/root/bitcoin/src/coins.cpp

Source
// Copyright (c) 2012-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include <coins.h>

#include <consensus/consensus.h>
#include <random.h>
#include <uint256.h>
#include <util/log.h>
#include <util/trace.h>

TRACEPOINT_SEMAPHORE(utxocache, add);
TRACEPOINT_SEMAPHORE(utxocache, spent);
TRACEPOINT_SEMAPHORE(utxocache, uncache);

CoinsViewEmpty& CoinsViewEmpty::Get()
{
    static CoinsViewEmpty instance;
    return instance;
}

std::optional<Coin> CCoinsViewCache::PeekCoin(const COutPoint& outpoint) const
{
    if (auto it{cacheCoins.find(outpoint)}; it != cacheCoins.end()) {
        return it->second.coin.IsSpent() ? std::nullopt : std::optional{it->second.coin};
    }
    return base->PeekCoin(outpoint);
}

CCoinsViewCache::CCoinsViewCache(CCoinsView* in_base, bool deterministic) :
    CCoinsViewBacked(in_base), m_deterministic(deterministic),
    cacheCoins(0, SaltedOutpointHasher(/*deterministic=*/deterministic), CCoinsMap::key_equal{}, &m_cache_coins_memory_resource)
{
    m_sentinel.second.SelfRef(m_sentinel);
}

size_t CCoinsViewCache::DynamicMemoryUsage() const {
    return memusage::DynamicUsage(cacheCoins) + cachedCoinsUsage;
}

std::optional<Coin> CCoinsViewCache::FetchCoinFromBase(const COutPoint& outpoint) const
{
    return base->GetCoin(outpoint);
}

CCoinsMap::iterator CCoinsViewCache::FetchCoin(const COutPoint &outpoint) const {
    const auto [ret, inserted] = cacheCoins.try_emplace(outpoint);
    if (inserted) {
        if (auto coin{FetchCoinFromBase(outpoint)}) {
            ret->second.coin = std::move(*coin);
            cachedCoinsUsage += ret->second.coin.DynamicMemoryUsage();
            Assert(!ret->second.coin.IsSpent());
        } else {
            cacheCoins.erase(ret);
            return cacheCoins.end();
        }
    }
    return ret;
}

std::optional<Coin> CCoinsViewCache::GetCoin(const COutPoint& outpoint) const
{
    if (auto it{FetchCoin(outpoint)}; it != cacheCoins.end() && !it->second.coin.IsSpent()) return it->second.coin;
    return std::nullopt;
}

void CCoinsViewCache::AddCoin(const COutPoint &outpoint, Coin&& coin, bool possible_overwrite) {
    assert(!coin.IsSpent());
    if (coin.out.scriptPubKey.IsUnspendable()) return;
    CCoinsMap::iterator it;
    bool inserted;
    std::tie(it, inserted) = cacheCoins.emplace(std::piecewise_construct, std::forward_as_tuple(outpoint), std::tuple<>());
    bool fresh = false;
    if (!possible_overwrite) {
        if (!it->second.coin.IsSpent()) {
            throw std::logic_error("Attempted to overwrite an unspent coin (when possible_overwrite is false)");
        }
        // If the coin exists in this cache as a spent coin and is DIRTY, then
        // its spentness hasn't been flushed to the parent cache. We're
        // re-adding the coin to this cache now but we can't mark it as FRESH.
        // If we mark it FRESH and then spend it before the cache is flushed
        // we would remove it from this cache and would never flush spentness
        // to the parent cache.
        //
        // Re-adding a spent coin can happen in the case of a re-org (the coin
        // is 'spent' when the block adding it is disconnected and then
        // re-added when it is also added in a newly connected block).
        //
        // If the coin doesn't exist in the current cache, or is spent but not
        // DIRTY, then it can be marked FRESH.
        fresh = !it->second.IsDirty();
    }
    if (!inserted) {
        Assume(TrySub(m_dirty_count, it->second.IsDirty()));
        Assume(TrySub(cachedCoinsUsage, it->second.coin.DynamicMemoryUsage()));
    }
    it->second.coin = std::move(coin);
    CCoinsCacheEntry::SetDirty(*it, m_sentinel);
    ++m_dirty_count;
    if (fresh) CCoinsCacheEntry::SetFresh(*it, m_sentinel);
    cachedCoinsUsage += it->second.coin.DynamicMemoryUsage();
    TRACEPOINT(utxocache, add,
           outpoint.hash.data(),
           (uint32_t)outpoint.n,
           (uint32_t)it->second.coin.nHeight,
           (int64_t)it->second.coin.out.nValue,
           (bool)it->second.coin.IsCoinBase());
}

void CCoinsViewCache::EmplaceCoinInternalDANGER(COutPoint&& outpoint, Coin&& coin) {
    const auto mem_usage{coin.DynamicMemoryUsage()};
    auto [it, inserted] = cacheCoins.try_emplace(std::move(outpoint), std::move(coin));
    if (inserted) {
        CCoinsCacheEntry::SetDirty(*it, m_sentinel);
        ++m_dirty_count;
        cachedCoinsUsage += mem_usage;
    }
}

