aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorazidar2015-10-06 14:28:24 -0700
committerazidar2015-10-06 14:28:24 -0700
commit2485d20374166b27c06c475a4aef365761a818f7 (patch)
tree627b3c180ba41d7619b1acc8be03e2195dd208aa /src
parent62e922b0e7ea5f90c14a918ab09ce04a28f082d4 (diff)
parent0a9dfbe9f58338fc8af11015f6e9227e0cb46ea4 (diff)
Merge branch 'master' of github.com:ucb-bar/firrtl
Conflicts: README.md
Diffstat (limited to 'src')
-rw-r--r--src/main/antlr4/FIRRTL.g4207
-rw-r--r--src/main/scala/Example.scala19
-rw-r--r--src/main/scala/firrtl/IR.scala110
-rw-r--r--src/main/scala/firrtl/Parser.scala44
-rw-r--r--src/main/scala/firrtl/Translator.scala115
-rw-r--r--src/main/scala/firrtl/Utils.scala194
-rw-r--r--src/main/scala/firrtl/Visitor.scala185
-rw-r--r--src/main/stanza/compilers.stanza10
-rw-r--r--src/main/stanza/custom-compiler.stanza2
-rw-r--r--src/main/stanza/ir-utils.stanza14
-rw-r--r--src/main/stanza/passes.stanza390
-rw-r--r--src/main/stanza/verilog.stanza4
12 files changed, 1129 insertions, 165 deletions
diff --git a/src/main/antlr4/FIRRTL.g4 b/src/main/antlr4/FIRRTL.g4
new file mode 100644
index 00000000..08697bb1
--- /dev/null
+++ b/src/main/antlr4/FIRRTL.g4
@@ -0,0 +1,207 @@
+// Jack Koenig
+// UC Berkeley ASPIRE Lab
+// July 9, 2015
+
+grammar FIRRTL;
+
+/*------------------------------------------------------------------
+ * PARSER RULES
+ *------------------------------------------------------------------*/
+
+// TODO add [info] support (all over the place)
+// TODO Fix connect
+// TODO Add partial connect
+// TODO Should FIRRTL keywords be legal IDs?
+
+// Does there have to be at least one module?
+circuit
+ : 'circuit' id ':' '{' module* '}'
+ ;
+
+// TODO Add support for extmodule
+module
+ : 'module' id ':' '{' port* blockStmt '}'
+ ;
+
+port
+ : portKind id ':' type
+ ;
+
+portKind
+ : 'input'
+ | 'output'
+ ;
+
+type
+ : 'UInt' '<' width '>'
+ | 'SInt' '<' width '>'
+ | 'Clock'
+ | '{' field* '}' // Bundle
+ | type '[' IntLit ']' // Vector
+ ;
+
+field
+ : orientation id ':' type
+ ;
+
+// FIXME This is what the spec says it should be
+//orientation
+// : 'default'
+// | 'reverse'
+// ;
+orientation
+ : 'flip'
+ | // Nothing
+ ;
+
+width
+ : IntLit
+ | '?'
+ ;
+
+// Much faster than replacing blockStmt with stmt+
+blockStmt
+ : (stmt)*
+ ;
+
+stmt
+ : 'wire' id ':' type
+ | 'reg' id ':' type exp exp
+ | 'smem' id ':' type exp
+ | 'cmem' id ':' type exp
+ | 'inst' id (':' | 'of') id // FIXME which should it be? ':' or 'of'
+ | 'node' id '=' exp
+ | 'poison' id ':' type // Poison, FIXME
+ | dir 'accessor' id '=' exp '[' exp ']' exp? // FIXME what is this extra exp?
+ | exp ':=' exp // Connect
+ | 'onreset' exp ':=' exp
+ | exp '<>' exp // Bulk Connect
+ | exp '[' IntLit 'through' IntLit ']' ':=' exp // SubWordConnect
+ | 'when' exp ':' '{' blockStmt '}' ( 'else' ':' '{' blockStmt '}' )?
+ | 'assert' exp
+ | 'skip'
+ ;
+
+// Accessor Direction
+dir
+ : 'infer'
+ | 'read'
+ | 'write'
+ | 'rdwr'
+ ;
+
+// TODO implement
+// What is exp?
+exp
+ : 'UInt' '<' width '>' '(' (IntLit) ')' // FIXME what does "ints" mean?
+ | 'SInt' '<' width '>' '(' (IntLit) ')' // FIXME same
+ | id // Ref
+ | exp '.' id // FIXME Does this work for no space?
+ | exp '[' IntLit ']'
+ | primop '(' exp* IntLit* ')' // FIXME Need a big check here
+ ;
+
+id
+ : Id
+ | keyword
+ ;
+
+// FIXME need to make sure this is exhaustive including all FIRRTL keywords that are legal IDs
+keyword
+ : primop
+ | dir
+ | 'inst'
+ ;
+
+primop
+ : 'add'
+ | 'sub'
+ | 'addw'
+ | 'subw'
+ | 'mul'
+ | 'div'
+ | 'mod'
+ | 'quo'
+ | 'rem'
+ | 'lt'
+ | 'leq'
+ | 'gt'
+ | 'geq'
+ | 'eq'
+ | 'neq'
+ | 'mux'
+ | 'pad'
+ | 'asUInt'
+ | 'asSInt'
+ | 'shl'
+ | 'shr'
+ | 'dshl'
+ | 'dshr'
+ | 'cvt'
+ | 'neg'
+ | 'not'
+ | 'and'
+ | 'or'
+ | 'xor'
+ | 'andr'
+ | 'orr'
+ | 'xorr'
+ | 'cat'
+ | 'bit'
+ | 'bits'
+ ;
+
+/*------------------------------------------------------------------
+ * LEXER RULES
+ *------------------------------------------------------------------*/
+
+Id
+ : IdNondigit
+ ( IdNondigit
+ | Digit
+ )*
+ ;
+
+fragment
+IdNondigit
+ : Nondigit
+ | [~!@#$%^*-+=?/]
+ ;
+
+// Should enforcing signed, non-neg, and positive ints be done in parser?
+// => YES
+IntLit
+ : '0'
+ | ( '+' | '-' )? [1-9] ( Digit )*
+ | '"' 'h' ( HexDigit )+ '"'
+ ;
+
+fragment
+Nondigit
+ : [a-zA-Z_]
+ ;
+
+fragment
+Digit
+ : [0-9]
+ ;
+
+fragment
+HexDigit
+ : [a-zA-Z0-9]
+ ;
+
+Comment
+ : ';' ~[\r\n]*
+ -> skip
+ ;
+
+Whitespace
+ : [ \t,]+
+ -> skip
+ ;
+
+Newline
+ : ( '\r'? '\n' )+
+ -> skip
+ ;
diff --git a/src/main/scala/Example.scala b/src/main/scala/Example.scala
new file mode 100644
index 00000000..210a50fb
--- /dev/null
+++ b/src/main/scala/Example.scala
@@ -0,0 +1,19 @@
+import java.io._
+import firrtl._
+import firrtl.Utils._
+
+object Example
+{
+ // Example use of Scala FIRRTL parser and serialization
+ def main(args: Array[String])
+ {
+ val inputFile = args(0)
+
+ // Parse file
+ val ast = firrtl.Parser.parse(inputFile)
+
+ val writer = new PrintWriter(new File(args(1)))
+ writer.write(ast.serialize) // serialize returns String
+ writer.close()
+ }
+}
diff --git a/src/main/scala/firrtl/IR.scala b/src/main/scala/firrtl/IR.scala
new file mode 100644
index 00000000..c52c45a4
--- /dev/null
+++ b/src/main/scala/firrtl/IR.scala
@@ -0,0 +1,110 @@
+package firrtl
+
+import scala.collection.Seq
+
+// Should this be defined elsewhere?
+case class FileInfo(file: String, line: Int, column: Int) {
+ override def toString(): String = s"$file@$line.$column"
+}
+
+trait AST
+
+trait PrimOp extends AST
+case object Add extends PrimOp
+case object Sub extends PrimOp
+case object Addw extends PrimOp
+case object Subw extends PrimOp
+case object Mul extends PrimOp
+case object Div extends PrimOp
+case object Mod extends PrimOp
+case object Quo extends PrimOp
+case object Rem extends PrimOp
+case object Lt extends PrimOp
+case object Leq extends PrimOp
+case object Gt extends PrimOp
+case object Geq extends PrimOp
+case object Eq extends PrimOp
+case object Neq extends PrimOp
+case object Mux extends PrimOp
+case object Pad extends PrimOp
+case object AsUInt extends PrimOp
+case object AsSInt extends PrimOp
+case object Shl extends PrimOp
+case object Shr extends PrimOp
+case object Dshl extends PrimOp
+case object Dshr extends PrimOp
+case object Cvt extends PrimOp
+case object Neg extends PrimOp
+case object Not extends PrimOp
+case object And extends PrimOp
+case object Or extends PrimOp
+case object Xor extends PrimOp
+case object Andr extends PrimOp
+case object Orr extends PrimOp
+case object Xorr extends PrimOp
+case object Cat extends PrimOp
+case object Bit extends PrimOp
+case object Bits extends PrimOp
+
+// TODO stanza ir has types on many of these, why? Is it the type of what we're referencing?
+// Add types, default to UNKNOWN
+// TODO add type
+trait Exp extends AST
+case class UIntValue(value: BigInt, width: BigInt) extends Exp
+case class SIntValue(value: BigInt, width: BigInt) extends Exp
+case class Ref(name: String, tpe: Type) extends Exp
+case class Subfield(exp: Exp, name: String, tpe: Type) extends Exp
+case class Subindex(exp: Exp, value: BigInt) extends Exp
+case class DoPrimOp(op: PrimOp, args: Seq[Exp], consts: Seq[BigInt]) extends Exp
+
+trait AccessorDir extends AST
+case object Infer extends AccessorDir
+case object Read extends AccessorDir
+case object Write extends AccessorDir
+case object RdWr extends AccessorDir
+
+trait Stmt extends AST
+case class DefWire(info: FileInfo, name: String, tpe: Type) extends Stmt
+case class DefReg(info: FileInfo, name: String, tpe: Type, clock: Exp, reset: Exp) extends Stmt
+case class DefMemory(info: FileInfo, name: String, seq: Boolean, tpe: Type, clock: Exp) extends Stmt
+case class DefInst(info: FileInfo, name: String, module: Exp) extends Stmt
+case class DefNode(info: FileInfo, name: String, value: Exp) extends Stmt
+case class DefPoison(info: FileInfo, name: String, tpe: Type) extends Stmt
+case class DefAccessor(info: FileInfo, name: String, dir: AccessorDir, source: Exp, index: Exp) extends Stmt
+case class OnReset(info: FileInfo, lhs: Exp, rhs: Exp) extends Stmt
+case class Connect(info: FileInfo, lhs: Exp, rhs: Exp) extends Stmt
+case class BulkConnect(info: FileInfo, lhs: Exp, rhs: Exp) extends Stmt
+case class When(info: FileInfo, pred: Exp, conseq: Stmt, alt: Stmt) extends Stmt
+case class Assert(info: FileInfo, pred: Exp) extends Stmt
+case class Block(stmts: Seq[Stmt]) extends Stmt
+case object EmptyStmt extends Stmt
+
+trait Width extends AST
+case class IntWidth(width: BigInt) extends Width
+case object UnknownWidth extends Width
+
+trait FieldDir extends AST
+case object Default extends FieldDir
+case object Reverse extends FieldDir
+
+case class Field(name: String, dir: FieldDir, tpe: Type) extends AST
+
+trait Type extends AST
+case class UIntType(width: Width) extends Type
+case class SIntType(width: Width) extends Type
+case object ClockType extends Type
+case class BundleType(fields: Seq[Field]) extends Type
+case class VectorType(tpe: Type, size: BigInt) extends Type
+case object UnknownType extends Type
+
+trait PortDir extends AST
+case object Input extends PortDir
+case object Output extends PortDir
+
+case class Port(info: FileInfo, name: String, dir: PortDir, tpe: Type) extends AST
+
+case class Module(info: FileInfo, name: String, ports: Seq[Port], stmt: Stmt) extends AST
+
+case class Circuit(info: FileInfo, name: String, modules: Seq[Module]) extends AST
+
+
diff --git a/src/main/scala/firrtl/Parser.scala b/src/main/scala/firrtl/Parser.scala
new file mode 100644
index 00000000..35e41222
--- /dev/null
+++ b/src/main/scala/firrtl/Parser.scala
@@ -0,0 +1,44 @@
+package firrtl
+
+import org.antlr.v4.runtime._;
+import org.antlr.v4.runtime.atn._;
+import org.antlr.v4.runtime.tree._;
+import java.io.FileInputStream
+import scala.collection.JavaConverters._
+import scala.io.Source
+import Utils._
+import antlr._
+
+object Parser
+{
+
+ /** Takes a firrtl filename, returns AST (root node is Circuit)
+ *
+ * Currently must be standard FIRRTL file
+ * Parser performs conversion to machine firrtl
+ */
+ def parse(filename: String): Circuit = {
+ //val antlrStream = new ANTLRInputStream(input.reader)
+ val fixedInput = Translator.addBrackets(Source.fromFile(filename).getLines)
+ val antlrStream = new ANTLRInputStream(fixedInput.result)
+ val lexer = new FIRRTLLexer(antlrStream)
+ val tokens = new CommonTokenStream(lexer)
+ val parser = new FIRRTLParser(tokens)
+
+ // FIXME Dangerous
+ parser.getInterpreter.setPredictionMode(PredictionMode.SLL)
+
+ // Concrete Syntax Tree
+ val cst = parser.circuit
+
+ val visitor = new Visitor(filename)
+ //val ast = visitor.visitCircuit(cst) match {
+ val ast = visitor.visit(cst) match {
+ case c: Circuit => c
+ case x => throw new ClassCastException("Error! AST not rooted with Circuit node!")
+ }
+
+ ast
+ }
+
+}
diff --git a/src/main/scala/firrtl/Translator.scala b/src/main/scala/firrtl/Translator.scala
new file mode 100644
index 00000000..eba78b39
--- /dev/null
+++ b/src/main/scala/firrtl/Translator.scala
@@ -0,0 +1,115 @@
+
+/* TODO
+ * - Add support for comments (that being said, current Scopers regex should ignore commented lines)
+ * - Add better error messages for illformed FIRRTL
+ * - Add support for files that do not have a circuit (like a module by itself in a file)
+ * - Improve performance? Replace regex?
+ * - Add proper commnad-line arguments?
+ * - Wrap in Reader subclass. This would have less memory footprint than creating a large string
+ */
+
+package firrtl
+
+import scala.io.Source
+import scala.collection.mutable.Stack
+import scala.collection.mutable.StringBuilder
+import java.io._
+
+
+object Translator
+{
+
+ def addBrackets(inputIt: Iterator[String]): StringBuilder = {
+ def countSpaces(s: String): Int = s.prefixLength(_ == ' ')
+
+ val Scopers = """\s*(circuit|module|when|else)(.*)""".r
+
+ // Function start
+ val it = inputIt.zipWithIndex
+ var ret = new StringBuilder()
+
+ if( !it.hasNext ) throw new Exception("Empty file!")
+
+ // Find circuit before starting scope checks
+ var line = it.next
+ while ( it.hasNext && !line._1.contains("circuit") ) {
+ ret ++= line._1 + "\n"
+ line = it.next
+ }
+ ret ++= line._1 + " { \n"
+ if( !it.hasNext ) throw new Exception("No circuit in file!")
+
+
+ val scope = Stack[Int]()
+ scope.push(countSpaces(line._1))
+ var newScope = true // indicates if increasing scope spacing is legal on next line
+
+ while( it.hasNext ) {
+ it.next match { case (text, lineNum) =>
+ val spaces = countSpaces(text)
+
+ val l = if (text.length > spaces ) { // Check that line has text in it
+ if (newScope) {
+ scope.push(countSpaces(text))
+ } else {
+
+ // Check if change in current scope
+ if( spaces < scope.top ) {
+ while( spaces < scope.top ) {
+ // Close scopes (adding brackets as we go)
+ scope.pop()
+ ret.deleteCharAt(ret.lastIndexOf("\n")) // Put on previous line
+ ret ++= " }\n"
+ }
+ if( spaces != scope.top )
+ throw new Exception("Spacing does not match scope on line : " + lineNum + " : " + scope.top)
+ }
+ else if( spaces > scope.top )
+ throw new Exception("Invalid increase in scope on line " + lineNum)
+ }
+ // Now match on legal scope increasers
+ text match {
+ case Scopers(keyword, _* ) => {
+ newScope = true
+ text + " { "
+ }
+ case _ => {
+ newScope = false
+ text
+ }
+ }
+ } // if( text.length > spaces )
+ else {
+ text // empty lines
+ }
+
+ ret ++= l + "\n"
+ } // it.next match
+ } // while( it.hasNext )
+
+ // Print any closing braces
+ while( scope.top > 0 ) {
+ scope.pop()
+ ret.deleteCharAt(ret.lastIndexOf("\n")) // Put on previous line
+ ret ++= " }\n"
+ }
+
+ ret
+ }
+
+ def main(args: Array[String]) {
+
+ try {
+ val translation = addBrackets(Source.fromFile(args(0)).getLines)
+
+ val writer = new PrintWriter(new File(args(1)))
+ writer.write(translation.result)
+ writer.close()
+ } catch {
+ case e: Exception => {
+ throw new Exception("USAGE: Translator <input file> <output file>\n" + e)
+ }
+ }
+ }
+
+}
diff --git a/src/main/scala/firrtl/Utils.scala b/src/main/scala/firrtl/Utils.scala
new file mode 100644
index 00000000..916408bc
--- /dev/null
+++ b/src/main/scala/firrtl/Utils.scala
@@ -0,0 +1,194 @@
+// Utility functions for FIRRTL IR
+
+/* TODO
+ * - Adopt style more similar to Chisel3 Emitter?
+ */
+
+package firrtl
+
+import scala.collection.mutable.StringBuilder
+
+object Utils {
+
+ implicit class BigIntUtils(bi: BigInt){
+ def serialize(): String =
+ "\"h0" + bi.toString(16) + "\""
+ }
+
+ implicit class PrimOpUtils(op: PrimOp) {
+ def serialize(): String = {
+ op match {
+ case Add => "add"
+ case Sub => "sub"
+ case Addw => "addw"
+ case Subw => "subw"
+ case Mul => "mul"
+ case Div => "div"
+ case Mod => "mod"
+ case Quo => "quo"
+ case Rem => "rem"
+ case Lt => "lt"
+ case Leq => "leq"
+ case Gt => "gt"
+ case Geq => "geq"
+ case Eq => "eq"
+ case Neq => "neq"
+ case Mux => "mux"
+ case Pad => "pad"
+ case AsUInt => "asUInt"
+ case AsSInt => "asSInt"
+ case Shl => "shl"
+ case Shr => "shr"
+ case Dshl => "dshl"
+ case Dshr => "dshr"
+ case Cvt => "cvt"
+ case Neg => "neg"
+ case Not => "not"
+ case And => "and"
+ case Or => "or"
+ case Xor => "xor"
+ case Andr => "andr"
+ case Orr => "orr"
+ case Xorr => "xorr"
+ case Cat => "cat"
+ case Bit => "bit"
+ case Bits => "bits"
+ }
+ }
+ }
+
+ implicit class ExpUtils(exp: Exp) {
+ def serialize(): String =
+ exp match {
+ case v: UIntValue => s"UInt<${v.width}>(${v.value.serialize})"
+ case v: SIntValue => s"SInt<${v.width}>(${v.value.serialize})"
+ case r: Ref => r.name
+ case s: Subfield => s"${s.exp.serialize}.${s.name}"
+ case s: Subindex => s"${s.exp.serialize}[${s.value}]"
+ case p: DoPrimOp =>
+ s"${p.op.serialize}(" + (p.args.map(_.serialize) ++ p.consts.map(_.toString)).mkString(", ") + ")"
+ }
+ }
+
+ // AccessorDir
+ implicit class AccessorDirUtils(dir: AccessorDir) {
+ def serialize(): String =
+ dir match {
+ case Infer => "infer"
+ case Read => "read"
+ case Write => "write"
+ case RdWr => "rdwr"
+ }
+ }
+
+
+ implicit class StmtUtils(stmt: Stmt) {
+ def serialize(): String =
+ stmt match {
+ case w: DefWire => s"wire ${w.name} : ${w.tpe.serialize}"
+ case r: DefReg => s"reg ${r.name} : ${r.tpe.serialize}, ${r.clock.serialize}, ${r.reset.serialize}"
+ case m: DefMemory => (if(m.seq) "smem" else "cmem") +
+ s" ${m.name} : ${m.tpe.serialize}, ${m.clock.serialize}"
+ case i: DefInst => s"inst ${i.name} of ${i.module.serialize}"
+ case n: DefNode => s"node ${n.name} = ${n.value.serialize}"
+ case p: DefPoison => s"poison ${p.name} : ${p.tpe.serialize}"
+ case a: DefAccessor => s"${a.dir.serialize} accessor ${a.name} = ${a.source.serialize}[${a.index.serialize}]"
+ case c: Connect => s"${c.lhs.serialize} := ${c.rhs.serialize}"
+ case o: OnReset => s"onreset ${o.lhs.serialize} := ${o.rhs.serialize}"
+ case b: BulkConnect => s"${b.lhs.serialize} <> ${b.rhs.serialize}"
+ case w: When => {
+ var str = new StringBuilder(s"when ${w.pred.serialize} : ")
+ withIndent { str ++= w.conseq.serialize }
+ if( w.alt != EmptyStmt ) {
+ str ++= newline + "else :"
+ withIndent { str ++= w.alt.serialize }
+ }
+ str.result
+ }
+ //case b: Block => b.stmts.map(newline ++ _.serialize).mkString
+ case b: Block => {
+ val s = new StringBuilder
+ b.stmts.foreach { s ++= newline ++ _.serialize }
+ s.result
+ }
+ case a: Assert => s"assert ${a.pred.serialize}"
+ case EmptyStmt => "skip"
+ }
+ }
+
+ implicit class WidthUtils(w: Width) {
+ def serialize(): String =
+ w match {
+ case UnknownWidth => "?"
+ case w: IntWidth => w.width.toString
+ }
+ }
+
+ implicit class FieldDirUtils(dir: FieldDir) {
+ def serialize(): String =
+ dir match {
+ case Reverse => "flip "
+ case Default => ""
+ }
+ }
+
+ implicit class FieldUtils(field: Field) {
+ def serialize(): String =
+ s"${field.dir.serialize} ${field.name} : ${field.tpe.serialize}"
+ }
+
+ implicit class TypeUtils(t: Type) {
+ def serialize(): String = {
+ val commas = ", " // for mkString in BundleType
+ t match {
+ case ClockType => "Clock"
+ case UnknownType => "UnknownType"
+ case t: UIntType => s"UInt<${t.width.serialize}>"
+ case t: SIntType => s"SInt<${t.width.serialize}>"
+ case t: BundleType => s"{ ${t.fields.map(_.serialize).mkString(commas)} }"
+ case t: VectorType => s"${t.tpe.serialize}[${t.size}]"
+ }
+ }
+ }
+
+ implicit class PortDirUtils(p: PortDir) {
+ def serialize(): String =
+ p match {
+ case Input => "input"
+ case Output => "output"
+ }
+ }
+
+ implicit class PortUtils(p: Port) {
+ def serialize(): String =
+ s"${p.dir.serialize} ${p.name} : ${p.tpe.serialize}"
+ }
+
+ implicit class ModuleUtils(m: Module) {
+ def serialize(): String = {
+ var s = new StringBuilder(s"module ${m.name} : ")
+ withIndent {
+ s ++= m.ports.map(newline ++ _.serialize).mkString
+ s ++= newline ++ m.stmt.serialize
+ }
+ s.toString
+ }
+ }
+
+ implicit class CircuitUtils(c: Circuit) {
+ def serialize(): String = {
+ var s = new StringBuilder(s"circuit ${c.name} : ")
+ //withIndent { c.modules.foreach(s ++= newline ++ newline ++ _.serialize) }
+ withIndent { s ++= newline ++ c.modules.map(_.serialize).mkString(newline + newline) }
+ s ++= newline ++ newline
+ s.toString
+ }
+ }
+
+ private var indentLevel = 0
+ private def newline = "\n" + (" " * indentLevel)
+ private def indent(): Unit = indentLevel += 1
+ private def unindent() { require(indentLevel > 0); indentLevel -= 1 }
+ private def withIndent(f: => Unit) { indent(); f; unindent() }
+
+}
diff --git a/src/main/scala/firrtl/Visitor.scala b/src/main/scala/firrtl/Visitor.scala
new file mode 100644
index 00000000..276facce
--- /dev/null
+++ b/src/main/scala/firrtl/Visitor.scala
@@ -0,0 +1,185 @@
+/*
+ * TODO FIXME
+ * - Support all integer types (not just "h...")
+ * - In ANTLR examples they use just visit, why am I having to use visitModule or other specific functions?
+ * - Make visit private?
+*/
+
+package firrtl
+
+import org.antlr.v4.runtime.tree.AbstractParseTreeVisitor;
+import org.antlr.v4.runtime.ParserRuleContext
+import org.antlr.v4.runtime.tree.ErrorNode
+import org.antlr.v4.runtime.tree.TerminalNode
+import scala.collection.JavaConversions._
+import antlr._
+
+class Visitor(val fullFilename: String) extends FIRRTLBaseVisitor[AST]
+{
+ // Strip file path
+ private val filename = fullFilename.drop(fullFilename.lastIndexOf("/")+1)
+
+ // For some reason visitCircuit does not visit the right function
+ // FIXME for some reason this cannot be private, probably because it extends
+ // FIRRTLBaseVisitor which is in a subpackage?
+ def visit[AST](ctx: FIRRTLParser.CircuitContext): Circuit = visitCircuit(ctx)
+
+ // These regex have to change if grammar changes
+ private def string2BigInt(s: String): BigInt = {
+ // private define legal patterns
+ val HexPattern = """\"*h([a-zA-Z0-9]+)\"*""".r
+ val DecPattern = """(\+|-)?([1-9]\d*)""".r
+ val ZeroPattern = "0".r
+ s match {
+ case ZeroPattern(_*) => BigInt(0)
+ case HexPattern(hexdigits) => BigInt(hexdigits, 16)
+ case DecPattern(sign, num) => BigInt(num)
+ case _ => throw new Exception("Invalid String for conversion to BigInt " + s)
+ }
+ }
+ private def getFileInfo(ctx: ParserRuleContext): FileInfo =
+ FileInfo(filename, ctx.getStart().getLine(), ctx.getStart().getCharPositionInLine())
+
+ private def visitCircuit[AST](ctx: FIRRTLParser.CircuitContext): Circuit =
+ Circuit(getFileInfo(ctx), ctx.id.getText, ctx.module.map(visitModule))
+
+ private def visitModule[AST](ctx: FIRRTLParser.ModuleContext): Module =
+ Module(getFileInfo(ctx), ctx.id.getText, ctx.port.map(visitPort), visitBlockStmt(ctx.blockStmt))
+
+ private def visitPort[AST](ctx: FIRRTLParser.PortContext): Port =
+ Port(getFileInfo(ctx), ctx.id.getText, visitPortKind(ctx.portKind), visitType(ctx.`type`))
+
+ private def visitPortKind[AST](ctx: FIRRTLParser.PortKindContext): PortDir =
+ ctx.getText match {
+ case "input" => Input
+ case "output" => Output
+ }
+
+ // Match on a type instead of on strings?
+ private def visitType[AST](ctx: FIRRTLParser.TypeContext): Type = {
+ ctx.getChild(0).getText match {
+ case "UInt" => UIntType( visitWidth(ctx.width) )
+ case "SInt" => SIntType( visitWidth(ctx.width) )
+ case "Clock" => ClockType
+ case "{" => BundleType(ctx.field.map(visitField))
+ case _ => new VectorType( visitType(ctx.`type`), string2BigInt(ctx.IntLit.getText) )
+ }
+ }
+
+ private def visitField[AST](ctx: FIRRTLParser.FieldContext): Field =
+ Field(ctx.id.getText, visitOrientation(ctx.orientation), visitType(ctx.`type`))
+
+ private def visitOrientation[AST](ctx: FIRRTLParser.OrientationContext): FieldDir =
+ ctx.getText match {
+ case "flip" => Reverse
+ case _ => Default
+ }
+
+ private def visitWidth[AST](ctx: FIRRTLParser.WidthContext): Width = {
+ val text = ctx.getText
+ text match {
+ case "?" => UnknownWidth
+ case _ => IntWidth(string2BigInt(text))
+ }
+ }
+
+ private def visitBlockStmt[AST](ctx: FIRRTLParser.BlockStmtContext): Stmt =
+ Block(ctx.stmt.map(visitStmt))
+
+ private def visitStmt[AST](ctx: FIRRTLParser.StmtContext): Stmt = {
+ val info = getFileInfo(ctx)
+
+ ctx.getChild(0).getText match {
+ case "wire" => DefWire(info, ctx.id(0).getText, visitType(ctx.`type`))
+ case "reg" => DefReg(info, ctx.id(0).getText, visitType(ctx.`type`),
+ visitExp(ctx.exp(0)), visitExp(ctx.exp(1)))
+ case "smem" => DefMemory(info, ctx.id(0).getText, true,
+ visitType(ctx.`type`), visitExp(ctx.exp(0)))
+ case "cmem" => DefMemory(info, ctx.id(0).getText, false,
+ visitType(ctx.`type`), visitExp(ctx.exp(0)))
+ case "inst" => DefInst(info, ctx.id(0).getText, Ref(ctx.id(1).getText, UnknownType))
+ case "node" => DefNode(info, ctx.id(0).getText, visitExp(ctx.exp(0)))
+ case "poison" => DefPoison(info, ctx.id(0).getText, visitType(ctx.`type`))
+ case "onreset" => OnReset(info, visitExp(ctx.exp(0)), visitExp(ctx.exp(1)))
+ case "when" => {
+ val alt = if (ctx.blockStmt.length > 1) visitBlockStmt(ctx.blockStmt(1)) else EmptyStmt
+ When(info, visitExp(ctx.exp(0)), visitBlockStmt(ctx.blockStmt(0)), alt)
+ }
+ case "assert" => Assert(info, visitExp(ctx.exp(0)))
+ case "skip" => EmptyStmt
+ // If we don't match on the first child, try the next one
+ case _ => {
+ ctx.getChild(1).getText match {
+ case "accessor" => DefAccessor(info, ctx.id(0).getText,
+ visitDir(ctx.dir), visitExp(ctx.exp(0)), visitExp(ctx.exp(1)))
+ case ":=" => Connect(info, visitExp(ctx.exp(0)), visitExp(ctx.exp(1)) )
+ case "<>" => BulkConnect(info, visitExp(ctx.exp(0)), visitExp(ctx.exp(1)) )
+ }
+ }
+ }
+ }
+
+ private def visitDir[AST](ctx: FIRRTLParser.DirContext): AccessorDir =
+ ctx.getText match {
+ case "infer" => Infer
+ case "read" => Read
+ case "write" => Write
+ case "rdwr" => RdWr // TODO remove exceptions for unmatched things
+ }
+
+ private def visitExp[AST](ctx: FIRRTLParser.ExpContext): Exp =
+ if( ctx.getChildCount == 1 )
+ Ref(ctx.getText, UnknownType)
+ else
+ ctx.getChild(0).getText match {
+ case "UInt" => UIntValue(string2BigInt(ctx.IntLit(0).getText), string2BigInt(ctx.width.getText))
+ case "SInt" => SIntValue(string2BigInt(ctx.IntLit(0).getText), string2BigInt(ctx.width.getText))
+ case _ =>
+ ctx.getChild(1).getText match {
+ case "." => new Subfield(visitExp(ctx.exp(0)), ctx.id.getText, UnknownType)
+ case "[" => new Subindex(visitExp(ctx.exp(0)), string2BigInt(ctx.IntLit(0).getText))
+ case "(" =>
+ DoPrimOp(visitPrimop(ctx.primop), ctx.exp.map(visitExp), ctx.IntLit.map(x => string2BigInt(x.getText)))
+ }
+ }
+
+ // TODO can I create this and have the opposite? create map and invert it?
+ private def visitPrimop[AST](ctx: FIRRTLParser.PrimopContext): PrimOp =
+ ctx.getText match {
+ case "add" => Add
+ case "sub" => Sub
+ case "addw" => Addw
+ case "subw" => Subw
+ case "mul" => Mul
+ case "div" => Div
+ case "mod" => Mod
+ case "quo" => Quo
+ case "rem" => Rem
+ case "lt" => Lt
+ case "leq" => Leq
+ case "gt" => Gt
+ case "geq" => Geq
+ case "eq" => Eq
+ case "neq" => Neq
+ case "mux" => Mux
+ case "pad" => Pad
+ case "asUInt" => AsUInt
+ case "asSInt" => AsSInt
+ case "shl" => Shl
+ case "shr" => Shr
+ case "dshl" => Dshl
+ case "dshr" => Dshr
+ case "cvt" => Cvt
+ case "neg" => Neg
+ case "not" => Not
+ case "and" => And
+ case "or" => Or
+ case "xor" => Xor
+ case "andr" => Andr
+ case "orr" => Orr
+ case "xorr" => Xorr
+ case "cat" => Cat
+ case "bit" => Bit
+ case "bits" => Bits
+ }
+}
diff --git a/src/main/stanza/compilers.stanza b/src/main/stanza/compilers.stanza
index 1e978a2e..0ea9a367 100644
--- a/src/main/stanza/compilers.stanza
+++ b/src/main/stanza/compilers.stanza
@@ -25,7 +25,7 @@ public defmethod passes (c:StandardFlo) -> List<Pass> :
CheckGenders()
ExpandAccessors()
LowerToGround()
- ExpandIndexedConnects()
+ InlineIndexed()
ExpandWhens()
InferWidths()
Pad()
@@ -44,7 +44,7 @@ public defstruct StandardVerilog <: Compiler :
public defmethod passes (c:StandardVerilog) -> List<Pass> :
to-list $ [
RemoveSpecialChars() ;R
- RemoveScopes() ;R
+ ;RemoveScopes() ;R
CheckHighForm() ;R
TempElimination() ;R
ToWorkingIR() ;R -> W
@@ -56,15 +56,17 @@ public defmethod passes (c:StandardVerilog) -> List<Pass> :
CheckTypes() ;R
ExpandAccessors() ;W
LowerToGround() ;W
- ExpandIndexedConnects() ;W
+ ;ExpandIndexedConnects() ;W
+ InlineIndexed()
InferTypes() ;R
CheckGenders() ;W
ExpandWhens() ;W
InferWidths() ;R
+ ToRealIR() ;W -> R
+ CheckWidths() ;R
Pad() ;R
ConstProp() ;R
SplitExp() ;R
- ToRealIR() ;W -> R
CheckWidths() ;R
CheckHighForm() ;R
CheckLowForm() ;R
diff --git a/src/main/stanza/custom-compiler.stanza b/src/main/stanza/custom-compiler.stanza
index 36a6474f..0f43da58 100644
--- a/src/main/stanza/custom-compiler.stanza
+++ b/src/main/stanza/custom-compiler.stanza
@@ -28,7 +28,7 @@ public defmethod passes (c:InstrumentedVerilog) -> List<Pass> :
CheckGenders()
ExpandAccessors()
LowerToGround()
- ExpandIndexedConnects()
+ InlineIndexed()
InferTypes()
CheckGenders()
ExpandWhens()
diff --git a/src/main/stanza/ir-utils.stanza b/src/main/stanza/ir-utils.stanza
index a234ff81..27acedb3 100644
--- a/src/main/stanza/ir-utils.stanza
+++ b/src/main/stanza/ir-utils.stanza
@@ -9,6 +9,11 @@ public defmulti print-debug (o:OutputStream, e:Expression|Stmt|Type|Port|Field|M
;============== GENSYM STUFF ======================
+defn generated? (s:String) -> False|Int :
+ for i in 1 to length(s) - 1 find :
+ val sub = substring(s,i + 1)
+ s[i] == '_' and digits?(sub) and s[i - 1] != '_'
+
public defn firrtl-gensym (s:Symbol) -> Symbol :
firrtl-gensym(s,HashTable<Symbol,Int>(symbol-hash))
public defn firrtl-gensym (sym-hash:HashTable<Symbol,Int>) -> Symbol :
@@ -31,11 +36,11 @@ public defn firrtl-gensym (s:Symbol,sym-hash:HashTable<Symbol,Int>) -> Symbol :
sym-hash[s] = 0
s
val s* = to-string(s)
- val i* = for i in 0 to length(s*) - 1 find :
- s*[i] == '_' and digits?(substring(s*,i + 1))
- match(i*) :
+ val i* = generated?(s*)
+ val nex = match(i*) :
(i:False) : get-name(s)
(i:Int) : get-name(to-symbol(substring(s*,0,i)))
+ nex
public defn get-sym-hash (m:InModule) -> HashTable<Symbol,Int> :
get-sym-hash(m,list())
@@ -45,8 +50,7 @@ public defn get-sym-hash (m:InModule,keywords:Streamable<Symbol>) -> HashTable<S
sym-hash[k] = 0
defn add-name (s:Symbol) -> False :
val s* = to-string(s)
- val i* = for i in 0 to length(s*) - 1 find :
- s*[i] == '_' and digits?(substring(s*,i + 1))
+ val i* = generated?(s*)
match(i*) :
(i:False) :
if key?(sym-hash,s) :
diff --git a/src/main/stanza/passes.stanza b/src/main/stanza/passes.stanza
index 99fb8172..0c812535 100644
--- a/src/main/stanza/passes.stanza
+++ b/src/main/stanza/passes.stanza
@@ -21,7 +21,8 @@ public val standard-passes = to-list $ [
CheckGenders()
ExpandAccessors()
LowerToGround()
- ExpandIndexedConnects()
+ ;ExpandIndexedConnects()
+ InlineIndexed()
ExpandWhens()
InferWidths()
Inline()
@@ -67,17 +68,19 @@ public defstruct WIndex <: Expression :
type: Type with: (as-method => true)
gender: Gender with: (as-method => true)
-defstruct ConnectToIndexed <: Stmt :
+defstruct DecFromIndexer <: Stmt :
info: FileInfo with: (as-method => true)
index: Expression
- locs: List<Expression>
- exp: Expression
+ exps: List<Expression>
+ name: Symbol
+ type: Type
-defstruct ConnectFromIndexed <: Stmt :
+defstruct DecToIndexer <: Stmt :
info: FileInfo with: (as-method => true)
index: Expression
- loc: Expression
exps: List<Expression>
+ name: Symbol
+ type: Type
;================ WORKING IR UTILS =========================
@@ -259,12 +262,12 @@ defmethod print (o:OutputStream, e:WIndex) :
print-all(o,[exp(e) "[" value(e) "]"])
print-debug(o,e as ?)
-defmethod print (o:OutputStream, c:ConnectToIndexed) :
- print-all(o, [locs(c) "[" index(c) "] := " exp(c)])
+defmethod print (o:OutputStream, c:DecFromIndexer) :
+ print-all(o, ["indexer " exps(c) "[" index(c) "] = " name(c) " : " type(c)])
print-debug(o,c as ?)
-defmethod print (o:OutputStream, c:ConnectFromIndexed) :
- print-all(o, [loc(c) " := " exps(c) "[" index(c) "]" ])
+defmethod print (o:OutputStream, c:DecToIndexer) :
+ print-all(o, ["indexer " name(c) " = " exps(c) "[" index(c) "] : " type(c)])
print-debug(o,c as ?)
defmethod map (f: Expression -> Expression, e: WSubfield) :
@@ -272,10 +275,10 @@ defmethod map (f: Expression -> Expression, e: WSubfield) :
defmethod map (f: Expression -> Expression, e: WIndex) :
WIndex(f(exp(e)), value(e), type(e), gender(e))
-defmethod map (f: Expression -> Expression, c:ConnectToIndexed) :
- ConnectToIndexed(info(c),f(index(c)), map(f, locs(c)), f(exp(c)))
-defmethod map (f: Expression -> Expression, c:ConnectFromIndexed) :
- ConnectFromIndexed(info(c),f(index(c)), f(loc(c)), map(f, exps(c)))
+defmethod map (f: Expression -> Expression, c:DecFromIndexer) :
+ DecFromIndexer(info(c),f(index(c)), map(f, exps(c)), name(c), type(c))
+defmethod map (f: Expression -> Expression, c:DecToIndexer) :
+ DecToIndexer(info(c),f(index(c)), map(f, exps(c)), name(c), type(c))
defmethod map (f: Type -> Type, e: WRef) :
WRef(name(e), f(type(e)), kind(e), gender(e))
@@ -297,7 +300,7 @@ public defmethod short-name (b:RemoveSpecialChars) -> String : "rem-spec-chars"
defn get-new-string (n:Char) -> String :
switch {n == _} :
- '_' : "_"
+ '_' : "__"
'~' : "$A"
'!' : "$B"
'@' : "$C"
@@ -850,12 +853,12 @@ defn resolve-genders (c:Circuit) :
resolve-genders(m,c)
;;============== EXPAND ACCESSORS ================================
-; This pass expands non-memory accessors into ConnectToIndexed or
+; This pass expands non-memory accessors into DecFromIndexer or
; ConnectFromIndexed. All elements of the vector are
; explicitly written out, then indexed. Depending on the gender
-; of the accessor, it is transformed into ConnectToIndexed (male) or
-; ConnectFromIndexed (female)
-; Eg:
+; of the accessor, it is transformed into DecFromIndexer (male) or
+; DecToIndexer (female)
+
public defstruct ExpandAccessors <: Pass
public defmethod pass (b:ExpandAccessors) -> (Circuit -> Circuit) : expand-accessors
public defmethod name (b:ExpandAccessors) -> String : "Expand Accessors"
@@ -876,18 +879,11 @@ defn expand-stmt (s:Stmt) -> Stmt :
if mem? : s
else :
val vtype = type(type(source(s)) as VectorType)
- val wire = DefWire(info(s),name(s),vtype)
switch {acc-dir(s) == _} :
- READ : Begin{list(wire,_)} $ ConnectFromIndexed(
- info(s),
- index(s),
- WRef(name(wire),vtype,NodeKind(),FEMALE),
- expand-vector(source(s)))
- WRITE : Begin{list(wire,_)} $ ConnectToIndexed(
- info(s),
- index(s),
- expand-vector(source(s)),
- WRef(name(wire),vtype,NodeKind(),MALE))
+ READ : DecToIndexer(info(s),index(s),expand-vector(source(s)),
+ name(s), vtype)
+ WRITE : DecFromIndexer(info(s),index(s),expand-vector(source(s)),
+ name(s), vtype)
INFER : error("Shouldn't be here")
RDWR : error("Haven't implemented RDWR yet")
(s) : map(expand-stmt,s)
@@ -897,8 +893,9 @@ defn expand-accessors (c:Circuit) :
val modules* =
for m in modules(c) map :
match(m) :
- (m:InModule) : InModule(info(m),name(m),ports(m),expand-stmt(body(m)))
(m:ExModule) : m
+ (m:InModule) :
+ InModule(info(m),name(m),ports(m),expand-stmt(body(m)))
;;=============== LOWERING TO GROUND TYPES =============================
; All non-ground (elevated) types (Vectors, Bundles) are expanded out to
@@ -1091,46 +1088,31 @@ defn lower (body:Stmt) -> Stmt :
switch fn ([x,y]) : lgender == x and rgender == y :
[FEMALE,MALE] : Connect(info(s),l*,r*)
[MALE,FEMALE] : Connect(info(s),r*,l*)
- (s:ConnectFromIndexed) : Begin(ls) where :
+ (s:DecToIndexer|DecFromIndexer) : Begin(ls) where :
val ctable = HashTable<Symbol,Vector<EF>>(symbol-hash)
val index* = exp(head $ expand-expr(index(s)))
for e in exps(s) do :
- for (r in expand-expr(e),l in expand-expr(loc(s))) do :
- val n = name(exp(l) as WRef)
+ for (r in expand-expr(e), ntf in generate-entry(name(s),type(s))) do:
+ val n = name(ntf)
val x = get?(ctable,n,Vector<EF>())
add(x,r)
ctable[n] = x
- val ls = for l in expand-expr(loc(s)) map :
- val n = name(exp(l) as WRef)
- val lgender = FEMALE * flip(l)
+ val default-gender = match(s) :
+ (s:DecToIndexer) : FEMALE
+ (s:DecFromIndexer) : MALE
+ val ls = for ntf in generate-entry(name(s),type(s)) map :
+ val n = name(ntf)
+ val dec-gender = default-gender * flip(ntf)
for x in ctable[n] do :
- if (flip(x) * MALE) == lgender : error("Shouldn't be here")
- val rgender = lgender * REVERSE
- val l* = set-gender(exp(l),lgender,flip(l))
- val exps = to-list $ for e in ctable[n] map : set-gender(exp(e),rgender,flip(e))
- switch fn ([x,y]) : lgender == x and rgender == y :
- [FEMALE,MALE] : ConnectFromIndexed(info(s),index*,l*,exps)
- [MALE,FEMALE] : ConnectToIndexed(info(s),index*,exps,l*)
- (s:ConnectToIndexed) : Begin(ls) where :
- val ctable = HashTable<Symbol,Vector<EF>>(symbol-hash)
- val index* = exp(head $ expand-expr(index(s)))
- for e in locs(s) do :
- for (l in expand-expr(e),r in expand-expr(exp(s))) do :
- val n = name(exp(r) as WRef)
- val x = get?(ctable,n,Vector<EF>())
- add(x,l)
- ctable[n] = x
- val ls = for r in expand-expr(exp(s)) map :
- val n = name(exp(r) as WRef)
- val rgender = MALE * flip(r)
- for x in ctable[n] do :
- if (flip(x) * FEMALE) == rgender : error("Shouldn't be here")
- val lgender = rgender * REVERSE
- val r* = set-gender(exp(r),rgender,flip(r))
- val locs = to-list $ for e in ctable[n] map : set-gender(exp(e),lgender,flip(e))
- switch fn ([x,y]) : lgender == x and rgender == y :
- [FEMALE,MALE] : ConnectToIndexed(info(s),index*,locs,r*)
- [MALE,FEMALE] : ConnectFromIndexed(info(s),index*,r*,locs)
+ if (flip(x) * swap(default-gender)) == dec-gender :
+ error("Shouldn't be here")
+ val exps-gender = swap(dec-gender)
+ ;val l* = set-gender(exp(l),lgender,flip(ntf))
+ val exps = to-list $ for e in ctable[n] map :
+ set-gender(exp(e),exps-gender,flip(e))
+ switch fn ([x,y]) : dec-gender == x and exps-gender == y :
+ [FEMALE,MALE] : DecToIndexer(info(s),index*,exps,name(ntf),type(ntf))
+ [MALE,FEMALE] : DecFromIndexer(info(s),index*,exps,name(ntf),type(ntf))
(s:Conditionally) :
Conditionally(info(s),exp(head $ expand-expr(pred(s))),lower-stmt(conseq(s)),lower-stmt(alt(s)))
(s:Begin|EmptyStmt) : map(lower-stmt,s)
@@ -1154,66 +1136,155 @@ defn lower-to-ground (c:Circuit) -> Circuit :
;;=========== CONVERT MULTI CONNECTS to WHEN ================
-; This pass converts ConnectToIndexed and ConnectFromIndexed
+; This pass converts DecFromIndexer and DecToIndexer
; into a series of when statements. TODO what about initial
; values?
-public defstruct ExpandIndexedConnects <: Pass
-public defmethod pass (b:ExpandIndexedConnects) -> (Circuit -> Circuit) : expand-connect-indexed
-public defmethod name (b:ExpandIndexedConnects) -> String : "Expand Indexed Connects"
-public defmethod short-name (b:ExpandIndexedConnects) -> String : "expand-indexed-connects"
-
-defn expand-connect-indexed-stmt (s: Stmt,sh:HashTable<Symbol,Int>) -> Stmt :
- defn equality (e1:Expression,e2:Expression) -> Expression :
- DoPrim(EQUIV-OP,list(e1,e2),List(),UIntType(UnknownWidth()))
- defn get-name (e:Expression) -> Symbol :
- match(e) :
- (e:WRef) : name(e)
- (e:WSubfield) : symbol-join([get-name(exp(e)) `. name(e)])
- (e:WIndex) : symbol-join([get-name(exp(e)) `. to-symbol(value(e))])
- (e) : `T
- match(s) :
- (s:ConnectToIndexed) : Begin $
- if length(locs(s)) == 0 : list(EmptyStmt())
- else :
- val ref = WRef(firrtl-gensym(get-name(index(s)),sh),type(index(s)),NodeKind(),UNKNOWN-GENDER)
- append(
- list(DefNode(info(s),name(ref),index(s)))
- to-list $
- for (i in 0 to false, l in locs(s)) stream : Conditionally(
- info(s),
- equality(ref,UIntValue(BigIntLit(i),UnknownWidth())),
- Connect(info(s),l,exp(s)),
- EmptyStmt()
- )
- )
- (s:ConnectFromIndexed) : Begin $
- if length(exps(s)) == 0 : list(EmptyStmt())
- else :
- val ref = WRef(firrtl-gensym(get-name(index(s)),sh),type(index(s)),NodeKind(),UNKNOWN-GENDER)
- append(
- list(Connect(info(s),loc(s),head(exps(s))),DefNode(info(s),name(ref),index(s)))
- to-list $
- for (i in 1 to false, e in tail(exps(s))) stream : Conditionally(
- info(s),
- equality(ref,UIntValue(BigIntLit(i),UnknownWidth())),
- Connect(info(s),loc(s),e),
- EmptyStmt()
- )
- )
- (s) : map(expand-connect-indexed-stmt{_,sh},s)
-
-defn expand-connect-indexed (m: Module) -> Module :
- match(m) :
- (m:InModule) :
- val sh = get-sym-hash(m,keys(v-keywords))
- InModule(info(m),name(m),ports(m),expand-connect-indexed-stmt(body(m),sh))
- (m:ExModule) : m
+;public defstruct ExpandIndexedConnects <: Pass
+;public defmethod pass (b:ExpandIndexedConnects) -> (Circuit -> Circuit) : expand-connect-indexed
+;public defmethod name (b:ExpandIndexedConnects) -> String : "Expand Indexed Connects"
+;public defmethod short-name (b:ExpandIndexedConnects) -> String : "expand-indexed-connects"
+;
+;defn expand-connect-indexed-stmt (s: Stmt,sh:HashTable<Symbol,Int>) -> Stmt :
+; defn equality (e1:Expression,e2:Expression) -> Expression :
+; DoPrim(EQUIV-OP,list(e1,e2),List(),UIntType(UnknownWidth()))
+; defn get-name (e:Expression) -> Symbol :
+; match(e) :
+; (e:WRef) : name(e)
+; (e:WSubfield) : symbol-join([get-name(exp(e)) `. name(e)])
+; (e:WIndex) : symbol-join([get-name(exp(e)) `. to-symbol(value(e))])
+; (e) : `F
+; match(s) :
+; (s:DecFromIndexer) : Begin $
+; if length(locs(s)) == 0 : list(EmptyStmt())
+; else :
+; val ref = WRef(firrtl-gensym(get-name(index(s)),sh),type(index(s)),NodeKind(),UNKNOWN-GENDER)
+; append(
+; list(DefNode(info(s),name(ref),index(s)))
+; to-list $
+; for (i in 0 to false, l in locs(s)) stream : Conditionally(
+; info(s),
+; equality(ref,UIntValue(BigIntLit(i),UnknownWidth())),
+; Connect(info(s),l,exp(s)),
+; EmptyStmt()
+; )
+; )
+; (s:DecToIndexer) : Begin $
+; if length(exps(s)) == 0 : list(EmptyStmt())
+; else :
+; val ref = WRef(firrtl-gensym(get-name(index(s)),sh),type(index(s)),NodeKind(),UNKNOWN-GENDER)
+; append(
+; list(Connect(info(s),loc(s),head(exps(s))),DefNode(info(s),name(ref),index(s)))
+; to-list $
+; for (i in 1 to false, e in tail(exps(s))) stream : Conditionally(
+; info(s),
+; equality(ref,UIntValue(BigIntLit(i),UnknownWidth())),
+; Connect(info(s),loc(s),e),
+; EmptyStmt()
+; )
+; )
+; (s) : map(expand-connect-indexed-stmt{_,sh},s)
+;
+;defn expand-connect-indexed (m: Module) -> Module :
+; match(m) :
+; (m:InModule) :
+; val sh = get-sym-hash(m,keys(v-keywords))
+; InModule(info(m),name(m),ports(m),expand-connect-indexed-stmt(body(m),sh))
+; (m:ExModule) : m
+;
+;defn expand-connect-indexed (c: Circuit) -> Circuit :
+; Circuit(info(c),modules*, main(c)) where :
+; val modules* =
+; for m in modules(c) map :
+; expand-connect-indexed(m)
+
+;;================ INLINE ACCESSORS =========================
+; This pass inlines all accessors to non-memory vector typed
+; components.
+
+public defstruct InlineIndexed <: Pass
+public defmethod pass (b:InlineIndexed) -> (Circuit -> Circuit) : inline-indexed
+public defmethod name (b:InlineIndexed) -> String : "Inline Indexers"
+public defmethod short-name (b:InlineIndexed) -> String : "inline-indexers"
+
+;------------ Helper Functions --------------
+defn get-name (e:Expression) -> Symbol :
+ match(e) :
+ (e:WRef) : name(e)
+ (e:WSubfield) : symbol-join([get-name(exp(e)) `. name(e)])
+ (e:WIndex) : symbol-join([get-name(exp(e)) `. to-symbol(value(e))])
+ (e) : `F
+
+defn equality (e1:Expression,i:Int) -> Expression :
+ DoPrim(EQUIV-OP,list(e1,UIntValue(BigIntLit(i),UnknownWidth())),
+ List(),UIntType(UnknownWidth()))
+
+
+;------------- Inline Accessors -------------
+
+
+
+defn inline-indexed-m (m:InModule) -> InModule :
+ val sh = get-sym-hash(m,keys(v-keywords))
+ val ih = HashTable<Symbol,Stmt>(symbol-hash)
+ defn inline-indexed-s (s:Stmt) -> Stmt :
+ val stmts = Vector<Stmt>()
+
+ defn expand-indexed (indexer:WRef,indexed-dec:Stmt) -> Expression :
+ val index = index(indexed-dec as DecFromIndexer|DecToIndexer)
+ val index-name = firrtl-gensym(get-name(index),sh)
+ val index-ref = WRef(index-name,type(index),NodeKind(),MALE)
+
+ val replace-name = firrtl-gensym(get-name(indexer),sh)
+ val replace-ref = WRef(replace-name,type(indexer),kind(indexer),gender(indexer))
+
+ add(stmts, DefWire(info(indexed-dec),name(replace-ref),type(replace-ref)))
+ add(stmts, DefNode(info(indexed-dec),index-name,index))
+ match(indexed-dec) :
+ (s:DecFromIndexer) :
+ if (gender(replace-ref) != FEMALE) : error("Shouldn't be here")
+ for (i in 0 to false, e in exps(s)) do :
+ val eq = equality(index-ref,i)
+ val cond = Conditionally(info(s),eq,Connect(info(s),e,replace-ref),EmptyStmt())
+ add(stmts,map(inline-indexed-s,cond))
+ (s:DecToIndexer) :
+ if (gender(replace-ref) != MALE) : error("Shouldn't be here")
+ val cnct = Connect(info(s),replace-ref,head(exps(s)))
+ add(stmts,map(inline-indexed-e,cnct))
+ ;println-all(["exps: " exps(s)])
+ for (i in 1 to false, e in tail(exps(s))) do :
+ val eq = equality(index-ref,i)
+ val cond = Conditionally(info(s),eq,Connect(info(s),replace-ref,e),EmptyStmt())
+ add(stmts,map(inline-indexed-s,cond))
+ replace-ref
+
+ defn inline-indexed-e (e:Expression) -> Expression :
+ match(map(inline-indexed-e,e)) :
+ (e:WRef) :
+ if key?(ih,name(e)) :
+ val indexer = ih[name(e)]
+ expand-indexed(e,indexer)
+ else : e
+ (e) : e
-defn expand-connect-indexed (c: Circuit) -> Circuit :
- Circuit(info(c),modules*, main(c)) where :
- val modules* =
- for m in modules(c) map :
- expand-connect-indexed(m)
+ match(s) :
+ (s:DecFromIndexer|DecToIndexer) :
+ ih[name(s)] = s
+ firrtl-gensym(name(s),sh)
+ add(stmts,EmptyStmt())
+ (s) :
+ val s* = map(inline-indexed-e,s)
+ add(stmts,map(inline-indexed-s,s*))
+ if length(stmts) == 1 : stmts[0]
+ else : Begin(to-list(stmts))
+
+ InModule(info(m),name(m),ports(m),inline-indexed-s(body(m)))
+
+public defn inline-indexed (c:Circuit) -> Circuit :
+ Circuit{info(c),_,main(c)} $
+ for m in modules(c) map :
+ match(m) :
+ (m:ExModule) : m
+ (m:InModule) : inline-indexed-m(m)
;;================ EXPAND WHENS =============================
; This pass does three things: remove last connect semantics,
@@ -1448,7 +1519,9 @@ defn merge-resets (assign:HashTable<Symbol,SymbolicValue>, resets:HashTable<Symb
val table = HashTable<Symbol,SymbolicValue>(symbol-hash)
for i in get-unique-keys(list(assign,resets)) do :
table[i] = match(get?(assign,i,false),get?(resets,i,false)) :
- (a:SymbolicValue,r:SymbolicValue) : SVMux(rsignals[i],r,a)
+ (a:SymbolicValue,r:SymbolicValue) :
+ if r typeof SVNul : a
+ else : SVMux(rsignals[i],r,a)
(a:SymbolicValue,r:False) : a
(a:False,r:SymbolicValue) : SVMux(rsignals[i],r,SVNul())
(a:False,r:False) : error("Shouldn't be here")
@@ -1466,8 +1539,9 @@ defn build-tables (s:Stmt,
flattn[name(s)] = true
(s:DefRegister) :
assign[name(s)] = SVNul()
- flattn[name(s)] = false
+ flattn[name(s)] = true
rsignals[name(s)] = reset(s)
+ resets[name(s)] = SVNul()
(s:DefAccessor) :
assign[name(s)] = SVNul()
flattn[name(s)] = false
@@ -1513,6 +1587,12 @@ defn build-tables (s:Stmt,
for x in assign-a do : println-debug(x)
println-debug("TABLE")
for x in assign do : println-debug(x)
+ println-debug("RESET-C")
+ for x in resets-c do : println-debug(x)
+ println-debug("RESET-A")
+ for x in resets-a do : println-debug(x)
+ println-debug("RESET")
+ for x in resets do : println-debug(x)
(s:Connect|OnReset) :
val key* = match(loc(s)) :
(e:WRef) : name(e)
@@ -2171,6 +2251,33 @@ defn inline-instances (c:Circuit) :
val top = (for m in modules(c) find : name(m) == main(c)) as InModule
Circuit(info(c),list(InModule(info(top),name(top),ports(top),inline-inst(body(top)))),main(c))
+;================= Bring to Real IR ========================
+; Returns a new Circuit with only real IR nodes.
+public defstruct ToRealIR <: Pass
+public defmethod pass (b:ToRealIR) -> (Circuit -> Circuit) : to-real-ir
+public defmethod name (b:ToRealIR) -> String : "Real IR"
+public defmethod short-name (b:ToRealIR) -> String : "real-ir"
+
+defn to-real-ir (c:Circuit) :
+ defn to-exp (e:Expression) :
+ match(map(to-exp,e)) :
+ (e:WRef) : Ref(name(e), type(e))
+ (e:WSubfield) : Subfield(exp(e),name(e),type(e))
+ (e:WIndex) : error("Shouldn't be here")
+ (e) : e
+ defn to-stmt (s:Stmt) :
+ match(map(to-exp,s)) :
+ (e:DecFromIndexer) : error("Shouldn't be here")
+ (e:DecToIndexer) : error("Shouldn't be here")
+ (e) : map(to-stmt,e)
+
+ Circuit(info(c),modules*, main(c)) where :
+ val modules* =
+ for m in modules(c) map :
+ match(m) :
+ (m:InModule) : InModule(info(m),name(m), ports(m), to-stmt(body(m)))
+ (m:ExModule) : m
+
;================= Split Expressions ========================
; Intended to only work on low firrtl
@@ -2181,7 +2288,7 @@ public defmethod short-name (b:SplitExp) -> String : "split-expressions"
defn full-name (e:Expression) -> Symbol|False :
match(e) :
- (e:WRef) : name(e)
+ (e:Ref) : name(e)
(e) : false
defn split-exp (c:Circuit) :
@@ -2195,13 +2302,13 @@ defn split-exp (c:Circuit) :
;all-same-type? = false
;if not all-same-type? :
;val n* =
- ; if n typeof False : firrtl-gensym(`T,sh)
+ ; if n typeof False : firrtl-gensym(`F,sh)
; else : firrtl-gensym(symbol-join([n as Symbol temp-delin]),sh)
val n* =
- if n typeof False : firrtl-gensym(`T,sh)
+ if n typeof False : firrtl-gensym(`F,sh)
else : firrtl-gensym(n as Symbol,sh)
add(v,DefNode(info,n*,map(split-exp-e{_,n,info},e)))
- WRef(n*,type(e),NodeKind(),UNKNOWN-GENDER)
+ Ref(n*,type(e))
;else : e
(e) : map(split-exp-e{_,n,info},e)
defn f (s:Stmt) -> False: split-exp-s(s,v,sh)
@@ -2242,33 +2349,6 @@ defn split-exp (c:Circuit) :
InModule(info(m),name(m),ports(m),Begin(to-list(v)))
(m:ExModule) : m
-;================= Bring to Real IR ========================
-; Returns a new Circuit with only real IR nodes.
-public defstruct ToRealIR <: Pass
-public defmethod pass (b:ToRealIR) -> (Circuit -> Circuit) : to-real-ir
-public defmethod name (b:ToRealIR) -> String : "Real IR"
-public defmethod short-name (b:ToRealIR) -> String : "real-ir"
-
-defn to-real-ir (c:Circuit) :
- defn to-exp (e:Expression) :
- match(map(to-exp,e)) :
- (e:WRef) : Ref(name(e), type(e))
- (e:WSubfield) : Subfield(exp(e),name(e),type(e))
- (e:WIndex) : error("Shouldn't be here")
- (e) : e
- defn to-stmt (s:Stmt) :
- match(map(to-exp,s)) :
- (e:ConnectToIndexed) : error("Shouldn't be here")
- (e:ConnectFromIndexed) : error("Shouldn't be here")
- (e) : map(to-stmt,e)
-
- Circuit(info(c),modules*, main(c)) where :
- val modules* =
- for m in modules(c) map :
- match(m) :
- (m:InModule) : InModule(info(m),name(m), ports(m), to-stmt(body(m)))
- (m:ExModule) : m
-
;================= Special Rename ========================
; Returns a new Circuit with only real IR nodes.
public defstruct SpecialRename <: Pass :
@@ -2381,7 +2461,7 @@ defn pad-widths-e (desired:Long,e:Expression) -> Expression :
else :
map(pad-widths-e{new-desired,_},e)
trim-pad(desired, e*)
- (e:WRef|WSubfield|WIndex) :
+ (e:Ref|Subfield|Index) :
trim-pad(desired, e)
(e:UIntValue) :
val i = int-width!(type(e))
diff --git a/src/main/stanza/verilog.stanza b/src/main/stanza/verilog.stanza
index c4a52d5e..1a495835 100644
--- a/src/main/stanza/verilog.stanza
+++ b/src/main/stanza/verilog.stanza
@@ -155,6 +155,10 @@ defn emit (e:Expression) -> String :
for x in tail(args(e)) do :
v = concat(v, [" ^ " emit(x)])
v
+ (e) :
+ println(["Expression:" e])
+ error("Unknown expression")
+
defn emit-module (m:InModule) :