Bitcoin Core  24.99.0
P2P Digital Currency
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
TxOrphanage Class Reference

A class to track orphan transactions (failed on TX_MISSING_INPUTS) Since we cannot distinguish orphans from bad transactions with non-existent inputs, we heavily limit the number of orphans we keep and the duration we keep them for. More...

#include <txorphanage.h>

Inheritance diagram for TxOrphanage:
[legend]
Collaboration diagram for TxOrphanage:
[legend]

Classes

struct  IteratorComparator
 
struct  OrphanTx
 

Public Member Functions

bool AddTx (const CTransactionRef &tx, NodeId peer) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
 Add a new orphan transaction. More...
 
bool HaveTx (const GenTxid &gtxid) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
 Check if we already have an orphan transaction (by txid or wtxid) More...
 
CTransactionRef GetTxToReconsider (NodeId peer, NodeId &originator, bool &more) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
 Extract a transaction from a peer's work set Returns nullptr and sets more to false if there are no transactions to work on. More...
 
int EraseTx (const uint256 &txid) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
 Erase an orphan by txid. More...
 
void EraseForPeer (NodeId peer) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
 Erase all orphans announced by a peer (eg, after that peer disconnects) More...
 
void EraseForBlock (const CBlock &block) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
 Erase all orphans included in or invalidated by a new block. More...
 
void LimitOrphans (unsigned int max_orphans) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
 Limit the orphanage to the given maximum. More...
 
void AddChildrenToWorkSet (const CTransaction &tx, NodeId peer) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
 Add any orphans that list a particular tx as a parent into a peer's work set. More...
 
size_t Size () EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
 Return how many entries exist in the orphange. More...
 

Protected Types

using OrphanMap = decltype(m_orphans)
 

Protected Member Functions

std::map< uint256, OrphanTx > m_orphans GUARDED_BY (m_mutex)
 Map from txid to orphan transaction record. More...
 
std::map< NodeId, std::set< uint256 > > m_peer_work_set GUARDED_BY (m_mutex)
 Which peer provided a parent tx of orphans that need to be reconsidered. More...
 
std::map< COutPoint, std::set< OrphanMap::iterator, IteratorComparator > > m_outpoint_to_orphan_it GUARDED_BY (m_mutex)
 Index from the parents' COutPoint into the m_orphans. More...
 
std::vector< OrphanMap::iterator > m_orphan_list GUARDED_BY (m_mutex)
 Orphan transactions in vector for quick random eviction. More...
 
std::map< uint256, OrphanMap::iterator > m_wtxid_to_orphan_it GUARDED_BY (m_mutex)
 Index from wtxid into the m_orphans to lookup orphan transactions using their witness ids. More...
 
int _EraseTx (const uint256 &txid) EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
 Erase an orphan by txid. More...
 

Protected Attributes

Mutex m_mutex
 Guards orphan transactions. More...
 

Detailed Description

A class to track orphan transactions (failed on TX_MISSING_INPUTS) Since we cannot distinguish orphans from bad transactions with non-existent inputs, we heavily limit the number of orphans we keep and the duration we keep them for.

Definition at line 21 of file txorphanage.h.

Member Typedef Documentation

◆ OrphanMap

using TxOrphanage::OrphanMap = decltype(m_orphans)
protected

Definition at line 78 of file txorphanage.h.

Member Function Documentation

◆ _EraseTx()

int TxOrphanage::_EraseTx ( const uint256 txid)
protected

Erase an orphan by txid.

Definition at line 61 of file txorphanage.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AddChildrenToWorkSet()

void TxOrphanage::AddChildrenToWorkSet ( const CTransaction tx,
NodeId  peer 
)

Add any orphans that list a particular tx as a parent into a peer's work set.

Definition at line 148 of file txorphanage.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AddTx()

bool TxOrphanage::AddTx ( const CTransactionRef tx,
NodeId  peer 
)

Add a new orphan transaction.

Definition at line 19 of file txorphanage.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EraseForBlock()

void TxOrphanage::EraseForBlock ( const CBlock block)

Erase all orphans included in or invalidated by a new block.

Definition at line 198 of file txorphanage.cpp.

Here is the call graph for this function:

◆ EraseForPeer()

void TxOrphanage::EraseForPeer ( NodeId  peer)

Erase all orphans announced by a peer (eg, after that peer disconnects)

Definition at line 93 of file txorphanage.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EraseTx()

int TxOrphanage::EraseTx ( const uint256 txid)

Erase an orphan by txid.

Definition at line 55 of file txorphanage.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetTxToReconsider()

CTransactionRef TxOrphanage::GetTxToReconsider ( NodeId  peer,
NodeId originator,
bool &  more 
)

Extract a transaction from a peer's work set Returns nullptr and sets more to false if there are no transactions to work on.

Otherwise returns the transaction reference, removes the transaction from the work set, and populates its arguments with the originating peer, and whether there are more orphans for this peer to work on after this tx.

Definition at line 175 of file txorphanage.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GUARDED_BY() [1/5]

std::map<uint256, OrphanTx> m_orphans TxOrphanage::GUARDED_BY ( m_mutex  )
protected

Map from txid to orphan transaction record.

Limited by -maxorphantx/DEFAULT_MAX_ORPHAN_TRANSACTIONS

◆ GUARDED_BY() [2/5]

std::map<NodeId, std::set<uint256> > m_peer_work_set TxOrphanage::GUARDED_BY ( m_mutex  )
protected

Which peer provided a parent tx of orphans that need to be reconsidered.

◆ GUARDED_BY() [3/5]

std::map<COutPoint, std::set<OrphanMap::iterator, IteratorComparator> > m_outpoint_to_orphan_it TxOrphanage::GUARDED_BY ( m_mutex  )
protected

Index from the parents' COutPoint into the m_orphans.

Used to remove orphan transactions from the m_orphans

◆ GUARDED_BY() [4/5]

std::vector<OrphanMap::iterator> m_orphan_list TxOrphanage::GUARDED_BY ( m_mutex  )
protected

Orphan transactions in vector for quick random eviction.

◆ GUARDED_BY() [5/5]

std::map<uint256, OrphanMap::iterator> m_wtxid_to_orphan_it TxOrphanage::GUARDED_BY ( m_mutex  )
protected

Index from wtxid into the m_orphans to lookup orphan transactions using their witness ids.

◆ HaveTx()

bool TxOrphanage::HaveTx ( const GenTxid gtxid) const

Check if we already have an orphan transaction (by txid or wtxid)

Definition at line 165 of file txorphanage.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LimitOrphans()

void TxOrphanage::LimitOrphans ( unsigned int  max_orphans)

Limit the orphanage to the given maximum.

Definition at line 112 of file txorphanage.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Size()

size_t TxOrphanage::Size ( )
inline

Return how many entries exist in the orphange.

Definition at line 54 of file txorphanage.h.

Here is the caller graph for this function:

Member Data Documentation

◆ m_mutex

Mutex TxOrphanage::m_mutex
mutableprotected

Guards orphan transactions.

Definition at line 62 of file txorphanage.h.


The documentation for this class was generated from the following files: