Merge pull request #8428 from rafaelmoresco/dev_rafael

Console --db option

Author: maliberty

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
 ```
 

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");
 }
 

test/gcd_sky130hd.odb

@@ -0,0 +1,6 @@
+TEST: Verifying database was loaded via -db flag
+PASS: Design loaded: gcd
+PASS: Database loaded correctly with 250 instances
+PASS: Basic commands work after database load
+PASS: Database object accessible
+PASS: -db flag test completed successfully

test/open_db.ok

@@ -0,0 +1,48 @@
+# Test for -db flag functionality
+# This test should be run with: openroad -db gcd_sky130hd.odb -exit open_db.tcl
+# It verifies that the database was loaded correctly via the -db flag
+
+source "helpers.tcl"
+
+puts "TEST: Verifying database was loaded via -db flag"
+
+# Check that we have a design loaded
+if { [current_design] == "" } {
+  puts "FAIL: No design loaded after -db flag"
+  exit 1
+}
+
+puts "PASS: Design loaded: [current_design]"
+
+# Check that we have some basic design information
+set instance_count [sta::network_instance_count]
+if { $instance_count == 0 } {
+  puts "FAIL: No instances found in loaded design"
+  exit 1
+}
+
+puts "PASS: Database loaded correctly with $instance_count instances"
+
+# Test that basic commands work
+# Note: all_nets and all_pins might not be available in this context
+# Let's test other basic functionality instead
+
+# Test that we can get design information
+set design_name [current_design]
+if { $design_name == "" } {
+  puts "FAIL: No design name available"
+  exit 1
+}
+
+puts "PASS: Basic commands work after database load"
+
+# Test that we can access the database
+set db [ord::get_db]
+if { $db == "" } {
+  puts "FAIL: Could not access database object"
+  exit 1
+}
+
+puts "PASS: Database object accessible"
+
+puts "PASS: -db flag test completed successfully"

test/open_db.tcl

@@ -0,0 +1,2 @@
+[ERROR ORD-0007] nonexistent_file.odb does not exist.
+Error: failed to read_db nonexistent_file.odb: ORD-0007

test/open_db_invalid.ok

@@ -0,0 +1,5 @@
+# Test for -db flag with invalid database file
+# This test verifies proper error handling when an invalid database file is specified
+# Expected behavior: OpenROAD should exit with error message and not reach this script
+
+puts "TEST: Testing -db flag with invalid database file"

test/open_db_invalid.tcl

@@ -196,22 +196,40 @@ proc run_test_lang { test lang } {
     flush stdout
     set test_errors [run_test_app $test $cmd_file $log_file $lang]
     if { [lindex $test_errors 0] == "ERROR" } {
-      puts " *ERROR* [lrange $test_errors 1 end]"
-      append_failure $test
-      incr errors(error)
-
-      # For some reason seg faults aren't echoed in the log - add them.
-      if { [file exists $log_file] } {
-        set log_ch [open $log_file "a"]
-        puts $log_ch "$test_errors"
-        close $log_ch
-      }
-
-      # Report partial log diff anyway.
-      if { [file exists $ok_file] } {
+      # Special handling: allow tests with expected errors to pass
+      # if their log matches the .ok file.
+      set pass_crit [test_pass_criteria $test]
+      if { $pass_crit == "compare_logfile_allow_error" && [file exists $ok_file] } {
+        # Filter dos '/r's from log file to match normal compare behavior.
+        set tmp_file [file join $result_dir $test.tmp]
+        exec tr -d "\r" < $log_file > $tmp_file
+        file rename -force $tmp_file $log_file
         # tclint-disable-next-line command-args
-        catch [concat exec diff $diff_options $ok_file $log_file \
-          >> $diff_file]
+        if { [catch [concat exec diff $diff_options $ok_file $log_file >> $diff_file]] } {
+          puts " *FAIL*"
+          append_failure $test
+          incr errors(fail)
+        } else {
+          puts " pass (expected error)"
+        }
+      } else {
+        puts " *ERROR* [lrange $test_errors 1 end]"
+        append_failure $test
+        incr errors(error)
+
+        # For some reason seg faults aren't echoed in the log - add them.
+        if { [file exists $log_file] } {
+          set log_ch [open $log_file "a"]
+          puts $log_ch "$test_errors"
+          close $log_ch
+        }
+
+        # Report partial log diff anyway.
+        if { [file exists $ok_file] } {
+          # tclint-disable-next-line command-args
+          catch [concat exec diff $diff_options $ok_file $log_file \
+            >> $diff_file]
+        }
       }
     } else {
       set error_msg ""
@@ -311,7 +329,7 @@ proc run_test_app { test cmd_file log_file lang } {
 }
 
 proc run_test_plain { test cmd_file log_file lang } {
-  global app_path app_options result_dir errorCode
+  global app_path app_options result_dir errorCode test_specific_options
 
   if { ![file exists $app_path] } {
     return "ERROR $app_path not found."
@@ -320,9 +338,14 @@ proc run_test_plain { test cmd_file log_file lang } {
   } else {
     set save_dir [pwd]
     cd [file dirname $cmd_file]
+    # Get test-specific options if they exist
+    set test_opts $app_options
+    if { [info exists test_specific_options($test)] } {
+      set test_opts [concat $test_specific_options($test) $app_options]
+    }
     # tclint-disable command-args
     if {
-      [catch [concat exec $app_path $app_options \
+      [catch [concat exec $app_path $test_opts \
         [lang_flag $lang] \
         -metrics [test_metrics_result_file $test $lang] \
         [file tail $cmd_file] >& $log_file]]
@@ -351,16 +374,22 @@ proc run_test_plain { test cmd_file log_file lang } {
 }
 
 proc run_test_valgrind { test cmd_file log_file lang } {
-  global app_path app_options valgrind_options result_dir errorCode
+  global app_path app_options valgrind_options result_dir errorCode test_specific_options
 
   set vg_cmd_file [test_valgrind_cmd_file $test $lang]
   set vg_stream [open $vg_cmd_file "w"]
   puts $vg_stream "cd [file dirname $cmd_file]"
   puts $vg_stream "source [file tail $cmd_file]"
   close $vg_stream
 
+  # Get test-specific options if they exist
+  set test_opts $app_options
+  if { [info exists test_specific_options($test)] } {
+    set test_opts [concat $test_specific_options($test) $app_options]
+  }
+
   set cmd [concat exec valgrind $valgrind_options \
-    $app_path [lang_flag $lang] $app_options \
+    $app_path [lang_flag $lang] $test_opts \
     $vg_cmd_file >& $log_file]
   set error_msg ""
   if { [catch { $cmd }] } {

test/regression.tcl

@@ -17,3 +17,8 @@ record_flow_tests {
   jpeg_sky130hs
   jpeg_sky130hd
 }
+
+# Database loading tests for -db flag functionality
+record_test open_db $test_dir "compare_logfile" "-db gcd_sky130hd.odb"
+# For invalid DB, allow non-zero exit but require log to match ok
+record_test open_db_invalid $test_dir "compare_logfile_allow_error" "-db nonexistent_file.odb"

test/regression_tests.tcl

@@ -87,12 +87,15 @@ proc record_tests1 { tests cmp_logfile } {
 }
 
 # Record a test in the regression suite.
-proc record_test { test cmd_dir pass_criteria } {
-  global cmd_dirs test_groups test_pass_criteria test_langs
+proc record_test { test cmd_dir pass_criteria { test_options "" } } {
+  global cmd_dirs test_groups test_pass_criteria test_langs test_specific_options
   set cmd_dirs($test) $cmd_dir
   lappend test_groups(all) $test
   set test_pass_criteria($test) $pass_criteria
   set test_langs($test) [list]
+  if { $test_options != "" } {
+    set test_specific_options($test) $test_options
+  }
   if { [file exists [file join $cmd_dir "$test.tcl"]] } {
     lappend test_langs($test) tcl
   }