Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.InboundGovernor

Contents

Run Inbound Protocol Governor
Trace
Re-exports
API's exported for testing purposes

Description

Server implementation based on ConnectionManager

This module should be imported qualified.

Synopsis

data PublicState peerAddr versionData = PublicState {
- inboundDuplexPeers :: !(Map peerAddr versionData)
- remoteStateMap :: Map (ConnectionId peerAddr) RemoteSt
}
data Arguments (muxMode :: Mode) handlerTrace socket peerAddr initiatorCtx responderCtx handle handleError versionNumber versionData bytes (m :: Type -> Type) a b x = Arguments {
- transitionTracer :: Tracer m (RemoteTransitionTrace peerAddr)
- tracer :: Tracer m (Trace peerAddr)
- debugTracer :: Tracer m (Debug peerAddr versionData)
- connectionDataFlow :: versionData -> DataFlow
- infoChannel :: InboundGovernorInfoChannel muxMode initiatorCtx peerAddr versionData ByteString m a b
- idleTimeout :: Maybe DiffTime
- withConnectionManager :: ConnectionHandler muxMode handlerTrace socket peerAddr handle handleError versionNumber versionData m -> (ConnectionManager muxMode socket peerAddr handle handleError m -> m x) -> m x
- mkConnectionHandler :: (StrictTVar m (StrictMaybe ResponderCounters) -> Tracer m (WithBearer (ConnectionId peerAddr) Trace)) -> ConnectionHandler muxMode handlerTrace socket peerAddr handle handleError versionNumber versionData m
}
with :: forall (muxMode :: Mode) socket peerAddr initiatorCtx responderCtx handle handlerTrace handleError versionData versionNumber bytes m a b x. (Alternative (STM m), MonadAsync m, MonadCatch m, MonadEvaluate m, MonadLabelledSTM m, MonadThrow m, MonadThrow (STM m), MonadTime m, MonadTimer m, MonadMask m, Ord peerAddr, HasResponder muxMode ~ 'True, MonadTraceSTM m, MonadFork m, MonadDelay m, Show peerAddr) => Arguments muxMode handlerTrace socket peerAddr initiatorCtx responderCtx handle handleError versionNumber versionData bytes m a b x -> (Async m Void -> m (PublicState peerAddr versionData) -> ConnectionManager muxMode socket peerAddr handle handleError m -> m x) -> m x
data Trace peerAddr
- = TrNewConnection !Provenance !(ConnectionId peerAddr)
- | TrResponderRestarted !(ConnectionId peerAddr) !MiniProtocolNum
- | TrResponderStartFailure !(ConnectionId peerAddr) !MiniProtocolNum !SomeException
- | TrResponderErrored !(ConnectionId peerAddr) !MiniProtocolNum !SomeException
- | TrResponderStarted !(ConnectionId peerAddr) !MiniProtocolNum
- | TrResponderTerminated !(ConnectionId peerAddr) !MiniProtocolNum
- | TrPromotedToWarmRemote !(ConnectionId peerAddr) !(OperationResult AbstractState)
- | TrPromotedToHotRemote !(ConnectionId peerAddr)
- | TrDemotedToWarmRemote !(ConnectionId peerAddr)
- | TrDemotedToColdRemote !(ConnectionId peerAddr) !(OperationResult DemotedToColdRemoteTr)
- | TrWaitIdleRemote !(ConnectionId peerAddr) !(OperationResult AbstractState)
- | TrMuxCleanExit !(ConnectionId peerAddr)
- | TrMuxErrored !(ConnectionId peerAddr) SomeException
- | TrInboundGovernorCounters !Counters
- | TrRemoteState !(Map (ConnectionId peerAddr) RemoteSt)
- | TrUnexpectedlyFalseAssertion !(IGAssertionLocation peerAddr)
- | TrInboundGovernorError !SomeException
- | TrMaturedConnections !(Set peerAddr) !(Set peerAddr)
- | TrInactive ![(peerAddr, Time)]
data Debug peerAddr versionData = Debug (State muxMode initiatorCtx peerAddr versionData m a b)
data Event (muxMode :: Mode) handle initiatorCtx peerAddr versionData (m :: Type -> Type) a b
- = NewConnection !(NewConnectionInfo peerAddr handle)
- | MuxFinished !(ConnectionId peerAddr) (STM m (Maybe SomeException))
- | MiniProtocolTerminated !(Terminated muxMode initiatorCtx peerAddr m a b)
- | WaitIdleRemote !(ConnectionId peerAddr)
- | RemotePromotedToHot !(ConnectionId peerAddr)
- | RemoteDemotedToWarm !(ConnectionId peerAddr)
- | CommitRemote !(ConnectionId peerAddr)
- | AwakeRemote !(ConnectionId peerAddr)
- | MaturedDuplexPeers !(Map peerAddr versionData) !(OrdPSQ peerAddr Time versionData)
- | InactivityTimeout
data NewConnectionInfo peerAddr handle = NewConnectionInfo !Provenance !(ConnectionId peerAddr) !DataFlow !handle
data RemoteSt
- = RemoteWarmSt
- | RemoteHotSt
- | RemoteIdleSt
- | RemoteColdSt
type RemoteTransition = Transition' (Maybe RemoteSt)
type RemoteTransitionTrace peerAddr = TransitionTrace' peerAddr (Maybe RemoteSt)
data AcceptConnectionsPolicyTrace
data Transition' state = Transition {
- fromState :: !state
- toState :: !state
}
data TransitionTrace' id state = TransitionTrace {
- ttPeerAddr :: id
- ttTransition :: Transition' state
}
data ResponderCounters = ResponderCounters {
- numTraceHotResponders :: !Int
- numTraceNonHotResponders :: !Int
}
maturedPeers :: Ord peerAddr => Time -> OrdPSQ peerAddr Time versionData -> (Map peerAddr versionData, OrdPSQ peerAddr Time versionData)

