Safe Haskell	None
Language	GHC2021

Wireform.Transport.Config

Contents

Synopsis

data Profile
- = Throughput
- | LowLatency
- | UltraLowLatency
profileConfig :: Profile -> TransportConfig
data TransportConfig = TransportConfig {
- ringSizeHint :: !Int
- waitPolicy :: !WaitPolicy
- pinning :: !PinningPolicy
- pages :: !PagePolicy
- memoryLocking :: !Bool
- numaPlacement :: !NumaPolicy
- ioUring :: !IOUringConfig
- onCapabilityLimit :: !CapabilityAction
}
defaultTransportConfig :: TransportConfig
data WaitPolicy
data SpinBudget
- = SpinIterations !Int
- | SpinNanos !Int
- | SpinUntilPaused
data PinningPolicy
- = NoPinning
- | PinToCore !Int
- | PinToCoreSet ![Int]
- | PinNearFd
- | PinIsolated
data PagePolicy
- = StandardPages
- | PreferHugePages
- | RequireHugePages
data NumaPolicy
- = NoNumaPreference
- | NumaNode !Int
- | NumaAutoFromFd
- | NumaAutoFromCurrentCore
data IOUringConfig = IOUringConfig {
- ioUringQueueDepth :: !Int
- ioUringSQPoll :: !SQPollPolicy
- ioUringProvidedBuffers :: !Bool
- ioUringCompletionWait :: !CompletionWaitMode
}
data SQPollPolicy
- = NoSQPoll
- | SQPollWithIdle !Int
data CompletionWaitMode
- = WaitViaEventFd
- | WaitViaBusyPoll
defaultIOUringConfig :: IOUringConfig
data CapabilityAction
- = SilentlyIgnore
- | LogAndContinue
- | FailHard

Profiles

data Profile Source #

High-level performance profile. Most users pick one of these and never touch TransportConfig directly.

Constructors

Throughput	IO-manager-parked. Good citizen on shared systems.
LowLatency	Brief spin before parking, pinned thread, huge pages where available.
UltraLowLatency	Pure busy-poll, pinned to isolated core, huge pages, mlock. Burns one CPU core permanently.

Instances

Instances details

Bounded Profile Source #
Instance details Defined in Wireform.Transport.Config Methods minBound :: Profile # maxBound :: Profile #
Enum Profile Source #
Instance details Defined in Wireform.Transport.Config Methods succ :: Profile -> Profile # pred :: Profile -> Profile # toEnum :: Int -> Profile # fromEnum :: Profile -> Int # enumFrom :: Profile -> [Profile] # enumFromThen :: Profile -> Profile -> [Profile] # enumFromTo :: Profile -> Profile -> [Profile] # enumFromThenTo :: Profile -> Profile -> Profile -> [Profile] #
Read Profile Source #
Instance details Defined in Wireform.Transport.Config Methods readsPrec :: Int -> ReadS Profile # readList :: ReadS [Profile] # readPrec :: ReadPrec Profile # readListPrec :: ReadPrec [Profile] #
Show Profile Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> Profile -> ShowS # show :: Profile -> String # showList :: [Profile] -> ShowS #
Eq Profile Source #
Instance details Defined in Wireform.Transport.Config Methods (==) :: Profile -> Profile -> Bool # (/=) :: Profile -> Profile -> Bool #
Ord Profile Source #
Instance details Defined in Wireform.Transport.Config Methods compare :: Profile -> Profile -> Ordering # (<) :: Profile -> Profile -> Bool # (<=) :: Profile -> Profile -> Bool # (>) :: Profile -> Profile -> Bool # (>=) :: Profile -> Profile -> Bool # max :: Profile -> Profile -> Profile # min :: Profile -> Profile -> Profile #

profileConfig :: Profile -> TransportConfig Source #

Expand a profile into a full TransportConfig.

Full configuration

data TransportConfig Source #

Constructors

TransportConfig

Fields

ringSizeHint :: !Int
Requested ring size in bytes. Rounded up to page-size multiple and power of two. Default: 1 MiB.
waitPolicy :: !WaitPolicy
pinning :: !PinningPolicy
pages :: !PagePolicy
memoryLocking :: !Bool
mlock the ring. Requires sufficient RLIMIT_MEMLOCK.
numaPlacement :: !NumaPolicy
ioUring :: !IOUringConfig
Linux io_uring tuning (silently ignored elsewhere).
onCapabilityLimit :: !CapabilityAction
What to do when a knob cannot be applied on this platform.

Instances

Instances details

Show TransportConfig Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> TransportConfig -> ShowS # show :: TransportConfig -> String # showList :: [TransportConfig] -> ShowS #

defaultTransportConfig :: TransportConfig Source #

Wait policy

data WaitPolicy Source #

Constructors

WaitParkImmediately	Park on the IO manager as soon as caught up.
WaitSpinThenPark !SpinBudget	Busy-spin for the budget, then park.
WaitBusyPoll	Never park. Burns a core.

Instances

Instances details

