#include "node_internals.h" #include "async_wrap.h" #include "node_buffer.h" #include "node_platform.h" #include "node_file.h" #include "tracing/agent.h" #include #include namespace node { using v8::Context; using v8::FunctionTemplate; using v8::HandleScope; using v8::Integer; using v8::Isolate; using v8::Local; using v8::Message; using v8::Number; using v8::Private; using v8::StackFrame; using v8::StackTrace; using v8::String; using v8::Value; IsolateData::IsolateData(Isolate* isolate, uv_loop_t* event_loop, MultiIsolatePlatform* platform, uint32_t* zero_fill_field) : isolate_(isolate), event_loop_(event_loop), zero_fill_field_(zero_fill_field), platform_(platform) { if (platform_ != nullptr) platform_->RegisterIsolate(this, event_loop); // Create string and private symbol properties as internalized one byte // strings after the platform is properly initialized. // // Internalized because it makes property lookups a little faster and // because the string is created in the old space straight away. It's going // to end up in the old space sooner or later anyway but now it doesn't go // through v8::Eternal's new space handling first. // // One byte because our strings are ASCII and we can safely skip V8's UTF-8 // decoding step. #define V(PropertyName, StringValue) \ PropertyName ## _.Set( \ isolate, \ Private::New( \ isolate, \ String::NewFromOneByte( \ isolate, \ reinterpret_cast(StringValue), \ v8::NewStringType::kInternalized, \ sizeof(StringValue) - 1).ToLocalChecked())); PER_ISOLATE_PRIVATE_SYMBOL_PROPERTIES(V) #undef V #define V(PropertyName, StringValue) \ PropertyName ## _.Set( \ isolate, \ String::NewFromOneByte( \ isolate, \ reinterpret_cast(StringValue), \ v8::NewStringType::kInternalized, \ sizeof(StringValue) - 1).ToLocalChecked()); PER_ISOLATE_STRING_PROPERTIES(V) #undef V } IsolateData::~IsolateData() { if (platform_ != nullptr) platform_->UnregisterIsolate(this); if (cpu_profiler_ != nullptr) cpu_profiler_->Dispose(); } v8::CpuProfiler* IsolateData::GetCpuProfiler() { if (cpu_profiler_ != nullptr) return cpu_profiler_; cpu_profiler_ = v8::CpuProfiler::New(isolate()); CHECK_NE(cpu_profiler_, nullptr); return cpu_profiler_; } void InitThreadLocalOnce() { CHECK_EQ(0, uv_key_create(&Environment::thread_local_env)); } Environment::Environment(IsolateData* isolate_data, Local context, tracing::Agent* tracing_agent) : isolate_(context->GetIsolate()), isolate_data_(isolate_data), tracing_agent_(tracing_agent), immediate_info_(context->GetIsolate()), tick_info_(context->GetIsolate()), timer_base_(uv_now(isolate_data->event_loop())), printed_error_(false), trace_sync_io_(false), abort_on_uncaught_exception_(false), emit_env_nonstring_warning_(true), makecallback_cntr_(0), should_abort_on_uncaught_toggle_(isolate_, 1), #if HAVE_INSPECTOR inspector_agent_(new inspector::Agent(this)), #endif handle_cleanup_waiting_(0), http_parser_buffer_(nullptr), fs_stats_field_array_(isolate_, kFsStatsFieldsLength * 2), context_(context->GetIsolate(), context) { // We'll be creating new objects so make sure we've entered the context. v8::HandleScope handle_scope(isolate()); v8::Context::Scope context_scope(context); set_as_external(v8::External::New(isolate(), this)); AssignToContext(context, ContextInfo("")); destroy_async_id_list_.reserve(512); performance_state_.reset(new performance::performance_state(isolate())); performance_state_->Mark( performance::NODE_PERFORMANCE_MILESTONE_ENVIRONMENT); performance_state_->Mark( performance::NODE_PERFORMANCE_MILESTONE_NODE_START, performance::performance_node_start); performance_state_->Mark( performance::NODE_PERFORMANCE_MILESTONE_V8_START, performance::performance_v8_start); // By default, always abort when --abort-on-uncaught-exception was passed. should_abort_on_uncaught_toggle_[0] = 1; } Environment::~Environment() { v8::HandleScope handle_scope(isolate()); #if HAVE_INSPECTOR // Destroy inspector agent before erasing the context. The inspector // destructor depends on the context still being accessible. inspector_agent_.reset(); #endif context()->SetAlignedPointerInEmbedderData( ContextEmbedderIndex::kEnvironment, nullptr); delete[] heap_statistics_buffer_; delete[] heap_space_statistics_buffer_; delete[] http_parser_buffer_; } void Environment::Start(int argc, const char* const* argv, int exec_argc, const char* const* exec_argv, bool start_profiler_idle_notifier) { HandleScope handle_scope(isolate()); Context::Scope context_scope(context()); uv_check_init(event_loop(), immediate_check_handle()); uv_unref(reinterpret_cast(immediate_check_handle())); uv_idle_init(event_loop(), immediate_idle_handle()); uv_check_start(immediate_check_handle(), CheckImmediate); // Inform V8's CPU profiler when we're idle. The profiler is sampling-based // but not all samples are created equal; mark the wall clock time spent in // epoll_wait() and friends so profiling tools can filter it out. The samples // still end up in v8.log but with state=IDLE rather than state=EXTERNAL. // TODO(bnoordhuis) Depends on a libuv implementation detail that we should // probably fortify in the API contract, namely that the last started prepare // or check watcher runs first. It's not 100% foolproof; if an add-on starts // a prepare or check watcher after us, any samples attributed to its callback // will be recorded with state=IDLE. uv_prepare_init(event_loop(), &idle_prepare_handle_); uv_check_init(event_loop(), &idle_check_handle_); uv_unref(reinterpret_cast(&idle_prepare_handle_)); uv_unref(reinterpret_cast(&idle_check_handle_)); // Register clean-up cb to be called to clean up the handles // when the environment is freed, note that they are not cleaned in // the one environment per process setup, but will be called in // FreeEnvironment. RegisterHandleCleanups(); if (start_profiler_idle_notifier) { StartProfilerIdleNotifier(); } auto process_template = FunctionTemplate::New(isolate()); process_template->SetClassName(FIXED_ONE_BYTE_STRING(isolate(), "process")); auto process_object = process_template->GetFunction()->NewInstance(context()).ToLocalChecked(); set_process_object(process_object); SetupProcessObject(this, argc, argv, exec_argc, exec_argv); LoadAsyncWrapperInfo(this); static uv_once_t init_once = UV_ONCE_INIT; uv_once(&init_once, InitThreadLocalOnce); uv_key_set(&thread_local_env, this); } void Environment::RegisterHandleCleanups() { HandleCleanupCb close_and_finish = [](Environment* env, uv_handle_t* handle, void* arg) { handle->data = env; uv_close(handle, [](uv_handle_t* handle) { static_cast(handle->data)->FinishHandleCleanup(handle); }); }; RegisterHandleCleanup( reinterpret_cast(immediate_check_handle()), close_and_finish, nullptr); RegisterHandleCleanup( reinterpret_cast(immediate_idle_handle()), close_and_finish, nullptr); RegisterHandleCleanup( reinterpret_cast(&idle_prepare_handle_), close_and_finish, nullptr); RegisterHandleCleanup( reinterpret_cast(&idle_check_handle_), close_and_finish, nullptr); } void Environment::CleanupHandles() { for (HandleCleanup& hc : handle_cleanup_queue_) { handle_cleanup_waiting_++; hc.cb_(this, hc.handle_, hc.arg_); } handle_cleanup_queue_.clear(); while (handle_cleanup_waiting_ != 0) uv_run(event_loop(), UV_RUN_ONCE); } void Environment::StartProfilerIdleNotifier() { uv_prepare_start(&idle_prepare_handle_, [](uv_prepare_t* handle) { Environment* env = ContainerOf(&Environment::idle_prepare_handle_, handle); env->isolate_data()->GetCpuProfiler()->SetIdle(true); }); uv_check_start(&idle_check_handle_, [](uv_check_t* handle) { Environment* env = ContainerOf(&Environment::idle_check_handle_, handle); env->isolate_data()->GetCpuProfiler()->SetIdle(false); }); } void Environment::StopProfilerIdleNotifier() { uv_prepare_stop(&idle_prepare_handle_); uv_check_stop(&idle_check_handle_); } void Environment::PrintSyncTrace() const { if (!trace_sync_io_) return; HandleScope handle_scope(isolate()); Local stack = StackTrace::CurrentStackTrace(isolate(), 10, StackTrace::kDetailed); fprintf(stderr, "(node:%u) WARNING: Detected use of sync API\n", uv_os_getpid()); for (int i = 0; i < stack->GetFrameCount() - 1; i++) { Local stack_frame = stack->GetFrame(i); node::Utf8Value fn_name_s(isolate(), stack_frame->GetFunctionName()); node::Utf8Value script_name(isolate(), stack_frame->GetScriptName()); const int line_number = stack_frame->GetLineNumber(); const int column = stack_frame->GetColumn(); if (stack_frame->IsEval()) { if (stack_frame->GetScriptId() == Message::kNoScriptIdInfo) { fprintf(stderr, " at [eval]:%i:%i\n", line_number, column); } else { fprintf(stderr, " at [eval] (%s:%i:%i)\n", *script_name, line_number, column); } break; } if (fn_name_s.length() == 0) { fprintf(stderr, " at %s:%i:%i\n", *script_name, line_number, column); } else { fprintf(stderr, " at %s (%s:%i:%i)\n", *fn_name_s, *script_name, line_number, column); } } fflush(stderr); } void Environment::RunBeforeExitCallbacks() { for (ExitCallback before_exit : before_exit_functions_) { before_exit.cb_(before_exit.arg_); } before_exit_functions_.clear(); } void Environment::BeforeExit(void (*cb)(void* arg), void* arg) { before_exit_functions_.push_back(ExitCallback{cb, arg}); } void Environment::RunAtExitCallbacks() { for (ExitCallback at_exit : at_exit_functions_) { at_exit.cb_(at_exit.arg_); } at_exit_functions_.clear(); } void Environment::AtExit(void (*cb)(void* arg), void* arg) { at_exit_functions_.push_back(ExitCallback{cb, arg}); } void Environment::AddPromiseHook(promise_hook_func fn, void* arg) { auto it = std::find_if( promise_hooks_.begin(), promise_hooks_.end(), [&](const PromiseHookCallback& hook) { return hook.cb_ == fn && hook.arg_ == arg; }); if (it != promise_hooks_.end()) { it->enable_count_++; return; } promise_hooks_.push_back(PromiseHookCallback{fn, arg, 1}); if (promise_hooks_.size() == 1) { isolate_->SetPromiseHook(EnvPromiseHook); } } bool Environment::RemovePromiseHook(promise_hook_func fn, void* arg) { auto it = std::find_if( promise_hooks_.begin(), promise_hooks_.end(), [&](const PromiseHookCallback& hook) { return hook.cb_ == fn && hook.arg_ == arg; }); if (it == promise_hooks_.end()) return false; if (--it->enable_count_ > 0) return true; promise_hooks_.erase(it); if (promise_hooks_.empty()) { isolate_->SetPromiseHook(nullptr); } return true; } void Environment::EnvPromiseHook(v8::PromiseHookType type, v8::Local promise, v8::Local parent) { Environment* env = Environment::GetCurrent(promise->CreationContext()); for (const PromiseHookCallback& hook : env->promise_hooks_) { hook.cb_(type, promise, parent, hook.arg_); } } void Environment::RunAndClearNativeImmediates() { size_t count = native_immediate_callbacks_.size(); if (count > 0) { size_t ref_count = 0; std::vector list; native_immediate_callbacks_.swap(list); auto drain_list = [&]() { v8::TryCatch try_catch(isolate()); for (auto it = list.begin(); it != list.end(); ++it) { #ifdef DEBUG v8::SealHandleScope seal_handle_scope(isolate()); #endif it->cb_(this, it->data_); if (it->refed_) ref_count++; if (UNLIKELY(try_catch.HasCaught())) { FatalException(isolate(), try_catch); // Bail out, remove the already executed callbacks from list // and set up a new TryCatch for the other pending callbacks. std::move_backward(it, list.end(), list.begin() + (list.end() - it)); list.resize(list.end() - it); return true; } } return false; }; while (drain_list()) {} #ifdef DEBUG CHECK_GE(immediate_info()->count(), count); #endif immediate_info()->count_dec(count); immediate_info()->ref_count_dec(ref_count); } } void Environment::CheckImmediate(uv_check_t* handle) { Environment* env = Environment::from_immediate_check_handle(handle); if (env->immediate_info()->count() == 0) return; HandleScope scope(env->isolate()); Context::Scope context_scope(env->context()); env->RunAndClearNativeImmediates(); do { MakeCallback(env->isolate(), env->process_object(), env->immediate_callback_function(), 0, nullptr, {0, 0}).ToLocalChecked(); } while (env->immediate_info()->has_outstanding()); if (env->immediate_info()->ref_count() == 0) env->ToggleImmediateRef(false); } void Environment::ToggleImmediateRef(bool ref) { if (ref) { // Idle handle is needed only to stop the event loop from blocking in poll. uv_idle_start(immediate_idle_handle(), [](uv_idle_t*){ }); } else { uv_idle_stop(immediate_idle_handle()); } } Local Environment::GetNow() { uv_update_time(event_loop()); uint64_t now = uv_now(event_loop()); CHECK_GE(now, timer_base()); now -= timer_base(); if (now <= 0xffffffff) return Integer::New(isolate(), static_cast(now)); else return Number::New(isolate(), static_cast(now)); } void CollectExceptionInfo(Environment* env, v8::Local obj, int errorno, const char* err_string, const char* syscall, const char* message, const char* path, const char* dest) { obj->Set(env->errno_string(), v8::Integer::New(env->isolate(), errorno)); obj->Set(env->context(), env->code_string(), OneByteString(env->isolate(), err_string)).FromJust(); if (message != nullptr) { obj->Set(env->context(), env->message_string(), OneByteString(env->isolate(), message)).FromJust(); } v8::Local path_buffer; if (path != nullptr) { path_buffer = Buffer::Copy(env->isolate(), path, strlen(path)).ToLocalChecked(); obj->Set(env->context(), env->path_string(), path_buffer).FromJust(); } v8::Local dest_buffer; if (dest != nullptr) { dest_buffer = Buffer::Copy(env->isolate(), dest, strlen(dest)).ToLocalChecked(); obj->Set(env->context(), env->dest_string(), dest_buffer).FromJust(); } if (syscall != nullptr) { obj->Set(env->context(), env->syscall_string(), OneByteString(env->isolate(), syscall)).FromJust(); } } void Environment::CollectExceptionInfo(v8::Local object, int errorno, const char* syscall, const char* message, const char* path) { if (!object->IsObject() || errorno == 0) return; v8::Local obj = object.As(); const char* err_string = node::errno_string(errorno); if (message == nullptr || message[0] == '\0') { message = strerror(errorno); } node::CollectExceptionInfo(this, obj, errorno, err_string, syscall, message, path, nullptr); } void Environment::CollectUVExceptionInfo(v8::Local object, int errorno, const char* syscall, const char* message, const char* path, const char* dest) { if (!object->IsObject() || errorno == 0) return; v8::Local obj = object.As(); const char* err_string = uv_err_name(errorno); if (message == nullptr || message[0] == '\0') { message = uv_strerror(errorno); } node::CollectExceptionInfo(this, obj, errorno, err_string, syscall, message, path, dest); } void Environment::AsyncHooks::grow_async_ids_stack() { const uint32_t old_capacity = async_ids_stack_.Length() / 2; const uint32_t new_capacity = old_capacity * 1.5; AliasedBuffer new_buffer( env()->isolate(), new_capacity * 2); for (uint32_t i = 0; i < old_capacity * 2; ++i) new_buffer[i] = async_ids_stack_[i]; async_ids_stack_ = std::move(new_buffer); env()->async_hooks_binding()->Set( env()->context(), env()->async_ids_stack_string(), async_ids_stack_.GetJSArray()).FromJust(); } uv_key_t Environment::thread_local_env = {}; } // namespace node