Bitcoin Core 31.99.0
P2P Digital Currency
chainstatemanager_args.cpp
Go to the documentation of this file.
1// Copyright (c) 2022-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
6
7#include <arith_uint256.h>
8#include <common/args.h>
9#include <common/system.h>
10#include <logging.h>
12#include <node/database_args.h>
13#include <tinyformat.h>
14#include <uint256.h>
15#include <util/byte_units.h>
16#include <util/result.h>
17#include <util/strencodings.h>
18#include <util/translation.h>
19#include <validation.h>
20
21#include <algorithm>
22#include <chrono>
23#include <string>
24
25namespace node {
27{
28 if (auto value{args.GetIntArg("-checkblockindex")}) {
29 // Interpret bare -checkblockindex argument as 1 instead of 0.
30 opts.check_block_index = args.GetArg("-checkblockindex")->empty() ? 1 : *value;
31 }
32
33 if (auto value{args.GetArg("-minimumchainwork")}) {
34 if (auto min_work{uint256::FromUserHex(*value)}) {
35 opts.minimum_chain_work = UintToArith256(*min_work);
36 } else {
37 return util::Error{Untranslated(strprintf("Invalid minimum work specified (%s), must be up to %d hex digits", *value, uint256::size() * 2))};
38 }
39 }
40
41 if (auto value{args.GetArg("-assumevalid")}) {
42 if (auto block_hash{uint256::FromUserHex(*value)}) {
43 opts.assumed_valid_block = *block_hash;
44 } else {
45 return util::Error{Untranslated(strprintf("Invalid assumevalid block hash specified (%s), must be up to %d hex digits (or 0 to disable)", *value, uint256::size() * 2))};
46 }
47 }
48
49 if (auto value{args.GetIntArg("-maxtipage")}) opts.max_tip_age = std::chrono::seconds{*value};
50
51 ReadDatabaseArgs(args, opts.coins_db);
52 ReadCoinsViewArgs(args, opts.coins_view);
53
54 int script_threads = args.GetIntArg("-par", DEFAULT_SCRIPTCHECK_THREADS);
55 if (script_threads <= 0) {
56 // -par=0 means autodetect (number of cores - 1 script threads)
57 // -par=-n means "leave n cores free" (number of cores - n - 1 script threads)
58 script_threads += GetNumCores();
59 }
60 // Subtract 1 because the main thread counts towards the par threads.
61 opts.worker_threads_num = script_threads - 1;
62
63 if (auto max_size = args.GetIntArg("-maxsigcachesize")) {
64 // 1. When supplied with a max_size of 0, both the signature cache and
65 // script execution cache create the minimum possible cache (2
66 // elements). Therefore, we can use 0 as a floor here.
67 // 2. Multiply first, divide after to avoid integer truncation.
68 size_t clamped_size_each{size_t(std::max<int64_t>(*max_size, 0) * 1_MiB / 2)};
69 opts.script_execution_cache_bytes = clamped_size_each;
70 opts.signature_cache_bytes = clamped_size_each;
71 }
72
73 return {};
74}
75} // namespace node
arith_uint256 UintToArith256(const uint256 &a)
ArgsManager & args
Definition: bitcoind.cpp:278
static constexpr int DEFAULT_SCRIPTCHECK_THREADS
-par default (number of script-checking threads, 0 = auto)
std::string GetArg(const std::string &strArg, const std::string &strDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return string argument or default value.
Definition: args.cpp:485
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Definition: args.h:308
static constexpr unsigned int size()
Definition: uint256.h:107
static std::optional< uint256 > FromUserHex(std::string_view str)
Definition: uint256.h:199
int GetNumCores()
Return the number of cores available on the current system.
Definition: system.cpp:109
Definition: messages.h:21
util::Result< void > ApplyArgsManOptions(const ArgsManager &args, BlockManager::Options &opts)
void ReadCoinsViewArgs(const ArgsManager &args, CoinsViewOptions &options)
void ReadDatabaseArgs(const ArgsManager &args, DBOptions &options)
An options struct for ChainstateManager, more ergonomically referred to as ChainstateManager::Options...
std::optional< uint256 > assumed_valid_block
If set, it will override the block hash whose ancestors we will assume to have valid scripts without ...
std::optional< arith_uint256 > minimum_chain_work
If set, it will override the minimum work we will assume exists on some valid chain.
std::optional< int32_t > check_block_index
std::chrono::seconds max_tip_age
If the tip is older than this, the node is considered to be in initial block download.
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:82