/root/bitcoin/src/wallet/db.h

Source
// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-present 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_WALLET_DB_H
#define BITCOIN_WALLET_DB_H

#include <clientversion.h>
#include <streams.h>
#include <support/allocators/secure.h>
#include <util/fs.h>

#include <atomic>
#include <memory>
#include <optional>
#include <string>

class ArgsManager;
struct bilingual_str;

namespace wallet {
// BytePrefix compares equality with other byte spans that begin with the same prefix.
struct BytePrefix {
    std::span<const std::byte> prefix;
};
bool operator<(BytePrefix a, std::span<const std::byte> b);
bool operator<(std::span<const std::byte> a, BytePrefix b);

class DatabaseCursor
{
public:
    explicit DatabaseCursor() = default;
    virtual ~DatabaseCursor() = default;

    DatabaseCursor(const DatabaseCursor&) = delete;
    DatabaseCursor& operator=(const DatabaseCursor&) = delete;

    enum class Status
    {
        FAIL,
        MORE,
        DONE,
    };

    virtual Status Next(DataStream& key, DataStream& value) { return Status::FAIL; }
};

/** RAII class that provides access to a WalletDatabase */
class DatabaseBatch
{
private:
    virtual bool ReadKey(DataStream&& key, DataStream& value) = 0;
    virtual bool WriteKey(DataStream&& key, DataStream&& value, bool overwrite = true) = 0;
    virtual bool EraseKey(DataStream&& key) = 0;
    virtual bool HasKey(DataStream&& key) = 0;

public:
    explicit DatabaseBatch() = default;
    virtual ~DatabaseBatch() = default;

    DatabaseBatch(const DatabaseBatch&) = delete;
    DatabaseBatch& operator=(const DatabaseBatch&) = delete;

    virtual void Close() = 0;

    template <typename K, typename T>
    bool Read(const K& key, T& value)
    {
        DataStream ssKey{};
        ssKey.reserve(1000);
        ssKey << key;

        DataStream ssValue{};
        if (!ReadKey(std::move(ssKey), ssValue)) return false;
        try {
            ssValue >> value;
            return true;
        } catch (const std::exception&) {
            return false;
        }
    }

    template <typename K, typename T>
    bool Write(const K& key, const T& value, bool fOverwrite = true)
    {
        DataStream ssKey{};
        ssKey.reserve(1000);
        ssKey << key;

        DataStream ssValue{};
        ssValue.reserve(10000);
        ssValue << value;

        return WriteKey(std::move(ssKey), std::move(ssValue), fOverwrite);
    }

    template <typename K>
    bool Erase(const K& key)
    {
        DataStream ssKey{};
        ssKey.reserve(1000);
        ssKey << key;

        return EraseKey(std::move(ssKey));
    }

    template <typename K>
    bool Exists(const K& key)
    {
        DataStream ssKey{};
        ssKey.reserve(1000);
        ssKey << key;

        return HasKey(std::move(ssKey));
    }
    virtual bool ErasePrefix(std::span<const std::byte> prefix) = 0;

    virtual std::unique_ptr<DatabaseCursor> GetNewCursor() = 0;
    virtual std::unique_ptr<DatabaseCursor> GetNewPrefixCursor(std::span<const std::byte> prefix) = 0;
    virtual bool TxnBegin() = 0;
    virtual bool TxnCommit() = 0;
    virtual bool TxnAbort() = 0;
    virtual bool HasActiveTxn() = 0;
};

/** An instance of this class represents one database.
 **/
class WalletDatabase
{
public:
    /** Create dummy DB handle */
    WalletDatabase() = default;
    virtual ~WalletDatabase() = default;

    /** Open the database if it is not already opened. */
    virtual void Open() = 0;

    //! Counts the number of active database users to be sure that the database is not closed while someone is using it
    std::atomic<int> m_refcount{0};

    /** Rewrite the entire database on disk, with the exception of key pszSkip if non-zero
     */
    virtual bool Rewrite(const char* pszSkip=nullptr) = 0;

