1 //===-- SelectionDAGPrinter.cpp - Implement SelectionDAG::viewGraph() -----===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This implements the SelectionDAG::viewGraph method.
12 //===----------------------------------------------------------------------===//
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/ScheduleDAGSDNodes.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"
37 struct DOTGraphTraits<SelectionDAG*> : public DefaultDOTGraphTraits {
38 static bool hasEdgeDestLabels() {
42 static unsigned numEdgeDestLabels(const void *Node) {
43 return ((const SDNode *) Node)->getNumValues();
46 static std::string getEdgeDestLabel(const void *Node, unsigned i) {
47 return ((const SDNode *) Node)->getValueType(i).getMVTString();
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) {
58 /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
59 /// called to determine which outgoing edge of Node is the target of this
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());
69 static std::string getGraphName(const SelectionDAG *G) {
70 return G->getMachineFunction().getFunction()->getName();
73 static bool renderGraphFromBottomUp() {
77 static bool hasNodeAddressLabel(const SDNode *Node,
78 const SelectionDAG *Graph) {
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();
89 return "color=red,style=bold";
90 else if (VT == MVT::Other)
91 return "color=blue,style=dashed";
96 static std::string getNodeLabel(const SDNode *Node,
97 const SelectionDAG *Graph);
98 static std::string getNodeAttributes(const SDNode *N,
99 const SelectionDAG *Graph) {
101 const std::string &Attrs = Graph->getGraphAttrs(N);
102 if (!Attrs.empty()) {
103 if (Attrs.find("shape=") == std::string::npos)
104 return std::string("shape=Mrecord,") + Attrs;
109 return "shape=Mrecord";
112 static void addCustomGraphFeatures(SelectionDAG *G,
113 GraphWriter<SelectionDAG*> &GW) {
114 GW.emitSimpleNode(0, "plaintext=circle", "GraphRoot");
115 if (G->getRoot().getNode())
116 GW.emitEdge(0, -1, G->getRoot().getNode(), G->getRoot().getResNo(),
117 "color=blue,style=dashed");
122 std::string DOTGraphTraits<SelectionDAG*>::getNodeLabel(const SDNode *Node,
123 const SelectionDAG *G) {
124 std::string Op = Node->getOperationName(G);
126 if (const ConstantSDNode *CSDN = dyn_cast<ConstantSDNode>(Node)) {
127 Op += ": " + utostr(CSDN->getZExtValue());
128 } else if (const ConstantFPSDNode *CSDN = dyn_cast<ConstantFPSDNode>(Node)) {
129 Op += ": " + ftostr(CSDN->getValueAPF());
130 } else if (const GlobalAddressSDNode *GADN =
131 dyn_cast<GlobalAddressSDNode>(Node)) {
132 Op += ": " + GADN->getGlobal()->getName();
133 if (int64_t Offset = GADN->getOffset()) {
135 Op += "+" + itostr(Offset);
137 Op += itostr(Offset);
139 } else if (const FrameIndexSDNode *FIDN = dyn_cast<FrameIndexSDNode>(Node)) {
140 Op += " " + itostr(FIDN->getIndex());
141 } else if (const JumpTableSDNode *JTDN = dyn_cast<JumpTableSDNode>(Node)) {
142 Op += " " + itostr(JTDN->getIndex());
143 } else if (const ConstantPoolSDNode *CP = dyn_cast<ConstantPoolSDNode>(Node)){
144 if (CP->isMachineConstantPoolEntry()) {
147 raw_string_ostream OSS(Op);
148 OSS << *CP->getMachineCPVal();
152 if (ConstantFP *CFP = dyn_cast<ConstantFP>(CP->getConstVal()))
153 Op += "<" + ftostr(CFP->getValueAPF()) + ">";
154 else if (ConstantInt *CI = dyn_cast<ConstantInt>(CP->getConstVal()))
155 Op += "<" + utostr(CI->getZExtValue()) + ">";
159 raw_string_ostream OSS(Op);
160 WriteAsOperand(OSS, CP->getConstVal(), false);
165 Op += " A=" + itostr(1 << CP->getAlignment());
166 } else if (const BasicBlockSDNode *BBDN = dyn_cast<BasicBlockSDNode>(Node)) {
168 const Value *LBB = (const Value*)BBDN->getBasicBlock()->getBasicBlock();
170 Op += LBB->getName();
171 //Op += " " + (const void*)BBDN->getBasicBlock();
172 } else if (const RegisterSDNode *R = dyn_cast<RegisterSDNode>(Node)) {
173 if (G && R->getReg() != 0 &&
174 TargetRegisterInfo::isPhysicalRegister(R->getReg())) {
176 G->getTarget().getRegisterInfo()->getName(R->getReg());
178 Op += " #" + utostr(R->getReg());
180 } else if (const DbgStopPointSDNode *D = dyn_cast<DbgStopPointSDNode>(Node)) {
181 DICompileUnit CU(cast<GlobalVariable>(D->getCompileUnit()));
182 Op += ": " + CU.getFilename();
183 Op += ":" + utostr(D->getLine());
184 if (D->getColumn() != 0)
185 Op += ":" + utostr(D->getColumn());
186 } else if (const LabelSDNode *L = dyn_cast<LabelSDNode>(Node)) {
187 Op += ": LabelID=" + utostr(L->getLabelID());
188 } else if (const CallSDNode *C = dyn_cast<CallSDNode>(Node)) {
189 Op += ": CallingConv=" + utostr(C->getCallingConv());
193 Op += ", isTailCall";
194 } else if (const ExternalSymbolSDNode *ES =
195 dyn_cast<ExternalSymbolSDNode>(Node)) {
196 Op += "'" + std::string(ES->getSymbol()) + "'";
197 } else if (const SrcValueSDNode *M = dyn_cast<SrcValueSDNode>(Node)) {
199 Op += "<" + M->getValue()->getName() + ">";
202 } else if (const MemOperandSDNode *M = dyn_cast<MemOperandSDNode>(Node)) {
203 const Value *V = M->MO.getValue();
207 } else if (const PseudoSourceValue *PSV = dyn_cast<PseudoSourceValue>(V)) {
208 // PseudoSourceValues don't have names, so use their print method.
209 raw_string_ostream OSS(Op);
214 Op += '+' + itostr(M->MO.getOffset()) + '>';
215 } else if (const ARG_FLAGSSDNode *N = dyn_cast<ARG_FLAGSSDNode>(Node)) {
216 Op = Op + " AF=" + N->getArgFlags().getArgFlagsString();
217 } else if (const VTSDNode *N = dyn_cast<VTSDNode>(Node)) {
218 Op = Op + " VT=" + N->getVT().getMVTString();
219 } else if (const LoadSDNode *LD = dyn_cast<LoadSDNode>(Node)) {
221 switch (LD->getExtensionType()) {
222 default: doExt = false; break;
224 Op = Op + "<anyext ";
234 Op += LD->getMemoryVT().getMVTString() + ">";
235 if (LD->isVolatile())
237 Op += LD->getIndexedModeName(LD->getAddressingMode());
238 if (LD->getAlignment() > 1)
239 Op += " A=" + utostr(LD->getAlignment());
240 } else if (const StoreSDNode *ST = dyn_cast<StoreSDNode>(Node)) {
241 if (ST->isTruncatingStore())
242 Op += "<trunc " + ST->getMemoryVT().getMVTString() + ">";
243 if (ST->isVolatile())
245 Op += ST->getIndexedModeName(ST->getAddressingMode());
246 if (ST->getAlignment() > 1)
247 Op += " A=" + utostr(ST->getAlignment());
251 Op += " Id=" + itostr(Node->getNodeId());
258 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
259 /// rendered using 'dot'.
261 void SelectionDAG::viewGraph(const std::string &Title) {
262 // This code is only for debugging!
264 ViewGraph(this, "dag." + getMachineFunction().getFunction()->getName(),
267 cerr << "SelectionDAG::viewGraph is only available in debug builds on "
268 << "systems with Graphviz or gv!\n";
272 // This overload is defined out-of-line here instead of just using a
273 // default parameter because this is easiest for gdb to call.
274 void SelectionDAG::viewGraph() {
278 /// clearGraphAttrs - Clear all previously defined node graph attributes.
279 /// Intended to be used from a debugging tool (eg. gdb).
280 void SelectionDAG::clearGraphAttrs() {
282 NodeGraphAttrs.clear();
284 cerr << "SelectionDAG::clearGraphAttrs is only available in debug builds"
285 << " on systems with Graphviz or gv!\n";
290 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
292 void SelectionDAG::setGraphAttrs(const SDNode *N, const char *Attrs) {
294 NodeGraphAttrs[N] = Attrs;
296 cerr << "SelectionDAG::setGraphAttrs is only available in debug builds"
297 << " on systems with Graphviz or gv!\n";
302 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
303 /// Used from getNodeAttributes.
304 const std::string SelectionDAG::getGraphAttrs(const SDNode *N) const {
306 std::map<const SDNode *, std::string>::const_iterator I =
307 NodeGraphAttrs.find(N);
309 if (I != NodeGraphAttrs.end())
314 cerr << "SelectionDAG::getGraphAttrs is only available in debug builds"
315 << " on systems with Graphviz or gv!\n";
316 return std::string("");
320 /// setGraphColor - Convenience for setting node color attribute.
322 void SelectionDAG::setGraphColor(const SDNode *N, const char *Color) {
324 NodeGraphAttrs[N] = std::string("color=") + Color;
326 cerr << "SelectionDAG::setGraphColor is only available in debug builds"
327 << " on systems with Graphviz or gv!\n";
331 /// setSubgraphColorHelper - Implement setSubgraphColor. Return
332 /// whether we truncated the search.
334 bool SelectionDAG::setSubgraphColorHelper(SDNode *N, const char *Color, DenseSet<SDNode *> &visited,
335 int level, bool &printed) {
336 bool hit_limit = false;
342 DOUT << "setSubgraphColor hit max level\n";
347 unsigned oldSize = visited.size();
349 if (visited.size() != oldSize) {
350 setGraphColor(N, Color);
351 for(SDNodeIterator i = SDNodeIterator::begin(N), iend = SDNodeIterator::end(N);
354 hit_limit = setSubgraphColorHelper(*i, Color, visited, level+1, printed) || hit_limit;
358 cerr << "SelectionDAG::setSubgraphColor is only available in debug builds"
359 << " on systems with Graphviz or gv!\n";
364 /// setSubgraphColor - Convenience for setting subgraph color attribute.
366 void SelectionDAG::setSubgraphColor(SDNode *N, const char *Color) {
368 DenseSet<SDNode *> visited;
369 bool printed = false;
370 if (setSubgraphColorHelper(N, Color, visited, 0, printed)) {
371 // Visually mark that we hit the limit
372 if (strcmp(Color, "red") == 0) {
373 setSubgraphColorHelper(N, "blue", visited, 0, printed);
375 else if (strcmp(Color, "yellow") == 0) {
376 setSubgraphColorHelper(N, "green", visited, 0, printed);
381 cerr << "SelectionDAG::setSubgraphColor is only available in debug builds"
382 << " on systems with Graphviz or gv!\n";
386 std::string ScheduleDAGSDNodes::getGraphNodeLabel(const SUnit *SU) const {
388 raw_string_ostream O(s);
389 O << "SU(" << SU->NodeNum << "): ";
391 SmallVector<SDNode *, 4> FlaggedNodes;
392 for (SDNode *N = SU->getNode(); N; N = N->getFlaggedNode())
393 FlaggedNodes.push_back(N);
394 while (!FlaggedNodes.empty()) {
395 O << DOTGraphTraits<SelectionDAG*>::getNodeLabel(FlaggedNodes.back(), DAG);
396 FlaggedNodes.pop_back();
397 if (!FlaggedNodes.empty())
401 O << "CROSS RC COPY";
406 void ScheduleDAGSDNodes::getCustomGraphFeatures(GraphWriter<ScheduleDAG*> &GW) const {
408 // Draw a special "GraphRoot" node to indicate the root of the graph.
409 GW.emitSimpleNode(0, "plaintext=circle", "GraphRoot");
410 const SDNode *N = DAG->getRoot().getNode();
411 if (N && N->getNodeId() != -1)
412 GW.emitEdge(0, -1, &SUnits[N->getNodeId()], -1,
413 "color=blue,style=dashed");