SelectionDAGPrinter.cpp revision 705e3f774254a03ef28a27c1d15903547a0e9d4c 
1//===-- SelectionDAGPrinter.cpp - Implement SelectionDAG::viewGraph() -----===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// 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/ScheduleDAG.h"
19#include "llvm/CodeGen/MachineConstantPool.h"
20#include "llvm/CodeGen/MachineFunction.h"
21#include "llvm/CodeGen/MachineModuleInfo.h"
22#include "llvm/CodeGen/PseudoSourceValue.h"
23#include "llvm/Target/TargetRegisterInfo.h"
24#include "llvm/Target/TargetMachine.h"
25#include "llvm/Support/GraphWriter.h"
26#include "llvm/Support/raw_ostream.h"
27#include "llvm/ADT/StringExtras.h"
28#include "llvm/Config/config.h"
29#include <fstream>
30using namespace llvm;
31
32namespace llvm {
33  template<>
34  struct DOTGraphTraits<SelectionDAG*> : public DefaultDOTGraphTraits {
35    static bool hasEdgeDestLabels() {
36      return true;
37    }
38
39    static unsigned numEdgeDestLabels(const void *Node) {
40      return ((const SDNode *) Node)->getNumValues();
41    }
42
43    static std::string getEdgeDestLabel(const void *Node, unsigned i) {
44      return ((const SDNode *) Node)->getValueType(i).getMVTString();
45    }
46
47    /// edgeTargetsEdgeSource - This method returns true if this outgoing edge
48    /// should actually target another edge source, not a node.  If this method is
49    /// implemented, getEdgeTarget should be implemented.
50    template<typename EdgeIter>
51    static bool edgeTargetsEdgeSource(const void *Node, EdgeIter I) {
52      return true;
53    }
54
55    /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
56    /// called to determine which outgoing edge of Node is the target of this
57    /// edge.
58    template<typename EdgeIter>
59    static EdgeIter getEdgeTarget(const void *Node, EdgeIter I) {
60      SDNode *TargetNode = *I;
61      SDNodeIterator NI = SDNodeIterator::begin(TargetNode);
62      std::advance(NI, I.getNode()->getOperand(I.getOperand()).getResNo());
63      return NI;
64    }
65
66    static std::string getGraphName(const SelectionDAG *G) {
67      return G->getMachineFunction().getFunction()->getName();
68    }
69
70    static bool renderGraphFromBottomUp() {
71      return true;
72    }
73
74    static bool hasNodeAddressLabel(const SDNode *Node,
75                                    const SelectionDAG *Graph) {
76      return true;
77    }
78
79    /// If you want to override the dot attributes printed for a particular
80    /// edge, override this method.
81    template<typename EdgeIter>
82    static std::string getEdgeAttributes(const void *Node, EdgeIter EI) {
83      SDValue Op = EI.getNode()->getOperand(EI.getOperand());
84      MVT VT = Op.getValueType();
85      if (VT == MVT::Flag)
86        return "color=red,style=bold";
87      else if (VT == MVT::Other)
88        return "color=blue,style=dashed";
89      return "";
90    }
91
92
93    static std::string getNodeLabel(const SDNode *Node,
94                                    const SelectionDAG *Graph);
95    static std::string getNodeAttributes(const SDNode *N,
96                                         const SelectionDAG *Graph) {
97#ifndef NDEBUG
98      const std::string &Attrs = Graph->getGraphAttrs(N);
99      if (!Attrs.empty()) {
100        if (Attrs.find("shape=") == std::string::npos)
101          return std::string("shape=Mrecord,") + Attrs;
102        else
103          return Attrs;
104      }
105#endif
106      return "shape=Mrecord";
107    }
108
109    static void addCustomGraphFeatures(SelectionDAG *G,
110                                       GraphWriter<SelectionDAG*> &GW) {
111      GW.emitSimpleNode(0, "plaintext=circle", "GraphRoot");
112      if (G->getRoot().getNode())
113        GW.emitEdge(0, -1, G->getRoot().getNode(), G->getRoot().getResNo(),
114                    "color=blue,style=dashed");
115    }
116  };
117}
118
119std::string DOTGraphTraits<SelectionDAG*>::getNodeLabel(const SDNode *Node,
120                                                        const SelectionDAG *G) {
121  std::string Op = Node->getOperationName(G);
122
123  if (const ConstantSDNode *CSDN = dyn_cast<ConstantSDNode>(Node)) {
124    Op += ": " + utostr(CSDN->getZExtValue());
125  } else if (const ConstantFPSDNode *CSDN = dyn_cast<ConstantFPSDNode>(Node)) {
126    Op += ": " + ftostr(CSDN->getValueAPF());
127  } else if (const GlobalAddressSDNode *GADN =
128             dyn_cast<GlobalAddressSDNode>(Node)) {
129    int offset = GADN->getOffset();
130    Op += ": " + GADN->getGlobal()->getName();
131    if (offset > 0)
132      Op += "+" + itostr(offset);
133    else
134      Op += itostr(offset);
135  } else if (const FrameIndexSDNode *FIDN = dyn_cast<FrameIndexSDNode>(Node)) {
136    Op += " " + itostr(FIDN->getIndex());
137  } else if (const JumpTableSDNode *JTDN = dyn_cast<JumpTableSDNode>(Node)) {
138    Op += " " + itostr(JTDN->getIndex());
139  } else if (const ConstantPoolSDNode *CP = dyn_cast<ConstantPoolSDNode>(Node)){
140    if (CP->isMachineConstantPoolEntry()) {
141      Op += '<';
142      {
143        raw_string_ostream OSS(Op);
144        OSS << *CP->getMachineCPVal();
145      }
146      Op += '>';
147    } else {
148      if (ConstantFP *CFP = dyn_cast<ConstantFP>(CP->getConstVal()))
149        Op += "<" + ftostr(CFP->getValueAPF()) + ">";
150      else if (ConstantInt *CI = dyn_cast<ConstantInt>(CP->getConstVal()))
151        Op += "<" + utostr(CI->getZExtValue()) + ">";
152      else {
153        Op += '<';
154        {
155          raw_string_ostream OSS(Op);
156          WriteAsOperand(OSS, CP->getConstVal(), false);
157        }
158        Op += '>';
159      }
160    }
161  } else if (const BasicBlockSDNode *BBDN = dyn_cast<BasicBlockSDNode>(Node)) {
162    Op = "BB: ";
163    const Value *LBB = (const Value*)BBDN->getBasicBlock()->getBasicBlock();
164    if (LBB)
165      Op += LBB->getName();
166    //Op += " " + (const void*)BBDN->getBasicBlock();
167  } else if (const RegisterSDNode *R = dyn_cast<RegisterSDNode>(Node)) {
168    if (G && R->getReg() != 0 &&
169        TargetRegisterInfo::isPhysicalRegister(R->getReg())) {
170      Op = Op + " " +
171        G->getTarget().getRegisterInfo()->getName(R->getReg());
172    } else {
173      Op += " #" + utostr(R->getReg());
174    }
175  } else if (const DbgStopPointSDNode *D = dyn_cast<DbgStopPointSDNode>(Node)) {
176    Op += ": " + D->getCompileUnit()->getFileName();
177    Op += ":" + utostr(D->getLine());
178    if (D->getColumn() != 0)
179      Op += ":" + utostr(D->getColumn());
180  } else if (const LabelSDNode *L = dyn_cast<LabelSDNode>(Node)) {
181    Op += ": LabelID=" + utostr(L->getLabelID());
182  } else if (const CallSDNode *C = dyn_cast<CallSDNode>(Node)) {
183    Op += ": CallingConv=" + utostr(C->getCallingConv());
184    if (C->isVarArg())
185      Op += ", isVarArg";
186    if (C->isTailCall())
187      Op += ", isTailCall";
188  } else if (const ExternalSymbolSDNode *ES =
189             dyn_cast<ExternalSymbolSDNode>(Node)) {
190    Op += "'" + std::string(ES->getSymbol()) + "'";
191  } else if (const SrcValueSDNode *M = dyn_cast<SrcValueSDNode>(Node)) {
192    if (M->getValue())
193      Op += "<" + M->getValue()->getName() + ">";
194    else
195      Op += "<null>";
196  } else if (const MemOperandSDNode *M = dyn_cast<MemOperandSDNode>(Node)) {
197    const Value *V = M->MO.getValue();
198    Op += '<';
199    if (!V) {
200      Op += "(unknown)";
201    } else if (isa<PseudoSourceValue>(V)) {
202      // PseudoSourceValues don't have names, so use their print method.
203      {
204        raw_string_ostream OSS(Op);
205        OSS << *M->MO.getValue();
206      }
207    } else {
208      Op += V->getName();
209    }
210    Op += '+' + itostr(M->MO.getOffset()) + '>';
211  } else if (const ARG_FLAGSSDNode *N = dyn_cast<ARG_FLAGSSDNode>(Node)) {
212    Op = Op + " AF=" + N->getArgFlags().getArgFlagsString();
213  } else if (const VTSDNode *N = dyn_cast<VTSDNode>(Node)) {
214    Op = Op + " VT=" + N->getVT().getMVTString();
215  } else if (const LoadSDNode *LD = dyn_cast<LoadSDNode>(Node)) {
216    bool doExt = true;
217    switch (LD->getExtensionType()) {
218    default: doExt = false; break;
219    case ISD::EXTLOAD:
220      Op = Op + "<anyext ";
221      break;
222    case ISD::SEXTLOAD:
223      Op = Op + " <sext ";
224      break;
225    case ISD::ZEXTLOAD:
226      Op = Op + " <zext ";
227      break;
228    }
229    if (doExt)
230      Op += LD->getMemoryVT().getMVTString() + ">";
231    if (LD->isVolatile())
232      Op += "<V>";
233    Op += LD->getIndexedModeName(LD->getAddressingMode());
234    if (LD->getAlignment() > 1)
235      Op += " A=" + utostr(LD->getAlignment());
236  } else if (const StoreSDNode *ST = dyn_cast<StoreSDNode>(Node)) {
237    if (ST->isTruncatingStore())
238      Op += "<trunc " + ST->getMemoryVT().getMVTString() + ">";
239    if (ST->isVolatile())
240      Op += "<V>";
241    Op += ST->getIndexedModeName(ST->getAddressingMode());
242    if (ST->getAlignment() > 1)
243      Op += " A=" + utostr(ST->getAlignment());
244  }
245
246#if 0
247  Op += " Id=" + itostr(Node->getNodeId());
248#endif
249
250  return Op;
251}
252
253
254/// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
255/// rendered using 'dot'.
256///
257void SelectionDAG::viewGraph(const std::string &Title) {
258// This code is only for debugging!
259#ifndef NDEBUG
260  ViewGraph(this, "dag." + getMachineFunction().getFunction()->getName(),
261            Title);
262#else
263  cerr << "SelectionDAG::viewGraph is only available in debug builds on "
264       << "systems with Graphviz or gv!\n";
265#endif  // NDEBUG
266}
267
268// This overload is defined out-of-line here instead of just using a
269// default parameter because this is easiest for gdb to call.
270void SelectionDAG::viewGraph() {
271  viewGraph("");
272}
273
274/// clearGraphAttrs - Clear all previously defined node graph attributes.
275/// Intended to be used from a debugging tool (eg. gdb).
276void SelectionDAG::clearGraphAttrs() {
277#ifndef NDEBUG
278  NodeGraphAttrs.clear();
279#else
280  cerr << "SelectionDAG::clearGraphAttrs is only available in debug builds"
281       << " on systems with Graphviz or gv!\n";
282#endif
283}
284
285
286/// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
287///
288void SelectionDAG::setGraphAttrs(const SDNode *N, const char *Attrs) {
289#ifndef NDEBUG
290  NodeGraphAttrs[N] = Attrs;
291#else
292  cerr << "SelectionDAG::setGraphAttrs is only available in debug builds"
293       << " on systems with Graphviz or gv!\n";
294#endif
295}
296
297
298/// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
299/// Used from getNodeAttributes.
300const std::string SelectionDAG::getGraphAttrs(const SDNode *N) const {
301#ifndef NDEBUG
302  std::map<const SDNode *, std::string>::const_iterator I =
303    NodeGraphAttrs.find(N);
304
305  if (I != NodeGraphAttrs.end())
306    return I->second;
307  else
308    return "";
309#else
310  cerr << "SelectionDAG::getGraphAttrs is only available in debug builds"
311       << " on systems with Graphviz or gv!\n";
312  return std::string("");
313#endif
314}
315
316/// setGraphColor - Convenience for setting node color attribute.
317///
318void SelectionDAG::setGraphColor(const SDNode *N, const char *Color) {
319#ifndef NDEBUG
320  NodeGraphAttrs[N] = std::string("color=") + Color;
321#else
322  cerr << "SelectionDAG::setGraphColor is only available in debug builds"
323       << " on systems with Graphviz or gv!\n";
324#endif
325}
326
327namespace llvm {
328  template<>
329  struct DOTGraphTraits<ScheduleDAG*> : public DefaultDOTGraphTraits {
330    static std::string getGraphName(const ScheduleDAG *G) {
331      return DOTGraphTraits<SelectionDAG*>::getGraphName(&G->DAG);
332    }
333
334    static bool renderGraphFromBottomUp() {
335      return true;
336    }
337
338    static bool hasNodeAddressLabel(const SUnit *Node,
339                                    const ScheduleDAG *Graph) {
340      return true;
341    }
342
343    /// If you want to override the dot attributes printed for a particular
344    /// edge, override this method.
345    template<typename EdgeIter>
346    static std::string getEdgeAttributes(const void *Node, EdgeIter EI) {
347      if (EI.isSpecialDep())
348        return "color=cyan,style=dashed";
349      if (EI.isCtrlDep())
350        return "color=blue,style=dashed";
351      return "";
352    }
353
354
355    static std::string getNodeLabel(const SUnit *Node,
356                                    const ScheduleDAG *Graph);
357    static std::string getNodeAttributes(const SUnit *N,
358                                         const ScheduleDAG *Graph) {
359      return "shape=Mrecord";
360    }
361
362    static void addCustomGraphFeatures(ScheduleDAG *G,
363                                       GraphWriter<ScheduleDAG*> &GW) {
364      GW.emitSimpleNode(0, "plaintext=circle", "GraphRoot");
365      const SDNode *N = G->DAG.getRoot().getNode();
366      if (N && N->getNodeId() != -1)
367        GW.emitEdge(0, -1, &G->SUnits[N->getNodeId()], -1,
368                    "color=blue,style=dashed");
369    }
370  };
371}
372
373std::string DOTGraphTraits<ScheduleDAG*>::getNodeLabel(const SUnit *SU,
374                                                       const ScheduleDAG *G) {
375  std::string Op;
376
377  for (unsigned i = 0; i < SU->FlaggedNodes.size(); ++i) {
378    Op += DOTGraphTraits<SelectionDAG*>::getNodeLabel(SU->FlaggedNodes[i],
379                                                      &G->DAG) + "\n";
380  }
381
382  if (SU->Node)
383    Op += DOTGraphTraits<SelectionDAG*>::getNodeLabel(SU->Node, &G->DAG);
384  else
385    Op += "<CROSS RC COPY>";
386
387  return Op;
388}
389
390
391/// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
392/// rendered using 'dot'.
393///
394void ScheduleDAG::viewGraph() {
395// This code is only for debugging!
396#ifndef NDEBUG
397  ViewGraph(this, "dag." + MF->getFunction()->getName(),
398            "Scheduling-Units Graph for " + MF->getFunction()->getName() + ':' +
399            BB->getBasicBlock()->getName());
400#else
401  cerr << "ScheduleDAG::viewGraph is only available in debug builds on "
402       << "systems with Graphviz or gv!\n";
403#endif  // NDEBUG
404}
405