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 override def ivyDeps = super.ivyDeps() ++ Agg( 121 ivy"com.lihaoyi::sourcecode:0.4.2", 122 ) 123 124} 125 126object yunsuan extends HasChisel { 127 128 override def millSourcePath = pwd / "yunsuan" 129 130} 131 132object huancun extends $file.huancun.common.HuanCunModule with HasChisel { 133 134 override def millSourcePath = pwd / "huancun" 135 136 def rocketModule: ScalaModule = rocketchip 137 138 def utilityModule: ScalaModule = utility 139 140} 141 142object coupledL2 extends $file.coupledL2.common.CoupledL2Module with HasChisel { 143 144 override def millSourcePath = pwd / "coupledL2" 145 146 def rocketModule: ScalaModule = rocketchip 147 148 def utilityModule: ScalaModule = utility 149 150 def huancunModule: ScalaModule = huancun 151 152} 153 154object openNCB extends SbtModule with HasChisel { 155 156 override def millSourcePath = pwd / "openLLC" / "openNCB" 157 158 override def moduleDeps = super.moduleDeps ++ Seq( 159 rocketchip 160 ) 161 162} 163 164object openLLC extends $file.openLLC.common.OpenLLCModule with HasChisel { 165 166 override def millSourcePath = pwd / "openLLC" 167 168 def coupledL2Module: ScalaModule = coupledL2 169 170 def rocketModule: ScalaModule = rocketchip 171 172 def utilityModule: ScalaModule = utility 173 174 def openNCBModule: ScalaModule = openNCB 175 176} 177 178object difftest extends HasChisel { 179 180 override def millSourcePath = pwd / "difftest" 181 182 object test extends SbtTests with TestModule.ScalaTest { 183 override def sources = T.sources { 184 super.sources() ++ Seq(PathRef(this.millSourcePath / "src" / "generator" / "chisel")) 185 } 186 } 187 188} 189 190object fudian extends HasChisel { 191 192 override def millSourcePath = pwd / "fudian" 193 194} 195 196object macros extends ScalaModule { 197 198 override def millSourcePath = pwd / "macros" 199 200 override def scalaVersion: T[String] = T(defaultScalaVersion) 201 202 override def ivyDeps = super.ivyDeps() ++ Agg(ivy"org.scala-lang:scala-reflect:${defaultScalaVersion}") 203 204 def scalaReflectIvy = ivy"org.scala-lang:scala-reflect:${defaultScalaVersion}" 205} 206 207// extends this trait to use XiangShan in other projects 208trait XiangShanModule extends ScalaModule { 209 210 def rocketModule: ScalaModule 211 212 def difftestModule: ScalaModule 213 214 def huancunModule: ScalaModule 215 216 def coupledL2Module: ScalaModule 217 218 def openLLCModule: ScalaModule 219 220 def fudianModule: ScalaModule 221 222 def utilityModule: ScalaModule 223 224 def yunsuanModule: ScalaModule 225 226 def macrosModule: ScalaModule 227 228 override def moduleDeps = super.moduleDeps ++ Seq( 229 rocketModule, 230 difftestModule, 231 huancunModule, 232 coupledL2Module, 233 openLLCModule, 234 yunsuanModule, 235 fudianModule, 236 utilityModule, 237 macrosModule, 238 ) 239 240 val resourcesPATH = pwd.toString() + "/src/main/resources" 241 val envPATH = sys.env("PATH") + ":" + resourcesPATH 242 243 override def forkEnv = Map("PATH" -> envPATH) 244} 245 246object xiangshan extends XiangShanModule with HasChisel with ScalafmtModule { 247 248 override def millSourcePath = pwd 249 250 def rocketModule = rocketchip 251 252 def difftestModule = difftest 253 254 def huancunModule = huancun 255 256 def coupledL2Module = coupledL2 257 258 def openLLCModule = openLLC 259 260 def fudianModule = fudian 261 262 def utilityModule = utility 263 264 def yunsuanModule = yunsuan 265 266 def macrosModule = macros 267 268 // properties may be changed by user. Use `Task.Input` here. 269 def forkArgsTask = Task.Input { 270 Seq(s"-Xmx${sys.props.getOrElse("jvm-xmx", "40G")}", s"-Xss${sys.props.getOrElse("jvm-xss", "256m")}") 271 } 272 273 override def forkArgs = forkArgsTask() 274 275 override def ivyDeps = super.ivyDeps() ++ Agg( 276 defaultVersions("chiseltest"), 277 ivy"io.circe::circe-yaml:1.15.0", 278 ivy"io.circe::circe-generic-extras:0.14.4" 279 ) 280 281 override def scalacOptions = super.scalacOptions() ++ Agg("-deprecation", "-feature") 282 283 def publishVersion: T[String] = VcsVersion.vcsState().format( 284 revHashDigits = 8, 285 dirtyHashDigits = 0, 286 commitCountPad = -1, 287 countSep = "", 288 tagModifier = (tag: String) => "[Rr]elease.*".r.findFirstMatchIn(tag) match { 289 case Some(_) => "Kunminghu-Release-" + LocalDateTime.now().format( 290 DateTimeFormatter.ofPattern("MMM-dd-yyyy").withLocale(new Locale("en"))) 291 case None => "Kunminghu-dev" 292 }, 293 /* add "username, buildhost, buildtime" for non-release version */ 294 untaggedSuffix = " (%s@%s) # %s".format( 295 System.getProperty("user.name"), 296 java.net.InetAddress.getLocalHost().getHostName(), 297 LocalDateTime.now().format(DateTimeFormatter.ofPattern("MMM dd hh:mm:ss yyyy").withLocale(new Locale("en")))), 298 ) 299 300 // gitStatus changes frequently and unpredictably. Use `Task.Input` here. 301 def gitStatus: T[String] = Task.Input { 302 val gitRevParseBuilder = new ProcessBuilder("git", "rev-parse", "HEAD") 303 val gitRevParseProcess = gitRevParseBuilder.start() 304 val shaReader = new BufferedReader(new InputStreamReader(gitRevParseProcess.getInputStream)) 305 val sha = shaReader.readLine() 306 307 val gitStatusBuilder = new ProcessBuilder("git", "status", "-uno", "--porcelain") 308 val gitStatusProcess = gitStatusBuilder.start() 309 val gitStatusReader = new BufferedReader(new InputStreamReader(gitStatusProcess.getInputStream)) 310 val status = gitStatusReader.readLine() 311 val gitDirty = if (status == null) 0 else 1 312 313 val str = 314 s"""|SHA=$sha 315 |dirty=$gitDirty 316 |""".stripMargin 317 str 318 } 319 320 def packDifftestResources(destDir: os.Path): Unit = { 321 // package difftest source as resources, only git tracked files were collected 322 val difftest_srcs = os.proc("git", "ls-files").call(cwd = pwd / "difftest").out 323 .text().split("\n").filter(_.nonEmpty).toSeq 324 .map(os.RelPath(_)) 325 difftest_srcs.foreach { f => 326 os.copy(pwd / "difftest" / f, destDir / "difftest-src" / f, createFolders = true) 327 } 328 329 // package ready-to-run binary as resources 330 val ready_to_run = Seq("riscv64-nemu-interpreter-dual-so", 331 "riscv64-nemu-interpreter-so", 332 "riscv64-spike-so") 333 ready_to_run.foreach { f => 334 os.copy(pwd / "ready-to-run" / f, destDir / "ready-to-run" / f, createFolders = true) 335 } 336 } 337 338 override def resources = T.sources { 339 os.write(T.dest / "publishVersion", publishVersion()) 340 os.write(T.dest / "gitStatus", gitStatus()) 341 os.write(T.dest / "gitModules", os.proc("git", "submodule", "status").call().out.text()) 342 packDifftestResources(T.dest) 343 super.resources() ++ Seq(PathRef(T.dest)) 344 } 345 346 object test extends SbtTests with TestModule.ScalaTest { 347 override def moduleDeps = super.moduleDeps ++ Seq( 348 difftestModule.test 349 ) 350 351 override def forkArgs = forkArgsTask() 352 353 override def scalacOptions = super.scalacOptions() ++ Agg("-deprecation", "-feature") 354 355 val resourcesPATH = pwd.toString() + "/src/main/resources" 356 val envPATH = sys.env("PATH") + ":" + resourcesPATH 357 358 override def forkEnv = Map("PATH" -> envPATH) 359 } 360} 361