Moduleghc-9.14.1GHC2021

GHC.Runtime.Interpreter.Types

Types used by the runtime interpreter

20 types
11 values

Packageghc-9.14.1
Exports31
LanguageGHC2021
LicenceBSD-3-Clause
SourceTypes.hs

datadata Interp

Interpreter

Constructors

Interp
- interpInstance :: !InterpInstance
  Interpreter instance (internal, external)
- interpLoader :: !Loader
  Interpreter loader
- interpSymbolCache :: !InterpSymbolCache
  LookupSymbol cache

datadata InterpInstance

Constructors

ExternalInterp !ExtInterp
External interpreter
InternalInterp
Internal interpreter

datadata InterpProcess

Constructors

InterpProcess
- interpPipe :: !Pipe
  Pipe to communicate with the server
- interpHandle :: !ProcessHandle
  Process handle of the server
- interpLock :: !MVar ()
  Lock to prevent concurrent access to the stream

datadata ExtInterp

typetype ExtInterpStatusVar d = MVar (InterpStatus (ExtInterpInstance d))

datadata ExtInterpInstance c

Common field between native external interpreter and the JS one

Constructors

ExtInterpInstance
- instProcess :: !InterpProcess
  External interpreter process and its pipe (communication channel)
- instPendingFrees :: !MVar [HValueRef]
  Values that need to be freed before the next command is sent. Finalizers for ForeignRefs can append values to this list asynchronously.
- instExtra :: !c
  Instance specific extra fields

datadata ExtInterpState cfg details

External interpreter

The external interpreter is spawned lazily (on first use) to avoid slowing down sessions that don't require it. The contents of the MVar reflects the state of the interpreter (running or not).

Constructors

ExtInterpState
- interpConfig :: !cfg
- interpStatus :: !ExtInterpStatusVar details

datadata InterpStatus inst

Status of an external interpreter

Constructors

InterpPending
Not spawned yet
InterpRunning !inst
Running

InterpSymbolCache

13 declarations

datadata InterpSymbolCache

Constructors

InterpSymbolCache
- interpClosureCache :: MVar (SymbolCache "closure")
- interpConInfoCache :: MVar (SymbolCache "con_info")
- interpStaticInfoCache :: MVar (SymbolCache "static_info")
- interpBytesCache :: MVar (SymbolCache "bytes")
- interpFaststringCache :: MVar (UniqFM FastString (Ptr ()))

valuemkInterpSymbolCache :: IO InterpSymbolCache

valuelookupInterpSymbolCache

:: InterpSymbol s
-> InterpSymbolCache
-> IO (Maybe (Ptr ()))

valueupdateInterpSymbolCache

:: InterpSymbol s
-> InterpSymbolCache
-> Ptr ()
-> IO ()

valuepurgeInterpSymbolCache :: InterpSymbolCache -> IO ()

Clear all symbol caches.

datadata InterpSymbol (s :: SuffixOrInterpreted) where

Constructors

