GraphWriter.h revision 551ccae044b0ff658fe629dd67edd5ffe75d10e8
1551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer//===-- llvm/Support/GraphWriter.h - Write graph to a .dot file -*- C++ -*-===// 2b2109ce97881269a610fa4afbcbca350e975174dJohn Criswell// 3b2109ce97881269a610fa4afbcbca350e975174dJohn Criswell// The LLVM Compiler Infrastructure 4b2109ce97881269a610fa4afbcbca350e975174dJohn Criswell// 5b2109ce97881269a610fa4afbcbca350e975174dJohn Criswell// This file was developed by the LLVM research group and is distributed under 6b2109ce97881269a610fa4afbcbca350e975174dJohn Criswell// the University of Illinois Open Source License. See LICENSE.TXT for details. 7b2109ce97881269a610fa4afbcbca350e975174dJohn Criswell// 8b2109ce97881269a610fa4afbcbca350e975174dJohn Criswell//===----------------------------------------------------------------------===// 995b923d548ed2e0f0993bb613868c871646f120cChris Lattner// 1095b923d548ed2e0f0993bb613868c871646f120cChris Lattner// This file defines a simple interface that can be used to print out generic 1195b923d548ed2e0f0993bb613868c871646f120cChris Lattner// LLVM graphs to ".dot" files. "dot" is a tool that is part of the AT&T 1295b923d548ed2e0f0993bb613868c871646f120cChris Lattner// graphviz package (http://www.research.att.com/sw/tools/graphviz/) which can 1395b923d548ed2e0f0993bb613868c871646f120cChris Lattner// be used to turn the files output by this interface into a variety of 1495b923d548ed2e0f0993bb613868c871646f120cChris Lattner// different graphics formats. 1595b923d548ed2e0f0993bb613868c871646f120cChris Lattner// 1695b923d548ed2e0f0993bb613868c871646f120cChris Lattner// Graphs do not need to implement any interface past what is already required 1795b923d548ed2e0f0993bb613868c871646f120cChris Lattner// by the GraphTraits template, but they can choose to implement specializations 1895b923d548ed2e0f0993bb613868c871646f120cChris Lattner// of the DOTGraphTraits template if they want to customize the graphs output in 1995b923d548ed2e0f0993bb613868c871646f120cChris Lattner// any way. 2095b923d548ed2e0f0993bb613868c871646f120cChris Lattner// 2195b923d548ed2e0f0993bb613868c871646f120cChris Lattner//===----------------------------------------------------------------------===// 2295b923d548ed2e0f0993bb613868c871646f120cChris Lattner 23551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#ifndef LLVM_SUPPORT_GRAPHWRITER_H 24551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#define LLVM_SUPPORT_GRAPHWRITER_H 2595b923d548ed2e0f0993bb613868c871646f120cChris Lattner 26551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/DOTGraphTraits.h" 27551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/ADT/GraphTraits.h" 28a329733f471a51d64dadbc4ac400c7e54d94358bChris Lattner#include <vector> 29ab77194e2a895bd2862f3a23bcd9d31efb553a54Chris Lattner#include <iostream> 3095b923d548ed2e0f0993bb613868c871646f120cChris Lattner 31d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 32d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 3395b923d548ed2e0f0993bb613868c871646f120cChris Lattnernamespace DOT { // Private functions... 3495b923d548ed2e0f0993bb613868c871646f120cChris Lattner inline std::string EscapeString(const std::string &Label) { 3595b923d548ed2e0f0993bb613868c871646f120cChris Lattner std::string Str(Label); 3695b923d548ed2e0f0993bb613868c871646f120cChris Lattner for (unsigned i = 0; i != Str.length(); ++i) 3795b923d548ed2e0f0993bb613868c871646f120cChris Lattner switch (Str[i]) { 3895b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '\n': 3995b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str.insert(Str.begin()+i, '\\'); // Escape character... 4095b923d548ed2e0f0993bb613868c871646f120cChris Lattner ++i; 4195b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str[i] = 'n'; 4295b923d548ed2e0f0993bb613868c871646f120cChris Lattner break; 4395b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '\t': 4495b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str.insert(Str.begin()+i, ' '); // Convert to two spaces 4595b923d548ed2e0f0993bb613868c871646f120cChris Lattner ++i; 4695b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str[i] = ' '; 4795b923d548ed2e0f0993bb613868c871646f120cChris Lattner break; 4895b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '\\': 4995b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (i+1 != Str.length() && Str[i+1] == 'l') 5095b923d548ed2e0f0993bb613868c871646f120cChris Lattner break; // don't disturb \l 5195b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '{': case '}': 5295b923d548ed2e0f0993bb613868c871646f120cChris Lattner case '<': case '>': 531926f69c53e4581ad10ba2e12eb2bbd21e4c06efChris Lattner case '"': 5495b923d548ed2e0f0993bb613868c871646f120cChris Lattner Str.insert(Str.begin()+i, '\\'); // Escape character... 5595b923d548ed2e0f0993bb613868c871646f120cChris Lattner ++i; // don't infinite loop 5695b923d548ed2e0f0993bb613868c871646f120cChris Lattner break; 5795b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 5895b923d548ed2e0f0993bb613868c871646f120cChris Lattner return Str; 5995b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 6095b923d548ed2e0f0993bb613868c871646f120cChris Lattner} 6195b923d548ed2e0f0993bb613868c871646f120cChris Lattner 6295b923d548ed2e0f0993bb613868c871646f120cChris Lattnertemplate<typename GraphType> 638c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnerclass GraphWriter { 648c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner std::ostream &O; 658c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner const GraphType &G; 6695b923d548ed2e0f0993bb613868c871646f120cChris Lattner 678c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef DOTGraphTraits<GraphType> DOTTraits; 688c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef GraphTraits<GraphType> GTraits; 698c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef typename GTraits::NodeType NodeType; 708c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef typename GTraits::nodes_iterator node_iterator; 718c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner typedef typename GTraits::ChildIteratorType child_iterator; 728c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnerpublic: 73dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {} 74dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 75dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner void writeHeader(const std::string &Name) { 768c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (Name.empty()) 778c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "digraph foo {\n"; // Graph name doesn't matter 788c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner else 798c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "digraph " << Name << " {\n"; 8095b923d548ed2e0f0993bb613868c871646f120cChris Lattner 818c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner std::string GraphName = DOTTraits::getGraphName(G); 828c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (!GraphName.empty()) 838c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n"; 848c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << DOTTraits::getGraphProperties(G); 858c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "\n"; 868c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 878c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 88dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner void writeFooter() { 898c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Finish off the graph 908c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "}\n"; 918c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 9295b923d548ed2e0f0993bb613868c871646f120cChris Lattner 938c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner void writeNodes() { 948c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Loop over the graph, printing it out... 958c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G); 968c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner I != E; ++I) 978c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner writeNode(&*I); 988c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 998c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 1008c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner void writeNode(NodeType *Node) { 1018c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner std::string NodeAttributes = DOTTraits::getNodeAttributes(Node); 1028c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 1038b70b78ba489b090d9866e6a4084ab1e8613b527Chris Lattner O << "\tNode" << reinterpret_cast<const void*>(Node) << " [shape=record,"; 10495b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (!NodeAttributes.empty()) O << NodeAttributes << ","; 10563a32de77680dd705d3f2788ea60021ecd4ad51eChris Lattner O << "label=\"{" 10695b923d548ed2e0f0993bb613868c871646f120cChris Lattner << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G)); 10795b923d548ed2e0f0993bb613868c871646f120cChris Lattner 10895b923d548ed2e0f0993bb613868c871646f120cChris Lattner // Print out the fields of the current node... 1098c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner child_iterator EI = GTraits::child_begin(Node); 1108c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner child_iterator EE = GTraits::child_end(Node); 11195b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (EI != EE) { 11295b923d548ed2e0f0993bb613868c871646f120cChris Lattner O << "|{"; 1138c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 11495b923d548ed2e0f0993bb613868c871646f120cChris Lattner for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) { 11595b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (i) O << "|"; 11695b923d548ed2e0f0993bb613868c871646f120cChris Lattner O << "<g" << i << ">" << DOTTraits::getEdgeSourceLabel(Node, EI); 11795b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 1188c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 11995b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (EI != EE) 1206a6dd6f487bfda1fe8fbb4ab7cb0a9fa1fbadbcfChris Lattner O << "|<g64>truncated..."; 12195b923d548ed2e0f0993bb613868c871646f120cChris Lattner O << "}"; 12295b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 12395b923d548ed2e0f0993bb613868c871646f120cChris Lattner O << "}\"];\n"; // Finish printing the "node" line 1248c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 12595b923d548ed2e0f0993bb613868c871646f120cChris Lattner // Output all of the edges now 12695b923d548ed2e0f0993bb613868c871646f120cChris Lattner EI = GTraits::child_begin(Node); 1278c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) 1288c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner writeEdge(Node, i, EI); 1296a6dd6f487bfda1fe8fbb4ab7cb0a9fa1fbadbcfChris Lattner for (; EI != EE; ++EI) 1306a6dd6f487bfda1fe8fbb4ab7cb0a9fa1fbadbcfChris Lattner writeEdge(Node, 64, EI); 1318c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 1328c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 1338c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) { 1348c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (NodeType *TargetNode = *EI) { 13596f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner int DestPort = -1; 1368c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) { 1378c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI); 1388c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 1398c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Figure out which edge this targets... 1408c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner unsigned Offset = std::distance(GTraits::child_begin(TargetNode), 1418c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner TargetIt); 1428b70b78ba489b090d9866e6a4084ab1e8613b527Chris Lattner DestPort = static_cast<int>(Offset); 14395b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 14496f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 1458b70b78ba489b090d9866e6a4084ab1e8613b527Chris Lattner emitEdge(reinterpret_cast<const void*>(Node), edgeidx, 1468b70b78ba489b090d9866e6a4084ab1e8613b527Chris Lattner reinterpret_cast<const void*>(TargetNode), DestPort, 14796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner DOTTraits::getEdgeAttributes(Node, EI)); 14895b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 14995b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 15096f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 15196f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner /// emitSimpleNode - Outputs a simple (non-record) node 1527be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner void emitSimpleNode(const void *ID, const std::string &Attr, 153a329733f471a51d64dadbc4ac400c7e54d94358bChris Lattner const std::string &Label, unsigned NumEdgeSources = 0, 154a329733f471a51d64dadbc4ac400c7e54d94358bChris Lattner const std::vector<std::string> *EdgeSourceLabels = 0) { 15596f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << "\tNode" << ID << "[ "; 15696f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (!Attr.empty()) 15796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << Attr << ","; 158137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner O << " label =\""; 159137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner if (NumEdgeSources) O << "{"; 160137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner O << DOT::EscapeString(Label); 1617be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner if (NumEdgeSources) { 1627be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner O << "|{"; 1637be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner 1647be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner for (unsigned i = 0; i != NumEdgeSources; ++i) { 1657be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner if (i) O << "|"; 1667be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner O << "<g" << i << ">"; 167a329733f471a51d64dadbc4ac400c7e54d94358bChris Lattner if (EdgeSourceLabels) O << (*EdgeSourceLabels)[i]; 1687be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner } 169137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner O << "}}"; 1707be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner } 171137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner O << "\"];\n"; 17296f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner } 17396f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 17496f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner /// emitEdge - Output an edge from a simple node into the graph... 1757be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner void emitEdge(const void *SrcNodeID, int SrcNodePort, 1767be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner const void *DestNodeID, int DestNodePort, 1777be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner const std::string &Attrs) { 178d8d97ce857121b31ce2508f48cb3d2e46f72ec4bChris Lattner if (SrcNodePort > 64) return; // Eminating from truncated part? 179d8d97ce857121b31ce2508f48cb3d2e46f72ec4bChris Lattner if (DestNodePort > 64) DestNodePort = 64; // Targetting the truncated part? 180d8d97ce857121b31ce2508f48cb3d2e46f72ec4bChris Lattner 18196f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << "\tNode" << SrcNodeID; 18296f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (SrcNodePort >= 0) 18396f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << ":g" << SrcNodePort; 1848b70b78ba489b090d9866e6a4084ab1e8613b527Chris Lattner O << " -> Node" << reinterpret_cast<const void*>(DestNodeID); 18596f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (DestNodePort >= 0) 18696f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << ":g" << DestNodePort; 18796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 18896f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (!Attrs.empty()) 18996f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << "[" << Attrs << "]"; 19096f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << ";\n"; 19196f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner } 1928c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner}; 19395b923d548ed2e0f0993bb613868c871646f120cChris Lattner 1948c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnertemplate<typename GraphType> 1958c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnerstd::ostream &WriteGraph(std::ostream &O, const GraphType &G, 1968c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner const std::string &Name = "") { 1978c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Start the graph emission process... 198dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner GraphWriter<GraphType> W(O, G); 199dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 200dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner // Output the header for the graph... 201dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner W.writeHeader(Name); 202dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 203dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner // Emit all of the nodes in the graph... 204dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner W.writeNodes(); 205dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 206dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner // Output any customizations on the graph 207dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W); 208dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 209dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner // Output the end of the graph 210dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner W.writeFooter(); 21195b923d548ed2e0f0993bb613868c871646f120cChris Lattner return O; 21295b923d548ed2e0f0993bb613868c871646f120cChris Lattner} 21395b923d548ed2e0f0993bb613868c871646f120cChris Lattner 214d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 215d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 21695b923d548ed2e0f0993bb613868c871646f120cChris Lattner#endif 217