There is no error message to print out, end sentence with `!'
[oota-llvm.git] / lib / VMCore / PassManagerT.h
index 55beaa457a482b52f8217290bf3ba6331f02503a..5d50e721939ea4804396b86b8c9144370ddfecb7 100644 (file)
@@ -1,4 +1,11 @@
-//===- PassManagerT.h - Container for Passes ---------------------*- C++ -*--=//
+//===- PassManagerT.h - Container for Passes --------------------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file defines the PassManagerT class.  This class is used to hold,
 // maintain, and optimize execution of Pass's.  The PassManager class ensures
@@ -21,7 +28,8 @@
 #include "Support/Timer.h"
 #include <algorithm>
 #include <iostream>
-class Annotable;
+
+namespace llvm {
 
 //===----------------------------------------------------------------------===//
 // Pass debugging information.  Often it is useful to find out what pass is
@@ -65,7 +73,9 @@ struct PMDebug {
   }
 
   static void PrintArgumentInformation(const Pass *P);
-  static void PrintPassInformation(unsigned,const char*,Pass *, Annotable *);
+  static void PrintPassInformation(unsigned,const char*,Pass *, Module *);
+  static void PrintPassInformation(unsigned,const char*,Pass *, Function *);
+  static void PrintPassInformation(unsigned,const char*,Pass *, BasicBlock *);
   static void PrintAnalysisSetInfo(unsigned,const char*,Pass *P,
                                    const std::vector<AnalysisID> &);
 };
@@ -84,11 +94,6 @@ class TimingInfo {
   // 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...
@@ -96,6 +101,11 @@ public:
     // TimerGroup is deleted next, printing the report.
   }
 
+  // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
+  // to a non null value (if the -time-passes option is enabled) or it leaves it
+  // null.  It may be called multiple times.
+  static void createTheTimeInfo();
+
   void passStarted(Pass *P) {
     if (dynamic_cast<AnalysisResolver*>(P)) return;
     std::map<Pass*, Timer>::iterator I = TimingData.find(P);
@@ -111,6 +121,8 @@ public:
   }
 };
 
+static TimingInfo *TheTimeInfo;
+
 //===----------------------------------------------------------------------===//
 // Declare the PassManagerTraits which will be specialized...
 //
@@ -130,9 +142,14 @@ class PassManagerT : public PassManagerTraits<UnitType>,public AnalysisResolver{
   typedef typename Traits::BatcherClass BatcherClass;
   typedef typename Traits::ParentClass   ParentClass;
 
-  friend typename Traits::PassClass;
-  friend typename Traits::SubPassClass;  
-  friend class Traits;
+#ifndef _MSC_VER
+  friend class PassManagerTraits<UnitType>::PassClass;
+  friend class PassManagerTraits<UnitType>::SubPassClass;  
+#else
+  friend PassClass;
+  friend SubPassClass;
+#endif
+  friend class PassManagerTraits<UnitType>;
   friend class ImmutablePass;
 
   std::vector<PassClass*> Passes;    // List of passes to run
@@ -176,6 +193,8 @@ public:
     closeBatcher();
     CurrentAnalyses.clear();
 
+    TimingInfo::createTheTimeInfo();
+
     // Add any immutable passes to the CurrentAnalyses set...
     for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
       ImmutablePass *IPass = ImmutablePasses[i];
@@ -194,7 +213,6 @@ public:
                                           E = LastUseOf.end(); I != E; ++I)
       LastUserOf[I->second].push_back(I->first);
 
-
     // Output debug information...
     if (Parent == 0) PMDebug::PerformPassStartupStuff(this);
 
@@ -202,8 +220,7 @@ public:
     for (unsigned i = 0, e = Passes.size(); i < e; ++i) {
       PassClass *P = Passes[i];
       
-      PMDebug::PrintPassInformation(getDepth(), "Executing Pass", P,
-                                    (Annotable*)M);
+      PMDebug::PrintPassInformation(getDepth(), "Executing Pass", P, M);
 
       // Get information about what analyses the pass uses...
       AnalysisUsage AnUsage;
@@ -235,9 +252,9 @@ public:
       }
 
       // Run the sub pass!
-      startPass(P);
+      if (TheTimeInfo) TheTimeInfo->passStarted(P);
       bool Changed = runPass(P, M);
-      endPass(P);
+      if (TheTimeInfo) TheTimeInfo->passEnded(P);
       MadeChanges |= Changed;
 
       // Check for memory leaks by the pass...
@@ -245,8 +262,7 @@ public:
                                     P->getPassName() + "'");
 
       if (Changed)
-        PMDebug::PrintPassInformation(getDepth()+1, "Made Modification", P,
-                                      (Annotable*)M);
+        PMDebug::PrintPassInformation(getDepth()+1, "Made Modification", P, M);
       PMDebug::PrintAnalysisSetInfo(getDepth(), "Preserved", P,
                                     AnUsage.getPreservedSet());
 
@@ -287,8 +303,7 @@ public:
       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,
-                                      (Annotable*)M);
+        PMDebug::PrintPassInformation(getDepth()+1, "Freeing Pass", *I, M);
         (*I)->releaseMemory();
       }
 
@@ -305,6 +320,7 @@ public:
         }
       }
     }
+
     return MadeChanges;
   }
 
@@ -375,20 +391,6 @@ public:
     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)
   // that these analyses are being used by this pass.  This is used to
   // make sure that analyses are not free'd before we have to use
@@ -399,6 +401,16 @@ public:
 
     if (I != CurrentAnalyses.end()) {
       LastUseOf[I->second] = User;    // Local pass, extend the lifetime
+
+      // Prolong live range of analyses that are needed after an analysis pass
+      // is destroyed, for querying by subsequent passes
+      AnalysisUsage AnUsage;
+      I->second->getAnalysisUsage(AnUsage);
+      const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
+      for (std::vector<AnalysisID>::const_iterator i = IDs.begin(),
+             e = IDs.end(); i != e; ++i)
+        markPassUsed(*i, User);
+
     } else {
       // Pass not in current available set, must be a higher level pass
       // available to us, propagate to parent pass manager...  We tell the
@@ -453,8 +465,27 @@ public:
     P->addToPassManager(this, AnUsage);
   }
 
-private:
+  // add - H4x0r an ImmutablePass into a PassManager that might not be
+  // expecting one.
+  //
+  void add(ImmutablePass *P) {
+    // Get information about what analyses the pass uses...
+    AnalysisUsage AnUsage;
+    P->getAnalysisUsage(AnUsage);
+    const std::vector<AnalysisID> &Required = AnUsage.getRequiredSet();
+
+    // Loop over all of the analyses used by this pass,
+    for (std::vector<AnalysisID>::const_iterator I = Required.begin(),
+           E = Required.end(); I != E; ++I) {
+      if (getAnalysisOrNullDown(*I) == 0)
+        add((PassClass*)(*I)->createPass());
+    }
+
+    // Add the ImmutablePass to this PassManager.
+    addPass(P, AnUsage);
+  }
 
+private:
   // addPass - These functions are used to implement the subclass specific
   // behaviors present in PassManager.  Basically the add(Pass*) method ends up
   // reflecting its behavior into a Pass::addToPassManager call.  Subclasses of
@@ -619,10 +650,6 @@ template<> struct PassManagerTraits<BasicBlock> : public BasicBlockPass {
     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"; }
@@ -669,10 +696,6 @@ template<> struct PassManagerTraits<Function> : public FunctionPass {
     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"; }
@@ -716,37 +739,10 @@ template<> struct PassManagerTraits<Module> : public Pass {
   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 PassManager interface...
   bool run(Module &M) {
-    TimeInfo = TimingInfo::create();
-    bool Result = ((PassManagerT<Module>*)this)->runOnUnit(&M);
-    if (TimeInfo) {
-      delete TimeInfo;
-      TimeInfo = 0;
-    }
-    return Result;
+    return ((PassManagerT<Module>*)this)->runOnUnit(&M);
   }
-
-  // PassManagerTraits constructor - Create a timing info object if the user
-  // specified timing info should be collected on the command line.
-  //
-  PassManagerTraits() : TimeInfo(0) {}
 };
 
 
@@ -810,4 +806,6 @@ inline bool PassManagerTraits<Function>::doFinalization(Module &M) {
   return Changed;
 }
 
+} // End llvm namespace
+
 #endif