Safe Haskell	None
Language	GHC2021

GHC.ByteCode.Types

Description

Bytecode assembler types

Synopsis

data CompiledByteCode = CompiledByteCode {
- bc_bcos :: [UnlinkedBCO]
- bc_itbls :: ItblEnv
- bc_ffis :: [FFIInfo]
- bc_strs :: AddrEnv
- bc_breaks :: Maybe ModBreaks
}
seqCompiledByteCode :: CompiledByteCode -> ()
newtype FFIInfo = FFIInfo (RemotePtr C_ffi_cif)
newtype RegBitmap = RegBitmap {
- unRegBitmap :: Word32
}
data NativeCallType
- = NativePrimCall
- | NativeTupleReturn
data NativeCallInfo = NativeCallInfo {
- nativeCallType :: !NativeCallType
- nativeCallSize :: !WordOff
- nativeCallRegs :: !GlobalRegSet
- nativeCallStackSpillSize :: !WordOff
}
voidTupleReturnInfo :: NativeCallInfo
voidPrimCallInfo :: NativeCallInfo
newtype ByteOff = ByteOff Int
newtype WordOff = WordOff Int
newtype HalfWord = HalfWord Word
data UnlinkedBCO = UnlinkedBCO {
- unlinkedBCOName :: !Name
- unlinkedBCOArity :: !Int
- unlinkedBCOInstrs :: !(UArray Int Word16)
- unlinkedBCOBitmap :: !(UArray Int Word64)
- unlinkedBCOLits :: !(SizedSeq BCONPtr)
- unlinkedBCOPtrs :: !(SizedSeq BCOPtr)
}
data BCOPtr
- = BCOPtrName !Name
- | BCOPtrPrimOp !PrimOp
- | BCOPtrBCO !UnlinkedBCO
- | BCOPtrBreakArray (ForeignRef BreakArray)
data BCONPtr
- = BCONPtrWord !Word
- | BCONPtrLbl !FastString
- | BCONPtrItbl !Name
- | BCONPtrAddr !Name
- | BCONPtrStr !ByteString
type ItblEnv = NameEnv (Name, ItblPtr)
newtype ItblPtr = ItblPtr (RemotePtr StgInfoTable)
type AddrEnv = NameEnv (Name, AddrPtr)
newtype AddrPtr = AddrPtr (RemotePtr ())
data CgBreakInfo = CgBreakInfo {
- cgb_tyvars :: ![IfaceTvBndr]
- cgb_vars :: ![Maybe (IfaceIdBndr, Word)]
- cgb_resty :: !IfaceType
}
data ModBreaks = ModBreaks {
- modBreaks_flags :: ForeignRef BreakArray
- modBreaks_locs :: !(Array BreakIndex SrcSpan)
- modBreaks_vars :: !(Array BreakIndex [OccName])
- modBreaks_decls :: !(Array BreakIndex [String])
- modBreaks_ccs :: !(Array BreakIndex (RemotePtr CostCentre))
- modBreaks_breakInfo :: IntMap CgBreakInfo
- modBreaks_module :: RemotePtr ModuleName
}
type BreakIndex = Int
emptyModBreaks :: ModBreaks
data CCostCentre

Documentation

data CompiledByteCode Source #

Constructors

CompiledByteCode
Fields bc_bcos :: [UnlinkedBCO] bc_itbls :: ItblEnv bc_ffis :: [FFIInfo] bc_strs :: AddrEnv bc_breaks :: Maybe ModBreaks

Instances

Instances details

Outputable CompiledByteCode Source #
Instance details Defined in GHC.ByteCode.Types Methods ppr :: CompiledByteCode -> SDoc Source #

seqCompiledByteCode :: CompiledByteCode -> () Source #

newtype FFIInfo Source #

Constructors

FFIInfo (RemotePtr C_ffi_cif)

Instances

Instances details

NFData FFIInfo Source #
Instance details Defined in GHC.ByteCode.Types Methods rnf :: FFIInfo -> () Source #
Show FFIInfo Source #
Instance details Defined in GHC.ByteCode.Types Methods showsPrec :: Int -> FFIInfo -> ShowS # show :: FFIInfo -> String # showList :: [FFIInfo] -> ShowS #

newtype RegBitmap Source #

Constructors

RegBitmap
Fields unRegBitmap :: Word32

Instances

Instances details

