GHC.RTS.Flags (original) (raw)

Description

Accessors to GHC RTS flags. Descriptions of flags can be seen inGHC 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
    }
• 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 :: IoSubSystem
  • numIoWorkerThreads :: Word32
    }
• 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
• data ProfFlags = ProfFlags {
  • doHeapProfile :: DoHeapProfile
  • heapProfileInterval :: RtsTime
  • heapProfileIntervalTicks :: Word
  • 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
    }
• 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 IoSubSystem
  • = IoPOSIX
  • | IoNative
• getRTSFlags :: IO RTSFlags
• getGCFlags :: IO GCFlags
• getConcFlags :: IO ConcFlags
• getMiscFlags :: IO MiscFlags
• getIoManagerFlag :: IO IoSubSystem
• getDebugFlags :: IO DebugFlags
• getCCFlags :: IO CCFlags
• getProfFlags :: IO ProfFlags
• getTraceFlags :: IO TraceFlags
• getTickyFlags :: IO TickyFlags
• getParFlags :: IO ParFlags

Documentation

data RTSFlags Source #

Parameters of the runtime system

Since: base-4.8.0.0

data GiveGCStats Source #

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

Since: base-4.8.2.0

data ConcFlags Source #

Parameters concerning context switching

Since: base-4.8.0.0

data CCFlags Source #

Parameters pertaining to the cost-center profiler.

Since: base-4.8.0.0

data TickyFlags Source #

Parameters pertaining to ticky-ticky profiler

Since: base-4.8.0.0

data ParFlags Source #

Parameters pertaining to parallelism

Since: base-4.8.0.0

data IoSubSystem Source #

The I/O SubSystem to use in the program.

Since: base-4.9.0.0

Constructors