Clash.Rewrite.Types

Type and instance definitions for Rewrite modules

Documentation

data RewriteStep

State used by the inspection mechanism for recording rewrite steps.

Constructors

RewriteStep

Fields

• t_ctx :: Context

  current context

• t_name :: String

  Name of the transformation

• t_bndrS :: String

  Name of the current binder

• t_before :: Term

  Term before apply

• t_after :: Term

  Term after apply

Instances

Show RewriteStep

Defined in Clash.Rewrite.Types

Methods

showsPrec :: Int -> RewriteStep -> ShowS

show :: RewriteStep -> String

showList :: [RewriteStep] -> ShowS

Generic RewriteStep

Defined in Clash.Rewrite.Types

Associated Types

type Rep RewriteStep :: Type -> Type

Methods

from :: RewriteStep -> Rep RewriteStep x

to :: Rep RewriteStep x -> RewriteStep

Hashable RewriteStep

Defined in Clash.Rewrite.Types

Methods

hashWithSalt :: Int -> RewriteStep -> Int

hash :: RewriteStep -> Int

Binary RewriteStep

Defined in Clash.Rewrite.Types

Methods

put :: RewriteStep -> Put

get :: Get RewriteStep

putList :: [RewriteStep] -> Put

NFData RewriteStep

Defined in Clash.Rewrite.Types

Methods

rnf :: RewriteStep -> ()

type Rep RewriteStep

Defined in Clash.Rewrite.Types

