src/db.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2011 The Bitcoin developers
   3 // Copyright (c) 2011-2012 The PPCoin developers
   4 // Distributed under the MIT/X11 software license, see the accompanying
   5 // file license.txt or http://www.opensource.org/licenses/mit-license.php.
   6 #ifndef BITCOIN_DB_H
   7 #define BITCOIN_DB_H
   8
   9 #include "key.h"
  10
  11 #include <map>
  12 #include <string>
  13 #include <vector>
  14
  15 #include <db_cxx.h>
  16
  17 class CTxIndex;
  18 class CDiskBlockIndex;
  19 class CDiskTxPos;
  20 class COutPoint;
  21 class CAddress;
  22 class CWalletTx;
  23 class CWallet;
  24 class CAccount;
  25 class CAccountingEntry;
  26 class CBlockLocator;
  27
  28
  29 extern unsigned int nWalletDBUpdated;
  30 extern DbEnv dbenv;
  31
  32 extern void DBFlush(bool fShutdown);
  33 void ThreadFlushWalletDB(void* parg);
  34 bool BackupWallet(const CWallet& wallet, const std::string& strDest);
  35
  36
  37
  38 class CDB
  39 {
  40 protected:
  41     Db* pdb;
  42     std::string strFile;
  43     std::vector<DbTxn*> vTxn;
  44     bool fReadOnly;
  45
  46     explicit CDB(const char* pszFile, const char* pszMode="r+");
  47     ~CDB() { Close(); }
  48 public:
  49     void Close();
  50 private:
  51     CDB(const CDB&);
  52     void operator=(const CDB&);
  53
  54 protected:
  55     template<typename K, typename T>
  56     bool Read(const K& key, T& value)
  57     {
  58         if (!pdb)
  59             return false;
  60
  61         // Key
  62         CDataStream ssKey(SER_DISK);
  63         ssKey.reserve(1000);
  64         ssKey << key;
  65         Dbt datKey(&ssKey[0], ssKey.size());
  66
  67         // Read
  68         Dbt datValue;
  69         datValue.set_flags(DB_DBT_MALLOC);
  70         int ret = pdb->get(GetTxn(), &datKey, &datValue, 0);
  71         memset(datKey.get_data(), 0, datKey.get_size());
  72         if (datValue.get_data() == NULL)
  73             return false;
  74
  75         // Unserialize value
  76         CDataStream ssValue((char*)datValue.get_data(), (char*)datValue.get_data() + datValue.get_size(), SER_DISK);
  77         ssValue >> value;
  78
  79         // Clear and free memory
  80         memset(datValue.get_data(), 0, datValue.get_size());
  81         free(datValue.get_data());
  82         return (ret == 0);
  83     }
  84
  85     template<typename K, typename T>
  86     bool Write(const K& key, const T& value, bool fOverwrite=true)
  87     {
  88         if (!pdb)
  89             return false;
  90         if (fReadOnly)
  91             assert(!"Write called on database in read-only mode");
  92
  93         // Key
  94         CDataStream ssKey(SER_DISK);
  95         ssKey.reserve(1000);
  96         ssKey << key;
  97         Dbt datKey(&ssKey[0], ssKey.size());
  98
  99         // Value
 100         CDataStream ssValue(SER_DISK);
 101         ssValue.reserve(10000);
 102         ssValue << value;
 103         Dbt datValue(&ssValue[0], ssValue.size());
 104
 105         // Write
 106         int ret = pdb->put(GetTxn(), &datKey, &datValue, (fOverwrite ? 0 : DB_NOOVERWRITE));
 107
 108         // Clear memory in case it was a private key
 109         memset(datKey.get_data(), 0, datKey.get_size());
 110         memset(datValue.get_data(), 0, datValue.get_size());
 111         return (ret == 0);
 112     }
 113
 114     template<typename K>
 115     bool Erase(const K& key)
 116     {
 117         if (!pdb)
 118             return false;
 119         if (fReadOnly)
 120             assert(!"Erase called on database in read-only mode");
 121
 122         // Key
 123         CDataStream ssKey(SER_DISK);
 124         ssKey.reserve(1000);
 125         ssKey << key;
 126         Dbt datKey(&ssKey[0], ssKey.size());
 127
 128         // Erase
 129         int ret = pdb->del(GetTxn(), &datKey, 0);
 130
 131         // Clear memory
 132         memset(datKey.get_data(), 0, datKey.get_size());
 133         return (ret == 0 || ret == DB_NOTFOUND);
 134     }
 135
 136     template<typename K>
 137     bool Exists(const K& key)
 138     {
 139         if (!pdb)
 140             return false;
 141
 142         // Key
 143         CDataStream ssKey(SER_DISK);
 144         ssKey.reserve(1000);
 145         ssKey << key;
 146         Dbt datKey(&ssKey[0], ssKey.size());
 147
 148         // Exists
 149         int ret = pdb->exists(GetTxn(), &datKey, 0);
 150
 151         // Clear memory
 152         memset(datKey.get_data(), 0, datKey.get_size());
 153         return (ret == 0);
 154     }
 155
 156     Dbc* GetCursor()
 157     {
 158         if (!pdb)
 159             return NULL;
 160         Dbc* pcursor = NULL;
 161         int ret = pdb->cursor(NULL, &pcursor, 0);
 162         if (ret != 0)
 163             return NULL;
 164         return pcursor;
 165     }
 166
 167     int ReadAtCursor(Dbc* pcursor, CDataStream& ssKey, CDataStream& ssValue, unsigned int fFlags=DB_NEXT)
 168     {
 169         // Read at cursor
 170         Dbt datKey;
 171         if (fFlags == DB_SET || fFlags == DB_SET_RANGE || fFlags == DB_GET_BOTH || fFlags == DB_GET_BOTH_RANGE)
 172         {
 173             datKey.set_data(&ssKey[0]);
 174             datKey.set_size(ssKey.size());
 175         }
 176         Dbt datValue;
 177         if (fFlags == DB_GET_BOTH || fFlags == DB_GET_BOTH_RANGE)
 178         {
 179             datValue.set_data(&ssValue[0]);
 180             datValue.set_size(ssValue.size());
 181         }
 182         datKey.set_flags(DB_DBT_MALLOC);
 183         datValue.set_flags(DB_DBT_MALLOC);
 184         int ret = pcursor->get(&datKey, &datValue, fFlags);
 185         if (ret != 0)
 186             return ret;
 187         else if (datKey.get_data() == NULL || datValue.get_data() == NULL)
 188             return 99999;
 189
 190         // Convert to streams
 191         ssKey.SetType(SER_DISK);
 192         ssKey.clear();
 193         ssKey.write((char*)datKey.get_data(), datKey.get_size());
 194         ssValue.SetType(SER_DISK);
 195         ssValue.clear();
 196         ssValue.write((char*)datValue.get_data(), datValue.get_size());
 197
 198         // Clear and free memory
 199         memset(datKey.get_data(), 0, datKey.get_size());
 200         memset(datValue.get_data(), 0, datValue.get_size());
 201         free(datKey.get_data());
 202         free(datValue.get_data());
 203         return 0;
 204     }
 205
 206     DbTxn* GetTxn()
 207     {
 208         if (!vTxn.empty())
 209             return vTxn.back();
 210         else
 211             return NULL;
 212     }
 213
 214 public:
 215     bool TxnBegin()
 216     {
 217         if (!pdb)
 218             return false;
 219         DbTxn* ptxn = NULL;
 220         int ret = dbenv.txn_begin(GetTxn(), &ptxn, DB_TXN_NOSYNC);
 221         if (!ptxn || ret != 0)
 222             return false;
 223         vTxn.push_back(ptxn);
 224         return true;
 225     }
 226
 227     bool TxnCommit()
 228     {
 229         if (!pdb)
 230             return false;
 231         if (vTxn.empty())
 232             return false;
 233         int ret = vTxn.back()->commit(0);
 234         vTxn.pop_back();
 235         return (ret == 0);
 236     }
 237
 238     bool TxnAbort()
 239     {
 240         if (!pdb)
 241             return false;
 242         if (vTxn.empty())
 243             return false;
 244         int ret = vTxn.back()->abort();
 245         vTxn.pop_back();
 246         return (ret == 0);
 247     }
 248
 249     bool ReadVersion(int& nVersion)
 250     {
 251         nVersion = 0;
 252         return Read(std::string("version"), nVersion);
 253     }
 254
 255     bool WriteVersion(int nVersion)
 256     {
 257         return Write(std::string("version"), nVersion);
 258     }
 259
 260     bool static Rewrite(const std::string& strFile, const char* pszSkip = NULL);
 261 };
 262
 263
 264
 265
 266
 267
 268
 269
 270 class CTxDB : public CDB
 271 {
 272 public:
 273     CTxDB(const char* pszMode="r+") : CDB("blkindex.dat", pszMode) { }
 274 private:
 275     CTxDB(const CTxDB&);
 276     void operator=(const CTxDB&);
 277 public:
 278     bool ReadTxIndex(uint256 hash, CTxIndex& txindex);
 279     bool UpdateTxIndex(uint256 hash, const CTxIndex& txindex);
 280     bool AddTxIndex(const CTransaction& tx, const CDiskTxPos& pos, int nHeight);
 281     bool EraseTxIndex(const CTransaction& tx);
 282     bool ContainsTx(uint256 hash);
 283     bool ReadOwnerTxes(uint160 hash160, int nHeight, std::vector<CTransaction>& vtx);
 284     bool ReadDiskTx(uint256 hash, CTransaction& tx, CTxIndex& txindex);
 285     bool ReadDiskTx(uint256 hash, CTransaction& tx);
 286     bool ReadDiskTx(COutPoint outpoint, CTransaction& tx, CTxIndex& txindex);
 287     bool ReadDiskTx(COutPoint outpoint, CTransaction& tx);
 288     bool WriteBlockIndex(const CDiskBlockIndex& blockindex);
 289     bool EraseBlockIndex(uint256 hash);
 290     bool ReadHashBestChain(uint256& hashBestChain);
 291     bool WriteHashBestChain(uint256 hashBestChain);
 292     bool ReadBestInvalidTrust(uint64& nBestInvalidTrust);
 293     bool WriteBestInvalidTrust(uint64 nBestInvalidTrust);
 294     bool ReadAutoCheckpoint(int& nAutoCheckpoint);
 295     bool WriteAutoCheckpoint(int nCheckpoint, bool fReset=false);
 296     bool ReadSyncCheckpoint(uint256& hashCheckpoint);
 297     bool WriteSyncCheckpoint(uint256 hashCheckpoint);
 298     bool LoadBlockIndex();
 299 };
 300
 301
 302
 303
 304
 305 class CAddrDB : public CDB
 306 {
 307 public:
 308     CAddrDB(const char* pszMode="r+") : CDB("addr.dat", pszMode) { }
 309 private:
 310     CAddrDB(const CAddrDB&);
 311     void operator=(const CAddrDB&);
 312 public:
 313     bool WriteAddress(const CAddress& addr);
 314     bool EraseAddress(const CAddress& addr);
 315     bool LoadAddresses();
 316 };
 317
 318 bool LoadAddresses();
 319
 320
 321
 322 class CKeyPool
 323 {
 324 public:
 325     int64 nTime;
 326     std::vector<unsigned char> vchPubKey;
 327
 328     CKeyPool()
 329     {
 330         nTime = GetTime();
 331     }
 332
 333     CKeyPool(const std::vector<unsigned char>& vchPubKeyIn)
 334     {
 335         nTime = GetTime();
 336         vchPubKey = vchPubKeyIn;
 337     }
 338
 339     IMPLEMENT_SERIALIZE
 340     (
 341         if (!(nType & SER_GETHASH))
 342             READWRITE(nVersion);
 343         READWRITE(nTime);
 344         READWRITE(vchPubKey);
 345     )
 346 };
 347
 348
 349
 350
 351 enum DBErrors
 352 {
 353     DB_LOAD_OK,
 354     DB_CORRUPT,
 355     DB_TOO_NEW,
 356     DB_LOAD_FAIL,
 357     DB_NEED_REWRITE
 358 };
 359
 360 class CWalletDB : public CDB
 361 {
 362 public:
 363     CWalletDB(std::string strFilename, const char* pszMode="r+") : CDB(strFilename.c_str(), pszMode)
 364     {
 365     }
 366 private:
 367     CWalletDB(const CWalletDB&);
 368     void operator=(const CWalletDB&);
 369 public:
 370     bool ReadName(const std::string& strAddress, std::string& strName)
 371     {
 372         strName = "";
 373         return Read(std::make_pair(std::string("name"), strAddress), strName);
 374     }
 375
 376     bool WriteName(const std::string& strAddress, const std::string& strName);
 377
 378     bool EraseName(const std::string& strAddress);
 379
 380     bool ReadTx(uint256 hash, CWalletTx& wtx)
 381     {
 382         return Read(std::make_pair(std::string("tx"), hash), wtx);
 383     }
 384
 385     bool WriteTx(uint256 hash, const CWalletTx& wtx)
 386     {
 387         nWalletDBUpdated++;
 388         return Write(std::make_pair(std::string("tx"), hash), wtx);
 389     }
 390
 391     bool EraseTx(uint256 hash)
 392     {
 393         nWalletDBUpdated++;
 394         return Erase(std::make_pair(std::string("tx"), hash));
 395     }
 396
 397     bool ReadKey(const std::vector<unsigned char>& vchPubKey, CPrivKey& vchPrivKey)
 398     {
 399         vchPrivKey.clear();
 400         return Read(std::make_pair(std::string("key"), vchPubKey), vchPrivKey);
 401     }
 402
 403     bool WriteKey(const std::vector<unsigned char>& vchPubKey, const CPrivKey& vchPrivKey)
 404     {
 405         nWalletDBUpdated++;
 406         return Write(std::make_pair(std::string("key"), vchPubKey), vchPrivKey, false);
 407     }
 408
 409     bool WriteCryptedKey(const std::vector<unsigned char>& vchPubKey, const std::vector<unsigned char>& vchCryptedSecret, bool fEraseUnencryptedKey = true)
 410     {
 411         nWalletDBUpdated++;
 412         if (!Write(std::make_pair(std::string("ckey"), vchPubKey), vchCryptedSecret, false))
 413             return false;
 414         if (fEraseUnencryptedKey)
 415         {
 416             Erase(std::make_pair(std::string("key"), vchPubKey));
 417             Erase(std::make_pair(std::string("wkey"), vchPubKey));
 418         }
 419         return true;
 420     }
 421
 422     bool WriteMasterKey(unsigned int nID, const CMasterKey& kMasterKey)
 423     {
 424         nWalletDBUpdated++;
 425         return Write(std::make_pair(std::string("mkey"), nID), kMasterKey, true);
 426     }
 427
 428     bool WriteBestBlock(const CBlockLocator& locator)
 429     {
 430         nWalletDBUpdated++;
 431         return Write(std::string("bestblock"), locator);
 432     }
 433
 434     bool ReadBestBlock(CBlockLocator& locator)
 435     {
 436         return Read(std::string("bestblock"), locator);
 437     }
 438
 439     bool ReadDefaultKey(std::vector<unsigned char>& vchPubKey)
 440     {
 441         vchPubKey.clear();
 442         return Read(std::string("defaultkey"), vchPubKey);
 443     }
 444
 445     bool WriteDefaultKey(const std::vector<unsigned char>& vchPubKey)
 446     {
 447         nWalletDBUpdated++;
 448         return Write(std::string("defaultkey"), vchPubKey);
 449     }
 450
 451     bool ReadPool(int64 nPool, CKeyPool& keypool)
 452     {
 453         return Read(std::make_pair(std::string("pool"), nPool), keypool);
 454     }
 455
 456     bool WritePool(int64 nPool, const CKeyPool& keypool)
 457     {
 458         nWalletDBUpdated++;
 459         return Write(std::make_pair(std::string("pool"), nPool), keypool);
 460     }
 461
 462     bool ErasePool(int64 nPool)
 463     {
 464         nWalletDBUpdated++;
 465         return Erase(std::make_pair(std::string("pool"), nPool));
 466     }
 467
 468     template<typename T>
 469     bool ReadSetting(const std::string& strKey, T& value)
 470     {
 471         return Read(std::make_pair(std::string("setting"), strKey), value);
 472     }
 473
 474     template<typename T>
 475     bool WriteSetting(const std::string& strKey, const T& value)
 476     {
 477         nWalletDBUpdated++;
 478         return Write(std::make_pair(std::string("setting"), strKey), value);
 479     }
 480
 481     bool ReadAccount(const std::string& strAccount, CAccount& account);
 482     bool WriteAccount(const std::string& strAccount, const CAccount& account);
 483     bool WriteAccountingEntry(const CAccountingEntry& acentry);
 484     int64 GetAccountCreditDebit(const std::string& strAccount);
 485     void ListAccountCreditDebit(const std::string& strAccount, std::list<CAccountingEntry>& acentries);
 486
 487     int LoadWallet(CWallet* pwallet);
 488 };
 489
 490 #endif