GCC Code Coverage Report
Directory: ../ Exec Total Coverage
File: /home/iojs/build/workspace/node-test-commit-linux-coverage-daily/nodes/benchmark/out/../src/node.h Lines: 15 15 100.0 %
Date: 2020-12-12 04:11:07 Branches: 1 2 50.0 %

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
#ifndef SRC_NODE_H_
23
#define SRC_NODE_H_
24
25
#ifdef _WIN32
26
# ifndef BUILDING_NODE_EXTENSION
27
#  define NODE_EXTERN __declspec(dllexport)
28
# else
29
#  define NODE_EXTERN __declspec(dllimport)
30
# endif
31
#else
32
# define NODE_EXTERN __attribute__((visibility("default")))
33
#endif
34
35
#ifdef BUILDING_NODE_EXTENSION
36
# undef BUILDING_V8_SHARED
37
# undef BUILDING_UV_SHARED
38
# define USING_V8_SHARED 1
39
# define USING_UV_SHARED 1
40
#endif
41
42
// This should be defined in make system.
43
// See issue https://github.com/nodejs/node-v0.x-archive/issues/1236
44
#if defined(__MINGW32__) || defined(_MSC_VER)
45
#ifndef _WIN32_WINNT
46
# define _WIN32_WINNT 0x0600  // Windows Server 2008
47
#endif
48
49
#ifndef NOMINMAX
50
# define NOMINMAX
51
#endif
52
53
#endif
54
55
#if defined(_MSC_VER)
56
#define PATH_MAX MAX_PATH
57
#endif
58
59
#ifdef _WIN32
60
# define SIGKILL 9
61
#endif
62
63
#include "v8.h"  // NOLINT(build/include_order)
64
65
#include "v8-platform.h"  // NOLINT(build/include_order)
66
#include "node_version.h"  // NODE_MODULE_VERSION
67
68
#include <memory>
69
#include <functional>
70
71
// We cannot use __POSIX__ in this header because that's only defined when
72
// building Node.js.
73
#ifndef _WIN32
74
#include <signal.h>
75
#endif  // _WIN32
76
77
#define NODE_MAKE_VERSION(major, minor, patch)                                \
78
  ((major) * 0x1000 + (minor) * 0x100 + (patch))
79
80
#ifdef __clang__
81
# define NODE_CLANG_AT_LEAST(major, minor, patch)                             \
82
  (NODE_MAKE_VERSION(major, minor, patch) <=                                  \
83
      NODE_MAKE_VERSION(__clang_major__, __clang_minor__, __clang_patchlevel__))
84
#else
85
# define NODE_CLANG_AT_LEAST(major, minor, patch) (0)
86
#endif
87
88
#ifdef __GNUC__
89
# define NODE_GNUC_AT_LEAST(major, minor, patch)                              \
90
  (NODE_MAKE_VERSION(major, minor, patch) <=                                  \
91
      NODE_MAKE_VERSION(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__))
92
#else
93
# define NODE_GNUC_AT_LEAST(major, minor, patch) (0)
94
#endif
95
96
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
97
# define NODE_DEPRECATED(message, declarator) declarator
98
#else  // NODE_WANT_INTERNALS
99
# if NODE_CLANG_AT_LEAST(2, 9, 0) || NODE_GNUC_AT_LEAST(4, 5, 0)
100
#  define NODE_DEPRECATED(message, declarator)                                 \
101
    __attribute__((deprecated(message))) declarator
102
# elif defined(_MSC_VER)
103
#  define NODE_DEPRECATED(message, declarator)                                 \
104
    __declspec(deprecated) declarator
