Merge pull request #8554 from eder-matheus/odb_check_pin_placement

odb: add command to check if pins are placed

Author: eder-matheus

src/odb/README.md

@@ -445,6 +445,14 @@ You can find examples on using the API from Tcl under `test/tcl/` directory.
 The full set of the Tcl commands exposed can be found under
 `./build/src/swig/tcl/opendb_wrapper.cpp`. Search for `SWIG_prefix`.
 
+### All pin placed
+
+This command checks if the IO pins of the design have a placement status of `PLACED`, `LOCKED`, `FIRM`, or `COVER`. Return `1` if true, and `0` if false.
+
+```tcl
+all_pins_placed
+```
+
 ## Regression tests
 
 There are a set of regression tests in `./test`. For more information, refer to this [section](../../README.md#regression-tests). 

src/odb/src/swig/tcl/odb.tcl

@@ -1056,6 +1056,24 @@ proc define_pin_shape_pattern { args } {
   odb::set_bterm_top_layer_grid $block $layer $x_step $y_step region $width $height $keepout
 }
 
+sta::define_cmd_args "all_pins_placed" {}
+
+proc all_pins_placed { args } {
+  sta::parse_key_args "all_pins_placed" args \
+    keys {} flags {}
+
+  set block [odb::get_block]
+
+  foreach bterm [$block getBTerms] {
+    set placement_status [$bterm getFirstPinPlacementStatus]
+    if { [lsearch -exact {PLACED LOCKED FIRM COVER} $placement_status] == -1 } {
+      return 0
+    }
+  }
+
+  return 1
+}
+
 namespace eval odb {
 proc add_direction_constraint { dir edge begin end } {
   set block [get_block]

src/odb/test/BUILD

@@ -142,6 +142,8 @@ py_test(
 # From CMakeLists.txt or_integration_tests(TESTS
 COMPULSORY_TESTS = [
     "abstract_origin",
+    "all_pins_placed1",
+    "all_pins_placed2",
     "bterm_hier_create",
     "check_routing_tracks",
     "create_blockage",
@@ -326,6 +328,12 @@ filegroup(
                 test_name + ".*",
             ],
         ) + {
+            "all_pins_placed1": [
+                "floorplan_initialize3.def",
+            ],
+            "all_pins_placed2": [
+                "design_is_routed1.def",
+            ],
             "dump_netlists": [
                 "dump_netlists_cdl.ok",
             ],

src/odb/test/CMakeLists.txt

@@ -2,6 +2,8 @@ or_integration_tests(
   "odb"
   TESTS
     abstract_origin
+    all_pins_placed1
+    all_pins_placed2
     bterm_hier_create
     check_routing_tracks
     create_blockage

src/odb/test/all_pins_placed1.ok

@@ -0,0 +1,6 @@
+[INFO ODB-0227] LEF file: Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
+[INFO ODB-0128] Design: top
+[INFO ODB-0130]     Created 6 pins.
+[INFO ODB-0131]     Created 5 components and 27 component-terminals.
+[INFO ODB-0133]     Created 10 nets and 14 connections.
+Some pins are not placed

src/odb/test/all_pins_placed1.tcl

@@ -0,0 +1,10 @@
+# test if all pins are placed
+source "helpers.tcl"
+read_lef Nangate45/Nangate45.lef
+read_def floorplan_initialize3.def
+
+if { [all_pins_placed] } {
+  puts "All pins are placed"
+} else {
+  puts "Some pins are not placed"
+}

src/odb/test/all_pins_placed2.ok

@@ -0,0 +1,5 @@
+[INFO ODB-0227] LEF file: Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
+[INFO ODB-0128] Design: gcd
+[INFO ODB-0131]     Created 200 components and 1117 component-terminals.
+[INFO ODB-0133]     Created 4 nets and 11 connections.
+All pins are placed

src/odb/test/all_pins_placed2.tcl

@@ -0,0 +1,10 @@
+# test if all pins are placed
+source "helpers.tcl"
+read_lef Nangate45/Nangate45.lef
+read_def design_is_routed1.def
+
+if { [all_pins_placed] } {
+  puts "All pins are placed"
+} else {
+  puts "Some pins are not placed"
+}