Branch data Line data Source code
1 : : // Copyright (c) 2021-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 <chain.h>
6 : : #include <chainparams.h>
7 : : #include <coins.h>
8 : : #include <consensus/consensus.h>
9 : : #include <consensus/validation.h>
10 : : #include <kernel/coinstats.h>
11 : : #include <node/blockstorage.h>
12 : : #include <node/utxo_snapshot.h>
13 : : #include <primitives/block.h>
14 : : #include <primitives/transaction.h>
15 : : #include <serialize.h>
16 : : #include <span.h>
17 : : #include <streams.h>
18 : : #include <sync.h>
19 : : #include <test/fuzz/FuzzedDataProvider.h>
20 : : #include <test/fuzz/fuzz.h>
21 : : #include <test/fuzz/util.h>
22 : : #include <test/util/mining.h>
23 : : #include <test/util/setup_common.h>
24 : : #include <uint256.h>
25 : : #include <util/check.h>
26 : : #include <util/fs.h>
27 : : #include <util/result.h>
28 : : #include <util/time.h>
29 : : #include <validation.h>
30 : :
31 : : #include <cstdint>
32 : : #include <functional>
33 : : #include <ios>
34 : : #include <memory>
35 : : #include <optional>
36 : : #include <vector>
37 : :
38 : : using node::SnapshotMetadata;
39 : :
40 : : namespace {
41 : :
42 : : const std::vector<std::shared_ptr<CBlock>>* g_chain;
43 : : TestingSetup* g_setup{nullptr};
44 : :
45 : : /** Sanity check the assumeutxo values hardcoded in chainparams for the fuzz target. */
46 : 2 : void sanity_check_snapshot()
47 : : {
48 [ + - - + ]: 2 : Assert(g_chain && g_setup == nullptr);
49 : :
50 : : // Create a temporary chainstate manager to connect the chain to.
51 [ + - ]: 2 : const auto tmp_setup{MakeNoLogFileContext<TestingSetup>(ChainType::REGTEST, TestOpts{.setup_net = false})};
52 : 2 : const auto& node{tmp_setup->m_node};
53 [ + + ]: 402 : for (auto& block: *g_chain) {
54 [ + - ]: 400 : ProcessBlock(node, block);
55 : : }
56 : :
57 : : // Connect the chain to the tmp chainman and sanity check the chainparams snapshot values.
58 [ + - ]: 2 : LOCK(cs_main);
59 [ + - ]: 2 : auto& cs{node.chainman->ActiveChainstate()};
60 [ + - ]: 2 : cs.ForceFlushStateToDisk();
61 [ + - + - : 2 : const auto stats{*Assert(kernel::ComputeUTXOStats(kernel::CoinStatsHashType::HASH_SERIALIZED, &cs.CoinsDB(), node.chainman->m_blockman))};
+ - ]
62 [ + - + - ]: 2 : const auto cp_au_data{*Assert(node.chainman->GetParams().AssumeutxoForHeight(2 * COINBASE_MATURITY))};
63 [ + - ]: 2 : Assert(stats.nHeight == cp_au_data.height);
64 [ + - ]: 2 : Assert(stats.nTransactions + 1 == cp_au_data.m_chain_tx_count); // +1 for the genesis tx.
65 [ + - ]: 2 : Assert(stats.hashBlock == cp_au_data.blockhash);
66 [ + - ]: 2 : Assert(AssumeutxoHash{stats.hashSerialized} == cp_au_data.hash_serialized);
67 : 2 : }
68 : :
69 : : template <bool INVALID>
70 : 2 : void initialize_chain()
71 : : {
72 [ + - ]: 2 : const auto params{CreateChainParams(ArgsManager{}, ChainType::REGTEST)};
73 [ + - + - : 4 : static const auto chain{CreateBlockChain(2 * COINBASE_MATURITY, *params)};
+ - ]
74 : 2 : g_chain = &chain;
75 : :
76 : : // Make sure we can generate a valid snapshot.
77 [ + - ]: 2 : sanity_check_snapshot();
78 : :
79 [ + - + - ]: 4 : static const auto setup{
80 : : MakeNoLogFileContext<TestingSetup>(ChainType::REGTEST,
81 : : TestOpts{
82 : : .setup_net = false,
83 : : .setup_validation_interface = false,
84 : : .min_validation_cache = true,
85 : : }),
86 : : };
87 : : if constexpr (INVALID) {
88 : 1 : auto& chainman{*setup->m_node.chainman};
89 [ + + ]: 201 : for (const auto& block : chain) {
90 : 200 : BlockValidationState dummy;
91 [ + - ]: 200 : bool processed{chainman.ProcessNewBlockHeaders({{block->GetBlockHeader()}}, true, dummy)};
92 [ + - ]: 200 : Assert(processed);
93 [ + - + - : 600 : const auto* index{WITH_LOCK(::cs_main, return chainman.m_blockman.LookupBlockIndex(block->GetHash()))};
+ - ]
94 [ + - ]: 200 : Assert(index);
95 : : }
96 : : }
97 : 2 : g_setup = setup.get();
98 [ + - ]: 4 : }
99 : :
100 : : template <bool INVALID>
101 : 577 : void utxo_snapshot_fuzz(FuzzBufferType buffer)
102 : : {
103 : 577 : SeedRandomStateForTest(SeedRand::ZEROS);
104 : 577 : FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
105 : 577 : SetMockTime(ConsumeTime(fuzzed_data_provider, /*min=*/1296688602)); // regtest genesis block timestamp
106 : 577 : auto& setup{*g_setup};
107 : 577 : bool dirty_chainman{false}; // Re-use the global chainman, but reset it when it is dirty
108 : 577 : auto& chainman{*setup.m_node.chainman};
109 : :
110 [ + - ]: 1154 : const auto snapshot_path = gArgs.GetDataDirNet() / "fuzzed_snapshot.dat";
111 : :
112 [ + - + - ]: 577 : Assert(!chainman.SnapshotBlockhash());
113 : :
114 : : {
115 [ + - + - ]: 1154 : AutoFile outfile{fsbridge::fopen(snapshot_path, "wb")};
116 : : // Metadata
117 [ + + ]: 577 : if (fuzzed_data_provider.ConsumeBool()) {
118 [ + - ]: 197 : std::vector<uint8_t> metadata{ConsumeRandomLengthByteVector(fuzzed_data_provider)};
119 [ + - ]: 394 : outfile << std::span{metadata};
120 : 197 : } else {
121 : 380 : auto msg_start = chainman.GetParams().MessageStart();
122 : 380 : int base_blockheight{fuzzed_data_provider.ConsumeIntegralInRange<int>(1, 2 * COINBASE_MATURITY)};
123 [ + - + - ]: 380 : uint256 base_blockhash{g_chain->at(base_blockheight - 1)->GetHash()};
124 : 380 : uint64_t m_coins_count{fuzzed_data_provider.ConsumeIntegralInRange<uint64_t>(1, 3 * COINBASE_MATURITY)};
125 [ + - ]: 380 : SnapshotMetadata metadata{msg_start, base_blockhash, m_coins_count};
126 : 380 : outfile << metadata;
127 : 380 : }
128 : : // Coins
129 [ + + ]: 577 : if (fuzzed_data_provider.ConsumeBool()) {
130 [ + - ]: 334 : std::vector<uint8_t> file_data{ConsumeRandomLengthByteVector(fuzzed_data_provider)};
131 [ + - ]: 668 : outfile << std::span{file_data};
132 : 334 : } else {
133 : 243 : int height{1};
134 [ + - + + ]: 48843 : for (const auto& block : *g_chain) {
135 [ + - + - : 97200 : auto coinbase{block->vtx.at(0)};
+ - ]
136 [ + - ]: 48600 : outfile << coinbase->GetHash();
137 [ + - ]: 48600 : WriteCompactSize(outfile, 1); // number of coins for the hash
138 [ + - ]: 48600 : WriteCompactSize(outfile, 0); // index of coin
139 [ + - ]: 97200 : outfile << Coin(coinbase->vout[0], height, /*fCoinBaseIn=*/1);
140 [ + - ]: 48600 : height++;
141 : : }
142 : : }
143 : : if constexpr (INVALID) {
144 : : // Append an invalid coin to ensure invalidity. This error will be
145 : : // detected late in PopulateAndValidateSnapshot, and allows the
146 : : // INVALID fuzz target to reach more potential code coverage.
147 [ + - ]: 175 : const auto& coinbase{g_chain->back()->vtx.back()};
148 [ + - ]: 175 : outfile << coinbase->GetHash();
149 [ + - ]: 175 : WriteCompactSize(outfile, 1); // number of coins for the hash
150 [ + - ]: 175 : WriteCompactSize(outfile, 999); // index of coin
151 [ + - ]: 350 : outfile << Coin{coinbase->vout[0], /*nHeightIn=*/999, /*fCoinBaseIn=*/0};
152 : : }
153 : 0 : }
154 : :
155 : 1731 : const auto ActivateFuzzedSnapshot{[&] {
156 [ + - + - ]: 1154 : AutoFile infile{fsbridge::fopen(snapshot_path, "rb")};
157 [ + - + - ]: 1154 : auto msg_start = chainman.GetParams().MessageStart();
158 [ + - + - ]: 1154 : SnapshotMetadata metadata{msg_start};
159 : : try {
160 : 888 : infile >> metadata;
161 [ - + - + ]: 266 : } catch (const std::ios_base::failure&) {
162 : : return false;
163 : : }
164 [ + - + - ]: 888 : return !!chainman.ActivateSnapshot(infile, metadata, /*in_memory=*/true);
165 : 2308 : }};
166 : :
167 [ + + ]: 577 : if (fuzzed_data_provider.ConsumeBool()) {
168 : : // Consume the bool, but skip the code for the INVALID fuzz target
169 : : if constexpr (!INVALID) {
170 [ + + ]: 73767 : for (const auto& block : *g_chain) {
171 : 73400 : BlockValidationState dummy;
172 [ + - ]: 73400 : bool processed{chainman.ProcessNewBlockHeaders({{block->GetBlockHeader()}}, true, dummy)};
173 [ + - ]: 73400 : Assert(processed);
174 [ + - + - : 220200 : const auto* index{WITH_LOCK(::cs_main, return chainman.m_blockman.LookupBlockIndex(block->GetHash()))};
+ - ]
175 [ + - ]: 73400 : Assert(index);
176 : : }
177 : : dirty_chainman = true;
178 : : }
179 : : }
180 : :
181 [ + - + + ]: 577 : if (ActivateFuzzedSnapshot()) {
182 [ + - ]: 17 : LOCK(::cs_main);
183 [ + - + - ]: 17 : Assert(!chainman.ActiveChainstate().m_from_snapshot_blockhash->IsNull());
184 [ + - + - : 17 : Assert(*chainman.ActiveChainstate().m_from_snapshot_blockhash ==
+ - ]
185 : : *chainman.SnapshotBlockhash());
186 [ + - + - ]: 17 : const auto& coinscache{chainman.ActiveChainstate().CoinsTip()};
187 [ + + ]: 3417 : for (const auto& block : *g_chain) {
188 [ + - + - : 3400 : Assert(coinscache.HaveCoin(COutPoint{block->vtx.at(0)->GetHash(), 0}));
+ - ]
189 [ + - + - ]: 3400 : const auto* index{chainman.m_blockman.LookupBlockIndex(block->GetHash())};
190 [ + - ]: 3400 : Assert(index);
191 [ + - ]: 3400 : Assert(index->nTx == 0);
192 [ + - + - ]: 3417 : if (index->nHeight == chainman.GetSnapshotBaseHeight()) {
193 [ + - ]: 17 : auto params{chainman.GetParams().AssumeutxoForHeight(index->nHeight)};
194 [ + - ]: 17 : Assert(params.has_value());
195 [ + - ]: 17 : Assert(params.value().m_chain_tx_count == index->m_chain_tx_count);
196 : : } else {
197 [ + - ]: 3383 : Assert(index->m_chain_tx_count == 0);
198 : : }
199 : : }
200 [ + - + - ]: 17 : Assert(g_chain->size() == coinscache.GetCacheSize());
201 [ + - ]: 17 : dirty_chainman = true;
202 : 17 : } else {
203 [ + - + - ]: 560 : Assert(!chainman.SnapshotBlockhash());
204 [ + - + - ]: 560 : Assert(!chainman.ActiveChainstate().m_from_snapshot_blockhash);
205 : : }
206 : : // Snapshot should refuse to load a second time regardless of validity
207 [ + - + - ]: 577 : Assert(!ActivateFuzzedSnapshot());
208 : : if constexpr (INVALID) {
209 : : // Activating the snapshot, or any other action that makes the chainman
210 : : // "dirty" can and must not happen for the INVALID fuzz target
211 [ + - ]: 175 : Assert(!dirty_chainman);
212 : : }
213 [ + + ]: 577 : if (dirty_chainman) {
214 [ + - ]: 367 : setup.m_node.chainman.reset();
215 [ + - ]: 367 : setup.m_make_chainman();
216 [ + - ]: 367 : setup.LoadVerifyActivateChainstate();
217 : : }
218 : 577 : }
219 : :
220 : : // There are two fuzz targets:
221 : : //
222 : : // The target 'utxo_snapshot', which allows valid snapshots, but is slow,
223 : : // because it has to reset the chainstate manager on almost all fuzz inputs.
224 : : // Otherwise, a dirty header tree or dirty chainstate could leak from one fuzz
225 : : // input execution into the next, which makes execution non-deterministic.
226 : : //
227 : : // The target 'utxo_snapshot_invalid', which is fast and does not require any
228 : : // expensive state to be reset.
229 [ + - ]: 842 : FUZZ_TARGET(utxo_snapshot /*valid*/, .init = initialize_chain<false>) { utxo_snapshot_fuzz<false>(buffer); }
230 [ + - ]: 615 : FUZZ_TARGET(utxo_snapshot_invalid, .init = initialize_chain<true>) { utxo_snapshot_fuzz<true>(buffer); }
231 : :
232 : : } // namespace
|
