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.

7,628 bytes · SHA-256 f8c03350f97ff173… · 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#ifndef STORAGE_LEVELDB_DB_DB_IMPL_H_
6#define STORAGE_LEVELDB_DB_DB_IMPL_H_
7
8#include <atomic>
9#include <deque>
10#include <set>
11#include <string>
12
13#include "db/dbformat.h"
14#include "db/log_writer.h"
15#include "db/snapshot.h"
16#include "leveldb/db.h"
17#include "leveldb/env.h"
18#include "port/port.h"
19#include "port/thread_annotations.h"
20
21namespace leveldb {
22
23class MemTable;
24class TableCache;
25class Version;
26class VersionEdit;
27class VersionSet;
28
29class DBImpl : public DB {
30 public:
31  DBImpl(const Options& options, const std::string& dbname);
32
33  DBImpl(const DBImpl&) = delete;
34  DBImpl& operator=(const DBImpl&) = delete;
35
36  ~DBImpl() override;
37
38  // Implementations of the DB interface
39  Status Put(const WriteOptions&, const Slice& key,
40             const Slice& value) override;
41  Status Delete(const WriteOptions&, const Slice& key) override;
42  Status Write(const WriteOptions& options, WriteBatch* updates) override;
43  Status Get(const ReadOptions& options, const Slice& key,
44             std::string* value) override;
45  Iterator* NewIterator(const ReadOptions&) override;
46  const Snapshot* GetSnapshot() override;
47  void ReleaseSnapshot(const Snapshot* snapshot) override;
48  bool GetProperty(const Slice& property, std::string* value) override;
49  void GetApproximateSizes(const Range* range, int n, uint64_t* sizes) override;
50  void CompactRange(const Slice* begin, const Slice* end) override;
51
52  // Extra methods (for testing) that are not in the public DB interface
53
54  // Compact any files in the named level that overlap [*begin,*end]
55  void TEST_CompactRange(int level, const Slice* begin, const Slice* end);
56
57  // Force current memtable contents to be compacted.
58  Status TEST_CompactMemTable();
59
60  // Return an internal iterator over the current state of the database.
61  // The keys of this iterator are internal keys (see format.h).
62  // The returned iterator should be deleted when no longer needed.
63  Iterator* TEST_NewInternalIterator();
64
65  // Return the maximum overlapping data (in bytes) at next level for any
66  // file at a level >= 1.
67  int64_t TEST_MaxNextLevelOverlappingBytes();
68
69  // Record a sample of bytes read at the specified internal key.
70  // Samples are taken approximately once every config::kReadBytesPeriod
71  // bytes.
72  void RecordReadSample(Slice key);
73
74 private:
75  friend class DB;
76  struct CompactionState;
77  struct Writer;
78
79  // Information for a manual compaction
80  struct ManualCompaction {
81    int level;
82    bool done;
83    const InternalKey* begin;  // null means beginning of key range
84    const InternalKey* end;    // null means end of key range
85    InternalKey tmp_storage;   // Used to keep track of compaction progress
86  };
87
88  // Per level compaction stats.  stats_[level] stores the stats for
89  // compactions that produced data for the specified "level".
90  struct CompactionStats {
91    CompactionStats() : micros(0), bytes_read(0), bytes_written(0) {}
92
93    void Add(const CompactionStats& c) {
94      this->micros += c.micros;
95      this->bytes_read += c.bytes_read;
96      this->bytes_written += c.bytes_written;
97    }
98
99    int64_t micros;
100    int64_t bytes_read;
101    int64_t bytes_written;
102  };
103
104  Iterator* NewInternalIterator(const ReadOptions&,
105                                SequenceNumber* latest_snapshot,
106                                uint32_t* seed);
107
108  Status NewDB();
109
110  // Recover the descriptor from persistent storage.  May do a significant
111  // amount of work to recover recently logged updates.  Any changes to
112  // be made to the descriptor are added to *edit.
113  Status Recover(VersionEdit* edit, bool* save_manifest)
114      EXCLUSIVE_LOCKS_REQUIRED(mutex_);
115
116  void MaybeIgnoreError(Status* s) const;
117
118  // Delete any unneeded files and stale in-memory entries.
119  void DeleteObsoleteFiles() EXCLUSIVE_LOCKS_REQUIRED(mutex_);
120
121  // Compact the in-memory write buffer to disk.  Switches to a new
122  // log-file/memtable and writes a new descriptor iff successful.
123  // Errors are recorded in bg_error_.
124  void CompactMemTable() EXCLUSIVE_LOCKS_REQUIRED(mutex_);
125
126  Status RecoverLogFile(uint64_t log_number, bool last_log, bool* save_manifest,
127                        VersionEdit* edit, SequenceNumber* max_sequence)
128      EXCLUSIVE_LOCKS_REQUIRED(mutex_);
129
130  Status WriteLevel0Table(MemTable* mem, VersionEdit* edit, Version* base)
131      EXCLUSIVE_LOCKS_REQUIRED(mutex_);
132
133  Status MakeRoomForWrite(bool force /* compact even if there is room? */)
134      EXCLUSIVE_LOCKS_REQUIRED(mutex_);
135  WriteBatch* BuildBatchGroup(Writer** last_writer)
136      EXCLUSIVE_LOCKS_REQUIRED(mutex_);
137
138  void RecordBackgroundError(const Status& s);
139
140  void MaybeScheduleCompaction() EXCLUSIVE_LOCKS_REQUIRED(mutex_);
141  static void BGWork(void* db);
142  void BackgroundCall();
143  void BackgroundCompaction() EXCLUSIVE_LOCKS_REQUIRED(mutex_);
144  void CleanupCompaction(CompactionState* compact)
145      EXCLUSIVE_LOCKS_REQUIRED(mutex_);
146  Status DoCompactionWork(CompactionState* compact)
147      EXCLUSIVE_LOCKS_REQUIRED(mutex_);
148
149  Status OpenCompactionOutputFile(CompactionState* compact);
150  Status FinishCompactionOutputFile(CompactionState* compact, Iterator* input);
151  Status InstallCompactionResults(CompactionState* compact)
152      EXCLUSIVE_LOCKS_REQUIRED(mutex_);
153
154  const Comparator* user_comparator() const {
155    return internal_comparator_.user_comparator();
156  }
157
158  // Constant after construction
159  Env* const env_;
160  const InternalKeyComparator internal_comparator_;
161  const InternalFilterPolicy internal_filter_policy_;
162  const Options options_;  // options_.comparator == &internal_comparator_
163  const bool owns_info_log_;
164  const bool owns_cache_;
165  const std::string dbname_;
166
167  // table_cache_ provides its own synchronization
168  TableCache* const table_cache_;
169
170  // Lock over the persistent DB state.  Non-null iff successfully acquired.
171  FileLock* db_lock_;
172
173  // State below is protected by mutex_
174  port::Mutex mutex_;
175  std::atomic<bool> shutting_down_;
176  port::CondVar background_work_finished_signal_ GUARDED_BY(mutex_);
177  MemTable* mem_;
178  MemTable* imm_ GUARDED_BY(mutex_);  // Memtable being compacted
179  std::atomic<bool> has_imm_;         // So bg thread can detect non-null imm_
180  WritableFile* logfile_;
181  uint64_t logfile_number_ GUARDED_BY(mutex_);
182  log::Writer* log_;
183  uint32_t seed_ GUARDED_BY(mutex_);  // For sampling.
184
185  // Queue of writers.
186  std::deque<Writer*> writers_ GUARDED_BY(mutex_);
187  WriteBatch* tmp_batch_ GUARDED_BY(mutex_);
188
189  SnapshotList snapshots_ GUARDED_BY(mutex_);
190
191  // Set of table files to protect from deletion because they are
192  // part of ongoing compactions.
193  std::set<uint64_t> pending_outputs_ GUARDED_BY(mutex_);
194
195  // Has a background compaction been scheduled or is running?
196  bool background_compaction_scheduled_ GUARDED_BY(mutex_);
197
198  ManualCompaction* manual_compaction_ GUARDED_BY(mutex_);
199
200  VersionSet* const versions_ GUARDED_BY(mutex_);
201
202  // Have we encountered a background error in paranoid mode?
203  Status bg_error_ GUARDED_BY(mutex_);
204
205  CompactionStats stats_[config::kNumLevels] GUARDED_BY(mutex_);
206};
207
208// Sanitize db options.  The caller should delete result.info_log if
209// it is not equal to src.info_log.
210Options SanitizeOptions(const std::string& db,
211                        const InternalKeyComparator* icmp,
212                        const InternalFilterPolicy* ipolicy,
213                        const Options& src);
214
215}  // namespace leveldb
216
217#endif  // STORAGE_LEVELDB_DB_DB_IMPL_H_
218

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.