1 //===- llvm/PassRegistry.h - Pass Information Registry ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_PASSREGISTRY_H
18 #define LLVM_PASSREGISTRY_H
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"
33 struct PassRegistrationListener;
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
42 mutable sys::SmartRWMutex<true> Lock;
44 /// Only if false, synchronization must use the Lock mutex.
45 std::atomic<bool> locked;
47 /// PassInfoMap - Keep track of the PassInfo object for each registered pass.
48 typedef DenseMap<const void *, const PassInfo *> MapType;
51 typedef StringMap<const PassInfo *> StringMapType;
52 StringMapType PassInfoStringMap;
54 std::vector<std::unique_ptr<const PassInfo>> ToFree;
55 std::vector<PassRegistrationListener *> Listeners;
58 PassRegistry() : locked(false) {}
61 /// getPassRegistry - Access the global registry object, which is
62 /// automatically initialized at application launch and destroyed by
64 static PassRegistry *getPassRegistry();
66 /// Enables fast thread synchronization in getPassInfo().
67 /// After calling lock() no more passes may be registered.
68 void lock() { locked = true; }
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;
74 /// getPassInfo - Look up a pass' corresponding PassInfo, indexed by the pass'
76 const PassInfo *getPassInfo(StringRef Arg) const;
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);
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);
89 /// enumerateWith - Enumerate the registered passes, calling the provided
90 /// PassRegistrationListener's passEnumerate() callback on each of them.
91 void enumerateWith(PassRegistrationListener *L);
93 /// addRegistrationListener - Register the given PassRegistrationListener
94 /// to receive passRegistered() callbacks whenever a new pass is registered.
95 void addRegistrationListener(PassRegistrationListener *L);
97 /// removeRegistrationListener - Unregister a PassRegistrationListener so that
98 /// it no longer receives passRegistered() callbacks.
99 void removeRegistrationListener(PassRegistrationListener *L);
102 // Create wrappers for C Binding types (see CBindingWrapping.h).
103 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassRegistry, LLVMPassRegistryRef)