txdb.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-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.
 
#ifndef BITCOIN_TXDB_H
#define BITCOIN_TXDB_H
 
#include <blockfileinfo.h>
#include <coins.h>
#include <dbwrapper.h>
#include <flatfile.h>
#include <kernel/cs_main.h>
#include <util/fs.h>
#include <util/result.h>
 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <vector>
 
struct BlockHash;
class CBlockFileInfo;
class CBlockIndex;
class COutPoint;
 
namespace Consensus {
struct Params;
};
 
static constexpr int64_t MIN_DB_CACHE_MB = 4;
static constexpr int64_t MAX_DB_CACHE_MB = sizeof(void *) > 4 ? 16384 : 1024;
static constexpr int64_t DEFAULT_DB_CACHE_MB = 1024;
static constexpr int64_t DEFAULT_DB_BATCH_SIZE = 16 << 20;
static constexpr int64_t MAX_BLOCK_DB_CACHE_MB = 2;
// Unlike for the UTXO database, for the txindex scenario the leveldb cache make
// a meaningful difference:
// https://github.com/bitcoin/bitcoin/pull/8273#issuecomment-229601991
static constexpr int64_t MAX_TX_INDEX_CACHE_MB = 1024;
static constexpr int64_t MAX_FILTER_INDEX_CACHE_MB = 1024;
static constexpr int64_t MAX_COINS_DB_CACHE_MB = 8;
 
struct CoinsViewOptions {
    size_t batch_write_bytes = DEFAULT_DB_BATCH_SIZE;
    int simulate_crash_ratio = 0;
};
 
class CCoinsViewDB final : public CCoinsView {
protected:
    DBParams m_db_params;
    CoinsViewOptions m_options;
    std::unique_ptr<CDBWrapper> m_db;
 
public:
    explicit CCoinsViewDB(DBParams db_params, CoinsViewOptions options);
 
    bool GetCoin(const COutPoint &outpoint, Coin &coin) const override;
    bool HaveCoin(const COutPoint &outpoint) const override;
    BlockHash GetBestBlock() const override;
    std::vector<BlockHash> GetHeadBlocks() const override;
    bool BatchWrite(CCoinsMap &mapCoins, const BlockHash &hashBlock,
                    bool erase = true) override;
    CCoinsViewCursor *Cursor() const override;
 
    bool Upgrade();
    size_t EstimateSize() const override;
 
    void ResizeCache(size_t new_cache_size) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
 
    std::optional<fs::path> StoragePath() { return m_db->StoragePath(); }
};
 
class CCoinsViewDBCursor : public CCoinsViewCursor {
public:
    ~CCoinsViewDBCursor() {}
 
    bool GetKey(COutPoint &key) const override;
    bool GetValue(Coin &coin) const override;
    unsigned int GetValueSize() const override;
 
    bool Valid() const override;
    void Next() override;
 
private:
    CCoinsViewDBCursor(CDBIterator *pcursorIn, const BlockHash &hashBlockIn)
        : CCoinsViewCursor(hashBlockIn), pcursor(pcursorIn) {}
    std::unique_ptr<CDBIterator> pcursor;
    std::pair<char, COutPoint> keyTmp;
 
    friend class CCoinsViewDB;
};
 
class CBlockTreeDB : public CDBWrapper {
public:
    using CDBWrapper::CDBWrapper;
    bool WriteBatchSync(
        const std::vector<std::pair<int, const CBlockFileInfo *>> &fileInfo,
        int nLastFile, const std::vector<const CBlockIndex *> &blockinfo);
    bool ReadBlockFileInfo(int nFile, CBlockFileInfo &info);
    bool ReadLastBlockFile(int &nFile);
    bool WriteReindexing(bool fReindexing);
    bool IsReindexing() const;
    bool WriteFlag(const std::string &name, bool fValue);
    bool ReadFlag(const std::string &name, bool &fValue);
    bool LoadBlockIndexGuts(
        const Consensus::Params &params,
        std::function<CBlockIndex *(const BlockHash &)> insertBlockIndex)
        EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
    ;
 
    bool Upgrade();
};
 
[[nodiscard]] util::Result<void>
CheckLegacyTxindex(CBlockTreeDB &block_tree_db);
 
#endif // BITCOIN_TXDB_H