GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: node_options.h Lines: 35 37 94.6 %
Date: 2022-04-03 04:14:58 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
#if HAVE_OPENSSL
15
#include "openssl/opensslv.h"
16
#endif
17
18
namespace node {
19
20
5587
class HostPort {
21
 public:
22
5410
  HostPort(const std::string& host_name, int port)
23
5410
      : host_name_(host_name), port_(port) {}
24
16779
  HostPort(const HostPort&) = default;
25
  HostPort& operator=(const HostPort&) = default;
26
  HostPort(HostPort&&) = default;
27
  HostPort& operator=(HostPort&&) = default;
28
29
  void set_host(const std::string& host) { host_name_ = host; }
30
31
96
  void set_port(int port) { port_ = port; }
32
33
6037
  const std::string& host() const { return host_name_; }
34
35
6184
  int port() const {
36
    // TODO(joyeecheung): make port a uint16_t
37
6184
    CHECK_GE(port_, 0);
38
6184
    return port_;
39
  }
40
41
100
  void Update(const HostPort& other) {
42
100
    if (!other.host_name_.empty()) host_name_ = other.host_name_;
43
100
    if (other.port_ >= 0) port_ = other.port_;
44
100
  }
45
46
 private:
47
  std::string host_name_;
48
  int port_;
49
};
50
51
class Options {
52
 public:
53
  virtual void CheckOptions(std::vector<std::string>* errors) {}
54
80814
  virtual ~Options() = default;
55
};
56
57
struct InspectPublishUid {
58
  bool console;
59
  bool http;
60
};
61
62
// These options are currently essentially per-Environment, but it can be nice
63
// to keep them separate since they are a group of options applying to a very
64
// specific part of Node. It might also make more sense for them to be
65
// per-Isolate, rather than per-Environment.
66
5587
class DebugOptions : public Options {
67
 public:
68
5310
  DebugOptions() = default;
69
11186
  DebugOptions(const DebugOptions&) = default;
70
  DebugOptions& operator=(const DebugOptions&) = default;
71
  DebugOptions(DebugOptions&&) = default;
72
  DebugOptions& operator=(DebugOptions&&) = default;
73
74
  // --inspect
75
  bool inspector_enabled = false;
76
  // --debug
77
  bool deprecated_debug = false;
78
  // --inspect-brk
79
  bool break_first_line = false;
80
  // --inspect-brk-node
81
  bool break_node_first_line = false;
82
  // --inspect-publish-uid
83
  std::string inspect_publish_uid_string = "stderr,http";
84
85
  InspectPublishUid inspect_publish_uid;
86
87
  enum { kDefaultInspectorPort = 9229 };
88
89
  HostPort host_port{"127.0.0.1", kDefaultInspectorPort};
90
91
  // Used to patch the options as if --inspect-brk is passed.
92
38
  void EnableBreakFirstLine() {
93
38
    inspector_enabled = true;
94
38
    break_first_line = true;
95
38
  }
96
97
5587
  bool wait_for_connect() const {
98

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