Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.BlockFetch.State

Synopsis

fetchLogicIterations :: ( HasHeader header, HasHeader block, HeaderHash header ~ HeaderHash block, MonadDelay m, MonadMonotonicTime m, MonadSTM m, Ord peer, Hashable peer) => Tracer m [ TraceLabelPeer peer ( FetchDecision [ Point header])] -> Tracer m ( TraceLabelPeer peer ( TraceFetchClientState header)) -> FetchDecisionPolicy header -> FetchTriggerVariables peer header m -> FetchNonTriggerVariables peer header block m -> m Void
data FetchDecisionPolicy header = FetchDecisionPolicy {
- maxInFlightReqsPerPeer :: Word
- maxConcurrencyBulkSync :: Word
- maxConcurrencyDeadline :: Word
- decisionLoopInterval :: DiffTime
- peerSalt :: Int
- plausibleCandidateChain :: HasCallStack => AnchoredFragment header -> AnchoredFragment header -> Bool
- compareCandidateChains :: HasCallStack => AnchoredFragment header -> AnchoredFragment header -> Ordering
- blockFetchSize :: header -> SizeInBytes
}
data FetchTriggerVariables peer header m = FetchTriggerVariables {
- readStateCurrentChain :: STM m ( AnchoredFragment header)
- readStateCandidateChains :: STM m ( Map peer ( AnchoredFragment header))
- readStatePeerStatus :: STM m ( Map peer ( PeerFetchStatus header))
}
data FetchNonTriggerVariables peer header block m = FetchNonTriggerVariables {
- readStateFetchedBlocks :: STM m ( Point block -> Bool )
- readStatePeerStateVars :: STM m ( Map peer ( FetchClientStateVars m header))
- readStatePeerGSVs :: STM m ( Map peer PeerGSV )
- readStateFetchMode :: STM m FetchMode
- readStateFetchedMaxSlotNo :: STM m MaxSlotNo
}
type FetchDecision result = Either FetchDecline result
data FetchDecline
- = FetchDeclineChainNotPlausible
- | FetchDeclineChainNoIntersection
- | FetchDeclineAlreadyFetched
- | FetchDeclineInFlightThisPeer
- | FetchDeclineInFlightOtherPeer
- | FetchDeclinePeerShutdown
- | FetchDeclinePeerSlow
- | FetchDeclineReqsInFlightLimit ! Word
- | FetchDeclineBytesInFlightLimit ! SizeInBytes ! SizeInBytes ! SizeInBytes
- | FetchDeclinePeerBusy ! SizeInBytes ! SizeInBytes ! SizeInBytes
- | FetchDeclineConcurrencyLimit ! FetchMode ! Word
data FetchMode
- = FetchModeBulkSync
- | FetchModeDeadline
data TraceLabelPeer peerid a = TraceLabelPeer peerid a
data TraceFetchClientState header
- = AddedFetchRequest ( FetchRequest header) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header)
- | AcknowledgedFetchRequest ( FetchRequest header)
- | SendFetchRequest ( AnchoredFragment header)
- | StartedFetchBatch ( ChainRange ( Point header)) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header)
- | CompletedBlockFetch ( Point header) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header) NominalDiffTime SizeInBytes
- | CompletedFetchBatch ( ChainRange ( Point header)) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header)
- | RejectedFetchBatch ( ChainRange ( Point header)) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header)
- | ClientTerminating Int

Documentation

fetchLogicIterations :: ( HasHeader header, HasHeader block, HeaderHash header ~ HeaderHash block, MonadDelay m, MonadMonotonicTime m, MonadSTM m, Ord peer, Hashable peer) => Tracer m [ TraceLabelPeer peer ( FetchDecision [ Point header])] -> Tracer m ( TraceLabelPeer peer ( TraceFetchClientState header)) -> FetchDecisionPolicy header -> FetchTriggerVariables peer header m -> FetchNonTriggerVariables peer header block m -> m Void Source #

data FetchDecisionPolicy header Source #

Constructors

FetchDecisionPolicy

Fields

maxInFlightReqsPerPeer :: Word
maxConcurrencyBulkSync :: Word
maxConcurrencyDeadline :: Word
decisionLoopInterval :: DiffTime
peerSalt :: Int
plausibleCandidateChain :: HasCallStack => AnchoredFragment header -> AnchoredFragment header -> Bool
compareCandidateChains :: HasCallStack => AnchoredFragment header -> AnchoredFragment header -> Ordering
blockFetchSize :: header -> SizeInBytes

data FetchTriggerVariables peer header m Source #

STM actions to read various state variables that the fetch logic depends upon. Any change in these variables is a trigger to re-evaluate the decision on what blocks to fetch.

Note that this is a "level trigger" not an "edge trigger": we do not have to re-evaluate on every change, it is sufficient to re-evaluate at some stage after one or more changes. This means it is ok to get somewhat behind, and it is not necessary to determine exactly what changed, just that there was some change.

Constructors

FetchTriggerVariables
Fields readStateCurrentChain :: STM m ( AnchoredFragment header) readStateCandidateChains :: STM m ( Map peer ( AnchoredFragment header)) readStatePeerStatus :: STM m ( Map peer ( PeerFetchStatus header))

data FetchNonTriggerVariables peer header block m Source #

STM actions to read various state variables that the fetch logic uses. While the decisions do make use of the values of these variables, it is not necessary to re-evaluate when these variables change.

Constructors

FetchNonTriggerVariables
Fields readStateFetchedBlocks :: STM m ( Point block -> Bool ) readStatePeerStateVars :: STM m ( Map peer ( FetchClientStateVars m header)) readStatePeerGSVs :: STM m ( Map peer PeerGSV ) readStateFetchMode :: STM m FetchMode readStateFetchedMaxSlotNo :: STM m MaxSlotNo

