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 3 // found in the LICENSE file. 4 5 // This header file defines the set of trace_event macros without specifying 6 // how the events actually get collected and stored. If you need to expose trace 7 // events to some other universe, you can copy-and-paste this file as well as 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 189 #ifndef BASE_DEBUG_TRACE_EVENT_H_ 190 #define BASE_DEBUG_TRACE_EVENT_H_ 191 192 #include <string> 193 194 #include "base/atomicops.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 399 // Records a single END event for "name" immediately. If the category 400 // is not enabled, then this does nothing. 401 // - category and name strings must have application lifetime (statics or 402 // literals). They may not include " chars. 403 #define TRACE_EVENT_END0(category_group, name) \ 404 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ 405 category_group, name, TRACE_EVENT_FLAG_NONE) 406 #define TRACE_EVENT_END1(category_group, name, arg1_name, arg1_val) \ 407 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ 408 category_group, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) 409 #define TRACE_EVENT_END2(category_group, name, arg1_name, arg1_val, \ 410 arg2_name, arg2_val) \ 411 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ 412 category_group, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \ 413 arg2_name, arg2_val) 414 #define TRACE_EVENT_COPY_END0(category_group, name) \ 415 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ 416 category_group, name, TRACE_EVENT_FLAG_COPY) 417 #define TRACE_EVENT_COPY_END1(category_group, name, arg1_name, arg1_val) \ 418 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ 419 category_group, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val) 420 #define TRACE_EVENT_COPY_END2(category_group, name, arg1_name, arg1_val, \ 421 arg2_name, arg2_val) \ 422 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \ 423 category_group, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val, \ 424 arg2_name, arg2_val) 425 426 // Similar to TRACE_EVENT_ENDx but with a custom |at| timestamp provided. 427 // - |id| is used to match the _BEGIN event with the _END event. 428 // Events are considered to match if their category_group, name and id values 429 // all match. |id| must either be a pointer or an integer value up to 64 bits. 430 // If it's a pointer, the bits will be xored with a hash of the process ID so 431 // that the same pointer on two different processes will not collide. 432 #define TRACE_EVENT_END_WITH_ID_TID_AND_TIMESTAMP0(category_group, \ 433 name, id, thread_id, timestamp) \ 434 INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP( \ 435 TRACE_EVENT_PHASE_ASYNC_END, category_group, name, id, thread_id, \ 436 timestamp, TRACE_EVENT_FLAG_NONE) 437 #define TRACE_EVENT_COPY_END_WITH_ID_TID_AND_TIMESTAMP0( \ 438 category_group, 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_COPY) 442 443 // Records the value of a counter called "name" immediately. Value 444 // must be representable as a 32 bit integer. 445 // - category and name strings must have application lifetime (statics or 446 // literals). They may not include " chars. 447 #define TRACE_COUNTER1(category_group, name, value) \ 448 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \ 449 category_group, name, TRACE_EVENT_FLAG_NONE, \ 450 "value", static_cast<int>(value)) 451 #define TRACE_COPY_COUNTER1(category_group, name, value) \ 452 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \ 453 category_group, name, TRACE_EVENT_FLAG_COPY, \ 454 "value", static_cast<int>(value)) 455 456 // Records the values of a multi-parted counter called "name" immediately. 457 // The UI will treat value1 and value2 as parts of a whole, displaying their 458 // values as a stacked-bar chart. 459 // - category and name strings must have application lifetime (statics or 460 // literals). They may not include " chars. 461 #define TRACE_COUNTER2(category_group, name, value1_name, value1_val, \ 462 value2_name, value2_val) \ 463 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \ 464 category_group, name, TRACE_EVENT_FLAG_NONE, \ 465 value1_name, static_cast<int>(value1_val), \ 466 value2_name, static_cast<int>(value2_val)) 467 #define TRACE_COPY_COUNTER2(category_group, name, value1_name, value1_val, \ 468 value2_name, value2_val) \ 469 INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \ 470 category_group, name, TRACE_EVENT_FLAG_COPY, \ 471 value1_name, static_cast<int>(value1_val), \ 472 value2_name, static_cast<int>(value2_val)) 473 474 // Records the value of a counter called "name" immediately. Value 475 // must be representable as a 32 bit integer. 476 // - category and name strings must have application lifetime (statics or 477 // literals). They may not include " chars. 478 // - |id| is used to disambiguate counters with the same name. It must either 479 // be a pointer or an integer value up to 64 bits. If it's a pointer, the bits 480 // will be xored with a hash of the process ID so that the same pointer on 481 // two different processes will not collide. 482 #define TRACE_COUNTER_ID1(category_group, name, id, value) \ 483 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \ 484 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ 485 "value", static_cast<int>(value)) 486 #define TRACE_COPY_COUNTER_ID1(category_group, name, id, value) \ 487 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \ 488 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ 489 "value", static_cast<int>(value)) 490 491 // Records the values of a multi-parted counter called "name" immediately. 492 // The UI will treat value1 and value2 as parts of a whole, displaying their 493 // values as a stacked-bar chart. 494 // - category and name strings must have application lifetime (statics or 495 // literals). They may not include " chars. 496 // - |id| is used to disambiguate counters with the same name. It must either 497 // be a pointer or an integer value up to 64 bits. If it's a pointer, the bits 498 // will be xored with a hash of the process ID so that the same pointer on 499 // two different processes will not collide. 500 #define TRACE_COUNTER_ID2(category_group, name, id, value1_name, value1_val, \ 501 value2_name, value2_val) \ 502 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \ 503 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ 504 value1_name, static_cast<int>(value1_val), \ 505 value2_name, static_cast<int>(value2_val)) 506 #define TRACE_COPY_COUNTER_ID2(category_group, name, id, value1_name, \ 507 value1_val, value2_name, value2_val) \ 508 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \ 509 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ 510 value1_name, static_cast<int>(value1_val), \ 511 value2_name, static_cast<int>(value2_val)) 512 513 514 // Records a single ASYNC_BEGIN event called "name" immediately, with 0, 1 or 2 515 // associated arguments. If the category is not enabled, then this 516 // does nothing. 517 // - category and name strings must have application lifetime (statics or 518 // literals). They may not include " chars. 519 // - |id| is used to match the ASYNC_BEGIN event with the ASYNC_END event. ASYNC 520 // events are considered to match if their category_group, name and id values 521 // all match. |id| must either be a pointer or an integer value up to 64 bits. 522 // If it's a pointer, the bits will be xored with a hash of the process ID so 523 // that the same pointer on two different processes will not collide. 524 // 525 // An asynchronous operation can consist of multiple phases. The first phase is 526 // defined by the ASYNC_BEGIN calls. Additional phases can be defined using the 527 // ASYNC_STEP_INTO or ASYNC_STEP_PAST macros. The ASYNC_STEP_INTO macro will 528 // annotate the block following the call. The ASYNC_STEP_PAST macro will 529 // annotate the block prior to the call. Note that any particular event must use 530 // only STEP_INTO or STEP_PAST macros; they can not mix and match. When the 531 // operation completes, call ASYNC_END. 532 // 533 // An ASYNC trace typically occurs on a single thread (if not, they will only be 534 // drawn on the thread defined in the ASYNC_BEGIN event), but all events in that 535 // operation must use the same |name| and |id|. Each step can have its own 536 // args. 537 #define TRACE_EVENT_ASYNC_BEGIN0(category_group, name, id) \ 538 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ 539 category_group, name, id, TRACE_EVENT_FLAG_NONE) 540 #define TRACE_EVENT_ASYNC_BEGIN1(category_group, name, id, arg1_name, \ 541 arg1_val) \ 542 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ 543 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) 544 #define TRACE_EVENT_ASYNC_BEGIN2(category_group, name, id, arg1_name, \ 545 arg1_val, arg2_name, arg2_val) \ 546 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ 547 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ 548 arg1_name, arg1_val, arg2_name, arg2_val) 549 #define TRACE_EVENT_COPY_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_COPY) 552 #define TRACE_EVENT_COPY_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_COPY, \ 556 arg1_name, arg1_val) 557 #define TRACE_EVENT_COPY_ASYNC_BEGIN2(category_group, name, id, arg1_name, \ 558 arg1_val, arg2_name, arg2_val) \ 559 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \ 560 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ 561 arg1_name, arg1_val, arg2_name, arg2_val) 562 563 // Records a single ASYNC_STEP_INTO event for |step| immediately. If the 564 // category is not enabled, then this does nothing. The |name| and |id| must 565 // match the ASYNC_BEGIN event above. The |step| param identifies this step 566 // within the async event. This should be called at the beginning of the next 567 // phase of an asynchronous operation. The ASYNC_BEGIN event must not have any 568 // ASYNC_STEP_PAST events. 569 #define TRACE_EVENT_ASYNC_STEP_INTO0(category_group, name, id, step) \ 570 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_INTO, \ 571 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step) 572 #define TRACE_EVENT_ASYNC_STEP_INTO1(category_group, name, id, step, \ 573 arg1_name, arg1_val) \ 574 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_INTO, \ 575 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step, \ 576 arg1_name, arg1_val) 577 578 // Records a single ASYNC_STEP_PAST event for |step| immediately. If the 579 // category is not enabled, then this does nothing. The |name| and |id| must 580 // match the ASYNC_BEGIN event above. The |step| param identifies this step 581 // within the async event. This should be called at the beginning of the next 582 // phase of an asynchronous operation. The ASYNC_BEGIN event must not have any 583 // ASYNC_STEP_INTO events. 584 #define TRACE_EVENT_ASYNC_STEP_PAST0(category_group, name, id, step) \ 585 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_PAST, \ 586 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step) 587 #define TRACE_EVENT_ASYNC_STEP_PAST1(category_group, name, id, step, \ 588 arg1_name, arg1_val) \ 589 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_PAST, \ 590 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step, \ 591 arg1_name, arg1_val) 592 593 // Records a single ASYNC_END event for "name" immediately. If the category 594 // is not enabled, then this does nothing. 595 #define TRACE_EVENT_ASYNC_END0(category_group, name, id) \ 596 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ 597 category_group, name, id, TRACE_EVENT_FLAG_NONE) 598 #define TRACE_EVENT_ASYNC_END1(category_group, name, id, arg1_name, arg1_val) \ 599 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ 600 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) 601 #define TRACE_EVENT_ASYNC_END2(category_group, name, id, arg1_name, arg1_val, \ 602 arg2_name, arg2_val) \ 603 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ 604 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ 605 arg1_name, arg1_val, arg2_name, arg2_val) 606 #define TRACE_EVENT_COPY_ASYNC_END0(category_group, name, id) \ 607 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ 608 category_group, name, id, TRACE_EVENT_FLAG_COPY) 609 #define TRACE_EVENT_COPY_ASYNC_END1(category_group, name, id, arg1_name, \ 610 arg1_val) \ 611 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ 612 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ 613 arg1_name, arg1_val) 614 #define TRACE_EVENT_COPY_ASYNC_END2(category_group, name, id, arg1_name, \ 615 arg1_val, arg2_name, arg2_val) \ 616 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \ 617 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ 618 arg1_name, arg1_val, arg2_name, arg2_val) 619 620 621 // Records a single FLOW_BEGIN event called "name" immediately, with 0, 1 or 2 622 // associated arguments. If the category is not enabled, then this 623 // does nothing. 624 // - category and name strings must have application lifetime (statics or 625 // literals). They may not include " chars. 626 // - |id| is used to match the FLOW_BEGIN event with the FLOW_END event. FLOW 627 // events are considered to match if their category_group, name and id values 628 // all match. |id| must either be a pointer or an integer value up to 64 bits. 629 // If it's a pointer, the bits will be xored with a hash of the process ID so 630 // that the same pointer on two different processes will not collide. 631 // FLOW events are different from ASYNC events in how they are drawn by the 632 // tracing UI. A FLOW defines asynchronous data flow, such as posting a task 633 // (FLOW_BEGIN) and later executing that task (FLOW_END). Expect FLOWs to be 634 // drawn as lines or arrows from FLOW_BEGIN scopes to FLOW_END scopes. Similar 635 // to ASYNC, a FLOW can consist of multiple phases. The first phase is defined 636 // by the FLOW_BEGIN calls. Additional phases can be defined using the FLOW_STEP 637 // macros. When the operation completes, call FLOW_END. An async operation can 638 // span threads and processes, but all events in that operation must use the 639 // same |name| and |id|. Each event can have its own args. 640 #define TRACE_EVENT_FLOW_BEGIN0(category_group, name, id) \ 641 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ 642 category_group, name, id, TRACE_EVENT_FLAG_NONE) 643 #define TRACE_EVENT_FLOW_BEGIN1(category_group, name, id, arg1_name, arg1_val) \ 644 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ 645 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) 646 #define TRACE_EVENT_FLOW_BEGIN2(category_group, name, id, arg1_name, arg1_val, \ 647 arg2_name, arg2_val) \ 648 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ 649 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ 650 arg1_name, arg1_val, arg2_name, arg2_val) 651 #define TRACE_EVENT_COPY_FLOW_BEGIN0(category_group, name, id) \ 652 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ 653 category_group, name, id, TRACE_EVENT_FLAG_COPY) 654 #define TRACE_EVENT_COPY_FLOW_BEGIN1(category_group, name, id, arg1_name, \ 655 arg1_val) \ 656 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ 657 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ 658 arg1_name, arg1_val) 659 #define TRACE_EVENT_COPY_FLOW_BEGIN2(category_group, name, id, arg1_name, \ 660 arg1_val, arg2_name, arg2_val) \ 661 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_BEGIN, \ 662 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ 663 arg1_name, arg1_val, arg2_name, arg2_val) 664 665 // Records a single FLOW_STEP event for |step| immediately. If the category 666 // is not enabled, then this does nothing. The |name| and |id| must match the 667 // FLOW_BEGIN event above. The |step| param identifies this step within the 668 // async event. This should be called at the beginning of the next phase of an 669 // asynchronous operation. 670 #define TRACE_EVENT_FLOW_STEP0(category_group, name, id, step) \ 671 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_STEP, \ 672 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step) 673 #define TRACE_EVENT_FLOW_STEP1(category_group, name, id, step, \ 674 arg1_name, arg1_val) \ 675 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_STEP, \ 676 category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step, \ 677 arg1_name, arg1_val) 678 #define TRACE_EVENT_COPY_FLOW_STEP0(category_group, name, id, step) \ 679 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_STEP, \ 680 category_group, name, id, TRACE_EVENT_FLAG_COPY, "step", step) 681 #define TRACE_EVENT_COPY_FLOW_STEP1(category_group, name, id, step, \ 682 arg1_name, arg1_val) \ 683 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_STEP, \ 684 category_group, name, id, TRACE_EVENT_FLAG_COPY, "step", step, \ 685 arg1_name, arg1_val) 686 687 // Records a single FLOW_END event for "name" immediately. If the category 688 // is not enabled, then this does nothing. 689 #define TRACE_EVENT_FLOW_END0(category_group, name, id) \ 690 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ 691 category_group, name, id, TRACE_EVENT_FLAG_NONE) 692 #define TRACE_EVENT_FLOW_END1(category_group, name, id, arg1_name, arg1_val) \ 693 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ 694 category_group, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val) 695 #define TRACE_EVENT_FLOW_END2(category_group, name, id, arg1_name, arg1_val, \ 696 arg2_name, arg2_val) \ 697 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ 698 category_group, name, id, TRACE_EVENT_FLAG_NONE, \ 699 arg1_name, arg1_val, arg2_name, arg2_val) 700 #define TRACE_EVENT_COPY_FLOW_END0(category_group, name, id) \ 701 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ 702 category_group, name, id, TRACE_EVENT_FLAG_COPY) 703 #define TRACE_EVENT_COPY_FLOW_END1(category_group, name, id, arg1_name, \ 704 arg1_val) \ 705 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ 706 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ 707 arg1_name, arg1_val) 708 #define TRACE_EVENT_COPY_FLOW_END2(category_group, name, id, arg1_name, \ 709 arg1_val, arg2_name, arg2_val) \ 710 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_FLOW_END, \ 711 category_group, name, id, TRACE_EVENT_FLAG_COPY, \ 712 arg1_name, arg1_val, arg2_name, arg2_val) 713 714 // Macros to track the life time and value of arbitrary client objects. 715 // See also TraceTrackableObject. 716 #define TRACE_EVENT_OBJECT_CREATED_WITH_ID(category_group, name, id) \ 717 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_CREATE_OBJECT, \ 718 category_group, name, TRACE_ID_DONT_MANGLE(id), TRACE_EVENT_FLAG_NONE) 719 720 #define TRACE_EVENT_OBJECT_SNAPSHOT_WITH_ID(category_group, name, id, snapshot) \ 721 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_SNAPSHOT_OBJECT, \ 722 category_group, name, TRACE_ID_DONT_MANGLE(id), TRACE_EVENT_FLAG_NONE,\ 723 "snapshot", snapshot) 724 725 #define TRACE_EVENT_OBJECT_DELETED_WITH_ID(category_group, name, id) \ 726 INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_DELETE_OBJECT, \ 727 category_group, name, TRACE_ID_DONT_MANGLE(id), TRACE_EVENT_FLAG_NONE) 728 729 #define INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE() \ 730 UNLIKELY(*INTERNAL_TRACE_EVENT_UID(category_group_enabled) & \ 731 (base::debug::TraceLog::ENABLED_FOR_RECORDING | \ 732 base::debug::TraceLog::ENABLED_FOR_EVENT_CALLBACK)) 733 734 // Macro to efficiently determine if a given category group is enabled. 735 #define TRACE_EVENT_CATEGORY_GROUP_ENABLED(category_group, ret) \ 736 do { \ 737 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ 738 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ 739 *ret = true; \ 740 } else { \ 741 *ret = false; \ 742 } \ 743 } while (0) 744 745 // Macro to efficiently determine, through polling, if a new trace has begun. 746 #define TRACE_EVENT_IS_NEW_TRACE(ret) \ 747 do { \ 748 static int INTERNAL_TRACE_EVENT_UID(lastRecordingNumber) = 0; \ 749 int num_traces_recorded = TRACE_EVENT_API_GET_NUM_TRACES_RECORDED(); \ 750 if (num_traces_recorded != -1 && \ 751 num_traces_recorded != \ 752 INTERNAL_TRACE_EVENT_UID(lastRecordingNumber)) { \ 753 INTERNAL_TRACE_EVENT_UID(lastRecordingNumber) = \ 754 num_traces_recorded; \ 755 *ret = true; \ 756 } else { \ 757 *ret = false; \ 758 } \ 759 } while (0) 760 761 //////////////////////////////////////////////////////////////////////////////// 762 // Implementation specific tracing API definitions. 763 764 // Get a pointer to the enabled state of the given trace category. Only 765 // long-lived literal strings should be given as the category group. The 766 // returned pointer can be held permanently in a local static for example. If 767 // the unsigned char is non-zero, tracing is enabled. If tracing is enabled, 768 // TRACE_EVENT_API_ADD_TRACE_EVENT can be called. It's OK if tracing is disabled 769 // between the load of the tracing state and the call to 770 // TRACE_EVENT_API_ADD_TRACE_EVENT, because this flag only provides an early out 771 // for best performance when tracing is disabled. 772 // const unsigned char* 773 // TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED(const char* category_group) 774 #define TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED \ 775 base::debug::TraceLog::GetCategoryGroupEnabled 776 777 // Get the number of times traces have been recorded. This is used to implement 778 // the TRACE_EVENT_IS_NEW_TRACE facility. 779 // unsigned int TRACE_EVENT_API_GET_NUM_TRACES_RECORDED() 780 #define TRACE_EVENT_API_GET_NUM_TRACES_RECORDED \ 781 base::debug::TraceLog::GetInstance()->GetNumTracesRecorded 782 783 // Add a trace event to the platform tracing system. 784 // base::debug::TraceEventHandle TRACE_EVENT_API_ADD_TRACE_EVENT( 785 // char phase, 786 // const unsigned char* category_group_enabled, 787 // const char* name, 788 // unsigned long long id, 789 // int num_args, 790 // const char** arg_names, 791 // const unsigned char* arg_types, 792 // const unsigned long long* arg_values, 793 // unsigned char flags) 794 #define TRACE_EVENT_API_ADD_TRACE_EVENT \ 795 base::debug::TraceLog::GetInstance()->AddTraceEvent 796 797 // Add a trace event to the platform tracing system. 798 // base::debug::TraceEventHandle TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_TIMESTAMP( 799 // char phase, 800 // const unsigned char* category_group_enabled, 801 // const char* name, 802 // unsigned long long id, 803 // int thread_id, 804 // const TimeTicks& timestamp, 805 // int num_args, 806 // const char** arg_names, 807 // const unsigned char* arg_types, 808 // const unsigned long long* arg_values, 809 // unsigned char flags) 810 #define TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP \ 811 base::debug::TraceLog::GetInstance()->AddTraceEventWithThreadIdAndTimestamp 812 813 // Set the duration field of a COMPLETE trace event. 814 // void TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION( 815 // const unsigned char* category_group_enabled, 816 // const char* name, 817 // base::debug::TraceEventHandle id) 818 #define TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION \ 819 base::debug::TraceLog::GetInstance()->UpdateTraceEventDuration 820 821 // Defines atomic operations used internally by the tracing system. 822 #define TRACE_EVENT_API_ATOMIC_WORD base::subtle::AtomicWord 823 #define TRACE_EVENT_API_ATOMIC_LOAD(var) base::subtle::NoBarrier_Load(&(var)) 824 #define TRACE_EVENT_API_ATOMIC_STORE(var, value) \ 825 base::subtle::NoBarrier_Store(&(var), (value)) 826 827 // Defines visibility for classes in trace_event.h 828 #define TRACE_EVENT_API_CLASS_EXPORT BASE_EXPORT 829 830 // The thread buckets for the sampling profiler. 831 TRACE_EVENT_API_CLASS_EXPORT extern \ 832 TRACE_EVENT_API_ATOMIC_WORD g_trace_state[3]; 833 834 #define TRACE_EVENT_API_THREAD_BUCKET(thread_bucket) \ 835 g_trace_state[thread_bucket] 836 837 //////////////////////////////////////////////////////////////////////////////// 838 839 // Implementation detail: trace event macros create temporary variables 840 // to keep instrumentation overhead low. These macros give each temporary 841 // variable a unique name based on the line number to prevent name collisions. 842 #define INTERNAL_TRACE_EVENT_UID3(a,b) \ 843 trace_event_unique_##a##b 844 #define INTERNAL_TRACE_EVENT_UID2(a,b) \ 845 INTERNAL_TRACE_EVENT_UID3(a,b) 846 #define INTERNAL_TRACE_EVENT_UID(name_prefix) \ 847 INTERNAL_TRACE_EVENT_UID2(name_prefix, __LINE__) 848 849 // Implementation detail: internal macro to create static category. 850 // No barriers are needed, because this code is designed to operate safely 851 // even when the unsigned char* points to garbage data (which may be the case 852 // on processors without cache coherency). 853 #define INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO_CUSTOM_VARIABLES( \ 854 category_group, atomic, category_group_enabled) \ 855 category_group_enabled = \ 856 reinterpret_cast<const unsigned char*>(TRACE_EVENT_API_ATOMIC_LOAD( \ 857 atomic)); \ 858 if (UNLIKELY(!category_group_enabled)) { \ 859 category_group_enabled = \ 860 TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED(category_group); \ 861 TRACE_EVENT_API_ATOMIC_STORE(atomic, \ 862 reinterpret_cast<TRACE_EVENT_API_ATOMIC_WORD>( \ 863 category_group_enabled)); \ 864 } 865 866 #define INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group) \ 867 static TRACE_EVENT_API_ATOMIC_WORD INTERNAL_TRACE_EVENT_UID(atomic) = 0; \ 868 const unsigned char* INTERNAL_TRACE_EVENT_UID(category_group_enabled); \ 869 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO_CUSTOM_VARIABLES(category_group, \ 870 INTERNAL_TRACE_EVENT_UID(atomic), \ 871 INTERNAL_TRACE_EVENT_UID(category_group_enabled)); 872 873 // Implementation detail: internal macro to create static category and add 874 // event if the category is enabled. 875 #define INTERNAL_TRACE_EVENT_ADD(phase, category_group, name, flags, ...) \ 876 do { \ 877 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ 878 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ 879 trace_event_internal::AddTraceEvent( \ 880 phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), name, \ 881 trace_event_internal::kNoEventId, flags, ##__VA_ARGS__); \ 882 } \ 883 } while (0) 884 885 // Implementation detail: internal macro to create static category and add begin 886 // event if the category is enabled. Also adds the end event when the scope 887 // ends. 888 #define INTERNAL_TRACE_EVENT_ADD_SCOPED(category_group, name, ...) \ 889 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ 890 trace_event_internal::ScopedTracer INTERNAL_TRACE_EVENT_UID(tracer); \ 891 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ 892 base::debug::TraceEventHandle h = trace_event_internal::AddTraceEvent( \ 893 TRACE_EVENT_PHASE_COMPLETE, \ 894 INTERNAL_TRACE_EVENT_UID(category_group_enabled), \ 895 name, trace_event_internal::kNoEventId, \ 896 TRACE_EVENT_FLAG_NONE, ##__VA_ARGS__); \ 897 INTERNAL_TRACE_EVENT_UID(tracer).Initialize( \ 898 INTERNAL_TRACE_EVENT_UID(category_group_enabled), name, h); \ 899 } 900 901 // Implementation detail: internal macro to create static category and add 902 // event if the category is enabled. 903 #define INTERNAL_TRACE_EVENT_ADD_WITH_ID(phase, category_group, name, id, \ 904 flags, ...) \ 905 do { \ 906 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ 907 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ 908 unsigned char trace_event_flags = flags | TRACE_EVENT_FLAG_HAS_ID; \ 909 trace_event_internal::TraceID trace_event_trace_id( \ 910 id, &trace_event_flags); \ 911 trace_event_internal::AddTraceEvent( \ 912 phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), \ 913 name, trace_event_trace_id.data(), trace_event_flags, \ 914 ##__VA_ARGS__); \ 915 } \ 916 } while (0) 917 918 // Implementation detail: internal macro to create static category and add 919 // event if the category is enabled. 920 #define INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP(phase, \ 921 category_group, name, id, thread_id, timestamp, flags, ...) \ 922 do { \ 923 INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \ 924 if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \ 925 unsigned char trace_event_flags = flags | TRACE_EVENT_FLAG_HAS_ID; \ 926 trace_event_internal::TraceID trace_event_trace_id( \ 927 id, &trace_event_flags); \ 928 trace_event_internal::AddTraceEventWithThreadIdAndTimestamp( \ 929 phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), \ 930 name, trace_event_trace_id.data(), \ 931 thread_id, base::TimeTicks::FromInternalValue(timestamp), \ 932 trace_event_flags, ##__VA_ARGS__); \ 933 } \ 934 } while (0) 935 936 // Notes regarding the following definitions: 937 // New values can be added and propagated to third party libraries, but existing 938 // definitions must never be changed, because third party libraries may use old 939 // definitions. 940 941 // Phase indicates the nature of an event entry. E.g. part of a begin/end pair. 942 #define TRACE_EVENT_PHASE_BEGIN ('B') 943 #define TRACE_EVENT_PHASE_END ('E') 944 #define TRACE_EVENT_PHASE_COMPLETE ('X') 945 #define TRACE_EVENT_PHASE_INSTANT ('i') 946 #define TRACE_EVENT_PHASE_ASYNC_BEGIN ('S') 947 #define TRACE_EVENT_PHASE_ASYNC_STEP_INTO ('T') 948 #define TRACE_EVENT_PHASE_ASYNC_STEP_PAST ('p') 949 #define TRACE_EVENT_PHASE_ASYNC_END ('F') 950 #define TRACE_EVENT_PHASE_FLOW_BEGIN ('s') 951 #define TRACE_EVENT_PHASE_FLOW_STEP ('t') 952 #define TRACE_EVENT_PHASE_FLOW_END ('f') 953 #define TRACE_EVENT_PHASE_METADATA ('M') 954 #define TRACE_EVENT_PHASE_COUNTER ('C') 955 #define TRACE_EVENT_PHASE_SAMPLE ('P') 956 #define TRACE_EVENT_PHASE_CREATE_OBJECT ('N') 957 #define TRACE_EVENT_PHASE_SNAPSHOT_OBJECT ('O') 958 #define TRACE_EVENT_PHASE_DELETE_OBJECT ('D') 959 960 // Flags for changing the behavior of TRACE_EVENT_API_ADD_TRACE_EVENT. 961 #define TRACE_EVENT_FLAG_NONE (static_cast<unsigned char>(0)) 962 #define TRACE_EVENT_FLAG_COPY (static_cast<unsigned char>(1 << 0)) 963 #define TRACE_EVENT_FLAG_HAS_ID (static_cast<unsigned char>(1 << 1)) 964 #define TRACE_EVENT_FLAG_MANGLE_ID (static_cast<unsigned char>(1 << 2)) 965 #define TRACE_EVENT_FLAG_SCOPE_OFFSET (static_cast<unsigned char>(1 << 3)) 966 967 #define TRACE_EVENT_FLAG_SCOPE_MASK (static_cast<unsigned char>( \ 968 TRACE_EVENT_FLAG_SCOPE_OFFSET | (TRACE_EVENT_FLAG_SCOPE_OFFSET << 1))) 969 970 // Type values for identifying types in the TraceValue union. 971 #define TRACE_VALUE_TYPE_BOOL (static_cast<unsigned char>(1)) 972 #define TRACE_VALUE_TYPE_UINT (static_cast<unsigned char>(2)) 973 #define TRACE_VALUE_TYPE_INT (static_cast<unsigned char>(3)) 974 #define TRACE_VALUE_TYPE_DOUBLE (static_cast<unsigned char>(4)) 975 #define TRACE_VALUE_TYPE_POINTER (static_cast<unsigned char>(5)) 976 #define TRACE_VALUE_TYPE_STRING (static_cast<unsigned char>(6)) 977 #define TRACE_VALUE_TYPE_COPY_STRING (static_cast<unsigned char>(7)) 978 #define TRACE_VALUE_TYPE_CONVERTABLE (static_cast<unsigned char>(8)) 979 980 // Enum reflecting the scope of an INSTANT event. Must fit within 981 // TRACE_EVENT_FLAG_SCOPE_MASK. 982 #define TRACE_EVENT_SCOPE_GLOBAL (static_cast<unsigned char>(0 << 3)) 983 #define TRACE_EVENT_SCOPE_PROCESS (static_cast<unsigned char>(1 << 3)) 984 #define TRACE_EVENT_SCOPE_THREAD (static_cast<unsigned char>(2 << 3)) 985 986 #define TRACE_EVENT_SCOPE_NAME_GLOBAL ('g') 987 #define TRACE_EVENT_SCOPE_NAME_PROCESS ('p') 988 #define TRACE_EVENT_SCOPE_NAME_THREAD ('t') 989 990 namespace trace_event_internal { 991 992 // Specify these values when the corresponding argument of AddTraceEvent is not 993 // used. 994 const int kZeroNumArgs = 0; 995 const unsigned long long kNoEventId = 0; 996 997 // TraceID encapsulates an ID that can either be an integer or pointer. Pointers 998 // are by default mangled with the Process ID so that they are unlikely to 999 // collide when the same pointer is used on different processes. 1000 class TraceID { 1001 public: 1002 class DontMangle { 1003 public: 1004 explicit DontMangle(const void* id) 1005 : data_(static_cast<unsigned long long>( 1006 reinterpret_cast<unsigned long>(id))) {} 1007 explicit DontMangle(unsigned long long id) : data_(id) {} 1008 explicit DontMangle(unsigned long id) : data_(id) {} 1009 explicit DontMangle(unsigned int id) : data_(id) {} 1010 explicit DontMangle(unsigned short id) : data_(id) {} 1011 explicit DontMangle(unsigned char id) : data_(id) {} 1012 explicit DontMangle(long long id) 1013 : data_(static_cast<unsigned long long>(id)) {} 1014 explicit DontMangle(long id) 1015 : data_(static_cast<unsigned long long>(id)) {} 1016 explicit DontMangle(int id) 1017 : data_(static_cast<unsigned long long>(id)) {} 1018 explicit DontMangle(short id) 1019 : data_(static_cast<unsigned long long>(id)) {} 1020 explicit DontMangle(signed char id) 1021 : data_(static_cast<unsigned long long>(id)) {} 1022 unsigned long long data() const { return data_; } 1023 private: 1024 unsigned long long data_; 1025 }; 1026 1027 class ForceMangle { 1028 public: 1029 explicit ForceMangle(unsigned long long id) : data_(id) {} 1030 explicit ForceMangle(unsigned long id) : data_(id) {} 1031 explicit ForceMangle(unsigned int id) : data_(id) {} 1032 explicit ForceMangle(unsigned short id) : data_(id) {} 1033 explicit ForceMangle(unsigned char id) : data_(id) {} 1034 explicit ForceMangle(long long id) 1035 : data_(static_cast<unsigned long long>(id)) {} 1036 explicit ForceMangle(long id) 1037 : data_(static_cast<unsigned long long>(id)) {} 1038 explicit ForceMangle(int id) 1039 : data_(static_cast<unsigned long long>(id)) {} 1040 explicit ForceMangle(short id) 1041 : data_(static_cast<unsigned long long>(id)) {} 1042 explicit ForceMangle(signed char id) 1043 : data_(static_cast<unsigned long long>(id)) {} 1044 unsigned long long data() const { return data_; } 1045 private: 1046 unsigned long long data_; 1047 }; 1048 1049 TraceID(const void* id, unsigned char* flags) 1050 : data_(static_cast<unsigned long long>( 1051 reinterpret_cast<unsigned long>(id))) { 1052 *flags |= TRACE_EVENT_FLAG_MANGLE_ID; 1053 } 1054 TraceID(ForceMangle id, unsigned char* flags) : data_(id.data()) { 1055 *flags |= TRACE_EVENT_FLAG_MANGLE_ID; 1056 } 1057 TraceID(DontMangle id, unsigned char* flags) : data_(id.data()) { 1058 } 1059 TraceID(unsigned long long id, unsigned char* flags) 1060 : data_(id) { (void)flags; } 1061 TraceID(unsigned long id, unsigned char* flags) 1062 : data_(id) { (void)flags; } 1063 TraceID(unsigned int id, unsigned char* flags) 1064 : data_(id) { (void)flags; } 1065 TraceID(unsigned short id, unsigned char* flags) 1066 : data_(id) { (void)flags; } 1067 TraceID(unsigned char id, unsigned char* flags) 1068 : data_(id) { (void)flags; } 1069 TraceID(long long id, unsigned char* flags) 1070 : data_(static_cast<unsigned long long>(id)) { (void)flags; } 1071 TraceID(long id, unsigned char* flags) 1072 : data_(static_cast<unsigned long long>(id)) { (void)flags; } 1073 TraceID(int id, unsigned char* flags) 1074 : data_(static_cast<unsigned long long>(id)) { (void)flags; } 1075 TraceID(short id, unsigned char* flags) 1076 : data_(static_cast<unsigned long long>(id)) { (void)flags; } 1077 TraceID(signed char id, unsigned char* flags) 1078 : data_(static_cast<unsigned long long>(id)) { (void)flags; } 1079 1080 unsigned long long data() const { return data_; } 1081 1082 private: 1083 unsigned long long data_; 1084 }; 1085 1086 // Simple union to store various types as unsigned long long. 1087 union TraceValueUnion { 1088 bool as_bool; 1089 unsigned long long as_uint; 1090 long long as_int; 1091 double as_double; 1092 const void* as_pointer; 1093 const char* as_string; 1094 }; 1095 1096 // Simple container for const char* that should be copied instead of retained. 1097 class TraceStringWithCopy { 1098 public: 1099 explicit TraceStringWithCopy(const char* str) : str_(str) {} 1100 const char* str() const { return str_; } 1101 private: 1102 const char* str_; 1103 }; 1104 1105 // Define SetTraceValue for each allowed type. It stores the type and 1106 // value in the return arguments. This allows this API to avoid declaring any 1107 // structures so that it is portable to third_party libraries. 1108 #define INTERNAL_DECLARE_SET_TRACE_VALUE(actual_type, \ 1109 arg_expression, \ 1110 union_member, \ 1111 value_type_id) \ 1112 static inline void SetTraceValue( \ 1113 actual_type arg, \ 1114 unsigned char* type, \ 1115 unsigned long long* value) { \ 1116 TraceValueUnion type_value; \ 1117 type_value.union_member = arg_expression; \ 1118 *type = value_type_id; \ 1119 *value = type_value.as_uint; \ 1120 } 1121 // Simpler form for int types that can be safely casted. 1122 #define INTERNAL_DECLARE_SET_TRACE_VALUE_INT(actual_type, \ 1123 value_type_id) \ 1124 static inline void SetTraceValue( \ 1125 actual_type arg, \ 1126 unsigned char* type, \ 1127 unsigned long long* value) { \ 1128 *type = value_type_id; \ 1129 *value = static_cast<unsigned long long>(arg); \ 1130 } 1131 1132 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned long long, TRACE_VALUE_TYPE_UINT) 1133 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned long, TRACE_VALUE_TYPE_UINT) 1134 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned int, TRACE_VALUE_TYPE_UINT) 1135 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned short, TRACE_VALUE_TYPE_UINT) 1136 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned char, TRACE_VALUE_TYPE_UINT) 1137 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(long long, TRACE_VALUE_TYPE_INT) 1138 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(long, TRACE_VALUE_TYPE_INT) 1139 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(int, TRACE_VALUE_TYPE_INT) 1140 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(short, TRACE_VALUE_TYPE_INT) 1141 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(signed char, TRACE_VALUE_TYPE_INT) 1142 INTERNAL_DECLARE_SET_TRACE_VALUE(bool, arg, as_bool, TRACE_VALUE_TYPE_BOOL) 1143 INTERNAL_DECLARE_SET_TRACE_VALUE(double, arg, as_double, 1144 TRACE_VALUE_TYPE_DOUBLE) 1145 INTERNAL_DECLARE_SET_TRACE_VALUE(const void*, arg, as_pointer, 1146 TRACE_VALUE_TYPE_POINTER) 1147 INTERNAL_DECLARE_SET_TRACE_VALUE(const char*, arg, as_string, 1148 TRACE_VALUE_TYPE_STRING) 1149 INTERNAL_DECLARE_SET_TRACE_VALUE(const TraceStringWithCopy&, arg.str(), 1150 as_string, TRACE_VALUE_TYPE_COPY_STRING) 1151 1152 #undef INTERNAL_DECLARE_SET_TRACE_VALUE 1153 #undef INTERNAL_DECLARE_SET_TRACE_VALUE_INT 1154 1155 // std::string version of SetTraceValue so that trace arguments can be strings. 1156 static inline void SetTraceValue(const std::string& arg, 1157 unsigned char* type, 1158 unsigned long long* value) { 1159 TraceValueUnion type_value; 1160 type_value.as_string = arg.c_str(); 1161 *type = TRACE_VALUE_TYPE_COPY_STRING; 1162 *value = type_value.as_uint; 1163 } 1164 1165 // base::Time and base::TimeTicks version of SetTraceValue to make it easier to 1166 // trace these types. 1167 static inline void SetTraceValue(const base::Time arg, 1168 unsigned char* type, 1169 unsigned long long* value) { 1170 *type = TRACE_VALUE_TYPE_INT; 1171 *value = arg.ToInternalValue(); 1172 } 1173 1174 static inline void SetTraceValue(const base::TimeTicks arg, 1175 unsigned char* type, 1176 unsigned long long* value) { 1177 *type = TRACE_VALUE_TYPE_INT; 1178 *value = arg.ToInternalValue(); 1179 } 1180 1181 // These AddTraceEvent and AddTraceEventWithThreadIdAndTimestamp template 1182 // functions are defined here instead of in the macro, because the arg_values 1183 // could be temporary objects, such as std::string. In order to store 1184 // pointers to the internal c_str and pass through to the tracing API, 1185 // the arg_values must live throughout these procedures. 1186 1187 static inline base::debug::TraceEventHandle 1188 AddTraceEventWithThreadIdAndTimestamp( 1189 char phase, 1190 const unsigned char* category_group_enabled, 1191 const char* name, 1192 unsigned long long id, 1193 int thread_id, 1194 const base::TimeTicks& timestamp, 1195 unsigned char flags, 1196 const char* arg1_name, 1197 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg1_val) { 1198 const int num_args = 1; 1199 unsigned char arg_types[1] = { TRACE_VALUE_TYPE_CONVERTABLE }; 1200 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( 1201 phase, category_group_enabled, name, id, thread_id, timestamp, 1202 num_args, &arg1_name, arg_types, NULL, &arg1_val, flags); 1203 } 1204 1205 template<class ARG1_TYPE> 1206 static inline base::debug::TraceEventHandle 1207 AddTraceEventWithThreadIdAndTimestamp( 1208 char phase, 1209 const unsigned char* category_group_enabled, 1210 const char* name, 1211 unsigned long long id, 1212 int thread_id, 1213 const base::TimeTicks& timestamp, 1214 unsigned char flags, 1215 const char* arg1_name, 1216 const ARG1_TYPE& arg1_val, 1217 const char* arg2_name, 1218 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg2_val) { 1219 const int num_args = 2; 1220 const char* arg_names[2] = { arg1_name, arg2_name }; 1221 1222 unsigned char arg_types[2]; 1223 unsigned long long arg_values[2]; 1224 SetTraceValue(arg1_val, &arg_types[0], &arg_values[0]); 1225 arg_types[1] = TRACE_VALUE_TYPE_CONVERTABLE; 1226 1227 scoped_refptr<base::debug::ConvertableToTraceFormat> convertable_values[2]; 1228 convertable_values[1] = arg2_val; 1229 1230 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( 1231 phase, category_group_enabled, name, id, thread_id, timestamp, 1232 num_args, arg_names, arg_types, arg_values, convertable_values, flags); 1233 } 1234 1235 template<class ARG2_TYPE> 1236 static inline base::debug::TraceEventHandle 1237 AddTraceEventWithThreadIdAndTimestamp( 1238 char phase, 1239 const unsigned char* category_group_enabled, 1240 const char* name, 1241 unsigned long long id, 1242 int thread_id, 1243 const base::TimeTicks& timestamp, 1244 unsigned char flags, 1245 const char* arg1_name, 1246 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg1_val, 1247 const char* arg2_name, 1248 const ARG2_TYPE& arg2_val) { 1249 const int num_args = 2; 1250 const char* arg_names[2] = { arg1_name, arg2_name }; 1251 1252 unsigned char arg_types[2]; 1253 unsigned long long arg_values[2]; 1254 arg_types[0] = TRACE_VALUE_TYPE_CONVERTABLE; 1255 arg_values[0] = 0; 1256 SetTraceValue(arg2_val, &arg_types[1], &arg_values[1]); 1257 1258 scoped_refptr<base::debug::ConvertableToTraceFormat> convertable_values[2]; 1259 convertable_values[0] = arg1_val; 1260 1261 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( 1262 phase, category_group_enabled, name, id, thread_id, timestamp, 1263 num_args, arg_names, arg_types, arg_values, convertable_values, flags); 1264 } 1265 1266 static inline base::debug::TraceEventHandle 1267 AddTraceEventWithThreadIdAndTimestamp( 1268 char phase, 1269 const unsigned char* category_group_enabled, 1270 const char* name, 1271 unsigned long long id, 1272 int thread_id, 1273 const base::TimeTicks& timestamp, 1274 unsigned char flags, 1275 const char* arg1_name, 1276 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg1_val, 1277 const char* arg2_name, 1278 const scoped_refptr<base::debug::ConvertableToTraceFormat>& arg2_val) { 1279 const int num_args = 2; 1280 const char* arg_names[2] = { arg1_name, arg2_name }; 1281 unsigned char arg_types[2] = 1282 { TRACE_VALUE_TYPE_CONVERTABLE, TRACE_VALUE_TYPE_CONVERTABLE }; 1283 scoped_refptr<base::debug::ConvertableToTraceFormat> convertable_values[2] = 1284 { arg1_val, arg2_val }; 1285 1286 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( 1287 phase, category_group_enabled, name, id, thread_id, timestamp, 1288 num_args, arg_names, arg_types, NULL, convertable_values, flags); 1289 } 1290 1291 static inline base::debug::TraceEventHandle 1292 AddTraceEventWithThreadIdAndTimestamp( 1293 char phase, 1294 const unsigned char* category_group_enabled, 1295 const char* name, 1296 unsigned long long id, 1297 int thread_id, 1298 const base::TimeTicks& timestamp, 1299 unsigned char flags) { 1300 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( 1301 phase, category_group_enabled, name, id, thread_id, timestamp, 1302 kZeroNumArgs, NULL, NULL, NULL, NULL, flags); 1303 } 1304 1305 static inline base::debug::TraceEventHandle AddTraceEvent( 1306 char phase, 1307 const unsigned char* category_group_enabled, 1308 const char* name, 1309 unsigned long long id, 1310 unsigned char flags) { 1311 int thread_id = static_cast<int>(base::PlatformThread::CurrentId()); 1312 base::TimeTicks now = base::TimeTicks::NowFromSystemTraceTime(); 1313 return AddTraceEventWithThreadIdAndTimestamp(phase, category_group_enabled, 1314 name, id, thread_id, now, flags); 1315 } 1316 1317 template<class ARG1_TYPE> 1318 static inline base::debug::TraceEventHandle 1319 AddTraceEventWithThreadIdAndTimestamp( 1320 char phase, 1321 const unsigned char* category_group_enabled, 1322 const char* name, 1323 unsigned long long id, 1324 int thread_id, 1325 const base::TimeTicks& timestamp, 1326 unsigned char flags, 1327 const char* arg1_name, 1328 const ARG1_TYPE& arg1_val) { 1329 const int num_args = 1; 1330 unsigned char arg_types[1]; 1331 unsigned long long arg_values[1]; 1332 SetTraceValue(arg1_val, &arg_types[0], &arg_values[0]); 1333 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( 1334 phase, category_group_enabled, name, id, thread_id, timestamp, 1335 num_args, &arg1_name, arg_types, arg_values, NULL, flags); 1336 } 1337 1338 template<class ARG1_TYPE> 1339 static inline base::debug::TraceEventHandle AddTraceEvent( 1340 char phase, 1341 const unsigned char* category_group_enabled, 1342 const char* name, 1343 unsigned long long id, 1344 unsigned char flags, 1345 const char* arg1_name, 1346 const ARG1_TYPE& arg1_val) { 1347 int thread_id = static_cast<int>(base::PlatformThread::CurrentId()); 1348 base::TimeTicks now = base::TimeTicks::NowFromSystemTraceTime(); 1349 return AddTraceEventWithThreadIdAndTimestamp(phase, category_group_enabled, 1350 name, id, thread_id, now, flags, 1351 arg1_name, arg1_val); 1352 } 1353 1354 template<class ARG1_TYPE, class ARG2_TYPE> 1355 static inline base::debug::TraceEventHandle 1356 AddTraceEventWithThreadIdAndTimestamp( 1357 char phase, 1358 const unsigned char* category_group_enabled, 1359 const char* name, 1360 unsigned long long id, 1361 int thread_id, 1362 const base::TimeTicks& timestamp, 1363 unsigned char flags, 1364 const char* arg1_name, 1365 const ARG1_TYPE& arg1_val, 1366 const char* arg2_name, 1367 const ARG2_TYPE& arg2_val) { 1368 const int num_args = 2; 1369 const char* arg_names[2] = { arg1_name, arg2_name }; 1370 unsigned char arg_types[2]; 1371 unsigned long long arg_values[2]; 1372 SetTraceValue(arg1_val, &arg_types[0], &arg_values[0]); 1373 SetTraceValue(arg2_val, &arg_types[1], &arg_values[1]); 1374 return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_THREAD_ID_AND_TIMESTAMP( 1375 phase, category_group_enabled, name, id, thread_id, timestamp, 1376 num_args, arg_names, arg_types, arg_values, NULL, flags); 1377 } 1378 1379 template<class ARG1_TYPE, class ARG2_TYPE> 1380 static inline base::debug::TraceEventHandle AddTraceEvent( 1381 char phase, 1382 const unsigned char* category_group_enabled, 1383 const char* name, 1384 unsigned long long id, 1385 unsigned char flags, 1386 const char* arg1_name, 1387 const ARG1_TYPE& arg1_val, 1388 const char* arg2_name, 1389 const ARG2_TYPE& arg2_val) { 1390 int thread_id = static_cast<int>(base::PlatformThread::CurrentId()); 1391 base::TimeTicks now = base::TimeTicks::NowFromSystemTraceTime(); 1392 return AddTraceEventWithThreadIdAndTimestamp(phase, category_group_enabled, 1393 name, id, thread_id, now, flags, 1394 arg1_name, arg1_val, 1395 arg2_name, arg2_val); 1396 } 1397 1398 // Used by TRACE_EVENTx macros. Do not use directly. 1399 class TRACE_EVENT_API_CLASS_EXPORT ScopedTracer { 1400 public: 1401 // Note: members of data_ intentionally left uninitialized. See Initialize. 1402 ScopedTracer() : p_data_(NULL) {} 1403 1404 ~ScopedTracer() { 1405 if (p_data_ && *data_.category_group_enabled) 1406 TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION( 1407 data_.category_group_enabled, data_.name, data_.event_handle); 1408 } 1409 1410 void Initialize(const unsigned char* category_group_enabled, 1411 const char* name, 1412 base::debug::TraceEventHandle event_handle) { 1413 data_.category_group_enabled = category_group_enabled; 1414 data_.name = name; 1415 data_.event_handle = event_handle; 1416 p_data_ = &data_; 1417 } 1418 1419 private: 1420 // This Data struct workaround is to avoid initializing all the members 1421 // in Data during construction of this object, since this object is always 1422 // constructed, even when tracing is disabled. If the members of Data were 1423 // members of this class instead, compiler warnings occur about potential 1424 // uninitialized accesses. 1425 struct Data { 1426 const unsigned char* category_group_enabled; 1427 const char* name; 1428 base::debug::TraceEventHandle event_handle; 1429 }; 1430 Data* p_data_; 1431 Data data_; 1432 }; 1433 1434 // Used by TRACE_EVENT_BINARY_EFFICIENTx macro. Do not use directly. 1435 class TRACE_EVENT_API_CLASS_EXPORT ScopedTraceBinaryEfficient { 1436 public: 1437 ScopedTraceBinaryEfficient(const char* category_group, const char* name); 1438 ~ScopedTraceBinaryEfficient(); 1439 1440 private: 1441 const unsigned char* category_group_enabled_; 1442 const char* name_; 1443 base::debug::TraceEventHandle event_handle_; 1444 }; 1445 1446 // This macro generates less code then TRACE_EVENT0 but is also 1447 // slower to execute when tracing is off. It should generally only be 1448 // used with code that is seldom executed or conditionally executed 1449 // when debugging. 1450 // For now the category_group must be "gpu". 1451 #define TRACE_EVENT_BINARY_EFFICIENT0(category_group, name) \ 1452 trace_event_internal::ScopedTraceBinaryEfficient \ 1453 INTERNAL_TRACE_EVENT_UID(scoped_trace)(category_group, name); 1454 1455 // TraceEventSamplingStateScope records the current sampling state 1456 // and sets a new sampling state. When the scope exists, it restores 1457 // the sampling state having recorded. 1458 template<size_t BucketNumber> 1459 class TraceEventSamplingStateScope { 1460 public: 1461 TraceEventSamplingStateScope(const char* category_and_name) { 1462 previous_state_ = TraceEventSamplingStateScope<BucketNumber>::Current(); 1463 TraceEventSamplingStateScope<BucketNumber>::Set(category_and_name); 1464 } 1465 1466 ~TraceEventSamplingStateScope() { 1467 TraceEventSamplingStateScope<BucketNumber>::Set(previous_state_); 1468 } 1469 1470 static inline const char* Current() { 1471 return reinterpret_cast<const char*>(TRACE_EVENT_API_ATOMIC_LOAD( 1472 g_trace_state[BucketNumber])); 1473 } 1474 1475 static inline void Set(const char* category_and_name) { 1476 TRACE_EVENT_API_ATOMIC_STORE( 1477 g_trace_state[BucketNumber], 1478 reinterpret_cast<TRACE_EVENT_API_ATOMIC_WORD>( 1479 const_cast<char*>(category_and_name))); 1480 } 1481 1482 private: 1483 const char* previous_state_; 1484 }; 1485 1486 } // namespace trace_event_internal 1487 1488 namespace base { 1489 namespace debug { 1490 1491 template<typename IDType> class TraceScopedTrackableObject { 1492 public: 1493 TraceScopedTrackableObject(const char* category_group, const char* name, 1494 IDType id) 1495 : category_group_(category_group), 1496 name_(name), 1497 id_(id) { 1498 TRACE_EVENT_OBJECT_CREATED_WITH_ID(category_group_, name_, id_); 1499 } 1500 1501 template <typename ArgType> void snapshot(ArgType snapshot) { 1502 TRACE_EVENT_OBJECT_SNAPSHOT_WITH_ID(category_group_, name_, id_, snapshot); 1503 } 1504 1505 ~TraceScopedTrackableObject() { 1506 TRACE_EVENT_OBJECT_DELETED_WITH_ID(category_group_, name_, id_); 1507 } 1508 1509 private: 1510 const char* category_group_; 1511 const char* name_; 1512 IDType id_; 1513 1514 DISALLOW_COPY_AND_ASSIGN(TraceScopedTrackableObject); 1515 }; 1516 1517 } // namespace debug 1518 } // namespace base 1519 1520 #endif /* BASE_DEBUG_TRACE_EVENT_H_ */ 1521