//
// The LLVM Compiler Infrastructure
//
-// This file was developed by Devang Patel and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
#include "llvm/ModuleProvider.h"
#include "llvm/Support/Streams.h"
#include "llvm/Support/ManagedStatic.h"
+#include "llvm-c/Core.h"
#include <algorithm>
#include <vector>
#include <map>
+using namespace llvm;
// See PassManagers.h for Pass Manager infrastructure overview.
public:
static char ID;
- BBPassManager(int Depth)
+ explicit BBPassManager(int Depth)
: PMDataManager(Depth), FunctionPass((intptr_t)&ID) {}
/// Execute all of the passes scheduled for execution. Keep track of
bool doFinalization(Function &F);
virtual const char *getPassName() const {
- return "BasicBlock Pass Manager";
+ return "BasicBlock Pass Manager";
}
// Print passes managed by this manager
public PMTopLevelManager {
public:
static char ID;
- FunctionPassManagerImpl(int Depth) :
+ explicit FunctionPassManagerImpl(int Depth) :
Pass((intptr_t)&ID), PMDataManager(Depth),
PMTopLevelManager(TLM_Function) { }
///
bool doInitialization(Module &M);
- /// doFinalization - Run all of the initializers for the function passes.
+ /// doFinalization - Run all of the finalizers for the function passes.
///
bool doFinalization(Module &M);
// MPPassManager
//
/// MPPassManager manages ModulePasses and function pass managers.
-/// It batches all Module passes passes and function pass managers together and
-/// sequence them to process one module.
+/// It batches all Module passes and function pass managers together and
+/// sequences them to process one module.
class MPPassManager : public Pass, public PMDataManager {
public:
static char ID;
- MPPassManager(int Depth) : Pass((intptr_t)&ID), PMDataManager(Depth) { }
+ explicit MPPassManager(int Depth) :
+ Pass((intptr_t)&ID), PMDataManager(Depth) { }
// Delete on the fly managers.
virtual ~MPPassManager() {
public:
static char ID;
- PassManagerImpl(int Depth) : Pass((intptr_t)&ID), PMDataManager(Depth),
- PMTopLevelManager(TLM_Pass) { }
+ explicit PassManagerImpl(int Depth) :
+ Pass((intptr_t)&ID), PMDataManager(Depth),
+ PMTopLevelManager(TLM_Pass) { }
/// add - Add a pass to the queue of passes to run. This passes ownership of
/// the Pass to the PassManager. When the PassManager is destroyed, the pass
}
/// Set pass P as the last user of the given analysis passes.
-void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
+void PMTopLevelManager::setLastUser(SmallVector<Pass *, 12> &AnalysisPasses,
Pass *P) {
- for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
+ for (SmallVector<Pass *, 12>::iterator I = AnalysisPasses.begin(),
E = AnalysisPasses.end(); I != E; ++I) {
Pass *AP = *I;
LastUser[AP] = P;
}
/// Collect passes whose last user is P
-void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
+void PMTopLevelManager::collectLastUses(SmallVector<Pass *, 12> &LastUses,
Pass *P) {
for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
LUE = LastUser.end(); LUI != LUE; ++LUI)
// TODO : Allocate function manager for this pass, other wise required set
// may be inserted into previous function manager
- // If this Analysis is already requested by one of the previous pass
- // and it is still available then do not insert new pass in the queue again.
- if (findAnalysisPass(P->getPassInfo()))
- return;
-
// Give pass a chance to prepare the stage.
P->preparePassManager(activeStack);
+ // If P is an analysis pass and it is available then do not
+ // generate the analysis again. Stale analysis info should not be
+ // available at this point.
+ if (P->getPassInfo() &&
+ P->getPassInfo()->isAnalysis() && findAnalysisPass(P->getPassInfo()))
+ return;
+
AnalysisUsage AnUsage;
P->getAnalysisUsage(AnUsage);
const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
Pass *P = NULL;
// Check pass managers
- for (std::vector<Pass *>::iterator I = PassManagers.begin(),
+ for (std::vector<PMDataManager *>::iterator I = PassManagers.begin(),
E = PassManagers.end(); P == NULL && I != E; ++I) {
- PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
- assert(PMD && "This is not a PassManager");
+ PMDataManager *PMD = *I;
P = PMD->findAnalysisPass(AID, false);
}
// If Pass not found then check the interfaces implemented by Immutable Pass
if (!P) {
- const std::vector<const PassInfo*> &ImmPI = PI->getInterfacesImplemented();
+ const std::vector<const PassInfo*> &ImmPI =
+ PI->getInterfacesImplemented();
if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end())
P = *I;
}
ImmutablePasses[i]->dumpPassStructure(0);
}
- for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
+ // Every class that derives from PMDataManager also derives from Pass
+ // (sometimes indirectly), but there's no inheritance relationship
+ // between PMDataManager and Pass, so we have to dynamic_cast to get
+ // from a PMDataManager* to a Pass*.
+ for (std::vector<PMDataManager *>::const_iterator I = PassManagers.begin(),
E = PassManagers.end(); I != E; ++I)
- (*I)->dumpPassStructure(1);
+ dynamic_cast<Pass *>(*I)->dumpPassStructure(1);
}
void PMTopLevelManager::dumpArguments() const {
return;
cerr << "Pass Arguments: ";
- for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
+ for (std::vector<PMDataManager *>::const_iterator I = PassManagers.begin(),
E = PassManagers.end(); I != E; ++I) {
- PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
- assert(PMD && "This is not a PassManager");
+ PMDataManager *PMD = *I;
PMD->dumpPassArguments();
}
cerr << "\n";
void PMTopLevelManager::initializeAllAnalysisInfo() {
- for (std::vector<Pass *>::iterator I = PassManagers.begin(),
+ for (std::vector<PMDataManager *>::iterator I = PassManagers.begin(),
E = PassManagers.end(); I != E; ++I) {
- PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
- assert(PMD && "This is not a PassManager");
+ PMDataManager *PMD = *I;
PMD->initializeAnalysisInfo();
}
/// Destructor
PMTopLevelManager::~PMTopLevelManager() {
- for (std::vector<Pass *>::iterator I = PassManagers.begin(),
+ for (std::vector<PMDataManager *>::iterator I = PassManagers.begin(),
E = PassManagers.end(); I != E; ++I)
delete *I;
for (std::vector<ImmutablePass *>::iterator
I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
delete *I;
-
- PassManagers.clear();
}
//===----------------------------------------------------------------------===//
// PMDataManager implementation
-/// Return true IFF pass P's required analysis set does not required new
-/// manager.
-bool PMDataManager::manageablePass(Pass *P) {
-
- // TODO
- // If this pass is not preserving information that is required by a
- // pass maintained by higher level pass manager then do not insert
- // this pass into current manager. Use new manager. For example,
- // For example, If FunctionPass F is not preserving ModulePass Info M1
- // that is used by another ModulePass M2 then do not insert F in
- // current function pass manager.
- return true;
-}
-
/// Augement AvailableAnalysis by adding analysis made available by pass P.
void PMDataManager::recordAvailableAnalysis(Pass *P) {
for (std::vector<Pass *>::iterator I = HigherLevelAnalysis.begin(),
E = HigherLevelAnalysis.end(); I != E; ++I) {
Pass *P1 = *I;
- if (!dynamic_cast<ImmutablePass*>(P1)
- && std::find(PreservedSet.begin(), PreservedSet.end(), P1->getPassInfo()) ==
+ if (!dynamic_cast<ImmutablePass*>(P1) &&
+ std::find(PreservedSet.begin(), PreservedSet.end(),
+ P1->getPassInfo()) ==
PreservedSet.end())
return false;
}
return true;
}
+/// verifyPreservedAnalysis -- Verify analysis presreved by pass P.
+void PMDataManager::verifyPreservedAnalysis(Pass *P) {
+ AnalysisUsage AnUsage;
+ P->getAnalysisUsage(AnUsage);
+ const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
+
+ // Verify preserved analysis
+ for (std::vector<AnalysisID>::const_iterator I = PreservedSet.begin(),
+ E = PreservedSet.end(); I != E; ++I) {
+ AnalysisID AID = *I;
+ Pass *AP = findAnalysisPass(AID, true);
+ if (AP)
+ AP->verifyAnalysis();
+ }
+}
+
/// Remove Analyss not preserved by Pass P
void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
AnalysisUsage AnUsage;
P->getAnalysisUsage(AnUsage);
-
if (AnUsage.getPreservesAll())
return;
I = InheritedAnalysis[Index]->begin(),
E = InheritedAnalysis[Index]->end(); I != E; ) {
std::map<AnalysisID, Pass *>::iterator Info = I++;
- if (!dynamic_cast<ImmutablePass*>(Info->second)
- && std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
+ if (!dynamic_cast<ImmutablePass*>(Info->second) &&
+ std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
PreservedSet.end())
// Remove this analysis
InheritedAnalysis[Index]->erase(Info);
}
/// Remove analysis passes that are not used any longer
-void PMDataManager::removeDeadPasses(Pass *P, std::string Msg,
+void PMDataManager::removeDeadPasses(Pass *P, const char *Msg,
enum PassDebuggingString DBG_STR) {
- std::vector<Pass *> DeadPasses;
+ SmallVector<Pass *, 12> DeadPasses;
// If this is a on the fly manager then it does not have TPM.
if (!TPM)
TPM->collectLastUses(DeadPasses, P);
- for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
+ for (SmallVector<Pass *, 12>::iterator I = DeadPasses.begin(),
E = DeadPasses.end(); I != E; ++I) {
dumpPassInfo(*I, FREEING_MSG, DBG_STR, Msg);
// If a FunctionPass F is the last user of ModulePass info M
// then the F's manager, not F, records itself as a last user of M.
- std::vector<Pass *> TransferLastUses;
+ SmallVector<Pass *, 12> TransferLastUses;
if (ProcessAnalysis) {
// At the moment, this pass is the last user of all required passes.
- std::vector<Pass *> LastUses;
+ SmallVector<Pass *, 12> LastUses;
SmallVector<Pass *, 8> RequiredPasses;
SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
// Print list of passes that are last used by P.
void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
- std::vector<Pass *> LUses;
+ SmallVector<Pass *, 12> LUses;
// If this is a on the fly manager then it does not have TPM.
if (!TPM)
TPM->collectLastUses(LUses, P);
- for (std::vector<Pass *>::iterator I = LUses.begin(),
+ for (SmallVector<Pass *, 12>::iterator I = LUses.begin(),
E = LUses.end(); I != E; ++I) {
llvm::cerr << "--" << std::string(Offset*2, ' ');
(*I)->dumpPassStructure(0);
}
}
-void PMDataManager:: dumpPassInfo(Pass *P, enum PassDebuggingString S1,
- enum PassDebuggingString S2,
- std::string Msg) {
+void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
+ enum PassDebuggingString S2,
+ const char *Msg) {
if (PassDebugging < Executions)
return;
cerr << (void*)this << std::string(getDepth()*2+1, ' ');
cerr << "Executing Pass '" << P->getPassName();
break;
case MODIFICATION_MSG:
- cerr << "' Made Modification '" << P->getPassName();
+ cerr << "Made Modification '" << P->getPassName();
break;
case FREEING_MSG:
cerr << " Freeing Pass '" << P->getPassName();
}
switch (S2) {
case ON_BASICBLOCK_MSG:
- cerr << "' on BasicBlock '" << Msg << "...\n";
+ cerr << "' on BasicBlock '" << Msg << "'...\n";
break;
case ON_FUNCTION_MSG:
- cerr << "' on Function '" << Msg << "...\n";
+ cerr << "' on Function '" << Msg << "'...\n";
break;
case ON_MODULE_MSG:
- cerr << "' on Module '" << Msg << "...\n";
+ cerr << "' on Module '" << Msg << "'...\n";
break;
case ON_LOOP_MSG:
- cerr << "' on Loop " << Msg << "...\n";
+ cerr << "' on Loop " << Msg << "'...\n";
break;
case ON_CG_MSG:
- cerr << "' on Call Graph " << Msg << "...\n";
+ cerr << "' on Call Graph " << Msg << "'...\n";
break;
default:
break;
}
}
+/// Add RequiredPass into list of lower level passes required by pass P.
+/// RequiredPass is run on the fly by Pass Manager when P requests it
+/// through getAnalysis interface.
+/// This should be handled by specific pass manager.
+void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
+ if (TPM) {
+ TPM->dumpArguments();
+ TPM->dumpPasses();
+ }
+
+ // Module Level pass may required Function Level analysis info
+ // (e.g. dominator info). Pass manager uses on the fly function pass manager
+ // to provide this on demand. In that case, in Pass manager terminology,
+ // module level pass is requiring lower level analysis info managed by
+ // lower level pass manager.
+
+ // When Pass manager is not able to order required analysis info, Pass manager
+ // checks whether any lower level manager will be able to provide this
+ // analysis info on demand or not.
+ assert (0 && "Unable to handle Pass that requires lower level Analysis pass");
+}
+
// Destructor
PMDataManager::~PMDataManager() {
E = PassVector.end(); I != E; ++I)
delete *I;
- PassVector.clear();
}
//===----------------------------------------------------------------------===//
AnalysisUsage AnUsage;
BP->getAnalysisUsage(AnUsage);
- dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
+ dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getNameStart());
dumpAnalysisSetInfo("Required", BP, AnUsage.getRequiredSet());
initializeAnalysisImpl(BP);
if (TheTimeInfo) TheTimeInfo->passEnded(BP);
if (Changed)
- dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
+ dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
+ I->getNameStart());
dumpAnalysisSetInfo("Preserved", BP, AnUsage.getPreservedSet());
+ verifyPreservedAnalysis(BP);
removeNotPreservedAnalysis(BP);
recordAvailableAnalysis(BP);
- removeDeadPasses(BP, (*I).getName(), ON_BASICBLOCK_MSG);
-
+ removeDeadPasses(BP, I->getNameStart(), ON_BASICBLOCK_MSG);
}
+
return Changed |= doFinalization(F);
}
// FPM is the top level manager.
FPM->setTopLevelManager(FPM);
- PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
- AnalysisResolver *AR = new AnalysisResolver(*PMD);
+ AnalysisResolver *AR = new AnalysisResolver(*FPM);
FPM->setResolver(AR);
MP = P;
bool FunctionPassManager::run(Function &F) {
std::string errstr;
if (MP->materializeFunction(&F, &errstr)) {
- cerr << "Error reading bytecode file: " << errstr << "\n";
+ cerr << "Error reading bitcode file: " << errstr << "\n";
abort();
}
return FPM->run(F);
return FPM->doInitialization(*MP->getModule());
}
-/// doFinalization - Run all of the initializers for the function passes.
+/// doFinalization - Run all of the finalizers for the function passes.
///
bool FunctionPassManager::doFinalization() {
return FPM->doFinalization(*MP->getModule());
if (F.isDeclaration())
return false;
+
+ // Collect inherited analysis from Module level pass manager.
+ populateInheritedAnalysis(TPM->activeStack);
for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
FunctionPass *FP = getContainedPass(Index);
AnalysisUsage AnUsage;
FP->getAnalysisUsage(AnUsage);
- dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
+ dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getNameStart());
dumpAnalysisSetInfo("Required", FP, AnUsage.getRequiredSet());
initializeAnalysisImpl(FP);
if (TheTimeInfo) TheTimeInfo->passEnded(FP);
if (Changed)
- dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
+ dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getNameStart());
dumpAnalysisSetInfo("Preserved", FP, AnUsage.getPreservedSet());
+ verifyPreservedAnalysis(FP);
removeNotPreservedAnalysis(FP);
recordAvailableAnalysis(FP);
- removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
+ removeDeadPasses(FP, F.getNameStart(), ON_FUNCTION_MSG);
}
return Changed;
}
AnalysisUsage AnUsage;
MP->getAnalysisUsage(AnUsage);
- dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
+ dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG,
+ M.getModuleIdentifier().c_str());
dumpAnalysisSetInfo("Required", MP, AnUsage.getRequiredSet());
initializeAnalysisImpl(MP);
if (Changed)
dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
- M.getModuleIdentifier());
+ M.getModuleIdentifier().c_str());
dumpAnalysisSetInfo("Preserved", MP, AnUsage.getPreservedSet());
+ verifyPreservedAnalysis(MP);
removeNotPreservedAnalysis(MP);
recordAvailableAnalysis(MP);
- removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
+ removeDeadPasses(MP, M.getModuleIdentifier().c_str(), ON_MODULE_MSG);
}
return Changed;
}
FPP->add(RequiredPass);
// Register P as the last user of RequiredPass.
- std::vector<Pass *> LU;
+ SmallVector<Pass *, 12> LU;
LU.push_back(RequiredPass);
FPP->setLastUser(LU, P);
}
}
// Push PM on the stack and set its top level manager.
-void PMStack::push(Pass *P) {
+void PMStack::push(PMDataManager *PM) {
PMDataManager *Top = NULL;
- PMDataManager *PM = dynamic_cast<PMDataManager *>(P);
assert (PM && "Unable to push. Pass Manager expected");
if (this->empty()) {
PM->setTopLevelManager(TPM);
}
- AnalysisResolver *AR = new AnalysisResolver(*Top);
- P->setResolver(AR);
-
S.push_back(PM);
}
for(std::deque<PMDataManager *>::iterator I = S.begin(),
E = S.end(); I != E; ++I) {
Pass *P = dynamic_cast<Pass *>(*I);
- printf ("%s ", P->getPassName());
+ printf("%s ", P->getPassName());
}
if (!S.empty())
- printf ("\n");
+ printf("\n");
}
/// Find appropriate Module Pass Manager in the PM Stack and
// [1] Create new Function Pass Manager
FPP = new FPPassManager(PMD->getDepth() + 1);
+ FPP->populateInheritedAnalysis(PMS);
// [2] Set up new manager's top level manager
PMTopLevelManager *TPM = PMD->getTopLevelManager();
// [3] Assign manager to manage this new manager. This may create
// and push new managers into PMS
- Pass *P = dynamic_cast<Pass *>(FPP);
// If Call Graph Pass Manager is active then use it to manage
// this new Function Pass manager.
if (PMD->getPassManagerType() == PMT_CallGraphPassManager)
- P->assignPassManager(PMS, PMT_CallGraphPassManager);
+ FPP->assignPassManager(PMS, PMT_CallGraphPassManager);
else
- P->assignPassManager(PMS);
+ FPP->assignPassManager(PMS);
// [4] Push new manager into PMS
PMS.push(FPP);
// Basic Pass Manager is a leaf pass manager. It does not handle
// any other pass manager.
- if (!PMS.empty()) {
+ if (!PMS.empty())
BBP = dynamic_cast<BBPassManager *>(PMS.top());
- }
// If leaf manager is not Basic Block Pass manager then create new
// basic Block Pass manager.
// [3] Assign manager to manage this new manager. This may create
// and push new managers into PMS
- Pass *P = dynamic_cast<Pass *>(BBP);
- P->assignPassManager(PMS);
+ BBP->assignPassManager(PMS);
// [4] Push new manager into PMS
PMS.push(BBP);
BBP->add(this);
}
+PassManagerBase::~PassManagerBase() {}
+
+/*===-- C Bindings --------------------------------------------------------===*/
+
+LLVMPassManagerRef LLVMCreatePassManager() {
+ return wrap(new PassManager());
+}
+
+LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef P) {
+ return wrap(new FunctionPassManager(unwrap(P)));
+}
+
+int LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M) {
+ return unwrap<PassManager>(PM)->run(*unwrap(M));
+}
+
+int LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM) {
+ return unwrap<FunctionPassManager>(FPM)->doInitialization();
+}
+int LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F) {
+ return unwrap<FunctionPassManager>(FPM)->run(*unwrap<Function>(F));
+}
+
+int LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM) {
+ return unwrap<FunctionPassManager>(FPM)->doFinalization();
+}
+
+void LLVMDisposePassManager(LLVMPassManagerRef PM) {
+ delete unwrap(PM);
+}