Outputable RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods ppr :: RegBitmap -> SDoc Source #
Bits RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods (.&.) :: RegBitmap -> RegBitmap -> RegBitmap # (.\|.) :: RegBitmap -> RegBitmap -> RegBitmap # xor :: RegBitmap -> RegBitmap -> RegBitmap # complement :: RegBitmap -> RegBitmap # shift :: RegBitmap -> Int -> RegBitmap # rotate :: RegBitmap -> Int -> RegBitmap # zeroBits :: RegBitmap # bit :: Int -> RegBitmap # setBit :: RegBitmap -> Int -> RegBitmap # clearBit :: RegBitmap -> Int -> RegBitmap # complementBit :: RegBitmap -> Int -> RegBitmap # testBit :: RegBitmap -> Int -> Bool # bitSizeMaybe :: RegBitmap -> Maybe Int # bitSize :: RegBitmap -> Int # isSigned :: RegBitmap -> Bool # shiftL :: RegBitmap -> Int -> RegBitmap # unsafeShiftL :: RegBitmap -> Int -> RegBitmap # shiftR :: RegBitmap -> Int -> RegBitmap # unsafeShiftR :: RegBitmap -> Int -> RegBitmap # rotateL :: RegBitmap -> Int -> RegBitmap # rotateR :: RegBitmap -> Int -> RegBitmap # popCount :: RegBitmap -> Int #
FiniteBits RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods finiteBitSize :: RegBitmap -> Int # countLeadingZeros :: RegBitmap -> Int # countTrailingZeros :: RegBitmap -> Int #
Enum RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods succ :: RegBitmap -> RegBitmap # pred :: RegBitmap -> RegBitmap # toEnum :: Int -> RegBitmap # fromEnum :: RegBitmap -> Int # enumFrom :: RegBitmap -> [RegBitmap] # enumFromThen :: RegBitmap -> RegBitmap -> [RegBitmap] # enumFromTo :: RegBitmap -> RegBitmap -> [RegBitmap] # enumFromThenTo :: RegBitmap -> RegBitmap -> RegBitmap -> [RegBitmap] #
Num RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods (+) :: RegBitmap -> RegBitmap -> RegBitmap # (-) :: RegBitmap -> RegBitmap -> RegBitmap # (*) :: RegBitmap -> RegBitmap -> RegBitmap # negate :: RegBitmap -> RegBitmap # abs :: RegBitmap -> RegBitmap # signum :: RegBitmap -> RegBitmap # fromInteger :: Integer -> RegBitmap #
Integral RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods quot :: RegBitmap -> RegBitmap -> RegBitmap # rem :: RegBitmap -> RegBitmap -> RegBitmap # div :: RegBitmap -> RegBitmap -> RegBitmap # mod :: RegBitmap -> RegBitmap -> RegBitmap # quotRem :: RegBitmap -> RegBitmap -> (RegBitmap, RegBitmap) # divMod :: RegBitmap -> RegBitmap -> (RegBitmap, RegBitmap) # toInteger :: RegBitmap -> Integer #
Real RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods toRational :: RegBitmap -> Rational #
Show RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods showsPrec :: Int -> RegBitmap -> ShowS # show :: RegBitmap -> String # showList :: [RegBitmap] -> ShowS #
Eq RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods (==) :: RegBitmap -> RegBitmap -> Bool # (/=) :: RegBitmap -> RegBitmap -> Bool #
Ord RegBitmap Source #
Instance details Defined in GHC.ByteCode.Types Methods compare :: RegBitmap -> RegBitmap -> Ordering # (<) :: RegBitmap -> RegBitmap -> Bool # (<=) :: RegBitmap -> RegBitmap -> Bool # (>) :: RegBitmap -> RegBitmap -> Bool # (>=) :: RegBitmap -> RegBitmap -> Bool # max :: RegBitmap -> RegBitmap -> RegBitmap # min :: RegBitmap -> RegBitmap -> RegBitmap #

data NativeCallType Source #

Constructors

NativePrimCall
NativeTupleReturn

Instances

Instances details

Eq NativeCallType Source #
Instance details Defined in GHC.ByteCode.Types Methods (==) :: NativeCallType -> NativeCallType -> Bool # (/=) :: NativeCallType -> NativeCallType -> Bool #

data NativeCallInfo Source #

Constructors

NativeCallInfo
Fields nativeCallType :: !NativeCallType nativeCallSize :: !WordOff nativeCallRegs :: !GlobalRegSet nativeCallStackSpillSize :: !WordOff

