include/llvm/PassRegistry.h

   1 //===- llvm/PassRegistry.h - Pass Information Registry ----------*- C++ -*-===//
   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 defines PassRegistry, a class that is used in the initialization
  11 // and registration of passes.  At application startup, passes are registered
  12 // with the PassRegistry, which is later provided to the PassManager for
  13 // dependency resolution and similar tasks.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_PASSREGISTRY_H
  18 #define LLVM_PASSREGISTRY_H
  19
  20 #include "llvm-c/Core.h"
  21 #include "llvm/ADT/DenseMap.h"
  22 #include "llvm/ADT/SmallPtrSet.h"
  23 #include "llvm/ADT/StringMap.h"
  24 #include "llvm/ADT/StringRef.h"
  25 #include "llvm/PassInfo.h"
  26 #include "llvm/Support/CBindingWrapping.h"
  27 #include "llvm/Support/RWMutex.h"
  28 #include <vector>
  29
  30 namespace llvm {
  31
  32 class PassInfo;
  33 struct PassRegistrationListener;
  34
  35 /// PassRegistry - This class manages the registration and intitialization of
  36 /// the pass subsystem as application startup, and assists the PassManager
  37 /// in resolving pass dependencies.
  38 /// NOTE: PassRegistry is NOT thread-safe.  If you want to use LLVM on multiple
  39 /// threads simultaneously, you will need to use a separate PassRegistry on
  40 /// each thread.
  41 class PassRegistry {
  42   mutable sys::SmartRWMutex<true> Lock;
  43
  44   /// Only if false, synchronization must use the Lock mutex.
  45   std::atomic<bool> locked;
  46
  47   /// PassInfoMap - Keep track of the PassInfo object for each registered pass.
  48   typedef DenseMap<const void *, const PassInfo *> MapType;
  49   MapType PassInfoMap;
  50
  51   typedef StringMap<const PassInfo *> StringMapType;
  52   StringMapType PassInfoStringMap;
  53
  54   std::vector<std::unique_ptr<const PassInfo>> ToFree;
  55   std::vector<PassRegistrationListener *> Listeners;
  56
  57 public:
  58   PassRegistry() : locked(false) {}
  59   ~PassRegistry();
  60
  61   /// getPassRegistry - Access the global registry object, which is
  62   /// automatically initialized at application launch and destroyed by
  63   /// llvm_shutdown.
  64   static PassRegistry *getPassRegistry();
  65
  66   /// Enables fast thread synchronization in getPassInfo().
  67   /// After calling lock() no more passes may be registered.
  68   void lock() { locked = true; }
  69
  70   /// getPassInfo - Look up a pass' corresponding PassInfo, indexed by the pass'
  71   /// type identifier (&MyPass::ID).
  72   const PassInfo *getPassInfo(const void *TI) const;
  73
  74   /// getPassInfo - Look up a pass' corresponding PassInfo, indexed by the pass'
  75   /// argument string.
  76   const PassInfo *getPassInfo(StringRef Arg) const;
  77
  78   /// registerPass - Register a pass (by means of its PassInfo) with the
  79   /// registry.  Required in order to use the pass with a PassManager.
  80   void registerPass(const PassInfo &PI, bool ShouldFree = false);
  81
  82   /// registerAnalysisGroup - Register an analysis group (or a pass implementing
  83   // an analysis group) with the registry.  Like registerPass, this is required
  84   // in order for a PassManager to be able to use this group/pass.
  85   void registerAnalysisGroup(const void *InterfaceID, const void *PassID,
  86                              PassInfo &Registeree, bool isDefault,
  87                              bool ShouldFree = false);
  88
  89   /// enumerateWith - Enumerate the registered passes, calling the provided
  90   /// PassRegistrationListener's passEnumerate() callback on each of them.
  91   void enumerateWith(PassRegistrationListener *L);
  92
  93   /// addRegistrationListener - Register the given PassRegistrationListener
  94   /// to receive passRegistered() callbacks whenever a new pass is registered.
  95   void addRegistrationListener(PassRegistrationListener *L);
  96
  97   /// removeRegistrationListener - Unregister a PassRegistrationListener so that
  98   /// it no longer receives passRegistered() callbacks.
  99   void removeRegistrationListener(PassRegistrationListener *L);
 100 };
 101
 102 // Create wrappers for C Binding types (see CBindingWrapping.h).
 103 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef)
 104
 105 }
 106
 107 #endif