Moduleghc-9.10.3GHC2021

GHC.ByteCode.Types

Bytecode assembler types

21 types
8 values

Packageghc-9.10.3
Exports29
LanguageGHC2021
LicenceBSD-3-Clause
SourceTypes.hs

datadata CompiledByteCode

Constructors

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

Instances1Outputable

Outputable CompiledByteCodeDefined in ghc-9.10.3 · GHC.ByteCode.Types

valueseqCompiledByteCode :: CompiledByteCode -> ()

datadata BCOByteArray a

Wrapper for a ByteArray#. The phantom type tells what elements are stored in the ByteArray#. Creating a ByteArray# can be achieved using UArray's API, where the underlying ByteArray# can be unpacked.

Constructors

BCOByteArray
- getBCOByteArray :: !ByteArray#

Instances3Show, Binary

Show (BCOByteArray Word16)Defined in ghci-9.10.3 · GHCi.ResolvedBCO
Show (BCOByteArray Word)Defined in ghci-9.10.3 · GHCi.ResolvedBCO
Binary (BCOByteArray a)Defined in ghci-9.10.3 · GHCi.ResolvedBCO

valuemkBCOByteArray :: UArray Int a -> BCOByteArray a

newtypenewtype FFIInfo

Constructors

FFIInfo (RemotePtr C_ffi_cif)

Instances2Show, NFData

Show FFIInfoDefined in ghc-9.10.3 · GHC.ByteCode.Types
NFData FFIInfoDefined in ghc-9.10.3 · GHC.ByteCode.Types

newtypenewtype RegBitmap

Constructors

RegBitmap
- unRegBitmap :: Word32

Instances10Enum, Eq, Integral, Num, Ord, Real, …

Enum RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types
Eq RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types
Integral RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types
Num RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types
Ord RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types
Real RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types
Show RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types
Bits RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types
FiniteBits RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types
Outputable RegBitmapDefined in ghc-9.10.3 · GHC.ByteCode.Types

datadata NativeCallType

NativePrimCall NativeTupleReturn

Instances1Eq

Eq NativeCallTypeDefined in ghc-9.10.3 · GHC.ByteCode.Types

datadata NativeCallInfo

Constructors

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

Instances1Outputable

Outputable NativeCallInfoDefined in ghc-9.10.3 · GHC.ByteCode.Types

valuevoidTupleReturnInfo :: NativeCallInfo

valuevoidPrimCallInfo :: NativeCallInfo

newtypenewtype ByteOff

Constructors

ByteOff Int

Instances8Enum, Eq, Integral, Num, Ord, Real, …

Enum ByteOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Eq ByteOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Integral ByteOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Num ByteOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Ord ByteOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Real ByteOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Show ByteOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Outputable ByteOffDefined in ghc-9.10.3 · GHC.ByteCode.Types

newtypenewtype WordOff

Constructors

WordOff Int

Instances8Enum, Eq, Integral, Num, Ord, Real, …

Enum WordOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Eq WordOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Integral WordOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Num WordOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Ord WordOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Real WordOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Show WordOffDefined in ghc-9.10.3 · GHC.ByteCode.Types
Outputable WordOffDefined in ghc-9.10.3 · GHC.ByteCode.Types

newtypenewtype HalfWord

Constructors

HalfWord Word

Instances8Enum, Eq, Integral, Num, Ord, Real, …

Enum HalfWordDefined in ghc-9.10.3 · GHC.ByteCode.Types
Eq HalfWordDefined in ghc-9.10.3 · GHC.ByteCode.Types
Integral HalfWordDefined in ghc-9.10.3 · GHC.ByteCode.Types
Num HalfWordDefined in ghc-9.10.3 · GHC.ByteCode.Types
Ord HalfWordDefined in ghc-9.10.3 · GHC.ByteCode.Types
Real HalfWordDefined in ghc-9.10.3 · GHC.ByteCode.Types
Show HalfWordDefined in ghc-9.10.3 · GHC.ByteCode.Types
Outputable HalfWordDefined in ghc-9.10.3 · GHC.ByteCode.Types

