Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Consensus.PeerSimulator.NodeLifecycle

Synopsis

data LiveInterval blk m = LiveInterval {
- liResources ∷ LiveResources blk m
- liResult ∷ LiveIntervalResult blk
- liNode ∷ LiveNode blk m
}
data LiveIntervalResult blk = LiveIntervalResult {
- lirPeerResults ∷ [PeerSimulatorResult blk]
- lirActive ∷ Set PeerId
}
data LiveNode blk m = LiveNode {
- lnChainDb ∷ ChainDB m blk
- lnStateViewTracers ∷ StateViewTracers blk m
- lnStateTracer ∷ Tracer m ()
- lnCopyToImmDb ∷ m (WithOrigin SlotNo)
- lnPeers ∷ Set PeerId
}
data LiveResources blk m = LiveResources {
- lrRegistry ∷ ResourceRegistry m
- lrPeerSim ∷ PeerSimulatorResources m blk
- lrTracer ∷ Tracer m (TraceEvent blk)
- lrSTracer ∷ ChainDB m blk → m (Tracer m ())
- lrConfig ∷ TopLevelConfig blk
- lrCdb ∷ NodeDBs (StrictTMVar m MockFS)
- lrLoEVar ∷ LoE (StrictTVar m (AnchoredFragment (Header blk)))
}
data NodeLifecycle blk m = NodeLifecycle {
- nlMinDuration ∷ Maybe DiffTime
- nlStart ∷ LiveIntervalResult blk → m (LiveNode blk m)
- nlShutdown ∷ LiveNode blk m → m (LiveIntervalResult blk)
}
lifecycleStart ∷ ∀ m. IOLike m ⇒ (LiveInterval TestBlock m → m ()) → LiveResources TestBlock m → LiveIntervalResult TestBlock → m (LiveNode TestBlock m)
lifecycleStop ∷ (IOLike m, GetHeader blk) ⇒ LiveResources blk m → LiveNode blk m → m (LiveIntervalResult blk)
restoreNode ∷ IOLike m ⇒ LiveResources TestBlock m → LiveIntervalResult TestBlock → m (LiveNode TestBlock m)

Documentation

data LiveInterval blk m Source #

Constructors

LiveInterval
Fields liResources ∷ LiveResources blk m liResult ∷ LiveIntervalResult blk liNode ∷ LiveNode blk m

data LiveIntervalResult blk Source #

Result of a node shutdown at the end of a live interval.

Constructors

LiveIntervalResult
Fields lirPeerResults ∷ [PeerSimulatorResult blk] Used to initialize the `StateViewTracers` of the next run to preserve earlier disconnections for the final result. lirActive ∷ Set PeerId The remaining peers, computed by removing all peers present in `lrPeerResults` from the current state in `lnPeers`.

data LiveNode blk m Source #

Resources used for a single live interval of the node, constructed when the node is started. When the node is shut down, lnCopyToImmDb is used to persist the current chain.

Constructors

LiveNode

Fields

lnChainDb ∷ ChainDB m blk
lnStateViewTracers ∷ StateViewTracers blk m
lnStateTracer ∷ Tracer m ()
lnCopyToImmDb ∷ m (WithOrigin SlotNo)
Write persistent ChainDB state (the immutable and volatile DBs, but not the ledger and GSM state) to the VFS TVars to preserve it for the next interval. Returns the immutable tip's slot for tracing.
lnPeers ∷ Set PeerId
The set of peers that should be started. Based on the simulation results at node shutdown, disconnected peers are removed for the next live interval.

data LiveResources blk m Source #

Resources used by the handlers lifecycleStart and lifecycleStop to shut down running components, construct tracers used for single intervals, and reset and persist state.

Constructors

LiveResources

Fields

lrRegistry ∷ ResourceRegistry m
lrPeerSim ∷ PeerSimulatorResources m blk
lrTracer ∷ Tracer m (TraceEvent blk)
lrSTracer ∷ ChainDB m blk → m (Tracer m ())
lrConfig ∷ TopLevelConfig blk
lrCdb ∷ NodeDBs (StrictTMVar m MockFS)
The chain DB state consists of several transient parts and the immutable DB's virtual file system. After lnCopyToImmDb was executed, the latter will contain the final state of an interval. The rest is reset when the chain DB is recreated.
lrLoEVar ∷ LoE (StrictTVar m (AnchoredFragment (Header blk)))
The LoE fragment must be reset for each live interval.

data NodeLifecycle blk m Source #

Handlers for starting the node and shutting it down for each live interval, using the state of the previous run.

Constructors

NodeLifecycle

Fields

nlMinDuration ∷ Maybe DiffTime
The minimum tick duration that triggers a node downtime. If this is Nothing, downtimes are disabled.
nlStart ∷ LiveIntervalResult blk → m (LiveNode blk m)
Start the node with prior state. For the first start, this must be called with an empty lirPeerResults and the initial set of all peers in lirActive.
nlShutdown ∷ LiveNode blk m → m (LiveIntervalResult blk)

lifecycleStart ∷ ∀ m. IOLike m ⇒ (LiveInterval TestBlock m → m ()) → LiveResources TestBlock m → LiveIntervalResult TestBlock → m (LiveNode TestBlock m) Source #

Allocate resources with restoreNode and pass them to the callback that starts the node's threads.

lifecycleStop ∷ (IOLike m, GetHeader blk) ⇒ LiveResources blk m → LiveNode blk m → m (LiveIntervalResult blk) Source #

Shut down the node by killing all its threads after extracting the persistent state used to restart the node later.

restoreNode ∷ IOLike m ⇒ LiveResources TestBlock m → LiveIntervalResult TestBlock → m (LiveNode TestBlock m) Source #

Allocate all the resources that depend on the results of previous live intervals, the ChainDB and its persisted state.