GraphWriter.h revision fe2cce63aa26d0916fa7be32c6bf7fa8fb059ee7 
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/Streams.h"
28#include "llvm/ADT/GraphTraits.h"
29#include "llvm/System/Path.h"
30#include <fstream>
31#include <vector>
32
33namespace llvm {
34
35namespace DOT {  // Private functions...
36  inline std::string EscapeString(const std::string &Label) {
37    std::string Str(Label);
38    for (unsigned i = 0; i != Str.length(); ++i)
39      switch (Str[i]) {
40      case '\n':
41        Str.insert(Str.begin()+i, '\\');  // Escape character...
42        ++i;
43        Str[i] = 'n';
44        break;
45      case '\t':
46        Str.insert(Str.begin()+i, ' ');  // Convert to two spaces
47        ++i;
48        Str[i] = ' ';
49        break;
50      case '\\':
51        if (i+1 != Str.length())
52          switch (Str[i+1]) {
53            case 'l': continue; // don't disturb \l
54            case '|': case '{': case '}':
55               Str.erase(Str.begin()+i); continue;
56            default: break;
57          }
58      case '{': case '}':
59      case '<': case '>':
60      case '|': case '"':
61        Str.insert(Str.begin()+i, '\\');  // Escape character...
62        ++i;  // don't infinite loop
63        break;
64      }
65    return Str;
66  }
67}
68
69void DisplayGraph(const sys::Path& Filename);
70
71template<typename GraphType>
72class GraphWriter {
73  std::ostream &O;
74  const GraphType &G;
75
76  typedef DOTGraphTraits<GraphType>           DOTTraits;
77  typedef GraphTraits<GraphType>              GTraits;
78  typedef typename GTraits::NodeType          NodeType;
79  typedef typename GTraits::nodes_iterator    node_iterator;
80  typedef typename GTraits::ChildIteratorType child_iterator;
81public:
82  GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {}
83
84  void writeHeader(const std::string &Name) {
85    std::string GraphName = DOTTraits::getGraphName(G);
86
87    if (!Name.empty())
88      O << "digraph \"" << DOT::EscapeString(Name) << "\" {\n";
89    else if (!GraphName.empty())
90      O << "digraph \"" << DOT::EscapeString(GraphName) << "\" {\n";
91    else
92      O << "digraph unnamed {\n";
93
94    if (DOTTraits::renderGraphFromBottomUp())
95      O << "\trankdir=\"BT\";\n";
96
97    if (!Name.empty())
98      O << "\tlabel=\"" << DOT::EscapeString(Name) << "\";\n";
99    else if (!GraphName.empty())
100      O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
101    O << DOTTraits::getGraphProperties(G);
102    O << "\n";
103  }
104
105  void writeFooter() {
106    // Finish off the graph
107    O << "}\n";
108  }
109
110  void writeNodes() {
111    // Loop over the graph, printing it out...
112    for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G);
113         I != E; ++I)
114      writeNode(*I);
115  }
116
117  void writeNode(NodeType& Node) {
118    writeNode(&Node);
119  }
120
121  void writeNode(NodeType *const *Node) {
122    writeNode(*Node);
123  }
124
125  void writeNode(NodeType *Node) {
126    std::string NodeAttributes = DOTTraits::getNodeAttributes(Node, G);
127
128    O << "\tNode" << static_cast<const void*>(Node) << " [shape=record,";
129    if (!NodeAttributes.empty()) O << NodeAttributes << ",";
130    O << "label=\"{";
131
132    if (!DOTTraits::renderGraphFromBottomUp()) {
133      O << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
134
135      // If we should include the address of the node in the label, do so now.
136      if (DOTTraits::hasNodeAddressLabel(Node, G))
137        O << "|" << (void*)Node;
138    }
139
140    // Print out the fields of the current node...
141    child_iterator EI = GTraits::child_begin(Node);
142    child_iterator EE = GTraits::child_end(Node);
143    if (EI != EE) {
144      if (!DOTTraits::renderGraphFromBottomUp()) O << "|";
145      O << "{";
146
147      for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) {
148        if (i) O << "|";
149        O << "<s" << i << ">" << DOTTraits::getEdgeSourceLabel(Node, EI);
150      }
151
152      if (EI != EE)
153        O << "|<s64>truncated...";
154      O << "}";
155      if (DOTTraits::renderGraphFromBottomUp()) O << "|";
156    }
157
158    if (DOTTraits::renderGraphFromBottomUp()) {
159      O << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
160
161      // If we should include the address of the node in the label, do so now.
162      if (DOTTraits::hasNodeAddressLabel(Node, G))
163        O << "|" << (void*)Node;
164    }
165
166    if (DOTTraits::hasEdgeDestLabels()) {
167      O << "|{";
168
169      unsigned i = 0, e = DOTTraits::numEdgeDestLabels(Node);
170      for (; i != e && i != 64; ++i) {
171        if (i) O << "|";
172        O << "<d" << i << ">" << DOTTraits::getEdgeDestLabel(Node, i);
173      }
174
175      if (i != e)
176        O << "|<d64>truncated...";
177      O << "}";
178    }
179
180    O << "}\"];\n";   // Finish printing the "node" line
181
182    // Output all of the edges now
183    EI = GTraits::child_begin(Node);
184    for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
185      writeEdge(Node, i, EI);
186    for (; EI != EE; ++EI)
187      writeEdge(Node, 64, EI);
188  }
189
190  void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) {
191    if (NodeType *TargetNode = *EI) {
192      int DestPort = -1;
193      if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) {
194        child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI);
195
196        // Figure out which edge this targets...
197        unsigned Offset =
198          (unsigned)std::distance(GTraits::child_begin(TargetNode), TargetIt);
199        DestPort = static_cast<int>(Offset);
200      }
201
202      emitEdge(static_cast<const void*>(Node), edgeidx,
203               static_cast<const void*>(TargetNode), DestPort,
204               DOTTraits::getEdgeAttributes(Node, EI));
205    }
206  }
207
208  /// emitSimpleNode - Outputs a simple (non-record) node
209  void emitSimpleNode(const void *ID, const std::string &Attr,
210                      const std::string &Label, unsigned NumEdgeSources = 0,
211                      const std::vector<std::string> *EdgeSourceLabels = 0) {
212    O << "\tNode" << ID << "[ ";
213    if (!Attr.empty())
214      O << Attr << ",";
215    O << " label =\"";
216    if (NumEdgeSources) O << "{";
217    O << DOT::EscapeString(Label);
218    if (NumEdgeSources) {
219      O << "|{";
220
221      for (unsigned i = 0; i != NumEdgeSources; ++i) {
222        if (i) O << "|";
223        O << "<g" << i << ">";
224        if (EdgeSourceLabels) O << (*EdgeSourceLabels)[i];
225      }
226      O << "}}";
227    }
228    O << "\"];\n";
229  }
230
231  /// emitEdge - Output an edge from a simple node into the graph...
232  void emitEdge(const void *SrcNodeID, int SrcNodePort,
233                const void *DestNodeID, int DestNodePort,
234                const std::string &Attrs) {
235    if (SrcNodePort  > 64) return;             // Eminating from truncated part?
236    if (DestNodePort > 64) DestNodePort = 64;  // Targetting the truncated part?
237
238    O << "\tNode" << SrcNodeID;
239    if (SrcNodePort >= 0)
240      O << ":s" << SrcNodePort;
241    O << " -> Node" << DestNodeID;
242    if (DestNodePort >= 0)
243      O << ":d" << DestNodePort;
244
245    if (!Attrs.empty())
246      O << "[" << Attrs << "]";
247    O << ";\n";
248  }
249};
250
251template<typename GraphType>
252std::ostream &WriteGraph(std::ostream &O, const GraphType &G,
253                         const std::string &Name = "",
254                         const std::string &Title = "") {
255  // Start the graph emission process...
256  GraphWriter<GraphType> W(O, G);
257
258  // Output the header for the graph...
259  W.writeHeader(Title);
260
261  // Emit all of the nodes in the graph...
262  W.writeNodes();
263
264  // Output any customizations on the graph
265  DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W);
266
267  // Output the end of the graph
268  W.writeFooter();
269  return O;
270}
271
272template<typename GraphType>
273sys::Path WriteGraph(const GraphType &G,
274                     const std::string& Name,
275                     const std::string& Title = "") {
276  std::string ErrMsg;
277  sys::Path Filename = sys::Path::GetTemporaryDirectory(&ErrMsg);
278  if (Filename.isEmpty()) {
279    cerr << "Error: " << ErrMsg << "\n";
280    return Filename;
281  }
282  Filename.appendComponent(Name + ".dot");
283  if (Filename.makeUnique(true,&ErrMsg)) {
284    cerr << "Error: " << ErrMsg << "\n";
285    return sys::Path();
286  }
287
288  cerr << "Writing '" << Filename << "'... ";
289
290  std::ofstream O(Filename.c_str());
291
292  if (O.good()) {
293    WriteGraph(O, G, Name, Title);
294    cerr << " done. \n";
295
296    O.close();
297  } else {
298    cerr << "error opening file for writing!\n";
299    Filename.clear();
300  }
301
302  return Filename;
303}
304
305/// ViewGraph - Emit a dot graph, run 'dot', run gv on the postscript file,
306/// then cleanup.  For use from the debugger.
307///
308template<typename GraphType>
309void ViewGraph(const GraphType& G,
310               const std::string& Name,
311               const std::string& Title = "") {
312  sys::Path Filename =  WriteGraph(G, Name, Title);
313
314  if (Filename.isEmpty()) {
315    return;
316  }
317
318  DisplayGraph(Filename);
319}
320
321} // End llvm namespace
322
323#endif
324