blob: 46e221037ca90a12526318fb173e55c260212c3b [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 Carruth62d42152015-01-15 02:16:27 +000025#include "llvm/Analysis/TargetLibraryInfo.h"
Rafael Espindola7cebf362014-08-21 20:03:44 +000026#include "llvm/Target/TargetMachine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000027#include "llvm/Transforms/IPO.h"
Rafael Espindola3ea478b2011-08-02 21:50:27 +000028#include "llvm/Transforms/Scalar.h"
Hal Finkelc34e5112012-02-01 03:51:43 +000029#include "llvm/Transforms/Vectorize.h"
Rafael Espindola3ea478b2011-08-02 21:50:27 +000030
31using namespace llvm;
32
Hal Finkelc34e5112012-02-01 03:51:43 +000033static cl::opt<bool>
Nadav Rotem7f27e0b2013-10-18 23:38:13 +000034RunLoopVectorization("vectorize-loops", cl::Hidden,
Nadav Rotemd3df6652012-10-30 18:37:43 +000035 cl::desc("Run the Loop vectorization passes"));
Nadav Rotemc59ae202012-10-29 16:36:25 +000036
37static cl::opt<bool>
Nadav Rotem7f27e0b2013-10-18 23:38:13 +000038RunSLPVectorization("vectorize-slp", cl::Hidden,
Nadav Rotemd4dcc002013-04-15 05:39:58 +000039 cl::desc("Run the SLP vectorization passes"));
40
41static cl::opt<bool>
Nadav Rotem7f27e0b2013-10-18 23:38:13 +000042RunBBVectorization("vectorize-slp-aggressive", cl::Hidden,
Nadav Rotemd4dcc002013-04-15 05:39:58 +000043 cl::desc("Run the BB vectorization passes"));
Hal Finkelc34e5112012-02-01 03:51:43 +000044
Hal Finkel204bf532012-04-13 17:15:33 +000045static cl::opt<bool>
46UseGVNAfterVectorization("use-gvn-after-vectorization",
47 cl::init(false), cl::Hidden,
48 cl::desc("Run GVN instead of Early CSE after vectorization passes"));
49
Chandler Carruth7b8297a2014-10-14 00:31:29 +000050static cl::opt<bool> ExtraVectorizerPasses(
51 "extra-vectorizer-passes", cl::init(false), cl::Hidden,
52 cl::desc("Run cleanup optimization passes after vectorization."));
53
Chandler Carruth1b398ae2012-09-14 09:22:59 +000054static cl::opt<bool> UseNewSROA("use-new-sroa",
Chandler Carruth4e435992012-10-02 04:24:01 +000055 cl::init(true), cl::Hidden,
Chandler Carruth1b398ae2012-09-14 09:22:59 +000056 cl::desc("Enable the new, experimental SROA pass"));
57
Hal Finkelbf45efd2013-11-16 23:59:05 +000058static cl::opt<bool>
59RunLoopRerolling("reroll-loops", cl::Hidden,
60 cl::desc("Run the loop rerolling pass"));
61
Michael J. Spencer289067c2014-05-29 01:55:07 +000062static cl::opt<bool> RunLoadCombine("combine-loads", cl::init(false),
63 cl::Hidden,
64 cl::desc("Run the load combining pass"));
65
James Molloy568da092014-08-06 12:56:19 +000066static cl::opt<bool>
67RunSLPAfterLoopVectorization("run-slp-after-loop-vectorization",
James Molloy6b95d8e2014-09-04 13:23:08 +000068 cl::init(true), cl::Hidden,
James Molloy568da092014-08-06 12:56:19 +000069 cl::desc("Run the SLP vectorizer (and BB vectorizer) after the Loop "
70 "vectorizer instead of before"));
71
Hal Finkel445dda52014-09-02 22:12:54 +000072static cl::opt<bool> UseCFLAA("use-cfl-aa",
73 cl::init(false), cl::Hidden,
74 cl::desc("Enable the new, experimental CFL alias analysis"));
James Molloy568da092014-08-06 12:56:19 +000075
Gerolf Hoflehner24815d92014-09-10 19:55:29 +000076static cl::opt<bool>
Gerolf Hoflehner008e5cd2014-09-10 20:24:03 +000077EnableMLSM("mlsm", cl::init(true), cl::Hidden,
78 cl::desc("Enable motion of merged load and store"));
Gerolf Hoflehner24815d92014-09-10 19:55:29 +000079
Karthik Bhat88db86d2015-03-06 10:11:25 +000080static cl::opt<bool> EnableLoopInterchange(
81 "enable-loopinterchange", cl::init(false), cl::Hidden,
82 cl::desc("Enable the new, experimental LoopInterchange Pass"));
83
Rafael Espindola3ea478b2011-08-02 21:50:27 +000084PassManagerBuilder::PassManagerBuilder() {
85 OptLevel = 2;
86 SizeLevel = 0;
Craig Topperf40110f2014-04-25 05:29:35 +000087 LibraryInfo = nullptr;
88 Inliner = nullptr;
Duncan P. N. Exon Smith49f3ec82014-04-18 01:05:15 +000089 DisableTailCalls = false;
Rafael Espindola3ea478b2011-08-02 21:50:27 +000090 DisableUnitAtATime = false;
91 DisableUnrollLoops = false;
Nadav Rotemd4dcc002013-04-15 05:39:58 +000092 BBVectorize = RunBBVectorization;
Nadav Rotema1e5e442013-04-15 04:54:42 +000093 SLPVectorize = RunSLPVectorization;
Nadav Rotemc59ae202012-10-29 16:36:25 +000094 LoopVectorize = RunLoopVectorization;
Hal Finkel29aeb202013-11-17 16:02:50 +000095 RerollLoops = RunLoopRerolling;
Michael J. Spencer289067c2014-05-29 01:55:07 +000096 LoadCombine = RunLoadCombine;
Rafael Espindola208bc532014-08-21 13:13:17 +000097 DisableGVNLoadPRE = false;
Rafael Espindola7cebf362014-08-21 20:03:44 +000098 VerifyInput = false;
99 VerifyOutput = false;
Nick Lewycky9e6d1842014-09-13 21:46:00 +0000100 MergeFunctions = false;
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000101}
102
103PassManagerBuilder::~PassManagerBuilder() {
104 delete LibraryInfo;
105 delete Inliner;
106}
107
David Chisnall719a72f2011-08-16 13:58:41 +0000108/// Set of global extensions, automatically added as part of the standard set.
109static ManagedStatic<SmallVector<std::pair<PassManagerBuilder::ExtensionPointTy,
110 PassManagerBuilder::ExtensionFn>, 8> > GlobalExtensions;
111
112void PassManagerBuilder::addGlobalExtension(
113 PassManagerBuilder::ExtensionPointTy Ty,
114 PassManagerBuilder::ExtensionFn Fn) {
115 GlobalExtensions->push_back(std::make_pair(Ty, Fn));
116}
117
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000118void PassManagerBuilder::addExtension(ExtensionPointTy Ty, ExtensionFn Fn) {
119 Extensions.push_back(std::make_pair(Ty, Fn));
120}
121
122void PassManagerBuilder::addExtensionsToPM(ExtensionPointTy ETy,
Chandler Carruth30d69c22015-02-13 10:01:29 +0000123 legacy::PassManagerBase &PM) const {
David Chisnall719a72f2011-08-16 13:58:41 +0000124 for (unsigned i = 0, e = GlobalExtensions->size(); i != e; ++i)
125 if ((*GlobalExtensions)[i].first == ETy)
126 (*GlobalExtensions)[i].second(*this, PM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000127 for (unsigned i = 0, e = Extensions.size(); i != e; ++i)
128 if (Extensions[i].first == ETy)
129 Extensions[i].second(*this, PM);
130}
131
Chandler Carruth30d69c22015-02-13 10:01:29 +0000132void PassManagerBuilder::addInitialAliasAnalysisPasses(
133 legacy::PassManagerBase &PM) const {
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000134 // Add TypeBasedAliasAnalysis before BasicAliasAnalysis so that
135 // BasicAliasAnalysis wins if they disagree. This is intended to help
136 // support "obvious" type-punning idioms.
Hal Finkel445dda52014-09-02 22:12:54 +0000137 if (UseCFLAA)
138 PM.add(createCFLAliasAnalysisPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000139 PM.add(createTypeBasedAliasAnalysisPass());
Hal Finkel94146652014-07-24 14:25:39 +0000140 PM.add(createScopedNoAliasAAPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000141 PM.add(createBasicAliasAnalysisPass());
142}
143
Chandler Carruth30d69c22015-02-13 10:01:29 +0000144void PassManagerBuilder::populateFunctionPassManager(
145 legacy::FunctionPassManager &FPM) {
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000146 addExtensionsToPM(EP_EarlyAsPossible, FPM);
147
148 // Add LibraryInfo if we have some.
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000149 if (LibraryInfo)
150 FPM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo));
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000151
152 if (OptLevel == 0) return;
153
154 addInitialAliasAnalysisPasses(FPM);
155
156 FPM.add(createCFGSimplificationPass());
Chandler Carruth1b398ae2012-09-14 09:22:59 +0000157 if (UseNewSROA)
158 FPM.add(createSROAPass());
159 else
160 FPM.add(createScalarReplAggregatesPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000161 FPM.add(createEarlyCSEPass());
162 FPM.add(createLowerExpectIntrinsicPass());
163}
164
Chandler Carruth30d69c22015-02-13 10:01:29 +0000165void PassManagerBuilder::populateModulePassManager(
166 legacy::PassManagerBase &MPM) {
Nick Lewycky592d8492014-10-23 23:49:31 +0000167 // If all optimizations are disabled, just run the always-inline pass and,
168 // if enabled, the function merging pass.
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000169 if (OptLevel == 0) {
170 if (Inliner) {
171 MPM.add(Inliner);
Craig Topperf40110f2014-04-25 05:29:35 +0000172 Inliner = nullptr;
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000173 }
Chandler Carruthe8479e12012-10-18 08:05:46 +0000174
Nick Lewycky592d8492014-10-23 23:49:31 +0000175 // FIXME: The BarrierNoopPass is a HACK! The inliner pass above implicitly
176 // creates a CGSCC pass manager, but we don't want to add extensions into
177 // that pass manager. To prevent this we insert a no-op module pass to reset
178 // the pass manager to get the same behavior as EP_OptimizerLast in non-O0
179 // builds. The function merging pass is
180 if (MergeFunctions)
181 MPM.add(createMergeFunctionsPass());
182 else if (!GlobalExtensions->empty() || !Extensions.empty())
Chandler Carruthe8479e12012-10-18 08:05:46 +0000183 MPM.add(createBarrierNoopPass());
184
Kostya Serebryanydc436f92011-11-30 22:19:26 +0000185 addExtensionsToPM(EP_EnabledOnOptLevel0, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000186 return;
187 }
188
189 // Add LibraryInfo if we have some.
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000190 if (LibraryInfo)
191 MPM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo));
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000192
193 addInitialAliasAnalysisPasses(MPM);
194
195 if (!DisableUnitAtATime) {
Dan Gohmanb9936292012-01-17 20:51:32 +0000196 addExtensionsToPM(EP_ModuleOptimizerEarly, MPM);
197
Gerolf Hoflehner65b13322014-07-03 19:28:15 +0000198 MPM.add(createIPSCCPPass()); // IP SCCP
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000199 MPM.add(createGlobalOptimizerPass()); // Optimize out global vars
200
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000201 MPM.add(createDeadArgEliminationPass()); // Dead argument elimination
202
203 MPM.add(createInstructionCombiningPass());// Clean up after IPCP & DAE
Peter Collingbourne0a437612014-05-25 10:27:02 +0000204 addExtensionsToPM(EP_Peephole, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000205 MPM.add(createCFGSimplificationPass()); // Clean up after IPCP & DAE
206 }
207
208 // Start of CallGraph SCC passes.
209 if (!DisableUnitAtATime)
210 MPM.add(createPruneEHPass()); // Remove dead EH info
211 if (Inliner) {
212 MPM.add(Inliner);
Craig Topperf40110f2014-04-25 05:29:35 +0000213 Inliner = nullptr;
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000214 }
215 if (!DisableUnitAtATime)
216 MPM.add(createFunctionAttrsPass()); // Set readonly/readnone attrs
217 if (OptLevel > 2)
218 MPM.add(createArgumentPromotionPass()); // Scalarize uninlined fn args
219
220 // Start of function pass.
221 // Break up aggregate allocas, using SSAUpdater.
Chandler Carruth70b44c52012-09-15 11:43:14 +0000222 if (UseNewSROA)
223 MPM.add(createSROAPass(/*RequiresDomTree*/ false));
224 else
225 MPM.add(createScalarReplAggregatesPass(-1, false));
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000226 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000227 MPM.add(createJumpThreadingPass()); // Thread jumps.
228 MPM.add(createCorrelatedValuePropagationPass()); // Propagate conditionals
229 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
230 MPM.add(createInstructionCombiningPass()); // Combine silly seq's
Peter Collingbourne0a437612014-05-25 10:27:02 +0000231 addExtensionsToPM(EP_Peephole, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000232
Duncan P. N. Exon Smith49f3ec82014-04-18 01:05:15 +0000233 if (!DisableTailCalls)
234 MPM.add(createTailCallEliminationPass()); // Eliminate tail calls
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000235 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
236 MPM.add(createReassociatePass()); // Reassociate expressions
Roman Divackyd2b9a1b2014-11-21 19:53:24 +0000237 // Rotate Loop - disable header duplication at -Oz
238 MPM.add(createLoopRotatePass(SizeLevel == 2 ? 0 : -1));
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000239 MPM.add(createLICMPass()); // Hoist loop invariants
240 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3));
241 MPM.add(createInstructionCombiningPass());
242 MPM.add(createIndVarSimplifyPass()); // Canonicalize indvars
243 MPM.add(createLoopIdiomPass()); // Recognize idioms like memset.
244 MPM.add(createLoopDeletionPass()); // Delete dead loops
Karthik Bhat88db86d2015-03-06 10:11:25 +0000245 if (EnableLoopInterchange)
246 MPM.add(createLoopInterchangePass()); // Interchange loops
Nadav Rotem6b94c2a2012-10-17 18:25:06 +0000247
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000248 if (!DisableUnrollLoops)
Hal Finkel86b30642014-03-31 23:23:51 +0000249 MPM.add(createSimpleLoopUnrollPass()); // Unroll small loops
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000250 addExtensionsToPM(EP_LoopOptimizerEnd, MPM);
251
Gerolf Hoflehnerf27ae6c2014-07-18 19:13:09 +0000252 if (OptLevel > 1) {
Gerolf Hoflehner24815d92014-09-10 19:55:29 +0000253 if (EnableMLSM)
254 MPM.add(createMergedLoadStoreMotionPass()); // Merge ld/st in diamonds
Rafael Espindola208bc532014-08-21 13:13:17 +0000255 MPM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies
Gerolf Hoflehnerf27ae6c2014-07-18 19:13:09 +0000256 }
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000257 MPM.add(createMemCpyOptPass()); // Remove memcpy / form memset
258 MPM.add(createSCCPPass()); // Constant prop with SCCP
259
Hal Finkel2bb61ba2015-02-17 01:36:59 +0000260 // Delete dead bit computations (instcombine runs after to fold away the dead
261 // computations, and then ADCE will run later to exploit any new DCE
262 // opportunities that creates).
263 MPM.add(createBitTrackingDCEPass()); // Delete dead bit computations
264
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000265 // Run instcombine after redundancy elimination to exploit opportunities
266 // opened up by them.
267 MPM.add(createInstructionCombiningPass());
Peter Collingbourne0a437612014-05-25 10:27:02 +0000268 addExtensionsToPM(EP_Peephole, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000269 MPM.add(createJumpThreadingPass()); // Thread jumps
270 MPM.add(createCorrelatedValuePropagationPass());
271 MPM.add(createDeadStoreEliminationPass()); // Delete dead stores
James Molloy83570242015-02-16 18:59:54 +0000272 MPM.add(createLICMPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000273
274 addExtensionsToPM(EP_ScalarOptimizerLate, MPM);
275
Hal Finkel29aeb202013-11-17 16:02:50 +0000276 if (RerollLoops)
Hal Finkelbf45efd2013-11-16 23:59:05 +0000277 MPM.add(createLoopRerollPass());
James Molloy568da092014-08-06 12:56:19 +0000278 if (!RunSLPAfterLoopVectorization) {
279 if (SLPVectorize)
280 MPM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains.
Nadav Rotemd4dcc002013-04-15 05:39:58 +0000281
James Molloy568da092014-08-06 12:56:19 +0000282 if (BBVectorize) {
283 MPM.add(createBBVectorizePass());
284 MPM.add(createInstructionCombiningPass());
285 addExtensionsToPM(EP_Peephole, MPM);
286 if (OptLevel > 1 && UseGVNAfterVectorization)
Rafael Espindola208bc532014-08-21 13:13:17 +0000287 MPM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies
James Molloy568da092014-08-06 12:56:19 +0000288 else
289 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies
Hal Finkelbf4db4f2013-01-29 00:22:49 +0000290
James Molloy568da092014-08-06 12:56:19 +0000291 // BBVectorize may have significantly shortened a loop body; unroll again.
292 if (!DisableUnrollLoops)
293 MPM.add(createLoopUnrollPass());
294 }
Hal Finkelc34e5112012-02-01 03:51:43 +0000295 }
296
Michael J. Spencer289067c2014-05-29 01:55:07 +0000297 if (LoadCombine)
298 MPM.add(createLoadCombinePass());
299
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000300 MPM.add(createAggressiveDCEPass()); // Delete dead instructions
Tom Stellardaa664d92013-08-06 02:43:45 +0000301 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000302 MPM.add(createInstructionCombiningPass()); // Clean up after everything.
Peter Collingbourne0a437612014-05-25 10:27:02 +0000303 addExtensionsToPM(EP_Peephole, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000304
Renato Golin729a3ae2013-12-05 21:20:02 +0000305 // FIXME: This is a HACK! The inliner pass above implicitly creates a CGSCC
306 // pass manager that we are specifically trying to avoid. To prevent this
307 // we must insert a no-op module pass to reset the pass manager.
308 MPM.add(createBarrierNoopPass());
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000309
310 // Re-rotate loops in all our loop nests. These may have fallout out of
311 // rotated form due to GVN or other transformations, and the vectorizer relies
312 // on the rotated form.
Michael Zolotukhin267e12f2015-03-10 19:07:41 +0000313 MPM.add(createLoopRotatePass());
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000314
Renato Golin729a3ae2013-12-05 21:20:02 +0000315 MPM.add(createLoopVectorizePass(DisableUnrollLoops, LoopVectorize));
316 // FIXME: Because of #pragma vectorize enable, the passes below are always
317 // inserted in the pipeline, even when the vectorizer doesn't run (ex. when
318 // on -O1 and no #pragma is found). Would be good to have these two passes
319 // as function calls, so that we can only pass them when the vectorizer
320 // changed the code.
321 MPM.add(createInstructionCombiningPass());
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000322 if (OptLevel > 1 && ExtraVectorizerPasses) {
323 // At higher optimization levels, try to clean up any runtime overlap and
324 // alignment checks inserted by the vectorizer. We want to track correllated
325 // runtime checks for two inner loops in the same outer loop, fold any
326 // common computations, hoist loop-invariant aspects out of any outer loop,
327 // and unswitch the runtime checks if possible. Once hoisted, we may have
328 // dead (or speculatable) control flows or more combining opportunities.
329 MPM.add(createEarlyCSEPass());
330 MPM.add(createCorrelatedValuePropagationPass());
331 MPM.add(createInstructionCombiningPass());
332 MPM.add(createLICMPass());
333 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3));
334 MPM.add(createCFGSimplificationPass());
335 MPM.add(createInstructionCombiningPass());
336 }
James Molloy568da092014-08-06 12:56:19 +0000337
338 if (RunSLPAfterLoopVectorization) {
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000339 if (SLPVectorize) {
James Molloy568da092014-08-06 12:56:19 +0000340 MPM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains.
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000341 if (OptLevel > 1 && ExtraVectorizerPasses) {
342 MPM.add(createEarlyCSEPass());
343 }
344 }
James Molloy568da092014-08-06 12:56:19 +0000345
346 if (BBVectorize) {
347 MPM.add(createBBVectorizePass());
348 MPM.add(createInstructionCombiningPass());
349 addExtensionsToPM(EP_Peephole, MPM);
350 if (OptLevel > 1 && UseGVNAfterVectorization)
Rafael Espindola208bc532014-08-21 13:13:17 +0000351 MPM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies
James Molloy568da092014-08-06 12:56:19 +0000352 else
353 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies
354
355 // BBVectorize may have significantly shortened a loop body; unroll again.
356 if (!DisableUnrollLoops)
357 MPM.add(createLoopUnrollPass());
358 }
359 }
360
Peter Collingbourne0a437612014-05-25 10:27:02 +0000361 addExtensionsToPM(EP_Peephole, MPM);
Renato Golin729a3ae2013-12-05 21:20:02 +0000362 MPM.add(createCFGSimplificationPass());
Chandler Carruth7b8297a2014-10-14 00:31:29 +0000363 MPM.add(createInstructionCombiningPass());
Chandler Carruth08e1b872013-06-24 07:21:47 +0000364
Kevin Qin49bc7642015-03-12 05:36:01 +0000365 if (!DisableUnrollLoops) {
Hal Finkel86b30642014-03-31 23:23:51 +0000366 MPM.add(createLoopUnrollPass()); // Unroll small loops
367
Kevin Qin49bc7642015-03-12 05:36:01 +0000368 // This is a barrier pass to avoid combine LICM pass and loop unroll pass
369 // within same loop pass manager.
370 MPM.add(createInstructionSimplifierPass());
371
372 // Runtime unrolling will introduce runtime check in loop prologue. If the
373 // unrolled loop is a inner loop, then the prologue will be inside the
374 // outer loop. LICM pass can help to promote the runtime check out if the
375 // checked value is loop invariant.
376 MPM.add(createLICMPass());
377 }
378
Hal Finkeld67e4632014-09-07 20:05:11 +0000379 // After vectorization and unrolling, assume intrinsics may tell us more
380 // about pointer alignments.
381 MPM.add(createAlignmentFromAssumptionsPass());
382
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000383 if (!DisableUnitAtATime) {
384 // FIXME: We shouldn't bother with this anymore.
385 MPM.add(createStripDeadPrototypesPass()); // Get rid of dead prototypes
386
Evan Cheng8c6b06d2012-09-28 21:23:26 +0000387 // GlobalOpt already deletes dead functions and globals, at -O2 try a
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000388 // late pass of GlobalDCE. It is capable of deleting dead cycles.
Evan Cheng8c6b06d2012-09-28 21:23:26 +0000389 if (OptLevel > 1) {
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000390 MPM.add(createGlobalDCEPass()); // Remove dead fns and globals.
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000391 MPM.add(createConstantMergePass()); // Merge dup global constants
Evan Cheng8c6b06d2012-09-28 21:23:26 +0000392 }
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000393 }
Nick Lewycky9e6d1842014-09-13 21:46:00 +0000394
395 if (MergeFunctions)
396 MPM.add(createMergeFunctionsPass());
397
Kostya Serebryanye505a5a2012-03-23 23:22:59 +0000398 addExtensionsToPM(EP_OptimizerLast, MPM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000399}
400
Chandler Carruth30d69c22015-02-13 10:01:29 +0000401void PassManagerBuilder::addLTOOptimizationPasses(legacy::PassManagerBase &PM) {
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000402 // Provide AliasAnalysis services for optimizations.
403 addInitialAliasAnalysisPasses(PM);
404
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000405 // Propagate constants at call sites into the functions they call. This
406 // opens opportunities for globalopt (and inlining) by substituting function
407 // pointers passed as arguments to direct uses of functions.
408 PM.add(createIPSCCPPass());
409
410 // Now that we internalized some globals, see if we can hack on them!
411 PM.add(createGlobalOptimizerPass());
412
413 // Linking modules together can lead to duplicated global constants, only
414 // keep one copy of each constant.
415 PM.add(createConstantMergePass());
416
417 // Remove unused arguments from functions.
418 PM.add(createDeadArgEliminationPass());
419
420 // Reduce the code after globalopt and ipsccp. Both can open up significant
421 // simplification opportunities, and both can propagate functions through
422 // function pointers. When this happens, we often have to resolve varargs
423 // calls, etc, so let instcombine do this.
424 PM.add(createInstructionCombiningPass());
Peter Collingbourne0a437612014-05-25 10:27:02 +0000425 addExtensionsToPM(EP_Peephole, PM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000426
427 // Inline small functions
Rafael Espindolae07caad2014-08-21 13:35:30 +0000428 bool RunInliner = Inliner;
429 if (RunInliner) {
430 PM.add(Inliner);
431 Inliner = nullptr;
432 }
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000433
434 PM.add(createPruneEHPass()); // Remove dead EH info.
435
436 // Optimize globals again if we ran the inliner.
437 if (RunInliner)
438 PM.add(createGlobalOptimizerPass());
439 PM.add(createGlobalDCEPass()); // Remove dead functions.
440
441 // If we didn't decide to inline a function, check to see if we can
442 // transform it to pass arguments by value instead of by reference.
443 PM.add(createArgumentPromotionPass());
444
445 // The IPO passes may leave cruft around. Clean up after them.
446 PM.add(createInstructionCombiningPass());
Peter Collingbourne0a437612014-05-25 10:27:02 +0000447 addExtensionsToPM(EP_Peephole, PM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000448 PM.add(createJumpThreadingPass());
Bill Wendling4c0d9ad2013-08-30 00:48:37 +0000449
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000450 // Break up allocas
Chandler Carruth1b398ae2012-09-14 09:22:59 +0000451 if (UseNewSROA)
452 PM.add(createSROAPass());
453 else
454 PM.add(createScalarReplAggregatesPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000455
456 // Run a few AA driven optimizations here and now, to cleanup the code.
457 PM.add(createFunctionAttrsPass()); // Add nocapture.
458 PM.add(createGlobalsModRefPass()); // IP alias analysis.
459
Bill Wendling932b9922012-04-02 22:16:50 +0000460 PM.add(createLICMPass()); // Hoist loop invariants.
Gerolf Hoflehner24815d92014-09-10 19:55:29 +0000461 if (EnableMLSM)
462 PM.add(createMergedLoadStoreMotionPass()); // Merge ld/st in diamonds.
Bill Wendling932b9922012-04-02 22:16:50 +0000463 PM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies.
464 PM.add(createMemCpyOptPass()); // Remove dead memcpys.
Bill Wendling4c0d9ad2013-08-30 00:48:37 +0000465
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000466 // Nuke dead stores.
467 PM.add(createDeadStoreEliminationPass());
468
Duncan P. N. Exon Smith2b691892014-04-15 17:48:15 +0000469 // More loops are countable; try to optimize them.
470 PM.add(createIndVarSimplifyPass());
471 PM.add(createLoopDeletionPass());
Karthik Bhat88db86d2015-03-06 10:11:25 +0000472 if (EnableLoopInterchange)
473 PM.add(createLoopInterchangePass());
474
Arnold Schwaighofereb1a38f2014-10-26 21:50:58 +0000475 PM.add(createLoopVectorizePass(true, LoopVectorize));
Arnold Schwaighofer6ccda922014-02-24 18:19:31 +0000476
Yi Jiang79eb0aa2014-05-05 23:14:46 +0000477 // More scalar chains could be vectorized due to more alias information
JF Bastienf42a6ea2014-10-21 23:18:21 +0000478 if (RunSLPAfterLoopVectorization)
479 if (SLPVectorize)
480 PM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains.
Yi Jiang79eb0aa2014-05-05 23:14:46 +0000481
Hal Finkeld67e4632014-09-07 20:05:11 +0000482 // After vectorization, assume intrinsics may tell us more about pointer
483 // alignments.
484 PM.add(createAlignmentFromAssumptionsPass());
485
Michael J. Spencer289067c2014-05-29 01:55:07 +0000486 if (LoadCombine)
487 PM.add(createLoadCombinePass());
488
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000489 // Cleanup and simplify the code after the scalar optimizations.
490 PM.add(createInstructionCombiningPass());
Peter Collingbourne0a437612014-05-25 10:27:02 +0000491 addExtensionsToPM(EP_Peephole, PM);
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000492
493 PM.add(createJumpThreadingPass());
Peter Collingbourne070843d2015-03-19 22:01:00 +0000494}
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000495
Peter Collingbourne070843d2015-03-19 22:01:00 +0000496void PassManagerBuilder::addLateLTOOptimizationPasses(
497 legacy::PassManagerBase &PM) {
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000498 // Delete basic blocks, which optimization passes may have killed.
Tom Stellardaa664d92013-08-06 02:43:45 +0000499 PM.add(createCFGSimplificationPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000500
501 // Now that we have optimized the program, discard unreachable functions.
502 PM.add(createGlobalDCEPass());
Nick Lewycky9e6d1842014-09-13 21:46:00 +0000503
504 // FIXME: this is profitable (for compiler time) to do at -O0 too, but
505 // currently it damages debug info.
506 if (MergeFunctions)
507 PM.add(createMergeFunctionsPass());
Rafael Espindola3ea478b2011-08-02 21:50:27 +0000508}
Rafael Espindola07f609152011-08-09 22:17:34 +0000509
Chandler Carruth30d69c22015-02-13 10:01:29 +0000510void PassManagerBuilder::populateLTOPassManager(legacy::PassManagerBase &PM) {
Rafael Espindola7cebf362014-08-21 20:03:44 +0000511 if (LibraryInfo)
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000512 PM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo));
Rafael Espindola7cebf362014-08-21 20:03:44 +0000513
Duncan P. N. Exon Smith0a93e2d2015-03-19 21:37:17 +0000514 if (VerifyInput) {
Rafael Espindola7cebf362014-08-21 20:03:44 +0000515 PM.add(createVerifierPass());
Rafael Espindola7cebf362014-08-21 20:03:44 +0000516 PM.add(createDebugInfoVerifierPass());
Duncan P. N. Exon Smith0a93e2d2015-03-19 21:37:17 +0000517 }
Rafael Espindola7cebf362014-08-21 20:03:44 +0000518
Peter Collingbourne070843d2015-03-19 22:01:00 +0000519 if (OptLevel > 1)
Rafael Espindola7cebf362014-08-21 20:03:44 +0000520 addLTOOptimizationPasses(PM);
521
Peter Collingbourne070843d2015-03-19 22:01:00 +0000522 // Lower bit sets to globals. This pass supports Clang's control flow
523 // integrity mechanisms (-fsanitize=cfi*) and needs to run at link time if CFI
524 // is enabled. The pass does nothing if CFI is disabled.
525 PM.add(createLowerBitSetsPass());
526
527 if (OptLevel != 0)
528 addLateLTOOptimizationPasses(PM);
529
Rafael Espindola7cebf362014-08-21 20:03:44 +0000530 if (VerifyOutput) {
531 PM.add(createVerifierPass());
532 PM.add(createDebugInfoVerifierPass());
533 }
534}
535
Eric Christopher04d4e932013-04-22 22:47:22 +0000536inline PassManagerBuilder *unwrap(LLVMPassManagerBuilderRef P) {
537 return reinterpret_cast<PassManagerBuilder*>(P);
538}
539
540inline LLVMPassManagerBuilderRef wrap(PassManagerBuilder *P) {
541 return reinterpret_cast<LLVMPassManagerBuilderRef>(P);
542}
543
Dmitri Gribenko0011bbf2012-11-15 16:51:49 +0000544LLVMPassManagerBuilderRef LLVMPassManagerBuilderCreate() {
Rafael Espindola07f609152011-08-09 22:17:34 +0000545 PassManagerBuilder *PMB = new PassManagerBuilder();
546 return wrap(PMB);
547}
548
549void LLVMPassManagerBuilderDispose(LLVMPassManagerBuilderRef PMB) {
550 PassManagerBuilder *Builder = unwrap(PMB);
551 delete Builder;
552}
553
554void
555LLVMPassManagerBuilderSetOptLevel(LLVMPassManagerBuilderRef PMB,
556 unsigned OptLevel) {
557 PassManagerBuilder *Builder = unwrap(PMB);
558 Builder->OptLevel = OptLevel;
559}
560
561void
562LLVMPassManagerBuilderSetSizeLevel(LLVMPassManagerBuilderRef PMB,
563 unsigned SizeLevel) {
564 PassManagerBuilder *Builder = unwrap(PMB);
565 Builder->SizeLevel = SizeLevel;
566}
567
568void
569LLVMPassManagerBuilderSetDisableUnitAtATime(LLVMPassManagerBuilderRef PMB,
570 LLVMBool Value) {
571 PassManagerBuilder *Builder = unwrap(PMB);
572 Builder->DisableUnitAtATime = Value;
573}
574
575void
576LLVMPassManagerBuilderSetDisableUnrollLoops(LLVMPassManagerBuilderRef PMB,
577 LLVMBool Value) {
578 PassManagerBuilder *Builder = unwrap(PMB);
579 Builder->DisableUnrollLoops = Value;
580}
581
582void
583LLVMPassManagerBuilderSetDisableSimplifyLibCalls(LLVMPassManagerBuilderRef PMB,
584 LLVMBool Value) {
Meador Ingedfb08a22013-06-20 19:48:07 +0000585 // NOTE: The simplify-libcalls pass has been removed.
Rafael Espindola07f609152011-08-09 22:17:34 +0000586}
587
588void
589LLVMPassManagerBuilderUseInlinerWithThreshold(LLVMPassManagerBuilderRef PMB,
590 unsigned Threshold) {
591 PassManagerBuilder *Builder = unwrap(PMB);
592 Builder->Inliner = createFunctionInliningPass(Threshold);
593}
594
595void
596LLVMPassManagerBuilderPopulateFunctionPassManager(LLVMPassManagerBuilderRef PMB,
597 LLVMPassManagerRef PM) {
598 PassManagerBuilder *Builder = unwrap(PMB);
Chandler Carruth30d69c22015-02-13 10:01:29 +0000599 legacy::FunctionPassManager *FPM = unwrap<legacy::FunctionPassManager>(PM);
Rafael Espindola07f609152011-08-09 22:17:34 +0000600 Builder->populateFunctionPassManager(*FPM);
601}
602
603void
604LLVMPassManagerBuilderPopulateModulePassManager(LLVMPassManagerBuilderRef PMB,
605 LLVMPassManagerRef PM) {
606 PassManagerBuilder *Builder = unwrap(PMB);
Chandler Carruth30d69c22015-02-13 10:01:29 +0000607 legacy::PassManagerBase *MPM = unwrap(PM);
Rafael Espindola07f609152011-08-09 22:17:34 +0000608 Builder->populateModulePassManager(*MPM);
609}
610
611void LLVMPassManagerBuilderPopulateLTOPassManager(LLVMPassManagerBuilderRef PMB,
612 LLVMPassManagerRef PM,
Nick Lewycky5f508542013-03-10 21:58:22 +0000613 LLVMBool Internalize,
614 LLVMBool RunInliner) {
Rafael Espindola07f609152011-08-09 22:17:34 +0000615 PassManagerBuilder *Builder = unwrap(PMB);
Chandler Carruth30d69c22015-02-13 10:01:29 +0000616 legacy::PassManagerBase *LPM = unwrap(PM);
Rafael Espindolae07caad2014-08-21 13:35:30 +0000617
618 // A small backwards compatibility hack. populateLTOPassManager used to take
619 // an RunInliner option.
620 if (RunInliner && !Builder->Inliner)
621 Builder->Inliner = createFunctionInliningPass();
622
623 Builder->populateLTOPassManager(*LPM);
Rafael Espindola07f609152011-08-09 22:17:34 +0000624}