Merge pull request #6530 from The-OpenROAD-Project-staging/gpl-binSize-float

Gpl: change bin size from int to float

Author: maliberty

src/gpl/src/fft.cpp

@@ -14,7 +14,7 @@
 
 namespace gpl {
 
-FFT::FFT(int binCntX, int binCntY, int binSizeX, int binSizeY)
+FFT::FFT(int binCntX, int binCntY, float binSizeX, float binSizeY)
     : binCntX_(binCntX),
       binCntY_(binCntY),
       binSizeX_(binSizeX),

src/gpl/src/fft.h

@@ -11,7 +11,7 @@ namespace gpl {
 class FFT
 {
  public:
-  FFT(int binCntX, int binCntY, int binSizeX, int binSizeY);
+  FFT(int binCntX, int binCntY, float binSizeX, float binSizeY);
   ~FFT();
 
   // input func
@@ -50,8 +50,8 @@ class FFT
 
   int binCntX_ = 0;
   int binCntY_ = 0;
-  int binSizeX_ = 0;
-  int binSizeY_ = 0;
+  float binSizeX_ = 0;
+  float binSizeY_ = 0;
 };
 
 //

src/gpl/src/graphics.cpp

@@ -492,6 +492,33 @@ bool Graphics::populateMap()
   return true;
 }
 
+void Graphics::populateXYGrid()
+{
+  BinGrid& grid = nbVec_[0]->getBinGrid();
+  std::vector<Bin>& bin = grid.bins();
+  int x_grid = grid.binCntX();
+  int y_grid = grid.binCntY();
+
+  std::vector<int> x_grid_set, y_grid_set;
+  x_grid_set.reserve(x_grid + 1);
+  y_grid_set.reserve(y_grid + 1);
+
+  x_grid_set.push_back(bin[0].lx());
+  y_grid_set.push_back(bin[0].ly());
+
+  for (int x = 0; x < x_grid && x < static_cast<int>(bin.size()); x++) {
+    x_grid_set.push_back(bin[x].ux());
+  }
+
+  for (int y = 0; y < y_grid; y++) {
+    size_t index = static_cast<size_t>(y) * static_cast<size_t>(x_grid);
+    if (index < bin.size()) {
+      y_grid_set.push_back(bin[index].uy());
+    }
+  }
+  setXYMapGrid(x_grid_set, y_grid_set);
+}
+
 void Graphics::combineMapData(bool base_has_value,
                               double& base,
                               const double new_data,

src/gpl/src/graphics.h

@@ -79,6 +79,7 @@ class Graphics : public gui::Renderer, public gui::HeatMapDataSource
                       double data_area,
                       double intersection_area,
                       double rect_area) override;
+  void populateXYGrid() override;
 
   // Is the GUI being displayed (true) or are we in batch mode (false)
   static bool guiActive();

src/gpl/src/nesterovBase.cpp

@@ -30,8 +30,6 @@ namespace gpl {
 using odb::dbBlock;
 using utl::GPL;
 
-static int fastModulo(int input, int ceil);
-
 static float calculateBiVariateNormalCDF(biNormalParameters i);
 
 static int64_t getOverlapArea(const Bin* bin,
@@ -692,12 +690,12 @@ int BinGrid::binCntY() const
   return binCntY_;
 }
 
-int BinGrid::binSizeX() const
+double BinGrid::binSizeX() const
 {
   return binSizeX_;
 }
 
-int BinGrid::binSizeY() const
+double BinGrid::binSizeY() const
 {
   return binSizeY_;
 }
@@ -800,8 +798,8 @@ void BinGrid::initBins()
   log_->info(
       GPL, 28, "{:21} {:7d} , {:6d}", "Bin count (X, Y):", binCntX_, binCntY_);
 
-  binSizeX_ = std::ceil(static_cast<float>((ux_ - lx_)) / binCntX_);
-  binSizeY_ = std::ceil(static_cast<float>((uy_ - ly_)) / binCntY_);
+  binSizeX_ = static_cast<double>((ux_ - lx_)) / binCntX_;
+  binSizeY_ = static_cast<double>((uy_ - ly_)) / binCntY_;
 
   log_->info(GPL,
              29,
@@ -815,13 +813,24 @@ void BinGrid::initBins()
 #pragma omp parallel for num_threads(num_threads_)
   for (int idxY = 0; idxY < binCntY_; ++idxY) {
     for (int idxX = 0; idxX < binCntX_; ++idxX) {
-      const int x = lx_ + idxX * binSizeX_;
-      const int y = ly_ + idxY * binSizeY_;
-      const int sizeX = std::min(ux_ - x, binSizeX_);
-      const int sizeY = std::min(uy_ - y, binSizeY_);
-
-      bins_[idxY * binCntX_ + idxX]
-          = Bin(idxX, idxY, x, y, x + sizeX, y + sizeY, targetDensity_);
+      const int bin_lx = lx_ + std::lround(idxX * binSizeX_);
+      const int bin_ly = ly_ + std::lround(idxY * binSizeY_);
+      const int bin_ux = lx_ + std::lround((idxX + 1) * binSizeX_);
+      const int bin_uy = ly_ + std::lround((idxY + 1) * binSizeY_);
+      const int bin_index = idxY * binCntX_ + idxX;
+      bins_[bin_index]
+          = Bin(idxX, idxY, bin_lx, bin_ly, bin_ux, bin_uy, targetDensity_);
+      auto& bin = bins_[bin_index];
+      if (bin.dx() < 0 || bin.dy() < 0) {
+        log_->warn(GPL,
+                   34,
+                   "Bin (center: {},{}, index: {}) has negative size: {}, {}",
+                   bin.cx(),
+                   bin.cy(),
+                   bin_index,
+                   bin.dx(),
+                   bin.dy());
+      }
     }
   }
 
@@ -978,9 +987,7 @@ void BinGrid::updateBinsGCellDensityArea(const std::vector<GCellHandle>& cells)
 std::pair<int, int> BinGrid::getDensityMinMaxIdxX(const GCell* gcell) const
 {
   int lowerIdx = (gcell->dLx() - lx()) / binSizeX_;
-  int upperIdx = (fastModulo((gcell->dUx() - lx()), binSizeX_) == 0)
-                     ? (gcell->dUx() - lx()) / binSizeX_
-                     : (gcell->dUx() - lx()) / binSizeX_ + 1;
+  int upperIdx = std::ceil((gcell->dUx() - lx()) / binSizeX_);
 
   lowerIdx = std::max(lowerIdx, 0);
   upperIdx = std::min(upperIdx, binCntX_);
@@ -990,9 +997,7 @@ std::pair<int, int> BinGrid::getDensityMinMaxIdxX(const GCell* gcell) const
 std::pair<int, int> BinGrid::getDensityMinMaxIdxY(const GCell* gcell) const
 {
   int lowerIdx = (gcell->dLy() - ly()) / binSizeY_;
-  int upperIdx = (fastModulo((gcell->dUy() - ly()), binSizeY_) == 0)
-                     ? (gcell->dUy() - ly()) / binSizeY_
-                     : (gcell->dUy() - ly()) / binSizeY_ + 1;
+  int upperIdx = std::ceil((gcell->dUy() - ly()) / binSizeY_);
 
   lowerIdx = std::max(lowerIdx, 0);
   upperIdx = std::min(upperIdx, binCntY_);
@@ -1002,19 +1007,15 @@ std::pair<int, int> BinGrid::getDensityMinMaxIdxY(const GCell* gcell) const
 std::pair<int, int> BinGrid::getMinMaxIdxX(const Instance* inst) const
 {
   int lowerIdx = (inst->lx() - lx()) / binSizeX_;
-  int upperIdx = (fastModulo((inst->ux() - lx()), binSizeX_) == 0)
-                     ? (inst->ux() - lx()) / binSizeX_
-                     : (inst->ux() - lx()) / binSizeX_ + 1;
+  int upperIdx = std::ceil((inst->ux() - lx()) / binSizeX_);
 
   return std::make_pair(std::max(lowerIdx, 0), std::min(upperIdx, binCntX_));
 }
 
 std::pair<int, int> BinGrid::getMinMaxIdxY(const Instance* inst) const
 {
   int lowerIdx = (inst->ly() - ly()) / binSizeY_;
-  int upperIdx = (fastModulo((inst->uy() - ly()), binSizeY_) == 0)
-                     ? (inst->uy() - ly()) / binSizeY_
-                     : (inst->uy() - ly()) / binSizeY_ + 1;
+  int upperIdx = std::ceil((inst->uy() - ly()) / binSizeY_);
 
   return std::make_pair(std::max(lowerIdx, 0), std::min(upperIdx, binCntY_));
 }
@@ -1901,12 +1902,12 @@ int NesterovBase::binCntY() const
   return bg_.binCntY();
 }
 
-int NesterovBase::binSizeX() const
+double NesterovBase::binSizeX() const
 {
   return bg_.binSizeX();
 }
 
-int NesterovBase::binSizeY() const
+double NesterovBase::binSizeY() const
 {
   return bg_.binSizeY();
 }
@@ -3370,12 +3371,6 @@ void NesterovBaseCommon::printGPins()
   }
 }
 
-// https://stackoverflow.com/questions/33333363/built-in-mod-vs-custom-mod-function-improve-the-performance-of-modulus-op
-static int fastModulo(const int input, const int ceil)
-{
-  return input >= ceil ? input % ceil : input;
-}
-
 static float getOverlapDensityArea(const Bin& bin, const GCell* cell)
 {
   const int rectLx = std::max(bin.lx(), cell->dLx());

src/gpl/src/nesterovBase.h

@@ -676,8 +676,8 @@ class BinGrid
 
   int binCntX() const;
   int binCntY() const;
-  int binSizeX() const;
-  int binSizeY() const;
+  double binSizeX() const;
+  double binSizeY() const;
 
   int64_t overflowArea() const;
   int64_t overflowAreaUnscaled() const;
@@ -704,8 +704,8 @@ class BinGrid
   int uy_ = 0;
   int binCntX_ = 0;
   int binCntY_ = 0;
-  int binSizeX_ = 0;
-  int binSizeY_ = 0;
+  double binSizeX_ = 0;
+  double binSizeY_ = 0;
   float targetDensity_ = 0;
   int64_t sumOverflowArea_ = 0;
   int64_t sumOverflowAreaUnscaled_ = 0;
@@ -924,8 +924,8 @@ class NesterovBase
 
   int binCntX() const;
   int binCntY() const;
-  int binSizeX() const;
-  int binSizeY() const;
+  double binSizeX() const;
+  double binSizeY() const;
   int64_t overflowArea() const;
   int64_t overflowAreaUnscaled() const;
 

src/gpl/src/nesterovPlace.cpp

@@ -339,7 +339,11 @@ int NesterovPlace::doNesterovPlace(int start_iter)
       }
 
       if (num_region_diverged_ > 0) {
-        divergeMsg_ = "RePlAce diverged at newStepLength.";
+        divergeMsg_
+            = "RePlAce diverged during gradient descent calculation, resulting "
+              "in an invalid step length (Inf or NaN). This is often caused by "
+              "numerical instability or high placement density. Consider "
+              "reducing placement density to potentially resolve the issue.";
         divergeCode_ = 305;
         break;
       }