Run Inbound Protocol Governor

data PublicState peerAddr versionData Source #

Public inbound governor state.

Constructors

PublicState
Fields inboundDuplexPeers :: !(Map peerAddr versionData) A map of mature inbound duplex connections. These peers are used for light peer sharing (e.g. bootstrapping peer sharing). remoteStateMap :: Map (ConnectionId peerAddr) RemoteSt Map of `RemoteSt`. It is lazy on purpose. It is created from `igsConnections`, so it should not point to any thunks that should be GC-ed leading to a memory leak.

data Arguments (muxMode :: Mode) handlerTrace socket peerAddr initiatorCtx responderCtx handle handleError versionNumber versionData bytes (m :: Type -> Type) a b x Source #

Constructors

Arguments

Fields

transitionTracer :: Tracer m (RemoteTransitionTrace peerAddr)
transition tracer
tracer :: Tracer m (Trace peerAddr)
main inbound governor tracer
debugTracer :: Tracer m (Debug peerAddr versionData)
debug inbound governor tracer
connectionDataFlow :: versionData -> DataFlow
connection data flow
infoChannel :: InboundGovernorInfoChannel muxMode initiatorCtx peerAddr versionData ByteString m a b
InformationChannel which passes NewConnectionInfo for outbound connections from connection manager to the inbound governor.
idleTimeout :: Maybe DiffTime
protocol idle timeout. The remote site must restart a mini-protocol within given timeframe (Nothing indicates no timeout).
withConnectionManager :: ConnectionHandler muxMode handlerTrace socket peerAddr handle handleError versionNumber versionData m -> (ConnectionManager muxMode socket peerAddr handle handleError m -> m x) -> m x
connection manager continuation
mkConnectionHandler :: (StrictTVar m (StrictMaybe ResponderCounters) -> Tracer m (WithBearer (ConnectionId peerAddr) Trace)) -> ConnectionHandler muxMode handlerTrace socket peerAddr handle handleError versionNumber versionData m
Connection handler builder, which injects a special tracer created here and routed into the muxer via the connection manager. The purpose is to inform the IG loop of miniprotocol responder activity such that proper and efficient peer coldwarmhot transitions can be tracked.

