Bitcoin Core  0.20.99
P2P Digital Currency
txdb.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2020 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 <chain.h>
12 #include <primitives/block.h>
13 
14 #include <memory>
15 #include <string>
16 #include <utility>
17 #include <vector>
18 
19 class CBlockIndex;
20 class CCoinsViewDBCursor;
21 class uint256;
22 
24 static const int64_t nDefaultDbCache = 450;
26 static const int64_t nDefaultDbBatchSize = 16 << 20;
28 static const int64_t nMaxDbCache = sizeof(void*) > 4 ? 16384 : 1024;
30 static const int64_t nMinDbCache = 4;
32 static const int64_t nMaxBlockDBCache = 2;
34 // Unlike for the UTXO database, for the txindex scenario the leveldb cache make
35 // a meaningful difference: https://github.com/bitcoin/bitcoin/pull/8273#issuecomment-229601991
36 static const int64_t nMaxTxIndexCache = 1024;
38 static const int64_t max_filter_index_cache = 1024;
40 static const int64_t nMaxCoinsDBCache = 8;
41 
42 // Actually declared in validation.cpp; can't include because of circular dependency.
43 extern RecursiveMutex cs_main;
44 
46 class CCoinsViewDB final : public CCoinsView
47 {
48 protected:
49  std::unique_ptr<CDBWrapper> m_db;
50  fs::path m_ldb_path;
52 public:
56  explicit CCoinsViewDB(fs::path ldb_path, size_t nCacheSize, bool fMemory, bool fWipe);
57 
58  bool GetCoin(const COutPoint &outpoint, Coin &coin) const override;
59  bool HaveCoin(const COutPoint &outpoint) const override;
60  uint256 GetBestBlock() const override;
61  std::vector<uint256> GetHeadBlocks() const override;
62  bool BatchWrite(CCoinsMap &mapCoins, const uint256 &hashBlock) override;
63  CCoinsViewCursor *Cursor() const override;
64 
66  bool Upgrade();
67  size_t EstimateSize() const override;
68 
70  void ResizeCache(size_t new_cache_size) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
71 };
72 
75 {
76 public:
78 
79  bool GetKey(COutPoint &key) const override;
80  bool GetValue(Coin &coin) const override;
81  unsigned int GetValueSize() const override;
82 
83  bool Valid() const override;
84  void Next() override;
85 
86 private:
87  CCoinsViewDBCursor(CDBIterator* pcursorIn, const uint256 &hashBlockIn):
88  CCoinsViewCursor(hashBlockIn), pcursor(pcursorIn) {}
89  std::unique_ptr<CDBIterator> pcursor;
90  std::pair<char, COutPoint> keyTmp;
91 
92  friend class CCoinsViewDB;
93 };
94 
96 class CBlockTreeDB : public CDBWrapper
97 {
98 public:
99  explicit CBlockTreeDB(size_t nCacheSize, bool fMemory = false, bool fWipe = false);
100 
101  bool WriteBatchSync(const std::vector<std::pair<int, const CBlockFileInfo*> >& fileInfo, int nLastFile, const std::vector<const CBlockIndex*>& blockinfo);
102  bool ReadBlockFileInfo(int nFile, CBlockFileInfo &info);
103  bool ReadLastBlockFile(int &nFile);
104  bool WriteReindexing(bool fReindexing);
105  void ReadReindexing(bool &fReindexing);
106  bool WriteFlag(const std::string &name, bool fValue);
107  bool ReadFlag(const std::string &name, bool &fValue);
108  bool LoadBlockIndexGuts(const Consensus::Params& consensusParams, std::function<CBlockIndex*(const uint256&)> insertBlockIndex);
109 };
110 
111 #endif // BITCOIN_TXDB_H
bool GetCoin(const COutPoint &outpoint, Coin &coin) const override
Retrieve the Coin (unspent transaction output) for a given outpoint.
Definition: txdb.cpp:57
bool Upgrade()
Attempt to update from an older database format. Returns whether an error occurred.
Definition: txdb.cpp:348
Specialization of CCoinsViewCursor to iterate over a CCoinsViewDB.
Definition: txdb.h:74
static const int64_t nMaxTxIndexCache
Max memory allocated to block tree DB specific cache, if -txindex (MiB)
Definition: txdb.h:36
A UTXO entry.
Definition: coins.h:30
CCoinsViewDB(fs::path ldb_path, size_t nCacheSize, bool fMemory, bool fWipe)
Definition: txdb.cpp:43
std::unique_ptr< CDBIterator > pcursor
Definition: txdb.h:89
void ResizeCache(size_t new_cache_size) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Dynamically alter the underlying leveldb cache size.
Definition: txdb.cpp:48
static const int64_t nMinDbCache
min. -dbcache (MiB)
Definition: txdb.h:30
static const int64_t max_filter_index_cache
Max memory allocated to all block filter index caches combined in MiB.
Definition: txdb.h:38
Access to the block database (blocks/index/)
Definition: txdb.h:96
Abstract view on the open txout dataset.
Definition: coins.h:180
const char * name
Definition: rest.cpp:41
std::unordered_map< COutPoint, CCoinsCacheEntry, SaltedOutpointHasher > CCoinsMap
Definition: coins.h:157
static const int64_t nDefaultDbCache
-dbcache default (MiB)
Definition: txdb.h:24
CCoinsViewDBCursor(CDBIterator *pcursorIn, const uint256 &hashBlockIn)
Definition: txdb.h:87
static const int64_t nDefaultDbBatchSize
-dbbatchsize default (bytes)
Definition: txdb.h:26
size_t EstimateSize() const override
Estimate database size (0 if not implemented)
Definition: txdb.cpp:141
Parameters that influence chain consensus.
Definition: params.h:45
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:20
std::pair< char, COutPoint > keyTmp
Definition: txdb.h:90
bool m_is_memory
Definition: txdb.h:51
bool HaveCoin(const COutPoint &outpoint) const override
Just check whether a given outpoint is unspent.
Definition: txdb.cpp:61
static const int64_t nMaxBlockDBCache
Max memory allocated to block tree DB specific cache, if no -txindex (MiB)
Definition: txdb.h:32
uint256 GetBestBlock() const override
Retrieve the block hash whose state this CCoinsView currently represents.
Definition: txdb.cpp:65
256-bit opaque blob.
Definition: uint256.h:123
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
The block chain is a tree shaped structure starting with the genesis block at the root...
Definition: chain.h:137
CCoinsView backed by the coin database (chainstate/)
Definition: txdb.h:46
static const int64_t nMaxCoinsDBCache
Max memory allocated to coin DB specific cache (MiB)
Definition: txdb.h:40
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate...
Definition: validation.cpp:129
static const int64_t nMaxDbCache
max. -dbcache (MiB)
Definition: txdb.h:28
bool BatchWrite(CCoinsMap &mapCoins, const uint256 &hashBlock) override
Do a bulk modification (multiple Coin changes + BestBlock change).
Definition: txdb.cpp:80
CCoinsViewCursor * Cursor() const override
Get a cursor to iterate over the whole state.
Definition: txdb.cpp:168
fs::path m_ldb_path
Definition: txdb.h:50
~CCoinsViewDBCursor()
Definition: txdb.h:77
std::vector< uint256 > GetHeadBlocks() const override
Retrieve the range of blocks that may have been only partially written.
Definition: txdb.cpp:72
std::unique_ptr< CDBWrapper > m_db
Definition: txdb.h:49
Cursor for iterating over CoinsView state.
Definition: coins.h:160