Bitcoin Core 29.99.0
P2P Digital Currency
validationinterface.h
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#ifndef BITCOIN_VALIDATIONINTERFACE_H
7#define BITCOIN_VALIDATIONINTERFACE_H
8
9#include <kernel/chain.h>
10#include <kernel/cs_main.h>
12#include <sync.h>
13
14#include <cstddef>
15#include <cstdint>
16#include <functional>
17#include <memory>
18#include <vector>
19
20namespace util {
21class TaskRunnerInterface;
22} // namespace util
23
25class CBlock;
26class CBlockIndex;
27struct CBlockLocator;
28enum class MemPoolRemovalReason;
31
48protected:
63 virtual void UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload) {}
67 virtual void ActiveTipChange(const CBlockIndex& new_tip, bool is_ibd) {};
73 virtual void TransactionAddedToMempool(const NewMempoolTransactionInfo& tx, uint64_t mempool_sequence) {}
74
107 virtual void TransactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRemovalReason reason, uint64_t mempool_sequence) {}
108 /*
109 * Notifies listeners of transactions removed from the mempool as
110 * as a result of new block being connected.
111 * MempoolTransactionsRemovedForBlock will be fired before BlockConnected.
112 *
113 * Called on a background thread.
114 */
115 virtual void MempoolTransactionsRemovedForBlock(const std::vector<RemovedMempoolTransactionInfo>& txs_removed_for_block, unsigned int nBlockHeight) {}
121 virtual void BlockConnected(ChainstateRole role, const std::shared_ptr<const CBlock> &block, const CBlockIndex *pindex) {}
129 virtual void BlockDisconnected(const std::shared_ptr<const CBlock> &block, const CBlockIndex* pindex) {}
146 virtual void ChainStateFlushed(ChainstateRole role, const CBlockLocator &locator) {}
153 virtual void BlockChecked(const std::shared_ptr<const CBlock>&, const BlockValidationState&) {}
158 virtual void NewPoWValidBlock(const CBlockIndex *pindex, const std::shared_ptr<const CBlock>& block) {};
159 friend class ValidationSignals;
161};
162
165private:
166 std::unique_ptr<ValidationSignalsImpl> m_internals;
167
168public:
169 // The task runner will block validation if it calls its insert method's
170 // func argument synchronously. In this class func contains a loop that
171 // dispatches a single validation event to all subscribers sequentially.
172 explicit ValidationSignals(std::unique_ptr<util::TaskRunnerInterface> task_runner);
173
175
178
179 size_t CallbacksPending();
180
187
188 // Alternate registration functions that release a shared_ptr after the last
189 // notification is sent. These are useful for race-free cleanup, since
190 // unregistration is nonblocking and can return before the last notification is
191 // processed.
193 void RegisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks);
195 void UnregisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks);
196
206 void CallFunctionInValidationInterfaceQueue(std::function<void ()> func);
207
218
219 void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload);
220 void ActiveTipChange(const CBlockIndex&, bool);
221 void TransactionAddedToMempool(const NewMempoolTransactionInfo&, uint64_t mempool_sequence);
222 void TransactionRemovedFromMempool(const CTransactionRef&, MemPoolRemovalReason, uint64_t mempool_sequence);
223 void MempoolTransactionsRemovedForBlock(const std::vector<RemovedMempoolTransactionInfo>&, unsigned int nBlockHeight);
224 void BlockConnected(ChainstateRole, const std::shared_ptr<const CBlock> &, const CBlockIndex *pindex);
225 void BlockDisconnected(const std::shared_ptr<const CBlock> &, const CBlockIndex* pindex);
227 void BlockChecked(const std::shared_ptr<const CBlock>&, const BlockValidationState&);
228 void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr<const CBlock>&);
229};
230
231#endif // BITCOIN_VALIDATIONINTERFACE_H
Definition: block.h:69
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:141
Implement this to subscribe to events generated in validation and mempool.
virtual void NewPoWValidBlock(const CBlockIndex *pindex, const std::shared_ptr< const CBlock > &block)
Notifies listeners that a block which builds directly on our current tip has been received and connec...
virtual void ChainStateFlushed(ChainstateRole role, const CBlockLocator &locator)
Notifies listeners of the new active block chain on-disk.
virtual void BlockConnected(ChainstateRole role, const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being connected.
virtual void TransactionRemovedFromMempool(const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence)
Notifies listeners of a transaction leaving mempool.
virtual void UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload)
Notifies listeners when the block chain tip advances.
virtual void MempoolTransactionsRemovedForBlock(const std::vector< RemovedMempoolTransactionInfo > &txs_removed_for_block, unsigned int nBlockHeight)
virtual void TransactionAddedToMempool(const NewMempoolTransactionInfo &tx, uint64_t mempool_sequence)
Notifies listeners of a transaction having been added to mempool.
virtual void BlockChecked(const std::shared_ptr< const CBlock > &, const BlockValidationState &)
Notifies listeners of a block validation result.
virtual void ActiveTipChange(const CBlockIndex &new_tip, bool is_ibd)
Notifies listeners any time the block chain tip changes, synchronously.
virtual void BlockDisconnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being disconnected Provides the block that was disconnected.
~CValidationInterface()=default
Protected destructor so that instances can only be deleted by derived classes.
void UnregisterValidationInterface(CValidationInterface *callbacks)
Unregister subscriber.
void CallFunctionInValidationInterfaceQueue(std::function< void()> func)
Pushes a function to callback onto the notification queue, guaranteeing any callbacks generated prior...
void RegisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Register subscriber.
ValidationSignals(std::unique_ptr< util::TaskRunnerInterface > task_runner)
void BlockDisconnected(const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
void BlockChecked(const std::shared_ptr< const CBlock > &, const BlockValidationState &)
void UnregisterAllValidationInterfaces()
Unregister all subscribers.
void RegisterValidationInterface(CValidationInterface *callbacks)
Register subscriber.
void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr< const CBlock > &)
void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload)
void TransactionAddedToMempool(const NewMempoolTransactionInfo &, uint64_t mempool_sequence)
void ChainStateFlushed(ChainstateRole, const CBlockLocator &)
void ActiveTipChange(const CBlockIndex &, bool)
void SyncWithValidationInterfaceQueue() LOCKS_EXCLUDED(cs_main)
This is a synonym for the following, which asserts certain locks are not held: std::promise<void> pro...
void MempoolTransactionsRemovedForBlock(const std::vector< RemovedMempoolTransactionInfo > &, unsigned int nBlockHeight)
void TransactionRemovedFromMempool(const CTransactionRef &, MemPoolRemovalReason, uint64_t mempool_sequence)
void FlushBackgroundCallbacks()
Call any remaining callbacks on the calling thread.
std::unique_ptr< ValidationSignalsImpl > m_internals
void BlockConnected(ChainstateRole, const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
void UnregisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Unregister subscriber.
ValidationSignalsImpl manages a list of shared_ptr<CValidationInterface> callbacks.
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
ChainstateRole
This enum describes the various roles a specific Chainstate instance can take.
Definition: chain.h:25
MemPoolRemovalReason
Reason why a transaction was removed from the mempool, this is passed to the notification signal.
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:423
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:124
#define LOCKS_EXCLUDED(...)
Definition: threadsafety.h:50