datadata UnlinkedBCO

Constructors

UnlinkedBCO
- unlinkedBCOName :: !Name
- unlinkedBCOArity :: !Int
- unlinkedBCOInstrs :: !BCOByteArray Word16
- unlinkedBCOBitmap :: !BCOByteArray Word
- unlinkedBCOLits :: !FlatBag BCONPtr
- unlinkedBCOPtrs :: !FlatBag BCOPtr

Instances2NFData, Outputable

NFData UnlinkedBCODefined in ghc-9.10.3 · GHC.ByteCode.Types
Outputable UnlinkedBCODefined in ghc-9.10.3 · GHC.ByteCode.Types

datadata BCOPtr

Constructors

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

Instances1NFData

NFData BCOPtrDefined in ghc-9.10.3 · GHC.ByteCode.Types

datadata BCONPtr

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.

Instances1NFData

NFData BCONPtrDefined in ghc-9.10.3 · GHC.ByteCode.Types

typetype ItblEnv = NameEnv (Name, ItblPtr)

newtypenewtype ItblPtr

Constructors

ItblPtr (RemotePtr StgInfoTable)

Instances2Show, NFData

Show ItblPtrDefined in ghc-9.10.3 · GHC.ByteCode.Types
NFData ItblPtrDefined in ghc-9.10.3 · GHC.ByteCode.Types

typetype AddrEnv = NameEnv (Name, AddrPtr)

newtypenewtype AddrPtr

Constructors

AddrPtr (RemotePtr ())

Instances1NFData

NFData AddrPtrDefined in ghc-9.10.3 · GHC.ByteCode.Types

datadata CgBreakInfo

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
- cgb_tyvars :: ![IfaceTvBndr]
  Type variables in scope at the breakpoint
- cgb_vars :: ![Maybe (IfaceIdBndr, Word)]
- cgb_resty :: !IfaceType

Instances1Outputable

Outputable CgBreakInfoDefined in ghc-9.10.3 · GHC.ByteCode.Types

datadata ModBreaks

All the information about the breakpoints for a module

Constructors

ModBreaks
- 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

typetype BreakIndex = Int

Breakpoint index

valueemptyModBreaks :: ModBreaks

Construct an empty ModBreaks

datadata CCostCentre

C CostCentre type

datadata FlatBag a

Store elements in a flattened representation.

A FlatBag is a data structure that stores an ordered list of elements in a flat structure, avoiding the overhead of a linked list. Use this data structure, if the code requires the following properties:

Elements are stored in a long-lived object, and benefit from a flattened representation.
The FlatBag will be traversed but not extended or filtered.
The number of elements should be known.
Sharing of the empty case improves memory behaviour.

A FlagBag aims to have as little overhead as possible to store its elements. To achieve that, it distinguishes between the empty case, singleton, tuple and general case. Thus, we only pay for the additional three words of an Array if we have at least three elements.

Instances4Functor, Foldable, Traversable, NFData

Functor FlatBagDefined in ghc-9.10.3 · GHC.Data.FlatBag
Foldable FlatBagDefined in ghc-9.10.3 · GHC.Data.FlatBag
Traversable FlatBagDefined in ghc-9.10.3 · GHC.Data.FlatBag
NFData a => NFData (FlatBag a)Defined in ghc-9.10.3 · GHC.Data.FlatBag

valuesizeFlatBag :: FlatBag a -> Word

Calculate the size of

valuefromSizedSeq :: SizedSeq a -> FlatBag a

Convert a SizedSeq into its flattened representation. A 'FlatBag a' is more memory efficient than '[a]', if no further modification is necessary.

valueelemsFlatBag :: FlatBag a -> [a]

Get all elements that are stored in the FlatBag.