GCC Code Coverage Report
Directory: ../ Exec Total Coverage
File: /home/iojs/build/workspace/node-test-commit-linux-coverage-daily/nodes/benchmark/out/../src/tracing/trace_event.h Lines: 59 63 93.7 %
Date: 2019-05-05 22:32:45 Branches: 75 132 56.8 %

Line Branch Exec Source
1
// Copyright 2015 the V8 project authors. All rights reserved.
2
// Use of this source code is governed by a BSD-style license that can be
3
// found in the LICENSE file.
4
5
#ifndef SRC_TRACING_TRACE_EVENT_H_
6
#define SRC_TRACING_TRACE_EVENT_H_
7
8
#include "node_platform.h"
9
#include "v8-platform.h"
10
#include "trace_event_common.h"
11
#include <atomic>
12
13
// This header file defines implementation details of how the trace macros in
14
// trace_event_common.h collect and store trace events. Anything not
15
// implementation-specific should go in trace_macros_common.h instead of here.
16
17
18
// The pointer returned from GetCategoryGroupEnabled() points to a
19
// value with zero or more of the following bits. Used in this class only.
20
// The TRACE_EVENT macros should only use the value as a bool.
21
// These values must be in sync with macro values in trace_log.h in
22
// chromium.
23
enum CategoryGroupEnabledFlags {
24
  // Category group enabled for the recording mode.
25
  kEnabledForRecording_CategoryGroupEnabledFlags = 1 << 0,
26
  // Category group enabled by SetEventCallbackEnabled().
27
  kEnabledForEventCallback_CategoryGroupEnabledFlags = 1 << 2,
28
  // Category group enabled to export events to ETW.
29
  kEnabledForETWExport_CategoryGroupEnabledFlags = 1 << 3,
30
};
31
32
// By default, const char* argument values are assumed to have long-lived scope
33
// and will not be copied. Use this macro to force a const char* to be copied.
34
#define TRACE_STR_COPY(str) node::tracing::TraceStringWithCopy(str)
35
36
// By default, uint64 ID argument values are not mangled with the Process ID in
37
// TRACE_EVENT_ASYNC macros. Use this macro to force Process ID mangling.
38
#define TRACE_ID_MANGLE(id) node::tracing::TraceID::ForceMangle(id)
39
40
// By default, pointers are mangled with the Process ID in TRACE_EVENT_ASYNC
41
// macros. Use this macro to prevent Process ID mangling.
42
#define TRACE_ID_DONT_MANGLE(id) node::tracing::TraceID::DontMangle(id)
43
44
// By default, trace IDs are eventually converted to a single 64-bit number. Use
45
// this macro to add a scope string.
46
#define TRACE_ID_WITH_SCOPE(scope, id) \
47
  trace_event_internal::TraceID::WithScope(scope, id)
48
49
#define INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE() \
50
  *INTERNAL_TRACE_EVENT_UID(category_group_enabled) &                    \
51
      (kEnabledForRecording_CategoryGroupEnabledFlags |                  \
52
       kEnabledForEventCallback_CategoryGroupEnabledFlags)
53
54
// The following macro has no implementation, but it needs to exist since
55
// it gets called from scoped trace events. It cannot call UNIMPLEMENTED()
56
// since an empty implementation is a valid one.
57
#define INTERNAL_TRACE_MEMORY(category, name)
58
59
////////////////////////////////////////////////////////////////////////////////
60
// Implementation specific tracing API definitions.
61
62
// Get a pointer to the enabled state of the given trace category. Only
63
// long-lived literal strings should be given as the category group. The
64
// returned pointer can be held permanently in a local static for example. If
65
// the unsigned char is non-zero, tracing is enabled. If tracing is enabled,
66
// TRACE_EVENT_API_ADD_TRACE_EVENT can be called. It's OK if tracing is disabled
67
// between the load of the tracing state and the call to
68
// TRACE_EVENT_API_ADD_TRACE_EVENT, because this flag only provides an early out
69
// for best performance when tracing is disabled.
70
// const uint8_t*
71
//     TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED(const char* category_group)
72
#define TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED              \
73
  node::tracing::TraceEventHelper::GetTracingController()       \
74
      ->GetCategoryGroupEnabled
