e7590ac019b2aa944a715f488a4cdfb5e85ccd12
[oota-llvm.git] / include / llvm / Transforms / IPO.h
1 //===- llvm/Transforms/IPO.h - Interprocedural Transformations --*- 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 header file defines prototypes for accessor functions that expose passes
11 // in the IPO transformations library.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_TRANSFORMS_IPO_H
16 #define LLVM_TRANSFORMS_IPO_H
17
18 #include <vector>
19
20 namespace llvm {
21
22 class FunctionPass;
23 class ModulePass;
24 class Pass;
25 class Function;
26 class BasicBlock;
27
28 //===----------------------------------------------------------------------===//
29 //
30 // These functions removes symbols from functions and modules.  If OnlyDebugInfo
31 // is true, only debugging information is removed from the module.
32 //
33 ModulePass *createStripSymbolsPass(bool OnlyDebugInfo = false);
34
35 //===----------------------------------------------------------------------===//
36 /// createLowerSetJmpPass - This function lowers the setjmp/longjmp intrinsics
37 /// to invoke/unwind instructions.  This should really be part of the C/C++
38 /// front-end, but it's so much easier to write transformations in LLVM proper.
39 ///
40 ModulePass* createLowerSetJmpPass();
41
42 //===----------------------------------------------------------------------===//
43 /// createConstantMergePass - This function returns a new pass that merges
44 /// duplicate global constants together into a single constant that is shared.
45 /// This is useful because some passes (ie TraceValues) insert a lot of string
46 /// constants into the program, regardless of whether or not they duplicate an
47 /// existing string.
48 ///
49 ModulePass *createConstantMergePass();
50
51
52 //===----------------------------------------------------------------------===//
53 /// createGlobalOptimizerPass - This function returns a new pass that optimizes
54 /// non-address taken internal globals.
55 ///
56 ModulePass *createGlobalOptimizerPass();
57
58
59 //===----------------------------------------------------------------------===//
60 /// createRaiseAllocationsPass - Return a new pass that transforms malloc and
61 /// free function calls into malloc and free instructions.
62 ///
63 ModulePass *createRaiseAllocationsPass();
64
65
66 //===----------------------------------------------------------------------===//
67 /// createDeadTypeEliminationPass - Return a new pass that eliminates symbol
68 /// table entries for types that are never used.
69 ///
70 ModulePass *createDeadTypeEliminationPass();
71
72
73 //===----------------------------------------------------------------------===//
74 /// createGlobalDCEPass - This transform is designed to eliminate unreachable
75 /// internal globals (functions or global variables)
76 ///
77 ModulePass *createGlobalDCEPass();
78
79
80 //===----------------------------------------------------------------------===//
81 /// createFunctionExtractionPass - If deleteFn is true, this pass deletes as
82 /// the specified function. Otherwise, it deletes as much of the module as
83 /// possible, except for the function specified.
84 ///
85 ModulePass *createFunctionExtractionPass(Function *F, bool deleteFn = false,
86                                          bool relinkCallees = false);
87
88
89 //===----------------------------------------------------------------------===//
90 /// createFunctionInliningPass - Return a new pass object that uses a heuristic
91 /// to inline direct function calls to small functions.
92 ///
93 Pass *createFunctionInliningPass();
94 Pass *createFunctionInliningPass(int Threshold);
95
96 //===----------------------------------------------------------------------===//
97 /// createPruneEHPass - Return a new pass object which transforms invoke
98 /// instructions into calls, if the callee can _not_ unwind the stack.
99 ///
100 Pass *createPruneEHPass();
101
102 //===----------------------------------------------------------------------===//
103 /// createInternalizePass - This pass loops over all of the functions in the
104 /// input module, looking for a main function.  If a list of symbols is
105 /// specified with the -internalize-public-api-* command line options, those
106 /// symbols are internalized.  Otherwise if InternalizeEverything is set and
107 /// the main function is found, all other globals are marked as internal.
108 ///
109 ModulePass *createInternalizePass(bool InternalizeEverything);
110 ModulePass *createInternalizePass(const std::vector<const char *> &exportList);
111
112 //===----------------------------------------------------------------------===//
113 /// createDeadArgEliminationPass - This pass removes arguments from functions
114 /// which are not used by the body of the function.
115 ///
116 ModulePass *createDeadArgEliminationPass();
117
118 /// DeadArgHacking pass - Same as DAE, but delete arguments of external
119 /// functions as well.  This is definitely not safe, and should only be used by
120 /// bugpoint.
121 ModulePass *createDeadArgHackingPass();
122
123 //===----------------------------------------------------------------------===//
124 /// createArgumentPromotionPass - This pass promotes "by reference" arguments to
125 /// be passed by value.
126 ///
127 Pass *createArgumentPromotionPass();
128
129 //===----------------------------------------------------------------------===//
130 /// createIPConstantPropagationPass - This pass propagates constants from call
131 /// sites into the bodies of functions.
132 ///
133 ModulePass *createIPConstantPropagationPass();
134
135 //===----------------------------------------------------------------------===//
136 /// createIPSCCPPass - This pass propagates constants from call sites into the
137 /// bodies of functions, and keeps track of whether basic blocks are executable
138 /// in the process.
139 ///
140 ModulePass *createIPSCCPPass();
141
142 //===----------------------------------------------------------------------===//
143 //
144 /// createLoopExtractorPass - This pass extracts all natural loops from the
145 /// program into a function if it can.
146 ///
147 FunctionPass *createLoopExtractorPass();
148
149 /// createSingleLoopExtractorPass - This pass extracts one natural loop from the
150 /// program into a function if it can.  This is used by bugpoint.
151 ///
152 FunctionPass *createSingleLoopExtractorPass();
153
154 /// createBlockExtractorPass - This pass extracts all blocks (except those
155 /// specified in the argument list) from the functions in the module.
156 ///
157 ModulePass *createBlockExtractorPass(const std::vector<BasicBlock*> &BTNE);
158
159 /// createOptimizeWellKnownCallsPass - This pass optimizes specific calls to
160 /// specific well-known (library) functions.
161 ModulePass *createSimplifyLibCallsPass();
162
163
164 /// createIndMemRemPass - This pass removes potential indirect calls of
165 /// malloc and free
166 ModulePass *createIndMemRemPass();
167
168 /// createStripDeadPrototypesPass - This pass removes any function declarations
169 /// (prototypes) that are not used.
170 ModulePass *createStripDeadPrototypesPass();
171
172 } // End llvm namespace
173
174 #endif