Clash.Normalize.Types

Types used in Normalize modules

Documentation

data NormalizeState

State of the NormalizeMonad

Constructors

NormalizeState

Fields

• _normalized :: BindingMap

  Global binders

• _specialisationCache :: Map (TmOccName, Int, Either Term Type) (TmName, Type)

  Cache of previously specialised functions:

  • Key: (name of the original function, argument position, specialised term/type)
  • Elem: (name of specialised function,type of specialised function)
• _specialisationHistory :: HashMap TmOccName Int

  Cache of how many times a function was specialized

• _specialisationLimit :: !Int

  Number of time a function f can be specialized

• _inlineHistory :: HashMap TmOccName (HashMap TmOccName Int)

  Cache of function where inlining took place:

  • Key: function where inlining took place
  • Elem: (functions which were inlined, number of times inlined)
• _inlineLimit :: !Int

  Number of times a function f can be inlined in a function g

• _inlineFunctionLimit :: !Word

  Size of a function below which it is always inlined if it is not recursive

• _inlineConstantLimit :: !Word

  Size of a constant below which it is always inlined; 0 = no limit

• _primitives :: PrimMap BlackBoxTemplate

  Primitive Definitions

• _recursiveComponents :: HashMap TmOccName Bool

  Map telling whether a components is recursively defined.

  NB: there are only no mutually-recursive component, only self-recursive ones.

specialisationLimit :: Lens' NormalizeState Int

specialisationHistory :: Lens' NormalizeState (HashMap TmOccName Int)

specialisationCache :: Lens' NormalizeState (Map (TmOccName, Int, Either Term Type) (TmName, Type))

recursiveComponents :: Lens' NormalizeState (HashMap TmOccName Bool)

primitives :: Lens' NormalizeState (PrimMap BlackBoxTemplate)

normalized :: Lens' NormalizeState BindingMap

inlineLimit :: Lens' NormalizeState Int

inlineHistory :: Lens' NormalizeState (HashMap TmOccName (HashMap TmOccName Int))

inlineFunctionLimit :: Lens' NormalizeState Word

inlineConstantLimit :: Lens' NormalizeState Word

type NormalizeMonad = State NormalizeState

State monad that stores specialisation and inlining information

type NormalizeSession = RewriteMonad NormalizeState

RewriteSession with extra Normalisation information

type NormRewrite = Rewrite NormalizeState

A Transform action in the context of the RewriteMonad and NormalizeMonad

data TermClassification

Description of a Term in terms of the type "components" the Term has.

Is used as a performance/size metric.

Constructors

TermClassification

Fields

• _function :: !Int

  Number of functions

• _primitive :: !Int

  Number of primitives

• _selection :: !Int

  Number of selections/multiplexers

Instances

Show TermClassification

Methods

showsPrec :: Int -> TermClassification -> ShowS

show :: TermClassification -> String

showList :: [TermClassification] -> ShowS

selection :: Lens' TermClassification Int

primitive :: Lens' TermClassification Int

function :: Lens' TermClassification Int