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/ADT/StringExtras.h"
27 #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()).ResNo);
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().Val)
113 GW.emitEdge(0, -1, G->getRoot().Val, G->getRoot().ResNo,
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->getValue());
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();
132 Op += "+" + itostr(offset);
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 std::ostringstream SS;
142 CP->getMachineCPVal()->print(SS);
143 Op += "<" + SS.str() + ">";
145 if (ConstantFP *CFP = dyn_cast<ConstantFP>(CP->getConstVal()))
146 Op += "<" + ftostr(CFP->getValueAPF()) + ">";
147 else if (ConstantInt *CI = dyn_cast<ConstantInt>(CP->getConstVal()))
148 Op += "<" + utostr(CI->getZExtValue()) + ">";
150 std::ostringstream SS;
151 WriteAsOperand(SS, CP->getConstVal(), false);
152 Op += "<" + SS.str() + ">";
155 } else if (const BasicBlockSDNode *BBDN = dyn_cast<BasicBlockSDNode>(Node)) {
157 const Value *LBB = (const Value*)BBDN->getBasicBlock()->getBasicBlock();
159 Op += LBB->getName();
160 //Op += " " + (const void*)BBDN->getBasicBlock();
161 } else if (const RegisterSDNode *R = dyn_cast<RegisterSDNode>(Node)) {
162 if (G && R->getReg() != 0 &&
163 TargetRegisterInfo::isPhysicalRegister(R->getReg())) {
165 G->getTarget().getRegisterInfo()->getName(R->getReg());
167 Op += " #" + utostr(R->getReg());
169 } else if (const DbgStopPointSDNode *D = dyn_cast<DbgStopPointSDNode>(Node)) {
170 Op += ": " + D->getCompileUnit()->getFileName();
171 Op += ":" + utostr(D->getLine());
172 if (D->getColumn() != 0)
173 Op += ":" + utostr(D->getColumn());
174 } else if (const LabelSDNode *L = dyn_cast<LabelSDNode>(Node)) {
175 Op += ": LabelID=" + utostr(L->getLabelID());
176 } else if (const ExternalSymbolSDNode *ES =
177 dyn_cast<ExternalSymbolSDNode>(Node)) {
178 Op += "'" + std::string(ES->getSymbol()) + "'";
179 } else if (const SrcValueSDNode *M = dyn_cast<SrcValueSDNode>(Node)) {
181 Op += "<" + M->getValue()->getName() + ">";
184 } else if (const MemOperandSDNode *M = dyn_cast<MemOperandSDNode>(Node)) {
185 const Value *V = M->MO.getValue();
189 } else if (isa<PseudoSourceValue>(V)) {
190 // PseudoSourceValues don't have names, so use their print method.
191 std::ostringstream SS;
192 M->MO.getValue()->print(SS);
197 Op += '+' + itostr(M->MO.getOffset()) + '>';
198 } else if (const ARG_FLAGSSDNode *N = dyn_cast<ARG_FLAGSSDNode>(Node)) {
199 Op = Op + " AF=" + N->getArgFlags().getArgFlagsString();
200 } else if (const VTSDNode *N = dyn_cast<VTSDNode>(Node)) {
201 Op = Op + " VT=" + N->getVT().getMVTString();
202 } else if (const LoadSDNode *LD = dyn_cast<LoadSDNode>(Node)) {
204 switch (LD->getExtensionType()) {
205 default: doExt = false; break;
207 Op = Op + "<anyext ";
217 Op += LD->getMemoryVT().getMVTString() + ">";
218 if (LD->isVolatile())
220 Op += LD->getIndexedModeName(LD->getAddressingMode());
221 if (LD->getAlignment() > 1)
222 Op += " A=" + utostr(LD->getAlignment());
223 } else if (const StoreSDNode *ST = dyn_cast<StoreSDNode>(Node)) {
224 if (ST->isTruncatingStore())
225 Op += "<trunc " + ST->getMemoryVT().getMVTString() + ">";
226 if (ST->isVolatile())
228 Op += ST->getIndexedModeName(ST->getAddressingMode());
229 if (ST->getAlignment() > 1)
230 Op += " A=" + utostr(ST->getAlignment());
234 Op += " Id=" + itostr(Node->getNodeId());
241 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
242 /// rendered using 'dot'.
244 void SelectionDAG::viewGraph(const std::string &Title) {
245 // This code is only for debugging!
247 ViewGraph(this, "dag." + getMachineFunction().getFunction()->getName(),
250 cerr << "SelectionDAG::viewGraph is only available in debug builds on "
251 << "systems with Graphviz or gv!\n";
256 /// clearGraphAttrs - Clear all previously defined node graph attributes.
257 /// Intended to be used from a debugging tool (eg. gdb).
258 void SelectionDAG::clearGraphAttrs() {
260 NodeGraphAttrs.clear();
262 cerr << "SelectionDAG::clearGraphAttrs is only available in debug builds"
263 << " on systems with Graphviz or gv!\n";
268 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
270 void SelectionDAG::setGraphAttrs(const SDNode *N, const char *Attrs) {
272 NodeGraphAttrs[N] = Attrs;
274 cerr << "SelectionDAG::setGraphAttrs is only available in debug builds"
275 << " on systems with Graphviz or gv!\n";
280 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
281 /// Used from getNodeAttributes.
282 const std::string SelectionDAG::getGraphAttrs(const SDNode *N) const {
284 std::map<const SDNode *, std::string>::const_iterator I =
285 NodeGraphAttrs.find(N);
287 if (I != NodeGraphAttrs.end())
292 cerr << "SelectionDAG::getGraphAttrs is only available in debug builds"
293 << " on systems with Graphviz or gv!\n";
294 return std::string("");
298 /// setGraphColor - Convenience for setting node color attribute.
300 void SelectionDAG::setGraphColor(const SDNode *N, const char *Color) {
302 NodeGraphAttrs[N] = std::string("color=") + Color;
304 cerr << "SelectionDAG::setGraphColor is only available in debug builds"
305 << " on systems with Graphviz or gv!\n";
311 struct DOTGraphTraits<ScheduleDAG*> : public DefaultDOTGraphTraits {
312 static std::string getGraphName(const ScheduleDAG *G) {
313 return DOTGraphTraits<SelectionDAG*>::getGraphName(&G->DAG);
316 static bool renderGraphFromBottomUp() {
320 static bool hasNodeAddressLabel(const SUnit *Node,
321 const ScheduleDAG *Graph) {
325 /// If you want to override the dot attributes printed for a particular
326 /// edge, override this method.
327 template<typename EdgeIter>
328 static std::string getEdgeAttributes(const void *Node, EdgeIter EI) {
329 if (EI.isSpecialDep())
330 return "color=cyan,style=dashed";
332 return "color=blue,style=dashed";
337 static std::string getNodeLabel(const SUnit *Node,
338 const ScheduleDAG *Graph);
339 static std::string getNodeAttributes(const SUnit *N,
340 const ScheduleDAG *Graph) {
341 return "shape=Mrecord";
344 static void addCustomGraphFeatures(ScheduleDAG *G,
345 GraphWriter<ScheduleDAG*> &GW) {
346 GW.emitSimpleNode(0, "plaintext=circle", "GraphRoot");
347 const SDNode *N = G->DAG.getRoot().Val;
348 if (N && N->getNodeId() != -1)
349 GW.emitEdge(0, -1, &G->SUnits[N->getNodeId()], -1,
350 "color=blue,style=dashed");
355 std::string DOTGraphTraits<ScheduleDAG*>::getNodeLabel(const SUnit *SU,
356 const ScheduleDAG *G) {
359 for (unsigned i = 0; i < SU->FlaggedNodes.size(); ++i) {
360 Op += DOTGraphTraits<SelectionDAG*>::getNodeLabel(SU->FlaggedNodes[i],
365 Op += DOTGraphTraits<SelectionDAG*>::getNodeLabel(SU->Node, &G->DAG);
367 Op += "<CROSS RC COPY>";
373 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
374 /// rendered using 'dot'.
376 void ScheduleDAG::viewGraph() {
377 // This code is only for debugging!
379 ViewGraph(this, "dag." + MF->getFunction()->getName(),
380 "Scheduling-Units Graph for " + MF->getFunction()->getName() + ':' +
381 BB->getBasicBlock()->getName());
383 cerr << "ScheduleDAG::viewGraph is only available in debug builds on "
384 << "systems with Graphviz or gv!\n";