GHCi.Message

Remote GHCi message types and serialization.

For details on Remote GHCi, see Note [Remote GHCi] in compilerghciGHCi.hs.

Documentation

data 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 ()))

LookupClosure :: String -> Message (Maybe HValueRef)

LoadDLL :: String -> Message (Maybe String)

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 :: [ByteString] -> Message [HValueRef]

Create a set of BCO objects, and return HValueRefs to them Note: Each ByteString contains a Binary-encoded [ResolvedBCO], not a ResolvedBCO. The list is to allow us to serialise the ResolvedBCOs in parallel. See createBCOs in compilerghciGHCi.hsc.

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 prepareForeignCall

FreeFFI :: RemotePtr C_ffi_cif -> Message ()

Free data previously created by PrepFFI

MkConInfoTable :: Int -> Int -> Int -> Int -> ByteString -> Message (RemotePtr StgInfoTable)

Create an info table for a constructor

EvalStmt :: EvalOpts -> EvalExpr HValueRef -> Message (EvalStatus [HValueRef])

Evaluate a statement

ResumeStmt :: EvalOpts -> RemoteRef (ResumeContext [HValueRef]) -> Message (EvalStatus [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

EnableBreakpoint :: RemoteRef BreakArray -> Int -> Bool -> Message ()

Enable a breakpoint

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 (EvalResult ())

Evaluate something. This is used to support :force in GHCi.

Instances

Show (Message a)

Defined in GHCi.Message

Methods

showsPrec :: Int -> Message a -> ShowS

show :: Message a -> String

showList :: [Message a] -> ShowS

data Msg

Constructors

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

data 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])

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])

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).

Instances

Show (THMessage a)

Defined in GHCi.Message

Methods

showsPrec :: Int -> THMessage a -> ShowS

show :: THMessage a -> String

showList :: [THMessage a] -> ShowS

data THMsg

Constructors

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

data 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

Instances

Show a => Show (QResult a)

Defined in GHCi.Message

Methods

showsPrec :: Int -> QResult a -> ShowS

show :: QResult a -> String

showList :: [QResult a] -> ShowS

Generic (QResult a)

Defined in GHCi.Message

Associated Types

type Rep (QResult a) :: Type -> Type

Methods

from :: QResult a -> Rep (QResult a) x

to :: Rep (QResult a) x -> QResult a

Binary a => Binary (QResult a)

Defined in GHCi.Message

Methods

put :: QResult a -> Put

get :: Get (QResult a)

putList :: [QResult a] -> Put

type Rep (QResult a)

Defined in GHCi.Message

type Rep (QResult a) = D1 (MetaData "QResult" "GHCi.Message" "ghc-lib-parser-0.20190903-34A35ewz7tcAVXzlweikF7" False) (C1 (MetaCons "QDone" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :+: (C1 (MetaCons "QException" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "QFail" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

data EvalStatus_ a b

Constructors

EvalComplete Word64 (EvalResult a)

EvalBreak Bool HValueRef Int Int (RemoteRef (ResumeContext b)) (RemotePtr CostCentreStack)

Instances

Show a => Show (EvalStatus_ a b)

Defined in GHCi.Message

Methods

showsPrec :: Int -> EvalStatus_ a b -> ShowS

show :: EvalStatus_ a b -> String

showList :: [EvalStatus_ a b] -> ShowS

Generic (EvalStatus_ a b)

Defined in GHCi.Message

Associated Types

type Rep (EvalStatus_ a b) :: Type -> Type

Methods

from :: EvalStatus_ a b -> Rep (EvalStatus_ a b) x

to :: Rep (EvalStatus_ a b) x -> EvalStatus_ a b

Binary a => Binary (EvalStatus_ a b)

Defined in GHCi.Message

Methods

put :: EvalStatus_ a b -> Put

get :: Get (EvalStatus_ a b)

putList :: [EvalStatus_ a b] -> Put

type Rep (EvalStatus_ a b)

Defined in GHCi.Message

type Rep (EvalStatus_ a b) = D1 (MetaData "EvalStatus_" "GHCi.Message" "ghc-lib-parser-0.20190903-34A35ewz7tcAVXzlweikF7" False) (C1 (MetaCons "EvalComplete" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (EvalResult a))) :+: C1 (MetaCons "EvalBreak" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HValueRef) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RemoteRef (ResumeContext b))) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RemotePtr CostCentreStack))))))

type EvalStatus a = EvalStatus_ a a