105
# else
106
#  define NODE_DEPRECATED(message, declarator) declarator
107
# endif
108
#endif
109
110
// Forward-declare libuv loop
111
struct uv_loop_s;
112
113
struct napi_module;
114
115
// Forward-declare these functions now to stop MSVS from becoming
116
// terminally confused when it's done in node_internals.h
117
namespace node {
118
119
namespace tracing {
120
121
class TracingController;
122
123
}
124
125
NODE_EXTERN v8::Local<v8::Value> ErrnoException(v8::Isolate* isolate,
126
                                                int errorno,
127
                                                const char* syscall = nullptr,
128
                                                const char* message = nullptr,
129
                                                const char* path = nullptr);
130
NODE_EXTERN v8::Local<v8::Value> UVException(v8::Isolate* isolate,
131
                                             int errorno,
132
                                             const char* syscall = nullptr,
133
                                             const char* message = nullptr,
134
                                             const char* path = nullptr,
135
                                             const char* dest = nullptr);
136
137
NODE_DEPRECATED("Use ErrnoException(isolate, ...)",
138
                inline v8::Local<v8::Value> ErrnoException(
139
      int errorno,
140
      const char* syscall = nullptr,
141
      const char* message = nullptr,
142
      const char* path = nullptr) {
143
  return ErrnoException(v8::Isolate::GetCurrent(),
144
                        errorno,
145
                        syscall,
146
                        message,
147
                        path);
148
})
149
150
NODE_DEPRECATED("Use UVException(isolate, ...)",
151
                inline v8::Local<v8::Value> UVException(int errorno,
152
                                        const char* syscall = nullptr,
153
                                        const char* message = nullptr,
154
                                        const char* path = nullptr) {
155
  return UVException(v8::Isolate::GetCurrent(),
156
                     errorno,
157
                     syscall,
158
                     message,
159
                     path);
160
})
161
162
/*
163
 * These methods need to be called in a HandleScope.
164
 *
165
 * It is preferred that you use the `MakeCallback` overloads taking
166
 * `async_context` arguments.
167
 */
168
169
NODE_DEPRECATED("Use MakeCallback(..., async_context)",
170
                NODE_EXTERN v8::Local<v8::Value> MakeCallback(
171
                    v8::Isolate* isolate,
172
                    v8::Local<v8::Object> recv,
173
                    const char* method,
174
                    int argc,
175
                    v8::Local<v8::Value>* argv));
176
NODE_DEPRECATED("Use MakeCallback(..., async_context)",
177
                NODE_EXTERN v8::Local<v8::Value> MakeCallback(
178
                    v8::Isolate* isolate,
179
                    v8::Local<v8::Object> recv,
180
                    v8::Local<v8::String> symbol,
181
                    int argc,
182
                    v8::Local<v8::Value>* argv));
183
NODE_DEPRECATED("Use MakeCallback(..., async_context)",
184
                NODE_EXTERN v8::Local<v8::Value> MakeCallback(
185
                    v8::Isolate* isolate,
186
                    v8::Local<v8::Object> recv,
187
                    v8::Local<v8::Function> callback,
188
                    int argc,
189
                    v8::Local<v8::Value>* argv));
190
191
}  // namespace node
192
193
#include <cassert>
194
#include <cstdint>
195
196
#ifndef NODE_STRINGIFY
197
# define NODE_STRINGIFY(n) NODE_STRINGIFY_HELPER(n)
198
# define NODE_STRINGIFY_HELPER(n) #n
199
#endif
200
201
#ifdef _WIN32
202
#if !defined(_SSIZE_T_) && !defined(_SSIZE_T_DEFINED)
203
typedef intptr_t ssize_t;
204
# define _SSIZE_T_
205
# define _SSIZE_T_DEFINED
206
#endif
207
#else  // !_WIN32
208
# include <sys/types.h>  // size_t, ssize_t
209
#endif  // _WIN32
210
211
212
namespace node {
213
214
class IsolateData;
215
class Environment;
216
217
// TODO(addaleax): Officially deprecate this and replace it with something
218
// better suited for a public embedder API.
219
NODE_EXTERN int Start(int argc, char* argv[]);
220
221
// Tear down Node.js while it is running (there are active handles
222
// in the loop and / or actively executing JavaScript code).
223
NODE_EXTERN int Stop(Environment* env);
224
225
// Set up per-process state needed to run Node.js. This will consume arguments
226
// from argv, fill exec_argv, and possibly add errors resulting from parsing
227
// the arguments to `errors`. The return value is a suggested exit code for the
228
// program; If it is 0, then initializing Node.js succeeded.
229
NODE_EXTERN int InitializeNodeWithArgs(std::vector<std::string>* argv,
230
                                       std::vector<std::string>* exec_argv,
231
                                       std::vector<std::string>* errors);
232
233
enum OptionEnvvarSettings {
234
  kAllowedInEnvironment,
235
  kDisallowedInEnvironment
236
};
237
238
NODE_EXTERN int ProcessGlobalArgs(std::vector<std::string>* args,
239
                      std::vector<std::string>* exec_args,
240
                      std::vector<std::string>* errors,
241
                      OptionEnvvarSettings settings);
242
243
class NodeArrayBufferAllocator;
244
245
// An ArrayBuffer::Allocator class with some Node.js-specific tweaks. If you do
246
// not have to use another allocator, using this class is recommended:
247
// - It supports Buffer.allocUnsafe() and Buffer.allocUnsafeSlow() with
248
//   uninitialized memory.
249
// - It supports transferring, rather than copying, ArrayBuffers when using
250
//   MessagePorts.
251
9674
class NODE_EXTERN ArrayBufferAllocator : public v8::ArrayBuffer::Allocator {
252
 public:
253
  // If `always_debug` is true, create an ArrayBuffer::Allocator instance
254
  // that performs additional integrity checks (e.g. make sure that only memory
255
  // that was allocated by the it is also freed by it).
256
  // This can also be set using the --debug-arraybuffer-allocations flag.
257
  static std::unique_ptr<ArrayBufferAllocator> Create(
258
      bool always_debug = false);
259
260
 private:
261
  virtual NodeArrayBufferAllocator* GetImpl() = 0;
262
263
  friend class IsolateData;
264
};
265
266
// Legacy equivalents for ArrayBufferAllocator::Create().
267
NODE_EXTERN ArrayBufferAllocator* CreateArrayBufferAllocator();
268
NODE_EXTERN void FreeArrayBufferAllocator(ArrayBufferAllocator* allocator);
269
270
5081
class NODE_EXTERN IsolatePlatformDelegate {
271
 public:
272
  virtual std::shared_ptr<v8::TaskRunner> GetForegroundTaskRunner() = 0;
273
  virtual bool IdleTasksEnabled() = 0;
274
};
275
276
4629
class NODE_EXTERN MultiIsolatePlatform : public v8::Platform {
277
 public:
278
4622
  ~MultiIsolatePlatform() override = default;
279
  // Returns true if work was dispatched or executed. New tasks that are
280
  // posted during flushing of the queue are postponed until the next
281
  // flushing.
282
  virtual bool FlushForegroundTasks(v8::Isolate* isolate) = 0;
283
  virtual void DrainTasks(v8::Isolate* isolate) = 0;
284
285
  // This needs to be called between the calls to `Isolate::Allocate()` and
286
  // `Isolate::Initialize()`, so that initialization can already start
287
  // using the platform.
288
  // When using `NewIsolate()`, this is taken care of by that function.
289
  // This function may only be called once per `Isolate`.
290
  virtual void RegisterIsolate(v8::Isolate* isolate,
291
                               struct uv_loop_s* loop) = 0;
292
  // This method can be used when an application handles task scheduling on its
293
  // own through `IsolatePlatformDelegate`. Upon registering an isolate with
294
  // this overload any other method in this class with the exception of
295
  // `UnregisterIsolate` *must not* be used on that isolate.
296
  virtual void RegisterIsolate(v8::Isolate* isolate,
297
                               IsolatePlatformDelegate* delegate) = 0;
298
299
  // This function may only be called once per `Isolate`, and discard any
300
  // pending delayed tasks scheduled for that isolate.
301
  // This needs to be called right before calling `Isolate::Dispose()`.
302
  virtual void UnregisterIsolate(v8::Isolate* isolate) = 0;
303
304
  // The platform should call the passed function once all state associated
305
  // with the given isolate has been cleaned up. This can, but does not have to,
306
  // happen asynchronously.
307
  virtual void AddIsolateFinishedCallback(v8::Isolate* isolate,
308
                                          void (*callback)(void*),
309
                                          void* data) = 0;
310
311
  static std::unique_ptr<MultiIsolatePlatform> Create(
312
      int thread_pool_size,
313
      v8::TracingController* tracing_controller = nullptr);
314
};
315
316
enum IsolateSettingsFlags {
317
  MESSAGE_LISTENER_WITH_ERROR_LEVEL = 1 << 0,
318
  DETAILED_SOURCE_POSITIONS_FOR_PROFILING = 1 << 1,
319
  SHOULD_NOT_SET_PROMISE_REJECTION_CALLBACK = 1 << 2,
320
  SHOULD_NOT_SET_PREPARE_STACK_TRACE_CALLBACK = 1 << 3
321
};
322
323
struct IsolateSettings {
324
  uint64_t flags = MESSAGE_LISTENER_WITH_ERROR_LEVEL |
325
      DETAILED_SOURCE_POSITIONS_FOR_PROFILING;
326
  v8::MicrotasksPolicy policy = v8::MicrotasksPolicy::kExplicit;
327
328
  // Error handling callbacks
329
  v8::Isolate::AbortOnUncaughtExceptionCallback
330
      should_abort_on_uncaught_exception_callback = nullptr;
331
  v8::FatalErrorCallback fatal_error_callback = nullptr;
332
  v8::PrepareStackTraceCallback prepare_stack_trace_callback = nullptr;
333
334
  // Miscellaneous callbacks
335
  v8::PromiseRejectCallback promise_reject_callback = nullptr;
336
  v8::AllowWasmCodeGenerationCallback
337
      allow_wasm_code_generation_callback = nullptr;
338
};
339
340
// Overriding IsolateSettings may produce unexpected behavior
341
// in Node.js core functionality, so proceed at your own risk.
342
NODE_EXTERN void SetIsolateUpForNode(v8::Isolate* isolate,
343
                                     const IsolateSettings& settings);
344
345
// Set a number of callbacks for the `isolate`, in particular the Node.js
346
// uncaught exception listener.
347
NODE_EXTERN void SetIsolateUpForNode(v8::Isolate* isolate);
348
349
// Creates a new isolate with Node.js-specific settings.
350
// This is a convenience method equivalent to using SetIsolateCreateParams(),
351
// Isolate::Allocate(), MultiIsolatePlatform::RegisterIsolate(),
352
// Isolate::Initialize(), and SetIsolateUpForNode().
353
NODE_EXTERN v8::Isolate* NewIsolate(ArrayBufferAllocator* allocator,
354
                                    struct uv_loop_s* event_loop,
355
                                    MultiIsolatePlatform* platform = nullptr);
356
NODE_EXTERN v8::Isolate* NewIsolate(
357
    std::shared_ptr<ArrayBufferAllocator> allocator,
358
    struct uv_loop_s* event_loop,
359
    MultiIsolatePlatform* platform);
360
361
// Creates a new context with Node.js-specific tweaks.
362
NODE_EXTERN v8::Local<v8::Context> NewContext(
363
    v8::Isolate* isolate,
364
    v8::Local<v8::ObjectTemplate> object_template =
365
        v8::Local<v8::ObjectTemplate>());
366
367
// Runs Node.js-specific tweaks on an already constructed context
368
// Return value indicates success of operation
369
NODE_EXTERN bool InitializeContext(v8::Local<v8::Context> context);
370
371
// If `platform` is passed, it will be used to register new Worker instances.
372
// It can be `nullptr`, in which case creating new Workers inside of
373
// Environments that use this `IsolateData` will not work.
374
NODE_EXTERN IsolateData* CreateIsolateData(
375
    v8::Isolate* isolate,
376
    struct uv_loop_s* loop,
377
    MultiIsolatePlatform* platform = nullptr,
378
    ArrayBufferAllocator* allocator = nullptr);
379
NODE_EXTERN void FreeIsolateData(IsolateData* isolate_data);
380
381
1
struct ThreadId {
382
  uint64_t id = static_cast<uint64_t>(-1);
383
};
384
NODE_EXTERN ThreadId AllocateEnvironmentThreadId();
385
386
namespace EnvironmentFlags {
387
enum Flags : uint64_t {
388
  kNoFlags = 0,
389
  // Use the default behaviour for Node.js instances.
390
  kDefaultFlags = 1 << 0,
391
  // Controls whether this Environment is allowed to affect per-process state
392
  // (e.g. cwd, process title, uid, etc.).
393
  // This is set when using kDefaultFlags.
394
  kOwnsProcessState = 1 << 1,
395
  // Set if this Environment instance is associated with the global inspector
396
  // handling code (i.e. listening on SIGUSR1).
397
  // This is set when using kDefaultFlags.
398
  kOwnsInspector = 1 << 2,
399
  // Set if Node.js should not run its own esm loader. This is needed by some
400
  // embedders, because it's possible for the Node.js esm loader to conflict
401
  // with another one in an embedder environment, e.g. Blink's in Chromium.
402
  kNoRegisterESMLoader = 1 << 3,
403
  // Set this flag to make Node.js track "raw" file descriptors, i.e. managed
404
  // by fs.open() and fs.close(), and close them during FreeEnvironment().
405
  kTrackUnmanagedFds = 1 << 4
406
};
407
}  // namespace EnvironmentFlags
408
409
635
struct InspectorParentHandle {
410
  virtual ~InspectorParentHandle();
411
};
412
413
// TODO(addaleax): Maybe move per-Environment options parsing here.
414
// Returns nullptr when the Environment cannot be created e.g. there are
415
// pending JavaScript exceptions.
416
NODE_EXTERN Environment* CreateEnvironment(
417
    IsolateData* isolate_data,
418
    v8::Local<v8::Context> context,
419
    const std::vector<std::string>& args,
420
    const std::vector<std::string>& exec_args,
421
    EnvironmentFlags::Flags flags = EnvironmentFlags::kDefaultFlags,
422
    ThreadId thread_id = {} /* allocates a thread id automatically */,
423
    std::unique_ptr<InspectorParentHandle> inspector_parent_handle = {});
424
425
// Returns a handle that can be passed to `LoadEnvironment()`, making the
426
// child Environment accessible to the inspector as if it were a Node.js Worker.
427
// `child_thread_id` can be created using `AllocateEnvironmentThreadId()`
428
// and then later passed on to `CreateEnvironment()` to create the child
429
// Environment, together with the inspector handle.
430
// This method should not be called while the parent Environment is active
431
// on another thread.
432
NODE_EXTERN std::unique_ptr<InspectorParentHandle> GetInspectorParentHandle(
433
    Environment* parent_env,
434
    ThreadId child_thread_id,
435
    const char* child_url);
436
437
struct StartExecutionCallbackInfo {
438
  v8::Local<v8::Object> process_object;
439
  v8::Local<v8::Function> native_require;
440
};
441
442
using StartExecutionCallback =
443
    std::function<v8::MaybeLocal<v8::Value>(const StartExecutionCallbackInfo&)>;
444
445
NODE_EXTERN v8::MaybeLocal<v8::Value> LoadEnvironment(
446
    Environment* env,
447
    StartExecutionCallback cb);
448
NODE_EXTERN v8::MaybeLocal<v8::Value> LoadEnvironment(
449
    Environment* env,
450
    const char* main_script_source_utf8);
451
NODE_EXTERN void FreeEnvironment(Environment* env);
452
453
// Set a callback that is called when process.exit() is called from JS,
454
// overriding the default handler.
455
// It receives the Environment* instance and the exit code as arguments.
456
// This could e.g. call Stop(env); in order to terminate execution and stop
457
// the event loop.
458
// The default handler disposes of the global V8 platform instance, if one is
459
// being used, and calls exit().
460
NODE_EXTERN void SetProcessExitHandler(
461
    Environment* env,
462
    std::function<void(Environment*, int)>&& handler);
463
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);
464
465
// This may return nullptr if context is not associated with a Node instance.
466
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
467
468
NODE_EXTERN void OnFatalError(const char* location, const char* message);
469
NODE_EXTERN void PromiseRejectCallback(v8::PromiseRejectMessage message);
470
NODE_EXTERN bool AllowWasmCodeGenerationCallback(v8::Local<v8::Context> context,
471
                                            v8::Local<v8::String>);
