ui/src/plugins/dev.perfetto.AndroidStartup/index.ts

// Copyright (C) 2024 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import {LONG} from '../../trace_processor/query_result';
import {Trace} from '../../public/trace';
import {PerfettoPlugin} from '../../public/plugin';
import {
  SimpleSliceTrack,
  SimpleSliceTrackConfig,
} from '../../frontend/simple_slice_track';
import {TrackNode} from '../../public/workspace';
export default class implements PerfettoPlugin {
  static readonly id = 'dev.perfetto.AndroidStartup';
  async onTraceLoad(ctx: Trace): Promise<void> {
    const e = ctx.engine;
    await e.query(`
          include perfetto module android.startup.startups;
          include perfetto module android.startup.startup_breakdowns;
         `);

    const cnt = await e.query('select count() cnt from android_startups');
    if (cnt.firstRow({cnt: LONG}).cnt === 0n) {
      return;
    }

    const trackSource = `
          SELECT l.ts AS ts, l.dur AS dur, l.package AS name
          FROM android_startups l
    `;
    const trackBreakdownSource = `
        SELECT
          ts,
          dur,
          reason AS name
          FROM android_startup_opinionated_breakdown
    `;

    const trackNode = this.loadStartupTrack(
      ctx,
      trackSource,
      `/android_startups`,
      'Android App Startups',
    );
    const trackBreakdownNode = this.loadStartupTrack(
      ctx,
      trackBreakdownSource,
      `/android_startups_breakdown`,
      'Android App Startups Breakdown',
    );

    ctx.workspace.addChildInOrder(trackNode);
    trackNode.addChildLast(trackBreakdownNode);
  }

  private loadStartupTrack(
    ctx: Trace,
    sqlSource: string,
    uri: string,
    title: string,
  ): TrackNode {
    const config: SimpleSliceTrackConfig = {
      data: {
        sqlSource,
        columns: ['ts', 'dur', 'name'],
      },
      columns: {ts: 'ts', dur: 'dur', name: 'name'},
      argColumns: [],
    };
    const track = new SimpleSliceTrack(ctx, {trackUri: uri}, config);
    ctx.tracks.registerTrack({
      uri,
      title,
      track,
    });
    // Needs a sort order lower than 'Ftrace Events' so that it is prioritized in the UI.
    return new TrackNode({title, uri, sortOrder: -6});
  }
}