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-11-20 19:51:53 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
9548
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
5062
class NODE_EXTERN IsolatePlatformDelegate {
271
 public:
272
  virtual std::shared_ptr<v8::TaskRunner> GetForegroundTaskRunner() = 0;
273
  virtual bool IdleTasksEnabled() = 0;
274
};
275
276
4616
class NODE_EXTERN MultiIsolatePlatform : public v8::Platform {
277
 public:
278
4609
  ~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
};
321
322
struct IsolateSettings {
323
  uint64_t flags = MESSAGE_LISTENER_WITH_ERROR_LEVEL |
324
      DETAILED_SOURCE_POSITIONS_FOR_PROFILING;
325
  v8::MicrotasksPolicy policy = v8::MicrotasksPolicy::kExplicit;
326
327
  // Error handling callbacks
328
  v8::Isolate::AbortOnUncaughtExceptionCallback
329
      should_abort_on_uncaught_exception_callback = nullptr;
330
  v8::FatalErrorCallback fatal_error_callback = nullptr;
331
  v8::PrepareStackTraceCallback prepare_stack_trace_callback = nullptr;
332
333
  // Miscellaneous callbacks
334
  v8::PromiseRejectCallback promise_reject_callback = nullptr;
335
  v8::AllowWasmCodeGenerationCallback
336
      allow_wasm_code_generation_callback = nullptr;
337
};
338
339
// Overriding IsolateSettings may produce unexpected behavior
340
// in Node.js core functionality, so proceed at your own risk.
341
NODE_EXTERN void SetIsolateUpForNode(v8::Isolate* isolate,
342
                                     const IsolateSettings& settings);
343
344
// Set a number of callbacks for the `isolate`, in particular the Node.js
345
// uncaught exception listener.
346
NODE_EXTERN void SetIsolateUpForNode(v8::Isolate* isolate);
347
348
// Creates a new isolate with Node.js-specific settings.
349
// This is a convenience method equivalent to using SetIsolateCreateParams(),
350
// Isolate::Allocate(), MultiIsolatePlatform::RegisterIsolate(),
351
// Isolate::Initialize(), and SetIsolateUpForNode().
352
NODE_EXTERN v8::Isolate* NewIsolate(ArrayBufferAllocator* allocator,
353
                                    struct uv_loop_s* event_loop,
354
                                    MultiIsolatePlatform* platform = nullptr);
355
NODE_EXTERN v8::Isolate* NewIsolate(
356
    std::shared_ptr<ArrayBufferAllocator> allocator,
357
    struct uv_loop_s* event_loop,
358
    MultiIsolatePlatform* platform);
359
360
// Creates a new context with Node.js-specific tweaks.
361
NODE_EXTERN v8::Local<v8::Context> NewContext(
362
    v8::Isolate* isolate,
363
    v8::Local<v8::ObjectTemplate> object_template =
364
        v8::Local<v8::ObjectTemplate>());
365
366
// Runs Node.js-specific tweaks on an already constructed context
367
// Return value indicates success of operation
368
NODE_EXTERN bool InitializeContext(v8::Local<v8::Context> context);
369
370
// If `platform` is passed, it will be used to register new Worker instances.
371
// It can be `nullptr`, in which case creating new Workers inside of
372
// Environments that use this `IsolateData` will not work.
373
NODE_EXTERN IsolateData* CreateIsolateData(
374
    v8::Isolate* isolate,
375
    struct uv_loop_s* loop,
376
    MultiIsolatePlatform* platform = nullptr,
377
    ArrayBufferAllocator* allocator = nullptr);
378
NODE_EXTERN void FreeIsolateData(IsolateData* isolate_data);
379
380
1
struct ThreadId {
381
  uint64_t id = static_cast<uint64_t>(-1);
382
};
383
NODE_EXTERN ThreadId AllocateEnvironmentThreadId();
384
385
namespace EnvironmentFlags {
386
enum Flags : uint64_t {
387
  kNoFlags = 0,
388
  // Use the default behaviour for Node.js instances.
389
  kDefaultFlags = 1 << 0,
390
  // Controls whether this Environment is allowed to affect per-process state
391
  // (e.g. cwd, process title, uid, etc.).
392
  // This is set when using kDefaultFlags.
393
  kOwnsProcessState = 1 << 1,
394
  // Set if this Environment instance is associated with the global inspector
395
  // handling code (i.e. listening on SIGUSR1).
396
  // This is set when using kDefaultFlags.
397
  kOwnsInspector = 1 << 2,
398
  // Set if Node.js should not run its own esm loader. This is needed by some
399
  // embedders, because it's possible for the Node.js esm loader to conflict
400
  // with another one in an embedder environment, e.g. Blink's in Chromium.
401
  kNoRegisterESMLoader = 1 << 3,
402
  // Set this flag to make Node.js track "raw" file descriptors, i.e. managed
403
  // by fs.open() and fs.close(), and close them during FreeEnvironment().
404
  kTrackUnmanagedFds = 1 << 4
405
};
406
}  // namespace EnvironmentFlags
407
408
632
struct InspectorParentHandle {
409
  virtual ~InspectorParentHandle();
410
};
411
412
// TODO(addaleax): Maybe move per-Environment options parsing here.
413
// Returns nullptr when the Environment cannot be created e.g. there are
414
// pending JavaScript exceptions.
415
NODE_EXTERN Environment* CreateEnvironment(
416
    IsolateData* isolate_data,
417
    v8::Local<v8::Context> context,
418
    const std::vector<std::string>& args,
419
    const std::vector<std::string>& exec_args,
420
    EnvironmentFlags::Flags flags = EnvironmentFlags::kDefaultFlags,
421
    ThreadId thread_id = {} /* allocates a thread id automatically */,
422
    std::unique_ptr<InspectorParentHandle> inspector_parent_handle = {});
