GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: node_v8.cc Lines: 93 93 100.0 %
Date: 2021-10-01 04:12:33 Branches: 8 14 57.1 %

Line Branch Exec Source
1
// Copyright Joyent, Inc. and other Node contributors.
2
//
3
// Permission is hereby granted, free of charge, to any person obtaining a
4
// copy of this software and associated documentation files (the
5
// "Software"), to deal in the Software without restriction, including
6
// without limitation the rights to use, copy, modify, merge, publish,
7
// distribute, sublicense, and/or sell copies of the Software, and to permit
8
// persons to whom the Software is furnished to do so, subject to the
9
// following conditions:
10
//
11
// The above copyright notice and this permission notice shall be included
12
// in all copies or substantial portions of the Software.
13
//
14
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
17
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20
// USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22
#include "node_v8.h"
23
#include "base_object-inl.h"
24
#include "env-inl.h"
25
#include "memory_tracker-inl.h"
26
#include "node.h"
27
#include "node_external_reference.h"
28
#include "util-inl.h"
29
#include "v8.h"
30
31
namespace node {
32
namespace v8_utils {
33
using v8::Array;
34
using v8::Context;
35
using v8::FunctionCallbackInfo;
36
using v8::HandleScope;
37
using v8::HeapCodeStatistics;
38
using v8::HeapSpaceStatistics;
39
using v8::HeapStatistics;
40
using v8::Integer;
41
using v8::Isolate;
42
using v8::Local;
43
using v8::Object;
44
using v8::ScriptCompiler;
45
using v8::String;
46
using v8::Uint32;
47
using v8::V8;
48
using v8::Value;
49
50
51
#define HEAP_STATISTICS_PROPERTIES(V)                                         \
52
  V(0, total_heap_size, kTotalHeapSizeIndex)                                  \
53
  V(1, total_heap_size_executable, kTotalHeapSizeExecutableIndex)             \
54
  V(2, total_physical_size, kTotalPhysicalSizeIndex)                          \
55
  V(3, total_available_size, kTotalAvailableSize)                             \
56
  V(4, used_heap_size, kUsedHeapSizeIndex)                                    \
57
  V(5, heap_size_limit, kHeapSizeLimitIndex)                                  \
58
  V(6, malloced_memory, kMallocedMemoryIndex)                                 \
59
  V(7, peak_malloced_memory, kPeakMallocedMemoryIndex)                        \
60
  V(8, does_zap_garbage, kDoesZapGarbageIndex)                                \
61
  V(9, number_of_native_contexts, kNumberOfNativeContextsIndex)               \
62
  V(10, number_of_detached_contexts, kNumberOfDetachedContextsIndex)
63
64
#define V(a, b, c) +1
65
static constexpr size_t kHeapStatisticsPropertiesCount =
66
    HEAP_STATISTICS_PROPERTIES(V);
67
#undef V
68
69
#define HEAP_SPACE_STATISTICS_PROPERTIES(V)                                   \
70
  V(0, space_size, kSpaceSizeIndex)                                           \
71
  V(1, space_used_size, kSpaceUsedSizeIndex)                                  \
72
  V(2, space_available_size, kSpaceAvailableSizeIndex)                        \
73
  V(3, physical_space_size, kPhysicalSpaceSizeIndex)
74
75
#define V(a, b, c) +1
76
static constexpr size_t kHeapSpaceStatisticsPropertiesCount =
77
    HEAP_SPACE_STATISTICS_PROPERTIES(V);
78
#undef V
79
80
#define HEAP_CODE_STATISTICS_PROPERTIES(V)                                     \
81
  V(0, code_and_metadata_size, kCodeAndMetadataSizeIndex)                      \
82
  V(1, bytecode_and_metadata_size, kBytecodeAndMetadataSizeIndex)              \
83
  V(2, external_script_source_size, kExternalScriptSourceSizeIndex)
84
85
#define V(a, b, c) +1
86
static const size_t kHeapCodeStatisticsPropertiesCount =
87
    HEAP_CODE_STATISTICS_PROPERTIES(V);
88
#undef V
89
90
5467
BindingData::BindingData(Environment* env, Local<Object> obj)
91
    : SnapshotableObject(env, obj, type_int),
92
      heap_statistics_buffer(env->isolate(), kHeapStatisticsPropertiesCount),
93
      heap_space_statistics_buffer(env->isolate(),
94
                                   kHeapSpaceStatisticsPropertiesCount),
95
      heap_code_statistics_buffer(env->isolate(),
96
5467
                                  kHeapCodeStatisticsPropertiesCount) {
97
5467
  obj->Set(env->context(),
98
           FIXED_ONE_BYTE_STRING(env->isolate(), "heapStatisticsBuffer"),
99
21868
           heap_statistics_buffer.GetJSArray())
100
      .Check();
101
5467
  obj->Set(env->context(),
102
           FIXED_ONE_BYTE_STRING(env->isolate(), "heapCodeStatisticsBuffer"),
103
21868
           heap_code_statistics_buffer.GetJSArray())
104
      .Check();
105
5467
  obj->Set(env->context(),
106
           FIXED_ONE_BYTE_STRING(env->isolate(), "heapSpaceStatisticsBuffer"),
107
16401
           heap_space_statistics_buffer.GetJSArray())
108
      .Check();
109
5467
}
110
111
6
void BindingData::PrepareForSerialization(Local<Context> context,
112
                                          v8::SnapshotCreator* creator) {
113
  // We'll just re-initialize the buffers in the constructor since their
114
  // contents can be thrown away once consumed in the previous call.
115
6
  heap_statistics_buffer.Release();
116
6
  heap_space_statistics_buffer.Release();
117
6
  heap_code_statistics_buffer.Release();
118
6
}
119
120
4845
void BindingData::Deserialize(Local<Context> context,
121
                              Local<Object> holder,
122
                              int index,
123
                              InternalFieldInfo* info) {
124
  DCHECK_EQ(index, BaseObject::kSlot);
125
9690
  HandleScope scope(context->GetIsolate());
126
4845
  Environment* env = Environment::GetCurrent(context);
127
4845
  BindingData* binding = env->AddBindingData<BindingData>(context, holder);
128
4845
  CHECK_NOT_NULL(binding);
129
4845
}
130
131
6
InternalFieldInfo* BindingData::Serialize(int index) {
132
  DCHECK_EQ(index, BaseObject::kSlot);
133
6
  InternalFieldInfo* info = InternalFieldInfo::New(type());
134
6
  return info;
135
}
136
137
22
void BindingData::MemoryInfo(MemoryTracker* tracker) const {
138
22
  tracker->TrackField("heap_statistics_buffer", heap_statistics_buffer);
139
22
  tracker->TrackField("heap_space_statistics_buffer",
140
22
                      heap_space_statistics_buffer);
141
22
  tracker->TrackField("heap_code_statistics_buffer",
142
22
                      heap_code_statistics_buffer);
143
22
}
144
145
// TODO(addaleax): Remove once we're on C++17.
146
constexpr FastStringKey BindingData::type_name;
147
148
4
void CachedDataVersionTag(const FunctionCallbackInfo<Value>& args) {
149
4
  Environment* env = Environment::GetCurrent(args);
150
  Local<Integer> result =
151
      Integer::NewFromUnsigned(env->isolate(),
152
4
                               ScriptCompiler::CachedDataVersionTag());
153
4
  args.GetReturnValue().Set(result);
154
4
}
155
156
1934
void UpdateHeapStatisticsBuffer(const FunctionCallbackInfo<Value>& args) {
157
1934
  BindingData* data = Environment::GetBindingData<BindingData>(args);
158
1934
  HeapStatistics s;
159
1934
  args.GetIsolate()->GetHeapStatistics(&s);
160
1934
  AliasedFloat64Array& buffer = data->heap_statistics_buffer;
161
#define V(index, name, _) buffer[index] = static_cast<double>(s.name());
162
1934
  HEAP_STATISTICS_PROPERTIES(V)
163
#undef V
164
1934
}
165
166
167
15472
void UpdateHeapSpaceStatisticsBuffer(const FunctionCallbackInfo<Value>& args) {
168
15472
  BindingData* data = Environment::GetBindingData<BindingData>(args);
169
15472
  HeapSpaceStatistics s;
170
15472
  Isolate* const isolate = args.GetIsolate();
171
15472
  CHECK(args[0]->IsUint32());
172
30944
  size_t space_index = static_cast<size_t>(args[0].As<v8::Uint32>()->Value());
173
15472
  isolate->GetHeapSpaceStatistics(&s, space_index);
174
175
15472
  AliasedFloat64Array& buffer = data->heap_space_statistics_buffer;
176
177
#define V(index, name, _) buffer[index] = static_cast<double>(s.name());
178
15472
  HEAP_SPACE_STATISTICS_PROPERTIES(V)
179
#undef V
180
15472
}
181
182
1
void UpdateHeapCodeStatisticsBuffer(const FunctionCallbackInfo<Value>& args) {
183
1
  BindingData* data = Environment::GetBindingData<BindingData>(args);
184
1
  HeapCodeStatistics s;
185
1
  args.GetIsolate()->GetHeapCodeAndMetadataStatistics(&s);
186
1
  AliasedFloat64Array& buffer = data->heap_code_statistics_buffer;
187
188
#define V(index, name, _) buffer[index] = static_cast<double>(s.name());
189
1
  HEAP_CODE_STATISTICS_PROPERTIES(V)
190
#undef V
191
1
}
192
193
194
8
void SetFlagsFromString(const FunctionCallbackInfo<Value>& args) {
195
16
  CHECK(args[0]->IsString());
196
16
  String::Utf8Value flags(args.GetIsolate(), args[0]);
197
8
  V8::SetFlagsFromString(*flags, static_cast<size_t>(flags.length()));
198
8
}
199
200
622
void Initialize(Local<Object> target,
201
                Local<Value> unused,
202
                Local<Context> context,
203
                void* priv) {
204
622
  Environment* env = Environment::GetCurrent(context);
205
  BindingData* const binding_data =
206
622
      env->AddBindingData<BindingData>(context, target);
207
622
  if (binding_data == nullptr) return;
208
209
622
  env->SetMethodNoSideEffect(target, "cachedDataVersionTag",
210
                             CachedDataVersionTag);
211
622
  env->SetMethod(
212
      target, "updateHeapStatisticsBuffer", UpdateHeapStatisticsBuffer);
213
214
622
  env->SetMethod(
215
      target, "updateHeapCodeStatisticsBuffer", UpdateHeapCodeStatisticsBuffer);
216
217
622
  size_t number_of_heap_spaces = env->isolate()->NumberOfHeapSpaces();
218
219
  // Heap space names are extracted once and exposed to JavaScript to
220
  // avoid excessive creation of heap space name Strings.
221
622
  HeapSpaceStatistics s;
222
1244
  MaybeStackBuffer<Local<Value>, 16> heap_spaces(number_of_heap_spaces);
223
5598
  for (size_t i = 0; i < number_of_heap_spaces; i++) {
224
4976
    env->isolate()->GetHeapSpaceStatistics(&s, i);
225
9952
    heap_spaces[i] = String::NewFromUtf8(env->isolate(), s.space_name())
226
                                             .ToLocalChecked();
227
  }
228
622
  target->Set(env->context(),
229
              FIXED_ONE_BYTE_STRING(env->isolate(), "kHeapSpaces"),
230
              Array::New(env->isolate(),
231
                         heap_spaces.out(),
232
1866
                         number_of_heap_spaces)).Check();
233
234
622
  env->SetMethod(target,
235
                 "updateHeapSpaceStatisticsBuffer",
236
                 UpdateHeapSpaceStatisticsBuffer);
237
238
#define V(i, _, name)                                                          \
239
  target                                                                       \
240
      ->Set(env->context(),                                                    \
241
            FIXED_ONE_BYTE_STRING(env->isolate(), #name),                      \
242
            Uint32::NewFromUnsigned(env->isolate(), i))                        \
243
      .Check();
244
245
21148
  HEAP_STATISTICS_PROPERTIES(V)
246
6220
  HEAP_CODE_STATISTICS_PROPERTIES(V)
247
7464
  HEAP_SPACE_STATISTICS_PROPERTIES(V)
248
#undef V
249
250
  // Export symbols used by v8.setFlagsFromString()
251
622
  env->SetMethod(target, "setFlagsFromString", SetFlagsFromString);
252
}
253
254
4851
void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
255
4851
  registry->Register(CachedDataVersionTag);
256
4851
  registry->Register(UpdateHeapStatisticsBuffer);
257
4851
  registry->Register(UpdateHeapCodeStatisticsBuffer);
258
4851
  registry->Register(UpdateHeapSpaceStatisticsBuffer);
259
4851
  registry->Register(SetFlagsFromString);
260
4851
}
261
262
}  // namespace v8_utils
263
}  // namespace node
264
265
4924
NODE_MODULE_CONTEXT_AWARE_INTERNAL(v8, node::v8_utils::Initialize)
266
4851
NODE_MODULE_EXTERNAL_REFERENCE(v8, node::v8_utils::RegisterExternalReferences)