472
NODE_EXTERN bool ShouldAbortOnUncaughtException(v8::Isolate* isolate);
473
NODE_EXTERN v8::MaybeLocal<v8::Value> PrepareStackTraceCallback(
474
    v8::Local<v8::Context> context,
475
    v8::Local<v8::Value> exception,
476
    v8::Local<v8::Array> trace);
477
478
// This returns the MultiIsolatePlatform used for an Environment or IsolateData
479
// instance, if one exists.
480
NODE_EXTERN MultiIsolatePlatform* GetMultiIsolatePlatform(Environment* env);
481
NODE_EXTERN MultiIsolatePlatform* GetMultiIsolatePlatform(IsolateData* env);
482
483
NODE_DEPRECATED("Use MultiIsolatePlatform::Create() instead",
484
    NODE_EXTERN MultiIsolatePlatform* CreatePlatform(
485
        int thread_pool_size,
486
        v8::TracingController* tracing_controller));
487
NODE_DEPRECATED("Use MultiIsolatePlatform::Create() instead",
488
    NODE_EXTERN void FreePlatform(MultiIsolatePlatform* platform));
489
490
// Get/set the currently active tracing controller. Using CreatePlatform()
491
// will implicitly set this by default. This is global and should be initialized
492
// along with the v8::Platform instance that is being used. `controller`
493
// is allowed to be `nullptr`.
494
// This is used for tracing events from Node.js itself. V8 uses the tracing
495
// controller returned from the active `v8::Platform` instance.
496
NODE_EXTERN v8::TracingController* GetTracingController();
497
NODE_EXTERN void SetTracingController(v8::TracingController* controller);
498
499
// Run `process.emit('beforeExit')` as it would usually happen when Node.js is
500
// run in standalone mode.
501
NODE_EXTERN v8::Maybe<bool> EmitProcessBeforeExit(Environment* env);
502
NODE_DEPRECATED("Use Maybe version (EmitProcessBeforeExit) instead",
503
    NODE_EXTERN void EmitBeforeExit(Environment* env));