423
424
// Returns a handle that can be passed to `LoadEnvironment()`, making the
425
// child Environment accessible to the inspector as if it were a Node.js Worker.
426
// `child_thread_id` can be created using `AllocateEnvironmentThreadId()`
427
// and then later passed on to `CreateEnvironment()` to create the child
428
// Environment, together with the inspector handle.
429
// This method should not be called while the parent Environment is active
430
// on another thread.
431
NODE_EXTERN std::unique_ptr<InspectorParentHandle> GetInspectorParentHandle(
432
    Environment* parent_env,
433
    ThreadId child_thread_id,
434
    const char* child_url);
435
436
struct StartExecutionCallbackInfo {
437
  v8::Local<v8::Object> process_object;
438
  v8::Local<v8::Function> native_require;
439
};
440
441
using StartExecutionCallback =
442
    std::function<v8::MaybeLocal<v8::Value>(const StartExecutionCallbackInfo&)>;
443
444
NODE_EXTERN v8::MaybeLocal<v8::Value> LoadEnvironment(
445
    Environment* env,
446
    StartExecutionCallback cb);
447
NODE_EXTERN v8::MaybeLocal<v8::Value> LoadEnvironment(
448
    Environment* env,
449
    const char* main_script_source_utf8);
450
NODE_EXTERN void FreeEnvironment(Environment* env);
451
452
// Set a callback that is called when process.exit() is called from JS,
453
// overriding the default handler.
454
// It receives the Environment* instance and the exit code as arguments.
455
// This could e.g. call Stop(env); in order to terminate execution and stop
456
// the event loop.
457
// The default handler disposes of the global V8 platform instance, if one is
458
// being used, and calls exit().
459
NODE_EXTERN void SetProcessExitHandler(
460
    Environment* env,
461
    std::function<void(Environment*, int)>&& handler);
462
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);
463
464
// This may return nullptr if context is not associated with a Node instance.
465
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
466
467
NODE_EXTERN void OnFatalError(const char* location, const char* message);
468
NODE_EXTERN void PromiseRejectCallback(v8::PromiseRejectMessage message);
469
NODE_EXTERN bool AllowWasmCodeGenerationCallback(v8::Local<v8::Context> context,
470
                                            v8::Local<v8::String>);
471
NODE_EXTERN bool ShouldAbortOnUncaughtException(v8::Isolate* isolate);
472
NODE_EXTERN v8::MaybeLocal<v8::Value> PrepareStackTraceCallback(
473
    v8::Local<v8::Context> context,
474
    v8::Local<v8::Value> exception,
475
    v8::Local<v8::Array> trace);
476
477
// This returns the MultiIsolatePlatform used for an Environment or IsolateData
478
// instance, if one exists.
479
NODE_EXTERN MultiIsolatePlatform* GetMultiIsolatePlatform(Environment* env);
480
NODE_EXTERN MultiIsolatePlatform* GetMultiIsolatePlatform(IsolateData* env);
481
482
NODE_DEPRECATED("Use MultiIsolatePlatform::Create() instead",
483
    NODE_EXTERN MultiIsolatePlatform* CreatePlatform(
484
        int thread_pool_size,
485
        v8::TracingController* tracing_controller));
486
NODE_DEPRECATED("Use MultiIsolatePlatform::Create() instead",
487
    NODE_EXTERN void FreePlatform(MultiIsolatePlatform* platform));
