1 //===- llvm/Transforms/IPO.h - Interprocedural Transformations --*- 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 header file defines prototypes for accessor functions that expose passes
11 // in the IPO transformations library.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_TRANSFORMS_IPO_H
16 #define LLVM_TRANSFORMS_IPO_H
28 //===----------------------------------------------------------------------===//
30 // These functions removes symbols from functions and modules. If OnlyDebugInfo
31 // is true, only debugging information is removed from the module.
33 ModulePass *createStripSymbolsPass(bool OnlyDebugInfo = false);
35 //===----------------------------------------------------------------------===//
37 // These functions strips symbols from functions and modules.
38 // Only debugging information is not stripped.
40 ModulePass *createStripNonDebugSymbolsPass();
42 //===----------------------------------------------------------------------===//
44 // These pass removes llvm.dbg.declare intrinsics.
45 ModulePass *createStripDebugDeclarePass();
47 //===----------------------------------------------------------------------===//
48 /// createLowerSetJmpPass - This function lowers the setjmp/longjmp intrinsics
49 /// to invoke/unwind instructions. This should really be part of the C/C++
50 /// front-end, but it's so much easier to write transformations in LLVM proper.
52 ModulePass *createLowerSetJmpPass();
54 //===----------------------------------------------------------------------===//
55 /// createConstantMergePass - This function returns a new pass that merges
56 /// duplicate global constants together into a single constant that is shared.
57 /// This is useful because some passes (ie TraceValues) insert a lot of string
58 /// constants into the program, regardless of whether or not they duplicate an
61 ModulePass *createConstantMergePass();
64 //===----------------------------------------------------------------------===//
65 /// createGlobalOptimizerPass - This function returns a new pass that optimizes
66 /// non-address taken internal globals.
68 ModulePass *createGlobalOptimizerPass();
71 //===----------------------------------------------------------------------===//
72 /// createRaiseAllocationsPass - Return a new pass that transforms malloc and
73 /// free function calls into malloc and free instructions.
75 ModulePass *createRaiseAllocationsPass();
78 //===----------------------------------------------------------------------===//
79 /// createDeadTypeEliminationPass - Return a new pass that eliminates symbol
80 /// table entries for types that are never used.
82 ModulePass *createDeadTypeEliminationPass();
85 //===----------------------------------------------------------------------===//
86 /// createGlobalDCEPass - This transform is designed to eliminate unreachable
87 /// internal globals (functions or global variables)
89 ModulePass *createGlobalDCEPass();
92 //===----------------------------------------------------------------------===//
93 /// createGVExtractionPass - If deleteFn is true, this pass deletes as
94 /// the specified global values. Otherwise, it deletes as much of the module as
95 /// possible, except for the global values specified.
97 ModulePass *createGVExtractionPass(std::vector<GlobalValue*>& GVs, bool
99 bool relinkCallees = false);
101 //===----------------------------------------------------------------------===//
102 /// createFunctionInliningPass - Return a new pass object that uses a heuristic
103 /// to inline direct function calls to small functions.
105 Pass *createFunctionInliningPass();
106 Pass *createFunctionInliningPass(int Threshold);
108 //===----------------------------------------------------------------------===//
109 /// createAlwaysInlinerPass - Return a new pass object that inlines only
110 /// functions that are marked as "always_inline".
111 Pass *createAlwaysInlinerPass();
113 //===----------------------------------------------------------------------===//
114 /// createPruneEHPass - Return a new pass object which transforms invoke
115 /// instructions into calls, if the callee can _not_ unwind the stack.
117 Pass *createPruneEHPass();
119 //===----------------------------------------------------------------------===//
120 /// createInternalizePass - This pass loops over all of the functions in the
121 /// input module, internalizing all globals (functions and variables) not part
122 /// of the api. If a list of symbols is specified with the
123 /// -internalize-public-api-* command line options, those symbols are not
124 /// internalized and all others are. Otherwise if AllButMain is set and the
125 /// main function is found, all other globals are marked as internal. If no api
126 /// is supplied and AllButMain is not set, or no main function is found, nothing
129 ModulePass *createInternalizePass(bool AllButMain);
131 /// createInternalizePass - This pass loops over all of the functions in the
132 /// input module, internalizing all globals (functions and variables) not in the
133 /// given exportList.
135 /// Note that commandline options that are used with the above function are not
136 /// used now! Also, when exportList is empty, nothing is internalized.
137 ModulePass *createInternalizePass(const std::vector<const char *> &exportList);
139 //===----------------------------------------------------------------------===//
140 /// createDeadArgEliminationPass - This pass removes arguments from functions
141 /// which are not used by the body of the function.
143 ModulePass *createDeadArgEliminationPass();
145 /// DeadArgHacking pass - Same as DAE, but delete arguments of external
146 /// functions as well. This is definitely not safe, and should only be used by
148 ModulePass *createDeadArgHackingPass();
150 //===----------------------------------------------------------------------===//
151 /// createArgumentPromotionPass - This pass promotes "by reference" arguments to
152 /// be passed by value if the number of elements passed is smaller or
153 /// equal to maxElements (maxElements == 0 means always promote).
155 Pass *createArgumentPromotionPass(unsigned maxElements = 3);
156 Pass *createStructRetPromotionPass();
158 //===----------------------------------------------------------------------===//
159 /// createIPConstantPropagationPass - This pass propagates constants from call
160 /// sites into the bodies of functions.
162 ModulePass *createIPConstantPropagationPass();
164 //===----------------------------------------------------------------------===//
165 /// createIPSCCPPass - This pass propagates constants from call sites into the
166 /// bodies of functions, and keeps track of whether basic blocks are executable
169 ModulePass *createIPSCCPPass();
171 //===----------------------------------------------------------------------===//
173 /// createLoopExtractorPass - This pass extracts all natural loops from the
174 /// program into a function if it can.
176 Pass *createLoopExtractorPass();
178 /// createSingleLoopExtractorPass - This pass extracts one natural loop from the
179 /// program into a function if it can. This is used by bugpoint.
181 Pass *createSingleLoopExtractorPass();
183 /// createBlockExtractorPass - This pass extracts all blocks (except those
184 /// specified in the argument list) from the functions in the module.
186 ModulePass *createBlockExtractorPass(const std::vector<BasicBlock*> &BTNE);
188 /// createStripDeadPrototypesPass - This pass removes any function declarations
189 /// (prototypes) that are not used.
190 ModulePass *createStripDeadPrototypesPass();
192 //===----------------------------------------------------------------------===//
193 /// createPartialSpecializationPass - This pass specializes functions for
194 /// constant arguments.
196 ModulePass *createPartialSpecializationPass();
198 //===----------------------------------------------------------------------===//
199 /// createFunctionAttrsPass - This pass discovers functions that do not access
200 /// memory, or only read memory, and gives them the readnone/readonly attribute.
201 /// It also discovers function arguments that are not captured by the function
202 /// and marks them with the nocapture attribute.
204 Pass *createFunctionAttrsPass();
206 //===----------------------------------------------------------------------===//
207 /// createMergeFunctionsPass - This pass discovers identical functions and
210 ModulePass *createMergeFunctionsPass();
212 //===----------------------------------------------------------------------===//
213 /// createPartialInliningPass - This pass inlines parts of functions.
215 ModulePass *createPartialInliningPass();
217 } // End llvm namespace