GHC.Debug.Client.Monad

Documentation

class (MonadFail m, Monad m) => DebugMonad m where

Associated Types

type DebugEnv m

Methods

request :: (Show resp, Typeable resp) => Request resp -> m resp

requestBlock :: (Show resp, Typeable resp) => BlockCacheRequest resp -> m resp

traceMsg :: String -> m ()

printRequestLog :: DebugEnv m -> IO ()

runDebug :: DebugEnv m -> m a -> IO a

runDebugTrace :: DebugEnv m -> m a -> IO (a, [String])

newEnv :: Tracer IO String -> Mode -> IO (DebugEnv m)

saveCache :: FilePath -> m ()

loadCache :: FilePath -> m ()

unsafeLiftIO :: IO a -> m a

Instances

DebugMonad DebugM

Defined in GHC.Debug.Client.Monad.Simple

Associated Types

type DebugEnv DebugM

Methods

request :: (Show resp, Typeable resp) => Request resp -> DebugM resp

requestBlock :: (Show resp, Typeable resp) => BlockCacheRequest resp -> DebugM resp

traceMsg :: String -> DebugM ()

printRequestLog :: DebugEnv DebugM -> IO ()

runDebug :: DebugEnv DebugM -> DebugM a -> IO a

runDebugTrace :: DebugEnv DebugM -> DebugM a -> IO (a, [String])

newEnv :: Tracer IO String -> Mode -> IO (DebugEnv DebugM)

saveCache :: FilePath -> DebugM ()

loadCache :: FilePath -> DebugM ()

unsafeLiftIO :: IO a -> DebugM a

run :: Debuggee -> DebugM a -> IO a

Run a DebugM a in the given environment.

type DebugM = DebugM

data Debuggee

traceWrite :: DebugMonad m => Show a => a -> m ()

runTrace :: Debuggee -> DebugM a -> IO a

Running/Connecting to a debuggee

withDebuggeeRun

Arguments

:: FilePath

path to executable to run as the debuggee

-> FilePath

filename of socket (e.g. "/tmp/ghc-debug")

-> (Debuggee -> IO a)

-> IO a

Bracketed version of debuggeeRun. Runs a debuggee, connects to it, runs the action, kills the process, then closes the debuggee.

withDebuggeeConnect

Arguments

:: FilePath

filename of socket (e.g. "/tmp/ghc-debug")

-> (Debuggee -> IO a)

-> IO a

Bracketed version of debuggeeConnect. Connects to a debuggee, runs the action, then closes the debuggee.

debuggeeRun

Arguments

:: FilePath

path to executable to run as the debuggee

-> FilePath

filename of socket (e.g. "/tmp/ghc-debug")

-> IO Debuggee

Run a debuggee and connect to it. Use debuggeeClose when you're done.

debuggeeConnect :: FilePath -> IO Debuggee

debuggeeConnectWithTracer

Arguments

:: Tracer IO String

-> FilePath

filename of socket (e.g. "/tmp/ghc-debug")

-> IO Debuggee

Connect to a debuggee on the given socket. Use debuggeeClose when you're done.

debuggeeClose :: Debuggee -> IO ()

Close the connection to the debuggee.

Snapshot run

snapshotInit :: FilePath -> IO Debuggee

Create a debuggee by loading a snapshot created by snapshot.

snapshotInitWithTracer :: Tracer IO String -> FilePath -> IO Debuggee

snapshotRun :: FilePath -> (Debuggee -> IO a) -> IO a

Start an analysis session using a snapshot. This will not connect to a debuggee. The snapshot is created by snapshot.

Logging

outputRequestLog :: Debuggee -> IO ()