W3cubDocs

/Haskell 7

GHC.RTS.Flags

Safe Haskell None
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: 4.8.0.0

type RtsTime = Word64 Source

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

Since: 4.8.2.0

type RtsNat = Word32 Source

nat defined in rts/Types.h

Since: 4.8.2.0

data RTSFlags Source

Parameters of the runtime system

Since: 4.8.0.0

Constructors

RTSFlags

Fields

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

Instances

data GiveGCStats Source

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

Since: 4.8.2.0

Constructors

NoGCStats
CollectGCStats
OneLineGCStats
SummaryGCStats
VerboseGCStats

Instances

data GCFlags Source

Parameters of the garbage collector.

Since: 4.8.0.0

Constructors

GCFlags

Fields

statsFile :: Maybe FilePath
giveStats :: GiveGCStats
maxStkSize :: RtsNat
initialStkSize :: RtsNat
stkChunkSize :: RtsNat
stkChunkBufferSize :: RtsNat
maxHeapSize :: RtsNat
minAllocAreaSize :: RtsNat
minOldGenSize :: RtsNat
heapSizeSuggestion :: RtsNat
heapSizeSuggestionAuto :: Bool
oldGenFactor :: Double
pcFreeHeap :: Double
generations :: RtsNat
steps :: RtsNat
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
frontpanel :: Bool
idleGCDelayTime :: RtsTime
doIdleGC :: Bool
heapBase :: Word

address to ask the OS for memory

allocLimitGrace :: Word

Instances

data ConcFlags Source

Parameters concerning context switching

Since: 4.8.0.0

Constructors

ConcFlags

Fields

ctxtSwitchTime :: RtsTime
ctxtSwitchTicks :: Int

Instances

data MiscFlags Source

Miscellaneous parameters

Since: 4.8.0.0

Constructors

MiscFlags

Fields

tickInterval :: RtsTime
installSignalHandlers :: Bool
machineReadable :: Bool
linkerMemBase :: Word

address to ask the OS for memory for the linker, 0 ==> off

Instances

data DebugFlags Source

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

Since: 4.8.0.0

Constructors

DebugFlags

Fields

scheduler :: Bool

s

interpreter :: Bool

i

weak :: Bool

w

gccafs :: Bool

G

gc :: Bool

g

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

data DoCostCentres Source

Should the RTS produce a cost-center summary?

Since: 4.8.2.0

Constructors

CostCentresNone
CostCentresSummary
CostCentresVerbose
CostCentresAll
CostCentresXML

Instances

data CCFlags Source

Parameters pertaining to the cost-center profiler.

Since: 4.8.0.0

Constructors

CCFlags

Fields

doCostCentres :: DoCostCentres
profilerTicks :: Int
msecsPerTick :: Int

Instances

data DoHeapProfile Source

What sort of heap profile are we collecting?

Since: 4.8.2.0

Constructors

NoHeapProfiling
HeapByCCS
HeapByMod
HeapByDescr
HeapByType
HeapByRetainer
HeapByLDV
HeapByClosureType

Instances

data ProfFlags Source

Parameters of the cost-center profiler

Since: 4.8.0.0

Constructors

ProfFlags

Fields

doHeapProfile :: DoHeapProfile
heapProfileInterval :: RtsTime

time between samples

heapProfileIntervalTicks :: Word

ticks between samples (derived)

includeTSOs :: 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

data DoTrace Source

Is event tracing enabled?

Since: 4.8.2.0

Constructors

TraceNone

no tracing
TraceEventLog

send tracing events to the event log
TraceStderr

send tracing events to stderr

Instances

data TraceFlags Source

Parameters pertaining to event tracing

Since: 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

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

data TickyFlags Source

Parameters pertaining to ticky-ticky profiler

Since: 4.8.0.0

Constructors

TickyFlags

Fields

showTickyStats :: Bool
tickyFile :: Maybe FilePath

Instances

getRTSFlags :: IO RTSFlags Source

getGCFlags :: IO GCFlags Source

getConcFlags :: IO ConcFlags Source

getMiscFlags :: IO MiscFlags Source

getDebugFlags :: IO DebugFlags Source

getCCFlags :: IO CCFlags Source

getProfFlags :: IO ProfFlags Source

getTraceFlags :: IO TraceFlags Source

getTickyFlags :: IO TickyFlags Source

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