pln: add --check <BLIF> command line option

Author: serge-rs

stars/src/RS/rsCheck.cpp

@@ -0,0 +1,77 @@
+#include "RS/rsCheck.h"
+#include "file_readers/pln_blif_file.h"
+
+namespace pln {
+
+using std::string;
+using std::endl;
+
+bool do_check(const rsOpts& opts) {
+  if (!opts.input_)
+    return false;
+  uint16_t tr = ltrace();
+  auto& ls = lout();
+
+  string fn1 = opts.input_;
+  CStr cfn = fn1.c_str();
+  ls << "  checking BLIF file: " << fn1 << endl;
+
+  BLIF_file bfile(fn1);
+
+  if (tr >= 4)
+    bfile.setTrace(3);
+
+  bool exi = false;
+  exi = bfile.fileExists();
+  if (tr >= 7)
+    ls << int(exi) << endl;
+  if (not exi) {
+    lprintf2("[Error] file '%s' does not exist\n", cfn); 
+    return false;
+  }
+
+  exi = bfile.fileAccessible();
+  if (tr >= 7)
+    ls << int(exi) << endl;
+  if (not exi) {
+    lprintf2("[Error] file '%s' is not accessible\n", cfn); 
+    return false;
+  }
+
+  bool rd_ok = bfile.readBlif();
+  if (tr >= 7)
+    ls << int(rd_ok) << endl;
+  if (not rd_ok) {
+    lprintf2("[Error] failed reading file '%s'\n", cfn); 
+    return false;
+  }
+
+  lprintf("  (blif_file)   #inputs= %u  #outputs= %u\n",
+          bfile.numInputs(), bfile.numOutputs());
+
+  if (tr >= 4) {
+    lputs();
+    bfile.printInputs(ls);
+    lputs();
+    bfile.printOutputs(ls);
+  }
+
+  lputs();
+  ls << ">>>>> checking BLIF " << fn1 << "  ..." << endl;
+
+  bool chk_ok = bfile.checkBlif();
+
+  ls << ">>>>> chk_ok: " << int(chk_ok) << endl;
+  if (chk_ok) {
+    ls << " === BLIF is OK." << endl;
+    return true;
+  }
+
+  ls << " !!! BLIF is not OK:  " << endl;
+  ls << " !!! " << bfile.err_msg_ << endl;
+
+  return false;
+}
+
+}
+

stars/src/RS/rsCheck.h

@@ -0,0 +1,15 @@
+#pragma once
+//  API entry points for checkers
+#ifndef _pln_rs_rsCheck_H_h_
+#define _pln_rs_rsCheck_H_h_
+
+#include "RS/rsOpts.h"
+
+namespace pln {
+
+bool do_check(const rsOpts& opts);
+
+}
+
+#endif
+

stars/src/RS/rsDB.cpp

@@ -8,7 +8,6 @@ using std::endl;
 using std::string;
 using std::stringstream;
 using std::ostream;
