fuzz coverage

Coverage Report

Created: 2025-06-01 19:34

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