75
76
// Get the number of times traces have been recorded. This is used to implement
77
// the TRACE_EVENT_IS_NEW_TRACE facility.
78
// unsigned int TRACE_EVENT_API_GET_NUM_TRACES_RECORDED()
79
#define TRACE_EVENT_API_GET_NUM_TRACES_RECORDED UNIMPLEMENTED()
80
81
// Add a trace event to the platform tracing system.
82
// uint64_t TRACE_EVENT_API_ADD_TRACE_EVENT(
83
//                    char phase,
84
//                    const uint8_t* category_group_enabled,
85
//                    const char* name,
86
//                    const char* scope,
87
//                    uint64_t id,
88
//                    uint64_t bind_id,
89
//                    int num_args,
90
//                    const char** arg_names,
91
//                    const uint8_t* arg_types,
92
//                    const uint64_t* arg_values,
93
//                    unsigned int flags)
94
#define TRACE_EVENT_API_ADD_TRACE_EVENT node::tracing::AddTraceEventImpl
95
96
// Add a trace event to the platform tracing system.
97
// uint64_t TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_TIMESTAMP(
98
//                    char phase,
99
//                    const uint8_t* category_group_enabled,
100
//                    const char* name,
101
//                    const char* scope,
102
//                    uint64_t id,
103
//                    uint64_t bind_id,
104
//                    int num_args,
105
//                    const char** arg_names,
106
//                    const uint8_t* arg_types,
107
//                    const uint64_t* arg_values,
108
//                    unsigned int flags,
109
//                    int64_t timestamp)
110
#define TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_TIMESTAMP \
111
  node::tracing::AddTraceEventWithTimestampImpl
112
113
// Set the duration field of a COMPLETE trace event.
114
// void TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION(
115
//     const uint8_t* category_group_enabled,
116
//     const char* name,
117
//     uint64_t id)
118
#define TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION             \
119
  node::tracing::TraceEventHelper::GetTracingController()       \
120
      ->UpdateTraceEventDuration
121
122
// Adds a metadata event to the trace log. The |AppendValueAsTraceFormat| method
123
// on the convertable value will be called at flush time.
124
// TRACE_EVENT_API_ADD_METADATA_EVENT(
125
//     const unsigned char* category_group_enabled,
126
//     const char* event_name,
127
//     const char* arg_name,
128
//     std::unique_ptr<ConvertableToTraceFormat> arg_value)
129
#define TRACE_EVENT_API_ADD_METADATA_EVENT node::tracing::AddMetadataEvent
130
131
// Defines atomic operations used internally by the tracing system.
132
#define TRACE_EVENT_API_ATOMIC_WORD std::atomic<intptr_t>
133
#define TRACE_EVENT_API_ATOMIC_WORD_VALUE intptr_t
134
#define TRACE_EVENT_API_ATOMIC_LOAD(var) (var).load()
135
#define TRACE_EVENT_API_ATOMIC_STORE(var, value) (var).store(value)
136
137
////////////////////////////////////////////////////////////////////////////////
138
139
// Implementation detail: trace event macros create temporary variables
140
// to keep instrumentation overhead low. These macros give each temporary
141
// variable a unique name based on the line number to prevent name collisions.
142
#define INTERNAL_TRACE_EVENT_UID3(a, b) trace_event_unique_##a##b
143
#define INTERNAL_TRACE_EVENT_UID2(a, b) INTERNAL_TRACE_EVENT_UID3(a, b)
144
#define INTERNAL_TRACE_EVENT_UID(name_prefix) \
145
  INTERNAL_TRACE_EVENT_UID2(name_prefix, __LINE__)
146
147
// Implementation detail: internal macro to create static category.
148
// No barriers are needed, because this code is designed to operate safely
149
// even when the unsigned char* points to garbage data (which may be the case
150
// on processors without cache coherency).
151
// TODO(fmeawad): This implementation contradicts that we can have a different
152
// configuration for each isolate,
153
// https://code.google.com/p/v8/issues/detail?id=4563
154
#define INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO_CUSTOM_VARIABLES(             \
155
    category_group, atomic, category_group_enabled)                          \
156
  category_group_enabled =                                                   \
157
      reinterpret_cast<const uint8_t*>(TRACE_EVENT_API_ATOMIC_LOAD(atomic)); \
158
  if (!category_group_enabled) {                                             \
159
    category_group_enabled =                                                 \
160
        TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED(category_group);          \
161
    TRACE_EVENT_API_ATOMIC_STORE(                                            \
162
        atomic, reinterpret_cast<TRACE_EVENT_API_ATOMIC_WORD_VALUE>(         \
163
                    category_group_enabled));                                \
164
  }
165
166
#define INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group)             \
167
  static TRACE_EVENT_API_ATOMIC_WORD INTERNAL_TRACE_EVENT_UID(atomic) {0}; \
168
  const uint8_t* INTERNAL_TRACE_EVENT_UID(category_group_enabled);         \
169
  INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO_CUSTOM_VARIABLES(                 \
170
      category_group, INTERNAL_TRACE_EVENT_UID(atomic),                    \
171
      INTERNAL_TRACE_EVENT_UID(category_group_enabled));
172
173
// Implementation detail: internal macro to create static category and add
174
// event if the category is enabled.
175
#define INTERNAL_TRACE_EVENT_ADD(phase, category_group, name, flags, ...)    \
176
  do {                                                                       \
177
    INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group);                  \
