Update for changed master base since PR #3837

Author: mjfh

tools/syncer/helpers/sync_ticker.nim

@@ -12,7 +12,8 @@
 
 import
   pkg/[chronos, chronicles, eth/common, stew/interval_set],
-  ../../../execution_chain/sync/beacon/worker/[blocks, headers, worker_desc]
+  ../../../execution_chain/sync/beacon/worker/[
+    blocks, headers, helpers, worker_desc]
 
 logScope:
   topics = "beacon ticker"
@@ -43,10 +44,11 @@ type
     blkStagedBottom: BlockNumber
 
     state: SyncState
+    standByMode: bool
     nSyncPeers: int
     eta: chronos.Duration
 
-  TickerRef* = ref object of RootRef
+  TickerRef = ref object
     ## Ticker descriptor object
     started: Moment
     visited: Moment
@@ -59,6 +61,7 @@ type
 const
   tickerLogInterval = chronos.seconds(2)
   tickerLogSuppressMax = chronos.seconds(100)
+  tickerLogStandByMax = chronos.seconds(200)
 
 proc updater(ctx: BeaconCtxRef): TickerStats =
   ## Legacy stuff, will be probably be superseded by `metrics`
@@ -86,79 +89,90 @@ proc updater(ctx: BeaconCtxRef): TickerStats =
     nBlkUnprocFragm: ctx.blk.unprocessed.chunks,
 
     state:           ctx.pool.syncState,
+    standByMode:     ctx.pool.standByMode,
     nSyncPeers:      ctx.nSyncPeers(),
     eta:             ctx.pool.syncEta.avg)
 
 proc tickerLogger(t: TickerRef; ctx: BeaconCtxRef) =
   let
     data = ctx.updater()
     now = Moment.now()
+    elapsed = now - t.visited
 
-  if now <= t.visited + tickerLogInterval:
+  if elapsed <= tickerLogInterval:
     return
 
-  if data != t.lastStats or
-    tickerLogSuppressMax < (now - t.visited):
-    let
-      B = if data.base == data.latest: "L" else: $data.base
-      L = if data.latest == data.coupler: "C" else: $data.latest
-      I = if data.top == 0: "n/a" else : $data.top
-      C = if data.coupler == data.dangling: "D"
-          elif data.coupler < high(int64).uint64: $data.coupler
-          else: "n/a"
-      D = if data.dangling == data.head: "H" else: $data.dangling
-      H = if data.head == data.target: "T"
-          elif data.activeOk: $data.head
-          else: "?" & $data.head
-      T = if data.activeOk: $data.target else: "?" & $data.target
-      F = if data.fin == 0: "n/a"
-          elif data.fin == data.target and data.activeOk: "T"
-          elif data.fin == data.head: "H"
-          elif data.fin == data.dangling: "D"
-          elif data.fin == data.latest: "L"
-          elif data.fin == data.base: "B"
-          else: $data.fin
-
-      hS = if data.nHdrStaged == 0: "n/a"
-          else: $data.hdrStagedTop & "[" & $data.nHdrStaged & "]"
-      hU = if data.nHdrUnprocFragm == 0 and data.nHdrUnprocessed == 0: "n/a"
-          elif data.hdrUnprocTop == 0:
-            "(" & data.nHdrUnprocessed.toSI & "," & $data.nHdrUnprocFragm & ")"
-          else: $data.hdrUnprocTop & "(" &
-                data.nHdrUnprocessed.toSI & "," & $data.nHdrUnprocFragm & ")"
-      hQ = if hS == "n/a": hU
-           elif hU == "n/a": hS
-           else: hS & "<-" & hU
-
-      bS = if data.nBlkStaged == 0: "n/a"
-          else: $data.blkStagedBottom & "[" & $data.nBlkStaged & "]"
-      bU = if data.nBlkUnprocFragm == 0 and data.nBlkUnprocessed == 0: "n/a"
-          elif data.blkUnprocBottom == high(BlockNumber):
-            "(" & data.nBlkUnprocessed.toSI & "," & $data.nBlkUnprocFragm & ")"
-          else: $data.blkUnprocBottom & "(" &
-                data.nBlkUnprocessed.toSI & "," & $data.nBlkUnprocFragm & ")"
-      bQ = if bS == "n/a": bU
-           elif bU == "n/a": bS
-           else: bS & "<-" & bU
-
-      st = case data.state
-        of idle: "0"
-        of headers: "h"
-        of headersCancel: "x"
-        of headersFinish: "f"
-        of blocks: "b"
-        of blocksCancel: "x"
-        of blocksFinish: "f"
-
-      nP = data.nSyncPeers
-
-      # With `int64`, there are more than 29*10^10 years range for seconds
-      up = (now - t.started).toStr
-      eta = data.eta.toStr
-
-    t.lastStats = data
-    t.visited = now
+  if data.standByMode:
+    if elapsed <= tickerLogStandByMax:
+      return
+  elif data == t.lastStats and
+       elapsed <= tickerLogSuppressMax:
+    return
 