with :: forall (muxMode :: Mode) socket peerAddr initiatorCtx responderCtx handle handlerTrace handleError versionData versionNumber bytes m a b x. (Alternative (STM m), MonadAsync m, MonadCatch m, MonadEvaluate m, MonadLabelledSTM m, MonadThrow m, MonadThrow (STM m), MonadTime m, MonadTimer m, MonadMask m, Ord peerAddr, HasResponder muxMode ~ 'True, MonadTraceSTM m, MonadFork m, MonadDelay m, Show peerAddr) => Arguments muxMode handlerTrace socket peerAddr initiatorCtx responderCtx handle handleError versionNumber versionData bytes m a b x -> (Async m Void -> m (PublicState peerAddr versionData) -> ConnectionManager muxMode socket peerAddr handle handleError m -> m x) -> m x Source #

Run the server, which consists of the following components:

inbound governor, it corresponds to p2p-governor on outbound side
accept loop(s), one per given ip address. We support up to one ipv4 address and up to one ipv6 address, i.e. an ipv6 enabled node will run two accept loops on listening on different addresses with shared inbound governor.

The server can be run in either of two Mode-es:

InitiatorResponderMode
ResponderMode

The first one is used in data diffusion for Node-To-Node protocol, while the other is useful for running a server for the Node-To-Client protocol.

Trace

data Trace peerAddr Source #

Constructors

TrNewConnection !Provenance !(ConnectionId peerAddr)
TrResponderRestarted !(ConnectionId peerAddr) !MiniProtocolNum
TrResponderStartFailure !(ConnectionId peerAddr) !MiniProtocolNum !SomeException
TrResponderErrored !(ConnectionId peerAddr) !MiniProtocolNum !SomeException
TrResponderStarted !(ConnectionId peerAddr) !MiniProtocolNum
TrResponderTerminated !(ConnectionId peerAddr) !MiniProtocolNum
TrPromotedToWarmRemote !(ConnectionId peerAddr) !(OperationResult AbstractState)
TrPromotedToHotRemote !(ConnectionId peerAddr)
TrDemotedToWarmRemote !(ConnectionId peerAddr)
TrDemotedToColdRemote !(ConnectionId peerAddr) !(OperationResult DemotedToColdRemoteTr)	All mini-protocols terminated. The boolean is true if this connection was not used by p2p-governor, and thus the connection will be terminated.
TrWaitIdleRemote !(ConnectionId peerAddr) !(OperationResult AbstractState)
TrMuxCleanExit !(ConnectionId peerAddr)
TrMuxErrored !(ConnectionId peerAddr) SomeException
TrInboundGovernorCounters !Counters
TrRemoteState !(Map (ConnectionId peerAddr) RemoteSt)
TrUnexpectedlyFalseAssertion !(IGAssertionLocation peerAddr)	This case is unexpected at call site.
TrInboundGovernorError !SomeException
TrMaturedConnections !(Set peerAddr) !(Set peerAddr)
TrInactive ![(peerAddr, Time)]

Instances

Instances details

Show peerAddr => Show (Trace peerAddr) Source #
Instance details Defined in Ouroboros.Network.InboundGovernor Methods showsPrec :: Int -> Trace peerAddr -> ShowS # show :: Trace peerAddr -> String # showList :: [Trace peerAddr] -> ShowS #

data Debug peerAddr versionData Source #

Constructors

Debug (State muxMode initiatorCtx peerAddr versionData m a b)

data Event (muxMode :: Mode) handle initiatorCtx peerAddr versionData (m :: Type -> Type) a b Source #

Edge triggered events to which the inbound protocol governor reacts.

Constructors

NewConnection !(NewConnectionInfo peerAddr handle)	A request to start mini-protocol bundle, either from the server or from connection manager after a duplex connection was negotiated.
MuxFinished !(ConnectionId peerAddr) (STM m (Maybe SomeException))	A multiplexer exited.
MiniProtocolTerminated !(Terminated muxMode initiatorCtx peerAddr m a b)	A mini-protocol terminated either cleanly or abruptly.
WaitIdleRemote !(ConnectionId peerAddr)	Transition from `RemoteEstablished` to `RemoteIdle`.
RemotePromotedToHot !(ConnectionId peerAddr)	A remote `warm → hot` transition. It is scheduled as soon as all hot mini-protocols are running.
RemoteDemotedToWarm !(ConnectionId peerAddr)	A `hot → warm` transition. It is scheduled as soon as any hot mini-protocol terminates.
CommitRemote !(ConnectionId peerAddr)	Transition from `RemoteIdle` to `RemoteCold`.
AwakeRemote !(ConnectionId peerAddr)	Transition from `RemoteIdle` or `RemoteCold` to `RemoteEstablished`.
MaturedDuplexPeers	Update `igsMatureDuplexPeers` and `igsFreshDuplexPeers`.
Fields !(Map peerAddr versionData) newly matured duplex peers !(OrdPSQ peerAddr Time versionData) queue of fresh duplex peers
InactivityTimeout

data NewConnectionInfo peerAddr handle Source #

Announcement message for a new connection.

Constructors

NewConnectionInfo !Provenance !(ConnectionId peerAddr) !DataFlow !handle

Announce a new connection. Inbound protocol governor will start responder protocols using StartOnDemand strategy and monitor remote transitions: PromotedToWarm^{Duplex}_{Remote} and DemotedToCold^{dataFlow}_{Remote}.

Instances

Instances details

Show peerAddr => Show (NewConnectionInfo peerAddr handle) Source #
Instance details Defined in Ouroboros.Network.InboundGovernor Methods showsPrec :: Int -> NewConnectionInfo peerAddr handle -> ShowS # show :: NewConnectionInfo peerAddr handle -> String # showList :: [NewConnectionInfo peerAddr handle] -> ShowS #

data RemoteSt Source #

Remote connection state tracked by inbound protocol governor.

This type is used for tracing.

Constructors

RemoteWarmSt
RemoteHotSt
RemoteIdleSt
RemoteColdSt

Instances

Instances details

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

type RemoteTransition = Transition' (Maybe RemoteSt) Source #

Nothing represents uninitialised state.

type RemoteTransitionTrace peerAddr = TransitionTrace' peerAddr (Maybe RemoteSt) Source #

data AcceptConnectionsPolicyTrace Source #

Trace for the AcceptConnectionsLimit policy.

Constructors

ServerTraceAcceptConnectionRateLimiting DiffTime Int
ServerTraceAcceptConnectionHardLimit Word32
ServerTraceAcceptConnectionResume Int

Instances

Instances details

Show AcceptConnectionsPolicyTrace Source #
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods showsPrec :: Int -> AcceptConnectionsPolicyTrace -> ShowS # show :: AcceptConnectionsPolicyTrace -> String # showList :: [AcceptConnectionsPolicyTrace] -> ShowS #
Eq AcceptConnectionsPolicyTrace Source #
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods (==) :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> Bool # (/=) :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> Bool #
Ord AcceptConnectionsPolicyTrace Source #
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods compare :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> Ordering # (<) :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> Bool # (<=) :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> Bool # (>) :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> Bool # (>=) :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> Bool # max :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace # min :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace #

Re-exports

data Transition' state Source #

Constructors

Transition
Fields fromState :: !state toState :: !state

Instances

Instances details

Functor Transition' Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods fmap :: (a -> b) -> Transition' a -> Transition' b # (<$) :: a -> Transition' b -> Transition' a #
Show state => Show (Transition' state) Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods showsPrec :: Int -> Transition' state -> ShowS # show :: Transition' state -> String # showList :: [Transition' state] -> ShowS #
Eq state => Eq (Transition' state) Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods (==) :: Transition' state -> Transition' state -> Bool # (/=) :: Transition' state -> Transition' state -> Bool #

data TransitionTrace' id state Source #

Constructors

TransitionTrace
Fields ttPeerAddr :: id an id of a connection, not necessarily an address, e.g. `ConnStateId` ttTransition :: Transition' state

Instances

Instances details

Functor (TransitionTrace' id) Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods fmap :: (a -> b) -> TransitionTrace' id a -> TransitionTrace' id b # (<$) :: a -> TransitionTrace' id b -> TransitionTrace' id a #
(Show peerAddr, Show state) => Show (TransitionTrace' peerAddr state) Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods showsPrec :: Int -> TransitionTrace' peerAddr state -> ShowS # show :: TransitionTrace' peerAddr state -> String # showList :: [TransitionTrace' peerAddr state] -> ShowS #

data ResponderCounters Source #

The IG maintains a state of the number of hot and warm miniprotocol responders to track transitions and notify the connection manager for interesting events.

Constructors

ResponderCounters
Fields numTraceHotResponders :: !Int numTraceNonHotResponders :: !Int

API's exported for testing purposes

maturedPeers :: Ord peerAddr => Time -> OrdPSQ peerAddr Time versionData -> (Map peerAddr versionData, OrdPSQ peerAddr Time versionData) Source #