Safe Haskell	None
Language	Haskell2010

GHC.Internal.Exception.Backtrace

Synopsis

data BacktraceMechanism
data EnabledBacktraceMechanisms = EnabledBacktraceMechanisms {
- costCentreBacktraceEnabled :: !Bool
- hasCallStackBacktraceEnabled :: !Bool
- executionBacktraceEnabled :: !Bool
- ipeBacktraceEnabled :: !Bool
}
defaultEnabledBacktraceMechanisms :: EnabledBacktraceMechanisms
backtraceMechanismEnabled :: BacktraceMechanism -> EnabledBacktraceMechanisms -> Bool
setBacktraceMechanismEnabled :: BacktraceMechanism -> Bool -> EnabledBacktraceMechanisms -> EnabledBacktraceMechanisms
enabledBacktraceMechanismsRef :: IORef EnabledBacktraceMechanisms
getEnabledBacktraceMechanisms :: IO EnabledBacktraceMechanisms
getBacktraceMechanismState :: BacktraceMechanism -> IO Bool
setBacktraceMechanismState :: BacktraceMechanism -> Bool -> IO ()
data CollectExceptionAnnotationMechanism = CollectExceptionAnnotationMechanism {
- ceaCollectExceptionAnnotationMechanism :: HasCallStack => IO SomeExceptionAnnotation
}
defaultCollectExceptionAnnotationMechanism :: CollectExceptionAnnotationMechanism
collectExceptionAnnotationMechanismRef :: IORef CollectExceptionAnnotationMechanism
getCollectExceptionAnnotationMechanism :: IO CollectExceptionAnnotationMechanism
setCollectExceptionAnnotation :: ExceptionAnnotation a => (HasCallStack => IO a) -> IO ()
data Backtraces = Backtraces {
- btrCostCentre :: Maybe (Ptr CostCentreStack)
- btrHasCallStack :: Maybe CallStack
- btrExecutionStack :: Maybe StackTrace
- btrIpe :: Maybe StackSnapshot
}
displayBacktraces :: Backtraces -> String
collectExceptionAnnotation :: HasCallStack => IO SomeExceptionAnnotation
collectBacktraces :: (?callStack :: CallStack) => IO Backtraces
collectBacktraces' :: (?callStack :: CallStack) => EnabledBacktraceMechanisms -> IO Backtraces

Documentation

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

data EnabledBacktraceMechanisms Source #

Constructors

EnabledBacktraceMechanisms
Fields costCentreBacktraceEnabled :: !Bool hasCallStackBacktraceEnabled :: !Bool executionBacktraceEnabled :: !Bool ipeBacktraceEnabled :: !Bool

defaultEnabledBacktraceMechanisms :: EnabledBacktraceMechanisms Source #

backtraceMechanismEnabled :: BacktraceMechanism -> EnabledBacktraceMechanisms -> Bool Source #

setBacktraceMechanismEnabled :: BacktraceMechanism -> Bool -> EnabledBacktraceMechanisms -> EnabledBacktraceMechanisms Source #

enabledBacktraceMechanismsRef :: IORef EnabledBacktraceMechanisms Source #

getEnabledBacktraceMechanisms :: IO EnabledBacktraceMechanisms Source #

Returns the currently enabled BacktraceMechanisms.

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?

data CollectExceptionAnnotationMechanism Source #

How to collect ExceptionAnnotations on throwing Exceptions.

Constructors

CollectExceptionAnnotationMechanism
Fields ceaCollectExceptionAnnotationMechanism :: HasCallStack => IO SomeExceptionAnnotation

defaultCollectExceptionAnnotationMechanism :: CollectExceptionAnnotationMechanism Source #

collectExceptionAnnotationMechanismRef :: IORef CollectExceptionAnnotationMechanism Source #

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.

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.

collectExceptionAnnotation :: HasCallStack => IO SomeExceptionAnnotation Source #

Collect SomeExceptionAnnotation based on the configuration of the global CollectExceptionAnnotationMechanism.

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

Collect a set of Backtraces.

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