Merge pull request #9077 from AcKoucher/mpl-macros-without-pins

mpl: properly handle fixed macros outside the macro placement area

Author: eder-matheus

src/mpl/src/clusterEngine.cpp

@@ -42,7 +42,6 @@ ClusteringEngine::ClusteringEngine(odb::dbBlock* block,
 
 void ClusteringEngine::run()
 {
-  design_metrics_ = computeModuleMetrics(block_->getTopModule());
   init();
 
   if (!tree_->has_unfixed_macros) {
@@ -88,17 +87,18 @@ void ClusteringEngine::setTree(PhysicalHierarchy* tree)
 // initialize the tree with data from the design.
 void ClusteringEngine::init()
 {
+  setDieArea();
+  setFloorplanShape();
+
+  design_metrics_ = computeModuleMetrics(block_->getTopModule());
+
   const std::vector<odb::dbInst*> unfixed_macros = getUnfixedMacros();
   if (unfixed_macros.empty()) {
     tree_->has_unfixed_macros = false;
     logger_->info(MPL, 17, "No unfixed macros.");
     return;
   }
 
-  setDieArea();
-  setFloorplanShape();
-  searchForFixedInstsInsideFloorplanShape();
-
   tree_->macro_with_halo_area = computeMacroWithHaloArea(unfixed_macros);
   const float inst_area_with_halos
       = tree_->macro_with_halo_area + design_metrics_->getStdCellArea();
@@ -154,25 +154,6 @@ void ClusteringEngine::setFloorplanShape()
   tree_->floorplan_shape = block_->getCoreArea().intersect(tree_->global_fence);
 }
 
-void ClusteringEngine::searchForFixedInstsInsideFloorplanShape()
-{
-  for (odb::dbInst* inst : block_->getInsts()) {
-    odb::dbMaster* master = inst->getMaster();
-
-    if (master->isBlock() || master->isCover()) {
-      continue;
-    }
-
-    if (inst->isFixed()
-        && inst->getBBox()->getBox().overlaps(tree_->floorplan_shape)) {
-      logger_->error(MPL,
-                     50,
-                     "Found fixed instance {} inside the floorplan area.",
-                     inst->getName());
-    }
-  }
-}
-
 Metrics* ClusteringEngine::computeModuleMetrics(odb::dbModule* module)
 {
   unsigned int num_std_cell = 0;
@@ -183,15 +164,25 @@ Metrics* ClusteringEngine::computeModuleMetrics(odb::dbModule* module)
   const odb::Rect& core = block_->getCoreArea();
 
   for (odb::dbInst* inst : module->getInsts()) {
-    if (isIgnoredInst(inst)) {
-      continue;
-    }
-
-    int64_t inst_area = computeArea(inst);
-
-    if (inst->isBlock()) {  // a macro
+    if (inst->isBlock()) {
       num_macro += 1;
-      macro_area += inst_area;
+      macro_area += computeArea(inst);
+
+      if (inst->isFixed()) {
+        logger_->info(MPL, 62, "Found fixed macro {}.", inst->getName());
+
+        if (!inst->getBBox()->getBox().overlaps(tree_->floorplan_shape)) {
+          ignorable_macros_.insert(inst);
+          logger_->info(MPL,
+                        63,
+                        "{} is outside the macro placement area and will be "
+                        "ignored.",
+                        inst->getName());
+          continue;
+        }
+
+        tree_->has_fixed_macros = true;
+      }
 
       auto macro = std::make_unique<HardMacro>(
           inst, tree_->halo_width, tree_->halo_height);
@@ -205,14 +196,17 @@ Metrics* ClusteringEngine::computeModuleMetrics(odb::dbModule* module)
             generateMacroAndCoreDimensionsTable(macro.get(), core));
       }
 
-      if (macro->isFixed()) {
-        tree_->has_fixed_macros = true;
-      }
-
       tree_->maps.inst_to_hard[inst] = std::move(macro);
-    } else {
+    } else if (inst->isFixed() && !inst->getMaster()->isCover()
+               && inst->getBBox()->getBox().overlaps(tree_->floorplan_shape)) {
+      logger_->error(MPL,
+                     50,
+                     "Found fixed non-macro instance {} inside the macro "
+                     "placement area.",
+                     inst->getName());
+    } else if (!isIgnoredInst(inst)) {
       num_std_cell += 1;
-      std_cell_area += inst_area;
+      std_cell_area += computeArea(inst);
     }
   }
 
@@ -856,12 +850,15 @@ DataFlowHypergraph ClusteringEngine::computeHypergraph(
   return graph;
 }
 
-/* static */
 bool ClusteringEngine::isIgnoredInst(odb::dbInst* inst)
 {
+  if (inst->isBlock()
+      && (ignorable_macros_.find(inst) != ignorable_macros_.end())) {
+    return true;
+  }
+
   odb::dbMaster* master = inst->getMaster();
-  return master->isPad() || master->isCover() || master->isEndCap()
-         || inst->getITerms().empty();
+  return master->isPad() || master->isCover() || master->isEndCap();
 }
 
 // Forward or Backward DFS search to find sequential paths from/to IO pins based

src/mpl/src/clusterEngine.h

@@ -10,6 +10,7 @@
 #include <set>
 #include <string>
 #include <unordered_map>
+#include <unordered_set>
 #include <utility>
 #include <vector>
 
@@ -161,7 +162,7 @@ class ClusteringEngine
 
   int getNumberOfIOs(Cluster* target) const;
 
-  static bool isIgnoredInst(odb::dbInst* inst);
+  bool isIgnoredInst(odb::dbInst* inst);
 
  private:
   using UniqueClusterQueue = std::queue<std::unique_ptr<Cluster>>;
@@ -179,7 +180,6 @@ class ClusteringEngine
   std::vector<odb::dbInst*> getUnfixedMacros();
   void setDieArea();
   void setFloorplanShape();
-  void searchForFixedInstsInsideFloorplanShape();
   int64_t computeMacroWithHaloArea(
       const std::vector<odb::dbInst*>& unfixed_macros);
   std::vector<odb::dbInst*> getIOPads() const;
@@ -316,11 +316,12 @@ class ClusteringEngine
   // The register distance between two macros for
   // them to be considered connected when creating data flow.
   const int max_num_of_hops_ = 5;
-
   const float minimum_connection_ratio_{0.08};
 
   int first_io_bundle_id_{-1};
   IOBundleSpans io_bundle_spans_;
+
+  std::unordered_set<odb::dbInst*> ignorable_macros_;
 };
 
 }  // namespace mpl

src/mpl/test/BUILD

@@ -36,6 +36,7 @@ COMPULSORY_TESTS = [
     "keep_clustering_data",
     "fixed_macros",
     "fixed_covers",
+    "macros_without_pins1",
 ]
 
 # Disabled in CMakeLists.txt
@@ -104,6 +105,7 @@ filegroup(
         "testcases/macro_only.lef",
         "testcases/macro_only.lib",
         "testcases/macro_only.v",
+        "testcases/macros_without_pins1.def",
         "testcases/mixed_ios1.def",
         "testcases/no_unfixed_macros.def",
         "testcases/orientation_improve1.def",

src/mpl/test/CMakeLists.txt

@@ -29,6 +29,7 @@ or_integration_tests(
     keep_clustering_data
     fixed_macros
     fixed_covers
+    macros_without_pins1
 )
 
 # Skipped

src/mpl/test/boundary_push1.ok

@@ -1,5 +1,5 @@
 [INFO ODB-0227] LEF file: ./Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
-[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 9 library cells
+[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 10 library cells
 [INFO ODB-0128] Design: boundary_push1
 [INFO ODB-0130]     Created 4 pins.
 [INFO ODB-0131]     Created 4 components and 8 component-terminals.

src/mpl/test/boundary_push2.ok

@@ -1,5 +1,5 @@
 [INFO ODB-0227] LEF file: ./Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
-[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 9 library cells
+[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 10 library cells
 [INFO ODB-0128] Design: boundary_push1
 [INFO ODB-0130]     Created 4 pins.
 [INFO ODB-0131]     Created 54 components and 308 component-terminals.

src/mpl/test/boundary_push3.ok

@@ -1,5 +1,5 @@
 [INFO ODB-0227] LEF file: ./Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
-[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 9 library cells
+[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 10 library cells
 [INFO ODB-0128] Design: boundary_push1
 [INFO ODB-0130]     Created 4 pins.
 [INFO ODB-0131]     Created 54 components and 308 component-terminals.

src/mpl/test/centralization1.ok

@@ -1,5 +1,5 @@
 [INFO ODB-0227] LEF file: ./Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
-[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 9 library cells
+[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 10 library cells
 [INFO ODB-0128] Design: centralization1
 [INFO ODB-0130]     Created 1 pins.
 [INFO ODB-0131]     Created 1 components and 2 component-terminals.

src/mpl/test/fixed_covers.ok

@@ -1,8 +1,9 @@
 [INFO ODB-0227] LEF file: ./Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
 [INFO ODB-0227] LEF file: ./Nangate45_io/dummy_pads.lef, created 29 library cells
-[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 9 library cells
+[INFO ODB-0227] LEF file: ./testcases/orientation_improve1.lef, created 10 library cells
 [INFO ODB-0128] Design: boundary_push1
 [INFO ODB-0131]     Created 402 components and 2404 component-terminals.
+[INFO MPL-0062] Found fixed macro MACRO_1.
 Die Area: (0.00, 0.00) (220.02, 221.20),  Floorplan Area: (0.00, 0.00) (220.02, 221.20)
 	Number of std cell instances: 400
 	Area of std cell instances: 1808.80

src/mpl/test/fixed_covers.tcl

@@ -1,6 +1,4 @@
-# Test if the packing engine can handle one fixed
-# macro and two movable macros without generating
-# overlap.
+# Test if firm COVERs are properly ignored.
 source "helpers.tcl"
 
 read_lef "./Nangate45/Nangate45.lef"