neobytes-project/neobytes
neobytes-project/neobytes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Merge #7927: Minor changes to dbwrapper to simplify support for other databases

Browse Source 
869cf12 dbwrapper: Move `HandleError` to `dbwrapper_private` (Wladimir J. van der Laan)
b69836d dbwrapper: Pass parent CDBWrapper into CDBBatch and CDBIterator (Wladimir J. van der Laan)
878bf48 dbwrapper: Remove CDBWrapper::GetObfuscateKeyHex (Wladimir J. van der Laan)
74f7b12 dbwrapper: Remove throw keywords in function signatures (Wladimir J. van der Laan)
This commit is contained in:
Wladimir J. van der Laan 2016-04-25 12:44:58 +02:00 committed by Alexander Block
parent 17f2ea5d73
commit 2e54bd2e8c
4 changed files with 80 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
src/dbwrapper.cpp
View File

@ -15,20 +15,6 @@
#include <memenv.h> #include <memenv.h>
#include <stdint.h> #include <stdint.h>
void HandleError(const leveldb::Status& status) throw(dbwrapper_error)
{
if (status.ok())
return;
LogPrintf("%s\n", status.ToString());
if (status.IsCorruption())
throw dbwrapper_error("Database corrupted");
if (status.IsIOError())
throw dbwrapper_error("Database I/O error");
if (status.IsNotFound())
throw dbwrapper_error("Database entry missing");
throw dbwrapper_error("Unknown database error");
}
static leveldb::Options GetOptions(size_t nCacheSize) static leveldb::Options GetOptions(size_t nCacheSize)
{ {
leveldb::Options options; leveldb::Options options;
@ -61,13 +47,13 @@ CDBWrapper::CDBWrapper(const boost::filesystem::path& path, size_t nCacheSize, b
if (fWipe) { if (fWipe) {
LogPrintf("Wiping LevelDB in %s\n", path.string()); LogPrintf("Wiping LevelDB in %s\n", path.string());
leveldb::Status result = leveldb::DestroyDB(path.string(), options); leveldb::Status result = leveldb::DestroyDB(path.string(), options);
HandleError(result); dbwrapper_private::HandleError(result);
} }
TryCreateDirectory(path); TryCreateDirectory(path);
LogPrintf("Opening LevelDB in %s\n", path.string()); LogPrintf("Opening LevelDB in %s\n", path.string());
} }
leveldb::Status status = leveldb::DB::Open(options, path.string(), &pdb); leveldb::Status status = leveldb::DB::Open(options, path.string(), &pdb);
HandleError(status); dbwrapper_private::HandleError(status);
LogPrintf("Opened LevelDB successfully\n"); LogPrintf("Opened LevelDB successfully\n");
// The base-case obfuscation key, which is a noop. // The base-case obfuscation key, which is a noop.
@ -84,10 +70,10 @@ CDBWrapper::CDBWrapper(const boost::filesystem::path& path, size_t nCacheSize, b
Write(OBFUSCATE_KEY_KEY, new_key); Write(OBFUSCATE_KEY_KEY, new_key);
obfuscate_key = new_key; obfuscate_key = new_key;
LogPrintf("Wrote new obfuscate key for %s: %s\n", path.string(), GetObfuscateKeyHex()); LogPrintf("Wrote new obfuscate key for %s: %s\n", path.string(), HexStr(obfuscate_key));
} }
LogPrintf("Using obfuscation key for %s: %s\n", path.string(), GetObfuscateKeyHex()); LogPrintf("Using obfuscation key for %s: %s\n", path.string(), HexStr(obfuscate_key));
} }
CDBWrapper::~CDBWrapper() CDBWrapper::~CDBWrapper()
@ -102,10 +88,10 @@ CDBWrapper::~CDBWrapper()
options.env = NULL; options.env = NULL;
} }
bool CDBWrapper::WriteBatch(CDBBatch& batch, bool fSync) throw(dbwrapper_error) bool CDBWrapper::WriteBatch(CDBBatch& batch, bool fSync)
{ {
leveldb::Status status = pdb->Write(fSync ? syncoptions : writeoptions, &batch.batch); leveldb::Status status = pdb->Write(fSync ? syncoptions : writeoptions, &batch.batch);
HandleError(status); dbwrapper_private::HandleError(status);
return true; return true;
} }
@ -136,17 +122,30 @@ bool CDBWrapper::IsEmpty()
return !(it->Valid()); return !(it->Valid());
} }
const std::vector<unsigned char>& CDBWrapper::GetObfuscateKey() const
{
return obfuscate_key;
}
std::string CDBWrapper::GetObfuscateKeyHex() const
{
return HexStr(obfuscate_key);
}
CDBIterator::~CDBIterator() { delete piter; } CDBIterator::~CDBIterator() { delete piter; }
bool CDBIterator::Valid() { return piter->Valid(); } bool CDBIterator::Valid() { return piter->Valid(); }
void CDBIterator::SeekToFirst() { piter->SeekToFirst(); } void CDBIterator::SeekToFirst() { piter->SeekToFirst(); }
void CDBIterator::Next() { piter->Next(); } void CDBIterator::Next() { piter->Next(); }
namespace dbwrapper_private {
void HandleError(const leveldb::Status& status)
{
if (status.ok())
return;
LogPrintf("%s\n", status.ToString());
if (status.IsCorruption())
throw dbwrapper_error("Database corrupted");
if (status.IsIOError())
throw dbwrapper_error("Database I/O error");
if (status.IsNotFound())
throw dbwrapper_error("Database entry missing");
throw dbwrapper_error("Unknown database error");
}
const std::vector<unsigned char>& GetObfuscateKey(const CDBWrapper &w)
{
return w.obfuscate_key;
}
};

