GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: node_perf.cc Lines: 153 171 89.5 %
Date: 2022-04-06 04:15:27 Branches: 34 52 65.4 %

Line Branch Exec Source
1
#include "node_perf.h"
2
#include "aliased_buffer.h"
3
#include "env-inl.h"
4
#include "histogram-inl.h"
5
#include "memory_tracker-inl.h"
6
#include "node_buffer.h"
7
#include "node_external_reference.h"
8
#include "node_internals.h"
9
#include "node_process-inl.h"
10
#include "util-inl.h"
11
12
#include <cinttypes>
13
14
namespace node {
15
namespace performance {
16
17
using v8::Context;
18
using v8::DontDelete;
19
using v8::Function;
20
using v8::FunctionCallbackInfo;
21
using v8::FunctionTemplate;
22
using v8::GCCallbackFlags;
23
using v8::GCType;
24
using v8::Int32;
25
using v8::Integer;
26
using v8::Isolate;
27
using v8::Local;
28
using v8::MaybeLocal;
29
using v8::Number;
30
using v8::Object;
31
using v8::PropertyAttribute;
32
using v8::ReadOnly;
33
using v8::String;
34
using v8::Value;
35
36
// Microseconds in a millisecond, as a float.
37
#define MICROS_PER_MILLIS 1e3
38
39
// https://w3c.github.io/hr-time/#dfn-time-origin
40
const uint64_t timeOrigin = PERFORMANCE_NOW();
41
// https://w3c.github.io/hr-time/#dfn-time-origin-timestamp
42
const double timeOriginTimestamp = GetCurrentTimeInMicroseconds();
43
uint64_t performance_v8_start;
44
45
5607
PerformanceState::PerformanceState(Isolate* isolate,
46
5607
                                   const PerformanceState::SerializeInfo* info)
47
    : root(isolate,
48
           sizeof(performance_state_internal),
49
           MAYBE_FIELD_PTR(info, root)),
50
      milestones(isolate,
51
                 offsetof(performance_state_internal, milestones),
52
                 NODE_PERFORMANCE_MILESTONE_INVALID,
53
5607
                 root,
54
                 MAYBE_FIELD_PTR(info, milestones)),
55
      observers(isolate,
56
                offsetof(performance_state_internal, observers),
57
                NODE_PERFORMANCE_ENTRY_TYPE_INVALID,
58
5607
                root,
59

5607
                MAYBE_FIELD_PTR(info, observers)) {
60
5607
  if (info == nullptr) {
61
4424
    for (size_t i = 0; i < milestones.Length(); i++) milestones[i] = -1.;
62
  }
63
5607
}
64
65
6
PerformanceState::SerializeInfo PerformanceState::Serialize(
66
    v8::Local<v8::Context> context, v8::SnapshotCreator* creator) {
67
6
  SerializeInfo info{root.Serialize(context, creator),
68
6
                     milestones.Serialize(context, creator),
69
6
                     observers.Serialize(context, creator)};
70
6
  return info;
71
}
72
73
4975
void PerformanceState::Deserialize(v8::Local<v8::Context> context) {
74
4975
  root.Deserialize(context);
75
  // This is just done to set up the pointers, we will actually reset
76
  // all the milestones after deserialization.
77
4975
  milestones.Deserialize(context);
78
4975
  observers.Deserialize(context);
79
4975
}
80
81
6
std::ostream& operator<<(std::ostream& o,
82
                         const PerformanceState::SerializeInfo& i) {
83
  o << "{\n"
84
6
    << "  " << i.root << ",  // root\n"
85
6
    << "  " << i.milestones << ",  // milestones\n"
86
6
    << "  " << i.observers << ",  // observers\n"
87
6
    << "}";
88
6
  return o;
89
}
90
91
32678
void PerformanceState::Mark(PerformanceMilestone milestone, uint64_t ts) {
92
32678
  this->milestones[milestone] = static_cast<double>(ts);
93

37668
  TRACE_EVENT_INSTANT_WITH_TIMESTAMP0(
94
      TRACING_CATEGORY_NODE1(bootstrap),
95
      GetPerformanceMilestoneName(milestone),
96
      TRACE_EVENT_SCOPE_THREAD, ts / 1000);
97
32678
}
98
99
// Allows specific Node.js lifecycle milestones to be set from JavaScript
100
void MarkMilestone(const FunctionCallbackInfo<Value>& args) {
101
  Environment* env = Environment::GetCurrent(args);
102
  PerformanceMilestone milestone =
103
      static_cast<PerformanceMilestone>(args[0].As<Int32>()->Value());
104
  if (milestone != NODE_PERFORMANCE_MILESTONE_INVALID)
105
    env->performance_state()->Mark(milestone);
106
}
107
108
632
void SetupPerformanceObservers(const FunctionCallbackInfo<Value>& args) {
109
632
  Environment* env = Environment::GetCurrent(args);
110
632
  CHECK(args[0]->IsFunction());
111
1264
  env->set_performance_entry_callback(args[0].As<Function>());
112
632
}
113
114
// Marks the start of a GC cycle
115
1
void MarkGarbageCollectionStart(
116
    Isolate* isolate,
117
    GCType type,
118
    GCCallbackFlags flags,
119
    void* data) {
120
1
  Environment* env = static_cast<Environment*>(data);
121
1
  env->performance_state()->performance_last_gc_start_mark = PERFORMANCE_NOW();
122
1
}
123
124
1
MaybeLocal<Object> GCPerformanceEntryTraits::GetDetails(
125
    Environment* env,
126
    const GCPerformanceEntry& entry) {
127
1
  Local<Object> obj = Object::New(env->isolate());
128
129
2
  if (!obj->Set(
130
          env->context(),
131
          env->kind_string(),
132
          Integer::NewFromUnsigned(
133
              env->isolate(),
134
4
              entry.details.kind)).IsJust()) {
135
    return MaybeLocal<Object>();
136
  }
137
138
2
  if (!obj->Set(
139
          env->context(),
140
          env->flags_string(),
141
          Integer::NewFromUnsigned(
142
              env->isolate(),
143
4
              entry.details.flags)).IsJust()) {
144
    return MaybeLocal<Object>();
145
  }
146
147
1
  return obj;
148
}
149
150
// Marks the end of a GC cycle
151
1
void MarkGarbageCollectionEnd(
152
    Isolate* isolate,
153
    GCType type,
154
    GCCallbackFlags flags,
155
    void* data) {
156
1
  Environment* env = static_cast<Environment*>(data);
157
1
  PerformanceState* state = env->performance_state();
158
  // If no one is listening to gc performance entries, do not create them.
159
1
  if (LIKELY(!state->observers[NODE_PERFORMANCE_ENTRY_TYPE_GC]))
160
    return;
161
162
1
  double start_time = state->performance_last_gc_start_mark / 1e6;
163
1
  double duration = (PERFORMANCE_NOW() / 1e6) - start_time;
164
165
  std::unique_ptr<GCPerformanceEntry> entry =
166
      std::make_unique<GCPerformanceEntry>(
167
          "gc",
168
          start_time,
169
          duration,
170
1
          GCPerformanceEntry::Details(
171
            static_cast<PerformanceGCKind>(type),
172
1
            static_cast<PerformanceGCFlags>(flags)));
173
174
1
  env->SetImmediate([entry = std::move(entry)](Environment* env) {
175
1
    entry->Notify(env);
176
1
  }, CallbackFlags::kUnrefed);
177
}
178
179
4
void GarbageCollectionCleanupHook(void* data) {
180
4
  Environment* env = static_cast<Environment*>(data);
181
4
  env->isolate()->RemoveGCPrologueCallback(MarkGarbageCollectionStart, data);
182
4
  env->isolate()->RemoveGCEpilogueCallback(MarkGarbageCollectionEnd, data);
183
4
}
184
185
4
static void InstallGarbageCollectionTracking(
186
    const FunctionCallbackInfo<Value>& args) {
187
4
  Environment* env = Environment::GetCurrent(args);
188
189
4
  env->isolate()->AddGCPrologueCallback(MarkGarbageCollectionStart,
190
                                        static_cast<void*>(env));
191
4
  env->isolate()->AddGCEpilogueCallback(MarkGarbageCollectionEnd,
192
                                        static_cast<void*>(env));
193
4
  env->AddCleanupHook(GarbageCollectionCleanupHook, env);
194
4
}
195
196
3
static void RemoveGarbageCollectionTracking(
197
  const FunctionCallbackInfo<Value> &args) {
198
3
  Environment* env = Environment::GetCurrent(args);
199
200
3
  env->RemoveCleanupHook(GarbageCollectionCleanupHook, env);
201
3
  GarbageCollectionCleanupHook(env);
202
3
}
203
204
// Gets the name of a function
205
inline Local<Value> GetName(Local<Function> fn) {
206
  Local<Value> val = fn->GetDebugName();
207
  if (val.IsEmpty() || val->IsUndefined()) {
208
    Local<Value> boundFunction = fn->GetBoundFunction();
209
    if (!boundFunction.IsEmpty() && !boundFunction->IsUndefined()) {
210
      val = GetName(boundFunction.As<Function>());
211
    }
212
  }
213
  return val;
214
}
215
216
// Notify a custom PerformanceEntry to observers
217
void Notify(const FunctionCallbackInfo<Value>& args) {
218
  Environment* env = Environment::GetCurrent(args);
219
  Utf8Value type(env->isolate(), args[0]);
220
  Local<Value> entry = args[1];
221
  PerformanceEntryType entry_type = ToPerformanceEntryTypeEnum(*type);
222
  AliasedUint32Array& observers = env->performance_state()->observers;
223
  if (entry_type != NODE_PERFORMANCE_ENTRY_TYPE_INVALID &&
224
      observers[entry_type]) {
225
    USE(env->performance_entry_callback()->
226
      Call(env->context(), Undefined(env->isolate()), 1, &entry));
227
  }
228
}
229
230
// Return idle time of the event loop
231
50
void LoopIdleTime(const FunctionCallbackInfo<Value>& args) {
232
50
  Environment* env = Environment::GetCurrent(args);
233
50
  uint64_t idle_time = uv_metrics_idle_time(env->event_loop());
234
50
  args.GetReturnValue().Set(1.0 * idle_time / 1e6);
235
50
}
236
237
3
void CreateELDHistogram(const FunctionCallbackInfo<Value>& args) {
238
3
  Environment* env = Environment::GetCurrent(args);
239
6
  int64_t interval = args[0].As<Integer>()->Value();
240
3
  CHECK_GT(interval, 0);
241
  BaseObjectPtr<IntervalHistogram> histogram =
242
1756
      IntervalHistogram::Create(env, interval, [](Histogram& histogram) {
243
1756
        uint64_t delta = histogram.RecordDelta();
244

1758
        TRACE_COUNTER1(TRACING_CATEGORY_NODE2(perf, event_loop),
245
                        "delay", delta);
246

1758
        TRACE_COUNTER1(TRACING_CATEGORY_NODE2(perf, event_loop),
247
                      "min", histogram.Min());
248

1758
        TRACE_COUNTER1(TRACING_CATEGORY_NODE2(perf, event_loop),
249
                      "max", histogram.Max());
250

1758
        TRACE_COUNTER1(TRACING_CATEGORY_NODE2(perf, event_loop),
251
                      "mean", histogram.Mean());
252

1758
        TRACE_COUNTER1(TRACING_CATEGORY_NODE2(perf, event_loop),
253
                      "stddev", histogram.Stddev());
254
6
      }, Histogram::Options { 1000 });
255
6
  args.GetReturnValue().Set(histogram->object());
256
3
}
257
258
6203
void GetTimeOrigin(const FunctionCallbackInfo<Value>& args) {
259
6203
  args.GetReturnValue().Set(Number::New(args.GetIsolate(), timeOrigin / 1e6));
260
6203
}
261
262
6203
void GetTimeOriginTimeStamp(const FunctionCallbackInfo<Value>& args) {
263
6203
  args.GetReturnValue().Set(
264
      Number::New(args.GetIsolate(), timeOriginTimestamp / MICROS_PER_MILLIS));
265
6203
}
266
267
632
void Initialize(Local<Object> target,
268
                Local<Value> unused,
269
                Local<Context> context,
270
                void* priv) {
271
632
  Environment* env = Environment::GetCurrent(context);
272
632
  Isolate* isolate = env->isolate();
273
632
  PerformanceState* state = env->performance_state();
274
275
632
  target->Set(context,
276
              FIXED_ONE_BYTE_STRING(isolate, "observerCounts"),
277
2528
              state->observers.GetJSArray()).Check();
278
632
  target->Set(context,
279
              FIXED_ONE_BYTE_STRING(isolate, "milestones"),
280
1896
              state->milestones.GetJSArray()).Check();
281
282
  Local<String> performanceEntryString =
283
632
      FIXED_ONE_BYTE_STRING(isolate, "PerformanceEntry");
284
285
632
  Local<FunctionTemplate> pe = FunctionTemplate::New(isolate);
286
632
  pe->SetClassName(performanceEntryString);
287
1264
  Local<Function> fn = pe->GetFunction(context).ToLocalChecked();
288
632
  target->Set(context, performanceEntryString, fn).Check();
289
632
  env->set_performance_entry_template(fn);
290
291
632
  env->SetMethod(target, "markMilestone", MarkMilestone);
292
632
  env->SetMethod(target, "setupObservers", SetupPerformanceObservers);
293
632
  env->SetMethod(target,
294
                 "installGarbageCollectionTracking",
295
                 InstallGarbageCollectionTracking);
296
632
  env->SetMethod(target,
297
                 "removeGarbageCollectionTracking",
298
                 RemoveGarbageCollectionTracking);
299
632
  env->SetMethod(target, "notify", Notify);
300
632
  env->SetMethod(target, "loopIdleTime", LoopIdleTime);
301
632
  env->SetMethod(target, "getTimeOrigin", GetTimeOrigin);
302
632
  env->SetMethod(target, "getTimeOriginTimestamp", GetTimeOriginTimeStamp);
303
632
  env->SetMethod(target, "createELDHistogram", CreateELDHistogram);
304
305
632
  Local<Object> constants = Object::New(isolate);
306
307
1896
  NODE_DEFINE_CONSTANT(constants, NODE_PERFORMANCE_GC_MAJOR);
308
1896
  NODE_DEFINE_CONSTANT(constants, NODE_PERFORMANCE_GC_MINOR);
309
1896
  NODE_DEFINE_CONSTANT(constants, NODE_PERFORMANCE_GC_INCREMENTAL);
310
1896
  NODE_DEFINE_CONSTANT(constants, NODE_PERFORMANCE_GC_WEAKCB);
311
312
1896
  NODE_DEFINE_CONSTANT(
313
    constants, NODE_PERFORMANCE_GC_FLAGS_NO);
314
1896
  NODE_DEFINE_CONSTANT(
315
    constants, NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED);
316
1896
  NODE_DEFINE_CONSTANT(
317
    constants, NODE_PERFORMANCE_GC_FLAGS_FORCED);
318
1896
  NODE_DEFINE_CONSTANT(
319
    constants, NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING);
320
1896
  NODE_DEFINE_CONSTANT(
321
    constants, NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE);
322
1896
  NODE_DEFINE_CONSTANT(
323
    constants, NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY);
324
1896
  NODE_DEFINE_CONSTANT(
325
    constants, NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE);
326
327
#define V(name, _)                                                            \
328
  NODE_DEFINE_HIDDEN_CONSTANT(constants, NODE_PERFORMANCE_ENTRY_TYPE_##name);
329
6952
  NODE_PERFORMANCE_ENTRY_TYPES(V)
330
#undef V
331
332
#define V(name, _)                                                            \
333
  NODE_DEFINE_HIDDEN_CONSTANT(constants, NODE_PERFORMANCE_MILESTONE_##name);
334
7584
  NODE_PERFORMANCE_MILESTONES(V)
335
#undef V
336
337
632
  PropertyAttribute attr =
338
      static_cast<PropertyAttribute>(ReadOnly | DontDelete);
339
340
632
  target->DefineOwnProperty(context,
341
                            env->constants_string(),
342
                            constants,
343
1264
                            attr).ToChecked();
344
345
632
  HistogramBase::Initialize(env, target);
346
632
}
347
348
4981
void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
349
4981
  registry->Register(MarkMilestone);
350
4981
  registry->Register(SetupPerformanceObservers);
351
4981
  registry->Register(InstallGarbageCollectionTracking);
352
4981
  registry->Register(RemoveGarbageCollectionTracking);
353
4981
  registry->Register(Notify);
354
4981
  registry->Register(LoopIdleTime);
355
4981
  registry->Register(GetTimeOrigin);
356
4981
  registry->Register(GetTimeOriginTimeStamp);
357
4981
  registry->Register(CreateELDHistogram);
358
4981
  HistogramBase::RegisterExternalReferences(registry);
359
4981
  IntervalHistogram::RegisterExternalReferences(registry);
360
4981
}
361
}  // namespace performance
362
}  // namespace node
363
364
5042
NODE_MODULE_CONTEXT_AWARE_INTERNAL(performance, node::performance::Initialize)
365
4981
NODE_MODULE_EXTERNAL_REFERENCE(performance,
366
                               node::performance::RegisterExternalReferences)