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.

13,657 bytes · SHA-256 2c46edd86f840bb9… · 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// We recover the contents of the descriptor from the other files we find.
6// (1) Any log files are first converted to tables
7// (2) We scan every table to compute
8//     (a) smallest/largest for the table
9//     (b) largest sequence number in the table
10// (3) We generate descriptor contents:
11//      - log number is set to zero
12//      - next-file-number is set to 1 + largest file number we found
13//      - last-sequence-number is set to largest sequence# found across
14//        all tables (see 2c)
15//      - compaction pointers are cleared
16//      - every table file is added at level 0
17//
18// Possible optimization 1:
19//   (a) Compute total size and use to pick appropriate max-level M
20//   (b) Sort tables by largest sequence# in the table
21//   (c) For each table: if it overlaps earlier table, place in level-0,
22//       else place in level-M.
23// Possible optimization 2:
24//   Store per-table metadata (smallest, largest, largest-seq#, ...)
25//   in the table's meta section to speed up ScanTable.
26
27#include "db/builder.h"
28#include "db/db_impl.h"
29#include "db/dbformat.h"
30#include "db/filename.h"
31#include "db/log_reader.h"
32#include "db/log_writer.h"
33#include "db/memtable.h"
34#include "db/table_cache.h"
35#include "db/version_edit.h"
36#include "db/write_batch_internal.h"
37#include "leveldb/comparator.h"
38#include "leveldb/db.h"
39#include "leveldb/env.h"
40
41namespace leveldb {
42
43namespace {
44
45class Repairer {
46 public:
47  Repairer(const std::string& dbname, const Options& options)
48      : dbname_(dbname),
49        env_(options.env),
50        icmp_(options.comparator),
51        ipolicy_(options.filter_policy),
52        options_(SanitizeOptions(dbname, &icmp_, &ipolicy_, options)),
53        owns_info_log_(options_.info_log != options.info_log),
54        owns_cache_(options_.block_cache != options.block_cache),
55        next_file_number_(1) {
56    // TableCache can be small since we expect each table to be opened once.
57    table_cache_ = new TableCache(dbname_, options_, 10);
58  }
59
60  ~Repairer() {
61    delete table_cache_;
62    if (owns_info_log_) {
63      delete options_.info_log;
64    }
65    if (owns_cache_) {
66      delete options_.block_cache;
67    }
68  }
69
70  Status Run() {
71    Status status = FindFiles();
72    if (status.ok()) {
73      ConvertLogFilesToTables();
74      ExtractMetaData();
75      status = WriteDescriptor();
76    }
77    if (status.ok()) {
78      unsigned long long bytes = 0;
79      for (size_t i = 0; i < tables_.size(); i++) {
80        bytes += tables_[i].meta.file_size;
81      }
82      Log(options_.info_log,
83          "**** Repaired leveldb %s; "
84          "recovered %d files; %llu bytes. "
85          "Some data may have been lost. "
86          "****",
87          dbname_.c_str(), static_cast<int>(tables_.size()), bytes);
88    }
89    return status;
90  }
91
92 private:
93  struct TableInfo {
94    FileMetaData meta;
95    SequenceNumber max_sequence;
96  };
97
98  Status FindFiles() {
99    std::vector<std::string> filenames;
100    Status status = env_->GetChildren(dbname_, &filenames);
101    if (!status.ok()) {
102      return status;
103    }
104    if (filenames.empty()) {
105      return Status::IOError(dbname_, "repair found no files");
106    }
107
108    uint64_t number;
109    FileType type;
110    for (size_t i = 0; i < filenames.size(); i++) {
111      if (ParseFileName(filenames[i], &number, &type)) {
112        if (type == kDescriptorFile) {
113          manifests_.push_back(filenames[i]);
114        } else {
115          if (number + 1 > next_file_number_) {
116            next_file_number_ = number + 1;
117          }
118          if (type == kLogFile) {
119            logs_.push_back(number);
120          } else if (type == kTableFile) {
121            table_numbers_.push_back(number);
122          } else {
123            // Ignore other files
124          }
125        }
126      }
127    }
128    return status;
129  }
130
131  void ConvertLogFilesToTables() {
132    for (size_t i = 0; i < logs_.size(); i++) {
133      std::string logname = LogFileName(dbname_, logs_[i]);
134      Status status = ConvertLogToTable(logs_[i]);
135      if (!status.ok()) {
136        Log(options_.info_log, "Log #%llu: ignoring conversion error: %s",
137            (unsigned long long)logs_[i], status.ToString().c_str());
138      }
139      ArchiveFile(logname);
140    }
141  }
142
143  Status ConvertLogToTable(uint64_t log) {
144    struct LogReporter : public log::Reader::Reporter {
145      Env* env;
146      Logger* info_log;
147      uint64_t lognum;
148      void Corruption(size_t bytes, const Status& s) override {
149        // We print error messages for corruption, but continue repairing.
150        Log(info_log, "Log #%llu: dropping %d bytes; %s",
151            (unsigned long long)lognum, static_cast<int>(bytes),
152            s.ToString().c_str());
153      }
154    };
155
156    // Open the log file
157    std::string logname = LogFileName(dbname_, log);
158    SequentialFile* lfile;
159    Status status = env_->NewSequentialFile(logname, &lfile);
160    if (!status.ok()) {
161      return status;
162    }
163
164    // Create the log reader.
165    LogReporter reporter;
166    reporter.env = env_;
167    reporter.info_log = options_.info_log;
168    reporter.lognum = log;
169    // We intentionally make log::Reader do checksumming so that
170    // corruptions cause entire commits to be skipped instead of
171    // propagating bad information (like overly large sequence
172    // numbers).
173    log::Reader reader(lfile, &reporter, false /*do not checksum*/,
174                       0 /*initial_offset*/);
175
176    // Read all the records and add to a memtable
177    std::string scratch;
178    Slice record;
179    WriteBatch batch;
180    MemTable* mem = new MemTable(icmp_);
181    mem->Ref();
182    int counter = 0;
183    while (reader.ReadRecord(&record, &scratch)) {
184      if (record.size() < 12) {
185        reporter.Corruption(record.size(),
186                            Status::Corruption("log record too small", logname));
187        continue;
188      }
189      WriteBatchInternal::SetContents(&batch, record);
190      status = WriteBatchInternal::InsertInto(&batch, mem);
191      if (status.ok()) {
192        counter += WriteBatchInternal::Count(&batch);
193      } else {
194        Log(options_.info_log, "Log #%llu: ignoring %s",
195            (unsigned long long)log, status.ToString().c_str());
196        status = Status::OK();  // Keep going with rest of file
197      }
198    }
199    delete lfile;
200
201    // Do not record a version edit for this conversion to a Table
202    // since ExtractMetaData() will also generate edits.
203    FileMetaData meta;
204    meta.number = next_file_number_++;
205    Iterator* iter = mem->NewIterator();
206    status = BuildTable(dbname_, env_, options_, table_cache_, iter, &meta);
207    delete iter;
208    mem->Unref();
209    mem = nullptr;
210    if (status.ok()) {
211      if (meta.file_size > 0) {
212        table_numbers_.push_back(meta.number);
213      }
214    }
215    Log(options_.info_log, "Log #%llu: %d ops saved to Table #%llu %s",
216        (unsigned long long)log, counter, (unsigned long long)meta.number,
217        status.ToString().c_str());
218    return status;
219  }
220
221  void ExtractMetaData() {
222    for (size_t i = 0; i < table_numbers_.size(); i++) {
223      ScanTable(table_numbers_[i]);
224    }
225  }
226
227  Iterator* NewTableIterator(const FileMetaData& meta) {
228    // Same as compaction iterators: if paranoid_checks are on, turn
229    // on checksum verification.
230    ReadOptions r;
231    r.verify_checksums = options_.paranoid_checks;
232    return table_cache_->NewIterator(r, meta.number, meta.file_size);
233  }
234
235  void ScanTable(uint64_t number) {
236    TableInfo t;
237    t.meta.number = number;
238    std::string fname = TableFileName(dbname_, number);
239    Status status = env_->GetFileSize(fname, &t.meta.file_size);
240    if (!status.ok()) {
241      // Try alternate file name.
242      fname = SSTTableFileName(dbname_, number);
243      Status s2 = env_->GetFileSize(fname, &t.meta.file_size);
244      if (s2.ok()) {
245        status = Status::OK();
246      }
247    }
248    if (!status.ok()) {
249      ArchiveFile(TableFileName(dbname_, number));
250      ArchiveFile(SSTTableFileName(dbname_, number));

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.