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 {
22 const PassInfo *PassToPrint;
23 ModulePassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
25 virtual bool run(Module &M) {
26 std::cout << "Printing Analysis info for Pass "
27 << PassToPrint->getPassName() << ":\n";
28 getAnalysisID<Pass>(PassToPrint).print(std::cout, &M);
30 // Get and print pass...
34 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
35 AU.addRequiredID(PassToPrint);
40 struct FunctionPassPrinter : public FunctionPass {
41 const PassInfo *PassToPrint;
42 FunctionPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
44 virtual bool runOnFunction(Function &F) {
45 std::cout << "Printing Analysis info for function '" << F.getName()
46 << "': Pass " << PassToPrint->getPassName() << ":\n";
47 getAnalysisID<Pass>(PassToPrint).print(std::cout, F.getParent());
49 // Get and print pass...
53 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
54 AU.addRequiredID(PassToPrint);
59 struct BasicBlockPassPrinter : public BasicBlockPass {
60 const PassInfo *PassToPrint;
61 BasicBlockPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
63 virtual bool runOnBasicBlock(BasicBlock &BB) {
64 std::cout << "Printing Analysis info for BasicBlock '" << BB.getName()
65 << "': Pass " << PassToPrint->getPassName() << ":\n";
66 getAnalysisID<Pass>(PassToPrint).print(std::cout, BB.getParent()->getParent());
68 // Get and print pass...
72 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
73 AU.addRequiredID(PassToPrint);
81 static cl::opt<std::string>
82 InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"),
83 cl::value_desc("filename"));
85 static cl::opt<bool> Quiet("q", cl::desc("Don't print analysis pass names"));
86 static cl::alias QuietA("quiet", cl::desc("Alias for -q"),
89 // The AnalysesList is automatically populated with registered Passes by the
92 static cl::list<const PassInfo*, bool,
93 FilteredPassNameParser<PassInfo::Analysis> >
94 AnalysesList(cl::desc("Analyses available:"));
97 int main(int argc, char **argv) {
98 cl::ParseCommandLineOptions(argc, argv, " llvm analysis printer tool\n");
102 CurMod = ParseBytecodeFile(InputFilename);
103 if (!CurMod && !(CurMod = ParseAssemblyFile(InputFilename))){
104 std::cerr << argv[0] << ": input file didn't read correctly.\n";
107 } catch (const ParseException &E) {
108 std::cerr << argv[0] << ": " << E.getMessage() << "\n";
112 // Create a PassManager to hold and optimize the collection of passes we are
117 // Create a new optimization pass for each one specified on the command line
118 for (unsigned i = 0; i < AnalysesList.size(); ++i) {
119 const PassInfo *Analysis = AnalysesList[i];
121 if (Analysis->getNormalCtor()) {
122 Pass *P = Analysis->getNormalCtor()();
125 if (BasicBlockPass *BBP = dynamic_cast<BasicBlockPass*>(P))
126 Passes.add(new BasicBlockPassPrinter(Analysis));
127 else if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P))
128 Passes.add(new FunctionPassPrinter(Analysis));
130 Passes.add(new ModulePassPrinter(Analysis));
133 std::cerr << argv[0] << ": cannot create pass: "
134 << Analysis->getPassName() << "\n";