Branch data Line data Source code
1 : : // Copyright (c) 2020-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 <node/mempool_args.h>
6 : : #include <policy/rbf.h>
7 : : #include <primitives/transaction.h>
8 : : #include <sync.h>
9 : : #include <test/fuzz/FuzzedDataProvider.h>
10 : : #include <test/fuzz/fuzz.h>
11 : : #include <test/fuzz/util.h>
12 : : #include <test/fuzz/util/mempool.h>
13 : : #include <test/util/setup_common.h>
14 : : #include <test/util/txmempool.h>
15 : : #include <txmempool.h>
16 : : #include <util/check.h>
17 : : #include <util/translation.h>
18 : :
19 : : #include <cstdint>
20 : : #include <optional>
21 : : #include <string>
22 : : #include <vector>
23 : :
24 : : namespace {
25 : : const BasicTestingSetup* g_setup;
26 : : } // namespace
27 : :
28 : : const int NUM_ITERS = 10000;
29 : :
30 : : std::vector<COutPoint> g_outpoints;
31 : :
32 : 1 : void initialize_rbf()
33 : : {
34 [ + - + - ]: 3 : static const auto testing_setup = MakeNoLogFileContext<>();
35 : 1 : g_setup = testing_setup.get();
36 [ + - ]: 2 : }
37 : :
38 : 1 : void initialize_package_rbf()
39 : : {
40 [ + - + - ]: 2 : static const auto testing_setup = MakeNoLogFileContext<>();
41 : 1 : g_setup = testing_setup.get();
42 : :
43 : : // Create a fixed set of unique "UTXOs" to source parents from
44 : : // to avoid fuzzer giving circular references
45 [ + + ]: 10001 : for (int i = 0; i < NUM_ITERS; ++i) {
46 : 10000 : g_outpoints.emplace_back();
47 : 10000 : g_outpoints.back().n = i;
48 : : }
49 : :
50 [ + - ]: 2 : }
51 : :
52 [ + - ]: 1041 : FUZZ_TARGET(rbf, .init = initialize_rbf)
53 : : {
54 : 629 : FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
55 : 629 : SetMockTime(ConsumeTime(fuzzed_data_provider));
56 : 629 : std::optional<CMutableTransaction> mtx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
57 [ + + ]: 629 : if (!mtx) {
58 : 40 : return;
59 : : }
60 : :
61 [ + - ]: 589 : bilingual_str error;
62 [ + - + - ]: 589 : CTxMemPool pool{MemPoolOptionsForTest(g_setup->m_node), error};
63 [ + - ]: 589 : Assert(error.empty());
64 : :
65 [ + + + - ]: 123463 : LIMITED_WHILE(fuzzed_data_provider.ConsumeBool(), NUM_ITERS)
66 : : {
67 : 123067 : const std::optional<CMutableTransaction> another_mtx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
68 [ + + ]: 123067 : if (!another_mtx) {
69 : : break;
70 : : }
71 [ + - ]: 122874 : const CTransaction another_tx{*another_mtx};
72 [ + + + + ]: 122874 : if (fuzzed_data_provider.ConsumeBool() && !mtx->vin.empty()) {
73 : 11346 : mtx->vin[0].prevout = COutPoint{another_tx.GetHash(), 0};
74 : : }
75 [ + - + - ]: 122874 : LOCK2(cs_main, pool.cs);
76 [ + - + + ]: 122874 : if (!pool.GetIter(another_tx.GetHash())) {
77 [ + - ]: 32777 : AddToMempool(pool, ConsumeTxMemPoolEntry(fuzzed_data_provider, another_tx));
78 : : }
79 [ + - + - ]: 491689 : }
80 [ + - ]: 589 : const CTransaction tx{*mtx};
81 [ + + ]: 589 : if (fuzzed_data_provider.ConsumeBool()) {
82 [ + - + - ]: 253 : LOCK2(cs_main, pool.cs);
83 [ + - + + ]: 253 : if (!pool.GetIter(tx.GetHash())) {
84 [ + - ]: 247 : AddToMempool(pool, ConsumeTxMemPoolEntry(fuzzed_data_provider, tx));
85 : : }
86 [ + - ]: 506 : }
87 : 589 : {
88 [ + - ]: 589 : LOCK(pool.cs);
89 [ + - ]: 589 : (void)IsRBFOptIn(tx, pool);
90 : 589 : }
91 [ + - ]: 1807 : }
92 : :
93 [ + - ]: 1252 : FUZZ_TARGET(package_rbf, .init = initialize_package_rbf)
94 : : {
95 : 840 : FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
96 : 840 : SetMockTime(ConsumeTime(fuzzed_data_provider));
97 : :
98 : : // "Real" virtual size is not important for this test since ConsumeTxMemPoolEntry generates its own virtual size values
99 : : // so we construct small transactions for performance reasons. Child simply needs an input for later to perhaps connect to parent.
100 : 840 : CMutableTransaction child;
101 [ + - ]: 840 : child.vin.resize(1);
102 : :
103 [ + - ]: 840 : bilingual_str error;
104 [ + - + - ]: 840 : CTxMemPool pool{MemPoolOptionsForTest(g_setup->m_node), error};
105 [ + - ]: 840 : Assert(error.empty());
106 : :
107 : : // Add a bunch of parent-child pairs to the mempool, and remember them.
108 : 840 : std::vector<CTransaction> mempool_txs;
109 : 840 : size_t iter{0};
110 : :
111 : : // Keep track of the total vsize of CTxMemPoolEntry's being added to the mempool to avoid overflow
112 : : // Add replacement_vsize since this is added to new diagram during RBF check
113 : 840 : std::optional<CMutableTransaction> replacement_tx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
114 [ + + ]: 840 : if (!replacement_tx) {
115 : 241 : return;
116 : : }
117 : 599 : assert(iter <= g_outpoints.size());
118 [ + - ]: 599 : replacement_tx->vin.resize(1);
119 [ + - ]: 599 : replacement_tx->vin[0].prevout = g_outpoints[iter++];
120 [ + - ]: 599 : CTransaction replacement_tx_final{*replacement_tx};
121 : 599 : auto replacement_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, replacement_tx_final);
122 [ + - ]: 599 : int32_t replacement_vsize = replacement_entry.GetTxSize();
123 : 599 : int64_t running_vsize_total{replacement_vsize};
124 : :
125 [ + - + - ]: 599 : LOCK2(cs_main, pool.cs);
126 : :
127 [ + + + - ]: 155924 : LIMITED_WHILE(fuzzed_data_provider.ConsumeBool(), NUM_ITERS)
128 : : {
129 : : // Make sure txns only have one input, and that a unique input is given to avoid circular references
130 [ + - ]: 155339 : CMutableTransaction parent;
131 [ - + ]: 155339 : assert(iter <= g_outpoints.size());
132 [ + - ]: 155339 : parent.vin.resize(1);
133 [ + - ]: 155339 : parent.vin[0].prevout = g_outpoints[iter++];
134 [ + - ]: 155339 : parent.vout.emplace_back(0, CScript());
135 : :
136 [ + - ]: 155339 : mempool_txs.emplace_back(parent);
137 : 155339 : const auto parent_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, mempool_txs.back());
138 [ + - ]: 155339 : running_vsize_total += parent_entry.GetTxSize();
139 [ + + ]: 155339 : if (running_vsize_total > std::numeric_limits<int32_t>::max()) {
140 : : // We aren't adding this final tx to mempool, so we don't want to conflict with it
141 : 10 : mempool_txs.pop_back();
142 : 10 : break;
143 : : }
144 [ + - - + ]: 155329 : assert(!pool.GetIter(parent_entry.GetTx().GetHash()));
145 [ + - ]: 155329 : AddToMempool(pool, parent_entry);
146 [ + + ]: 155329 : if (fuzzed_data_provider.ConsumeBool()) {
147 : 154143 : child.vin[0].prevout = COutPoint{mempool_txs.back().GetHash(), 0};
148 : : }
149 [ + - ]: 155329 : mempool_txs.emplace_back(child);
150 : 155329 : const auto child_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, mempool_txs.back());
151 [ + - ]: 155329 : running_vsize_total += child_entry.GetTxSize();
152 [ + + ]: 155329 : if (running_vsize_total > std::numeric_limits<int32_t>::max()) {
153 : : // We aren't adding this final tx to mempool, so we don't want to conflict with it
154 : 4 : mempool_txs.pop_back();
155 : 4 : break;
156 : : }
157 [ + - + + ]: 155325 : if (!pool.GetIter(child_entry.GetTx().GetHash())) {
158 [ + - ]: 154183 : AddToMempool(pool, child_entry);
159 : : }
160 : :
161 [ + + ]: 155325 : if (fuzzed_data_provider.ConsumeBool()) {
162 [ + - ]: 154568 : pool.PrioritiseTransaction(mempool_txs.back().GetHash().ToUint256(), fuzzed_data_provider.ConsumeIntegralInRange<int32_t>(-100000, 100000));
163 : : }
164 : 310678 : }
165 : :
166 : : // Pick some transactions at random to be the direct conflicts
167 : 599 : CTxMemPool::setEntries direct_conflicts;
168 [ + + ]: 311253 : for (auto& tx : mempool_txs) {
169 [ + + ]: 310654 : if (fuzzed_data_provider.ConsumeBool()) {
170 [ + - + - ]: 252234 : direct_conflicts.insert(*pool.GetIter(tx.GetHash()));
171 : : }
172 : : }
173 : :
174 : : // Calculate all conflicts:
175 : 599 : CTxMemPool::setEntries all_conflicts;
176 [ + + ]: 252317 : for (auto& txiter : direct_conflicts) {
177 [ + - ]: 251718 : pool.CalculateDescendants(txiter, all_conflicts);
178 : : }
179 : :
180 : 599 : CAmount replacement_fees = ConsumeMoney(fuzzed_data_provider);
181 [ + - ]: 599 : auto changeset = pool.GetChangeSet();
182 [ + + ]: 259425 : for (auto& txiter : all_conflicts) {
183 [ + - ]: 258826 : changeset->StageRemoval(txiter);
184 : : }
185 [ + - + - ]: 1198 : changeset->StageAddition(replacement_entry.GetSharedTx(), replacement_fees,
186 [ + - ]: 599 : replacement_entry.GetTime().count(), replacement_entry.GetHeight(),
187 [ + - ]: 599 : replacement_entry.GetSequence(), replacement_entry.GetSpendsCoinbase(),
188 [ + - ]: 599 : replacement_entry.GetSigOpCost(), replacement_entry.GetLockPoints());
189 : : // Calculate the chunks for a replacement.
190 [ + - ]: 599 : auto calc_results{changeset->CalculateChunksForRBF()};
191 : :
192 [ + - ]: 599 : if (calc_results.has_value()) {
193 : : // Sanity checks on the chunks.
194 : :
195 : : // Feerates are monotonically decreasing.
196 : 599 : FeeFrac first_sum;
197 [ + + ]: 162898 : for (size_t i = 0; i < calc_results->first.size(); ++i) {
198 [ + + ]: 162299 : first_sum += calc_results->first[i];
199 [ + + - + ]: 162299 : if (i) assert(!(calc_results->first[i - 1] << calc_results->first[i]));
200 : : }
201 : 599 : FeeFrac second_sum;
202 [ + + ]: 8144 : for (size_t i = 0; i < calc_results->second.size(); ++i) {
203 [ + + ]: 7545 : second_sum += calc_results->second[i];
204 [ + + - + ]: 7545 : if (i) assert(!(calc_results->second[i - 1] << calc_results->second[i]));
205 : : }
206 : :
207 : 599 : FeeFrac replaced;
208 [ + + ]: 259425 : for (auto txiter : all_conflicts) {
209 [ + - ]: 258826 : replaced.fee += txiter->GetModifiedFee();
210 [ + - ]: 258826 : replaced.size += txiter->GetTxSize();
211 : : }
212 : : // The total fee & size of the new diagram minus replaced fee & size should be the total
213 : : // fee & size of the old diagram minus replacement fee & size.
214 [ + - ]: 599 : assert((first_sum - replaced) == (second_sum - FeeFrac{replacement_fees, replacement_vsize}));
215 : : }
216 : :
217 : : // If internals report error, wrapper should too
218 [ + - ]: 599 : auto err_tuple{ImprovesFeerateDiagram(*changeset)};
219 [ - + ]: 599 : if (!calc_results.has_value()) {
220 [ # # # # ]: 0 : assert(err_tuple.value().first == DiagramCheckError::UNCALCULABLE);
221 : : } else {
222 : : // Diagram check succeeded
223 : 599 : auto old_sum = std::accumulate(calc_results->first.begin(), calc_results->first.end(), FeeFrac{});
224 : 599 : auto new_sum = std::accumulate(calc_results->second.begin(), calc_results->second.end(), FeeFrac{});
225 [ + + ]: 599 : if (!err_tuple.has_value()) {
226 : : // New diagram's final fee should always match or exceed old diagram's
227 [ - + ]: 158 : assert(old_sum.fee <= new_sum.fee);
228 [ + + ]: 441 : } else if (old_sum.fee > new_sum.fee) {
229 : : // Or it failed, and if old diagram had higher fees, it should be a failure
230 [ - + ]: 270 : assert(err_tuple.value().first == DiagramCheckError::FAILURE);
231 : : }
232 : : }
233 [ + - + - : 4916 : }
+ - ]
|
