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