mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-02-11 03:27:00 +00:00
0a3bc102eb
* Update sync scheduler pool mode why: The pool mode allows to loop over active peers one after another. This is ideal for soft re-starting peers. As this is a two tier experience (start/stop, setup/release) the loop must be run twice. This is controlled by a more rigid re-definition of how to use the `poolMode` flag. * Mitigate RLP serialiser deficiency why: Currently, serialising the `BlockBody` in not conevrtible and need to be checked in the `eth` module. Currently a local fix for the wire protocol applies. Unit tests will stay (after this local solution will have been removed.) * Code cosmetics and massage details: Main part is `types.toStr()` as a unified function for logging block numbers. * Allow to use a logical genesis replacement (start of history) why: Snap sync will set up an arbitrary pivot at a block number different from zero. In fact, the higher the block number the better. details: A non-genesis start of history will currently only affect the score values which were derived from the difficulty. * Provide function to store the snap pivot block header in chain db why: Together with the start of history facility, this allows to proceed with full syncing once snap has finished. details: Snap db storage was switched from a sub-tables to the flat chain db. * Provide database completeness and sanity checker details: For debugging on smaller databases, only * Implement snap -> full sync switch
136 lines
4.1 KiB
Nim
136 lines
4.1 KiB
Nim
# Nimbus
|
|
# Copyright (c) 2021 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
|
|
chronicles,
|
|
chronos,
|
|
eth/p2p,
|
|
../db/select_backend,
|
|
../core/chain,
|
|
./snap/[worker, worker_desc],
|
|
"."/[protocol, sync_desc, sync_sched]
|
|
|
|
logScope:
|
|
topics = "snap-sync"
|
|
|
|
type
|
|
SnapSyncRef* = RunnerSyncRef[SnapCtxData,SnapBuddyData]
|
|
|
|
const
|
|
extraTraceMessages = false # or true
|
|
## Enable additional logging noise
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Private logging helpers
|
|
# ------------------------------------------------------------------------------
|
|
|
|
template traceMsg(f, info: static[string]; args: varargs[untyped]) =
|
|
trace "Snap scheduler " & f & "() " & info, args
|
|
|
|
template traceMsgCtx(f, info: static[string]; c: SnapCtxRef) =
|
|
when extraTraceMessages:
|
|
block:
|
|
let
|
|
poolMode {.inject.} = c.poolMode
|
|
daemon {.inject.} = c.daemon
|
|
f.traceMsg info, poolMode, daemon
|
|
|
|
template traceMsgBuddy(f, info: static[string]; b: SnapBuddyRef) =
|
|
when extraTraceMessages:
|
|
block:
|
|
let
|
|
peer {.inject.} = b.peer
|
|
runState {.inject.} = b.ctrl.state
|
|
multiOk {.inject.} = b.ctrl.multiOk
|
|
poolMode {.inject.} = b.ctx.poolMode
|
|
daemon {.inject.} = b.ctx.daemon
|
|
f.traceMsg info, peer, runState, multiOk, poolMode, daemon
|
|
|
|
|
|
template tracerFrameCtx(f: static[string]; c: SnapCtxRef; code: untyped) =
|
|
f.traceMsgCtx "begin", c
|
|
code
|
|
f.traceMsgCtx "end", c
|
|
|
|
template tracerFrameBuddy(f: static[string]; b: SnapBuddyRef; code: untyped) =
|
|
f.traceMsgBuddy "begin", b
|
|
code
|
|
f.traceMsgBuddy "end", b
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Virtual methods/interface, `mixin` functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc runSetup(ctx: SnapCtxRef; ticker: bool): bool =
|
|
tracerFrameCtx("runSetup", ctx):
|
|
result = worker.setup(ctx,ticker)
|
|
|
|
proc runRelease(ctx: SnapCtxRef) =
|
|
tracerFrameCtx("runRelease", ctx):
|
|
worker.release(ctx)
|
|
|
|
proc runDaemon(ctx: SnapCtxRef) {.async.} =
|
|
tracerFrameCtx("runDaemon", ctx):
|
|
await worker.runDaemon(ctx)
|
|
|
|
proc runStart(buddy: SnapBuddyRef): bool =
|
|
tracerFrameBuddy("runStart", buddy):
|
|
result = worker.start(buddy)
|
|
|
|
proc runStop(buddy: SnapBuddyRef) =
|
|
tracerFrameBuddy("runStop", buddy):
|
|
worker.stop(buddy)
|
|
|
|
proc runPool(buddy: SnapBuddyRef; last: bool; laps: int): bool =
|
|
tracerFrameBuddy("runPool", buddy):
|
|
result = worker.runPool(buddy, last=last, laps=laps)
|
|
|
|
proc runSingle(buddy: SnapBuddyRef) {.async.} =
|
|
tracerFrameBuddy("runSingle", buddy):
|
|
await worker.runSingle(buddy)
|
|
|
|
proc runMulti(buddy: SnapBuddyRef) {.async.} =
|
|
tracerFrameBuddy("runMulti", buddy):
|
|
await worker.runMulti(buddy)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc init*(
|
|
T: type SnapSyncRef;
|
|
ethNode: EthereumNode;
|
|
chain: ChainRef;
|
|
rng: ref HmacDrbgContext;
|
|
maxPeers: int;
|
|
dbBackend: ChainDb;
|
|
enableTicker = false;
|
|
exCtrlFile = none(string);
|
|
): T =
|
|
new result
|
|
result.initSync(ethNode, chain, maxPeers, enableTicker, exCtrlFile)
|
|
result.ctx.chain = chain # explicitely override
|
|
result.ctx.pool.rng = rng
|
|
result.ctx.pool.dbBackend = dbBackend
|
|
# Required to have been initialised via `addEthHandlerCapability()`
|
|
doAssert not result.ctx.ethWireCtx.isNil
|
|
|
|
proc start*(ctx: SnapSyncRef) =
|
|
doAssert ctx.startSync()
|
|
|
|
proc stop*(ctx: SnapSyncRef) =
|
|
ctx.stopSync()
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|