LCOV - code coverage report
Current view: top level - src - blockencodings.cpp (source / functions) Coverage Total Hit
Test: total_coverage.info Lines: 92.5 % 107 99
Test Date: 2024-11-04 05:10:19 Functions: 100.0 % 6 6
Branches: 61.7 % 154 95

             Branch data     Line data    Source code
       1                 :             : // Copyright (c) 2016-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 <blockencodings.h>
       6                 :             : #include <chainparams.h>
       7                 :             : #include <common/system.h>
       8                 :             : #include <consensus/consensus.h>
       9                 :             : #include <consensus/validation.h>
      10                 :             : #include <crypto/sha256.h>
      11                 :             : #include <crypto/siphash.h>
      12                 :             : #include <logging.h>
      13                 :             : #include <random.h>
      14                 :             : #include <streams.h>
      15                 :             : #include <txmempool.h>
      16                 :             : #include <validation.h>
      17                 :             : 
      18                 :             : #include <unordered_map>
      19                 :             : 
      20                 :       98166 : CBlockHeaderAndShortTxIDs::CBlockHeaderAndShortTxIDs(const CBlock& block, const uint64_t nonce) :
      21                 :       98166 :         nonce(nonce),
      22         [ +  - ]:       98166 :         shorttxids(block.vtx.size() - 1), prefilledtxn(1), header(block) {
      23         [ +  - ]:       98166 :     FillShortTxIDSelector();
      24                 :             :     //TODO: Use our mempool prior to block acceptance to predictively fill more than just the coinbase
      25         [ -  + ]:       98166 :     prefilledtxn[0] = {0, block.vtx[0]};
      26         [ +  + ]:      143345 :     for (size_t i = 1; i < block.vtx.size(); i++) {
      27         [ +  - ]:       45179 :         const CTransaction& tx = *block.vtx[i];
      28         [ +  - ]:       45179 :         shorttxids[i - 1] = GetShortID(tx.GetWitnessHash());
      29                 :             :     }
      30         [ +  - ]:      294498 : }
      31                 :             : 
      32                 :      124223 : void CBlockHeaderAndShortTxIDs::FillShortTxIDSelector() const {
      33                 :      124223 :     DataStream stream{};
      34   [ +  -  +  - ]:      124223 :     stream << header << nonce;
      35         [ +  - ]:      124223 :     CSHA256 hasher;
      36         [ +  - ]:      124223 :     hasher.Write((unsigned char*)&(*stream.begin()), stream.end() - stream.begin());
      37                 :      124223 :     uint256 shorttxidhash;
      38         [ +  - ]:      124223 :     hasher.Finalize(shorttxidhash.begin());
      39                 :      124223 :     shorttxidk0 = shorttxidhash.GetUint64(0);
      40                 :      124223 :     shorttxidk1 = shorttxidhash.GetUint64(1);
      41                 :      124223 : }
      42                 :             : 
      43                 :      106695 : uint64_t CBlockHeaderAndShortTxIDs::GetShortID(const Wtxid& wtxid) const {
      44                 :      106695 :     static_assert(SHORTTXIDS_LENGTH == 6, "shorttxids calculation assumes 6-byte shorttxids");
      45                 :      106695 :     return SipHashUint256(shorttxidk0, shorttxidk1, wtxid) & 0xffffffffffffL;
      46                 :             : }
      47                 :             : 
      48                 :             : 
      49                 :             : 
      50                 :       20912 : ReadStatus PartiallyDownloadedBlock::InitData(const CBlockHeaderAndShortTxIDs& cmpctblock, const std::vector<CTransactionRef>& extra_txn) {
      51   [ +  -  +  +  :       20912 :     if (cmpctblock.header.IsNull() || (cmpctblock.shorttxids.empty() && cmpctblock.prefilledtxn.empty()))
                   +  - ]
      52                 :             :         return READ_STATUS_INVALID;
      53         [ +  - ]:       20912 :     if (cmpctblock.shorttxids.size() + cmpctblock.prefilledtxn.size() > MAX_BLOCK_WEIGHT / MIN_SERIALIZABLE_TRANSACTION_WEIGHT)
      54                 :             :         return READ_STATUS_INVALID;
      55                 :             : 
      56   [ +  -  +  - ]:       20912 :     if (!header.IsNull() || !txn_available.empty()) return READ_STATUS_INVALID;
      57                 :             : 
      58                 :       20912 :     header = cmpctblock.header;
      59                 :       20912 :     txn_available.resize(cmpctblock.BlockTxCount());
      60                 :             : 
      61                 :       20912 :     int32_t lastprefilledindex = -1;
      62         [ +  + ]:       41831 :     for (size_t i = 0; i < cmpctblock.prefilledtxn.size(); i++) {
      63         [ +  - ]:       20920 :         if (cmpctblock.prefilledtxn[i].tx->IsNull())
      64                 :             :             return READ_STATUS_INVALID;
      65                 :             : 
      66                 :       20920 :         lastprefilledindex += cmpctblock.prefilledtxn[i].index + 1; //index is a uint16_t, so can't overflow here
      67         [ +  - ]:       20920 :         if (lastprefilledindex > std::numeric_limits<uint16_t>::max())
      68                 :             :             return READ_STATUS_INVALID;
      69         [ +  + ]:       20920 :         if ((uint32_t)lastprefilledindex > cmpctblock.shorttxids.size() + i) {
      70                 :             :             // If we are inserting a tx at an index greater than our full list of shorttxids
      71                 :             :             // plus the number of prefilled txn we've inserted, then we have txn for which we
      72                 :             :             // have neither a prefilled txn or a shorttxid!
      73                 :             :             return READ_STATUS_INVALID;
      74                 :             :         }
      75                 :       20919 :         txn_available[lastprefilledindex] = cmpctblock.prefilledtxn[i].tx;
      76                 :             :     }
      77                 :       20911 :     prefilled_count = cmpctblock.prefilledtxn.size();
      78                 :             : 
      79                 :             :     // Calculate map of txids -> positions and check mempool to see what we have (or don't)
      80                 :             :     // Because well-formed cmpctblock messages will have a (relatively) uniform distribution
      81                 :             :     // of short IDs, any highly-uneven distribution of elements can be safely treated as a
      82                 :             :     // READ_STATUS_FAILED.
      83                 :       20911 :     std::unordered_map<uint64_t, uint16_t> shorttxids(cmpctblock.shorttxids.size());
      84                 :             :     uint16_t index_offset = 0;
      85         [ +  + ]:       32987 :     for (size_t i = 0; i < cmpctblock.shorttxids.size(); i++) {
      86         [ +  + ]:       12936 :         while (txn_available[i + index_offset])
      87                 :         860 :             index_offset++;
      88         [ +  - ]:       12076 :         shorttxids[cmpctblock.shorttxids[i]] = i + index_offset;
      89                 :             :         // To determine the chance that the number of entries in a bucket exceeds N,
      90                 :             :         // we use the fact that the number of elements in a single bucket is
      91                 :             :         // binomially distributed (with n = the number of shorttxids S, and p =
      92                 :             :         // 1 / the number of buckets), that in the worst case the number of buckets is
      93                 :             :         // equal to S (due to std::unordered_map having a default load factor of 1.0),
      94                 :             :         // and that the chance for any bucket to exceed N elements is at most
      95                 :             :         // buckets * (the chance that any given bucket is above N elements).
      96                 :             :         // Thus: P(max_elements_per_bucket > N) <= S * (1 - cdf(binomial(n=S,p=1/S), N)).
      97                 :             :         // If we assume blocks of up to 16000, allowing 12 elements per bucket should
      98                 :             :         // only fail once per ~1 million block transfers (per peer and connection).
      99         [ +  - ]:       12076 :         if (shorttxids.bucket_size(shorttxids.bucket(cmpctblock.shorttxids[i])) > 12)
     100                 :             :             return READ_STATUS_FAILED;
     101                 :             :     }
     102                 :             :     // TODO: in the shortid-collision case, we should instead request both transactions
     103                 :             :     // which collided. Falling back to full-block-request here is overkill.
     104         [ +  - ]:       20911 :     if (shorttxids.size() != cmpctblock.shorttxids.size())
     105                 :             :         return READ_STATUS_FAILED; // Short ID collision
     106                 :             : 
     107   [ +  -  +  - ]:       41822 :     std::vector<bool> have_txn(txn_available.size());
     108                 :       20911 :     {
     109         [ +  - ]:       20911 :     LOCK(pool->cs);
     110         [ +  + ]:       79919 :     for (const auto& tx : pool->txns_randomized) {
     111         [ +  - ]:       59328 :         uint64_t shortid = cmpctblock.GetShortID(tx->GetWitnessHash());
     112                 :       59328 :         std::unordered_map<uint64_t, uint16_t>::iterator idit = shorttxids.find(shortid);
     113         [ +  + ]:       59328 :         if (idit != shorttxids.end()) {
     114         [ +  - ]:        9987 :             if (!have_txn[idit->second]) {
     115                 :        9987 :                 txn_available[idit->second] = tx;
     116                 :        9987 :                 have_txn[idit->second]  = true;
     117                 :        9987 :                 mempool_count++;
     118                 :             :             } else {
     119                 :             :                 // If we find two mempool txn that match the short id, just request it.
     120                 :             :                 // This should be rare enough that the extra bandwidth doesn't matter,
     121                 :             :                 // but eating a round-trip due to FillBlock failure would be annoying
     122         [ #  # ]:           0 :                 if (txn_available[idit->second]) {
     123                 :           0 :                     txn_available[idit->second].reset();
     124                 :           0 :                     mempool_count--;
     125                 :             :                 }
     126                 :             :             }
     127                 :             :         }
     128                 :             :         // Though ideally we'd continue scanning for the two-txn-match-shortid case,
     129                 :             :         // the performance win of an early exit here is too good to pass up and worth
     130                 :             :         // the extra risk.
     131         [ +  + ]:       59328 :         if (mempool_count == shorttxids.size())
     132                 :             :             break;
     133                 :             :     }
     134                 :           0 :     }
     135                 :             : 
     136         [ +  + ]:       31335 :     for (size_t i = 0; i < extra_txn.size(); i++) {
     137         [ +  + ]:       10985 :         if (extra_txn[i] == nullptr) {
     138                 :        8800 :             continue;
     139                 :             :         }
     140         [ +  - ]:        2185 :         uint64_t shortid = cmpctblock.GetShortID(extra_txn[i]->GetWitnessHash());
     141                 :        2185 :         std::unordered_map<uint64_t, uint16_t>::iterator idit = shorttxids.find(shortid);
     142         [ +  + ]:        2185 :         if (idit != shorttxids.end()) {
     143         [ +  + ]:         101 :             if (!have_txn[idit->second]) {
     144                 :         100 :                 txn_available[idit->second] = extra_txn[i];
     145                 :         100 :                 have_txn[idit->second]  = true;
     146                 :         100 :                 mempool_count++;
     147                 :         100 :                 extra_count++;
     148                 :             :             } else {
     149                 :             :                 // If we find two mempool/extra txn that match the short id, just
     150                 :             :                 // request it.
     151                 :             :                 // This should be rare enough that the extra bandwidth doesn't matter,
     152                 :             :                 // but eating a round-trip due to FillBlock failure would be annoying
     153                 :             :                 // Note that we don't want duplication between extra_txn and mempool to
     154                 :             :                 // trigger this case, so we compare witness hashes first
     155   [ +  -  -  + ]:           1 :                 if (txn_available[idit->second] &&
     156   [ +  -  -  + ]:           1 :                         txn_available[idit->second]->GetWitnessHash() != extra_txn[i]->GetWitnessHash()) {
     157                 :           0 :                     txn_available[idit->second].reset();
     158                 :           0 :                     mempool_count--;
     159                 :           0 :                     extra_count--;
     160                 :             :                 }
     161                 :             :             }
     162                 :             :         }
     163                 :             :         // Though ideally we'd continue scanning for the two-txn-match-shortid case,
     164                 :             :         // the performance win of an early exit here is too good to pass up and worth
     165                 :             :         // the extra risk.
     166         [ +  + ]:        2185 :         if (mempool_count == shorttxids.size())
     167                 :             :             break;
     168                 :             :     }
     169                 :             : 
     170   [ +  -  +  -  :       41822 :     LogDebug(BCLog::CMPCTBLOCK, "Initialized PartiallyDownloadedBlock for block %s using a cmpctblock of size %lu\n", cmpctblock.header.GetHash().ToString(), GetSerializeSize(cmpctblock));
          +  -  +  -  +  
                -  +  - ]
     171                 :             : 
     172                 :       20911 :     return READ_STATUS_OK;
     173                 :       41822 : }
     174                 :             : 
     175                 :       32994 : bool PartiallyDownloadedBlock::IsTxAvailable(size_t index) const
     176                 :             : {
     177         [ +  - ]:       32994 :     if (header.IsNull()) return false;
     178                 :             : 
     179         [ -  + ]:       32994 :     assert(index < txn_available.size());
     180                 :       32994 :     return txn_available[index] != nullptr;
     181                 :             : }
     182                 :             : 
     183                 :       20899 : ReadStatus PartiallyDownloadedBlock::FillBlock(CBlock& block, const std::vector<CTransactionRef>& vtx_missing)
     184                 :             : {
     185         [ +  - ]:       20899 :     if (header.IsNull()) return READ_STATUS_INVALID;
     186                 :             : 
     187                 :       20899 :     uint256 hash = header.GetHash();
     188                 :       20899 :     block = header;
     189                 :       20899 :     block.vtx.resize(txn_available.size());
     190                 :             : 
     191                 :       20899 :     size_t tx_missing_offset = 0;
     192         [ +  + ]:       53789 :     for (size_t i = 0; i < txn_available.size(); i++) {
     193         [ +  + ]:       32892 :         if (!txn_available[i]) {
     194         [ +  + ]:        1904 :             if (vtx_missing.size() <= tx_missing_offset)
     195                 :             :                 return READ_STATUS_INVALID;
     196                 :        1902 :             block.vtx[i] = vtx_missing[tx_missing_offset++];
     197                 :             :         } else
     198                 :       30988 :             block.vtx[i] = std::move(txn_available[i]);
     199                 :             :     }
     200                 :             : 
     201                 :             :     // Make sure we can't call FillBlock again.
     202                 :       20897 :     header.SetNull();
     203                 :       20897 :     txn_available.clear();
     204                 :             : 
     205         [ +  - ]:       20897 :     if (vtx_missing.size() != tx_missing_offset)
     206                 :             :         return READ_STATUS_INVALID;
     207                 :             : 
     208         [ -  + ]:       20897 :     BlockValidationState state;
     209   [ -  +  -  - ]:       20897 :     CheckBlockFn check_block = m_check_block_mock ? m_check_block_mock : CheckBlock;
     210   [ +  -  +  -  :       20897 :     if (!check_block(block, state, Params().GetConsensus(), /*fCheckPoW=*/true, /*fCheckMerkleRoot=*/true)) {
                   +  + ]
     211                 :             :         // TODO: We really want to just check merkle tree manually here,
     212                 :             :         // but that is expensive, and CheckBlock caches a block's
     213                 :             :         // "checked-status" (in the CBlock?). CBlock should be able to
     214                 :             :         // check its own merkle root and cache that check.
     215         [ -  + ]:           3 :         if (state.GetResult() == BlockValidationResult::BLOCK_MUTATED)
     216                 :             :             return READ_STATUS_FAILED; // Possible Short ID collision
     217                 :           0 :         return READ_STATUS_CHECKBLOCK_FAILED;
     218                 :             :     }
     219                 :             : 
     220   [ +  -  +  -  :       41788 :     LogDebug(BCLog::CMPCTBLOCK, "Successfully reconstructed block %s with %lu txn prefilled, %lu txn from mempool (incl at least %lu from extra pool) and %lu txn requested\n", hash.ToString(), prefilled_count, mempool_count, extra_count, vtx_missing.size());
             +  -  +  - ]
     221         [ +  + ]:       20894 :     if (vtx_missing.size() < 5) {
     222         [ +  + ]:       21526 :         for (const auto& tx : vtx_missing) {
     223   [ +  -  +  -  :        1314 :             LogDebug(BCLog::CMPCTBLOCK, "Reconstructed block %s required tx %s\n", hash.ToString(), tx->GetHash().ToString());
          +  -  +  -  +  
                      - ]
     224                 :             :         }
     225                 :             :     }
     226                 :             : 
     227                 :             :     return READ_STATUS_OK;
     228                 :       41794 : }
        

Generated by: LCOV version 2.0-1