488
489
// Get/set the currently active tracing controller. Using CreatePlatform()
490
// will implicitly set this by default. This is global and should be initialized
491
// along with the v8::Platform instance that is being used. `controller`
492
// is allowed to be `nullptr`.
493
// This is used for tracing events from Node.js itself. V8 uses the tracing
494
// controller returned from the active `v8::Platform` instance.
495
NODE_EXTERN v8::TracingController* GetTracingController();
496
NODE_EXTERN void SetTracingController(v8::TracingController* controller);
497
498
// Run `process.emit('beforeExit')` as it would usually happen when Node.js is
499
// run in standalone mode.
500
NODE_EXTERN v8::Maybe<bool> EmitProcessBeforeExit(Environment* env);
501
NODE_DEPRECATED("Use Maybe version (EmitProcessBeforeExit) instead",
502
    NODE_EXTERN void EmitBeforeExit(Environment* env));
503
// Run `process.emit('exit')` as it would usually happen when Node.js is run
504
// in standalone mode. The return value corresponds to the exit code.
505
NODE_EXTERN v8::Maybe<int> EmitProcessExit(Environment* env);
506
NODE_DEPRECATED("Use Maybe version (EmitProcessExit) instead",
507
    NODE_EXTERN int EmitExit(Environment* env));
508
509
// Runs hooks added through `AtExit()`. This is part of `FreeEnvironment()`,
510
// so calling it manually is typically not necessary.
511
NODE_EXTERN void RunAtExit(Environment* env);
512
513
// This may return nullptr if the current v8::Context is not associated
514
// with a Node instance.
515
NODE_EXTERN struct uv_loop_s* GetCurrentEventLoop(v8::Isolate* isolate);
516
517
// Runs the main loop for a given Environment. This roughly performs the
518
// following steps:
519
// 1. Call uv_run() on the event loop until it is drained.
520
// 2. Call platform->DrainTasks() on the associated platform/isolate.
521
//   3. If the event loop is alive again, go to Step 1.
522
// 4. Call EmitProcessBeforeExit().
523
//   5. If the event loop is alive again, go to Step 1.
524
// 6. Call EmitProcessExit() and forward the return value.
525
// If at any point node::Stop() is called, the function will attempt to return
526
// as soon as possible, returning an empty `Maybe`.
527
// This function only works if `env` has an associated `MultiIsolatePlatform`.
528
NODE_EXTERN v8::Maybe<int> SpinEventLoop(Environment* env);
529
530
class NODE_EXTERN CommonEnvironmentSetup {
531
 public:
532
  ~CommonEnvironmentSetup();
533
534
  // Create a new CommonEnvironmentSetup, that is, a group of objects that
535
  // together form the typical setup for a single Node.js Environment instance.
536
  // If any error occurs, `*errors` will be populated and the returned pointer
537
  // will be empty.
538
  // env_args will be passed through as arguments to CreateEnvironment(), after
539
  // `isolate_data` and `context`.
540
  template <typename... EnvironmentArgs>
541
  static std::unique_ptr<CommonEnvironmentSetup> Create(
542
      MultiIsolatePlatform* platform,
543
      std::vector<std::string>* errors,
544
      EnvironmentArgs&&... env_args);
545
546
  struct uv_loop_s* event_loop() const;
547
  std::shared_ptr<ArrayBufferAllocator> array_buffer_allocator() const;
548
  v8::Isolate* isolate() const;
549
  IsolateData* isolate_data() const;
550
  Environment* env() const;
551
  v8::Local<v8::Context> context() const;
552
553
  CommonEnvironmentSetup(const CommonEnvironmentSetup&) = delete;
554
  CommonEnvironmentSetup& operator=(const CommonEnvironmentSetup&) = delete;
555
  CommonEnvironmentSetup(CommonEnvironmentSetup&&) = delete;
556
  CommonEnvironmentSetup& operator=(CommonEnvironmentSetup&&) = delete;
557
558
 private:
559
  struct Impl;
560
  Impl* impl_;
561
  CommonEnvironmentSetup(
562
      MultiIsolatePlatform*,
563
      std::vector<std::string>*,
564
      std::function<Environment*(const CommonEnvironmentSetup*)>);
565
};
566
567
// Implementation for CommonEnvironmentSetup::Create
568
template <typename... EnvironmentArgs>
569
7
std::unique_ptr<CommonEnvironmentSetup> CommonEnvironmentSetup::Create(
570
    MultiIsolatePlatform* platform,
571
    std::vector<std::string>* errors,
572
    EnvironmentArgs&&... env_args) {
573
7
  auto ret = std::unique_ptr<CommonEnvironmentSetup>(new CommonEnvironmentSetup(
574
      platform, errors,
575
7
      [&](const CommonEnvironmentSetup* setup) -> Environment* {
576
28
        return CreateEnvironment(
577
            setup->isolate_data(), setup->context(),
578
28
            std::forward<EnvironmentArgs>(env_args)...);
579
14
      }));
580
7
  if (!errors->empty()) ret.reset();
581
7
  return ret;
582
}
583
584
/* Converts a unixtime to V8 Date */
585
NODE_DEPRECATED("Use v8::Date::New() directly",
586
                inline v8::Local<v8::Value> NODE_UNIXTIME_V8(double time) {
587
                  return v8::Date::New(
588
                             v8::Isolate::GetCurrent()->GetCurrentContext(),
589
                             1000 * time)
590
                      .ToLocalChecked();
591
                })
