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/Analysis/Verifier.h"
25 #include "llvm/Support/CommandLine.h"
26 #include "llvm/Target/TargetLibraryInfo.h"
27 #include "llvm/Transforms/Scalar.h"
28 #include "llvm/Transforms/Vectorize.h"
29 #include "llvm/Transforms/IPO.h"
30 #include "llvm/ADT/SmallVector.h"
31 #include "llvm/Support/ManagedStatic.h"
36 RunVectorization("vectorize", cl::desc("Run vectorization passes"));
39 UseGVNAfterVectorization("use-gvn-after-vectorization",
40 cl::init(false), cl::Hidden,
41 cl::desc("Run GVN instead of Early CSE after vectorization passes"));
43 static cl::opt<bool> UseNewSROA("use-new-sroa",
44 cl::init(true), cl::Hidden,
45 cl::desc("Enable the new, experimental SROA pass"));
47 PassManagerBuilder::PassManagerBuilder() {
52 DisableSimplifyLibCalls = false;
53 DisableUnitAtATime = false;
54 DisableUnrollLoops = false;
55 Vectorize = RunVectorization;
58 PassManagerBuilder::~PassManagerBuilder() {
63 /// Set of global extensions, automatically added as part of the standard set.
64 static ManagedStatic<SmallVector<std::pair<PassManagerBuilder::ExtensionPointTy,
65 PassManagerBuilder::ExtensionFn>, 8> > GlobalExtensions;
67 void PassManagerBuilder::addGlobalExtension(
68 PassManagerBuilder::ExtensionPointTy Ty,
69 PassManagerBuilder::ExtensionFn Fn) {
70 GlobalExtensions->push_back(std::make_pair(Ty, Fn));
73 void PassManagerBuilder::addExtension(ExtensionPointTy Ty, ExtensionFn Fn) {
74 Extensions.push_back(std::make_pair(Ty, Fn));
77 void PassManagerBuilder::addExtensionsToPM(ExtensionPointTy ETy,
78 PassManagerBase &PM) const {
79 for (unsigned i = 0, e = GlobalExtensions->size(); i != e; ++i)
80 if ((*GlobalExtensions)[i].first == ETy)
81 (*GlobalExtensions)[i].second(*this, PM);
82 for (unsigned i = 0, e = Extensions.size(); i != e; ++i)
83 if (Extensions[i].first == ETy)
84 Extensions[i].second(*this, PM);
88 PassManagerBuilder::addInitialAliasAnalysisPasses(PassManagerBase &PM) const {
89 // Add TypeBasedAliasAnalysis before BasicAliasAnalysis so that
90 // BasicAliasAnalysis wins if they disagree. This is intended to help
91 // support "obvious" type-punning idioms.
92 PM.add(createTypeBasedAliasAnalysisPass());
93 PM.add(createBasicAliasAnalysisPass());
96 void PassManagerBuilder::populateFunctionPassManager(FunctionPassManager &FPM) {
97 addExtensionsToPM(EP_EarlyAsPossible, FPM);
99 // Add LibraryInfo if we have some.
100 if (LibraryInfo) FPM.add(new TargetLibraryInfo(*LibraryInfo));
102 if (OptLevel == 0) return;
104 addInitialAliasAnalysisPasses(FPM);
106 FPM.add(createCFGSimplificationPass());
108 FPM.add(createSROAPass());
110 FPM.add(createScalarReplAggregatesPass());
111 FPM.add(createEarlyCSEPass());
112 FPM.add(createLowerExpectIntrinsicPass());
115 void PassManagerBuilder::populateModulePassManager(PassManagerBase &MPM) {
116 // If all optimizations are disabled, just run the always-inline pass.
122 addExtensionsToPM(EP_EnabledOnOptLevel0, MPM);
126 // Add LibraryInfo if we have some.
127 if (LibraryInfo) MPM.add(new TargetLibraryInfo(*LibraryInfo));
129 addInitialAliasAnalysisPasses(MPM);
131 if (!DisableUnitAtATime) {
132 addExtensionsToPM(EP_ModuleOptimizerEarly, MPM);
134 MPM.add(createGlobalOptimizerPass()); // Optimize out global vars
136 MPM.add(createIPSCCPPass()); // IP SCCP
137 MPM.add(createDeadArgEliminationPass()); // Dead argument elimination
139 MPM.add(createInstructionCombiningPass());// Clean up after IPCP & DAE
140 MPM.add(createCFGSimplificationPass()); // Clean up after IPCP & DAE
143 // Start of CallGraph SCC passes.
144 if (!DisableUnitAtATime)
145 MPM.add(createPruneEHPass()); // Remove dead EH info
150 if (!DisableUnitAtATime)
151 MPM.add(createFunctionAttrsPass()); // Set readonly/readnone attrs
153 MPM.add(createArgumentPromotionPass()); // Scalarize uninlined fn args
155 // Start of function pass.
156 // Break up aggregate allocas, using SSAUpdater.
157 MPM.add(createScalarReplAggregatesPass(-1, false));
158 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies
159 if (!DisableSimplifyLibCalls)
160 MPM.add(createSimplifyLibCallsPass()); // Library Call Optimizations
161 MPM.add(createJumpThreadingPass()); // Thread jumps.
162 MPM.add(createCorrelatedValuePropagationPass()); // Propagate conditionals
163 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
164 MPM.add(createInstructionCombiningPass()); // Combine silly seq's
166 MPM.add(createTailCallEliminationPass()); // Eliminate tail calls
167 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
168 MPM.add(createReassociatePass()); // Reassociate expressions
169 MPM.add(createLoopRotatePass()); // Rotate Loop
170 MPM.add(createLICMPass()); // Hoist loop invariants
171 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3));
172 MPM.add(createInstructionCombiningPass());
173 MPM.add(createIndVarSimplifyPass()); // Canonicalize indvars
174 MPM.add(createLoopIdiomPass()); // Recognize idioms like memset.
175 MPM.add(createLoopDeletionPass()); // Delete dead loops
176 if (!DisableUnrollLoops)
177 MPM.add(createLoopUnrollPass()); // Unroll small loops
178 addExtensionsToPM(EP_LoopOptimizerEnd, MPM);
181 MPM.add(createGVNPass()); // Remove redundancies
182 MPM.add(createMemCpyOptPass()); // Remove memcpy / form memset
183 MPM.add(createSCCPPass()); // Constant prop with SCCP
185 // Run instcombine after redundancy elimination to exploit opportunities
186 // opened up by them.
187 MPM.add(createInstructionCombiningPass());
188 MPM.add(createJumpThreadingPass()); // Thread jumps
189 MPM.add(createCorrelatedValuePropagationPass());
190 MPM.add(createDeadStoreEliminationPass()); // Delete dead stores
192 addExtensionsToPM(EP_ScalarOptimizerLate, MPM);
195 MPM.add(createBBVectorizePass());
196 MPM.add(createInstructionCombiningPass());
197 if (OptLevel > 1 && UseGVNAfterVectorization)
198 MPM.add(createGVNPass()); // Remove redundancies
200 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies
203 MPM.add(createAggressiveDCEPass()); // Delete dead instructions
204 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
205 MPM.add(createInstructionCombiningPass()); // Clean up after everything.
207 if (!DisableUnitAtATime) {
208 // FIXME: We shouldn't bother with this anymore.
209 MPM.add(createStripDeadPrototypesPass()); // Get rid of dead prototypes
211 // GlobalOpt already deletes dead functions and globals, at -O3 try a
212 // late pass of GlobalDCE. It is capable of deleting dead cycles.
214 MPM.add(createGlobalDCEPass()); // Remove dead fns and globals.
217 MPM.add(createConstantMergePass()); // Merge dup global constants
219 addExtensionsToPM(EP_OptimizerLast, MPM);
222 void PassManagerBuilder::populateLTOPassManager(PassManagerBase &PM,
225 bool DisableGVNLoadPRE) {
226 // Provide AliasAnalysis services for optimizations.
227 addInitialAliasAnalysisPasses(PM);
229 // Now that composite has been compiled, scan through the module, looking
230 // for a main function. If main is defined, mark all other functions
233 PM.add(createInternalizePass(true));
235 // Propagate constants at call sites into the functions they call. This
236 // opens opportunities for globalopt (and inlining) by substituting function
237 // pointers passed as arguments to direct uses of functions.
238 PM.add(createIPSCCPPass());
240 // Now that we internalized some globals, see if we can hack on them!
241 PM.add(createGlobalOptimizerPass());
243 // Linking modules together can lead to duplicated global constants, only
244 // keep one copy of each constant.
245 PM.add(createConstantMergePass());
247 // Remove unused arguments from functions.
248 PM.add(createDeadArgEliminationPass());
250 // Reduce the code after globalopt and ipsccp. Both can open up significant
251 // simplification opportunities, and both can propagate functions through
252 // function pointers. When this happens, we often have to resolve varargs
253 // calls, etc, so let instcombine do this.
254 PM.add(createInstructionCombiningPass());
256 // Inline small functions
258 PM.add(createFunctionInliningPass());
260 PM.add(createPruneEHPass()); // Remove dead EH info.
262 // Optimize globals again if we ran the inliner.
264 PM.add(createGlobalOptimizerPass());
265 PM.add(createGlobalDCEPass()); // Remove dead functions.
267 // If we didn't decide to inline a function, check to see if we can
268 // transform it to pass arguments by value instead of by reference.
269 PM.add(createArgumentPromotionPass());
271 // The IPO passes may leave cruft around. Clean up after them.
272 PM.add(createInstructionCombiningPass());
273 PM.add(createJumpThreadingPass());
276 PM.add(createSROAPass());
278 PM.add(createScalarReplAggregatesPass());
280 // Run a few AA driven optimizations here and now, to cleanup the code.
281 PM.add(createFunctionAttrsPass()); // Add nocapture.
282 PM.add(createGlobalsModRefPass()); // IP alias analysis.
284 PM.add(createLICMPass()); // Hoist loop invariants.
285 PM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies.
286 PM.add(createMemCpyOptPass()); // Remove dead memcpys.
288 PM.add(createDeadStoreEliminationPass());
290 // Cleanup and simplify the code after the scalar optimizations.
291 PM.add(createInstructionCombiningPass());
293 PM.add(createJumpThreadingPass());
295 // Delete basic blocks, which optimization passes may have killed.
296 PM.add(createCFGSimplificationPass());
298 // Now that we have optimized the program, discard unreachable functions.
299 PM.add(createGlobalDCEPass());
302 LLVMPassManagerBuilderRef LLVMPassManagerBuilderCreate(void) {
303 PassManagerBuilder *PMB = new PassManagerBuilder();
307 void LLVMPassManagerBuilderDispose(LLVMPassManagerBuilderRef PMB) {
308 PassManagerBuilder *Builder = unwrap(PMB);
313 LLVMPassManagerBuilderSetOptLevel(LLVMPassManagerBuilderRef PMB,
315 PassManagerBuilder *Builder = unwrap(PMB);
316 Builder->OptLevel = OptLevel;
320 LLVMPassManagerBuilderSetSizeLevel(LLVMPassManagerBuilderRef PMB,
321 unsigned SizeLevel) {
322 PassManagerBuilder *Builder = unwrap(PMB);
323 Builder->SizeLevel = SizeLevel;
327 LLVMPassManagerBuilderSetDisableUnitAtATime(LLVMPassManagerBuilderRef PMB,
329 PassManagerBuilder *Builder = unwrap(PMB);
330 Builder->DisableUnitAtATime = Value;
334 LLVMPassManagerBuilderSetDisableUnrollLoops(LLVMPassManagerBuilderRef PMB,
336 PassManagerBuilder *Builder = unwrap(PMB);
337 Builder->DisableUnrollLoops = Value;
341 LLVMPassManagerBuilderSetDisableSimplifyLibCalls(LLVMPassManagerBuilderRef PMB,
343 PassManagerBuilder *Builder = unwrap(PMB);
344 Builder->DisableSimplifyLibCalls = Value;
348 LLVMPassManagerBuilderUseInlinerWithThreshold(LLVMPassManagerBuilderRef PMB,
349 unsigned Threshold) {
350 PassManagerBuilder *Builder = unwrap(PMB);
351 Builder->Inliner = createFunctionInliningPass(Threshold);
355 LLVMPassManagerBuilderPopulateFunctionPassManager(LLVMPassManagerBuilderRef PMB,
356 LLVMPassManagerRef PM) {
357 PassManagerBuilder *Builder = unwrap(PMB);
358 FunctionPassManager *FPM = unwrap<FunctionPassManager>(PM);
359 Builder->populateFunctionPassManager(*FPM);
363 LLVMPassManagerBuilderPopulateModulePassManager(LLVMPassManagerBuilderRef PMB,
364 LLVMPassManagerRef PM) {
365 PassManagerBuilder *Builder = unwrap(PMB);
366 PassManagerBase *MPM = unwrap(PM);
367 Builder->populateModulePassManager(*MPM);
370 void LLVMPassManagerBuilderPopulateLTOPassManager(LLVMPassManagerBuilderRef PMB,
371 LLVMPassManagerRef PM,
374 PassManagerBuilder *Builder = unwrap(PMB);
375 PassManagerBase *LPM = unwrap(PM);
376 Builder->populateLTOPassManager(*LPM, Internalize, RunInliner);