lib/VMCore/Pass.cpp

   1 //===- Pass.cpp - LLVM Pass Infrastructure Impementation ------------------===//
   2 //
   3 // This file implements the LLVM Pass infrastructure.  It is primarily
   4 // responsible with ensuring that passes are executed and batched together
   5 // optimally.
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "llvm/PassManager.h"
  10 #include "PassManagerT.h"         // PassManagerT implementation
  11 #include "llvm/Module.h"
  12 #include "Support/STLExtras.h"
  13 #include "Support/TypeInfo.h"
  14 #include <stdio.h>
  15 #include <sys/resource.h>
  16 #include <sys/time.h>
  17 #include <sys/unistd.h>
  18 #include <set>
  19
  20 // IncludeFile - Stub function used to help linking out.
  21 IncludeFile::IncludeFile(void*) {}
  22
  23 //===----------------------------------------------------------------------===//
  24 //   AnalysisID Class Implementation
  25 //
  26
  27 static std::vector<const PassInfo*> CFGOnlyAnalyses;
  28
  29 void RegisterPassBase::setPreservesCFG() {
  30   CFGOnlyAnalyses.push_back(PIObj);
  31 }
  32
  33 //===----------------------------------------------------------------------===//
  34 //   AnalysisResolver Class Implementation
  35 //
  36
  37 void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
  38   assert(P->Resolver == 0 && "Pass already in a PassManager!");
  39   P->Resolver = AR;
  40 }
  41
  42 //===----------------------------------------------------------------------===//
  43 //   AnalysisUsage Class Implementation
  44 //
  45
  46 // preservesCFG - This function should be called to by the pass, iff they do
  47 // not:
  48 //
  49 //  1. Add or remove basic blocks from the function
  50 //  2. Modify terminator instructions in any way.
  51 //
  52 // This function annotates the AnalysisUsage info object to say that analyses
  53 // that only depend on the CFG are preserved by this pass.
  54 //
  55 void AnalysisUsage::preservesCFG() {
  56   // Since this transformation doesn't modify the CFG, it preserves all analyses
  57   // that only depend on the CFG (like dominators, loop info, etc...)
  58   //
  59   Preserved.insert(Preserved.end(),
  60                    CFGOnlyAnalyses.begin(), CFGOnlyAnalyses.end());
  61 }
  62
  63
  64 //===----------------------------------------------------------------------===//
  65 // PassManager implementation - The PassManager class is a simple Pimpl class
  66 // that wraps the PassManagerT template.
  67 //
  68 PassManager::PassManager() : PM(new PassManagerT<Module>()) {}
  69 PassManager::~PassManager() { delete PM; }
  70 void PassManager::add(Pass *P) { PM->add(P); }
  71 bool PassManager::run(Module &M) { return PM->run(M); }
  72
  73
  74 //===----------------------------------------------------------------------===//
  75 // TimingInfo Class - This class is used to calculate information about the
  76 // amount of time each pass takes to execute.  This only happens with
  77 // -time-passes is enabled on the command line.
  78 //
  79 static cl::opt<bool>
  80 EnableTiming("time-passes",
  81             cl::desc("Time each pass, printing elapsed time for each on exit"));
  82
  83 static TimeRecord getTimeRecord() {
  84   static unsigned long PageSize = 0;
  85
  86   if (PageSize == 0) {
  87 #ifdef _SC_PAGE_SIZE
  88     PageSize = sysconf(_SC_PAGE_SIZE);
  89 #else
  90 #ifdef _SC_PAGESIZE
  91     PageSize = sysconf(_SC_PAGESIZE);
  92 #else
  93     PageSize = getpagesize();
  94 #endif
  95 #endif
  96   }
  97
  98   struct rusage RU;
  99   struct timeval T;
 100   gettimeofday(&T, 0);
 101   if (getrusage(RUSAGE_SELF, &RU)) {
 102     perror("getrusage call failed: -time-passes info incorrect!");
 103   }
 104
 105   TimeRecord Result;
 106   Result.Elapsed    =           T.tv_sec +           T.tv_usec/1000000.0;
 107   Result.UserTime   = RU.ru_utime.tv_sec + RU.ru_utime.tv_usec/1000000.0;
 108   Result.SystemTime = RU.ru_stime.tv_sec + RU.ru_stime.tv_usec/1000000.0;
 109   Result.MaxRSS = RU.ru_maxrss*PageSize;
 110
 111   return Result;
 112 }
 113
 114 bool TimeRecord::operator<(const TimeRecord &TR) const {
 115   // Primary sort key is User+System time
 116   if (UserTime+SystemTime < TR.UserTime+TR.SystemTime)
 117     return true;
 118   if (UserTime+SystemTime > TR.UserTime+TR.SystemTime)
 119     return false;
 120
 121   // Secondary sort key is Wall Time
 122   return Elapsed < TR.Elapsed;
 123 }
 124
 125 void TimeRecord::passStart(const TimeRecord &T) {
 126   Elapsed    -= T.Elapsed;
 127   UserTime   -= T.UserTime;
 128   SystemTime -= T.SystemTime;
 129   RSSTemp     = T.MaxRSS;
 130 }
 131
 132 void TimeRecord::passEnd(const TimeRecord &T) {
 133   Elapsed    += T.Elapsed;
 134   UserTime   += T.UserTime;
 135   SystemTime += T.SystemTime;
 136   RSSTemp     = T.MaxRSS - RSSTemp;
 137   MaxRSS      = std::max(MaxRSS, RSSTemp);
 138 }
 139
 140 static void printVal(double Val, double Total) {
 141   if (Total < 1e-7)   // Avoid dividing by zero...
 142     fprintf(stderr, "        -----     ");
 143   else
 144     fprintf(stderr, "  %7.4f (%5.1f%%)", Val, Val*100/Total);
 145 }
 146
 147 void TimeRecord::print(const char *PassName, const TimeRecord &Total) const {
 148   printVal(UserTime, Total.UserTime);
 149   printVal(SystemTime, Total.SystemTime);
 150   printVal(UserTime+SystemTime, Total.UserTime+Total.SystemTime);
 151   printVal(Elapsed, Total.Elapsed);
 152
 153   fprintf(stderr, "  ");
 154
 155   if (Total.MaxRSS)
 156     std::cerr << MaxRSS << "\t";
 157   std::cerr << PassName << "\n";
 158 }
 159
 160
 161 // Create method.  If Timing is enabled, this creates and returns a new timing
 162 // object, otherwise it returns null.
 163 //
 164 TimingInfo *TimingInfo::create() {
 165   return EnableTiming ? new TimingInfo() : 0;
 166 }
 167
 168 void TimingInfo::passStarted(Pass *P) {
 169   TimingData[P].passStart(getTimeRecord());
 170 }
 171 void TimingInfo::passEnded(Pass *P) {
 172   TimingData[P].passEnd(getTimeRecord());
 173 }
 174 void TimeRecord::sum(const TimeRecord &TR) {
 175   Elapsed    += TR.Elapsed;
 176   UserTime   += TR.UserTime;
 177   SystemTime += TR.SystemTime;
 178   MaxRSS     += TR.MaxRSS;
 179 }
 180
 181 // TimingDtor - Print out information about timing information
 182 TimingInfo::~TimingInfo() {
 183   // Iterate over all of the data, converting it into the dual of the data map,
 184   // so that the data is sorted by amount of time taken, instead of pointer.
 185   //
 186   std::vector<std::pair<TimeRecord, Pass*> > Data;
 187   TimeRecord Total;
 188   for (std::map<Pass*, TimeRecord>::iterator I = TimingData.begin(),
 189          E = TimingData.end(); I != E; ++I)
 190     // Throw out results for "grouping" pass managers...
 191     if (!dynamic_cast<AnalysisResolver*>(I->first)) {
 192       Data.push_back(std::make_pair(I->second, I->first));
 193       Total.sum(I->second);
 194     }
 195
 196   // Sort the data by time as the primary key, in reverse order...
 197   std::sort(Data.begin(), Data.end(),
 198             std::greater<std::pair<TimeRecord, Pass*> >());
 199
 200   // Print out timing header...
 201   std::cerr << std::string(79, '=') << "\n"
 202             << "                      ... Pass execution timing report ...\n"
 203             << std::string(79, '=') << "\n  Total Execution Time: "
 204             << (Total.UserTime+Total.SystemTime) << " seconds ("
 205             << Total.Elapsed << " wall clock)\n\n   ---User Time---   "
 206             << "--System Time--   --User+System--   ---Wall Time---";
 207
 208   if (Total.MaxRSS)
 209     std::cerr << " ---Mem---";
 210   std::cerr << "  --- Pass Name ---\n";
 211
 212   // Loop through all of the timing data, printing it out...
 213   for (unsigned i = 0, e = Data.size(); i != e; ++i)
 214     Data[i].first.print(Data[i].second->getPassName(), Total);
 215
 216   Total.print("TOTAL", Total);
 217 }
 218
 219
 220 void PMDebug::PrintArgumentInformation(const Pass *P) {
 221   // Print out passes in pass manager...
 222   if (const AnalysisResolver *PM = dynamic_cast<const AnalysisResolver*>(P)) {
 223     for (unsigned i = 0, e = PM->getNumContainedPasses(); i != e; ++i)
 224       PrintArgumentInformation(PM->getContainedPass(i));
 225
 226   } else {  // Normal pass.  Print argument information...
 227     // Print out arguments for registered passes that are _optimizations_
 228     if (const PassInfo *PI = P->getPassInfo())
 229       if (PI->getPassType() & PassInfo::Optimization)
 230         std::cerr << " -" << PI->getPassArgument();
 231   }
 232 }
 233
 234 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
 235                                    Pass *P, Annotable *V) {
 236   if (PassDebugging >= Executions) {
 237     std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
 238               << P->getPassName();
 239     if (V) {
 240       std::cerr << "' on ";
 241
 242       if (dynamic_cast<Module*>(V)) {
 243         std::cerr << "Module\n"; return;
 244       } else if (Function *F = dynamic_cast<Function*>(V))
 245         std::cerr << "Function '" << F->getName();
 246       else if (BasicBlock *BB = dynamic_cast<BasicBlock*>(V))
 247         std::cerr << "BasicBlock '" << BB->getName();
 248       else if (Value *Val = dynamic_cast<Value*>(V))
 249         std::cerr << typeid(*Val).name() << " '" << Val->getName();
 250     }
 251     std::cerr << "'...\n";
 252   }
 253 }
 254
 255 void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
 256                                    Pass *P, const std::vector<AnalysisID> &Set){
 257   if (PassDebugging >= Details && !Set.empty()) {
 258     std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
 259     for (unsigned i = 0; i != Set.size(); ++i) {
 260       if (i) std::cerr << ",";
 261       std::cerr << " " << Set[i]->getPassName();
 262     }
 263     std::cerr << "\n";
 264   }
 265 }
 266
 267 //===----------------------------------------------------------------------===//
 268 // Pass Implementation
 269 //
 270
 271 void Pass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
 272   PM->addPass(this, AU);
 273 }
 274
 275 // dumpPassStructure - Implement the -debug-passes=Structure option
 276 void Pass::dumpPassStructure(unsigned Offset) {
 277   std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
 278 }
 279
 280 // getPassName - Use C++ RTTI to get a SOMEWHAT intelligable name for the pass.
 281 //
 282 const char *Pass::getPassName() const {
 283   if (const PassInfo *PI = getPassInfo())
 284     return PI->getPassName();
 285   return typeid(*this).name();
 286 }
 287
 288 // print - Print out the internal state of the pass.  This is called by Analyse
 289 // to print out the contents of an analysis.  Otherwise it is not neccesary to
 290 // implement this method.
 291 //
 292 void Pass::print(std::ostream &O) const {
 293   O << "Pass::print not implemented for pass: '" << getPassName() << "'!\n";
 294 }
 295
 296 // dump - call print(std::cerr);
 297 void Pass::dump() const {
 298   print(std::cerr, 0);
 299 }
 300
 301 //===----------------------------------------------------------------------===//
 302 // ImmutablePass Implementation
 303 //
 304 void ImmutablePass::addToPassManager(PassManagerT<Module> *PM,
 305                                      AnalysisUsage &AU) {
 306   PM->addPass(this, AU);
 307 }
 308
 309
 310 //===----------------------------------------------------------------------===//
 311 // FunctionPass Implementation
 312 //
 313
 314 // run - On a module, we run this pass by initializing, runOnFunction'ing once
 315 // for every function in the module, then by finalizing.
 316 //
 317 bool FunctionPass::run(Module &M) {
 318   bool Changed = doInitialization(M);
 319
 320   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 321     if (!I->isExternal())      // Passes are not run on external functions!
 322     Changed |= runOnFunction(*I);
 323
 324   return Changed | doFinalization(M);
 325 }
 326
 327 // run - On a function, we simply initialize, run the function, then finalize.
 328 //
 329 bool FunctionPass::run(Function &F) {
 330   if (F.isExternal()) return false;// Passes are not run on external functions!
 331
 332   return doInitialization(*F.getParent()) | runOnFunction(F)
 333        | doFinalization(*F.getParent());
 334 }
 335
 336 void FunctionPass::addToPassManager(PassManagerT<Module> *PM,
 337                                     AnalysisUsage &AU) {
 338   PM->addPass(this, AU);
 339 }
 340
 341 void FunctionPass::addToPassManager(PassManagerT<Function> *PM,
 342                                     AnalysisUsage &AU) {
 343   PM->addPass(this, AU);
 344 }
 345
 346 //===----------------------------------------------------------------------===//
 347 // BasicBlockPass Implementation
 348 //
 349
 350 // To run this pass on a function, we simply call runOnBasicBlock once for each
 351 // function.
 352 //
 353 bool BasicBlockPass::runOnFunction(Function &F) {
 354   bool Changed = doInitialization(F);
 355   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
 356     Changed |= runOnBasicBlock(*I);
 357   return Changed | doFinalization(F);
 358 }
 359
 360 // To run directly on the basic block, we initialize, runOnBasicBlock, then
 361 // finalize.
 362 //
 363 bool BasicBlockPass::run(BasicBlock &BB) {
 364   Function &F = *BB.getParent();
 365   Module &M = *F.getParent();
 366   return doInitialization(M) | doInitialization(F) | runOnBasicBlock(BB) |
 367          doFinalization(F) | doFinalization(M);
 368 }
 369
 370 void BasicBlockPass::addToPassManager(PassManagerT<Function> *PM,
 371                                       AnalysisUsage &AU) {
 372   PM->addPass(this, AU);
 373 }
 374
 375 void BasicBlockPass::addToPassManager(PassManagerT<BasicBlock> *PM,
 376                                       AnalysisUsage &AU) {
 377   PM->addPass(this, AU);
 378 }
 379
 380
 381 //===----------------------------------------------------------------------===//
 382 // Pass Registration mechanism
 383 //
 384 static std::map<TypeInfo, PassInfo*> *PassInfoMap = 0;
 385 static std::vector<PassRegistrationListener*> *Listeners = 0;
 386
 387 // getPassInfo - Return the PassInfo data structure that corresponds to this
 388 // pass...
 389 const PassInfo *Pass::getPassInfo() const {
 390   if (PassInfoCache) return PassInfoCache;
 391   return lookupPassInfo(typeid(*this));
 392 }
 393
 394 const PassInfo *Pass::lookupPassInfo(const std::type_info &TI) {
 395   if (PassInfoMap == 0) return 0;
 396   std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->find(TI);
 397   return (I != PassInfoMap->end()) ? I->second : 0;
 398 }
 399
 400 void RegisterPassBase::registerPass(PassInfo *PI) {
 401   if (PassInfoMap == 0)
 402     PassInfoMap = new std::map<TypeInfo, PassInfo*>();
 403
 404   assert(PassInfoMap->find(PI->getTypeInfo()) == PassInfoMap->end() &&
 405          "Pass already registered!");
 406   PIObj = PI;
 407   PassInfoMap->insert(std::make_pair(TypeInfo(PI->getTypeInfo()), PI));
 408
 409   // Notify any listeners...
 410   if (Listeners)
 411     for (std::vector<PassRegistrationListener*>::iterator
 412            I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
 413       (*I)->passRegistered(PI);
 414 }
 415
 416 void RegisterPassBase::unregisterPass(PassInfo *PI) {
 417   assert(PassInfoMap && "Pass registered but not in map!");
 418   std::map<TypeInfo, PassInfo*>::iterator I =
 419     PassInfoMap->find(PI->getTypeInfo());
 420   assert(I != PassInfoMap->end() && "Pass registered but not in map!");
 421
 422   // Remove pass from the map...
 423   PassInfoMap->erase(I);
 424   if (PassInfoMap->empty()) {
 425     delete PassInfoMap;
 426     PassInfoMap = 0;
 427   }
 428
 429   // Notify any listeners...
 430   if (Listeners)
 431     for (std::vector<PassRegistrationListener*>::iterator
 432            I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
 433       (*I)->passUnregistered(PI);
 434
 435   // Delete the PassInfo object itself...
 436   delete PI;
 437 }
 438
 439 //===----------------------------------------------------------------------===//
 440 //                  Analysis Group Implementation Code
 441 //===----------------------------------------------------------------------===//
 442
 443 struct AnalysisGroupInfo {
 444   const PassInfo *DefaultImpl;
 445   std::set<const PassInfo *> Implementations;
 446   AnalysisGroupInfo() : DefaultImpl(0) {}
 447 };
 448
 449 static std::map<const PassInfo *, AnalysisGroupInfo> *AnalysisGroupInfoMap = 0;
 450
 451 // RegisterAGBase implementation
 452 //
 453 RegisterAGBase::RegisterAGBase(const std::type_info &Interface,
 454                                const std::type_info *Pass, bool isDefault)
 455   : ImplementationInfo(0), isDefaultImplementation(isDefault) {
 456
 457   InterfaceInfo = const_cast<PassInfo*>(Pass::lookupPassInfo(Interface));
 458   if (InterfaceInfo == 0) {   // First reference to Interface, add it now.
 459     InterfaceInfo =   // Create the new PassInfo for the interface...
 460       new PassInfo("", "", Interface, PassInfo::AnalysisGroup, 0, 0);
 461     registerPass(InterfaceInfo);
 462     PIObj = 0;
 463   }
 464   assert(InterfaceInfo->getPassType() == PassInfo::AnalysisGroup &&
 465          "Trying to join an analysis group that is a normal pass!");
 466
 467   if (Pass) {
 468     ImplementationInfo = Pass::lookupPassInfo(*Pass);
 469     assert(ImplementationInfo &&
 470            "Must register pass before adding to AnalysisGroup!");
 471
 472     // Make sure we keep track of the fact that the implementation implements
 473     // the interface.
 474     PassInfo *IIPI = const_cast<PassInfo*>(ImplementationInfo);
 475     IIPI->addInterfaceImplemented(InterfaceInfo);
 476
 477     // Lazily allocate to avoid nasty initialization order dependencies
 478     if (AnalysisGroupInfoMap == 0)
 479       AnalysisGroupInfoMap = new std::map<const PassInfo *,AnalysisGroupInfo>();
 480
 481     AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
 482     assert(AGI.Implementations.count(ImplementationInfo) == 0 &&
 483            "Cannot add a pass to the same analysis group more than once!");
 484     AGI.Implementations.insert(ImplementationInfo);
 485     if (isDefault) {
 486       assert(AGI.DefaultImpl == 0 && InterfaceInfo->getNormalCtor() == 0 &&
 487              "Default implementation for analysis group already specified!");
 488       assert(ImplementationInfo->getNormalCtor() &&
 489            "Cannot specify pass as default if it does not have a default ctor");
 490       AGI.DefaultImpl = ImplementationInfo;
 491       InterfaceInfo->setNormalCtor(ImplementationInfo->getNormalCtor());
 492     }
 493   }
 494 }
 495
 496 void RegisterAGBase::setGroupName(const char *Name) {
 497   assert(InterfaceInfo->getPassName()[0] == 0 && "Interface Name already set!");
 498   InterfaceInfo->setPassName(Name);
 499 }
 500
 501 RegisterAGBase::~RegisterAGBase() {
 502   if (ImplementationInfo) {
 503     assert(AnalysisGroupInfoMap && "Inserted into map, but map doesn't exist?");
 504     AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
 505
 506     assert(AGI.Implementations.count(ImplementationInfo) &&
 507            "Pass not a member of analysis group?");
 508
 509     if (AGI.DefaultImpl == ImplementationInfo)
 510       AGI.DefaultImpl = 0;
 511
 512     AGI.Implementations.erase(ImplementationInfo);
 513
 514     // Last member of this analysis group? Unregister PassInfo, delete map entry
 515     if (AGI.Implementations.empty()) {
 516       assert(AGI.DefaultImpl == 0 &&
 517              "Default implementation didn't unregister?");
 518       AnalysisGroupInfoMap->erase(InterfaceInfo);
 519       if (AnalysisGroupInfoMap->empty()) {  // Delete map if empty
 520         delete AnalysisGroupInfoMap;
 521         AnalysisGroupInfoMap = 0;
 522       }
 523
 524       unregisterPass(InterfaceInfo);
 525     }
 526   }
 527 }
 528
 529
 530 //===----------------------------------------------------------------------===//
 531 // PassRegistrationListener implementation
 532 //
 533
 534 // PassRegistrationListener ctor - Add the current object to the list of
 535 // PassRegistrationListeners...
 536 PassRegistrationListener::PassRegistrationListener() {
 537   if (!Listeners) Listeners = new std::vector<PassRegistrationListener*>();
 538   Listeners->push_back(this);
 539 }
 540
 541 // dtor - Remove object from list of listeners...
 542 PassRegistrationListener::~PassRegistrationListener() {
 543   std::vector<PassRegistrationListener*>::iterator I =
 544     std::find(Listeners->begin(), Listeners->end(), this);
 545   assert(Listeners && I != Listeners->end() &&
 546          "PassRegistrationListener not registered!");
 547   Listeners->erase(I);
 548
 549   if (Listeners->empty()) {
 550     delete Listeners;
 551     Listeners = 0;
 552   }
 553 }
 554
 555 // enumeratePasses - Iterate over the registered passes, calling the
 556 // passEnumerate callback on each PassInfo object.
 557 //
 558 void PassRegistrationListener::enumeratePasses() {
 559   if (PassInfoMap)
 560     for (std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->begin(),
 561            E = PassInfoMap->end(); I != E; ++I)
 562       passEnumerate(I->second);
 563 }