-using namespace pln;
 
 ///@brief Returns the name of a unique unconnected net
 static string create_unconn_net(size_t& unconn_count) noexcept {

stars/src/RS/rsOpts.cpp

@@ -21,9 +21,9 @@ static CStr _help_[] = {"H", "h", "help", "hel", "hlp", "he", nullptr};
 
 static CStr _fun_[] = {"F", "fu", "fun", "func", "funct", "function", nullptr};
 
-static CStr _check_[] = {"ch", "che", "chec", "check", nullptr};
+static CStr _check_[] = {"CH", "ch", "che", "chec", "check", nullptr};
 
-static CStr _csv_[] = {"CS", "cs", "csv", nullptr};
+static CStr _csv_[] = {"CSV", "cs", "csv", nullptr};
 
 static CStr _xml_[] = {"XM", "xm", "xml", "XML", nullptr};
 
@@ -399,19 +399,6 @@ void rsOpts::parse(int argc, const char** argv) noexcept {
   if (test_id_ < 0) test_id_ = 0;
 }
 
-// and2_gemini
-bool rsOpts::set_VPR_TC1() noexcept {
-  lputs(" O-set_VPR_TC1: and2_gemini");
-  assert(argc_ > 0 && argv_);
-  bool ok = false;
-
-#ifdef RSBE_UNIT_TEST_ON
-#endif  // RSBE_UNIT_TEST_ON
-
-  flush_out(true);
-  return ok;
-}
-
 bool rsOpts::set_STA_testCase(int TC_id) noexcept { return false; }
 
 bool rsOpts::set_VPR_TC_args(CStr raw_tc) noexcept {
@@ -492,6 +479,14 @@ bool rsOpts::isCmdInput() const noexcept {
   return input_file_exists(input_);
 }
 
+bool rsOpts::hasInputFile() const noexcept {
+  if (!input_ || !input_[0]) return false;
+  size_t len = ::strlen(input_);
+  if (len < 1 || len > UNIX_Path_Max) return false;
+
+  return input_file_exists(input_);
+}
+
 bool rsOpts::ends_with_pin_c(CStr z) noexcept {
   if (!z or !z[0])
     return false;

stars/src/RS/rsOpts.h

@@ -95,11 +95,11 @@ struct rsOpts {
   bool trace_specified() const noexcept { return traceIndex_ > 0; }
   bool test_id_specified() const noexcept { return test_id_ > 0; }
 
-  bool set_VPR_TC1() noexcept;  // and2_gemini
   bool set_STA_testCase(int TC_id) noexcept;
 
   bool createVprArgv(vector<string>& W) noexcept;
 
+  bool hasInputFile() const noexcept;
   bool isCmdInput() const noexcept;
 
 private:

stars/src/main.cpp

@@ -1,4 +1,4 @@
-static const char* _pln_VERSION_STR = "pln0216";
+static const char* _pln_VERSION_STR = "pln0218";
 
 #include "RS/rsEnv.h"
 #include "util/pln_log.h"
@@ -14,6 +14,7 @@ static const char* _pln_VERSION_STR = "pln0216";
 #include "read_options.h"
 
 #include "RS/rsVPR.h"
+#include "RS/rsCheck.h"
 #include "RS/sta_file_writer.h"
 
 namespace pln {
@@ -27,6 +28,33 @@ static rsEnv s_env;
 
 static bool deal_pinc(const rsOpts& opts, bool orig_args);
 
+static bool deal_check(const rsOpts& opts) {
+  bool status = false;
+  uint16_t tr = ltrace();
+  if (tr >= 4)
+    lputs("[PLANNER CHECKER] deal_check()");
+
+  if (not opts.hasInputFile()) {
+    err_puts("\n[PLANNER CHECKER] : something wrong with input file\n");
+    if (!opts.input_) {
+      lputs("[PLANNER CHECKER] : input file is not specified");
+    } else {
+      lprintf("[PLANNER CHECKER] : input file '%s'\n", opts.input_);
+      lprintf("                  : does not exist or not readable\n");
+    }
+    flush_out(true);
+    return false;
+  }
+
+  status = do_check(opts);
+
+  if (tr >= 3)
+    lprintf("(deal_check status) %s\n", status ? "TRUE" : "FALSE");
+
+  flush_out(true);
+  return status;
+}
+
 static bool deal_stars(const rsOpts& opts, bool orig_args) {
   bool status = false;
 
@@ -236,7 +264,7 @@ static bool deal_cmd(rsOpts& opts) {
       return false;
     }
     arg0 = W[0];
-    if (tr >= 6) {
+    if (tr >= 7) {
       lprintf("  W.size()= %zu  W[0]= %s\n", W.size(), arg0.c_str());
       lputs();
     }
@@ -247,7 +275,7 @@ static bool deal_cmd(rsOpts& opts) {
       for (uint j = 1; j < W.size(); j++) {
         cmdArgv[cmdArgc++] = ::strdup(W[j].c_str());
       }
-      if (tr >= 3)
+      if (tr >= 4)
         lprintf("  created cmdArgv: cmdArgc= %i\n", cmdArgc);
       opts.vprArgc_ = cmdArgc;
       opts.vprArgv_ = cmdArgv;
@@ -310,7 +338,7 @@ static bool deal_pinc(const rsOpts& opts, bool orig_args) {
     return false;
   }
 
-  if (tr >= 9 || getenv("pln_trace_env")) {
+  if (tr >= 11 || getenv("pln_trace_env")) {
     string cmd_fn = str::concat("01_deal_pinc.", std::to_string(s_env.pid_), ".pinc.sh");
     std::ofstream cmd_os(cmd_fn);
     if (cmd_os.is_open()) {
@@ -424,17 +452,14 @@ int main(int argc, char** argv) {
 
   s_env.initVersions(_pln_VERSION_STR);
 
-  if (ltrace() >= 2) {
-    if (ltrace() >= 6)
-      s_env.printPids(_pln_VERSION_STR);
-    else
-      lout() << _pln_VERSION_STR << endl;
+  if (ltrace() >= 3) {
+    lprintf("\t %s\n", _pln_VERSION_STR);
     lprintf("\t compiled:  %s\n", s_env.compTimeCS());
   }
 
   s_env.parse(argc, argv);
 
-  if (opts.trace_ >= 4 || ltrace() >= 9 || getenv("pln_trace_env")) {
+  if (opts.trace_ >= 8 || ltrace() >= 9 || getenv("pln_trace_env")) {
     s_env.dump("\n----env----\n");
     lout() << "-----------" << endl;
   }
@@ -445,13 +470,21 @@ int main(int argc, char** argv) {
     std::quick_exit(0);
   }
 
+  if (ltrace() >= 4) {
+    lprintf("ltrace()= %u  cmd.argc= %i\n", ltrace(), argc);
+  }
+
   if (opts.unit_specified()) {
     deal_units(opts);
     ::exit(0);
   }
 
-  if (ltrace() >= 3) {
-    lprintf("ltrace()= %u  cmd.argc= %i\n", ltrace(), argc);
+  if (opts.check_) {
+    bool check_ok = deal_check(opts);
+    if (check_ok)
+      ::exit(0);
+    else
+      ::exit(1);
   }
 
   int status = 1;