Bitcoin Core Fuzz Coverage Report

Coverage Report

Created: 2026-06-01 16:00

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