Moduleghc-10.0.0.20260917GHC2024

GHC.StgToCmm.Monad

10 types
63 values

Packageghc-10.0.0.20260917
Exports73
LanguageGHC2024
LicenceBSD-3-Clause
SourceMonad.hs

newtypenewtype FCode a

Instances5Monad, Functor, Applicative, MonadGetUnique, MonadUnique

Monad FCodeDefined in ghc-10.0.0.20260917 · GHC.StgToCmm.Monad
Functor FCodeDefined in ghc-10.0.0.20260917 · GHC.StgToCmm.Monad
Applicative FCodeDefined in ghc-10.0.0.20260917 · GHC.StgToCmm.Monad
MonadGetUnique FCodeDefined in ghc-10.0.0.20260917 · GHC.StgToCmm.Monad
MonadUnique FCodeDefined in ghc-10.0.0.20260917 · GHC.StgToCmm.Monad

valueinitC :: IO CgState

valueinitFCodeState :: Platform -> FCodeState

valuerunC :: StgToCmmConfig -> FCodeState -> CgState -> FCode a -> (a, CgState)

valuefixC :: (a -> FCode a) -> FCode a

valuenewUnique :: FCode Unique

valueemitLabel :: BlockId -> FCode ()

valueemit :: CmmAGraph -> FCode ()

valueemitDecl :: DCmmDecl -> FCode ()

valueemitProcWithConvention

valueemitProcWithStackFrame

:: Convention
-> Maybe CmmInfoTable
-> CLabel
-> [CmmFormal]
-> [CmmFormal]
-> CmmAGraphScoped
-> Bool
-> FCode ()

valueemitOutOfLine :: BlockId -> CmmAGraphScoped -> FCode ()

valueemitAssign :: CmmReg -> CmmExpr -> FCode ()

valueemitStore :: CmmExpr -> CmmExpr -> FCode ()

Assumes natural alignment.

valueemitStore' :: AlignmentSpec -> CmmExpr -> CmmExpr -> FCode ()

valueemitComment :: FastString -> FCode ()

valueemitTick :: CmmTickish -> FCode ()

valueemitUnwind :: [(GlobalReg, Maybe CmmExpr)] -> FCode ()

valuenewTemp :: MonadGetUnique m => CmmType -> m LocalReg

valuegetCmm :: FCode a -> FCode (a, DCmmGroup)

valueaGraphToGraph :: CmmAGraphScoped -> FCode DCmmGraph

valuegetPlatform :: FCode Platform

valuegetProfile :: FCode Profile

valuegetCodeR :: FCode a -> FCode (a, CmmAGraph)

valuegetCode :: FCode a -> FCode CmmAGraph

valuegetCodeScoped :: FCode a -> FCode (a, CmmAGraphScoped)

Generate code into a fresh tick (sub-)scope and gather generated code

valuegetHeapUsage :: (VirtualHpOffset -> FCode a) -> FCode a

valuegetContext :: FCode SDocContext

valuemkCmmIfThenElse :: CmmExpr -> CmmAGraph -> CmmAGraph -> FCode CmmAGraph

valuemkCmmIfThen :: CmmExpr -> CmmAGraph -> FCode CmmAGraph

valuemkCmmIfGoto :: CmmExpr -> BlockId -> FCode CmmAGraph

valuemkCmmIfThenElse'

valuemkCmmIfThen' :: CmmExpr -> CmmAGraph -> Maybe Bool -> FCode CmmAGraph

valuemkCmmIfGoto' :: CmmExpr -> BlockId -> Maybe Bool -> FCode CmmAGraph

valuemkCall

:: CmmExpr
-> (Convention, Convention)
-> [CmmFormal]
-> [CmmExpr]
-> UpdFrameOffset
-> [CmmExpr]
-> FCode CmmAGraph

valuemkCmmCall

:: CmmExpr
-> [CmmFormal]
-> [CmmExpr]
-> UpdFrameOffset
-> FCode CmmAGraph

valueforkClosureBody :: FCode () -> FCode ()

valueforkLneBody :: FCode a -> FCode a

valueforkAlts :: [FCode a] -> FCode [a]

valueforkAltPair :: FCode a -> FCode a -> FCode (a, a)

valuecodeOnly :: FCode () -> FCode ()

