35 const std::string &filename, Db &
db,
41 int ret =
db.get_mpf()->get_fileid(fileid.
value);
43 throw std::runtime_error(
44 strprintf(
"BerkeleyDatabase: Can't open database %s (get_fileid "
50 if (fileid == item.second && &fileid != &item.second) {
51 throw std::runtime_error(
52 strprintf(
"BerkeleyDatabase: Can't open database %s "
53 "(duplicates fileid %s "
55 filename,
HexStr(item.second.value), item.first));
63std::map<std::string, std::weak_ptr<BerkeleyEnvironment>>
83std::shared_ptr<BerkeleyEnvironment>
89 std::weak_ptr<BerkeleyEnvironment>());
90 if (inserted.second) {
91 auto env = std::make_shared<BerkeleyEnvironment>(env_directory);
92 inserted.first->second = env;
95 return inserted.first->second.lock();
113 database.
m_db->close(0);
114 database.
m_db.reset();
118 FILE *error_file =
nullptr;
119 dbenv->get_errfile(&error_file);
121 int ret =
dbenv->close(0);
123 LogPrintf(
"BerkeleyEnvironment::Close: Error %d closing database "
125 ret, DbEnv::strerror(ret));
128 DbEnv(uint32_t(0)).remove(
strPath.c_str(), 0);
139 dbenv.reset(
new DbEnv(DB_CXX_NO_EXCEPTIONS));
164 LogPrintf(
"Cannot obtain a lock on wallet directory %s. Another "
165 "instance of bitcoin may be using it.\n",
167 err =
strprintf(
_(
"Error initializing wallet database environment %s!"),
172 fs::path pathLogDir = pathIn /
"database";
174 fs::path pathErrorFile = pathIn /
"db.log";
175 LogPrintf(
"BerkeleyEnvironment::Open: LogDir=%s ErrorFile=%s\n",
178 unsigned int nEnvFlags = 0;
180 nEnvFlags |= DB_PRIVATE;
185 dbenv->set_cachesize(0, 0x100000, 1);
186 dbenv->set_lg_bsize(0x10000);
187 dbenv->set_lg_max(1048576);
188 dbenv->set_lk_max_locks(40000);
189 dbenv->set_lk_max_objects(40000);
192 dbenv->set_flags(DB_AUTO_COMMIT, 1);
193 dbenv->set_flags(DB_TXN_WRITE_NOSYNC, 1);
194 dbenv->log_set_config(DB_LOG_AUTO_REMOVE, 1);
197 DB_CREATE | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_MPOOL |
198 DB_INIT_TXN | DB_THREAD | DB_RECOVER | nEnvFlags,
201 LogPrintf(
"BerkeleyEnvironment::Open: Error %d opening database "
203 ret, DbEnv::strerror(ret));
204 int ret2 =
dbenv->close(0);
206 LogPrintf(
"BerkeleyEnvironment::Open: Error %d closing failed "
207 "database environment: %s\n",
208 ret2, DbEnv::strerror(ret2));
211 err =
strprintf(
_(
"Error initializing wallet database environment %s!"),
213 if (ret == DB_RUNRECOVERY) {
215 _(
"This error could occur if this wallet was not shutdown "
216 "cleanly and was last loaded using a build with a newer "
217 "version of Berkeley DB. If so, please use the software "
218 "that last loaded this wallet");
234 dbenv->set_cachesize(1, 0, 1);
235 dbenv->set_lg_bsize(10485760 * 4);
236 dbenv->set_lg_max(10485760);
237 dbenv->set_lk_max_locks(10000);
238 dbenv->set_lk_max_objects(10000);
239 dbenv->set_flags(DB_AUTO_COMMIT, 1);
240 dbenv->log_set_config(DB_LOG_IN_MEMORY, 1);
243 DB_CREATE | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_MPOOL |
244 DB_INIT_TXN | DB_THREAD | DB_PRIVATE,
247 throw std::runtime_error(
248 strprintf(
"BerkeleyEnvironment::MakeMock: Error %d opening "
249 "database environment.",
258 m_dbt.set_flags(DB_DBT_MALLOC);
264 if (m_dbt.get_data() !=
nullptr) {
270 if (m_dbt.get_flags() & DB_DBT_MALLOC) {
271 free(m_dbt.get_data());
277 return m_dbt.get_data();
281 return m_dbt.get_size();
284BerkeleyBatch::SafeDbt::operator Dbt *() {
303 int result =
db.verify(
strFile.c_str(),
nullptr,
nullptr, 0);
306 strprintf(
_(
"%s corrupt. Try using the wallet tool "
307 "bitcoin-wallet to salvage or restoring a backup."),
317 dbenv->txn_checkpoint(0, 0, 0);
321 dbenv->lsn_reset(
strFile.c_str(), 0);
336 bool fFlushOnCloseIn)
349 unsigned int nFlags = DB_THREAD | DB_CREATE;
354 if (!
env->Open(open_err)) {
355 throw std::runtime_error(
356 "BerkeleyDatabase: Failed to open database environment.");
359 if (
m_db ==
nullptr) {
361 std::unique_ptr<Db> pdb_temp =
362 std::make_unique<Db>(
env->dbenv.get(), 0);
364 bool fMockDb =
env->IsMock();
366 DbMpoolFile *mpf = pdb_temp->get_mpf();
367 ret = mpf->set_flags(DB_MPOOL_NOFILE, 1);
370 "BerkeleyDatabase: Failed to configure for no "
371 "temp file backing for database %s",
376 ret = pdb_temp->open(
378 fMockDb ?
nullptr :
strFile.c_str(),
379 fMockDb ?
strFile.c_str() :
"main",
386 "BerkeleyDatabase: Error %d, can't open database %s", ret,
396 m_db.reset(pdb_temp.release());
407 unsigned int nMinutes = 0;
455 database.
m_db->close(0);
456 database.
m_db.reset();
463 std::unique_lock<RecursiveMutex> lock(cs_db);
466 if (
db.second.get().m_refcount > 0) {
479 for (
const std::string &filename :
filenames) {
500 bool fSuccess =
true;
502 std::string strFileRes =
strFile +
".rewrite";
505 std::unique_ptr<Db> pdbCopy =
506 std::make_unique<Db>(
env->dbenv.get(), 0);
508 int ret = pdbCopy->open(
nullptr,
515 LogPrintf(
"BerkeleyBatch::Rewrite: Can't create "
516 "database file %s\n",
521 if (
db.StartCursor()) {
527 db.ReadAtCursor(ssKey, ssValue, complete);
536 strncmp((
const char *)ssKey.data(), pszSkip,
537 std::min(ssKey.size(),
538 strlen(pszSkip))) == 0) {
541 if (strncmp((
const char *)ssKey.data(),
542 "\x07version", 8) == 0) {
547 Dbt datKey(ssKey.data(), ssKey.size());
548 Dbt datValue(ssValue.data(), ssValue.size());
549 int ret2 = pdbCopy->put(
nullptr, &datKey, &datValue,
560 if (pdbCopy->close(0)) {
568 Db dbA(
env->dbenv.get(), 0);
569 if (dbA.remove(
strFile.c_str(),
nullptr, 0)) {
572 Db dbB(
env->dbenv.get(), 0);
573 if (dbB.rename(strFileRes.c_str(),
nullptr,
strFile.c_str(),
579 LogPrintf(
"BerkeleyBatch::Rewrite: Failed to rewrite "
580 "database file %s\n",
594 strPath, fShutdown ?
"true" :
"false",
601 bool no_dbs_accessed =
true;
603 std::string strFile = db_it.first;
604 int nRefCount = db_it.second.get().m_refcount;
610 "BerkeleyEnvironment::Flush: Flushing %s (refcount = %d)...\n",
612 if (nRefCount == 0) {
616 "BerkeleyEnvironment::Flush: %s checkpoint\n",
618 dbenv->txn_checkpoint(0, 0, 0);
620 "BerkeleyEnvironment::Flush: %s detach\n", strFile);
622 dbenv->lsn_reset(strFile.c_str(), 0);
625 "BerkeleyEnvironment::Flush: %s closed\n", strFile);
628 no_dbs_accessed =
false;
632 "BerkeleyEnvironment::Flush: Flush(%s)%s took %15dms\n",
633 fShutdown ?
"true" :
"false",
638 if (no_dbs_accessed) {
639 dbenv->log_archive(&listp, DB_ARCH_REMOVE);
657 for (
auto &it :
env->m_databases) {
658 if (it.second.get().m_refcount > 0) {
694 if (fs::is_directory(pathDest)) {
700 fs::equivalent(pathSrc, pathDest)) {
701 LogPrintf(
"cannot backup to wallet source file %s\n",
707 fs::copy_options::overwrite_existing);
711 }
catch (
const fs::filesystem_error &e) {
753 int ret =
m_cursor->get(datKey, datValue, DB_NEXT);
754 if (ret == DB_NOTFOUND) {
759 }
else if (datKey.
get_data() ==
nullptr || datValue.
get_data() ==
nullptr) {
810 return DbEnv::version(
nullptr,
nullptr,
nullptr);
818 SafeDbt datKey(key.data(), key.size());
822 if (ret == 0 && datValue.
get_data() !=
nullptr) {
836 assert(!
"Write called on database in read-only mode");
839 SafeDbt datKey(key.data(), key.size());
841 SafeDbt datValue(value.data(), value.size());
844 pdb->put(
activeTxn, datKey, datValue, (overwrite ? 0 : DB_NOOVERWRITE));
853 assert(!
"Erase called on database in read-only mode");
856 SafeDbt datKey(key.data(), key.size());
859 return (ret == 0 || ret == DB_NOTFOUND);
867 SafeDbt datKey(key.data(), key.size());
886 env->m_db_in_use.notify_all();
890std::unique_ptr<DatabaseBatch>
892 return std::make_unique<BerkeleyBatch>(*
this,
false, flush_on_close);
897 std::string data_filename;
902std::unique_ptr<BerkeleyDatabase>
905 std::unique_ptr<BerkeleyDatabase>
db;
909 std::string data_filename;
910 std::shared_ptr<BerkeleyEnvironment> env =
912 if (env->m_databases.count(data_filename)) {
914 "Refusing to load database. Data file '%s' is already loaded.",
919 db = std::make_unique<BerkeleyDatabase>(std::move(env),
920 std::move(data_filename));
923 if (options.
verify && !
db->Verify(error)) {
bool ExistsBerkeleyDatabase(const fs::path &path)
Check if Berkeley database exists at specified path.
std::unique_ptr< BerkeleyDatabase > MakeBerkeleyDatabase(const fs::path &path, const DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error)
Return object giving access to Berkeley database at specified path.
std::string BerkeleyDatabaseVersion()
std::shared_ptr< BerkeleyEnvironment > GetWalletEnv(const fs::path &wallet_path, std::string &database_filename)
Get BerkeleyEnvironment and database filename given a wallet path.
static const unsigned int DEFAULT_WALLET_DBLOGSIZE
static const bool DEFAULT_WALLET_PRIVDB
bool IsBerkeleyBtree(const fs::path &path)
Check format of database file.
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
RAII class that automatically cleanses its data on destruction.
uint32_t get_size() const
const void * get_data() const
RAII class that provides access to a Berkeley database.
bool HasKey(DataStream &&key) override
bool ReadKey(DataStream &&key, DataStream &value) override
bool TxnCommit() override
bool ReadAtCursor(DataStream &ssKey, DataStream &ssValue, bool &complete) override
bool StartCursor() override
void CloseCursor() override
bool WriteKey(DataStream &&key, DataStream &&value, bool overwrite=true) override
BerkeleyBatch(BerkeleyDatabase &database, const bool fReadOnly, bool fFlushOnCloseIn=true)
bool EraseKey(DataStream &&key) override
BerkeleyEnvironment * env
~BerkeleyBatch() override
BerkeleyDatabase & m_database
An instance of this class represents one database.
std::shared_ptr< BerkeleyEnvironment > env
Pointer to shared database environment.
void IncrementUpdateCounter() override
void ReloadDbEnv() override
std::unique_ptr< DatabaseBatch > MakeBatch(bool flush_on_close=true) override
Make a BerkeleyBatch connected to this database.
~BerkeleyDatabase() override
bool Rewrite(const char *pszSkip=nullptr) override
Rewrite the entire database on disk, with the exception of key pszSkip if non-zero.
void AddRef() override
Indicate the a new database user has began using the database.
void Flush() override
Make sure all changes are flushed to database file.
void Open() override
Open the database if it is not already opened.
bool PeriodicFlush() override
flush the wallet passively (TRY_LOCK) ideal to be called periodically
void RemoveRef() override
Indicate that database user has stopped using the database and that it could be flushed or closed.
void Close() override
Flush to the database file and close the database.
std::unique_ptr< Db > m_db
Database pointer.
bool Verify(bilingual_str &error)
Verifies the environment and database file.
bool Backup(const std::string &strDest) const override
Back up the entire database to a file.
std::unordered_map< std::string, WalletDatabaseFileId > m_fileids
DbTxn * TxnBegin(int flags=DB_TXN_WRITE_NOSYNC)
fs::path Directory() const
std::map< std::string, std::reference_wrapper< BerkeleyDatabase > > m_databases
bool Open(bilingual_str &error)
std::unique_ptr< DbEnv > dbenv
std::condition_variable_any m_db_in_use
void CheckpointLSN(const std::string &strFile)
void Flush(bool fShutdown)
BerkeleyEnvironment()
Construct an in-memory mock Berkeley environment for testing.
void CloseDb(const std::string &strFile)
Double ended buffer combining vector and stream-like interfaces.
void write(Span< const value_type > src)
std::atomic< unsigned int > nUpdateCounter
std::atomic< int > m_refcount
Counts the number of active database users to be sure that the database is not closed while someone i...
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
void memory_cleanse(void *ptr, size_t len)
Secure overwrite a buffer (possibly containing secret data) with zero-bytes.
static constexpr int CLIENT_VERSION
bitcoind-res.rc includes this file, but it cannot cope with real c++ code.
void UnlockDirectory(const fs::path &directory, const std::string &lockfile_name)
bool TryCreateDirectories(const fs::path &p)
Ignores exceptions thrown by create_directories if the requested directory exists.
std::string HexStr(const Span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
#define LogPrint(category,...)
Filesystem operations and types.
static auto quoted(const std::string &s)
static bool exists(const path &p)
static bool copy_file(const path &from, const path &to, copy_options options)
static std::string PathToString(const path &path)
Convert path object to byte string.
static path PathFromString(const std::string &string)
Convert byte string to path object.
FILE * fopen(const fs::path &p, const char *mode)
std::string get_filesystem_error_message(const fs::filesystem_error &e)
LockResult LockDirectory(const fs::path &directory, const std::string lockfile_name, bool probe_only)
const std::byte * BytePtr(const void *data)
Convert a data pointer to a std::byte data pointer.
bool operator==(const WalletDatabaseFileId &rhs) const
uint8_t value[DB_FILE_ID_LEN]
#define AssertLockNotHeld(cs)
#define TRY_LOCK(cs, name)
int64_t GetTimeMillis()
Returns the system time (not mockable)
void UninterruptibleSleep(const std::chrono::microseconds &n)
bilingual_str _(const char *psz)
Translation function.
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
static const char * filenames[]
void SplitWalletPath(const fs::path &wallet_path, fs::path &env_directory, std::string &database_filename)