1551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer//===-- llvm/Support/GraphWriter.h - Write graph to a .dot file -*- C++ -*-===// 263b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman// 3b2109ce97881269a610fa4afbcbca350e975174dJohn Criswell// The LLVM Compiler Infrastructure 4b2109ce97881269a610fa4afbcbca350e975174dJohn Criswell// 57ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// This file is distributed under the University of Illinois Open Source 67ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// License. See LICENSE.TXT for details. 763b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman// 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" 27103289e9383ad1eb66caf28c9b166aebce963a35Chris Lattner#include "llvm/Support/raw_ostream.h" 28551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/ADT/GraphTraits.h" 291f6efa3996dd1929fbc129203ce5009b620e6969Michael J. Spencer#include "llvm/Support/Path.h" 3052883e7a9a637c0d6dea091917090a8ac63e7736Bill Wendling#include <vector> 31229509a8bc2390c4c9c1bd20f777acf29911d452David Greene#include <cassert> 3295b923d548ed2e0f0993bb613868c871646f120cChris Lattner 33d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 34d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 3595b923d548ed2e0f0993bb613868c871646f120cChris Lattnernamespace DOT { // Private functions... 36103289e9383ad1eb66caf28c9b166aebce963a35Chris Lattner std::string EscapeString(const std::string &Label); 3795b923d548ed2e0f0993bb613868c871646f120cChris Lattner} 3895b923d548ed2e0f0993bb613868c871646f120cChris Lattner 3900ad26ff5760ff2d1b24acb18718e63541088923David Greenenamespace GraphProgram { 4000ad26ff5760ff2d1b24acb18718e63541088923David Greene enum Name { 4100ad26ff5760ff2d1b24acb18718e63541088923David Greene DOT, 4200ad26ff5760ff2d1b24acb18718e63541088923David Greene FDP, 4300ad26ff5760ff2d1b24acb18718e63541088923David Greene NEATO, 4400ad26ff5760ff2d1b24acb18718e63541088923David Greene TWOPI, 4500ad26ff5760ff2d1b24acb18718e63541088923David Greene CIRCO 4600ad26ff5760ff2d1b24acb18718e63541088923David Greene }; 4700ad26ff5760ff2d1b24acb18718e63541088923David Greene} 4865b660743ccce5393f70d3667ac4e2b0b76e5236Daniel Dunbar 4900ad26ff5760ff2d1b24acb18718e63541088923David Greenevoid DisplayGraph(const sys::Path& Filename, bool wait=true, GraphProgram::Name program = GraphProgram::DOT); 50fe2cce63aa26d0916fa7be32c6bf7fa8fb059ee7Misha Brukman 5195b923d548ed2e0f0993bb613868c871646f120cChris Lattnertemplate<typename GraphType> 528c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnerclass GraphWriter { 53103289e9383ad1eb66caf28c9b166aebce963a35Chris Lattner raw_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; 61a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser DOTTraits DTraits; 62c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 63c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser // Writes the edge labels of the node to O and returns true if there are any 64c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser // edge labels not equal to the empty string "". 65c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser bool getEdgeSourceLabels(raw_ostream &O, NodeType *Node) { 66c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser child_iterator EI = GTraits::child_begin(Node); 67c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser child_iterator EE = GTraits::child_end(Node); 68c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser bool hasEdgeSourceLabels = false; 69c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 70c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) { 71a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser std::string label = DTraits.getEdgeSourceLabel(Node, EI); 72c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 73b0cdabb6c2413dff2a8d68b30ff31fd5920c4b37Dan Gohman if (label.empty()) 74c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser continue; 75c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 76c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser hasEdgeSourceLabels = true; 77c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 78c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser if (i) 79c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser O << "|"; 80c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 817ee42e6a28784dcf6a6fa25c776362044eea6a91Dan Gohman O << "<s" << i << ">" << DOT::EscapeString(label); 82c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser } 83c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 84c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser if (EI != EE && hasEdgeSourceLabels) 85c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser O << "|<s64>truncated..."; 86c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 87c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser return hasEdgeSourceLabels; 88c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser } 89c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 908c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnerpublic: 9156f4ef3232850e29c4635d0923910acce8887bd0Tobias Grosser GraphWriter(raw_ostream &o, const GraphType &g, bool SN) : O(o), G(g) { 92640e74207eb75ebc1f22b3cf1c1c39b32bbf232dDan Gohman DTraits = DOTTraits(SN); 93640e74207eb75ebc1f22b3cf1c1c39b32bbf232dDan Gohman } 94dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 95cce563cf1cdbdcb470a1823f1e917960dde3aad6Dan Gohman void writeGraph(const std::string &Title = "") { 96f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman // Output the header for the graph... 97d73b908f263d538f380e7fbee508d4e9a1a71791Dan Gohman writeHeader(Title); 98f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman 99f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman // Emit all of the nodes in the graph... 100d73b908f263d538f380e7fbee508d4e9a1a71791Dan Gohman writeNodes(); 101f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman 102f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman // Output any customizations on the graph 103d73b908f263d538f380e7fbee508d4e9a1a71791Dan Gohman DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, *this); 104f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman 105f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman // Output the end of the graph 106d73b908f263d538f380e7fbee508d4e9a1a71791Dan Gohman writeFooter(); 107f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman } 108f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman 1094c6809d8e38b9690898700085ebbd913e035c2e2Dan Gohman void writeHeader(const std::string &Title) { 110a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser std::string GraphName = DTraits.getGraphName(G); 111afbd0737e7593f1b79ed5060e506749558e82ab9Dan Gohman 1124c6809d8e38b9690898700085ebbd913e035c2e2Dan Gohman if (!Title.empty()) 1134c6809d8e38b9690898700085ebbd913e035c2e2Dan Gohman O << "digraph \"" << DOT::EscapeString(Title) << "\" {\n"; 114afbd0737e7593f1b79ed5060e506749558e82ab9Dan Gohman else if (!GraphName.empty()) 115358f5ac9721f02eec68145bba012322ebc78d58cDan Gohman O << "digraph \"" << DOT::EscapeString(GraphName) << "\" {\n"; 116afbd0737e7593f1b79ed5060e506749558e82ab9Dan Gohman else 117afbd0737e7593f1b79ed5060e506749558e82ab9Dan Gohman O << "digraph unnamed {\n"; 11895b923d548ed2e0f0993bb613868c871646f120cChris Lattner 119a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (DTraits.renderGraphFromBottomUp()) 12089a1ed58399045d2b2c7b246571945b068f2e5e1Chris Lattner O << "\trankdir=\"BT\";\n"; 12189a1ed58399045d2b2c7b246571945b068f2e5e1Chris Lattner 1224c6809d8e38b9690898700085ebbd913e035c2e2Dan Gohman if (!Title.empty()) 1234c6809d8e38b9690898700085ebbd913e035c2e2Dan Gohman O << "\tlabel=\"" << DOT::EscapeString(Title) << "\";\n"; 1242d3ff5a7aee24024765629d17ebff351ea11c9bbDan Gohman else if (!GraphName.empty()) 1258c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n"; 126a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser O << DTraits.getGraphProperties(G); 1278c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "\n"; 1288c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 1298c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 130dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner void writeFooter() { 1318c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Finish off the graph 1328c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner O << "}\n"; 1338c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 13495b923d548ed2e0f0993bb613868c871646f120cChris Lattner 1358c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner void writeNodes() { 1368c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Loop over the graph, printing it out... 1378c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G); 1388c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner I != E; ++I) 13989938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman if (!isNodeHidden(*I)) 14089938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman writeNode(*I); 14189938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman } 14289938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman 14389938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman bool isNodeHidden(NodeType &Node) { 14489938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman return isNodeHidden(&Node); 14589938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman } 14689938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman 14789938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman bool isNodeHidden(NodeType *const *Node) { 14889938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman return isNodeHidden(*Node); 14989938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman } 15089938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman 15189938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman bool isNodeHidden(NodeType *Node) { 15289938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman return DTraits.isNodeHidden(Node); 15396345186a5fefff5c88195f6f2505232215b258eTed Kremenek } 154fe2cce63aa26d0916fa7be32c6bf7fa8fb059ee7Misha Brukman 15596345186a5fefff5c88195f6f2505232215b258eTed Kremenek void writeNode(NodeType& Node) { 15696345186a5fefff5c88195f6f2505232215b258eTed Kremenek writeNode(&Node); 1578c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 15863b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman 159ce393a609ba1df701cfba9e96749275a16e22adeChris Lattner void writeNode(NodeType *const *Node) { 160ce393a609ba1df701cfba9e96749275a16e22adeChris Lattner writeNode(*Node); 161ce393a609ba1df701cfba9e96749275a16e22adeChris Lattner } 16263b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman 1638c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner void writeNode(NodeType *Node) { 164a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser std::string NodeAttributes = DTraits.getNodeAttributes(Node, G); 16563b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman 1667953f3781077b6feaba3708fb96ef917f8e8fc89Dan Gohman O << "\tNode" << static_cast<const void*>(Node) << " [shape=record,"; 16795b923d548ed2e0f0993bb613868c871646f120cChris Lattner if (!NodeAttributes.empty()) O << NodeAttributes << ","; 16889a1ed58399045d2b2c7b246571945b068f2e5e1Chris Lattner O << "label=\"{"; 16989a1ed58399045d2b2c7b246571945b068f2e5e1Chris Lattner 170a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (!DTraits.renderGraphFromBottomUp()) { 17156f4ef3232850e29c4635d0923910acce8887bd0Tobias Grosser O << DOT::EscapeString(DTraits.getNodeLabel(Node, G)); 17263b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman 173f85a55b09657094a1e3954728c7f4ca5bdb6f56aChris Lattner // If we should include the address of the node in the label, do so now. 174a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (DTraits.hasNodeAddressLabel(Node, G)) 175f85a55b09657094a1e3954728c7f4ca5bdb6f56aChris Lattner O << "|" << (void*)Node; 176f85a55b09657094a1e3954728c7f4ca5bdb6f56aChris Lattner } 177f85a55b09657094a1e3954728c7f4ca5bdb6f56aChris Lattner 178c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser std::string edgeSourceLabels; 179795eb2ae8eacba3d9d9e55353475b94de5d5d94cBenjamin Kramer raw_string_ostream EdgeSourceLabels(edgeSourceLabels); 180c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser bool hasEdgeSourceLabels = getEdgeSourceLabels(EdgeSourceLabels, Node); 181c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 182c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser if (hasEdgeSourceLabels) { 183a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (!DTraits.renderGraphFromBottomUp()) O << "|"; 18463b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman 185c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser O << "{" << EdgeSourceLabels.str() << "}"; 18663b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman 187a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (DTraits.renderGraphFromBottomUp()) O << "|"; 18895b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 189f85a55b09657094a1e3954728c7f4ca5bdb6f56aChris Lattner 190a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (DTraits.renderGraphFromBottomUp()) { 19156f4ef3232850e29c4635d0923910acce8887bd0Tobias Grosser O << DOT::EscapeString(DTraits.getNodeLabel(Node, G)); 19263b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman 193f85a55b09657094a1e3954728c7f4ca5bdb6f56aChris Lattner // If we should include the address of the node in the label, do so now. 194a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (DTraits.hasNodeAddressLabel(Node, G)) 195f85a55b09657094a1e3954728c7f4ca5bdb6f56aChris Lattner O << "|" << (void*)Node; 196f85a55b09657094a1e3954728c7f4ca5bdb6f56aChris Lattner } 197f85a55b09657094a1e3954728c7f4ca5bdb6f56aChris Lattner 198a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (DTraits.hasEdgeDestLabels()) { 199358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman O << "|{"; 200358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman 201a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser unsigned i = 0, e = DTraits.numEdgeDestLabels(Node); 202358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman for (; i != e && i != 64; ++i) { 203358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman if (i) O << "|"; 2045b296e307f71bcaf3d31eff4a04ba5d2016eb628Dan Gohman O << "<d" << i << ">" 2055b296e307f71bcaf3d31eff4a04ba5d2016eb628Dan Gohman << DOT::EscapeString(DTraits.getEdgeDestLabel(Node, i)); 206358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman } 207358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman 208358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman if (i != e) 209358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman O << "|<d64>truncated..."; 210358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman O << "}"; 211358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman } 212358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman 213b78ea801cd762ede7586c6e8ae37f8009100289aJim Laskey O << "}\"];\n"; // Finish printing the "node" line 21463b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman 21595b923d548ed2e0f0993bb613868c871646f120cChris Lattner // Output all of the edges now 216c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser child_iterator EI = GTraits::child_begin(Node); 217c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser child_iterator EE = GTraits::child_end(Node); 2188c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) 21989938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman if (!DTraits.isNodeHidden(*EI)) 22089938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman writeEdge(Node, i, EI); 2216a6dd6f487bfda1fe8fbb4ab7cb0a9fa1fbadbcfChris Lattner for (; EI != EE; ++EI) 22289938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman if (!DTraits.isNodeHidden(*EI)) 22389938ce0ad6a0c13104495e2a00d3cc745e34068Dan Gohman writeEdge(Node, 64, EI); 2248c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner } 2258c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 2268c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) { 2278c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner if (NodeType *TargetNode = *EI) { 22896f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner int DestPort = -1; 229a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (DTraits.edgeTargetsEdgeSource(Node, EI)) { 230a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser child_iterator TargetIt = DTraits.getEdgeTarget(Node, EI); 2318c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner 2328c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Figure out which edge this targets... 23334cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned Offset = 23434cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng (unsigned)std::distance(GTraits::child_begin(TargetNode), TargetIt); 2358b70b78ba489b090d9866e6a4084ab1e8613b527Chris Lattner DestPort = static_cast<int>(Offset); 23695b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 23796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 238b0cdabb6c2413dff2a8d68b30ff31fd5920c4b37Dan Gohman if (DTraits.getEdgeSourceLabel(Node, EI).empty()) 239c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser edgeidx = -1; 240c500566d9fb70472a17f62b4cf1689062c52e095Tobias Grosser 2417953f3781077b6feaba3708fb96ef917f8e8fc89Dan Gohman emitEdge(static_cast<const void*>(Node), edgeidx, 2427953f3781077b6feaba3708fb96ef917f8e8fc89Dan Gohman static_cast<const void*>(TargetNode), DestPort, 243a91f86c49a63f7a37c662c3a9553055bff33a84bTobias Grosser DTraits.getEdgeAttributes(Node, EI, G)); 24495b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 24595b923d548ed2e0f0993bb613868c871646f120cChris Lattner } 24696f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 24796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner /// emitSimpleNode - Outputs a simple (non-record) node 2487be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner void emitSimpleNode(const void *ID, const std::string &Attr, 249a329733f471a51d64dadbc4ac400c7e54d94358bChris Lattner const std::string &Label, unsigned NumEdgeSources = 0, 250a329733f471a51d64dadbc4ac400c7e54d94358bChris Lattner const std::vector<std::string> *EdgeSourceLabels = 0) { 25196f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << "\tNode" << ID << "[ "; 25296f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (!Attr.empty()) 25396f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << Attr << ","; 254137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner O << " label =\""; 255137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner if (NumEdgeSources) O << "{"; 256137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner O << DOT::EscapeString(Label); 2577be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner if (NumEdgeSources) { 2587be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner O << "|{"; 25963b3afa98460ce38a1c48d3c44ef6edfdaf37b77Misha Brukman 2607be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner for (unsigned i = 0; i != NumEdgeSources; ++i) { 2617be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner if (i) O << "|"; 262787b0db33c0aed66e74ec826809f8ff2fa174349Andrew Lenharth O << "<s" << i << ">"; 2635b296e307f71bcaf3d31eff4a04ba5d2016eb628Dan Gohman if (EdgeSourceLabels) O << DOT::EscapeString((*EdgeSourceLabels)[i]); 2647be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner } 265137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner O << "}}"; 2667be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner } 267137d399faea745a9b75315fd1d5c4c1855fd6f4fChris Lattner O << "\"];\n"; 26896f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner } 26996f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 27096f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner /// emitEdge - Output an edge from a simple node into the graph... 2717be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner void emitEdge(const void *SrcNodeID, int SrcNodePort, 2727be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner const void *DestNodeID, int DestNodePort, 2737be17dd23364e7f3bd63f5e765c9381bdb544cd5Chris Lattner const std::string &Attrs) { 274d8d97ce857121b31ce2508f48cb3d2e46f72ec4bChris Lattner if (SrcNodePort > 64) return; // Eminating from truncated part? 2757a2bdde0a0eebcd2125055e0eacaca040f0b766cChris Lattner if (DestNodePort > 64) DestNodePort = 64; // Targeting the truncated part? 276d8d97ce857121b31ce2508f48cb3d2e46f72ec4bChris Lattner 27796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << "\tNode" << SrcNodeID; 27896f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (SrcNodePort >= 0) 279358033102ffaef4d1afb1c0b7e96440906f0b48fDan Gohman O << ":s" << SrcNodePort; 2807953f3781077b6feaba3708fb96ef917f8e8fc89Dan Gohman O << " -> Node" << DestNodeID; 281a10d598602308549d87d2c5d9848f5a72fda2b43Tobias Grosser if (DestNodePort >= 0 && DTraits.hasEdgeDestLabels()) 282ce4edd647bddec0be61df39962f1a697068891f2Tobias Grosser O << ":d" << DestNodePort; 28396f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner 28496f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner if (!Attrs.empty()) 28596f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << "[" << Attrs << "]"; 28696f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner O << ";\n"; 28796f549310013eaf751ff401b5ad3cbe01542e9b1Chris Lattner } 288f96b0063674e6bf72da5429bd49097e33c2325c7Tobias Grosser 289f96b0063674e6bf72da5429bd49097e33c2325c7Tobias Grosser /// getOStream - Get the raw output stream into the graph file. Useful to 290f96b0063674e6bf72da5429bd49097e33c2325c7Tobias Grosser /// write fancy things using addCustomGraphFeatures(). 291f96b0063674e6bf72da5429bd49097e33c2325c7Tobias Grosser raw_ostream &getOStream() { 292f96b0063674e6bf72da5429bd49097e33c2325c7Tobias Grosser return O; 293f96b0063674e6bf72da5429bd49097e33c2325c7Tobias Grosser } 2948c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner}; 29595b923d548ed2e0f0993bb613868c871646f120cChris Lattner 2968c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattnertemplate<typename GraphType> 297103289e9383ad1eb66caf28c9b166aebce963a35Chris Lattnerraw_ostream &WriteGraph(raw_ostream &O, const GraphType &G, 298103289e9383ad1eb66caf28c9b166aebce963a35Chris Lattner bool ShortNames = false, 29925ad1cc32af8d526eb72893a513a486bc28c5106Benjamin Kramer const Twine &Title = "") { 3008c836ce4f86713376b626e30765494f0a4f7e4b3Chris Lattner // Start the graph emission process... 3018cbc94afb71fd2da72d8f1284f7f53e39019fdecOwen Anderson GraphWriter<GraphType> W(O, G, ShortNames); 302dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 303f7e2ca9e161140f658a2ae65ad67e508b703ac8cDan Gohman // Emit the graph. 30425ad1cc32af8d526eb72893a513a486bc28c5106Benjamin Kramer W.writeGraph(Title.str()); 305dc05fffe2bbbdecf2e0dc0bb691b8967777edc9aChris Lattner 30695b923d548ed2e0f0993bb613868c871646f120cChris Lattner return O; 30795b923d548ed2e0f0993bb613868c871646f120cChris Lattner} 30895b923d548ed2e0f0993bb613868c871646f120cChris Lattner 3099d5b532de9bdca37810a59a93a69128441b02c55Reid Spencertemplate<typename GraphType> 31025ad1cc32af8d526eb72893a513a486bc28c5106Benjamin Kramersys::Path WriteGraph(const GraphType &G, const Twine &Name, 31125ad1cc32af8d526eb72893a513a486bc28c5106Benjamin Kramer bool ShortNames = false, const Twine &Title = "") { 3125860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel std::string ErrMsg; 3135860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel sys::Path Filename = sys::Path::GetTemporaryDirectory(&ErrMsg); 3145860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel if (Filename.isEmpty()) { 3155860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel errs() << "Error: " << ErrMsg << "\n"; 3165860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel return Filename; 3175860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel } 31825ad1cc32af8d526eb72893a513a486bc28c5106Benjamin Kramer Filename.appendComponent((Name + ".dot").str()); 3195860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel if (Filename.makeUnique(true,&ErrMsg)) { 3205860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel errs() << "Error: " << ErrMsg << "\n"; 32151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer return sys::Path(); 32251c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 32351c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer 3245860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel errs() << "Writing '" << Filename.str() << "'... "; 3255860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel 3265860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel std::string ErrorInfo; 3275860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel raw_fd_ostream O(Filename.c_str(), ErrorInfo); 3285860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel 3295860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel if (ErrorInfo.empty()) { 3305860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel llvm::WriteGraph(O, G, ShortNames, Title); 3315860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel errs() << " done. \n"; 3325860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel } else { 3335860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel errs() << "error opening file '" << Filename.str() << "' for writing!\n"; 3345860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel Filename.clear(); 3355860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel } 336fe2cce63aa26d0916fa7be32c6bf7fa8fb059ee7Misha Brukman 3375860c6c09e58c3f6d19cee4458320c42a5d17298Devang Patel return Filename; 3389d5b532de9bdca37810a59a93a69128441b02c55Reid Spencer} 339fe2cce63aa26d0916fa7be32c6bf7fa8fb059ee7Misha Brukman 3409d5b532de9bdca37810a59a93a69128441b02c55Reid Spencer/// ViewGraph - Emit a dot graph, run 'dot', run gv on the postscript file, 3419d5b532de9bdca37810a59a93a69128441b02c55Reid Spencer/// then cleanup. For use from the debugger. 3429d5b532de9bdca37810a59a93a69128441b02c55Reid Spencer/// 3439d5b532de9bdca37810a59a93a69128441b02c55Reid Spencertemplate<typename GraphType> 34425ad1cc32af8d526eb72893a513a486bc28c5106Benjamin Kramervoid ViewGraph(const GraphType &G, const Twine &Name, 34525ad1cc32af8d526eb72893a513a486bc28c5106Benjamin Kramer bool ShortNames = false, const Twine &Title = "", 34600ad26ff5760ff2d1b24acb18718e63541088923David Greene GraphProgram::Name Program = GraphProgram::DOT) { 34768e18b30540104f2302f560dd90b405b60084158Mikhail Glushenkov sys::Path Filename = llvm::WriteGraph(G, Name, ShortNames, Title); 3489d5b532de9bdca37810a59a93a69128441b02c55Reid Spencer 34974382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner if (Filename.isEmpty()) 3509d5b532de9bdca37810a59a93a69128441b02c55Reid Spencer return; 351fe2cce63aa26d0916fa7be32c6bf7fa8fb059ee7Misha Brukman 35200ad26ff5760ff2d1b24acb18718e63541088923David Greene DisplayGraph(Filename, true, Program); 3539d5b532de9bdca37810a59a93a69128441b02c55Reid Spencer} 3549d5b532de9bdca37810a59a93a69128441b02c55Reid Spencer 355d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 356d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 35795b923d548ed2e0f0993bb613868c871646f120cChris Lattner#endif 358