Instances

Instances details

Outputable NativeCallInfo Source #
Instance details Defined in GHC.ByteCode.Types Methods ppr :: NativeCallInfo -> SDoc Source #

voidTupleReturnInfo :: NativeCallInfo Source #

voidPrimCallInfo :: NativeCallInfo Source #

newtype ByteOff Source #

Constructors

ByteOff Int

Instances

Instances details

Outputable ByteOff Source #
Instance details Defined in GHC.ByteCode.Types Methods ppr :: ByteOff -> SDoc Source #
Enum ByteOff Source #
Instance details Defined in GHC.ByteCode.Types Methods succ :: ByteOff -> ByteOff # pred :: ByteOff -> ByteOff # toEnum :: Int -> ByteOff # fromEnum :: ByteOff -> Int # enumFrom :: ByteOff -> [ByteOff] # enumFromThen :: ByteOff -> ByteOff -> [ByteOff] # enumFromTo :: ByteOff -> ByteOff -> [ByteOff] # enumFromThenTo :: ByteOff -> ByteOff -> ByteOff -> [ByteOff] #
Num ByteOff Source #
Instance details Defined in GHC.ByteCode.Types Methods (+) :: ByteOff -> ByteOff -> ByteOff # (-) :: ByteOff -> ByteOff -> ByteOff # (*) :: ByteOff -> ByteOff -> ByteOff # negate :: ByteOff -> ByteOff # abs :: ByteOff -> ByteOff # signum :: ByteOff -> ByteOff # fromInteger :: Integer -> ByteOff #
Integral ByteOff Source #
Instance details Defined in GHC.ByteCode.Types Methods quot :: ByteOff -> ByteOff -> ByteOff # rem :: ByteOff -> ByteOff -> ByteOff # div :: ByteOff -> ByteOff -> ByteOff # mod :: ByteOff -> ByteOff -> ByteOff # quotRem :: ByteOff -> ByteOff -> (ByteOff, ByteOff) # divMod :: ByteOff -> ByteOff -> (ByteOff, ByteOff) # toInteger :: ByteOff -> Integer #
Real ByteOff Source #
Instance details Defined in GHC.ByteCode.Types Methods toRational :: ByteOff -> Rational #
Show ByteOff Source #
Instance details Defined in GHC.ByteCode.Types Methods showsPrec :: Int -> ByteOff -> ShowS # show :: ByteOff -> String # showList :: [ByteOff] -> ShowS #
Eq ByteOff Source #
Instance details Defined in GHC.ByteCode.Types Methods (==) :: ByteOff -> ByteOff -> Bool # (/=) :: ByteOff -> ByteOff -> Bool #
Ord ByteOff Source #
Instance details Defined in GHC.ByteCode.Types Methods compare :: ByteOff -> ByteOff -> Ordering # (<) :: ByteOff -> ByteOff -> Bool # (<=) :: ByteOff -> ByteOff -> Bool # (>) :: ByteOff -> ByteOff -> Bool # (>=) :: ByteOff -> ByteOff -> Bool # max :: ByteOff -> ByteOff -> ByteOff # min :: ByteOff -> ByteOff -> ByteOff #

newtype WordOff Source #

Constructors

WordOff Int

Instances

Instances details

