Coverage Report

Created: 2025-06-10 13:21

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