Bitcoin Core  22.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-2020 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 <primitives/transaction.h> // CTransaction(Ref)
10 #include <sync.h>
11 
12 #include <functional>
13 #include <memory>
14 
15 extern RecursiveMutex cs_main;
17 class CBlock;
18 class CBlockIndex;
19 struct CBlockLocator;
20 class CConnman;
22 class uint256;
23 class CScheduler;
24 enum class MemPoolRemovalReason;
25 
32 
33 // Alternate registration functions that release a shared_ptr after the last
34 // notification is sent. These are useful for race-free cleanup, since
35 // unregistration is nonblocking and can return before the last notification is
36 // processed.
38 void RegisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks);
40 void UnregisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks);
41 
51 void CallFunctionInValidationInterfaceQueue(std::function<void ()> func);
62 
79 protected:
84  ~CValidationInterface() = default;
94  virtual void UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload) {}
100  virtual void TransactionAddedToMempool(const CTransactionRef& tx, uint64_t mempool_sequence) {}
101 
134  virtual void TransactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRemovalReason reason, uint64_t mempool_sequence) {}
141  virtual void BlockConnected(const std::shared_ptr<const CBlock> &block, const CBlockIndex *pindex) {}
147  virtual void BlockDisconnected(const std::shared_ptr<const CBlock> &block, const CBlockIndex* pindex) {}
164  virtual void ChainStateFlushed(const CBlockLocator &locator) {}
171  virtual void BlockChecked(const CBlock&, const BlockValidationState&) {}
175  virtual void NewPoWValidBlock(const CBlockIndex *pindex, const std::shared_ptr<const CBlock>& block) {};
176  friend class CMainSignals;
177 };
178 
179 struct MainSignalsInstance;
181 private:
182  std::unique_ptr<MainSignalsInstance> m_internals;
183 
184  friend void ::RegisterSharedValidationInterface(std::shared_ptr<CValidationInterface>);
187  friend void ::CallFunctionInValidationInterfaceQueue(std::function<void ()> func);
188 
189 public:
196 
197  size_t CallbacksPending();
198 
199 
200  void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload);
201  void TransactionAddedToMempool(const CTransactionRef&, uint64_t mempool_sequence);
202  void TransactionRemovedFromMempool(const CTransactionRef&, MemPoolRemovalReason, uint64_t mempool_sequence);
203  void BlockConnected(const std::shared_ptr<const CBlock> &, const CBlockIndex *pindex);
204  void BlockDisconnected(const std::shared_ptr<const CBlock> &, const CBlockIndex* pindex);
205  void ChainStateFlushed(const CBlockLocator &);
206  void BlockChecked(const CBlock&, const BlockValidationState&);
207  void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr<const CBlock>&);
208 };
209 
211 
212 #endif // BITCOIN_VALIDATIONINTERFACE_H
CValidationInterface
Implement this to subscribe to events generated in validation.
Definition: validationinterface.h:78
CValidationInterface::TransactionRemovedFromMempool
virtual void TransactionRemovedFromMempool(const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence)
Notifies listeners of a transaction leaving mempool.
Definition: validationinterface.h:134
CMainSignals::BlockConnected
void BlockConnected(const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
Definition: validationinterface.cpp:220
CScheduler
Simple class for background tasks that should be run periodically or once "after a while".
Definition: scheduler.h:33
CMainSignals::CallbacksPending
size_t CallbacksPending()
Definition: validationinterface.cpp:110
CValidationInterface::NewPoWValidBlock
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...
Definition: validationinterface.h:175
BlockValidationState
Definition: validation.h:140
MainSignalsInstance
The MainSignalsInstance manages a list of shared_ptr<CValidationInterface> callbacks.
Definition: validationinterface.cpp:26
sync.h
transaction.h
CValidationInterface::BlockDisconnected
virtual void BlockDisconnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being disconnected.
Definition: validationinterface.h:147
AnnotatedMixin< std::recursive_mutex >
CMainSignals::BlockChecked
void BlockChecked(const CBlock &, const BlockValidationState &)
Definition: validationinterface.cpp:247
CTransactionRef
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:386
CMainSignals::BlockDisconnected
void BlockDisconnected(const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
Definition: validationinterface.cpp:229
UnregisterSharedValidationInterface
void UnregisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Unregister subscriber.
Definition: validationinterface.cpp:135
CMainSignals::UpdatedBlockTip
void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload)
Definition: validationinterface.cpp:188
CValidationInterface::BlockConnected
virtual void BlockConnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being connected.
Definition: validationinterface.h:141
SyncWithValidationInterfaceQueue
void SyncWithValidationInterfaceQueue() LOCKS_EXCLUDED(cs_main)
This is a synonym for the following, which asserts certain locks are not held: std::promise<void> pro...
Definition: validationinterface.cpp:160
CValidationInterface::ChainStateFlushed
virtual void ChainStateFlushed(const CBlockLocator &locator)
Notifies listeners of the new active block chain on-disk.
Definition: validationinterface.h:164
CMainSignals::TransactionRemovedFromMempool
void TransactionRemovedFromMempool(const CTransactionRef &, MemPoolRemovalReason, uint64_t mempool_sequence)
Definition: validationinterface.cpp:211
CMainSignals::FlushBackgroundCallbacks
void FlushBackgroundCallbacks()
Call any remaining callbacks on the calling thread.
Definition: validationinterface.cpp:103
CallFunctionInValidationInterfaceQueue
void CallFunctionInValidationInterfaceQueue(std::function< void()> func)
Pushes a function to callback onto the notification queue, guaranteeing any callbacks generated prior...
Definition: validationinterface.cpp:155
RegisterSharedValidationInterface
void RegisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Register subscriber.
Definition: validationinterface.cpp:121
CValidationInterface::TransactionAddedToMempool
virtual void TransactionAddedToMempool(const CTransactionRef &tx, uint64_t mempool_sequence)
Notifies listeners of a transaction having been added to mempool.
Definition: validationinterface.h:100
CMainSignals::RegisterBackgroundSignalScheduler
void RegisterBackgroundSignalScheduler(CScheduler &scheduler)
Register a CScheduler to give callbacks which should run in the background (may only be called once)
Definition: validationinterface.cpp:92
uint256
256-bit opaque blob.
Definition: uint256.h:124
cs_main
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: validation.cpp:116
GetMainSignals
CMainSignals & GetMainSignals()
Definition: validationinterface.cpp:116
CMainSignals::UnregisterBackgroundSignalScheduler
void UnregisterBackgroundSignalScheduler()
Unregister a CScheduler to give callbacks which should run in the background - these callbacks will n...
Definition: validationinterface.cpp:98
CMainSignals::TransactionAddedToMempool
void TransactionAddedToMempool(const CTransactionRef &, uint64_t mempool_sequence)
Definition: validationinterface.cpp:202
CBlock
Definition: block.h:62
CConnman
Definition: net.h:740
LOCKS_EXCLUDED
#define LOCKS_EXCLUDED(...)
Definition: threadsafety.h:48
UnregisterAllValidationInterfaces
void UnregisterAllValidationInterfaces()
Unregister all subscribers.
Definition: validationinterface.cpp:147
MemPoolRemovalReason
MemPoolRemovalReason
Reason why a transaction was removed from the mempool, this is passed to the notification signal.
Definition: txmempool.h:396
UnregisterValidationInterface
void UnregisterValidationInterface(CValidationInterface *callbacks)
Unregister subscriber.
Definition: validationinterface.cpp:140
CMainSignals
Definition: validationinterface.h:180
CMainSignals::m_internals
std::unique_ptr< MainSignalsInstance > m_internals
Definition: validationinterface.h:182
CMainSignals::NewPoWValidBlock
void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr< const CBlock > &)
Definition: validationinterface.cpp:253
CBlockLocator
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:114
CMainSignals::ChainStateFlushed
void ChainStateFlushed(const CBlockLocator &)
Definition: validationinterface.cpp:239
CBlockIndex
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:137
CValidationInterface::BlockChecked
virtual void BlockChecked(const CBlock &, const BlockValidationState &)
Notifies listeners of a block validation result.
Definition: validationinterface.h:171
CValidationInterface::UpdatedBlockTip
virtual void UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload)
Notifies listeners when the block chain tip advances.
Definition: validationinterface.h:94
RegisterValidationInterface
void RegisterValidationInterface(CValidationInterface *callbacks)
Register subscriber.
Definition: validationinterface.cpp:128