592
#define NODE_UNIXTIME_V8 node::NODE_UNIXTIME_V8
593
NODE_DEPRECATED("Use v8::Date::ValueOf() directly",
594
                inline double NODE_V8_UNIXTIME(v8::Local<v8::Date> date) {
595
  return date->ValueOf() / 1000;
596
})
597
#define NODE_V8_UNIXTIME node::NODE_V8_UNIXTIME
598
599
#define NODE_DEFINE_CONSTANT(target, constant)                                \
600
  do {                                                                        \
601
    v8::Isolate* isolate = target->GetIsolate();                              \
602
    v8::Local<v8::Context> context = isolate->GetCurrentContext();            \
603
    v8::Local<v8::String> constant_name =                                     \
604
        v8::String::NewFromUtf8(isolate, #constant,                           \
605
            v8::NewStringType::kInternalized).ToLocalChecked();               \
606
    v8::Local<v8::Number> constant_value =                                    \
607
        v8::Number::New(isolate, static_cast<double>(constant));              \
608
    v8::PropertyAttribute constant_attributes =                               \
609
        static_cast<v8::PropertyAttribute>(v8::ReadOnly | v8::DontDelete);    \
610
    (target)->DefineOwnProperty(context,                                      \
611
                                constant_name,                                \
612
                                constant_value,                               \
613
                                constant_attributes).Check();                 \
614
  }                                                                           \
615
  while (0)
616
617
#define NODE_DEFINE_HIDDEN_CONSTANT(target, constant)                         \
618
  do {                                                                        \
619
    v8::Isolate* isolate = target->GetIsolate();                              \
620
    v8::Local<v8::Context> context = isolate->GetCurrentContext();            \
621
    v8::Local<v8::String> constant_name =                                     \
622
        v8::String::NewFromUtf8(isolate, #constant,                           \
623
                                v8::NewStringType::kInternalized)             \
624
                                  .ToLocalChecked();                          \
625
    v8::Local<v8::Number> constant_value =                                    \
626
        v8::Number::New(isolate, static_cast<double>(constant));              \
627
    v8::PropertyAttribute constant_attributes =                               \
628
        static_cast<v8::PropertyAttribute>(v8::ReadOnly |                     \
629
                                           v8::DontDelete |                   \
630
                                           v8::DontEnum);                     \
631
    (target)->DefineOwnProperty(context,                                      \
632
                                constant_name,                                \
633
                                constant_value,                               \
634
                                constant_attributes).Check();                 \
635
  }                                                                           \
636
  while (0)
637
638
// Used to be a macro, hence the uppercase name.
639
inline void NODE_SET_METHOD(v8::Local<v8::Template> recv,
640
                            const char* name,
641
                            v8::FunctionCallback callback) {
642
  v8::Isolate* isolate = v8::Isolate::GetCurrent();
643
  v8::HandleScope handle_scope(isolate);
644
  v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New(isolate,
645
                                                                callback);
646
  v8::Local<v8::String> fn_name = v8::String::NewFromUtf8(isolate, name,
647
      v8::NewStringType::kInternalized).ToLocalChecked();
648
  t->SetClassName(fn_name);
649
  recv->Set(fn_name, t);
650
}
651
652
// Used to be a macro, hence the uppercase name.
653
inline void NODE_SET_METHOD(v8::Local<v8::Object> recv,
654
                            const char* name,
655
                            v8::FunctionCallback callback) {
656
  v8::Isolate* isolate = v8::Isolate::GetCurrent();
657
  v8::HandleScope handle_scope(isolate);
658
  v8::Local<v8::Context> context = isolate->GetCurrentContext();
659
  v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New(isolate,
660
                                                                callback);
661
  v8::Local<v8::Function> fn = t->GetFunction(context).ToLocalChecked();
662
  v8::Local<v8::String> fn_name = v8::String::NewFromUtf8(isolate, name,
663
      v8::NewStringType::kInternalized).ToLocalChecked();
664
  fn->SetName(fn_name);
665
  recv->Set(context, fn_name, fn).Check();
666
}
667
#define NODE_SET_METHOD node::NODE_SET_METHOD
668
669
// Used to be a macro, hence the uppercase name.
670
// Not a template because it only makes sense for FunctionTemplates.
671
inline void NODE_SET_PROTOTYPE_METHOD(v8::Local<v8::FunctionTemplate> recv,
672
                                      const char* name,
673
                                      v8::FunctionCallback callback) {
674
  v8::Isolate* isolate = v8::Isolate::GetCurrent();
675
  v8::HandleScope handle_scope(isolate);
676
  v8::Local<v8::Signature> s = v8::Signature::New(isolate, recv);
677
  v8::Local<v8::FunctionTemplate> t =
678
      v8::FunctionTemplate::New(isolate, callback, v8::Local<v8::Value>(), s);
679
  v8::Local<v8::String> fn_name = v8::String::NewFromUtf8(isolate, name,
680
      v8::NewStringType::kInternalized).ToLocalChecked();
681
  t->SetClassName(fn_name);
682
  recv->PrototypeTemplate()->Set(fn_name, t);
683
}
684
#define NODE_SET_PROTOTYPE_METHOD node::NODE_SET_PROTOTYPE_METHOD
685
686
// BINARY is a deprecated alias of LATIN1.
687
// BASE64URL is not currently exposed to the JavaScript side.
688
enum encoding {
689
  ASCII,
690
  UTF8,
691
  BASE64,
692
  UCS2,
693
  BINARY,
694
  HEX,
695
  BUFFER,
696
  BASE64URL,
697
  LATIN1 = BINARY
698
};
699
700
NODE_EXTERN enum encoding ParseEncoding(
701
    v8::Isolate* isolate,
702
    v8::Local<v8::Value> encoding_v,
703
    enum encoding default_encoding = LATIN1);
