1 //===- RegionPrinter.cpp - Print regions tree pass ------------------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 // Print out the region tree of a function using dotty/graphviz.
10 //===----------------------------------------------------------------------===//
11
12 #include "llvm/Analysis/RegionInfo.h"
13 #include "llvm/Analysis/RegionIterator.h"
14 #include "llvm/Analysis/RegionPrinter.h"
15 #include "llvm/Analysis/Passes.h"
16 #include "llvm/Analysis/DOTGraphTraitsPass.h"
17 #include "llvm/ADT/Statistic.h"
18 #include "llvm/ADT/PostOrderIterator.h"
19 #include "llvm/ADT/DepthFirstIterator.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/CommandLine.h"
22 #include "llvm/Support/raw_ostream.h"
23
24 using namespace llvm;
25
26 //===----------------------------------------------------------------------===//
27 /// onlySimpleRegion - Show only the simple regions in the RegionViewer.
28 static cl::opt<bool>
29 onlySimpleRegions("only-simple-regions",
30 cl::desc("Show only simple regions in the graphviz viewer"),
31 cl::Hidden,
32 cl::init(false));
33
34 namespace llvm {
35 template<>
36 struct DOTGraphTraits<RegionNode*> : public DefaultDOTGraphTraits {
37
DOTGraphTraitsllvm::DOTGraphTraits38 DOTGraphTraits (bool isSimple=false)
39 : DefaultDOTGraphTraits(isSimple) {}
40
getNodeLabelllvm::DOTGraphTraits41 std::string getNodeLabel(RegionNode *Node, RegionNode *Graph) {
42
43 if (!Node->isSubRegion()) {
44 BasicBlock *BB = Node->getNodeAs<BasicBlock>();
45
46 if (isSimple())
47 return DOTGraphTraits<const Function*>
48 ::getSimpleNodeLabel(BB, BB->getParent());
49 else
50 return DOTGraphTraits<const Function*>
51 ::getCompleteNodeLabel(BB, BB->getParent());
52 }
53
54 return "Not implemented";
55 }
56 };
57
58 template<>
59 struct DOTGraphTraits<RegionInfo*> : public DOTGraphTraits<RegionNode*> {
60
DOTGraphTraitsllvm::DOTGraphTraits61 DOTGraphTraits (bool isSimple=false)
62 : DOTGraphTraits<RegionNode*>(isSimple) {}
63
getGraphNamellvm::DOTGraphTraits64 static std::string getGraphName(RegionInfo *DT) {
65 return "Region Graph";
66 }
67
getNodeLabelllvm::DOTGraphTraits68 std::string getNodeLabel(RegionNode *Node, RegionInfo *G) {
69 return DOTGraphTraits<RegionNode*>::getNodeLabel(Node,
70 G->getTopLevelRegion());
71 }
72
getEdgeAttributesllvm::DOTGraphTraits73 std::string getEdgeAttributes(RegionNode *srcNode,
74 GraphTraits<RegionInfo*>::ChildIteratorType CI, RegionInfo *RI) {
75
76 RegionNode *destNode = *CI;
77
78 if (srcNode->isSubRegion() || destNode->isSubRegion())
79 return "";
80
81 // In case of a backedge, do not use it to define the layout of the nodes.
82 BasicBlock *srcBB = srcNode->getNodeAs<BasicBlock>();
83 BasicBlock *destBB = destNode->getNodeAs<BasicBlock>();
84
85 Region *R = RI->getRegionFor(destBB);
86
87 while (R && R->getParent())
88 if (R->getParent()->getEntry() == destBB)
89 R = R->getParent();
90 else
91 break;
92
93 if (R->getEntry() == destBB && R->contains(srcBB))
94 return "constraint=false";
95
96 return "";
97 }
98
99 // Print the cluster of the subregions. This groups the single basic blocks
100 // and adds a different background color for each group.
printRegionClusterllvm::DOTGraphTraits101 static void printRegionCluster(const Region *R, GraphWriter<RegionInfo*> &GW,
102 unsigned depth = 0) {
103 raw_ostream &O = GW.getOStream();
104 O.indent(2 * depth) << "subgraph cluster_" << static_cast<const void*>(R)
105 << " {\n";
106 O.indent(2 * (depth + 1)) << "label = \"\";\n";
107
108 if (!onlySimpleRegions || R->isSimple()) {
109 O.indent(2 * (depth + 1)) << "style = filled;\n";
110 O.indent(2 * (depth + 1)) << "color = "
111 << ((R->getDepth() * 2 % 12) + 1) << "\n";
112
113 } else {
114 O.indent(2 * (depth + 1)) << "style = solid;\n";
115 O.indent(2 * (depth + 1)) << "color = "
116 << ((R->getDepth() * 2 % 12) + 2) << "\n";
117 }
118
119 for (Region::const_iterator RI = R->begin(), RE = R->end(); RI != RE; ++RI)
120 printRegionCluster(*RI, GW, depth + 1);
121
122 RegionInfo *RI = R->getRegionInfo();
123
124 for (Region::const_block_iterator BI = R->block_begin(),
125 BE = R->block_end(); BI != BE; ++BI) {
126 BasicBlock *BB = (*BI)->getNodeAs<BasicBlock>();
127 if (RI->getRegionFor(BB) == R)
128 O.indent(2 * (depth + 1)) << "Node"
129 << static_cast<const void*>(RI->getTopLevelRegion()->getBBNode(BB))
130 << ";\n";
131 }
132
133 O.indent(2 * depth) << "}\n";
134 }
135
addCustomGraphFeaturesllvm::DOTGraphTraits136 static void addCustomGraphFeatures(const RegionInfo* RI,
137 GraphWriter<RegionInfo*> &GW) {
138 raw_ostream &O = GW.getOStream();
139 O << "\tcolorscheme = \"paired12\"\n";
140 printRegionCluster(RI->getTopLevelRegion(), GW, 4);
141 }
142 };
143 } //end namespace llvm
144
145 namespace {
146
147 struct RegionViewer
148 : public DOTGraphTraitsViewer<RegionInfo, false> {
149 static char ID;
RegionViewer__anone74917020111::RegionViewer150 RegionViewer() : DOTGraphTraitsViewer<RegionInfo, false>("reg", ID){
151 initializeRegionViewerPass(*PassRegistry::getPassRegistry());
152 }
153 };
154 char RegionViewer::ID = 0;
155
156 struct RegionOnlyViewer
157 : public DOTGraphTraitsViewer<RegionInfo, true> {
158 static char ID;
RegionOnlyViewer__anone74917020111::RegionOnlyViewer159 RegionOnlyViewer() : DOTGraphTraitsViewer<RegionInfo, true>("regonly", ID) {
160 initializeRegionOnlyViewerPass(*PassRegistry::getPassRegistry());
161 }
162 };
163 char RegionOnlyViewer::ID = 0;
164
165 struct RegionPrinter
166 : public DOTGraphTraitsPrinter<RegionInfo, false> {
167 static char ID;
RegionPrinter__anone74917020111::RegionPrinter168 RegionPrinter() :
169 DOTGraphTraitsPrinter<RegionInfo, false>("reg", ID) {
170 initializeRegionPrinterPass(*PassRegistry::getPassRegistry());
171 }
172 };
173 char RegionPrinter::ID = 0;
174 } //end anonymous namespace
175
176 INITIALIZE_PASS(RegionPrinter, "dot-regions",
177 "Print regions of function to 'dot' file", true, true)
178
179 INITIALIZE_PASS(RegionViewer, "view-regions", "View regions of function",
180 true, true)
181
182 INITIALIZE_PASS(RegionOnlyViewer, "view-regions-only",
183 "View regions of function (with no function bodies)",
184 true, true)
185
186 namespace {
187
188 struct RegionOnlyPrinter
189 : public DOTGraphTraitsPrinter<RegionInfo, true> {
190 static char ID;
RegionOnlyPrinter__anone74917020211::RegionOnlyPrinter191 RegionOnlyPrinter() :
192 DOTGraphTraitsPrinter<RegionInfo, true>("reg", ID) {
193 initializeRegionOnlyPrinterPass(*PassRegistry::getPassRegistry());
194 }
195 };
196
197 }
198
199 char RegionOnlyPrinter::ID = 0;
200 INITIALIZE_PASS(RegionOnlyPrinter, "dot-regions-only",
201 "Print regions of function to 'dot' file "
202 "(with no function bodies)",
203 true, true)
204
createRegionViewerPass()205 FunctionPass* llvm::createRegionViewerPass() {
206 return new RegionViewer();
207 }
208
createRegionOnlyViewerPass()209 FunctionPass* llvm::createRegionOnlyViewerPass() {
210 return new RegionOnlyViewer();
211 }
212
createRegionPrinterPass()213 FunctionPass* llvm::createRegionPrinterPass() {
214 return new RegionPrinter();
215 }
216
createRegionOnlyPrinterPass()217 FunctionPass* llvm::createRegionOnlyPrinterPass() {
218 return new RegionOnlyPrinter();
219 }
220
221