1 //===-- llvm/Support/GraphWriter.h - Write graph to a .dot file -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
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
21 //===----------------------------------------------------------------------===//
23 #ifndef LLVM_SUPPORT_GRAPHWRITER_H
24 #define LLVM_SUPPORT_GRAPHWRITER_H
26 #include "llvm/Support/DOTGraphTraits.h"
27 #include "llvm/Support/Streams.h"
28 #include "llvm/ADT/GraphTraits.h"
29 #include "llvm/System/Path.h"
35 namespace 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)
41 Str.insert(Str.begin()+i, '\\'); // Escape character...
46 Str.insert(Str.begin()+i, ' '); // Convert to two spaces
51 if (i+1 != Str.length())
53 case 'l': continue; // don't disturb \l
54 case '|': case '{': case '}':
55 Str.erase(Str.begin()+i); continue;
61 Str.insert(Str.begin()+i, '\\'); // Escape character...
62 ++i; // don't infinite loop
69 void DisplayGraph(const sys::Path& Filename);
71 template<typename GraphType>
77 typedef DOTGraphTraits<GraphType> DOTTraits;
78 typedef GraphTraits<GraphType> GTraits;
79 typedef typename GTraits::NodeType NodeType;
80 typedef typename GTraits::nodes_iterator node_iterator;
81 typedef typename GTraits::ChildIteratorType child_iterator;
83 GraphWriter(std::ostream &o, const GraphType &g, bool SN) :
84 O(o), G(g), ShortNames(SN) {}
86 void writeHeader(const std::string &Name) {
87 std::string GraphName = DOTTraits::getGraphName(G);
90 O << "digraph \"" << DOT::EscapeString(Name) << "\" {\n";
91 else if (!GraphName.empty())
92 O << "digraph \"" << DOT::EscapeString(GraphName) << "\" {\n";
94 O << "digraph unnamed {\n";
96 if (DOTTraits::renderGraphFromBottomUp())
97 O << "\trankdir=\"BT\";\n";
100 O << "\tlabel=\"" << DOT::EscapeString(Name) << "\";\n";
101 else if (!GraphName.empty())
102 O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
103 O << DOTTraits::getGraphProperties(G);
108 // Finish off the graph
113 // Loop over the graph, printing it out...
114 for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G);
119 void writeNode(NodeType& Node) {
123 void writeNode(NodeType *const *Node) {
127 void writeNode(NodeType *Node) {
128 std::string NodeAttributes = DOTTraits::getNodeAttributes(Node, G);
130 O << "\tNode" << static_cast<const void*>(Node) << " [shape=record,";
131 if (!NodeAttributes.empty()) O << NodeAttributes << ",";
134 if (!DOTTraits::renderGraphFromBottomUp()) {
135 O << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G, ShortNames));
137 // If we should include the address of the node in the label, do so now.
138 if (DOTTraits::hasNodeAddressLabel(Node, G))
139 O << "|" << (void*)Node;
142 // Print out the fields of the current node...
143 child_iterator EI = GTraits::child_begin(Node);
144 child_iterator EE = GTraits::child_end(Node);
146 if (!DOTTraits::renderGraphFromBottomUp()) O << "|";
149 for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) {
151 O << "<s" << i << ">" << DOTTraits::getEdgeSourceLabel(Node, EI);
155 O << "|<s64>truncated...";
157 if (DOTTraits::renderGraphFromBottomUp()) O << "|";
160 if (DOTTraits::renderGraphFromBottomUp()) {
161 O << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G, ShortNames));
163 // If we should include the address of the node in the label, do so now.
164 if (DOTTraits::hasNodeAddressLabel(Node, G))
165 O << "|" << (void*)Node;
168 if (DOTTraits::hasEdgeDestLabels()) {
171 unsigned i = 0, e = DOTTraits::numEdgeDestLabels(Node);
172 for (; i != e && i != 64; ++i) {
174 O << "<d" << i << ">" << DOTTraits::getEdgeDestLabel(Node, i);
178 O << "|<d64>truncated...";
182 O << "}\"];\n"; // Finish printing the "node" line
184 // Output all of the edges now
185 EI = GTraits::child_begin(Node);
186 for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
187 writeEdge(Node, i, EI);
188 for (; EI != EE; ++EI)
189 writeEdge(Node, 64, EI);
192 void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) {
193 if (NodeType *TargetNode = *EI) {
195 if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) {
196 child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI);
198 // Figure out which edge this targets...
200 (unsigned)std::distance(GTraits::child_begin(TargetNode), TargetIt);
201 DestPort = static_cast<int>(Offset);
204 emitEdge(static_cast<const void*>(Node), edgeidx,
205 static_cast<const void*>(TargetNode), DestPort,
206 DOTTraits::getEdgeAttributes(Node, EI));
210 /// emitSimpleNode - Outputs a simple (non-record) node
211 void emitSimpleNode(const void *ID, const std::string &Attr,
212 const std::string &Label, unsigned NumEdgeSources = 0,
213 const std::vector<std::string> *EdgeSourceLabels = 0) {
214 O << "\tNode" << ID << "[ ";
218 if (NumEdgeSources) O << "{";
219 O << DOT::EscapeString(Label);
220 if (NumEdgeSources) {
223 for (unsigned i = 0; i != NumEdgeSources; ++i) {
225 O << "<g" << i << ">";
226 if (EdgeSourceLabels) O << (*EdgeSourceLabels)[i];
233 /// emitEdge - Output an edge from a simple node into the graph...
234 void emitEdge(const void *SrcNodeID, int SrcNodePort,
235 const void *DestNodeID, int DestNodePort,
236 const std::string &Attrs) {
237 if (SrcNodePort > 64) return; // Eminating from truncated part?
238 if (DestNodePort > 64) DestNodePort = 64; // Targetting the truncated part?
240 O << "\tNode" << SrcNodeID;
241 if (SrcNodePort >= 0)
242 O << ":s" << SrcNodePort;
243 O << " -> Node" << DestNodeID;
244 if (DestNodePort >= 0)
245 O << ":d" << DestNodePort;
248 O << "[" << Attrs << "]";
253 template<typename GraphType>
254 std::ostream &WriteGraph(std::ostream &O, const GraphType &G,
255 bool ShortNames = false,
256 const std::string &Name = "",
257 const std::string &Title = "") {
258 // Start the graph emission process...
259 GraphWriter<GraphType> W(O, G, ShortNames);
261 // Output the header for the graph...
262 W.writeHeader(Title);
264 // Emit all of the nodes in the graph...
267 // Output any customizations on the graph
268 DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W);
270 // Output the end of the graph
275 template<typename GraphType>
276 sys::Path WriteGraph(const GraphType &G,
277 const std::string& Name,
278 bool ShortNames = false,
279 const std::string& Title = "") {
281 sys::Path Filename = sys::Path::GetTemporaryDirectory(&ErrMsg);
282 if (Filename.isEmpty()) {
283 cerr << "Error: " << ErrMsg << "\n";
286 Filename.appendComponent(Name + ".dot");
287 if (Filename.makeUnique(true,&ErrMsg)) {
288 cerr << "Error: " << ErrMsg << "\n";
292 cerr << "Writing '" << Filename << "'... ";
294 std::ofstream O(Filename.c_str());
297 WriteGraph(O, G, ShortNames, Name, Title);
302 cerr << "error opening file for writing!\n";
309 /// ViewGraph - Emit a dot graph, run 'dot', run gv on the postscript file,
310 /// then cleanup. For use from the debugger.
312 template<typename GraphType>
313 void ViewGraph(const GraphType& G,
314 const std::string& Name,
315 bool ShortNames = false,
316 const std::string& Title = "") {
317 sys::Path Filename = WriteGraph(G, Name, ShortNames, Title);
319 if (Filename.isEmpty()) {
323 DisplayGraph(Filename);
326 } // End llvm namespace