[FIRRTL] Only add SiTest metadata for design (#7799)

Update the `CreateSiFiveMetadata` pass to treat blackboxes under layers as contributing to test harness JSON metadata. This brings this metadata in line with other metadata which treats layers as "not design". Note: for class-based metadata, this pass does not make any distinction between design and test. Therefore, this commit does not make any change to class-based metadata. Any blackboxes under layers will be included in class-based metadata. (I have no idea if this distinction is correct or intended. However, keeping this the same is at least self-consistent.) Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
llvm · Nov 12, 2024 · bab6cbc · bab6cbc
1 parent 7d890fc
commit bab6cbc
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 2 deletions.
diff --git a/lib/Dialect/FIRRTL/Transforms/CreateSiFiveMetadata.cpp b/lib/Dialect/FIRRTL/Transforms/CreateSiFiveMetadata.cpp
@@ -833,7 +833,7 @@ CreateSiFiveMetadataPass::emitSitestBlackboxMetadata(ObjectModelIR &omir) {
       continue;
 
     // Record the defname of the module.
-    if (instanceInfo->anyInstanceUnderEffectiveDut(extModule)) {
+    if (instanceInfo->anyInstanceInEffectiveDesign(extModule)) {
       dutModules.push_back(*extModule.getDefname());
     } else {
       testModules.push_back(*extModule.getDefname());

diff --git a/test/Dialect/FIRRTL/emit-metadata.mlir b/test/Dialect/FIRRTL/emit-metadata.mlir
@@ -227,6 +227,7 @@ firrtl.circuit "BasicBlackboxes" attributes {
     }
   ]
 } {
+  firrtl.layer @A bind {}
   firrtl.module @BasicBlackboxes() attributes {
     annotations = [
       {
@@ -237,6 +238,11 @@ firrtl.circuit "BasicBlackboxes" attributes {
     firrtl.instance test @DUTBlackbox_0()
     firrtl.instance test @DUTBlackbox_1()
     firrtl.instance test @DUTBlackbox_2()
+    firrtl.instance layerBlackboxInDesign1 @LayerBlackboxInDesign()
+    firrtl.layerblock @A {
+      firrtl.instance layerBlackboxInDesign2 @LayerBlackboxInDesign()
+      firrtl.instance layerBlackbox @LayerBlackbox()
+    }
   }
 
   // These should all be ignored.
@@ -290,6 +296,8 @@ firrtl.circuit "BasicBlackboxes" attributes {
   firrtl.extmodule @DUTBlackbox_0() attributes {defname = "DUTBlackbox2"}
   firrtl.extmodule @DUTBlackbox_1() attributes {defname = "DUTBlackbox1"}
   firrtl.extmodule @DUTBlackbox_2() attributes {defname = "DUTBlackbox1"}
+  firrtl.extmodule @LayerBlackboxInDesign() attributes {defname = "LayerBlackboxInDesign"}
+  firrtl.extmodule @LayerBlackbox() attributes {defname = "LayerBlackbox"}
 }
 
 // (1) Class-based metadata ----------------------------------------------------
@@ -305,6 +313,9 @@ firrtl.circuit "BasicBlackboxes" attributes {
 // CHECK-SAME:            out %TestBlackbox_field: !firrtl.class<@SitestBlackBoxModulesSchema(
 // CHECK-SAME:            out %DUTBlackbox_0_field: !firrtl.class<@SitestBlackBoxModulesSchema(
 // CHECK-SAME:            out %DUTBlackbox_1_field: !firrtl.class<@SitestBlackBoxModulesSchema(
+// CHECK-SAME:            out %LayerBlackboxInDesign_field: !firrtl.class<@SitestBlackBoxModulesSchema(
+// CHECK-SAME:            out %LayerBlackbox_field: !firrtl.class<@SitestBlackBoxModulesSchema(
+// CHECK-NOT:             !firrtl.class<@SitestBlackBoxModulesSchema(
 //
 // CHECK-NEXT:            %[[#defname:]] = firrtl.string "TestBlackbox"
 // CHECK-NEXT:            %[[object:.+]] = firrtl.object @SitestBlackBoxModulesSchema
@@ -324,20 +335,34 @@ firrtl.circuit "BasicBlackboxes" attributes {
 // CHECK-NEXT:            firrtl.propassign %[[#moduleName]], %[[#defname:]] : !firrtl.string
 // CHECK-NEXT:            firrtl.propassign %DUTBlackbox_1_field, %[[object]]
 //
+// CHECK-NEXT:            %[[#defname:]] = firrtl.string "LayerBlackboxInDesign"
+// CHECK-NEXT:            %[[object:.+]] = firrtl.object @SitestBlackBoxModulesSchema
+// CHECK-NEXT:            %[[#moduleName:]] = firrtl.object.subfield %[[object]][moduleName_in]
+// CHECK-NEXT:            firrtl.propassign %[[#moduleName]], %[[#defname:]] : !firrtl.string
+// CHECK-NEXT:            firrtl.propassign %LayerBlackboxInDesign_field, %[[object]]
+//
+// CHECK-NEXT:            %[[#defname:]] = firrtl.string "LayerBlackbox"
+// CHECK-NEXT:            %[[object:.+]] = firrtl.object @SitestBlackBoxModulesSchema
+// CHECK-NEXT:            %[[#moduleName:]] = firrtl.object.subfield %[[object]][moduleName_in]
+// CHECK-NEXT:            firrtl.propassign %[[#moduleName]], %[[#defname:]] : !firrtl.string
+// CHECK-NEXT:            firrtl.propassign %LayerBlackbox_field, %[[object]]
+//
 // CHECK-NOT:             firrtl.object
 
 // (2) JSON file-based metadata ------------------------------------------------
 //
 // CHECK:               emit.file "test_blackboxes.json" {
 // CHECK-NEXT{LITERAL}:   emit.verbatim "[\0A
+// CHECK-SAME:              \22LayerBlackbox\22,\0A
 // CHECK-SAME:              \22TestBlackbox\22\0A
 // CHECK-SAME:            ]"
 // CHECK-NEXT:          }
 //
 // CHECK:               emit.file "dut_blackboxes.json" {
 // CHECK-NEXT{LITERAL}:   emit.verbatim "[\0A
 // CHECK-SAME:              \22DUTBlackbox1\22,\0A
-// CHECK-SAME:              \22DUTBlackbox2\22\0A
+// CHECK-SAME:              \22DUTBlackbox2\22,\0A
+// CHECK-SAME:              \22LayerBlackboxInDesign\22\0A
 // CHECK-SAME:            ]"
 // CHECK-NEXT:          }