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