data EvalResult a

Constructors

EvalException SerializableException

EvalSuccess a

Instances

Show a => Show (EvalResult a)

Defined in GHCi.Message

Methods

showsPrec :: Int -> EvalResult a -> ShowS

show :: EvalResult a -> String

showList :: [EvalResult a] -> ShowS

Generic (EvalResult a)

Defined in GHCi.Message

Associated Types

type Rep (EvalResult a) :: Type -> Type

Methods

from :: EvalResult a -> Rep (EvalResult a) x

to :: Rep (EvalResult a) x -> EvalResult a

Binary a => Binary (EvalResult a)

Defined in GHCi.Message

Methods

put :: EvalResult a -> Put

get :: Get (EvalResult a)

putList :: [EvalResult a] -> Put

type Rep (EvalResult a)

Defined in GHCi.Message

type Rep (EvalResult a) = D1 (MetaData "EvalResult" "GHCi.Message" "ghc-lib-parser-0.20190903-34A35ewz7tcAVXzlweikF7" False) (C1 (MetaCons "EvalException" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SerializableException)) :+: C1 (MetaCons "EvalSuccess" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))

data EvalOpts

Constructors

EvalOpts

Fields

• useSandboxThread :: Bool
• singleStep :: Bool
• breakOnException :: Bool
• breakOnError :: Bool

Instances

Show EvalOpts

Defined in GHCi.Message

Methods

showsPrec :: Int -> EvalOpts -> ShowS

show :: EvalOpts -> String

showList :: [EvalOpts] -> ShowS

Generic EvalOpts

Defined in GHCi.Message

Associated Types

type Rep EvalOpts :: Type -> Type

Methods

from :: EvalOpts -> Rep EvalOpts x

to :: Rep EvalOpts x -> EvalOpts

Binary EvalOpts

Defined in GHCi.Message

Methods

put :: EvalOpts -> Put

get :: Get EvalOpts

putList :: [EvalOpts] -> Put

type Rep EvalOpts

Defined in GHCi.Message

type Rep EvalOpts = D1 (MetaData "EvalOpts" "GHCi.Message" "ghc-lib-parser-0.20190903-34A35ewz7tcAVXzlweikF7" 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))))

data 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)

Instances

Show a => Show (EvalExpr a)

Defined in GHCi.Message

Methods

showsPrec :: Int -> EvalExpr a -> ShowS

show :: EvalExpr a -> String

showList :: [EvalExpr a] -> ShowS

Generic (EvalExpr a)

Defined in GHCi.Message

Associated Types

type Rep (EvalExpr a) :: Type -> Type

Methods

from :: EvalExpr a -> Rep (EvalExpr a) x

to :: Rep (EvalExpr a) x -> EvalExpr a

Binary a => Binary (EvalExpr a)

Defined in GHCi.Message

Methods

put :: EvalExpr a -> Put

get :: Get (EvalExpr a)

putList :: [EvalExpr a] -> Put

type Rep (EvalExpr a)

Defined in GHCi.Message

type Rep (EvalExpr a) = D1 (MetaData "EvalExpr" "GHCi.Message" "ghc-lib-parser-0.20190903-34A35ewz7tcAVXzlweikF7" False) (C1 (MetaCons "EvalThis" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :+: C1 (MetaCons "EvalApp" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (EvalExpr a)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (EvalExpr a))))

data SerializableException

Constructors

EUserInterrupt

EExitCode ExitCode

EOtherException String

Instances

Show SerializableException

Defined in GHCi.Message

Methods

showsPrec :: Int -> SerializableException -> ShowS

show :: SerializableException -> String

showList :: [SerializableException] -> ShowS

Generic SerializableException

Defined in GHCi.Message

Associated Types

type Rep SerializableException :: Type -> Type

Methods

from :: SerializableException -> Rep SerializableException x

to :: Rep SerializableException x -> SerializableException

Binary SerializableException

Defined in GHCi.Message

Methods

put :: SerializableException -> Put

get :: Get SerializableException

putList :: [SerializableException] -> Put

type Rep SerializableException

Defined in GHCi.Message

