mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-03-04 02:36:16 +00:00
ae9121f958
This allows us to separate the initialization code from translations and error reporting. This change changes the caller semantics of LoadChainstate quite drastically. To see that this change doesn't change behaviour, observe that: 1. Prior to this change, LoadChainstate returned false only in the "bad genesis block" failure case (by returning InitError()), indicating that the caller should immediately bail. After this change, the corresponding ERROR_BAD_GENESIS_BLOCK handler in src/init.cpp maintains behavioue by also bailing immediately. 2. The failed_* temporary booleans were only used to break out of the outer do/while(false) loop. They can therefore be safely removed.
69 lines
2.6 KiB
C++
69 lines
2.6 KiB
C++
// Copyright (c) 2021 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#ifndef BITCOIN_NODE_CHAINSTATE_H
|
|
#define BITCOIN_NODE_CHAINSTATE_H
|
|
|
|
#include <cstdint> // for int64_t
|
|
#include <optional> // for std::optional
|
|
|
|
class ArgsManager;
|
|
class CChainParams;
|
|
class ChainstateManager;
|
|
struct NodeContext;
|
|
|
|
enum class ChainstateLoadingError {
|
|
ERROR_LOADING_BLOCK_DB,
|
|
ERROR_BAD_GENESIS_BLOCK,
|
|
ERROR_PRUNED_NEEDS_REINDEX,
|
|
ERROR_LOAD_GENESIS_BLOCK_FAILED,
|
|
ERROR_CHAINSTATE_UPGRADE_FAILED,
|
|
ERROR_REPLAYBLOCKS_FAILED,
|
|
ERROR_LOADCHAINTIP_FAILED,
|
|
ERROR_GENERIC_BLOCKDB_OPEN_FAILED,
|
|
ERROR_BLOCKS_WITNESS_INSUFFICIENTLY_VALIDATED,
|
|
ERROR_BLOCK_FROM_FUTURE,
|
|
ERROR_CORRUPTED_BLOCK_DB,
|
|
SHUTDOWN_PROBED,
|
|
};
|
|
|
|
/** This sequence can have 4 types of outcomes:
|
|
*
|
|
* 1. Success
|
|
* 2. Shutdown requested
|
|
* - nothing failed but a shutdown was triggered in the middle of the
|
|
* sequence
|
|
* 3. Soft failure
|
|
* - a failure that might be recovered from with a reindex
|
|
* 4. Hard failure
|
|
* - a failure that definitively cannot be recovered from with a reindex
|
|
*
|
|
* Currently, LoadChainstate returns a std::optional<ChainstateLoadingError>
|
|
* which:
|
|
*
|
|
* - if has_value()
|
|
* - Either "Soft failure", "Hard failure", or "Shutdown requested",
|
|
* differentiable by the specific enumerator.
|
|
*
|
|
* Note that a return value of SHUTDOWN_PROBED means ONLY that "during
|
|
* this sequence, when we explicitly checked ShutdownRequested() at
|
|
* arbitrary points, one of those calls returned true". Therefore, a
|
|
* return value other than SHUTDOWN_PROBED does not guarantee that
|
|
* ShutdownRequested() hasn't been called indirectly.
|
|
* - else
|
|
* - Success!
|
|
*/
|
|
std::optional<ChainstateLoadingError> LoadChainstate(bool fReset,
|
|
ChainstateManager& chainman,
|
|
NodeContext& node,
|
|
bool fPruneMode,
|
|
const CChainParams& chainparams,
|
|
const ArgsManager& args,
|
|
bool fReindexChainState,
|
|
int64_t nBlockTreeDBCache,
|
|
int64_t nCoinDBCache,
|
|
int64_t nCoinCacheUsage);
|
|
|
|
#endif // BITCOIN_NODE_CHAINSTATE_H
|