planes is not spelled with an O
[oota-llvm.git] / lib / VMCore / PassManagerT.h
index a8c8d579be29f5b07ccc76c494f780ad3b2ec594..53ce19f2e1f1fd15e402b68e6c29b7805a9617c2 100644 (file)
-//===- llvm/PassManager.h - Container for Passes -----------------*- C++ -*--=//
+//===- PassManagerT.h - Container for Passes ---------------------*- C++ -*--=//
 //
-// This file defines the PassManager class.  This class is used to hold,
+// This file defines the PassManagerT class.  This class is used to hold,
 // maintain, and optimize execution of Pass's.  The PassManager class ensures
 // that analysis results are available before a pass runs, and that Pass's are
 // destroyed when the PassManager is destroyed.
 //
-// The PassManagerT template is instantiated three times to do its job.
+// The PassManagerT template is instantiated three times to do its job.  The
+// public PassManager class is a Pimpl around the PassManagerT<Module> interface
+// to avoid having all of the PassManager clients being exposed to the
+// implementation details herein.
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_PASSMANAGER_H
-#define LLVM_PASSMANAGER_H
+#ifndef LLVM_PASSMANAGER_T_H
+#define LLVM_PASSMANAGER_T_H
 
 #include "llvm/Pass.h"
-#include <string>
+#include "Support/CommandLine.h"
+#include "Support/LeakDetector.h"
+#include "Support/Timer.h"
 #include <algorithm>
+#include <iostream>
+class Annotable;
+
+//===----------------------------------------------------------------------===//
+// Pass debugging information.  Often it is useful to find out what pass is
+// running when a crash occurs in a utility.  When this library is compiled with
+// debugging on, a command line option (--debug-pass) is enabled that causes the
+// pass name to be printed before it executes.
+//
+
+// Different debug levels that can be enabled...
+enum PassDebugLevel {
+  None, Arguments, Structure, Executions, Details
+};
+
+static cl::opt<enum PassDebugLevel>
+PassDebugging("debug-pass", cl::Hidden,
+              cl::desc("Print PassManager debugging information"),
+              cl::values(
+  clEnumVal(None      , "disable debug output"),
+  clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
+  clEnumVal(Structure , "print pass structure before run()"),
+  clEnumVal(Executions, "print pass name before it is executed"),
+  clEnumVal(Details   , "print pass details when it is executed"),
+                         0));
 
 //===----------------------------------------------------------------------===//
 // PMDebug class - a set of debugging functions, that are not to be
 // instantiated by the template.
 //
 struct PMDebug {
-  // If compiled in debug mode, these functions can be enabled by setting
-  // -debug-pass on the command line of the tool being used.
-  //
-  static void PrintPassStructure(Pass *P);
-  static void PrintPassInformation(unsigned,const char*,Pass *, Value *);
+  static void PerformPassStartupStuff(Pass *P) {
+    // If debugging is enabled, print out argument information...
+    if (PassDebugging >= Arguments) {
+      std::cerr << "Pass Arguments: ";
+      PrintArgumentInformation(P);
+      std::cerr << "\n";
+
+      // Print the pass execution structure
+      if (PassDebugging >= Structure)
+        P->dumpPassStructure();
+    }
+  }
+
+  static void PrintArgumentInformation(const Pass *P);
+  static void PrintPassInformation(unsigned,const char*,Pass *, Annotable *);
   static void PrintAnalysisSetInfo(unsigned,const char*,Pass *P,
                                    const std::vector<AnalysisID> &);
 };
 
 
+//===----------------------------------------------------------------------===//
+// TimingInfo Class - This class is used to calculate information about the
+// amount of time each pass takes to execute.  This only happens when
+// -time-passes is enabled on the command line.
+//
+
+class TimingInfo {
+  std::map<Pass*, Timer> TimingData;
+  TimerGroup TG;
+
+  // Private ctor, must use 'create' member
+  TimingInfo() : TG("... Pass execution timing report ...") {}
+public:
+  // Create method.  If Timing is enabled, this creates and returns a new timing
+  // object, otherwise it returns null.
+  //
+  static TimingInfo *create();
+
+  // TimingDtor - Print out information about timing information
+  ~TimingInfo() {
+    // Delete all of the timers...
+    TimingData.clear();
+    // TimerGroup is deleted next, printing the report.
+  }
+
+  void passStarted(Pass *P) {
+    if (dynamic_cast<AnalysisResolver*>(P)) return;
+    std::map<Pass*, Timer>::iterator I = TimingData.find(P);
+    if (I == TimingData.end())
+      I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
+    I->second.startTimer();
+  }
+  void passEnded(Pass *P) {
+    if (dynamic_cast<AnalysisResolver*>(P)) return;
+    std::map<Pass*, Timer>::iterator I = TimingData.find(P);
+    assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
+    I->second.stopTimer();
+  }
+};
 
 //===----------------------------------------------------------------------===//
 // Declare the PassManagerTraits which will be specialized...
