diff --git a/src/wallet/bdb.cpp b/src/wallet/bdb.cpp index 255c26ac2372..58488fdbfaa4 100644 --- a/src/wallet/bdb.cpp +++ b/src/wallet/bdb.cpp @@ -709,12 +709,14 @@ void BerkeleyDatabase::ReloadDbEnv() env->ReloadDbEnv(); } -BerkeleyCursor::BerkeleyCursor(BerkeleyDatabase& database) +BerkeleyCursor::BerkeleyCursor(BerkeleyDatabase& database, const BerkeleyBatch& batch) { if (!database.m_db.get()) { throw std::runtime_error(STR_INTERNAL_BUG("BerkeleyDatabase does not exist")); } - int ret = database.m_db->cursor(nullptr, &m_cursor, 0); + // Transaction argument to cursor is only needed when using the cursor to + // write to the database. Read-only cursors do not need a txn pointer. + int ret = database.m_db->cursor(batch.txn(), &m_cursor, 0); if (ret != 0) { throw std::runtime_error(STR_INTERNAL_BUG(strprintf("BDB Cursor could not be created. Returned %d", ret))); } @@ -752,7 +754,7 @@ BerkeleyCursor::~BerkeleyCursor() std::unique_ptr BerkeleyBatch::GetNewCursor() { if (!pdb) return nullptr; - return std::make_unique(m_database); + return std::make_unique(m_database, *this); } bool BerkeleyBatch::TxnBegin() diff --git a/src/wallet/bdb.h b/src/wallet/bdb.h index aa46ca83077e..51b0d7fd7987 100644 --- a/src/wallet/bdb.h +++ b/src/wallet/bdb.h @@ -159,7 +159,7 @@ class BerkeleyCursor : public DatabaseCursor Dbc* m_cursor; public: - explicit BerkeleyCursor(BerkeleyDatabase& database); + explicit BerkeleyCursor(BerkeleyDatabase& database, const BerkeleyBatch& batch); ~BerkeleyCursor() override; Status Next(DataStream& key, DataStream& value) override; diff --git a/src/wallet/scriptpubkeyman.cpp b/src/wallet/scriptpubkeyman.cpp index bdf2d7e341a5..a9b43b349b59 100644 --- a/src/wallet/scriptpubkeyman.cpp +++ b/src/wallet/scriptpubkeyman.cpp @@ -2182,23 +2182,7 @@ bool LegacyScriptPubKeyMan::DeleteRecords() { LOCK(cs_KeyStore); WalletBatch batch(m_storage.GetDatabase()); - // Wrap the legacy-record deletion in a single SQLite transaction. Without - // this, EraseRecords cursor-walks the entire DB and every matching row's - // Erase auto-commits+fsyncs on its own — legacy wallets with thousands of - // KEY/HDPUBKEY/POOL/KEYMETA rows then take minutes instead of milliseconds. - if (!batch.TxnBegin()) { - WalletLogPrintf("DeleteRecords: TxnBegin failed\n"); - return false; - } - if (!batch.EraseRecords(DBKeys::LEGACY_TYPES)) { - batch.TxnAbort(); - return false; - } - if (!batch.TxnCommit()) { - WalletLogPrintf("DeleteRecords: TxnCommit failed\n"); - return false; - } - return true; + return batch.EraseRecords(DBKeys::LEGACY_TYPES); } util::Result DescriptorScriptPubKeyMan::GetNewDestination() diff --git a/src/wallet/test/util.h b/src/wallet/test/util.h index af558e06e49a..52ef7553f7fc 100644 --- a/src/wallet/test/util.h +++ b/src/wallet/test/util.h @@ -29,6 +29,15 @@ struct WalletContext; const std::string ADDRESS_B58T_UNSPENDABLE = "yXXXXXXXXXXXXXXXXXXXXXXXXXXXVd2rXU"; +static const DatabaseFormat DATABASE_FORMATS[] = { +#ifdef USE_SQLITE + DatabaseFormat::SQLITE, +#endif +#ifdef USE_BDB + DatabaseFormat::BERKELEY, +#endif +}; + std::unique_ptr CreateSyncedWallet(interfaces::Chain& chain, ChainstateManager& chainman, const CKey& key); std::shared_ptr TestLoadWallet(WalletContext& context); diff --git a/src/wallet/test/wallet_tests.cpp b/src/wallet/test/wallet_tests.cpp index bd6dac45649f..72be7a3c7f21 100644 --- a/src/wallet/test/wallet_tests.cpp +++ b/src/wallet/test/wallet_tests.cpp @@ -454,15 +454,6 @@ BOOST_AUTO_TEST_CASE(ComputeTimeSmart) BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 5, 50, 600), 300); } -static const DatabaseFormat DATABASE_FORMATS[] = { -#ifdef USE_SQLITE - DatabaseFormat::SQLITE, -#endif -#ifdef USE_BDB - DatabaseFormat::BERKELEY, -#endif -}; - void TestLoadWallet(const std::string& name, DatabaseFormat format, std::function)> f) { DatabaseOptions options; diff --git a/src/wallet/test/walletdb_tests.cpp b/src/wallet/test/walletdb_tests.cpp index e3a710ddf058..94fb2a5ca1b2 100644 --- a/src/wallet/test/walletdb_tests.cpp +++ b/src/wallet/test/walletdb_tests.cpp @@ -9,6 +9,7 @@ #include #include #include +#include #include #include @@ -149,5 +150,31 @@ BOOST_AUTO_TEST_CASE(walletdb_platform_data_corruption_policy) BOOST_CHECK(platform_data.at("platform/intact") == std::vector({0x01, 0x02})); } +BOOST_AUTO_TEST_CASE(walletdb_read_write_deadlock) +{ + // Exercises a db read write operation that shouldn't deadlock. + for (const DatabaseFormat& db_format : DATABASE_FORMATS) { + // Context setup + DatabaseOptions options; + options.require_format = db_format; + DatabaseStatus status; + bilingual_str error_string; + std::unique_ptr db = MakeDatabase(m_path_root / strprintf("wallet_%d_.dat", db_format).c_str(), options, status, error_string); + BOOST_ASSERT(status == DatabaseStatus::SUCCESS); + + std::shared_ptr wallet(new CWallet(m_node.chain.get(), "", std::move(db))); + wallet->m_keypool_size = 4; + + // Create legacy spkm + LOCK(wallet->cs_wallet); + auto legacy_spkm = wallet->GetOrCreateLegacyScriptPubKeyMan(); + BOOST_CHECK(legacy_spkm->CanGenerateKeys() && legacy_spkm->TopUp()); + wallet->Flush(); + + // Now delete all records, which performs a read write operation. + BOOST_CHECK(wallet->GetLegacyScriptPubKeyMan()->DeleteRecords()); + } +} + BOOST_AUTO_TEST_SUITE_END() } // namespace wallet diff --git a/src/wallet/walletdb.cpp b/src/wallet/walletdb.cpp index bc8688d55ec9..4d062fe4643f 100644 --- a/src/wallet/walletdb.cpp +++ b/src/wallet/walletdb.cpp @@ -1248,6 +1248,9 @@ bool WalletBatch::WriteWalletFlags(const uint64_t flags) bool WalletBatch::EraseRecords(const std::unordered_set& types) { + // Begin db txn + if (!m_batch->TxnBegin()) return false; + // Get cursor std::unique_ptr cursor = m_batch->GetNewCursor(); if (!cursor) @@ -1256,8 +1259,7 @@ bool WalletBatch::EraseRecords(const std::unordered_set& types) } // Iterate the DB and look for any records that have the type prefixes - while (true) - { + while (true) { // Read next record DataStream key{}; DataStream value{}; @@ -1265,6 +1267,8 @@ bool WalletBatch::EraseRecords(const std::unordered_set& types) if (status == DatabaseCursor::Status::DONE) { break; } else if (status == DatabaseCursor::Status::FAIL) { + cursor.reset(nullptr); + m_batch->TxnAbort(); // abort db txn return false; } @@ -1275,10 +1279,16 @@ bool WalletBatch::EraseRecords(const std::unordered_set& types) key >> type; if (types.count(type) > 0) { - m_batch->Erase(key_data); + if (!m_batch->Erase(key_data)) { + cursor.reset(nullptr); + m_batch->TxnAbort(); + return false; // erase failed + } } } - return true; + // Finish db txn + cursor.reset(nullptr); + return m_batch->TxnCommit(); } bool WalletBatch::TxnBegin()