mpl2: prevent mpl2 flow to go on if there are fixed instances inside the area defined for the macro placement

Signed-off-by: Arthur Koucher <arthurkoucher@precisioninno.com>

Author: AcKoucher

src/mpl2/src/clusterEngine.cpp

@@ -112,41 +112,23 @@ void ClusteringEngine::init()
     return;
   }
 
-  tree_->macro_with_halo_area = computeMacroWithHaloArea(unfixed_macros);
-
-  const odb::Rect die = block_->getDieArea();
-  const odb::Rect core_box = block_->getCoreArea();
-
-  const float core_lx = block_->dbuToMicrons(core_box.xMin());
-  const float core_ly = block_->dbuToMicrons(core_box.yMin());
-  const float core_ux = block_->dbuToMicrons(core_box.xMax());
-  const float core_uy = block_->dbuToMicrons(core_box.yMax());
+  setFloorplanShape();
+  searchForFixedInstsInsideFloorplanShape();
 
-  const float core_area = (core_ux - core_lx) * (core_uy - core_ly);
+  tree_->macro_with_halo_area = computeMacroWithHaloArea(unfixed_macros);
   const float inst_area_with_halos
       = tree_->macro_with_halo_area + design_metrics_->getStdCellArea();
 
-  if (inst_area_with_halos > core_area) {
+  if (inst_area_with_halos > tree_->floorplan_shape.getArea()) {
     logger_->error(MPL,
                    16,
                    "The instance area considering the macros' halos {} exceeds "
-                   "the core area {}",
+                   "the floorplan area {}",
                    inst_area_with_halos,
-                   core_area);
+                   tree_->floorplan_shape.getArea());
   }
 
-  logger_->report(
-      "Floorplan Outline: ({}, {}) ({}, {}),  Core Outline: ({}, {}) ({}, {})",
-      block_->dbuToMicrons(die.xMin()),
-      block_->dbuToMicrons(die.yMin()),
-      block_->dbuToMicrons(die.xMax()),
-      block_->dbuToMicrons(die.yMax()),
-      core_lx,
-      core_ly,
-      core_ux,
-      core_uy);
-
-  reportDesignData(core_area);
+  reportDesignData();
 }
 
 float ClusteringEngine::computeMacroWithHaloArea(
@@ -175,6 +157,39 @@ std::vector<odb::dbInst*> ClusteringEngine::getUnfixedMacros()
   return unfixed_macros;
 }
 
