Copyright	(c) Galois Inc 2014
License	BSD3
Maintainer	Joe Hendrix <jhendrix@galois.com>
Stability	provisional
Safe Haskell	None
Language	Haskell2010

Lang.Crucible.Simulator.SimError

Description

Synopsis

data SimErrorReason
- = GenericSimError !String
- | Unsupported !CallStack !String
- | ReadBeforeWriteSimError !String
- | AssertFailureSimError !String !String
- | ResourceExhausted String
data SimError where
- SimErrorWithContext !ProgramLoc !SimErrorReason !(Maybe ProgramStack)
- pattern SimError :: ProgramLoc -> SimErrorReason -> SimError
data ProgramStack = ProgramStack {
- psFrameOmitCount :: Int
- psFrames :: [ProgramLoc]
}
mkSimError :: ProgramLoc -> SimErrorReason -> Maybe ProgramStack -> SimError
simErrorReason :: SimError -> SimErrorReason
simErrorLoc :: SimError -> ProgramLoc
simErrorContext :: SimError -> Maybe ProgramStack
simErrorReasonMsg :: SimErrorReason -> String
simErrorDetailsMsg :: SimErrorReason -> String
ppSimError :: SimError -> Doc ann
ppProgramStack :: ProgramStack -> Doc ann

Documentation

data SimErrorReason Source #

Class for exceptions generated by simulator.

Constructors

GenericSimError !String
Unsupported !CallStack !String	We can't do that (yet?). The call stack identifies where in the Haskell code the error occured.
ReadBeforeWriteSimError !String
AssertFailureSimError !String !String	An assertion failed. The first parameter is a short description. The second is a more detailed explanation.
ResourceExhausted String	A loop iteration count, or similar resource limit, was exceeded.

Instances

Instances details

IsString SimErrorReason Source #
Instance details Defined in Lang.Crucible.Simulator.SimError Methods fromString :: String -> SimErrorReason #
Show SimErrorReason Source #
Instance details Defined in Lang.Crucible.Simulator.SimError Methods showsPrec :: Int -> SimErrorReason -> ShowS # show :: SimErrorReason -> String # showList :: [SimErrorReason] -> ShowS #

data SimError Source #

Constructors

SimErrorWithContext !ProgramLoc !SimErrorReason !(Maybe ProgramStack)

Bundled Patterns

pattern SimError :: ProgramLoc -> SimErrorReason -> SimError

This pattern synonym constructs SimErrors without a program stack context when used as an expression and ignores the program stack when used as a pattern. It exists because SimError did not used to have a ProgramStack, and there are many usages in the code of the previous constructor which is approximated by this pattern.

Using SimErrorWithContext should be preferred.

Instances

Instances details

Exception SimError Source #
Instance details Defined in Lang.Crucible.Simulator.SimError Methods toException :: SimError -> SomeException # fromException :: SomeException -> Maybe SimError # displayException :: SimError -> String #
Show SimError Source #
Instance details Defined in Lang.Crucible.Simulator.SimError Methods showsPrec :: Int -> SimError -> ShowS # show :: SimError -> String # showList :: [SimError] -> ShowS #

data ProgramStack Source #

Representation of the program stack for providing dynamic context for SimErrors

Constructors

ProgramStack
Fields psFrameOmitCount :: Int Number of calling frames omitted in the stack trace psFrames :: [ProgramLoc] The visible part of the stack strace

mkSimError :: ProgramLoc -> SimErrorReason -> Maybe ProgramStack -> SimError Source #

simErrorReason :: SimError -> SimErrorReason Source #

simErrorLoc :: SimError -> ProgramLoc Source #

simErrorContext :: SimError -> Maybe ProgramStack Source #

simErrorReasonMsg :: SimErrorReason -> String Source #

simErrorDetailsMsg :: SimErrorReason -> String Source #

ppSimError :: SimError -> Doc ann Source #

ppProgramStack :: ProgramStack -> Doc ann Source #