void AddCoins(CCoinsViewCache& cache, const CTransaction &tx, int nHeight, bool check_for_overwrite) {
    bool fCoinbase = tx.IsCoinBase();
    const Txid& txid = tx.GetHash();
    for (size_t i = 0; i < tx.vout.size(); ++i) {
        bool overwrite = check_for_overwrite ? cache.HaveCoin(COutPoint(txid, i)) : fCoinbase;
        // Coinbase transactions can always be overwritten, in order to correctly
        // deal with the pre-BIP30 occurrences of duplicate coinbase transactions.
        cache.AddCoin(COutPoint(txid, i), Coin(tx.vout[i], nHeight, fCoinbase), overwrite);
    }
}

bool CCoinsViewCache::SpendCoin(const COutPoint &outpoint, Coin* moveout) {
    CCoinsMap::iterator it = FetchCoin(outpoint);
    if (it == cacheCoins.end()) return false;
    Assume(TrySub(m_dirty_count, it->second.IsDirty()));
    Assume(TrySub(cachedCoinsUsage, it->second.coin.DynamicMemoryUsage()));
    TRACEPOINT(utxocache, spent,
           outpoint.hash.data(),
           (uint32_t)outpoint.n,
           (uint32_t)it->second.coin.nHeight,
           (int64_t)it->second.coin.out.nValue,
           (bool)it->second.coin.IsCoinBase());
    if (moveout) {
        *moveout = std::move(it->second.coin);
    }
    if (it->second.IsFresh()) {
        cacheCoins.erase(it);
    } else {
        CCoinsCacheEntry::SetDirty(*it, m_sentinel);
        ++m_dirty_count;
        it->second.coin.Clear();
    }
    return true;
}

static const Coin coinEmpty;

const Coin& CCoinsViewCache::AccessCoin(const COutPoint &outpoint) const {
    CCoinsMap::const_iterator it = FetchCoin(outpoint);
    if (it == cacheCoins.end()) {
        return coinEmpty;
    } else {
        return it->second.coin;
    }
}

bool CCoinsViewCache::HaveCoin(const COutPoint& outpoint) const
{
    CCoinsMap::const_iterator it = FetchCoin(outpoint);
    return (it != cacheCoins.end() && !it->second.coin.IsSpent());
}

bool CCoinsViewCache::HaveCoinInCache(const COutPoint &outpoint) const {
    CCoinsMap::const_iterator it = cacheCoins.find(outpoint);
    return (it != cacheCoins.end() && !it->second.coin.IsSpent());
}

uint256 CCoinsViewCache::GetBestBlock() const {
    if (m_block_hash.IsNull())
        m_block_hash = base->GetBestBlock();
    return m_block_hash;
}

void CCoinsViewCache::SetBestBlock(const uint256& in_block_hash)
{
    m_block_hash = in_block_hash;
}

void CCoinsViewCache::BatchWrite(CoinsViewCacheCursor& cursor, const uint256& in_block_hash)
{
    for (auto it{cursor.Begin()}; it != cursor.End(); it = cursor.NextAndMaybeErase(*it)) {
        if (!it->second.IsDirty()) { // TODO a cursor can only contain dirty entries
            continue;
        }
        auto [itUs, inserted]{cacheCoins.try_emplace(it->first)};
        if (inserted) {
            if (it->second.IsFresh() && it->second.coin.IsSpent()) {
                cacheCoins.erase(itUs); // TODO fresh coins should have been removed at spend
            } else {
                // The parent cache does not have an entry, while the child cache does.
                // Move the data up and mark it as dirty.
                CCoinsCacheEntry& entry{itUs->second};
                assert(entry.coin.DynamicMemoryUsage() == 0);
                if (cursor.WillErase(*it)) {
                    // Since this entry will be erased,
                    // we can move the coin into us instead of copying it
                    entry.coin = std::move(it->second.coin);
                } else {
                    entry.coin = it->second.coin;
                }
                CCoinsCacheEntry::SetDirty(*itUs, m_sentinel);
                ++m_dirty_count;
                cachedCoinsUsage += entry.coin.DynamicMemoryUsage();
                // We can mark it FRESH in the parent if it was FRESH in the child
                // Otherwise it might have just been flushed from the parent's cache
                // and already exist in the grandparent
                if (it->second.IsFresh()) CCoinsCacheEntry::SetFresh(*itUs, m_sentinel);
            }
        } else {
            // Found the entry in the parent cache
            if (it->second.IsFresh() && !itUs->second.coin.IsSpent()) {
                // The coin was marked FRESH in the child cache, but the coin
                // exists in the parent cache. If this ever happens, it means
                // the FRESH flag was misapplied and there is a logic error in
                // the calling code.
                throw std::logic_error("FRESH flag misapplied to coin that exists in parent cache");
            }

            if (itUs->second.IsFresh() && it->second.coin.IsSpent()) {
                // The grandparent cache does not have an entry, and the coin
                // has been spent. We can just delete it from the parent cache.
                Assume(TrySub(m_dirty_count, itUs->second.IsDirty()));
                Assume(TrySub(cachedCoinsUsage, itUs->second.coin.DynamicMemoryUsage()));
                cacheCoins.erase(itUs);
            } else {
                // A normal modification.
                Assume(TrySub(cachedCoinsUsage, itUs->second.coin.DynamicMemoryUsage()));
                if (cursor.WillErase(*it)) {
                    // Since this entry will be erased,
                    // we can move the coin into us instead of copying it
                    itUs->second.coin = std::move(it->second.coin);
                } else {
                    itUs->second.coin = it->second.coin;
                }
                cachedCoinsUsage += itUs->second.coin.DynamicMemoryUsage();
                if (!itUs->second.IsDirty()) {
                    CCoinsCacheEntry::SetDirty(*itUs, m_sentinel);
                    ++m_dirty_count;
                }
                // NOTE: It isn't safe to mark the coin as FRESH in the parent
                // cache. If it already existed and was spent in the parent
                // cache then marking it FRESH would prevent that spentness
                // from being flushed to the grandparent.
            }
        }
    }
    SetBestBlock(in_block_hash);
}

