GHC.RTS.Flags

Safe Haskell	Safe-Inferred
Language	Haskell2010

Description

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

Since: base-4.8.0.0

type RtsTime = Word64 Source

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

Since: base-4.8.2.0

data RTSFlags Source

Parameters of the runtime system

Since: base-4.8.0.0

Constructors

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

Instances

Instances details

Generic RTSFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep RTSFlags :: Type -> Type Source Methods from :: RTSFlags -> Rep RTSFlags x Source to :: Rep RTSFlags x -> RTSFlags Source
Show RTSFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> RTSFlags -> ShowS Source show :: RTSFlags -> String Source showList :: [RTSFlags] -> ShowS Source
type Rep RTSFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep RTSFlags = D1 ('MetaData "RTSFlags" "GHC.RTS.Flags" "base" '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))))))

data GiveGCStats Source

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

Since: base-4.8.2.0

Constructors

NoGCStats
CollectGCStats
OneLineGCStats
SummaryGCStats
VerboseGCStats

Instances

Instances details

Enum GiveGCStats Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods succ :: GiveGCStats -> GiveGCStats Source pred :: GiveGCStats -> GiveGCStats Source toEnum :: Int -> GiveGCStats Source fromEnum :: GiveGCStats -> Int Source enumFrom :: GiveGCStats -> [GiveGCStats] Source enumFromThen :: GiveGCStats -> GiveGCStats -> [GiveGCStats] Source enumFromTo :: GiveGCStats -> GiveGCStats -> [GiveGCStats] Source enumFromThenTo :: GiveGCStats -> GiveGCStats -> GiveGCStats -> [GiveGCStats] Source
Generic GiveGCStats Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep GiveGCStats :: Type -> Type Source Methods from :: GiveGCStats -> Rep GiveGCStats x Source to :: Rep GiveGCStats x -> GiveGCStats Source
Show GiveGCStats Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> GiveGCStats -> ShowS Source show :: GiveGCStats -> String Source showList :: [GiveGCStats] -> ShowS Source
type Rep GiveGCStats Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep GiveGCStats = D1 ('MetaData "GiveGCStats" "GHC.RTS.Flags" "base" 'False) ((C1 ('MetaCons "NoGCStats" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CollectGCStats" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "OneLineGCStats" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SummaryGCStats" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "VerboseGCStats" 'PrefixI 'False) (U1 :: Type -> Type))))

data GCFlags Source

Parameters of the garbage collector.

Since: base-4.8.0.0

Constructors

GCFlags

Fields

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

Instances

Instances details

Generic GCFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep GCFlags :: Type -> Type Source Methods from :: GCFlags -> Rep GCFlags x Source to :: Rep GCFlags x -> GCFlags Source
Show GCFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> GCFlags -> ShowS Source show :: GCFlags -> String Source showList :: [GCFlags] -> ShowS Source
type Rep GCFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep GCFlags = D1 ('MetaData "GCFlags" "GHC.RTS.Flags" "base" '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)))))))

data ConcFlags Source

Parameters concerning context switching

Since: base-4.8.0.0

Constructors

ConcFlags
Fields ctxtSwitchTime :: RtsTime ctxtSwitchTicks :: Int

Instances

Instances details

Generic ConcFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep ConcFlags :: Type -> Type Source Methods from :: ConcFlags -> Rep ConcFlags x Source to :: Rep ConcFlags x -> ConcFlags Source
Show ConcFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> ConcFlags -> ShowS Source show :: ConcFlags -> String Source showList :: [ConcFlags] -> ShowS Source
type Rep ConcFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep ConcFlags = D1 ('MetaData "ConcFlags" "GHC.RTS.Flags" "base" 'False) (C1 ('MetaCons "ConcFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "ctxtSwitchTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RtsTime) :*: S1 ('MetaSel ('Just "ctxtSwitchTicks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

data MiscFlags Source

Miscellaneous parameters

Since: base-4.8.0.0

Constructors

MiscFlags

Fields

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 :: IoSubSystem
numIoWorkerThreads :: Word32

Instances

Instances details

Generic MiscFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep MiscFlags :: Type -> Type Source Methods from :: MiscFlags -> Rep MiscFlags x Source to :: Rep MiscFlags x -> MiscFlags Source
Show MiscFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> MiscFlags -> ShowS Source show :: MiscFlags -> String Source showList :: [MiscFlags] -> ShowS Source
type Rep MiscFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep MiscFlags = D1 ('MetaData "MiscFlags" "GHC.RTS.Flags" "base" '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 IoSubSystem) :*: S1 ('MetaSel ('Just "numIoWorkerThreads") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32))))))

