lib/VMCore/Pass.cpp

   1 //===- Pass.cpp - LLVM Pass Infrastructure Implementation -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the LLVM Pass infrastructure.  It is primarily
  11 // responsible with ensuring that passes are executed and batched together
  12 // optimally.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/PassManager.h"
  17 #include "PassManagerT.h"         // PassManagerT implementation
  18 #include "llvm/Module.h"
  19 #include "llvm/ModuleProvider.h"
  20 #include "llvm/ADT/STLExtras.h"
  21 #include "llvm/Support/TypeInfo.h"
  22 #include <iostream>
  23 #include <set>
  24 using namespace llvm;
  25
  26 // IncludeFile - Stub function used to help linking out.
  27 IncludeFile::IncludeFile(void*) {}
  28
  29 //===----------------------------------------------------------------------===//
  30 //   AnalysisID Class Implementation
  31 //
  32
  33 // getCFGOnlyAnalyses - A wrapper around the CFGOnlyAnalyses which make it
  34 // initializer order independent.
  35 static std::vector<const PassInfo*> &getCFGOnlyAnalyses() {
  36   static std::vector<const PassInfo*> CFGOnlyAnalyses;
  37   return CFGOnlyAnalyses;
  38 }
  39
  40 void RegisterPassBase::setOnlyUsesCFG() {
  41   getCFGOnlyAnalyses().push_back(PIObj);
  42 }
  43
  44 //===----------------------------------------------------------------------===//
  45 //   AnalysisResolver Class Implementation
  46 //
  47
  48 void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
  49   assert(P->Resolver == 0 && "Pass already in a PassManager!");
  50   P->Resolver = AR;
  51 }
  52
  53 //===----------------------------------------------------------------------===//
  54 //   AnalysisUsage Class Implementation
  55 //
  56
  57 // setPreservesCFG - This function should be called to by the pass, iff they do
  58 // not:
  59 //
  60 //  1. Add or remove basic blocks from the function
  61 //  2. Modify terminator instructions in any way.
  62 //
  63 // This function annotates the AnalysisUsage info object to say that analyses
  64 // that only depend on the CFG are preserved by this pass.
  65 //
  66 void AnalysisUsage::setPreservesCFG() {
  67   // Since this transformation doesn't modify the CFG, it preserves all analyses
  68   // that only depend on the CFG (like dominators, loop info, etc...)
  69   //
  70   Preserved.insert(Preserved.end(),
  71                    getCFGOnlyAnalyses().begin(), getCFGOnlyAnalyses().end());
  72 }
  73
  74
  75 //===----------------------------------------------------------------------===//
  76 // PassManager implementation - The PassManager class is a simple Pimpl class
  77 // that wraps the PassManagerT template.
  78 //
  79 PassManager::PassManager() : PM(new PassManagerT<Module>()) {}
  80 PassManager::~PassManager() { delete PM; }
  81 void PassManager::add(Pass *P) {
  82   ModulePass *MP = dynamic_cast<ModulePass*>(P);
  83   assert(MP && "Not a modulepass?");
  84   PM->add(MP);
  85 }
  86 bool PassManager::run(Module &M) { return PM->runOnModule(M); }
  87
  88 //===----------------------------------------------------------------------===//
  89 // FunctionPassManager implementation - The FunctionPassManager class
  90 // is a simple Pimpl class that wraps the PassManagerT template. It
  91 // is like PassManager, but only deals in FunctionPasses.
  92 //
  93 FunctionPassManager::FunctionPassManager(ModuleProvider *P) :
  94   PM(new PassManagerT<Function>()), MP(P) {}
  95 FunctionPassManager::~FunctionPassManager() { delete PM; }
  96 void FunctionPassManager::add(FunctionPass *P) { PM->add(P); }
  97 void FunctionPassManager::add(ImmutablePass *IP) { PM->add(IP); }
  98 bool FunctionPassManager::run(Function &F) {
  99   try {
 100     MP->materializeFunction(&F);
 101   } catch (std::string& errstr) {
 102     std::cerr << "Error reading bytecode file: " << errstr << "\n";
 103     abort();
 104   } catch (...) {
 105     std::cerr << "Error reading bytecode file!\n";
 106     abort();
 107   }
 108   return PM->run(F);
 109 }
 110
 111
 112 //===----------------------------------------------------------------------===//
 113 // TimingInfo Class - This class is used to calculate information about the
 114 // amount of time each pass takes to execute.  This only happens with
 115 // -time-passes is enabled on the command line.
 116 //
 117 bool llvm::TimePassesIsEnabled = false;
 118 static cl::opt<bool,true>
 119 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
 120             cl::desc("Time each pass, printing elapsed time for each on exit"));
 121
 122 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
 123 // a non null value (if the -time-passes option is enabled) or it leaves it
 124 // null.  It may be called multiple times.
 125 void TimingInfo::createTheTimeInfo() {
 126   if (!TimePassesIsEnabled || TheTimeInfo) return;
 127
 128   // Constructed the first time this is called, iff -time-passes is enabled.
 129   // This guarantees that the object will be constructed before static globals,
 130   // thus it will be destroyed before them.
 131   static TimingInfo TTI;
 132   TheTimeInfo = &TTI;
 133 }
 134
 135 void PMDebug::PrintArgumentInformation(const Pass *P) {
 136   // Print out passes in pass manager...
 137   if (const AnalysisResolver *PM = dynamic_cast<const AnalysisResolver*>(P)) {
 138     for (unsigned i = 0, e = PM->getNumContainedPasses(); i != e; ++i)
 139       PrintArgumentInformation(PM->getContainedPass(i));
 140
 141   } else {  // Normal pass.  Print argument information...
 142     // Print out arguments for registered passes that are _optimizations_
 143     if (const PassInfo *PI = P->getPassInfo())
 144       if (PI->getPassType() & PassInfo::Optimization)
 145         std::cerr << " -" << PI->getPassArgument();
 146   }
 147 }
 148
 149 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
 150                                    Pass *P, Module *M) {
 151   if (PassDebugging >= Executions) {
 152     std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
 153               << P->getPassName();
 154     if (M) std::cerr << "' on Module '" << M->getModuleIdentifier() << "'\n";
 155     std::cerr << "'...\n";
 156   }
 157 }
 158
 159 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
 160                                    Pass *P, Function *F) {
 161   if (PassDebugging >= Executions) {
 162     std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
 163               << P->getPassName();
 164     if (F) std::cerr << "' on Function '" << F->getName();
 165     std::cerr << "'...\n";
 166   }
 167 }
 168
 169 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
 170                                    Pass *P, BasicBlock *BB) {
 171   if (PassDebugging >= Executions) {
 172     std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
 173               << P->getPassName();
 174     if (BB) std::cerr << "' on BasicBlock '" << BB->getName();
 175     std::cerr << "'...\n";
 176   }
 177 }
 178
 179 void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
 180                                    Pass *P, const std::vector<AnalysisID> &Set){
 181   if (PassDebugging >= Details && !Set.empty()) {
 182     std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
 183     for (unsigned i = 0; i != Set.size(); ++i) {
 184       if (i) std::cerr << ",";
 185       std::cerr << " " << Set[i]->getPassName();
 186     }
 187     std::cerr << "\n";
 188   }
 189 }
 190
 191 //===----------------------------------------------------------------------===//
 192 // Pass Implementation
 193 //
 194
 195 void ModulePass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
 196   PM->addPass(this, AU);
 197 }
 198
 199 bool Pass::mustPreserveAnalysisID(const PassInfo *AnalysisID) const {
 200   return Resolver->getAnalysisToUpdate(AnalysisID) != 0;
 201 }
 202
 203 // dumpPassStructure - Implement the -debug-passes=Structure option
 204 void Pass::dumpPassStructure(unsigned Offset) {
 205   std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
 206 }
 207
 208 // getPassName - Use C++ RTTI to get a SOMEWHAT intelligible name for the pass.
 209 //
 210 const char *Pass::getPassName() const {
 211   if (const PassInfo *PI = getPassInfo())
 212     return PI->getPassName();
 213   return typeid(*this).name();
 214 }
 215
 216 // print - Print out the internal state of the pass.  This is called by Analyze
 217 // to print out the contents of an analysis.  Otherwise it is not necessary to
 218 // implement this method.
 219 //
 220 void Pass::print(std::ostream &O,const Module*) const {
 221   O << "Pass::print not implemented for pass: '" << getPassName() << "'!\n";
 222 }
 223
 224 // dump - call print(std::cerr);
 225 void Pass::dump() const {
 226   print(std::cerr, 0);
 227 }
 228
 229 //===----------------------------------------------------------------------===//
 230 // ImmutablePass Implementation
 231 //
 232 void ImmutablePass::addToPassManager(PassManagerT<Module> *PM,
 233                                      AnalysisUsage &AU) {
 234   PM->addPass(this, AU);
 235 }
 236
 237
 238 //===----------------------------------------------------------------------===//
 239 // FunctionPass Implementation
 240 //
 241
 242 // run - On a module, we run this pass by initializing, runOnFunction'ing once
 243 // for every function in the module, then by finalizing.
 244 //
 245 bool FunctionPass::runOnModule(Module &M) {
 246   bool Changed = doInitialization(M);
 247
 248   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 249     if (!I->isExternal())      // Passes are not run on external functions!
 250     Changed |= runOnFunction(*I);
 251
 252   return Changed | doFinalization(M);
 253 }
 254
 255 // run - On a function, we simply initialize, run the function, then finalize.
 256 //
 257 bool FunctionPass::run(Function &F) {
 258   if (F.isExternal()) return false;// Passes are not run on external functions!
 259
 260   bool Changed = doInitialization(*F.getParent());
 261   Changed |= runOnFunction(F);
 262   return Changed | doFinalization(*F.getParent());
 263 }
 264
 265 void FunctionPass::addToPassManager(PassManagerT<Module> *PM,
 266                                     AnalysisUsage &AU) {
 267   PM->addPass(this, AU);
 268 }
 269
 270 void FunctionPass::addToPassManager(PassManagerT<Function> *PM,
 271                                     AnalysisUsage &AU) {
 272   PM->addPass(this, AU);
 273 }
 274
 275 //===----------------------------------------------------------------------===//
 276 // BasicBlockPass Implementation
 277 //
 278
 279 // To run this pass on a function, we simply call runOnBasicBlock once for each
 280 // function.
 281 //
 282 bool BasicBlockPass::runOnFunction(Function &F) {
 283   bool Changed = doInitialization(F);
 284   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
 285     Changed |= runOnBasicBlock(*I);
 286   return Changed | doFinalization(F);
 287 }
 288
 289 // To run directly on the basic block, we initialize, runOnBasicBlock, then
 290 // finalize.
 291 //
 292 bool BasicBlockPass::runPass(BasicBlock &BB) {
 293   Function &F = *BB.getParent();
 294   Module &M = *F.getParent();
 295   bool Changed = doInitialization(M);
 296   Changed |= doInitialization(F);
 297   Changed |= runOnBasicBlock(BB);
 298   Changed |= doFinalization(F);
 299   Changed |= doFinalization(M);
 300   return Changed;
 301 }
 302
 303 void BasicBlockPass::addToPassManager(PassManagerT<Function> *PM,
 304                                       AnalysisUsage &AU) {
 305   PM->addPass(this, AU);
 306 }
 307
 308 void BasicBlockPass::addToPassManager(PassManagerT<BasicBlock> *PM,
 309                                       AnalysisUsage &AU) {
 310   PM->addPass(this, AU);
 311 }
 312
 313
 314 //===----------------------------------------------------------------------===//
 315 // Pass Registration mechanism
 316 //
 317 static std::map<TypeInfo, PassInfo*> *PassInfoMap = 0;
 318 static std::vector<PassRegistrationListener*> *Listeners = 0;
 319
 320 // getPassInfo - Return the PassInfo data structure that corresponds to this
 321 // pass...
 322 const PassInfo *Pass::getPassInfo() const {
 323   if (PassInfoCache) return PassInfoCache;
 324   return lookupPassInfo(typeid(*this));
 325 }
 326
 327 const PassInfo *Pass::lookupPassInfo(const std::type_info &TI) {
 328   if (PassInfoMap == 0) return 0;
 329   std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->find(TI);
 330   return (I != PassInfoMap->end()) ? I->second : 0;
 331 }
 332
 333 void RegisterPassBase::registerPass(PassInfo *PI) {
 334   if (PassInfoMap == 0)
 335     PassInfoMap = new std::map<TypeInfo, PassInfo*>();
 336
 337   assert(PassInfoMap->find(PI->getTypeInfo()) == PassInfoMap->end() &&
 338          "Pass already registered!");
 339   PIObj = PI;
 340   PassInfoMap->insert(std::make_pair(TypeInfo(PI->getTypeInfo()), PI));
 341
 342   // Notify any listeners...
 343   if (Listeners)
 344     for (std::vector<PassRegistrationListener*>::iterator
 345            I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
 346       (*I)->passRegistered(PI);
 347 }
 348
 349 void RegisterPassBase::unregisterPass(PassInfo *PI) {
 350   assert(PassInfoMap && "Pass registered but not in map!");
 351   std::map<TypeInfo, PassInfo*>::iterator I =
 352     PassInfoMap->find(PI->getTypeInfo());
 353   assert(I != PassInfoMap->end() && "Pass registered but not in map!");
 354
 355   // Remove pass from the map...
 356   PassInfoMap->erase(I);
 357   if (PassInfoMap->empty()) {
 358     delete PassInfoMap;
 359     PassInfoMap = 0;
 360   }
 361
 362   // Notify any listeners...
 363   if (Listeners)
 364     for (std::vector<PassRegistrationListener*>::iterator
 365            I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
 366       (*I)->passUnregistered(PI);
 367
 368   // Delete the PassInfo object itself...
 369   delete PI;
 370 }
 371
 372 //===----------------------------------------------------------------------===//
 373 //                  Analysis Group Implementation Code
 374 //===----------------------------------------------------------------------===//
 375
 376 struct AnalysisGroupInfo {
 377   const PassInfo *DefaultImpl;
 378   std::set<const PassInfo *> Implementations;
 379   AnalysisGroupInfo() : DefaultImpl(0) {}
 380 };
 381
 382 static std::map<const PassInfo *, AnalysisGroupInfo> *AnalysisGroupInfoMap = 0;
 383
 384 // RegisterAGBase implementation
 385 //
 386 RegisterAGBase::RegisterAGBase(const std::type_info &Interface,
 387                                const std::type_info *Pass, bool isDefault)
 388   : ImplementationInfo(0), isDefaultImplementation(isDefault) {
 389
 390   InterfaceInfo = const_cast<PassInfo*>(Pass::lookupPassInfo(Interface));
 391   if (InterfaceInfo == 0) {   // First reference to Interface, add it now.
 392     InterfaceInfo =   // Create the new PassInfo for the interface...
 393       new PassInfo("", "", Interface, PassInfo::AnalysisGroup, 0, 0);
 394     registerPass(InterfaceInfo);
 395     PIObj = 0;
 396   }
 397   assert(InterfaceInfo->getPassType() == PassInfo::AnalysisGroup &&
 398          "Trying to join an analysis group that is a normal pass!");
 399
 400   if (Pass) {
 401     ImplementationInfo = Pass::lookupPassInfo(*Pass);
 402     assert(ImplementationInfo &&
 403            "Must register pass before adding to AnalysisGroup!");
 404
 405     // Make sure we keep track of the fact that the implementation implements
 406     // the interface.
 407     PassInfo *IIPI = const_cast<PassInfo*>(ImplementationInfo);
 408     IIPI->addInterfaceImplemented(InterfaceInfo);
 409
 410     // Lazily allocate to avoid nasty initialization order dependencies
 411     if (AnalysisGroupInfoMap == 0)
 412       AnalysisGroupInfoMap = new std::map<const PassInfo *,AnalysisGroupInfo>();
 413
 414     AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
 415     assert(AGI.Implementations.count(ImplementationInfo) == 0 &&
 416            "Cannot add a pass to the same analysis group more than once!");
 417     AGI.Implementations.insert(ImplementationInfo);
 418     if (isDefault) {
 419       assert(AGI.DefaultImpl == 0 && InterfaceInfo->getNormalCtor() == 0 &&
 420              "Default implementation for analysis group already specified!");
 421       assert(ImplementationInfo->getNormalCtor() &&
 422            "Cannot specify pass as default if it does not have a default ctor");
 423       AGI.DefaultImpl = ImplementationInfo;
 424       InterfaceInfo->setNormalCtor(ImplementationInfo->getNormalCtor());
 425     }
 426   }
 427 }
 428
 429 void RegisterAGBase::setGroupName(const char *Name) {
 430   assert(InterfaceInfo->getPassName()[0] == 0 && "Interface Name already set!");
 431   InterfaceInfo->setPassName(Name);
 432 }
 433
 434 RegisterAGBase::~RegisterAGBase() {
 435   if (ImplementationInfo) {
 436     assert(AnalysisGroupInfoMap && "Inserted into map, but map doesn't exist?");
 437     AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
 438
 439     assert(AGI.Implementations.count(ImplementationInfo) &&
 440            "Pass not a member of analysis group?");
 441
 442     if (AGI.DefaultImpl == ImplementationInfo)
 443       AGI.DefaultImpl = 0;
 444
 445     AGI.Implementations.erase(ImplementationInfo);
 446
 447     // Last member of this analysis group? Unregister PassInfo, delete map entry
 448     if (AGI.Implementations.empty()) {
 449       assert(AGI.DefaultImpl == 0 &&
 450              "Default implementation didn't unregister?");
 451       AnalysisGroupInfoMap->erase(InterfaceInfo);
 452       if (AnalysisGroupInfoMap->empty()) {  // Delete map if empty
 453         delete AnalysisGroupInfoMap;
 454         AnalysisGroupInfoMap = 0;
 455       }
 456
 457       unregisterPass(InterfaceInfo);
 458     }
 459   }
 460 }
 461
 462
 463 //===----------------------------------------------------------------------===//
 464 // PassRegistrationListener implementation
 465 //
 466
 467 // PassRegistrationListener ctor - Add the current object to the list of
 468 // PassRegistrationListeners...
 469 PassRegistrationListener::PassRegistrationListener() {
 470   if (!Listeners) Listeners = new std::vector<PassRegistrationListener*>();
 471   Listeners->push_back(this);
 472 }
 473
 474 // dtor - Remove object from list of listeners...
 475 PassRegistrationListener::~PassRegistrationListener() {
 476   std::vector<PassRegistrationListener*>::iterator I =
 477     std::find(Listeners->begin(), Listeners->end(), this);
 478   assert(Listeners && I != Listeners->end() &&
 479          "PassRegistrationListener not registered!");
 480   Listeners->erase(I);
 481
 482   if (Listeners->empty()) {
 483     delete Listeners;
 484     Listeners = 0;
 485   }
 486 }
 487
 488 // enumeratePasses - Iterate over the registered passes, calling the
 489 // passEnumerate callback on each PassInfo object.
 490 //
 491 void PassRegistrationListener::enumeratePasses() {
 492   if (PassInfoMap)
 493     for (std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->begin(),
 494            E = PassInfoMap->end(); I != E; ++I)
 495       passEnumerate(I->second);
 496 }