READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

48,885 bytes · SHA-256 b8e1157faebfb845… · View upstream ↗

1// Copyright (c) 2011 The LevelDB Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file. See the AUTHORS file for names of contributors.
4
5#include "db/db_impl.h"
6
7#include <stdint.h>
8#include <stdio.h>
9
10#include <algorithm>
11#include <atomic>
12#include <set>
13#include <string>
14#include <vector>
15
16#include "db/builder.h"
17#include "db/db_iter.h"
18#include "db/dbformat.h"
19#include "db/filename.h"
20#include "db/log_reader.h"
21#include "db/log_writer.h"
22#include "db/memtable.h"
23#include "db/table_cache.h"
24#include "db/version_set.h"
25#include "db/write_batch_internal.h"
26#include "leveldb/db.h"
27#include "leveldb/env.h"
28#include "leveldb/status.h"
29#include "leveldb/table.h"
30#include "leveldb/table_builder.h"
31#include "port/port.h"
32#include "table/block.h"
33#include "table/merger.h"
34#include "table/two_level_iterator.h"
35#include "util/coding.h"
36#include "util/logging.h"
37#include "util/mutexlock.h"
38
39namespace leveldb {
40
41const int kNumNonTableCacheFiles = 10;
42
43// Information kept for every waiting writer
44struct DBImpl::Writer {
45  explicit Writer(port::Mutex* mu)
46      : batch(nullptr), sync(false), done(false), cv(mu) {}
47
48  Status status;
49  WriteBatch* batch;
50  bool sync;
51  bool done;
52  port::CondVar cv;
53};
54
55struct DBImpl::CompactionState {
56  // Files produced by compaction
57  struct Output {
58    uint64_t number;
59    uint64_t file_size;
60    InternalKey smallest, largest;
61  };
62
63  Output* current_output() { return &outputs[outputs.size() - 1]; }
64
65  explicit CompactionState(Compaction* c)
66      : compaction(c),
67        smallest_snapshot(0),
68        outfile(nullptr),
69        builder(nullptr),
70        total_bytes(0) {}
71
72  Compaction* const compaction;
73
74  // Sequence numbers < smallest_snapshot are not significant since we
75  // will never have to service a snapshot below smallest_snapshot.
76  // Therefore if we have seen a sequence number S <= smallest_snapshot,
77  // we can drop all entries for the same key with sequence numbers < S.
78  SequenceNumber smallest_snapshot;
79
80  std::vector<Output> outputs;
81
82  // State kept for output being generated
83  WritableFile* outfile;
84  TableBuilder* builder;
85
86  uint64_t total_bytes;
87};
88
89// Fix user-supplied options to be reasonable
90template <class T, class V>
91static void ClipToRange(T* ptr, V minvalue, V maxvalue) {
92  if (static_cast<V>(*ptr) > maxvalue) *ptr = maxvalue;
93  if (static_cast<V>(*ptr) < minvalue) *ptr = minvalue;
94}
95Options SanitizeOptions(const std::string& dbname,
96                        const InternalKeyComparator* icmp,
97                        const InternalFilterPolicy* ipolicy,
98                        const Options& src) {
99  Options result = src;
100  result.comparator = icmp;
101  result.filter_policy = (src.filter_policy != nullptr) ? ipolicy : nullptr;
102  ClipToRange(&result.max_open_files, 64 + kNumNonTableCacheFiles, 50000);
103  ClipToRange(&result.write_buffer_size, 64 << 10, 1 << 30);
104  ClipToRange(&result.max_file_size, 1 << 20, 1 << 30);
105  ClipToRange(&result.block_size, 1 << 10, 4 << 20);
106  if (result.info_log == nullptr) {
107    // Open a log file in the same directory as the db
108    src.env->CreateDir(dbname);  // In case it does not exist
109    src.env->RenameFile(InfoLogFileName(dbname), OldInfoLogFileName(dbname));
110    Status s = src.env->NewLogger(InfoLogFileName(dbname), &result.info_log);
111    if (!s.ok()) {
112      // No place suitable for logging
113      result.info_log = nullptr;
114    }
115  }
116  if (result.block_cache == nullptr) {
117    result.block_cache = NewLRUCache(8 << 20);
118  }
119  return result;
120}
121
122static int TableCacheSize(const Options& sanitized_options) {
123  // Reserve ten files or so for other uses and give the rest to TableCache.
124  return sanitized_options.max_open_files - kNumNonTableCacheFiles;
125}
126
127DBImpl::DBImpl(const Options& raw_options, const std::string& dbname)
128    : env_(raw_options.env),
129      internal_comparator_(raw_options.comparator),
130      internal_filter_policy_(raw_options.filter_policy),
131      options_(SanitizeOptions(dbname, &internal_comparator_,
132                               &internal_filter_policy_, raw_options)),
133      owns_info_log_(options_.info_log != raw_options.info_log),
134      owns_cache_(options_.block_cache != raw_options.block_cache),
135      dbname_(dbname),
136      table_cache_(new TableCache(dbname_, options_, TableCacheSize(options_))),
137      db_lock_(nullptr),
138      shutting_down_(false),
139      background_work_finished_signal_(&mutex_),
140      mem_(nullptr),
141      imm_(nullptr),
142      has_imm_(false),
143      logfile_(nullptr),
144      logfile_number_(0),
145      log_(nullptr),
146      seed_(0),
147      tmp_batch_(new WriteBatch),
148      background_compaction_scheduled_(false),
149      manual_compaction_(nullptr),
150      versions_(new VersionSet(dbname_, &options_, table_cache_,
151                               &internal_comparator_)) {}
152
153DBImpl::~DBImpl() {
154  // Wait for background work to finish.
155  mutex_.Lock();
156  shutting_down_.store(true, std::memory_order_release);
157  while (background_compaction_scheduled_) {
158    background_work_finished_signal_.Wait();
159  }
160  mutex_.Unlock();
161
162  if (db_lock_ != nullptr) {
163    env_->UnlockFile(db_lock_);
164  }
165
166  delete versions_;
167  if (mem_ != nullptr) mem_->Unref();
168  if (imm_ != nullptr) imm_->Unref();
169  delete tmp_batch_;
170  delete log_;
171  delete logfile_;
172  delete table_cache_;
173
174  if (owns_info_log_) {
175    delete options_.info_log;
176  }
177  if (owns_cache_) {
178    delete options_.block_cache;
179  }
180}
181
182Status DBImpl::NewDB() {
183  VersionEdit new_db;
184  new_db.SetComparatorName(user_comparator()->Name());
185  new_db.SetLogNumber(0);
186  new_db.SetNextFile(2);
187  new_db.SetLastSequence(0);
188
189  const std::string manifest = DescriptorFileName(dbname_, 1);
190  WritableFile* file;
191  Status s = env_->NewWritableFile(manifest, &file);
192  if (!s.ok()) {
193    return s;
194  }
195  {
196    log::Writer log(file);
197    std::string record;
198    new_db.EncodeTo(&record);
199    s = log.AddRecord(record);
200    if (s.ok()) {
201      s = file->Close();
202    }
203  }
204  delete file;
205  if (s.ok()) {
206    // Make "CURRENT" file that points to the new manifest file.
207    s = SetCurrentFile(env_, dbname_, 1);
208  } else {
209    env_->DeleteFile(manifest);
210  }
211  return s;
212}
213
214void DBImpl::MaybeIgnoreError(Status* s) const {
215  if (s->ok() || options_.paranoid_checks) {
216    // No change needed
217  } else {
218    Log(options_.info_log, "Ignoring error %s", s->ToString().c_str());
219    *s = Status::OK();
220  }
221}
222
223void DBImpl::DeleteObsoleteFiles() {
224  mutex_.AssertHeld();
225
226  if (!bg_error_.ok()) {
227    // After a background error, we don't know whether a new version may
228    // or may not have been committed, so we cannot safely garbage collect.
229    return;
230  }
231
232  // Make a set of all of the live files
233  std::set<uint64_t> live = pending_outputs_;
234  versions_->AddLiveFiles(&live);
235
236  std::vector<std::string> filenames;
237  env_->GetChildren(dbname_, &filenames);  // Ignoring errors on purpose
238  uint64_t number;
239  FileType type;
240  std::vector<std::string> files_to_delete;
241  for (std::string& filename : filenames) {
242    if (ParseFileName(filename, &number, &type)) {
243      bool keep = true;
244      switch (type) {
245        case kLogFile:
246          keep = ((number >= versions_->LogNumber()) ||
247                  (number == versions_->PrevLogNumber()));
248          break;
249        case kDescriptorFile:
250          // Keep my manifest file, and any newer incarnations'

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.