Bitcoin Core  21.99.0
P2P Digital Currency
blockfilterindex.h
Go to the documentation of this file.
1 // Copyright (c) 2018-2020 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 <blockfilter.h>
9 #include <chain.h>
10 #include <flatfile.h>
11 #include <index/base.h>
12 #include <util/hasher.h>
13 
15 static constexpr int CFCHECKPT_INTERVAL = 1000;
16 
24 class BlockFilterIndex final : public BaseIndex
25 {
26 private:
28  std::string m_name;
29  std::unique_ptr<BaseIndex::DB> m_db;
30 
32  std::unique_ptr<FlatFileSeq> m_filter_fileseq;
33 
34  bool ReadFilterFromDisk(const FlatFilePos& pos, BlockFilter& filter) const;
35  size_t WriteFilterToDisk(FlatFilePos& pos, const BlockFilter& filter);
36 
39  std::unordered_map<uint256, uint256, FilterHeaderHasher> m_headers_cache GUARDED_BY(m_cs_headers_cache);
40 
41 protected:
42  bool Init() override;
43 
44  bool CommitInternal(CDBBatch& batch) override;
45 
46  bool WriteBlock(const CBlock& block, const CBlockIndex* pindex) override;
47 
48  bool Rewind(const CBlockIndex* current_tip, const CBlockIndex* new_tip) override;
49 
50  BaseIndex::DB& GetDB() const override { return *m_db; }
51 
52  const char* GetName() const override { return m_name.c_str(); }
53 
54 public:
56  explicit BlockFilterIndex(BlockFilterType filter_type,
57  size_t n_cache_size, bool f_memory = false, bool f_wipe = false);
58 
60 
62  bool LookupFilter(const CBlockIndex* block_index, BlockFilter& filter_out) const;
63 
65  bool LookupFilterHeader(const CBlockIndex* block_index, uint256& header_out);
66 
68  bool LookupFilterRange(int start_height, const CBlockIndex* stop_index,
69  std::vector<BlockFilter>& filters_out) const;
70 
72  bool LookupFilterHashRange(int start_height, const CBlockIndex* stop_index,
73  std::vector<uint256>& hashes_out) const;
74 };
75 
81 
83 void ForEachBlockFilterIndex(std::function<void (BlockFilterIndex&)> fn);
84 
89 bool InitBlockFilterIndex(BlockFilterType filter_type,
90  size_t n_cache_size, bool f_memory = false, bool f_wipe = false);
91 
98 
101 
102 #endif // BITCOIN_INDEX_BLOCKFILTERINDEX_H
BlockFilterIndex::m_name
std::string m_name
Definition: blockfilterindex.h:28
CDBBatch
Batch of changes queued to be written to a CDBWrapper.
Definition: dbwrapper.h:47
BlockFilterIndex::m_db
std::unique_ptr< BaseIndex::DB > m_db
Definition: blockfilterindex.h:29
BlockFilterIndex::WriteFilterToDisk
size_t WriteFilterToDisk(FlatFilePos &pos, const BlockFilter &filter)
Definition: blockfilterindex.cpp:164
flatfile.h
BlockFilterIndex
BlockFilterIndex is used to store and retrieve block filters, hashes, and headers for a range of bloc...
Definition: blockfilterindex.h:24
AnnotatedMixin< std::mutex >
BlockFilterIndex::CommitInternal
bool CommitInternal(CDBBatch &batch) override
Virtual method called internally by Commit that can be overridden to atomically commit more index sta...
Definition: blockfilterindex.cpp:127
base.h
BaseIndex
Base class for indices of blockchain data.
Definition: base.h:27
BlockFilterIndex::Init
bool Init() override
Initialize internal state from the database and block index.
Definition: blockfilterindex.cpp:109
BlockFilterIndex::m_filter_type
BlockFilterType m_filter_type
Definition: blockfilterindex.h:27
blockfilter.h
FlatFilePos
Definition: flatfile.h:14
BlockFilterIndex::LookupFilterRange
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.
Definition: blockfilterindex.cpp:415
BlockFilterIndex::Rewind
bool Rewind(const CBlockIndex *current_tip, const CBlockIndex *new_tip) override
Rewind index to an earlier chain tip during a chain reorg.
Definition: blockfilterindex.cpp:279
uint256
256-bit opaque blob.
Definition: uint256.h:124
hasher.h
GetBlockFilterIndex
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
Definition: blockfilterindex.cpp:452
CBlock
Definition: block.h:62
BlockFilterIndex::ReadFilterFromDisk
bool ReadFilterFromDisk(const FlatFilePos &pos, BlockFilter &filter) const
Definition: blockfilterindex.cpp:144
BlockFilterIndex::GUARDED_BY
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.
BlockFilterIndex::m_next_filter_pos
FlatFilePos m_next_filter_pos
Definition: blockfilterindex.h:31
BlockFilterIndex::LookupFilterHashRange
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.
Definition: blockfilterindex.cpp:435
InitBlockFilterIndex
bool InitBlockFilterIndex(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.
Definition: blockfilterindex.cpp:463
BlockFilterIndex::WriteBlock
bool WriteBlock(const CBlock &block, const CBlockIndex *pindex) override
Write update index entries for a newly connected block.
Definition: blockfilterindex.cpp:210
CFCHECKPT_INTERVAL
static constexpr int CFCHECKPT_INTERVAL
Interval between compact filter checkpoints.
Definition: blockfilterindex.h:15
BlockFilterIndex::LookupFilter
bool LookupFilter(const CBlockIndex *block_index, BlockFilter &filter_out) const
Get a single filter by block.
Definition: blockfilterindex.cpp:375
BaseIndex::DB
The database stores a block locator of the chain the database is synced to so that the index can effi...
Definition: base.h:37
DestroyAllBlockFilterIndexes
void DestroyAllBlockFilterIndexes()
Destroy all open block filter indexes.
Definition: blockfilterindex.cpp:478
BlockFilterType
BlockFilterType
Definition: blockfilter.h:88
BlockFilterIndex::GetFilterType
BlockFilterType GetFilterType() const
Definition: blockfilterindex.h:59
BlockFilterIndex::GetDB
BaseIndex::DB & GetDB() const override
Definition: blockfilterindex.h:50
BlockFilterIndex::m_cs_headers_cache
Mutex m_cs_headers_cache
Definition: blockfilterindex.h:37
ForEachBlockFilterIndex
void ForEachBlockFilterIndex(std::function< void(BlockFilterIndex &)> fn)
Iterate over all running block filter indexes, invoking fn on each.
Definition: blockfilterindex.cpp:458
DestroyBlockFilterIndex
bool DestroyBlockFilterIndex(BlockFilterType filter_type)
Destroy the block filter index with the given type.
Definition: blockfilterindex.cpp:473
BlockFilterIndex::BlockFilterIndex
BlockFilterIndex(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.
Definition: blockfilterindex.cpp:94
CBlockIndex
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:137
BlockFilterIndex::LookupFilterHeader
bool LookupFilterHeader(const CBlockIndex *block_index, uint256 &header_out)
Get a single filter header by block.
Definition: blockfilterindex.cpp:385
BlockFilterIndex::m_filter_fileseq
std::unique_ptr< FlatFileSeq > m_filter_fileseq
Definition: blockfilterindex.h:32
BlockFilterIndex::GetName
const char * GetName() const override
Get the name of the index for display in logs.
Definition: blockfilterindex.h:52
BlockFilter
Complete block filter struct as defined in BIP 157.
Definition: blockfilter.h:110