[ChiselSim][svsim] Switch to shouldIncludeFile

Change both ChiselSim and svsim to no longer use the `filter` function of
`LayerControl`.  Migrate both to use `shouldIncludeFile` partial function.
The latter is a much better API as it reserves the handling of files that
are outside the domain of the filter to ChiselSim and svsim.

Signed-off-by: Schuyler Eldridge <[email protected]>

Author: seldridge

src/main/scala-2/chisel3/simulator/EphemeralSimulator.scala

@@ -23,31 +23,27 @@ object EphemeralSimulator extends PeekPokeAPI {
     layerControl: LayerControl.Type = LayerControl.EnableAll
   )(body:         (T) => Unit
   ): Unit = {
-    makeSimulator(layerControl).simulate(module, layerControl)({ module => body(module.wrapped) }).result
+    makeSimulator().simulate(module, layerControl)({ module => body(module.wrapped) }).result
   }
 
-  private class DefaultSimulator(val workspacePath: String, layerControl: LayerControl.Type)
-      extends SingleBackendSimulator[verilator.Backend] {
+  private class DefaultSimulator(val workspacePath: String) extends SingleBackendSimulator[verilator.Backend] {
     val backend = verilator.Backend.initializeFromProcessEnvironment()
     val tag = "default"
-    val commonCompilationSettings = CommonCompilationSettings(
-      fileFilter = layerControl.filter
-    )
+    val commonCompilationSettings = CommonCompilationSettings()
     val backendSpecificCompilationSettings = verilator.Backend.CompilationSettings()
 
     // Try to clean up temporary workspace if possible
     sys.addShutdownHook {
       (new Directory(new File(workspacePath))).deleteRecursively()
     }
   }
-  private def makeSimulator(layerControl: LayerControl.Type): DefaultSimulator = {
+  private def makeSimulator(): DefaultSimulator = {
     // TODO: Use ProcessHandle when we can drop Java 8 support
     // val id = ProcessHandle.current().pid().toString()
     val id = java.lang.management.ManagementFactory.getRuntimeMXBean().getName()
     val className = getClass().getName().stripSuffix("$")
     new DefaultSimulator(
-      workspacePath = Files.createTempDirectory(s"${className}_${id}_").toString,
-      layerControl = layerControl
+      workspacePath = Files.createTempDirectory(s"${className}_${id}_").toString
     )
   }
 }

src/main/scala-2/chisel3/simulator/Simulator.scala

@@ -128,8 +128,12 @@ trait Simulator {
 
     processBackends(
       compiler,
-      commonCompilationSettings.copy(verilogPreprocessorDefines =
-        commonCompilationSettings.verilogPreprocessorDefines ++ layerControl.preprocessorDefines(elaboratedModule)
+      commonCompilationSettings.copy(
+        verilogPreprocessorDefines =
+          commonCompilationSettings.verilogPreprocessorDefines ++ layerControl.preprocessorDefines(
+            elaboratedModule
+          ),
+        fileFilter = commonCompilationSettings.fileFilter.orElse(layerControl.shouldIncludeFile(elaboratedModule))
       )
     )
     compiler.results.toSeq

src/test/scala/chiselTests/ChiselSpec.scala

@@ -63,7 +63,7 @@ trait ChiselRunners extends Assertions {
             VerilogPreprocessorDefine("STOP_COND", s"!${Workspace.testbenchModuleName}.reset")
           ) ++ layerControl.preprocessorDefines(elaboratedModule),
           includeDirs = Some(Seq(workspace.primarySourcesPath)),
-          fileFilter = layerControl.filter
+          fileFilter = layerControl.shouldIncludeFile(elaboratedModule)
         )
       },
       verilator.Backend

svsim/src/main/scala/Backend.scala

@@ -15,7 +15,7 @@ case class CommonCompilationSettings(
   libraryExtensions: Option[Seq[String]] = None,
   libraryPaths:      Option[Seq[String]] = None,
   includeDirs:       Option[Seq[String]] = None,
-  fileFilter:        File => Boolean = _ => true)
+  fileFilter:        PartialFunction[File, Boolean] = PartialFunction.empty)
 object CommonCompilationSettings {
   object VerilogPreprocessorDefine {
     def apply(name: String, value: String) = new VerilogPreprocessorDefine(name, Some(value))

svsim/src/main/scala/Workspace.scala

@@ -318,7 +318,7 @@ final class Workspace(
       .flatMap(p => Files.walk(Paths.get(p)).iterator().asScala.toSeq)
       .map(_.toFile)
       .filter(_.isFile)
-      .filter(commonSettings.fileFilter)
+      .filter(commonSettings.fileFilter.orElse { case _ => true })
       .map { file => workingDirectory.toPath().relativize(file.toPath()).toString() }
 
     val traceFileStem = (backendSpecificSettings match {