Bitcoin Core  22.99.0
P2P Digital Currency
utxo_snapshot.cpp
Go to the documentation of this file.
1 // Copyright (c) 2021 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 <chainparams.h>
6 #include <consensus/validation.h>
7 #include <node/utxo_snapshot.h>
9 #include <test/fuzz/fuzz.h>
10 #include <test/fuzz/util.h>
11 #include <test/util/mining.h>
12 #include <test/util/setup_common.h>
13 #include <validation.h>
14 #include <validationinterface.h>
15 
17 
18 namespace {
19 
20 const std::vector<std::shared_ptr<CBlock>>* g_chain;
21 
22 void initialize_chain()
23 {
25  static const auto chain{CreateBlockChain(2 * COINBASE_MATURITY, *params)};
26  g_chain = &chain;
27 }
28 
29 FUZZ_TARGET_INIT(utxo_snapshot, initialize_chain)
30 {
31  FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
32  std::unique_ptr<const TestingSetup> setup{MakeNoLogFileContext<const TestingSetup>()};
33  const auto& node = setup->m_node;
34  auto& chainman{*node.chainman};
35 
36  const auto snapshot_path = gArgs.GetDataDirNet() / "fuzzed_snapshot.dat";
37 
38  Assert(!chainman.SnapshotBlockhash());
39 
40  {
41  CAutoFile outfile{fsbridge::fopen(snapshot_path, "wb"), SER_DISK, CLIENT_VERSION};
42  const auto file_data{ConsumeRandomLengthByteVector(fuzzed_data_provider)};
43  outfile << Span{file_data};
44  }
45 
46  const auto ActivateFuzzedSnapshot{[&] {
47  CAutoFile infile{fsbridge::fopen(snapshot_path, "rb"), SER_DISK, CLIENT_VERSION};
48  SnapshotMetadata metadata;
49  try {
50  infile >> metadata;
51  } catch (const std::ios_base::failure&) {
52  return false;
53  }
54  return chainman.ActivateSnapshot(infile, metadata, /*in_memory=*/true);
55  }};
56 
57  if (fuzzed_data_provider.ConsumeBool()) {
58  for (const auto& block : *g_chain) {
60  bool processed{chainman.ProcessNewBlockHeaders({*block}, dummy, ::Params())};
61  Assert(processed);
62  const auto* index{WITH_LOCK(::cs_main, return chainman.m_blockman.LookupBlockIndex(block->GetHash()))};
63  Assert(index);
64  }
65  }
66 
67  if (ActivateFuzzedSnapshot()) {
68  LOCK(::cs_main);
69  Assert(!chainman.ActiveChainstate().m_from_snapshot_blockhash->IsNull());
70  Assert(*chainman.ActiveChainstate().m_from_snapshot_blockhash ==
71  *chainman.SnapshotBlockhash());
72  const auto& coinscache{chainman.ActiveChainstate().CoinsTip()};
73  int64_t chain_tx{};
74  for (const auto& block : *g_chain) {
75  Assert(coinscache.HaveCoin(COutPoint{block->vtx.at(0)->GetHash(), 0}));
76  const auto* index{chainman.m_blockman.LookupBlockIndex(block->GetHash())};
77  const auto num_tx{Assert(index)->nTx};
78  Assert(num_tx == 1);
79  chain_tx += num_tx;
80  }
81  Assert(g_chain->size() == coinscache.GetCacheSize());
82  Assert(chain_tx == chainman.ActiveTip()->nChainTx);
83  } else {
84  Assert(!chainman.SnapshotBlockhash());
85  Assert(!chainman.ActiveChainstate().m_from_snapshot_blockhash);
86  }
87  // Snapshot should refuse to load a second time regardless of validity
88  Assert(!ActivateFuzzedSnapshot());
89 }
90 } // namespace
SER_DISK
@ SER_DISK
Definition: serialize.h:139
COINBASE_MATURITY
static const int COINBASE_MATURITY
Coinbase transaction outputs can only be spent after this number of new blocks (network rule)
Definition: consensus.h:19
node::SnapshotMetadata
Metadata describing a serialized version of a UTXO set from which an assumeutxo CChainState can be co...
Definition: utxo_snapshot.h:15
BlockValidationState
Definition: validation.h:141
fsbridge::fopen
FILE * fopen(const fs::path &p, const char *mode)
Definition: fs.cpp:25
ArgsManager::GetDataDirNet
const fs::path & GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: system.h:288
setup_common.h
validationinterface.h
validation.h
util.h
WITH_LOCK
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:270
chainparams.h
Assert
#define Assert(val)
Identity function.
Definition: check.h:57
CAutoFile
Non-refcounted RAII wrapper for FILE*.
Definition: streams.h:544
Span
A Span is an object that can refer to a contiguous sequence of objects.
Definition: span.h:96
CBaseChainParams::REGTEST
static const std::string REGTEST
Definition: chainparamsbase.h:25
FuzzedDataProvider.h
ConsumeRandomLengthByteVector
std::vector< uint8_t > ConsumeRandomLengthByteVector(FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
Definition: util.h:63
utxo_snapshot.h
gArgs
ArgsManager gArgs
Definition: system.cpp:85
cs_main
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: validation.cpp:138
ArgsManager
Definition: system.h:158
fuzz.h
LOCK
#define LOCK(cs)
Definition: sync.h:226
FuzzedDataProvider
Definition: FuzzedDataProvider.h:31
CLIENT_VERSION
static const int CLIENT_VERSION
bitcoind-res.rc includes this file, but it cannot cope with real c++ code.
Definition: clientversion.h:33
Params
const CChainParams & Params()
Return the currently selected parameters.
Definition: chainparams.cpp:561
node
Definition: init.h:22
COutPoint
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:26
FUZZ_TARGET_INIT
#define FUZZ_TARGET_INIT(name, init_fun)
Definition: fuzz.h:34
CreateChainParams
std::unique_ptr< const CChainParams > CreateChainParams(const ArgsManager &args, const std::string &chain)
Creates and returns a std::unique_ptr<CChainParams> of the chosen chain.
Definition: chainparams.cpp:566
mining.h
CreateBlockChain
std::vector< std::shared_ptr< CBlock > > CreateBlockChain(size_t total_height, const CChainParams &params)
Create a blockchain, starting from genesis.
Definition: mining.cpp:31