Bitcoin Core  0.20.99
P2P Digital Currency
base.h
Go to the documentation of this file.
1 // Copyright (c) 2017-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_BASE_H
6 #define BITCOIN_INDEX_BASE_H
7 
8 #include <dbwrapper.h>
9 #include <primitives/block.h>
10 #include <primitives/transaction.h>
11 #include <threadinterrupt.h>
12 #include <validationinterface.h>
13 
14 class CBlockIndex;
15 
22 {
23 protected:
24  class DB : public CDBWrapper
25  {
26  public:
27  DB(const fs::path& path, size_t n_cache_size,
28  bool f_memory = false, bool f_wipe = false, bool f_obfuscate = false);
29 
31  bool ReadBestBlock(CBlockLocator& locator) const;
32 
34  void WriteBestBlock(CDBBatch& batch, const CBlockLocator& locator);
35  };
36 
37 private:
41  std::atomic<bool> m_synced{false};
42 
44  std::atomic<const CBlockIndex*> m_best_block_index{nullptr};
45 
46  std::thread m_thread_sync;
48 
54  void ThreadSync();
55 
64  bool Commit();
65 
66 protected:
67  void BlockConnected(const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex) override;
68 
69  void ChainStateFlushed(const CBlockLocator& locator) override;
70 
72  virtual bool Init();
73 
75  virtual bool WriteBlock(const CBlock& block, const CBlockIndex* pindex) { return true; }
76 
79  virtual bool CommitInternal(CDBBatch& batch);
80 
83  virtual bool Rewind(const CBlockIndex* current_tip, const CBlockIndex* new_tip);
84 
85  virtual DB& GetDB() const = 0;
86 
88  virtual const char* GetName() const = 0;
89 
90 public:
92  virtual ~BaseIndex();
93 
99  bool BlockUntilSyncedToCurrentChain() const;
100 
101  void Interrupt();
102 
105  void Start();
106 
108  void Stop();
109 };
110 
111 #endif // BITCOIN_INDEX_BASE_H
bool Commit()
Write the current index state (eg.
Definition: base.cpp:158
virtual bool Init()
Initialize internal state from the database and block index.
Definition: base.cpp:54
CThreadInterrupt m_interrupt
Definition: base.h:47
void ChainStateFlushed(const CBlockLocator &locator) override
Notifies listeners of the new active block chain on-disk.
Definition: base.cpp:232
Describes a place in the block chain to another node such that if the other node doesn&#39;t have the sam...
Definition: block.h:114
std::atomic< bool > m_synced
Whether the index is in sync with the main chain.
Definition: base.h:41
Batch of changes queued to be written to a CDBWrapper.
Definition: dbwrapper.h:46
Definition: block.h:62
virtual bool Rewind(const CBlockIndex *current_tip, const CBlockIndex *new_tip)
Rewind index to an earlier chain tip during a chain reorg.
Definition: base.cpp:174
Implement this to subscribe to events generated in validation.
void Stop()
Stops the instance from staying in sync with blockchain updates.
Definition: base.cpp:314
std::thread m_thread_sync
Definition: base.h:46
virtual bool WriteBlock(const CBlock &block, const CBlockIndex *pindex)
Write update index entries for a newly connected block.
Definition: base.h:75
virtual ~BaseIndex()
Destructor interrupts sync thread if running and blocks until it exits.
Definition: base.cpp:48
void Interrupt()
Definition: base.cpp:295
Base class for indices of blockchain data.
Definition: base.h:21
void WriteBestBlock(CDBBatch &batch, const CBlockLocator &locator)
Write block locator of the chain that the txindex is in sync with.
Definition: base.cpp:43
void Start()
Start initializes the sync state and registers the instance as a ValidationInterface so that it stays...
Definition: base.cpp:300
virtual bool CommitInternal(CDBBatch &batch)
Virtual method called internally by Commit that can be overridden to atomically commit more index sta...
Definition: base.cpp:167
The block chain is a tree shaped structure starting with the genesis block at the root...
Definition: chain.h:137
void BlockConnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex) override
Notifies listeners of a block being connected.
Definition: base.cpp:190
void ThreadSync()
Sync the index with the block index starting from the current best block.
Definition: base.cpp:87
virtual const char * GetName() const =0
Get the name of the index for display in logs.
DB(const fs::path &path, size_t n_cache_size, bool f_memory=false, bool f_wipe=false, bool f_obfuscate=false)
Definition: base.cpp:30
bool ReadBestBlock(CBlockLocator &locator) const
Read block locator of the chain that the txindex is in sync with.
Definition: base.cpp:34
virtual DB & GetDB() const =0
std::atomic< const CBlockIndex * > m_best_block_index
The last block in the chain that the index is in sync with.
Definition: base.h:44
bool BlockUntilSyncedToCurrentChain() const
Blocks the current thread until the index is caught up to the current state of the block chain...
Definition: base.cpp:271