typetype ConTagZ = Int

A *zero-indexed* constructor tag

datadata Sequel

A Sequel tells what to do with the result of this expression

Constructors

Return
Return result(s) to continuation found on the stack.
AssignTo [LocalReg] Bool

Instances1Outputable

Outputable SequelDefined in ghc-10.0.0.20260917 · GHC.StgToCmm.Sequel

datadata ReturnKind

Constructors

AssignedDirectly
ReturnedTo BlockId ByteOff

valuewithSequel :: Sequel -> FCode a -> FCode a

valuegetSequel :: FCode Sequel

datadata SelfLoopInfo

Constructors

MkSelfLoopInfo
- sli_id :: !Id
- sli_arity :: !RepArity
  always equal to idFunRepArity of sli_id, i.e. unarised arity, including void arguments
- sli_registers :: ![LocalReg]
  Excludes void arguments (LocalReg is never void)
- sli_header_block :: !BlockId

valuesetTickyCtrLabel :: CLabel -> FCode a -> FCode a

valuegetTickyCtrLabel :: FCode CLabel

valuetickScope :: FCode a -> FCode a

Places blocks generated by the given code into a fresh (sub-)scope. This will make sure that Cmm annotations in our scope will apply to the Cmm blocks generated therein - but not the other way around.

valuegetTickScope :: FCode CmmTickScope

The current tick scope. We will assign this to generated blocks.

valuewithUpdFrameOff :: UpdFrameOffset -> FCode a -> FCode a

valuegetUpdFrameOff :: FCode UpdFrameOffset

datadata HeapUsage

Constructors

HeapUsage
- virtHp :: VirtualHpOffset
- realHp :: VirtualHpOffset

typetype VirtualHpOffset = WordOff

valueinitHpUsage :: HeapUsage

valuegetHpUsage :: FCode HeapUsage

valuesetHpUsage :: HeapUsage -> FCode ()

valueheapHWM :: HeapUsage -> VirtualHpOffset

valuesetVirtHp :: VirtualHpOffset -> FCode ()

valuegetVirtHp :: FCode VirtualHpOffset

valuesetRealHp :: VirtualHpOffset -> FCode ()

valuegetModuleName :: FCode Module

valuegetState :: FCode CgState

valuesetState :: CgState -> FCode ()

valuegetSelfLoop :: FCode (Maybe SelfLoopInfo)

valuewithSelfLoop :: SelfLoopInfo -> FCode a -> FCode a

valuegetStgToCmmConfig :: FCode StgToCmmConfig

datadata CgIdInfo

Constructors

CgIdInfo
- cg_id :: Id
  Id that this is the info for
- cg_lf :: LambdaFormInfo
- cg_loc :: CgLoc
  CmmExpr for the *tagged* value

Instances1OutputableP

OutputableP Platform CgIdInfoDefined in ghc-10.0.0.20260917 · GHC.StgToCmm.Monad

valuegetBinds :: FCode CgBindings

valuesetBinds :: CgBindings -> FCode ()

datadata StgToCmmConfig

Constructors

StgToCmmConfig
- stgToCmmProfile :: !Profile
  Current profile
- stgToCmmThisModule :: Module
  The module being compiled. This field kept lazy for Cmm/Parser.y which preloads it with a panic
- stgToCmmTmpDir :: !TempDir
  Temp Dir for files used in compilation
- stgToCmmContext :: !SDocContext
  Context for StgToCmm phase
- stgToCmmEmitDebugInfo :: !Bool
  Whether we wish to output debug information
- stgToCmmBinBlobThresh :: !Maybe Word
  Threshold at which Binary literals (e.g. strings) are either dumped to a file and a CmmFileEmbed literal is emitted (over threshold), or become a CmmString Literal (under or at threshold). CmmFileEmbed is only supported with the NCG, thus a Just means two things: We have a threshold, and will be using the NCG. Conversely, a Nothing implies we are not using NCG and disables CmmFileEmbed. See Note [Embedding large binary blobs] in GHC.CmmToAsm.Ppr, and cgTopBinding in GHC.StgToCmm.
- stgToCmmMaxInlAllocSize :: !Int
  Max size, in bytes, of inline array allocations.
