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