704
705
NODE_EXTERN void FatalException(v8::Isolate* isolate,
706
                                const v8::TryCatch& try_catch);
707
708
NODE_EXTERN v8::Local<v8::Value> Encode(v8::Isolate* isolate,
709
                                        const char* buf,
710
                                        size_t len,
711
                                        enum encoding encoding = LATIN1);
712
713
// Warning: This reverses endianness on Big Endian platforms, even though the
714
// signature using uint16_t implies that it should not.
715
NODE_EXTERN v8::Local<v8::Value> Encode(v8::Isolate* isolate,
716
                                        const uint16_t* buf,
717
                                        size_t len);
718
719
// Returns -1 if the handle was not valid for decoding
720
NODE_EXTERN ssize_t DecodeBytes(v8::Isolate* isolate,
721
                                v8::Local<v8::Value>,
722
                                enum encoding encoding = LATIN1);
723
// returns bytes written.
724
NODE_EXTERN ssize_t DecodeWrite(v8::Isolate* isolate,
725
                                char* buf,
726
                                size_t buflen,
727
                                v8::Local<v8::Value>,
728
                                enum encoding encoding = LATIN1);
729
#ifdef _WIN32
730
NODE_EXTERN v8::Local<v8::Value> WinapiErrnoException(
731
    v8::Isolate* isolate,
732
    int errorno,
733
    const char* syscall = nullptr,
734
    const char* msg = "",
735
    const char* path = nullptr);
736
#endif
737
738
const char* signo_string(int errorno);
739
740
741
typedef void (*addon_register_func)(
742
    v8::Local<v8::Object> exports,
743
    v8::Local<v8::Value> module,
744
    void* priv);
745
746
typedef void (*addon_context_register_func)(
747
    v8::Local<v8::Object> exports,
748
    v8::Local<v8::Value> module,
749
    v8::Local<v8::Context> context,
750
    void* priv);
751
752
enum ModuleFlags {
753
  kLinked = 0x02
754
};
755
756
struct node_module {
757
  int nm_version;
758
  unsigned int nm_flags;
759
  void* nm_dso_handle;
760
  const char* nm_filename;
761
  node::addon_register_func nm_register_func;
762
  node::addon_context_register_func nm_context_register_func;
763
  const char* nm_modname;
764
  void* nm_priv;
765
  struct node_module* nm_link;
766
};
767
768
extern "C" NODE_EXTERN void node_module_register(void* mod);
769
770
#ifdef _WIN32
771
# define NODE_MODULE_EXPORT __declspec(dllexport)
772
#else
773
# define NODE_MODULE_EXPORT __attribute__((visibility("default")))
774
#endif
775
776
#ifdef NODE_SHARED_MODE
777
# define NODE_CTOR_PREFIX
778
#else
779
# define NODE_CTOR_PREFIX static
780
#endif
781
782
#if defined(_MSC_VER)
783
#pragma section(".CRT$XCU", read)
784
#define NODE_C_CTOR(fn)                                               \
785
  NODE_CTOR_PREFIX void __cdecl fn(void);                             \
786
  __declspec(dllexport, allocate(".CRT$XCU"))                         \