504
// Run `process.emit('exit')` as it would usually happen when Node.js is run
505
// in standalone mode. The return value corresponds to the exit code.
506
NODE_EXTERN v8::Maybe<int> EmitProcessExit(Environment* env);
507
NODE_DEPRECATED("Use Maybe version (EmitProcessExit) instead",
508
    NODE_EXTERN int EmitExit(Environment* env));
509
510
// Runs hooks added through `AtExit()`. This is part of `FreeEnvironment()`,
511
// so calling it manually is typically not necessary.
512
NODE_EXTERN void RunAtExit(Environment* env);
513
514
// This may return nullptr if the current v8::Context is not associated
515
// with a Node instance.
516
NODE_EXTERN struct uv_loop_s* GetCurrentEventLoop(v8::Isolate* isolate);
517
518
// Runs the main loop for a given Environment. This roughly performs the
519
// following steps:
520
// 1. Call uv_run() on the event loop until it is drained.
521
// 2. Call platform->DrainTasks() on the associated platform/isolate.
522
//   3. If the event loop is alive again, go to Step 1.
523
// 4. Call EmitProcessBeforeExit().
524
//   5. If the event loop is alive again, go to Step 1.
525
// 6. Call EmitProcessExit() and forward the return value.
526
// If at any point node::Stop() is called, the function will attempt to return
527
// as soon as possible, returning an empty `Maybe`.
528
// This function only works if `env` has an associated `MultiIsolatePlatform`.
529
NODE_EXTERN v8::Maybe<int> SpinEventLoop(Environment* env);
530
531
class NODE_EXTERN CommonEnvironmentSetup {
532
 public:
533
  ~CommonEnvironmentSetup();
534
535
  // Create a new CommonEnvironmentSetup, that is, a group of objects that
536
  // together form the typical setup for a single Node.js Environment instance.
537
  // If any error occurs, `*errors` will be populated and the returned pointer
538
  // will be empty.
539
  // env_args will be passed through as arguments to CreateEnvironment(), after
540
  // `isolate_data` and `context`.
541
  template <typename... EnvironmentArgs>
542
  static std::unique_ptr<CommonEnvironmentSetup> Create(
543
      MultiIsolatePlatform* platform,
544
      std::vector<std::string>* errors,
545
      EnvironmentArgs&&... env_args);
546
547
  struct uv_loop_s* event_loop() const;
548
  std::shared_ptr<ArrayBufferAllocator> array_buffer_allocator() const;
549
  v8::Isolate* isolate() const;
550
  IsolateData* isolate_data() const;
551
  Environment* env() const;
552
  v8::Local<v8::Context> context() const;
553
554
  CommonEnvironmentSetup(const CommonEnvironmentSetup&) = delete;
555
  CommonEnvironmentSetup& operator=(const CommonEnvironmentSetup&) = delete;
556
  CommonEnvironmentSetup(CommonEnvironmentSetup&&) = delete;
557
  CommonEnvironmentSetup& operator=(CommonEnvironmentSetup&&) = delete;
558
559
 private:
560
  struct Impl;
561
  Impl* impl_;
562
  CommonEnvironmentSetup(
563
      MultiIsolatePlatform*,
564
      std::vector<std::string>*,
565
      std::function<Environment*(const CommonEnvironmentSetup*)>);
566
};
567
568
// Implementation for CommonEnvironmentSetup::Create
569
template <typename... EnvironmentArgs>
570
7
std::unique_ptr<CommonEnvironmentSetup> CommonEnvironmentSetup::Create(
571
    MultiIsolatePlatform* platform,
572
    std::vector<std::string>* errors,
573
    EnvironmentArgs&&... env_args) {
574
7
  auto ret = std::unique_ptr<CommonEnvironmentSetup>(new CommonEnvironmentSetup(
575
      platform, errors,
576
7
      [&](const CommonEnvironmentSetup* setup) -> Environment* {
577
28
        return CreateEnvironment(
578
            setup->isolate_data(), setup->context(),
579
28
            std::forward<EnvironmentArgs>(env_args)...);
580
14
      }));
581
7
  if (!errors->empty()) ret.reset();
582
7
  return ret;
583
}
584
585
/* Converts a unixtime to V8 Date */
586
NODE_DEPRECATED("Use v8::Date::New() directly",
587
                inline v8::Local<v8::Value> NODE_UNIXTIME_V8(double time) {
588
                  return v8::Date::New(
589
                             v8::Isolate::GetCurrent()->GetCurrentContext(),
590
                             1000 * time)
591
                      .ToLocalChecked();
592
                })