type Rep SerializableException = D1 (MetaData "SerializableException" "GHCi.Message" "ghc-lib-parser-0.20190903-34A35ewz7tcAVXzlweikF7" False) (C1 (MetaCons "EUserInterrupt" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "EExitCode" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExitCode)) :+: C1 (MetaCons "EOtherException" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

toSerializableException :: SomeException -> SerializableException

fromSerializableException :: SerializableException -> SomeException

data THResult a

Constructors

THException String

THComplete a

Instances

Show a => Show (THResult a)

Defined in GHCi.Message

Methods

showsPrec :: Int -> THResult a -> ShowS

show :: THResult a -> String

showList :: [THResult a] -> ShowS

Generic (THResult a)

Defined in GHCi.Message

Associated Types

type Rep (THResult a) :: Type -> Type

Methods

from :: THResult a -> Rep (THResult a) x

to :: Rep (THResult a) x -> THResult a

Binary a => Binary (THResult a)

Defined in GHCi.Message

Methods

put :: THResult a -> Put

get :: Get (THResult a)

putList :: [THResult a] -> Put

type Rep (THResult a)

Defined in GHCi.Message

type Rep (THResult a) = D1 (MetaData "THResult" "GHCi.Message" "ghc-lib-parser-0.20190903-34A35ewz7tcAVXzlweikF7" False) (C1 (MetaCons "THException" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "THComplete" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))

data THResultType

Constructors

THExp

THPat

THType

THDec

THAnnWrapper

Instances

Enum THResultType

Defined in GHCi.Message

Methods

succ :: THResultType -> THResultType

pred :: THResultType -> THResultType

toEnum :: Int -> THResultType

fromEnum :: THResultType -> Int

enumFrom :: THResultType -> [THResultType]

enumFromThen :: THResultType -> THResultType -> [THResultType]

enumFromTo :: THResultType -> THResultType -> [THResultType]

enumFromThenTo :: THResultType -> THResultType -> THResultType -> [THResultType]

Show THResultType

Defined in GHCi.Message

Methods

showsPrec :: Int -> THResultType -> ShowS

show :: THResultType -> String

showList :: [THResultType] -> ShowS

Generic THResultType

Defined in GHCi.Message

Associated Types

type Rep THResultType :: Type -> Type

Methods

from :: THResultType -> Rep THResultType x

to :: Rep THResultType x -> THResultType

Binary THResultType

Defined in GHCi.Message

Methods

put :: THResultType -> Put

get :: Get THResultType

putList :: [THResultType] -> Put

type Rep THResultType

Defined in GHCi.Message

type Rep THResultType = D1 (MetaData "THResultType" "GHCi.Message" "ghc-lib-parser-0.20190903-34A35ewz7tcAVXzlweikF7" False) ((C1 (MetaCons "THExp" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "THPat" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "THType" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "THDec" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "THAnnWrapper" PrefixI False) (U1 :: Type -> Type))))

data ResumeContext a

Constructors

ResumeContext

Fields

• resumeBreakMVar :: MVar ()
• resumeStatusMVar :: MVar (EvalStatus a)
• resumeThreadId :: ThreadId

data 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

Fields

• 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

Instances

Show QState

Defined in GHCi.Message

Methods

showsPrec :: Int -> QState -> ShowS

show :: QState -> String

showList :: [QState] -> ShowS

getMessage :: Get Msg

putMessage :: Message a -> Put

getTHMessage :: Get THMsg

putTHMessage :: THMessage a -> Put

data Pipe

Constructors

Pipe

Fields

• pipeRead :: Handle
• pipeWrite :: Handle
• pipeLeftovers :: IORef (Maybe ByteString)

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

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

readPipe :: Pipe -> Get a -> IO a

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

Orphan instances

Binary ExitCode

Methods

put :: ExitCode -> Put

get :: Get ExitCode

putList :: [ExitCode] -> Put

Binary ClosureType

Methods

put :: ClosureType -> Put

get :: Get ClosureType

putList :: [ClosureType] -> Put

Binary StgInfoTable

Methods

put :: StgInfoTable -> Put

get :: Get StgInfoTable

putList :: [StgInfoTable] -> Put

Binary PrimType

Methods

put :: PrimType -> Put

get :: Get PrimType

putList :: [PrimType] -> Put

Binary (Ptr a)

Methods

put :: Ptr a -> Put

get :: Get (Ptr a)

putList :: [Ptr a] -> Put

Binary (FunPtr a)

Methods

put :: FunPtr a -> Put

get :: Get (FunPtr a)

putList :: [FunPtr a] -> Put

Binary a => Binary (GenClosure a)

Methods

put :: GenClosure a -> Put

get :: Get (GenClosure a)

putList :: [GenClosure a] -> Put