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_PACKAGE_MANAGER  (1<<18)
71 #define ATRACE_TAG_SYSTEM_SERVER    (1<<19)
72 #define ATRACE_TAG_DATABASE         (1<<20)
73 #define ATRACE_TAG_NETWORK          (1<<21)
74 #define ATRACE_TAG_ADB              (1<<22)
75 #define ATRACE_TAG_LAST             ATRACE_TAG_ADB
76 
77 // Reserved for initialization.
78 #define ATRACE_TAG_NOT_READY        (1ULL<<63)
79 
80 #define ATRACE_TAG_VALID_MASK ((ATRACE_TAG_LAST - 1) | ATRACE_TAG_LAST)
81 
82 #ifndef ATRACE_TAG
83 #define ATRACE_TAG ATRACE_TAG_NEVER
84 #elif ATRACE_TAG > ATRACE_TAG_VALID_MASK
85 #error ATRACE_TAG must be defined to be one of the tags defined in cutils/trace.h
86 #endif
87 
88 /**
89  * Opens the trace file for writing and reads the property for initial tags.
90  * The atrace.tags.enableflags property sets the tags to trace.
91  * This function should not be explicitly called, the first call to any normal
92  * trace function will cause it to be run safely.
93  */
94 void atrace_setup();
95 
96 /**
97  * If tracing is ready, set atrace_enabled_tags to the system property
98  * debug.atrace.tags.enableflags. Can be used as a sysprop change callback.
99  */
100 void atrace_update_tags();
101 
102 /**
103  * Set whether the process is debuggable.  By default the process is not
104  * considered debuggable.  If the process is not debuggable then application-
105  * level tracing is not allowed unless the ro.debuggable system property is
106  * set to '1'.
107  */
108 void atrace_set_debuggable(bool debuggable);
109 
110 /**
111  * Set whether tracing is enabled for the current process.  This is used to
112  * prevent tracing within the Zygote process.
113  */
114 void atrace_set_tracing_enabled(bool enabled);
115 
116 /**
117  * Flag indicating whether setup has been completed, initialized to 0.
118  * Nonzero indicates setup has completed.
119  * Note: This does NOT indicate whether or not setup was successful.
120  */
121 extern atomic_bool atrace_is_ready;
122 
123 /**
124  * Set of ATRACE_TAG flags to trace for, initialized to ATRACE_TAG_NOT_READY.
125  * A value of zero indicates setup has failed.
126  * Any other nonzero value indicates setup has succeeded, and tracing is on.
127  */
128 extern uint64_t atrace_enabled_tags;
129 
130 /**
131  * Handle to the kernel's trace buffer, initialized to -1.
132  * Any other value indicates setup has succeeded, and is a valid fd for tracing.
133  */
134 extern int atrace_marker_fd;
135 
136 /**
137  * atrace_init readies the process for tracing by opening the trace_marker file.
138  * Calling any trace function causes this to be run, so calling it is optional.
139  * This can be explicitly run to avoid setup delay on first trace function.
140  */
141 #define ATRACE_INIT() atrace_init()
atrace_init()142 static inline void atrace_init()
143 {
144     if (CC_UNLIKELY(!atomic_load_explicit(&atrace_is_ready, memory_order_acquire))) {
145         atrace_setup();
146     }
147 }
148 
149 /**
150  * Get the mask of all tags currently enabled.
151  * It can be used as a guard condition around more expensive trace calculations.
152  * Every trace function calls this, which ensures atrace_init is run.
153  */
154 #define ATRACE_GET_ENABLED_TAGS() atrace_get_enabled_tags()
atrace_get_enabled_tags()155 static inline uint64_t atrace_get_enabled_tags()
156 {
157     atrace_init();
158     return atrace_enabled_tags;
159 }
160 
161 /**
162  * Test if a given tag is currently enabled.
163  * Returns nonzero if the tag is enabled, otherwise zero.
164  * It can be used as a guard condition around more expensive trace calculations.
165  */
166 #define ATRACE_ENABLED() atrace_is_tag_enabled(ATRACE_TAG)
atrace_is_tag_enabled(uint64_t tag)167 static inline uint64_t atrace_is_tag_enabled(uint64_t tag)
168 {
169     return atrace_get_enabled_tags() & tag;
170 }
171 
172 /**
173  * Trace the beginning of a context.  name is used to identify the context.
174  * This is often used to time function execution.
175  */
176 #define ATRACE_BEGIN(name) atrace_begin(ATRACE_TAG, name)
atrace_begin(uint64_t tag,const char * name)177 static inline void atrace_begin(uint64_t tag, const char* name)
178 {
179     if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) {
180         void atrace_begin_body(const char*);
181         atrace_begin_body(name);
182     }
183 }
184 
185 /**
186  * Trace the end of a context.
187  * This should match up (and occur after) a corresponding ATRACE_BEGIN.
188  */
189 #define ATRACE_END() atrace_end(ATRACE_TAG)
atrace_end(uint64_t tag)190 static inline void atrace_end(uint64_t tag)
191 {
192     if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) {
193         void atrace_end_body();
194         atrace_end_body();
195     }
196 }
197 
198 /**
199  * Trace the beginning of an asynchronous event. Unlike ATRACE_BEGIN/ATRACE_END
200  * contexts, asynchronous events do not need to be nested. The name describes
201  * the event, and the cookie provides a unique identifier for distinguishing
202  * simultaneous events. The name and cookie used to begin an event must be
203  * used to end it.
204  */
205 #define ATRACE_ASYNC_BEGIN(name, cookie) \
206     atrace_async_begin(ATRACE_TAG, name, cookie)
atrace_async_begin(uint64_t tag,const char * name,int32_t cookie)207 static inline void atrace_async_begin(uint64_t tag, const char* name,
208         int32_t cookie)
209 {
210     if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) {
211         void atrace_async_begin_body(const char*, int32_t);
212         atrace_async_begin_body(name, cookie);
213     }
214 }
215 
216 /**
217  * Trace the end of an asynchronous event.
218  * This should have a corresponding ATRACE_ASYNC_BEGIN.
219  */
220 #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)221 static inline void atrace_async_end(uint64_t tag, const char* name, int32_t cookie)
222 {
223     if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) {
224         void atrace_async_end_body(const char*, int32_t);
225         atrace_async_end_body(name, cookie);
226     }
227 }
228 
229 /**
230  * Traces an integer counter value.  name is used to identify the counter.
231  * This can be used to track how a value changes over time.
232  */
233 #define ATRACE_INT(name, value) atrace_int(ATRACE_TAG, name, value)
atrace_int(uint64_t tag,const char * name,int32_t value)234 static inline void atrace_int(uint64_t tag, const char* name, int32_t value)
235 {
236     if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) {
237         void atrace_int_body(const char*, int32_t);
238         atrace_int_body(name, value);
239     }
240 }
241 
242 /**
243  * Traces a 64-bit integer counter value.  name is used to identify the
244  * counter. This can be used to track how a value changes over time.
245  */
246 #define ATRACE_INT64(name, value) atrace_int64(ATRACE_TAG, name, value)
atrace_int64(uint64_t tag,const char * name,int64_t value)247 static inline void atrace_int64(uint64_t tag, const char* name, int64_t value)
248 {
249     if (CC_UNLIKELY(atrace_is_tag_enabled(tag))) {
250         void atrace_int64_body(const char*, int64_t);
251         atrace_int64_body(name, value);
252     }
253 }
254 
255 __END_DECLS
256 
257 #endif // _LIBS_CUTILS_TRACE_H
258