2016-12-31 18:01:21 +00:00
|
|
|
// Copyright (c) 2012-2016 The Bitcoin Core developers
|
2014-11-04 13:34:04 +00:00
|
|
|
// Distributed under the MIT software license, see the accompanying
|
2012-09-03 17:05:30 +00:00
|
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
|
2015-10-23 01:33:06 +00:00
|
|
|
#include "dbwrapper.h"
|
2013-04-13 05:13:08 +00:00
|
|
|
|
2017-03-01 15:54:22 +00:00
|
|
|
#include "fs.h"
|
2012-09-03 17:05:30 +00:00
|
|
|
#include "util.h"
|
2015-09-07 22:22:23 +00:00
|
|
|
#include "random.h"
|
2012-09-03 17:05:30 +00:00
|
|
|
|
|
|
|
#include <leveldb/cache.h>
|
2013-04-13 05:13:08 +00:00
|
|
|
#include <leveldb/env.h>
|
2012-09-03 17:05:30 +00:00
|
|
|
#include <leveldb/filter_policy.h>
|
2013-09-09 02:02:28 +00:00
|
|
|
#include <memenv.h>
|
2015-09-07 22:22:23 +00:00
|
|
|
#include <stdint.h>
|
2017-03-15 09:43:00 +00:00
|
|
|
#include <algorithm>
|
|
|
|
|
|
|
|
class CBitcoinLevelDBLogger : public leveldb::Logger {
|
|
|
|
public:
|
|
|
|
// This code is adapted from posix_logger.h, which is why it is using vsprintf.
|
|
|
|
// Please do not do this in normal code
|
|
|
|
virtual void Logv(const char * format, va_list ap) override {
|
2016-12-25 20:19:40 +00:00
|
|
|
if (!LogAcceptCategory(BCLog::LEVELDB)) {
|
2017-03-15 09:43:00 +00:00
|
|
|
return;
|
2016-12-25 20:19:40 +00:00
|
|
|
}
|
2017-03-15 09:43:00 +00:00
|
|
|
char buffer[500];
|
|
|
|
for (int iter = 0; iter < 2; iter++) {
|
|
|
|
char* base;
|
|
|
|
int bufsize;
|
|
|
|
if (iter == 0) {
|
|
|
|
bufsize = sizeof(buffer);
|
|
|
|
base = buffer;
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
bufsize = 30000;
|
|
|
|
base = new char[bufsize];
|
|
|
|
}
|
|
|
|
char* p = base;
|
|
|
|
char* limit = base + bufsize;
|
|
|
|
|
|
|
|
// Print the message
|
|
|
|
if (p < limit) {
|
|
|
|
va_list backup_ap;
|
|
|
|
va_copy(backup_ap, ap);
|
|
|
|
// Do not use vsnprintf elsewhere in bitcoin source code, see above.
|
|
|
|
p += vsnprintf(p, limit - p, format, backup_ap);
|
|
|
|
va_end(backup_ap);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Truncate to available space if necessary
|
|
|
|
if (p >= limit) {
|
|
|
|
if (iter == 0) {
|
|
|
|
continue; // Try again with larger buffer
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
p = limit - 1;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Add newline if necessary
|
|
|
|
if (p == base || p[-1] != '\n') {
|
|
|
|
*p++ = '\n';
|
|
|
|
}
|
|
|
|
|
|
|
|
assert(p <= limit);
|
|
|
|
base[std::min(bufsize - 1, (int)(p - base))] = '\0';
|
|
|
|
LogPrintStr(base);
|
|
|
|
if (base != buffer) {
|
|
|
|
delete[] base;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
2012-09-03 17:05:30 +00:00
|
|
|
|
2014-09-19 17:21:46 +00:00
|
|
|
static leveldb::Options GetOptions(size_t nCacheSize)
|
|
|
|
{
|
2012-09-03 17:05:30 +00:00
|
|
|
leveldb::Options options;
|
2012-11-04 16:11:48 +00:00
|
|
|
options.block_cache = leveldb::NewLRUCache(nCacheSize / 2);
|
|
|
|
options.write_buffer_size = nCacheSize / 4; // up to two write buffers may be held in memory simultaneously
|
2012-09-03 17:05:30 +00:00
|
|
|
options.filter_policy = leveldb::NewBloomFilterPolicy(10);
|
|
|
|
options.compression = leveldb::kNoCompression;
|
2013-04-23 22:10:23 +00:00
|
|
|
options.max_open_files = 64;
|
2017-03-15 09:43:00 +00:00
|
|
|
options.info_log = new CBitcoinLevelDBLogger();
|
2014-05-12 10:24:22 +00:00
|
|
|
if (leveldb::kMajorVersion > 1 || (leveldb::kMajorVersion == 1 && leveldb::kMinorVersion >= 16)) {
|
|
|
|
// LevelDB versions before 1.16 consider short writes to be corruption. Only trigger error
|
|
|
|
// on corruption in later versions.
|
|
|
|
options.paranoid_checks = true;
|
|
|
|
}
|
2012-09-03 17:05:30 +00:00
|
|
|
return options;
|
|
|
|
}
|
|
|
|
|
2017-03-01 16:05:50 +00:00
|
|
|
CDBWrapper::CDBWrapper(const fs::path& path, size_t nCacheSize, bool fMemory, bool fWipe, bool obfuscate)
|
2014-09-19 17:21:46 +00:00
|
|
|
{
|
2012-09-03 17:05:30 +00:00
|
|
|
penv = NULL;
|
|
|
|
readoptions.verify_checksums = true;
|
|
|
|
iteroptions.verify_checksums = true;
|
|
|
|
iteroptions.fill_cache = false;
|
|
|
|
syncoptions.sync = true;
|
2012-11-04 16:11:48 +00:00
|
|
|
options = GetOptions(nCacheSize);
|
2012-09-03 17:05:30 +00:00
|
|
|
options.create_if_missing = true;
|
2012-09-04 16:12:00 +00:00
|
|
|
if (fMemory) {
|
|
|
|
penv = leveldb::NewMemEnv(leveldb::Env::Default());
|
|
|
|
options.env = penv;
|
|
|
|
} else {
|
2012-10-21 19:23:13 +00:00
|
|
|
if (fWipe) {
|
2014-01-16 15:15:27 +00:00
|
|
|
LogPrintf("Wiping LevelDB in %s\n", path.string());
|
2015-08-12 23:32:20 +00:00
|
|
|
leveldb::Status result = leveldb::DestroyDB(path.string(), options);
|
2016-04-20 09:48:57 +00:00
|
|
|
dbwrapper_private::HandleError(result);
|
2012-10-21 19:23:13 +00:00
|
|
|
}
|
2017-02-22 09:10:00 +00:00
|
|
|
TryCreateDirectories(path);
|
2014-01-16 15:15:27 +00:00
|
|
|
LogPrintf("Opening LevelDB in %s\n", path.string());
|
2012-09-04 16:12:00 +00:00
|
|
|
}
|
2012-09-03 17:05:30 +00:00
|
|
|
leveldb::Status status = leveldb::DB::Open(options, path.string(), &pdb);
|
2016-04-20 09:48:57 +00:00
|
|
|
dbwrapper_private::HandleError(status);
|
2013-09-18 10:38:08 +00:00
|
|
|
LogPrintf("Opened LevelDB successfully\n");
|
2015-09-07 22:22:23 +00:00
|
|
|
|
|
|
|
// The base-case obfuscation key, which is a noop.
|
|
|
|
obfuscate_key = std::vector<unsigned char>(OBFUSCATE_KEY_NUM_BYTES, '\000');
|
|
|
|
|
|
|
|
bool key_exists = Read(OBFUSCATE_KEY_KEY, obfuscate_key);
|
|
|
|
|
|
|
|
if (!key_exists && obfuscate && IsEmpty()) {
|
2015-10-23 00:49:02 +00:00
|
|
|
// Initialize non-degenerate obfuscation if it won't upset
|
2015-09-07 22:22:23 +00:00
|
|
|
// existing, non-obfuscated data.
|
|
|
|
std::vector<unsigned char> new_key = CreateObfuscateKey();
|
|
|
|
|
|
|
|
// Write `new_key` so we don't obfuscate the key with itself
|
|
|
|
Write(OBFUSCATE_KEY_KEY, new_key);
|
|
|
|
obfuscate_key = new_key;
|
|
|
|
|
2016-04-20 07:08:45 +00:00
|
|
|
LogPrintf("Wrote new obfuscate key for %s: %s\n", path.string(), HexStr(obfuscate_key));
|
2015-09-07 22:22:23 +00:00
|
|
|
}
|
|
|
|
|
2016-04-20 07:08:45 +00:00
|
|
|
LogPrintf("Using obfuscation key for %s: %s\n", path.string(), HexStr(obfuscate_key));
|
2012-09-03 17:05:30 +00:00
|
|
|
}
|
|
|
|
|
2015-10-23 01:02:20 +00:00
|
|
|
CDBWrapper::~CDBWrapper()
|
2014-09-19 17:21:46 +00:00
|
|
|
{
|
2012-09-03 17:05:30 +00:00
|
|
|
delete pdb;
|
|
|
|
pdb = NULL;
|
|
|
|
delete options.filter_policy;
|
|
|
|
options.filter_policy = NULL;
|
2017-03-15 09:43:00 +00:00
|
|
|
delete options.info_log;
|
|
|
|
options.info_log = NULL;
|
2012-09-03 17:05:30 +00:00
|
|
|
delete options.block_cache;
|
|
|
|
options.block_cache = NULL;
|
|
|
|
delete penv;
|
|
|
|
options.env = NULL;
|
|
|
|
}
|
|
|
|
|
2016-04-20 07:05:12 +00:00
|
|
|
bool CDBWrapper::WriteBatch(CDBBatch& batch, bool fSync)
|
2014-09-19 17:21:46 +00:00
|
|
|
{
|
2012-09-03 17:05:30 +00:00
|
|
|
leveldb::Status status = pdb->Write(fSync ? syncoptions : writeoptions, &batch.batch);
|
2016-04-20 09:48:57 +00:00
|
|
|
dbwrapper_private::HandleError(status);
|
2012-09-03 17:05:30 +00:00
|
|
|
return true;
|
|
|
|
}
|
2015-09-07 22:22:23 +00:00
|
|
|
|
|
|
|
// Prefixed with null character to avoid collisions with other keys
|
|
|
|
//
|
|
|
|
// We must use a string constructor which specifies length so that we copy
|
|
|
|
// past the null-terminator.
|
2015-10-23 01:02:20 +00:00
|
|
|
const std::string CDBWrapper::OBFUSCATE_KEY_KEY("\000obfuscate_key", 14);
|
2015-09-07 22:22:23 +00:00
|
|
|
|
2015-10-23 01:02:20 +00:00
|
|
|
const unsigned int CDBWrapper::OBFUSCATE_KEY_NUM_BYTES = 8;
|
2015-09-07 22:22:23 +00:00
|
|
|
|
|
|
|
/**
|
2015-10-23 00:49:02 +00:00
|
|
|
* Returns a string (consisting of 8 random bytes) suitable for use as an
|
|
|
|
* obfuscating XOR key.
|
2015-09-07 22:22:23 +00:00
|
|
|
*/
|
2015-10-23 01:02:20 +00:00
|
|
|
std::vector<unsigned char> CDBWrapper::CreateObfuscateKey() const
|
2015-09-07 22:22:23 +00:00
|
|
|
{
|
|
|
|
unsigned char buff[OBFUSCATE_KEY_NUM_BYTES];
|
|
|
|
GetRandBytes(buff, OBFUSCATE_KEY_NUM_BYTES);
|
|
|
|
return std::vector<unsigned char>(&buff[0], &buff[OBFUSCATE_KEY_NUM_BYTES]);
|
|
|
|
|
|
|
|
}
|
|
|
|
|
2015-10-23 01:02:20 +00:00
|
|
|
bool CDBWrapper::IsEmpty()
|
2015-09-07 22:22:23 +00:00
|
|
|
{
|
2016-08-30 20:41:56 +00:00
|
|
|
std::unique_ptr<CDBIterator> it(NewIterator());
|
2015-09-07 22:22:23 +00:00
|
|
|
it->SeekToFirst();
|
|
|
|
return !(it->Valid());
|
|
|
|
}
|
|
|
|
|
2015-10-23 01:02:20 +00:00
|
|
|
CDBIterator::~CDBIterator() { delete piter; }
|
|
|
|
bool CDBIterator::Valid() { return piter->Valid(); }
|
|
|
|
void CDBIterator::SeekToFirst() { piter->SeekToFirst(); }
|
|
|
|
void CDBIterator::Next() { piter->Next(); }
|
2016-04-20 09:46:01 +00:00
|
|
|
|
|
|
|
namespace dbwrapper_private {
|
|
|
|
|
2016-04-20 09:48:57 +00:00
|
|
|
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");
|
|
|
|
}
|
|
|
|
|
2016-04-20 09:46:01 +00:00
|
|
|
const std::vector<unsigned char>& GetObfuscateKey(const CDBWrapper &w)
|
|
|
|
{
|
|
|
|
return w.obfuscate_key;
|
|
|
|
}
|
|
|
|
|
2017-05-31 20:21:25 +00:00
|
|
|
} // namespace dbwrapper_private
|