void CCoinsViewCache::Flush(bool reallocate_cache)
{
    auto cursor{CoinsViewCacheCursor(m_dirty_count, m_sentinel, cacheCoins, /*will_erase=*/true)};
    base->BatchWrite(cursor, m_block_hash);
    Assume(m_dirty_count == 0);
    cacheCoins.clear();
    if (reallocate_cache) {
        ReallocateCache();
    }
    cachedCoinsUsage = 0;
}

void CCoinsViewCache::Sync()
{
    auto cursor{CoinsViewCacheCursor(m_dirty_count, m_sentinel, cacheCoins, /*will_erase=*/false)};
    base->BatchWrite(cursor, m_block_hash);
    Assume(m_dirty_count == 0);
    if (m_sentinel.second.Next() != &m_sentinel) {
        /* BatchWrite must clear flags of all entries */
        throw std::logic_error("Not all unspent flagged entries were cleared");
    }
}

void CCoinsViewCache::Reset() noexcept
{
    cacheCoins.clear();
    cachedCoinsUsage = 0;
    m_dirty_count = 0;
    SetBestBlock(uint256::ZERO);
}

void CCoinsViewCache::Uncache(const COutPoint& hash)
{
    CCoinsMap::iterator it = cacheCoins.find(hash);
    if (it != cacheCoins.end() && !it->second.IsDirty()) {
        Assume(TrySub(cachedCoinsUsage, it->second.coin.DynamicMemoryUsage()));
        TRACEPOINT(utxocache, uncache,
               hash.hash.data(),
               (uint32_t)hash.n,
               (uint32_t)it->second.coin.nHeight,
               (int64_t)it->second.coin.out.nValue,
               (bool)it->second.coin.IsCoinBase());
        cacheCoins.erase(it);
    }
}

unsigned int CCoinsViewCache::GetCacheSize() const {
    return cacheCoins.size();
}

bool CCoinsViewCache::HaveInputs(const CTransaction& tx) const
{
    if (!tx.IsCoinBase()) {
        for (unsigned int i = 0; i < tx.vin.size(); i++) {
            if (!HaveCoin(tx.vin[i].prevout)) {
                return false;
            }
        }
    }
    return true;
}

void CCoinsViewCache::ReallocateCache()
{
    // Cache should be empty when we're calling this.
    assert(cacheCoins.size() == 0);
    cacheCoins.~CCoinsMap();
    m_cache_coins_memory_resource.~CCoinsMapMemoryResource();
    ::new (&m_cache_coins_memory_resource) CCoinsMapMemoryResource{};
    ::new (&cacheCoins) CCoinsMap{0, SaltedOutpointHasher{/*deterministic=*/m_deterministic}, CCoinsMap::key_equal{}, &m_cache_coins_memory_resource};
}

void CCoinsViewCache::SanityCheck() const
{
    size_t recomputed_usage = 0;
    size_t count_dirty = 0;
    for (const auto& [_, entry] : cacheCoins) {
        if (entry.coin.IsSpent()) {
            assert(entry.IsDirty() && !entry.IsFresh()); // A spent coin must be dirty and cannot be fresh
        } else {
            assert(entry.IsDirty() || !entry.IsFresh()); // An unspent coin must not be fresh if not dirty
        }

        // Recompute cachedCoinsUsage.
        recomputed_usage += entry.coin.DynamicMemoryUsage();

        // Count the number of entries we expect in the linked list.
        if (entry.IsDirty()) ++count_dirty;
    }
    // Iterate over the linked list of flagged entries.
    size_t count_linked = 0;
    for (auto it = m_sentinel.second.Next(); it != &m_sentinel; it = it->second.Next()) {
        // Verify linked list integrity.
        assert(it->second.Next()->second.Prev() == it);
        assert(it->second.Prev()->second.Next() == it);
        // Verify they are actually flagged.
        assert(it->second.IsDirty());
        // Count the number of entries actually in the list.
        ++count_linked;
    }
    assert(count_dirty == count_linked && count_dirty == m_dirty_count);
    assert(recomputed_usage == cachedCoinsUsage);
}

static const uint64_t MIN_TRANSACTION_OUTPUT_WEIGHT{WITNESS_SCALE_FACTOR * ::GetSerializeSize(CTxOut())};
static const uint64_t MAX_OUTPUTS_PER_BLOCK{MAX_BLOCK_WEIGHT / MIN_TRANSACTION_OUTPUT_WEIGHT};