+  let
+    B = if data.base == data.latest: "L" else: $data.base
+    L = if data.latest == data.coupler: "C" else: $data.latest
+    I = if data.top == 0: "n/a" else : $data.top
+    C = if data.coupler == data.dangling: "D"
+        elif data.coupler < high(int64).uint64: $data.coupler
+        else: "n/a"
+    D = if data.dangling == data.head: "H" else: $data.dangling
+    H = if data.head == data.target: "T"
+        elif data.activeOk: $data.head
+        else: "?" & $data.head
+    T = if data.activeOk: $data.target else: "?" & $data.target
+    F = if data.fin == 0: "n/a"
+        elif data.fin == data.target and data.activeOk: "T"
+        elif data.fin == data.head: "H"
+        elif data.fin == data.dangling: "D"
+        elif data.fin == data.latest: "L"
+        elif data.fin == data.base: "B"
+        else: $data.fin
+
+    hS = if data.nHdrStaged == 0: "n/a"
+        else: $data.hdrStagedTop & "[" & $data.nHdrStaged & "]"
+    hU = if data.nHdrUnprocFragm == 0 and data.nHdrUnprocessed == 0: "n/a"
+        elif data.hdrUnprocTop == 0:
+          "(" & data.nHdrUnprocessed.toSI & "," & $data.nHdrUnprocFragm & ")"
+        else: $data.hdrUnprocTop & "(" &
+              data.nHdrUnprocessed.toSI & "," & $data.nHdrUnprocFragm & ")"
+    hQ = if hS == "n/a": hU
+         elif hU == "n/a": hS
+         else: hS & "<-" & hU
+
+    bS = if data.nBlkStaged == 0: "n/a"
+        else: $data.blkStagedBottom & "[" & $data.nBlkStaged & "]"
+    bU = if data.nBlkUnprocFragm == 0 and data.nBlkUnprocessed == 0: "n/a"
+        elif data.blkUnprocBottom == high(BlockNumber):
+          "(" & data.nBlkUnprocessed.toSI & "," & $data.nBlkUnprocFragm & ")"
+        else: $data.blkUnprocBottom & "(" &
+              data.nBlkUnprocessed.toSI & "," & $data.nBlkUnprocFragm & ")"
+    bQ = if bS == "n/a": bU
+         elif bU == "n/a": bS
+         else: bS & "<-" & bU
+
+    st = case data.state
+      of idle: "0"
+      of headers: "h"
+      of headersCancel: "x"
+      of headersFinish: "f"
+      of blocks: "b"
+      of blocksCancel: "x"
+      of blocksFinish: "f"
+
+    nP = data.nSyncPeers
+
+    # With `int64`, there are more than 29*10^10 years range for seconds
+    up = (now - t.started).toStr
+    eta = data.eta.toStr
+
+  t.lastStats = data
+  t.visited = now
+
+  if data.standByMode:
+    debug "Sync stand-by mode", up, eta, nP, B, L,
+      D, H, T, F
+  else:
     case data.state
     of idle:
       debug "Sync state idle", up, eta, nP, B, L,
@@ -176,7 +190,7 @@ proc tickerLogger(t: TickerRef; ctx: BeaconCtxRef) =
 # Public function
 # ------------------------------------------------------------------------------
 
-proc syncTicker*(): BackgroundTicker =
+proc syncTicker*(): Ticker =
   let desc = TickerRef(started: Moment.now())
   return proc(ctx: BeaconCtxRef) =
     desc.tickerLogger(ctx)

tools/syncer/replay/replay_desc.nim

@@ -33,10 +33,10 @@ type
   ReplayEndUpFn* = proc() {.gcsafe, raises: [].}
     ## Terminator control directive for runner/dispatcher
 
-  ReplayGetSyncPeerFn* = GetSyncPeerFn[BeaconCtxData,BeaconBuddyData]
+  ReplayGetSyncPeerFn* = GetSyncPeerFn[BeaconCtxData,BeaconPeerData]
     ## Shortcut
 
-  ReplayNSyncPeersFn* = NSyncPeersFn[BeaconCtxData,BeaconBuddyData]
+  ReplayNSyncPeersFn* = NSyncPeersFn[BeaconCtxData,BeaconPeerData]
     ## Shortcut
 
   ReplayRef* = ref object of BeaconHandlersSyncRef

tools/syncer/replay/replay_runner/runner_desc.nim

