1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2012 The Bitcoin developers
3 // Distributed under the MIT/X11 software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
19 class CDiskBlockIndex;
27 extern unsigned int nWalletDBUpdated;
29 void ThreadFlushWalletDB(void* parg);
30 bool BackupWallet(const CWallet& wallet, const std::string& strDest);
39 boost::filesystem::path pathEnv;
45 mutable CCriticalSection cs_db;
47 std::map<std::string, int> mapFileUseCount;
48 std::map<std::string, Db*> mapDb;
53 bool IsMock() { return fMockDb; };
56 * Verify that database file strFile is OK. If it is not,
57 * call the callback to try to recover.
58 * This must be called BEFORE strFile is opened.
59 * Returns true if strFile is OK.
61 enum VerifyResult { VERIFY_OK, RECOVER_OK, RECOVER_FAIL };
62 VerifyResult Verify(std::string strFile, bool (*recoverFunc)(CDBEnv& dbenv, std::string strFile));
64 * Salvage data from a file that Verify says is bad.
65 * fAggressive sets the DB_AGGRESSIVE flag (see berkeley DB->verify() method documentation).
66 * Appends binary key/value pairs to vResult, returns true if successful.
67 * NOTE: reads the entire database into memory, so cannot be used
70 typedef std::pair<std::vector<unsigned char>, std::vector<unsigned char> > KeyValPair;
71 bool Salvage(std::string strFile, bool fAggressive, std::vector<KeyValPair>& vResult);
73 bool Open(boost::filesystem::path pathEnv_);
75 void Flush(bool fShutdown);
76 void CheckpointLSN(std::string strFile);
77 void SetDetach(bool fDetachDB_) { fDetachDB = fDetachDB_; }
78 bool GetDetach() { return fDetachDB; }
80 void CloseDb(const std::string& strFile);
81 bool RemoveDb(const std::string& strFile);
83 DbTxn *TxnBegin(int flags=DB_TXN_WRITE_NOSYNC)
86 int ret = dbenv.txn_begin(NULL, &ptxn, flags);
87 if (!ptxn || ret != 0)
96 /** RAII class that provides access to a Berkeley database */
105 explicit CDB(const char* pszFile, const char* pszMode="r+");
111 void operator=(const CDB&);
114 template<typename K, typename T>
115 bool Read(const K& key, T& value)
121 CDataStream ssKey(SER_DISK, CLIENT_VERSION);
124 Dbt datKey(&ssKey[0], ssKey.size());
128 datValue.set_flags(DB_DBT_MALLOC);
129 int ret = pdb->get(activeTxn, &datKey, &datValue, 0);
130 memset(datKey.get_data(), 0, datKey.get_size());
131 if (datValue.get_data() == NULL)
136 CDataStream ssValue((char*)datValue.get_data(), (char*)datValue.get_data() + datValue.get_size(), SER_DISK, CLIENT_VERSION);
139 catch (std::exception &e) {
143 // Clear and free memory
144 memset(datValue.get_data(), 0, datValue.get_size());
145 free(datValue.get_data());
149 template<typename K, typename T>
150 bool Write(const K& key, const T& value, bool fOverwrite=true)
155 assert(!"Write called on database in read-only mode");
158 CDataStream ssKey(SER_DISK, CLIENT_VERSION);
161 Dbt datKey(&ssKey[0], ssKey.size());
164 CDataStream ssValue(SER_DISK, CLIENT_VERSION);
165 ssValue.reserve(10000);
167 Dbt datValue(&ssValue[0], ssValue.size());
170 int ret = pdb->put(activeTxn, &datKey, &datValue, (fOverwrite ? 0 : DB_NOOVERWRITE));
172 // Clear memory in case it was a private key
173 memset(datKey.get_data(), 0, datKey.get_size());
174 memset(datValue.get_data(), 0, datValue.get_size());
179 bool Erase(const K& key)
184 assert(!"Erase called on database in read-only mode");
187 CDataStream ssKey(SER_DISK, CLIENT_VERSION);
190 Dbt datKey(&ssKey[0], ssKey.size());
193 int ret = pdb->del(activeTxn, &datKey, 0);
196 memset(datKey.get_data(), 0, datKey.get_size());
197 return (ret == 0 || ret == DB_NOTFOUND);
201 bool Exists(const K& key)
207 CDataStream ssKey(SER_DISK, CLIENT_VERSION);
210 Dbt datKey(&ssKey[0], ssKey.size());
213 int ret = pdb->exists(activeTxn, &datKey, 0);
216 memset(datKey.get_data(), 0, datKey.get_size());
225 int ret = pdb->cursor(NULL, &pcursor, 0);
231 int ReadAtCursor(Dbc* pcursor, CDataStream& ssKey, CDataStream& ssValue, unsigned int fFlags=DB_NEXT)
235 if (fFlags == DB_SET || fFlags == DB_SET_RANGE || fFlags == DB_GET_BOTH || fFlags == DB_GET_BOTH_RANGE)
237 datKey.set_data(&ssKey[0]);
238 datKey.set_size(ssKey.size());
241 if (fFlags == DB_GET_BOTH || fFlags == DB_GET_BOTH_RANGE)
243 datValue.set_data(&ssValue[0]);
244 datValue.set_size(ssValue.size());
246 datKey.set_flags(DB_DBT_MALLOC);
247 datValue.set_flags(DB_DBT_MALLOC);
248 int ret = pcursor->get(&datKey, &datValue, fFlags);
251 else if (datKey.get_data() == NULL || datValue.get_data() == NULL)
254 // Convert to streams
255 ssKey.SetType(SER_DISK);
257 ssKey.write((char*)datKey.get_data(), datKey.get_size());
258 ssValue.SetType(SER_DISK);
260 ssValue.write((char*)datValue.get_data(), datValue.get_size());
262 // Clear and free memory
263 memset(datKey.get_data(), 0, datKey.get_size());
264 memset(datValue.get_data(), 0, datValue.get_size());
265 free(datKey.get_data());
266 free(datValue.get_data());
273 if (!pdb || activeTxn)
275 DbTxn* ptxn = bitdb.TxnBegin();
284 if (!pdb || !activeTxn)
286 int ret = activeTxn->commit(0);
293 if (!pdb || !activeTxn)
295 int ret = activeTxn->abort();
300 bool ReadVersion(int& nVersion)
303 return Read(std::string("version"), nVersion);
306 bool WriteVersion(int nVersion)
308 return Write(std::string("version"), nVersion);
311 bool static Rewrite(const std::string& strFile, const char* pszSkip = NULL);
315 /** Access to the (IP) address database (peers.dat) */
319 boost::filesystem::path pathAddr;
322 bool Write(const CAddrMan& addr);
323 bool Read(CAddrMan& addr);
326 #endif // BITCOIN_DB_H