- Fighting with linking problem due to removing the ::ID elements. Now the
[oota-llvm.git] / lib / VMCore / Pass.cpp
index 06e77e7fe16ba0d305eeccd0c0ac02b8b95e3384..33bf11d8e7faeb95f23f6298193ccd868a298fa6 100644 (file)
 #include "PassManagerT.h"         // PassManagerT implementation
 #include "llvm/Module.h"
 #include "Support/STLExtras.h"
-#include "Support/CommandLine.h"
 #include "Support/TypeInfo.h"
-#include <typeinfo>
-#include <iostream>
-#include <sys/time.h>
 #include <stdio.h>
+#include <sys/resource.h>
+#include <sys/unistd.h>
+#include <set>
+
+// IncludeFile - Stub function used to help linking out.
+IncludeFile::IncludeFile(void*) {}
 
 //===----------------------------------------------------------------------===//
 //   AnalysisID Class Implementation
 //
 
-static std::vector<AnalysisID> CFGOnlyAnalyses;
-#if 0
-// Source of unique analysis ID #'s.
-unsigned AnalysisID::NextID = 0;
+static std::vector<const PassInfo*> CFGOnlyAnalyses;
 
-AnalysisID::AnalysisID(const AnalysisID &AID, bool DependsOnlyOnCFG) {
-  ID = AID.ID;                    // Implement the copy ctor part...
-  Constructor = AID.Constructor;
-  
-  // If this analysis only depends on the CFG of the function, add it to the CFG
-  // only list...
-  if (DependsOnlyOnCFG)
-    CFGOnlyAnalyses.push_back(AID);
+void RegisterPassBase::setPreservesCFG() {
+  CFGOnlyAnalyses.push_back(PIObj);
 }
-#endif
 
 //===----------------------------------------------------------------------===//
 //   AnalysisResolver Class Implementation
@@ -87,12 +79,84 @@ static cl::opt<bool>
 EnableTiming("time-passes",
             cl::desc("Time each pass, printing elapsed time for each on exit"));
 
-static double getTime() {
+static TimeRecord getTimeRecord() {
+  static unsigned long PageSize = 0;
+
+  if (PageSize == 0) {
+#ifdef _SC_PAGE_SIZE
+    PageSize = sysconf(_SC_PAGE_SIZE);
+#else
+#ifdef _SC_PAGESIZE
+    PageSize = sysconf(_SC_PAGESIZE);
+#else
+    PageSize = getpagesize();
+#endif
+#endif
+  }
+
+  struct rusage RU;
   struct timeval T;
   gettimeofday(&T, 0);
-  return T.tv_sec + T.tv_usec/1000000.0;
+  if (getrusage(RUSAGE_SELF, &RU)) {
+    perror("getrusage call failed: -time-passes info incorrect!");
+  }
+
+  TimeRecord Result;
+  Result.Elapsed    =           T.tv_sec +           T.tv_usec/1000000.0;
+  Result.UserTime   = RU.ru_utime.tv_sec + RU.ru_utime.tv_usec/1000000.0;
+  Result.SystemTime = RU.ru_stime.tv_sec + RU.ru_stime.tv_usec/1000000.0;
+  Result.MaxRSS = RU.ru_maxrss*PageSize;
+
+  return Result;
+}
+
+bool TimeRecord::operator<(const TimeRecord &TR) const {
+  // Primary sort key is User+System time
+  if (UserTime+SystemTime < TR.UserTime+TR.SystemTime)
+    return true;
+  if (UserTime+SystemTime > TR.UserTime+TR.SystemTime)
+    return false;
+
+  // Secondary sort key is Wall Time
+  return Elapsed < TR.Elapsed;
+}
+
+void TimeRecord::passStart(const TimeRecord &T) {
+  Elapsed    -= T.Elapsed;
+  UserTime   -= T.UserTime;
+  SystemTime -= T.SystemTime;
+  RSSTemp     = T.MaxRSS;
+}
+
+void TimeRecord::passEnd(const TimeRecord &T) {
+  Elapsed    += T.Elapsed;
+  UserTime   += T.UserTime;
+  SystemTime += T.SystemTime;
+  RSSTemp     = T.MaxRSS - RSSTemp;
+  MaxRSS      = std::max(MaxRSS, RSSTemp);
+}
+
+static void printVal(double Val, double Total) {
+  if (Total < 1e-7)   // Avoid dividing by zero...
+    fprintf(stderr, "        -----     ");
+  else
+    fprintf(stderr, "  %7.4f (%5.1f%%)", Val, Val*100/Total);
+}
+
+void TimeRecord::print(const char *PassName, const TimeRecord &Total) const {
+  printVal(UserTime, Total.UserTime);
+  printVal(SystemTime, Total.SystemTime);
+  printVal(UserTime+SystemTime, Total.UserTime+Total.SystemTime);
+  printVal(Elapsed, Total.Elapsed);
+  
+  fprintf(stderr, "  ");
+
+  if (Total.MaxRSS)
+    std::cerr << MaxRSS << "\t";
+  std::cerr << PassName << "\n";
 }
 
+
 // Create method.  If Timing is enabled, this creates and returns a new timing
 // object, otherwise it returns null.
 //
@@ -100,69 +164,70 @@ TimingInfo *TimingInfo::create() {
   return EnableTiming ? new TimingInfo() : 0;
 }
 
-void TimingInfo::passStarted(Pass *P) { TimingData[P] -= getTime(); }
-void TimingInfo::passEnded(Pass *P) { TimingData[P] += getTime(); }
+void TimingInfo::passStarted(Pass *P) {
+  TimingData[P].passStart(getTimeRecord());
+}
+void TimingInfo::passEnded(Pass *P) {
+  TimingData[P].passEnd(getTimeRecord());
+}
+void TimeRecord::sum(const TimeRecord &TR) {
+  Elapsed    += TR.Elapsed;
+  UserTime   += TR.UserTime;
+  SystemTime += TR.SystemTime;
+  MaxRSS     += TR.MaxRSS;
+}
 
 // TimingDtor - Print out information about timing information
 TimingInfo::~TimingInfo() {
   // Iterate over all of the data, converting it into the dual of the data map,
   // so that the data is sorted by amount of time taken, instead of pointer.
   //
-  std::vector<std::pair<double, Pass*> > Data;
-  double TotalTime = 0;
-  for (std::map<Pass*, double>::iterator I = TimingData.begin(),
+  std::vector<std::pair<TimeRecord, Pass*> > Data;
+  TimeRecord Total;
+  for (std::map<Pass*, TimeRecord>::iterator I = TimingData.begin(),
          E = TimingData.end(); I != E; ++I)
     // Throw out results for "grouping" pass managers...
     if (!dynamic_cast<AnalysisResolver*>(I->first)) {
       Data.push_back(std::make_pair(I->second, I->first));
-      TotalTime += I->second;
+      Total.sum(I->second);
     }
   
   // Sort the data by time as the primary key, in reverse order...
-  std::sort(Data.begin(), Data.end(), std::greater<std::pair<double, Pass*> >());
+  std::sort(Data.begin(), Data.end(),
+            std::greater<std::pair<TimeRecord, Pass*> >());
 
   // Print out timing header...
   std::cerr << std::string(79, '=') << "\n"
-       << "                      ... Pass execution timing report ...\n"
-       << std::string(79, '=') << "\n  Total Execution Time: " << TotalTime
-       << " seconds\n\n  % Time: Seconds:\tPass Name:\n";
+            << "                      ... Pass execution timing report ...\n"
+            << std::string(79, '=') << "\n  Total Execution Time: "
+            << (Total.UserTime+Total.SystemTime) << " seconds ("
+            << Total.Elapsed << " wall clock)\n\n   ---User Time---   "
+            << "--System Time--   --User+System--   ---Wall Time---";
 
-  // Loop through all of the timing data, printing it out...
-  for (unsigned i = 0, e = Data.size(); i != e; ++i) {
-    fprintf(stderr, "  %6.2f%% %fs\t%s\n", Data[i].first*100 / TotalTime,
-            Data[i].first, Data[i].second->getPassName());
-  }
-  std::cerr << "  100.00% " << TotalTime << "s\tTOTAL\n"
-       << std::string(79, '=') << "\n";
-}
+  if (Total.MaxRSS)
+    std::cerr << " ---Mem---";
+  std::cerr << "  --- Pass Name ---\n";
 
+  // Loop through all of the timing data, printing it out...
+  for (unsigned i = 0, e = Data.size(); i != e; ++i)
+    Data[i].first.print(Data[i].second->getPassName(), Total);
 
-//===----------------------------------------------------------------------===//
-// 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.
-//
+  Total.print("TOTAL", Total);
+}
 
-// Different debug levels that can be enabled...
-enum PassDebugLevel {
-  None, 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"),
-  // TODO: add option to print out pass names "PassOptions"
-  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));
+void PMDebug::PrintArgumentInformation(const Pass *P) {
+  // Print out passes in pass manager...
+  if (const AnalysisResolver *PM = dynamic_cast<const AnalysisResolver*>(P)) {
+    for (unsigned i = 0, e = PM->getNumContainedPasses(); i != e; ++i)
+      PrintArgumentInformation(PM->getContainedPass(i));
 
-void PMDebug::PrintPassStructure(Pass *P) {
-  if (PassDebugging >= Structure)
-    P->dumpPassStructure();
+  } else {  // Normal pass.  Print argument information...
+    // Print out arguments for registered passes that are _optimizations_
+    if (const PassInfo *PI = P->getPassInfo())
+      if (PI->getPassType() & PassInfo::Optimization)
+        std::cerr << " -" << PI->getPassArgument();
+  }
 }
 
 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
@@ -190,22 +255,12 @@ void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
                                    Pass *P, const std::vector<AnalysisID> &Set){
   if (PassDebugging >= Details && !Set.empty()) {
     std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
-    for (unsigned i = 0; i != Set.size(); ++i) {
-      // FIXME: This can use the local pass map!
-      Pass *P = Set[i]->createPass();   // Good thing this is just debug code...
-      std::cerr << "  " << P->getPassName();
-      delete P;
-    }
+    for (unsigned i = 0; i != Set.size(); ++i)
+      std::cerr << "  " << Set[i]->getPassName();
     std::cerr << "\n";
   }
 }
 
-// dumpPassStructure - Implement the -debug-passes=Structure option
-void Pass::dumpPassStructure(unsigned Offset) {
-  std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
-}
-
-
 //===----------------------------------------------------------------------===//
 // Pass Implementation
 //
@@ -214,6 +269,10 @@ void Pass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
   PM->addPass(this, AU);
 }
 
