Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-2022 The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #include <txdb.h>
7 : :
8 : : #include <coins.h>
9 : : #include <dbwrapper.h>
10 : : #include <logging.h>
11 : : #include <primitives/transaction.h>
12 : : #include <random.h>
13 : : #include <serialize.h>
14 : : #include <uint256.h>
15 : : #include <util/vector.h>
16 : :
17 : : #include <cassert>
18 : : #include <cstdlib>
19 : : #include <iterator>
20 : : #include <utility>
21 : :
22 : : static constexpr uint8_t DB_COIN{'C'};
23 : : static constexpr uint8_t DB_BEST_BLOCK{'B'};
24 : : static constexpr uint8_t DB_HEAD_BLOCKS{'H'};
25 : : // Keys used in previous version that might still be found in the DB:
26 : : static constexpr uint8_t DB_COINS{'c'};
27 : :
28 : 1210 : bool CCoinsViewDB::NeedsUpgrade()
29 : : {
30 [ + - ]: 1210 : std::unique_ptr<CDBIterator> cursor{m_db->NewIterator()};
31 : : // DB_COINS was deprecated in v0.15.0, commit
32 : : // 1088b02f0ccd7358d2b7076bb9e122d59d502d02
33 [ + - ]: 1210 : cursor->Seek(std::make_pair(DB_COINS, uint256{}));
34 [ + - ]: 2420 : return cursor->Valid();
35 : 1210 : }
36 : :
37 : : namespace {
38 : :
39 : : struct CoinEntry {
40 : : COutPoint* outpoint;
41 : : uint8_t key;
42 [ + - ]: 1215635 : explicit CoinEntry(const COutPoint* ptr) : outpoint(const_cast<COutPoint*>(ptr)), key(DB_COIN) {}
43 : :
44 : 10432232 : SERIALIZE_METHODS(CoinEntry, obj) { READWRITE(obj.key, obj.outpoint->hash, VARINT(obj.outpoint->n)); }
45 : : };
46 : :
47 : : } // namespace
48 : :
49 : 1811 : CCoinsViewDB::CCoinsViewDB(DBParams db_params, CoinsViewOptions options) :
50 : 1811 : m_db_params{std::move(db_params)},
51 : 1811 : m_options{std::move(options)},
52 [ + - ]: 1811 : m_db{std::make_unique<CDBWrapper>(m_db_params)} { }
53 : :
54 : 1219 : void CCoinsViewDB::ResizeCache(size_t new_cache_size)
55 : : {
56 : : // We can't do this operation with an in-memory DB since we'll lose all the coins upon
57 : : // reset.
58 [ - + ]: 1219 : if (!m_db_params.memory_only) {
59 : : // Have to do a reset first to get the original `m_db` state to release its
60 : : // filesystem lock.
61 [ # # ]: 0 : m_db.reset();
62 : 0 : m_db_params.cache_bytes = new_cache_size;
63 : 0 : m_db_params.wipe_data = false;
64 : 0 : m_db = std::make_unique<CDBWrapper>(m_db_params);
65 : : }
66 : 1219 : }
67 : :
68 : 1215635 : std::optional<Coin> CCoinsViewDB::GetCoin(const COutPoint& outpoint) const
69 : : {
70 [ + - + + ]: 1215635 : if (Coin coin; m_db->Read(CoinEntry(&outpoint), coin)) return coin;
71 : 1209307 : return std::nullopt;
72 : : }
73 : :
74 : 0 : bool CCoinsViewDB::HaveCoin(const COutPoint &outpoint) const {
75 : 0 : return m_db->Exists(CoinEntry(&outpoint));
76 : : }
77 : :
78 : 231629 : uint256 CCoinsViewDB::GetBestBlock() const {
79 : 231629 : uint256 hashBestChain;
80 [ + + ]: 231629 : if (!m_db->Read(DB_BEST_BLOCK, hashBestChain))
81 : 4822 : return uint256();
82 : 226807 : return hashBestChain;
83 : : }
84 : :
85 : 2402 : std::vector<uint256> CCoinsViewDB::GetHeadBlocks() const {
86 : 2402 : std::vector<uint256> vhashHeadBlocks;
87 [ + - + - ]: 2402 : if (!m_db->Read(DB_HEAD_BLOCKS, vhashHeadBlocks)) {
88 : 2402 : return std::vector<uint256>();
89 : : }
90 : 0 : return vhashHeadBlocks;
91 : 2402 : }
92 : :
93 : 76393 : bool CCoinsViewDB::BatchWrite(CoinsViewCacheCursor& cursor, const uint256 &hashBlock) {
94 : 76393 : CDBBatch batch(*m_db);
95 : 76393 : size_t count = 0;
96 : 76393 : size_t changed = 0;
97 [ - + ]: 76393 : assert(!hashBlock.IsNull());
98 : :
99 [ + - ]: 76393 : uint256 old_tip = GetBestBlock();
100 [ + + ]: 76393 : if (old_tip.IsNull()) {
101 : : // We may be in the middle of replaying.
102 [ + - ]: 1192 : std::vector<uint256> old_heads = GetHeadBlocks();
103 [ - + ]: 1192 : if (old_heads.size() == 2) {
104 [ # # ]: 0 : if (old_heads[0] != hashBlock) {
105 [ # # # # : 0 : LogPrintLevel(BCLog::COINDB, BCLog::Level::Error, "The coins database detected an inconsistent state, likely due to a previous crash or shutdown. You will need to restart bitcoind with the -reindex-chainstate or -reindex configuration option.\n");
# # ]
106 : : }
107 [ # # ]: 0 : assert(old_heads[0] == hashBlock);
108 : 0 : old_tip = old_heads[1];
109 : : }
110 : 1192 : }
111 : :
112 : : // In the first batch, mark the database as being in the middle of a
113 : : // transition from old_tip to hashBlock.
114 : : // A vector is used for future extensibility, as we may want to support
115 : : // interrupting after partial writes from multiple independent reorgs.
116 [ + - ]: 76393 : batch.Erase(DB_BEST_BLOCK);
117 [ + - + - ]: 76393 : batch.Write(DB_HEAD_BLOCKS, Vector(hashBlock, old_tip));
118 : :
119 [ + + ]: 137507 : for (auto it{cursor.Begin()}; it != cursor.End();) {
120 [ + - ]: 61114 : if (it->second.IsDirty()) {
121 : 61114 : CoinEntry entry(&it->first);
122 [ + + ]: 61114 : if (it->second.coin.IsSpent()) {
123 [ + - ]: 317 : batch.Erase(entry);
124 : : } else {
125 [ + - ]: 60797 : batch.Write(entry, it->second.coin);
126 : : }
127 : :
128 : 61114 : changed++;
129 : : }
130 : 61114 : count++;
131 : 61114 : it = cursor.NextAndMaybeErase(*it);
132 [ + - - + ]: 61114 : if (batch.ApproximateSize() > m_options.batch_write_bytes) {
133 [ # # # # : 0 : LogDebug(BCLog::COINDB, "Writing partial batch of %.2f MiB\n", batch.ApproximateSize() * (1.0 / 1048576.0));
# # # # ]
134 : :
135 [ # # ]: 0 : m_db->WriteBatch(batch);
136 [ # # ]: 0 : batch.Clear();
137 [ # # ]: 0 : if (m_options.simulate_crash_ratio) {
138 [ # # # # ]: 0 : static FastRandomContext rng;
139 [ # # ]: 0 : if (rng.randrange(m_options.simulate_crash_ratio) == 0) {
140 [ # # # # ]: 0 : LogPrintf("Simulating a crash. Goodbye.\n");
141 : 0 : _Exit(0);
142 : : }
143 : : }
144 : : }
145 : : }
146 : :
147 : : // In the last batch, mark the database as consistent with hashBlock again.
148 [ + - ]: 76393 : batch.Erase(DB_HEAD_BLOCKS);
149 [ + - ]: 76393 : batch.Write(DB_BEST_BLOCK, hashBlock);
150 : :
151 [ + - + + : 76393 : LogDebug(BCLog::COINDB, "Writing final batch of %.2f MiB\n", batch.ApproximateSize() * (1.0 / 1048576.0));
+ - + - ]
152 [ + - ]: 76393 : bool ret = m_db->WriteBatch(batch);
153 [ + - + + : 76393 : LogDebug(BCLog::COINDB, "Committed %u changed transaction outputs (out of %u) to coin database...\n", (unsigned int)changed, (unsigned int)count);
+ - ]
154 : 76393 : return ret;
155 : 76393 : }
156 : :
157 : 75731 : size_t CCoinsViewDB::EstimateSize() const
158 : : {
159 : 75731 : return m_db->EstimateSize(DB_COIN, uint8_t(DB_COIN + 1));
160 : : }
161 : :
162 : : /** Specialization of CCoinsViewCursor to iterate over a CCoinsViewDB */
163 : : class CCoinsViewDBCursor: public CCoinsViewCursor
164 : : {
165 : : public:
166 : : // Prefer using CCoinsViewDB::Cursor() since we want to perform some
167 : : // cache warmup on instantiation.
168 : 75772 : CCoinsViewDBCursor(CDBIterator* pcursorIn, const uint256&hashBlockIn):
169 : 75772 : CCoinsViewCursor(hashBlockIn), pcursor(pcursorIn) {}
170 : 75772 : ~CCoinsViewDBCursor() = default;
171 : :
172 : : bool GetKey(COutPoint &key) const override;
173 : : bool GetValue(Coin &coin) const override;
174 : :
175 : : bool Valid() const override;
176 : : void Next() override;
177 : :
178 : : private:
179 : : std::unique_ptr<CDBIterator> pcursor;
180 : : std::pair<char, COutPoint> keyTmp;
181 : :
182 : : friend class CCoinsViewDB;
183 : : };
184 : :
185 : 75772 : std::unique_ptr<CCoinsViewCursor> CCoinsViewDB::Cursor() const
186 : : {
187 : 75772 : auto i = std::make_unique<CCoinsViewDBCursor>(
188 : 75772 : const_cast<CDBWrapper&>(*m_db).NewIterator(), GetBestBlock());
189 : : /* It seems that there are no "const iterators" for LevelDB. Since we
190 : : only need read operations on it, use a const-cast to get around
191 : : that restriction. */
192 [ + - ]: 75772 : i->pcursor->Seek(DB_COIN);
193 : : // Cache key of first record
194 [ + - + + ]: 75772 : if (i->pcursor->Valid()) {
195 [ + - ]: 74866 : CoinEntry entry(&i->keyTmp.second);
196 [ + - ]: 74866 : i->pcursor->GetKey(entry);
197 : 74866 : i->keyTmp.first = entry.key;
198 : : } else {
199 : 906 : i->keyTmp.first = 0; // Make sure Valid() and GetKey() return false
200 : : }
201 : 75772 : return i;
202 : 75772 : }
203 : :
204 : 3939367 : bool CCoinsViewDBCursor::GetKey(COutPoint &key) const
205 : : {
206 : : // Return cached key
207 [ + - ]: 3939367 : if (keyTmp.first == DB_COIN) {
208 : 3939367 : key = keyTmp.second;
209 : 3939367 : return true;
210 : : }
211 : : return false;
212 : : }
213 : :
214 : 3939367 : bool CCoinsViewDBCursor::GetValue(Coin &coin) const
215 : : {
216 : 3939367 : return pcursor->GetValue(coin);
217 : : }
218 : :
219 : 4015139 : bool CCoinsViewDBCursor::Valid() const
220 : : {
221 : 4015139 : return keyTmp.first == DB_COIN;
222 : : }
223 : :
224 : 3939367 : void CCoinsViewDBCursor::Next()
225 : : {
226 : 3939367 : pcursor->Next();
227 : 3939367 : CoinEntry entry(&keyTmp.second);
228 [ + + - + ]: 3939367 : if (!pcursor->Valid() || !pcursor->GetKey(entry)) {
229 : 74866 : keyTmp.first = 0; // Invalidate cached key after last record so that Valid() and GetKey() return false
230 : : } else {
231 : 3864501 : keyTmp.first = entry.key;
232 : : }
233 : 3939367 : }
|
