Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2012 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.os; |
| 18 | |
John Reck | 13f08e6 | 2019-01-09 11:16:28 -0800 | [diff] [blame] | 19 | import android.annotation.NonNull; |
Artur Satayev | afdb23a | 2019-12-10 17:47:53 +0000 | [diff] [blame] | 20 | import android.compat.annotation.UnsupportedAppUsage; |
John Reck | 62cc119 | 2017-05-12 15:39:51 -0700 | [diff] [blame] | 21 | |
Florian Mayer | 9fd2102 | 2019-12-09 17:16:01 +0000 | [diff] [blame] | 22 | import dalvik.annotation.optimization.CriticalNative; |
John Reck | 6be2cab | 2016-10-03 14:38:06 -0700 | [diff] [blame] | 23 | import dalvik.annotation.optimization.FastNative; |
| 24 | |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 25 | /** |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 26 | * Writes trace events to the system trace buffer. These trace events can be |
| 27 | * collected and visualized using the Systrace tool. |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 28 | * |
Scott Main | c468240 | 2013-06-13 12:38:55 -0700 | [diff] [blame] | 29 | * <p>This tracing mechanism is independent of the method tracing mechanism |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 30 | * offered by {@link Debug#startMethodTracing}. In particular, it enables |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 31 | * tracing of events that occur across multiple processes. |
Scott Main | c468240 | 2013-06-13 12:38:55 -0700 | [diff] [blame] | 32 | * <p>For information about using the Systrace tool, read <a |
| 33 | * href="{@docRoot}tools/debugging/systrace.html">Analyzing Display and Performance |
| 34 | * with Systrace</a>. |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 35 | */ |
| 36 | public final class Trace { |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 37 | /* |
| 38 | * Writes trace events to the kernel trace buffer. These trace events can be |
| 39 | * collected using the "atrace" program for offline analysis. |
| 40 | */ |
| 41 | |
Andy McFadden | d11ca4d | 2012-10-22 16:16:06 -0700 | [diff] [blame] | 42 | private static final String TAG = "Trace"; |
| 43 | |
Alex Ray | 8a6787b | 2012-11-14 18:08:49 -0800 | [diff] [blame] | 44 | // These tags must be kept in sync with system/core/include/cutils/trace.h. |
Jeff Brown | 3edf527 | 2014-08-14 19:25:14 -0700 | [diff] [blame] | 45 | // They should also be added to frameworks/native/cmds/atrace/atrace.cpp. |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 46 | /** @hide */ |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 47 | public static final long TRACE_TAG_NEVER = 0; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 48 | /** @hide */ |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 49 | public static final long TRACE_TAG_ALWAYS = 1L << 0; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 50 | /** @hide */ |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 51 | public static final long TRACE_TAG_GRAPHICS = 1L << 1; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 52 | /** @hide */ |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 53 | public static final long TRACE_TAG_INPUT = 1L << 2; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 54 | /** @hide */ |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 55 | @UnsupportedAppUsage |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 56 | public static final long TRACE_TAG_VIEW = 1L << 3; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 57 | /** @hide */ |
Chris Craik | 192a65e | 2012-04-16 16:08:40 -0700 | [diff] [blame] | 58 | public static final long TRACE_TAG_WEBVIEW = 1L << 4; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 59 | /** @hide */ |
Dianne Hackborn | 1ded0b1 | 2012-04-26 14:14:50 -0700 | [diff] [blame] | 60 | public static final long TRACE_TAG_WINDOW_MANAGER = 1L << 5; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 61 | /** @hide */ |
Dianne Hackborn | 1ded0b1 | 2012-04-26 14:14:50 -0700 | [diff] [blame] | 62 | public static final long TRACE_TAG_ACTIVITY_MANAGER = 1L << 6; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 63 | /** @hide */ |
Andy Stadler | 09b45a3 | 2012-05-03 15:00:49 -0700 | [diff] [blame] | 64 | public static final long TRACE_TAG_SYNC_MANAGER = 1L << 7; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 65 | /** @hide */ |
Glenn Kasten | ed853fc | 2012-05-07 11:05:55 -0700 | [diff] [blame] | 66 | public static final long TRACE_TAG_AUDIO = 1L << 8; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 67 | /** @hide */ |
Jamie Gennis | 24dae6c | 2012-05-11 04:43:35 -0700 | [diff] [blame] | 68 | public static final long TRACE_TAG_VIDEO = 1L << 9; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 69 | /** @hide */ |
Eino-Ville Talvala | 9c0d9cf | 2012-05-31 15:49:31 -0700 | [diff] [blame] | 70 | public static final long TRACE_TAG_CAMERA = 1L << 10; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 71 | /** @hide */ |
Alex Ray | 8a6787b | 2012-11-14 18:08:49 -0800 | [diff] [blame] | 72 | public static final long TRACE_TAG_HAL = 1L << 11; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 73 | /** @hide */ |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 74 | @UnsupportedAppUsage |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 75 | public static final long TRACE_TAG_APP = 1L << 12; |
Dianne Hackborn | f7be480 | 2013-04-12 14:52:58 -0700 | [diff] [blame] | 76 | /** @hide */ |
| 77 | public static final long TRACE_TAG_RESOURCES = 1L << 13; |
Jamie Gennis | 0cc84ce | 2013-05-07 15:22:31 -0700 | [diff] [blame] | 78 | /** @hide */ |
| 79 | public static final long TRACE_TAG_DALVIK = 1L << 14; |
Tim Murray | 6d7a53c | 2013-05-23 16:59:23 -0700 | [diff] [blame] | 80 | /** @hide */ |
| 81 | public static final long TRACE_TAG_RS = 1L << 15; |
Brigid Smith | 461ac24 | 2014-05-28 14:13:41 -0700 | [diff] [blame] | 82 | /** @hide */ |
| 83 | public static final long TRACE_TAG_BIONIC = 1L << 16; |
Jeff Brown | 3edf527 | 2014-08-14 19:25:14 -0700 | [diff] [blame] | 84 | /** @hide */ |
| 85 | public static final long TRACE_TAG_POWER = 1L << 17; |
Todd Kennedy | 114beb2 | 2015-08-03 09:56:07 -0700 | [diff] [blame] | 86 | /** @hide */ |
| 87 | public static final long TRACE_TAG_PACKAGE_MANAGER = 1L << 18; |
Yasuhiro Matsuda | 1ab43d5 | 2015-06-30 17:07:32 +0900 | [diff] [blame] | 88 | /** @hide */ |
| 89 | public static final long TRACE_TAG_SYSTEM_SERVER = 1L << 19; |
Greg Hackmann | e12350f | 2014-12-01 14:31:21 -0800 | [diff] [blame] | 90 | /** @hide */ |
| 91 | public static final long TRACE_TAG_DATABASE = 1L << 20; |
Felipe Leme | 873a83a | 2016-09-07 11:34:10 -0700 | [diff] [blame] | 92 | /** @hide */ |
| 93 | public static final long TRACE_TAG_NETWORK = 1L << 21; |
Josh Gao | 552d86b5 | 2016-11-29 10:57:01 -0800 | [diff] [blame] | 94 | /** @hide */ |
| 95 | public static final long TRACE_TAG_ADB = 1L << 22; |
Alexey Kuzmin | e59145a | 2018-02-10 15:19:03 +0000 | [diff] [blame] | 96 | /** @hide */ |
| 97 | public static final long TRACE_TAG_VIBRATOR = 1L << 23; |
Martijn Coenen | afbfb17 | 2018-03-09 09:26:54 +0100 | [diff] [blame] | 98 | /** @hide */ |
| 99 | public static final long TRACE_TAG_AIDL = 1L << 24; |
Mika Raento | 6a30ff8 | 2018-04-23 22:08:57 +0100 | [diff] [blame] | 100 | /** @hide */ |
| 101 | public static final long TRACE_TAG_NNAPI = 1L << 25; |
MÃ¥rten Kongstad | 5668589 | 2018-12-03 12:59:19 +0100 | [diff] [blame] | 102 | /** @hide */ |
| 103 | public static final long TRACE_TAG_RRO = 1L << 26; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 104 | |
Andy McFadden | 325be8a | 2012-10-29 16:42:41 -0700 | [diff] [blame] | 105 | private static final long TRACE_TAG_NOT_READY = 1L << 63; |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 106 | private static final int MAX_SECTION_NAME_LEN = 127; |
Dianne Hackborn | 83e6eb1 | 2012-05-08 14:53:24 -0700 | [diff] [blame] | 107 | |
Andy McFadden | d11ca4d | 2012-10-22 16:16:06 -0700 | [diff] [blame] | 108 | // Must be volatile to avoid word tearing. |
Florian Mayer | 9fd2102 | 2019-12-09 17:16:01 +0000 | [diff] [blame] | 109 | // This is only kept in case any apps get this by reflection but do not |
| 110 | // check the return value for null. |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 111 | @UnsupportedAppUsage |
Andy McFadden | 325be8a | 2012-10-29 16:42:41 -0700 | [diff] [blame] | 112 | private static volatile long sEnabledTags = TRACE_TAG_NOT_READY; |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 113 | |
John Reck | 62cc119 | 2017-05-12 15:39:51 -0700 | [diff] [blame] | 114 | private static int sZygoteDebugFlags = 0; |
| 115 | |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 116 | @UnsupportedAppUsage |
Florian Mayer | 9fd2102 | 2019-12-09 17:16:01 +0000 | [diff] [blame] | 117 | @CriticalNative |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 118 | private static native long nativeGetEnabledTags(); |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 119 | private static native void nativeSetAppTracingAllowed(boolean allowed); |
Jamie Gennis | 6ad0452 | 2013-04-15 18:53:24 -0700 | [diff] [blame] | 120 | private static native void nativeSetTracingEnabled(boolean allowed); |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 121 | |
John Reck | 6be2cab | 2016-10-03 14:38:06 -0700 | [diff] [blame] | 122 | @FastNative |
John Reck | 77b31a5 | 2018-12-05 18:16:39 -0800 | [diff] [blame] | 123 | private static native void nativeTraceCounter(long tag, String name, long value); |
John Reck | 6be2cab | 2016-10-03 14:38:06 -0700 | [diff] [blame] | 124 | @FastNative |
| 125 | private static native void nativeTraceBegin(long tag, String name); |
| 126 | @FastNative |
| 127 | private static native void nativeTraceEnd(long tag); |
| 128 | @FastNative |
| 129 | private static native void nativeAsyncTraceBegin(long tag, String name, int cookie); |
| 130 | @FastNative |
| 131 | private static native void nativeAsyncTraceEnd(long tag, String name, int cookie); |
| 132 | |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 133 | private Trace() { |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Returns true if a trace tag is enabled. |
| 138 | * |
| 139 | * @param traceTag The trace tag to check. |
| 140 | * @return True if the trace tag is valid. |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 141 | * |
| 142 | * @hide |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 143 | */ |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 144 | @UnsupportedAppUsage |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 145 | public static boolean isTagEnabled(long traceTag) { |
Florian Mayer | 9fd2102 | 2019-12-09 17:16:01 +0000 | [diff] [blame] | 146 | long tags = nativeGetEnabledTags(); |
Andy McFadden | d11ca4d | 2012-10-22 16:16:06 -0700 | [diff] [blame] | 147 | return (tags & traceTag) != 0; |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 148 | } |
| 149 | |
| 150 | /** |
| 151 | * Writes trace message to indicate the value of a given counter. |
| 152 | * |
| 153 | * @param traceTag The trace tag. |
| 154 | * @param counterName The counter name to appear in the trace. |
| 155 | * @param counterValue The counter value. |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 156 | * |
| 157 | * @hide |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 158 | */ |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 159 | @UnsupportedAppUsage |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 160 | public static void traceCounter(long traceTag, String counterName, int counterValue) { |
Andy McFadden | d11ca4d | 2012-10-22 16:16:06 -0700 | [diff] [blame] | 161 | if (isTagEnabled(traceTag)) { |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 162 | nativeTraceCounter(traceTag, counterName, counterValue); |
| 163 | } |
| 164 | } |
| 165 | |
| 166 | /** |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 167 | * Set whether application tracing is allowed for this process. This is intended to be set |
| 168 | * once at application start-up time based on whether the application is debuggable. |
| 169 | * |
| 170 | * @hide |
| 171 | */ |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 172 | @UnsupportedAppUsage |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 173 | public static void setAppTracingAllowed(boolean allowed) { |
| 174 | nativeSetAppTracingAllowed(allowed); |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | /** |
Jamie Gennis | 6ad0452 | 2013-04-15 18:53:24 -0700 | [diff] [blame] | 178 | * Set whether tracing is enabled in this process. Tracing is disabled shortly after Zygote |
| 179 | * initializes and re-enabled after processes fork from Zygote. This is done because Zygote |
| 180 | * has no way to be notified about changes to the tracing tags, and if Zygote ever reads and |
| 181 | * caches the tracing tags, forked processes will inherit those stale tags. |
| 182 | * |
| 183 | * @hide |
| 184 | */ |
John Reck | 62cc119 | 2017-05-12 15:39:51 -0700 | [diff] [blame] | 185 | public static void setTracingEnabled(boolean enabled, int debugFlags) { |
Jamie Gennis | 6ad0452 | 2013-04-15 18:53:24 -0700 | [diff] [blame] | 186 | nativeSetTracingEnabled(enabled); |
John Reck | 62cc119 | 2017-05-12 15:39:51 -0700 | [diff] [blame] | 187 | sZygoteDebugFlags = debugFlags; |
Jamie Gennis | 6ad0452 | 2013-04-15 18:53:24 -0700 | [diff] [blame] | 188 | } |
| 189 | |
| 190 | /** |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 191 | * Writes a trace message to indicate that a given section of code has |
| 192 | * begun. Must be followed by a call to {@link #traceEnd} using the same |
| 193 | * tag. |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 194 | * |
| 195 | * @param traceTag The trace tag. |
| 196 | * @param methodName The method name to appear in the trace. |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 197 | * |
| 198 | * @hide |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 199 | */ |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 200 | @UnsupportedAppUsage |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 201 | public static void traceBegin(long traceTag, String methodName) { |
Andy McFadden | d11ca4d | 2012-10-22 16:16:06 -0700 | [diff] [blame] | 202 | if (isTagEnabled(traceTag)) { |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 203 | nativeTraceBegin(traceTag, methodName); |
| 204 | } |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Writes a trace message to indicate that the current method has ended. |
| 209 | * Must be called exactly once for each call to {@link #traceBegin} using the same tag. |
| 210 | * |
| 211 | * @param traceTag The trace tag. |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 212 | * |
| 213 | * @hide |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 214 | */ |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 215 | @UnsupportedAppUsage |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 216 | public static void traceEnd(long traceTag) { |
Andy McFadden | d11ca4d | 2012-10-22 16:16:06 -0700 | [diff] [blame] | 217 | if (isTagEnabled(traceTag)) { |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 218 | nativeTraceEnd(traceTag); |
| 219 | } |
| 220 | } |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 221 | |
| 222 | /** |
Romain Guy | 9425f92 | 2013-04-10 16:35:48 -0700 | [diff] [blame] | 223 | * Writes a trace message to indicate that a given section of code has |
| 224 | * begun. Must be followed by a call to {@link #asyncTraceEnd} using the same |
| 225 | * tag. Unlike {@link #traceBegin(long, String)} and {@link #traceEnd(long)}, |
| 226 | * asynchronous events do not need to be nested. The name and cookie used to |
| 227 | * begin an event must be used to end it. |
| 228 | * |
| 229 | * @param traceTag The trace tag. |
| 230 | * @param methodName The method name to appear in the trace. |
| 231 | * @param cookie Unique identifier for distinguishing simultaneous events |
| 232 | * |
| 233 | * @hide |
| 234 | */ |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 235 | @UnsupportedAppUsage |
Romain Guy | 9425f92 | 2013-04-10 16:35:48 -0700 | [diff] [blame] | 236 | public static void asyncTraceBegin(long traceTag, String methodName, int cookie) { |
| 237 | if (isTagEnabled(traceTag)) { |
| 238 | nativeAsyncTraceBegin(traceTag, methodName, cookie); |
| 239 | } |
| 240 | } |
| 241 | |
| 242 | /** |
| 243 | * Writes a trace message to indicate that the current method has ended. |
| 244 | * Must be called exactly once for each call to {@link #asyncTraceBegin(long, String, int)} |
| 245 | * using the same tag, name and cookie. |
| 246 | * |
| 247 | * @param traceTag The trace tag. |
| 248 | * @param methodName The method name to appear in the trace. |
| 249 | * @param cookie Unique identifier for distinguishing simultaneous events |
| 250 | * |
| 251 | * @hide |
| 252 | */ |
Andrei Onea | 24ec321 | 2019-03-15 17:35:05 +0000 | [diff] [blame] | 253 | @UnsupportedAppUsage |
Romain Guy | 9425f92 | 2013-04-10 16:35:48 -0700 | [diff] [blame] | 254 | public static void asyncTraceEnd(long traceTag, String methodName, int cookie) { |
| 255 | if (isTagEnabled(traceTag)) { |
| 256 | nativeAsyncTraceEnd(traceTag, methodName, cookie); |
| 257 | } |
| 258 | } |
| 259 | |
| 260 | /** |
John Reck | d5a9dc0 | 2018-07-16 10:42:35 -0700 | [diff] [blame] | 261 | * Checks whether or not tracing is currently enabled. This is useful to avoid intermediate |
| 262 | * string creation for trace sections that require formatting. It is not necessary |
| 263 | * to guard all Trace method calls as they internally already check this. However it is |
| 264 | * recommended to use this to prevent creating any temporary objects that would then be |
| 265 | * passed to those methods to reduce runtime cost when tracing isn't enabled. |
| 266 | * |
| 267 | * @return true if tracing is currently enabled, false otherwise |
| 268 | */ |
| 269 | public static boolean isEnabled() { |
| 270 | return isTagEnabled(TRACE_TAG_APP); |
| 271 | } |
| 272 | |
| 273 | /** |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 274 | * Writes a trace message to indicate that a given section of code has begun. This call must |
Jamie Gennis | 5800fc8 | 2013-04-09 18:37:22 -0700 | [diff] [blame] | 275 | * be followed by a corresponding call to {@link #endSection()} on the same thread. |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 276 | * |
| 277 | * <p class="note"> At this time the vertical bar character '|', newline character '\n', and |
| 278 | * null character '\0' are used internally by the tracing mechanism. If sectionName contains |
| 279 | * these characters they will be replaced with a space character in the trace. |
| 280 | * |
| 281 | * @param sectionName The name of the code section to appear in the trace. This may be at |
| 282 | * most 127 Unicode code units long. |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 283 | */ |
John Reck | 13f08e6 | 2019-01-09 11:16:28 -0800 | [diff] [blame] | 284 | public static void beginSection(@NonNull String sectionName) { |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 285 | if (isTagEnabled(TRACE_TAG_APP)) { |
| 286 | if (sectionName.length() > MAX_SECTION_NAME_LEN) { |
| 287 | throw new IllegalArgumentException("sectionName is too long"); |
| 288 | } |
| 289 | nativeTraceBegin(TRACE_TAG_APP, sectionName); |
| 290 | } |
| 291 | } |
| 292 | |
| 293 | /** |
| 294 | * Writes a trace message to indicate that a given section of code has ended. This call must |
Jamie Gennis | 5800fc8 | 2013-04-09 18:37:22 -0700 | [diff] [blame] | 295 | * be preceeded by a corresponding call to {@link #beginSection(String)}. Calling this method |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 296 | * will mark the end of the most recently begun section of code, so care must be taken to |
Jamie Gennis | 5800fc8 | 2013-04-09 18:37:22 -0700 | [diff] [blame] | 297 | * ensure that beginSection / endSection pairs are properly nested and called from the same |
| 298 | * thread. |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 299 | */ |
Jamie Gennis | 5800fc8 | 2013-04-09 18:37:22 -0700 | [diff] [blame] | 300 | public static void endSection() { |
Jamie Gennis | f9c7d6b | 2013-03-25 14:18:25 -0700 | [diff] [blame] | 301 | if (isTagEnabled(TRACE_TAG_APP)) { |
| 302 | nativeTraceEnd(TRACE_TAG_APP); |
| 303 | } |
| 304 | } |
John Reck | d5a9dc0 | 2018-07-16 10:42:35 -0700 | [diff] [blame] | 305 | |
| 306 | /** |
| 307 | * Writes a trace message to indicate that a given section of code has |
| 308 | * begun. Must be followed by a call to {@link #endAsyncSection(String, int)} with the same |
| 309 | * methodName and cookie. Unlike {@link #beginSection(String)} and {@link #endSection()}, |
| 310 | * asynchronous events do not need to be nested. The name and cookie used to |
| 311 | * begin an event must be used to end it. |
| 312 | * |
| 313 | * @param methodName The method name to appear in the trace. |
| 314 | * @param cookie Unique identifier for distinguishing simultaneous events |
| 315 | */ |
John Reck | 13f08e6 | 2019-01-09 11:16:28 -0800 | [diff] [blame] | 316 | public static void beginAsyncSection(@NonNull String methodName, int cookie) { |
John Reck | d5a9dc0 | 2018-07-16 10:42:35 -0700 | [diff] [blame] | 317 | asyncTraceBegin(TRACE_TAG_APP, methodName, cookie); |
| 318 | } |
| 319 | |
| 320 | /** |
| 321 | * Writes a trace message to indicate that the current method has ended. |
| 322 | * Must be called exactly once for each call to {@link #beginAsyncSection(String, int)} |
| 323 | * using the same name and cookie. |
| 324 | * |
| 325 | * @param methodName The method name to appear in the trace. |
| 326 | * @param cookie Unique identifier for distinguishing simultaneous events |
| 327 | */ |
John Reck | 13f08e6 | 2019-01-09 11:16:28 -0800 | [diff] [blame] | 328 | public static void endAsyncSection(@NonNull String methodName, int cookie) { |
John Reck | d5a9dc0 | 2018-07-16 10:42:35 -0700 | [diff] [blame] | 329 | asyncTraceEnd(TRACE_TAG_APP, methodName, cookie); |
| 330 | } |
| 331 | |
| 332 | /** |
| 333 | * Writes trace message to indicate the value of a given counter. |
| 334 | * |
| 335 | * @param counterName The counter name to appear in the trace. |
| 336 | * @param counterValue The counter value. |
| 337 | */ |
John Reck | 13f08e6 | 2019-01-09 11:16:28 -0800 | [diff] [blame] | 338 | public static void setCounter(@NonNull String counterName, long counterValue) { |
John Reck | d5a9dc0 | 2018-07-16 10:42:35 -0700 | [diff] [blame] | 339 | if (isTagEnabled(TRACE_TAG_APP)) { |
| 340 | nativeTraceCounter(TRACE_TAG_APP, counterName, counterValue); |
| 341 | } |
| 342 | } |
Jeff Brown | 481c157 | 2012-03-09 14:41:15 -0800 | [diff] [blame] | 343 | } |