mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-01-10 20:36:31 +00:00
221e6c9e2f
* Nimbus folder environment update details: * Integrated `CoreDbRef` for the sources in the `nimbus` sub-folder. * The `nimbus` program does not compile yet as it needs the updates in the parallel `stateless` sub-folder. * Stateless environment update details: * Integrated `CoreDbRef` for the sources in the `stateless` sub-folder. * The `nimbus` program compiles now. * Premix environment update details: * Integrated `CoreDbRef` for the sources in the `premix` sub-folder. * Fluffy environment update details: * Integrated `CoreDbRef` for the sources in the `fluffy` sub-folder. * Tools environment update details: * Integrated `CoreDbRef` for the sources in the `tools` sub-folder. * Nodocker environment update details: * Integrated `CoreDbRef` for the sources in the `hive_integration/nodocker` sub-folder. * Tests environment update details: * Integrated `CoreDbRef` for the sources in the `tests` sub-folder. * The unit tests compile and run cleanly now. * Generalise `CoreDbRef` to any `select_backend` supported database why: Generalisation was just missed due to overcoming some compiler oddity which was tied to rocksdb for testing. * Suppress compiler warning for `newChainDB()` why: Warning was added to this function which must be wrapped so that any `CatchableError` is re-raised as `Defect`. * Split off persistent `CoreDbRef` constructor into separate file why: This allows to compile a memory only database version without linking the backend library. * Use memory `CoreDbRef` database by default detail: Persistent DB constructor needs to import `db/core_db/persistent why: Most tests use memory DB anyway. This avoids linking `-lrocksdb` or any other backend by default. * fix `toLegacyBackend()` availability check why: got garbled after memory/persistent split. * Clarify raw access to MPT for snap sync handler why: Logically, `kvt` is not the raw access for the hexary trie (although this holds for the legacy database)
135 lines
4.0 KiB
Nim
135 lines
4.0 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_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): bool =
|
|
tracerFrameCtx("runSetup", ctx):
|
|
result = worker.setup(ctx)
|
|
|
|
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;
|
|
enableTicker = false;
|
|
exCtrlFile = none(string);
|
|
): T =
|
|
new result
|
|
result.initSync(ethNode, chain, maxPeers, exCtrlFile)
|
|
result.ctx.chain = chain # explicitely override
|
|
result.ctx.pool.rng = rng
|
|
result.ctx.pool.enableTicker = enableTicker
|
|
# 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
|
|
# ------------------------------------------------------------------------------
|