Bitcoin Core  24.99.0
P2P Digital Currency
blockfilterindex.h
Go to the documentation of this file.
1 // Copyright (c) 2018-2022 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 #ifndef BITCOIN_INDEX_BLOCKFILTERINDEX_H
6 #define BITCOIN_INDEX_BLOCKFILTERINDEX_H
7 
8 #include <attributes.h>
9 #include <blockfilter.h>
10 #include <chain.h>
11 #include <flatfile.h>
12 #include <index/base.h>
13 #include <util/hasher.h>
14 
15 static const char* const DEFAULT_BLOCKFILTERINDEX = "0";
16 
18 static constexpr int CFCHECKPT_INTERVAL = 1000;
19 
27 class BlockFilterIndex final : public BaseIndex
28 {
29 private:
31  std::unique_ptr<BaseIndex::DB> m_db;
32 
34  std::unique_ptr<FlatFileSeq> m_filter_fileseq;
35 
36  bool ReadFilterFromDisk(const FlatFilePos& pos, const uint256& hash, BlockFilter& filter) const;
37  size_t WriteFilterToDisk(FlatFilePos& pos, const BlockFilter& filter);
38 
41  std::unordered_map<uint256, uint256, FilterHeaderHasher> m_headers_cache GUARDED_BY(m_cs_headers_cache);
42 
43  bool AllowPrune() const override { return true; }
44 
45 protected:
46  bool CustomInit(const std::optional<interfaces::BlockKey>& block) override;
47 
48  bool CustomCommit(CDBBatch& batch) override;
49 
50  bool CustomAppend(const interfaces::BlockInfo& block) override;
51 
52  bool CustomRewind(const interfaces::BlockKey& current_tip, const interfaces::BlockKey& new_tip) override;
53 
54  BaseIndex::DB& GetDB() const LIFETIMEBOUND override { return *m_db; }
55 
56 public:
58  explicit BlockFilterIndex(std::unique_ptr<interfaces::Chain> chain, BlockFilterType filter_type,
59  size_t n_cache_size, bool f_memory = false, bool f_wipe = false);
60 
62 
64  bool LookupFilter(const CBlockIndex* block_index, BlockFilter& filter_out) const;
65 
68 
70  bool LookupFilterRange(int start_height, const CBlockIndex* stop_index,
71  std::vector<BlockFilter>& filters_out) const;
72 
74  bool LookupFilterHashRange(int start_height, const CBlockIndex* stop_index,
75  std::vector<uint256>& hashes_out) const;
76 };
77 
83 
85 void ForEachBlockFilterIndex(std::function<void (BlockFilterIndex&)> fn);
86 
91 bool InitBlockFilterIndex(std::function<std::unique_ptr<interfaces::Chain>()> make_chain, BlockFilterType filter_type,
92  size_t n_cache_size, bool f_memory = false, bool f_wipe = false);
93 
100 
103 
104 #endif // BITCOIN_INDEX_BLOCKFILTERINDEX_H
#define LIFETIMEBOUND
Definition: attributes.h:16
BlockFilterType
Definition: blockfilter.h:90
bool DestroyBlockFilterIndex(BlockFilterType filter_type)
Destroy the block filter index with the given type.
bool InitBlockFilterIndex(std::function< std::unique_ptr< interfaces::Chain >()> make_chain, BlockFilterType filter_type, size_t n_cache_size, bool f_memory=false, bool f_wipe=false)
Initialize a block filter index for the given type if one does not already exist.
void DestroyAllBlockFilterIndexes()
Destroy all open block filter indexes.
static const char *const DEFAULT_BLOCKFILTERINDEX
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
static constexpr int CFCHECKPT_INTERVAL
Interval between compact filter checkpoints.
void ForEachBlockFilterIndex(std::function< void(BlockFilterIndex &)> fn)
Iterate over all running block filter indexes, invoking fn on each.
The database stores a block locator of the chain the database is synced to so that the index can effi...
Definition: base.h:44
Base class for indices of blockchain data.
Definition: base.h:34
Complete block filter struct as defined in BIP 157.
Definition: blockfilter.h:112
BlockFilterIndex is used to store and retrieve block filters, hashes, and headers for a range of bloc...
std::unique_ptr< BaseIndex::DB > m_db
bool LookupFilterRange(int start_height, const CBlockIndex *stop_index, std::vector< BlockFilter > &filters_out) const
Get a range of filters between two heights on a chain.
bool CustomInit(const std::optional< interfaces::BlockKey > &block) override
Initialize internal state from the database and block index.
BlockFilterType GetFilterType() const
BaseIndex::DB & GetDB() const LIFETIMEBOUND override
bool CustomCommit(CDBBatch &batch) override
Virtual method called internally by Commit that can be overridden to atomically commit more index sta...
BlockFilterType m_filter_type
BlockFilterIndex(std::unique_ptr< interfaces::Chain > chain, BlockFilterType filter_type, size_t n_cache_size, bool f_memory=false, bool f_wipe=false)
Constructs the index, which becomes available to be queried.
std::unique_ptr< FlatFileSeq > m_filter_fileseq
bool LookupFilter(const CBlockIndex *block_index, BlockFilter &filter_out) const
Get a single filter by block.
bool ReadFilterFromDisk(const FlatFilePos &pos, const uint256 &hash, BlockFilter &filter) const
bool LookupFilterHashRange(int start_height, const CBlockIndex *stop_index, std::vector< uint256 > &hashes_out) const
Get a range of filter hashes between two heights on a chain.
bool CustomAppend(const interfaces::BlockInfo &block) override
Write update index entries for a newly connected block.
std::unordered_map< uint256, uint256, FilterHeaderHasher > m_headers_cache GUARDED_BY(m_cs_headers_cache)
cache of block hash to filter header, to avoid disk access when responding to getcfcheckpt.
bool CustomRewind(const interfaces::BlockKey &current_tip, const interfaces::BlockKey &new_tip) override
Rewind index to an earlier chain tip during a chain reorg.
bool AllowPrune() const override
size_t WriteFilterToDisk(FlatFilePos &pos, const BlockFilter &filter)
bool LookupFilterHeader(const CBlockIndex *block_index, uint256 &header_out) EXCLUSIVE_LOCKS_REQUIRED(!m_cs_headers_cache)
Get a single filter header by block.
FlatFilePos m_next_filter_pos
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:151
Batch of changes queued to be written to a CDBWrapper.
Definition: dbwrapper.h:64
256-bit opaque blob.
Definition: uint256.h:119
Block data sent with blockConnected, blockDisconnected notifications.
Definition: chain.h:82
Hash/height pair to help track and identify blocks.
Definition: chain.h:43
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49