const Coin& AccessByTxid(const CCoinsViewCache& view, const Txid& txid)
{
    COutPoint iter(txid, 0);
    while (iter.n < MAX_OUTPUTS_PER_BLOCK) {
        const Coin& alternate = view.AccessCoin(iter);
        if (!alternate.IsSpent()) return alternate;
        ++iter.n;
    }
    return coinEmpty;
}

template <typename ReturnType, typename Func>
static ReturnType ExecuteBackedWrapper(Func func, const std::vector<std::function<void()>>& err_callbacks)
{
    try {
        return func();
    } catch(const std::runtime_error& e) {
        for (const auto& f : err_callbacks) {
            f();
        }
        LogError("Error reading from database: %s\n", e.what());
        // Starting the shutdown sequence and returning false to the caller would be
        // interpreted as 'entry not found' (as opposed to unable to read data), and
        // could lead to invalid interpretation. Just exit immediately, as we can't
        // continue anyway, and all writes should be atomic.
        std::abort();
    }
}

std::optional<Coin> CCoinsViewErrorCatcher::GetCoin(const COutPoint& outpoint) const
{
    return ExecuteBackedWrapper<std::optional<Coin>>([&]() { return CCoinsViewBacked::GetCoin(outpoint); }, m_err_callbacks);
}

bool CCoinsViewErrorCatcher::HaveCoin(const COutPoint& outpoint) const
{
    return ExecuteBackedWrapper<bool>([&]() { return CCoinsViewBacked::HaveCoin(outpoint); }, m_err_callbacks);
}

std::optional<Coin> CCoinsViewErrorCatcher::PeekCoin(const COutPoint& outpoint) const
{
    return ExecuteBackedWrapper<std::optional<Coin>>([&]() { return CCoinsViewBacked::PeekCoin(outpoint); }, m_err_callbacks);
}

Coverage Report

Created: 2026-06-09 19:51

