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 <coins.h>
6 : : #include <consensus/amount.h>
7 : : #include <consensus/tx_check.h>
8 : : #include <consensus/tx_verify.h>
9 : : #include <consensus/validation.h>
10 : : #include <policy/policy.h>
11 : : #include <primitives/transaction.h>
12 : : #include <script/interpreter.h>
13 : : #include <test/fuzz/FuzzedDataProvider.h>
14 : : #include <test/fuzz/fuzz.h>
15 : : #include <test/fuzz/util.h>
16 : : #include <test/util/setup_common.h>
17 : : #include <txdb.h>
18 : : #include <util/hasher.h>
19 : :
20 : : #include <cassert>
21 : : #include <cstdint>
22 : : #include <limits>
23 : : #include <memory>
24 : : #include <optional>
25 : : #include <stdexcept>
26 : : #include <string>
27 : : #include <utility>
28 : : #include <vector>
29 : :
30 : : namespace {
31 : : const Coin EMPTY_COIN{};
32 : :
33 : 11230 : bool operator==(const Coin& a, const Coin& b)
34 : : {
35 [ + + - + ]: 11230 : if (a.IsSpent() && b.IsSpent()) return true;
36 [ + + + + : 9410 : return a.fCoinBase == b.fCoinBase && a.nHeight == b.nHeight && a.out == b.out;
+ + ]
37 : : }
38 : : } // namespace
39 : :
40 : 2 : void initialize_coins_view()
41 : : {
42 [ + - + - ]: 4 : static const auto testing_setup = MakeNoLogFileContext<>();
43 [ + - ]: 4 : }
44 : :
45 : 6525 : void TestCoinsView(FuzzedDataProvider& fuzzed_data_provider, CCoinsView& backend_coins_view, bool is_db)
46 : : {
47 : 6525 : bool good_data{true};
48 : :
49 : 6525 : CCoinsViewCache coins_view_cache{&backend_coins_view, /*deterministic=*/true};
50 [ + + + - ]: 6525 : if (is_db) coins_view_cache.SetBestBlock(uint256::ONE);
51 : 6525 : COutPoint random_out_point;
52 : 6525 : Coin random_coin;
53 [ + - ]: 6525 : CMutableTransaction random_mutable_transaction;
54 [ + + + + : 7231109 : LIMITED_WHILE(good_data && fuzzed_data_provider.ConsumeBool(), 10'000)
+ + ]
55 : : {
56 [ + - ]: 3609421 : CallOneOf(
57 : : fuzzed_data_provider,
58 : 535772 : [&] {
59 [ + + ]: 535772 : if (random_coin.IsSpent()) {
60 : : return;
61 : : }
62 : 486561 : Coin coin = random_coin;
63 : 486561 : bool expected_code_path = false;
64 : 486561 : const bool possible_overwrite = fuzzed_data_provider.ConsumeBool();
65 : 486561 : try {
66 [ + + ]: 486561 : coins_view_cache.AddCoin(random_out_point, std::move(coin), possible_overwrite);
67 : : expected_code_path = true;
68 [ - + ]: 16684 : } catch (const std::logic_error& e) {
69 [ + - + - ]: 16684 : if (e.what() == std::string{"Attempted to overwrite an unspent coin (when possible_overwrite is false)"}) {
70 [ - + ]: 16684 : assert(!possible_overwrite);
71 : 16684 : expected_code_path = true;
72 : : // AddCoin() decreases cachedCoinsUsage by the memory usage of the old coin at the beginning and
73 : : // increases it by the value of the new coin at the end. If it throws in the process, the value
74 : : // of cachedCoinsUsage would have been incorrectly decreased, leading to an underflow later on.
75 : : // To avoid this, use Flush() to reset the value of cachedCoinsUsage in sync with the cacheCoins
76 : : // mapping.
77 [ + - ]: 16684 : (void)coins_view_cache.Flush();
78 : : }
79 : 0 : }
80 : 16684 : assert(expected_code_path);
81 : 486561 : },
82 : 769373 : [&] {
83 : 769373 : (void)coins_view_cache.Flush();
84 : 769373 : },
85 : 1795992 : [&] {
86 : 1795992 : (void)coins_view_cache.Sync();
87 : 1795992 : },
88 : 11002 : [&] {
89 : 11002 : uint256 best_block{ConsumeUInt256(fuzzed_data_provider)};
90 : : // Set best block hash to non-null to satisfy the assertion in CCoinsViewDB::BatchWrite().
91 [ + + + + ]: 11002 : if (is_db && best_block.IsNull()) best_block = uint256::ONE;
92 : 11002 : coins_view_cache.SetBestBlock(best_block);
93 : 11002 : },
94 : 381239 : [&] {
95 : 381239 : Coin move_to;
96 [ + + + - ]: 395994 : (void)coins_view_cache.SpendCoin(random_out_point, fuzzed_data_provider.ConsumeBool() ? &move_to : nullptr);
97 : 381239 : },
98 : 22897 : [&] {
99 : 22897 : coins_view_cache.Uncache(random_out_point);
100 : 22897 : },
101 : 15753 : [&] {
102 [ + + ]: 15753 : if (fuzzed_data_provider.ConsumeBool()) {
103 : 14536 : backend_coins_view = CCoinsView{};
104 : : }
105 : 15753 : coins_view_cache.SetBackend(backend_coins_view);
106 : 15753 : },
107 : 7178 : [&] {
108 : 7178 : const std::optional<COutPoint> opt_out_point = ConsumeDeserializable<COutPoint>(fuzzed_data_provider);
109 [ + + ]: 7178 : if (!opt_out_point) {
110 : 70 : good_data = false;
111 : 70 : return;
112 : : }
113 : 7108 : random_out_point = *opt_out_point;
114 : : },
115 : 21695 : [&] {
116 : 21695 : const std::optional<Coin> opt_coin = ConsumeDeserializable<Coin>(fuzzed_data_provider);
117 [ + + ]: 21695 : if (!opt_coin) {
118 : 208 : good_data = false;
119 : 208 : return;
120 : : }
121 : 21487 : random_coin = *opt_coin;
122 : 21695 : },
123 : 17605 : [&] {
124 : 17605 : const std::optional<CMutableTransaction> opt_mutable_transaction = ConsumeDeserializable<CMutableTransaction>(fuzzed_data_provider, TX_WITH_WITNESS);
125 [ + + ]: 17605 : if (!opt_mutable_transaction) {
126 : 437 : good_data = false;
127 [ - + ]: 437 : return;
128 : : }
129 [ + - ]: 17168 : random_mutable_transaction = *opt_mutable_transaction;
130 : 17605 : },
131 : 30915 : [&] {
132 : 30915 : CoinsCachePair sentinel{};
133 : 30915 : sentinel.second.SelfRef(sentinel);
134 : 30915 : size_t usage{0};
135 [ + - ]: 30915 : CCoinsMapMemoryResource resource;
136 [ + - + - ]: 30915 : CCoinsMap coins_map{0, SaltedOutpointHasher{/*deterministic=*/true}, CCoinsMap::key_equal{}, &resource};
137 [ + - + + : 699158 : LIMITED_WHILE(good_data && fuzzed_data_provider.ConsumeBool(), 10'000)
+ + ]
138 : : {
139 : 668311 : CCoinsCacheEntry coins_cache_entry;
140 : 668311 : const auto dirty{fuzzed_data_provider.ConsumeBool()};
141 : 668311 : const auto fresh{fuzzed_data_provider.ConsumeBool()};
142 [ + + ]: 668311 : if (fuzzed_data_provider.ConsumeBool()) {
143 : 659542 : coins_cache_entry.coin = random_coin;
144 : : } else {
145 : 8769 : const std::optional<Coin> opt_coin = ConsumeDeserializable<Coin>(fuzzed_data_provider);
146 [ + + ]: 8769 : if (!opt_coin) {
147 : 68 : good_data = false;
148 : 68 : return;
149 : : }
150 : 8701 : coins_cache_entry.coin = *opt_coin;
151 : 8701 : }
152 [ + - ]: 668243 : auto it{coins_map.emplace(random_out_point, std::move(coins_cache_entry)).first};
153 [ + + ]: 668243 : if (dirty) CCoinsCacheEntry::SetDirty(*it, sentinel);
154 [ + + ]: 668243 : if (fresh) CCoinsCacheEntry::SetFresh(*it, sentinel);
155 [ + + ]: 668243 : usage += it->second.coin.DynamicMemoryUsage();
156 : 668311 : }
157 : 30847 : bool expected_code_path = false;
158 : 30847 : try {
159 [ + - ]: 30847 : auto cursor{CoinsViewCacheCursor(usage, sentinel, coins_map, /*will_erase=*/true)};
160 [ + - ]: 30847 : uint256 best_block{coins_view_cache.GetBestBlock()};
161 [ + + ]: 30847 : if (fuzzed_data_provider.ConsumeBool()) best_block = ConsumeUInt256(fuzzed_data_provider);
162 : : // Set best block hash to non-null to satisfy the assertion in CCoinsViewDB::BatchWrite().
163 [ + + + + ]: 30847 : if (is_db && best_block.IsNull()) best_block = uint256::ONE;
164 [ + + ]: 30847 : coins_view_cache.BatchWrite(cursor, best_block);
165 : : expected_code_path = true;
166 [ - + ]: 4745 : } catch (const std::logic_error& e) {
167 [ + - + - ]: 4745 : if (e.what() == std::string{"FRESH flag misapplied to coin that exists in parent cache"}) {
168 : 4745 : expected_code_path = true;
169 : : }
170 : 0 : }
171 : 4745 : assert(expected_code_path);
172 : 30915 : });
173 : : }
174 : :
175 : 6525 : {
176 [ + - ]: 6525 : const Coin& coin_using_access_coin = coins_view_cache.AccessCoin(random_out_point);
177 : 6525 : const bool exists_using_access_coin = !(coin_using_access_coin == EMPTY_COIN);
178 [ + - ]: 6525 : const bool exists_using_have_coin = coins_view_cache.HaveCoin(random_out_point);
179 [ + - ]: 6525 : const bool exists_using_have_coin_in_cache = coins_view_cache.HaveCoinInCache(random_out_point);
180 [ + - + + ]: 6525 : if (auto coin{coins_view_cache.GetCoin(random_out_point)}) {
181 [ - + ]: 4705 : assert(*coin == coin_using_access_coin);
182 [ + - - + ]: 4705 : assert(exists_using_access_coin && exists_using_have_coin_in_cache && exists_using_have_coin);
183 : : } else {
184 [ + - - + ]: 1820 : assert(!exists_using_access_coin && !exists_using_have_coin_in_cache && !exists_using_have_coin);
185 : 6525 : }
186 : : // If HaveCoin on the backend is true, it must also be on the cache if the coin wasn't spent.
187 [ + - ]: 6525 : const bool exists_using_have_coin_in_backend = backend_coins_view.HaveCoin(random_out_point);
188 [ + + + + ]: 6525 : if (!coin_using_access_coin.IsSpent() && exists_using_have_coin_in_backend) {
189 [ - + ]: 1809 : assert(exists_using_have_coin);
190 : : }
191 [ + - + + ]: 6525 : if (auto coin{backend_coins_view.GetCoin(random_out_point)}) {
192 [ - + ]: 1857 : assert(exists_using_have_coin_in_backend);
193 : : // Note we can't assert that `coin_using_get_coin == *coin` because the coin in
194 : : // the cache may have been modified but not yet flushed.
195 : : } else {
196 [ - + ]: 4668 : assert(!exists_using_have_coin_in_backend);
197 : 6525 : }
198 : : }
199 : :
200 : 6525 : {
201 : 6525 : bool expected_code_path = false;
202 : 6525 : try {
203 : 6525 : (void)coins_view_cache.Cursor();
204 [ - + ]: 6525 : } catch (const std::logic_error&) {
205 : 6525 : expected_code_path = true;
206 : 6525 : }
207 : 6525 : assert(expected_code_path);
208 [ + - ]: 6525 : (void)coins_view_cache.DynamicMemoryUsage();
209 [ + - ]: 6525 : (void)coins_view_cache.EstimateSize();
210 [ + - ]: 6525 : (void)coins_view_cache.GetBestBlock();
211 [ + - ]: 6525 : (void)coins_view_cache.GetCacheSize();
212 [ + - ]: 6525 : (void)coins_view_cache.GetHeadBlocks();
213 [ + - + - ]: 6525 : (void)coins_view_cache.HaveInputs(CTransaction{random_mutable_transaction});
214 : : }
215 : :
216 : 6525 : {
217 [ + - ]: 6525 : std::unique_ptr<CCoinsViewCursor> coins_view_cursor = backend_coins_view.Cursor();
218 [ - + ]: 6525 : assert(is_db == !!coins_view_cursor);
219 [ + - ]: 6525 : (void)backend_coins_view.EstimateSize();
220 [ + - ]: 6525 : (void)backend_coins_view.GetBestBlock();
221 [ + - ]: 6525 : (void)backend_coins_view.GetHeadBlocks();
222 : 6525 : }
223 : :
224 [ + + ]: 6525 : if (fuzzed_data_provider.ConsumeBool()) {
225 [ + - ]: 4966 : CallOneOf(
226 : : fuzzed_data_provider,
227 : 379 : [&] {
228 : 379 : const CTransaction transaction{random_mutable_transaction};
229 : 379 : bool is_spent = false;
230 [ + + ]: 2024144 : for (const CTxOut& tx_out : transaction.vout) {
231 [ + + ]: 2023765 : if (Coin{tx_out, 0, transaction.IsCoinBase()}.IsSpent()) {
232 : 33 : is_spent = true;
233 : : }
234 : : }
235 [ + + ]: 379 : if (is_spent) {
236 : : // Avoid:
237 : : // coins.cpp:69: void CCoinsViewCache::AddCoin(const COutPoint &, Coin &&, bool): Assertion `!coin.IsSpent()' failed.
238 : 15 : return;
239 : : }
240 : 364 : bool expected_code_path = false;
241 : 364 : const int height{int(fuzzed_data_provider.ConsumeIntegral<uint32_t>() >> 1)};
242 : 364 : const bool possible_overwrite = fuzzed_data_provider.ConsumeBool();
243 : 364 : try {
244 [ + + ]: 364 : AddCoins(coins_view_cache, transaction, height, possible_overwrite);
245 : : expected_code_path = true;
246 [ - + ]: 4 : } catch (const std::logic_error& e) {
247 [ + - + - ]: 4 : if (e.what() == std::string{"Attempted to overwrite an unspent coin (when possible_overwrite is false)"}) {
248 [ - + ]: 4 : assert(!possible_overwrite);
249 : : expected_code_path = true;
250 : : }
251 : 0 : }
252 : 4 : assert(expected_code_path);
253 : 379 : },
254 : 2894 : [&] {
255 [ + - ]: 2894 : (void)AreInputsStandard(CTransaction{random_mutable_transaction}, coins_view_cache);
256 : 2894 : },
257 : 241 : [&] {
258 [ + - ]: 241 : TxValidationState state;
259 : 241 : CAmount tx_fee_out;
260 [ + - ]: 241 : const CTransaction transaction{random_mutable_transaction};
261 [ + + ]: 241 : if (ContainsSpentInput(transaction, coins_view_cache)) {
262 : : // Avoid:
263 : : // consensus/tx_verify.cpp:171: bool Consensus::CheckTxInputs(const CTransaction &, TxValidationState &, const CCoinsViewCache &, int, CAmount &): Assertion `!coin.IsSpent()' failed.
264 : : return;
265 : : }
266 [ + - ]: 224 : TxValidationState dummy;
267 [ + - + + ]: 224 : if (!CheckTransaction(transaction, dummy)) {
268 : : // It is not allowed to call CheckTxInputs if CheckTransaction failed
269 : 144 : return;
270 : : }
271 [ + - + + ]: 80 : if (Consensus::CheckTxInputs(transaction, state, coins_view_cache, fuzzed_data_provider.ConsumeIntegralInRange<int>(0, std::numeric_limits<int>::max()), tx_fee_out)) {
272 [ - + ]: 5 : assert(MoneyRange(tx_fee_out));
273 : : }
274 : 706 : },
275 : 251 : [&] {
276 : 251 : const CTransaction transaction{random_mutable_transaction};
277 [ + + ]: 251 : if (ContainsSpentInput(transaction, coins_view_cache)) {
278 : : // Avoid:
279 : : // consensus/tx_verify.cpp:130: unsigned int GetP2SHSigOpCount(const CTransaction &, const CCoinsViewCache &): Assertion `!coin.IsSpent()' failed.
280 : 68 : return;
281 : : }
282 [ + - ]: 183 : (void)GetP2SHSigOpCount(transaction, coins_view_cache);
283 : 251 : },
284 : 665 : [&] {
285 : 665 : const CTransaction transaction{random_mutable_transaction};
286 [ + + ]: 665 : if (ContainsSpentInput(transaction, coins_view_cache)) {
287 : : // Avoid:
288 : : // consensus/tx_verify.cpp:130: unsigned int GetP2SHSigOpCount(const CTransaction &, const CCoinsViewCache &): Assertion `!coin.IsSpent()' failed.
289 : : return;
290 : : }
291 : 651 : const auto flags{fuzzed_data_provider.ConsumeIntegral<uint32_t>()};
292 [ + + + + ]: 651 : if (!transaction.vin.empty() && (flags & SCRIPT_VERIFY_WITNESS) != 0 && (flags & SCRIPT_VERIFY_P2SH) == 0) {
293 : : // Avoid:
294 : : // script/interpreter.cpp:1705: size_t CountWitnessSigOps(const CScript &, const CScript &, const CScriptWitness *, unsigned int): Assertion `(flags & SCRIPT_VERIFY_P2SH) != 0' failed.
295 : : return;
296 : : }
297 [ + - ]: 649 : (void)GetTransactionSigOpCost(transaction, coins_view_cache, flags);
298 : 665 : },
299 : 536 : [&] {
300 [ + - ]: 536 : (void)IsWitnessStandard(CTransaction{random_mutable_transaction}, coins_view_cache);
301 : 536 : });
302 : : }
303 : 6525 : }
304 : :
305 [ + - ]: 3549 : FUZZ_TARGET(coins_view, .init = initialize_coins_view)
306 : : {
307 [ + - ]: 3099 : FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
308 : 3099 : CCoinsView backend_coins_view;
309 [ + - ]: 3099 : TestCoinsView(fuzzed_data_provider, backend_coins_view, /*is_db=*/false);
310 : 3099 : }
311 : :
312 [ + - ]: 3876 : FUZZ_TARGET(coins_view_db, .init = initialize_coins_view)
313 : : {
314 : 3426 : FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
315 : 3426 : auto db_params = DBParams{
316 : : .path = "",
317 : : .cache_bytes = 1_MiB,
318 : : .memory_only = true,
319 : 3426 : };
320 [ + - ]: 3426 : CCoinsViewDB coins_db{std::move(db_params), CoinsViewOptions{}};
321 [ + - ]: 3426 : TestCoinsView(fuzzed_data_provider, coins_db, /*is_db=*/true);
322 : 6852 : }
|
