Merge pull request #760 from os-fpga/pinc_check_and_report_config_json_arg

pin_c: check and report config.json argument

Author: serge-dsa

planning/src/RS/rsOpts.cpp

@@ -29,6 +29,8 @@ static CStr _xml_[] = {"XM", "xm", "xml", "XML", nullptr};
 
 static CStr _pcf_[] = {"PCF", "pcf", nullptr};
 
+static CStr _edtf_[] = {"EDT", "edit", "edits", nullptr};
+
 static CStr _blif_[] = {"BL", "blif", nullptr};
 
 static CStr _json_[] = {"JS", "js", "jsf", "json", "port_info", "port_i", "PI", nullptr};
@@ -129,6 +131,7 @@ void rsOpts::print(CStr label) const noexcept {
   printf("  pcfFile_: %s\n", nns(pcfFile_));
   printf("  blifFile_: %s\n", nns(blifFile_));
   printf("  jsonFile_: %s\n", nns(jsonFile_));
+  printf("  editsFile_: %s\n", nns(editsFile_));
   printf("  output_: %s\n", nns(output_));
   printf("  assignOrder_: %s\n", nns(assignOrder_));
 
@@ -285,7 +288,7 @@ void rsOpts::parse(int argc, const char** argv) noexcept {
   assert(argc_ > 0 and argv_);
 
   CStr inp = 0, out = 0, csv = 0, xml = 0, pcf = 0, blif = 0, jsnf = 0,
-       fun = 0, assignOrd = 0;
+       fun = 0, assignOrd = 0, edtf = 0;
 
   for (int i = 1; i < argc_; i++) {
     CStr arg = argv_[i];
@@ -343,6 +346,14 @@ void rsOpts::parse(int argc, const char** argv) noexcept {
         pcf = nullptr;
       continue;
     }
+    if (op_match(arg, _edtf_)) {
+      i++;
+      if (i < argc_)
+        edtf = argv_[i];
+      else
+        edtf = nullptr;
+      continue;
+    }
     if (op_match(arg, _blif_)) {
       i++;
       if (i < argc_)
@@ -421,6 +432,7 @@ void rsOpts::parse(int argc, const char** argv) noexcept {
   pcfFile_ = p_strdup(pcf);
   blifFile_ = p_strdup(blif);
   jsonFile_ = p_strdup(jsnf);
+  editsFile_ = p_strdup(edtf);
 
   if (fun)
     setFunction(fun);
@@ -541,6 +553,7 @@ bool rsOpts::ends_with_pin_c(CStr z) noexcept {
 
 // static 
 bool rsOpts::validate_pinc_args(int argc, const char** argv) noexcept {
+  flush_out(false);
   using std::cerr;
   if (argc < 1 or !argv)
     return false;
@@ -576,12 +589,24 @@ bool rsOpts::validate_pinc_args(int argc, const char** argv) noexcept {
   CStr pcf = tmpO.pcfFile_;
   if (pcf) {
     if (not Fio::regularFileExists(pcf)) {
-      lprintf("\n[Error] specified PCF file %s does not exist\n", pcf);
-      cerr << "[Error] specified PCF file does not exist" << endl; 
+      flush_out(true); err_puts();
+      lprintf2("[Error] specified PCF file does not exist: %s\n", pcf);
+      err_puts(); flush_out(true);
+      return false;
+    }
+  }
+
+  CStr editf = tmpO.editsFile_;
+  if (editf) {
+    if (not Fio::regularFileExists(editf)) {
+      flush_out(true); err_puts();
+      lprintf2("[Error] specified config_json (--edits) file does not exist: %s\n", editf);
+      err_puts(); flush_out(true);
       return false;
     }
   }
 
+  flush_out(false);
   return true;
 }
 

planning/src/RS/rsOpts.h

@@ -54,6 +54,7 @@ struct rsOpts {
   char* pcfFile_ = nullptr;
   char* blifFile_ = nullptr;
   char* jsonFile_ = nullptr;
+  char* editsFile_ = nullptr;
 
   char* input_ = nullptr;
   char* output_ = nullptr;

planning/src/main.cpp

@@ -1,4 +1,4 @@
-static const char* _pln_VERSION_STR = "pln0247";
+static const char* _pln_VERSION_STR = "pln0258";
 
 #include "RS/rsEnv.h"
 #include "util/pln_log.h"

planning/src/pin_loc/pcf_place.cpp

@@ -349,7 +349,11 @@ void PinPlacer::print_summary(const string& csv_name) const {
 
   lprintf("     auto-PCF : %s\n", auto_pcf_created_ ? "TRUE" : "FALSE");
   if (!auto_pcf_created_)
-  lprintf("     user-PCF : %s\n", user_pcf_.c_str());
+    lprintf("     user-PCF : %s\n", user_pcf_.c_str());
+
+  CStr editsVal = has_edits_.empty() ? "FALSE" : has_edits_.c_str();
+  lprintf("     has edits (config.json) : %s\n", editsVal);
+
   lprintf("  pinc_trace verbosity= %u\n", tr);
 
   if (num_critical_warnings_) {

planning/src/pin_loc/pin_placer.cpp

@@ -164,6 +164,8 @@ void PinPlacer::resetState() noexcept {
   pin_names_translated_ = false;
   num_warnings_ = 0;
   num_critical_warnings_ = 0;
+  user_pcf_.clear();
+  has_edits_.clear();
   clear_err_code();
 }
 
@@ -304,17 +306,18 @@ bool PinPlacer::read_and_write() {
   }
 
   // --4. read netlist edits (--edits option)
-  bool has_edits = read_edits();
+  has_edits_ = read_edits();
   flush_out(false);
-  if (tr >= 3)
-    lprintf("\t  has_edits : %i\n", has_edits);
-
+  if (tr >= 3) {
+    CStr val = has_edits_.empty() ? "(FALSE)" : has_edits_.c_str();
+    lprintf("\t  has_edits_ : %s\n", val);
+  }
 
   // if no user pcf is provided, created a temp one
   if (usage_requirement_2 || (usage_requirement_0 && user_pcf_ == "")) {
     flush_out(true);
-    if (has_edits) {
-      // if auto-PCF and has_edits, translate and de-duplicate
+    if (has_edits_.size()) {
+      // if auto-PCF and has_edits_, translate and de-duplicate
       // user-design ports now, since edits.json could remove some design ports.
       if (not pin_names_translated_)
         translatePinNames("(auto-PCF)");
@@ -412,7 +415,7 @@ bool PinPlacer::read_and_write() {
         }
       }
 
-    } // has_edits
+    } // has_edits_
 
     if (!create_temp_pcf(csv_rd)) {
       flush_out(true);

planning/src/pin_loc/pin_placer.h

@@ -114,6 +114,7 @@ struct PinPlacer {
 
   bool auto_pcf_created_ = false;
   string user_pcf_;
+  string has_edits_;
 
 public:
   enum class PortDir : uint8_t {
@@ -199,7 +200,7 @@ struct PinPlacer {
 
   bool read_csv_file(PcCsvReader&);
   bool read_design_ports();
-  bool read_edits();
+  string read_edits();
   void translate_pcf_cmds();
 
   bool read_pcf(const PcCsvReader&);

planning/src/pin_loc/read_ports.cpp

@@ -177,10 +177,14 @@ bool PinPlacer::read_design_ports() {
   return true;
 }
 
-bool PinPlacer::read_edits() {
+// returns {} on error
+string PinPlacer::read_edits() {
   flush_out(false);
   uint16_t tr = ltrace();
-  if (tr >= 4) lputs("\nread_edits() __ getting io_config .json");
+  if (tr >= 4) {
+    flush_out(true);
+    lputs("\nread_edits() __ getting io_config .json");
+  }
 
   all_edits_.clear();
   ibufs_.clear();
@@ -189,7 +193,7 @@ bool PinPlacer::read_edits() {
   string edits_fn = cl_.get_param("--edits");
   if (edits_fn.empty()) {
     if (tr >= 4) lputs("[Info] edits cmd option is not specified");
-    return false;
+    return {};
   }
 
   if (tr >= 4)
@@ -203,7 +207,7 @@ bool PinPlacer::read_edits() {
     err_puts();
     CERROR << "specified <io edits>.json file does not exist: " << edits_fn << endl;
     flush_out(true);
-    return false;
+    return {};
   }
   if (! Fio::nonEmptyFileExists(edits_fn)) {
     flush_out(true);
@@ -212,7 +216,7 @@ bool PinPlacer::read_edits() {
     err_puts();
     CERROR << "specified <io edits>.json file is empty or not accessible: " << edits_fn << endl;
     flush_out(true);
-    return false;
+    return {};
   }
 
   ifstream edits_ifs(edits_fn);
@@ -226,7 +230,7 @@ bool PinPlacer::read_edits() {
       err_puts();
       OUT_ERROR << " failed reading " << edits_fn << endl;
       flush_out(true);
-      return false;
+      return {};
     }
   }
   else {
@@ -236,7 +240,7 @@ bool PinPlacer::read_edits() {
     CERROR    << "  could not open <io edits>.json file : " << edits_fn << endl;
     err_puts();
     flush_out(true);
-    return false;
+    return {};
   }
 
   bool check_ok = check_edit_info();
@@ -256,7 +260,9 @@ bool PinPlacer::read_edits() {
   }
 
   flush_out(false);
-  return bool(ibufs_.size()) or bool(obufs_.size());
+  if (ibufs_.size() or obufs_.size())
+    return edits_fn;
+  return {};
 }
 
 static bool read_json_ports(const nlohmann::ordered_json& from,