@@ -39,21 +39,21 @@ const
 type
   ReplayWaitError* = tuple
     ## Capture exception or error context for waiting/polling instance
-    excp: BeaconErrorType
+    excp: ErrorType
     name: string
     msg: string
 
   # --------- internal context types ---------
 
-  ReplayBuddyRef* = ref object of BeaconBuddyRef
-    ## Replacement of `BeaconBuddyRef` in `runPeer()` and `runPool()`
+  ReplayPeerRef* = ref object of BeaconPeerRef
+    ## Replacement of `BeacomPeerRef` in `runPeer()` and `runPool()`
     isNew*: bool                       ## Set in `getOrNewPeer()` when created
     run*: ReplayRunnerRef              ## Back-reference for convenience
     frameID*: Opt[uint]                ## Begin/end frame
     message*: ReplayPayloadRef         ## Data message channel
 
   ReplayDaemonRef* = ref object
-    ## Daemeon job frame (similar to `ReplayBuddyRef`)
+    ## Daemeon job frame (similar to `ReplayPeerRef`)
     run*: ReplayRunnerRef              ## Back-reference for convenience
     frameID*: Opt[uint]                ## Begin/end frame
     message*: ReplayPayloadRef         ## Data message channel
@@ -73,7 +73,7 @@ type
 
     # Local state
     daemon*: ReplayDaemonRef           ## Currently active daemon, or `nil`
-    peers*: Table[Hash,ReplayBuddyRef] ## Begin/End for base frames
+    peers*: Table[Hash,ReplayPeerRef]  ## Begin/End for base frames
     nSyncPeers*: int                   ## Track active peer instances
     failTmoMax*: chronos.Duration      ## Keep track of largest timeout
 
@@ -85,7 +85,7 @@ type
 # ------------------------------------------------------------------------------
 
 proc replayGetSyncPeerFn*(run: ReplayRunnerRef): ReplayGetSyncPeerFn =
-  result = proc(peerID: Hash): BeaconBuddyRef =
+  result = proc(peerID: Hash): BeaconPeerRef =
     run.peers.withValue(peerID,val):
       return val[]
 

tools/syncer/replay/replay_runner/runner_dispatch/dispatch_blocks.nim

@@ -43,7 +43,7 @@ proc toBnRange(
 
 proc toStr(
     lst: openArray[Hash32];
-    buddy: BeaconBuddyRef;
+    buddy: BeaconPeerRef;
     info: static[string];
       ): string =
   buddy.ctx.toBnRange(lst, info).toStr
@@ -85,13 +85,13 @@ func getBeaconError(e: ReplayWaitError): BeaconError =
 # ------------------------------------------------------------------------------
 
 proc fetchBodiesHandler*(
-    buddy: BeaconBuddyRef;
+    buddy: BeaconPeerRef;
     req: BlockBodiesRequest;
       ): Future[Result[FetchBodiesData,BeaconError]]
       {.async: (raises: []).} =
   const info = "&fetchBodies"
 
-  let buddy = ReplayBuddyRef(buddy)
+  let buddy = ReplayPeerRef(buddy)
 
   var data: ReplayFetchBodies
   buddy.withInstr(typeof data, rlxBaseNum=true, ignLatestNum=true, info):
@@ -118,15 +118,15 @@ proc fetchBodiesHandler*(
 
 
 proc importBlockHandler*(
-    buddy: BeaconBuddyRef;
+    buddy: BeaconPeerRef;
     ethBlock: EthBlock;
     effPeerID: Hash;
       ): Future[Result[Duration,BeaconError]]
       {.async: (raises: []).} =
   const info = "&importBlock"
 
   let
-    buddy = ReplayBuddyRef(buddy)
+    buddy = ReplayPeerRef(buddy)
     n = buddy.iNum
     peer = buddy.peerStr
     peerID = buddy.peerIdStr

tools/syncer/replay/replay_runner/runner_dispatch/dispatch_headers.nim

@@ -55,14 +55,14 @@ func getBeaconError(e: ReplayWaitError): BeaconError =
 # ------------------------------------------------------------------------------
 
 proc fetchHeadersHandler*(
-    buddy: BeaconBuddyRef;
+    buddy: BeaconPeerRef;
     req: BlockHeadersRequest;
     bn: BlockNumber;
       ): Future[Result[FetchHeadersData,BeaconError]]
       {.async: (raises: []).} =
   ## Replacement for `getBlockHeaders()` handler.
   const info = "&fetchHeaders"
-  let buddy = ReplayBuddyRef(buddy)
+  let buddy = ReplayPeerRef(buddy)
 
   var data: ReplayFetchHeaders
   buddy.withInstr(typeof data, rlxBaseNum=false, ignLatestNum=false, info):