coins.cpp

Go to the documentation of this file.

// Copyright (c) 2012-2016 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 <logging.h>
#include <random.h>
#include <uint256.h>
#include <util/trace.h>
 
std::optional<Coin> CCoinsView::GetCoin(const COutPoint &outpoint) const {
    return std::nullopt;
}
BlockHash CCoinsView::GetBestBlock() const {
    return BlockHash();
}
std::vector<BlockHash> CCoinsView::GetHeadBlocks() const {
    return std::vector<BlockHash>();
}
void CCoinsView::BatchWrite(CoinsViewCacheCursor &cursor,
                            const BlockHash &hashBlock) {
    for (auto it{cursor.Begin()}; it != cursor.End();
         it = cursor.NextAndMaybeErase(*it)) {
    }
}
CCoinsViewCursor *CCoinsView::Cursor() const {
    return nullptr;
}
bool CCoinsView::HaveCoin(const COutPoint &outpoint) const {
    return GetCoin(outpoint).has_value();
}
 
CCoinsViewBacked::CCoinsViewBacked(CCoinsView *viewIn) : base(viewIn) {}
std::optional<Coin> CCoinsViewBacked::GetCoin(const COutPoint &outpoint) const {
    return base->GetCoin(outpoint);
}
bool CCoinsViewBacked::HaveCoin(const COutPoint &outpoint) const {
    return base->HaveCoin(outpoint);
}
BlockHash CCoinsViewBacked::GetBestBlock() const {
    return base->GetBestBlock();
}
std::vector<BlockHash> CCoinsViewBacked::GetHeadBlocks() const {
    return base->GetHeadBlocks();
}
void CCoinsViewBacked::SetBackend(CCoinsView &viewIn) {
    base = &viewIn;
}
void CCoinsViewBacked::BatchWrite(CoinsViewCacheCursor &cursor,
                                  const BlockHash &hashBlock) {
    base->BatchWrite(cursor, hashBlock);
}
CCoinsViewCursor *CCoinsViewBacked::Cursor() const {
    return base->Cursor();
}
size_t CCoinsViewBacked::EstimateSize() const {
    return base->EstimateSize();
}
 
CCoinsViewCache::CCoinsViewCache(CCoinsView *baseIn, bool deterministic)
    : CCoinsViewBacked(baseIn), m_deterministic(deterministic),
      cacheCoins(0, SaltedOutpointHasher(/*deterministic=*/deterministic),
                 CCoinsMap::key_equal{}, &m_cache_coins_memory_resource),
      cachedCoinsUsage(0) {
    m_sentinel.second.SelfRef(m_sentinel);
}
 
size_t CCoinsViewCache::DynamicMemoryUsage() const {
    return memusage::DynamicUsage(cacheCoins) + cachedCoinsUsage;
}
 
CCoinsMap::iterator
CCoinsViewCache::FetchCoin(const COutPoint &outpoint) const {
    const auto [ret, inserted] = cacheCoins.try_emplace(outpoint);
    if (inserted) {
        if (auto coin{base->GetCoin(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.GetTxOut().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();
    TRACE5(utxocache, add, outpoint.GetTxId().data(), outpoint.GetN(),
           coin.GetHeight(), coin.GetTxOut().nValue.ToString().c_str(),
           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.GetId();
    for (size_t i = 0; i < tx.vout.size(); ++i) {
        const COutPoint outpoint(txid, i);
        bool overwrite =
            check_for_overwrite ? cache.HaveCoin(outpoint) : fCoinbase;
        // Coinbase transactions can always be overwritten,
        // in order to correctly deal with the pre-BIP30 occurrences of
        // duplicate coinbase transactions.
        cache.AddCoin(outpoint, 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()));
    TRACE5(utxocache, spent, outpoint.GetTxId().data(), outpoint.GetN(),
           it->second.coin.GetHeight(),
           it->second.coin.GetTxOut().nValue.ToString().c_str(),
           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;
    }
    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());
}
 
BlockHash CCoinsViewCache::GetBestBlock() const {
    if (hashBlock.IsNull()) {
        hashBlock = base->GetBestBlock();
    }
    return hashBlock;
}
 
void CCoinsViewCache::SetBestBlock(const BlockHash &hashBlockIn) {
    hashBlock = hashBlockIn;
}
 
void CCoinsViewCache::BatchWrite(CoinsViewCacheCursor &cursor,
                                 const BlockHash &hashBlockIn) {
    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()) {
                // TODO fresh coins should have been removed at spend
                cacheCoins.erase(itUs);
            } 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(hashBlockIn);
}
 
void CCoinsViewCache::Flush(bool reallocate_cache) {
    auto cursor{CoinsViewCacheCursor(m_dirty_count, m_sentinel, cacheCoins,
                                     /*will_erase=*/true)};
    base->BatchWrite(cursor, hashBlock);
    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, hashBlock);
    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(BlockHash{uint256::ZERO});
}
 
void CCoinsViewCache::Uncache(const COutPoint &outpoint) {
    CCoinsMap::iterator it = cacheCoins.find(outpoint);
    if (it != cacheCoins.end() && !it->second.IsDirty()) {
        Assume(TrySub(cachedCoinsUsage, it->second.coin.DynamicMemoryUsage()));
        TRACE5(utxocache, uncache, outpoint.GetTxId().data(), outpoint.GetN(),
               it->second.coin.GetHeight(),
               it->second.coin.GetTxOut().nValue.ToString().c_str(),
               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()) {
        return true;
    }
 
    for (size_t 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()) {
            // A spent coin must be dirty and cannot be fresh
            assert(entry.IsDirty() && !entry.IsFresh());
        } else {
            // An unspent coin must not be fresh if not dirty
            assert(entry.IsDirty() || !entry.IsFresh());
        }
 
        // 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);
}
 
// TODO: merge with similar definition in undo.h.
static const size_t MAX_OUTPUTS_PER_TX =
    MAX_TX_SIZE / ::GetSerializeSize(CTxOut{});
 
const Coin &AccessByTxid(const CCoinsViewCache &view, const TxId &txid) {
    for (uint32_t n = 0; n < MAX_OUTPUTS_PER_TX; n++) {
        const Coin &alternate = view.AccessCoin(COutPoint(txid, n));
        if (!alternate.IsSpent()) {
            return alternate;
        }
    }
 
    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);
}