Moduleghc-9.10.3GHC2021

GHC.StgToJS.Types

Module that holds the Types required for the StgToJS pass

32 types
4 values

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

typetype G = StateT GenState IO

A State monad over IO holding the generator state.

datadata GenState

The JS code generator state

Constructors

GenState
- gsSettings :: !StgToJSConfig
  codegen settings, read-only
- gsModule :: !Module
  current module
- gsId :: !FastMutInt
  unique number for the id generator
- gsIdents :: !IdCache
  hash consing for identifiers from a Unique
- gsUnfloated :: !UniqFM Id CgStgExpr
  unfloated arguments
- gsGroup :: GenGroupState
  state for the current binding group
- gsGlobal :: [JStgStat]
  global (per module) statements (gets included when anything else from the module is used)

datadata GenGroupState

The JS code generator state relevant for the current binding group

Constructors

GenGroupState
- ggsToplevelStats :: [JStgStat]
  extra toplevel statements for the binding group
- ggsClosureInfo :: [ClosureInfo]
  closure metadata (info tables) for the binding group
- ggsStatic :: [StaticInfo]
  static (CAF) data in our binding group
- ggsStack :: [StackSlot]
  stack info for the current expression
- ggsStackDepth :: Int
  current stack depth
- ggsExtraDeps :: Set OtherSymb
  extra dependencies for the linkable unit that contains this group
- ggsGlobalIdCache :: GlobalIdCache
- ggsForeignRefs :: [ForeignJSRef]

datadata StgToJSConfig

The Configuration record for the StgToJS pass

Constructors

StgToJSConfig
- csInlinePush :: !Bool
- csInlineBlackhole :: !Bool
- csInlineLoadRegs :: !Bool
- csInlineEnter :: !Bool
- csInlineAlloc :: !Bool
- csPrettyRender :: !Bool
- csTraceRts :: !Bool
- csAssertRts :: !Bool
- csBoundsCheck :: !Bool
- csDebugAlloc :: !Bool
- csTraceForeign :: !Bool
- csProf :: !Bool
  Profiling enabled
- csRuntimeAssert :: !Bool
  Enable runtime assertions settings
- csContext :: !SDocContext
- csLinkerConfig :: !LinkerConfig
  Emscripten linker

datadata ClosureInfo

Information relevenat to code generation for closures.

Constructors

ClosureInfo
- ciVar :: Ident
  object being infod
- ciRegs :: CIRegs
  size of the payload (in number of JS values)
- ciName :: FastString
  friendly name for printing
- ciLayout :: CILayout
  heap/stack layout of the object
- ciType :: CIType
  type of the object, with extra info where required
- ciStatic :: CIStatic
  static references of this object

Instances3Eq, Show, Binary

Eq ClosureInfoDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show ClosureInfoDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary ClosureInfoDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata CIRegs

Closure information, ClosureInfo, registers

Constructors

CIRegsUnknown
A value witnessing a state of unknown registers
CIRegs
- ciRegsSkip :: Int
  unused registers before actual args start
- ciRegsTypes :: [JSRep]
  args

Instances4Eq, Ord, Show, Binary

Eq CIRegsDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord CIRegsDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show CIRegsDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary CIRegsDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata CILayout

Closure Information, ClosureInfo, layout

Constructors

CILayoutVariable
layout stored in object itself, first position from the start
CILayoutUnknown
fixed size, but content unknown (for example stack apply frame)
- layoutSize :: !Int
  closure size in array positions, including entry
CILayoutFixed
whole layout known
- layoutSize :: !Int
  closure size in array positions, including entry
- layout :: [JSRep]
  The list of JSReps to layout

Instances4Eq, Ord, Show, Binary

Eq CILayoutDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord CILayoutDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show CILayoutDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary CILayoutDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata CIType

The type of ClosureInfo

Constructors

CIFun
- citArity :: !Int
  function arity
- citRegs :: !Int
  number of registers for the args
