Merge pull request #8238 from The-OpenROAD-Project-staging/mpl-align-macros

mpl: accept macro alignment only if it improves the result

Author: eder-matheus

src/mpl/src/SACoreSoftMacro.cpp

@@ -94,8 +94,11 @@ void SACoreSoftMacro::run()
 
   fastSA();
 
-  if (centralization_on_) {
+  if (enhancements_on_) {
     attemptCentralization(calNormCost());
+    if (centralization_was_reverted_) {
+      attemptMacroClusterAlignment();
+    }
   }
 
   if (graphics_) {
@@ -554,11 +557,16 @@ void SACoreSoftMacro::calFixedMacrosPenalty()
 }
 
 // Align macro clusters to reduce notch
-void SACoreSoftMacro::alignMacroClusters()
+void SACoreSoftMacro::attemptMacroClusterAlignment()
 {
-  if (width_ > outline_.getWidth() || height_ > outline_.getHeight()) {
+  if (!isValid()) {
     return;
   }
+
+  float pre_cost = calNormCost();
+  // Cache current solution to allow reversal
+  auto clusters_locations = getClustersLocations();
+
   // update threshold value
   adjust_h_th_ = notch_h_th_;
   adjust_v_th_ = notch_v_th_;
@@ -597,6 +605,19 @@ void SACoreSoftMacro::alignMacroClusters()
       }
     }
   }
+
+  calPenalty();
+
+  // Revert macro alignemnt
+  if (calNormCost() > pre_cost) {
+    setClustersLocations(clusters_locations);
+
+    if (graphics_) {
+      graphics_->saStep(macros_);
+    }
+
+    calPenalty();
+  }
 }
 
 float SACoreSoftMacro::calSingleNotchPenalty(float width, float height)
@@ -984,6 +1005,33 @@ void SACoreSoftMacro::addBlockages(const std::vector<Rect>& blockages)
   blockages_.insert(blockages_.end(), blockages.begin(), blockages.end());
 }
 
+std::vector<std::pair<float, float>> SACoreSoftMacro::getClustersLocations()
+    const
+{
+  std::vector<std::pair<float, float>> clusters_locations(pos_seq_.size());
+  for (int id : pos_seq_) {
+    clusters_locations[id] = {macros_[id].getX(), macros_[id].getY()};
+  }
+
+  return clusters_locations;
+}
+
+void SACoreSoftMacro::setClustersLocations(
+    const std::vector<std::pair<float, float>>& clusters_locations)
+{
+  if (clusters_locations.size() != pos_seq_.size()) {
+    logger_->error(MPL,
+                   52,
+                   "setClustersLocation called with a different numbers of "
+                   "clusters of that in the sequence pair");
+  }
+
+  for (int& id : pos_seq_) {
+    macros_[id].setX(clusters_locations[id].first);
+    macros_[id].setY(clusters_locations[id].second);
+  }
+}
+
 void SACoreSoftMacro::attemptCentralization(const float pre_cost)
 {
   if (outline_penalty_ > 0) {
@@ -993,24 +1041,18 @@ void SACoreSoftMacro::attemptCentralization(const float pre_cost)
   // In order to revert the centralization, we cache the current location
   // of the clusters to avoid floating-point evilness when creating the
   // x,y grid to fill the dead space by expanding mixed clusters.
-  std::map<int, std::pair<float, float>> clusters_locations;
-
-  for (int& id : pos_seq_) {
-    clusters_locations[id] = {macros_[id].getX(), macros_[id].getY()};
-  }
+  auto clusters_locations = getClustersLocations();
 
   std::pair<float, float> offset((outline_.getWidth() - width_) / 2,
                                  (outline_.getHeight() - height_) / 2);
   moveFloorplan(offset);
+  calPenalty();
 
   // revert centralization
   if (calNormCost() > pre_cost) {
     centralization_was_reverted_ = true;
 
-    for (int& id : pos_seq_) {
-      macros_[id].setX(clusters_locations[id].first);
-      macros_[id].setY(clusters_locations[id].second);
-    }
+    setClustersLocations(clusters_locations);
 
     if (graphics_) {
       graphics_->saStep(macros_);
@@ -1030,8 +1072,6 @@ void SACoreSoftMacro::moveFloorplan(const std::pair<float, float>& offset)
   if (graphics_) {
     graphics_->saStep(macros_);
   }
-
-  calPenalty();
 }
 
 Tiling SACoreSoftMacro::computeOverlapShape(const Rect& rect_a,

src/mpl/src/SACoreSoftMacro.h

@@ -63,14 +63,12 @@ class SACoreSoftMacro : public SimulatedAnnealingCore<SoftMacro>
   void initialize() override;
   // adjust the size of MixedCluster to fill the empty space
   void fillDeadSpace() override;
-  void alignMacroClusters();
+  void attemptMacroClusterAlignment();
   void addBlockages(const std::vector<Rect>& blockages);
 
   bool centralizationWasReverted() { return centralization_was_reverted_; }
-  void setCentralizationAttemptOn(bool centralization_on)
-  {
-    centralization_on_ = centralization_on;
-  };
+
+  void enableEnhancements() { enhancements_on_ = true; };
 
  private:
   float calNormCost() const override;
@@ -90,6 +88,9 @@ class SACoreSoftMacro : public SimulatedAnnealingCore<SoftMacro>
   void calMacroBlockagePenalty();
   void calFixedMacrosPenalty();
 
+  std::vector<std::pair<float, float>> getClustersLocations() const;
+  void setClustersLocations(
+      const std::vector<std::pair<float, float>>& clusters_locations);
   // Only for Cluster Placement:
   void attemptCentralization(float pre_cost);
   void moveFloorplan(const std::pair<float, float>& offset);
@@ -135,7 +136,7 @@ class SACoreSoftMacro : public SimulatedAnnealingCore<SoftMacro>
   // action prob
   float resize_prob_ = 0.0;
 
-  bool centralization_on_ = false;
+  bool enhancements_on_ = false;
   bool centralization_was_reverted_ = false;
 };
 

src/mpl/src/hier_rtlmp.cpp

@@ -1651,7 +1651,7 @@ void HierRTLMP::placeChildren(Cluster* parent, bool ignore_std_cell_area)
                                               logger_,
                                               block_);
       sa->setNumberOfSequencePairMacros(number_of_sequence_pair_macros);
-      sa->setCentralizationAttemptOn(true);
+      sa->enableEnhancements();
       sa->setFences(fences);
       sa->setGuides(guides);
       sa->setNets(nets);
@@ -1707,9 +1707,6 @@ void HierRTLMP::placeChildren(Cluster* parent, bool ignore_std_cell_area)
       logger_->error(MPL, 40, "Failed on cluster {}", parent->getName());
     }
   } else {
-    if (best_sa->centralizationWasReverted()) {
-      best_sa->alignMacroClusters();
-    }
     best_sa->fillDeadSpace();
 
     std::vector<SoftMacro> shaped_macros = best_sa->getMacros();