18 #include <validation.h>
31 template <
typename... Args>
37 AbortError(
_(
"A fatal internal error occurred, see debug.log for details"));
51 CDBWrapper(path, n_cache_size, f_memory, f_wipe, f_obfuscate)
80 if (!
GetDB().ReadBestBlock(locator)) {
97 bool prune_violation =
false;
107 if (!active_chain.
Contains(block_to_test)) {
110 block_to_test = active_chain.
FindFork(block_to_test);
113 prune_violation =
true;
116 if (block_to_test == block) {
117 prune_violation =
false;
123 block = block->
pprev;
126 if (prune_violation) {
127 return InitError(
strprintf(
Untranslated(
"%s best block of the index goes beyond pruned data. Please disable the index or reindex (which will download the whole blockchain again)"),
GetName()));
138 return chain.Genesis();
141 const CBlockIndex* pindex = chain.Next(pindex_prev);
146 return chain.Next(chain.FindFork(pindex_prev));
156 std::chrono::steady_clock::time_point last_log_time{0s};
157 std::chrono::steady_clock::time_point last_locator_write_time{0s};
179 FatalError(
"%s: Failed to rewind index %s to a previous chain tip",
183 pindex = pindex_next;
186 auto current_time{std::chrono::steady_clock::now()};
188 LogPrintf(
"Syncing %s with block chain from height %d\n",
190 last_log_time = current_time;
195 last_locator_write_time = current_time;
203 FatalError(
"%s: Failed to read block %s from disk",
207 block_info.
data = █
210 FatalError(
"%s: Failed to write block %s to index database",
238 return error(
"%s: Failed to commit latest %s state", __func__,
GetName());
274 if (!best_block_index) {
276 FatalError(
"%s: First block connected is not the genesis block (height=%d)",
287 LogPrintf(
"%s: WARNING: Block %s does not connect to an ancestor of "
288 "known best chain (tip=%s); not updating index\n",
293 if (best_block_index != pindex->
pprev && !
Rewind(best_block_index, pindex->
pprev)) {
294 FatalError(
"%s: Failed to rewind index %s to a previous chain tip",
307 FatalError(
"%s: Failed to write block %s to index",
319 const uint256& locator_tip_hash = locator.
vHave.front();
326 if (!locator_tip_index) {
327 FatalError(
"%s: First block (hash=%s) in locator was not found",
328 __func__, locator_tip_hash.
ToString());
339 LogPrintf(
"%s: WARNING: Locator contains block (hash=%s) not on known best "
340 "chain (tip=%s); not writing index locator\n",
341 __func__, locator_tip_hash.
ToString(),
352 bool BaseIndex::BlockUntilSyncedToCurrentChain()
const
371 LogPrintf(
"%s: %s is catching up on block notifications\n", __func__,
GetName());
389 if (!
Init())
return false;
static const CBlockIndex * NextSyncBlock(const CBlockIndex *pindex_prev, CChain &chain) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
static void FatalError(const char *fmt, const Args &... args)
constexpr uint8_t DB_BEST_BLOCK
constexpr auto SYNC_LOCATOR_WRITE_INTERVAL
constexpr auto SYNC_LOG_INTERVAL
CBlockLocator GetLocator(interfaces::Chain &chain, const uint256 &block_hash)
@ BLOCK_HAVE_DATA
full block available in blk*.dat
const CChainParams & Params()
Return the currently selected parameters.
void WriteBestBlock(CDBBatch &batch, const CBlockLocator &locator)
Write block locator of the chain that the index is in sync with.
DB(const fs::path &path, size_t n_cache_size, bool f_memory=false, bool f_wipe=false, bool f_obfuscate=false)
bool ReadBestBlock(CBlockLocator &locator) const
Read block locator of the chain that the index is in sync with.
void Stop()
Stops the instance from staying in sync with blockchain updates.
void SetBestBlockIndex(const CBlockIndex *block)
Update the internal best block index as well as the prune lock.
bool Init()
Read best block locator and check that data needed to sync has not been pruned.
void BlockConnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex) override
Notifies listeners of a block being connected.
virtual ~BaseIndex()
Destructor interrupts sync thread if running and blocks until it exits.
virtual bool CustomCommit(CDBBatch &batch)
Virtual method called internally by Commit that can be overridden to atomically commit more index sta...
virtual bool AllowPrune() const =0
const std::string & GetName() const LIFETIMEBOUND
Get the name of the index for display in logs.
std::atomic< bool > m_synced
Whether the index is in sync with the main chain.
CThreadInterrupt m_interrupt
BaseIndex(std::unique_ptr< interfaces::Chain > chain, std::string name)
IndexSummary GetSummary() const
Get a summary of the index and its state.
void ChainStateFlushed(const CBlockLocator &locator) override
Notifies listeners of the new active block chain on-disk.
std::thread m_thread_sync
bool Commit()
Write the current index state (eg.
bool Start()
Start initializes the sync state and registers the instance as a ValidationInterface so that it stays...
virtual bool CustomInit(const std::optional< interfaces::BlockKey > &block)
Initialize internal state from the database and block index.
virtual bool CustomRewind(const interfaces::BlockKey ¤t_tip, const interfaces::BlockKey &new_tip)
Rewind index to an earlier chain tip during a chain reorg.
void ThreadSync()
Sync the index with the block index starting from the current best block.
virtual DB & GetDB() const =0
Chainstate * m_chainstate
bool Rewind(const CBlockIndex *current_tip, const CBlockIndex *new_tip)
Loop over disconnected blocks and call CustomRewind.
std::unique_ptr< interfaces::Chain > m_chain
std::atomic< const CBlockIndex * > m_best_block_index
The last block in the chain that the index is in sync with.
virtual bool CustomAppend(const interfaces::BlockInfo &block)
Write update index entries for a newly connected block.
The block chain is a tree shaped structure starting with the genesis block at the root,...
CBlockIndex * pprev
pointer to the index of the predecessor of this block
uint256 GetBlockHash() const
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
int nHeight
height of the entry in the chain. The genesis block has height 0
An in-memory indexed chain of blocks.
CBlockIndex * Genesis() const
Returns the index entry for the genesis block of this chain, or nullptr if none.
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
const CBlockIndex * FindFork(const CBlockIndex *pindex) const
Find the last common block between this chain and a block index entry.
bool Contains(const CBlockIndex *pindex) const
Efficiently check whether a block is present in this chain.
const Consensus::Params & GetConsensus() const
Batch of changes queued to be written to a CDBWrapper.
void Write(const K &key, const V &value)
bool WriteBatch(CDBBatch &batch, bool fSync=false)
CChain m_chain
The current chain of blockheaders we consult and build on.
node::BlockManager & m_blockman
Reference to a BlockManager instance which itself is shared across all Chainstate instances.
const CBlockIndex * FindForkInGlobalIndex(const CBlockLocator &locator) const EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Find the last common block of this chain and a locator.
std::string ToString() const
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Interface giving clients (wallet processes, maybe other analysis tools in the future) ability to acce...
virtual bool findBlock(const uint256 &hash, const FoundBlock &block={})=0
Return whether node has the block and optionally return block metadata or contents.
Helper for findBlock to selectively return pieces of block data.
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool IsPruneMode() const
Whether running in -prune mode.
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
void Interrupt(NodeContext &node)
Interrupt threads.
bool InitError(const bilingual_str &str)
Show error message.
constexpr auto AbortError
interfaces::BlockInfo MakeBlockInfo(const CBlockIndex *index, const CBlock *data)
Return data from block index.
bool ReadBlockFromDisk(CBlock &block, const FlatFilePos &pos, const Consensus::Params &consensusParams)
Functions for disk access for blocks.
void TraceThread(std::string_view thread_name, std::function< void()> thread_func)
A wrapper for do-something-once thread functions.
void StartShutdown()
Request shutdown of the application.
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
std::vector< uint256 > vHave
Block data sent with blockConnected, blockDisconnected notifications.
Hash/height pair to help track and identify blocks.
#define AssertLockNotHeld(cs)
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
void SetSyscallSandboxPolicy(SyscallSandboxPolicy syscall_policy)
Force the current thread (and threads created from the current thread) into a restricted-service oper...
bool error(const char *fmt, const Args &... args)
#define EXCLUSIVE_LOCKS_REQUIRED(...)
bilingual_str _(const char *psz)
Translation function.
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
void UnregisterValidationInterface(CValidationInterface *callbacks)
Unregister subscriber.
void RegisterValidationInterface(CValidationInterface *callbacks)
Register subscriber.
void SyncWithValidationInterfaceQueue()
This is a synonym for the following, which asserts certain locks are not held: std::promise<void> pro...
void SetMiscWarning(const bilingual_str &warning)