178
    if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) {  \
179
      node::tracing::AddTraceEvent(                                          \
180
          phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), name,     \
181
          node::tracing::kGlobalScope, node::tracing::kNoId,                 \
182
          node::tracing::kNoId, flags, ##__VA_ARGS__);                       \
183
    }                                                                        \
184
  } while (0)
185
186
// Implementation detail: internal macro to create static category and add begin
187
// event if the category is enabled. Also adds the end event when the scope
188
// ends.
189
#define INTERNAL_TRACE_EVENT_ADD_SCOPED(category_group, name, ...)           \
190
  INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group);                    \
191
  node::tracing::ScopedTracer INTERNAL_TRACE_EVENT_UID(tracer);              \
192
  if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) {    \
193
    uint64_t h = node::tracing::AddTraceEvent(                               \
194
        TRACE_EVENT_PHASE_COMPLETE,                                          \
195
        INTERNAL_TRACE_EVENT_UID(category_group_enabled), name,              \
196
        node::tracing::kGlobalScope, node::tracing::kNoId,                   \
197
        node::tracing::kNoId, TRACE_EVENT_FLAG_NONE, ##__VA_ARGS__);         \
198
    INTERNAL_TRACE_EVENT_UID(tracer)                                         \
199
        .Initialize(INTERNAL_TRACE_EVENT_UID(category_group_enabled), name,  \
200
                    h);                                                      \
201
  }
202
203
#define INTERNAL_TRACE_EVENT_ADD_SCOPED_WITH_FLOW(category_group, name,     \
204
                                                  bind_id, flow_flags, ...) \
205
  INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group);                   \
206
  node::tracing::ScopedTracer INTERNAL_TRACE_EVENT_UID(tracer);             \
207
  if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) {   \
208
    unsigned int trace_event_flags = flow_flags;                            \
209
    node::tracing::TraceID trace_event_bind_id(bind_id,                     \
210
                                               &trace_event_flags);         \
211
    uint64_t h = node::tracing::AddTraceEvent(                              \
212
        TRACE_EVENT_PHASE_COMPLETE,                                         \
213
        INTERNAL_TRACE_EVENT_UID(category_group_enabled), name,             \
214
        node::tracing::kGlobalScope, node::tracing::kNoId,                  \
215
        trace_event_bind_id.raw_id(), trace_event_flags, ##__VA_ARGS__);    \
216
    INTERNAL_TRACE_EVENT_UID(tracer)                                        \
217
        .Initialize(INTERNAL_TRACE_EVENT_UID(category_group_enabled), name, \
218
                    h);                                                     \
219
  }
220
221
// Implementation detail: internal macro to create static category and add
222
// event if the category is enabled.
223
#define INTERNAL_TRACE_EVENT_ADD_WITH_ID(phase, category_group, name, id,      \
224
                                         flags, ...)                           \
225
  do {                                                                         \
226
    INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group);                    \
227
    if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) {    \
228
      unsigned int trace_event_flags = flags | TRACE_EVENT_FLAG_HAS_ID;        \
229
      node::tracing::TraceID trace_event_trace_id(id,                          \
230
                                                  &trace_event_flags);         \
231
      node::tracing::AddTraceEvent(                                            \
232
          phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), name,       \
233
          trace_event_trace_id.scope(), trace_event_trace_id.raw_id(),         \
234
          node::tracing::kNoId, trace_event_flags, ##__VA_ARGS__);             \
235
    }                                                                          \
236
  } while (0)
237
238
// Adds a trace event with a given timestamp.
239
#define INTERNAL_TRACE_EVENT_ADD_WITH_TIMESTAMP(phase, category_group, name, \
240
                                                timestamp, flags, ...)       \
241
  do {                                                                       \
242
    INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group);                  \
243
    if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) {  \
244
      node::tracing::AddTraceEventWithTimestamp(                     \
245
          phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), name,     \
246
          node::tracing::kGlobalScope, node::tracing::kNoId, \
247
          node::tracing::kNoId, flags, timestamp, ##__VA_ARGS__);    \
248
    }                                                                        \
249
  } while (0)
250
251
// Adds a trace event with a given id and timestamp. Not Implemented.
252
#define INTERNAL_TRACE_EVENT_ADD_WITH_ID_AND_TIMESTAMP(     \
253
    phase, category_group, name, id, timestamp, flags, ...) \
254
  UNIMPLEMENTED()
255
256
// Adds a trace event with a given id, thread_id, and timestamp. Not
257
// Implemented.
258
#define INTERNAL_TRACE_EVENT_ADD_WITH_ID_TID_AND_TIMESTAMP(                  \
259
    phase, category_group, name, id, thread_id, timestamp, flags, ...)       \
260
  do {                                                                       \
261
    INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group);                  \