72
src/dbwrapper.h
View File

@ -23,7 +23,23 @@ public:
dbwrapper_error(const std::string& msg) : std::runtime_error(msg) {} dbwrapper_error(const std::string& msg) : std::runtime_error(msg) {}
}; };
void HandleError(const leveldb::Status& status) throw(dbwrapper_error); class CDBWrapper;
/** These should be considered an implementation detail of the specific database.
*/
namespace dbwrapper_private {
/** Handle database error by throwing dbwrapper_error exception.
*/
void HandleError(const leveldb::Status& status);
/** Work around circular dependency, as well as for testing in dbwrapper_tests.
* Database obfuscation should be considered an implementation detail of the
* specific database.
*/
const std::vector<unsigned char>& GetObfuscateKey(const CDBWrapper &w);
};
/** Batch of changes queued to be written to a CDBWrapper */ /** Batch of changes queued to be written to a CDBWrapper */
class CDBBatch class CDBBatch
@ -31,14 +47,14 @@ class CDBBatch
friend class CDBWrapper; friend class CDBWrapper;
private: private:
const CDBWrapper &parent;
leveldb::WriteBatch batch; leveldb::WriteBatch batch;
const std::vector<unsigned char> *obfuscate_key;
public: public:
/** /**
* @param[in] obfuscate_key If passed, XOR data with this key. * @param[in] parent CDBWrapper that this batch is to be submitted to
*/ */
CDBBatch(const std::vector<unsigned char> *obfuscate_key) : obfuscate_key(obfuscate_key) { }; CDBBatch(const CDBWrapper &parent) : parent(parent) { };
template <typename K, typename V> template <typename K, typename V>
void Write(const K& key, const V& value) void Write(const K& key, const V& value)
@ -51,7 +67,7 @@ public:
CDataStream ssValue(SER_DISK, CLIENT_VERSION); CDataStream ssValue(SER_DISK, CLIENT_VERSION);
ssValue.reserve(ssValue.GetSerializeSize(value)); ssValue.reserve(ssValue.GetSerializeSize(value));
ssValue << value; ssValue << value;
ssValue.Xor(*obfuscate_key); ssValue.Xor(dbwrapper_private::GetObfuscateKey(parent));
leveldb::Slice slValue(&ssValue[0], ssValue.size()); leveldb::Slice slValue(&ssValue[0], ssValue.size());
batch.Put(slKey, slValue); batch.Put(slKey, slValue);
@ -72,17 +88,17 @@ public:
class CDBIterator class CDBIterator
{ {
private: private:
const CDBWrapper &parent;
leveldb::Iterator *piter; leveldb::Iterator *piter;
const std::vector<unsigned char> *obfuscate_key;
public: public:
/** /**
* @param[in] parent Parent CDBWrapper instance.
* @param[in] piterIn The original leveldb iterator. * @param[in] piterIn The original leveldb iterator.
* @param[in] obfuscate_key If passed, XOR data with this key.
*/ */
CDBIterator(leveldb::Iterator *piterIn, const std::vector<unsigned char>* obfuscate_key) : CDBIterator(const CDBWrapper &parent, leveldb::Iterator *piterIn) :
piter(piterIn), obfuscate_key(obfuscate_key) { }; parent(parent), piter(piterIn) { };
~CDBIterator(); ~CDBIterator();
bool Valid(); bool Valid();
@ -118,7 +134,7 @@ public:
leveldb::Slice slValue = piter->value(); leveldb::Slice slValue = piter->value();
try { try {
CDataStream ssValue(slValue.data(), slValue.data() + slValue.size(), SER_DISK, CLIENT_VERSION); CDataStream ssValue(slValue.data(), slValue.data() + slValue.size(), SER_DISK, CLIENT_VERSION);
ssValue.Xor(*obfuscate_key); ssValue.Xor(dbwrapper_private::GetObfuscateKey(parent));
ssValue >> value; ssValue >> value;
} catch (const std::exception&) { } catch (const std::exception&) {
return false; return false;
@ -134,6 +150,7 @@ public:
class CDBWrapper class CDBWrapper
{ {
friend const std::vector<unsigned char>& dbwrapper_private::GetObfuscateKey(const CDBWrapper &w);
private: private:
//! custom environment this database is using (may be NULL in case of default environment) //! custom environment this database is using (may be NULL in case of default environment)
leveldb::Env* penv; leveldb::Env* penv;
@ -180,7 +197,7 @@ public:
~CDBWrapper(); ~CDBWrapper();
template <typename K, typename V> template <typename K, typename V>
bool Read(const K& key, V& value) const throw(dbwrapper_error) bool Read(const K& key, V& value) const
{ {
CDataStream ssKey(SER_DISK, CLIENT_VERSION); CDataStream ssKey(SER_DISK, CLIENT_VERSION);
ssKey.reserve(ssKey.GetSerializeSize(key)); ssKey.reserve(ssKey.GetSerializeSize(key));
@ -193,7 +210,7 @@ public:
if (status.IsNotFound()) if (status.IsNotFound())
return false; return false;
LogPrintf("LevelDB read failure: %s\n", status.ToString()); LogPrintf("LevelDB read failure: %s\n", status.ToString());
HandleError(status); dbwrapper_private::HandleError(status);
} }
try { try {
CDataStream ssValue(strValue.data(), strValue.data() + strValue.size(), SER_DISK, CLIENT_VERSION); CDataStream ssValue(strValue.data(), strValue.data() + strValue.size(), SER_DISK, CLIENT_VERSION);
@ -206,15 +223,15 @@ public:
} }
template <typename K, typename V> template <typename K, typename V>
bool Write(const K& key, const V& value, bool fSync = false) throw(dbwrapper_error) bool Write(const K& key, const V& value, bool fSync = false)
{ {
CDBBatch batch(&obfuscate_key); CDBBatch batch(*this);
batch.Write(key, value); batch.Write(key, value);
return WriteBatch(batch, fSync); return WriteBatch(batch, fSync);
} }
template <typename K> template <typename K>
bool Exists(const K& key) const throw(dbwrapper_error) bool Exists(const K& key) const
{ {
CDataStream ssKey(SER_DISK, CLIENT_VERSION); CDataStream ssKey(SER_DISK, CLIENT_VERSION);
ssKey.reserve(ssKey.GetSerializeSize(key)); ssKey.reserve(ssKey.GetSerializeSize(key));
@ -227,20 +244,20 @@ public:
if (status.IsNotFound()) if (status.IsNotFound())
return false; return false;
LogPrintf("LevelDB read failure: %s\n", status.ToString()); LogPrintf("LevelDB read failure: %s\n", status.ToString());
HandleError(status); dbwrapper_private::HandleError(status);
} }
return true; return true;
} }
template <typename K> template <typename K>
bool Erase(const K& key, bool fSync = false) throw(dbwrapper_error) bool Erase(const K& key, bool fSync = false)
{ {
CDBBatch batch(&obfuscate_key); CDBBatch batch(*this);
batch.Erase(key); batch.Erase(key);
return WriteBatch(batch, fSync); return WriteBatch(batch, fSync);
} }
bool WriteBatch(CDBBatch& batch, bool fSync = false) throw(dbwrapper_error); bool WriteBatch(CDBBatch& batch, bool fSync = false);
// not available for LevelDB; provide for compatibility with BDB // not available for LevelDB; provide for compatibility with BDB
bool Flush() bool Flush()
@ -248,32 +265,21 @@ public:
return true; return true;
} }
bool Sync() throw(dbwrapper_error) bool Sync()
{ {
CDBBatch batch(&obfuscate_key); CDBBatch batch(*this);
return WriteBatch(batch, true); return WriteBatch(batch, true);
} }
CDBIterator *NewIterator() CDBIterator *NewIterator()
{ {
return new CDBIterator(pdb->NewIterator(iteroptions), &obfuscate_key); return new CDBIterator(*this, pdb->NewIterator(iteroptions));
} }
/** /**
* Return true if the database managed by this class contains no entries. * Return true if the database managed by this class contains no entries.
*/ */
bool IsEmpty(); bool IsEmpty();
/**
* Accessor for obfuscate_key.
*/
const std::vector<unsigned char>& GetObfuscateKey() const;
/**
* Return the obfuscate_key as a hex-formatted string.
*/
std::string GetObfuscateKeyHex() const;
}; };
#endif // BITCOIN_DBWRAPPER_H #endif // BITCOIN_DBWRAPPER_H

