fuzz coverage

Coverage Report

Created: 2026-05-08 05:52

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