nimbus-eth2/beacon_chain/block_pools/quarantine.nim

# beacon_chain
# Copyright (c) 2018-2020 Status Research & Development GmbH
# Licensed and distributed under either of
#   * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
#   * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
# at your option. This file may not be copied, modified, or distributed except according to those terms.

import
  chronicles, tables, options,
  stew/bitops2,
  metrics,
  ../spec/[datatypes, digest],
  block_pools_types

export options, block_pools_types

logScope:
  topics = "quarant"

{.push raises: [Defect].}

func checkMissing*(quarantine: var QuarantineRef): seq[FetchRecord] =
  ## Return a list of blocks that we should try to resolve from other client -
  ## to be called periodically but not too often (once per slot?)
  var done: seq[Eth2Digest]

  for k, v in quarantine.missing.mpairs():
    if v.tries > 8:
      done.add(k)
    else:
      inc v.tries

  for k in done:
    # TODO Need to potentially remove from quarantine.pending - this is currently a
    #      memory leak here!
    quarantine.missing.del(k)

  # simple (simplistic?) exponential backoff for retries..
  for k, v in quarantine.missing.pairs():
    if countOnes(v.tries.uint64) == 1:
      result.add(FetchRecord(root: k))

func addMissing*(quarantine: var QuarantineRef, broot: Eth2Digest) {.inline.} =
  if broot notin quarantine.orphans:
    discard quarantine.missing.hasKeyOrPut(broot, MissingBlock())

func add*(quarantine: var QuarantineRef, dag: ChainDAGRef,
          sblck: SignedBeaconBlock) =
  ## Adds block to quarantine's `orphans` and `missing` lists.
  quarantine.orphans[sblck.root] = sblck
  quarantine.missing.del(sblck.root)

  let parentRoot = sblck.message.parent_root
  if parentRoot notin quarantine.orphans:
    quarantine.addMissing(parentRoot)