ghc-experimental-9.1500.0: Experimental features of GHC's standard library and unstable GHC internals.

Safe Haskell	None
Language	Haskell2010

GHC.Exception.Backtrace.Experimental

Contents

Backtrace mechanisms
Collecting backtraces
Collecting exception annotations on throwing Exceptions

Synopsis

data BacktraceMechanism
getBacktraceMechanismState :: BacktraceMechanism -> IO Bool
setBacktraceMechanismState :: BacktraceMechanism -> Bool -> IO ()
data Backtraces = Backtraces {
- btrCostCentre :: Maybe (Ptr CostCentreStack)
- btrHasCallStack :: Maybe CallStack
- btrExecutionStack :: Maybe StackTrace
- btrIpe :: Maybe StackSnapshot
}
displayBacktraces :: Backtraces -> String
collectBacktraces :: (?callStack :: CallStack) => IO Backtraces
data CollectExceptionAnnotationMechanism
getCollectExceptionAnnotationMechanism :: IO CollectExceptionAnnotationMechanism
setCollectExceptionAnnotation :: ExceptionAnnotation a => (HasCallStack => IO a) -> IO ()
collectExceptionAnnotation :: HasCallStack => IO SomeExceptionAnnotation

Backtrace mechanisms

data BacktraceMechanism Source #

How to collect a backtrace when an exception is thrown.

Constructors

CostCentreBacktrace	collect cost-centre stack backtraces (only available when built with profiling)
HasCallStackBacktrace	collect `HasCallStack` backtraces
ExecutionBacktrace	collect backtraces via native execution stack unwinding (e.g. using DWARF debug information)
IPEBacktrace	collect backtraces from Info Table Provenance Entries

getBacktraceMechanismState :: BacktraceMechanism -> IO Bool Source #

Will the given BacktraceMechanism be used when collecting backtraces?

setBacktraceMechanismState :: BacktraceMechanism -> Bool -> IO () Source #

Set whether the given BacktraceMechanism will be used when collecting backtraces?

Collecting backtraces

data Backtraces Source #

A collection of backtraces.

Constructors

Backtraces
Fields btrCostCentre :: Maybe (Ptr CostCentreStack) btrHasCallStack :: Maybe CallStack btrExecutionStack :: Maybe StackTrace btrIpe :: Maybe StackSnapshot

Instances

Instances details

ExceptionAnnotation Backtraces Source #
Instance details Defined in GHC.Internal.Exception.Backtrace Methods displayExceptionAnnotation :: Backtraces -> String Source #

displayBacktraces :: Backtraces -> String Source #

Render a set of backtraces to a human-readable string.

collectBacktraces :: (?callStack :: CallStack) => IO Backtraces Source #

Collect a set of Backtraces.

Collecting exception annotations on throwing `Exception`s

data CollectExceptionAnnotationMechanism Source #

How to collect ExceptionAnnotations on throwing Exceptions.

getCollectExceptionAnnotationMechanism :: IO CollectExceptionAnnotationMechanism Source #

Returns the current callback for collecting ExceptionAnnotations on throwing Exceptions.

setCollectExceptionAnnotation :: ExceptionAnnotation a => (HasCallStack => IO a) -> IO () Source #

Set the callback for collecting an ExceptionAnnotation.

collectExceptionAnnotation :: HasCallStack => IO SomeExceptionAnnotation Source #

Collect SomeExceptionAnnotation based on the configuration of the global CollectExceptionAnnotationMechanism.