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 29 #include <cutils/compiler.h> 30 31 __BEGIN_DECLS 32 33 /** 34 * The ATRACE_TAG macro can be defined before including this header to trace 35 * using one of the tags defined below. It must be defined to one of the 36 * following ATRACE_TAG_* macros. The trace tag is used to filter tracing in 37 * userland to avoid some of the runtime cost of tracing when it is not desired. 38 * 39 * Defining ATRACE_TAG to be ATRACE_TAG_ALWAYS will result in the tracing always 40 * being enabled - this should ONLY be done for debug code, as userland tracing 41 * has a performance cost even when the trace is not being recorded. Defining 42 * ATRACE_TAG to be ATRACE_TAG_NEVER or leaving ATRACE_TAG undefined will result 43 * in the tracing always being disabled. 44 * 45 * ATRACE_TAG_HAL should be bitwise ORed with the relevant tags for tracing 46 * within a hardware module. For example a camera hardware module would set: 47 * #define ATRACE_TAG (ATRACE_TAG_CAMERA | ATRACE_TAG_HAL) 48 * 49 * Keep these in sync with frameworks/base/core/java/android/os/Trace.java. 50 */ 51 #define ATRACE_TAG_NEVER 0 // This tag is never enabled. 52 #define ATRACE_TAG_ALWAYS (1<<0) // This tag is always enabled. 53 #define ATRACE_TAG_GRAPHICS (1<<1) 54 #define ATRACE_TAG_INPUT (1<<2) 55 #define ATRACE_TAG_VIEW (1<<3) 56 #define ATRACE_TAG_WEBVIEW (1<<4) 57 #define ATRACE_TAG_WINDOW_MANAGER (1<<5) 58 #define ATRACE_TAG_ACTIVITY_MANAGER (1<<6) 59 #define ATRACE_TAG_SYNC_MANAGER (1<<7) 60 #define ATRACE_TAG_AUDIO (1<<8) 61 #define ATRACE_TAG_VIDEO (1<<9) 62 #define ATRACE_TAG_CAMERA (1<<10) 63 #define ATRACE_TAG_HAL (1<<11) 64 #define ATRACE_TAG_APP (1<<12) 65 #define ATRACE_TAG_RESOURCES (1<<13) 66 #define ATRACE_TAG_DALVIK (1<<14) 67 #define ATRACE_TAG_RS (1<<15) 68 #define ATRACE_TAG_BIONIC (1<<16) 69 #define ATRACE_TAG_POWER (1<<17) 70 #define ATRACE_TAG_LAST ATRACE_TAG_POWER 71 72 // Reserved for initialization. 73 #define ATRACE_TAG_NOT_READY (1LL<<63) 74 75 #define ATRACE_TAG_VALID_MASK ((ATRACE_TAG_LAST - 1) | ATRACE_TAG_LAST) 76 77 #ifndef ATRACE_TAG 78 #define ATRACE_TAG ATRACE_TAG_NEVER 79 #elif ATRACE_TAG > ATRACE_TAG_VALID_MASK 80 #error ATRACE_TAG must be defined to be one of the tags defined in cutils/trace.h 81 #endif 82 83 /** 84 * Opens the trace file for writing and reads the property for initial tags. 85 * The atrace.tags.enableflags property sets the tags to trace. 86 * This function should not be explicitly called, the first call to any normal 87 * trace function will cause it to be run safely. 88 */ 89 void atrace_setup(); 90 91 /** 92 * If tracing is ready, set atrace_enabled_tags to the system property 93 * debug.atrace.tags.enableflags. Can be used as a sysprop change callback. 94 */ 95 void atrace_update_tags(); 96 97 /** 98 * Set whether the process is debuggable. By default the process is not 99 * considered debuggable. If the process is not debuggable then application- 100 * level tracing is not allowed unless the ro.debuggable system property is 101 * set to '1'. 102 */ 103 void atrace_set_debuggable(bool debuggable); 104 105 /** 106 * Set whether tracing is enabled for the current process. This is used to 107 * prevent tracing within the Zygote process. 108 */ 109 void atrace_set_tracing_enabled(bool enabled); 110 111 /** 112 * Flag indicating whether setup has been completed, initialized to 0. 113 * Nonzero indicates setup has completed. 114 * Note: This does NOT indicate whether or not setup was successful. 115 */ 116 extern atomic_bool atrace_is_ready; 117 118 /** 119 * Set of ATRACE_TAG flags to trace for, initialized to ATRACE_TAG_NOT_READY. 120 * A value of zero indicates setup has failed. 121 * Any other nonzero value indicates setup has succeeded, and tracing is on. 122 */ 123 extern uint64_t atrace_enabled_tags; 124 125 /** 126 * Handle to the kernel's trace buffer, initialized to -1. 127 * Any other value indicates setup has succeeded, and is a valid fd for tracing. 128 */ 129 extern int atrace_marker_fd; 130 131 /** 132 * atrace_init readies the process for tracing by opening the trace_marker file. 133 * Calling any trace function causes this to be run, so calling it is optional. 134 * This can be explicitly run to avoid setup delay on first trace function. 135 */ 136 #define ATRACE_INIT() atrace_init() 137 static inline void atrace_init() 138 { 139 if (CC_UNLIKELY(!atomic_load_explicit(&atrace_is_ready, memory_order_acquire))) { 140 atrace_setup(); 141 } 142 } 143 144 /** 145 * Get the mask of all tags currently enabled. 146 * It can be used as a guard condition around more expensive trace calculations. 147 * Every trace function calls this, which ensures atrace_init is run. 148 */ 149 #define ATRACE_GET_ENABLED_TAGS() atrace_get_enabled_tags() 150 static inline uint64_t atrace_get_enabled_tags() 151 { 152 atrace_init(); 153 return atrace_enabled_tags; 154 } 155 156 /** 157 * Test if a given tag is currently enabled. 158 * Returns nonzero if the tag is enabled, otherwise zero. 159 * It can be used as a guard condition around more expensive trace calculations. 160 */ 161 #define ATRACE_ENABLED() atrace_is_tag_enabled(ATRACE_TAG) 162 static inline uint64_t atrace_is_tag_enabled(uint64_t tag) 163 { 164 return atrace_get_enabled_tags() & tag; 165 } 166 167 /** 168 * Trace the beginning of a context. name is used to identify the context. 169 * This is often used to time function execution. 170 */ 171 #define ATRACE_BEGIN(name) atrace_begin(ATRACE_TAG, name) 172 static inline void atrace_begin(uint64_t tag, const char* name) 173 { 174 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 175 void atrace_begin_body(const char*); 176 atrace_begin_body(name); 177 } 178 } 179 180 /** 181 * Trace the end of a context. 182 * This should match up (and occur after) a corresponding ATRACE_BEGIN. 183 */ 184 #define ATRACE_END() atrace_end(ATRACE_TAG) 185 static inline void atrace_end(uint64_t tag) 186 { 187 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 188 char c = 'E'; 189 write(atrace_marker_fd, &c, 1); 190 } 191 } 192 193 /** 194 * Trace the beginning of an asynchronous event. Unlike ATRACE_BEGIN/ATRACE_END 195 * contexts, asynchronous events do not need to be nested. The name describes 196 * the event, and the cookie provides a unique identifier for distinguishing 197 * simultaneous events. The name and cookie used to begin an event must be 198 * used to end it. 199 */ 200 #define ATRACE_ASYNC_BEGIN(name, cookie) \ 201 atrace_async_begin(ATRACE_TAG, name, cookie) 202 static inline void atrace_async_begin(uint64_t tag, const char* name, 203 int32_t cookie) 204 { 205 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 206 void atrace_async_begin_body(const char*, int32_t); 207 atrace_async_begin_body(name, cookie); 208 } 209 } 210 211 /** 212 * Trace the end of an asynchronous event. 213 * This should have a corresponding ATRACE_ASYNC_BEGIN. 214 */ 215 #define ATRACE_ASYNC_END(name, cookie) atrace_async_end(ATRACE_TAG, name, cookie) 216 static inline void atrace_async_end(uint64_t tag, const char* name, int32_t cookie) 217 { 218 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 219 void atrace_async_end_body(const char*, int32_t); 220 atrace_async_end_body(name, cookie); 221 } 222 } 223 224 /** 225 * Traces an integer counter value. name is used to identify the counter. 226 * This can be used to track how a value changes over time. 227 */ 228 #define ATRACE_INT(name, value) atrace_int(ATRACE_TAG, name, value) 229 static inline void atrace_int(uint64_t tag, const char* name, int32_t value) 230 { 231 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 232 void atrace_int_body(const char*, int32_t); 233 atrace_int_body(name, value); 234 } 235 } 236 237 /** 238 * Traces a 64-bit integer counter value. name is used to identify the 239 * counter. This can be used to track how a value changes over time. 240 */ 241 #define ATRACE_INT64(name, value) atrace_int64(ATRACE_TAG, name, value) 242 static inline void atrace_int64(uint64_t tag, const char* name, int64_t value) 243 { 244 if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) { 245 void atrace_int64_body(const char*, int64_t); 246 atrace_int64_body(name, value); 247 } 248 } 249 250 __END_DECLS 251 252 #endif // _LIBS_CUTILS_TRACE_H 253
