X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FSupport%2FGraphWriter.h;h=85cf71805fd69fa8e905dff2bc9d7df56e47e046;hb=80a75bfae980df96f969f1c05b0c4a80ce975240;hp=02f3952422c88d42ec0317cba5d645d01c7a7be0;hpb=ce393a609ba1df701cfba9e96749275a16e22ade;p=oota-llvm.git diff --git a/include/llvm/Support/GraphWriter.h b/include/llvm/Support/GraphWriter.h index 02f3952422c..85cf71805fd 100644 --- a/include/llvm/Support/GraphWriter.h +++ b/include/llvm/Support/GraphWriter.h @@ -1,10 +1,10 @@ //===-- 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 @@ -23,10 +23,12 @@ #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 namespace llvm { @@ -50,7 +52,7 @@ namespace DOT { // Private functions... break; // don't disturb \l case '{': case '}': case '<': case '>': - case '"': + case '|': case '"': Str.insert(Str.begin()+i, '\\'); // Escape character... ++i; // don't infinite loop break; @@ -59,6 +61,8 @@ namespace DOT { // Private functions... } } +void DisplayGraph(const sys::Path& Filename); + template class GraphWriter { std::ostream &O; @@ -78,6 +82,9 @@ public: 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"; @@ -94,38 +101,60 @@ 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); - + 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 << "}"; + 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) @@ -164,7 +193,7 @@ public: O << DOT::EscapeString(Label); if (NumEdgeSources) { O << "|{"; - + for (unsigned i = 0; i != NumEdgeSources; ++i) { if (i) O << "|"; O << ""; @@ -187,7 +216,7 @@ public: O << ":g" << SrcNodePort; O << " -> Node" << reinterpret_cast(DestNodeID); if (DestNodePort >= 0) - O << ":g" << DestNodePort; + O << ":g" << DestNodePort; if (!Attrs.empty()) O << "[" << Attrs << "]"; @@ -215,6 +244,69 @@ std::ostream &WriteGraph(std::ostream &O, const GraphType &G, 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