xref: /XiangShan/build.sc (revision 26f0fb0db89b6c9397a7c9ab310013ea83ec4185)
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 $file.`rocket-chip`.common
21import $file.`rocket-chip`.cde.common
22import $file.`rocket-chip`.hardfloat.build
23import $file.huancun.common
24import $file.coupledL2.common
25import $file.openLLC.common
26
27/* for publishVersion */
28import $ivy.`de.tototec::de.tobiasroeser.mill.vcs.version::0.4.0`
29import de.tobiasroeser.mill.vcs.version.VcsVersion
30import java.time.LocalDateTime
31import java.time.format.DateTimeFormatter
32import java.util.Locale
33import scala.util.matching.Regex
34
35val defaultScalaVersion = "2.13.14"
36
37def defaultVersions = Map(
38  "chisel"        -> ivy"org.chipsalliance::chisel:6.5.0",
39  "chisel-plugin" -> ivy"org.chipsalliance:::chisel-plugin:6.5.0",
40  "chiseltest"    -> ivy"edu.berkeley.cs::chiseltest:6.0.0"
41)
42
43trait HasChisel extends SbtModule {
44  def chiselModule: Option[ScalaModule] = None
45
46  def chiselPluginJar: T[Option[PathRef]] = None
47
48  def chiselIvy: Option[Dep] = Some(defaultVersions("chisel"))
49
50  def chiselPluginIvy: Option[Dep] = Some(defaultVersions("chisel-plugin"))
51
52  override def scalaVersion = defaultScalaVersion
53
54  override def scalacOptions = super.scalacOptions() ++
55    Agg("-language:reflectiveCalls", "-Ymacro-annotations", "-Ytasty-reader")
56
57  override def ivyDeps = super.ivyDeps() ++ Agg(chiselIvy.get)
58
59  override def scalacPluginIvyDeps = super.scalacPluginIvyDeps() ++ Agg(chiselPluginIvy.get)
60}
61
62object rocketchip
63  extends millbuild.`rocket-chip`.common.RocketChipModule
64    with HasChisel {
65  def scalaVersion: T[String] = T(defaultScalaVersion)
66
67  override def millSourcePath = os.pwd / "rocket-chip"
68
69  def macrosModule = macros
70
71  def hardfloatModule = hardfloat
72
73  def cdeModule = cde
74
75  def mainargsIvy = ivy"com.lihaoyi::mainargs:0.7.0"
76
77  def json4sJacksonIvy = ivy"org.json4s::json4s-jackson:4.0.7"
78
79  object macros extends Macros
80
81  trait Macros
82    extends millbuild.`rocket-chip`.common.MacrosModule
83      with SbtModule {
84
85    def scalaVersion: T[String] = T(defaultScalaVersion)
86
87    def scalaReflectIvy = ivy"org.scala-lang:scala-reflect:${defaultScalaVersion}"
88  }
89
90  object hardfloat
91    extends millbuild.`rocket-chip`.hardfloat.common.HardfloatModule with HasChisel {
92
93    def scalaVersion: T[String] = T(defaultScalaVersion)
94
95    override def millSourcePath = os.pwd / "rocket-chip" / "hardfloat" / "hardfloat"
96
97  }
98
99  object cde
100    extends millbuild.`rocket-chip`.cde.common.CDEModule with ScalaModule {
101
102    def scalaVersion: T[String] = T(defaultScalaVersion)
103
104    override def millSourcePath = os.pwd / "rocket-chip" / "cde" / "cde"
105  }
106}
107
108object utility extends HasChisel {
109
110  override def millSourcePath = os.pwd / "utility"
111
112  override def moduleDeps = super.moduleDeps ++ Seq(
113    rocketchip
114  )
115
116}
117
118object yunsuan extends HasChisel {
119
120  override def millSourcePath = os.pwd / "yunsuan"
121
122}
123
124object huancun extends millbuild.huancun.common.HuanCunModule with HasChisel {
125
126  override def millSourcePath = os.pwd / "huancun"
127
128  def rocketModule: ScalaModule = rocketchip
129
130  def utilityModule: ScalaModule = utility
131
132}
133
134object coupledL2 extends millbuild.coupledL2.common.CoupledL2Module with HasChisel {
135
136  override def millSourcePath = os.pwd / "coupledL2"
137
138  def rocketModule: ScalaModule = rocketchip
139
140  def utilityModule: ScalaModule = utility
141
142  def huancunModule: ScalaModule = huancun
143
144}
145
146object openLLC extends millbuild.openLLC.common.OpenLLCModule with HasChisel {
147
148  override def millSourcePath = os.pwd / "openLLC"
149
150  def coupledL2Module: ScalaModule = coupledL2
151
152  def rocketModule: ScalaModule = rocketchip
153
154  def utilityModule: ScalaModule = utility
155}
156
157object difftest extends HasChisel {
158
159  override def millSourcePath = os.pwd / "difftest"
160
161}
162
163object fudian extends HasChisel {
164
165  override def millSourcePath = os.pwd / "fudian"
166
167}
168
169object macros extends ScalaModule {
170
171  override def millSourcePath = os.pwd / "macros"
172
173  override def scalaVersion: T[String] = T(defaultScalaVersion)
174
175  override def ivyDeps = super.ivyDeps() ++ Agg(ivy"org.scala-lang:scala-reflect:${defaultScalaVersion}")
176
177  def scalaReflectIvy = ivy"org.scala-lang:scala-reflect:${defaultScalaVersion}"
178}
179
180// extends this trait to use XiangShan in other projects
181trait XiangShanModule extends ScalaModule {
182
183  def rocketModule: ScalaModule
184
185  def difftestModule: ScalaModule
186
187  def huancunModule: ScalaModule
188
189  def coupledL2Module: ScalaModule
190
191  def openLLCModule: ScalaModule
192
193  def fudianModule: ScalaModule
194
195  def utilityModule: ScalaModule
196
197  def yunsuanModule: ScalaModule
198
199  def macrosModule: ScalaModule
200
201  override def moduleDeps = super.moduleDeps ++ Seq(
202    rocketModule,
203    difftestModule,
204    huancunModule,
205    coupledL2Module,
206    openLLCModule,
207    yunsuanModule,
208    fudianModule,
209    utilityModule,
210    macrosModule,
211  )
212
213  val resourcesPATH = os.pwd.toString() + "/src/main/resources"
214  val envPATH = sys.env("PATH") + ":" + resourcesPATH
215
216  override def forkEnv = Map("PATH" -> envPATH)
217}
218
219object xiangshan extends XiangShanModule with HasChisel {
220
221  override def millSourcePath = os.pwd
222
223  def rocketModule = rocketchip
224
225  def difftestModule = difftest
226
227  def huancunModule = huancun
228
229  def coupledL2Module = coupledL2
230
231  def openLLCModule = openLLC
232
233  def fudianModule = fudian
234
235  def utilityModule = utility
236
237  def yunsuanModule = yunsuan
238
239  def macrosModule = macros
240
241  override def forkArgs = Seq("-Xmx40G", "-Xss256m")
242
243  override def ivyDeps = super.ivyDeps() ++ Agg(
244    defaultVersions("chiseltest"),
245  )
246
247  override def scalacOptions = super.scalacOptions() ++ Agg("-deprecation", "-feature")
248
249  def publishVersion: T[String] = VcsVersion.vcsState().format(
250    revHashDigits = 8,
251    dirtyHashDigits = 0,
252    commitCountPad = -1,
253    countSep = "",
254    tagModifier = (tag: String) => "[Rr]elease.*".r.findFirstMatchIn(tag) match {
255      case Some(_) => "Kunminghu-Release-" + LocalDateTime.now().format(
256                                 DateTimeFormatter.ofPattern("MMM-dd-yyyy").withLocale(new Locale("en")))
257      case None => "Kunminghu-dev"
258    },
259    /* add "username, buildhost, buildtime" for non-release version */
260    untaggedSuffix = " (%s@%s) # %s".format(
261      System.getProperty("user.name"),
262      java.net.InetAddress.getLocalHost().getHostName(),
263      LocalDateTime.now().format(DateTimeFormatter.ofPattern("MMM dd hh:mm:ss yyyy").withLocale(new Locale("en")))),
264  )
265
266  override def resources = T.sources {
267    os.write(T.dest / "publishVersion", publishVersion())
268    super.resources() ++ Seq(PathRef(T.dest))
269  }
270
271  object test extends SbtModuleTests with TestModule.ScalaTest {
272    override def forkArgs = Seq("-Xmx40G", "-Xss256m")
273
274    override def ivyDeps = super.ivyDeps() ++ Agg(
275      defaultVersions("chiseltest")
276    )
277
278    override def scalacOptions = super.scalacOptions() ++ Agg("-deprecation", "-feature")
279
280    val resourcesPATH = os.pwd.toString() + "/src/main/resources"
281    val envPATH = sys.env("PATH") + ":" + resourcesPATH
282
283    override def forkEnv = Map("PATH" -> envPATH)
284  }
285}
286