593
#define NODE_UNIXTIME_V8 node::NODE_UNIXTIME_V8
594
NODE_DEPRECATED("Use v8::Date::ValueOf() directly",
595
                inline double NODE_V8_UNIXTIME(v8::Local<v8::Date> date) {
596
  return date->ValueOf() / 1000;
597
})
598
#define NODE_V8_UNIXTIME node::NODE_V8_UNIXTIME
599
600
#define NODE_DEFINE_CONSTANT(target, constant)                                \
601
  do {                                                                        \
602
    v8::Isolate* isolate = target->GetIsolate();                              \
603
    v8::Local<v8::Context> context = isolate->GetCurrentContext();            \
604
    v8::Local<v8::String> constant_name =                                     \
605
        v8::String::NewFromUtf8(isolate, #constant,                           \
606
            v8::NewStringType::kInternalized).ToLocalChecked();               \
607
    v8::Local<v8::Number> constant_value =                                    \
608
        v8::Number::New(isolate, static_cast<double>(constant));              \
609
    v8::PropertyAttribute constant_attributes =                               \
610
        static_cast<v8::PropertyAttribute>(v8::ReadOnly | v8::DontDelete);    \
611
    (target)->DefineOwnProperty(context,                                      \
612
                                constant_name,                                \
613
                                constant_value,                               \
614
                                constant_attributes).Check();                 \
615
  }                                                                           \
616
  while (0)
617
618
#define NODE_DEFINE_HIDDEN_CONSTANT(target, constant)                         \
619
  do {                                                                        \
620
    v8::Isolate* isolate = target->GetIsolate();                              \
621
    v8::Local<v8::Context> context = isolate->GetCurrentContext();            \
622
    v8::Local<v8::String> constant_name =                                     \
623
        v8::String::NewFromUtf8(isolate, #constant,                           \
624
                                v8::NewStringType::kInternalized)             \
625
                                  .ToLocalChecked();                          \
626
    v8::Local<v8::Number> constant_value =                                    \
627
        v8::Number::New(isolate, static_cast<double>(constant));              \
628
    v8::PropertyAttribute constant_attributes =                               \
629
        static_cast<v8::PropertyAttribute>(v8::ReadOnly |                     \
630
                                           v8::DontDelete |                   \
631
                                           v8::DontEnum);                     \
632
    (target)->DefineOwnProperty(context,                                      \
633
                                constant_name,                                \
634
                                constant_value,                               \
635
                                constant_attributes).Check();                 \
636
  }                                                                           \
637
  while (0)
638
639
// Used to be a macro, hence the uppercase name.
640
inline void NODE_SET_METHOD(v8::Local<v8::Template> recv,
641
                            const char* name,
642
                            v8::FunctionCallback callback) {
643
  v8::Isolate* isolate = v8::Isolate::GetCurrent();
644
  v8::HandleScope handle_scope(isolate);
645
  v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New(isolate,
646
                                                                callback);
647
  v8::Local<v8::String> fn_name = v8::String::NewFromUtf8(isolate, name,
648
      v8::NewStringType::kInternalized).ToLocalChecked();
649
  t->SetClassName(fn_name);
650
  recv->Set(fn_name, t);
651
}
652
653
// Used to be a macro, hence the uppercase name.
654
inline void NODE_SET_METHOD(v8::Local<v8::Object> recv,
655
                            const char* name,
656
                            v8::FunctionCallback callback) {
657
  v8::Isolate* isolate = v8::Isolate::GetCurrent();
658
  v8::HandleScope handle_scope(isolate);
659
  v8::Local<v8::Context> context = isolate->GetCurrentContext();
660
  v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New(isolate,
661
                                                                callback);
662
  v8::Local<v8::Function> fn = t->GetFunction(context).ToLocalChecked();
663
  v8::Local<v8::String> fn_name = v8::String::NewFromUtf8(isolate, name,
664
      v8::NewStringType::kInternalized).ToLocalChecked();
665
  fn->SetName(fn_name);
666
  recv->Set(context, fn_name, fn).Check();
667
}
668
#define NODE_SET_METHOD node::NODE_SET_METHOD
669
670
// Used to be a macro, hence the uppercase name.
671
// Not a template because it only makes sense for FunctionTemplates.
672
inline void NODE_SET_PROTOTYPE_METHOD(v8::Local<v8::FunctionTemplate> recv,
673
                                      const char* name,
674
                                      v8::FunctionCallback callback) {
675
  v8::Isolate* isolate = v8::Isolate::GetCurrent();
676
  v8::HandleScope handle_scope(isolate);
677
  v8::Local<v8::Signature> s = v8::Signature::New(isolate, recv);
678
  v8::Local<v8::FunctionTemplate> t =
679
      v8::FunctionTemplate::New(isolate, callback, v8::Local<v8::Value>(), s);
680
  v8::Local<v8::String> fn_name = v8::String::NewFromUtf8(isolate, name,
681
      v8::NewStringType::kInternalized).ToLocalChecked();
682
  t->SetClassName(fn_name);
683
  recv->PrototypeTemplate()->Set(fn_name, t);
684
}
685
#define NODE_SET_PROTOTYPE_METHOD node::NODE_SET_PROTOTYPE_METHOD
686
687
// BINARY is a deprecated alias of LATIN1.
688
// BASE64URL is not currently exposed to the JavaScript side.
689
enum encoding {
690
  ASCII,
691
  UTF8,
692
  BASE64,
693
  UCS2,
694
  BINARY,
695
  HEX,
696
  BUFFER,
697
  BASE64URL,
698
  LATIN1 = BINARY
699
};
700
701
NODE_EXTERN enum encoding ParseEncoding(
702
    v8::Isolate* isolate,
703
    v8::Local<v8::Value> encoding_v,
704
    enum encoding default_encoding = LATIN1);
