Branch data Line data Source code
1 : : // Copyright (c) 2020-present 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 [ + - + - : 2 : static const auto testing_setup = MakeNoLogFileContext<>();
+ - ]
35 : 1 : g_setup = testing_setup.get();
36 : 1 : }
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 : 1 : }
51 : :
52 [ + - ]: 1068 : FUZZ_TARGET(rbf, .init = initialize_rbf)
53 : : {
54 : 612 : SeedRandomStateForTest(SeedRand::ZEROS);
55 : 612 : FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
56 : 612 : SetMockTime(ConsumeTime(fuzzed_data_provider));
57 : 612 : std::optional<CMutableTransaction> mtx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
58 [ + + ]: 612 : if (!mtx) {
59 : 28 : return;
60 : : }
61 : :
62 [ + - ]: 584 : bilingual_str error;
63 [ + - + - ]: 584 : CTxMemPool pool{MemPoolOptionsForTest(g_setup->m_node), error};
64 [ - + ]: 584 : Assert(error.empty());
65 : :
66 [ + + + - ]: 180291 : LIMITED_WHILE(fuzzed_data_provider.ConsumeBool(), NUM_ITERS)
67 : : {
68 : 179835 : const std::optional<CMutableTransaction> another_mtx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
69 [ + + ]: 179835 : if (!another_mtx) {
70 : : break;
71 : : }
72 [ + - ]: 179707 : const CTransaction another_tx{*another_mtx};
73 [ + + + + ]: 179707 : if (fuzzed_data_provider.ConsumeBool() && !mtx->vin.empty()) {
74 : 13191 : mtx->vin[0].prevout = COutPoint{another_tx.GetHash(), 0};
75 : : }
76 [ + - + - ]: 179707 : LOCK2(cs_main, pool.cs);
77 [ + - + + ]: 179707 : if (!pool.GetIter(another_tx.GetHash())) {
78 [ + - ]: 175073 : AddToMempool(pool, ConsumeTxMemPoolEntry(fuzzed_data_provider, another_tx));
79 : : }
80 [ + - + - ]: 718956 : }
81 [ + - ]: 584 : const CTransaction tx{*mtx};
82 [ + + ]: 584 : if (fuzzed_data_provider.ConsumeBool()) {
83 [ + - + - ]: 266 : LOCK2(cs_main, pool.cs);
84 [ + - + + ]: 266 : if (!pool.GetIter(tx.GetHash())) {
85 [ + - ]: 232 : AddToMempool(pool, ConsumeTxMemPoolEntry(fuzzed_data_provider, tx));
86 : : }
87 [ + - ]: 532 : }
88 : 584 : {
89 [ + - ]: 584 : LOCK(pool.cs);
90 [ + - ]: 584 : (void)IsRBFOptIn(tx, pool);
91 : 584 : }
92 [ + - ]: 1780 : }
93 : :
94 [ + - ]: 1329 : FUZZ_TARGET(package_rbf, .init = initialize_package_rbf)
95 : : {
96 : 873 : SeedRandomStateForTest(SeedRand::ZEROS);
97 : 873 : FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
98 : 873 : SetMockTime(ConsumeTime(fuzzed_data_provider));
99 : :
100 : : // "Real" virtual size is not important for this test since ConsumeTxMemPoolEntry generates its own virtual size values
101 : : // so we construct small transactions for performance reasons. Child simply needs an input for later to perhaps connect to parent.
102 : 873 : CMutableTransaction child;
103 [ + - ]: 873 : child.vin.resize(1);
104 : :
105 [ + - ]: 873 : bilingual_str error;
106 [ + - + - ]: 873 : CTxMemPool pool{MemPoolOptionsForTest(g_setup->m_node), error};
107 [ - + ]: 873 : Assert(error.empty());
108 : :
109 : : // Add a bunch of parent-child pairs to the mempool, and remember them.
110 : 873 : std::vector<CTransaction> mempool_txs;
111 : 873 : uint32_t iter{0};
112 : :
113 : : // Keep track of the total vsize of CTxMemPoolEntry's being added to the mempool to avoid overflow
114 : : // Add replacement_vsize since this is added to new diagram during RBF check
115 : 873 : std::optional<CMutableTransaction> replacement_tx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
116 [ + + ]: 873 : if (!replacement_tx) {
117 : 81 : return;
118 : : }
119 [ + - ]: 792 : replacement_tx->vin.resize(1);
120 [ + - + - ]: 792 : replacement_tx->vin[0].prevout = g_outpoints.at(iter++);
121 [ + - ]: 792 : CTransaction replacement_tx_final{*replacement_tx};
122 : 792 : auto replacement_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, replacement_tx_final);
123 [ + - ]: 792 : int32_t replacement_weight = replacement_entry.GetAdjustedWeight();
124 [ + - ]: 792 : int64_t running_vsize_total{replacement_entry.GetTxSize()};
125 : :
126 [ + - + - ]: 792 : LOCK2(cs_main, pool.cs);
127 : :
128 [ + + ]: 396073 : while (fuzzed_data_provider.ConsumeBool()) {
129 [ + + ]: 395286 : if (iter >= NUM_ITERS) break;
130 : :
131 : : // Make sure txns only have one input, and that a unique input is given to avoid circular references
132 [ + - ]: 395285 : CMutableTransaction parent;
133 [ + - ]: 395285 : parent.vin.resize(1);
134 [ + - ]: 395285 : parent.vin[0].prevout = g_outpoints.at(iter++);
135 [ + - ]: 395285 : parent.vout.emplace_back(0, CScript());
136 : :
137 [ + - ]: 395285 : mempool_txs.emplace_back(parent);
138 : 395285 : const auto parent_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, mempool_txs.back());
139 [ + - ]: 395285 : running_vsize_total += parent_entry.GetTxSize();
140 [ + + ]: 395285 : if (running_vsize_total > std::numeric_limits<int32_t>::max()) {
141 : : // We aren't adding this final tx to mempool, so we don't want to conflict with it
142 : 4 : mempool_txs.pop_back();
143 : 4 : break;
144 : : }
145 [ + - - + ]: 395281 : assert(!pool.GetIter(parent_entry.GetTx().GetHash()));
146 [ + - ]: 395281 : AddToMempool(pool, parent_entry);
147 : :
148 : : // It's possible that adding this to the mempool failed due to cluster
149 : : // size limits; if so bail out.
150 [ + - + + ]: 395281 : if(!pool.GetIter(parent_entry.GetTx().GetHash())) {
151 : 293804 : mempool_txs.pop_back();
152 : 293804 : continue;
153 : : }
154 : :
155 [ + - ]: 101477 : child.vin[0].prevout = COutPoint{mempool_txs.back().GetHash(), 0};
156 [ + - ]: 101477 : mempool_txs.emplace_back(child);
157 : 101477 : const auto child_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, mempool_txs.back());
158 [ + - ]: 101477 : running_vsize_total += child_entry.GetTxSize();
159 [ - + ]: 101477 : if (running_vsize_total > std::numeric_limits<int32_t>::max()) {
160 : : // We aren't adding this final tx to mempool, so we don't want to conflict with it
161 : 0 : mempool_txs.pop_back();
162 : 0 : break;
163 : : }
164 [ + - + - ]: 101477 : if (!pool.GetIter(child_entry.GetTx().GetHash())) {
165 [ + - ]: 101477 : AddToMempool(pool, child_entry);
166 : : // Adding this transaction to the mempool may fail due to cluster
167 : : // size limits; if so bail out.
168 [ + - + + ]: 101477 : if(!pool.GetIter(child_entry.GetTx().GetHash())) {
169 : 50738 : mempool_txs.pop_back();
170 : 50738 : continue;
171 : : }
172 : : }
173 : :
174 [ + + ]: 50739 : if (fuzzed_data_provider.ConsumeBool()) {
175 [ + - ]: 50614 : pool.PrioritiseTransaction(mempool_txs.back().GetHash(), fuzzed_data_provider.ConsumeIntegralInRange<int32_t>(-100000, 100000));
176 : : }
177 : 790570 : }
178 : :
179 : : // Pick some transactions at random to be the direct conflicts
180 : 792 : CTxMemPool::setEntries direct_conflicts;
181 [ + + ]: 153008 : for (auto& tx : mempool_txs) {
182 [ + + + - : 152216 : if (fuzzed_data_provider.ConsumeBool() && pool.GetIter(tx.GetHash())) {
+ - ]
183 [ + - + - ]: 129650 : direct_conflicts.insert(*pool.GetIter(tx.GetHash()));
184 : : }
185 : : }
186 : :
187 : : // Calculate all conflicts:
188 : 792 : CTxMemPool::setEntries all_conflicts;
189 [ + + ]: 130442 : for (auto& txiter : direct_conflicts) {
190 [ + - ]: 129650 : pool.CalculateDescendants(txiter, all_conflicts);
191 : : }
192 : :
193 : 792 : CAmount replacement_fees = ConsumeMoney(fuzzed_data_provider);
194 [ + - ]: 792 : auto changeset = pool.GetChangeSet();
195 [ + + ]: 133097 : for (auto& txiter : all_conflicts) {
196 [ + - ]: 132305 : changeset->StageRemoval(txiter);
197 : : }
198 [ + - + - ]: 1584 : changeset->StageAddition(replacement_entry.GetSharedTx(), replacement_fees,
199 [ + - ]: 792 : replacement_entry.GetTime().count(), replacement_entry.GetHeight(),
200 [ + - ]: 792 : replacement_entry.GetSequence(), replacement_entry.GetSpendsCoinbase(),
201 [ + - ]: 792 : replacement_entry.GetSigOpCost(), replacement_entry.GetLockPoints());
202 : : // Calculate the chunks for a replacement.
203 [ + - ]: 792 : auto calc_results{changeset->CalculateChunksForRBF()};
204 : :
205 [ + + ]: 792 : if (calc_results.has_value()) {
206 : : // Sanity checks on the chunks.
207 : :
208 : : // Feerates are monotonically decreasing.
209 : 262 : FeeFrac first_sum;
210 [ - + + + ]: 30049 : for (size_t i = 0; i < calc_results->first.size(); ++i) {
211 [ + + ]: 29787 : first_sum += calc_results->first[i];
212 [ + + - + ]: 29787 : if (i) assert(!(calc_results->first[i - 1] << calc_results->first[i]));
213 : : }
214 : 262 : FeeFrac second_sum;
215 [ - + + + ]: 988 : for (size_t i = 0; i < calc_results->second.size(); ++i) {
216 [ + + ]: 726 : second_sum += calc_results->second[i];
217 [ + + - + ]: 726 : if (i) assert(!(calc_results->second[i - 1] << calc_results->second[i]));
218 : : }
219 : :
220 : 262 : FeeFrac replaced;
221 [ + + ]: 32969 : for (auto txiter : all_conflicts) {
222 [ + - ]: 32707 : replaced.fee += txiter->GetModifiedFee();
223 [ + - ]: 32707 : replaced.size += txiter->GetAdjustedWeight();
224 : : }
225 : : // The total fee & size of the new diagram minus replaced fee & size should be the total
226 : : // fee & size of the old diagram minus replacement fee & size.
227 [ + - ]: 262 : assert((first_sum - replaced) == (second_sum - FeeFrac{replacement_fees, replacement_weight}));
228 : : }
229 : :
230 : : // If internals report error, wrapper should too
231 [ + - ]: 792 : auto err_tuple{ImprovesFeerateDiagram(*changeset)};
232 [ + + ]: 792 : if (!calc_results.has_value()) {
233 [ + - - + ]: 530 : assert(err_tuple.value().first == DiagramCheckError::UNCALCULABLE);
234 : : } else {
235 : : // Diagram check succeeded
236 : 262 : auto old_sum = std::accumulate(calc_results->first.begin(), calc_results->first.end(), FeeFrac{});
237 : 262 : auto new_sum = std::accumulate(calc_results->second.begin(), calc_results->second.end(), FeeFrac{});
238 [ + + ]: 262 : if (!err_tuple.has_value()) {
239 : : // New diagram's final fee should always match or exceed old diagram's
240 [ - + ]: 115 : assert(old_sum.fee <= new_sum.fee);
241 [ + + ]: 147 : } else if (old_sum.fee > new_sum.fee) {
242 : : // Or it failed, and if old diagram had higher fees, it should be a failure
243 [ - + ]: 79 : assert(err_tuple.value().first == DiagramCheckError::FAILURE);
244 : : }
245 : : }
246 [ + - + - : 5787 : }
+ - ]
|
