Copyright	(c) The University of Glasgow 1994-2000
License	see libraries/base/LICENSE
Maintainer	ghc-devs@haskell.org
Stability	internal
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

GHC.RTS.Flags

Description

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.

Since: base-4.8.0.0

Synopsis

type RtsTime = Word64
data RTSFlags = RTSFlags {
- gcFlags :: GCFlags
- concurrentFlags :: ConcFlags
- miscFlags :: MiscFlags
- debugFlags :: DebugFlags
- costCentreFlags :: CCFlags
- profilingFlags :: ProfFlags
- traceFlags :: TraceFlags
- tickyFlags :: TickyFlags
- parFlags :: ParFlags
- hpcFlags :: HpcFlags
}
data GiveGCStats
- = NoGCStats
- | CollectGCStats
- | OneLineGCStats
- | SummaryGCStats
- | VerboseGCStats
data GCFlags = 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
- compactThreshold :: Double
- sweep :: Bool
- ringBell :: Bool
- idleGCDelayTime :: RtsTime
- doIdleGC :: Bool
- heapBase :: Word
- allocLimitGrace :: Word
- numa :: Bool
- numaMask :: Word
}
data ConcFlags = ConcFlags {
- ctxtSwitchTime :: RtsTime
- ctxtSwitchTicks :: Int
}
data MiscFlags = MiscFlags {
- tickInterval :: RtsTime
- installSignalHandlers :: Bool
- installSEHHandlers :: Bool
- generateCrashDumpFile :: Bool
- generateStackTrace :: Bool
- machineReadable :: Bool
- disableDelayedOsMemoryReturn :: Bool
- internalCounters :: Bool
- linkerAlwaysPic :: Bool
- linkerMemBase :: Word
- ioManager :: IoManagerFlag
- numIoWorkerThreads :: Word32
}
data IoManagerFlag
- = IoManagerFlagAuto
- | IoManagerFlagSelect
- | IoManagerFlagMIO
- | IoManagerFlagWinIO
- | IoManagerFlagWin32Legacy
data DebugFlags = DebugFlags {
- scheduler :: Bool
- interpreter :: Bool
- weak :: Bool
- gccafs :: Bool
- gc :: Bool
- nonmoving_gc :: Bool
- block_alloc :: Bool
- sanity :: Bool
- stable :: Bool
- prof :: Bool
- linker :: Bool
- apply :: Bool
- stm :: Bool
- squeeze :: Bool
- hpc :: Bool
- sparks :: Bool
}
data DoCostCentres
- = CostCentresNone
- | CostCentresSummary
- | CostCentresVerbose
- | CostCentresAll
- | CostCentresJSON
data CCFlags = CCFlags {
- doCostCentres :: DoCostCentres
- profilerTicks :: Int
- msecsPerTick :: Int
}
data DoHeapProfile
- = NoHeapProfiling
- | HeapByCCS
- | HeapByMod
- | HeapByDescr
- | HeapByType
- | HeapByRetainer
- | HeapByLDV
- | HeapByClosureType
- | HeapByInfoTable
- | HeapByEra
data ProfFlags = ProfFlags {
- doHeapProfile :: DoHeapProfile
- heapProfileInterval :: RtsTime
- heapProfileIntervalTicks :: Word
- 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
}
data DoTrace
- = TraceNone
- | TraceEventLog
- | TraceStderr
data TraceFlags = TraceFlags {
- tracing :: DoTrace
- timestamp :: Bool
- traceScheduler :: Bool
- traceGc :: Bool
- traceNonmovingGc :: Bool
- sparksSampled :: Bool
- sparksFull :: Bool
- user :: Bool
}
data TickyFlags = TickyFlags {
- showTickyStats :: Bool
- tickyFile :: Maybe FilePath
}
data ParFlags = ParFlags {
- nCapabilities :: Word32
- migrate :: Bool
- maxLocalSparks :: Word32
- parGcEnabled :: Bool
- parGcGen :: Word32
- parGcLoadBalancingEnabled :: Bool
- parGcLoadBalancingGen :: Word32
- parGcNoSyncWithIdle :: Word32
- parGcThreads :: Word32
- setAffinity :: Bool
}
data HpcFlags = HpcFlags {
- readTixFile :: Bool
- writeTixFile :: Bool
}
data IoSubSystem
- = IoPOSIX
- | IoNative
getRTSFlags :: IO RTSFlags
getGCFlags :: IO GCFlags
getConcFlags :: IO ConcFlags
getMiscFlags :: IO MiscFlags
getDebugFlags :: IO DebugFlags
getCCFlags :: IO CCFlags
getProfFlags :: IO ProfFlags
getTraceFlags :: IO TraceFlags
getTickyFlags :: IO TickyFlags
getParFlags :: IO ParFlags
getHpcFlags :: IO HpcFlags

Documentation

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 hpcFlags :: HpcFlags

Instances

Instances details

Generic RTSFlags Source #

Instance details

NoGCStats
CollectGCStats
OneLineGCStats
SummaryGCStats
VerboseGCStats

ConcFlags
Fields ctxtSwitchTime :: RtsTime ctxtSwitchTicks :: Int

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

Eq IoManagerFlag Source #
Instance details Defined in GHC.RTS.Flags Methods (==) :: IoManagerFlag -> IoManagerFlag -> Bool Source # (/=) :: IoManagerFlag -> IoManagerFlag -> Bool Source #
Enum IoManagerFlag Source #
Instance details Defined in GHC.RTS.Flags Methods succ :: IoManagerFlag -> IoManagerFlag Source # pred :: IoManagerFlag -> IoManagerFlag Source # toEnum :: Int -> IoManagerFlag Source # fromEnum :: IoManagerFlag -> Int Source # enumFrom :: IoManagerFlag -> [IoManagerFlag] Source # enumFromThen :: IoManagerFlag -> IoManagerFlag -> [IoManagerFlag] Source # enumFromTo :: IoManagerFlag -> IoManagerFlag -> [IoManagerFlag] Source # enumFromThenTo :: IoManagerFlag -> IoManagerFlag -> IoManagerFlag -> [IoManagerFlag] Source #
Show IoManagerFlag Source #
Instance details Defined in GHC.RTS.Flags Methods showsPrec :: Int -> IoManagerFlag -> ShowS Source # show :: IoManagerFlag -> String Source # showList :: [IoManagerFlag] -> ShowS Source #

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

CostCentresNone
CostCentresSummary
CostCentresVerbose
CostCentresAll
CostCentresJSON

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

NoHeapProfiling
HeapByCCS
HeapByMod
HeapByDescr
HeapByType
HeapByRetainer
HeapByLDV
HeapByClosureType
HeapByInfoTable
HeapByEra	Since: base-4.20.0.0

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

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)

TickyFlags
Fields showTickyStats :: Bool tickyFile :: Maybe FilePath

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

HpcFlags
Fields 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.

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.

Eq IoSubSystem Source #
Instance details Defined in GHC.Internal.IO.SubSystem Methods (==) :: IoSubSystem -> IoSubSystem -> Bool Source # (/=) :: IoSubSystem -> IoSubSystem -> Bool Source #
Enum IoSubSystem Source #
Instance details Defined in GHC.Internal.IO.SubSystem 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.Internal.IO.SubSystem Methods showsPrec :: Int -> IoSubSystem -> ShowS Source # show :: IoSubSystem -> String Source # showList :: [IoSubSystem] -> ShowS Source #