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
18 #include "llvm/ADT/ArrayRef.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 //===----------------------------------------------------------------------===//
49 // These pass removes unused symbols' debug info.
50 ModulePass *createStripDeadDebugInfoPass();
52 //===----------------------------------------------------------------------===//
53 /// createConstantMergePass - This function returns a new pass that merges
54 /// duplicate global constants together into a single constant that is shared.
55 /// This is useful because some passes (ie TraceValues) insert a lot of string
56 /// constants into the program, regardless of whether or not they duplicate an
59 ModulePass *createConstantMergePass();
61 //===----------------------------------------------------------------------===//
62 /// createGlobalOptimizerPass - This function returns a new pass that optimizes
63 /// non-address taken internal globals.
65 ModulePass *createGlobalOptimizerPass();
67 //===----------------------------------------------------------------------===//
68 /// createGlobalDCEPass - This transform is designed to eliminate unreachable
69 /// internal globals (functions or global variables)
71 ModulePass *createGlobalDCEPass();
73 //===----------------------------------------------------------------------===//
74 /// createGVExtractionPass - If deleteFn is true, this pass deletes
75 /// the specified global values. Otherwise, it deletes as much of the module as
76 /// possible, except for the global values specified.
78 ModulePass *createGVExtractionPass(std::vector<GlobalValue*>& GVs, bool
81 //===----------------------------------------------------------------------===//
82 /// createFunctionInliningPass - Return a new pass object that uses a heuristic
83 /// to inline direct function calls to small functions.
85 /// The Threshold can be passed directly, or asked to be computed from the
86 /// given optimization and size optimization arguments.
88 /// The -inline-threshold command line option takes precedence over the
89 /// threshold given here.
90 Pass *createFunctionInliningPass();
91 Pass *createFunctionInliningPass(int Threshold);
92 Pass *createFunctionInliningPass(unsigned OptLevel, unsigned SizeOptLevel);
94 //===----------------------------------------------------------------------===//
95 /// createAlwaysInlinerPass - Return a new pass object that inlines only
96 /// functions that are marked as "always_inline".
97 Pass *createAlwaysInlinerPass();
98 Pass *createAlwaysInlinerPass(bool InsertLifetime);
100 //===----------------------------------------------------------------------===//
101 /// createPruneEHPass - Return a new pass object which transforms invoke
102 /// instructions into calls, if the callee can _not_ unwind the stack.
104 Pass *createPruneEHPass();
106 //===----------------------------------------------------------------------===//
107 /// createInternalizePass - This pass loops over all of the functions in the
108 /// input module, internalizing all globals (functions and variables) it can.
110 /// The symbols in \p ExportList are never internalized.
112 /// The symbol in DSOList are internalized if it is safe to drop them from
113 /// the symbol table.
115 /// Note that commandline options that are used with the above function are not
117 ModulePass *createInternalizePass(ArrayRef<const char *> ExportList);
118 /// createInternalizePass - Same as above, but with an empty exportList.
119 ModulePass *createInternalizePass();
121 //===----------------------------------------------------------------------===//
122 /// createDeadArgEliminationPass - This pass removes arguments from functions
123 /// which are not used by the body of the function.
125 ModulePass *createDeadArgEliminationPass();
127 /// DeadArgHacking pass - Same as DAE, but delete arguments of external
128 /// functions as well. This is definitely not safe, and should only be used by
130 ModulePass *createDeadArgHackingPass();
132 //===----------------------------------------------------------------------===//
133 /// createArgumentPromotionPass - This pass promotes "by reference" arguments to
134 /// be passed by value if the number of elements passed is smaller or
135 /// equal to maxElements (maxElements == 0 means always promote).
137 Pass *createArgumentPromotionPass(unsigned maxElements = 3);
139 //===----------------------------------------------------------------------===//
140 /// createIPConstantPropagationPass - This pass propagates constants from call
141 /// sites into the bodies of functions.
143 ModulePass *createIPConstantPropagationPass();
145 //===----------------------------------------------------------------------===//
146 /// createIPSCCPPass - This pass propagates constants from call sites into the
147 /// bodies of functions, and keeps track of whether basic blocks are executable
150 ModulePass *createIPSCCPPass();
152 //===----------------------------------------------------------------------===//
154 /// createLoopExtractorPass - This pass extracts all natural loops from the
155 /// program into a function if it can.
157 Pass *createLoopExtractorPass();
159 /// createSingleLoopExtractorPass - This pass extracts one natural loop from the
160 /// program into a function if it can. This is used by bugpoint.
162 Pass *createSingleLoopExtractorPass();
164 /// createBlockExtractorPass - This pass extracts all blocks (except those
165 /// specified in the argument list) from the functions in the module.
167 ModulePass *createBlockExtractorPass();
169 /// createStripDeadPrototypesPass - This pass removes any function declarations
170 /// (prototypes) that are not used.
171 ModulePass *createStripDeadPrototypesPass();
173 //===----------------------------------------------------------------------===//
174 /// createFunctionAttrsPass - This pass discovers functions that do not access
175 /// memory, or only read memory, and gives them the readnone/readonly attribute.
176 /// It also discovers function arguments that are not captured by the function
177 /// and marks them with the nocapture attribute.
179 Pass *createFunctionAttrsPass();
181 //===----------------------------------------------------------------------===//
182 /// createMergeFunctionsPass - This pass discovers identical functions and
185 ModulePass *createMergeFunctionsPass();
187 //===----------------------------------------------------------------------===//
188 /// createPartialInliningPass - This pass inlines parts of functions.
190 ModulePass *createPartialInliningPass();
192 //===----------------------------------------------------------------------===//
193 // createMetaRenamerPass - Rename everything with metasyntatic names.
195 ModulePass *createMetaRenamerPass();
197 //===----------------------------------------------------------------------===//
198 /// createBarrierNoopPass - This pass is purely a module pass barrier in a pass
200 ModulePass *createBarrierNoopPass();
202 } // End llvm namespace