|
| 1 | +// Copyright (C) 2026 The Android Open Source Project |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +import protos from '../../../protos'; |
| 16 | +import {AdbDevice} from '../../dev.perfetto.RecordTraceV2/adb/adb_device'; |
| 17 | +import {createAdbTracingSession} from '../../dev.perfetto.RecordTraceV2/adb/adb_tracing_session'; |
| 18 | +import {TracedWebsocketTarget} from '../../dev.perfetto.RecordTraceV2/traced_over_websocket/traced_websocket_target'; |
| 19 | + |
| 20 | +const DUMP_INTERVAL_MS = 10_000; |
| 21 | +const PROC_STATS_BUFFER_SIZE_KB = 4 * 1024; |
| 22 | +const HEAPPROFD_BUFFER_SIZE_KB = 128 * 1024; |
| 23 | +const JAVA_HPROF_BUFFER_SIZE_KB = 256 * 1024; |
| 24 | +const STATS_POLL_INTERVAL_MS = 3000; // How often we poll the buffer size. |
| 25 | + |
| 26 | +export type ProfileState = 'recording' | 'stopping' | 'finished' | 'error'; |
| 27 | + |
| 28 | +export interface ProfileSession { |
| 29 | + readonly pid: number; |
| 30 | + readonly processName: string; |
| 31 | + readonly startX: number; |
| 32 | + readonly state: ProfileState; |
| 33 | + readonly error?: string; |
| 34 | + readonly bufferUsagePct?: number; |
| 35 | + /** Stops recording and waits for the trace data to be ready. */ |
| 36 | + stop(): Promise<void>; |
| 37 | + /** Cancels recording and discards trace data. */ |
| 38 | + cancel(): Promise<void>; |
| 39 | + /** Returns the trace buffer once state is 'finished'. */ |
| 40 | + getTraceData(): Uint8Array | undefined; |
| 41 | +} |
| 42 | + |
| 43 | +export async function createProcessProfileSession( |
| 44 | + targetOrDevice: TracedWebsocketTarget | AdbDevice, |
| 45 | + pid: number, |
| 46 | + processName: string, |
| 47 | + startX: number, |
| 48 | +): Promise<ProfileSession> { |
| 49 | + const config = buildProcessProfileConfig(pid); |
| 50 | + const result = |
| 51 | + targetOrDevice instanceof TracedWebsocketTarget |
| 52 | + ? await targetOrDevice.startTracing(config) |
| 53 | + : await createAdbTracingSession(targetOrDevice, config); |
| 54 | + if (!result.ok) { |
| 55 | + // TODO: Put this in the error state of the returned object |
| 56 | + return { |
| 57 | + pid, |
| 58 | + processName, |
| 59 | + startX, |
| 60 | + state: 'error', |
| 61 | + error: `Failed to start profile: ${result.error}`, |
| 62 | + async stop() {}, |
| 63 | + async cancel() {}, |
| 64 | + getTraceData() { |
| 65 | + return undefined; |
| 66 | + }, |
| 67 | + }; |
| 68 | + } |
| 69 | + |
| 70 | + let bufferUsagePct: number | undefined; |
| 71 | + const session = result.value; |
| 72 | + let state: ProfileState = 'recording'; |
| 73 | + let error: string | undefined = undefined; |
| 74 | + |
| 75 | + const intervalHandle = setInterval(async () => { |
| 76 | + bufferUsagePct = await session.getBufferUsagePct(); |
| 77 | + }, STATS_POLL_INTERVAL_MS); |
| 78 | + |
| 79 | + session.onSessionUpdate.addListener(() => { |
| 80 | + if (session.state === 'FINISHED') { |
| 81 | + state = 'finished'; |
| 82 | + } else if (session.state === 'ERRORED') { |
| 83 | + state = 'error'; |
| 84 | + error = session.logs |
| 85 | + .filter((l) => l.isError) |
| 86 | + .map((l) => l.message) |
| 87 | + .join('; '); |
| 88 | + } |
| 89 | + }); |
| 90 | + |
| 91 | + return { |
| 92 | + pid, |
| 93 | + processName, |
| 94 | + startX, |
| 95 | + get state() { |
| 96 | + return state; |
| 97 | + }, |
| 98 | + get bufferUsagePct() { |
| 99 | + return bufferUsagePct; |
| 100 | + }, |
| 101 | + get error() { |
| 102 | + return error; |
| 103 | + }, |
| 104 | + /** Stops recording and waits for the trace data to be ready. */ |
| 105 | + async stop() { |
| 106 | + if (state !== 'recording') return; |
| 107 | + clearInterval(intervalHandle); |
| 108 | + state = 'stopping'; |
| 109 | + await session.stop(); |
| 110 | + // Wait for the session to reach FINISHED if it hasn't already. |
| 111 | + if (session.state !== 'FINISHED') { |
| 112 | + await new Promise<void>((resolve) => { |
| 113 | + const sub = session.onSessionUpdate.addListener(() => { |
| 114 | + if (session.state === 'FINISHED' || session.state === 'ERRORED') { |
| 115 | + sub[Symbol.dispose](); |
| 116 | + resolve(); |
| 117 | + } |
| 118 | + }); |
| 119 | + }); |
| 120 | + } |
| 121 | + state = session.state === 'FINISHED' ? 'finished' : 'error'; |
| 122 | + }, |
| 123 | + async cancel(): Promise<void> { |
| 124 | + if (state !== 'recording') return; |
| 125 | + clearInterval(intervalHandle); |
| 126 | + state = 'error'; |
| 127 | + await session.cancel(); |
| 128 | + }, |
| 129 | + /** Returns the trace buffer once state is 'finished'. */ |
| 130 | + getTraceData(): Uint8Array | undefined { |
| 131 | + return session.getTraceData(); |
| 132 | + }, |
| 133 | + }; |
| 134 | +} |
| 135 | + |
| 136 | +/** Builds the TraceConfig for a single-process heap profiling session. */ |
| 137 | +function buildProcessProfileConfig(pid: number): protos.ITraceConfig { |
| 138 | + return { |
| 139 | + compressionType: |
| 140 | + protos.TraceConfig.CompressionType.COMPRESSION_TYPE_DEFLATE, |
| 141 | + buffers: [ |
| 142 | + { |
| 143 | + name: 'process_stats', |
| 144 | + sizeKb: PROC_STATS_BUFFER_SIZE_KB, |
| 145 | + fillPolicy: protos.TraceConfig.BufferConfig.FillPolicy.DISCARD, |
| 146 | + }, |
| 147 | + { |
| 148 | + name: 'heapprofd', |
| 149 | + sizeKb: HEAPPROFD_BUFFER_SIZE_KB, |
| 150 | + fillPolicy: protos.TraceConfig.BufferConfig.FillPolicy.RING_BUFFER, |
| 151 | + }, |
| 152 | + { |
| 153 | + name: 'java_hprof', |
| 154 | + sizeKb: JAVA_HPROF_BUFFER_SIZE_KB, |
| 155 | + fillPolicy: protos.TraceConfig.BufferConfig.FillPolicy.RING_BUFFER, |
| 156 | + }, |
| 157 | + ], |
| 158 | + dataSources: [ |
| 159 | + { |
| 160 | + config: { |
| 161 | + name: 'linux.process_stats', |
| 162 | + targetBufferName: 'process_stats', |
| 163 | + processStatsConfig: { |
| 164 | + scanAllProcessesOnStart: true, // Necessary for track names. |
| 165 | + }, |
| 166 | + }, |
| 167 | + }, |
| 168 | + { |
| 169 | + config: { |
| 170 | + name: 'android.heapprofd', |
| 171 | + targetBufferName: 'heapprofd', |
| 172 | + heapprofdConfig: { |
| 173 | + pid: [pid], |
| 174 | + samplingIntervalBytes: 32 * 1024, // Slightly larger than default to avoid overhead. |
| 175 | + shmemSizeBytes: 16 * 1024 * 1024, // Arbitrary, could use default. |
| 176 | + blockClient: true, // Important for trace integrity. |
| 177 | + continuousDumpConfig: { |
| 178 | + dumpIntervalMs: DUMP_INTERVAL_MS, // Important for getting regular heap snapshots to see how memory usage evolves over time. |
| 179 | + }, |
| 180 | + }, |
| 181 | + }, |
| 182 | + }, |
| 183 | + { |
| 184 | + config: { |
| 185 | + name: 'android.java_hprof', |
| 186 | + targetBufferName: 'java_hprof', |
| 187 | + javaHprofConfig: { |
| 188 | + pid: [pid], |
| 189 | + continuousDumpConfig: { |
| 190 | + dumpIntervalMs: DUMP_INTERVAL_MS, // Required for Java profiles. |
| 191 | + }, |
| 192 | + }, |
| 193 | + }, |
| 194 | + }, |
| 195 | + ], |
| 196 | + }; |
| 197 | +} |
0 commit comments