status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Clarify addOrphan error/logging (#4981) 

* Clarify addOrphan error/logging

addOrphan returned a bool to indicate success. Change this to a Result
so that different errors can be distinguished.

* Update beacon_chain/consensus_object_pools/block_quarantine.nim

Co-authored-by: tersec <tersec@users.noreply.github.com>

* Update beacon_chain/gossip_processing/gossip_validation.nim

---------

Co-authored-by: tersec <tersec@users.noreply.github.com>
This commit is contained in:
henridf 2023-05-21 19:47:00 +02:00 committed by GitHub
parent cd087b9a43
commit 5ef748b19d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
beacon_chain/consensus_object_pools/block_quarantine.nim
View File

@ -251,11 +251,11 @@ func clearAfterReorg*(quarantine: var Quarantine) =
# likely imminent arrival. # likely imminent arrival.
func addOrphan*( func addOrphan*(
quarantine: var Quarantine, finalizedSlot: Slot, quarantine: var Quarantine, finalizedSlot: Slot,
signedBlock: ForkedSignedBeaconBlock): bool = signedBlock: ForkedSignedBeaconBlock): Result[void, cstring] =
## Adds block to quarantine's `orphans` and `missing` lists. ## Adds block to quarantine's `orphans` and `missing` lists.
if not isViable(finalizedSlot, getForkedBlockField(signedBlock, slot)): if not isViable(finalizedSlot, getForkedBlockField(signedBlock, slot)):
quarantine.addUnviable(signedBlock.root) quarantine.addUnviable(signedBlock.root)
return false return err("block unviable")
quarantine.cleanupOrphans(finalizedSlot) quarantine.cleanupOrphans(finalizedSlot)
@ -263,19 +263,19 @@ func addOrphan*(
if parent_root in quarantine.unviable: if parent_root in quarantine.unviable:
quarantine.unviable[signedBlock.root] = () quarantine.unviable[signedBlock.root] = ()
return true return ok()
# Even if the quarantine is full, we need to schedule its parent for # Even if the quarantine is full, we need to schedule its parent for
# downloading or we'll never get to the bottom of things # downloading or we'll never get to the bottom of things
quarantine.addMissing(parent_root) quarantine.addMissing(parent_root)
if quarantine.orphans.lenu64 >= MaxOrphans: if quarantine.orphans.lenu64 >= MaxOrphans:
return false return err("block quarantine full")
quarantine.orphans[(signedBlock.root, signedBlock.signature)] = signedBlock quarantine.orphans[(signedBlock.root, signedBlock.signature)] = signedBlock
quarantine.missing.del(signedBlock.root) quarantine.missing.del(signedBlock.root)
true ok()
iterator pop*(quarantine: var Quarantine, root: Eth2Digest): iterator pop*(quarantine: var Quarantine, root: Eth2Digest):
ForkedSignedBeaconBlock = ForkedSignedBeaconBlock =

10
beacon_chain/gossip_processing/block_processor.nim
View File

@ -520,12 +520,14 @@ proc storeBlock*(
return err((VerifierError.UnviableFork, ProcessingStatus.completed)) return err((VerifierError.UnviableFork, ProcessingStatus.completed))
if not self.consensusManager.quarantine[].addOrphan( if (let r = self.consensusManager.quarantine[].addOrphan(
dag.finalizedHead.slot, ForkedSignedBeaconBlock.init(signedBlock)): dag.finalizedHead.slot, ForkedSignedBeaconBlock.init(signedBlock));
debug "Block quarantine full", r.isErr()):
debug "storeBlock: could not add orphan",
blockRoot = shortLog(signedBlock.root), blockRoot = shortLog(signedBlock.root),
blck = shortLog(signedBlock.message), blck = shortLog(signedBlock.message),
signature = shortLog(signedBlock.signature) signature = shortLog(signedBlock.signature),
err = r.error()
of VerifierError.UnviableFork: of VerifierError.UnviableFork:
# Track unviables so that descendants can be discarded properly # Track unviables so that descendants can be discarded properly
self.consensusManager.quarantine[].addUnviable(signedBlock.root) self.consensusManager.quarantine[].addUnviable(signedBlock.root)

9
beacon_chain/gossip_processing/gossip_validation.nim
View File

@ -457,10 +457,13 @@ proc validateBeaconBlock*(
# When the parent is missing, we can't validate the block - we'll queue it # When the parent is missing, we can't validate the block - we'll queue it
# in the quarantine for later processing # in the quarantine for later processing
if not quarantine[].addOrphan( if (let r = quarantine[].addOrphan(
dag.finalizedHead.slot, dag.finalizedHead.slot,
ForkedSignedBeaconBlock.init(signed_beacon_block)): ForkedSignedBeaconBlock.init(signed_beacon_block)); r.isErr):
debug "Block quarantine full" debug "validateBeaconBlock: could not add orphan",
blockRoot = shortLog(signed_beacon_block.root),
blck = shortLog(signed_beacon_block.message),
err = r.error()
return errIgnore("BeaconBlock: Parent not found") return errIgnore("BeaconBlock: Parent not found")

8
tests/test_block_quarantine.nim
View File

@ -44,13 +44,13 @@ suite "Block quarantine":
check: check:
FetchRecord(root: b1.root) in quarantine.checkMissing() FetchRecord(root: b1.root) in quarantine.checkMissing()
quarantine.addOrphan(Slot 0, b1) quarantine.addOrphan(Slot 0, b1).isOk
FetchRecord(root: b1.root) notin quarantine.checkMissing() FetchRecord(root: b1.root) notin quarantine.checkMissing()
quarantine.addOrphan(Slot 0, b2) quarantine.addOrphan(Slot 0, b2).isOk
quarantine.addOrphan(Slot 0, b3) quarantine.addOrphan(Slot 0, b3).isOk
quarantine.addOrphan(Slot 0, b4) quarantine.addOrphan(Slot 0, b4).isOk
quarantine.addBlobless(Slot 0, b5) quarantine.addBlobless(Slot 0, b5)
quarantine.addBlobless(Slot 0, b6) quarantine.addBlobless(Slot 0, b6)