Branch data Line data Source code
1 : : // Copyright (c) 2021-2022 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 : :
5 : : #include <node/chainstate.h>
6 : :
7 : : #include <arith_uint256.h>
8 : : #include <chain.h>
9 : : #include <coins.h>
10 : : #include <consensus/params.h>
11 : : #include <logging.h>
12 : : #include <node/blockstorage.h>
13 : : #include <node/caches.h>
14 : : #include <sync.h>
15 : : #include <threadsafety.h>
16 : : #include <tinyformat.h>
17 : : #include <txdb.h>
18 : : #include <uint256.h>
19 : : #include <util/fs.h>
20 : : #include <util/signalinterrupt.h>
21 : : #include <util/time.h>
22 : : #include <util/translation.h>
23 : : #include <validation.h>
24 : :
25 : : #include <algorithm>
26 : : #include <atomic>
27 : : #include <cassert>
28 : : #include <limits>
29 : : #include <memory>
30 : : #include <vector>
31 : :
32 : : namespace node {
33 : : // Complete initialization of chainstates after the initial call has been made
34 : : // to ChainstateManager::InitializeChainstate().
35 : 169 : static ChainstateLoadResult CompleteChainstateInitialization(
36 : : ChainstateManager& chainman,
37 : : const CacheSizes& cache_sizes,
38 : : const ChainstateLoadOptions& options) EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
39 : : {
40 : 169 : auto& pblocktree{chainman.m_blockman.m_block_tree_db};
41 : : // new BlockTreeDB tries to delete the existing file, which
42 : : // fails if it's still open from the previous loop. Close it first:
43 [ + + ]: 169 : pblocktree.reset();
44 : 169 : try {
45 : 338 : pblocktree = std::make_unique<BlockTreeDB>(DBParams{
46 [ + - + - : 507 : .path = chainman.m_options.datadir / "blocks" / "index",
+ - ]
47 : 169 : .cache_bytes = static_cast<size_t>(cache_sizes.block_tree_db),
48 : 169 : .memory_only = options.block_tree_db_in_memory,
49 [ + - ]: 169 : .wipe_data = options.wipe_block_tree_db,
50 : 169 : .options = chainman.m_options.block_tree_db});
51 [ - - ]: 0 : } catch (dbwrapper_error& err) {
52 [ - - ]: 0 : LogError("%s\n", err.what());
53 [ - - ]: 0 : return {ChainstateLoadStatus::FAILURE, _("Error opening block database")};
54 : 0 : }
55 : :
56 [ - + ]: 169 : if (options.wipe_block_tree_db) {
57 : 0 : pblocktree->WriteReindexing(true);
58 [ # # ]: 0 : chainman.m_blockman.m_blockfiles_indexed = false;
59 : : //If we're reindexing in prune mode, wipe away unusable block files and all undo data files
60 [ # # ]: 0 : if (options.prune) {
61 : 0 : chainman.m_blockman.CleanupBlockRevFiles();
62 : : }
63 : : }
64 : :
65 [ - + - - ]: 169 : if (chainman.m_interrupt) return {ChainstateLoadStatus::INTERRUPTED, {}};
66 : :
67 : : // LoadBlockIndex will load m_have_pruned if we've ever removed a
68 : : // block file from disk.
69 : : // Note that it also sets m_blockfiles_indexed based on the disk flag!
70 [ - + ]: 169 : if (!chainman.LoadBlockIndex()) {
71 [ # # # # ]: 0 : if (chainman.m_interrupt) return {ChainstateLoadStatus::INTERRUPTED, {}};
72 : 0 : return {ChainstateLoadStatus::FAILURE, _("Error loading block database")};
73 : : }
74 : :
75 [ + + - + ]: 173 : if (!chainman.BlockIndex().empty() &&
76 : 4 : !chainman.m_blockman.LookupBlockIndex(chainman.GetConsensus().hashGenesisBlock)) {
77 : : // If the loaded chain has a wrong genesis, bail out immediately
78 : : // (we're likely using a testnet datadir, or the other way around).
79 : 0 : return {ChainstateLoadStatus::FAILURE_INCOMPATIBLE_DB, _("Incorrect or no genesis block found. Wrong datadir for network?")};
80 : : }
81 : :
82 : : // Check for changed -prune state. What we are concerned about is a user who has pruned blocks
83 : : // in the past, but is now trying to run unpruned.
84 [ - + - - ]: 169 : if (chainman.m_blockman.m_have_pruned && !options.prune) {
85 : 0 : return {ChainstateLoadStatus::FAILURE, _("You need to rebuild the database using -reindex to go back to unpruned mode. This will redownload the entire blockchain")};
86 : : }
87 : :
88 : : // At this point blocktree args are consistent with what's on disk.
89 : : // If we're not mid-reindex (based on disk + args), add a genesis block on disk
90 : : // (otherwise we use the one already on disk).
91 : : // This is called again in ImportBlocks after the reindex completes.
92 [ + - + - ]: 169 : if (chainman.m_blockman.m_blockfiles_indexed && !chainman.ActiveChainstate().LoadGenesisBlock()) {
93 : 0 : return {ChainstateLoadStatus::FAILURE, _("Error initializing block database")};
94 : : }
95 : :
96 : 340 : auto is_coinsview_empty = [&](Chainstate* chainstate) EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
97 [ + - + + ]: 171 : return options.wipe_chainstate_db || chainstate->CoinsTip().GetBestBlock().IsNull();
98 : 169 : };
99 : :
100 [ - + ]: 169 : assert(chainman.m_total_coinstip_cache > 0);
101 [ - + ]: 169 : assert(chainman.m_total_coinsdb_cache > 0);
102 : :
103 : : // If running with multiple chainstates, limit the cache sizes with a
104 : : // discount factor. If discounted the actual cache size will be
105 : : // recalculated by `chainman.MaybeRebalanceCaches()`. The discount factor
106 : : // is conservatively chosen such that the sum of the caches does not exceed
107 : : // the allowable amount during this temporary initialization state.
108 [ + + ]: 336 : double init_cache_fraction = chainman.GetAll().size() > 1 ? 0.2 : 1.0;
109 : :
110 : : // At this point we're either in reindex or we've loaded a useful
111 : : // block tree into BlockIndex()!
112 : :
113 [ + + ]: 340 : for (Chainstate* chainstate : chainman.GetAll()) {
114 [ + - + - ]: 171 : LogPrintf("Initializing chainstate %s\n", chainstate->ToString());
115 : :
116 : 171 : try {
117 [ + - ]: 171 : chainstate->InitCoinsDB(
118 : 171 : /*cache_size_bytes=*/chainman.m_total_coinsdb_cache * init_cache_fraction,
119 : 171 : /*in_memory=*/options.coins_db_in_memory,
120 [ + - ]: 171 : /*should_wipe=*/options.wipe_chainstate_db);
121 [ - - ]: 0 : } catch (dbwrapper_error& err) {
122 [ - - ]: 0 : LogError("%s\n", err.what());
123 [ - - ]: 0 : return {ChainstateLoadStatus::FAILURE, _("Error opening coins database")};
124 [ - - ]: 0 : }
125 : :
126 [ - + ]: 171 : if (options.coins_error_cb) {
127 [ # # # # ]: 0 : chainstate->CoinsErrorCatcher().AddReadErrCallback(options.coins_error_cb);
128 : : }
129 : :
130 : : // Refuse to load unsupported database format.
131 : : // This is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
132 [ + - + - : 171 : if (chainstate->CoinsDB().NeedsUpgrade()) {
- + ]
133 [ # # ]: 0 : return {ChainstateLoadStatus::FAILURE_INCOMPATIBLE_DB, _("Unsupported chainstate database format found. "
134 : : "Please restart with -reindex-chainstate. This will "
135 : 0 : "rebuild the chainstate database.")};
136 : : }
137 : :
138 : : // ReplayBlocks is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
139 [ + - - + ]: 171 : if (!chainstate->ReplayBlocks()) {
140 [ # # ]: 0 : return {ChainstateLoadStatus::FAILURE, _("Unable to replay blocks. You will need to rebuild the database using -reindex-chainstate.")};
141 : : }
142 : :
143 : : // The on-disk coinsdb is now in a good state, create the cache
144 [ + - ]: 171 : chainstate->InitCoinsCache(chainman.m_total_coinstip_cache * init_cache_fraction);
145 [ + - ]: 171 : assert(chainstate->CanFlushToDisk());
146 : :
147 [ + - + + ]: 171 : if (!is_coinsview_empty(chainstate)) {
148 : : // LoadChainTip initializes the chain based on CoinsTip()'s best block
149 [ + - - + ]: 6 : if (!chainstate->LoadChainTip()) {
150 [ # # ]: 0 : return {ChainstateLoadStatus::FAILURE, _("Error initializing block database")};
151 : : }
152 [ + - - + ]: 6 : assert(chainstate->m_chain.Tip() != nullptr);
153 : : }
154 : 0 : }
155 : :
156 [ + - ]: 169 : if (!options.wipe_block_tree_db) {
157 : 169 : auto chainstates{chainman.GetAll()};
158 [ + - - + ]: 169 : if (std::any_of(chainstates.begin(), chainstates.end(),
159 : 171 : [](const Chainstate* cs) EXCLUSIVE_LOCKS_REQUIRED(cs_main) { return cs->NeedsRedownload(); })) {
160 [ # # # # ]: 0 : return {ChainstateLoadStatus::FAILURE, strprintf(_("Witness data for blocks after height %d requires validation. Please restart with -reindex."),
161 [ # # ]: 0 : chainman.GetConsensus().SegwitHeight)};
162 : 169 : };
163 : 169 : }
164 : :
165 : : // Now that chainstates are loaded and we're able to flush to
166 : : // disk, rebalance the coins caches to desired levels based
167 : : // on the condition of each chainstate.
168 : 169 : chainman.MaybeRebalanceCaches();
169 : :
170 [ + - ]: 338 : return {ChainstateLoadStatus::SUCCESS, {}};
171 [ - - - - : 169 : }
+ - ]
172 : :
173 : 168 : ChainstateLoadResult LoadChainstate(ChainstateManager& chainman, const CacheSizes& cache_sizes,
174 : : const ChainstateLoadOptions& options)
175 : : {
176 [ + + ]: 168 : if (!chainman.AssumedValidBlock().IsNull()) {
177 [ + - ]: 158 : LogPrintf("Assuming ancestors of block %s have valid signatures.\n", chainman.AssumedValidBlock().GetHex());
178 : : } else {
179 : 89 : LogPrintf("Validating signatures for all blocks.\n");
180 : : }
181 [ + - ]: 168 : LogPrintf("Setting nMinimumChainWork=%s\n", chainman.MinimumChainWork().GetHex());
182 [ - + ]: 168 : if (chainman.MinimumChainWork() < UintToArith256(chainman.GetConsensus().nMinimumChainWork)) {
183 [ # # ]: 0 : LogPrintf("Warning: nMinimumChainWork set below default value of %s\n", chainman.GetConsensus().nMinimumChainWork.GetHex());
184 : : }
185 [ - + ]: 168 : if (chainman.m_blockman.GetPruneTarget() == BlockManager::PRUNE_TARGET_MANUAL) {
186 : 0 : LogPrintf("Block pruning enabled. Use RPC call pruneblockchain(height) to manually prune block and undo files.\n");
187 [ - + ]: 168 : } else if (chainman.m_blockman.GetPruneTarget()) {
188 : 0 : LogPrintf("Prune configured to target %u MiB on disk for block and undo files.\n", chainman.m_blockman.GetPruneTarget() / 1024 / 1024);
189 : : }
190 : :
191 : 168 : LOCK(cs_main);
192 : :
193 : 168 : chainman.m_total_coinstip_cache = cache_sizes.coins;
194 : 168 : chainman.m_total_coinsdb_cache = cache_sizes.coins_db;
195 : :
196 : : // Load the fully validated chainstate.
197 [ + - ]: 168 : chainman.InitializeChainstate(options.mempool);
198 : :
199 : : // Load a chain created from a UTXO snapshot, if any exist.
200 [ + - ]: 168 : bool has_snapshot = chainman.DetectSnapshotChainstate();
201 : :
202 [ + + - + ]: 168 : if (has_snapshot && options.wipe_chainstate_db) {
203 [ # # ]: 0 : LogPrintf("[snapshot] deleting snapshot chainstate due to reindexing\n");
204 [ # # # # ]: 0 : if (!chainman.DeleteSnapshotChainstate()) {
205 [ # # # # ]: 0 : return {ChainstateLoadStatus::FAILURE_FATAL, Untranslated("Couldn't remove snapshot chainstate.")};
206 : : }
207 : : }
208 : :
209 [ + - - + ]: 168 : auto [init_status, init_error] = CompleteChainstateInitialization(chainman, cache_sizes, options);
210 [ - + ]: 168 : if (init_status != ChainstateLoadStatus::SUCCESS) {
211 [ # # ]: 0 : return {init_status, init_error};
212 : : }
213 : :
214 : : // If a snapshot chainstate was fully validated by a background chainstate during
215 : : // the last run, detect it here and clean up the now-unneeded background
216 : : // chainstate.
217 : : //
218 : : // Why is this cleanup done here (on subsequent restart) and not just when the
219 : : // snapshot is actually validated? Because this entails unusual
220 : : // filesystem operations to move leveldb data directories around, and that seems
221 : : // too risky to do in the middle of normal runtime.
222 [ + - ]: 168 : auto snapshot_completion = chainman.MaybeCompleteSnapshotValidation();
223 : :
224 [ + + ]: 168 : if (snapshot_completion == SnapshotCompletionResult::SKIPPED) {
225 : : // do nothing; expected case
226 [ + - ]: 1 : } else if (snapshot_completion == SnapshotCompletionResult::SUCCESS) {
227 [ + - ]: 1 : LogPrintf("[snapshot] cleaning up unneeded background chainstate, then reinitializing\n");
228 [ + - - + ]: 1 : if (!chainman.ValidatedSnapshotCleanup()) {
229 [ # # # # ]: 0 : return {ChainstateLoadStatus::FAILURE_FATAL, Untranslated("Background chainstate cleanup failed unexpectedly.")};
230 : : }
231 : :
232 : : // Because ValidatedSnapshotCleanup() has torn down chainstates with
233 : : // ChainstateManager::ResetChainstates(), reinitialize them here without
234 : : // duplicating the blockindex work above.
235 [ + - - + ]: 1 : assert(chainman.GetAll().empty());
236 [ + - - + ]: 1 : assert(!chainman.IsSnapshotActive());
237 [ - + ]: 1 : assert(!chainman.IsSnapshotValidated());
238 : :
239 [ + - ]: 1 : chainman.InitializeChainstate(options.mempool);
240 : :
241 : : // A reload of the block index is required to recompute setBlockIndexCandidates
242 : : // for the fully validated chainstate.
243 [ + - + - ]: 1 : chainman.ActiveChainstate().ClearBlockIndexCandidates();
244 : :
245 [ + - - + ]: 1 : auto [init_status, init_error] = CompleteChainstateInitialization(chainman, cache_sizes, options);
246 [ - + ]: 1 : if (init_status != ChainstateLoadStatus::SUCCESS) {
247 [ # # ]: 0 : return {init_status, init_error};
248 : : }
249 : 1 : } else {
250 [ # # ]: 0 : return {ChainstateLoadStatus::FAILURE_FATAL, _(
251 : : "UTXO snapshot failed to validate. "
252 : 0 : "Restart to resume normal initial block download, or try loading a different snapshot.")};
253 : : }
254 : :
255 [ + - ]: 336 : return {ChainstateLoadStatus::SUCCESS, {}};
256 [ + - ]: 504 : }
257 : :
258 : 168 : ChainstateLoadResult VerifyLoadedChainstate(ChainstateManager& chainman, const ChainstateLoadOptions& options)
259 : : {
260 : 337 : auto is_coinsview_empty = [&](Chainstate* chainstate) EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
261 [ + - + + ]: 169 : return options.wipe_chainstate_db || chainstate->CoinsTip().GetBestBlock().IsNull();
262 : 168 : };
263 : :
264 : 168 : LOCK(cs_main);
265 : :
266 [ + - + + ]: 337 : for (Chainstate* chainstate : chainman.GetAll()) {
267 [ + - + + ]: 169 : if (!is_coinsview_empty(chainstate)) {
268 [ + - ]: 4 : const CBlockIndex* tip = chainstate->m_chain.Tip();
269 [ + - + - : 4 : if (tip && tip->nTime > GetTime() + MAX_FUTURE_BLOCK_TIME) {
+ - ]
270 [ # # ]: 0 : return {ChainstateLoadStatus::FAILURE, _("The block database contains a block which appears to be from the future. "
271 : : "This may be due to your computer's date and time being set incorrectly. "
272 : 0 : "Only rebuild the block database if you are sure that your computer's date and time are correct")};
273 : : }
274 : :
275 [ + - + - ]: 8 : VerifyDBResult result = CVerifyDB(chainman.GetNotifications()).VerifyDB(
276 : 4 : *chainstate, chainman.GetConsensus(), chainstate->CoinsDB(),
277 : 4 : options.check_level,
278 [ + - ]: 4 : options.check_blocks);
279 [ - - - + ]: 4 : switch (result) {
280 : : case VerifyDBResult::SUCCESS:
281 : : case VerifyDBResult::SKIPPED_MISSING_BLOCKS:
282 : : break;
283 : 0 : case VerifyDBResult::INTERRUPTED:
284 [ # # ]: 0 : return {ChainstateLoadStatus::INTERRUPTED, _("Block verification was interrupted")};
285 : 0 : case VerifyDBResult::CORRUPTED_BLOCK_DB:
286 [ # # ]: 0 : return {ChainstateLoadStatus::FAILURE, _("Corrupted block database detected")};
287 : 0 : case VerifyDBResult::SKIPPED_L3_CHECKS:
288 [ # # ]: 0 : if (options.require_full_verification) {
289 [ # # ]: 0 : return {ChainstateLoadStatus::FAILURE_INSUFFICIENT_DBCACHE, _("Insufficient dbcache for block verification")};
290 : : }
291 : : break;
292 : : } // no default case, so the compiler can warn about missing cases
293 : : }
294 : 0 : }
295 : :
296 [ + - ]: 336 : return {ChainstateLoadStatus::SUCCESS, {}};
297 [ + - ]: 336 : }
298 : : } // namespace node
|
