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