1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
// See LICENSE for license details.
package chisel.internal.firrtl
import chisel._
import chisel.internal.sourceinfo.{NoSourceInfo, SourceLine}
private[chisel] object Emitter {
def emit(circuit: Circuit): String = new Emitter(circuit).toString
}
private class Emitter(circuit: Circuit) {
override def toString: String = res.toString
private def emitPort(e: Port): String =
s"${e.dir} ${e.id.getRef.name} : ${e.id.toType}"
private def emit(e: Command, ctx: Component): String = {
val firrtlLine = e match {
case e: DefPrim[_] => s"node ${e.name} = ${e.op.name}(${e.args.map(_.fullName(ctx)).mkString(", ")})"
case e: DefWire => s"wire ${e.name} : ${e.id.toType}"
case e: DefReg => s"reg ${e.name} : ${e.id.toType}, ${e.clock.fullName(ctx)}"
case e: DefRegInit => s"reg ${e.name} : ${e.id.toType}, ${e.clock.fullName(ctx)} with : (reset => (${e.reset.fullName(ctx)}, ${e.init.fullName(ctx)}))"
case e: DefMemory => s"cmem ${e.name} : ${e.t.toType}[${e.size}]"
case e: DefSeqMemory => s"smem ${e.name} : ${e.t.toType}[${e.size}]"
case e: DefMemPort[_] => s"${e.dir} mport ${e.name} = ${e.source.fullName(ctx)}[${e.index.fullName(ctx)}], ${e.clock.fullName(ctx)}"
case e: Connect => s"${e.loc.fullName(ctx)} <= ${e.exp.fullName(ctx)}"
case e: BulkConnect => s"${e.loc1.fullName(ctx)} <- ${e.loc2.fullName(ctx)}"
case e: Stop => s"stop(${e.clk.fullName(ctx)}, UInt<1>(1), ${e.ret})"
case e: Printf => s"""printf(${e.clk.fullName(ctx)}, UInt<1>(1), "${e.format}"${e.ids.map(_.fullName(ctx)).fold(""){_ + ", " + _}})"""
case e: DefInvalid => s"${e.arg.fullName(ctx)} is invalid"
case e: DefInstance => {
val modName = moduleMap.get(e.id.name).get
s"inst ${e.name} of $modName"
}
case w: WhenBegin =>
indent()
s"when ${w.pred.fullName(ctx)} :"
case _: WhenEnd =>
unindent()
s"skip"
}
e.sourceInfo match {
case SourceLine(filename, line, col) => s"${firrtlLine} @[${filename} ${line}:${col}] "
case _: NoSourceInfo => firrtlLine
}
}
// Map of Module FIRRTL definition to FIRRTL name, if it has been emitted already.
private val defnMap = collection.mutable.HashMap[String, String]()
// Map of Component name to FIRRTL id.
private val moduleMap = collection.mutable.HashMap[String, String]()
/** Generates the FIRRTL module definition with a specified name.
*/
private def moduleDefn(m: Component, name: String): String = {
val body = new StringBuilder
m.id match {
case _: BlackBox => body ++= newline + s"extmodule $name : "
case _: Module => body ++= newline + s"module $name : "
}
withIndent {
for (p <- m.ports)
body ++= newline + emitPort(p)
body ++= newline
m.id match {
case _: BlackBox =>
// TODO: BlackBoxes should be empty, but funkiness in Module() means
// it's not for now. Eventually, this should assert out.
case _: Module => for (cmd <- m.commands) {
body ++= newline + emit(cmd, m)
}
}
body ++= newline
}
body.toString()
}
/** Returns the FIRRTL declaration and body of a module, or nothing if it's a
* duplicate of something already emitted (on the basis of simple string
* matching).
*/
private def emit(m: Component): String = {
// Generate the body.
val moduleName = m.id.getClass.getName.split('.').last
val defn = moduleDefn(m, moduleName)
defnMap get defn match {
case Some(deduplicatedName) =>
moduleMap(m.name) = deduplicatedName
""
case None =>
require(!(moduleMap contains m.name),
"emitting module with same name but different contents")
moduleMap(m.name) = m.name
defnMap(defn) = m.name
moduleDefn(m, m.name)
}
}
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() }
private val res = new StringBuilder(s"circuit ${circuit.name} : ")
withIndent { circuit.components.foreach(c => res ++= emit(c)) }
res ++= newline
}
|