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
29 //===----------------------------------------------------------------------===//
31 // These functions removes symbols from functions and modules. If OnlyDebugInfo
32 // is true, only debugging information is removed from the module.
34 ModulePass *createStripSymbolsPass(bool OnlyDebugInfo = false);
36 //===----------------------------------------------------------------------===//
38 // These functions removes symbols from functions and modules.
39 // Only debugging information is not removed.
41 ModulePass *createStripNonDebugSymbolsPass();
43 //===----------------------------------------------------------------------===//
44 /// createLowerSetJmpPass - This function lowers the setjmp/longjmp intrinsics
45 /// to invoke/unwind instructions. This should really be part of the C/C++
46 /// front-end, but it's so much easier to write transformations in LLVM proper.
48 ModulePass *createLowerSetJmpPass();
50 //===----------------------------------------------------------------------===//
51 /// createConstantMergePass - This function returns a new pass that merges
52 /// duplicate global constants together into a single constant that is shared.
53 /// This is useful because some passes (ie TraceValues) insert a lot of string
54 /// constants into the program, regardless of whether or not they duplicate an
57 ModulePass *createConstantMergePass();
60 //===----------------------------------------------------------------------===//
61 /// createGlobalOptimizerPass - This function returns a new pass that optimizes
62 /// non-address taken internal globals.
64 ModulePass *createGlobalOptimizerPass();
67 //===----------------------------------------------------------------------===//
68 /// createRaiseAllocationsPass - Return a new pass that transforms malloc and
69 /// free function calls into malloc and free instructions.
71 ModulePass *createRaiseAllocationsPass();
74 //===----------------------------------------------------------------------===//
75 /// createDeadTypeEliminationPass - Return a new pass that eliminates symbol
76 /// table entries for types that are never used.
78 ModulePass *createDeadTypeEliminationPass();
81 //===----------------------------------------------------------------------===//
82 /// createGlobalDCEPass - This transform is designed to eliminate unreachable
83 /// internal globals (functions or global variables)
85 ModulePass *createGlobalDCEPass();
88 //===----------------------------------------------------------------------===//
89 /// createGVExtractionPass - If deleteFn is true, this pass deletes as
90 /// the specified global values. Otherwise, it deletes as much of the module as
91 /// possible, except for the global values specified.
93 ModulePass *createGVExtractionPass(std::vector<GlobalValue*>& GVs, bool
95 bool relinkCallees = false);
97 //===----------------------------------------------------------------------===//
98 /// createFunctionInliningPass - Return a new pass object that uses a heuristic
99 /// to inline direct function calls to small functions.
101 Pass *createFunctionInliningPass();
102 Pass *createFunctionInliningPass(int Threshold);
104 //===----------------------------------------------------------------------===//
105 /// createAlwaysInlinerPass - Return a new pass object that inlines only
106 /// functions that are marked as "always_inline".
107 Pass *createAlwaysInlinerPass();
109 //===----------------------------------------------------------------------===//
110 /// createPruneEHPass - Return a new pass object which transforms invoke
111 /// instructions into calls, if the callee can _not_ unwind the stack.
113 Pass *createPruneEHPass();
115 //===----------------------------------------------------------------------===//
116 /// createInternalizePass - This pass loops over all of the functions in the
117 /// input module, internalizing all globals (functions and variables) not part
118 /// of the api. If a list of symbols is specified with the
119 /// -internalize-public-api-* command line options, those symbols are not
120 /// internalized and all others are. Otherwise if AllButMain is set and the
121 /// main function is found, all other globals are marked as internal. If no api
122 /// is supplied and AllButMain is not set, or no main function is found, nothing
125 ModulePass *createInternalizePass(bool AllButMain);
127 /// createInternalizePass - This pass loops over all of the functions in the
128 /// input module, internalizing all globals (functions and variables) not in the
129 /// given exportList.
131 /// Note that commandline options that are used with the above function are not
132 /// used now! Also, when exportList is empty, nothing is internalized.
133 ModulePass *createInternalizePass(const std::vector<const char *> &exportList);
135 //===----------------------------------------------------------------------===//
136 /// createDeadArgEliminationPass - This pass removes arguments from functions
137 /// which are not used by the body of the function.
139 ModulePass *createDeadArgEliminationPass();
141 /// DeadArgHacking pass - Same as DAE, but delete arguments of external
142 /// functions as well. This is definitely not safe, and should only be used by
144 ModulePass *createDeadArgHackingPass();
146 //===----------------------------------------------------------------------===//
147 /// createArgumentPromotionPass - This pass promotes "by reference" arguments to
148 /// be passed by value if the number of elements passed is smaller or
149 /// equal to maxElements (maxElements == 0 means always promote).
151 Pass *createArgumentPromotionPass(unsigned maxElements = 3);
152 Pass *createStructRetPromotionPass();
154 //===----------------------------------------------------------------------===//
155 /// createIPConstantPropagationPass - This pass propagates constants from call
156 /// sites into the bodies of functions.
158 ModulePass *createIPConstantPropagationPass();
160 //===----------------------------------------------------------------------===//
161 /// createIPSCCPPass - This pass propagates constants from call sites into the
162 /// bodies of functions, and keeps track of whether basic blocks are executable
165 ModulePass *createIPSCCPPass();
167 //===----------------------------------------------------------------------===//
169 /// createLoopExtractorPass - This pass extracts all natural loops from the
170 /// program into a function if it can.
172 FunctionPass *createLoopExtractorPass();
174 /// createSingleLoopExtractorPass - This pass extracts one natural loop from the
175 /// program into a function if it can. This is used by bugpoint.
177 FunctionPass *createSingleLoopExtractorPass();
179 /// createBlockExtractorPass - This pass extracts all blocks (except those
180 /// specified in the argument list) from the functions in the module.
182 ModulePass *createBlockExtractorPass(const std::vector<BasicBlock*> &BTNE);
184 /// createIndMemRemPass - This pass removes potential indirect calls of
186 ModulePass *createIndMemRemPass();
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 } // End llvm namespace