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