Show WaitPolicy Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> WaitPolicy -> ShowS # show :: WaitPolicy -> String # showList :: [WaitPolicy] -> ShowS #

data SpinBudget Source #

Constructors

SpinIterations !Int
SpinNanos !Int
SpinUntilPaused

Instances

Instances details

Show SpinBudget Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> SpinBudget -> ShowS # show :: SpinBudget -> String # showList :: [SpinBudget] -> ShowS #

Pinning

data PinningPolicy Source #

Constructors

NoPinning
PinToCore !Int
PinToCoreSet ![Int]
PinNearFd	Auto-detect: pin near the NIC / fd's NUMA node.
PinIsolated	Pick an isolated core (Linux `isolcpus=`); fall back to `PinNearFd`.

Instances

Instances details

Show PinningPolicy Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> PinningPolicy -> ShowS # show :: PinningPolicy -> String # showList :: [PinningPolicy] -> ShowS #

Pages

data PagePolicy Source #

Constructors

StandardPages
PreferHugePages	Request huge pages; fall back to standard if unavailable.
RequireHugePages	Fail at ring creation if huge pages are unavailable.

Instances

Instances details

Show PagePolicy Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> PagePolicy -> ShowS # show :: PagePolicy -> String # showList :: [PagePolicy] -> ShowS #

NUMA

data NumaPolicy Source #

Constructors

NoNumaPreference
NumaNode !Int
NumaAutoFromFd
NumaAutoFromCurrentCore

Instances

Instances details

Show NumaPolicy Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> NumaPolicy -> ShowS # show :: NumaPolicy -> String # showList :: [NumaPolicy] -> ShowS #

io_uring

data IOUringConfig Source #

Constructors

IOUringConfig
Fields ioUringQueueDepth :: !Int ioUringSQPoll :: !SQPollPolicy ioUringProvidedBuffers :: !Bool ioUringCompletionWait :: !CompletionWaitMode

Instances

Instances details

Show IOUringConfig Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> IOUringConfig -> ShowS # show :: IOUringConfig -> String # showList :: [IOUringConfig] -> ShowS #

data SQPollPolicy Source #

Constructors

NoSQPoll
SQPollWithIdle !Int

Instances

Instances details

Show SQPollPolicy Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> SQPollPolicy -> ShowS # show :: SQPollPolicy -> String # showList :: [SQPollPolicy] -> ShowS #

data CompletionWaitMode Source #

Constructors

WaitViaEventFd
WaitViaBusyPoll

Instances

Instances details

Show CompletionWaitMode Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> CompletionWaitMode -> ShowS # show :: CompletionWaitMode -> String # showList :: [CompletionWaitMode] -> ShowS #

defaultIOUringConfig :: IOUringConfig Source #

Capability handling

data CapabilityAction Source #

Constructors

SilentlyIgnore
LogAndContinue
FailHard

Instances

Instances details

Bounded CapabilityAction Source #
Instance details Defined in Wireform.Transport.Config Methods minBound :: CapabilityAction # maxBound :: CapabilityAction #
Enum CapabilityAction Source #
Instance details Defined in Wireform.Transport.Config Methods succ :: CapabilityAction -> CapabilityAction # pred :: CapabilityAction -> CapabilityAction # toEnum :: Int -> CapabilityAction # fromEnum :: CapabilityAction -> Int # enumFrom :: CapabilityAction -> [CapabilityAction] # enumFromThen :: CapabilityAction -> CapabilityAction -> [CapabilityAction] # enumFromTo :: CapabilityAction -> CapabilityAction -> [CapabilityAction] # enumFromThenTo :: CapabilityAction -> CapabilityAction -> CapabilityAction -> [CapabilityAction] #
Read CapabilityAction Source #
Instance details Defined in Wireform.Transport.Config Methods readsPrec :: Int -> ReadS CapabilityAction # readList :: ReadS [CapabilityAction] # readPrec :: ReadPrec CapabilityAction # readListPrec :: ReadPrec [CapabilityAction] #
Show CapabilityAction Source #
Instance details Defined in Wireform.Transport.Config Methods showsPrec :: Int -> CapabilityAction -> ShowS # show :: CapabilityAction -> String # showList :: [CapabilityAction] -> ShowS #
Eq CapabilityAction Source #
Instance details Defined in Wireform.Transport.Config Methods (==) :: CapabilityAction -> CapabilityAction -> Bool # (/=) :: CapabilityAction -> CapabilityAction -> Bool #
Ord CapabilityAction Source #
Instance details Defined in Wireform.Transport.Config Methods compare :: CapabilityAction -> CapabilityAction -> Ordering # (<) :: CapabilityAction -> CapabilityAction -> Bool # (<=) :: CapabilityAction -> CapabilityAction -> Bool # (>) :: CapabilityAction -> CapabilityAction -> Bool # (>=) :: CapabilityAction -> CapabilityAction -> Bool # max :: CapabilityAction -> CapabilityAction -> CapabilityAction # min :: CapabilityAction -> CapabilityAction -> CapabilityAction #