    /** Back up the entire database to a file.
     */
    virtual bool Backup(const std::string& strDest) const = 0;

    /** Flush to the database file and close the database.
     *  Also close the environment if no other databases are open in it.
     */
    virtual void Close() = 0;

    /** Return path to main database file for logs and error messages. */
    virtual std::string Filename() = 0;

    virtual std::string Format() = 0;

    /** Make a DatabaseBatch connected to this database */
    virtual std::unique_ptr<DatabaseBatch> MakeBatch() = 0;
};

enum class DatabaseFormat {
    SQLITE,
    BERKELEY_RO,
};

struct DatabaseOptions {
    bool require_existing = false;
    bool require_create = false;
    std::optional<DatabaseFormat> require_format;
    uint64_t create_flags = 0;
    SecureString create_passphrase;

    // Specialized options. Not every option is supported by every backend.
    bool verify = true;             //!< Check data integrity on load.
    bool use_unsafe_sync = false;   //!< Disable file sync for faster performance.
    bool use_shared_memory = false; //!< Let other processes access the database.
    int64_t max_log_mb = 100;       //!< Max log size to allow before consolidating.
};

enum class DatabaseStatus {
    SUCCESS,
    FAILED_BAD_PATH,
    FAILED_BAD_FORMAT,
    FAILED_ALREADY_LOADED,
    FAILED_ALREADY_EXISTS,
    FAILED_NOT_FOUND,
    FAILED_CREATE,
    FAILED_LOAD,
    FAILED_VERIFY,
    FAILED_ENCRYPT,
    FAILED_INVALID_BACKUP_FILE,
};

/** Recursively list database paths in directory. */
std::vector<std::pair<fs::path, std::string>> ListDatabases(const fs::path& path);

void ReadDatabaseArgs(const ArgsManager& args, DatabaseOptions& options);
std::unique_ptr<WalletDatabase> MakeDatabase(const fs::path& path, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error);

fs::path BDBDataFile(const fs::path& path);
fs::path SQLiteDataFile(const fs::path& path);
bool IsBDBFile(const fs::path& path);
bool IsSQLiteFile(const fs::path& path);
} // namespace wallet

#endif // BITCOIN_WALLET_DB_H

Coverage Report

Created: 2025-05-14 12:32

