Branch data     Line data    Source code

       1                 :             : // Copyright (c) 2009-2010 Satoshi Nakamoto
       2                 :             : // Copyright (c) 2009-2022 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                 :             : #ifndef BITCOIN_TXDB_H
       7                 :             : #define BITCOIN_TXDB_H
       8                 :             : 
       9                 :             : #include <coins.h>
      10                 :             : #include <dbwrapper.h>
      11                 :             : #include <kernel/cs_main.h>
      12                 :             : #include <sync.h>
      13                 :             : #include <util/fs.h>
      14                 :             : 
      15                 :             : #include <cstddef>
      16                 :             : #include <cstdint>
      17                 :             : #include <memory>
      18                 :             : #include <optional>
      19                 :             : #include <vector>
      20                 :             : 
      21                 :             : class COutPoint;
      22                 :             : class uint256;
      23                 :             : 
      24                 :             : //! -dbcache default (MiB)
      25                 :             : static const int64_t nDefaultDbCache = 450;
      26                 :             : //! -dbbatchsize default (bytes)
      27                 :             : static const int64_t nDefaultDbBatchSize = 16 << 20;
      28                 :             : //! min. -dbcache (MiB)
      29                 :             : static const int64_t nMinDbCache = 4;
      30                 :             : //! Max memory allocated to block tree DB specific cache, if no -txindex (MiB)
      31                 :             : static const int64_t nMaxBlockDBCache = 2;
      32                 :             : //! Max memory allocated to block tree DB specific cache, if -txindex (MiB)
      33                 :             : // Unlike for the UTXO database, for the txindex scenario the leveldb cache make
      34                 :             : // a meaningful difference: https://github.com/bitcoin/bitcoin/pull/8273#issuecomment-229601991
      35                 :             : static const int64_t nMaxTxIndexCache = 1024;
      36                 :             : //! Max memory allocated to all block filter index caches combined in MiB.
      37                 :             : static const int64_t max_filter_index_cache = 1024;
      38                 :             : //! Max memory allocated to coin DB specific cache (MiB)
      39                 :             : static const int64_t nMaxCoinsDBCache = 8;
      40                 :             : 
      41                 :             : //! User-controlled performance and debug options.
      42                 :             : struct CoinsViewOptions {
      43                 :             :     //! Maximum database write batch size in bytes.
      44                 :             :     size_t batch_write_bytes = nDefaultDbBatchSize;
      45                 :             :     //! If non-zero, randomly exit when the database is flushed with (1/ratio)
      46                 :             :     //! probability.
      47                 :             :     int simulate_crash_ratio = 0;
      48                 :             : };
      49                 :             : 
      50                 :             : /** CCoinsView backed by the coin database (chainstate/) */
      51                 :             : class CCoinsViewDB final : public CCoinsView
      52                 :             : {
      53                 :             : protected:
      54                 :             :     DBParams m_db_params;
      55                 :             :     CoinsViewOptions m_options;
      56                 :             :     std::unique_ptr<CDBWrapper> m_db;
      57                 :             : public:
      58                 :             :     explicit CCoinsViewDB(DBParams db_params, CoinsViewOptions options);
      59                 :             : 
      60                 :             :     std::optional<Coin> GetCoin(const COutPoint& outpoint) const override;
      61                 :             :     bool HaveCoin(const COutPoint &outpoint) const override;
      62                 :             :     uint256 GetBestBlock() const override;
      63                 :             :     std::vector<uint256> GetHeadBlocks() const override;
      64                 :             :     bool BatchWrite(CoinsViewCacheCursor& cursor, const uint256 &hashBlock) override;
      65                 :             :     std::unique_ptr<CCoinsViewCursor> Cursor() const override;
      66                 :             : 
      67                 :             :     //! Whether an unsupported database format is used.
      68                 :             :     bool NeedsUpgrade();
      69                 :             :     size_t EstimateSize() const override;
      70                 :             : 
      71                 :             :     //! Dynamically alter the underlying leveldb cache size.
      72                 :             :     void ResizeCache(size_t new_cache_size) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
      73                 :             : 
      74                 :             :     //! @returns filesystem path to on-disk storage or std::nullopt if in memory.
      75   [ #  #  #  #  :           0 :     std::optional<fs::path> StoragePath() { return m_db->StoragePath(); }
           #  # ][ #  #  
             #  #  #  # ]
      76                 :             : };
      77                 :             : 
      78                 :             : #endif // BITCOIN_TXDB_H