1 //===- PassManagerBuilder.cpp - Build Standard Pass -----------------------===//
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 file defines the PassManagerBuilder class, which is used to set up a
11 // "standard" optimization sequence suitable for languages like C and C++.
13 //===----------------------------------------------------------------------===//
16 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
18 #include "llvm-c/Transforms/PassManagerBuilder.h"
20 #include "llvm/PassManager.h"
21 #include "llvm/DefaultPasses.h"
22 #include "llvm/PassManager.h"
23 #include "llvm/Analysis/Passes.h"
24 #include "llvm/Target/TargetLibraryInfo.h"
25 #include "llvm/Transforms/Scalar.h"
26 #include "llvm/Transforms/IPO.h"
27 #include "llvm/ADT/SmallVector.h"
28 #include "llvm/Support/ManagedStatic.h"
32 PassManagerBuilder::PassManagerBuilder() {
37 DisableSimplifyLibCalls = false;
38 DisableUnitAtATime = false;
39 DisableUnrollLoops = false;
42 PassManagerBuilder::~PassManagerBuilder() {
47 /// Set of global extensions, automatically added as part of the standard set.
48 static ManagedStatic<SmallVector<std::pair<PassManagerBuilder::ExtensionPointTy,
49 PassManagerBuilder::ExtensionFn>, 8> > GlobalExtensions;
51 void PassManagerBuilder::addGlobalExtension(
52 PassManagerBuilder::ExtensionPointTy Ty,
53 PassManagerBuilder::ExtensionFn Fn) {
54 GlobalExtensions->push_back(std::make_pair(Ty, Fn));
57 void PassManagerBuilder::addExtension(ExtensionPointTy Ty, ExtensionFn Fn) {
58 Extensions.push_back(std::make_pair(Ty, Fn));
61 void PassManagerBuilder::addExtensionsToPM(ExtensionPointTy ETy,
62 PassManagerBase &PM) const {
63 for (unsigned i = 0, e = GlobalExtensions->size(); i != e; ++i)
64 if ((*GlobalExtensions)[i].first == ETy)
65 (*GlobalExtensions)[i].second(*this, PM);
66 for (unsigned i = 0, e = Extensions.size(); i != e; ++i)
67 if (Extensions[i].first == ETy)
68 Extensions[i].second(*this, PM);
72 PassManagerBuilder::addInitialAliasAnalysisPasses(PassManagerBase &PM) const {
73 // Add TypeBasedAliasAnalysis before BasicAliasAnalysis so that
74 // BasicAliasAnalysis wins if they disagree. This is intended to help
75 // support "obvious" type-punning idioms.
76 PM.add(createTypeBasedAliasAnalysisPass());
77 PM.add(createBasicAliasAnalysisPass());
80 void PassManagerBuilder::populateFunctionPassManager(FunctionPassManager &FPM) {
81 addExtensionsToPM(EP_EarlyAsPossible, FPM);
83 // Add LibraryInfo if we have some.
84 if (LibraryInfo) FPM.add(new TargetLibraryInfo(*LibraryInfo));
86 if (OptLevel == 0) return;
88 addInitialAliasAnalysisPasses(FPM);
90 FPM.add(createCFGSimplificationPass());
91 FPM.add(createScalarReplAggregatesPass());
92 FPM.add(createEarlyCSEPass());
93 FPM.add(createLowerExpectIntrinsicPass());
96 void PassManagerBuilder::populateModulePassManager(PassManagerBase &MPM) {
97 // If all optimizations are disabled, just run the always-inline pass.
103 addExtensionsToPM(EP_EnabledOnOptLevel0, MPM);
107 // Add LibraryInfo if we have some.
108 if (LibraryInfo) MPM.add(new TargetLibraryInfo(*LibraryInfo));
110 addInitialAliasAnalysisPasses(MPM);
112 if (!DisableUnitAtATime) {
113 addExtensionsToPM(EP_ModuleOptimizerEarly, MPM);
115 MPM.add(createGlobalOptimizerPass()); // Optimize out global vars
117 MPM.add(createIPSCCPPass()); // IP SCCP
118 MPM.add(createDeadArgEliminationPass()); // Dead argument elimination
120 MPM.add(createInstructionCombiningPass());// Clean up after IPCP & DAE
121 MPM.add(createCFGSimplificationPass()); // Clean up after IPCP & DAE
124 // Start of CallGraph SCC passes.
125 if (!DisableUnitAtATime)
126 MPM.add(createPruneEHPass()); // Remove dead EH info
131 if (!DisableUnitAtATime)
132 MPM.add(createFunctionAttrsPass()); // Set readonly/readnone attrs
134 MPM.add(createArgumentPromotionPass()); // Scalarize uninlined fn args
136 // Start of function pass.
137 // Break up aggregate allocas, using SSAUpdater.
138 MPM.add(createScalarReplAggregatesPass(-1, false));
139 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies
140 if (!DisableSimplifyLibCalls)
141 MPM.add(createSimplifyLibCallsPass()); // Library Call Optimizations
142 MPM.add(createJumpThreadingPass()); // Thread jumps.
143 MPM.add(createCorrelatedValuePropagationPass()); // Propagate conditionals
144 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
145 MPM.add(createInstructionCombiningPass()); // Combine silly seq's
147 MPM.add(createTailCallEliminationPass()); // Eliminate tail calls
148 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
149 MPM.add(createReassociatePass()); // Reassociate expressions
150 MPM.add(createLoopRotatePass()); // Rotate Loop
151 MPM.add(createLICMPass()); // Hoist loop invariants
152 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3));
153 MPM.add(createInstructionCombiningPass());
154 MPM.add(createIndVarSimplifyPass()); // Canonicalize indvars
155 MPM.add(createLoopIdiomPass()); // Recognize idioms like memset.
156 MPM.add(createLoopDeletionPass()); // Delete dead loops
157 if (!DisableUnrollLoops)
158 MPM.add(createLoopUnrollPass()); // Unroll small loops
159 addExtensionsToPM(EP_LoopOptimizerEnd, MPM);
162 MPM.add(createGVNPass()); // Remove redundancies
163 MPM.add(createMemCpyOptPass()); // Remove memcpy / form memset
164 MPM.add(createSCCPPass()); // Constant prop with SCCP
166 // Run instcombine after redundancy elimination to exploit opportunities
167 // opened up by them.
168 MPM.add(createInstructionCombiningPass());
169 MPM.add(createJumpThreadingPass()); // Thread jumps
170 MPM.add(createCorrelatedValuePropagationPass());
171 MPM.add(createDeadStoreEliminationPass()); // Delete dead stores
173 addExtensionsToPM(EP_ScalarOptimizerLate, MPM);
175 MPM.add(createAggressiveDCEPass()); // Delete dead instructions
176 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
177 MPM.add(createInstructionCombiningPass()); // Clean up after everything.
179 if (!DisableUnitAtATime) {
180 // FIXME: We shouldn't bother with this anymore.
181 MPM.add(createStripDeadPrototypesPass()); // Get rid of dead prototypes
183 // GlobalOpt already deletes dead functions and globals, at -O3 try a
184 // late pass of GlobalDCE. It is capable of deleting dead cycles.
186 MPM.add(createGlobalDCEPass()); // Remove dead fns and globals.
189 MPM.add(createConstantMergePass()); // Merge dup global constants
193 void PassManagerBuilder::populateLTOPassManager(PassManagerBase &PM,
196 // Provide AliasAnalysis services for optimizations.
197 addInitialAliasAnalysisPasses(PM);
199 // Now that composite has been compiled, scan through the module, looking
200 // for a main function. If main is defined, mark all other functions
203 PM.add(createInternalizePass(true));
205 // Propagate constants at call sites into the functions they call. This
206 // opens opportunities for globalopt (and inlining) by substituting function
207 // pointers passed as arguments to direct uses of functions.
208 PM.add(createIPSCCPPass());
210 // Now that we internalized some globals, see if we can hack on them!
211 PM.add(createGlobalOptimizerPass());
213 // Linking modules together can lead to duplicated global constants, only
214 // keep one copy of each constant.
215 PM.add(createConstantMergePass());
217 // Remove unused arguments from functions.
218 PM.add(createDeadArgEliminationPass());
220 // Reduce the code after globalopt and ipsccp. Both can open up significant
221 // simplification opportunities, and both can propagate functions through
222 // function pointers. When this happens, we often have to resolve varargs
223 // calls, etc, so let instcombine do this.
224 PM.add(createInstructionCombiningPass());
226 // Inline small functions
228 PM.add(createFunctionInliningPass());
230 PM.add(createPruneEHPass()); // Remove dead EH info.
232 // Optimize globals again if we ran the inliner.
234 PM.add(createGlobalOptimizerPass());
235 PM.add(createGlobalDCEPass()); // Remove dead functions.
237 // If we didn't decide to inline a function, check to see if we can
238 // transform it to pass arguments by value instead of by reference.
239 PM.add(createArgumentPromotionPass());
241 // The IPO passes may leave cruft around. Clean up after them.
242 PM.add(createInstructionCombiningPass());
243 PM.add(createJumpThreadingPass());
245 PM.add(createScalarReplAggregatesPass());
247 // Run a few AA driven optimizations here and now, to cleanup the code.
248 PM.add(createFunctionAttrsPass()); // Add nocapture.
249 PM.add(createGlobalsModRefPass()); // IP alias analysis.
251 PM.add(createLICMPass()); // Hoist loop invariants.
252 PM.add(createGVNPass()); // Remove redundancies.
253 PM.add(createMemCpyOptPass()); // Remove dead memcpys.
255 PM.add(createDeadStoreEliminationPass());
257 // Cleanup and simplify the code after the scalar optimizations.
258 PM.add(createInstructionCombiningPass());
260 PM.add(createJumpThreadingPass());
262 // Delete basic blocks, which optimization passes may have killed.
263 PM.add(createCFGSimplificationPass());
265 // Now that we have optimized the program, discard unreachable functions.
266 PM.add(createGlobalDCEPass());
269 LLVMPassManagerBuilderRef LLVMPassManagerBuilderCreate(void) {
270 PassManagerBuilder *PMB = new PassManagerBuilder();
274 void LLVMPassManagerBuilderDispose(LLVMPassManagerBuilderRef PMB) {
275 PassManagerBuilder *Builder = unwrap(PMB);
280 LLVMPassManagerBuilderSetOptLevel(LLVMPassManagerBuilderRef PMB,
282 PassManagerBuilder *Builder = unwrap(PMB);
283 Builder->OptLevel = OptLevel;
287 LLVMPassManagerBuilderSetSizeLevel(LLVMPassManagerBuilderRef PMB,
288 unsigned SizeLevel) {
289 PassManagerBuilder *Builder = unwrap(PMB);
290 Builder->SizeLevel = SizeLevel;
294 LLVMPassManagerBuilderSetDisableUnitAtATime(LLVMPassManagerBuilderRef PMB,
296 PassManagerBuilder *Builder = unwrap(PMB);
297 Builder->DisableUnitAtATime = Value;
301 LLVMPassManagerBuilderSetDisableUnrollLoops(LLVMPassManagerBuilderRef PMB,
303 PassManagerBuilder *Builder = unwrap(PMB);
304 Builder->DisableUnrollLoops = Value;
308 LLVMPassManagerBuilderSetDisableSimplifyLibCalls(LLVMPassManagerBuilderRef PMB,
310 PassManagerBuilder *Builder = unwrap(PMB);
311 Builder->DisableSimplifyLibCalls = Value;
315 LLVMPassManagerBuilderUseInlinerWithThreshold(LLVMPassManagerBuilderRef PMB,
316 unsigned Threshold) {
317 PassManagerBuilder *Builder = unwrap(PMB);
318 Builder->Inliner = createFunctionInliningPass(Threshold);
322 LLVMPassManagerBuilderPopulateFunctionPassManager(LLVMPassManagerBuilderRef PMB,
323 LLVMPassManagerRef PM) {
324 PassManagerBuilder *Builder = unwrap(PMB);
325 FunctionPassManager *FPM = unwrap<FunctionPassManager>(PM);
326 Builder->populateFunctionPassManager(*FPM);
330 LLVMPassManagerBuilderPopulateModulePassManager(LLVMPassManagerBuilderRef PMB,
331 LLVMPassManagerRef PM) {
332 PassManagerBuilder *Builder = unwrap(PMB);
333 PassManagerBase *MPM = unwrap(PM);
334 Builder->populateModulePassManager(*MPM);
337 void LLVMPassManagerBuilderPopulateLTOPassManager(LLVMPassManagerBuilderRef PMB,
338 LLVMPassManagerRef PM,
341 PassManagerBuilder *Builder = unwrap(PMB);
342 PassManagerBase *LPM = unwrap(PM);
343 Builder->populateLTOPassManager(*LPM, Internalize, RunInliner);