X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FSupport%2FGraphWriter.h;h=85cf71805fd69fa8e905dff2bc9d7df56e47e046;hb=80a75bfae980df96f969f1c05b0c4a80ce975240;hp=7783b4680876fb57055ef77f802d57506125cdf2;hpb=834a9d12f3575f0030f39117546f01fc7e0ff300;p=oota-llvm.git diff --git a/include/llvm/Support/GraphWriter.h b/include/llvm/Support/GraphWriter.h index 7783b468087..85cf71805fd 100644 --- a/include/llvm/Support/GraphWriter.h +++ b/include/llvm/Support/GraphWriter.h @@ -1,4 +1,11 @@ -//===-- Support/GraphWriter.h - Write a graph to a .dot file ---*- C++ -*--===// +//===-- llvm/Support/GraphWriter.h - Write graph to a .dot file -*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file was developed by the LLVM research group and is distributed under +// the University of Illinois Open Source License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// // // This file defines a simple interface that can be used to print out generic // LLVM graphs to ".dot" files. "dot" is a tool that is part of the AT&T @@ -13,12 +20,17 @@ // //===----------------------------------------------------------------------===// -#ifndef SUPPORT_GRAPHWRITER_H -#define SUPPORT_GRAPHWRITER_H +#ifndef LLVM_SUPPORT_GRAPHWRITER_H +#define LLVM_SUPPORT_GRAPHWRITER_H + +#include "llvm/Support/Debug.h" +#include "llvm/Support/DOTGraphTraits.h" +#include "llvm/ADT/GraphTraits.h" +#include "llvm/System/Path.h" +#include +#include -#include "Support/DOTGraphTraits.h" -#include "Support/GraphTraits.h" -#include +namespace llvm { namespace DOT { // Private functions... inline std::string EscapeString(const std::string &Label) { @@ -40,6 +52,7 @@ namespace DOT { // Private functions... break; // don't disturb \l case '{': case '}': case '<': case '>': + case '|': case '"': Str.insert(Str.begin()+i, '\\'); // Escape character... ++i; // don't infinite loop break; @@ -48,6 +61,8 @@ namespace DOT { // Private functions... } } +void DisplayGraph(const sys::Path& Filename); + template class GraphWriter { std::ostream &O; @@ -59,27 +74,25 @@ class GraphWriter { typedef typename GTraits::nodes_iterator node_iterator; typedef typename GTraits::ChildIteratorType child_iterator; public: - GraphWriter(std::ostream &o, const GraphType &g, - const std::string &Name) : O(o), G(g) { + GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {} + + void writeHeader(const std::string &Name) { if (Name.empty()) O << "digraph foo {\n"; // Graph name doesn't matter else O << "digraph " << Name << " {\n"; + if (DOTTraits::renderGraphFromBottomUp()) + O << "\trankdir=\"BT\";\n"; + std::string GraphName = DOTTraits::getGraphName(G); if (!GraphName.empty()) O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n"; O << DOTTraits::getGraphProperties(G); O << "\n"; - - // Emit all of the nodes in the graph... - writeNodes(); - - // Output any customizations on the graph - DOTTraits::addCustomGraphFeatures(G, *this); } - ~GraphWriter() { + void writeFooter() { // Finish off the graph O << "}\n"; } @@ -88,59 +101,126 @@ public: // Loop over the graph, printing it out... for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G); I != E; ++I) - writeNode(&*I); + writeNode(*I); + } + + void writeNode(NodeType& Node) { + writeNode(&Node); + } + + void writeNode(NodeType *const *Node) { + writeNode(*Node); } void writeNode(NodeType *Node) { - std::string NodeAttributes = DOTTraits::getNodeAttributes(Node); - - O << "\tNode" << (void*)Node << " [shape=record,"; + std::string NodeAttributes = DOTTraits::getNodeAttributes(Node, G); + + O << "\tNode" << reinterpret_cast(Node) << " [shape=record,"; if (!NodeAttributes.empty()) O << NodeAttributes << ","; - O << "label=\"{" - << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G)); - + O << "label=\"{"; + + if (!DOTTraits::renderGraphFromBottomUp()) { + O << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G)); + + // If we should include the address of the node in the label, do so now. + if (DOTTraits::hasNodeAddressLabel(Node, G)) + O << "|" << (void*)Node; + } + // Print out the fields of the current node... child_iterator EI = GTraits::child_begin(Node); child_iterator EE = GTraits::child_end(Node); if (EI != EE) { - O << "|{"; - + if (!DOTTraits::renderGraphFromBottomUp()) O << "|"; + O << "{"; + for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) { if (i) O << "|"; O << "" << DOTTraits::getEdgeSourceLabel(Node, EI); } - + if (EI != EE) - O << "|truncated..."; + O << "|truncated..."; O << "}"; + if (DOTTraits::renderGraphFromBottomUp()) O << "|"; + } + + if (DOTTraits::renderGraphFromBottomUp()) { + O << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G)); + + // If we should include the address of the node in the label, do so now. + if (DOTTraits::hasNodeAddressLabel(Node, G)) + O << "|" << (void*)Node; } + O << "}\"];\n"; // Finish printing the "node" line - + // Output all of the edges now EI = GTraits::child_begin(Node); for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) writeEdge(Node, i, EI); + for (; EI != EE; ++EI) + writeEdge(Node, 64, EI); } void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) { if (NodeType *TargetNode = *EI) { - O << "\tNode" << (void*)Node << ":g" << edgeidx << " -> Node" - << (void*)TargetNode; + int DestPort = -1; if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) { child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI); // Figure out which edge this targets... unsigned Offset = std::distance(GTraits::child_begin(TargetNode), TargetIt); - if (Offset > 64) Offset = 64; // Targetting the truncated part? - O << ":g" << Offset; + DestPort = static_cast(Offset); + } + + emitEdge(reinterpret_cast(Node), edgeidx, + reinterpret_cast(TargetNode), DestPort, + DOTTraits::getEdgeAttributes(Node, EI)); + } + } + + /// emitSimpleNode - Outputs a simple (non-record) node + void emitSimpleNode(const void *ID, const std::string &Attr, + const std::string &Label, unsigned NumEdgeSources = 0, + const std::vector *EdgeSourceLabels = 0) { + O << "\tNode" << ID << "[ "; + if (!Attr.empty()) + O << Attr << ","; + O << " label =\""; + if (NumEdgeSources) O << "{"; + O << DOT::EscapeString(Label); + if (NumEdgeSources) { + O << "|{"; + + for (unsigned i = 0; i != NumEdgeSources; ++i) { + if (i) O << "|"; + O << ""; + if (EdgeSourceLabels) O << (*EdgeSourceLabels)[i]; } - - std::string EdgeAttributes = DOTTraits::getEdgeAttributes(Node, EI); - if (!EdgeAttributes.empty()) - O << "[" << EdgeAttributes << "]"; - O << ";\n"; + O << "}}"; } + O << "\"];\n"; + } + + /// emitEdge - Output an edge from a simple node into the graph... + void emitEdge(const void *SrcNodeID, int SrcNodePort, + const void *DestNodeID, int DestNodePort, + const std::string &Attrs) { + if (SrcNodePort > 64) return; // Eminating from truncated part? + if (DestNodePort > 64) DestNodePort = 64; // Targetting the truncated part? + + O << "\tNode" << SrcNodeID; + if (SrcNodePort >= 0) + O << ":g" << SrcNodePort; + O << " -> Node" << reinterpret_cast(DestNodeID); + if (DestNodePort >= 0) + O << ":g" << DestNodePort; + + if (!Attrs.empty()) + O << "[" << Attrs << "]"; + O << ";\n"; } }; @@ -148,8 +228,85 @@ template std::ostream &WriteGraph(std::ostream &O, const GraphType &G, const std::string &Name = "") { // Start the graph emission process... - GraphWriter W(O, G, Name); + GraphWriter W(O, G); + + // Output the header for the graph... + W.writeHeader(Name); + + // Emit all of the nodes in the graph... + W.writeNodes(); + + // Output any customizations on the graph + DOTGraphTraits::addCustomGraphFeatures(G, W); + + // Output the end of the graph + W.writeFooter(); return O; } +template +sys::Path WriteGraph(const GraphType &G, + const std::string& Name, + const std::string& Title = "") { + std::string ErrMsg; + sys::Path Filename = sys::Path::GetTemporaryDirectory(&ErrMsg); + if (Filename.isEmpty()) { + cerr << "Error: " << ErrMsg << "\n"; + return Filename; + } + Filename.appendComponent(Name + ".dot"); + if (Filename.makeUnique(true,&ErrMsg)) { + cerr << "Error: " << ErrMsg << "\n"; + return sys::Path(); + } + + cerr << "Writing '" << Filename << "'... "; + + std::ofstream O(Filename.c_str()); + + if (O.good()) { + // Start the graph emission process... + GraphWriter W(O, G); + + // Output the header for the graph... + W.writeHeader(Title); + + // Emit all of the nodes in the graph... + W.writeNodes(); + + // Output any customizations on the graph + DOTGraphTraits::addCustomGraphFeatures(G, W); + + // Output the end of the graph + W.writeFooter(); + cerr << " done. \n"; + + O.close(); + + } else { + cerr << "error opening file for writing!\n"; + Filename.clear(); + } + + return Filename; +} + +/// ViewGraph - Emit a dot graph, run 'dot', run gv on the postscript file, +/// then cleanup. For use from the debugger. +/// +template +void ViewGraph(const GraphType& G, + const std::string& Name, + const std::string& Title = "") { + sys::Path Filename = WriteGraph(G, Name, Title); + + if (Filename.isEmpty()) { + return; + } + + DisplayGraph(Filename); +} + +} // End llvm namespace + #endif