705
706
NODE_EXTERN void FatalException(v8::Isolate* isolate,
707
                                const v8::TryCatch& try_catch);
708
709
NODE_EXTERN v8::Local<v8::Value> Encode(v8::Isolate* isolate,
710
                                        const char* buf,
711
                                        size_t len,
712
                                        enum encoding encoding = LATIN1);
713
714
// Warning: This reverses endianness on Big Endian platforms, even though the
715
// signature using uint16_t implies that it should not.
716
NODE_EXTERN v8::Local<v8::Value> Encode(v8::Isolate* isolate,
717
                                        const uint16_t* buf,
718
                                        size_t len);
719
720
// Returns -1 if the handle was not valid for decoding
721
NODE_EXTERN ssize_t DecodeBytes(v8::Isolate* isolate,
722
                                v8::Local<v8::Value>,
723
                                enum encoding encoding = LATIN1);
724
// returns bytes written.
725
NODE_EXTERN ssize_t DecodeWrite(v8::Isolate* isolate,
726
                                char* buf,
727
                                size_t buflen,
728
                                v8::Local<v8::Value>,
729
                                enum encoding encoding = LATIN1);
730
#ifdef _WIN32
731
NODE_EXTERN v8::Local<v8::Value> WinapiErrnoException(
732
    v8::Isolate* isolate,
733
    int errorno,
734
    const char* syscall = nullptr,
735
    const char* msg = "",
736
    const char* path = nullptr);
737
#endif
738
739
const char* signo_string(int errorno);
740
741
742
typedef void (*addon_register_func)(
743
    v8::Local<v8::Object> exports,
744
    v8::Local<v8::Value> module,
745
    void* priv);
746
747
typedef void (*addon_context_register_func)(
748
    v8::Local<v8::Object> exports,
749
    v8::Local<v8::Value> module,
750
    v8::Local<v8::Context> context,
751
    void* priv);
752
753
enum ModuleFlags {
754
  kLinked = 0x02
755
};
756
757
struct node_module {
758
  int nm_version;
759
  unsigned int nm_flags;
760
  void* nm_dso_handle;
761
  const char* nm_filename;
762
  node::addon_register_func nm_register_func;
763
  node::addon_context_register_func nm_context_register_func;
764
  const char* nm_modname;
765
  void* nm_priv;
766
  struct node_module* nm_link;
767
};
768
769
extern "C" NODE_EXTERN void node_module_register(void* mod);
770
771
#ifdef _WIN32
772
# define NODE_MODULE_EXPORT __declspec(dllexport)
773
#else
774
# define NODE_MODULE_EXPORT __attribute__((visibility("default")))
775
#endif
776
777
#ifdef NODE_SHARED_MODE
778
# define NODE_CTOR_PREFIX
779
#else
780
# define NODE_CTOR_PREFIX static
781
#endif
782
783
#if defined(_MSC_VER)
784
#pragma section(".CRT$XCU", read)
785
#define NODE_C_CTOR(fn)                                               \
786
  NODE_CTOR_PREFIX void __cdecl fn(void);                             \
787
  __declspec(dllexport, allocate(".CRT$XCU"))                         \
788
      void (__cdecl*fn ## _)(void) = fn;                              \
789
  NODE_CTOR_PREFIX void __cdecl fn(void)
790
#else
791
#define NODE_C_CTOR(fn)                                               \
792
  NODE_CTOR_PREFIX void fn(void) __attribute__((constructor));        \
793
  NODE_CTOR_PREFIX void fn(void)
794
#endif
795
796
#define NODE_MODULE_X(modname, regfunc, priv, flags)                  \
797
  extern "C" {                                                        \
798
    static node::node_module _module =                                \
799
    {                                                                 \
800
      NODE_MODULE_VERSION,                                            \
801
      flags,                                                          \
802
      NULL,  /* NOLINT (readability/null_usage) */                    \
803
      __FILE__,                                                       \
804
      (node::addon_register_func) (regfunc),                          \
805
      NULL,  /* NOLINT (readability/null_usage) */                    \
806
      NODE_STRINGIFY(modname),                                        \
807
      priv,                                                           \
808
      NULL   /* NOLINT (readability/null_usage) */                    \
809
    };                                                                \
810
    NODE_C_CTOR(_register_ ## modname) {                              \
811
      node_module_register(&_module);                                 \
812
    }                                                                 \
813
  }
814
815
#define NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, priv, flags)    \
816
  extern "C" {                                                        \
817
    static node::node_module _module =                                \
818
    {                                                                 \
819
      NODE_MODULE_VERSION,                                            \
820
      flags,                                                          \
821
      NULL,  /* NOLINT (readability/null_usage) */                    \
822
      __FILE__,                                                       \
823
      NULL,  /* NOLINT (readability/null_usage) */                    \
824
      (node::addon_context_register_func) (regfunc),                  \
825
      NODE_STRINGIFY(modname),                                        \
826
      priv,                                                           \
827
      NULL  /* NOLINT (readability/null_usage) */                     \
828
    };                                                                \
829
    NODE_C_CTOR(_register_ ## modname) {                              \
830
      node_module_register(&_module);                                 \
831
    }                                                                 \
832
  }
833
834
// Usage: `NODE_MODULE(NODE_GYP_MODULE_NAME, InitializerFunction)`
835
// If no NODE_MODULE is declared, Node.js looks for the well-known
836
// symbol `node_register_module_v${NODE_MODULE_VERSION}`.
837
#define NODE_MODULE(modname, regfunc)                                 \
838
  NODE_MODULE_X(modname, regfunc, NULL, 0)  // NOLINT (readability/null_usage)
839
840
#define NODE_MODULE_CONTEXT_AWARE(modname, regfunc)                   \
841
  /* NOLINTNEXTLINE (readability/null_usage) */                       \
842
  NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL, 0)
