Merge pull request #8673 from titan73/gap_check

maliberty · web-flow · commit b7399edef144 · 2025-10-21T20:23:16.000Z
ifp: Check -gap value is positive.
diff --git a/src/ifp/include/ifp/InitFloorplan.hh b/src/ifp/include/ifp/InitFloorplan.hh
@@ -3,6 +3,8 @@
 
 #pragma once
 
+#include <cstdint>
+#include <limits>
 #include <set>
 #include <string>
 #include <vector>
@@ -51,7 +53,7 @@ class InitFloorplan
                      const std::vector<odb::dbSite*>& additional_sites = {},
                      RowParity row_parity = RowParity::NONE,
                      const std::set<odb::dbSite*>& flipped_sites = {},
-                     int gap = -1);
+                     int gap = std::numeric_limits<std::int32_t>::min());
 
   // The base_site determines the single-height rows.  For hybrid rows it is
   // a site containing a row pattern.
@@ -61,7 +63,7 @@ class InitFloorplan
                      const std::vector<odb::dbSite*>& additional_sites = {},
                      RowParity row_parity = RowParity::NONE,
                      const std::set<odb::dbSite*>& flipped_sites = {},
-                     int gap = -1);
+                     int gap = std::numeric_limits<std::int32_t>::min());
 
   void insertTiecells(odb::dbMTerm* tie_term,
                       const std::string& prefix = "TIEOFF_");
@@ -92,7 +94,7 @@ class InitFloorplan
                            = {},
                            RowParity row_parity = RowParity::NONE,
                            const std::set<odb::dbSite*>& flipped_sites = {},
-                           int gap = -1);
+                           int gap = std::numeric_limits<std::int32_t>::min());
 
   // The base_site determines the single-height rows.  For hybrid rows it is
   // a site containing a row pattern.
@@ -101,15 +103,15 @@ class InitFloorplan
                 const std::vector<odb::dbSite*>& additional_sites = {},
                 RowParity row_parity = RowParity::NONE,
                 const std::set<odb::dbSite*>& flipped_sites = {},
-                int gap = -1);
+                int gap = std::numeric_limits<std::int32_t>::min());
 
   // Create rows for a polygon core area using true polygon-aware generation
   void makePolygonRows(const odb::Polygon& core_polygon,
                        odb::dbSite* base_site,
                        const std::vector<odb::dbSite*>& additional_sites = {},
                        RowParity row_parity = RowParity::NONE,
                        const std::set<odb::dbSite*>& flipped_sites = {},
-                       int gap = -1);
+                       int gap = std::numeric_limits<std::int32_t>::min());
 
   void makeTracks();
   void makeTracks(odb::dbTechLayer* layer,
@@ -178,6 +180,8 @@ class InitFloorplan
   // this is a set of sets of all constructed site ids.
   std::set<std::set<int>> constructed_patterns_;
   std::vector<std::vector<odb::dbSite*>> repeating_row_patterns_;
+
+  void checkGap(int gap);
 };
 
 }  // namespace ifp
diff --git a/src/ifp/src/InitFloorplan.cc b/src/ifp/src/InitFloorplan.cc
@@ -6,6 +6,7 @@
 #include <algorithm>
 #include <cmath>
 #include <cstddef>
+#include <cstdint>
 #include <limits>
 #include <map>
 #include <set>
