Merge pull request #827 from os-fpga/checker_improved_clock_data_check

checker: improved clock-data check

Author: serge-dsa

planning/src/RS/rsCheck.cpp

@@ -58,17 +58,18 @@ bool do_check_blif(CStr cfn) {
   bool chk_ok = bfile.checkBlif();
   assert(chk_ok == bfile.chk_ok_);
 
-  lprintf(">>>>>     passed: %s\n", chk_ok ? "YES" : "NO");
+  lprintf("=====  passed: %s\n", chk_ok ? "YES" : "NO");
 
-  ls << ">>>>>   topModel: " << bfile.topModel_ << endl;
-  ls << ">>>>>       file: " << bfile.fnm_ << endl;
-  if (bfile.num_MOGs_) {
+  ls << "-----  topModel: " << bfile.topModel_ << endl;
+  ls << "-----      file: " << bfile.fnm_ << endl;
+  ls << "-----  PinGraph: " << bfile.pinGraphFile_ << endl;
+  if (bfile.num_MOGs_ and tr >= 4) {
     ls << ">>>>> [NOTE] num_MOGs_ =  " << bfile.num_MOGs_ << endl;
   }
 
   flush_out(true);
   if (chk_ok) {
-    ls << " === BLIF is OK." << endl;
+    ls << "=====  BLIF is OK." << endl;
     if (tr >= 4 or bfile.trace_ >= 4) {
       flush_out(true);
       lprintf("     ltrace()= %u  pln_blif_trace= %u\n", tr, bfile.trace_);

planning/src/file_io/pln_blif_file.cpp

@@ -183,6 +183,9 @@ bool BLIF_file::readBlif() noexcept {
   fabricNodes_.clear();
   latches_.clear();
   constantNodes_.clear();
+  topModel_.clear();
+  pinGraphFile_.clear();
+
   rd_ok_ = chk_ok_ = false;
   err_msg_.clear();
   trace_ = 0;
@@ -459,7 +462,7 @@ bool BLIF_file::checkBlif() noexcept {
   }
 
   // -- write yaml file to check prim-DB:
-  if (trace_ >= 7) {
+  if (trace_ >= 8) {
     //string written = pr_write_yaml( DFFRE );
     //string written = pr_write_yaml( DSP19X2 );
     //string written = pr_write_yaml( DSP38 );
@@ -924,7 +927,7 @@ bool BLIF_file::createNodes() noexcept {
       continue;
     }
 
-    if (trace_ >= 6) lprintf("\t .....  line-%u  %s\n", L, cs);
+    if (trace_ >= 7) lprintf("\t .....  line-%u  %s\n", L, cs);
 
     // -- parse .names
     if (starts_w_names(cs + 1, len - 1)) {
@@ -1571,8 +1574,9 @@ bool BLIF_file::checkClockSepar(vector<const BNode*>& clocked) noexcept {
     lputs();
   }
 
-  if (trace_ >= 4)
-    writePinGraph("pin_graph_2.dot");
+  if (trace_ >= 3) {
+    pinGraphFile_ = writePinGraph("_PinGraph.dot");
+  }
 
   bool color_ok = true;
   CStr viol_prefix = "    ===>>> clock color violation";
@@ -1658,7 +1662,6 @@ bool BLIF_file::createPinGraph() noexcept {
     assert(nid);
     pg_.nodeRef(nid).markInp(true);
     assert(not pg_.nodeRef(nid).isNamed());
-    //pg_.setNodeName(nid, port.out_);
     pg_.setNodeName3(nid, port.id_, port.lnum_, port.out_.c_str());
     port.nw_id_ = nid;
     pg2blif_.emplace(nid, port.id_);
@@ -1672,12 +1675,23 @@ bool BLIF_file::createPinGraph() noexcept {
     assert(nid);
     pg_.nodeRef(nid).markOut(true);
     assert(not pg_.nodeRef(nid).isNamed());
-    //pg_.setNodeName(nid, port.out_);
     pg_.setNodeName3(nid, port.id_, port.lnum_, port.out_.c_str());
     port.nw_id_ = nid;
     pg2blif_.emplace(nid, port.id_);
   }
 
+  uint max_nid1 = pg_.getMaxNid();
+  uint64_t max_key1 = pg_.getMaxKey();
+  if (trace_ >= 4) {
+    if (trace_ >= 5) lputs();
+    lprintf(" (pg_ after inserting top-port nodes)");
+    lprintf("  max_nid= %u  max_key= %zu\n", max_nid1, max_key1);
+    if (trace_ >= 5) {
+      pg_.printNodes(lout(), " pg_ after inserting top-port nodes ", false);
+    }
+  }
+  max_key1++; // max_key1 is used to offset hashCantor
+
   vector<qTup> Q;
   Q.reserve(topInputs_.size());
 
@@ -1720,7 +1734,7 @@ bool BLIF_file::createPinGraph() noexcept {
       }
 
       assert(par.cell_hc_);
-      key = hashCantor(par.id_, pinIndex+1);
+      key = hashCantor(par.id_, pinIndex+1) + max_key1;
       assert(key);
       assert(not pg_.hasKey(key));
       kid = pg_.insK(key);
@@ -1735,7 +1749,7 @@ bool BLIF_file::createPinGraph() noexcept {
                  par.lnum_, par.id_, pinIndex);
 
       assert(not pg_.nodeRef(kid).inp_flag_);
-      pg_.setNodeName3(kid, par.id_, par.lnum_);
+      pg_.setNodeName4(kid, par.id_, par.lnum_, pinIndex+1, par.cPrimType());
       pg_.nodeRef(kid).markClk(is_clock);
 
       if (trace_ >= 6)
@@ -1772,7 +1786,7 @@ bool BLIF_file::createPinGraph() noexcept {
                 kid, bnode.lnum_, q.cellId_);
 
       assert(not pg_.nodeRef(kid).inp_flag_);
-      pg_.setNodeName3(kid, bnode.id_, bnode.lnum_);
+      pg_.setNodeName3(kid, bnode.id_, bnode.lnum_, bnode.out_.c_str());
       bnode.nw_id_ = kid;
       pg2blif_.emplace(kid, bnode.id_);
 
@@ -1800,7 +1814,7 @@ bool BLIF_file::createPinGraph() noexcept {
         if (not pr_pin_is_clock(cn.ptype_, inp))
           continue;
         assert(cn.cell_hc_);
-        key = hashCantor(cn.id_, i + 1);
+        key = hashCantor(cn.id_, i + 1) + max_key1;
         assert(key);
         // assert(not pg_.hasKey(key));
         kid = pg_.insK(key);
@@ -1888,7 +1902,7 @@ bool BLIF_file::createPinGraph() noexcept {
             return false;
           }
 
-          uint64_t ipin_key = hashCantor(dn.id_, 1);
+          uint64_t ipin_key = hashCantor(dn.id_, 1) + max_key1;
           assert(ipin_key);
           uint ipin_nid = pg_.findNode(ipin_key);
           if (ipin_nid) {
@@ -2029,32 +2043,39 @@ bool BLIF_file::createPinGraph() noexcept {
   return true;
 }
 
-bool BLIF_file::writePinGraph(CStr fn) const noexcept {
+string BLIF_file::writePinGraph(CStr fn0) const noexcept {
   auto& ls = lout();
-  flush_out(true);
-  pg_.print(ls, "\t *** pin_graph for clock-data separation ***");
-  lprintf("\t  pg_. numN()= %u   numE()= %u\n", pg_.numN(), pg_.numE());
-  lputs();
-  pg_.printSum(ls, 0);
-  lputs();
-  pg_.printEdges(ls, "|edges|");
-  flush_out(true);
+  if (trace_ >= 5) {
+    flush_out(true);
+    pg_.print(ls, "\t *** pin_graph for clock-data separation ***");
+    lprintf("\t  pg_. numN()= %u   numE()= %u\n", pg_.numN(), pg_.numE());
+    lputs();
+    pg_.printSum(ls, 0);
+    lputs();
+    pg_.printEdges(ls, "|edges|");
+    flush_out(true);
+  }
 
-  if (!fn or !fn[0])
-    fn = "pinGraph.dot";
+  if (!fn0 or !fn0[0])
+    fn0 = "pinGraph.dot";
 
-  bool wrDot_ok = pg_.writeDot(fn, nullptr, true, true);
+  string fn = str::concat(topModel_.c_str(), "_", fn0);
+
+  bool wrDot_ok = pg_.writeDot(fn.c_str(), nullptr, true, true);
   if (!wrDot_ok) {
     flush_out(true); err_puts();
-    lprintf2("[Error] could not write pin_graph to file '%s'\n", fn);
+    lprintf2("[Error] could not write pin_graph to file '%s'\n", fn.c_str());
     err_puts(); flush_out(true);
   }
 
-  lprintf("(writePinGraph)  status:%i  file: %s\n",
-          wrDot_ok, fn);
+  lprintf("(writePinGraph)  status:%s  file: %s\n",
+          wrDot_ok ? "OK" : "FAIL",
+          fn.c_str());
 
   flush_out(true);
-  return wrDot_ok;
+  if (wrDot_ok)
+    return fn;
+  return {};
 }
 
 }

planning/src/file_io/pln_blif_file.h

@@ -213,6 +213,7 @@ struct BLIF_file : public fio::MMapReader
   }
 
   string topModel_;
+  string pinGraphFile_;
 
   vector<string> inputs_;
   vector<string> outputs_;
@@ -261,7 +262,8 @@ struct BLIF_file : public fio::MMapReader
 
   bool createPinGraph() noexcept;
   bool linkPinGraph() noexcept;
-  bool writePinGraph(CStr fn) const noexcept;
+
+  string writePinGraph(CStr fn0) const noexcept;
 
   bool checkClockSepar(vector<const BNode*>& clocked) noexcept;
 

planning/src/main.cpp

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

planning/src/util/nw/Nw.h

@@ -282,7 +282,8 @@ struct NW {
   bool empty() const noexcept { return nids_.empty(); }
 
   inline uint getMaxLabel() const noexcept;
-  inline uint getMaxNid() const noexcept;
+  uint getMaxNid() const noexcept;
+  uint64_t getMaxKey() const noexcept;
 
   upair getMinMaxDeg() const noexcept;
   upair getMinMaxLbl() const noexcept;
@@ -812,16 +813,6 @@ inline uint NW::getMaxLabel() const noexcept {
   return maxLabel;
 }
 
-inline uint NW::getMaxNid() const noexcept {
-  if (empty()) return 0;
-  uint maxId = 0;
-  for (cNI I(*this); I.valid(); ++I) {
-    const Node& nd = *I;
-    if (nd.id_ > maxId) maxId = nd.id_;
-  }
-  return maxId;
-}
-
 inline void NW::sort_xy() noexcept {
   std::sort(nids_.begin(), nids_.end(), Cmpi_xy(*this));
 }

planning/src/util/nw/Nw_io.cpp

@@ -346,8 +346,8 @@ void NW::Node::nprint_dot(ostream& os) const noexcept {
       ::sprintf(attrib, "[ shape=box, color=%s, style=filled ];", cs);
     }
     else if (clk_flag_) {
-      CStr cs = isRed() ? "red" : "orange";
-      ::sprintf(attrib, "[ shape=record, color=%s, style=filled ];", cs);
+      CStr cs = isRed() ? "violet" : "orange";
+      ::sprintf(attrib, "[ shape=ellipse, color=%s, style=filled ];", cs);
     }
   }
 
@@ -592,6 +592,8 @@ static const char* _colorNames[] = {
 };
 
 CStr NW::i2color(uint i) noexcept {
+  if (i == c_Red)
+    return "darkviolet";
   return _colorNames[ i % (c_MAX_COLOR + 1) ];
 }
 

planning/src/util/nw/Nw_node.cpp

@@ -84,16 +84,17 @@ void NW::getOutgE(const Node& nd, vecu& E) const noexcept {
   }
 }
 
+static constexpr uint STOP_ON_NAMING_NODE = 29;
+
 void NW::setNodeName(uint id, CStr nm) noexcept {
   assert(hasNode(id));
+  // assert(nm);
 
-  assert(nm);
-
-  //if (nodeRef(id).isNamed())
-  //  lputs1();
-  // ---
-  //if (id == 17)
-  //  lputs1();
+  if (STOP_ON_NAMING_NODE) {
+    if (id == STOP_ON_NAMING_NODE) {
+      lputs1();
+    }
+  }
 
   if (nm) {
     if (trace_ >= 6)
@@ -118,6 +119,12 @@ void NW::setNodeName3(uint id, uint B, uint L, CStr a) noexcept {
 
   if (trace_ >= 6)
     lprintf(" (setNodeName3)   %u --> %s\n", id, nd.name_.c_str());
+
+  if (STOP_ON_NAMING_NODE) {
+    if (id == STOP_ON_NAMING_NODE) {
+      lputs1();
+    }
+  }
 }
 
 void NW::setNodeName4(uint id, uint B, uint L, uint ipin, CStr a) noexcept {
@@ -134,6 +141,12 @@ void NW::setNodeName4(uint id, uint B, uint L, uint ipin, CStr a) noexcept {
 
   if (trace_ >= 6)
     lprintf(" (setNodeName4)   %u --> %s\n", id, nd.name_.c_str());
+
+  if (STOP_ON_NAMING_NODE) {
+    if (id == STOP_ON_NAMING_NODE) {
+      lputs1();
+    }
+  }
 }
 
 uint NW::countRedEdges() const noexcept {
@@ -154,5 +167,25 @@ void NW::clearEdges() noexcept {
   }
 }
 
+uint NW::getMaxNid() const noexcept {
+  if (empty()) return 0;
+  uint maxId = 0;
+  for (cNI I(*this); I.valid(); ++I) {
+    const Node& nd = *I;
+    if (nd.id_ > maxId) maxId = nd.id_;
+  }
+  return maxId;
+}
+
+uint64_t NW::getMaxKey() const noexcept {
+  if (empty()) return 0;
+  uint64_t maxK = 0;
+  for (cNI I(*this); I.valid(); ++I) {
+    const Node& nd = *I;
+    if (nd.key_ > maxK) maxK = nd.key_;
+  }
+  return maxK;
+}
+
 }