CIThunk
The closure is a THUNK
CICon
The closure is a Constructor
- citConstructor :: !Int
CIPap
The closure is a Partial Application
CIBlackhole
The closure is a black hole
CIStackFrame
The closure is a stack frame

Instances4Eq, Ord, Show, Binary

Eq CITypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord CITypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show CITypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary CITypeDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

newtypenewtype CIStatic

Static references that must be kept alive

Constructors

CIStaticRefs
- staticRefs :: [FastString]

Instances6Eq, Show, Semigroup, Monoid, Binary, ToJExpr

Eq CIStaticDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show CIStaticDefined in ghc-9.10.3 · GHC.StgToJS.Types
Semigroup CIStaticDefined in ghc-9.10.3 · GHC.StgToJS.Types
Monoid CIStaticDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary CIStaticDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan
ToJExpr CIStaticDefined in ghc-9.10.3 · GHC.StgToJS.Types
static refs: array = references, null = nothing to report note: only works after all top-level objects have been created

datadata JSRep

JS primitive representations

Constructors

PtrV
pointer = reference to heap object (closure object), lifted or not. Can also be some RTS object (e.g. TVar#, MVar#, MutVar#, Weak#)
VoidV
no fields
DoubleV
A Double: one field
IntV
An Int (32bit because JS): one field
LongV
A Long: two fields one for the upper 32bits, one for the lower (NB: JS is little endian)
AddrV
a pointer not to the heap: two fields, array + index
ObjV
some JS object, user supplied, be careful around these, can be anything
ArrV
boxed array

Instances7Bounded, Enum, Eq, Ord, Show, Binary, …

Bounded JSRepDefined in ghc-9.10.3 · GHC.StgToJS.Types
Enum JSRepDefined in ghc-9.10.3 · GHC.StgToJS.Types
Eq JSRepDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord JSRepDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show JSRepDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary JSRepDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan
ToJExpr JSRepDefined in ghc-9.10.3 · GHC.StgToJS.Types

datadata IdType

The type of identifiers. These determine the suffix of generated functions in JS Land. For example, the entry function for the Just constructor is a IdConEntry which compiles to: function h$ghczminternalZCGHCziInternalziMaybeziJust_con_e() { return h$rs() }; which just returns whatever the stack point is pointing to. Whereas the entry function to Just is an IdEntry and does the work. It compiles to: function h$ghczminternalZCGHCziInternalziMaybeziJust_e() { var h$$baseZCGHCziMaybezieta_8KXnScrCjF5 = h$r2; h$r1 = h$c1(h$ghczminternalZCGHCziInternalziMaybeziJust_con_e, h$$ghczminternalZCGHCziInternalziMaybezieta_8KXnScrCjF5); return h$rs(); }; Which loads some payload from register 2, and applies the Constructor Entry function for the Just to the payload, returns the result in register 1 and returns whatever is on top of the stack

Constructors

IdPlain
A plain identifier for values, no suffix added
IdEntry
An entry function, suffix = "_e" in makeIdentForId
IdConEntry
A Constructor entry function, suffix = "_con_e" in makeIdentForId

Instances3Enum, Eq, Ord

Enum IdTypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Eq IdTypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord IdTypeDefined in ghc-9.10.3 · GHC.StgToJS.Types

datadata IdKey

Keys to differentiate Ident's in the ID Cache

Constructors

IdKey !Word64 !Int !IdType

Instances2Eq, Ord

Eq IdKeyDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord IdKeyDefined in ghc-9.10.3 · GHC.StgToJS.Types

datadata OtherSymb

Some other symbol

Constructors

OtherSymb !Module !FastString

Instances2Eq, Ord

Eq OtherSymbDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord OtherSymbDefined in ghc-9.10.3 · GHC.StgToJS.Types

newtypenewtype IdCache

The identifier cache indexed on IdKey local to a module

Constructors

IdCache (Map IdKey Ident)

newtypenewtype GlobalIdCache

The global Identifier Cache

Constructors

GlobalIdCache (UniqFM Ident (IdKey, Id))

datadata StackSlot

A Stack Slot is either known or unknown. We avoid maybe here for more strictness.

Constructors

SlotId !Id !Int
SlotUnknown

Instances2Eq, Ord

Eq StackSlotDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord StackSlotDefined in ghc-9.10.3 · GHC.StgToJS.Types

datadata StaticInfo

Constructors

StaticInfo
- siVar :: !FastString
  global object
- siVal :: !StaticVal
  static initialization
- siCC :: !Maybe Ident
  optional CCS name

Instances3Eq, Show, Binary

Eq StaticInfoDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show StaticInfoDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary StaticInfoDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata StaticVal

Constructors

StaticFun !FastString [StaticArg]
heap object for function
StaticThunk !(Maybe (FastString, [StaticArg]))
heap object for CAF (field is Nothing when thunk is initialized in an alternative way, like string thunks through h$str)
StaticUnboxed !StaticUnboxed
unboxed constructor (Bool, Int, Double etc)
StaticData !FastString [StaticArg]
regular datacon app
StaticList [StaticArg] (Maybe FastString)
list initializer (with optional tail)

Instances3Eq, Show, Binary

Eq StaticValDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show StaticValDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary StaticValDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata StaticUnboxed

Constructors

StaticUnboxedBool !Bool
StaticUnboxedInt !Integer
StaticUnboxedDouble !SaneDouble
StaticUnboxedString !ByteString
StaticUnboxedStringOffset !ByteString

Instances4Eq, Ord, Show, Binary

Eq StaticUnboxedDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord StaticUnboxedDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show StaticUnboxedDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary StaticUnboxedDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata StaticArg

Static Arguments. Static Arguments are things that are statically allocated, i.e., they exist at program startup. These are static heap objects or literals or things that have been floated to the top level binding by ghc.

Constructors

StaticObjArg !FastString
reference to a heap object
StaticLitArg !StaticLit
literal
StaticConArg !FastString [StaticArg]
unfloated constructor

Instances4Eq, Show, Outputable, Binary

Eq StaticArgDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show StaticArgDefined in ghc-9.10.3 · GHC.StgToJS.Types
Outputable StaticArgDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary StaticArgDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata StaticLit

A Static literal value

Constructors

BoolLit !Bool
IntLit !Integer
NullLit
DoubleLit !SaneDouble
StringLit !FastString
BinLit !ByteString
LabelLit !Bool !FastString
is function pointer, label (also used for string / binary init)

Instances5Eq, Show, Outputable, Binary, ToJExpr

Eq StaticLitDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show StaticLitDefined in ghc-9.10.3 · GHC.StgToJS.Types
Outputable StaticLitDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary StaticLitDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan
ToJExpr StaticLitDefined in ghc-9.10.3 · GHC.StgToJS.Types

datadata ForeignJSRef

A foreign reference to some JS code

Constructors

ForeignJSRef
- foreignRefSrcSpan :: !FastString
- foreignRefPattern :: !FastString
- foreignRefSafety :: !Safety
- foreignRefCConv :: !CCallConv
- foreignRefArgs :: ![FastString]
- foreignRefResult :: !FastString

Instances1Binary

Binary ForeignJSRefDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata LinkableUnit

data used to generate one ObjBlock in our object file

Constructors

LinkableUnit
- luObjBlock :: ObjBlock
  serializable unit info
- luIdExports :: [Id]
  exported names from haskell identifiers
- luOtherExports :: [FastString]
  other exports
- luIdDeps :: [Id]
  identifiers this unit depends on
- luPseudoIdDeps :: [Unique]
  pseudo-id identifiers this unit depends on (fixme)
- luOtherDeps :: [OtherSymb]
  symbols not from a haskell id that this unit depends on
- luRequired :: Bool
  always link this unit
- luForeignRefs :: [ForeignJSRef]

datadata ObjBlock

one toplevel block in the object file

Constructors

ObjBlock
- oiSymbols :: ![FastString]
  toplevel symbols (stored in index)
- oiClInfo :: ![ClosureInfo]
  closure information of all closures in block
- oiStatic :: ![StaticInfo]
  static closure data
- oiStat :: JStat
  the code
- oiRaw :: !ByteString
  raw JS code
- oiFExports :: ![ExpFun]
- oiFImports :: ![ForeignJSRef]

datadata ExpFun

Constructors

ExpFun
- isIO :: !Bool
- args :: [JSFFIType]
- result :: !JSFFIType

Instances4Eq, Ord, Show, Binary

Eq ExpFunDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord ExpFunDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show ExpFunDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary ExpFunDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata JSFFIType

Types of FFI values

Int8Type Int16Type Int32Type Int64Type Word8Type Word16Type Word32Type Word64Type DoubleType ByteArrayType PtrType RefType

Instances5Enum, Eq, Ord, Show, Binary

Enum JSFFITypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Eq JSFFITypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord JSFFITypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show JSFFITypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Binary JSFFITypeDefined in ghc-9.10.3 · GHC.StgToJS.Object · orphan

datadata TypedExpr

Typed expression

Constructors

TypedExpr
- typex_typ :: !PrimRep
- typex_expr :: [JStgExpr]

Instances1Outputable

Outputable TypedExprDefined in ghc-9.10.3 · GHC.StgToJS.Types

datadata PrimRes

A Primop result is either an inlining of some JS payload, or a primitive call to a JS function defined in Shim files in base.

Constructors

PrimInline JStgStat
primop is inline, result is assigned directly
PRPrimCall JStgStat
primop is async call, primop returns the next function to run. result returned to stack top in registers

datadata ExprResult

ExprCont ExprInline

Instances1Eq

Eq ExprResultDefined in ghc-9.10.3 · GHC.StgToJS.Types

newtypenewtype ExprValData

Constructors

ExprValData [JStgExpr]

Instances1Eq

Eq ExprValDataDefined in ghc-9.10.3 · GHC.StgToJS.Types

datadata ClosureType

A Closure is one of six types

Constructors

Thunk
The closure is a THUNK
Fun
The closure is a Function
Pap
The closure is a Partial Application
Con
The closure is a Constructor
Blackhole
The closure is a Blackhole
StackFrame
The closure is a stack frame

Instances6Bounded, Enum, Eq, Ord, Show, ToJExpr

Bounded ClosureTypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Enum ClosureTypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Eq ClosureTypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord ClosureTypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show ClosureTypeDefined in ghc-9.10.3 · GHC.StgToJS.Types
ToJExpr ClosureTypeDefined in ghc-9.10.3 · GHC.StgToJS.Types

valuectNum :: ClosureType -> Int

Convert ClosureType to an Int

valuectJsName :: ClosureType -> String

Convert ClosureType to a String

datadata ThreadStatus

A thread is in one of 4 states

Constructors

Running
The thread is running
Blocked
The thread is blocked
Finished
The thread is done
Died
The thread has died

Instances5Bounded, Enum, Eq, Ord, Show

Bounded ThreadStatusDefined in ghc-9.10.3 · GHC.StgToJS.Types
Enum ThreadStatusDefined in ghc-9.10.3 · GHC.StgToJS.Types
Eq ThreadStatusDefined in ghc-9.10.3 · GHC.StgToJS.Types
Ord ThreadStatusDefined in ghc-9.10.3 · GHC.StgToJS.Types
Show ThreadStatusDefined in ghc-9.10.3 · GHC.StgToJS.Types

valuethreadStatusNum :: ThreadStatus -> Int

Convert the status of a thread in JS land to an Int

valuethreadStatusJsName :: ThreadStatus -> String

convert the status of a thread in JS land to a string