txorphanage.h

Go to the documentation of this file.

// Copyright (c) 2021 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_TXORPHANAGE_H
#define BITCOIN_TXORPHANAGE_H
 
#include <net.h>
#include <primitives/block.h>
#include <primitives/transaction.h>
#include <sync.h>
 
extern RecursiveMutex g_cs_orphans;
 
class TxOrphanage {
public:
    bool AddTx(const CTransactionRef &tx, NodeId peer)
        EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans);
 
    bool HaveTx(const TxId &txid) const LOCKS_EXCLUDED(g_cs_orphans);
 
    std::pair<CTransactionRef, NodeId> GetTx(const TxId &txid) const
        EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans);
 
    int EraseTx(const TxId &txid) EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans);
 
    void EraseForPeer(NodeId peer) EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans);
 
    void EraseForBlock(const CBlock &block) LOCKS_EXCLUDED(g_cs_orphans);
 
    unsigned int LimitOrphans(unsigned int max_orphans)
        EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans);
 
    void AddChildrenToWorkSet(const CTransaction &tx,
                              std::set<TxId> &orphan_work_set) const
        EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans);
 
    size_t Size() LOCKS_EXCLUDED(::g_cs_orphans) {
        LOCK(::g_cs_orphans);
        return m_orphans.size();
    }
 
protected:
    struct OrphanTx {
        CTransactionRef tx;
        NodeId fromPeer;
        int64_t nTimeExpire;
        size_t list_pos;
    };
 
    std::map<TxId, OrphanTx> m_orphans GUARDED_BY(g_cs_orphans);
 
    using OrphanMap = decltype(m_orphans);
 
    struct IteratorComparator {
        template <typename I> bool operator()(const I &a, const I &b) const {
            return &(*a) < &(*b);
        }
    };
 
    std::map<COutPoint, std::set<OrphanMap ::iterator, IteratorComparator>>
        m_outpoint_to_orphan_it GUARDED_BY(g_cs_orphans);
 
    std::vector<OrphanMap::iterator> m_orphan_list GUARDED_BY(g_cs_orphans);
};
 
#endif // BITCOIN_TXORPHANAGE_H