8
src/test/dbwrapper_tests.cpp
View File

@ -39,7 +39,7 @@ BOOST_AUTO_TEST_CASE(dbwrapper)
uint256 res; uint256 res;
// Ensure that we're doing real obfuscation when obfuscate=true // Ensure that we're doing real obfuscation when obfuscate=true
BOOST_CHECK(obfuscate != is_null_key(dbw.GetObfuscateKey())); BOOST_CHECK(obfuscate != is_null_key(dbwrapper_private::GetObfuscateKey(dbw)));
BOOST_CHECK(dbw.Write(key, in)); BOOST_CHECK(dbw.Write(key, in));
BOOST_CHECK(dbw.Read(key, res)); BOOST_CHECK(dbw.Read(key, res));
@ -64,7 +64,7 @@ BOOST_AUTO_TEST_CASE(dbwrapper_batch)
uint256 in3 = GetRandHash(); uint256 in3 = GetRandHash();
uint256 res; uint256 res;
CDBBatch batch(&dbw.GetObfuscateKey()); CDBBatch batch(dbw);
batch.Write(key, in); batch.Write(key, in);
batch.Write(key2, in2); batch.Write(key2, in2);
@ -156,7 +156,7 @@ BOOST_AUTO_TEST_CASE(existing_data_no_obfuscate)
BOOST_CHECK_EQUAL(res2.ToString(), in.ToString()); BOOST_CHECK_EQUAL(res2.ToString(), in.ToString());
BOOST_CHECK(!odbw.IsEmpty()); // There should be existing data BOOST_CHECK(!odbw.IsEmpty()); // There should be existing data
BOOST_CHECK(is_null_key(odbw.GetObfuscateKey())); // The key should be an empty string BOOST_CHECK(is_null_key(dbwrapper_private::GetObfuscateKey(odbw))); // The key should be an empty string
uint256 in2 = GetRandHash(); uint256 in2 = GetRandHash();
uint256 res3; uint256 res3;
@ -193,7 +193,7 @@ BOOST_AUTO_TEST_CASE(existing_data_reindex)
// Check that the key/val we wrote with unobfuscated wrapper doesn't exist // Check that the key/val we wrote with unobfuscated wrapper doesn't exist
uint256 res2; uint256 res2;
BOOST_CHECK(!odbw.Read(key, res2)); BOOST_CHECK(!odbw.Read(key, res2));
BOOST_CHECK(!is_null_key(odbw.GetObfuscateKey())); BOOST_CHECK(!is_null_key(dbwrapper_private::GetObfuscateKey(odbw)));
uint256 in2 = GetRandHash(); uint256 in2 = GetRandHash();
uint256 res3; uint256 res3;

