Coverage Report

Created: 2026-07-14 18:13

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