GCC Code Coverage Report
Directory: ../ Exec Total Coverage
File: /home/iojs/build/workspace/node-test-commit-linux-coverage-daily/nodes/benchmark/out/../src/node_options-inl.h Lines: 172 175 98.3 %
Date: 2020-02-19 22:14:06 Branches: 223 396 56.3 %

Line Branch Exec Source
1
#ifndef SRC_NODE_OPTIONS_INL_H_
2
#define SRC_NODE_OPTIONS_INL_H_
3
4
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
5
6
#include <cstdlib>
7
#include "node_options.h"
8
#include "util.h"
9
10
namespace node {
11
12
329994
PerIsolateOptions* PerProcessOptions::get_per_isolate_options() {
13
329994
  return per_isolate.get();
14
}
15
16
294987
EnvironmentOptions* PerIsolateOptions::get_per_env_options() {
17
294987
  return per_env.get();
18
}
19
20
namespace options_parser {
21
22
template <typename Options>
23
255346
void OptionsParser<Options>::AddOption(const char* name,
24
                                       const char* help_text,
25
                                       bool Options::* field,
26
                                       OptionEnvvarSettings env_setting) {
27
255346
  options_.emplace(name,
28
                   OptionInfo{kBoolean,
29
                              std::make_shared<SimpleOptionField<bool>>(field),
30
                              env_setting,
31
                              help_text});
32
255346
}
33
34
template <typename Options>
35
12558
void OptionsParser<Options>::AddOption(const char* name,
36
                                       const char* help_text,
37
                                       uint64_t Options::* field,
38
                                       OptionEnvvarSettings env_setting) {
39
12558
  options_.emplace(
40
      name,
41
      OptionInfo{kUInteger,
42
                 std::make_shared<SimpleOptionField<uint64_t>>(field),
43
                 env_setting,
44
                 help_text});
45
12558
}
46
47
template <typename Options>
48
4186
void OptionsParser<Options>::AddOption(const char* name,
49
                                       const char* help_text,
50
                                       int64_t Options::* field,
51
                                       OptionEnvvarSettings env_setting) {
52
4186
  options_.emplace(
53
      name,
54
      OptionInfo{kInteger,
55
                 std::make_shared<SimpleOptionField<int64_t>>(field),
56
                 env_setting,
57
                 help_text});
58
4186
}
59
60
template <typename Options>
61
108836
void OptionsParser<Options>::AddOption(const char* name,
62
                                       const char* help_text,
63
                                       std::string Options::* field,
64
                                       OptionEnvvarSettings env_setting) {
65
108836
  options_.emplace(
66
      name,
67
      OptionInfo{kString,
68
                 std::make_shared<SimpleOptionField<std::string>>(field),
69
                 env_setting,
70
                 help_text});
71
108836
}
72
73
template <typename Options>
74
8372
void OptionsParser<Options>::AddOption(
75
    const char* name,
76
    const char* help_text,
77
    std::vector<std::string> Options::* field,
78
    OptionEnvvarSettings env_setting) {
79
8372
  options_.emplace(name, OptionInfo {
80
    kStringList,
81
    std::make_shared<SimpleOptionField<std::vector<std::string>>>(field),
82
    env_setting,
83
    help_text
84
  });
85
8372
}
86
87
template <typename Options>
88
4186
void OptionsParser<Options>::AddOption(const char* name,
89
                                       const char* help_text,
90
                                       HostPort Options::* field,
91
                                       OptionEnvvarSettings env_setting) {
92
4186
  options_.emplace(
93
      name,
94
      OptionInfo{kHostPort,
95
                 std::make_shared<SimpleOptionField<HostPort>>(field),
96
                 env_setting,
97
                 help_text});
98
4186
}
99
100
template <typename Options>
101
12558
void OptionsParser<Options>::AddOption(const char* name,
102
                                       const char* help_text,
103
                                       NoOp no_op_tag,
104
                                       OptionEnvvarSettings env_setting) {
105
12558
  options_.emplace(name, OptionInfo{kNoOp, nullptr, env_setting, help_text});
106
12558
}
107
108
template <typename Options>
109
37674
void OptionsParser<Options>::AddOption(const char* name,
110
                                       const char* help_text,
111
                                       V8Option v8_option_tag,
112
                                       OptionEnvvarSettings env_setting) {
113
37674
  options_.emplace(name,
114
                   OptionInfo{kV8Option, nullptr, env_setting, help_text});
115
37674
}
116
117
template <typename Options>
118
54418
void OptionsParser<Options>::AddAlias(const char* from,
119
                                      const char* to) {
120

54418
  aliases_[from] = { to };
121
54418
}
122
123
template <typename Options>
124
25116
void OptionsParser<Options>::AddAlias(const char* from,
125
                                      const std::vector<std::string>& to) {
126
25116
  aliases_[from] = to;
127
25116
}
128
129
template <typename Options>
130
25116
void OptionsParser<Options>::AddAlias(
131
    const char* from,
132
    const std::initializer_list<std::string>& to) {
133
25116
  AddAlias(from, std::vector<std::string>(to));
134
25116
}
135
136
template <typename Options>
137
25116
void OptionsParser<Options>::Implies(const char* from,
138
                                     const char* to) {
139
25116
  auto it = options_.find(to);
140


25116
  CHECK_NE(it, options_.end());
141


25116
  CHECK_EQ(it->second.type, kBoolean);
142
25116
  implications_.emplace(from, Implication {
143
25116
    it->second.field, true
144
  });
145
25116
}
146
147
template <typename Options>
148
4186
void OptionsParser<Options>::ImpliesNot(const char* from,
149
                                        const char* to) {
150
4186
  auto it = options_.find(to);
151
4186
  CHECK_NE(it, options_.end());
152
4186
  CHECK_EQ(it->second.type, kBoolean);
153
4186
  implications_.emplace(from, Implication {
154
4186
    it->second.field, false
155
  });
156
4186
}
157
158
template <typename Options>
159
template <typename OriginalField, typename ChildOptions>
160
732550
auto OptionsParser<Options>::Convert(
161
    std::shared_ptr<OriginalField> original,
162
    ChildOptions* (Options::* get_child)()) {
163
  // If we have a field on ChildOptions, and we want to access it from an
164
  // Options instance, we call get_child() on the original Options and then
165
  // access it, i.e. this class implements a kind of function chaining.
166
1465100
  struct AdaptedField : BaseOptionField {
167
655815
    void* LookupImpl(Options* options) const override {
168

655815
      return original->LookupImpl((options->*get_child)());
169
    }
170
171
732550
    AdaptedField(
172
        std::shared_ptr<OriginalField> original,
173
        ChildOptions* (Options::* get_child)())
174
732550
          : original(original), get_child(get_child) {}
175
176
    std::shared_ptr<OriginalField> original;
177
    ChildOptions* (Options::* get_child)();
178
  };
179
180
  return std::shared_ptr<BaseOptionField>(
181
732550
      new AdaptedField(original, get_child));
182
}
183
template <typename Options>
184
template <typename ChildOptions>
185
686504
auto OptionsParser<Options>::Convert(
186
    typename OptionsParser<ChildOptions>::OptionInfo original,
187
    ChildOptions* (Options::* get_child)()) {
188
686504
  return OptionInfo{original.type,
189
                    Convert(original.field, get_child),
190
686504
                    original.env_setting,
191
1373008
                    original.help_text};
192
}
193
194
template <typename Options>
195
template <typename ChildOptions>
196
46046
auto OptionsParser<Options>::Convert(
197
    typename OptionsParser<ChildOptions>::Implication original,
198
    ChildOptions* (Options::* get_child)()) {
199
  return Implication {
200
    Convert(original.target_field, get_child),
201
46046
    original.target_value
202
92092
  };
203
}
204
205
template <typename Options>
206
template <typename ChildOptions>
207
12558
void OptionsParser<Options>::Insert(
208
    const OptionsParser<ChildOptions>& child_options_parser,
209
    ChildOptions* (Options::* get_child)()) {
210
12558
  aliases_.insert(std::begin(child_options_parser.aliases_),
211
                  std::end(child_options_parser.aliases_));
212
213

699062
  for (const auto& pair : child_options_parser.options_)
214
686504
    options_.emplace(pair.first, Convert(pair.second, get_child));
215
216

58604
  for (const auto& pair : child_options_parser.implications_)
217
46046
    implications_.emplace(pair.first, Convert(pair.second, get_child));
218
12558
}
219
220
15
inline std::string NotAllowedInEnvErr(const std::string& arg) {
221
15
  return arg + " is not allowed in NODE_OPTIONS";
222
}
223
224
7
inline std::string RequiresArgumentErr(const std::string& arg) {
225
7
  return arg + " requires an argument";
226
}
227
228
// We store some of the basic information around a single Parse call inside
229
// this struct, to separate storage of command line arguments and their
230
// handling. In particular, this makes it easier to introduce 'synthetic'
231
// arguments that get inserted by expanding option aliases.
232
8316
struct ArgsInfo {
233
  // Generally, the idea here is that the first entry in `*underlying` stores
234
  // the "0th" argument (the program name), then `synthetic_args` are inserted,
235
  // followed by the remainder of `*underlying`.
236
  std::vector<std::string>* underlying;
237
  std::vector<std::string> synthetic_args;
238
239
  std::vector<std::string>* exec_args;
240
241
8316
  ArgsInfo(std::vector<std::string>* args,
242
           std::vector<std::string>* exec_args)
243
8316
    : underlying(args), exec_args(exec_args) {}
244
245
12340
  size_t remaining() const {
246
    // -1 to account for the program name.
247
12340
    return underlying->size() - 1 + synthetic_args.size();
248
  }
249
250
12340
  bool empty() const { return remaining() == 0; }
251
8316
  const std::string& program_name() const { return underlying->at(0); }
252
253
16636
  std::string& first() {
254
16636
    return synthetic_args.empty() ? underlying->at(1) : synthetic_args.front();
255
  }
256
257
2266
  std::string pop_first() {
258
2266
    std::string ret = std::move(first());
259
2266
    if (synthetic_args.empty()) {
260
      // Only push arguments to `exec_args` that were also originally passed
261
      // on the command line (i.e. not generated through alias expansion).
262
      // '--' is a special case here since its purpose is to end `exec_argv`,
263
      // which is why we do not include it.
264

2065
      if (exec_args != nullptr && ret != "--")
265
1954
        exec_args->push_back(ret);
266
2065
      underlying->erase(underlying->begin() + 1);
267
    } else {
268
201
      synthetic_args.erase(synthetic_args.begin());
269
    }
270
2266
    return ret;
271
  }
272
};
273
274
template <typename Options>
275
8316
void OptionsParser<Options>::Parse(
276
    std::vector<std::string>* const orig_args,
277
    std::vector<std::string>* const exec_args,
278
    std::vector<std::string>* const v8_args,
279
    Options* const options,
280
    OptionEnvvarSettings required_env_settings,
281
    std::vector<std::string>* const errors) const {
282
16632
  ArgsInfo args(orig_args, exec_args);
283
284
  // The first entry is the process name. Make sure it ends up in the V8 argv,
285
  // since V8::SetFlagsFromCommandLine() expects that to hold true for that
286
  // array as well.
287

8316
  if (v8_args->empty())
288
8316
    v8_args->push_back(args.program_name());
289
290




11682
  while (!args.empty() && errors->empty()) {
291




9353
    if (args.first().size() <= 1 || args.first()[0] != '-') break;
292
293
    // We know that we're either going to consume this
294
    // argument or fail completely.
295
3277
    const std::string arg = args.pop_first();
296
297

1720
    if (arg == "--") {
298

16
      if (required_env_settings == kAllowedInEnvironment)
299
1
        errors->push_back(NotAllowedInEnvErr("--"));
300
16
      break;
301
    }
302
303
    // Only allow --foo=bar notation for options starting with double dashes.
304
    // (E.g. -e=a is not allowed as shorthand for --eval=a, which would
305
    // otherwise be the result of alias expansion.)
306
    const std::string::size_type equals_index =
307



1704
        arg[0] == '-' && arg[1] == '-' ? arg.find('=') : std::string::npos;
308
    std::string name =
309



3261
      equals_index == std::string::npos ? arg : arg.substr(0, equals_index);
310
311
    // Store the 'original name' of the argument. This name differs from
312
    // 'name' in that it contains a possible '=' sign and is not affected
313
    // by alias expansion.
314


3261
    std::string original_name = name;
315

1704
    if (equals_index != std::string::npos)
316
161
      original_name += '=';
317
318
    // Normalize by replacing `_` with `-` in options.
319

20581
    for (std::string::size_type i = 2; i < name.size(); ++i) {
320

18877
      if (name[i] == '_')
321
60
        name[i] = '-';
322
    }
323
324
    {
325
1704
      auto it = aliases_.end();
326
      // Expand aliases:
327
      // - If `name` can be found in `aliases_`.
328
      // - If `name` + '=' can be found in `aliases_`.
329
      // - If `name` + " <arg>" can be found in `aliases_`, and we have
330
      //   a subsequent argument that does not start with '-' itself.
331



9552
      while ((it = aliases_.find(name)) != aliases_.end() ||
332

222
             (equals_index != std::string::npos &&
333




9714
              (it = aliases_.find(name + '=')) != aliases_.end()) ||
334

3460
             (!args.empty() &&
335

3337
                 !args.first().empty() &&
336

2864
                 args.first()[0] != '-' &&
337

3548
              (it = aliases_.find(name + " <arg>")) != aliases_.end())) {
338
1296
        const std::string prev_name = std::move(name);
339
649
        const std::vector<std::string>& expansion = it->second;
340
341
        // Use the first entry in the expansion as the new 'name'.
342
649
        name = expansion.front();
343
344

649
        if (expansion.size() > 1) {
345
          // The other arguments, if any, are going to be handled later.
346
606
          args.synthetic_args.insert(
347
404
              args.synthetic_args.begin(),
348
404
              expansion.begin() + 1,
349
              expansion.end());
350
        }
351
352



649
        if (name == prev_name) break;
353
      }
354
    }
355
356
1704
    auto it = options_.find(name);
357
358



4986
    if ((it == options_.end() ||
359



2750
         it->second.env_setting == kDisallowedInEnvironment) &&
360
        required_env_settings == kAllowedInEnvironment) {
361
14
      errors->push_back(NotAllowedInEnvErr(original_name));
362
14
      break;
363
    }
364
365

1690
    if (it == options_.end()) {
366
126
      v8_args->push_back(arg);
367
126
      continue;
368
    }
369
370
    {
371
1564
      auto implications = implications_.equal_range(name);
372

1906
      for (auto it = implications.first; it != implications.second; ++it) {
373
684
        *it->second.target_field->template Lookup<bool>(options) =
374
342
            it->second.target_value;
375
      }
376
    }
377
378
1564
    const OptionInfo& info = it->second;
379


3121
    std::string value;
380




1564
    if (info.type != kBoolean && info.type != kNoOp && info.type != kV8Option) {
381

701
      if (equals_index != std::string::npos) {
382
150
        value = arg.substr(equals_index + 1);
383

150
        if (value.empty()) {
384
        missing_argument:
385
7
          errors->push_back(RequiresArgumentErr(original_name));
386
7
          break;
387
        }
388
      } else {
389

551
        if (args.empty())
390
5
          goto missing_argument;
391
392
546
        value = args.pop_first();
393
394




546
        if (!value.empty() && value[0] == '-') {
395
          goto missing_argument;
396
        } else {
397






546
          if (!value.empty() && value[0] == '\\' && value[1] == '-')
398
1
            value = value.substr(1);  // Treat \- as escaping an -.
399
        }
400
      }
401
    }
402
403






1557
    switch (info.type) {
404
      case kBoolean:
405
825
        *Lookup<bool>(info.field, options) = true;
406
825
        break;
407
      case kInteger:
408
1
        *Lookup<int64_t>(info.field, options) = std::atoll(value.c_str());
409
1
        break;
410
      case kUInteger:
411
23
        *Lookup<uint64_t>(info.field, options) = std::stoull(value);
412
23
        break;
413
      case kString:
414
532
        *Lookup<std::string>(info.field, options) = value;
415
532
        break;
416
      case kStringList:
417
40
        Lookup<std::vector<std::string>>(info.field, options)
418
40
            ->emplace_back(std::move(value));
419
40
        break;
420
      case kHostPort:
421
98
        Lookup<HostPort>(info.field, options)
422
            ->Update(SplitHostPort(value, errors));
423
98
        break;
424
      case kNoOp:
425
        break;
426
      case kV8Option:
427
38
        v8_args->push_back(arg);
428

38
        break;
429
      default:
430
        UNREACHABLE();
431
    }
432
  }
433
8316
  options->CheckOptions(errors);
434
8316
}
435
436
}  // namespace options_parser
437
}  // namespace node
438
439
#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
440
441
#endif  // SRC_NODE_OPTIONS_INL_H_