Moduleghci-9.10.3Haskell2010

GHCi.Message

Remote GHCi message types and serialization.

For details on Remote GHCi, see Note [Remote GHCi] in compilerGHCRuntime/Interpreter.hs.

19 types
10 values

Packageghci-9.10.3
Exports29
LanguageHaskell2010
LicenceBSD-3-Clause
SourceMessage.hs

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 :: String -> Message (Maybe (RemotePtr ()))
LookupSymbolInDLL :: RemotePtr LoadedDLL -> String -> Message (Maybe (RemotePtr ()))
LookupClosure :: String -> Message (Maybe HValueRef)
LoadDLL :: 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 :: FFIConv -> [FFIType] -> FFIType -> Message (RemotePtr C_ffi_cif)
Calls GHCi.FFI.prepareForeignCall
FreeFFI :: RemotePtr C_ffi_cif -> Message ()
Free data previously created by PrepFFI
MkConInfoTable :: Bool -> Int -> Int -> Int -> Int -> ByteString -> 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 :: String -> [(String, String)] -> 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.Exts.Heap.getClosureData. This is used by the GHCi debugger to inspect values in the heap for :print and type reconstruction.
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)
NewBreakModule :: String -> Message (RemotePtr BreakModule)
Allocate a string for a breakpoint module name. This uses an empty dummy type because ModuleName isn't available here.

Instances1Show

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

datadata Msg

Constructors

forall a. (Binary a, Show a) => Msg (Message a)

datadata THMessage a where

Messages sent back to GHC from GHCi.TH, to implement the methods of Quasi. For an overview of how TH works with Remote GHCi, see Note [Remote Template Haskell] in GHCi.TH.

Constructors

NewName :: String -> THMessage (THResult Name)
Report :: Bool -> String -> THMessage (THResult ())
LookupName :: Bool -> String -> THMessage (THResult (Maybe Name))
Reify :: Name -> THMessage (THResult Info)
ReifyFixity :: Name -> THMessage (THResult (Maybe Fixity))
ReifyType :: Name -> THMessage (THResult Type)
ReifyInstances :: Name -> [Type] -> THMessage (THResult [Dec])
ReifyRoles :: Name -> THMessage (THResult [Role])
ReifyAnnotations :: AnnLookup -> TypeRep -> THMessage (THResult [ByteString])
ReifyModule :: Module -> THMessage (THResult ModuleInfo)
ReifyConStrictness :: Name -> THMessage (THResult [DecidedStrictness])
GetPackageRoot :: THMessage (THResult FilePath)
AddDependentFile :: FilePath -> THMessage (THResult ())
AddTempFile :: String -> THMessage (THResult FilePath)
AddModFinalizer :: RemoteRef (Q ()) -> THMessage (THResult ())
AddCorePlugin :: String -> THMessage (THResult ())
AddTopDecls :: [Dec] -> THMessage (THResult ())
AddForeignFilePath :: ForeignSrcLang -> FilePath -> THMessage (THResult ())
IsExtEnabled :: Extension -> THMessage (THResult Bool)
ExtsEnabled :: THMessage (THResult [Extension])
PutDoc :: DocLoc -> String -> THMessage (THResult ())
GetDoc :: DocLoc -> THMessage (THResult (Maybe String))
StartRecover :: THMessage ()
EndRecover :: Bool -> THMessage ()
FailIfErrs :: THMessage (THResult ())
RunTHDone :: THMessage ()
Indicates that this RunTH is finished, and the next message will be the result of RunTH (a QResult).

Instances1Show

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

datadata THMsg

Constructors

forall a. (Binary a, Show a) => THMsg (THMessage a)

datadata QResult a

Template Haskell return values

Constructors

QDone a
RunTH finished successfully; return value follows
QException String
RunTH threw an exception
QFail String
RunTH called fail

Instances4Show, Generic, Binary, Rep

