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