787
      void (__cdecl*fn ## _)(void) = fn;                              \
788
  NODE_CTOR_PREFIX void __cdecl fn(void)
789
#else
790
#define NODE_C_CTOR(fn)                                               \
791
  NODE_CTOR_PREFIX void fn(void) __attribute__((constructor));        \
792
  NODE_CTOR_PREFIX void fn(void)
793
#endif
794
795
#define NODE_MODULE_X(modname, regfunc, priv, flags)                  \
796
  extern "C" {                                                        \
797
    static node::node_module _module =                                \
798
    {                                                                 \
799
      NODE_MODULE_VERSION,                                            \
800
      flags,                                                          \
801
      NULL,  /* NOLINT (readability/null_usage) */                    \
802
      __FILE__,                                                       \
803
      (node::addon_register_func) (regfunc),                          \
804
      NULL,  /* NOLINT (readability/null_usage) */                    \
805
      NODE_STRINGIFY(modname),                                        \
806
      priv,                                                           \
807
      NULL   /* NOLINT (readability/null_usage) */                    \
808
    };                                                                \
809
    NODE_C_CTOR(_register_ ## modname) {                              \
810
      node_module_register(&_module);                                 \
811
    }                                                                 \
812
  }
813
814
#define NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, priv, flags)    \
815
  extern "C" {                                                        \
816
    static node::node_module _module =                                \
817
    {                                                                 \
818
      NODE_MODULE_VERSION,                                            \
819
      flags,                                                          \
820
      NULL,  /* NOLINT (readability/null_usage) */                    \
821
      __FILE__,                                                       \
822
      NULL,  /* NOLINT (readability/null_usage) */                    \
823
      (node::addon_context_register_func) (regfunc),                  \
824
      NODE_STRINGIFY(modname),                                        \
825
      priv,                                                           \
826
      NULL  /* NOLINT (readability/null_usage) */                     \
827
    };                                                                \
828
    NODE_C_CTOR(_register_ ## modname) {                              \
829
      node_module_register(&_module);                                 \
830
    }                                                                 \
831
  }
832
833
// Usage: `NODE_MODULE(NODE_GYP_MODULE_NAME, InitializerFunction)`
834
// If no NODE_MODULE is declared, Node.js looks for the well-known
835
// symbol `node_register_module_v${NODE_MODULE_VERSION}`.
836
#define NODE_MODULE(modname, regfunc)                                 \
837
  NODE_MODULE_X(modname, regfunc, NULL, 0)  // NOLINT (readability/null_usage)
838
839
#define NODE_MODULE_CONTEXT_AWARE(modname, regfunc)                   \
840
  /* NOLINTNEXTLINE (readability/null_usage) */                       \
841
  NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL, 0)
842
843
// Embedders can use this type of binding for statically linked native bindings.
844
// It is used the same way addon bindings are used, except that linked bindings
845
// can be accessed through `process._linkedBinding(modname)`.
846
#define NODE_MODULE_LINKED(modname, regfunc)                               \
847
  /* NOLINTNEXTLINE (readability/null_usage) */                            \
848
  NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL,                      \
849
                              node::ModuleFlags::kLinked)
850
851
/*
852
 * For backward compatibility in add-on modules.
853
 */
854
#define NODE_MODULE_DECL /* nothing */
855
856
#define NODE_MODULE_INITIALIZER_BASE node_register_module_v
857
858
#define NODE_MODULE_INITIALIZER_X(base, version)                      \
859
    NODE_MODULE_INITIALIZER_X_HELPER(base, version)
860
861
#define NODE_MODULE_INITIALIZER_X_HELPER(base, version) base##version
862
863
#define NODE_MODULE_INITIALIZER                                       \
864
  NODE_MODULE_INITIALIZER_X(NODE_MODULE_INITIALIZER_BASE,             \
865
      NODE_MODULE_VERSION)
866
867
#define NODE_MODULE_INIT()                                            \
868
  extern "C" NODE_MODULE_EXPORT void                                  \
869
  NODE_MODULE_INITIALIZER(v8::Local<v8::Object> exports,              \
870
                          v8::Local<v8::Value> module,                \
871
                          v8::Local<v8::Context> context);            \
872
  NODE_MODULE_CONTEXT_AWARE(NODE_GYP_MODULE_NAME,                     \
873
                            NODE_MODULE_INITIALIZER)                  \
874
  void NODE_MODULE_INITIALIZER(v8::Local<v8::Object> exports,         \
875
                               v8::Local<v8::Value> module,           \
876
                               v8::Local<v8::Context> context)
877
878
// Allows embedders to add a binding to the current Environment* that can be
879
// accessed through process._linkedBinding() in the target Environment and all
880
// Worker threads that it creates.
881
// In each variant, the registration function needs to be usable at least for
882
// the time during which the Environment exists.
883
NODE_EXTERN void AddLinkedBinding(Environment* env, const node_module& mod);
884
NODE_EXTERN void AddLinkedBinding(Environment* env,
885
                                  const struct napi_module& mod);