@@ -45,17 +124,19 @@ template<class UnitType> class PassManagerTraits;   // Do not define.
 //
 template<typename UnitType>
 class PassManagerT : public PassManagerTraits<UnitType>,public AnalysisResolver{
-  typedef typename PassManagerTraits<UnitType>::PassClass       PassClass;
-  typedef typename PassManagerTraits<UnitType>::SubPassClass SubPassClass;
-  typedef typename PassManagerTraits<UnitType>::BatcherClass BatcherClass;
-  typedef typename PassManagerTraits<UnitType>::ParentClass   ParentClass;
-  typedef          PassManagerTraits<UnitType>                     Traits;
+  typedef PassManagerTraits<UnitType> Traits;
+  typedef typename Traits::PassClass       PassClass;
+  typedef typename Traits::SubPassClass SubPassClass;
+  typedef typename Traits::BatcherClass BatcherClass;
+  typedef typename Traits::ParentClass   ParentClass;
 
-  friend typename PassManagerTraits<UnitType>::PassClass;
-  friend typename PassManagerTraits<UnitType>::SubPassClass;  
-  friend class PassManagerTraits<UnitType>;
+  friend typename Traits::PassClass;
+  friend typename Traits::SubPassClass;  
+  friend class Traits;
+  friend class ImmutablePass;
 
-  std::vector<PassClass*> Passes;    // List of pass's to run
+  std::vector<PassClass*> Passes;    // List of passes to run
+  std::vector<ImmutablePass*> ImmutablePasses;  // List of immutable passes
 
   // The parent of this pass manager...
   ParentClass * const Parent;
@@ -79,8 +160,12 @@ public:
   PassManagerT(ParentClass *Par = 0) : Parent(Par), Batcher(0) {}
   ~PassManagerT() {
     // Delete all of the contained passes...
-    for (std::vector<PassClass*>::iterator I = Passes.begin(), E = Passes.end();
-         I != E; ++I)
+    for (typename std::vector<PassClass*>::iterator
+           I = Passes.begin(), E = Passes.end(); I != E; ++I)
+      delete *I;
+
+    for (std::vector<ImmutablePass*>::iterator
+           I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
       delete *I;
   }
 
@@ -91,6 +176,18 @@ public:
     closeBatcher();
     CurrentAnalyses.clear();
 
+    // Add any immutable passes to the CurrentAnalyses set...
+    for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
+      ImmutablePass *IPass = ImmutablePasses[i];
+      if (const PassInfo *PI = IPass->getPassInfo()) {
+        CurrentAnalyses[PI] = IPass;
+
+        const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
+        for (unsigned i = 0, e = II.size(); i != e; ++i)
+          CurrentAnalyses[II[i]] = IPass;
+      }
+    }
+
     // LastUserOf - This contains the inverted LastUseOfMap...
     std::map<Pass *, std::vector<Pass*> > LastUserOf;
     for (std::map<Pass*, Pass*>::iterator I = LastUseOf.begin(),
@@ -99,13 +196,14 @@ public:
 
 
     // Output debug information...
-    if (Parent == 0) PMDebug::PrintPassStructure(this);
+    if (Parent == 0) PMDebug::PerformPassStartupStuff(this);
 
     // Run all of the passes
     for (unsigned i = 0, e = Passes.size(); i < e; ++i) {
       PassClass *P = Passes[i];
       
-      PMDebug::PrintPassInformation(getDepth(), "Executing Pass", P, (Value*)M);
+      PMDebug::PrintPassInformation(getDepth(), "Executing Pass", P,
+                                    (Annotable*)M);
 
       // Get information about what analyses the pass uses...
       AnalysisUsage AnUsage;
@@ -113,30 +211,48 @@ public:
       PMDebug::PrintAnalysisSetInfo(getDepth(), "Required", P,
                                     AnUsage.getRequiredSet());
 
-#ifndef NDEBUG
-      // All Required analyses should be available to the pass as it runs!
-      for (vector<AnalysisID>::const_iterator
+      // All Required analyses should be available to the pass as it runs!  Here
+      // we fill in the AnalysisImpls member of the pass so that it can
+      // successfully use the getAnalysis() method to retrieve the
+      // implementations it needs.
+      //
+      P->AnalysisImpls.clear();
+      P->AnalysisImpls.reserve(AnUsage.getRequiredSet().size());
+      for (std::vector<const PassInfo *>::const_iterator
              I = AnUsage.getRequiredSet().begin(), 
              E = AnUsage.getRequiredSet().end(); I != E; ++I) {
-        assert(getAnalysisOrNullUp(*I) && "Analysis used but not available!");
+        Pass *Impl = getAnalysisOrNullUp(*I);
+        if (Impl == 0) {
+          std::cerr << "Analysis '" << (*I)->getPassName()
+                    << "' used but not available!";
+          assert(0 && "Analysis used but not available!");
+        } else if (PassDebugging == Details) {
+          if ((*I)->getPassName() != std::string(Impl->getPassName()))
+            std::cerr << "    Interface '" << (*I)->getPassName()
+                    << "' implemented by '" << Impl->getPassName() << "'\n";
+        }
+        P->AnalysisImpls.push_back(std::make_pair(*I, Impl));
       }
-#endif
 
       // Run the sub pass!
-      bool Changed = Traits::runPass(P, M);
+      startPass(P);
+      bool Changed = runPass(P, M);
+      endPass(P);
       MadeChanges |= Changed;
 
+      // Check for memory leaks by the pass...
+      LeakDetector::checkForGarbage(std::string("after running pass '") +
+                                    P->getPassName() + "'");
+
       if (Changed)
         PMDebug::PrintPassInformation(getDepth()+1, "Made Modification", P,
-                                      (Value*)M);
+                                      (Annotable*)M);
       PMDebug::PrintAnalysisSetInfo(getDepth(), "Preserved", P,
                                     AnUsage.getPreservedSet());
-      PMDebug::PrintAnalysisSetInfo(getDepth(), "Provided", P,
-                                    AnUsage.getProvidedSet());
 
 
       // Erase all analyses not in the preserved set...
-      if (!AnUsage.preservesAll()) {
+      if (!AnUsage.getPreservesAll()) {
         const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
         for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin(),
                E = CurrentAnalyses.end(); I != E; )
@@ -144,40 +260,69 @@ public:
               PreservedSet.end())
             ++I; // This analysis is preserved, leave it in the available set...
           else {
+            if (!dynamic_cast<ImmutablePass*>(I->second)) {
 #if MAP_DOESNT_HAVE_BROKEN_ERASE_MEMBER
-            I = CurrentAnalyses.erase(I);   // Analysis not preserved!
+              I = CurrentAnalyses.erase(I);   // Analysis not preserved!
 #else
-            // GCC 2.95.3 STL doesn't have correct erase member!
-            CurrentAnalyses.erase(I);
-            I = CurrentAnalyses.begin();
+              // GCC 2.95.3 STL doesn't have correct erase member!
+              CurrentAnalyses.erase(I);
+              I = CurrentAnalyses.begin();
 #endif
+            } else {
+              ++I;
+            }
           }
       }
 
-      // Add all analyses in the provided set...
-      for (std::vector<AnalysisID>::const_iterator
-             I = AnUsage.getProvidedSet().begin(),
-             E = AnUsage.getProvidedSet().end(); I != E; ++I)
-        CurrentAnalyses[*I] = P;
+      // Add the current pass to the set of passes that have been run, and are
+      // thus available to users.
+      //
+      if (const PassInfo *PI = P->getPassInfo()) {
+        CurrentAnalyses[PI] = P;
+
+        // This pass is the current implementation of all of the interfaces it
+        // implements as well.
+        //
+        const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
+        for (unsigned i = 0, e = II.size(); i != e; ++i)
+          CurrentAnalyses[II[i]] = P;
+      }
 
       // Free memory for any passes that we are the last use of...
       std::vector<Pass*> &DeadPass = LastUserOf[P];
       for (std::vector<Pass*>::iterator I = DeadPass.begin(),E = DeadPass.end();
            I != E; ++I) {
         PMDebug::PrintPassInformation(getDepth()+1, "Freeing Pass", *I,
-                                      (Value*)M);
+                                      (Annotable*)M);
         (*I)->releaseMemory();
       }
+
+      // Make sure to remove dead passes from the CurrentAnalyses list...
+      for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin();
+           I != CurrentAnalyses.end(); ) {
+        std::vector<Pass*>::iterator DPI = std::find(DeadPass.begin(),
+                                                     DeadPass.end(), I->second);
+        if (DPI != DeadPass.end()) {    // This pass is dead now... remove it
+          std::map<AnalysisID, Pass*>::iterator IDead = I++;
+          CurrentAnalyses.erase(IDead);
+        } else {
+          ++I;  // Move on to the next element...
+        }
+      }
     }
     return MadeChanges;
   }
 
   // dumpPassStructure - Implement the -debug-passes=PassStructure option
   virtual void dumpPassStructure(unsigned Offset = 0) {
+    // Print out the immutable passes...
+    for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i)
+      ImmutablePasses[i]->dumpPassStructure(0);
+
     std::cerr << std::string(Offset*2, ' ') << Traits::getPMName()
               << " Pass Manager\n";
