PassManager.cpp revision 16b77211cf38b040680ddaf2937499f5e2ca87fd
1//===- PassManager.cpp - LLVM Pass Infrastructure Implementation ----------===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file implements the LLVM Pass Manager infrastructure. 11// 12//===----------------------------------------------------------------------===// 13 14 15#include "llvm/PassManagers.h" 16#include "llvm/Assembly/Writer.h" 17#include "llvm/Support/CommandLine.h" 18#include "llvm/Support/Debug.h" 19#include "llvm/Support/Timer.h" 20#include "llvm/Module.h" 21#include "llvm/Support/ErrorHandling.h" 22#include "llvm/Support/ManagedStatic.h" 23#include "llvm/Support/raw_ostream.h" 24#include "llvm/System/Mutex.h" 25#include "llvm/System/Threading.h" 26#include "llvm-c/Core.h" 27#include <algorithm> 28#include <cstdio> 29#include <map> 30using namespace llvm; 31 32// See PassManagers.h for Pass Manager infrastructure overview. 33 34namespace llvm { 35 36//===----------------------------------------------------------------------===// 37// Pass debugging information. Often it is useful to find out what pass is 38// running when a crash occurs in a utility. When this library is compiled with 39// debugging on, a command line option (--debug-pass) is enabled that causes the 40// pass name to be printed before it executes. 41// 42 43// Different debug levels that can be enabled... 44enum PassDebugLevel { 45 None, Arguments, Structure, Executions, Details 46}; 47 48static cl::opt<enum PassDebugLevel> 49PassDebugging("debug-pass", cl::Hidden, 50 cl::desc("Print PassManager debugging information"), 51 cl::values( 52 clEnumVal(None , "disable debug output"), 53 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"), 54 clEnumVal(Structure , "print pass structure before run()"), 55 clEnumVal(Executions, "print pass name before it is executed"), 56 clEnumVal(Details , "print pass details when it is executed"), 57 clEnumValEnd)); 58} // End of llvm namespace 59 60/// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions 61/// or higher is specified. 62bool PMDataManager::isPassDebuggingExecutionsOrMore() const { 63 return PassDebugging >= Executions; 64} 65 66 67 68 69void PassManagerPrettyStackEntry::print(raw_ostream &OS) const { 70 if (V == 0 && M == 0) 71 OS << "Releasing pass '"; 72 else 73 OS << "Running pass '"; 74 75 OS << P->getPassName() << "'"; 76 77 if (M) { 78 OS << " on module '" << M->getModuleIdentifier() << "'.\n"; 79 return; 80 } 81 if (V == 0) { 82 OS << '\n'; 83 return; 84 } 85 86 OS << " on "; 87 if (isa<Function>(V)) 88 OS << "function"; 89 else if (isa<BasicBlock>(V)) 90 OS << "basic block"; 91 else 92 OS << "value"; 93 94 OS << " '"; 95 WriteAsOperand(OS, V, /*PrintTy=*/false, M); 96 OS << "'\n"; 97} 98 99 100namespace { 101 102//===----------------------------------------------------------------------===// 103// BBPassManager 104// 105/// BBPassManager manages BasicBlockPass. It batches all the 106/// pass together and sequence them to process one basic block before 107/// processing next basic block. 108class BBPassManager : public PMDataManager, public FunctionPass { 109 110public: 111 static char ID; 112 explicit BBPassManager(int Depth) 113 : PMDataManager(Depth), FunctionPass(&ID) {} 114 115 /// Execute all of the passes scheduled for execution. Keep track of 116 /// whether any of the passes modifies the function, and if so, return true. 117 bool runOnFunction(Function &F); 118 119 /// Pass Manager itself does not invalidate any analysis info. 120 void getAnalysisUsage(AnalysisUsage &Info) const { 121 Info.setPreservesAll(); 122 } 123 124 bool doInitialization(Module &M); 125 bool doInitialization(Function &F); 126 bool doFinalization(Module &M); 127 bool doFinalization(Function &F); 128 129 virtual PMDataManager *getAsPMDataManager() { return this; } 130 virtual Pass *getAsPass() { return this; } 131 132 virtual const char *getPassName() const { 133 return "BasicBlock Pass Manager"; 134 } 135 136 // Print passes managed by this manager 137 void dumpPassStructure(unsigned Offset) { 138 llvm::dbgs() << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n"; 139 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 140 BasicBlockPass *BP = getContainedPass(Index); 141 BP->dumpPassStructure(Offset + 1); 142 dumpLastUses(BP, Offset+1); 143 } 144 } 145 146 BasicBlockPass *getContainedPass(unsigned N) { 147 assert(N < PassVector.size() && "Pass number out of range!"); 148 BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]); 149 return BP; 150 } 151 152 virtual PassManagerType getPassManagerType() const { 153 return PMT_BasicBlockPassManager; 154 } 155}; 156 157char BBPassManager::ID = 0; 158} 159 160namespace llvm { 161 162//===----------------------------------------------------------------------===// 163// FunctionPassManagerImpl 164// 165/// FunctionPassManagerImpl manages FPPassManagers 166class FunctionPassManagerImpl : public Pass, 167 public PMDataManager, 168 public PMTopLevelManager { 169private: 170 bool wasRun; 171public: 172 static char ID; 173 explicit FunctionPassManagerImpl(int Depth) : 174 Pass(PT_PassManager, &ID), PMDataManager(Depth), 175 PMTopLevelManager(TLM_Function), wasRun(false) { } 176 177 /// add - Add a pass to the queue of passes to run. This passes ownership of 178 /// the Pass to the PassManager. When the PassManager is destroyed, the pass 179 /// will be destroyed as well, so there is no need to delete the pass. This 180 /// implies that all passes MUST be allocated with 'new'. 181 void add(Pass *P) { 182 schedulePass(P); 183 } 184 185 // Prepare for running an on the fly pass, freeing memory if needed 186 // from a previous run. 187 void releaseMemoryOnTheFly(); 188 189 /// run - Execute all of the passes scheduled for execution. Keep track of 190 /// whether any of the passes modifies the module, and if so, return true. 191 bool run(Function &F); 192 193 /// doInitialization - Run all of the initializers for the function passes. 194 /// 195 bool doInitialization(Module &M); 196 197 /// doFinalization - Run all of the finalizers for the function passes. 198 /// 199 bool doFinalization(Module &M); 200 201 202 virtual PMDataManager *getAsPMDataManager() { return this; } 203 virtual Pass *getAsPass() { return this; } 204 205 /// Pass Manager itself does not invalidate any analysis info. 206 void getAnalysisUsage(AnalysisUsage &Info) const { 207 Info.setPreservesAll(); 208 } 209 210 inline void addTopLevelPass(Pass *P) { 211 if (ImmutablePass *IP = P->getAsImmutablePass()) { 212 // P is a immutable pass and it will be managed by this 213 // top level manager. Set up analysis resolver to connect them. 214 AnalysisResolver *AR = new AnalysisResolver(*this); 215 P->setResolver(AR); 216 initializeAnalysisImpl(P); 217 addImmutablePass(IP); 218 recordAvailableAnalysis(IP); 219 } else { 220 P->assignPassManager(activeStack); 221 } 222 223 } 224 225 FPPassManager *getContainedManager(unsigned N) { 226 assert(N < PassManagers.size() && "Pass number out of range!"); 227 FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]); 228 return FP; 229 } 230}; 231 232char FunctionPassManagerImpl::ID = 0; 233//===----------------------------------------------------------------------===// 234// MPPassManager 235// 236/// MPPassManager manages ModulePasses and function pass managers. 237/// It batches all Module passes and function pass managers together and 238/// sequences them to process one module. 239class MPPassManager : public Pass, public PMDataManager { 240public: 241 static char ID; 242 explicit MPPassManager(int Depth) : 243 Pass(PT_PassManager, &ID), PMDataManager(Depth) { } 244 245 // Delete on the fly managers. 246 virtual ~MPPassManager() { 247 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator 248 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end(); 249 I != E; ++I) { 250 FunctionPassManagerImpl *FPP = I->second; 251 delete FPP; 252 } 253 } 254 255 /// run - Execute all of the passes scheduled for execution. Keep track of 256 /// whether any of the passes modifies the module, and if so, return true. 257 bool runOnModule(Module &M); 258 259 /// Pass Manager itself does not invalidate any analysis info. 260 void getAnalysisUsage(AnalysisUsage &Info) const { 261 Info.setPreservesAll(); 262 } 263 264 /// Add RequiredPass into list of lower level passes required by pass P. 265 /// RequiredPass is run on the fly by Pass Manager when P requests it 266 /// through getAnalysis interface. 267 virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass); 268 269 /// Return function pass corresponding to PassInfo PI, that is 270 /// required by module pass MP. Instantiate analysis pass, by using 271 /// its runOnFunction() for function F. 272 virtual Pass* getOnTheFlyPass(Pass *MP, const PassInfo *PI, Function &F); 273 274 virtual const char *getPassName() const { 275 return "Module Pass Manager"; 276 } 277 278 virtual PMDataManager *getAsPMDataManager() { return this; } 279 virtual Pass *getAsPass() { return this; } 280 281 // Print passes managed by this manager 282 void dumpPassStructure(unsigned Offset) { 283 llvm::dbgs() << std::string(Offset*2, ' ') << "ModulePass Manager\n"; 284 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 285 ModulePass *MP = getContainedPass(Index); 286 MP->dumpPassStructure(Offset + 1); 287 std::map<Pass *, FunctionPassManagerImpl *>::const_iterator I = 288 OnTheFlyManagers.find(MP); 289 if (I != OnTheFlyManagers.end()) 290 I->second->dumpPassStructure(Offset + 2); 291 dumpLastUses(MP, Offset+1); 292 } 293 } 294 295 ModulePass *getContainedPass(unsigned N) { 296 assert(N < PassVector.size() && "Pass number out of range!"); 297 return static_cast<ModulePass *>(PassVector[N]); 298 } 299 300 virtual PassManagerType getPassManagerType() const { 301 return PMT_ModulePassManager; 302 } 303 304 private: 305 /// Collection of on the fly FPPassManagers. These managers manage 306 /// function passes that are required by module passes. 307 std::map<Pass *, FunctionPassManagerImpl *> OnTheFlyManagers; 308}; 309 310char MPPassManager::ID = 0; 311//===----------------------------------------------------------------------===// 312// PassManagerImpl 313// 314 315/// PassManagerImpl manages MPPassManagers 316class PassManagerImpl : public Pass, 317 public PMDataManager, 318 public PMTopLevelManager { 319 320public: 321 static char ID; 322 explicit PassManagerImpl(int Depth) : 323 Pass(PT_PassManager, &ID), PMDataManager(Depth), 324 PMTopLevelManager(TLM_Pass) { } 325 326 /// add - Add a pass to the queue of passes to run. This passes ownership of 327 /// the Pass to the PassManager. When the PassManager is destroyed, the pass 328 /// will be destroyed as well, so there is no need to delete the pass. This 329 /// implies that all passes MUST be allocated with 'new'. 330 void add(Pass *P) { 331 schedulePass(P); 332 } 333 334 /// run - Execute all of the passes scheduled for execution. Keep track of 335 /// whether any of the passes modifies the module, and if so, return true. 336 bool run(Module &M); 337 338 /// Pass Manager itself does not invalidate any analysis info. 339 void getAnalysisUsage(AnalysisUsage &Info) const { 340 Info.setPreservesAll(); 341 } 342 343 inline void addTopLevelPass(Pass *P) { 344 if (ImmutablePass *IP = P->getAsImmutablePass()) { 345 // P is a immutable pass and it will be managed by this 346 // top level manager. Set up analysis resolver to connect them. 347 AnalysisResolver *AR = new AnalysisResolver(*this); 348 P->setResolver(AR); 349 initializeAnalysisImpl(P); 350 addImmutablePass(IP); 351 recordAvailableAnalysis(IP); 352 } else { 353 P->assignPassManager(activeStack); 354 } 355 } 356 357 virtual PMDataManager *getAsPMDataManager() { return this; } 358 virtual Pass *getAsPass() { return this; } 359 360 MPPassManager *getContainedManager(unsigned N) { 361 assert(N < PassManagers.size() && "Pass number out of range!"); 362 MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]); 363 return MP; 364 } 365}; 366 367char PassManagerImpl::ID = 0; 368} // End of llvm namespace 369 370namespace { 371 372//===----------------------------------------------------------------------===// 373/// TimingInfo Class - This class is used to calculate information about the 374/// amount of time each pass takes to execute. This only happens when 375/// -time-passes is enabled on the command line. 376/// 377 378static ManagedStatic<sys::SmartMutex<true> > TimingInfoMutex; 379 380class TimingInfo { 381 std::map<Pass*, Timer> TimingData; 382 TimerGroup TG; 383 384public: 385 // Use 'create' member to get this. 386 TimingInfo() : TG("... Pass execution timing report ...") {} 387 388 // TimingDtor - Print out information about timing information 389 ~TimingInfo() { 390 // Delete all of the timers... 391 TimingData.clear(); 392 // TimerGroup is deleted next, printing the report. 393 } 394 395 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer 396 // to a non null value (if the -time-passes option is enabled) or it leaves it 397 // null. It may be called multiple times. 398 static void createTheTimeInfo(); 399 400 /// passStarted - This method creates a timer for the given pass if it doesn't 401 /// already have one, and starts the timer. 402 Timer *passStarted(Pass *P) { 403 if (P->getAsPMDataManager()) 404 return 0; 405 406 sys::SmartScopedLock<true> Lock(*TimingInfoMutex); 407 std::map<Pass*, Timer>::iterator I = TimingData.find(P); 408 if (I == TimingData.end()) 409 I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first; 410 Timer *T = &I->second; 411 T->startTimer(); 412 return T; 413 } 414}; 415 416} // End of anon namespace 417 418static TimingInfo *TheTimeInfo; 419 420//===----------------------------------------------------------------------===// 421// PMTopLevelManager implementation 422 423/// Initialize top level manager. Create first pass manager. 424PMTopLevelManager::PMTopLevelManager(enum TopLevelManagerType t) { 425 if (t == TLM_Pass) { 426 MPPassManager *MPP = new MPPassManager(1); 427 MPP->setTopLevelManager(this); 428 addPassManager(MPP); 429 activeStack.push(MPP); 430 } else if (t == TLM_Function) { 431 FPPassManager *FPP = new FPPassManager(1); 432 FPP->setTopLevelManager(this); 433 addPassManager(FPP); 434 activeStack.push(FPP); 435 } 436} 437 438/// Set pass P as the last user of the given analysis passes. 439void PMTopLevelManager::setLastUser(SmallVector<Pass *, 12> &AnalysisPasses, 440 Pass *P) { 441 for (SmallVector<Pass *, 12>::iterator I = AnalysisPasses.begin(), 442 E = AnalysisPasses.end(); I != E; ++I) { 443 Pass *AP = *I; 444 LastUser[AP] = P; 445 446 if (P == AP) 447 continue; 448 449 // If AP is the last user of other passes then make P last user of 450 // such passes. 451 for (DenseMap<Pass *, Pass *>::iterator LUI = LastUser.begin(), 452 LUE = LastUser.end(); LUI != LUE; ++LUI) { 453 if (LUI->second == AP) 454 // DenseMap iterator is not invalidated here because 455 // this is just updating exisitng entry. 456 LastUser[LUI->first] = P; 457 } 458 } 459} 460 461/// Collect passes whose last user is P 462void PMTopLevelManager::collectLastUses(SmallVector<Pass *, 12> &LastUses, 463 Pass *P) { 464 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator DMI = 465 InversedLastUser.find(P); 466 if (DMI == InversedLastUser.end()) 467 return; 468 469 SmallPtrSet<Pass *, 8> &LU = DMI->second; 470 for (SmallPtrSet<Pass *, 8>::iterator I = LU.begin(), 471 E = LU.end(); I != E; ++I) { 472 LastUses.push_back(*I); 473 } 474 475} 476 477AnalysisUsage *PMTopLevelManager::findAnalysisUsage(Pass *P) { 478 AnalysisUsage *AnUsage = NULL; 479 DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.find(P); 480 if (DMI != AnUsageMap.end()) 481 AnUsage = DMI->second; 482 else { 483 AnUsage = new AnalysisUsage(); 484 P->getAnalysisUsage(*AnUsage); 485 AnUsageMap[P] = AnUsage; 486 } 487 return AnUsage; 488} 489 490/// Schedule pass P for execution. Make sure that passes required by 491/// P are run before P is run. Update analysis info maintained by 492/// the manager. Remove dead passes. This is a recursive function. 493void PMTopLevelManager::schedulePass(Pass *P) { 494 495 // TODO : Allocate function manager for this pass, other wise required set 496 // may be inserted into previous function manager 497 498 // Give pass a chance to prepare the stage. 499 P->preparePassManager(activeStack); 500 501 // If P is an analysis pass and it is available then do not 502 // generate the analysis again. Stale analysis info should not be 503 // available at this point. 504 if (P->getPassInfo() && 505 P->getPassInfo()->isAnalysis() && findAnalysisPass(P->getPassInfo())) { 506 delete P; 507 return; 508 } 509 510 AnalysisUsage *AnUsage = findAnalysisUsage(P); 511 512 bool checkAnalysis = true; 513 while (checkAnalysis) { 514 checkAnalysis = false; 515 516 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet(); 517 for (AnalysisUsage::VectorType::const_iterator I = RequiredSet.begin(), 518 E = RequiredSet.end(); I != E; ++I) { 519 520 Pass *AnalysisPass = findAnalysisPass(*I); 521 if (!AnalysisPass) { 522 AnalysisPass = (*I)->createPass(); 523 if (P->getPotentialPassManagerType () == 524 AnalysisPass->getPotentialPassManagerType()) 525 // Schedule analysis pass that is managed by the same pass manager. 526 schedulePass(AnalysisPass); 527 else if (P->getPotentialPassManagerType () > 528 AnalysisPass->getPotentialPassManagerType()) { 529 // Schedule analysis pass that is managed by a new manager. 530 schedulePass(AnalysisPass); 531 // Recheck analysis passes to ensure that required analysises that 532 // are already checked are still available. 533 checkAnalysis = true; 534 } 535 else 536 // Do not schedule this analysis. Lower level analsyis 537 // passes are run on the fly. 538 delete AnalysisPass; 539 } 540 } 541 } 542 543 // Now all required passes are available. 544 addTopLevelPass(P); 545} 546 547/// Find the pass that implements Analysis AID. Search immutable 548/// passes and all pass managers. If desired pass is not found 549/// then return NULL. 550Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) { 551 552 Pass *P = NULL; 553 // Check pass managers 554 for (SmallVector<PMDataManager *, 8>::iterator I = PassManagers.begin(), 555 E = PassManagers.end(); P == NULL && I != E; ++I) { 556 PMDataManager *PMD = *I; 557 P = PMD->findAnalysisPass(AID, false); 558 } 559 560 // Check other pass managers 561 for (SmallVector<PMDataManager *, 8>::iterator 562 I = IndirectPassManagers.begin(), 563 E = IndirectPassManagers.end(); P == NULL && I != E; ++I) 564 P = (*I)->findAnalysisPass(AID, false); 565 566 for (SmallVector<ImmutablePass *, 8>::iterator I = ImmutablePasses.begin(), 567 E = ImmutablePasses.end(); P == NULL && I != E; ++I) { 568 const PassInfo *PI = (*I)->getPassInfo(); 569 if (PI == AID) 570 P = *I; 571 572 // If Pass not found then check the interfaces implemented by Immutable Pass 573 if (!P) { 574 const std::vector<const PassInfo*> &ImmPI = 575 PI->getInterfacesImplemented(); 576 if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end()) 577 P = *I; 578 } 579 } 580 581 return P; 582} 583 584// Print passes managed by this top level manager. 585void PMTopLevelManager::dumpPasses() const { 586 587 if (PassDebugging < Structure) 588 return; 589 590 // Print out the immutable passes 591 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) { 592 ImmutablePasses[i]->dumpPassStructure(0); 593 } 594 595 // Every class that derives from PMDataManager also derives from Pass 596 // (sometimes indirectly), but there's no inheritance relationship 597 // between PMDataManager and Pass, so we have to getAsPass to get 598 // from a PMDataManager* to a Pass*. 599 for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(), 600 E = PassManagers.end(); I != E; ++I) 601 (*I)->getAsPass()->dumpPassStructure(1); 602} 603 604void PMTopLevelManager::dumpArguments() const { 605 606 if (PassDebugging < Arguments) 607 return; 608 609 dbgs() << "Pass Arguments: "; 610 for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(), 611 E = PassManagers.end(); I != E; ++I) 612 (*I)->dumpPassArguments(); 613 dbgs() << "\n"; 614} 615 616void PMTopLevelManager::initializeAllAnalysisInfo() { 617 for (SmallVector<PMDataManager *, 8>::iterator I = PassManagers.begin(), 618 E = PassManagers.end(); I != E; ++I) 619 (*I)->initializeAnalysisInfo(); 620 621 // Initailize other pass managers 622 for (SmallVector<PMDataManager *, 8>::iterator I = IndirectPassManagers.begin(), 623 E = IndirectPassManagers.end(); I != E; ++I) 624 (*I)->initializeAnalysisInfo(); 625 626 for (DenseMap<Pass *, Pass *>::iterator DMI = LastUser.begin(), 627 DME = LastUser.end(); DMI != DME; ++DMI) { 628 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator InvDMI = 629 InversedLastUser.find(DMI->second); 630 if (InvDMI != InversedLastUser.end()) { 631 SmallPtrSet<Pass *, 8> &L = InvDMI->second; 632 L.insert(DMI->first); 633 } else { 634 SmallPtrSet<Pass *, 8> L; L.insert(DMI->first); 635 InversedLastUser[DMI->second] = L; 636 } 637 } 638} 639 640/// Destructor 641PMTopLevelManager::~PMTopLevelManager() { 642 for (SmallVector<PMDataManager *, 8>::iterator I = PassManagers.begin(), 643 E = PassManagers.end(); I != E; ++I) 644 delete *I; 645 646 for (SmallVector<ImmutablePass *, 8>::iterator 647 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I) 648 delete *I; 649 650 for (DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.begin(), 651 DME = AnUsageMap.end(); DMI != DME; ++DMI) 652 delete DMI->second; 653} 654 655//===----------------------------------------------------------------------===// 656// PMDataManager implementation 657 658/// Augement AvailableAnalysis by adding analysis made available by pass P. 659void PMDataManager::recordAvailableAnalysis(Pass *P) { 660 const PassInfo *PI = P->getPassInfo(); 661 if (PI == 0) return; 662 663 AvailableAnalysis[PI] = P; 664 665 //This pass is the current implementation of all of the interfaces it 666 //implements as well. 667 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented(); 668 for (unsigned i = 0, e = II.size(); i != e; ++i) 669 AvailableAnalysis[II[i]] = P; 670} 671 672// Return true if P preserves high level analysis used by other 673// passes managed by this manager 674bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) { 675 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P); 676 if (AnUsage->getPreservesAll()) 677 return true; 678 679 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet(); 680 for (SmallVector<Pass *, 8>::iterator I = HigherLevelAnalysis.begin(), 681 E = HigherLevelAnalysis.end(); I != E; ++I) { 682 Pass *P1 = *I; 683 if (P1->getAsImmutablePass() == 0 && 684 std::find(PreservedSet.begin(), PreservedSet.end(), 685 P1->getPassInfo()) == 686 PreservedSet.end()) 687 return false; 688 } 689 690 return true; 691} 692 693/// verifyPreservedAnalysis -- Verify analysis preserved by pass P. 694void PMDataManager::verifyPreservedAnalysis(Pass *P) { 695 // Don't do this unless assertions are enabled. 696#ifdef NDEBUG 697 return; 698#endif 699 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P); 700 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet(); 701 702 // Verify preserved analysis 703 for (AnalysisUsage::VectorType::const_iterator I = PreservedSet.begin(), 704 E = PreservedSet.end(); I != E; ++I) { 705 AnalysisID AID = *I; 706 if (Pass *AP = findAnalysisPass(AID, true)) { 707 708 Timer *T = 0; 709 if (TheTimeInfo) T = TheTimeInfo->passStarted(AP); 710 AP->verifyAnalysis(); 711 if (T) T->stopTimer(); 712 } 713 } 714} 715 716/// Remove Analysis not preserved by Pass P 717void PMDataManager::removeNotPreservedAnalysis(Pass *P) { 718 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P); 719 if (AnUsage->getPreservesAll()) 720 return; 721 722 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet(); 723 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(), 724 E = AvailableAnalysis.end(); I != E; ) { 725 std::map<AnalysisID, Pass*>::iterator Info = I++; 726 if (Info->second->getAsImmutablePass() == 0 && 727 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) == 728 PreservedSet.end()) { 729 // Remove this analysis 730 if (PassDebugging >= Details) { 731 Pass *S = Info->second; 732 dbgs() << " -- '" << P->getPassName() << "' is not preserving '"; 733 dbgs() << S->getPassName() << "'\n"; 734 } 735 AvailableAnalysis.erase(Info); 736 } 737 } 738 739 // Check inherited analysis also. If P is not preserving analysis 740 // provided by parent manager then remove it here. 741 for (unsigned Index = 0; Index < PMT_Last; ++Index) { 742 743 if (!InheritedAnalysis[Index]) 744 continue; 745 746 for (std::map<AnalysisID, Pass*>::iterator 747 I = InheritedAnalysis[Index]->begin(), 748 E = InheritedAnalysis[Index]->end(); I != E; ) { 749 std::map<AnalysisID, Pass *>::iterator Info = I++; 750 if (Info->second->getAsImmutablePass() == 0 && 751 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) == 752 PreservedSet.end()) { 753 // Remove this analysis 754 if (PassDebugging >= Details) { 755 Pass *S = Info->second; 756 dbgs() << " -- '" << P->getPassName() << "' is not preserving '"; 757 dbgs() << S->getPassName() << "'\n"; 758 } 759 InheritedAnalysis[Index]->erase(Info); 760 } 761 } 762 } 763} 764 765/// Remove analysis passes that are not used any longer 766void PMDataManager::removeDeadPasses(Pass *P, StringRef Msg, 767 enum PassDebuggingString DBG_STR) { 768 769 SmallVector<Pass *, 12> DeadPasses; 770 771 // If this is a on the fly manager then it does not have TPM. 772 if (!TPM) 773 return; 774 775 TPM->collectLastUses(DeadPasses, P); 776 777 if (PassDebugging >= Details && !DeadPasses.empty()) { 778 dbgs() << " -*- '" << P->getPassName(); 779 dbgs() << "' is the last user of following pass instances."; 780 dbgs() << " Free these instances\n"; 781 } 782 783 for (SmallVector<Pass *, 12>::iterator I = DeadPasses.begin(), 784 E = DeadPasses.end(); I != E; ++I) 785 freePass(*I, Msg, DBG_STR); 786} 787 788void PMDataManager::freePass(Pass *P, StringRef Msg, 789 enum PassDebuggingString DBG_STR) { 790 dumpPassInfo(P, FREEING_MSG, DBG_STR, Msg); 791 792 { 793 // If the pass crashes releasing memory, remember this. 794 PassManagerPrettyStackEntry X(P); 795 796 Timer *T = StartPassTimer(P); 797 P->releaseMemory(); 798 StopPassTimer(P, T); 799 } 800 801 if (const PassInfo *PI = P->getPassInfo()) { 802 // Remove the pass itself (if it is not already removed). 803 AvailableAnalysis.erase(PI); 804 805 // Remove all interfaces this pass implements, for which it is also 806 // listed as the available implementation. 807 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented(); 808 for (unsigned i = 0, e = II.size(); i != e; ++i) { 809 std::map<AnalysisID, Pass*>::iterator Pos = 810 AvailableAnalysis.find(II[i]); 811 if (Pos != AvailableAnalysis.end() && Pos->second == P) 812 AvailableAnalysis.erase(Pos); 813 } 814 } 815} 816 817/// Add pass P into the PassVector. Update 818/// AvailableAnalysis appropriately if ProcessAnalysis is true. 819void PMDataManager::add(Pass *P, bool ProcessAnalysis) { 820 // This manager is going to manage pass P. Set up analysis resolver 821 // to connect them. 822 AnalysisResolver *AR = new AnalysisResolver(*this); 823 P->setResolver(AR); 824 825 // If a FunctionPass F is the last user of ModulePass info M 826 // then the F's manager, not F, records itself as a last user of M. 827 SmallVector<Pass *, 12> TransferLastUses; 828 829 if (!ProcessAnalysis) { 830 // Add pass 831 PassVector.push_back(P); 832 return; 833 } 834 835 // At the moment, this pass is the last user of all required passes. 836 SmallVector<Pass *, 12> LastUses; 837 SmallVector<Pass *, 8> RequiredPasses; 838 SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable; 839 840 unsigned PDepth = this->getDepth(); 841 842 collectRequiredAnalysis(RequiredPasses, 843 ReqAnalysisNotAvailable, P); 844 for (SmallVector<Pass *, 8>::iterator I = RequiredPasses.begin(), 845 E = RequiredPasses.end(); I != E; ++I) { 846 Pass *PRequired = *I; 847 unsigned RDepth = 0; 848 849 assert(PRequired->getResolver() && "Analysis Resolver is not set"); 850 PMDataManager &DM = PRequired->getResolver()->getPMDataManager(); 851 RDepth = DM.getDepth(); 852 853 if (PDepth == RDepth) 854 LastUses.push_back(PRequired); 855 else if (PDepth > RDepth) { 856 // Let the parent claim responsibility of last use 857 TransferLastUses.push_back(PRequired); 858 // Keep track of higher level analysis used by this manager. 859 HigherLevelAnalysis.push_back(PRequired); 860 } else 861 llvm_unreachable("Unable to accomodate Required Pass"); 862 } 863 864 // Set P as P's last user until someone starts using P. 865 // However, if P is a Pass Manager then it does not need 866 // to record its last user. 867 if (P->getAsPMDataManager() == 0) 868 LastUses.push_back(P); 869 TPM->setLastUser(LastUses, P); 870 871 if (!TransferLastUses.empty()) { 872 Pass *My_PM = getAsPass(); 873 TPM->setLastUser(TransferLastUses, My_PM); 874 TransferLastUses.clear(); 875 } 876 877 // Now, take care of required analysises that are not available. 878 for (SmallVector<AnalysisID, 8>::iterator 879 I = ReqAnalysisNotAvailable.begin(), 880 E = ReqAnalysisNotAvailable.end() ;I != E; ++I) { 881 Pass *AnalysisPass = (*I)->createPass(); 882 this->addLowerLevelRequiredPass(P, AnalysisPass); 883 } 884 885 // Take a note of analysis required and made available by this pass. 886 // Remove the analysis not preserved by this pass 887 removeNotPreservedAnalysis(P); 888 recordAvailableAnalysis(P); 889 890 // Add pass 891 PassVector.push_back(P); 892} 893 894 895/// Populate RP with analysis pass that are required by 896/// pass P and are available. Populate RP_NotAvail with analysis 897/// pass that are required by pass P but are not available. 898void PMDataManager::collectRequiredAnalysis(SmallVector<Pass *, 8>&RP, 899 SmallVector<AnalysisID, 8> &RP_NotAvail, 900 Pass *P) { 901 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P); 902 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet(); 903 for (AnalysisUsage::VectorType::const_iterator 904 I = RequiredSet.begin(), E = RequiredSet.end(); I != E; ++I) { 905 if (Pass *AnalysisPass = findAnalysisPass(*I, true)) 906 RP.push_back(AnalysisPass); 907 else 908 RP_NotAvail.push_back(*I); 909 } 910 911 const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet(); 912 for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(), 913 E = IDs.end(); I != E; ++I) { 914 if (Pass *AnalysisPass = findAnalysisPass(*I, true)) 915 RP.push_back(AnalysisPass); 916 else 917 RP_NotAvail.push_back(*I); 918 } 919} 920 921// All Required analyses should be available to the pass as it runs! Here 922// we fill in the AnalysisImpls member of the pass so that it can 923// successfully use the getAnalysis() method to retrieve the 924// implementations it needs. 925// 926void PMDataManager::initializeAnalysisImpl(Pass *P) { 927 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P); 928 929 for (AnalysisUsage::VectorType::const_iterator 930 I = AnUsage->getRequiredSet().begin(), 931 E = AnUsage->getRequiredSet().end(); I != E; ++I) { 932 Pass *Impl = findAnalysisPass(*I, true); 933 if (Impl == 0) 934 // This may be analysis pass that is initialized on the fly. 935 // If that is not the case then it will raise an assert when it is used. 936 continue; 937 AnalysisResolver *AR = P->getResolver(); 938 assert(AR && "Analysis Resolver is not set"); 939 AR->addAnalysisImplsPair(*I, Impl); 940 } 941} 942 943/// Find the pass that implements Analysis AID. If desired pass is not found 944/// then return NULL. 945Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) { 946 947 // Check if AvailableAnalysis map has one entry. 948 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID); 949 950 if (I != AvailableAnalysis.end()) 951 return I->second; 952 953 // Search Parents through TopLevelManager 954 if (SearchParent) 955 return TPM->findAnalysisPass(AID); 956 957 return NULL; 958} 959 960// Print list of passes that are last used by P. 961void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{ 962 963 SmallVector<Pass *, 12> LUses; 964 965 // If this is a on the fly manager then it does not have TPM. 966 if (!TPM) 967 return; 968 969 TPM->collectLastUses(LUses, P); 970 971 for (SmallVector<Pass *, 12>::iterator I = LUses.begin(), 972 E = LUses.end(); I != E; ++I) { 973 llvm::dbgs() << "--" << std::string(Offset*2, ' '); 974 (*I)->dumpPassStructure(0); 975 } 976} 977 978void PMDataManager::dumpPassArguments() const { 979 for (SmallVector<Pass *, 8>::const_iterator I = PassVector.begin(), 980 E = PassVector.end(); I != E; ++I) { 981 if (PMDataManager *PMD = (*I)->getAsPMDataManager()) 982 PMD->dumpPassArguments(); 983 else 984 if (const PassInfo *PI = (*I)->getPassInfo()) 985 if (!PI->isAnalysisGroup()) 986 dbgs() << " -" << PI->getPassArgument(); 987 } 988} 989 990void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1, 991 enum PassDebuggingString S2, 992 StringRef Msg) { 993 if (PassDebugging < Executions) 994 return; 995 dbgs() << (void*)this << std::string(getDepth()*2+1, ' '); 996 switch (S1) { 997 case EXECUTION_MSG: 998 dbgs() << "Executing Pass '" << P->getPassName(); 999 break; 1000 case MODIFICATION_MSG: 1001 dbgs() << "Made Modification '" << P->getPassName(); 1002 break; 1003 case FREEING_MSG: 1004 dbgs() << " Freeing Pass '" << P->getPassName(); 1005 break; 1006 default: 1007 break; 1008 } 1009 switch (S2) { 1010 case ON_BASICBLOCK_MSG: 1011 dbgs() << "' on BasicBlock '" << Msg << "'...\n"; 1012 break; 1013 case ON_FUNCTION_MSG: 1014 dbgs() << "' on Function '" << Msg << "'...\n"; 1015 break; 1016 case ON_MODULE_MSG: 1017 dbgs() << "' on Module '" << Msg << "'...\n"; 1018 break; 1019 case ON_LOOP_MSG: 1020 dbgs() << "' on Loop '" << Msg << "'...\n"; 1021 break; 1022 case ON_CG_MSG: 1023 dbgs() << "' on Call Graph Nodes '" << Msg << "'...\n"; 1024 break; 1025 default: 1026 break; 1027 } 1028} 1029 1030void PMDataManager::dumpRequiredSet(const Pass *P) const { 1031 if (PassDebugging < Details) 1032 return; 1033 1034 AnalysisUsage analysisUsage; 1035 P->getAnalysisUsage(analysisUsage); 1036 dumpAnalysisUsage("Required", P, analysisUsage.getRequiredSet()); 1037} 1038 1039void PMDataManager::dumpPreservedSet(const Pass *P) const { 1040 if (PassDebugging < Details) 1041 return; 1042 1043 AnalysisUsage analysisUsage; 1044 P->getAnalysisUsage(analysisUsage); 1045 dumpAnalysisUsage("Preserved", P, analysisUsage.getPreservedSet()); 1046} 1047 1048void PMDataManager::dumpAnalysisUsage(StringRef Msg, const Pass *P, 1049 const AnalysisUsage::VectorType &Set) const { 1050 assert(PassDebugging >= Details); 1051 if (Set.empty()) 1052 return; 1053 dbgs() << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:"; 1054 for (unsigned i = 0; i != Set.size(); ++i) { 1055 if (i) dbgs() << ','; 1056 dbgs() << ' ' << Set[i]->getPassName(); 1057 } 1058 dbgs() << '\n'; 1059} 1060 1061/// Add RequiredPass into list of lower level passes required by pass P. 1062/// RequiredPass is run on the fly by Pass Manager when P requests it 1063/// through getAnalysis interface. 1064/// This should be handled by specific pass manager. 1065void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) { 1066 if (TPM) { 1067 TPM->dumpArguments(); 1068 TPM->dumpPasses(); 1069 } 1070 1071 // Module Level pass may required Function Level analysis info 1072 // (e.g. dominator info). Pass manager uses on the fly function pass manager 1073 // to provide this on demand. In that case, in Pass manager terminology, 1074 // module level pass is requiring lower level analysis info managed by 1075 // lower level pass manager. 1076 1077 // When Pass manager is not able to order required analysis info, Pass manager 1078 // checks whether any lower level manager will be able to provide this 1079 // analysis info on demand or not. 1080#ifndef NDEBUG 1081 dbgs() << "Unable to schedule '" << RequiredPass->getPassName(); 1082 dbgs() << "' required by '" << P->getPassName() << "'\n"; 1083#endif 1084 llvm_unreachable("Unable to schedule pass"); 1085} 1086 1087// Destructor 1088PMDataManager::~PMDataManager() { 1089 for (SmallVector<Pass *, 8>::iterator I = PassVector.begin(), 1090 E = PassVector.end(); I != E; ++I) 1091 delete *I; 1092} 1093 1094//===----------------------------------------------------------------------===// 1095// NOTE: Is this the right place to define this method ? 1096// getAnalysisIfAvailable - Return analysis result or null if it doesn't exist. 1097Pass *AnalysisResolver::getAnalysisIfAvailable(AnalysisID ID, bool dir) const { 1098 return PM.findAnalysisPass(ID, dir); 1099} 1100 1101Pass *AnalysisResolver::findImplPass(Pass *P, const PassInfo *AnalysisPI, 1102 Function &F) { 1103 return PM.getOnTheFlyPass(P, AnalysisPI, F); 1104} 1105 1106//===----------------------------------------------------------------------===// 1107// BBPassManager implementation 1108 1109/// Execute all of the passes scheduled for execution by invoking 1110/// runOnBasicBlock method. Keep track of whether any of the passes modifies 1111/// the function, and if so, return true. 1112bool BBPassManager::runOnFunction(Function &F) { 1113 if (F.isDeclaration()) 1114 return false; 1115 1116 bool Changed = doInitialization(F); 1117 1118 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) 1119 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 1120 BasicBlockPass *BP = getContainedPass(Index); 1121 bool LocalChanged = false; 1122 1123 dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getName()); 1124 dumpRequiredSet(BP); 1125 1126 initializeAnalysisImpl(BP); 1127 1128 { 1129 // If the pass crashes, remember this. 1130 PassManagerPrettyStackEntry X(BP, *I); 1131 1132 Timer *T = StartPassTimer(BP); 1133 LocalChanged |= BP->runOnBasicBlock(*I); 1134 StopPassTimer(BP, T); 1135 } 1136 1137 Changed |= LocalChanged; 1138 if (LocalChanged) 1139 dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG, 1140 I->getName()); 1141 dumpPreservedSet(BP); 1142 1143 verifyPreservedAnalysis(BP); 1144 removeNotPreservedAnalysis(BP); 1145 recordAvailableAnalysis(BP); 1146 removeDeadPasses(BP, I->getName(), ON_BASICBLOCK_MSG); 1147 } 1148 1149 return doFinalization(F) || Changed; 1150} 1151 1152// Implement doInitialization and doFinalization 1153bool BBPassManager::doInitialization(Module &M) { 1154 bool Changed = false; 1155 1156 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) 1157 Changed |= getContainedPass(Index)->doInitialization(M); 1158 1159 return Changed; 1160} 1161 1162bool BBPassManager::doFinalization(Module &M) { 1163 bool Changed = false; 1164 1165 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) 1166 Changed |= getContainedPass(Index)->doFinalization(M); 1167 1168 return Changed; 1169} 1170 1171bool BBPassManager::doInitialization(Function &F) { 1172 bool Changed = false; 1173 1174 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 1175 BasicBlockPass *BP = getContainedPass(Index); 1176 Changed |= BP->doInitialization(F); 1177 } 1178 1179 return Changed; 1180} 1181 1182bool BBPassManager::doFinalization(Function &F) { 1183 bool Changed = false; 1184 1185 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 1186 BasicBlockPass *BP = getContainedPass(Index); 1187 Changed |= BP->doFinalization(F); 1188 } 1189 1190 return Changed; 1191} 1192 1193 1194//===----------------------------------------------------------------------===// 1195// FunctionPassManager implementation 1196 1197/// Create new Function pass manager 1198FunctionPassManager::FunctionPassManager(Module *m) : M(m) { 1199 FPM = new FunctionPassManagerImpl(0); 1200 // FPM is the top level manager. 1201 FPM->setTopLevelManager(FPM); 1202 1203 AnalysisResolver *AR = new AnalysisResolver(*FPM); 1204 FPM->setResolver(AR); 1205} 1206 1207FunctionPassManager::~FunctionPassManager() { 1208 delete FPM; 1209} 1210 1211/// add - Add a pass to the queue of passes to run. This passes 1212/// ownership of the Pass to the PassManager. When the 1213/// PassManager_X is destroyed, the pass will be destroyed as well, so 1214/// there is no need to delete the pass. (TODO delete passes.) 1215/// This implies that all passes MUST be allocated with 'new'. 1216void FunctionPassManager::add(Pass *P) { 1217 FPM->add(P); 1218} 1219 1220/// run - Execute all of the passes scheduled for execution. Keep 1221/// track of whether any of the passes modifies the function, and if 1222/// so, return true. 1223/// 1224bool FunctionPassManager::run(Function &F) { 1225 if (F.isMaterializable()) { 1226 std::string errstr; 1227 if (F.Materialize(&errstr)) { 1228 llvm_report_error("Error reading bitcode file: " + errstr); 1229 } 1230 } 1231 return FPM->run(F); 1232} 1233 1234 1235/// doInitialization - Run all of the initializers for the function passes. 1236/// 1237bool FunctionPassManager::doInitialization() { 1238 return FPM->doInitialization(*M); 1239} 1240 1241/// doFinalization - Run all of the finalizers for the function passes. 1242/// 1243bool FunctionPassManager::doFinalization() { 1244 return FPM->doFinalization(*M); 1245} 1246 1247//===----------------------------------------------------------------------===// 1248// FunctionPassManagerImpl implementation 1249// 1250bool FunctionPassManagerImpl::doInitialization(Module &M) { 1251 bool Changed = false; 1252 1253 dumpArguments(); 1254 dumpPasses(); 1255 1256 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) 1257 Changed |= getContainedManager(Index)->doInitialization(M); 1258 1259 return Changed; 1260} 1261 1262bool FunctionPassManagerImpl::doFinalization(Module &M) { 1263 bool Changed = false; 1264 1265 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) 1266 Changed |= getContainedManager(Index)->doFinalization(M); 1267 1268 return Changed; 1269} 1270 1271/// cleanup - After running all passes, clean up pass manager cache. 1272void FPPassManager::cleanup() { 1273 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 1274 FunctionPass *FP = getContainedPass(Index); 1275 AnalysisResolver *AR = FP->getResolver(); 1276 assert(AR && "Analysis Resolver is not set"); 1277 AR->clearAnalysisImpls(); 1278 } 1279} 1280 1281void FunctionPassManagerImpl::releaseMemoryOnTheFly() { 1282 if (!wasRun) 1283 return; 1284 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) { 1285 FPPassManager *FPPM = getContainedManager(Index); 1286 for (unsigned Index = 0; Index < FPPM->getNumContainedPasses(); ++Index) { 1287 FPPM->getContainedPass(Index)->releaseMemory(); 1288 } 1289 } 1290 wasRun = false; 1291} 1292 1293// Execute all the passes managed by this top level manager. 1294// Return true if any function is modified by a pass. 1295bool FunctionPassManagerImpl::run(Function &F) { 1296 bool Changed = false; 1297 TimingInfo::createTheTimeInfo(); 1298 1299 initializeAllAnalysisInfo(); 1300 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) 1301 Changed |= getContainedManager(Index)->runOnFunction(F); 1302 1303 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) 1304 getContainedManager(Index)->cleanup(); 1305 1306 wasRun = true; 1307 return Changed; 1308} 1309 1310//===----------------------------------------------------------------------===// 1311// FPPassManager implementation 1312 1313char FPPassManager::ID = 0; 1314/// Print passes managed by this manager 1315void FPPassManager::dumpPassStructure(unsigned Offset) { 1316 llvm::dbgs() << std::string(Offset*2, ' ') << "FunctionPass Manager\n"; 1317 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 1318 FunctionPass *FP = getContainedPass(Index); 1319 FP->dumpPassStructure(Offset + 1); 1320 dumpLastUses(FP, Offset+1); 1321 } 1322} 1323 1324 1325/// Execute all of the passes scheduled for execution by invoking 1326/// runOnFunction method. Keep track of whether any of the passes modifies 1327/// the function, and if so, return true. 1328bool FPPassManager::runOnFunction(Function &F) { 1329 if (F.isDeclaration()) 1330 return false; 1331 1332 bool Changed = false; 1333 1334 // Collect inherited analysis from Module level pass manager. 1335 populateInheritedAnalysis(TPM->activeStack); 1336 1337 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 1338 FunctionPass *FP = getContainedPass(Index); 1339 bool LocalChanged = false; 1340 1341 dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName()); 1342 dumpRequiredSet(FP); 1343 1344 initializeAnalysisImpl(FP); 1345 1346 { 1347 PassManagerPrettyStackEntry X(FP, F); 1348 1349 Timer *T = StartPassTimer(FP); 1350 LocalChanged |= FP->runOnFunction(F); 1351 StopPassTimer(FP, T); 1352 } 1353 1354 Changed |= LocalChanged; 1355 if (LocalChanged) 1356 dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName()); 1357 dumpPreservedSet(FP); 1358 1359 verifyPreservedAnalysis(FP); 1360 removeNotPreservedAnalysis(FP); 1361 recordAvailableAnalysis(FP); 1362 removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG); 1363 } 1364 return Changed; 1365} 1366 1367bool FPPassManager::runOnModule(Module &M) { 1368 bool Changed = doInitialization(M); 1369 1370 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) 1371 runOnFunction(*I); 1372 1373 return doFinalization(M) || Changed; 1374} 1375 1376bool FPPassManager::doInitialization(Module &M) { 1377 bool Changed = false; 1378 1379 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) 1380 Changed |= getContainedPass(Index)->doInitialization(M); 1381 1382 return Changed; 1383} 1384 1385bool FPPassManager::doFinalization(Module &M) { 1386 bool Changed = false; 1387 1388 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) 1389 Changed |= getContainedPass(Index)->doFinalization(M); 1390 1391 return Changed; 1392} 1393 1394//===----------------------------------------------------------------------===// 1395// MPPassManager implementation 1396 1397/// Execute all of the passes scheduled for execution by invoking 1398/// runOnModule method. Keep track of whether any of the passes modifies 1399/// the module, and if so, return true. 1400bool 1401MPPassManager::runOnModule(Module &M) { 1402 bool Changed = false; 1403 1404 // Initialize on-the-fly passes 1405 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator 1406 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end(); 1407 I != E; ++I) { 1408 FunctionPassManagerImpl *FPP = I->second; 1409 Changed |= FPP->doInitialization(M); 1410 } 1411 1412 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 1413 ModulePass *MP = getContainedPass(Index); 1414 bool LocalChanged = false; 1415 1416 dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier()); 1417 dumpRequiredSet(MP); 1418 1419 initializeAnalysisImpl(MP); 1420 1421 { 1422 PassManagerPrettyStackEntry X(MP, M); 1423 Timer *T = StartPassTimer(MP); 1424 LocalChanged |= MP->runOnModule(M); 1425 StopPassTimer(MP, T); 1426 } 1427 1428 Changed |= LocalChanged; 1429 if (LocalChanged) 1430 dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG, 1431 M.getModuleIdentifier()); 1432 dumpPreservedSet(MP); 1433 1434 verifyPreservedAnalysis(MP); 1435 removeNotPreservedAnalysis(MP); 1436 recordAvailableAnalysis(MP); 1437 removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG); 1438 } 1439 1440 // Finalize on-the-fly passes 1441 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator 1442 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end(); 1443 I != E; ++I) { 1444 FunctionPassManagerImpl *FPP = I->second; 1445 // We don't know when is the last time an on-the-fly pass is run, 1446 // so we need to releaseMemory / finalize here 1447 FPP->releaseMemoryOnTheFly(); 1448 Changed |= FPP->doFinalization(M); 1449 } 1450 return Changed; 1451} 1452 1453/// Add RequiredPass into list of lower level passes required by pass P. 1454/// RequiredPass is run on the fly by Pass Manager when P requests it 1455/// through getAnalysis interface. 1456void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) { 1457 assert(P->getPotentialPassManagerType() == PMT_ModulePassManager && 1458 "Unable to handle Pass that requires lower level Analysis pass"); 1459 assert((P->getPotentialPassManagerType() < 1460 RequiredPass->getPotentialPassManagerType()) && 1461 "Unable to handle Pass that requires lower level Analysis pass"); 1462 1463 FunctionPassManagerImpl *FPP = OnTheFlyManagers[P]; 1464 if (!FPP) { 1465 FPP = new FunctionPassManagerImpl(0); 1466 // FPP is the top level manager. 1467 FPP->setTopLevelManager(FPP); 1468 1469 OnTheFlyManagers[P] = FPP; 1470 } 1471 FPP->add(RequiredPass); 1472 1473 // Register P as the last user of RequiredPass. 1474 SmallVector<Pass *, 12> LU; 1475 LU.push_back(RequiredPass); 1476 FPP->setLastUser(LU, P); 1477} 1478 1479/// Return function pass corresponding to PassInfo PI, that is 1480/// required by module pass MP. Instantiate analysis pass, by using 1481/// its runOnFunction() for function F. 1482Pass* MPPassManager::getOnTheFlyPass(Pass *MP, const PassInfo *PI, Function &F){ 1483 FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP]; 1484 assert(FPP && "Unable to find on the fly pass"); 1485 1486 FPP->releaseMemoryOnTheFly(); 1487 FPP->run(F); 1488 return ((PMTopLevelManager*)FPP)->findAnalysisPass(PI); 1489} 1490 1491 1492//===----------------------------------------------------------------------===// 1493// PassManagerImpl implementation 1494// 1495/// run - Execute all of the passes scheduled for execution. Keep track of 1496/// whether any of the passes modifies the module, and if so, return true. 1497bool PassManagerImpl::run(Module &M) { 1498 bool Changed = false; 1499 TimingInfo::createTheTimeInfo(); 1500 1501 dumpArguments(); 1502 dumpPasses(); 1503 1504 initializeAllAnalysisInfo(); 1505 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) 1506 Changed |= getContainedManager(Index)->runOnModule(M); 1507 return Changed; 1508} 1509 1510//===----------------------------------------------------------------------===// 1511// PassManager implementation 1512 1513/// Create new pass manager 1514PassManager::PassManager() { 1515 PM = new PassManagerImpl(0); 1516 // PM is the top level manager 1517 PM->setTopLevelManager(PM); 1518} 1519 1520PassManager::~PassManager() { 1521 delete PM; 1522} 1523 1524/// add - Add a pass to the queue of passes to run. This passes ownership of 1525/// the Pass to the PassManager. When the PassManager is destroyed, the pass 1526/// will be destroyed as well, so there is no need to delete the pass. This 1527/// implies that all passes MUST be allocated with 'new'. 1528void PassManager::add(Pass *P) { 1529 PM->add(P); 1530} 1531 1532/// run - Execute all of the passes scheduled for execution. Keep track of 1533/// whether any of the passes modifies the module, and if so, return true. 1534bool PassManager::run(Module &M) { 1535 return PM->run(M); 1536} 1537 1538//===----------------------------------------------------------------------===// 1539// TimingInfo Class - This class is used to calculate information about the 1540// amount of time each pass takes to execute. This only happens with 1541// -time-passes is enabled on the command line. 1542// 1543bool llvm::TimePassesIsEnabled = false; 1544static cl::opt<bool,true> 1545EnableTiming("time-passes", cl::location(TimePassesIsEnabled), 1546 cl::desc("Time each pass, printing elapsed time for each on exit")); 1547 1548// createTheTimeInfo - This method either initializes the TheTimeInfo pointer to 1549// a non null value (if the -time-passes option is enabled) or it leaves it 1550// null. It may be called multiple times. 1551void TimingInfo::createTheTimeInfo() { 1552 if (!TimePassesIsEnabled || TheTimeInfo) return; 1553 1554 // Constructed the first time this is called, iff -time-passes is enabled. 1555 // This guarantees that the object will be constructed before static globals, 1556 // thus it will be destroyed before them. 1557 static ManagedStatic<TimingInfo> TTI; 1558 TheTimeInfo = &*TTI; 1559} 1560 1561/// If TimingInfo is enabled then start pass timer. 1562Timer *llvm::StartPassTimer(Pass *P) { 1563 if (TheTimeInfo) 1564 return TheTimeInfo->passStarted(P); 1565 return 0; 1566} 1567 1568/// If TimingInfo is enabled then stop pass timer. 1569void llvm::StopPassTimer(Pass *P, Timer *T) { 1570 if (T) T->stopTimer(); 1571} 1572 1573//===----------------------------------------------------------------------===// 1574// PMStack implementation 1575// 1576 1577// Pop Pass Manager from the stack and clear its analysis info. 1578void PMStack::pop() { 1579 1580 PMDataManager *Top = this->top(); 1581 Top->initializeAnalysisInfo(); 1582 1583 S.pop_back(); 1584} 1585 1586// Push PM on the stack and set its top level manager. 1587void PMStack::push(PMDataManager *PM) { 1588 assert(PM && "Unable to push. Pass Manager expected"); 1589 1590 if (!this->empty()) { 1591 PMTopLevelManager *TPM = this->top()->getTopLevelManager(); 1592 1593 assert(TPM && "Unable to find top level manager"); 1594 TPM->addIndirectPassManager(PM); 1595 PM->setTopLevelManager(TPM); 1596 } 1597 1598 S.push_back(PM); 1599} 1600 1601// Dump content of the pass manager stack. 1602void PMStack::dump() { 1603 for (std::deque<PMDataManager *>::iterator I = S.begin(), 1604 E = S.end(); I != E; ++I) 1605 printf("%s ", (*I)->getAsPass()->getPassName()); 1606 1607 if (!S.empty()) 1608 printf("\n"); 1609} 1610 1611/// Find appropriate Module Pass Manager in the PM Stack and 1612/// add self into that manager. 1613void ModulePass::assignPassManager(PMStack &PMS, 1614 PassManagerType PreferredType) { 1615 // Find Module Pass Manager 1616 while(!PMS.empty()) { 1617 PassManagerType TopPMType = PMS.top()->getPassManagerType(); 1618 if (TopPMType == PreferredType) 1619 break; // We found desired pass manager 1620 else if (TopPMType > PMT_ModulePassManager) 1621 PMS.pop(); // Pop children pass managers 1622 else 1623 break; 1624 } 1625 assert(!PMS.empty() && "Unable to find appropriate Pass Manager"); 1626 PMS.top()->add(this); 1627} 1628 1629/// Find appropriate Function Pass Manager or Call Graph Pass Manager 1630/// in the PM Stack and add self into that manager. 1631void FunctionPass::assignPassManager(PMStack &PMS, 1632 PassManagerType PreferredType) { 1633 1634 // Find Module Pass Manager 1635 while (!PMS.empty()) { 1636 if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager) 1637 PMS.pop(); 1638 else 1639 break; 1640 } 1641 1642 // Create new Function Pass Manager if needed. 1643 FPPassManager *FPP; 1644 if (PMS.top()->getPassManagerType() == PMT_FunctionPassManager) { 1645 FPP = (FPPassManager *)PMS.top(); 1646 } else { 1647 assert(!PMS.empty() && "Unable to create Function Pass Manager"); 1648 PMDataManager *PMD = PMS.top(); 1649 1650 // [1] Create new Function Pass Manager 1651 FPP = new FPPassManager(PMD->getDepth() + 1); 1652 FPP->populateInheritedAnalysis(PMS); 1653 1654 // [2] Set up new manager's top level manager 1655 PMTopLevelManager *TPM = PMD->getTopLevelManager(); 1656 TPM->addIndirectPassManager(FPP); 1657 1658 // [3] Assign manager to manage this new manager. This may create 1659 // and push new managers into PMS 1660 FPP->assignPassManager(PMS, PMD->getPassManagerType()); 1661 1662 // [4] Push new manager into PMS 1663 PMS.push(FPP); 1664 } 1665 1666 // Assign FPP as the manager of this pass. 1667 FPP->add(this); 1668} 1669 1670/// Find appropriate Basic Pass Manager or Call Graph Pass Manager 1671/// in the PM Stack and add self into that manager. 1672void BasicBlockPass::assignPassManager(PMStack &PMS, 1673 PassManagerType PreferredType) { 1674 BBPassManager *BBP; 1675 1676 // Basic Pass Manager is a leaf pass manager. It does not handle 1677 // any other pass manager. 1678 if (!PMS.empty() && 1679 PMS.top()->getPassManagerType() == PMT_BasicBlockPassManager) { 1680 BBP = (BBPassManager *)PMS.top(); 1681 } else { 1682 // If leaf manager is not Basic Block Pass manager then create new 1683 // basic Block Pass manager. 1684 assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager"); 1685 PMDataManager *PMD = PMS.top(); 1686 1687 // [1] Create new Basic Block Manager 1688 BBP = new BBPassManager(PMD->getDepth() + 1); 1689 1690 // [2] Set up new manager's top level manager 1691 // Basic Block Pass Manager does not live by itself 1692 PMTopLevelManager *TPM = PMD->getTopLevelManager(); 1693 TPM->addIndirectPassManager(BBP); 1694 1695 // [3] Assign manager to manage this new manager. This may create 1696 // and push new managers into PMS 1697 BBP->assignPassManager(PMS); 1698 1699 // [4] Push new manager into PMS 1700 PMS.push(BBP); 1701 } 1702 1703 // Assign BBP as the manager of this pass. 1704 BBP->add(this); 1705} 1706 1707PassManagerBase::~PassManagerBase() {} 1708 1709/*===-- C Bindings --------------------------------------------------------===*/ 1710 1711LLVMPassManagerRef LLVMCreatePassManager() { 1712 return wrap(new PassManager()); 1713} 1714 1715LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef P) { 1716 return wrap(new FunctionPassManager(unwrap(P))); 1717} 1718 1719LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M) { 1720 return unwrap<PassManager>(PM)->run(*unwrap(M)); 1721} 1722 1723LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM) { 1724 return unwrap<FunctionPassManager>(FPM)->doInitialization(); 1725} 1726 1727LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F) { 1728 return unwrap<FunctionPassManager>(FPM)->run(*unwrap<Function>(F)); 1729} 1730 1731LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM) { 1732 return unwrap<FunctionPassManager>(FPM)->doFinalization(); 1733} 1734 1735void LLVMDisposePassManager(LLVMPassManagerRef PM) { 1736 delete unwrap(PM); 1737} 1738