+void ClusteringEngine::setFloorplanShape()
+{
+  const odb::Rect& core_box = block_->getCoreArea();
+  const float core_lx = block_->dbuToMicrons(core_box.xMin());
+  const float core_ly = block_->dbuToMicrons(core_box.yMin());
+  const float core_ux = block_->dbuToMicrons(core_box.xMax());
+  const float core_uy = block_->dbuToMicrons(core_box.yMax());
+
+  tree_->floorplan_shape = Rect(std::max(core_lx, tree_->global_fence.xMin()),
+                                std::max(core_ly, tree_->global_fence.yMin()),
+                                std::min(core_ux, tree_->global_fence.xMax()),
+                                std::min(core_uy, tree_->global_fence.yMax()));
+}
+
+void ClusteringEngine::searchForFixedInstsInsideFloorplanShape()
+{
+  odb::Rect floorplan_shape(
+      block_->micronsToDbu(tree_->floorplan_shape.xMin()),
+      block_->micronsToDbu(tree_->floorplan_shape.yMin()),
+      block_->micronsToDbu(tree_->floorplan_shape.xMax()),
+      block_->micronsToDbu(tree_->floorplan_shape.yMax()));
+
+  for (odb::dbInst* inst : block_->getInsts()) {
+    if (inst->isFixed()
+        && inst->getBBox()->getBox().overlaps(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;
@@ -218,14 +233,26 @@ Metrics* ClusteringEngine::computeModuleMetrics(odb::dbModule* module)
   return tree_->maps.module_to_metrics[module].get();
 }
 
-void ClusteringEngine::reportDesignData(const float core_area)
+void ClusteringEngine::reportDesignData()
 {
+  const odb::Rect& die = block_->getDieArea();
+  logger_->report(
+      "Die Area: ({}, {}) ({}, {}),  Floorplan Area: ({}, {}) ({}, {})",
+      block_->dbuToMicrons(die.xMin()),
+      block_->dbuToMicrons(die.yMin()),
+      block_->dbuToMicrons(die.xMax()),
+      block_->dbuToMicrons(die.yMax()),
+      tree_->floorplan_shape.xMin(),
+      tree_->floorplan_shape.yMin(),
+      tree_->floorplan_shape.xMax(),
+      tree_->floorplan_shape.yMax());
+
   float util
       = (design_metrics_->getStdCellArea() + design_metrics_->getMacroArea())
-        / core_area;
-  float core_util = design_metrics_->getStdCellArea()
-                    / (core_area - design_metrics_->getMacroArea());
-
+        / tree_->floorplan_shape.getArea();
+  float floorplan_util
+      = design_metrics_->getStdCellArea()
+        / (tree_->floorplan_shape.getArea() - design_metrics_->getMacroArea());
   logger_->report(
       "\tNumber of std cell instances: {}\n"
       "\tArea of std cell instances: {:.2f}\n"
@@ -235,9 +262,9 @@ void ClusteringEngine::reportDesignData(const float core_area)
       "\tHalo height: {:.2f}\n"
       "\tArea of macros with halos: {:.2f}\n"
       "\tArea of std cell instances + Area of macros: {:.2f}\n"
-      "\tCore area: {:.2f}\n"
+      "\tFloorplan area: {:.2f}\n"
       "\tDesign Utilization: {:.2f}\n"
-      "\tCore Utilization: {:.2f}\n"
+      "\tFloorplan Utilization: {:.2f}\n"
       "\tManufacturing Grid: {}\n",
       design_metrics_->getNumStdCell(),
       design_metrics_->getStdCellArea(),
@@ -247,9 +274,9 @@ void ClusteringEngine::reportDesignData(const float core_area)
       tree_->halo_height,
       tree_->macro_with_halo_area,
       design_metrics_->getStdCellArea() + design_metrics_->getMacroArea(),
-      core_area,
+      tree_->floorplan_shape.getArea(),
       util,
-      core_util,
+      floorplan_util,
       block_->getTech()->getManufacturingGrid());
 }
 

src/mpl2/src/clusterEngine.h

@@ -117,6 +117,8 @@ struct PhysicalHierarchy
   float halo_width{0.0f};
   float halo_height{0.0f};
   float macro_with_halo_area{0.0f};
+  Rect global_fence;
+  Rect floorplan_shape;
 
   bool has_io_clusters{true};
   bool has_only_macros{false};
@@ -176,9 +178,11 @@ class ClusteringEngine
   void init();
   Metrics* computeModuleMetrics(odb::dbModule* module);
   std::vector<odb::dbInst*> getUnfixedMacros();
+  void setFloorplanShape();
+  void searchForFixedInstsInsideFloorplanShape();
   float computeMacroWithHaloArea(
       const std::vector<odb::dbInst*>& unfixed_macros);
-  void reportDesignData(float core_area);
+  void reportDesignData();
   void createRoot();
   void setBaseThresholds();
   void createIOClusters();

src/mpl2/src/hier_rtlmp.cpp

@@ -129,10 +129,7 @@ void HierRTLMP::setGlobalFence(float fence_lx,
                                float fence_ux,
                                float fence_uy)
 {
-  global_fence_lx_ = fence_lx;
-  global_fence_ly_ = fence_ly;
-  global_fence_ux_ = fence_ux;
-  global_fence_uy_ = fence_uy;
+  tree_->global_fence = Rect(fence_lx, fence_ly, fence_ux, fence_uy);
 }
 
 void HierRTLMP::setHaloWidth(float halo_width)
@@ -370,31 +367,15 @@ void HierRTLMP::setRootShapes()
 {
   auto root_soft_macro = std::make_unique<SoftMacro>(tree_->root.get());
 
-  const float core_lx
-      = static_cast<float>(block_->dbuToMicrons(block_->getCoreArea().xMin()));
-  const float root_lx = std::max(core_lx, global_fence_lx_);
-
-  const float core_ly
-      = static_cast<float>(block_->dbuToMicrons(block_->getCoreArea().yMin()));
-  const float root_ly = std::max(core_ly, global_fence_ly_);
-
-  const float core_ux
-      = static_cast<float>(block_->dbuToMicrons(block_->getCoreArea().xMax()));
-  const float root_ux = std::min(core_ux, global_fence_ux_);
-
-  const float core_uy
-      = static_cast<float>(block_->dbuToMicrons(block_->getCoreArea().yMax()));
-  const float root_uy = std::min(core_uy, global_fence_uy_);
-
-  const float root_area = (root_ux - root_lx) * (root_uy - root_ly);
-  const float root_width = root_ux - root_lx;
+  const float root_area = tree_->floorplan_shape.getArea();
+  const float root_width = tree_->floorplan_shape.getWidth();
   const std::vector<std::pair<float, float>> root_width_list
       = {std::pair<float, float>(root_width, root_width)};
 
   root_soft_macro->setShapes(root_width_list, root_area);
   root_soft_macro->setWidth(root_width);  // This will set height automatically
-  root_soft_macro->setX(root_lx);
-  root_soft_macro->setY(root_ly);
+  root_soft_macro->setX(tree_->floorplan_shape.xMin());
+  root_soft_macro->setY(tree_->floorplan_shape.yMin());
   tree_->root->setSoftMacro(std::move(root_soft_macro));
 }
 

src/mpl2/src/hier_rtlmp.h

@@ -272,12 +272,6 @@ class HierRTLMP
   std::string report_directory_;
   std::string macro_placement_file_;
 
-  // User can specify a global region for some designs
-  float global_fence_lx_ = std::numeric_limits<float>::max();
-  float global_fence_ly_ = std::numeric_limits<float>::max();
-  float global_fence_ux_ = 0.0;
-  float global_fence_uy_ = 0.0;
-
   const int num_runs_ = 10;    // number of runs for SA
   int num_threads_ = 10;       // number of threads
   const int random_seed_ = 0;  // random seed for deterministic

src/mpl2/src/object.h

@@ -629,13 +629,13 @@ struct Rect
   float yMax() const { return uy; }
 
   float getX() const { return (lx + ux) / 2.0; }
-
   float getY() const { return (ly + uy) / 2.0; }
 
   float getWidth() const { return ux - lx; }
-
   float getHeight() const { return uy - ly; }
 
+  float getArea() const { return getWidth() * getHeight(); }
+
   void setLoc(float x,
               float y,
               float core_lx,

src/mpl2/test/guides1.ok

@@ -13,7 +13,7 @@ Using 2 tracks default min distance between IO pins.
 [INFO PPL-0003] Number of I/O w/sink      0
 [INFO PPL-0004] Number of I/O w/o sink    3
 [INFO PPL-0012] I/O nets HPWL: 0.00 um.
-Floorplan Outline: (0, 0) (150, 125),  Core Outline: (0, 0) (149.91, 124.6)
+Die Area: (0, 0) (150, 125),  Floorplan Area: (0, 0) (149.91, 124.6)
 	Number of std cell instances: 400
 	Area of std cell instances: 1808.79
 	Number of macros: 1
@@ -22,9 +22,9 @@ Floorplan Outline: (0, 0) (150, 125),  Core Outline: (0, 0) (149.91, 124.6)
 	Halo height: 4.00
 	Area of macros with halos: 11664.00
 	Area of std cell instances + Area of macros: 11808.79
-	Core area: 18678.79
+	Floorplan area: 18678.79
 	Design Utilization: 0.63
-	Core Utilization: 0.21
+	Floorplan Utilization: 0.21
 	Manufacturing Grid: 10
 
 [WARNING MPL-0014] No Liberty data found for std cells. Continuing without dataflow.

src/mpl2/test/guides2.ok

@@ -3,7 +3,7 @@
 [WARNING STA-1171] ./testcases/macro_only.lib line 32, default_max_transition is 0.0.
 [INFO ODB-0128] Design: macro_only
 [INFO ODB-0253]     Updated 10 components.
-Floorplan Outline: (0, 0) (450, 450),  Core Outline: (4.94, 4.2) (444.98, 443.8)
+Die Area: (0, 0) (450, 450),  Floorplan Area: (4.94, 4.2) (444.98, 443.8)
 	Number of std cell instances: 0
 	Area of std cell instances: 0.00
 	Number of macros: 10
@@ -12,9 +12,9 @@ Floorplan Outline: (0, 0) (450, 450),  Core Outline: (4.94, 4.2) (444.98, 443.8)
 	Halo height: 4.00
 	Area of macros with halos: 187920.00
 	Area of std cell instances + Area of macros: 166000.00
-	Core area: 193441.58
+	Floorplan area: 193441.58
 	Design Utilization: 0.86
-	Core Utilization: 0.00
+	Floorplan Utilization: 0.00
 	Manufacturing Grid: 10
 
 [WARNING MPL-0026] Design has no IO pins!

src/mpl2/test/macro_only.ok

@@ -3,7 +3,7 @@
 [WARNING STA-1171] ./testcases/macro_only.lib line 32, default_max_transition is 0.0.
 [INFO ODB-0128] Design: macro_only
 [INFO ODB-0253]     Updated 10 components.
-Floorplan Outline: (0, 0) (450, 450),  Core Outline: (4.94, 4.2) (444.98, 443.8)
+Die Area: (0, 0) (450, 450),  Floorplan Area: (4.94, 4.2) (444.98, 443.8)
 	Number of std cell instances: 0
 	Area of std cell instances: 0.00
 	Number of macros: 10
@@ -12,9 +12,9 @@ Floorplan Outline: (0, 0) (450, 450),  Core Outline: (4.94, 4.2) (444.98, 443.8)
 	Halo height: 4.00
 	Area of macros with halos: 187920.00
 	Area of std cell instances + Area of macros: 166000.00
-	Core area: 193441.58
+	Floorplan area: 193441.58
 	Design Utilization: 0.86
-	Core Utilization: 0.00
+	Floorplan Utilization: 0.00
 	Manufacturing Grid: 10
 
 [WARNING MPL-0026] Design has no IO pins!