1 //===- llvm/PassManager.h - Container for Passes ----------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the PassManager class. This class is used to hold,
11 // maintain, and optimize execution of Passes. The PassManager class ensures
12 // that analysis results are available before a pass runs, and that Pass's are
13 // destroyed when the PassManager is destroyed.
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_PASSMANAGER_H
18 #define LLVM_PASSMANAGER_H
20 #include "llvm/Pass.h"
29 #ifdef USE_OLD_PASSMANAGER
31 class ModulePassManager;
32 class FunctionPassManagerT;
33 class BasicBlockPassManager;
36 ModulePassManager *PM; // This is a straightforward Pimpl class
41 /// add - Add a pass to the queue of passes to run. This passes ownership of
42 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
43 /// will be destroyed as well, so there is no need to delete the pass. This
44 /// implies that all passes MUST be allocated with 'new'.
48 /// run - Execute all of the passes scheduled for execution. Keep track of
49 /// whether any of the passes modifies the module, and if so, return true.
58 class FunctionPassManager {
59 FunctionPassManagerT *PM; // This is a straightforward Pimpl class
62 FunctionPassManager(ModuleProvider *P);
63 ~FunctionPassManager();
65 /// add - Add a pass to the queue of passes to run. This passes
66 /// ownership of the FunctionPass to the PassManager. When the
67 /// PassManager is destroyed, the pass will be destroyed as well, so
68 /// there is no need to delete the pass. This implies that all
69 /// passes MUST be allocated with 'new'.
71 void add(FunctionPass *P);
73 /// add - ImmutablePasses are not FunctionPasses, so we have a
74 /// special hack to get them into a FunctionPassManager.
76 void add(ImmutablePass *IP);
78 /// doInitialization - Run all of the initializers for the function passes.
80 bool doInitialization();
82 /// run - Execute all of the passes scheduled for execution. Keep
83 /// track of whether any of the passes modifies the function, and if
86 bool run(Function &F);
88 /// doFinalization - Run all of the initializers for the function passes.
90 bool doFinalization();
95 class ModulePassManager;
96 class PassManagerImpl_New;
97 class FunctionPassManagerImpl_New;
99 /// PassManager manages ModulePassManagers
107 /// add - Add a pass to the queue of passes to run. This passes ownership of
108 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
109 /// will be destroyed as well, so there is no need to delete the pass. This
110 /// implies that all passes MUST be allocated with 'new'.
113 /// run - Execute all of the passes scheduled for execution. Keep track of
114 /// whether any of the passes modifies the module, and if so, return true.
119 /// PassManagerImpl_New is the actual class. PassManager is just the
120 /// wraper to publish simple pass manager interface
121 PassManagerImpl_New *PM;
125 /// FunctionPassManager manages FunctionPasses and BasicBlockPassManagers.
126 class FunctionPassManager {
128 FunctionPassManager(ModuleProvider *P);
129 FunctionPassManager();
130 ~FunctionPassManager();
132 /// add - Add a pass to the queue of passes to run. This passes
133 /// ownership of the Pass to the PassManager. When the
134 /// PassManager_X is destroyed, the pass will be destroyed as well, so
135 /// there is no need to delete the pass. (TODO delete passes.)
136 /// This implies that all passes MUST be allocated with 'new'.
139 /// run - Execute all of the passes scheduled for execution. Keep
140 /// track of whether any of the passes modifies the function, and if
143 bool run(Function &F);
145 /// doInitialization - Run all of the initializers for the function passes.
147 bool doInitialization();
149 /// doFinalization - Run all of the initializers for the function passes.
151 bool doFinalization();
154 FunctionPassManagerImpl_New *FPM;
160 } // End llvm namespace