Line	Count	Source
1		// Copyright (c) 2009-2010 Satoshi Nakamoto
2		// Copyright (c) 2009-present 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_WALLET_DB_H
7		#define BITCOIN_WALLET_DB_H
8
9		#include <clientversion.h>
10		#include <streams.h>
11		#include <support/allocators/secure.h>
12		#include <util/fs.h>
13
14		#include <atomic>
15		#include <memory>
16		#include <optional>
17		#include <string>
18
19		class ArgsManager;
20		struct bilingual_str;
21
22		namespace wallet {
23		// BytePrefix compares equality with other byte spans that begin with the same prefix.
24		struct BytePrefix {
25		std::span<const std::byte> prefix;
26		};
27		bool operator<(BytePrefix a, std::span<const std::byte> b);
28		bool operator<(std::span<const std::byte> a, BytePrefix b);
29
30		class DatabaseCursor
31		{
32		public:
33	0	explicit DatabaseCursor() = default;
34	0	virtual ~DatabaseCursor() = default;
35
36		DatabaseCursor(const DatabaseCursor&) = delete;
37		DatabaseCursor& operator=(const DatabaseCursor&) = delete;
38
39		enum class Status
40		{
41		FAIL,
42		MORE,
43		DONE,
44		};
45
46	0	virtual Status Next(DataStream& key, DataStream& value) { return Status::FAIL; }
47		};
48
49		/** RAII class that provides access to a WalletDatabase */
50		class DatabaseBatch
51		{
52		private:
53		virtual bool ReadKey(DataStream&& key, DataStream& value) = 0;
54		virtual bool WriteKey(DataStream&& key, DataStream&& value, bool overwrite = true) = 0;
55		virtual bool EraseKey(DataStream&& key) = 0;
56		virtual bool HasKey(DataStream&& key) = 0;
57
58		public:
59	0	explicit DatabaseBatch() = default;
60	0	virtual ~DatabaseBatch() = default;
61
62		DatabaseBatch(const DatabaseBatch&) = delete;
63		DatabaseBatch& operator=(const DatabaseBatch&) = delete;
64
65		virtual void Close() = 0;
66
67		template <typename K, typename T>
68		bool Read(const K& key, T& value)
69	0	{
70	0	DataStream ssKey{};
71	0	ssKey.reserve(1000);
72	0	ssKey << key;
73
74	0	DataStream ssValue{};
75	0	if (!ReadKey(std::move(ssKey), ssValue)) return false;
76	0	try {
77	0	ssValue >> value;
78	0	return true;
79	0	} catch (const std::exception&) {
80	0	return false;
81	0	}
82	0	} Unexecuted instantiation: _ZN6wallet13DatabaseBatch4ReadINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEmEEbRKT_RT0_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch4ReadISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CPubKeyESt6vectorIhSaIhEEEEbRKT_RT0_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch4ReadINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE13CBlockLocatorEEbRKT_RT0_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch4ReadINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEiEEbRKT_RT0_
83
84		template <typename K, typename T>
85		bool Write(const K& key, const T& value, bool fOverwrite = true)
86	0	{
87	0	DataStream ssKey{};
88	0	ssKey.reserve(1000);
89	0	ssKey << key;
90
91	0	DataStream ssValue{};
92	0	ssValue.reserve(10000);
93	0	ssValue << value;
94
95	0	return WriteKey(std::move(ssKey), std::move(ssValue), fOverwrite);
96	0	} Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4spanIhLm18446744073709551615EES3_EEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4spanIKSt4byteLm18446744073709551615EES5_EEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES8_ES8_EEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE22transaction_identifierILb0EEENS_9CWalletTxEEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CPubKeyENS_12CKeyMetadataEEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CPubKeyES2_ISt6vectorIh16secure_allocatorIhEE7uint256EEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CPubKeyES2_ISt6vectorIhSaIhEE7uint256EEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEjENS_10CMasterKeyEEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CScriptENS_12CKeyMetadataEEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CScriptEhEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE13CBlockLocatorEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEElEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEhE7uint256EEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I7uint2567CPubKeyEES2_ISt6vectorIh16secure_allocatorIhEES9_EEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I7uint2567CPubKeyEESt6vectorIhSaIhEEEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7uint256ENS_16WalletDescriptorEEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairIS2_INSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7uint256ES2_IjjEESt6vectorIhSaIhEEEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairIS2_INSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7uint256EjESt6vectorIhSaIhEEEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I22transaction_identifierILb0EEjEEhEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEiEEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_IS8_S8_EES8_EEbRKT_RKT0_b Unexecuted instantiation: _ZN6wallet13DatabaseBatch5WriteINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEmEEbRKT_RKT0_b
97
98		template <typename K>
99		bool Erase(const K& key)
100	0	{
101	0	DataStream ssKey{};
102	0	ssKey.reserve(1000);
103	0	ssKey << key;
104
105	0	return EraseKey(std::move(ssKey));
106	0	} Unexecuted instantiation: _ZN6wallet13DatabaseBatch5EraseISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES8_EEEbRKT_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch5EraseISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7uint256EEEbRKT_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch5EraseISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CPubKeyEEEbRKT_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch5EraseISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEjEEEbRKT_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch5EraseISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CScriptEEEbRKT_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch5EraseISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEhEEEbRKT_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch5EraseISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I7uint2567CPubKeyEEEEbRKT_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch5EraseISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I22transaction_identifierILb0EEjEEEEbRKT_ Unexecuted instantiation: _ZN6wallet13DatabaseBatch5EraseISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_IS8_S8_EEEEbRKT_
107
108		template <typename K>
109		bool Exists(const K& key)
110		{
111		DataStream ssKey{};
112		ssKey.reserve(1000);
113		ssKey << key;
114
115		return HasKey(std::move(ssKey));
116		}
117		virtual bool ErasePrefix(std::span<const std::byte> prefix) = 0;
118
119		virtual std::unique_ptr<DatabaseCursor> GetNewCursor() = 0;
120		virtual std::unique_ptr<DatabaseCursor> GetNewPrefixCursor(std::span<const std::byte> prefix) = 0;
121		virtual bool TxnBegin() = 0;
122		virtual bool TxnCommit() = 0;
123		virtual bool TxnAbort() = 0;
124		virtual bool HasActiveTxn() = 0;
125		};
126
127		/** An instance of this class represents one database.
128		**/
129		class WalletDatabase
130		{
131		public:
132		/** Create dummy DB handle */
133	0	WalletDatabase() = default;
134	0	virtual ~WalletDatabase() = default;
135
136		/** Open the database if it is not already opened. */
137		virtual void Open() = 0;
138
139		//! Counts the number of active database users to be sure that the database is not closed while someone is using it
140		std::atomic<int> m_refcount{0};
141
142		/** Rewrite the entire database on disk, with the exception of key pszSkip if non-zero
143		*/
144		virtual bool Rewrite(const char* pszSkip=nullptr) = 0;
145
146		/** Back up the entire database to a file.
147		*/
148		virtual bool Backup(const std::string& strDest) const = 0;
149
150		/** Flush to the database file and close the database.
151		* Also close the environment if no other databases are open in it.
152		*/
153		virtual void Close() = 0;
154
155		/** Return path to main database file for logs and error messages. */
156		virtual std::string Filename() = 0;
157
158		virtual std::string Format() = 0;
159
160		/** Make a DatabaseBatch connected to this database */
161		virtual std::unique_ptr<DatabaseBatch> MakeBatch() = 0;
162		};
163
164		enum class DatabaseFormat {
165		SQLITE,
166		BERKELEY_RO,
167		};
168
169		struct DatabaseOptions {
170		bool require_existing = false;
171		bool require_create = false;
172		std::optional<DatabaseFormat> require_format;
173		uint64_t create_flags = 0;
174		SecureString create_passphrase;
175
176		// Specialized options. Not every option is supported by every backend.
177		bool verify = true; //!< Check data integrity on load.
178		bool use_unsafe_sync = false; //!< Disable file sync for faster performance.
179		bool use_shared_memory = false; //!< Let other processes access the database.
180		int64_t max_log_mb = 100; //!< Max log size to allow before consolidating.
181		};
182
183		enum class DatabaseStatus {
184		SUCCESS,
185		FAILED_BAD_PATH,
186		FAILED_BAD_FORMAT,
187		FAILED_ALREADY_LOADED,
188		FAILED_ALREADY_EXISTS,
189		FAILED_NOT_FOUND,
190		FAILED_CREATE,
191		FAILED_LOAD,
192		FAILED_VERIFY,
193		FAILED_ENCRYPT,
194		FAILED_INVALID_BACKUP_FILE,
195		};
196
197		/** Recursively list database paths in directory. */
198		std::vector<std::pair<fs::path, std::string>> ListDatabases(const fs::path& path);
199
200		void ReadDatabaseArgs(const ArgsManager& args, DatabaseOptions& options);
201		std::unique_ptr<WalletDatabase> MakeDatabase(const fs::path& path, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error);
202
203		fs::path BDBDataFile(const fs::path& path);
204		fs::path SQLiteDataFile(const fs::path& path);
205		bool IsBDBFile(const fs::path& path);
206		bool IsSQLiteFile(const fs::path& path);
207		} // namespace wallet
208
209		#endif // BITCOIN_WALLET_DB_H