2002-01-21 07:37:31 +00:00
|
|
|
//===- Pass.cpp - LLVM Pass Infrastructure Impementation ------------------===//
|
|
|
|
//
|
|
|
|
// This file implements the LLVM Pass infrastructure. It is primarily
|
|
|
|
// responsible with ensuring that passes are executed and batched together
|
|
|
|
// optimally.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
#include "llvm/PassManager.h"
|
2002-04-28 20:46:05 +00:00
|
|
|
#include "PassManagerT.h" // PassManagerT implementation
|
2002-01-31 00:45:31 +00:00
|
|
|
#include "llvm/Module.h"
|
2002-03-26 18:01:55 +00:00
|
|
|
#include "llvm/Function.h"
|
2002-02-12 21:07:25 +00:00
|
|
|
#include "llvm/BasicBlock.h"
|
2002-01-21 07:37:31 +00:00
|
|
|
#include "Support/STLExtras.h"
|
2002-04-28 20:46:05 +00:00
|
|
|
#include "Support/CommandLine.h"
|
|
|
|
#include <typeinfo>
|
|
|
|
#include <iostream>
|
2002-01-23 05:49:41 +00:00
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
// Source of unique analysis ID #'s.
|
|
|
|
unsigned AnalysisID::NextID = 0;
|
|
|
|
|
|
|
|
void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
|
|
|
|
assert(P->Resolver == 0 && "Pass already in a PassManager!");
|
|
|
|
P->Resolver = AR;
|
|
|
|
}
|
|
|
|
|
2002-04-28 21:25:41 +00:00
|
|
|
|
|
|
|
// preservesCFG - This function should be called to by the pass, iff they do
|
|
|
|
// not:
|
|
|
|
//
|
|
|
|
// 1. Add or remove basic blocks from the function
|
|
|
|
// 2. Modify terminator instructions in any way.
|
|
|
|
//
|
|
|
|
// This function annotates the AnalysisUsage info object to say that analyses
|
|
|
|
// that only depend on the CFG are preserved by this pass.
|
|
|
|
//
|
|
|
|
void AnalysisUsage::preservesCFG() {
|
|
|
|
// FIXME: implement preservesCFG
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2002-04-28 20:46:05 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// PassManager implementation - The PassManager class is a simple Pimpl class
|
|
|
|
// that wraps the PassManagerT template.
|
|
|
|
//
|
|
|
|
PassManager::PassManager() : PM(new PassManagerT<Module>()) {}
|
|
|
|
PassManager::~PassManager() { delete PM; }
|
|
|
|
void PassManager::add(Pass *P) { PM->add(P); }
|
|
|
|
bool PassManager::run(Module *M) { return PM->run(M); }
|
2002-01-31 00:45:31 +00:00
|
|
|
|
2002-04-28 20:46:05 +00:00
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
2002-01-23 05:49:41 +00:00
|
|
|
// Pass debugging information. Often it is useful to find out what pass is
|
|
|
|
// running when a crash occurs in a utility. When this library is compiled with
|
|
|
|
// debugging on, a command line option (--debug-pass) is enabled that causes the
|
|
|
|
// pass name to be printed before it executes.
|
|
|
|
//
|
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
// Different debug levels that can be enabled...
|
|
|
|
enum PassDebugLevel {
|
|
|
|
None, PassStructure, PassExecutions, PassDetails
|
|
|
|
};
|
2002-01-23 05:49:41 +00:00
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
static cl::Enum<enum PassDebugLevel> PassDebugging("debug-pass", cl::Hidden,
|
|
|
|
"Print PassManager debugging information",
|
|
|
|
clEnumVal(None , "disable debug output"),
|
|
|
|
clEnumVal(PassStructure , "print pass structure before run()"),
|
|
|
|
clEnumVal(PassExecutions, "print pass name before it is executed"),
|
|
|
|
clEnumVal(PassDetails , "print pass details when it is executed"), 0);
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
void PMDebug::PrintPassStructure(Pass *P) {
|
|
|
|
if (PassDebugging >= PassStructure)
|
|
|
|
P->dumpPassStructure();
|
2002-01-21 07:37:31 +00:00
|
|
|
}
|
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
|
2002-04-28 05:14:06 +00:00
|
|
|
Pass *P, Annotable *V) {
|
2002-01-31 00:45:31 +00:00
|
|
|
if (PassDebugging >= PassExecutions) {
|
2002-01-31 18:32:27 +00:00
|
|
|
std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
|
2002-01-31 00:45:31 +00:00
|
|
|
<< typeid(*P).name();
|
|
|
|
if (V) {
|
|
|
|
std::cerr << "' on ";
|
2002-04-28 05:14:06 +00:00
|
|
|
|
|
|
|
if (dynamic_cast<Module*>(V)) {
|
2002-01-31 00:45:31 +00:00
|
|
|
std::cerr << "Module\n"; return;
|
2002-04-28 05:14:06 +00:00
|
|
|
} else if (Function *F = dynamic_cast<Function*>(V))
|
|
|
|
std::cerr << "Function '" << F->getName();
|
|
|
|
else if (BasicBlock *BB = dynamic_cast<BasicBlock*>(V))
|
|
|
|
std::cerr << "BasicBlock '" << BB->getName();
|
|
|
|
else if (Value *Val = dynamic_cast<Value*>(V))
|
|
|
|
std::cerr << typeid(*Val).name() << " '" << Val->getName();
|
2002-01-31 00:45:31 +00:00
|
|
|
}
|
|
|
|
std::cerr << "'...\n";
|
2002-01-21 07:37:31 +00:00
|
|
|
}
|
2002-01-31 00:45:31 +00:00
|
|
|
}
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
|
2002-04-27 06:56:12 +00:00
|
|
|
Pass *P, const std::vector<AnalysisID> &Set){
|
2002-01-31 00:45:31 +00:00
|
|
|
if (PassDebugging >= PassDetails && !Set.empty()) {
|
2002-01-31 18:32:27 +00:00
|
|
|
std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
|
2002-04-27 06:56:12 +00:00
|
|
|
for (unsigned i = 0; i != Set.size(); ++i) {
|
2002-01-31 00:45:31 +00:00
|
|
|
Pass *P = Set[i].createPass(); // Good thing this is just debug code...
|
|
|
|
std::cerr << " " << typeid(*P).name();
|
|
|
|
delete P;
|
2002-01-23 05:49:41 +00:00
|
|
|
}
|
2002-01-31 00:45:31 +00:00
|
|
|
std::cerr << "\n";
|
2002-01-21 07:37:31 +00:00
|
|
|
}
|
2002-01-31 00:45:31 +00:00
|
|
|
}
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
// dumpPassStructure - Implement the -debug-passes=PassStructure option
|
|
|
|
void Pass::dumpPassStructure(unsigned Offset = 0) {
|
|
|
|
std::cerr << std::string(Offset*2, ' ') << typeid(*this).name() << "\n";
|
|
|
|
}
|
2002-01-21 07:37:31 +00:00
|
|
|
|
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Pass Implementation
|
|
|
|
//
|
2002-01-23 05:49:41 +00:00
|
|
|
|
2002-04-27 06:56:12 +00:00
|
|
|
void Pass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
|
|
|
|
PM->addPass(this, AU);
|
2002-01-31 00:45:31 +00:00
|
|
|
}
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-04-27 06:56:12 +00:00
|
|
|
// FunctionPass Implementation
|
2002-01-31 00:45:31 +00:00
|
|
|
//
|
2002-01-22 00:17:48 +00:00
|
|
|
|
2002-04-27 06:56:12 +00:00
|
|
|
// run - On a module, we run this pass by initializing, runOnFunction'ing once
|
|
|
|
// for every function in the module, then by finalizing.
|
2002-01-31 00:45:31 +00:00
|
|
|
//
|
2002-04-27 06:56:12 +00:00
|
|
|
bool FunctionPass::run(Module *M) {
|
2002-01-31 00:45:31 +00:00
|
|
|
bool Changed = doInitialization(M);
|
|
|
|
|
|
|
|
for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
|
2002-04-27 06:56:12 +00:00
|
|
|
if (!(*I)->isExternal()) // Passes are not run on external functions!
|
|
|
|
Changed |= runOnFunction(*I);
|
2002-01-31 00:45:31 +00:00
|
|
|
|
|
|
|
return Changed | doFinalization(M);
|
|
|
|
}
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-04-27 06:56:12 +00:00
|
|
|
// run - On a function, we simply initialize, run the function, then finalize.
|
2002-01-31 00:45:31 +00:00
|
|
|
//
|
2002-04-27 06:56:12 +00:00
|
|
|
bool FunctionPass::run(Function *F) {
|
|
|
|
if (F->isExternal()) return false;// Passes are not run on external functions!
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-04-27 06:56:12 +00:00
|
|
|
return doInitialization(F->getParent()) | runOnFunction(F)
|
2002-03-26 18:01:55 +00:00
|
|
|
| doFinalization(F->getParent());
|
2002-01-31 00:45:31 +00:00
|
|
|
}
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-04-27 06:56:12 +00:00
|
|
|
void FunctionPass::addToPassManager(PassManagerT<Module> *PM,
|
|
|
|
AnalysisUsage &AU) {
|
|
|
|
PM->addPass(this, AU);
|
2002-01-31 00:45:31 +00:00
|
|
|
}
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-04-27 06:56:12 +00:00
|
|
|
void FunctionPass::addToPassManager(PassManagerT<Function> *PM,
|
|
|
|
AnalysisUsage &AU) {
|
|
|
|
PM->addPass(this, AU);
|
2002-01-22 00:17:48 +00:00
|
|
|
}
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// BasicBlockPass Implementation
|
|
|
|
//
|
2002-01-21 07:37:31 +00:00
|
|
|
|
2002-04-27 06:56:12 +00:00
|
|
|
// To run this pass on a function, we simply call runOnBasicBlock once for each
|
|
|
|
// function.
|
2002-01-21 07:37:31 +00:00
|
|
|
//
|
2002-04-27 06:56:12 +00:00
|
|
|
bool BasicBlockPass::runOnFunction(Function *F) {
|
2002-01-31 00:45:31 +00:00
|
|
|
bool Changed = false;
|
2002-03-26 18:01:55 +00:00
|
|
|
for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I)
|
2002-01-31 00:45:31 +00:00
|
|
|
Changed |= runOnBasicBlock(*I);
|
|
|
|
return Changed;
|
2002-01-21 07:37:31 +00:00
|
|
|
}
|
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
// To run directly on the basic block, we initialize, runOnBasicBlock, then
|
|
|
|
// finalize.
|
|
|
|
//
|
|
|
|
bool BasicBlockPass::run(BasicBlock *BB) {
|
|
|
|
Module *M = BB->getParent()->getParent();
|
|
|
|
return doInitialization(M) | runOnBasicBlock(BB) | doFinalization(M);
|
2002-01-21 07:37:31 +00:00
|
|
|
}
|
2002-01-23 05:49:41 +00:00
|
|
|
|
2002-03-26 18:01:55 +00:00
|
|
|
void BasicBlockPass::addToPassManager(PassManagerT<Function> *PM,
|
2002-04-27 06:56:12 +00:00
|
|
|
AnalysisUsage &AU) {
|
|
|
|
PM->addPass(this, AU);
|
2002-01-31 00:45:31 +00:00
|
|
|
}
|
2002-01-23 05:49:41 +00:00
|
|
|
|
2002-01-31 00:45:31 +00:00
|
|
|
void BasicBlockPass::addToPassManager(PassManagerT<BasicBlock> *PM,
|
2002-04-27 06:56:12 +00:00
|
|
|
AnalysisUsage &AU) {
|
|
|
|
PM->addPass(this, AU);
|
2002-01-23 05:49:41 +00:00
|
|
|
}
|
2002-01-31 00:45:31 +00:00
|
|
|
|