GraphIR: Implement the dotty-printing of the graph.

Author: nadavrot

include/glow/Graph/Graph.h

@@ -104,6 +104,9 @@ class Graph final {
 
   /// Dumps the textual representation of the network.
   void dump();
+
+  /// Dump a dotty graph that depicts the module.
+  void dumpDAG();
 };
 
 } // namespace glow

src/glow/Graph/Graph.cpp

@@ -3,7 +3,9 @@
 #include "glow/Graph/Graph.h"
 #include "glow/Graph/Nodes.h"
 #include "glow/IR/IR.h"
+#include "glow/Support/Support.h"
 
+#include <fstream>
 #include <iostream>
 
 using namespace glow;
@@ -203,3 +205,77 @@ void Graph::dump() {
     std::cout << n->getDebugDesc() << "\n";
   }
 }
+
+/// A helper class for visiting and generating the dotty file from the graph.
+struct DottyPrinterPass : NodeVisitor {
+  using edgeTy = std::pair<Node *, Node *>;
+  std::vector<edgeTy> nodeEdges{};
+
+public:
+  // Don't revisit visited nodes.
+  bool shouldVisit(Node *parent, Node *N) override {
+    edgeTy e = {parent, N};
+    return std::find(nodeEdges.begin(), nodeEdges.end(), e) == nodeEdges.end();
+  }
+
+  DottyPrinterPass() = default;
+
+  void pre(Node *parent, Node *N) override { nodeEdges.push_back({parent, N}); }
+
+  std::string nodeDescr(Node *N) {
+    if (!N) {
+      return "";
+    }
+    // Print a node descriptor that looks like this:
+    // Format: "node12" [ label = "0xf7fc43e01" shape = "record" ];
+    std::string sb;
+    sb += quote(std::to_string((void *)N)) + "[\n";
+    std::string repr = escapeDottyString(N->getDebugDesc());
+    sb += "\tlabel = " + repr + "\n";
+    sb += "\tshape = \"record\"\n";
+    sb += "];\n\n";
+    return sb;
+  }
+
+  std::string quote(std::string in) { return '"' + in + '"'; }
+  std::string getDottyString() {
+    std::string sb;
+
+    sb += "digraph finite_state_machine {\n\trankdir=TD;\n";
+
+    // Assign a unique name to each one of the nodes:
+    for (auto &e : nodeEdges) {
+      if (e.first) {
+        sb += quote(std::to_string(e.second)) + " -> " +
+              quote(std::to_string(e.first)) + ";\n";
+      }
+    }
+
+    // Assign a unique name to each one of the nodes:
+    for (auto &e : nodeEdges) {
+      sb += nodeDescr(e.first);
+      sb += nodeDescr(e.second);
+    }
+
+    sb += "}";
+    return sb;
+  }
+};
+
+void Graph::dumpDAG() {
+  DottyPrinterPass DP;
+
+  for (auto &N : nodes_) {
+    N->visit(nullptr, &DP);
+  }
+
+  std::string filename = "dotty_graph_dump_" + std::to_string(this) + ".dot";
+  std::cout << "Writing dotty graph to: " << filename << '\n';
+
+  std::string rep = DP.getDottyString();
+
+  std::ofstream myfile;
+  myfile.open(filename);
+  myfile << rep;
+  myfile.close();
+}

src/glow/Graph/Nodes.cpp

@@ -78,7 +78,7 @@ std::string Node::getDebugDesc() const { return "<node>"; }
 
 std::string Variable::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()))
+  db.addParam("name", quote(getName()))
       .addParam("output", *getType())
       .addParam("init", WeightVar::getInitKindStr(initKind_))
       .addParam("val", val_);
@@ -87,7 +87,7 @@ std::string Variable::getDebugDesc() const {
 
 std::string ConvolutionNode::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()))
+  db.addParam("name", quote(getName()))
       .addParam("input", *in_->getType())
       .addParam("output", *getType())
       .addParam("filter", *filter_->getType())
@@ -100,7 +100,7 @@ std::string ConvolutionNode::getDebugDesc() const {
 }
 std::string PoolNode::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()))
+  db.addParam("name", quote(getName()))
 
       .addParam("input", *in_->getType())
       .addParam("output", *getType())
@@ -113,7 +113,7 @@ std::string PoolNode::getDebugDesc() const {
 
 std::string FullyConnectedNode::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()))
+  db.addParam("name", quote(getName()))
       .addParam("input", *in_->getType())
       .addParam("output", *getType())
       .addParam("filter", *filter_->getType())
@@ -124,7 +124,7 @@ std::string FullyConnectedNode::getDebugDesc() const {
 
 std::string LocalResponseNormalizationNode::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()))
+  db.addParam("name", quote(getName()))
       .addParam("input", *in_->getType())
       .addParam("alpha", alpha_)
       .addParam("beta", beta_)
@@ -135,7 +135,7 @@ std::string LocalResponseNormalizationNode::getDebugDesc() const {
 
 std::string ConcatNode::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()));
+  db.addParam("name", quote(getName()));
 
   for (auto input : in_) {
     db.addParam("input", *input->getType());
@@ -146,23 +146,23 @@ std::string ConcatNode::getDebugDesc() const {
 
 std::string SoftMaxNode::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()))
+  db.addParam("name", quote(getName()))
       .addParam("input", *in_->getType())
       .addParam("selected", *selected_->getType());
   return db;
 }
 
 std::string RegressionNode::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()))
+  db.addParam("name", quote(getName()))
       .addParam("input", *in_->getType())
       .addParam("expected", *expected_->getType());
   return db;
 }
 
 std::string BatchNormalizationNode::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()))
+  db.addParam("name", quote(getName()))
       .addParam("input", *in_->getType())
       .addParam("beta", *bias_->getType())
       .addParam("gamma", *scale_->getType())
@@ -174,7 +174,7 @@ std::string BatchNormalizationNode::getDebugDesc() const {
 
 std::string ArithmeticNode::getDebugDesc() const {
   DescriptionBuilder db(getKindName());
-  db.addParam("name ", quote(getName()))
+  db.addParam("name", quote(getName()))
       .addParam("output", *getType())
       .addParam("op", kind_ == ArithmeticInst::OpKind::Add ? "add" : "mul");
   return db;

src/glow/IR/IR.cpp

@@ -256,7 +256,7 @@ static const char *getDottyArrowForCC(OperandKind k) {
 
 /// Dump a dotty graph that depicts the module.
 void Module::dumpDAG() {
-  std::string filename = "dotty_network_dump_" + std::to_string(this) + ".dot";
+  std::string filename = "dotty_ir_dump_" + std::to_string(this) + ".dot";
   std::cout << "Writing dotty graph to: " << filename << '\n';
 
   std::string sb;