- stgToCmmDoTicky :: !Bool
  Ticky profiling enabled (cf -ticky)
- stgToCmmTickyAllocd :: !Bool
  True indicates ticky prof traces allocs of each named thing in addition to allocs _by_ that thing
- stgToCmmTickyLNE :: !Bool
  True indicates ticky uses name-specific counters for join-points (let-no-escape)
- stgToCmmTickyDynThunk :: !Bool
  True indicates ticky uses name-specific counters for dynamic thunks
- stgToCmmTickyTag :: !Bool
  True indicates ticky will count number of avoided tag checks by tag inference.
- stgToCmmLoopification :: !Bool
  Loopification enabled (cf -floopification)
- stgToCmmAlignCheck :: !Bool
  Insert alignment check (cf -falignment-sanitisation)
- stgToCmmFastPAPCalls :: !Bool
- stgToCmmSCCProfiling :: !Bool
  Check if cost-centre profiling is enabled
- stgToCmmEagerBlackHole :: !Bool
- stgToCmmOrigThunkInfo :: !Bool
  Push stg_orig_thunk_info frames during thunk update.
- stgToCmmInfoTableMap :: !Bool
  true means generate C Stub for IPE map, See Note [Mapping Info Tables to Source Positions]
- stgToCmmInfoTableMapWithFallback :: !Bool
  Include info tables with fallback source locations in the info table map
- stgToCmmInfoTableMapWithStack :: !Bool
  Include info tables for STACK closures in the info table map
- stgToCmmOmitYields :: !Bool
  true means omit heap checks when no allocation is performed
- stgToCmmOmitIfPragmas :: !Bool
  true means don't generate interface programs (implied by -O0)
- stgToCmmPIC :: !Bool
  true if -fPIC
- stgToCmmPIE :: !Bool
  true if -fPIE
- stgToCmmExtDynRefs :: !Bool
  true if -fexternal-dynamic-refs, meaning generate code for linking against dynamic libraries
- stgToCmmDoBoundsCheck :: !Bool
  decides whether to check array bounds in StgToCmm.Prim or not
- stgToCmmDoTagCheck :: !Bool
  Verify tag inference predictions.
- stgToCmmObjectDeterminism :: !Bool
  Enable deterministic code generation (more precisely, the deterministic unique-renaming pass in StgToCmm)
- stgToCmmAllowArith64 :: !Bool
  Allowed to emit 64-bit arithmetic operations
- stgToCmmAllowQuot64 :: !Bool
  Allowed to emit 64-bit division operations
- stgToCmmAllowQuotRemInstr :: !Bool
  Allowed to generate QuotRem instructions
- stgToCmmAllowQuotRem2 :: !Bool
  Allowed to generate QuotRem
- stgToCmmAllowExtendedAddSubInstrs :: !Bool
  Allowed to generate AddWordC, SubWordC, Add2, etc.
- stgToCmmAllowIntMul2Instr :: !Bool
  Allowed to generate IntMul2 instruction
- stgToCmmAllowWordMul2Instr :: !Bool
  Allowed to generate WordMul2 instruction
- stgToCmmAllowFMAInstr :: FMASign -> Bool
  Allowed to generate FMA instruction
- stgToCmmAllowIntWord64X2MinMax :: !Bool
  Allowed to generate minmax instructions for Int64X2Word64X2
- stgToCmmUseStdApThunk :: !Bool
  Use precomputed standard AP thunks in the RTS.
- stgToCmmSaveFCallTargetToLocal :: !Bool
  Save a foreign call target to a Cmm local, see Note [Saving foreign call target to local] for details
- stgToCmmVecInstrsErr :: Maybe String
  Error (if any) to raise when vector instructions are used, see StgToCmm.Prim.checkVecCompatibility
- stgToCmmAvx :: !Bool
  check for Advanced Vector Extensions
- stgToCmmAvx2 :: !Bool
  check for Advanced Vector Extensions 2
- stgToCmmAvx512f :: !Bool
  check for Advanced Vector 512-bit Extensions

datadata CgState

Constructors

MkCgState
- cgs_stmts :: CmmAGraph
- cgs_tops :: OrdList DCmmDecl
- cgs_binds :: CgBindings
- cgs_hp_usg :: HeapUsage
- cgs_uniqs :: UniqSupply