843
844
// Embedders can use this type of binding for statically linked native bindings.
845
// It is used the same way addon bindings are used, except that linked bindings
846
// can be accessed through `process._linkedBinding(modname)`.
847
#define NODE_MODULE_LINKED(modname, regfunc)                               \
848
  /* NOLINTNEXTLINE (readability/null_usage) */                            \
849
  NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL,                      \
850
                              node::ModuleFlags::kLinked)
851
852
/*
853
 * For backward compatibility in add-on modules.
854
 */
855
#define NODE_MODULE_DECL /* nothing */
856
857
#define NODE_MODULE_INITIALIZER_BASE node_register_module_v
858
859
#define NODE_MODULE_INITIALIZER_X(base, version)                      \
860
    NODE_MODULE_INITIALIZER_X_HELPER(base, version)
861
862
#define NODE_MODULE_INITIALIZER_X_HELPER(base, version) base##version
863
864
#define NODE_MODULE_INITIALIZER                                       \
865
  NODE_MODULE_INITIALIZER_X(NODE_MODULE_INITIALIZER_BASE,             \
866
      NODE_MODULE_VERSION)
867
868
#define NODE_MODULE_INIT()                                            \
869
  extern "C" NODE_MODULE_EXPORT void                                  \
870
  NODE_MODULE_INITIALIZER(v8::Local<v8::Object> exports,              \
871
                          v8::Local<v8::Value> module,                \
872
                          v8::Local<v8::Context> context);            \
873
  NODE_MODULE_CONTEXT_AWARE(NODE_GYP_MODULE_NAME,                     \
874
                            NODE_MODULE_INITIALIZER)                  \
875
  void NODE_MODULE_INITIALIZER(v8::Local<v8::Object> exports,         \
876
                               v8::Local<v8::Value> module,           \
877
                               v8::Local<v8::Context> context)
878
879
// Allows embedders to add a binding to the current Environment* that can be
880
// accessed through process._linkedBinding() in the target Environment and all
881
// Worker threads that it creates.
882
// In each variant, the registration function needs to be usable at least for
883
// the time during which the Environment exists.
884
NODE_EXTERN void AddLinkedBinding(Environment* env, const node_module& mod);
885
NODE_EXTERN void AddLinkedBinding(Environment* env,
886
                                  const struct napi_module& mod);
887
NODE_EXTERN void AddLinkedBinding(Environment* env,
888
                                  const char* name,
889
                                  addon_context_register_func fn,
890
                                  void* priv);
891
892
/* Registers a callback with the passed-in Environment instance. The callback
893
 * is called after the event loop exits, but before the VM is disposed.
894
 * Callbacks are run in reverse order of registration, i.e. newest first.
895
 */
896
NODE_EXTERN void AtExit(Environment* env,
897
                        void (*cb)(void* arg),
898
                        void* arg);
899
900
typedef double async_id;
901
struct async_context {
902
  ::node::async_id async_id;
903
  ::node::async_id trigger_async_id;
904
};
905
906
/* This is a lot like node::AtExit, except that the hooks added via this
907
 * function are run before the AtExit ones and will always be registered
908
 * for the current Environment instance.
909
 * These functions are safe to use in an addon supporting multiple
910
 * threads/isolates. */
911
NODE_EXTERN void AddEnvironmentCleanupHook(v8::Isolate* isolate,
912
                                           void (*fun)(void* arg),
913
                                           void* arg);
914
915
NODE_EXTERN void RemoveEnvironmentCleanupHook(v8::Isolate* isolate,
916
                                              void (*fun)(void* arg),
917
                                              void* arg);
918
919
/* These are async equivalents of the above. After the cleanup hook is invoked,
920
 * `cb(cbarg)` *must* be called, and attempting to remove the cleanup hook will
921
 * have no effect. */
922
struct ACHHandle;
923
struct NODE_EXTERN DeleteACHHandle { void operator()(ACHHandle*) const; };
924
typedef std::unique_ptr<ACHHandle, DeleteACHHandle> AsyncCleanupHookHandle;
925
926
NODE_EXTERN AsyncCleanupHookHandle AddEnvironmentCleanupHook(
927
    v8::Isolate* isolate,
928
    void (*fun)(void* arg, void (*cb)(void*), void* cbarg),
929
    void* arg);
930
931
NODE_EXTERN void RemoveEnvironmentCleanupHook(AsyncCleanupHookHandle holder);
932
933
/* Returns the id of the current execution context. If the return value is
934
 * zero then no execution has been set. This will happen if the user handles
935
 * I/O from native code. */
936
NODE_EXTERN async_id AsyncHooksGetExecutionAsyncId(v8::Isolate* isolate);
937
938
/* Return same value as async_hooks.triggerAsyncId(); */
939
NODE_EXTERN async_id AsyncHooksGetTriggerAsyncId(v8::Isolate* isolate);
940
941
/* If the native API doesn't inherit from the helper class then the callbacks
942
 * must be triggered manually. This triggers the init() callback. The return
943
 * value is the async id assigned to the resource.
944
 *
945
 * The `trigger_async_id` parameter should correspond to the resource which is
946
 * creating the new resource, which will usually be the return value of
947
 * `AsyncHooksGetTriggerAsyncId()`. */
948
NODE_EXTERN async_context EmitAsyncInit(v8::Isolate* isolate,
949
                                        v8::Local<v8::Object> resource,
950
                                        const char* name,
951
                                        async_id trigger_async_id = -1);
