1 //===----------------------------------------------------------------------===//
2 // LLVM 'Analyze' UTILITY
4 // This utility is designed to print out the results of running various analysis
5 // passes on a program. This is useful for understanding a program, or for
6 // debugging an analysis pass.
8 // analyze --help - Output information about command line switches
9 // analyze --quiet - Do not print analysis name before output
11 //===----------------------------------------------------------------------===//
13 #include "llvm/Instruction.h"
14 #include "llvm/Module.h"
15 #include "llvm/Function.h"
16 #include "llvm/iPHINode.h"
17 #include "llvm/Type.h"
18 #include "llvm/PassManager.h"
19 #include "llvm/Bytecode/Reader.h"
20 #include "llvm/Assembly/Parser.h"
21 #include "llvm/Assembly/PrintModulePass.h"
22 #include "llvm/Assembly/Writer.h"
23 #include "llvm/Analysis/Writer.h"
24 #include "llvm/Analysis/InstForest.h"
25 #include "llvm/Analysis/Dominators.h"
26 #include "llvm/Analysis/IntervalPartition.h"
27 #include "llvm/Analysis/Expressions.h"
28 #include "llvm/Analysis/InductionVariable.h"
29 #include "llvm/Analysis/CallGraph.h"
30 #include "llvm/Analysis/LoopInfo.h"
31 #include "llvm/Analysis/DataStructure.h"
32 #include "llvm/Analysis/FindUnsafePointerTypes.h"
33 #include "llvm/Analysis/FindUsedTypes.h"
34 #include "llvm/Support/InstIterator.h"
35 #include "Support/CommandLine.h"
42 //===----------------------------------------------------------------------===//
43 // printPass - Specify how to print out a pass. For most passes, the standard
44 // way of using operator<< works great, so we use it directly...
46 template<class PassType>
47 static void printPass(PassType &P, ostream &O, Module *M) {
51 template<class PassType>
52 static void printPass(PassType &P, ostream &O, Function *F) {
56 // Other classes require more information to print out information, so we
57 // specialize the template here for them...
60 static void printPass(DataStructure &P, ostream &O, Module *M) {
65 static void printPass(FindUsedTypes &FUT, ostream &O, Module *M) {
70 static void printPass(FindUnsafePointerTypes &FUPT, ostream &O,
72 FUPT.printResults(M, O);
77 template <class PassType, class PassName>
78 class PassPrinter; // Do not implement
80 template <class PassName>
81 class PassPrinter<Pass, PassName> : public Pass {
85 PassPrinter(const string &M, AnalysisID id) : Message(M), ID(id) {}
87 virtual bool run(Module *M) {
88 std::cout << Message << "\n";
89 printPass(getAnalysis<PassName>(ID), std::cout, M);
93 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
98 template <class PassName>
99 class PassPrinter<FunctionPass, PassName> : public FunctionPass {
100 const string Message;
103 PassPrinter(const string &M, AnalysisID id) : Message(M), ID(id) {}
105 virtual bool runOnFunction(Function *F) {
106 std::cout << Message << " on function '" << F->getName() << "'\n";
107 printPass(getAnalysis<PassName>(ID), std::cout, F);
111 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
118 template <class PassType, class PassName, AnalysisID &ID>
119 Pass *New(const string &Message) {
120 return new PassPrinter<PassType, PassName>(Message, ID);
122 template <class PassType, class PassName>
123 Pass *New(const string &Message) {
124 return new PassPrinter<PassType, PassName>(Message, PassName::ID);
129 Pass *NewPrintFunction(const string &Message) {
130 return new PrintFunctionPass(Message, &std::cout);
132 Pass *NewPrintModule(const string &Message) {
133 return new PrintModulePass(&std::cout);
136 struct InstForest : public FunctionPass {
137 void doit(Function *F) {
138 std::cout << analysis::InstForest<char>(F);
142 struct IndVars : public FunctionPass {
143 void doit(Function *F) {
144 cfg::LoopInfo &LI = getAnalysis<cfg::LoopInfo>();
145 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
146 if (PHINode *PN = dyn_cast<PHINode>(*I)) {
147 InductionVariable IV(PN, &LI);
148 if (IV.InductionType != InductionVariable::Unknown)
153 void getAnalysisUsage(AnalysisUsage &AU) const {
154 AU.addRequired(cfg::LoopInfo::ID);
158 struct Exprs : public FunctionPass {
159 static void doit(Function *F) {
160 std::cout << "Classified expressions for: " << F->getName() << "\n";
161 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I) {
164 if ((*I)->getType() == Type::VoidTy) continue;
165 analysis::ExprType R = analysis::ClassifyExpression(*I);
166 if (R.Var == *I) continue; // Doesn't tell us anything
168 std::cout << "\t\tExpr =";
170 case analysis::ExprType::ScaledLinear:
171 WriteAsOperand(std::cout << "(", (Value*)R.Scale) << " ) *";
173 case analysis::ExprType::Linear:
174 WriteAsOperand(std::cout << "(", R.Var) << " )";
175 if (R.Offset == 0) break;
176 else std::cout << " +";
178 case analysis::ExprType::Constant:
179 if (R.Offset) WriteAsOperand(std::cout, (Value*)R.Offset);
180 else std::cout << " 0";
189 template<class TraitClass>
190 class PrinterPass : public TraitClass {
191 const string Message;
193 PrinterPass(const string &M) : Message(M) {}
195 virtual bool runOnFunction(Function *F) {
196 std::cout << Message << " on function '" << F->getName() << "'\n";
204 template<class PassClass>
205 Pass *Create(const string &Message) {
206 return new PassClass(Message);
213 print, intervals, exprs, instforest, loops, indvars,
216 printmodule, callgraph, datastructure, printusedtypes, unsafepointertypes,
218 domset, idom, domtree, domfrontier,
219 postdomset, postidom, postdomtree, postdomfrontier,
222 cl::String InputFilename ("", "Load <arg> file to analyze", cl::NoFlags, "-");
223 cl::Flag Quiet ("q", "Don't print analysis pass names");
224 cl::Alias QuietA ("quiet", "Alias for -q", cl::NoFlags, Quiet);
225 cl::EnumList<enum Ans> AnalysesList(cl::NoFlags,
226 clEnumVal(print , "Print each function"),
227 clEnumVal(intervals , "Print Interval Partitions"),
228 clEnumVal(exprs , "Classify Expressions"),
229 clEnumVal(instforest , "Print Instruction Forest"),
230 clEnumVal(loops , "Print natural loops"),
231 clEnumVal(indvars , "Print Induction Variables"),
233 clEnumVal(printmodule , "Print entire module"),
234 clEnumVal(callgraph , "Print Call Graph"),
235 clEnumVal(datastructure , "Print data structure information"),
236 clEnumVal(printusedtypes , "Print types used by module"),
237 clEnumVal(unsafepointertypes, "Print unsafe pointer types"),
239 clEnumVal(domset , "Print Dominator Sets"),
240 clEnumVal(idom , "Print Immediate Dominators"),
241 clEnumVal(domtree , "Print Dominator Tree"),
242 clEnumVal(domfrontier , "Print Dominance Frontier"),
244 clEnumVal(postdomset , "Print Postdominator Sets"),
245 clEnumVal(postidom , "Print Immediate Postdominators"),
246 clEnumVal(postdomtree , "Print Post Dominator Tree"),
247 clEnumVal(postdomfrontier, "Print Postdominance Frontier"),
253 Pass *(*PassConstructor)(const string &Message);
256 { print , NewPrintFunction },
257 { intervals , New<FunctionPass, cfg::IntervalPartition> },
258 { loops , New<FunctionPass, cfg::LoopInfo> },
259 { instforest , Create<PrinterPass<InstForest> > },
260 { indvars , Create<PrinterPass<IndVars> > },
261 { exprs , Create<PrinterPass<Exprs> > },
264 { printmodule , NewPrintModule },
265 { printusedtypes , New<Pass, FindUsedTypes> },
266 { callgraph , New<Pass, CallGraph> },
267 { datastructure , New<Pass, DataStructure> },
268 { unsafepointertypes, New<Pass, FindUnsafePointerTypes> },
270 // Dominator analyses
271 { domset , New<FunctionPass, cfg::DominatorSet> },
272 { idom , New<FunctionPass, cfg::ImmediateDominators> },
273 { domtree , New<FunctionPass, cfg::DominatorTree> },
274 { domfrontier , New<FunctionPass, cfg::DominanceFrontier> },
276 { postdomset , New<FunctionPass, cfg::DominatorSet, cfg::DominatorSet::PostDomID> },
277 { postidom , New<FunctionPass, cfg::ImmediateDominators, cfg::ImmediateDominators::PostDomID> },
278 { postdomtree , New<FunctionPass, cfg::DominatorTree, cfg::DominatorTree::PostDomID> },
279 { postdomfrontier , New<FunctionPass, cfg::DominanceFrontier, cfg::DominanceFrontier::PostDomID> },
282 int main(int argc, char **argv) {
283 cl::ParseCommandLineOptions(argc, argv, " llvm analysis printer tool\n");
287 CurMod = ParseBytecodeFile(InputFilename);
288 if (!CurMod && !(CurMod = ParseAssemblyFile(InputFilename))){
289 std::cerr << "Input file didn't read correctly.\n";
292 } catch (const ParseException &E) {
293 std::cerr << E.getMessage() << "\n";
297 // Create a PassManager to hold and optimize the collection of passes we are
300 PassManager Analyses;
302 // Loop over all of the analyses looking for analyses to run...
303 for (unsigned i = 0; i < AnalysesList.size(); ++i) {
304 enum Ans AnalysisPass = AnalysesList[i];
306 for (unsigned j = 0; j < sizeof(AnTable)/sizeof(AnTable[0]); ++j) {
307 if (AnTable[j].AnID == AnalysisPass) {
310 Message = "\nRunning: '" +
311 string(AnalysesList.getArgDescription(AnalysisPass)) + "' analysis";
312 Analyses.add(AnTable[j].PassConstructor(Message));
313 break; // get an error later
318 Analyses.run(CurMod);