lib/VMCore/PassRegistry.cpp

   1 //===- PassRegistry.cpp - Pass Registration 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 PassRegistry, with which passes are registered on
  11 // initialization, and supports the PassManager in dependency resolution.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/PassRegistry.h"
  16 #include "llvm/PassSupport.h"
  17 #include "llvm/Support/Compiler.h"
  18 #include "llvm/Support/ManagedStatic.h"
  19 #include "llvm/ADT/DenseMap.h"
  20 #include "llvm/ADT/SmallPtrSet.h"
  21 #include "llvm/ADT/StringMap.h"
  22 #include <vector>
  23
  24 using namespace llvm;
  25
  26 // FIXME: We use ManagedStatic to erase the pass registrar on shutdown.
  27 // Unfortunately, passes are registered with static ctors, and having
  28 // llvm_shutdown clear this map prevents successful ressurection after
  29 // llvm_shutdown is run.  Ideally we should find a solution so that we don't
  30 // leak the map, AND can still resurrect after shutdown.
  31 static ManagedStatic<PassRegistry> PassRegistryObj;
  32 PassRegistry *PassRegistry::getPassRegistry() {
  33   return &*PassRegistryObj;
  34 }
  35
  36 //===----------------------------------------------------------------------===//
  37 // PassRegistryImpl
  38 //
  39
  40 struct PassRegistryImpl {
  41   /// PassInfoMap - Keep track of the PassInfo object for each registered pass.
  42   typedef DenseMap<const void*, const PassInfo*> MapType;
  43   MapType PassInfoMap;
  44
  45   typedef StringMap<const PassInfo*> StringMapType;
  46   StringMapType PassInfoStringMap;
  47
  48   /// AnalysisGroupInfo - Keep track of information for each analysis group.
  49   struct AnalysisGroupInfo {
  50     SmallPtrSet<const PassInfo *, 8> Implementations;
  51   };
  52   DenseMap<const PassInfo*, AnalysisGroupInfo> AnalysisGroupInfoMap;
  53
  54   std::vector<PassRegistrationListener*> Listeners;
  55 };
  56
  57 void *PassRegistry::getImpl() const {
  58   if (!pImpl)
  59     pImpl = new PassRegistryImpl();
  60   return pImpl;
  61 }
  62
  63 //===----------------------------------------------------------------------===//
  64 // Accessors
  65 //
  66
  67 PassRegistry::~PassRegistry() {
  68   PassRegistryImpl *Impl = static_cast<PassRegistryImpl*>(pImpl);
  69   if (Impl) delete Impl;
  70   pImpl = 0;
  71 }
  72
  73 const PassInfo *PassRegistry::getPassInfo(const void *TI) const {
  74   PassRegistryImpl *Impl = static_cast<PassRegistryImpl*>(getImpl());
  75   PassRegistryImpl::MapType::const_iterator I = Impl->PassInfoMap.find(TI);
  76   return I != Impl->PassInfoMap.end() ? I->second : 0;
  77 }
  78
  79 const PassInfo *PassRegistry::getPassInfo(StringRef Arg) const {
  80   PassRegistryImpl *Impl = static_cast<PassRegistryImpl*>(getImpl());
  81   PassRegistryImpl::StringMapType::const_iterator
  82     I = Impl->PassInfoStringMap.find(Arg);
  83   return I != Impl->PassInfoStringMap.end() ? I->second : 0;
  84 }
  85
  86 //===----------------------------------------------------------------------===//
  87 // Pass Registration mechanism
  88 //
  89
  90 void PassRegistry::registerPass(const PassInfo &PI) {
  91   PassRegistryImpl *Impl = static_cast<PassRegistryImpl*>(getImpl());
  92   bool Inserted =
  93     Impl->PassInfoMap.insert(std::make_pair(PI.getTypeInfo(),&PI)).second;
  94   assert(Inserted && "Pass registered multiple times!"); Inserted=Inserted;
  95   Impl->PassInfoStringMap[PI.getPassArgument()] = &PI;
  96
  97   // Notify any listeners.
  98   for (std::vector<PassRegistrationListener*>::iterator
  99        I = Impl->Listeners.begin(), E = Impl->Listeners.end(); I != E; ++I)
 100     (*I)->passRegistered(&PI);
 101 }
 102
 103 void PassRegistry::unregisterPass(const PassInfo &PI) {
 104   PassRegistryImpl *Impl = static_cast<PassRegistryImpl*>(getImpl());
 105   PassRegistryImpl::MapType::iterator I =
 106     Impl->PassInfoMap.find(PI.getTypeInfo());
 107   assert(I != Impl->PassInfoMap.end() && "Pass registered but not in map!");
 108
 109   // Remove pass from the map.
 110   Impl->PassInfoMap.erase(I);
 111   Impl->PassInfoStringMap.erase(PI.getPassArgument());
 112 }
 113
 114 void PassRegistry::enumerateWith(PassRegistrationListener *L) {
 115   PassRegistryImpl *Impl = static_cast<PassRegistryImpl*>(getImpl());
 116   for (PassRegistryImpl::MapType::const_iterator I = Impl->PassInfoMap.begin(),
 117        E = Impl->PassInfoMap.end(); I != E; ++I)
 118     L->passEnumerate(I->second);
 119 }
 120
 121
 122 /// Analysis Group Mechanisms.
 123 void PassRegistry::registerAnalysisGroup(const void *InterfaceID,
 124                                          const void *PassID,
 125                                          PassInfo& Registeree,
 126                                          bool isDefault) {
 127   PassInfo *InterfaceInfo =  const_cast<PassInfo*>(getPassInfo(InterfaceID));
 128   if (InterfaceInfo == 0) {
 129     // First reference to Interface, register it now.
 130     registerPass(Registeree);
 131     InterfaceInfo = &Registeree;
 132   }
 133   assert(Registeree.isAnalysisGroup() &&
 134          "Trying to join an analysis group that is a normal pass!");
 135
 136   if (PassID) {
 137     PassInfo *ImplementationInfo = const_cast<PassInfo*>(getPassInfo(PassID));
 138     assert(ImplementationInfo &&
 139            "Must register pass before adding to AnalysisGroup!");
 140
 141     // Make sure we keep track of the fact that the implementation implements
 142     // the interface.
 143     ImplementationInfo->addInterfaceImplemented(InterfaceInfo);
 144
 145     PassRegistryImpl *Impl = static_cast<PassRegistryImpl*>(getImpl());
 146     PassRegistryImpl::AnalysisGroupInfo &AGI =
 147       Impl->AnalysisGroupInfoMap[InterfaceInfo];
 148     assert(AGI.Implementations.count(ImplementationInfo) == 0 &&
 149            "Cannot add a pass to the same analysis group more than once!");
 150     AGI.Implementations.insert(ImplementationInfo);
 151     if (isDefault) {
 152       assert(InterfaceInfo->getNormalCtor() == 0 &&
 153              "Default implementation for analysis group already specified!");
 154       assert(ImplementationInfo->getNormalCtor() &&
 155            "Cannot specify pass as default if it does not have a default ctor");
 156       InterfaceInfo->setNormalCtor(ImplementationInfo->getNormalCtor());
 157     }
 158   }
 159 }
 160
 161 void PassRegistry::addRegistrationListener(PassRegistrationListener *L) {
 162   PassRegistryImpl *Impl = static_cast<PassRegistryImpl*>(getImpl());
 163   Impl->Listeners.push_back(L);
 164 }
 165
 166 void PassRegistry::removeRegistrationListener(PassRegistrationListener *L) {
 167   // NOTE: This is necessary, because removeRegistrationListener() can be called
 168   // as part of the llvm_shutdown sequence.  Since we have no control over the
 169   // order of that sequence, we need to gracefully handle the case where the
 170   // PassRegistry is destructed before the object that triggers this call.
 171   if (!pImpl) return;
 172
 173   PassRegistryImpl *Impl = static_cast<PassRegistryImpl*>(getImpl());
 174   std::vector<PassRegistrationListener*>::iterator I =
 175     std::find(Impl->Listeners.begin(), Impl->Listeners.end(), L);
 176   assert(I != Impl->Listeners.end() &&
 177          "PassRegistrationListener not registered!");
 178   Impl->Listeners.erase(I);
 179 }