Branch data Line data Source code
1 : : // Copyright (c) 2021-2022 The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <txorphanage.h>
6 : :
7 : : #include <consensus/validation.h>
8 : : #include <logging.h>
9 : : #include <policy/policy.h>
10 : : #include <primitives/transaction.h>
11 : : #include <util/time.h>
12 : :
13 : : #include <cassert>
14 : :
15 : 168 : bool TxOrphanage::AddTx(const CTransactionRef& tx, NodeId peer)
16 : : {
17 : 168 : const Txid& hash = tx->GetHash();
18 : 168 : const Wtxid& wtxid = tx->GetWitnessHash();
19 [ + + ]: 168 : if (m_orphans.count(wtxid))
20 : : return false;
21 : :
22 : : // Ignore big transactions, to avoid a
23 : : // send-big-orphans memory exhaustion attack. If a peer has a legitimate
24 : : // large transaction with a missing parent then we assume
25 : : // it will rebroadcast it later, after the parent transaction(s)
26 : : // have been mined or received.
27 : : // 100 orphans, each of which is at most 100,000 bytes big is
28 : : // at most 10 megabytes of orphans and somewhat more byprev index (in the worst case):
29 : 148 : unsigned int sz = GetTransactionWeight(*tx);
30 [ + + ]: 148 : if (sz > MAX_STANDARD_TX_WEIGHT)
31 : : {
32 [ + - + - : 22 : LogDebug(BCLog::TXPACKAGES, "ignoring large orphan tx (size: %u, txid: %s, wtxid: %s)\n", sz, hash.ToString(), wtxid.ToString());
+ - ]
33 : 11 : return false;
34 : : }
35 : :
36 [ + - + - ]: 274 : auto ret = m_orphans.emplace(wtxid, OrphanTx{{tx, peer, Now<NodeSeconds>() + ORPHAN_TX_EXPIRE_TIME}, m_orphan_list.size()});
37 [ - + ]: 137 : assert(ret.second);
38 : 137 : m_orphan_list.push_back(ret.first);
39 [ + + ]: 325 : for (const CTxIn& txin : tx->vin) {
40 : 188 : m_outpoint_to_orphan_it[txin.prevout].insert(ret.first);
41 : : }
42 : :
43 [ + - + - : 274 : LogDebug(BCLog::TXPACKAGES, "stored orphan tx %s (wtxid=%s), weight: %u (mapsz %u outsz %u)\n", hash.ToString(), wtxid.ToString(), sz,
+ - ]
44 : : m_orphans.size(), m_outpoint_to_orphan_it.size());
45 : : return true;
46 : : }
47 : :
48 : 132 : int TxOrphanage::EraseTx(const Wtxid& wtxid)
49 : : {
50 : 132 : std::map<Wtxid, OrphanTx>::iterator it = m_orphans.find(wtxid);
51 [ + + ]: 132 : if (it == m_orphans.end())
52 : : return 0;
53 [ + + ]: 166 : for (const CTxIn& txin : it->second.tx->vin)
54 : : {
55 : 83 : auto itPrev = m_outpoint_to_orphan_it.find(txin.prevout);
56 [ - + ]: 83 : if (itPrev == m_outpoint_to_orphan_it.end())
57 : 0 : continue;
58 : 83 : itPrev->second.erase(it);
59 [ + + ]: 83 : if (itPrev->second.empty())
60 : 82 : m_outpoint_to_orphan_it.erase(itPrev);
61 : : }
62 : :
63 [ - + ]: 83 : size_t old_pos = it->second.list_pos;
64 [ - + ]: 83 : assert(m_orphan_list[old_pos] == it);
65 [ + + ]: 83 : if (old_pos + 1 != m_orphan_list.size()) {
66 : : // Unless we're deleting the last entry in m_orphan_list, move the last
67 : : // entry to the position we're deleting.
68 : 72 : auto it_last = m_orphan_list.back();
69 : 72 : m_orphan_list[old_pos] = it_last;
70 : 72 : it_last->second.list_pos = old_pos;
71 : : }
72 : 83 : const auto& txid = it->second.tx->GetHash();
73 : : // Time spent in orphanage = difference between current and entry time.
74 : : // Entry time is equal to ORPHAN_TX_EXPIRE_TIME earlier than entry's expiry.
75 [ + - + - : 166 : LogDebug(BCLog::TXPACKAGES, " removed orphan tx %s (wtxid=%s) after %ds\n", txid.ToString(), wtxid.ToString(),
+ - ]
76 : : Ticks<std::chrono::seconds>(NodeClock::now() + ORPHAN_TX_EXPIRE_TIME - it->second.nTimeExpire));
77 : 83 : m_orphan_list.pop_back();
78 : :
79 : 83 : m_orphans.erase(it);
80 : 83 : return 1;
81 : : }
82 : :
83 : 29 : void TxOrphanage::EraseForPeer(NodeId peer)
84 : : {
85 : 29 : m_peer_work_set.erase(peer);
86 : :
87 : 29 : int nErased = 0;
88 : 29 : std::map<Wtxid, OrphanTx>::iterator iter = m_orphans.begin();
89 [ + + ]: 372 : while (iter != m_orphans.end())
90 : : {
91 : : // increment to avoid iterator becoming invalid after erasure
92 [ + + ]: 314 : const auto& [wtxid, orphan] = *iter++;
93 [ + + ]: 314 : if (orphan.fromPeer == peer) {
94 : 6 : nErased += EraseTx(wtxid);
95 : : }
96 : : }
97 [ + + + - ]: 29 : if (nErased > 0) LogDebug(BCLog::TXPACKAGES, "Erased %d orphan transaction(s) from peer=%d\n", nErased, peer);
98 : 29 : }
99 : :
100 : 53 : void TxOrphanage::LimitOrphans(unsigned int max_orphans, FastRandomContext& rng)
101 : : {
102 : 53 : unsigned int nEvicted = 0;
103 : 53 : auto nNow{Now<NodeSeconds>()};
104 [ + + ]: 53 : if (m_next_sweep <= nNow) {
105 : : // Sweep out expired orphan pool entries:
106 : 43 : int nErased = 0;
107 : 43 : auto nMinExpTime{nNow + ORPHAN_TX_EXPIRE_TIME - ORPHAN_TX_EXPIRE_INTERVAL};
108 : 43 : std::map<Wtxid, OrphanTx>::iterator iter = m_orphans.begin();
109 [ + + ]: 159 : while (iter != m_orphans.end())
110 : : {
111 : 116 : std::map<Wtxid, OrphanTx>::iterator maybeErase = iter++;
112 [ + + ]: 116 : if (maybeErase->second.nTimeExpire <= nNow) {
113 : 1 : nErased += EraseTx(maybeErase->second.tx->GetWitnessHash());
114 : : } else {
115 : 115 : nMinExpTime = std::min(maybeErase->second.nTimeExpire, nMinExpTime);
116 : : }
117 : : }
118 : : // Sweep again 5 minutes after the next entry that expires in order to batch the linear scan.
119 : 43 : m_next_sweep = nMinExpTime + ORPHAN_TX_EXPIRE_INTERVAL;
120 [ + + + - ]: 43 : if (nErased > 0) LogDebug(BCLog::TXPACKAGES, "Erased %d orphan tx due to expiration\n", nErased);
121 : : }
122 [ + + ]: 127 : while (m_orphans.size() > max_orphans)
123 : : {
124 : : // Evict a random orphan:
125 : 74 : size_t randompos = rng.randrange(m_orphan_list.size());
126 : 74 : EraseTx(m_orphan_list[randompos]->second.tx->GetWitnessHash());
127 : 74 : ++nEvicted;
128 : : }
129 [ + + + - ]: 53 : if (nEvicted > 0) LogDebug(BCLog::TXPACKAGES, "orphanage overflow, removed %u tx\n", nEvicted);
130 : 53 : }
131 : :
132 : 0 : void TxOrphanage::AddChildrenToWorkSet(const CTransaction& tx)
133 : : {
134 [ # # ]: 0 : for (unsigned int i = 0; i < tx.vout.size(); i++) {
135 : 0 : const auto it_by_prev = m_outpoint_to_orphan_it.find(COutPoint(tx.GetHash(), i));
136 [ # # ]: 0 : if (it_by_prev != m_outpoint_to_orphan_it.end()) {
137 [ # # ]: 0 : for (const auto& elem : it_by_prev->second) {
138 : : // Get this source peer's work set, emplacing an empty set if it didn't exist
139 : : // (note: if this peer wasn't still connected, we would have removed the orphan tx already)
140 : 0 : std::set<Wtxid>& orphan_work_set = m_peer_work_set.try_emplace(elem->second.fromPeer).first->second;
141 : : // Add this tx to the work set
142 : 0 : orphan_work_set.insert(elem->first);
143 [ # # # # : 0 : LogDebug(BCLog::TXPACKAGES, "added %s (wtxid=%s) to peer %d workset\n",
# # ]
144 : : tx.GetHash().ToString(), tx.GetWitnessHash().ToString(), elem->second.fromPeer);
145 : : }
146 : : }
147 : : }
148 : 0 : }
149 : :
150 : 276 : bool TxOrphanage::HaveTx(const Wtxid& wtxid) const
151 : : {
152 : 276 : return m_orphans.count(wtxid);
153 : : }
154 : :
155 : 2 : CTransactionRef TxOrphanage::GetTxToReconsider(NodeId peer)
156 : : {
157 : 2 : auto work_set_it = m_peer_work_set.find(peer);
158 [ - + ]: 2 : if (work_set_it != m_peer_work_set.end()) {
159 : 0 : auto& work_set = work_set_it->second;
160 [ # # ]: 0 : while (!work_set.empty()) {
161 : 0 : Wtxid wtxid = *work_set.begin();
162 : 0 : work_set.erase(work_set.begin());
163 : :
164 : 0 : const auto orphan_it = m_orphans.find(wtxid);
165 [ # # ]: 0 : if (orphan_it != m_orphans.end()) {
166 [ # # ]: 0 : return orphan_it->second.tx;
167 : : }
168 : : }
169 : : }
170 : 2 : return nullptr;
171 : : }
172 : :
173 : 2 : bool TxOrphanage::HaveTxToReconsider(NodeId peer)
174 : : {
175 : 2 : auto work_set_it = m_peer_work_set.find(peer);
176 [ - + ]: 2 : if (work_set_it != m_peer_work_set.end()) {
177 : 0 : auto& work_set = work_set_it->second;
178 : 0 : return !work_set.empty();
179 : : }
180 : : return false;
181 : : }
182 : :
183 : 2 : void TxOrphanage::EraseForBlock(const CBlock& block)
184 : : {
185 : 2 : std::vector<Wtxid> vOrphanErase;
186 : :
187 [ + + ]: 4 : for (const CTransactionRef& ptx : block.vtx) {
188 : 2 : const CTransaction& tx = *ptx;
189 : :
190 : : // Which orphan pool entries must we evict?
191 [ + + ]: 4 : for (const auto& txin : tx.vin) {
192 : 2 : auto itByPrev = m_outpoint_to_orphan_it.find(txin.prevout);
193 [ + - ]: 2 : if (itByPrev == m_outpoint_to_orphan_it.end()) continue;
194 [ # # ]: 0 : for (auto mi = itByPrev->second.begin(); mi != itByPrev->second.end(); ++mi) {
195 [ # # ]: 0 : const CTransaction& orphanTx = *(*mi)->second.tx;
196 [ # # ]: 0 : vOrphanErase.push_back(orphanTx.GetWitnessHash());
197 : : }
198 : : }
199 : : }
200 : :
201 : : // Erase orphan transactions included or precluded by this block
202 [ - + ]: 2 : if (vOrphanErase.size()) {
203 : 0 : int nErased = 0;
204 [ # # ]: 0 : for (const auto& orphanHash : vOrphanErase) {
205 [ # # ]: 0 : nErased += EraseTx(orphanHash);
206 : : }
207 [ # # # # : 0 : LogDebug(BCLog::TXPACKAGES, "Erased %d orphan transaction(s) included or conflicted by block\n", nErased);
# # ]
208 : : }
209 : 2 : }
210 : :
211 : 15 : std::vector<CTransactionRef> TxOrphanage::GetChildrenFromSamePeer(const CTransactionRef& parent, NodeId nodeid) const
212 : : {
213 : : // First construct a vector of iterators to ensure we do not return duplicates of the same tx
214 : : // and so we can sort by nTimeExpire.
215 : 15 : std::vector<OrphanMap::iterator> iters;
216 : :
217 : : // For each output, get all entries spending this prevout, filtering for ones from the specified peer.
218 [ + + ]: 41 : for (unsigned int i = 0; i < parent->vout.size(); i++) {
219 : 26 : const auto it_by_prev = m_outpoint_to_orphan_it.find(COutPoint(parent->GetHash(), i));
220 [ + + ]: 26 : if (it_by_prev != m_outpoint_to_orphan_it.end()) {
221 [ + + ]: 43 : for (const auto& elem : it_by_prev->second) {
222 [ + + ]: 26 : if (elem->second.fromPeer == nodeid) {
223 [ + - ]: 14 : iters.emplace_back(elem);
224 : : }
225 : : }
226 : : }
227 : : }
228 : :
229 : : // Sort by address so that duplicates can be deleted. At the same time, sort so that more recent
230 : : // orphans (which expire later) come first. Break ties based on address, as nTimeExpire is
231 : : // quantified in seconds and it is possible for orphans to have the same expiry.
232 [ + - ]: 29 : std::sort(iters.begin(), iters.end(), [](const auto& lhs, const auto& rhs) {
233 [ + - ]: 14 : if (lhs->second.nTimeExpire == rhs->second.nTimeExpire) {
234 : 14 : return &(*lhs) < &(*rhs);
235 : : } else {
236 : 0 : return lhs->second.nTimeExpire > rhs->second.nTimeExpire;
237 : : }
238 : : });
239 : : // Erase duplicates
240 : 15 : iters.erase(std::unique(iters.begin(), iters.end()), iters.end());
241 : :
242 : : // Convert to a vector of CTransactionRef
243 : 15 : std::vector<CTransactionRef> children_found;
244 [ + - ]: 15 : children_found.reserve(iters.size());
245 [ + + ]: 27 : for (const auto& child_iter : iters) {
246 [ + - ]: 12 : children_found.emplace_back(child_iter->second.tx);
247 : : }
248 : 15 : return children_found;
249 : 15 : }
250 : :
251 : 12 : std::vector<std::pair<CTransactionRef, NodeId>> TxOrphanage::GetChildrenFromDifferentPeer(const CTransactionRef& parent, NodeId nodeid) const
252 : : {
253 : : // First construct vector of iterators to ensure we do not return duplicates of the same tx.
254 : 12 : std::vector<OrphanMap::iterator> iters;
255 : :
256 : : // For each output, get all entries spending this prevout, filtering for ones not from the specified peer.
257 [ + + ]: 32 : for (unsigned int i = 0; i < parent->vout.size(); i++) {
258 : 20 : const auto it_by_prev = m_outpoint_to_orphan_it.find(COutPoint(parent->GetHash(), i));
259 [ + + ]: 20 : if (it_by_prev != m_outpoint_to_orphan_it.end()) {
260 [ + + ]: 30 : for (const auto& elem : it_by_prev->second) {
261 [ + + ]: 18 : if (elem->second.fromPeer != nodeid) {
262 [ + - ]: 12 : iters.emplace_back(elem);
263 : : }
264 : : }
265 : : }
266 : : }
267 : :
268 : : // Erase duplicates
269 : 12 : std::sort(iters.begin(), iters.end(), IteratorComparator());
270 : 12 : iters.erase(std::unique(iters.begin(), iters.end()), iters.end());
271 : :
272 : : // Convert iterators to pair<CTransactionRef, NodeId>
273 : 12 : std::vector<std::pair<CTransactionRef, NodeId>> children_found;
274 [ + - ]: 12 : children_found.reserve(iters.size());
275 [ + + ]: 22 : for (const auto& child_iter : iters) {
276 [ + - ]: 10 : children_found.emplace_back(child_iter->second.tx, child_iter->second.fromPeer);
277 : : }
278 : 12 : return children_found;
279 : 12 : }
280 : :
281 : 0 : std::vector<TxOrphanage::OrphanTxBase> TxOrphanage::GetOrphanTransactions() const
282 : : {
283 : 0 : std::vector<OrphanTxBase> ret;
284 [ # # ]: 0 : ret.reserve(m_orphans.size());
285 [ # # ]: 0 : for (auto const& o : m_orphans) {
286 [ # # # # ]: 0 : ret.push_back({o.second.tx, o.second.fromPeer, o.second.nTimeExpire});
287 : : }
288 : 0 : return ret;
289 [ # # ]: 0 : }
|