@@ -88,6 +89,13 @@ InitFloorplan::InitFloorplan(dbBlock* block,
 {
 }
 
+void InitFloorplan::checkGap(const int gap)
+{
+  if (gap != std::numeric_limits<int32_t>::min() && gap <= 0) {
+    logger_->error(IFP, 36, "Gap must be positive ({})", gap);
+  }
+}
+
 void InitFloorplan::initFloorplan(
     double utilization,
     double aspect_ratio,
@@ -101,6 +109,8 @@ void InitFloorplan::initFloorplan(
     const std::set<odb::dbSite*>& flipped_sites,
     const int gap)
 {
+  checkGap(gap);
+
   makeDieUtilization(utilization,
                      aspect_ratio,
                      core_space_bottom,
@@ -129,6 +139,8 @@ void InitFloorplan::initFloorplan(
     const std::set<odb::dbSite*>& flipped_sites,
     const int gap)
 {
+  checkGap(gap);
+
   makeDie(die);
   makeRows(core, base_site, additional_sites, row_parity, flipped_sites, gap);
 }
@@ -212,6 +224,8 @@ void InitFloorplan::makePolygonRows(
     const std::set<odb::dbSite*>& flipped_sites,
     const int gap)
 {
+  checkGap(gap);
+
   auto points = core_polygon.getPoints();
 
   if (points.empty()) {
@@ -344,6 +358,8 @@ void InitFloorplan::makeRowsWithSpacing(
     const std::set<odb::dbSite*>& flipped_sites,
     const int gap)
 {
+  checkGap(gap);
+
   odb::Rect block_die_area = block_->getDieArea();
   if (block_die_area.area() == 0) {
     logger_->error(IFP, 64, "Floorplan die area is 0. Cannot build rows.");
@@ -381,6 +397,8 @@ void InitFloorplan::makeRows(const odb::Rect& core,
                              const std::set<odb::dbSite*>& flipped_sites,
                              const int gap)
 {
+  checkGap(gap);
+
   odb::Rect block_die_area = block_->getDieArea();
   if (block_die_area.area() == 0) {
     logger_->error(IFP, 63, "Floorplan die area is 0. Cannot build rows.");
@@ -522,7 +540,9 @@ void InitFloorplan::updateVoltageDomain(const int core_lx,
         }
       }
       // Default space is 6 times the minimum site height
-      const int power_domain_y_space = (gap == -1) ? 6 * min_site_dy : gap;
+      const int power_domain_y_space
+          = (gap == std::numeric_limits<int32_t>::min()) ? 6 * min_site_dy
+                                                         : gap;
 
       row_itr = rows.begin();
       for (int row_processed = 0; row_processed < total_row_count;
diff --git a/src/ifp/src/InitFloorplan.tcl b/src/ifp/src/InitFloorplan.tcl
@@ -111,7 +111,7 @@ proc make_rows_helper { key_array } {
   }
 
   # Get gap space
-  set gap -1
+  set gap [expr -(2 ** 31)]
   if { [info exists keys(-gap)] } {
     set gap [ord::microns_to_dbu $keys(-gap)]
   }
@@ -450,7 +450,7 @@ proc make_polygon_rows_helper { key_array } {
   }
 
   # Get gap space
-  set gap -1
+  set gap [expr -(2 ** 31)]
   if { [info exists keys(-gap)] } {
     set gap [ord::microns_to_dbu $keys(-gap)]
   }
diff --git a/src/ifp/test/init_floorplan_gap.ok b/src/ifp/test/init_floorplan_gap.ok
@@ -1,5 +1,9 @@
 [INFO ODB-0227] LEF file: Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
 [INFO ODB-0227] LEF file: init_floorplan_gap.lef
+[ERROR IFP-0036] Gap must be positive (-2000)
+[ERROR IFP-0036] Gap must be positive (0)
+[ERROR IFP-0036] Gap must be positive (-2000)
+[ERROR IFP-0036] Gap must be positive (0)
 [INFO IFP-0001] Added 71 rows of 526 site FreePDK45_38x28_10R_NP_162NW_34O.
 [INFO IFP-0001] Added 35 rows of 526 site FreePDK45_38x28_10R_NP_162NW_34O_DoubleHeight.
 No differences found.
diff --git a/src/ifp/test/init_floorplan_gap.py b/src/ifp/test/init_floorplan_gap.py
@@ -23,9 +23,33 @@
 floorplan = design.getFloorplan()
 site = floorplan.findSite("FreePDK45_38x28_10R_NP_162NW_34O")
 additional_site = floorplan.findSite("FreePDK45_38x28_10R_NP_162NW_34O_DoubleHeight")
+
+# Test non positive gap
+try:
+    floorplan.initFloorplan(
+        die, core, site, [additional_site], "NONE", [], design.micronToDBU(-1)
+    )
+except Exception:
+    pass
+try:
+    floorplan.initFloorplan(
+        die, core, site, [additional_site], "NONE", [], design.micronToDBU(0)
+    )
+except Exception:
+    pass
+try:
+    floorplan.makeRows(core, site, [], "NONE", [], design.micronToDBU(-1))
+except Exception:
+    pass
+try:
+    floorplan.makeRows(core, site, [], "NONE", [], design.micronToDBU(0))
+except Exception:
+    pass
+
 floorplan.initFloorplan(
     die, core, site, [additional_site], "NONE", [], design.micronToDBU(2)
 )
+
 def_file = helpers.make_result_file("init_floorplan_gap.def")
 design.writeDef(def_file)
 helpers.diff_files("init_floorplan_gap.defok", def_file)
diff --git a/src/ifp/test/init_floorplan_gap.tcl b/src/ifp/test/init_floorplan_gap.tcl
@@ -5,9 +5,37 @@ read_lef init_floorplan_gap.lef
 read_liberty Nangate45/Nangate45_typ.lib
 read_verilog reg1.v
 link_design top
+
+set area {0 0 100 100}
+
 create_voltage_domain TEMP_ANALOG -area {34 34 66 66}
-initialize_floorplan -die_area {0 0 100 100} \
-  -core_area {0 0 100 100} \
+
+# Test non positive gap
+catch {
+  initialize_floorplan -die_area $area \
+    -core_area $area \
+    -site FreePDK45_38x28_10R_NP_162NW_34O \
+    -gap -1
+}
+catch {
+  initialize_floorplan -die_area $area \
+    -core_area $area \
+    -site FreePDK45_38x28_10R_NP_162NW_34O \
+    -gap 0
+}
+catch {
+  make_rows -core_area $area \
+    -site FreePDK45_38x28_10R_NP_162NW_34O \
+    -gap -1
+}
+catch {
+  make_rows -core_area $area \
+    -site FreePDK45_38x28_10R_NP_162NW_34O \
+    -gap 0
+}
+
+initialize_floorplan -die_area $area \
+  -core_area $area \
   -site FreePDK45_38x28_10R_NP_162NW_34O \
   -additional_sites FreePDK45_38x28_10R_NP_162NW_34O_DoubleHeight \
   -gap 2

Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ proc make_rows_helper { key_array } {`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`# Get gap space`
`114`		`- set gap -1`
	`114`	`+ set gap [expr -(2 ** 31)]`
`115`	`115`	`if { [info exists keys(-gap)] } {`
`116`	`116`	`set gap [ord::microns_to_dbu $keys(-gap)]`
`117`	`117`	`}`
`@@ -450,7 +450,7 @@ proc make_polygon_rows_helper { key_array } {`
`450`	`450`	`}`
`451`	`451`
`452`	`452`	`# Get gap space`
`453`		`- set gap -1`
	`453`	`+ set gap [expr -(2 ** 31)]`
`454`	`454`	`if { [info exists keys(-gap)] } {`
`455`	`455`	`set gap [ord::microns_to_dbu $keys(-gap)]`
`456`	`456`	`}`