Merge pull request #789 from os-fpga/checker_now_works_on_simple_cases

checker: clock separation check now works on simple cases

Author: serge-dsa

planning/src/file_readers/pln_blif_file.cpp

@@ -439,8 +439,16 @@ bool BLIF_file::checkBlif() noexcept {
         flush_out(true);
         return false;
       }
-      if (trace_ >= 4)
+      if (trace_ >= 4) {
         lputs("(clock-data separation)  checked OK.");
+        if (trace_ >= 5) {
+          flush_out(true);
+          pg_.print(ls, " [[ final pinGraph ]]");
+          flush_out(true);
+          pg_.printEdges(ls, "[[ edges of pinGraph ]]");
+          flush_out(true);
+        }
+      }
     }
     flush_out(true);
   }
@@ -1027,7 +1035,6 @@ bool BLIF_file::createNodes() noexcept {
           Fio::split_spa(buf, V);
           if (not V.empty()) nd.out_ = V.back();
         }
-        // lputs9();
         // fill inPins_, inSigs_:
         nd.inPins_.clear();
         nd.inSigs_.clear();
@@ -1324,7 +1331,6 @@ bool BLIF_file::linkNodes() noexcept {
           lout() << pinToken << endl;
         if (not par->isLatch()) {
           // skipping latches for now
-          // lputs9();
           err_msg_.reserve(224);
           err_msg_ = "output port contacts fabric input:  port= ",
           err_msg_ += nd.out_;
@@ -1434,6 +1440,11 @@ bool BLIF_file::checkClockSepar(vector<const Node*>& clocked) noexcept {
   if (pg_.size() < 3)
     return true;
 
+  if (trace_ >= 3) {
+    lprintf("    number of clock nodes = %u\n",
+            pg_.countClockNodes());
+  }
+
   if (not pg_.hasClockNodes())
     return true;
 
@@ -1448,8 +1459,43 @@ bool BLIF_file::checkClockSepar(vector<const Node*>& clocked) noexcept {
       }
     }
   }
+  // -- paint nodes contacted by red edges
+  for (NW::cEI E(pg_); E.valid(); ++E) {
+    const NW::Edge& ed = *E;
+    if (ed.isRed()) {
+      pg_.nodeRef(ed.n1_).paintRed();
+      pg_.nodeRef(ed.n2_).paintRed();
+    }
+  }
+  // -- for red input ports, paint their outgoing edges Red
+  for (const Node* p : topInputs_) {
+    const Node& port = *p;
+    assert(port.nw_id_);
+    NW::Node& nw_node = pg_.nodeRefCk(port.nw_id_);
+    for (NW::OutgEI J(pg_, nw_node); J.valid(); ++J) {
+      uint eid = J->id_;
+      pg_.edgeRef(eid).paintRed();
+    }
+  }
 
-  return true;
+  writePinGraph("pin_graph_2.dot");
+
+  bool color_ok = true;
+
+  // -- check that end-points of red edges are red
+  for (NW::cEI E(pg_); E.valid(); ++E) {
+    const NW::Edge& ed = *E;
+    if (not ed.isRed())
+      continue;
+    const NW::Node& p1 = pg_.nodeRef(ed.n1_);
+    const NW::Node& p2 = pg_.nodeRef(ed.n2_);
+    if (!p1.isRed() or !p2.isRed()) {
+      color_ok = false;
+      break;
+    }
+  }
+
+  return color_ok;
 }
 
 struct qTup {
@@ -1472,7 +1518,6 @@ struct qTup {
 };
 
 bool BLIF_file::createPinGraph() noexcept {
-  auto& ls = lout();
   pg_.clear();
   if (!rd_ok_) return false;
   if (topInputs_.empty() and topOutputs_.empty()) return false;
@@ -1486,23 +1531,25 @@ bool BLIF_file::createPinGraph() noexcept {
   char nm_buf[512] = {};
 
   // -- create pg-nodes for topInputs_
-  for (const Node* p : topInputs_) {
-    const Node& port = *p;
+  for (Node* p : topInputs_) {
+    Node& port = *p;
     assert(!port.out_.empty());
     nid = pg_.insK(port.id_);
     assert(nid);
     pg_.setNodeName(nid, port.out_);
     pg_.nodeRef(nid).markInp(true);
+    port.nw_id_ = nid;
   }
 
   // -- create pg-nodes for topOutputs_
-  for (const Node* p : topOutputs_) {
-    const Node& port = *p;
+  for (Node* p : topOutputs_) {
+    Node& port = *p;
     assert(!port.out_.empty());
     nid = pg_.insK(port.id_);
     assert(nid);
     pg_.setNodeName(nid, port.out_);
     pg_.nodeRef(nid).markOut(true);
+    port.nw_id_ = nid;
   }
 
   vector<qTup> Q;
@@ -1592,24 +1639,39 @@ bool BLIF_file::createPinGraph() noexcept {
     }
   }
 
-  if (1) {
+  pg_.setNwName("pin_graph");
 
-    flush_out(true);
-    pg_.setNwName("pin_graph");
-    pg_.dump("\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_.dumpEdges("|edges|");
-    lputs();
+  // writePinGraph("pin_graph_1.dot");
 
-    bool wrDot_ok = pg_.writeDot("pinGraph.dot", nullptr, true, true);
-    lprintf("wrDot_ok:%i\n", wrDot_ok);
+  return true;
+}
 
+bool BLIF_file::writePinGraph(CStr fn) 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 (!fn or !fn[0])
+    fn = "pinGraph.dot";
+
+  bool wrDot_ok = pg_.writeDot(fn, nullptr, true, true);
+  if (!wrDot_ok) {
+    flush_out(true); err_puts();
+    lprintf2("[Error] could not write pin_graph to file '%s'\n", fn);
+    err_puts(); flush_out(true);
   }
 
-  return true;
+  lprintf("(writePinGraph)  status:%i  file: %s\n",
+          wrDot_ok, fn);
+
+  flush_out(true);
+  return wrDot_ok;
 }
 
 }

planning/src/file_readers/pln_blif_file.h

@@ -18,8 +18,10 @@ struct BLIF_file : public fio::MMapReader
   // Input ports are leaves.
   // Output ports are roots of fanin cones.
   struct Node {
-    uint id_ = 0;    // index+1 in pool
-    uint lnum_ = 0;  // line number in blif
+    uint id_ = 0;      // index+1 in pool
+    uint nw_id_ = 0;   // node-id in NW, for ports only
+
+    uint lnum_ = 0;    // line number in blif
     uint parent_ = 0;
     uint depth_ = 0;
     vector<uint> chld_;
@@ -236,6 +238,7 @@ struct BLIF_file : public fio::MMapReader
 
   bool createPinGraph() noexcept;
   bool linkPinGraph() noexcept;
+  bool writePinGraph(CStr fn) const noexcept;
 
   bool checkClockSepar(vector<const Node*>& clocked) noexcept;
 

planning/src/main.cpp

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

planning/src/util/nw/Nw.cpp

@@ -144,12 +144,15 @@ void NW::rmNode(uint x) noexcept {
   rm.inval();
 }
 
-void NW::getTopo(vecu& topo) noexcept {
+bool NW::getTopo(vecu& topo) noexcept {
   topo.clear();
-  if (empty()) return;
-  labelDepth();
+  if (empty()) return true;
+  bool ok = labelDepth();
+  if (not ok)
+    return false;
   getNodes(topo);
   sort_label(topo);
+  return true;
 }
 
 uint NW::getRadius() noexcept {
@@ -161,10 +164,12 @@ uint NW::getRadius() noexcept {
 
 using Nd = NW::Node;
 
-static void dfs_setD(NW& g, const Nd& fr, Nd& to) noexcept {
+static bool dfs_setD(NW& g, const Nd& fr, Nd& to) noexcept {
   assert(to.lbl_ == UINT_MAX);
   assert(fr.lbl_ != UINT_MAX);
-  assert(to.par_ > 0 and to.par_ == fr.id_);
+  assert(to.par_ > 0);
+  if (to.par_ != fr.id_)
+    return false;
 
   to.lbl_ = fr.lbl_ + 1;
 
@@ -173,11 +178,14 @@ static void dfs_setD(NW& g, const Nd& fr, Nd& to) noexcept {
     NW::Edge& e = g.edgeRef(ei);
     Nd& other = g.nodeRef(to.otherSide(e));
     if (other.id_ == fr.id_) continue;
-    dfs_setD(g, to, other);
+    if (not dfs_setD(g, to, other))
+      return false;
   }
+
+  return true;
 }
 
-void NW::labelDepth() noexcept {
+bool NW::labelDepth() noexcept {
   assert(not empty());
   uint rootId = first_rid();
   assert(rootId);
@@ -188,22 +196,25 @@ void NW::labelDepth() noexcept {
   for (NI I(*this); I.valid(); ++I) I->lbl_ = UINT_MAX;
   root.lbl_ = 0;
   if (size() == 1) {
-    return;
+    return true;
   }
   if (size() == 2) {
     for (NI I(*this); I.valid(); ++I) {
       Node& nd = *I;
       if (nd.id_ != rootId)
         nd.lbl_ = 1;
     }
-    return;
+    return true;
   }
 
   for (int i = root.degree() - 1; i >= 0; i--) {
     Edge& e = edStor_[root.edges_[i]];
     Node& to = ndStor_[root.otherSide(e)];
-    dfs_setD(*this, root, to);
+    if (not dfs_setD(*this, root, to))
+      return false;
   }
+
+  return true;
 }
 
 upair NW::getMinMaxDeg() const noexcept {
@@ -372,10 +383,16 @@ void NW::Edge::eprint_dot(ostream& os, char arrow, const NW& g) const noexcept {
   replace_bus_for_dot(buf);
   os << buf;
 
-  if (inCell_) {
-    os_printf(os, " [ style=dashed ] ");
-  }
-  os_printf(os, ";\n");
+  char attrib[512] = {};
+  ::sprintf(attrib, " [%s %s",
+      inCell_ ? "style=dashed" : "",
+      color_ ? "color=" : ""
+      );
+  if (color_)
+    ::strcat(attrib, i2color(color_));
+  ::strcat(attrib, " ]");
+
+  os_printf(os, "%s;\n", attrib);
 }
 
 uint NW::print(ostream& os, CStr msg) const noexcept {
@@ -581,6 +598,37 @@ void NW::beComplete() noexcept {
     }
   }
   assert(selfCheck());
+
+  for (EI I(*this); I.valid(); ++I) {
+    Edge& e = *I;
+    e.paint( e.id_ % (c_MAX_COLOR + 1) );
+  }
+}
+
+static const char* _colorNames[] = {
+  "black",
+  "red",
+  "orange",
+  "yellow",
+  "green",
+  "blue",
+  "firebrick",
+  "darkslategray",
+  "purple",
+  "aquamarine3",
+  "chocolate4",
+  "cadetblue4",
+  "darkolivegreen4",
+  "darkorchid4",
+  "cyan",
+  "goldenrod3",
+  "black",
+  "black",
+  "black"
+};
+
+CStr NW::i2color(uint i) noexcept {
+  return _colorNames[ i % (c_MAX_COLOR + 1) ];
 }
 
 }

planning/src/util/nw/Nw.h

@@ -37,6 +37,17 @@ struct NW {
   static constexpr uint c_Yellow = 3;
   static constexpr uint c_Green = 4;
   static constexpr uint c_Blue = 5;
+  static constexpr uint c_firebrick = 6;
+  static constexpr uint c_darkslategray = 7;
+  static constexpr uint c_purple = 8;
+  static constexpr uint c_aquamarine3 = 9;
+  static constexpr uint c_chocolate4 = 10;
+  static constexpr uint c_cadetblue4 = 11;
+  static constexpr uint c_darkolivegreen4 = 12;
+  static constexpr uint c_darkorchid4 = 13;
+  static constexpr uint c_cyan = 14;
+  static constexpr uint c_goldenrod3 = 15;
+  static constexpr uint c_MAX_COLOR = 15;
 
   struct Edge {
     uint id_ = 0;
@@ -437,20 +448,22 @@ struct NW {
   }
   inline void labelNodes(uint label, uint parent) noexcept;
   inline void labelRadius() noexcept;
-  void labelDepth() noexcept;
+  bool labelDepth() noexcept;
 
   inline void sort_xy() noexcept;
   inline void sort_label(vecu& V) const noexcept;
   inline void sort_cid(vecu& V) const noexcept;
 
-  void getTopo(vecu& topo) noexcept;
+  bool getTopo(vecu& topo) noexcept;
   uint getRadius() noexcept;
 
   inline bool selfCheck() const noexcept { return true; }
   inline bool checkConn() const noexcept { return true; }
 
   bool verifyOneRoot() const noexcept;
 
+  static CStr i2color(uint i) noexcept;
+
   uint print(ostream& os, CStr msg = nullptr) const noexcept;
   uint dump(CStr msg = nullptr) const noexcept;
   uint printNodes(ostream& os, CStr msg, uint16_t forDot) const noexcept;