Rename DeclareOutputDir to OutputDirPrecedence

llvm · May 22, 2024 · 9a8c66a · 9a8c66a
1 parent b501eee
commit 9a8c66a
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 14 deletions.
diff --git a/docs/Dialects/FIRRTL/FIRRTLAnnotations.md b/docs/Dialects/FIRRTL/FIRRTLAnnotations.md
@@ -1478,11 +1478,11 @@ Example:
 }
 ```
 
-### DeclareOutputDirAnnotation
+### OutputDirPrecedenceAnnotation
 
 | Property   | Type    | Description                             |
 | ---------- | ------- | --------------------------------------- |
-| class      | string  | `circt.DeclareOutputDirAnnotation`      |
+| class      | string  | `circt.OutputDirPrecedenceAnnotation`      |
 | name       | string  | The output directory                    |
 | parent     | string  | The parent output directory             |
 
@@ -1512,7 +1512,7 @@ parent.
 Example:
 ```json
 {
-  "class": "circt.DeclareOutputDirAnnotation",
+  "class": "circt.OutputDirPrecedenceAnnotation",
   "name": "verification_extras",
   "parent": "verification"
 }

diff --git a/include/circt/Dialect/FIRRTL/AnnotationDetails.h b/include/circt/Dialect/FIRRTL/AnnotationDetails.h
@@ -80,8 +80,8 @@ constexpr const char *testBenchDirAnnoClass =
 constexpr const char *moduleHierAnnoClass =
     "sifive.enterprise.firrtl.ModuleHierarchyAnnotation";
 constexpr const char *outputDirAnnoClass = "circt.OutputDirAnnotation";
-constexpr const char *declareOutputDirAnnoClass =
-    "circt.DeclareOutputDirAnnotation";
+constexpr const char *ouputDirPrecedenceAnnoClass =
+    "circt.OutputDirPrecedenceAnnotation";
 constexpr const char *testHarnessHierAnnoClass =
     "sifive.enterprise.firrtl.TestHarnessHierarchyAnnotation";
 constexpr const char *retimeModulesFileAnnoClass =

diff --git a/include/circt/Dialect/FIRRTL/Passes.td b/include/circt/Dialect/FIRRTL/Passes.td
@@ -942,7 +942,7 @@ def AssignOutputDirs : Pass<"firrtl-assign-output-dirs", "firrtl::CircuitOp"> {
 
     The least common ancestor is chosen according to a precedence graph provided
     by the user through a circuit level annotation called
-    `DeclareOutputDirAnnotation`. The default output directory is implicitly the
+    `OutputDirPrecedenceAnnotation`. The default output directory is implicitly the
     common ancestor of all other output directories.
   }];
   let constructor = "circt::firrtl::createAssignOutputDirsPass()";

diff --git a/lib/Dialect/FIRRTL/Transforms/AssignOutputDirs.cpp b/lib/Dialect/FIRRTL/Transforms/AssignOutputDirs.cpp
@@ -97,7 +97,7 @@ LogicalResult OutputDirTable::initialize(CircuitOp circuit) {
   infoTable.emplace_back(nullptr, 0, SIZE_MAX);
   AnnotationSet annos(circuit);
   for (auto anno : annos) {
-    if (anno.isClass(declareOutputDirAnnoClass)) {
+    if (anno.isClass(ouputDirPrecedenceAnnoClass)) {
       auto nameField = anno.getMember<StringAttr>("name");
       if (!nameField)
         return err() << "output directory declaration missing name";

diff --git a/lib/Dialect/FIRRTL/Transforms/LowerAnnotations.cpp b/lib/Dialect/FIRRTL/Transforms/LowerAnnotations.cpp
@@ -518,7 +518,7 @@ static llvm::StringMap<AnnoRecord> annotationRecords{{
     {metadataDirectoryAttrName, NoTargetAnnotation},
     {moduleHierAnnoClass, NoTargetAnnotation},
     {outputDirAnnoClass, {stdResolve, applyOutputDirAnno}},
-    {declareOutputDirAnnoClass, NoTargetAnnotation},
+    {ouputDirPrecedenceAnnoClass, NoTargetAnnotation},
     {sitestTestHarnessBlackBoxAnnoClass, NoTargetAnnotation},
     {testBenchDirAnnoClass, NoTargetAnnotation},
     {testHarnessHierAnnoClass, NoTargetAnnotation},

diff --git a/test/Dialect/FIRRTL/assign-output-dirs.mlir b/test/Dialect/FIRRTL/assign-output-dirs.mlir
@@ -7,9 +7,9 @@ firrtl.circuit "AssignOutputDirs"
       //    A       B
       //  C   D
       annotations = [
-        {class = "circt.DeclareOutputDirAnnotation", name = "B", parent = ""},
-        {class = "circt.DeclareOutputDirAnnotation", name = "C", parent = "A"},
-        {class = "circt.DeclareOutputDirAnnotation", name = "D", parent = "A"}
+        {class = "circt.OutputDirPrecedenceAnnotation", name = "B", parent = ""},
+        {class = "circt.OutputDirPrecedenceAnnotation", name = "C", parent = "A"},
+        {class = "circt.OutputDirPrecedenceAnnotation", name = "D", parent = "A"}
       ]
   } {
 

diff --git a/test/firtool/dedup-modules-with-output-dirs.fir b/test/firtool/dedup-modules-with-output-dirs.fir
@@ -134,17 +134,17 @@ circuit Top: %[[
     "target": "~Top|B"
   },
   {
-    "class": "circt.DeclareOutputDirAnnotation",
+    "class": "circt.OutputDirPrecedenceAnnotation",
     "name": "XXX",
     "parent": "ZZZ"
   },
   {
-    "class": "circt.DeclareOutputDirAnnotation",
+    "class": "circt.OutputDirPrecedenceAnnotation",
     "name": "YYY",
     "parent": "ZZZ"
   },
   {
-    "class": "circt.DeclareOutputDirAnnotation",
+    "class": "circt.OutputDirPrecedenceAnnotation",
     "name": "ZZZ",
     "parent": ""
   }