Bitcoin Core 28.99.0
P2P Digital Currency
partially_downloaded_block.cpp
Go to the documentation of this file.
1#include <blockencodings.h>
2#include <consensus/merkle.h>
4#include <primitives/block.h>
7#include <test/fuzz/fuzz.h>
8#include <test/fuzz/util.h>
11#include <test/util/txmempool.h>
12#include <txmempool.h>
13#include <util/check.h>
14#include <util/time.h>
15#include <util/translation.h>
16
17#include <cstddef>
18#include <cstdint>
19#include <limits>
20#include <memory>
21#include <optional>
22#include <set>
23#include <vector>
24
25namespace {
26const TestingSetup* g_setup;
27} // namespace
28
30{
31 static const auto testing_setup = MakeNoLogFileContext<const TestingSetup>();
32 g_setup = testing_setup.get();
33}
34
35PartiallyDownloadedBlock::CheckBlockFn FuzzedCheckBlock(std::optional<BlockValidationResult> result)
36{
37 return [result](const CBlock&, BlockValidationState& state, const Consensus::Params&, bool, bool) {
38 if (result) {
39 return state.Invalid(*result);
40 }
41
42 return true;
43 };
44}
45
46FUZZ_TARGET(partially_downloaded_block, .init = initialize_pdb)
47{
49 FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
50 SetMockTime(ConsumeTime(fuzzed_data_provider));
51
52 auto block{ConsumeDeserializable<CBlock>(fuzzed_data_provider, TX_WITH_WITNESS)};
53 if (!block || block->vtx.size() == 0 ||
54 block->vtx.size() >= std::numeric_limits<uint16_t>::max()) {
55 return;
56 }
57
58 CBlockHeaderAndShortTxIDs cmpctblock{*block, fuzzed_data_provider.ConsumeIntegral<uint64_t>()};
59
60 bilingual_str error;
61 CTxMemPool pool{MemPoolOptionsForTest(g_setup->m_node), error};
62 Assert(error.empty());
63 PartiallyDownloadedBlock pdb{&pool};
64
65 // Set of available transactions (mempool or extra_txn)
66 std::set<uint16_t> available;
67 // The coinbase is always available
68 available.insert(0);
69
70 std::vector<CTransactionRef> extra_txn;
71 for (size_t i = 1; i < block->vtx.size(); ++i) {
72 auto tx{block->vtx[i]};
73
74 bool add_to_extra_txn{fuzzed_data_provider.ConsumeBool()};
75 bool add_to_mempool{fuzzed_data_provider.ConsumeBool()};
76
77 if (add_to_extra_txn) {
78 extra_txn.emplace_back(tx);
79 available.insert(i);
80 }
81
82 if (add_to_mempool && !pool.exists(GenTxid::Txid(tx->GetHash()))) {
83 LOCK2(cs_main, pool.cs);
84 AddToMempool(pool, ConsumeTxMemPoolEntry(fuzzed_data_provider, *tx));
85 available.insert(i);
86 }
87 }
88
89 auto init_status{pdb.InitData(cmpctblock, extra_txn)};
90
91 std::vector<CTransactionRef> missing;
92 // Whether we skipped a transaction that should be included in `missing`.
93 // FillBlock should never return READ_STATUS_OK if that is the case.
94 bool skipped_missing{false};
95 for (size_t i = 0; i < cmpctblock.BlockTxCount(); i++) {
96 // If init_status == READ_STATUS_OK then a available transaction in the
97 // compact block (i.e. IsTxAvailable(i) == true) implies that we marked
98 // that transaction as available above (i.e. available.count(i) > 0).
99 // The reverse is not true, due to possible compact block short id
100 // collisions (i.e. available.count(i) > 0 does not imply
101 // IsTxAvailable(i) == true).
102 if (init_status == READ_STATUS_OK) {
103 assert(!pdb.IsTxAvailable(i) || available.count(i) > 0);
104 }
105
106 bool skip{fuzzed_data_provider.ConsumeBool()};
107 if (!pdb.IsTxAvailable(i) && !skip) {
108 missing.push_back(block->vtx[i]);
109 }
110
111 skipped_missing |= (!pdb.IsTxAvailable(i) && skip);
112 }
113
114 // Mock CheckBlock
115 bool fail_check_block{fuzzed_data_provider.ConsumeBool()};
116 auto validation_result =
117 fuzzed_data_provider.PickValueInArray(
128 pdb.m_check_block_mock = FuzzedCheckBlock(
129 fail_check_block ?
130 std::optional<BlockValidationResult>{validation_result} :
131 std::nullopt);
132
133 CBlock reconstructed_block;
134 auto fill_status{pdb.FillBlock(reconstructed_block, missing)};
135 switch (fill_status) {
136 case READ_STATUS_OK:
137 assert(!skipped_missing);
138 assert(!fail_check_block);
139 assert(block->GetHash() == reconstructed_block.GetHash());
140 break;
141 case READ_STATUS_CHECKBLOCK_FAILED: [[fallthrough]];
143 assert(fail_check_block);
144 break;
146 break;
147 }
148}
@ READ_STATUS_OK
@ READ_STATUS_INVALID
@ READ_STATUS_CHECKBLOCK_FAILED
@ READ_STATUS_FAILED
#define Assert(val)
Identity function.
Definition: check.h:85
Definition: block.h:69
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
Definition: txmempool.h:304
static GenTxid Txid(const uint256 &hash)
Definition: transaction.h:434
std::function< bool(const CBlock &, BlockValidationState &, const Consensus::Params &, bool, bool)> CheckBlockFn
@ BLOCK_CHECKPOINT
the block failed to meet one of our checkpoints
@ BLOCK_HEADER_LOW_WORK
the block header may be on a too-little-work chain
@ BLOCK_INVALID_HEADER
invalid proof of work or time too old
@ BLOCK_CACHED_INVALID
this block was cached as being invalid and we didn't store the reason why
@ BLOCK_CONSENSUS
invalid by consensus rules (excluding any below reasons)
@ BLOCK_MISSING_PREV
We don't have the previous block the checked one is built on.
@ BLOCK_INVALID_PREV
A block this one builds on is invalid.
@ BLOCK_MUTATED
the block's data didn't match the data committed to by the PoW
@ BLOCK_TIME_FUTURE
block timestamp was > 2 hours in the future (or our clock is bad)
@ BLOCK_RESULT_UNSET
initial value. Block has not yet been rejected
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
AddToMempool(pool, CTxMemPoolEntry(tx, fee, nTime, nHeight, sequence, spendsCoinbase, sigOpCost, lp))
FUZZ_TARGET(partially_downloaded_block,.init=initialize_pdb)
void initialize_pdb()
PartiallyDownloadedBlock::CheckBlockFn FuzzedCheckBlock(std::optional< BlockValidationResult > result)
static constexpr TransactionSerParams TX_WITH_WITNESS
Definition: transaction.h:195
Parameters that influence chain consensus.
Definition: params.h:74
Testing setup that configures a complete environment.
Definition: setup_common.h:121
Bilingual messages:
Definition: translation.h:24
bool empty() const
Definition: translation.h:35
#define LOCK2(cs1, cs2)
Definition: sync.h:258
CTxMemPoolEntry ConsumeTxMemPoolEntry(FuzzedDataProvider &fuzzed_data_provider, const CTransaction &tx) noexcept
Definition: mempool.cpp:17
int64_t ConsumeTime(FuzzedDataProvider &fuzzed_data_provider, const std::optional< int64_t > &min, const std::optional< int64_t > &max) noexcept
Definition: util.cpp:34
void SeedRandomStateForTest(SeedRand seedtype)
Seed the global RNG state for testing and log the seed value.
Definition: random.cpp:19
@ ZEROS
Seed with a compile time constant of zeros.
CTxMemPool::Options MemPoolOptionsForTest(const NodeContext &node)
Definition: txmempool.cpp:20
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:39
assert(!tx.IsCoinBase())