LCOV - code coverage report
Current view: top level - src/wallet - db.h (source / functions) Coverage Total Hit
Test: fuzz_coverage.info Lines: 48.5 % 33 16
Test Date: 2024-11-04 04:15:01 Functions: 21.4 % 42 9
Branches: 12.1 % 58 7

             Branch data     Line data    Source code
       1                 :             : // Copyright (c) 2009-2010 Satoshi Nakamoto
       2                 :             : // Copyright (c) 2009-2021 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                 :             :     Span<const std::byte> prefix;
      26                 :             : };
      27                 :             : bool operator<(BytePrefix a, Span<const std::byte> b);
      28                 :             : bool operator<(Span<const std::byte> a, BytePrefix b);
      29                 :             : 
      30                 :             : class DatabaseCursor
      31                 :             : {
      32                 :             : public:
      33         [ +  - ]:           7 :     explicit DatabaseCursor() = default;
      34                 :           7 :     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         [ #  # ]:     2850613 :     explicit DatabaseBatch() = default;
      60                 :     2850613 :     virtual ~DatabaseBatch() = default;
      61                 :             : 
      62                 :             :     DatabaseBatch(const DatabaseBatch&) = delete;
      63                 :             :     DatabaseBatch& operator=(const DatabaseBatch&) = delete;
      64                 :             : 
      65                 :             :     virtual void Flush() = 0;
      66                 :             :     virtual void Close() = 0;
      67                 :             : 
      68                 :             :     template <typename K, typename T>
      69                 :           0 :     bool Read(const K& key, T& value)
      70                 :             :     {
      71         [ #  # ]:           0 :         DataStream ssKey{};
      72         [ #  # ]:           0 :         ssKey.reserve(1000);
      73                 :           0 :         ssKey << key;
      74                 :             : 
      75                 :           0 :         DataStream ssValue{};
      76   [ #  #  #  # ]:           0 :         if (!ReadKey(std::move(ssKey), ssValue)) return false;
      77                 :             :         try {
      78                 :           0 :             ssValue >> value;
      79                 :           0 :             return true;
      80         [ -  - ]:           0 :         } catch (const std::exception&) {
      81                 :             :             return false;
      82                 :             :         }
      83                 :           0 :     }
      84                 :             : 
      85                 :             :     template <typename K, typename T>
      86                 :     3538836 :     bool Write(const K& key, const T& value, bool fOverwrite = true)
      87                 :             :     {
      88         [ +  - ]:     3538836 :         DataStream ssKey{};
      89         [ +  - ]:     3538836 :         ssKey.reserve(1000);
      90                 :     3538836 :         ssKey << key;
      91                 :             : 
      92         [ +  - ]:     3538836 :         DataStream ssValue{};
      93         [ +  - ]:     3538836 :         ssValue.reserve(10000);
      94                 :     3538836 :         ssValue << value;
      95                 :             : 
      96         [ +  - ]:     3538836 :         return WriteKey(std::move(ssKey), std::move(ssValue), fOverwrite);
      97                 :     3538836 :     }
      98                 :             : 
      99                 :             :     template <typename K>
     100                 :           0 :     bool Erase(const K& key)
     101                 :             :     {
     102         [ #  # ]:           0 :         DataStream ssKey{};
     103         [ #  # ]:           0 :         ssKey.reserve(1000);
     104                 :           0 :         ssKey << key;
     105                 :             : 
     106         [ #  # ]:           0 :         return EraseKey(std::move(ssKey));
     107                 :           0 :     }
     108                 :             : 
     109                 :             :     template <typename K>
     110                 :             :     bool Exists(const K& key)
     111                 :             :     {
     112                 :             :         DataStream ssKey{};
     113                 :             :         ssKey.reserve(1000);
     114                 :             :         ssKey << key;
     115                 :             : 
     116                 :             :         return HasKey(std::move(ssKey));
     117                 :             :     }
     118                 :             :     virtual bool ErasePrefix(Span<const std::byte> prefix) = 0;
     119                 :             : 
     120                 :             :     virtual std::unique_ptr<DatabaseCursor> GetNewCursor() = 0;
     121                 :             :     virtual std::unique_ptr<DatabaseCursor> GetNewPrefixCursor(Span<const std::byte> prefix) = 0;
     122                 :             :     virtual bool TxnBegin() = 0;
     123                 :             :     virtual bool TxnCommit() = 0;
     124                 :             :     virtual bool TxnAbort() = 0;
     125                 :             :     virtual bool HasActiveTxn() = 0;
     126                 :             : };
     127                 :             : 
     128                 :             : /** An instance of this class represents one database.
     129                 :             :  **/
     130                 :             : class WalletDatabase
     131                 :             : {
     132                 :             : public:
     133                 :             :     /** Create dummy DB handle */
     134         [ +  - ]:        7628 :     WalletDatabase() : nUpdateCounter(0) {}
     135                 :        7628 :     virtual ~WalletDatabase() = default;
     136                 :             : 
     137                 :             :     /** Open the database if it is not already opened. */
     138                 :             :     virtual void Open() = 0;
     139                 :             : 
     140                 :             :     //! Counts the number of active database users to be sure that the database is not closed while someone is using it
     141                 :             :     std::atomic<int> m_refcount{0};
     142                 :             :     /** Indicate the a new database user has began using the database. Increments m_refcount */
     143                 :             :     virtual void AddRef() = 0;
     144                 :             :     /** Indicate that database user has stopped using the database and that it could be flushed or closed. Decrement m_refcount */
     145                 :             :     virtual void RemoveRef() = 0;
     146                 :             : 
     147                 :             :     /** Rewrite the entire database on disk, with the exception of key pszSkip if non-zero
     148                 :             :      */
     149                 :             :     virtual bool Rewrite(const char* pszSkip=nullptr) = 0;
     150                 :             : 
     151                 :             :     /** Back up the entire database to a file.
     152                 :             :      */
     153                 :             :     virtual bool Backup(const std::string& strDest) const = 0;
     154                 :             : 
     155                 :             :     /** Make sure all changes are flushed to database file.
     156                 :             :      */
     157                 :             :     virtual void Flush() = 0;
     158                 :             :     /** Flush to the database file and close the database.
     159                 :             :      *  Also close the environment if no other databases are open in it.
     160                 :             :      */
     161                 :             :     virtual void Close() = 0;
     162                 :             :     /* flush the wallet passively (TRY_LOCK)
     163                 :             :        ideal to be called periodically */
     164                 :             :     virtual bool PeriodicFlush() = 0;
     165                 :             : 
     166                 :             :     virtual void IncrementUpdateCounter() = 0;
     167                 :             : 
     168                 :             :     virtual void ReloadDbEnv() = 0;
     169                 :             : 
     170                 :             :     /** Return path to main database file for logs and error messages. */
     171                 :             :     virtual std::string Filename() = 0;
     172                 :             : 
     173                 :             :     virtual std::string Format() = 0;
     174                 :             : 
     175                 :             :     std::atomic<unsigned int> nUpdateCounter;
     176                 :             :     unsigned int nLastSeen{0};
     177                 :             :     unsigned int nLastFlushed{0};
     178                 :             :     int64_t nLastWalletUpdate{0};
     179                 :             : 
     180                 :             :     /** Make a DatabaseBatch connected to this database */
     181                 :             :     virtual std::unique_ptr<DatabaseBatch> MakeBatch(bool flush_on_close = true) = 0;
     182                 :             : };
     183                 :             : 
     184                 :             : enum class DatabaseFormat {
     185                 :             :     BERKELEY,
     186                 :             :     SQLITE,
     187                 :             :     BERKELEY_RO,
     188                 :             :     BERKELEY_SWAP,
     189                 :             : };
     190                 :             : 
     191   [ #  #  #  #  :          78 : struct DatabaseOptions {
           #  # ][ #  #  
          #  #  #  #  #  
           # ][ #  #  #  
             #  #  #  #  
                      # ]
           [ #  #  #  # ]
     192                 :             :     bool require_existing = false;
     193                 :             :     bool require_create = false;
     194                 :             :     std::optional<DatabaseFormat> require_format;
     195                 :             :     uint64_t create_flags = 0;
     196                 :             :     SecureString create_passphrase;
     197                 :             : 
     198                 :             :     // Specialized options. Not every option is supported by every backend.
     199                 :             :     bool verify = true;             //!< Check data integrity on load.
     200                 :             :     bool use_unsafe_sync = false;   //!< Disable file sync for faster performance.
     201                 :             :     bool use_shared_memory = false; //!< Let other processes access the database.
     202                 :             :     int64_t max_log_mb = 100;       //!< Max log size to allow before consolidating.
     203                 :             : };
     204                 :             : 
     205                 :             : enum class DatabaseStatus {
     206                 :             :     SUCCESS,
     207                 :             :     FAILED_BAD_PATH,
     208                 :             :     FAILED_BAD_FORMAT,
     209                 :             :     FAILED_ALREADY_LOADED,
     210                 :             :     FAILED_ALREADY_EXISTS,
     211                 :             :     FAILED_NOT_FOUND,
     212                 :             :     FAILED_CREATE,
     213                 :             :     FAILED_LOAD,
     214                 :             :     FAILED_VERIFY,
     215                 :             :     FAILED_ENCRYPT,
     216                 :             :     FAILED_INVALID_BACKUP_FILE,
     217                 :             : };
     218                 :             : 
     219                 :             : /** Recursively list database paths in directory. */
     220                 :             : std::vector<std::pair<fs::path, std::string>> ListDatabases(const fs::path& path);
     221                 :             : 
     222                 :             : void ReadDatabaseArgs(const ArgsManager& args, DatabaseOptions& options);
     223                 :             : std::unique_ptr<WalletDatabase> MakeDatabase(const fs::path& path, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error);
     224                 :             : 
     225                 :             : fs::path BDBDataFile(const fs::path& path);
     226                 :             : fs::path SQLiteDataFile(const fs::path& path);
     227                 :             : bool IsBDBFile(const fs::path& path);
     228                 :             : bool IsSQLiteFile(const fs::path& path);
     229                 :             : } // namespace wallet
     230                 :             : 
     231                 :             : #endif // BITCOIN_WALLET_DB_H
        

Generated by: LCOV version 2.0-1