mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-01-14 22:34:23 +00:00
ea268e81ff
* Clarifying/commenting FCU setup condition & small fixes, comments etc. * Update some logging * Reorg metrics updater and activation * Better `async` responsiveness why: Block import does not allow `async` task activation while executing. So allow potential switch after each imported block (rather than a group of 32 blocks.) * Handle resuming after previous sync followed by import why: In this case the ledger state is more recent than the saved sync state. So this is considered a pristine sync where any previous sync state is forgotten. This fixes some assert thrown because of inconsistent internal state at some point. * Provide option for clearing saved beacon sync state before starting syncer why: It would resume with the last state otherwise which might be undesired sometimes. Without RPC available, the syncer typically stops and terminates with the canonical head larger than the base/finalised head. The latter one will be saved as database/ledger state and the canonical head as syncer target. Resuming syncing here will repeat itself. So clearing the syncer state can prevent from starting the syncer unnecessarily avoiding useless actions. * Allow workers to request syncer shutdown from within why: In one-trick-pony mode (after resuming without RPC support) the syncer can be stopped from within soavoiding unnecessary polling. In that case, the syncer can (theoretically) be restarted externally with `startSync()`. * Terminate beacon sync after a single run target is reached why: Stops doing useless polling (typically when there is no RPC available) * Remove crufty comments * Tighten state reload condition when resuming why: Some pathological case might apply if the syncer is stopped while the distance between finalised block and head is very large and the FCU base becomes larger than the locked finalised state. * Verify that finalised number from CL is at least FCU base number why: The FCU base number is determined by the database, non zero if manually imported. The finalised number is passed via RPC by the CL node and will increase over time. Unless fully synced, this number will be pretty low. On the other hand, the FCU call `forkChoice()` will eventually fail if the `finalizedHash` argument refers to something outside the internal chain starting at the FCU base block. * Remove support for completing interrupted sync without RPC support why: Simplifies start/stop logic * Rmove unused import
121 lines
3.8 KiB
Nim
121 lines
3.8 KiB
Nim
# Nimbus
|
|
# Copyright (c) 2021-2024 Status Research & Development GmbH
|
|
# Licensed under either of
|
|
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
# http://www.apache.org/licenses/LICENSE-2.0)
|
|
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
|
# http://opensource.org/licenses/MIT)
|
|
# at your option. This file may not be copied, modified, or distributed
|
|
# except according to those terms.
|
|
|
|
## Worker peers scheduler template
|
|
## ===============================
|
|
##
|
|
## Public descriptors
|
|
|
|
{.push raises: [].}
|
|
|
|
import
|
|
eth/p2p
|
|
|
|
type
|
|
BuddyRunState* = enum
|
|
Running = 0 ## Running, default state
|
|
Stopped ## Stopped or about stopping
|
|
ZombieStop ## Abandon/ignore (wait for pushed out of LRU table)
|
|
ZombieRun ## Extra zombie state to potentially recover from
|
|
|
|
BuddyCtrlRef* = ref object
|
|
## Control and state settings
|
|
runState: BuddyRunState ## Access with getters
|
|
|
|
BuddyRef*[S,W] = ref object
|
|
## Worker peer state descriptor.
|
|
ctx*: CtxRef[S] ## Shared data descriptor back reference
|
|
peer*: Peer ## Reference to eth p2pProtocol entry
|
|
ctrl*: BuddyCtrlRef ## Control and state settings
|
|
only*: W ## Worker peer specific data
|
|
|
|
CtxRef*[S] = ref object
|
|
## Shared state among all syncing peer workers (aka buddies.)
|
|
poolMode*: bool ## Activate `runPool()` workers if set `true`
|
|
daemon*: bool ## Enable global background job
|
|
pool*: S ## Shared context for all worker peers
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc `$`*[S,W](worker: BuddyRef[S,W]): string =
|
|
$worker.peer & "$" & $worker.ctrl.runState
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public getters, `BuddyRunState` execution control functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc state*(ctrl: BuddyCtrlRef): BuddyRunState =
|
|
## Getter (logging only, details of `BuddyCtrl` are private)
|
|
ctrl.runState
|
|
|
|
proc running*(ctrl: BuddyCtrlRef): bool =
|
|
## Getter, if `true` if `ctrl.state()` is `Running`
|
|
ctrl.runState == Running
|
|
|
|
proc stopped*(ctrl: BuddyCtrlRef): bool =
|
|
## Getter, if `true`, if `ctrl.state()` is not `Running`
|
|
ctrl.runState != Running
|
|
|
|
proc zombie*(ctrl: BuddyCtrlRef): bool =
|
|
## Getter, `true` if `ctrl.state()` is `Zombie` (i.e. not `running()` and
|
|
## not `stopped()`)
|
|
ctrl.runState in {ZombieStop, ZombieRun}
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public setters, `BuddyRunState` execution control functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc `zombie=`*(ctrl: BuddyCtrlRef; value: bool) =
|
|
## Setter
|
|
if value:
|
|
case ctrl.runState:
|
|
of Running:
|
|
ctrl.runState = ZombieRun
|
|
of Stopped:
|
|
ctrl.runState = ZombieStop
|
|
else:
|
|
discard
|
|
else:
|
|
case ctrl.runState:
|
|
of ZombieRun:
|
|
ctrl.runState = Running
|
|
of ZombieStop:
|
|
ctrl.runState = Stopped
|
|
else:
|
|
discard
|
|
|
|
proc `stopped=`*(ctrl: BuddyCtrlRef; value: bool) =
|
|
## Setter
|
|
if value:
|
|
case ctrl.runState:
|
|
of Running:
|
|
ctrl.runState = Stopped
|
|
else:
|
|
discard
|
|
else:
|
|
case ctrl.runState:
|
|
of Stopped:
|
|
ctrl.runState = Running
|
|
else:
|
|
discard
|
|
|
|
proc `forceRun=`*(ctrl: BuddyCtrlRef; value: bool) =
|
|
## Setter, gets out of `Zombie` jail/locked state with `true argument.
|
|
if value:
|
|
ctrl.runState = Running
|
|
else:
|
|
ctrl.stopped = true
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|