include/llvm/Support/GraphWriter.h

   1 //===-- llvm/Support/GraphWriter.h - Write graph to a .dot file -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines a simple interface that can be used to print out generic
  11 // LLVM graphs to ".dot" files.  "dot" is a tool that is part of the AT&T
  12 // graphviz package (http://www.research.att.com/sw/tools/graphviz/) which can
  13 // be used to turn the files output by this interface into a variety of
  14 // different graphics formats.
  15 //
  16 // Graphs do not need to implement any interface past what is already required
  17 // by the GraphTraits template, but they can choose to implement specializations
  18 // of the DOTGraphTraits template if they want to customize the graphs output in
  19 // any way.
  20 //
  21 //===----------------------------------------------------------------------===//
  22
  23 #ifndef LLVM_SUPPORT_GRAPHWRITER_H
  24 #define LLVM_SUPPORT_GRAPHWRITER_H
  25
  26 #include "llvm/Support/DOTGraphTraits.h"
  27 #include "llvm/ADT/GraphTraits.h"
  28 #include <vector>
  29 #include <iostream>
  30
  31 namespace llvm {
  32
  33 namespace DOT {  // Private functions...
  34   inline std::string EscapeString(const std::string &Label) {
  35     std::string Str(Label);
  36     for (unsigned i = 0; i != Str.length(); ++i)
  37       switch (Str[i]) {
  38       case '\n':
  39         Str.insert(Str.begin()+i, '\\');  // Escape character...
  40         ++i;
  41         Str[i] = 'n';
  42         break;
  43       case '\t':
  44         Str.insert(Str.begin()+i, ' ');  // Convert to two spaces
  45         ++i;
  46         Str[i] = ' ';
  47         break;
  48       case '\\':
  49         if (i+1 != Str.length() && Str[i+1] == 'l')
  50           break;  // don't disturb \l
  51       case '{': case '}':
  52       case '<': case '>':
  53       case '"':
  54         Str.insert(Str.begin()+i, '\\');  // Escape character...
  55         ++i;  // don't infinite loop
  56         break;
  57       }
  58     return Str;
  59   }
  60 }
  61
  62 template<typename GraphType>
  63 class GraphWriter {
  64   std::ostream &O;
  65   const GraphType &G;
  66
  67   typedef DOTGraphTraits<GraphType>           DOTTraits;
  68   typedef GraphTraits<GraphType>              GTraits;
  69   typedef typename GTraits::NodeType          NodeType;
  70   typedef typename GTraits::nodes_iterator    node_iterator;
  71   typedef typename GTraits::ChildIteratorType child_iterator;
  72 public:
  73   GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {}
  74
  75   void writeHeader(const std::string &Name) {
  76     if (Name.empty())
  77       O << "digraph foo {\n";        // Graph name doesn't matter
  78     else
  79       O << "digraph " << Name << " {\n";
  80
  81     std::string GraphName = DOTTraits::getGraphName(G);
  82     if (!GraphName.empty())
  83       O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
  84     O << DOTTraits::getGraphProperties(G);
  85     O << "\n";
  86   }
  87
  88   void writeFooter() {
  89     // Finish off the graph
  90     O << "}\n";
  91   }
  92
  93   void writeNodes() {
  94     // Loop over the graph, printing it out...
  95     for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G);
  96          I != E; ++I)
  97       writeNode(&*I);
  98   }
  99
 100   void writeNode(NodeType *const *Node) {
 101     writeNode(*Node);
 102   }
 103
 104   void writeNode(NodeType *Node) {
 105     std::string NodeAttributes = DOTTraits::getNodeAttributes(Node);
 106
 107     O << "\tNode" << reinterpret_cast<const void*>(Node) << " [shape=record,";
 108     if (!NodeAttributes.empty()) O << NodeAttributes << ",";
 109     O << "label=\"{"
 110       << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
 111
 112     // Print out the fields of the current node...
 113     child_iterator EI = GTraits::child_begin(Node);
 114     child_iterator EE = GTraits::child_end(Node);
 115     if (EI != EE) {
 116       O << "|{";
 117
 118       for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) {
 119         if (i) O << "|";
 120         O << "<g" << i << ">" << DOTTraits::getEdgeSourceLabel(Node, EI);
 121       }
 122
 123       if (EI != EE)
 124         O << "|<g64>truncated...";
 125       O << "}";
 126     }
 127     O << "}\"];\n";   // Finish printing the "node" line
 128
 129     // Output all of the edges now
 130     EI = GTraits::child_begin(Node);
 131     for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
 132       writeEdge(Node, i, EI);
 133     for (; EI != EE; ++EI)
 134       writeEdge(Node, 64, EI);
 135   }
 136
 137   void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) {
 138     if (NodeType *TargetNode = *EI) {
 139       int DestPort = -1;
 140       if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) {
 141         child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI);
 142
 143         // Figure out which edge this targets...
 144         unsigned Offset = std::distance(GTraits::child_begin(TargetNode),
 145                                         TargetIt);
 146         DestPort = static_cast<int>(Offset);
 147       }
 148
 149       emitEdge(reinterpret_cast<const void*>(Node), edgeidx,
 150                reinterpret_cast<const void*>(TargetNode), DestPort,
 151                DOTTraits::getEdgeAttributes(Node, EI));
 152     }
 153   }
 154
 155   /// emitSimpleNode - Outputs a simple (non-record) node
 156   void emitSimpleNode(const void *ID, const std::string &Attr,
 157                       const std::string &Label, unsigned NumEdgeSources = 0,
 158                       const std::vector<std::string> *EdgeSourceLabels = 0) {
 159     O << "\tNode" << ID << "[ ";
 160     if (!Attr.empty())
 161       O << Attr << ",";
 162     O << " label =\"";
 163     if (NumEdgeSources) O << "{";
 164     O << DOT::EscapeString(Label);
 165     if (NumEdgeSources) {
 166       O << "|{";
 167
 168       for (unsigned i = 0; i != NumEdgeSources; ++i) {
 169         if (i) O << "|";
 170         O << "<g" << i << ">";
 171         if (EdgeSourceLabels) O << (*EdgeSourceLabels)[i];
 172       }
 173       O << "}}";
 174     }
 175     O << "\"];\n";
 176   }
 177
 178   /// emitEdge - Output an edge from a simple node into the graph...
 179   void emitEdge(const void *SrcNodeID, int SrcNodePort,
 180                 const void *DestNodeID, int DestNodePort,
 181                 const std::string &Attrs) {
 182     if (SrcNodePort  > 64) return;             // Eminating from truncated part?
 183     if (DestNodePort > 64) DestNodePort = 64;  // Targetting the truncated part?
 184
 185     O << "\tNode" << SrcNodeID;
 186     if (SrcNodePort >= 0)
 187       O << ":g" << SrcNodePort;
 188     O << " -> Node" << reinterpret_cast<const void*>(DestNodeID);
 189     if (DestNodePort >= 0)
 190       O << ":g" << DestNodePort;
 191
 192     if (!Attrs.empty())
 193       O << "[" << Attrs << "]";
 194     O << ";\n";
 195   }
 196 };
 197
 198 template<typename GraphType>
 199 std::ostream &WriteGraph(std::ostream &O, const GraphType &G,
 200                          const std::string &Name = "") {
 201   // Start the graph emission process...
 202   GraphWriter<GraphType> W(O, G);
 203
 204   // Output the header for the graph...
 205   W.writeHeader(Name);
 206
 207   // Emit all of the nodes in the graph...
 208   W.writeNodes();
 209
 210   // Output any customizations on the graph
 211   DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W);
 212
 213   // Output the end of the graph
 214   W.writeFooter();
 215   return O;
 216 }
 217
 218 } // End llvm namespace
 219
 220 #endif