952
953
NODE_EXTERN async_context EmitAsyncInit(v8::Isolate* isolate,
954
                                        v8::Local<v8::Object> resource,
955
                                        v8::Local<v8::String> name,
956
                                        async_id trigger_async_id = -1);
957
958
/* Emit the destroy() callback. The overload taking an `Environment*` argument
959
 * should be used when the Isolate’s current Context is not associated with
960
 * a Node.js Environment, or when there is no current Context, for example
961
 * when calling this function during garbage collection. In that case, the
962
 * `Environment*` value should have been acquired previously, e.g. through
963
 * `GetCurrentEnvironment()`. */
964
NODE_EXTERN void EmitAsyncDestroy(v8::Isolate* isolate,
965
                                  async_context asyncContext);
966
NODE_EXTERN void EmitAsyncDestroy(Environment* env,
967
                                  async_context asyncContext);
968
969
class InternalCallbackScope;
970
971
/* This class works like `MakeCallback()` in that it sets up a specific
972
 * asyncContext as the current one and informs the async_hooks and domains
973
 * modules that this context is currently active.
974
 *
975
 * `MakeCallback()` is a wrapper around this class as well as
976
 * `Function::Call()`. Either one of these mechanisms needs to be used for
977
 * top-level calls into JavaScript (i.e. without any existing JS stack).
978
 *
979
 * This object should be stack-allocated to ensure that it is contained in a
980
 * valid HandleScope.
981
 *
982
 * Exceptions happening within this scope will be treated like uncaught
983
 * exceptions. If this behaviour is undesirable, a new `v8::TryCatch` scope
984
 * needs to be created inside of this scope.
985
 */
986
class NODE_EXTERN CallbackScope {
987
 public:
988
  CallbackScope(v8::Isolate* isolate,
989
                v8::Local<v8::Object> resource,
990
                async_context asyncContext);
991
  ~CallbackScope();
992
993
  void operator=(const CallbackScope&) = delete;
994
  void operator=(CallbackScope&&) = delete;
995
  CallbackScope(const CallbackScope&) = delete;
996
  CallbackScope(CallbackScope&&) = delete;
997
998
 private:
999
  InternalCallbackScope* private_;
1000
  v8::TryCatch try_catch_;
1001
};
1002
1003
/* An API specific to emit before/after callbacks is unnecessary because
1004
 * MakeCallback will automatically call them for you.
1005
 *
1006
 * These methods may create handles on their own, so run them inside a
1007
 * HandleScope.
1008
 *
1009
 * `asyncId` and `triggerAsyncId` should correspond to the values returned by
1010
 * `EmitAsyncInit()` and `AsyncHooksGetTriggerAsyncId()`, respectively, when the
1011
 * invoking resource was created. If these values are unknown, 0 can be passed.
1012
 * */
1013
NODE_EXTERN
1014
v8::MaybeLocal<v8::Value> MakeCallback(v8::Isolate* isolate,
1015
                                       v8::Local<v8::Object> recv,
1016
                                       v8::Local<v8::Function> callback,
1017
                                       int argc,
1018
                                       v8::Local<v8::Value>* argv,
1019
                                       async_context asyncContext);
1020
NODE_EXTERN
1021
v8::MaybeLocal<v8::Value> MakeCallback(v8::Isolate* isolate,
1022
                                       v8::Local<v8::Object> recv,
1023
                                       const char* method,
1024
                                       int argc,
1025
                                       v8::Local<v8::Value>* argv,
1026
                                       async_context asyncContext);
1027
NODE_EXTERN
1028
v8::MaybeLocal<v8::Value> MakeCallback(v8::Isolate* isolate,
1029
                                       v8::Local<v8::Object> recv,
1030
                                       v8::Local<v8::String> symbol,
1031
                                       int argc,
1032
                                       v8::Local<v8::Value>* argv,
1033
                                       async_context asyncContext);
1034
1035
/* Helper class users can optionally inherit from. If
1036
 * `AsyncResource::MakeCallback()` is used, then all four callbacks will be
1037
 * called automatically. */
1038
class NODE_EXTERN AsyncResource {
1039
 public:
1040
  AsyncResource(v8::Isolate* isolate,
1041
                v8::Local<v8::Object> resource,
1042
                const char* name,
1043
                async_id trigger_async_id = -1);
1044
1045
  virtual ~AsyncResource();
1046
1047
  AsyncResource(const AsyncResource&) = delete;
1048
  void operator=(const AsyncResource&) = delete;
1049
1050
  v8::MaybeLocal<v8::Value> MakeCallback(
1051
      v8::Local<v8::Function> callback,
1052
      int argc,
1053
      v8::Local<v8::Value>* argv);
1054
1055
  v8::MaybeLocal<v8::Value> MakeCallback(
1056
      const char* method,
1057
      int argc,
1058
      v8::Local<v8::Value>* argv);
1059
1060
  v8::MaybeLocal<v8::Value> MakeCallback(
1061
      v8::Local<v8::String> symbol,
1062
      int argc,
1063
      v8::Local<v8::Value>* argv);
1064
1065
  v8::Local<v8::Object> get_resource();
1066
  async_id get_async_id() const;
1067
  async_id get_trigger_async_id() const;
1068
1069
 protected:
1070
638
  class NODE_EXTERN CallbackScope : public node::CallbackScope {
1071
   public:
1072
    explicit CallbackScope(AsyncResource* res);
1073
  };
1074
1075
 private:
1076
  Environment* env_;
1077
  v8::Global<v8::Object> resource_;
1078
  async_context async_context_;
1079
};
1080
1081
#ifndef _WIN32
1082
// Register a signal handler without interrupting any handlers that node
1083
// itself needs. This does override handlers registered through
1084
// process.on('SIG...', function() { ... }). The `reset_handler` flag indicates
1085
// whether the signal handler for the given signal should be reset to its
1086
// default value before executing the handler (i.e. it works like SA_RESETHAND).
1087
// The `reset_handler` flag is invalid when `signal` is SIGSEGV.
1088
NODE_EXTERN
1089
void RegisterSignalHandler(int signal,
1090
                           void (*handler)(int signal,
1091
                                           siginfo_t* info,
1092
                                           void* ucontext),
1093
                           bool reset_handler = false);
1094
#endif  // _WIN32
1095
1096
}  // namespace node
1097
1098
#endif  // SRC_NODE_H_