blob: 17f7e4866d851098a812409ca45753ec4e262222 [file] [log] [blame]
Chris Lattnerfa6db4b2002-01-31 00:46:09 +00001//===----------------------------------------------------------------------===//
John Criswell7c0e0222003-10-20 17:47:21 +00002//
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 Lattner4ec35ab2002-04-28 16:21:53 +000010// The LLVM analyze utility
Chris Lattnerf3dc2c92001-07-03 15:30:38 +000011//
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 Lattnerfa6db4b2002-01-31 00:46:09 +000019//===----------------------------------------------------------------------===//
Chris Lattnerf3dc2c92001-07-03 15:30:38 +000020
Chris Lattnerf3dc2c92001-07-03 15:30:38 +000021#include "llvm/Module.h"
Chris Lattnerfa6db4b2002-01-31 00:46:09 +000022#include "llvm/PassManager.h"
Chris Lattnerf3dc2c92001-07-03 15:30:38 +000023#include "llvm/Bytecode/Reader.h"
24#include "llvm/Assembly/Parser.h"
Chris Lattnercd7fbf22002-08-30 22:54:37 +000025#include "llvm/Analysis/Verifier.h"
Chris Lattner9c3b55e2003-04-24 19:13:02 +000026#include "llvm/Target/TargetData.h"
Chris Lattner9a740fd2002-07-27 01:08:50 +000027#include "llvm/Support/PassNameParser.h"
Chris Lattner49d9a882002-11-10 06:55:02 +000028#include "Support/Timer.h"
Chris Lattnerc4199ec2001-09-28 00:07:36 +000029#include <algorithm>
Chris Lattnerfa6db4b2002-01-31 00:46:09 +000030
Chris Lattner75deac62001-11-26 19:18:11 +000031
Chris Lattner9a740fd2002-07-27 01:08:50 +000032struct ModulePassPrinter : public Pass {
Chris Lattner1ad44362002-07-29 23:02:25 +000033 const PassInfo *PassToPrint;
34 ModulePassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
Chris Lattner75deac62001-11-26 19:18:11 +000035
Chris Lattner9a740fd2002-07-27 01:08:50 +000036 virtual bool run(Module &M) {
Chris Lattner22a3b552003-02-24 20:07:54 +000037 std::cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
Chris Lattner5f0eb8d2002-08-08 19:01:30 +000038 getAnalysisID<Pass>(PassToPrint).print(std::cout, &M);
Chris Lattner9a740fd2002-07-27 01:08:50 +000039
40 // Get and print pass...
Chris Lattnerfa6db4b2002-01-31 00:46:09 +000041 return false;
42 }
Chris Lattner6d37acb2002-11-06 06:16:08 +000043
44 virtual const char *getPassName() const { return "'Pass' Printer"; }
Chris Lattner1ad44362002-07-29 23:02:25 +000045
46 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattner5f0eb8d2002-08-08 19:01:30 +000047 AU.addRequiredID(PassToPrint);
Chris Lattner1ad44362002-07-29 23:02:25 +000048 AU.setPreservesAll();
49 }
Chris Lattnerfa6db4b2002-01-31 00:46:09 +000050};
51
Chris Lattner9a740fd2002-07-27 01:08:50 +000052struct FunctionPassPrinter : public FunctionPass {
53 const PassInfo *PassToPrint;
54 FunctionPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
Chris Lattnerfa6db4b2002-01-31 00:46:09 +000055
Chris Lattner9a740fd2002-07-27 01:08:50 +000056 virtual bool runOnFunction(Function &F) {
Chris Lattner22a3b552003-02-24 20:07:54 +000057 std::cout << "Printing analysis '" << PassToPrint->getPassName()
58 << "' for function '" << F.getName() << "':\n";
Chris Lattner5f0eb8d2002-08-08 19:01:30 +000059 getAnalysisID<Pass>(PassToPrint).print(std::cout, F.getParent());
Chris Lattnerc13aff62001-07-06 16:59:10 +000060
Chris Lattner9a740fd2002-07-27 01:08:50 +000061 // Get and print pass...
62 return false;
63 }
Chris Lattnerc13aff62001-07-06 16:59:10 +000064
Chris Lattner6d37acb2002-11-06 06:16:08 +000065 virtual const char *getPassName() const { return "FunctionPass Printer"; }
66
Chris Lattner9a740fd2002-07-27 01:08:50 +000067 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattner5f0eb8d2002-08-08 19:01:30 +000068 AU.addRequiredID(PassToPrint);
Chris Lattner9a740fd2002-07-27 01:08:50 +000069 AU.setPreservesAll();
70 }
Chris Lattner8f367bd2001-07-23 02:35:57 +000071};
72
Chris Lattner9a740fd2002-07-27 01:08:50 +000073struct 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 Lattner5f0eb8d2002-08-08 19:01:30 +000080 getAnalysisID<Pass>(PassToPrint).print(std::cout, BB.getParent()->getParent());
Chris Lattner9a740fd2002-07-27 01:08:50 +000081
82 // Get and print pass...
83 return false;
84 }
85
Chris Lattner6d37acb2002-11-06 06:16:08 +000086 virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
87
Chris Lattner9a740fd2002-07-27 01:08:50 +000088 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattner5f0eb8d2002-08-08 19:01:30 +000089 AU.addRequiredID(PassToPrint);
Chris Lattner9a740fd2002-07-27 01:08:50 +000090 AU.setPreservesAll();
91 }
92};
93
94
95
Chris Lattner0b43f4e2003-05-12 22:08:58 +000096namespace {
97 cl::opt<std::string>
98 InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"),
99 cl::value_desc("filename"));
Chris Lattner9a740fd2002-07-27 01:08:50 +0000100
Chris Lattner0b43f4e2003-05-12 22:08:58 +0000101 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 Lattner50e3f882002-07-22 02:10:07 +0000104
Chris Lattner59039a92003-05-12 22:12:44 +0000105 cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
106 cl::desc("Do not verify input module"));
107
Chris Lattner0b43f4e2003-05-12 22:08:58 +0000108 // 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 Lattner50e3f882002-07-22 02:10:07 +0000113
Chris Lattner0b43f4e2003-05-12 22:08:58 +0000114 Timer BytecodeLoadTimer("Bytecode Loader");
115}
Chris Lattner49d9a882002-11-10 06:55:02 +0000116
Chris Lattnerf3dc2c92001-07-03 15:30:38 +0000117int main(int argc, char **argv) {
Chris Lattner8f367bd2001-07-23 02:35:57 +0000118 cl::ParseCommandLineOptions(argc, argv, " llvm analysis printer tool\n");
Chris Lattnerf3dc2c92001-07-03 15:30:38 +0000119
Chris Lattnerbc132d62002-03-26 22:43:12 +0000120 Module *CurMod = 0;
Chris Lattner7d922622002-02-01 05:09:35 +0000121 try {
Chris Lattner9ec73682002-12-03 19:42:26 +0000122#if 0
Chris Lattner49d9a882002-11-10 06:55:02 +0000123 TimeRegion RegionTimer(BytecodeLoadTimer);
Chris Lattner9ec73682002-12-03 19:42:26 +0000124#endif
Chris Lattnerbc132d62002-03-26 22:43:12 +0000125 CurMod = ParseBytecodeFile(InputFilename);
126 if (!CurMod && !(CurMod = ParseAssemblyFile(InputFilename))){
Chris Lattner50e3a202002-07-30 21:43:22 +0000127 std::cerr << argv[0] << ": input file didn't read correctly.\n";
Chris Lattner7d922622002-02-01 05:09:35 +0000128 return 1;
129 }
130 } catch (const ParseException &E) {
Chris Lattner50e3a202002-07-30 21:43:22 +0000131 std::cerr << argv[0] << ": " << E.getMessage() << "\n";
Chris Lattnerc13aff62001-07-06 16:59:10 +0000132 return 1;
Chris Lattnerf3dc2c92001-07-03 15:30:38 +0000133 }
134
Chris Lattnerfa6db4b2002-01-31 00:46:09 +0000135 // Create a PassManager to hold and optimize the collection of passes we are
136 // about to build...
137 //
Chris Lattner9a740fd2002-07-27 01:08:50 +0000138 PassManager Passes;
Chris Lattnerfa6db4b2002-01-31 00:46:09 +0000139
Chris Lattner9c3b55e2003-04-24 19:13:02 +0000140 // Add an appropriate TargetData instance for this module...
141 Passes.add(new TargetData("analyze", CurMod));
142
Chris Lattnercd7fbf22002-08-30 22:54:37 +0000143 // Make sure the input LLVM is well formed.
Chris Lattner59039a92003-05-12 22:12:44 +0000144 if (!NoVerify)
145 Passes.add(createVerifierPass());
Chris Lattnercd7fbf22002-08-30 22:54:37 +0000146
Chris Lattner9a740fd2002-07-27 01:08:50 +0000147 // Create a new optimization pass for each one specified on the command line
Chris Lattnerc4199ec2001-09-28 00:07:36 +0000148 for (unsigned i = 0; i < AnalysesList.size(); ++i) {
Chris Lattner9a740fd2002-07-27 01:08:50 +0000149 const PassInfo *Analysis = AnalysesList[i];
150
151 if (Analysis->getNormalCtor()) {
152 Pass *P = Analysis->getNormalCtor()();
153 Passes.add(P);
Chris Lattnerc4199ec2001-09-28 00:07:36 +0000154
Chris Lattner9a740fd2002-07-27 01:08:50 +0000155 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 Lattner1ad44362002-07-29 23:02:25 +0000160 Passes.add(new ModulePassPrinter(Analysis));
Chris Lattnerc4199ec2001-09-28 00:07:36 +0000161
Chris Lattner9a740fd2002-07-27 01:08:50 +0000162 } else
Chris Lattner8633a482002-07-31 19:32:14 +0000163 std::cerr << argv[0] << ": cannot create pass: "
164 << Analysis->getPassName() << "\n";
Chris Lattner9a740fd2002-07-27 01:08:50 +0000165 }
166
167 Passes.run(*CurMod);
Chris Lattnerf3dc2c92001-07-03 15:30:38 +0000168
Chris Lattnerbc132d62002-03-26 22:43:12 +0000169 delete CurMod;
Chris Lattnerf3dc2c92001-07-03 15:30:38 +0000170 return 0;
171}