-    for (std::vector<PassClass*>::iterator I = Passes.begin(), E = Passes.end();
-         I != E; ++I) {
+    for (typename std::vector<PassClass*>::iterator
+           I = Passes.begin(), E = Passes.end(); I != E; ++I) {
       PassClass *P = *I;
       P->dumpPassStructure(Offset+1);
 
@@ -185,31 +330,46 @@ public:
       for (std::map<Pass*, Pass*>::iterator I = LastUseOf.begin(),
                                             E = LastUseOf.end(); I != E; ++I) {
         if (P == I->second) {
-          std::cerr << "Fr" << std::string(Offset*2, ' ');
+          std::cerr << "--" << std::string(Offset*2, ' ');
           I->first->dumpPassStructure(0);
         }
       }
     }
   }
 
-  Pass *getAnalysisOrNullDown(AnalysisID ID) const {
+  Pass *getAnalysisOrNullDown(const PassInfo *ID) const {
     std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
-    if (I == CurrentAnalyses.end()) {
-      if (Batcher)
-        return ((AnalysisResolver*)Batcher)->getAnalysisOrNullDown(ID);
-      return 0;
-    }
-    return I->second;
+
+    if (I != CurrentAnalyses.end())
+      return I->second;  // Found it.
+
+    if (Batcher)
+      return ((AnalysisResolver*)Batcher)->getAnalysisOrNullDown(ID);
+    return 0;
   }
 
-  Pass *getAnalysisOrNullUp(AnalysisID ID) const {
+  Pass *getAnalysisOrNullUp(const PassInfo *ID) const {
     std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
-    if (I == CurrentAnalyses.end()) {
-      if (Parent)
-        return Parent->getAnalysisOrNullUp(ID);
-      return 0;
-    }
-    return I->second;
+    if (I != CurrentAnalyses.end())
+      return I->second;  // Found it.
+
+    if (Parent)          // Try scanning...
+      return Parent->getAnalysisOrNullUp(ID);
+    return 0;
+  }
+
+  // {start/end}Pass - Called when a pass is started, it just propagates
+  // information up to the top level PassManagerT object to tell it that a pass
+  // has started or ended.  This is used to gather timing information about
+  // passes.
+  //
+  void startPass(Pass *P) {
+    if (Parent) Parent->startPass(P);
+    else PassStarted(P);
+  }
+  void endPass(Pass *P) {
+    if (Parent) Parent->endPass(P);
+    else PassEnded(P);
   }
 
   // markPassUsed - Inform higher level pass managers (and ourselves)
@@ -217,29 +377,39 @@ public:
   // make sure that analyses are not free'd before we have to use
   // them...
   //
-  void markPassUsed(AnalysisID P, Pass *User) {
-    std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.find(P);
+  void markPassUsed(const PassInfo *P, Pass *User) {
+    std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(P);
+
     if (I != CurrentAnalyses.end()) {
       LastUseOf[I->second] = User;    // Local pass, extend the lifetime
     } else {
       // Pass not in current available set, must be a higher level pass
-      // available to us, propogate to parent pass manager...  We tell the
+      // available to us, propagate to parent pass manager...  We tell the
       // parent that we (the passmanager) are using the analysis so that it
       // frees the analysis AFTER this pass manager runs.
       //
-      assert(Parent != 0 && "Pass available but not found! "
-             "Did your analysis pass 'Provide' itself?");
-      Parent->markPassUsed(P, this);
+      if (Parent) {
+        Parent->markPassUsed(P, this);
+      } else {
+        assert(0 && "Pass available but not found! "
+               "Perhaps this is a module pass requiring a function pass?");
+      }
     }
   }
-
+  
   // Return the number of parent PassManagers that exist
   virtual unsigned getDepth() const {
     if (Parent == 0) return 0;
     return 1 + Parent->getDepth();
   }
 
-  // add - Add a pass to the queue of passes to run.  This passes ownership of
+  virtual unsigned getNumContainedPasses() const { return Passes.size(); }
+  virtual const Pass *getContainedPass(unsigned N) const {
+    assert(N < Passes.size() && "Pass number out of range!");
+    return Passes[N];
+  }
+
+  // add - Add a pass to the queue of passes to run.  This gives ownership of
   // the Pass to the PassManager.  When the PassManager is destroyed, the pass
   // will be destroyed as well, so there is no need to delete the pass.  This
   // implies that all passes MUST be new'd.
@@ -254,7 +424,7 @@ public:
     for (std::vector<AnalysisID>::const_iterator I = Required.begin(),
            E = Required.end(); I != E; ++I) {
       if (getAnalysisOrNullDown(*I) == 0)
-        add((PassClass*)I->createPass());
+        add((PassClass*)(*I)->createPass());
     }
 
     // Tell the pass to add itself to this PassManager... the way it does so
@@ -278,13 +448,13 @@ private:
   //
   void addPass(PassClass *P, AnalysisUsage &AnUsage) {
     const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
-    const std::vector<AnalysisID> &ProvidedSet = AnUsage.getProvidedSet();
 
-    // Providers are analysis classes which are forbidden to modify the module
-    // they are operating on, so they are allowed to be reordered to before the
-    // batcher...
+    // FIXME: If this pass being added isn't killed by any of the passes in the
+    // batcher class then we can reorder to pass to execute before the batcher
+    // does, which will potentially allow us to batch more passes!
     //
-    if (Batcher && ProvidedSet.empty())
+    //const std::vector<AnalysisID> &ProvidedSet = AnUsage.getProvidedSet();
+    if (Batcher /*&& ProvidedSet.empty()*/)
       closeBatcher();                     // This pass cannot be batched!
     
     // Set the Resolver instance variable in the Pass so that it knows where to 
@@ -302,27 +472,31 @@ private:
       markPassUsed(*I, P);     // Mark *I as used by P
 
     // Erase all analyses not in the preserved set...
-    if (!AnUsage.preservesAll()) {
+    if (!AnUsage.getPreservesAll()) {
       const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
       for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin(),
-             E = CurrentAnalyses.end(); I != E; )
-        if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) !=
-            PreservedSet.end())
-          ++I;  // This analysis is preserved, leave it in the available set...
-        else {
-#if MAP_DOESNT_HAVE_BROKEN_ERASE_MEMBER
-          I = CurrentAnalyses.erase(I);   // Analysis not preserved!
-#else
-          CurrentAnalyses.erase(I);// GCC 2.95.3 STL doesn't have correct erase!
+             E = CurrentAnalyses.end(); I != E; ) {
+        if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
+            PreservedSet.end()) {             // Analysis not preserved!
+          CurrentAnalyses.erase(I);           // Remove from available analyses
           I = CurrentAnalyses.begin();
-#endif
+        } else {
+          ++I;
         }
+      }
     }
 
-    // Add all analyses in the provided set...
-    for (std::vector<AnalysisID>::const_iterator I = ProvidedSet.begin(),
-           E = ProvidedSet.end(); I != E; ++I)
-      CurrentAnalyses[*I] = P;
+    // Add this pass to the currently available set...
+    if (const PassInfo *PI = P->getPassInfo()) {
+      CurrentAnalyses[PI] = P;
+
+      // This pass is the current implementation of all of the interfaces it
+      // implements as well.
+      //
+      const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
+      for (unsigned i = 0, e = II.size(); i != e; ++i)
+        CurrentAnalyses[II[i]] = P;
+    }
 
     // For now assume that our results are never used...
     LastUseOf[P] = P;
@@ -335,7 +509,7 @@ private:
   void addPass(SubPassClass *MP, AnalysisUsage &AnUsage) {
     if (Batcher == 0) // If we don't have a batcher yet, make one now.
       Batcher = new BatcherClass(this);
-    // The Batcher will queue them passes up
+    // The Batcher will queue the passes up
     MP->addToPassManager(Batcher, AnUsage);
   }
 
@@ -346,6 +520,34 @@ private:
       Batcher = 0;
     }
   }
