[ChiselSim] Better file include in LayerControl

Provide initial work that better handles the problem of needing to filter
files in order to enable specific layers.  This adds a new member
function, `shouldIncludeFile` which returns a `PartialFunction` that is
defined only if the file being examined is a layer file (as defined in the
FIRRTL ABI for extract layers) and returns true if that layer file should
be included in order to enable the requested layers.

In subsequent commits, this will be made load bearing.

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

Author: seldridge

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

@@ -54,6 +54,30 @@ object LayerControl {
           case _ => None
         }
     }
+
+    /** Return a partial function that will return true if a file should be included
+      * in the build to enable a layer.  This partial function is not defined if
+      * the file is not a layer file.
+      *
+      * @param module an elaborated module
+      * @return a partial function to test if layer files should be included
+      */
+    final def shouldIncludeFile(module: ElaboratedModule[_ <: RawModule]): PartialFunction[File, Boolean] = {
+      val layerFilenames: Seq[String] = getLayerSubset(module).flatMap {
+        case layer =>
+          layer.config.abi match {
+            case abi: chisel3.layer.ABI.FileInclude.type =>
+              Some(abi.toFilename(layer, module.wrapped.circuitName))
+            case _ => None
+          }
+      }
+
+      {
+        case a if a.getName().startsWith("layers-") =>
+          layerFilenames.mkString("|").r.matches(a.getName())
+      }
+    }
+
   }
 
   /** Enable all layers */

src/test/scala/chiselTests/simulator/LayerControlSpec.scala

@@ -5,42 +5,82 @@ package chiselTests.simulator
 import java.io.File
 import org.scalatest.funspec.AnyFunSpec
 import org.scalatest.matchers.should.Matchers
-import chisel3.layer.{Layer, LayerConfig}
-import chisel3.simulator.LayerControl
+import chisel3.RawModule
+import chisel3.layer.{addLayer, Layer, LayerConfig}
+import chisel3.simulator.{ChiselWorkspace, LayerControl}
+import svsim.Workspace
 
 class LayerControlSpec extends AnyFunSpec with Matchers {
+
+  object A extends Layer(LayerConfig.Extract())
+  object B extends Layer(LayerConfig.Extract()) {
+    object C extends Layer(LayerConfig.Extract())
+  }
+  class Foo extends RawModule {
+    Seq(A, B, B.C).foreach(addLayer)
+  }
+
+  val workspace = new Workspace(path = "test_run_dir/LayerControlSpec")
+  workspace.reset()
+  val elaboratedModule = workspace.elaborateGeneratedModule({ () => new Foo })
+
   describe("LayerControl.EnableAll") {
-    it("should always filter to true") {
+    it("should include all layer files") {
       val layerControl = LayerControl.EnableAll
-      layerControl.filter(new File("foo")) should be(true)
-      layerControl.filter(new File("layers-foo-bar.sv")) should be(true)
+
+      info("non-layer files are ignored")
+      layerControl.shouldIncludeFile(elaboratedModule).isDefinedAt(new File("Foo.sv")) should be(false)
+
+      Seq("layers-Foo-A.sv", "layers-Foo-B.sv", "layers-Foo-B-C.sv").map(new File(_)).foreach {
+        case filename =>
+          info(s"$filename is included")
+          layerControl.shouldIncludeFile(elaboratedModule)(filename) should be(true)
+      }
     }
   }
   describe("LayerControl.Enable()") {
-    it("should return true for non-layers and false for layers") {
+    it("should include no layer files") {
       val layerControl = LayerControl.Enable()
-      layerControl.filter(new File("foo")) should be(true)
-      layerControl.filter(new File("layers-foo-bar.sv")) should be(false)
+
+      info("non-layer files are ignored")
+      layerControl.shouldIncludeFile(elaboratedModule).isDefinedAt(new File("Foo.sv")) should be(false)
+
+      Seq("layers-Foo-A.sv", "layers-Foo-B.sv", "layers-Foo-B-C.sv").map(new File(_)).foreach {
+        case filename =>
+          info(s"$filename is excluded")
+          layerControl.shouldIncludeFile(elaboratedModule)(filename) should be(false)
+      }
     }
   }
   describe("LayerControl.DisableAll") {
-    it("should return true for non-layers and false for layers") {
-      LayerControl.DisableAll.filter(new File("foo")) should be(true)
-      LayerControl.DisableAll.filter(new File("layers-foo-bar.sv")) should be(false)
+    it("should include no layer files") {
+      val layerControl = LayerControl.Enable()
+
+      info("non-layer files are ignored")
+      layerControl.shouldIncludeFile(elaboratedModule).isDefinedAt(new File("Foo.sv")) should be(false)
+
+      Seq("layers-Foo-A.sv", "layers-Foo-B.sv", "layers-Foo-B-C.sv").map(new File(_)).foreach {
+        case filename =>
+          info(s"$filename is excluded")
+          layerControl.shouldIncludeFile(elaboratedModule)(filename) should be(false)
+      }
     }
   }
-  describe("LayerControl.Enable") {
-    it("should return true for non-layers and filter layers properly") {
-      object A extends Layer(LayerConfig.Extract())
-      object B extends Layer(LayerConfig.Extract()) {
-        object C extends Layer(LayerConfig.Extract())
-      }
+  describe("LayerControl.Enable(A, B.C)") {
+    it("should include only specified layers") {
       val layerControl = LayerControl.Enable(A, B.C)
-      layerControl.filter(new File("foo")) should be(true)
-      layerControl.filter(new File("layers-foo.sv")) should be(false)
-      layerControl.filter(new File("layers-foo-A.sv")) should be(true)
-      layerControl.filter(new File("layers-foo-A-B.sv")) should be(false)
-      layerControl.filter(new File("layers-foo-B-C.sv")) should be(true)
+
+      info("non-layer files are ignored")
+      layerControl.shouldIncludeFile(elaboratedModule).isDefinedAt(new File("foo")) should be(false)
+
+      Seq("layers-Foo-A.sv", "layers-Foo-B-C.sv").map(new File(_)).foreach {
+        case filename =>
+          info(s"$filename is included")
+          layerControl.shouldIncludeFile(elaboratedModule)(filename) should be(true)
+      }
+
+      info("layers-Foo-A-B.sv is excluded")
+      layerControl.shouldIncludeFile(elaboratedModule)(new File("layers-Foo-A-B.sv")) should be(false)
     }
   }
 }