GraphWriter.h revision dc05fffe2bbbdecf2e0dc0bb691b8967777edc9a
195b923d548ed2e0f0993bb613868c871646f120cChris Lattner//===-- Support/GraphWriter.h - Write a graph to a .dot file ---*- C++ -*--===// 295b923d548ed2e0f0993bb613868c871646f120cChris Lattner// 395b923d548ed2e0f0993bb613868c871646f120cChris Lattner// This file defines a simple interface that can be used to print out generic 495b923d548ed2e0f0993bb613868c871646f120cChris Lattner// LLVM graphs to ".dot" files. "dot" is a tool that is part of the AT&T 595b923d548ed2e0f0993bb613868c871646f120cChris Lattner// graphviz package (http://www.research.att.com/sw/tools/graphviz/) which can 695b923d548ed2e0f0993bb613868c871646f120cChris Lattner// be used to turn the files output by this interface into a variety of 795b923d548ed2e0f0993bb613868c871646f120cChris Lattner// different graphics formats. 895b923d548ed2e0f0993bb613868c871646f120cChris Lattner// 995b923d548ed2e0f0993bb613868c871646f120cChris Lattner// Graphs do not need to implement any interface past what is already required 1095b923d548ed2e0f0993bb613868c871646f120cChris Lattner// by the GraphTraits template, but they can choose to implement specializations 1195b923d548ed2e0f0993bb613868c871646f120cChris Lattner// of the DOTGraphTraits template if they want to customize the graphs output in 1295b923d548ed2e0f0993bb613868c871646f120cChris Lattner// any way. 1395b923d548ed2e0f0993bb613868c871646f120cChris Lattner// 1495b923d548ed2e0f0993bb613868c871646f120cChris Lattner//===----------------------------------------------------------------------===// 1595b923d548ed2e0f0993bb613868c871646f120cChris Lattner 1695b923d548ed2e0f0993bb613868c871646f120cChris Lattner#ifndef SUPPORT_GRAPHWRITER_H 1795b923d548ed2e0f0993bb613868c871646f120cChris Lattner#define SUPPORT_GRAPHWRITER_H 1895b923d548ed2e0f0993bb613868c871646f120cChris Lattner 1995b923d548ed2e0f0993bb613868c871646f120cChris Lattner#include "Support/DOTGraphTraits.h" 20f6516da9b3b39ccdf0efe8f999ecbae31d2497beChris Lattner#include "Support/GraphTraits.h" 2195b923d548ed2e0f0993bb613868c871646f120cChris Lattner#include <ostream> 2295b923d548ed2e0f0993bb613868c871646f120cChris Lattner 2395b923d548ed2e0f0993bb613868c871646f120cChris Lattnernamespace DOT { // Private functions... 2495b923d548ed2e0f0993bb613868c871646f120cChris Lattner inline std::string EscapeString(const std::string &Label) { 2595b923d548ed2e0f0993bb613868c871646f120cChris Lattner std::string Str(Label); 2695b923d548ed2e0f0993bb613868c871646f120cChris Lattner for (unsigned i = 0; i != Str.length(); ++i) 2795b923d548ed2e0f0993bb613868c871646f120cChris Lattner switch (Str[i]) { 2895b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '\n': 2995b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str.insert(Str.begin()+i, '\\'); // Escape character... 3095b923d548ed2e0f0993bb613868c871646f120cChris Lattner ++i; 3195b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str[i] = 'n'; 3295b923d548ed2e0f0993bb613868c871646f120cChris Lattner break; 3395b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '\t': 3495b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str.insert(Str.begin()+i, ' '); // Convert to two spaces 3595b923d548ed2e0f0993bb613868c871646f120cChris Lattner ++i; 3695b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str[i] = ' '; 3795b923d548ed2e0f0993bb613868c871646f120cChris Lattner break; 3895b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '\\': 3995b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (i+1 != Str.length() && Str[i+1] == 'l') 4095b923d548ed2e0f0993bb613868c871646f120cChris Lattner break; // don't disturb \l 4195b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '{': case '}': 4295b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '<': case '>': 4395b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str.insert(Str.begin()+i, '\\'); // Escape character... 4495b923d548ed2e0f0993bb613868c871646f120cChris Lattner ++i; // don't infinite loop 4595b923d548ed2e0f0993bb613868c871646f120cChris Lattner break; 4695b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 4795b923d548ed2e0f0993bb613868c871646f120cChris Lattner return Str; 4895b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 4995b923d548ed2e0f0993bb613868c871646f120cChris Lattner} 5095b923d548ed2e0f0993bb613868c871646f120cChris Lattner 5195b923d548ed2e0f0993bb613868c871646f120cChris Lattnertemplate<typename GraphType> 528c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnerclass GraphWriter { 538c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner std::ostream &O; 548c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner const GraphType &G; 5595b923d548ed2e0f0993bb613868c871646f120cChris Lattner 568c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef DOTGraphTraits<GraphType> DOTTraits; 578c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef GraphTraits<GraphType> GTraits; 588c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef typename GTraits::NodeType NodeType; 598c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef typename GTraits::nodes_iterator node_iterator; 608c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef typename GTraits::ChildIteratorType child_iterator; 618c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnerpublic: 62dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {} 63dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 64dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner void writeHeader(const std::string &Name) { 658c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (Name.empty()) 668c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "digraph foo {\n"; // Graph name doesn't matter 678c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner else 688c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "digraph " << Name << " {\n"; 6995b923d548ed2e0f0993bb613868c871646f120cChris Lattner 708c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner std::string GraphName = DOTTraits::getGraphName(G); 718c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (!GraphName.empty()) 728c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n"; 738c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << DOTTraits::getGraphProperties(G); 748c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "\n"; 758c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 768c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 77dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner void writeFooter() { 788c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Finish off the graph 798c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "}\n"; 808c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 8195b923d548ed2e0f0993bb613868c871646f120cChris Lattner 828c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner void writeNodes() { 838c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Loop over the graph, printing it out... 848c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G); 858c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner I != E; ++I) 868c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner writeNode(&*I); 878c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 888c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 898c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner void writeNode(NodeType *Node) { 908c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner std::string NodeAttributes = DOTTraits::getNodeAttributes(Node); 918c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 9263a32de77680dd705d3f2788ea60021ecd4ad51eChris Lattner O << "\tNode" << (void*)Node << " [shape=record,"; 9395b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (!NodeAttributes.empty()) O << NodeAttributes << ","; 9463a32de77680dd705d3f2788ea60021ecd4ad51eChris Lattner O << "label=\"{" 9595b923d548ed2e0f0993bb613868c871646f120cChris Lattner << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G)); 9695b923d548ed2e0f0993bb613868c871646f120cChris Lattner 9795b923d548ed2e0f0993bb613868c871646f120cChris Lattner // Print out the fields of the current node... 988c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner child_iterator EI = GTraits::child_begin(Node); 998c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner child_iterator EE = GTraits::child_end(Node); 10095b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (EI != EE) { 10195b923d548ed2e0f0993bb613868c871646f120cChris Lattner O << "|{"; 1028c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 10395b923d548ed2e0f0993bb613868c871646f120cChris Lattner for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) { 10495b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (i) O << "|"; 10595b923d548ed2e0f0993bb613868c871646f120cChris Lattner O << "<g" << i << ">" << DOTTraits::getEdgeSourceLabel(Node, EI); 10695b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 1078c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 10895b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (EI != EE) 10995b923d548ed2e0f0993bb613868c871646f120cChris Lattner O << "|truncated..."; 11095b923d548ed2e0f0993bb613868c871646f120cChris Lattner O << "}"; 11195b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 11295b923d548ed2e0f0993bb613868c871646f120cChris Lattner O << "}\"];\n"; // Finish printing the "node" line 1138c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 11495b923d548ed2e0f0993bb613868c871646f120cChris Lattner // Output all of the edges now 11595b923d548ed2e0f0993bb613868c871646f120cChris Lattner EI = GTraits::child_begin(Node); 1168c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) 1178c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner writeEdge(Node, i, EI); 1188c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 1198c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 1208c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) { 1218c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (NodeType *TargetNode = *EI) { 12296f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner int DestPort = -1; 1238c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) { 1248c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI); 1258c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 1268c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Figure out which edge this targets... 1278c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner unsigned Offset = std::distance(GTraits::child_begin(TargetNode), 1288c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner TargetIt); 1298c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (Offset > 64) Offset = 64; // Targetting the truncated part? 13096f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner DestPort = (int)Offset; 13195b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 13296f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 13396f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner emitEdge((void *)Node, edgeidx, (void*)TargetNode, DestPort, 13496f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner DOTTraits::getEdgeAttributes(Node, EI)); 13595b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 13695b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 13796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 13896f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner /// emitSimpleNode - Outputs a simple (non-record) node 1397be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner void emitSimpleNode(const void *ID, const std::string &Attr, 1407be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner const std::string &Label, unsigned NumEdgeSources = 0) { 14196f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << "\tNode" << ID << "[ "; 14296f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (!Attr.empty()) 14396f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << Attr << ","; 1447be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner O << " label =\"{" << DOT::EscapeString(Label); 1457be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner if (NumEdgeSources) { 1467be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner O << "|{"; 1477be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner 1487be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner for (unsigned i = 0; i != NumEdgeSources; ++i) { 1497be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner if (i) O << "|"; 1507be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner O << "<g" << i << ">"; 1517be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner } 1527be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner O << "}"; 1537be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner } 1547be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner O << "}\"];\n"; 15596f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner } 15696f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 15796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner /// emitEdge - Output an edge from a simple node into the graph... 1587be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner void emitEdge(const void *SrcNodeID, int SrcNodePort, 1597be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner const void *DestNodeID, int DestNodePort, 1607be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner const std::string &Attrs) { 16196f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << "\tNode" << SrcNodeID; 16296f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (SrcNodePort >= 0) 16396f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << ":g" << SrcNodePort; 16496f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << " -> Node" << (void*)DestNodeID; 16596f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (DestNodePort >= 0) 16696f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << ":g" << DestNodePort; 16796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 16896f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (!Attrs.empty()) 16996f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << "[" << Attrs << "]"; 17096f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << ";\n"; 17196f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner } 1728c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner}; 17395b923d548ed2e0f0993bb613868c871646f120cChris Lattner 1748c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnertemplate<typename GraphType> 1758c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnerstd::ostream &WriteGraph(std::ostream &O, const GraphType &G, 1768c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner const std::string &Name = "") { 1778c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Start the graph emission process... 178dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner GraphWriter<GraphType> W(O, G); 179dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 180dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner // Output the header for the graph... 181dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner W.writeHeader(Name); 182dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 183dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner // Emit all of the nodes in the graph... 184dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner W.writeNodes(); 185dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 186dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner // Output any customizations on the graph 187dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W); 188dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 189dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner // Output the end of the graph 190dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner W.writeFooter(); 19195b923d548ed2e0f0993bb613868c871646f120cChris Lattner return O; 19295b923d548ed2e0f0993bb613868c871646f120cChris Lattner} 19395b923d548ed2e0f0993bb613868c871646f120cChris Lattner 19495b923d548ed2e0f0993bb613868c871646f120cChris Lattner#endif 195