Merge remote-tracking branch 'origin/master' into gui-fix-instance-loop

Author: gadfort

.clang-tidy

@@ -65,7 +65,7 @@ CheckOptions:
 
 # All modules but sta
 # Exclude build as there is too much noise from swig generated code
-HeaderFilterRegex: "(?!build/.*)/(ant|cts|dbSta|dft|dpl|drt|dst|est|exa|fin|gpl|grt|gui|ifp|mpl|odb|ord|pad|par|pdn|ppl|psm|rcx|rmp|rsz|stt|tap|upf|utl)/.*"
+HeaderFilterRegex: "(?!build/.*)/(ant|cgt|cts|cut|dbSta|dft|dpl|drt|dst|est|exa|fin|gpl|grt|gui|ifp|mpl|odb|ord|pad|par|pdn|ppl|psm|rcx|ram|rmp|rsz|stt|tap|upf|utl)/.*"
 
 # Not currently handling identifier naming
 # WarningsAsErrors: "*"

.github/workflows/github-actions-format-on-push.yml

@@ -18,7 +18,7 @@ jobs:
           fetch-depth: 0
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v46
+        uses: tj-actions/changed-files@v47
       - name: Check format of cpp changed files
         run: |
           clang-format --version

BUILD.bazel

@@ -90,6 +90,7 @@ OPENROAD_LIBRARY_DEPS = [
     "//src/pdn",
     "//src/ppl",
     "//src/psm",
+    "//src/ram",
     "//src/rcx",
     "//src/rcx:ui",
     "//src/rmp",

README.md

@@ -329,7 +329,7 @@ save_flow_metrics_limits <TEST_NAME>
 
 ``` text
 openroad [-help] [-version] [-no_init] [-exit] [-gui]
-         [-threads count|max] [-log file_name] cmd_file
+         [-threads count|max] [-log file_name] [-db file_name] cmd_file
   -help              show help and exit
   -version           show version and exit
   -no_init           do not read .openroad init file
@@ -339,6 +339,7 @@ openroad [-help] [-version] [-no_init] [-exit] [-gui]
   -gui               start in gui mode
   -python            start with python interpreter [limited to db operations]
   -log <file_name>   write a log in <file_name>
+  -db <file_name>    open a .odb database at startup
   cmd_file           source cmd_file
 ```
 

include/ord/OpenRoad.hh

@@ -64,6 +64,10 @@ namespace fin {
 class Finale;
 }
 
+namespace ram {
+class RamGen;
+}
+
 namespace exa {
 class Example;
 }
@@ -156,6 +160,7 @@ class OpenRoad
   dbVerilogNetwork* getVerilogNetwork() { return verilog_network_; }
   dpl::Opendp* getOpendp() { return opendp_; }
   fin::Finale* getFinale() { return finale_; }
+  ram::RamGen* getRamGen() { return ram_gen_; }
   tap::Tapcell* getTapcell() { return tapcell_; }
   mpl::MacroPlacer* getMacroPlacer() { return macro_placer_; }
   exa::Example* getExample() { return example_; }
@@ -255,6 +260,7 @@ class OpenRoad
   ppl::IOPlacer* ioPlacer_ = nullptr;
   dpl::Opendp* opendp_ = nullptr;
   fin::Finale* finale_ = nullptr;
+  ram::RamGen* ram_gen_ = nullptr;
   mpl::MacroPlacer* macro_placer_ = nullptr;
   exa::Example* example_ = nullptr;
   grt::GlobalRouter* global_router_ = nullptr;

src/CMakeLists.txt

@@ -263,6 +263,7 @@ add_subdirectory(gpl)
 add_subdirectory(dpl)
 add_subdirectory(exa)
 add_subdirectory(fin)
+add_subdirectory(ram)
 add_subdirectory(ppl)
 add_subdirectory(rmp)
 add_subdirectory(cgt)
@@ -326,6 +327,7 @@ target_link_libraries(openroad
   dpl
   exa
   fin
+  ram
   rsz
   ppl
   stt
@@ -422,6 +424,7 @@ if (Python3_FOUND AND BUILD_PYTHON)
     cts_py
     drt_py
     fin_py
+#    ram_py
     rcx_py
     rmp_py
     stt_py

src/Main.cc

@@ -88,6 +88,7 @@ int cmd_argc;
 char** cmd_argv;
 static const char* log_filename = nullptr;
 static const char* metrics_filename = nullptr;
+static const char* read_odb_filename = nullptr;
 static bool no_settings = false;
 static bool minimize = false;
 
@@ -243,6 +244,7 @@ int main(int argc, char* argv[])
     std::filesystem::remove(metrics_filename, err_ignored);
   }
 
+  read_odb_filename = findCmdLineKey(argc, argv, "-db");
   no_settings = findCmdLineFlag(argc, argv, "-no_settings");
   minimize = findCmdLineFlag(argc, argv, "-minimize");
 
@@ -449,6 +451,21 @@ static int tclAppInit(int& argc,
 
     const bool gui_enabled = gui::Gui::enabled();
 
+    if (read_odb_filename) {
+      std::string cmd = fmt::format("read_db {{{}}}", read_odb_filename);
+      if (!gui_enabled) {
+        if (Tcl_Eval(interp, cmd.c_str()) != TCL_OK) {
+          fprintf(stderr,
+                  "Error: failed to read_db %s: %s\n",
+                  read_odb_filename,
+                  Tcl_GetStringResult(interp));
+          exit(1);
+        }
+      } else {
+        gui::Gui::get()->addRestoreStateCommand(cmd);
+      }
+    }
+
     const char* home = getenv("HOME");
     if (!findCmdLineFlag(argc, argv, "-no_init") && home) {
       const char* restore_state_cmd = "include -echo -verbose {{{}}}";
@@ -525,7 +542,7 @@ static void showUsage(const char* prog, const char* init_filename)
 {
   printf("Usage: %s [-help] [-version] [-no_init] [-no_splash] [-exit] ", prog);
   printf("[-gui] [-threads count|max] [-log file_name] [-metrics file_name] ");
-  printf("[-no_settings] [-minimize] cmd_file\n");
+  printf("[-db file_name] [-no_settings] [-minimize] cmd_file\n");
   printf("  -help                 show help and exit\n");
   printf("  -version              show version and exit\n");
   printf("  -no_init              do not read %s init file\n", init_filename);
@@ -543,6 +560,7 @@ static void showUsage(const char* prog, const char* init_filename)
   printf("  -log <file_name>      write a log in <file_name>\n");
   printf(
       "  -metrics <file_name>  write metrics in <file_name> in JSON format\n");
+  printf("  -db <file_name>      open a .odb database at startup\n");
   printf("  cmd_file              source cmd_file\n");
 }
 

src/OpenRoad.cc

@@ -67,6 +67,8 @@
 #include "ppl/MakeIoplacer.h"
 #include "psm/MakePDNSim.hh"
 #include "psm/pdnsim.h"
+#include "ram/MakeRam.h"
+#include "ram/ram.h"
 #include "rcx/MakeOpenRCX.h"
 #include "rcx/ext.h"
 #include "rmp/MakeRestructure.h"
@@ -135,6 +137,7 @@ OpenRoad::~OpenRoad()
   delete replace_;
   delete pdnsim_;
   delete finale_;
+  delete ram_gen_;
   delete antenna_checker_;
   odb::dbDatabase::destroy(db_);
   delete partitionMgr_;
@@ -220,6 +223,7 @@ void OpenRoad::init(Tcl_Interp* tcl_interp,
                               opendp_,
                               estimate_parasitics_);
   finale_ = new fin::Finale(db_, logger_);
+  ram_gen_ = new ram::RamGen(getDbNetwork(), db_, logger_);
   restructure_ = new rmp::Restructure(
       logger_, sta_, db_, resizer_, estimate_parasitics_);
   clock_gating_ = new cgt::ClockGating(logger_, sta_);
@@ -253,6 +257,7 @@ void OpenRoad::init(Tcl_Interp* tcl_interp,
   utl::evalTclInit(tcl_interp, ord::ord_tcl_inits);
 
   utl::initLogger(tcl_interp);
+
   // GUI first so we can register our sink with the logger
   gui::initGui(tcl_interp, db_, sta_, logger_);
   odb::initOdb(tcl_interp);
@@ -264,6 +269,7 @@ void OpenRoad::init(Tcl_Interp* tcl_interp,
   gpl::initReplace(tcl_interp);
   dpl::initOpendp(tcl_interp);
   fin::initFinale(tcl_interp);
+  ram::initRamGen(tcl_interp);
   grt::initTcl(tcl_interp);
   cts::initTritonCts(tcl_interp);
   tap::initTapcell(tcl_interp);

src/cts/BUILD

@@ -19,7 +19,6 @@ cc_library(
         "src/CtsObserver.h",
         "src/HTreeBuilder.h",
         "src/LatencyBalancer.h",
-        "src/LevelBalancer.h",
         "src/SinkClustering.h",
         "src/TreeBuilder.h",
         "src/Util.h",
@@ -41,7 +40,6 @@ cc_library(
         "src/CtsOptions.cpp",
         "src/HTreeBuilder.cpp",
         "src/LatencyBalancer.cpp",
-        "src/LevelBalancer.cpp",
         "src/SinkClustering.cpp",
         "src/TechChar.cpp",
         "src/TreeBuilder.cpp",

src/cts/README.md

@@ -151,6 +151,7 @@ set_cts_config
     [-sink_clustering_levels levels]
     [-sink_clustering_max_diameter max_diameter]
     [-sink_clustering_size cluster_size]
+    [-skip_nets <list_of_clk_nets_to_skip>]
     [-tree_buf <buf>]
     [-wire_unit wire_unit]
 ```
@@ -176,6 +177,7 @@ set_cts_config
 | `-sink_clustering_max_diameter` | Specifies maximum diameter (in microns) of sink cluster for the register tree. The allowed values are integers `[0, MAX_INT]`. If this is not specified the diameter will be automatically chosen between `50, 100 or 200`, based on the tree buffer max cap. |
 | `-sink_clustering_size` | Specifies the maximum number of sinks per cluster for the register tree. The allowed values are integers `[0, MAX_INT]`. If this is not specified the size will be automatically chosen between `10, 20 or 30` based on the tree buffer max cap. |
 | `-sink_clustering_levels` | ... |
+| `-skip_nets` | Tcl list containing the clock nets to be skipped (e.g. `{net1, net2}`). If the net is a root clock net, the whole clock is skipped, otherwise only the subnet specified is skipped. |
 | `-wire_unit` | Minimum unit distance between buffers for a specific wire. If this parameter is omitted, the code gets the value from ten times the height of `-root_buffer`. |
 
 ### Report CTS configuration
@@ -208,6 +210,7 @@ reset_cts_config
     [-sink_clustering_levels]
     [-sink_clustering_max_diameter]
     [-sink_clustering_size]
+    [-skip_nets]
     [-tree_buf]
     [-wire_unit]
 ```