Safe Haskell	Trustworthy
Language	Haskell2010

ReWire.Hyle.Syntax

Description

The Hyle IR: a pure, first-order, monomorphic, total language over width-indexed bitvectors, plus a synchronous device construct (registers, sequential-extern instances, parallel wire equations). The syntax and semantics are specified in doc/hyle.md; this module is the AST and the pretty printer for the concrete syntax (doc/hyle.md, section 10).

Synopsis

type Size = Word
type Index = Word
type Name = Text
type GId = Text
type Value = Integer
class SizeAnnotated a where
- sizeOf :: a -> Size
data Op
- = Add
- | Sub
- | Mul
- | UDiv
- | UMod
- | Pow
- | And
- | Or
- | XOr
- | Not
- | Shl
- | LShr
- | AShr
- | Eq
- | Ne
- | ULt
- | ULe
- | UGt
- | UGe
- | SLt
- | SLe
- | SGt
- | SGe
- | RedAnd
- | RedOr
- | RedXOr
- | ZExt !Size
- | SExt !Size
- | Trunc !Size
- | Rep !Natural
opName :: Op -> Text
opResultSize :: Op -> [Size] -> Maybe Size
data Exp
- = Lit Annote !BV
- | Undef Annote !Size
- | Var Annote !Size !Name
- | Cat Annote !Exp !Exp
- | Slice Annote !Index !Size !Exp
- | Prim Annote !Size !Op ![Exp]
- | Call Annote !Size !GId ![Exp]
- | XCall Annote !Size !Name ![Natural] ![Exp]
- | If Annote !Size !Exp !Exp !Exp
- | Let Annote !Size !Name !Exp !Exp
data Sig = Sig Annote ![Size] !Size
data Defn = Defn {
- defnAnnote :: Annote
- defnName :: !GId
- defnSig :: !Sig
- defnParams :: ![Name]
- defnBody :: !Exp
- defnNoInline :: !Bool
- defnDoc :: !(Blind [Text])
}
data ExternKind
- = Comb
- | Seq !(Maybe Name) !(Maybe Name)
data Extern = Extern {
- extAnnote :: Annote
- extName :: !Name
- extGenerics :: ![Name]
- extKind :: !ExternKind
- extInputs :: ![(Name, Size)]
- extOutputs :: ![(Name, Size)]
- extModel :: !(Maybe GId)
}
externResultSize :: Extern -> Size
data Register = Register Annote !Name !Size !BV
data Instance = Instance Annote !Name !Name ![Natural]
data Stmt
- = SLet Annote !Name !Exp
- | SOutput Annote !Name !Exp
- | SNext Annote !Name !Exp
- | SInstIn Annote !Name !Name !Exp
data Device = Device {
- devAnnote :: Annote
- devName :: !Name
- devInputs :: ![(Name, Size)]
- devOutputs :: ![(Name, Size)]
- devRegisters :: ![Register]
- devInstances :: ![Instance]
- devBody :: ![Stmt]
- devTags :: !(Blind [(Text, Integer)])
}
data Program = Program {
- progExterns :: ![Extern]
- progDefns :: ![Defn]
- progDevice :: !Device
}
newtype Blind a = Blind {
- unBlind :: a
}
nil :: Exp
isNil :: Exp -> Bool
cat :: [Exp] -> Exp
gather :: Exp -> [Exp]
reservedWords :: HashSet Text

Documentation

type Size = Word Source #

type Index = Word Source #

type Name = Text Source #

type GId = Text Source #

type Value = Integer Source #

class SizeAnnotated a where Source #

Methods

sizeOf :: a -> Size Source #

Instances

Instances details

SizeAnnotated Defn Source #
Instance details Defined in ReWire.Hyle.Syntax Methods sizeOf :: Defn -> Size Source #
SizeAnnotated Exp Source #
Instance details Defined in ReWire.Hyle.Syntax Methods sizeOf :: Exp -> Size Source #
SizeAnnotated Extern Source #
Instance details Defined in ReWire.Hyle.Syntax Methods sizeOf :: Extern -> Size Source #
SizeAnnotated Register Source #
Instance details Defined in ReWire.Hyle.Syntax Methods sizeOf :: Register -> Size Source #
SizeAnnotated Sig Source #
Instance details Defined in ReWire.Hyle.Syntax Methods sizeOf :: Sig -> Size Source #

data Op Source #

Primitive operations (doc/hyle.md, section 3.3). Static parameters (target widths, replication counts) are part of the operator.

Constructors

Add
Sub
Mul
UDiv
UMod
Pow
And
Or
XOr
Not
Shl
LShr
AShr
Eq
Ne
ULt
ULe
UGt
UGe
SLt
SLe
SGt
SGe
RedAnd
RedOr
RedXOr
ZExt !Size
SExt !Size
Trunc !Size
Rep !Natural

Instances

Instances details

Data Op Source #

Instance details

Lit Annote !BV
Undef Annote !Size
Var Annote !Size !Name
Cat Annote !Exp !Exp
Slice Annote !Index !Size !Exp	e[offset +: width], LSB-indexed.
Prim Annote !Size !Op ![Exp]
Call Annote !Size !GId ![Exp]
XCall Annote !Size !Name ![Natural] ![Exp]	Combinational extern call with generic arguments.
If Annote !Size !Exp !Exp !Exp
Let Annote !Size !Name !Exp !Exp

Defn
Fields defnAnnote :: Annote defnName :: !GId defnSig :: !Sig defnParams :: ![Name] Same length as the Sig's argument list. defnBody :: !Exp defnNoInline :: !Bool Exempt from backend inlining (including --flatten); a real attribute, visible to Eq. defnDoc :: !(Blind [Text]) Display-only doc lines (`--\|`); invisible to EqOrdHashable.

Extern
Fields extAnnote :: Annote extName :: !Name extGenerics :: ![Name] extKind :: !ExternKind extInputs :: ![(Name, Size)] extOutputs :: ![(Name, Size)] extModel :: !(Maybe GId) Combinational externs only.

SLet Annote !Name !Exp
SOutput Annote !Name !Exp
SNext Annote !Name !Exp
SInstIn Annote !Name !Name !Exp	Instance name, port name.

Device
Fields devAnnote :: Annote devName :: !Name devInputs :: ![(Name, Size)] devOutputs :: ![(Name, Size)] devRegisters :: ![Register] devInstances :: ![Instance] devBody :: ![Stmt] devTags :: !(Blind [(Text, Integer)]) Display names for the `__resumption_tag` register's values; invisible to EqOrdHashable.

Program
Fields progExterns :: ![Extern] progDefns :: ![Defn] progDevice :: !Device

Blind
Fields unBlind :: a