diff --git a/src/txrequest.h b/src/txrequest.h --- a/src/txrequest.h +++ b/src/txrequest.h @@ -13,53 +13,53 @@ #include /** - * Data structure to keep track of, and schedule, transaction downloads from + * Data structure to keep track of, and schedule, inventory downloads from * peers. * * === Specification === * - * We keep track of which peers have announced which transactions, and use that + * We keep track of which peers have announced which inventories, and use that * to determine which requests should go to which peer, when, and in what order. * - * The following information is tracked per peer/tx combination + * The following information is tracked per peer/inv combination * ("announcement"): * - Which peer announced it (through their NodeId) - * - The txid of the transaction - * - What the earliest permitted time is that that transaction can be requested + * - The invid of the inventory + * - What the earliest permitted time is that that inventory can be requested * from that peer (called "reqtime"). * - Whether it's from a "preferred" peer or not. Which announcements get this * flag is determined by the caller, but this is designed for outbound peers, * or other peers that we have a higher level of trust in. Even when the * peers' preferredness changes, the preferred flag of existing announcements * from that peer won't change. - * - Whether or not the transaction was requested already, and if so, when it + * - Whether or not the inventory was requested already, and if so, when it * times out (called "expiry"). - * - Whether or not the transaction request failed already (timed out, or - * invalid transaction or NOTFOUND was received). + * - Whether or not the inventory request failed already (timed out, or + * invalid inventory or NOTFOUND was received). * * Transaction requests are then assigned to peers, following these rules: * - * - No transaction is requested as long as another request for the same txid + * - No inventory is requested as long as another request for the same invid * is outstanding (it needs to fail first by passing expiry, or a NOTFOUND or - * invalid transaction has to be received for it). + * invalid inventory has to be received for it). * * Rationale: to avoid wasting bandwidth on multiple copies of the same - * transaction. + * inventory. * - * - The same transaction is never requested twice from the same peer, unless + * - The same inventory is never requested twice from the same peer, unless * the announcement was forgotten in between, and re-announced. Announcements * are forgotten only: * - If a peer goes offline, all its announcements are forgotten. - * - If a transaction has been successfully received, or is otherwise no + * - If an inventory has been successfully received, or is otherwise no * longer needed, the caller can call ForgetTxId, which removes all - * announcements across all peers with the specified txid. - * - If for a given txid only already-failed announcements remain, they are + * announcements across all peers with the specified invid. + * - If for a given invid only already-failed announcements remain, they are * all forgotten. * - * Rationale: giving a peer multiple chances to announce a transaction would + * Rationale: giving a peer multiple chances to announce an inventory would * allow them to bias requests in their favor, worsening - * transaction censoring attacks. The flip side is that as long as - * an attacker manages to prevent us from receiving a transaction, + * inventory censoring attacks. The flip side is that as long as + * an attacker manages to prevent us from receiving an inventory, * failed announcements (including those from honest peers) will * linger longer, increasing memory usage somewhat. The impact of * this is limited by imposing a cap on the number of tracked @@ -67,7 +67,7 @@ * announcements from honest peers should be rare, this almost * solely hinders attackers. * Transaction censoring attacks can be done by announcing - * transactions quickly while not answering requests for them. See + * inventories quickly while not answering requests for them. See * https://allquantor.at/blockchainbib/pdf/miller2015topology.pdf * for more information. * @@ -96,7 +96,7 @@ * - Will be unsuccessful if all preferred connections are honest (and there is * at least one preferred connection). * - If there are P preferred connections of which Ph>=1 are honest, the - * attacker can delay us from learning about a transaction by k expiration + * attacker can delay us from learning about an inventory by k expiration * periods, where k ~ 1 + NHG(N=P-1,K=P-Ph-1,r=1), which has mean P/(Ph+1) * (where NHG stands for Negative Hypergeometric distribution). The "1 +" is * due to the fact that the attacker can be the first to announce through a @@ -134,22 +134,22 @@ virtual ~InvRequestTrackerImplInterface() = default; - virtual void ReceivedInv(NodeId peer, const uint256 &txid, bool preferred, + virtual void ReceivedInv(NodeId peer, const uint256 &invid, bool preferred, std::chrono::microseconds reqtime) = 0; virtual void DisconnectedPeer(NodeId peer) = 0; - virtual void ForgetTxId(const uint256 &txid) = 0; + virtual void ForgetTxId(const uint256 &invid) = 0; virtual std::vector GetRequestable(NodeId peer, std::chrono::microseconds now, ClearExpiredFun clearExpired, EmplaceExpiredFun emplaceExpired) = 0; - virtual void RequestedTx(NodeId peer, const uint256 &txid, + virtual void RequestedTx(NodeId peer, const uint256 &invid, std::chrono::microseconds expiry) = 0; - virtual void ReceivedResponse(NodeId peer, const uint256 &txid) = 0; + virtual void ReceivedResponse(NodeId peer, const uint256 &invid) = 0; virtual size_t CountInFlight(NodeId peer) const = 0; virtual size_t CountCandidates(NodeId peer) const = 0; virtual size_t Count(NodeId peer) const = 0; virtual size_t Size() const = 0; - virtual uint64_t ComputePriority(const uint256 &txid, NodeId peer, + virtual uint64_t ComputePriority(const uint256 &invid, NodeId peer, bool preferred) const = 0; virtual void SanityCheck() const = 0; virtual void @@ -174,34 +174,34 @@ ~TxRequestTracker() = default; // Conceptually, the data structure consists of a collection of - // "announcements", one for each peer/txid combination: + // "announcements", one for each peer/invid combination: // - // - CANDIDATE announcements represent transactions that were announced by a + // - CANDIDATE announcements represent inventories that were announced by a // peer, and that become available for download after their reqtime has // passed. // - // - REQUESTED announcements represent transactions that have been + // - REQUESTED announcements represent inventories that have been // requested, and which we're awaiting a response for from that peer. // Their expiry value determines when the request times out. // - // - COMPLETED announcements represent transactions that have been requested - // from a peer, and a NOTFOUND or a transaction was received in response + // - COMPLETED announcements represent inventories that have been requested + // from a peer, and a NOTFOUND or an inventory was received in response // (valid or not), or they timed out. They're only kept around to prevent - // requesting them again. If only COMPLETED announcements for a given txid - // remain (so no CANDIDATE or REQUESTED ones), all of them are deleted - // (this is an invariant, and maintained by all operations below). + // requesting them again. If only COMPLETED announcements for a given + // invid remain (so no CANDIDATE or REQUESTED ones), all of them are + // deleted (this is an invariant, and maintained by all operations below). // // The operations below manipulate the data structure. /** * Adds a new CANDIDATE announcement. * - * Does nothing if one already exists for that (txid, peer) combination + * Does nothing if one already exists for that (invid, peer) combination * (whether it's CANDIDATE, REQUESTED, or COMPLETED). */ - void ReceivedInv(NodeId peer, const InvId &txid, bool preferred, + void ReceivedInv(NodeId peer, const InvId &invid, bool preferred, std::chrono::microseconds reqtime) { - m_impl->ReceivedInv(peer, txid, preferred, reqtime); + m_impl->ReceivedInv(peer, invid, preferred, reqtime); } /** @@ -212,33 +212,33 @@ void DisconnectedPeer(NodeId peer) { m_impl->DisconnectedPeer(peer); } /** - * Deletes all announcements for a given txid. + * Deletes all announcements for a given invid. * - * This should be called when a transaction is no longer needed. The caller - * should ensure that new announcements for the same txid will not trigger + * This should be called when an inventory is no longer needed. The caller + * should ensure that new announcements for the same invid will not trigger * new ReceivedInv calls, at least in the short term after this call. */ - void ForgetTxId(const InvId &txid) { m_impl->ForgetTxId(txid); } + void ForgetTxId(const InvId &invid) { m_impl->ForgetTxId(invid); } /** - * Find the txids to request now from peer. + * Find the invids to request now from peer. * * It does the following: - * - Convert all REQUESTED announcements (for all txids/peers) with + * - Convert all REQUESTED announcements (for all invids/peers) with * (expiry <= now) to COMPLETED ones. These are returned in expired, if * non-nullptr. * - Requestable announcements are selected: CANDIDATE announcements from * the specified peer with (reqtime <= now) for which no existing - * REQUESTED announcement with the same txid from a different peer + * REQUESTED announcement with the same invid from a different peer * exists, and for which the specified peer is the best choice among all - * (reqtime <= now) CANDIDATE announcements with the same txid (subject + * (reqtime <= now) CANDIDATE announcements with the same invid (subject * to preferredness rules, and tiebreaking using a deterministic salted - * hash of peer and txid). + * hash of peer and invid). * - The selected announcements are returned in announcement order (even * if multiple were added at the same time, or when the clock went * backwards while they were being added). This is done to minimize - * disruption from dependent transactions being requested out of order: - * if multiple dependent transactions are announced simultaneously by one + * disruption from dependent inventories being requested out of order: + * if multiple dependent inventories are announced simultaneously by one * peer, and end up being requested from them, the requests will happen * in announcement order. */ @@ -252,9 +252,9 @@ } }; InvRequestTrackerImplInterface::EmplaceExpiredFun emplaceExpired = - [expired](const NodeId &nodeid, const uint256 &txid) { + [expired](const NodeId &nodeid, const uint256 &invid) { if (expired) { - expired->emplace_back(nodeid, InvId(txid)); + expired->emplace_back(nodeid, InvId(invid)); } }; std::vector hashes = @@ -263,31 +263,32 @@ } /** - * Marks a transaction as requested, with a specified expiry. + * Marks an inventory as requested, with a specified expiry. * - * If no CANDIDATE announcement for the provided peer and txid exists, this + * If no CANDIDATE announcement for the provided peer and invid exists, this * call has no effect. Otherwise: * - That announcement is converted to REQUESTED. - * - If any other REQUESTED announcement for the same txid already + * - If any other REQUESTED announcement for the same invid already * existed, it means an unexpected request was made (GetRequestable will * never advise doing so). In this case it is converted to COMPLETED, as * we're no longer waiting for a response to it. */ - void RequestedTx(NodeId peer, const InvId &txid, + void RequestedTx(NodeId peer, const InvId &invid, std::chrono::microseconds expiry) { - m_impl->RequestedTx(peer, txid, expiry); + m_impl->RequestedTx(peer, invid, expiry); } /** * Converts a CANDIDATE or REQUESTED announcement to a COMPLETED one. If no - * such announcement exists for the provided peer and txid, nothing happens. + * such announcement exists for the provided peer and invid, nothing + * happens. * - * It should be called whenever a transaction or NOTFOUND was received from - * a peer. When the transaction is not needed entirely anymore, ForgetTxId + * It should be called whenever an inventory or NOTFOUND was received from + * a peer. When the inventory is not needed entirely anymore, ForgetTxId * should be called instead of, or in addition to, this call. */ - void ReceivedResponse(NodeId peer, const InvId &txid) { - m_impl->ReceivedResponse(peer, txid); + void ReceivedResponse(NodeId peer, const InvId &invid) { + m_impl->ReceivedResponse(peer, invid); } // The operations below inspect the data structure. @@ -310,14 +311,14 @@ /** * Count how many announcements are being tracked in total across all peers - * and transaction hashes. + * and inventory ids. */ size_t Size() const { return m_impl->Size(); } /** Access to the internal priority computation (testing only) */ - uint64_t ComputePriority(const InvId &txid, NodeId peer, + uint64_t ComputePriority(const InvId &invid, NodeId peer, bool preferred) const { - return m_impl->ComputePriority(txid, peer, preferred); + return m_impl->ComputePriority(invid, peer, preferred); } /** Run internal consistency check (testing only). */ diff --git a/src/txrequest.cpp b/src/txrequest.cpp --- a/src/txrequest.cpp +++ b/src/txrequest.cpp @@ -20,11 +20,11 @@ namespace { /** - * The various states a (txid, peer) pair can be in. + * The various states a (invid, peer) pair can be in. * * Note that CANDIDATE is split up into 3 substates (DELAYED, BEST, READY), * allowing more efficient implementation. Also note that the sorting order of - * ByTxIdView relies on the specific order of values in this enum. + * ByInvIdView relies on the specific order of values in this enum. * * Expected behaviour is: * - When first announced by a peer, the state is CANDIDATE_DELAYED until @@ -37,7 +37,7 @@ * - When requested, an announcement will be in state REQUESTED until expiry * is reached. * - If expiry is reached, or the peer replies to the request (either with - * NOTFOUND or the tx), the state becomes COMPLETED. + * NOTFOUND or the inv), the state becomes COMPLETED. */ enum class State : uint8_t { /** A CANDIDATE announcement whose reqtime is in the future. */ @@ -47,10 +47,10 @@ */ CANDIDATE_READY, /** - * The best CANDIDATE for a given txid; only if there is no REQUESTED - * announcement already for that txid. The CANDIDATE_BEST is the + * The best CANDIDATE for a given invid; only if there is no REQUESTED + * announcement already for that invid. The CANDIDATE_BEST is the * highest-priority announcement among all CANDIDATE_READY (and _BEST) ones - * for that txid. + * for that invid. */ CANDIDATE_BEST, /** A REQUESTED announcement. */ @@ -63,12 +63,12 @@ using SequenceNumber = uint64_t; /** - * An announcement. This is the data we track for each txid that is announced + * An announcement. This is the data we track for each invid that is announced * to us by each peer. */ struct Announcement { - /** TxId that was announced. */ - const uint256 m_txid; + /** InvId that was announced. */ + const uint256 m_invid; /** * For CANDIDATE_{DELAYED,BEST,READY} the reqtime; for REQUESTED the * expiry. @@ -97,7 +97,7 @@ /** * Whether this announcement is selected. There can be at most 1 selected - * peer per txid. + * peer per invid. */ bool IsSelected() const { return GetState() == State::CANDIDATE_BEST || @@ -123,9 +123,9 @@ * Construct a new announcement from scratch, initially in * CANDIDATE_DELAYED state. */ - Announcement(const uint256 &txid, NodeId peer, bool preferred, + Announcement(const uint256 &invid, NodeId peer, bool preferred, std::chrono::microseconds reqtime, SequenceNumber sequence) - : m_txid(txid), m_time(reqtime), m_peer(peer), m_sequence(sequence), + : m_invid(invid), m_time(reqtime), m_peer(peer), m_sequence(sequence), m_preferred(preferred), m_state(static_cast(State::CANDIDATE_DELAYED)) {} }; @@ -146,10 +146,10 @@ : m_k0{deterministic ? 0 : GetRand(0xFFFFFFFFFFFFFFFF)}, m_k1{deterministic ? 0 : GetRand(0xFFFFFFFFFFFFFFFF)} {} - Priority operator()(const uint256 &txid, NodeId peer, + Priority operator()(const uint256 &invid, NodeId peer, bool preferred) const { uint64_t low_bits = CSipHasher(m_k0, m_k1) - .Write(txid.begin(), txid.size()) + .Write(invid.begin(), invid.size()) .Write(peer) .Finalize() >> 1; @@ -157,7 +157,7 @@ } Priority operator()(const Announcement &ann) const { - return operator()(ann.m_txid, ann.m_peer, ann.m_preferred); + return operator()(ann.m_invid, ann.m_peer, ann.m_preferred); } }; @@ -169,11 +169,11 @@ // https://www.boost.org/doc/libs/1_58_0/libs/multi_index/doc/reference/key_extraction.html#key_extractors // for more information about the key extraction concept. -// The ByPeer index is sorted by (peer, state == CANDIDATE_BEST, txid) +// The ByPeer index is sorted by (peer, state == CANDIDATE_BEST, invid) // // Uses: -// * Looking up existing announcements by peer/txid, by checking both (peer, -// false, txid) and (peer, true, txid). +// * Looking up existing announcements by peer/invid, by checking both (peer, +// false, invid) and (peer, true, invid). // * Finding all CANDIDATE_BEST announcements for a given peer in // GetRequestable. struct ByPeer {}; @@ -182,33 +182,33 @@ using result_type = ByPeerView; result_type operator()(const Announcement &ann) const { return ByPeerView{ann.m_peer, ann.GetState() == State::CANDIDATE_BEST, - ann.m_txid}; + ann.m_invid}; } }; -// The ByTxId index is sorted by (txid, state, priority). +// The ByInvId index is sorted by (invid, state, priority). // // Note: priority == 0 whenever state != CANDIDATE_READY. // // Uses: -// * Deleting all announcements with a given txid in ForgetTxId. +// * Deleting all announcements with a given invid in ForgetTxId. // * Finding the best CANDIDATE_READY to convert to CANDIDATE_BEST, when no -// other CANDIDATE_READY or REQUESTED announcement exists for that txid. -// * Determining when no more non-COMPLETED announcements for a given txid +// other CANDIDATE_READY or REQUESTED announcement exists for that invid. +// * Determining when no more non-COMPLETED announcements for a given invid // exist, so the COMPLETED ones can be deleted. -struct ByTxId {}; -using ByTxIdView = std::tuple; -class ByTxIdViewExtractor { +struct ByInvId {}; +using ByInvIdView = std::tuple; +class ByInvIdViewExtractor { const PriorityComputer &m_computer; public: - ByTxIdViewExtractor(const PriorityComputer &computer) + ByInvIdViewExtractor(const PriorityComputer &computer) : m_computer(computer) {} - using result_type = ByTxIdView; + using result_type = ByInvIdView; result_type operator()(const Announcement &ann) const { const Priority prio = (ann.GetState() == State::CANDIDATE_READY) ? m_computer(ann) : 0; - return ByTxIdView{ann.m_txid, ann.GetState(), prio}; + return ByInvIdView{ann.m_invid, ann.GetState(), prio}; } }; @@ -255,15 +255,15 @@ /** * Data type for the main data structure (Announcement objects with - * ByPeer/ByTxId/ByTime indexes). + * ByPeer/ByInvId/ByTime indexes). */ using Index = boost::multi_index_container< Announcement, boost::multi_index::indexed_by< boost::multi_index::ordered_unique, ByPeerViewExtractor>, - boost::multi_index::ordered_non_unique, - ByTxIdViewExtractor>, + boost::multi_index::ordered_non_unique, + ByInvIdViewExtractor>, boost::multi_index::ordered_non_unique, ByTimeViewExtractor>>>; @@ -280,15 +280,15 @@ size_t m_requested = 0; }; -/** Per-txid statistics object. Only used for sanity checking. */ -struct TxIdInfo { - //! Number of CANDIDATE_DELAYED announcements for this txid. +/** Per-invid statistics object. Only used for sanity checking. */ +struct InvIdInfo { + //! Number of CANDIDATE_DELAYED announcements for this invid. size_t m_candidate_delayed = 0; - //! Number of CANDIDATE_READY announcements for this txid. + //! Number of CANDIDATE_READY announcements for this invid. size_t m_candidate_ready = 0; - //! Number of CANDIDATE_BEST announcements for this txid (at most one). + //! Number of CANDIDATE_BEST announcements for this invid (at most one). size_t m_candidate_best = 0; - //! Number of REQUESTED announcements for this txid (at most one; mutually + //! Number of REQUESTED announcements for this invid (at most one; mutually //! exclusive with CANDIDATE_BEST). size_t m_requested = 0; //! The priority of the CANDIDATE_BEST announcement if one exists, or max() @@ -298,7 +298,7 @@ //! none exist). Priority m_priority_best_candidate_ready = std::numeric_limits::min(); - //! All peers we have an announcement for this txid for. + //! All peers we have an announcement for this invid for. std::vector m_peers; }; @@ -322,13 +322,13 @@ return ret; } -/** Compute the TxIdInfo map. Only used for sanity checking. */ -std::map ComputeTxIdInfo(const Index &index, - const PriorityComputer &computer) { - std::map ret; +/** Compute the InvIdInfo map. Only used for sanity checking. */ +std::map +ComputeInvIdInfo(const Index &index, const PriorityComputer &computer) { + std::map ret; for (const Announcement &ann : index) { - TxIdInfo &info = ret[ann.m_txid]; - // Classify how many announcements of each state we have for this txid. + InvIdInfo &info = ret[ann.m_invid]; + // Classify how many announcements of each state we have for this invid. info.m_candidate_delayed += (ann.GetState() == State::CANDIDATE_DELAYED); info.m_candidate_ready += (ann.GetState() == State::CANDIDATE_READY); @@ -343,7 +343,7 @@ info.m_priority_best_candidate_ready = std::max(info.m_priority_best_candidate_ready, computer(ann)); } - // Also keep track of which peers this txid has an announcement for + // Also keep track of which peers this invid has an announcement for // (so we can detect duplicates). info.m_peers.push_back(ann.m_peer); } @@ -355,7 +355,7 @@ /** Actual implementation for TxRequestTracker's data structure. */ class InvRequestTrackerImpl : public InvRequestTrackerImplInterface { //! The current sequence number. Increases for every announcement. This is - //! used to sort txid returned by GetRequestable in announcement order. + //! used to sort invid returned by GetRequestable in announcement order. SequenceNumber m_current_sequence{0}; //! This tracker's priority computer. @@ -375,12 +375,12 @@ // invariant that no PeerInfo announcements with m_total==0 exist. assert(m_peerinfo == RecomputePeerInfo(m_index)); - // Calculate per-txid statistics from m_index, and validate + // Calculate per-invid statistics from m_index, and validate // invariants. - for (auto &item : ComputeTxIdInfo(m_index, m_computer)) { - TxIdInfo &info = item.second; + for (auto &item : ComputeInvIdInfo(m_index, m_computer)) { + InvIdInfo &info = item.second; - // Cannot have only COMPLETED peer (txid should have been forgotten + // Cannot have only COMPLETED peer (invid should have been forgotten // already) assert(info.m_candidate_delayed + info.m_candidate_ready + info.m_candidate_best + info.m_requested > @@ -403,7 +403,7 @@ info.m_priority_best_candidate_ready); } - // No txid can have been announced by the same peer twice. + // No invid can have been announced by the same peer twice. std::sort(info.m_peers.begin(), info.m_peers.end()); assert( std::adjacent_find(info.m_peers.begin(), info.m_peers.end()) == @@ -455,26 +455,26 @@ //! makes it the new best CANDIDATE_READY (and no REQUESTED exists) and //! better than the CANDIDATE_BEST (if any), it becomes the new //! CANDIDATE_BEST. - void PromoteCandidateReady(Iter it) { - assert(it != m_index.get().end()); + void PromoteCandidateReady(Iter it) { + assert(it != m_index.get().end()); assert(it->GetState() == State::CANDIDATE_DELAYED); // Convert CANDIDATE_DELAYED to CANDIDATE_READY first. - Modify(it, [](Announcement &ann) { + Modify(it, [](Announcement &ann) { ann.SetState(State::CANDIDATE_READY); }); - // The following code relies on the fact that the ByTxId is sorted by - // txid, and then by state (first _DELAYED, then _READY, then + // The following code relies on the fact that the ByInvId is sorted by + // invid, and then by state (first _DELAYED, then _READY, then // _BEST/REQUESTED). Within the _READY announcements, the best one // (highest priority) comes last. Thus, if an existing _BEST exists for - // the same txid that this announcement may be preferred over, it must + // the same invid that this announcement may be preferred over, it must // immediately follow the newly created _READY. auto it_next = std::next(it); - if (it_next == m_index.get().end() || - it_next->m_txid != it->m_txid || + if (it_next == m_index.get().end() || + it_next->m_invid != it->m_invid || it_next->GetState() == State::COMPLETED) { // This is the new best CANDIDATE_READY, and there is no - // IsSelected() announcement for this txid already. - Modify(it, [](Announcement &ann) { + // IsSelected() announcement for this invid already. + Modify(it, [](Announcement &ann) { ann.SetState(State::CANDIDATE_BEST); }); } else if (it_next->GetState() == State::CANDIDATE_BEST) { @@ -483,10 +483,10 @@ if (priority_new > priority_old) { // There is a CANDIDATE_BEST announcement already, but this one // is better. - Modify(it_next, [](Announcement &ann) { + Modify(it_next, [](Announcement &ann) { ann.SetState(State::CANDIDATE_READY); }); - Modify(it, [](Announcement &ann) { + Modify(it, [](Announcement &ann) { ann.SetState(State::CANDIDATE_BEST); }); } @@ -496,46 +496,46 @@ //! Change the state of an announcement to something non-IsSelected(). If it //! was IsSelected(), the next best announcement will be marked //! CANDIDATE_BEST. - void ChangeAndReselect(Iter it, State new_state) { + void ChangeAndReselect(Iter it, State new_state) { assert(new_state == State::COMPLETED || new_state == State::CANDIDATE_DELAYED); - assert(it != m_index.get().end()); - if (it->IsSelected() && it != m_index.get().begin()) { + assert(it != m_index.get().end()); + if (it->IsSelected() && it != m_index.get().begin()) { auto it_prev = std::prev(it); // The next best CANDIDATE_READY, if any, immediately precedes the - // REQUESTED or CANDIDATE_BEST announcement in the ByTxId index. - if (it_prev->m_txid == it->m_txid && + // REQUESTED or CANDIDATE_BEST announcement in the ByInvId index. + if (it_prev->m_invid == it->m_invid && it_prev->GetState() == State::CANDIDATE_READY) { - // If one such CANDIDATE_READY exists (for this txid), convert + // If one such CANDIDATE_READY exists (for this invid), convert // it to CANDIDATE_BEST. - Modify(it_prev, [](Announcement &ann) { + Modify(it_prev, [](Announcement &ann) { ann.SetState(State::CANDIDATE_BEST); }); } } - Modify( + Modify( it, [new_state](Announcement &ann) { ann.SetState(new_state); }); } - //! Check if 'it' is the only announcement for a given txid that isn't + //! Check if 'it' is the only announcement for a given invid that isn't //! COMPLETED. - bool IsOnlyNonCompleted(Iter it) { - assert(it != m_index.get().end()); + bool IsOnlyNonCompleted(Iter it) { + assert(it != m_index.get().end()); // Not allowed to call this on COMPLETED announcements. assert(it->GetState() != State::COMPLETED); - // This announcement has a predecessor that belongs to the same txid. + // This announcement has a predecessor that belongs to the same invid. // Due to ordering, and the fact that 'it' is not COMPLETED, its // predecessor cannot be COMPLETED here. - if (it != m_index.get().begin() && - std::prev(it)->m_txid == it->m_txid) { + if (it != m_index.get().begin() && + std::prev(it)->m_invid == it->m_invid) { return false; } - // This announcement has a successor that belongs to the same txid, + // This announcement has a successor that belongs to the same invid, // and is not COMPLETED. - if (std::next(it) != m_index.get().end() && - std::next(it)->m_txid == it->m_txid && + if (std::next(it) != m_index.get().end() && + std::next(it)->m_invid == it->m_invid && std::next(it)->GetState() != State::COMPLETED) { return false; } @@ -545,13 +545,13 @@ /** * Convert any announcement to a COMPLETED one. If there are no - * non-COMPLETED announcements left for this txid, they are deleted. If + * non-COMPLETED announcements left for this invid, they are deleted. If * this was a REQUESTED announcement, and there are other CANDIDATEs left, * the best one is made CANDIDATE_BEST. Returns whether the announcement * still exists. */ - bool MakeCompleted(Iter it) { - assert(it != m_index.get().end()); + bool MakeCompleted(Iter it) { + assert(it != m_index.get().end()); // Nothing to be done if it's already COMPLETED. if (it->GetState() == State::COMPLETED) { @@ -559,12 +559,13 @@ } if (IsOnlyNonCompleted(it)) { - // This is the last non-COMPLETED announcement for this txid. + // This is the last non-COMPLETED announcement for this invid. // Delete all. - uint256 txid = it->m_txid; + uint256 invid = it->m_invid; do { - it = Erase(it); - } while (it != m_index.get().end() && it->m_txid == txid); + it = Erase(it); + } while (it != m_index.get().end() && + it->m_invid == invid); return false; } @@ -592,11 +593,11 @@ auto it = m_index.get().begin(); if (it->GetState() == State::CANDIDATE_DELAYED && it->m_time <= now) { - PromoteCandidateReady(m_index.project(it)); + PromoteCandidateReady(m_index.project(it)); } else if (it->GetState() == State::REQUESTED && it->m_time <= now) { - emplaceExpired(it->m_peer, it->m_txid); - MakeCompleted(m_index.project(it)); + emplaceExpired(it->m_peer, it->m_invid); + MakeCompleted(m_index.project(it)); } else { break; } @@ -610,7 +611,7 @@ // TxRequestTracker::Impl's behaviour. auto it = std::prev(m_index.get().end()); if (it->IsSelectable() && it->m_time > now) { - ChangeAndReselect(m_index.project(it), + ChangeAndReselect(m_index.project(it), State::CANDIDATE_DELAYED); } else { break; @@ -622,16 +623,16 @@ InvRequestTrackerImpl(bool deterministic) : m_computer(deterministic), // Explicitly initialize m_index as we need to pass a reference to - // m_computer to ByTxHashViewExtractor. + // m_computer to ByInvIdViewExtractor. m_index(boost::make_tuple( boost::make_tuple(ByPeerViewExtractor(), std::less()), - boost::make_tuple(ByTxIdViewExtractor(m_computer), - std::less()), + boost::make_tuple(ByInvIdViewExtractor(m_computer), + std::less()), boost::make_tuple(ByTimeViewExtractor(), std::less()))) {} // Disable copying and assigning (a default copy won't work due the stateful - // ByTxIdViewExtractor). + // ByInvIdViewExtractor). InvRequestTrackerImpl(const InvRequestTrackerImpl &) = delete; InvRequestTrackerImpl &operator=(const InvRequestTrackerImpl &) = delete; @@ -648,29 +649,29 @@ // - std::next(it) is end() or belongs to a different peer. In that // case, this is the last iteration of the loop (denote this by // setting it_next to end()). - // - 'it' is not the only non-COMPLETED announcement for its txid. + // - 'it' is not the only non-COMPLETED announcement for its invid. // This means it will be deleted, but no other Announcement // objects will be modified. Continue with std::next(it) if it // belongs to the same peer, but decide this ahead of time (as // 'it' may change position in what follows). - // - 'it' is the only non-COMPLETED announcement for its txid. This + // - 'it' is the only non-COMPLETED announcement for its invid. This // means it will be deleted along with all other announcements for - // the same txid - which may include std::next(it). However, other - // than 'it', no announcements for the same peer can be affected - // (due to (peer, txid) uniqueness). In other words, the situation - // where std::next(it) is deleted can only occur if std::next(it) - // belongs to a different peer but the same txid as 'it'. This is - // covered by the first bulletpoint already, and we'll have set - // it_next to end(). + // the same invid - which may include std::next(it). However, + // other than 'it', no announcements for the same peer can be + // affected (due to (peer, invid) uniqueness). In other words, the + // situation where std::next(it) is deleted can only occur if + // std::next(it) belongs to a different peer but the same invid as + // 'it'. This is covered by the first bulletpoint already, and + // we'll have set it_next to end(). auto it_next = (std::next(it) == index.end() || std::next(it)->m_peer != peer) ? index.end() : std::next(it); // If the announcement isn't already COMPLETED, first make it // COMPLETED (which will mark other CANDIDATEs as CANDIDATE_BEST, or - // delete all of a txid's announcements if no non-COMPLETED ones are - // left). - if (MakeCompleted(m_index.project(it))) { + // delete all of a invid's announcements if no non-COMPLETED ones + // are left). + if (MakeCompleted(m_index.project(it))) { // Then actually delete the announcement (unless it was already // deleted by MakeCompleted). Erase(it); @@ -679,31 +680,31 @@ } } - void ForgetTxId(const uint256 &txid) { - auto it = m_index.get().lower_bound( - ByTxIdView{txid, State::CANDIDATE_DELAYED, 0}); - while (it != m_index.get().end() && it->m_txid == txid) { - it = Erase(it); + void ForgetTxId(const uint256 &invid) { + auto it = m_index.get().lower_bound( + ByInvIdView{invid, State::CANDIDATE_DELAYED, 0}); + while (it != m_index.get().end() && it->m_invid == invid) { + it = Erase(it); } } - void ReceivedInv(NodeId peer, const uint256 &txid, bool preferred, + void ReceivedInv(NodeId peer, const uint256 &invid, bool preferred, std::chrono::microseconds reqtime) { // Bail out if we already have a CANDIDATE_BEST announcement for this - // (txid, peer) combination. The case where there is a + // (invid, peer) combination. The case where there is a // non-CANDIDATE_BEST announcement already will be caught by the // uniqueness property of the ByPeer index when we try to emplace the // new object below. - if (m_index.get().count(ByPeerView{peer, true, txid})) { + if (m_index.get().count(ByPeerView{peer, true, invid})) { return; } // Try creating the announcement with CANDIDATE_DELAYED state (which // will fail due to the uniqueness of the ByPeer index if a - // non-CANDIDATE_BEST announcement already exists with the same txid + // non-CANDIDATE_BEST announcement already exists with the same invid // and peer). Bail out in that case. - auto ret = m_index.get().emplace(txid, peer, preferred, reqtime, - m_current_sequence); + auto ret = m_index.get().emplace(invid, peer, preferred, + reqtime, m_current_sequence); if (!ret.second) { return; } @@ -713,7 +714,7 @@ ++m_current_sequence; } - //! Find the TxIds to request now from peer. + //! Find the InvIds to request now from peer. std::vector GetRequestable(NodeId peer, std::chrono::microseconds now, ClearExpiredFun clearExpired, @@ -738,33 +739,33 @@ return a->m_sequence < b->m_sequence; }); - // Convert to TxId and return. + // Convert to InvId and return. std::vector ret; ret.reserve(selected.size()); std::transform(selected.begin(), selected.end(), std::back_inserter(ret), - [](const Announcement *ann) { return ann->m_txid; }); + [](const Announcement *ann) { return ann->m_invid; }); return ret; } - void RequestedTx(NodeId peer, const uint256 &txid, + void RequestedTx(NodeId peer, const uint256 &invid, std::chrono::microseconds expiry) { - auto it = m_index.get().find(ByPeerView{peer, true, txid}); + auto it = m_index.get().find(ByPeerView{peer, true, invid}); if (it == m_index.get().end()) { // There is no CANDIDATE_BEST announcement, look for a _READY or // _DELAYED instead. If the caller only ever invokes RequestedTx // with the values returned by GetRequestable, and no other - // non-const functions other than ForgetTxHash and GetRequestable in - // between, this branch will never execute (as txids returned by + // non-const functions other than ForgetTxId and GetRequestable in + // between, this branch will never execute (as invids returned by // GetRequestable always correspond to CANDIDATE_BEST // announcements). - it = m_index.get().find(ByPeerView{peer, false, txid}); + it = m_index.get().find(ByPeerView{peer, false, invid}); if (it == m_index.get().end() || (it->GetState() != State::CANDIDATE_DELAYED && it->GetState() != State::CANDIDATE_READY)) { // There is no CANDIDATE announcement tracked for this peer, so - // we have nothing to do. Either this txid wasn't tracked at + // we have nothing to do. Either this invid wasn't tracked at // all (and the caller should have called ReceivedInv), or it // was already requested and/or completed for other reasons and // this is just a superfluous RequestedTx call. @@ -772,17 +773,17 @@ } // Look for an existing CANDIDATE_BEST or REQUESTED with the same - // txid. We only need to do this if the found announcement had a + // invid. We only need to do this if the found announcement had a // different state than CANDIDATE_BEST. If it did, invariants // guarantee that no other CANDIDATE_BEST or REQUESTED can exist. - auto it_old = m_index.get().lower_bound( - ByTxIdView{txid, State::CANDIDATE_BEST, 0}); - if (it_old != m_index.get().end() && - it_old->m_txid == txid) { + auto it_old = m_index.get().lower_bound( + ByInvIdView{invid, State::CANDIDATE_BEST, 0}); + if (it_old != m_index.get().end() && + it_old->m_invid == invid) { if (it_old->GetState() == State::CANDIDATE_BEST) { // The data structure's invariants require that there can be // at most one CANDIDATE_BEST or one REQUESTED announcement - // per txid (but not both simultaneously), so we have to + // per invid (but not both simultaneously), so we have to // convert any existing CANDIDATE_BEST to another // CANDIDATE_* when constructing another REQUESTED. It // doesn't matter whether we pick CANDIDATE_READY or @@ -790,14 +791,14 @@ // GetRequestable() time. If time only goes forward, it will // always be _READY, so pick that to avoid extra work in // SetTimePoint(). - Modify(it_old, [](Announcement &ann) { + Modify(it_old, [](Announcement &ann) { ann.SetState(State::CANDIDATE_READY); }); } else if (it_old->GetState() == State::REQUESTED) { // As we're no longer waiting for a response to the previous // REQUESTED announcement, convert it to COMPLETED. This // also helps guaranteeing progress. - Modify(it_old, [](Announcement &ann) { + Modify(it_old, [](Announcement &ann) { ann.SetState(State::COMPLETED); }); } @@ -810,15 +811,15 @@ }); } - void ReceivedResponse(NodeId peer, const uint256 &txid) { - // We need to search the ByPeer index for both (peer, false, txid) and - // (peer, true, txid). - auto it = m_index.get().find(ByPeerView{peer, false, txid}); + void ReceivedResponse(NodeId peer, const uint256 &invid) { + // We need to search the ByPeer index for both (peer, false, invid) and + // (peer, true, invid). + auto it = m_index.get().find(ByPeerView{peer, false, invid}); if (it == m_index.get().end()) { - it = m_index.get().find(ByPeerView{peer, true, txid}); + it = m_index.get().find(ByPeerView{peer, true, invid}); } if (it != m_index.get().end()) { - MakeCompleted(m_index.project(it)); + MakeCompleted(m_index.project(it)); } } @@ -851,10 +852,10 @@ //! and transactions. size_t Size() const { return m_index.size(); } - uint64_t ComputePriority(const uint256 &txid, NodeId peer, + uint64_t ComputePriority(const uint256 &invid, NodeId peer, bool preferred) const { // Return Priority as a uint64_t as Priority is internal. - return uint64_t{m_computer(txid, peer, preferred)}; + return uint64_t{m_computer(invid, peer, preferred)}; } };