Change the C++ code to use an enum and have the string conversion handled in the swig layer. Update README

Signed-off-by: Jonas Gava <[email protected]>

Author: jfgava

src/cts/README.md

@@ -92,7 +92,7 @@ clock_tree_synthesis
 | `-num_static_layers` | Set the number of static layers. The default value is `0`, and the allowed values are integers `[0, MAX_INT]`. |
 | `-sink_clustering_buffer` | Set the sink clustering buffer(s) to be used. |
 | `-obstruction_aware` | Enables obstruction-aware buffering such that clock buffers are not placed on top of blockages or hard macros. This option may reduce legalizer displacement, leading to better latency, skew or timing QoR.  The default value is `False`, and the allowed values are bool. |
-| `-apply_ndr` | Applies 2X spacing non-default rule to clock nets except leaf-level nets following some strategy. There are four strategy options: `none, root_only, half, full`. The default value is `root_only`. |
+| `-apply_ndr` | Applies 2X spacing non-default rule to clock nets except leaf-level nets following some strategy. There are four strategy options: `none, root_only, half, full`. If this is not specified, the default value is `none`. |
 | `-dont_use_dummy_load` | Don't apply dummy buffer or inverter cells at clock tree leaves to balance loads. The default values is `False`. |
 | `-sink_buffer_max_cap_derate` | Use this option to control automatic buffer selection. To favor strong(weak) drive strength buffers use a small(large) value.  The default value is `0.01`, meaning that buffers are selected by derating max cap limit by 0.01. The value of 1.0 means no derating of max cap limit.  |
 | `-delay_buffer_derate` | This option balances latencies between macro cells and registers by inserting delay buffers.  The default value is `1.0`, meaning all needed delay buffers are inserted.  A value of 0.5 means only half of necessary delay buffers are inserted.  A value of 0.0 means no insertion of delay buffers. |

src/cts/src/CtsOptions.cpp

@@ -5,31 +5,6 @@
 
 namespace cts {
 
-void CtsOptions::setApplyNDR(const std::string& strategy)
-{
-  std::string lower_strategy = strategy;
-  std::transform(lower_strategy.begin(),
-                 lower_strategy.end(),
-                 lower_strategy.begin(),
-                 ::tolower);
-
-  if (lower_strategy == "none") {
-    ndrStrategy_ = NdrStrategy::NONE;
-  } else if (lower_strategy == "root_only") {
-    ndrStrategy_ = NdrStrategy::ROOT_ONLY;
-  } else if (lower_strategy == "half") {
-    ndrStrategy_ = NdrStrategy::HALF;
-  } else if (lower_strategy == "full") {
-    ndrStrategy_ = NdrStrategy::FULL;
-  } else {
-    logger_->warn(utl::CTS,
-                  33,
-                  "Invalid NDR strategy: {}. Defaulting to root_only.",
-                  strategy);
-    ndrStrategy_ = NdrStrategy::ROOT_ONLY;
-  }
-}
-
 CtsOptions::MasterType CtsOptions::getType(odb::dbInst* inst) const
 {
   if (inst->getName().substr(0, dummyload_prefix_.size())

src/cts/src/CtsOptions.h

@@ -271,7 +271,7 @@ class CtsOptions : public odb::dbBlockCallBackObj
   bool getRepairClockNets() { return repairClockNets_; }
 
   // NDR strategies
-  void setApplyNDR(const std::string& strategy);
+  void setApplyNDR(NdrStrategy strategy) { ndrStrategy_ = strategy; }
   NdrStrategy getApplyNdr() const { return ndrStrategy_; }
 
  private:

src/cts/src/TritonCTS.i

@@ -26,6 +26,35 @@ using ord::getTritonCts;
 %ignore cts::CtsOptions::setObserver;
 %ignore cts::CtsOptions::getObserver;
 
+// Enum: CtsOptions::NdrStrategy
+%typemap(typecheck) CtsOptions::NdrStrategy {
+  char *str = Tcl_GetStringFromObj($input, 0);
+  if (strcasecmp(str, "NONE") == 0) {
+    $1 = 1;
+  } else if (strcasecmp(str, "ROOT_ONLY") == 0) {
+    $1 = 1;
+  } else if (strcasecmp(str, "HALF") == 0) {
+    $1 = 1;
+  } else if (strcasecmp(str, "FULL") == 0) {
+    $1 = 1;
+  } else {
+    $1 = 0;
+  }
+}
+
+%typemap(in) CtsOptions::NdrStrategy {
+  char *str = Tcl_GetStringFromObj($input, 0);
+  if (strcasecmp(str, "ROOT_ONLY") == 0) {
+    $1 = CtsOptions::NdrStrategy::ROOT_ONLY;
+  } else if (strcasecmp(str, "HALF") == 0) {
+    $1 = CtsOptions::NdrStrategy::HALF;
+  } else if (strcasecmp(str, "FULL") == 0) {
+    $1 = CtsOptions::NdrStrategy::FULL;
+  } else {
+    $1 = CtsOptions::NdrStrategy::NONE;
+  };
+}
+
 %inline %{
 
 void
@@ -205,7 +234,7 @@ set_obstruction_aware(bool obs)
 }
 
 void
-set_apply_ndr(const char* strategy)
+set_apply_ndr(CtsOptions::NdrStrategy strategy)
 {
   getTritonCts()->getParms()->setApplyNDR(strategy);
 }

src/cts/src/TritonCTS.tcl

@@ -56,7 +56,7 @@ sta::define_cmd_args "clock_tree_synthesis" {[-wire_unit unit]
                                              [-sink_clustering_buffer] \
                                              [-obstruction_aware] \
                                              [-no_obstruction_aware] \
-                                             [-apply_ndr] \
+                                             [-apply_ndr strategy] \
                                              [-sink_buffer_max_cap_derate] \
                                              [-dont_use_dummy_load] \
                                              [-delay_buffer_derate] \

src/cts/test/simple_test.py

@@ -1,6 +1,7 @@
 from openroad import Design, Tech
 import helpers
 import cts_aux
+import cts
 
 tech = Tech()
 tech.readLef("Nangate45/Nangate45.lef")
@@ -17,7 +18,7 @@
     root_buf="CLKBUF_X3",
     buf_list="CLKBUF_X3",
     wire_unit=20,
-    apply_ndr="root_only",
+    apply_ndr=cts.CtsOptions.NdrStrategy_ROOT_ONLY,
 )
 
 cts_aux.report_cts(design)