Moduleghc-10.0.0.20260917GHC2024

GHC.Runtime.Interpreter

Interacting with the iserv interpreter, whether it is running on an external process or in the current process.

5 types
48 values

Packageghc-10.0.0.20260917
Exports53
LanguageGHC2024
LicenceBSD-3-Clause
SourceInterpreter.hs

module GHC.Runtime.Interpreter.Types

High-level interface to the interpreter

27 declarations

valueevalStmt

:: Interp
-> EvalOpts
-> EvalExpr ForeignHValue
-> IO (EvalStatus_ [ForeignHValue] [HValueRef])

Execute an action of type IO [a], returning ForeignHValues for each of the results.

datadata EvalStatus_ a b

Constructors

EvalComplete Word64 (EvalResult a)
EvalBreak HValueRef (Maybe EvalBreakpoint) (RemoteRef (ResumeContext b)) (RemotePtr CostCentreStack)

Instances4Show, Generic, Binary, Rep

Show a => Show (EvalStatus_ a b)Defined in ghci-10.0.0.20260917 · GHCi.Message
Generic (EvalStatus_ a b)Defined in ghci-10.0.0.20260917 · GHCi.Message
Binary a => Binary (EvalStatus_ a b)Defined in ghci-10.0.0.20260917 · GHCi.Message
type Rep (EvalStatus_ a b) = D1 ('MetaData "EvalStatus_" "GHCi.Message" "ghci-10.0.0.20260917-ecdf" 'False) (C1 ('MetaCons "EvalComplete" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvalResult a))) :+: C1 ('MetaCons "EvalBreak" 'PrefixI 'False) ((S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HValueRef) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EvalBreakpoint))) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RemoteRef (ResumeContext b))) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RemotePtr CostCentreStack)))))Defined in ghci-10.0.0.20260917 · GHCi.Message

typetype EvalStatus a = EvalStatus_ a a

datadata EvalResult a

Constructors

EvalException SerializableException
EvalSuccess a

Instances4Show, Generic, Binary, Rep

Show a => Show (EvalResult a)Defined in ghci-10.0.0.20260917 · GHCi.Message
Generic (EvalResult a)Defined in ghci-10.0.0.20260917 · GHCi.Message
Binary a => Binary (EvalResult a)Defined in ghci-10.0.0.20260917 · GHCi.Message
type Rep (EvalResult a) = D1 ('MetaData "EvalResult" "GHCi.Message" "ghci-10.0.0.20260917-ecdf" 'False) (C1 ('MetaCons "EvalException" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SerializableException)) :+: C1 ('MetaCons "EvalSuccess" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))Defined in ghci-10.0.0.20260917 · GHCi.Message

datadata EvalExpr a

We can pass simple expressions to EvalStmt, consisting of values and application. This allows us to wrap the statement to be executed in another function, which is used by GHCi to implement :set args and :set prog. It might be worthwhile to extend this little language in the future.

Constructors

EvalThis a
EvalApp (EvalExpr a) (EvalExpr a)

Instances4Show, Generic, Binary, Rep