IClosureSymbol :: Name -> InterpSymbol ('Suffix "closure")
IConInfoSymbol :: Name -> InterpSymbol ('Suffix "con_info")
IStaticInfoSymbol :: Name -> InterpSymbol ('Suffix "static_info")
IBytesSymbol :: Name -> InterpSymbol ('Suffix "bytes")
IFaststringSymbol :: FastString -> InterpSymbol 'Interpreted

Instances1Outputable

Outputable (InterpSymbol s)Defined in ghc-9.14.1 · GHC.Runtime.Interpreter.Types.SymbolCache

datadata SuffixOrInterpreted

Constructors

Suffix Symbol
Interpreted

valueinterpSymbolName :: InterpSymbol ('Suffix s) -> Name

valueinterpSymbolSuffix :: InterpSymbol ('Suffix s) -> String

valueeliminateInterpSymbol

:: InterpSymbol s
-> InterpSymbol 'Interpreted -> r
-> forall (x :: Symbol). InterpSymbol ('Suffix x) -> r
-> r

valueinterpretedInterpSymbol :: InterpSymbol 'Interpreted -> FastString

valueinterpreterProfiled :: Interp -> Bool

Interpreter uses Profiling way

valueinterpreterDynamic :: Interp -> Bool

Interpreter uses Dynamic way

IServ

2 declarations

typetype IServ = ExtInterpState IServConfig ()

datadata IServConfig

Configuration needed to spawn an external interpreter

Constructors

IServConfig
- iservConfProgram :: !String
  External program to run
- iservConfOpts :: ![String]
  Command-line options
- iservConfProfiled :: !Bool
  Use Profiling way
- iservConfDynamic :: !Bool
  Use Dynamic way
- iservConfHook :: !Maybe (CreateProcess -> IO ProcessHandle)
  Hook
- iservConfTrace :: IO ()
  Trace action executed after spawn

JSInterp

8 declarations

typetype JSInterp = ExtInterpState JSInterpConfig JSInterpExtra

datadata JSInterpExtra

Constructors

JSInterpExtra
- instStdIn :: !Handle
  Stdin for the process
- instFinderCache :: !FinderCache
- instFinderOpts :: !FinderOpts
- instJSState :: !MVar JSState
  Mutable state
- instGhciUnitId :: !UnitId
  GHCi unit-id

datadata JSInterpConfig

Constructors

JSInterpConfig
- jsInterpNodeConfig :: !NodeJsSettings
  NodeJS settings
- jsInterpScript :: !FilePath
  Path to "ghc-interp.js" script
- jsInterpTmpFs :: !TmpFs
- jsInterpTmpDir :: !TempDir
- jsInterpLogger :: !Logger
- jsInterpCodegenCfg :: !StgToJSConfig
- jsInterpUnitEnv :: !UnitEnv
- jsInterpFinderOpts :: !FinderOpts
- jsInterpFinderCache :: !FinderCache

datadata JSState

Constructors

JSState
- jsLinkState :: !LinkPlan
  Linker state of the interpreter
- jsServerStarted :: !Bool
  Is the Haskell server started?

datadata NodeJsSettings

NodeJs configuration

Constructors

NodeJsSettings
- nodeProgram :: FilePath
  location of node.js program
- nodePath :: Maybe FilePath
  value of NODE_PATH environment variable (search path for Node modules; GHCJS used to provide some)
- nodeExtraArgs :: [String]
  extra arguments to pass to node.js
- nodeKeepAliveMaxMem :: Integer
  keep node.js (TH, GHCJSi) processes alive if they don't use more than this

valuedefaultNodeJsSettings :: NodeJsSettings

typetype WasmInterp = ExtInterpState WasmInterpConfig ()

datadata WasmInterpConfig

Constructors

WasmInterpConfig
- wasmInterpDyLD :: !FilePath
  Location of dyld.mjs script
- wasmInterpLibDir :: FilePath
  wasi-sdk sysroot libdir containing libc.so, etc
- wasmInterpOpts :: ![String]
  Additional command line arguments for iserv
- wasmInterpBrowser :: !Bool
- wasmInterpBrowserHost :: !String
- wasmInterpBrowserPort :: !Int
- wasmInterpBrowserRedirectWasiConsole :: !Bool
- wasmInterpBrowserPuppeteerLaunchOpts :: !Maybe String
- wasmInterpBrowserPlaywrightBrowserType :: !Maybe String
- wasmInterpBrowserPlaywrightLaunchOpts :: !Maybe String
- wasmInterpTargetPlatform :: !Platform
- wasmInterpProfiled :: !Bool
  Are we profiling yet?
- wasmInterpHsSoSuffix :: !String
  Shared lib filename common suffix sans .so, e.g. p-ghc9.13.20241001
- wasmInterpUnitState :: !UnitState