Cryptol.Eval

Documentation

moduleEnv

Arguments

:: EvalPrims sym

=> sym

-> Module

Module containing declarations to evaluate

-> GenEvalEnv sym

Environment to extend

-> SEval sym (GenEvalEnv sym)

Extend the given evaluation environment with all the declarations contained in the given module.

runEval :: EvalOpts -> Eval a -> IO a

Execute the given evaluation action.

data EvalOpts

Some options for evalutaion

Constructors

EvalOpts

Fields

• evalLogger :: Logger

  Where to print stuff (e.g., for trace)

• evalPPOpts :: PPOpts

  How to pretty print things.

data PPOpts

How to pretty print things when evaluating

Constructors

PPOpts

Fields

• useAscii :: Bool
• useBase :: Int
• useInfLength :: Int
• useFPBase :: Int
• useFPFormat :: PPFloatFormat

defaultPPOpts :: PPOpts

data Eval a

The monad for Cryptol evaluation.

Instances

Monad Eval

Defined in Cryptol.Eval.Monad

Methods

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

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

return :: a -> Eval a

fail :: String -> Eval a

Functor Eval

Defined in Cryptol.Eval.Monad

Methods

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

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

MonadFix Eval

Defined in Cryptol.Eval.Monad

Methods

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

MonadFail Eval

Defined in Cryptol.Eval.Monad

Methods

fail :: String -> Eval a

Applicative Eval

Defined in Cryptol.Eval.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

Defined in Cryptol.Eval.Monad

Methods

liftIO :: IO a -> Eval a

NFData a => NFData (Eval a)

Defined in Cryptol.Eval.Monad

Methods

rnf :: Eval a -> ()

type EvalEnv = GenEvalEnv Concrete

emptyEnv :: GenEvalEnv sym

Evaluation environment with no bindings

evalExpr

Arguments

:: EvalPrims sym

=> sym

-> GenEvalEnv sym

Evaluation environment

-> Expr

Expression to evaluate

-> SEval sym (GenValue sym)

Evaluate a Cryptol expression to a value. This evaluator is parameterized by the EvalPrims class, which defines the behavior of bits and words, in addition to providing implementations for all the primitives.

evalDecls

Arguments

:: EvalPrims sym

=> sym

-> [DeclGroup]

Declaration groups to evaluate

-> GenEvalEnv sym

Environment to extend

-> SEval sym (GenEvalEnv sym)

Extend the given evaluation environment with the result of evaluating the given collection of declaration groups.

evalSel :: EvalPrims sym => sym -> GenValue sym -> Selector -> SEval sym (GenValue sym)

Apply the the given "selector" form to the given value. This function pushes tuple and record selections pointwise down into other value constructs (e.g., streams and functions).

evalSetSel :: forall sym. EvalPrims sym => sym -> GenValue sym -> Selector -> SEval sym (GenValue sym) -> SEval sym (GenValue sym)

data EvalError

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

Show EvalError

Defined in Cryptol.Eval.Monad

Methods

showsPrec :: Int -> EvalError -> ShowS

show :: EvalError -> String

showList :: [EvalError] -> ShowS

Exception EvalError

Defined in Cryptol.Eval.Monad

Methods

toException :: EvalError -> SomeException

fromException :: SomeException -> Maybe EvalError

displayException :: EvalError -> String

PP EvalError

Defined in Cryptol.Eval.Monad

Methods

ppPrec :: Int -> EvalError -> Doc

data Unsupported

Constructors

UnsupportedSymbolicOp String

Operation cannot be supported in the symbolic simulator

Instances

Show Unsupported

Defined in Cryptol.Eval.Monad

Methods

showsPrec :: Int -> Unsupported -> ShowS

show :: Unsupported -> String

showList :: [Unsupported] -> ShowS

Exception Unsupported

Defined in Cryptol.Eval.Monad

Methods

toException :: Unsupported -> SomeException

fromException :: SomeException -> Maybe Unsupported

displayException :: Unsupported -> String

PP Unsupported

Defined in Cryptol.Eval.Monad

Methods

ppPrec :: Int -> Unsupported -> Doc

forceValue :: Backend sym => GenValue sym -> SEval sym ()

Force the evaluation of a value