spinal.sim.IVerilogBackend.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spinalhdl-sim_2.11 Show documentation
SpinalHDL Sim
There is a newer version: 1.12.0
package spinal.sim

import org.apache.commons.io.FileUtils
import spinal.sim.vpi.SharedMemIface

import java.io.{File, PrintWriter}
import java.nio.file.{Files, Path, Paths}
import scala.sys.process.Process


/* README first!

  This backend doesn't work because of incompatibilities between IVerilog and SpinalSim execution method

*/
class IVerilogBackendConfig extends VpiBackendConfig {
  var binDirectory: String = ""
}
class IVerilogBackend(config: IVerilogBackendConfig) extends VpiBackend(config) {
  import Backend._
  import config._

  val availableFormats = Array(
    WaveFormat.VCD,
    WaveFormat.FST,
    WaveFormat.FST_SPEED,
    WaveFormat.FST_SPACE,
    WaveFormat.LXT,
    WaveFormat.LXT_SPEED,
    WaveFormat.LXT_SPACE,
    WaveFormat.LXT2,
    WaveFormat.LXT2_SPEED,
    WaveFormat.LXT2_SPACE,
    WaveFormat.DEFAULT,
    WaveFormat.NONE
  )

  val format = if (availableFormats contains config.waveFormat) {
    config.waveFormat
  } else {
    println("Wave format " + config.waveFormat + " not supported by IVerilog")
    WaveFormat.NONE
  }

  var hasWave = false
  if (!(Array(WaveFormat.DEFAULT, WaveFormat.NONE) contains format)) {

    runFlags += " -" + format.ext
    hasWave = true
  }

  val vpiModuleName = "vpi_iverilog.vpi"
  val vpiModulePath = pluginsPath + "/" + vpiModuleName
  val iverilogPath = binDirectory + "iverilog"
  val iverilogVpiPath = binDirectory + "iverilog-vpi"
  val vvpPath = binDirectory + "vvp"

  val IVERILOGCFLAGS = "-Wstrict-prototypes".r
    .replaceAllIn(Process(Seq(iverilogVpiPath, "--cflags")).!!, "")
  val IVERILOGLDFLAGS = Process(Seq(iverilogVpiPath, "--ldflags")).!!
  val IVERILOGLDLIBS = Process(Seq(iverilogVpiPath, "--ldlibs")).!!

  val timeScale = config.timePrecision match {
    case null => "1ns/1ns"
    case t => "1ns/" + t.replace(" ", "")
  }

  def compileVPI() = {
    val vpiModulePath = pluginsPath + "/" + vpiModuleName
    if (!Files.exists(Paths.get(vpiModulePath))) {

      for (filename <- Array("/VpiPlugin.cpp", "/SharedStruct.hpp")) {
        var cppSourceFile = new PrintWriter(new File(pluginsPath + "/" + filename))
        var stream = getClass.getResourceAsStream(filename)
        cppSourceFile.write(scala.io.Source.fromInputStream(stream).mkString)
        cppSourceFile.close
      }

      doCmd(
        Seq(CC, "-c", IVERILOGCFLAGS, CFLAGS + " -DIVERILOG_PLUGIN", "VpiPlugin.cpp", "-o", "VpiPlugin.o")
          .mkString(" "),
        new File(pluginsPath),
        "Compilation of VpiPlugin.o failed"
      )

      doCmd(
        Seq(CC, IVERILOGCFLAGS, CFLAGS, "VpiPlugin.o", IVERILOGLDFLAGS, IVERILOGLDLIBS, LDFLAGS, "-o", vpiModuleName)
          .mkString(" "),
        new File(pluginsPath),
        s"Compilation of $vpiModuleName failed"
      )
    }
  }

  def analyzeRTL(): Unit = {
    val verilogSourcePaths = rtlSourcesPaths
      .filter { s =>
        (s.endsWith(".v") ||
        s.endsWith(".sv") ||
        s.endsWith(".vl"))
      }
      .mkString(" ")

    val simulationDefSource = s"""
                               |`timescale $timeScale
                               |
                               |module __simulation_def;
                               |reg [255*8:0] wavefile;  // "255 bytes are enough for every path"
                               |reg ign_res;             // ignored result of $$value$$plusargs
                               |initial
                               | begin
                               |  ign_res = $$value$$plusargs("wavefile=%s", wavefile);   // read wave file name from +wavefile=xxx.ext parameter passed at simulation runtime
                               |  ${if (hasWave) "$dumpfile(wavefile);" else ""}
                               |  ${if (hasWave) "$dumpvars(0," + toplevelName + ");" else ""}
                               |  $$readmempath("./rtl/");
                               | end
                               |endmodule""".stripMargin

    val simulationDefSourceFile = new PrintWriter(
      new File(
        s"${workspacePath}/rtl/" ++
          "__simulation_def.v"
      )
    )
    simulationDefSourceFile.write(simulationDefSource)
    simulationDefSourceFile.close

    config.rtlSourcesPaths
      .filter(s => s.endsWith(".bin") || s.endsWith(".mem"))
      .foreach(path => FileUtils.copyFileToDirectory(new File(path), new File(workspacePath)))

    val verilogIncludePaths = config.rtlIncludeDirs.map("-I " + new File(_).getAbsolutePath).mkString(" ")

    doCmd(
      Seq(
        iverilogPath,
        analyzeFlags,
        "-o",
        toplevelName + ".vvp",
        "-s __simulation_def",
        "-s",
        toplevelName,
        verilogIncludePaths,
        verilogSourcePaths,
        s"./rtl/__simulation_def.v"
      ).mkString(" "),
      new File(workspacePath),
      s"Analyze step of verilog files failed"
    )
  }

  def runSimulation(sharedMemIface: SharedMemIface, testName: String): Thread = {
    val vpiModulePath =
      if (!isWindows) pluginsPath + "/" + vpiModuleName
      else (pluginsPath + "/" + vpiModuleName).replaceAll("/C", raw"C:").replaceAll(raw"/", raw"\\")

    val pathStr = if (!isWindows) sys.env("PATH")
    val waveFilePath = Paths.get(System.getProperty("user.dir"), config.testPath.replace("$TEST",testName)).toAbsolutePath.normalize()

    val thread = new Thread(new Runnable {
      val iface = sharedMemIface
      def run(): Unit = {
        val wavefilePathFlag = (if (config.waveFormat != WaveFormat.NONE) f"+wavefile=${waveFilePath}/wave.${config.waveFormat.ext}" else "")
        if (wavefilePathFlag != "") {
          FileUtils.forceMkdirParent(new File(waveFilePath.toString, "."))
        }
        val retCode = Process(
          Seq(vvpPath, "-M.", s"-m${pwd + "/" + vpiModulePath}", toplevelName + ".vvp", wavefilePathFlag, runFlags).mkString(" "),
          new File(workspacePath)
        ).!(new LoggerPrint())
        if (retCode != 0) {
          iface.set_crashed(retCode)
          println(s"Simulation of $toplevelName failed")
        }
      }
    })

    thread.setDaemon(true)
    thread.start()
    thread
  }

  override def isBufferedWrite: Boolean = true
}