Merge "Add TrackTracer to trace to a single perfetto track" into main (e53d6662) · Commits · e / os / android_frameworks_libs_systemui

tracinglib/core/src/TraceUtils.kt

+40 −6

Original line number	Diff line number	Diff line
		@@ -124,6 +124,7 @@ public inline fun <T> traceSection(tag: () -> String, block: () -> T): T {
		}
		}

		@OptIn(ExperimentalContracts::class)
		public object TraceUtils {
		public const val TAG: String = "TraceUtils"
		public const val DEFAULT_TRACK_NAME: String = "AsyncTraces"
		@@ -190,18 +191,51 @@ public object TraceUtils {
		/**
		* Creates an async slice in a track with [trackName] while [block] runs.
		*
		* This can be used to trace coroutine code. [method] will be the name of the slice, [trackName]
		* of the track. The track is one of the rows visible in a perfetto trace inside the app
		* process.
		* This can be used to trace coroutine code. [sliceName] will be the name of the slice,
		* [trackName] of the track. The track is one of the rows visible in a perfetto trace inside the
		* app process.
		*/
		@JvmStatic
		public inline fun <T> traceAsync(trackName: String, method: String, block: () -> T): T {
		public inline fun <T> traceAsync(trackName: String, sliceName: String, block: () -> T): T {
		contract { callsInPlace(block, InvocationKind.EXACTLY_ONCE) }
		return traceAsync(Trace.TRACE_TAG_APP, trackName, sliceName, block)
		}

		/** Creates an async slice in a track with [trackName] while [block] runs. */
		@JvmStatic
		public inline fun <T> traceAsync(
		traceTag: Long,
		trackName: String,
		sliceName: String,
		block: () -> T,
		): T {
		contract { callsInPlace(block, InvocationKind.EXACTLY_ONCE) }
		val cookie = ThreadLocalRandom.current().nextInt()
		Trace.asyncTraceForTrackBegin(Trace.TRACE_TAG_APP, trackName, method, cookie)
		Trace.asyncTraceForTrackBegin(traceTag, trackName, sliceName, cookie)
		try {
		return block()
		} finally {
		Trace.asyncTraceForTrackEnd(Trace.TRACE_TAG_APP, trackName, cookie)
		Trace.asyncTraceForTrackEnd(traceTag, trackName, cookie)
		}
		}

		/** Creates an async slice in a track with [trackName] while [block] runs. */
		@JvmStatic
		public inline fun <T> traceAsync(
		traceTag: Long,
		trackName: String,
		sliceName: () -> String,
		block: () -> T,
		): T {
		contract {
		callsInPlace(sliceName, InvocationKind.AT_MOST_ONCE)
		callsInPlace(block, InvocationKind.EXACTLY_ONCE)
		}
		val tracingEnabled = Trace.isEnabled()
		return if (tracingEnabled) {
		return traceAsync(traceTag, trackName, sliceName(), block)
		} else {
		block()
		}
		}
		}

tracinglib/core/src/coroutines/TrackTracer.kt

0 → 100644

+74 −0

Original line number	Diff line number	Diff line
		/*
		* 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.
		*/

		package com.android.app.tracing.coroutines

		import android.os.Trace
		import com.android.app.tracing.TraceUtils
		import java.io.Closeable
		import java.util.concurrent.ThreadLocalRandom
		import kotlin.contracts.ExperimentalContracts
		import kotlin.contracts.InvocationKind
		import kotlin.contracts.contract

		/**
		* Wrapper to trace to a single perfetto track elegantly, without duplicating trace tag and track
		* name all the times.
		*
		* The intended use is the following:
		* ```kotlin
		* class SomeClass {
		* privat val t = TrackTracer("SomeTrackName")
		*
		* ...
		* t.instant { "some instant" }
		* t.traceAsync("Some slice name") { ... }
		* }
		* ```
		*/
		@OptIn(ExperimentalContracts::class)
		public class TrackTracer(
		public val trackName: String,
		public val traceTag: Long = Trace.TRACE_TAG_APP,
		) {
		/** See [Trace.instantForTrack]. */
		public inline fun instant(s: () -> String) {
		if (!Trace.isEnabled()) return
		Trace.instantForTrack(traceTag, trackName, s())
		}

		/** See [Trace.asyncTraceForTrackBegin]. */
		public inline fun <T> traceAsync(sliceName: () -> String, block: () -> T): T {
		contract {
		callsInPlace(block, InvocationKind.EXACTLY_ONCE)
		callsInPlace(sliceName, InvocationKind.AT_MOST_ONCE)
		}
		return TraceUtils.traceAsync(traceTag, trackName, sliceName, block)
		}

		/** See [Trace.asyncTraceForTrackBegin]. */
		public inline fun <T> traceAsync(sliceName: String, block: () -> T): T {
		contract { callsInPlace(block, InvocationKind.EXACTLY_ONCE) }
		return TraceUtils.traceAsync(traceTag, trackName, sliceName, block)
		}

		/** See [Trace.asyncTraceForTrackBegin]. */
		public fun traceAsyncBegin(sliceName: String): Closeable {
		val cookie = ThreadLocalRandom.current().nextInt()
		Trace.asyncTraceForTrackBegin(traceTag, trackName, sliceName, cookie)
		return Closeable { Trace.asyncTraceForTrackEnd(traceTag, trackName, cookie) }
		}
		}