Chris Lattner | fa6db4b | 2002-01-31 00:46:09 +0000 | [diff] [blame] | 1 | //===----------------------------------------------------------------------===// |
John Criswell | 7c0e022 | 2003-10-20 17:47:21 +0000 | [diff] [blame^] | 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file was developed by the LLVM research group and is distributed under |
| 6 | // the University of Illinois Open Source License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
Chris Lattner | 4ec35ab | 2002-04-28 16:21:53 +0000 | [diff] [blame] | 10 | // The LLVM analyze utility |
Chris Lattner | f3dc2c9 | 2001-07-03 15:30:38 +0000 | [diff] [blame] | 11 | // |
| 12 | // This utility is designed to print out the results of running various analysis |
| 13 | // passes on a program. This is useful for understanding a program, or for |
| 14 | // debugging an analysis pass. |
| 15 | // |
| 16 | // analyze --help - Output information about command line switches |
| 17 | // analyze --quiet - Do not print analysis name before output |
| 18 | // |
Chris Lattner | fa6db4b | 2002-01-31 00:46:09 +0000 | [diff] [blame] | 19 | //===----------------------------------------------------------------------===// |
Chris Lattner | f3dc2c9 | 2001-07-03 15:30:38 +0000 | [diff] [blame] | 20 | |
Chris Lattner | f3dc2c9 | 2001-07-03 15:30:38 +0000 | [diff] [blame] | 21 | #include "llvm/Module.h" |
Chris Lattner | fa6db4b | 2002-01-31 00:46:09 +0000 | [diff] [blame] | 22 | #include "llvm/PassManager.h" |
Chris Lattner | f3dc2c9 | 2001-07-03 15:30:38 +0000 | [diff] [blame] | 23 | #include "llvm/Bytecode/Reader.h" |
| 24 | #include "llvm/Assembly/Parser.h" |
Chris Lattner | cd7fbf2 | 2002-08-30 22:54:37 +0000 | [diff] [blame] | 25 | #include "llvm/Analysis/Verifier.h" |
Chris Lattner | 9c3b55e | 2003-04-24 19:13:02 +0000 | [diff] [blame] | 26 | #include "llvm/Target/TargetData.h" |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 27 | #include "llvm/Support/PassNameParser.h" |
Chris Lattner | 49d9a88 | 2002-11-10 06:55:02 +0000 | [diff] [blame] | 28 | #include "Support/Timer.h" |
Chris Lattner | c4199ec | 2001-09-28 00:07:36 +0000 | [diff] [blame] | 29 | #include <algorithm> |
Chris Lattner | fa6db4b | 2002-01-31 00:46:09 +0000 | [diff] [blame] | 30 | |
Chris Lattner | 75deac6 | 2001-11-26 19:18:11 +0000 | [diff] [blame] | 31 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 32 | struct ModulePassPrinter : public Pass { |
Chris Lattner | 1ad4436 | 2002-07-29 23:02:25 +0000 | [diff] [blame] | 33 | const PassInfo *PassToPrint; |
| 34 | ModulePassPrinter(const PassInfo *PI) : PassToPrint(PI) {} |
Chris Lattner | 75deac6 | 2001-11-26 19:18:11 +0000 | [diff] [blame] | 35 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 36 | virtual bool run(Module &M) { |
Chris Lattner | 22a3b55 | 2003-02-24 20:07:54 +0000 | [diff] [blame] | 37 | std::cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n"; |
Chris Lattner | 5f0eb8d | 2002-08-08 19:01:30 +0000 | [diff] [blame] | 38 | getAnalysisID<Pass>(PassToPrint).print(std::cout, &M); |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 39 | |
| 40 | // Get and print pass... |
Chris Lattner | fa6db4b | 2002-01-31 00:46:09 +0000 | [diff] [blame] | 41 | return false; |
| 42 | } |
Chris Lattner | 6d37acb | 2002-11-06 06:16:08 +0000 | [diff] [blame] | 43 | |
| 44 | virtual const char *getPassName() const { return "'Pass' Printer"; } |
Chris Lattner | 1ad4436 | 2002-07-29 23:02:25 +0000 | [diff] [blame] | 45 | |
| 46 | virtual void getAnalysisUsage(AnalysisUsage &AU) const { |
Chris Lattner | 5f0eb8d | 2002-08-08 19:01:30 +0000 | [diff] [blame] | 47 | AU.addRequiredID(PassToPrint); |
Chris Lattner | 1ad4436 | 2002-07-29 23:02:25 +0000 | [diff] [blame] | 48 | AU.setPreservesAll(); |
| 49 | } |
Chris Lattner | fa6db4b | 2002-01-31 00:46:09 +0000 | [diff] [blame] | 50 | }; |
| 51 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 52 | struct FunctionPassPrinter : public FunctionPass { |
| 53 | const PassInfo *PassToPrint; |
| 54 | FunctionPassPrinter(const PassInfo *PI) : PassToPrint(PI) {} |
Chris Lattner | fa6db4b | 2002-01-31 00:46:09 +0000 | [diff] [blame] | 55 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 56 | virtual bool runOnFunction(Function &F) { |
Chris Lattner | 22a3b55 | 2003-02-24 20:07:54 +0000 | [diff] [blame] | 57 | std::cout << "Printing analysis '" << PassToPrint->getPassName() |
| 58 | << "' for function '" << F.getName() << "':\n"; |
Chris Lattner | 5f0eb8d | 2002-08-08 19:01:30 +0000 | [diff] [blame] | 59 | getAnalysisID<Pass>(PassToPrint).print(std::cout, F.getParent()); |
Chris Lattner | c13aff6 | 2001-07-06 16:59:10 +0000 | [diff] [blame] | 60 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 61 | // Get and print pass... |
| 62 | return false; |
| 63 | } |
Chris Lattner | c13aff6 | 2001-07-06 16:59:10 +0000 | [diff] [blame] | 64 | |
Chris Lattner | 6d37acb | 2002-11-06 06:16:08 +0000 | [diff] [blame] | 65 | virtual const char *getPassName() const { return "FunctionPass Printer"; } |
| 66 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 67 | virtual void getAnalysisUsage(AnalysisUsage &AU) const { |
Chris Lattner | 5f0eb8d | 2002-08-08 19:01:30 +0000 | [diff] [blame] | 68 | AU.addRequiredID(PassToPrint); |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 69 | AU.setPreservesAll(); |
| 70 | } |
Chris Lattner | 8f367bd | 2001-07-23 02:35:57 +0000 | [diff] [blame] | 71 | }; |
| 72 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 73 | struct BasicBlockPassPrinter : public BasicBlockPass { |
| 74 | const PassInfo *PassToPrint; |
| 75 | BasicBlockPassPrinter(const PassInfo *PI) : PassToPrint(PI) {} |
| 76 | |
| 77 | virtual bool runOnBasicBlock(BasicBlock &BB) { |
| 78 | std::cout << "Printing Analysis info for BasicBlock '" << BB.getName() |
| 79 | << "': Pass " << PassToPrint->getPassName() << ":\n"; |
Chris Lattner | 5f0eb8d | 2002-08-08 19:01:30 +0000 | [diff] [blame] | 80 | getAnalysisID<Pass>(PassToPrint).print(std::cout, BB.getParent()->getParent()); |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 81 | |
| 82 | // Get and print pass... |
| 83 | return false; |
| 84 | } |
| 85 | |
Chris Lattner | 6d37acb | 2002-11-06 06:16:08 +0000 | [diff] [blame] | 86 | virtual const char *getPassName() const { return "BasicBlockPass Printer"; } |
| 87 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 88 | virtual void getAnalysisUsage(AnalysisUsage &AU) const { |
Chris Lattner | 5f0eb8d | 2002-08-08 19:01:30 +0000 | [diff] [blame] | 89 | AU.addRequiredID(PassToPrint); |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 90 | AU.setPreservesAll(); |
| 91 | } |
| 92 | }; |
| 93 | |
| 94 | |
| 95 | |
Chris Lattner | 0b43f4e | 2003-05-12 22:08:58 +0000 | [diff] [blame] | 96 | namespace { |
| 97 | cl::opt<std::string> |
| 98 | InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"), |
| 99 | cl::value_desc("filename")); |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 100 | |
Chris Lattner | 0b43f4e | 2003-05-12 22:08:58 +0000 | [diff] [blame] | 101 | cl::opt<bool> Quiet("q", cl::desc("Don't print analysis pass names")); |
| 102 | cl::alias QuietA("quiet", cl::desc("Alias for -q"), |
| 103 | cl::aliasopt(Quiet)); |
Chris Lattner | 50e3f88 | 2002-07-22 02:10:07 +0000 | [diff] [blame] | 104 | |
Chris Lattner | 59039a9 | 2003-05-12 22:12:44 +0000 | [diff] [blame] | 105 | cl::opt<bool> NoVerify("disable-verify", cl::Hidden, |
| 106 | cl::desc("Do not verify input module")); |
| 107 | |
Chris Lattner | 0b43f4e | 2003-05-12 22:08:58 +0000 | [diff] [blame] | 108 | // The AnalysesList is automatically populated with registered Passes by the |
| 109 | // PassNameParser. |
| 110 | // |
| 111 | cl::list<const PassInfo*, bool, FilteredPassNameParser<PassInfo::Analysis> > |
| 112 | AnalysesList(cl::desc("Analyses available:")); |
Chris Lattner | 50e3f88 | 2002-07-22 02:10:07 +0000 | [diff] [blame] | 113 | |
Chris Lattner | 0b43f4e | 2003-05-12 22:08:58 +0000 | [diff] [blame] | 114 | Timer BytecodeLoadTimer("Bytecode Loader"); |
| 115 | } |
Chris Lattner | 49d9a88 | 2002-11-10 06:55:02 +0000 | [diff] [blame] | 116 | |
Chris Lattner | f3dc2c9 | 2001-07-03 15:30:38 +0000 | [diff] [blame] | 117 | int main(int argc, char **argv) { |
Chris Lattner | 8f367bd | 2001-07-23 02:35:57 +0000 | [diff] [blame] | 118 | cl::ParseCommandLineOptions(argc, argv, " llvm analysis printer tool\n"); |
Chris Lattner | f3dc2c9 | 2001-07-03 15:30:38 +0000 | [diff] [blame] | 119 | |
Chris Lattner | bc132d6 | 2002-03-26 22:43:12 +0000 | [diff] [blame] | 120 | Module *CurMod = 0; |
Chris Lattner | 7d92262 | 2002-02-01 05:09:35 +0000 | [diff] [blame] | 121 | try { |
Chris Lattner | 9ec7368 | 2002-12-03 19:42:26 +0000 | [diff] [blame] | 122 | #if 0 |
Chris Lattner | 49d9a88 | 2002-11-10 06:55:02 +0000 | [diff] [blame] | 123 | TimeRegion RegionTimer(BytecodeLoadTimer); |
Chris Lattner | 9ec7368 | 2002-12-03 19:42:26 +0000 | [diff] [blame] | 124 | #endif |
Chris Lattner | bc132d6 | 2002-03-26 22:43:12 +0000 | [diff] [blame] | 125 | CurMod = ParseBytecodeFile(InputFilename); |
| 126 | if (!CurMod && !(CurMod = ParseAssemblyFile(InputFilename))){ |
Chris Lattner | 50e3a20 | 2002-07-30 21:43:22 +0000 | [diff] [blame] | 127 | std::cerr << argv[0] << ": input file didn't read correctly.\n"; |
Chris Lattner | 7d92262 | 2002-02-01 05:09:35 +0000 | [diff] [blame] | 128 | return 1; |
| 129 | } |
| 130 | } catch (const ParseException &E) { |
Chris Lattner | 50e3a20 | 2002-07-30 21:43:22 +0000 | [diff] [blame] | 131 | std::cerr << argv[0] << ": " << E.getMessage() << "\n"; |
Chris Lattner | c13aff6 | 2001-07-06 16:59:10 +0000 | [diff] [blame] | 132 | return 1; |
Chris Lattner | f3dc2c9 | 2001-07-03 15:30:38 +0000 | [diff] [blame] | 133 | } |
| 134 | |
Chris Lattner | fa6db4b | 2002-01-31 00:46:09 +0000 | [diff] [blame] | 135 | // Create a PassManager to hold and optimize the collection of passes we are |
| 136 | // about to build... |
| 137 | // |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 138 | PassManager Passes; |
Chris Lattner | fa6db4b | 2002-01-31 00:46:09 +0000 | [diff] [blame] | 139 | |
Chris Lattner | 9c3b55e | 2003-04-24 19:13:02 +0000 | [diff] [blame] | 140 | // Add an appropriate TargetData instance for this module... |
| 141 | Passes.add(new TargetData("analyze", CurMod)); |
| 142 | |
Chris Lattner | cd7fbf2 | 2002-08-30 22:54:37 +0000 | [diff] [blame] | 143 | // Make sure the input LLVM is well formed. |
Chris Lattner | 59039a9 | 2003-05-12 22:12:44 +0000 | [diff] [blame] | 144 | if (!NoVerify) |
| 145 | Passes.add(createVerifierPass()); |
Chris Lattner | cd7fbf2 | 2002-08-30 22:54:37 +0000 | [diff] [blame] | 146 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 147 | // Create a new optimization pass for each one specified on the command line |
Chris Lattner | c4199ec | 2001-09-28 00:07:36 +0000 | [diff] [blame] | 148 | for (unsigned i = 0; i < AnalysesList.size(); ++i) { |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 149 | const PassInfo *Analysis = AnalysesList[i]; |
| 150 | |
| 151 | if (Analysis->getNormalCtor()) { |
| 152 | Pass *P = Analysis->getNormalCtor()(); |
| 153 | Passes.add(P); |
Chris Lattner | c4199ec | 2001-09-28 00:07:36 +0000 | [diff] [blame] | 154 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 155 | if (BasicBlockPass *BBP = dynamic_cast<BasicBlockPass*>(P)) |
| 156 | Passes.add(new BasicBlockPassPrinter(Analysis)); |
| 157 | else if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) |
| 158 | Passes.add(new FunctionPassPrinter(Analysis)); |
| 159 | else |
Chris Lattner | 1ad4436 | 2002-07-29 23:02:25 +0000 | [diff] [blame] | 160 | Passes.add(new ModulePassPrinter(Analysis)); |
Chris Lattner | c4199ec | 2001-09-28 00:07:36 +0000 | [diff] [blame] | 161 | |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 162 | } else |
Chris Lattner | 8633a48 | 2002-07-31 19:32:14 +0000 | [diff] [blame] | 163 | std::cerr << argv[0] << ": cannot create pass: " |
| 164 | << Analysis->getPassName() << "\n"; |
Chris Lattner | 9a740fd | 2002-07-27 01:08:50 +0000 | [diff] [blame] | 165 | } |
| 166 | |
| 167 | Passes.run(*CurMod); |
Chris Lattner | f3dc2c9 | 2001-07-03 15:30:38 +0000 | [diff] [blame] | 168 | |
Chris Lattner | bc132d6 | 2002-03-26 22:43:12 +0000 | [diff] [blame] | 169 | delete CurMod; |
Chris Lattner | f3dc2c9 | 2001-07-03 15:30:38 +0000 | [diff] [blame] | 170 | return 0; |
| 171 | } |