Coverage Report

Created: 2025-10-29 16:48

/root/bitcoin/src/test/fuzz/headerssync.cpp
Line
Count
Source (jump to first uncovered line)
1
// Copyright (c) 2022-present The Bitcoin Core developers
2
// Distributed under the MIT software license, see the accompanying
3
// file COPYING or https://opensource.org/license/mit.
4
5
#include <arith_uint256.h>
6
#include <chain.h>
7
#include <chainparams.h>
8
#include <headerssync.h>
9
#include <test/fuzz/fuzz.h>
10
#include <test/fuzz/util.h>
11
#include <test/util/setup_common.h>
12
#include <uint256.h>
13
#include <util/chaintype.h>
14
#include <util/time.h>
15
#include <validation.h>
16
17
#include <iterator>
18
#include <vector>
19
20
static void initialize_headers_sync_state_fuzz()
21
0
{
22
0
    static const auto testing_setup = MakeNoLogFileContext<>(
23
0
        /*chain_type=*/ChainType::MAIN);
24
0
}
25
26
void MakeHeadersContinuous(
27
    const CBlockHeader& genesis_header,
28
    const std::vector<CBlockHeader>& all_headers,
29
    std::vector<CBlockHeader>& new_headers)
30
0
{
31
0
    Assume(!new_headers.empty());
32
33
0
    const CBlockHeader* prev_header{
34
0
        all_headers.empty() ? &genesis_header : &all_headers.back()};
35
36
0
    for (auto& header : new_headers) {
37
0
        header.hashPrevBlock = prev_header->GetHash();
38
39
0
        prev_header = &header;
40
0
    }
41
0
}
42
43
class FuzzedHeadersSyncState : public HeadersSyncState
44
{
45
public:
46
    FuzzedHeadersSyncState(const HeadersSyncParams& sync_params, const size_t commit_offset,
47
                           const CBlockIndex* chain_start, const arith_uint256& minimum_required_work)
48
0
        : HeadersSyncState(/*id=*/0, Params().GetConsensus(), sync_params, chain_start, minimum_required_work)
49
0
    {
50
0
        const_cast<size_t&>(m_commit_offset) = commit_offset;
51
0
    }
52
};
53
54
FUZZ_TARGET(headers_sync_state, .init = initialize_headers_sync_state_fuzz)
55
0
{
56
0
    SeedRandomStateForTest(SeedRand::ZEROS);
57
0
    FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
58
0
    auto mock_time{ConsumeTime(fuzzed_data_provider)};
59
60
0
    CBlockHeader genesis_header{Params().GenesisBlock()};
61
0
    CBlockIndex start_index(genesis_header);
62
63
0
    if (mock_time < start_index.GetMedianTimePast()) return;
64
0
    SetMockTime(mock_time);
65
66
0
    const uint256 genesis_hash = genesis_header.GetHash();
67
0
    start_index.phashBlock = &genesis_hash;
68
69
0
    const HeadersSyncParams params{
70
0
        .commitment_period = fuzzed_data_provider.ConsumeIntegralInRange<size_t>(1, Params().HeadersSync().commitment_period * 2),
71
0
        .redownload_buffer_size = fuzzed_data_provider.ConsumeIntegralInRange<size_t>(0, Params().HeadersSync().redownload_buffer_size * 2),
72
0
    };
73
0
    arith_uint256 min_work{UintToArith256(ConsumeUInt256(fuzzed_data_provider))};
74
0
    FuzzedHeadersSyncState headers_sync(
75
0
        params,
76
0
        /*commit_offset=*/fuzzed_data_provider.ConsumeIntegralInRange<size_t>(0, params.commitment_period - 1),
77
0
        /*chain_start=*/&start_index,
78
0
        /*minimum_required_work=*/min_work);
79
80
    // Store headers for potential redownload phase.
81
0
    std::vector<CBlockHeader> all_headers;
82
0
    std::vector<CBlockHeader>::const_iterator redownloaded_it;
83
0
    bool presync{true};
84
0
    bool requested_more{true};
85
86
0
    while (requested_more) {
87
0
        std::vector<CBlockHeader> headers;
88
89
        // Consume headers from fuzzer or maybe replay headers if we got to the
90
        // redownload phase.
91
0
        if (presync || fuzzed_data_provider.ConsumeBool()) {
92
0
            auto deser_headers = ConsumeDeserializable<std::vector<CBlockHeader>>(fuzzed_data_provider);
93
0
            if (!deser_headers || deser_headers->empty()) return;
94
95
0
            if (fuzzed_data_provider.ConsumeBool()) {
96
0
                MakeHeadersContinuous(genesis_header, all_headers, *deser_headers);
97
0
            }
98
99
0
            headers.swap(*deser_headers);
100
0
        } else if (auto num_headers_left{std::distance(redownloaded_it, all_headers.cend())}; num_headers_left > 0) {
101
            // Consume some headers from the redownload buffer (At least one
102
            // header is consumed).
103
0
            auto begin_it{redownloaded_it};
104
0
            std::advance(redownloaded_it, fuzzed_data_provider.ConsumeIntegralInRange<int>(1, num_headers_left));
105
0
            headers.insert(headers.cend(), begin_it, redownloaded_it);
106
0
        }
107
108
0
        if (headers.empty()) return;
109
0
        auto result = headers_sync.ProcessNextHeaders(headers, fuzzed_data_provider.ConsumeBool());
110
0
        requested_more = result.request_more;
111
112
0
        if (result.request_more) {
113
0
            if (presync) {
114
0
                all_headers.insert(all_headers.cend(), headers.cbegin(), headers.cend());
115
116
0
                if (headers_sync.GetState() == HeadersSyncState::State::REDOWNLOAD) {
117
0
                    presync = false;
118
0
                    redownloaded_it = all_headers.cbegin();
119
120
                    // If we get to redownloading, the presynced headers need
121
                    // to have the min amount of work on them.
122
0
                    assert(CalculateClaimedHeadersWork(all_headers) >= min_work);
123
0
                }
124
0
            }
125
126
0
            (void)headers_sync.NextHeadersRequestLocator();
127
0
        }
128
0
    }
129
0
}