[chromium] Implement TRACE_EVENT macros for sampling profiling
[WebKit-https.git] / Source / WebCore / platform / chromium / 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 "EventTracer.h"
167
168 #include <wtf/DynamicAnnotations.h>
169 #include <wtf/text/CString.h>
170
171 // By default, const char* argument values are assumed to have long-lived scope
172 // and will not be copied. Use this macro to force a const char* to be copied.
173 #define TRACE_STR_COPY(str) \
174     WebCore::TraceEvent::TraceStringWithCopy(str)
175
176 // Records a pair of begin and end events called "name" for the current
177 // scope, with 0, 1 or 2 associated arguments. If the category is not
178 // enabled, then this does nothing.
179 // - category and name strings must have application lifetime (statics or
180 //   literals). They may not include " chars.
181 #define TRACE_EVENT0(category, name) \
182     INTERNAL_TRACE_EVENT_ADD_SCOPED(category, name)
183 #define TRACE_EVENT1(category, name, arg1_name, arg1_val) \
184     INTERNAL_TRACE_EVENT_ADD_SCOPED(category, name, arg1_name, arg1_val)
185 #define TRACE_EVENT2(category, name, arg1_name, arg1_val, arg2_name, arg2_val) \
186     INTERNAL_TRACE_EVENT_ADD_SCOPED(category, name, arg1_name, arg1_val, \
187         arg2_name, arg2_val)
188
189 // Records a single event called "name" immediately, with 0, 1 or 2
190 // associated arguments. If the category is not enabled, then this
191 // does nothing.
192 // - category and name strings must have application lifetime (statics or
193 //   literals). They may not include " chars.
194 #define TRACE_EVENT_INSTANT0(category, name) \
195     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
196         category, name, TRACE_EVENT_FLAG_NONE)
197 #define TRACE_EVENT_INSTANT1(category, name, arg1_name, arg1_val) \
198     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
199         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
200 #define TRACE_EVENT_INSTANT2(category, name, arg1_name, arg1_val, \
201         arg2_name, arg2_val) \
202     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
203         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \
204         arg2_name, arg2_val)
205 #define TRACE_EVENT_COPY_INSTANT0(category, name) \
206     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
207         category, name, TRACE_EVENT_FLAG_COPY)
208 #define TRACE_EVENT_COPY_INSTANT1(category, name, arg1_name, arg1_val) \
209     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_INSTANT, \
210         category, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val)
211 #define TRACE_EVENT_COPY_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_COPY, arg1_name, arg1_val, \
215         arg2_name, arg2_val)
216
217 // Records a single BEGIN event called "name" immediately, with 0, 1 or 2
218 // associated arguments. If the category is not enabled, then this
219 // does nothing.
220 // - category and name strings must have application lifetime (statics or
221 //   literals). They may not include " chars.
222 #define TRACE_EVENT_BEGIN0(category, name) \
223     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
224         category, name, TRACE_EVENT_FLAG_NONE)
225 #define TRACE_EVENT_BEGIN1(category, name, arg1_name, arg1_val) \
226     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
227         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
228 #define TRACE_EVENT_BEGIN2(category, name, arg1_name, arg1_val, \
229         arg2_name, arg2_val) \
230     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
231         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \
232         arg2_name, arg2_val)
233 #define TRACE_EVENT_COPY_BEGIN0(category, name) \
234     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
235         category, name, TRACE_EVENT_FLAG_COPY)
236 #define TRACE_EVENT_COPY_BEGIN1(category, name, arg1_name, arg1_val) \
237     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_BEGIN, \
238         category, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val)
239 #define TRACE_EVENT_COPY_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_COPY, arg1_name, arg1_val, \
243         arg2_name, arg2_val)
244
245 // Records a single END event for "name" immediately. If the category
246 // is not enabled, then this does nothing.
247 // - category and name strings must have application lifetime (statics or
248 //   literals). They may not include " chars.
249 #define TRACE_EVENT_END0(category, name) \
250     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
251         category, name, TRACE_EVENT_FLAG_NONE)
252 #define TRACE_EVENT_END1(category, name, arg1_name, arg1_val) \
253     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
254         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
255 #define TRACE_EVENT_END2(category, name, arg1_name, arg1_val, \
256         arg2_name, arg2_val) \
257     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
258         category, name, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val, \
259         arg2_name, arg2_val)
260 #define TRACE_EVENT_COPY_END0(category, name) \
261     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
262         category, name, TRACE_EVENT_FLAG_COPY)
263 #define TRACE_EVENT_COPY_END1(category, name, arg1_name, arg1_val) \
264     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_END, \
265         category, name, TRACE_EVENT_FLAG_COPY, arg1_name, arg1_val)
266 #define TRACE_EVENT_COPY_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_COPY, arg1_name, arg1_val, \
270         arg2_name, arg2_val)
271
272 // Records the value of a counter called "name" immediately. Value
273 // must be representable as a 32 bit integer.
274 // - category and name strings must have application lifetime (statics or
275 //   literals). They may not include " chars.
276 #define TRACE_COUNTER1(category, name, value) \
277     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \
278         category, name, TRACE_EVENT_FLAG_NONE, \
279         "value", static_cast<int>(value))
280 #define TRACE_COPY_COUNTER1(category, name, value) \
281     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \
282         category, name, TRACE_EVENT_FLAG_COPY, \
283         "value", static_cast<int>(value))
284
285 // Records the values of a multi-parted counter called "name" immediately.
286 // The UI will treat value1 and value2 as parts of a whole, displaying their
287 // values as a stacked-bar chart.
288 // - category and name strings must have application lifetime (statics or
289 //   literals). They may not include " chars.
290 #define TRACE_COUNTER2(category, name, value1_name, value1_val, \
291         value2_name, value2_val) \
292     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \
293         category, name, TRACE_EVENT_FLAG_NONE, \
294         value1_name, static_cast<int>(value1_val), \
295         value2_name, static_cast<int>(value2_val))
296 #define TRACE_COPY_COUNTER2(category, name, value1_name, value1_val, \
297         value2_name, value2_val) \
298     INTERNAL_TRACE_EVENT_ADD(TRACE_EVENT_PHASE_COUNTER, \
299         category, name, TRACE_EVENT_FLAG_COPY, \
300         value1_name, static_cast<int>(value1_val), \
301         value2_name, static_cast<int>(value2_val))
302
303 // Records the value of a counter called "name" immediately. Value
304 // must be representable as a 32 bit integer.
305 // - category and name strings must have application lifetime (statics or
306 //   literals). They may not include " chars.
307 // - |id| is used to disambiguate counters with the same name. It must either
308 //   be a pointer or an integer value up to 64 bits. If it's a pointer, the bits
309 //   will be xored with a hash of the process ID so that the same pointer on
310 //   two different processes will not collide.
311 #define TRACE_COUNTER_ID1(category, name, id, value) \
312     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \
313         category, name, id, TRACE_EVENT_FLAG_NONE, \
314         "value", static_cast<int>(value))
315 #define TRACE_COPY_COUNTER_ID1(category, name, id, value) \
316     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \
317         category, name, id, TRACE_EVENT_FLAG_COPY, \
318         "value", static_cast<int>(value))
319
320 // Records the values of a multi-parted counter called "name" immediately.
321 // The UI will treat value1 and value2 as parts of a whole, displaying their
322 // values as a stacked-bar chart.
323 // - category and name strings must have application lifetime (statics or
324 //   literals). They may not include " chars.
325 // - |id| is used to disambiguate counters with the same name. It must either
326 //   be a pointer or an integer value up to 64 bits. If it's a pointer, the bits
327 //   will be xored with a hash of the process ID so that the same pointer on
328 //   two different processes will not collide.
329 #define TRACE_COUNTER_ID2(category, name, id, value1_name, value1_val, \
330         value2_name, value2_val) \
331     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \
332         category, name, id, TRACE_EVENT_FLAG_NONE, \
333         value1_name, static_cast<int>(value1_val), \
334         value2_name, static_cast<int>(value2_val))
335 #define TRACE_COPY_COUNTER_ID2(category, name, id, value1_name, value1_val, \
336         value2_name, value2_val) \
337     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_COUNTER, \
338         category, name, id, TRACE_EVENT_FLAG_COPY, \
339         value1_name, static_cast<int>(value1_val), \
340         value2_name, static_cast<int>(value2_val))
341
342 // Records a single ASYNC_BEGIN event called "name" immediately, with 0, 1 or 2
343 // associated arguments. If the category is not enabled, then this
344 // does nothing.
345 // - category and name strings must have application lifetime (statics or
346 //   literals). They may not include " chars.
347 // - |id| is used to match the ASYNC_BEGIN event with the ASYNC_END event. ASYNC
348 //   events are considered to match if their category, name and id values all
349 //   match. |id| must either be a pointer or an integer value up to 64 bits. If
350 //   it's a pointer, the bits will be xored with a hash of the process ID so
351 //   that the same pointer on two different processes will not collide.
352 // An asynchronous operation can consist of multiple phases. The first phase is
353 // defined by the ASYNC_BEGIN calls. Additional phases can be defined using the
354 // ASYNC_STEP_BEGIN macros. When the operation completes, call ASYNC_END.
355 // An async operation can span threads and processes, but all events in that
356 // operation must use the same |name| and |id|. Each event can have its own
357 // args.
358 #define TRACE_EVENT_ASYNC_BEGIN0(category, name, id) \
359     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
360         category, name, id, TRACE_EVENT_FLAG_NONE)
361 #define TRACE_EVENT_ASYNC_BEGIN1(category, name, id, arg1_name, arg1_val) \
362     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
363         category, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
364 #define TRACE_EVENT_ASYNC_BEGIN2(category, name, id, arg1_name, arg1_val, \
365         arg2_name, arg2_val) \
366     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
367         category, name, id, TRACE_EVENT_FLAG_NONE, \
368         arg1_name, arg1_val, arg2_name, arg2_val)
369 #define TRACE_EVENT_COPY_ASYNC_BEGIN0(category, name, id) \
370     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
371         category, name, id, TRACE_EVENT_FLAG_COPY)
372 #define TRACE_EVENT_COPY_ASYNC_BEGIN1(category, name, id, arg1_name, arg1_val) \
373     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
374         category, name, id, TRACE_EVENT_FLAG_COPY, \
375         arg1_name, arg1_val)
376 #define TRACE_EVENT_COPY_ASYNC_BEGIN2(category, name, id, arg1_name, arg1_val, \
377         arg2_name, arg2_val) \
378     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_BEGIN, \
379         category, name, id, TRACE_EVENT_FLAG_COPY, \
380         arg1_name, arg1_val, arg2_name, arg2_val)
381
382 // Records a single ASYNC_STEP event for |step| immediately. If the category
383 // is not enabled, then this does nothing. The |name| and |id| must match the
384 // ASYNC_BEGIN event above. The |step| param identifies this step within the
385 // async event. This should be called at the beginning of the next phase of an
386 // asynchronous operation.
387 #define TRACE_EVENT_ASYNC_STEP0(category, name, id, step) \
388     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP, \
389         category, name, id, TRACE_EVENT_FLAG_NONE, "step", step)
390 #define TRACE_EVENT_ASYNC_STEP1(category, name, id, step, \
391                                       arg1_name, arg1_val) \
392     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP, \
393         category, name, id, TRACE_EVENT_FLAG_NONE, "step", step, \
394         arg1_name, arg1_val)
395 #define TRACE_EVENT_COPY_ASYNC_STEP0(category, name, id, step) \
396     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP, \
397         category, name, id, TRACE_EVENT_FLAG_COPY, "step", step)
398 #define TRACE_EVENT_COPY_ASYNC_STEP1(category, name, id, step, \
399         arg1_name, arg1_val) \
400     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_STEP, \
401         category, name, id, TRACE_EVENT_FLAG_COPY, "step", step, \
402         arg1_name, arg1_val)
403
404 // Records a single ASYNC_END event for "name" immediately. If the category
405 // is not enabled, then this does nothing.
406 #define TRACE_EVENT_ASYNC_END0(category, name, id) \
407     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
408         category, name, id, TRACE_EVENT_FLAG_NONE)
409 #define TRACE_EVENT_ASYNC_END1(category, name, id, arg1_name, arg1_val) \
410     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
411         category, name, id, TRACE_EVENT_FLAG_NONE, arg1_name, arg1_val)
412 #define TRACE_EVENT_ASYNC_END2(category, name, id, arg1_name, arg1_val, \
413         arg2_name, arg2_val) \
414     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
415         category, name, id, TRACE_EVENT_FLAG_NONE, \
416         arg1_name, arg1_val, arg2_name, arg2_val)
417 #define TRACE_EVENT_COPY_ASYNC_END0(category, name, id) \
418     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
419         category, name, id, TRACE_EVENT_FLAG_COPY)
420 #define TRACE_EVENT_COPY_ASYNC_END1(category, name, id, arg1_name, arg1_val) \
421     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
422         category, name, id, TRACE_EVENT_FLAG_COPY, \
423         arg1_name, arg1_val)
424 #define TRACE_EVENT_COPY_ASYNC_END2(category, name, id, arg1_name, arg1_val, \
425         arg2_name, arg2_val) \
426     INTERNAL_TRACE_EVENT_ADD_WITH_ID(TRACE_EVENT_PHASE_ASYNC_END, \
427         category, name, id, TRACE_EVENT_FLAG_COPY, \
428         arg1_name, arg1_val, arg2_name, arg2_val)
429
430 // Updates a global state with 'name'. The sampling thread will read
431 // the value periodically. STATE0 is for the main thread.
432 // STATE1 and STATE2 will be preserved for other threads.
433 #define TRACE_EVENT_SAMPLING_STATE0(name) \
434     INTERNAL_TRACE_EVENT_SAMPLING_STATE(name, 0)
435 #define TRACE_EVENT_SAMPLING_STATE1(name) \
436     INTERNAL_TRACE_EVENT_SAMPLING_STATE(name, 1)
437 #define TRACE_EVENT_SAMPLING_STATE2(name) \
438     INTERNAL_TRACE_EVENT_SAMPLING_STATE(name, 2)
439
440 ////////////////////////////////////////////////////////////////////////////////
441 // Implementation specific tracing API definitions.
442
443 // Get a pointer to the enabled state of the given trace category. Only
444 // long-lived literal strings should be given as the category name. The returned
445 // pointer can be held permanently in a local static for example. If the
446 // unsigned char is non-zero, tracing is enabled. If tracing is enabled,
447 // TRACE_EVENT_API_ADD_TRACE_EVENT can be called. It's OK if tracing is disabled
448 // between the load of the tracing state and the call to
449 // TRACE_EVENT_API_ADD_TRACE_EVENT, because this flag only provides an early out
450 // for best performance when tracing is disabled.
451 // const unsigned char*
452 //     TRACE_EVENT_API_GET_CATEGORY_ENABLED(const char* category_name)
453 #define TRACE_EVENT_API_GET_CATEGORY_ENABLED \
454     WebCore::EventTracer::getTraceCategoryEnabledFlag
455
456 // Add a trace event to the platform tracing system. 
457 // void TRACE_EVENT_API_ADD_TRACE_EVENT(
458 //                    char phase,
459 //                    const unsigned char* category_enabled,
460 //                    const char* name,
461 //                    unsigned long long id,
462 //                    int num_args,
463 //                    const char** arg_names,
464 //                    const unsigned char* arg_types,
465 //                    const unsigned long long* arg_values,
466 //                    unsigned char flags)
467 #define TRACE_EVENT_API_ADD_TRACE_EVENT \
468     WebCore::EventTracer::addTraceEvent
469
470 ////////////////////////////////////////////////////////////////////////////////
471
472 // Implementation detail: trace event macros create temporary variables
473 // to keep instrumentation overhead low. These macros give each temporary
474 // variable a unique name based on the line number to prevent name collissions.
475 #define INTERNAL_TRACE_EVENT_UID3(a, b) \
476     trace_event_unique_##a##b
477 #define INTERNAL_TRACE_EVENT_UID2(a, b) \
478     INTERNAL_TRACE_EVENT_UID3(a, b)
479 #define INTERNALTRACEEVENTUID(name_prefix) \
480     INTERNAL_TRACE_EVENT_UID2(name_prefix, __LINE__)
481
482 // Implementation detail: internal macro to create static category.
483 // - WTF_ANNOTATE_BENIGN_RACE, see Thread Safety above.
484 #define INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category) \
485     static const unsigned char* INTERNALTRACEEVENTUID(catstatic) = 0; \
486     WTF_ANNOTATE_BENIGN_RACE(&INTERNALTRACEEVENTUID(catstatic), \
487                              "trace_event category"); \
488     if (!INTERNALTRACEEVENTUID(catstatic)) \
489       INTERNALTRACEEVENTUID(catstatic) = \
490           TRACE_EVENT_API_GET_CATEGORY_ENABLED(category);
491
492 // Implementation detail: internal macro to create static category and add
493 // event if the category is enabled.
494 #if COMPILER(MSVC7_OR_LOWER)
495 #define INTERNAL_TRACE_EVENT_ADD(ignore) ((void)0)
496 #else
497 #define INTERNAL_TRACE_EVENT_ADD(phase, category, name, flags, ...) \
498     do { \
499         INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category); \
500         if (*INTERNALTRACEEVENTUID(catstatic)) { \
501             WebCore::TraceEvent::addTraceEvent( \
502                 phase, INTERNALTRACEEVENTUID(catstatic), name, \
503                 WebCore::TraceEvent::noEventId, flags, ##__VA_ARGS__); \
504         } \
505     } while (0)
506 #endif
507
508 // Implementation detail: internal macro to create static category and add begin
509 // event if the category is enabled. Also adds the end event when the scope
510 // ends.
511 #if COMPILER(MSVC7_OR_LOWER)
512 #define INTERNAL_TRACE_EVENT_ADD_SCOPED(ignore) ((void)0)
513 #else
514 #define INTERNAL_TRACE_EVENT_ADD_SCOPED(category, name, ...) \
515     INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category); \
516     WebCore::TraceEvent::TraceEndOnScopeClose \
517         INTERNALTRACEEVENTUID(profileScope); \
518     if (*INTERNALTRACEEVENTUID(catstatic)) { \
519       WebCore::TraceEvent::addTraceEvent( \
520           TRACE_EVENT_PHASE_BEGIN, \
521           INTERNALTRACEEVENTUID(catstatic), \
522           name, WebCore::TraceEvent::noEventId, \
523           TRACE_EVENT_FLAG_NONE, ##__VA_ARGS__); \
524       INTERNALTRACEEVENTUID(profileScope).initialize( \
525           INTERNALTRACEEVENTUID(catstatic), name); \
526     }
527 #endif
528
529 // Implementation detail: internal macro to create static category and add
530 // event if the category is enabled.
531 #if COMPILER(MSVC7_OR_LOWER)
532 #define INTERNAL_TRACE_EVENT_ADD_WITH_ID(ignore) ((void)0)
533 #else
534 #define INTERNAL_TRACE_EVENT_ADD_WITH_ID(phase, category, name, id, flags, \
535                                          ...) \
536     do { \
537         INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category); \
538         if (*INTERNALTRACEEVENTUID(catstatic)) { \
539             unsigned char traceEventFlags = flags | TRACE_EVENT_FLAG_HAS_ID; \
540             WebCore::TraceEvent::TraceID traceEventTraceID( \
541                 id, &traceEventFlags); \
542             WebCore::TraceEvent::addTraceEvent( \
543                 phase, INTERNALTRACEEVENTUID(catstatic), \
544                 name, traceEventTraceID.data(), traceEventFlags, \
545                 ##__VA_ARGS__); \
546         } \
547     } while (0)
548 #endif
549
550 // Implementation detail: internal macro to update a global state for
551 // the sampling profiler.
552 // FIXME: The current implementation uses only one global variable,
553 // and thus cannot trace states of multiple threads.
554 #if COMPILER(MSVC7_OR_LOWER)
555 #define INTERNAL_TRACE_EVENT_SAMPLING_STATE(ignore) ((void)0)
556 #else
557 #define INTERNAL_TRACE_EVENT_SAMPLING_STATE(name, threadBucket) \
558     do { \
559         *WebCore::traceSamplingState##threadBucket = reinterpret_cast<TraceEventAPIAtomicWord>("WebKit\0" name); \
560     } while (0);
561 #endif
562
563 // Notes regarding the following definitions:
564 // New values can be added and propagated to third party libraries, but existing
565 // definitions must never be changed, because third party libraries may use old
566 // definitions.
567
568 // Phase indicates the nature of an event entry. E.g. part of a begin/end pair.
569 #define TRACE_EVENT_PHASE_BEGIN    ('B')
570 #define TRACE_EVENT_PHASE_END      ('E')
571 #define TRACE_EVENT_PHASE_INSTANT  ('I')
572 #define TRACE_EVENT_PHASE_ASYNC_BEGIN ('S')
573 #define TRACE_EVENT_PHASE_ASYNC_STEP  ('T')
574 #define TRACE_EVENT_PHASE_ASYNC_END   ('F')
575 #define TRACE_EVENT_PHASE_METADATA ('M')
576 #define TRACE_EVENT_PHASE_COUNTER  ('C')
577 #define TRACE_EVENT_PHASE_SAMPLE  ('P')
578
579 // Flags for changing the behavior of TRACE_EVENT_API_ADD_TRACE_EVENT.
580 #define TRACE_EVENT_FLAG_NONE        (static_cast<unsigned char>(0))
581 #define TRACE_EVENT_FLAG_COPY        (static_cast<unsigned char>(1 << 0))
582 #define TRACE_EVENT_FLAG_HAS_ID      (static_cast<unsigned char>(1 << 1))
583 #define TRACE_EVENT_FLAG_MANGLE_ID   (static_cast<unsigned char>(1 << 2))
584
585 // Type values for identifying types in the TraceValue union.
586 #define TRACE_VALUE_TYPE_BOOL         (static_cast<unsigned char>(1))
587 #define TRACE_VALUE_TYPE_UINT         (static_cast<unsigned char>(2))
588 #define TRACE_VALUE_TYPE_INT          (static_cast<unsigned char>(3))
589 #define TRACE_VALUE_TYPE_DOUBLE       (static_cast<unsigned char>(4))
590 #define TRACE_VALUE_TYPE_POINTER      (static_cast<unsigned char>(5))
591 #define TRACE_VALUE_TYPE_STRING       (static_cast<unsigned char>(6))
592 #define TRACE_VALUE_TYPE_COPY_STRING  (static_cast<unsigned char>(7))
593
594
595 namespace WebCore {
596
597 namespace TraceEvent {
598
599 // Specify these values when the corresponding argument of addTraceEvent is not
600 // used.
601 const int zeroNumArgs = 0;
602 const unsigned long long noEventId = 0;
603
604 // TraceID encapsulates an ID that can either be an integer or pointer. Pointers
605 // are mangled with the Process ID so that they are unlikely to collide when the
606 // same pointer is used on different processes.
607 class TraceID {
608 public:
609     explicit TraceID(const void* id, unsigned char* flags) :
610         m_data(static_cast<unsigned long long>(reinterpret_cast<unsigned long>(id)))
611     {
612         *flags |= TRACE_EVENT_FLAG_MANGLE_ID;
613     }
614     explicit TraceID(unsigned long long id, unsigned char* flags) : m_data(id) { (void)flags; }
615     explicit TraceID(unsigned long id, unsigned char* flags) : m_data(id) { (void)flags; }
616     explicit TraceID(unsigned int id, unsigned char* flags) : m_data(id) { (void)flags; }
617     explicit TraceID(unsigned short id, unsigned char* flags) : m_data(id) { (void)flags; }
618     explicit TraceID(unsigned char id, unsigned char* flags) : m_data(id) { (void)flags; }
619     explicit TraceID(long long id, unsigned char* flags) :
620         m_data(static_cast<unsigned long long>(id)) { (void)flags; }
621     explicit TraceID(long id, unsigned char* flags) :
622         m_data(static_cast<unsigned long long>(id)) { (void)flags; }
623     explicit TraceID(int id, unsigned char* flags) :
624         m_data(static_cast<unsigned long long>(id)) { (void)flags; }
625     explicit TraceID(short id, unsigned char* flags) :
626         m_data(static_cast<unsigned long long>(id)) { (void)flags; }
627     explicit TraceID(signed char id, unsigned char* flags) :
628         m_data(static_cast<unsigned long long>(id)) { (void)flags; }
629
630     unsigned long long data() const { return m_data; }
631
632 private:
633     unsigned long long m_data;
634 };
635
636 // Simple union to store various types as unsigned long long.
637 union TraceValueUnion {
638     bool m_bool;
639     unsigned long long m_uint;
640     long long m_int;
641     double m_double;
642     const void* m_pointer;
643     const char* m_string;
644 };
645
646 // Simple container for const char* that should be copied instead of retained.
647 class TraceStringWithCopy {
648 public:
649     explicit TraceStringWithCopy(const char* str) : m_str(str) { }
650     operator const char* () const { return m_str; }
651 private:
652     const char* m_str;
653 };
654
655 // Define setTraceValue for each allowed type. It stores the type and
656 // value in the return arguments. This allows this API to avoid declaring any
657 // structures so that it is portable to third_party libraries.
658 #define INTERNAL_DECLARE_SET_TRACE_VALUE(actual_type, \
659                                          union_member, \
660                                          value_type_id) \
661     static inline void setTraceValue(actual_type arg, \
662                                      unsigned char* type, \
663                                      unsigned long long* value) { \
664         TraceValueUnion typeValue; \
665         typeValue.union_member = arg; \
666         *type = value_type_id; \
667         *value = typeValue.m_uint; \
668     }
669 // Simpler form for int types that can be safely casted.
670 #define INTERNAL_DECLARE_SET_TRACE_VALUE_INT(actual_type, \
671                                              value_type_id) \
672     static inline void setTraceValue(actual_type arg, \
673                                      unsigned char* type, \
674                                      unsigned long long* value) { \
675         *type = value_type_id; \
676         *value = static_cast<unsigned long long>(arg); \
677     }
678
679 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned long long, TRACE_VALUE_TYPE_UINT)
680 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned int, TRACE_VALUE_TYPE_UINT)
681 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned short, TRACE_VALUE_TYPE_UINT)
682 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned char, TRACE_VALUE_TYPE_UINT)
683 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(long long, TRACE_VALUE_TYPE_INT)
684 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(int, TRACE_VALUE_TYPE_INT)
685 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(short, TRACE_VALUE_TYPE_INT)
686 INTERNAL_DECLARE_SET_TRACE_VALUE_INT(signed char, TRACE_VALUE_TYPE_INT)
687 INTERNAL_DECLARE_SET_TRACE_VALUE(bool, m_bool, TRACE_VALUE_TYPE_BOOL)
688 INTERNAL_DECLARE_SET_TRACE_VALUE(double, m_double, TRACE_VALUE_TYPE_DOUBLE)
689 INTERNAL_DECLARE_SET_TRACE_VALUE(const void*, m_pointer,
690                                  TRACE_VALUE_TYPE_POINTER)
691 INTERNAL_DECLARE_SET_TRACE_VALUE(const char*, m_string,
692                                  TRACE_VALUE_TYPE_STRING)
693 INTERNAL_DECLARE_SET_TRACE_VALUE(const TraceStringWithCopy&, m_string,
694                                  TRACE_VALUE_TYPE_COPY_STRING)
695
696 #undef INTERNAL_DECLARE_SET_TRACE_VALUE
697 #undef INTERNAL_DECLARE_SET_TRACE_VALUE_INT
698
699 // WTF::String version of setTraceValue so that trace arguments can be strings.
700 static inline void setTraceValue(const WTF::CString& arg,
701                                  unsigned char* type,
702                                  unsigned long long* value) {
703     TraceValueUnion typeValue;
704     typeValue.m_string = arg.data();
705     *type = TRACE_VALUE_TYPE_COPY_STRING;
706     *value = typeValue.m_uint;
707 }
708
709 // These addTraceEvent template functions are defined here instead of in the
710 // macro, because the arg values could be temporary string objects. In order to
711 // store pointers to the internal c_str and pass through to the tracing API, the
712 // arg values must live throughout these procedures.
713
714 static inline void addTraceEvent(char phase,
715                                 const unsigned char* categoryEnabled,
716                                 const char* name,
717                                 unsigned long long id,
718                                 unsigned char flags) {
719     TRACE_EVENT_API_ADD_TRACE_EVENT(
720         phase, categoryEnabled, name, id,
721         zeroNumArgs, 0, 0, 0,
722         flags);
723 }
724
725 template<class ARG1_TYPE>
726 static inline void addTraceEvent(char phase,
727                                 const unsigned char* categoryEnabled,
728                                 const char* name,
729                                 unsigned long long id,
730                                 unsigned char flags,
731                                 const char* arg1Name,
732                                 const ARG1_TYPE& arg1Val) {
733     const int numArgs = 1;
734     unsigned char argTypes[1];
735     unsigned long long argValues[1];
736     setTraceValue(arg1Val, &argTypes[0], &argValues[0]);
737     TRACE_EVENT_API_ADD_TRACE_EVENT(
738         phase, categoryEnabled, name, id,
739         numArgs, &arg1Name, argTypes, argValues,
740         flags);
741 }
742
743 template<class ARG1_TYPE, class ARG2_TYPE>
744 static inline void addTraceEvent(char phase,
745                                 const unsigned char* categoryEnabled,
746                                 const char* name,
747                                 unsigned long long id,
748                                 unsigned char flags,
749                                 const char* arg1Name,
750                                 const ARG1_TYPE& arg1Val,
751                                 const char* arg2Name,
752                                 const ARG2_TYPE& arg2Val) {
753     const int numArgs = 2;
754     const char* argNames[2] = { arg1Name, arg2Name };
755     unsigned char argTypes[2];
756     unsigned long long argValues[2];
757     setTraceValue(arg1Val, &argTypes[0], &argValues[0]);
758     setTraceValue(arg2Val, &argTypes[1], &argValues[1]);
759     return TRACE_EVENT_API_ADD_TRACE_EVENT(
760         phase, categoryEnabled, name, id,
761         numArgs, argNames, argTypes, argValues,
762         flags);
763 }
764
765 // Used by TRACE_EVENTx macro. Do not use directly.
766 class TraceEndOnScopeClose {
767 public:
768     // Note: members of m_data intentionally left uninitialized. See initialize.
769     TraceEndOnScopeClose() : m_pdata(0) { }
770     ~TraceEndOnScopeClose()
771     {
772         if (m_pdata)
773             addEventIfEnabled();
774     }
775
776     void initialize(const unsigned char* categoryEnabled,
777                     const char* name)
778     {
779         m_data.categoryEnabled = categoryEnabled;
780         m_data.name = name;
781         m_pdata = &m_data;
782     }
783
784 private:
785     // Add the end event if the category is still enabled.
786     void addEventIfEnabled()
787     {
788         // Only called when m_pdata is non-null.
789         if (*m_pdata->categoryEnabled) {
790             TRACE_EVENT_API_ADD_TRACE_EVENT(
791                 TRACE_EVENT_PHASE_END,
792                 m_pdata->categoryEnabled,
793                 m_pdata->name, noEventId,
794                 zeroNumArgs, 0, 0, 0,
795                 TRACE_EVENT_FLAG_NONE);
796         }
797     }
798
799     // This Data struct workaround is to avoid initializing all the members
800     // in Data during construction of this object, since this object is always
801     // constructed, even when tracing is disabled. If the members of Data were
802     // members of this class instead, compiler warnings occur about potential
803     // uninitialized accesses.
804     struct Data {
805         const unsigned char* categoryEnabled;
806         const char* name;
807     };
808     Data* m_pdata;
809     Data m_data;
810 };
811
812 } // namespace TraceEvent
813
814 } // namespace WebCore
815
816 #endif