type Rep RewriteStep = D1 ('MetaData "RewriteStep" "Clash.Rewrite.Types" "clash-lib-1.4.4-inplace" 'False) (C1 ('MetaCons "RewriteStep" 'PrefixI 'True) ((S1 ('MetaSel ('Just "t_ctx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Context) :*: S1 ('MetaSel ('Just "t_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :*: (S1 ('MetaSel ('Just "t_bndrS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Just "t_before") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Term) :*: S1 ('MetaSel ('Just "t_after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Term)))))

data RewriteState extra

State of a rewriting session

Constructors

RewriteState

Fields

• _transformCounter :: !Int

  Number of applied transformations

• _bindings :: !BindingMap

  Global binders

• _uniqSupply :: !Supply

  Supply of unique numbers

• _curFun :: (Id, SrcSpan)

  Function which is currently normalized

• _nameCounter :: !Int

  Used for Fresh

• _globalHeap :: PrimHeap

  Used as a heap for compile-time evaluation of primitives that live in I/O

• _workFreeBinders :: VarEnv Bool

  Map telling whether a binder's definition is work-free

• _extra :: !extra

  Additional state

Instances

MonadState (RewriteState extra) (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

get :: RewriteMonad extra (RewriteState extra)

put :: RewriteState extra -> RewriteMonad extra ()

state :: (RewriteState extra -> (a, RewriteState extra)) -> RewriteMonad extra a

workFreeBinders :: forall extra. Lens' (RewriteState extra) (VarEnv Bool)

uniqSupply :: forall extra. Lens' (RewriteState extra) Supply

transformCounter :: forall extra. Lens' (RewriteState extra) Int

nameCounter :: forall extra. Lens' (RewriteState extra) Int

globalHeap :: forall extra. Lens' (RewriteState extra) PrimHeap

extra :: forall extra extra. Lens (RewriteState extra) (RewriteState extra) extra extra

curFun :: forall extra. Lens' (RewriteState extra) (Id, SrcSpan)

bindings :: forall extra. Lens' (RewriteState extra) BindingMap

data RewriteEnv

Read-only environment of a rewriting session

Constructors

RewriteEnv

Fields

• _dbgLevel :: DebugLevel

  Level at which we print debugging messages

• _dbgTransformations :: Set String

  See ClashOpts.dbgTransformations

• _dbgTransformationsFrom :: Int

  See ClashOpts.opt_dbgTransformationsFrom

• _dbgTransformationsLimit :: Int

  See ClashOpts.opt_dbgTransformationsLimit

• _dbgRewriteHistoryFile :: Maybe FilePath

  See ClashOpts.opt_dbgRewriteHistory

• _aggressiveXOpt :: Bool

  Transformations to print debugging info for

• _typeTranslator :: CustomReprs -> TyConMap -> Type -> State HWMap (Maybe (Either String FilteredHWType))

  Hardcode Type -> FilteredHWType translator

• _tcCache :: TyConMap

  TyCon cache

• _tupleTcCache :: IntMap TyConName

  Tuple TyCon cache

• _evaluator :: Evaluator

  Hardcoded evaluator for partial evaluation

• _topEntities :: VarSet

  Functions that are considered TopEntities

• _customReprs :: CustomReprs

  Custom bit representations

• _fuelLimit :: Word

  Maximum amount of fuel for the evaluator

Instances

MonadReader RewriteEnv (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

ask :: RewriteMonad extra RewriteEnv

local :: (RewriteEnv -> RewriteEnv) -> RewriteMonad extra a -> RewriteMonad extra a

reader :: (RewriteEnv -> a) -> RewriteMonad extra a

typeTranslator :: Lens' RewriteEnv (CustomReprs -> TyConMap -> Type -> State HWMap (Maybe (Either String FilteredHWType)))

tupleTcCache :: Lens' RewriteEnv (IntMap TyConName)

topEntities :: Lens' RewriteEnv VarSet

tcCache :: Lens' RewriteEnv TyConMap

fuelLimit :: Lens' RewriteEnv Word

evaluator :: Lens' RewriteEnv Evaluator

dbgTransformationsLimit :: Lens' RewriteEnv Int

dbgTransformationsFrom :: Lens' RewriteEnv Int

dbgTransformations :: Lens' RewriteEnv (Set String)

dbgRewriteHistoryFile :: Lens' RewriteEnv (Maybe FilePath)

dbgLevel :: Lens' RewriteEnv DebugLevel

customReprs :: Lens' RewriteEnv CustomReprs

aggressiveXOpt :: Lens' RewriteEnv Bool

newtype RewriteMonad extra a

Monad that keeps track how many transformations have been applied and can generate fresh variables and unique identifiers. In addition, it keeps track if a transformation/rewrite has been successfully applied.

Constructors

R

Fields

• unR :: RewriteEnv -> RewriteState extra -> Any -> (a, RewriteState extra, Any)

Instances

MonadReader RewriteEnv (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

ask :: RewriteMonad extra RewriteEnv

local :: (RewriteEnv -> RewriteEnv) -> RewriteMonad extra a -> RewriteMonad extra a

reader :: (RewriteEnv -> a) -> RewriteMonad extra a

MonadWriter Any (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

writer :: (a, Any) -> RewriteMonad extra a

tell :: Any -> RewriteMonad extra ()

listen :: RewriteMonad extra a -> RewriteMonad extra (a, Any)

pass :: RewriteMonad extra (a, Any -> Any) -> RewriteMonad extra a

Monad (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

(>>=) :: RewriteMonad extra a -> (a -> RewriteMonad extra b) -> RewriteMonad extra b

(>>) :: RewriteMonad extra a -> RewriteMonad extra b -> RewriteMonad extra b

return :: a -> RewriteMonad extra a

Functor (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

fmap :: (a -> b) -> RewriteMonad extra a -> RewriteMonad extra b

(<$) :: a -> RewriteMonad extra b -> RewriteMonad extra a

MonadFix (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

mfix :: (a -> RewriteMonad extra a) -> RewriteMonad extra a

MonadFail (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

fail :: String -> RewriteMonad extra a

Applicative (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

pure :: a -> RewriteMonad extra a

(<*>) :: RewriteMonad extra (a -> b) -> RewriteMonad extra a -> RewriteMonad extra b

liftA2 :: (a -> b -> c) -> RewriteMonad extra a -> RewriteMonad extra b -> RewriteMonad extra c

(*>) :: RewriteMonad extra a -> RewriteMonad extra b -> RewriteMonad extra b

(<*) :: RewriteMonad extra a -> RewriteMonad extra b -> RewriteMonad extra a

MonadUnique (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

getUniqueM :: RewriteMonad extra Int

MonadState (RewriteState extra) (RewriteMonad extra)

Defined in Clash.Rewrite.Types

Methods

get :: RewriteMonad extra (RewriteState extra)

put :: RewriteState extra -> RewriteMonad extra ()

state :: (RewriteState extra -> (a, RewriteState extra)) -> RewriteMonad extra a

runR :: RewriteMonad extra a -> RewriteEnv -> RewriteState extra -> (a, RewriteState extra, Any)

Run the computation in the RewriteMonad

censor :: (Any -> Any) -> RewriteMonad extra a -> RewriteMonad extra a

data TransformContext

Constructors

TransformContext

Fields

• tfInScope :: !InScopeSet
• tfContext :: Context

type Transform m = TransformContext -> Term -> m Term

Monadic action that transforms a term given a certain context

type Rewrite extra = Transform (RewriteMonad extra)

A Transform action in the context of the RewriteMonad