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/ADT/StringMap.h"
  21 #include "llvm/System/DataTypes.h"
  22
  23 namespace llvm {
  24
  25 class PassInfo;
  26 struct PassRegistrationListener;
  27
  28 /// PassRegistry - This class manages the registration and intitialization of
  29 /// the pass subsystem as application startup, and assists the PassManager
  30 /// in resolving pass dependencies.
  31 /// NOTE: PassRegistry is NOT thread-safe.  If you want to use LLVM on multiple
  32 /// threads simultaneously, you will need to use a separate PassRegistry on
  33 /// each thread.
  34 class PassRegistry {
  35   mutable void *pImpl;
  36   void *getImpl() const;
  37
  38 public:
  39   PassRegistry() : pImpl(0) { }
  40   ~PassRegistry();
  41
  42   /// getPassRegistry - Access the global registry object, which is
  43   /// automatically initialized at application launch and destroyed by
  44   /// llvm_shutdown.
  45   static PassRegistry *getPassRegistry();
  46
  47   /// getPassInfo - Look up a pass' corresponding PassInfo, indexed by the pass'
  48   /// type identifier (&MyPass::ID).
  49   const PassInfo *getPassInfo(const void *TI) const;
  50
  51   /// getPassInfo - Look up a pass' corresponding PassInfo, indexed by the pass'
  52   /// argument string.
  53   const PassInfo *getPassInfo(StringRef Arg) const;
  54
  55   /// registerPass - Register a pass (by means of its PassInfo) with the
  56   /// registry.  Required in order to use the pass with a PassManager.
  57   void registerPass(const PassInfo &PI);
  58
  59   /// registerPass - Unregister a pass (by means of its PassInfo) with the
  60   /// registry.
  61   void unregisterPass(const PassInfo &PI);
  62
  63   /// registerAnalysisGroup - Register an analysis group (or a pass implementing
  64   // an analysis group) with the registry.  Like registerPass, this is required
  65   // in order for a PassManager to be able to use this group/pass.
  66   void registerAnalysisGroup(const void *InterfaceID, const void *PassID,
  67                              PassInfo& Registeree, bool isDefault);
  68
  69   /// enumerateWith - Enumerate the registered passes, calling the provided
  70   /// PassRegistrationListener's passEnumerate() callback on each of them.
  71   void enumerateWith(PassRegistrationListener *L);
  72
  73   /// addRegistrationListener - Register the given PassRegistrationListener
  74   /// to receive passRegistered() callbacks whenever a new pass is registered.
  75   void addRegistrationListener(PassRegistrationListener *L);
  76
  77   /// removeRegistrationListener - Unregister a PassRegistrationListener so that
  78   /// it no longer receives passRegistered() callbacks.
  79   void removeRegistrationListener(PassRegistrationListener *L);
  80 };
  81
  82 }
  83
  84 #endif