Clash.Normalize.Util

Utility functions used by the normalisation transformations

Documentation

isConstantArg

Arguments

:: Text

Primitive name

-> Int

Argument number

-> RewriteMonad NormalizeState Bool

Yields DontCare for if given primitive name is not found, if the argument does not exist, or if the argument was not mentioned by the blackbox.

Determine if argument should reduce to a constant given a primitive and an argument number. Caches results.

shouldReduce

Arguments

:: Context

..in the current transformcontext

-> RewriteMonad NormalizeState Bool

Given a list of transformation contexts, determine if any of the contexts indicates that the current arg is to be reduced to a constant / literal.

alreadyInlined

Arguments

:: Id

Function we want to inline

-> Id

Function in which we want to perform the inlining

-> NormalizeMonad (Maybe Int)

Determine if a function is already inlined in the context of the NetlistMonad

addNewInline

Arguments

:: Id

Function we want to inline

-> Id

Function in which we want to perform the inlining

-> NormalizeMonad ()

specializeNorm :: NormRewrite

Specialize under the Normalization Monad

isRecursiveBndr :: Id -> NormalizeSession Bool

Assert whether a name is a reference to a recursive binder.

isClosed :: TyConMap -> Term -> Bool

Determine if a term is closed

callGraph :: BindingMap -> Id -> CallGraph

Create a call graph for a set of global binders, given a root

classifyFunction :: Term -> TermClassification

Give a "performance/size" classification of a function in normal form.

isCheapFunction :: Term -> Bool

Determine whether a function adds a lot of hardware or not.

It is considered expensive when it has 2 or more of the following components:

• functions
• primitives
• selections (multiplexers)

isNonRecursiveGlobalVar :: Term -> NormalizeSession Bool

Test whether a given term represents a non-recursive global variable

canConstantSpec :: Term -> RewriteMonad NormalizeState Bool

Test if we can constant specialize current term in current function. The rules are, we can constant fold if:

• Term does not carry a clock or reset
• Term is constant is isConstant sense, and additionally when term is a global, non-recursive variable

normalizeTopLvlBndr :: Id -> (Id, SrcSpan, InlineSpec, Term) -> NormalizeSession (Id, SrcSpan, InlineSpec, Term)

rewriteExpr

Arguments

:: (String, NormRewrite)

Transformation to apply

-> (String, Term)

Term to transform

-> (Id, SrcSpan)

Renew current function being rewritten

-> NormalizeSession Term

Rewrite a term according to the provided transformation

removedTm :: Type -> Term