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 : 0 : void initialize_rbf()
33 : : {
34 [ # # # # ]: 0 : static const auto testing_setup = MakeNoLogFileContext<>();
35 : 0 : g_setup = testing_setup.get();
36 [ # # ]: 0 : }
37 : :
38 : 0 : void initialize_package_rbf()
39 : : {
40 [ # # # # ]: 0 : static const auto testing_setup = MakeNoLogFileContext<>();
41 : 0 : 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 [ # # ]: 0 : for (int i = 0; i < NUM_ITERS; ++i) {
46 : 0 : g_outpoints.emplace_back();
47 : 0 : g_outpoints.back().n = i;
48 : : }
49 : :
50 [ # # ]: 0 : }
51 : :
52 [ # # ]: 0 : FUZZ_TARGET(rbf, .init = initialize_rbf)
53 : : {
54 : 0 : FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
55 : 0 : SetMockTime(ConsumeTime(fuzzed_data_provider));
56 : 0 : std::optional<CMutableTransaction> mtx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
57 [ # # ]: 0 : if (!mtx) {
58 : 0 : return;
59 : : }
60 : :
61 [ # # ]: 0 : bilingual_str error;
62 [ # # # # ]: 0 : CTxMemPool pool{MemPoolOptionsForTest(g_setup->m_node), error};
63 [ # # ]: 0 : Assert(error.empty());
64 : :
65 [ # # # # ]: 0 : LIMITED_WHILE(fuzzed_data_provider.ConsumeBool(), NUM_ITERS)
66 : : {
67 : 0 : const std::optional<CMutableTransaction> another_mtx = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
68 [ # # ]: 0 : if (!another_mtx) {
69 : : break;
70 : : }
71 [ # # ]: 0 : const CTransaction another_tx{*another_mtx};
72 [ # # # # ]: 0 : if (fuzzed_data_provider.ConsumeBool() && !mtx->vin.empty()) {
73 : 0 : mtx->vin[0].prevout = COutPoint{another_tx.GetHash(), 0};
74 : : }
75 [ # # # # ]: 0 : LOCK2(cs_main, pool.cs);
76 [ # # # # ]: 0 : pool.addUnchecked(ConsumeTxMemPoolEntry(fuzzed_data_provider, another_tx));
77 [ # # # # ]: 0 : }
78 [ # # ]: 0 : const CTransaction tx{*mtx};
79 [ # # ]: 0 : if (fuzzed_data_provider.ConsumeBool()) {
80 [ # # # # ]: 0 : LOCK2(cs_main, pool.cs);
81 [ # # # # ]: 0 : pool.addUnchecked(ConsumeTxMemPoolEntry(fuzzed_data_provider, tx));
82 [ # # ]: 0 : }
83 : 0 : {
84 [ # # ]: 0 : LOCK(pool.cs);
85 [ # # ]: 0 : (void)IsRBFOptIn(tx, pool);
86 : 0 : }
87 [ # # ]: 0 : }
88 : :
89 [ # # ]: 0 : FUZZ_TARGET(package_rbf, .init = initialize_package_rbf)
90 : : {
91 : 0 : FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
92 : 0 : SetMockTime(ConsumeTime(fuzzed_data_provider));
93 : :
94 : : // "Real" virtual size is not important for this test since ConsumeTxMemPoolEntry generates its own virtual size values
95 : : // so we construct small transactions for performance reasons. Child simply needs an input for later to perhaps connect to parent.
96 : 0 : CMutableTransaction child;
97 [ # # ]: 0 : child.vin.resize(1);
98 : :
99 [ # # ]: 0 : bilingual_str error;
100 [ # # # # ]: 0 : CTxMemPool pool{MemPoolOptionsForTest(g_setup->m_node), error};
101 [ # # ]: 0 : Assert(error.empty());
102 : :
103 : : // Add a bunch of parent-child pairs to the mempool, and remember them.
104 : 0 : std::vector<CTransaction> mempool_txs;
105 : 0 : size_t iter{0};
106 : :
107 : 0 : int32_t replacement_vsize = fuzzed_data_provider.ConsumeIntegralInRange<int32_t>(1, 1000000);
108 : :
109 : : // Keep track of the total vsize of CTxMemPoolEntry's being added to the mempool to avoid overflow
110 : : // Add replacement_vsize since this is added to new diagram during RBF check
111 : 0 : int64_t running_vsize_total{replacement_vsize};
112 : :
113 [ # # # # ]: 0 : LOCK2(cs_main, pool.cs);
114 : :
115 [ # # # # ]: 0 : LIMITED_WHILE(fuzzed_data_provider.ConsumeBool(), NUM_ITERS)
116 : : {
117 : : // Make sure txns only have one input, and that a unique input is given to avoid circular references
118 [ # # ]: 0 : CMutableTransaction parent;
119 [ # # ]: 0 : assert(iter <= g_outpoints.size());
120 [ # # ]: 0 : parent.vin.resize(1);
121 [ # # ]: 0 : parent.vin[0].prevout = g_outpoints[iter++];
122 [ # # ]: 0 : parent.vout.emplace_back(0, CScript());
123 : :
124 [ # # ]: 0 : mempool_txs.emplace_back(parent);
125 : 0 : const auto parent_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, mempool_txs.back());
126 [ # # ]: 0 : running_vsize_total += parent_entry.GetTxSize();
127 [ # # ]: 0 : if (running_vsize_total > std::numeric_limits<int32_t>::max()) {
128 : : // We aren't adding this final tx to mempool, so we don't want to conflict with it
129 : 0 : mempool_txs.pop_back();
130 : 0 : break;
131 : : }
132 [ # # ]: 0 : pool.addUnchecked(parent_entry);
133 [ # # ]: 0 : if (fuzzed_data_provider.ConsumeBool()) {
134 : 0 : child.vin[0].prevout = COutPoint{mempool_txs.back().GetHash(), 0};
135 : : }
136 [ # # ]: 0 : mempool_txs.emplace_back(child);
137 : 0 : const auto child_entry = ConsumeTxMemPoolEntry(fuzzed_data_provider, mempool_txs.back());
138 [ # # ]: 0 : running_vsize_total += child_entry.GetTxSize();
139 [ # # ]: 0 : 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 : 0 : mempool_txs.pop_back();
142 : 0 : break;
143 : : }
144 [ # # ]: 0 : pool.addUnchecked(child_entry);
145 : :
146 [ # # ]: 0 : if (fuzzed_data_provider.ConsumeBool()) {
147 [ # # ]: 0 : pool.PrioritiseTransaction(mempool_txs.back().GetHash().ToUint256(), fuzzed_data_provider.ConsumeIntegralInRange<int32_t>(-100000, 100000));
148 : : }
149 : 0 : }
150 : :
151 : : // Pick some transactions at random to be the direct conflicts
152 : 0 : CTxMemPool::setEntries direct_conflicts;
153 [ # # ]: 0 : for (auto& tx : mempool_txs) {
154 [ # # ]: 0 : if (fuzzed_data_provider.ConsumeBool()) {
155 [ # # # # ]: 0 : direct_conflicts.insert(*pool.GetIter(tx.GetHash()));
156 : : }
157 : : }
158 : :
159 : : // Calculate all conflicts:
160 : 0 : CTxMemPool::setEntries all_conflicts;
161 [ # # ]: 0 : for (auto& txiter : direct_conflicts) {
162 [ # # ]: 0 : pool.CalculateDescendants(txiter, all_conflicts);
163 : : }
164 : :
165 : : // Calculate the chunks for a replacement.
166 : 0 : CAmount replacement_fees = ConsumeMoney(fuzzed_data_provider);
167 [ # # ]: 0 : auto calc_results{pool.CalculateChunksForRBF(replacement_fees, replacement_vsize, direct_conflicts, all_conflicts)};
168 : :
169 [ # # ]: 0 : if (calc_results.has_value()) {
170 : : // Sanity checks on the chunks.
171 : :
172 : : // Feerates are monotonically decreasing.
173 : 0 : FeeFrac first_sum;
174 [ # # ]: 0 : for (size_t i = 0; i < calc_results->first.size(); ++i) {
175 [ # # ]: 0 : first_sum += calc_results->first[i];
176 [ # # # # ]: 0 : if (i) assert(!(calc_results->first[i - 1] << calc_results->first[i]));
177 : : }
178 : 0 : FeeFrac second_sum;
179 [ # # ]: 0 : for (size_t i = 0; i < calc_results->second.size(); ++i) {
180 [ # # ]: 0 : second_sum += calc_results->second[i];
181 [ # # # # ]: 0 : if (i) assert(!(calc_results->second[i - 1] << calc_results->second[i]));
182 : : }
183 : :
184 : 0 : FeeFrac replaced;
185 [ # # ]: 0 : for (auto txiter : all_conflicts) {
186 [ # # ]: 0 : replaced.fee += txiter->GetModifiedFee();
187 [ # # ]: 0 : replaced.size += txiter->GetTxSize();
188 : : }
189 : : // The total fee & size of the new diagram minus replaced fee & size should be the total
190 : : // fee & size of the old diagram minus replacement fee & size.
191 [ # # ]: 0 : assert((first_sum - replaced) == (second_sum - FeeFrac{replacement_fees, replacement_vsize}));
192 : : }
193 : :
194 : : // If internals report error, wrapper should too
195 [ # # ]: 0 : auto err_tuple{ImprovesFeerateDiagram(pool, direct_conflicts, all_conflicts, replacement_fees, replacement_vsize)};
196 [ # # ]: 0 : if (!calc_results.has_value()) {
197 [ # # # # ]: 0 : assert(err_tuple.value().first == DiagramCheckError::UNCALCULABLE);
198 : : } else {
199 : : // Diagram check succeeded
200 : 0 : auto old_sum = std::accumulate(calc_results->first.begin(), calc_results->first.end(), FeeFrac{});
201 : 0 : auto new_sum = std::accumulate(calc_results->second.begin(), calc_results->second.end(), FeeFrac{});
202 [ # # ]: 0 : if (!err_tuple.has_value()) {
203 : : // New diagram's final fee should always match or exceed old diagram's
204 [ # # ]: 0 : assert(old_sum.fee <= new_sum.fee);
205 [ # # ]: 0 : } else if (old_sum.fee > new_sum.fee) {
206 : : // Or it failed, and if old diagram had higher fees, it should be a failure
207 [ # # ]: 0 : assert(err_tuple.value().first == DiagramCheckError::FAILURE);
208 : : }
209 : : }
210 [ # # # # ]: 0 : }
|
