// Copyright (c) 2009-2010 Satoshi Nakamoto

// Copyright (c) 2009-present The Bitcoin Core developers

// Distributed under the MIT software license, see the accompanying

// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include <chain.h>

#include <tinyformat.h>

#include <util/check.h>

std::string CBlockIndex::ToString() const

{

    return strprintf("CBlockIndex(pprev=%p, nHeight=%d, merkle=%s, hashBlock=%s)",

                     pprev, nHeight, hashMerkleRoot.ToString(), GetBlockHash().ToString());

}

void CChain::SetTip(CBlockIndex& block)

{

    CBlockIndex* pindex = █

    vChain.resize(pindex->nHeight + 1);

    while (pindex && vChain[pindex->nHeight] != pindex) {

  Branch (20:12): [True: 91.1M, False: 450k]
  Branch (20:22): [True: 91.1M, False: 64.5k]

        vChain[pindex->nHeight] = pindex;

        pindex = pindex->pprev;

    }

}

std::vector<uint256> LocatorEntries(const CBlockIndex* index)

{

    int step = 1;

    std::vector<uint256> have;

    if (index == nullptr) return have;

  Branch (30:9): [True: 0, False: 643k]

    have.reserve(32);

    while (index) {

  Branch (33:12): [True: 12.2M, False: 0]

        have.emplace_back(index->GetBlockHash());

        if (index->nHeight == 0) break;

  Branch (35:13): [True: 643k, False: 11.5M]

        // Exponentially larger steps back, plus the genesis block.

        int height = std::max(index->nHeight - step, 0);

        // Use skiplist.

        index = index->GetAncestor(height);

        if (have.size() > 10) step *= 2;

  Branch (40:13): [True: 5.14M, False: 6.43M]

    }

    return have;

}

CBlockLocator GetLocator(const CBlockIndex* index)

{

    return CBlockLocator{LocatorEntries(index)};

}

const CBlockIndex* CChain::FindFork(const CBlockIndex& index) const

{

    const auto* pindex{&index};

    if (pindex->nHeight > Height())

  Branch (53:9): [True: 37.8k, False: 36.6k]

        pindex = pindex->GetAncestor(Height());

    while (pindex && !Contains(*pindex))

  Branch (55:12): [True: 105k, False: 27]
  Branch (55:22): [True: 30.7k, False: 74.4k]

        pindex = pindex->pprev;

    return pindex;

}

CBlockIndex* CChain::FindEarliestAtLeast(int64_t nTime, int height) const

{

    std::pair<int64_t, int> blockparams = std::make_pair(nTime, height);

    std::vector<CBlockIndex*>::const_iterator lower = std::lower_bound(vChain.begin(), vChain.end(), blockparams,

        [](CBlockIndex* pBlock, const std::pair<int64_t, int>& blockparams) -> bool { return pBlock->GetBlockTimeMax() < blockparams.first || pBlock->nHeight < blockparams.second; });

  Branch (64:94): [True: 0, False: 0]
  Branch (64:143): [True: 0, False: 0]

    return (lower == vChain.end() ? nullptr : *lower);

  Branch (65:13): [True: 0, False: 0]

}

/** Turn the lowest '1' bit in the binary representation of a number into a '0'. */

int static inline InvertLowestOne(int n) { return n & (n - 1); }

/** Compute what height to jump back to with the CBlockIndex::pskip pointer. */

int static inline GetSkipHeight(int height) {

    if (height < 2)

  Branch (73:9): [True: 1.40M, False: 77.8M]

        return 0;

    // Determine which height to jump back to. Any number strictly lower than height is acceptable,

    // but the following expression seems to perform well in simulations (max 110 steps to go back

    // up to 2**18 blocks).

    return (height & 1) ? InvertLowestOne(InvertLowestOne(height - 1)) + 1 : InvertLowestOne(height);

  Branch (79:12): [True: 38.9M, False: 38.9M]

}

const CBlockIndex* CBlockIndex::GetAncestor(int height) const

