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.

8,106 bytes · SHA-256 0f1cd749c5a55391… · 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 "leveldb/table_builder.h"
6
7#include <assert.h>
8
9#include "leveldb/comparator.h"
10#include "leveldb/env.h"
11#include "leveldb/filter_policy.h"
12#include "leveldb/options.h"
13#include "table/block_builder.h"
14#include "table/filter_block.h"
15#include "table/format.h"
16#include "util/coding.h"
17#include "util/crc32c.h"
18
19namespace leveldb {
20
21struct TableBuilder::Rep {
22  Rep(const Options& opt, WritableFile* f)
23      : options(opt),
24        index_block_options(opt),
25        file(f),
26        offset(0),
27        data_block(&options),
28        index_block(&index_block_options),
29        num_entries(0),
30        closed(false),
31        filter_block(opt.filter_policy == nullptr
32                         ? nullptr
33                         : new FilterBlockBuilder(opt.filter_policy)),
34        pending_index_entry(false) {
35    index_block_options.block_restart_interval = 1;
36  }
37
38  Options options;
39  Options index_block_options;
40  WritableFile* file;
41  uint64_t offset;
42  Status status;
43  BlockBuilder data_block;
44  BlockBuilder index_block;
45  std::string last_key;
46  int64_t num_entries;
47  bool closed;  // Either Finish() or Abandon() has been called.
48  FilterBlockBuilder* filter_block;
49
50  // We do not emit the index entry for a block until we have seen the
51  // first key for the next data block.  This allows us to use shorter
52  // keys in the index block.  For example, consider a block boundary
53  // between the keys "the quick brown fox" and "the who".  We can use
54  // "the r" as the key for the index block entry since it is >= all
55  // entries in the first block and < all entries in subsequent
56  // blocks.
57  //
58  // Invariant: r->pending_index_entry is true only if data_block is empty.
59  bool pending_index_entry;
60  BlockHandle pending_handle;  // Handle to add to index block
61
62  std::string compressed_output;
63};
64
65TableBuilder::TableBuilder(const Options& options, WritableFile* file)
66    : rep_(new Rep(options, file)) {
67  if (rep_->filter_block != nullptr) {
68    rep_->filter_block->StartBlock(0);
69  }
70}
71
72TableBuilder::~TableBuilder() {
73  assert(rep_->closed);  // Catch errors where caller forgot to call Finish()
74  delete rep_->filter_block;
75  delete rep_;
76}
77
78Status TableBuilder::ChangeOptions(const Options& options) {
79  // Note: if more fields are added to Options, update
80  // this function to catch changes that should not be allowed to
81  // change in the middle of building a Table.
82  if (options.comparator != rep_->options.comparator) {
83    return Status::InvalidArgument("changing comparator while building table");
84  }
85
86  // Note that any live BlockBuilders point to rep_->options and therefore
87  // will automatically pick up the updated options.
88  rep_->options = options;
89  rep_->index_block_options = options;
90  rep_->index_block_options.block_restart_interval = 1;
91  return Status::OK();
92}
93
94void TableBuilder::Add(const Slice& key, const Slice& value) {
95  Rep* r = rep_;
96  assert(!r->closed);
97  if (!ok()) return;
98  if (r->num_entries > 0) {
99    assert(r->options.comparator->Compare(key, Slice(r->last_key)) > 0);
100  }
101
102  if (r->pending_index_entry) {
103    assert(r->data_block.empty());
104    r->options.comparator->FindShortestSeparator(&r->last_key, key);
105    std::string handle_encoding;
106    r->pending_handle.EncodeTo(&handle_encoding);
107    r->index_block.Add(r->last_key, Slice(handle_encoding));
108    r->pending_index_entry = false;
109  }
110
111  if (r->filter_block != nullptr) {
112    r->filter_block->AddKey(key);
113  }
114
115  r->last_key.assign(key.data(), key.size());
116  r->num_entries++;
117  r->data_block.Add(key, value);
118
119  const size_t estimated_block_size = r->data_block.CurrentSizeEstimate();
120  if (estimated_block_size >= r->options.block_size) {
121    Flush();
122  }
123}
124
125void TableBuilder::Flush() {
126  Rep* r = rep_;
127  assert(!r->closed);
128  if (!ok()) return;
129  if (r->data_block.empty()) return;
130  assert(!r->pending_index_entry);
131  WriteBlock(&r->data_block, &r->pending_handle);
132  if (ok()) {
133    r->pending_index_entry = true;
134    r->status = r->file->Flush();
135  }
136  if (r->filter_block != nullptr) {
137    r->filter_block->StartBlock(r->offset);
138  }
139}
140
141void TableBuilder::WriteBlock(BlockBuilder* block, BlockHandle* handle) {
142  // File format contains a sequence of blocks where each block has:
143  //    block_data: uint8[n]
144  //    type: uint8
145  //    crc: uint32
146  assert(ok());
147  Rep* r = rep_;
148  Slice raw = block->Finish();
149
150  Slice block_contents;
151  CompressionType type = r->options.compression;
152  // TODO(postrelease): Support more compression options: zlib?
153  switch (type) {
154    case kNoCompression:
155      block_contents = raw;
156      break;
157
158    case kSnappyCompression: {
159      std::string* compressed = &r->compressed_output;
160      if (port::Snappy_Compress(raw.data(), raw.size(), compressed) &&
161          compressed->size() < raw.size() - (raw.size() / 8u)) {
162        block_contents = *compressed;
163      } else {
164        // Snappy not supported, or compressed less than 12.5%, so just
165        // store uncompressed form
166        block_contents = raw;
167        type = kNoCompression;
168      }
169      break;
170    }
171  }
172  WriteRawBlock(block_contents, type, handle);
173  r->compressed_output.clear();
174  block->Reset();
175}
176
177void TableBuilder::WriteRawBlock(const Slice& block_contents,
178                                 CompressionType type, BlockHandle* handle) {
179  Rep* r = rep_;
180  handle->set_offset(r->offset);
181  handle->set_size(block_contents.size());
182  r->status = r->file->Append(block_contents);
183  if (r->status.ok()) {
184    char trailer[kBlockTrailerSize];
185    trailer[0] = type;
186    uint32_t crc = crc32c::Value(block_contents.data(), block_contents.size());
187    crc = crc32c::Extend(crc, trailer, 1);  // Extend crc to cover block type
188    EncodeFixed32(trailer + 1, crc32c::Mask(crc));
189    r->status = r->file->Append(Slice(trailer, kBlockTrailerSize));
190    if (r->status.ok()) {
191      r->offset += block_contents.size() + kBlockTrailerSize;
192    }
193  }
194}
195
196Status TableBuilder::status() const { return rep_->status; }
197
198Status TableBuilder::Finish() {
199  Rep* r = rep_;
200  Flush();
201  assert(!r->closed);
202  r->closed = true;
203
204  BlockHandle filter_block_handle, metaindex_block_handle, index_block_handle;
205
206  // Write filter block
207  if (ok() && r->filter_block != nullptr) {
208    WriteRawBlock(r->filter_block->Finish(), kNoCompression,
209                  &filter_block_handle);
210  }
211
212  // Write metaindex block
213  if (ok()) {
214    BlockBuilder meta_index_block(&r->options);
215    if (r->filter_block != nullptr) {
216      // Add mapping from "filter.Name" to location of filter data
217      std::string key = "filter.";
218      key.append(r->options.filter_policy->Name());
219      std::string handle_encoding;
220      filter_block_handle.EncodeTo(&handle_encoding);
221      meta_index_block.Add(key, handle_encoding);
222    }
223
224    // TODO(postrelease): Add stats and other meta blocks
225    WriteBlock(&meta_index_block, &metaindex_block_handle);
226  }
227
228  // Write index block
229  if (ok()) {
230    if (r->pending_index_entry) {
231      r->options.comparator->FindShortSuccessor(&r->last_key);
232      std::string handle_encoding;
233      r->pending_handle.EncodeTo(&handle_encoding);
234      r->index_block.Add(r->last_key, Slice(handle_encoding));
235      r->pending_index_entry = false;
236    }
237    WriteBlock(&r->index_block, &index_block_handle);
238  }
239
240  // Write footer
241  if (ok()) {
242    Footer footer;
243    footer.set_metaindex_handle(metaindex_block_handle);
244    footer.set_index_handle(index_block_handle);
245    std::string footer_encoding;
246    footer.EncodeTo(&footer_encoding);
247    r->status = r->file->Append(footer_encoding);
248    if (r->status.ok()) {
249      r->offset += footer_encoding.size();
250    }

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.