262
    if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) {  \
263
      unsigned int trace_event_flags = flags | TRACE_EVENT_FLAG_HAS_ID;      \
264
      node::tracing::TraceID trace_event_trace_id(id,                        \
265
                                                  &trace_event_flags);       \
266
      node::tracing::AddTraceEventWithTimestamp(                             \
267
          phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), name,     \
268
          trace_event_trace_id.scope(), trace_event_trace_id.raw_id(),       \
269
          node::tracing::kNoId, trace_event_flags, timestamp, ##__VA_ARGS__);\
270
    }                                                                        \
271
  } while (0)
272
273
#define INTERNAL_TRACE_EVENT_METADATA_ADD(category_group, name, ...)  \
274
  do { \
275
    INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group); \
276
    if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \
277
      TRACE_EVENT_API_ADD_METADATA_EVENT( \
278
          INTERNAL_TRACE_EVENT_UID(category_group_enabled), name, \
279
          ##__VA_ARGS__); \
280
    } \
281
  } while(0)
282
283
// Enter and leave a context based on the current scope.
284
#define INTERNAL_TRACE_EVENT_SCOPED_CONTEXT(category_group, name, context) \
285
  struct INTERNAL_TRACE_EVENT_UID(ScopedContext) {                         \
286
   public:                                                                 \
287
    INTERNAL_TRACE_EVENT_UID(ScopedContext)(uint64_t cid) : cid_(cid) {    \
288
      TRACE_EVENT_ENTER_CONTEXT(category_group, name, cid_);               \
289
    }                                                                      \
290
    ~INTERNAL_TRACE_EVENT_UID(ScopedContext)() {                           \
291
      TRACE_EVENT_LEAVE_CONTEXT(category_group, name, cid_);               \
292
    }                                                                      \
293
                                                                           \
294
   private:                                                                \
295
    /* Local class friendly DISALLOW_COPY_AND_ASSIGN */                    \
296
    INTERNAL_TRACE_EVENT_UID(ScopedContext)                                \
297
    (const INTERNAL_TRACE_EVENT_UID(ScopedContext)&) {}                    \
298
    void operator=(const INTERNAL_TRACE_EVENT_UID(ScopedContext)&) {}      \
299
    uint64_t cid_;                                                         \
300
  };                                                                       \
301
  INTERNAL_TRACE_EVENT_UID(ScopedContext)                                  \
302
  INTERNAL_TRACE_EVENT_UID(scoped_context)(context);
