include/llvm/Support/GraphWriter.h

   1 //===-- llvm/Support/GraphWriter.h - Write graph to a .dot file -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines a simple interface that can be used to print out generic
  11 // LLVM graphs to ".dot" files.  "dot" is a tool that is part of the AT&T
  12 // graphviz package (http://www.research.att.com/sw/tools/graphviz/) which can
  13 // be used to turn the files output by this interface into a variety of
  14 // different graphics formats.
  15 //
  16 // Graphs do not need to implement any interface past what is already required
  17 // by the GraphTraits template, but they can choose to implement specializations
  18 // of the DOTGraphTraits template if they want to customize the graphs output in
  19 // any way.
  20 //
  21 //===----------------------------------------------------------------------===//
  22
  23 #ifndef LLVM_SUPPORT_GRAPHWRITER_H
  24 #define LLVM_SUPPORT_GRAPHWRITER_H
  25
  26 #include "llvm/Support/DOTGraphTraits.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 #include "llvm/ADT/GraphTraits.h"
  29 #include "llvm/System/Path.h"
  30 #include <vector>
  31 #include <cassert>
  32
  33 namespace llvm {
  34
  35 namespace DOT {  // Private functions...
  36   std::string EscapeString(const std::string &Label);
  37 }
  38
  39 namespace GraphProgram {
  40    enum Name {
  41       DOT,
  42       FDP,
  43       NEATO,
  44       TWOPI,
  45       CIRCO
  46    };
  47 }
  48
  49 void DisplayGraph(const sys::Path& Filename, bool wait=true, GraphProgram::Name program = GraphProgram::DOT);
  50
  51 template<typename GraphType>
  52 class GraphWriter {
  53   raw_ostream &O;
  54   const GraphType &G;
  55
  56   typedef DOTGraphTraits<GraphType>           DOTTraits;
  57   typedef GraphTraits<GraphType>              GTraits;
  58   typedef typename GTraits::NodeType          NodeType;
  59   typedef typename GTraits::nodes_iterator    node_iterator;
  60   typedef typename GTraits::ChildIteratorType child_iterator;
  61   DOTTraits DTraits;
  62
  63   // Writes the edge labels of the node to O and returns true if there are any
  64   // edge labels not equal to the empty string "".
  65   bool getEdgeSourceLabels(raw_ostream &O, NodeType *Node) {
  66     child_iterator EI = GTraits::child_begin(Node);
  67     child_iterator EE = GTraits::child_end(Node);
  68     bool hasEdgeSourceLabels = false;
  69
  70     for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) {
  71       std::string label = DTraits.getEdgeSourceLabel(Node, EI);
  72
  73       if (label == "")
  74         continue;
  75
  76       hasEdgeSourceLabels = true;
  77
  78       if (i)
  79         O << "|";
  80
  81       O << "<s" << i << ">" << DTraits.getEdgeSourceLabel(Node, EI);
  82     }
  83
  84     if (EI != EE && hasEdgeSourceLabels)
  85       O << "|<s64>truncated...";
  86
  87     return hasEdgeSourceLabels;
  88   }
  89
  90 public:
  91   GraphWriter(raw_ostream &o, const GraphType &g, bool SN) : O(o), G(g) {
  92   DTraits = DOTTraits(SN);
  93 }
  94
  95   void writeHeader(const std::string &Name) {
  96     std::string GraphName = DTraits.getGraphName(G);
  97
  98     if (!Name.empty())
  99       O << "digraph \"" << DOT::EscapeString(Name) << "\" {\n";
 100     else if (!GraphName.empty())
 101       O << "digraph \"" << DOT::EscapeString(GraphName) << "\" {\n";
 102     else
 103       O << "digraph unnamed {\n";
 104
 105     if (DTraits.renderGraphFromBottomUp())
 106       O << "\trankdir=\"BT\";\n";
 107
 108     if (!Name.empty())
 109       O << "\tlabel=\"" << DOT::EscapeString(Name) << "\";\n";
 110     else if (!GraphName.empty())
 111       O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
 112     O << DTraits.getGraphProperties(G);
 113     O << "\n";
 114   }
 115
 116   void writeFooter() {
 117     // Finish off the graph
 118     O << "}\n";
 119   }
 120
 121   void writeNodes() {
 122     // Loop over the graph, printing it out...
 123     for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G);
 124          I != E; ++I)
 125       writeNode(*I);
 126   }
 127
 128   void writeNode(NodeType& Node) {
 129     writeNode(&Node);
 130   }
 131
 132   void writeNode(NodeType *const *Node) {
 133     writeNode(*Node);
 134   }
 135
 136   void writeNode(NodeType *Node) {
 137     std::string NodeAttributes = DTraits.getNodeAttributes(Node, G);
 138
 139     O << "\tNode" << static_cast<const void*>(Node) << " [shape=record,";
 140     if (!NodeAttributes.empty()) O << NodeAttributes << ",";
 141     O << "label=\"{";
 142
 143     if (!DTraits.renderGraphFromBottomUp()) {
 144       O << DOT::EscapeString(DTraits.getNodeLabel(Node, G));
 145
 146       // If we should include the address of the node in the label, do so now.
 147       if (DTraits.hasNodeAddressLabel(Node, G))
 148         O << "|" << (void*)Node;
 149     }
 150
 151     std::string edgeSourceLabels;
 152     raw_string_ostream::raw_string_ostream EdgeSourceLabels(edgeSourceLabels);
 153     bool hasEdgeSourceLabels = getEdgeSourceLabels(EdgeSourceLabels, Node);
 154
 155     if (hasEdgeSourceLabels) {
 156       if (!DTraits.renderGraphFromBottomUp()) O << "|";
 157
 158       O << "{" << EdgeSourceLabels.str() << "}";
 159
 160       if (DTraits.renderGraphFromBottomUp()) O << "|";
 161     }
 162
 163     if (DTraits.renderGraphFromBottomUp()) {
 164       O << DOT::EscapeString(DTraits.getNodeLabel(Node, G));
 165
 166       // If we should include the address of the node in the label, do so now.
 167       if (DTraits.hasNodeAddressLabel(Node, G))
 168         O << "|" << (void*)Node;
 169     }
 170
 171     if (DTraits.hasEdgeDestLabels()) {
 172       O << "|{";
 173
 174       unsigned i = 0, e = DTraits.numEdgeDestLabels(Node);
 175       for (; i != e && i != 64; ++i) {
 176         if (i) O << "|";
 177         O << "<d" << i << ">" << DTraits.getEdgeDestLabel(Node, i);
 178       }
 179
 180       if (i != e)
 181         O << "|<d64>truncated...";
 182       O << "}";
 183     }
 184
 185     O << "}\"];\n";   // Finish printing the "node" line
 186
 187     // Output all of the edges now
 188     child_iterator EI = GTraits::child_begin(Node);
 189     child_iterator EE = GTraits::child_end(Node);
 190     for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
 191       writeEdge(Node, i, EI);
 192     for (; EI != EE; ++EI)
 193       writeEdge(Node, 64, EI);
 194   }
 195
 196   void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) {
 197     if (NodeType *TargetNode = *EI) {
 198       int DestPort = -1;
 199       if (DTraits.edgeTargetsEdgeSource(Node, EI)) {
 200         child_iterator TargetIt = DTraits.getEdgeTarget(Node, EI);
 201
 202         // Figure out which edge this targets...
 203         unsigned Offset =
 204           (unsigned)std::distance(GTraits::child_begin(TargetNode), TargetIt);
 205         DestPort = static_cast<int>(Offset);
 206       }
 207
 208       if (DTraits.getEdgeSourceLabel(Node, EI) == "")
 209         edgeidx = -1;
 210
 211       emitEdge(static_cast<const void*>(Node), edgeidx,
 212                static_cast<const void*>(TargetNode), DestPort,
 213                DTraits.getEdgeAttributes(Node, EI));
 214     }
 215   }
 216
 217   /// emitSimpleNode - Outputs a simple (non-record) node
 218   void emitSimpleNode(const void *ID, const std::string &Attr,
 219                       const std::string &Label, unsigned NumEdgeSources = 0,
 220                       const std::vector<std::string> *EdgeSourceLabels = 0) {
 221     O << "\tNode" << ID << "[ ";
 222     if (!Attr.empty())
 223       O << Attr << ",";
 224     O << " label =\"";
 225     if (NumEdgeSources) O << "{";
 226     O << DOT::EscapeString(Label);
 227     if (NumEdgeSources) {
 228       O << "|{";
 229
 230       for (unsigned i = 0; i != NumEdgeSources; ++i) {
 231         if (i) O << "|";
 232         O << "<s" << i << ">";
 233         if (EdgeSourceLabels) O << (*EdgeSourceLabels)[i];
 234       }
 235       O << "}}";
 236     }
 237     O << "\"];\n";
 238   }
 239
 240   /// emitEdge - Output an edge from a simple node into the graph...
 241   void emitEdge(const void *SrcNodeID, int SrcNodePort,
 242                 const void *DestNodeID, int DestNodePort,
 243                 const std::string &Attrs) {
 244     if (SrcNodePort  > 64) return;             // Eminating from truncated part?
 245     if (DestNodePort > 64) DestNodePort = 64;  // Targetting the truncated part?
 246
 247     O << "\tNode" << SrcNodeID;
 248     if (SrcNodePort >= 0)
 249       O << ":s" << SrcNodePort;
 250     O << " -> Node" << DestNodeID;
 251     if (DestNodePort >= 0 && DTraits.hasEdgeDestLabels())
 252       O << ":d" << DestNodePort;
 253
 254     if (!Attrs.empty())
 255       O << "[" << Attrs << "]";
 256     O << ";\n";
 257   }
 258 };
 259
 260 template<typename GraphType>
 261 raw_ostream &WriteGraph(raw_ostream &O, const GraphType &G,
 262                         bool ShortNames = false,
 263                         const std::string &Name = "",
 264                         const std::string &Title = "") {
 265   // Start the graph emission process...
 266   GraphWriter<GraphType> W(O, G, ShortNames);
 267
 268   // Output the header for the graph...
 269   W.writeHeader(Title);
 270
 271   // Emit all of the nodes in the graph...
 272   W.writeNodes();
 273
 274   // Output any customizations on the graph
 275   DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W);
 276
 277   // Output the end of the graph
 278   W.writeFooter();
 279   return O;
 280 }
 281
 282 template<typename GraphType>
 283 sys::Path WriteGraph(const GraphType &G, const std::string &Name,
 284                      bool ShortNames = false, const std::string &Title = "") {
 285   std::string ErrMsg;
 286   sys::Path Filename = sys::Path::GetTemporaryDirectory(&ErrMsg);
 287   if (Filename.isEmpty()) {
 288     errs() << "Error: " << ErrMsg << "\n";
 289     return Filename;
 290   }
 291   Filename.appendComponent(Name + ".dot");
 292   if (Filename.makeUnique(true,&ErrMsg)) {
 293     errs() << "Error: " << ErrMsg << "\n";
 294     return sys::Path();
 295   }
 296
 297   errs() << "Writing '" << Filename.str() << "'... ";
 298
 299   std::string ErrorInfo;
 300   raw_fd_ostream O(Filename.c_str(), ErrorInfo);
 301
 302   if (ErrorInfo.empty()) {
 303     WriteGraph(O, G, ShortNames, Name, Title);
 304     errs() << " done. \n";
 305   } else {
 306     errs() << "error opening file '" << Filename.str() << "' for writing!\n";
 307     Filename.clear();
 308   }
 309
 310   return Filename;
 311 }
 312
 313 /// ViewGraph - Emit a dot graph, run 'dot', run gv on the postscript file,
 314 /// then cleanup.  For use from the debugger.
 315 ///
 316 template<typename GraphType>
 317 void ViewGraph(const GraphType &G, const std::string &Name,
 318                bool ShortNames = false, const std::string &Title = "",
 319                GraphProgram::Name Program = GraphProgram::DOT) {
 320   sys::Path Filename = WriteGraph(G, Name, ShortNames, Title);
 321
 322   if (Filename.isEmpty())
 323     return;
 324
 325   DisplayGraph(Filename, true, Program);
 326 }
 327
 328 } // End llvm namespace
 329
 330 #endif