Outputable WordOff Source #
Instance details Defined in GHC.ByteCode.Types Methods ppr :: WordOff -> SDoc Source #
Enum WordOff Source #
Instance details Defined in GHC.ByteCode.Types Methods succ :: WordOff -> WordOff # pred :: WordOff -> WordOff # toEnum :: Int -> WordOff # fromEnum :: WordOff -> Int # enumFrom :: WordOff -> [WordOff] # enumFromThen :: WordOff -> WordOff -> [WordOff] # enumFromTo :: WordOff -> WordOff -> [WordOff] # enumFromThenTo :: WordOff -> WordOff -> WordOff -> [WordOff] #
Num WordOff Source #
Instance details Defined in GHC.ByteCode.Types Methods (+) :: WordOff -> WordOff -> WordOff # (-) :: WordOff -> WordOff -> WordOff # (*) :: WordOff -> WordOff -> WordOff # negate :: WordOff -> WordOff # abs :: WordOff -> WordOff # signum :: WordOff -> WordOff # fromInteger :: Integer -> WordOff #
Integral WordOff Source #
Instance details Defined in GHC.ByteCode.Types Methods quot :: WordOff -> WordOff -> WordOff # rem :: WordOff -> WordOff -> WordOff # div :: WordOff -> WordOff -> WordOff # mod :: WordOff -> WordOff -> WordOff # quotRem :: WordOff -> WordOff -> (WordOff, WordOff) # divMod :: WordOff -> WordOff -> (WordOff, WordOff) # toInteger :: WordOff -> Integer #
Real WordOff Source #
Instance details Defined in GHC.ByteCode.Types Methods toRational :: WordOff -> Rational #
Show WordOff Source #
Instance details Defined in GHC.ByteCode.Types Methods showsPrec :: Int -> WordOff -> ShowS # show :: WordOff -> String # showList :: [WordOff] -> ShowS #
Eq WordOff Source #
Instance details Defined in GHC.ByteCode.Types Methods (==) :: WordOff -> WordOff -> Bool # (/=) :: WordOff -> WordOff -> Bool #
Ord WordOff Source #
Instance details Defined in GHC.ByteCode.Types Methods compare :: WordOff -> WordOff -> Ordering # (<) :: WordOff -> WordOff -> Bool # (<=) :: WordOff -> WordOff -> Bool # (>) :: WordOff -> WordOff -> Bool # (>=) :: WordOff -> WordOff -> Bool # max :: WordOff -> WordOff -> WordOff # min :: WordOff -> WordOff -> WordOff #

newtype HalfWord Source #

Constructors

HalfWord Word

Instances

Instances details

Outputable HalfWord Source #
Instance details Defined in GHC.ByteCode.Types Methods ppr :: HalfWord -> SDoc Source #
Enum HalfWord Source #
Instance details Defined in GHC.ByteCode.Types Methods succ :: HalfWord -> HalfWord # pred :: HalfWord -> HalfWord # toEnum :: Int -> HalfWord # fromEnum :: HalfWord -> Int # enumFrom :: HalfWord -> [HalfWord] # enumFromThen :: HalfWord -> HalfWord -> [HalfWord] # enumFromTo :: HalfWord -> HalfWord -> [HalfWord] # enumFromThenTo :: HalfWord -> HalfWord -> HalfWord -> [HalfWord] #
Num HalfWord Source #
Instance details Defined in GHC.ByteCode.Types Methods (+) :: HalfWord -> HalfWord -> HalfWord # (-) :: HalfWord -> HalfWord -> HalfWord # (*) :: HalfWord -> HalfWord -> HalfWord # negate :: HalfWord -> HalfWord # abs :: HalfWord -> HalfWord # signum :: HalfWord -> HalfWord # fromInteger :: Integer -> HalfWord #
Integral HalfWord Source #
Instance details Defined in GHC.ByteCode.Types Methods quot :: HalfWord -> HalfWord -> HalfWord # rem :: HalfWord -> HalfWord -> HalfWord # div :: HalfWord -> HalfWord -> HalfWord # mod :: HalfWord -> HalfWord -> HalfWord # quotRem :: HalfWord -> HalfWord -> (HalfWord, HalfWord) # divMod :: HalfWord -> HalfWord -> (HalfWord, HalfWord) # toInteger :: HalfWord -> Integer #
Real HalfWord Source #
Instance details Defined in GHC.ByteCode.Types Methods toRational :: HalfWord -> Rational #
Show HalfWord Source #
Instance details Defined in GHC.ByteCode.Types Methods showsPrec :: Int -> HalfWord -> ShowS # show :: HalfWord -> String # showList :: [HalfWord] -> ShowS #
Eq HalfWord Source #
Instance details Defined in GHC.ByteCode.Types Methods (==) :: HalfWord -> HalfWord -> Bool # (/=) :: HalfWord -> HalfWord -> Bool #
Ord HalfWord Source #
Instance details Defined in GHC.ByteCode.Types Methods compare :: HalfWord -> HalfWord -> Ordering # (<) :: HalfWord -> HalfWord -> Bool # (<=) :: HalfWord -> HalfWord -> Bool # (>) :: HalfWord -> HalfWord -> Bool # (>=) :: HalfWord -> HalfWord -> Bool # max :: HalfWord -> HalfWord -> HalfWord # min :: HalfWord -> HalfWord -> HalfWord #

data UnlinkedBCO Source #

Constructors

