// Copyright Joyent, Inc. and other Node contributors. // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the // "Software"), to deal in the Software without restriction, including // without limitation the rights to use, copy, modify, merge, publish, // distribute, sublicense, and/or sell copies of the Software, and to permit // persons to whom the Software is furnished to do so, subject to the // following conditions: // // The above copyright notice and this permission notice shall be included // in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE // USE OR OTHER DEALINGS IN THE SOFTWARE. #include "async-wrap.h" #include "async-wrap-inl.h" #include "env.h" #include "env-inl.h" #include "util.h" #include "util-inl.h" #include "uv.h" #include "v8.h" #include "v8-profiler.h" using v8::Array; using v8::Context; using v8::Float64Array; using v8::Function; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::HeapProfiler; using v8::Integer; using v8::Isolate; using v8::Local; using v8::MaybeLocal; using v8::Number; using v8::Object; using v8::ObjectTemplate; using v8::Promise; using v8::PromiseHookType; using v8::PropertyCallbackInfo; using v8::RetainedObjectInfo; using v8::String; using v8::Symbol; using v8::TryCatch; using v8::Undefined; using v8::Value; using AsyncHooks = node::Environment::AsyncHooks; namespace node { static const char* const provider_names[] = { #define V(PROVIDER) \ #PROVIDER, NODE_ASYNC_PROVIDER_TYPES(V) #undef V }; // Report correct information in a heapdump. class RetainedAsyncInfo: public RetainedObjectInfo { public: explicit RetainedAsyncInfo(uint16_t class_id, AsyncWrap* wrap); void Dispose() override; bool IsEquivalent(RetainedObjectInfo* other) override; intptr_t GetHash() override; const char* GetLabel() override; intptr_t GetSizeInBytes() override; private: const char* label_; const AsyncWrap* wrap_; const int length_; }; RetainedAsyncInfo::RetainedAsyncInfo(uint16_t class_id, AsyncWrap* wrap) : label_(provider_names[class_id - NODE_ASYNC_ID_OFFSET]), wrap_(wrap), length_(wrap->self_size()) { } void RetainedAsyncInfo::Dispose() { delete this; } bool RetainedAsyncInfo::IsEquivalent(RetainedObjectInfo* other) { return label_ == other->GetLabel() && wrap_ == static_cast(other)->wrap_; } intptr_t RetainedAsyncInfo::GetHash() { return reinterpret_cast(wrap_); } const char* RetainedAsyncInfo::GetLabel() { return label_; } intptr_t RetainedAsyncInfo::GetSizeInBytes() { return length_; } RetainedObjectInfo* WrapperInfo(uint16_t class_id, Local wrapper) { // No class_id should be the provider type of NONE. CHECK_GT(class_id, NODE_ASYNC_ID_OFFSET); // And make sure the class_id doesn't extend past the last provider. CHECK_LE(class_id - NODE_ASYNC_ID_OFFSET, AsyncWrap::PROVIDERS_LENGTH); CHECK(wrapper->IsObject()); CHECK(!wrapper.IsEmpty()); Local object = wrapper.As(); CHECK_GT(object->InternalFieldCount(), 0); AsyncWrap* wrap = Unwrap(object); CHECK_NE(nullptr, wrap); return new RetainedAsyncInfo(class_id, wrap); } // end RetainedAsyncInfo static void DestroyIdsCb(uv_timer_t* handle) { Environment* env = Environment::from_destroy_ids_timer_handle(handle); HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); Local fn = env->async_hooks_destroy_function(); TryCatch try_catch(env->isolate()); do { std::vector destroy_ids_list; destroy_ids_list.swap(*env->destroy_ids_list()); for (auto current_id : destroy_ids_list) { // Want each callback to be cleaned up after itself, instead of cleaning // them all up after the while() loop completes. HandleScope scope(env->isolate()); Local argv = Number::New(env->isolate(), current_id); MaybeLocal ret = fn->Call( env->context(), Undefined(env->isolate()), 1, &argv); if (ret.IsEmpty()) { ClearFatalExceptionHandlers(env); FatalException(env->isolate(), try_catch); UNREACHABLE(); } } } while (!env->destroy_ids_list()->empty()); } static void PushBackDestroyId(Environment* env, double id) { if (env->async_hooks()->fields()[AsyncHooks::kDestroy] == 0) return; if (env->destroy_ids_list()->empty()) uv_timer_start(env->destroy_ids_timer_handle(), DestroyIdsCb, 0, 0); env->destroy_ids_list()->push_back(id); } void AsyncWrap::EmitBefore(Environment* env, double async_id) { AsyncHooks* async_hooks = env->async_hooks(); if (async_hooks->fields()[AsyncHooks::kBefore] == 0) return; Local uid = Number::New(env->isolate(), async_id); Local fn = env->async_hooks_before_function(); TryCatch try_catch(env->isolate()); MaybeLocal ar = fn->Call( env->context(), Undefined(env->isolate()), 1, &uid); if (ar.IsEmpty()) { ClearFatalExceptionHandlers(env); FatalException(env->isolate(), try_catch); UNREACHABLE(); } } void AsyncWrap::EmitAfter(Environment* env, double async_id) { AsyncHooks* async_hooks = env->async_hooks(); if (async_hooks->fields()[AsyncHooks::kAfter] == 0) return; // If the user's callback failed then the after() hooks will be called at the // end of _fatalException(). Local uid = Number::New(env->isolate(), async_id); Local fn = env->async_hooks_after_function(); TryCatch try_catch(env->isolate()); MaybeLocal ar = fn->Call( env->context(), Undefined(env->isolate()), 1, &uid); if (ar.IsEmpty()) { ClearFatalExceptionHandlers(env); FatalException(env->isolate(), try_catch); UNREACHABLE(); } } class PromiseWrap : public AsyncWrap { public: PromiseWrap(Environment* env, Local object, bool silent) : AsyncWrap(env, object, PROVIDER_PROMISE, silent) { MakeWeak(this); } size_t self_size() const override { return sizeof(*this); } static constexpr int kPromiseField = 1; static constexpr int kParentIdField = 2; static constexpr int kInternalFieldCount = 3; static PromiseWrap* New(Environment* env, Local promise, PromiseWrap* parent_wrap, bool silent); static void GetPromise(Local property, const PropertyCallbackInfo& info); static void GetParentId(Local property, const PropertyCallbackInfo& info); }; PromiseWrap* PromiseWrap::New(Environment* env, Local promise, PromiseWrap* parent_wrap, bool silent) { Local object = env->promise_wrap_template() ->NewInstance(env->context()).ToLocalChecked(); object->SetInternalField(PromiseWrap::kPromiseField, promise); if (parent_wrap != nullptr) { object->SetInternalField(PromiseWrap::kParentIdField, Number::New(env->isolate(), parent_wrap->get_id())); } CHECK_EQ(promise->GetAlignedPointerFromInternalField(0), nullptr); promise->SetInternalField(0, object); return new PromiseWrap(env, object, silent); } void PromiseWrap::GetPromise(Local property, const PropertyCallbackInfo& info) { info.GetReturnValue().Set(info.Holder()->GetInternalField(kPromiseField)); } void PromiseWrap::GetParentId(Local property, const PropertyCallbackInfo& info) { info.GetReturnValue().Set(info.Holder()->GetInternalField(kParentIdField)); } static void PromiseHook(PromiseHookType type, Local promise, Local parent, void* arg) { Environment* env = static_cast(arg); Local resource_object_value = promise->GetInternalField(0); PromiseWrap* wrap = nullptr; if (resource_object_value->IsObject()) { Local resource_object = resource_object_value.As(); wrap = Unwrap(resource_object); } if (type == PromiseHookType::kInit || wrap == nullptr) { bool silent = type != PromiseHookType::kInit; PromiseWrap* parent_wrap = nullptr; // set parent promise's async Id as this promise's triggerAsyncId if (parent->IsPromise()) { // parent promise exists, current promise // is a chained promise, so we set parent promise's id as // current promise's triggerAsyncId Local parent_promise = parent.As(); Local parent_resource = parent_promise->GetInternalField(0); if (parent_resource->IsObject()) { parent_wrap = Unwrap(parent_resource.As()); } if (parent_wrap == nullptr) { parent_wrap = PromiseWrap::New(env, parent_promise, nullptr, true); } // get id from parentWrap double trigger_id = parent_wrap->get_id(); env->set_init_trigger_id(trigger_id); } wrap = PromiseWrap::New(env, promise, parent_wrap, silent); } else if (type == PromiseHookType::kResolve) { // TODO(matthewloring): need to expose this through the async hooks api. } CHECK_NE(wrap, nullptr); if (type == PromiseHookType::kBefore) { env->async_hooks()->push_ids(wrap->get_id(), wrap->get_trigger_id()); AsyncWrap::EmitBefore(wrap->env(), wrap->get_id()); } else if (type == PromiseHookType::kAfter) { AsyncWrap::EmitAfter(wrap->env(), wrap->get_id()); if (env->current_async_id() == wrap->get_id()) { // This condition might not be true if async_hooks was enabled during // the promise callback execution. // Popping it off the stack can be skipped in that case, because is is // known that it would correspond to exactly one call with // PromiseHookType::kBefore that was not witnessed by the PromiseHook. env->async_hooks()->pop_ids(wrap->get_id()); } } } static void SetupHooks(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsObject()) return env->ThrowTypeError("first argument must be an object"); // All of init, before, after, destroy are supplied by async_hooks // internally, so this should every only be called once. At which time all // the functions should be set. Detect this by checking if init !IsEmpty(). CHECK(env->async_hooks_init_function().IsEmpty()); Local fn_obj = args[0].As(); #define SET_HOOK_FN(name) \ Local name##_v = fn_obj->Get( \ env->context(), \ FIXED_ONE_BYTE_STRING(env->isolate(), #name)).ToLocalChecked(); \ CHECK(name##_v->IsFunction()); \ env->set_async_hooks_##name##_function(name##_v.As()); SET_HOOK_FN(init); SET_HOOK_FN(before); SET_HOOK_FN(after); SET_HOOK_FN(destroy); #undef SET_HOOK_FN { Local ctor = FunctionTemplate::New(env->isolate()); ctor->SetClassName(FIXED_ONE_BYTE_STRING(env->isolate(), "PromiseWrap")); Local promise_wrap_template = ctor->InstanceTemplate(); promise_wrap_template->SetInternalFieldCount( PromiseWrap::kInternalFieldCount); promise_wrap_template->SetAccessor( FIXED_ONE_BYTE_STRING(env->isolate(), "promise"), PromiseWrap::GetPromise); promise_wrap_template->SetAccessor( FIXED_ONE_BYTE_STRING(env->isolate(), "parentId"), PromiseWrap::GetParentId); env->set_promise_wrap_template(promise_wrap_template); } } static void EnablePromiseHook(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); env->AddPromiseHook(PromiseHook, static_cast(env)); } static void DisablePromiseHook(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); // Delay the call to `RemovePromiseHook` because we might currently be // between the `before` and `after` calls of a Promise. env->isolate()->EnqueueMicrotask([](void* data) { Environment* env = static_cast(data); env->RemovePromiseHook(PromiseHook, data); }, static_cast(env)); } void AsyncWrap::GetAsyncId(const FunctionCallbackInfo& args) { AsyncWrap* wrap; args.GetReturnValue().Set(-1); ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); args.GetReturnValue().Set(wrap->get_id()); } void AsyncWrap::PushAsyncIds(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); // No need for CHECK(IsNumber()) on args because if FromJust() doesn't fail // then the checks in push_ids() and pop_ids() will. double async_id = args[0]->NumberValue(env->context()).FromJust(); double trigger_id = args[1]->NumberValue(env->context()).FromJust(); env->async_hooks()->push_ids(async_id, trigger_id); } void AsyncWrap::PopAsyncIds(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); double async_id = args[0]->NumberValue(env->context()).FromJust(); args.GetReturnValue().Set(env->async_hooks()->pop_ids(async_id)); } void AsyncWrap::AsyncIdStackSize(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); args.GetReturnValue().Set( static_cast(env->async_hooks()->stack_size())); } void AsyncWrap::ClearIdStack(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); env->async_hooks()->clear_id_stack(); } void AsyncWrap::AsyncReset(const FunctionCallbackInfo& args) { AsyncWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); wrap->AsyncReset(); } void AsyncWrap::QueueDestroyId(const FunctionCallbackInfo& args) { CHECK(args[0]->IsNumber()); PushBackDestroyId(Environment::GetCurrent(args), args[0]->NumberValue()); } void AsyncWrap::AddWrapMethods(Environment* env, Local constructor, int flag) { env->SetProtoMethod(constructor, "getAsyncId", AsyncWrap::GetAsyncId); if (flag & kFlagHasReset) env->SetProtoMethod(constructor, "asyncReset", AsyncWrap::AsyncReset); } void AsyncWrap::Initialize(Local target, Local unused, Local context) { Environment* env = Environment::GetCurrent(context); Isolate* isolate = env->isolate(); HandleScope scope(isolate); env->SetMethod(target, "setupHooks", SetupHooks); env->SetMethod(target, "pushAsyncIds", PushAsyncIds); env->SetMethod(target, "popAsyncIds", PopAsyncIds); env->SetMethod(target, "asyncIdStackSize", AsyncIdStackSize); env->SetMethod(target, "clearIdStack", ClearIdStack); env->SetMethod(target, "addIdToDestroyList", QueueDestroyId); env->SetMethod(target, "enablePromiseHook", EnablePromiseHook); env->SetMethod(target, "disablePromiseHook", DisablePromiseHook); v8::PropertyAttribute ReadOnlyDontDelete = static_cast(v8::ReadOnly | v8::DontDelete); #define FORCE_SET_TARGET_FIELD(obj, str, field) \ (obj)->DefineOwnProperty(context, \ FIXED_ONE_BYTE_STRING(isolate, str), \ field, \ ReadOnlyDontDelete).FromJust() // Attach the uint32_t[] where each slot contains the count of the number of // callbacks waiting to be called on a particular event. It can then be // incremented/decremented from JS quickly to communicate to C++ if there are // any callbacks waiting to be called. FORCE_SET_TARGET_FIELD(target, "async_hook_fields", env->async_hooks()->fields().GetJSArray()); // The following v8::Float64Array has 5 fields. These fields are shared in // this way to allow JS and C++ to read/write each value as quickly as // possible. The fields are represented as follows: // // kAsyncUid: Maintains the state of the next unique id to be assigned. // // kInitTriggerId: Write the id of the resource responsible for a handle's // creation just before calling the new handle's constructor. After the new // handle is constructed kInitTriggerId is set back to 0. FORCE_SET_TARGET_FIELD(target, "async_uid_fields", env->async_hooks()->uid_fields().GetJSArray()); Local constants = Object::New(isolate); #define SET_HOOKS_CONSTANT(name) \ FORCE_SET_TARGET_FIELD( \ constants, #name, Integer::New(isolate, AsyncHooks::name)); SET_HOOKS_CONSTANT(kInit); SET_HOOKS_CONSTANT(kBefore); SET_HOOKS_CONSTANT(kAfter); SET_HOOKS_CONSTANT(kDestroy); SET_HOOKS_CONSTANT(kTotals); SET_HOOKS_CONSTANT(kCurrentAsyncId); SET_HOOKS_CONSTANT(kCurrentTriggerId); SET_HOOKS_CONSTANT(kAsyncUidCntr); SET_HOOKS_CONSTANT(kInitTriggerId); #undef SET_HOOKS_CONSTANT FORCE_SET_TARGET_FIELD(target, "constants", constants); Local async_providers = Object::New(isolate); #define V(p) \ FORCE_SET_TARGET_FIELD( \ async_providers, #p, Integer::New(isolate, AsyncWrap::PROVIDER_ ## p)); NODE_ASYNC_PROVIDER_TYPES(V) #undef V FORCE_SET_TARGET_FIELD(target, "Providers", async_providers); // These Symbols are used throughout node so the stored values on each object // can be accessed easily across files. FORCE_SET_TARGET_FIELD( target, "async_id_symbol", Symbol::New(isolate, FIXED_ONE_BYTE_STRING(isolate, "asyncId"))); FORCE_SET_TARGET_FIELD( target, "trigger_id_symbol", Symbol::New(isolate, FIXED_ONE_BYTE_STRING(isolate, "triggerId"))); #undef FORCE_SET_TARGET_FIELD env->set_async_hooks_init_function(Local()); env->set_async_hooks_before_function(Local()); env->set_async_hooks_after_function(Local()); env->set_async_hooks_destroy_function(Local()); } void LoadAsyncWrapperInfo(Environment* env) { HeapProfiler* heap_profiler = env->isolate()->GetHeapProfiler(); #define V(PROVIDER) \ heap_profiler->SetWrapperClassInfoProvider( \ (NODE_ASYNC_ID_OFFSET + AsyncWrap::PROVIDER_ ## PROVIDER), WrapperInfo); NODE_ASYNC_PROVIDER_TYPES(V) #undef V } AsyncWrap::AsyncWrap(Environment* env, Local object, ProviderType provider, bool silent) : BaseObject(env, object), provider_type_(provider) { CHECK_NE(provider, PROVIDER_NONE); CHECK_GE(object->InternalFieldCount(), 1); // Shift provider value over to prevent id collision. persistent().SetWrapperClassId(NODE_ASYNC_ID_OFFSET + provider); // Use AsyncReset() call to execute the init() callbacks. AsyncReset(silent); } AsyncWrap::~AsyncWrap() { PushBackDestroyId(env(), get_id()); } // Generalized call for both the constructor and for handles that are pooled // and reused over their lifetime. This way a new uid can be assigned when // the resource is pulled out of the pool and put back into use. void AsyncWrap::AsyncReset(bool silent) { async_id_ = env()->new_async_id(); trigger_id_ = env()->get_init_trigger_id(); if (silent) return; EmitAsyncInit(env(), object(), env()->async_hooks()->provider_string(provider_type()), async_id_, trigger_id_); } void AsyncWrap::EmitAsyncInit(Environment* env, Local object, Local type, double async_id, double trigger_id) { CHECK(!object.IsEmpty()); CHECK(!type.IsEmpty()); AsyncHooks* async_hooks = env->async_hooks(); // Nothing to execute, so can continue normally. if (async_hooks->fields()[AsyncHooks::kInit] == 0) { return; } HandleScope scope(env->isolate()); Local init_fn = env->async_hooks_init_function(); Local argv[] = { Number::New(env->isolate(), async_id), type, Number::New(env->isolate(), trigger_id), object, }; TryCatch try_catch(env->isolate()); MaybeLocal ret = init_fn->Call( env->context(), object, arraysize(argv), argv); if (ret.IsEmpty()) { ClearFatalExceptionHandlers(env); FatalException(env->isolate(), try_catch); } } MaybeLocal AsyncWrap::MakeCallback(const Local cb, int argc, Local* argv) { async_context context { get_id(), get_trigger_id() }; return InternalMakeCallback(env(), object(), cb, argc, argv, context); } /* Public C++ embedder API */ async_id AsyncHooksGetExecutionAsyncId(Isolate* isolate) { return Environment::GetCurrent(isolate)->current_async_id(); } async_id AsyncHooksGetTriggerAsyncId(Isolate* isolate) { return Environment::GetCurrent(isolate)->trigger_id(); } async_context EmitAsyncInit(Isolate* isolate, Local resource, const char* name, async_id trigger_async_id) { Local type = String::NewFromUtf8(isolate, name, v8::NewStringType::kInternalized) .ToLocalChecked(); return EmitAsyncInit(isolate, resource, type, trigger_async_id); } async_context EmitAsyncInit(Isolate* isolate, Local resource, v8::Local name, async_id trigger_async_id) { Environment* env = Environment::GetCurrent(isolate); // Initialize async context struct if (trigger_async_id == -1) trigger_async_id = env->get_init_trigger_id(); async_context context = { env->new_async_id(), // async_id_ trigger_async_id // trigger_async_id_ }; // Run init hooks AsyncWrap::EmitAsyncInit(env, resource, name, context.async_id, context.trigger_async_id); return context; } void EmitAsyncDestroy(Isolate* isolate, async_context asyncContext) { PushBackDestroyId(Environment::GetCurrent(isolate), asyncContext.async_id); } } // namespace node NODE_MODULE_CONTEXT_AWARE_BUILTIN(async_wrap, node::AsyncWrap::Initialize)