Repository navigation
Expand file tree
/
Copy pathcallback.cc
More file actions
408 lines (348 loc) · 13.8 KB
/
Copy pathcallback.cc
File metadata and controls
408 lines (348 loc) · 13.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
#include "async_context_frame.h"
#include "async_wrap-inl.h"
#include "env-inl.h"
#include "node.h"
#include "v8.h"
#include <optional>
namespace node {
using v8::Context;
using v8::Function;
using v8::Global;
using v8::HandleScope;
using v8::Isolate;
using v8::Local;
using v8::MaybeLocal;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Undefined;
using v8::Value;
CallbackScope::CallbackScope(Isolate* isolate,
Local<Object> object,
async_context async_context)
: CallbackScope(Environment::GetCurrent(isolate), object, async_context) {}
CallbackScope::CallbackScope(Environment* env,
Local<Object> object,
async_context asyncContext)
: resource_storage_({.local = object}),
private_(new InternalCallbackScope(
env, &resource_storage_.local, asyncContext)),
try_catch_(env->isolate()) {
try_catch_.SetVerbose(true);
}
CallbackScope::CallbackScope(Environment* env,
Global<Object>* object,
async_context asyncContext)
: resource_storage_({.global_ptr = object}),
private_(new InternalCallbackScope(
env, resource_storage_.global_ptr, asyncContext)),
try_catch_(env->isolate()) {
try_catch_.SetVerbose(true);
// These checks can be removed in a future major version -- they ensure
// ABI compatibility with previous Node.js versions.
static_assert(sizeof(resource_storage_) == sizeof(Global<Object>*));
static_assert(sizeof(resource_storage_) == sizeof(Local<Object>));
static_assert(alignof(decltype(resource_storage_)) ==
alignof(Global<Object>*));
static_assert(alignof(decltype(resource_storage_)) == alignof(Local<Object>));
}
CallbackScope::~CallbackScope() {
if (try_catch_.HasCaught())
private_->MarkAsFailed();
delete private_;
}
InternalCallbackScope::InternalCallbackScope(AsyncWrap* async_wrap, int flags)
: InternalCallbackScope(
async_wrap->env(),
async_wrap->object(),
{async_wrap->get_async_id(), async_wrap->get_trigger_async_id()},
flags,
async_wrap->context_frame()) {}
InternalCallbackScope::InternalCallbackScope(
Environment* env,
std::variant<Local<Object>, Local<Object>*, Global<Object>*> object_arg,
const async_context& asyncContext,
int flags,
Local<Value> context_frame)
: env_(env),
async_context_(asyncContext),
skip_hooks_(flags & kSkipAsyncHooks),
skip_task_queues_(flags & kSkipTaskQueues) {
CHECK_NOT_NULL(env);
std::variant<v8::Local<v8::Object>*, v8::Global<v8::Object>*> object;
if (std::holds_alternative<Local<Object>>(object_arg)) {
object_storage_ = std::get<Local<Object>>(object_arg);
object = &object_storage_;
} else if (std::holds_alternative<Local<Object>*>(object_arg)) {
object = std::get<Local<Object>*>(object_arg);
} else {
object = std::get<Global<Object>*>(object_arg);
}
std::visit([](auto* ptr) { CHECK_NOT_NULL(ptr); }, object);
env->PushAsyncCallbackScope();
if (!env->can_call_into_js()) {
failed_ = true;
return;
}
Isolate* isolate = env->isolate();
if (handle_cleanup_depth > 0) allow_js_.emplace(isolate);
HandleScope handle_scope(isolate);
Local<Context> current_context = isolate->GetCurrentContext();
// If you hit this assertion, the caller forgot to enter the right Node.js
// Environment's v8::Context first.
// We first check `env->context() != current_context` because the contexts
// likely *are* the same, in which case we can skip the slightly more
// expensive Environment::GetCurrent() call.
if (env->context() != current_context) [[unlikely]] {
CHECK_EQ(Environment::GetCurrent(isolate), env);
}
isolate->SetIdle(false);
// The prior frame is usually undefined: no global handle then.
Local<Value> prior_context_frame =
async_context_frame::exchange(env, context_frame);
if (!prior_context_frame->IsUndefined()) {
prior_context_frame_.Reset(isolate, prior_context_frame);
}
env->async_hooks()->push_async_context(
async_context_.async_id, async_context_.trigger_async_id, object);
pushed_ids_ = true;
if (asyncContext.async_id != 0 && !skip_hooks_) {
// No need to check a return value because the application will exit if
// an exception occurs.
AsyncWrap::EmitBefore(env, asyncContext.async_id);
}
}
InternalCallbackScope::~InternalCallbackScope() {
Close();
env_->PopAsyncCallbackScope();
}
void InternalCallbackScope::Close() {
if (closed_) return;
closed_ = true;
// This function must ends up with either cleanup the
// async id stack or pop the topmost one from it
auto perform_stopping_check = [&]() {
if (env_->is_stopping()) {
MarkAsFailed();
env_->async_hooks()->clear_async_id_stack();
}
};
perform_stopping_check();
if (env_->is_stopping()) return;
Isolate* isolate = env_->isolate();
auto idle = OnScopeLeave([&]() { isolate->SetIdle(true); });
if (!failed_ && async_context_.async_id != 0 && !skip_hooks_) {
AsyncWrap::EmitAfter(env_, async_context_.async_id);
}
if (pushed_ids_) {
env_->async_hooks()->pop_async_context(async_context_.async_id);
async_context_frame::set(env_, prior_context_frame_.Get(isolate));
}
if (failed_) return;
if (env_->async_callback_scope_depth() > 1 || skip_task_queues_) {
return;
}
TickInfo* tick_info = env_->tick_info();
if (!env_->can_call_into_js()) return;
auto weakref_cleanup = OnScopeLeave([&]() { env_->RunWeakRefCleanup(); });
Local<Context> context = env_->context();
if (!tick_info->has_tick_scheduled()) {
context->GetMicrotaskQueue()->PerformCheckpoint(isolate);
perform_stopping_check();
}
// Make sure the stack unwound properly. If there are nested MakeCallback's
// then it should return early and not reach this code.
if (env_->async_hooks()->fields()[AsyncHooks::kTotals]) {
CHECK_EQ(env_->execution_async_id(), 0);
CHECK_EQ(env_->trigger_async_id(), 0);
}
if (!tick_info->has_tick_scheduled() && !tick_info->has_rejection_to_warn()) {
return;
}
HandleScope handle_scope(isolate);
Local<Object> process = env_->process_object();
if (!env_->can_call_into_js()) return;
Local<Function> tick_callback = env_->tick_callback_function();
// The tick is triggered before JS land calls SetTickCallback
// to initializes the tick callback during bootstrap.
CHECK(!tick_callback.IsEmpty());
if (tick_callback->Call(context, process, 0, nullptr).IsEmpty()) {
failed_ = true;
}
perform_stopping_check();
}
MaybeLocal<Value> InternalMakeCallback(Environment* env,
Local<Object> resource,
Local<Object> recv,
const Local<Function> callback,
int argc,
Local<Value> argv[],
async_context asyncContext,
Local<Value> context_frame) {
CHECK(!recv.IsEmpty());
#ifdef DEBUG
for (int i = 0; i < argc; i++)
CHECK(!argv[i].IsEmpty());
#endif
Local<Function> hook_cb = env->async_hooks_callback_trampoline();
int flags = InternalCallbackScope::kNoFlags;
bool use_async_hooks_trampoline = false;
AsyncHooks* async_hooks = env->async_hooks();
if (!hook_cb.IsEmpty()) {
// Use the callback trampoline if there are any before or after hooks, or
// we can expect some kind of usage of async_hooks.executionAsyncResource().
flags = InternalCallbackScope::kSkipAsyncHooks;
use_async_hooks_trampoline =
async_hooks->fields()[AsyncHooks::kBefore] +
async_hooks->fields()[AsyncHooks::kAfter] +
async_hooks->fields()[AsyncHooks::kUsesExecutionAsyncResource] > 0;
}
InternalCallbackScope scope(
env, resource, asyncContext, flags, context_frame);
if (scope.Failed()) {
return MaybeLocal<Value>();
}
MaybeLocal<Value> ret;
Local<Context> context = env->context();
if (use_async_hooks_trampoline) {
MaybeStackBuffer<Value, 16> args(env->isolate(), 3 + argc);
args[0] = Number::New(env->isolate(), asyncContext.async_id);
args[1] = resource;
args[2] = callback;
for (int i = 0; i < argc; i++) {
args[i + 3] = argv[i];
}
ret = hook_cb->Call(context, recv, args.length(), &args[0]);
} else {
ret = callback->Call(context, recv, argc, argv);
}
if (ret.IsEmpty()) {
scope.MarkAsFailed();
return MaybeLocal<Value>();
}
scope.Close();
if (scope.Failed()) {
return MaybeLocal<Value>();
}
return ret;
}
// Public MakeCallback()s
MaybeLocal<Value> MakeCallback(Isolate* isolate,
Local<Object> recv,
const char* method,
int argc,
Local<Value> argv[],
async_context asyncContext) {
Local<String> method_string;
if (!String::NewFromUtf8(isolate, method).ToLocal(&method_string)) {
return {};
}
return MakeCallback(isolate, recv, method_string, argc, argv, asyncContext);
}
MaybeLocal<Value> MakeCallback(Isolate* isolate,
Local<Object> recv,
Local<String> symbol,
int argc,
Local<Value> argv[],
async_context asyncContext) {
// Check can_call_into_js() first because calling Get() might do so.
Local<Context> context;
if (!recv->GetCreationContext().ToLocal(&context)) {
return {};
}
Environment* env = Environment::GetCurrent(context);
CHECK_NOT_NULL(env);
if (!env->can_call_into_js()) return {};
Local<Value> callback_v;
if (!recv->Get(isolate->GetCurrentContext(), symbol).ToLocal(&callback_v)) {
return {};
}
if (!callback_v->IsFunction()) {
// This used to return an empty value, but Undefined() makes more sense
// since no exception is pending here.
return Undefined(isolate);
}
Local<Function> callback = callback_v.As<Function>();
return MakeCallback(isolate, recv, callback, argc, argv, asyncContext);
}
MaybeLocal<Value> MakeCallback(Isolate* isolate,
Local<Object> recv,
Local<Function> callback,
int argc,
Local<Value> argv[],
async_context asyncContext) {
return InternalMakeCallback(
isolate, recv, callback, argc, argv, asyncContext, Undefined(isolate));
}
MaybeLocal<Value> InternalMakeCallback(Isolate* isolate,
Local<Object> recv,
Local<Function> callback,
int argc,
Local<Value> argv[],
async_context asyncContext,
Local<Value> context_frame) {
// Observe the following two subtleties:
//
// 1. The environment is retrieved from the callback function's context.
// 2. The context to enter is retrieved from the environment.
//
// Because of the AssignToContext() call in src/node_contextify.cc,
// the two contexts need not be the same.
Local<Context> context;
if (!callback->GetCreationContext().ToLocal(&context)) {
return {};
}
Environment* env = Environment::GetCurrent(context);
CHECK_NOT_NULL(env);
// Entering the context changes nothing when it is already the entered and
// the current one, which is the common case for addons.
Local<Context> env_context = env->context();
std::optional<Context::Scope> context_scope;
if (isolate->GetEnteredOrMicrotaskContext() != env_context ||
isolate->GetCurrentContext() != env_context) {
context_scope.emplace(env_context);
}
MaybeLocal<Value> ret = InternalMakeCallback(
env, recv, recv, callback, argc, argv, asyncContext, context_frame);
if (ret.IsEmpty() && env->async_callback_scope_depth() == 0) {
// This is only for legacy compatibility and we may want to look into
// removing/adjusting it.
return Undefined(isolate);
}
return ret;
}
// Use this if you just want to safely invoke some JS callback and
// would like to retain the currently active async_context, if any.
// In case none is available, a fixed default context will be
// installed otherwise.
MaybeLocal<Value> MakeSyncCallback(Isolate* isolate,
Local<Object> recv,
Local<Function> callback,
int argc,
Local<Value> argv[]) {
Local<Context> context;
if (!callback->GetCreationContext().ToLocal(&context)) {
return {};
}
Environment* env = Environment::GetCurrent(context);
CHECK_NOT_NULL(env);
if (!env->can_call_into_js()) return {};
Context::Scope context_scope(context);
if (env->async_callback_scope_depth()) {
// There's another MakeCallback() on the stack, piggy back on it.
// In particular, retain the current async_context.
return callback->Call(context, recv, argc, argv);
}
// This is a toplevel invocation and the caller (intentionally)
// didn't provide any async_context to run in. Install a default context.
MaybeLocal<Value> ret = InternalMakeCallback(env,
env->process_object(),
recv,
callback,
argc,
argv,
async_context{0, 0},
Undefined(isolate));
return ret;
}
} // namespace node