| OLD | NEW |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 // This header file defines the set of trace_event macros without specifying | 5 // In the process of moving the trace event files. Right now the headers |
| 6 // how the events actually get collected and stored. If you need to expose trace | 6 // are being forwarded. In next CLs the change will get completed |
| 7 // events to some other universe, you can copy-and-paste this file as well as | 7 // TODO(ssid): https://code.google.com/p/chromium/issues/detail?id=451032 |
| 8 // trace_event.h, modifying the macros contained there as necessary for the | |
| 9 // target platform. The end result is that multiple libraries can funnel events | |
| 10 // through to a shared trace event collector. | |
| 11 | |
| 12 // Trace events are for tracking application performance and resource usage. | |
| 13 // Macros are provided to track: | |
| 14 // Begin and end of function calls | |
| 15 // Counters | |
| 16 // | |
| 17 // Events are issued against categories. Whereas LOG's | |
| 18 // categories are statically defined, TRACE categories are created | |
| 19 // implicitly with a string. For example: | |
| 20 // TRACE_EVENT_INSTANT0("MY_SUBSYSTEM", "SomeImportantEvent", | |
| 21 // TRACE_EVENT_SCOPE_THREAD) | |
| 22 // | |
| 23 // It is often the case that one trace may belong in multiple categories at the | |
| 24 // same time. The first argument to the trace can be a comma-separated list of | |
| 25 // categories, forming a category group, like: | |
| 26 // | |
| 27 // TRACE_EVENT_INSTANT0("input,views", "OnMouseOver", TRACE_EVENT_SCOPE_THREAD) | |
| 28 // | |
| 29 // We can enable/disable tracing of OnMouseOver by enabling/disabling either | |
| 30 // category. | |
| 31 // | |
| 32 // Events can be INSTANT, or can be pairs of BEGIN and END in the same scope: | |
| 33 // TRACE_EVENT_BEGIN0("MY_SUBSYSTEM", "SomethingCostly") | |
| 34 // doSomethingCostly() | |
| 35 // TRACE_EVENT_END0("MY_SUBSYSTEM", "SomethingCostly") | |
| 36 // Note: our tools can't always determine the correct BEGIN/END pairs unless | |
| 37 // these are used in the same scope. Use ASYNC_BEGIN/ASYNC_END macros if you | |
| 38 // need them to be in separate scopes. | |
| 39 // | |
| 40 // A common use case is to trace entire function scopes. This | |
| 41 // issues a trace BEGIN and END automatically: | |
| 42 // void doSomethingCostly() { | |
| 43 // TRACE_EVENT0("MY_SUBSYSTEM", "doSomethingCostly"); | |
| 44 // ... | |
| 45 // } | |
| 46 // | |
| 47 // Additional parameters can be associated with an event: | |
| 48 // void doSomethingCostly2(int howMuch) { | |
| 49 // TRACE_EVENT1("MY_SUBSYSTEM", "doSomethingCostly", | |
| 50 // "howMuch", howMuch); | |
| 51 // ... | |
| 52 // } | |
| 53 // | |
| 54 // The trace system will automatically add to this information the | |
| 55 // current process id, thread id, and a timestamp in microseconds. | |
| 56 // | |
| 57 // To trace an asynchronous procedure such as an IPC send/receive, use | |
| 58 // ASYNC_BEGIN and ASYNC_END: | |
| 59 // [single threaded sender code] | |
| 60 // static int send_count = 0; | |
| 61 // ++send_count; | |
| 62 // TRACE_EVENT_ASYNC_BEGIN0("ipc", "message", send_count); | |
| 63 // Send(new MyMessage(send_count)); | |
| 64 // [receive code] | |
| 65 // void OnMyMessage(send_count) { | |
| 66 // TRACE_EVENT_ASYNC_END0("ipc", "message", send_count); | |
| 67 // } | |
| 68 // The third parameter is a unique ID to match ASYNC_BEGIN/ASYNC_END pairs. | |
| 69 // ASYNC_BEGIN and ASYNC_END can occur on any thread of any traced process. | |
| 70 // Pointers can be used for the ID parameter, and they will be mangled | |
| 71 // internally so that the same pointer on two different processes will not | |
| 72 // match. For example: | |
| 73 // class MyTracedClass { | |
| 74 // public: | |
| 75 // MyTracedClass() { | |
| 76 // TRACE_EVENT_ASYNC_BEGIN0("category", "MyTracedClass", this); | |
| 77 // } | |
| 78 // ~MyTracedClass() { | |
| 79 // TRACE_EVENT_ASYNC_END0("category", "MyTracedClass", this); | |
| 80 // } | |
| 81 // } | |
| 82 // | |
| 83 // Trace event also supports counters, which is a way to track a quantity | |
| 84 // as it varies over time. Counters are created with the following macro: | |
| 85 // TRACE_COUNTER1("MY_SUBSYSTEM", "myCounter", g_myCounterValue); | |
| 86 // | |
| 87 // Counters are process-specific. The macro itself can be issued from any | |
| 88 // thread, however. | |
| 89 // | |
| 90 // Sometimes, you want to track two counters at once. You can do this with two | |
| 91 // counter macros: | |
| 92 // TRACE_COUNTER1("MY_SUBSYSTEM", "myCounter0", g_myCounterValue[0]); | |
| 93 // TRACE_COUNTER1("MY_SUBSYSTEM", "myCounter1", g_myCounterValue[1]); | |
| 94 // Or you can do it with a combined macro: | |
| 95 // TRACE_COUNTER2("MY_SUBSYSTEM", "myCounter", | |
| 96 // "bytesPinned", g_myCounterValue[0], | |
| 97 // "bytesAllocated", g_myCounterValue[1]); | |
| 98 // This indicates to the tracing UI that these counters should be displayed | |
| 99 // in a single graph, as a summed area chart. | |
| 100 // | |
| 101 // Since counters are in a global namespace, you may want to disambiguate with a | |
| 102 // unique ID, by using the TRACE_COUNTER_ID* variations. | |
| 103 // | |
| 104 // By default, trace collection is compiled in, but turned off at runtime. | |
| 105 // Collecting trace data is the responsibility of the embedding | |
| 106 // application. In Chrome's case, navigating to about:tracing will turn on | |
| 107 // tracing and display data collected across all active processes. | |
| 108 // | |
| 109 // | |
| 110 // Memory scoping note: | |
| 111 // Tracing copies the pointers, not the string content, of the strings passed | |
| 112 // in for category_group, name, and arg_names. Thus, the following code will | |
| 113 // cause problems: | |
| 114 // char* str = strdup("importantName"); | |
| 115 // TRACE_EVENT_INSTANT0("SUBSYSTEM", str); // BAD! | |
| 116 // free(str); // Trace system now has dangling pointer | |
| 117 // | |
| 118 // To avoid this issue with the |name| and |arg_name| parameters, use the | |
| 119 // TRACE_EVENT_COPY_XXX overloads of the macros at additional runtime overhead. | |
| 120 // Notes: The category must always be in a long-lived char* (i.e. static const). | |
| 121 // The |arg_values|, when used, are always deep copied with the _COPY | |
| 122 // macros. | |
| 123 // | |
| 124 // When are string argument values copied: | |
| 125 // const char* arg_values are only referenced by default: | |
| 126 // TRACE_EVENT1("category", "name", | |
| 127 // "arg1", "literal string is only referenced"); | |
| 128 // Use TRACE_STR_COPY to force copying of a const char*: | |
| 129 // TRACE_EVENT1("category", "name", | |
| 130 // "arg1", TRACE_STR_COPY("string will be copied")); | |
| 131 // std::string arg_values are always copied: | |
| 132 // TRACE_EVENT1("category", "name", | |
| 133 // "arg1", std::string("string will be copied")); | |
| 134 // | |
| 135 // | |
| 136 // Convertable notes: | |
| 137 // Converting a large data type to a string can be costly. To help with this, | |
| 138 // the trace framework provides an interface ConvertableToTraceFormat. If you | |
| 139 // inherit from it and implement the AppendAsTraceFormat method the trace | |
| 140 // framework will call back to your object to convert a trace output time. This | |
| 141 // means, if the category for the event is disabled, the conversion will not | |
| 142 // happen. | |
| 143 // | |
| 144 // class MyData : public base::debug::ConvertableToTraceFormat { | |
| 145 // public: | |
| 146 // MyData() {} | |
| 147 // virtual void AppendAsTraceFormat(std::string* out) const override { | |
| 148 // out->append("{\"foo\":1}"); | |
| 149 // } | |
| 150 // private: | |
| 151 // virtual ~MyData() {} | |
| 152 // DISALLOW_COPY_AND_ASSIGN(MyData); | |
| 153 // }; | |
| 154 // | |
| 155 // TRACE_EVENT1("foo", "bar", "data", | |
| 156 // scoped_refptr<ConvertableToTraceFormat>(new MyData())); | |
| 157 // | |
| 158 // The trace framework will take ownership if the passed pointer and it will | |
| 159 // be free'd when the trace buffer is flushed. | |
| 160 // | |
| 161 // Note, we only do the conversion when the buffer is flushed, so the provided | |
| 162 // data object should not be modified after it's passed to the trace framework. | |
| 163 // | |
| 164 // | |
| 165 // Thread Safety: | |
| 166 // A thread safe singleton and mutex are used for thread safety. Category | |
| 167 // enabled flags are used to limit the performance impact when the system | |
| 168 // is not enabled. | |
| 169 // | |
| 170 // TRACE_EVENT macros first cache a pointer to a category. The categories are | |
| 171 // statically allocated and safe at all times, even after exit. Fetching a | |
| 172 // category is protected by the TraceLog::lock_. Multiple threads initializing | |
| 173 // the static variable is safe, as they will be serialized by the lock and | |
| 174 // multiple calls will return the same pointer to the category. | |
| 175 // | |
| 176 // Then the category_group_enabled flag is checked. This is a unsigned char, and | |
| 177 // not intended to be multithread safe. It optimizes access to AddTraceEvent | |
| 178 // which is threadsafe internally via TraceLog::lock_. The enabled flag may | |
| 179 // cause some threads to incorrectly call or skip calling AddTraceEvent near | |
| 180 // the time of the system being enabled or disabled. This is acceptable as | |
| 181 // we tolerate some data loss while the system is being enabled/disabled and | |
| 182 // because AddTraceEvent is threadsafe internally and checks the enabled state | |
| 183 // again under lock. | |
| 184 // | |
| 185 // Without the use of these static category pointers and enabled flags all | |
| 186 // trace points would carry a significant performance cost of acquiring a lock | |
| 187 // and resolving the category. | |
| 188 | 8 |
| 189 #ifndef BASE_DEBUG_TRACE_EVENT_H_ | 9 #ifndef BASE_DEBUG_TRACE_EVENT_H_ |
| 190 #define BASE_DEBUG_TRACE_EVENT_H_ | 10 #define BASE_DEBUG_TRACE_EVENT_H_ |
| 191 | 11 |
| 192 #include <string> | 12 #include "base/trace_event/trace_event.h" |
| 193 | 13 |
| 194 #include "base/atomicops.h" | 14 #endif // BASE_DEBUG_TRACE_EVENT_H_ |
| 195 #include "base/debug/trace_event_impl.h" | |
| 196 #include "base/debug/trace_event_memory.h" | |
| 197 #include "base/debug/trace_event_system_stats_monitor.h" | |
| 198 #include "base/time/time.h" | |
| 199 #include "build/build_config.h" | |
| 200 | |
| 201 // By default, const char* argument values are assumed to have long-lived scope | |
| 202 // and will not be copied. Use this macro to force a const char* to be copied. | |
| 203 #define TRACE_STR_COPY(str) \ | |
| 204 trace_event_internal::TraceStringWithCopy(str) | |
| 205 | |
| 206 // This will mark the trace event as disabled by default. The user will need | |
| 207 // to explicitly enable the event. | |
| 208 #define TRACE_DISABLED_BY_DEFAULT(name) "disabled-by-default-" name | |
| 209 | |
| 210 // By default, uint64 ID argument values are not mangled with the Process ID in | |
| 211 // TRACE_EVENT_ASYNC macros. Use this macro to force Process ID mangling. | |
| 212 #define TRACE_ID_MANGLE(id) \ | |
| 213 trace_event_internal::TraceID::ForceMangle(id) | |
| 214 | |
| 215 // By default, pointers are mangled with the Process ID in TRACE_EVENT_ASYNC | |
| 216 // macros. Use this macro to prevent Process ID mangling. | |
| 217 #define TRACE_ID_DONT_MANGLE(id) \ | |
| 218 trace_event_internal::TraceID::DontMangle(id) | |
| 219 | |
| 220 // Records a pair of begin and end events called "name" for the current | |
| 221 // scope, with 0, 1 or 2 associated arguments. If the category is not | |
| 222 // enabled, then this does nothing. | |
| 223 // - category and name strings must have application lifetime (statics or | |
| 224 // literals). They may not include " chars. | |
| 225 #define TRACE_EVENT0(category_group, name) \ | |
| 226 INTERNAL_TRACE_MEMORY(category_group, name) \ | |
| 227 INTERNAL_TRACE_EVENT_ADD_SCOPED(category_group, name) | |
| 228 #define TRACE_EVENT1(category_group, name, arg1_name, arg1_val) \ | |
| 229 INTERNAL_TRACE_MEMORY(category_group, name) \ | |
| 230 INTERNAL_TRACE_EVENT_ADD_SCOPED(category_group, name, arg1_name, arg1_val) | |
| 231 #define TRACE_EVENT2( \ | |
| 232 category_group, name, arg1_name, arg1_val, arg2_name, arg2_val) \ | |
| 233 INTERNAL_TRACE_MEMORY(category_group, name) \ | |
| 234 INTERNAL_TRACE_EVENT_ADD_SCOPED( \ | |
| 235 category_group, name, arg1_name, arg1_val, arg2_name, arg2_val) | |
| 236 | |
| 237 // Records events like TRACE_EVENT2 but uses |memory_tag| for memory tracing. | |
| 238 // Use this where |name| is too generic to accurately aggregate allocations. | |
| 239 #define TRACE_EVENT_WITH_MEMORY_TAG2( \ | |
| 240 category, name, memory_tag, arg1_name, arg1_val, arg2_name, arg2_val) \ | |
| 241 INTERNAL_TRACE_MEMORY(category, memory_tag) \ | |
| 242 INTERNAL_TRACE_EVENT_ADD_SCOPED( \ | |
| 243 category, name, arg1_name, arg1_val, arg2_name, arg2_val) | |
| 244 | |
| 245 // UNSHIPPED_TRACE_EVENT* are like TRACE_EVENT* except that they are not | |
| 246 // included in official builds. | |
| 247 | |
| 248 #if OFFICIAL_BUILD | |
| 249 #undef TRACING_IS_OFFICIAL_BUILD | |
| 250 #define TRACING_IS_OFFICIAL_BUILD 1 | |
| 251 #elif !defined(TRACING_IS_OFFICIAL_BUILD) | |
| 252 #define TRACING_IS_OFFICIAL_BUILD 0 | |
| 253 #endif | |
| 254 | |
| 255 #if TRACING_IS_OFFICIAL_BUILD | |
| 256 #define UNSHIPPED_TRACE_EVENT0(category_group, name) (void)0 | |
| 257 #define UNSHIPPED_TRACE_EVENT1(category_group, name, arg1_name, arg1_val) \ | |
| 258 (void)0 | |
| 259 #define UNSHIPPED_TRACE_EVENT2(category_group, name, arg1_name, arg1_val, \ | |
| 260 arg2_name, arg2_val) (void)0 | |
| 261 #define UNSHIPPED_TRACE_EVENT_INSTANT0(category_group, name, scope) (void)0 | |
| 262 #define UNSHIPPED_TRACE_EVENT_INSTANT1(category_group, name, scope, \ | |
| 263 arg1_name, arg1_val) (void)0 | |
| 264 #define UNSHIPPED_TRACE_EVENT_INSTANT2(category_group, name, scope, \ | |
| 265 arg1_name, arg1_val, \ | |
| 266 arg2_name, arg2_val) (void)0 | |
| 267 #else | |
| 268 #define UNSHIPPED_TRACE_EVENT0(category_group, name) \ | |
| 269 TRACE_EVENT0(category_group, name) | |
| 270 #define UNSHIPPED_TRACE_EVENT1(category_group, name, arg1_name, arg1_val) \ | |
| 271 TRACE_EVENT1(category_group, name, arg1_name, arg1_val) | |
| 272 #define UNSHIPPED_TRACE_EVENT2(category_group, name, arg1_name, arg1_val, \ | |
| 273 arg2_name, arg2_val) \ | |
| 274 TRACE_EVENT2(category_group, name, arg1_name, arg1_val, arg2_name, arg2_val) | |
| 275 #define UNSHIPPED_TRACE_EVENT_INSTANT0(category_group, name, scope) \ | |
| 276 TRACE_EVENT_INSTANT0(category_group, name, scope) | |
| 277 #define UNSHIPPED_TRACE_EVENT_INSTANT1(category_group, name, scope, \ | |
| 278 arg1_name, arg1_val) \ | |
| 279 TRACE_EVENT_INSTANT1(category_group, name, scope, arg1_name, arg1_val) | |
| 280 #define UNSHIPPED_TRACE_EVENT_INSTANT2(category_group, name, scope, \ | |
| 281 arg1_name, arg1_val, \ | |
| 282 arg2_name, arg2_val) \ | |
| 283 TRACE_EVENT_INSTANT2(category_group, name, scope, arg1_name, arg1_val, \ | |
| 284 arg2_name, arg2_val) | |
| 285 #endif | |
| 286 | |
| 287 // Records a single event called "name" immediately, with 0, 1 or 2 | |
| 288 // associated arguments. If the category is not enabled, then this | |
| 289 // does nothing. | |
| 290 // - category and name strings must have application lifetime (statics or | |
| 291 // literals). They may not include " chars. | |
| 292 #define TRACE_EVENT_INSTANT0(category_group, name, scope) \ | |
| 293 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \ | |
| 294 category_group, name, TRACE_EVENT_FLAG_NONE | scope) | |
| 295 #define TRACE_EVENT_INSTANT1(category_group, name, scope, arg1_name, arg1_val) \ | |
| 296 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \ | |
| 297 category_group, name, TRACE_EVENT_FLAG_NONE | scope, \ | |
| 298 arg1_name, arg1_val) | |
| 299 #define TRACE_EVENT_INSTANT2(category_group, name, scope, arg1_name, arg1_val, \ | |
| 300 arg2_name, arg2_val) \ | |
| 301 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \ | |
| 302 category_group, name, TRACE_EVENT_FLAG_NONE | scope, \ | |
| 303 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 304 #define TRACE_EVENT_COPY_INSTANT0(category_group, name, scope) \ | |
| 305 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \ | |
| 306 category_group, name, TRACE_EVENT_FLAG_COPY | scope) | |
| 307 #define TRACE_EVENT_COPY_INSTANT1(category_group, name, scope, \ | |
| 308 arg1_name, arg1_val) \ | |
| 309 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \ | |
| 310 category_group, name, TRACE_EVENT_FLAG_COPY | scope, arg1_name, \ | |
| 311 arg1_val) | |
| 312 #define TRACE_EVENT_COPY_INSTANT2(category_group, name, scope, \ | |
| 313 arg1_name, arg1_val, \ | |
| 314 arg2_name, arg2_val) \ | |
| 315 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \ | |
| 316 category_group, name, TRACE_EVENT_FLAG_COPY | scope, \ | |
| 317 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 318 | |
| 319 // Sets the current sample state to the given category and name (both must be | |
| 320 // constant strings). These states are intended for a sampling profiler. | |
| 321 // Implementation note: we store category and name together because we don't | |
| 322 // want the inconsistency/expense of storing two pointers. | |
| 323 // |thread_bucket| is [0..2] and is used to statically isolate samples in one | |
| 324 // thread from others. | |
| 325 #define TRACE_EVENT_SET_SAMPLING_STATE_FOR_BUCKET( \ | |
| 326 bucket_number, category, name) \ | |
| 327 trace_event_internal:: \ | |
| 328 TraceEventSamplingStateScope<bucket_number>::Set(category "\0" name) | |
| 329 | |
| 330 // Returns a current sampling state of the given bucket. | |
| 331 #define TRACE_EVENT_GET_SAMPLING_STATE_FOR_BUCKET(bucket_number) \ | |
| 332 trace_event_internal::TraceEventSamplingStateScope<bucket_number>::Current() | |
| 333 | |
| 334 // Creates a scope of a sampling state of the given bucket. | |
| 335 // | |
| 336 // { // The sampling state is set within this scope. | |
| 337 // TRACE_EVENT_SAMPLING_STATE_SCOPE_FOR_BUCKET(0, "category", "name"); | |
| 338 // ...; | |
| 339 // } | |
| 340 #define TRACE_EVENT_SCOPED_SAMPLING_STATE_FOR_BUCKET( \ | |
| 341 bucket_number, category, name) \ | |
| 342 trace_event_internal::TraceEventSamplingStateScope<bucket_number> \ | |
| 343 traceEventSamplingScope(category "\0" name); | |
| 344 | |
| 345 // Syntactic sugars for the sampling tracing in the main thread. | |
| 346 #define TRACE_EVENT_SCOPED_SAMPLING_STATE(category, name) \ | |
| 347 TRACE_EVENT_SCOPED_SAMPLING_STATE_FOR_BUCKET(0, category, name) | |
| 348 #define TRACE_EVENT_GET_SAMPLING_STATE() \ | |
| 349 TRACE_EVENT_GET_SAMPLING_STATE_FOR_BUCKET(0) | |
| 350 #define TRACE_EVENT_SET_SAMPLING_STATE(category, name) \ | |
| 351 TRACE_EVENT_SET_SAMPLING_STATE_FOR_BUCKET(0, category, name) | |
| 352 | |
| 353 | |
| 354 // Records a single BEGIN event called "name" immediately, with 0, 1 or 2 | |
| 355 // associated arguments. If the category is not enabled, then this | |
| 356 // does nothing. | |
| 357 // - category and name strings must have application lifetime (statics or | |
| 358 // literals). They may not include " chars. | |
| 359 #define TRACE_EVENT_BEGIN0(category_group, name) \ | |
| 360 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \ | |
| 361 category_group, name, TRACE_EVENT_FLAG_NONE) | |
| 362 #define TRACE_EVENT_BEGIN1(category_group, name, arg1_name, arg1_val) \ | |
| 363 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \ | |
| 364 category_group, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) | |
| 365 #define TRACE_EVENT_BEGIN2(category_group, name, arg1_name, arg1_val, \ | |
| 366 arg2_name, arg2_val) \ | |
| 367 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \ | |
| 368 category_group, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \ | |
| 369 arg2_name, arg2_val) | |
| 370 #define TRACE_EVENT_COPY_BEGIN0(category_group, name) \ | |
| 371 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \ | |
| 372 category_group, name, TRACE_EVENT_FLAG_COPY) | |
| 373 #define TRACE_EVENT_COPY_BEGIN1(category_group, name, arg1_name, arg1_val) \ | |
| 374 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \ | |
| 375 category_group, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val) | |
| 376 #define TRACE_EVENT_COPY_BEGIN2(category_group, name, arg1_name, arg1_val, \ | |
| 377 arg2_name, arg2_val) \ | |
| 378 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \ | |
| 379 category_group, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val, \ | |
| 380 arg2_name, arg2_val) | |
| 381 | |
| 382 // Similar to TRACE_EVENT_BEGINx but with a custom |at| timestamp provided. | |
| 383 // - |id| is used to match the _BEGIN event with the _END event. | |
| 384 // Events are considered to match if their category_group, name and id values | |
| 385 // all match. |id| must either be a pointer or an integer value up to 64 bits. | |
| 386 // If it's a pointer, the bits will be xored with a hash of the process ID so | |
| 387 // that the same pointer on two different processes will not collide. | |
| 388 #define TRACE_EVENT_BEGIN_WITH_ID_TID_AND_TIMESTAMP0(category_group, \ | |
| 389 name, id, thread_id, timestamp) \ | |
| 390 INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP( \ | |
| 391 TRACE_EVENT_PHASE_ASYNC_BEGIN, category_group, name, id, thread_id, \ | |
| 392 timestamp, TRACE_EVENT_FLAG_NONE) | |
| 393 #define TRACE_EVENT_COPY_BEGIN_WITH_ID_TID_AND_TIMESTAMP0( \ | |
| 394 category_group, name, id, thread_id, timestamp) \ | |
| 395 INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP( \ | |
| 396 TRACE_EVENT_PHASE_ASYNC_BEGIN, category_group, name, id, thread_id, \ | |
| 397 timestamp, TRACE_EVENT_FLAG_COPY) | |
| 398 #define TRACE_EVENT_COPY_BEGIN_WITH_ID_TID_AND_TIMESTAMP1( \ | |
| 399 category_group, name, id, thread_id, timestamp, arg1_name, arg1_val) \ | |
| 400 INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP( \ | |
| 401 TRACE_EVENT_PHASE_ASYNC_BEGIN, category_group, name, id, thread_id, \ | |
| 402 timestamp, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val) | |
| 403 | |
| 404 // Records a single END event for "name" immediately. If the category | |
| 405 // is not enabled, then this does nothing. | |
| 406 // - category and name strings must have application lifetime (statics or | |
| 407 // literals). They may not include " chars. | |
| 408 #define TRACE_EVENT_END0(category_group, name) \ | |
| 409 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ | |
| 410 category_group, name, TRACE_EVENT_FLAG_NONE) | |
| 411 #define TRACE_EVENT_END1(category_group, name, arg1_name, arg1_val) \ | |
| 412 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ | |
| 413 category_group, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) | |
| 414 #define TRACE_EVENT_END2(category_group, name, arg1_name, arg1_val, \ | |
| 415 arg2_name, arg2_val) \ | |
| 416 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ | |
| 417 category_group, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \ | |
| 418 arg2_name, arg2_val) | |
| 419 #define TRACE_EVENT_COPY_END0(category_group, name) \ | |
| 420 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ | |
| 421 category_group, name, TRACE_EVENT_FLAG_COPY) | |
| 422 #define TRACE_EVENT_COPY_END1(category_group, name, arg1_name, arg1_val) \ | |
| 423 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ | |
| 424 category_group, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val) | |
| 425 #define TRACE_EVENT_COPY_END2(category_group, name, arg1_name, arg1_val, \ | |
| 426 arg2_name, arg2_val) \ | |
| 427 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ | |
| 428 category_group, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val, \ | |
| 429 arg2_name, arg2_val) | |
| 430 | |
| 431 // Similar to TRACE_EVENT_ENDx but with a custom |at| timestamp provided. | |
| 432 // - |id| is used to match the _BEGIN event with the _END event. | |
| 433 // Events are considered to match if their category_group, name and id values | |
| 434 // all match. |id| must either be a pointer or an integer value up to 64 bits. | |
| 435 // If it's a pointer, the bits will be xored with a hash of the process ID so | |
| 436 // that the same pointer on two different processes will not collide. | |
| 437 #define TRACE_EVENT_END_WITH_ID_TID_AND_TIMESTAMP0(category_group, \ | |
| 438 name, id, thread_id, timestamp) \ | |
| 439 INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP( \ | |
| 440 TRACE_EVENT_PHASE_ASYNC_END, category_group, name, id, thread_id, \ | |
| 441 timestamp, TRACE_EVENT_FLAG_NONE) | |
| 442 #define TRACE_EVENT_COPY_END_WITH_ID_TID_AND_TIMESTAMP0( \ | |
| 443 category_group, name, id, thread_id, timestamp) \ | |
| 444 INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP( \ | |
| 445 TRACE_EVENT_PHASE_ASYNC_END, category_group, name, id, thread_id, \ | |
| 446 timestamp, TRACE_EVENT_FLAG_COPY) | |
| 447 #define TRACE_EVENT_COPY_END_WITH_ID_TID_AND_TIMESTAMP1( \ | |
| 448 category_group, name, id, thread_id, timestamp, arg1_name, arg1_val) \ | |
| 449 INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP( \ | |
| 450 TRACE_EVENT_PHASE_ASYNC_END, category_group, name, id, thread_id, \ | |
| 451 timestamp, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val) | |
| 452 | |
| 453 // Records the value of a counter called "name" immediately. Value | |
| 454 // must be representable as a 32 bit integer. | |
| 455 // - category and name strings must have application lifetime (statics or | |
| 456 // literals). They may not include " chars. | |
| 457 #define TRACE_COUNTER1(category_group, name, value) \ | |
| 458 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \ | |
| 459 category_group, name, TRACE_EVENT_FLAG_NONE, \ | |
| 460 "value", static_cast<int>(value)) | |
| 461 #define TRACE_COPY_COUNTER1(category_group, name, value) \ | |
| 462 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \ | |
| 463 category_group, name, TRACE_EVENT_FLAG_COPY, \ | |
| 464 "value", static_cast<int>(value)) | |
| 465 | |
| 466 // Records the values of a multi-parted counter called "name" immediately. | |
| 467 // The UI will treat value1 and value2 as parts of a whole, displaying their | |
| 468 // values as a stacked-bar chart. | |
| 469 // - category and name strings must have application lifetime (statics or | |
| 470 // literals). They may not include " chars. | |
| 471 #define TRACE_COUNTER2(category_group, name, value1_name, value1_val, \ | |
| 472 value2_name, value2_val) \ | |
| 473 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \ | |
| 474 category_group, name, TRACE_EVENT_FLAG_NONE, \ | |
| 475 value1_name, static_cast<int>(value1_val), \ | |
| 476 value2_name, static_cast<int>(value2_val)) | |
| 477 #define TRACE_COPY_COUNTER2(category_group, name, value1_name, value1_val, \ | |
| 478 value2_name, value2_val) \ | |
| 479 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \ | |
| 480 category_group, name, TRACE_EVENT_FLAG_COPY, \ | |
| 481 value1_name, static_cast<int>(value1_val), \ | |
| 482 value2_name, static_cast<int>(value2_val)) | |
| 483 | |
| 484 // Records the value of a counter called "name" immediately. Value | |
| 485 // must be representable as a 32 bit integer. | |
| 486 // - category and name strings must have application lifetime (statics or | |
| 487 // literals). They may not include " chars. | |
| 488 // - |id| is used to disambiguate counters with the same name. It must either | |
| 489 // be a pointer or an integer value up to 64 bits. If it's a pointer, the bits | |
| 490 // will be xored with a hash of the process ID so that the same pointer on | |
| 491 // two different processes will not collide. | |
| 492 #define TRACE_COUNTER_ID1(category_group, name, id, value) \ | |
| 493 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \ | |
| 494 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ | |
| 495 "value", static_cast<int>(value)) | |
| 496 #define TRACE_COPY_COUNTER_ID1(category_group, name, id, value) \ | |
| 497 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \ | |
| 498 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 499 "value", static_cast<int>(value)) | |
| 500 | |
| 501 // Records the values of a multi-parted counter called "name" immediately. | |
| 502 // The UI will treat value1 and value2 as parts of a whole, displaying their | |
| 503 // values as a stacked-bar chart. | |
| 504 // - category and name strings must have application lifetime (statics or | |
| 505 // literals). They may not include " chars. | |
| 506 // - |id| is used to disambiguate counters with the same name. It must either | |
| 507 // be a pointer or an integer value up to 64 bits. If it's a pointer, the bits | |
| 508 // will be xored with a hash of the process ID so that the same pointer on | |
| 509 // two different processes will not collide. | |
| 510 #define TRACE_COUNTER_ID2(category_group, name, id, value1_name, value1_val, \ | |
| 511 value2_name, value2_val) \ | |
| 512 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \ | |
| 513 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ | |
| 514 value1_name, static_cast<int>(value1_val), \ | |
| 515 value2_name, static_cast<int>(value2_val)) | |
| 516 #define TRACE_COPY_COUNTER_ID2(category_group, name, id, value1_name, \ | |
| 517 value1_val, value2_name, value2_val) \ | |
| 518 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \ | |
| 519 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 520 value1_name, static_cast<int>(value1_val), \ | |
| 521 value2_name, static_cast<int>(value2_val)) | |
| 522 | |
| 523 // ASYNC_STEP_* APIs should be only used by legacy code. New code should | |
| 524 // consider using NESTABLE_ASYNC_* APIs to describe substeps within an async | |
| 525 // event. | |
| 526 // Records a single ASYNC_BEGIN event called "name" immediately, with 0, 1 or 2 | |
| 527 // associated arguments. If the category is not enabled, then this | |
| 528 // does nothing. | |
| 529 // - category and name strings must have application lifetime (statics or | |
| 530 // literals). They may not include " chars. | |
| 531 // - |id| is used to match the ASYNC_BEGIN event with the ASYNC_END event. ASYNC | |
| 532 // events are considered to match if their category_group, name and id values | |
| 533 // all match. |id| must either be a pointer or an integer value up to 64 bits. | |
| 534 // If it's a pointer, the bits will be xored with a hash of the process ID so | |
| 535 // that the same pointer on two different processes will not collide. | |
| 536 // | |
| 537 // An asynchronous operation can consist of multiple phases. The first phase is | |
| 538 // defined by the ASYNC_BEGIN calls. Additional phases can be defined using the | |
| 539 // ASYNC_STEP_INTO or ASYNC_STEP_PAST macros. The ASYNC_STEP_INTO macro will | |
| 540 // annotate the block following the call. The ASYNC_STEP_PAST macro will | |
| 541 // annotate the block prior to the call. Note that any particular event must use | |
| 542 // only STEP_INTO or STEP_PAST macros; they can not mix and match. When the | |
| 543 // operation completes, call ASYNC_END. | |
| 544 // | |
| 545 // An ASYNC trace typically occurs on a single thread (if not, they will only be | |
| 546 // drawn on the thread defined in the ASYNC_BEGIN event), but all events in that | |
| 547 // operation must use the same |name| and |id|. Each step can have its own | |
| 548 // args. | |
| 549 #define TRACE_EVENT_ASYNC_BEGIN0(category_group, name, id) \ | |
| 550 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ | |
| 551 category_group, name, id, TRACE_EVENT_FLAG_NONE) | |
| 552 #define TRACE_EVENT_ASYNC_BEGIN1(category_group, name, id, arg1_name, \ | |
| 553 arg1_val) \ | |
| 554 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ | |
| 555 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) | |
| 556 #define TRACE_EVENT_ASYNC_BEGIN2(category_group, name, id, arg1_name, \ | |
| 557 arg1_val, arg2_name, arg2_val) \ | |
| 558 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ | |
| 559 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ | |
| 560 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 561 #define TRACE_EVENT_COPY_ASYNC_BEGIN0(category_group, name, id) \ | |
| 562 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ | |
| 563 category_group, name, id, TRACE_EVENT_FLAG_COPY) | |
| 564 #define TRACE_EVENT_COPY_ASYNC_BEGIN1(category_group, name, id, arg1_name, \ | |
| 565 arg1_val) \ | |
| 566 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ | |
| 567 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 568 arg1_name, arg1_val) | |
| 569 #define TRACE_EVENT_COPY_ASYNC_BEGIN2(category_group, name, id, arg1_name, \ | |
| 570 arg1_val, arg2_name, arg2_val) \ | |
| 571 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ | |
| 572 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 573 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 574 | |
| 575 // Similar to TRACE_EVENT_ASYNC_BEGINx but with a custom |at| timestamp | |
| 576 // provided. | |
| 577 #define TRACE_EVENT_ASYNC_BEGIN_WITH_TIMESTAMP0(category_group, \ | |
| 578 name, id, timestamp) \ | |
| 579 INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP( \ | |
| 580 TRACE_EVENT_PHASE_ASYNC_BEGIN, category_group, name, id, \ | |
| 581 static_cast<int>(base::PlatformThread::CurrentId()), \ | |
| 582 timestamp, TRACE_EVENT_FLAG_NONE) | |
| 583 | |
| 584 // Records a single ASYNC_STEP_INTO event for |step| immediately. If the | |
| 585 // category is not enabled, then this does nothing. The |name| and |id| must | |
| 586 // match the ASYNC_BEGIN event above. The |step| param identifies this step | |
| 587 // within the async event. This should be called at the beginning of the next | |
| 588 // phase of an asynchronous operation. The ASYNC_BEGIN event must not have any | |
| 589 // ASYNC_STEP_PAST events. | |
| 590 #define TRACE_EVENT_ASYNC_STEP_INTO0(category_group, name, id, step) \ | |
| 591 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_INTO, \ | |
| 592 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step) | |
| 593 #define TRACE_EVENT_ASYNC_STEP_INTO1(category_group, name, id, step, \ | |
| 594 arg1_name, arg1_val) \ | |
| 595 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_INTO, \ | |
| 596 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step, \ | |
| 597 arg1_name, arg1_val) | |
| 598 | |
| 599 // Records a single ASYNC_STEP_PAST event for |step| immediately. If the | |
| 600 // category is not enabled, then this does nothing. The |name| and |id| must | |
| 601 // match the ASYNC_BEGIN event above. The |step| param identifies this step | |
| 602 // within the async event. This should be called at the beginning of the next | |
| 603 // phase of an asynchronous operation. The ASYNC_BEGIN event must not have any | |
| 604 // ASYNC_STEP_INTO events. | |
| 605 #define TRACE_EVENT_ASYNC_STEP_PAST0(category_group, name, id, step) \ | |
| 606 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_PAST, \ | |
| 607 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step) | |
| 608 #define TRACE_EVENT_ASYNC_STEP_PAST1(category_group, name, id, step, \ | |
| 609 arg1_name, arg1_val) \ | |
| 610 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_PAST, \ | |
| 611 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step, \ | |
| 612 arg1_name, arg1_val) | |
| 613 | |
| 614 // Records a single ASYNC_END event for "name" immediately. If the category | |
| 615 // is not enabled, then this does nothing. | |
| 616 #define TRACE_EVENT_ASYNC_END0(category_group, name, id) \ | |
| 617 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ | |
| 618 category_group, name, id, TRACE_EVENT_FLAG_NONE) | |
| 619 #define TRACE_EVENT_ASYNC_END1(category_group, name, id, arg1_name, arg1_val) \ | |
| 620 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ | |
| 621 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) | |
| 622 #define TRACE_EVENT_ASYNC_END2(category_group, name, id, arg1_name, arg1_val, \ | |
| 623 arg2_name, arg2_val) \ | |
| 624 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ | |
| 625 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ | |
| 626 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 627 #define TRACE_EVENT_COPY_ASYNC_END0(category_group, name, id) \ | |
| 628 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ | |
| 629 category_group, name, id, TRACE_EVENT_FLAG_COPY) | |
| 630 #define TRACE_EVENT_COPY_ASYNC_END1(category_group, name, id, arg1_name, \ | |
| 631 arg1_val) \ | |
| 632 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ | |
| 633 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 634 arg1_name, arg1_val) | |
| 635 #define TRACE_EVENT_COPY_ASYNC_END2(category_group, name, id, arg1_name, \ | |
| 636 arg1_val, arg2_name, arg2_val) \ | |
| 637 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ | |
| 638 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 639 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 640 | |
| 641 // Similar to TRACE_EVENT_ASYNC_ENDx but with a custom |at| timestamp provided. | |
| 642 #define TRACE_EVENT_ASYNC_END_WITH_TIMESTAMP0(category_group, \ | |
| 643 name, id, timestamp) \ | |
| 644 INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP( \ | |
| 645 TRACE_EVENT_PHASE_ASYNC_END, category_group, name, id, \ | |
| 646 static_cast<int>(base::PlatformThread::CurrentId()), \ | |
| 647 timestamp, TRACE_EVENT_FLAG_NONE) | |
| 648 | |
| 649 // NESTABLE_ASYNC_* APIs are used to describe an async operation, which can | |
| 650 // be nested within a NESTABLE_ASYNC event and/or have inner NESTABLE_ASYNC | |
| 651 // events. | |
| 652 // - category and name strings must have application lifetime (statics or | |
| 653 // literals). They may not include " chars. | |
| 654 // - |id| is used to match the NESTABLE_ASYNC_BEGIN event with the | |
| 655 // NESTABLE_ASYNC_END event. Events are considered to match if their | |
| 656 // category_group, name and id values all match. |id| must either be a | |
| 657 // pointer or an integer value up to 64 bits. If it's a pointer, the bits | |
| 658 // will be xored with a hash of the process ID so that the same pointer on two | |
| 659 // different processes will not collide. | |
| 660 // | |
| 661 // Unmatched NESTABLE_ASYNC_END event will be parsed as an instant event, | |
| 662 // and unmatched NESTABLE_ASYNC_BEGIN event will be parsed as an event that | |
| 663 // ends at the last NESTABLE_ASYNC_END event of that |id|. | |
| 664 | |
| 665 // Records a single NESTABLE_ASYNC_BEGIN event called "name" immediately, with 2 | |
| 666 // associated arguments. If the category is not enabled, then this does nothing. | |
| 667 #define TRACE_EVENT_NESTABLE_ASYNC_BEGIN2(category_group, name, id, arg1_name, \ | |
| 668 arg1_val, arg2_name, arg2_val) \ | |
| 669 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_NESTABLE_ASYNC_BEGIN, \ | |
| 670 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \ | |
| 671 arg2_name, arg2_val) | |
| 672 // Records a single NESTABLE_ASYNC_END event called "name" immediately, with 2 | |
| 673 // associated arguments. If the category is not enabled, then this does nothing. | |
| 674 #define TRACE_EVENT_NESTABLE_ASYNC_END2(category_group, name, id, arg1_name, \ | |
| 675 arg1_val, arg2_name, arg2_val) \ | |
| 676 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_NESTABLE_ASYNC_END, \ | |
| 677 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \ | |
| 678 arg2_name, arg2_val) | |
| 679 // Records a single NESTABLE_ASYNC_INSTANT event called "name" immediately, | |
| 680 // with 2 associated arguments. If the category is not enabled, then this | |
| 681 // does nothing. | |
| 682 #define TRACE_EVENT_NESTABLE_ASYNC_INSTANT2(category_group, name, id, \ | |
| 683 arg1_name, arg1_val, arg2_name, arg2_val) \ | |
| 684 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_NESTABLE_ASYNC_INSTANT, \ | |
| 685 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \ | |
| 686 arg2_name, arg2_val) | |
| 687 | |
| 688 // Records a single FLOW_BEGIN event called "name" immediately, with 0, 1 or 2 | |
| 689 // associated arguments. If the category is not enabled, then this | |
| 690 // does nothing. | |
| 691 // - category and name strings must have application lifetime (statics or | |
| 692 // literals). They may not include " chars. | |
| 693 // - |id| is used to match the FLOW_BEGIN event with the FLOW_END event. FLOW | |
| 694 // events are considered to match if their category_group, name and id values | |
| 695 // all match. |id| must either be a pointer or an integer value up to 64 bits. | |
| 696 // If it's a pointer, the bits will be xored with a hash of the process ID so | |
| 697 // that the same pointer on two different processes will not collide. | |
| 698 // FLOW events are different from ASYNC events in how they are drawn by the | |
| 699 // tracing UI. A FLOW defines asynchronous data flow, such as posting a task | |
| 700 // (FLOW_BEGIN) and later executing that task (FLOW_END). Expect FLOWs to be | |
| 701 // drawn as lines or arrows from FLOW_BEGIN scopes to FLOW_END scopes. Similar | |
| 702 // to ASYNC, a FLOW can consist of multiple phases. The first phase is defined | |
| 703 // by the FLOW_BEGIN calls. Additional phases can be defined using the FLOW_STEP | |
| 704 // macros. When the operation completes, call FLOW_END. An async operation can | |
| 705 // span threads and processes, but all events in that operation must use the | |
| 706 // same |name| and |id|. Each event can have its own args. | |
| 707 #define TRACE_EVENT_FLOW_BEGIN0(category_group, name, id) \ | |
| 708 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ | |
| 709 category_group, name, id, TRACE_EVENT_FLAG_NONE) | |
| 710 #define TRACE_EVENT_FLOW_BEGIN1(category_group, name, id, arg1_name, arg1_val) \ | |
| 711 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ | |
| 712 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) | |
| 713 #define TRACE_EVENT_FLOW_BEGIN2(category_group, name, id, arg1_name, arg1_val, \ | |
| 714 arg2_name, arg2_val) \ | |
| 715 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ | |
| 716 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ | |
| 717 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 718 #define TRACE_EVENT_COPY_FLOW_BEGIN0(category_group, name, id) \ | |
| 719 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ | |
| 720 category_group, name, id, TRACE_EVENT_FLAG_COPY) | |
| 721 #define TRACE_EVENT_COPY_FLOW_BEGIN1(category_group, name, id, arg1_name, \ | |
| 722 arg1_val) \ | |
| 723 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ | |
| 724 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 725 arg1_name, arg1_val) | |
| 726 #define TRACE_EVENT_COPY_FLOW_BEGIN2(category_group, name, id, arg1_name, \ | |
| 727 arg1_val, arg2_name, arg2_val) \ | |
| 728 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ | |
| 729 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 730 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 731 | |
| 732 // Records a single FLOW_STEP event for |step| immediately. If the category | |
| 733 // is not enabled, then this does nothing. The |name| and |id| must match the | |
| 734 // FLOW_BEGIN event above. The |step| param identifies this step within the | |
| 735 // async event. This should be called at the beginning of the next phase of an | |
| 736 // asynchronous operation. | |
| 737 #define TRACE_EVENT_FLOW_STEP0(category_group, name, id, step) \ | |
| 738 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_STEP, \ | |
| 739 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step) | |
| 740 #define TRACE_EVENT_FLOW_STEP1(category_group, name, id, step, \ | |
| 741 arg1_name, arg1_val) \ | |
| 742 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_STEP, \ | |
| 743 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step, \ | |
| 744 arg1_name, arg1_val) | |
| 745 #define TRACE_EVENT_COPY_FLOW_STEP0(category_group, name, id, step) \ | |
| 746 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_STEP, \ | |
| 747 category_group, name, id, TRACE_EVENT_FLAG_COPY, "step", step) | |
| 748 #define TRACE_EVENT_COPY_FLOW_STEP1(category_group, name, id, step, \ | |
| 749 arg1_name, arg1_val) \ | |
| 750 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_STEP, \ | |
| 751 category_group, name, id, TRACE_EVENT_FLAG_COPY, "step", step, \ | |
| 752 arg1_name, arg1_val) | |
| 753 | |
| 754 // Records a single FLOW_END event for "name" immediately. If the category | |
| 755 // is not enabled, then this does nothing. | |
| 756 #define TRACE_EVENT_FLOW_END0(category_group, name, id) \ | |
| 757 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ | |
| 758 category_group, name, id, TRACE_EVENT_FLAG_NONE) | |
| 759 #define TRACE_EVENT_FLOW_END1(category_group, name, id, arg1_name, arg1_val) \ | |
| 760 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ | |
| 761 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) | |
| 762 #define TRACE_EVENT_FLOW_END2(category_group, name, id, arg1_name, arg1_val, \ | |
| 763 arg2_name, arg2_val) \ | |
| 764 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ | |
| 765 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ | |
| 766 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 767 #define TRACE_EVENT_COPY_FLOW_END0(category_group, name, id) \ | |
| 768 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ | |
| 769 category_group, name, id, TRACE_EVENT_FLAG_COPY) | |
| 770 #define TRACE_EVENT_COPY_FLOW_END1(category_group, name, id, arg1_name, \ | |
| 771 arg1_val) \ | |
| 772 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ | |
| 773 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 774 arg1_name, arg1_val) | |
| 775 #define TRACE_EVENT_COPY_FLOW_END2(category_group, name, id, arg1_name, \ | |
| 776 arg1_val, arg2_name, arg2_val) \ | |
| 777 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ | |
| 778 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ | |
| 779 arg1_name, arg1_val, arg2_name, arg2_val) | |
| 780 | |
| 781 // Macros to track the life time and value of arbitrary client objects. | |
| 782 // See also TraceTrackableObject. | |
| 783 #define TRACE_EVENT_OBJECT_CREATED_WITH_ID(category_group, name, id) \ | |
| 784 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_CREATE_OBJECT, \ | |
| 785 category_group, name, TRACE_ID_DONT_MANGLE(id), TRACE_EVENT_FLAG_NONE) | |
| 786 | |
| 787 #define TRACE_EVENT_OBJECT_SNAPSHOT_WITH_ID(category_group, name, id, snapshot)
\ | |
| 788 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_SNAPSHOT_OBJECT, \ | |
| 789 category_group, name, TRACE_ID_DONT_MANGLE(id), TRACE_EVENT_FLAG_NONE,\ | |
| 790 "snapshot", snapshot) | |
| 791 | |
| 792 #define TRACE_EVENT_OBJECT_DELETED_WITH_ID(category_group, name, id) \ | |
| 793 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_DELETE_OBJECT, \ | |
| 794 category_group, name, TRACE_ID_DONT_MANGLE(id), TRACE_EVENT_FLAG_NONE) | |
| 795 | |
| 796 #define INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE() \ | |
| 797 UNLIKELY(*INTERNAL_TRACE_EVENT_UID(category_group_enabled) & \ | |
| 798 (base::debug::TraceLog::ENABLED_FOR_RECORDING | \ | |
| 799 base::debug::TraceLog::ENABLED_FOR_EVENT_CALLBACK)) | |
| 800 | |
| 801 // Macro to efficiently determine if a given category group is enabled. | |
| 802 #define TRACE_EVENT_CATEGORY_GROUP_ENABLED(category_group, ret) \ | |
| 803 do { \ | |
| 804 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ | |
| 805 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ | |
| 806 *ret = true; \ | |
| 807 } else { \ | |
| 808 *ret = false; \ | |
| 809 } \ | |
| 810 } while (0) | |
| 811 | |
| 812 // Macro to efficiently determine, through polling, if a new trace has begun. | |
| 813 #define TRACE_EVENT_IS_NEW_TRACE(ret) \ | |
| 814 do { \ | |
| 815 static int INTERNAL_TRACE_EVENT_UID(lastRecordingNumber) = 0; \ | |
| 816 int num_traces_recorded = TRACE_EVENT_API_GET_NUM_TRACES_RECORDED(); \ | |
| 817 if (num_traces_recorded != -1 && \ | |
| 818 num_traces_recorded != \ | |
| 819 INTERNAL_TRACE_EVENT_UID(lastRecordingNumber)) { \ | |
| 820 INTERNAL_TRACE_EVENT_UID(lastRecordingNumber) = \ | |
| 821 num_traces_recorded; \ | |
| 822 *ret = true; \ | |
| 823 } else { \ | |
| 824 *ret = false; \ | |
| 825 } \ | |
| 826 } while (0) | |
| 827 | |
| 828 //////////////////////////////////////////////////////////////////////////////// | |
| 829 // Implementation specific tracing API definitions. | |
| 830 | |
| 831 // Get a pointer to the enabled state of the given trace category. Only | |
| 832 // long-lived literal strings should be given as the category group. The | |
| 833 // returned pointer can be held permanently in a local static for example. If | |
| 834 // the unsigned char is non-zero, tracing is enabled. If tracing is enabled, | |
| 835 // TRACE_EVENT_API_ADD_TRACE_EVENT can be called. It's OK if tracing is disabled | |
| 836 // between the load of the tracing state and the call to | |
| 837 // TRACE_EVENT_API_ADD_TRACE_EVENT, because this flag only provides an early out | |
| 838 // for best performance when tracing is disabled. | |
| 839 // const unsigned char* | |
| 840 // TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED(const char* category_group) | |
| 841 #define TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED \ | |
| 842 base::debug::TraceLog::GetCategoryGroupEnabled | |
| 843 | |
| 844 // Get the number of times traces have been recorded. This is used to implement | |
| 845 // the TRACE_EVENT_IS_NEW_TRACE facility. | |
| 846 // unsigned int TRACE_EVENT_API_GET_NUM_TRACES_RECORDED() | |
| 847 #define TRACE_EVENT_API_GET_NUM_TRACES_RECORDED \ | |
| 848 base::debug::TraceLog::GetInstance()->GetNumTracesRecorded | |
| 849 | |
| 850 // Add a trace event to the platform tracing system. | |
| 851 // base::debug::TraceEventHandle TRACE_EVENT_API_ADD_TRACE_EVENT( | |
| 852 // char phase, | |
| 853 // const unsigned char* category_group_enabled, | |
| 854 // const char* name, | |
| 855 // unsigned long long id, | |
| 856 // int num_args, | |
| 857 // const char** arg_names, | |
| 858 // const unsigned char* arg_types, | |
| 859 // const unsigned long long* arg_values, | |
| 860 // unsigned char flags) | |
| 861 #define TRACE_EVENT_API_ADD_TRACE_EVENT \ | |
| 862 base::debug::TraceLog::GetInstance()->AddTraceEvent | |
| 863 | |
| 864 // Add a trace event to the platform tracing system. | |
| 865 // base::debug::TraceEventHandle TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_TIMESTAMP( | |
| 866 // char phase, | |
| 867 // const unsigned char* category_group_enabled, | |
| 868 // const char* name, | |
| 869 // unsigned long long id, | |
| 870 // int thread_id, | |
| 871 // const TimeTicks& timestamp, | |
| 872 // int num_args, | |
| 873 // const char** arg_names, | |
| 874 // const unsigned char* arg_types, | |
| 875 // const unsigned long long* arg_values, | |
| 876 // unsigned char flags) | |
| 877 #define TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP \ | |
| 878 base::debug::TraceLog::GetInstance()->AddTraceEventWithThreadIdAndTimestamp | |
| 879 | |
| 880 // Set the duration field of a COMPLETE trace event. | |
| 881 // void TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION( | |
| 882 // const unsigned char* category_group_enabled, | |
| 883 // const char* name, | |
| 884 // base::debug::TraceEventHandle id) | |
| 885 #define TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION \ | |
| 886 base::debug::TraceLog::GetInstance()->UpdateTraceEventDuration | |
| 887 | |
| 888 // Defines atomic operations used internally by the tracing system. | |
| 889 #define TRACE_EVENT_API_ATOMIC_WORD base::subtle::AtomicWord | |
| 890 #define TRACE_EVENT_API_ATOMIC_LOAD(var) base::subtle::NoBarrier_Load(&(var)) | |
| 891 #define TRACE_EVENT_API_ATOMIC_STORE(var, value) \ | |
| 892 base::subtle::NoBarrier_Store(&(var), (value)) | |
| 893 | |
| 894 // Defines visibility for classes in trace_event.h | |
| 895 #define TRACE_EVENT_API_CLASS_EXPORT BASE_EXPORT | |
| 896 | |
| 897 // The thread buckets for the sampling profiler. | |
| 898 TRACE_EVENT_API_CLASS_EXPORT extern \ | |
| 899 TRACE_EVENT_API_ATOMIC_WORD g_trace_state[3]; | |
| 900 | |
| 901 #define TRACE_EVENT_API_THREAD_BUCKET(thread_bucket) \ | |
| 902 g_trace_state[thread_bucket] | |
| 903 | |
| 904 //////////////////////////////////////////////////////////////////////////////// | |
| 905 | |
| 906 // Implementation detail: trace event macros create temporary variables | |
| 907 // to keep instrumentation overhead low. These macros give each temporary | |
| 908 // variable a unique name based on the line number to prevent name collisions. | |
| 909 #define INTERNAL_TRACE_EVENT_UID3(a,b) \ | |
| 910 trace_event_unique_##a##b | |
| 911 #define INTERNAL_TRACE_EVENT_UID2(a,b) \ | |
| 912 INTERNAL_TRACE_EVENT_UID3(a,b) | |
| 913 #define INTERNAL_TRACE_EVENT_UID(name_prefix) \ | |
| 914 INTERNAL_TRACE_EVENT_UID2(name_prefix, __LINE__) | |
| 915 | |
| 916 // Implementation detail: internal macro to create static category. | |
| 917 // No barriers are needed, because this code is designed to operate safely | |
| 918 // even when the unsigned char* points to garbage data (which may be the case | |
| 919 // on processors without cache coherency). | |
| 920 #define INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO_CUSTOM_VARIABLES( \ | |
| 921 category_group, atomic, category_group_enabled) \ | |
| 922 category_group_enabled = \ | |
| 923 reinterpret_cast<const unsigned char*>(TRACE_EVENT_API_ATOMIC_LOAD( \ | |
| 924 atomic)); \ | |
| 925 if (UNLIKELY(!category_group_enabled)) { \ | |
| 926 category_group_enabled = \ | |
| 927 TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED(category_group); \ | |
| 928 TRACE_EVENT_API_ATOMIC_STORE(atomic, \ | |
| 929 reinterpret_cast<TRACE_EVENT_API_ATOMIC_WORD>( \ | |
| 930 category_group_enabled)); \ | |
| 931 } | |
| 932 | |
| 933 #define INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group) \ | |
| 934 static TRACE_EVENT_API_ATOMIC_WORD INTERNAL_TRACE_EVENT_UID(atomic) = 0; \ | |
| 935 const unsigned char* INTERNAL_TRACE_EVENT_UID(category_group_enabled); \ | |
| 936 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO_CUSTOM_VARIABLES(category_group, \ | |
| 937 INTERNAL_TRACE_EVENT_UID(atomic), \ | |
| 938 INTERNAL_TRACE_EVENT_UID(category_group_enabled)); | |
| 939 | |
| 940 // Implementation detail: internal macro to create static category and add | |
| 941 // event if the category is enabled. | |
| 942 #define INTERNAL_TRACE_EVENT_ADD(phase, category_group, name, flags, ...) \ | |
| 943 do { \ | |
| 944 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ | |
| 945 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ | |
| 946 trace_event_internal::AddTraceEvent( \ | |
| 947 phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), name, \ | |
| 948 trace_event_internal::kNoEventId, flags, ##__VA_ARGS__); \ | |
| 949 } \ | |
| 950 } while (0) | |
| 951 | |
| 952 // Implementation detail: internal macro to create static category and add begin | |
| 953 // event if the category is enabled. Also adds the end event when the scope | |
| 954 // ends. | |
| 955 #define INTERNAL_TRACE_EVENT_ADD_SCOPED(category_group, name, ...) \ | |
| 956 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ | |
| 957 trace_event_internal::ScopedTracer INTERNAL_TRACE_EVENT_UID(tracer); \ | |
| 958 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ | |
| 959 base::debug::TraceEventHandle h = trace_event_internal::AddTraceEvent( \ | |
| 960 TRACE_EVENT_PHASE_COMPLETE, \ | |
| 961 INTERNAL_TRACE_EVENT_UID(category_group_enabled), \ | |
| 962 name, trace_event_internal::kNoEventId, \ | |
| 963 TRACE_EVENT_FLAG_NONE, ##__VA_ARGS__); \ | |
| 964 INTERNAL_TRACE_EVENT_UID(tracer).Initialize( \ | |
| 965 INTERNAL_TRACE_EVENT_UID(category_group_enabled), name, h); \ | |
| 966 } | |
| 967 | |
| 968 // Implementation detail: internal macro to create static category and add | |
| 969 // event if the category is enabled. | |
| 970 #define INTERNAL_TRACE_EVENT_ADD_WITH_ID(phase, category_group, name, id, \ | |
| 971 flags, ...) \ | |
| 972 do { \ | |
| 973 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ | |
| 974 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ | |
| 975 unsigned char trace_event_flags = flags | TRACE_EVENT_FLAG_HAS_ID; \ | |
| 976 trace_event_internal::TraceID trace_event_trace_id( \ | |
| 977 id, &trace_event_flags); \ | |
| 978 trace_event_internal::AddTraceEvent( \ | |
| 979 phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), \ | |
| 980 name, trace_event_trace_id.data(), trace_event_flags, \ | |
| 981 ##__VA_ARGS__); \ | |
| 982 } \ | |
| 983 } while (0) | |
| 984 | |
| 985 // Implementation detail: internal macro to create static category and add | |
| 986 // event if the category is enabled. | |
| 987 #define INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP(phase, \ | |
| 988 category_group, name, id, thread_id, timestamp, flags, ...) \ | |
| 989 do { \ | |
| 990 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ | |
| 991 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ | |
| 992 unsigned char trace_event_flags = flags | TRACE_EVENT_FLAG_HAS_ID; \ | |
| 993 trace_event_internal::TraceID trace_event_trace_id( \ | |
| 994 id, &trace_event_flags); \ | |
| 995 trace_event_internal::AddTraceEventWithThreadIdAndTimestamp( \ | |
| 996 phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), \ | |
| 997 name, trace_event_trace_id.data(), \ | |
| 998 thread_id, base::TimeTicks::FromInternalValue(timestamp), \ | |
| 999 trace_event_flags, ##__VA_ARGS__); \ | |
| 1000 } \ | |
| 1001 } while (0) | |
| 1002 | |
| 1003 // Notes regarding the following definitions: | |
| 1004 // New values can be added and propagated to third party libraries, but existing | |
| 1005 // definitions must never be changed, because third party libraries may use old | |
| 1006 // definitions. | |
| 1007 | |
| 1008 // Phase indicates the nature of an event entry. E.g. part of a begin/end pair. | |
| 1009 #define TRACE_EVENT_PHASE_BEGIN ('B') | |
| 1010 #define TRACE_EVENT_PHASE_END ('E') | |
| 1011 #define TRACE_EVENT_PHASE_COMPLETE ('X') | |
| 1012 #define TRACE_EVENT_PHASE_INSTANT ('I') | |
| 1013 #define TRACE_EVENT_PHASE_ASYNC_BEGIN ('S') | |
| 1014 #define TRACE_EVENT_PHASE_ASYNC_STEP_INTO ('T') | |
| 1015 #define TRACE_EVENT_PHASE_ASYNC_STEP_PAST ('p') | |
| 1016 #define TRACE_EVENT_PHASE_ASYNC_END ('F') | |
| 1017 #define TRACE_EVENT_PHASE_NESTABLE_ASYNC_BEGIN ('b') | |
| 1018 #define TRACE_EVENT_PHASE_NESTABLE_ASYNC_END ('e') | |
| 1019 #define TRACE_EVENT_PHASE_NESTABLE_ASYNC_INSTANT ('n') | |
| 1020 #define TRACE_EVENT_PHASE_FLOW_BEGIN ('s') | |
| 1021 #define TRACE_EVENT_PHASE_FLOW_STEP ('t') | |
| 1022 #define TRACE_EVENT_PHASE_FLOW_END ('f') | |
| 1023 #define TRACE_EVENT_PHASE_METADATA ('M') | |
| 1024 #define TRACE_EVENT_PHASE_COUNTER ('C') | |
| 1025 #define TRACE_EVENT_PHASE_SAMPLE ('P') | |
| 1026 #define TRACE_EVENT_PHASE_CREATE_OBJECT ('N') | |
| 1027 #define TRACE_EVENT_PHASE_SNAPSHOT_OBJECT ('O') | |
| 1028 #define TRACE_EVENT_PHASE_DELETE_OBJECT ('D') | |
| 1029 | |
| 1030 // Flags for changing the behavior of TRACE_EVENT_API_ADD_TRACE_EVENT. | |
| 1031 #define TRACE_EVENT_FLAG_NONE (static_cast<unsigned char>(0)) | |
| 1032 #define TRACE_EVENT_FLAG_COPY (static_cast<unsigned char>(1 << 0)) | |
| 1033 #define TRACE_EVENT_FLAG_HAS_ID (static_cast<unsigned char>(1 << 1)) | |
| 1034 #define TRACE_EVENT_FLAG_MANGLE_ID (static_cast<unsigned char>(1 << 2)) | |
| 1035 #define TRACE_EVENT_FLAG_SCOPE_OFFSET (static_cast<unsigned char>(1 << 3)) | |
| 1036 | |
| 1037 #define TRACE_EVENT_FLAG_SCOPE_MASK (static_cast<unsigned char>( \ | |
| 1038 TRACE_EVENT_FLAG_SCOPE_OFFSET | (TRACE_EVENT_FLAG_SCOPE_OFFSET << 1))) | |
| 1039 | |
| 1040 // Type values for identifying types in the TraceValue union. | |
| 1041 #define TRACE_VALUE_TYPE_BOOL (static_cast<unsigned char>(1)) | |
| 1042 #define TRACE_VALUE_TYPE_UINT (static_cast<unsigned char>(2)) | |
| 1043 #define TRACE_VALUE_TYPE_INT (static_cast<unsigned char>(3)) | |
| 1044 #define TRACE_VALUE_TYPE_DOUBLE (static_cast<unsigned char>(4)) | |
| 1045 #define TRACE_VALUE_TYPE_POINTER (static_cast<unsigned char>(5)) | |
| 1046 #define TRACE_VALUE_TYPE_STRING (static_cast<unsigned char>(6)) | |
| 1047 #define TRACE_VALUE_TYPE_COPY_STRING (static_cast<unsigned char>(7)) | |
| 1048 #define TRACE_VALUE_TYPE_CONVERTABLE (static_cast<unsigned char>(8)) | |
| 1049 | |
| 1050 // Enum reflecting the scope of an INSTANT event. Must fit within | |
| 1051 // TRACE_EVENT_FLAG_SCOPE_MASK. | |
| 1052 #define TRACE_EVENT_SCOPE_GLOBAL (static_cast<unsigned char>(0 << 3)) | |
| 1053 #define TRACE_EVENT_SCOPE_PROCESS (static_cast<unsigned char>(1 << 3)) | |
| 1054 #define TRACE_EVENT_SCOPE_THREAD (static_cast<unsigned char>(2 << 3)) | |
| 1055 | |
| 1056 #define TRACE_EVENT_SCOPE_NAME_GLOBAL ('g') | |
| 1057 #define TRACE_EVENT_SCOPE_NAME_PROCESS ('p') | |
| 1058 #define TRACE_EVENT_SCOPE_NAME_THREAD ('t') | |
| 1059 | |
| 1060 namespace trace_event_internal { | |
| 1061 | |
| 1062 // Specify these values when the corresponding argument of AddTraceEvent is not | |
| 1063 // used. | |
| 1064 const int kZeroNumArgs = 0; | |
| 1065 const unsigned long long kNoEventId = 0; | |
| 1066 | |
| 1067 // TraceID encapsulates an ID that can either be an integer or pointer. Pointers | |
| 1068 // are by default mangled with the Process ID so that they are unlikely to | |
| 1069 // collide when the same pointer is used on different processes. | |
| 1070 class TraceID { | |
| 1071 public: | |
| 1072 class DontMangle { | |
| 1073 public: | |
| 1074 explicit DontMangle(const void* id) | |
| 1075 : data_(static_cast<unsigned long long>( | |
| 1076 reinterpret_cast<uintptr_t>(id))) {} | |
| 1077 explicit DontMangle(unsigned long long id) : data_(id) {} | |
| 1078 explicit DontMangle(unsigned long id) : data_(id) {} | |
| 1079 explicit DontMangle(unsigned int id) : data_(id) {} | |
| 1080 explicit DontMangle(unsigned short id) : data_(id) {} | |
| 1081 explicit DontMangle(unsigned char id) : data_(id) {} | |
| 1082 explicit DontMangle(long long id) | |
| 1083 : data_(static_cast<unsigned long long>(id)) {} | |
| 1084 explicit DontMangle(long id) | |
| 1085 : data_(static_cast<unsigned long long>(id)) {} | |
| 1086 explicit DontMangle(int id) | |
| 1087 : data_(static_cast<unsigned long long>(id)) {} | |
| 1088 explicit DontMangle(short id) | |
| 1089 : data_(static_cast<unsigned long long>(id)) {} | |
| 1090 explicit DontMangle(signed char id) | |
| 1091 : data_(static_cast<unsigned long long>(id)) {} | |
| 1092 unsigned long long data() const { return data_; } | |
| 1093 private: | |
| 1094 unsigned long long data_; | |
| 1095 }; | |
| 1096 | |
| 1097 class ForceMangle { | |
| 1098 public: | |
| 1099 explicit ForceMangle(unsigned long long id) : data_(id) {} | |
| 1100 explicit ForceMangle(unsigned long id) : data_(id) {} | |
| 1101 explicit ForceMangle(unsigned int id) : data_(id) {} | |
| 1102 explicit ForceMangle(unsigned short id) : data_(id) {} | |
| 1103 explicit ForceMangle(unsigned char id) : data_(id) {} | |
| 1104 explicit ForceMangle(long long id) | |
| 1105 : data_(static_cast<unsigned long long>(id)) {} | |
| 1106 explicit ForceMangle(long id) | |
| 1107 : data_(static_cast<unsigned long long>(id)) {} | |
| 1108 explicit ForceMangle(int id) | |
| 1109 : data_(static_cast<unsigned long long>(id)) {} | |
| 1110 explicit ForceMangle(short id) | |
| 1111 : data_(static_cast<unsigned long long>(id)) {} | |
| 1112 explicit ForceMangle(signed char id) | |
| 1113 : data_(static_cast<unsigned long long>(id)) {} | |
| 1114 unsigned long long data() const { return data_; } | |
| 1115 private: | |
| 1116 unsigned long long data_; | |
| 1117 }; | |
| 1118 TraceID(const void* id, unsigned char* flags) | |
| 1119 : data_(static_cast<unsigned long long>( | |
| 1120 reinterpret_cast<uintptr_t>(id))) { | |
| 1121 *flags |= TRACE_EVENT_FLAG_MANGLE_ID; | |
| 1122 } | |
| 1123 TraceID(ForceMangle id, unsigned char* flags) : data_(id.data()) { | |
| 1124 *flags |= TRACE_EVENT_FLAG_MANGLE_ID; | |
| 1125 } | |
| 1126 TraceID(DontMangle id, unsigned char* flags) : data_(id.data()) { | |
| 1127 } | |
| 1128 TraceID(unsigned long long id, unsigned char* flags) | |
| 1129 : data_(id) { (void)flags; } | |
| 1130 TraceID(unsigned long id, unsigned char* flags) | |
| 1131 : data_(id) { (void)flags; } | |
| 1132 TraceID(unsigned int id, unsigned char* flags) | |
| 1133 : data_(id) { (void)flags; } | |
| 1134 TraceID(unsigned short id, unsigned char* flags) | |
| 1135 : data_(id) { (void)flags; } | |
| 1136 TraceID(unsigned char id, unsigned char* flags) | |
| 1137 : data_(id) { (void)flags; } | |
| 1138 TraceID(long long id, unsigned char* flags) | |
| 1139 : data_(static_cast<unsigned long long>(id)) { (void)flags; } | |
| 1140 TraceID(long id, unsigned char* flags) | |
| 1141 : data_(static_cast<unsigned long long>(id)) { (void)flags; } | |
| 1142 TraceID(int id, unsigned char* flags) | |
| 1143 : data_(static_cast<unsigned long long>(id)) { (void)flags; } | |
| 1144 TraceID(short id, unsigned char* flags) | |
| 1145 : data_(static_cast<unsigned long long>(id)) { (void)flags; } | |
| 1146 TraceID(signed char id, unsigned char* flags) | |
| 1147 : data_(static_cast<unsigned long long>(id)) { (void)flags; } | |
| 1148 | |
| 1149 unsigned long long data() const { return data_; } | |
| 1150 | |
| 1151 private: | |
| 1152 unsigned long long data_; | |
| 1153 }; | |
| 1154 | |
| 1155 // Simple union to store various types as unsigned long long. | |
| 1156 union TraceValueUnion { | |
| 1157 bool as_bool; | |
| 1158 unsigned long long as_uint; | |
| 1159 long long as_int; | |
| 1160 double as_double; | |
| 1161 const void* as_pointer; | |
| 1162 const char* as_string; | |
| 1163 }; | |
| 1164 | |
| 1165 // Simple container for const char* that should be copied instead of retained. | |
| 1166 class TraceStringWithCopy { | |
| 1167 public: | |
| 1168 explicit TraceStringWithCopy(const char* str) : str_(str) {} | |
| 1169 const char* str() const { return str_; } | |
| 1170 private: | |
| 1171 const char* str_; | |
| 1172 }; | |
| 1173 | |
| 1174 // Define SetTraceValue for each allowed type. It stores the type and | |
| 1175 // value in the return arguments. This allows this API to avoid declaring any | |
| 1176 // structures so that it is portable to third_party libraries. | |
| 1177 #define INTERNAL_DECLARE_SET_TRACE_VALUE(actual_type, \ | |
| 1178 arg_expression, \ | |
| 1179 union_member, \ | |
| 1180 value_type_id) \ | |
| 1181 static inline void SetTraceValue( \ | |
| 1182 actual_type arg, \ | |
| 1183 unsigned char* type, \ | |
| 1184 unsigned long long* value) { \ | |
| 1185 TraceValueUnion type_value; \ | |
| 1186 type_value.union_member = arg_expression; \ | |
| 1187 *type = value_type_id; \ | |
| 1188 *value = type_value.as_uint; \ | |
| 1189 } | |
| 1190 // Simpler form for int types that can be safely casted. | |
| 1191 #define INTERNAL_DECLARE_SET_TRACE_VALUE_INT(actual_type, \ | |
| 1192 value_type_id) \ | |
| 1193 static inline void SetTraceValue( \ | |
| 1194 actual_type arg, \ | |
| 1195 unsigned char* type, \ | |
| 1196 unsigned long long* value) { \ | |
| 1197 *type = value_type_id; \ | |
| 1198 *value = static_cast<unsigned long long>(arg); \ | |
| 1199 } | |
| 1200 | |
| 1201 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned long long, TRACE_VALUE_TYPE_UINT) | |
| 1202 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned long, TRACE_VALUE_TYPE_UINT) | |
| 1203 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned int, TRACE_VALUE_TYPE_UINT) | |
| 1204 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned short, TRACE_VALUE_TYPE_UINT) | |
| 1205 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned char, TRACE_VALUE_TYPE_UINT) | |
| 1206 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(long long, TRACE_VALUE_TYPE_INT) | |
| 1207 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(long, TRACE_VALUE_TYPE_INT) | |
| 1208 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(int, TRACE_VALUE_TYPE_INT) | |
| 1209 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(short, TRACE_VALUE_TYPE_INT) | |
| 1210 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(signed char, TRACE_VALUE_TYPE_INT) | |
| 1211 INTERNAL_DECLARE_SET_TRACE_VALUE(bool, arg, as_bool, TRACE_VALUE_TYPE_BOOL) | |
| 1212 INTERNAL_DECLARE_SET_TRACE_VALUE(double, arg, as_double, | |
| 1213 TRACE_VALUE_TYPE_DOUBLE) | |
| 1214 INTERNAL_DECLARE_SET_TRACE_VALUE(const void*, arg, as_pointer, | |
| 1215 TRACE_VALUE_TYPE_POINTER) | |
| 1216 INTERNAL_DECLARE_SET_TRACE_VALUE(const char*, arg, as_string, | |
| 1217 TRACE_VALUE_TYPE_STRING) | |
| 1218 INTERNAL_DECLARE_SET_TRACE_VALUE(const TraceStringWithCopy&, arg.str(), | |
| 1219 as_string, TRACE_VALUE_TYPE_COPY_STRING) | |
| 1220 | |
| 1221 #undef INTERNAL_DECLARE_SET_TRACE_VALUE | |
| 1222 #undef INTERNAL_DECLARE_SET_TRACE_VALUE_INT | |
| 1223 | |
| 1224 // std::string version of SetTraceValue so that trace arguments can be strings. | |
| 1225 static inline void SetTraceValue(const std::string& arg, | |
| 1226 unsigned char* type, | |
| 1227 unsigned long long* value) { | |
| 1228 TraceValueUnion type_value; | |
| 1229 type_value.as_string = arg.c_str(); | |
| 1230 *type = TRACE_VALUE_TYPE_COPY_STRING; | |
| 1231 *value = type_value.as_uint; | |
| 1232 } | |
| 1233 | |
| 1234 // base::Time and base::TimeTicks version of SetTraceValue to make it easier to | |
| 1235 // trace these types. | |
| 1236 static inline void SetTraceValue(const base::Time arg, | |
| 1237 unsigned char* type, | |
| 1238 unsigned long long* value) { | |
| 1239 *type = TRACE_VALUE_TYPE_INT; | |
| 1240 *value = arg.ToInternalValue(); | |
| 1241 } | |
| 1242 | |
| 1243 static inline void SetTraceValue(const base::TimeTicks arg, | |
| 1244 unsigned char* type, | |
| 1245 unsigned long long* value) { | |
| 1246 *type = TRACE_VALUE_TYPE_INT; | |
| 1247 *value = arg.ToInternalValue(); | |
| 1248 } | |
| 1249 | |
| 1250 // These AddTraceEvent and AddTraceEventWithThreadIdAndTimestamp template | |
| 1251 // functions are defined here instead of in the macro, because the arg_values | |
| 1252 // could be temporary objects, such as std::string. In order to store | |
| 1253 // pointers to the internal c_str and pass through to the tracing API, | |
| 1254 // the arg_values must live throughout these procedures. | |
| 1255 | |
| 1256 static inline base::debug::TraceEventHandle | |
| 1257 AddTraceEventWithThreadIdAndTimestamp( | |
| 1258 char phase, | |
| 1259 const unsigned char* category_group_enabled, | |
| 1260 const char* name, | |
| 1261 unsigned long long id, | |
| 1262 int thread_id, | |
| 1263 const base::TimeTicks& timestamp, | |
| 1264 unsigned char flags, | |
| 1265 const char* arg1_name, | |
| 1266 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg1_val) { | |
| 1267 const int num_args = 1; | |
| 1268 unsigned char arg_types[1] = { TRACE_VALUE_TYPE_CONVERTABLE }; | |
| 1269 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( | |
| 1270 phase, category_group_enabled, name, id, thread_id, timestamp, | |
| 1271 num_args, &arg1_name, arg_types, NULL, &arg1_val, flags); | |
| 1272 } | |
| 1273 | |
| 1274 template<class ARG1_TYPE> | |
| 1275 static inline base::debug::TraceEventHandle | |
| 1276 AddTraceEventWithThreadIdAndTimestamp( | |
| 1277 char phase, | |
| 1278 const unsigned char* category_group_enabled, | |
| 1279 const char* name, | |
| 1280 unsigned long long id, | |
| 1281 int thread_id, | |
| 1282 const base::TimeTicks& timestamp, | |
| 1283 unsigned char flags, | |
| 1284 const char* arg1_name, | |
| 1285 const ARG1_TYPE& arg1_val, | |
| 1286 const char* arg2_name, | |
| 1287 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg2_val) { | |
| 1288 const int num_args = 2; | |
| 1289 const char* arg_names[2] = { arg1_name, arg2_name }; | |
| 1290 | |
| 1291 unsigned char arg_types[2]; | |
| 1292 unsigned long long arg_values[2]; | |
| 1293 SetTraceValue(arg1_val, &arg_types[0], &arg_values[0]); | |
| 1294 arg_types[1] = TRACE_VALUE_TYPE_CONVERTABLE; | |
| 1295 | |
| 1296 scoped_refptr<base::debug::ConvertableToTraceFormat> convertable_values[2]; | |
| 1297 convertable_values[1] = arg2_val; | |
| 1298 | |
| 1299 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( | |
| 1300 phase, category_group_enabled, name, id, thread_id, timestamp, | |
| 1301 num_args, arg_names, arg_types, arg_values, convertable_values, flags); | |
| 1302 } | |
| 1303 | |
| 1304 template<class ARG2_TYPE> | |
| 1305 static inline base::debug::TraceEventHandle | |
| 1306 AddTraceEventWithThreadIdAndTimestamp( | |
| 1307 char phase, | |
| 1308 const unsigned char* category_group_enabled, | |
| 1309 const char* name, | |
| 1310 unsigned long long id, | |
| 1311 int thread_id, | |
| 1312 const base::TimeTicks& timestamp, | |
| 1313 unsigned char flags, | |
| 1314 const char* arg1_name, | |
| 1315 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg1_val, | |
| 1316 const char* arg2_name, | |
| 1317 const ARG2_TYPE& arg2_val) { | |
| 1318 const int num_args = 2; | |
| 1319 const char* arg_names[2] = { arg1_name, arg2_name }; | |
| 1320 | |
| 1321 unsigned char arg_types[2]; | |
| 1322 unsigned long long arg_values[2]; | |
| 1323 arg_types[0] = TRACE_VALUE_TYPE_CONVERTABLE; | |
| 1324 arg_values[0] = 0; | |
| 1325 SetTraceValue(arg2_val, &arg_types[1], &arg_values[1]); | |
| 1326 | |
| 1327 scoped_refptr<base::debug::ConvertableToTraceFormat> convertable_values[2]; | |
| 1328 convertable_values[0] = arg1_val; | |
| 1329 | |
| 1330 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( | |
| 1331 phase, category_group_enabled, name, id, thread_id, timestamp, | |
| 1332 num_args, arg_names, arg_types, arg_values, convertable_values, flags); | |
| 1333 } | |
| 1334 | |
| 1335 static inline base::debug::TraceEventHandle | |
| 1336 AddTraceEventWithThreadIdAndTimestamp( | |
| 1337 char phase, | |
| 1338 const unsigned char* category_group_enabled, | |
| 1339 const char* name, | |
| 1340 unsigned long long id, | |
| 1341 int thread_id, | |
| 1342 const base::TimeTicks& timestamp, | |
| 1343 unsigned char flags, | |
| 1344 const char* arg1_name, | |
| 1345 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg1_val, | |
| 1346 const char* arg2_name, | |
| 1347 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg2_val) { | |
| 1348 const int num_args = 2; | |
| 1349 const char* arg_names[2] = { arg1_name, arg2_name }; | |
| 1350 unsigned char arg_types[2] = | |
| 1351 { TRACE_VALUE_TYPE_CONVERTABLE, TRACE_VALUE_TYPE_CONVERTABLE }; | |
| 1352 scoped_refptr<base::debug::ConvertableToTraceFormat> convertable_values[2] = | |
| 1353 { arg1_val, arg2_val }; | |
| 1354 | |
| 1355 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( | |
| 1356 phase, category_group_enabled, name, id, thread_id, timestamp, | |
| 1357 num_args, arg_names, arg_types, NULL, convertable_values, flags); | |
| 1358 } | |
| 1359 | |
| 1360 static inline base::debug::TraceEventHandle | |
| 1361 AddTraceEventWithThreadIdAndTimestamp( | |
| 1362 char phase, | |
| 1363 const unsigned char* category_group_enabled, | |
| 1364 const char* name, | |
| 1365 unsigned long long id, | |
| 1366 int thread_id, | |
| 1367 const base::TimeTicks& timestamp, | |
| 1368 unsigned char flags) { | |
| 1369 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( | |
| 1370 phase, category_group_enabled, name, id, thread_id, timestamp, | |
| 1371 kZeroNumArgs, NULL, NULL, NULL, NULL, flags); | |
| 1372 } | |
| 1373 | |
| 1374 static inline base::debug::TraceEventHandle AddTraceEvent( | |
| 1375 char phase, | |
| 1376 const unsigned char* category_group_enabled, | |
| 1377 const char* name, | |
| 1378 unsigned long long id, | |
| 1379 unsigned char flags) { | |
| 1380 int thread_id = static_cast<int>(base::PlatformThread::CurrentId()); | |
| 1381 base::TimeTicks now = base::TimeTicks::NowFromSystemTraceTime(); | |
| 1382 return AddTraceEventWithThreadIdAndTimestamp(phase, category_group_enabled, | |
| 1383 name, id, thread_id, now, flags); | |
| 1384 } | |
| 1385 | |
| 1386 template<class ARG1_TYPE> | |
| 1387 static inline base::debug::TraceEventHandle | |
| 1388 AddTraceEventWithThreadIdAndTimestamp( | |
| 1389 char phase, | |
| 1390 const unsigned char* category_group_enabled, | |
| 1391 const char* name, | |
| 1392 unsigned long long id, | |
| 1393 int thread_id, | |
| 1394 const base::TimeTicks& timestamp, | |
| 1395 unsigned char flags, | |
| 1396 const char* arg1_name, | |
| 1397 const ARG1_TYPE& arg1_val) { | |
| 1398 const int num_args = 1; | |
| 1399 unsigned char arg_types[1]; | |
| 1400 unsigned long long arg_values[1]; | |
| 1401 SetTraceValue(arg1_val, &arg_types[0], &arg_values[0]); | |
| 1402 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( | |
| 1403 phase, category_group_enabled, name, id, thread_id, timestamp, | |
| 1404 num_args, &arg1_name, arg_types, arg_values, NULL, flags); | |
| 1405 } | |
| 1406 | |
| 1407 template<class ARG1_TYPE> | |
| 1408 static inline base::debug::TraceEventHandle AddTraceEvent( | |
| 1409 char phase, | |
| 1410 const unsigned char* category_group_enabled, | |
| 1411 const char* name, | |
| 1412 unsigned long long id, | |
| 1413 unsigned char flags, | |
| 1414 const char* arg1_name, | |
| 1415 const ARG1_TYPE& arg1_val) { | |
| 1416 int thread_id = static_cast<int>(base::PlatformThread::CurrentId()); | |
| 1417 base::TimeTicks now = base::TimeTicks::NowFromSystemTraceTime(); | |
| 1418 return AddTraceEventWithThreadIdAndTimestamp(phase, category_group_enabled, | |
| 1419 name, id, thread_id, now, flags, | |
| 1420 arg1_name, arg1_val); | |
| 1421 } | |
| 1422 | |
| 1423 template<class ARG1_TYPE, class ARG2_TYPE> | |
| 1424 static inline base::debug::TraceEventHandle | |
| 1425 AddTraceEventWithThreadIdAndTimestamp( | |
| 1426 char phase, | |
| 1427 const unsigned char* category_group_enabled, | |
| 1428 const char* name, | |
| 1429 unsigned long long id, | |
| 1430 int thread_id, | |
| 1431 const base::TimeTicks& timestamp, | |
| 1432 unsigned char flags, | |
| 1433 const char* arg1_name, | |
| 1434 const ARG1_TYPE& arg1_val, | |
| 1435 const char* arg2_name, | |
| 1436 const ARG2_TYPE& arg2_val) { | |
| 1437 const int num_args = 2; | |
| 1438 const char* arg_names[2] = { arg1_name, arg2_name }; | |
| 1439 unsigned char arg_types[2]; | |
| 1440 unsigned long long arg_values[2]; | |
| 1441 SetTraceValue(arg1_val, &arg_types[0], &arg_values[0]); | |
| 1442 SetTraceValue(arg2_val, &arg_types[1], &arg_values[1]); | |
| 1443 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( | |
| 1444 phase, category_group_enabled, name, id, thread_id, timestamp, | |
| 1445 num_args, arg_names, arg_types, arg_values, NULL, flags); | |
| 1446 } | |
| 1447 | |
| 1448 template<class ARG1_TYPE, class ARG2_TYPE> | |
| 1449 static inline base::debug::TraceEventHandle AddTraceEvent( | |
| 1450 char phase, | |
| 1451 const unsigned char* category_group_enabled, | |
| 1452 const char* name, | |
| 1453 unsigned long long id, | |
| 1454 unsigned char flags, | |
| 1455 const char* arg1_name, | |
| 1456 const ARG1_TYPE& arg1_val, | |
| 1457 const char* arg2_name, | |
| 1458 const ARG2_TYPE& arg2_val) { | |
| 1459 int thread_id = static_cast<int>(base::PlatformThread::CurrentId()); | |
| 1460 base::TimeTicks now = base::TimeTicks::NowFromSystemTraceTime(); | |
| 1461 return AddTraceEventWithThreadIdAndTimestamp(phase, category_group_enabled, | |
| 1462 name, id, thread_id, now, flags, | |
| 1463 arg1_name, arg1_val, | |
| 1464 arg2_name, arg2_val); | |
| 1465 } | |
| 1466 | |
| 1467 // Used by TRACE_EVENTx macros. Do not use directly. | |
| 1468 class TRACE_EVENT_API_CLASS_EXPORT ScopedTracer { | |
| 1469 public: | |
| 1470 // Note: members of data_ intentionally left uninitialized. See Initialize. | |
| 1471 ScopedTracer() : p_data_(NULL) {} | |
| 1472 | |
| 1473 ~ScopedTracer() { | |
| 1474 if (p_data_ && *data_.category_group_enabled) | |
| 1475 TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION( | |
| 1476 data_.category_group_enabled, data_.name, data_.event_handle); | |
| 1477 } | |
| 1478 | |
| 1479 void Initialize(const unsigned char* category_group_enabled, | |
| 1480 const char* name, | |
| 1481 base::debug::TraceEventHandle event_handle) { | |
| 1482 data_.category_group_enabled = category_group_enabled; | |
| 1483 data_.name = name; | |
| 1484 data_.event_handle = event_handle; | |
| 1485 p_data_ = &data_; | |
| 1486 } | |
| 1487 | |
| 1488 private: | |
| 1489 // This Data struct workaround is to avoid initializing all the members | |
| 1490 // in Data during construction of this object, since this object is always | |
| 1491 // constructed, even when tracing is disabled. If the members of Data were | |
| 1492 // members of this class instead, compiler warnings occur about potential | |
| 1493 // uninitialized accesses. | |
| 1494 struct Data { | |
| 1495 const unsigned char* category_group_enabled; | |
| 1496 const char* name; | |
| 1497 base::debug::TraceEventHandle event_handle; | |
| 1498 }; | |
| 1499 Data* p_data_; | |
| 1500 Data data_; | |
| 1501 }; | |
| 1502 | |
| 1503 // Used by TRACE_EVENT_BINARY_EFFICIENTx macro. Do not use directly. | |
| 1504 class TRACE_EVENT_API_CLASS_EXPORT ScopedTraceBinaryEfficient { | |
| 1505 public: | |
| 1506 ScopedTraceBinaryEfficient(const char* category_group, const char* name); | |
| 1507 ~ScopedTraceBinaryEfficient(); | |
| 1508 | |
| 1509 private: | |
| 1510 const unsigned char* category_group_enabled_; | |
| 1511 const char* name_; | |
| 1512 base::debug::TraceEventHandle event_handle_; | |
| 1513 }; | |
| 1514 | |
| 1515 // This macro generates less code then TRACE_EVENT0 but is also | |
| 1516 // slower to execute when tracing is off. It should generally only be | |
| 1517 // used with code that is seldom executed or conditionally executed | |
| 1518 // when debugging. | |
| 1519 // For now the category_group must be "gpu". | |
| 1520 #define TRACE_EVENT_BINARY_EFFICIENT0(category_group, name) \ | |
| 1521 trace_event_internal::ScopedTraceBinaryEfficient \ | |
| 1522 INTERNAL_TRACE_EVENT_UID(scoped_trace)(category_group, name); | |
| 1523 | |
| 1524 // TraceEventSamplingStateScope records the current sampling state | |
| 1525 // and sets a new sampling state. When the scope exists, it restores | |
| 1526 // the sampling state having recorded. | |
| 1527 template<size_t BucketNumber> | |
| 1528 class TraceEventSamplingStateScope { | |
| 1529 public: | |
| 1530 TraceEventSamplingStateScope(const char* category_and_name) { | |
| 1531 previous_state_ = TraceEventSamplingStateScope<BucketNumber>::Current(); | |
| 1532 TraceEventSamplingStateScope<BucketNumber>::Set(category_and_name); | |
| 1533 } | |
| 1534 | |
| 1535 ~TraceEventSamplingStateScope() { | |
| 1536 TraceEventSamplingStateScope<BucketNumber>::Set(previous_state_); | |
| 1537 } | |
| 1538 | |
| 1539 static inline const char* Current() { | |
| 1540 return reinterpret_cast<const char*>(TRACE_EVENT_API_ATOMIC_LOAD( | |
| 1541 g_trace_state[BucketNumber])); | |
| 1542 } | |
| 1543 | |
| 1544 static inline void Set(const char* category_and_name) { | |
| 1545 TRACE_EVENT_API_ATOMIC_STORE( | |
| 1546 g_trace_state[BucketNumber], | |
| 1547 reinterpret_cast<TRACE_EVENT_API_ATOMIC_WORD>( | |
| 1548 const_cast<char*>(category_and_name))); | |
| 1549 } | |
| 1550 | |
| 1551 private: | |
| 1552 const char* previous_state_; | |
| 1553 }; | |
| 1554 | |
| 1555 } // namespace trace_event_internal | |
| 1556 | |
| 1557 namespace base { | |
| 1558 namespace debug { | |
| 1559 | |
| 1560 template<typename IDType> class TraceScopedTrackableObject { | |
| 1561 public: | |
| 1562 TraceScopedTrackableObject(const char* category_group, const char* name, | |
| 1563 IDType id) | |
| 1564 : category_group_(category_group), | |
| 1565 name_(name), | |
| 1566 id_(id) { | |
| 1567 TRACE_EVENT_OBJECT_CREATED_WITH_ID(category_group_, name_, id_); | |
| 1568 } | |
| 1569 | |
| 1570 template <typename ArgType> void snapshot(ArgType snapshot) { | |
| 1571 TRACE_EVENT_OBJECT_SNAPSHOT_WITH_ID(category_group_, name_, id_, snapshot); | |
| 1572 } | |
| 1573 | |
| 1574 ~TraceScopedTrackableObject() { | |
| 1575 TRACE_EVENT_OBJECT_DELETED_WITH_ID(category_group_, name_, id_); | |
| 1576 } | |
| 1577 | |
| 1578 private: | |
| 1579 const char* category_group_; | |
| 1580 const char* name_; | |
| 1581 IDType id_; | |
| 1582 | |
| 1583 DISALLOW_COPY_AND_ASSIGN(TraceScopedTrackableObject); | |
| 1584 }; | |
| 1585 | |
| 1586 } // namespace debug | |
| 1587 } // namespace base | |
| 1588 | |
| 1589 #endif /* BASE_DEBUG_TRACE_EVENT_H_ */ | |
| OLD | NEW |