blob: a4a1852de305e36eba14d2dee1d80159e499677f [file] [log] [blame]
Rafael Espindola3ea478b2011-08-02 21:50:27 +00001//===- PassManagerBuilder.cpp - Build Standard Pass -----------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
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++.
12//
13//===----------------------------------------------------------------------===//
14
15
16#include "llvm/Transforms/IPO/PassManagerBuilder.h"
Rafael Espindola07f609152011-08-09 22:17:34 +000017#include "llvm-c/Transforms/PassManagerBuilder.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000018#include "llvm/ADT/SmallVector.h"
Rafael Espindola3ea478b2011-08-02 21:50:27 +000019#include "llvm/Analysis/Passes.h"
Rafael Espindola7cebf362014-08-21 20:03:44 +000020#include "llvm/IR/DataLayout.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000021#include "llvm/IR/Verifier.h"
Chandler Carruth30d69c22015-02-13 10:01:29 +000022#include "llvm/IR/LegacyPassManager.h"
Hal Finkelc34e5112012-02-01 03:51:43 +000023#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000024#include "llvm/Support/ManagedStatic.h"
Chandler Carruth17e0bc32015-08-06 07:33:15 +000025#include "llvm/Analysis/BasicAliasAnalysis.h"
Chandler Carruth62d42152015-01-15 02:16:27 +000026#include "llvm/Analysis/TargetLibraryInfo.h"
Rafael Espindola7cebf362014-08-21 20:03:44 +000027#include "llvm/Target/TargetMachine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000028#include "llvm/Transforms/IPO.h"
Rafael Espindola3ea478b2011-08-02 21:50:27 +000029#include "llvm/Transforms/Scalar.h"
Hal Finkelc34e5112012-02-01 03:51:43 +000030#include "llvm/Transforms/Vectorize.h"
Rafael Espindola3ea478b2011-08-02 21:50:27 +000031
32using namespace llvm;
33
Hal Finkelc34e5112012-02-01 03:51:43 +000034static cl::opt<bool>
Nadav Rotem7f27e0b2013-10-18 23:38:13 +000035RunLoopVectorization("vectorize-loops", cl::Hidden,
Nadav Rotemd3df6652012-10-30 18:37:43 +000036 cl::desc("Run the Loop vectorization passes"));
Nadav Rotemc59ae202012-10-29 16:36:25 +000037
38static cl::opt<bool>
Nadav Rotem7f27e0b2013-10-18 23:38:13 +000039RunSLPVectorization("vectorize-slp", cl::Hidden,
Nadav Rotemd4dcc002013-04-15 05:39:58 +000040 cl::desc("Run the SLP vectorization passes"));
41
42static cl::opt<bool>
Nadav Rotem7f27e0b2013-10-18 23:38:13 +000043RunBBVectorization("vectorize-slp-aggressive", cl::Hidden,
Nadav Rotemd4dcc002013-04-15 05:39:58 +000044 cl::desc("Run the BB vectorization passes"));
Hal Finkelc34e5112012-02-01 03:51:43 +000045
Hal Finkel204bf532012-04-13 17:15:33 +000046static cl::opt<bool>
47UseGVNAfterVectorization("use-gvn-after-vectorization",
48 cl::init(false), cl::Hidden,
49 cl::desc("Run GVN instead of Early CSE after vectorization passes"));
50
Chandler Carruth7b8297a2014-10-14 00:31:29 +000051static cl::opt<bool> ExtraVectorizerPasses(
52 "extra-vectorizer-passes", cl::init(false), cl::Hidden,
53 cl::desc("Run cleanup optimization passes after vectorization."));
54
Chandler Carruth1b398ae2012-09-14 09:22:59 +000055static cl::opt<bool> UseNewSROA("use-new-sroa",
Chandler Carruth4e435992012-10-02 04:24:01 +000056 cl::init(true), cl::Hidden,
Chandler Carruth1b398ae2012-09-14 09:22:59 +000057 cl::desc("Enable the new, experimental SROA pass"));
58
Hal Finkelbf45efd2013-11-16 23:59:05 +000059static cl::opt<bool>
60RunLoopRerolling("reroll-loops", cl::Hidden,
61 cl::desc("Run the loop rerolling pass"));
62
James Molloy0cbb2a862015-03-27 10:36:57 +000063static cl::opt<bool>
64RunFloat2Int("float-to-int", cl::Hidden, cl::init(true),
65 cl::desc("Run the float2int (float demotion) pass"));
66
Michael J. Spencer289067c2014-05-29 01:55:07 +000067static cl::opt<bool> RunLoadCombine("combine-loads", cl::init(false),
68 cl::Hidden,
69 cl::desc("Run the load combining pass"));
70
James Molloy568da092014-08-06 12:56:19 +000071static cl::opt<bool>
72RunSLPAfterLoopVectorization("run-slp-after-loop-vectorization",
James Molloy6b95d8e2014-09-04 13:23:08 +000073 cl::init(true), cl::Hidden,
James Molloy568da092014-08-06 12:56:19 +000074 cl::desc("Run the SLP vectorizer (and BB vectorizer) after the Loop "
75 "vectorizer instead of before"));
76
Hal Finkel445dda52014-09-02 22:12:54 +000077static cl::opt<bool> UseCFLAA("use-cfl-aa",
78 cl::init(false), cl::Hidden,
79 cl::desc("Enable the new, experimental CFL alias analysis"));
James Molloy568da092014-08-06 12:56:19 +000080
Gerolf Hoflehner24815d92014-09-10 19:55:29 +000081static cl::opt<bool>
Gerolf Hoflehner008e5cd2014-09-10 20:24:03 +000082EnableMLSM("mlsm", cl::init(true), cl::Hidden,
83 cl::desc("Enable motion of merged load and store"));
Gerolf Hoflehner24815d92014-09-10 19:55:29 +000084
Karthik Bhat88db86d2015-03-06 10:11:25 +000085static cl::opt<bool> EnableLoopInterchange(
86 "enable-loopinterchange", cl::init(false), cl::Hidden,
87 cl::desc("Enable the new, experimental LoopInterchange Pass"));
88
Adam Nemet938d3d62015-05-14 12:05:18 +000089static cl::opt<bool> EnableLoopDistribute(
90 "enable-loop-distribute", cl::init(false), cl::Hidden,
91 cl::desc("Enable the new, experimental LoopDistribution Pass"));
92
Chandler Carruthe9ea5a62015-07-22 11:57:28 +000093static cl::opt<bool> EnableNonLTOGlobalsModRef(
94 "enable-non-lto-gmr", cl::init(false), cl::Hidden,
95 cl::desc(
96 "Enable the GlobalsModRef AliasAnalysis outside of the LTO pipeline."));
97
Rafael Espindola3ea478b2011-08-02 21:50:27 +000098PassManagerBuilder::PassManagerBuilder() {
99 OptLevel = 2;
100 SizeLevel = 0;
Craig Topperf40110f2014-04-25 05:29:35 +0000101 LibraryInfo = nullptr;
102 Inliner = nullptr;
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000103 DisableUnitAtATime = false;
104 DisableUnrollLoops = false;
Nadav Rotemd4dcc002013-04-15 05:39:58 +0000105 BBVectorize = RunBBVectorization;
Nadav Rotema1e5e442013-04-15 04:54:42 +0000106 SLPVectorize = RunSLPVectorization;
Nadav Rotemc59ae202012-10-29 16:36:25 +0000107 LoopVectorize = RunLoopVectorization;
Hal Finkel29aeb202013-11-17 16:02:50 +0000108 RerollLoops = RunLoopRerolling;
Michael J. Spencer289067c2014-05-29 01:55:07 +0000109 LoadCombine = RunLoadCombine;
Rafael Espindola208bc532014-08-21 13:13:17 +0000110 DisableGVNLoadPRE = false;
Rafael Espindola7cebf362014-08-21 20:03:44 +0000111 VerifyInput = false;
112 VerifyOutput = false;
Nick Lewycky9e6d1842014-09-13 21:46:00 +0000113 MergeFunctions = false;
Teresa Johnsond3a33a12015-07-06 16:22:42 +0000114 PrepareForLTO = false;
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000115}
116
117PassManagerBuilder::~PassManagerBuilder() {
118 delete LibraryInfo;
119 delete Inliner;
120}
121
David Chisnall719a72f2011-08-16 13:58:41 +0000122/// Set of global extensions, automatically added as part of the standard set.
123static ManagedStatic<SmallVector<std::pair<PassManagerBuilder::ExtensionPointTy,
124 PassManagerBuilder::ExtensionFn>, 8> > GlobalExtensions;
125
126void PassManagerBuilder::addGlobalExtension(
127 PassManagerBuilder::ExtensionPointTy Ty,
128 PassManagerBuilder::ExtensionFn Fn) {
129 GlobalExtensions->push_back(std::make_pair(Ty, Fn));
130}
131
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000132void PassManagerBuilder::addExtension(ExtensionPointTy Ty, ExtensionFn Fn) {
133 Extensions.push_back(std::make_pair(Ty, Fn));
134}
135
136void PassManagerBuilder::addExtensionsToPM(ExtensionPointTy ETy,
Chandler Carruth30d69c22015-02-13 10:01:29 +0000137 legacy::PassManagerBase &PM) const {
David Chisnall719a72f2011-08-16 13:58:41 +0000138 for (unsigned i = 0, e = GlobalExtensions->size(); i != e; ++i)
139 if ((*GlobalExtensions)[i].first == ETy)
140 (*GlobalExtensions)[i].second(*this, PM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000141 for (unsigned i = 0, e = Extensions.size(); i != e; ++i)
142 if (Extensions[i].first == ETy)
143 Extensions[i].second(*this, PM);
144}
145
Chandler Carruth30d69c22015-02-13 10:01:29 +0000146void PassManagerBuilder::addInitialAliasAnalysisPasses(
147 legacy::PassManagerBase &PM) const {
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000148 // Add TypeBasedAliasAnalysis before BasicAliasAnalysis so that
149 // BasicAliasAnalysis wins if they disagree. This is intended to help
150 // support "obvious" type-punning idioms.
Hal Finkel445dda52014-09-02 22:12:54 +0000151 if (UseCFLAA)
152 PM.add(createCFLAliasAnalysisPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000153 PM.add(createTypeBasedAliasAnalysisPass());
Hal Finkel94146652014-07-24 14:25:39 +0000154 PM.add(createScopedNoAliasAAPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000155 PM.add(createBasicAliasAnalysisPass());
156}
157
Chandler Carruth30d69c22015-02-13 10:01:29 +0000158void PassManagerBuilder::populateFunctionPassManager(
159 legacy::FunctionPassManager &FPM) {
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000160 addExtensionsToPM(EP_EarlyAsPossible, FPM);
161
162 // Add LibraryInfo if we have some.
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000163 if (LibraryInfo)
164 FPM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo));
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000165
166 if (OptLevel == 0) return;
167
168 addInitialAliasAnalysisPasses(FPM);
169
170 FPM.add(createCFGSimplificationPass());
Chandler Carruth1b398ae2012-09-14 09:22:59 +0000171 if (UseNewSROA)
172 FPM.add(createSROAPass());
173 else
174 FPM.add(createScalarReplAggregatesPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000175 FPM.add(createEarlyCSEPass());
176 FPM.add(createLowerExpectIntrinsicPass());
177}
178
Chandler Carruth30d69c22015-02-13 10:01:29 +0000179void PassManagerBuilder::populateModulePassManager(
180 legacy::PassManagerBase &MPM) {
Nick Lewycky592d8492014-10-23 23:49:31 +0000181 // If all optimizations are disabled, just run the always-inline pass and,
182 // if enabled, the function merging pass.
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000183 if (OptLevel == 0) {
184 if (Inliner) {
185 MPM.add(Inliner);
Craig Topperf40110f2014-04-25 05:29:35 +0000186 Inliner = nullptr;
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000187 }
Chandler Carruthe8479e12012-10-18 08:05:46 +0000188
Nick Lewycky592d8492014-10-23 23:49:31 +0000189 // FIXME: The BarrierNoopPass is a HACK! The inliner pass above implicitly
190 // creates a CGSCC pass manager, but we don't want to add extensions into
191 // that pass manager. To prevent this we insert a no-op module pass to reset
192 // the pass manager to get the same behavior as EP_OptimizerLast in non-O0
193 // builds. The function merging pass is
194 if (MergeFunctions)
195 MPM.add(createMergeFunctionsPass());
196 else if (!GlobalExtensions->empty() || !Extensions.empty())
Chandler Carruthe8479e12012-10-18 08:05:46 +0000197 MPM.add(createBarrierNoopPass());
198
Kostya Serebryanydc436f92011-11-30 22:19:26 +0000199 addExtensionsToPM(EP_EnabledOnOptLevel0, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000200 return;
201 }
202
203 // Add LibraryInfo if we have some.
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000204 if (LibraryInfo)
205 MPM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo));
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000206
207 addInitialAliasAnalysisPasses(MPM);
208
209 if (!DisableUnitAtATime) {
Dan Gohmanb9936292012-01-17 20:51:32 +0000210 addExtensionsToPM(EP_ModuleOptimizerEarly, MPM);
211
Gerolf Hoflehner65b13322014-07-03 19:28:15 +0000212 MPM.add(createIPSCCPPass()); // IP SCCP
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000213 MPM.add(createGlobalOptimizerPass()); // Optimize out global vars
214
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000215 MPM.add(createDeadArgEliminationPass()); // Dead argument elimination
216
217 MPM.add(createInstructionCombiningPass());// Clean up after IPCP & DAE
Peter Collingbourne0a437612014-05-25 10:27:02 +0000218 addExtensionsToPM(EP_Peephole, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000219 MPM.add(createCFGSimplificationPass()); // Clean up after IPCP & DAE
220 }
221
Chandler Carruthe9ea5a62015-07-22 11:57:28 +0000222 if (EnableNonLTOGlobalsModRef)
223 // We add a module alias analysis pass here. In part due to bugs in the
224 // analysis infrastructure this "works" in that the analysis stays alive
225 // for the entire SCC pass run below.
226 MPM.add(createGlobalsModRefPass());
227
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000228 // Start of CallGraph SCC passes.
229 if (!DisableUnitAtATime)
230 MPM.add(createPruneEHPass()); // Remove dead EH info
231 if (Inliner) {
232 MPM.add(Inliner);
Craig Topperf40110f2014-04-25 05:29:35 +0000233 Inliner = nullptr;
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000234 }
235 if (!DisableUnitAtATime)
236 MPM.add(createFunctionAttrsPass()); // Set readonly/readnone attrs
237 if (OptLevel > 2)
238 MPM.add(createArgumentPromotionPass()); // Scalarize uninlined fn args
239
240 // Start of function pass.
241 // Break up aggregate allocas, using SSAUpdater.
Chandler Carruth70b44c52012-09-15 11:43:14 +0000242 if (UseNewSROA)
243 MPM.add(createSROAPass(/*RequiresDomTree*/ false));
244 else
245 MPM.add(createScalarReplAggregatesPass(-1, false));
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000246 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000247 MPM.add(createJumpThreadingPass()); // Thread jumps.
248 MPM.add(createCorrelatedValuePropagationPass()); // Propagate conditionals
249 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
250 MPM.add(createInstructionCombiningPass()); // Combine silly seq's
Peter Collingbourne0a437612014-05-25 10:27:02 +0000251 addExtensionsToPM(EP_Peephole, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000252
Akira Hatanakad9699bc2015-06-09 19:07:19 +0000253 MPM.add(createTailCallEliminationPass()); // Eliminate tail calls
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000254 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
255 MPM.add(createReassociatePass()); // Reassociate expressions
Roman Divackyd2b9a1b2014-11-21 19:53:24 +0000256 // Rotate Loop - disable header duplication at -Oz
257 MPM.add(createLoopRotatePass(SizeLevel == 2 ? 0 : -1));
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000258 MPM.add(createLICMPass()); // Hoist loop invariants
259 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3));
260 MPM.add(createInstructionCombiningPass());
261 MPM.add(createIndVarSimplifyPass()); // Canonicalize indvars
262 MPM.add(createLoopIdiomPass()); // Recognize idioms like memset.
263 MPM.add(createLoopDeletionPass()); // Delete dead loops
Karthik Bhat8210fdf2015-04-23 04:51:44 +0000264 if (EnableLoopInterchange) {
Karthik Bhat88db86d2015-03-06 10:11:25 +0000265 MPM.add(createLoopInterchangePass()); // Interchange loops
Karthik Bhat8210fdf2015-04-23 04:51:44 +0000266 MPM.add(createCFGSimplificationPass());
267 }
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000268 if (!DisableUnrollLoops)
Hal Finkel86b30642014-03-31 23:23:51 +0000269 MPM.add(createSimpleLoopUnrollPass()); // Unroll small loops
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000270 addExtensionsToPM(EP_LoopOptimizerEnd, MPM);
271
Gerolf Hoflehnerf27ae6c2014-07-18 19:13:09 +0000272 if (OptLevel > 1) {
Gerolf Hoflehner24815d92014-09-10 19:55:29 +0000273 if (EnableMLSM)
274 MPM.add(createMergedLoadStoreMotionPass()); // Merge ld/st in diamonds
Rafael Espindola208bc532014-08-21 13:13:17 +0000275 MPM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies
Gerolf Hoflehnerf27ae6c2014-07-18 19:13:09 +0000276 }
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000277 MPM.add(createMemCpyOptPass()); // Remove memcpy / form memset
278 MPM.add(createSCCPPass()); // Constant prop with SCCP
279
Hal Finkel2bb61ba2015-02-17 01:36:59 +0000280 // Delete dead bit computations (instcombine runs after to fold away the dead
281 // computations, and then ADCE will run later to exploit any new DCE
282 // opportunities that creates).
283 MPM.add(createBitTrackingDCEPass()); // Delete dead bit computations
284
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000285 // Run instcombine after redundancy elimination to exploit opportunities
286 // opened up by them.
287 MPM.add(createInstructionCombiningPass());
Peter Collingbourne0a437612014-05-25 10:27:02 +0000288 addExtensionsToPM(EP_Peephole, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000289 MPM.add(createJumpThreadingPass()); // Thread jumps
290 MPM.add(createCorrelatedValuePropagationPass());
291 MPM.add(createDeadStoreEliminationPass()); // Delete dead stores
James Molloy83570242015-02-16 18:59:54 +0000292 MPM.add(createLICMPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000293
294 addExtensionsToPM(EP_ScalarOptimizerLate, MPM);
295
Hal Finkel29aeb202013-11-17 16:02:50 +0000296 if (RerollLoops)
Hal Finkelbf45efd2013-11-16 23:59:05 +0000297 MPM.add(createLoopRerollPass());
James Molloy568da092014-08-06 12:56:19 +0000298 if (!RunSLPAfterLoopVectorization) {
299 if (SLPVectorize)
300 MPM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains.
Nadav Rotemd4dcc002013-04-15 05:39:58 +0000301
James Molloy568da092014-08-06 12:56:19 +0000302 if (BBVectorize) {
303 MPM.add(createBBVectorizePass());
304 MPM.add(createInstructionCombiningPass());
305 addExtensionsToPM(EP_Peephole, MPM);
306 if (OptLevel > 1 && UseGVNAfterVectorization)
Rafael Espindola208bc532014-08-21 13:13:17 +0000307 MPM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies
James Molloy568da092014-08-06 12:56:19 +0000308 else
309 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies
Hal Finkelbf4db4f2013-01-29 00:22:49 +0000310
James Molloy568da092014-08-06 12:56:19 +0000311 // BBVectorize may have significantly shortened a loop body; unroll again.
312 if (!DisableUnrollLoops)
313 MPM.add(createLoopUnrollPass());
314 }
Hal Finkelc34e5112012-02-01 03:51:43 +0000315 }
316
Michael J. Spencer289067c2014-05-29 01:55:07 +0000317 if (LoadCombine)
318 MPM.add(createLoadCombinePass());
319
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000320 MPM.add(createAggressiveDCEPass()); // Delete dead instructions
Tom Stellardaa664d92013-08-06 02:43:45 +0000321 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000322 MPM.add(createInstructionCombiningPass()); // Clean up after everything.
Peter Collingbourne0a437612014-05-25 10:27:02 +0000323 addExtensionsToPM(EP_Peephole, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000324
Renato Golin729a3ae2013-12-05 21:20:02 +0000325 // FIXME: This is a HACK! The inliner pass above implicitly creates a CGSCC
326 // pass manager that we are specifically trying to avoid. To prevent this
327 // we must insert a no-op module pass to reset the pass manager.
328 MPM.add(createBarrierNoopPass());
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000329
Chandler Carruth08eebe22015-07-23 09:34:01 +0000330 if (EnableNonLTOGlobalsModRef)
331 // We add a fresh GlobalsModRef run at this point. This is particularly
332 // useful as the above will have inlined, DCE'ed, and function-attr
333 // propagated everything. We should at this point have a reasonably minimal
334 // and richly annotated call graph. By computing aliasing and mod/ref
335 // information for all local globals here, the late loop passes and notably
336 // the vectorizer will be able to use them to help recognize vectorizable
337 // memory operations.
338 //
339 // Note that this relies on a bug in the pass manager which preserves
340 // a module analysis into a function pass pipeline (and throughout it) so
341 // long as the first function pass doesn't invalidate the module analysis.
342 // Thus both Float2Int and LoopRotate have to preserve AliasAnalysis for
343 // this to work. Fortunately, it is trivial to preserve AliasAnalysis
344 // (doing nothing preserves it as it is required to be conservatively
345 // correct in the face of IR changes).
346 MPM.add(createGlobalsModRefPass());
347
James Molloy0cbb2a862015-03-27 10:36:57 +0000348 if (RunFloat2Int)
349 MPM.add(createFloat2IntPass());
350
Tobias Grosser39a7bd12015-07-16 08:20:37 +0000351 addExtensionsToPM(EP_VectorizerStart, MPM);
352
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000353 // Re-rotate loops in all our loop nests. These may have fallout out of
354 // rotated form due to GVN or other transformations, and the vectorizer relies
Alexey Bataevda33d802015-07-10 10:37:09 +0000355 // on the rotated form. Disable header duplication at -Oz.
356 MPM.add(createLoopRotatePass(SizeLevel == 2 ? 0 : -1));
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000357
Adam Nemet938d3d62015-05-14 12:05:18 +0000358 // Distribute loops to allow partial vectorization. I.e. isolate dependences
359 // into separate loop that would otherwise inhibit vectorization.
360 if (EnableLoopDistribute)
361 MPM.add(createLoopDistributePass());
362
Renato Golin729a3ae2013-12-05 21:20:02 +0000363 MPM.add(createLoopVectorizePass(DisableUnrollLoops, LoopVectorize));
364 // FIXME: Because of #pragma vectorize enable, the passes below are always
365 // inserted in the pipeline, even when the vectorizer doesn't run (ex. when
366 // on -O1 and no #pragma is found). Would be good to have these two passes
367 // as function calls, so that we can only pass them when the vectorizer
368 // changed the code.
369 MPM.add(createInstructionCombiningPass());
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000370 if (OptLevel > 1 && ExtraVectorizerPasses) {
371 // At higher optimization levels, try to clean up any runtime overlap and
372 // alignment checks inserted by the vectorizer. We want to track correllated
373 // runtime checks for two inner loops in the same outer loop, fold any
374 // common computations, hoist loop-invariant aspects out of any outer loop,
375 // and unswitch the runtime checks if possible. Once hoisted, we may have
376 // dead (or speculatable) control flows or more combining opportunities.
377 MPM.add(createEarlyCSEPass());
378 MPM.add(createCorrelatedValuePropagationPass());
379 MPM.add(createInstructionCombiningPass());
380 MPM.add(createLICMPass());
381 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3));
382 MPM.add(createCFGSimplificationPass());
383 MPM.add(createInstructionCombiningPass());
384 }
James Molloy568da092014-08-06 12:56:19 +0000385
386 if (RunSLPAfterLoopVectorization) {
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000387 if (SLPVectorize) {
James Molloy568da092014-08-06 12:56:19 +0000388 MPM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains.
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000389 if (OptLevel > 1 && ExtraVectorizerPasses) {
390 MPM.add(createEarlyCSEPass());
391 }
392 }
James Molloy568da092014-08-06 12:56:19 +0000393
394 if (BBVectorize) {
395 MPM.add(createBBVectorizePass());
396 MPM.add(createInstructionCombiningPass());
397 addExtensionsToPM(EP_Peephole, MPM);
398 if (OptLevel > 1 && UseGVNAfterVectorization)
Rafael Espindola208bc532014-08-21 13:13:17 +0000399 MPM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies
James Molloy568da092014-08-06 12:56:19 +0000400 else
401 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies
402
403 // BBVectorize may have significantly shortened a loop body; unroll again.
404 if (!DisableUnrollLoops)
405 MPM.add(createLoopUnrollPass());
406 }
407 }
408
Peter Collingbourne0a437612014-05-25 10:27:02 +0000409 addExtensionsToPM(EP_Peephole, MPM);
Renato Golin729a3ae2013-12-05 21:20:02 +0000410 MPM.add(createCFGSimplificationPass());
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000411 MPM.add(createInstructionCombiningPass());
Chandler Carruth08e1b872013-06-24 07:21:47 +0000412
Kevin Qin49bc7642015-03-12 05:36:01 +0000413 if (!DisableUnrollLoops) {
Hal Finkel86b30642014-03-31 23:23:51 +0000414 MPM.add(createLoopUnrollPass()); // Unroll small loops
415
Wei Mibf727ba2015-05-14 22:02:54 +0000416 // LoopUnroll may generate some redundency to cleanup.
417 MPM.add(createInstructionCombiningPass());
418
Kevin Qin49bc7642015-03-12 05:36:01 +0000419 // Runtime unrolling will introduce runtime check in loop prologue. If the
420 // unrolled loop is a inner loop, then the prologue will be inside the
421 // outer loop. LICM pass can help to promote the runtime check out if the
422 // checked value is loop invariant.
423 MPM.add(createLICMPass());
424 }
425
Hal Finkeld67e4632014-09-07 20:05:11 +0000426 // After vectorization and unrolling, assume intrinsics may tell us more
427 // about pointer alignments.
428 MPM.add(createAlignmentFromAssumptionsPass());
429
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000430 if (!DisableUnitAtATime) {
431 // FIXME: We shouldn't bother with this anymore.
432 MPM.add(createStripDeadPrototypesPass()); // Get rid of dead prototypes
433
Evan Cheng8c6b06d2012-09-28 21:23:26 +0000434 // GlobalOpt already deletes dead functions and globals, at -O2 try a
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000435 // late pass of GlobalDCE. It is capable of deleting dead cycles.
Evan Cheng8c6b06d2012-09-28 21:23:26 +0000436 if (OptLevel > 1) {
Teresa Johnsond3a33a12015-07-06 16:22:42 +0000437 if (!PrepareForLTO) {
438 // Remove avail extern fns and globals definitions if we aren't
439 // compiling an object file for later LTO. For LTO we want to preserve
440 // these so they are eligible for inlining at link-time. Note if they
441 // are unreferenced they will be removed by GlobalDCE below, so
442 // this only impacts referenced available externally globals.
443 // Eventually they will be suppressed during codegen, but eliminating
444 // here enables more opportunity for GlobalDCE as it may make
445 // globals referenced by available external functions dead.
446 MPM.add(createEliminateAvailableExternallyPass());
447 }
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000448 MPM.add(createGlobalDCEPass()); // Remove dead fns and globals.
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000449 MPM.add(createConstantMergePass()); // Merge dup global constants
Evan Cheng8c6b06d2012-09-28 21:23:26 +0000450 }
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000451 }
Nick Lewycky9e6d1842014-09-13 21:46:00 +0000452
453 if (MergeFunctions)
454 MPM.add(createMergeFunctionsPass());
455
Kostya Serebryanye505a5a2012-03-23 23:22:59 +0000456 addExtensionsToPM(EP_OptimizerLast, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000457}
458
Chandler Carruth30d69c22015-02-13 10:01:29 +0000459void PassManagerBuilder::addLTOOptimizationPasses(legacy::PassManagerBase &PM) {
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000460 // Provide AliasAnalysis services for optimizations.
461 addInitialAliasAnalysisPasses(PM);
462
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000463 // Propagate constants at call sites into the functions they call. This
464 // opens opportunities for globalopt (and inlining) by substituting function
465 // pointers passed as arguments to direct uses of functions.
466 PM.add(createIPSCCPPass());
467
468 // Now that we internalized some globals, see if we can hack on them!
469 PM.add(createGlobalOptimizerPass());
470
471 // Linking modules together can lead to duplicated global constants, only
472 // keep one copy of each constant.
473 PM.add(createConstantMergePass());
474
475 // Remove unused arguments from functions.
476 PM.add(createDeadArgEliminationPass());
477
478 // Reduce the code after globalopt and ipsccp. Both can open up significant
479 // simplification opportunities, and both can propagate functions through
480 // function pointers. When this happens, we often have to resolve varargs
481 // calls, etc, so let instcombine do this.
482 PM.add(createInstructionCombiningPass());
Peter Collingbourne0a437612014-05-25 10:27:02 +0000483 addExtensionsToPM(EP_Peephole, PM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000484
485 // Inline small functions
Rafael Espindolae07caad2014-08-21 13:35:30 +0000486 bool RunInliner = Inliner;
487 if (RunInliner) {
488 PM.add(Inliner);
489 Inliner = nullptr;
490 }
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000491
492 PM.add(createPruneEHPass()); // Remove dead EH info.
493
494 // Optimize globals again if we ran the inliner.
495 if (RunInliner)
496 PM.add(createGlobalOptimizerPass());
497 PM.add(createGlobalDCEPass()); // Remove dead functions.
498
499 // If we didn't decide to inline a function, check to see if we can
500 // transform it to pass arguments by value instead of by reference.
501 PM.add(createArgumentPromotionPass());
502
503 // The IPO passes may leave cruft around. Clean up after them.
504 PM.add(createInstructionCombiningPass());
Peter Collingbourne0a437612014-05-25 10:27:02 +0000505 addExtensionsToPM(EP_Peephole, PM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000506 PM.add(createJumpThreadingPass());
Bill Wendling4c0d9ad2013-08-30 00:48:37 +0000507
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000508 // Break up allocas
Chandler Carruth1b398ae2012-09-14 09:22:59 +0000509 if (UseNewSROA)
510 PM.add(createSROAPass());
511 else
512 PM.add(createScalarReplAggregatesPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000513
514 // Run a few AA driven optimizations here and now, to cleanup the code.
515 PM.add(createFunctionAttrsPass()); // Add nocapture.
516 PM.add(createGlobalsModRefPass()); // IP alias analysis.
517
Bill Wendling932b9922012-04-02 22:16:50 +0000518 PM.add(createLICMPass()); // Hoist loop invariants.
Gerolf Hoflehner24815d92014-09-10 19:55:29 +0000519 if (EnableMLSM)
520 PM.add(createMergedLoadStoreMotionPass()); // Merge ld/st in diamonds.
Bill Wendling932b9922012-04-02 22:16:50 +0000521 PM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies.
522 PM.add(createMemCpyOptPass()); // Remove dead memcpys.
Bill Wendling4c0d9ad2013-08-30 00:48:37 +0000523
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000524 // Nuke dead stores.
525 PM.add(createDeadStoreEliminationPass());
526
Duncan P. N. Exon Smith2b691892014-04-15 17:48:15 +0000527 // More loops are countable; try to optimize them.
528 PM.add(createIndVarSimplifyPass());
529 PM.add(createLoopDeletionPass());
Karthik Bhat88db86d2015-03-06 10:11:25 +0000530 if (EnableLoopInterchange)
531 PM.add(createLoopInterchangePass());
532
Arnold Schwaighofereb1a38f2014-10-26 21:50:58 +0000533 PM.add(createLoopVectorizePass(true, LoopVectorize));
Arnold Schwaighofer6ccda922014-02-24 18:19:31 +0000534
Yi Jiang79eb0aa2014-05-05 23:14:46 +0000535 // More scalar chains could be vectorized due to more alias information
JF Bastienf42a6ea2014-10-21 23:18:21 +0000536 if (RunSLPAfterLoopVectorization)
537 if (SLPVectorize)
538 PM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains.
Yi Jiang79eb0aa2014-05-05 23:14:46 +0000539
Hal Finkeld67e4632014-09-07 20:05:11 +0000540 // After vectorization, assume intrinsics may tell us more about pointer
541 // alignments.
542 PM.add(createAlignmentFromAssumptionsPass());
543
Michael J. Spencer289067c2014-05-29 01:55:07 +0000544 if (LoadCombine)
545 PM.add(createLoadCombinePass());
546
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000547 // Cleanup and simplify the code after the scalar optimizations.
548 PM.add(createInstructionCombiningPass());
Peter Collingbourne0a437612014-05-25 10:27:02 +0000549 addExtensionsToPM(EP_Peephole, PM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000550
551 PM.add(createJumpThreadingPass());
Peter Collingbourne070843d2015-03-19 22:01:00 +0000552}
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000553
Peter Collingbourne070843d2015-03-19 22:01:00 +0000554void PassManagerBuilder::addLateLTOOptimizationPasses(
555 legacy::PassManagerBase &PM) {
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000556 // Delete basic blocks, which optimization passes may have killed.
Tom Stellardaa664d92013-08-06 02:43:45 +0000557 PM.add(createCFGSimplificationPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000558
559 // Now that we have optimized the program, discard unreachable functions.
560 PM.add(createGlobalDCEPass());
Nick Lewycky9e6d1842014-09-13 21:46:00 +0000561
562 // FIXME: this is profitable (for compiler time) to do at -O0 too, but
563 // currently it damages debug info.
564 if (MergeFunctions)
565 PM.add(createMergeFunctionsPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000566}
Rafael Espindola07f609152011-08-09 22:17:34 +0000567
Chandler Carruth30d69c22015-02-13 10:01:29 +0000568void PassManagerBuilder::populateLTOPassManager(legacy::PassManagerBase &PM) {
Rafael Espindola7cebf362014-08-21 20:03:44 +0000569 if (LibraryInfo)
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000570 PM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo));
Rafael Espindola7cebf362014-08-21 20:03:44 +0000571
Duncan P. N. Exon Smithab58a562015-03-19 22:24:17 +0000572 if (VerifyInput)
Rafael Espindola7cebf362014-08-21 20:03:44 +0000573 PM.add(createVerifierPass());
Rafael Espindola7cebf362014-08-21 20:03:44 +0000574
Peter Collingbourne070843d2015-03-19 22:01:00 +0000575 if (OptLevel > 1)
Rafael Espindola7cebf362014-08-21 20:03:44 +0000576 addLTOOptimizationPasses(PM);
577
Peter Collingbourne070843d2015-03-19 22:01:00 +0000578 // Lower bit sets to globals. This pass supports Clang's control flow
579 // integrity mechanisms (-fsanitize=cfi*) and needs to run at link time if CFI
580 // is enabled. The pass does nothing if CFI is disabled.
581 PM.add(createLowerBitSetsPass());
582
583 if (OptLevel != 0)
584 addLateLTOOptimizationPasses(PM);
585
Duncan P. N. Exon Smithab58a562015-03-19 22:24:17 +0000586 if (VerifyOutput)
Rafael Espindola7cebf362014-08-21 20:03:44 +0000587 PM.add(createVerifierPass());
Rafael Espindola7cebf362014-08-21 20:03:44 +0000588}
589
Eric Christopher04d4e932013-04-22 22:47:22 +0000590inline PassManagerBuilder *unwrap(LLVMPassManagerBuilderRef P) {
591 return reinterpret_cast<PassManagerBuilder*>(P);
592}
593
594inline LLVMPassManagerBuilderRef wrap(PassManagerBuilder *P) {
595 return reinterpret_cast<LLVMPassManagerBuilderRef>(P);
596}
597
Dmitri Gribenko0011bbf2012-11-15 16:51:49 +0000598LLVMPassManagerBuilderRef LLVMPassManagerBuilderCreate() {
Rafael Espindola07f609152011-08-09 22:17:34 +0000599 PassManagerBuilder *PMB = new PassManagerBuilder();
600 return wrap(PMB);
601}
602
603void LLVMPassManagerBuilderDispose(LLVMPassManagerBuilderRef PMB) {
604 PassManagerBuilder *Builder = unwrap(PMB);
605 delete Builder;
606}
607
608void
609LLVMPassManagerBuilderSetOptLevel(LLVMPassManagerBuilderRef PMB,
610 unsigned OptLevel) {
611 PassManagerBuilder *Builder = unwrap(PMB);
612 Builder->OptLevel = OptLevel;
613}
614
615void
616LLVMPassManagerBuilderSetSizeLevel(LLVMPassManagerBuilderRef PMB,
617 unsigned SizeLevel) {
618 PassManagerBuilder *Builder = unwrap(PMB);
619 Builder->SizeLevel = SizeLevel;
620}
621
622void
623LLVMPassManagerBuilderSetDisableUnitAtATime(LLVMPassManagerBuilderRef PMB,
624 LLVMBool Value) {
625 PassManagerBuilder *Builder = unwrap(PMB);
626 Builder->DisableUnitAtATime = Value;
627}
628
629void
630LLVMPassManagerBuilderSetDisableUnrollLoops(LLVMPassManagerBuilderRef PMB,
631 LLVMBool Value) {
632 PassManagerBuilder *Builder = unwrap(PMB);
633 Builder->DisableUnrollLoops = Value;
634}
635
636void
637LLVMPassManagerBuilderSetDisableSimplifyLibCalls(LLVMPassManagerBuilderRef PMB,
638 LLVMBool Value) {
Meador Ingedfb08a22013-06-20 19:48:07 +0000639 // NOTE: The simplify-libcalls pass has been removed.
Rafael Espindola07f609152011-08-09 22:17:34 +0000640}
641
642void
643LLVMPassManagerBuilderUseInlinerWithThreshold(LLVMPassManagerBuilderRef PMB,
644 unsigned Threshold) {
645 PassManagerBuilder *Builder = unwrap(PMB);
646 Builder->Inliner = createFunctionInliningPass(Threshold);
647}
648
649void
650LLVMPassManagerBuilderPopulateFunctionPassManager(LLVMPassManagerBuilderRef PMB,
651 LLVMPassManagerRef PM) {
652 PassManagerBuilder *Builder = unwrap(PMB);
Chandler Carruth30d69c22015-02-13 10:01:29 +0000653 legacy::FunctionPassManager *FPM = unwrap<legacy::FunctionPassManager>(PM);
Rafael Espindola07f609152011-08-09 22:17:34 +0000654 Builder->populateFunctionPassManager(*FPM);
655}
656
657void
658LLVMPassManagerBuilderPopulateModulePassManager(LLVMPassManagerBuilderRef PMB,
659 LLVMPassManagerRef PM) {
660 PassManagerBuilder *Builder = unwrap(PMB);
Chandler Carruth30d69c22015-02-13 10:01:29 +0000661 legacy::PassManagerBase *MPM = unwrap(PM);
Rafael Espindola07f609152011-08-09 22:17:34 +0000662 Builder->populateModulePassManager(*MPM);
663}
664
665void LLVMPassManagerBuilderPopulateLTOPassManager(LLVMPassManagerBuilderRef PMB,
666 LLVMPassManagerRef PM,
Nick Lewycky5f508542013-03-10 21:58:22 +0000667 LLVMBool Internalize,
668 LLVMBool RunInliner) {
Rafael Espindola07f609152011-08-09 22:17:34 +0000669 PassManagerBuilder *Builder = unwrap(PMB);
Chandler Carruth30d69c22015-02-13 10:01:29 +0000670 legacy::PassManagerBase *LPM = unwrap(PM);
Rafael Espindolae07caad2014-08-21 13:35:30 +0000671
672 // A small backwards compatibility hack. populateLTOPassManager used to take
673 // an RunInliner option.
674 if (RunInliner && !Builder->Inliner)
675 Builder->Inliner = createFunctionInliningPass();
676
677 Builder->populateLTOPassManager(*LPM);
Rafael Espindola07f609152011-08-09 22:17:34 +0000678}