Bitcoin Core Fuzz Coverage Report

Coverage Report

Created: 2026-05-28 15:05

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/Users/brunogarcia/projects/bitcoin-core-dev/src/validation.cpp
Line
Count
Source
1
// Copyright (c) 2009-2010 Satoshi Nakamoto
2
// Copyright (c) 2009-present The Bitcoin Core developers
3
// Distributed under the MIT software license, see the accompanying
4
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6
#include <bitcoin-build-config.h> // IWYU pragma: keep
7
8
#include <validation.h>
9
10
#include <arith_uint256.h>
11
#include <chain.h>
12
#include <checkqueue.h>
13
#include <clientversion.h>
14
#include <consensus/amount.h>
15
#include <consensus/consensus.h>
16
#include <consensus/merkle.h>
17
#include <consensus/tx_check.h>
18
#include <consensus/tx_verify.h>
19
#include <consensus/validation.h>
20
#include <cuckoocache.h>
21
#include <flatfile.h>
22
#include <hash.h>
23
#include <kernel/chainparams.h>
24
#include <kernel/coinstats.h>
25
#include <kernel/disconnected_transactions.h>
26
#include <kernel/mempool_entry.h>
27
#include <kernel/messagestartchars.h>
28
#include <kernel/notifications_interface.h>
29
#include <kernel/types.h>
30
#include <kernel/warning.h>
31
#include <logging/timer.h>
32
#include <node/blockstorage.h>
33
#include <node/utxo_snapshot.h>
34
#include <policy/ephemeral_policy.h>
35
#include <policy/policy.h>
36
#include <policy/rbf.h>
37
#include <policy/settings.h>
38
#include <policy/truc_policy.h>
39
#include <pow.h>
40
#include <primitives/block.h>
41
#include <primitives/transaction.h>
42
#include <random.h>
43
#include <script/script.h>
44
#include <script/sigcache.h>
45
#include <signet.h>
46
#include <tinyformat.h>
47
#include <txdb.h>
48
#include <txmempool.h>
49
#include <uint256.h>
50
#include <undo.h>
51
#include <util/check.h>
52
#include <util/fs.h>
53
#include <util/fs_helpers.h>
54
#include <util/hasher.h>
55
#include <util/log.h>
56
#include <util/moneystr.h>
57
#include <util/rbf.h>
58
#include <util/result.h>
59
#include <util/signalinterrupt.h>
60
#include <util/strencodings.h>
61
#include <util/string.h>
62
#include <util/time.h>
63
#include <util/trace.h>
64
#include <util/translation.h>
65
#include <validationinterface.h>
66
67
#include <algorithm>
68
#include <cassert>
69
#include <chrono>
70
#include <deque>
71
#include <numeric>
72
#include <optional>
73
#include <ranges>
74
#include <span>
75
#include <string>
76
#include <tuple>
77
#include <utility>
78
79
using kernel::CCoinsStats;
80
using kernel::ChainstateRole;
81
using kernel::CoinStatsHashType;
82
using kernel::ComputeUTXOStats;
83
using kernel::Notifications;
84
85
using fsbridge::FopenFn;
86
using node::BlockManager;
87
using node::BlockMap;
88
using node::CBlockIndexHeightOnlyComparator;
89
using node::CBlockIndexWorkComparator;
90
using node::SnapshotMetadata;
91
92
/** Time window to wait between writing blocks/block index and chainstate to disk.
93
 *  Randomize writing time inside the window to prevent a situation where the
94
 *  network over time settles into a few cohorts of synchronized writers.
95
*/
96
static constexpr auto DATABASE_WRITE_INTERVAL_MIN{50min};
97
static constexpr auto DATABASE_WRITE_INTERVAL_MAX{70min};
98
/** Maximum age of our tip for us to be considered current for fee estimation */
99
static constexpr std::chrono::hours MAX_FEE_ESTIMATION_TIP_AGE{3};
100
const std::vector<std::string> CHECKLEVEL_DOC {
101
    "level 0 reads the blocks from disk",
102
    "level 1 verifies block validity",
103
    "level 2 verifies undo data",
104
    "level 3 checks disconnection of tip blocks",
105
    "level 4 tries to reconnect the blocks",
106
    "each level includes the checks of the previous levels",
107
};
108
/** The number of blocks to keep below the deepest prune lock.
109
 *  There is nothing special about this number. It is higher than what we
110
 *  expect to see in regular mainnet reorgs, but not so high that it would
111
 *  noticeably interfere with the pruning mechanism.
112
 * */
113
static constexpr int PRUNE_LOCK_BUFFER{10};
114
115
TRACEPOINT_SEMAPHORE(validation, block_connected);
116
TRACEPOINT_SEMAPHORE(utxocache, flush);
117
TRACEPOINT_SEMAPHORE(mempool, replaced);
118
TRACEPOINT_SEMAPHORE(mempool, rejected);
119
120
const CBlockIndex* Chainstate::FindForkInGlobalIndex(const CBlockLocator& locator) const
121
0
{
122
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
123
124
    // Find the latest block common to locator and chain - we expect that
125
    // locator.vHave is sorted descending by height.
126
0
    for (const uint256& hash : locator.vHave) {
127
0
        const CBlockIndex* pindex{m_blockman.LookupBlockIndex(hash)};
128
0
        if (pindex) {
129
0
            if (m_chain.Contains(pindex)) {
130
0
                return pindex;
131
0
            }
132
0
            if (pindex->GetAncestor(m_chain.Height()) == m_chain.Tip()) {
133
0
                return m_chain.Tip();
134
0
            }
135
0
        }
136
0
    }
137
0
    return m_chain.Genesis();
138
0
}
139
140
bool CheckInputScripts(const CTransaction& tx, TxValidationState& state,
141
                       const CCoinsViewCache& inputs, script_verify_flags flags, bool cacheSigStore,
142
                       bool cacheFullScriptStore, PrecomputedTransactionData& txdata,
143
                       ValidationCache& validation_cache,
144
                       std::vector<CScriptCheck>* pvChecks = nullptr)
145
                       EXCLUSIVE_LOCKS_REQUIRED(cs_main);
146
147
bool CheckFinalTxAtTip(const CBlockIndex& active_chain_tip, const CTransaction& tx)
148
0
{
149
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
150
151
    // CheckFinalTxAtTip() uses active_chain_tip.Height()+1 to evaluate
152
    // nLockTime because when IsFinalTx() is called within
153
    // AcceptBlock(), the height of the block *being*
154
    // evaluated is what is used. Thus if we want to know if a
155
    // transaction can be part of the *next* block, we need to call
156
    // IsFinalTx() with one more than active_chain_tip.Height().
157
0
    const int nBlockHeight = active_chain_tip.nHeight + 1;
158
159
    // BIP113 requires that time-locked transactions have nLockTime set to
160
    // less than the median time of the previous block they're contained in.
161
    // When the next block is created its previous block will be the current
162
    // chain tip, so we use that to calculate the median time passed to
163
    // IsFinalTx().
164
0
    const int64_t nBlockTime{active_chain_tip.GetMedianTimePast()};
165
166
0
    return IsFinalTx(tx, nBlockHeight, nBlockTime);
167
0
}
168
169
namespace {
170
/**
171
 * A helper which calculates heights of inputs of a given transaction.
172
 *
173
 * @param[in] tip    The current chain tip. If an input belongs to a mempool
174
 *                   transaction, we assume it will be confirmed in the next block.
175
 * @param[in] coins  Any CCoinsView that provides access to the relevant coins.
176
 * @param[in] tx     The transaction being evaluated.
177
 *
178
 * @returns A vector of input heights or nullopt, in case of an error.
179
 */
180
std::optional<std::vector<int>> CalculatePrevHeights(
181
    const CBlockIndex& tip,
182
    const CCoinsView& coins,
183
    const CTransaction& tx)
184
0
{
185
0
    std::vector<int> prev_heights;
186
0
    prev_heights.resize(tx.vin.size());
187
0
    for (size_t i = 0; i < tx.vin.size(); ++i) {
188
0
        if (auto coin{coins.GetCoin(tx.vin[i].prevout)}) {
189
0
            prev_heights[i] = coin->nHeight == MEMPOOL_HEIGHT
190
0
                              ? tip.nHeight + 1 // Assume all mempool transaction confirm in the next block.
191
0
                              : coin->nHeight;
192
0
        } else {
193
0
            LogInfo("ERROR: %s: Missing input %d in transaction \'%s\'\n", __func__, i, tx.GetHash().GetHex());
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
194
0
            return std::nullopt;
195
0
        }
196
0
    }
197
0
    return prev_heights;
198
0
}
199
} // namespace
200
201
std::optional<LockPoints> CalculateLockPointsAtTip(
202
    CBlockIndex* tip,
203
    const CCoinsView& coins_view,
204
    const CTransaction& tx)
205
0
{
206
0
    assert(tip);
207
208
0
    auto prev_heights{CalculatePrevHeights(*tip, coins_view, tx)};
209
0
    if (!prev_heights.has_value()) return std::nullopt;
210
211
0
    CBlockIndex next_tip;
212
0
    next_tip.pprev = tip;
213
    // When SequenceLocks() is called within ConnectBlock(), the height
214
    // of the block *being* evaluated is what is used.
215
    // Thus if we want to know if a transaction can be part of the
216
    // *next* block, we need to use one more than active_chainstate.m_chain.Height()
217
0
    next_tip.nHeight = tip->nHeight + 1;
218
0
    const auto [min_height, min_time] = CalculateSequenceLocks(tx, STANDARD_LOCKTIME_VERIFY_FLAGS, prev_heights.value(), next_tip);
219
220
    // Also store the hash of the block with the highest height of
221
    // all the blocks which have sequence locked prevouts.
222
    // This hash needs to still be on the chain
223
    // for these LockPoint calculations to be valid
224
    // Note: It is impossible to correctly calculate a maxInputBlock
225
    // if any of the sequence locked inputs depend on unconfirmed txs,
226
    // except in the special case where the relative lock time/height
227
    // is 0, which is equivalent to no sequence lock. Since we assume
228
    // input height of tip+1 for mempool txs and test the resulting
229
    // min_height and min_time from CalculateSequenceLocks against tip+1.
230
0
    int max_input_height{0};
231
0
    for (const int height : prev_heights.value()) {
232
        // Can ignore mempool inputs since we'll fail if they had non-zero locks
233
0
        if (height != next_tip.nHeight) {
234
0
            max_input_height = std::max(max_input_height, height);
235
0
        }
236
0
    }
237
238
    // tip->GetAncestor(max_input_height) should never return a nullptr
239
    // because max_input_height is always less than the tip height.
240
    // It would, however, be a bad bug to continue execution, since a
241
    // LockPoints object with the maxInputBlock member set to nullptr
242
    // signifies no relative lock time.
243
0
    return LockPoints{min_height, min_time, Assert(tip->GetAncestor(max_input_height))};
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
244
0
}
245
246
bool CheckSequenceLocksAtTip(CBlockIndex* tip,
247
                             const LockPoints& lock_points)
248
0
{
249
0
    assert(tip != nullptr);
250
251
0
    CBlockIndex index;
252
0
    index.pprev = tip;
253
    // CheckSequenceLocksAtTip() uses active_chainstate.m_chain.Height()+1 to evaluate
254
    // height based locks because when SequenceLocks() is called within
255
    // ConnectBlock(), the height of the block *being*
256
    // evaluated is what is used.
257
    // Thus if we want to know if a transaction can be part of the
258
    // *next* block, we need to use one more than active_chainstate.m_chain.Height()
259
0
    index.nHeight = tip->nHeight + 1;
260
261
0
    return EvaluateSequenceLocks(index, {lock_points.height, lock_points.time});
262
0
}
263
264
static void LimitMempoolSize(CTxMemPool& pool, CCoinsViewCache& coins_cache)
265
    EXCLUSIVE_LOCKS_REQUIRED(::cs_main, pool.cs)
266
0
{
267
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
268
0
    AssertLockHeld(pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
269
0
    int expired = pool.Expire(GetTime<std::chrono::seconds>() - pool.m_opts.expiry);
270
0
    if (expired != 0) {
271
0
        LogDebug(BCLog::MEMPOOL, "Expired %i transactions from the memory pool\n", expired);
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
272
0
    }
273
274
0
    std::vector<COutPoint> vNoSpendsRemaining;
275
0
    pool.TrimToSize(pool.m_opts.max_size_bytes, &vNoSpendsRemaining);
276
0
    for (const COutPoint& removed : vNoSpendsRemaining)
277
0
        coins_cache.Uncache(removed);
278
0
}
279
280
static bool IsCurrentForFeeEstimation(Chainstate& active_chainstate) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
281
0
{
282
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
283
0
    if (active_chainstate.m_chainman.IsInitialBlockDownload()) {
284
0
        return false;
285
0
    }
286
0
    if (active_chainstate.m_chain.Tip()->GetBlockTime() < count_seconds(GetTime<std::chrono::seconds>() - MAX_FEE_ESTIMATION_TIP_AGE))
287
0
        return false;
288
0
    if (active_chainstate.m_chain.Height() < active_chainstate.m_chainman.m_best_header->nHeight - 1) {
289
0
        return false;
290
0
    }
291
0
    return true;
292
0
}
293
294
void Chainstate::MaybeUpdateMempoolForReorg(
295
    DisconnectedBlockTransactions& disconnectpool,
296
    bool fAddToMempool)
297
0
{
298
0
    if (!m_mempool) return;
299
300
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
301
0
    AssertLockHeld(m_mempool->cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
302
0
    std::vector<Txid> vHashUpdate;
303
0
    {
304
        // disconnectpool is ordered so that the front is the most recently-confirmed
305
        // transaction (the last tx of the block at the tip) in the disconnected chain.
306
        // Iterate disconnectpool in reverse, so that we add transactions
307
        // back to the mempool starting with the earliest transaction that had
308
        // been previously seen in a block.
309
0
        const auto queuedTx = disconnectpool.take();
310
0
        auto it = queuedTx.rbegin();
311
0
        while (it != queuedTx.rend()) {
312
            // ignore validation errors in resurrected transactions
313
0
            if (!fAddToMempool || (*it)->IsCoinBase() ||
314
0
                AcceptToMemoryPool(*this, *it, GetTime(),
315
0
                    /*bypass_limits=*/true, /*test_accept=*/false).m_result_type !=
316
0
                        MempoolAcceptResult::ResultType::VALID) {
317
                // If the transaction doesn't make it in to the mempool, remove any
318
                // transactions that depend on it (which would now be orphans).
319
0
                m_mempool->removeRecursive(**it, MemPoolRemovalReason::REORG);
320
0
            } else if (m_mempool->exists((*it)->GetHash())) {
321
0
                vHashUpdate.push_back((*it)->GetHash());
322
0
            }
323
0
            ++it;
324
0
        }
325
0
    }
326
327
    // AcceptToMemoryPool/addNewTransaction all assume that new mempool entries have
328
    // no in-mempool children, which is generally not true when adding
329
    // previously-confirmed transactions back to the mempool.
330
    // UpdateTransactionsFromBlock finds descendants of any transactions in
331
    // the disconnectpool that were added back and cleans up the mempool state.
332
0
    m_mempool->UpdateTransactionsFromBlock(vHashUpdate);
333
334
    // Predicate to use for filtering transactions in removeForReorg.
335
    // Checks whether the transaction is still final and, if it spends a coinbase output, mature.
336
    // Also updates valid entries' cached LockPoints if needed.
337
    // If false, the tx is still valid and its lockpoints are updated.
338
    // If true, the tx would be invalid in the next block; remove this entry and all of its descendants.
339
    // Note that TRUC rules are not applied here, so reorgs may cause violations of TRUC inheritance or
340
    // topology restrictions.
341
0
    const auto filter_final_and_mature = [&](CTxMemPool::txiter it)
342
0
        EXCLUSIVE_LOCKS_REQUIRED(m_mempool->cs, ::cs_main) {
343
0
        AssertLockHeld(m_mempool->cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
344
0
        AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
345
0
        const CTransaction& tx = it->GetTx();
346
347
        // The transaction must be final.
348
0
        if (!CheckFinalTxAtTip(*Assert(m_chain.Tip()), tx)) return true;
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
349
350
0
        const LockPoints& lp = it->GetLockPoints();
351
        // CheckSequenceLocksAtTip checks if the transaction will be final in the next block to be
352
        // created on top of the new chain.
353
0
        if (TestLockPointValidity(m_chain, lp)) {
354
0
            if (!CheckSequenceLocksAtTip(m_chain.Tip(), lp)) {
355
0
                return true;
356
0
            }
357
0
        } else {
358
0
            const CCoinsViewMemPool view_mempool{&CoinsTip(), *m_mempool};
359
0
            const std::optional<LockPoints> new_lock_points{CalculateLockPointsAtTip(m_chain.Tip(), view_mempool, tx)};
360
0
            if (new_lock_points.has_value() && CheckSequenceLocksAtTip(m_chain.Tip(), *new_lock_points)) {
361
                // Now update the mempool entry lockpoints as well.
362
0
                it->UpdateLockPoints(*new_lock_points);
363
0
            } else {
364
0
                return true;
365
0
            }
366
0
        }
367
368
        // If the transaction spends any coinbase outputs, it must be mature.
369
0
        if (it->GetSpendsCoinbase()) {
370
0
            for (const CTxIn& txin : tx.vin) {
371
0
                if (m_mempool->exists(txin.prevout.hash)) continue;
372
0
                const Coin& coin{CoinsTip().AccessCoin(txin.prevout)};
373
0
                assert(!coin.IsSpent());
374
0
                const auto mempool_spend_height{m_chain.Tip()->nHeight + 1};
375
0
                if (coin.IsCoinBase() && mempool_spend_height - coin.nHeight < COINBASE_MATURITY) {
376
0
                    return true;
377
0
                }
378
0
            }
379
0
        }
380
        // Transaction is still valid and cached LockPoints are updated.
381
0
        return false;
382
0
    };
383
384
    // We also need to remove any now-immature transactions
385
0
    m_mempool->removeForReorg(m_chain, filter_final_and_mature);
386
    // Re-limit mempool size, in case we added any transactions
387
0
    LimitMempoolSize(*m_mempool, this->CoinsTip());
388
0
}
389
390
/**
391
* Checks to avoid mempool polluting consensus critical paths since cached
392
* signature and script validity results will be reused if we validate this
393
* transaction again during block validation.
394
* */
395
static bool CheckInputsFromMempoolAndCache(const CTransaction& tx, TxValidationState& state,
396
                const CCoinsViewCache& view, const CTxMemPool& pool,
397
                script_verify_flags flags, PrecomputedTransactionData& txdata, CCoinsViewCache& coins_tip,
398
                ValidationCache& validation_cache)
399
                EXCLUSIVE_LOCKS_REQUIRED(cs_main, pool.cs)
400
0
{
401
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
402
0
    AssertLockHeld(pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
403
404
0
    assert(!tx.IsCoinBase());
405
0
    for (const CTxIn& txin : tx.vin) {
406
0
        const Coin& coin = view.AccessCoin(txin.prevout);
407
408
        // This coin was checked in PreChecks and MemPoolAccept
409
        // has been holding cs_main since then.
410
0
        Assume(!coin.IsSpent());
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
411
0
        if (coin.IsSpent()) return false;
412
413
        // If the Coin is available, there are 2 possibilities:
414
        // it is available in our current ChainstateActive UTXO set,
415
        // or it's a UTXO provided by a transaction in our mempool.
416
        // Ensure the scriptPubKeys in Coins from CoinsView are correct.
417
0
        const CTransactionRef& txFrom = pool.get(txin.prevout.hash);
418
0
        if (txFrom) {
419
0
            assert(txFrom->GetHash() == txin.prevout.hash);
420
0
            assert(txFrom->vout.size() > txin.prevout.n);
421
0
            assert(txFrom->vout[txin.prevout.n] == coin.out);
422
0
        } else {
423
0
            const Coin& coinFromUTXOSet = coins_tip.AccessCoin(txin.prevout);
424
0
            assert(!coinFromUTXOSet.IsSpent());
425
0
            assert(coinFromUTXOSet.out == coin.out);
426
0
        }
427
0
    }
428
429
    // Call CheckInputScripts() to cache signature and script validity against current tip consensus rules.
430
0
    return CheckInputScripts(tx, state, view, flags, /* cacheSigStore= */ true, /* cacheFullScriptStore= */ true, txdata, validation_cache);
431
0
}
432
433
namespace {
434
435
class MemPoolAccept
436
{
437
public:
438
    explicit MemPoolAccept(CTxMemPool& mempool, Chainstate& active_chainstate) :
439
0
        m_pool(mempool),
440
0
        m_view(&CoinsViewEmpty::Get()),
441
0
        m_viewmempool(&active_chainstate.CoinsTip(), m_pool),
442
0
        m_active_chainstate(active_chainstate)
443
0
    {
444
0
    }
445
446
    // We put the arguments we're handed into a struct, so we can pass them
447
    // around easier.
448
    struct ATMPArgs {
449
        const CChainParams& m_chainparams;
450
        const int64_t m_accept_time;
451
        const bool m_bypass_limits;
452
        /*
453
         * Return any outpoints which were not previously present in the coins
454
         * cache, but were added as a result of validating the tx for mempool
455
         * acceptance. This allows the caller to optionally remove the cache
456
         * additions if the associated transaction ends up being rejected by
457
         * the mempool.
458
         */
459
        std::vector<COutPoint>& m_coins_to_uncache;
460
        /** When true, the transaction or package will not be submitted to the mempool. */
461
        const bool m_test_accept;
462
        /** Whether we allow transactions to replace mempool transactions. If false,
463
         * any transaction spending the same inputs as a transaction in the mempool is considered
464
         * a conflict. */
465
        const bool m_allow_replacement;
466
        /** When true, allow sibling eviction. This only occurs in single transaction package settings. */
467
        const bool m_allow_sibling_eviction;
468
        /** Used to skip the LimitMempoolSize() call within AcceptSingleTransaction(). This should be used when multiple
469
         * AcceptSubPackage calls are expected and the mempool will be trimmed at the end of AcceptPackage(). */
470
        const bool m_package_submission;
471
        /** When true, use package feerates instead of individual transaction feerates for fee-based
472
         * policies such as mempool min fee and min relay fee.
473
         */
474
        const bool m_package_feerates;
475
        /** Used for local submission of transactions to catch "absurd" fees
476
         * due to fee miscalculation by wallets. std:nullopt implies unset, allowing any feerates.
477
         * Any individual transaction failing this check causes immediate failure.
478
         */
479
        const std::optional<CFeeRate> m_client_maxfeerate;
480
481
        /** Parameters for single transaction mempool validation. */
482
        static ATMPArgs SingleAccept(const CChainParams& chainparams, int64_t accept_time,
483
                                     bool bypass_limits, std::vector<COutPoint>& coins_to_uncache,
484
0
                                     bool test_accept) {
485
0
            return ATMPArgs{/*chainparams=*/ chainparams,
486
0
                            /*accept_time=*/ accept_time,
487
0
                            /*bypass_limits=*/ bypass_limits,
488
0
                            /*coins_to_uncache=*/ coins_to_uncache,
489
0
                            /*test_accept=*/ test_accept,
490
0
                            /*allow_replacement=*/ true,
491
0
                            /*allow_sibling_eviction=*/ true,
492
0
                            /*package_submission=*/ false,
493
0
                            /*package_feerates=*/ false,
494
0
                            /*client_maxfeerate=*/ {}, // checked by caller
495
0
            };
496
0
        }
497
498
        /** Parameters for test package mempool validation through testmempoolaccept. */
499
        static ATMPArgs PackageTestAccept(const CChainParams& chainparams, int64_t accept_time,
500
0
                                          std::vector<COutPoint>& coins_to_uncache) {
501
0
            return ATMPArgs{/*chainparams=*/ chainparams,
502
0
                            /*accept_time=*/ accept_time,
503
0
                            /*bypass_limits=*/ false,
504
0
                            /*coins_to_uncache=*/ coins_to_uncache,
505
0
                            /*test_accept=*/ true,
506
0
                            /*allow_replacement=*/ false,
507
0
                            /*allow_sibling_eviction=*/ false,
508
0
                            /*package_submission=*/ false, // not submitting to mempool
509
0
                            /*package_feerates=*/ false,
510
0
                            /*client_maxfeerate=*/ {}, // checked by caller
511
0
            };
512
0
        }
513
514
        /** Parameters for child-with-parents package validation. */
515
        static ATMPArgs PackageChildWithParents(const CChainParams& chainparams, int64_t accept_time,
516
0
                                                std::vector<COutPoint>& coins_to_uncache, const std::optional<CFeeRate>& client_maxfeerate) {
517
0
            return ATMPArgs{/*chainparams=*/ chainparams,
518
0
                            /*accept_time=*/ accept_time,
519
0
                            /*bypass_limits=*/ false,
520
0
                            /*coins_to_uncache=*/ coins_to_uncache,
521
0
                            /*test_accept=*/ false,
522
0
                            /*allow_replacement=*/ true,
523
0
                            /*allow_sibling_eviction=*/ false,
524
0
                            /*package_submission=*/ true,
525
0
                            /*package_feerates=*/ true,
526
0
                            /*client_maxfeerate=*/ client_maxfeerate,
527
0
            };
528
0
        }
529
530
        /** Parameters for a single transaction within a package. */
531
0
        static ATMPArgs SingleInPackageAccept(const ATMPArgs& package_args) {
532
0
            return ATMPArgs{/*chainparams=*/ package_args.m_chainparams,
533
0
                            /*accept_time=*/ package_args.m_accept_time,
534
0
                            /*bypass_limits=*/ false,
535
0
                            /*coins_to_uncache=*/ package_args.m_coins_to_uncache,
536
0
                            /*test_accept=*/ package_args.m_test_accept,
537
0
                            /*allow_replacement=*/ true,
538
0
                            /*allow_sibling_eviction=*/ true,
539
0
                            /*package_submission=*/ true, // trim at the end of AcceptPackage()
540
0
                            /*package_feerates=*/ false, // only 1 transaction
541
0
                            /*client_maxfeerate=*/ package_args.m_client_maxfeerate,
542
0
            };
543
0
        }
544
545
    private:
546
        // Private ctor to avoid exposing details to clients and allowing the possibility of
547
        // mixing up the order of the arguments. Use static functions above instead.
548
        ATMPArgs(const CChainParams& chainparams,
549
                 int64_t accept_time,
550
                 bool bypass_limits,
551
                 std::vector<COutPoint>& coins_to_uncache,
552
                 bool test_accept,
553
                 bool allow_replacement,
554
                 bool allow_sibling_eviction,
555
                 bool package_submission,
556
                 bool package_feerates,
557
                 std::optional<CFeeRate> client_maxfeerate)
558
0
            : m_chainparams{chainparams},
559
0
              m_accept_time{accept_time},
560
0
              m_bypass_limits{bypass_limits},
561
0
              m_coins_to_uncache{coins_to_uncache},
562
0
              m_test_accept{test_accept},
563
0
              m_allow_replacement{allow_replacement},
564
0
              m_allow_sibling_eviction{allow_sibling_eviction},
565
0
              m_package_submission{package_submission},
566
0
              m_package_feerates{package_feerates},
567
0
              m_client_maxfeerate{client_maxfeerate}
568
0
        {
569
            // If we are using package feerates, we must be doing package submission.
570
            // It also means sibling eviction is not permitted.
571
0
            if (m_package_feerates) {
572
0
                Assume(m_package_submission);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
573
0
                Assume(!m_allow_sibling_eviction);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
574
0
            }
575
0
            if (m_allow_sibling_eviction) Assume(m_allow_replacement);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
576
0
        }
577
    };
578
579
    /** Clean up all non-chainstate coins from m_view and m_viewmempool. */
580
    void CleanupTemporaryCoins() EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
581
582
    // Single transaction acceptance
583
0
    MempoolAcceptResult AcceptSingleTransactionAndCleanup(const CTransactionRef& ptx, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
584
0
        LOCK(m_pool.cs);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
585
0
        MempoolAcceptResult result = AcceptSingleTransactionInternal(ptx, args);
586
0
        ClearSubPackageState();
587
0
        return result;
588
0
    }
589
    MempoolAcceptResult AcceptSingleTransactionInternal(const CTransactionRef& ptx, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
590
591
    /**
592
    * Multiple transaction acceptance. Transactions may or may not be interdependent, but must not
593
    * conflict with each other, and the transactions cannot already be in the mempool. Parents must
594
    * come before children if any dependencies exist.
595
    */
596
0
    PackageMempoolAcceptResult AcceptMultipleTransactionsAndCleanup(const std::vector<CTransactionRef>& txns, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
597
0
        LOCK(m_pool.cs);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
598
0
        PackageMempoolAcceptResult result = AcceptMultipleTransactionsInternal(txns, args);
599
0
        ClearSubPackageState();
600
0
        return result;
601
0
    }
602
    PackageMempoolAcceptResult AcceptMultipleTransactionsInternal(const std::vector<CTransactionRef>& txns, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
603
604
    /**
605
     * Submission of a subpackage.
606
     * If subpackage size == 1, calls AcceptSingleTransaction() with adjusted ATMPArgs to
607
     * enable sibling eviction and creates a PackageMempoolAcceptResult
608
     * wrapping the result.
609
     *
610
     * If subpackage size > 1, calls AcceptMultipleTransactions() with the provided ATMPArgs.
611
     *
612
     * Also cleans up all non-chainstate coins from m_view at the end.
613
    */
614
    PackageMempoolAcceptResult AcceptSubPackage(const std::vector<CTransactionRef>& subpackage, ATMPArgs& args)
615
        EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
616
617
    /**
618
     * Package (more specific than just multiple transactions) acceptance. Package must be a child
619
     * with all of its unconfirmed parents, and topologically sorted.
620
     */
621
    PackageMempoolAcceptResult AcceptPackage(const Package& package, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
622
623
private:
624
    // All the intermediate state that gets passed between the various levels
625
    // of checking a given transaction.
626
    struct Workspace {
627
0
        explicit Workspace(const CTransactionRef& ptx) : m_ptx(ptx), m_hash(ptx->GetHash()) {}
628
        /** Txids of mempool transactions that this transaction directly conflicts with or may
629
         * replace via sibling eviction. */
630
        std::set<Txid> m_conflicts;
631
        /** Iterators to mempool entries that this transaction directly conflicts with or may
632
         * replace via sibling eviction. */
633
        CTxMemPool::setEntries m_iters_conflicting;
634
        /** All mempool parents of this transaction. */
635
        std::vector<CTxMemPoolEntry::CTxMemPoolEntryRef> m_parents;
636
        /* Handle to the tx in the changeset */
637
        CTxMemPool::ChangeSet::TxHandle m_tx_handle;
638
        /** Whether RBF-related data structures (m_conflicts, m_iters_conflicting,
639
         * m_replaced_transactions) include a sibling in addition to txns with conflicting inputs. */
640
        bool m_sibling_eviction{false};
641
642
        /** Virtual size of the transaction as used by the mempool, calculated using serialized size
643
         * of the transaction and sigops. */
644
        int64_t m_vsize;
645
        /** Fees paid by this transaction: total input amounts subtracted by total output amounts. */
646
        CAmount m_base_fees;
647
        /** Base fees + any fee delta set by the user with prioritisetransaction. */
648
        CAmount m_modified_fees;
649
650
        /** If we're doing package validation (i.e. m_package_feerates=true), the "effective"
651
         * package feerate of this transaction is the total fees divided by the total size of
652
         * transactions (which may include its ancestors and/or descendants). */
653
        CFeeRate m_package_feerate{0};
654
655
        const CTransactionRef& m_ptx;
656
        /** Txid. */
657
        const Txid& m_hash;
658
        TxValidationState m_state;
659
        /** A temporary cache containing serialized transaction data for signature verification.
660
         * Reused across PolicyScriptChecks and ConsensusScriptChecks. */
661
        PrecomputedTransactionData m_precomputed_txdata;
662
    };
663
664
    // Run the policy checks on a given transaction, excluding any script checks.
665
    // Looks up inputs, calculates feerate, considers replacement, evaluates
666
    // package limits, etc. As this function can be invoked for "free" by a peer,
667
    // only tests that are fast should be done here (to avoid CPU DoS).
668
    bool PreChecks(ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
669
670
    // Run checks for mempool replace-by-fee, only used in AcceptSingleTransaction.
671
    bool ReplacementChecks(Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
672
673
    bool PackageRBFChecks(const std::vector<CTransactionRef>& txns,
674
                          std::vector<Workspace>& workspaces,
675
                          int64_t total_vsize,
676
                          PackageValidationState& package_state) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
677
678
    // Run the script checks using our policy flags. As this can be slow, we should
679
    // only invoke this on transactions that have otherwise passed policy checks.
680
    bool PolicyScriptChecks(const ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
681
682
    // Re-run the script checks, using consensus flags, and try to cache the
683
    // result in the scriptcache. This should be done after
684
    // PolicyScriptChecks(). This requires that all inputs either be in our
685
    // utxo set or in the mempool.
686
    bool ConsensusScriptChecks(const ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
687
688
    // Try to add the transaction to the mempool, removing any conflicts first.
689
    void FinalizeSubpackage(const ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
690
691
    // Submit all transactions to the mempool and call ConsensusScriptChecks to add to the script
692
    // cache - should only be called after successful validation of all transactions in the package.
693
    // Does not call LimitMempoolSize(), so mempool max_size_bytes may be temporarily exceeded.
694
    bool SubmitPackage(const ATMPArgs& args, std::vector<Workspace>& workspaces, PackageValidationState& package_state,
695
                       std::map<Wtxid, MempoolAcceptResult>& results)
696
         EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
697
698
    // Compare a package's feerate against minimum allowed.
699
    bool CheckFeeRate(size_t package_size, CAmount package_fee, TxValidationState& state) EXCLUSIVE_LOCKS_REQUIRED(::cs_main, m_pool.cs)
700
0
    {
701
0
        AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
702
0
        AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
703
0
        CAmount mempoolRejectFee = m_pool.GetMinFee().GetFee(package_size);
704
0
        if (mempoolRejectFee > 0 && package_fee < mempoolRejectFee) {
705
0
            return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "mempool min fee not met", strprintf("%d < %d", package_fee, mempoolRejectFee));
Line
Count
Source
1172
0
#define strprintf tfm::format
706
0
        }
707
708
0
        if (package_fee < m_pool.m_opts.min_relay_feerate.GetFee(package_size)) {
709
0
            return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "min relay fee not met",
710
0
                                 strprintf("%d < %d", package_fee, m_pool.m_opts.min_relay_feerate.GetFee(package_size)));
Line
Count
Source
1172
0
#define strprintf tfm::format
711
0
        }
712
0
        return true;
713
0
    }
714
715
    ValidationCache& GetValidationCache()
716
0
    {
717
0
        return m_active_chainstate.m_chainman.m_validation_cache;
718
0
    }
719
720
private:
721
    CTxMemPool& m_pool;
722
723
    /** Holds a cached view of available coins from the UTXO set, mempool, and artificial temporary coins (to enable package validation).
724
     * The view doesn't track whether a coin previously existed but has now been spent. We detect conflicts in other ways:
725
     * - conflicts within a transaction are checked in CheckTransaction (bad-txns-inputs-duplicate)
726
     * - conflicts within a package are checked in IsWellFormedPackage (conflict-in-package)
727
     * - conflicts with an existing mempool transaction are found in CTxMemPool::GetConflictTx and replacements are allowed
728
     * The temporary coins should persist between individual transaction checks so that package validation is possible,
729
     * but must be cleaned up when we finish validating a subpackage, whether accepted or rejected. The cache must also
730
     * be cleared when mempool contents change (when a changeset is applied or when the mempool trims itself) because it
731
     * can return cached coins that no longer exist in the backend. Use CleanupTemporaryCoins() anytime you are finished
732
     * with a SubPackageState or call LimitMempoolSize().
733
     */
734
    CCoinsViewCache m_view;
735
736
    // These are the two possible backends for m_view.
737
    /** When m_view is connected to m_viewmempool as its backend, it can pull coins from the mempool and from the UTXO
738
     * set. This is also where temporary coins are stored. */
739
    CCoinsViewMemPool m_viewmempool;
740
741
    Chainstate& m_active_chainstate;
742
743
    // Fields below are per *sub*package state and must be reset prior to subsequent
744
    // AcceptSingleTransaction and AcceptMultipleTransactions invocations
745
    struct SubPackageState {
746
        /** Aggregated modified fees of all transactions, used to calculate package feerate. */
747
        CAmount m_total_modified_fees{0};
748
        /** Aggregated virtual size of all transactions, used to calculate package feerate. */
749
        int64_t m_total_vsize{0};
750
751
        // RBF-related members
752
        /** Whether the transaction(s) would replace any mempool transactions and/or evict any siblings.
753
         * If so, RBF rules apply. */
754
        bool m_rbf{false};
755
        /** Mempool transactions that were replaced. */
756
        std::list<CTransactionRef> m_replaced_transactions;
757
        /* Changeset representing adding transactions and removing their conflicts. */
758
        std::unique_ptr<CTxMemPool::ChangeSet> m_changeset;
759
760
        /** Total modified fees of mempool transactions being replaced. */
761
        CAmount m_conflicting_fees{0};
762
        /** Total size (in virtual bytes) of mempool transactions being replaced. */
763
        size_t m_conflicting_size{0};
764
    };
765
766
    struct SubPackageState m_subpackage;
767
768
    /** Re-set sub-package state to not leak between evaluations */
769
    void ClearSubPackageState() EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs)
770
0
    {
771
0
        m_subpackage = SubPackageState{};
772
773
        // And clean coins while at it
774
0
        CleanupTemporaryCoins();
775
0
    }
776
};
777
778
bool MemPoolAccept::PreChecks(ATMPArgs& args, Workspace& ws)
779
0
{
780
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
781
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
782
0
    const CTransactionRef& ptx = ws.m_ptx;
783
0
    const CTransaction& tx = *ws.m_ptx;
784
0
    const Txid& hash = ws.m_hash;
785
786
    // Copy/alias what we need out of args
787
0
    const int64_t nAcceptTime = args.m_accept_time;
788
0
    const bool bypass_limits = args.m_bypass_limits;
789
0
    std::vector<COutPoint>& coins_to_uncache = args.m_coins_to_uncache;
790
791
    // Alias what we need out of ws
792
0
    TxValidationState& state = ws.m_state;
793
794
0
    if (!CheckTransaction(tx, state)) {
795
0
        return false; // state filled in by CheckTransaction
796
0
    }
797
798
    // Coinbase is only valid in a block, not as a loose transaction
799
0
    if (tx.IsCoinBase())
800
0
        return state.Invalid(TxValidationResult::TX_CONSENSUS, "coinbase");
801
802
    // Rather not work on nonstandard transactions (unless -testnet/-regtest)
803
0
    std::string reason;
804
0
    if (m_pool.m_opts.require_standard && !IsStandardTx(tx, m_pool.m_opts.max_datacarrier_bytes, m_pool.m_opts.permit_bare_multisig, m_pool.m_opts.dust_relay_feerate, reason)) {
805
0
        return state.Invalid(TxValidationResult::TX_NOT_STANDARD, reason);
806
0
    }
807
808
    // Transactions smaller than 65 non-witness bytes are not relayed to mitigate CVE-2017-12842.
809
0
    if (::GetSerializeSize(TX_NO_WITNESS(tx)) < MIN_STANDARD_TX_NONWITNESS_SIZE)
810
0
        return state.Invalid(TxValidationResult::TX_NOT_STANDARD, "tx-size-small");
811
812
    // Only accept nLockTime-using transactions that can be mined in the next
813
    // block; we don't want our mempool filled up with transactions that can't
814
    // be mined yet.
815
0
    if (!CheckFinalTxAtTip(*Assert(m_active_chainstate.m_chain.Tip()), tx)) {
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
816
0
        return state.Invalid(TxValidationResult::TX_PREMATURE_SPEND, "non-final");
817
0
    }
818
819
0
    if (m_pool.exists(tx.GetWitnessHash())) {
820
        // Exact transaction already exists in the mempool.
821
0
        return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-already-in-mempool");
822
0
    } else if (m_pool.exists(tx.GetHash())) {
823
        // Transaction with the same non-witness data but different witness (same txid, different
824
        // wtxid) already exists in the mempool.
825
0
        return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-same-nonwitness-data-in-mempool");
826
0
    }
827
828
    // Check for conflicts with in-memory transactions
829
0
    for (const CTxIn &txin : tx.vin)
830
0
    {
831
0
        const CTransaction* ptxConflicting = m_pool.GetConflictTx(txin.prevout);
832
0
        if (ptxConflicting) {
833
0
            if (!args.m_allow_replacement) {
834
                // Transaction conflicts with a mempool tx, but we're not allowing replacements in this context.
835
0
                return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "bip125-replacement-disallowed");
836
0
            }
837
0
            ws.m_conflicts.insert(ptxConflicting->GetHash());
838
0
        }
839
0
    }
840
841
0
    m_view.SetBackend(m_viewmempool);
842
843
0
    const CCoinsViewCache& coins_cache = m_active_chainstate.CoinsTip();
844
    // do all inputs exist?
845
0
    for (const CTxIn& txin : tx.vin) {
846
0
        if (!coins_cache.HaveCoinInCache(txin.prevout)) {
847
0
            coins_to_uncache.push_back(txin.prevout);
848
0
        }
849
850
        // Note: this call may add txin.prevout to the coins cache
851
        // (coins_cache.cacheCoins) by way of FetchCoin(). It should be removed
852
        // later (via coins_to_uncache) if this tx turns out to be invalid.
853
0
        if (!m_view.HaveCoin(txin.prevout)) {
854
            // Are inputs missing because we already have the tx?
855
0
            for (size_t out = 0; out < tx.vout.size(); out++) {
856
                // Optimistically just do efficient check of cache for outputs
857
0
                if (coins_cache.HaveCoinInCache(COutPoint(hash, out))) {
858
0
                    return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-already-known");
859
0
                }
860
0
            }
861
            // Otherwise assume this might be an orphan tx for which we just haven't seen parents yet
862
0
            return state.Invalid(TxValidationResult::TX_MISSING_INPUTS, "bad-txns-inputs-missingorspent");
863
0
        }
864
0
    }
865
866
    // This is const, but calls into `CCoinsViewCache::GetBestBlock()` to refresh
867
    // the cached best block through `m_viewmempool` after caching inputs.
868
0
    (void)m_view.GetBestBlock();
869
870
    // All required inputs are cached now, so switch m_view to the empty backend.
871
    // This keeps already-fetched cache entries for later checks and prevents new
872
    // backend lookups (which would avoid coins_to_uncache tracking).
873
0
    m_view.SetBackend(CoinsViewEmpty::Get());
874
875
0
    assert(m_active_chainstate.m_blockman.LookupBlockIndex(m_view.GetBestBlock()) == m_active_chainstate.m_chain.Tip());
876
877
    // Only accept BIP68 sequence locked transactions that can be mined in the next
878
    // block; we don't want our mempool filled up with transactions that can't
879
    // be mined yet.
880
    // Pass in m_view which has all of the relevant inputs cached. Note that, since m_view's
881
    // backend was removed, it no longer pulls coins from the mempool.
882
0
    const std::optional<LockPoints> lock_points{CalculateLockPointsAtTip(m_active_chainstate.m_chain.Tip(), m_view, tx)};
883
0
    if (!lock_points.has_value() || !CheckSequenceLocksAtTip(m_active_chainstate.m_chain.Tip(), *lock_points)) {
884
0
        return state.Invalid(TxValidationResult::TX_PREMATURE_SPEND, "non-BIP68-final");
885
0
    }
886
887
    // The mempool holds txs for the next block, so pass height+1 to CheckTxInputs
888
0
    if (!Consensus::CheckTxInputs(tx, state, m_view, m_active_chainstate.m_chain.Height() + 1, ws.m_base_fees)) {
889
0
        return false; // state filled in by CheckTxInputs
890
0
    }
891
892
0
    if (m_pool.m_opts.require_standard) {
893
0
        state = ValidateInputsStandardness(tx, m_view);
894
0
        if (state.IsInvalid()) {
895
0
            return false;
896
0
        }
897
0
    }
898
899
    // Check for non-standard witnesses.
900
0
    if (tx.HasWitness() && m_pool.m_opts.require_standard && !IsWitnessStandard(tx, m_view)) {
901
0
        return state.Invalid(TxValidationResult::TX_WITNESS_MUTATED, "bad-witness-nonstandard");
902
0
    }
903
904
0
    int64_t nSigOpsCost = GetTransactionSigOpCost(tx, m_view, STANDARD_SCRIPT_VERIFY_FLAGS);
905
906
    // Keep track of transactions that spend a coinbase, which we re-scan
907
    // during reorgs to ensure COINBASE_MATURITY is still met.
908
0
    bool fSpendsCoinbase = false;
909
0
    for (const CTxIn &txin : tx.vin) {
910
0
        const Coin &coin = m_view.AccessCoin(txin.prevout);
911
0
        if (coin.IsCoinBase()) {
912
0
            fSpendsCoinbase = true;
913
0
            break;
914
0
        }
915
0
    }
916
917
    // Set entry_sequence to 0 when bypass_limits is used; this allows txs from a block
918
    // reorg to be marked earlier than any child txs that were already in the mempool.
919
0
    const uint64_t entry_sequence = bypass_limits ? 0 : m_pool.GetSequence();
920
0
    if (!m_subpackage.m_changeset) {
921
0
        m_subpackage.m_changeset = m_pool.GetChangeSet();
922
0
    }
923
0
    ws.m_tx_handle = m_subpackage.m_changeset->StageAddition(ptx, ws.m_base_fees, nAcceptTime, m_active_chainstate.m_chain.Height(), entry_sequence, fSpendsCoinbase, nSigOpsCost, lock_points.value());
924
925
    // ws.m_modified_fees includes any fee deltas from PrioritiseTransaction
926
0
    ws.m_modified_fees = ws.m_tx_handle->GetModifiedFee();
927
928
0
    ws.m_vsize = ws.m_tx_handle->GetTxSize();
929
930
    // Enforces 0-fee for dust transactions, no incentive to be mined alone
931
0
    if (m_pool.m_opts.require_standard) {
932
0
        if (!PreCheckEphemeralTx(*ptx, m_pool.m_opts.dust_relay_feerate, ws.m_base_fees, ws.m_modified_fees, state)) {
933
0
            return false; // state filled in by PreCheckEphemeralTx
934
0
        }
935
0
    }
936
937
0
    if (nSigOpsCost > MAX_STANDARD_TX_SIGOPS_COST)
938
0
        return state.Invalid(TxValidationResult::TX_NOT_STANDARD, "bad-txns-too-many-sigops",
939
0
                strprintf("%d", nSigOpsCost));
Line
Count
Source
1172
0
#define strprintf tfm::format
940
941
    // No individual transactions are allowed below the mempool min feerate except from disconnected
942
    // blocks and transactions in a package. Package transactions will be checked using package
943
    // feerate later.
944
0
    if (!bypass_limits && !args.m_package_feerates && !CheckFeeRate(ws.m_vsize, ws.m_modified_fees, state)) return false;
945
946
0
    ws.m_iters_conflicting = m_pool.GetIterSet(ws.m_conflicts);
947
948
0
    ws.m_parents = m_pool.GetParents(*ws.m_tx_handle);
949
950
0
    if (!args.m_bypass_limits) {
951
        // Perform the TRUC checks, using the in-mempool parents.
952
0
        if (const auto err{SingleTRUCChecks(m_pool, ws.m_ptx, ws.m_parents, ws.m_conflicts, ws.m_vsize)}) {
953
            // Single transaction contexts only.
954
0
            if (args.m_allow_sibling_eviction && err->second != nullptr) {
955
                // We should only be considering where replacement is considered valid as well.
956
0
                Assume(args.m_allow_replacement);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
957
                // Potential sibling eviction. Add the sibling to our list of mempool conflicts to be
958
                // included in RBF checks.
959
0
                ws.m_conflicts.insert(err->second->GetHash());
960
                // Adding the sibling to m_iters_conflicting here means that it doesn't count towards
961
                // RBF Carve Out above. This is correct, since removing to-be-replaced transactions from
962
                // the descendant count is done separately in SingleTRUCChecks for TRUC transactions.
963
0
                ws.m_iters_conflicting.insert(m_pool.GetIter(err->second->GetHash()).value());
964
0
                ws.m_sibling_eviction = true;
965
                // The sibling will be treated as part of the to-be-replaced set in ReplacementChecks.
966
                // Note that we are not checking whether it opts in to replaceability via BIP125 or TRUC
967
                // (which is normally done in PreChecks). However, the only way a TRUC transaction can
968
                // have a non-TRUC and non-BIP125 descendant is due to a reorg.
969
0
            } else {
970
0
                return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "TRUC-violation", err->first);
971
0
            }
972
0
        }
973
0
    }
974
975
    // We want to detect conflicts in any tx in a package to trigger package RBF logic
976
0
    m_subpackage.m_rbf |= !ws.m_conflicts.empty();
977
0
    return true;
978
0
}
979
980
bool MemPoolAccept::ReplacementChecks(Workspace& ws)
981
0
{
982
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
983
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
984
985
0
    const CTransaction& tx = *ws.m_ptx;
986
0
    const Txid& hash = ws.m_hash;
987
0
    TxValidationState& state = ws.m_state;
988
989
0
    CFeeRate newFeeRate(ws.m_modified_fees, ws.m_vsize);
990
991
0
    CTxMemPool::setEntries all_conflicts;
992
993
    // Calculate all conflicting entries and enforce Rule #5.
994
0
    if (const auto err_string{GetEntriesForConflicts(tx, m_pool, ws.m_iters_conflicting, all_conflicts)}) {
995
0
        return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY,
996
0
                             strprintf("too many potential replacements%s", ws.m_sibling_eviction ? " (including sibling eviction)" : ""), *err_string);
Line
Count
Source
1172
0
#define strprintf tfm::format
997
0
    }
998
999
    // Check if it's economically rational to mine this transaction rather than the ones it
1000
    // replaces and pays for its own relay fees. Enforce Rules #3 and #4.
1001
0
    for (CTxMemPool::txiter it : all_conflicts) {
1002
0
        m_subpackage.m_conflicting_fees += it->GetModifiedFee();
1003
0
        m_subpackage.m_conflicting_size += it->GetTxSize();
1004
0
    }
1005
1006
0
    if (const auto err_string{PaysForRBF(m_subpackage.m_conflicting_fees, ws.m_modified_fees, ws.m_vsize,
1007
0
                                         m_pool.m_opts.incremental_relay_feerate, hash)}) {
1008
        // Result may change in a package context
1009
0
        return state.Invalid(TxValidationResult::TX_RECONSIDERABLE,
1010
0
                             strprintf("insufficient fee%s", ws.m_sibling_eviction ? " (including sibling eviction)" : ""), *err_string);
Line
Count
Source
1172
0
#define strprintf tfm::format
1011
0
    }
1012
1013
    // Add all the to-be-removed transactions to the changeset.
1014
0
    for (auto it : all_conflicts) {
1015
0
        m_subpackage.m_changeset->StageRemoval(it);
1016
0
    }
1017
1018
    // Run cluster size limit checks and fail if we exceed them.
1019
0
    if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1020
0
        return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "too-large-cluster", "");
1021
0
    }
1022
1023
0
    if (const auto err_string{ImprovesFeerateDiagram(*m_subpackage.m_changeset)}) {
1024
        // We checked above for the cluster size limits being respected, so a
1025
        // failure here can only be due to an insufficient fee.
1026
0
        Assume(err_string->first == DiagramCheckError::FAILURE);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1027
0
        return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "replacement-failed", err_string->second);
1028
0
    }
1029
1030
0
    return true;
1031
0
}
1032
1033
bool MemPoolAccept::PackageRBFChecks(const std::vector<CTransactionRef>& txns,
1034
                                     std::vector<Workspace>& workspaces,
1035
                                     const int64_t total_vsize,
1036
                                     PackageValidationState& package_state)
1037
0
{
1038
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1039
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1040
1041
0
    assert(std::all_of(txns.cbegin(), txns.cend(), [this](const auto& tx)
1042
0
                       { return !m_pool.exists(tx->GetHash());}));
1043
1044
0
    assert(txns.size() == workspaces.size());
1045
1046
    // We're in package RBF context; replacement proposal must be size 2
1047
0
    if (workspaces.size() != 2 || !Assume(IsChildWithParents(txns))) {
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1048
0
        return package_state.Invalid(PackageValidationResult::PCKG_POLICY, "package RBF failed: package must be 1-parent-1-child");
1049
0
    }
1050
1051
    // If the package has in-mempool parents, we won't consider a package RBF
1052
    // since it would result in a cluster larger than 2.
1053
    // N.B. To relax this constraint we will need to revisit how CCoinsViewMemPool::PackageAddTransaction
1054
    // is being used inside AcceptMultipleTransactions to track available inputs while processing a package.
1055
    // Specifically we would need to check that the ancestors of the new
1056
    // transactions don't intersect with the set of transactions to be removed
1057
    // due to RBF, which is not checked at all in the package acceptance
1058
    // context.
1059
0
    for (const auto& ws : workspaces) {
1060
0
        if (!ws.m_parents.empty()) {
1061
0
            return package_state.Invalid(PackageValidationResult::PCKG_POLICY, "package RBF failed: new transaction cannot have mempool ancestors");
1062
0
        }
1063
0
    }
1064
1065
    // Aggregate all conflicts into one set.
1066
0
    CTxMemPool::setEntries direct_conflict_iters;
1067
0
    for (Workspace& ws : workspaces) {
1068
        // Aggregate all conflicts into one set.
1069
0
        direct_conflict_iters.merge(ws.m_iters_conflicting);
1070
0
    }
1071
1072
0
    const auto& parent_ws = workspaces[0];
1073
0
    const auto& child_ws = workspaces[1];
1074
1075
    // Don't consider replacements that would cause us to remove a large number of mempool entries.
1076
    // This limit is not increased in a package RBF. Use the aggregate number of transactions.
1077
0
    CTxMemPool::setEntries all_conflicts;
1078
0
    if (const auto err_string{GetEntriesForConflicts(*child_ws.m_ptx, m_pool, direct_conflict_iters,
1079
0
                                                     all_conflicts)}) {
1080
0
        return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1081
0
                                     "package RBF failed: too many potential replacements", *err_string);
1082
0
    }
1083
1084
0
    for (CTxMemPool::txiter it : all_conflicts) {
1085
0
        m_subpackage.m_changeset->StageRemoval(it);
1086
0
        m_subpackage.m_conflicting_fees += it->GetModifiedFee();
1087
0
        m_subpackage.m_conflicting_size += it->GetTxSize();
1088
0
    }
1089
1090
    // Use the child as the transaction for attributing errors to.
1091
0
    const Txid& child_hash = child_ws.m_ptx->GetHash();
1092
0
    if (const auto err_string{PaysForRBF(/*original_fees=*/m_subpackage.m_conflicting_fees,
1093
0
                                         /*replacement_fees=*/m_subpackage.m_total_modified_fees,
1094
0
                                         /*replacement_vsize=*/m_subpackage.m_total_vsize,
1095
0
                                         m_pool.m_opts.incremental_relay_feerate, child_hash)}) {
1096
0
        return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1097
0
                                     "package RBF failed: insufficient anti-DoS fees", *err_string);
1098
0
    }
1099
1100
    // Ensure this two transaction package is a "chunk" on its own; we don't want the child
1101
    // to be only paying anti-DoS fees
1102
0
    const CFeeRate parent_feerate(parent_ws.m_modified_fees, parent_ws.m_vsize);
1103
0
    const CFeeRate package_feerate(m_subpackage.m_total_modified_fees, m_subpackage.m_total_vsize);
1104
0
    if (package_feerate <= parent_feerate) {
1105
0
        return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1106
0
                                     "package RBF failed: package feerate is less than or equal to parent feerate",
1107
0
                                     strprintf("package feerate %s <= parent feerate is %s", package_feerate.ToString(), parent_feerate.ToString()));
Line
Count
Source
1172
0
#define strprintf tfm::format
1108
0
    }
1109
1110
    // Run cluster size limit checks and fail if we exceed them.
1111
0
    if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1112
0
        return package_state.Invalid(PackageValidationResult::PCKG_POLICY, "too-large-cluster", "");
1113
0
    }
1114
1115
    // Check if it's economically rational to mine this package rather than the ones it replaces.
1116
0
    if (const auto err_tup{ImprovesFeerateDiagram(*m_subpackage.m_changeset)}) {
1117
0
        Assume(err_tup->first == DiagramCheckError::FAILURE);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1118
0
        return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1119
0
                                     "package RBF failed: " + err_tup.value().second, "");
1120
0
    }
1121
1122
0
    LogDebug(BCLog::TXPACKAGES, "package RBF checks passed: parent %s (wtxid=%s), child %s (wtxid=%s), package hash (%s)\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
1123
0
        txns.front()->GetHash().ToString(), txns.front()->GetWitnessHash().ToString(),
1124
0
        txns.back()->GetHash().ToString(), txns.back()->GetWitnessHash().ToString(),
1125
0
        GetPackageHash(txns).ToString());
1126
1127
1128
0
    return true;
1129
0
}
1130
1131
bool MemPoolAccept::PolicyScriptChecks(const ATMPArgs& args, Workspace& ws)
1132
0
{
1133
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1134
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1135
0
    const CTransaction& tx = *ws.m_ptx;
1136
0
    TxValidationState& state = ws.m_state;
1137
1138
0
    constexpr script_verify_flags scriptVerifyFlags = STANDARD_SCRIPT_VERIFY_FLAGS;
1139
1140
    // Check input scripts and signatures.
1141
    // This is done last to help prevent CPU exhaustion denial-of-service attacks.
1142
0
    if (!CheckInputScripts(tx, state, m_view, scriptVerifyFlags, true, false, ws.m_precomputed_txdata, GetValidationCache())) {
1143
        // Detect a failure due to a missing witness so that p2p code can handle rejection caching appropriately.
1144
0
        if (!tx.HasWitness() && SpendsNonAnchorWitnessProg(tx, m_view)) {
1145
0
            state.Invalid(TxValidationResult::TX_WITNESS_STRIPPED,
1146
0
                    state.GetRejectReason(), state.GetDebugMessage());
1147
0
        }
1148
0
        return false; // state filled in by CheckInputScripts
1149
0
    }
1150
1151
0
    return true;
1152
0
}
1153
1154
bool MemPoolAccept::ConsensusScriptChecks(const ATMPArgs& args, Workspace& ws)
1155
0
{
1156
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1157
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1158
0
    const CTransaction& tx = *ws.m_ptx;
1159
0
    const Txid& hash = ws.m_hash;
1160
0
    TxValidationState& state = ws.m_state;
1161
1162
    // Check again against the current block tip's script verification
1163
    // flags to cache our script execution flags. This is, of course,
1164
    // useless if the next block has different script flags from the
1165
    // previous one, but because the cache tracks script flags for us it
1166
    // will auto-invalidate and we'll just have a few blocks of extra
1167
    // misses on soft-fork activation.
1168
    //
1169
    // This is also useful in case of bugs in the standard flags that cause
1170
    // transactions to pass as valid when they're actually invalid. For
1171
    // instance the STRICTENC flag was incorrectly allowing certain
1172
    // CHECKSIG NOT scripts to pass, even though they were invalid.
1173
    //
1174
    // There is a similar check in CreateNewBlock() to prevent creating
1175
    // invalid blocks (using TestBlockValidity), however allowing such
1176
    // transactions into the mempool can be exploited as a DoS attack.
1177
0
    script_verify_flags currentBlockScriptVerifyFlags{GetBlockScriptFlags(*m_active_chainstate.m_chain.Tip(), m_active_chainstate.m_chainman)};
1178
0
    if (!CheckInputsFromMempoolAndCache(tx, state, m_view, m_pool, currentBlockScriptVerifyFlags,
1179
0
                                        ws.m_precomputed_txdata, m_active_chainstate.CoinsTip(), GetValidationCache())) {
1180
0
        LogError("BUG! PLEASE REPORT THIS! CheckInputScripts failed against latest-block but not STANDARD flags %s, %s", hash.ToString(), state.ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
1181
0
        return Assume(false);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1182
0
    }
1183
1184
0
    return true;
1185
0
}
1186
1187
void MemPoolAccept::FinalizeSubpackage(const ATMPArgs& args)
1188
0
{
1189
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1190
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1191
1192
0
    if (!m_subpackage.m_changeset->GetRemovals().empty()) Assume(args.m_allow_replacement);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1193
    // Remove conflicting transactions from the mempool
1194
0
    for (CTxMemPool::txiter it : m_subpackage.m_changeset->GetRemovals())
1195
0
    {
1196
0
        std::string log_string = strprintf("replacing mempool tx %s (wtxid=%s, fees=%s, vsize=%s). ",
Line
Count
Source
1172
0
#define strprintf tfm::format
1197
0
                                      it->GetTx().GetHash().ToString(),
1198
0
                                      it->GetTx().GetWitnessHash().ToString(),
1199
0
                                      it->GetFee(),
1200
0
                                      it->GetTxSize());
1201
0
        FeeFrac feerate{m_subpackage.m_total_modified_fees, int32_t(m_subpackage.m_total_vsize)};
1202
0
        uint256 tx_or_package_hash{};
1203
0
        const bool replaced_with_tx{m_subpackage.m_changeset->GetTxCount() == 1};
1204
0
        if (replaced_with_tx) {
1205
0
            const CTransaction& tx = m_subpackage.m_changeset->GetAddedTxn(0);
1206
0
            tx_or_package_hash = tx.GetHash().ToUint256();
1207
0
            log_string += strprintf("New tx %s (wtxid=%s, fees=%s, vsize=%s)",
Line
Count
Source
1172
0
#define strprintf tfm::format
1208
0
                                    tx.GetHash().ToString(),
1209
0
                                    tx.GetWitnessHash().ToString(),
1210
0
                                    feerate.fee,
1211
0
                                    feerate.size);
1212
0
        } else {
1213
0
            tx_or_package_hash = GetPackageHash(m_subpackage.m_changeset->GetAddedTxns());
1214
0
            log_string += strprintf("New package %s with %lu txs, fees=%s, vsize=%s",
Line
Count
Source
1172
0
#define strprintf tfm::format
1215
0
                                    tx_or_package_hash.ToString(),
1216
0
                                    m_subpackage.m_changeset->GetTxCount(),
1217
0
                                    feerate.fee,
1218
0
                                    feerate.size);
1219
1220
0
        }
1221
0
        LogDebug(BCLog::MEMPOOL, "%s\n", log_string);
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
1222
0
        TRACEPOINT(mempool, replaced,
1223
0
                it->GetTx().GetHash().data(),
1224
0
                it->GetTxSize(),
1225
0
                it->GetFee(),
1226
0
                std::chrono::duration_cast<std::chrono::duration<std::uint64_t>>(it->GetTime()).count(),
1227
0
                tx_or_package_hash.data(),
1228
0
                feerate.size,
1229
0
                feerate.fee,
1230
0
                replaced_with_tx
1231
0
        );
1232
0
        m_subpackage.m_replaced_transactions.push_back(it->GetSharedTx());
1233
0
    }
1234
0
    m_subpackage.m_changeset->Apply();
1235
0
    m_subpackage.m_changeset.reset();
1236
0
}
1237
1238
bool MemPoolAccept::SubmitPackage(const ATMPArgs& args, std::vector<Workspace>& workspaces,
1239
                                  PackageValidationState& package_state,
1240
                                  std::map<Wtxid, MempoolAcceptResult>& results)
1241
0
{
1242
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1243
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1244
    // Sanity check: none of the transactions should be in the mempool, and none of the transactions
1245
    // should have a same-txid-different-witness equivalent in the mempool.
1246
0
    assert(std::all_of(workspaces.cbegin(), workspaces.cend(), [this](const auto& ws) { return !m_pool.exists(ws.m_ptx->GetHash()); }));
1247
1248
0
    bool all_submitted = true;
1249
0
    FinalizeSubpackage(args);
1250
    // ConsensusScriptChecks adds to the script cache and is therefore consensus-critical;
1251
    // CheckInputsFromMempoolAndCache asserts that transactions only spend coins available from the
1252
    // mempool or UTXO set. Submit each transaction to the mempool immediately after calling
1253
    // ConsensusScriptChecks to make the outputs available for subsequent transactions.
1254
0
    for (Workspace& ws : workspaces) {
1255
0
        if (!ConsensusScriptChecks(args, ws)) {
1256
0
            results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
1257
            // Since PolicyScriptChecks() passed, this should never fail.
1258
0
            Assume(false);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1259
0
            all_submitted = false;
1260
0
            package_state.Invalid(PackageValidationResult::PCKG_MEMPOOL_ERROR,
1261
0
                                  strprintf("BUG! PolicyScriptChecks succeeded but ConsensusScriptChecks failed: %s",
Line
Count
Source
1172
0
#define strprintf tfm::format
1262
0
                                            ws.m_ptx->GetHash().ToString()));
1263
            // Remove the transaction from the mempool.
1264
0
            if (!m_subpackage.m_changeset) m_subpackage.m_changeset = m_pool.GetChangeSet();
1265
0
            m_subpackage.m_changeset->StageRemoval(m_pool.GetIter(ws.m_ptx->GetHash()).value());
1266
0
        }
1267
0
    }
1268
0
    if (!all_submitted) {
1269
0
        Assume(m_subpackage.m_changeset);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1270
        // This code should be unreachable; it's here as belt-and-suspenders
1271
        // to try to ensure we have no consensus-invalid transactions in the
1272
        // mempool.
1273
0
        m_subpackage.m_changeset->Apply();
1274
0
        m_subpackage.m_changeset.reset();
1275
0
        return false;
1276
0
    }
1277
1278
0
    std::vector<Wtxid> all_package_wtxids;
1279
0
    all_package_wtxids.reserve(workspaces.size());
1280
0
    std::transform(workspaces.cbegin(), workspaces.cend(), std::back_inserter(all_package_wtxids),
1281
0
                   [](const auto& ws) { return ws.m_ptx->GetWitnessHash(); });
1282
1283
0
    if (!m_subpackage.m_replaced_transactions.empty()) {
1284
0
        LogDebug(BCLog::MEMPOOL, "replaced %u mempool transactions with %u new one(s) for %s additional fees, %d delta bytes\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
1285
0
                 m_subpackage.m_replaced_transactions.size(), workspaces.size(),
1286
0
                 m_subpackage.m_total_modified_fees - m_subpackage.m_conflicting_fees,
1287
0
                 m_subpackage.m_total_vsize - static_cast<int>(m_subpackage.m_conflicting_size));
1288
0
    }
1289
1290
    // Add successful results. The returned results may change later if LimitMempoolSize() evicts them.
1291
0
    for (Workspace& ws : workspaces) {
1292
0
        auto iter = m_pool.GetIter(ws.m_ptx->GetHash());
1293
0
        Assume(iter.has_value());
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1294
0
        const auto effective_feerate = args.m_package_feerates ? ws.m_package_feerate :
1295
0
            CFeeRate{ws.m_modified_fees, static_cast<int32_t>(ws.m_vsize)};
1296
0
        const auto effective_feerate_wtxids = args.m_package_feerates ? all_package_wtxids :
1297
0
            std::vector<Wtxid>{ws.m_ptx->GetWitnessHash()};
1298
0
        results.emplace(ws.m_ptx->GetWitnessHash(),
1299
0
                        MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions), ws.m_vsize,
1300
0
                                         ws.m_base_fees, effective_feerate, effective_feerate_wtxids));
1301
0
        if (!m_pool.m_opts.signals) continue;
1302
0
        const CTransaction& tx = *ws.m_ptx;
1303
0
        const auto tx_info = NewMempoolTransactionInfo(ws.m_ptx, ws.m_base_fees,
1304
0
                                                       ws.m_vsize, (*iter)->GetHeight(),
1305
0
                                                       args.m_bypass_limits, args.m_package_submission,
1306
0
                                                       IsCurrentForFeeEstimation(m_active_chainstate),
1307
0
                                                       m_pool.HasNoInputsOf(tx));
1308
0
        m_pool.m_opts.signals->TransactionAddedToMempool(tx_info, m_pool.GetAndIncrementSequence());
1309
0
    }
1310
0
    return all_submitted;
1311
0
}
1312
1313
MempoolAcceptResult MemPoolAccept::AcceptSingleTransactionInternal(const CTransactionRef& ptx, ATMPArgs& args)
1314
0
{
1315
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1316
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1317
1318
0
    Workspace ws(ptx);
1319
0
    const std::vector<Wtxid> single_wtxid{ws.m_ptx->GetWitnessHash()};
1320
1321
0
    if (!PreChecks(args, ws)) {
1322
0
        if (ws.m_state.GetResult() == TxValidationResult::TX_RECONSIDERABLE) {
1323
            // Failed for fee reasons. Provide the effective feerate and which tx was included.
1324
0
            return MempoolAcceptResult::FeeFailure(ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), single_wtxid);
1325
0
        }
1326
0
        return MempoolAcceptResult::Failure(ws.m_state);
1327
0
    }
1328
1329
0
    if (m_subpackage.m_rbf && !ReplacementChecks(ws)) {
1330
0
        if (ws.m_state.GetResult() == TxValidationResult::TX_RECONSIDERABLE) {
1331
            // Failed for incentives-based fee reasons. Provide the effective feerate and which tx was included.
1332
0
            return MempoolAcceptResult::FeeFailure(ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), single_wtxid);
1333
0
        }
1334
0
        return MempoolAcceptResult::Failure(ws.m_state);
1335
0
    }
1336
1337
    // Check if the transaction would exceed the cluster size limit.
1338
0
    if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1339
0
        ws.m_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "too-large-cluster", "");
1340
0
        return MempoolAcceptResult::Failure(ws.m_state);
1341
0
    }
1342
1343
    // Now that we've verified the cluster limit is respected, we can perform
1344
    // calculations involving the full ancestors of the tx.
1345
0
    if (ws.m_conflicts.size()) {
1346
0
        auto ancestors = m_subpackage.m_changeset->CalculateMemPoolAncestors(ws.m_tx_handle);
1347
1348
        // A transaction that spends outputs that would be replaced by it is invalid. Now
1349
        // that we have the set of all ancestors we can detect this
1350
        // pathological case by making sure ws.m_conflicts and this tx's ancestors don't
1351
        // intersect.
1352
0
        if (const auto err_string{EntriesAndTxidsDisjoint(ancestors, ws.m_conflicts, ptx->GetHash())}) {
1353
            // We classify this as a consensus error because a transaction depending on something it
1354
            // conflicts with would be inconsistent.
1355
0
            ws.m_state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-txns-spends-conflicting-tx", *err_string);
1356
0
            return MempoolAcceptResult::Failure(ws.m_state);
1357
0
        }
1358
0
    }
1359
1360
0
    m_subpackage.m_total_vsize = ws.m_vsize;
1361
0
    m_subpackage.m_total_modified_fees = ws.m_modified_fees;
1362
1363
    // Individual modified feerate exceeded caller-defined max; abort
1364
0
    if (args.m_client_maxfeerate && CFeeRate(ws.m_modified_fees, ws.m_vsize) > args.m_client_maxfeerate.value()) {
1365
0
        ws.m_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "max feerate exceeded", "");
1366
0
        return MempoolAcceptResult::Failure(ws.m_state);
1367
0
    }
1368
1369
0
    if (!args.m_bypass_limits && m_pool.m_opts.require_standard) {
1370
0
        Wtxid dummy_wtxid;
1371
0
        if (!CheckEphemeralSpends(/*package=*/{ptx}, m_pool.m_opts.dust_relay_feerate, m_pool, ws.m_state, dummy_wtxid)) {
1372
0
            return MempoolAcceptResult::Failure(ws.m_state);
1373
0
        }
1374
0
    }
1375
1376
    // Perform the inexpensive checks first and avoid hashing and signature verification unless
1377
    // those checks pass, to mitigate CPU exhaustion denial-of-service attacks.
1378
0
    if (!PolicyScriptChecks(args, ws)) return MempoolAcceptResult::Failure(ws.m_state);
1379
1380
0
    if (!ConsensusScriptChecks(args, ws)) return MempoolAcceptResult::Failure(ws.m_state);
1381
1382
0
    const CFeeRate effective_feerate{ws.m_modified_fees, static_cast<int32_t>(ws.m_vsize)};
1383
    // Tx was accepted, but not added
1384
0
    if (args.m_test_accept) {
1385
0
        return MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions), ws.m_vsize,
1386
0
                                            ws.m_base_fees, effective_feerate, single_wtxid);
1387
0
    }
1388
1389
0
    FinalizeSubpackage(args);
1390
1391
    // Limit the mempool, if appropriate.
1392
0
    if (!args.m_package_submission && !args.m_bypass_limits) {
1393
0
        LimitMempoolSize(m_pool, m_active_chainstate.CoinsTip());
1394
        // If mempool contents change, then the m_view cache is dirty. Given this isn't a package
1395
        // submission, we won't be using the cache anymore, but clear it anyway for clarity.
1396
0
        CleanupTemporaryCoins();
1397
1398
0
        if (!m_pool.exists(ws.m_hash)) {
1399
            // The tx no longer meets our (new) mempool minimum feerate but could be reconsidered in a package.
1400
0
            ws.m_state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "mempool full");
1401
0
            return MempoolAcceptResult::FeeFailure(ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), {ws.m_ptx->GetWitnessHash()});
1402
0
        }
1403
0
    }
1404
1405
0
    if (m_pool.m_opts.signals) {
1406
0
        const CTransaction& tx = *ws.m_ptx;
1407
0
        auto iter = m_pool.GetIter(tx.GetHash());
1408
0
        Assume(iter.has_value());
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1409
0
        const auto tx_info = NewMempoolTransactionInfo(ws.m_ptx, ws.m_base_fees,
1410
0
                                                       ws.m_vsize, (*iter)->GetHeight(),
1411
0
                                                       args.m_bypass_limits, args.m_package_submission,
1412
0
                                                       IsCurrentForFeeEstimation(m_active_chainstate),
1413
0
                                                       m_pool.HasNoInputsOf(tx));
1414
0
        m_pool.m_opts.signals->TransactionAddedToMempool(tx_info, m_pool.GetAndIncrementSequence());
1415
0
    }
1416
1417
0
    if (!m_subpackage.m_replaced_transactions.empty()) {
1418
0
        LogDebug(BCLog::MEMPOOL, "replaced %u mempool transactions with 1 new transaction for %s additional fees, %d delta bytes\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
1419
0
                 m_subpackage.m_replaced_transactions.size(),
1420
0
                 ws.m_modified_fees - m_subpackage.m_conflicting_fees,
1421
0
                 ws.m_vsize - static_cast<int>(m_subpackage.m_conflicting_size));
1422
0
    }
1423
1424
0
    return MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions), ws.m_vsize, ws.m_base_fees,
1425
0
                                        effective_feerate, single_wtxid);
1426
0
}
1427
1428
PackageMempoolAcceptResult MemPoolAccept::AcceptMultipleTransactionsInternal(const std::vector<CTransactionRef>& txns, ATMPArgs& args)
1429
0
{
1430
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1431
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1432
1433
    // These context-free package limits can be done before taking the mempool lock.
1434
0
    PackageValidationState package_state;
1435
0
    if (!IsWellFormedPackage(txns, package_state)) return PackageMempoolAcceptResult(package_state, {});
1436
1437
0
    std::vector<Workspace> workspaces{};
1438
0
    workspaces.reserve(txns.size());
1439
0
    std::transform(txns.cbegin(), txns.cend(), std::back_inserter(workspaces),
1440
0
                   [](const auto& tx) { return Workspace(tx); });
1441
0
    std::map<Wtxid, MempoolAcceptResult> results;
1442
1443
    // Do all PreChecks first and fail fast to avoid running expensive script checks when unnecessary.
1444
0
    for (Workspace& ws : workspaces) {
1445
0
        if (!PreChecks(args, ws)) {
1446
0
            package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1447
            // Exit early to avoid doing pointless work. Update the failed tx result; the rest are unfinished.
1448
0
            results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
1449
0
            return PackageMempoolAcceptResult(package_state, std::move(results));
1450
0
        }
1451
1452
        // Individual modified feerate exceeded caller-defined max; abort
1453
        // N.B. this doesn't take into account CPFPs. Chunk-aware validation may be more robust.
1454
0
        if (args.m_client_maxfeerate && CFeeRate(ws.m_modified_fees, ws.m_vsize) > args.m_client_maxfeerate.value()) {
1455
            // Need to set failure here both individually and at package level
1456
0
            ws.m_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "max feerate exceeded", "");
1457
0
            package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1458
            // Exit early to avoid doing pointless work. Update the failed tx result; the rest are unfinished.
1459
0
            results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
1460
0
            return PackageMempoolAcceptResult(package_state, std::move(results));
1461
0
        }
1462
1463
        // Make the coins created by this transaction available for subsequent transactions in the
1464
        // package to spend. If there are no conflicts within the package, no transaction can spend a coin
1465
        // needed by another transaction in the package. We also need to make sure that no package
1466
        // tx replaces (or replaces the ancestor of) the parent of another package tx. As long as we
1467
        // check these two things, we don't need to track the coins spent.
1468
        // If a package tx conflicts with a mempool tx, PackageRBFChecks() ensures later that any package RBF attempt
1469
        // has *no* in-mempool ancestors, so we don't have to worry about subsequent transactions in
1470
        // same package spending the same in-mempool outpoints. This needs to be revisited for general
1471
        // package RBF.
1472
0
        m_viewmempool.PackageAddTransaction(ws.m_ptx);
1473
0
    }
1474
1475
    // At this point we have all in-mempool parents, and we know every transaction's vsize.
1476
    // Run the TRUC checks on the package.
1477
0
    for (Workspace& ws : workspaces) {
1478
0
        if (auto err{PackageTRUCChecks(m_pool, ws.m_ptx, ws.m_vsize, txns, ws.m_parents)}) {
1479
0
            package_state.Invalid(PackageValidationResult::PCKG_POLICY, "TRUC-violation", err.value());
1480
0
            return PackageMempoolAcceptResult(package_state, {});
1481
0
        }
1482
0
    }
1483
1484
    // Transactions must meet two minimum feerates: the mempool minimum fee and min relay fee.
1485
    // For transactions consisting of exactly one child and its parents, it suffices to use the
1486
    // package feerate (total modified fees / total virtual size) to check this requirement.
1487
    // Note that this is an aggregate feerate; this function has not checked that there are transactions
1488
    // too low feerate to pay for themselves, or that the child transactions are higher feerate than
1489
    // their parents. Using aggregate feerate may allow "parents pay for child" behavior and permit
1490
    // a child that is below mempool minimum feerate. To avoid these behaviors, callers of
1491
    // AcceptMultipleTransactions need to restrict txns topology (e.g. to ancestor sets) and check
1492
    // the feerates of individuals and subsets.
1493
0
    m_subpackage.m_total_vsize = std::accumulate(workspaces.cbegin(), workspaces.cend(), int64_t{0},
1494
0
        [](int64_t sum, auto& ws) { return sum + ws.m_vsize; });
1495
0
    m_subpackage.m_total_modified_fees = std::accumulate(workspaces.cbegin(), workspaces.cend(), CAmount{0},
1496
0
        [](CAmount sum, auto& ws) { return sum + ws.m_modified_fees; });
1497
0
    const CFeeRate package_feerate(m_subpackage.m_total_modified_fees, m_subpackage.m_total_vsize);
1498
0
    std::vector<Wtxid> all_package_wtxids;
1499
0
    all_package_wtxids.reserve(workspaces.size());
1500
0
    std::transform(workspaces.cbegin(), workspaces.cend(), std::back_inserter(all_package_wtxids),
1501
0
                   [](const auto& ws) { return ws.m_ptx->GetWitnessHash(); });
1502
0
    TxValidationState placeholder_state;
1503
0
    if (args.m_package_feerates &&
1504
0
        !CheckFeeRate(m_subpackage.m_total_vsize, m_subpackage.m_total_modified_fees, placeholder_state)) {
1505
0
        package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1506
0
        return PackageMempoolAcceptResult(package_state, {{workspaces.back().m_ptx->GetWitnessHash(),
1507
0
            MempoolAcceptResult::FeeFailure(placeholder_state, CFeeRate(m_subpackage.m_total_modified_fees, m_subpackage.m_total_vsize), all_package_wtxids)}});
1508
0
    }
1509
1510
    // Apply package mempool RBF checks.
1511
0
    if (m_subpackage.m_rbf && !PackageRBFChecks(txns, workspaces, m_subpackage.m_total_vsize, package_state)) {
1512
0
        return PackageMempoolAcceptResult(package_state, std::move(results));
1513
0
    }
1514
1515
    // Check if the transactions would exceed the cluster size limit.
1516
0
    if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1517
0
        package_state.Invalid(PackageValidationResult::PCKG_POLICY, "too-large-cluster", "");
1518
0
        return PackageMempoolAcceptResult(package_state, std::move(results));
1519
0
    }
1520
1521
    // Now that we've bounded the resulting possible ancestry count, check package for dust spends
1522
0
    if (m_pool.m_opts.require_standard) {
1523
0
        TxValidationState child_state;
1524
0
        Wtxid child_wtxid;
1525
0
        if (!CheckEphemeralSpends(txns, m_pool.m_opts.dust_relay_feerate, m_pool, child_state, child_wtxid)) {
1526
0
            package_state.Invalid(PackageValidationResult::PCKG_TX, "unspent-dust");
1527
0
            results.emplace(child_wtxid, MempoolAcceptResult::Failure(child_state));
1528
0
            return PackageMempoolAcceptResult(package_state, std::move(results));
1529
0
        }
1530
0
    }
1531
1532
0
    for (Workspace& ws : workspaces) {
1533
0
        ws.m_package_feerate = package_feerate;
1534
0
        if (!PolicyScriptChecks(args, ws)) {
1535
            // Exit early to avoid doing pointless work. Update the failed tx result; the rest are unfinished.
1536
0
            package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1537
0
            results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
1538
0
            return PackageMempoolAcceptResult(package_state, std::move(results));
1539
0
        }
1540
0
        if (args.m_test_accept) {
1541
0
            const auto effective_feerate = args.m_package_feerates ? ws.m_package_feerate :
1542
0
                CFeeRate{ws.m_modified_fees, static_cast<int32_t>(ws.m_vsize)};
1543
0
            const auto effective_feerate_wtxids = args.m_package_feerates ? all_package_wtxids :
1544
0
                std::vector<Wtxid>{ws.m_ptx->GetWitnessHash()};
1545
0
            results.emplace(ws.m_ptx->GetWitnessHash(),
1546
0
                            MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions),
1547
0
                                                         ws.m_vsize, ws.m_base_fees, effective_feerate,
1548
0
                                                         effective_feerate_wtxids));
1549
0
        }
1550
0
    }
1551
1552
0
    if (args.m_test_accept) return PackageMempoolAcceptResult(package_state, std::move(results));
1553
1554
0
    if (!SubmitPackage(args, workspaces, package_state, results)) {
1555
        // PackageValidationState filled in by SubmitPackage().
1556
0
        return PackageMempoolAcceptResult(package_state, std::move(results));
1557
0
    }
1558
1559
0
    return PackageMempoolAcceptResult(package_state, std::move(results));
1560
0
}
1561
1562
void MemPoolAccept::CleanupTemporaryCoins()
1563
0
{
1564
    // There are 3 kinds of coins in m_view:
1565
    // (1) Temporary coins from the transactions in subpackage, constructed by m_viewmempool.
1566
    // (2) Mempool coins from transactions in the mempool, constructed by m_viewmempool.
1567
    // (3) Confirmed coins fetched from our current UTXO set.
1568
    //
1569
    // (1) Temporary coins need to be removed, regardless of whether the transaction was submitted.
1570
    // If the transaction was submitted to the mempool, m_viewmempool will be able to fetch them from
1571
    // there. If it wasn't submitted to mempool, it is incorrect to keep them - future calls may try
1572
    // to spend those coins that don't actually exist.
1573
    // (2) Mempool coins also need to be removed. If the mempool contents have changed as a result
1574
    // of submitting or replacing transactions, coins previously fetched from mempool may now be
1575
    // spent or nonexistent. Those coins need to be deleted from m_view.
1576
    // (3) Confirmed coins don't need to be removed. The chainstate has not changed (we are
1577
    // holding cs_main and no blocks have been processed) so the confirmed tx cannot disappear like
1578
    // a mempool tx can. The coin may now be spent after we submitted a tx to mempool, but
1579
    // we have already checked that the package does not have 2 transactions spending the same coin
1580
    // and we check whether a mempool transaction spends conflicting coins (CTxMemPool::GetConflictTx).
1581
    // Keeping them in m_view is an optimization to not re-fetch confirmed coins if we later look up
1582
    // inputs for this transaction again.
1583
0
    for (const auto& outpoint : m_viewmempool.GetNonBaseCoins()) {
1584
        // In addition to resetting m_viewmempool, we also need to manually delete these coins from
1585
        // m_view because it caches copies of the coins it fetched from m_viewmempool previously.
1586
0
        m_view.Uncache(outpoint);
1587
0
    }
1588
    // This deletes the temporary and mempool coins.
1589
0
    m_viewmempool.Reset();
1590
0
}
1591
1592
PackageMempoolAcceptResult MemPoolAccept::AcceptSubPackage(const std::vector<CTransactionRef>& subpackage, ATMPArgs& args)
1593
0
{
1594
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1595
0
    AssertLockHeld(m_pool.cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1596
0
    auto result = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main, m_pool.cs) {
1597
0
        if (subpackage.size() > 1) {
1598
0
            return AcceptMultipleTransactionsInternal(subpackage, args);
1599
0
        }
1600
0
        const auto& tx = subpackage.front();
1601
0
        ATMPArgs single_args = ATMPArgs::SingleInPackageAccept(args);
1602
0
        const auto single_res = AcceptSingleTransactionInternal(tx, single_args);
1603
0
        PackageValidationState package_state_wrapped;
1604
0
        if (single_res.m_result_type != MempoolAcceptResult::ResultType::VALID) {
1605
0
            package_state_wrapped.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1606
0
        }
1607
0
        return PackageMempoolAcceptResult(package_state_wrapped, {{tx->GetWitnessHash(), single_res}});
1608
0
    }();
1609
1610
    // Clean up m_view and m_viewmempool so that other subpackage evaluations don't have access to
1611
    // coins they shouldn't. Keep some coins in order to minimize re-fetching coins from the UTXO set.
1612
    // Clean up package feerate and rbf calculations
1613
0
    ClearSubPackageState();
1614
1615
0
    return result;
1616
0
}
1617
1618
PackageMempoolAcceptResult MemPoolAccept::AcceptPackage(const Package& package, ATMPArgs& args)
1619
0
{
1620
0
    Assert(!package.empty());
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
1621
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1622
    // Used if returning a PackageMempoolAcceptResult directly from this function.
1623
0
    PackageValidationState package_state_quit_early;
1624
1625
    // There are two topologies we are able to handle through this function:
1626
    // (1) A single transaction
1627
    // (2) A child-with-parents package.
1628
    // Check that the package is well-formed. If it isn't, we won't try to validate any of the
1629
    // transactions and thus won't return any MempoolAcceptResults, just a package-wide error.
1630
1631
    // Context-free package checks.
1632
0
    if (!IsWellFormedPackage(package, package_state_quit_early)) {
1633
0
        return PackageMempoolAcceptResult(package_state_quit_early, {});
1634
0
    }
1635
1636
0
    if (package.size() > 1 && !IsChildWithParents(package)) {
1637
        // All transactions in the package must be a parent of the last transaction. This is just an
1638
        // opportunity for us to fail fast on a context-free check without taking the mempool lock.
1639
0
        package_state_quit_early.Invalid(PackageValidationResult::PCKG_POLICY, "package-not-child-with-parents");
1640
0
        return PackageMempoolAcceptResult(package_state_quit_early, {});
1641
0
    }
1642
1643
0
    LOCK(m_pool.cs);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
1644
    // Stores results from which we will create the returned PackageMempoolAcceptResult.
1645
    // A result may be changed if a mempool transaction is evicted later due to LimitMempoolSize().
1646
0
    std::map<Wtxid, MempoolAcceptResult> results_final;
1647
    // Results from individual validation which will be returned if no other result is available for
1648
    // this transaction. "Nonfinal" because if a transaction fails by itself but succeeds later
1649
    // (i.e. when evaluated with a fee-bumping child), the result in this map may be discarded.
1650
0
    std::map<Wtxid, MempoolAcceptResult> individual_results_nonfinal;
1651
    // Tracks whether we think package submission could result in successful entry to the mempool
1652
0
    bool quit_early{false};
1653
0
    std::vector<CTransactionRef> txns_package_eval;
1654
0
    for (const auto& tx : package) {
1655
0
        const auto& wtxid = tx->GetWitnessHash();
1656
0
        const auto& txid = tx->GetHash();
1657
        // There are 3 possibilities: already in mempool, same-txid-diff-wtxid already in mempool,
1658
        // or not in mempool. An already confirmed tx is treated as one not in mempool, because all
1659
        // we know is that the inputs aren't available.
1660
0
        if (m_pool.exists(wtxid)) {
1661
            // Exact transaction already exists in the mempool.
1662
            // Node operators are free to set their mempool policies however they please, nodes may receive
1663
            // transactions in different orders, and malicious counterparties may try to take advantage of
1664
            // policy differences to pin or delay propagation of transactions. As such, it's possible for
1665
            // some package transaction(s) to already be in the mempool, and we don't want to reject the
1666
            // entire package in that case (as that could be a censorship vector). De-duplicate the
1667
            // transactions that are already in the mempool, and only call AcceptMultipleTransactions() with
1668
            // the new transactions. This ensures we don't double-count transaction counts and sizes when
1669
            // checking ancestor/descendant limits, or double-count transaction fees for fee-related policy.
1670
0
            const auto& entry{*Assert(m_pool.GetEntry(txid))};
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
1671
0
            results_final.emplace(wtxid, MempoolAcceptResult::MempoolTx(entry.GetTxSize(), entry.GetFee()));
1672
0
        } else if (m_pool.exists(txid)) {
1673
            // Transaction with the same non-witness data but different witness (same txid,
1674
            // different wtxid) already exists in the mempool.
1675
            //
1676
            // We don't allow replacement transactions right now, so just swap the package
1677
            // transaction for the mempool one. Note that we are ignoring the validity of the
1678
            // package transaction passed in.
1679
            // TODO: allow witness replacement in packages.
1680
0
            const auto& entry{*Assert(m_pool.GetEntry(txid))};
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
1681
            // Provide the wtxid of the mempool tx so that the caller can look it up in the mempool.
1682
0
            results_final.emplace(wtxid, MempoolAcceptResult::MempoolTxDifferentWitness(entry.GetTx().GetWitnessHash()));
1683
0
        } else {
1684
            // Transaction does not already exist in the mempool.
1685
            // Try submitting the transaction on its own.
1686
0
            const auto single_package_res = AcceptSubPackage({tx}, args);
1687
0
            const auto& single_res = single_package_res.m_tx_results.at(wtxid);
1688
0
            if (single_res.m_result_type == MempoolAcceptResult::ResultType::VALID) {
1689
                // The transaction succeeded on its own and is now in the mempool. Don't include it
1690
                // in package validation, because its fees should only be "used" once.
1691
0
                assert(m_pool.exists(wtxid));
1692
0
                results_final.emplace(wtxid, single_res);
1693
0
            } else if (package.size() == 1 || // If there is only one transaction, no need to retry it "as a package"
1694
0
                       (single_res.m_state.GetResult() != TxValidationResult::TX_RECONSIDERABLE &&
1695
0
                       single_res.m_state.GetResult() != TxValidationResult::TX_MISSING_INPUTS)) {
1696
                // Package validation policy only differs from individual policy in its evaluation
1697
                // of feerate. For example, if a transaction fails here due to violation of a
1698
                // consensus rule, the result will not change when it is submitted as part of a
1699
                // package. To minimize the amount of repeated work, unless the transaction fails
1700
                // due to feerate or missing inputs (its parent is a previous transaction in the
1701
                // package that failed due to feerate), don't run package validation. Note that this
1702
                // decision might not make sense if different types of packages are allowed in the
1703
                // future.  Continue individually validating the rest of the transactions, because
1704
                // some of them may still be valid.
1705
0
                quit_early = true;
1706
0
                package_state_quit_early.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1707
0
                individual_results_nonfinal.emplace(wtxid, single_res);
1708
0
            } else {
1709
0
                individual_results_nonfinal.emplace(wtxid, single_res);
1710
0
                txns_package_eval.push_back(tx);
1711
0
            }
1712
0
        }
1713
0
    }
1714
1715
0
    auto multi_submission_result = quit_early || txns_package_eval.empty() ? PackageMempoolAcceptResult(package_state_quit_early, {}) :
1716
0
        AcceptSubPackage(txns_package_eval, args);
1717
0
    PackageValidationState& package_state_final = multi_submission_result.m_state;
1718
1719
    // This is invoked by AcceptSubPackage() already, so this is just here for
1720
    // clarity (since it's not permitted to invoke LimitMempoolSize() while a
1721
    // changeset is outstanding).
1722
0
    ClearSubPackageState();
1723
1724
    // Make sure we haven't exceeded max mempool size.
1725
    // Package transactions that were submitted to mempool or already in mempool may be evicted.
1726
    // If mempool contents change, then the m_view cache is dirty. It has already been cleared above.
1727
0
    LimitMempoolSize(m_pool, m_active_chainstate.CoinsTip());
1728
1729
0
    for (const auto& tx : package) {
1730
0
        const auto& wtxid = tx->GetWitnessHash();
1731
0
        if (multi_submission_result.m_tx_results.contains(wtxid)) {
1732
            // We shouldn't have re-submitted if the tx result was already in results_final.
1733
0
            Assume(!results_final.contains(wtxid));
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1734
            // If it was submitted, check to see if the tx is still in the mempool. It could have
1735
            // been evicted due to LimitMempoolSize() above.
1736
0
            const auto& txresult = multi_submission_result.m_tx_results.at(wtxid);
1737
0
            if (txresult.m_result_type == MempoolAcceptResult::ResultType::VALID && !m_pool.exists(wtxid)) {
1738
0
                package_state_final.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1739
0
                TxValidationState mempool_full_state;
1740
0
                mempool_full_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "mempool full");
1741
0
                results_final.emplace(wtxid, MempoolAcceptResult::Failure(mempool_full_state));
1742
0
            } else {
1743
0
                results_final.emplace(wtxid, txresult);
1744
0
            }
1745
0
        } else if (const auto it{results_final.find(wtxid)}; it != results_final.end()) {
1746
            // Already-in-mempool transaction. Check to see if it's still there, as it could have
1747
            // been evicted when LimitMempoolSize() was called.
1748
0
            Assume(it->second.m_result_type != MempoolAcceptResult::ResultType::INVALID);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1749
0
            Assume(!individual_results_nonfinal.contains(wtxid));
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1750
            // Query by txid to include the same-txid-different-witness ones.
1751
0
            if (!m_pool.exists(tx->GetHash())) {
1752
0
                package_state_final.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1753
0
                TxValidationState mempool_full_state;
1754
0
                mempool_full_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "mempool full");
1755
                // Replace the previous result.
1756
0
                results_final.erase(wtxid);
1757
0
                results_final.emplace(wtxid, MempoolAcceptResult::Failure(mempool_full_state));
1758
0
            }
1759
0
        } else if (const auto it{individual_results_nonfinal.find(wtxid)}; it != individual_results_nonfinal.end()) {
1760
0
            Assume(it->second.m_result_type == MempoolAcceptResult::ResultType::INVALID);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1761
            // Interesting result from previous processing.
1762
0
            results_final.emplace(wtxid, it->second);
1763
0
        }
1764
0
    }
1765
0
    Assume(results_final.size() == package.size());
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
1766
0
    return PackageMempoolAcceptResult(package_state_final, std::move(results_final));
1767
0
}
1768
1769
} // anon namespace
1770
1771
MempoolAcceptResult AcceptToMemoryPool(Chainstate& active_chainstate, const CTransactionRef& tx,
1772
                                       int64_t accept_time, bool bypass_limits, bool test_accept)
1773
0
{
1774
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1775
0
    const CChainParams& chainparams{active_chainstate.m_chainman.GetParams()};
1776
0
    assert(active_chainstate.GetMempool() != nullptr);
1777
0
    CTxMemPool& pool{*active_chainstate.GetMempool()};
1778
1779
0
    std::vector<COutPoint> coins_to_uncache;
1780
1781
0
    auto args = MemPoolAccept::ATMPArgs::SingleAccept(chainparams, accept_time, bypass_limits, coins_to_uncache, test_accept);
1782
0
    MempoolAcceptResult result = MemPoolAccept(pool, active_chainstate).AcceptSingleTransactionAndCleanup(tx, args);
1783
1784
0
    if (result.m_result_type != MempoolAcceptResult::ResultType::VALID) {
1785
        // Remove coins that were not present in the coins cache before calling
1786
        // AcceptSingleTransaction(); this is to prevent memory DoS in case we receive a large
1787
        // number of invalid transactions that attempt to overrun the in-memory coins cache
1788
        // (`CCoinsViewCache::cacheCoins`).
1789
1790
0
        for (const COutPoint& hashTx : coins_to_uncache)
1791
0
            active_chainstate.CoinsTip().Uncache(hashTx);
1792
0
        TRACEPOINT(mempool, rejected,
1793
0
                tx->GetHash().data(),
1794
0
                result.m_state.GetRejectReason().c_str()
1795
0
        );
1796
0
    }
1797
    // After we've (potentially) uncached entries, ensure our coins cache is still within its size limits
1798
0
    BlockValidationState state_dummy;
1799
0
    active_chainstate.FlushStateToDisk(state_dummy, FlushStateMode::PERIODIC);
1800
0
    return result;
1801
0
}
1802
1803
PackageMempoolAcceptResult ProcessNewPackage(Chainstate& active_chainstate, CTxMemPool& pool,
1804
                                                   const Package& package, bool test_accept, const std::optional<CFeeRate>& client_maxfeerate)
1805
0
{
1806
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1807
0
    assert(!package.empty());
1808
0
    assert(std::all_of(package.cbegin(), package.cend(), [](const auto& tx){return tx != nullptr;}));
1809
1810
0
    std::vector<COutPoint> coins_to_uncache;
1811
0
    const CChainParams& chainparams = active_chainstate.m_chainman.GetParams();
1812
0
    auto result = [&]() EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
1813
0
        AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1814
0
        if (test_accept) {
1815
0
            auto args = MemPoolAccept::ATMPArgs::PackageTestAccept(chainparams, GetTime(), coins_to_uncache);
1816
0
            return MemPoolAccept(pool, active_chainstate).AcceptMultipleTransactionsAndCleanup(package, args);
1817
0
        } else {
1818
0
            auto args = MemPoolAccept::ATMPArgs::PackageChildWithParents(chainparams, GetTime(), coins_to_uncache, client_maxfeerate);
1819
0
            return MemPoolAccept(pool, active_chainstate).AcceptPackage(package, args);
1820
0
        }
1821
0
    }();
1822
1823
    // Uncache coins pertaining to transactions that were not submitted to the mempool.
1824
0
    if (test_accept || result.m_state.IsInvalid()) {
1825
0
        for (const COutPoint& hashTx : coins_to_uncache) {
1826
0
            active_chainstate.CoinsTip().Uncache(hashTx);
1827
0
        }
1828
0
    }
1829
    // Ensure the coins cache is still within limits.
1830
0
    BlockValidationState state_dummy;
1831
0
    active_chainstate.FlushStateToDisk(state_dummy, FlushStateMode::PERIODIC);
1832
0
    return result;
1833
0
}
1834
1835
CAmount GetBlockSubsidy(int nHeight, const Consensus::Params& consensusParams)
1836
0
{
1837
0
    int halvings = nHeight / consensusParams.nSubsidyHalvingInterval;
1838
    // Force block reward to zero when right shift is undefined.
1839
0
    if (halvings >= 64)
1840
0
        return 0;
1841
1842
0
    CAmount nSubsidy = 50 * COIN;
1843
    // Subsidy is cut in half every 210,000 blocks which will occur approximately every 4 years.
1844
0
    nSubsidy >>= halvings;
1845
0
    return nSubsidy;
1846
0
}
1847
1848
CoinsViews::CoinsViews(DBParams db_params, CoinsViewOptions options)
1849
0
    : m_dbview{std::move(db_params), std::move(options)},
1850
0
      m_catcherview(&m_dbview) {}
1851
1852
void CoinsViews::InitCache()
1853
0
{
1854
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1855
0
    m_cacheview = std::make_unique<CCoinsViewCache>(&m_catcherview);
1856
0
    m_connect_block_view = std::make_unique<CoinsViewOverlay>(&*m_cacheview);
1857
0
}
1858
1859
Chainstate::Chainstate(
1860
    CTxMemPool* mempool,
1861
    BlockManager& blockman,
1862
    ChainstateManager& chainman,
1863
    std::optional<uint256> from_snapshot_blockhash)
1864
0
    : m_mempool(mempool),
1865
0
      m_blockman(blockman),
1866
0
      m_chainman(chainman),
1867
0
      m_assumeutxo(from_snapshot_blockhash ? Assumeutxo::UNVALIDATED : Assumeutxo::VALIDATED),
1868
0
      m_from_snapshot_blockhash(from_snapshot_blockhash) {}
1869
1870
fs::path Chainstate::StoragePath() const
1871
0
{
1872
0
    fs::path path{m_chainman.m_options.datadir / "chainstate"};
1873
0
    if (m_from_snapshot_blockhash) {
1874
0
        path += node::SNAPSHOT_CHAINSTATE_SUFFIX;
1875
0
    }
1876
0
    return path;
1877
0
}
1878
1879
const CBlockIndex* Chainstate::SnapshotBase() const
1880
0
{
1881
0
    if (!m_from_snapshot_blockhash) return nullptr;
1882
0
    if (!m_cached_snapshot_base) m_cached_snapshot_base = Assert(m_chainman.m_blockman.LookupBlockIndex(*m_from_snapshot_blockhash));
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
1883
0
    return m_cached_snapshot_base;
1884
0
}
1885
1886
const CBlockIndex* Chainstate::TargetBlock() const
1887
0
{
1888
0
    if (!m_target_blockhash) return nullptr;
1889
0
    if (!m_cached_target_block) m_cached_target_block = Assert(m_chainman.m_blockman.LookupBlockIndex(*m_target_blockhash));
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
1890
0
    return m_cached_target_block;
1891
0
}
1892
1893
void Chainstate::SetTargetBlock(CBlockIndex* block)
1894
0
{
1895
0
    if (block) {
1896
0
        m_target_blockhash = block->GetBlockHash();
1897
0
    } else {
1898
0
        m_target_blockhash.reset();
1899
0
    }
1900
0
    m_cached_target_block = block;
1901
0
}
1902
1903
void Chainstate::SetTargetBlockHash(uint256 block_hash)
1904
0
{
1905
0
    m_target_blockhash = block_hash;
1906
0
    m_cached_target_block = nullptr;
1907
0
}
1908
1909
void Chainstate::InitCoinsDB(
1910
    size_t cache_size_bytes,
1911
    bool in_memory,
1912
    bool should_wipe)
1913
0
{
1914
0
    m_coins_views = std::make_unique<CoinsViews>(
1915
0
        DBParams{
1916
0
            .path = StoragePath(),
1917
0
            .cache_bytes = cache_size_bytes,
1918
0
            .memory_only = in_memory,
1919
0
            .wipe_data = should_wipe,
1920
0
            .obfuscate = true,
1921
0
            .options = m_chainman.m_options.coins_db},
1922
0
        m_chainman.m_options.coins_view);
1923
1924
0
    m_coinsdb_cache_size_bytes = cache_size_bytes;
1925
0
}
1926
1927
void Chainstate::InitCoinsCache(size_t cache_size_bytes)
1928
0
{
1929
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1930
0
    assert(m_coins_views != nullptr);
1931
0
    m_coinstip_cache_size_bytes = cache_size_bytes;
1932
0
    m_coins_views->InitCache();
1933
0
}
1934
1935
// Lock-free: depends on `m_cached_is_ibd`, which is latched by `UpdateIBDStatus()`.
1936
bool ChainstateManager::IsInitialBlockDownload() const noexcept
1937
13.1k
{
1938
13.1k
    return m_cached_is_ibd.load(std::memory_order_relaxed);
1939
13.1k
}
1940
1941
void Chainstate::CheckForkWarningConditions()
1942
0
{
1943
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1944
1945
0
    if (this->GetRole().historical) {
1946
0
        return;
1947
0
    }
1948
1949
0
    if (m_chainman.m_best_invalid && m_chainman.m_best_invalid->nChainWork > m_chain.Tip()->nChainWork + (GetBlockProof(*m_chain.Tip()) * 6)) {
1950
0
        LogWarning("Found invalid chain more than 6 blocks longer than our best chain. This could be due to database corruption or consensus incompatibility with peers.");
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
1951
0
        m_chainman.GetNotifications().warningSet(
1952
0
            kernel::Warning::LARGE_WORK_INVALID_CHAIN,
1953
0
            _("Warning: Found invalid chain more than 6 blocks longer than our best chain. This could be due to database corruption or consensus incompatibility with peers."));
1954
0
    } else {
1955
0
        m_chainman.GetNotifications().warningUnset(kernel::Warning::LARGE_WORK_INVALID_CHAIN);
1956
0
    }
1957
0
}
1958
1959
// Called both upon regular invalid block discovery *and* InvalidateBlock
1960
void Chainstate::InvalidChainFound(CBlockIndex* pindexNew)
1961
0
{
1962
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1963
0
    if (!m_chainman.m_best_invalid || pindexNew->nChainWork > m_chainman.m_best_invalid->nChainWork) {
1964
0
        m_chainman.m_best_invalid = pindexNew;
1965
0
    }
1966
0
    SetBlockFailureFlags(pindexNew);
1967
0
    if (m_chainman.m_best_header != nullptr && m_chainman.m_best_header->GetAncestor(pindexNew->nHeight) == pindexNew) {
1968
0
        m_chainman.RecalculateBestHeader();
1969
0
    }
1970
1971
0
    LogInfo("%s: invalid block=%s height=%d log2_work=%f date=%s", __func__,
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
1972
0
      pindexNew->GetBlockHash().ToString(), pindexNew->nHeight,
1973
0
      log(pindexNew->nChainWork.getdouble())/log(2.0), FormatISO8601DateTime(pindexNew->GetBlockTime()));
1974
0
    CBlockIndex *tip = m_chain.Tip();
1975
0
    assert (tip);
1976
0
    LogInfo("%s: current best=%s height=%d log2_work=%f date=%s", __func__,
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
1977
0
      tip->GetBlockHash().ToString(), m_chain.Height(), log(tip->nChainWork.getdouble())/log(2.0),
1978
0
      FormatISO8601DateTime(tip->GetBlockTime()));
1979
0
    CheckForkWarningConditions();
1980
0
}
1981
1982
// Same as InvalidChainFound, above, except not called directly from InvalidateBlock,
1983
// which does its own setBlockIndexCandidates management.
1984
void Chainstate::InvalidBlockFound(CBlockIndex* pindex, const BlockValidationState& state)
1985
0
{
1986
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
1987
0
    if (state.GetResult() != BlockValidationResult::BLOCK_MUTATED) {
1988
0
        pindex->nStatus |= BLOCK_FAILED_VALID;
1989
0
        m_blockman.m_dirty_blockindex.insert(pindex);
1990
0
        setBlockIndexCandidates.erase(pindex);
1991
0
        InvalidChainFound(pindex);
1992
0
    }
1993
0
}
1994
1995
void UpdateCoins(const CTransaction& tx, CCoinsViewCache& inputs, CTxUndo &txundo, int nHeight)
1996
0
{
1997
    // mark inputs spent
1998
0
    if (!tx.IsCoinBase()) {
1999
0
        txundo.vprevout.reserve(tx.vin.size());
2000
0
        for (const CTxIn &txin : tx.vin) {
2001
0
            txundo.vprevout.emplace_back();
2002
0
            bool is_spent = inputs.SpendCoin(txin.prevout, &txundo.vprevout.back());
2003
0
            assert(is_spent);
2004
0
        }
2005
0
    }
2006
    // add outputs
2007
0
    AddCoins(inputs, tx, nHeight);
2008
0
}
2009
2010
0
std::optional<std::pair<ScriptError, std::string>> CScriptCheck::operator()() {
2011
0
    const CScript &scriptSig = ptxTo->vin[nIn].scriptSig;
2012
0
    const CScriptWitness *witness = &ptxTo->vin[nIn].scriptWitness;
2013
0
    ScriptError error{SCRIPT_ERR_UNKNOWN_ERROR};
2014
0
    if (VerifyScript(scriptSig, m_tx_out.scriptPubKey, witness, m_flags, CachingTransactionSignatureChecker(ptxTo, nIn, m_tx_out.nValue, cacheStore, *m_signature_cache, *txdata), &error)) {
2015
0
        return std::nullopt;
2016
0
    } else {
2017
0
        auto debug_str = strprintf("input %i of %s (wtxid %s), spending %s:%i", nIn, ptxTo->GetHash().ToString(), ptxTo->GetWitnessHash().ToString(), ptxTo->vin[nIn].prevout.hash.ToString(), ptxTo->vin[nIn].prevout.n);
Line
Count
Source
1172
0
#define strprintf tfm::format
2018
0
        return std::make_pair(error, std::move(debug_str));
2019
0
    }
2020
0
}
2021
2022
ValidationCache::ValidationCache(const size_t script_execution_cache_bytes, const size_t signature_cache_bytes)
2023
0
    : m_signature_cache{signature_cache_bytes}
2024
0
{
2025
    // Setup the salted hasher
2026
0
    uint256 nonce = GetRandHash();
2027
    // We want the nonce to be 64 bytes long to force the hasher to process
2028
    // this chunk, which makes later hash computations more efficient. We
2029
    // just write our 32-byte entropy twice to fill the 64 bytes.
2030
0
    m_script_execution_cache_hasher.Write(nonce.begin(), 32);
2031
0
    m_script_execution_cache_hasher.Write(nonce.begin(), 32);
2032
2033
0
    const auto [num_elems, approx_size_bytes] = m_script_execution_cache.setup_bytes(script_execution_cache_bytes);
2034
0
    LogInfo("Using %zu MiB out of %zu MiB requested for script execution cache, able to store %zu elements",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2035
0
              approx_size_bytes >> 20, script_execution_cache_bytes >> 20, num_elems);
2036
0
}
2037
2038
/**
2039
 * Check whether all of this transaction's input scripts succeed.
2040
 *
2041
 * This involves ECDSA signature checks so can be computationally intensive. This function should
2042
 * only be called after the cheap sanity checks in CheckTxInputs passed.
2043
 *
2044
 * If pvChecks is not nullptr, script checks are pushed onto it instead of being performed inline. Any
2045
 * script checks which are not necessary (eg due to script execution cache hits) are, obviously,
2046
 * not pushed onto pvChecks/run.
2047
 *
2048
 * Setting cacheSigStore/cacheFullScriptStore to false will remove elements from the corresponding cache
2049
 * which are matched. This is useful for checking blocks where we will likely never need the cache
2050
 * entry again.
2051
 *
2052
 * Note that we may set state.reason to NOT_STANDARD for extra soft-fork flags in flags, block-checking
2053
 * callers should probably reset it to CONSENSUS in such cases.
2054
 *
2055
 * Non-static (and redeclared) in src/test/txvalidationcache_tests.cpp
2056
 */
2057
bool CheckInputScripts(const CTransaction& tx, TxValidationState& state,
2058
                       const CCoinsViewCache& inputs, script_verify_flags flags, bool cacheSigStore,
2059
                       bool cacheFullScriptStore, PrecomputedTransactionData& txdata,
2060
                       ValidationCache& validation_cache,
2061
                       std::vector<CScriptCheck>* pvChecks)
2062
0
{
2063
0
    if (tx.IsCoinBase()) return true;
2064
2065
0
    if (pvChecks) {
2066
0
        pvChecks->reserve(tx.vin.size());
2067
0
    }
2068
2069
    // First check if script executions have been cached with the same
2070
    // flags. Note that this assumes that the inputs provided are
2071
    // correct (ie that the transaction hash which is in tx's prevouts
2072
    // properly commits to the scriptPubKey in the inputs view of that
2073
    // transaction).
2074
0
    uint256 hashCacheEntry;
2075
0
    CSHA256 hasher = validation_cache.ScriptExecutionCacheHasher();
2076
0
    hasher.Write(UCharCast(tx.GetWitnessHash().begin()), 32).Write((unsigned char*)&flags, sizeof(flags)).Finalize(hashCacheEntry.begin());
2077
0
    AssertLockHeld(cs_main); //TODO: Remove this requirement by making CuckooCache not require external locks
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
2078
0
    if (validation_cache.m_script_execution_cache.contains(hashCacheEntry, !cacheFullScriptStore)) {
2079
0
        return true;
2080
0
    }
2081
2082
0
    if (!txdata.m_spent_outputs_ready) {
2083
0
        std::vector<CTxOut> spent_outputs;
2084
0
        spent_outputs.reserve(tx.vin.size());
2085
2086
0
        for (const auto& txin : tx.vin) {
2087
0
            const COutPoint& prevout = txin.prevout;
2088
0
            const Coin& coin = inputs.AccessCoin(prevout);
2089
0
            assert(!coin.IsSpent());
2090
0
            spent_outputs.emplace_back(coin.out);
2091
0
        }
2092
0
        txdata.Init(tx, std::move(spent_outputs));
2093
0
    }
2094
0
    assert(txdata.m_spent_outputs.size() == tx.vin.size());
2095
2096
0
    for (unsigned int i = 0; i < tx.vin.size(); i++) {
2097
2098
        // We very carefully only pass in things to CScriptCheck which
2099
        // are clearly committed to by tx' witness hash. This provides
2100
        // a sanity check that our caching is not introducing consensus
2101
        // failures through additional data in, eg, the coins being
2102
        // spent being checked as a part of CScriptCheck.
2103
2104
        // Verify signature
2105
0
        CScriptCheck check(txdata.m_spent_outputs[i], tx, validation_cache.m_signature_cache, i, flags, cacheSigStore, &txdata);
2106
0
        if (pvChecks) {
2107
0
            pvChecks->emplace_back(std::move(check));
2108
0
        } else if (auto result = check(); result.has_value()) {
2109
            // Tx failures never trigger disconnections/bans.
2110
            // This is so that network splits aren't triggered
2111
            // either due to non-consensus relay policies (such as
2112
            // non-standard DER encodings or non-null dummy
2113
            // arguments) or due to new consensus rules introduced in
2114
            // soft forks.
2115
0
            if (flags & STANDARD_NOT_MANDATORY_VERIFY_FLAGS) {
2116
0
                return state.Invalid(TxValidationResult::TX_NOT_STANDARD, strprintf("mempool-script-verify-flag-failed (%s)", ScriptErrorString(result->first)), result->second);
Line
Count
Source
1172
0
#define strprintf tfm::format
2117
0
            } else {
2118
0
                return state.Invalid(TxValidationResult::TX_CONSENSUS, strprintf("block-script-verify-flag-failed (%s)", ScriptErrorString(result->first)), result->second);
Line
Count
Source
1172
0
#define strprintf tfm::format
2119
0
            }
2120
0
        }
2121
0
    }
2122
2123
0
    if (cacheFullScriptStore && !pvChecks) {
2124
        // We executed all of the provided scripts, and were told to
2125
        // cache the result. Do so now.
2126
0
        validation_cache.m_script_execution_cache.insert(hashCacheEntry);
2127
0
    }
2128
2129
0
    return true;
2130
0
}
2131
2132
bool FatalError(Notifications& notifications, BlockValidationState& state, const bilingual_str& message)
2133
0
{
2134
0
    notifications.fatalError(message);
2135
0
    return state.Error(message.original);
2136
0
}
2137
2138
/**
2139
 * Restore the UTXO in a Coin at a given COutPoint
2140
 * @param undo The Coin to be restored.
2141
 * @param view The coins view to which to apply the changes.
2142
 * @param out The out point that corresponds to the tx input.
2143
 * @return A DisconnectResult as an int
2144
 */
2145
int ApplyTxInUndo(Coin&& undo, CCoinsViewCache& view, const COutPoint& out)
2146
0
{
2147
0
    bool fClean = true;
2148
2149
0
    if (view.HaveCoin(out)) fClean = false; // overwriting transaction output
2150
2151
0
    if (undo.nHeight == 0) {
2152
        // Missing undo metadata (height and coinbase). Older versions included this
2153
        // information only in undo records for the last spend of a transactions'
2154
        // outputs. This implies that it must be present for some other output of the same tx.
2155
0
        const Coin& alternate = AccessByTxid(view, out.hash);
2156
0
        if (!alternate.IsSpent()) {
2157
0
            undo.nHeight = alternate.nHeight;
2158
0
            undo.fCoinBase = alternate.fCoinBase;
2159
0
        } else {
2160
0
            return DISCONNECT_FAILED; // adding output for transaction without known metadata
2161
0
        }
2162
0
    }
2163
    // If the coin already exists as an unspent coin in the cache, then the
2164
    // possible_overwrite parameter to AddCoin must be set to true. We have
2165
    // already checked whether an unspent coin exists above using HaveCoin, so
2166
    // we don't need to guess. When fClean is false, an unspent coin already
2167
    // existed and it is an overwrite.
2168
0
    view.AddCoin(out, std::move(undo), !fClean);
2169
2170
0
    return fClean ? DISCONNECT_OK : DISCONNECT_UNCLEAN;
2171
0
}
2172
2173
/** Undo the effects of this block (with given index) on the UTXO set represented by coins.
2174
 *  When FAILED is returned, view is left in an indeterminate state. */
2175
DisconnectResult Chainstate::DisconnectBlock(const CBlock& block, const CBlockIndex* pindex, CCoinsViewCache& view)
2176
0
{
2177
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
2178
0
    bool fClean = true;
2179
2180
0
    CBlockUndo blockUndo;
2181
0
    if (!m_blockman.ReadBlockUndo(blockUndo, *pindex)) {
2182
0
        LogError("DisconnectBlock(): failure reading undo data\n");
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2183
0
        return DISCONNECT_FAILED;
2184
0
    }
2185
2186
0
    if (blockUndo.vtxundo.size() + 1 != block.vtx.size()) {
2187
0
        LogError("DisconnectBlock(): block and undo data inconsistent\n");
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2188
0
        return DISCONNECT_FAILED;
2189
0
    }
2190
2191
    // Ignore blocks that contain transactions which are 'overwritten' by later transactions,
2192
    // unless those are already completely spent.
2193
    // See https://github.com/bitcoin/bitcoin/issues/22596 for additional information.
2194
    // Note: the blocks specified here are different than the ones used in ConnectBlock because DisconnectBlock
2195
    // unwinds the blocks in reverse. As a result, the inconsistency is not discovered until the earlier
2196
    // blocks with the duplicate coinbase transactions are disconnected.
2197
0
    bool fEnforceBIP30 = !((pindex->nHeight==91722 && pindex->GetBlockHash() == uint256{"00000000000271a2dc26e7667f8419f2e15416dc6955e5a6c6cdf3f2574dd08e"}) ||
2198
0
                           (pindex->nHeight==91812 && pindex->GetBlockHash() == uint256{"00000000000af0aed4792b1acee3d966af36cf5def14935db8de83d6f9306f2f"}));
2199
2200
    // undo transactions in reverse order
2201
0
    for (int i = block.vtx.size() - 1; i >= 0; i--) {
2202
0
        const CTransaction &tx = *(block.vtx[i]);
2203
0
        Txid hash = tx.GetHash();
2204
0
        bool is_coinbase = tx.IsCoinBase();
2205
0
        bool is_bip30_exception = (is_coinbase && !fEnforceBIP30);
2206
2207
        // Check that all outputs are available and match the outputs in the block itself
2208
        // exactly.
2209
0
        for (size_t o = 0; o < tx.vout.size(); o++) {
2210
0
            if (!tx.vout[o].scriptPubKey.IsUnspendable()) {
2211
0
                COutPoint out(hash, o);
2212
0
                Coin coin;
2213
0
                bool is_spent = view.SpendCoin(out, &coin);
2214
0
                if (!is_spent || tx.vout[o] != coin.out || pindex->nHeight != coin.nHeight || is_coinbase != coin.fCoinBase) {
2215
0
                    if (!is_bip30_exception) {
2216
0
                        fClean = false; // transaction output mismatch
2217
0
                    }
2218
0
                }
2219
0
            }
2220
0
        }
2221
2222
        // restore inputs
2223
0
        if (i > 0) { // not coinbases
2224
0
            CTxUndo &txundo = blockUndo.vtxundo[i-1];
2225
0
            if (txundo.vprevout.size() != tx.vin.size()) {
2226
0
                LogError("DisconnectBlock(): transaction and undo data inconsistent\n");
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2227
0
                return DISCONNECT_FAILED;
2228
0
            }
2229
0
            for (unsigned int j = tx.vin.size(); j > 0;) {
2230
0
                --j;
2231
0
                const COutPoint& out = tx.vin[j].prevout;
2232
0
                int res = ApplyTxInUndo(std::move(txundo.vprevout[j]), view, out);
2233
0
                if (res == DISCONNECT_FAILED) return DISCONNECT_FAILED;
2234
0
                fClean = fClean && res != DISCONNECT_UNCLEAN;
2235
0
            }
2236
            // At this point, all of txundo.vprevout should have been moved out.
2237
0
        }
2238
0
    }
2239
2240
    // move best block pointer to prevout block
2241
0
    view.SetBestBlock(pindex->pprev->GetBlockHash());
2242
2243
0
    return fClean ? DISCONNECT_OK : DISCONNECT_UNCLEAN;
2244
0
}
2245
2246
script_verify_flags GetBlockScriptFlags(const CBlockIndex& block_index, const ChainstateManager& chainman)
2247
0
{
2248
0
    const Consensus::Params& consensusparams = chainman.GetConsensus();
2249
2250
    // BIP16 didn't become active until Apr 1 2012 (on mainnet, and
2251
    // retroactively applied to testnet)
2252
    // However, only one historical block violated the P2SH rules (on both
2253
    // mainnet and testnet).
2254
    // Similarly, only one historical block violated the TAPROOT rules on
2255
    // mainnet.
2256
    // For simplicity, always leave P2SH+WITNESS+TAPROOT on except for the two
2257
    // violating blocks.
2258
0
    script_verify_flags flags{SCRIPT_VERIFY_P2SH | SCRIPT_VERIFY_WITNESS | SCRIPT_VERIFY_TAPROOT};
2259
0
    const auto it{consensusparams.script_flag_exceptions.find(*Assert(block_index.phashBlock))};
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
2260
0
    if (it != consensusparams.script_flag_exceptions.end()) {
2261
0
        flags = it->second;
2262
0
    }
2263
2264
    // Enforce the DERSIG (BIP66) rule
2265
0
    if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_DERSIG)) {
2266
0
        flags |= SCRIPT_VERIFY_DERSIG;
2267
0
    }
2268
2269
    // Enforce CHECKLOCKTIMEVERIFY (BIP65)
2270
0
    if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_CLTV)) {
2271
0
        flags |= SCRIPT_VERIFY_CHECKLOCKTIMEVERIFY;
2272
0
    }
2273
2274
    // Enforce CHECKSEQUENCEVERIFY (BIP112)
2275
0
    if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_CSV)) {
2276
0
        flags |= SCRIPT_VERIFY_CHECKSEQUENCEVERIFY;
2277
0
    }
2278
2279
    // Enforce BIP147 NULLDUMMY (activated simultaneously with segwit)
2280
0
    if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_SEGWIT)) {
2281
0
        flags |= SCRIPT_VERIFY_NULLDUMMY;
2282
0
    }
2283
2284
0
    return flags;
2285
0
}
2286
2287
2288
/** Apply the effects of this block (with given index) on the UTXO set represented by coins.
2289
 *  Validity checks that depend on the UTXO set are also done; ConnectBlock()
2290
 *  can fail if those validity checks fail (among other reasons). */
2291
bool Chainstate::ConnectBlock(const CBlock& block, BlockValidationState& state, CBlockIndex* pindex,
2292
                               CCoinsViewCache& view, bool fJustCheck)
2293
0
{
2294
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
2295
0
    assert(pindex);
2296
2297
0
    uint256 block_hash{block.GetHash()};
2298
0
    assert(*pindex->phashBlock == block_hash);
2299
2300
0
    const auto time_start{SteadyClock::now()};
2301
0
    const CChainParams& params{m_chainman.GetParams()};
2302
2303
    // Check it again in case a previous version let a bad block in
2304
    // NOTE: We don't currently (re-)invoke ContextualCheckBlock() or
2305
    // ContextualCheckBlockHeader() here. This means that if we add a new
2306
    // consensus rule that is enforced in one of those two functions, then we
2307
    // may have let in a block that violates the rule prior to updating the
2308
    // software, and we would NOT be enforcing the rule here. Fully solving
2309
    // upgrade from one software version to the next after a consensus rule
2310
    // change is potentially tricky and issue-specific (see NeedsRedownload()
2311
    // for one approach that was used for BIP 141 deployment).
2312
    // Also, currently the rule against blocks more than 2 hours in the future
2313
    // is enforced in ContextualCheckBlockHeader(); we wouldn't want to
2314
    // re-enforce that rule here (at least until we make it impossible for
2315
    // the clock to go backward).
2316
0
    if (!CheckBlock(block, state, params.GetConsensus(), !fJustCheck, !fJustCheck)) {
2317
0
        if (state.GetResult() == BlockValidationResult::BLOCK_MUTATED) {
2318
            // We don't write down blocks to disk if they may have been
2319
            // corrupted, so this should be impossible unless we're having hardware
2320
            // problems.
2321
0
            return FatalError(m_chainman.GetNotifications(), state, _("Corrupt block found indicating potential hardware failure."));
2322
0
        }
2323
0
        LogError("%s: Consensus::CheckBlock: %s\n", __func__, state.ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2324
0
        return false;
2325
0
    }
2326
2327
    // verify that the view's current state corresponds to the previous block
2328
0
    uint256 hashPrevBlock = pindex->pprev == nullptr ? uint256() : pindex->pprev->GetBlockHash();
2329
0
    assert(hashPrevBlock == view.GetBestBlock());
2330
2331
0
    m_chainman.num_blocks_total++;
2332
2333
    // Special case for the genesis block, skipping connection of its transactions
2334
    // (its coinbase is unspendable)
2335
0
    if (block_hash == params.GetConsensus().hashGenesisBlock) {
2336
0
        if (!fJustCheck)
2337
0
            view.SetBestBlock(pindex->GetBlockHash());
2338
0
        return true;
2339
0
    }
2340
2341
0
    const char* script_check_reason;
2342
0
    if (m_chainman.AssumedValidBlock().IsNull()) {
2343
0
        script_check_reason = "assumevalid=0 (always verify)";
2344
0
    } else {
2345
0
        constexpr int64_t TWO_WEEKS_IN_SECONDS{60 * 60 * 24 * 7 * 2};
2346
        // We've been configured with the hash of a block which has been externally verified to have a valid history.
2347
        // A suitable default value is included with the software and updated from time to time.  Because validity
2348
        //  relative to a piece of software is an objective fact these defaults can be easily reviewed.
2349
        // This setting doesn't force the selection of any particular chain but makes validating some faster by
2350
        //  effectively caching the result of part of the verification.
2351
0
        BlockMap::const_iterator it{m_blockman.m_block_index.find(m_chainman.AssumedValidBlock())};
2352
0
        if (it == m_blockman.m_block_index.end()) {
2353
0
            script_check_reason = "assumevalid hash not in headers";
2354
0
        } else if (it->second.GetAncestor(pindex->nHeight) != pindex) {
2355
0
            script_check_reason = (pindex->nHeight > it->second.nHeight) ? "block height above assumevalid height" : "block not in assumevalid chain";
2356
0
        } else if (m_chainman.m_best_header->GetAncestor(pindex->nHeight) != pindex) {
2357
0
            script_check_reason = "block not in best header chain";
2358
0
        } else if (m_chainman.m_best_header->nChainWork < m_chainman.MinimumChainWork()) {
2359
0
            script_check_reason = "best header chainwork below minimumchainwork";
2360
0
        } else if (GetBlockProofEquivalentTime(*m_chainman.m_best_header, *pindex, *m_chainman.m_best_header, params.GetConsensus()) <= TWO_WEEKS_IN_SECONDS) {
2361
0
            script_check_reason = "block too recent relative to best header";
2362
0
        } else {
2363
            // This block is a member of the assumed verified chain and an ancestor of the best header.
2364
            // Script verification is skipped when connecting blocks under the
2365
            //  assumevalid block. Assuming the assumevalid block is valid this
2366
            //  is safe because block merkle hashes are still computed and checked,
2367
            // Of course, if an assumed valid block is invalid due to false scriptSigs
2368
            //  this optimization would allow an invalid chain to be accepted.
2369
            // The equivalent time check discourages hash power from extorting the network via DOS attack
2370
            //  into accepting an invalid block through telling users they must manually set assumevalid.
2371
            //  Requiring a software change or burying the invalid block, regardless of the setting, makes
2372
            //  it hard to hide the implication of the demand. This also avoids having release candidates
2373
            //  that are hardly doing any signature verification at all in testing without having to
2374
            //  artificially set the default assumed verified block further back.
2375
            // The test against the minimum chain work prevents the skipping when denied access to any chain at
2376
            //  least as good as the expected chain.
2377
0
            script_check_reason = nullptr;
2378
0
        }
2379
0
    }
2380
2381
0
    const auto time_1{SteadyClock::now()};
2382
0
    m_chainman.time_check += time_1 - time_start;
2383
0
    LogDebug(BCLog::BENCH, "    - Sanity checks: %.2fms [%.2fs (%.2fms/blk)]\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2384
0
             Ticks<MillisecondsDouble>(time_1 - time_start),
2385
0
             Ticks<SecondsDouble>(m_chainman.time_check),
2386
0
             Ticks<MillisecondsDouble>(m_chainman.time_check) / m_chainman.num_blocks_total);
2387
2388
    // Do not allow blocks that contain transactions which 'overwrite' older transactions,
2389
    // unless those are already completely spent.
2390
    // If such overwrites are allowed, coinbases and transactions depending upon those
2391
    // can be duplicated to remove the ability to spend the first instance -- even after
2392
    // being sent to another address.
2393
    // See BIP30, CVE-2012-1909, and https://r6.ca/blog/20120206T005236Z.html for more information.
2394
    // This rule was originally applied to all blocks with a timestamp after March 15, 2012, 0:00 UTC.
2395
    // Now that the whole chain is irreversibly beyond that time it is applied to all blocks except the
2396
    // two in the chain that violate it. This prevents exploiting the issue against nodes during their
2397
    // initial block download.
2398
0
    bool fEnforceBIP30 = !IsBIP30Repeat(*pindex);
2399
2400
    // Once BIP34 activated it was not possible to create new duplicate coinbases and thus other than starting
2401
    // with the 2 existing duplicate coinbase pairs, not possible to create overwriting txs.  But by the
2402
    // time BIP34 activated, in each of the existing pairs the duplicate coinbase had overwritten the first
2403
    // before the first had been spent.  Since those coinbases are sufficiently buried it's no longer possible to create further
2404
    // duplicate transactions descending from the known pairs either.
2405
    // If we're on the known chain at height greater than where BIP34 activated, we can save the db accesses needed for the BIP30 check.
2406
2407
    // BIP34 requires that a block at height X (block X) has its coinbase
2408
    // scriptSig start with a CScriptNum of X (indicated height X).  The above
2409
    // logic of no longer requiring BIP30 once BIP34 activates is flawed in the
2410
    // case that there is a block X before the BIP34 height of 227,931 which has
2411
    // an indicated height Y where Y is greater than X.  The coinbase for block
2412
    // X would also be a valid coinbase for block Y, which could be a BIP30
2413
    // violation.  An exhaustive search of all mainnet coinbases before the
2414
    // BIP34 height which have an indicated height greater than the block height
2415
    // reveals many occurrences. The 3 lowest indicated heights found are
2416
    // 209,921, 490,897, and 1,983,702 and thus coinbases for blocks at these 3
2417
    // heights would be the first opportunity for BIP30 to be violated.
2418
2419
    // The search reveals a great many blocks which have an indicated height
2420
    // greater than 1,983,702, so we simply remove the optimization to skip
2421
    // BIP30 checking for blocks at height 1,983,702 or higher.  Before we reach
2422
    // that block in another 25 years or so, we should take advantage of a
2423
    // future consensus change to do a new and improved version of BIP34 that
2424
    // will actually prevent ever creating any duplicate coinbases in the
2425
    // future.
2426
0
    static constexpr int BIP34_IMPLIES_BIP30_LIMIT = 1983702;
2427
2428
    // There is no potential to create a duplicate coinbase at block 209,921
2429
    // because this is still before the BIP34 height and so explicit BIP30
2430
    // checking is still active.
2431
2432
    // The final case is block 176,684 which has an indicated height of
2433
    // 490,897. Unfortunately, this issue was not discovered until about 2 weeks
2434
    // before block 490,897 so there was not much opportunity to address this
2435
    // case other than to carefully analyze it and determine it would not be a
2436
    // problem. Block 490,897 was, in fact, mined with a different coinbase than
2437
    // block 176,684, but it is important to note that even if it hadn't been or
2438
    // is remined on an alternate fork with a duplicate coinbase, we would still
2439
    // not run into a BIP30 violation.  This is because the coinbase for 176,684
2440
    // is spent in block 185,956 in transaction
2441
    // d4f7fbbf92f4a3014a230b2dc70b8058d02eb36ac06b4a0736d9d60eaa9e8781.  This
2442
    // spending transaction can't be duplicated because it also spends coinbase
2443
    // 0328dd85c331237f18e781d692c92de57649529bd5edf1d01036daea32ffde29.  This
2444
    // coinbase has an indicated height of over 4.2 billion, and wouldn't be
2445
    // duplicatable until that height, and it's currently impossible to create a
2446
    // chain that long. Nevertheless we may wish to consider a future soft fork
2447
    // which retroactively prevents block 490,897 from creating a duplicate
2448
    // coinbase. The two historical BIP30 violations often provide a confusing
2449
    // edge case when manipulating the UTXO and it would be simpler not to have
2450
    // another edge case to deal with.
2451
2452
    // testnet3 has no blocks before the BIP34 height with indicated heights
2453
    // post BIP34 before approximately height 486,000,000. After block
2454
    // 1,983,702 testnet3 starts doing unnecessary BIP30 checking again.
2455
0
    assert(pindex->pprev);
2456
0
    CBlockIndex* pindexBIP34height = pindex->pprev->GetAncestor(params.GetConsensus().BIP34Height);
2457
    //Only continue to enforce if we're below BIP34 activation height or the block hash at that height doesn't correspond.
2458
0
    fEnforceBIP30 = fEnforceBIP30 && (!pindexBIP34height || !(pindexBIP34height->GetBlockHash() == params.GetConsensus().BIP34Hash));
2459
2460
    // TODO: Remove BIP30 checking from block height 1,983,702 on, once we have a
2461
    // consensus change that ensures coinbases at those heights cannot
2462
    // duplicate earlier coinbases.
2463
0
    if (fEnforceBIP30 || pindex->nHeight >= BIP34_IMPLIES_BIP30_LIMIT) {
2464
0
        for (const auto& tx : block.vtx) {
2465
0
            for (size_t o = 0; o < tx->vout.size(); o++) {
2466
0
                if (view.HaveCoin(COutPoint(tx->GetHash(), o))) {
2467
0
                    state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-BIP30",
2468
0
                                  "tried to overwrite transaction");
2469
0
                }
2470
0
            }
2471
0
        }
2472
0
    }
2473
2474
    // Enforce BIP68 (sequence locks)
2475
0
    int nLockTimeFlags = 0;
2476
0
    if (DeploymentActiveAt(*pindex, m_chainman, Consensus::DEPLOYMENT_CSV)) {
2477
0
        nLockTimeFlags |= LOCKTIME_VERIFY_SEQUENCE;
2478
0
    }
2479
2480
    // Get the script flags for this block
2481
0
    script_verify_flags flags{GetBlockScriptFlags(*pindex, m_chainman)};
2482
2483
0
    const auto time_2{SteadyClock::now()};
2484
0
    m_chainman.time_forks += time_2 - time_1;
2485
0
    LogDebug(BCLog::BENCH, "    - Fork checks: %.2fms [%.2fs (%.2fms/blk)]\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2486
0
             Ticks<MillisecondsDouble>(time_2 - time_1),
2487
0
             Ticks<SecondsDouble>(m_chainman.time_forks),
2488
0
             Ticks<MillisecondsDouble>(m_chainman.time_forks) / m_chainman.num_blocks_total);
2489
2490
0
    const bool fScriptChecks{!!script_check_reason};
2491
0
    const kernel::ChainstateRole role{GetRole()};
2492
0
    if (script_check_reason != m_last_script_check_reason_logged && role.validated && !role.historical) {
2493
0
        if (fScriptChecks) {
2494
0
            LogInfo("Enabling script verification at block #%d (%s): %s.",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2495
0
                    pindex->nHeight, block_hash.ToString(), script_check_reason);
2496
0
        } else {
2497
0
            LogInfo("Disabling script verification at block #%d (%s).",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2498
0
                    pindex->nHeight, block_hash.ToString());
2499
0
        }
2500
0
        m_last_script_check_reason_logged = script_check_reason;
2501
0
    }
2502
2503
0
    CBlockUndo blockundo;
2504
2505
    // Precomputed transaction data pointers must not be invalidated
2506
    // until after `control` has run the script checks (potentially
2507
    // in multiple threads). Preallocate the vector size so a new allocation
2508
    // doesn't invalidate pointers into the vector, and keep txsdata in scope
2509
    // for as long as `control`.
2510
0
    std::optional<CCheckQueueControl<CScriptCheck>> control;
2511
0
    if (auto& queue = m_chainman.GetCheckQueue(); queue.HasThreads() && fScriptChecks) control.emplace(queue);
2512
2513
0
    std::vector<PrecomputedTransactionData> txsdata(block.vtx.size());
2514
2515
0
    std::vector<int> prevheights;
2516
0
    CAmount nFees = 0;
2517
0
    int nInputs = 0;
2518
0
    int64_t nSigOpsCost = 0;
2519
0
    blockundo.vtxundo.reserve(block.vtx.size() - 1);
2520
0
    for (unsigned int i = 0; i < block.vtx.size(); i++)
2521
0
    {
2522
0
        if (!state.IsValid()) break;
2523
0
        const CTransaction &tx = *(block.vtx[i]);
2524
2525
0
        nInputs += tx.vin.size();
2526
2527
0
        if (!tx.IsCoinBase())
2528
0
        {
2529
0
            CAmount txfee = 0;
2530
0
            TxValidationState tx_state;
2531
0
            if (!Consensus::CheckTxInputs(tx, tx_state, view, pindex->nHeight, txfee)) {
2532
                // Any transaction validation failure in ConnectBlock is a block consensus failure
2533
0
                state.Invalid(BlockValidationResult::BLOCK_CONSENSUS,
2534
0
                              tx_state.GetRejectReason(),
2535
0
                              tx_state.GetDebugMessage() + " in transaction " + tx.GetHash().ToString());
2536
0
                break;
2537
0
            }
2538
0
            nFees += txfee;
2539
0
            if (!MoneyRange(nFees)) {
2540
0
                state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-accumulated-fee-outofrange",
2541
0
                              "accumulated fee in the block out of range");
2542
0
                break;
2543
0
            }
2544
2545
            // Check that transaction is BIP68 final
2546
            // BIP68 lock checks (as opposed to nLockTime checks) must
2547
            // be in ConnectBlock because they require the UTXO set
2548
0
            prevheights.resize(tx.vin.size());
2549
0
            for (size_t j = 0; j < tx.vin.size(); j++) {
2550
0
                prevheights[j] = view.AccessCoin(tx.vin[j].prevout).nHeight;
2551
0
            }
2552
2553
0
            if (!SequenceLocks(tx, nLockTimeFlags, prevheights, *pindex)) {
2554
0
                state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-nonfinal",
2555
0
                              "contains a non-BIP68-final transaction " + tx.GetHash().ToString());
2556
0
                break;
2557
0
            }
2558
0
        }
2559
2560
        // GetTransactionSigOpCost counts 3 types of sigops:
2561
        // * legacy (always)
2562
        // * p2sh (when P2SH enabled in flags and excludes coinbase)
2563
        // * witness (when witness enabled in flags and excludes coinbase)
2564
0
        nSigOpsCost += GetTransactionSigOpCost(tx, view, flags);
2565
0
        if (nSigOpsCost > MAX_BLOCK_SIGOPS_COST) {
2566
0
            state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-sigops", "too many sigops");
2567
0
            break;
2568
0
        }
2569
2570
0
        if (!tx.IsCoinBase() && fScriptChecks)
2571
0
        {
2572
0
            bool fCacheResults = fJustCheck; /* Don't cache results if we're actually connecting blocks (still consult the cache, though) */
2573
0
            bool tx_ok;
2574
0
            TxValidationState tx_state;
2575
            // If CheckInputScripts is called with a pointer to a checks vector, the resulting checks are appended to it. In that case
2576
            // they need to be added to control which runs them asynchronously. Otherwise, CheckInputScripts runs the checks before returning.
2577
0
            if (control) {
2578
0
                std::vector<CScriptCheck> vChecks;
2579
0
                tx_ok = CheckInputScripts(tx, tx_state, view, flags, fCacheResults, fCacheResults, txsdata[i], m_chainman.m_validation_cache, &vChecks);
2580
0
                if (tx_ok) control->Add(std::move(vChecks));
2581
0
            } else {
2582
0
                tx_ok = CheckInputScripts(tx, tx_state, view, flags, fCacheResults, fCacheResults, txsdata[i], m_chainman.m_validation_cache);
2583
0
            }
2584
0
            if (!tx_ok) {
2585
                // Any transaction validation failure in ConnectBlock is a block consensus failure
2586
0
                state.Invalid(BlockValidationResult::BLOCK_CONSENSUS,
2587
0
                              tx_state.GetRejectReason(), tx_state.GetDebugMessage());
2588
0
                break;
2589
0
            }
2590
0
        }
2591
2592
0
        CTxUndo undoDummy;
2593
0
        if (i > 0) {
2594
0
            blockundo.vtxundo.emplace_back();
2595
0
        }
2596
0
        UpdateCoins(tx, view, i == 0 ? undoDummy : blockundo.vtxundo.back(), pindex->nHeight);
2597
0
    }
2598
0
    const auto time_3{SteadyClock::now()};
2599
0
    m_chainman.time_connect += time_3 - time_2;
2600
0
    LogDebug(BCLog::BENCH, "      - Connect %u transactions: %.2fms (%.3fms/tx, %.3fms/txin) [%.2fs (%.2fms/blk)]\n", (unsigned)block.vtx.size(),
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2601
0
             Ticks<MillisecondsDouble>(time_3 - time_2), Ticks<MillisecondsDouble>(time_3 - time_2) / block.vtx.size(),
2602
0
             nInputs <= 1 ? 0 : Ticks<MillisecondsDouble>(time_3 - time_2) / (nInputs - 1),
2603
0
             Ticks<SecondsDouble>(m_chainman.time_connect),
2604
0
             Ticks<MillisecondsDouble>(m_chainman.time_connect) / m_chainman.num_blocks_total);
2605
2606
0
    CAmount blockReward = nFees + GetBlockSubsidy(pindex->nHeight, params.GetConsensus());
2607
0
    if (block.vtx[0]->GetValueOut() > blockReward && state.IsValid()) {
2608
0
        state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-amount",
2609
0
                      strprintf("coinbase pays too much (actual=%d vs limit=%d)", block.vtx[0]->GetValueOut(), blockReward));
Line
Count
Source
1172
0
#define strprintf tfm::format
2610
0
    }
2611
0
    if (control) {
2612
0
        auto parallel_result = control->Complete();
2613
0
        if (parallel_result.has_value() && state.IsValid()) {
2614
0
            state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, strprintf("block-script-verify-flag-failed (%s)", ScriptErrorString(parallel_result->first)), parallel_result->second);
Line
Count
Source
1172
0
#define strprintf tfm::format
2615
0
        }
2616
0
    }
2617
0
    if (!state.IsValid()) {
2618
0
        LogInfo("Block validation error: %s", state.ToString());
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2619
0
        return false;
2620
0
    }
2621
0
    const auto time_4{SteadyClock::now()};
2622
0
    m_chainman.time_verify += time_4 - time_2;
2623
0
    LogDebug(BCLog::BENCH, "    - Verify %u txins: %.2fms (%.3fms/txin) [%.2fs (%.2fms/blk)]\n", nInputs - 1,
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2624
0
             Ticks<MillisecondsDouble>(time_4 - time_2),
2625
0
             nInputs <= 1 ? 0 : Ticks<MillisecondsDouble>(time_4 - time_2) / (nInputs - 1),
2626
0
             Ticks<SecondsDouble>(m_chainman.time_verify),
2627
0
             Ticks<MillisecondsDouble>(m_chainman.time_verify) / m_chainman.num_blocks_total);
2628
2629
0
    if (fJustCheck) {
2630
0
        return true;
2631
0
    }
2632
2633
0
    if (!m_blockman.WriteBlockUndo(blockundo, state, *pindex)) {
2634
0
        return false;
2635
0
    }
2636
2637
0
    const auto time_5{SteadyClock::now()};
2638
0
    m_chainman.time_undo += time_5 - time_4;
2639
0
    LogDebug(BCLog::BENCH, "    - Write undo data: %.2fms [%.2fs (%.2fms/blk)]\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2640
0
             Ticks<MillisecondsDouble>(time_5 - time_4),
2641
0
             Ticks<SecondsDouble>(m_chainman.time_undo),
2642
0
             Ticks<MillisecondsDouble>(m_chainman.time_undo) / m_chainman.num_blocks_total);
2643
2644
0
    if (!pindex->IsValid(BLOCK_VALID_SCRIPTS)) {
2645
0
        pindex->RaiseValidity(BLOCK_VALID_SCRIPTS);
2646
0
        m_blockman.m_dirty_blockindex.insert(pindex);
2647
0
    }
2648
2649
    // add this block to the view's block chain
2650
0
    view.SetBestBlock(pindex->GetBlockHash());
2651
2652
0
    const auto time_6{SteadyClock::now()};
2653
0
    m_chainman.time_index += time_6 - time_5;
2654
0
    LogDebug(BCLog::BENCH, "    - Index writing: %.2fms [%.2fs (%.2fms/blk)]\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2655
0
             Ticks<MillisecondsDouble>(time_6 - time_5),
2656
0
             Ticks<SecondsDouble>(m_chainman.time_index),
2657
0
             Ticks<MillisecondsDouble>(m_chainman.time_index) / m_chainman.num_blocks_total);
2658
2659
0
    TRACEPOINT(validation, block_connected,
2660
0
        block_hash.data(),
2661
0
        pindex->nHeight,
2662
0
        block.vtx.size(),
2663
0
        nInputs,
2664
0
        nSigOpsCost,
2665
0
        Ticks<std::chrono::nanoseconds>(time_5 - time_start)
2666
0
    );
2667
2668
0
    return true;
2669
0
}
2670
2671
CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState()
2672
0
{
2673
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
2674
0
    return this->GetCoinsCacheSizeState(
2675
0
        m_coinstip_cache_size_bytes,
2676
0
        m_mempool ? m_mempool->m_opts.max_size_bytes : 0);
2677
0
}
2678
2679
CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState(
2680
    size_t max_coins_cache_size_bytes,
2681
    size_t max_mempool_size_bytes)
2682
0
{
2683
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
2684
0
    const int64_t nMempoolUsage = m_mempool ? m_mempool->DynamicMemoryUsage() : 0;
2685
0
    int64_t cacheSize = CoinsTip().DynamicMemoryUsage();
2686
0
    int64_t nTotalSpace =
2687
0
        max_coins_cache_size_bytes + std::max<int64_t>(int64_t(max_mempool_size_bytes) - nMempoolUsage, 0);
2688
2689
0
    if (cacheSize > nTotalSpace) {
2690
0
        LogInfo("Cache size (%s) exceeds total space (%s)\n", cacheSize, nTotalSpace);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2691
0
        return CoinsCacheSizeState::CRITICAL;
2692
0
    } else if (cacheSize > LargeCoinsCacheThreshold(nTotalSpace)) {
2693
0
        return CoinsCacheSizeState::LARGE;
2694
0
    }
2695
0
    return CoinsCacheSizeState::OK;
2696
0
}
2697
2698
bool Chainstate::FlushStateToDisk(
2699
    BlockValidationState &state,
2700
    FlushStateMode mode,
2701
    int nManualPruneHeight)
2702
0
{
2703
0
    LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
2704
0
    assert(this->CanFlushToDisk());
2705
0
    std::set<int> setFilesToPrune;
2706
0
    bool full_flush_completed = false;
2707
2708
0
    [[maybe_unused]] const size_t coins_count{CoinsTip().GetCacheSize()};
2709
0
    [[maybe_unused]] const size_t coins_mem_usage{CoinsTip().DynamicMemoryUsage()};
2710
2711
0
    try {
2712
0
    {
2713
0
        bool fFlushForPrune = false;
2714
2715
0
        CoinsCacheSizeState cache_state = GetCoinsCacheSizeState();
2716
0
        LOCK(m_blockman.cs_LastBlockFile);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
2717
0
        if (m_blockman.IsPruneMode() && (m_blockman.m_check_for_pruning || nManualPruneHeight > 0) && m_chainman.m_blockman.m_blockfiles_indexed) {
2718
            // make sure we don't prune above any of the prune locks bestblocks
2719
            // pruning is height-based
2720
0
            int last_prune{m_chain.Height()}; // last height we can prune
2721
0
            std::optional<std::string> limiting_lock; // prune lock that actually was the limiting factor, only used for logging
2722
2723
0
            for (const auto& prune_lock : m_blockman.m_prune_locks) {
2724
0
                if (prune_lock.second.height_first == std::numeric_limits<int>::max()) continue;
2725
                // Remove the buffer and one additional block here to get actual height that is outside of the buffer
2726
0
                const int lock_height{prune_lock.second.height_first - PRUNE_LOCK_BUFFER - 1};
2727
0
                last_prune = std::max(1, std::min(last_prune, lock_height));
2728
0
                if (last_prune == lock_height) {
2729
0
                    limiting_lock = prune_lock.first;
2730
0
                }
2731
0
            }
2732
2733
0
            if (limiting_lock) {
2734
0
                LogDebug(BCLog::PRUNE, "%s limited pruning to height %d\n", limiting_lock.value(), last_prune);
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2735
0
            }
2736
2737
0
            if (nManualPruneHeight > 0) {
2738
0
                LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune (manual)", BCLog::BENCH);
Line
Count
Source
104
0
    BCLog::Timer<std::chrono::milliseconds> UNIQUE_NAME(logging_timer)(__func__, end_msg, log_category)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
2739
2740
0
                m_blockman.FindFilesToPruneManual(
2741
0
                    setFilesToPrune,
2742
0
                    std::min(last_prune, nManualPruneHeight),
2743
0
                    *this);
2744
0
            } else {
2745
0
                LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune", BCLog::BENCH);
Line
Count
Source
104
0
    BCLog::Timer<std::chrono::milliseconds> UNIQUE_NAME(logging_timer)(__func__, end_msg, log_category)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
2746
2747
0
                m_blockman.FindFilesToPrune(setFilesToPrune, last_prune, *this, m_chainman);
2748
0
                m_blockman.m_check_for_pruning = false;
2749
0
            }
2750
0
            if (!setFilesToPrune.empty()) {
2751
0
                fFlushForPrune = true;
2752
0
                if (!m_blockman.m_have_pruned) {
2753
0
                    m_blockman.m_block_tree_db->WriteFlag("prunedblockfiles", true);
2754
0
                    m_blockman.m_have_pruned = true;
2755
0
                }
2756
0
            }
2757
0
        }
2758
0
        const auto nNow{NodeClock::now()};
2759
        // The cache is large and we're within 10% and 10 MiB of the limit, but we have time now (not in the middle of a block processing).
2760
0
        bool fCacheLarge = mode == FlushStateMode::PERIODIC && cache_state >= CoinsCacheSizeState::LARGE;
2761
        // The cache is over the limit, we have to write now.
2762
0
        bool fCacheCritical = mode == FlushStateMode::IF_NEEDED && cache_state >= CoinsCacheSizeState::CRITICAL;
2763
        // It's been a while since we wrote the block index and chain state to disk. Do this frequently, so we don't need to redownload or reindex after a crash.
2764
0
        bool fPeriodicWrite = mode == FlushStateMode::PERIODIC && nNow >= m_next_write;
2765
0
        const auto empty_cache{(mode == FlushStateMode::FORCE_FLUSH) || fCacheLarge || fCacheCritical};
2766
        // Combine all conditions that result in a write to disk.
2767
0
        bool should_write = (mode == FlushStateMode::FORCE_SYNC) || empty_cache || fPeriodicWrite || fFlushForPrune;
2768
        // Write blocks, block index and best chain related state to disk.
2769
0
        if (should_write) {
2770
0
            LogDebug(BCLog::COINDB, "Writing chainstate to disk: flush mode=%s, prune=%d, large=%d, critical=%d, periodic=%d",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2771
0
                     FlushStateModeNames[size_t(mode)], fFlushForPrune, fCacheLarge, fCacheCritical, fPeriodicWrite);
2772
2773
            // Ensure we can write block index
2774
0
            if (!CheckDiskSpace(m_blockman.m_opts.blocks_dir)) {
2775
0
                return FatalError(m_chainman.GetNotifications(), state, _("Disk space is too low!"));
2776
0
            }
2777
0
            {
2778
0
                LOG_TIME_MILLIS_WITH_CATEGORY("write block and undo data to disk", BCLog::BENCH);
Line
Count
Source
104
0
    BCLog::Timer<std::chrono::milliseconds> UNIQUE_NAME(logging_timer)(__func__, end_msg, log_category)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
2779
2780
                // First make sure all block and undo data is flushed to disk.
2781
                // TODO: Handle return error, or add detailed comment why it is
2782
                // safe to not return an error upon failure.
2783
0
                if (!m_blockman.FlushChainstateBlockFile(m_chain.Height())) {
2784
0
                    LogWarning("%s: Failed to flush block file.\n", __func__);
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2785
0
                }
2786
0
            }
2787
2788
            // Then update all block file information (which may refer to block and undo files).
2789
0
            {
2790
0
                LOG_TIME_MILLIS_WITH_CATEGORY("write block index to disk", BCLog::BENCH);
Line
Count
Source
104
0
    BCLog::Timer<std::chrono::milliseconds> UNIQUE_NAME(logging_timer)(__func__, end_msg, log_category)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
2791
2792
0
                m_blockman.WriteBlockIndexDB();
2793
0
            }
2794
            // Finally remove any pruned files
2795
0
            if (fFlushForPrune) {
2796
0
                LOG_TIME_MILLIS_WITH_CATEGORY("unlink pruned files", BCLog::BENCH);
Line
Count
Source
104
0
    BCLog::Timer<std::chrono::milliseconds> UNIQUE_NAME(logging_timer)(__func__, end_msg, log_category)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
2797
2798
0
                m_blockman.UnlinkPrunedFiles(setFilesToPrune);
2799
0
            }
2800
2801
0
            if (!CoinsTip().GetBestBlock().IsNull()) {
2802
                // Typical Coin structures on disk are around 48 bytes in size.
2803
                // Pushing a new one to the database can cause it to be written
2804
                // twice (once in the log, and once in the tables). This is already
2805
                // an overestimation, as most will delete an existing entry or
2806
                // overwrite one. Still, use a conservative safety factor of 2.
2807
0
                if (!CheckDiskSpace(m_chainman.m_options.datadir, 48 * 2 * 2 * CoinsTip().GetDirtyCount())) {
2808
0
                    return FatalError(m_chainman.GetNotifications(), state, _("Disk space is too low!"));
2809
0
                }
2810
                // Flush the chainstate (which may refer to block index entries).
2811
0
                empty_cache ? CoinsTip().Flush() : CoinsTip().Sync();
2812
0
                full_flush_completed = true;
2813
0
                TRACEPOINT(utxocache, flush,
2814
0
                    int64_t{Ticks<std::chrono::microseconds>(NodeClock::now() - nNow)},
2815
0
                    (uint32_t)mode,
2816
0
                    (uint64_t)coins_count,
2817
0
                    (uint64_t)coins_mem_usage,
2818
0
                    (bool)fFlushForPrune);
2819
0
            }
2820
0
        }
2821
2822
0
        if (should_write || m_next_write == NodeClock::time_point::max()) {
2823
0
            constexpr auto range{DATABASE_WRITE_INTERVAL_MAX - DATABASE_WRITE_INTERVAL_MIN};
2824
0
            m_next_write = FastRandomContext().rand_uniform_delay(NodeClock::now() + DATABASE_WRITE_INTERVAL_MIN, range);
2825
0
        }
2826
0
    }
2827
0
    if (full_flush_completed && m_chainman.m_options.signals) {
2828
        // Update best block in wallet (so we can detect restored wallets).
2829
0
        m_chainman.m_options.signals->ChainStateFlushed(this->GetRole(), GetLocator(m_chain.Tip()));
2830
0
    }
2831
0
    } catch (const std::runtime_error& e) {
2832
0
        return FatalError(m_chainman.GetNotifications(), state, strprintf(_("System error while flushing: %s"), e.what()));
Line
Count
Source
1172
0
#define strprintf tfm::format
2833
0
    }
2834
0
    return true;
2835
0
}
2836
2837
void Chainstate::ForceFlushStateToDisk(bool wipe_cache)
2838
0
{
2839
0
    BlockValidationState state;
2840
0
    if (!this->FlushStateToDisk(state, wipe_cache ? FlushStateMode::FORCE_FLUSH : FlushStateMode::FORCE_SYNC)) {
2841
0
        LogWarning("Failed to force flush state (%s)", state.ToString());
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2842
0
    }
2843
0
}
2844
2845
void Chainstate::PruneAndFlush()
2846
0
{
2847
0
    BlockValidationState state;
2848
0
    m_blockman.m_check_for_pruning = true;
2849
0
    if (!this->FlushStateToDisk(state, FlushStateMode::NONE)) {
2850
0
        LogWarning("Failed to flush state (%s)", state.ToString());
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2851
0
    }
2852
0
}
2853
2854
static void UpdateTipLog(
2855
    const ChainstateManager& chainman,
2856
    const CCoinsViewCache& coins_tip,
2857
    const CBlockIndex* tip,
2858
    const std::string& func_name,
2859
    const std::string& prefix,
2860
    const std::string& warning_messages,
2861
    const bool background_validation) EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
2862
0
{
2863
2864
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
2865
2866
    // Disable rate limiting in LogPrintLevel_ so this source location may log during IBD.
2867
0
    LogPrintLevel_(BCLog::LogFlags::ALL, util::log::Level::Info, /*should_ratelimit=*/false, "%s%s: new best=%s height=%d version=0x%08x log2_work=%f tx=%lu date='%s' progress=%f cache=%.1fMiB(%utxo)%s\n",
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2868
0
                   prefix, func_name,
2869
0
                   tip->GetBlockHash().ToString(), tip->nHeight, tip->nVersion,
2870
0
                   log(tip->nChainWork.getdouble()) / log(2.0), tip->m_chain_tx_count,
2871
0
                   FormatISO8601DateTime(tip->GetBlockTime()),
2872
0
                   background_validation ? chainman.GetBackgroundVerificationProgress(*tip) : chainman.GuessVerificationProgress(tip),
2873
0
                   coins_tip.DynamicMemoryUsage() * (1.0 / (1 << 20)),
2874
0
                   coins_tip.GetCacheSize(),
2875
0
                   !warning_messages.empty() ? strprintf(" warning='%s'", warning_messages) : "");
2876
0
}
2877
2878
void Chainstate::UpdateTip(const CBlockIndex* pindexNew)
2879
0
{
2880
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
2881
0
    const auto& coins_tip = this->CoinsTip();
2882
2883
    // The remainder of the function isn't relevant if we are not acting on
2884
    // the active chainstate, so return if need be.
2885
0
    if (this != &m_chainman.ActiveChainstate()) {
2886
        // Only log every so often so that we don't bury log messages at the tip.
2887
0
        constexpr int BACKGROUND_LOG_INTERVAL = 2000;
2888
0
        if (pindexNew->nHeight % BACKGROUND_LOG_INTERVAL == 0) {
2889
0
            UpdateTipLog(m_chainman, coins_tip, pindexNew, __func__, "[background validation] ", "", /*background_validation=*/true);
2890
0
        }
2891
0
        return;
2892
0
    }
2893
2894
    // New best block
2895
0
    if (m_mempool) {
2896
0
        m_mempool->AddTransactionsUpdated(1);
2897
0
    }
2898
2899
0
    std::vector<bilingual_str> warning_messages;
2900
0
    if (!m_chainman.IsInitialBlockDownload()) {
2901
0
        auto bits = m_chainman.m_versionbitscache.CheckUnknownActivations(pindexNew, m_chainman.GetParams());
2902
0
        for (auto [bit, active] : bits) {
2903
0
            const bilingual_str warning = strprintf(_("Unknown new rules activated (versionbit %i)"), bit);
Line
Count
Source
1172
0
#define strprintf tfm::format
2904
0
            if (active) {
2905
0
                m_chainman.GetNotifications().warningSet(kernel::Warning::UNKNOWN_NEW_RULES_ACTIVATED, warning);
2906
0
            } else {
2907
0
                warning_messages.push_back(warning);
2908
0
            }
2909
0
        }
2910
0
    }
2911
0
    UpdateTipLog(m_chainman, coins_tip, pindexNew, __func__, "",
2912
0
                 util::Join(warning_messages, Untranslated(", ")).original, /*background_validation=*/false);
2913
0
}
2914
2915
/** Disconnect m_chain's tip.
2916
  * After calling, the mempool will be in an inconsistent state, with
2917
  * transactions from disconnected blocks being added to disconnectpool.  You
2918
  * should make the mempool consistent again by calling MaybeUpdateMempoolForReorg.
2919
  * with cs_main held.
2920
  *
2921
  * If disconnectpool is nullptr, then no disconnected transactions are added to
2922
  * disconnectpool (note that the caller is responsible for mempool consistency
2923
  * in any case).
2924
  */
2925
bool Chainstate::DisconnectTip(BlockValidationState& state, DisconnectedBlockTransactions* disconnectpool)
2926
0
{
2927
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
2928
0
    if (m_mempool) AssertLockHeld(m_mempool->cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
2929
2930
0
    CBlockIndex *pindexDelete = m_chain.Tip();
2931
0
    assert(pindexDelete);
2932
0
    assert(pindexDelete->pprev);
2933
    // Read block from disk.
2934
0
    std::shared_ptr<CBlock> pblock = std::make_shared<CBlock>();
2935
0
    CBlock& block = *pblock;
2936
0
    if (!m_blockman.ReadBlock(block, *pindexDelete)) {
2937
0
        LogError("DisconnectTip(): Failed to read block\n");
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2938
0
        return false;
2939
0
    }
2940
    // Apply the block atomically to the chain state.
2941
0
    const auto time_start{SteadyClock::now()};
2942
0
    {
2943
0
        CCoinsViewCache view(&CoinsTip());
2944
0
        assert(view.GetBestBlock() == pindexDelete->GetBlockHash());
2945
0
        if (DisconnectBlock(block, pindexDelete, view) != DISCONNECT_OK) {
2946
0
            LogError("DisconnectTip(): DisconnectBlock %s failed\n", pindexDelete->GetBlockHash().ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
2947
0
            return false;
2948
0
        }
2949
0
        view.Flush(/*reallocate_cache=*/false); // local CCoinsViewCache goes out of scope
2950
0
    }
2951
0
    LogDebug(BCLog::BENCH, "- Disconnect block: %.2fms\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2952
0
             Ticks<MillisecondsDouble>(SteadyClock::now() - time_start));
2953
2954
0
    {
2955
        // Prune locks that began at or after the tip should be moved backward so they get a chance to reorg
2956
0
        const int max_height_first{pindexDelete->nHeight - 1};
2957
0
        for (auto& prune_lock : m_blockman.m_prune_locks) {
2958
0
            if (prune_lock.second.height_first <= max_height_first) continue;
2959
2960
0
            prune_lock.second.height_first = max_height_first;
2961
0
            LogDebug(BCLog::PRUNE, "%s prune lock moved back to %d\n", prune_lock.first, max_height_first);
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
2962
0
        }
2963
0
    }
2964
2965
    // Write the chain state to disk, if necessary.
2966
0
    if (!FlushStateToDisk(state, FlushStateMode::IF_NEEDED)) {
2967
0
        return false;
2968
0
    }
2969
2970
0
    if (disconnectpool && m_mempool) {
2971
        // Save transactions to re-add to mempool at end of reorg. If any entries are evicted for
2972
        // exceeding memory limits, remove them and their descendants from the mempool.
2973
0
        for (auto&& evicted_tx : disconnectpool->AddTransactionsFromBlock(block.vtx)) {
2974
0
            m_mempool->removeRecursive(*evicted_tx, MemPoolRemovalReason::REORG);
2975
0
        }
2976
0
    }
2977
2978
0
    m_chain.SetTip(*pindexDelete->pprev);
2979
0
    m_chainman.UpdateIBDStatus();
2980
2981
0
    UpdateTip(pindexDelete->pprev);
2982
    // Let wallets know transactions went from 1-confirmed to
2983
    // 0-confirmed or conflicted:
2984
0
    if (m_chainman.m_options.signals) {
2985
0
        m_chainman.m_options.signals->BlockDisconnected(std::move(pblock), pindexDelete);
2986
0
    }
2987
0
    return true;
2988
0
}
2989
2990
struct ConnectedBlock {
2991
    const CBlockIndex* pindex;
2992
    std::shared_ptr<const CBlock> pblock;
2993
};
2994
2995
/**
2996
 * Connect a new block to m_chain. block_to_connect is either nullptr or a pointer to a CBlock
2997
 * corresponding to pindexNew, to bypass loading it again from disk.
2998
 *
2999
 * The block is added to connected_blocks if connection succeeds.
3000
 */
3001
bool Chainstate::ConnectTip(
3002
    BlockValidationState& state,
3003
    CBlockIndex* pindexNew,
3004
    std::shared_ptr<const CBlock> block_to_connect,
3005
    std::vector<ConnectedBlock>& connected_blocks,
3006
    DisconnectedBlockTransactions& disconnectpool)
3007
0
{
3008
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3009
0
    if (m_mempool) AssertLockHeld(m_mempool->cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3010
3011
0
    assert(pindexNew->pprev == m_chain.Tip());
3012
    // Read block from disk.
3013
0
    const auto time_1{SteadyClock::now()};
3014
0
    if (!block_to_connect) {
3015
0
        std::shared_ptr<CBlock> pblockNew = std::make_shared<CBlock>();
3016
0
        if (!m_blockman.ReadBlock(*pblockNew, *pindexNew)) {
3017
0
            return FatalError(m_chainman.GetNotifications(), state, _("Failed to read block."));
3018
0
        }
3019
0
        block_to_connect = std::move(pblockNew);
3020
0
    } else {
3021
0
        LogDebug(BCLog::BENCH, "  - Using cached block\n");
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
3022
0
    }
3023
    // Apply the block atomically to the chain state.
3024
0
    const auto time_2{SteadyClock::now()};
3025
0
    SteadyClock::time_point time_3;
3026
    // When adding aggregate statistics in the future, keep in mind that
3027
    // num_blocks_total may be zero until the ConnectBlock() call below.
3028
0
    LogDebug(BCLog::BENCH, "  - Load block from disk: %.2fms\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
3029
0
             Ticks<MillisecondsDouble>(time_2 - time_1));
3030
0
    {
3031
0
        CCoinsViewCache& view{*m_coins_views->m_connect_block_view};
3032
0
        const auto reset_guard{view.CreateResetGuard()};
3033
0
        bool rv = ConnectBlock(*block_to_connect, state, pindexNew, view);
3034
0
        if (m_chainman.m_options.signals) {
3035
0
            m_chainman.m_options.signals->BlockChecked(block_to_connect, state);
3036
0
        }
3037
0
        if (!rv) {
3038
0
            if (state.IsInvalid())
3039
0
                InvalidBlockFound(pindexNew, state);
3040
0
            LogError("%s: ConnectBlock %s failed, %s\n", __func__, pindexNew->GetBlockHash().ToString(), state.ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
3041
0
            return false;
3042
0
        }
3043
0
        time_3 = SteadyClock::now();
3044
0
        m_chainman.time_connect_total += time_3 - time_2;
3045
0
        assert(m_chainman.num_blocks_total > 0);
3046
0
        LogDebug(BCLog::BENCH, "  - Connect total: %.2fms [%.2fs (%.2fms/blk)]\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
3047
0
                 Ticks<MillisecondsDouble>(time_3 - time_2),
3048
0
                 Ticks<SecondsDouble>(m_chainman.time_connect_total),
3049
0
                 Ticks<MillisecondsDouble>(m_chainman.time_connect_total) / m_chainman.num_blocks_total);
3050
0
        view.Flush(/*reallocate_cache=*/false); // No need to reallocate since it only has capacity for 1 block
3051
0
    }
3052
0
    const auto time_4{SteadyClock::now()};
3053
0
    m_chainman.time_flush += time_4 - time_3;
3054
0
    LogDebug(BCLog::BENCH, "  - Flush: %.2fms [%.2fs (%.2fms/blk)]\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
3055
0
             Ticks<MillisecondsDouble>(time_4 - time_3),
3056
0
             Ticks<SecondsDouble>(m_chainman.time_flush),
3057
0
             Ticks<MillisecondsDouble>(m_chainman.time_flush) / m_chainman.num_blocks_total);
3058
    // Write the chain state to disk, if necessary.
3059
0
    if (!FlushStateToDisk(state, FlushStateMode::IF_NEEDED)) {
3060
0
        return false;
3061
0
    }
3062
0
    const auto time_5{SteadyClock::now()};
3063
0
    m_chainman.time_chainstate += time_5 - time_4;
3064
0
    LogDebug(BCLog::BENCH, "  - Writing chainstate: %.2fms [%.2fs (%.2fms/blk)]\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
3065
0
             Ticks<MillisecondsDouble>(time_5 - time_4),
3066
0
             Ticks<SecondsDouble>(m_chainman.time_chainstate),
3067
0
             Ticks<MillisecondsDouble>(m_chainman.time_chainstate) / m_chainman.num_blocks_total);
3068
    // Remove conflicting transactions from the mempool.;
3069
0
    if (m_mempool) {
3070
0
        m_mempool->removeForBlock(block_to_connect->vtx, pindexNew->nHeight);
3071
0
        disconnectpool.removeForBlock(block_to_connect->vtx);
3072
0
    }
3073
    // Update m_chain & related variables.
3074
0
    m_chain.SetTip(*pindexNew);
3075
0
    m_chainman.UpdateIBDStatus();
3076
0
    UpdateTip(pindexNew);
3077
3078
0
    const auto time_6{SteadyClock::now()};
3079
0
    m_chainman.time_post_connect += time_6 - time_5;
3080
0
    m_chainman.time_total += time_6 - time_1;
3081
0
    LogDebug(BCLog::BENCH, "  - Connect postprocess: %.2fms [%.2fs (%.2fms/blk)]\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
3082
0
             Ticks<MillisecondsDouble>(time_6 - time_5),
3083
0
             Ticks<SecondsDouble>(m_chainman.time_post_connect),
3084
0
             Ticks<MillisecondsDouble>(m_chainman.time_post_connect) / m_chainman.num_blocks_total);
3085
0
    LogDebug(BCLog::BENCH, "- Connect block: %.2fms [%.2fs (%.2fms/blk)]\n",
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
3086
0
             Ticks<MillisecondsDouble>(time_6 - time_1),
3087
0
             Ticks<SecondsDouble>(m_chainman.time_total),
3088
0
             Ticks<MillisecondsDouble>(m_chainman.time_total) / m_chainman.num_blocks_total);
3089
3090
    // See if this chainstate has reached a target block and can be used to
3091
    // validate an assumeutxo snapshot. If it can, hashing the UTXO database
3092
    // will be slow, and cs_main could remain locked here for several minutes.
3093
    // If the snapshot is validated, the UTXO hash will be saved to
3094
    // this->m_target_utxohash, causing HistoricalChainstate() to return null
3095
    // and this chainstate to no longer be used. ActivateBestChain() will also
3096
    // stop connecting blocks to this chainstate because this->ReachedTarget()
3097
    // will be true and this->setBlockIndexCandidates will not have additional
3098
    // blocks.
3099
0
    Chainstate& current_cs{m_chainman.CurrentChainstate()};
3100
0
    m_chainman.MaybeValidateSnapshot(*this, current_cs);
3101
3102
0
    connected_blocks.emplace_back(pindexNew, std::move(block_to_connect));
3103
0
    return true;
3104
0
}
3105
3106
/**
3107
 * Return the tip of the chain with the most work in it, that isn't
3108
 * known to be invalid (it's however far from certain to be valid).
3109
 */
3110
CBlockIndex* Chainstate::FindMostWorkChain()
3111
0
{
3112
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3113
0
    do {
3114
0
        CBlockIndex *pindexNew = nullptr;
3115
3116
        // Find the best candidate header.
3117
0
        {
3118
0
            std::set<CBlockIndex*, CBlockIndexWorkComparator>::reverse_iterator it = setBlockIndexCandidates.rbegin();
3119
0
            if (it == setBlockIndexCandidates.rend())
3120
0
                return nullptr;
3121
0
            pindexNew = *it;
3122
0
        }
3123
3124
        // Check whether all blocks on the path between the currently active chain and the candidate are valid.
3125
        // Just going until the active chain is an optimization, as we know all blocks in it are valid already.
3126
0
        bool fInvalidAncestor = false;
3127
0
        for (CBlockIndex *pindexTest = pindexNew; pindexTest && !m_chain.Contains(pindexTest); pindexTest = pindexTest->pprev) {
3128
0
            assert(pindexTest->HaveNumChainTxs() || pindexTest->nHeight == 0);
3129
3130
            // Pruned nodes may have entries in setBlockIndexCandidates for
3131
            // which block files have been deleted.  Remove those as candidates
3132
            // for the most work chain if we come across them; we can't switch
3133
            // to a chain unless we have all the non-active-chain parent blocks.
3134
0
            bool fFailedChain = pindexTest->nStatus & BLOCK_FAILED_VALID;
3135
0
            bool fMissingData = !(pindexTest->nStatus & BLOCK_HAVE_DATA);
3136
0
            if (fFailedChain || fMissingData) {
3137
                // Candidate chain is not usable (either invalid or missing data)
3138
0
                if (fFailedChain && (m_chainman.m_best_invalid == nullptr || pindexNew->nChainWork > m_chainman.m_best_invalid->nChainWork)) {
3139
0
                    m_chainman.m_best_invalid = pindexNew;
3140
0
                }
3141
                // Remove the entire chain from the set.
3142
0
                for (CBlockIndex *pindexFailed = pindexNew; pindexFailed != pindexTest; pindexFailed = pindexFailed->pprev) {
3143
0
                    if (fMissingData && !fFailedChain) {
3144
                        // If we're missing data and not a descendant of an invalid block,
3145
                        // then add back to m_blocks_unlinked, so that if the block arrives in the future
3146
                        // we can try adding to setBlockIndexCandidates again.
3147
0
                        m_blockman.m_blocks_unlinked.insert(
3148
0
                            std::make_pair(pindexFailed->pprev, pindexFailed));
3149
0
                    }
3150
0
                    setBlockIndexCandidates.erase(pindexFailed);
3151
0
                }
3152
0
                setBlockIndexCandidates.erase(pindexTest);
3153
0
                fInvalidAncestor = true;
3154
0
                break;
3155
0
            }
3156
0
        }
3157
0
        if (!fInvalidAncestor)
3158
0
            return pindexNew;
3159
0
    } while(true);
3160
0
}
3161
3162
/** Delete all entries in setBlockIndexCandidates that are worse than the current tip. */
3163
0
void Chainstate::PruneBlockIndexCandidates() {
3164
    // Note that we can't delete the current block itself, as we may need to return to it later in case a
3165
    // reorganization to a better block fails.
3166
0
    std::set<CBlockIndex*, CBlockIndexWorkComparator>::iterator it = setBlockIndexCandidates.begin();
3167
0
    while (it != setBlockIndexCandidates.end() && setBlockIndexCandidates.value_comp()(*it, m_chain.Tip())) {
3168
0
        setBlockIndexCandidates.erase(it++);
3169
0
    }
3170
    // Either the current tip or a successor of it we're working towards is left in setBlockIndexCandidates.
3171
0
    assert(!setBlockIndexCandidates.empty());
3172
0
}
3173
3174
/**
3175
 * Try to make some progress towards making pindexMostWork the active block.
3176
 * pblock is either nullptr or a pointer to a CBlock corresponding to pindexMostWork.
3177
 *
3178
 * @returns true unless a system error occurred
3179
 */
3180
bool Chainstate::ActivateBestChainStep(BlockValidationState& state, CBlockIndex* pindexMostWork, const std::shared_ptr<const CBlock>& pblock, bool& fInvalidFound, std::vector<ConnectedBlock>& connected_blocks)
3181
0
{
3182
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3183
0
    if (m_mempool) AssertLockHeld(m_mempool->cs);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3184
3185
0
    const CBlockIndex* pindexOldTip = m_chain.Tip();
3186
0
    const CBlockIndex* pindexFork = m_chain.FindFork(pindexMostWork);
3187
3188
    // Disconnect active blocks which are no longer in the best chain.
3189
0
    bool fBlocksDisconnected = false;
3190
0
    DisconnectedBlockTransactions disconnectpool{MAX_DISCONNECTED_TX_POOL_BYTES};
3191
0
    while (m_chain.Tip() && m_chain.Tip() != pindexFork) {
3192
0
        if (!DisconnectTip(state, &disconnectpool)) {
3193
            // This is likely a fatal error, but keep the mempool consistent,
3194
            // just in case. Only remove from the mempool in this case.
3195
0
            MaybeUpdateMempoolForReorg(disconnectpool, false);
3196
3197
            // If we're unable to disconnect a block during normal operation,
3198
            // then that is a failure of our local system -- we should abort
3199
            // rather than stay on a less work chain.
3200
0
            FatalError(m_chainman.GetNotifications(), state, _("Failed to disconnect block."));
3201
0
            return false;
3202
0
        }
3203
0
        fBlocksDisconnected = true;
3204
0
    }
3205
3206
    // Build list of new blocks to connect (in descending height order).
3207
0
    std::vector<CBlockIndex*> vpindexToConnect;
3208
0
    bool fContinue = true;
3209
0
    int nHeight = pindexFork ? pindexFork->nHeight : -1;
3210
0
    while (fContinue && nHeight != pindexMostWork->nHeight) {
3211
        // Don't iterate the entire list of potential improvements toward the best tip, as we likely only need
3212
        // a few blocks along the way.
3213
0
        int nTargetHeight = std::min(nHeight + 32, pindexMostWork->nHeight);
3214
0
        vpindexToConnect.clear();
3215
0
        vpindexToConnect.reserve(nTargetHeight - nHeight);
3216
0
        CBlockIndex* pindexIter = pindexMostWork->GetAncestor(nTargetHeight);
3217
0
        while (pindexIter && pindexIter->nHeight != nHeight) {
3218
0
            vpindexToConnect.push_back(pindexIter);
3219
0
            pindexIter = pindexIter->pprev;
3220
0
        }
3221
0
        nHeight = nTargetHeight;
3222
3223
        // Connect new blocks.
3224
0
        for (CBlockIndex* pindexConnect : vpindexToConnect | std::views::reverse) {
3225
0
            if (!ConnectTip(state, pindexConnect, pindexConnect == pindexMostWork ? pblock : std::shared_ptr<const CBlock>(), connected_blocks, disconnectpool)) {
3226
0
                if (state.IsInvalid()) {
3227
                    // The block violates a consensus rule.
3228
0
                    if (state.GetResult() != BlockValidationResult::BLOCK_MUTATED) {
3229
0
                        InvalidChainFound(vpindexToConnect.front());
3230
0
                    }
3231
0
                    state = BlockValidationState();
3232
0
                    fInvalidFound = true;
3233
0
                    fContinue = false;
3234
0
                    break;
3235
0
                } else {
3236
                    // A system error occurred (disk space, database error, ...).
3237
                    // Make the mempool consistent with the current tip, just in case
3238
                    // any observers try to use it before shutdown.
3239
0
                    MaybeUpdateMempoolForReorg(disconnectpool, false);
3240
0
                    return false;
3241
0
                }
3242
0
            } else {
3243
0
                PruneBlockIndexCandidates();
3244
0
                if (!pindexOldTip || m_chain.Tip()->nChainWork > pindexOldTip->nChainWork) {
3245
                    // We're in a better position than we were. Return temporarily to release the lock.
3246
0
                    fContinue = false;
3247
0
                    break;
3248
0
                }
3249
0
            }
3250
0
        }
3251
0
    }
3252
3253
0
    if (fBlocksDisconnected) {
3254
        // If any blocks were disconnected, disconnectpool may be non empty.  Add
3255
        // any disconnected transactions back to the mempool.
3256
0
        MaybeUpdateMempoolForReorg(disconnectpool, true);
3257
0
    }
3258
0
    if (m_mempool) m_mempool->check(this->CoinsTip(), this->m_chain.Height() + 1);
3259
3260
0
    CheckForkWarningConditions();
3261
3262
0
    return true;
3263
0
}
3264
3265
static SynchronizationState GetSynchronizationState(bool init, bool blockfiles_indexed)
3266
0
{
3267
0
    if (!init) return SynchronizationState::POST_INIT;
3268
0
    if (!blockfiles_indexed) return SynchronizationState::INIT_REINDEX;
3269
0
    return SynchronizationState::INIT_DOWNLOAD;
3270
0
}
3271
3272
void ChainstateManager::UpdateIBDStatus()
3273
0
{
3274
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3275
0
    if (!m_cached_is_ibd.load(std::memory_order_relaxed)) return;
3276
0
    if (m_blockman.LoadingBlocks()) return;
3277
0
    if (!CurrentChainstate().m_chain.IsTipRecent(MinimumChainWork(), m_options.max_tip_age)) return;
3278
0
    LogInfo("Leaving InitialBlockDownload (latching to false)");
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
3279
0
    m_cached_is_ibd.store(false, std::memory_order_relaxed);
3280
0
}
3281
3282
bool ChainstateManager::NotifyHeaderTip()
3283
0
{
3284
0
    bool fNotify = false;
3285
0
    bool fInitialBlockDownload = false;
3286
0
    CBlockIndex* pindexHeader = nullptr;
3287
0
    {
3288
0
        LOCK(GetMutex());
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3289
0
        pindexHeader = m_best_header;
3290
3291
0
        if (pindexHeader != m_last_notified_header) {
3292
0
            fNotify = true;
3293
0
            fInitialBlockDownload = IsInitialBlockDownload();
3294
0
            m_last_notified_header = pindexHeader;
3295
0
        }
3296
0
    }
3297
    // Send block tip changed notifications without the lock held
3298
0
    if (fNotify) {
3299
0
        GetNotifications().headerTip(GetSynchronizationState(fInitialBlockDownload, m_blockman.m_blockfiles_indexed), pindexHeader->nHeight, pindexHeader->nTime, false);
3300
0
    }
3301
0
    return fNotify;
3302
0
}
3303
3304
0
static void LimitValidationInterfaceQueue(ValidationSignals& signals) LOCKS_EXCLUDED(cs_main) {
3305
0
    AssertLockNotHeld(cs_main);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
3306
3307
0
    if (signals.CallbacksPending() > 10) {
3308
0
        signals.SyncWithValidationInterfaceQueue();
3309
0
    }
3310
0
}
3311
3312
bool Chainstate::ActivateBestChain(BlockValidationState& state, std::shared_ptr<const CBlock> pblock)
3313
0
{
3314
0
    AssertLockNotHeld(m_chainstate_mutex);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
3315
3316
    // Note that while we're often called here from ProcessNewBlock, this is
3317
    // far from a guarantee. Things in the P2P/RPC will often end up calling
3318
    // us in the middle of ProcessNewBlock - do not assume pblock is set
3319
    // sanely for performance or correctness!
3320
0
    AssertLockNotHeld(::cs_main);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
3321
3322
    // ABC maintains a fair degree of expensive-to-calculate internal state
3323
    // because this function periodically releases cs_main so that it does not lock up other threads for too long
3324
    // during large connects - and to allow for e.g. the callback queue to drain
3325
    // we use m_chainstate_mutex to enforce mutual exclusion so that only one caller may execute this function at a time
3326
0
    LOCK(m_chainstate_mutex);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3327
3328
    // Belt-and-suspenders check that we aren't attempting to advance the
3329
    // chainstate past the target block.
3330
0
    if (WITH_LOCK(::cs_main, return m_target_utxohash)) {
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
3331
0
        LogError("%s", STR_INTERNAL_BUG("m_target_utxohash is set - this chainstate should not be in operation."));
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
3332
0
        return Assume(false);
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
3333
0
    }
3334
3335
0
    CBlockIndex *pindexMostWork = nullptr;
3336
0
    CBlockIndex *pindexNewTip = nullptr;
3337
0
    bool exited_ibd{false};
3338
0
    do {
3339
        // Block until the validation queue drains. This should largely
3340
        // never happen in normal operation, however may happen during
3341
        // reindex, causing memory blowup if we run too far ahead.
3342
        // Note that if a validationinterface callback ends up calling
3343
        // ActivateBestChain this may lead to a deadlock! We should
3344
        // probably have a DEBUG_LOCKORDER test for this in the future.
3345
0
        if (m_chainman.m_options.signals) LimitValidationInterfaceQueue(*m_chainman.m_options.signals);
3346
3347
0
        {
3348
0
            LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3349
0
            {
3350
            // Lock transaction pool for at least as long as it takes for connected_blocks to be consumed
3351
0
            LOCK(MempoolMutex());
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3352
0
            const bool was_in_ibd = m_chainman.IsInitialBlockDownload();
3353
0
            CBlockIndex* starting_tip = m_chain.Tip();
3354
0
            bool blocks_connected = false;
3355
0
            do {
3356
                // We absolutely may not unlock cs_main until we've made forward progress
3357
                // (with the exception of shutdown due to hardware issues, low disk space, etc).
3358
0
                std::vector<ConnectedBlock> connected_blocks; // Destructed before cs_main is unlocked
3359
3360
0
                if (pindexMostWork == nullptr) {
3361
0
                    pindexMostWork = FindMostWorkChain();
3362
0
                }
3363
3364
                // Whether we have anything to do at all.
3365
0
                if (pindexMostWork == nullptr || pindexMostWork == m_chain.Tip()) {
3366
0
                    break;
3367
0
                }
3368
3369
0
                bool fInvalidFound = false;
3370
0
                std::shared_ptr<const CBlock> nullBlockPtr;
3371
                // BlockConnected signals must be sent for the original role;
3372
                // in case snapshot validation is completed during ActivateBestChainStep, the
3373
                // result of GetRole() changes from BACKGROUND to NORMAL.
3374
0
               const ChainstateRole chainstate_role{this->GetRole()};
3375
0
                if (!ActivateBestChainStep(state, pindexMostWork, pblock && pblock->GetHash() == pindexMostWork->GetBlockHash() ? pblock : nullBlockPtr, fInvalidFound, connected_blocks)) {
3376
                    // A system error occurred
3377
0
                    return false;
3378
0
                }
3379
0
                blocks_connected = true;
3380
3381
0
                if (fInvalidFound) {
3382
                    // Wipe cache, we may need another branch now.
3383
0
                    pindexMostWork = nullptr;
3384
0
                }
3385
0
                pindexNewTip = m_chain.Tip();
3386
3387
0
                for (auto& [index, block] : std::move(connected_blocks)) {
3388
0
                    if (m_chainman.m_options.signals) {
3389
0
                        m_chainman.m_options.signals->BlockConnected(chainstate_role, std::move(Assert(block)), Assert(index));
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
                        m_chainman.m_options.signals->BlockConnected(chainstate_role, std::move(Assert(block)), Assert(index));
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
3390
0
                    }
3391
0
                }
3392
3393
                // Break this do-while to ensure we don't advance past the target block.
3394
0
                if (ReachedTarget()) {
3395
0
                    break;
3396
0
                }
3397
0
            } while (!m_chain.Tip() || (starting_tip && CBlockIndexWorkComparator()(m_chain.Tip(), starting_tip)));
3398
0
            if (!blocks_connected) return true;
3399
3400
0
            const CBlockIndex* pindexFork = m_chain.FindFork(starting_tip);
3401
0
            bool still_in_ibd = m_chainman.IsInitialBlockDownload();
3402
3403
0
            if (was_in_ibd && !still_in_ibd) {
3404
                // Active chainstate has exited IBD.
3405
0
                exited_ibd = true;
3406
0
            }
3407
3408
            // Notify external listeners about the new tip.
3409
            // Enqueue while holding cs_main to ensure that UpdatedBlockTip is called in the order in which blocks are connected
3410
0
            if (this == &m_chainman.ActiveChainstate() && pindexFork != pindexNewTip) {
3411
                // Notify ValidationInterface subscribers
3412
0
                if (m_chainman.m_options.signals) {
3413
0
                    m_chainman.m_options.signals->UpdatedBlockTip(pindexNewTip, pindexFork, still_in_ibd);
3414
0
                }
3415
3416
0
                if (kernel::IsInterrupted(m_chainman.GetNotifications().blockTip(
3417
0
                        /*state=*/GetSynchronizationState(still_in_ibd, m_chainman.m_blockman.m_blockfiles_indexed),
3418
0
                        /*index=*/*pindexNewTip,
3419
0
                        /*verification_progress=*/m_chainman.GuessVerificationProgress(pindexNewTip))))
3420
0
                {
3421
                    // Just breaking and returning success for now. This could
3422
                    // be changed to bubble up the kernel::Interrupted value to
3423
                    // the caller so the caller could distinguish between
3424
                    // completed and interrupted operations.
3425
0
                    break;
3426
0
                }
3427
0
            }
3428
0
            } // release MempoolMutex
3429
            // Notify external listeners about the new tip, even if pindexFork == pindexNewTip.
3430
0
            if (m_chainman.m_options.signals && this == &m_chainman.ActiveChainstate()) {
3431
0
                m_chainman.m_options.signals->ActiveTipChange(*Assert(pindexNewTip), m_chainman.IsInitialBlockDownload());
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
3432
0
            }
3433
0
        } // release cs_main
3434
        // When we reach this point, we switched to a new tip (stored in pindexNewTip).
3435
3436
0
        bool reached_target;
3437
0
        {
3438
0
            LOCK(m_chainman.GetMutex());
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3439
0
            if (exited_ibd) {
3440
                // If a background chainstate is in use, we may need to rebalance our
3441
                // allocation of caches once a chainstate exits initial block download.
3442
0
                m_chainman.MaybeRebalanceCaches();
3443
0
            }
3444
3445
            // Write changes periodically to disk, after relay.
3446
0
            if (!FlushStateToDisk(state, FlushStateMode::PERIODIC)) {
3447
0
                return false;
3448
0
            }
3449
3450
0
            reached_target = ReachedTarget();
3451
0
        }
3452
3453
0
        if (reached_target) {
3454
            // Chainstate has reached the target block, so exit.
3455
            //
3456
            // Restart indexes so indexes can resync and index new blocks after
3457
            // the target block.
3458
            //
3459
            // This cannot be done while holding cs_main (within
3460
            // MaybeValidateSnapshot) or a cs_main deadlock will occur.
3461
0
            if (m_chainman.snapshot_download_completed) {
3462
0
                m_chainman.snapshot_download_completed();
3463
0
            }
3464
0
            break;
3465
0
        }
3466
3467
        // We check interrupt only after giving ActivateBestChainStep a chance to run once so that we
3468
        // never interrupt before connecting the genesis block during LoadChainTip(). Previously this
3469
        // caused an assert() failure during interrupt in such cases as the UTXO DB flushing checks
3470
        // that the best block hash is non-null.
3471
0
        if (m_chainman.m_interrupt) break;
3472
0
    } while (pindexNewTip != pindexMostWork);
3473
3474
0
    m_chainman.CheckBlockIndex();
3475
3476
0
    return true;
3477
0
}
3478
3479
bool Chainstate::PreciousBlock(BlockValidationState& state, CBlockIndex* pindex)
3480
0
{
3481
0
    AssertLockNotHeld(m_chainstate_mutex);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
3482
0
    AssertLockNotHeld(::cs_main);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
3483
0
    {
3484
0
        LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3485
0
        if (pindex->nChainWork < m_chain.Tip()->nChainWork) {
3486
            // Nothing to do, this block is not at the tip.
3487
0
            return true;
3488
0
        }
3489
0
        if (m_chain.Tip()->nChainWork > m_chainman.nLastPreciousChainwork) {
3490
            // The chain has been extended since the last call, reset the counter.
3491
0
            m_chainman.nBlockReverseSequenceId = -1;
3492
0
        }
3493
0
        m_chainman.nLastPreciousChainwork = m_chain.Tip()->nChainWork;
3494
0
        setBlockIndexCandidates.erase(pindex);
3495
0
        pindex->nSequenceId = m_chainman.nBlockReverseSequenceId;
3496
0
        if (m_chainman.nBlockReverseSequenceId > std::numeric_limits<int32_t>::min()) {
3497
            // We can't keep reducing the counter if somebody really wants to
3498
            // call preciousblock 2**31-1 times on the same set of tips...
3499
0
            m_chainman.nBlockReverseSequenceId--;
3500
0
        }
3501
0
        if (pindex->IsValid(BLOCK_VALID_TRANSACTIONS) && pindex->HaveNumChainTxs()) {
3502
0
            setBlockIndexCandidates.insert(pindex);
3503
0
            PruneBlockIndexCandidates();
3504
0
        }
3505
0
    }
3506
3507
0
    return ActivateBestChain(state, std::shared_ptr<const CBlock>());
3508
0
}
3509
3510
bool Chainstate::InvalidateBlock(BlockValidationState& state, CBlockIndex* pindex)
3511
0
{
3512
0
    AssertLockNotHeld(m_chainstate_mutex);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
3513
0
    AssertLockNotHeld(::cs_main);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
3514
3515
    // Genesis block can't be invalidated
3516
0
    assert(pindex);
3517
0
    if (pindex->nHeight == 0) return false;
3518
3519
    // We do not allow ActivateBestChain() to run while InvalidateBlock() is
3520
    // running, as that could cause the tip to change while we disconnect
3521
    // blocks.
3522
0
    LOCK(m_chainstate_mutex);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3523
3524
    // We'll be acquiring and releasing cs_main below, to allow the validation
3525
    // callbacks to run. However, we should keep the block index in a
3526
    // consistent state as we disconnect blocks -- in particular we need to
3527
    // add equal-work blocks to setBlockIndexCandidates as we disconnect.
3528
    // To avoid walking the block index repeatedly in search of candidates,
3529
    // build a map once so that we can look up candidate blocks by chain
3530
    // work as we go.
3531
0
    std::multimap<const arith_uint256, CBlockIndex*> highpow_outofchain_headers;
3532
3533
0
    {
3534
0
        LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3535
0
        for (auto& entry : m_blockman.m_block_index) {
3536
0
            CBlockIndex* candidate = &entry.second;
3537
            // We don't need to put anything in our active chain into the
3538
            // multimap, because those candidates will be found and considered
3539
            // as we disconnect.
3540
            // Instead, consider only non-active-chain blocks that score
3541
            // at least as good with CBlockIndexWorkComparator as the new tip.
3542
0
            if (!m_chain.Contains(candidate) &&
3543
0
                !CBlockIndexWorkComparator()(candidate, pindex->pprev) &&
3544
0
                !(candidate->nStatus & BLOCK_FAILED_VALID)) {
3545
0
                highpow_outofchain_headers.insert({candidate->nChainWork, candidate});
3546
0
            }
3547
0
        }
3548
0
    }
3549
3550
0
    CBlockIndex* to_mark_failed = pindex;
3551
0
    bool pindex_was_in_chain = false;
3552
0
    int disconnected = 0;
3553
3554
    // Disconnect (descendants of) pindex, and mark them invalid.
3555
0
    while (true) {
3556
0
        if (m_chainman.m_interrupt) break;
3557
3558
        // Make sure the queue of validation callbacks doesn't grow unboundedly.
3559
0
        if (m_chainman.m_options.signals) LimitValidationInterfaceQueue(*m_chainman.m_options.signals);
3560
3561
0
        LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3562
        // Lock for as long as disconnectpool is in scope to make sure MaybeUpdateMempoolForReorg is
3563
        // called after DisconnectTip without unlocking in between
3564
0
        LOCK(MempoolMutex());
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3565
0
        if (!m_chain.Contains(pindex)) break;
3566
0
        pindex_was_in_chain = true;
3567
0
        CBlockIndex* disconnected_tip{m_chain.Tip()};
3568
3569
        // ActivateBestChain considers blocks already in m_chain
3570
        // unconditionally valid already, so force disconnect away from it.
3571
0
        DisconnectedBlockTransactions disconnectpool{MAX_DISCONNECTED_TX_POOL_BYTES};
3572
0
        bool ret = DisconnectTip(state, &disconnectpool);
3573
        // DisconnectTip will add transactions to disconnectpool.
3574
        // Adjust the mempool to be consistent with the new tip, adding
3575
        // transactions back to the mempool if disconnecting was successful,
3576
        // and we're not doing a very deep invalidation (in which case
3577
        // keeping the mempool up to date is probably futile anyway).
3578
0
        MaybeUpdateMempoolForReorg(disconnectpool, /* fAddToMempool = */ (++disconnected <= 10) && ret);
3579
0
        if (!ret) return false;
3580
0
        CBlockIndex* new_tip{m_chain.Tip()};
3581
0
        assert(disconnected_tip->pprev == new_tip);
3582
3583
        // We immediately mark the disconnected blocks as invalid.
3584
        // This prevents a case where pruned nodes may fail to invalidateblock
3585
        // and be left unable to start as they have no tip candidates (as there
3586
        // are no blocks that meet the "have data and are not invalid per
3587
        // nStatus" criteria for inclusion in setBlockIndexCandidates).
3588
0
        disconnected_tip->nStatus |= BLOCK_FAILED_VALID;
3589
0
        m_blockman.m_dirty_blockindex.insert(disconnected_tip);
3590
0
        setBlockIndexCandidates.erase(disconnected_tip);
3591
0
        setBlockIndexCandidates.insert(new_tip);
3592
3593
        // Mark out-of-chain descendants of the invalidated block as invalid
3594
        // Add any equal or more work headers that are not invalidated to setBlockIndexCandidates
3595
        // Recalculate m_best_header if it became invalid.
3596
0
        auto candidate_it = highpow_outofchain_headers.lower_bound(new_tip->nChainWork);
3597
3598
0
        const bool best_header_needs_update{m_chainman.m_best_header->GetAncestor(disconnected_tip->nHeight) == disconnected_tip};
3599
0
        if (best_header_needs_update) {
3600
            // new_tip is definitely still valid at this point, but there may be better ones
3601
0
            m_chainman.m_best_header = new_tip;
3602
0
        }
3603
3604
0
        while (candidate_it != highpow_outofchain_headers.end()) {
3605
0
            CBlockIndex* candidate{candidate_it->second};
3606
0
            if (candidate->GetAncestor(disconnected_tip->nHeight) == disconnected_tip) {
3607
                // Children of failed blocks are marked as BLOCK_FAILED_VALID.
3608
0
                candidate->nStatus |= BLOCK_FAILED_VALID;
3609
0
                m_blockman.m_dirty_blockindex.insert(candidate);
3610
                // If invalidated, the block is irrelevant for setBlockIndexCandidates
3611
                // and for m_best_header and can be removed from the cache.
3612
0
                candidate_it = highpow_outofchain_headers.erase(candidate_it);
3613
0
                continue;
3614
0
            }
3615
0
            if (!CBlockIndexWorkComparator()(candidate, new_tip) &&
3616
0
                candidate->IsValid(BLOCK_VALID_TRANSACTIONS) &&
3617
0
                candidate->HaveNumChainTxs()) {
3618
0
                setBlockIndexCandidates.insert(candidate);
3619
                // Do not remove candidate from the highpow_outofchain_headers cache, because it might be a descendant of the block being invalidated
3620
                // which needs to be marked failed later.
3621
0
            }
3622
0
            if (best_header_needs_update &&
3623
0
                m_chainman.m_best_header->nChainWork < candidate->nChainWork) {
3624
0
                m_chainman.m_best_header = candidate;
3625
0
            }
3626
0
            ++candidate_it;
3627
0
        }
3628
3629
        // Track the last disconnected block to call InvalidChainFound on it.
3630
0
        to_mark_failed = disconnected_tip;
3631
0
    }
3632
3633
0
    m_chainman.CheckBlockIndex();
3634
3635
0
    {
3636
0
        LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
3637
0
        if (m_chain.Contains(to_mark_failed)) {
3638
            // If the to-be-marked invalid block is in the active chain, something is interfering and we can't proceed.
3639
0
            return false;
3640
0
        }
3641
3642
        // Mark pindex as invalid if it never was in the main chain
3643
0
        if (!pindex_was_in_chain && !(pindex->nStatus & BLOCK_FAILED_VALID)) {
3644
0
            pindex->nStatus |= BLOCK_FAILED_VALID;
3645
0
            m_blockman.m_dirty_blockindex.insert(pindex);
3646
0
            setBlockIndexCandidates.erase(pindex);
3647
0
        }
3648
3649
        // If any new blocks somehow arrived while we were disconnecting
3650
        // (above), then the pre-calculation of what should go into
3651
        // setBlockIndexCandidates may have missed entries. This would
3652
        // technically be an inconsistency in the block index, but if we clean
3653
        // it up here, this should be an essentially unobservable error.
3654
        // Loop back over all block index entries and add any missing entries
3655
        // to setBlockIndexCandidates.
3656
0
        for (auto& [_, block_index] : m_blockman.m_block_index) {
3657
0
            if (block_index.IsValid(BLOCK_VALID_TRANSACTIONS) && block_index.HaveNumChainTxs() && !setBlockIndexCandidates.value_comp()(&block_index, m_chain.Tip())) {
3658
0
                setBlockIndexCandidates.insert(&block_index);
3659
0
            }
3660
0
        }
3661
3662
0
        InvalidChainFound(to_mark_failed);
3663
0
    }
3664
3665
    // Only notify about a new block tip if the active chain was modified.
3666
0
    if (pindex_was_in_chain) {
3667
        // Ignoring return value for now, this could be changed to bubble up
3668
        // kernel::Interrupted value to the caller so the caller could
3669
        // distinguish between completed and interrupted operations. It might
3670
        // also make sense for the blockTip notification to have an enum
3671
        // parameter indicating the source of the tip change so hooks can
3672
        // distinguish user-initiated invalidateblock changes from other
3673
        // changes.
3674
0
        (void)m_chainman.GetNotifications().blockTip(
3675
0
            /*state=*/GetSynchronizationState(m_chainman.IsInitialBlockDownload(), m_chainman.m_blockman.m_blockfiles_indexed),
3676
0
            /*index=*/*to_mark_failed->pprev,
3677
0
            /*verification_progress=*/WITH_LOCK(m_chainman.GetMutex(), return m_chainman.GuessVerificationProgress(to_mark_failed->pprev)));
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
3678
3679
        // Fire ActiveTipChange now for the current chain tip to make sure clients are notified.
3680
        // ActivateBestChain may call this as well, but not necessarily.
3681
0
        if (m_chainman.m_options.signals) {
3682
0
            m_chainman.m_options.signals->ActiveTipChange(*Assert(m_chain.Tip()), m_chainman.IsInitialBlockDownload());
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
3683
0
        }
3684
0
    }
3685
0
    return true;
3686
0
}
3687
3688
void Chainstate::SetBlockFailureFlags(CBlockIndex* invalid_block)
3689
0
{
3690
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3691
3692
0
    for (auto& [_, block_index] : m_blockman.m_block_index) {
3693
0
        if (invalid_block != &block_index && block_index.GetAncestor(invalid_block->nHeight) == invalid_block) {
3694
0
            block_index.nStatus |= BLOCK_FAILED_VALID;
3695
0
            m_blockman.m_dirty_blockindex.insert(&block_index);
3696
0
        }
3697
0
    }
3698
0
}
3699
3700
0
void Chainstate::ResetBlockFailureFlags(CBlockIndex *pindex) {
3701
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3702
3703
0
    int nHeight = pindex->nHeight;
3704
3705
    // Remove the invalidity flag from this block and all its descendants and ancestors.
3706
0
    for (auto& [_, block_index] : m_blockman.m_block_index) {
3707
0
        if ((block_index.nStatus & BLOCK_FAILED_VALID) && (block_index.GetAncestor(nHeight) == pindex || pindex->GetAncestor(block_index.nHeight) == &block_index)) {
3708
0
            block_index.nStatus &= ~BLOCK_FAILED_VALID;
3709
0
            m_blockman.m_dirty_blockindex.insert(&block_index);
3710
0
            if (block_index.IsValid(BLOCK_VALID_TRANSACTIONS) && block_index.HaveNumChainTxs() && setBlockIndexCandidates.value_comp()(m_chain.Tip(), &block_index)) {
3711
0
                setBlockIndexCandidates.insert(&block_index);
3712
0
            }
3713
0
            if (&block_index == m_chainman.m_best_invalid) {
3714
                // Reset invalid block marker if it was pointing to one of those.
3715
0
                m_chainman.m_best_invalid = nullptr;
3716
0
            }
3717
0
        }
3718
0
    }
3719
0
}
3720
3721
void Chainstate::TryAddBlockIndexCandidate(CBlockIndex* pindex)
3722
0
{
3723
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3724
3725
    // Do not continue building a chainstate that is based on an invalid
3726
    // snapshot. This is a belt-and-suspenders type of check because if an
3727
    // invalid snapshot is loaded, the node will shut down to force a manual
3728
    // intervention. But it is good to handle this case correctly regardless.
3729
0
    if (m_assumeutxo == Assumeutxo::INVALID) {
3730
0
        return;
3731
0
    }
3732
3733
    // The block only is a candidate for the most-work-chain if it has the same
3734
    // or more work than our current tip.
3735
0
    if (m_chain.Tip() != nullptr && setBlockIndexCandidates.value_comp()(pindex, m_chain.Tip())) {
3736
0
        return;
3737
0
    }
3738
3739
0
    const CBlockIndex* target_block{TargetBlock()};
3740
0
    if (!target_block) {
3741
        // If no specific target block, add all entries that have more
3742
        // work than the tip.
3743
0
        setBlockIndexCandidates.insert(pindex);
3744
0
    } else {
3745
        // If there is a target block, only consider connecting blocks
3746
        // towards the target block.
3747
0
        if (target_block->GetAncestor(pindex->nHeight) == pindex) {
3748
0
            setBlockIndexCandidates.insert(pindex);
3749
0
        }
3750
0
    }
3751
0
}
3752
3753
/** Mark a block as having its data received and checked (up to BLOCK_VALID_TRANSACTIONS). */
3754
void ChainstateManager::ReceivedBlockTransactions(const CBlock& block, CBlockIndex* pindexNew, const FlatFilePos& pos)
3755
0
{
3756
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
3757
0
    pindexNew->nTx = block.vtx.size();
3758
    // Typically m_chain_tx_count will be 0 at this point, but it can be nonzero if this
3759
    // is a pruned block which is being downloaded again, or if this is an
3760
    // assumeutxo snapshot block which has a hardcoded m_chain_tx_count value from the
3761
    // snapshot metadata. If the pindex is not the snapshot block and the
3762
    // m_chain_tx_count value is not zero, assert that value is actually correct.
3763
0
    auto prev_tx_sum = [](CBlockIndex& block) { return block.nTx + (block.pprev ? block.pprev->m_chain_tx_count : 0); };
3764
0
    if (!Assume(pindexNew->m_chain_tx_count == 0 || pindexNew->m_chain_tx_count == prev_tx_sum(*pindexNew) ||
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
3765
0
                std::ranges::any_of(m_chainstates, [&](const auto& cs) EXCLUSIVE_LOCKS_REQUIRED(cs_main) { return cs->SnapshotBase() == pindexNew; }))) {
3766
0
        LogWarning("Internal bug detected: block %d has unexpected m_chain_tx_count %i that should be %i (%s %s). Please report this issue here: %s\n",
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
3767
0
            pindexNew->nHeight, pindexNew->m_chain_tx_count, prev_tx_sum(*pindexNew), CLIENT_NAME, FormatFullVersion(), CLIENT_BUGREPORT);
3768
0
        pindexNew->m_chain_tx_count = 0;
3769
0
    }
3770
0
    pindexNew->nFile = pos.nFile;
3771
0
    pindexNew->nDataPos = pos.nPos;
3772
0
    pindexNew->nUndoPos = 0;
3773
0
    pindexNew->nStatus |= BLOCK_HAVE_DATA;
3774
0
    if (DeploymentActiveAt(*pindexNew, *this, Consensus::DEPLOYMENT_SEGWIT)) {
3775
0
        pindexNew->nStatus |= BLOCK_OPT_WITNESS;
3776
0
    }
3777
0
    pindexNew->RaiseValidity(BLOCK_VALID_TRANSACTIONS);
3778
0
    m_blockman.m_dirty_blockindex.insert(pindexNew);
3779
3780
0
    if (pindexNew->pprev == nullptr || pindexNew->pprev->HaveNumChainTxs()) {
3781
        // If pindexNew is the genesis block or all parents are BLOCK_VALID_TRANSACTIONS.
3782
0
        std::deque<CBlockIndex*> queue;
3783
0
        queue.push_back(pindexNew);
3784
3785
        // Recursively process any descendant blocks that now may be eligible to be connected.
3786
0
        while (!queue.empty()) {
3787
0
            CBlockIndex *pindex = queue.front();
3788
0
            queue.pop_front();
3789
            // Before setting m_chain_tx_count, assert that it is 0 or already set to
3790
            // the correct value. This assert will fail after receiving the
3791
            // assumeutxo snapshot block if assumeutxo snapshot metadata has an
3792
            // incorrect hardcoded AssumeutxoData::m_chain_tx_count value.
3793
0
            if (!Assume(pindex->m_chain_tx_count == 0 || pindex->m_chain_tx_count == prev_tx_sum(*pindex))) {
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
3794
0
                LogWarning("Internal bug detected: block %d has unexpected m_chain_tx_count %i that should be %i (%s %s). Please report this issue here: %s\n",
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
3795
0
                   pindex->nHeight, pindex->m_chain_tx_count, prev_tx_sum(*pindex), CLIENT_NAME, FormatFullVersion(), CLIENT_BUGREPORT);
3796
0
            }
3797
0
            pindex->m_chain_tx_count = prev_tx_sum(*pindex);
3798
0
            pindex->nSequenceId = nBlockSequenceId++;
3799
0
            for (const auto& c : m_chainstates) {
3800
0
                c->TryAddBlockIndexCandidate(pindex);
3801
0
            }
3802
0
            std::pair<std::multimap<CBlockIndex*, CBlockIndex*>::iterator, std::multimap<CBlockIndex*, CBlockIndex*>::iterator> range = m_blockman.m_blocks_unlinked.equal_range(pindex);
3803
0
            while (range.first != range.second) {
3804
0
                std::multimap<CBlockIndex*, CBlockIndex*>::iterator it = range.first;
3805
0
                queue.push_back(it->second);
3806
0
                range.first++;
3807
0
                m_blockman.m_blocks_unlinked.erase(it);
3808
0
            }
3809
0
        }
3810
0
    } else {
3811
0
        if (pindexNew->pprev && pindexNew->pprev->IsValid(BLOCK_VALID_TREE)) {
3812
0
            m_blockman.m_blocks_unlinked.insert(std::make_pair(pindexNew->pprev, pindexNew));
3813
0
        }
3814
0
    }
3815
0
}
3816
3817
static bool CheckBlockHeader(const CBlockHeader& block, BlockValidationState& state, const Consensus::Params& consensusParams, bool fCheckPOW = true)
3818
0
{
3819
    // Check proof of work matches claimed amount
3820
0
    if (fCheckPOW && !CheckProofOfWork(block.GetHash(), block.nBits, consensusParams))
3821
0
        return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "high-hash", "proof of work failed");
3822
3823
0
    return true;
3824
0
}
3825
3826
static bool CheckMerkleRoot(const CBlock& block, BlockValidationState& state)
3827
0
{
3828
0
    if (block.m_checked_merkle_root) return true;
3829
3830
0
    bool mutated;
3831
0
    uint256 merkle_root = BlockMerkleRoot(block, &mutated);
3832
0
    if (block.hashMerkleRoot != merkle_root) {
3833
0
        return state.Invalid(
3834
0
            /*result=*/BlockValidationResult::BLOCK_MUTATED,
3835
0
            /*reject_reason=*/"bad-txnmrklroot",
3836
0
            /*debug_message=*/"hashMerkleRoot mismatch");
3837
0
    }
3838
3839
    // Check for merkle tree malleability (CVE-2012-2459): repeating sequences
3840
    // of transactions in a block without affecting the merkle root of a block,
3841
    // while still invalidating it.
3842
0
    if (mutated) {
3843
0
        return state.Invalid(
3844
0
            /*result=*/BlockValidationResult::BLOCK_MUTATED,
3845
0
            /*reject_reason=*/"bad-txns-duplicate",
3846
0
            /*debug_message=*/"duplicate transaction");
3847
0
    }
3848
3849
0
    block.m_checked_merkle_root = true;
3850
0
    return true;
3851
0
}
3852
3853
/** CheckWitnessMalleation performs checks for block malleation with regard to
3854
 * its witnesses.
3855
 *
3856
 * Note: If the witness commitment is expected (i.e. `expect_witness_commitment
3857
 * = true`), then the block is required to have at least one transaction and the
3858
 * first transaction needs to have at least one input. */
3859
static bool CheckWitnessMalleation(const CBlock& block, bool expect_witness_commitment, BlockValidationState& state)
3860
0
{
3861
0
    if (expect_witness_commitment) {
3862
0
        if (block.m_checked_witness_commitment) return true;
3863
3864
0
        int commitpos = GetWitnessCommitmentIndex(block);
3865
0
        if (commitpos != NO_WITNESS_COMMITMENT) {
3866
0
            assert(!block.vtx.empty() && !block.vtx[0]->vin.empty());
3867
0
            const auto& witness_stack{block.vtx[0]->vin[0].scriptWitness.stack};
3868
3869
0
            if (witness_stack.size() != 1 || witness_stack[0].size() != 32) {
3870
0
                return state.Invalid(
3871
0
                    /*result=*/BlockValidationResult::BLOCK_MUTATED,
3872
0
                    /*reject_reason=*/"bad-witness-nonce-size",
3873
0
                    /*debug_message=*/strprintf("%s : invalid witness reserved value size", __func__));
Line
Count
Source
1172
0
#define strprintf tfm::format
3874
0
            }
3875
3876
            // The malleation check is ignored; as the transaction tree itself
3877
            // already does not permit it, it is impossible to trigger in the
3878
            // witness tree.
3879
0
            uint256 hash_witness = BlockWitnessMerkleRoot(block);
3880
3881
0
            CHash256().Write(hash_witness).Write(witness_stack[0]).Finalize(hash_witness);
3882
0
            if (memcmp(hash_witness.begin(), &block.vtx[0]->vout[commitpos].scriptPubKey[6], 32)) {
3883
0
                return state.Invalid(
3884
0
                    /*result=*/BlockValidationResult::BLOCK_MUTATED,
3885
0
                    /*reject_reason=*/"bad-witness-merkle-match",
3886
0
                    /*debug_message=*/strprintf("%s : witness merkle commitment mismatch", __func__));
Line
Count
Source
1172
0
#define strprintf tfm::format
3887
0
            }
3888
3889
0
            block.m_checked_witness_commitment = true;
3890
0
            return true;
3891
0
        }
3892
0
    }
3893
3894
    // No witness data is allowed in blocks that don't commit to witness data, as this would otherwise leave room for spam
3895
0
    for (const auto& tx : block.vtx) {
3896
0
        if (tx->HasWitness()) {
3897
0
            return state.Invalid(
3898
0
                /*result=*/BlockValidationResult::BLOCK_MUTATED,
3899
0
                /*reject_reason=*/"unexpected-witness",
3900
0
                /*debug_message=*/strprintf("%s : unexpected witness data found", __func__));
Line
Count
Source
1172
0
#define strprintf tfm::format
3901
0
        }
3902
0
    }
3903
3904
0
    return true;
3905
0
}
3906
3907
bool CheckBlock(const CBlock& block, BlockValidationState& state, const Consensus::Params& consensusParams, bool fCheckPOW, bool fCheckMerkleRoot)
3908
0
{
3909
    // These are checks that are independent of context.
3910
3911
0
    if (block.fChecked)
3912
0
        return true;
3913
3914
    // Check that the header is valid (particularly PoW).  This is mostly
3915
    // redundant with the call in AcceptBlockHeader.
3916
0
    if (!CheckBlockHeader(block, state, consensusParams, fCheckPOW))
3917
0
        return false;
3918
3919
    // Signet only: check block solution
3920
0
    if (consensusParams.signet_blocks && fCheckPOW && !CheckSignetBlockSolution(block, consensusParams)) {
3921
0
        return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-signet-blksig", "signet block signature validation failure");
3922
0
    }
3923
3924
    // Check the merkle root.
3925
0
    if (fCheckMerkleRoot && !CheckMerkleRoot(block, state)) {
3926
0
        return false;
3927
0
    }
3928
3929
    // All potential-corruption validation must be done before we do any
3930
    // transaction validation, as otherwise we may mark the header as invalid
3931
    // because we receive the wrong transactions for it.
3932
    // Note that witness malleability is checked in ContextualCheckBlock, so no
3933
    // checks that use witness data may be performed here.
3934
3935
    // Size limits
3936
0
    if (block.vtx.empty() || block.vtx.size() * WITNESS_SCALE_FACTOR > MAX_BLOCK_WEIGHT || ::GetSerializeSize(TX_NO_WITNESS(block)) * WITNESS_SCALE_FACTOR > MAX_BLOCK_WEIGHT)
3937
0
        return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-length", "size limits failed");
3938
3939
    // First transaction must be coinbase, the rest must not be
3940
0
    if (block.vtx.empty() || !block.vtx[0]->IsCoinBase())
3941
0
        return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-missing", "first tx is not coinbase");
3942
0
    for (unsigned int i = 1; i < block.vtx.size(); i++)
3943
0
        if (block.vtx[i]->IsCoinBase())
3944
0
            return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-multiple", "more than one coinbase");
3945
3946
    // Check transactions
3947
    // Must check for duplicate inputs (see CVE-2018-17144)
3948
0
    for (const auto& tx : block.vtx) {
3949
0
        TxValidationState tx_state;
3950
0
        if (!CheckTransaction(*tx, tx_state)) {
3951
            // CheckBlock() does context-free validation checks. The only
3952
            // possible failures are consensus failures.
3953
0
            assert(tx_state.GetResult() == TxValidationResult::TX_CONSENSUS);
3954
0
            return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, tx_state.GetRejectReason(),
3955
0
                                 strprintf("Transaction check failed (tx hash %s) %s", tx->GetHash().ToString(), tx_state.GetDebugMessage()));
Line
Count
Source
1172
0
#define strprintf tfm::format
3956
0
        }
3957
0
    }
3958
    // This underestimates the number of sigops, because unlike ConnectBlock it
3959
    // does not count witness and p2sh sigops.
3960
0
    unsigned int nSigOps = 0;
3961
0
    for (const auto& tx : block.vtx)
3962
0
    {
3963
0
        nSigOps += GetLegacySigOpCount(*tx);
3964
0
    }
3965
0
    if (nSigOps * WITNESS_SCALE_FACTOR > MAX_BLOCK_SIGOPS_COST)
3966
0
        return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-sigops", "out-of-bounds SigOpCount");
3967
3968
0
    if (fCheckPOW && fCheckMerkleRoot)
3969
0
        block.fChecked = true;
3970
3971
0
    return true;
3972
0
}
3973
3974
void ChainstateManager::UpdateUncommittedBlockStructures(CBlock& block, const CBlockIndex* pindexPrev) const
3975
0
{
3976
0
    int commitpos = GetWitnessCommitmentIndex(block);
3977
0
    static const std::vector<unsigned char> nonce(32, 0x00);
3978
0
    if (commitpos != NO_WITNESS_COMMITMENT && DeploymentActiveAfter(pindexPrev, *this, Consensus::DEPLOYMENT_SEGWIT) && !block.vtx[0]->HasWitness()) {
3979
0
        CMutableTransaction tx(*block.vtx[0]);
3980
0
        tx.vin[0].scriptWitness.stack.resize(1);
3981
0
        tx.vin[0].scriptWitness.stack[0] = nonce;
3982
0
        block.vtx[0] = MakeTransactionRef(std::move(tx));
3983
0
    }
3984
0
}
3985
3986
void ChainstateManager::GenerateCoinbaseCommitment(CBlock& block, const CBlockIndex* pindexPrev) const
3987
0
{
3988
0
    int commitpos = GetWitnessCommitmentIndex(block);
3989
0
    std::vector<unsigned char> ret(32, 0x00);
3990
0
    if (commitpos == NO_WITNESS_COMMITMENT) {
3991
0
        uint256 witnessroot = BlockWitnessMerkleRoot(block);
3992
0
        CHash256().Write(witnessroot).Write(ret).Finalize(witnessroot);
3993
0
        CTxOut out;
3994
0
        out.nValue = 0;
3995
0
        out.scriptPubKey.resize(MINIMUM_WITNESS_COMMITMENT);
3996
0
        out.scriptPubKey[0] = OP_RETURN;
3997
0
        out.scriptPubKey[1] = 0x24;
3998
0
        out.scriptPubKey[2] = 0xaa;
3999
0
        out.scriptPubKey[3] = 0x21;
4000
0
        out.scriptPubKey[4] = 0xa9;
4001
0
        out.scriptPubKey[5] = 0xed;
4002
0
        memcpy(&out.scriptPubKey[6], witnessroot.begin(), 32);
4003
0
        CMutableTransaction tx(*block.vtx[0]);
4004
0
        tx.vout.push_back(out);
4005
0
        block.vtx[0] = MakeTransactionRef(std::move(tx));
4006
0
    }
4007
0
    UpdateUncommittedBlockStructures(block, pindexPrev);
4008
0
}
4009
4010
bool HasValidProofOfWork(std::span<const CBlockHeader> headers, const Consensus::Params& consensusParams)
4011
0
{
4012
0
    return std::ranges::all_of(headers,
4013
0
                               [&](const auto& header) { return CheckProofOfWork(header.GetHash(), header.nBits, consensusParams); });
4014
0
}
4015
4016
bool IsBlockMutated(const CBlock& block, bool check_witness_root)
4017
0
{
4018
0
    BlockValidationState state;
4019
0
    if (!CheckMerkleRoot(block, state)) {
4020
0
        LogDebug(BCLog::VALIDATION, "Block mutated: %s\n", state.ToString());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
4021
0
        return true;
4022
0
    }
4023
4024
0
    if (block.vtx.empty() || !block.vtx[0]->IsCoinBase()) {
4025
        // Consider the block mutated if any transaction is 64 bytes in size (see 3.1
4026
        // in "Weaknesses in Bitcoin’s Merkle Root Construction":
4027
        // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/attachments/20190225/a27d8837/attachment-0001.pdf).
4028
        //
4029
        // Note: This is not a consensus change as this only applies to blocks that
4030
        // don't have a coinbase transaction and would therefore already be invalid.
4031
0
        return std::any_of(block.vtx.begin(), block.vtx.end(),
4032
0
                           [](auto& tx) { return GetSerializeSize(TX_NO_WITNESS(tx)) == 64; });
4033
0
    } else {
4034
        // Theoretically it is still possible for a block with a 64 byte
4035
        // coinbase transaction to be mutated but we neglect that possibility
4036
        // here as it requires at least 224 bits of work.
4037
0
    }
4038
4039
0
    if (!CheckWitnessMalleation(block, check_witness_root, state)) {
4040
0
        LogDebug(BCLog::VALIDATION, "Block mutated: %s\n", state.ToString());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
4041
0
        return true;
4042
0
    }
4043
4044
0
    return false;
4045
0
}
4046
4047
arith_uint256 CalculateClaimedHeadersWork(std::span<const CBlockHeader> headers)
4048
0
{
4049
0
    arith_uint256 total_work{0};
4050
0
    for (const CBlockHeader& header : headers) {
4051
0
        total_work += GetBlockProof(header);
4052
0
    }
4053
0
    return total_work;
4054
0
}
4055
4056
/** Context-dependent validity checks.
4057
 *  By "context", we mean only the previous block headers, but not the UTXO
4058
 *  set; UTXO-related validity checks are done in ConnectBlock().
4059
 *  NOTE: This function is not currently invoked by ConnectBlock(), so we
4060
 *  should consider upgrade issues if we change which consensus rules are
4061
 *  enforced in this function (eg by adding a new consensus rule). See comment
4062
 *  in ConnectBlock().
4063
 *  Note that -reindex-chainstate skips the validation that happens here!
4064
 *
4065
 *  NOTE: failing to check the header's height against the last checkpoint's opened a DoS vector between
4066
 *  v0.12 and v0.15 (when no additional protection was in place) whereby an attacker could unboundedly
4067
 *  grow our in-memory block index. See https://bitcoincore.org/en/2024/07/03/disclose-header-spam.
4068
 */
4069
static bool ContextualCheckBlockHeader(const CBlockHeader& block, BlockValidationState& state, const ChainstateManager& chainman, const CBlockIndex* pindexPrev) EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
4070
0
{
4071
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4072
0
    assert(pindexPrev != nullptr);
4073
0
    const int nHeight = pindexPrev->nHeight + 1;
4074
4075
    // Check proof of work
4076
0
    const Consensus::Params& consensusParams = chainman.GetConsensus();
4077
0
    if (block.nBits != GetNextWorkRequired(pindexPrev, &block, consensusParams))
4078
0
        return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "bad-diffbits", "incorrect proof of work");
4079
4080
    // Check timestamp against prev
4081
0
    if (block.GetBlockTime() <= pindexPrev->GetMedianTimePast())
4082
0
        return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "time-too-old", "block's timestamp is too early");
4083
4084
    // Testnet4 and regtest only: Check timestamp against prev for difficulty-adjustment
4085
    // blocks to prevent timewarp attacks (see https://github.com/bitcoin/bitcoin/pull/15482).
4086
0
    if (consensusParams.enforce_BIP94) {
4087
        // Check timestamp for the first block of each difficulty adjustment
4088
        // interval, except the genesis block.
4089
0
        if (nHeight % consensusParams.DifficultyAdjustmentInterval() == 0) {
4090
0
            if (block.GetBlockTime() < pindexPrev->GetBlockTime() - MAX_TIMEWARP) {
4091
0
                return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "time-timewarp-attack", "block's timestamp is too early on diff adjustment block");
4092
0
            }
4093
0
        }
4094
0
    }
4095
4096
    // Check timestamp
4097
0
    if (block.Time() > NodeClock::now() + std::chrono::seconds{MAX_FUTURE_BLOCK_TIME}) {
4098
0
        return state.Invalid(BlockValidationResult::BLOCK_TIME_FUTURE, "time-too-new", "block timestamp too far in the future");
4099
0
    }
4100
4101
    // Reject blocks with outdated version
4102
0
    if ((block.nVersion < 2 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_HEIGHTINCB)) ||
4103
0
        (block.nVersion < 3 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_DERSIG)) ||
4104
0
        (block.nVersion < 4 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_CLTV))) {
4105
0
            return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, strprintf("bad-version(0x%08x)", block.nVersion),
Line
Count
Source
1172
0
#define strprintf tfm::format
4106
0
                                 strprintf("rejected nVersion=0x%08x block", block.nVersion));
Line
Count
Source
1172
0
#define strprintf tfm::format
4107
0
    }
4108
4109
0
    return true;
4110
0
}
4111
4112
/** NOTE: This function is not currently invoked by ConnectBlock(), so we
4113
 *  should consider upgrade issues if we change which consensus rules are
4114
 *  enforced in this function (eg by adding a new consensus rule). See comment
4115
 *  in ConnectBlock().
4116
 *  Note that -reindex-chainstate skips the validation that happens here!
4117
 */
4118
static bool ContextualCheckBlock(const CBlock& block, BlockValidationState& state, const ChainstateManager& chainman, const CBlockIndex* pindexPrev)
4119
0
{
4120
0
    const int nHeight = pindexPrev == nullptr ? 0 : pindexPrev->nHeight + 1;
4121
4122
    // Enforce BIP113 (Median Time Past).
4123
0
    bool enforce_locktime_median_time_past{false};
4124
0
    if (DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_CSV)) {
4125
0
        assert(pindexPrev != nullptr);
4126
0
        enforce_locktime_median_time_past = true;
4127
0
    }
4128
4129
0
    const int64_t nLockTimeCutoff{enforce_locktime_median_time_past ?
4130
0
                                      pindexPrev->GetMedianTimePast() :
4131
0
                                      block.GetBlockTime()};
4132
4133
    // Check that all transactions are finalized
4134
0
    for (const auto& tx : block.vtx) {
4135
0
        if (!IsFinalTx(*tx, nHeight, nLockTimeCutoff)) {
4136
0
            return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-nonfinal", "non-final transaction");
4137
0
        }
4138
0
    }
4139
4140
    // Enforce rule that the coinbase starts with serialized block height
4141
0
    if (DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_HEIGHTINCB))
4142
0
    {
4143
0
        CScript expect = CScript() << nHeight;
4144
0
        if (block.vtx[0]->vin[0].scriptSig.size() < expect.size() ||
4145
0
            !std::equal(expect.begin(), expect.end(), block.vtx[0]->vin[0].scriptSig.begin())) {
4146
0
            return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-height", "block height mismatch in coinbase");
4147
0
        }
4148
0
    }
4149
4150
    // Validation for witness commitments.
4151
    // * We compute the witness hash (which is the hash including witnesses) of all the block's transactions, except the
4152
    //   coinbase (where 0x0000....0000 is used instead).
4153
    // * The coinbase scriptWitness is a stack of a single 32-byte vector, containing a witness reserved value (unconstrained).
4154
    // * We build a merkle tree with all those witness hashes as leaves (similar to the hashMerkleRoot in the block header).
4155
    // * There must be at least one output whose scriptPubKey is a single 36-byte push, the first 4 bytes of which are
4156
    //   {0xaa, 0x21, 0xa9, 0xed}, and the following 32 bytes are SHA256^2(witness root, witness reserved value). In case there are
4157
    //   multiple, the last one is used.
4158
0
    if (!CheckWitnessMalleation(block, DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_SEGWIT), state)) {
4159
0
        return false;
4160
0
    }
4161
4162
    // After the coinbase witness reserved value and commitment are verified,
4163
    // we can check if the block weight passes (before we've checked the
4164
    // coinbase witness, it would be possible for the weight to be too
4165
    // large by filling up the coinbase witness, which doesn't change
4166
    // the block hash, so we couldn't mark the block as permanently
4167
    // failed).
4168
0
    if (GetBlockWeight(block) > MAX_BLOCK_WEIGHT) {
4169
0
        return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-weight", strprintf("%s : weight limit failed", __func__));
Line
Count
Source
1172
0
#define strprintf tfm::format
4170
0
    }
4171
4172
0
    return true;
4173
0
}
4174
4175
bool ChainstateManager::AcceptBlockHeader(const CBlockHeader& block, BlockValidationState& state, CBlockIndex** ppindex, bool min_pow_checked)
4176
0
{
4177
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4178
4179
    // Check for duplicate
4180
0
    uint256 hash = block.GetHash();
4181
0
    BlockMap::iterator miSelf{m_blockman.m_block_index.find(hash)};
4182
0
    if (hash != GetConsensus().hashGenesisBlock) {
4183
0
        if (miSelf != m_blockman.m_block_index.end()) {
4184
            // Block header is already known.
4185
0
            CBlockIndex* pindex = &(miSelf->second);
4186
0
            if (ppindex)
4187
0
                *ppindex = pindex;
4188
0
            if (pindex->nStatus & BLOCK_FAILED_VALID) {
4189
0
                LogDebug(BCLog::VALIDATION, "%s: block %s is marked invalid\n", __func__, hash.ToString());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
4190
0
                return state.Invalid(BlockValidationResult::BLOCK_CACHED_INVALID, "duplicate-invalid",
4191
0
                                     strprintf("block %s was previously marked invalid", hash.ToString()));
Line
Count
Source
1172
0
#define strprintf tfm::format
4192
0
            }
4193
0
            return true;
4194
0
        }
4195
4196
0
        if (!CheckBlockHeader(block, state, GetConsensus())) {
4197
0
            LogDebug(BCLog::VALIDATION, "%s: Consensus::CheckBlockHeader: %s, %s\n", __func__, hash.ToString(), state.ToString());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
4198
0
            return false;
4199
0
        }
4200
4201
        // Get prev block index
4202
0
        CBlockIndex* pindexPrev = nullptr;
4203
0
        BlockMap::iterator mi{m_blockman.m_block_index.find(block.hashPrevBlock)};
4204
0
        if (mi == m_blockman.m_block_index.end()) {
4205
0
            LogDebug(BCLog::VALIDATION, "header %s has prev block not found: %s\n", hash.ToString(), block.hashPrevBlock.ToString());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
4206
0
            return state.Invalid(BlockValidationResult::BLOCK_MISSING_PREV, "prev-blk-not-found");
4207
0
        }
4208
0
        pindexPrev = &((*mi).second);
4209
0
        if (pindexPrev->nStatus & BLOCK_FAILED_VALID) {
4210
0
            LogDebug(BCLog::VALIDATION, "header %s has prev block invalid: %s\n", hash.ToString(), block.hashPrevBlock.ToString());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
4211
0
            return state.Invalid(BlockValidationResult::BLOCK_INVALID_PREV, "bad-prevblk");
4212
0
        }
4213
0
        if (!ContextualCheckBlockHeader(block, state, *this, pindexPrev)) {
4214
0
            LogDebug(BCLog::VALIDATION, "%s: Consensus::ContextualCheckBlockHeader: %s, %s\n", __func__, hash.ToString(), state.ToString());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
4215
0
            return false;
4216
0
        }
4217
0
    }
4218
0
    if (!min_pow_checked) {
4219
0
        LogDebug(BCLog::VALIDATION, "%s: not adding new block header %s, missing anti-dos proof-of-work validation\n", __func__, hash.ToString());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
4220
0
        return state.Invalid(BlockValidationResult::BLOCK_HEADER_LOW_WORK, "too-little-chainwork");
4221
0
    }
4222
0
    CBlockIndex* pindex{m_blockman.AddToBlockIndex(block, m_best_header)};
4223
4224
0
    if (ppindex)
4225
0
        *ppindex = pindex;
4226
4227
0
    return true;
4228
0
}
4229
4230
// Exposed wrapper for AcceptBlockHeader
4231
bool ChainstateManager::ProcessNewBlockHeaders(std::span<const CBlockHeader> headers, bool min_pow_checked, BlockValidationState& state, const CBlockIndex** ppindex)
4232
0
{
4233
0
    AssertLockNotHeld(cs_main);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
4234
0
    {
4235
0
        LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
4236
0
        for (const CBlockHeader& header : headers) {
4237
0
            CBlockIndex *pindex = nullptr; // Use a temp pindex instead of ppindex to avoid a const_cast
4238
0
            bool accepted{AcceptBlockHeader(header, state, &pindex, min_pow_checked)};
4239
0
            CheckBlockIndex();
4240
4241
0
            if (!accepted) {
4242
0
                return false;
4243
0
            }
4244
0
            if (ppindex) {
4245
0
                *ppindex = pindex;
4246
0
            }
4247
0
        }
4248
0
    }
4249
0
    if (NotifyHeaderTip()) {
4250
0
        if (IsInitialBlockDownload() && ppindex && *ppindex) {
4251
0
            const CBlockIndex& last_accepted{**ppindex};
4252
0
            int64_t blocks_left{(NodeClock::now() - last_accepted.Time()) / GetConsensus().PowTargetSpacing()};
4253
0
            blocks_left = std::max<int64_t>(0, blocks_left);
4254
0
            const double progress{100.0 * last_accepted.nHeight / (last_accepted.nHeight + blocks_left)};
4255
0
            LogInfo("Synchronizing blockheaders, height: %d (~%.2f%%)\n", last_accepted.nHeight, progress);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4256
0
        }
4257
0
    }
4258
0
    return true;
4259
0
}
4260
4261
void ChainstateManager::ReportHeadersPresync(int64_t height, int64_t timestamp)
4262
0
{
4263
0
    AssertLockNotHeld(GetMutex());
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
4264
0
    {
4265
0
        LOCK(GetMutex());
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
4266
        // Don't report headers presync progress if we already have a post-minchainwork header chain.
4267
        // This means we lose reporting for potentially legitimate, but unlikely, deep reorgs, but
4268
        // prevent attackers that spam low-work headers from filling our logs.
4269
0
        if (m_best_header->nChainWork >= UintToArith256(GetConsensus().nMinimumChainWork)) return;
4270
        // Rate limit headers presync updates to 4 per second, as these are not subject to DoS
4271
        // protection.
4272
0
        auto now = MockableSteadyClock::now();
4273
0
        if (now < m_last_presync_update + std::chrono::milliseconds{250}) return;
4274
0
        m_last_presync_update = now;
4275
0
    }
4276
0
    bool initial_download = IsInitialBlockDownload();
4277
0
    GetNotifications().headerTip(GetSynchronizationState(initial_download, m_blockman.m_blockfiles_indexed), height, timestamp, /*presync=*/true);
4278
0
    if (initial_download) {
4279
0
        int64_t blocks_left{(NodeClock::now() - NodeSeconds{std::chrono::seconds{timestamp}}) / GetConsensus().PowTargetSpacing()};
4280
0
        blocks_left = std::max<int64_t>(0, blocks_left);
4281
0
        const double progress{100.0 * height / (height + blocks_left)};
4282
0
        LogInfo("Pre-synchronizing blockheaders, height: %d (~%.2f%%)\n", height, progress);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4283
0
    }
4284
0
}
4285
4286
/** Store block on disk. If dbp is non-nullptr, the file is known to already reside on disk */
4287
bool ChainstateManager::AcceptBlock(const std::shared_ptr<const CBlock>& pblock, BlockValidationState& state, CBlockIndex** ppindex, bool fRequested, const FlatFilePos* dbp, bool* fNewBlock, bool min_pow_checked)
4288
0
{
4289
0
    const CBlock& block = *pblock;
4290
4291
0
    if (fNewBlock) *fNewBlock = false;
4292
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4293
4294
0
    CBlockIndex *pindexDummy = nullptr;
4295
0
    CBlockIndex *&pindex = ppindex ? *ppindex : pindexDummy;
4296
4297
0
    bool accepted_header{AcceptBlockHeader(block, state, &pindex, min_pow_checked)};
4298
0
    CheckBlockIndex();
4299
4300
0
    if (!accepted_header)
4301
0
        return false;
4302
4303
    // Check all requested blocks that we do not already have for validity and
4304
    // save them to disk. Skip processing of unrequested blocks as an anti-DoS
4305
    // measure, unless the blocks have more work than the active chain tip, and
4306
    // aren't too far ahead of it, so are likely to be attached soon.
4307
0
    bool fAlreadyHave = pindex->nStatus & BLOCK_HAVE_DATA;
4308
0
    bool fHasMoreOrSameWork = (ActiveTip() ? pindex->nChainWork >= ActiveTip()->nChainWork : true);
4309
    // Blocks that are too out-of-order needlessly limit the effectiveness of
4310
    // pruning, because pruning will not delete block files that contain any
4311
    // blocks which are too close in height to the tip.  Apply this test
4312
    // regardless of whether pruning is enabled; it should generally be safe to
4313
    // not process unrequested blocks.
4314
0
    bool fTooFarAhead{pindex->nHeight > ActiveHeight() + int(MIN_BLOCKS_TO_KEEP)};
4315
4316
    // TODO: Decouple this function from the block download logic by removing fRequested
4317
    // This requires some new chain data structure to efficiently look up if a
4318
    // block is in a chain leading to a candidate for best tip, despite not
4319
    // being such a candidate itself.
4320
    // Note that this would break the getblockfrompeer RPC
4321
4322
    // TODO: deal better with return value and error conditions for duplicate
4323
    // and unrequested blocks.
4324
0
    if (fAlreadyHave) return true;
4325
0
    if (!fRequested) {  // If we didn't ask for it:
4326
0
        if (pindex->nTx != 0) return true;    // This is a previously-processed block that was pruned
4327
0
        if (!fHasMoreOrSameWork) return true; // Don't process less-work chains
4328
0
        if (fTooFarAhead) return true;        // Block height is too high
4329
4330
        // Protect against DoS attacks from low-work chains.
4331
        // If our tip is behind, a peer could try to send us
4332
        // low-work blocks on a fake chain that we would never
4333
        // request; don't process these.
4334
0
        if (pindex->nChainWork < MinimumChainWork()) return true;
4335
0
    }
4336
4337
0
    const CChainParams& params{GetParams()};
4338
4339
0
    if (!CheckBlock(block, state, params.GetConsensus()) ||
4340
0
        !ContextualCheckBlock(block, state, *this, pindex->pprev)) {
4341
0
        if (Assume(state.IsInvalid())) {
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
4342
0
            ActiveChainstate().InvalidBlockFound(pindex, state);
4343
0
        }
4344
0
        LogError("%s: %s\n", __func__, state.ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4345
0
        return false;
4346
0
    }
4347
4348
    // Header is valid/has work, merkle tree and segwit merkle tree are good...RELAY NOW
4349
    // (but if it does not build on our best tip, let the SendMessages loop relay it)
4350
0
    if (!IsInitialBlockDownload() && ActiveTip() == pindex->pprev && m_options.signals) {
4351
0
        m_options.signals->NewPoWValidBlock(pindex, pblock);
4352
0
    }
4353
4354
    // Write block to history file
4355
0
    if (fNewBlock) *fNewBlock = true;
4356
0
    try {
4357
0
        FlatFilePos blockPos{};
4358
0
        if (dbp) {
4359
0
            blockPos = *dbp;
4360
0
            m_blockman.UpdateBlockInfo(block, pindex->nHeight, blockPos);
4361
0
        } else {
4362
0
            blockPos = m_blockman.WriteBlock(block, pindex->nHeight);
4363
0
            if (blockPos.IsNull()) {
4364
0
                state.Error(strprintf("%s: Failed to find position to write new block to disk", __func__));
Line
Count
Source
1172
0
#define strprintf tfm::format
4365
0
                return false;
4366
0
            }
4367
0
        }
4368
0
        ReceivedBlockTransactions(block, pindex, blockPos);
4369
0
    } catch (const std::runtime_error& e) {
4370
0
        return FatalError(GetNotifications(), state, strprintf(_("System error while saving block to disk: %s"), e.what()));
Line
Count
Source
1172
0
#define strprintf tfm::format
4371
0
    }
4372
4373
    // TODO: FlushStateToDisk() handles flushing of both block and chainstate
4374
    // data, so we should move this to ChainstateManager so that we can be more
4375
    // intelligent about how we flush.
4376
    // For now, since FlushStateMode::NONE is used, all that can happen is that
4377
    // the block files may be pruned, so we can just call this on one
4378
    // chainstate (particularly if we haven't implemented pruning with
4379
    // background validation yet).
4380
0
    ActiveChainstate().FlushStateToDisk(state, FlushStateMode::NONE);
4381
4382
0
    CheckBlockIndex();
4383
4384
0
    return true;
4385
0
}
4386
4387
bool ChainstateManager::ProcessNewBlock(const std::shared_ptr<const CBlock>& block, bool force_processing, bool min_pow_checked, bool* new_block)
4388
0
{
4389
0
    AssertLockNotHeld(cs_main);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
4390
4391
0
    {
4392
0
        CBlockIndex *pindex = nullptr;
4393
0
        if (new_block) *new_block = false;
4394
0
        BlockValidationState state;
4395
4396
        // CheckBlock() does not support multi-threaded block validation because CBlock::fChecked can cause data race.
4397
        // Therefore, the following critical section must include the CheckBlock() call as well.
4398
0
        LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
4399
4400
        // Skipping AcceptBlock() for CheckBlock() failures means that we will never mark a block as invalid if
4401
        // CheckBlock() fails.  This is protective against consensus failure if there are any unknown forms of block
4402
        // malleability that cause CheckBlock() to fail; see e.g. CVE-2012-2459 and
4403
        // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2019-February/016697.html.  Because CheckBlock() is
4404
        // not very expensive, the anti-DoS benefits of caching failure (of a definitely-invalid block) are not substantial.
4405
0
        bool ret = CheckBlock(*block, state, GetConsensus());
4406
0
        if (ret) {
4407
            // Store to disk
4408
0
            ret = AcceptBlock(block, state, &pindex, force_processing, nullptr, new_block, min_pow_checked);
4409
0
        }
4410
0
        if (!ret) {
4411
0
            if (m_options.signals) {
4412
0
                m_options.signals->BlockChecked(block, state);
4413
0
            }
4414
0
            LogError("%s: AcceptBlock FAILED (%s)\n", __func__, state.ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4415
0
            return false;
4416
0
        }
4417
0
    }
4418
4419
0
    NotifyHeaderTip();
4420
4421
0
    BlockValidationState state; // Only used to report errors, not invalidity - ignore it
4422
0
    if (!ActiveChainstate().ActivateBestChain(state, block)) {
4423
0
        LogError("%s: ActivateBestChain failed (%s)\n", __func__, state.ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4424
0
        return false;
4425
0
    }
4426
4427
0
    Chainstate* bg_chain{WITH_LOCK(cs_main, return HistoricalChainstate())};
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
4428
0
    BlockValidationState bg_state;
4429
0
    if (bg_chain && !bg_chain->ActivateBestChain(bg_state, block)) {
4430
0
        LogError("%s: [background] ActivateBestChain failed (%s)\n", __func__, bg_state.ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4431
0
        return false;
4432
0
     }
4433
4434
0
    return true;
4435
0
}
4436
4437
MempoolAcceptResult ChainstateManager::ProcessTransaction(const CTransactionRef& tx, bool test_accept)
4438
0
{
4439
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4440
0
    Chainstate& active_chainstate = ActiveChainstate();
4441
0
    if (!active_chainstate.GetMempool()) {
4442
0
        TxValidationState state;
4443
0
        state.Invalid(TxValidationResult::TX_NO_MEMPOOL, "no-mempool");
4444
0
        return MempoolAcceptResult::Failure(state);
4445
0
    }
4446
0
    auto result = AcceptToMemoryPool(active_chainstate, tx, GetTime(), /*bypass_limits=*/ false, test_accept);
4447
0
    active_chainstate.GetMempool()->check(active_chainstate.CoinsTip(), active_chainstate.m_chain.Height() + 1);
4448
0
    return result;
4449
0
}
4450
4451
4452
BlockValidationState TestBlockValidity(
4453
    Chainstate& chainstate,
4454
    const CBlock& block,
4455
    const bool check_pow,
4456
    const bool check_merkle_root)
4457
0
{
4458
    // Lock must be held throughout this function for two reasons:
4459
    // 1. We don't want the tip to change during several of the validation steps
4460
    // 2. To prevent a CheckBlock() race condition for fChecked, see ProcessNewBlock()
4461
0
    AssertLockHeld(chainstate.m_chainman.GetMutex());
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4462
4463
0
    BlockValidationState state;
4464
0
    CBlockIndex* tip{Assert(chainstate.m_chain.Tip())};
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
4465
4466
0
    if (block.hashPrevBlock != *Assert(tip->phashBlock)) {
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
4467
0
        state.Invalid({}, "inconclusive-not-best-prevblk");
4468
0
        return state;
4469
0
    }
4470
4471
    // For signets CheckBlock() verifies the challenge iff fCheckPow is set.
4472
0
    if (!CheckBlock(block, state, chainstate.m_chainman.GetConsensus(), /*fCheckPow=*/check_pow, /*fCheckMerkleRoot=*/check_merkle_root)) {
4473
        // This should never happen, but belt-and-suspenders don't approve the
4474
        // block if it does.
4475
0
        if (state.IsValid()) NONFATAL_UNREACHABLE();
Line
Count
Source
134
0
    throw NonFatalCheckError { "Unreachable code reached (non-fatal)", std::source_location::current() }
4476
0
        return state;
4477
0
    }
4478
4479
    /**
4480
     * At this point ProcessNewBlock would call AcceptBlock(), but we
4481
     * don't want to store the block or its header. Run individual checks
4482
     * instead:
4483
     * - skip AcceptBlockHeader() because:
4484
     *   - we don't want to update the block index
4485
     *   - we do not care about duplicates
4486
     *   - we already ran CheckBlockHeader() via CheckBlock()
4487
     *   - we already checked for prev-blk-not-found
4488
     *   - we know the tip is valid, so no need to check bad-prevblk
4489
     * - we already ran CheckBlock()
4490
     * - do run ContextualCheckBlockHeader()
4491
     * - do run ContextualCheckBlock()
4492
     */
4493
4494
0
    if (!ContextualCheckBlockHeader(block, state, chainstate.m_chainman, tip)) {
4495
0
        if (state.IsValid()) NONFATAL_UNREACHABLE();
Line
Count
Source
134
0
    throw NonFatalCheckError { "Unreachable code reached (non-fatal)", std::source_location::current() }
4496
0
        return state;
4497
0
    }
4498
4499
0
    if (!ContextualCheckBlock(block, state, chainstate.m_chainman, tip)) {
4500
0
        if (state.IsValid()) NONFATAL_UNREACHABLE();
Line
Count
Source
134
0
    throw NonFatalCheckError { "Unreachable code reached (non-fatal)", std::source_location::current() }
4501
0
        return state;
4502
0
    }
4503
4504
    // We don't want ConnectBlock to update the actual chainstate, so create
4505
    // a cache on top of it, along with a dummy block index.
4506
0
    CBlockIndex index_dummy{block};
4507
0
    uint256 block_hash(block.GetHash());
4508
0
    index_dummy.pprev = tip;
4509
0
    index_dummy.nHeight = tip->nHeight + 1;
4510
0
    index_dummy.phashBlock = &block_hash;
4511
0
    CCoinsViewCache view_dummy(&chainstate.CoinsTip());
4512
4513
    // Set fJustCheck to true in order to update, and not clear, validation caches.
4514
0
    if(!chainstate.ConnectBlock(block, state, &index_dummy, view_dummy, /*fJustCheck=*/true)) {
4515
0
        if (state.IsValid()) NONFATAL_UNREACHABLE();
Line
Count
Source
134
0
    throw NonFatalCheckError { "Unreachable code reached (non-fatal)", std::source_location::current() }
4516
0
        return state;
4517
0
    }
4518
4519
    // Ensure no check returned successfully while also setting an invalid state.
4520
0
    if (!state.IsValid()) NONFATAL_UNREACHABLE();
Line
Count
Source
134
0
    throw NonFatalCheckError { "Unreachable code reached (non-fatal)", std::source_location::current() }
4521
4522
0
    return state;
4523
0
}
4524
4525
/* This function is called from the RPC code for pruneblockchain */
4526
void PruneBlockFilesManual(Chainstate& active_chainstate, int nManualPruneHeight)
4527
0
{
4528
0
    BlockValidationState state;
4529
0
    if (!active_chainstate.FlushStateToDisk(
4530
0
            state, FlushStateMode::NONE, nManualPruneHeight)) {
4531
0
        LogWarning("Failed to flush state after manual prune (%s)", state.ToString());
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4532
0
    }
4533
0
}
4534
4535
bool Chainstate::LoadChainTip()
4536
0
{
4537
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4538
0
    const CCoinsViewCache& coins_cache = CoinsTip();
4539
0
    assert(!coins_cache.GetBestBlock().IsNull()); // Never called when the coins view is empty
4540
0
    CBlockIndex* tip = m_chain.Tip();
4541
4542
0
    if (tip && tip->GetBlockHash() == coins_cache.GetBestBlock()) {
4543
0
        return true;
4544
0
    }
4545
4546
    // Load pointer to end of best chain
4547
0
    CBlockIndex* pindex = m_blockman.LookupBlockIndex(coins_cache.GetBestBlock());
4548
0
    if (!pindex) {
4549
0
        return false;
4550
0
    }
4551
0
    m_chain.SetTip(*pindex);
4552
0
    m_chainman.UpdateIBDStatus();
4553
0
    tip = m_chain.Tip();
4554
4555
    // nSequenceId is one of the keys used to sort setBlockIndexCandidates. Ensure all
4556
    // candidate sets are empty to avoid UB, as nSequenceId is about to be modified.
4557
0
    for (const auto& cs : m_chainman.m_chainstates) {
4558
0
        assert(cs->setBlockIndexCandidates.empty());
4559
0
    }
4560
4561
    // Make sure our chain tip before shutting down scores better than any other candidate
4562
    // to maintain a consistent best tip over reboots in case of a tie.
4563
0
    auto target = tip;
4564
0
    while (target) {
4565
0
        target->nSequenceId = SEQ_ID_BEST_CHAIN_FROM_DISK;
4566
0
        target = target->pprev;
4567
0
    }
4568
4569
0
    LogInfo("Loaded best chain: hashBestChain=%s height=%d date=%s progress=%f",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4570
0
              tip->GetBlockHash().ToString(),
4571
0
              m_chain.Height(),
4572
0
              FormatISO8601DateTime(tip->GetBlockTime()),
4573
0
              m_chainman.GuessVerificationProgress(tip));
4574
4575
    // Ensure KernelNotifications m_tip_block is set even if no new block arrives.
4576
0
    if (!this->GetRole().historical) {
4577
        // Ignoring return value for now.
4578
0
        (void)m_chainman.GetNotifications().blockTip(
4579
0
            /*state=*/GetSynchronizationState(/*init=*/true, m_chainman.m_blockman.m_blockfiles_indexed),
4580
0
            /*index=*/*pindex,
4581
0
            /*verification_progress=*/m_chainman.GuessVerificationProgress(tip));
4582
0
    }
4583
4584
0
    CheckForkWarningConditions();
4585
4586
0
    return true;
4587
0
}
4588
4589
CVerifyDB::CVerifyDB(Notifications& notifications)
4590
0
    : m_notifications{notifications}
4591
0
{
4592
0
    m_notifications.progress(_("Verifying blocks…"), 0, false);
4593
0
}
4594
4595
CVerifyDB::~CVerifyDB()
4596
0
{
4597
0
    m_notifications.progress(bilingual_str{}, 100, false);
4598
0
}
4599
4600
VerifyDBResult CVerifyDB::VerifyDB(
4601
    Chainstate& chainstate,
4602
    const Consensus::Params& consensus_params,
4603
    CCoinsView& coinsview,
4604
    int nCheckLevel, int nCheckDepth)
4605
0
{
4606
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4607
4608
0
    if (chainstate.m_chain.Tip() == nullptr || chainstate.m_chain.Tip()->pprev == nullptr) {
4609
0
        return VerifyDBResult::SUCCESS;
4610
0
    }
4611
4612
    // Verify blocks in the best chain
4613
0
    if (nCheckDepth <= 0 || nCheckDepth > chainstate.m_chain.Height()) {
4614
0
        nCheckDepth = chainstate.m_chain.Height();
4615
0
    }
4616
0
    nCheckLevel = std::max(0, std::min(4, nCheckLevel));
4617
0
    LogInfo("Verifying last %i blocks at level %i", nCheckDepth, nCheckLevel);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4618
0
    CCoinsViewCache coins(&coinsview);
4619
0
    CBlockIndex* pindex;
4620
0
    CBlockIndex* pindexFailure = nullptr;
4621
0
    int nGoodTransactions = 0;
4622
0
    BlockValidationState state;
4623
0
    int reportDone = 0;
4624
0
    bool skipped_no_block_data{false};
4625
0
    bool skipped_l3_checks{false};
4626
0
    LogInfo("Verification progress: 0%%");
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4627
4628
0
    const bool is_snapshot_cs{chainstate.m_from_snapshot_blockhash};
4629
4630
0
    for (pindex = chainstate.m_chain.Tip(); pindex && pindex->pprev; pindex = pindex->pprev) {
4631
0
        const int percentageDone = std::max(1, std::min(99, (int)(((double)(chainstate.m_chain.Height() - pindex->nHeight)) / (double)nCheckDepth * (nCheckLevel >= 4 ? 50 : 100))));
4632
0
        if (reportDone < percentageDone / 10) {
4633
            // report every 10% step
4634
0
            LogInfo("Verification progress: %d%%", percentageDone);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4635
0
            reportDone = percentageDone / 10;
4636
0
        }
4637
0
        m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
4638
0
        if (pindex->nHeight <= chainstate.m_chain.Height() - nCheckDepth) {
4639
0
            break;
4640
0
        }
4641
0
        if ((chainstate.m_blockman.IsPruneMode() || is_snapshot_cs) && !(pindex->nStatus & BLOCK_HAVE_DATA)) {
4642
            // If pruning or running under an assumeutxo snapshot, only go
4643
            // back as far as we have data.
4644
0
            LogInfo("Block verification stopping at height %d (no data). This could be due to pruning or use of an assumeutxo snapshot.", pindex->nHeight);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4645
0
            skipped_no_block_data = true;
4646
0
            break;
4647
0
        }
4648
0
        CBlock block;
4649
        // check level 0: read from disk
4650
0
        if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
4651
0
            LogError("Verification error: ReadBlock failed at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4652
0
            return VerifyDBResult::CORRUPTED_BLOCK_DB;
4653
0
        }
4654
        // check level 1: verify block validity
4655
0
        if (nCheckLevel >= 1 && !CheckBlock(block, state, consensus_params)) {
4656
0
            LogError("Verification error: found bad block at %d, hash=%s (%s)",
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4657
0
                      pindex->nHeight, pindex->GetBlockHash().ToString(), state.ToString());
4658
0
            return VerifyDBResult::CORRUPTED_BLOCK_DB;
4659
0
        }
4660
        // check level 2: verify undo validity
4661
0
        if (nCheckLevel >= 2 && pindex) {
4662
0
            CBlockUndo undo;
4663
0
            if (!pindex->GetUndoPos().IsNull()) {
4664
0
                if (!chainstate.m_blockman.ReadBlockUndo(undo, *pindex)) {
4665
0
                    LogError("Verification error: found bad undo data at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4666
0
                    return VerifyDBResult::CORRUPTED_BLOCK_DB;
4667
0
                }
4668
0
            }
4669
0
        }
4670
        // check level 3: check for inconsistencies during memory-only disconnect of tip blocks
4671
0
        size_t curr_coins_usage = coins.DynamicMemoryUsage() + chainstate.CoinsTip().DynamicMemoryUsage();
4672
4673
0
        if (nCheckLevel >= 3) {
4674
0
            if (curr_coins_usage <= chainstate.m_coinstip_cache_size_bytes) {
4675
0
                assert(coins.GetBestBlock() == pindex->GetBlockHash());
4676
0
                DisconnectResult res = chainstate.DisconnectBlock(block, pindex, coins);
4677
0
                if (res == DISCONNECT_FAILED) {
4678
0
                    LogError("Verification error: irrecoverable inconsistency in block data at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4679
0
                    return VerifyDBResult::CORRUPTED_BLOCK_DB;
4680
0
                }
4681
0
                if (res == DISCONNECT_UNCLEAN) {
4682
0
                    nGoodTransactions = 0;
4683
0
                    pindexFailure = pindex;
4684
0
                } else {
4685
0
                    nGoodTransactions += block.vtx.size();
4686
0
                }
4687
0
            } else {
4688
0
                skipped_l3_checks = true;
4689
0
            }
4690
0
        }
4691
0
        if (chainstate.m_chainman.m_interrupt) return VerifyDBResult::INTERRUPTED;
4692
0
    }
4693
0
    if (pindexFailure) {
4694
0
        LogError("Verification error: coin database inconsistencies found (last %i blocks, %i good transactions before that)", chainstate.m_chain.Height() - pindexFailure->nHeight + 1, nGoodTransactions);
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4695
0
        return VerifyDBResult::CORRUPTED_BLOCK_DB;
4696
0
    }
4697
0
    if (skipped_l3_checks) {
4698
0
        LogWarning("Skipped verification of level >=3 (insufficient database cache size). Consider increasing -dbcache.");
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4699
0
    }
4700
4701
    // store block count as we move pindex at check level >= 4
4702
0
    int block_count = chainstate.m_chain.Height() - pindex->nHeight;
4703
4704
    // check level 4: try reconnecting blocks
4705
0
    if (nCheckLevel >= 4 && !skipped_l3_checks) {
4706
0
        while (pindex != chainstate.m_chain.Tip()) {
4707
0
            const int percentageDone = std::max(1, std::min(99, 100 - (int)(((double)(chainstate.m_chain.Height() - pindex->nHeight)) / (double)nCheckDepth * 50)));
4708
0
            if (reportDone < percentageDone / 10) {
4709
                // report every 10% step
4710
0
                LogInfo("Verification progress: %d%%", percentageDone);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4711
0
                reportDone = percentageDone / 10;
4712
0
            }
4713
0
            m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
4714
0
            pindex = chainstate.m_chain.Next(pindex);
4715
0
            CBlock block;
4716
0
            if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
4717
0
                LogError("Verification error: ReadBlock failed at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4718
0
                return VerifyDBResult::CORRUPTED_BLOCK_DB;
4719
0
            }
4720
0
            if (!chainstate.ConnectBlock(block, state, pindex, coins)) {
4721
0
                LogError("Verification error: found unconnectable block at %d, hash=%s (%s)", pindex->nHeight, pindex->GetBlockHash().ToString(), state.ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4722
0
                return VerifyDBResult::CORRUPTED_BLOCK_DB;
4723
0
            }
4724
0
            if (chainstate.m_chainman.m_interrupt) return VerifyDBResult::INTERRUPTED;
4725
0
        }
4726
0
    }
4727
4728
0
    LogInfo("Verification: No coin database inconsistencies in last %i blocks (%i transactions)", block_count, nGoodTransactions);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4729
4730
0
    if (skipped_l3_checks) {
4731
0
        return VerifyDBResult::SKIPPED_L3_CHECKS;
4732
0
    }
4733
0
    if (skipped_no_block_data) {
4734
0
        return VerifyDBResult::SKIPPED_MISSING_BLOCKS;
4735
0
    }
4736
0
    return VerifyDBResult::SUCCESS;
4737
0
}
4738
4739
/** Apply the effects of a block on the utxo cache, ignoring that it may already have been applied. */
4740
bool Chainstate::RollforwardBlock(const CBlockIndex* pindex, CCoinsViewCache& inputs)
4741
0
{
4742
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4743
    // TODO: merge with ConnectBlock
4744
0
    CBlock block;
4745
0
    if (!m_blockman.ReadBlock(block, *pindex)) {
4746
0
        LogError("ReplayBlock(): ReadBlock failed at %d, hash=%s\n", pindex->nHeight, pindex->GetBlockHash().ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4747
0
        return false;
4748
0
    }
4749
4750
0
    for (const CTransactionRef& tx : block.vtx) {
4751
0
        if (!tx->IsCoinBase()) {
4752
0
            for (const CTxIn &txin : tx->vin) {
4753
0
                inputs.SpendCoin(txin.prevout);
4754
0
            }
4755
0
        }
4756
        // Pass check = true as every addition may be an overwrite.
4757
0
        AddCoins(inputs, *tx, pindex->nHeight, true);
4758
0
    }
4759
0
    return true;
4760
0
}
4761
4762
bool Chainstate::ReplayBlocks()
4763
0
{
4764
0
    LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
4765
4766
0
    CCoinsView& db = this->CoinsDB();
4767
0
    CCoinsViewCache cache(&db);
4768
4769
0
    std::vector<uint256> hashHeads = db.GetHeadBlocks();
4770
0
    if (hashHeads.empty()) return true; // We're already in a consistent state.
4771
0
    if (hashHeads.size() != 2) {
4772
0
        LogError("ReplayBlocks(): unknown inconsistent state\n");
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4773
0
        return false;
4774
0
    }
4775
4776
0
    m_chainman.GetNotifications().progress(_("Replaying blocks…"), 0, false);
4777
0
    LogInfo("Replaying blocks");
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4778
4779
0
    const CBlockIndex* pindexOld = nullptr;  // Old tip during the interrupted flush.
4780
0
    const CBlockIndex* pindexNew;            // New tip during the interrupted flush.
4781
0
    const CBlockIndex* pindexFork = nullptr; // Latest block common to both the old and the new tip.
4782
4783
0
    if (!m_blockman.m_block_index.contains(hashHeads[0])) {
4784
0
        LogError("ReplayBlocks(): reorganization to unknown block requested\n");
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4785
0
        return false;
4786
0
    }
4787
0
    pindexNew = &(m_blockman.m_block_index[hashHeads[0]]);
4788
4789
0
    if (!hashHeads[1].IsNull()) { // The old tip is allowed to be 0, indicating it's the first flush.
4790
0
        if (!m_blockman.m_block_index.contains(hashHeads[1])) {
4791
0
            LogError("ReplayBlocks(): reorganization from unknown block requested\n");
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4792
0
            return false;
4793
0
        }
4794
0
        pindexOld = &(m_blockman.m_block_index[hashHeads[1]]);
4795
0
        pindexFork = LastCommonAncestor(pindexOld, pindexNew);
4796
0
        assert(pindexFork != nullptr);
4797
0
    }
4798
4799
    // Rollback along the old branch.
4800
0
    const int nForkHeight{pindexFork ? pindexFork->nHeight : 0};
4801
0
    if (pindexOld != pindexFork) {
4802
0
        LogInfo("Rolling back from %s (%i to %i)", pindexOld->GetBlockHash().ToString(), pindexOld->nHeight, nForkHeight);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4803
0
        while (pindexOld != pindexFork) {
4804
0
            if (pindexOld->nHeight > 0) { // Never disconnect the genesis block.
4805
0
                CBlock block;
4806
0
                if (!m_blockman.ReadBlock(block, *pindexOld)) {
4807
0
                    LogError("RollbackBlock(): ReadBlock() failed at %d, hash=%s\n", pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4808
0
                    return false;
4809
0
                }
4810
0
                if (pindexOld->nHeight % 10'000 == 0) {
4811
0
                    LogInfo("Rolling back %s (%i)", pindexOld->GetBlockHash().ToString(), pindexOld->nHeight);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4812
0
                }
4813
0
                DisconnectResult res = DisconnectBlock(block, pindexOld, cache);
4814
0
                if (res == DISCONNECT_FAILED) {
4815
0
                    LogError("RollbackBlock(): DisconnectBlock failed at %d, hash=%s\n", pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4816
0
                    return false;
4817
0
                }
4818
                // If DISCONNECT_UNCLEAN is returned, it means a non-existing UTXO was deleted, or an existing UTXO was
4819
                // overwritten. It corresponds to cases where the block-to-be-disconnect never had all its operations
4820
                // applied to the UTXO set. However, as both writing a UTXO and deleting a UTXO are idempotent operations,
4821
                // the result is still a version of the UTXO set with the effects of that block undone.
4822
0
            }
4823
0
            pindexOld = pindexOld->pprev;
4824
0
        }
4825
0
        LogInfo("Rolled back to %s", pindexFork->GetBlockHash().ToString());
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4826
0
    }
4827
4828
    // Roll forward from the forking point to the new tip.
4829
0
    if (nForkHeight < pindexNew->nHeight) {
4830
0
        LogInfo("Rolling forward to %s (%i to %i)", pindexNew->GetBlockHash().ToString(), nForkHeight, pindexNew->nHeight);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4831
0
        for (int nHeight = nForkHeight + 1; nHeight <= pindexNew->nHeight; ++nHeight) {
4832
0
            const CBlockIndex& pindex{*Assert(pindexNew->GetAncestor(nHeight))};
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
4833
4834
0
            if (nHeight % 10'000 == 0) {
4835
0
                LogInfo("Rolling forward %s (%i)", pindex.GetBlockHash().ToString(), nHeight);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4836
0
            }
4837
0
            m_chainman.GetNotifications().progress(_("Replaying blocks…"), (int)((nHeight - nForkHeight) * 100.0 / (pindexNew->nHeight - nForkHeight)), false);
4838
0
            if (!RollforwardBlock(&pindex, cache)) return false;
4839
0
        }
4840
0
        LogInfo("Rolled forward to %s", pindexNew->GetBlockHash().ToString());
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4841
0
    }
4842
4843
0
    cache.SetBestBlock(pindexNew->GetBlockHash());
4844
0
    cache.Flush(/*reallocate_cache=*/false); // local CCoinsViewCache goes out of scope
4845
0
    m_chainman.GetNotifications().progress(bilingual_str{}, 100, false);
4846
0
    return true;
4847
0
}
4848
4849
bool Chainstate::NeedsRedownload() const
4850
0
{
4851
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4852
4853
    // At and above m_params.SegwitHeight, segwit consensus rules must be validated
4854
0
    CBlockIndex* block{m_chain.Tip()};
4855
4856
0
    while (block != nullptr && DeploymentActiveAt(*block, m_chainman, Consensus::DEPLOYMENT_SEGWIT)) {
4857
0
        if (!(block->nStatus & BLOCK_OPT_WITNESS)) {
4858
            // block is insufficiently validated for a segwit client
4859
0
            return true;
4860
0
        }
4861
0
        block = block->pprev;
4862
0
    }
4863
4864
0
    return false;
4865
0
}
4866
4867
void Chainstate::ClearBlockIndexCandidates()
4868
0
{
4869
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4870
0
    setBlockIndexCandidates.clear();
4871
0
}
4872
4873
void Chainstate::PopulateBlockIndexCandidates()
4874
0
{
4875
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4876
4877
0
    for (CBlockIndex* pindex : m_blockman.GetAllBlockIndices()) {
4878
        // With assumeutxo, the snapshot block is a candidate for the tip, but it
4879
        // may not have BLOCK_VALID_TRANSACTIONS (e.g. if we haven't yet downloaded
4880
        // the block), so we special-case it here.
4881
0
        if (pindex == SnapshotBase() ||
4882
0
                (pindex->IsValid(BLOCK_VALID_TRANSACTIONS) &&
4883
0
                 (pindex->HaveNumChainTxs() || pindex->pprev == nullptr))) {
4884
0
            TryAddBlockIndexCandidate(pindex);
4885
0
        }
4886
0
    }
4887
0
}
4888
4889
bool ChainstateManager::LoadBlockIndex()
4890
0
{
4891
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
4892
    // Load block index from databases
4893
0
    if (m_blockman.m_blockfiles_indexed) {
4894
0
        bool ret{m_blockman.LoadBlockIndexDB(CurrentChainstate().m_from_snapshot_blockhash)};
4895
0
        if (!ret) return false;
4896
4897
0
        m_blockman.ScanAndUnlinkAlreadyPrunedFiles();
4898
4899
0
        std::vector<CBlockIndex*> vSortedByHeight{m_blockman.GetAllBlockIndices()};
4900
0
        std::sort(vSortedByHeight.begin(), vSortedByHeight.end(),
4901
0
                  CBlockIndexHeightOnlyComparator());
4902
4903
0
        for (CBlockIndex* pindex : vSortedByHeight) {
4904
0
            if (m_interrupt) return false;
4905
0
            if (pindex->nStatus & BLOCK_FAILED_VALID && (!m_best_invalid || pindex->nChainWork > m_best_invalid->nChainWork)) {
4906
0
                m_best_invalid = pindex;
4907
0
            }
4908
0
            if (pindex->IsValid(BLOCK_VALID_TREE) && (m_best_header == nullptr || CBlockIndexWorkComparator()(m_best_header, pindex)))
4909
0
                m_best_header = pindex;
4910
0
        }
4911
0
    }
4912
0
    return true;
4913
0
}
4914
4915
bool Chainstate::LoadGenesisBlock()
4916
0
{
4917
0
    LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
4918
4919
0
    const CChainParams& params{m_chainman.GetParams()};
4920
4921
    // Check whether we're already initialized by checking for genesis in
4922
    // m_blockman.m_block_index. Note that we can't use m_chain here, since it is
4923
    // set based on the coins db, not the block index db, which is the only
4924
    // thing loaded at this point.
4925
0
    if (m_blockman.m_block_index.contains(params.GenesisBlock().GetHash()))
4926
0
        return true;
4927
4928
0
    try {
4929
0
        const CBlock& block = params.GenesisBlock();
4930
0
        FlatFilePos blockPos{m_blockman.WriteBlock(block, 0)};
4931
0
        if (blockPos.IsNull()) {
4932
0
            LogError("%s: writing genesis block to disk failed\n", __func__);
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4933
0
            return false;
4934
0
        }
4935
0
        CBlockIndex* pindex = m_blockman.AddToBlockIndex(block, m_chainman.m_best_header);
4936
0
        m_chainman.ReceivedBlockTransactions(block, pindex, blockPos);
4937
0
    } catch (const std::runtime_error& e) {
4938
0
        LogError("%s: failed to write genesis block: %s\n", __func__, e.what());
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
4939
0
        return false;
4940
0
    }
4941
4942
0
    return true;
4943
0
}
4944
4945
void ChainstateManager::LoadExternalBlockFile(
4946
    AutoFile& file_in,
4947
    FlatFilePos* dbp,
4948
    std::multimap<uint256, FlatFilePos>* blocks_with_unknown_parent)
4949
0
{
4950
    // Either both should be specified (-reindex), or neither (-loadblock).
4951
0
    assert(!dbp == !blocks_with_unknown_parent);
4952
4953
0
    const auto start{SteadyClock::now()};
4954
0
    const CChainParams& params{GetParams()};
4955
4956
0
    int nLoaded = 0;
4957
0
    try {
4958
0
        BufferedFile blkdat{file_in, 2 * MAX_BLOCK_SERIALIZED_SIZE, MAX_BLOCK_SERIALIZED_SIZE + 8};
4959
        // nRewind indicates where to resume scanning in case something goes wrong,
4960
        // such as a block fails to deserialize.
4961
0
        uint64_t nRewind = blkdat.GetPos();
4962
0
        while (!blkdat.eof()) {
4963
0
            if (m_interrupt) return;
4964
4965
0
            blkdat.SetPos(nRewind);
4966
0
            nRewind++; // start one byte further next time, in case of failure
4967
0
            blkdat.SetLimit(); // remove former limit
4968
0
            unsigned int nSize = 0;
4969
0
            try {
4970
                // locate a header
4971
0
                MessageStartChars buf;
4972
0
                blkdat.FindByte(std::byte(params.MessageStart()[0]));
4973
0
                nRewind = blkdat.GetPos() + 1;
4974
0
                blkdat >> buf;
4975
0
                if (buf != params.MessageStart()) {
4976
0
                    continue;
4977
0
                }
4978
                // read size
4979
0
                blkdat >> nSize;
4980
0
                if (nSize < 80 || nSize > MAX_BLOCK_SERIALIZED_SIZE)
4981
0
                    continue;
4982
0
            } catch (const std::exception&) {
4983
                // no valid block header found; don't complain
4984
                // (this happens at the end of every blk.dat file)
4985
0
                break;
4986
0
            }
4987
0
            try {
4988
                // read block header
4989
0
                const uint64_t nBlockPos{blkdat.GetPos()};
4990
0
                if (dbp)
4991
0
                    dbp->nPos = nBlockPos;
4992
0
                blkdat.SetLimit(nBlockPos + nSize);
4993
0
                CBlockHeader header;
4994
0
                blkdat >> header;
4995
0
                const uint256 hash{header.GetHash()};
4996
                // Skip the rest of this block (this may read from disk into memory); position to the marker before the
4997
                // next block, but it's still possible to rewind to the start of the current block (without a disk read).
4998
0
                nRewind = nBlockPos + nSize;
4999
0
                blkdat.SkipTo(nRewind);
5000
5001
0
                std::shared_ptr<CBlock> pblock{}; // needs to remain available after the cs_main lock is released to avoid duplicate reads from disk
5002
5003
0
                {
5004
0
                    LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5005
                    // detect out of order blocks, and store them for later
5006
0
                    if (hash != params.GetConsensus().hashGenesisBlock && !m_blockman.LookupBlockIndex(header.hashPrevBlock)) {
5007
0
                        LogDebug(BCLog::REINDEX, "%s: Out of order block %s, parent %s not known\n", __func__, hash.ToString(),
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
5008
0
                                 header.hashPrevBlock.ToString());
5009
0
                        if (dbp && blocks_with_unknown_parent) {
5010
0
                            blocks_with_unknown_parent->emplace(header.hashPrevBlock, *dbp);
5011
0
                        }
5012
0
                        continue;
5013
0
                    }
5014
5015
                    // process in case the block isn't known yet
5016
0
                    const CBlockIndex* pindex = m_blockman.LookupBlockIndex(hash);
5017
0
                    if (!pindex || (pindex->nStatus & BLOCK_HAVE_DATA) == 0) {
5018
                        // This block can be processed immediately; rewind to its start, read and deserialize it.
5019
0
                        blkdat.SetPos(nBlockPos);
5020
0
                        pblock = std::make_shared<CBlock>();
5021
0
                        blkdat >> TX_WITH_WITNESS(*pblock);
5022
0
                        nRewind = blkdat.GetPos();
5023
5024
0
                        BlockValidationState state;
5025
0
                        if (AcceptBlock(pblock, state, nullptr, true, dbp, nullptr, true)) {
5026
0
                            nLoaded++;
5027
0
                        }
5028
0
                        if (state.IsError()) {
5029
0
                            break;
5030
0
                        }
5031
0
                    } else if (hash != params.GetConsensus().hashGenesisBlock && pindex->nHeight % 1000 == 0) {
5032
0
                        LogDebug(BCLog::REINDEX, "Block Import: already had block %s at height %d\n", hash.ToString(), pindex->nHeight);
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
5033
0
                    }
5034
0
                }
5035
5036
                // Activate the genesis block so normal node progress can continue
5037
                // During first -reindex, this will only connect Genesis since
5038
                // ActivateBestChain only connects blocks which are in the block tree db,
5039
                // which only contains blocks whose parents are in it.
5040
                // But do this only if genesis isn't activated yet, to avoid connecting many blocks
5041
                // without assumevalid in the case of a continuation of a reindex that
5042
                // was interrupted by the user.
5043
0
                if (hash == params.GetConsensus().hashGenesisBlock && WITH_LOCK(::cs_main, return ActiveHeight()) == -1) {
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
5044
0
                    BlockValidationState state;
5045
0
                    if (!ActiveChainstate().ActivateBestChain(state, nullptr)) {
5046
0
                        break;
5047
0
                    }
5048
0
                }
5049
5050
0
                if (m_blockman.IsPruneMode() && m_blockman.m_blockfiles_indexed && pblock) {
5051
                    // must update the tip for pruning to work while importing with -loadblock.
5052
                    // this is a tradeoff to conserve disk space at the expense of time
5053
                    // spent updating the tip to be able to prune.
5054
                    // otherwise, ActivateBestChain won't be called by the import process
5055
                    // until after all of the block files are loaded. ActivateBestChain can be
5056
                    // called by concurrent network message processing. but, that is not
5057
                    // reliable for the purpose of pruning while importing.
5058
0
                    if (auto result{ActivateBestChains()}; !result) {
5059
0
                        LogDebug(BCLog::REINDEX, "%s\n", util::ErrorString(result).original);
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
5060
0
                        break;
5061
0
                    }
5062
0
                }
5063
5064
0
                NotifyHeaderTip();
5065
5066
0
                if (!blocks_with_unknown_parent) continue;
5067
5068
                // Recursively process earlier encountered successors of this block
5069
0
                std::deque<uint256> queue;
5070
0
                queue.push_back(hash);
5071
0
                while (!queue.empty()) {
5072
0
                    uint256 head = queue.front();
5073
0
                    queue.pop_front();
5074
0
                    auto range = blocks_with_unknown_parent->equal_range(head);
5075
0
                    while (range.first != range.second) {
5076
0
                        std::multimap<uint256, FlatFilePos>::iterator it = range.first;
5077
0
                        std::shared_ptr<CBlock> pblockrecursive = std::make_shared<CBlock>();
5078
0
                        if (m_blockman.ReadBlock(*pblockrecursive, it->second, {})) {
5079
0
                            const auto& block_hash{pblockrecursive->GetHash()};
5080
0
                            LogDebug(BCLog::REINDEX, "%s: Processing out of order child %s of %s", __func__, block_hash.ToString(), head.ToString());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
5081
0
                            LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5082
0
                            BlockValidationState dummy;
5083
0
                            if (AcceptBlock(pblockrecursive, dummy, nullptr, true, &it->second, nullptr, true)) {
5084
0
                                nLoaded++;
5085
0
                                queue.push_back(block_hash);
5086
0
                            }
5087
0
                        }
5088
0
                        range.first++;
5089
0
                        blocks_with_unknown_parent->erase(it);
5090
0
                        NotifyHeaderTip();
5091
0
                    }
5092
0
                }
5093
0
            } catch (const std::exception& e) {
5094
                // historical bugs added extra data to the block files that does not deserialize cleanly.
5095
                // commonly this data is between readable blocks, but it does not really matter. such data is not fatal to the import process.
5096
                // the code that reads the block files deals with invalid data by simply ignoring it.
5097
                // it continues to search for the next {4 byte magic message start bytes + 4 byte length + block} that does deserialize cleanly
5098
                // and passes all of the other block validation checks dealing with POW and the merkle root, etc...
5099
                // we merely note with this informational log message when unexpected data is encountered.
5100
                // we could also be experiencing a storage system read error, or a read of a previous bad write. these are possible, but
5101
                // less likely scenarios. we don't have enough information to tell a difference here.
5102
                // the reindex process is not the place to attempt to clean and/or compact the block files. if so desired, a studious node operator
5103
                // may use knowledge of the fact that the block files are not entirely pristine in order to prepare a set of pristine, and
5104
                // perhaps ordered, block files for later reindexing.
5105
0
                LogDebug(BCLog::REINDEX, "%s: unexpected data at file offset 0x%x - %s. continuing\n", __func__, (nRewind - 1), e.what());
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
5106
0
            }
5107
0
        }
5108
0
    } catch (const std::runtime_error& e) {
5109
0
        GetNotifications().fatalError(strprintf(_("System error while loading external block file: %s"), e.what()));
Line
Count
Source
1172
0
#define strprintf tfm::format
5110
0
    }
5111
0
    LogInfo("Loaded %i blocks from external file in %dms", nLoaded, Ticks<std::chrono::milliseconds>(SteadyClock::now() - start));
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5112
0
}
5113
5114
bool ChainstateManager::ShouldCheckBlockIndex() const
5115
0
{
5116
    // Assert to verify Flatten() has been called.
5117
0
    if (!*Assert(m_options.check_block_index)) return false;
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
5118
0
    if (FastRandomContext().randrange(*m_options.check_block_index) >= 1) return false;
5119
0
    return true;
5120
0
}
5121
5122
void ChainstateManager::CheckBlockIndex() const
5123
0
{
5124
0
    if (!ShouldCheckBlockIndex()) {
5125
0
        return;
5126
0
    }
5127
5128
0
    LOCK(cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5129
5130
    // During a reindex, we read the genesis block and call CheckBlockIndex before ActivateBestChain,
5131
    // so we have the genesis block in m_blockman.m_block_index but no active chain. (A few of the
5132
    // tests when iterating the block tree require that m_chain has been initialized.)
5133
0
    if (ActiveChain().Height() < 0) {
5134
0
        assert(m_blockman.m_block_index.size() <= 1);
5135
0
        return;
5136
0
    }
5137
5138
    // Build forward-pointing data structure for the entire block tree.
5139
    // For performance reasons, indexes of the best header chain are stored in a vector (within CChain).
5140
    // All remaining blocks are stored in a multimap.
5141
    // The best header chain can differ from the active chain: E.g. its entries may belong to blocks that
5142
    // are not yet validated.
5143
0
    CChain best_hdr_chain;
5144
0
    assert(m_best_header);
5145
0
    assert(!(m_best_header->nStatus & BLOCK_FAILED_VALID));
5146
0
    best_hdr_chain.SetTip(*m_best_header);
5147
5148
0
    std::multimap<const CBlockIndex*, const CBlockIndex*> forward;
5149
0
    for (auto& [_, block_index] : m_blockman.m_block_index) {
5150
        // Only save indexes in forward that are not part of the best header chain.
5151
0
        if (!best_hdr_chain.Contains(&block_index)) {
5152
            // Only genesis, which must be part of the best header chain, can have a nullptr parent.
5153
0
            assert(block_index.pprev);
5154
0
            forward.emplace(block_index.pprev, &block_index);
5155
0
        }
5156
0
    }
5157
0
    assert(forward.size() + best_hdr_chain.Height() + 1 == m_blockman.m_block_index.size());
5158
5159
0
    const CBlockIndex* pindex = best_hdr_chain[0];
5160
0
    assert(pindex);
5161
    // Iterate over the entire block tree, using depth-first search.
5162
    // Along the way, remember whether there are blocks on the path from genesis
5163
    // block being explored which are the first to have certain properties.
5164
0
    size_t nNodes = 0;
5165
0
    int nHeight = 0;
5166
0
    const CBlockIndex* pindexFirstInvalid = nullptr;              // Oldest ancestor of pindex which is invalid.
5167
0
    const CBlockIndex* pindexFirstMissing = nullptr;              // Oldest ancestor of pindex which does not have BLOCK_HAVE_DATA, since assumeutxo snapshot if used.
5168
0
    const CBlockIndex* pindexFirstNeverProcessed = nullptr;       // Oldest ancestor of pindex for which nTx == 0, since assumeutxo snapshot if used.
5169
0
    const CBlockIndex* pindexFirstNotTreeValid = nullptr;         // Oldest ancestor of pindex which does not have BLOCK_VALID_TREE (regardless of being valid or not).
5170
0
    const CBlockIndex* pindexFirstNotTransactionsValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_TRANSACTIONS (regardless of being valid or not), since assumeutxo snapshot if used.
5171
0
    const CBlockIndex* pindexFirstNotChainValid = nullptr;        // Oldest ancestor of pindex which does not have BLOCK_VALID_CHAIN (regardless of being valid or not), since assumeutxo snapshot if used.
5172
0
    const CBlockIndex* pindexFirstNotScriptsValid = nullptr;      // Oldest ancestor of pindex which does not have BLOCK_VALID_SCRIPTS (regardless of being valid or not), since assumeutxo snapshot if used.
5173
5174
    // After checking an assumeutxo snapshot block, reset pindexFirst pointers
5175
    // to earlier blocks that have not been downloaded or validated yet, so
5176
    // checks for later blocks can assume the earlier blocks were validated and
5177
    // be stricter, testing for more requirements.
5178
0
    const CBlockIndex* snap_base{CurrentChainstate().SnapshotBase()};
5179
0
    const CBlockIndex *snap_first_missing{}, *snap_first_notx{}, *snap_first_notv{}, *snap_first_nocv{}, *snap_first_nosv{};
5180
0
    auto snap_update_firsts = [&] {
5181
0
        if (pindex == snap_base) {
5182
0
            std::swap(snap_first_missing, pindexFirstMissing);
5183
0
            std::swap(snap_first_notx, pindexFirstNeverProcessed);
5184
0
            std::swap(snap_first_notv, pindexFirstNotTransactionsValid);
5185
0
            std::swap(snap_first_nocv, pindexFirstNotChainValid);
5186
0
            std::swap(snap_first_nosv, pindexFirstNotScriptsValid);
5187
0
        }
5188
0
    };
5189
5190
0
    while (pindex != nullptr) {
5191
0
        nNodes++;
5192
0
        if (pindexFirstInvalid == nullptr && pindex->nStatus & BLOCK_FAILED_VALID) pindexFirstInvalid = pindex;
5193
0
        if (pindexFirstMissing == nullptr && !(pindex->nStatus & BLOCK_HAVE_DATA)) {
5194
0
            pindexFirstMissing = pindex;
5195
0
        }
5196
0
        if (pindexFirstNeverProcessed == nullptr && pindex->nTx == 0) pindexFirstNeverProcessed = pindex;
5197
0
        if (pindex->pprev != nullptr && pindexFirstNotTreeValid == nullptr && (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_TREE) pindexFirstNotTreeValid = pindex;
5198
5199
0
        if (pindex->pprev != nullptr) {
5200
0
            if (pindexFirstNotTransactionsValid == nullptr &&
5201
0
                    (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_TRANSACTIONS) {
5202
0
                pindexFirstNotTransactionsValid = pindex;
5203
0
            }
5204
5205
0
            if (pindexFirstNotChainValid == nullptr &&
5206
0
                    (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_CHAIN) {
5207
0
                pindexFirstNotChainValid = pindex;
5208
0
            }
5209
5210
0
            if (pindexFirstNotScriptsValid == nullptr &&
5211
0
                    (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_SCRIPTS) {
5212
0
                pindexFirstNotScriptsValid = pindex;
5213
0
            }
5214
0
        }
5215
5216
        // Begin: actual consistency checks.
5217
0
        if (pindex->pprev == nullptr) {
5218
            // Genesis block checks.
5219
0
            assert(pindex->GetBlockHash() == GetConsensus().hashGenesisBlock); // Genesis block's hash must match.
5220
0
            for (const auto& c : m_chainstates) {
5221
0
                if (c->m_chain.Genesis() != nullptr) {
5222
0
                    assert(pindex == c->m_chain.Genesis()); // The chain's genesis block must be this block.
5223
0
                }
5224
0
            }
5225
0
        }
5226
        // nSequenceId can't be set higher than SEQ_ID_INIT_FROM_DISK{1} for blocks that aren't linked
5227
        // (negative is used for preciousblock, SEQ_ID_BEST_CHAIN_FROM_DISK{0} for active chain when loaded from disk)
5228
0
        if (!pindex->HaveNumChainTxs()) assert(pindex->nSequenceId <= SEQ_ID_INIT_FROM_DISK);
5229
        // VALID_TRANSACTIONS is equivalent to nTx > 0 for all nodes (whether or not pruning has occurred).
5230
        // HAVE_DATA is only equivalent to nTx > 0 (or VALID_TRANSACTIONS) if no pruning has occurred.
5231
0
        if (!m_blockman.m_have_pruned) {
5232
            // If we've never pruned, then HAVE_DATA should be equivalent to nTx > 0
5233
0
            assert(!(pindex->nStatus & BLOCK_HAVE_DATA) == (pindex->nTx == 0));
5234
0
            assert(pindexFirstMissing == pindexFirstNeverProcessed);
5235
0
        } else {
5236
            // If we have pruned, then we can only say that HAVE_DATA implies nTx > 0
5237
0
            if (pindex->nStatus & BLOCK_HAVE_DATA) assert(pindex->nTx > 0);
5238
0
        }
5239
0
        if (pindex->nStatus & BLOCK_HAVE_UNDO) assert(pindex->nStatus & BLOCK_HAVE_DATA);
5240
0
        if (snap_base && snap_base->GetAncestor(pindex->nHeight) == pindex) {
5241
            // Assumed-valid blocks should connect to the main chain.
5242
0
            assert((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TREE);
5243
0
        }
5244
        // There should only be an nTx value if we have
5245
        // actually seen a block's transactions.
5246
0
        assert(((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TRANSACTIONS) == (pindex->nTx > 0)); // This is pruning-independent.
5247
        // All parents having had data (at some point) is equivalent to all parents being VALID_TRANSACTIONS, which is equivalent to HaveNumChainTxs().
5248
        // HaveNumChainTxs will also be set in the assumeutxo snapshot block from snapshot metadata.
5249
0
        assert((pindexFirstNeverProcessed == nullptr || pindex == snap_base) == pindex->HaveNumChainTxs());
5250
0
        assert((pindexFirstNotTransactionsValid == nullptr || pindex == snap_base) == pindex->HaveNumChainTxs());
5251
0
        assert(pindex->nHeight == nHeight); // nHeight must be consistent.
5252
0
        assert(pindex->pprev == nullptr || pindex->nChainWork >= pindex->pprev->nChainWork); // For every block except the genesis block, the chainwork must be larger than the parent's.
5253
0
        assert(nHeight < 2 || (pindex->pskip && (pindex->pskip->nHeight < nHeight))); // The pskip pointer must point back for all but the first 2 blocks.
5254
0
        assert(pindexFirstNotTreeValid == nullptr); // All m_blockman.m_block_index entries must at least be TREE valid
5255
0
        if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TREE) assert(pindexFirstNotTreeValid == nullptr); // TREE valid implies all parents are TREE valid
5256
0
        if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_CHAIN) assert(pindexFirstNotChainValid == nullptr); // CHAIN valid implies all parents are CHAIN valid
5257
0
        if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_SCRIPTS) assert(pindexFirstNotScriptsValid == nullptr); // SCRIPTS valid implies all parents are SCRIPTS valid
5258
0
        if (pindexFirstInvalid == nullptr) {
5259
            // Checks for not-invalid blocks.
5260
0
            assert((pindex->nStatus & BLOCK_FAILED_VALID) == 0); // The failed flag cannot be set for blocks without invalid parents.
5261
0
        } else {
5262
0
            assert(pindex->nStatus & BLOCK_FAILED_VALID); // Invalid blocks and their descendants must be marked as invalid
5263
0
        }
5264
        // Make sure m_chain_tx_count sum is correctly computed.
5265
0
        if (!pindex->pprev) {
5266
            // If no previous block, nTx and m_chain_tx_count must be the same.
5267
0
            assert(pindex->m_chain_tx_count == pindex->nTx);
5268
0
        } else if (pindex->pprev->m_chain_tx_count > 0 && pindex->nTx > 0) {
5269
            // If previous m_chain_tx_count is set and number of transactions in block is known, sum must be set.
5270
0
            assert(pindex->m_chain_tx_count == pindex->nTx + pindex->pprev->m_chain_tx_count);
5271
0
        } else {
5272
            // Otherwise m_chain_tx_count should only be set if this is a snapshot
5273
            // block, and must be set if it is.
5274
0
            assert((pindex->m_chain_tx_count != 0) == (pindex == snap_base));
5275
0
        }
5276
        // There should be no block with more work than m_best_header, unless it's known to be invalid
5277
0
        assert((pindex->nStatus & BLOCK_FAILED_VALID) || pindex->nChainWork <= m_best_header->nChainWork);
5278
5279
        // Chainstate-specific checks on setBlockIndexCandidates
5280
0
        for (const auto& c : m_chainstates) {
5281
0
            if (c->m_chain.Tip() == nullptr) continue;
5282
            // Two main factors determine whether pindex is a candidate in
5283
            // setBlockIndexCandidates:
5284
            //
5285
            // - If pindex has less work than the chain tip, it should not be a
5286
            //   candidate, and this will be asserted below. Otherwise it is a
5287
            //   potential candidate.
5288
            //
5289
            // - If pindex or one of its parent blocks back to the genesis block
5290
            //   or an assumeutxo snapshot never downloaded transactions
5291
            //   (pindexFirstNeverProcessed is non-null), it should not be a
5292
            //   candidate, and this will be asserted below. The only exception
5293
            //   is if pindex itself is an assumeutxo snapshot block. Then it is
5294
            //   also a potential candidate.
5295
0
            if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) && (pindexFirstNeverProcessed == nullptr || pindex == snap_base)) {
5296
                // If pindex was detected as invalid (pindexFirstInvalid is
5297
                // non-null), it is not required to be in
5298
                // setBlockIndexCandidates.
5299
0
                if (pindexFirstInvalid == nullptr) {
5300
                    // If pindex and all its parents back to the genesis block
5301
                    // or an assumeutxo snapshot block downloaded transactions,
5302
                    // and the transactions were not pruned (pindexFirstMissing
5303
                    // is null), it is a potential candidate. The check
5304
                    // excludes pruned blocks, because if any blocks were
5305
                    // pruned between pindex and the current chain tip, pindex will
5306
                    // only temporarily be added to setBlockIndexCandidates,
5307
                    // before being moved to m_blocks_unlinked. This check
5308
                    // could be improved to verify that if all blocks between
5309
                    // the chain tip and pindex have data, pindex must be a
5310
                    // candidate.
5311
                    //
5312
                    // If pindex is the chain tip, it also is a potential
5313
                    // candidate.
5314
                    //
5315
                    // If the chainstate was loaded from a snapshot and pindex
5316
                    // is the base of the snapshot, pindex is also a potential
5317
                    // candidate.
5318
0
                    if (pindexFirstMissing == nullptr || pindex == c->m_chain.Tip() || pindex == c->SnapshotBase()) {
5319
                        // If this chainstate is not a historical chainstate
5320
                        // targeting a specific block, pindex must be in
5321
                        // setBlockIndexCandidates. Otherwise, pindex only
5322
                        // needs to be added if it is an ancestor of the target
5323
                        // block.
5324
0
                        if (!c->TargetBlock() || c->TargetBlock()->GetAncestor(pindex->nHeight) == pindex) {
5325
0
                            assert(c->setBlockIndexCandidates.contains(pindex));
5326
0
                        }
5327
0
                    }
5328
                    // If some parent is missing, then it could be that this block was in
5329
                    // setBlockIndexCandidates but had to be removed because of the missing data.
5330
                    // In this case it must be in m_blocks_unlinked -- see test below.
5331
0
                }
5332
0
            } else { // If this block sorts worse than the current tip or some ancestor's block has never been seen, it cannot be in setBlockIndexCandidates.
5333
0
                assert(!c->setBlockIndexCandidates.contains(pindex));
5334
0
            }
5335
0
        }
5336
        // Check whether this block is in m_blocks_unlinked.
5337
0
        auto rangeUnlinked{m_blockman.m_blocks_unlinked.equal_range(pindex->pprev)};
5338
0
        bool foundInUnlinked = false;
5339
0
        while (rangeUnlinked.first != rangeUnlinked.second) {
5340
0
            assert(rangeUnlinked.first->first == pindex->pprev);
5341
0
            if (rangeUnlinked.first->second == pindex) {
5342
0
                foundInUnlinked = true;
5343
0
                break;
5344
0
            }
5345
0
            rangeUnlinked.first++;
5346
0
        }
5347
0
        if (pindex->pprev && (pindex->nStatus & BLOCK_HAVE_DATA) && pindexFirstNeverProcessed != nullptr && pindexFirstInvalid == nullptr) {
5348
            // If this block has block data available, some parent was never received, and has no invalid parents, it must be in m_blocks_unlinked.
5349
0
            assert(foundInUnlinked);
5350
0
        }
5351
0
        if (!(pindex->nStatus & BLOCK_HAVE_DATA)) assert(!foundInUnlinked); // Can't be in m_blocks_unlinked if we don't HAVE_DATA
5352
0
        if (pindexFirstMissing == nullptr) assert(!foundInUnlinked); // We aren't missing data for any parent -- cannot be in m_blocks_unlinked.
5353
0
        if (pindex->pprev && (pindex->nStatus & BLOCK_HAVE_DATA) && pindexFirstNeverProcessed == nullptr && pindexFirstMissing != nullptr) {
5354
            // We HAVE_DATA for this block, have received data for all parents at some point, but we're currently missing data for some parent.
5355
0
            assert(m_blockman.m_have_pruned);
5356
            // This block may have entered m_blocks_unlinked if:
5357
            //  - it has a descendant that at some point had more work than the
5358
            //    tip, and
5359
            //  - we tried switching to that descendant but were missing
5360
            //    data for some intermediate block between m_chain and the
5361
            //    tip.
5362
            // So if this block is itself better than any m_chain.Tip() and it wasn't in
5363
            // setBlockIndexCandidates, then it must be in m_blocks_unlinked.
5364
0
            for (const auto& c : m_chainstates) {
5365
0
                if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) && !c->setBlockIndexCandidates.contains(pindex)) {
5366
0
                    if (pindexFirstInvalid == nullptr) {
5367
0
                        if (!c->TargetBlock() || c->TargetBlock()->GetAncestor(pindex->nHeight) == pindex) {
5368
0
                            assert(foundInUnlinked);
5369
0
                        }
5370
0
                    }
5371
0
                }
5372
0
            }
5373
0
        }
5374
        // assert(pindex->GetBlockHash() == pindex->GetBlockHeader().GetHash()); // Perhaps too slow
5375
        // End: actual consistency checks.
5376
5377
5378
        // Try descending into the first subnode. Always process forks first and the best header chain after.
5379
0
        snap_update_firsts();
5380
0
        auto range{forward.equal_range(pindex)};
5381
0
        if (range.first != range.second) {
5382
            // A subnode not part of the best header chain was found.
5383
0
            pindex = range.first->second;
5384
0
            nHeight++;
5385
0
            continue;
5386
0
        } else if (best_hdr_chain.Contains(pindex)) {
5387
            // Descend further into best header chain.
5388
0
            nHeight++;
5389
0
            pindex = best_hdr_chain[nHeight];
5390
0
            if (!pindex) break; // we are finished, since the best header chain is always processed last
5391
0
            continue;
5392
0
        }
5393
        // This is a leaf node.
5394
        // Move upwards until we reach a node of which we have not yet visited the last child.
5395
0
        while (pindex) {
5396
            // We are going to either move to a parent or a sibling of pindex.
5397
0
            snap_update_firsts();
5398
            // If pindex was the first with a certain property, unset the corresponding variable.
5399
0
            if (pindex == pindexFirstInvalid) pindexFirstInvalid = nullptr;
5400
0
            if (pindex == pindexFirstMissing) pindexFirstMissing = nullptr;
5401
0
            if (pindex == pindexFirstNeverProcessed) pindexFirstNeverProcessed = nullptr;
5402
0
            if (pindex == pindexFirstNotTreeValid) pindexFirstNotTreeValid = nullptr;
5403
0
            if (pindex == pindexFirstNotTransactionsValid) pindexFirstNotTransactionsValid = nullptr;
5404
0
            if (pindex == pindexFirstNotChainValid) pindexFirstNotChainValid = nullptr;
5405
0
            if (pindex == pindexFirstNotScriptsValid) pindexFirstNotScriptsValid = nullptr;
5406
            // Find our parent.
5407
0
            CBlockIndex* pindexPar = pindex->pprev;
5408
            // Find which child we just visited.
5409
0
            auto rangePar{forward.equal_range(pindexPar)};
5410
0
            while (rangePar.first->second != pindex) {
5411
0
                assert(rangePar.first != rangePar.second); // Our parent must have at least the node we're coming from as child.
5412
0
                rangePar.first++;
5413
0
            }
5414
            // Proceed to the next one.
5415
0
            rangePar.first++;
5416
0
            if (rangePar.first != rangePar.second) {
5417
                // Move to a sibling not part of the best header chain.
5418
0
                pindex = rangePar.first->second;
5419
0
                break;
5420
0
            } else if (pindexPar == best_hdr_chain[nHeight - 1]) {
5421
                // Move to pindex's sibling on the best-chain, if it has one.
5422
0
                pindex = best_hdr_chain[nHeight];
5423
                // There will not be a next block if (and only if) parent block is the best header.
5424
0
                assert((pindex == nullptr) == (pindexPar == best_hdr_chain.Tip()));
5425
0
                break;
5426
0
            } else {
5427
                // Move up further.
5428
0
                pindex = pindexPar;
5429
0
                nHeight--;
5430
0
                continue;
5431
0
            }
5432
0
        }
5433
0
    }
5434
5435
    // Check that we actually traversed the entire block index.
5436
0
    assert(nNodes == forward.size() + best_hdr_chain.Height() + 1);
5437
0
}
5438
5439
std::string Chainstate::ToString()
5440
0
{
5441
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
5442
0
    CBlockIndex* tip = m_chain.Tip();
5443
0
    return strprintf("Chainstate [%s] @ height %d (%s)",
Line
Count
Source
1172
0
#define strprintf tfm::format
5444
0
                     m_from_snapshot_blockhash ? "snapshot" : "ibd",
5445
0
                     tip ? tip->nHeight : -1, tip ? tip->GetBlockHash().ToString() : "null");
5446
0
}
5447
5448
bool Chainstate::ResizeCoinsCaches(size_t coinstip_size, size_t coinsdb_size)
5449
0
{
5450
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
5451
0
    if (coinstip_size == m_coinstip_cache_size_bytes &&
5452
0
            coinsdb_size == m_coinsdb_cache_size_bytes) {
5453
        // Cache sizes are unchanged, no need to continue.
5454
0
        return true;
5455
0
    }
5456
0
    size_t old_coinstip_size = m_coinstip_cache_size_bytes;
5457
0
    m_coinstip_cache_size_bytes = coinstip_size;
5458
0
    m_coinsdb_cache_size_bytes = coinsdb_size;
5459
0
    CoinsDB().ResizeCache(coinsdb_size);
5460
5461
0
    LogInfo("[%s] resized coinsdb cache to %.1f MiB",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5462
0
        this->ToString(), coinsdb_size * (1.0 / 1024 / 1024));
5463
0
    LogInfo("[%s] resized coinstip cache to %.1f MiB",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5464
0
        this->ToString(), coinstip_size * (1.0 / 1024 / 1024));
5465
5466
0
    BlockValidationState state;
5467
0
    bool ret;
5468
5469
0
    if (coinstip_size > old_coinstip_size) {
5470
        // Likely no need to flush if cache sizes have grown.
5471
0
        ret = FlushStateToDisk(state, FlushStateMode::IF_NEEDED);
5472
0
    } else {
5473
        // Otherwise, flush state to disk and deallocate the in-memory coins map.
5474
0
        ret = FlushStateToDisk(state, FlushStateMode::FORCE_FLUSH);
5475
0
    }
5476
0
    return ret;
5477
0
}
5478
5479
double ChainstateManager::GuessVerificationProgress(const CBlockIndex* pindex) const
5480
0
{
5481
0
    AssertLockHeld(GetMutex());
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
5482
0
    const ChainTxData& data{GetParams().TxData()};
5483
0
    if (pindex == nullptr) {
5484
0
        return 0.0;
5485
0
    }
5486
5487
0
    if (pindex->m_chain_tx_count == 0) {
5488
0
        LogDebug(BCLog::VALIDATION, "Block %d has unset m_chain_tx_count. Unable to estimate verification progress.\n", pindex->nHeight);
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
5489
0
        return 0.0;
5490
0
    }
5491
5492
0
    const int64_t nNow{TicksSinceEpoch<std::chrono::seconds>(NodeClock::now())};
5493
0
    const auto block_time{
5494
0
        (Assume(m_best_header) && std::abs(nNow - pindex->GetBlockTime()) <= Ticks<std::chrono::seconds>(2h) &&
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
5495
0
         Assume(m_best_header->nHeight >= pindex->nHeight)) ?
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
5496
            // When the header is known to be recent, switch to a height-based
5497
            // approach. This ensures the returned value is quantized when
5498
            // close to "1.0", because some users expect it to be. This also
5499
            // avoids relying too much on the exact miner-set timestamp, which
5500
            // may be off.
5501
0
            nNow - (m_best_header->nHeight - pindex->nHeight) * GetConsensus().nPowTargetSpacing :
5502
0
            pindex->GetBlockTime(),
5503
0
    };
5504
5505
0
    double fTxTotal;
5506
5507
0
    if (pindex->m_chain_tx_count <= data.tx_count) {
5508
0
        fTxTotal = data.tx_count + (nNow - data.nTime) * data.dTxRate;
5509
0
    } else {
5510
0
        fTxTotal = pindex->m_chain_tx_count + (nNow - block_time) * data.dTxRate;
5511
0
    }
5512
5513
0
    return std::min<double>(pindex->m_chain_tx_count / fTxTotal, 1.0);
5514
0
}
5515
5516
double ChainstateManager::GetBackgroundVerificationProgress(const CBlockIndex& pindex) const
5517
0
{
5518
0
    AssertLockHeld(GetMutex());
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
5519
0
    Assert(HistoricalChainstate());
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
5520
0
    auto target_block = HistoricalChainstate()->TargetBlock();
5521
5522
0
    if (pindex.m_chain_tx_count == 0 || target_block->m_chain_tx_count == 0) {
5523
0
        LogDebug(BCLog::VALIDATION, "[background validation] Block %d has unset m_chain_tx_count. Unable to estimate verification progress.", pindex.nHeight);
Line
Count
Source
117
0
#define LogDebug(category, ...) detail_LogIfCategoryAndLevelEnabled(category, BCLog::Level::Debug, __VA_ARGS__)
Line
Count
Source
108
0
    do {                                                               \
109
0
        if (util::log::ShouldLog((category), (level))) {               \
110
0
            bool rate_limit{level >= BCLog::Level::Info};              \
111
0
            Assume(!rate_limit); /*Only called with the levels below*/ \
Line
Count
Source
128
0
#define Assume(val) inline_assertion_check<false>(val, std::source_location::current(), #val)
112
0
            LogPrintLevel_(category, level, rate_limit, __VA_ARGS__);  \
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
113
0
        }                                                              \
114
0
    } while (0)
5524
0
        return 0.0;
5525
0
    }
5526
0
    return static_cast<double>(pindex.m_chain_tx_count) / static_cast<double>(target_block->m_chain_tx_count);
5527
0
}
5528
5529
Chainstate& ChainstateManager::InitializeChainstate(CTxMemPool* mempool)
5530
0
{
5531
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
5532
0
    assert(m_chainstates.empty());
5533
0
    m_chainstates.emplace_back(std::make_unique<Chainstate>(mempool, m_blockman, *this));
5534
0
    return *m_chainstates.back();
5535
0
}
5536
5537
[[nodiscard]] static bool DeleteCoinsDBFromDisk(const fs::path db_path, bool is_snapshot)
5538
    EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
5539
0
{
5540
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
5541
5542
0
    if (is_snapshot) {
5543
0
        fs::path base_blockhash_path = db_path / node::SNAPSHOT_BLOCKHASH_FILENAME;
5544
5545
0
        try {
5546
0
            bool existed = fs::remove(base_blockhash_path);
5547
0
            if (!existed) {
5548
0
                LogWarning("[snapshot] snapshot chainstate dir being removed lacks %s file",
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5549
0
                          fs::PathToString(node::SNAPSHOT_BLOCKHASH_FILENAME));
5550
0
            }
5551
0
        } catch (const fs::filesystem_error& e) {
5552
0
            LogWarning("[snapshot] failed to remove file %s: %s\n",
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5553
0
                       fs::PathToString(base_blockhash_path), e.code().message());
5554
0
        }
5555
0
    }
5556
5557
0
    std::string path_str = fs::PathToString(db_path);
5558
0
    LogInfo("Removing leveldb dir at %s\n", path_str);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5559
5560
    // We have to destruct before this call leveldb::DB in order to release the db
5561
    // lock, otherwise `DestroyDB` will fail. See `leveldb::~DBImpl()`.
5562
0
    const bool destroyed = DestroyDB(path_str);
5563
5564
0
    if (!destroyed) {
5565
0
        LogError("leveldb DestroyDB call failed on %s", path_str);
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5566
0
    }
5567
5568
    // Datadir should be removed from filesystem; otherwise initialization may detect
5569
    // it on subsequent statups and get confused.
5570
    //
5571
    // If the base_blockhash_path removal above fails in the case of snapshot
5572
    // chainstates, this will return false since leveldb won't remove a non-empty
5573
    // directory.
5574
0
    return destroyed && !fs::exists(db_path);
5575
0
}
5576
5577
util::Result<CBlockIndex*> ChainstateManager::ActivateSnapshot(
5578
        AutoFile& coins_file,
5579
        const SnapshotMetadata& metadata,
5580
        bool in_memory)
5581
0
{
5582
0
    uint256 base_blockhash = metadata.m_base_blockhash;
5583
5584
0
    CBlockIndex* snapshot_start_block{};
5585
5586
0
    {
5587
0
        LOCK(::cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5588
5589
0
        if (this->CurrentChainstate().m_from_snapshot_blockhash) {
5590
0
            return util::Error{Untranslated("Can't activate a snapshot-based chainstate more than once")};
5591
0
        }
5592
0
        if (!GetParams().AssumeutxoForBlockhash(base_blockhash).has_value()) {
5593
0
            auto available_heights = GetParams().GetAvailableSnapshotHeights();
5594
0
            std::string heights_formatted = util::Join(available_heights, ", ", [&](const auto& i) { return util::ToString(i); });
5595
0
            return util::Error{Untranslated(strprintf("assumeutxo block hash in snapshot metadata not recognized (hash: %s). The following snapshot heights are available: %s",
Line
Count
Source
1172
0
#define strprintf tfm::format
5596
0
                base_blockhash.ToString(),
5597
0
                heights_formatted))};
5598
0
        }
5599
5600
0
        snapshot_start_block = m_blockman.LookupBlockIndex(base_blockhash);
5601
0
        if (!snapshot_start_block) {
5602
0
            return util::Error{Untranslated(strprintf("The base block header (%s) must appear in the headers chain. Make sure all headers are syncing, and call loadtxoutset again",
Line
Count
Source
1172
0
#define strprintf tfm::format
5603
0
                          base_blockhash.ToString()))};
5604
0
        }
5605
5606
0
        bool start_block_invalid = snapshot_start_block->nStatus & BLOCK_FAILED_VALID;
5607
0
        if (start_block_invalid) {
5608
0
            return util::Error{Untranslated(strprintf("The base block header (%s) is part of an invalid chain", base_blockhash.ToString()))};
Line
Count
Source
1172
0
#define strprintf tfm::format
5609
0
        }
5610
5611
0
        if (!m_best_header || m_best_header->GetAncestor(snapshot_start_block->nHeight) != snapshot_start_block) {
5612
0
            return util::Error{Untranslated("A forked headers-chain with more work than the chain with the snapshot base block header exists. Please proceed to sync without AssumeUtxo.")};
5613
0
        }
5614
5615
0
        auto mempool{CurrentChainstate().GetMempool()};
5616
0
        if (mempool && mempool->size() > 0) {
5617
0
            return util::Error{Untranslated("Can't activate a snapshot when mempool not empty")};
5618
0
        }
5619
0
    }
5620
5621
0
    int64_t current_coinsdb_cache_size{0};
5622
0
    int64_t current_coinstip_cache_size{0};
5623
5624
    // Cache percentages to allocate to each chainstate.
5625
    //
5626
    // These particular percentages don't matter so much since they will only be
5627
    // relevant during snapshot activation; caches are rebalanced at the conclusion of
5628
    // this function. We want to give (essentially) all available cache capacity to the
5629
    // snapshot to aid the bulk load later in this function.
5630
0
    static constexpr double IBD_CACHE_PERC = 0.01;
5631
0
    static constexpr double SNAPSHOT_CACHE_PERC = 0.99;
5632
5633
0
    {
5634
0
        LOCK(::cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5635
        // Resize the coins caches to ensure we're not exceeding memory limits.
5636
        //
5637
        // Allocate the majority of the cache to the incoming snapshot chainstate, since
5638
        // (optimistically) getting to its tip will be the top priority. We'll need to call
5639
        // `MaybeRebalanceCaches()` once we're done with this function to ensure
5640
        // the right allocation (including the possibility that no snapshot was activated
5641
        // and that we should restore the active chainstate caches to their original size).
5642
        //
5643
0
        current_coinsdb_cache_size = this->ActiveChainstate().m_coinsdb_cache_size_bytes;
5644
0
        current_coinstip_cache_size = this->ActiveChainstate().m_coinstip_cache_size_bytes;
5645
5646
        // Temporarily resize the active coins cache to make room for the newly-created
5647
        // snapshot chain.
5648
0
        this->ActiveChainstate().ResizeCoinsCaches(
5649
0
            static_cast<size_t>(current_coinstip_cache_size * IBD_CACHE_PERC),
5650
0
            static_cast<size_t>(current_coinsdb_cache_size * IBD_CACHE_PERC));
5651
0
    }
5652
5653
0
    auto snapshot_chainstate = WITH_LOCK(::cs_main,
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
5654
0
        return std::make_unique<Chainstate>(
5655
0
            /*mempool=*/nullptr, m_blockman, *this, base_blockhash));
5656
5657
0
    {
5658
0
        LOCK(::cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5659
0
        snapshot_chainstate->InitCoinsDB(
5660
0
            static_cast<size_t>(current_coinsdb_cache_size * SNAPSHOT_CACHE_PERC),
5661
0
            in_memory, /*should_wipe=*/false);
5662
0
        snapshot_chainstate->InitCoinsCache(
5663
0
            static_cast<size_t>(current_coinstip_cache_size * SNAPSHOT_CACHE_PERC));
5664
0
    }
5665
5666
0
    auto cleanup_bad_snapshot = [&](bilingual_str reason) EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
5667
0
        this->MaybeRebalanceCaches();
5668
5669
        // PopulateAndValidateSnapshot can return (in error) before the leveldb datadir
5670
        // has been created, so only attempt removal if we got that far.
5671
0
        if (auto snapshot_datadir = node::FindAssumeutxoChainstateDir(m_options.datadir)) {
5672
            // We have to destruct leveldb::DB in order to release the db lock, otherwise
5673
            // DestroyDB() (in DeleteCoinsDBFromDisk()) will fail. See `leveldb::~DBImpl()`.
5674
            // Destructing the chainstate (and so resetting the coinsviews object) does this.
5675
0
            snapshot_chainstate.reset();
5676
0
            bool removed = DeleteCoinsDBFromDisk(*snapshot_datadir, /*is_snapshot=*/true);
5677
0
            if (!removed) {
5678
0
                GetNotifications().fatalError(strprintf(_("Failed to remove snapshot chainstate dir (%s). "
Line
Count
Source
1172
0
#define strprintf tfm::format
5679
0
                    "Manually remove it before restarting.\n"), fs::PathToString(*snapshot_datadir)));
5680
0
            }
5681
0
        }
5682
0
        return util::Error{std::move(reason)};
5683
0
    };
5684
5685
0
    if (auto res{this->PopulateAndValidateSnapshot(*snapshot_chainstate, coins_file, metadata)}; !res) {
5686
0
        LOCK(::cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5687
0
        return cleanup_bad_snapshot(Untranslated(strprintf("Population failed: %s", util::ErrorString(res).original)));
Line
Count
Source
1172
0
#define strprintf tfm::format
5688
0
    }
5689
5690
0
    LOCK(::cs_main);  // cs_main required for rest of snapshot activation.
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5691
5692
    // Do a final check to ensure that the snapshot chainstate is actually a more
5693
    // work chain than the active chainstate; a user could have loaded a snapshot
5694
    // very late in the IBD process, and we wouldn't want to load a useless chainstate.
5695
0
    if (!CBlockIndexWorkComparator()(ActiveTip(), snapshot_chainstate->m_chain.Tip())) {
5696
0
        return cleanup_bad_snapshot(Untranslated("work does not exceed active chainstate"));
5697
0
    }
5698
    // If not in-memory, persist the base blockhash for use during subsequent
5699
    // initialization.
5700
0
    if (!in_memory) {
5701
0
        if (!node::WriteSnapshotBaseBlockhash(*snapshot_chainstate)) {
5702
0
            return cleanup_bad_snapshot(Untranslated("could not write base blockhash"));
5703
0
        }
5704
0
    }
5705
5706
0
    Chainstate& chainstate{AddChainstate(std::move(snapshot_chainstate))};
5707
0
    m_blockman.m_snapshot_height = Assert(chainstate.SnapshotBase())->nHeight;
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
5708
5709
0
    chainstate.PopulateBlockIndexCandidates();
5710
5711
0
    LogInfo("[snapshot] successfully activated snapshot %s", base_blockhash.ToString());
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5712
0
    LogInfo("[snapshot] (%.2f MB)",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5713
0
              chainstate.CoinsTip().DynamicMemoryUsage() / (1000 * 1000));
5714
5715
0
    this->MaybeRebalanceCaches();
5716
0
    return snapshot_start_block;
5717
0
}
5718
5719
static void FlushSnapshotToDisk(CCoinsViewCache& coins_cache, bool snapshot_loaded)
5720
0
{
5721
0
    LOG_TIME_MILLIS_WITH_CATEGORY_MSG_ONCE(
Line
Count
Source
106
0
    BCLog::Timer<std::chrono::milliseconds> UNIQUE_NAME(logging_timer)(__func__, end_msg, log_category, /* msg_on_completion=*/false)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5722
0
        strprintf("%s (%.2f MB)",
5723
0
                  snapshot_loaded ? "saving snapshot chainstate" : "flushing coins cache",
5724
0
                  coins_cache.DynamicMemoryUsage() / (1000 * 1000)),
5725
0
        BCLog::LogFlags::ALL);
5726
5727
0
    coins_cache.Flush();
5728
0
}
5729
5730
struct StopHashingException : public std::exception
5731
{
5732
    const char* what() const noexcept override
5733
0
    {
5734
0
        return "ComputeUTXOStats interrupted.";
5735
0
    }
5736
};
5737
5738
static void SnapshotUTXOHashBreakpoint(const util::SignalInterrupt& interrupt)
5739
0
{
5740
0
    if (interrupt) throw StopHashingException();
5741
0
}
5742
5743
util::Result<void> ChainstateManager::PopulateAndValidateSnapshot(
5744
    Chainstate& snapshot_chainstate,
5745
    AutoFile& coins_file,
5746
    const SnapshotMetadata& metadata)
5747
0
{
5748
    // It's okay to release cs_main before we're done using `coins_cache` because we know
5749
    // that nothing else will be referencing the newly created snapshot_chainstate yet.
5750
0
    CCoinsViewCache& coins_cache = *WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsTip());
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
5751
5752
0
    uint256 base_blockhash = metadata.m_base_blockhash;
5753
5754
0
    CBlockIndex* snapshot_start_block = WITH_LOCK(::cs_main, return m_blockman.LookupBlockIndex(base_blockhash));
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
5755
5756
0
    if (!snapshot_start_block) {
5757
        // Needed for ComputeUTXOStats to determine the
5758
        // height and to avoid a crash when base_blockhash.IsNull()
5759
0
        return util::Error{Untranslated(strprintf("Did not find snapshot start blockheader %s",
Line
Count
Source
1172
0
#define strprintf tfm::format
5760
0
                  base_blockhash.ToString()))};
5761
0
    }
5762
5763
0
    int base_height = snapshot_start_block->nHeight;
5764
0
    const auto& maybe_au_data = GetParams().AssumeutxoForHeight(base_height);
5765
5766
0
    if (!maybe_au_data) {
5767
0
        return util::Error{Untranslated(strprintf("Assumeutxo height in snapshot metadata not recognized "
Line
Count
Source
1172
0
#define strprintf tfm::format
5768
0
                  "(%d) - refusing to load snapshot", base_height))};
5769
0
    }
5770
5771
0
    const AssumeutxoData& au_data = *maybe_au_data;
5772
5773
    // This work comparison is a duplicate check with the one performed later in
5774
    // ActivateSnapshot(), but is done so that we avoid doing the long work of staging
5775
    // a snapshot that isn't actually usable.
5776
0
    if (WITH_LOCK(::cs_main, return !CBlockIndexWorkComparator()(ActiveTip(), snapshot_start_block))) {
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
5777
0
        return util::Error{Untranslated("Work does not exceed active chainstate")};
5778
0
    }
5779
5780
0
    const uint64_t coins_count = metadata.m_coins_count;
5781
0
    uint64_t coins_left = metadata.m_coins_count;
5782
5783
0
    LogInfo("[snapshot] loading %d coins from snapshot %s", coins_left, base_blockhash.ToString());
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5784
0
    int64_t coins_processed{0};
5785
5786
0
    while (coins_left > 0) {
5787
0
        try {
5788
0
            Txid txid;
5789
0
            coins_file >> txid;
5790
0
            size_t coins_per_txid{0};
5791
0
            coins_per_txid = ReadCompactSize(coins_file);
5792
5793
0
            if (coins_per_txid > coins_left) {
5794
0
                return util::Error{Untranslated("Mismatch in coins count in snapshot metadata and actual snapshot data")};
5795
0
            }
5796
5797
0
            for (size_t i = 0; i < coins_per_txid; i++) {
5798
0
                COutPoint outpoint;
5799
0
                Coin coin;
5800
0
                outpoint.n = static_cast<uint32_t>(ReadCompactSize(coins_file));
5801
0
                outpoint.hash = txid;
5802
0
                coins_file >> coin;
5803
0
                if (coin.nHeight > base_height ||
5804
0
                    outpoint.n >= std::numeric_limits<decltype(outpoint.n)>::max() // Avoid integer wrap-around in coinstats.cpp:ApplyHash
5805
0
                ) {
5806
0
                    return util::Error{Untranslated(strprintf("Bad snapshot data after deserializing %d coins",
Line
Count
Source
1172
0
#define strprintf tfm::format
5807
0
                              coins_count - coins_left))};
5808
0
                }
5809
0
                if (!MoneyRange(coin.out.nValue)) {
5810
0
                    return util::Error{Untranslated(strprintf("Bad snapshot data after deserializing %d coins - bad tx out value",
Line
Count
Source
1172
0
#define strprintf tfm::format
5811
0
                              coins_count - coins_left))};
5812
0
                }
5813
0
                coins_cache.EmplaceCoinInternalDANGER(std::move(outpoint), std::move(coin));
5814
5815
0
                --coins_left;
5816
0
                ++coins_processed;
5817
5818
0
                if (coins_processed % 1000000 == 0) {
5819
0
                    LogInfo("[snapshot] %d coins loaded (%.2f%%, %.2f MB)",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5820
0
                        coins_processed,
5821
0
                        static_cast<float>(coins_processed) * 100 / static_cast<float>(coins_count),
5822
0
                        coins_cache.DynamicMemoryUsage() / (1000 * 1000));
5823
0
                }
5824
5825
                // Batch write and flush (if we need to) every so often.
5826
                //
5827
                // If our average Coin size is roughly 41 bytes, checking every 120,000 coins
5828
                // means <5MB of memory imprecision.
5829
0
                if (coins_processed % 120000 == 0) {
5830
0
                    if (m_interrupt) {
5831
0
                        return util::Error{Untranslated("Aborting after an interrupt was requested")};
5832
0
                    }
5833
5834
0
                    const auto snapshot_cache_state = WITH_LOCK(::cs_main,
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
5835
0
                        return snapshot_chainstate.GetCoinsCacheSizeState());
5836
5837
0
                    if (snapshot_cache_state >= CoinsCacheSizeState::CRITICAL) {
5838
                        // This is a hack - we don't know what the actual best block is, but that
5839
                        // doesn't matter for the purposes of flushing the cache here. We'll set this
5840
                        // to its correct value (`base_blockhash`) below after the coins are loaded.
5841
0
                        coins_cache.SetBestBlock(GetRandHash());
5842
5843
                        // No need to acquire cs_main since this chainstate isn't being used yet.
5844
0
                        FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/false);
5845
0
                    }
5846
0
                }
5847
0
            }
5848
0
        } catch (const std::ios_base::failure&) {
5849
0
            return util::Error{Untranslated(strprintf("Bad snapshot format or truncated snapshot after deserializing %d coins",
Line
Count
Source
1172
0
#define strprintf tfm::format
5850
0
                      coins_processed))};
5851
0
        }
5852
0
    }
5853
5854
    // Important that we set this. This and the coins_cache accesses above are
5855
    // sort of a layer violation, but either we reach into the innards of
5856
    // CCoinsViewCache here or we have to invert some of the Chainstate to
5857
    // embed them in a snapshot-activation-specific CCoinsViewCache bulk load
5858
    // method.
5859
0
    coins_cache.SetBestBlock(base_blockhash);
5860
5861
0
    bool out_of_coins{false};
5862
0
    try {
5863
0
        std::byte left_over_byte;
5864
0
        coins_file >> left_over_byte;
5865
0
    } catch (const std::ios_base::failure&) {
5866
        // We expect an exception since we should be out of coins.
5867
0
        out_of_coins = true;
5868
0
    }
5869
0
    if (!out_of_coins) {
5870
0
        return util::Error{Untranslated(strprintf("Bad snapshot - coins left over after deserializing %d coins",
Line
Count
Source
1172
0
#define strprintf tfm::format
5871
0
            coins_count))};
5872
0
    }
5873
5874
0
    LogInfo("[snapshot] loaded %d (%.2f MB) coins from snapshot %s",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5875
0
        coins_count,
5876
0
        coins_cache.DynamicMemoryUsage() / (1000 * 1000),
5877
0
        base_blockhash.ToString());
5878
5879
    // No need to acquire cs_main since this chainstate isn't being used yet.
5880
0
    FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/true);
5881
5882
0
    assert(coins_cache.GetBestBlock() == base_blockhash);
5883
5884
    // As above, okay to immediately release cs_main here since no other context knows
5885
    // about the snapshot_chainstate.
5886
0
    CCoinsViewDB* snapshot_coinsdb = WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsDB());
Line
Count
Source
299
0
#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
5887
5888
0
    std::optional<CCoinsStats> maybe_stats;
5889
5890
0
    try {
5891
0
        maybe_stats = ComputeUTXOStats(
5892
0
            CoinStatsHashType::HASH_SERIALIZED, snapshot_coinsdb, m_blockman, [&interrupt = m_interrupt] { SnapshotUTXOHashBreakpoint(interrupt); });
5893
0
    } catch (StopHashingException const&) {
5894
0
        return util::Error{Untranslated("Aborting after an interrupt was requested")};
5895
0
    }
5896
0
    if (!maybe_stats.has_value()) {
5897
0
        return util::Error{Untranslated("Failed to generate coins stats")};
5898
0
    }
5899
5900
    // Assert that the deserialized chainstate contents match the expected assumeutxo value.
5901
0
    if (AssumeutxoHash{maybe_stats->hashSerialized} != au_data.hash_serialized) {
5902
0
        return util::Error{Untranslated(strprintf("Bad snapshot content hash: expected %s, got %s",
Line
Count
Source
1172
0
#define strprintf tfm::format
5903
0
            au_data.hash_serialized.ToString(), maybe_stats->hashSerialized.ToString()))};
5904
0
    }
5905
5906
0
    snapshot_chainstate.m_chain.SetTip(*snapshot_start_block);
5907
5908
    // The remainder of this function requires modifying data protected by cs_main.
5909
0
    LOCK(::cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
5910
5911
    // Fake various pieces of CBlockIndex state:
5912
0
    CBlockIndex* index = nullptr;
5913
5914
    // Don't make any modifications to the genesis block since it shouldn't be
5915
    // necessary, and since the genesis block doesn't have normal flags like
5916
    // BLOCK_VALID_SCRIPTS set.
5917
0
    constexpr int AFTER_GENESIS_START{1};
5918
5919
0
    for (int i = AFTER_GENESIS_START; i <= snapshot_chainstate.m_chain.Height(); ++i) {
5920
0
        index = snapshot_chainstate.m_chain[i];
5921
5922
        // Fake BLOCK_OPT_WITNESS so that Chainstate::NeedsRedownload()
5923
        // won't ask for -reindex on startup.
5924
0
        if (DeploymentActiveAt(*index, *this, Consensus::DEPLOYMENT_SEGWIT)) {
5925
0
            index->nStatus |= BLOCK_OPT_WITNESS;
5926
0
        }
5927
5928
0
        m_blockman.m_dirty_blockindex.insert(index);
5929
        // Changes to the block index will be flushed to disk after this call
5930
        // returns in `ActivateSnapshot()`, when `MaybeRebalanceCaches()` is
5931
        // called, since we've added a snapshot chainstate and therefore will
5932
        // have to downsize the IBD chainstate, which will result in a call to
5933
        // `FlushStateToDisk(FORCE_FLUSH)`.
5934
0
    }
5935
5936
0
    assert(index);
5937
0
    assert(index == snapshot_start_block);
5938
0
    index->m_chain_tx_count = au_data.m_chain_tx_count;
5939
5940
0
    LogInfo("[snapshot] validated snapshot (%.2f MB)",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5941
0
        coins_cache.DynamicMemoryUsage() / (1000 * 1000));
5942
0
    return {};
5943
0
}
5944
5945
// Currently, this function holds cs_main for its duration, which could be for
5946
// multiple minutes due to the ComputeUTXOStats call. Holding cs_main used to be
5947
// necessary (before d43a1f1a2fa3) to avoid advancing validated_cs farther than
5948
// its target block. Now it should be possible to avoid this, but simply
5949
// releasing cs_main here would not be possible because this function is invoked
5950
// by ConnectTip within ActivateBestChain.
5951
//
5952
// Eventually (TODO) it would be better to call this function outside of
5953
// ActivateBestChain, on a separate thread that should not require cs_main to
5954
// hash, because the UTXO set is only hashed after the historical chainstate
5955
// reaches its target block and is no longer changing.
5956
SnapshotCompletionResult ChainstateManager::MaybeValidateSnapshot(Chainstate& validated_cs, Chainstate& unvalidated_cs)
5957
0
{
5958
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
5959
5960
    // If the snapshot does not need to be validated...
5961
0
    if (unvalidated_cs.m_assumeutxo != Assumeutxo::UNVALIDATED ||
5962
            // Or if either chainstate is unusable...
5963
0
            !unvalidated_cs.m_from_snapshot_blockhash ||
5964
0
            validated_cs.m_assumeutxo != Assumeutxo::VALIDATED ||
5965
0
            !validated_cs.m_chain.Tip() ||
5966
            // Or the validated chainstate is not targeting the snapshot block...
5967
0
            !validated_cs.m_target_blockhash ||
5968
0
            *validated_cs.m_target_blockhash != *unvalidated_cs.m_from_snapshot_blockhash ||
5969
            // Or the validated chainstate has not reached the snapshot block yet...
5970
0
            !validated_cs.ReachedTarget()) {
5971
       // Then the snapshot cannot be validated and there is nothing to do.
5972
0
       return SnapshotCompletionResult::SKIPPED;
5973
0
    }
5974
0
    assert(validated_cs.TargetBlock() == validated_cs.m_chain.Tip());
5975
5976
0
    auto handle_invalid_snapshot = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
5977
0
        bilingual_str user_error = strprintf(_(
Line
Count
Source
1172
0
#define strprintf tfm::format
5978
0
            "%s failed to validate the -assumeutxo snapshot state. "
5979
0
            "This indicates a hardware problem, or a bug in the software, or a "
5980
0
            "bad software modification that allowed an invalid snapshot to be "
5981
0
            "loaded. As a result of this, the node will shut down and stop using any "
5982
0
            "state that was built on the snapshot, resetting the chain height "
5983
0
            "from %d to %d. On the next "
5984
0
            "restart, the node will resume syncing from %d "
5985
0
            "without using any snapshot data. "
5986
0
            "Please report this incident to %s, including how you obtained the snapshot. "
5987
0
            "The invalid snapshot chainstate will be left on disk in case it is "
5988
0
            "helpful in diagnosing the issue that caused this error."),
5989
0
            CLIENT_NAME, unvalidated_cs.m_chain.Height(),
Line
Count
Source
98
0
#define CLIENT_NAME "Bitcoin Core"
5990
0
            validated_cs.m_chain.Height(),
5991
0
            validated_cs.m_chain.Height(), CLIENT_BUGREPORT);
Line
Count
Source
95
0
#define CLIENT_BUGREPORT "https://github.com/bitcoin/bitcoin/issues"
5992
5993
0
        LogError("[snapshot] !!! %s\n", user_error.original);
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5994
0
        LogError("[snapshot] deleting snapshot, reverting to validated chain, and stopping node\n");
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
5995
5996
        // Reset chainstate target to network tip instead of snapshot block.
5997
0
        validated_cs.SetTargetBlock(nullptr);
5998
5999
0
        unvalidated_cs.m_assumeutxo = Assumeutxo::INVALID;
6000
6001
0
        auto rename_result = unvalidated_cs.InvalidateCoinsDBOnDisk();
6002
0
        if (!rename_result) {
6003
0
            user_error += Untranslated("\n") + util::ErrorString(rename_result);
6004
0
        }
6005
6006
0
        GetNotifications().fatalError(user_error);
6007
0
    };
6008
6009
0
    CCoinsViewDB& validated_coins_db = validated_cs.CoinsDB();
6010
0
    validated_cs.ForceFlushStateToDisk();
6011
6012
0
    const auto& maybe_au_data = m_options.chainparams.AssumeutxoForHeight(validated_cs.m_chain.Height());
6013
0
    if (!maybe_au_data) {
6014
0
        LogWarning("[snapshot] assumeutxo data not found for height "
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6015
0
            "(%d) - refusing to validate snapshot", validated_cs.m_chain.Height());
6016
0
        handle_invalid_snapshot();
6017
0
        return SnapshotCompletionResult::MISSING_CHAINPARAMS;
6018
0
    }
6019
6020
0
    const AssumeutxoData& au_data = *maybe_au_data;
6021
0
    std::optional<CCoinsStats> validated_cs_stats;
6022
0
    LogInfo("[snapshot] computing UTXO stats for background chainstate to validate "
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6023
0
        "snapshot - this could take a few minutes");
6024
0
    try {
6025
0
        validated_cs_stats = ComputeUTXOStats(
6026
0
            CoinStatsHashType::HASH_SERIALIZED,
6027
0
            &validated_coins_db,
6028
0
            m_blockman,
6029
0
            [&interrupt = m_interrupt] { SnapshotUTXOHashBreakpoint(interrupt); });
6030
0
    } catch (StopHashingException const&) {
6031
0
        return SnapshotCompletionResult::STATS_FAILED;
6032
0
    }
6033
6034
    // XXX note that this function is slow and will hold cs_main for potentially minutes.
6035
0
    if (!validated_cs_stats) {
6036
0
        LogWarning("[snapshot] failed to generate stats for validation coins db");
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6037
        // While this isn't a problem with the snapshot per se, this condition
6038
        // prevents us from validating the snapshot, so we should shut down and let the
6039
        // user handle the issue manually.
6040
0
        handle_invalid_snapshot();
6041
0
        return SnapshotCompletionResult::STATS_FAILED;
6042
0
    }
6043
6044
    // Compare the validated chainstate's UTXO set hash against the hard-coded
6045
    // assumeutxo hash we expect.
6046
    //
6047
    // TODO: For belt-and-suspenders, we could cache the UTXO set
6048
    // hash for the snapshot when it's loaded in its chainstate's leveldb. We could then
6049
    // reference that here for an additional check.
6050
0
    if (AssumeutxoHash{validated_cs_stats->hashSerialized} != au_data.hash_serialized) {
6051
0
        LogWarning("[snapshot] hash mismatch: actual=%s, expected=%s",
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6052
0
            validated_cs_stats->hashSerialized.ToString(),
6053
0
            au_data.hash_serialized.ToString());
6054
0
        handle_invalid_snapshot();
6055
0
        return SnapshotCompletionResult::HASH_MISMATCH;
6056
0
    }
6057
6058
0
    LogInfo("[snapshot] snapshot beginning at %s has been fully validated",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6059
0
        unvalidated_cs.m_from_snapshot_blockhash->ToString());
6060
6061
0
    unvalidated_cs.m_assumeutxo = Assumeutxo::VALIDATED;
6062
0
    validated_cs.m_target_utxohash = AssumeutxoHash{validated_cs_stats->hashSerialized};
6063
0
    this->MaybeRebalanceCaches();
6064
6065
0
    return SnapshotCompletionResult::SUCCESS;
6066
0
}
6067
6068
Chainstate& ChainstateManager::ActiveChainstate() const
6069
65
{
6070
65
    LOCK(::cs_main);
Line
Count
Source
268
65
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
65
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
65
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
65
#define PASTE(x, y) x ## y
6071
65
    return CurrentChainstate();
6072
65
}
6073
6074
void ChainstateManager::MaybeRebalanceCaches()
6075
0
{
6076
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
6077
0
    Chainstate& current_cs{CurrentChainstate()};
6078
0
    Chainstate* historical_cs{HistoricalChainstate()};
6079
0
    if (!historical_cs && !current_cs.m_from_snapshot_blockhash) {
6080
        // Allocate everything to the IBD chainstate. This will always happen
6081
        // when we are not using a snapshot.
6082
0
        current_cs.ResizeCoinsCaches(m_total_coinstip_cache, m_total_coinsdb_cache);
6083
0
    } else if (!historical_cs) {
6084
        // If background validation has completed and snapshot is our active chain...
6085
0
        LogInfo("[snapshot] allocating all cache to the snapshot chainstate");
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6086
        // Allocate everything to the snapshot chainstate.
6087
0
        current_cs.ResizeCoinsCaches(m_total_coinstip_cache, m_total_coinsdb_cache);
6088
0
    } else {
6089
        // If both chainstates exist, determine who needs more cache based on IBD status.
6090
        //
6091
        // Note: shrink caches first so that we don't inadvertently overwhelm available memory.
6092
0
        if (IsInitialBlockDownload()) {
6093
0
            historical_cs->ResizeCoinsCaches(
6094
0
                m_total_coinstip_cache * 0.05, m_total_coinsdb_cache * 0.05);
6095
0
            current_cs.ResizeCoinsCaches(
6096
0
                m_total_coinstip_cache * 0.95, m_total_coinsdb_cache * 0.95);
6097
0
        } else {
6098
0
            current_cs.ResizeCoinsCaches(
6099
0
                m_total_coinstip_cache * 0.05, m_total_coinsdb_cache * 0.05);
6100
0
            historical_cs->ResizeCoinsCaches(
6101
0
                m_total_coinstip_cache * 0.95, m_total_coinsdb_cache * 0.95);
6102
0
        }
6103
0
    }
6104
0
}
6105
6106
void ChainstateManager::ResetChainstates()
6107
0
{
6108
0
    m_chainstates.clear();
6109
0
}
6110
6111
/**
6112
 * Apply default chain params to nullopt members.
6113
 * This helps to avoid coding errors around the accidental use of the compare
6114
 * operators that accept nullopt, thus ignoring the intended default value.
6115
 */
6116
static ChainstateManager::Options&& Flatten(ChainstateManager::Options&& opts)
6117
0
{
6118
0
    if (!opts.check_block_index.has_value()) opts.check_block_index = opts.chainparams.DefaultConsistencyChecks();
6119
0
    if (!opts.minimum_chain_work.has_value()) opts.minimum_chain_work = UintToArith256(opts.chainparams.GetConsensus().nMinimumChainWork);
6120
0
    if (!opts.assumed_valid_block.has_value()) opts.assumed_valid_block = opts.chainparams.GetConsensus().defaultAssumeValid;
6121
0
    return std::move(opts);
6122
0
}
6123
6124
ChainstateManager::ChainstateManager(const util::SignalInterrupt& interrupt, Options options, node::BlockManager::Options blockman_options)
6125
0
    : m_script_check_queue{/*batch_size=*/128, std::clamp(options.worker_threads_num, 0, MAX_SCRIPTCHECK_THREADS)},
6126
0
      m_interrupt{interrupt},
6127
0
      m_options{Flatten(std::move(options))},
6128
0
      m_blockman{interrupt, std::move(blockman_options)},
6129
0
      m_validation_cache{m_options.script_execution_cache_bytes, m_options.signature_cache_bytes}
6130
0
{
6131
0
}
6132
6133
ChainstateManager::~ChainstateManager()
6134
1
{
6135
1
    LOCK(::cs_main);
Line
Count
Source
268
1
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
1
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
1
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
1
#define PASTE(x, y) x ## y
6136
6137
1
    m_versionbitscache.Clear();
6138
1
}
6139
6140
Chainstate* ChainstateManager::LoadAssumeutxoChainstate()
6141
0
{
6142
0
    assert(!CurrentChainstate().m_from_snapshot_blockhash);
6143
0
    std::optional<fs::path> path = node::FindAssumeutxoChainstateDir(m_options.datadir);
6144
0
    if (!path) {
6145
0
        return nullptr;
6146
0
    }
6147
0
    std::optional<uint256> base_blockhash = node::ReadSnapshotBaseBlockhash(*path);
6148
0
    if (!base_blockhash) {
6149
0
        return nullptr;
6150
0
    }
6151
0
    LogInfo("[snapshot] detected active snapshot chainstate (%s) - loading",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6152
0
        fs::PathToString(*path));
6153
6154
0
    auto snapshot_chainstate{std::make_unique<Chainstate>(nullptr, m_blockman, *this, base_blockhash)};
6155
0
    LogInfo("[snapshot] switching active chainstate to %s", snapshot_chainstate->ToString());
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6156
0
    return &this->AddChainstate(std::move(snapshot_chainstate));
6157
0
}
6158
6159
Chainstate& ChainstateManager::AddChainstate(std::unique_ptr<Chainstate> chainstate)
6160
0
{
6161
0
    Chainstate& prev_chainstate{CurrentChainstate()};
6162
0
    assert(prev_chainstate.m_assumeutxo == Assumeutxo::VALIDATED);
6163
    // Set target block for historical chainstate to snapshot block.
6164
0
    assert(!prev_chainstate.m_target_blockhash);
6165
0
    prev_chainstate.m_target_blockhash = chainstate->m_from_snapshot_blockhash;
6166
0
    m_chainstates.push_back(std::move(chainstate));
6167
0
    Chainstate& curr_chainstate{CurrentChainstate()};
6168
0
    assert(&curr_chainstate == m_chainstates.back().get());
6169
6170
    // Transfer possession of the mempool to the chainstate.
6171
    // Mempool is empty at this point because we're still in IBD.
6172
0
    assert(!prev_chainstate.m_mempool || prev_chainstate.m_mempool->size() == 0);
6173
0
    assert(!curr_chainstate.m_mempool);
6174
0
    std::swap(curr_chainstate.m_mempool, prev_chainstate.m_mempool);
6175
0
    return curr_chainstate;
6176
0
}
6177
6178
bool IsBIP30Repeat(const CBlockIndex& block_index)
6179
0
{
6180
0
    return (block_index.nHeight==91842 && block_index.GetBlockHash() == uint256{"00000000000a4d0a398161ffc163c503763b1f4360639393e0e4c8e300e0caec"}) ||
6181
0
           (block_index.nHeight==91880 && block_index.GetBlockHash() == uint256{"00000000000743f190a18c5577a3c2d2a1f610ae9601ac046a38084ccb7cd721"});
6182
0
}
6183
6184
bool IsBIP30Unspendable(const uint256& block_hash, int block_height)
6185
0
{
6186
0
    return (block_height==91722 && block_hash == uint256{"00000000000271a2dc26e7667f8419f2e15416dc6955e5a6c6cdf3f2574dd08e"}) ||
6187
0
           (block_height==91812 && block_hash == uint256{"00000000000af0aed4792b1acee3d966af36cf5def14935db8de83d6f9306f2f"});
6188
0
}
6189
6190
util::Result<void> Chainstate::InvalidateCoinsDBOnDisk()
6191
0
{
6192
    // Should never be called on a non-snapshot chainstate.
6193
0
    assert(m_from_snapshot_blockhash);
6194
6195
    // Coins views no longer usable.
6196
0
    m_coins_views.reset();
6197
6198
0
    const fs::path db_path{StoragePath()};
6199
0
    const fs::path invalid_path{db_path + "_INVALID"};
6200
0
    const std::string db_path_str{fs::PathToString(db_path)};
6201
0
    const std::string invalid_path_str{fs::PathToString(invalid_path)};
6202
0
    LogInfo("[snapshot] renaming snapshot datadir %s to %s", db_path_str, invalid_path_str);
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6203
6204
    // The invalid storage directory is simply moved and not deleted because we may
6205
    // want to do forensics later during issue investigation. The user is instructed
6206
    // accordingly in MaybeValidateSnapshot().
6207
0
    try {
6208
0
        fs::rename(db_path, invalid_path);
6209
0
    } catch (const fs::filesystem_error& e) {
6210
0
        LogError("While invalidating the coins db: Error renaming file '%s' -> '%s': %s",
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6211
0
                 db_path_str, invalid_path_str, e.what());
6212
0
        return util::Error{strprintf(_(
Line
Count
Source
1172
0
#define strprintf tfm::format
6213
0
            "Rename of '%s' -> '%s' failed. "
6214
0
            "You should resolve this by manually moving or deleting the invalid "
6215
0
            "snapshot directory %s, otherwise you will encounter the same error again "
6216
0
            "on the next startup."),
6217
0
            db_path_str, invalid_path_str, db_path_str)};
6218
0
    }
6219
0
    return {};
6220
0
}
6221
6222
bool ChainstateManager::DeleteChainstate(Chainstate& chainstate)
6223
0
{
6224
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
6225
0
    assert(!chainstate.m_coins_views);
6226
0
    const fs::path db_path{chainstate.StoragePath()};
6227
0
    if (!DeleteCoinsDBFromDisk(db_path, /*is_snapshot=*/bool{chainstate.m_from_snapshot_blockhash})) {
6228
0
        LogError("Deletion of %s failed. Please remove it manually to continue reindexing.",
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6229
0
                  fs::PathToString(db_path));
6230
0
        return false;
6231
0
    }
6232
0
    std::unique_ptr<Chainstate> prev_chainstate{Assert(RemoveChainstate(chainstate))};
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
6233
0
    Chainstate& curr_chainstate{CurrentChainstate()};
6234
0
    assert(prev_chainstate->m_mempool->size() == 0);
6235
0
    assert(!curr_chainstate.m_mempool);
6236
0
    std::swap(curr_chainstate.m_mempool, prev_chainstate->m_mempool);
6237
0
    return true;
6238
0
}
6239
6240
ChainstateRole Chainstate::GetRole() const
6241
0
{
6242
0
    return ChainstateRole{.validated = m_assumeutxo == Assumeutxo::VALIDATED, .historical = bool{m_target_blockhash}};
6243
0
}
6244
6245
void ChainstateManager::RecalculateBestHeader()
6246
0
{
6247
0
    AssertLockHeld(cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
6248
0
    m_best_header = ActiveChain().Tip();
6249
0
    for (auto& entry : m_blockman.m_block_index) {
6250
0
        if (!(entry.second.nStatus & BLOCK_FAILED_VALID) && m_best_header->nChainWork < entry.second.nChainWork) {
6251
0
            m_best_header = &entry.second;
6252
0
        }
6253
0
    }
6254
0
}
6255
6256
std::optional<int> ChainstateManager::BlocksAheadOfTip() const
6257
0
{
6258
0
    LOCK(::cs_main);
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
6259
0
    const CBlockIndex* best_header{m_best_header};
6260
0
    const CBlockIndex* tip{ActiveChain().Tip()};
6261
    // Only consider headers that extend the active tip; ignore competing branches.
6262
0
    if (best_header && tip && best_header->nChainWork > tip->nChainWork &&
6263
0
        best_header->GetAncestor(tip->nHeight) == tip) {
6264
0
        return best_header->nHeight - tip->nHeight;
6265
0
    }
6266
0
    return std::nullopt;
6267
0
}
6268
6269
bool ChainstateManager::ValidatedSnapshotCleanup(Chainstate& validated_cs, Chainstate& unvalidated_cs)
6270
0
{
6271
0
    AssertLockHeld(::cs_main);
Line
Count
Source
144
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
6272
0
    if (unvalidated_cs.m_assumeutxo != Assumeutxo::VALIDATED) {
6273
        // No need to clean up.
6274
0
        return false;
6275
0
    }
6276
6277
0
    const fs::path validated_path{validated_cs.StoragePath()};
6278
0
    const fs::path assumed_valid_path{unvalidated_cs.StoragePath()};
6279
0
    const fs::path delete_path{validated_path + "_todelete"};
6280
6281
    // Since we're going to be moving around the underlying leveldb filesystem content
6282
    // for each chainstate, make sure that the chainstates (and their constituent
6283
    // CoinsViews members) have been destructed first.
6284
    //
6285
    // The caller of this method will be responsible for reinitializing chainstates
6286
    // if they want to continue operation.
6287
0
    this->ResetChainstates();
6288
0
    assert(this->m_chainstates.size() == 0);
6289
6290
0
    LogInfo("[snapshot] deleting background chainstate directory (now unnecessary) (%s)",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6291
0
              fs::PathToString(validated_path));
6292
6293
0
    auto rename_failed_abort = [this](
6294
0
                                   fs::path p_old,
6295
0
                                   fs::path p_new,
6296
0
                                   const fs::filesystem_error& err) {
6297
0
        LogError("[snapshot] Error renaming path (%s) -> (%s): %s\n",
Line
Count
Source
99
0
#define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6298
0
                  fs::PathToString(p_old), fs::PathToString(p_new), err.what());
6299
0
        GetNotifications().fatalError(strprintf(_(
Line
Count
Source
1172
0
#define strprintf tfm::format
6300
0
            "Rename of '%s' -> '%s' failed. "
6301
0
            "Cannot clean up the background chainstate leveldb directory."),
6302
0
            fs::PathToString(p_old), fs::PathToString(p_new)));
6303
0
    };
6304
6305
0
    try {
6306
0
        fs::rename(validated_path, delete_path);
6307
0
    } catch (const fs::filesystem_error& e) {
6308
0
        rename_failed_abort(validated_path, delete_path, e);
6309
0
        throw;
6310
0
    }
6311
6312
0
    LogInfo("[snapshot] moving snapshot chainstate (%s) to "
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6313
0
              "default chainstate directory (%s)",
6314
0
              fs::PathToString(assumed_valid_path), fs::PathToString(validated_path));
6315
6316
0
    try {
6317
0
        fs::rename(assumed_valid_path, validated_path);
6318
0
    } catch (const fs::filesystem_error& e) {
6319
0
        rename_failed_abort(assumed_valid_path, validated_path, e);
6320
0
        throw;
6321
0
    }
6322
6323
0
    if (!DeleteCoinsDBFromDisk(delete_path, /*is_snapshot=*/false)) {
6324
        // No need to FatalError because once the unneeded bg chainstate data is
6325
        // moved, it will not interfere with subsequent initialization.
6326
0
        LogWarning("Deletion of %s failed. Please remove it manually, as the "
Line
Count
Source
98
0
#define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6327
0
                   "directory is now unnecessary.",
6328
0
                   fs::PathToString(delete_path));
6329
0
    } else {
6330
0
        LogInfo("[snapshot] deleted background chainstate directory (%s)",
Line
Count
Source
97
0
#define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/true, __VA_ARGS__)
Line
Count
Source
91
0
#define LogPrintLevel_(category, level, should_ratelimit, ...) LogPrintFormatInternal(SourceLocation{__func__}, category, level, should_ratelimit, __VA_ARGS__)
6331
0
                fs::PathToString(validated_path));
6332
0
    }
6333
0
    return true;
6334
0
}
6335
6336
std::pair<int, int> Chainstate::GetPruneRange(int last_height_can_prune) const
6337
0
{
6338
0
    if (m_chain.Height() <= 0) {
6339
0
        return {0, 0};
6340
0
    }
6341
0
    int prune_start{0};
6342
6343
0
    if (m_from_snapshot_blockhash && m_assumeutxo != Assumeutxo::VALIDATED) {
6344
        // Only prune blocks _after_ the snapshot if this is a snapshot chain
6345
        // that has not been fully validated yet. The earlier blocks need to be
6346
        // kept to validate the snapshot
6347
0
        prune_start = Assert(SnapshotBase())->nHeight + 1;
Line
Count
Source
116
0
#define Assert(val) inline_assertion_check<true>(val, std::source_location::current(), #val)
6348
0
    }
6349
6350
0
    int max_prune = std::max<int>(
6351
0
        0, m_chain.Height() - static_cast<int>(MIN_BLOCKS_TO_KEEP));
6352
6353
    // last block to prune is the lesser of (caller-specified height, MIN_BLOCKS_TO_KEEP from the tip)
6354
    //
6355
    // While you might be tempted to prune the background chainstate more
6356
    // aggressively (i.e. fewer MIN_BLOCKS_TO_KEEP), this won't work with index
6357
    // building - specifically blockfilterindex requires undo data, and if
6358
    // we don't maintain this trailing window, we hit indexing failures.
6359
0
    int prune_end = std::min(last_height_can_prune, max_prune);
6360
6361
0
    return {prune_start, prune_end};
6362
0
}
6363
6364
std::optional<std::pair<const CBlockIndex*, const CBlockIndex*>> ChainstateManager::GetHistoricalBlockRange() const
6365
1.87k
{
6366
1.87k
    const Chainstate* chainstate{HistoricalChainstate()};
6367
1.87k
    if (!chainstate) return {};
6368
0
    return std::make_pair(chainstate->m_chain.Tip(), chainstate->TargetBlock());
6369
1.87k
}
6370
6371
util::Result<void> ChainstateManager::ActivateBestChains()
6372
0
{
6373
    // We can't hold cs_main during ActivateBestChain even though we're accessing
6374
    // the chainman unique_ptrs since ABC requires us not to be holding cs_main, so retrieve
6375
    // the relevant pointers before the ABC call.
6376
0
    AssertLockNotHeld(cs_main);
Line
Count
Source
149
0
#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
6377
0
    std::vector<Chainstate*> chainstates;
6378
0
    {
6379
0
        LOCK(GetMutex());
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
6380
0
        chainstates.reserve(m_chainstates.size());
6381
0
        for (const auto& chainstate : m_chainstates) {
6382
0
            if (chainstate && chainstate->m_assumeutxo != Assumeutxo::INVALID && !chainstate->m_target_utxohash) {
6383
0
                chainstates.push_back(chainstate.get());
6384
0
            }
6385
0
        }
6386
0
    }
6387
0
    for (Chainstate* chainstate : chainstates) {
6388
0
        BlockValidationState state;
6389
0
        if (!chainstate->ActivateBestChain(state, nullptr)) {
6390
0
            LOCK(GetMutex());
Line
Count
Source
268
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
6391
0
            return util::Error{Untranslated(strprintf("%s Failed to connect best block (%s)", chainstate->ToString(), state.ToString()))};
Line
Count
Source
1172
0
#define strprintf tfm::format
6392
0
        }
6393
0
    }
6394
0
    return {};
6395
0
}