16
src/txdb.cpp
View File

@ -53,7 +53,7 @@ uint256 CCoinsViewDB::GetBestBlock() const {
} }
bool CCoinsViewDB::BatchWrite(CCoinsMap &mapCoins, const uint256 &hashBlock) { bool CCoinsViewDB::BatchWrite(CCoinsMap &mapCoins, const uint256 &hashBlock) {
CDBBatch batch(&db.GetObfuscateKey()); CDBBatch batch(db);
size_t count = 0; size_t count = 0;
size_t changed = 0; size_t changed = 0;
for (CCoinsMap::iterator it = mapCoins.begin(); it != mapCoins.end();) { for (CCoinsMap::iterator it = mapCoins.begin(); it != mapCoins.end();) {
@ -143,7 +143,7 @@ void CCoinsViewDBCursor::Next()
} }
bool CBlockTreeDB::WriteBatchSync(const std::vector<std::pair<int, const CBlockFileInfo*> >& fileInfo, int nLastFile, const std::vector<const CBlockIndex*>& blockinfo) { bool CBlockTreeDB::WriteBatchSync(const std::vector<std::pair<int, const CBlockFileInfo*> >& fileInfo, int nLastFile, const std::vector<const CBlockIndex*>& blockinfo) {
CDBBatch batch(&GetObfuscateKey()); CDBBatch batch(*this);
for (std::vector<std::pair<int, const CBlockFileInfo*> >::const_iterator it=fileInfo.begin(); it != fileInfo.end(); it++) { for (std::vector<std::pair<int, const CBlockFileInfo*> >::const_iterator it=fileInfo.begin(); it != fileInfo.end(); it++) {
batch.Write(make_pair(DB_BLOCK_FILES, it->first), *it->second); batch.Write(make_pair(DB_BLOCK_FILES, it->first), *it->second);
} }
@ -159,7 +159,7 @@ bool CBlockTreeDB::ReadTxIndex(const uint256 &txid, CDiskTxPos &pos) {
} }
bool CBlockTreeDB::WriteTxIndex(const std::vector<std::pair<uint256, CDiskTxPos> >&vect) { bool CBlockTreeDB::WriteTxIndex(const std::vector<std::pair<uint256, CDiskTxPos> >&vect) {
CDBBatch batch(&GetObfuscateKey()); CDBBatch batch(*this);
for (std::vector<std::pair<uint256,CDiskTxPos> >::const_iterator it=vect.begin(); it!=vect.end(); it++) for (std::vector<std::pair<uint256,CDiskTxPos> >::const_iterator it=vect.begin(); it!=vect.end(); it++)
batch.Write(make_pair(DB_TXINDEX, it->first), it->second); batch.Write(make_pair(DB_TXINDEX, it->first), it->second);
return WriteBatch(batch); return WriteBatch(batch);
@ -170,7 +170,7 @@ bool CBlockTreeDB::ReadSpentIndex(CSpentIndexKey &key, CSpentIndexValue &value)
} }
bool CBlockTreeDB::UpdateSpentIndex(const std::vector<std::pair<CSpentIndexKey, CSpentIndexValue> >&vect) { bool CBlockTreeDB::UpdateSpentIndex(const std::vector<std::pair<CSpentIndexKey, CSpentIndexValue> >&vect) {
CDBBatch batch(&GetObfuscateKey()); CDBBatch batch(*this);
for (std::vector<std::pair<CSpentIndexKey,CSpentIndexValue> >::const_iterator it=vect.begin(); it!=vect.end(); it++) { for (std::vector<std::pair<CSpentIndexKey,CSpentIndexValue> >::const_iterator it=vect.begin(); it!=vect.end(); it++) {
if (it->second.IsNull()) { if (it->second.IsNull()) {
batch.Erase(make_pair(DB_SPENTINDEX, it->first)); batch.Erase(make_pair(DB_SPENTINDEX, it->first));
@ -182,7 +182,7 @@ bool CBlockTreeDB::UpdateSpentIndex(const std::vector<std::pair<CSpentIndexKey,
} }
bool CBlockTreeDB::UpdateAddressUnspentIndex(const std::vector<std::pair<CAddressUnspentKey, CAddressUnspentValue > >&vect) { bool CBlockTreeDB::UpdateAddressUnspentIndex(const std::vector<std::pair<CAddressUnspentKey, CAddressUnspentValue > >&vect) {
CDBBatch batch(&GetObfuscateKey()); CDBBatch batch(*this);
for (std::vector<std::pair<CAddressUnspentKey, CAddressUnspentValue> >::const_iterator it=vect.begin(); it!=vect.end(); it++) { for (std::vector<std::pair<CAddressUnspentKey, CAddressUnspentValue> >::const_iterator it=vect.begin(); it!=vect.end(); it++) {
if (it->second.IsNull()) { if (it->second.IsNull()) {
batch.Erase(make_pair(DB_ADDRESSUNSPENTINDEX, it->first)); batch.Erase(make_pair(DB_ADDRESSUNSPENTINDEX, it->first));
@ -220,14 +220,14 @@ bool CBlockTreeDB::ReadAddressUnspentIndex(uint160 addressHash, int type,
} }
bool CBlockTreeDB::WriteAddressIndex(const std::vector<std::pair<CAddressIndexKey, CAmount > >&vect) { bool CBlockTreeDB::WriteAddressIndex(const std::vector<std::pair<CAddressIndexKey, CAmount > >&vect) {
CDBBatch batch(&GetObfuscateKey()); CDBBatch batch(*this);
for (std::vector<std::pair<CAddressIndexKey, CAmount> >::const_iterator it=vect.begin(); it!=vect.end(); it++) for (std::vector<std::pair<CAddressIndexKey, CAmount> >::const_iterator it=vect.begin(); it!=vect.end(); it++)
batch.Write(make_pair(DB_ADDRESSINDEX, it->first), it->second); batch.Write(make_pair(DB_ADDRESSINDEX, it->first), it->second);
return WriteBatch(batch); return WriteBatch(batch);
} }
bool CBlockTreeDB::EraseAddressIndex(const std::vector<std::pair<CAddressIndexKey, CAmount > >&vect) { bool CBlockTreeDB::EraseAddressIndex(const std::vector<std::pair<CAddressIndexKey, CAmount > >&vect) {
CDBBatch batch(&GetObfuscateKey()); CDBBatch batch(*this);
for (std::vector<std::pair<CAddressIndexKey, CAmount> >::const_iterator it=vect.begin(); it!=vect.end(); it++) for (std::vector<std::pair<CAddressIndexKey, CAmount> >::const_iterator it=vect.begin(); it!=vect.end(); it++)
batch.Erase(make_pair(DB_ADDRESSINDEX, it->first)); batch.Erase(make_pair(DB_ADDRESSINDEX, it->first));
return WriteBatch(batch); return WriteBatch(batch);
@ -268,7 +268,7 @@ bool CBlockTreeDB::ReadAddressIndex(uint160 addressHash, int type,
} }
bool CBlockTreeDB::WriteTimestampIndex(const CTimestampIndexKey &timestampIndex) { bool CBlockTreeDB::WriteTimestampIndex(const CTimestampIndexKey &timestampIndex) {
CDBBatch batch(&GetObfuscateKey()); CDBBatch batch(*this);
batch.Write(make_pair(DB_TIMESTAMPINDEX, timestampIndex), 0); batch.Write(make_pair(DB_TIMESTAMPINDEX, timestampIndex), 0);
return WriteBatch(batch); return WriteBatch(batch);
} }