lib/CodeGen/SelectionDAG/SelectionDAGPrinter.cpp

   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>
  27 using namespace llvm;
  28
  29 namespace 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
  84 std::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 ConstantPoolSDNode *CP = dyn_cast<ConstantPoolSDNode>(Node)){
 109     if (CP->isMachineConstantPoolEntry()) {
 110       std::ostringstream SS;
 111       CP->getMachineCPVal()->print(SS);
 112       Op += "<" + SS.str() + ">";
 113     } else {
 114       if (ConstantFP *CFP = dyn_cast<ConstantFP>(CP->getConstVal()))
 115         Op += "<" + ftostr(CFP->getValue()) + ">";
 116       else if (ConstantInt *CI = dyn_cast<ConstantInt>(CP->getConstVal()))
 117         Op += "<" + utostr(CI->getZExtValue()) + ">";
 118       else {
 119         std::ostringstream SS;
 120         WriteAsOperand(SS, CP->getConstVal(), false);
 121         Op += "<" + SS.str() + ">";
 122       }
 123     }
 124   } else if (const BasicBlockSDNode *BBDN = dyn_cast<BasicBlockSDNode>(Node)) {
 125     Op = "BB: ";
 126     const Value *LBB = (const Value*)BBDN->getBasicBlock()->getBasicBlock();
 127     if (LBB)
 128       Op += LBB->getName();
 129     //Op += " " + (const void*)BBDN->getBasicBlock();
 130   } else if (const RegisterSDNode *R = dyn_cast<RegisterSDNode>(Node)) {
 131     if (G && R->getReg() != 0 &&
 132         MRegisterInfo::isPhysicalRegister(R->getReg())) {
 133       Op = Op + " " + G->getTarget().getRegisterInfo()->getName(R->getReg());
 134     } else {
 135       Op += " #" + utostr(R->getReg());
 136     }
 137   } else if (const ExternalSymbolSDNode *ES =
 138              dyn_cast<ExternalSymbolSDNode>(Node)) {
 139     Op += "'" + std::string(ES->getSymbol()) + "'";
 140   } else if (const SrcValueSDNode *M = dyn_cast<SrcValueSDNode>(Node)) {
 141     if (M->getValue())
 142       Op += "<" + M->getValue()->getName() + ":" + itostr(M->getOffset()) + ">";
 143     else
 144       Op += "<null:" + itostr(M->getOffset()) + ">";
 145   } else if (const VTSDNode *N = dyn_cast<VTSDNode>(Node)) {
 146     Op = Op + " VT=" + getValueTypeString(N->getVT());
 147   } else if (const StringSDNode *N = dyn_cast<StringSDNode>(Node)) {
 148     Op = Op + "\"" + N->getValue() + "\"";
 149   } else if (const LoadSDNode *LD = dyn_cast<LoadSDNode>(Node)) {
 150     bool doExt = true;
 151     switch (LD->getExtensionType()) {
 152     default: doExt = false; break;
 153     case ISD::EXTLOAD:
 154       Op = Op + "<anyext ";
 155       break;
 156     case ISD::SEXTLOAD:
 157       Op = Op + " <sext ";
 158       break;
 159     case ISD::ZEXTLOAD:
 160       Op = Op + " <zext ";
 161       break;
 162     }
 163     if (doExt)
 164       Op = Op + MVT::getValueTypeString(LD->getLoadedVT()) + ">";
 165
 166     Op += LD->getAddressingModeName(LD->getAddressingMode());
 167   } else if (const StoreSDNode *ST = dyn_cast<StoreSDNode>(Node)) {
 168     if (ST->isTruncatingStore())
 169       Op = Op + "<trunc " + MVT::getValueTypeString(ST->getStoredVT()) + ">";
 170     Op += ST->getAddressingModeName(ST->getAddressingMode());
 171   }
 172
 173   return Op;
 174 }
 175
 176
 177 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
 178 /// rendered using 'dot'.
 179 ///
 180 void SelectionDAG::viewGraph() {
 181 // This code is only for debugging!
 182 #ifndef NDEBUG
 183   ViewGraph(this, "dag." + getMachineFunction().getFunction()->getName());
 184 #else
 185   std::cerr << "SelectionDAG::viewGraph is only available in debug builds on "
 186             << "systems with Graphviz or gv!\n";
 187 #endif  // NDEBUG
 188 }
 189
 190
 191 /// clearGraphAttrs - Clear all previously defined node graph attributes.
 192 /// Intended to be used from a debugging tool (eg. gdb).
 193 void SelectionDAG::clearGraphAttrs() {
 194 #ifndef NDEBUG
 195   NodeGraphAttrs.clear();
 196 #else
 197   std::cerr << "SelectionDAG::clearGraphAttrs is only available in debug builds"
 198             << " on systems with Graphviz or gv!\n";
 199 #endif
 200 }
 201
 202
 203 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
 204 ///
 205 void SelectionDAG::setGraphAttrs(const SDNode *N, const char *Attrs) {
 206 #ifndef NDEBUG
 207   NodeGraphAttrs[N] = Attrs;
 208 #else
 209   std::cerr << "SelectionDAG::setGraphAttrs is only available in debug builds"
 210             << " on systems with Graphviz or gv!\n";
 211 #endif
 212 }
 213
 214
 215 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
 216 /// Used from getNodeAttributes.
 217 const std::string SelectionDAG::getGraphAttrs(const SDNode *N) const {
 218 #ifndef NDEBUG
 219   std::map<const SDNode *, std::string>::const_iterator I =
 220     NodeGraphAttrs.find(N);
 221
 222   if (I != NodeGraphAttrs.end())
 223     return I->second;
 224   else
 225     return "";
 226 #else
 227   std::cerr << "SelectionDAG::getGraphAttrs is only available in debug builds"
 228             << " on systems with Graphviz or gv!\n";
 229   return std::string("");
 230 #endif
 231 }
 232
 233 /// setGraphColor - Convenience for setting node color attribute.
 234 ///
 235 void SelectionDAG::setGraphColor(const SDNode *N, const char *Color) {
 236 #ifndef NDEBUG
 237   NodeGraphAttrs[N] = std::string("color=") + Color;
 238 #else
 239   std::cerr << "SelectionDAG::setGraphColor is only available in debug builds"
 240             << " on systems with Graphviz or gv!\n";
 241 #endif
 242 }
 243