UnlinkedBCO
Fields unlinkedBCOName :: !Name unlinkedBCOArity :: !Int unlinkedBCOInstrs :: !(UArray Int Word16) unlinkedBCOBitmap :: !(UArray Int Word64) unlinkedBCOLits :: !(SizedSeq BCONPtr) unlinkedBCOPtrs :: !(SizedSeq BCOPtr)

Instances

Instances details

NFData UnlinkedBCO Source #
Instance details Defined in GHC.ByteCode.Types Methods rnf :: UnlinkedBCO -> () Source #
Outputable UnlinkedBCO Source #
Instance details Defined in GHC.ByteCode.Types Methods ppr :: UnlinkedBCO -> SDoc Source #

data BCOPtr Source #

Constructors

BCOPtrName !Name
BCOPtrPrimOp !PrimOp
BCOPtrBCO !UnlinkedBCO
BCOPtrBreakArray (ForeignRef BreakArray)	a pointer to a breakpoint's module's BreakArray in GHCi's memory

Instances

Instances details

NFData BCOPtr Source #
Instance details Defined in GHC.ByteCode.Types Methods rnf :: BCOPtr -> () Source #

data BCONPtr Source #

Constructors

BCONPtrWord !Word
BCONPtrLbl !FastString
BCONPtrItbl !Name
BCONPtrAddr !Name	A reference to a top-level string literal; see Note [Generating code for top-level string literal bindings] in GHC.StgToByteCode.
BCONPtrStr !ByteString	Only used internally in the assembler in an intermediate representation; should never appear in a fully-assembled UnlinkedBCO. Also see Note [Allocating string literals] in GHC.ByteCode.Asm.

Instances

Instances details

NFData BCONPtr Source #
Instance details Defined in GHC.ByteCode.Types Methods rnf :: BCONPtr -> () Source #

type ItblEnv = NameEnv (Name, ItblPtr) Source #

newtype ItblPtr Source #

Constructors

ItblPtr (RemotePtr StgInfoTable)

Instances

Instances details

NFData ItblPtr Source #
Instance details Defined in GHC.ByteCode.Types Methods rnf :: ItblPtr -> () Source #
Show ItblPtr Source #
Instance details Defined in GHC.ByteCode.Types Methods showsPrec :: Int -> ItblPtr -> ShowS # show :: ItblPtr -> String # showList :: [ItblPtr] -> ShowS #

type AddrEnv = NameEnv (Name, AddrPtr) Source #

newtype AddrPtr Source #

Constructors

AddrPtr (RemotePtr ())

Instances

Instances details

NFData AddrPtr Source #
Instance details Defined in GHC.ByteCode.Types Methods rnf :: AddrPtr -> () Source #

data CgBreakInfo Source #

Information about a breakpoint that we know at code-generation time In order to be used, this needs to be hydrated relative to the current HscEnv by hydrateCgBreakInfo. Everything here can be fully forced and that's critical for preventing space leaks (see #22530)

Constructors

CgBreakInfo
Fields cgb_tyvars :: ![IfaceTvBndr] Type variables in scope at the breakpoint cgb_vars :: ![Maybe (IfaceIdBndr, Word)] cgb_resty :: !IfaceType

Instances

Instances details

Outputable CgBreakInfo Source #
Instance details Defined in GHC.ByteCode.Types Methods ppr :: CgBreakInfo -> SDoc Source #

data ModBreaks Source #

All the information about the breakpoints for a module

Constructors

ModBreaks

Fields

modBreaks_flags :: ForeignRef BreakArray
The array of flags, one per breakpoint, indicating which breakpoints are enabled.
modBreaks_locs :: !(Array BreakIndex SrcSpan)
An array giving the source span of each breakpoint.
modBreaks_vars :: !(Array BreakIndex [OccName])
An array giving the names of the free variables at each breakpoint.
modBreaks_decls :: !(Array BreakIndex [String])
An array giving the names of the declarations enclosing each breakpoint. See Note [Field modBreaks_decls]
modBreaks_ccs :: !(Array BreakIndex (RemotePtr CostCentre))
Array pointing to cost centre for each breakpoint
modBreaks_breakInfo :: IntMap CgBreakInfo
info about each breakpoint from the bytecode generator
modBreaks_module :: RemotePtr ModuleName

type BreakIndex = Int Source #

Breakpoint index

emptyModBreaks :: ModBreaks Source #

Construct an empty ModBreaks

data CCostCentre Source #

C CostCentre type