Show a => Show (QResult a)Defined in ghci-9.10.3 · GHCi.Message
Generic (QResult a)Defined in ghci-9.10.3 · GHCi.Message
Binary a => Binary (QResult a)Defined in ghci-9.10.3 · GHCi.Message
type Rep (QResult a) = D1 ('MetaData "QResult" "GHCi.Message" "ghci-9.10.3-e3f8" 'False) (C1 ('MetaCons "QDone" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: (C1 ('MetaCons "QException" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "QFail" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))Defined in ghci-9.10.3 · GHCi.Message

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-9.10.3 · GHCi.Message
Generic (EvalStatus_ a b)Defined in ghci-9.10.3 · GHCi.Message
Binary a => Binary (EvalStatus_ a b)Defined in ghci-9.10.3 · GHCi.Message
type Rep (EvalStatus_ a b) = D1 ('MetaData "EvalStatus_" "GHCi.Message" "ghci-9.10.3-e3f8" '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-9.10.3 · GHCi.Message

typetype EvalStatus a = EvalStatus_ a a

datadata EvalResult a

Instances4Show, Generic, Binary, Rep

Show a => Show (EvalResult a)Defined in ghci-9.10.3 · GHCi.Message
Generic (EvalResult a)Defined in ghci-9.10.3 · GHCi.Message
Binary a => Binary (EvalResult a)Defined in ghci-9.10.3 · GHCi.Message
type Rep (EvalResult a) = D1 ('MetaData "EvalResult" "GHCi.Message" "ghci-9.10.3-e3f8" '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-9.10.3 · GHCi.Message

datadata EvalOpts

Constructors

EvalOpts
- useSandboxThread :: Bool
- singleStep :: Bool
- breakOnException :: Bool
- breakOnError :: Bool

Instances4Show, Generic, Binary, Rep

Show EvalOptsDefined in ghci-9.10.3 · GHCi.Message
Generic EvalOptsDefined in ghci-9.10.3 · GHCi.Message
Binary EvalOptsDefined in ghci-9.10.3 · GHCi.Message
type Rep EvalOpts = D1 ('MetaData "EvalOpts" "GHCi.Message" "ghci-9.10.3-e3f8" 'False) (C1 ('MetaCons "EvalOpts" 'PrefixI 'True) ((S1 ('MetaSel ('Just "useSandboxThread") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "singleStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "breakOnException") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "breakOnError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))Defined in ghci-9.10.3 · 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-9.10.3 · GHCi.Message
Generic (EvalExpr a)Defined in ghci-9.10.3 · GHCi.Message
Binary a => Binary (EvalExpr a)Defined in ghci-9.10.3 · GHCi.Message
type Rep (EvalExpr a) = D1 ('MetaData "EvalExpr" "GHCi.Message" "ghci-9.10.3-e3f8" '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-9.10.3 · GHCi.Message

datadata EvalBreakpoint

Constructors

EvalBreakpoint
- eb_tick_mod :: String
  Breakpoint tick module
- eb_tick_index :: Int
  Breakpoint tick index
- eb_info_mod :: String
  Breakpoint info module
- eb_info_index :: Int
  Breakpoint info index

Instances4Show, Generic, Binary, Rep

Show EvalBreakpointDefined in ghci-9.10.3 · GHCi.Message
Generic EvalBreakpointDefined in ghci-9.10.3 · GHCi.Message
Binary EvalBreakpointDefined in ghci-9.10.3 · GHCi.Message
type Rep EvalBreakpoint = D1 ('MetaData "EvalBreakpoint" "GHCi.Message" "ghci-9.10.3-e3f8" 'False) (C1 ('MetaCons "EvalBreakpoint" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eb_tick_mod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "eb_tick_index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "eb_info_mod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "eb_info_index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))Defined in ghci-9.10.3 · GHCi.Message

datadata SerializableException

Constructors

EUserInterrupt
EExitCode ExitCode
EOtherException String

Instances4Show, Generic, Binary, Rep

Show SerializableExceptionDefined in ghci-9.10.3 · GHCi.Message
Generic SerializableExceptionDefined in ghci-9.10.3 · GHCi.Message
Binary SerializableExceptionDefined in ghci-9.10.3 · GHCi.Message
type Rep SerializableException = D1 ('MetaData "SerializableException" "GHCi.Message" "ghci-9.10.3-e3f8" 'False) (C1 ('MetaCons "EUserInterrupt" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "EExitCode" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExitCode)) :+: C1 ('MetaCons "EOtherException" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))Defined in ghci-9.10.3 · GHCi.Message

valuetoSerializableException :: SomeException -> SerializableException

valuefromSerializableException :: SerializableException -> SomeException

datadata THResult a

Constructors

THException String
THComplete a

Instances4Show, Generic, Binary, Rep

Show a => Show (THResult a)Defined in ghci-9.10.3 · GHCi.Message
Generic (THResult a)Defined in ghci-9.10.3 · GHCi.Message
Binary a => Binary (THResult a)Defined in ghci-9.10.3 · GHCi.Message
type Rep (THResult a) = D1 ('MetaData "THResult" "GHCi.Message" "ghci-9.10.3-e3f8" 'False) (C1 ('MetaCons "THException" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "THComplete" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))Defined in ghci-9.10.3 · GHCi.Message

datadata THResultType

THExp THPat THType THDec THAnnWrapper

Instances5Enum, Show, Generic, Binary, Rep

Enum THResultTypeDefined in ghci-9.10.3 · GHCi.Message
Show THResultTypeDefined in ghci-9.10.3 · GHCi.Message
Generic THResultTypeDefined in ghci-9.10.3 · GHCi.Message
Binary THResultTypeDefined in ghci-9.10.3 · GHCi.Message
type Rep THResultType = D1 ('MetaData "THResultType" "GHCi.Message" "ghci-9.10.3-e3f8" 'False) ((C1 ('MetaCons "THExp" 'PrefixI 'False) U1 :+: C1 ('MetaCons "THPat" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "THType" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "THDec" 'PrefixI 'False) U1 :+: C1 ('MetaCons "THAnnWrapper" 'PrefixI 'False) U1)))Defined in ghci-9.10.3 · GHCi.Message

datadata ResumeContext a

Constructors

ResumeContext
- resumeBreakMVar :: MVar ()
- resumeStatusMVar :: MVar (EvalStatus a)
- resumeThreadId :: ThreadId

datadata QState

The server-side Template Haskell state. This is created by the StartTH message. A new one is created per module that GHC typechecks.

Constructors

QState
- qsMap :: Map TypeRep Dynamic
  persistent data between splices in a module
- qsLocation :: Maybe Loc
  location for current splice, if any
- qsPipe :: Pipe
  pipe to communicate with GHC

Instances1Show

Show QStateDefined in ghci-9.10.3 · GHCi.Message

valuegetMessage :: Get Msg

valueputMessage :: Message a -> Put

valuegetTHMessage :: Get THMsg

valueputTHMessage :: THMessage a -> Put

datadata Pipe

Constructors

Pipe
- pipeRead :: Handle
- pipeWrite :: Handle
- pipeLeftovers :: IORef (Maybe ByteString)

valueremoteCall :: Binary a => Pipe -> Message a -> IO a

valueremoteTHCall :: Binary a => Pipe -> THMessage a -> IO a

valuereadPipe :: Pipe -> Get a -> IO a

valuewritePipe :: Pipe -> Put -> IO ()

datadata BreakModule

A dummy type that tags the pointer to a breakpoint's ModuleName, because that type isn't available here.

datadata LoadedDLL

A dummy type that tags pointers returned by LoadDLL.

Orphan instances

14 instances