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 [ + - ]: 1258 : FUZZ_TARGET(rbf, .init = initialize_rbf)
53 : : {
54 : 844 : SeedRandomStateForTest(SeedRand::ZEROS);
55 : 844 : FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
56 : 844 : SetMockTime(ConsumeTime(fuzzed_data_provider));
57 : 844 : std::optional<CMutableTransaction> mtx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
58 [ + + ]: 844 : if (!mtx) {
59 : 44 : return;
60 : : }
61 : :
62 [ + - ]: 800 : bilingual_str error;
63 [ + - + - ]: 800 : CTxMemPool pool{MemPoolOptionsForTest(g_setup->m_node), error};
64 [ + - ]: 800 : Assert(error.empty());
65 : :
66 [ + + + - ]: 324325 : LIMITED_WHILE(fuzzed_data_provider.ConsumeBool(), NUM_ITERS)
67 : : {
68 : 323797 : const std::optional<CMutableTransaction> another_mtx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
69 [ + + ]: 323797 : if (!another_mtx) {
70 : : break;
71 : : }
72 [ + - ]: 323525 : const CTransaction another_tx{*another_mtx};
73 [ + + + + ]: 323525 : if (fuzzed_data_provider.ConsumeBool() && !mtx->vin.empty()) {
74 : 11998 : mtx->vin[0].prevout = COutPoint{another_tx.GetHash(), 0};
75 : : }
76 [ + - + - ]: 323525 : LOCK2(cs_main, pool.cs);
77 [ + - + + ]: 323525 : if (!pool.GetIter(another_tx.GetHash())) {
78 [ + - ]: 81212 : AddToMempool(pool, ConsumeTxMemPoolEntry(fuzzed_data_provider, another_tx));
79 : : }
80 [ + - + - ]: 1294372 : }
81 [ + - ]: 800 : const CTransaction tx{*mtx};
82 [ + + ]: 800 : if (fuzzed_data_provider.ConsumeBool()) {
83 [ + - + - ]: 353 : LOCK2(cs_main, pool.cs);
84 [ + - + + ]: 353 : if (!pool.GetIter(tx.GetHash())) {
85 [ + - ]: 321 : AddToMempool(pool, ConsumeTxMemPoolEntry(fuzzed_data_provider, tx));
86 : : }
87 [ + - ]: 706 : }
88 : 800 : {
89 [ + - ]: 800 : LOCK(pool.cs);
90 [ + - ]: 800 : (void)IsRBFOptIn(tx, pool);
91 : 800 : }
92 [ + - ]: 2444 : }
93 : :
94 [ + - ]: 1368 : FUZZ_TARGET(package_rbf, .init = initialize_package_rbf)
95 : : {
96 : 954 : SeedRandomStateForTest(SeedRand::ZEROS);
97 : 954 : FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
98 : 954 : 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 : 954 : CMutableTransaction child;
103 [ + - ]: 954 : child.vin.resize(1);
104 : :
105 [ + - ]: 954 : bilingual_str error;
106 [ + - + - ]: 954 : CTxMemPool pool{MemPoolOptionsForTest(g_setup->m_node), error};
107 [ + - ]: 954 : Assert(error.empty());
108 : :
109 : : // Add a bunch of parent-child pairs to the mempool, and remember them.
110 : 954 : std::vector<CTransaction> mempool_txs;
111 : 954 : size_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 : 954 : std::optional<CMutableTransaction> replacement_tx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
116 [ + + ]: 954 : if (!replacement_tx) {
117 : 267 : return;
118 : : }
119 : 687 : assert(iter <= g_outpoints.size());
120 [ + - ]: 687 : replacement_tx->vin.resize(1);
121 [ + - ]: 687 : replacement_tx->vin[0].prevout = g_outpoints[iter++];
122 [ + - ]: 687 : CTransaction replacement_tx_final{*replacement_tx};
123 : 687 : auto replacement_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, replacement_tx_final);
124 [ + - ]: 687 : int32_t replacement_vsize = replacement_entry.GetTxSize();
125 : 687 : int64_t running_vsize_total{replacement_vsize};
126 : :
127 [ + - + - ]: 687 : LOCK2(cs_main, pool.cs);
128 : :
129 [ + + + - ]: 344363 : LIMITED_WHILE(fuzzed_data_provider.ConsumeBool(), NUM_ITERS)
130 : : {
131 : : // Make sure txns only have one input, and that a unique input is given to avoid circular references
132 [ + - ]: 343708 : CMutableTransaction parent;
133 [ - + ]: 343708 : assert(iter <= g_outpoints.size());
134 [ + - ]: 343708 : parent.vin.resize(1);
135 [ + - ]: 343708 : parent.vin[0].prevout = g_outpoints[iter++];
136 [ + - ]: 343708 : parent.vout.emplace_back(0, CScript());
137 : :
138 [ + - ]: 343708 : mempool_txs.emplace_back(parent);
139 : 343708 : const auto parent_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, mempool_txs.back());
140 [ + - ]: 343708 : running_vsize_total += parent_entry.GetTxSize();
141 [ + + ]: 343708 : if (running_vsize_total > std::numeric_limits<int32_t>::max()) {
142 : : // We aren't adding this final tx to mempool, so we don't want to conflict with it
143 : 21 : mempool_txs.pop_back();
144 : 21 : break;
145 : : }
146 [ + - - + ]: 343687 : assert(!pool.GetIter(parent_entry.GetTx().GetHash()));
147 [ + - ]: 343687 : AddToMempool(pool, parent_entry);
148 [ + + ]: 343687 : if (fuzzed_data_provider.ConsumeBool()) {
149 : 342086 : child.vin[0].prevout = COutPoint{mempool_txs.back().GetHash(), 0};
150 : : }
151 [ + - ]: 343687 : mempool_txs.emplace_back(child);
152 : 343687 : const auto child_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, mempool_txs.back());
153 [ + - ]: 343687 : running_vsize_total += child_entry.GetTxSize();
154 [ + + ]: 343687 : if (running_vsize_total > std::numeric_limits<int32_t>::max()) {
155 : : // We aren't adding this final tx to mempool, so we don't want to conflict with it
156 : 11 : mempool_txs.pop_back();
157 : 11 : break;
158 : : }
159 [ + - + + ]: 343676 : if (!pool.GetIter(child_entry.GetTx().GetHash())) {
160 [ + - ]: 342125 : AddToMempool(pool, child_entry);
161 : : }
162 : :
163 [ + + ]: 343676 : if (fuzzed_data_provider.ConsumeBool()) {
164 [ + - ]: 342813 : pool.PrioritiseTransaction(mempool_txs.back().GetHash().ToUint256(), fuzzed_data_provider.ConsumeIntegralInRange<int32_t>(-100000, 100000));
165 : : }
166 : 687416 : }
167 : :
168 : : // Pick some transactions at random to be the direct conflicts
169 : 1374 : CTxMemPool::setEntries direct_conflicts;
170 [ + + ]: 688050 : for (auto& tx : mempool_txs) {
171 [ + + ]: 687363 : if (fuzzed_data_provider.ConsumeBool()) {
172 [ + - + - ]: 556276 : direct_conflicts.insert(*pool.GetIter(tx.GetHash()));
173 : : }
174 : : }
175 : :
176 : : // Calculate all conflicts:
177 : 687 : CTxMemPool::setEntries all_conflicts;
178 [ + + ]: 556343 : for (auto& txiter : direct_conflicts) {
179 [ + - ]: 555656 : pool.CalculateDescendants(txiter, all_conflicts);
180 : : }
181 : :
182 : 687 : CAmount replacement_fees = ConsumeMoney(fuzzed_data_provider);
183 [ + - ]: 687 : auto changeset = pool.GetChangeSet();
184 [ + + ]: 575861 : for (auto& txiter : all_conflicts) {
185 [ + - ]: 575174 : changeset->StageRemoval(txiter);
186 : : }
187 [ + - + - ]: 1374 : changeset->StageAddition(replacement_entry.GetSharedTx(), replacement_fees,
188 [ + - ]: 687 : replacement_entry.GetTime().count(), replacement_entry.GetHeight(),
189 [ + - ]: 687 : replacement_entry.GetSequence(), replacement_entry.GetSpendsCoinbase(),
190 [ + - ]: 687 : replacement_entry.GetSigOpCost(), replacement_entry.GetLockPoints());
191 : : // Calculate the chunks for a replacement.
192 [ + - ]: 687 : auto calc_results{changeset->CalculateChunksForRBF()};
193 : :
194 [ + - ]: 687 : if (calc_results.has_value()) {
195 : : // Sanity checks on the chunks.
196 : :
197 : : // Feerates are monotonically decreasing.
198 : 687 : FeeFrac first_sum;
199 [ + + ]: 395171 : for (size_t i = 0; i < calc_results->first.size(); ++i) {
200 [ + + ]: 394484 : first_sum += calc_results->first[i];
201 [ + + - + ]: 394484 : if (i) assert(!(calc_results->first[i - 1] << calc_results->first[i]));
202 : : }
203 : 687 : FeeFrac second_sum;
204 [ + + ]: 16022 : for (size_t i = 0; i < calc_results->second.size(); ++i) {
205 [ + + ]: 15335 : second_sum += calc_results->second[i];
206 [ + + - + ]: 15335 : if (i) assert(!(calc_results->second[i - 1] << calc_results->second[i]));
207 : : }
208 : :
209 : 687 : FeeFrac replaced;
210 [ + + ]: 575861 : for (auto txiter : all_conflicts) {
211 [ + - ]: 575174 : replaced.fee += txiter->GetModifiedFee();
212 [ + - ]: 575174 : replaced.size += txiter->GetTxSize();
213 : : }
214 : : // The total fee & size of the new diagram minus replaced fee & size should be the total
215 : : // fee & size of the old diagram minus replacement fee & size.
216 [ + - ]: 687 : assert((first_sum - replaced) == (second_sum - FeeFrac{replacement_fees, replacement_vsize}));
217 : : }
218 : :
219 : : // If internals report error, wrapper should too
220 [ + - ]: 687 : auto err_tuple{ImprovesFeerateDiagram(*changeset)};
221 [ - + ]: 687 : if (!calc_results.has_value()) {
222 [ # # # # ]: 0 : assert(err_tuple.value().first == DiagramCheckError::UNCALCULABLE);
223 : : } else {
224 : : // Diagram check succeeded
225 : 687 : auto old_sum = std::accumulate(calc_results->first.begin(), calc_results->first.end(), FeeFrac{});
226 : 687 : auto new_sum = std::accumulate(calc_results->second.begin(), calc_results->second.end(), FeeFrac{});
227 [ + + ]: 687 : if (!err_tuple.has_value()) {
228 : : // New diagram's final fee should always match or exceed old diagram's
229 [ - + ]: 167 : assert(old_sum.fee <= new_sum.fee);
230 [ + + ]: 520 : } else if (old_sum.fee > new_sum.fee) {
231 : : // Or it failed, and if old diagram had higher fees, it should be a failure
232 [ - + ]: 335 : assert(err_tuple.value().first == DiagramCheckError::FAILURE);
233 : : }
234 : : }
235 [ + - + - : 5610 : }
+ - ]
|
