Branch data Line data Source code
1 : : // Copyright (c) 2012-present The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <dbwrapper.h>
6 : :
7 : : #include <leveldb/cache.h>
8 : : #include <leveldb/db.h>
9 : : #include <leveldb/env.h>
10 : : #include <leveldb/filter_policy.h>
11 : : #include <leveldb/helpers/memenv/memenv.h>
12 : : #include <leveldb/iterator.h>
13 : : #include <leveldb/options.h>
14 : : #include <leveldb/slice.h>
15 : : #include <leveldb/status.h>
16 : : #include <leveldb/write_batch.h>
17 : : #include <random.h>
18 : : #include <serialize.h>
19 : : #include <span.h>
20 : : #include <streams.h>
21 : : #include <util/byte_units.h>
22 : : #include <util/fs.h>
23 : : #include <util/fs_helpers.h>
24 : : #include <util/log.h>
25 : : #include <util/obfuscation.h>
26 : : #include <util/strencodings.h>
27 : :
28 : : #include <algorithm>
29 : : #include <cassert>
30 : : #include <cstdarg>
31 : : #include <cstdint>
32 : : #include <cstdio>
33 : : #include <memory>
34 : : #include <optional>
35 : : #include <utility>
36 : :
37 : 7207587 : static auto CharCast(const std::byte* data) { return reinterpret_cast<const char*>(data); }
38 : :
39 : 35 : bool DestroyDB(const std::string& path_str)
40 : : {
41 [ - + ]: 35 : return leveldb::DestroyDB(path_str, {}).ok();
42 : : }
43 : :
44 : : /** Handle database error by throwing dbwrapper_error exception.
45 : : */
46 : 45613 : static void HandleError(const leveldb::Status& status)
47 : : {
48 [ + + ]: 45613 : if (status.ok())
49 : 45603 : return;
50 [ + - ]: 10 : const std::string errmsg = "Fatal LevelDB error: " + status.ToString();
51 [ + - ]: 10 : LogError("%s", errmsg);
52 [ + - ]: 10 : LogInfo("You can use -debug=leveldb to get more complete diagnostic messages");
53 [ + - ]: 10 : throw dbwrapper_error(errmsg);
54 : 10 : }
55 : :
56 : 2897 : class CBitcoinLevelDBLogger : public leveldb::Logger {
57 : : public:
58 : : // This code is adapted from posix_logger.h, which is why it is using vsprintf.
59 : : // Please do not do this in normal code
60 : 11976 : void Logv(const char * format, va_list ap) override {
61 [ - + ]: 11976 : if (!util::log::ShouldDebugLog(BCLog::LEVELDB)) {
62 : : return;
63 : : }
64 : : char buffer[500];
65 [ # # ]: 0 : for (int iter = 0; iter < 2; iter++) {
66 : 0 : char* base;
67 : 0 : int bufsize;
68 [ # # ]: 0 : if (iter == 0) {
69 : : bufsize = sizeof(buffer);
70 : : base = buffer;
71 : : }
72 : : else {
73 : 0 : bufsize = 30000;
74 : 0 : base = new char[bufsize];
75 : : }
76 : 0 : char* p = base;
77 : 0 : char* limit = base + bufsize;
78 : :
79 : : // Print the message
80 [ # # ]: 0 : if (p < limit) {
81 : 0 : va_list backup_ap;
82 : 0 : va_copy(backup_ap, ap);
83 : : // Do not use vsnprintf elsewhere in bitcoin source code, see above.
84 : 0 : p += vsnprintf(p, limit - p, format, backup_ap);
85 : 0 : va_end(backup_ap);
86 : : }
87 : :
88 : : // Truncate to available space if necessary
89 [ # # ]: 0 : if (p >= limit) {
90 [ # # ]: 0 : if (iter == 0) {
91 : 0 : continue; // Try again with larger buffer
92 : : }
93 : : else {
94 : 0 : p = limit - 1;
95 : : }
96 : : }
97 : :
98 : : // Add newline if necessary
99 [ # # # # ]: 0 : if (p == base || p[-1] != '\n') {
100 : 0 : *p++ = '\n';
101 : : }
102 : :
103 [ # # ]: 0 : assert(p <= limit);
104 [ # # ]: 0 : base[std::min(bufsize - 1, (int)(p - base))] = '\0';
105 [ # # ]: 0 : LogDebug(BCLog::LEVELDB, "%s\n", util::RemoveSuffixView(base, "\n"));
106 [ # # ]: 0 : if (base != buffer) {
107 [ # # ]: 0 : delete[] base;
108 : : }
109 : : break;
110 : : }
111 : : }
112 : : };
113 : :
114 : 2897 : static void SetMaxOpenFiles(leveldb::Options *options) {
115 : : // On most platforms the default setting of max_open_files (which is 1000)
116 : : // is optimal. On Windows using a large file count is OK because the handles
117 : : // do not interfere with select() loops. On 64-bit Unix hosts this value is
118 : : // also OK, because up to that amount LevelDB will use an mmap
119 : : // implementation that does not use extra file descriptors (the fds are
120 : : // closed after being mmap'ed).
121 : : //
122 : : // Increasing the value beyond the default is dangerous because LevelDB will
123 : : // fall back to a non-mmap implementation when the file count is too large.
124 : : // On 32-bit Unix host we should decrease the value because the handles use
125 : : // up real fds, and we want to avoid fd exhaustion issues.
126 : : //
127 : : // See PR #12495 for further discussion.
128 : :
129 : 2897 : int default_open_files = options->max_open_files;
130 : : #ifndef WIN32
131 : 2897 : if (sizeof(void*) < 8) {
132 : : options->max_open_files = 64;
133 : : }
134 : : #endif
135 [ - + ]: 2897 : LogDebug(BCLog::LEVELDB, "LevelDB using max_open_files=%d (default=%d)\n",
136 : : options->max_open_files, default_open_files);
137 : 2897 : }
138 : :
139 : 2897 : static leveldb::Options GetOptions(size_t nCacheSize)
140 : : {
141 : 2897 : leveldb::Options options;
142 : 2897 : options.block_cache = leveldb::NewLRUCache(nCacheSize / 2);
143 : 2897 : options.write_buffer_size = nCacheSize / 4; // up to two write buffers may be held in memory simultaneously
144 : 2897 : options.filter_policy = leveldb::NewBloomFilterPolicy(10);
145 : 2897 : options.compression = leveldb::kNoCompression;
146 : 2897 : options.info_log = new CBitcoinLevelDBLogger();
147 : 2897 : if (leveldb::kMajorVersion > 1 || (leveldb::kMajorVersion == 1 && leveldb::kMinorVersion >= 16)) {
148 : : // LevelDB versions before 1.16 consider short writes to be corruption. Only trigger error
149 : : // on corruption in later versions.
150 : 2897 : options.paranoid_checks = true;
151 : : }
152 : 2897 : SetMaxOpenFiles(&options);
153 : 2897 : return options;
154 : : }
155 : :
156 [ + - ]: 85290 : struct CDBBatch::WriteBatchImpl {
157 : : leveldb::WriteBatch batch;
158 : : };
159 : :
160 : 42645 : CDBBatch::CDBBatch(const CDBWrapper& _parent)
161 : 42645 : : parent{_parent},
162 : 42645 : m_impl_batch{std::make_unique<CDBBatch::WriteBatchImpl>()}
163 : : {
164 [ + - ]: 42645 : m_key_scratch.reserve(DBWRAPPER_PREALLOC_KEY_SIZE);
165 [ + - ]: 42645 : m_value_scratch.reserve(DBWRAPPER_PREALLOC_VALUE_SIZE);
166 [ + - ]: 42645 : Clear();
167 : 42645 : };
168 : :
169 : 42645 : CDBBatch::~CDBBatch() = default;
170 : :
171 : 42647 : void CDBBatch::Clear()
172 : : {
173 : 42647 : m_impl_batch->batch.Clear();
174 [ - + - + ]: 42647 : assert(m_key_scratch.empty());
175 [ - + - + ]: 42647 : assert(m_value_scratch.empty());
176 : 42647 : }
177 : :
178 : 501911 : void CDBBatch::WriteImpl(std::span<const std::byte> key, DataStream& value)
179 : : {
180 : 501911 : leveldb::Slice slKey(CharCast(key.data()), key.size());
181 [ - + ]: 501911 : dbwrapper_private::GetObfuscation(parent)(value);
182 [ - + ]: 501911 : leveldb::Slice slValue(CharCast(value.data()), value.size());
183 : 501911 : m_impl_batch->batch.Put(slKey, slValue);
184 : 501911 : }
185 : :
186 : 39284 : void CDBBatch::EraseImpl(std::span<const std::byte> key)
187 : : {
188 : 39284 : leveldb::Slice slKey(CharCast(key.data()), key.size());
189 : 39284 : m_impl_batch->batch.Delete(slKey);
190 : 39284 : }
191 : :
192 : 330102 : size_t CDBBatch::ApproximateSize() const
193 : : {
194 : 330102 : return m_impl_batch->batch.ApproximateSize();
195 : : }
196 : :
197 : : struct LevelDBContext {
198 : : //! custom environment this database is using (may be nullptr in case of default environment)
199 : : leveldb::Env* penv;
200 : :
201 : : //! database options used
202 : : leveldb::Options options;
203 : :
204 : : //! options used when reading from the database
205 : : leveldb::ReadOptions readoptions;
206 : :
207 : : //! options used when iterating over values of the database
208 : : leveldb::ReadOptions iteroptions;
209 : :
210 : : //! options used when writing to the database
211 : : leveldb::WriteOptions writeoptions;
212 : :
213 : : //! options used when sync writing to the database
214 : : leveldb::WriteOptions syncoptions;
215 : :
216 : : //! the database itself
217 : : leveldb::DB* pdb;
218 : : };
219 : :
220 : 2897 : CDBWrapper::CDBWrapper(const DBParams& params)
221 [ + - - + ]: 14485 : : m_db_context{std::make_unique<LevelDBContext>()}, m_name{fs::PathToString(params.path.stem())}
222 : : {
223 [ + - ]: 2897 : DBContext().penv = nullptr;
224 [ + - ]: 2897 : DBContext().readoptions.verify_checksums = true;
225 [ + - ]: 2897 : DBContext().iteroptions.verify_checksums = true;
226 [ + - ]: 2897 : DBContext().iteroptions.fill_cache = false;
227 [ + - ]: 2897 : DBContext().syncoptions.sync = true;
228 [ + - + - ]: 2897 : DBContext().options = GetOptions(params.cache_bytes);
229 [ + - ]: 2897 : DBContext().options.create_if_missing = true;
230 [ + - ]: 2897 : DBContext().options.max_file_size = params.max_file_size;
231 [ - + - - ]: 2897 : assert(!(params.testing_env && params.memory_only));
232 [ - + ]: 2897 : if (params.testing_env) {
233 [ # # ]: 0 : DBContext().options.env = params.testing_env;
234 [ + + ]: 2897 : } else if (params.memory_only) {
235 [ + - + - : 332 : DBContext().penv = leveldb::NewMemEnv(leveldb::Env::Default());
+ - ]
236 [ + - + - ]: 332 : DBContext().options.env = DBContext().penv;
237 : : }
238 [ + + ]: 2897 : if (!params.memory_only) {
239 [ + + ]: 2565 : if (params.wipe_data) {
240 [ - + + - ]: 136 : LogInfo("Wiping LevelDB in %s", fs::PathToString(params.path));
241 [ + - - + : 136 : leveldb::Status result = leveldb::DestroyDB(fs::PathToString(params.path), DBContext().options);
+ - ]
242 [ + - ]: 68 : HandleError(result);
243 : 68 : }
244 [ + - ]: 2565 : if (!params.testing_env) {
245 [ + - ]: 2565 : TryCreateDirectories(params.path);
246 : : }
247 [ - + + - ]: 5130 : LogInfo("Opening LevelDB in %s", fs::PathToString(params.path));
248 : : }
249 : : // PathToString() return value is safe to pass to leveldb open function,
250 : : // because on POSIX leveldb passes the byte string directly to ::open(), and
251 : : // on Windows it converts from UTF-8 to UTF-16 before calling ::CreateFileW
252 : : // (see env_posix.cc and env_windows.cc).
253 [ + - - + : 5794 : leveldb::Status status = leveldb::DB::Open(DBContext().options, fs::PathToString(params.path), &DBContext().pdb);
+ - + - ]
254 [ + + ]: 2897 : HandleError(status);
255 [ + - ]: 2888 : LogInfo("Opened LevelDB successfully");
256 : :
257 [ - + ]: 2888 : if (params.options.force_compact) {
258 [ # # # # ]: 0 : LogInfo("Starting database compaction of %s", fs::PathToString(params.path));
259 [ # # # # ]: 0 : DBContext().pdb->CompactRange(nullptr, nullptr);
260 [ # # # # ]: 0 : LogInfo("Finished database compaction of %s", fs::PathToString(params.path));
261 : : }
262 : :
263 [ + + + + : 2888 : if (!Read(OBFUSCATION_KEY, m_obfuscation) && params.obfuscate && IsEmpty()) {
+ + + - +
+ ]
264 : : // Generate and write the new obfuscation key.
265 : 529 : const Obfuscation obfuscation{FastRandomContext{}.randbytes<Obfuscation::KEY_SIZE>()};
266 [ - + ]: 529 : assert(!m_obfuscation); // Make sure the key is written without obfuscation.
267 [ + - ]: 529 : Write(OBFUSCATION_KEY, obfuscation);
268 : 529 : m_obfuscation = obfuscation;
269 [ + - - + : 1058 : LogInfo("Wrote new obfuscation key for %s: %s", fs::PathToString(params.path), m_obfuscation.HexKey());
+ - ]
270 : : }
271 [ + - - + : 5774 : LogInfo("Using obfuscation key for %s: %s", fs::PathToString(params.path), m_obfuscation.HexKey());
+ - - + ]
272 : 2897 : }
273 : :
274 : 2887 : CDBWrapper::~CDBWrapper()
275 : : {
276 [ + - ]: 2887 : delete DBContext().pdb;
277 : 2887 : DBContext().pdb = nullptr;
278 [ + - ]: 2887 : delete DBContext().options.filter_policy;
279 : 2887 : DBContext().options.filter_policy = nullptr;
280 [ + - ]: 2887 : delete DBContext().options.info_log;
281 : 2887 : DBContext().options.info_log = nullptr;
282 [ + - ]: 2887 : delete DBContext().options.block_cache;
283 : 2887 : DBContext().options.block_cache = nullptr;
284 [ + + ]: 2887 : delete DBContext().penv;
285 : 2887 : DBContext().options.env = nullptr;
286 : 2887 : }
287 : :
288 : 42647 : void CDBWrapper::WriteBatch(CDBBatch& batch, bool fSync)
289 : : {
290 : 42647 : const bool log_memory = util::log::ShouldDebugLog(BCLog::LEVELDB);
291 : 42647 : double mem_before = 0;
292 [ - + ]: 42647 : if (log_memory) {
293 : 0 : mem_before = DynamicMemoryUsage() / double(1_MiB);
294 : : }
295 [ + + ]: 42647 : leveldb::Status status = DBContext().pdb->Write(fSync ? DBContext().syncoptions : DBContext().writeoptions, &batch.m_impl_batch->batch);
296 [ + - ]: 42647 : HandleError(status);
297 [ - + ]: 42647 : if (log_memory) {
298 [ # # ]: 0 : double mem_after{DynamicMemoryUsage() / double(1_MiB)};
299 [ - - - - : 42647 : LogDebug(BCLog::LEVELDB, "WriteBatch memory usage: db=%s, before=%.1fMiB, after=%.1fMiB\n",
- - - + ]
300 : : m_name, mem_before, mem_after);
301 : : }
302 : 42647 : }
303 : :
304 : 0 : size_t CDBWrapper::DynamicMemoryUsage() const
305 : : {
306 [ # # ]: 0 : std::string memory;
307 : 0 : std::optional<size_t> parsed;
308 [ # # # # : 0 : if (!DBContext().pdb->GetProperty("leveldb.approximate-memory-usage", &memory) || !(parsed = ToIntegral<size_t>(memory))) {
# # # # ]
309 [ # # # # : 0 : LogDebug(BCLog::LEVELDB, "Failed to get approximate-memory-usage property\n");
# # ]
310 : 0 : return 0;
311 : : }
312 : 0 : return parsed.value();
313 : 0 : }
314 : :
315 : 6158386 : std::optional<std::string> CDBWrapper::ReadImpl(std::span<const std::byte> key) const
316 : : {
317 [ + - ]: 6158386 : leveldb::Slice slKey(CharCast(key.data()), key.size());
318 [ + - ]: 6158386 : std::string strValue;
319 [ + - + - : 6158386 : leveldb::Status status = DBContext().pdb->Get(DBContext().readoptions, slKey, &strValue);
+ - ]
320 [ + + ]: 6158386 : if (!status.ok()) {
321 [ + + ]: 6054210 : if (status.IsNotFound())
322 : 6054209 : return std::nullopt;
323 [ + - + - ]: 1 : LogError("LevelDB read failure: %s", status.ToString());
324 [ - + ]: 1 : HandleError(status);
325 : : }
326 : 104176 : return strValue;
327 : 6158386 : }
328 : :
329 : 1327 : bool CDBWrapper::ExistsImpl(std::span<const std::byte> key) const
330 : : {
331 [ + - ]: 1327 : leveldb::Slice slKey(CharCast(key.data()), key.size());
332 : :
333 [ + - ]: 1327 : std::string strValue;
334 [ + - + - : 1327 : leveldb::Status status = DBContext().pdb->Get(DBContext().readoptions, slKey, &strValue);
+ - ]
335 [ + + ]: 1327 : if (!status.ok()) {
336 [ - + ]: 1314 : if (status.IsNotFound())
337 : : return false;
338 [ # # # # ]: 0 : LogError("LevelDB read failure: %s", status.ToString());
339 [ # # ]: 0 : HandleError(status);
340 : : }
341 : : return true;
342 : 1327 : }
343 : :
344 : 104 : size_t CDBWrapper::EstimateSizeImpl(std::span<const std::byte> key1, std::span<const std::byte> key2) const
345 : : {
346 : 104 : leveldb::Slice slKey1(CharCast(key1.data()), key1.size());
347 : 104 : leveldb::Slice slKey2(CharCast(key2.data()), key2.size());
348 : 104 : uint64_t size = 0;
349 : 104 : leveldb::Range range(slKey1, slKey2);
350 : 104 : DBContext().pdb->GetApproximateSizes(&range, 1, &size);
351 : 104 : return size;
352 : : }
353 : :
354 : 533 : bool CDBWrapper::IsEmpty()
355 : : {
356 [ + - ]: 533 : std::unique_ptr<CDBIterator> it(NewIterator());
357 [ + - ]: 533 : it->SeekToFirst();
358 [ + - ]: 1066 : return !(it->Valid());
359 : 533 : }
360 : :
361 : 5087 : struct CDBIterator::IteratorImpl {
362 : : const std::unique_ptr<leveldb::Iterator> iter;
363 : :
364 : 5087 : explicit IteratorImpl(leveldb::Iterator* _iter) : iter{_iter} {}
365 : : };
366 : :
367 : 5087 : CDBIterator::CDBIterator(const CDBWrapper& _parent, std::unique_ptr<IteratorImpl> _piter) : parent(_parent),
368 [ + - ]: 5087 : m_impl_iter(std::move(_piter))
369 : : {
370 [ + - ]: 5087 : m_scratch.reserve(DBWRAPPER_PREALLOC_KEY_SIZE);
371 : 5087 : }
372 : :
373 : 5087 : CDBIterator* CDBWrapper::NewIterator()
374 : : {
375 [ + - + - : 5087 : return new CDBIterator{*this, std::make_unique<CDBIterator::IteratorImpl>(DBContext().pdb->NewIterator(DBContext().iteroptions))};
+ - + - +
- ]
376 : : }
377 : :
378 : 4560 : void CDBIterator::SeekImpl(std::span<const std::byte> key)
379 : : {
380 : 4560 : leveldb::Slice slKey(CharCast(key.data()), key.size());
381 : 4560 : m_impl_iter->iter->Seek(slKey);
382 : 4560 : }
383 : :
384 : 414494 : std::span<const std::byte> CDBIterator::GetKeyImpl() const
385 : : {
386 : : // The returned span borrows from the current iterator entry and is only
387 : : // valid until the iterator is advanced.
388 : 414494 : return MakeByteSpan(m_impl_iter->iter->key());
389 : : }
390 : :
391 : 413492 : std::span<const std::byte> CDBIterator::GetValueImpl() const
392 : : {
393 : 413492 : return MakeByteSpan(m_impl_iter->iter->value());
394 : : }
395 : :
396 : 5087 : CDBIterator::~CDBIterator() = default;
397 : 418411 : bool CDBIterator::Valid() const { return m_impl_iter->iter->Valid(); }
398 : 533 : void CDBIterator::SeekToFirst() { m_impl_iter->iter->SeekToFirst(); }
399 : 413169 : void CDBIterator::Next() { m_impl_iter->iter->Next(); }
400 : :
401 : : namespace dbwrapper_private {
402 : :
403 : 915417 : const Obfuscation& GetObfuscation(const CDBWrapper& w)
404 : : {
405 : 915417 : return w.m_obfuscation;
406 : : }
407 : :
408 : : } // namespace dbwrapper_private
|
