Bitcoin Core Fuzz Coverage Report for wallet_tx_can_be_bumped

Coverage Report

Created: 2025-11-19 11:20

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