+
+public:
+  // When an ImmutablePass is added, it gets added to the top level pass
+  // manager.
+  void addPass(ImmutablePass *IP, AnalysisUsage &AU) {
+    if (Parent) { // Make sure this request goes to the top level passmanager...
+      Parent->addPass(IP, AU);
+      return;
+    }
+
+    // Set the Resolver instance variable in the Pass so that it knows where to 
+    // find this object...
+    //
+    setAnalysisResolver(IP, this);
+    ImmutablePasses.push_back(IP);
+    
+    // Add this pass to the currently available set...
+    if (const PassInfo *PI = IP->getPassInfo()) {
+      CurrentAnalyses[PI] = IP;
+
+      // This pass is the current implementation of all of the interfaces it
+      // implements as well.
+      //
+      const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
+      for (unsigned i = 0, e = II.size(); i != e; ++i)
+        CurrentAnalyses[II[i]] = IP;
+    }
+  }
 };
 
 
@@ -381,17 +583,28 @@ template<> struct PassManagerTraits<BasicBlock> : public BasicBlockPass {
   // runPass - Specify how the pass should be run on the UnitType
   static bool runPass(PassClass *P, BasicBlock *M) {
     // todo, init and finalize
-    return P->runOnBasicBlock(M);
+    return P->runOnBasicBlock(*M);
   }
 
+  // Dummy implementation of PassStarted/PassEnded
+  static void PassStarted(Pass *P) {}
+  static void PassEnded(Pass *P) {}
+
   // getPMName() - Return the name of the unit the PassManager operates on for
   // debugging.
   const char *getPMName() const { return "BasicBlock"; }
+  virtual const char *getPassName() const { return "BasicBlock Pass Manager"; }
 
   // Implement the BasicBlockPass interface...
-  virtual bool doInitialization(Module *M);
-  virtual bool runOnBasicBlock(BasicBlock *BB);
-  virtual bool doFinalization(Module *M);
+  virtual bool doInitialization(Module &M);
+  virtual bool doInitialization(Function &F);
+  virtual bool runOnBasicBlock(BasicBlock &BB);
+  virtual bool doFinalization(Function &F);
+  virtual bool doFinalization(Module &M);
+
+  virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+    AU.setPreservesAll();
+  }
 };
 
 
