lib/VMCore/PassManagerT.h

   1 //===- PassManagerT.h - Container for Passes --------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the PassManagerT class.  This class is used to hold,
  11 // maintain, and optimize execution of Pass's.  The PassManager class ensures
  12 // that analysis results are available before a pass runs, and that Pass's are
  13 // destroyed when the PassManager is destroyed.
  14 //
  15 // The PassManagerT template is instantiated three times to do its job.  The
  16 // public PassManager class is a Pimpl around the PassManagerT<Module> interface
  17 // to avoid having all of the PassManager clients being exposed to the
  18 // implementation details herein.
  19 //
  20 //===----------------------------------------------------------------------===//
  21
  22 #ifndef LLVM_PASSMANAGER_T_H
  23 #define LLVM_PASSMANAGER_T_H
  24
  25 #include "llvm/Pass.h"
  26 #include "Support/CommandLine.h"
  27 #include "Support/LeakDetector.h"
  28 #include "Support/Timer.h"
  29 #include <algorithm>
  30 #include <iostream>
  31
  32 namespace llvm {
  33
  34 class Annotable;
  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...
  44 enum PassDebugLevel {
  45   None, Arguments, Structure, Executions, Details
  46 };
  47
  48 static cl::opt<enum PassDebugLevel>
  49 PassDebugging("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                          0));
  58
  59 //===----------------------------------------------------------------------===//
  60 // PMDebug class - a set of debugging functions, that are not to be
  61 // instantiated by the template.
  62 //
  63 struct PMDebug {
  64   static void PerformPassStartupStuff(Pass *P) {
  65     // If debugging is enabled, print out argument information...
  66     if (PassDebugging >= Arguments) {
  67       std::cerr << "Pass Arguments: ";
  68       PrintArgumentInformation(P);
  69       std::cerr << "\n";
  70
  71       // Print the pass execution structure
  72       if (PassDebugging >= Structure)
  73         P->dumpPassStructure();
  74     }
  75   }
  76
  77   static void PrintArgumentInformation(const Pass *P);
  78   static void PrintPassInformation(unsigned,const char*,Pass *, Annotable *);
  79   static void PrintAnalysisSetInfo(unsigned,const char*,Pass *P,
  80                                    const std::vector<AnalysisID> &);
  81 };
  82
  83
  84 //===----------------------------------------------------------------------===//
  85 // TimingInfo Class - This class is used to calculate information about the
  86 // amount of time each pass takes to execute.  This only happens when
  87 // -time-passes is enabled on the command line.
  88 //
  89
  90 class TimingInfo {
  91   std::map<Pass*, Timer> TimingData;
  92   TimerGroup TG;
  93
  94   // Private ctor, must use 'create' member
  95   TimingInfo() : TG("... Pass execution timing report ...") {}
  96 public:
  97   // TimingDtor - Print out information about timing information
  98   ~TimingInfo() {
  99     // Delete all of the timers...
 100     TimingData.clear();
 101     // TimerGroup is deleted next, printing the report.
 102   }
 103
 104   // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
 105   // to a non null value (if the -time-passes option is enabled) or it leaves it
 106   // null.  It may be called multiple times.
 107   static void createTheTimeInfo();
 108
 109   void passStarted(Pass *P) {
 110     if (dynamic_cast<AnalysisResolver*>(P)) return;
 111     std::map<Pass*, Timer>::iterator I = TimingData.find(P);
 112     if (I == TimingData.end())
 113       I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
 114     I->second.startTimer();
 115   }
 116   void passEnded(Pass *P) {
 117     if (dynamic_cast<AnalysisResolver*>(P)) return;
 118     std::map<Pass*, Timer>::iterator I = TimingData.find(P);
 119     assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
 120     I->second.stopTimer();
 121   }
 122 };
 123
 124 static TimingInfo *TheTimeInfo;
 125
 126 //===----------------------------------------------------------------------===//
 127 // Declare the PassManagerTraits which will be specialized...
 128 //
 129 template<class UnitType> class PassManagerTraits;   // Do not define.
 130
 131
 132 //===----------------------------------------------------------------------===//
 133 // PassManagerT - Container object for passes.  The PassManagerT destructor
 134 // deletes all passes contained inside of the PassManagerT, so you shouldn't
 135 // delete passes manually, and all passes should be dynamically allocated.
 136 //
 137 template<typename UnitType>
 138 class PassManagerT : public PassManagerTraits<UnitType>,public AnalysisResolver{
 139   typedef PassManagerTraits<UnitType> Traits;
 140   typedef typename Traits::PassClass       PassClass;
 141   typedef typename Traits::SubPassClass SubPassClass;
 142   typedef typename Traits::BatcherClass BatcherClass;
 143   typedef typename Traits::ParentClass   ParentClass;
 144
 145   friend class PassManagerTraits<UnitType>::PassClass;
 146   friend class PassManagerTraits<UnitType>::SubPassClass;
 147   friend class PassManagerTraits<UnitType>;
 148   friend class ImmutablePass;
 149
 150   std::vector<PassClass*> Passes;    // List of passes to run
 151   std::vector<ImmutablePass*> ImmutablePasses;  // List of immutable passes
 152
 153   // The parent of this pass manager...
 154   ParentClass * const Parent;
 155
 156   // The current batcher if one is in use, or null
 157   BatcherClass *Batcher;
 158
 159   // CurrentAnalyses - As the passes are being run, this map contains the
 160   // analyses that are available to the current pass for use.  This is accessed
 161   // through the getAnalysis() function in this class and in Pass.
 162   //
 163   std::map<AnalysisID, Pass*> CurrentAnalyses;
 164
 165   // LastUseOf - This map keeps track of the last usage in our pipeline of a
 166   // particular pass.  When executing passes, the memory for .first is free'd
 167   // after .second is run.
 168   //
 169   std::map<Pass*, Pass*> LastUseOf;
 170
 171 public:
 172   PassManagerT(ParentClass *Par = 0) : Parent(Par), Batcher(0) {}
 173   ~PassManagerT() {
 174     // Delete all of the contained passes...
 175     for (typename std::vector<PassClass*>::iterator
 176            I = Passes.begin(), E = Passes.end(); I != E; ++I)
 177       delete *I;
 178
 179     for (std::vector<ImmutablePass*>::iterator
 180            I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
 181       delete *I;
 182   }
 183
 184   // run - Run all of the queued passes on the specified module in an optimal
 185   // way.
 186   virtual bool runOnUnit(UnitType *M) {
 187     bool MadeChanges = false;
 188     closeBatcher();
 189     CurrentAnalyses.clear();
 190
 191     TimingInfo::createTheTimeInfo();
 192
 193     // Add any immutable passes to the CurrentAnalyses set...
 194     for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
 195       ImmutablePass *IPass = ImmutablePasses[i];
 196       if (const PassInfo *PI = IPass->getPassInfo()) {
 197         CurrentAnalyses[PI] = IPass;
 198
 199         const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
 200         for (unsigned i = 0, e = II.size(); i != e; ++i)
 201           CurrentAnalyses[II[i]] = IPass;
 202       }
 203     }
 204
 205     // LastUserOf - This contains the inverted LastUseOfMap...
 206     std::map<Pass *, std::vector<Pass*> > LastUserOf;
 207     for (std::map<Pass*, Pass*>::iterator I = LastUseOf.begin(),
 208                                           E = LastUseOf.end(); I != E; ++I)
 209       LastUserOf[I->second].push_back(I->first);
 210
 211
 212     // Output debug information...
 213     if (Parent == 0) PMDebug::PerformPassStartupStuff(this);
 214
 215     // Run all of the passes
 216     for (unsigned i = 0, e = Passes.size(); i < e; ++i) {
 217       PassClass *P = Passes[i];
 218
 219       PMDebug::PrintPassInformation(getDepth(), "Executing Pass", P,
 220                                     (Annotable*)M);
 221
 222       // Get information about what analyses the pass uses...
 223       AnalysisUsage AnUsage;
 224       P->getAnalysisUsage(AnUsage);
 225       PMDebug::PrintAnalysisSetInfo(getDepth(), "Required", P,
 226                                     AnUsage.getRequiredSet());
 227
 228       // All Required analyses should be available to the pass as it runs!  Here
 229       // we fill in the AnalysisImpls member of the pass so that it can
 230       // successfully use the getAnalysis() method to retrieve the
 231       // implementations it needs.
 232       //
 233       P->AnalysisImpls.clear();
 234       P->AnalysisImpls.reserve(AnUsage.getRequiredSet().size());
 235       for (std::vector<const PassInfo *>::const_iterator
 236              I = AnUsage.getRequiredSet().begin(),
 237              E = AnUsage.getRequiredSet().end(); I != E; ++I) {
 238         Pass *Impl = getAnalysisOrNullUp(*I);
 239         if (Impl == 0) {
 240           std::cerr << "Analysis '" << (*I)->getPassName()
 241                     << "' used but not available!";
 242           assert(0 && "Analysis used but not available!");
 243         } else if (PassDebugging == Details) {
 244           if ((*I)->getPassName() != std::string(Impl->getPassName()))
 245             std::cerr << "    Interface '" << (*I)->getPassName()
 246                     << "' implemented by '" << Impl->getPassName() << "'\n";
 247         }
 248         P->AnalysisImpls.push_back(std::make_pair(*I, Impl));
 249       }
 250
 251       // Run the sub pass!
 252       if (TheTimeInfo) TheTimeInfo->passStarted(P);
 253       bool Changed = runPass(P, M);
 254       if (TheTimeInfo) TheTimeInfo->passEnded(P);
 255       MadeChanges |= Changed;
 256
 257       // Check for memory leaks by the pass...
 258       LeakDetector::checkForGarbage(std::string("after running pass '") +
 259                                     P->getPassName() + "'");
 260
 261       if (Changed)
 262         PMDebug::PrintPassInformation(getDepth()+1, "Made Modification", P,
 263                                       (Annotable*)M);
 264       PMDebug::PrintAnalysisSetInfo(getDepth(), "Preserved", P,
 265                                     AnUsage.getPreservedSet());
 266
 267
 268       // Erase all analyses not in the preserved set...
 269       if (!AnUsage.getPreservesAll()) {
 270         const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
 271         for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin(),
 272                E = CurrentAnalyses.end(); I != E; )
 273           if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) !=
 274               PreservedSet.end())
 275             ++I; // This analysis is preserved, leave it in the available set...
 276           else {
 277             if (!dynamic_cast<ImmutablePass*>(I->second)) {
 278               std::map<AnalysisID, Pass*>::iterator J = I++;
 279               CurrentAnalyses.erase(J);   // Analysis not preserved!
 280             } else {
 281               ++I;
 282             }
 283           }
 284       }
 285
 286       // Add the current pass to the set of passes that have been run, and are
 287       // thus available to users.
 288       //
 289       if (const PassInfo *PI = P->getPassInfo()) {
 290         CurrentAnalyses[PI] = P;
 291
 292         // This pass is the current implementation of all of the interfaces it
 293         // implements as well.
 294         //
 295         const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
 296         for (unsigned i = 0, e = II.size(); i != e; ++i)
 297           CurrentAnalyses[II[i]] = P;
 298       }
 299
 300       // Free memory for any passes that we are the last use of...
 301       std::vector<Pass*> &DeadPass = LastUserOf[P];
 302       for (std::vector<Pass*>::iterator I = DeadPass.begin(),E = DeadPass.end();
 303            I != E; ++I) {
 304         PMDebug::PrintPassInformation(getDepth()+1, "Freeing Pass", *I,
 305                                       (Annotable*)M);
 306         (*I)->releaseMemory();
 307       }
 308
 309       // Make sure to remove dead passes from the CurrentAnalyses list...
 310       for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin();
 311            I != CurrentAnalyses.end(); ) {
 312         std::vector<Pass*>::iterator DPI = std::find(DeadPass.begin(),
 313                                                      DeadPass.end(), I->second);
 314         if (DPI != DeadPass.end()) {    // This pass is dead now... remove it
 315           std::map<AnalysisID, Pass*>::iterator IDead = I++;
 316           CurrentAnalyses.erase(IDead);
 317         } else {
 318           ++I;  // Move on to the next element...
 319         }
 320       }
 321     }
 322
 323     return MadeChanges;
 324   }
 325
 326   // dumpPassStructure - Implement the -debug-passes=PassStructure option
 327   virtual void dumpPassStructure(unsigned Offset = 0) {
 328     // Print out the immutable passes...
 329     for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i)
 330       ImmutablePasses[i]->dumpPassStructure(0);
 331
 332     std::cerr << std::string(Offset*2, ' ') << Traits::getPMName()
 333               << " Pass Manager\n";
 334     for (typename std::vector<PassClass*>::iterator
 335            I = Passes.begin(), E = Passes.end(); I != E; ++I) {
 336       PassClass *P = *I;
 337       P->dumpPassStructure(Offset+1);
 338
 339       // Loop through and see which classes are destroyed after this one...
 340       for (std::map<Pass*, Pass*>::iterator I = LastUseOf.begin(),
 341                                             E = LastUseOf.end(); I != E; ++I) {
 342         if (P == I->second) {
 343           std::cerr << "--" << std::string(Offset*2, ' ');
 344           I->first->dumpPassStructure(0);
 345         }
 346       }
 347     }
 348   }
 349
 350   Pass *getImmutablePassOrNull(const PassInfo *ID) const {
 351     for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
 352       const PassInfo *IPID = ImmutablePasses[i]->getPassInfo();
 353       if (IPID == ID)
 354         return ImmutablePasses[i];
 355
 356       // This pass is the current implementation of all of the interfaces it
 357       // implements as well.
 358       //
 359       const std::vector<const PassInfo*> &II =
 360         IPID->getInterfacesImplemented();
 361       for (unsigned j = 0, e = II.size(); j != e; ++j)
 362         if (II[j] == ID) return ImmutablePasses[i];
 363     }
 364     return 0;
 365   }
 366
 367   Pass *getAnalysisOrNullDown(const PassInfo *ID) const {
 368     std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
 369
 370     if (I != CurrentAnalyses.end())
 371       return I->second;  // Found it.
 372
 373     if (Pass *P = getImmutablePassOrNull(ID))
 374       return P;
 375
 376     if (Batcher)
 377       return ((AnalysisResolver*)Batcher)->getAnalysisOrNullDown(ID);
 378     return 0;
 379   }
 380
 381   Pass *getAnalysisOrNullUp(const PassInfo *ID) const {
 382     std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
 383     if (I != CurrentAnalyses.end())
 384       return I->second;  // Found it.
 385
 386     if (Parent)          // Try scanning...
 387       return Parent->getAnalysisOrNullUp(ID);
 388     else if (!ImmutablePasses.empty())
 389       return getImmutablePassOrNull(ID);
 390     return 0;
 391   }
 392
 393   // markPassUsed - Inform higher level pass managers (and ourselves)
 394   // that these analyses are being used by this pass.  This is used to
 395   // make sure that analyses are not free'd before we have to use
 396   // them...
 397   //
 398   void markPassUsed(const PassInfo *P, Pass *User) {
 399     std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(P);
 400
 401     if (I != CurrentAnalyses.end()) {
 402       LastUseOf[I->second] = User;    // Local pass, extend the lifetime
 403     } else {
 404       // Pass not in current available set, must be a higher level pass
 405       // available to us, propagate to parent pass manager...  We tell the
 406       // parent that we (the passmanager) are using the analysis so that it
 407       // frees the analysis AFTER this pass manager runs.
 408       //
 409       if (Parent) {
 410         Parent->markPassUsed(P, this);
 411       } else {
 412         assert(getAnalysisOrNullUp(P) &&
 413                dynamic_cast<ImmutablePass*>(getAnalysisOrNullUp(P)) &&
 414                "Pass available but not found! "
 415                "Perhaps this is a module pass requiring a function pass?");
 416       }
 417     }
 418   }
 419
 420   // Return the number of parent PassManagers that exist
 421   virtual unsigned getDepth() const {
 422     if (Parent == 0) return 0;
 423     return 1 + Parent->getDepth();
 424   }
 425
 426   virtual unsigned getNumContainedPasses() const { return Passes.size(); }
 427   virtual const Pass *getContainedPass(unsigned N) const {
 428     assert(N < Passes.size() && "Pass number out of range!");
 429     return Passes[N];
 430   }
 431
 432   // add - Add a pass to the queue of passes to run.  This gives ownership of
 433   // the Pass to the PassManager.  When the PassManager is destroyed, the pass
 434   // will be destroyed as well, so there is no need to delete the pass.  This
 435   // implies that all passes MUST be new'd.
 436   //
 437   void add(PassClass *P) {
 438     // Get information about what analyses the pass uses...
 439     AnalysisUsage AnUsage;
 440     P->getAnalysisUsage(AnUsage);
 441     const std::vector<AnalysisID> &Required = AnUsage.getRequiredSet();
 442
 443     // Loop over all of the analyses used by this pass,
 444     for (std::vector<AnalysisID>::const_iterator I = Required.begin(),
 445            E = Required.end(); I != E; ++I) {
 446       if (getAnalysisOrNullDown(*I) == 0)
 447         add((PassClass*)(*I)->createPass());
 448     }
 449
 450     // Tell the pass to add itself to this PassManager... the way it does so
 451     // depends on the class of the pass, and is critical to laying out passes in
 452     // an optimal order..
 453     //
 454     P->addToPassManager(this, AnUsage);
 455   }
 456
 457   // add - H4x0r an ImmutablePass into a PassManager that might not be
 458   // expecting one.
 459   //
 460   void add(ImmutablePass *P) {
 461     // Get information about what analyses the pass uses...
 462     AnalysisUsage AnUsage;
 463     P->getAnalysisUsage(AnUsage);
 464     const std::vector<AnalysisID> &Required = AnUsage.getRequiredSet();
 465
 466     // Loop over all of the analyses used by this pass,
 467     for (std::vector<AnalysisID>::const_iterator I = Required.begin(),
 468            E = Required.end(); I != E; ++I) {
 469       if (getAnalysisOrNullDown(*I) == 0)
 470         add((PassClass*)(*I)->createPass());
 471     }
 472
 473     // Add the ImmutablePass to this PassManager.
 474     addPass(P, AnUsage);
 475   }
 476
 477 private:
 478   // addPass - These functions are used to implement the subclass specific
 479   // behaviors present in PassManager.  Basically the add(Pass*) method ends up
 480   // reflecting its behavior into a Pass::addToPassManager call.  Subclasses of
 481   // Pass override it specifically so that they can reflect the type
 482   // information inherent in "this" back to the PassManager.
 483   //
 484   // For generic Pass subclasses (which are interprocedural passes), we simply
 485   // add the pass to the end of the pass list and terminate any accumulation of
 486   // FunctionPass's that are present.
 487   //
 488   void addPass(PassClass *P, AnalysisUsage &AnUsage) {
 489     const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
 490
 491     // FIXME: If this pass being added isn't killed by any of the passes in the
 492     // batcher class then we can reorder to pass to execute before the batcher
 493     // does, which will potentially allow us to batch more passes!
 494     //
 495     //const std::vector<AnalysisID> &ProvidedSet = AnUsage.getProvidedSet();
 496     if (Batcher /*&& ProvidedSet.empty()*/)
 497       closeBatcher();                     // This pass cannot be batched!
 498
 499     // Set the Resolver instance variable in the Pass so that it knows where to
 500     // find this object...
 501     //
 502     setAnalysisResolver(P, this);
 503     Passes.push_back(P);
 504
 505     // Inform higher level pass managers (and ourselves) that these analyses are
 506     // being used by this pass.  This is used to make sure that analyses are not
 507     // free'd before we have to use them...
 508     //
 509     for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
 510            E = RequiredSet.end(); I != E; ++I)
 511       markPassUsed(*I, P);     // Mark *I as used by P
 512
 513     // Erase all analyses not in the preserved set...
 514     if (!AnUsage.getPreservesAll()) {
 515       const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
 516       for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin(),
 517              E = CurrentAnalyses.end(); I != E; ) {
 518         if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
 519             PreservedSet.end()) {             // Analysis not preserved!
 520           CurrentAnalyses.erase(I);           // Remove from available analyses
 521           I = CurrentAnalyses.begin();
 522         } else {
 523           ++I;
 524         }
 525       }
 526     }
 527
 528     // Add this pass to the currently available set...
 529     if (const PassInfo *PI = P->getPassInfo()) {
 530       CurrentAnalyses[PI] = P;
 531
 532       // This pass is the current implementation of all of the interfaces it
 533       // implements as well.
 534       //
 535       const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
 536       for (unsigned i = 0, e = II.size(); i != e; ++i)
 537         CurrentAnalyses[II[i]] = P;
 538     }
 539
 540     // For now assume that our results are never used...
 541     LastUseOf[P] = P;
 542   }
 543
 544   // For FunctionPass subclasses, we must be sure to batch the FunctionPass's
 545   // together in a BatcherClass object so that all of the analyses are run
 546   // together a function at a time.
 547   //
 548   void addPass(SubPassClass *MP, AnalysisUsage &AnUsage) {
 549     if (Batcher == 0) // If we don't have a batcher yet, make one now.
 550       Batcher = new BatcherClass(this);
 551     // The Batcher will queue the passes up
 552     MP->addToPassManager(Batcher, AnUsage);
 553   }
 554
 555   // closeBatcher - Terminate the batcher that is being worked on.
 556   void closeBatcher() {
 557     if (Batcher) {
 558       Passes.push_back(Batcher);
 559       Batcher = 0;
 560     }
 561   }
 562
 563 public:
 564   // When an ImmutablePass is added, it gets added to the top level pass
 565   // manager.
 566   void addPass(ImmutablePass *IP, AnalysisUsage &AU) {
 567     if (Parent) { // Make sure this request goes to the top level passmanager...
 568       Parent->addPass(IP, AU);
 569       return;
 570     }
 571
 572     // Set the Resolver instance variable in the Pass so that it knows where to
 573     // find this object...
 574     //
 575     setAnalysisResolver(IP, this);
 576     ImmutablePasses.push_back(IP);
 577
 578     // All Required analyses should be available to the pass as it initializes!
 579     // Here we fill in the AnalysisImpls member of the pass so that it can
 580     // successfully use the getAnalysis() method to retrieve the implementations
 581     // it needs.
 582     //
 583     IP->AnalysisImpls.clear();
 584     IP->AnalysisImpls.reserve(AU.getRequiredSet().size());
 585     for (std::vector<const PassInfo *>::const_iterator
 586            I = AU.getRequiredSet().begin(),
 587            E = AU.getRequiredSet().end(); I != E; ++I) {
 588       Pass *Impl = getAnalysisOrNullUp(*I);
 589       if (Impl == 0) {
 590         std::cerr << "Analysis '" << (*I)->getPassName()
 591                   << "' used but not available!";
 592         assert(0 && "Analysis used but not available!");
 593       } else if (PassDebugging == Details) {
 594         if ((*I)->getPassName() != std::string(Impl->getPassName()))
 595           std::cerr << "    Interface '" << (*I)->getPassName()
 596                     << "' implemented by '" << Impl->getPassName() << "'\n";
 597       }
 598       IP->AnalysisImpls.push_back(std::make_pair(*I, Impl));
 599     }
 600
 601     // Initialize the immutable pass...
 602     IP->initializePass();
 603   }
 604 };
 605
 606
 607
 608 //===----------------------------------------------------------------------===//
 609 // PassManagerTraits<BasicBlock> Specialization
 610 //
 611 // This pass manager is used to group together all of the BasicBlockPass's
 612 // into a single unit.
 613 //
 614 template<> struct PassManagerTraits<BasicBlock> : public BasicBlockPass {
 615   // PassClass - The type of passes tracked by this PassManager
 616   typedef BasicBlockPass PassClass;
 617
 618   // SubPassClass - The types of classes that should be collated together
 619   // This is impossible to match, so BasicBlock instantiations of PassManagerT
 620   // do not collate.
 621   //
 622   typedef PassManagerT<Module> SubPassClass;
 623
 624   // BatcherClass - The type to use for collation of subtypes... This class is
 625   // never instantiated for the PassManager<BasicBlock>, but it must be an
 626   // instance of PassClass to typecheck.
 627   //
 628   typedef PassClass BatcherClass;
 629
 630   // ParentClass - The type of the parent PassManager...
 631   typedef PassManagerT<Function> ParentClass;
 632
 633   // PMType - The type of the passmanager that subclasses this class
 634   typedef PassManagerT<BasicBlock> PMType;
 635
 636   // runPass - Specify how the pass should be run on the UnitType
 637   static bool runPass(PassClass *P, BasicBlock *M) {
 638     // todo, init and finalize
 639     return P->runOnBasicBlock(*M);
 640   }
 641
 642   // getPMName() - Return the name of the unit the PassManager operates on for
 643   // debugging.
 644   const char *getPMName() const { return "BasicBlock"; }
 645   virtual const char *getPassName() const { return "BasicBlock Pass Manager"; }
 646
 647   // Implement the BasicBlockPass interface...
 648   virtual bool doInitialization(Module &M);
 649   virtual bool doInitialization(Function &F);
 650   virtual bool runOnBasicBlock(BasicBlock &BB);
 651   virtual bool doFinalization(Function &F);
 652   virtual bool doFinalization(Module &M);
 653
 654   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 655     AU.setPreservesAll();
 656   }
 657 };
 658
 659
 660
 661 //===----------------------------------------------------------------------===//
 662 // PassManagerTraits<Function> Specialization
 663 //
 664 // This pass manager is used to group together all of the FunctionPass's
 665 // into a single unit.
 666 //
 667 template<> struct PassManagerTraits<Function> : public FunctionPass {
 668   // PassClass - The type of passes tracked by this PassManager
 669   typedef FunctionPass PassClass;
 670
 671   // SubPassClass - The types of classes that should be collated together
 672   typedef BasicBlockPass SubPassClass;
 673
 674   // BatcherClass - The type to use for collation of subtypes...
 675   typedef PassManagerT<BasicBlock> BatcherClass;
 676
 677   // ParentClass - The type of the parent PassManager...
 678   typedef PassManagerT<Module> ParentClass;
 679
 680   // PMType - The type of the passmanager that subclasses this class
 681   typedef PassManagerT<Function> PMType;
 682
 683   // runPass - Specify how the pass should be run on the UnitType
 684   static bool runPass(PassClass *P, Function *F) {
 685     return P->runOnFunction(*F);
 686   }
 687
 688   // getPMName() - Return the name of the unit the PassManager operates on for
 689   // debugging.
 690   const char *getPMName() const { return "Function"; }
 691   virtual const char *getPassName() const { return "Function Pass Manager"; }
 692
 693   // Implement the FunctionPass interface...
 694   virtual bool doInitialization(Module &M);
 695   virtual bool runOnFunction(Function &F);
 696   virtual bool doFinalization(Module &M);
 697
 698   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 699     AU.setPreservesAll();
 700   }
 701 };
 702
 703
 704
 705 //===----------------------------------------------------------------------===//
 706 // PassManagerTraits<Module> Specialization
 707 //
 708 // This is the top level PassManager implementation that holds generic passes.
 709 //
 710 template<> struct PassManagerTraits<Module> : public Pass {
 711   // PassClass - The type of passes tracked by this PassManager
 712   typedef Pass PassClass;
 713
 714   // SubPassClass - The types of classes that should be collated together
 715   typedef FunctionPass SubPassClass;
 716
 717   // BatcherClass - The type to use for collation of subtypes...
 718   typedef PassManagerT<Function> BatcherClass;
 719
 720   // ParentClass - The type of the parent PassManager...
 721   typedef AnalysisResolver ParentClass;
 722
 723   // runPass - Specify how the pass should be run on the UnitType
 724   static bool runPass(PassClass *P, Module *M) { return P->run(*M); }
 725
 726   // getPMName() - Return the name of the unit the PassManager operates on for
 727   // debugging.
 728   const char *getPMName() const { return "Module"; }
 729   virtual const char *getPassName() const { return "Module Pass Manager"; }
 730
 731   // run - Implement the PassManager interface...
 732   bool run(Module &M) {
 733     return ((PassManagerT<Module>*)this)->runOnUnit(&M);
 734   }
 735 };
 736
 737
 738
 739 //===----------------------------------------------------------------------===//
 740 // PassManagerTraits Method Implementations
 741 //
 742
 743 // PassManagerTraits<BasicBlock> Implementations
 744 //
 745 inline bool PassManagerTraits<BasicBlock>::doInitialization(Module &M) {
 746   bool Changed = false;
 747   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
 748     ((PMType*)this)->Passes[i]->doInitialization(M);
 749   return Changed;
 750 }
 751
 752 inline bool PassManagerTraits<BasicBlock>::doInitialization(Function &F) {
 753   bool Changed = false;
 754   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
 755     ((PMType*)this)->Passes[i]->doInitialization(F);
 756   return Changed;
 757 }
 758
 759 inline bool PassManagerTraits<BasicBlock>::runOnBasicBlock(BasicBlock &BB) {
 760   return ((PMType*)this)->runOnUnit(&BB);
 761 }
 762
 763 inline bool PassManagerTraits<BasicBlock>::doFinalization(Function &F) {
 764   bool Changed = false;
 765   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
 766     ((PMType*)this)->Passes[i]->doFinalization(F);
 767   return Changed;
 768 }
 769
 770 inline bool PassManagerTraits<BasicBlock>::doFinalization(Module &M) {
 771   bool Changed = false;
 772   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
 773     ((PMType*)this)->Passes[i]->doFinalization(M);
 774   return Changed;
 775 }
 776
 777
 778 // PassManagerTraits<Function> Implementations
 779 //
 780 inline bool PassManagerTraits<Function>::doInitialization(Module &M) {
 781   bool Changed = false;
 782   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
 783     ((PMType*)this)->Passes[i]->doInitialization(M);
 784   return Changed;
 785 }
 786
 787 inline bool PassManagerTraits<Function>::runOnFunction(Function &F) {
 788   return ((PMType*)this)->runOnUnit(&F);
 789 }
 790
 791 inline bool PassManagerTraits<Function>::doFinalization(Module &M) {
 792   bool Changed = false;
 793   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
 794     ((PMType*)this)->Passes[i]->doFinalization(M);
 795   return Changed;
 796 }
 797
 798 } // End llvm namespace
 799
 800 #endif