mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-01-22 01:59:10 +00:00
05483d89bd
* Remove `--sync-mode` option from nimbus config why: Currently there is only one sync mode available. * Rename `flare` -> `beacon`, but not base module folder and nim source why: The name `flare` was used do designate an alternative `beacon` mode that. Leaving the base folder and source as-is for a moment, makes it easier to read change diffs. * Rename `flare` base module folder and nim source: `flare` -> `beacon`
164 lines
5.0 KiB
Nim
164 lines
5.0 KiB
Nim
# Nimbus - Fetch account and storage states from peers efficiently
|
|
#
|
|
# 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.
|
|
|
|
{.push raises: [].}
|
|
|
|
import
|
|
std/strutils,
|
|
pkg/[chronos, chronicles, eth/common, stint],
|
|
../../../../utils/prettify,
|
|
../helpers
|
|
|
|
logScope:
|
|
topics = "ticker"
|
|
|
|
type
|
|
TickerStatsUpdater* = proc: TickerStats {.gcsafe, raises: [].}
|
|
## Full sync state update function
|
|
|
|
TickerStats* = object
|
|
## Full sync state (see `TickerFullStatsUpdater`)
|
|
stateTop*: BlockNumber
|
|
base*: BlockNumber
|
|
least*: BlockNumber
|
|
final*: BlockNumber
|
|
beacon*: BlockNumber
|
|
|
|
hdrUnprocTop*: BlockNumber
|
|
nHdrUnprocessed*: uint64
|
|
nHdrUnprocFragm*: int
|
|
nHdrStaged*: int
|
|
hdrStagedTop*: BlockNumber
|
|
|
|
blkUnprocTop*: BlockNumber
|
|
nBlkUnprocessed*: uint64
|
|
nBlkUnprocFragm*: int
|
|
nBlkStaged*: int
|
|
blkStagedBottom*: BlockNumber
|
|
|
|
reorg*: int
|
|
|
|
TickerRef* = ref object
|
|
## Ticker descriptor object
|
|
nBuddies: int
|
|
started: Moment
|
|
visited: Moment
|
|
prettyPrint: proc(t: TickerRef) {.gcsafe, raises: [].}
|
|
statsCb: TickerStatsUpdater
|
|
lastStats: TickerStats
|
|
|
|
const
|
|
tickerStartDelay = chronos.milliseconds(100)
|
|
tickerLogInterval = chronos.seconds(1)
|
|
tickerLogSuppressMax = chronos.seconds(100)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Private functions: printing ticker messages
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc tickerLogger(t: TickerRef) {.gcsafe.} =
|
|
let
|
|
data = t.statsCb()
|
|
now = Moment.now()
|
|
|
|
if data != t.lastStats or
|
|
tickerLogSuppressMax < (now - t.visited):
|
|
let
|
|
T = data.stateTop.bnStr
|
|
B = data.base.bnStr
|
|
L = data.least.bnStr
|
|
F = data.final.bnStr
|
|
Z = data.beacon.bnStr
|
|
|
|
hS = if data.nHdrStaged == 0: "n/a"
|
|
else: data.hdrStagedTop.bnStr & "(" & $data.nHdrStaged & ")"
|
|
hU = if data.nHdrUnprocFragm == 0: "n/a"
|
|
else: data.hdrUnprocTop.bnStr & "(" &
|
|
data.nHdrUnprocessed.toSI & "," & $data.nHdrUnprocFragm & ")"
|
|
|
|
bS = if data.nBlkStaged == 0: "n/a"
|
|
else: data.blkStagedBottom.bnStr & "(" & $data.nBlkStaged & ")"
|
|
bU = if data.nBlkUnprocFragm == 0: "n/a"
|
|
else: data.blkUnprocTop.bnStr & "(" &
|
|
data.nBlkUnprocessed.toSI & "," & $data.nBlkUnprocFragm & ")"
|
|
|
|
reorg = data.reorg
|
|
peers = t.nBuddies
|
|
|
|
# With `int64`, there are more than 29*10^10 years range for seconds
|
|
up = (now - t.started).seconds.uint64.toSI
|
|
mem = getTotalMem().uint.toSI
|
|
|
|
t.lastStats = data
|
|
t.visited = now
|
|
|
|
info "State", up, peers, T, B, L, F, Z, hS, hU, bS, bU, reorg, mem
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Private functions: ticking log messages
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc setLogTicker(t: TickerRef; at: Moment) {.gcsafe.}
|
|
|
|
proc runLogTicker(t: TickerRef) {.gcsafe.} =
|
|
t.prettyPrint(t)
|
|
t.setLogTicker(Moment.fromNow(tickerLogInterval))
|
|
|
|
proc setLogTicker(t: TickerRef; at: Moment) =
|
|
if t.statsCb.isNil:
|
|
debug "Stopped", nBuddies=t.nBuddies
|
|
else:
|
|
# Store the `runLogTicker()` in a closure to avoid some garbage collection
|
|
# memory corruption issues that might occur otherwise.
|
|
discard setTimer(at, proc(ign: pointer) = runLogTicker(t))
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public constructor and start/stop functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc init*(T: type TickerRef; cb: TickerStatsUpdater): T =
|
|
## Constructor
|
|
result = TickerRef(
|
|
prettyPrint: tickerLogger,
|
|
statsCb: cb,
|
|
started: Moment.now())
|
|
result.setLogTicker Moment.fromNow(tickerStartDelay)
|
|
|
|
proc destroy*(t: TickerRef) =
|
|
## Stop ticker unconditionally
|
|
if not t.isNil:
|
|
t.statsCb = TickerStatsUpdater(nil)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc startBuddy*(t: TickerRef) =
|
|
## Increment buddies counter and start ticker unless running.
|
|
if not t.isNil:
|
|
if t.nBuddies <= 0:
|
|
t.nBuddies = 1
|
|
else:
|
|
t.nBuddies.inc
|
|
debug "Start buddy", nBuddies=t.nBuddies
|
|
|
|
proc stopBuddy*(t: TickerRef) =
|
|
## Decrement buddies counter and stop ticker if there are no more registered
|
|
## buddies.
|
|
if not t.isNil:
|
|
if 0 < t.nBuddies:
|
|
t.nBuddies.dec
|
|
debug "Stop buddy", nBuddies=t.nBuddies
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|