Modulebase-4.23.0.0Haskell2010

GHC.RTS.Flags

The API of this module is unstable and is tightly coupled to GHC's internals. If depend on it, make sure to use a tight upper bound, e.g., base < 4.X rather than base < 5, because the interface can change rapidly without much warning.

Descriptions of flags can be seen in GHC User's Guide, or by running RTS help message using +RTS --help.

This module is a compatibility layer. It is meant to be temporary to allow for the eventual deprecation of these declarations as described in CLC proposal #289. These declarations are now instead available from the ghc-experimental package.

18 types
11 values

Packagebase-4.23.0.0
Exports29
LanguageHaskell2010
LicenceBSD-3-Clause
SourceFlags.hs

typetype RtsTime = Word64

RtsTime is defined as a StgWord64 in stg/Types.h

datadata RTSFlags

Parameters of the runtime system

Constructors

RTSFlags
- gcFlags :: GCFlags
- concurrentFlags :: ConcFlags
- miscFlags :: MiscFlags
- debugFlags :: DebugFlags
- costCentreFlags :: CCFlags
- profilingFlags :: ProfFlags
- traceFlags :: TraceFlags
- tickyFlags :: TickyFlags
- parFlags :: ParFlags
- hpcFlags :: HpcFlags

Instances3Show, Generic, Rep