886
NODE_EXTERN void AddLinkedBinding(Environment* env,
887
                                  const char* name,
888
                                  addon_context_register_func fn,
889
                                  void* priv);
890
891
/* Registers a callback with the passed-in Environment instance. The callback
892
 * is called after the event loop exits, but before the VM is disposed.
893
 * Callbacks are run in reverse order of registration, i.e. newest first.
894
 */
895
NODE_EXTERN void AtExit(Environment* env,
896
                        void (*cb)(void* arg),
897
                        void* arg);
898
899
typedef double async_id;
900
struct async_context {
901
  ::node::async_id async_id;
902
  ::node::async_id trigger_async_id;
903
};
904
905
/* This is a lot like node::AtExit, except that the hooks added via this
906
 * function are run before the AtExit ones and will always be registered
907
 * for the current Environment instance.
908
 * These functions are safe to use in an addon supporting multiple
909
 * threads/isolates. */
910
NODE_EXTERN void AddEnvironmentCleanupHook(v8::Isolate* isolate,
911
                                           void (*fun)(void* arg),
912
                                           void* arg);
913
914
NODE_EXTERN void RemoveEnvironmentCleanupHook(v8::Isolate* isolate,
915
                                              void (*fun)(void* arg),
916
                                              void* arg);
917
918
/* These are async equivalents of the above. After the cleanup hook is invoked,
919
 * `cb(cbarg)` *must* be called, and attempting to remove the cleanup hook will
920
 * have no effect. */
921
struct ACHHandle;
922
struct NODE_EXTERN DeleteACHHandle { void operator()(ACHHandle*) const; };
923
typedef std::unique_ptr<ACHHandle, DeleteACHHandle> AsyncCleanupHookHandle;
924
925
NODE_EXTERN AsyncCleanupHookHandle AddEnvironmentCleanupHook(
926
    v8::Isolate* isolate,
927
    void (*fun)(void* arg, void (*cb)(void*), void* cbarg),
928
    void* arg);
929
930
NODE_EXTERN void RemoveEnvironmentCleanupHook(AsyncCleanupHookHandle holder);
931
932
/* Returns the id of the current execution context. If the return value is
933
 * zero then no execution has been set. This will happen if the user handles
934
 * I/O from native code. */
935
NODE_EXTERN async_id AsyncHooksGetExecutionAsyncId(v8::Isolate* isolate);
936
937
/* Return same value as async_hooks.triggerAsyncId(); */
938
NODE_EXTERN async_id AsyncHooksGetTriggerAsyncId(v8::Isolate* isolate);
939
940
/* If the native API doesn't inherit from the helper class then the callbacks
941
 * must be triggered manually. This triggers the init() callback. The return
942
 * value is the async id assigned to the resource.
943
 *
944
 * The `trigger_async_id` parameter should correspond to the resource which is
945
 * creating the new resource, which will usually be the return value of
946
 * `AsyncHooksGetTriggerAsyncId()`. */
947
NODE_EXTERN async_context EmitAsyncInit(v8::Isolate* isolate,
948
                                        v8::Local<v8::Object> resource,
949
                                        const char* name,
950
                                        async_id trigger_async_id = -1);
951
952
NODE_EXTERN async_context EmitAsyncInit(v8::Isolate* isolate,
953
                                        v8::Local<v8::Object> resource,
954
                                        v8::Local<v8::String> name,
955
                                        async_id trigger_async_id = -1);
956
957
/* Emit the destroy() callback. The overload taking an `Environment*` argument
958
 * should be used when the Isolate’s current Context is not associated with
959
 * a Node.js Environment, or when there is no current Context, for example
960
 * when calling this function during garbage collection. In that case, the
961
 * `Environment*` value should have been acquired previously, e.g. through
962
 * `GetCurrentEnvironment()`. */
963
NODE_EXTERN void EmitAsyncDestroy(v8::Isolate* isolate,
964
                                  async_context asyncContext);
965
NODE_EXTERN void EmitAsyncDestroy(Environment* env,
966
                                  async_context asyncContext);
967
968
class InternalCallbackScope;
969
970
/* This class works like `MakeCallback()` in that it sets up a specific
971
 * asyncContext as the current one and informs the async_hooks and domains
972
 * modules that this context is currently active.
973
 *
974
 * `MakeCallback()` is a wrapper around this class as well as
975
 * `Function::Call()`. Either one of these mechanisms needs to be used for
976
 * top-level calls into JavaScript (i.e. without any existing JS stack).
977
 *
978
 * This object should be stack-allocated to ensure that it is contained in a
979
 * valid HandleScope.
980
 *
981
 * Exceptions happening within this scope will be treated like uncaught
982
 * exceptions. If this behaviour is undesirable, a new `v8::TryCatch` scope
983
 * needs to be created inside of this scope.
984
 */
