xref: /XiangShan/build.sc (revision ebd53cdba163c9ff5304107837ccd354892c11ad) 
1/***************************************************************************************
2* Copyright (c) 2024 Beijing Institute of Open Source Chip (BOSC)
3* Copyright (c) 2020-2024 Institute of Computing Technology, Chinese Academy of Sciences
4* Copyright (c) 2020-2021 Peng Cheng Laboratory
5*
6* XiangShan is licensed under Mulan PSL v2.
7* You can use this software according to the terms and conditions of the Mulan PSL v2.
8* You may obtain a copy of Mulan PSL v2 at:
9*          http://license.coscl.org.cn/MulanPSL2
10*
11* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
12* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
13* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
14*
15* See the Mulan PSL v2 for more details.
16***************************************************************************************/
17
18import mill._
19import scalalib._
20import scalafmt._
21import $packages._
22import $file.`rocket-chip`.common
23import $file.`rocket-chip`.cde.common
24import $file.`rocket-chip`.hardfloat.common
25import $file.huancun.common
26import $file.coupledL2.common
27import $file.openLLC.common
28
29/* for publishVersion */
30import $ivy.`de.tototec::de.tobiasroeser.mill.vcs.version::0.4.0`
31import de.tobiasroeser.mill.vcs.version.VcsVersion
32import java.io.{BufferedReader, InputStreamReader}
33import java.time.LocalDateTime
34import java.time.format.DateTimeFormatter
35import java.util.Locale
36import scala.util.matching.Regex
37
38val defaultScalaVersion = "2.13.15"
39val pwd = os.Path(sys.env("MILL_WORKSPACE_ROOT"))
40
41def defaultVersions = Map(
42  "chisel"        -> ivy"org.chipsalliance::chisel:6.6.0",
43  "chisel-plugin" -> ivy"org.chipsalliance:::chisel-plugin:6.6.0",
44  "chiseltest"    -> ivy"edu.berkeley.cs::chiseltest:6.0.0"
45)
46
47trait HasChisel extends SbtModule {
48  def chiselModule: Option[ScalaModule] = None
49
50  def chiselPluginJar: T[Option[PathRef]] = None
51
52  def chiselIvy: Option[Dep] = Some(defaultVersions("chisel"))
53
54  def chiselPluginIvy: Option[Dep] = Some(defaultVersions("chisel-plugin"))
55
56  override def scalaVersion = defaultScalaVersion
57
58  override def scalacOptions = super.scalacOptions() ++
59    Agg("-language:reflectiveCalls", "-Ymacro-annotations", "-Ytasty-reader")
60
61  override def ivyDeps = super.ivyDeps() ++ Agg(chiselIvy.get)
62
63  override def scalacPluginIvyDeps = super.scalacPluginIvyDeps() ++ Agg(chiselPluginIvy.get)
64}
65
66object rocketchip
67  extends $file.`rocket-chip`.common.RocketChipModule
68    with HasChisel {
69  def scalaVersion: T[String] = T(defaultScalaVersion)
70
71  override def millSourcePath = pwd / "rocket-chip"
72
73  def macrosModule = macros
74
75  def hardfloatModule = hardfloat
76
77  def cdeModule = cde
78
79  def mainargsIvy = ivy"com.lihaoyi::mainargs:0.7.0"
80
81  def json4sJacksonIvy = ivy"org.json4s::json4s-jackson:4.0.7"
82
83  object macros extends Macros
84
85  trait Macros
86    extends $file.`rocket-chip`.common.MacrosModule
87      with SbtModule {
88
89    def scalaVersion: T[String] = T(defaultScalaVersion)
90
91    def scalaReflectIvy = ivy"org.scala-lang:scala-reflect:${defaultScalaVersion}"
92  }
93
94  object hardfloat
95    extends $file.`rocket-chip`.hardfloat.common.HardfloatModule with HasChisel {
96
97    def scalaVersion: T[String] = T(defaultScalaVersion)
98
99    override def millSourcePath = pwd / "rocket-chip" / "hardfloat" / "hardfloat"
100
101  }
102
103  object cde
104    extends $file.`rocket-chip`.cde.common.CDEModule with ScalaModule {
105
106    def scalaVersion: T[String] = T(defaultScalaVersion)
107
108    override def millSourcePath = pwd / "rocket-chip" / "cde" / "cde"
109  }
110}
111
112object utility extends HasChisel {
113
114  override def millSourcePath = pwd / "utility"
115
116  override def moduleDeps = super.moduleDeps ++ Seq(
117    rocketchip
118  )
119
120}
121
122object yunsuan extends HasChisel {
123
124  override def millSourcePath = pwd / "yunsuan"
125
126}
127
128object huancun extends $file.huancun.common.HuanCunModule with HasChisel {
129
130  override def millSourcePath = pwd / "huancun"
131
132  def rocketModule: ScalaModule = rocketchip
133
134  def utilityModule: ScalaModule = utility
135
136}
137
138object coupledL2 extends $file.coupledL2.common.CoupledL2Module with HasChisel {
139
140  override def millSourcePath = pwd / "coupledL2"
141
142  def rocketModule: ScalaModule = rocketchip
143
144  def utilityModule: ScalaModule = utility
145
146  def huancunModule: ScalaModule = huancun
147
148}
149
150object openNCB extends SbtModule with HasChisel {
151
152  override def millSourcePath = pwd / "openLLC" / "openNCB"
153
154  override def moduleDeps = super.moduleDeps ++ Seq(
155    rocketchip
156  )
157
158}
159
160object openLLC extends $file.openLLC.common.OpenLLCModule with HasChisel {
161
162  override def millSourcePath = pwd / "openLLC"
163
164  def coupledL2Module: ScalaModule = coupledL2
165
166  def rocketModule: ScalaModule = rocketchip
167
168  def utilityModule: ScalaModule = utility
169
170  def openNCBModule: ScalaModule = openNCB
171
172}
173
174object difftest extends HasChisel {
175
176  override def millSourcePath = pwd / "difftest"
177
178  object test extends SbtTests with TestModule.ScalaTest {
179    override def sources = T.sources {
180      super.sources() ++ Seq(PathRef(this.millSourcePath / "src" / "generator" / "chisel"))
181    }
182  }
183
184}
185
186object fudian extends HasChisel {
187
188  override def millSourcePath = pwd / "fudian"
189
190}
191
192object macros extends ScalaModule {
193
194  override def millSourcePath = pwd / "macros"
195
196  override def scalaVersion: T[String] = T(defaultScalaVersion)
197
198  override def ivyDeps = super.ivyDeps() ++ Agg(ivy"org.scala-lang:scala-reflect:${defaultScalaVersion}")
199
200  def scalaReflectIvy = ivy"org.scala-lang:scala-reflect:${defaultScalaVersion}"
201}
202
203// extends this trait to use XiangShan in other projects
204trait XiangShanModule extends ScalaModule {
205
206  def rocketModule: ScalaModule
207
208  def difftestModule: ScalaModule
209
210  def huancunModule: ScalaModule
211
212  def coupledL2Module: ScalaModule
213
214  def openLLCModule: ScalaModule
215
216  def fudianModule: ScalaModule
217
218  def utilityModule: ScalaModule
219
220  def yunsuanModule: ScalaModule
221
222  def macrosModule: ScalaModule
223
224  override def moduleDeps = super.moduleDeps ++ Seq(
225    rocketModule,
226    difftestModule,
227    huancunModule,
228    coupledL2Module,
229    openLLCModule,
230    yunsuanModule,
231    fudianModule,
232    utilityModule,
233    macrosModule,
234  )
235
236  val resourcesPATH = pwd.toString() + "/src/main/resources"
237  val envPATH = sys.env("PATH") + ":" + resourcesPATH
238
239  override def forkEnv = Map("PATH" -> envPATH)
240}
241
242object xiangshan extends XiangShanModule with HasChisel with ScalafmtModule {
243
244  override def millSourcePath = pwd
245
246  def rocketModule = rocketchip
247
248  def difftestModule = difftest
249
250  def huancunModule = huancun
251
252  def coupledL2Module = coupledL2
253
254  def openLLCModule = openLLC
255
256  def fudianModule = fudian
257
258  def utilityModule = utility
259
260  def yunsuanModule = yunsuan
261
262  def macrosModule = macros
263
264  // properties may be changed by user. Use `Task.Input` here.
265  def forkArgsTask = Task.Input {
266    Seq(s"-Xmx${sys.props.getOrElse("jvm-xmx", "40G")}", s"-Xss${sys.props.getOrElse("jvm-xss", "256m")}")
267  }
268
269  override def forkArgs = forkArgsTask()
270
271  override def ivyDeps = super.ivyDeps() ++ Agg(
272    defaultVersions("chiseltest"),
273    ivy"io.circe::circe-yaml:1.15.0",
274    ivy"io.circe::circe-generic-extras:0.14.4"
275  )
276
277  override def scalacOptions = super.scalacOptions() ++ Agg("-deprecation", "-feature")
278
279  def publishVersion: T[String] = VcsVersion.vcsState().format(
280    revHashDigits = 8,
281    dirtyHashDigits = 0,
282    commitCountPad = -1,
283    countSep = "",
284    tagModifier = (tag: String) => "[Rr]elease.*".r.findFirstMatchIn(tag) match {
285      case Some(_) => "Kunminghu-Release-" + LocalDateTime.now().format(
286                                 DateTimeFormatter.ofPattern("MMM-dd-yyyy").withLocale(new Locale("en")))
287      case None => "Kunminghu-dev"
288    },
289    /* add "username, buildhost, buildtime" for non-release version */
290    untaggedSuffix = " (%s@%s) # %s".format(
291      System.getProperty("user.name"),
292      java.net.InetAddress.getLocalHost().getHostName(),
293      LocalDateTime.now().format(DateTimeFormatter.ofPattern("MMM dd hh:mm:ss yyyy").withLocale(new Locale("en")))),
294  )
295
296  // gitStatus changes frequently and unpredictably. Use `Task.Input` here.
297  def gitStatus: T[String] = Task.Input {
298    val gitRevParseBuilder = new ProcessBuilder("git", "rev-parse", "HEAD")
299    val gitRevParseProcess = gitRevParseBuilder.start()
300    val shaReader = new BufferedReader(new InputStreamReader(gitRevParseProcess.getInputStream))
301    val sha = shaReader.readLine()
302
303    val gitStatusBuilder = new ProcessBuilder("git", "status", "-uno", "--porcelain")
304    val gitStatusProcess = gitStatusBuilder.start()
305    val gitStatusReader = new BufferedReader(new InputStreamReader(gitStatusProcess.getInputStream))
306    val status = gitStatusReader.readLine()
307    val gitDirty = if (status == null) 0 else 1
308
309    val str =
310      s"""|SHA=$sha
311          |dirty=$gitDirty
312          |""".stripMargin
313    str
314  }
315
316  def packDifftestResources(destDir: os.Path): Unit = {
317    // package difftest source as resources, only git tracked files were collected
318    val difftest_srcs = os.proc("git", "ls-files").call(cwd = pwd / "difftest").out
319                          .text().split("\n").filter(_.nonEmpty).toSeq
320                          .map(os.RelPath(_))
321    difftest_srcs.foreach { f =>
322      os.copy(pwd / "difftest" / f, destDir / "difftest-src" / f, createFolders = true)
323    }
324
325    // package ready-to-run binary as resources
326    val ready_to_run = Seq("riscv64-nemu-interpreter-dual-so",
327                           "riscv64-nemu-interpreter-so",
328                           "riscv64-spike-so")
329    ready_to_run.foreach { f =>
330      os.copy(pwd / "ready-to-run" / f, destDir / "ready-to-run" / f, createFolders = true)
331    }
332  }
333
334  override def resources = T.sources {
335    os.write(T.dest / "publishVersion", publishVersion())
336    os.write(T.dest / "gitStatus", gitStatus())
337    os.write(T.dest / "gitModules", os.proc("git", "submodule", "status").call().out.text())
338    packDifftestResources(T.dest)
339    super.resources() ++ Seq(PathRef(T.dest))
340  }
341
342  object test extends SbtTests with TestModule.ScalaTest {
343    override def moduleDeps = super.moduleDeps ++ Seq(
344      difftestModule.test
345    )
346
347    override def forkArgs = forkArgsTask()
348
349    override def scalacOptions = super.scalacOptions() ++ Agg("-deprecation", "-feature")
350
351    val resourcesPATH = pwd.toString() + "/src/main/resources"
352    val envPATH = sys.env("PATH") + ":" + resourcesPATH
353
354    override def forkEnv = Map("PATH" -> envPATH)
355  }
356}
357