ui/src/plugins/com.android.AndroidBinderViz/index.ts

// Copyright (C) 2025 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 {
  BreakdownTrackAggType,
  BreakdownTracks,
} from '../../components/tracks/breakdown_tracks';
import type {PerfettoPlugin} from '../../public/plugin';
import type {Trace} from '../../public/trace';
import {TrackNode} from '../../public/workspace';
import {BinderSliceDetailsPanel} from './details_panel';

export default class implements PerfettoPlugin {
  static readonly id = 'com.android.AndroidBinderViz';

  async onTraceLoad(ctx: Trace): Promise<void> {
    // Build the server and client trees concurrently so the trace engine isn't
    // left idle between the two sides' query streams. Attach after both finish,
    // server first: the root tracks carry no sortOrder, so addChildInOrder falls
    // back to insertion order and a bare Promise.all would race the ordering.
    const [serverRoot, clientRoot] = await Promise.all([
      this.createBinderTransactionTrack(
        ctx,
        'server',
        'client',
        'binder_txn_id',
        'Server perspective: for each server process and AIDL interface and ' +
          'method name, which client process/thread is calling it.',
      ),
      this.createBinderTransactionTrack(
        ctx,
        'client',
        'server',
        'binder_reply_id',
        'Client perspective: for each client process and AIDL interface and ' +
          'method name, which server process/thread is replying.',
      ),
    ]);
    const binderGroup = new TrackNode({name: 'Binder', isSummary: true});
    binderGroup.addChildInOrder(serverRoot);
    binderGroup.addChildInOrder(clientRoot);
    ctx.defaultWorkspace.addChildInOrder(binderGroup);
  }

  async createBinderTransactionTrack(
    ctx: Trace,
    perspective: string,
    oppositePerspective: string,
    sliceIdColumn: string,
    description: string,
  ): Promise<TrackNode> {
    // The titles live under a "Binder" group, so drop the redundant prefix.
    const sideName = perspective[0].toUpperCase() + perspective.slice(1);
    const binderCounterBreakdowns = new BreakdownTracks({
      trace: ctx,
      trackTitle: `${sideName} Transaction Counts`,
      description,
      modules: ['android.binder'],
      aggregationType: BreakdownTrackAggType.COUNT,
      aggregation: {
        columns: [
          `${perspective}_process`,
          `(IFNULL(interface, "unknown interface"))`,
          `(IFNULL(method_name, "unknown method"))`,
          `(${oppositePerspective}_process || ":" || ${oppositePerspective}_upid)`,
          `(${oppositePerspective}_thread || ":" ||  ${oppositePerspective}_utid)`,
        ],
        tsCol: `${oppositePerspective}_ts`,
        durCol: `${oppositePerspective}_dur`,
        tableName: 'android_binder_txns',
      },
      slice: {
        columns: ['IFNULL(aidl_name, "unknown aidl")'],
        tableName: 'android_binder_txns',
        tsCol: `${oppositePerspective}_ts`,
        durCol: `${oppositePerspective}_dur`,
      },
      sliceIdColumn: sliceIdColumn,
      sortTracks: false,
      detailsPanel: (trace: Trace) => new BinderSliceDetailsPanel(trace),
    });

    return await binderCounterBreakdowns.createTracks();
  }
}