Merge branch 'master' into latest_working_branch

Author: eder-matheus

docker/Dockerfile.binary

@@ -12,6 +12,6 @@ FROM $copyImage AS copyfrom
 
 FROM $fromImage
 
-COPY --from=copyfrom /OpenROAD/build/src/openroad /usr/bin/.
+COPY --from=copyfrom /OpenROAD/build/bin/openroad /usr/bin/.
 
 ENTRYPOINT [ "openroad" ]

docs/user/Build.md

@@ -50,7 +50,7 @@ Please refer to the instructions for installing prebuilt binaries
 ## Build Locally
 
 The default build type is `RELEASE` to compile optimized code.
-The resulting executable is in `build/src/openroad`.
+The resulting executable is in `build/bin/openroad`.
 
 Optional CMake variables passed as `-D<var>=<value>` arguments to CMake are show below.
 

etc/DockerHelper.sh

@@ -144,7 +144,7 @@ _test() {
         _create
     fi
     if [[ "${testTarget}" == "smoke" ]]; then
-        docker run --rm "${imagePath}" bash -c './build/src/openroad -help'
+        docker run --rm "${imagePath}" bash -c './build/bin/openroad -help'
     else
         docker run --rm "${imagePath}" "./docker/test_wrapper.sh" "${compiler}" "ctest --test-dir build -j ${numThreads}"
     fi

jenkins/Jenkinsfile.nightly

@@ -47,7 +47,7 @@ node {
                             stage("Run ${name}") {
                                 catchError(buildResult: 'FAILURE', stageResult: 'FAILURE') {
                                     timeout(time: 8, unit: 'HOURS') {
-                                        sh "python3 src/drt/test/run-ispd.py --program ${WORKSPACE}/build/src/openroad --tests ispd${ispd_year}_test${test_to_run}";
+                                        sh "python3 src/drt/test/run-ispd.py --program ${WORKSPACE}/build/bin/openroad --tests ispd${ispd_year}_test${test_to_run}";
                                     }
                                 }
                             }

src/CMakeLists.txt

@@ -289,6 +289,10 @@ add_executable(openroad
   ${OPENROAD_SOURCE}
 )
 
+set_target_properties(openroad PROPERTIES
+  RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin"
+)
+
 target_compile_options(openroad
   PRIVATE
     -Wextra -pedantic -Wcast-qual

src/README.md

@@ -156,7 +156,7 @@ write_db filename
 
 | Switch Name | Description |
 | ----- | ----- |
-| `filename` | Path to the file to be read, if the filename ends with `.gz` the file will be comprssed using gzip. |
+| `filename` | Path to the file to be written, if the filename ends with `.gz` the file will be compressed using gzip. |
 
 ### Examples
 ```
@@ -195,6 +195,32 @@ write_abstract_lef -bloat_factor 3 reg1_abstract.lef
 write_abstract_lef -bloat_occupied_layers reg1_abstract.lef
 ```
 
+## Write CDL netlist
+
+To export the CDL netlist to disk.
+
+``` tcl
+write_cdl
+  -masters list_of_cdl_files
+  [-include_fillers]
+  filename
+```
+### Options
+
+| Switch Name | Description |
+| ----- | ----- |
+| `-masters` | List of CDL netlist dependencies. |
+| `[-include_fillers]` | Export fillers to the CDL netlist |
+| `filename` | Path to the file to be written, if the filename ends with `.gz` the file will be compressed using gzip. |
+
+### Examples
+```
+write_cdl -master {netlist1.cdl netlist2.cdl ...} -include_fillers netlist.cdl
+
+# To write a database file with gzip compression.
+write_cdl -master {netlist1.cdl netlist2.cdl ...} -include_fillers netlist.cdl.gz
+```
+
 ### Global Connections
 
 #### Add global connections

src/cts/src/CtsOptions.h

@@ -350,7 +350,7 @@ class CtsOptions : public odb::dbBlockCallBackObj
   std::string dummyload_prefix_ = "clkload";
   MasterCount dummy_count_;
   bool repairClockNets_ = false;
-  NdrStrategy ndrStrategy_ = NdrStrategy::NONE;
+  NdrStrategy ndrStrategy_ = NdrStrategy::HALF;
 };
 
 }  // namespace cts

src/cts/src/TritonCTS.cpp

@@ -1582,7 +1582,7 @@ std::vector<int> TritonCTS::getAllClockTreeLevels(Clock& clockNet)
   std::set<int> uniqueLevels;
 
   clockNet.forEachSubNet([&](ClockSubNet& subNet) {
-    if (!subNet.isLeafLevel()) {
+    if (!subNet.isLeafLevel() && subNet.getTreeLevel() != -1) {
       uniqueLevels.insert(subNet.getTreeLevel());
     }
   });
@@ -1704,13 +1704,19 @@ void TritonCTS::writeClockNDRsToDb(TreeBuilder* builder)
     int defaultWidth = layer->getWidth();
     layerRule->setSpacing(defaultSpace * 2);
     layerRule->setWidth(defaultWidth);
-    // clang-format off
-    debugPrint(logger_, CTS, "clustering", 1, "  NDR rule set to layer {} {} as "
-	       "space={} width={} vs. default space={} width={}",
-	       i, layer->getName(),
-	       layerRule->getSpacing(), layerRule->getWidth(),
-	       defaultSpace, defaultWidth);
-    // clang-format on
+
+    debugPrint(logger_,
+               CTS,
+               "clustering",
+               1,
+               "  NDR rule set to layer {} {} as space={} width={} vs. default "
+               "space={} width={}",
+               i,
+               layer->getName(),
+               layerRule->getSpacing(),
+               layerRule->getWidth(),
+               defaultSpace,
+               defaultWidth);
   }
 
   int clkNets = 0;
@@ -1732,12 +1738,14 @@ void TritonCTS::writeClockNDRsToDb(TreeBuilder* builder)
       break;
   }
 