@@ -420,17 +633,26 @@ template<> struct PassManagerTraits<Function> : public FunctionPass {
 
   // runPass - Specify how the pass should be run on the UnitType
   static bool runPass(PassClass *P, Function *F) {
-    return P->runOnFunction(F);
+    return P->runOnFunction(*F);
   }
 
+  // Dummy implementation of PassStarted/PassEnded
+  static void PassStarted(Pass *P) {}
+  static void PassEnded(Pass *P) {}
+
   // getPMName() - Return the name of the unit the PassManager operates on for
   // debugging.
   const char *getPMName() const { return "Function"; }
+  virtual const char *getPassName() const { return "Function Pass Manager"; }
 
   // Implement the FunctionPass interface...
-  virtual bool doInitialization(Module *M);
-  virtual bool runOnFunction(Function *F);
-  virtual bool doFinalization(Module *M);
+  virtual bool doInitialization(Module &M);
+  virtual bool runOnFunction(Function &F);
+  virtual bool doFinalization(Module &M);
+
+  virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+    AU.setPreservesAll();
+  }
 };
 
 
@@ -454,16 +676,44 @@ template<> struct PassManagerTraits<Module> : public Pass {
   typedef AnalysisResolver ParentClass;
 
   // runPass - Specify how the pass should be run on the UnitType
-  static bool runPass(PassClass *P, Module *M) { return P->run(M); }
+  static bool runPass(PassClass *P, Module *M) { return P->run(*M); }
 
   // getPMName() - Return the name of the unit the PassManager operates on for
   // debugging.
   const char *getPMName() const { return "Module"; }
+  virtual const char *getPassName() const { return "Module Pass Manager"; }
+
+  // TimingInformation - This data member maintains timing information for each
+  // of the passes that is executed.
+  //
+  TimingInfo *TimeInfo;
+
+  // PassStarted/Ended - This callback is notified any time a pass is started
+  // or stops.  This is used to collect timing information about the different
+  // passes being executed.
+  //
+  void PassStarted(Pass *P) {
+    if (TimeInfo) TimeInfo->passStarted(P);
+  }
+  void PassEnded(Pass *P) {
+    if (TimeInfo) TimeInfo->passEnded(P);
+  }
 
-  // run - Implement the Pass interface...
-  virtual bool run(Module *M) {
-    return ((PassManagerT<Module>*)this)->runOnUnit(M);
+  // run - Implement the PassManager interface...
+  bool run(Module &M) {
+    TimeInfo = TimingInfo::create();
+    bool Result = ((PassManagerT<Module>*)this)->runOnUnit(&M);
+    if (TimeInfo) {
+      delete TimeInfo;
+      TimeInfo = 0;
+    }
+    return Result;
   }
+
+  // PassManagerTraits constructor - Create a timing info object if the user
+  // specified timing info should be collected on the command line.
+  //
+  PassManagerTraits() : TimeInfo(0) {}
 };
 
 
@@ -474,18 +724,32 @@ template<> struct PassManagerTraits<Module> : public Pass {
 
 // PassManagerTraits<BasicBlock> Implementations
 //
-inline bool PassManagerTraits<BasicBlock>::doInitialization(Module *M) {
+inline bool PassManagerTraits<BasicBlock>::doInitialization(Module &M) {
   bool Changed = false;
   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
     ((PMType*)this)->Passes[i]->doInitialization(M);
   return Changed;
 }
 
-inline bool PassManagerTraits<BasicBlock>::runOnBasicBlock(BasicBlock *BB) {
-  return ((PMType*)this)->runOnUnit(BB);
+inline bool PassManagerTraits<BasicBlock>::doInitialization(Function &F) {
+  bool Changed = false;
+  for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
+    ((PMType*)this)->Passes[i]->doInitialization(F);
+  return Changed;
+}
+
+inline bool PassManagerTraits<BasicBlock>::runOnBasicBlock(BasicBlock &BB) {
+  return ((PMType*)this)->runOnUnit(&BB);
+}
+
+inline bool PassManagerTraits<BasicBlock>::doFinalization(Function &F) {
+  bool Changed = false;
+  for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
+    ((PMType*)this)->Passes[i]->doFinalization(F);
+  return Changed;
 }
 
-inline bool PassManagerTraits<BasicBlock>::doFinalization(Module *M) {
+inline bool PassManagerTraits<BasicBlock>::doFinalization(Module &M) {
   bool Changed = false;
   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
     ((PMType*)this)->Passes[i]->doFinalization(M);
@@ -495,18 +759,18 @@ inline bool PassManagerTraits<BasicBlock>::doFinalization(Module *M) {
 
 // PassManagerTraits<Function> Implementations
 //
-inline bool PassManagerTraits<Function>::doInitialization(Module *M) {
+inline bool PassManagerTraits<Function>::doInitialization(Module &M) {
   bool Changed = false;
   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
     ((PMType*)this)->Passes[i]->doInitialization(M);
   return Changed;
 }
 
-inline bool PassManagerTraits<Function>::runOnFunction(Function *F) {
-  return ((PMType*)this)->runOnUnit(F);
+inline bool PassManagerTraits<Function>::runOnFunction(Function &F) {
+  return ((PMType*)this)->runOnUnit(&F);
 }
 
-inline bool PassManagerTraits<Function>::doFinalization(Module *M) {
+inline bool PassManagerTraits<Function>::doFinalization(Module &M) {
   bool Changed = false;
   for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
     ((PMType*)this)->Passes[i]->doFinalization(M);