Convert analyze over to use new pass framework for its analyses

llvm-svn: 1607
This commit is contained in:
Chris Lattner 2002-01-31 00:46:09 +00:00
parent cdd09c2c17
commit 3d61db42bb
1 changed files with 193 additions and 149 deletions

View File

@ -1,4 +1,4 @@
//===------------------------------------------------------------------------=== //===----------------------------------------------------------------------===//
// LLVM 'Analyze' UTILITY // LLVM 'Analyze' UTILITY
// //
// This utility is designed to print out the results of running various analysis // This utility is designed to print out the results of running various analysis
@ -8,14 +8,16 @@
// analyze --help - Output information about command line switches // analyze --help - Output information about command line switches
// analyze --quiet - Do not print analysis name before output // analyze --quiet - Do not print analysis name before output
// //
//===------------------------------------------------------------------------=== //===----------------------------------------------------------------------===//
#include "llvm/Instruction.h" #include "llvm/Instruction.h"
#include "llvm/Module.h" #include "llvm/Module.h"
#include "llvm/Method.h" #include "llvm/Method.h"
#include "llvm/iPHINode.h" #include "llvm/iPHINode.h"
#include "llvm/PassManager.h"
#include "llvm/Bytecode/Reader.h" #include "llvm/Bytecode/Reader.h"
#include "llvm/Assembly/Parser.h" #include "llvm/Assembly/Parser.h"
#include "llvm/Assembly/PrintModulePass.h"
#include "llvm/Analysis/Writer.h" #include "llvm/Analysis/Writer.h"
#include "llvm/Analysis/InstForest.h" #include "llvm/Analysis/InstForest.h"
#include "llvm/Analysis/Dominators.h" #include "llvm/Analysis/Dominators.h"
@ -29,19 +31,111 @@
#include "Support/CommandLine.h" #include "Support/CommandLine.h"
#include <algorithm> #include <algorithm>
#include <iostream> #include <iostream>
using std::cout; using std::cout;
using std::cerr; using std::ostream;
using std::pair; using std::string;
static void PrintMethod(Method *M) { static Module *CurrentModule;
cout << M;
static void operator<<(ostream &O, const FindUsedTypes &FUT) {
FUT.printTypes(cout, CurrentModule);
} }
static void PrintIntervalPartition(Method *M) { static void operator<<(ostream &O, const FindUnsafePointerTypes &FUPT) {
cout << cfg::IntervalPartition(M); FUPT.printResults(CurrentModule, cout);
} }
static void PrintClassifiedExprs(Method *M) {
template <class PassType, class PassName>
class PassPrinter; // Do not implement
template <class PassName>
class PassPrinter<Pass, PassName> : public Pass {
const string Message;
const AnalysisID ID;
public:
PassPrinter(const string &M, AnalysisID id) : Message(M), ID(id) {}
virtual bool run(Module *M) {
cout << Message << "\n" << getAnalysis<PassName>(ID);
return false;
}
virtual void getAnalysisUsageInfo(Pass::AnalysisSet &Required,
Pass::AnalysisSet &Destroyed,
Pass::AnalysisSet &Provided) {
Required.push_back(ID);
}
};
template <class PassName>
class PassPrinter<MethodPass, PassName> : public MethodPass {
const string Message;
const AnalysisID ID;
public:
PassPrinter(const string &M, AnalysisID id) : Message(M), ID(id) {}
virtual bool runOnMethod(Method *M) {
cout << Message << " on method '" << M->getName() << "'\n"
<< getAnalysis<PassName>(ID);
return false;
}
virtual void getAnalysisUsageInfo(Pass::AnalysisSet &Required,
Pass::AnalysisSet &Destroyed,
Pass::AnalysisSet &Provided) {
Required.push_back(ID);
}
};
template <class PassType, class PassName, AnalysisID &ID>
Pass *New(const string &Message) {
return new PassPrinter<PassType, PassName>(Message, ID);
}
template <class PassType, class PassName>
Pass *New(const string &Message) {
return new PassPrinter<PassType, PassName>(Message, PassName::ID);
}
Pass *NewPrintMethod(const string &Message) {
return new PrintMethodPass(Message, &std::cout);
}
Pass *NewPrintModule(const string &Message) {
return new PrintModulePass(&std::cout);
}
struct InstForest : public MethodPass {
void doit(Method *M) {
cout << analysis::InstForest<char>(M);
}
};
struct IndVars : public MethodPass {
void doit(Method *M) {
cfg::LoopInfo &LI = getAnalysis<cfg::LoopInfo>();
for (Method::inst_iterator I = M->inst_begin(), E = M->inst_end();
I != E; ++I)
if (PHINode *PN = dyn_cast<PHINode>(*I)) {
InductionVariable IV(PN, &LI);
if (IV.InductionType != InductionVariable::Unknown)
cout << IV;
}
}
void getAnalysisUsageInfo(Pass::AnalysisSet &Req,
Pass::AnalysisSet &, Pass::AnalysisSet &) {
Req.push_back(cfg::LoopInfo::ID);
}
};
struct Exprs : public MethodPass {
static void doit(Method *M) {
cout << "Classified expressions for: " << M->getName() << "\n"; cout << "Classified expressions for: " << M->getName() << "\n";
Method::inst_iterator I = M->inst_begin(), E = M->inst_end(); Method::inst_iterator I = M->inst_begin(), E = M->inst_end();
for (; I != E; ++I) { for (; I != E; ++I) {
@ -68,72 +162,37 @@ static void PrintClassifiedExprs(Method *M) {
cout << "\n\n"; cout << "\n\n";
} }
} }
};
static void PrintInductionVariables(Method *M) {
cfg::LoopInfo LI(M);
for (Method::inst_iterator I = M->inst_begin(), E = M->inst_end();
I != E; ++I)
if (PHINode *PN = dyn_cast<PHINode>(*I)) {
InductionVariable IV(PN, &LI);
if (IV.InductionType != InductionVariable::Unknown)
cout << IV;
}
}
static void PrintInstForest(Method *M) { template<class TraitClass>
cout << analysis::InstForest<char>(M); class PrinterPass : public TraitClass {
const string Message;
public:
PrinterPass(const string &M) : Message(M) {}
virtual bool runOnMethod(Method *M) {
cout << Message << " on method '" << M->getName() << "'\n";
TraitClass::doit(M);
return false;
} }
static void PrintLoops(Method *M) { };
cout << cfg::LoopInfo(M);
}
static void PrintCallGraph(Module *M) { template<class PassClass>
cout << cfg::CallGraph(M); Pass *Create(const string &Message) {
return new PassClass(Message);
} }
static void PrintUnsafePtrTypes(Module *M) {
FindUnsafePointerTypes FUPT;
FUPT.run(M);
FUPT.printResults(M, cout);
}
static void PrintUsedTypes(Module *M) {
FindUsedTypes FUT;
FUT.run(M);
FUT.printTypes(cout, M);
}
static void PrintDominatorSets(Method *M) {
cout << cfg::DominatorSet(M);
}
static void PrintImmediateDominators(Method *M) {
cout << cfg::ImmediateDominators(M);
}
static void PrintDominatorTree(Method *M) {
cout << cfg::DominatorTree(M);
}
static void PrintDominanceFrontier(Method *M) {
cout << cfg::DominanceFrontier(M);
}
static void PrintPostDominatorSets(Method *M) {
cout << cfg::DominatorSet(M, true);
}
static void PrintImmediatePostDoms(Method *M) {
cout << cfg::ImmediateDominators(cfg::DominatorSet(M, true));
}
static void PrintPostDomTree(Method *M) {
cout << cfg::DominatorTree(cfg::DominatorSet(M, true));
}
static void PrintPostDomFrontier(Method *M) {
cout << cfg::DominanceFrontier(cfg::DominatorSet(M, true));
}
enum Ans { enum Ans {
PassDone, // Unique Marker // global analyses
print, intervals, exprclassify, instforest, loops, indvars, callgraph, print, intervals, exprs, instforest, loops, indvars,
printusedtypes, unsafepointertypes,
// ip analyses
printmodule, callgraph, printusedtypes, unsafepointertypes,
domset, idom, domtree, domfrontier, domset, idom, domtree, domfrontier,
postdomset, postidom, postdomtree, postdomfrontier, postdomset, postidom, postdomtree, postdomfrontier,
@ -143,12 +202,14 @@ cl::String InputFilename ("", "Load <arg> file to analyze", cl::NoFlags, "-");
cl::Flag Quiet ("q", "Don't print analysis pass names"); cl::Flag Quiet ("q", "Don't print analysis pass names");
cl::Alias QuietA ("quiet", "Alias for -q", cl::NoFlags, Quiet); cl::Alias QuietA ("quiet", "Alias for -q", cl::NoFlags, Quiet);
cl::EnumList<enum Ans> AnalysesList(cl::NoFlags, cl::EnumList<enum Ans> AnalysesList(cl::NoFlags,
clEnumVal(print , "Print each Method"), clEnumVal(print , "Print each method"),
clEnumVal(intervals , "Print Interval Partitions"), clEnumVal(intervals , "Print Interval Partitions"),
clEnumVal(exprclassify , "Classify Expressions"), clEnumVal(exprs , "Classify Expressions"),
clEnumVal(instforest , "Print Instruction Forest"), clEnumVal(instforest , "Print Instruction Forest"),
clEnumVal(loops , "Print Loops"), clEnumVal(loops , "Print Loops"),
clEnumVal(indvars , "Print Induction Variables"), clEnumVal(indvars , "Print Induction Variables"),
clEnumVal(printmodule , "Print entire module"),
clEnumVal(callgraph , "Print Call Graph"), clEnumVal(callgraph , "Print Call Graph"),
clEnumVal(printusedtypes , "Print Types Used by Module"), clEnumVal(printusedtypes , "Print Types Used by Module"),
clEnumVal(unsafepointertypes, "Print Unsafe Pointer Types"), clEnumVal(unsafepointertypes, "Print Unsafe Pointer Types"),
@ -164,86 +225,69 @@ cl::EnumList<enum Ans> AnalysesList(cl::NoFlags,
clEnumVal(postdomfrontier, "Print Postdominance Frontier"), clEnumVal(postdomfrontier, "Print Postdominance Frontier"),
0); 0);
struct { struct {
enum Ans AnID; enum Ans AnID;
void (*AnPtr)(Method *M); Pass *(*PassConstructor)(const string &Message);
} MethAnTable[] = { } AnTable[] = {
{ print , PrintMethod }, // Global analyses
{ intervals , PrintIntervalPartition }, { print , NewPrintMethod },
{ exprclassify , PrintClassifiedExprs }, { intervals , New<MethodPass, cfg::IntervalPartition> },
{ instforest , PrintInstForest }, { loops , New<MethodPass, cfg::LoopInfo> },
{ loops , PrintLoops }, { instforest , Create<PrinterPass<InstForest> > },
{ indvars , PrintInductionVariables }, { indvars , Create<PrinterPass<IndVars> > },
{ exprs , Create<PrinterPass<Exprs> > },
{ domset , PrintDominatorSets }, // IP Analyses...
{ idom , PrintImmediateDominators }, { printmodule , NewPrintModule },
{ domtree , PrintDominatorTree }, { printusedtypes , New<Pass, FindUsedTypes> },
{ domfrontier , PrintDominanceFrontier }, { callgraph , New<Pass, cfg::CallGraph> },
{ unsafepointertypes, New<Pass, FindUnsafePointerTypes> },
{ postdomset , PrintPostDominatorSets }, // Dominator analyses
{ postidom , PrintImmediatePostDoms }, { domset , New<MethodPass, cfg::DominatorSet> },
{ postdomtree , PrintPostDomTree }, { idom , New<MethodPass, cfg::ImmediateDominators> },
{ postdomfrontier, PrintPostDomFrontier }, { domtree , New<MethodPass, cfg::DominatorTree> },
{ domfrontier , New<MethodPass, cfg::DominanceFrontier> },
{ postdomset , New<MethodPass, cfg::DominatorSet, cfg::DominatorSet::PostDomID> },
{ postidom , New<MethodPass, cfg::ImmediateDominators, cfg::ImmediateDominators::PostDomID> },
{ postdomtree , New<MethodPass, cfg::DominatorTree, cfg::DominatorTree::PostDomID> },
{ postdomfrontier , New<MethodPass, cfg::DominanceFrontier, cfg::DominanceFrontier::PostDomID> },
}; };
pair<enum Ans, void (*)(Module *)> ModAnTable[] = {
pair<enum Ans, void (*)(Module *)>(callgraph , PrintCallGraph),
pair<enum Ans, void (*)(Module *)>(printusedtypes , PrintUsedTypes),
pair<enum Ans, void (*)(Module *)>(unsafepointertypes, PrintUnsafePtrTypes),
};
int main(int argc, char **argv) { int main(int argc, char **argv) {
cl::ParseCommandLineOptions(argc, argv, " llvm analysis printer tool\n"); cl::ParseCommandLineOptions(argc, argv, " llvm analysis printer tool\n");
Module *C = ParseBytecodeFile(InputFilename); CurrentModule = ParseBytecodeFile(InputFilename);
if (!C && !(C = ParseAssemblyFile(InputFilename))) { if (!CurrentModule && !(CurrentModule = ParseAssemblyFile(InputFilename))) {
cerr << "Input file didn't read correctly.\n"; std::cerr << "Input file didn't read correctly.\n";
return 1; return 1;
} }
// Loop over all of the analyses looking for module level analyses to run... // Create a PassManager to hold and optimize the collection of passes we are
// about to build...
//
PassManager Analyses;
// Loop over all of the analyses looking for analyses to run...
for (unsigned i = 0; i < AnalysesList.size(); ++i) { for (unsigned i = 0; i < AnalysesList.size(); ++i) {
enum Ans AnalysisPass = AnalysesList[i]; enum Ans AnalysisPass = AnalysesList[i];
for (unsigned j = 0; j < sizeof(ModAnTable)/sizeof(ModAnTable[0]); ++j) { for (unsigned j = 0; j < sizeof(AnTable)/sizeof(AnTable[0]); ++j) {
if (ModAnTable[j].first == AnalysisPass) { if (AnTable[j].AnID == AnalysisPass) {
string Message;
if (!Quiet) if (!Quiet)
cerr << "Running: " << AnalysesList.getArgDescription(AnalysisPass) Message = "\nRunning: '" +
<< " analysis on module!\n"; string(AnalysesList.getArgDescription(AnalysisPass)) + "' analysis";
ModAnTable[j].second(C); Analyses.add(AnTable[j].PassConstructor(Message));
AnalysesList[i] = PassDone; // Mark pass as complete so that we don't
break; // get an error later break; // get an error later
} }
} }
} }
// Loop over all of the methods in the module... Analyses.run(CurrentModule);
for (Module::iterator I = C->begin(), E = C->end(); I != E; ++I) {
Method *M = *I;
if (M->isExternal()) continue;
for (unsigned i = 0; i < AnalysesList.size(); ++i) { delete CurrentModule;
enum Ans AnalysisPass = AnalysesList[i];
if (AnalysisPass == PassDone) continue; // Don't rerun module analyses
// Loop over all of the analyses to be run...
unsigned j;
for (j = 0; j < sizeof(MethAnTable)/sizeof(MethAnTable[0]); ++j) {
if (AnalysisPass == MethAnTable[j].AnID) {
if (!Quiet)
cerr << "Running: " << AnalysesList.getArgDescription(AnalysisPass)
<< " analysis on '" << ((Value*)M)->getName() << "'!\n";
MethAnTable[j].AnPtr(M);
break;
}
}
if (j == sizeof(MethAnTable)/sizeof(MethAnTable[0]))
cerr << "Analysis tables inconsistent!\n";
}
}
delete C;
return 0; return 0;
} }