+// dumpPassStructure - Implement the -debug-passes=Structure option
+void Pass::dumpPassStructure(unsigned Offset) {
+  std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
+}
 
 // getPassName - Use C++ RTTI to get a SOMEWHAT intelligable name for the pass.
 //
@@ -315,8 +374,12 @@ static std::vector<PassRegistrationListener*> *Listeners = 0;
 // pass...
 const PassInfo *Pass::getPassInfo() const {
   if (PassInfoCache) return PassInfoCache;
+  return lookupPassInfo(typeid(*this));
+}
+
+const PassInfo *Pass::lookupPassInfo(const std::type_info &TI) {
   if (PassInfoMap == 0) return 0;
-  std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->find(typeid(*this));
+  std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->find(TI);
   return (I != PassInfoMap->end()) ? I->second : 0;
 }
 
@@ -336,10 +399,10 @@ void RegisterPassBase::registerPass(PassInfo *PI) {
       (*I)->passRegistered(PI);
 }
 
-RegisterPassBase::~RegisterPassBase() {
+void RegisterPassBase::unregisterPass(PassInfo *PI) {
   assert(PassInfoMap && "Pass registered but not in map!");
   std::map<TypeInfo, PassInfo*>::iterator I =
-    PassInfoMap->find(PIObj->getTypeInfo());
+    PassInfoMap->find(PI->getTypeInfo());
   assert(I != PassInfoMap->end() && "Pass registered but not in map!");
 
   // Remove pass from the map...
@@ -353,12 +416,124 @@ RegisterPassBase::~RegisterPassBase() {
   if (Listeners)
     for (std::vector<PassRegistrationListener*>::iterator
            I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
-      (*I)->passUnregistered(PIObj);
+      (*I)->passUnregistered(PI);
 
   // Delete the PassInfo object itself...
-  delete PIObj;
+  delete PI;
+}
+
+//===----------------------------------------------------------------------===//
+//                  Analysis Group Implementation Code
+//===----------------------------------------------------------------------===//
+
+struct AnalysisGroupInfo {
+  const PassInfo *DefaultImpl;
+  std::set<const PassInfo *> Implementations;
+  AnalysisGroupInfo() : DefaultImpl(0) {}
+};
+
+static std::map<const PassInfo *, AnalysisGroupInfo> *AnalysisGroupInfoMap = 0;
+
+// RegisterAGBase implementation
+//
+RegisterAGBase::RegisterAGBase(const std::type_info &Interface,
+                               const std::type_info *Pass, bool isDefault)
+  : ImplementationInfo(0), isDefaultImplementation(isDefault) {
+
+  InterfaceInfo = const_cast<PassInfo*>(Pass::lookupPassInfo(Interface));
+  if (InterfaceInfo == 0) {   // First reference to Interface, add it now.
+    InterfaceInfo =   // Create the new PassInfo for the interface...
+      new PassInfo("", "", Interface, PassInfo::AnalysisGroup, 0, 0);
+    registerPass(InterfaceInfo);
+    PIObj = 0;
+  }
+  assert(InterfaceInfo->getPassType() == PassInfo::AnalysisGroup &&
+         "Trying to join an analysis group that is a normal pass!");
+
+  if (Pass) {
+    ImplementationInfo = Pass::lookupPassInfo(*Pass);
+    assert(ImplementationInfo &&
+           "Must register pass before adding to AnalysisGroup!");
+
+    // Lazily allocate to avoid nasty initialization order dependencies
+    if (AnalysisGroupInfoMap == 0)
+      AnalysisGroupInfoMap = new std::map<const PassInfo *,AnalysisGroupInfo>();
+
+    AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
+    assert(AGI.Implementations.count(ImplementationInfo) == 0 &&
+           "Cannot add a pass to the same analysis group more than once!");
+    AGI.Implementations.insert(ImplementationInfo);
+    if (isDefault) {
+      assert(AGI.DefaultImpl == 0 && InterfaceInfo->getNormalCtor() == 0 &&
+             "Default implementation for analysis group already specified!");
+      assert(ImplementationInfo->getNormalCtor() &&
+           "Cannot specify pass as default if it does not have a default ctor");
+      AGI.DefaultImpl = ImplementationInfo;
+      InterfaceInfo->setNormalCtor(ImplementationInfo->getNormalCtor());
+    }
+  }
+}
+
+void RegisterAGBase::setGroupName(const char *Name) {
+  assert(InterfaceInfo->getPassName()[0] == 0 && "Interface Name already set!");
+  InterfaceInfo->setPassName(Name);
 }
 
+RegisterAGBase::~RegisterAGBase() {
+  if (ImplementationInfo) {
+    assert(AnalysisGroupInfoMap && "Inserted into map, but map doesn't exist?");
+    AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
+
+    assert(AGI.Implementations.count(ImplementationInfo) &&
+           "Pass not a member of analysis group?");
+
+    if (AGI.DefaultImpl == ImplementationInfo)
+      AGI.DefaultImpl = 0;
+    
+    AGI.Implementations.erase(ImplementationInfo);
+
+    // Last member of this analysis group? Unregister PassInfo, delete map entry
+    if (AGI.Implementations.empty()) {
+      assert(AGI.DefaultImpl == 0 &&
+             "Default implementation didn't unregister?");
+      AnalysisGroupInfoMap->erase(InterfaceInfo);
+      if (AnalysisGroupInfoMap->empty()) {  // Delete map if empty
+        delete AnalysisGroupInfoMap;
+        AnalysisGroupInfoMap = 0;
+      }
+
+      unregisterPass(InterfaceInfo);
+    }
+  }
+}
+
+
+// findAnalysisGroupMember - Return an iterator pointing to one of the elements
+// of Map if there is a pass in Map that is a member of the analysis group for
+// the specified AnalysisGroupID.
+//
+static std::map<const PassInfo*, Pass*>::const_iterator
+findAnalysisGroupMember(const PassInfo *AnalysisGroupID,
+                        const std::map<const PassInfo*, Pass*> &Map) {
+  assert(AnalysisGroupID->getPassType() == PassInfo::AnalysisGroup &&
+         "AnalysisGroupID is not an analysis group!");
+  assert(AnalysisGroupInfoMap && AnalysisGroupInfoMap->count(AnalysisGroupID) &&
+         "Analysis Group does not have any registered members!");
+
+  // Get the set of all known implementations of this analysis group...
+  std::set<const PassInfo *> &Impls = 
+    (*AnalysisGroupInfoMap)[AnalysisGroupID].Implementations;
+
+  // Scan over available passes, checking to see if any is a valid analysis
+  for (std::map<const PassInfo*, Pass*>::const_iterator I = Map.begin(),
+         E = Map.end(); I != E; ++I)
+    if (Impls.count(I->first))  // This is a valid analysis, return it.
+      return I;
+
+  return Map.end();  // Nothing of use found.
+}
+
+
 
 
 //===----------------------------------------------------------------------===//