data DebugFlags Source

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

Since: base-4.8.0.0

Constructors

DebugFlags
Fields 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`

Instances

Instances details

Generic DebugFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep DebugFlags :: Type -> Type Source Methods from :: DebugFlags -> Rep DebugFlags x Source to :: Rep DebugFlags x -> DebugFlags Source
Show DebugFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> DebugFlags -> ShowS Source show :: DebugFlags -> String Source showList :: [DebugFlags] -> ShowS Source
type Rep DebugFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep DebugFlags = D1 ('MetaData "DebugFlags" "GHC.RTS.Flags" "base" '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))))))

data DoCostCentres Source

Should the RTS produce a cost-center summary?

Since: base-4.8.2.0

Constructors

CostCentresNone
CostCentresSummary
CostCentresVerbose
CostCentresAll
CostCentresJSON

Instances

Instances details

Enum DoCostCentres Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods succ :: DoCostCentres -> DoCostCentres Source pred :: DoCostCentres -> DoCostCentres Source toEnum :: Int -> DoCostCentres Source fromEnum :: DoCostCentres -> Int Source enumFrom :: DoCostCentres -> [DoCostCentres] Source enumFromThen :: DoCostCentres -> DoCostCentres -> [DoCostCentres] Source enumFromTo :: DoCostCentres -> DoCostCentres -> [DoCostCentres] Source enumFromThenTo :: DoCostCentres -> DoCostCentres -> DoCostCentres -> [DoCostCentres] Source
Generic DoCostCentres Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep DoCostCentres :: Type -> Type Source Methods from :: DoCostCentres -> Rep DoCostCentres x Source to :: Rep DoCostCentres x -> DoCostCentres Source
Show DoCostCentres Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> DoCostCentres -> ShowS Source show :: DoCostCentres -> String Source showList :: [DoCostCentres] -> ShowS Source
type Rep DoCostCentres Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep DoCostCentres = D1 ('MetaData "DoCostCentres" "GHC.RTS.Flags" "base" 'False) ((C1 ('MetaCons "CostCentresNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CostCentresSummary" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CostCentresVerbose" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CostCentresAll" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CostCentresJSON" 'PrefixI 'False) (U1 :: Type -> Type))))

data CCFlags Source

Parameters pertaining to the cost-center profiler.

Since: base-4.8.0.0

Constructors

CCFlags
Fields doCostCentres :: DoCostCentres profilerTicks :: Int msecsPerTick :: Int

Instances

Instances details

Generic CCFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep CCFlags :: Type -> Type Source Methods from :: CCFlags -> Rep CCFlags x Source to :: Rep CCFlags x -> CCFlags Source
Show CCFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> CCFlags -> ShowS Source show :: CCFlags -> String Source showList :: [CCFlags] -> ShowS Source
type Rep CCFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep CCFlags = D1 ('MetaData "CCFlags" "GHC.RTS.Flags" "base" '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))))

data DoHeapProfile Source

What sort of heap profile are we collecting?

Since: base-4.8.2.0

Constructors

NoHeapProfiling
HeapByCCS
HeapByMod
HeapByDescr
HeapByType
HeapByRetainer
HeapByLDV
HeapByClosureType
HeapByInfoTable

Instances

Instances details

Enum DoHeapProfile Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods succ :: DoHeapProfile -> DoHeapProfile Source pred :: DoHeapProfile -> DoHeapProfile Source toEnum :: Int -> DoHeapProfile Source fromEnum :: DoHeapProfile -> Int Source enumFrom :: DoHeapProfile -> [DoHeapProfile] Source enumFromThen :: DoHeapProfile -> DoHeapProfile -> [DoHeapProfile] Source enumFromTo :: DoHeapProfile -> DoHeapProfile -> [DoHeapProfile] Source enumFromThenTo :: DoHeapProfile -> DoHeapProfile -> DoHeapProfile -> [DoHeapProfile] Source
Generic DoHeapProfile Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep DoHeapProfile :: Type -> Type Source Methods from :: DoHeapProfile -> Rep DoHeapProfile x Source to :: Rep DoHeapProfile x -> DoHeapProfile Source
Show DoHeapProfile Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> DoHeapProfile -> ShowS Source show :: DoHeapProfile -> String Source showList :: [DoHeapProfile] -> ShowS Source
type Rep DoHeapProfile Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep DoHeapProfile = D1 ('MetaData "DoHeapProfile" "GHC.RTS.Flags" "base" 'False) (((C1 ('MetaCons "NoHeapProfiling" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HeapByCCS" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HeapByMod" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HeapByDescr" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "HeapByType" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HeapByRetainer" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HeapByLDV" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "HeapByClosureType" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HeapByInfoTable" 'PrefixI 'False) (U1 :: Type -> Type)))))

data ProfFlags Source

Parameters of the cost-center profiler

Since: base-4.8.0.0

Constructors

ProfFlags

Fields

doHeapProfile :: DoHeapProfile
heapProfileInterval :: RtsTime
time between samples
heapProfileIntervalTicks :: Word
ticks between samples (derived)
startHeapProfileAtStartup :: Bool
showCCSOnException :: 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

Instances

Instances details

Generic ProfFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep ProfFlags :: Type -> Type Source Methods from :: ProfFlags -> Rep ProfFlags x Source to :: Rep ProfFlags x -> ProfFlags Source
Show ProfFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> ProfFlags -> ShowS Source show :: ProfFlags -> String Source showList :: [ProfFlags] -> ShowS Source
type Rep ProfFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep ProfFlags = D1 ('MetaData "ProfFlags" "GHC.RTS.Flags" "base" '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 "showCCSOnException") '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)))))))

data DoTrace Source

Is event tracing enabled?

Since: base-4.8.2.0

Constructors

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

Instances

Instances details

Enum DoTrace Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods succ :: DoTrace -> DoTrace Source pred :: DoTrace -> DoTrace Source toEnum :: Int -> DoTrace Source fromEnum :: DoTrace -> Int Source enumFrom :: DoTrace -> [DoTrace] Source enumFromThen :: DoTrace -> DoTrace -> [DoTrace] Source enumFromTo :: DoTrace -> DoTrace -> [DoTrace] Source enumFromThenTo :: DoTrace -> DoTrace -> DoTrace -> [DoTrace] Source
Generic DoTrace Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep DoTrace :: Type -> Type Source Methods from :: DoTrace -> Rep DoTrace x Source to :: Rep DoTrace x -> DoTrace Source
Show DoTrace Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> DoTrace -> ShowS Source show :: DoTrace -> String Source showList :: [DoTrace] -> ShowS Source
type Rep DoTrace Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep DoTrace = D1 ('MetaData "DoTrace" "GHC.RTS.Flags" "base" 'False) (C1 ('MetaCons "TraceNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "TraceEventLog" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TraceStderr" 'PrefixI 'False) (U1 :: Type -> Type)))

data TraceFlags Source

Parameters pertaining to event tracing

Since: base-4.8.0.0

Constructors

TraceFlags
Fields 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)

Instances

Instances details

Generic TraceFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep TraceFlags :: Type -> Type Source Methods from :: TraceFlags -> Rep TraceFlags x Source to :: Rep TraceFlags x -> TraceFlags Source
Show TraceFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> TraceFlags -> ShowS Source show :: TraceFlags -> String Source showList :: [TraceFlags] -> ShowS Source
type Rep TraceFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep TraceFlags = D1 ('MetaData "TraceFlags" "GHC.RTS.Flags" "base" '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)))))

data TickyFlags Source

Parameters pertaining to ticky-ticky profiler

Since: base-4.8.0.0

Constructors

TickyFlags
Fields showTickyStats :: Bool tickyFile :: Maybe FilePath

Instances

Instances details

Generic TickyFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep TickyFlags :: Type -> Type Source Methods from :: TickyFlags -> Rep TickyFlags x Source to :: Rep TickyFlags x -> TickyFlags Source
Show TickyFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> TickyFlags -> ShowS Source show :: TickyFlags -> String Source showList :: [TickyFlags] -> ShowS Source
type Rep TickyFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep TickyFlags = D1 ('MetaData "TickyFlags" "GHC.RTS.Flags" "base" '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))))

data ParFlags Source

Parameters pertaining to parallelism

Since: base-4.8.0.0

Constructors

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

Instances

Instances details

Generic ParFlags Source
Instance details Defined in GHC.RTS.Flags Associated Types type Rep ParFlags :: Type -> Type Source Methods from :: ParFlags -> Rep ParFlags x Source to :: Rep ParFlags x -> ParFlags Source
Show ParFlags Source	Since: base-4.8.0.0
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> ParFlags -> ShowS Source show :: ParFlags -> String Source showList :: [ParFlags] -> ShowS Source
type Rep ParFlags Source	Since: base-4.15.0.0
Instance details Defined in GHC.RTS.Flags type Rep ParFlags = D1 ('MetaData "ParFlags" "GHC.RTS.Flags" "base" '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))))))

data IoSubSystem Source

The I/O SubSystem to use in the program.

Since: base-4.9.0.0

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.

Instances

Instances details

Storable IoSubSystem Source	Since: base-4.9.0.0
Instance details Defined in GHC.RTS.Flags Methods sizeOf :: IoSubSystem -> Int Source alignment :: IoSubSystem -> Int Source peekElemOff :: Ptr IoSubSystem -> Int -> IO IoSubSystem Source pokeElemOff :: Ptr IoSubSystem -> Int -> IoSubSystem -> IO () Source peekByteOff :: Ptr b -> Int -> IO IoSubSystem Source pokeByteOff :: Ptr b -> Int -> IoSubSystem -> IO () Source peek :: Ptr IoSubSystem -> IO IoSubSystem Source poke :: Ptr IoSubSystem -> IoSubSystem -> IO () Source
Enum IoSubSystem Source	Since: base-4.9.0.0
Instance details Defined in GHC.RTS.Flags Methods succ :: IoSubSystem -> IoSubSystem Source pred :: IoSubSystem -> IoSubSystem Source toEnum :: Int -> IoSubSystem Source fromEnum :: IoSubSystem -> Int Source enumFrom :: IoSubSystem -> [IoSubSystem] Source enumFromThen :: IoSubSystem -> IoSubSystem -> [IoSubSystem] Source enumFromTo :: IoSubSystem -> IoSubSystem -> [IoSubSystem] Source enumFromThenTo :: IoSubSystem -> IoSubSystem -> IoSubSystem -> [IoSubSystem] Source
Show IoSubSystem Source
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> IoSubSystem -> ShowS Source show :: IoSubSystem -> String Source showList :: [IoSubSystem] -> ShowS Source
Eq IoSubSystem Source
Instance details Defined in GHC.RTS.Flags Methods (==) :: IoSubSystem -> IoSubSystem -> Bool Source (/=) :: IoSubSystem -> IoSubSystem -> Bool Source

getRTSFlags :: IO RTSFlags Source

getGCFlags :: IO GCFlags Source

getConcFlags :: IO ConcFlags Source

getMiscFlags :: IO MiscFlags Source

getIoManagerFlag :: IO IoSubSystem Source

Needed to optimize support for different IO Managers on Windows. See Note [The need for getIoManagerFlag]

getDebugFlags :: IO DebugFlags Source

getCCFlags :: IO CCFlags Source

getProfFlags :: IO ProfFlags Source

getTraceFlags :: IO TraceFlags Source

getTickyFlags :: IO TickyFlags Source

getParFlags :: IO ParFlags Source

© The University of Glasgow and others
Licensed under a BSD-style license (see top of the page).
https://downloads.haskell.org/~ghc/9.4.2/docs/libraries/base-4.17.0.0/GHC-RTS-Flags.html

GHC.RTS.Flags

Description

Constructors

Fields

Instances

Associated Types

Methods

Methods

Constructors

Instances

Methods

Associated Types

Methods

Methods

Constructors

Fields

Instances

Associated Types

Methods

Methods

Constructors

Fields

Instances

Associated Types

Methods

Methods

Constructors

Fields

Instances

Associated Types

Methods

Methods

Constructors

Fields

Instances

Associated Types

Methods

Methods

Constructors

Instances

Methods

Associated Types

Methods

Methods

Constructors

Fields

Instances

Associated Types

Methods

Methods

Constructors

Instances

Methods

Associated Types

Methods

Methods

Constructors

Fields

Instances

Associated Types

Methods

Methods

Constructors

Instances

Methods

Associated Types

Methods

Methods

Constructors

Fields

Instances

Associated Types

Methods

Methods

Constructors

Fields

Instances

Associated Types

Methods

Methods