Branch data Line data Source code
1 : : // Copyright (c) 2012-2022 The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <coins.h>
6 : :
7 : : #include <consensus/consensus.h>
8 : : #include <logging.h>
9 : : #include <random.h>
10 : : #include <util/trace.h>
11 : :
12 : 0 : bool CCoinsView::GetCoin(const COutPoint &outpoint, Coin &coin) const { return false; }
13 : 0 : uint256 CCoinsView::GetBestBlock() const { return uint256(); }
14 : 0 : std::vector<uint256> CCoinsView::GetHeadBlocks() const { return std::vector<uint256>(); }
15 : 0 : bool CCoinsView::BatchWrite(CoinsViewCacheCursor& cursor, const uint256 &hashBlock) { return false; }
16 : 0 : std::unique_ptr<CCoinsViewCursor> CCoinsView::Cursor() const { return nullptr; }
17 : :
18 : 0 : bool CCoinsView::HaveCoin(const COutPoint &outpoint) const
19 : : {
20 : 0 : Coin coin;
21 [ # # ]: 0 : return GetCoin(outpoint, coin);
22 : 0 : }
23 : :
24 : 5 : CCoinsViewBacked::CCoinsViewBacked(CCoinsView *viewIn) : base(viewIn) { }
25 : 0 : bool CCoinsViewBacked::GetCoin(const COutPoint &outpoint, Coin &coin) const { return base->GetCoin(outpoint, coin); }
26 : 0 : bool CCoinsViewBacked::HaveCoin(const COutPoint &outpoint) const { return base->HaveCoin(outpoint); }
27 : 3 : uint256 CCoinsViewBacked::GetBestBlock() const { return base->GetBestBlock(); }
28 : 0 : std::vector<uint256> CCoinsViewBacked::GetHeadBlocks() const { return base->GetHeadBlocks(); }
29 : 0 : void CCoinsViewBacked::SetBackend(CCoinsView &viewIn) { base = &viewIn; }
30 : 0 : bool CCoinsViewBacked::BatchWrite(CoinsViewCacheCursor& cursor, const uint256 &hashBlock) { return base->BatchWrite(cursor, hashBlock); }
31 : 0 : std::unique_ptr<CCoinsViewCursor> CCoinsViewBacked::Cursor() const { return base->Cursor(); }
32 : 0 : size_t CCoinsViewBacked::EstimateSize() const { return base->EstimateSize(); }
33 : :
34 : 4 : CCoinsViewCache::CCoinsViewCache(CCoinsView* baseIn, bool deterministic) :
35 : 4 : CCoinsViewBacked(baseIn), m_deterministic(deterministic),
36 [ + - + - ]: 4 : cacheCoins(0, SaltedOutpointHasher(/*deterministic=*/deterministic), CCoinsMap::key_equal{}, &m_cache_coins_memory_resource)
37 : : {
38 : 4 : m_sentinel.second.SelfRef(m_sentinel);
39 : 4 : }
40 : :
41 : 7 : size_t CCoinsViewCache::DynamicMemoryUsage() const {
42 : 7 : return memusage::DynamicUsage(cacheCoins) + cachedCoinsUsage;
43 : : }
44 : :
45 : 0 : CCoinsMap::iterator CCoinsViewCache::FetchCoin(const COutPoint &outpoint) const {
46 [ # # ]: 0 : const auto [ret, inserted] = cacheCoins.try_emplace(outpoint);
47 [ # # ]: 0 : if (inserted) {
48 [ # # ]: 0 : if (!base->GetCoin(outpoint, ret->second.coin)) {
49 : 0 : cacheCoins.erase(ret);
50 : 0 : return cacheCoins.end();
51 : : }
52 [ # # ]: 0 : if (ret->second.coin.IsSpent()) {
53 : : // The parent only has an empty entry for this outpoint; we can consider our version as fresh.
54 : 0 : ret->second.AddFlags(CCoinsCacheEntry::FRESH, *ret, m_sentinel);
55 : : }
56 [ # # ]: 0 : cachedCoinsUsage += ret->second.coin.DynamicMemoryUsage();
57 : : }
58 : 0 : return ret;
59 : : }
60 : :
61 : 0 : bool CCoinsViewCache::GetCoin(const COutPoint &outpoint, Coin &coin) const {
62 [ # # ]: 0 : CCoinsMap::const_iterator it = FetchCoin(outpoint);
63 [ # # ]: 0 : if (it != cacheCoins.end()) {
64 : 0 : coin = it->second.coin;
65 : 0 : return !coin.IsSpent();
66 : : }
67 : : return false;
68 : : }
69 : :
70 : 0 : void CCoinsViewCache::AddCoin(const COutPoint &outpoint, Coin&& coin, bool possible_overwrite) {
71 [ # # ]: 0 : assert(!coin.IsSpent());
72 [ # # ]: 0 : if (coin.out.scriptPubKey.IsUnspendable()) return;
73 : 0 : CCoinsMap::iterator it;
74 : 0 : bool inserted;
75 [ # # ]: 0 : std::tie(it, inserted) = cacheCoins.emplace(std::piecewise_construct, std::forward_as_tuple(outpoint), std::tuple<>());
76 : 0 : bool fresh = false;
77 [ # # ]: 0 : if (!inserted) {
78 [ # # ]: 0 : cachedCoinsUsage -= it->second.coin.DynamicMemoryUsage();
79 : : }
80 [ # # ]: 0 : if (!possible_overwrite) {
81 [ # # ]: 0 : if (!it->second.coin.IsSpent()) {
82 [ # # ]: 0 : throw std::logic_error("Attempted to overwrite an unspent coin (when possible_overwrite is false)");
83 : : }
84 : : // If the coin exists in this cache as a spent coin and is DIRTY, then
85 : : // its spentness hasn't been flushed to the parent cache. We're
86 : : // re-adding the coin to this cache now but we can't mark it as FRESH.
87 : : // If we mark it FRESH and then spend it before the cache is flushed
88 : : // we would remove it from this cache and would never flush spentness
89 : : // to the parent cache.
90 : : //
91 : : // Re-adding a spent coin can happen in the case of a re-org (the coin
92 : : // is 'spent' when the block adding it is disconnected and then
93 : : // re-added when it is also added in a newly connected block).
94 : : //
95 : : // If the coin doesn't exist in the current cache, or is spent but not
96 : : // DIRTY, then it can be marked FRESH.
97 : 0 : fresh = !it->second.IsDirty();
98 : : }
99 : 0 : it->second.coin = std::move(coin);
100 [ # # ]: 0 : it->second.AddFlags(CCoinsCacheEntry::DIRTY | (fresh ? CCoinsCacheEntry::FRESH : 0), *it, m_sentinel);
101 [ # # ]: 0 : cachedCoinsUsage += it->second.coin.DynamicMemoryUsage();
102 : : TRACE5(utxocache, add,
103 : : outpoint.hash.data(),
104 : : (uint32_t)outpoint.n,
105 : : (uint32_t)it->second.coin.nHeight,
106 : : (int64_t)it->second.coin.out.nValue,
107 : 0 : (bool)it->second.coin.IsCoinBase());
108 : : }
109 : :
110 : 0 : void CCoinsViewCache::EmplaceCoinInternalDANGER(COutPoint&& outpoint, Coin&& coin) {
111 [ # # ]: 0 : cachedCoinsUsage += coin.DynamicMemoryUsage();
112 [ # # ]: 0 : auto [it, inserted] = cacheCoins.emplace(
113 : : std::piecewise_construct,
114 : 0 : std::forward_as_tuple(std::move(outpoint)),
115 : 0 : std::forward_as_tuple(std::move(coin)));
116 [ # # ]: 0 : if (inserted) {
117 : 0 : it->second.AddFlags(CCoinsCacheEntry::DIRTY, *it, m_sentinel);
118 : : }
119 : 0 : }
120 : :
121 : 0 : void AddCoins(CCoinsViewCache& cache, const CTransaction &tx, int nHeight, bool check_for_overwrite) {
122 : 0 : bool fCoinbase = tx.IsCoinBase();
123 : 0 : const Txid& txid = tx.GetHash();
124 [ # # ]: 0 : for (size_t i = 0; i < tx.vout.size(); ++i) {
125 [ # # ]: 0 : bool overwrite = check_for_overwrite ? cache.HaveCoin(COutPoint(txid, i)) : fCoinbase;
126 : : // Coinbase transactions can always be overwritten, in order to correctly
127 : : // deal with the pre-BIP30 occurrences of duplicate coinbase transactions.
128 [ # # ]: 0 : cache.AddCoin(COutPoint(txid, i), Coin(tx.vout[i], nHeight, fCoinbase), overwrite);
129 : : }
130 : 0 : }
131 : :
132 : 0 : bool CCoinsViewCache::SpendCoin(const COutPoint &outpoint, Coin* moveout) {
133 : 0 : CCoinsMap::iterator it = FetchCoin(outpoint);
134 [ # # ]: 0 : if (it == cacheCoins.end()) return false;
135 [ # # ]: 0 : cachedCoinsUsage -= it->second.coin.DynamicMemoryUsage();
136 : : TRACE5(utxocache, spent,
137 : : outpoint.hash.data(),
138 : : (uint32_t)outpoint.n,
139 : : (uint32_t)it->second.coin.nHeight,
140 : : (int64_t)it->second.coin.out.nValue,
141 : 0 : (bool)it->second.coin.IsCoinBase());
142 [ # # ]: 0 : if (moveout) {
143 : 0 : *moveout = std::move(it->second.coin);
144 : : }
145 [ # # ]: 0 : if (it->second.IsFresh()) {
146 : 0 : cacheCoins.erase(it);
147 : : } else {
148 : 0 : it->second.AddFlags(CCoinsCacheEntry::DIRTY, *it, m_sentinel);
149 : 0 : it->second.coin.Clear();
150 : : }
151 : : return true;
152 : : }
153 : :
154 : : static const Coin coinEmpty;
155 : :
156 : 0 : const Coin& CCoinsViewCache::AccessCoin(const COutPoint &outpoint) const {
157 [ # # ]: 0 : CCoinsMap::const_iterator it = FetchCoin(outpoint);
158 [ # # ]: 0 : if (it == cacheCoins.end()) {
159 : : return coinEmpty;
160 : : } else {
161 : 0 : return it->second.coin;
162 : : }
163 : : }
164 : :
165 : 0 : bool CCoinsViewCache::HaveCoin(const COutPoint &outpoint) const {
166 [ # # ]: 0 : CCoinsMap::const_iterator it = FetchCoin(outpoint);
167 [ # # # # ]: 0 : return (it != cacheCoins.end() && !it->second.coin.IsSpent());
168 : : }
169 : :
170 : 0 : bool CCoinsViewCache::HaveCoinInCache(const COutPoint &outpoint) const {
171 [ # # ]: 0 : CCoinsMap::const_iterator it = cacheCoins.find(outpoint);
172 [ # # # # ]: 0 : return (it != cacheCoins.end() && !it->second.coin.IsSpent());
173 : : }
174 : :
175 : 4 : uint256 CCoinsViewCache::GetBestBlock() const {
176 [ + - ]: 4 : if (hashBlock.IsNull())
177 : 4 : hashBlock = base->GetBestBlock();
178 : 4 : return hashBlock;
179 : : }
180 : :
181 : 1 : void CCoinsViewCache::SetBestBlock(const uint256 &hashBlockIn) {
182 : 1 : hashBlock = hashBlockIn;
183 : 1 : }
184 : :
185 : 1 : bool CCoinsViewCache::BatchWrite(CoinsViewCacheCursor& cursor, const uint256 &hashBlockIn) {
186 [ - + ]: 1 : for (auto it{cursor.Begin()}; it != cursor.End(); it = cursor.NextAndMaybeErase(*it)) {
187 : : // Ignore non-dirty entries (optimization).
188 [ # # ]: 0 : if (!it->second.IsDirty()) {
189 : 0 : continue;
190 : : }
191 : 0 : CCoinsMap::iterator itUs = cacheCoins.find(it->first);
192 [ # # ]: 0 : if (itUs == cacheCoins.end()) {
193 : : // The parent cache does not have an entry, while the child cache does.
194 : : // We can ignore it if it's both spent and FRESH in the child
195 [ # # # # ]: 0 : if (!(it->second.IsFresh() && it->second.coin.IsSpent())) {
196 : : // Create the coin in the parent cache, move the data up
197 : : // and mark it as dirty.
198 : 0 : itUs = cacheCoins.try_emplace(it->first).first;
199 [ # # ]: 0 : CCoinsCacheEntry& entry{itUs->second};
200 [ # # ]: 0 : if (cursor.WillErase(*it)) {
201 : : // Since this entry will be erased,
202 : : // we can move the coin into us instead of copying it
203 : 0 : entry.coin = std::move(it->second.coin);
204 : : } else {
205 : 0 : entry.coin = it->second.coin;
206 : : }
207 [ # # ]: 0 : cachedCoinsUsage += entry.coin.DynamicMemoryUsage();
208 : 0 : entry.AddFlags(CCoinsCacheEntry::DIRTY, *itUs, m_sentinel);
209 : : // We can mark it FRESH in the parent if it was FRESH in the child
210 : : // Otherwise it might have just been flushed from the parent's cache
211 : : // and already exist in the grandparent
212 [ # # ]: 0 : if (it->second.IsFresh()) {
213 : 0 : entry.AddFlags(CCoinsCacheEntry::FRESH, *itUs, m_sentinel);
214 : : }
215 : : }
216 : : } else {
217 : : // Found the entry in the parent cache
218 [ # # # # ]: 0 : if (it->second.IsFresh() && !itUs->second.coin.IsSpent()) {
219 : : // The coin was marked FRESH in the child cache, but the coin
220 : : // exists in the parent cache. If this ever happens, it means
221 : : // the FRESH flag was misapplied and there is a logic error in
222 : : // the calling code.
223 [ # # ]: 0 : throw std::logic_error("FRESH flag misapplied to coin that exists in parent cache");
224 : : }
225 : :
226 [ # # # # ]: 0 : if (itUs->second.IsFresh() && it->second.coin.IsSpent()) {
227 : : // The grandparent cache does not have an entry, and the coin
228 : : // has been spent. We can just delete it from the parent cache.
229 [ # # ]: 0 : cachedCoinsUsage -= itUs->second.coin.DynamicMemoryUsage();
230 : 0 : cacheCoins.erase(itUs);
231 : : } else {
232 : : // A normal modification.
233 [ # # ]: 0 : cachedCoinsUsage -= itUs->second.coin.DynamicMemoryUsage();
234 [ # # ]: 0 : if (cursor.WillErase(*it)) {
235 : : // Since this entry will be erased,
236 : : // we can move the coin into us instead of copying it
237 : 0 : itUs->second.coin = std::move(it->second.coin);
238 : : } else {
239 : 0 : itUs->second.coin = it->second.coin;
240 : : }
241 [ # # ]: 0 : cachedCoinsUsage += itUs->second.coin.DynamicMemoryUsage();
242 : 0 : itUs->second.AddFlags(CCoinsCacheEntry::DIRTY, *itUs, m_sentinel);
243 : : // NOTE: It isn't safe to mark the coin as FRESH in the parent
244 : : // cache. If it already existed and was spent in the parent
245 : : // cache then marking it FRESH would prevent that spentness
246 : : // from being flushed to the grandparent.
247 : : }
248 : : }
249 : : }
250 : 1 : hashBlock = hashBlockIn;
251 : 1 : return true;
252 : : }
253 : :
254 : 1 : bool CCoinsViewCache::Flush() {
255 : 1 : auto cursor{CoinsViewCacheCursor(cachedCoinsUsage, m_sentinel, cacheCoins, /*will_erase=*/true)};
256 : 1 : bool fOk = base->BatchWrite(cursor, hashBlock);
257 [ + - ]: 1 : if (fOk) {
258 : 1 : cacheCoins.clear();
259 : 1 : ReallocateCache();
260 : : }
261 : 1 : cachedCoinsUsage = 0;
262 : 1 : return fOk;
263 : : }
264 : :
265 : 0 : bool CCoinsViewCache::Sync()
266 : : {
267 : 0 : auto cursor{CoinsViewCacheCursor(cachedCoinsUsage, m_sentinel, cacheCoins, /*will_erase=*/false)};
268 : 0 : bool fOk = base->BatchWrite(cursor, hashBlock);
269 [ # # ]: 0 : if (fOk) {
270 [ # # ]: 0 : if (m_sentinel.second.Next() != &m_sentinel) {
271 : : /* BatchWrite must clear flags of all entries */
272 [ # # ]: 0 : throw std::logic_error("Not all unspent flagged entries were cleared");
273 : : }
274 : : }
275 : 0 : return fOk;
276 : : }
277 : :
278 : 0 : void CCoinsViewCache::Uncache(const COutPoint& hash)
279 : : {
280 : 0 : CCoinsMap::iterator it = cacheCoins.find(hash);
281 [ # # # # : 0 : if (it != cacheCoins.end() && !it->second.IsDirty() && !it->second.IsFresh()) {
# # ]
282 [ # # ]: 0 : cachedCoinsUsage -= it->second.coin.DynamicMemoryUsage();
283 : : TRACE5(utxocache, uncache,
284 : : hash.hash.data(),
285 : : (uint32_t)hash.n,
286 : : (uint32_t)it->second.coin.nHeight,
287 : : (int64_t)it->second.coin.out.nValue,
288 : 0 : (bool)it->second.coin.IsCoinBase());
289 : 0 : cacheCoins.erase(it);
290 : : }
291 : 0 : }
292 : :
293 : 4 : unsigned int CCoinsViewCache::GetCacheSize() const {
294 : 4 : return cacheCoins.size();
295 : : }
296 : :
297 : 0 : bool CCoinsViewCache::HaveInputs(const CTransaction& tx) const
298 : : {
299 [ # # ]: 0 : if (!tx.IsCoinBase()) {
300 [ # # ]: 0 : for (unsigned int i = 0; i < tx.vin.size(); i++) {
301 [ # # ]: 0 : if (!HaveCoin(tx.vin[i].prevout)) {
302 : : return false;
303 : : }
304 : : }
305 : : }
306 : : return true;
307 : : }
308 : :
309 : 1 : void CCoinsViewCache::ReallocateCache()
310 : : {
311 : : // Cache should be empty when we're calling this.
312 [ - + ]: 1 : assert(cacheCoins.size() == 0);
313 : 1 : cacheCoins.~CCoinsMap();
314 : 1 : m_cache_coins_memory_resource.~CCoinsMapMemoryResource();
315 : 1 : ::new (&m_cache_coins_memory_resource) CCoinsMapMemoryResource{};
316 : 1 : ::new (&cacheCoins) CCoinsMap{0, SaltedOutpointHasher{/*deterministic=*/m_deterministic}, CCoinsMap::key_equal{}, &m_cache_coins_memory_resource};
317 : 1 : }
318 : :
319 : 0 : void CCoinsViewCache::SanityCheck() const
320 : : {
321 : 0 : size_t recomputed_usage = 0;
322 : 0 : size_t count_flagged = 0;
323 [ # # # # ]: 0 : for (const auto& [_, entry] : cacheCoins) {
324 : 0 : unsigned attr = 0;
325 [ # # ]: 0 : if (entry.IsDirty()) attr |= 1;
326 [ # # ]: 0 : if (entry.IsFresh()) attr |= 2;
327 [ # # ]: 0 : if (entry.coin.IsSpent()) attr |= 4;
328 : : // Only 5 combinations are possible.
329 [ # # # # ]: 0 : assert(attr != 2 && attr != 4 && attr != 7);
330 : :
331 : : // Recompute cachedCoinsUsage.
332 [ # # ]: 0 : recomputed_usage += entry.coin.DynamicMemoryUsage();
333 : :
334 : : // Count the number of entries we expect in the linked list.
335 [ # # # # ]: 0 : if (entry.IsDirty() || entry.IsFresh()) ++count_flagged;
336 : : }
337 : : // Iterate over the linked list of flagged entries.
338 : 0 : size_t count_linked = 0;
339 [ # # ]: 0 : for (auto it = m_sentinel.second.Next(); it != &m_sentinel; it = it->second.Next()) {
340 : : // Verify linked list integrity.
341 [ # # ]: 0 : assert(it->second.Next()->second.Prev() == it);
342 [ # # ]: 0 : assert(it->second.Prev()->second.Next() == it);
343 : : // Verify they are actually flagged.
344 [ # # # # ]: 0 : assert(it->second.IsDirty() || it->second.IsFresh());
345 : : // Count the number of entries actually in the list.
346 : 0 : ++count_linked;
347 : : }
348 [ # # ]: 0 : assert(count_linked == count_flagged);
349 [ # # ]: 0 : assert(recomputed_usage == cachedCoinsUsage);
350 : 0 : }
351 : :
352 : : static const size_t MIN_TRANSACTION_OUTPUT_WEIGHT = WITNESS_SCALE_FACTOR * ::GetSerializeSize(CTxOut());
353 : : static const size_t MAX_OUTPUTS_PER_BLOCK = MAX_BLOCK_WEIGHT / MIN_TRANSACTION_OUTPUT_WEIGHT;
354 : :
355 : 0 : const Coin& AccessByTxid(const CCoinsViewCache& view, const Txid& txid)
356 : : {
357 : 0 : COutPoint iter(txid, 0);
358 [ # # ]: 0 : while (iter.n < MAX_OUTPUTS_PER_BLOCK) {
359 : 0 : const Coin& alternate = view.AccessCoin(iter);
360 [ # # ]: 0 : if (!alternate.IsSpent()) return alternate;
361 : 0 : ++iter.n;
362 : : }
363 : : return coinEmpty;
364 : : }
365 : :
366 : : template <typename Func>
367 : 0 : static bool ExecuteBackedWrapper(Func func, const std::vector<std::function<void()>>& err_callbacks)
368 : : {
369 : : try {
370 [ # # ]: 0 : return func();
371 [ - - ]: 0 : } catch(const std::runtime_error& e) {
372 [ - - ]: 0 : for (const auto& f : err_callbacks) {
373 [ - - ]: 0 : f();
374 : : }
375 [ - - ]: 0 : LogError("Error reading from database: %s\n", e.what());
376 : : // Starting the shutdown sequence and returning false to the caller would be
377 : : // interpreted as 'entry not found' (as opposed to unable to read data), and
378 : : // could lead to invalid interpretation. Just exit immediately, as we can't
379 : : // continue anyway, and all writes should be atomic.
380 : 0 : std::abort();
381 : : }
382 : : }
383 : :
384 : 0 : bool CCoinsViewErrorCatcher::GetCoin(const COutPoint &outpoint, Coin &coin) const {
385 : 0 : return ExecuteBackedWrapper([&]() { return CCoinsViewBacked::GetCoin(outpoint, coin); }, m_err_callbacks);
386 : : }
387 : :
388 : 0 : bool CCoinsViewErrorCatcher::HaveCoin(const COutPoint &outpoint) const {
389 [ # # ]: 0 : return ExecuteBackedWrapper([&]() { return CCoinsViewBacked::HaveCoin(outpoint); }, m_err_callbacks);
390 : : }
|