type FetchDecision result = Either FetchDecline result Source #

Throughout the decision making process we accumulate reasons to decline to fetch any blocks. This type is used to wrap intermediate and final results.

data FetchDecline Source #

All the various reasons we can decide not to fetch blocks from a peer.

Constructors

FetchDeclineChainNotPlausible
FetchDeclineChainNoIntersection
FetchDeclineAlreadyFetched
FetchDeclineInFlightThisPeer
FetchDeclineInFlightOtherPeer
FetchDeclinePeerShutdown
FetchDeclinePeerSlow
FetchDeclineReqsInFlightLimit ! Word
FetchDeclineBytesInFlightLimit ! SizeInBytes ! SizeInBytes ! SizeInBytes
FetchDeclinePeerBusy ! SizeInBytes ! SizeInBytes ! SizeInBytes
FetchDeclineConcurrencyLimit ! FetchMode ! Word

Instances

Instances details

Eq FetchDecline Source #
Instance details Defined in Ouroboros.Network.BlockFetch.Decision Methods (==) :: FetchDecline -> FetchDecline -> Bool Source # (/=) :: FetchDecline -> FetchDecline -> Bool Source #
Show FetchDecline Source #
Instance details Defined in Ouroboros.Network.BlockFetch.Decision Methods showsPrec :: Int -> FetchDecline -> ShowS Source # show :: FetchDecline -> String Source # showList :: [ FetchDecline ] -> ShowS Source #

data FetchMode Source #

Constructors

FetchModeBulkSync	Use this mode when we are catching up on the chain but are stil well behind. In this mode the fetch logic will optimise for throughput rather than latency.
FetchModeDeadline	Use this mode for block-producing nodes that have a known deadline to produce a block and need to get the best chain before that. In this mode the fetch logic will optimise for picking the best chain within the given deadline.

Instances

Instances details

Eq FetchMode Source #
Instance details Defined in Ouroboros.Network.BlockFetch.Decision Methods (==) :: FetchMode -> FetchMode -> Bool Source # (/=) :: FetchMode -> FetchMode -> Bool Source #
Show FetchMode Source #
Instance details Defined in Ouroboros.Network.BlockFetch.Decision Methods showsPrec :: Int -> FetchMode -> ShowS Source # show :: FetchMode -> String Source # showList :: [ FetchMode ] -> ShowS Source #

data TraceLabelPeer peerid a Source #

A peer label for use in Tracer s. This annotates tracer output as being associated with a given peer identifier.

Constructors

TraceLabelPeer peerid a

Instances

Instances details

Functor ( TraceLabelPeer peerid)
Instance details Defined in Network.Mux.Trace Methods fmap :: (a -> b) -> TraceLabelPeer peerid a -> TraceLabelPeer peerid b Source # (<$) :: a -> TraceLabelPeer peerid b -> TraceLabelPeer peerid a Source #
( Eq peerid, Eq a) => Eq ( TraceLabelPeer peerid a)
Instance details Defined in Network.Mux.Trace Methods (==) :: TraceLabelPeer peerid a -> TraceLabelPeer peerid a -> Bool Source # (/=) :: TraceLabelPeer peerid a -> TraceLabelPeer peerid a -> Bool Source #
( Show peerid, Show a) => Show ( TraceLabelPeer peerid a)
Instance details Defined in Network.Mux.Trace Methods showsPrec :: Int -> TraceLabelPeer peerid a -> ShowS Source # show :: TraceLabelPeer peerid a -> String Source # showList :: [ TraceLabelPeer peerid a] -> ShowS Source #

data TraceFetchClientState header Source #

Tracing types for the various events that change the state (i.e. FetchClientStateVars ) for a block fetch client.

Note that while these are all state changes, the AddedFetchRequest occurs in the decision thread while the other state changes occur in the block fetch client threads.

Constructors

AddedFetchRequest ( FetchRequest header) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header)	The block fetch decision thread has added a new fetch instruction consisting of one or more individual request ranges.
AcknowledgedFetchRequest ( FetchRequest header)	Mark the point when the fetch client picks up the request added by the block fetch decision thread. Note that this event can happen fewer times than the `AddedFetchRequest` due to fetch request merging.
SendFetchRequest ( AnchoredFragment header)	Mark the point when fetch request for a fragment is actually sent over the wire.
StartedFetchBatch ( ChainRange ( Point header)) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header)	Mark the start of receiving a streaming batch of blocks. This will be followed by one or more `CompletedBlockFetch` and a final `CompletedFetchBatch` .
CompletedBlockFetch ( Point header) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header) NominalDiffTime SizeInBytes	Mark the completion of of receiving a single block within a streaming batch of blocks.
CompletedFetchBatch ( ChainRange ( Point header)) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header)	Mark the successful end of receiving a streaming batch of blocks
RejectedFetchBatch ( ChainRange ( Point header)) ( PeerFetchInFlight header) PeerFetchInFlightLimits ( PeerFetchStatus header)	If the other peer rejects our request then we have this event instead of `StartedFetchBatch` and `CompletedFetchBatch` .
ClientTerminating Int	The client is terminating. Log the number of outstanding requests.

Instances

Instances details

( StandardHash header, Show header) => Show ( TraceFetchClientState header) Source #
Instance details Defined in Ouroboros.Network.BlockFetch.ClientState Methods showsPrec :: Int -> TraceFetchClientState header -> ShowS Source # show :: TraceFetchClientState header -> String Source # showList :: [ TraceFetchClientState header] -> ShowS Source #