// 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.
#ifndef SRC_NODE_H_
#define SRC_NODE_H_
#ifdef _WIN32
# ifndef BUILDING_NODE_EXTENSION
# define NODE_EXTERN __declspec(dllexport)
# else
# define NODE_EXTERN __declspec(dllimport)
# endif
#else
# define NODE_EXTERN __attribute__((visibility("default")))
#endif
// Declarations annotated with NODE_EXTERN_PRIVATE do not form part of
// the public API. They are implementation details that can and will
// change between releases, even in semver patch releases. Do not use
// any such symbol in external code.
#ifdef NODE_SHARED_MODE
#define NODE_EXTERN_PRIVATE NODE_EXTERN
#else
#define NODE_EXTERN_PRIVATE
#endif
#ifdef BUILDING_NODE_EXTENSION
# undef BUILDING_V8_SHARED
# undef BUILDING_UV_SHARED
# define USING_V8_SHARED 1
# define USING_UV_SHARED 1
#endif
// This should be defined in make system.
// See issue https://github.com/nodejs/node-v0.x-archive/issues/1236
#if defined(__MINGW32__) || defined(_MSC_VER)
#ifndef _WIN32_WINNT
# define _WIN32_WINNT 0x0600 // Windows Server 2008
#endif
#ifndef NOMINMAX
# define NOMINMAX
#endif
#endif
#if defined(_MSC_VER)
#define PATH_MAX MAX_PATH
#endif
#ifdef _WIN32
# define SIGKILL 9
#endif
#include "v8.h" // NOLINT(build/include_order)
#include "v8-platform.h" // NOLINT(build/include_order)
#include "node_version.h" // NODE_MODULE_VERSION
#define NAPI_EXPERIMENTAL
#include "node_api.h"
#include
#include
#include
// We cannot use __POSIX__ in this header because that's only defined when
// building Node.js.
#ifndef _WIN32
#include
#endif // _WIN32
#define NODE_MAKE_VERSION(major, minor, patch) \
((major) * 0x1000 + (minor) * 0x100 + (patch))
#ifdef __clang__
# define NODE_CLANG_AT_LEAST(major, minor, patch) \
(NODE_MAKE_VERSION(major, minor, patch) DrainTasks() on the associated platform/isolate.
// 3. If the event loop is alive again, go to Step 1.
// 4. Call EmitProcessBeforeExit().
// 5. If the event loop is alive again, go to Step 1.
// 6. Call EmitProcessExit() and forward the return value.
// If at any point node::Stop() is called, the function will attempt to return
// as soon as possible, returning an empty `Maybe`.
// This function only works if `env` has an associated `MultiIsolatePlatform`.
NODE_EXTERN v8::Maybe SpinEventLoop(Environment* env);
NODE_EXTERN std::string GetAnonymousMainPath();
class NODE_EXTERN CommonEnvironmentSetup {
public:
~CommonEnvironmentSetup();
// Create a new CommonEnvironmentSetup, that is, a group of objects that
// together form the typical setup for a single Node.js Environment instance.
// If any error occurs, `*errors` will be populated and the returned pointer
// will be empty.
// env_args will be passed through as arguments to CreateEnvironment(), after
// `isolate_data` and `context`.
template
static std::unique_ptr Create(
MultiIsolatePlatform* platform,
std::vector* errors,
EnvironmentArgs&&... env_args);
template
static std::unique_ptr CreateFromSnapshot(
MultiIsolatePlatform* platform,
std::vector* errors,
const EmbedderSnapshotData* snapshot_data,
EnvironmentArgs&&... env_args);
// Create an embedding setup which will be used for creating a snapshot
// using CreateSnapshot().
//
// This will create and attach a v8::SnapshotCreator to this instance,
// and the same restrictions apply to this instance that also apply to
// other V8 snapshotting environments.
// Not all Node.js APIs are supported in this case. Currently, there is
// no support for native/host objects other than Node.js builtins
// in the snapshot.
//
// If the embedder wants to use LoadEnvironment() later to run a snapshot
// builder script they should make sure args[1] contains the path of the
// snapshot script, which will be used to create __filename and __dirname
// in the context where the builder script is run. If they do not want to
// include the build-time paths into the snapshot, use the string returned
// by GetAnonymousMainPath() as args[1] to anonymize the script.
//
// Snapshots are an *experimental* feature. In particular, the embedder API
// exposed through this class is subject to change or removal between Node.js
// versions, including possible API and ABI breakage.
static std::unique_ptr CreateForSnapshotting(
MultiIsolatePlatform* platform,
std::vector* errors,
const std::vector& args = {},
const std::vector& exec_args = {});
EmbedderSnapshotData::Pointer CreateSnapshot();
struct uv_loop_s* event_loop() const;
v8::SnapshotCreator* snapshot_creator();
// Empty for snapshotting environments.
std::shared_ptr array_buffer_allocator() const;
v8::Isolate* isolate() const;
IsolateData* isolate_data() const;
Environment* env() const;
v8::Local context() const;
CommonEnvironmentSetup(const CommonEnvironmentSetup&) = delete;
CommonEnvironmentSetup& operator=(const CommonEnvironmentSetup&) = delete;
CommonEnvironmentSetup(CommonEnvironmentSetup&&) = delete;
CommonEnvironmentSetup& operator=(CommonEnvironmentSetup&&) = delete;
private:
enum Flags : uint32_t {
kNoFlags = 0,
kIsForSnapshotting = 1,
};
struct Impl;
Impl* impl_;
CommonEnvironmentSetup(
MultiIsolatePlatform*,
std::vector*,
std::function);
CommonEnvironmentSetup(
MultiIsolatePlatform*,
std::vector*,
const EmbedderSnapshotData*,
uint32_t flags,
std::function);
};
// Implementation for CommonEnvironmentSetup::Create
template
std::unique_ptr CommonEnvironmentSetup::Create(
MultiIsolatePlatform* platform,
std::vector* errors,
EnvironmentArgs&&... env_args) {
auto ret = std::unique_ptr(new CommonEnvironmentSetup(
platform, errors,
[&](const CommonEnvironmentSetup* setup) -> Environment* {
return CreateEnvironment(
setup->isolate_data(), setup->context(),
std::forward(env_args)...);
}));
if (!errors->empty()) ret.reset();
return ret;
}
// Implementation for ::CreateFromSnapshot -- the ::Create() method
// could call this with a nullptr snapshot_data in a major version.
template
std::unique_ptr
CommonEnvironmentSetup::CreateFromSnapshot(
MultiIsolatePlatform* platform,
std::vector* errors,
const EmbedderSnapshotData* snapshot_data,
EnvironmentArgs&&... env_args) {
auto ret = std::unique_ptr(new CommonEnvironmentSetup(
platform,
errors,
snapshot_data,
Flags::kNoFlags,
[&](const CommonEnvironmentSetup* setup) -> Environment* {
return CreateEnvironment(setup->isolate_data(),
setup->context(),
std::forward(env_args)...);
}));
if (!errors->empty()) ret.reset();
return ret;
}
/* Converts a unixtime to V8 Date */
NODE_DEPRECATED("Use v8::Date::New() directly",
inline v8::Local NODE_UNIXTIME_V8(double time) {
return v8::Date::New(
v8::Isolate::GetCurrent()->GetCurrentContext(),
1000 * time)
.ToLocalChecked();
})
#define NODE_UNIXTIME_V8 node::NODE_UNIXTIME_V8
NODE_DEPRECATED("Use v8::Date::ValueOf() directly",
inline double NODE_V8_UNIXTIME(v8::Local date) {
return date->ValueOf() / 1000;
})
#define NODE_V8_UNIXTIME node::NODE_V8_UNIXTIME
#define NODE_DEFINE_CONSTANT(target, constant) \
do { \
v8::Isolate* isolate = target->GetIsolate(); \
v8::Local context = isolate->GetCurrentContext(); \
v8::Local constant_name = \
v8::String::NewFromUtf8(isolate, #constant, \
v8::NewStringType::kInternalized).ToLocalChecked(); \
v8::Local constant_value = \
v8::Number::New(isolate, static_cast(constant)); \
v8::PropertyAttribute constant_attributes = \
static_cast(v8::ReadOnly | v8::DontDelete); \
(target)->DefineOwnProperty(context, \
constant_name, \
constant_value, \
constant_attributes).Check(); \
} \
while (0)
#define NODE_DEFINE_HIDDEN_CONSTANT(target, constant) \
do { \
v8::Isolate* isolate = target->GetIsolate(); \
v8::Local context = isolate->GetCurrentContext(); \
v8::Local constant_name = \
v8::String::NewFromUtf8(isolate, #constant, \
v8::NewStringType::kInternalized) \
.ToLocalChecked(); \
v8::Local constant_value = \
v8::Number::New(isolate, static_cast(constant)); \
v8::PropertyAttribute constant_attributes = \
static_cast(v8::ReadOnly | \
v8::DontDelete | \
v8::DontEnum); \
(target)->DefineOwnProperty(context, \
constant_name, \
constant_value, \
constant_attributes).Check(); \
} \
while (0)
// Used to be a macro, hence the uppercase name.
inline void NODE_SET_METHOD(v8::Local recv,
const char* name,
v8::FunctionCallback callback) {
v8::Isolate* isolate = v8::Isolate::GetCurrent();
v8::HandleScope handle_scope(isolate);
v8::Local t = v8::FunctionTemplate::New(isolate,
callback);
v8::Local fn_name = v8::String::NewFromUtf8(isolate, name,
v8::NewStringType::kInternalized).ToLocalChecked();
t->SetClassName(fn_name);
recv->Set(fn_name, t);
}
// Used to be a macro, hence the uppercase name.
inline void NODE_SET_METHOD(v8::Local recv,
const char* name,
v8::FunctionCallback callback) {
v8::Isolate* isolate = v8::Isolate::GetCurrent();
v8::HandleScope handle_scope(isolate);
v8::Local context = isolate->GetCurrentContext();
v8::Local t = v8::FunctionTemplate::New(isolate,
callback);
v8::Local fn = t->GetFunction(context).ToLocalChecked();
v8::Local fn_name = v8::String::NewFromUtf8(isolate, name,
v8::NewStringType::kInternalized).ToLocalChecked();
fn->SetName(fn_name);
recv->Set(context, fn_name, fn).Check();
}
#define NODE_SET_METHOD node::NODE_SET_METHOD
// Used to be a macro, hence the uppercase name.
// Not a template because it only makes sense for FunctionTemplates.
inline void NODE_SET_PROTOTYPE_METHOD(v8::Local recv,
const char* name,
v8::FunctionCallback callback) {
v8::Isolate* isolate = v8::Isolate::GetCurrent();
v8::HandleScope handle_scope(isolate);
v8::Local s = v8::Signature::New(isolate, recv);
v8::Local t =
v8::FunctionTemplate::New(isolate, callback, v8::Local(), s);
v8::Local fn_name = v8::String::NewFromUtf8(isolate, name,
v8::NewStringType::kInternalized).ToLocalChecked();
t->SetClassName(fn_name);
recv->PrototypeTemplate()->Set(fn_name, t);
}
#define NODE_SET_PROTOTYPE_METHOD node::NODE_SET_PROTOTYPE_METHOD
// BINARY is a deprecated alias of LATIN1.
// BASE64URL is not currently exposed to the JavaScript side.
enum encoding {
ASCII,
UTF8,
BASE64,
UCS2,
BINARY,
HEX,
BUFFER,
BASE64URL,
LATIN1 = BINARY
};
NODE_EXTERN enum encoding ParseEncoding(
v8::Isolate* isolate,
v8::Local encoding_v,
enum encoding default_encoding = LATIN1);
NODE_EXTERN void FatalException(v8::Isolate* isolate,
const v8::TryCatch& try_catch);
NODE_EXTERN v8::Local Encode(v8::Isolate* isolate,
const char* buf,
size_t len,
enum encoding encoding = LATIN1);
// Warning: This reverses endianness on Big Endian platforms, even though the
// signature using uint16_t implies that it should not.
NODE_EXTERN v8::Local Encode(v8::Isolate* isolate,
const uint16_t* buf,
size_t len);
// Returns -1 if the handle was not valid for decoding
NODE_EXTERN ssize_t DecodeBytes(v8::Isolate* isolate,
v8::Local,
enum encoding encoding = LATIN1);
// returns bytes written.
NODE_EXTERN ssize_t DecodeWrite(v8::Isolate* isolate,
char* buf,
size_t buflen,
v8::Local,
enum encoding encoding = LATIN1);
#ifdef _WIN32
NODE_EXTERN v8::Local WinapiErrnoException(
v8::Isolate* isolate,
int errorno,
const char* syscall = nullptr,
const char* msg = "",
const char* path = nullptr);
#endif
const char* signo_string(int errorno);
typedef void (*addon_register_func)(
v8::Local exports,
v8::Local module,
void* priv);
typedef void (*addon_context_register_func)(
v8::Local exports,
v8::Local module,
v8::Local context,
void* priv);
enum ModuleFlags {
kLinked = 0x02
};
struct node_module {
int nm_version;
unsigned int nm_flags;
void* nm_dso_handle;
const char* nm_filename;
node::addon_register_func nm_register_func;
node::addon_context_register_func nm_context_register_func;
const char* nm_modname;
void* nm_priv;
struct node_module* nm_link;
};
extern "C" NODE_EXTERN void node_module_register(void* mod);
#ifdef _WIN32
# define NODE_MODULE_EXPORT __declspec(dllexport)
#else
# define NODE_MODULE_EXPORT __attribute__((visibility("default")))
#endif
#ifdef NODE_SHARED_MODE
# define NODE_CTOR_PREFIX
#else
# define NODE_CTOR_PREFIX static
#endif
#if defined(_MSC_VER)
#define NODE_C_CTOR(fn) \
NODE_CTOR_PREFIX void __cdecl fn(void); \
namespace { \
struct fn##_ { \
fn##_() { fn(); }; \
} fn##_v_; \
} \
NODE_CTOR_PREFIX void __cdecl fn(void)
#else
#define NODE_C_CTOR(fn) \
NODE_CTOR_PREFIX void fn(void) __attribute__((constructor)); \
NODE_CTOR_PREFIX void fn(void)
#endif
#define NODE_MODULE_X(modname, regfunc, priv, flags) \
extern "C" { \
static node::node_module _module = \
{ \
NODE_MODULE_VERSION, \
flags, \
NULL, /* NOLINT (readability/null_usage) */ \
__FILE__, \
(node::addon_register_func) (regfunc), \
NULL, /* NOLINT (readability/null_usage) */ \
NODE_STRINGIFY(modname), \
priv, \
NULL /* NOLINT (readability/null_usage) */ \
}; \
NODE_C_CTOR(_register_ ## modname) { \
node_module_register(&_module); \
} \
}
#define NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, priv, flags) \
extern "C" { \
static node::node_module _module = \
{ \
NODE_MODULE_VERSION, \
flags, \
NULL, /* NOLINT (readability/null_usage) */ \
__FILE__, \
NULL, /* NOLINT (readability/null_usage) */ \
(node::addon_context_register_func) (regfunc), \
NODE_STRINGIFY(modname), \
priv, \
NULL /* NOLINT (readability/null_usage) */ \
}; \
NODE_C_CTOR(_register_ ## modname) { \
node_module_register(&_module); \
} \
}
// Usage: `NODE_MODULE(NODE_GYP_MODULE_NAME, InitializerFunction)`
// If no NODE_MODULE is declared, Node.js looks for the well-known
// symbol `node_register_module_v${NODE_MODULE_VERSION}`.
#define NODE_MODULE(modname, regfunc) \
NODE_MODULE_X(modname, regfunc, NULL, 0) // NOLINT (readability/null_usage)
#define NODE_MODULE_CONTEXT_AWARE(modname, regfunc) \
/* NOLINTNEXTLINE (readability/null_usage) */ \
NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL, 0)
// Embedders can use this type of binding for statically linked native bindings.
// It is used the same way addon bindings are used, except that linked bindings
// can be accessed through `process._linkedBinding(modname)`.
#define NODE_MODULE_LINKED(modname, regfunc) \
/* NOLINTNEXTLINE (readability/null_usage) */ \
NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL, \
node::ModuleFlags::kLinked)
/*
* For backward compatibility in add-on modules.
*/
#define NODE_MODULE_DECL /* nothing */
#define NODE_MODULE_INITIALIZER_BASE node_register_module_v
#define NODE_MODULE_INITIALIZER_X(base, version) \
NODE_MODULE_INITIALIZER_X_HELPER(base, version)
#define NODE_MODULE_INITIALIZER_X_HELPER(base, version) base##version
#define NODE_MODULE_INITIALIZER \
NODE_MODULE_INITIALIZER_X(NODE_MODULE_INITIALIZER_BASE, \
NODE_MODULE_VERSION)
#define NODE_MODULE_INIT() \
extern "C" NODE_MODULE_EXPORT void \
NODE_MODULE_INITIALIZER(v8::Local exports, \
v8::Local module, \
v8::Local context); \
NODE_MODULE_CONTEXT_AWARE(NODE_GYP_MODULE_NAME, \
NODE_MODULE_INITIALIZER) \
void NODE_MODULE_INITIALIZER(v8::Local exports, \
v8::Local module, \
v8::Local context)
// Allows embedders to add a binding to the current Environment* that can be
// accessed through process._linkedBinding() in the target Environment and all
// Worker threads that it creates.
// In each variant, the registration function needs to be usable at least for
// the time during which the Environment exists.
NODE_EXTERN void AddLinkedBinding(Environment* env, const node_module& mod);
NODE_EXTERN void AddLinkedBinding(Environment* env,
const struct napi_module& mod);
NODE_EXTERN void AddLinkedBinding(Environment* env,
const char* name,
addon_context_register_func fn,
void* priv);
NODE_EXTERN void AddLinkedBinding(
Environment* env,
const char* name,
napi_addon_register_func fn,
int32_t module_api_version = NODE_API_DEFAULT_MODULE_API_VERSION);
/* Registers a callback with the passed-in Environment instance. The callback
* is called after the event loop exits, but before the VM is disposed.
* Callbacks are run in reverse order of registration, i.e. newest first.
*/
NODE_EXTERN void AtExit(Environment* env,
void (*cb)(void* arg),
void* arg);
typedef double async_id;
struct async_context {
::node::async_id async_id;
::node::async_id trigger_async_id;
};
/* This is a lot like node::AtExit, except that the hooks added via this
* function are run before the AtExit ones and will always be registered
* for the current Environment instance.
* These functions are safe to use in an addon supporting multiple
* threads/isolates. */
NODE_EXTERN void AddEnvironmentCleanupHook(v8::Isolate* isolate,
void (*fun)(void* arg),
void* arg);
NODE_EXTERN void RemoveEnvironmentCleanupHook(v8::Isolate* isolate,
void (*fun)(void* arg),
void* arg);
/* These are async equivalents of the above. After the cleanup hook is invoked,
* `cb(cbarg)` *must* be called, and attempting to remove the cleanup hook will
* have no effect. */
struct ACHHandle;
struct NODE_EXTERN DeleteACHHandle { void operator()(ACHHandle*) const; };
typedef std::unique_ptr AsyncCleanupHookHandle;
/* This function is not intended to be used externally, it exists to aid in
* keeping ABI compatibility between Node and Electron. */
NODE_EXTERN ACHHandle* AddEnvironmentCleanupHookInternal(
v8::Isolate* isolate,
void (*fun)(void* arg, void (*cb)(void*), void* cbarg),
void* arg);
inline AsyncCleanupHookHandle AddEnvironmentCleanupHook(
v8::Isolate* isolate,
void (*fun)(void* arg, void (*cb)(void*), void* cbarg),
void* arg) {
return AsyncCleanupHookHandle(AddEnvironmentCleanupHookInternal(isolate, fun,
arg));
}
/* This function is not intended to be used externally, it exists to aid in
* keeping ABI compatibility between Node and Electron. */
NODE_EXTERN void RemoveEnvironmentCleanupHookInternal(ACHHandle* holder);
inline void RemoveEnvironmentCleanupHook(AsyncCleanupHookHandle holder) {
RemoveEnvironmentCleanupHookInternal(holder.get());
}
// This behaves like V8's Isolate::RequestInterrupt(), but also wakes up
// the event loop if it is currently idle. Interrupt requests are drained
// in `FreeEnvironment()`. The passed callback can not call back into
// JavaScript.
// This function can be called from any thread.
NODE_EXTERN void RequestInterrupt(Environment* env,
void (*fun)(void* arg),
void* arg);
/* Returns the id of the current execution context. If the return value is
* zero then no execution has been set. This will happen if the user handles
* I/O from native code. */
NODE_EXTERN async_id AsyncHooksGetExecutionAsyncId(v8::Isolate* isolate);
/* Return same value as async_hooks.triggerAsyncId(); */
NODE_EXTERN async_id AsyncHooksGetTriggerAsyncId(v8::Isolate* isolate);
/* If the native API doesn't inherit from the helper class then the callbacks
* must be triggered manually. This triggers the init() callback. The return
* value is the async id assigned to the resource.
*
* The `trigger_async_id` parameter should correspond to the resource which is
* creating the new resource, which will usually be the return value of
* `AsyncHooksGetTriggerAsyncId()`. */
NODE_EXTERN async_context EmitAsyncInit(v8::Isolate* isolate,
v8::Local resource,
const char* name,
async_id trigger_async_id = -1);
NODE_EXTERN async_context EmitAsyncInit(v8::Isolate* isolate,
v8::Local resource,
v8::Local name,
async_id trigger_async_id = -1);
/* Emit the destroy() callback. The overload taking an `Environment*` argument
* should be used when the Isolates current Context is not associated with
* a Node.js Environment, or when there is no current Context, for example
* when calling this function during garbage collection. In that case, the
* `Environment*` value should have been acquired previously, e.g. through
* `GetCurrentEnvironment()`. */
NODE_EXTERN void EmitAsyncDestroy(v8::Isolate* isolate,
async_context asyncContext);
NODE_EXTERN void EmitAsyncDestroy(Environment* env,
async_context asyncContext);
class InternalCallbackScope;
/* This class works like `MakeCallback()` in that it sets up a specific
* asyncContext as the current one and informs the async_hooks and domains
* modules that this context is currently active.
*
* `MakeCallback()` is a wrapper around this class as well as
* `Function::Call()`. Either one of these mechanisms needs to be used for
* top-level calls into JavaScript (i.e. without any existing JS stack).
*
* This object should be stack-allocated to ensure that it is contained in a
* valid HandleScope.
*
* Exceptions happening within this scope will be treated like uncaught
* exceptions. If this behaviour is undesirable, a new `v8::TryCatch` scope
* needs to be created inside of this scope.
*/
class NODE_EXTERN CallbackScope {
public:
CallbackScope(v8::Isolate* isolate,
v8::Local resource,
async_context asyncContext);
CallbackScope(Environment* env,
v8::Local resource,
async_context asyncContext);
~CallbackScope();
void operator=(const CallbackScope&) = delete;
void operator=(CallbackScope&&) = delete;
CallbackScope(const CallbackScope&) = delete;
CallbackScope(CallbackScope&&) = delete;
private:
InternalCallbackScope* private_;
v8::TryCatch try_catch_;
};
/* An API specific to emit before/after callbacks is unnecessary because
* MakeCallback will automatically call them for you.
*
* These methods may create handles on their own, so run them inside a
* HandleScope.
*
* `asyncId` and `triggerAsyncId` should correspond to the values returned by
* `EmitAsyncInit()` and `AsyncHooksGetTriggerAsyncId()`, respectively, when the
* invoking resource was created. If these values are unknown, 0 can be passed.
* */
NODE_EXTERN
v8::MaybeLocal MakeCallback(v8::Isolate* isolate,
v8::Local recv,
v8::Local callback,
int argc,
v8::Local* argv,
async_context asyncContext);
NODE_EXTERN
v8::MaybeLocal MakeCallback(v8::Isolate* isolate,
v8::Local recv,
const char* method,
int argc,
v8::Local* argv,
async_context asyncContext);
NODE_EXTERN
v8::MaybeLocal MakeCallback(v8::Isolate* isolate,
v8::Local recv,
v8::Local symbol,
int argc,
v8::Local* argv,
async_context asyncContext);
/* Helper class users can optionally inherit from. If
* `AsyncResource::MakeCallback()` is used, then all four callbacks will be
* called automatically. */
class NODE_EXTERN AsyncResource {
public:
AsyncResource(v8::Isolate* isolate,
v8::Local resource,
const char* name,
async_id trigger_async_id = -1);
virtual ~AsyncResource();
AsyncResource(const AsyncResource&) = delete;
void operator=(const AsyncResource&) = delete;
v8::MaybeLocal MakeCallback(
v8::Local callback,
int argc,
v8::Local* argv);
v8::MaybeLocal MakeCallback(
const char* method,
int argc,
v8::Local* argv);
v8::MaybeLocal MakeCallback(
v8::Local symbol,
int argc,
v8::Local* argv);
v8::Local get_resource();
async_id get_async_id() const;
async_id get_trigger_async_id() const;
protected:
class NODE_EXTERN CallbackScope : public node::CallbackScope {
public:
explicit CallbackScope(AsyncResource* res);
};
private:
Environment* env_;
v8::Global resource_;
async_context async_context_;
};
#ifndef _WIN32
// Register a signal handler without interrupting any handlers that node
// itself needs. This does override handlers registered through
// process.on('SIG...', function() { ... }). The `reset_handler` flag indicates
// whether the signal handler for the given signal should be reset to its
// default value before executing the handler (i.e. it works like SA_RESETHAND).
// The `reset_handler` flag is invalid when `signal` is SIGSEGV.
NODE_EXTERN
void RegisterSignalHandler(int signal,
void (*handler)(int signal,
siginfo_t* info,
void* ucontext),
bool reset_handler = false);
#endif // _WIN32
// Configure the layout of the JavaScript object with a cppgc::GarbageCollected
// instance so that when the JavaScript object is reachable, the garbage
// collected instance would have its Trace() method invoked per the cppgc
// contract. To make it work, the process must have called
// cppgc::InitializeProcess() before, which is usually the case for addons
// loaded by the stand-alone Node.js executable. Embedders of Node.js can use
// either need to call it themselves or make sure that
// ProcessInitializationFlags::kNoInitializeCppgc is *not* set for cppgc to
// work.
// If the CppHeap is owned by Node.js, which is usually the case for addon,
// the object must be created with at least two internal fields available,
// and the first two internal fields would be configured by Node.js.
// This may be superseded by a V8 API in the future, see
// https://bugs.chromium.org/p/v8/issues/detail?id=13960. Until then this
// serves as a helper for Node.js isolates.
NODE_EXTERN void SetCppgcReference(v8::Isolate* isolate,
v8::Local object,
void* wrappable);
} // namespace node
#endif // SRC_NODE_H_