X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FSupport%2FGraphWriter.h;h=86985c5694649cf1f90442bad62d129cf4768ee3;hb=HEAD;hp=229284fa8e583f66c0db82d738faac9d7ebd3178;hpb=b2109ce97881269a610fa4afbcbca350e975174d;p=oota-llvm.git diff --git a/include/llvm/Support/GraphWriter.h b/include/llvm/Support/GraphWriter.h index 229284fa8e5..86985c56946 100644 --- a/include/llvm/Support/GraphWriter.h +++ b/include/llvm/Support/GraphWriter.h @@ -1,10 +1,10 @@ -//===-- 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 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 @@ -20,45 +20,41 @@ // //===----------------------------------------------------------------------===// -#ifndef SUPPORT_GRAPHWRITER_H -#define SUPPORT_GRAPHWRITER_H +#ifndef LLVM_SUPPORT_GRAPHWRITER_H +#define LLVM_SUPPORT_GRAPHWRITER_H -#include "Support/DOTGraphTraits.h" -#include "Support/GraphTraits.h" +#include "llvm/ADT/GraphTraits.h" +#include "llvm/ADT/Twine.h" +#include "llvm/Support/DOTGraphTraits.h" +#include "llvm/Support/raw_ostream.h" #include -#include + +namespace llvm { namespace DOT { // Private functions... - inline std::string EscapeString(const std::string &Label) { - std::string Str(Label); - for (unsigned i = 0; i != Str.length(); ++i) - switch (Str[i]) { - case '\n': - Str.insert(Str.begin()+i, '\\'); // Escape character... - ++i; - Str[i] = 'n'; - break; - case '\t': - Str.insert(Str.begin()+i, ' '); // Convert to two spaces - ++i; - Str[i] = ' '; - break; - case '\\': - if (i+1 != Str.length() && Str[i+1] == 'l') - break; // don't disturb \l - case '{': case '}': - case '<': case '>': - Str.insert(Str.begin()+i, '\\'); // Escape character... - ++i; // don't infinite loop - break; - } - return Str; - } + std::string EscapeString(const std::string &Label); + + /// \brief Get a color string for this node number. Simply round-robin selects + /// from a reasonable number of colors. + StringRef getColorString(unsigned NodeNumber); +} + +namespace GraphProgram { + enum Name { + DOT, + FDP, + NEATO, + TWOPI, + CIRCO + }; } +bool DisplayGraph(StringRef Filename, bool wait = true, + GraphProgram::Name program = GraphProgram::DOT); + template class GraphWriter { - std::ostream &O; + raw_ostream &O; const GraphType &G; typedef DOTGraphTraits DOTTraits; @@ -66,19 +62,72 @@ class GraphWriter { typedef typename GTraits::NodeType NodeType; typedef typename GTraits::nodes_iterator node_iterator; typedef typename GTraits::ChildIteratorType child_iterator; + DOTTraits DTraits; + + // Writes the edge labels of the node to O and returns true if there are any + // edge labels not equal to the empty string "". + bool getEdgeSourceLabels(raw_ostream &O, NodeType *Node) { + child_iterator EI = GTraits::child_begin(Node); + child_iterator EE = GTraits::child_end(Node); + bool hasEdgeSourceLabels = false; + + for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) { + std::string label = DTraits.getEdgeSourceLabel(Node, EI); + + if (label.empty()) + continue; + + hasEdgeSourceLabels = true; + + if (i) + O << "|"; + + O << "" << DOT::EscapeString(label); + } + + if (EI != EE && hasEdgeSourceLabels) + O << "|truncated..."; + + return hasEdgeSourceLabels; + } + public: - GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {} + GraphWriter(raw_ostream &o, const GraphType &g, bool SN) : O(o), G(g) { + DTraits = DOTTraits(SN); + } + + void writeGraph(const std::string &Title = "") { + // Output the header for the graph... + writeHeader(Title); + + // Emit all of the nodes in the graph... + writeNodes(); - void writeHeader(const std::string &Name) { - if (Name.empty()) - O << "digraph foo {\n"; // Graph name doesn't matter + // Output any customizations on the graph + DOTGraphTraits::addCustomGraphFeatures(G, *this); + + // Output the end of the graph + writeFooter(); + } + + void writeHeader(const std::string &Title) { + std::string GraphName = DTraits.getGraphName(G); + + if (!Title.empty()) + O << "digraph \"" << DOT::EscapeString(Title) << "\" {\n"; + else if (!GraphName.empty()) + O << "digraph \"" << DOT::EscapeString(GraphName) << "\" {\n"; else - O << "digraph " << Name << " {\n"; + O << "digraph unnamed {\n"; + + if (DTraits.renderGraphFromBottomUp()) + O << "\trankdir=\"BT\";\n"; - std::string GraphName = DOTTraits::getGraphName(G); - if (!GraphName.empty()) + if (!Title.empty()) + O << "\tlabel=\"" << DOT::EscapeString(Title) << "\";\n"; + else if (!GraphName.empty()) O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n"; - O << DOTTraits::getGraphProperties(G); + O << DTraits.getGraphProperties(G); O << "\n"; } @@ -91,61 +140,128 @@ 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); + if (!isNodeHidden(*I)) + writeNode(*I); + } + + bool isNodeHidden(NodeType &Node) { + return isNodeHidden(&Node); + } + + bool isNodeHidden(NodeType *const *Node) { + return isNodeHidden(*Node); + } + + bool isNodeHidden(NodeType *Node) { + return DTraits.isNodeHidden(Node); + } + + 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 = DTraits.getNodeAttributes(Node, G); + + O << "\tNode" << static_cast(Node) << " [shape=record,"; if (!NodeAttributes.empty()) O << NodeAttributes << ","; - O << "label=\"{" - << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G)); - - // 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 << "label=\"{"; + + if (!DTraits.renderGraphFromBottomUp()) { + O << DOT::EscapeString(DTraits.getNodeLabel(Node, G)); + + // If we should include the address of the node in the label, do so now. + std::string Id = DTraits.getNodeIdentifierLabel(Node, G); + if (!Id.empty()) + O << "|" << DOT::EscapeString(Id); + + std::string NodeDesc = DTraits.getNodeDescription(Node, G); + if (!NodeDesc.empty()) + O << "|" << DOT::EscapeString(NodeDesc); + } + + std::string edgeSourceLabels; + raw_string_ostream EdgeSourceLabels(edgeSourceLabels); + bool hasEdgeSourceLabels = getEdgeSourceLabels(EdgeSourceLabels, Node); + + if (hasEdgeSourceLabels) { + if (!DTraits.renderGraphFromBottomUp()) O << "|"; + + O << "{" << EdgeSourceLabels.str() << "}"; + + if (DTraits.renderGraphFromBottomUp()) O << "|"; + } + + if (DTraits.renderGraphFromBottomUp()) { + O << DOT::EscapeString(DTraits.getNodeLabel(Node, G)); + + // If we should include the address of the node in the label, do so now. + std::string Id = DTraits.getNodeIdentifierLabel(Node, G); + if (!Id.empty()) + O << "|" << DOT::EscapeString(Id); + + std::string NodeDesc = DTraits.getNodeDescription(Node, G); + if (!NodeDesc.empty()) + O << "|" << DOT::EscapeString(NodeDesc); + } + + if (DTraits.hasEdgeDestLabels()) { O << "|{"; - - for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) { + + unsigned i = 0, e = DTraits.numEdgeDestLabels(Node); + for (; i != e && i != 64; ++i) { if (i) O << "|"; - O << "" << DOTTraits::getEdgeSourceLabel(Node, EI); + O << "" + << DOT::EscapeString(DTraits.getEdgeDestLabel(Node, i)); } - - if (EI != EE) - O << "|truncated..."; + + if (i != e) + O << "|truncated..."; O << "}"; } + O << "}\"];\n"; // Finish printing the "node" line - + // Output all of the edges now - EI = GTraits::child_begin(Node); + child_iterator EI = GTraits::child_begin(Node); + child_iterator EE = GTraits::child_end(Node); for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) - writeEdge(Node, i, EI); + if (!DTraits.isNodeHidden(*EI)) + writeEdge(Node, i, EI); + for (; EI != EE; ++EI) + if (!DTraits.isNodeHidden(*EI)) + writeEdge(Node, 64, EI); } void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) { if (NodeType *TargetNode = *EI) { int DestPort = -1; - if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) { - child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI); + if (DTraits.edgeTargetsEdgeSource(Node, EI)) { + child_iterator TargetIt = DTraits.getEdgeTarget(Node, EI); // Figure out which edge this targets... - unsigned Offset = std::distance(GTraits::child_begin(TargetNode), - TargetIt); - DestPort = (int)Offset; + unsigned Offset = + (unsigned)std::distance(GTraits::child_begin(TargetNode), TargetIt); + DestPort = static_cast(Offset); } - emitEdge((void *)Node, edgeidx, (void*)TargetNode, DestPort, - DOTTraits::getEdgeAttributes(Node, EI)); + if (DTraits.getEdgeSourceLabel(Node, EI).empty()) + edgeidx = -1; + + emitEdge(static_cast(Node), edgeidx, + static_cast(TargetNode), DestPort, + DTraits.getEdgeAttributes(Node, EI, G)); } } /// 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) { + const std::string &Label, unsigned NumEdgeSources = 0, + const std::vector *EdgeSourceLabels = nullptr) { O << "\tNode" << ID << "[ "; if (!Attr.empty()) O << Attr << ","; @@ -154,11 +270,11 @@ public: O << DOT::EscapeString(Label); if (NumEdgeSources) { O << "|{"; - + for (unsigned i = 0; i != NumEdgeSources; ++i) { if (i) O << "|"; - O << ""; - if (EdgeSourceLabels) O << (*EdgeSourceLabels)[i]; + O << ""; + if (EdgeSourceLabels) O << DOT::EscapeString((*EdgeSourceLabels)[i]); } O << "}}"; } @@ -170,39 +286,78 @@ public: 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? + if (DestNodePort > 64) DestNodePort = 64; // Targeting the truncated part? O << "\tNode" << SrcNodeID; if (SrcNodePort >= 0) - O << ":g" << SrcNodePort; - O << " -> Node" << (void*)DestNodeID; - if (DestNodePort >= 0) - O << ":g" << DestNodePort; + O << ":s" << SrcNodePort; + O << " -> Node" << DestNodeID; + if (DestNodePort >= 0 && DTraits.hasEdgeDestLabels()) + O << ":d" << DestNodePort; if (!Attrs.empty()) O << "[" << Attrs << "]"; O << ";\n"; } + + /// getOStream - Get the raw output stream into the graph file. Useful to + /// write fancy things using addCustomGraphFeatures(). + raw_ostream &getOStream() { + return O; + } }; template -std::ostream &WriteGraph(std::ostream &O, const GraphType &G, - const std::string &Name = "") { +raw_ostream &WriteGraph(raw_ostream &O, const GraphType &G, + bool ShortNames = false, + const Twine &Title = "") { // Start the graph emission process... - GraphWriter W(O, G); + GraphWriter W(O, G, ShortNames); - // Output the header for the graph... - W.writeHeader(Name); + // Emit the graph. + W.writeGraph(Title.str()); - // Emit all of the nodes in the graph... - W.writeNodes(); + return O; +} - // Output any customizations on the graph - DOTGraphTraits::addCustomGraphFeatures(G, W); +std::string createGraphFilename(const Twine &Name, int &FD); - // Output the end of the graph - W.writeFooter(); - return O; +template +std::string WriteGraph(const GraphType &G, const Twine &Name, + bool ShortNames = false, const Twine &Title = "") { + int FD; + // Windows can't always handle long paths, so limit the length of the name. + std::string N = Name.str(); + N = N.substr(0, std::min(N.size(), 140)); + std::string Filename = createGraphFilename(N, FD); + raw_fd_ostream O(FD, /*shouldClose=*/ true); + + if (FD == -1) { + errs() << "error opening file '" << Filename << "' for writing!\n"; + return ""; + } + + llvm::WriteGraph(O, G, ShortNames, Title); + errs() << " done. \n"; + + 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 Twine &Name, + bool ShortNames = false, const Twine &Title = "", + GraphProgram::Name Program = GraphProgram::DOT) { + std::string Filename = llvm::WriteGraph(G, Name, ShortNames, Title); + + if (Filename.empty()) + return; + + DisplayGraph(Filename, false, Program); } +} // End llvm namespace + #endif