303
304
namespace node {
305
namespace tracing {
306
307
// Specify these values when the corresponding argument of AddTraceEvent is not
308
// used.
309
const int kZeroNumArgs = 0;
310
const decltype(nullptr) kGlobalScope = nullptr;
311
const uint64_t kNoId = 0;
312
313
class TraceEventHelper {
314
 public:
315
  static TracingController* GetTracingController();
316
  static Agent* GetAgent();
317
  static void SetAgent(Agent* agent);
318
};
319
320
// TraceID encapsulates an ID that can either be an integer or pointer. Pointers
321
// are by default mangled with the Process ID so that they are unlikely to
322
// collide when the same pointer is used on different processes.
323
class TraceID {
324
 public:
325
  class WithScope {
326
   public:
327
    WithScope(const char* scope, uint64_t raw_id)
328
        : scope_(scope), raw_id_(raw_id) {}
329
    uint64_t raw_id() const { return raw_id_; }
330
    const char* scope() const { return scope_; }
331
332
   private:
333
    const char* scope_ = nullptr;
334
    uint64_t raw_id_;
335
  };
336
337
  class DontMangle {
338
   public:
339
    explicit DontMangle(const void* raw_id)
340
        : raw_id_(static_cast<uint64_t>(reinterpret_cast<uintptr_t>(raw_id))) {}
341
    explicit DontMangle(uint64_t raw_id) : raw_id_(raw_id) {}
342
    explicit DontMangle(unsigned int raw_id) : raw_id_(raw_id) {}
343
    explicit DontMangle(uint16_t raw_id) : raw_id_(raw_id) {}
344
    explicit DontMangle(unsigned char raw_id) : raw_id_(raw_id) {}
345
    explicit DontMangle(int64_t raw_id)
346
        : raw_id_(static_cast<uint64_t>(raw_id)) {}
347
    explicit DontMangle(int raw_id) : raw_id_(static_cast<uint64_t>(raw_id)) {}
348
    explicit DontMangle(int16_t raw_id)
349
        : raw_id_(static_cast<uint64_t>(raw_id)) {}
350
    explicit DontMangle(signed char raw_id)
351
        : raw_id_(static_cast<uint64_t>(raw_id)) {}
352
    explicit DontMangle(WithScope scoped_id)
353
        : scope_(scoped_id.scope()), raw_id_(scoped_id.raw_id()) {}
354
    const char* scope() const { return scope_; }
355
    uint64_t raw_id() const { return raw_id_; }
356
357
   private:
358
    const char* scope_ = nullptr;
359
    uint64_t raw_id_;
360
  };
361
362
  class ForceMangle {
363
   public:
364
    explicit ForceMangle(uint64_t raw_id) : raw_id_(raw_id) {}
365
    explicit ForceMangle(unsigned int raw_id) : raw_id_(raw_id) {}
366
    explicit ForceMangle(uint16_t raw_id) : raw_id_(raw_id) {}
367
    explicit ForceMangle(unsigned char raw_id) : raw_id_(raw_id) {}
368
    explicit ForceMangle(int64_t raw_id)
369
        : raw_id_(static_cast<uint64_t>(raw_id)) {}
370
    explicit ForceMangle(int raw_id) : raw_id_(static_cast<uint64_t>(raw_id)) {}
371
    explicit ForceMangle(int16_t raw_id)
372
        : raw_id_(static_cast<uint64_t>(raw_id)) {}
373
    explicit ForceMangle(signed char raw_id)
374
        : raw_id_(static_cast<uint64_t>(raw_id)) {}
375
    uint64_t raw_id() const { return raw_id_; }
376
377
   private:
378
    uint64_t raw_id_;
379
  };
380
381
162
  TraceID(const void* raw_id, unsigned int* flags)
382
162
      : raw_id_(static_cast<uint64_t>(reinterpret_cast<uintptr_t>(raw_id))) {
383
162
    *flags |= TRACE_EVENT_FLAG_MANGLE_ID;
384
162
  }
385
  TraceID(ForceMangle raw_id, unsigned int* flags) : raw_id_(raw_id.raw_id()) {
386
    *flags |= TRACE_EVENT_FLAG_MANGLE_ID;
387
  }
388
  TraceID(DontMangle maybe_scoped_id, unsigned int* flags)
389
      : scope_(maybe_scoped_id.scope()), raw_id_(maybe_scoped_id.raw_id()) {}
390
  TraceID(uint64_t raw_id, unsigned int* flags) : raw_id_(raw_id) {
391
    (void)flags;
392
  }
393
  TraceID(unsigned int raw_id, unsigned int* flags) : raw_id_(raw_id) {
394
    (void)flags;
395
  }
396
  TraceID(uint16_t raw_id, unsigned int* flags) : raw_id_(raw_id) {
397
    (void)flags;
398
  }
399
  TraceID(unsigned char raw_id, unsigned int* flags) : raw_id_(raw_id) {
400
    (void)flags;
401
  }
402
74
  TraceID(int64_t raw_id, unsigned int* flags)
403
74
      : raw_id_(static_cast<uint64_t>(raw_id)) {
404
    (void)flags;
405
74
  }
406
  TraceID(int raw_id, unsigned int* flags)
407
      : raw_id_(static_cast<uint64_t>(raw_id)) {
408
    (void)flags;
409
  }
410
  TraceID(int16_t raw_id, unsigned int* flags)
411
      : raw_id_(static_cast<uint64_t>(raw_id)) {
412
    (void)flags;
413
  }
414
  TraceID(signed char raw_id, unsigned int* flags)
415
      : raw_id_(static_cast<uint64_t>(raw_id)) {
416
    (void)flags;
417
  }
418
  TraceID(WithScope scoped_id, unsigned int* flags)
419
      : scope_(scoped_id.scope()), raw_id_(scoped_id.raw_id()) {}
420
421
236
  uint64_t raw_id() const { return raw_id_; }
422
236
  const char* scope() const { return scope_; }
423
424
 private:
425
  const char* scope_ = nullptr;
426
  uint64_t raw_id_;
427
};
428
429
// Simple union to store various types as uint64_t.
430
union TraceValueUnion {
431
  bool as_bool;
432
  uint64_t as_uint;
433
  int64_t as_int;
434
  double as_double;
435
  const void* as_pointer;
436
  const char* as_string;
437
};
438
439
// Simple container for const char* that should be copied instead of retained.
440
class TraceStringWithCopy {
441
 public:
442
96
  explicit TraceStringWithCopy(const char* str) : str_(str) {}
443
96
  operator const char*() const { return str_; }
444
445
 private:
446
  const char* str_;
447
};
448
449
579
static inline uint64_t AddTraceEventImpl(
450
    char phase, const uint8_t* category_group_enabled, const char* name,
451
    const char* scope, uint64_t id, uint64_t bind_id, int32_t num_args,
452
    const char** arg_names, const uint8_t* arg_types,
453
    const uint64_t* arg_values, unsigned int flags) {
454
1737
  std::unique_ptr<v8::ConvertableToTraceFormat> arg_convertibles[2];
455

579
  if (num_args > 0 && arg_types[0] == TRACE_VALUE_TYPE_CONVERTABLE) {
456
    arg_convertibles[0].reset(reinterpret_cast<v8::ConvertableToTraceFormat*>(
457
25
        static_cast<intptr_t>(arg_values[0])));
458
  }
459

579
  if (num_args > 1 && arg_types[1] == TRACE_VALUE_TYPE_CONVERTABLE) {
460
    arg_convertibles[1].reset(reinterpret_cast<v8::ConvertableToTraceFormat*>(
461
        static_cast<intptr_t>(arg_values[1])));
462
  }
463
  // DCHECK(num_args, 2);
464
  v8::TracingController* controller =
465
579
      node::tracing::TraceEventHelper::GetTracingController();
466
  return controller->AddTraceEvent(phase, category_group_enabled, name, scope, id,
467
                                   bind_id, num_args, arg_names, arg_types,
468
1737
                                   arg_values, arg_convertibles, flags);
469
}
470
471
static V8_INLINE uint64_t AddTraceEventWithTimestampImpl(
472
    char phase, const uint8_t* category_group_enabled, const char* name,
473
    const char* scope, uint64_t id, uint64_t bind_id, int32_t num_args,
474
    const char** arg_names, const uint8_t* arg_types,
475
    const uint64_t* arg_values, unsigned int flags, int64_t timestamp) {
476



195
  std::unique_ptr<v8::ConvertableToTraceFormat> arg_convertables[2];
477






65
  if (num_args > 0 && arg_types[0] == TRACE_VALUE_TYPE_CONVERTABLE) {
478
    arg_convertables[0].reset(reinterpret_cast<v8::ConvertableToTraceFormat*>(
479
        static_cast<intptr_t>(arg_values[0])));
480
  }
481






65
  if (num_args > 1 && arg_types[1] == TRACE_VALUE_TYPE_CONVERTABLE) {
482
    arg_convertables[1].reset(reinterpret_cast<v8::ConvertableToTraceFormat*>(
483
        static_cast<intptr_t>(arg_values[1])));
484
  }
485
  // DCHECK_LE(num_args, 2);
486
  v8::TracingController* controller =
487
65
      node::tracing::TraceEventHelper::GetTracingController();
488
  return controller->AddTraceEventWithTimestamp(
489
      phase, category_group_enabled, name, scope, id, bind_id, num_args,
490



65
      arg_names, arg_types, arg_values, arg_convertables, flags, timestamp);
491
}
492
493
static V8_INLINE void AddMetadataEventImpl(
494
    const uint8_t* category_group_enabled, const char* name, int32_t num_args,
495
    const char** arg_names, const uint8_t* arg_types,
496
    const uint64_t* arg_values, unsigned int flags) {
497


1867
  std::unique_ptr<v8::ConvertableToTraceFormat> arg_convertibles[2];
498




624
  if (num_args > 0 && arg_types[0] == TRACE_VALUE_TYPE_CONVERTABLE) {
499
    arg_convertibles[0].reset(reinterpret_cast<v8::ConvertableToTraceFormat*>(
500
72
        static_cast<intptr_t>(arg_values[0])));
501
  }
502




622
  if (num_args > 1 && arg_types[1] == TRACE_VALUE_TYPE_CONVERTABLE) {
503
    arg_convertibles[1].reset(reinterpret_cast<v8::ConvertableToTraceFormat*>(
504
        static_cast<intptr_t>(arg_values[1])));
505
  }
506
  node::tracing::TracingController* controller =
507
622
      node::tracing::TraceEventHelper::GetTracingController();
508
  return controller->AddMetadataEvent(
509
      category_group_enabled, name, num_args, arg_names, arg_types, arg_values,
510


624
      arg_convertibles, flags);
511
}
512
513
// Define SetTraceValue for each allowed type. It stores the type and
514
// value in the return arguments. This allows this API to avoid declaring any
515
// structures so that it is portable to third_party libraries.
516
#define INTERNAL_DECLARE_SET_TRACE_VALUE(actual_type, union_member,         \
517
                                         value_type_id)                     \
518
  static inline void SetTraceValue(actual_type arg, unsigned char* type,    \
519
                                   uint64_t* value) {                       \
520
    TraceValueUnion type_value;                                             \
521
    type_value.union_member = arg;                                          \
522
    *type = value_type_id;                                                  \
523
    *value = type_value.as_uint;                                            \
524
  }
525
// Simpler form for int types that can be safely casted.
526
#define INTERNAL_DECLARE_SET_TRACE_VALUE_INT(actual_type, value_type_id)    \
527
  static inline void SetTraceValue(actual_type arg, unsigned char* type,    \
528
                                   uint64_t* value) {                       \
529
    *type = value_type_id;                                                  \
530
    *value = static_cast<uint64_t>(arg);                                    \
531
  }
532
533
1
INTERNAL_DECLARE_SET_TRACE_VALUE_INT(uint64_t, TRACE_VALUE_TYPE_UINT)
534
1
INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned int, TRACE_VALUE_TYPE_UINT)
535
INTERNAL_DECLARE_SET_TRACE_VALUE_INT(uint16_t, TRACE_VALUE_TYPE_UINT)
536
INTERNAL_DECLARE_SET_TRACE_VALUE_INT(unsigned char, TRACE_VALUE_TYPE_UINT)
537
INTERNAL_DECLARE_SET_TRACE_VALUE_INT(int64_t, TRACE_VALUE_TYPE_INT)
538
41
INTERNAL_DECLARE_SET_TRACE_VALUE_INT(int, TRACE_VALUE_TYPE_INT)
539
INTERNAL_DECLARE_SET_TRACE_VALUE_INT(int16_t, TRACE_VALUE_TYPE_INT)
540
INTERNAL_DECLARE_SET_TRACE_VALUE_INT(signed char, TRACE_VALUE_TYPE_INT)
541
1
INTERNAL_DECLARE_SET_TRACE_VALUE(bool, as_bool, TRACE_VALUE_TYPE_BOOL)
542
INTERNAL_DECLARE_SET_TRACE_VALUE(double, as_double, TRACE_VALUE_TYPE_DOUBLE)
543
INTERNAL_DECLARE_SET_TRACE_VALUE(const void*, as_pointer,
544
                                 TRACE_VALUE_TYPE_POINTER)
