1 //===- analyze.cpp - The LLVM analyze utility -----------------------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This utility is designed to print out the results of running various analysis
11 // passes on a program. This is useful for understanding a program, or for
12 // debugging an analysis pass.
14 // analyze --help - Output information about command line switches
15 // analyze --quiet - Do not print analysis name before output
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Module.h"
20 #include "llvm/PassManager.h"
21 #include "llvm/Bytecode/Reader.h"
22 #include "llvm/Assembly/Parser.h"
23 #include "llvm/Analysis/Verifier.h"
24 #include "llvm/Target/TargetData.h"
25 #include "llvm/Support/PassNameParser.h"
26 #include "Support/Timer.h"
31 struct ModulePassPrinter : public Pass {
32 const PassInfo *PassToPrint;
33 ModulePassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
35 virtual bool run(Module &M) {
36 std::cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
37 getAnalysisID<Pass>(PassToPrint).print(std::cout, &M);
39 // Get and print pass...
43 virtual const char *getPassName() const { return "'Pass' Printer"; }
45 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
46 AU.addRequiredID(PassToPrint);
51 struct FunctionPassPrinter : public FunctionPass {
52 const PassInfo *PassToPrint;
53 FunctionPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
55 virtual bool runOnFunction(Function &F) {
56 std::cout << "Printing analysis '" << PassToPrint->getPassName()
57 << "' for function '" << F.getName() << "':\n";
58 getAnalysisID<Pass>(PassToPrint).print(std::cout, F.getParent());
60 // Get and print pass...
64 virtual const char *getPassName() const { return "FunctionPass Printer"; }
66 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
67 AU.addRequiredID(PassToPrint);
72 struct BasicBlockPassPrinter : public BasicBlockPass {
73 const PassInfo *PassToPrint;
74 BasicBlockPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
76 virtual bool runOnBasicBlock(BasicBlock &BB) {
77 std::cout << "Printing Analysis info for BasicBlock '" << BB.getName()
78 << "': Pass " << PassToPrint->getPassName() << ":\n";
79 getAnalysisID<Pass>(PassToPrint).print(std::cout, BB.getParent()->getParent());
81 // Get and print pass...
85 virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
87 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
88 AU.addRequiredID(PassToPrint);
97 InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"),
98 cl::value_desc("filename"));
100 cl::opt<bool> Quiet("q", cl::desc("Don't print analysis pass names"));
101 cl::alias QuietA("quiet", cl::desc("Alias for -q"),
102 cl::aliasopt(Quiet));
104 cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
105 cl::desc("Do not verify input module"));
107 // The AnalysesList is automatically populated with registered Passes by the
110 cl::list<const PassInfo*, bool, FilteredPassNameParser<PassInfo::Analysis> >
111 AnalysesList(cl::desc("Analyses available:"));
113 Timer BytecodeLoadTimer("Bytecode Loader");
116 int main(int argc, char **argv) {
117 cl::ParseCommandLineOptions(argc, argv, " llvm analysis printer tool\n");
122 TimeRegion RegionTimer(BytecodeLoadTimer);
124 CurMod = ParseBytecodeFile(InputFilename);
125 if (!CurMod && !(CurMod = ParseAssemblyFile(InputFilename))){
126 std::cerr << argv[0] << ": input file didn't read correctly.\n";
129 } catch (const ParseException &E) {
130 std::cerr << argv[0] << ": " << E.getMessage() << "\n";
134 // Create a PassManager to hold and optimize the collection of passes we are
139 // Add an appropriate TargetData instance for this module...
140 Passes.add(new TargetData("analyze", CurMod));
142 // Make sure the input LLVM is well formed.
144 Passes.add(createVerifierPass());
146 // Create a new optimization pass for each one specified on the command line
147 for (unsigned i = 0; i < AnalysesList.size(); ++i) {
148 const PassInfo *Analysis = AnalysesList[i];
150 if (Analysis->getNormalCtor()) {
151 Pass *P = Analysis->getNormalCtor()();
154 if (BasicBlockPass *BBP = dynamic_cast<BasicBlockPass*>(P))
155 Passes.add(new BasicBlockPassPrinter(Analysis));
156 else if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P))
157 Passes.add(new FunctionPassPrinter(Analysis));
159 Passes.add(new ModulePassPrinter(Analysis));
162 std::cerr << argv[0] << ": cannot create pass: "
163 << Analysis->getPassName() << "\n";