Merge pull request #8900 from The-OpenROAD-Project-staging/options-parsing

gpl: Improved options parsing (example template)

Author: maliberty

BUILD.bazel

@@ -22,6 +22,7 @@ exports_files([
     "LICENSE",
     "src/Design.i",
     "src/Exception.i",
+    "src/options.i",
 ])
 
 string_flag(
@@ -298,6 +299,7 @@ py_library(
     imports = ["."],
     visibility = ["//visibility:public"],
     deps = [
+        "//src/gpl:gpl_py",
         "//src/odb:odb_py",
         "//src/utl:utl_py",
     ],
@@ -362,3 +364,11 @@ filegroup(
         "src/Design.i",
     ],
 )
+
+filegroup(
+    name = "options_swig",
+    srcs = [
+        "src/options.i",
+    ],
+    visibility = ["@//:__subpackages__"],
+)

src/Exception-py.i

@@ -31,7 +31,7 @@
   // This catches std::runtime_error (utl::error) and sta::Exception.
   catch (std::exception &excp) {
     #ifdef BAZEL
-    Logger* logger = Logger::defaultLogger();
+    utl::Logger* logger = utl::Logger::defaultLogger();
     if (logger->debugCheck(utl::ORD, "trace", 1)) {
       std::stringstream trace;
       trace << boost::stacktrace::stacktrace();
@@ -56,7 +56,7 @@
   }
   catch (...) {
     #ifdef BAZEL
-    Logger* logger = Logger::defaultLogger();
+    utl::Logger* logger = utl::Logger::defaultLogger();
     if (logger->debugCheck(utl::ORD, "trace", 1)) {
       std::stringstream trace;
       trace << boost::stacktrace::stacktrace();

src/OpenRoad.i

@@ -493,20 +493,10 @@ microns_to_dbu(double microns)
 
 // Common check for placement tools.
 bool
-db_has_rows()
+db_has_core_rows()
 {
   dbDatabase *db = OpenRoad::openRoad()->getDb();
-  if (!db->getChip() || !db->getChip()->getBlock()) {
-    return false;
-  }
-
-  for (odb::dbRow* row : db->getChip()->getBlock()->getRows()) {
-    if (row->getSite()->getClass() != odb::dbSiteClass::PAD) {
-      return true;
-    }
-  }
-
-  return false;
+  return dbHasCoreRows(db);
 }
 
 bool

src/dpl/src/Opendp.tcl

@@ -39,7 +39,7 @@ proc detailed_placement { args } {
     utl::warn DPL 3 "-disallow_one_site_gaps is deprecated"
   }
 
-  if { [ord::db_has_rows] } {
+  if { [ord::db_has_core_rows] } {
     set site [dpl::get_row_site]
     # Convert displacement from microns to sites.
     set max_displacement_x [expr [ord::microns_to_dbu $max_displacement_x] \

src/gpl/BUILD

@@ -1,8 +1,10 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright (c) 2025, The OpenROAD Authors
 
+load("@openroad_rules_python//python:defs.bzl", "py_library")
+load("@rules_cc//cc:cc_binary.bzl", "cc_binary")
 load("@rules_cc//cc:cc_library.bzl", "cc_library")
-load("//bazel:python_wrap_cc.bzl", "python_wrap_cc")
+load("//bazel:python_wrap_cc.bzl", "PYTHON_STABLE_API_DEFINE", "python_wrap_cc")
 load("//bazel:tcl_encode_or.bzl", "tcl_encode")
 load("//bazel:tcl_wrap_cc.bzl", "tcl_wrap_cc")
 
@@ -83,27 +85,61 @@ cc_library(
     ],
 )
 
+# This target compiles the SWIG C++ wrapper into a shared library (.so)
+# that Python can load dynamically.
+cc_binary(
+    name = "_gpl.so",
+    srcs = [
+        ":swig-py",
+    ],
+    defines = [PYTHON_STABLE_API_DEFINE],
+    includes = ["src"],
+    linkshared = True,
+    deps = [
+        "//src/gpl",
+        "//src/odb",
+        "//src/utl",
+        "@boost.stacktrace",
+        "@openroad_rules_python//python/cc:current_py_cc_headers",
+    ],
+)
+
+# This packages the SWIG-generated Python wrapper (gpl.py) and the
+# compiled C++ extension (_gpl.so) together.
+py_library(
+    name = "gpl_py",
+    srcs = [":swig-py"],  # Use the .py output from the swig-py rule
+    # The data attribute makes the .so file available at runtime.
+    data = [":_gpl.so"],
+    # This allows imports relative to the workspace root.
+    imports = ["."],
+    visibility = ["//visibility:public"],
+)
+
 tcl_encode(
     name = "tcl",
     srcs = [
         "src/replace.tcl",
     ],
     char_array_name = "gpl_tcl_inits",
     namespace = "gpl",
+    visibility = ["//visibility:public"],
 )
 
 tcl_wrap_cc(
     name = "swig",
     srcs = [
         "src/replace.i",
         "//:error_swig",
+        "//:options_swig",
     ],
     module = "gpl",
     namespace_prefix = "gpl",
     root_swig_src = "src/replace.i",
     swig_includes = [
         "src/gpl/src",
     ],
+    visibility = ["//visibility:public"],
     deps = [
         "//src/odb:swig",
     ],

src/gpl/README.md

@@ -67,8 +67,6 @@ Timing-driven arguments
 global_placement
     [-timing_driven]
     [-routability_driven]
-    [-disable_timing_driven]
-    [-disable_routability_driven]
     [-skip_initial_place]
     [-incremental]
     [-bin_grid_count grid_count]

src/gpl/include/gpl/Replace.h

@@ -44,6 +44,57 @@ class NesterovPlace;
 using Cluster = std::vector<odb::dbInst*>;
 using Clusters = std::vector<Cluster>;
 
+struct PlaceOptions
+{
+  int initialPlaceMaxIter = 20;
+  int initialPlaceMinDiffLength = 1500;
+  int initialPlaceMaxSolverIter = 100;
+  int initialPlaceMaxFanout = 200;
+  float initialPlaceNetWeightScale = 800;
+
+  bool skipIoMode = false;
+  bool timingDrivenMode = false;
+  bool routabilityDrivenMode = false;
+  bool uniformTargetDensityMode = false;
+  std::vector<int> timingNetWeightOverflows{64, 20};
+  float timingNetWeightMax = 5;
+  float overflow = 0.1;
+  int nesterovPlaceMaxIter = 5000;
+  // timing driven check overflow to keep resizer changes (non-virtual resizer)
+  float keepResizeBelowOverflow = 1.0;
+  bool routabilityUseRudy = true;
+  bool disableRevertIfDiverge = false;
+  bool enable_routing_congestion = false;
+  float minPhiCoef = 0.95;
+  float maxPhiCoef = 1.05;
+  float initDensityPenaltyFactor = 0.00008;
+  float initWireLengthCoef = 0.25;
+  float referenceHpwl = 446000000;
+  int binGridCntX = 0;
+  int binGridCntY = 0;
+  float density = 0.7;
+
+  float routabilityCheckOverflow = 0.3;
+  float routabilityMaxDensity = 0.99;
+  float routabilityTargetRcMetric = 1.01;
+  float routabilityInflationRatioCoef = 2;
+  float routabilityMaxInflationRatio = 3;
+  int routabilityMaxInflationIter = 4;
+
+  // routability RC metric coefficients
+  float routabilityRcK1 = 1.0;
+  float routabilityRcK2 = 1.0;
+  float routabilityRcK3 = 0.0;
+  float routabilityRcK4 = 0.0;
+
+  // OpenDB should have these values.
+  int padLeft = 0;
+  int padRight = 0;
+
+  void skipIo();
+  void validate(utl::Logger* log);
+};
+
 class Replace
 {
  public:
@@ -64,62 +115,19 @@ class Replace
 
   void reset();
 
-  void doIncrementalPlace(int threads);
-  void doInitialPlace(int threads);
+  void doIncrementalPlace(int threads, const PlaceOptions& options = {});
+  void doPlace(int threads, const PlaceOptions& options = {});
+  void doInitialPlace(int threads, const PlaceOptions& options = {});
+  int doNesterovPlace(int threads,
+                      const PlaceOptions& options = {},
+                      int start_iter = 0);
+
   void runMBFF(int max_sz, float alpha, float beta, int threads, int num_paths);
 
   void addPlacementCluster(const Cluster& cluster);
-  int doNesterovPlace(int threads, int start_iter = 0);
-
-  // Initial Place param settings
-  void setInitialPlaceMaxIter(int iter);
-  void setInitialPlaceMinDiffLength(int length);
-  void setInitialPlaceMaxSolverIter(int iter);
-  void setInitialPlaceMaxFanout(int fanout);
-  void setInitialPlaceNetWeightScale(float scale);
-
-  void setNesterovPlaceMaxIter(int iter);
-
-  void setBinGridCnt(int binGridCntX, int binGridCntY);
-
-  void setTargetDensity(float density);
-  // Execute gpl with uniform density as target density
-  void setUniformTargetDensityMode(bool mode);
-  void setTargetOverflow(float overflow);
-  void setInitDensityPenalityFactor(float penaltyFactor);
-  void setInitWireLengthCoef(float coef);
-  void setMinPhiCoef(float minPhiCoef);
-  void setMaxPhiCoef(float maxPhiCoef);
 
   // Query for uniform density value
-  float getUniformTargetDensity(int threads);
-
-  // HPWL: half-parameter wire length.
-  void setReferenceHpwl(float refHpwl);
-
-  // temp funcs; OpenDB should have these values.
-  void setPadLeft(int padding);
-  void setPadRight(int padding);
-
-  void setTimingDrivenMode(bool mode);
-
-  void setSkipIoMode(bool mode);
-  void setDisableRevertIfDiverge(bool mode);
-
-  void setRoutabilityDrivenMode(bool mode);
-  void setRoutabilityUseGrt(bool mode);
-  void setRoutabilityCheckOverflow(float overflow);
-  void setRoutabilityMaxDensity(float density);
-  void setRoutabilityMaxInflationIter(int iter);
-  void setRoutabilityTargetRcMetric(float rc);
-  void setRoutabilityInflationRatioCoef(float coef);
-  void setRoutabilityMaxInflationRatio(float ratio);
-  void setRoutabilityRcCoefficients(float k1, float k2, float k3, float k4);
-  void setEnableRoutingCongestion(bool mode);
-
-  void addTimingNetWeightOverflow(int overflow);
-  void setTimingNetWeightMax(float max);
-  void setKeepResizeBelowOverflow(float overflow);
+  float getUniformTargetDensity(const PlaceOptions& options, int threads);
 
   void setDebug(int pause_iterations,
                 int update_iterations,
@@ -128,10 +136,11 @@ class Replace
                 odb::dbInst* inst,
                 int start_iter,
                 bool generate_images,
-                std::string images_path);
+                const std::string& images_path);
 
  private:
-  bool initNesterovPlace(int threads);
+  bool initNesterovPlace(const PlaceOptions& options, int threads);
+  void checkHasCoreRows();
 
   odb::dbDatabase* db_ = nullptr;
   sta::dbSta* sta_ = nullptr;
@@ -151,55 +160,10 @@ class Replace
   std::unique_ptr<InitialPlace> ip_;
   std::unique_ptr<NesterovPlace> np_;
 
-  int initialPlaceMaxIter_ = 20;
-  int initialPlaceMinDiffLength_ = 1500;
-  int initialPlaceMaxSolverIter_ = 100;
-  int initialPlaceMaxFanout_ = 200;
-  float initialPlaceNetWeightScale_ = 800;
-
   int total_placeable_insts_ = 0;
 
-  int nesterovPlaceMaxIter_ = 5000;
-  int binGridCntX_ = 0;
-  int binGridCntY_ = 0;
-  float overflow_ = 0.1;
-  float density_ = 1.0;
-  float initDensityPenalityFactor_ = 0.00008;
-  float initWireLengthCoef_ = 0.25;
-  float minPhiCoef_ = 0.95;
-  float maxPhiCoef_ = 1.05;
-  float referenceHpwl_ = 446000000;
-
-  float routabilityCheckOverflow_ = 0.3;
-  float routabilityMaxDensity_ = 0.99;
-  float routabilityTargetRcMetric_ = 1.01;
-  float routabilityInflationRatioCoef_ = 2;
-  float routabilityMaxInflationRatio_ = 3;
-  int routabilityMaxInflationIter_ = 4;
-
-  // routability RC metric coefficients
-  float routabilityRcK1_ = 1.0;
-  float routabilityRcK2_ = 1.0;
-  float routabilityRcK3_ = 0.0;
-  float routabilityRcK4_ = 0.0;
-
-  float timingNetWeightMax_ = 5;
-  float keepResizeBelowOverflow_ = 1.0;
-
-  bool timingDrivenMode_ = true;
-  bool routabilityDrivenMode_ = true;
-  bool routabilityUseRudy_ = true;
-  bool uniformTargetDensityMode_ = false;
-  bool skipIoMode_ = false;
-  bool disableRevertIfDiverge_ = false;
-  bool enable_routing_congestion_ = false;
-
-  std::vector<int> timingNetWeightOverflows_;
   Clusters clusters_;
 
-  // temp variable; OpenDB should have these values.
-  int padLeft_ = 0;
-  int padRight_ = 0;
   bool gui_debug_ = false;
   int gui_debug_pause_iterations_ = 10;
   int gui_debug_update_iterations_ = 10;

src/gpl/src/initialPlace.cpp

@@ -21,19 +21,15 @@ namespace gpl {
 
 using T = Eigen::Triplet<float>;
 
-InitialPlaceVars::InitialPlaceVars()
+InitialPlaceVars::InitialPlaceVars(const PlaceOptions& options,
+                                   const bool debug)
+    : maxIter(options.initialPlaceMaxIter),
+      minDiffLength(options.initialPlaceMinDiffLength),
+      maxSolverIter(options.initialPlaceMaxSolverIter),
+      maxFanout(options.initialPlaceMaxFanout),
+      netWeightScale(options.initialPlaceNetWeightScale),
+      debug(debug)
 {
-  reset();
-}
-
-void InitialPlaceVars::reset()
-{
-  maxIter = 20;
-  minDiffLength = 1500;
-  maxSolverIter = 100;
-  maxFanout = 200;
-  netWeightScale = 800.0;
-  debug = false;
 }
 
 InitialPlace::InitialPlace(InitialPlaceVars ipVars,