545
478
INTERNAL_DECLARE_SET_TRACE_VALUE(const char*, as_string,
546
                                 TRACE_VALUE_TYPE_STRING)
547
96
INTERNAL_DECLARE_SET_TRACE_VALUE(const TraceStringWithCopy&, as_string,
548
                                 TRACE_VALUE_TYPE_COPY_STRING)
549
550
#undef INTERNAL_DECLARE_SET_TRACE_VALUE
551
#undef INTERNAL_DECLARE_SET_TRACE_VALUE_INT
552
553
97
static inline void SetTraceValue(v8::ConvertableToTraceFormat* convertable_value,
554
                                    unsigned char* type, uint64_t* value) {
555
97
  *type = TRACE_VALUE_TYPE_CONVERTABLE;
556
97
  *value = static_cast<uint64_t>(reinterpret_cast<intptr_t>(convertable_value));
557
97
}
558
559
template <typename T>
560
static inline typename std::enable_if<
561
    std::is_convertible<T*, v8::ConvertableToTraceFormat*>::value>::type
562
97
SetTraceValue(std::unique_ptr<T> ptr, unsigned char* type, uint64_t* value) {
563
97
  SetTraceValue(ptr.release(), type, value);
564
97
}
565
566
// These AddTraceEvent template
567
// function is defined here instead of in the macro, because the arg_values
568
// could be temporary objects, such as std::string. In order to store
569
// pointers to the internal c_str and pass through to the tracing API,
570
// the arg_values must live throughout these procedures.
571
572
493
static inline uint64_t AddTraceEvent(char phase,
573
                                        const uint8_t* category_group_enabled,
574
                                        const char* name, const char* scope,
575
                                        uint64_t id, uint64_t bind_id,
576
                                        unsigned int flags) {
577
  return TRACE_EVENT_API_ADD_TRACE_EVENT(phase, category_group_enabled, name,
578
                                         scope, id, bind_id, kZeroNumArgs,
579
493
                                         nullptr, nullptr, nullptr, flags);
580
}
581
582
template <class ARG1_TYPE>
583
78
static inline uint64_t AddTraceEvent(
584
    char phase, const uint8_t* category_group_enabled, const char* name,
585
    const char* scope, uint64_t id, uint64_t bind_id, unsigned int flags,
586
    const char* arg1_name, ARG1_TYPE&& arg1_val) {
587
78
  const int num_args = 1;
588
  uint8_t arg_type;
589
  uint64_t arg_value;
590
78
  SetTraceValue(std::forward<ARG1_TYPE>(arg1_val), &arg_type, &arg_value);
591
  return TRACE_EVENT_API_ADD_TRACE_EVENT(
592
      phase, category_group_enabled, name, scope, id, bind_id, num_args,
593
78
      &arg1_name, &arg_type, &arg_value, flags);
594
}
595
596
template <class ARG1_TYPE, class ARG2_TYPE>
597
8
static inline uint64_t AddTraceEvent(
598
    char phase, const uint8_t* category_group_enabled, const char* name,
599
    const char* scope, uint64_t id, uint64_t bind_id, unsigned int flags,
600
    const char* arg1_name, ARG1_TYPE&& arg1_val, const char* arg2_name,
601
    ARG2_TYPE&& arg2_val) {
602
8
  const int num_args = 2;
603
8
  const char* arg_names[2] = {arg1_name, arg2_name};
604
  unsigned char arg_types[2];
605
  uint64_t arg_values[2];
606
12
  SetTraceValue(std::forward<ARG1_TYPE>(arg1_val), &arg_types[0],
607
4
                &arg_values[0]);
608
14
  SetTraceValue(std::forward<ARG2_TYPE>(arg2_val), &arg_types[1],
609
6
                &arg_values[1]);
610
  return TRACE_EVENT_API_ADD_TRACE_EVENT(
611
      phase, category_group_enabled, name, scope, id, bind_id, num_args,
612
8
      arg_names, arg_types, arg_values, flags);
613
}
614
615
static V8_INLINE uint64_t AddTraceEventWithTimestamp(
616
    char phase, const uint8_t* category_group_enabled, const char* name,
617
    const char* scope, uint64_t id, uint64_t bind_id, unsigned int flags,
618
    int64_t timestamp) {
619
  return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_TIMESTAMP(
620
      phase, category_group_enabled, name, scope, id, bind_id, kZeroNumArgs,
621
130
      nullptr, nullptr, nullptr, flags, timestamp);
622
}
623
624
template <class ARG1_TYPE>
625
static V8_INLINE uint64_t AddTraceEventWithTimestamp(
626
    char phase, const uint8_t* category_group_enabled, const char* name,
627
    const char* scope, uint64_t id, uint64_t bind_id, unsigned int flags,
628
    int64_t timestamp, const char* arg1_name, ARG1_TYPE&& arg1_val) {
629
  const int num_args = 1;
630
  uint8_t arg_type;
631
  uint64_t arg_value;
632
  SetTraceValue(std::forward<ARG1_TYPE>(arg1_val), &arg_type, &arg_value);
633
  return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_TIMESTAMP(
634
      phase, category_group_enabled, name, scope, id, bind_id, num_args,
635
      &arg1_name, &arg_type, &arg_value, flags, timestamp);
636
}
637
638
template <class ARG1_TYPE, class ARG2_TYPE>
639
static V8_INLINE uint64_t AddTraceEventWithTimestamp(
640
    char phase, const uint8_t* category_group_enabled, const char* name,
641
    const char* scope, uint64_t id, uint64_t bind_id, unsigned int flags,
642
    int64_t timestamp, const char* arg1_name, ARG1_TYPE&& arg1_val,
643
    const char* arg2_name, ARG2_TYPE&& arg2_val) {
644
  const int num_args = 2;
645
  const char* arg_names[2] = {arg1_name, arg2_name};
646
  unsigned char arg_types[2];
647
  uint64_t arg_values[2];
648
  SetTraceValue(std::forward<ARG1_TYPE>(arg1_val), &arg_types[0],
649
                &arg_values[0]);
650
  SetTraceValue(std::forward<ARG2_TYPE>(arg2_val), &arg_types[1],
651
                &arg_values[1]);
652
  return TRACE_EVENT_API_ADD_TRACE_EVENT_WITH_TIMESTAMP(
653
      phase, category_group_enabled, name, scope, id, bind_id, num_args,
654
      arg_names, arg_types, arg_values, flags, timestamp);
655
}
656
657
template <class ARG1_TYPE>
658
static V8_INLINE void AddMetadataEvent(
659
    const uint8_t* category_group_enabled, const char* name,
660
    const char* arg1_name, ARG1_TYPE&& arg1_val) {
661
621
  const int num_args = 1;
662
  uint8_t arg_type;
663
  uint64_t arg_value;
664
621
  SetTraceValue(std::forward<ARG1_TYPE>(arg1_val), &arg_type, &arg_value);
665
  AddMetadataEventImpl(
666
      category_group_enabled, name, num_args, &arg1_name, &arg_type, &arg_value,
667
      TRACE_EVENT_FLAG_NONE);
668
}
669
670
// Used by TRACE_EVENTx macros. Do not use directly.
671
class ScopedTracer {
672
 public:
673
  // Note: members of data_ intentionally left uninitialized. See Initialize.
674
  ScopedTracer() : p_data_(nullptr) {}
675
676
  ~ScopedTracer() {
677
    if (p_data_ && *data_.category_group_enabled)
678
      TRACE_EVENT_API_UPDATE_TRACE_EVENT_DURATION(
679
          data_.category_group_enabled, data_.name, data_.event_handle);
680
  }
681
682
  void Initialize(const uint8_t* category_group_enabled, const char* name,
683
                  uint64_t event_handle) {
684
    data_.category_group_enabled = category_group_enabled;
685
    data_.name = name;
686
    data_.event_handle = event_handle;
687
    p_data_ = &data_;
688
  }
689
690
 private:
691
  // This Data struct workaround is to avoid initializing all the members
692
  // in Data during construction of this object, since this object is always
693
  // constructed, even when tracing is disabled. If the members of Data were
694
  // members of this class instead, compiler warnings occur about potential
695
  // uninitialized accesses.
696
  struct Data {
697
    const uint8_t* category_group_enabled;
698
    const char* name;
699
    uint64_t event_handle;
700
  };
701
  Data* p_data_;
702
  Data data_;
703
};
704
705
}  // namespace tracing
706
}  // namespace node
707
708
#endif  // SRC_TRACING_TRACE_EVENT_H_