Bitcoin Core  24.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-2022 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/cs_main.h>
10 #include <primitives/transaction.h> // CTransaction(Ref)
11 #include <sync.h>
12 
13 #include <functional>
14 #include <memory>
15 
17 class CBlock;
18 class CBlockIndex;
19 struct CBlockLocator;
21 class CScheduler;
22 enum class MemPoolRemovalReason;
23 
30 
31 // Alternate registration functions that release a shared_ptr after the last
32 // notification is sent. These are useful for race-free cleanup, since
33 // unregistration is nonblocking and can return before the last notification is
34 // processed.
36 void RegisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks);
38 void UnregisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks);
39 
49 void CallFunctionInValidationInterfaceQueue(std::function<void ()> func);
60 
77 protected:
82  ~CValidationInterface() = default;
92  virtual void UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload) {}
98  virtual void TransactionAddedToMempool(const CTransactionRef& tx, uint64_t mempool_sequence) {}
99 
132  virtual void TransactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRemovalReason reason, uint64_t mempool_sequence) {}
139  virtual void BlockConnected(const std::shared_ptr<const CBlock> &block, const CBlockIndex *pindex) {}
145  virtual void BlockDisconnected(const std::shared_ptr<const CBlock> &block, const CBlockIndex* pindex) {}
162  virtual void ChainStateFlushed(const CBlockLocator &locator) {}
169  virtual void BlockChecked(const CBlock&, const BlockValidationState&) {}
173  virtual void NewPoWValidBlock(const CBlockIndex *pindex, const std::shared_ptr<const CBlock>& block) {};
174  friend class CMainSignals;
176 };
177 
178 class MainSignalsImpl;
180 private:
181  std::unique_ptr<MainSignalsImpl> m_internals;
182 
183  friend void ::RegisterSharedValidationInterface(std::shared_ptr<CValidationInterface>);
186  friend void ::CallFunctionInValidationInterfaceQueue(std::function<void ()> func);
187 
188 public:
195 
196  size_t CallbacksPending();
197 
198 
199  void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload);
200  void TransactionAddedToMempool(const CTransactionRef&, uint64_t mempool_sequence);
201  void TransactionRemovedFromMempool(const CTransactionRef&, MemPoolRemovalReason, uint64_t mempool_sequence);
202  void BlockConnected(const std::shared_ptr<const CBlock> &, const CBlockIndex *pindex);
203  void BlockDisconnected(const std::shared_ptr<const CBlock> &, const CBlockIndex* pindex);
204  void ChainStateFlushed(const CBlockLocator &);
205  void BlockChecked(const CBlock&, const BlockValidationState&);
206  void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr<const CBlock>&);
207 };
208 
210 
211 #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:151
void TransactionAddedToMempool(const CTransactionRef &, uint64_t mempool_sequence)
void BlockConnected(const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload)
void BlockDisconnected(const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
void BlockChecked(const CBlock &, const BlockValidationState &)
std::unique_ptr< MainSignalsImpl > m_internals
void UnregisterBackgroundSignalScheduler()
Unregister a CScheduler to give callbacks which should run in the background - these callbacks will n...
void TransactionRemovedFromMempool(const CTransactionRef &, MemPoolRemovalReason, uint64_t mempool_sequence)
void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr< const CBlock > &)
void RegisterBackgroundSignalScheduler(CScheduler &scheduler)
Register a CScheduler to give callbacks which should run in the background (may only be called once)
void ChainStateFlushed(const CBlockLocator &)
void FlushBackgroundCallbacks()
Call any remaining callbacks on the calling thread.
Simple class for background tasks that should be run periodically or once "after a while".
Definition: scheduler.h:39
Implement this to subscribe to events generated in validation.
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 TransactionAddedToMempool(const CTransactionRef &tx, uint64_t mempool_sequence)
Notifies listeners of a transaction having been added to mempool.
virtual void ChainStateFlushed(const CBlockLocator &locator)
Notifies listeners of the new active block chain on-disk.
virtual void BlockChecked(const CBlock &, const BlockValidationState &)
Notifies listeners of a block validation result.
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 BlockConnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being connected.
virtual void BlockDisconnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being disconnected.
~CValidationInterface()=default
Protected destructor so that instances can only be deleted by derived classes.
MainSignalsImpl 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:7
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:421
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:121
#define LOCKS_EXCLUDED(...)
Definition: threadsafety.h:48
MemPoolRemovalReason
Reason why a transaction was removed from the mempool, this is passed to the notification signal.
Definition: txmempool.h:231
CMainSignals & GetMainSignals()
void CallFunctionInValidationInterfaceQueue(std::function< void()> func)
Pushes a function to callback onto the notification queue, guaranteeing any callbacks generated prior...
void UnregisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Unregister subscriber.
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 UnregisterAllValidationInterfaces()
Unregister all subscribers.
void UnregisterValidationInterface(CValidationInterface *callbacks)
Unregister subscriber.
void RegisterValidationInterface(CValidationInterface *callbacks)
Register subscriber.
void RegisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Register subscriber.