src/chain.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2014 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 #ifndef BITCOIN_CHAIN_H
   7 #define BITCOIN_CHAIN_H
   8
   9 #include "arith_uint256.h"
  10 #include "primitives/block.h"
  11 #include "pow.h"
  12 #include "tinyformat.h"
  13 #include "uint256.h"
  14
  15 #include <vector>
  16
  17 #include <boost/foreach.hpp>
  18
  19 struct CDiskBlockPos
  20 {
  21     int nFile;
  22     unsigned int nPos;
  23
  24     ADD_SERIALIZE_METHODS;
  25
  26     template <typename Stream, typename Operation>
  27     inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion) {
  28         READWRITE(VARINT(nFile));
  29         READWRITE(VARINT(nPos));
  30     }
  31
  32     CDiskBlockPos() {
  33         SetNull();
  34     }
  35
  36     CDiskBlockPos(int nFileIn, unsigned int nPosIn) {
  37         nFile = nFileIn;
  38         nPos = nPosIn;
  39     }
  40
  41     friend bool operator==(const CDiskBlockPos &a, const CDiskBlockPos &b) {
  42         return (a.nFile == b.nFile && a.nPos == b.nPos);
  43     }
  44
  45     friend bool operator!=(const CDiskBlockPos &a, const CDiskBlockPos &b) {
  46         return !(a == b);
  47     }
  48
  49     void SetNull() { nFile = -1; nPos = 0; }
  50     bool IsNull() const { return (nFile == -1); }
  51
  52     std::string ToString() const
  53     {
  54         return strprintf("CBlockDiskPos(nFile=%i, nPos=%i)", nFile, nPos);
  55     }
  56
  57 };
  58
  59 enum BlockStatus {
  60     //! Unused.
  61     BLOCK_VALID_UNKNOWN      =    0,
  62
  63     //! Parsed, version ok, hash satisfies claimed PoW, 1 <= vtx count <= max, timestamp not in future
  64     BLOCK_VALID_HEADER       =    1,
  65
  66     //! All parent headers found, difficulty matches, timestamp >= median previous, checkpoint. Implies all parents
  67     //! are also at least TREE.
  68     BLOCK_VALID_TREE         =    2,
  69
  70     /**
  71      * Only first tx is coinbase, 2 <= coinbase input script length <= 100, transactions valid, no duplicate txids,
  72      * sigops, size, merkle root. Implies all parents are at least TREE but not necessarily TRANSACTIONS. When all
  73      * parent blocks also have TRANSACTIONS, CBlockIndex::nChainTx will be set.
  74      */
  75     BLOCK_VALID_TRANSACTIONS =    3,
  76
  77     //! Outputs do not overspend inputs, no double spends, coinbase output ok, no immature coinbase spends, BIP30.
  78     //! Implies all parents are also at least CHAIN.
  79     BLOCK_VALID_CHAIN        =    4,
  80
  81     //! Scripts & signatures ok. Implies all parents are also at least SCRIPTS.
  82     BLOCK_VALID_SCRIPTS      =    5,
  83
  84     //! All validity bits.
  85     BLOCK_VALID_MASK         =   BLOCK_VALID_HEADER | BLOCK_VALID_TREE | BLOCK_VALID_TRANSACTIONS |
  86                                  BLOCK_VALID_CHAIN | BLOCK_VALID_SCRIPTS,
  87
  88     BLOCK_HAVE_DATA          =    8, //! full block available in blk*.dat
  89     BLOCK_HAVE_UNDO          =   16, //! undo data available in rev*.dat
  90     BLOCK_HAVE_MASK          =   BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO,
  91
  92     BLOCK_FAILED_VALID       =   32, //! stage after last reached validness failed
  93     BLOCK_FAILED_CHILD       =   64, //! descends from failed block
  94     BLOCK_FAILED_MASK        =   BLOCK_FAILED_VALID | BLOCK_FAILED_CHILD,
  95 };
  96
  97 /** The block chain is a tree shaped structure starting with the
  98  * genesis block at the root, with each block potentially having multiple
  99  * candidates to be the next block. A blockindex may have multiple pprev pointing
 100  * to it, but at most one of them can be part of the currently active branch.
 101  */
 102 class CBlockIndex
 103 {
 104 public:
 105     //! pointer to the hash of the block, if any. Memory is owned by this CBlockIndex
 106     const uint256* phashBlock;
 107
 108     //! pointer to the index of the predecessor of this block
 109     CBlockIndex* pprev;
 110
 111     //! pointer to the index of some further predecessor of this block
 112     CBlockIndex* pskip;
 113
 114     //! height of the entry in the chain. The genesis block has height 0
 115     int nHeight;
 116
 117     //! Which # file this block is stored in (blk?????.dat)
 118     int nFile;
 119
 120     //! Byte offset within blk?????.dat where this block's data is stored
 121     unsigned int nDataPos;
 122
 123     //! Byte offset within rev?????.dat where this block's undo data is stored
 124     unsigned int nUndoPos;
 125
 126     //! (memory only) Total amount of work (expected number of hashes) in the chain up to and including this block
 127     arith_uint256 nChainWork;
 128
 129     //! Number of transactions in this block.
 130     //! Note: in a potential headers-first mode, this number cannot be relied upon
 131     unsigned int nTx;
 132
 133     //! (memory only) Number of transactions in the chain up to and including this block.
 134     //! This value will be non-zero only if and only if transactions for this block and all its parents are available.
 135     //! Change to 64-bit type when necessary; won't happen before 2030
 136     unsigned int nChainTx;
 137
 138     //! Verification status of this block. See enum BlockStatus
 139     unsigned int nStatus;
 140
 141     //! block header
 142     int nVersion;
 143     uint256 hashMerkleRoot;
 144     uint256 hashReserved;
 145     unsigned int nTime;
 146     unsigned int nBits;
 147     uint256 nNonce;
 148     std::vector<uint32_t> nSolution;
 149
 150     //! (memory only) Sequential id assigned to distinguish order in which blocks are received.
 151     uint32_t nSequenceId;
 152
 153     void SetNull()
 154     {
 155         phashBlock = NULL;
 156         pprev = NULL;
 157         pskip = NULL;
 158         nHeight = 0;
 159         nFile = 0;
 160         nDataPos = 0;
 161         nUndoPos = 0;
 162         nChainWork = arith_uint256();
 163         nTx = 0;
 164         nChainTx = 0;
 165         nStatus = 0;
 166         nSequenceId = 0;
 167
 168         nVersion       = 0;
 169         hashMerkleRoot = uint256();
 170         hashReserved   = uint256();
 171         nTime          = 0;
 172         nBits          = 0;
 173         nNonce         = uint256();
 174         nSolution.clear();
 175     }
 176
 177     CBlockIndex()
 178     {
 179         SetNull();
 180     }
 181
 182     CBlockIndex(const CBlockHeader& block)
 183     {
 184         SetNull();
 185
 186         nVersion       = block.nVersion;
 187         hashMerkleRoot = block.hashMerkleRoot;
 188         hashReserved   = block.hashReserved;
 189         nTime          = block.nTime;
 190         nBits          = block.nBits;
 191         nNonce         = block.nNonce;
 192         nSolution      = block.nSolution;
 193     }
 194
 195     CDiskBlockPos GetBlockPos() const {
 196         CDiskBlockPos ret;
 197         if (nStatus & BLOCK_HAVE_DATA) {
 198             ret.nFile = nFile;
 199             ret.nPos  = nDataPos;
 200         }
 201         return ret;
 202     }
 203
 204     CDiskBlockPos GetUndoPos() const {
 205         CDiskBlockPos ret;
 206         if (nStatus & BLOCK_HAVE_UNDO) {
 207             ret.nFile = nFile;
 208             ret.nPos  = nUndoPos;
 209         }
 210         return ret;
 211     }
 212
 213     CBlockHeader GetBlockHeader() const
 214     {
 215         CBlockHeader block;
 216         block.nVersion       = nVersion;
 217         if (pprev)
 218             block.hashPrevBlock = pprev->GetBlockHash();
 219         block.hashMerkleRoot = hashMerkleRoot;
 220         block.hashReserved   = hashReserved;
 221         block.nTime          = nTime;
 222         block.nBits          = nBits;
 223         block.nNonce         = nNonce;
 224         block.nSolution      = nSolution;
 225         return block;
 226     }
 227
 228     uint256 GetBlockHash() const
 229     {
 230         return *phashBlock;
 231     }
 232
 233     int64_t GetBlockTime() const
 234     {
 235         return (int64_t)nTime;
 236     }
 237
 238     enum { nMedianTimeSpan=11 };
 239
 240     int64_t GetMedianTimePast() const
 241     {
 242         int64_t pmedian[nMedianTimeSpan];
 243         int64_t* pbegin = &pmedian[nMedianTimeSpan];
 244         int64_t* pend = &pmedian[nMedianTimeSpan];
 245
 246         const CBlockIndex* pindex = this;
 247         for (int i = 0; i < nMedianTimeSpan && pindex; i++, pindex = pindex->pprev)
 248             *(--pbegin) = pindex->GetBlockTime();
 249
 250         std::sort(pbegin, pend);
 251         return pbegin[(pend - pbegin)/2];
 252     }
 253
 254     std::string ToString() const
 255     {
 256         return strprintf("CBlockIndex(pprev=%p, nHeight=%d, merkle=%s, hashBlock=%s)",
 257             pprev, nHeight,
 258             hashMerkleRoot.ToString(),
 259             GetBlockHash().ToString());
 260     }
 261
 262     //! Check whether this block index entry is valid up to the passed validity level.
 263     bool IsValid(enum BlockStatus nUpTo = BLOCK_VALID_TRANSACTIONS) const
 264     {
 265         assert(!(nUpTo & ~BLOCK_VALID_MASK)); // Only validity flags allowed.
 266         if (nStatus & BLOCK_FAILED_MASK)
 267             return false;
 268         return ((nStatus & BLOCK_VALID_MASK) >= nUpTo);
 269     }
 270
 271     //! Raise the validity level of this block index entry.
 272     //! Returns true if the validity was changed.
 273     bool RaiseValidity(enum BlockStatus nUpTo)
 274     {
 275         assert(!(nUpTo & ~BLOCK_VALID_MASK)); // Only validity flags allowed.
 276         if (nStatus & BLOCK_FAILED_MASK)
 277             return false;
 278         if ((nStatus & BLOCK_VALID_MASK) < nUpTo) {
 279             nStatus = (nStatus & ~BLOCK_VALID_MASK) | nUpTo;
 280             return true;
 281         }
 282         return false;
 283     }
 284
 285     //! Build the skiplist pointer for this entry.
 286     void BuildSkip();
 287
 288     //! Efficiently find an ancestor of this block.
 289     CBlockIndex* GetAncestor(int height);
 290     const CBlockIndex* GetAncestor(int height) const;
 291 };
 292
 293 /** Used to marshal pointers into hashes for db storage. */
 294 class CDiskBlockIndex : public CBlockIndex
 295 {
 296 public:
 297     uint256 hashPrev;
 298
 299     CDiskBlockIndex() {
 300         hashPrev = uint256();
 301     }
 302
 303     explicit CDiskBlockIndex(const CBlockIndex* pindex) : CBlockIndex(*pindex) {
 304         hashPrev = (pprev ? pprev->GetBlockHash() : uint256());
 305     }
 306
 307     ADD_SERIALIZE_METHODS;
 308
 309     template <typename Stream, typename Operation>
 310     inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion) {
 311         if (!(nType & SER_GETHASH))
 312             READWRITE(VARINT(nVersion));
 313
 314         READWRITE(VARINT(nHeight));
 315         READWRITE(VARINT(nStatus));
 316         READWRITE(VARINT(nTx));
 317         if (nStatus & (BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO))
 318             READWRITE(VARINT(nFile));
 319         if (nStatus & BLOCK_HAVE_DATA)
 320             READWRITE(VARINT(nDataPos));
 321         if (nStatus & BLOCK_HAVE_UNDO)
 322             READWRITE(VARINT(nUndoPos));
 323
 324         // block header
 325         READWRITE(this->nVersion);
 326         READWRITE(hashPrev);
 327         READWRITE(hashMerkleRoot);
 328         READWRITE(hashReserved);
 329         READWRITE(nTime);
 330         READWRITE(nBits);
 331         READWRITE(nNonce);
 332         READWRITE(nSolution);
 333     }
 334
 335     uint256 GetBlockHash() const
 336     {
 337         CBlockHeader block;
 338         block.nVersion        = nVersion;
 339         block.hashPrevBlock   = hashPrev;
 340         block.hashMerkleRoot  = hashMerkleRoot;
 341         block.hashReserved    = hashReserved;
 342         block.nTime           = nTime;
 343         block.nBits           = nBits;
 344         block.nNonce          = nNonce;
 345         block.nSolution       = nSolution;
 346         return block.GetHash();
 347     }
 348
 349
 350     std::string ToString() const
 351     {
 352         std::string str = "CDiskBlockIndex(";
 353         str += CBlockIndex::ToString();
 354         str += strprintf("\n                hashBlock=%s, hashPrev=%s)",
 355             GetBlockHash().ToString(),
 356             hashPrev.ToString());
 357         return str;
 358     }
 359 };
 360
 361 /** An in-memory indexed chain of blocks. */
 362 class CChain {
 363 private:
 364     std::vector<CBlockIndex*> vChain;
 365
 366 public:
 367     /** Returns the index entry for the genesis block of this chain, or NULL if none. */
 368     CBlockIndex *Genesis() const {
 369         return vChain.size() > 0 ? vChain[0] : NULL;
 370     }
 371
 372     /** Returns the index entry for the tip of this chain, or NULL if none. */
 373     CBlockIndex *Tip() const {
 374         return vChain.size() > 0 ? vChain[vChain.size() - 1] : NULL;
 375     }
 376
 377     /** Returns the index entry at a particular height in this chain, or NULL if no such height exists. */
 378     CBlockIndex *operator[](int nHeight) const {
 379         if (nHeight < 0 || nHeight >= (int)vChain.size())
 380             return NULL;
 381         return vChain[nHeight];
 382     }
 383
 384     /** Compare two chains efficiently. */
 385     friend bool operator==(const CChain &a, const CChain &b) {
 386         return a.vChain.size() == b.vChain.size() &&
 387                a.vChain[a.vChain.size() - 1] == b.vChain[b.vChain.size() - 1];
 388     }
 389
 390     /** Efficiently check whether a block is present in this chain. */
 391     bool Contains(const CBlockIndex *pindex) const {
 392         return (*this)[pindex->nHeight] == pindex;
 393     }
 394
 395     /** Find the successor of a block in this chain, or NULL if the given index is not found or is the tip. */
 396     CBlockIndex *Next(const CBlockIndex *pindex) const {
 397         if (Contains(pindex))
 398             return (*this)[pindex->nHeight + 1];
 399         else
 400             return NULL;
 401     }
 402
 403     /** Return the maximal height in the chain. Is equal to chain.Tip() ? chain.Tip()->nHeight : -1. */
 404     int Height() const {
 405         return vChain.size() - 1;
 406     }
 407
 408     /** Set/initialize a chain with a given tip. */
 409     void SetTip(CBlockIndex *pindex);
 410
 411     /** Return a CBlockLocator that refers to a block in this chain (by default the tip). */
 412     CBlockLocator GetLocator(const CBlockIndex *pindex = NULL) const;
 413
 414     /** Find the last common block between this chain and a block index entry. */
 415     const CBlockIndex *FindFork(const CBlockIndex *pindex) const;
 416 };
 417
 418 #endif // BITCOIN_CHAIN_H