Show RTSFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic RTSFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep RTSFlags = D1 ('MetaData "RTSFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "RTSFlags" 'PrefixI 'True) (((S1 ('MetaSel ('Just "gcFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GCFlags) :*: S1 ('MetaSel ('Just "concurrentFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConcFlags)) :*: (S1 ('MetaSel ('Just "miscFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MiscFlags) :*: (S1 ('MetaSel ('Just "debugFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DebugFlags) :*: S1 ('MetaSel ('Just "costCentreFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CCFlags)))) :*: ((S1 ('MetaSel ('Just "profilingFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProfFlags) :*: S1 ('MetaSel ('Just "traceFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TraceFlags)) :*: (S1 ('MetaSel ('Just "tickyFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TickyFlags) :*: (S1 ('MetaSel ('Just "parFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ParFlags) :*: S1 ('MetaSel ('Just "hpcFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HpcFlags))))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata GiveGCStats

Should we produce a summary of the garbage collector statistics after the program has exited?

NoGCStats CollectGCStats OneLineGCStats SummaryGCStats VerboseGCStats

Instances3Show, Generic, Rep

Show GiveGCStatsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic GiveGCStatsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep GiveGCStats = D1 ('MetaData "GiveGCStats" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) ((C1 ('MetaCons "NoGCStats" 'PrefixI 'False) U1 :+: C1 ('MetaCons "CollectGCStats" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "OneLineGCStats" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "SummaryGCStats" 'PrefixI 'False) U1 :+: C1 ('MetaCons "VerboseGCStats" 'PrefixI 'False) U1)))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata GCFlags

Parameters of the garbage collector.

Constructors

GCFlags
- statsFile :: Maybe FilePath
- giveStats :: GiveGCStats
- maxStkSize :: Word32
- initialStkSize :: Word32
- stkChunkSize :: Word32
- stkChunkBufferSize :: Word32
- maxHeapSize :: Word32
- minAllocAreaSize :: Word32
- largeAllocLim :: Word32
- nurseryChunkSize :: Word32
- minOldGenSize :: Word32
- heapSizeSuggestion :: Word32
- heapSizeSuggestionAuto :: Bool
- oldGenFactor :: Double
- returnDecayFactor :: Double
- pcFreeHeap :: Double
- generations :: Word32
- squeezeUpdFrames :: Bool
- compact :: Bool
  True = "compact all the time"
- compactThreshold :: Double
- sweep :: Bool
  use "mostly mark-sweep" instead of copying for the oldest generation
- ringBell :: Bool
- idleGCDelayTime :: RtsTime
- doIdleGC :: Bool
- heapBase :: Word
  address to ask the OS for memory
- allocLimitGrace :: Word
- numa :: Bool
- numaMask :: Word

Instances3Show, Generic, Rep

Show GCFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic GCFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep GCFlags = D1 ('MetaData "GCFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "GCFlags" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "statsFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: (S1 ('MetaSel ('Just "giveStats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GiveGCStats) :*: S1 ('MetaSel ('Just "maxStkSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32))) :*: ((S1 ('MetaSel ('Just "initialStkSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: S1 ('MetaSel ('Just "stkChunkSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "stkChunkBufferSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: S1 ('MetaSel ('Just "maxHeapSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))) :*: ((S1 ('MetaSel ('Just "minAllocAreaSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "largeAllocLim") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: S1 ('MetaSel ('Just "nurseryChunkSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32))) :*: ((S1 ('MetaSel ('Just "minOldGenSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: S1 ('MetaSel ('Just "heapSizeSuggestion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "heapSizeSuggestionAuto") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "oldGenFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))))) :*: (((S1 ('MetaSel ('Just "returnDecayFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "pcFreeHeap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "generations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32))) :*: ((S1 ('MetaSel ('Just "squeezeUpdFrames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "compact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "compactThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "sweep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "ringBell") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "idleGCDelayTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RtsTime) :*: S1 ('MetaSel ('Just "doIdleGC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "heapBase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :*: S1 ('MetaSel ('Just "allocLimitGrace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)) :*: (S1 ('MetaSel ('Just "numa") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "numaMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata ConcFlags

Parameters concerning context switching

Constructors

ConcFlags
- ctxtSwitchTime :: RtsTime
- ctxtSwitchTicks :: Int

Instances3Show, Generic, Rep

Show ConcFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic ConcFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep ConcFlags = D1 ('MetaData "ConcFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "ConcFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "ctxtSwitchTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RtsTime) :*: S1 ('MetaSel ('Just "ctxtSwitchTicks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata MiscFlags

Miscellaneous parameters

Constructors

MiscFlags
- tickInterval :: RtsTime
- installSignalHandlers :: Bool
- installSEHHandlers :: Bool
- generateCrashDumpFile :: Bool
- generateStackTrace :: Bool
- machineReadable :: Bool
- disableDelayedOsMemoryReturn :: Bool
- internalCounters :: Bool
- linkerAlwaysPic :: Bool
- linkerMemBase :: Word
  address to ask the OS for memory for the linker, 0 ==> off
- ioManager :: IoManagerFlag
- numIoWorkerThreads :: Word32

Instances3Show, Generic, Rep

Show MiscFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic MiscFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep MiscFlags = D1 ('MetaData "MiscFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "MiscFlags" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tickInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RtsTime) :*: (S1 ('MetaSel ('Just "installSignalHandlers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "installSEHHandlers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "generateCrashDumpFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "generateStackTrace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "machineReadable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "disableDelayedOsMemoryReturn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "internalCounters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "linkerAlwaysPic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "linkerMemBase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :*: (S1 ('MetaSel ('Just "ioManager") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IoManagerFlag) :*: S1 ('MetaSel ('Just "numIoWorkerThreads") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32))))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata IoManagerFlag

Constructors

IoManagerFlagAuto
IoManagerFlagSelect
Unix only, non-threaded RTS only
IoManagerFlagMIO
cross-platform, threaded RTS only
IoManagerFlagWinIO
Windows only
IoManagerFlagWin32Legacy
Windows only, non-threaded RTS only

Instances3Enum, Eq, Show

Enum IoManagerFlagDefined in base-4.23.0.0 · GHC.RTS.Flags
Eq IoManagerFlagDefined in base-4.23.0.0 · GHC.RTS.Flags
Show IoManagerFlagDefined in base-4.23.0.0 · GHC.RTS.Flags

datadata DebugFlags

Flags to control debugging output & extra checking in various subsystems.

Constructors

DebugFlags
- scheduler :: Bool
```
s
```
- interpreter :: Bool
```
i
```
- weak :: Bool
```
w
```
- gccafs :: Bool
```
G
```
- gc :: Bool
```
g
```
- nonmoving_gc :: Bool
```
n
```
- block_alloc :: Bool
```
b
```
- sanity :: Bool
```
S
```
- stable :: Bool
```
t
```
- prof :: Bool
```
p
```
- linker :: Bool
  l the object linker
- apply :: Bool
```
a
```
- stm :: Bool
```
m
```
- squeeze :: Bool
  z stack squeezing & lazy blackholing
- hpc :: Bool
  c coverage
- sparks :: Bool
```
r
```

Instances3Show, Generic, Rep

Show DebugFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic DebugFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep DebugFlags = D1 ('MetaData "DebugFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "DebugFlags" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "scheduler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "interpreter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "weak") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "gccafs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "gc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "nonmoving_gc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "block_alloc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "sanity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: (((S1 ('MetaSel ('Just "stable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "prof") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "linker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "apply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "stm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "squeeze") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "hpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "sparks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata DoCostCentres

Should the RTS produce a cost-center summary?

CostCentresNone CostCentresSummary CostCentresVerbose CostCentresAll CostCentresJSON

Instances3Show, Generic, Rep

Show DoCostCentresDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic DoCostCentresDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep DoCostCentres = D1 ('MetaData "DoCostCentres" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) ((C1 ('MetaCons "CostCentresNone" 'PrefixI 'False) U1 :+: C1 ('MetaCons "CostCentresSummary" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "CostCentresVerbose" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "CostCentresAll" 'PrefixI 'False) U1 :+: C1 ('MetaCons "CostCentresJSON" 'PrefixI 'False) U1)))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata CCFlags

Parameters pertaining to the cost-center profiler.

Constructors

CCFlags
- doCostCentres :: DoCostCentres
- profilerTicks :: Int
- msecsPerTick :: Int

Instances3Show, Generic, Rep

Show CCFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic CCFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep CCFlags = D1 ('MetaData "CCFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "CCFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "doCostCentres") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DoCostCentres) :*: (S1 ('MetaSel ('Just "profilerTicks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "msecsPerTick") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata DoHeapProfile

What sort of heap profile are we collecting?

Instances3Show, Generic, Rep

Show DoHeapProfileDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic DoHeapProfileDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep DoHeapProfile = D1 ('MetaData "DoHeapProfile" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (((C1 ('MetaCons "NoHeapProfiling" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HeapByCCS" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "HeapByMod" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "HeapByDescr" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HeapByType" 'PrefixI 'False) U1))) :+: ((C1 ('MetaCons "HeapByRetainer" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HeapByLDV" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "HeapByClosureType" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "HeapByInfoTable" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HeapByEra" 'PrefixI 'False) U1))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata ProfFlags

Parameters of the cost-center profiler

Constructors

ProfFlags
- doHeapProfile :: DoHeapProfile
- heapProfileInterval :: RtsTime
  time between samples
- heapProfileIntervalTicks :: Word
  ticks between samples (derived)
- startHeapProfileAtStartup :: Bool
- startTimeProfileAtStartup :: Bool
- showCCSOnException :: Bool
- automaticEraIncrement :: Bool
- maxRetainerSetSize :: Word
- ccsLength :: Word
- modSelector :: Maybe String
- descrSelector :: Maybe String
- typeSelector :: Maybe String
- ccSelector :: Maybe String
- ccsSelector :: Maybe String
- retainerSelector :: Maybe String
- bioSelector :: Maybe String
- eraSelector :: Word

Instances3Show, Generic, Rep

Show ProfFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic ProfFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep ProfFlags = D1 ('MetaData "ProfFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "ProfFlags" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "doHeapProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DoHeapProfile) :*: S1 ('MetaSel ('Just "heapProfileInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RtsTime)) :*: (S1 ('MetaSel ('Just "heapProfileIntervalTicks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :*: S1 ('MetaSel ('Just "startHeapProfileAtStartup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "startTimeProfileAtStartup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "showCCSOnException") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "automaticEraIncrement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "maxRetainerSetSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))) :*: (((S1 ('MetaSel ('Just "ccsLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :*: S1 ('MetaSel ('Just "modSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String))) :*: (S1 ('MetaSel ('Just "descrSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "typeSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)))) :*: ((S1 ('MetaSel ('Just "ccSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "ccsSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String))) :*: (S1 ('MetaSel ('Just "retainerSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: (S1 ('MetaSel ('Just "bioSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "eraSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata DoTrace

Is event tracing enabled?

Constructors

TraceNone
no tracing
TraceEventLog
send tracing events to the event log
TraceStderr
send tracing events to stderr

Instances3Show, Generic, Rep

Show DoTraceDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic DoTraceDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep DoTrace = D1 ('MetaData "DoTrace" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "TraceNone" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "TraceEventLog" 'PrefixI 'False) U1 :+: C1 ('MetaCons "TraceStderr" 'PrefixI 'False) U1))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata TraceFlags

Parameters pertaining to event tracing

Constructors

TraceFlags
- tracing :: DoTrace
- timestamp :: Bool
  show timestamp in stderr output
- traceScheduler :: Bool
  trace scheduler events
- traceGc :: Bool
  trace GC events
- traceNonmovingGc :: Bool
  trace nonmoving GC heap census samples
- sparksSampled :: Bool
  trace spark events by a sampled method
- sparksFull :: Bool
  trace spark events 100% accurately
- user :: Bool
  trace user events (emitted from Haskell code)

Instances3Show, Generic, Rep

Show TraceFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic TraceFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep TraceFlags = D1 ('MetaData "TraceFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "TraceFlags" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tracing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DoTrace) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "traceScheduler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "traceGc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "traceNonmovingGc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "sparksSampled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "sparksFull") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata TickyFlags

Parameters pertaining to ticky-ticky profiler

Constructors

TickyFlags
- showTickyStats :: Bool
- tickyFile :: Maybe FilePath

Instances3Show, Generic, Rep

Show TickyFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic TickyFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep TickyFlags = D1 ('MetaData "TickyFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "TickyFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "showTickyStats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "tickyFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata ParFlags

Parameters pertaining to parallelism

Constructors

ParFlags
- nCapabilities :: Word32
- migrate :: Bool
- maxLocalSparks :: Word32
- parGcEnabled :: Bool
- parGcGen :: Word32
- parGcLoadBalancingEnabled :: Bool
- parGcLoadBalancingGen :: Word32
- parGcNoSyncWithIdle :: Word32
- parGcThreads :: Word32
- setAffinity :: Bool

Instances3Show, Generic, Rep

Show ParFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic ParFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep ParFlags = D1 ('MetaData "ParFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "ParFlags" 'PrefixI 'True) (((S1 ('MetaSel ('Just "nCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: S1 ('MetaSel ('Just "migrate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "maxLocalSparks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "parGcEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "parGcGen") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))) :*: ((S1 ('MetaSel ('Just "parGcLoadBalancingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "parGcLoadBalancingGen") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "parGcNoSyncWithIdle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "parGcThreads") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: S1 ('MetaSel ('Just "setAffinity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata HpcFlags

Parameters pertaining to Haskell program coverage (HPC)

Constructors

HpcFlags
- readTixFile :: Bool
  Controls whether a program.tix file is read at the start of execution to initialize the RTS internal HPC datastructures.
- writeTixFile :: Bool
  Controls whether the program.tix file should be written after the execution of the program.

Instances3Show, Generic, Rep

Show HpcFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
Generic HpcFlagsDefined in base-4.23.0.0 · GHC.RTS.Flags
type Rep HpcFlags = D1 ('MetaData "HpcFlags" "GHC.RTS.Flags" "base-4.23.0.0-3279" 'False) (C1 ('MetaCons "HpcFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "readTixFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "writeTixFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))Defined in base-4.23.0.0 · GHC.RTS.Flags

datadata IoSubSystem

The I/O SubSystem to use in the program.

Constructors

IoPOSIX
Use a POSIX I/O Sub-System
IoNative
Use platform native Sub-System. For unix OSes this is the same as IoPOSIX, but on Windows this means use the Windows native APIs for I/O, including IOCP and RIO.

Instances3Enum, Eq, Show

Enum IoSubSystemDefined in ghc-internal-10.0.0 · GHC.Internal.IO.SubSystem
Eq IoSubSystemDefined in ghc-internal-10.0.0 · GHC.Internal.IO.SubSystem
Show IoSubSystemDefined in ghc-internal-10.0.0 · GHC.Internal.IO.SubSystem

valuegetRTSFlags :: IO RTSFlags

valuegetGCFlags :: IO GCFlags

valuegetConcFlags :: IO ConcFlags

valuegetMiscFlags :: IO MiscFlags

valuegetDebugFlags :: IO DebugFlags

valuegetCCFlags :: IO CCFlags

valuegetProfFlags :: IO ProfFlags

valuegetTraceFlags :: IO TraceFlags

valuegetTickyFlags :: IO TickyFlags

valuegetParFlags :: IO ParFlags

valuegetHpcFlags :: IO HpcFlags