blob: 81ecf47cf0c65911198bb1c0923d5e03b150c06e [file]
// 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 m from 'mithril';
import type {Trace} from '../../public/trace';
import type {PerfettoPlugin} from '../../public/plugin';
import {TrackNode} from '../../public/workspace';
import {SliceTrack} from '../../components/tracks/slice_track';
import {LONG, NUM, STR} from '../../trace_processor/query_result';
import {SourceDataset} from '../../trace_processor/dataset';
import {getColorForSlice, makeColorScheme} from '../../components/colorizer';
import {HSLColor} from '../../base/color';
import {CounterTrack} from '../../components/tracks/counter_track';
export default class implements PerfettoPlugin {
static readonly id = 'com.example.Tracks';
static readonly description =
'Example plugin showcasing different ways to create tracks.';
async onTraceLoad(trace: Trace): Promise<void> {
await createDummyData(trace);
await addBasicSliceTrack(trace);
await addFilteredSliceTrack(trace);
await addSliceTrackWithCustomColorizer(trace);
await addInstantTrack(trace);
await addFlatSliceTrack(trace);
await addFixedColorSliceTrack(trace);
await addNestedTrackGroup(trace);
addTracksWithHelpText(trace);
await addIncompleteSlicesTrack(trace);
await addCounterTracks(trace);
}
}
// Helper function to create a dummy table with sample slice data.
async function createDummyData(trace: Trace) {
const traceStartTime = trace.traceInfo.start;
const traceDur = trace.traceInfo.end - trace.traceInfo.start;
const tableName = 'example_events';
await trace.engine.tryQuery(`drop table if exists ${tableName}`);
await trace.engine.query(`
create table ${tableName} (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT,
ts INTEGER,
dur INTEGER,
arg TEXT
);
insert into ${tableName} (name, ts, dur, arg)
values
('Foo', ${traceStartTime}, ${traceDur}, 'aaa'),
('Bar', ${traceStartTime}, ${traceDur / 2n}, 'bbb'),
('Baz', ${traceStartTime}, ${traceDur / 3n}, 'aaa'),
('Qux', ${traceStartTime + traceDur / 2n}, ${traceDur / 2n}, 'bbb')
;
`);
}
// Example 1: A basic slice track showing all data from the table.
async function addBasicSliceTrack(trace: Trace): Promise<void> {
const uri = `com.example.Tracks#BasicSliceTrack`;
trace.tracks.registerTrack({
uri,
renderer: SliceTrack.create({
trace: trace,
uri,
dataset: new SourceDataset({
src: 'example_events', // Use the whole dummy table
schema: {
id: NUM,
ts: LONG,
dur: LONG,
name: STR,
},
}),
}),
});
// Add to workspace
trace.defaultWorkspace.addChildInOrder(
new TrackNode({uri, name: 'All Example Events'}),
);
}
// Example 2: A simple slice track filtering data from an existing table.
async function addFilteredSliceTrack(trace: Trace): Promise<void> {
const name = 'Slices starting with "B"';
const uri = `com.example.Tracks#FilteredSliceTrack`;
trace.tracks.registerTrack({
uri,
renderer: SliceTrack.create({
trace: trace,
uri,
dataset: new SourceDataset({
src: `
select
id,
ts,
dur,
name
from example_events -- Use our dummy table
where name glob 'B*'
`,
schema: {
id: NUM,
ts: LONG,
dur: LONG,
name: STR,
},
}),
}),
});
// Add to workspace
trace.defaultWorkspace.addChildInOrder(new TrackNode({uri, name}));
}
// Example 3: A slice track using a custom colorizer based on arguments.
async function addSliceTrackWithCustomColorizer(trace: Trace): Promise<void> {
const name = 'Slices colorized by arg';
const uri = `com.example.Tracks#SliceTrackColorized`;
trace.tracks.registerTrack({
uri,
renderer: SliceTrack.create({
trace: trace,
uri,
dataset: new SourceDataset({
src: 'example_events', // Use the whole dummy table
schema: {
id: NUM,
ts: LONG,
dur: LONG,
name: STR,
arg: STR, // Need the 'arg' column for colorizing
},
}),
colorizer: (row) => {
// Color slices based on the 'arg' column value
return getColorForSlice(row.arg);
},
}),
});
// Add to workspace
trace.defaultWorkspace.addChildInOrder(new TrackNode({uri, name}));
}
// Example 4: An instant track (no durations).
async function addInstantTrack(trace: Trace): Promise<void> {
const name = 'Instant Events';
const uri = `com.example.Tracks#InstantTrack`;
trace.tracks.registerTrack({
uri,
renderer: SliceTrack.create({
trace: trace,
uri,
dataset: new SourceDataset({
src: 'example_events', // Use the whole dummy table
schema: {
id: NUM,
ts: LONG,
name: STR,
// No 'dur' column means instants are drawn
},
}),
}),
});
// Add to workspace
trace.defaultWorkspace.addChildInOrder(new TrackNode({uri, name}));
}
// Example 5: A slice track with explicit depth (rendered flat).
async function addFlatSliceTrack(trace: Trace): Promise<void> {
const name = 'Flat Slices (Depth 0)';
const uri = `com.example.Tracks#FlatSliceTrack`;
trace.tracks.registerTrack({
uri,
renderer: SliceTrack.create({
trace: trace,
uri,
dataset: new SourceDataset({
// Explicitly select depth as 0
src: 'select 0 as depth, * from example_events',
schema: {
id: NUM,
ts: LONG,
dur: LONG,
name: STR,
depth: NUM, // Include depth in the schema
},
}),
}),
});
// Add to workspace
trace.defaultWorkspace.addChildInOrder(new TrackNode({uri, name}));
}
// Example 6: A slice track with a fixed color scheme.
async function addFixedColorSliceTrack(trace: Trace): Promise<void> {
const name = 'Fixed Color Slices (Red)';
const uri = `com.example.Tracks#FixedColorSliceTrack`;
trace.tracks.registerTrack({
uri,
renderer: SliceTrack.create({
trace: trace,
uri,
dataset: new SourceDataset({
src: 'example_events',
schema: {
id: NUM,
ts: LONG,
dur: LONG,
name: STR,
},
}),
// Provide a fixed red color scheme for all slices
colorizer: () => makeColorScheme(new HSLColor({h: 0, s: 50, l: 50})),
}),
});
// Add to workspace
trace.defaultWorkspace.addChildInOrder(new TrackNode({uri, name}));
}
// Example 7: Creating a nested group of tracks in the workspace.
// Note: This example focuses on workspace structure, not track content itself.
// It reuses the 'BasicSliceTrack' for demonstration.
async function addNestedTrackGroup(trace: Trace): Promise<void> {
// Borrow an existing track URI for our nested tracks example.
const trackUri = `com.example.Tracks#BasicSliceTrack`;
// Create track nodes for the hierarchy
const trackRoot = new TrackNode({
name: 'Nested Track Group',
});
const track1 = new TrackNode({
uri: trackUri,
name: 'Nested 1',
});
const track2 = new TrackNode({
uri: trackUri,
name: 'Nested 2',
});
const track11 = new TrackNode({
uri: trackUri,
name: 'Nested 1.1',
});
const track12 = new TrackNode({
uri: trackUri,
name: 'Nested 1.2',
});
const track121 = new TrackNode({
uri: trackUri,
name: 'Nested 1.2.1',
});
const track21 = new TrackNode({
uri: trackUri,
name: 'Nested 2.1',
});
// Build the hierarchy
trace.defaultWorkspace.addChildInOrder(trackRoot);
trackRoot.addChildLast(track1);
trackRoot.addChildLast(track2);
track1.addChildLast(track11);
track1.addChildLast(track12);
track12.addChildLast(track121);
track2.addChildLast(track21);
// Example commands demonstrating workspace manipulation with nested tracks
trace.commands.registerCommand({
id: 'com.example.CloneNestedGroupToNewWorkspace',
name: 'Clone nested group to new workspace',
callback: () => {
const ws = trace.workspaces.createEmptyWorkspace('New workspace');
// Clone only the group node (shallow clone)
ws.addChildLast(trackRoot.clone());
trace.workspaces.switchWorkspace(ws);
},
});
trace.commands.registerCommand({
id: 'com.example.DeepCloneNestedGroupToNewWorkspace',
name: 'Clone nested group and children to new workspace',
callback: () => {
const ws = trace.workspaces.createEmptyWorkspace('Deep workspace');
// Clone the group node and all its descendants (deep clone)
ws.addChildLast(trackRoot.clone(true));
trace.workspaces.switchWorkspace(ws);
},
});
}
function addTracksWithHelpText(trace: Trace) {
const uri = `com.example.Tracks#TrackWithHelpText`;
trace.tracks.registerTrack({
uri,
renderer: SliceTrack.create({
trace: trace,
uri,
dataset: new SourceDataset({
src: 'example_events', // Use the whole dummy table
schema: {
id: NUM,
ts: LONG,
dur: LONG,
name: STR,
},
}),
}),
description: () => [
'This track demonstrates how to add help text.',
m('br'),
'Use Mithril vnodes for formatting.',
],
});
const groupNode = addGroupWithHelpText(trace);
// Add to workspace
groupNode.addChildLast(new TrackNode({uri, name: 'Track with Help Text'}));
}
function addGroupWithHelpText(trace: Trace) {
const uri = `com.example.Tracks#GroupWithHelpText`;
trace.tracks.registerTrack({
uri,
renderer: {
render: () => {},
},
description: () => [
'This is a group track with some help text.',
m('br'),
'Use Mithril vnodes for formatting.',
],
});
// Add to workspace
const groupNode = new TrackNode({uri, name: 'Group with Help Text'});
trace.defaultWorkspace.addChildInOrder(groupNode);
return groupNode;
}
// Example 8: A track with incomplete slices (dur = -1) at various depth levels.
async function addIncompleteSlicesTrack(trace: Trace): Promise<void> {
const traceStartTime = trace.traceInfo.start;
const traceDur = trace.traceInfo.end - trace.traceInfo.start;
const tableName = 'incomplete_events';
// Create a table with incomplete slices at different depths
await trace.engine.tryQuery(`drop table if exists ${tableName}`);
await trace.engine.query(`
create table ${tableName} (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT,
ts INTEGER,
dur INTEGER,
depth INTEGER
);
insert into ${tableName} (name, ts, dur, depth)
values
-- Complete slices for context
('Complete 0', ${traceStartTime}, ${traceDur / 4n}, 0),
('Complete 1', ${traceStartTime + traceDur / 3n}, ${traceDur / 4n}, 1),
('Complete 2', ${traceStartTime + traceDur / 2n}, ${traceDur / 4n}, 2),
-- Incomplete slices (dur = -1) at various depths
('Incomplete at depth 0', ${traceStartTime + traceDur / 8n}, -1, 0),
('Incomplete at depth 1', ${traceStartTime + traceDur / 6n}, -1, 1),
('Incomplete at depth 2', ${traceStartTime + traceDur / 5n}, -1, 2),
('Incomplete at depth 3', ${traceStartTime + traceDur / 4n}, -1, 3)
;
`);
const name = 'Incomplete Slices (Various Depths)';
const uri = `com.example.Tracks#IncompleteSlicesTrack`;
trace.tracks.registerTrack({
uri,
renderer: SliceTrack.create({
trace: trace,
uri,
dataset: new SourceDataset({
src: tableName,
schema: {
id: NUM,
ts: LONG,
dur: LONG,
name: STR,
depth: NUM,
},
}),
}),
});
// Add to workspace
trace.defaultWorkspace.addChildInOrder(new TrackNode({uri, name}));
}
// Example 9: Counter tracks demonstrating different counter options.
async function addCounterTracks(trace: Trace): Promise<void> {
const traceStartTime = trace.traceInfo.start;
const traceDur = trace.traceInfo.end - trace.traceInfo.start;
const tableName = 'example_counter';
// Create a counter table with a sine wave pattern
await trace.engine.tryQuery(`drop table if exists ${tableName}`);
await trace.engine.query(`
create table ${tableName} (
id INTEGER PRIMARY KEY AUTOINCREMENT,
ts INTEGER,
value REAL
);
`);
const numPoints = 2000;
const values: string[] = [];
for (let i = 0; i < numPoints; i++) {
const ts = traceStartTime + (traceDur * BigInt(i)) / BigInt(numPoints);
const value = 50 * Math.sin((10 * Math.PI * i) / numPoints);
values.push(`(${ts}, ${value.toFixed(2)})`);
}
await trace.engine.query(`
insert into ${tableName} (ts, value) values ${values.join(',')};
`);
// Basic counter track
const uri1 = 'com.example.Tracks#CounterTrack';
trace.tracks.registerTrack({
uri: uri1,
renderer: CounterTrack.create({
trace,
uri: uri1,
sqlSource: `select ts, value from ${tableName}`,
}),
});
// Counter track with range sharing key
const uri2 = 'com.example.Tracks#CounterTrackShared1';
trace.tracks.registerTrack({
uri: uri2,
renderer: CounterTrack.create({
trace,
uri: uri2,
sqlSource: `select ts, value from ${tableName}`,
yRangeSharingKey: 'example_shared',
}),
});
const uri3 = 'com.example.Tracks#CounterTrackShared2';
trace.tracks.registerTrack({
uri: uri3,
renderer: CounterTrack.create({
trace,
uri: uri3,
sqlSource: `select ts, value * 0.5 + 20 as value from ${tableName}`,
yRangeSharingKey: 'example_shared',
}),
});
// Counter track with negative values
const uri4 = 'com.example.Tracks#CounterTrackNegative';
trace.tracks.registerTrack({
uri: uri4,
renderer: CounterTrack.create({
trace,
uri: uri4,
sqlSource: `select ts, value - 40 as value from ${tableName}`,
}),
});
// Counter track with only negative values (shifted below zero)
const uri5 = 'com.example.Tracks#CounterTrackNegativeOnly';
trace.tracks.registerTrack({
uri: uri5,
renderer: CounterTrack.create({
trace,
uri: uri5,
sqlSource: `select ts, value - 100 as value from ${tableName}`,
}),
});
// Counter track with very large values (gigabytes scale)
const uri6 = 'com.example.Tracks#CounterTrackLarge';
trace.tracks.registerTrack({
uri: uri6,
renderer: CounterTrack.create({
trace,
uri: uri6,
sqlSource: `select ts, (value + 50) * 20000000 as value from ${tableName}`,
}),
});
// Counter track with very small values (nanoseconds scale)
const uri7 = 'com.example.Tracks#CounterTrackSmall';
trace.tracks.registerTrack({
uri: uri7,
renderer: CounterTrack.create({
trace,
uri: uri7,
sqlSource: `select ts, (value + 50) * 0.000001 as value from ${tableName}`,
}),
});
// Frequency counter (Hz) - values in MHz range
const uri8 = 'com.example.Tracks#CounterTrackHz';
trace.tracks.registerTrack({
uri: uri8,
renderer: CounterTrack.create({
trace,
uri: uri8,
sqlSource: `select ts, (value + 50) * 30000000 as value from ${tableName}`,
unit: 'Hz',
}),
});
// Power counter (W) - values in milliwatt range
const uri9 = 'com.example.Tracks#CounterTrackWatts';
trace.tracks.registerTrack({
uri: uri9,
renderer: CounterTrack.create({
trace,
uri: uri9,
sqlSource: `select ts, (value + 50) * 0.001 as value from ${tableName}`,
unit: 'W',
}),
});
// Memory counter (bytes) - values in megabyte range
const uri10 = 'com.example.Tracks#CounterTrackBytes';
trace.tracks.registerTrack({
uri: uri10,
renderer: CounterTrack.create({
trace,
uri: uri10,
sqlSource: `select ts, (value + 50) * 1000000 as value from ${tableName}`,
unit: 'B',
}),
});
// Duration counter (seconds) - values in millisecond range
const uri11 = 'com.example.Tracks#CounterTrackSeconds';
trace.tracks.registerTrack({
uri: uri11,
renderer: CounterTrack.create({
trace,
uri: uri11,
sqlSource: `select ts, (value + 50) * 0.0001 as value from ${tableName}`,
unit: 's',
}),
});
// Unknown unit counter - prefix attaches to number
const uri12 = 'com.example.Tracks#CounterTrackFPS';
trace.tracks.registerTrack({
uri: uri12,
renderer: CounterTrack.create({
trace,
uri: uri12,
sqlSource: `select ts, (value + 50) * 200000 as value from ${tableName}`,
unit: 'fps',
}),
});
const ws = trace.defaultWorkspace;
ws.addChildInOrder(new TrackNode({uri: uri1, name: 'Sine Wave Counter'}));
ws.addChildInOrder(
new TrackNode({uri: uri2, name: 'Shared Range Counter 1'}),
);
ws.addChildInOrder(
new TrackNode({uri: uri3, name: 'Shared Range Counter 2'}),
);
ws.addChildInOrder(
new TrackNode({uri: uri4, name: 'Negative Values Counter'}),
);
ws.addChildInOrder(new TrackNode({uri: uri5, name: 'Negative Only Counter'}));
ws.addChildInOrder(
new TrackNode({uri: uri6, name: 'Large Values Counter (~GBs)'}),
);
ws.addChildInOrder(
new TrackNode({uri: uri7, name: 'Small Values Counter (~µs)'}),
);
ws.addChildInOrder(
new TrackNode({uri: uri8, name: 'Frequency Counter (Hz)'}),
);
ws.addChildInOrder(new TrackNode({uri: uri9, name: 'Power Counter (W)'}));
ws.addChildInOrder(new TrackNode({uri: uri10, name: 'Memory Counter (B)'}));
ws.addChildInOrder(new TrackNode({uri: uri11, name: 'Duration Counter (s)'}));
ws.addChildInOrder(
new TrackNode({uri: uri12, name: 'Frame Rate Counter (fps)'}),
);
}