fix vivado caching and add cleanup mechanism for vivado work folder

Author: Oron Port

internals/src/main/scala/dfhdl/internals/DiskCache.scala

@@ -76,6 +76,7 @@ class DiskCache(val cacheFolderStr: String):
     protected def cacheStrToValue(str: String): R
     protected def logCachedRun(): Unit = {}
     protected def runAfterValue(value: R): Unit = {}
+    protected def cleanUpBeforeFileRestore(value: R): Unit = {}
     protected def genFiles(value: R): List[String] = Nil
     protected val name: String = typeName
     private lazy val keyHash: String =
@@ -99,7 +100,9 @@ class DiskCache(val cacheFolderStr: String):
         case Some(dataStr) =>
           logCachedRun()
           val value = cacheStrToValue(dataStr)
-          if (hasGenFiles) restoreFiles(value)
+          if (hasGenFiles)
+            cleanUpBeforeFileRestore(value)
+            restoreFiles(value)
           value
         case None =>
           put(name, "data", getDataHash, calcDataStr)

lib/src/main/scala/dfhdl/app/DFApp.scala

@@ -176,7 +176,8 @@ trait DFApp:
         hasGenFiles = true
       )(
         simulatorOptions.getTool.toString,
-        simulatorOptions.getTool.installedVersion
+        simulatorOptions.getTool.installedVersion,
+        compilerOptions.backend.toString()
       ):
     override protected def cacheEnable: Boolean = appOptions.cacheEnable
     override protected def genFiles(committed: CompiledDesign): List[String] =
@@ -185,6 +186,8 @@ trait DFApp:
       }
     protected def run(committed: CompiledDesign): CompiledDesign =
       committed.tap(_ => logger.info("Preparing external simulation...")).simPrep
+    override protected def cleanUpBeforeFileRestore(committed: CompiledDesign): Unit =
+      simulatorOptions.getTool.cleanUpBeforeFileRestore()(using committed.stagedDB.getSet)
     override protected def logCachedRun(): Unit =
       logger.info("Loading sim prep from cache...")
     protected def valueToCacheStr(value: CompiledDesign): String = value.stagedDB.toJsonString

lib/src/main/scala/dfhdl/tools/toolsCore/Tool.scala

@@ -28,6 +28,7 @@ trait Tool:
   protected def versionCmd: String
   protected def extractVersion(cmdRetStr: String): Option[String]
   protected[dfhdl] def producedFiles(using MemberGetSet, CompilerOptions): List[String] = Nil
+  protected[dfhdl] def cleanUpBeforeFileRestore()(using MemberGetSet, CompilerOptions): Unit = {}
 
   private[dfhdl] lazy val installedVersion: Option[String] =
     val getVersionFullCmd =

lib/src/main/scala/dfhdl/tools/toolsCore/VivadoSim.scala

@@ -37,22 +37,76 @@ trait VivadoSimCommon extends Linter, Simulator:
 
   protected def xsimFolder(using MemberGetSet): String =
     s"xsim.dir${separatorChar}work.${topName}"
+  private val workFolder = s"xsim.dir${separatorChar}work"
 
   // TODO: check if the script is indeed shell script
   val axsimScript = if (osIsWindows) "axsim.bat" else "axsim.sh"
 
