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.

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

Defined in GHC.Internal.RTS.Flags

Associated Types

type Rep RTSFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

Associated Types

type Rep GiveGCStats

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

type Rep GiveGCStats = D1 ('MetaData "GiveGCStats" "GHC.Internal.RTS.Flags" "ghc-internal" '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))))

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.Internal.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.Internal.RTS.Flags

type Rep GiveGCStats = D1 ('MetaData "GiveGCStats" "GHC.Internal.RTS.Flags" "ghc-internal" '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.Internal.RTS.Flags

Associated Types

type Rep GCFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

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.Internal.RTS.Flags

Associated Types

type Rep ConcFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

type Rep ConcFlags = D1 ('MetaData "ConcFlags" "GHC.Internal.RTS.Flags" "ghc-internal" 'False) (C1 ('MetaCons "ConcFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "ctxtSwitchTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RtsTime) :*: S1 ('MetaSel ('Just "ctxtSwitchTicks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

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.Internal.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.Internal.RTS.Flags

type Rep ConcFlags = D1 ('MetaData "ConcFlags" "GHC.Internal.RTS.Flags" "ghc-internal" '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 :: IoManagerFlag
numIoWorkerThreads :: Word32

Instances

Instances details

Generic MiscFlags Source #

Instance details

Defined in GHC.Internal.RTS.Flags

Associated Types

type Rep MiscFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

data IoManagerFlag Source #

Since: base-4.21.0.0

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

Instances

Instances details

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

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.Internal.RTS.Flags

Associated Types

type Rep DebugFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

Associated Types

type Rep DoCostCentres

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

type Rep DoCostCentres = D1 ('MetaData "DoCostCentres" "GHC.Internal.RTS.Flags" "ghc-internal" '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))))

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.Internal.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.Internal.RTS.Flags

type Rep DoCostCentres = D1 ('MetaData "DoCostCentres" "GHC.Internal.RTS.Flags" "ghc-internal" '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.Internal.RTS.Flags

Associated Types

type Rep CCFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

type Rep CCFlags = D1 ('MetaData "CCFlags" "GHC.Internal.RTS.Flags" "ghc-internal" '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))))

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.Internal.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.Internal.RTS.Flags

type Rep CCFlags = D1 ('MetaData "CCFlags" "GHC.Internal.RTS.Flags" "ghc-internal" '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
HeapByEra	Since: base-4.20.0.0

Instances

Instances details

Enum DoHeapProfile Source #

Since: base-4.8.0.0

Instance details

Defined in GHC.Internal.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.Internal.RTS.Flags

Associated Types

type Rep DoHeapProfile

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

type Rep DoHeapProfile = D1 ('MetaData "DoHeapProfile" "GHC.Internal.RTS.Flags" "ghc-internal" '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) :+: C1 ('MetaCons "HeapByEra" 'PrefixI 'False) (U1 :: Type -> Type)))))

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.Internal.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.Internal.RTS.Flags

type Rep DoHeapProfile = D1 ('MetaData "DoHeapProfile" "GHC.Internal.RTS.Flags" "ghc-internal" '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) :+: C1 ('MetaCons "HeapByEra" '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
startTimeProfileAtStartup :: Bool
Since: base-4.20.0.0
showCCSOnException :: Bool
automaticEraIncrement :: Bool
Since: ghc-internal-4.20.0.0
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
Since: base-4.20.0.0

Instances

Instances details

Generic ProfFlags Source #

Instance details

Defined in GHC.Internal.RTS.Flags

Associated Types

type Rep ProfFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

Associated Types

type Rep DoTrace	Since: base-4.15.0.0
Instance details Defined in GHC.Internal.RTS.Flags type Rep DoTrace = D1 ('MetaData "DoTrace" "GHC.Internal.RTS.Flags" "ghc-internal" '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)))

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.Internal.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.Internal.RTS.Flags

type Rep DoTrace = D1 ('MetaData "DoTrace" "GHC.Internal.RTS.Flags" "ghc-internal" '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.Internal.RTS.Flags

Associated Types

type Rep TraceFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

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.Internal.RTS.Flags

Associated Types

type Rep TickyFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

type Rep TickyFlags = D1 ('MetaData "TickyFlags" "GHC.Internal.RTS.Flags" "ghc-internal" '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))))

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.Internal.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.Internal.RTS.Flags

type Rep TickyFlags = D1 ('MetaData "TickyFlags" "GHC.Internal.RTS.Flags" "ghc-internal" '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.Internal.RTS.Flags

Associated Types

type Rep ParFlags

Since: base-4.15.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

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.Internal.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.Internal.RTS.Flags

data HpcFlags Source #

Parameters pertaining to Haskell program coverage (HPC)

Since: base-4.20.0.0

Constructors

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.

Instances

Instances details

Generic HpcFlags Source #

Instance details

Defined in GHC.Internal.RTS.Flags

Associated Types

type Rep HpcFlags

Since: base-4.20.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

type Rep HpcFlags = D1 ('MetaData "HpcFlags" "GHC.Internal.RTS.Flags" "ghc-internal" 'False) (C1 ('MetaCons "HpcFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "readTixFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "writeTixFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

Methods

from :: HpcFlags -> Rep HpcFlags x Source #

to :: Rep HpcFlags x -> HpcFlags Source #

Show HpcFlags Source #

Since: base-4.20.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

Methods

showsPrec :: Int -> HpcFlags -> ShowS Source #

show :: HpcFlags -> String Source #

showList :: [HpcFlags] -> ShowS Source #

type Rep HpcFlags Source #

Since: base-4.20.0.0

Instance details

Defined in GHC.Internal.RTS.Flags

type Rep HpcFlags = D1 ('MetaData "HpcFlags" "GHC.Internal.RTS.Flags" "ghc-internal" 'False) (C1 ('MetaCons "HpcFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "readTixFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "writeTixFile") '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

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 #
Eq IoSubSystem Source #
Instance details Defined in GHC.Internal.IO.SubSystem 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 #

getDebugFlags :: IO DebugFlags Source #

getCCFlags :: IO CCFlags Source #

getProfFlags :: IO ProfFlags Source #

getTraceFlags :: IO TraceFlags Source #

getTickyFlags :: IO TickyFlags Source #

getParFlags :: IO ParFlags Source #

getHpcFlags :: IO HpcFlags Source #