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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
// See LICENSE for license details.
package firrtlTests
import java.io.{File, FileNotFoundException, FileOutputStream}
import org.scalatest.{FreeSpec, Matchers}
import firrtl.passes.InlineInstances
import firrtl.passes.memlib.{InferReadWrite, ReplSeqMem}
import firrtl._
class DriverSpec extends FreeSpec with Matchers with BackendCompilationUtilities {
"CommonOptions are some simple options available across the chisel3 ecosystem" - {
"CommonOption provide an scopt implementation of an OptionParser" - {
"Options can be set from an Array[String] as is passed into a main" - {
"With no arguments default values come out" in {
val optionsManager = new ExecutionOptionsManager("test")
optionsManager.parse(Array.empty[String]) should be(true)
val commonOptions = optionsManager.commonOptions
commonOptions.topName should be("")
commonOptions.targetDirName should be(".")
}
"top name and target can be set" in {
val optionsManager = new ExecutionOptionsManager("test")
optionsManager.parse(Array("--top-name", "dog", "--target-dir", "a/b/c")) should be(true)
val commonOptions = optionsManager.commonOptions
commonOptions.topName should be("dog")
commonOptions.targetDirName should be("a/b/c")
optionsManager.getBuildFileName(".fir") should be("a/b/c/dog.fir")
optionsManager.getBuildFileName("fir") should be("a/b/c/dog.fir")
}
}
"CommonOptions can create a directory" in {
var dir = new java.io.File("a/b/c")
if(dir.exists()) {
dir.delete()
}
val optionsManager = new ExecutionOptionsManager("test")
optionsManager.parse(Array("--top-name", "dog", "--target-dir", "a/b/c")) should be (true)
val commonOptions = optionsManager.commonOptions
commonOptions.topName should be ("dog")
commonOptions.targetDirName should be ("a/b/c")
optionsManager.makeTargetDir() should be (true)
dir = new java.io.File("a/b/c")
dir.exists() should be (true)
FileUtils.deleteDirectoryHierarchy(commonOptions.targetDirName)
}
}
}
"FirrtlOptions holds option information for the firrtl compiler" - {
"It includes a CommonOptions" in {
val optionsManager = new ExecutionOptionsManager("test")
optionsManager.commonOptions.targetDirName should be (".")
}
"It provides input and output file names based on target" in {
val optionsManager = new ExecutionOptionsManager("test") with HasFirrtlOptions
optionsManager.parse(Array("--top-name", "cat")) should be (true)
val firrtlOptions = optionsManager.firrtlOptions
val inputFileName = optionsManager.getBuildFileName("fir", firrtlOptions.inputFileNameOverride)
inputFileName should be ("./cat.fir")
val outputFileName = optionsManager.getBuildFileName("v", firrtlOptions.outputFileNameOverride)
outputFileName should be ("./cat.v")
}
"input and output file names can be overridden, overrides do not use targetDir" in {
val optionsManager = new ExecutionOptionsManager("test") with HasFirrtlOptions
optionsManager.parse(
Array("--top-name", "cat", "-i", "./bob.fir", "-o", "carol.v")
) should be (true)
val firrtlOptions = optionsManager.firrtlOptions
val inputFileName = optionsManager.getBuildFileName("fir", firrtlOptions.inputFileNameOverride)
inputFileName should be ("./bob.fir")
val outputFileName = optionsManager.getBuildFileName("v", firrtlOptions.outputFileNameOverride)
outputFileName should be ("carol.v")
}
"various annotations can be created from command line, currently:" - {
"inline annotation" in {
val optionsManager = new ExecutionOptionsManager("test") with HasFirrtlOptions
optionsManager.parse(
Array("--inline", "module,module.submodule,module.submodule.instance")
) should be (true)
val firrtlOptions = optionsManager.firrtlOptions
firrtlOptions.annotations.length should be (3)
firrtlOptions.annotations.foreach { annotation =>
annotation.transform shouldBe classOf[InlineInstances]
}
}
"infer-rw annotation" in {
val optionsManager = new ExecutionOptionsManager("test") with HasFirrtlOptions
optionsManager.parse(
Array("--infer-rw", "circuit")
) should be (true)
val firrtlOptions = optionsManager.firrtlOptions
firrtlOptions.annotations.length should be (1)
firrtlOptions.annotations.foreach { annotation =>
annotation.transform shouldBe classOf[InferReadWrite]
}
}
"repl-seq-mem annotation" in {
val optionsManager = new ExecutionOptionsManager("test") with HasFirrtlOptions
optionsManager.parse(
Array("--repl-seq-mem", "-c:circuit1:-i:infile1:-o:outfile1")
) should be (true)
val firrtlOptions = optionsManager.firrtlOptions
firrtlOptions.annotations.length should be (1)
firrtlOptions.annotations.foreach { annotation =>
annotation.transform shouldBe classOf[ReplSeqMem]
}
}
}
}
"Annotations can be read from a file" in {
val optionsManager = new ExecutionOptionsManager("test") with HasFirrtlOptions {
commonOptions = commonOptions.copy(topName = "a.fir")
firrtlOptions = firrtlOptions.copy(
annotationFileNameOverride = "SampleAnnotations"
)
}
val annotationsTestFile = new File(optionsManager.commonOptions.targetDirName, optionsManager.firrtlOptions.annotationFileNameOverride + ".anno")
copyResourceToFile("/annotations/SampleAnnotations.anno", annotationsTestFile)
optionsManager.firrtlOptions.annotations.length should be (0)
Driver.loadAnnotations(optionsManager)
optionsManager.firrtlOptions.annotations.length should be (9)
optionsManager.firrtlOptions.annotations.head.transformClass should be ("firrtl.passes.InlineInstances")
annotationsTestFile.delete()
}
val input =
"""
|circuit Dummy :
| module Dummy :
| input x : UInt<1>
| output y : UInt<1>
| y <= x
""".stripMargin
"Driver produces files with different names depending on the compiler" - {
"compiler changes the default name of the output file" in {
Seq(
"low" -> "./Dummy.lo.fir",
"high" -> "./Dummy.hi.fir",
"verilog" -> "./Dummy.v"
).foreach { case (compilerName, expectedOutputFileName) =>
val manager = new ExecutionOptionsManager("test") with HasFirrtlOptions {
commonOptions = CommonOptions(topName = "Dummy")
firrtlOptions = FirrtlExecutionOptions(firrtlSource = Some(input), compilerName = compilerName)
}
firrtl.Driver.execute(manager)
val file = new File(expectedOutputFileName)
file.exists() should be (true)
file.delete()
}
}
}
}
|
