1//===- LegacyPassManager.h - Legacy Container for Passes --------*- 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 the legacy 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.
14//
15//===----------------------------------------------------------------------===//
16
17#ifndef LLVM_IR_LEGACYPASSMANAGER_H
18#define LLVM_IR_LEGACYPASSMANAGER_H
19
20#include "llvm/Pass.h"
21#include "llvm/Support/CBindingWrapping.h"
22
23namespace llvm {
24
25class Pass;
26class Module;
27
28namespace legacy {
29
30class PassManagerImpl;
31class FunctionPassManagerImpl;
32
33/// PassManagerBase - An abstract interface to allow code to add passes to
34/// a pass manager without having to hard-code what kind of pass manager
35/// it is.
36class PassManagerBase {
37public:
38  virtual ~PassManagerBase();
39
40  /// add - Add a pass to the queue of passes to run.  This passes ownership of
41  /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
42  /// will be destroyed as well, so there is no need to delete the pass.  This
43  /// implies that all passes MUST be allocated with 'new'.
44  virtual void add(Pass *P) = 0;
45};
46
47/// PassManager manages ModulePassManagers
48class PassManager : public PassManagerBase {
49public:
50
51  PassManager();
52  ~PassManager();
53
54  /// add - Add a pass to the queue of passes to run.  This passes ownership of
55  /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
56  /// will be destroyed as well, so there is no need to delete the pass.  This
57  /// implies that all passes MUST be allocated with 'new'.
58  void add(Pass *P) override;
59
60  /// run - Execute all of the passes scheduled for execution.  Keep track of
61  /// whether any of the passes modifies the module, and if so, return true.
62  bool run(Module &M);
63
64private:
65  /// PassManagerImpl_New is the actual class. PassManager is just the
66  /// wraper to publish simple pass manager interface
67  PassManagerImpl *PM;
68};
69
70/// FunctionPassManager manages FunctionPasses and BasicBlockPassManagers.
71class FunctionPassManager : public PassManagerBase {
72public:
73  /// FunctionPassManager ctor - This initializes the pass manager.  It needs,
74  /// but does not take ownership of, the specified Module.
75  explicit FunctionPassManager(Module *M);
76  ~FunctionPassManager();
77
78  /// add - Add a pass to the queue of passes to run.  This passes
79  /// ownership of the Pass to the PassManager.  When the
80  /// PassManager_X is destroyed, the pass will be destroyed as well, so
81  /// there is no need to delete the pass.
82  /// This implies that all passes MUST be allocated with 'new'.
83  void add(Pass *P) override;
84
85  /// run - Execute all of the passes scheduled for execution.  Keep
86  /// track of whether any of the passes modifies the function, and if
87  /// so, return true.
88  ///
89  bool run(Function &F);
90
91  /// doInitialization - Run all of the initializers for the function passes.
92  ///
93  bool doInitialization();
94
95  /// doFinalization - Run all of the finalizers for the function passes.
96  ///
97  bool doFinalization();
98
99private:
100  FunctionPassManagerImpl *FPM;
101  Module *M;
102};
103
104} // End legacy namespace
105
106// Create wrappers for C Binding types (see CBindingWrapping.h).
107DEFINE_STDCXX_CONVERSION_FUNCTIONS(legacy::PassManagerBase, LLVMPassManagerRef)
108
109} // End llvm namespace
110
111#endif
112