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