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