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/CodeGen/SelectionDAG.h"
15 #include "ScheduleDAGSDNodes.h"
16 #include "llvm/ADT/DenseSet.h"
17 #include "llvm/ADT/StringExtras.h"
18 #include "llvm/CodeGen/MachineConstantPool.h"
19 #include "llvm/CodeGen/MachineFunction.h"
20 #include "llvm/CodeGen/MachineModuleInfo.h"
21 #include "llvm/IR/Constants.h"
22 #include "llvm/IR/DebugInfo.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/GraphWriter.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include "llvm/Target/TargetMachine.h"
27 #include "llvm/Target/TargetRegisterInfo.h"
30 #define DEBUG_TYPE "dag-printer"
34 struct DOTGraphTraits<SelectionDAG*> : public DefaultDOTGraphTraits {
36 explicit DOTGraphTraits(bool isSimple=false) :
37 DefaultDOTGraphTraits(isSimple) {}
39 static bool hasEdgeDestLabels() {
43 static unsigned numEdgeDestLabels(const void *Node) {
44 return ((const SDNode *) Node)->getNumValues();
47 static std::string getEdgeDestLabel(const void *Node, unsigned i) {
48 return ((const SDNode *) Node)->getValueType(i).getEVTString();
51 template<typename EdgeIter>
52 static std::string getEdgeSourceLabel(const void *Node, EdgeIter I) {
53 return itostr(I - SDNodeIterator::begin((const SDNode *) Node));
56 /// edgeTargetsEdgeSource - This method returns true if this outgoing edge
57 /// should actually target another edge source, not a node. If this method
58 /// is implemented, getEdgeTarget should be implemented.
59 template<typename EdgeIter>
60 static bool edgeTargetsEdgeSource(const void *Node, EdgeIter I) {
64 /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
65 /// called to determine which outgoing edge of Node is the target of this
67 template<typename EdgeIter>
68 static EdgeIter getEdgeTarget(const void *Node, EdgeIter I) {
69 SDNode *TargetNode = *I;
70 SDNodeIterator NI = SDNodeIterator::begin(TargetNode);
71 std::advance(NI, I.getNode()->getOperand(I.getOperand()).getResNo());
75 static std::string getGraphName(const SelectionDAG *G) {
76 return G->getMachineFunction().getName();
79 static bool renderGraphFromBottomUp() {
83 static bool hasNodeAddressLabel(const SDNode *Node,
84 const SelectionDAG *Graph) {
88 /// If you want to override the dot attributes printed for a particular
89 /// edge, override this method.
90 template<typename EdgeIter>
91 static std::string getEdgeAttributes(const void *Node, EdgeIter EI,
92 const SelectionDAG *Graph) {
93 SDValue Op = EI.getNode()->getOperand(EI.getOperand());
94 EVT VT = Op.getValueType();
96 return "color=red,style=bold";
97 else if (VT == MVT::Other)
98 return "color=blue,style=dashed";
103 static std::string getSimpleNodeLabel(const SDNode *Node,
104 const SelectionDAG *G) {
105 std::string Result = Node->getOperationName(G);
107 raw_string_ostream OS(Result);
108 Node->print_details(OS, G);
112 std::string getNodeLabel(const SDNode *Node, const SelectionDAG *Graph);
113 static std::string getNodeAttributes(const SDNode *N,
114 const SelectionDAG *Graph) {
116 const std::string &Attrs = Graph->getGraphAttrs(N);
117 if (!Attrs.empty()) {
118 if (Attrs.find("shape=") == std::string::npos)
119 return std::string("shape=Mrecord,") + Attrs;
124 return "shape=Mrecord";
127 static void addCustomGraphFeatures(SelectionDAG *G,
128 GraphWriter<SelectionDAG*> &GW) {
129 GW.emitSimpleNode(nullptr, "plaintext=circle", "GraphRoot");
130 if (G->getRoot().getNode())
131 GW.emitEdge(nullptr, -1, G->getRoot().getNode(), G->getRoot().getResNo(),
132 "color=blue,style=dashed");
137 std::string DOTGraphTraits<SelectionDAG*>::getNodeLabel(const SDNode *Node,
138 const SelectionDAG *G) {
139 return DOTGraphTraits<SelectionDAG*>::getSimpleNodeLabel(Node, G);
143 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
144 /// rendered using 'dot'.
146 void SelectionDAG::viewGraph(const std::string &Title) {
147 // This code is only for debugging!
149 ViewGraph(this, "dag." + getMachineFunction().getName(),
152 errs() << "SelectionDAG::viewGraph is only available in debug builds on "
153 << "systems with Graphviz or gv!\n";
157 // This overload is defined out-of-line here instead of just using a
158 // default parameter because this is easiest for gdb to call.
159 void SelectionDAG::viewGraph() {
163 /// clearGraphAttrs - Clear all previously defined node graph attributes.
164 /// Intended to be used from a debugging tool (eg. gdb).
165 void SelectionDAG::clearGraphAttrs() {
167 NodeGraphAttrs.clear();
169 errs() << "SelectionDAG::clearGraphAttrs is only available in debug builds"
170 << " on systems with Graphviz or gv!\n";
175 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
177 void SelectionDAG::setGraphAttrs(const SDNode *N, const char *Attrs) {
179 NodeGraphAttrs[N] = Attrs;
181 errs() << "SelectionDAG::setGraphAttrs is only available in debug builds"
182 << " on systems with Graphviz or gv!\n";
187 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
188 /// Used from getNodeAttributes.
189 const std::string SelectionDAG::getGraphAttrs(const SDNode *N) const {
191 std::map<const SDNode *, std::string>::const_iterator I =
192 NodeGraphAttrs.find(N);
194 if (I != NodeGraphAttrs.end())
199 errs() << "SelectionDAG::getGraphAttrs is only available in debug builds"
200 << " on systems with Graphviz or gv!\n";
201 return std::string();
205 /// setGraphColor - Convenience for setting node color attribute.
207 void SelectionDAG::setGraphColor(const SDNode *N, const char *Color) {
209 NodeGraphAttrs[N] = std::string("color=") + Color;
211 errs() << "SelectionDAG::setGraphColor is only available in debug builds"
212 << " on systems with Graphviz or gv!\n";
216 /// setSubgraphColorHelper - Implement setSubgraphColor. Return
217 /// whether we truncated the search.
219 bool SelectionDAG::setSubgraphColorHelper(SDNode *N, const char *Color, DenseSet<SDNode *> &visited,
220 int level, bool &printed) {
221 bool hit_limit = false;
227 DEBUG(dbgs() << "setSubgraphColor hit max level\n");
232 unsigned oldSize = visited.size();
234 if (visited.size() != oldSize) {
235 setGraphColor(N, Color);
236 for(SDNodeIterator i = SDNodeIterator::begin(N), iend = SDNodeIterator::end(N);
239 hit_limit = setSubgraphColorHelper(*i, Color, visited, level+1, printed) || hit_limit;
243 errs() << "SelectionDAG::setSubgraphColor is only available in debug builds"
244 << " on systems with Graphviz or gv!\n";
249 /// setSubgraphColor - Convenience for setting subgraph color attribute.
251 void SelectionDAG::setSubgraphColor(SDNode *N, const char *Color) {
253 DenseSet<SDNode *> visited;
254 bool printed = false;
255 if (setSubgraphColorHelper(N, Color, visited, 0, printed)) {
256 // Visually mark that we hit the limit
257 if (strcmp(Color, "red") == 0) {
258 setSubgraphColorHelper(N, "blue", visited, 0, printed);
259 } else if (strcmp(Color, "yellow") == 0) {
260 setSubgraphColorHelper(N, "green", visited, 0, printed);
265 errs() << "SelectionDAG::setSubgraphColor is only available in debug builds"
266 << " on systems with Graphviz or gv!\n";
270 std::string ScheduleDAGSDNodes::getGraphNodeLabel(const SUnit *SU) const {
272 raw_string_ostream O(s);
273 O << "SU(" << SU->NodeNum << "): ";
275 SmallVector<SDNode *, 4> GluedNodes;
276 for (SDNode *N = SU->getNode(); N; N = N->getGluedNode())
277 GluedNodes.push_back(N);
278 while (!GluedNodes.empty()) {
279 O << DOTGraphTraits<SelectionDAG*>
280 ::getSimpleNodeLabel(GluedNodes.back(), DAG);
281 GluedNodes.pop_back();
282 if (!GluedNodes.empty())
286 O << "CROSS RC COPY";
291 void ScheduleDAGSDNodes::getCustomGraphFeatures(GraphWriter<ScheduleDAG*> &GW) const {
293 // Draw a special "GraphRoot" node to indicate the root of the graph.
294 GW.emitSimpleNode(nullptr, "plaintext=circle", "GraphRoot");
295 const SDNode *N = DAG->getRoot().getNode();
296 if (N && N->getNodeId() != -1)
297 GW.emitEdge(nullptr, -1, &SUnits[N->getNodeId()], -1,
298 "color=blue,style=dashed");