1 //===- llvm/PassManager.h - Container for Passes ----------------*- 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 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 class PassManagerImpl;
30 class FunctionPassManagerImpl;
32 /// PassManager manages ModulePassManagers
39 /// add - Add a pass to the queue of passes to run. This passes ownership of
40 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
41 /// will be destroyed as well, so there is no need to delete the pass. This
42 /// implies that all passes MUST be allocated with 'new'.
45 /// run - Execute all of the passes scheduled for execution. Keep track of
46 /// whether any of the passes modifies the module, and if so, return true.
51 /// PassManagerImpl_New is the actual class. PassManager is just the
52 /// wraper to publish simple pass manager interface
56 /// FunctionPassManager manages FunctionPasses and BasicBlockPassManagers.
57 class FunctionPassManager {
59 /// FunctionPassManager ctor - This initializes the pass manager. It needs,
60 /// but does not take ownership of, the specified module provider.
61 explicit FunctionPassManager(ModuleProvider *P);
62 ~FunctionPassManager();
64 /// add - Add a pass to the queue of passes to run. This passes
65 /// ownership of the Pass to the PassManager. When the
66 /// PassManager_X is destroyed, the pass will be destroyed as well, so
67 /// there is no need to delete the pass. (TODO delete passes.)
68 /// This implies that all passes MUST be allocated with 'new'.
71 /// run - Execute all of the passes scheduled for execution. Keep
72 /// track of whether any of the passes modifies the function, and if
75 bool run(Function &F);
77 /// doInitialization - Run all of the initializers for the function passes.
79 bool doInitialization();
81 /// doFinalization - Run all of the finalizers for the function passes.
83 bool doFinalization();
86 FunctionPassManagerImpl *FPM;
90 } // End llvm namespace