lib/CodeGen/SelectionDAG/SelectionDAGPrinter.cpp

   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>
  30 using namespace llvm;
  31
  32 namespace 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
 119 std::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     Op += " A=" + itostr(1 << CP->getAlignment());
 162   } else if (const BasicBlockSDNode *BBDN = dyn_cast<BasicBlockSDNode>(Node)) {
 163     Op = "BB: ";
 164     const Value *LBB = (const Value*)BBDN->getBasicBlock()->getBasicBlock();
 165     if (LBB)
 166       Op += LBB->getName();
 167     //Op += " " + (const void*)BBDN->getBasicBlock();
 168   } else if (const RegisterSDNode *R = dyn_cast<RegisterSDNode>(Node)) {
 169     if (G && R->getReg() != 0 &&
 170         TargetRegisterInfo::isPhysicalRegister(R->getReg())) {
 171       Op = Op + " " +
 172         G->getTarget().getRegisterInfo()->getName(R->getReg());
 173     } else {
 174       Op += " #" + utostr(R->getReg());
 175     }
 176   } else if (const DbgStopPointSDNode *D = dyn_cast<DbgStopPointSDNode>(Node)) {
 177     Op += ": " + D->getCompileUnit()->getFileName();
 178     Op += ":" + utostr(D->getLine());
 179     if (D->getColumn() != 0)
 180       Op += ":" + utostr(D->getColumn());
 181   } else if (const LabelSDNode *L = dyn_cast<LabelSDNode>(Node)) {
 182     Op += ": LabelID=" + utostr(L->getLabelID());
 183   } else if (const CallSDNode *C = dyn_cast<CallSDNode>(Node)) {
 184     Op += ": CallingConv=" + utostr(C->getCallingConv());
 185     if (C->isVarArg())
 186       Op += ", isVarArg";
 187     if (C->isTailCall())
 188       Op += ", isTailCall";
 189   } else if (const ExternalSymbolSDNode *ES =
 190              dyn_cast<ExternalSymbolSDNode>(Node)) {
 191     Op += "'" + std::string(ES->getSymbol()) + "'";
 192   } else if (const SrcValueSDNode *M = dyn_cast<SrcValueSDNode>(Node)) {
 193     if (M->getValue())
 194       Op += "<" + M->getValue()->getName() + ">";
 195     else
 196       Op += "<null>";
 197   } else if (const MemOperandSDNode *M = dyn_cast<MemOperandSDNode>(Node)) {
 198     const Value *V = M->MO.getValue();
 199     Op += '<';
 200     if (!V) {
 201       Op += "(unknown)";
 202     } else if (isa<PseudoSourceValue>(V)) {
 203       // PseudoSourceValues don't have names, so use their print method.
 204       {
 205         raw_string_ostream OSS(Op);
 206         OSS << *M->MO.getValue();
 207       }
 208     } else {
 209       Op += V->getName();
 210     }
 211     Op += '+' + itostr(M->MO.getOffset()) + '>';
 212   } else if (const ARG_FLAGSSDNode *N = dyn_cast<ARG_FLAGSSDNode>(Node)) {
 213     Op = Op + " AF=" + N->getArgFlags().getArgFlagsString();
 214   } else if (const VTSDNode *N = dyn_cast<VTSDNode>(Node)) {
 215     Op = Op + " VT=" + N->getVT().getMVTString();
 216   } else if (const LoadSDNode *LD = dyn_cast<LoadSDNode>(Node)) {
 217     bool doExt = true;
 218     switch (LD->getExtensionType()) {
 219     default: doExt = false; break;
 220     case ISD::EXTLOAD:
 221       Op = Op + "<anyext ";
 222       break;
 223     case ISD::SEXTLOAD:
 224       Op = Op + " <sext ";
 225       break;
 226     case ISD::ZEXTLOAD:
 227       Op = Op + " <zext ";
 228       break;
 229     }
 230     if (doExt)
 231       Op += LD->getMemoryVT().getMVTString() + ">";
 232     if (LD->isVolatile())
 233       Op += "<V>";
 234     Op += LD->getIndexedModeName(LD->getAddressingMode());
 235     if (LD->getAlignment() > 1)
 236       Op += " A=" + utostr(LD->getAlignment());
 237   } else if (const StoreSDNode *ST = dyn_cast<StoreSDNode>(Node)) {
 238     if (ST->isTruncatingStore())
 239       Op += "<trunc " + ST->getMemoryVT().getMVTString() + ">";
 240     if (ST->isVolatile())
 241       Op += "<V>";
 242     Op += ST->getIndexedModeName(ST->getAddressingMode());
 243     if (ST->getAlignment() > 1)
 244       Op += " A=" + utostr(ST->getAlignment());
 245   }
 246
 247 #if 0
 248   Op += " Id=" + itostr(Node->getNodeId());
 249 #endif
 250
 251   return Op;
 252 }
 253
 254
 255 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
 256 /// rendered using 'dot'.
 257 ///
 258 void SelectionDAG::viewGraph(const std::string &Title) {
 259 // This code is only for debugging!
 260 #ifndef NDEBUG
 261   ViewGraph(this, "dag." + getMachineFunction().getFunction()->getName(),
 262             Title);
 263 #else
 264   cerr << "SelectionDAG::viewGraph is only available in debug builds on "
 265        << "systems with Graphviz or gv!\n";
 266 #endif  // NDEBUG
 267 }
 268
 269 // This overload is defined out-of-line here instead of just using a
 270 // default parameter because this is easiest for gdb to call.
 271 void SelectionDAG::viewGraph() {
 272   viewGraph("");
 273 }
 274
 275 /// clearGraphAttrs - Clear all previously defined node graph attributes.
 276 /// Intended to be used from a debugging tool (eg. gdb).
 277 void SelectionDAG::clearGraphAttrs() {
 278 #ifndef NDEBUG
 279   NodeGraphAttrs.clear();
 280 #else
 281   cerr << "SelectionDAG::clearGraphAttrs is only available in debug builds"
 282        << " on systems with Graphviz or gv!\n";
 283 #endif
 284 }
 285
 286
 287 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
 288 ///
 289 void SelectionDAG::setGraphAttrs(const SDNode *N, const char *Attrs) {
 290 #ifndef NDEBUG
 291   NodeGraphAttrs[N] = Attrs;
 292 #else
 293   cerr << "SelectionDAG::setGraphAttrs is only available in debug builds"
 294        << " on systems with Graphviz or gv!\n";
 295 #endif
 296 }
 297
 298
 299 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
 300 /// Used from getNodeAttributes.
 301 const std::string SelectionDAG::getGraphAttrs(const SDNode *N) const {
 302 #ifndef NDEBUG
 303   std::map<const SDNode *, std::string>::const_iterator I =
 304     NodeGraphAttrs.find(N);
 305
 306   if (I != NodeGraphAttrs.end())
 307     return I->second;
 308   else
 309     return "";
 310 #else
 311   cerr << "SelectionDAG::getGraphAttrs is only available in debug builds"
 312        << " on systems with Graphviz or gv!\n";
 313   return std::string("");
 314 #endif
 315 }
 316
 317 /// setGraphColor - Convenience for setting node color attribute.
 318 ///
 319 void SelectionDAG::setGraphColor(const SDNode *N, const char *Color) {
 320 #ifndef NDEBUG
 321   NodeGraphAttrs[N] = std::string("color=") + Color;
 322 #else
 323   cerr << "SelectionDAG::setGraphColor is only available in debug builds"
 324        << " on systems with Graphviz or gv!\n";
 325 #endif
 326 }
 327
 328 namespace llvm {
 329   template<>
 330   struct DOTGraphTraits<ScheduleDAG*> : public DefaultDOTGraphTraits {
 331     static std::string getGraphName(const ScheduleDAG *G) {
 332       return DOTGraphTraits<SelectionDAG*>::getGraphName(&G->DAG);
 333     }
 334
 335     static bool renderGraphFromBottomUp() {
 336       return true;
 337     }
 338
 339     static bool hasNodeAddressLabel(const SUnit *Node,
 340                                     const ScheduleDAG *Graph) {
 341       return true;
 342     }
 343
 344     /// If you want to override the dot attributes printed for a particular
 345     /// edge, override this method.
 346     template<typename EdgeIter>
 347     static std::string getEdgeAttributes(const void *Node, EdgeIter EI) {
 348       if (EI.isSpecialDep())
 349         return "color=cyan,style=dashed";
 350       if (EI.isCtrlDep())
 351         return "color=blue,style=dashed";
 352       return "";
 353     }
 354
 355
 356     static std::string getNodeLabel(const SUnit *Node,
 357                                     const ScheduleDAG *Graph);
 358     static std::string getNodeAttributes(const SUnit *N,
 359                                          const ScheduleDAG *Graph) {
 360       return "shape=Mrecord";
 361     }
 362
 363     static void addCustomGraphFeatures(ScheduleDAG *G,
 364                                        GraphWriter<ScheduleDAG*> &GW) {
 365       GW.emitSimpleNode(0, "plaintext=circle", "GraphRoot");
 366       const SDNode *N = G->DAG.getRoot().getNode();
 367       if (N && N->getNodeId() != -1)
 368         GW.emitEdge(0, -1, &G->SUnits[N->getNodeId()], -1,
 369                     "color=blue,style=dashed");
 370     }
 371   };
 372 }
 373
 374 std::string DOTGraphTraits<ScheduleDAG*>::getNodeLabel(const SUnit *SU,
 375                                                        const ScheduleDAG *G) {
 376   std::string Op;
 377
 378   for (unsigned i = 0; i < SU->FlaggedNodes.size(); ++i) {
 379     Op += DOTGraphTraits<SelectionDAG*>::getNodeLabel(SU->FlaggedNodes[i],
 380                                                       &G->DAG) + "\n";
 381   }
 382
 383   if (SU->Node)
 384     Op += DOTGraphTraits<SelectionDAG*>::getNodeLabel(SU->Node, &G->DAG);
 385   else
 386     Op += "<CROSS RC COPY>";
 387
 388   return Op;
 389 }
 390
 391
 392 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
 393 /// rendered using 'dot'.
 394 ///
 395 void ScheduleDAG::viewGraph() {
 396 // This code is only for debugging!
 397 #ifndef NDEBUG
 398   ViewGraph(this, "dag." + MF->getFunction()->getName(),
 399             "Scheduling-Units Graph for " + MF->getFunction()->getName() + ':' +
 400             BB->getBasicBlock()->getName());
 401 #else
 402   cerr << "ScheduleDAG::viewGraph is only available in debug builds on "
 403        << "systems with Graphviz or gv!\n";
 404 #endif  // NDEBUG
 405 }