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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
package firrtl.fuzzer
import com.pholser.junit.quickcheck.From
import edu.berkeley.cs.jqf.fuzz.Fuzz;
import edu.berkeley.cs.jqf.fuzz.JQF;
import firrtl._
import firrtl.annotations.{Annotation, CircuitTarget, ModuleTarget, Target}
import firrtl.ir.Circuit
import firrtl.stage.{FirrtlCircuitAnnotation, InfoModeAnnotation, OutputFileAnnotation, TransformManager}
import firrtl.stage.Forms.{VerilogMinimumOptimized, VerilogOptimized}
import firrtl.stage.phases.WriteEmitted
import firrtl.transforms.ManipulateNames
import firrtl.util.BackendCompilationUtilities
import java.io.{File, FileWriter, PrintWriter, StringWriter}
import java.io.{File, FileWriter}
import org.junit.Assert
import org.junit.runner.RunWith
object FirrtlEquivalenceTestUtils {
private class AddSuffixToTop(suffix: String) extends ManipulateNames[AddSuffixToTop] {
override def manipulate = (a: String, b: Namespace) => Some(b.newName(a + suffix))
override def execute(state: CircuitState): CircuitState = {
val block = (_: Target) => false
val allow: Target => Boolean = {
case _: ModuleTarget => true
case _: CircuitTarget => true
case _: Target => false
}
val renames = RenameMap()
val circuitx = run(state.circuit, renames, block, allow)
state.copy(circuit = circuitx, renames = Some(renames))
}
}
private def writeEmitted(state: CircuitState, outputFile: String): Unit = {
(new WriteEmitted).transform(state.annotations :+ OutputFileAnnotation(outputFile))
}
def firrtlEquivalenceTestPass(
circuit: Circuit,
referenceCompiler: TransformManager,
referenceAnnos: Seq[Annotation],
customCompiler: TransformManager,
customAnnos: Seq[Annotation],
testDir: File,
timesteps: Int = 1): Boolean = {
val baseAnnos = Seq(
InfoModeAnnotation("ignore"),
FirrtlCircuitAnnotation(circuit)
)
testDir.mkdirs()
val customTransforms = Seq(
customCompiler,
new AddSuffixToTop("_custom"),
new VerilogEmitter
)
val customResult = customTransforms.foldLeft(CircuitState(
circuit,
ChirrtlForm,
baseAnnos ++: EmitCircuitAnnotation(classOf[VerilogEmitter]) +: customAnnos
)) { case (state, transform) => transform.transform(state) }
val customName = customResult.circuit.main
val customOutputFile = new File(testDir, s"$customName.v")
writeEmitted(customResult, customOutputFile.toString)
val referenceTransforms = Seq(
referenceCompiler,
new AddSuffixToTop("_reference"),
new MinimumVerilogEmitter
)
val referenceResult = referenceTransforms.foldLeft(CircuitState(
circuit,
ChirrtlForm,
baseAnnos ++: EmitCircuitAnnotation(classOf[MinimumVerilogEmitter]) +: referenceAnnos
)) { case (state, transform) => transform.transform(state) }
val referenceName = referenceResult.circuit.main
val referenceOutputFile = new File(testDir, s"$referenceName.v")
writeEmitted(referenceResult, referenceOutputFile.toString)
BackendCompilationUtilities.yosysExpectSuccess(customName, referenceName, testDir, timesteps)
}
}
@RunWith(classOf[JQF])
class FirrtlEquivalenceTests {
private val lowFirrtlCompiler = new LowFirrtlCompiler()
private val header = "=" * 50 + "\n"
private val footer = header
private def message(c: Circuit, t: Throwable): String = {
val sw = new StringWriter()
val pw = new PrintWriter(sw)
t.printStackTrace(pw)
pw.flush()
header + c.serialize + "\n" + sw.toString + footer
}
private val baseTestDir = new File("fuzzer/test_run_dir")
@Fuzz
def compileSingleModule(@From(value = classOf[FirrtlSingleModuleGenerator]) c: Circuit) = {
val testDir = new File(baseTestDir, f"${c.hashCode}%08x")
testDir.mkdirs()
val fileWriter = new FileWriter(new File(testDir, s"${c.main}.fir"))
fileWriter.write(c.serialize)
fileWriter.close()
val passed = try {
FirrtlEquivalenceTestUtils.firrtlEquivalenceTestPass(
circuit = c,
referenceCompiler = new TransformManager(VerilogMinimumOptimized),
referenceAnnos = Seq(),
customCompiler = new TransformManager(VerilogOptimized),
customAnnos = Seq(),
testDir = testDir
)
} catch {
case e: Throwable => {
Assert.assertTrue(s"exception thrown on input ${testDir}:\n${message(c, e)}", false)
throw e
}
}
if (!passed) {
Assert.assertTrue(
s"not equivalent to reference compiler on input ${testDir}:\n${c.serialize}\n", false)
}
}
}
|