985
class NODE_EXTERN CallbackScope {
986
 public:
987
  CallbackScope(v8::Isolate* isolate,
988
                v8::Local<v8::Object> resource,
989
                async_context asyncContext);
990
  ~CallbackScope();
991
992
  void operator=(const CallbackScope&) = delete;
993
  void operator=(CallbackScope&&) = delete;
994
  CallbackScope(const CallbackScope&) = delete;
995
  CallbackScope(CallbackScope&&) = delete;
996
997
 private:
998
  InternalCallbackScope* private_;
999
  v8::TryCatch try_catch_;
1000
};
1001
1002
/* An API specific to emit before/after callbacks is unnecessary because
1003
 * MakeCallback will automatically call them for you.
1004
 *
1005
 * These methods may create handles on their own, so run them inside a
1006
 * HandleScope.
1007
 *
1008
 * `asyncId` and `triggerAsyncId` should correspond to the values returned by
1009
 * `EmitAsyncInit()` and `AsyncHooksGetTriggerAsyncId()`, respectively, when the
1010
 * invoking resource was created. If these values are unknown, 0 can be passed.
1011
 * */
1012
NODE_EXTERN
1013
v8::MaybeLocal<v8::Value> MakeCallback(v8::Isolate* isolate,
1014
                                       v8::Local<v8::Object> recv,
1015
                                       v8::Local<v8::Function> callback,
1016
                                       int argc,
1017
                                       v8::Local<v8::Value>* argv,
1018
                                       async_context asyncContext);
1019
NODE_EXTERN
1020
v8::MaybeLocal<v8::Value> MakeCallback(v8::Isolate* isolate,
1021
                                       v8::Local<v8::Object> recv,
1022
                                       const char* method,
1023
                                       int argc,
1024
                                       v8::Local<v8::Value>* argv,
1025
                                       async_context asyncContext);
1026
NODE_EXTERN
1027
v8::MaybeLocal<v8::Value> MakeCallback(v8::Isolate* isolate,
1028
                                       v8::Local<v8::Object> recv,
1029
                                       v8::Local<v8::String> symbol,
1030
                                       int argc,
1031
                                       v8::Local<v8::Value>* argv,
1032
                                       async_context asyncContext);
1033
1034
/* Helper class users can optionally inherit from. If
1035
 * `AsyncResource::MakeCallback()` is used, then all four callbacks will be
1036
 * called automatically. */
1037
class NODE_EXTERN AsyncResource {
1038
 public:
1039
  AsyncResource(v8::Isolate* isolate,
1040
                v8::Local<v8::Object> resource,
1041
                const char* name,
1042
                async_id trigger_async_id = -1);
1043
1044
  virtual ~AsyncResource();
1045
1046
  AsyncResource(const AsyncResource&) = delete;
1047
  void operator=(const AsyncResource&) = delete;
1048
1049
  v8::MaybeLocal<v8::Value> MakeCallback(
1050
      v8::Local<v8::Function> callback,
1051
      int argc,
1052
      v8::Local<v8::Value>* argv);
1053
1054
  v8::MaybeLocal<v8::Value> MakeCallback(
1055
      const char* method,
1056
      int argc,
1057
      v8::Local<v8::Value>* argv);
1058
1059
  v8::MaybeLocal<v8::Value> MakeCallback(
1060
      v8::Local<v8::String> symbol,
1061
      int argc,
1062
      v8::Local<v8::Value>* argv);
1063
1064
  v8::Local<v8::Object> get_resource();
1065
  async_id get_async_id() const;
1066
  async_id get_trigger_async_id() const;
1067
1068
 protected:
1069
638
  class NODE_EXTERN CallbackScope : public node::CallbackScope {
1070
   public:
1071
    explicit CallbackScope(AsyncResource* res);
1072
  };
1073
1074
 private:
1075
  Environment* env_;
1076
  v8::Global<v8::Object> resource_;
1077
  async_context async_context_;
1078
};
1079
1080
#ifndef _WIN32
1081
// Register a signal handler without interrupting any handlers that node
1082
// itself needs. This does override handlers registered through
1083
// process.on('SIG...', function() { ... }). The `reset_handler` flag indicates
1084
// whether the signal handler for the given signal should be reset to its
1085
// default value before executing the handler (i.e. it works like SA_RESETHAND).
1086
// The `reset_handler` flag is invalid when `signal` is SIGSEGV.
1087
NODE_EXTERN
1088
void RegisterSignalHandler(int signal,
1089
                           void (*handler)(int signal,
1090
                                           siginfo_t* info,
1091
                                           void* ucontext),
1092
                           bool reset_handler = false);
1093
#endif  // _WIN32
1094
1095
}  // namespace node
1096
1097
#endif  // SRC_NODE_H_