base.h

Go to the documentation of this file.

// Copyright (c) 2017-2018 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_INDEX_BASE_H
#define BITCOIN_INDEX_BASE_H

#include <dbwrapper.h>
#include <primitives/block.h>
#include <primitives/transaction.h>
#include <threadinterrupt.h>
#include <validationinterface.h>

class CBlockIndex;

class BaseIndex : public CValidationInterface {
protected:
    class DB : public CDBWrapper {
    public:
        DB(const fs::path &path, size_t n_cache_size, bool f_memory = false,
           bool f_wipe = false, bool f_obfuscate = false);

        bool ReadBestBlock(CBlockLocator &locator) const;

        void WriteBestBlock(CDBBatch &batch, const CBlockLocator &locator);
    };

private:
    std::atomic<bool> m_synced{false};

    std::atomic<const CBlockIndex *> m_best_block_index{nullptr};

    std::thread m_thread_sync;
    CThreadInterrupt m_interrupt;

    void ThreadSync();

    bool Commit();

protected:
    void BlockConnected(const std::shared_ptr<const CBlock> &block,
                        const CBlockIndex *pindex) override;

    void ChainStateFlushed(const CBlockLocator &locator) override;

    virtual bool Init();

    virtual bool WriteBlock(const CBlock &block, const CBlockIndex *pindex) {
        return true;
    }

    virtual bool CommitInternal(CDBBatch &batch);

    virtual bool Rewind(const CBlockIndex *current_tip,
                        const CBlockIndex *new_tip);

    virtual DB &GetDB() const = 0;

    virtual const char *GetName() const = 0;

public:
    virtual ~BaseIndex();

    bool BlockUntilSyncedToCurrentChain() const;

    void Interrupt();

    void Start();

    void Stop();
};

#endif // BITCOIN_INDEX_BASE_H