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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
// SPDX-License-Identifier: Apache-2.0
enablePlugins(SiteScaladocPlugin)
def javacOptionsVersion(scalaVersion: String): Seq[String] = {
Seq() ++ {
// Scala 2.12 requires Java 8, but we continue to generate
// Java 7 compatible code until we need Java 8 features
// for compatibility with old clients.
CrossVersion.partialVersion(scalaVersion) match {
case Some((2, scalaMajor: Long)) if scalaMajor < 12 =>
Seq("-source", "1.7", "-target", "1.7")
case _ =>
Seq("-source", "1.8", "-target", "1.8")
}
}
}
lazy val commonSettings = Seq(
organization := "edu.berkeley.cs",
name := "firrtl",
version := "1.5-SNAPSHOT",
scalaVersion := "2.12.12",
crossScalaVersions := Seq("2.13.2", "2.12.12", "2.11.12"),
addCompilerPlugin(scalafixSemanticdb),
scalacOptions := Seq(
"-deprecation",
"-unchecked",
"-language:reflectiveCalls",
"-language:existentials",
"-language:implicitConversions",
"-Yrangepos", // required by SemanticDB compiler plugin
),
javacOptions ++= javacOptionsVersion(scalaVersion.value),
libraryDependencies ++= Seq(
"org.scala-lang" % "scala-reflect" % scalaVersion.value,
"org.scalatest" %% "scalatest" % "3.2.0" % "test",
"org.scalatestplus" %% "scalacheck-1-14" % "3.1.3.0" % "test",
"com.github.scopt" %% "scopt" % "3.7.1",
"net.jcazevedo" %% "moultingyaml" % "0.4.2",
"org.json4s" %% "json4s-native" % "3.6.9",
"org.apache.commons" % "commons-text" % "1.8"
),
// starting with scala 2.13 the parallel collections are separate from the standard library
libraryDependencies ++= {
CrossVersion.partialVersion(scalaVersion.value) match {
case Some((2, major)) if major <= 12 => Seq()
case _ => Seq("org.scala-lang.modules" %% "scala-parallel-collections" % "0.2.0")
}
},
resolvers ++= Seq(
Resolver.sonatypeRepo("snapshots"),
Resolver.sonatypeRepo("releases")
)
)
lazy val protobufSettings = Seq(
sourceDirectory in ProtobufConfig := baseDirectory.value / "src" / "main" / "proto",
protobufRunProtoc in ProtobufConfig := (args =>
com.github.os72.protocjar.Protoc.runProtoc("-v351" +: args.toArray)
)
)
lazy val assemblySettings = Seq(
assemblyJarName in assembly := "firrtl.jar",
test in assembly := {},
assemblyOutputPath in assembly := file("./utils/bin/firrtl.jar")
)
lazy val testAssemblySettings = Seq(
test in (Test, assembly) := {}, // Ditto above
assemblyMergeStrategy in (Test, assembly) := {
case PathList("firrtlTests", xs @ _*) => MergeStrategy.discard
case x =>
val oldStrategy = (assemblyMergeStrategy in (Test, assembly)).value
oldStrategy(x)
},
assemblyJarName in (Test, assembly) := s"firrtl-test.jar",
assemblyOutputPath in (Test, assembly) := file("./utils/bin/" + (Test / assembly / assemblyJarName).value)
)
lazy val antlrSettings = Seq(
antlr4GenVisitor in Antlr4 := true,
antlr4GenListener in Antlr4 := false,
antlr4PackageName in Antlr4 := Option("firrtl.antlr"),
antlr4Version in Antlr4 := "4.7.1",
javaSource in Antlr4 := (sourceManaged in Compile).value
)
lazy val publishSettings = Seq(
publishMavenStyle := true,
publishArtifact in Test := false,
pomIncludeRepository := { x => false },
// Don't add 'scm' elements if we have a git.remoteRepo definition,
// but since we don't (with the removal of ghpages), add them in below.
pomExtra := <url>http://chisel.eecs.berkeley.edu/</url>
<licenses>
<license>
<name>apache_v2</name>
<url>https://opensource.org/licenses/Apache-2.0</url>
<distribution>repo</distribution>
</license>
</licenses>
<scm>
<url>https://github.com/freechipsproject/firrtl.git</url>
<connection>scm:git:github.com/freechipsproject/firrtl.git</connection>
</scm>
<developers>
<developer>
<id>jackbackrack</id>
<name>Jonathan Bachrach</name>
<url>http://www.eecs.berkeley.edu/~jrb/</url>
</developer>
</developers>,
publishTo := {
val v = version.value
val nexus = "https://oss.sonatype.org/"
if (v.trim.endsWith("SNAPSHOT")) {
Some("snapshots" at nexus + "content/repositories/snapshots")
} else {
Some("releases" at nexus + "service/local/staging/deploy/maven2")
}
}
)
def scalacDocOptionsVersion(scalaVersion: String): Seq[String] = {
Seq() ++ {
// If we're building with Scala > 2.11, enable the compile option
// to flag warnings as errors. This must be disabled for 2.11 since
// references to the Java class library from Java 9 on generate warnings.
// https://github.com/scala/bug/issues/10675
CrossVersion.partialVersion(scalaVersion) match {
case Some((2, scalaMajor: Long)) if scalaMajor < 12 => Seq()
case _ => Seq("-Xfatal-warnings")
}
}
}
lazy val docSettings = Seq(
doc in Compile := (doc in ScalaUnidoc).value,
autoAPIMappings := true,
scalacOptions in Compile in doc ++= Seq(
"-feature",
"-diagrams",
"-diagrams-max-classes", "25",
"-doc-version", version.value,
"-doc-title", name.value,
"-doc-root-content", baseDirectory.value+"/root-doc.txt",
"-sourcepath", (baseDirectory in ThisBuild).value.toString,
"-doc-source-url",
{
val branch =
if (version.value.endsWith("-SNAPSHOT")) {
"master"
} else {
s"v${version.value}"
}
s"https://github.com/freechipsproject/firrtl/tree/$branch€{FILE_PATH}.scala"
}
) ++ scalacDocOptionsVersion(scalaVersion.value)
)
lazy val firrtl = (project in file("."))
.enablePlugins(ProtobufPlugin)
.enablePlugins(ScalaUnidocPlugin)
.enablePlugins(Antlr4Plugin)
.settings(
fork := true,
Test / testForkedParallel := true
)
.settings(commonSettings)
.settings(protobufSettings)
.settings(antlrSettings)
.settings(assemblySettings)
.settings(inConfig(Test)(baseAssemblySettings))
.settings(testAssemblySettings)
.settings(publishSettings)
.settings(docSettings)
.enablePlugins(BuildInfoPlugin)
.settings(
buildInfoPackage := name.value,
buildInfoUsePackageAsPath := true,
buildInfoKeys := Seq[BuildInfoKey](buildInfoPackage, version, scalaVersion, sbtVersion)
)
lazy val benchmark = (project in file("benchmark"))
.dependsOn(firrtl)
.settings(
assemblyJarName in assembly := "firrtl-benchmark.jar",
test in assembly := {},
assemblyOutputPath in assembly := file("./utils/bin/firrtl-benchmark.jar")
)
val JQF_VERSION = "1.5"
lazy val jqf = (project in file("jqf"))
.settings(
libraryDependencies ++= Seq(
"edu.berkeley.cs.jqf" % "jqf-fuzz" % JQF_VERSION,
"edu.berkeley.cs.jqf" % "jqf-instrument" % JQF_VERSION,
"com.github.scopt" %% "scopt" % "3.7.1",
)
)
lazy val jqfFuzz = sbt.inputKey[Unit]("input task that runs the firrtl.jqf.JQFFuzz main method")
lazy val jqfRepro = sbt.inputKey[Unit]("input task that runs the firrtl.jqf.JQFRepro main method")
lazy val testClassAndMethodParser = {
import sbt.complete.DefaultParsers._
val spaces = SpaceClass.+.string
val testClassName = token(Space) ~> token(charClass(c => isScalaIDChar(c) || (c == '.')).+.string, "<test class name>")
val testMethod = spaces ~> token(charClass(isScalaIDChar).+.string, "<test method name>")
val rest = spaces.? ~> token(any.*.string, "<other args>")
(testClassName ~ testMethod ~ rest).map {
case ((a, b), c) => (a, b, c)
}
}
lazy val fuzzer = (project in file("fuzzer"))
.dependsOn(firrtl)
.settings(
libraryDependencies ++= Seq(
"com.pholser" % "junit-quickcheck-core" % "0.8",
"com.pholser" % "junit-quickcheck-generators" % "0.8",
"edu.berkeley.cs.jqf" % "jqf-fuzz" % JQF_VERSION,
"org.scalacheck" %% "scalacheck" % "1.14.3" % Test
),
jqfFuzz := (Def.inputTaskDyn {
val (testClassName, testMethod, otherArgs) = testClassAndMethodParser.parsed
val outputDir = target.in(Compile).value / "JQF" / testClassName / testMethod
val classpath = (Compile / fullClasspathAsJars).toTask.value.files.mkString(":")
(jqf/runMain).in(Compile).toTask(
s" firrtl.jqf.JQFFuzz " +
s"--testClassName $testClassName " +
s"--testMethod $testMethod " +
s"--classpath $classpath " +
s"--outputDirectory $outputDir " +
otherArgs)
}).evaluated,
jqfRepro := (Def.inputTaskDyn {
val (testClassName, testMethod, otherArgs) = testClassAndMethodParser.parsed
val classpath = (Compile / fullClasspathAsJars).toTask.value.files.mkString(":")
(jqf/runMain).in(Compile).toTask(
s" firrtl.jqf.JQFRepro " +
s"--testClassName $testClassName " +
s"--testMethod $testMethod " +
s"--classpath $classpath " +
otherArgs)
}).evaluated,
)
|
