GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: node_options.h Lines: 34 36 94.4 %
Date: 2021-09-17 04:12:37 Branches: 8 10 80.0 %

Line Branch Exec Source
1
#ifndef SRC_NODE_OPTIONS_H_
2
#define SRC_NODE_OPTIONS_H_
3
4
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
5
6
#include <memory>
7
#include <string>
8
#include <unordered_map>
9
#include <vector>
10
#include "node_constants.h"
11
#include "node_mutex.h"
12
#include "util.h"
13
14
namespace node {
15
16
5393
class HostPort {
17
 public:
18
5230
  HostPort(const std::string& host_name, int port)
19
5230
      : host_name_(host_name), port_(port) {}
20
16194
  HostPort(const HostPort&) = default;
21
  HostPort& operator=(const HostPort&) = default;
22
  HostPort(HostPort&&) = default;
23
  HostPort& operator=(HostPort&&) = default;
24
25
  void set_host(const std::string& host) { host_name_ = host; }
26
27
96
  void set_port(int port) { port_ = port; }
28
29
5463
  const std::string& host() const { return host_name_; }
30
31
5588
  int port() const {
32
    // TODO(joyeecheung): make port a uint16_t
33
5588
    CHECK_GE(port_, 0);
34
5588
    return port_;
35
  }
36
37
100
  void Update(const HostPort& other) {
38
100
    if (!other.host_name_.empty()) host_name_ = other.host_name_;
39
100
    if (other.port_ >= 0) port_ = other.port_;
40
100
  }
41
42
 private:
43
  std::string host_name_;
44
  int port_;
45
};
46
47
class Options {
48
 public:
49
  virtual void CheckOptions(std::vector<std::string>* errors) {}
50
77636
  virtual ~Options() = default;
51
};
52
53
struct InspectPublishUid {
54
  bool console;
55
  bool http;
56
};
57
58
// These options are currently essentially per-Environment, but it can be nice
59
// to keep them separate since they are a group of options applying to a very
60
// specific part of Node. It might also make more sense for them to be
61
// per-Isolate, rather than per-Environment.
62
5393
class DebugOptions : public Options {
63
 public:
64
5130
  DebugOptions() = default;
65
10796
  DebugOptions(const DebugOptions&) = default;
66
  DebugOptions& operator=(const DebugOptions&) = default;
67
  DebugOptions(DebugOptions&&) = default;
68
  DebugOptions& operator=(DebugOptions&&) = default;
69
70
  // --inspect
71
  bool inspector_enabled = false;
72
  // --debug
73
  bool deprecated_debug = false;
74
  // --inspect-brk
75
  bool break_first_line = false;
76
  // --inspect-brk-node
77
  bool break_node_first_line = false;
78
  // --inspect-publish-uid
79
  std::string inspect_publish_uid_string = "stderr,http";
80
81
  InspectPublishUid inspect_publish_uid;
82
83
  enum { kDefaultInspectorPort = 9229 };
84
85
  HostPort host_port{"127.0.0.1", kDefaultInspectorPort};
86
87
  // Used to patch the options as if --inspect-brk is passed.
88
38
  void EnableBreakFirstLine() {
89
38
    inspector_enabled = true;
90
38
    break_first_line = true;
91
38
  }
92
93
5393
  bool wait_for_connect() const {
94

5393
    return break_first_line || break_node_first_line;
95
  }
96
97
  void CheckOptions(std::vector<std::string>* errors) override;
98
};
99
100
class EnvironmentOptions : public Options {
101
 public:
102
  bool abort_on_uncaught_exception = false;
103
  std::vector<std::string> conditions;
104
  std::string dns_result_order;
105
  bool enable_source_maps = false;
106
  bool experimental_json_modules = false;
107
  bool experimental_modules = false;
108
  std::string experimental_specifier_resolution;
109
  bool experimental_wasm_modules = false;
110
  bool experimental_import_meta_resolve = false;
111
  std::string module_type;
112
  std::string experimental_policy;
113
  std::string experimental_policy_integrity;
114
  bool has_policy_integrity_string;
115
  bool experimental_repl_await = true;
116
  bool experimental_vm_modules = false;
117
  bool expose_internals = false;
118
  bool frozen_intrinsics = false;
119
  int64_t heap_snapshot_near_heap_limit = 0;
120
  std::string heap_snapshot_signal;
121
  uint64_t max_http_header_size = 16 * 1024;
122
  bool deprecation = true;
123
  bool force_async_hooks_checks = true;
124
  bool allow_native_addons = true;
125
  bool warnings = true;
126
  bool force_context_aware = false;
127
  bool pending_deprecation = false;
128
  bool preserve_symlinks = false;
129
  bool preserve_symlinks_main = false;
130
  bool prof_process = false;
131
#if HAVE_INSPECTOR
132
  std::string cpu_prof_dir;
133
  static const uint64_t kDefaultCpuProfInterval = 1000;
134
  uint64_t cpu_prof_interval = kDefaultCpuProfInterval;
135
  std::string cpu_prof_name;
136
  bool cpu_prof = false;
137
  std::string heap_prof_dir;
138
  std::string heap_prof_name;
139
  static const uint64_t kDefaultHeapProfInterval = 512 * 1024;
140
  uint64_t heap_prof_interval = kDefaultHeapProfInterval;
141
  bool heap_prof = false;
142
#endif  // HAVE_INSPECTOR
143
  std::string redirect_warnings;
144
  std::string diagnostic_dir;
145
  bool test_udp_no_try_send = false;
146
  bool throw_deprecation = false;
147
  bool trace_atomics_wait = false;
148
  bool trace_deprecation = false;
149
  bool trace_exit = false;
150
  bool trace_sync_io = false;
151
  bool trace_tls = false;
152
  bool trace_uncaught = false;
153
  bool trace_warnings = false;
154
  bool extra_info_on_fatal_exception = true;
155
  std::string unhandled_rejections;
156
  std::string userland_loader;
157
  bool verify_base_objects =
158
#ifdef DEBUG
159
      true;
160
#else
161
      false;
162
#endif  // DEBUG
163
164
  bool syntax_check_only = false;
165
  bool has_eval_string = false;
166
  bool experimental_wasi = false;
167
  std::string eval_string;
168
  bool print_eval = false;
169
  bool force_repl = false;
170
171
  bool insecure_http_parser = false;
172
173
  bool tls_min_v1_0 = false;
174
  bool tls_min_v1_1 = false;
175
  bool tls_min_v1_2 = false;
176
  bool tls_min_v1_3 = false;
177
  bool tls_max_v1_2 = false;
178
  bool tls_max_v1_3 = false;
179
  std::string tls_keylog;
180
181
  std::vector<std::string> preload_modules;
182
183
  std::vector<std::string> user_argv;
184
185
37881
  inline DebugOptions* get_debug_options() { return &debug_options_; }
186
21580
  inline const DebugOptions& debug_options() const { return debug_options_; }
187
188
  void CheckOptions(std::vector<std::string>* errors) override;
189
190
 private:
191
  DebugOptions debug_options_;
192
};
193
194
class PerIsolateOptions : public Options {
195
 public:
196
  std::shared_ptr<EnvironmentOptions> per_env { new EnvironmentOptions() };
197
  bool track_heap_objects = false;
198
  bool node_snapshot = true;
199
  bool report_uncaught_exception = false;
200
  bool report_on_signal = false;
201
  bool experimental_top_level_await = true;
202
  std::string report_signal = "SIGUSR2";
203
  inline EnvironmentOptions* get_per_env_options();
204
  void CheckOptions(std::vector<std::string>* errors) override;
205
};
206
207
class PerProcessOptions : public Options {
208
 public:
209
  // Options shouldn't be here unless they affect the entire process scope, and
210
  // that should avoided when possible.
211
  //
212
  // When an option is used during process initialization, it does not need
213
  // protection, but any use after that will likely require synchronization
214
  // using the node::per_process::cli_options_mutex, typically:
215
  //
216
  //     Mutex::ScopedLock lock(node::per_process::cli_options_mutex);
217
  std::shared_ptr<PerIsolateOptions> per_isolate { new PerIsolateOptions() };
218
219
  std::string title;
220
  std::string trace_event_categories;
221
  std::string trace_event_file_pattern = "node_trace.${rotation}.log";
222
  int64_t v8_thread_pool_size = 4;
223
  bool zero_fill_all_buffers = false;
224
  bool debug_arraybuffer_allocations = false;
225
  std::string disable_proto;
226
227
  std::vector<std::string> security_reverts;
228
  bool print_bash_completion = false;
229
  bool print_help = false;
230
  bool print_v8_help = false;
231
  bool print_version = false;
232
233
#ifdef NODE_HAVE_I18N_SUPPORT
234
  std::string icu_data_dir;
235
#endif
236
237
  // Per-process because they affect singleton OpenSSL shared library state,
238
  // or are used once during process initialization.
239
#if HAVE_OPENSSL
240
  std::string openssl_config;
241
  std::string tls_cipher_list = DEFAULT_CIPHER_LIST_CORE;
242
  int64_t secure_heap = 0;
243
  int64_t secure_heap_min = 2;
244
#ifdef NODE_OPENSSL_CERT_STORE
245
  bool ssl_openssl_cert_store = true;
246
#else
247
  bool ssl_openssl_cert_store = false;
248
#endif
249
  bool use_openssl_ca = false;
250
  bool use_bundled_ca = false;
251
  bool enable_fips_crypto = false;
252
  bool force_fips_crypto = false;
253
#endif
254
255
  // Per-process because reports can be triggered outside a known V8 context.
256
  bool report_on_fatalerror = false;
257
  bool report_compact = false;
258
  std::string report_directory;
259
  std::string report_filename;
260
261
  // TODO(addaleax): Some of these could probably be per-Environment.
262
  std::string use_largepages = "off";
263
  bool trace_sigint = false;
264
  std::vector<std::string> cmdline;
265
266
  inline PerIsolateOptions* get_per_isolate_options();
267
  void CheckOptions(std::vector<std::string>* errors) override;
268
};
269
270
// The actual options parser, as opposed to the structs containing them:
271
272
namespace options_parser {
273
274
HostPort SplitHostPort(const std::string& arg,
275
    std::vector<std::string>* errors);
276
void GetOptions(const v8::FunctionCallbackInfo<v8::Value>& args);
277
std::string GetBashCompletion();
278
279
enum OptionType {
280
  kNoOp,
281
  kV8Option,
282
  kBoolean,
283
  kInteger,
284
  kUInteger,
285
  kString,
286
  kHostPort,
287
  kStringList,
288
};
289
290
template <typename Options>
291
class OptionsParser {
292
 public:
293
38952
  virtual ~OptionsParser() = default;
294
295
  typedef Options TargetType;
296
297
  struct NoOp {};
298
  struct V8Option {};
299
300
  // These methods add a single option to the parser. Optionally, it can be
301
  // specified whether the option should be allowed from environment variable
302
  // sources (i.e. NODE_OPTIONS).
303
  void AddOption(const char* name,
304
                 const char* help_text,
305
                 bool Options::* field,
306
                 OptionEnvvarSettings env_setting = kDisallowedInEnvironment,
307
                 bool default_is_true = false);
308
  void AddOption(const char* name,
309
                 const char* help_text,
310
                 uint64_t Options::* field,
311
                 OptionEnvvarSettings env_setting = kDisallowedInEnvironment);
312
  void AddOption(const char* name,
313
                 const char* help_text,
314
                 int64_t Options::* field,
315
                 OptionEnvvarSettings env_setting = kDisallowedInEnvironment);
316
  void AddOption(const char* name,
317
                 const char* help_text,
318
                 std::string Options::* field,
319
                 OptionEnvvarSettings env_setting = kDisallowedInEnvironment);
320
  void AddOption(const char* name,
321
                 const char* help_text,
322
                 std::vector<std::string> Options::* field,
323
                 OptionEnvvarSettings env_setting = kDisallowedInEnvironment);
324
  void AddOption(const char* name,
325
                 const char* help_text,
326
                 HostPort Options::* field,
327
                 OptionEnvvarSettings env_setting = kDisallowedInEnvironment);
328
  void AddOption(const char* name,
329
                 const char* help_text,
330
                 NoOp no_op_tag,
331
                 OptionEnvvarSettings env_setting = kDisallowedInEnvironment);
332
  void AddOption(const char* name,
333
                 const char* help_text,
334
                 V8Option v8_option_tag,
335
                 OptionEnvvarSettings env_setting = kDisallowedInEnvironment);
336
337
  // Adds aliases. An alias can be of the form "--option-a" -> "--option-b",
338
  // or have a more complex group expansion, like
339
  //   "--option-a" -> { "--option-b", "--harmony-foobar", "--eval", "42" }
340
  // If `from` has the form "--option-a=", the alias will only be expanded if
341
  // the option is presented in that form (i.e. with a '=').
342
  // If `from` has the form "--option-a <arg>", the alias will only be expanded
343
  // if the option has a non-option argument (not starting with -) following it.
344
  void AddAlias(const char* from, const char* to);
345
  void AddAlias(const char* from, const std::vector<std::string>& to);
346
  void AddAlias(const char* from,
347
                const std::initializer_list<std::string>& to);
348
349
  // Add implications from some arbitrary option to a boolean one, either
350
  // in a way that makes `from` set `to` to true or to false.
351
  void Implies(const char* from, const char* to);
352
  void ImpliesNot(const char* from, const char* to);
353
354
  // Insert options from another options parser into this one, along with
355
  // a method that yields the target options type from this parser's options
356
  // type.
357
  template <typename ChildOptions>
358
  void Insert(const OptionsParser<ChildOptions>& child_options_parser,
359
              ChildOptions* (Options::* get_child)());
360
361
  // Parse a sequence of options into an options struct, a list of
362
  // arguments that were parsed as options, a list of unknown/JS engine options,
363
  // and leave the remainder in the input `args` vector.
364
  //
365
  // For example, an `args` input of
366
  //
367
  //   node --foo --harmony-bar --fizzle=42 -- /path/to/cow moo
368
  //
369
  // expands as
370
  //
371
  // - `args` -> { "node", "/path/to/cow", "moo" }
372
  // - `exec_args` -> { "--foo", "--harmony-bar", "--fizzle=42" }
373
  // - `v8_args` -> `{ "node", "--harmony-bar" }
374
  // - `options->foo == true`, `options->fizzle == 42`.
375
  //
376
  // If `*error` is set, the result of the parsing should be discarded and the
377
  // contents of any of the argument vectors should be considered undefined.
378
  void Parse(std::vector<std::string>* const args,
379
             std::vector<std::string>* const exec_args,
380
             std::vector<std::string>* const v8_args,
381
             Options* const options,
382
             OptionEnvvarSettings required_env_settings,
383
             std::vector<std::string>* const errors) const;
384
385
 private:
386
  // We support the wide variety of different option types by remembering
387
  // how to access them, given a certain `Options` struct.
388
389
  // Represents a field within `Options`.
390
  class BaseOptionField {
391
   public:
392
2960352
    virtual ~BaseOptionField() = default;
393
    virtual void* LookupImpl(Options* options) const = 0;
394
395
    template <typename T>
396
1155708
    inline T* Lookup(Options* options) const {
397
1155708
      return static_cast<T*>(LookupImpl(options));
398
    }
399
  };
400
401
  // Represents a field of type T within `Options` that can be looked up
402
  // as a C++ member field.
403
  template <typename T>
404
  class SimpleOptionField : public BaseOptionField {
405
   public:
406
1041966
    explicit SimpleOptionField(T Options::* field) : field_(field) {}
407
577854
    void* LookupImpl(Options* options) const override {
408
1155708
      return static_cast<void*>(&(options->*field_));
409
    }
410
411
   private:
412
    T Options::* field_;
413
  };
414
415
  template <typename T>
416
577503
  inline T* Lookup(std::shared_ptr<BaseOptionField> field,
417
                   Options* options) const {
418
577503
    return field->template Lookup<T>(options);
419
  }
420
421
  // An option consists of:
422
  // - A type.
423
  // - A way to store/access the property value.
424
  // - The information of whether it may occur in an env var or not.
425
  struct OptionInfo {
426
    OptionType type;
427
    std::shared_ptr<BaseOptionField> field;
428
    OptionEnvvarSettings env_setting;
429
    std::string help_text;
430
    bool default_is_true = false;
431
  };
432
433
  // An implied option is composed of the information on where to store a
434
  // specific boolean value (if another specific option is encountered).
435
  struct Implication {
436
    OptionType type;
437
    std::string name;
438
    std::shared_ptr<BaseOptionField> target_field;
439
    bool target_value;
440
  };
441
442
  // These are helpers that make `Insert()` support properties of other
443
  // options structs, if we know how to access them.
444
  template <typename OriginalField, typename ChildOptions>
445
  static auto Convert(
446
      std::shared_ptr<OriginalField> original,
447
      ChildOptions* (Options::* get_child)());
448
  template <typename ChildOptions>
449
  static auto Convert(
450
      typename OptionsParser<ChildOptions>::OptionInfo original,
451
      ChildOptions* (Options::* get_child)());
452
  template <typename ChildOptions>
453
  static auto Convert(
454
      typename OptionsParser<ChildOptions>::Implication original,
455
      ChildOptions* (Options::* get_child)());
456
457
  std::unordered_map<std::string, OptionInfo> options_;
458
  std::unordered_map<std::string, std::vector<std::string>> aliases_;
459
  std::unordered_multimap<std::string, Implication> implications_;
460
461
  template <typename OtherOptions>
462
  friend class OptionsParser;
463
464
  friend void GetOptions(const v8::FunctionCallbackInfo<v8::Value>& args);
465
  friend std::string GetBashCompletion();
466
};
467
468
using StringVector = std::vector<std::string>;
469
template <class OptionsType, class = Options>
470
void Parse(
471
  StringVector* const args, StringVector* const exec_args,
472
  StringVector* const v8_args, OptionsType* const options,
473
  OptionEnvvarSettings required_env_settings, StringVector* const errors);
474
475
}  // namespace options_parser
476
477
namespace per_process {
478
479
extern Mutex cli_options_mutex;
480
extern std::shared_ptr<PerProcessOptions> cli_options;
481
482
}  // namespace per_process
483
484
void HandleEnvOptions(std::shared_ptr<EnvironmentOptions> env_options);
485
void HandleEnvOptions(std::shared_ptr<EnvironmentOptions> env_options,
486
                      std::function<std::string(const char*)> opt_getter);
487
488
std::vector<std::string> ParseNodeOptionsEnvVar(
489
    const std::string& node_options, std::vector<std::string>* errors);
490
}  // namespace node
491
492
#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
493
494
#endif  // SRC_NODE_OPTIONS_H_