Coverage Report

Created: 2025-03-18 19:28

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