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/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"
34 struct DOTGraphTraits<SelectionDAG*> : public DefaultDOTGraphTraits {
35 static bool hasEdgeDestLabels() {
39 static unsigned numEdgeDestLabels(const void *Node) {
40 return ((const SDNode *) Node)->getNumValues();
43 static std::string getEdgeDestLabel(const void *Node, unsigned i) {
44 return ((const SDNode *) Node)->getValueType(i).getMVTString();
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) {
55 /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
56 /// called to determine which outgoing edge of Node is the target of this
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());
66 static std::string getGraphName(const SelectionDAG *G) {
67 return G->getMachineFunction().getFunction()->getName();
70 static bool renderGraphFromBottomUp() {
74 static bool hasNodeAddressLabel(const SDNode *Node,
75 const SelectionDAG *Graph) {
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();
86 return "color=red,style=bold";
87 else if (VT == MVT::Other)
88 return "color=blue,style=dashed";
93 static std::string getNodeLabel(const SDNode *Node,
94 const SelectionDAG *Graph);
95 static std::string getNodeAttributes(const SDNode *N,
96 const SelectionDAG *Graph) {
98 const std::string &Attrs = Graph->getGraphAttrs(N);
100 if (Attrs.find("shape=") == std::string::npos)
101 return std::string("shape=Mrecord,") + Attrs;
106 return "shape=Mrecord";
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");
119 std::string DOTGraphTraits<SelectionDAG*>::getNodeLabel(const SDNode *Node,
120 const SelectionDAG *G) {
121 std::string Op = Node->getOperationName(G);
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 Op += ": " + GADN->getGlobal()->getName();
130 if (int Offset = GADN->getOffset()) {
132 Op += "+" + itostr(Offset);
134 Op += itostr(Offset);
136 } else if (const FrameIndexSDNode *FIDN = dyn_cast<FrameIndexSDNode>(Node)) {
137 Op += " " + itostr(FIDN->getIndex());
138 } else if (const JumpTableSDNode *JTDN = dyn_cast<JumpTableSDNode>(Node)) {
139 Op += " " + itostr(JTDN->getIndex());
140 } else if (const ConstantPoolSDNode *CP = dyn_cast<ConstantPoolSDNode>(Node)){
141 if (CP->isMachineConstantPoolEntry()) {
144 raw_string_ostream OSS(Op);
145 OSS << *CP->getMachineCPVal();
149 if (ConstantFP *CFP = dyn_cast<ConstantFP>(CP->getConstVal()))
150 Op += "<" + ftostr(CFP->getValueAPF()) + ">";
151 else if (ConstantInt *CI = dyn_cast<ConstantInt>(CP->getConstVal()))
152 Op += "<" + utostr(CI->getZExtValue()) + ">";
156 raw_string_ostream OSS(Op);
157 WriteAsOperand(OSS, CP->getConstVal(), false);
162 Op += " A=" + itostr(1 << CP->getAlignment());
163 } else if (const BasicBlockSDNode *BBDN = dyn_cast<BasicBlockSDNode>(Node)) {
165 const Value *LBB = (const Value*)BBDN->getBasicBlock()->getBasicBlock();
167 Op += LBB->getName();
168 //Op += " " + (const void*)BBDN->getBasicBlock();
169 } else if (const RegisterSDNode *R = dyn_cast<RegisterSDNode>(Node)) {
170 if (G && R->getReg() != 0 &&
171 TargetRegisterInfo::isPhysicalRegister(R->getReg())) {
173 G->getTarget().getRegisterInfo()->getName(R->getReg());
175 Op += " #" + utostr(R->getReg());
177 } else if (const DbgStopPointSDNode *D = dyn_cast<DbgStopPointSDNode>(Node)) {
178 Op += ": " + D->getCompileUnit()->getFileName();
179 Op += ":" + utostr(D->getLine());
180 if (D->getColumn() != 0)
181 Op += ":" + utostr(D->getColumn());
182 } else if (const LabelSDNode *L = dyn_cast<LabelSDNode>(Node)) {
183 Op += ": LabelID=" + utostr(L->getLabelID());
184 } else if (const CallSDNode *C = dyn_cast<CallSDNode>(Node)) {
185 Op += ": CallingConv=" + utostr(C->getCallingConv());
189 Op += ", isTailCall";
190 } else if (const ExternalSymbolSDNode *ES =
191 dyn_cast<ExternalSymbolSDNode>(Node)) {
192 Op += "'" + std::string(ES->getSymbol()) + "'";
193 } else if (const SrcValueSDNode *M = dyn_cast<SrcValueSDNode>(Node)) {
195 Op += "<" + M->getValue()->getName() + ">";
198 } else if (const MemOperandSDNode *M = dyn_cast<MemOperandSDNode>(Node)) {
199 const Value *V = M->MO.getValue();
203 } else if (isa<PseudoSourceValue>(V)) {
204 // PseudoSourceValues don't have names, so use their print method.
206 raw_string_ostream OSS(Op);
207 OSS << *M->MO.getValue();
212 Op += '+' + itostr(M->MO.getOffset()) + '>';
213 } else if (const ARG_FLAGSSDNode *N = dyn_cast<ARG_FLAGSSDNode>(Node)) {
214 Op = Op + " AF=" + N->getArgFlags().getArgFlagsString();
215 } else if (const VTSDNode *N = dyn_cast<VTSDNode>(Node)) {
216 Op = Op + " VT=" + N->getVT().getMVTString();
217 } else if (const LoadSDNode *LD = dyn_cast<LoadSDNode>(Node)) {
219 switch (LD->getExtensionType()) {
220 default: doExt = false; break;
222 Op = Op + "<anyext ";
232 Op += LD->getMemoryVT().getMVTString() + ">";
233 if (LD->isVolatile())
235 Op += LD->getIndexedModeName(LD->getAddressingMode());
236 if (LD->getAlignment() > 1)
237 Op += " A=" + utostr(LD->getAlignment());
238 } else if (const StoreSDNode *ST = dyn_cast<StoreSDNode>(Node)) {
239 if (ST->isTruncatingStore())
240 Op += "<trunc " + ST->getMemoryVT().getMVTString() + ">";
241 if (ST->isVolatile())
243 Op += ST->getIndexedModeName(ST->getAddressingMode());
244 if (ST->getAlignment() > 1)
245 Op += " A=" + utostr(ST->getAlignment());
249 Op += " Id=" + itostr(Node->getNodeId());
256 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
257 /// rendered using 'dot'.
259 void SelectionDAG::viewGraph(const std::string &Title) {
260 // This code is only for debugging!
262 ViewGraph(this, "dag." + getMachineFunction().getFunction()->getName(),
265 cerr << "SelectionDAG::viewGraph is only available in debug builds on "
266 << "systems with Graphviz or gv!\n";
270 // This overload is defined out-of-line here instead of just using a
271 // default parameter because this is easiest for gdb to call.
272 void SelectionDAG::viewGraph() {
276 /// clearGraphAttrs - Clear all previously defined node graph attributes.
277 /// Intended to be used from a debugging tool (eg. gdb).
278 void SelectionDAG::clearGraphAttrs() {
280 NodeGraphAttrs.clear();
282 cerr << "SelectionDAG::clearGraphAttrs is only available in debug builds"
283 << " on systems with Graphviz or gv!\n";
288 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
290 void SelectionDAG::setGraphAttrs(const SDNode *N, const char *Attrs) {
292 NodeGraphAttrs[N] = Attrs;
294 cerr << "SelectionDAG::setGraphAttrs is only available in debug builds"
295 << " on systems with Graphviz or gv!\n";
300 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
301 /// Used from getNodeAttributes.
302 const std::string SelectionDAG::getGraphAttrs(const SDNode *N) const {
304 std::map<const SDNode *, std::string>::const_iterator I =
305 NodeGraphAttrs.find(N);
307 if (I != NodeGraphAttrs.end())
312 cerr << "SelectionDAG::getGraphAttrs is only available in debug builds"
313 << " on systems with Graphviz or gv!\n";
314 return std::string("");
318 /// setGraphColor - Convenience for setting node color attribute.
320 void SelectionDAG::setGraphColor(const SDNode *N, const char *Color) {
322 NodeGraphAttrs[N] = std::string("color=") + Color;
324 cerr << "SelectionDAG::setGraphColor is only available in debug builds"
325 << " on systems with Graphviz or gv!\n";
331 struct DOTGraphTraits<ScheduleDAG*> : public DefaultDOTGraphTraits {
332 static std::string getGraphName(const ScheduleDAG *G) {
333 return DOTGraphTraits<SelectionDAG*>::getGraphName(&G->DAG);
336 static bool renderGraphFromBottomUp() {
340 static bool hasNodeAddressLabel(const SUnit *Node,
341 const ScheduleDAG *Graph) {
345 /// If you want to override the dot attributes printed for a particular
346 /// edge, override this method.
347 template<typename EdgeIter>
348 static std::string getEdgeAttributes(const void *Node, EdgeIter EI) {
349 if (EI.isSpecialDep())
350 return "color=cyan,style=dashed";
352 return "color=blue,style=dashed";
357 static std::string getNodeLabel(const SUnit *Node,
358 const ScheduleDAG *Graph);
359 static std::string getNodeAttributes(const SUnit *N,
360 const ScheduleDAG *Graph) {
361 return "shape=Mrecord";
364 static void addCustomGraphFeatures(ScheduleDAG *G,
365 GraphWriter<ScheduleDAG*> &GW) {
366 GW.emitSimpleNode(0, "plaintext=circle", "GraphRoot");
367 const SDNode *N = G->DAG.getRoot().getNode();
368 if (N && N->getNodeId() != -1)
369 GW.emitEdge(0, -1, &G->SUnits[N->getNodeId()], -1,
370 "color=blue,style=dashed");
375 std::string DOTGraphTraits<ScheduleDAG*>::getNodeLabel(const SUnit *SU,
376 const ScheduleDAG *G) {
379 for (unsigned i = 0; i < SU->FlaggedNodes.size(); ++i) {
380 Op += DOTGraphTraits<SelectionDAG*>::getNodeLabel(SU->FlaggedNodes[i],
385 Op += DOTGraphTraits<SelectionDAG*>::getNodeLabel(SU->Node, &G->DAG);
387 Op += "<CROSS RC COPY>";
393 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
394 /// rendered using 'dot'.
396 void ScheduleDAG::viewGraph() {
397 // This code is only for debugging!
399 ViewGraph(this, "dag." + MF->getFunction()->getName(),
400 "Scheduling-Units Graph for " + MF->getFunction()->getName() + ':' +
401 BB->getBasicBlock()->getName());
403 cerr << "ScheduleDAG::viewGraph is only available in debug builds on "
404 << "systems with Graphviz or gv!\n";