Branch data Line data Source code
1 : : // Copyright (c) 2017-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 <index/base.h>
6 : :
7 : : #include <chain.h>
8 : : #include <common/args.h>
9 : : #include <dbwrapper.h>
10 : : #include <interfaces/chain.h>
11 : : #include <interfaces/types.h>
12 : : #include <kernel/types.h>
13 : : #include <node/abort.h>
14 : : #include <node/blockstorage.h>
15 : : #include <node/context.h>
16 : : #include <node/database_args.h>
17 : : #include <node/interface_ui.h>
18 : : #include <primitives/block.h>
19 : : #include <sync.h>
20 : : #include <tinyformat.h>
21 : : #include <uint256.h>
22 : : #include <undo.h>
23 : : #include <util/fs.h>
24 : : #include <util/log.h>
25 : : #include <util/string.h>
26 : : #include <util/thread.h>
27 : : #include <util/threadinterrupt.h>
28 : : #include <util/time.h>
29 : : #include <util/translation.h>
30 : : #include <validation.h>
31 : : #include <validationinterface.h>
32 : :
33 : : #include <cassert>
34 : : #include <compare>
35 : : #include <cstdint>
36 : : #include <functional>
37 : : #include <memory>
38 : : #include <optional>
39 : : #include <stdexcept>
40 : : #include <string>
41 : : #include <thread>
42 : : #include <utility>
43 : : #include <vector>
44 : :
45 : : using kernel::ChainstateRole;
46 : :
47 : : constexpr uint8_t DB_BEST_BLOCK{'B'};
48 : :
49 : : constexpr auto SYNC_LOG_INTERVAL{30s};
50 : : constexpr auto SYNC_LOCATOR_WRITE_INTERVAL{30s};
51 : :
52 : : template <typename... Args>
53 : 0 : void BaseIndex::FatalErrorf(util::ConstevalFormatString<sizeof...(Args)> fmt, const Args&... args)
54 : : {
55 : 0 : auto message = tfm::format(fmt, args...);
56 [ # # # # : 0 : node::AbortNode(m_chain->context()->shutdown_request, m_chain->context()->exit_status, Untranslated(message), m_chain->context()->warnings.get());
# # # # #
# # # ]
57 : 0 : }
58 : :
59 : 306 : CBlockLocator GetLocator(interfaces::Chain& chain, const uint256& block_hash)
60 : : {
61 : 306 : CBlockLocator locator;
62 [ + - ]: 306 : bool found = chain.findBlock(block_hash, interfaces::FoundBlock().locator(locator));
63 [ - + ]: 306 : assert(found);
64 [ - + ]: 306 : assert(!locator.IsNull());
65 : 306 : return locator;
66 : 0 : }
67 : :
68 : 166 : BaseIndex::DB::DB(const fs::path& path, size_t n_cache_size, bool f_memory, bool f_wipe, bool f_obfuscate) :
69 : 7 : CDBWrapper{DBParams{
70 : : .path = path,
71 : : .cache_bytes = n_cache_size,
72 : : .memory_only = f_memory,
73 : : .wipe_data = f_wipe,
74 : : .obfuscate = f_obfuscate,
75 [ + - + + ]: 166 : .options = [] { DBOptions options; node::ReadDatabaseArgs(gArgs, options); return options; }()}}
76 : 159 : {}
77 : :
78 : 164 : CBlockLocator BaseIndex::DB::ReadBestBlock() const
79 : : {
80 : 164 : CBlockLocator locator;
81 : :
82 [ + - ]: 164 : bool success = Read(DB_BEST_BLOCK, locator);
83 [ + + ]: 164 : if (!success) {
84 [ - + ]: 59 : locator.SetNull();
85 : : }
86 : :
87 : 164 : return locator;
88 : 0 : }
89 : :
90 : 306 : void BaseIndex::DB::WriteBestBlock(CDBBatch& batch, const CBlockLocator& locator)
91 : : {
92 : 306 : batch.Write(DB_BEST_BLOCK, locator);
93 : 306 : }
94 : :
95 : 166 : BaseIndex::BaseIndex(std::unique_ptr<interfaces::Chain> chain, std::string name)
96 [ + - ]: 166 : : m_chain{std::move(chain)}, m_name{std::move(name)} {}
97 : :
98 : 166 : BaseIndex::~BaseIndex()
99 : : {
100 : 166 : Interrupt();
101 : 166 : Stop();
102 : 166 : }
103 : :
104 : 164 : bool BaseIndex::Init()
105 : : {
106 : 164 : AssertLockNotHeld(cs_main);
107 : :
108 : : // May need reset if index is being restarted.
109 : 164 : m_interrupt.reset();
110 : :
111 : : // m_chainstate member gives indexing code access to node internals. It is
112 : : // removed in followup https://github.com/bitcoin/bitcoin/pull/24230
113 [ + - + - ]: 492 : m_chainstate = WITH_LOCK(::cs_main,
114 : : return &m_chain->context()->chainman->ValidatedChainstate());
115 : : // Register to validation interface before setting the 'm_synced' flag, so that
116 : : // callbacks are not missed once m_synced is true.
117 : 164 : m_chain->context()->validation_signals->RegisterValidationInterface(this);
118 : :
119 : 164 : const auto locator{GetDB().ReadBestBlock()};
120 : :
121 [ + - ]: 164 : LOCK(cs_main);
122 : 164 : CChain& index_chain = m_chainstate->m_chain;
123 : :
124 [ + + ]: 164 : if (locator.IsNull()) {
125 [ + - ]: 59 : SetBestBlockIndex(nullptr);
126 : : } else {
127 : : // Setting the best block to the locator's top block. If it is not part of the
128 : : // best chain, we will rewind to the fork point during index sync
129 [ + - + - ]: 105 : const CBlockIndex* locator_index{m_chainstate->m_blockman.LookupBlockIndex(locator.vHave.at(0))};
130 [ - + ]: 105 : if (!locator_index) {
131 [ # # # # : 0 : return InitError(Untranslated(strprintf("best block of %s not found. Please rebuild the index.", GetName())));
# # ]
132 : : }
133 [ + - ]: 105 : SetBestBlockIndex(locator_index);
134 : : }
135 : :
136 : : // Child init
137 [ + + ]: 164 : const CBlockIndex* start_block = m_best_block_index.load();
138 [ + + + - : 164 : if (!CustomInit(start_block ? std::make_optional(interfaces::BlockRef{start_block->GetBlockHash(), start_block->nHeight}) : std::nullopt)) {
+ - ]
139 : : return false;
140 : : }
141 : :
142 : : // Note: this will latch to true immediately if the user starts up with an empty
143 : : // datadir and an index enabled. If this is the case, indexation will happen solely
144 : : // via `BlockConnected` signals until, possibly, the next restart.
145 [ - + ]: 328 : m_synced = start_block == index_chain.Tip();
146 : 164 : m_init = true;
147 : 164 : return true;
148 : 164 : }
149 : :
150 : 11347 : static const CBlockIndex* NextSyncBlock(const CBlockIndex* pindex_prev, CChain& chain) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
151 : : {
152 : 11347 : AssertLockHeld(cs_main);
153 : :
154 [ + + ]: 11347 : if (!pindex_prev) {
155 [ - + ]: 37 : return chain.Genesis();
156 : : }
157 : :
158 [ + + ]: 11310 : if (const auto* pindex{chain.Next(pindex_prev)}) {
159 : : return pindex;
160 : : }
161 : :
162 : : // If there is no next block, we might be synced
163 [ - + + + ]: 232 : if (pindex_prev == chain.Tip()) {
164 : : return nullptr;
165 : : }
166 : :
167 : : // Since block is not in the chain, return the next block in the chain AFTER the last common ancestor.
168 : : // Caller will be responsible for rewinding back to the common ancestor.
169 : 2 : return chain.Next(chain.FindFork(pindex_prev));
170 : : }
171 : :
172 : 33466 : bool BaseIndex::ProcessBlock(const CBlockIndex* pindex, const CBlock* block_data)
173 : : {
174 : 33466 : interfaces::BlockInfo block_info = kernel::MakeBlockInfo(pindex, block_data);
175 : :
176 : 33466 : CBlock block;
177 [ + + ]: 33466 : if (!block_data) { // disk lookup if block data wasn't provided
178 [ + - - + ]: 11233 : if (!m_chainstate->m_blockman.ReadBlock(block, *pindex)) {
179 [ # # ]: 0 : FatalErrorf("Failed to read block %s from disk",
180 [ # # ]: 0 : pindex->GetBlockHash().ToString());
181 : 0 : return false;
182 : : }
183 : 11233 : block_info.data = █
184 : : }
185 : :
186 : 33466 : CBlockUndo block_undo;
187 [ + - + + ]: 33466 : if (CustomOptions().connect_undo_data) {
188 [ + + + - : 28886 : if (pindex->nHeight > 0 && !m_chainstate->m_blockman.ReadBlockUndo(block_undo, *pindex)) {
- + ]
189 [ # # ]: 0 : FatalErrorf("Failed to read undo block data %s from disk",
190 [ # # ]: 0 : pindex->GetBlockHash().ToString());
191 : 0 : return false;
192 : : }
193 : 28886 : block_info.undo_data = &block_undo;
194 : : }
195 : :
196 [ + - - + ]: 33466 : if (!CustomAppend(block_info)) {
197 [ # # ]: 0 : FatalErrorf("Failed to write block %s to index database",
198 [ # # ]: 0 : pindex->GetBlockHash().ToString());
199 : 0 : return false;
200 : : }
201 : :
202 : : return true;
203 : 66932 : }
204 : :
205 : 158 : void BaseIndex::Sync()
206 : : {
207 [ + + ]: 158 : const CBlockIndex* pindex = m_best_block_index.load();
208 [ + + ]: 158 : if (!m_synced) {
209 : 101 : auto last_log_time{NodeClock::now()};
210 : 101 : auto last_locator_write_time{last_log_time};
211 : 11334 : while (true) {
212 [ + + ]: 11334 : if (m_interrupt) {
213 : 44 : LogInfo("%s: m_interrupt set; exiting ThreadSync", GetName());
214 : :
215 : 44 : SetBestBlockIndex(pindex);
216 : : // No need to handle errors in Commit. If it fails, the error will be already be
217 : : // logged. The best way to recover is to continue, as index cannot be corrupted by
218 : : // a missed commit to disk for an advanced index state.
219 : 44 : Commit();
220 : 44 : return;
221 : : }
222 : :
223 [ + - + - ]: 33870 : const CBlockIndex* pindex_next = WITH_LOCK(cs_main, return NextSyncBlock(pindex, m_chainstate->m_chain));
224 : : // If pindex_next is null, it means pindex is the chain tip, so
225 : : // commit data indexed so far.
226 [ + + ]: 11290 : if (!pindex_next) {
227 : 57 : SetBestBlockIndex(pindex);
228 : : // No need to handle errors in Commit. See rationale above.
229 : 57 : Commit();
230 : :
231 : : // If pindex is still the chain tip after committing, exit the
232 : : // sync loop. It is important for cs_main to be locked while
233 : : // setting m_synced = true, otherwise a new block could be
234 : : // attached while m_synced is still false, and it would not be
235 : : // indexed.
236 : 57 : LOCK(::cs_main);
237 [ + - ]: 57 : pindex_next = NextSyncBlock(pindex, m_chainstate->m_chain);
238 [ + - ]: 57 : if (!pindex_next) {
239 [ + - ]: 57 : m_synced = true;
240 [ + - ]: 57 : break;
241 : : }
242 : 57 : }
243 [ + + - + ]: 11233 : if (pindex_next->pprev != pindex && !Rewind(pindex, pindex_next->pprev)) {
244 : 0 : FatalErrorf("Failed to rewind %s to a previous chain tip", GetName());
245 : 0 : return;
246 : : }
247 : 11233 : pindex = pindex_next;
248 : :
249 : :
250 [ + - ]: 11233 : if (!ProcessBlock(pindex)) return; // error logged internally
251 : :
252 : 11233 : auto current_time{NodeClock::now()};
253 [ + + ]: 11233 : if (current_time - last_log_time >= SYNC_LOG_INTERVAL) {
254 : 3 : LogInfo("Syncing %s with block chain from height %d", GetName(), pindex->nHeight);
255 : 3 : last_log_time = current_time;
256 : : }
257 : :
258 [ + + ]: 11233 : if (current_time - last_locator_write_time >= SYNC_LOCATOR_WRITE_INTERVAL) {
259 : 3 : SetBestBlockIndex(pindex);
260 : 3 : last_locator_write_time = current_time;
261 : : // No need to handle errors in Commit. See rationale above.
262 : 3 : Commit();
263 : : }
264 : : }
265 : : }
266 : :
267 [ + + ]: 114 : if (pindex) {
268 : 112 : LogInfo("%s is enabled at height %d", GetName(), pindex->nHeight);
269 : : } else {
270 : 2 : LogInfo("%s is enabled", GetName());
271 : : }
272 : : }
273 : :
274 : 307 : bool BaseIndex::Commit()
275 : : {
276 : : // Don't commit anything if we haven't indexed any block yet
277 : : // (this could happen if init is interrupted).
278 [ + + ]: 307 : bool ok = m_best_block_index != nullptr;
279 [ + + ]: 307 : if (ok) {
280 : 306 : CDBBatch batch(GetDB());
281 [ + - ]: 306 : ok = CustomCommit(batch);
282 [ + - ]: 306 : if (ok) {
283 [ + - + - : 306 : GetDB().WriteBestBlock(batch, GetLocator(*m_chain, m_best_block_index.load()->GetBlockHash()));
+ - ]
284 [ + - + - ]: 306 : GetDB().WriteBatch(batch);
285 : : }
286 : 306 : }
287 [ + + ]: 307 : if (!ok) {
288 : 1 : LogError("Failed to commit latest %s state", GetName());
289 : 1 : return false;
290 : : }
291 : : return true;
292 : : }
293 : :
294 : 22 : bool BaseIndex::Rewind(const CBlockIndex* current_tip, const CBlockIndex* new_tip)
295 : : {
296 [ - + ]: 22 : assert(current_tip->GetAncestor(new_tip->nHeight) == new_tip);
297 : :
298 : 22 : CBlock block;
299 : 22 : CBlockUndo block_undo;
300 : :
301 [ + + ]: 447 : for (const CBlockIndex* iter_tip = current_tip; iter_tip != new_tip; iter_tip = iter_tip->pprev) {
302 [ + - ]: 425 : interfaces::BlockInfo block_info = kernel::MakeBlockInfo(iter_tip);
303 [ + - + + ]: 425 : if (CustomOptions().disconnect_data) {
304 [ + - - + ]: 167 : if (!m_chainstate->m_blockman.ReadBlock(block, *iter_tip)) {
305 [ # # # # ]: 0 : LogError("Failed to read block %s from disk",
306 : : iter_tip->GetBlockHash().ToString());
307 : 0 : return false;
308 : : }
309 : 167 : block_info.data = █
310 : : }
311 [ + - + + : 425 : if (CustomOptions().disconnect_undo_data && iter_tip->nHeight > 0) {
+ - ]
312 [ + - + - ]: 163 : if (!m_chainstate->m_blockman.ReadBlockUndo(block_undo, *iter_tip)) {
313 : : return false;
314 : : }
315 : 163 : block_info.undo_data = &block_undo;
316 : : }
317 [ + - + - ]: 425 : if (!CustomRemove(block_info)) {
318 : : return false;
319 : : }
320 : : }
321 : :
322 : : // Don't commit here - the committed index state must never be ahead of the
323 : : // flushed chainstate, otherwise unclean restarts would lead to index corruption.
324 : : // Pruning has a minimum of 288 blocks-to-keep and getting the index
325 : : // out of sync may be possible but a users fault.
326 : : // In case we reorg beyond the pruned depth, ReadBlock would
327 : : // throw and lead to a graceful shutdown
328 [ + - ]: 22 : SetBestBlockIndex(new_tip);
329 : : return true;
330 : 22 : }
331 : :
332 : 24949 : void BaseIndex::BlockConnected(const ChainstateRole& role, const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex)
333 : : {
334 : : // Ignore events from not fully validated chains to avoid out-of-order indexing.
335 : : //
336 : : // TODO at some point we could parameterize whether a particular index can be
337 : : // built out of order, but for now just do the conservative simple thing.
338 [ + + ]: 24949 : if (!role.validated) {
339 : : return;
340 : : }
341 : :
342 : : // Ignore BlockConnected signals until we have fully indexed the chain.
343 [ + + ]: 24149 : if (!m_synced) {
344 : : return;
345 : : }
346 : :
347 [ + + ]: 22233 : const CBlockIndex* best_block_index = m_best_block_index.load();
348 [ + + ]: 22233 : if (!best_block_index) {
349 [ - + ]: 21 : if (pindex->nHeight != 0) {
350 : 0 : FatalErrorf("First block connected is not the genesis block (height=%d)",
351 : 0 : pindex->nHeight);
352 : 0 : return;
353 : : }
354 : : } else {
355 : : // Ensure block connects to an ancestor of the current best block. This should be the case
356 : : // most of the time, but may not be immediately after the sync thread catches up and sets
357 : : // m_synced. Consider the case where there is a reorg and the blocks on the stale branch are
358 : : // in the ValidationInterface queue backlog even after the sync thread has caught up to the
359 : : // new chain tip. In this unlikely event, log a warning and let the queue clear.
360 [ - + ]: 22212 : if (best_block_index->GetAncestor(pindex->nHeight - 1) != pindex->pprev) {
361 [ # # # # ]: 0 : LogWarning("Block %s does not connect to an ancestor of "
362 : : "known best chain (tip=%s); not updating index",
363 : : pindex->GetBlockHash().ToString(),
364 : : best_block_index->GetBlockHash().ToString());
365 : 0 : return;
366 : : }
367 [ + + - + ]: 22212 : if (best_block_index != pindex->pprev && !Rewind(best_block_index, pindex->pprev)) {
368 : 0 : FatalErrorf("Failed to rewind %s to a previous chain tip",
369 : 0 : GetName());
370 : 0 : return;
371 : : }
372 : : }
373 : :
374 : : // Dispatch block to child class; errors are logged internally and abort the node.
375 [ + - ]: 22233 : if (ProcessBlock(pindex, block.get())) {
376 : : // Setting the best block index is intentionally the last step of this
377 : : // function, so BlockUntilSyncedToCurrentChain callers waiting for the
378 : : // best block index to be updated can rely on the block being fully
379 : : // processed, and the index object being safe to delete.
380 : 22233 : SetBestBlockIndex(pindex);
381 : : }
382 : : }
383 : :
384 : 293 : void BaseIndex::ChainStateFlushed(const ChainstateRole& role, const CBlockLocator& locator)
385 : : {
386 : : // Ignore events from not fully validated chains to avoid out-of-order indexing.
387 [ + + ]: 293 : if (!role.validated) {
388 : : return;
389 : : }
390 : :
391 [ + + ]: 264 : if (!m_synced) {
392 : : return;
393 : : }
394 : :
395 : 214 : const uint256& locator_tip_hash = locator.vHave.front();
396 : 214 : const CBlockIndex* locator_tip_index;
397 : 214 : {
398 : 214 : LOCK(cs_main);
399 [ + - + - ]: 214 : locator_tip_index = m_chainstate->m_blockman.LookupBlockIndex(locator_tip_hash);
400 : 0 : }
401 : :
402 [ - + ]: 214 : if (!locator_tip_index) {
403 [ # # ]: 0 : FatalErrorf("First block (hash=%s) in locator was not found",
404 : 0 : locator_tip_hash.ToString());
405 : 0 : return;
406 : : }
407 : :
408 : : // This checks that ChainStateFlushed callbacks are received after BlockConnected. The check may fail
409 : : // immediately after the sync thread catches up and sets m_synced. Consider the case where
410 : : // there is a reorg and the blocks on the stale branch are in the ValidationInterface queue
411 : : // backlog even after the sync thread has caught up to the new chain tip. In this unlikely
412 : : // event, log a warning and let the queue clear.
413 : 214 : const CBlockIndex* best_block_index = m_best_block_index.load();
414 [ + + ]: 214 : if (best_block_index->GetAncestor(locator_tip_index->nHeight) != locator_tip_index) {
415 [ + - + - ]: 22 : LogWarning("Locator contains block (hash=%s) not on known best "
416 : : "chain (tip=%s); not writing index locator",
417 : : locator_tip_hash.ToString(),
418 : : best_block_index->GetBlockHash().ToString());
419 : 11 : return;
420 : : }
421 : :
422 : : // No need to handle errors in Commit. If it fails, the error will be already be logged. The
423 : : // best way to recover is to continue, as index cannot be corrupted by a missed commit to disk
424 : : // for an advanced index state.
425 : 203 : Commit();
426 : : }
427 : :
428 : 130 : bool BaseIndex::BlockUntilSyncedToCurrentChain() const
429 : : {
430 : 130 : AssertLockNotHeld(cs_main);
431 : :
432 [ + + ]: 130 : if (!m_synced) {
433 : : return false;
434 : : }
435 : :
436 : 126 : {
437 : : // Skip the queue-draining stuff if we know we're caught up with
438 : : // m_chain.Tip().
439 : 126 : LOCK(cs_main);
440 [ - + ]: 126 : const CBlockIndex* chain_tip = m_chainstate->m_chain.Tip();
441 [ + - ]: 126 : const CBlockIndex* best_block_index = m_best_block_index.load();
442 [ + - + + ]: 126 : if (best_block_index->GetAncestor(chain_tip->nHeight) == chain_tip) {
443 [ + - ]: 110 : return true;
444 : : }
445 : 110 : }
446 : :
447 : 16 : LogInfo("%s is catching up on block notifications", GetName());
448 : 16 : m_chain->context()->validation_signals->SyncWithValidationInterfaceQueue();
449 : 16 : return true;
450 : : }
451 : :
452 : 324 : void BaseIndex::Interrupt()
453 : : {
454 : 324 : m_interrupt();
455 : 324 : }
456 : :
457 : 153 : bool BaseIndex::StartBackgroundSync()
458 : : {
459 [ - + - - ]: 153 : if (!m_init) throw std::logic_error("Error: Cannot start a non-initialized index");
460 : :
461 : 306 : m_thread_sync = std::thread(&util::TraceThread, GetName(), [this] { Sync(); });
462 : 153 : return true;
463 : : }
464 : :
465 : 330 : void BaseIndex::Stop()
466 : : {
467 [ + + ]: 330 : if (m_chain->context()->validation_signals) {
468 : 327 : m_chain->context()->validation_signals->UnregisterValidationInterface(this);
469 : : }
470 : :
471 [ + + ]: 330 : if (m_thread_sync.joinable()) {
472 : 153 : m_thread_sync.join();
473 : : }
474 : 330 : }
475 : :
476 : 322 : IndexSummary BaseIndex::GetSummary() const
477 : : {
478 [ + - ]: 322 : IndexSummary summary{};
479 [ + - ]: 322 : summary.name = GetName();
480 [ + + ]: 322 : summary.synced = m_synced;
481 [ + + ]: 322 : if (const auto& pindex = m_best_block_index.load()) {
482 : 269 : summary.best_block_height = pindex->nHeight;
483 : 269 : summary.best_block_hash = pindex->GetBlockHash();
484 : : } else {
485 : 53 : summary.best_block_height = 0;
486 [ + - ]: 53 : summary.best_block_hash = m_chain->getBlockHash(0);
487 : : }
488 : 322 : return summary;
489 : 0 : }
490 : :
491 : 22523 : void BaseIndex::SetBestBlockIndex(const CBlockIndex* block)
492 : : {
493 [ + + - + ]: 22523 : assert(!m_chainstate->m_blockman.IsPruneMode() || AllowPrune());
494 : :
495 [ + + + + ]: 22523 : if (AllowPrune() && block) {
496 : 20714 : node::PruneLockInfo prune_lock;
497 : 20714 : prune_lock.height_first = block->nHeight;
498 [ + - ]: 62142 : WITH_LOCK(::cs_main, m_chainstate->m_blockman.UpdatePruneLock(GetName(), prune_lock));
499 : : }
500 : :
501 : : // Intentionally set m_best_block_index as the last step in this function,
502 : : // after updating prune locks above, and after making any other references
503 : : // to *this, so the BlockUntilSyncedToCurrentChain function (which checks
504 : : // m_best_block_index as an optimization) can be used to wait for the last
505 : : // BlockConnected notification and safely assume that prune locks are
506 : : // updated and that the index object is safe to delete.
507 : 22523 : m_best_block_index = block;
508 : 22523 : }
|