Line	Count	Source
1		// Copyright (c) 2012-present The Bitcoin Core developers
2		// Distributed under the MIT software license, see the accompanying
3		// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5		#include <coins.h>
6
7		#include <consensus/consensus.h>
8		#include <random.h>
9		#include <uint256.h>
10		#include <util/log.h>
11		#include <util/trace.h>
12
13		TRACEPOINT_SEMAPHORE(utxocache, add);
14		TRACEPOINT_SEMAPHORE(utxocache, spent);
15		TRACEPOINT_SEMAPHORE(utxocache, uncache);
16
17		CoinsViewEmpty& CoinsViewEmpty::Get()
18	0	{
19	0	static CoinsViewEmpty instance;
20	0	return instance;
21	0	}
22
23		std::optional<Coin> CCoinsViewCache::PeekCoin(const COutPoint& outpoint) const
24	0	{
25	0	if (auto it{cacheCoins.find(outpoint)}; it != cacheCoins.end()) { Branch (25:45): [True: 0, False: 0]
26	0	return it->second.coin.IsSpent() ? std::nullopt : std::optional{it->second.coin}; Branch (26:16): [True: 0, False: 0]
27	0	}
28	0	return base->PeekCoin(outpoint);
29	0	}
30
31		CCoinsViewCache::CCoinsViewCache(CCoinsView* in_base, bool deterministic) :
32	0	CCoinsViewBacked(in_base), m_deterministic(deterministic),
33	0	cacheCoins(0, SaltedOutpointHasher(/deterministic=/deterministic), CCoinsMap::key_equal{}, &m_cache_coins_memory_resource)
34	0	{
35	0	m_sentinel.second.SelfRef(m_sentinel);
36	0	}
37
38	0	size_t CCoinsViewCache::DynamicMemoryUsage() const {
39	0	return memusage::DynamicUsage(cacheCoins) + cachedCoinsUsage;
40	0	}
41
42		std::optional<Coin> CCoinsViewCache::FetchCoinFromBase(const COutPoint& outpoint) const
43	0	{
44	0	return base->GetCoin(outpoint);
45	0	}
46
47	0	CCoinsMap::iterator CCoinsViewCache::FetchCoin(const COutPoint &outpoint) const {
48	0	const auto [ret, inserted] = cacheCoins.try_emplace(outpoint);
49	0	if (inserted) { Branch (49:9): [True: 0, False: 0]
50	0	if (auto coin{FetchCoinFromBase(outpoint)}) { Branch (50:18): [True: 0, False: 0]
51	0	ret->second.coin = std::move(*coin);
52	0	cachedCoinsUsage += ret->second.coin.DynamicMemoryUsage();
53	0	Assert(!ret->second.coin.IsSpent());
54	0	} else {
55	0	cacheCoins.erase(ret);
56	0	return cacheCoins.end();
57	0	}
58	0	}
59	0	return ret;
60	0	}
61
62		std::optional<Coin> CCoinsViewCache::GetCoin(const COutPoint& outpoint) const
63	0	{
64	0	if (auto it{FetchCoin(outpoint)}; it != cacheCoins.end() && !it->second.coin.IsSpent()) return it->second.coin; Branch (64:39): [True: 0, False: 0] Branch (64:39): [True: 0, False: 0] Branch (64:65): [True: 0, False: 0]
65	0	return std::nullopt;
66	0	}
67
68	0	void CCoinsViewCache::AddCoin(const COutPoint &outpoint, Coin&& coin, bool possible_overwrite) {
69	0	assert(!coin.IsSpent()); Branch (69:5): [True: 0, False: 0]
70	0	if (coin.out.scriptPubKey.IsUnspendable()) return; Branch (70:9): [True: 0, False: 0]
71	0	CCoinsMap::iterator it;
72	0	bool inserted;
73	0	std::tie(it, inserted) = cacheCoins.emplace(std::piecewise_construct, std::forward_as_tuple(outpoint), std::tuple<>());
74	0	bool fresh = false;
75	0	if (!possible_overwrite) { Branch (75:9): [True: 0, False: 0]
76	0	if (!it->second.coin.IsSpent()) { Branch (76:13): [True: 0, False: 0]
77	0	throw std::logic_error("Attempted to overwrite an unspent coin (when possible_overwrite is false)");
78	0	}
79		// If the coin exists in this cache as a spent coin and is DIRTY, then
80		// its spentness hasn't been flushed to the parent cache. We're
81		// re-adding the coin to this cache now but we can't mark it as FRESH.
82		// If we mark it FRESH and then spend it before the cache is flushed
83		// we would remove it from this cache and would never flush spentness
84		// to the parent cache.
85		//
86		// Re-adding a spent coin can happen in the case of a re-org (the coin
87		// is 'spent' when the block adding it is disconnected and then
88		// re-added when it is also added in a newly connected block).
89		//
90		// If the coin doesn't exist in the current cache, or is spent but not
91		// DIRTY, then it can be marked FRESH.
92	0	fresh = !it->second.IsDirty();
93	0	}
94	0	if (!inserted) { Branch (94:9): [True: 0, False: 0]
95	0	Assume(TrySub(m_dirty_count, it->second.IsDirty()));
96	0	Assume(TrySub(cachedCoinsUsage, it->second.coin.DynamicMemoryUsage()));
97	0	}
98	0	it->second.coin = std::move(coin);
99	0	CCoinsCacheEntry::SetDirty(*it, m_sentinel);
100	0	++m_dirty_count;
101	0	if (fresh) CCoinsCacheEntry::SetFresh(*it, m_sentinel); Branch (101:9): [True: 0, False: 0]
102	0	cachedCoinsUsage += it->second.coin.DynamicMemoryUsage();
103	0	TRACEPOINT(utxocache, add,
104	0	outpoint.hash.data(),
105	0	(uint32_t)outpoint.n,
106	0	(uint32_t)it->second.coin.nHeight,
107	0	(int64_t)it->second.coin.out.nValue,
108	0	(bool)it->second.coin.IsCoinBase());
109	0	}
110
111	0	void CCoinsViewCache::EmplaceCoinInternalDANGER(COutPoint&& outpoint, Coin&& coin) {
112	0	const auto mem_usage{coin.DynamicMemoryUsage()};
113	0	auto [it, inserted] = cacheCoins.try_emplace(std::move(outpoint), std::move(coin));
114	0	if (inserted) { Branch (114:9): [True: 0, False: 0]
115	0	CCoinsCacheEntry::SetDirty(*it, m_sentinel);
116	0	++m_dirty_count;
117	0	cachedCoinsUsage += mem_usage;
118	0	}
119	0	}
120
121	0	void AddCoins(CCoinsViewCache& cache, const CTransaction &tx, int nHeight, bool check_for_overwrite) {
122	0	bool fCoinbase = tx.IsCoinBase();
123	0	const Txid& txid = tx.GetHash();
124	0	for (size_t i = 0; i < tx.vout.size(); ++i) { Branch (124:24): [True: 0, False: 0]
125	0	bool overwrite = check_for_overwrite ? cache.HaveCoin(COutPoint(txid, i)) : fCoinbase; Branch (125:26): [True: 0, False: 0]
126		// Coinbase transactions can always be overwritten, in order to correctly
127		// deal with the pre-BIP30 occurrences of duplicate coinbase transactions.
128	0	cache.AddCoin(COutPoint(txid, i), Coin(tx.vout[i], nHeight, fCoinbase), overwrite);
129	0	}
130	0	}
131
132	0	bool CCoinsViewCache::SpendCoin(const COutPoint &outpoint, Coin* moveout) {
133	0	CCoinsMap::iterator it = FetchCoin(outpoint);
134	0	if (it == cacheCoins.end()) return false; Branch (134:9): [True: 0, False: 0]
135	0	Assume(TrySub(m_dirty_count, it->second.IsDirty()));
136	0	Assume(TrySub(cachedCoinsUsage, it->second.coin.DynamicMemoryUsage()));
137	0	TRACEPOINT(utxocache, spent,
138	0	outpoint.hash.data(),
139	0	(uint32_t)outpoint.n,
140	0	(uint32_t)it->second.coin.nHeight,
141	0	(int64_t)it->second.coin.out.nValue,
142	0	(bool)it->second.coin.IsCoinBase());
143	0	if (moveout) { Branch (143:9): [True: 0, False: 0]
144	0	*moveout = std::move(it->second.coin);
145	0	}
146	0	if (it->second.IsFresh()) { Branch (146:9): [True: 0, False: 0]
147	0	cacheCoins.erase(it);
148	0	} else {
149	0	CCoinsCacheEntry::SetDirty(*it, m_sentinel);
150	0	++m_dirty_count;
151	0	it->second.coin.Clear();
152	0	}
153	0	return true;
154	0	}
155
156		static const Coin coinEmpty;
157
158	0	const Coin& CCoinsViewCache::AccessCoin(const COutPoint &outpoint) const {
159	0	CCoinsMap::const_iterator it = FetchCoin(outpoint);
160	0	if (it == cacheCoins.end()) { Branch (160:9): [True: 0, False: 0]
161	0	return coinEmpty;
162	0	} else {
163	0	return it->second.coin;
164	0	}
165	0	}
166
167		bool CCoinsViewCache::HaveCoin(const COutPoint& outpoint) const
168	0	{
169	0	CCoinsMap::const_iterator it = FetchCoin(outpoint);
170	0	return (it != cacheCoins.end() && !it->second.coin.IsSpent()); Branch (170:13): [True: 0, False: 0] Branch (170:39): [True: 0, False: 0]
171	0	}
172
173	0	bool CCoinsViewCache::HaveCoinInCache(const COutPoint &outpoint) const {
174	0	CCoinsMap::const_iterator it = cacheCoins.find(outpoint);
175	0	return (it != cacheCoins.end() && !it->second.coin.IsSpent()); Branch (175:13): [True: 0, False: 0] Branch (175:39): [True: 0, False: 0]
176	0	}
177
178	0	uint256 CCoinsViewCache::GetBestBlock() const {
179	0	if (m_block_hash.IsNull()) Branch (179:9): [True: 0, False: 0]
180	0	m_block_hash = base->GetBestBlock();
181	0	return m_block_hash;
182	0	}
183
184		void CCoinsViewCache::SetBestBlock(const uint256& in_block_hash)
185	0	{
186	0	m_block_hash = in_block_hash;
187	0	}
188
189		void CCoinsViewCache::BatchWrite(CoinsViewCacheCursor& cursor, const uint256& in_block_hash)
190	0	{
191	0	for (auto it{cursor.Begin()}; it != cursor.End(); it = cursor.NextAndMaybeErase(*it)) { Branch (191:35): [True: 0, False: 0]
192	0	if (!it->second.IsDirty()) { // TODO a cursor can only contain dirty entries Branch (192:13): [True: 0, False: 0]
193	0	continue;
194	0	}
195	0	auto [itUs, inserted]{cacheCoins.try_emplace(it->first)};
196	0	if (inserted) { Branch (196:13): [True: 0, False: 0]
197	0	if (it->second.IsFresh() && it->second.coin.IsSpent()) { Branch (197:17): [True: 0, False: 0] Branch (197:41): [True: 0, False: 0]
198	0	cacheCoins.erase(itUs); // TODO fresh coins should have been removed at spend
199	0	} else {
200		// The parent cache does not have an entry, while the child cache does.
201		// Move the data up and mark it as dirty.
202	0	CCoinsCacheEntry& entry{itUs->second};
203	0	assert(entry.coin.DynamicMemoryUsage() == 0); Branch (203:17): [True: 0, False: 0]
204	0	if (cursor.WillErase(*it)) { Branch (204:21): [True: 0, False: 0]
205		// Since this entry will be erased,
206		// we can move the coin into us instead of copying it
207	0	entry.coin = std::move(it->second.coin);
208	0	} else {
209	0	entry.coin = it->second.coin;
210	0	}
211	0	CCoinsCacheEntry::SetDirty(*itUs, m_sentinel);
212	0	++m_dirty_count;
213	0	cachedCoinsUsage += entry.coin.DynamicMemoryUsage();
214		// We can mark it FRESH in the parent if it was FRESH in the child
215		// Otherwise it might have just been flushed from the parent's cache
216		// and already exist in the grandparent
217	0	if (it->second.IsFresh()) CCoinsCacheEntry::SetFresh(*itUs, m_sentinel); Branch (217:21): [True: 0, False: 0]
218	0	}
219	0	} else {
220		// Found the entry in the parent cache
221	0	if (it->second.IsFresh() && !itUs->second.coin.IsSpent()) { Branch (221:17): [True: 0, False: 0] Branch (221:41): [True: 0, False: 0]
222		// The coin was marked FRESH in the child cache, but the coin
223		// exists in the parent cache. If this ever happens, it means
224		// the FRESH flag was misapplied and there is a logic error in
225		// the calling code.
226	0	throw std::logic_error("FRESH flag misapplied to coin that exists in parent cache");
227	0	}
228
229	0	if (itUs->second.IsFresh() && it->second.coin.IsSpent()) { Branch (229:17): [True: 0, False: 0] Branch (229:43): [True: 0, False: 0]
230		// The grandparent cache does not have an entry, and the coin
231		// has been spent. We can just delete it from the parent cache.
232	0	Assume(TrySub(m_dirty_count, itUs->second.IsDirty()));
233	0	Assume(TrySub(cachedCoinsUsage, itUs->second.coin.DynamicMemoryUsage()));
234	0	cacheCoins.erase(itUs);
235	0	} else {
236		// A normal modification.
237	0	Assume(TrySub(cachedCoinsUsage, itUs->second.coin.DynamicMemoryUsage()));
238	0	if (cursor.WillErase(*it)) { Branch (238:21): [True: 0, False: 0]
239		// Since this entry will be erased,
240		// we can move the coin into us instead of copying it
241	0	itUs->second.coin = std::move(it->second.coin);
242	0	} else {
243	0	itUs->second.coin = it->second.coin;
244	0	}
245	0	cachedCoinsUsage += itUs->second.coin.DynamicMemoryUsage();
246	0	if (!itUs->second.IsDirty()) { Branch (246:21): [True: 0, False: 0]
247	0	CCoinsCacheEntry::SetDirty(*itUs, m_sentinel);
248	0	++m_dirty_count;
249	0	}
250		// NOTE: It isn't safe to mark the coin as FRESH in the parent
251		// cache. If it already existed and was spent in the parent
252		// cache then marking it FRESH would prevent that spentness
253		// from being flushed to the grandparent.
254	0	}
255	0	}
256	0	}
257	0	SetBestBlock(in_block_hash);
258	0	}
259
260		void CCoinsViewCache::Flush(bool reallocate_cache)
261	0	{
262	0	auto cursor{CoinsViewCacheCursor(m_dirty_count, m_sentinel, cacheCoins, /will_erase=/true)};
263	0	base->BatchWrite(cursor, m_block_hash);
264	0	Assume(m_dirty_count == 0);
265	0	cacheCoins.clear();
266	0	if (reallocate_cache) { Branch (266:9): [True: 0, False: 0]
267	0	ReallocateCache();
268	0	}
269	0	cachedCoinsUsage = 0;
270	0	}
271
272		void CCoinsViewCache::Sync()
273	0	{
274	0	auto cursor{CoinsViewCacheCursor(m_dirty_count, m_sentinel, cacheCoins, /will_erase=/false)};
275	0	base->BatchWrite(cursor, m_block_hash);
276	0	Assume(m_dirty_count == 0);
277	0	if (m_sentinel.second.Next() != &m_sentinel) { Branch (277:9): [True: 0, False: 0]
278		/* BatchWrite must clear flags of all entries */
279	0	throw std::logic_error("Not all unspent flagged entries were cleared");
280	0	}
281	0	}
282
283		void CCoinsViewCache::Reset() noexcept
284	0	{
285	0	cacheCoins.clear();
286	0	cachedCoinsUsage = 0;
287	0	m_dirty_count = 0;
288	0	SetBestBlock(uint256::ZERO);
289	0	}
290
291		void CCoinsViewCache::Uncache(const COutPoint& hash)
292	0	{
293	0	CCoinsMap::iterator it = cacheCoins.find(hash);
294	0	if (it != cacheCoins.end() && !it->second.IsDirty()) { Branch (294:9): [True: 0, False: 0] Branch (294:9): [True: 0, False: 0] Branch (294:35): [True: 0, False: 0]
295	0	Assume(TrySub(cachedCoinsUsage, it->second.coin.DynamicMemoryUsage()));
296	0	TRACEPOINT(utxocache, uncache,
297	0	hash.hash.data(),
298	0	(uint32_t)hash.n,
299	0	(uint32_t)it->second.coin.nHeight,
300	0	(int64_t)it->second.coin.out.nValue,
301	0	(bool)it->second.coin.IsCoinBase());
302	0	cacheCoins.erase(it);
303	0	}
304	0	}
305
306	0	unsigned int CCoinsViewCache::GetCacheSize() const {
307	0	return cacheCoins.size();
308	0	}
309
310		bool CCoinsViewCache::HaveInputs(const CTransaction& tx) const
311	0	{
312	0	if (!tx.IsCoinBase()) { Branch (312:9): [True: 0, False: 0]
313	0	for (unsigned int i = 0; i < tx.vin.size(); i++) { Branch (313:34): [True: 0, False: 0]
314	0	if (!HaveCoin(tx.vin[i].prevout)) { Branch (314:17): [True: 0, False: 0]
315	0	return false;
316	0	}
317	0	}
318	0	}
319	0	return true;
320	0	}
321
322		void CCoinsViewCache::ReallocateCache()
323	0	{
324		// Cache should be empty when we're calling this.
325	0	assert(cacheCoins.size() == 0); Branch (325:5): [True: 0, False: 0]
326	0	cacheCoins.~CCoinsMap();
327	0	m_cache_coins_memory_resource.~CCoinsMapMemoryResource();
328	0	::new (&m_cache_coins_memory_resource) CCoinsMapMemoryResource{};
329	0	::new (&cacheCoins) CCoinsMap{0, SaltedOutpointHasher{/deterministic=/m_deterministic}, CCoinsMap::key_equal{}, &m_cache_coins_memory_resource};
330	0	}
331
332		void CCoinsViewCache::SanityCheck() const
333	0	{
334	0	size_t recomputed_usage = 0;
335	0	size_t count_dirty = 0;
336	0	for (const auto& [_, entry] : cacheCoins) { Branch (336:33): [True: 0, False: 0]
337	0	if (entry.coin.IsSpent()) { Branch (337:13): [True: 0, False: 0]
338	0	assert(entry.IsDirty() && !entry.IsFresh()); // A spent coin must be dirty and cannot be fresh Branch (338:13): [True: 0, False: 0] Branch (338:13): [True: 0, False: 0] Branch (338:13): [True: 0, False: 0]
339	0	} else {
340	0	assert(entry.IsDirty() \|\| !entry.IsFresh()); // An unspent coin must not be fresh if not dirty Branch (340:13): [True: 0, False: 0] Branch (340:13): [True: 0, False: 0] Branch (340:13): [True: 0, False: 0]
341	0	}
342
343		// Recompute cachedCoinsUsage.
344	0	recomputed_usage += entry.coin.DynamicMemoryUsage();
345
346		// Count the number of entries we expect in the linked list.
347	0	if (entry.IsDirty()) ++count_dirty; Branch (347:13): [True: 0, False: 0]
348	0	}
349		// Iterate over the linked list of flagged entries.
350	0	size_t count_linked = 0;
351	0	for (auto it = m_sentinel.second.Next(); it != &m_sentinel; it = it->second.Next()) { Branch (351:46): [True: 0, False: 0]
352		// Verify linked list integrity.
353	0	assert(it->second.Next()->second.Prev() == it); Branch (353:9): [True: 0, False: 0]
354	0	assert(it->second.Prev()->second.Next() == it); Branch (354:9): [True: 0, False: 0]
355		// Verify they are actually flagged.
356	0	assert(it->second.IsDirty()); Branch (356:9): [True: 0, False: 0]
357		// Count the number of entries actually in the list.
358	0	++count_linked;
359	0	}
360	0	assert(count_dirty == count_linked && count_dirty == m_dirty_count); Branch (360:5): [True: 0, False: 0] Branch (360:5): [True: 0, False: 0] Branch (360:5): [True: 0, False: 0]
361	0	assert(recomputed_usage == cachedCoinsUsage); Branch (361:5): [True: 0, False: 0]
362	0	}
363
364		static const uint64_t MIN_TRANSACTION_OUTPUT_WEIGHT{WITNESS_SCALE_FACTOR * ::GetSerializeSize(CTxOut())};
365		static const uint64_t MAX_OUTPUTS_PER_BLOCK{MAX_BLOCK_WEIGHT / MIN_TRANSACTION_OUTPUT_WEIGHT};
366
367		const Coin& AccessByTxid(const CCoinsViewCache& view, const Txid& txid)
368	0	{
369	0	COutPoint iter(txid, 0);
370	0	while (iter.n < MAX_OUTPUTS_PER_BLOCK) { Branch (370:12): [True: 0, False: 0]
371	0	const Coin& alternate = view.AccessCoin(iter);
372	0	if (!alternate.IsSpent()) return alternate; Branch (372:13): [True: 0, False: 0]
373	0	++iter.n;
374	0	}
375	0	return coinEmpty;
376	0	}
377
378		template <typename ReturnType, typename Func>
379		static ReturnType ExecuteBackedWrapper(Func func, const std::vector<std::function<void()>>& err_callbacks)
380	0	{
381	0	try {
382	0	return func();
383	0	} catch(const std::runtime_error& e) {
384	0	for (const auto& f : err_callbacks) { Branch (384:28): [True: 0, False: 0] Branch (384:28): [True: 0, False: 0] Branch (384:28): [True: 0, False: 0]
385	0	f();
386	0	}
387	0	LogError("Error reading from database: %s\n", e.what());
388		// Starting the shutdown sequence and returning false to the caller would be
389		// interpreted as 'entry not found' (as opposed to unable to read data), and
390		// could lead to invalid interpretation. Just exit immediately, as we can't
391		// continue anyway, and all writes should be atomic.
392	0	std::abort();
393	0	}
394	0	} Unexecuted instantiation: coins.cpp:_ZL20ExecuteBackedWrapperISt8optionalI4CoinEZNK22CCoinsViewErrorCatcher7GetCoinERK9COutPointE3$_0ET_T0_RKSt6vectorISt8functionIFvvEESaISD_EE Unexecuted instantiation: coins.cpp:_ZL20ExecuteBackedWrapperIbZNK22CCoinsViewErrorCatcher8HaveCoinERK9COutPointE3$_0ET_T0_RKSt6vectorISt8functionIFvvEESaISA_EE Unexecuted instantiation: coins.cpp:_ZL20ExecuteBackedWrapperISt8optionalI4CoinEZNK22CCoinsViewErrorCatcher8PeekCoinERK9COutPointE3$_0ET_T0_RKSt6vectorISt8functionIFvvEESaISD_EE
395
396		std::optional<Coin> CCoinsViewErrorCatcher::GetCoin(const COutPoint& outpoint) const
397	0	{
398	0	return ExecuteBackedWrapper<std::optional<Coin>>([&]() { return CCoinsViewBacked::GetCoin(outpoint); }, m_err_callbacks);
399	0	}
400
401		bool CCoinsViewErrorCatcher::HaveCoin(const COutPoint& outpoint) const
402	0	{
403	0	return ExecuteBackedWrapper<bool>([&]() { return CCoinsViewBacked::HaveCoin(outpoint); }, m_err_callbacks);
404	0	}
405
406		std::optional<Coin> CCoinsViewErrorCatcher::PeekCoin(const COutPoint& outpoint) const
407	0	{
408	0	return ExecuteBackedWrapper<std::optional<Coin>>([&]() { return CCoinsViewBacked::PeekCoin(outpoint); }, m_err_callbacks);
409	0	}