Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #include <common/args.h>
7 : :
8 : : #include <chainparamsbase.h>
9 : : #include <common/settings.h>
10 : : #include <sync.h>
11 : : #include <tinyformat.h>
12 : : #include <univalue.h>
13 : : #include <util/chaintype.h>
14 : : #include <util/check.h>
15 : : #include <util/fs.h>
16 : : #include <util/fs_helpers.h>
17 : : #include <util/log.h>
18 : : #include <util/strencodings.h>
19 : : #include <util/string.h>
20 : :
21 : : #ifdef WIN32
22 : : #include <shlobj.h>
23 : : #endif
24 : :
25 : : #include <algorithm>
26 : : #include <cassert>
27 : : #include <cstdint>
28 : : #include <cstdlib>
29 : : #include <cstring>
30 : : #include <map>
31 : : #include <optional>
32 : : #include <stdexcept>
33 : : #include <string>
34 : : #include <utility>
35 : : #include <variant>
36 : :
37 : : const char * const BITCOIN_CONF_FILENAME = "bitcoin.conf";
38 : : const char * const BITCOIN_SETTINGS_FILENAME = "settings.json";
39 : :
40 : : ArgsManager gArgs;
41 : :
42 : : /**
43 : : * Interpret a string argument as a boolean.
44 : : *
45 : : * The definition of LocaleIndependentAtoi<int>() requires that non-numeric string values
46 : : * like "foo", return 0. This means that if a user unintentionally supplies a
47 : : * non-integer argument here, the return value is always false. This means that
48 : : * -foo=false does what the user probably expects, but -foo=true is well defined
49 : : * but does not do what they probably expected.
50 : : *
51 : : * The return value of LocaleIndependentAtoi<int>(...) is zero when given input not
52 : : * representable as an int.
53 : : *
54 : : * For a more extensive discussion of this topic (and a wide range of opinions
55 : : * on the Right Way to change this code), see PR12713.
56 : : */
57 : 8397 : static bool InterpretBool(const std::string& strValue)
58 : : {
59 [ + + ]: 8397 : if (strValue.empty())
60 : : return true;
61 [ - + ]: 3934 : return (LocaleIndependentAtoi<int>(strValue) != 0);
62 : : }
63 : :
64 : 1431058 : static std::string SettingName(const std::string& arg)
65 : : {
66 [ - + + + : 1458534 : return arg.size() > 0 && arg[0] == '-' ? arg.substr(1) : arg;
+ + ]
67 : : }
68 : :
69 : : /**
70 : : * Parse "name", "section.name", "noname", "section.noname" settings keys.
71 : : *
72 : : * @note Where an option was negated can be later checked using the
73 : : * IsArgNegated() method. One use case for this is to have a way to disable
74 : : * options that are not normally boolean (e.g. using -nodebuglogfile to request
75 : : * that debug log output is not sent to any file at all).
76 : : */
77 : 17509 : KeyInfo InterpretKey(std::string key)
78 : : {
79 [ + + ]: 17509 : KeyInfo result;
80 : : // Split section name from key name for keys like "testnet.foo" or "regtest.bar"
81 : 17509 : size_t option_index = key.find('.');
82 [ + + ]: 17509 : if (option_index != std::string::npos) {
83 [ + - ]: 1484 : result.section = key.substr(0, option_index);
84 [ + - ]: 1484 : key.erase(0, option_index + 1);
85 : : }
86 [ - + + + ]: 17509 : if (key.starts_with("no")) {
87 [ + - ]: 2745 : key.erase(0, 2);
88 : 2745 : result.negated = true;
89 : : }
90 [ + - ]: 17509 : result.name = key;
91 : 17509 : return result;
92 : 0 : }
93 : :
94 : : /**
95 : : * Interpret settings value based on registered flags.
96 : : *
97 : : * @param[in] key key information to know if key was negated
98 : : * @param[in] value string value of setting to be parsed
99 : : * @param[in] flags ArgsManager registered argument flags
100 : : * @param[out] error Error description if settings value is not valid
101 : : *
102 : : * @return parsed settings value if it is valid, otherwise nullopt accompanied
103 : : * by a descriptive error string
104 : : */
105 : 16622 : std::optional<common::SettingsValue> InterpretValue(const KeyInfo& key, const std::string* value,
106 : : unsigned int flags, std::string& error)
107 : : {
108 : : // Return negated settings as false values.
109 [ + + ]: 16622 : if (key.negated) {
110 [ - + ]: 2470 : if (flags & ArgsManager::DISALLOW_NEGATION) {
111 : 0 : error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name);
112 : 0 : return std::nullopt;
113 : : }
114 : : // Double negatives like -nofoo=0 are supported (but discouraged)
115 [ + + + + ]: 2470 : if (value && !InterpretBool(*value)) {
116 : 1617 : LogWarning("Parsed potentially confusing double-negative -%s=%s", key.name, *value);
117 : 1617 : return true;
118 : : }
119 : 853 : return false;
120 : : }
121 [ + + + + ]: 14152 : if (!value && (flags & ArgsManager::DISALLOW_ELISION)) {
122 : 21 : error = strprintf("Can not set -%s with no value. Please specify value with -%s=value.", key.name, key.name);
123 : 21 : return std::nullopt;
124 : : }
125 [ + - ]: 14131 : return value ? *value : "";
126 : : }
127 : :
128 : : // Define default constructor and destructor that are not inline, so code instantiating this class doesn't need to
129 : : // #include class definitions for all members.
130 : : // For example, m_settings has an internal dependency on univalue.
131 : 2518 : ArgsManager::ArgsManager() = default;
132 [ - + ]: 12590 : ArgsManager::~ArgsManager() = default;
133 : :
134 : 2282 : std::set<std::string> ArgsManager::GetUnsuitableSectionOnlyArgs() const
135 : : {
136 [ + - ]: 2282 : std::set<std::string> unsuitables;
137 : :
138 [ + - ]: 2282 : LOCK(cs_args);
139 : :
140 : : // if there's no section selected, don't worry
141 [ + + ]: 2282 : if (m_network.empty()) return std::set<std::string> {};
142 : :
143 : : // if it's okay to use the default section for this network, don't worry
144 [ + - + + ]: 1772 : if (m_network == ChainTypeToString(ChainType::MAIN)) return std::set<std::string> {};
145 : :
146 [ + + ]: 14406 : for (const auto& arg : m_network_only_args) {
147 [ + - + - : 12641 : if (OnlyHasDefaultSectionSetting(m_settings, m_network, SettingName(arg))) {
- + ]
148 [ # # ]: 0 : unsuitables.insert(arg);
149 : : }
150 : : }
151 : 1765 : return unsuitables;
152 : 2282 : }
153 : :
154 : 2282 : std::list<SectionInfo> ArgsManager::GetUnrecognizedSections() const
155 : : {
156 : : // Section names to be recognized in the config file.
157 : 2282 : static const std::set<std::string> available_sections{
158 : : ChainTypeToString(ChainType::REGTEST),
159 : : ChainTypeToString(ChainType::SIGNET),
160 : : ChainTypeToString(ChainType::TESTNET),
161 : : ChainTypeToString(ChainType::TESTNET4),
162 : : ChainTypeToString(ChainType::MAIN),
163 [ + + + - : 2834 : };
- + + + -
- ]
164 : :
165 : 2282 : LOCK(cs_args);
166 [ + - ]: 2282 : std::list<SectionInfo> unrecognized = m_config_sections;
167 : 2282 : unrecognized.remove_if([](const SectionInfo& appeared){ return available_sections.contains(appeared.m_name); });
168 [ + - ]: 2282 : return unrecognized;
169 [ + - + - : 2374 : }
+ - + - +
- - - ]
170 : :
171 : 55061 : void ArgsManager::SelectConfigNetwork(const std::string& network)
172 : : {
173 : 55061 : LOCK(cs_args);
174 [ + - + - ]: 110122 : m_network = network;
175 : 55061 : }
176 : :
177 : 10254 : bool ArgsManager::ParseParameters(int argc, const char* const argv[], std::string& error)
178 : : {
179 : 10254 : LOCK(cs_args);
180 : 10254 : m_settings.command_line_options.clear();
181 : :
182 [ + + ]: 26855 : for (int i = 1; i < argc; i++) {
183 [ + - ]: 24432 : std::string key(argv[i]);
184 : :
185 : : #ifdef __APPLE__
186 : : // At the first time when a user gets the "App downloaded from the
187 : : // internet" warning, and clicks the Open button, macOS passes
188 : : // a unique process serial number (PSN) as -psn_... command-line
189 : : // argument, which we filter out.
190 : : if (key.starts_with("-psn_")) continue;
191 : : #endif
192 : :
193 [ + + ]: 24432 : if (key == "-") break; //bitcoin-tx using stdin
194 : 24353 : std::optional<std::string> val;
195 : 24353 : size_t is_index = key.find('=');
196 [ + + ]: 24353 : if (is_index != std::string::npos) {
197 [ + - ]: 9992 : val = key.substr(is_index + 1);
198 [ + - ]: 9992 : key.erase(is_index);
199 : : }
200 : : #ifdef WIN32
201 : : key = ToLower(key);
202 : : if (key[0] == '/')
203 : : key[0] = '-';
204 : : #endif
205 : :
206 [ + + ]: 24353 : if (key[0] != '-') {
207 [ + + + + ]: 6844 : if (!m_accept_any_command && m_command.empty()) {
208 : : // The first non-dash arg is a registered command
209 [ + - ]: 278 : std::optional<unsigned int> flags = GetArgFlags_(key);
210 [ + + + + ]: 278 : if (!flags || !(*flags & ArgsManager::COMMAND)) {
211 [ + - ]: 276 : error = strprintf("Invalid command '%s'", argv[i]);
212 : 276 : return false;
213 : : }
214 : : }
215 [ + - ]: 6568 : m_command.push_back(key);
216 [ + + ]: 22129 : while (++i < argc) {
217 : : // The remaining args are command args
218 [ + - ]: 15561 : m_command.emplace_back(argv[i]);
219 : : }
220 : 6568 : break;
221 : : }
222 : :
223 : : // Transform --foo to -foo
224 [ - + + + : 17509 : if (key.length() > 1 && key[1] == '-')
+ + ]
225 [ + - ]: 107 : key.erase(0, 1);
226 : :
227 : : // Transform -foo to foo
228 [ + - ]: 17509 : key.erase(0, 1);
229 [ - + + - ]: 35018 : KeyInfo keyinfo = InterpretKey(key);
230 [ + - + - ]: 17509 : std::optional<unsigned int> flags = GetArgFlags_('-' + keyinfo.name);
231 : :
232 : : // Unknown command line options and command line options with dot
233 : : // characters (which are returned from InterpretKey with nonempty
234 : : // section strings) are not valid.
235 [ + + + + ]: 17509 : if (!flags || !keyinfo.section.empty()) {
236 [ + - ]: 887 : error = strprintf("Invalid parameter %s", argv[i]);
237 : 887 : return false;
238 : : }
239 : :
240 [ + + + - ]: 23973 : std::optional<common::SettingsValue> value = InterpretValue(keyinfo, val ? &*val : nullptr, *flags, error);
241 [ + + ]: 16622 : if (!value) return false;
242 : :
243 [ + - + - ]: 16601 : m_settings.command_line_options[keyinfo.name].push_back(*value);
244 : 48530 : }
245 : :
246 : : // we do not allow -includeconf from command line, only -noincludeconf
247 [ + - + + ]: 9070 : if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
248 : 74 : const common::SettingsSpan values{*includes};
249 : : // Range may be empty if -noincludeconf was passed
250 [ + - + + ]: 74 : if (!values.empty()) {
251 [ + - + - : 73 : error = "-includeconf cannot be used from commandline; -includeconf=" + values.begin()->write();
+ - ]
252 : 73 : return false; // pick first value as example
253 : : }
254 : : }
255 : : return true;
256 : 10254 : }
257 : :
258 : 61091 : std::optional<unsigned int> ArgsManager::GetArgFlags_(const std::string& name) const
259 : : {
260 : 61091 : AssertLockHeld(cs_args);
261 [ + + ]: 167662 : for (const auto& arg_map : m_available_args) {
262 : 155616 : const auto search = arg_map.second.find(name);
263 [ + + ]: 155616 : if (search != arg_map.second.end()) {
264 : 49045 : return search->second.m_flags;
265 : : }
266 : : }
267 : 12046 : return m_default_flags;
268 : : }
269 : :
270 : 43304 : std::optional<unsigned int> ArgsManager::GetArgFlags(const std::string& name) const
271 : : {
272 : 43304 : LOCK(cs_args);
273 [ + - ]: 43304 : return GetArgFlags_(name);
274 : 43304 : }
275 : :
276 : 0 : void ArgsManager::SetDefaultFlags(std::optional<unsigned int> flags)
277 : : {
278 : 0 : LOCK(cs_args);
279 [ # # ]: 0 : m_default_flags = flags;
280 : 0 : }
281 : :
282 : 7187 : fs::path ArgsManager::GetPathArg_(std::string arg, const fs::path& default_value) const
283 : : {
284 : 7187 : AssertLockHeld(cs_args);
285 : 7187 : const auto value = GetSetting_(arg);
286 [ + + ]: 7187 : if (value.isFalse()) return {};
287 [ + - + - ]: 7094 : std::string path_str = SettingToString(value, "");
288 [ + + + - ]: 12818 : if (path_str.empty()) return default_value;
289 [ + - + - ]: 17172 : fs::path result = fs::PathFromString(path_str).lexically_normal();
290 : : // Remove trailing slash, if present.
291 [ + - + - : 17172 : return result.has_filename() ? result : result.parent_path();
- - ]
292 : 12911 : }
293 : :
294 : 1463 : fs::path ArgsManager::GetPathArg(std::string arg, const fs::path& default_value) const
295 : : {
296 : 1463 : LOCK(cs_args);
297 [ + - + - ]: 2926 : return GetPathArg_(std::move(arg), default_value);
298 : 1463 : }
299 : :
300 : 6137 : fs::path ArgsManager::GetBlocksDirPath() const
301 : : {
302 : 6137 : LOCK(cs_args);
303 : 6137 : fs::path& path = m_cached_blocks_path;
304 : :
305 : : // Cache the path to avoid calling fs::create_directories on every call of
306 : : // this function
307 [ + + + - ]: 6137 : if (!path.empty()) return path;
308 : :
309 [ + - + - : 2862 : if (!GetSetting_("-blocksdir").isNull()) {
- + ]
310 [ # # # # : 0 : path = fs::absolute(GetPathArg_("-blocksdir"));
# # ]
311 [ # # # # ]: 0 : if (!fs::is_directory(path)) {
312 [ # # ]: 0 : path = "";
313 [ # # ]: 0 : return path;
314 : : }
315 : : } else {
316 [ + - ]: 8586 : path = GetDataDir(/*net_specific=*/false);
317 : : }
318 : :
319 [ + - + - ]: 5724 : path /= fs::PathFromString(BaseParams().DataDir());
320 [ + - ]: 2862 : path /= "blocks";
321 [ + - ]: 2862 : fs::create_directories(path);
322 [ + - + - ]: 6137 : return path;
323 : 6137 : }
324 : :
325 : 25 : fs::path ArgsManager::GetDataDirBase() const {
326 : 25 : LOCK(cs_args);
327 [ + - ]: 25 : return GetDataDir(/*net_specific=*/false);
328 : 25 : }
329 : :
330 : 39502 : fs::path ArgsManager::GetDataDirNet() const {
331 : 39502 : LOCK(cs_args);
332 [ + - ]: 39502 : return GetDataDir(/*net_specific=*/true);
333 : 39502 : }
334 : :
335 : 42389 : fs::path ArgsManager::GetDataDir(bool net_specific) const
336 : : {
337 : 42389 : AssertLockHeld(cs_args);
338 [ + + ]: 42389 : fs::path& path = net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
339 : :
340 : : // Used cached path if available
341 [ + + ]: 42389 : if (!path.empty()) return path;
342 : :
343 [ + - + - ]: 11448 : const fs::path datadir{GetPathArg_("-datadir")};
344 [ + - ]: 5724 : if (!datadir.empty()) {
345 [ + - ]: 11448 : path = fs::absolute(datadir);
346 [ + - - + ]: 5724 : if (!fs::is_directory(path)) {
347 [ # # ]: 0 : path = "";
348 [ # # ]: 0 : return path;
349 : : }
350 : : } else {
351 [ # # ]: 0 : path = GetDefaultDataDir();
352 : : }
353 : :
354 [ + + + - : 5724 : if (net_specific && !BaseParams().DataDir().empty()) {
+ + ]
355 [ + - + - ]: 8565 : path /= fs::PathFromString(BaseParams().DataDir());
356 : : }
357 : :
358 [ + - ]: 5724 : return path;
359 : 5724 : }
360 : :
361 : 1463 : void ArgsManager::ClearPathCache()
362 : : {
363 : 1463 : LOCK(cs_args);
364 : :
365 : 1463 : m_cached_datadir_path = fs::path();
366 : 1463 : m_cached_network_datadir_path = fs::path();
367 [ + - ]: 2926 : m_cached_blocks_path = fs::path();
368 : 1463 : }
369 : :
370 : 819 : std::optional<const ArgsManager::Command> ArgsManager::GetCommand() const
371 : : {
372 [ + - ]: 819 : Command ret;
373 [ + - ]: 819 : LOCK(cs_args);
374 [ + + ]: 819 : auto it = m_command.begin();
375 [ + + ]: 819 : if (it == m_command.end()) {
376 : : // No command was passed
377 : 597 : return std::nullopt;
378 : : }
379 [ + + ]: 222 : if (!m_accept_any_command) {
380 : : // The registered command
381 [ + - ]: 44 : ret.command = *(it++);
382 : : }
383 [ + + ]: 22307 : while (it != m_command.end()) {
384 : : // The unregistered command and args (if any)
385 [ + - ]: 22085 : ret.args.push_back(*(it++));
386 : : }
387 : 222 : return ret;
388 : 1638 : }
389 : :
390 : 222 : bool ArgsManager::CheckCommandOptions(const std::string& command, std::vector<std::string>* errors) const
391 : : {
392 : 222 : LOCK(cs_args);
393 : :
394 : 222 : auto command_options = m_available_args.find(OptionsCategory::COMMAND_OPTIONS);
395 [ + + ]: 222 : if (command_options == m_available_args.end()) {
396 : : // There are no command-specific options at all, so everything is fine
397 : : return true;
398 : : }
399 : :
400 : 3 : const auto command_args = m_command_args.find(command);
401 : 4 : auto is_valid_opt = [&](const auto& opt) EXCLUSIVE_LOCKS_REQUIRED(cs_args) -> bool {
402 [ - + ]: 1 : if (command_args == m_command_args.end()) {
403 : : // Caller may not have checked that command actually exists
404 : : // before calling this function. In that case, treat it as
405 : : // having no valid command-specific options.
406 : : return false;
407 : : } else {
408 : 0 : return command_args->second.contains(opt);
409 : : }
410 : 3 : };
411 : :
412 : 3 : bool ok = true;
413 [ + - + + ]: 8 : for (const auto& [arg, _] : command_options->second) {
414 [ + - + + : 5 : if (!GetSetting_(arg).isNull() && !is_valid_opt(arg)) {
- + + + ]
415 : 1 : ok = false;
416 [ - + ]: 1 : if (errors != nullptr) {
417 [ # # # # ]: 0 : errors->emplace_back(strprintf("The %s option cannot be used with the '%s' command.", arg, command));
418 : : }
419 : : }
420 : : }
421 : : return ok;
422 : 222 : }
423 : :
424 : 281415 : std::vector<std::string> ArgsManager::GetArgs(const std::string& strArg) const
425 : : {
426 : 281415 : std::vector<std::string> result;
427 [ + - + + ]: 288827 : for (const common::SettingsValue& value : GetSettingsList(strArg)) {
428 [ - + - - : 22235 : result.push_back(value.isFalse() ? "0" : value.isTrue() ? "1" : value.get_str());
+ + + - +
- - + +
- ]
429 : : }
430 : 281415 : return result;
431 : 0 : }
432 : :
433 : 16057 : bool ArgsManager::IsArgSet(const std::string& strArg) const
434 : : {
435 : 16057 : return !GetSetting(strArg).isNull();
436 : : }
437 : :
438 : 0 : bool ArgsManager::GetSettingsPath(fs::path* filepath, bool temp, bool backup) const
439 : : {
440 [ # # # # ]: 0 : fs::path settings = GetPathArg("-settings", BITCOIN_SETTINGS_FILENAME);
441 [ # # ]: 0 : if (settings.empty()) {
442 : : return false;
443 : : }
444 [ # # ]: 0 : if (backup) {
445 [ # # ]: 0 : settings += ".bak";
446 : : }
447 [ # # ]: 0 : if (filepath) {
448 [ # # # # : 0 : *filepath = fsbridge::AbsPathJoin(GetDataDirNet(), temp ? settings + ".tmp" : settings);
# # # # #
# # # ]
449 : : }
450 : : return true;
451 : 0 : }
452 : :
453 : 0 : static void SaveErrors(const std::vector<std::string> errors, std::vector<std::string>* error_out)
454 : : {
455 [ # # ]: 0 : for (const auto& error : errors) {
456 [ # # ]: 0 : if (error_out) {
457 : 0 : error_out->emplace_back(error);
458 : : } else {
459 : 0 : LogWarning("%s", error);
460 : : }
461 : : }
462 : 0 : }
463 : :
464 : 0 : bool ArgsManager::ReadSettingsFile(std::vector<std::string>* errors)
465 : : {
466 : 0 : fs::path path;
467 [ # # # # ]: 0 : if (!GetSettingsPath(&path, /* temp= */ false)) {
468 : : return true; // Do nothing if settings file disabled.
469 : : }
470 : :
471 [ # # ]: 0 : LOCK(cs_args);
472 : 0 : m_settings.rw_settings.clear();
473 : 0 : std::vector<std::string> read_errors;
474 [ # # # # ]: 0 : if (!common::ReadSettings(path, m_settings.rw_settings, read_errors)) {
475 [ # # # # ]: 0 : SaveErrors(read_errors, errors);
476 : 0 : return false;
477 : : }
478 [ # # ]: 0 : for (const auto& setting : m_settings.rw_settings) {
479 [ # # # # ]: 0 : KeyInfo key = InterpretKey(setting.first); // Split setting key into section and argname
480 [ # # # # : 0 : if (!GetArgFlags_('-' + key.name)) {
# # ]
481 [ # # ]: 0 : LogWarning("Ignoring unknown rw_settings value %s", setting.first);
482 : : }
483 : 0 : }
484 : : return true;
485 [ # # ]: 0 : }
486 : :
487 : 0 : bool ArgsManager::WriteSettingsFile(std::vector<std::string>* errors, bool backup) const
488 : : {
489 : 0 : fs::path path, path_tmp;
490 [ # # # # : 0 : if (!GetSettingsPath(&path, /*temp=*/false, backup) || !GetSettingsPath(&path_tmp, /*temp=*/true, backup)) {
# # # # ]
491 [ # # ]: 0 : throw std::logic_error("Attempt to write settings file when dynamic settings are disabled.");
492 : : }
493 : :
494 [ # # ]: 0 : LOCK(cs_args);
495 : 0 : std::vector<std::string> write_errors;
496 [ # # # # ]: 0 : if (!common::WriteSettings(path_tmp, m_settings.rw_settings, write_errors)) {
497 [ # # # # ]: 0 : SaveErrors(write_errors, errors);
498 : 0 : return false;
499 : : }
500 [ # # # # : 0 : if (!RenameOver(path_tmp, path)) {
# # # # ]
501 [ # # # # : 0 : SaveErrors({strprintf("Failed renaming settings file %s to %s\n", fs::PathToString(path_tmp), fs::PathToString(path))}, errors);
# # # # #
# ]
502 : 0 : return false;
503 : : }
504 : : return true;
505 [ # # # # : 0 : }
# # ]
506 : :
507 : 0 : common::SettingsValue ArgsManager::GetPersistentSetting(const std::string& name) const
508 : : {
509 : 0 : LOCK(cs_args);
510 [ # # # # : 0 : return common::GetSetting(m_settings, m_network, name, !UseDefaultSection("-" + name),
# # ]
511 [ # # ]: 0 : /*ignore_nonpersistent=*/true, /*get_chain_type=*/false);
512 : 0 : }
513 : :
514 : 2282 : bool ArgsManager::IsArgNegated(const std::string& strArg) const
515 : : {
516 : 2282 : return GetSetting(strArg).isFalse();
517 : : }
518 : :
519 : 21664 : std::string ArgsManager::GetArg(const std::string& strArg, const std::string& strDefault) const
520 : : {
521 [ + - ]: 43328 : return GetArg(strArg).value_or(strDefault);
522 : : }
523 : :
524 : 108709 : std::optional<std::string> ArgsManager::GetArg(const std::string& strArg) const
525 : : {
526 : 108709 : const common::SettingsValue value = GetSetting(strArg);
527 [ + - ]: 217418 : return SettingToString(value);
528 : 108709 : }
529 : :
530 : 115803 : std::optional<std::string> SettingToString(const common::SettingsValue& value)
531 : : {
532 [ + + ]: 115803 : if (value.isNull()) return std::nullopt;
533 [ + + ]: 5982 : if (value.isFalse()) return "0";
534 [ + + ]: 5981 : if (value.isTrue()) return "1";
535 [ - + - - ]: 5980 : if (value.isNum()) return value.getValStr();
536 [ - + ]: 11960 : return value.get_str();
537 : : }
538 : :
539 : 7094 : std::string SettingToString(const common::SettingsValue& value, const std::string& strDefault)
540 : : {
541 [ + - ]: 14188 : return SettingToString(value).value_or(strDefault);
542 : : }
543 : :
544 : : template <std::integral Int>
545 : 648938 : Int ArgsManager::GetArg(const std::string& strArg, Int nDefault) const
546 : : {
547 [ + + ]: 648938 : return GetArg<Int>(strArg).value_or(nDefault);
548 : : }
549 : :
550 : : template <std::integral Int>
551 : 742466 : std::optional<Int> ArgsManager::GetArg(const std::string& strArg) const
552 : : {
553 : 742466 : const common::SettingsValue value = GetSetting(strArg);
554 [ + - ]: 1484932 : return SettingTo<Int>(value);
555 : 742466 : }
556 : :
557 : : template <std::integral Int>
558 [ + + ]: 742466 : std::optional<Int> SettingTo(const common::SettingsValue& value)
559 : : {
560 [ + + ]: 742466 : if (value.isNull()) return std::nullopt;
561 [ + + ]: 40935 : if (value.isFalse()) return 0;
562 [ + + ]: 40934 : if (value.isTrue()) return 1;
563 [ - + ]: 40933 : if (value.isNum()) return value.getInt<Int>();
564 [ - + ]: 40933 : return LocaleIndependentAtoi<Int>(value.get_str());
565 : : }
566 : :
567 : : template <std::integral Int>
568 : 0 : Int SettingTo(const common::SettingsValue& value, Int nDefault)
569 : : {
570 [ # # ]: 0 : return SettingTo<Int>(value).value_or(nDefault);
571 : : }
572 : :
573 : 153907 : bool ArgsManager::GetBoolArg(const std::string& strArg, bool fDefault) const
574 : : {
575 [ + + ]: 153907 : return GetBoolArg(strArg).value_or(fDefault);
576 : : }
577 : :
578 : 164287 : std::optional<bool> ArgsManager::GetBoolArg(const std::string& strArg) const
579 : : {
580 : 164287 : const common::SettingsValue value = GetSetting(strArg);
581 [ + - ]: 328574 : return SettingToBool(value);
582 : 164287 : }
583 : :
584 : 164287 : std::optional<bool> SettingToBool(const common::SettingsValue& value)
585 : : {
586 [ + + ]: 164287 : if (value.isNull()) return std::nullopt;
587 [ + + ]: 6596 : if (value.isBool()) return value.get_bool();
588 : 6594 : return InterpretBool(value.get_str());
589 : : }
590 : :
591 : 0 : bool SettingToBool(const common::SettingsValue& value, bool fDefault)
592 : : {
593 [ # # ]: 0 : return SettingToBool(value).value_or(fDefault);
594 : : }
595 : :
596 : : #define INSTANTIATE_INT_TYPE(Type) \
597 : : template Type ArgsManager::GetArg<Type>(const std::string&, Type) const; \
598 : : template std::optional<Type> ArgsManager::GetArg<Type>(const std::string&) const; \
599 : : template Type SettingTo<Type>(const common::SettingsValue&, Type); \
600 : : template std::optional<Type> SettingTo<Type>(const common::SettingsValue&)
601 : :
602 : : INSTANTIATE_INT_TYPE(int8_t);
603 : : INSTANTIATE_INT_TYPE(uint8_t);
604 : : INSTANTIATE_INT_TYPE(int16_t);
605 : : INSTANTIATE_INT_TYPE(uint16_t);
606 : : INSTANTIATE_INT_TYPE(int32_t);
607 : : INSTANTIATE_INT_TYPE(uint32_t);
608 : : INSTANTIATE_INT_TYPE(int64_t);
609 : : INSTANTIATE_INT_TYPE(uint64_t);
610 : :
611 : : #undef INSTANTIATE_INT_TYPE
612 : :
613 : 19523 : bool ArgsManager::SoftSetArg(const std::string& strArg, const std::string& strValue)
614 : : {
615 : 19523 : LOCK(cs_args);
616 [ + - + + ]: 19523 : if (!GetSetting_(strArg).isNull()) return false;
617 [ + - + - : 7012 : m_settings.forced_settings[SettingName(strArg)] = strValue;
+ - ]
618 : 7012 : return true;
619 : 19523 : }
620 : :
621 : 14279 : bool ArgsManager::SoftSetBoolArg(const std::string& strArg, bool fValue)
622 : : {
623 [ + + ]: 14279 : if (fValue)
624 [ + - ]: 14149 : return SoftSetArg(strArg, std::string("1"));
625 : : else
626 [ + - ]: 130 : return SoftSetArg(strArg, std::string("0"));
627 : : }
628 : :
629 : 57484 : void ArgsManager::ForceSetArg(const std::string& strArg, const std::string& strValue)
630 : : {
631 : 57484 : LOCK(cs_args);
632 [ + - + - : 57484 : m_settings.forced_settings[SettingName(strArg)] = strValue;
+ - + - ]
633 : 57484 : }
634 : :
635 : 2893 : void ArgsManager::AddCommand(const std::string& cmd, const std::string& help, std::set<std::string> options)
636 : : {
637 [ - + ]: 2893 : Assert(cmd.find('=') == std::string::npos);
638 [ - + ]: 2893 : Assert(cmd.at(0) != '-');
639 : :
640 : 2893 : LOCK(cs_args);
641 : 2893 : m_accept_any_command = false; // latch to false
642 [ + - ]: 2893 : std::map<std::string, Arg>& arg_map = m_available_args[OptionsCategory::COMMANDS];
643 [ + - - + : 5786 : auto ret = arg_map.emplace(cmd, Arg{"", help, ArgsManager::COMMAND});
+ - ]
644 [ + + ]: 2893 : if (!options.empty()) {
645 [ + - ]: 2 : auto& cmdopts = m_available_args[OptionsCategory::COMMAND_OPTIONS];
646 : 2 : bool command_has_all_options_defined = true;
647 [ + + ]: 4 : for (const auto& opt : options) {
648 [ - + ]: 2 : if (!cmdopts.contains(opt)) {
649 : 0 : command_has_all_options_defined = false;
650 : : }
651 : : }
652 [ - + ]: 2 : Assert(command_has_all_options_defined);
653 : :
654 [ + - ]: 2 : m_command_args.try_emplace(cmd, std::move(options));
655 : : }
656 [ - + + - ]: 2893 : Assert(ret.second); // Fail on duplicate commands
657 : 2893 : }
658 : :
659 : 291179 : void ArgsManager::AddArg(const std::string& name, const std::string& help, unsigned int flags, const OptionsCategory& cat)
660 : : {
661 [ - + ]: 291179 : Assert((flags & ArgsManager::COMMAND) == 0); // use AddCommand
662 : :
663 : : // Split arg name from its help param
664 : 291179 : size_t eq_index = name.find('=');
665 [ + + ]: 291179 : if (eq_index == std::string::npos) {
666 [ - + ]: 139027 : eq_index = name.size();
667 : : }
668 : 291179 : std::string arg_name = name.substr(0, eq_index);
669 : :
670 [ + - ]: 291179 : LOCK(cs_args);
671 : :
672 : : // Allow duplicates involving HIDDEN — it is used as a placeholder for args
673 : : // unavailable in this binary but tolerated for shared config files (see #13441).
674 [ + + ]: 1906096 : for (const auto& arg_map : m_available_args) {
675 [ + + + + ]: 1614917 : if (arg_map.first == OptionsCategory::HIDDEN || cat == OptionsCategory::HIDDEN) continue;
676 [ - + ]: 1614917 : Assert(!arg_map.second.contains(arg_name));
677 : : }
678 : :
679 [ + - ]: 291179 : std::map<std::string, Arg>& arg_map = m_available_args[cat];
680 [ - + + - : 582358 : auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags});
- + + - ]
681 [ - + ]: 291179 : assert(ret.second); // Make sure an insertion actually happened
682 : :
683 [ + + ]: 291179 : if (flags & ArgsManager::NETWORK_ONLY) {
684 [ + - ]: 14234 : m_network_only_args.emplace(arg_name);
685 : : }
686 : 291179 : }
687 : :
688 : 15400 : void ArgsManager::AddHiddenArgs(const std::vector<std::string>& names)
689 : : {
690 [ + + ]: 50181 : for (const std::string& name : names) {
691 [ + - ]: 69562 : AddArg(name, "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
692 : : }
693 : 15400 : }
694 : :
695 : 2835 : void ArgsManager::ClearArgs()
696 : : {
697 : 2835 : LOCK(cs_args);
698 : 2835 : m_settings = {};
699 : 2835 : m_available_args.clear();
700 : 2835 : m_command_args.clear();
701 : 2835 : m_network_only_args.clear();
702 [ + - ]: 2835 : m_config_sections.clear();
703 : 2835 : }
704 : :
705 : 0 : void ArgsManager::CheckMultipleCLIArgs() const
706 : : {
707 : 0 : LOCK(cs_args);
708 : 0 : std::vector<std::string> found{};
709 : 0 : auto cmds = m_available_args.find(OptionsCategory::CLI_COMMANDS);
710 [ # # ]: 0 : if (cmds != m_available_args.end()) {
711 [ # # # # ]: 0 : for (const auto& [cmd, argspec] : cmds->second) {
712 [ # # # # ]: 0 : if (!GetSetting_(cmd).isNull()) {
713 [ # # ]: 0 : found.push_back(cmd);
714 : : }
715 : : }
716 [ # # # # ]: 0 : if (found.size() > 1) {
717 [ # # # # : 0 : throw std::runtime_error(strprintf("Only one of %s may be specified.", util::Join(found, ", ")));
# # ]
718 : : }
719 : : }
720 [ # # ]: 0 : }
721 : :
722 : 819 : std::string ArgsManager::GetHelpMessage() const
723 : : {
724 [ + - ]: 819 : const bool show_debug = GetBoolArg("-help-debug", false);
725 : :
726 [ + - ]: 819 : std::string usage;
727 [ + - ]: 819 : LOCK(cs_args);
728 : :
729 : 819 : const auto command_options = m_available_args.find(OptionsCategory::COMMAND_OPTIONS);
730 [ + - ]: 2 : const auto for_matching_cmd_opts = [&](const std::set<std::string>& select, auto&& fn) EXCLUSIVE_LOCKS_REQUIRED(cs_args) {
731 [ + - ]: 2 : if (select.empty()) return;
732 [ + - ]: 2 : if (command_options == m_available_args.end()) return;
733 [ + - + + ]: 4 : for (const auto& [name, info] : command_options->second) {
734 [ + - + - ]: 2 : if (!show_debug && (info.m_flags & ArgsManager::DEBUG_ONLY)) continue;
735 [ # # ]: 0 : if (!select.contains(name)) continue;
736 : 0 : fn(name, info);
737 : : }
738 : 819 : };
739 : :
740 [ + + + + : 1654 : for (const auto& [category, category_args] : m_available_args) {
+ + + + +
+ + + + +
+ + + + ]
741 [ + + + + : 1334 : switch(category) {
+ + + + +
+ + + + +
+ + ]
742 : 459 : case OptionsCategory::OPTIONS:
743 [ + - + - ]: 918 : usage += HelpMessageGroup("Options:");
744 : 459 : break;
745 : 32 : case OptionsCategory::CONNECTION:
746 [ + - + - ]: 64 : usage += HelpMessageGroup("Connection options:");
747 : 32 : break;
748 : 7 : case OptionsCategory::ZMQ:
749 [ + - + - ]: 14 : usage += HelpMessageGroup("ZeroMQ notification options:");
750 : 7 : break;
751 : 25 : case OptionsCategory::DEBUG_TEST:
752 [ + - + - ]: 50 : usage += HelpMessageGroup("Debugging/Testing options:");
753 : 25 : break;
754 : 27 : case OptionsCategory::NODE_RELAY:
755 [ + - + - ]: 54 : usage += HelpMessageGroup("Node relay options:");
756 : 27 : break;
757 : 8 : case OptionsCategory::BLOCK_CREATION:
758 [ + - + - ]: 16 : usage += HelpMessageGroup("Block creation options:");
759 : 8 : break;
760 : 7 : case OptionsCategory::RPC:
761 [ + - + - ]: 14 : usage += HelpMessageGroup("RPC server options:");
762 : 7 : break;
763 : 7 : case OptionsCategory::IPC:
764 [ + - + - ]: 14 : usage += HelpMessageGroup("IPC interprocess connection options:");
765 : 7 : break;
766 : 10 : case OptionsCategory::WALLET:
767 [ + - + - ]: 20 : usage += HelpMessageGroup("Wallet options:");
768 : 10 : break;
769 : 28 : case OptionsCategory::WALLET_DEBUG_TEST:
770 [ - + - - : 28 : if (show_debug) usage += HelpMessageGroup("Wallet debugging/testing options:");
- - ]
771 : : break;
772 : 10 : case OptionsCategory::CHAINPARAMS:
773 [ + - + - ]: 20 : usage += HelpMessageGroup("Chain selection options:");
774 : 10 : break;
775 : 14 : case OptionsCategory::GUI:
776 [ + - + - ]: 28 : usage += HelpMessageGroup("UI Options:");
777 : 14 : break;
778 : 149 : case OptionsCategory::COMMANDS:
779 [ + - + - ]: 298 : usage += HelpMessageGroup("Commands:");
780 : 149 : break;
781 : 4 : case OptionsCategory::REGISTER_COMMANDS:
782 [ + - + - ]: 8 : usage += HelpMessageGroup("Register Commands:");
783 : 4 : break;
784 : 35 : case OptionsCategory::CLI_COMMANDS:
785 [ + - + - ]: 70 : usage += HelpMessageGroup("CLI Commands:");
786 : 35 : break;
787 : : case OptionsCategory::COMMAND_OPTIONS:
788 : : case OptionsCategory::HIDDEN:
789 : : break;
790 : : } // no default case, so the compiler can warn about missing cases
791 : :
792 [ + + ]: 1334 : if (category == OptionsCategory::COMMAND_OPTIONS) continue;
793 : :
794 : : // When we get to the hidden options, stop
795 [ + + ]: 1321 : if (category == OptionsCategory::HIDDEN) break;
796 : :
797 [ + + + + ]: 4155 : for (const auto& [arg_name, arg_info] : category_args) {
798 [ + + + + ]: 3333 : if (show_debug || !(arg_info.m_flags & ArgsManager::DEBUG_ONLY)) {
799 [ - + - + : 3500 : usage += HelpMessageOpt(arg_name, arg_info.m_help_param, arg_info.m_help_text);
- + + - ]
800 : :
801 [ + + ]: 1750 : if (category == OptionsCategory::COMMANDS) {
802 : 1260 : const auto cmd_args = m_command_args.find(arg_name);
803 [ + + ]: 1260 : if (cmd_args == m_command_args.end()) continue;
804 [ + - ]: 2 : for_matching_cmd_opts(cmd_args->second, [&](const auto& cmdopt_name, const auto& cmdopt_info) {
805 [ # # # # : 0 : usage += HelpMessageOpt(cmdopt_name, cmdopt_info.m_help_param, cmdopt_info.m_help_text, /*subopt=*/true);
# # # # ]
806 : 0 : });
807 : : }
808 : : }
809 : : }
810 : : }
811 [ + - ]: 819 : return usage;
812 : 819 : }
813 : :
814 : 819 : bool HelpRequested(const ArgsManager& args)
815 : : {
816 [ + - + - : 3771 : return args.IsArgSet("-?") || args.IsArgSet("-h") || args.IsArgSet("-help") || args.IsArgSet("-help-debug");
+ + + - +
- + + + -
+ - + + +
- + - + +
+ + + + -
- - - -
- ]
817 : : }
818 : :
819 : 2101 : void SetupHelpOptions(ArgsManager& args)
820 : : {
821 [ + - + - ]: 4202 : args.AddArg("-help", "Print this help message and exit (also -h or -?)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
822 [ + - ]: 2101 : args.AddHiddenArgs({"-h", "-?"});
823 : 2101 : }
824 : :
825 : 2032 : std::string HelpMessageGroup(const std::string &message) {
826 [ + - ]: 6096 : return std::string(message) + std::string("\n\n");
827 : : }
828 : :
829 : 4226 : std::string HelpMessageOpt(std::string_view option, std::string_view help_param, std::string_view message, bool subopt)
830 : : {
831 : 4226 : constexpr int screen_width = 79;
832 : 4226 : int opt_indent = 2;
833 : 4226 : int msg_indent = 7;
834 : :
835 [ - + ]: 4226 : if (subopt) {
836 : 0 : int bump = msg_indent - opt_indent;
837 : 0 : opt_indent += bump; // opt_indent now at the old msg_indent level
838 : 0 : msg_indent += bump; // indent by the same amount
839 : : }
840 : 4226 : int msg_width = screen_width - msg_indent;
841 : :
842 : 4226 : return strprintf("%*s%s%s\n%*s%s\n\n",
843 : : opt_indent, "", option, help_param,
844 [ + - ]: 8452 : msg_indent, "", FormatParagraph(message, msg_width, msg_indent));
845 : : }
846 : :
847 : : const std::vector<std::string> TEST_OPTIONS_DOC{
848 : : "addrman (use deterministic addrman)",
849 : : "reindex_after_failure_noninteractive_yes (When asked for a reindex after failure interactively, simulate as-if answered with 'yes')",
850 : : "bip94 (enforce BIP94 consensus rules)",
851 : : };
852 : :
853 : 2936 : bool HasTestOption(const ArgsManager& args, const std::string& test_option)
854 : : {
855 [ + - ]: 2936 : const auto options = args.GetArgs("-test");
856 [ - + - + : 35232 : return std::any_of(options.begin(), options.end(), [test_option](const auto& option) {
- + + - -
+ + - - +
+ - - + +
- ]
857 [ # # ]: 0 : return option == test_option;
858 : 2936 : });
859 : 2936 : }
860 : :
861 : 0 : fs::path GetDefaultDataDir()
862 : : {
863 : : // Windows:
864 : : // old: C:\Users\Username\AppData\Roaming\Bitcoin
865 : : // new: C:\Users\Username\AppData\Local\Bitcoin
866 : : // macOS: ~/Library/Application Support/Bitcoin
867 : : // Unix-like: ~/.bitcoin
868 : : #ifdef WIN32
869 : : // Windows
870 : : // Check for existence of datadir in old location and keep it there
871 : : fs::path legacy_path = GetSpecialFolderPath(CSIDL_APPDATA) / "Bitcoin";
872 : : if (fs::exists(legacy_path)) return legacy_path;
873 : :
874 : : // Otherwise, fresh installs can start in the new, "proper" location
875 : : return GetSpecialFolderPath(CSIDL_LOCAL_APPDATA) / "Bitcoin";
876 : : #else
877 : 0 : fs::path pathRet;
878 : 0 : char* pszHome = getenv("HOME");
879 [ # # # # ]: 0 : if (pszHome == nullptr || strlen(pszHome) == 0)
880 [ # # ]: 0 : pathRet = fs::path("/");
881 : : else
882 [ # # ]: 0 : pathRet = fs::path(pszHome);
883 : : #ifdef __APPLE__
884 : : // macOS
885 : : return pathRet / "Library/Application Support/Bitcoin";
886 : : #else
887 : : // Unix-like
888 [ # # # # ]: 0 : return pathRet / ".bitcoin";
889 : : #endif
890 : : #endif
891 : 0 : }
892 : :
893 : 0 : bool CheckDataDirOption(const ArgsManager& args)
894 : : {
895 [ # # # # ]: 0 : const fs::path datadir{args.GetPathArg("-datadir")};
896 [ # # # # : 0 : return datadir.empty() || fs::is_directory(fs::absolute(datadir));
# # # # ]
897 : 0 : }
898 : :
899 : 0 : fs::path ArgsManager::GetConfigFilePath() const
900 : : {
901 : 0 : LOCK(cs_args);
902 [ # # # # : 0 : return *Assert(m_config_path);
# # ]
903 : 0 : }
904 : :
905 : 0 : void ArgsManager::SetConfigFilePath(fs::path path)
906 : : {
907 : 0 : LOCK(cs_args);
908 [ # # ]: 0 : assert(!m_config_path);
909 [ # # ]: 0 : m_config_path = path;
910 : 0 : }
911 : :
912 : 1463 : ChainType ArgsManager::GetChainType() const
913 : : {
914 : 1463 : std::variant<ChainType, std::string> arg = GetChainArg();
915 [ + - ]: 1463 : if (auto* parsed = std::get_if<ChainType>(&arg)) return *parsed;
916 [ # # # # : 0 : throw std::runtime_error(strprintf("Unknown chain %s.", std::get<std::string>(arg)));
# # ]
917 : 1463 : }
918 : :
919 : 819 : std::string ArgsManager::GetChainTypeString() const
920 : : {
921 : 819 : auto arg = GetChainArg();
922 [ + + + - ]: 816 : if (auto* parsed = std::get_if<ChainType>(&arg)) return ChainTypeToString(*parsed);
923 [ - + - + ]: 834 : return std::get<std::string>(arg);
924 : 816 : }
925 : :
926 : 2282 : std::variant<ChainType, std::string> ArgsManager::GetChainArg() const
927 : : {
928 : 11410 : auto get_net = [&](const std::string& arg) {
929 : 9128 : LOCK(cs_args);
930 [ + - + - ]: 18256 : common::SettingsValue value = common::GetSetting(m_settings, /* section= */ "", SettingName(arg),
931 : : /* ignore_default_section_config= */ false,
932 : : /*ignore_nonpersistent=*/false,
933 [ + - ]: 9128 : /* get_chain_type= */ true);
934 [ + + - + : 9128 : return value.isNull() ? false : value.isBool() ? value.get_bool() : InterpretBool(value.get_str());
- - + - +
- ]
935 [ + - ]: 18256 : };
936 : :
937 [ + - ]: 2282 : const bool fRegTest = get_net("-regtest");
938 [ + - ]: 2282 : const bool fSigNet = get_net("-signet");
939 [ + - ]: 2282 : const bool fTestNet = get_net("-testnet");
940 [ + - ]: 2282 : const bool fTestNet4 = get_net("-testnet4");
941 [ + - ]: 2282 : const auto chain_arg = GetArg("-chain");
942 : :
943 [ + + ]: 2282 : if ((int)chain_arg.has_value() + (int)fRegTest + (int)fSigNet + (int)fTestNet + (int)fTestNet4 > 1) {
944 [ + - ]: 3 : throw std::runtime_error("Invalid combination of -regtest, -signet, -testnet, -testnet4 and -chain. Can use at most one.");
945 : : }
946 [ + + ]: 2279 : if (chain_arg) {
947 [ - + + - : 19 : if (auto parsed = ChainTypeFromString(*chain_arg)) return *parsed;
+ + ]
948 : : // Not a known string, so return original string
949 [ - + ]: 36 : return *chain_arg;
950 : : }
951 [ + + ]: 2260 : if (fRegTest) return ChainType::REGTEST;
952 [ + + ]: 2254 : if (fSigNet) return ChainType::SIGNET;
953 [ + + ]: 2251 : if (fTestNet) return ChainType::TESTNET;
954 [ + + ]: 2250 : if (fTestNet4) return ChainType::TESTNET4;
955 : 2246 : return ChainType::MAIN;
956 : 2279 : }
957 : :
958 : 1344793 : bool ArgsManager::UseDefaultSection(const std::string& arg) const
959 : : {
960 : 1344793 : AssertLockHeld(cs_args);
961 [ + + + + ]: 1344793 : return m_network == ChainTypeToString(ChainType::MAIN) || !m_network_only_args.contains(arg);
962 : : }
963 : :
964 : 1063378 : common::SettingsValue ArgsManager::GetSetting_(const std::string& arg) const
965 : : {
966 : 1063378 : AssertLockHeld(cs_args);
967 : 1063378 : return common::GetSetting(
968 : 1063378 : m_settings, m_network, SettingName(arg), !UseDefaultSection(arg),
969 [ + - ]: 2126756 : /*ignore_nonpersistent=*/false, /*get_chain_type=*/false);
970 : : }
971 : :
972 : 1033801 : common::SettingsValue ArgsManager::GetSetting(const std::string& arg) const
973 : : {
974 : 1033801 : LOCK(cs_args);
975 [ + - ]: 1033801 : return GetSetting_(arg);
976 : 1033801 : }
977 : :
978 : 281415 : std::vector<common::SettingsValue> ArgsManager::GetSettingsList(const std::string& arg) const
979 : : {
980 : 281415 : LOCK(cs_args);
981 [ + - + - : 562830 : return common::GetSettingsList(m_settings, m_network, SettingName(arg), !UseDefaultSection(arg));
+ - + - ]
982 : 281415 : }
983 : :
984 : 0 : void ArgsManager::logArgsPrefix(
985 : : const std::string& prefix,
986 : : const std::string& section,
987 : : const std::map<std::string, std::vector<common::SettingsValue>>& args) const
988 : : {
989 : 0 : AssertLockHeld(cs_args);
990 [ # # # # ]: 0 : std::string section_str = section.empty() ? "" : "[" + section + "] ";
991 [ # # ]: 0 : for (const auto& arg : args) {
992 [ # # ]: 0 : for (const auto& value : arg.second) {
993 [ # # # # ]: 0 : std::optional<unsigned int> flags = GetArgFlags_('-' + arg.first);
994 [ # # ]: 0 : if (flags) {
995 [ # # # # : 0 : std::string value_str = (*flags & SENSITIVE) ? "****" : value.write();
# # ]
996 [ # # ]: 0 : LogInfo("%s %s%s=%s\n", prefix, section_str, arg.first, value_str);
997 : 0 : }
998 : : }
999 : : }
1000 : 0 : }
1001 : :
1002 : 0 : void ArgsManager::LogArgs() const
1003 : : {
1004 : 0 : LOCK(cs_args);
1005 [ # # ]: 0 : for (const auto& section : m_settings.ro_config) {
1006 [ # # # # ]: 0 : logArgsPrefix("Config file arg:", section.first, section.second);
1007 : : }
1008 [ # # ]: 0 : for (const auto& setting : m_settings.rw_settings) {
1009 [ # # # # ]: 0 : LogInfo("Setting file arg: %s = %s\n", setting.first, setting.second.write());
1010 : : }
1011 [ # # # # : 0 : logArgsPrefix("Command-line arg:", "", m_settings.command_line_options);
# # # # ]
1012 : 0 : }
|