-  override protected[dfhdl] def producedFiles(using MemberGetSet, CompilerOptions): List[String] =
+  // must clean up work folder when switching between verilog and vhdl backends
+  private def cleanUp()(using
+      getSet: MemberGetSet,
+      co: CompilerOptions
+  ): Unit =
+    import java.nio.file.{Files, Paths, DirectoryStream}
+    import scala.jdk.CollectionConverters._
+
+    val dir = Paths.get(co.topCommitPath(topName)).resolve(workFolder)
+    if (Files.exists(dir) && Files.isDirectory(dir))
+      val removePattern = co.backend match
+        case _: backends.verilog => "*.vdb"
+        case _: backends.vhdl    => "*.sdb"
+      if (removePattern.nonEmpty)
+        val stream: DirectoryStream[java.nio.file.Path] =
+          java.nio.file.Files.newDirectoryStream(dir, removePattern)
+        try
+          for (file <- stream.asScala)
+            try Files.deleteIfExists(file)
+            catch case _: Throwable => ()
+        finally
+          stream.close()
+  end cleanUp
+
+  override protected[dfhdl] def cleanUpBeforeFileRestore()(using
+      getSet: MemberGetSet,
+      co: CompilerOptions
+  ): Unit = cleanUp()
+
+  override protected[dfhdl] def producedFiles(using
+      getSet: MemberGetSet,
+      co: CompilerOptions
+  ): List[String] =
     val folder = xsimFolder
     val axsimRunExec = s"${folder}${separatorChar}axsim${if (osIsWindows) ".exe" else ""}"
     val xsimSuffixes = List("dbg", "mem", "reloc", "rtti", "svtype", "type", "xdbg")
     val xsimSupportFiles =
       xsimSuffixes.map(suffix => s"${folder}${separatorChar}xsim.${suffix}")
-    axsimScript :: axsimRunExec :: xsimSupportFiles
+    def compiledFilePath(dclName: String): String =
+      val name = co.backend match
+        case _: backends.vhdl    => s"${dclName.toLowerCase()}.vdb"
+        case _: backends.verilog =>
+          dclName.flatMap { c =>
+            if (c.isUpper) s"@${c.toLower}" else s"$c"
+          } + ".sdb"
+      s"${workFolder}${separatorChar}${name}"
+    def compiledVHDLPackageFiles: List[String] =
+      co.backend match
+        case _: backends.vhdl =>
+          this.designDefFiles.map { path =>
+            val fileName = path.split(separatorChar).last.toLowerCase()
+            s"${workFolder}${separatorChar}${fileName.replace(".vhd", ".vdb")}"
+          }
+        case _: backends.verilog => Nil
+    val compiledFiles =
+      s"$workFolder${separatorChar}work.rlx" :: compiledVHDLPackageFiles ++
+        getSet.designDB.uniqueDesignMemberList.view.map(_._1.dclName).map(compiledFilePath).toList
+    axsimScript :: axsimRunExec :: xsimSupportFiles ++ compiledFiles
+  end producedFiles
 
   override protected[dfhdl] def simulatePreprocess(cd: CompiledDesign)(using
       co: CompilerOptions,
       so: SimulatorOptions
   ): CompiledDesign =
+    cleanUp()(using cd.stagedDB.getSet)
     val ret = super.simulatePreprocess(cd)
     given MemberGetSet = ret.stagedDB.getSet
     val runExec = if (osIsWindows) "xelab.bat" else "xelab"

project/DFHDLCommands.scala

@@ -128,12 +128,12 @@ object DFHDLCommands {
     }
     //TODO: fix caching issues
     for (tool <- vhdlTools if existingTools.contains(tool); dialect <- vhdlDialects if !skip.contains((tool, dialect))) {
-      val arguments = s" AES.top_CipherSim --nocache simulate -b $dialect -t $tool --Werror-tool"
+      val arguments = s" AES.top_CipherSim simulate -b $dialect -t $tool --Werror-tool"
       val (updatedState, _) = extracted.runInputTask(runMainTask, arguments, newState)
       newState = updatedState
     }
     for (tool <- verilogTools if existingTools.contains(tool); dialect <- verilogDialects if !skip.contains((tool, dialect))) {
-      val arguments = s" AES.top_CipherSim --nocache simulate -b $dialect -t $tool --Werror-tool"
+      val arguments = s" AES.top_CipherSim simulate -b $dialect -t $tool --Werror-tool"
       val (updatedState, _) = extracted.runInputTask(runMainTask, arguments, newState)
       newState = updatedState
     }