1 //===----------------------------------------------------------------------===//
2 // The 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/Module.h"
14 #include "llvm/PassManager.h"
15 #include "llvm/Bytecode/Reader.h"
16 #include "llvm/Assembly/Parser.h"
17 #include "llvm/Support/PassNameParser.h"
21 struct ModulePassPrinter : public Pass {
23 ModulePassPrinter(Pass *PI) : PassToPrint(PI) {}
25 virtual bool run(Module &M) {
26 std::cout << "Printing Analysis info for Pass "
27 << PassToPrint->getPassName() << ":\n";
28 PassToPrint->print(std::cout, &M);
30 // Get and print pass...
35 struct FunctionPassPrinter : public FunctionPass {
36 const PassInfo *PassToPrint;
37 FunctionPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
39 virtual bool runOnFunction(Function &F) {
40 std::cout << "Printing Analysis info for function '" << F.getName()
41 << "': Pass " << PassToPrint->getPassName() << ":\n";
42 getAnalysis<Pass>(PassToPrint).print(std::cout, F.getParent());
44 // Get and print pass...
48 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
49 AU.addRequired(PassToPrint);
54 struct BasicBlockPassPrinter : public BasicBlockPass {
55 const PassInfo *PassToPrint;
56 BasicBlockPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
58 virtual bool runOnBasicBlock(BasicBlock &BB) {
59 std::cout << "Printing Analysis info for BasicBlock '" << BB.getName()
60 << "': Pass " << PassToPrint->getPassName() << ":\n";
61 getAnalysis<Pass>(PassToPrint).print(std::cout, BB.getParent()->getParent());
63 // Get and print pass...
67 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
68 AU.addRequired(PassToPrint);
76 static cl::opt<std::string>
77 InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"),
78 cl::value_desc("filename"));
80 static cl::opt<bool> Quiet("q", cl::desc("Don't print analysis pass names"));
81 static cl::alias QuietA("quiet", cl::desc("Alias for -q"),
84 // The AnalysesList is automatically populated with registered Passes by the
87 static cl::list<const PassInfo*, bool,
88 FilteredPassNameParser<PassInfo::Analysis> >
89 AnalysesList(cl::desc("Analyses available:"));
92 int main(int argc, char **argv) {
93 cl::ParseCommandLineOptions(argc, argv, " llvm analysis printer tool\n");
97 CurMod = ParseBytecodeFile(InputFilename);
98 if (!CurMod && !(CurMod = ParseAssemblyFile(InputFilename))){
99 std::cerr << "Input file didn't read correctly.\n";
102 } catch (const ParseException &E) {
103 std::cerr << E.getMessage() << "\n";
107 // Create a PassManager to hold and optimize the collection of passes we are
112 // Create a new optimization pass for each one specified on the command line
113 for (unsigned i = 0; i < AnalysesList.size(); ++i) {
114 const PassInfo *Analysis = AnalysesList[i];
116 if (Analysis->getNormalCtor()) {
117 Pass *P = Analysis->getNormalCtor()();
120 if (BasicBlockPass *BBP = dynamic_cast<BasicBlockPass*>(P))
121 Passes.add(new BasicBlockPassPrinter(Analysis));
122 else if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P))
123 Passes.add(new FunctionPassPrinter(Analysis));
125 Passes.add(new ModulePassPrinter(P));
128 cerr << "Cannot create pass: " << Analysis->getPassName() << "\n";