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 #ifndef _LIBS_CUTILS_TRACE_H 18 #define _LIBS_CUTILS_TRACE_H 19 20 #include <inttypes.h> 21 #include <stdatomic.h> 22 #include <stdbool.h> 23 #include <stdint.h> 24 #include <stdio.h> 25 #include <sys/cdefs.h> 26 #include <sys/types.h> 27 #include <unistd.h> 28 #include <cutils/compiler.h> 29 30 __BEGIN_DECLS 31 32 /** 33 * The ATRACE_TAG macro can be defined before including this header to trace 34 * using one of the tags defined below. It must be defined to one of the 35 * following ATRACE_TAG_* macros. The trace tag is used to filter tracing in 36 * userland to avoid some of the runtime cost of tracing when it is not desired. 37 * 38 * Defining ATRACE_TAG to be ATRACE_TAG_ALWAYS will result in the tracing always 39 * being enabled - this should ONLY be done for debug code, as userland tracing 40 * has a performance cost even when the trace is not being recorded. Defining 41 * ATRACE_TAG to be ATRACE_TAG_NEVER or leaving ATRACE_TAG undefined will result 42 * in the tracing always being disabled. 43 * 44 * ATRACE_TAG_HAL should be bitwise ORed with the relevant tags for tracing 45 * within a hardware module. For example a camera hardware module would set: 46 * #define ATRACE_TAG (ATRACE_TAG_CAMERA | ATRACE_TAG_HAL) 47 * 48 * Keep these in sync with frameworks/base/core/java/android/os/Trace.java. 49 */ 50 #define ATRACE_TAG_NEVER 0 // This tag is never enabled. 51 #define ATRACE_TAG_ALWAYS (1<<0) // This tag is always enabled. 52 #define ATRACE_TAG_GRAPHICS (1<<1) 53 #define ATRACE_TAG_INPUT (1<<2) 54 #define ATRACE_TAG_VIEW (1<<3) 55 #define ATRACE_TAG_WEBVIEW (1<<4) 56 #define ATRACE_TAG_WINDOW_MANAGER (1<<5) 57 #define ATRACE_TAG_ACTIVITY_MANAGER (1<<6) 58 #define ATRACE_TAG_SYNC_MANAGER (1<<7) 59 #define ATRACE_TAG_AUDIO (1<<8) 60 #define ATRACE_TAG_VIDEO (1<<9) 61 #define ATRACE_TAG_CAMERA (1<<10) 62 #define ATRACE_TAG_HAL (1<<11) 63 #define ATRACE_TAG_APP (1<<12) 64 #define ATRACE_TAG_RESOURCES (1<<13) 65 #define ATRACE_TAG_DALVIK (1<<14) 66 #define ATRACE_TAG_RS (1<<15) 67 #define ATRACE_TAG_BIONIC (1<<16) 68 #define ATRACE_TAG_POWER (1<<17) 69 #define ATRACE_TAG_PACKAGE_MANAGER (1<<18) 70 #define ATRACE_TAG_SYSTEM_SERVER (1<<19) 71 #define ATRACE_TAG_DATABASE (1<<20) 72 #define ATRACE_TAG_NETWORK (1<<21) 73 #define ATRACE_TAG_ADB (1<<22) 74 #define ATRACE_TAG_VIBRATOR (1<<23) 75 #define ATRACE_TAG_AIDL (1<<24) 76 #define ATRACE_TAG_NNAPI (1<<25) 77 #define ATRACE_TAG_RRO (1<<26) 78 #define ATRACE_TAG_THERMAL (1 << 27) 79 #define ATRACE_TAG_LAST ATRACE_TAG_THERMAL 80 81 // Reserved for initialization. 82 #define ATRACE_TAG_NOT_READY (1ULL<<63) 83 84 #define ATRACE_TAG_VALID_MASK ((ATRACE_TAG_LAST - 1) | ATRACE_TAG_LAST) 85 86 #ifndef ATRACE_TAG 87 #define ATRACE_TAG ATRACE_TAG_NEVER 88 #elif ATRACE_TAG > ATRACE_TAG_VALID_MASK 89 #error ATRACE_TAG must be defined to be one of the tags defined in cutils/trace.h 90 #endif 91 92 /** 93 * Opens the trace file for writing and reads the property for initial tags. 94 * The atrace.tags.enableflags property sets the tags to trace. 95 * This function should not be explicitly called, the first call to any normal 96 * trace function will cause it to be run safely. 97 */ 98 void atrace_setup(); 99 100 /** 101 * If tracing is ready, set atrace_enabled_tags to the system property 102 * debug.atrace.tags.enableflags. Can be used as a sysprop change callback. 103 */ 104 void atrace_update_tags(); 105 106 /** 107 * Set whether tracing is enabled for the current process. This is used to 108 * prevent tracing within the Zygote process. 109 */ 110 void atrace_set_tracing_enabled(bool enabled); 111 112 /** 113 * This is always set to false. This forces code that uses an old version 114 * of this header to always call into atrace_setup, in which we call 115 * atrace_init unconditionally. 116 */ 117 extern atomic_bool atrace_is_ready; 118 119 /** 120 * Set of ATRACE_TAG flags to trace for, initialized to ATRACE_TAG_NOT_READY. 121 * A value of zero indicates setup has failed. 122 * Any other nonzero value indicates setup has succeeded, and tracing is on. 123 */ 124 extern uint64_t atrace_enabled_tags; 125 126 /** 127 * Handle to the kernel's trace buffer, initialized to -1. 128 * Any other value indicates setup has succeeded, and is a valid fd for tracing. 129 */ 130 extern int atrace_marker_fd; 131 132 /** 133 * atrace_init readies the process for tracing by opening the trace_marker file. 134 * Calling any trace function causes this to be run, so calling it is optional. 135 * This can be explicitly run to avoid setup delay on first trace function. 136 */ 137 #define ATRACE_INIT() atrace_init() 138 #define ATRACE_GET_ENABLED_TAGS() atrace_get_enabled_tags() 139 140 void atrace_init(); 141 uint64_t atrace_get_enabled_tags(); 142 143 /** 144 * Test if a given tag is currently enabled. 145 * Returns nonzero if the tag is enabled, otherwise zero. 146 * It can be used as a guard condition around more expensive trace calculations. 147 */ 148 #define ATRACE_ENABLED() atrace_is_tag_enabled(ATRACE_TAG) atrace_is_tag_enabled(uint64_t tag)149 static inline uint64_t atrace_is_tag_enabled(uint64_t tag) 150 { 151 return atrace_get_enabled_tags() & tag; 152 } 153 154 /** 155 * Trace the beginning of a context. name is used to identify the context. 156 * This is often used to time function execution. 157 */ 158 #define ATRACE_BEGIN(name) atrace_begin(ATRACE_TAG, name) atrace_begin(uint64_t tag,const char * name)159 static inline void atrace_begin(uint64_t tag, const char* name) 160 { 161 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 162 void atrace_begin_body(const char*); 163 atrace_begin_body(name); 164 } 165 } 166 167 /** 168 * Trace the end of a context. 169 * This should match up (and occur after) a corresponding ATRACE_BEGIN. 170 */ 171 #define ATRACE_END() atrace_end(ATRACE_TAG) atrace_end(uint64_t tag)172 static inline void atrace_end(uint64_t tag) 173 { 174 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 175 void atrace_end_body(); 176 atrace_end_body(); 177 } 178 } 179 180 /** 181 * Trace the beginning of an asynchronous event. Unlike ATRACE_BEGIN/ATRACE_END 182 * contexts, asynchronous events do not need to be nested. The name describes 183 * the event, and the cookie provides a unique identifier for distinguishing 184 * simultaneous events. The name and cookie used to begin an event must be 185 * used to end it. 186 */ 187 #define ATRACE_ASYNC_BEGIN(name, cookie) \ 188 atrace_async_begin(ATRACE_TAG, name, cookie) atrace_async_begin(uint64_t tag,const char * name,int32_t cookie)189 static inline void atrace_async_begin(uint64_t tag, const char* name, 190 int32_t cookie) 191 { 192 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 193 void atrace_async_begin_body(const char*, int32_t); 194 atrace_async_begin_body(name, cookie); 195 } 196 } 197 198 /** 199 * Trace the end of an asynchronous event. 200 * This should have a corresponding ATRACE_ASYNC_BEGIN. 201 */ 202 #define ATRACE_ASYNC_END(name, cookie) atrace_async_end(ATRACE_TAG, name, cookie) atrace_async_end(uint64_t tag,const char * name,int32_t cookie)203 static inline void atrace_async_end(uint64_t tag, const char* name, int32_t cookie) 204 { 205 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 206 void atrace_async_end_body(const char*, int32_t); 207 atrace_async_end_body(name, cookie); 208 } 209 } 210 211 /** 212 * Trace the beginning of an asynchronous event. In addition to the name and a 213 * cookie as in ATRACE_ASYNC_BEGIN/ATRACE_ASYNC_END, a track name argument is 214 * provided, which is the name of the row where this async event should be 215 * recorded. The track name, name, and cookie used to begin an event must be 216 * used to end it. 217 * The cookie here must be unique on the track_name level, not the name level. 218 */ 219 #define ATRACE_ASYNC_FOR_TRACK_BEGIN(track_name, name, cookie) \ 220 atrace_async_for_track_begin(ATRACE_TAG, track_name, name, cookie) atrace_async_for_track_begin(uint64_t tag,const char * track_name,const char * name,int32_t cookie)221 static inline void atrace_async_for_track_begin(uint64_t tag, const char* track_name, 222 const char* name, int32_t cookie) { 223 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 224 void atrace_async_for_track_begin_body(const char*, const char*, int32_t); 225 atrace_async_for_track_begin_body(track_name, name, cookie); 226 } 227 } 228 229 /** 230 * Trace the end of an asynchronous event. 231 * This should correspond to a previous ATRACE_ASYNC_FOR_TRACK_BEGIN. 232 */ 233 #define ATRACE_ASYNC_FOR_TRACK_END(track_name, cookie) \ 234 atrace_async_for_track_end(ATRACE_TAG, track_name, cookie) atrace_async_for_track_end(uint64_t tag,const char * track_name,int32_t cookie)235 static inline void atrace_async_for_track_end(uint64_t tag, const char* track_name, 236 int32_t cookie) { 237 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 238 void atrace_async_for_track_end_body(const char*, int32_t); 239 atrace_async_for_track_end_body(track_name, cookie); 240 } 241 } 242 243 /** 244 * Trace an instantaneous context. name is used to identify the context. 245 * 246 * An "instant" is an event with no defined duration. Visually is displayed like a single marker 247 * in the timeline (rather than a span, in the case of begin/end events). 248 * 249 * By default, instant events are added into a dedicated track that has the same name of the event. 250 * Use atrace_instant_for_track to put different instant events into the same timeline track/row. 251 */ 252 #define ATRACE_INSTANT(name) atrace_instant(ATRACE_TAG, name) atrace_instant(uint64_t tag,const char * name)253 static inline void atrace_instant(uint64_t tag, const char* name) { 254 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 255 void atrace_instant_body(const char*); 256 atrace_instant_body(name); 257 } 258 } 259 260 /** 261 * Trace an instantaneous context. name is used to identify the context. 262 * track_name is the name of the row where the event should be recorded. 263 * 264 * An "instant" is an event with no defined duration. Visually is displayed like a single marker 265 * in the timeline (rather than a span, in the case of begin/end events). 266 */ 267 #define ATRACE_INSTANT_FOR_TRACK(trackName, name) \ 268 atrace_instant_for_track(ATRACE_TAG, trackName, name) atrace_instant_for_track(uint64_t tag,const char * track_name,const char * name)269 static inline void atrace_instant_for_track(uint64_t tag, const char* track_name, 270 const char* name) { 271 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 272 void atrace_instant_for_track_body(const char*, const char*); 273 atrace_instant_for_track_body(track_name, name); 274 } 275 } 276 277 /** 278 * Traces an integer counter value. name is used to identify the counter. 279 * This can be used to track how a value changes over time. 280 */ 281 #define ATRACE_INT(name, value) atrace_int(ATRACE_TAG, name, value) atrace_int(uint64_t tag,const char * name,int32_t value)282 static inline void atrace_int(uint64_t tag, const char* name, int32_t value) 283 { 284 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 285 void atrace_int_body(const char*, int32_t); 286 atrace_int_body(name, value); 287 } 288 } 289 290 /** 291 * Traces a 64-bit integer counter value. name is used to identify the 292 * counter. This can be used to track how a value changes over time. 293 */ 294 #define ATRACE_INT64(name, value) atrace_int64(ATRACE_TAG, name, value) atrace_int64(uint64_t tag,const char * name,int64_t value)295 static inline void atrace_int64(uint64_t tag, const char* name, int64_t value) 296 { 297 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 298 void atrace_int64_body(const char*, int64_t); 299 atrace_int64_body(name, value); 300 } 301 } 302 303 __END_DECLS 304 305 #endif // _LIBS_CUTILS_TRACE_H 306