1 | //===- llvm/PassRegistry.h - Pass Information Registry ----------*- C++ -*-===// |
2 | // |
3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
4 | // See https://llvm.org/LICENSE.txt for license information. |
5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
6 | // |
7 | //===----------------------------------------------------------------------===// |
8 | // |
9 | // This file defines PassRegistry, a class that is used in the initialization |
10 | // and registration of passes. At application startup, passes are registered |
11 | // with the PassRegistry, which is later provided to the PassManager for |
12 | // dependency resolution and similar tasks. |
13 | // |
14 | //===----------------------------------------------------------------------===// |
15 | |
16 | #ifndef LLVM_PASSREGISTRY_H |
17 | #define LLVM_PASSREGISTRY_H |
18 | |
19 | #include "llvm/ADT/DenseMap.h" |
20 | #include "llvm/ADT/StringMap.h" |
21 | #include "llvm/ADT/StringRef.h" |
22 | #include "llvm/Support/RWMutex.h" |
23 | #include <memory> |
24 | #include <vector> |
25 | |
26 | namespace llvm { |
27 | |
28 | class PassInfo; |
29 | struct PassRegistrationListener; |
30 | |
31 | /// PassRegistry - This class manages the registration and intitialization of |
32 | /// the pass subsystem as application startup, and assists the PassManager |
33 | /// in resolving pass dependencies. |
34 | /// NOTE: PassRegistry is NOT thread-safe. If you want to use LLVM on multiple |
35 | /// threads simultaneously, you will need to use a separate PassRegistry on |
36 | /// each thread. |
37 | class PassRegistry { |
38 | mutable sys::SmartRWMutex<true> Lock; |
39 | |
40 | /// PassInfoMap - Keep track of the PassInfo object for each registered pass. |
41 | using MapType = DenseMap<const void *, const PassInfo *>; |
42 | MapType PassInfoMap; |
43 | |
44 | using StringMapType = StringMap<const PassInfo *>; |
45 | StringMapType PassInfoStringMap; |
46 | |
47 | std::vector<std::unique_ptr<const PassInfo>> ToFree; |
48 | std::vector<PassRegistrationListener *> Listeners; |
49 | |
50 | public: |
51 | PassRegistry() = default; |
52 | ~PassRegistry(); |
53 | |
54 | /// getPassRegistry - Access the global registry object, which is |
55 | /// automatically initialized at application launch and destroyed by |
56 | /// llvm_shutdown. |
57 | static PassRegistry *getPassRegistry(); |
58 | |
59 | /// getPassInfo - Look up a pass' corresponding PassInfo, indexed by the pass' |
60 | /// type identifier (&MyPass::ID). |
61 | const PassInfo *getPassInfo(const void *TI) const; |
62 | |
63 | /// getPassInfo - Look up a pass' corresponding PassInfo, indexed by the pass' |
64 | /// argument string. |
65 | const PassInfo *getPassInfo(StringRef Arg) const; |
66 | |
67 | /// registerPass - Register a pass (by means of its PassInfo) with the |
68 | /// registry. Required in order to use the pass with a PassManager. |
69 | void registerPass(const PassInfo &PI, bool ShouldFree = false); |
70 | |
71 | /// registerAnalysisGroup - Register an analysis group (or a pass implementing |
72 | // an analysis group) with the registry. Like registerPass, this is required |
73 | // in order for a PassManager to be able to use this group/pass. |
74 | void registerAnalysisGroup(const void *InterfaceID, const void *PassID, |
75 | PassInfo &Registeree, bool isDefault, |
76 | bool ShouldFree = false); |
77 | |
78 | /// enumerateWith - Enumerate the registered passes, calling the provided |
79 | /// PassRegistrationListener's passEnumerate() callback on each of them. |
80 | void enumerateWith(PassRegistrationListener *L); |
81 | |
82 | /// addRegistrationListener - Register the given PassRegistrationListener |
83 | /// to receive passRegistered() callbacks whenever a new pass is registered. |
84 | void addRegistrationListener(PassRegistrationListener *L); |
85 | |
86 | /// removeRegistrationListener - Unregister a PassRegistrationListener so that |
87 | /// it no longer receives passRegistered() callbacks. |
88 | void removeRegistrationListener(PassRegistrationListener *L); |
89 | }; |
90 | |
91 | } // end namespace llvm |
92 | |
93 | #endif // LLVM_PASSREGISTRY_H |
94 | |