{

    if (height > nHeight || height < 0) {

  Branch (84:9): [True: 5.69M, False: 115M]
  Branch (84:29): [True: 2.17k, False: 115M]

        return nullptr;

    }

    const CBlockIndex* pindexWalk = this;

    int heightWalk = nHeight;

    while (heightWalk > height) {

  Branch (90:12): [True: 39.5M, False: 115M]

        int heightSkip = GetSkipHeight(heightWalk);

        int heightSkipPrev = GetSkipHeight(heightWalk - 1);

        if (pindexWalk->pskip != nullptr &&

  Branch (93:13): [True: 39.5M, False: 2.28k]

            (heightSkip == height ||

  Branch (94:14): [True: 3.70M, False: 35.8M]

             (heightSkip > height && !(heightSkipPrev < heightSkip - 2 &&

  Branch (95:15): [True: 11.0M, False: 24.8M]
  Branch (95:40): [True: 1.29M, False: 9.73M]

                                       heightSkipPrev >= height)))) {

  Branch (96:40): [True: 91.7k, False: 1.20M]

            // Only follow pskip if pprev->pskip isn't better than pskip->pprev.

            pindexWalk = pindexWalk->pskip;

            heightWalk = heightSkip;

        } else {

            assert(pindexWalk->pprev);

  Branch (101:13): [True: 24.9M, False: 0]

            pindexWalk = pindexWalk->pprev;

            heightWalk--;

        }

    }

    return pindexWalk;

}

CBlockIndex* CBlockIndex::GetAncestor(int height)

{

    return const_cast<CBlockIndex*>(static_cast<const CBlockIndex*>(this)->GetAncestor(height));

}

void CBlockIndex::BuildSkip()

{

    if (pprev)

  Branch (116:9): [True: 107k, False: 0]

        pskip = pprev->GetAncestor(GetSkipHeight(nHeight));

}

arith_uint256 GetBitsProof(uint32_t bits)

{

    arith_uint256 bnTarget;

    bool fNegative;

    bool fOverflow;

    bnTarget.SetCompact(bits, &fNegative, &fOverflow);

    if (fNegative || fOverflow || bnTarget == 0)

  Branch (126:9): [True: 0, False: 816k]
  Branch (126:22): [True: 0, False: 816k]
  Branch (126:35): [True: 0, False: 816k]

        return 0;

    // We need to compute 2**256 / (bnTarget+1), but we can't represent 2**256

    // as it's too large for an arith_uint256. However, as 2**256 is at least as large

    // as bnTarget+1, it is equal to ((2**256 - bnTarget - 1) / (bnTarget+1)) + 1,

    // or ~bnTarget / (bnTarget+1) + 1.

    return (~bnTarget / (bnTarget + 1)) + 1;

}

int64_t GetBlockProofEquivalentTime(const CBlockIndex& to, const CBlockIndex& from, const CBlockIndex& tip, const Consensus::Params& params)

{

    arith_uint256 r;

    int sign = 1;

    if (to.nChainWork > from.nChainWork) {

  Branch (139:9): [True: 629, False: 508]

        r = to.nChainWork - from.nChainWork;

    } else {

        r = from.nChainWork - to.nChainWork;

        sign = -1;

    }

    r = r * arith_uint256(params.nPowTargetSpacing) / GetBlockProof(tip);

    if (r.bits() > 63) {

  Branch (146:9): [True: 0, False: 1.13k]

        return sign * std::numeric_limits<int64_t>::max();

    }

    return sign * int64_t(r.GetLow64());

}

/** Find the last common ancestor two blocks have.

 *  Both pa and pb must be non-nullptr. */

const CBlockIndex* LastCommonAncestor(const CBlockIndex* pa, const CBlockIndex* pb) {

    // First rewind to the last common height (the forking point cannot be past one of the two).

    if (pa->nHeight > pb->nHeight) {

  Branch (156:9): [True: 2.81M, False: 91.6M]

        pa = pa->GetAncestor(pb->nHeight);

    } else if (pb->nHeight > pa->nHeight) {

  Branch (158:16): [True: 0, False: 91.6M]

        pb = pb->GetAncestor(pa->nHeight);

    }

    while (pa != pb) {

  Branch (161:12): [True: 5.26M, False: 94.4M]

        // Jump back until pa and pb have a common "skip" ancestor.

        while (pa->pskip != pb->pskip) {

  Branch (163:16): [True: 210k, False: 5.26M]

            // This logic relies on the property that equal-height blocks have equal-height skip

            // pointers.

            Assume(pa->nHeight == pb->nHeight);

            Assume(pa->pskip->nHeight == pb->pskip->nHeight);

            pa = pa->pskip;

            pb = pb->pskip;

        }

        // At this point, pa and pb are different, but have equal pskip. The forking point lies in

        // between pa/pb on the one end, and pa->pskip/pb->pskip on the other end.

        pa = pa->pprev;

        pb = pb->pprev;

    }

    return pa;

}