SelectionDAGPrinter.cpp revision 6cc31ae4da958abc85309f2160e64d6effaa2d3c 
1//===-- SelectionDAGPrinter.cpp - Implement SelectionDAG::viewGraph() -----===//
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 implements the SelectionDAG::viewGraph method.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/Constants.h"
15#include "llvm/Function.h"
16#include "llvm/Assembly/Writer.h"
17#include "llvm/CodeGen/SelectionDAG.h"
18#include "llvm/CodeGen/MachineConstantPool.h"
19#include "llvm/CodeGen/MachineFunction.h"
20#include "llvm/Target/MRegisterInfo.h"
21#include "llvm/Target/TargetMachine.h"
22#include "llvm/Support/GraphWriter.h"
23#include "llvm/ADT/StringExtras.h"
24#include "llvm/Config/config.h"
25#include <fstream>
26#include <sstream>
27using namespace llvm;
28
29namespace llvm {
30  template<>
31  struct DOTGraphTraits<SelectionDAG*> : public DefaultDOTGraphTraits {
32    static std::string getGraphName(const SelectionDAG *G) {
33      return G->getMachineFunction().getFunction()->getName();
34    }
35
36    static bool renderGraphFromBottomUp() {
37      return true;
38    }
39
40    static bool hasNodeAddressLabel(const SDNode *Node,
41                                    const SelectionDAG *Graph) {
42      return true;
43    }
44
45    /// If you want to override the dot attributes printed for a particular
46    /// edge, override this method.
47    template<typename EdgeIter>
48    static std::string getEdgeAttributes(const void *Node, EdgeIter EI) {
49      SDOperand Op = EI.getNode()->getOperand(EI.getOperand());
50      MVT::ValueType VT = Op.getValueType();
51      if (VT == MVT::Flag)
52        return "color=red,style=bold";
53      else if (VT == MVT::Other)
54        return "style=dashed";
55      return "";
56    }
57
58
59    static std::string getNodeLabel(const SDNode *Node,
60                                    const SelectionDAG *Graph);
61    static std::string getNodeAttributes(const SDNode *N,
62                                         const SelectionDAG *Graph) {
63#ifndef NDEBUG
64      const std::string &Attrs = Graph->getGraphAttrs(N);
65      if (!Attrs.empty()) {
66        if (Attrs.find("shape=") == std::string::npos)
67          return std::string("shape=Mrecord,") + Attrs;
68        else
69          return Attrs;
70      }
71#endif
72      return "shape=Mrecord";
73    }
74
75    static void addCustomGraphFeatures(SelectionDAG *G,
76                                       GraphWriter<SelectionDAG*> &GW) {
77      GW.emitSimpleNode(0, "plaintext=circle", "GraphRoot");
78      if (G->getRoot().Val)
79        GW.emitEdge(0, -1, G->getRoot().Val, -1, "");
80    }
81  };
82}
83
84std::string DOTGraphTraits<SelectionDAG*>::getNodeLabel(const SDNode *Node,
85                                                        const SelectionDAG *G) {
86  std::string Op = Node->getOperationName(G);
87
88  for (unsigned i = 0, e = Node->getNumValues(); i != e; ++i)
89    if (Node->getValueType(i) == MVT::Other)
90      Op += ":ch";
91    else
92      Op = Op + ":" + MVT::getValueTypeString(Node->getValueType(i));
93
94  if (const ConstantSDNode *CSDN = dyn_cast<ConstantSDNode>(Node)) {
95    Op += ": " + utostr(CSDN->getValue());
96  } else if (const ConstantFPSDNode *CSDN = dyn_cast<ConstantFPSDNode>(Node)) {
97    Op += ": " + ftostr(CSDN->getValue());
98  } else if (const GlobalAddressSDNode *GADN =
99             dyn_cast<GlobalAddressSDNode>(Node)) {
100    int offset = GADN->getOffset();
101    Op += ": " + GADN->getGlobal()->getName();
102    if (offset > 0)
103      Op += "+" + itostr(offset);
104    else
105      Op += itostr(offset);
106  } else if (const FrameIndexSDNode *FIDN = dyn_cast<FrameIndexSDNode>(Node)) {
107    Op += " " + itostr(FIDN->getIndex());
108  } else if (const JumpTableSDNode *JTDN = dyn_cast<JumpTableSDNode>(Node)) {
109    Op += " " + itostr(JTDN->getIndex());
110  } else if (const ConstantPoolSDNode *CP = dyn_cast<ConstantPoolSDNode>(Node)){
111    if (CP->isMachineConstantPoolEntry()) {
112      std::ostringstream SS;
113      CP->getMachineCPVal()->print(SS);
114      Op += "<" + SS.str() + ">";
115    } else {
116      if (ConstantFP *CFP = dyn_cast<ConstantFP>(CP->getConstVal()))
117        Op += "<" + ftostr(CFP->getValue()) + ">";
118      else if (ConstantInt *CI = dyn_cast<ConstantInt>(CP->getConstVal()))
119        Op += "<" + utostr(CI->getZExtValue()) + ">";
120      else {
121        std::ostringstream SS;
122        WriteAsOperand(SS, CP->getConstVal(), false);
123        Op += "<" + SS.str() + ">";
124      }
125    }
126  } else if (const BasicBlockSDNode *BBDN = dyn_cast<BasicBlockSDNode>(Node)) {
127    Op = "BB: ";
128    const Value *LBB = (const Value*)BBDN->getBasicBlock()->getBasicBlock();
129    if (LBB)
130      Op += LBB->getName();
131    //Op += " " + (const void*)BBDN->getBasicBlock();
132  } else if (const RegisterSDNode *R = dyn_cast<RegisterSDNode>(Node)) {
133    if (G && R->getReg() != 0 &&
134        MRegisterInfo::isPhysicalRegister(R->getReg())) {
135      Op = Op + " " + G->getTarget().getRegisterInfo()->getName(R->getReg());
136    } else {
137      Op += " #" + utostr(R->getReg());
138    }
139  } else if (const ExternalSymbolSDNode *ES =
140             dyn_cast<ExternalSymbolSDNode>(Node)) {
141    Op += "'" + std::string(ES->getSymbol()) + "'";
142  } else if (const SrcValueSDNode *M = dyn_cast<SrcValueSDNode>(Node)) {
143    if (M->getValue())
144      Op += "<" + M->getValue()->getName() + ":" + itostr(M->getOffset()) + ">";
145    else
146      Op += "<null:" + itostr(M->getOffset()) + ">";
147  } else if (const VTSDNode *N = dyn_cast<VTSDNode>(Node)) {
148    Op = Op + " VT=" + getValueTypeString(N->getVT());
149  } else if (const StringSDNode *N = dyn_cast<StringSDNode>(Node)) {
150    Op = Op + "\"" + N->getValue() + "\"";
151  } else if (const LoadSDNode *LD = dyn_cast<LoadSDNode>(Node)) {
152    bool doExt = true;
153    switch (LD->getExtensionType()) {
154    default: doExt = false; break;
155    case ISD::EXTLOAD:
156      Op = Op + "<anyext ";
157      break;
158    case ISD::SEXTLOAD:
159      Op = Op + " <sext ";
160      break;
161    case ISD::ZEXTLOAD:
162      Op = Op + " <zext ";
163      break;
164    }
165    if (doExt)
166      Op = Op + MVT::getValueTypeString(LD->getLoadedVT()) + ">";
167
168    Op += LD->getAddressingModeName(LD->getAddressingMode());
169  } else if (const StoreSDNode *ST = dyn_cast<StoreSDNode>(Node)) {
170    if (ST->isTruncatingStore())
171      Op = Op + "<trunc " + MVT::getValueTypeString(ST->getStoredVT()) + ">";
172    Op += ST->getAddressingModeName(ST->getAddressingMode());
173  }
174
175  return Op;
176}
177
178
179/// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
180/// rendered using 'dot'.
181///
182void SelectionDAG::viewGraph() {
183// This code is only for debugging!
184#ifndef NDEBUG
185  ViewGraph(this, "dag." + getMachineFunction().getFunction()->getName());
186#else
187  std::cerr << "SelectionDAG::viewGraph is only available in debug builds on "
188            << "systems with Graphviz or gv!\n";
189#endif  // NDEBUG
190}
191
192
193/// clearGraphAttrs - Clear all previously defined node graph attributes.
194/// Intended to be used from a debugging tool (eg. gdb).
195void SelectionDAG::clearGraphAttrs() {
196#ifndef NDEBUG
197  NodeGraphAttrs.clear();
198#else
199  std::cerr << "SelectionDAG::clearGraphAttrs is only available in debug builds"
200            << " on systems with Graphviz or gv!\n";
201#endif
202}
203
204
205/// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
206///
207void SelectionDAG::setGraphAttrs(const SDNode *N, const char *Attrs) {
208#ifndef NDEBUG
209  NodeGraphAttrs[N] = Attrs;
210#else
211  std::cerr << "SelectionDAG::setGraphAttrs is only available in debug builds"
212            << " on systems with Graphviz or gv!\n";
213#endif
214}
215
216
217/// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
218/// Used from getNodeAttributes.
219const std::string SelectionDAG::getGraphAttrs(const SDNode *N) const {
220#ifndef NDEBUG
221  std::map<const SDNode *, std::string>::const_iterator I =
222    NodeGraphAttrs.find(N);
223
224  if (I != NodeGraphAttrs.end())
225    return I->second;
226  else
227    return "";
228#else
229  std::cerr << "SelectionDAG::getGraphAttrs is only available in debug builds"
230            << " on systems with Graphviz or gv!\n";
231  return std::string("");
232#endif
233}
234
235/// setGraphColor - Convenience for setting node color attribute.
236///
237void SelectionDAG::setGraphColor(const SDNode *N, const char *Color) {
238#ifndef NDEBUG
239  NodeGraphAttrs[N] = std::string("color=") + Color;
240#else
241  std::cerr << "SelectionDAG::setGraphColor is only available in debug builds"
242            << " on systems with Graphviz or gv!\n";
243#endif
244}
245
246