GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: node_options.h Lines: 35 37 94.6 %
Date: 2022-02-05 04:14:12 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
5544
class HostPort {
21
 public:
22
5359
  HostPort(const std::string& host_name, int port)
23
5359
      : host_name_(host_name), port_(port) {}
24
16647
  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
5623
  const std::string& host() const { return host_name_; }
34
35
5766
  int port() const {
36
    // TODO(joyeecheung): make port a uint16_t
37
5766
    CHECK_GE(port_, 0);
38
5766
    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
80108
  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
5544
class DebugOptions : public Options {
67
 public:
68
5259
  DebugOptions() = default;
69
11098
  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
5544
  bool wait_for_connect() const {
98

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