Show a => Show (EvalExpr a)Defined in ghci-10.0.0.20260917 · GHCi.Message
Generic (EvalExpr a)Defined in ghci-10.0.0.20260917 · GHCi.Message
Binary a => Binary (EvalExpr a)Defined in ghci-10.0.0.20260917 · GHCi.Message
type Rep (EvalExpr a) = D1 ('MetaData "EvalExpr" "GHCi.Message" "ghci-10.0.0.20260917-ecdf" 'False) (C1 ('MetaCons "EvalThis" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "EvalApp" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvalExpr a)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvalExpr a))))Defined in ghci-10.0.0.20260917 · GHCi.Message

valueresumeStmt

:: Interp
-> EvalOpts
-> ForeignRef (ResumeContext [HValueRef])
-> IO (EvalStatus_ [ForeignHValue] [HValueRef])

valueabandonStmt :: Interp -> ForeignRef (ResumeContext [HValueRef]) -> IO ()

valueevalIO :: Interp -> ForeignHValue -> IO ()

Execute an action of type IO ()

valueevalString :: Interp -> ForeignHValue -> IO String

Execute an action of type IO String

valueevalStringToIOString :: Interp -> ForeignHValue -> String -> IO String

Execute an action of type String -> IO String

valuemallocData :: Interp -> ByteString -> IO (RemotePtr ())

Allocate and store the given bytes in memory, returning a pointer to the memory in the remote process.

valuecreateBCOs :: Interp -> [ResolvedBCO] -> IO [HValueRef]

Create a set of BCOs that may be mutually recursive.

valueaddSptEntry :: Interp -> Fingerprint -> ForeignHValue -> IO ()

valuemkCostCentres

:: Interp
-> FastString
-> [(ShortByteString, ShortByteString)]
-> IO [RemotePtr CostCentre]

valuecostCentreStackInfo :: Interp -> RemotePtr CostCentreStack -> IO [String]

valuenewBreakArray :: Interp -> Int -> IO (ForeignRef BreakArray)

valuestoreBreakpoint :: Interp -> ForeignRef BreakArray -> Int -> Int -> IO ()

valuebreakpointStatus :: Interp -> ForeignRef BreakArray -> Int -> IO Bool

valuegetBreakpointVar

valuegetClosure :: Interp -> ForeignHValue -> IO (GenClosure ForeignHValue)

valuewhereFrom :: Interp -> ForeignHValue -> IO (Maybe InfoProv)

valuegetModBreaks :: HomeModInfo -> Maybe InternalModBreaks

Get the breakpoint information from the ByteCode object associated to this HomeModInfo.

valuereadIModBreaks

Read the InternalModBreaks of the given home Module (via InternalBreakpointId) from the HomeUnitGraph.

valuereadIModBreaksMaybe

Read the InternalModBreaks of the given home Module from the HomeUnitGraph.

valuereadIModModBreaks :: HomeUnitGraph -> Module -> IO ModBreaks

Read the ModBreaks from the given module's InternalModBreaks

valueseqHValue

:: Interp
-> UnitEnv
-> Logger
-> ForeignHValue
-> IO (EvalResult ())

Send a Seq message to the iserv process to force a value #2950

valueevalBreakpointToId :: EvalBreakpoint -> InternalBreakpointId

The object-code linker

25 declarations

valueinitObjLinker :: Interp -> IO ()

valuelookupSymbol :: Interp -> InterpSymbol s -> IO (Maybe (RemotePtr ()))

valuelookupSymbolInDLL

:: Interp
-> RemotePtr LoadedDLL
-> InterpSymbol s
-> IO (Maybe (RemotePtr ()))

valuelookupClosure :: Interp -> InterpSymbol s -> IO (Maybe HValueRef)

valueloadDLLs :: Interp -> [String] -> IO (Either String [RemotePtr LoadedDLL])

loadDLLs loads dynamic libraries using the OS's native linker (i.e. dlopen() on Unix, LoadLibrary() on Windows). It takes either absolute pathnames to the files, or relative filenames (e.g. "libfoo.so" or "foo.dll"). In the latter case, loadDLLs searches the standard locations for the appropriate libraries.

valueloadArchive :: Interp -> String -> IO ()

valueloadObj :: Interp -> String -> IO ()

valueunloadObj :: Interp -> String -> IO ()

valueaddLibrarySearchPath :: Interp -> String -> IO (RemotePtr ())

valueremoveLibrarySearchPath :: Interp -> RemotePtr () -> IO Bool

valueresolveObjs :: Interp -> IO SuccessFlag

valuefindSystemLibrary :: Interp -> String -> IO (Maybe String)

valueinterpCmd :: Binary a => Interp -> Message a -> IO a

Run a command in the interpreter's context. With -fexternal-interpreter, the command is serialized and sent to an external iserv process, and the response is deserialized (hence the Binary constraint). With -fno-external-interpreter we execute the command directly here.

valuewithExtInterp

:: ExceptionMonad m
=> ExtInterp
-> forall d. ExtInterpInstance d -> m a
-> m a

valuewithExtInterpStatus

:: ExtInterp
-> forall d. ExtInterpStatusVar d -> m a
-> m a

valuewithIServ

:: ExceptionMonad m
=> IServ
-> ExtInterpInstance () -> m a
-> m a

Grab a lock on the IServ and do something with it. Overloaded because this is used from TcM as well as IO.

valuewithJSInterp

:: ExceptionMonad m
=> JSInterp
-> ExtInterpInstance JSInterpExtra -> m a
-> m a

Spawn JS interpreter if it isn't already running and execute the given action

Update the interpreter state.

valuestopInterp :: Interp -> IO ()

Stop the interpreter

valuepurgeLookupSymbolCache :: Interp -> IO ()

valuefreeReallyRemoteRef :: ExtInterpInstance d -> RemoteRef a -> IO ()

valuefreeHValueRefs :: Interp -> [HValueRef] -> IO ()

valuemkFinalizedHValue :: Interp -> RemoteRef a -> IO (ForeignRef a)

Creates a ForeignRef that will automatically release the RemoteRef when it is no longer referenced.

valuewormhole :: Interp -> ForeignRef a -> IO a

Convert a ForeignRef to the value it references directly. This only works when the interpreter is running in the same process as the compiler, so it fails when -fexternal-interpreter is on.

valuewormholeRef :: Interp -> RemoteRef a -> IO a

Convert an RemoteRef to the value it references directly. This only works when the interpreter is running in the same process as the compiler, so it fails when -fexternal-interpreter is on.

valuefromEvalResult :: EvalResult a -> IO a

Reexport for convenience

1 declaration

datadata Message a where

A Message a is a message that returns a value of type a. These are requests sent from GHC to the server.

Constructors

Shutdown :: Message ()
Exit the iserv process
RtsRevertCAFs :: Message ()
InitLinker :: Message ()
LookupSymbol :: !ShortByteString -> Message (Maybe (RemotePtr ()))
LookupSymbolInDLL :: !RemotePtr LoadedDLL -> !ShortByteString -> Message (Maybe (RemotePtr ()))
LookupClosure :: !ShortByteString -> Message (Maybe HValueRef)
LoadDLLs :: [String] -> Message (Either String [RemotePtr LoadedDLL])
LoadArchive :: String -> Message ()
LoadObj :: String -> Message ()
UnloadObj :: String -> Message ()
AddLibrarySearchPath :: String -> Message (RemotePtr ())
RemoveLibrarySearchPath :: RemotePtr () -> Message Bool
ResolveObjs :: Message Bool
FindSystemLibrary :: String -> Message (Maybe String)
CreateBCOs :: [ResolvedBCO] -> Message [HValueRef]
Create a set of BCO objects, and return HValueRefs to them See createBCOs in compilerGHCRuntime/Interpreter.hs. NB: this has a custom Binary behavior, see Note [Parallelize CreateBCOs serialization]
FreeHValueRefs :: [HValueRef] -> Message ()
Release HValueRefs
AddSptEntry :: Fingerprint -> HValueRef -> Message ()
Add entries to the Static Pointer Table
MallocData :: ByteString -> Message (RemotePtr ())
Malloc some data and return a RemotePtr to it
MallocStrings :: [ByteString] -> Message [RemotePtr ()]
PrepFFI :: [FFIType] -> FFIType -> Message (RemotePtr C_ffi_cif)
Calls GHCi.FFI.prepareForeignCall
FreeFFI :: RemotePtr C_ffi_cif -> Message ()
Free data previously created by PrepFFI
MkConInfoTable :: !ConInfoTable -> Message (RemotePtr StgInfoTable)
Create an info table for a constructor
EvalStmt :: EvalOpts -> EvalExpr HValueRef -> Message (EvalStatus_ [HValueRef] [HValueRef])
Evaluate a statement
ResumeStmt :: EvalOpts -> RemoteRef (ResumeContext [HValueRef]) -> Message (EvalStatus_ [HValueRef] [HValueRef])
Resume evaluation of a statement after a breakpoint
AbandonStmt :: RemoteRef (ResumeContext [HValueRef]) -> Message ()
Abandon evaluation of a statement after a breakpoint
EvalString :: HValueRef -> Message (EvalResult String)
Evaluate something of type IO String
EvalStringToString :: HValueRef -> String -> Message (EvalResult String)
Evaluate something of type String -> IO String
EvalIO :: HValueRef -> Message (EvalResult ())
Evaluate something of type IO ()
MkCostCentres :: !RemotePtr () -> ![(ShortByteString, ShortByteString)] -> Message [RemotePtr CostCentre]
Create a set of CostCentres with the same module name
CostCentreStackInfo :: RemotePtr CostCentreStack -> Message [String]
Show a CostCentreStack as a [String]
NewBreakArray :: Int -> Message (RemoteRef BreakArray)
Create a new array of breakpoint flags
SetupBreakpoint :: RemoteRef BreakArray -> Int -> Int -> Message ()
Set how many times a breakpoint should be ignored also used for enable/disable
BreakpointStatus :: RemoteRef BreakArray -> Int -> Message Bool
Query the status of a breakpoint (True = enabled)
GetBreakpointVar :: HValueRef -> Int -> Message (Maybe HValueRef)
Get a reference to a free variable at a breakpoint
StartTH :: Message (RemoteRef (IORef QState))
Start a new TH module, return a state token that should be
RunTH :: RemoteRef (IORef QState) -> HValueRef -> THResultType -> Maybe Loc -> Message (QResult ByteString)
Evaluate a TH computation.
Returns a ByteString, because we have to force the result before returning it to ensure there are no errors lurking in it. The TH types don't have NFData instances, and even if they did, we have to serialize the value anyway, so we might as well serialize it to force it.
RunModFinalizers :: RemoteRef (IORef QState) -> [RemoteRef (Q ())] -> Message (QResult ())
Run the given mod finalizers.
GetClosure :: HValueRef -> Message (GenClosure HValueRef)
Remote interface to GHC.Internal.Heap.getClosureData. This is used by the GHCi debugger to inspect values in the heap for :print and type reconstruction.
WhereFrom :: HValueRef -> Message (Maybe InfoProv)
Remote interface to GHC.InfoProv.whereFrom. This is used by the GHCi debugger to inspect the provenance of thunks for :print.
Seq :: HValueRef -> Message (EvalStatus_ () ())
Evaluate something. This is used to support :force in GHCi.
ResumeSeq :: RemoteRef (ResumeContext ()) -> Message (EvalStatus_ () ())
Resume forcing a free variable in a breakpoint (#2950)
CustomMessage :: Word8 -> ByteString -> Message ByteString
User-defined request encoded as a tag/payload pair. This is left uninterpreted by GHC and is meant for GHC API applications to be able to supply their own interpreter which understands additional commands.

Instances1Show

Show (Message a)Defined in ghci-10.0.0.20260917 · GHCi.Message

module GHC.Runtime.Interpreter.Process