src/third_party/WebKit/Source/platform/TraceEvent.h

   1 /*
   2  * Copyright (C) 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 // Trace events are for tracking application performance and resource usage.
  27 // Macros are provided to track:
  28 //    Begin and end of function calls
  29 //    Counters
  30 //
  31 // Events are issued against categories. Whereas LOG's
  32 // categories are statically defined, TRACE categories are created
  33 // implicitly with a string. For example:
  34 //   TRACE_EVENT_INSTANT0("MY_SUBSYSTEM", "SomeImportantEvent")
  35 //
  36 // Events can be INSTANT, or can be pairs of BEGIN and END in the same scope:
  37 //   TRACE_EVENT_BEGIN0("MY_SUBSYSTEM", "SomethingCostly")
  38 //   doSomethingCostly()
  39 //   TRACE_EVENT_END0("MY_SUBSYSTEM", "SomethingCostly")
  40 // Note: our tools can't always determine the correct BEGIN/END pairs unless
  41 // these are used in the same scope. Use ASYNC_BEGIN/ASYNC_END macros if you need them
  42 // to be in separate scopes.
  43 //
  44 // A common use case is to trace entire function scopes. This
  45 // issues a trace BEGIN and END automatically:
  46 //   void doSomethingCostly() {
  47 //     TRACE_EVENT0("MY_SUBSYSTEM", "doSomethingCostly");
  48 //     ...
  49 //   }
  50 //
  51 // Additional parameters can be associated with an event:
  52 //   void doSomethingCostly2(int howMuch) {
  53 //     TRACE_EVENT1("MY_SUBSYSTEM", "doSomethingCostly",
  54 //         "howMuch", howMuch);
  55 //     ...
  56 //   }
  57 //
  58 // The trace system will automatically add to this information the
  59 // current process id, thread id, and a timestamp in microseconds.
  60 //
  61 // To trace an asynchronous procedure such as an IPC send/receive, use ASYNC_BEGIN and
  62 // ASYNC_END:
  63 //   [single threaded sender code]
  64 //     static int send_count = 0;
  65 //     ++send_count;
  66 //     TRACE_EVENT_ASYNC_BEGIN0("ipc", "message", send_count);
  67 //     Send(new MyMessage(send_count));
  68 //   [receive code]
  69 //     void OnMyMessage(send_count) {
  70 //       TRACE_EVENT_ASYNC_END0("ipc", "message", send_count);
  71 //     }
  72 // The third parameter is a unique ID to match ASYNC_BEGIN/ASYNC_END pairs.
  73 // ASYNC_BEGIN and ASYNC_END can occur on any thread of any traced process. Pointers can
  74 // be used for the ID parameter, and they will be mangled internally so that
  75 // the same pointer on two different processes will not match. For example:
  76 //   class MyTracedClass {
  77 //    public:
  78 //     MyTracedClass() {
  79 //       TRACE_EVENT_ASYNC_BEGIN0("category", "MyTracedClass", this);
  80 //     }
  81 //     ~MyTracedClass() {
  82 //       TRACE_EVENT_ASYNC_END0("category", "MyTracedClass", this);
  83 //     }
  84 //   }
  85 //
  86 // Trace event also supports counters, which is a way to track a quantity
  87 // as it varies over time. Counters are created with the following macro:
  88 //   TRACE_COUNTER1("MY_SUBSYSTEM", "myCounter", g_myCounterValue);
  89 //
  90 // Counters are process-specific. The macro itself can be issued from any
  91 // thread, however.
  92 //
  93 // Sometimes, you want to track two counters at once. You can do this with two
  94 // counter macros:
  95 //   TRACE_COUNTER1("MY_SUBSYSTEM", "myCounter0", g_myCounterValue[0]);
  96 //   TRACE_COUNTER1("MY_SUBSYSTEM", "myCounter1", g_myCounterValue[1]);
  97 // Or you can do it with a combined macro:
  98 //   TRACE_COUNTER2("MY_SUBSYSTEM", "myCounter",
  99 //       "bytesPinned", g_myCounterValue[0],
 100 //       "bytesAllocated", g_myCounterValue[1]);
 101 // This indicates to the tracing UI that these counters should be displayed
 102 // in a single graph, as a summed area chart.
 103 //
 104 // Since counters are in a global namespace, you may want to disembiguate with a
 105 // unique ID, by using the TRACE_COUNTER_ID* variations.
 106 //
 107 // By default, trace collection is compiled in, but turned off at runtime.
 108 // Collecting trace data is the responsibility of the embedding
 109 // application. In Chrome's case, navigating to about:tracing will turn on
 110 // tracing and display data collected across all active processes.
 111 //
 112 //
 113 // Memory scoping note:
 114 // Tracing copies the pointers, not the string content, of the strings passed
 115 // in for category, name, and arg_names. Thus, the following code will
 116 // cause problems:
 117 //     char* str = strdup("impprtantName");
 118 //     TRACE_EVENT_INSTANT0("SUBSYSTEM", str);  // BAD!
 119 //     free(str);                   // Trace system now has dangling pointer
 120 //
 121 // To avoid this issue with the |name| and |arg_name| parameters, use the
 122 // TRACE_EVENT_COPY_XXX overloads of the macros at additional runtime overhead.
 123 // Notes: The category must always be in a long-lived char* (i.e. static const).
 124 //        The |arg_values|, when used, are always deep copied with the _COPY
 125 //        macros.
 126 //
 127 // When are string argument values copied:
 128 // const char* arg_values are only referenced by default:
 129 //     TRACE_EVENT1("category", "name",
 130 //                  "arg1", "literal string is only referenced");
 131 // Use TRACE_STR_COPY to force copying of a const char*:
 132 //     TRACE_EVENT1("category", "name",
 133 //                  "arg1", TRACE_STR_COPY("string will be copied"));
 134 // std::string arg_values are always copied:
 135 //     TRACE_EVENT1("category", "name",
 136 //                  "arg1", std::string("string will be copied"));
 137 //
 138 //
 139 // Thread Safety:
 140 // A thread safe singleton and mutex are used for thread safety. Category
 141 // enabled flags are used to limit the performance impact when the system
 142 // is not enabled.
 143 //
 144 // TRACE_EVENT macros first cache a pointer to a category. The categories are
 145 // statically allocated and safe at all times, even after exit. Fetching a
 146 // category is protected by the TraceLog::lock_. Multiple threads initializing
 147 // the static variable is safe, as they will be serialized by the lock and
 148 // multiple calls will return the same pointer to the category.
 149 //
 150 // Then the category_enabled flag is checked. This is a unsigned char, and
 151 // not intended to be multithread safe. It optimizes access to addTraceEvent
 152 // which is threadsafe internally via TraceLog::lock_. The enabled flag may
 153 // cause some threads to incorrectly call or skip calling addTraceEvent near
 154 // the time of the system being enabled or disabled. This is acceptable as
 155 // we tolerate some data loss while the system is being enabled/disabled and
 156 // because addTraceEvent is threadsafe internally and checks the enabled state
 157 // again under lock.
 158 //
 159 // Without the use of these static category pointers and enabled flags all
 160 // trace points would carry a significant performance cost of aquiring a lock
 161 // and resolving the category.
 162
 163 #ifndef TraceEvent_h
 164 #define TraceEvent_h
 165
 166 #include "platform/EventTracer.h"
 167
 168 #include "wtf/DynamicAnnotations.h"
 169 #include "wtf/PassRefPtr.h"
 170 #include "wtf/text/CString.h"
 171
 172 // By default, const char* argument values are assumed to have long-lived scope
 173 // and will not be copied. Use this macro to force a const char* to be copied.
 174 #define TRACE_STR_COPY(str) \
 175     WebCore::TraceEvent::TraceStringWithCopy(str)
 176
 177 // By default, uint64 ID argument values are not mangled with the Process ID in
 178 // TRACE_EVENT_ASYNC macros. Use this macro to force Process ID mangling.
 179 #define TRACE_ID_MANGLE(id) \
 180     WebCore::TraceEvent::TraceID::ForceMangle(id)
 181
 182 // By default, pointers are mangled with the Process ID in TRACE_EVENT_ASYNC
 183 // macros. Use this macro to prevent Process ID mangling.
 184 #define TRACE_ID_DONT_MANGLE(id) \
 185     WebCore::TraceEvent::TraceID::DontMangle(id)
 186
 187 // Records a pair of begin and end events called "name" for the current
 188 // scope, with 0, 1 or 2 associated arguments. If the category is not
 189 // enabled, then this does nothing.
 190 // - category and name strings must have application lifetime (statics or
 191 //   literals). They may not include " chars.
 192 #define TRACE_EVENT0(category, name) \
 193     INTERNAL_TRACE_EVENT_ADD_SCOPED(category, name)
 194 #define TRACE_EVENT1(category, name, arg1_name, arg1_val) \
 195     INTERNAL_TRACE_EVENT_ADD_SCOPED(category, name, arg1_name, arg1_val)
 196 #define TRACE_EVENT2(category, name, arg1_name, arg1_val, arg2_name, arg2_val) \
 197     INTERNAL_TRACE_EVENT_ADD_SCOPED(category, name, arg1_name, arg1_val, \
 198         arg2_name, arg2_val)
 199
 200 // Records a single event called "name" immediately, with 0, 1 or 2
 201 // associated arguments. If the category is not enabled, then this
 202 // does nothing.
 203 // - category and name strings must have application lifetime (statics or
 204 //   literals). They may not include " chars.
 205 #define TRACE_EVENT_INSTANT0(category, name) \
 206     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
 207         category, name, TRACE_EVENT_FLAG_NONE)
 208 #define TRACE_EVENT_INSTANT1(category, name, arg1_name, arg1_val) \
 209     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
 210         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
 211 #define TRACE_EVENT_INSTANT2(category, name, arg1_name, arg1_val, \
 212         arg2_name, arg2_val) \
 213     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
 214         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \
 215         arg2_name, arg2_val)
 216 #define TRACE_EVENT_COPY_INSTANT0(category, name) \
 217     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
 218         category, name, TRACE_EVENT_FLAG_COPY)
 219 #define TRACE_EVENT_COPY_INSTANT1(category, name, arg1_name, arg1_val) \
 220     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
 221         category, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val)
 222 #define TRACE_EVENT_COPY_INSTANT2(category, name, arg1_name, arg1_val, \
 223         arg2_name, arg2_val) \
 224     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
 225         category, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val, \
 226         arg2_name, arg2_val)
 227
 228 // Records a single BEGIN event called "name" immediately, with 0, 1 or 2
 229 // associated arguments. If the category is not enabled, then this
 230 // does nothing.
 231 // - category and name strings must have application lifetime (statics or
 232 //   literals). They may not include " chars.
 233 #define TRACE_EVENT_BEGIN0(category, name) \
 234     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
 235         category, name, TRACE_EVENT_FLAG_NONE)
 236 #define TRACE_EVENT_BEGIN1(category, name, arg1_name, arg1_val) \
 237     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
 238         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
 239 #define TRACE_EVENT_BEGIN2(category, name, arg1_name, arg1_val, \
 240         arg2_name, arg2_val) \
 241     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
 242         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \
 243         arg2_name, arg2_val)
 244 #define TRACE_EVENT_COPY_BEGIN0(category, name) \
 245     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
 246         category, name, TRACE_EVENT_FLAG_COPY)
 247 #define TRACE_EVENT_COPY_BEGIN1(category, name, arg1_name, arg1_val) \
 248     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
 249         category, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val)
 250 #define TRACE_EVENT_COPY_BEGIN2(category, name, arg1_name, arg1_val, \
 251         arg2_name, arg2_val) \
 252     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
 253         category, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val, \
 254         arg2_name, arg2_val)
 255
 256 // Records a single END event for "name" immediately. If the category
 257 // is not enabled, then this does nothing.
 258 // - category and name strings must have application lifetime (statics or
 259 //   literals). They may not include " chars.
 260 #define TRACE_EVENT_END0(category, name) \
 261     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
 262         category, name, TRACE_EVENT_FLAG_NONE)
 263 #define TRACE_EVENT_END1(category, name, arg1_name, arg1_val) \
 264     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
 265         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
 266 #define TRACE_EVENT_END2(category, name, arg1_name, arg1_val, \
 267         arg2_name, arg2_val) \
 268     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
 269         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \
 270         arg2_name, arg2_val)
 271 #define TRACE_EVENT_COPY_END0(category, name) \
 272     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
 273         category, name, TRACE_EVENT_FLAG_COPY)
 274 #define TRACE_EVENT_COPY_END1(category, name, arg1_name, arg1_val) \
 275     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
 276         category, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val)
 277 #define TRACE_EVENT_COPY_END2(category, name, arg1_name, arg1_val, \
 278         arg2_name, arg2_val) \
 279     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
 280         category, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val, \
 281         arg2_name, arg2_val)
 282
 283 // Records the value of a counter called "name" immediately. Value
 284 // must be representable as a 32 bit integer.
 285 // - category and name strings must have application lifetime (statics or
 286 //   literals). They may not include " chars.
 287 #define TRACE_COUNTER1(category, name, value) \
 288     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \
 289         category, name, TRACE_EVENT_FLAG_NONE, \
 290         "value", static_cast<int>(value))
 291 #define TRACE_COPY_COUNTER1(category, name, value) \
 292     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \
 293         category, name, TRACE_EVENT_FLAG_COPY, \
 294         "value", static_cast<int>(value))
 295
 296 // Records the values of a multi-parted counter called "name" immediately.
 297 // The UI will treat value1 and value2 as parts of a whole, displaying their
 298 // values as a stacked-bar chart.
 299 // - category and name strings must have application lifetime (statics or
 300 //   literals). They may not include " chars.
 301 #define TRACE_COUNTER2(category, name, value1_name, value1_val, \
 302         value2_name, value2_val) \
 303     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \
 304         category, name, TRACE_EVENT_FLAG_NONE, \
 305         value1_name, static_cast<int>(value1_val), \
 306         value2_name, static_cast<int>(value2_val))
 307 #define TRACE_COPY_COUNTER2(category, name, value1_name, value1_val, \
 308         value2_name, value2_val) \
 309     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \
 310         category, name, TRACE_EVENT_FLAG_COPY, \
 311         value1_name, static_cast<int>(value1_val), \
 312         value2_name, static_cast<int>(value2_val))
 313
 314 // Records the value of a counter called "name" immediately. Value
 315 // must be representable as a 32 bit integer.
 316 // - category and name strings must have application lifetime (statics or
 317 //   literals). They may not include " chars.
 318 // - |id| is used to disambiguate counters with the same name. It must either
 319 //   be a pointer or an integer value up to 64 bits. If it's a pointer, the bits
 320 //   will be xored with a hash of the process ID so that the same pointer on
 321 //   two different processes will not collide.
 322 #define TRACE_COUNTER_ID1(category, name, id, value) \
 323     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \
 324         category, name, id, TRACE_EVENT_FLAG_NONE, \
 325         "value", static_cast<int>(value))
 326 #define TRACE_COPY_COUNTER_ID1(category, name, id, value) \
 327     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \
 328         category, name, id, TRACE_EVENT_FLAG_COPY, \
 329         "value", static_cast<int>(value))
 330
 331 // Records the values of a multi-parted counter called "name" immediately.
 332 // The UI will treat value1 and value2 as parts of a whole, displaying their
 333 // values as a stacked-bar chart.
 334 // - category and name strings must have application lifetime (statics or
 335 //   literals). They may not include " chars.
 336 // - |id| is used to disambiguate counters with the same name. It must either
 337 //   be a pointer or an integer value up to 64 bits. If it's a pointer, the bits
 338 //   will be xored with a hash of the process ID so that the same pointer on
 339 //   two different processes will not collide.
 340 #define TRACE_COUNTER_ID2(category, name, id, value1_name, value1_val, \
 341         value2_name, value2_val) \
 342     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \
 343         category, name, id, TRACE_EVENT_FLAG_NONE, \
 344         value1_name, static_cast<int>(value1_val), \
 345         value2_name, static_cast<int>(value2_val))
 346 #define TRACE_COPY_COUNTER_ID2(category, name, id, value1_name, value1_val, \
 347         value2_name, value2_val) \
 348     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \
 349         category, name, id, TRACE_EVENT_FLAG_COPY, \
 350         value1_name, static_cast<int>(value1_val), \
 351         value2_name, static_cast<int>(value2_val))
 352
 353 // Records a single ASYNC_BEGIN event called "name" immediately, with 0, 1 or 2
 354 // associated arguments. If the category is not enabled, then this
 355 // does nothing.
 356 // - category and name strings must have application lifetime (statics or
 357 //   literals). They may not include " chars.
 358 // - |id| is used to match the ASYNC_BEGIN event with the ASYNC_END event. ASYNC
 359 //   events are considered to match if their category, name and id values all
 360 //   match. |id| must either be a pointer or an integer value up to 64 bits. If
 361 //   it's a pointer, the bits will be xored with a hash of the process ID so
 362 //   that the same pointer on two different processes will not collide.
 363 //
 364 // An asynchronous operation can consist of multiple phases. The first phase is
 365 // defined by the ASYNC_BEGIN calls. Additional phases can be defined using the
 366 // ASYNC_STEP_INTO or ASYNC_STEP_PAST macros. The ASYNC_STEP_INTO macro will
 367 // annotate the block following the call. The ASYNC_STEP_PAST macro will
 368 // annotate the block prior to the call. Note that any particular event must use
 369 // only STEP_INTO or STEP_PAST macros; they can not mix and match. When the
 370 // operation completes, call ASYNC_END.
 371 //
 372 // An ASYNC trace typically occurs on a single thread (if not, they will only be
 373 // drawn on the thread defined in the ASYNC_BEGIN event), but all events in that
 374 // operation must use the same |name| and |id|. Each step can have its own
 375 #define TRACE_EVENT_ASYNC_BEGIN0(category, name, id) \
 376     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
 377         category, name, id, TRACE_EVENT_FLAG_NONE)
 378 #define TRACE_EVENT_ASYNC_BEGIN1(category, name, id, arg1_name, arg1_val) \
 379     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
 380         category, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
 381 #define TRACE_EVENT_ASYNC_BEGIN2(category, name, id, arg1_name, arg1_val, \
 382         arg2_name, arg2_val) \
 383     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
 384         category, name, id, TRACE_EVENT_FLAG_NONE, \
 385         arg1_name, arg1_val, arg2_name, arg2_val)
 386 #define TRACE_EVENT_COPY_ASYNC_BEGIN0(category, name, id) \
 387     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
 388         category, name, id, TRACE_EVENT_FLAG_COPY)
 389 #define TRACE_EVENT_COPY_ASYNC_BEGIN1(category, name, id, arg1_name, arg1_val) \
 390     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
 391         category, name, id, TRACE_EVENT_FLAG_COPY, \
 392         arg1_name, arg1_val)
 393 #define TRACE_EVENT_COPY_ASYNC_BEGIN2(category, name, id, arg1_name, arg1_val, \
 394         arg2_name, arg2_val) \
 395     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
 396         category, name, id, TRACE_EVENT_FLAG_COPY, \
 397         arg1_name, arg1_val, arg2_name, arg2_val)
 398
 399 // Records a single ASYNC_STEP_INTO event for |step| immediately. If the
 400 // category is not enabled, then this does nothing. The |name| and |id| must
 401 // match the ASYNC_BEGIN event above. The |step| param identifies this step
 402 // within the async event. This should be called at the beginning of the next
 403 // phase of an asynchronous operation. The ASYNC_BEGIN event must not have any
 404 // ASYNC_STEP_PAST events.
 405 #define TRACE_EVENT_ASYNC_STEP_INTO0(category, name, id, step) \
 406     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_INTO, \
 407         category, name, id, TRACE_EVENT_FLAG_NONE, "step", step)
 408 #define TRACE_EVENT_ASYNC_STEP_INTO1(category, name, id, step, \
 409         arg1_name, arg1_val) \
 410     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_INTO, \
 411         category, name, id, TRACE_EVENT_FLAG_NONE, "step", step, \
 412         arg1_name, arg1_val)
 413
 414 // Records a single ASYNC_STEP_PAST event for |step| immediately. If the
 415 // category is not enabled, then this does nothing. The |name| and |id| must
 416 // match the ASYNC_BEGIN event above. The |step| param identifies this step
 417 // within the async event. This should be called at the beginning of the next
 418 // phase of an asynchronous operation. The ASYNC_BEGIN event must not have any
 419 // ASYNC_STEP_INTO events.
 420 #define TRACE_EVENT_ASYNC_STEP_PAST0(category_group, name, id, step) \
 421     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_PAST, \
 422         category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step)
 423 #define TRACE_EVENT_ASYNC_STEP_PAST1(category_group, name, id, step, arg1_name, arg1_val) \
 424     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP_PAST, \
 425         category_group, name, id, TRACE_EVENT_FLAG_NONE, "step", step, \
 426         arg1_name, arg1_val)
 427
 428 // Records a single ASYNC_END event for "name" immediately. If the category
 429 // is not enabled, then this does nothing.
 430 #define TRACE_EVENT_ASYNC_END0(category, name, id) \
 431     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
 432         category, name, id, TRACE_EVENT_FLAG_NONE)
 433 #define TRACE_EVENT_ASYNC_END1(category, name, id, arg1_name, arg1_val) \
 434     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
 435         category, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
 436 #define TRACE_EVENT_ASYNC_END2(category, name, id, arg1_name, arg1_val, \
 437         arg2_name, arg2_val) \
 438     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
 439         category, name, id, TRACE_EVENT_FLAG_NONE, \
 440         arg1_name, arg1_val, arg2_name, arg2_val)
 441 #define TRACE_EVENT_COPY_ASYNC_END0(category, name, id) \
 442     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
 443         category, name, id, TRACE_EVENT_FLAG_COPY)
 444 #define TRACE_EVENT_COPY_ASYNC_END1(category, name, id, arg1_name, arg1_val) \
 445     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
 446         category, name, id, TRACE_EVENT_FLAG_COPY, \
 447         arg1_name, arg1_val)
 448 #define TRACE_EVENT_COPY_ASYNC_END2(category, name, id, arg1_name, arg1_val, \
 449         arg2_name, arg2_val) \
 450     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
 451         category, name, id, TRACE_EVENT_FLAG_COPY, \
 452         arg1_name, arg1_val, arg2_name, arg2_val)
 453
 454 // Creates a scope of a sampling state with the given category and name (both must
 455 // be constant strings). These states are intended for a sampling profiler.
 456 // Implementation note: we store category and name together because we don't
 457 // want the inconsistency/expense of storing two pointers.
 458 // |thread_bucket| is [0..2] and is used to statically isolate samples in one
 459 // thread from others.
 460 //
 461 // {  // The sampling state is set within this scope.
 462 //    TRACE_EVENT_SAMPLING_STATE_SCOPE_FOR_BUCKET(0, "category", "name");
 463 //    ...;
 464 // }
 465 #define TRACE_EVENT_SCOPED_SAMPLING_STATE_FOR_BUCKET(bucket_number, category, name) \
 466     TraceEvent::SamplingStateScope<bucket_number> traceEventSamplingScope(category "\0" name);
 467
 468 // Returns a current sampling state of the given bucket.
 469 // The format of the returned string is "category\0name".
 470 #define TRACE_EVENT_GET_SAMPLING_STATE_FOR_BUCKET(bucket_number) \
 471     TraceEvent::SamplingStateScope<bucket_number>::current()
 472
 473 // Sets a current sampling state of the given bucket.
 474 // |category| and |name| have to be constant strings.
 475 #define TRACE_EVENT_SET_SAMPLING_STATE_FOR_BUCKET(bucket_number, category, name) \
 476     TraceEvent::SamplingStateScope<bucket_number>::set(category "\0" name)
 477
 478 // Sets a current sampling state of the given bucket.
 479 // |categoryAndName| doesn't need to be a constant string.
 480 // The format of the string is "category\0name".
 481 #define TRACE_EVENT_SET_NONCONST_SAMPLING_STATE_FOR_BUCKET(bucket_number, categoryAndName) \
 482     TraceEvent::SamplingStateScope<bucket_number>::set(categoryAndName)
 483
 484 // Syntactic sugars for the sampling tracing in the main thread.
 485 #define TRACE_EVENT_SCOPED_SAMPLING_STATE(category, name) \
 486     TRACE_EVENT_SCOPED_SAMPLING_STATE_FOR_BUCKET(0, category, name)
 487 #define TRACE_EVENT_GET_SAMPLING_STATE() \
 488     TRACE_EVENT_GET_SAMPLING_STATE_FOR_BUCKET(0)
 489 #define TRACE_EVENT_SET_SAMPLING_STATE(category, name) \
 490     TRACE_EVENT_SET_SAMPLING_STATE_FOR_BUCKET(0, category, name)
 491 #define TRACE_EVENT_SET_NONCONST_SAMPLING_STATE(categoryAndName) \
 492     TRACE_EVENT_SET_NONCONST_SAMPLING_STATE_FOR_BUCKET(0, categoryAndName)
 493
 494 // Macros to track the life time and value of arbitrary client objects.
 495 // See also TraceTrackableObject.
 496 #define TRACE_EVENT_OBJECT_CREATED_WITH_ID(categoryGroup, name, id) \
 497     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_CREATE_OBJECT, \
 498         categoryGroup, name, TRACE_ID_DONT_MANGLE(id), TRACE_EVENT_FLAG_NONE)
 499
 500 #define TRACE_EVENT_OBJECT_DELETED_WITH_ID(categoryGroup, name, id) \
 501     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_DELETE_OBJECT, \
 502         categoryGroup, name, TRACE_ID_DONT_MANGLE(id), TRACE_EVENT_FLAG_NONE)
 503
 504 // Macro to efficiently determine if a given category group is enabled.
 505 #define TRACE_EVENT_CATEGORY_GROUP_ENABLED(categoryGroup, ret) \
 506     do { \
 507         INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(categoryGroup);  \
 508         if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \
 509             *ret = true;                                        \
 510         } else {                                                \
 511             *ret = false;                                       \
 512         }                                                       \
 513     } while (0)
 514
 515 // This will mark the trace event as disabled by default. The user will need
 516 // to explicitly enable the event.
 517 #define TRACE_DISABLED_BY_DEFAULT(name) "disabled-by-default-" name
 518
 519 ////////////////////////////////////////////////////////////////////////////////
 520 // Implementation specific tracing API definitions.
 521
 522 // Get a pointer to the enabled state of the given trace category. Only
 523 // long-lived literal strings should be given as the category name. The returned
 524 // pointer can be held permanently in a local static for example. If the
 525 // unsigned char is non-zero, tracing is enabled. If tracing is enabled,
 526 // TRACE_EVENT_API_ADD_TRACE_EVENT can be called. It's OK if tracing is disabled
 527 // between the load of the tracing state and the call to
 528 // TRACE_EVENT_API_ADD_TRACE_EVENT, because this flag only provides an early out
 529 // for best performance when tracing is disabled.
 530 // const unsigned char*
 531 //     TRACE_EVENT_API_GET_CATEGORY_ENABLED(const char* category_name)
 532 #define TRACE_EVENT_API_GET_CATEGORY_ENABLED \
 533     WebCore::EventTracer::getTraceCategoryEnabledFlag
 534
 535 // Add a trace event to the platform tracing system.
 536 // WebCore::TraceEvent::TraceEventHandle TRACE_EVENT_API_ADD_TRACE_EVENT(
 537 //                    char phase,
 538 //                    const unsigned char* category_enabled,
 539 //                    const char* name,
 540 //                    unsigned long long id,
 541 //                    int num_args,
 542 //                    const char** arg_names,
 543 //                    const unsigned char* arg_types,
 544 //                    const unsigned long long* arg_values,
 545 //                    const RefPtr<ConvertableToTraceFormat>* convertableValues
 546 //                    unsigned char flags)
 547 #define TRACE_EVENT_API_ADD_TRACE_EVENT \
 548     WebCore::EventTracer::addTraceEvent
 549
 550 // Set the duration field of a COMPLETE trace event.
 551 // void TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION(
 552 //     WebCore::TraceEvent::TraceEventHandle handle)
 553 #define TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION \
 554     WebCore::EventTracer::updateTraceEventDuration
 555
 556 ////////////////////////////////////////////////////////////////////////////////
 557
 558 // Implementation detail: trace event macros create temporary variables
 559 // to keep instrumentation overhead low. These macros give each temporary
 560 // variable a unique name based on the line number to prevent name collissions.
 561 #define INTERNAL_TRACE_EVENT_UID3(a, b) \
 562     trace_event_unique_##a##b
 563 #define INTERNAL_TRACE_EVENT_UID2(a, b) \
 564     INTERNAL_TRACE_EVENT_UID3(a, b)
 565 #define INTERNALTRACEEVENTUID(name_prefix) \
 566     INTERNAL_TRACE_EVENT_UID2(name_prefix, __LINE__)
 567
 568 // Implementation detail: internal macro to create static category.
 569 // - WTF_ANNOTATE_BENIGN_RACE, see Thread Safety above.
 570
 571 #define INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category) \
 572     static const unsigned char* INTERNALTRACEEVENTUID(categoryGroupEnabled) = 0; \
 573     WTF_ANNOTATE_BENIGN_RACE(&INTERNALTRACEEVENTUID(categoryGroupEnabled), \
 574                              "trace_event category"); \
 575     if (!INTERNALTRACEEVENTUID(categoryGroupEnabled)) { \
 576         INTERNALTRACEEVENTUID(categoryGroupEnabled) = \
 577             TRACE_EVENT_API_GET_CATEGORY_ENABLED(category); \
 578     }
 579
 580 // Implementation detail: internal macro to create static category and add
 581 // event if the category is enabled.
 582 #define INTERNAL_TRACE_EVENT_ADD(phase, category, name, flags, ...) \
 583     do { \
 584         INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category); \
 585         if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \
 586             WebCore::TraceEvent::addTraceEvent( \
 587                 phase, INTERNALTRACEEVENTUID(categoryGroupEnabled), name, \
 588                 WebCore::TraceEvent::noEventId, flags, ##__VA_ARGS__); \
 589         } \
 590     } while (0)
 591
 592 // Implementation detail: internal macro to create static category and add begin
 593 // event if the category is enabled. Also adds the end event when the scope
 594 // ends.
 595 #define INTERNAL_TRACE_EVENT_ADD_SCOPED(category, name, ...) \
 596     INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category); \
 597     WebCore::TraceEvent::ScopedTracer INTERNALTRACEEVENTUID(scopedTracer); \
 598     if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \
 599         WebCore::TraceEvent::TraceEventHandle h = \
 600             WebCore::TraceEvent::addTraceEvent( \
 601                 TRACE_EVENT_PHASE_COMPLETE, \
 602                 INTERNALTRACEEVENTUID(categoryGroupEnabled), \
 603                 name, WebCore::TraceEvent::noEventId, \
 604                 TRACE_EVENT_FLAG_NONE, ##__VA_ARGS__); \
 605         INTERNALTRACEEVENTUID(scopedTracer).initialize( \
 606             INTERNALTRACEEVENTUID(categoryGroupEnabled), name, h); \
 607     }
 608
 609 // Implementation detail: internal macro to create static category and add
 610 // event if the category is enabled.
 611 #define INTERNAL_TRACE_EVENT_ADD_WITH_ID(phase, category, name, id, flags, \
 612                                          ...) \
 613     do { \
 614         INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category); \
 615         if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \
 616             unsigned char traceEventFlags = flags | TRACE_EVENT_FLAG_HAS_ID; \
 617             WebCore::TraceEvent::TraceID traceEventTraceID( \
 618                 id, &traceEventFlags); \
 619             WebCore::TraceEvent::addTraceEvent( \
 620                 phase, INTERNALTRACEEVENTUID(categoryGroupEnabled), \
 621                 name, traceEventTraceID.data(), traceEventFlags, \
 622                 ##__VA_ARGS__); \
 623         } \
 624     } while (0)
 625
 626 // Notes regarding the following definitions:
 627 // New values can be added and propagated to third party libraries, but existing
 628 // definitions must never be changed, because third party libraries may use old
 629 // definitions.
 630
 631 // Phase indicates the nature of an event entry. E.g. part of a begin/end pair.
 632 #define TRACE_EVENT_PHASE_BEGIN    ('B')
 633 #define TRACE_EVENT_PHASE_END      ('E')
 634 #define TRACE_EVENT_PHASE_COMPLETE ('X')
 635 // FIXME: unify instant events handling between blink and platform.
 636 #define TRACE_EVENT_PHASE_INSTANT  ('I')
 637 #define TRACE_EVENT_PHASE_INSTANT_WITH_SCOPE  ('i')
 638 #define TRACE_EVENT_PHASE_ASYNC_BEGIN ('S')
 639 #define TRACE_EVENT_PHASE_ASYNC_STEP_INTO  ('T')
 640 #define TRACE_EVENT_PHASE_ASYNC_STEP_PAST  ('p')
 641 #define TRACE_EVENT_PHASE_ASYNC_END   ('F')
 642 #define TRACE_EVENT_PHASE_METADATA ('M')
 643 #define TRACE_EVENT_PHASE_COUNTER  ('C')
 644 #define TRACE_EVENT_PHASE_SAMPLE  ('P')
 645 #define TRACE_EVENT_PHASE_CREATE_OBJECT ('N')
 646 #define TRACE_EVENT_PHASE_DELETE_OBJECT ('D')
 647
 648 // Flags for changing the behavior of TRACE_EVENT_API_ADD_TRACE_EVENT.
 649 #define TRACE_EVENT_FLAG_NONE        (static_cast<unsigned char>(0))
 650 #define TRACE_EVENT_FLAG_COPY        (static_cast<unsigned char>(1 << 0))
 651 #define TRACE_EVENT_FLAG_HAS_ID      (static_cast<unsigned char>(1 << 1))
 652 #define TRACE_EVENT_FLAG_MANGLE_ID   (static_cast<unsigned char>(1 << 2))
 653
 654 // Type values for identifying types in the TraceValue union.
 655 #define TRACE_VALUE_TYPE_BOOL         (static_cast<unsigned char>(1))
 656 #define TRACE_VALUE_TYPE_UINT         (static_cast<unsigned char>(2))
 657 #define TRACE_VALUE_TYPE_INT          (static_cast<unsigned char>(3))
 658 #define TRACE_VALUE_TYPE_DOUBLE       (static_cast<unsigned char>(4))
 659 #define TRACE_VALUE_TYPE_POINTER      (static_cast<unsigned char>(5))
 660 #define TRACE_VALUE_TYPE_STRING       (static_cast<unsigned char>(6))
 661 #define TRACE_VALUE_TYPE_COPY_STRING  (static_cast<unsigned char>(7))
 662 #define TRACE_VALUE_TYPE_CONVERTABLE  (static_cast<unsigned char>(8))
 663
 664 // These values must be in sync with base::debug::TraceLog::CategoryGroupEnabledFlags.
 665 #define ENABLED_FOR_RECORDING (1 << 0)
 666 #define ENABLED_FOR_EVENT_CALLBACK (1 << 2)
 667
 668 #define INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE() \
 669     (*INTERNALTRACEEVENTUID(categoryGroupEnabled) & (ENABLED_FOR_RECORDING | ENABLED_FOR_EVENT_CALLBACK))
 670
 671 namespace WebCore {
 672
 673 namespace TraceEvent {
 674
 675 // Specify these values when the corresponding argument of addTraceEvent is not
 676 // used.
 677 const int zeroNumArgs = 0;
 678 const unsigned long long noEventId = 0;
 679
 680 // TraceID encapsulates an ID that can either be an integer or pointer. Pointers
 681 // are mangled with the Process ID so that they are unlikely to collide when the
 682 // same pointer is used on different processes.
 683 class TraceID {
 684 public:
 685     template<bool dummyMangle> class MangleBehavior {
 686     public:
 687         template<typename T> explicit MangleBehavior(T id) : m_data(reinterpret_cast<unsigned long long>(id)) { }
 688         unsigned long long data() const { return m_data; }
 689     private:
 690         unsigned long long m_data;
 691     };
 692     typedef MangleBehavior<false> DontMangle;
 693     typedef MangleBehavior<true> ForceMangle;
 694
 695     TraceID(const void* id, unsigned char* flags) :
 696         m_data(static_cast<unsigned long long>(reinterpret_cast<unsigned long>(id)))
 697     {
 698         *flags |= TRACE_EVENT_FLAG_MANGLE_ID;
 699     }
 700     TraceID(ForceMangle id, unsigned char* flags) : m_data(id.data())
 701     {
 702         *flags |= TRACE_EVENT_FLAG_MANGLE_ID;
 703     }
 704     TraceID(DontMangle id, unsigned char*) : m_data(id.data()) { }
 705     TraceID(unsigned long long id, unsigned char*) : m_data(id) { }
 706     TraceID(unsigned long id, unsigned char*) : m_data(id) { }
 707     TraceID(unsigned id, unsigned char*) : m_data(id) { }
 708     TraceID(unsigned short id, unsigned char*) : m_data(id) { }
 709     TraceID(unsigned char id, unsigned char*) : m_data(id) { }
 710     TraceID(long long id, unsigned char*) :
 711         m_data(static_cast<unsigned long long>(id)) { }
 712     TraceID(long id, unsigned char*) :
 713         m_data(static_cast<unsigned long long>(id)) { }
 714     TraceID(int id, unsigned char*) :
 715         m_data(static_cast<unsigned long long>(id)) { }
 716     TraceID(short id, unsigned char*) :
 717         m_data(static_cast<unsigned long long>(id)) { }
 718     TraceID(signed char id, unsigned char*) :
 719         m_data(static_cast<unsigned long long>(id)) { }
 720
 721     unsigned long long data() const { return m_data; }
 722
 723 private:
 724     unsigned long long m_data;
 725 };
 726
 727 // Simple union to store various types as unsigned long long.
 728 union TraceValueUnion {
 729     bool m_bool;
 730     unsigned long long m_uint;
 731     long long m_int;
 732     double m_double;
 733     const void* m_pointer;
 734     const char* m_string;
 735 };
 736
 737 // Simple container for const char* that should be copied instead of retained.
 738 class TraceStringWithCopy {
 739 public:
 740     explicit TraceStringWithCopy(const char* str) : m_str(str) { }
 741     operator const char* () const { return m_str; }
 742 private:
 743     const char* m_str;
 744 };
 745
 746 // Define setTraceValue for each allowed type. It stores the type and
 747 // value in the return arguments. This allows this API to avoid declaring any
 748 // structures so that it is portable to third_party libraries.
 749 #define INTERNAL_DECLARE_SET_TRACE_VALUE(actual_type, \
 750                                          union_member, \
 751                                          value_type_id) \
 752     static inline void setTraceValue(actual_type arg, \
 753                                      unsigned char* type, \
 754                                      unsigned long long* value) { \
 755         TraceValueUnion typeValue; \
 756         typeValue.union_member = arg; \
 757         *type = value_type_id; \
 758         *value = typeValue.m_uint; \
 759     }
 760 // Simpler form for int types that can be safely casted.
 761 #define INTERNAL_DECLARE_SET_TRACE_VALUE_INT(actual_type, \
 762                                              value_type_id) \
 763     static inline void setTraceValue(actual_type arg, \
 764                                      unsigned char* type, \
 765                                      unsigned long long* value) { \
 766         *type = value_type_id; \
 767         *value = static_cast<unsigned long long>(arg); \
 768     }
 769
 770 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned long long, TRACE_VALUE_TYPE_UINT)
 771 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned, TRACE_VALUE_TYPE_UINT)
 772 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned short, TRACE_VALUE_TYPE_UINT)
 773 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned char, TRACE_VALUE_TYPE_UINT)
 774 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(long long, TRACE_VALUE_TYPE_INT)
 775 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(int, TRACE_VALUE_TYPE_INT)
 776 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(short, TRACE_VALUE_TYPE_INT)
 777 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(signed char, TRACE_VALUE_TYPE_INT)
 778 INTERNAL_DECLARE_SET_TRACE_VALUE(bool, m_bool, TRACE_VALUE_TYPE_BOOL)
 779 INTERNAL_DECLARE_SET_TRACE_VALUE(double, m_double, TRACE_VALUE_TYPE_DOUBLE)
 780 INTERNAL_DECLARE_SET_TRACE_VALUE(const void*, m_pointer,
 781                                  TRACE_VALUE_TYPE_POINTER)
 782 INTERNAL_DECLARE_SET_TRACE_VALUE(const char*, m_string,
 783                                  TRACE_VALUE_TYPE_STRING)
 784 INTERNAL_DECLARE_SET_TRACE_VALUE(const TraceStringWithCopy&, m_string,
 785                                  TRACE_VALUE_TYPE_COPY_STRING)
 786
 787 #undef INTERNAL_DECLARE_SET_TRACE_VALUE
 788 #undef INTERNAL_DECLARE_SET_TRACE_VALUE_INT
 789
 790 // WTF::String version of setTraceValue so that trace arguments can be strings.
 791 static inline void setTraceValue(const WTF::CString& arg, unsigned char* type, unsigned long long* value)
 792 {
 793     TraceValueUnion typeValue;
 794     typeValue.m_string = arg.data();
 795     *type = TRACE_VALUE_TYPE_COPY_STRING;
 796     *value = typeValue.m_uint;
 797 }
 798
 799 static inline void setTraceValue(ConvertableToTraceFormat*, unsigned char* type, unsigned long long*)
 800 {
 801     *type = TRACE_VALUE_TYPE_CONVERTABLE;
 802 }
 803
 804 template<typename T> static inline void setTraceValue(const PassRefPtr<T>& ptr, unsigned char* type, unsigned long long* value)
 805 {
 806     setTraceValue(ptr.get(), type, value);
 807 }
 808
 809 template<typename T> struct ConvertableToTraceFormatTraits {
 810     static const bool isConvertable = false;
 811     static void assignIfConvertable(ConvertableToTraceFormat*& left, const T&)
 812     {
 813         left = 0;
 814     }
 815 };
 816
 817 template<typename T> struct ConvertableToTraceFormatTraits<T*> {
 818     static const bool isConvertable = WTF::IsSubclass<T, TraceEvent::ConvertableToTraceFormat>::value;
 819     static void assignIfConvertable(ConvertableToTraceFormat*& left, ...)
 820     {
 821         left = 0;
 822     }
 823     static void assignIfConvertable(ConvertableToTraceFormat*& left, ConvertableToTraceFormat* const& right)
 824     {
 825         left = right;
 826     }
 827 };
 828
 829 template<typename T> struct ConvertableToTraceFormatTraits<PassRefPtr<T> > {
 830     static const bool isConvertable = WTF::IsSubclass<T, TraceEvent::ConvertableToTraceFormat>::value;
 831     static void assignIfConvertable(ConvertableToTraceFormat*& left, const PassRefPtr<T>& right)
 832     {
 833         ConvertableToTraceFormatTraits<T*>::assignIfConvertable(left, right.get());
 834     }
 835 };
 836
 837 template<typename T> bool isConvertableToTraceFormat(const T&)
 838 {
 839     return ConvertableToTraceFormatTraits<T>::isConvertable;
 840 }
 841
 842 template<typename T> void assignIfConvertableToTraceFormat(ConvertableToTraceFormat*& left, const T& right)
 843 {
 844     ConvertableToTraceFormatTraits<T>::assignIfConvertable(left, right);
 845 }
 846
 847 // These addTraceEvent template functions are defined here instead of in the
 848 // macro, because the arg values could be temporary string objects. In order to
 849 // store pointers to the internal c_str and pass through to the tracing API, the
 850 // arg values must live throughout these procedures.
 851
 852 static inline TraceEventHandle addTraceEvent(
 853     char phase,
 854     const unsigned char* categoryEnabled,
 855     const char* name,
 856     unsigned long long id,
 857     unsigned char flags)
 858 {
 859     return TRACE_EVENT_API_ADD_TRACE_EVENT(
 860         phase, categoryEnabled, name, id,
 861         zeroNumArgs, 0, 0, 0,
 862         flags);
 863 }
 864
 865 template<typename ARG1_TYPE>
 866 static inline TraceEventHandle addTraceEvent(
 867     char phase,
 868     const unsigned char* categoryEnabled,
 869     const char* name,
 870     unsigned long long id,
 871     unsigned char flags,
 872     const char* arg1Name,
 873     const ARG1_TYPE& arg1Val)
 874 {
 875     const int numArgs = 1;
 876     unsigned char argTypes[1];
 877     unsigned long long argValues[1];
 878     setTraceValue(arg1Val, &argTypes[0], &argValues[0]);
 879     if (isConvertableToTraceFormat(arg1Val)) {
 880         ConvertableToTraceFormat* convertableValues[1];
 881         assignIfConvertableToTraceFormat(convertableValues[0], arg1Val);
 882         return TRACE_EVENT_API_ADD_TRACE_EVENT(
 883             phase, categoryEnabled, name, id,
 884             numArgs, &arg1Name, argTypes, argValues,
 885             convertableValues,
 886             flags);
 887     }
 888     return TRACE_EVENT_API_ADD_TRACE_EVENT(
 889         phase, categoryEnabled, name, id,
 890         numArgs, &arg1Name, argTypes, argValues,
 891         flags);
 892 }
 893
 894 template<typename ARG1_TYPE, typename ARG2_TYPE>
 895 static inline TraceEventHandle addTraceEvent(
 896     char phase,
 897     const unsigned char* categoryEnabled,
 898     const char* name,
 899     unsigned long long id,
 900     unsigned char flags,
 901     const char* arg1Name,
 902     const ARG1_TYPE& arg1Val,
 903     const char* arg2Name,
 904     const ARG2_TYPE& arg2Val)
 905 {
 906     const int numArgs = 2;
 907     const char* argNames[2] = { arg1Name, arg2Name };
 908     unsigned char argTypes[2];
 909     unsigned long long argValues[2];
 910     setTraceValue(arg1Val, &argTypes[0], &argValues[0]);
 911     setTraceValue(arg2Val, &argTypes[1], &argValues[1]);
 912     if (isConvertableToTraceFormat(arg1Val) || isConvertableToTraceFormat(arg2Val)) {
 913         ConvertableToTraceFormat* convertableValues[2];
 914         assignIfConvertableToTraceFormat(convertableValues[0], arg1Val);
 915         assignIfConvertableToTraceFormat(convertableValues[1], arg2Val);
 916         return TRACE_EVENT_API_ADD_TRACE_EVENT(
 917             phase, categoryEnabled, name, id,
 918             numArgs, argNames, argTypes, argValues,
 919             convertableValues,
 920             flags);
 921     }
 922     return TRACE_EVENT_API_ADD_TRACE_EVENT(
 923         phase, categoryEnabled, name, id,
 924         numArgs, argNames, argTypes, argValues,
 925         flags);
 926 }
 927
 928 // Used by TRACE_EVENTx macro. Do not use directly.
 929 class ScopedTracer {
 930 public:
 931     // Note: members of m_data intentionally left uninitialized. See initialize.
 932     ScopedTracer() : m_pdata(0) { }
 933     ~ScopedTracer()
 934     {
 935         if (m_pdata && *m_pdata->categoryGroupEnabled)
 936             TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION(m_data.categoryGroupEnabled, m_data.name, m_data.eventHandle);
 937     }
 938
 939     void initialize(const unsigned char* categoryGroupEnabled, const char* name, TraceEventHandle eventHandle)
 940     {
 941         m_data.categoryGroupEnabled = categoryGroupEnabled;
 942         m_data.name = name;
 943         m_data.eventHandle = eventHandle;
 944         m_pdata = &m_data;
 945     }
 946
 947 private:
 948     // This Data struct workaround is to avoid initializing all the members
 949     // in Data during construction of this object, since this object is always
 950     // constructed, even when tracing is disabled. If the members of Data were
 951     // members of this class instead, compiler warnings occur about potential
 952     // uninitialized accesses.
 953     struct Data {
 954         const unsigned char* categoryGroupEnabled;
 955         const char* name;
 956         TraceEventHandle eventHandle;
 957     };
 958     Data* m_pdata;
 959     Data m_data;
 960 };
 961
 962 // TraceEventSamplingStateScope records the current sampling state
 963 // and sets a new sampling state. When the scope exists, it restores
 964 // the sampling state having recorded.
 965 template<size_t BucketNumber>
 966 class SamplingStateScope {
 967     WTF_MAKE_FAST_ALLOCATED;
 968 public:
 969     SamplingStateScope(const char* categoryAndName)
 970     {
 971         m_previousState = SamplingStateScope<BucketNumber>::current();
 972         SamplingStateScope<BucketNumber>::set(categoryAndName);
 973     }
 974
 975     ~SamplingStateScope()
 976     {
 977         SamplingStateScope<BucketNumber>::set(m_previousState);
 978     }
 979
 980     // FIXME: Make load/store to traceSamplingState[] thread-safe and atomic.
 981     static inline const char* current()
 982     {
 983         return reinterpret_cast<const char*>(*WebCore::traceSamplingState[BucketNumber]);
 984     }
 985     static inline void set(const char* categoryAndName)
 986     {
 987         *WebCore::traceSamplingState[BucketNumber] = reinterpret_cast<long>(const_cast<char*>(categoryAndName));
 988     }
 989
 990 private:
 991     const char* m_previousState;
 992 };
 993
 994 template<typename IDType> class TraceScopedTrackableObject {
 995     WTF_MAKE_NONCOPYABLE(TraceScopedTrackableObject);
 996 public:
 997     TraceScopedTrackableObject(const char* categoryGroup, const char* name, IDType id)
 998         : m_categoryGroup(categoryGroup), m_name(name), m_id(id)
 999     {
1000         TRACE_EVENT_OBJECT_CREATED_WITH_ID(m_categoryGroup, m_name, m_id);
1001     }
1002
1003     ~TraceScopedTrackableObject()
1004     {
1005         TRACE_EVENT_OBJECT_DELETED_WITH_ID(m_categoryGroup, m_name, m_id);
1006     }
1007
1008 private:
1009     const char* m_categoryGroup;
1010     const char* m_name;
1011     IDType m_id;
1012 };
1013
1014 } // namespace TraceEvent
1015
1016 } // namespace WebCore
1017
1018 #endif