-  logger_->info(CTS,
-                202,
-                "Non-default rule {} for double spacing has been applied to {} "
-                "clock nets",
-                ruleName,
-                clkNets);
+  debugPrint(logger_,
+             CTS,
+             "clustering",
+             1,
+             "Non-default rule {} for double spacing has been applied to {} "
+             "clock nets",
+             ruleName,
+             clkNets);
 }
 
 std::pair<int, int> TritonCTS::branchBufferCount(ClockInst* inst,

src/cts/test/balance_levels.defok

@@ -4,6 +4,44 @@ BUSBITCHARS "[]" ;
 DESIGN multi_sink ;
 UNITS DISTANCE MICRONS 2000 ;
 DIEAREA ( 0 0 ) ( 200000 200000 ) ;
+NONDEFAULTRULES 3 ;
+    - CTS_NDR_0
+      + LAYER metal1 WIDTH 140 SPACING 260
+      + LAYER metal2 WIDTH 140 SPACING 280
+      + LAYER metal3 WIDTH 140 SPACING 280
+      + LAYER metal4 WIDTH 280 SPACING 560
+      + LAYER metal5 WIDTH 280 SPACING 560
+      + LAYER metal6 WIDTH 280 SPACING 560
+      + LAYER metal7 WIDTH 800 SPACING 1600
+      + LAYER metal8 WIDTH 800 SPACING 1600
+      + LAYER metal9 WIDTH 1600 SPACING 3200
+      + LAYER metal10 WIDTH 1600 SPACING 3200
+    ;
+    - CTS_NDR_1
+      + LAYER metal1 WIDTH 140 SPACING 260
+      + LAYER metal2 WIDTH 140 SPACING 280
+      + LAYER metal3 WIDTH 140 SPACING 280
+      + LAYER metal4 WIDTH 280 SPACING 560
+      + LAYER metal5 WIDTH 280 SPACING 560
+      + LAYER metal6 WIDTH 280 SPACING 560
+      + LAYER metal7 WIDTH 800 SPACING 1600
+      + LAYER metal8 WIDTH 800 SPACING 1600
+      + LAYER metal9 WIDTH 1600 SPACING 3200
+      + LAYER metal10 WIDTH 1600 SPACING 3200
+    ;
+    - CTS_NDR_2
+      + LAYER metal1 WIDTH 140 SPACING 260
+      + LAYER metal2 WIDTH 140 SPACING 280
+      + LAYER metal3 WIDTH 140 SPACING 280
+      + LAYER metal4 WIDTH 280 SPACING 560
+      + LAYER metal5 WIDTH 280 SPACING 560
+      + LAYER metal6 WIDTH 280 SPACING 560
+      + LAYER metal7 WIDTH 800 SPACING 1600
+      + LAYER metal8 WIDTH 800 SPACING 1600
+      + LAYER metal9 WIDTH 1600 SPACING 3200
+      + LAYER metal10 WIDTH 1600 SPACING 3200
+    ;
+END NONDEFAULTRULES
 COMPONENTS 368 ;
     - CELL/CKGATE BUF_X1 + PLACED ( 100000 100000 ) N ;
     - clkbuf_0_CELL\/clk2 CLKBUF_X3 + SOURCE TIMING + PLACED ( 103228 140117 ) N ;
@@ -381,16 +419,16 @@ PINS 1 ;
         + FIXED ( 100000 199860 ) N ;
 END PINS
 NETS 39 ;
-    - CELL/clk2 ( clkbuf_0_CELL\/clk2 A ) ( CELL/CKGATE Z ) + USE CLOCK ;
-    - clk ( PIN clk ) ( clkbuf_regs_0_clk A ) ( clkbuf_0_clk A ) + USE CLOCK ;
-    - clk_regs ( clkbuf_regs_0_clk Z ) ( clkbuf_0_clk_regs A ) + USE CLOCK ;
+    - CELL/clk2 ( clkbuf_0_CELL\/clk2 A ) ( CELL/CKGATE Z ) + USE CLOCK + NONDEFAULTRULE CTS_NDR_2 ;
+    - clk ( PIN clk ) ( clkbuf_regs_0_clk A ) ( clkbuf_0_clk A ) + USE CLOCK + NONDEFAULTRULE CTS_NDR_0 ;
+    - clk_regs ( clkbuf_regs_0_clk Z ) ( clkbuf_0_clk_regs A ) + USE CLOCK + NONDEFAULTRULE CTS_NDR_1 ;
     - clknet_0_CELL\/clk2 ( clkbuf_4_15__f_CELL\/clk2 A ) ( clkbuf_4_14__f_CELL\/clk2 A ) ( clkbuf_4_13__f_CELL\/clk2 A ) ( clkbuf_4_12__f_CELL\/clk2 A ) ( clkbuf_4_11__f_CELL\/clk2 A ) ( clkbuf_4_10__f_CELL\/clk2 A ) ( clkbuf_4_9__f_CELL\/clk2 A )
       ( clkbuf_4_8__f_CELL\/clk2 A ) ( clkbuf_4_7__f_CELL\/clk2 A ) ( clkbuf_4_6__f_CELL\/clk2 A ) ( clkbuf_4_5__f_CELL\/clk2 A ) ( clkbuf_4_4__f_CELL\/clk2 A ) ( clkbuf_4_3__f_CELL\/clk2 A ) ( clkbuf_4_2__f_CELL\/clk2 A ) ( clkbuf_4_1__f_CELL\/clk2 A )
-      ( clkbuf_4_0__f_CELL\/clk2 A ) ( clkbuf_0_CELL\/clk2 Z ) + USE CLOCK ;
-    - clknet_0_clk ( clkbuf_1_0__f_clk A ) ( clkbuf_0_clk Z ) + USE CLOCK ;
+      ( clkbuf_4_0__f_CELL\/clk2 A ) ( clkbuf_0_CELL\/clk2 Z ) + USE CLOCK + NONDEFAULTRULE CTS_NDR_2 ;
+    - clknet_0_clk ( clkbuf_1_0__f_clk A ) ( clkbuf_0_clk Z ) + USE CLOCK + NONDEFAULTRULE CTS_NDR_0 ;
     - clknet_0_clk_regs ( clkbuf_4_15__f_clk_regs A ) ( clkbuf_4_14__f_clk_regs A ) ( clkbuf_4_13__f_clk_regs A ) ( clkbuf_4_12__f_clk_regs A ) ( clkbuf_4_11__f_clk_regs A ) ( clkbuf_4_10__f_clk_regs A ) ( clkbuf_4_9__f_clk_regs A )
       ( clkbuf_4_8__f_clk_regs A ) ( clkbuf_4_7__f_clk_regs A ) ( clkbuf_4_6__f_clk_regs A ) ( clkbuf_4_5__f_clk_regs A ) ( clkbuf_4_4__f_clk_regs A ) ( clkbuf_4_3__f_clk_regs A ) ( clkbuf_4_2__f_clk_regs A ) ( clkbuf_4_1__f_clk_regs A )
-      ( clkbuf_4_0__f_clk_regs A ) ( clkbuf_0_clk_regs Z ) + USE CLOCK ;
+      ( clkbuf_4_0__f_clk_regs A ) ( clkbuf_0_clk_regs Z ) + USE CLOCK + NONDEFAULTRULE CTS_NDR_1 ;
     - clknet_1_0__leaf_clk ( CELL/CKGATE A ) ( clkbuf_1_0__f_clk Z ) + USE CLOCK ;
     - clknet_4_0__leaf_CELL\/clk2 ( clkload15 A ) ( ff162 CK ) ( ff163 CK ) ( ff164 CK ) ( ff165 CK ) ( ff180 CK ) ( ff181 CK )
       ( ff182 CK ) ( ff183 CK ) ( ff184 CK ) ( clkbuf_4_0__f_CELL\/clk2 Z ) + USE CLOCK ;

src/cts/test/simple_test.ok

@@ -34,7 +34,6 @@
 [INFO CTS-0015]     Created 3 clock nets.
 [INFO CTS-0016]     Fanout distribution for the current clock = 8:2..
 [INFO CTS-0017]     Max level of the clock tree: 1.
-[INFO CTS-0202] Non-default rule CTS_NDR_0 for double spacing has been applied to 2 clock nets
 [INFO CTS-0098] Clock net "clk"
 [INFO CTS-0099]  Sinks 16
 [INFO CTS-0100]  Leaf buffers 0