cryptol-2.10.0: Cryptol: The Language of Cryptography
Copyright(c) 2013-2016 Galois Inc.
LicenseBSD3
Maintainercryptol@galois.com
Stabilityprovisional
Portabilityportable
Safe HaskellSafe
LanguageHaskell2010

Cryptol.Backend.Monad

Description

 
Synopsis

Evaluation monad

data Eval a Source #

The monad for Cryptol evaluation. A computation is either "ready", which means it represents only trivial computation, or is an "eval" action which must be computed to get the answer, or it is a "thunk", which represents a delayed, shared computation.

Constructors

Ready !a 
Eval !(IO a) 
Thunk !(TVar (ThunkState a)) 

Instances

Instances details
Monad Eval Source # 
Instance details

Defined in Cryptol.Backend.Monad

Methods

(>>=) :: Eval a -> (a -> Eval b) -> Eval b #

(>>) :: Eval a -> Eval b -> Eval b #

return :: a -> Eval a #

Functor Eval Source # 
Instance details

Defined in Cryptol.Backend.Monad

Methods

fmap :: (a -> b) -> Eval a -> Eval b #

(<$) :: a -> Eval b -> Eval a #

MonadFix Eval Source # 
Instance details

Defined in Cryptol.Backend.Monad

Methods

mfix :: (a -> Eval a) -> Eval a #

MonadFail Eval Source # 
Instance details

Defined in Cryptol.Backend.Monad

Methods

fail :: String -> Eval a #

Applicative Eval Source # 
Instance details

Defined in Cryptol.Backend.Monad

Methods

pure :: a -> Eval a #

(<*>) :: Eval (a -> b) -> Eval a -> Eval b #

liftA2 :: (a -> b -> c) -> Eval a -> Eval b -> Eval c #

(*>) :: Eval a -> Eval b -> Eval b #

(<*) :: Eval a -> Eval b -> Eval a #

MonadIO Eval Source # 
Instance details

Defined in Cryptol.Backend.Monad

Methods

liftIO :: IO a -> Eval a #

runEval :: Eval a -> IO a Source #

Execute the given evaluation action.

data EvalOpts Source #

Some options for evalutaion

Constructors

EvalOpts 

Fields

data PPOpts Source #

How to pretty print things when evaluating

data PPFloatFormat Source #

Constructors

FloatFixed Int PPFloatExp

Use this many significant digis

FloatFrac Int

Show this many digits after floating point

FloatFree PPFloatExp

Use the correct number of digits

data PPFloatExp Source #

Constructors

ForceExponent

Always show an exponent

AutoExponent

Only show exponent when needed

io :: IO a -> Eval a Source #

Lift an IO computation into the Eval monad.

delayFill Source #

Arguments

:: Eval a

Computation to delay

-> Eval a

Backup computation to run if a tight loop is detected

-> Eval (Eval a) 

Delay the given evaluation computation, returning a thunk which will run the computation when forced. Run the retry computation instead if the resulting thunk is forced during its own evaluation.

ready :: a -> Eval a Source #

A computation that returns an already-evaluated value.

blackhole Source #

Arguments

:: String

A name to associate with this thunk.

-> Eval (Eval a, Eval a -> Eval ()) 

Produce a thunk value which can be filled with its associated computation after the fact. A preallocated thunk is returned, along with an operation to fill the thunk with the associated computation. This is used to implement recursive declaration groups.

evalSpark :: Eval a -> Eval (Eval a) Source #

Begin executing the given operation in a separate thread, returning a thunk which will await the completion of the computation when forced.

maybeReady :: Eval a -> Eval (Maybe a) Source #

Test if a value is "ready", which means that it requires no computation to return.

Error reporting

data Unsupported Source #

Constructors

UnsupportedSymbolicOp String

Operation cannot be supported in the symbolic simulator

data EvalError Source #

Data type describing errors that can occur during evaluation.

Constructors

InvalidIndex (Maybe Integer)

Out-of-bounds index

TypeCannotBeDemoted Type

Non-numeric type passed to number function

DivideByZero

Division or modulus by 0

NegativeExponent

Exponentiation by negative integer

LogNegative

Logarithm of a negative integer

WordTooWide Integer

Bitvector too large

UserError String

Call to the Cryptol error primitive

LoopError String

Detectable nontermination

NoPrim Name

Primitive with no implementation

BadRoundingMode Integer

Invalid rounding mode

BadValue String

Value outside the domain of a partial function.

Instances

Instances details
Show EvalError Source # 
Instance details

Defined in Cryptol.Backend.Monad

Exception EvalError Source # 
Instance details

Defined in Cryptol.Backend.Monad

PP EvalError Source # 
Instance details

Defined in Cryptol.Backend.Monad

Methods

ppPrec :: Int -> EvalError -> Doc Source #

evalPanic :: HasCallStack => String -> [String] -> a Source #

Panic from an Eval context.

wordTooWide :: Integer -> a Source #

For when we know that a word is too wide and will exceed gmp's limits (though words approaching this size will probably cause the system to crash anyway due to lack of memory).

typeCannotBeDemoted :: Type -> a Source #

For things like `(inf) or `(0-1).