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