1 //===- Parsing, selection, and construction of pass pipelines -------------===//
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 //===----------------------------------------------------------------------===//
11 /// This file provides the implementation of the PassBuilder based on our
12 /// static pass registry as well as related functionality. It also provides
13 /// helpers to aid in analyzing, debugging, and testing passes and pass
16 //===----------------------------------------------------------------------===//
18 #include "llvm/Passes/PassBuilder.h"
19 #include "llvm/ADT/StringSwitch.h"
20 #include "llvm/Analysis/AliasAnalysis.h"
21 #include "llvm/Analysis/AliasAnalysisEvaluator.h"
22 #include "llvm/Analysis/AssumptionCache.h"
23 #include "llvm/Analysis/BasicAliasAnalysis.h"
24 #include "llvm/Analysis/BlockFrequencyInfo.h"
25 #include "llvm/Analysis/BlockFrequencyInfoImpl.h"
26 #include "llvm/Analysis/BranchProbabilityInfo.h"
27 #include "llvm/Analysis/CFGPrinter.h"
28 #include "llvm/Analysis/CFLAndersAliasAnalysis.h"
29 #include "llvm/Analysis/CFLSteensAliasAnalysis.h"
30 #include "llvm/Analysis/CGSCCPassManager.h"
31 #include "llvm/Analysis/CallGraph.h"
32 #include "llvm/Analysis/DemandedBits.h"
33 #include "llvm/Analysis/DependenceAnalysis.h"
34 #include "llvm/Analysis/DominanceFrontier.h"
35 #include "llvm/Analysis/GlobalsModRef.h"
36 #include "llvm/Analysis/IVUsers.h"
37 #include "llvm/Analysis/LazyCallGraph.h"
38 #include "llvm/Analysis/LazyValueInfo.h"
39 #include "llvm/Analysis/LoopAccessAnalysis.h"
40 #include "llvm/Analysis/LoopInfo.h"
41 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
42 #include "llvm/Analysis/ModuleSummaryAnalysis.h"
43 #include "llvm/Analysis/OptimizationDiagnosticInfo.h"
44 #include "llvm/Analysis/PostDominators.h"
45 #include "llvm/Analysis/ProfileSummaryInfo.h"
46 #include "llvm/Analysis/RegionInfo.h"
47 #include "llvm/Analysis/ScalarEvolution.h"
48 #include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
49 #include "llvm/Analysis/ScopedNoAliasAA.h"
50 #include "llvm/Analysis/TargetLibraryInfo.h"
51 #include "llvm/Analysis/TargetTransformInfo.h"
52 #include "llvm/Analysis/TypeBasedAliasAnalysis.h"
53 #include "llvm/CodeGen/PreISelIntrinsicLowering.h"
54 #include "llvm/CodeGen/UnreachableBlockElim.h"
55 #include "llvm/IR/Dominators.h"
56 #include "llvm/IR/IRPrintingPasses.h"
57 #include "llvm/IR/PassManager.h"
58 #include "llvm/IR/Verifier.h"
59 #include "llvm/Support/Debug.h"
60 #include "llvm/Support/Regex.h"
61 #include "llvm/Target/TargetMachine.h"
62 #include "llvm/Transforms/GCOVProfiler.h"
63 #include "llvm/Transforms/IPO/AlwaysInliner.h"
64 #include "llvm/Transforms/IPO/ConstantMerge.h"
65 #include "llvm/Transforms/IPO/CrossDSOCFI.h"
66 #include "llvm/Transforms/IPO/DeadArgumentElimination.h"
67 #include "llvm/Transforms/IPO/ElimAvailExtern.h"
68 #include "llvm/Transforms/IPO/ForceFunctionAttrs.h"
69 #include "llvm/Transforms/IPO/FunctionAttrs.h"
70 #include "llvm/Transforms/IPO/FunctionImport.h"
71 #include "llvm/Transforms/IPO/GlobalDCE.h"
72 #include "llvm/Transforms/IPO/GlobalOpt.h"
73 #include "llvm/Transforms/IPO/GlobalSplit.h"
74 #include "llvm/Transforms/IPO/InferFunctionAttrs.h"
75 #include "llvm/Transforms/IPO/Inliner.h"
76 #include "llvm/Transforms/IPO/Internalize.h"
77 #include "llvm/Transforms/IPO/LowerTypeTests.h"
78 #include "llvm/Transforms/IPO/PartialInlining.h"
79 #include "llvm/Transforms/IPO/SCCP.h"
80 #include "llvm/Transforms/IPO/StripDeadPrototypes.h"
81 #include "llvm/Transforms/IPO/WholeProgramDevirt.h"
82 #include "llvm/Transforms/InstCombine/InstCombine.h"
83 #include "llvm/Transforms/InstrProfiling.h"
84 #include "llvm/Transforms/PGOInstrumentation.h"
85 #include "llvm/Transforms/SampleProfile.h"
86 #include "llvm/Transforms/Scalar/ADCE.h"
87 #include "llvm/Transforms/Scalar/AlignmentFromAssumptions.h"
88 #include "llvm/Transforms/Scalar/BDCE.h"
89 #include "llvm/Transforms/Scalar/ConstantHoisting.h"
90 #include "llvm/Transforms/Scalar/CorrelatedValuePropagation.h"
91 #include "llvm/Transforms/Scalar/DCE.h"
92 #include "llvm/Transforms/Scalar/DeadStoreElimination.h"
93 #include "llvm/Transforms/Scalar/EarlyCSE.h"
94 #include "llvm/Transforms/Scalar/Float2Int.h"
95 #include "llvm/Transforms/Scalar/GVN.h"
96 #include "llvm/Transforms/Scalar/GuardWidening.h"
97 #include "llvm/Transforms/Scalar/IVUsersPrinter.h"
98 #include "llvm/Transforms/Scalar/IndVarSimplify.h"
99 #include "llvm/Transforms/Scalar/JumpThreading.h"
100 #include "llvm/Transforms/Scalar/LICM.h"
101 #include "llvm/Transforms/Scalar/LoopAccessAnalysisPrinter.h"
102 #include "llvm/Transforms/Scalar/LoopDataPrefetch.h"
103 #include "llvm/Transforms/Scalar/LoopDeletion.h"
104 #include "llvm/Transforms/Scalar/LoopDistribute.h"
105 #include "llvm/Transforms/Scalar/LoopIdiomRecognize.h"
106 #include "llvm/Transforms/Scalar/LoopInstSimplify.h"
107 #include "llvm/Transforms/Scalar/LoopPassManager.h"
108 #include "llvm/Transforms/Scalar/LoopRotation.h"
109 #include "llvm/Transforms/Scalar/LoopSimplifyCFG.h"
110 #include "llvm/Transforms/Scalar/LoopStrengthReduce.h"
111 #include "llvm/Transforms/Scalar/LoopUnrollPass.h"
112 #include "llvm/Transforms/Scalar/LowerAtomic.h"
113 #include "llvm/Transforms/Scalar/LowerExpectIntrinsic.h"
114 #include "llvm/Transforms/Scalar/LowerGuardIntrinsic.h"
115 #include "llvm/Transforms/Scalar/MemCpyOptimizer.h"
116 #include "llvm/Transforms/Scalar/MergedLoadStoreMotion.h"
117 #include "llvm/Transforms/Scalar/NaryReassociate.h"
118 #include "llvm/Transforms/Scalar/NewGVN.h"
119 #include "llvm/Transforms/Scalar/PartiallyInlineLibCalls.h"
120 #include "llvm/Transforms/Scalar/Reassociate.h"
121 #include "llvm/Transforms/Scalar/SCCP.h"
122 #include "llvm/Transforms/Scalar/SROA.h"
123 #include "llvm/Transforms/Scalar/SimplifyCFG.h"
124 #include "llvm/Transforms/Scalar/Sink.h"
125 #include "llvm/Transforms/Scalar/SpeculativeExecution.h"
126 #include "llvm/Transforms/Scalar/TailRecursionElimination.h"
127 #include "llvm/Transforms/Utils/AddDiscriminators.h"
128 #include "llvm/Transforms/Utils/BreakCriticalEdges.h"
129 #include "llvm/Transforms/Utils/LCSSA.h"
130 #include "llvm/Transforms/Utils/LibCallsShrinkWrap.h"
131 #include "llvm/Transforms/Utils/LoopSimplify.h"
132 #include "llvm/Transforms/Utils/LowerInvoke.h"
133 #include "llvm/Transforms/Utils/Mem2Reg.h"
134 #include "llvm/Transforms/Utils/MemorySSA.h"
135 #include "llvm/Transforms/Utils/NameAnonGlobals.h"
136 #include "llvm/Transforms/Utils/SimplifyInstructions.h"
137 #include "llvm/Transforms/Utils/SymbolRewriter.h"
138 #include "llvm/Transforms/Vectorize/LoopVectorize.h"
139 #include "llvm/Transforms/Vectorize/SLPVectorizer.h"
141 #include <type_traits>
143 using namespace llvm;
145 static Regex DefaultAliasRegex("^(default|lto-pre-link|lto)<(O[0123sz])>$");
147 static bool isOptimizingForSize(PassBuilder::OptimizationLevel Level) {
149 case PassBuilder::O0:
150 case PassBuilder::O1:
151 case PassBuilder::O2:
152 case PassBuilder::O3:
155 case PassBuilder::Os:
156 case PassBuilder::Oz:
159 llvm_unreachable("Invalid optimization level!");
164 /// \brief No-op module pass which does nothing.
165 struct NoOpModulePass {
166 PreservedAnalyses run(Module &M, ModuleAnalysisManager &) {
167 return PreservedAnalyses::all();
169 static StringRef name() { return "NoOpModulePass"; }
172 /// \brief No-op module analysis.
173 class NoOpModuleAnalysis : public AnalysisInfoMixin<NoOpModuleAnalysis> {
174 friend AnalysisInfoMixin<NoOpModuleAnalysis>;
175 static AnalysisKey Key;
179 Result run(Module &, ModuleAnalysisManager &) { return Result(); }
180 static StringRef name() { return "NoOpModuleAnalysis"; }
183 /// \brief No-op CGSCC pass which does nothing.
184 struct NoOpCGSCCPass {
185 PreservedAnalyses run(LazyCallGraph::SCC &C, CGSCCAnalysisManager &,
186 LazyCallGraph &, CGSCCUpdateResult &UR) {
187 return PreservedAnalyses::all();
189 static StringRef name() { return "NoOpCGSCCPass"; }
192 /// \brief No-op CGSCC analysis.
193 class NoOpCGSCCAnalysis : public AnalysisInfoMixin<NoOpCGSCCAnalysis> {
194 friend AnalysisInfoMixin<NoOpCGSCCAnalysis>;
195 static AnalysisKey Key;
199 Result run(LazyCallGraph::SCC &, CGSCCAnalysisManager &, LazyCallGraph &G) {
202 static StringRef name() { return "NoOpCGSCCAnalysis"; }
205 /// \brief No-op function pass which does nothing.
206 struct NoOpFunctionPass {
207 PreservedAnalyses run(Function &F, FunctionAnalysisManager &) {
208 return PreservedAnalyses::all();
210 static StringRef name() { return "NoOpFunctionPass"; }
213 /// \brief No-op function analysis.
214 class NoOpFunctionAnalysis : public AnalysisInfoMixin<NoOpFunctionAnalysis> {
215 friend AnalysisInfoMixin<NoOpFunctionAnalysis>;
216 static AnalysisKey Key;
220 Result run(Function &, FunctionAnalysisManager &) { return Result(); }
221 static StringRef name() { return "NoOpFunctionAnalysis"; }
224 /// \brief No-op loop pass which does nothing.
225 struct NoOpLoopPass {
226 PreservedAnalyses run(Loop &L, LoopAnalysisManager &,
227 LoopStandardAnalysisResults &, LPMUpdater &) {
228 return PreservedAnalyses::all();
230 static StringRef name() { return "NoOpLoopPass"; }
233 /// \brief No-op loop analysis.
234 class NoOpLoopAnalysis : public AnalysisInfoMixin<NoOpLoopAnalysis> {
235 friend AnalysisInfoMixin<NoOpLoopAnalysis>;
236 static AnalysisKey Key;
240 Result run(Loop &, LoopAnalysisManager &, LoopStandardAnalysisResults &) {
243 static StringRef name() { return "NoOpLoopAnalysis"; }
246 AnalysisKey NoOpModuleAnalysis::Key;
247 AnalysisKey NoOpCGSCCAnalysis::Key;
248 AnalysisKey NoOpFunctionAnalysis::Key;
249 AnalysisKey NoOpLoopAnalysis::Key;
251 } // End anonymous namespace.
253 void PassBuilder::registerModuleAnalyses(ModuleAnalysisManager &MAM) {
254 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \
255 MAM.registerPass([&] { return CREATE_PASS; });
256 #include "PassRegistry.def"
259 void PassBuilder::registerCGSCCAnalyses(CGSCCAnalysisManager &CGAM) {
260 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
261 CGAM.registerPass([&] { return CREATE_PASS; });
262 #include "PassRegistry.def"
265 void PassBuilder::registerFunctionAnalyses(FunctionAnalysisManager &FAM) {
266 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
267 FAM.registerPass([&] { return CREATE_PASS; });
268 #include "PassRegistry.def"
271 void PassBuilder::registerLoopAnalyses(LoopAnalysisManager &LAM) {
272 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \
273 LAM.registerPass([&] { return CREATE_PASS; });
274 #include "PassRegistry.def"
278 PassBuilder::buildFunctionSimplificationPipeline(OptimizationLevel Level,
280 assert(Level != O0 && "Must request optimizations!");
281 FunctionPassManager FPM(DebugLogging);
283 // Form SSA out of local memory accesses after breaking apart aggregates into
287 // Catch trivial redundancies
288 FPM.addPass(EarlyCSEPass());
290 // Speculative execution if the target has divergent branches; otherwise nop.
291 FPM.addPass(SpeculativeExecutionPass());
293 // Optimize based on known information about branches, and cleanup afterward.
294 FPM.addPass(JumpThreadingPass());
295 FPM.addPass(CorrelatedValuePropagationPass());
296 FPM.addPass(SimplifyCFGPass());
297 FPM.addPass(InstCombinePass());
299 if (!isOptimizingForSize(Level))
300 FPM.addPass(LibCallsShrinkWrapPass());
302 FPM.addPass(TailCallElimPass());
303 FPM.addPass(SimplifyCFGPass());
305 // Form canonically associated expression trees, and simplify the trees using
306 // basic mathematical properties. For example, this will form (nearly)
307 // minimal multiplication trees.
308 FPM.addPass(ReassociatePass());
310 // Add the primary loop simplification pipeline.
311 // FIXME: Currently this is split into two loop pass pipelines because we run
312 // some function passes in between them. These can and should be replaced by
313 // loop pass equivalenst but those aren't ready yet. Specifically,
314 // `SimplifyCFGPass` and `InstCombinePass` are used. We have
315 // `LoopSimplifyCFGPass` which isn't yet powerful enough, and the closest to
316 // the other we have is `LoopInstSimplify`.
317 LoopPassManager LPM1(DebugLogging), LPM2(DebugLogging);
319 // FIXME: Enable these when the loop pass manager can support enforcing loop
320 // simplified and LCSSA form as well as updating the loop nest after
321 // transformations and we finsih porting the loop passes.
323 // Rotate Loop - disable header duplication at -Oz
324 LPM1.addPass(LoopRotatePass(Level != Oz));
325 LPM1.addPass(LICMPass());
326 LPM1.addPass(LoopUnswitchPass(/* OptimizeForSize */ Level != O3));
327 LPM2.addPass(IndVarSimplifyPass());
328 LPM2.addPass(LoopIdiomPass());
329 LPM2.addPass(LoopDeletionPass());
330 LPM2.addPass(SimpleLoopUnrollPass());
332 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM1)));
333 FPM.addPass(SimplifyCFGPass());
334 FPM.addPass(InstCombinePass());
335 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM2)));
337 // Eliminate redundancies.
339 // These passes add substantial compile time so skip them at O1.
340 FPM.addPass(MergedLoadStoreMotionPass());
344 // Specially optimize memory movement as it doesn't look like dataflow in SSA.
345 FPM.addPass(MemCpyOptPass());
347 // Sparse conditional constant propagation.
348 // FIXME: It isn't clear why we do this *after* loop passes rather than
350 FPM.addPass(SCCPPass());
352 // Delete dead bit computations (instcombine runs after to fold away the dead
353 // computations, and then ADCE will run later to exploit any new DCE
354 // opportunities that creates).
355 FPM.addPass(BDCEPass());
357 // Run instcombine after redundancy and dead bit elimination to exploit
358 // opportunities opened up by them.
359 FPM.addPass(InstCombinePass());
361 // Re-consider control flow based optimizations after redundancy elimination,
363 FPM.addPass(JumpThreadingPass());
364 FPM.addPass(CorrelatedValuePropagationPass());
365 FPM.addPass(DSEPass());
366 // FIXME: Enable this when the loop pass manager can support enforcing loop
367 // simplified and LCSSA form as well as updating the loop nest after
368 // transformations and we finsih porting the loop passes.
370 FPM.addPass(createFunctionToLoopPassAdaptor(LICMPass()));
373 // Finally, do an expensive DCE pass to catch all the dead code exposed by
374 // the simplifications and basic cleanup after all the simplifications.
375 FPM.addPass(ADCEPass());
376 FPM.addPass(SimplifyCFGPass());
377 FPM.addPass(InstCombinePass());
383 PassBuilder::buildPerModuleDefaultPipeline(OptimizationLevel Level,
385 assert(Level != O0 && "Must request optimizations for the default pipeline!");
386 ModulePassManager MPM(DebugLogging);
388 // Force any function attributes we want the rest of the pipeline te observe.
389 MPM.addPass(ForceFunctionAttrsPass());
391 // Do basic inference of function attributes from known properties of system
392 // libraries and other oracles.
393 MPM.addPass(InferFunctionAttrsPass());
395 // Create an early function pass manager to cleanup the output of the
397 FunctionPassManager EarlyFPM(DebugLogging);
398 EarlyFPM.addPass(SimplifyCFGPass());
399 EarlyFPM.addPass(SROA());
400 EarlyFPM.addPass(EarlyCSEPass());
401 EarlyFPM.addPass(LowerExpectIntrinsicPass());
402 EarlyFPM.addPass(GVNHoistPass());
403 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(EarlyFPM)));
405 // Interprocedural constant propagation now that basic cleanup has occured
406 // and prior to optimizing globals.
407 // FIXME: This position in the pipeline hasn't been carefully considered in
408 // years, it should be re-analyzed.
409 MPM.addPass(IPSCCPPass());
411 // Optimize globals to try and fold them into constants.
412 MPM.addPass(GlobalOptPass());
414 // Promote any localized globals to SSA registers.
415 // FIXME: Should this instead by a run of SROA?
416 // FIXME: We should probably run instcombine and simplify-cfg afterward to
417 // delete control flows that are dead once globals have been folded to
419 MPM.addPass(createModuleToFunctionPassAdaptor(PromotePass()));
421 // Remove any dead arguments exposed by cleanups and constand folding
423 MPM.addPass(DeadArgumentEliminationPass());
425 // Create a small function pass pipeline to cleanup after all the global
427 FunctionPassManager GlobalCleanupPM(DebugLogging);
428 GlobalCleanupPM.addPass(InstCombinePass());
429 GlobalCleanupPM.addPass(SimplifyCFGPass());
430 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(GlobalCleanupPM)));
432 // FIXME: Enable this when cross-IR-unit analysis invalidation is working.
434 MPM.addPass(RequireAnalysisPass<GlobalsAA>());
437 // Now begin the main postorder CGSCC pipeline.
438 // FIXME: The current CGSCC pipeline has its origins in the legacy pass
439 // manager and trying to emulate its precise behavior. Much of this doesn't
440 // make a lot of sense and we should revisit the core CGSCC structure.
441 CGSCCPassManager MainCGPipeline(DebugLogging);
443 // Note: historically, the PruneEH pass was run first to deduce nounwind and
444 // generally clean up exception handling overhead. It isn't clear this is
445 // valuable as the inliner doesn't currently care whether it is inlining an
448 // Run the inliner first. The theory is that we are walking bottom-up and so
449 // the callees have already been fully optimized, and we want to inline them
450 // into the callers so that our optimizations can reflect that.
451 // FIXME; Customize the threshold based on optimization level.
452 MainCGPipeline.addPass(InlinerPass());
454 // Now deduce any function attributes based in the current code.
455 MainCGPipeline.addPass(PostOrderFunctionAttrsPass());
457 // Lastly, add the core function simplification pipeline nested inside the
459 MainCGPipeline.addPass(createCGSCCToFunctionPassAdaptor(
460 buildFunctionSimplificationPipeline(Level, DebugLogging)));
463 createModuleToPostOrderCGSCCPassAdaptor(std::move(MainCGPipeline)));
465 // This ends the canonicalization and simplification phase of the pipeline.
466 // At this point, we expect to have canonical and simple IR which we begin
467 // *optimizing* for efficient execution going forward.
469 // Eliminate externally available functions now that inlining is over -- we
470 // won't emit these anyways.
471 MPM.addPass(EliminateAvailableExternallyPass());
473 // Do RPO function attribute inference across the module to forward-propagate
474 // attributes where applicable.
475 // FIXME: Is this really an optimization rather than a canonicalization?
476 MPM.addPass(ReversePostOrderFunctionAttrsPass());
478 // Recompute GloblasAA here prior to function passes. This is particularly
479 // useful as the above will have inlined, DCE'ed, and function-attr
480 // propagated everything. We should at this point have a reasonably minimal
481 // and richly annotated call graph. By computing aliasing and mod/ref
482 // information for all local globals here, the late loop passes and notably
483 // the vectorizer will be able to use them to help recognize vectorizable
484 // memory operations.
485 // FIXME: Enable this once analysis invalidation is fully supported.
487 MPM.addPass(Require<GlobalsAA>());
490 FunctionPassManager OptimizePM(DebugLogging);
491 OptimizePM.addPass(Float2IntPass());
492 // FIXME: We need to run some loop optimizations to re-rotate loops after
493 // simplify-cfg and others undo their rotation.
495 // Optimize the loop execution. These passes operate on entire loop nests
496 // rather than on each loop in an inside-out manner, and so they are actually
498 OptimizePM.addPass(LoopDistributePass());
500 // FIXME: LoopVectorize relies on "requiring" LCSSA which isn't supported in
502 OptimizePM.addPass(LoopVectorizePass());
504 // FIXME: Need to port Loop Load Elimination and add it here.
505 OptimizePM.addPass(InstCombinePass());
507 // Optimize parallel scalar instruction chains into SIMD instructions.
508 OptimizePM.addPass(SLPVectorizerPass());
510 // Cleanup after vectorizers.
511 OptimizePM.addPass(SimplifyCFGPass());
512 OptimizePM.addPass(InstCombinePass());
514 // Unroll small loops to hide loop backedge latency and saturate any parallel
515 // execution resources of an out-of-order processor.
516 // FIXME: Need to add once loop pass pipeline is available.
518 // FIXME: Add the loop sink pass when ported.
520 // FIXME: Add cleanup from the loop pass manager when we're forming LCSSA
523 // Now that we've vectorized and unrolled loops, we may have more refined
524 // alignment information, try to re-derive it here.
525 OptimizePM.addPass(AlignmentFromAssumptionsPass());
527 // ADd the core optimizing pipeline.
528 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(OptimizePM)));
530 // Now we need to do some global optimization transforms.
531 // FIXME: It would seem like these should come first in the optimization
532 // pipeline and maybe be the bottom of the canonicalization pipeline? Weird
534 MPM.addPass(GlobalDCEPass());
535 MPM.addPass(ConstantMergePass());
541 PassBuilder::buildLTOPreLinkDefaultPipeline(OptimizationLevel Level,
543 assert(Level != O0 && "Must request optimizations for the default pipeline!");
544 // FIXME: We should use a customized pre-link pipeline!
545 return buildPerModuleDefaultPipeline(Level, DebugLogging);
548 ModulePassManager PassBuilder::buildLTODefaultPipeline(OptimizationLevel Level,
550 assert(Level != O0 && "Must request optimizations for the default pipeline!");
551 ModulePassManager MPM(DebugLogging);
553 // FIXME: Finish fleshing this out to match the legacy LTO pipelines.
554 FunctionPassManager LateFPM(DebugLogging);
555 LateFPM.addPass(InstCombinePass());
556 LateFPM.addPass(SimplifyCFGPass());
558 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(LateFPM)));
563 AAManager PassBuilder::buildDefaultAAPipeline() {
566 // The order in which these are registered determines their priority when
569 // First we register the basic alias analysis that provides the majority of
570 // per-function local AA logic. This is a stateless, on-demand local set of
572 AA.registerFunctionAnalysis<BasicAA>();
574 // Next we query fast, specialized alias analyses that wrap IR-embedded
575 // information about aliasing.
576 AA.registerFunctionAnalysis<ScopedNoAliasAA>();
577 AA.registerFunctionAnalysis<TypeBasedAA>();
579 // Add support for querying global aliasing information when available.
580 // Because the `AAManager` is a function analysis and `GlobalsAA` is a module
581 // analysis, all that the `AAManager` can do is query for any *cached*
582 // results from `GlobalsAA` through a readonly proxy..
584 // FIXME: Enable once the invalidation logic supports this. Currently, the
585 // `AAManager` will hold stale references to the module analyses.
586 AA.registerModuleAnalysis<GlobalsAA>();
592 static Optional<int> parseRepeatPassName(StringRef Name) {
593 if (!Name.consume_front("repeat<") || !Name.consume_back(">"))
596 if (Name.getAsInteger(0, Count) || Count <= 0)
601 static Optional<int> parseDevirtPassName(StringRef Name) {
602 if (!Name.consume_front("devirt<") || !Name.consume_back(">"))
605 if (Name.getAsInteger(0, Count) || Count <= 0)
610 static bool isModulePassName(StringRef Name) {
611 // Manually handle aliases for pre-configured pipeline fragments.
612 if (Name.startswith("default") || Name.startswith("lto"))
613 return DefaultAliasRegex.match(Name);
615 // Explicitly handle pass manager names.
616 if (Name == "module")
620 if (Name == "function")
623 // Explicitly handle custom-parsed pass names.
624 if (parseRepeatPassName(Name))
627 #define MODULE_PASS(NAME, CREATE_PASS) \
630 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \
631 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
633 #include "PassRegistry.def"
638 static bool isCGSCCPassName(StringRef Name) {
639 // Explicitly handle pass manager names.
642 if (Name == "function")
645 // Explicitly handle custom-parsed pass names.
646 if (parseRepeatPassName(Name))
648 if (parseDevirtPassName(Name))
651 #define CGSCC_PASS(NAME, CREATE_PASS) \
654 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
655 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
657 #include "PassRegistry.def"
662 static bool isFunctionPassName(StringRef Name) {
663 // Explicitly handle pass manager names.
664 if (Name == "function")
669 // Explicitly handle custom-parsed pass names.
670 if (parseRepeatPassName(Name))
673 #define FUNCTION_PASS(NAME, CREATE_PASS) \
676 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
677 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
679 #include "PassRegistry.def"
684 static bool isLoopPassName(StringRef Name) {
685 // Explicitly handle pass manager names.
689 // Explicitly handle custom-parsed pass names.
690 if (parseRepeatPassName(Name))
693 #define LOOP_PASS(NAME, CREATE_PASS) \
696 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \
697 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
699 #include "PassRegistry.def"
704 Optional<std::vector<PassBuilder::PipelineElement>>
705 PassBuilder::parsePipelineText(StringRef Text) {
706 std::vector<PipelineElement> ResultPipeline;
708 SmallVector<std::vector<PipelineElement> *, 4> PipelineStack = {
711 std::vector<PipelineElement> &Pipeline = *PipelineStack.back();
712 size_t Pos = Text.find_first_of(",()");
713 Pipeline.push_back({Text.substr(0, Pos), {}});
715 // If we have a single terminating name, we're done.
716 if (Pos == Text.npos)
719 char Sep = Text[Pos];
720 Text = Text.substr(Pos + 1);
722 // Just a name ending in a comma, continue.
726 // Push the inner pipeline onto the stack to continue processing.
727 PipelineStack.push_back(&Pipeline.back().InnerPipeline);
731 assert(Sep == ')' && "Bogus separator!");
732 // When handling the close parenthesis, we greedily consume them to avoid
733 // empty strings in the pipeline.
735 // If we try to pop the outer pipeline we have unbalanced parentheses.
736 if (PipelineStack.size() == 1)
739 PipelineStack.pop_back();
740 } while (Text.consume_front(")"));
742 // Check if we've finished parsing.
746 // Otherwise, the end of an inner pipeline always has to be followed by
747 // a comma, and then we can continue.
748 if (!Text.consume_front(","))
752 if (PipelineStack.size() > 1)
753 // Unbalanced paretheses.
756 assert(PipelineStack.back() == &ResultPipeline &&
757 "Wrong pipeline at the bottom of the stack!");
758 return {std::move(ResultPipeline)};
761 bool PassBuilder::parseModulePass(ModulePassManager &MPM,
762 const PipelineElement &E, bool VerifyEachPass,
765 auto &InnerPipeline = E.InnerPipeline;
767 // First handle complex passes like the pass managers which carry pipelines.
768 if (!InnerPipeline.empty()) {
769 if (Name == "module") {
770 ModulePassManager NestedMPM(DebugLogging);
771 if (!parseModulePassPipeline(NestedMPM, InnerPipeline, VerifyEachPass,
774 MPM.addPass(std::move(NestedMPM));
777 if (Name == "cgscc") {
778 CGSCCPassManager CGPM(DebugLogging);
779 if (!parseCGSCCPassPipeline(CGPM, InnerPipeline, VerifyEachPass,
782 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPM),
786 if (Name == "function") {
787 FunctionPassManager FPM(DebugLogging);
788 if (!parseFunctionPassPipeline(FPM, InnerPipeline, VerifyEachPass,
791 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
794 if (auto Count = parseRepeatPassName(Name)) {
795 ModulePassManager NestedMPM(DebugLogging);
796 if (!parseModulePassPipeline(NestedMPM, InnerPipeline, VerifyEachPass,
799 MPM.addPass(createRepeatedPass(*Count, std::move(NestedMPM)));
802 // Normal passes can't have pipelines.
806 // Manually handle aliases for pre-configured pipeline fragments.
807 if (Name.startswith("default") || Name.startswith("lto")) {
808 SmallVector<StringRef, 3> Matches;
809 if (!DefaultAliasRegex.match(Name, &Matches))
811 assert(Matches.size() == 3 && "Must capture two matched strings!");
813 OptimizationLevel L = StringSwitch<OptimizationLevel>(Matches[2])
821 // At O0 we do nothing at all!
824 if (Matches[1] == "default") {
825 MPM.addPass(buildPerModuleDefaultPipeline(L, DebugLogging));
826 } else if (Matches[1] == "lto-pre-link") {
827 MPM.addPass(buildLTOPreLinkDefaultPipeline(L, DebugLogging));
829 assert(Matches[1] == "lto" && "Not one of the matched options!");
830 MPM.addPass(buildLTODefaultPipeline(L, DebugLogging));
835 // Finally expand the basic registered passes from the .inc file.
836 #define MODULE_PASS(NAME, CREATE_PASS) \
837 if (Name == NAME) { \
838 MPM.addPass(CREATE_PASS); \
841 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \
842 if (Name == "require<" NAME ">") { \
844 RequireAnalysisPass< \
845 std::remove_reference<decltype(CREATE_PASS)>::type, Module>()); \
848 if (Name == "invalidate<" NAME ">") { \
849 MPM.addPass(InvalidateAnalysisPass< \
850 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
853 #include "PassRegistry.def"
858 bool PassBuilder::parseCGSCCPass(CGSCCPassManager &CGPM,
859 const PipelineElement &E, bool VerifyEachPass,
862 auto &InnerPipeline = E.InnerPipeline;
864 // First handle complex passes like the pass managers which carry pipelines.
865 if (!InnerPipeline.empty()) {
866 if (Name == "cgscc") {
867 CGSCCPassManager NestedCGPM(DebugLogging);
868 if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
871 // Add the nested pass manager with the appropriate adaptor.
872 CGPM.addPass(std::move(NestedCGPM));
875 if (Name == "function") {
876 FunctionPassManager FPM(DebugLogging);
877 if (!parseFunctionPassPipeline(FPM, InnerPipeline, VerifyEachPass,
880 // Add the nested pass manager with the appropriate adaptor.
882 createCGSCCToFunctionPassAdaptor(std::move(FPM), DebugLogging));
885 if (auto Count = parseRepeatPassName(Name)) {
886 CGSCCPassManager NestedCGPM(DebugLogging);
887 if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
890 CGPM.addPass(createRepeatedPass(*Count, std::move(NestedCGPM)));
893 if (auto MaxRepetitions = parseDevirtPassName(Name)) {
894 CGSCCPassManager NestedCGPM(DebugLogging);
895 if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
898 CGPM.addPass(createDevirtSCCRepeatedPass(std::move(NestedCGPM),
899 *MaxRepetitions, DebugLogging));
902 // Normal passes can't have pipelines.
906 // Now expand the basic registered passes from the .inc file.
907 #define CGSCC_PASS(NAME, CREATE_PASS) \
908 if (Name == NAME) { \
909 CGPM.addPass(CREATE_PASS); \
912 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
913 if (Name == "require<" NAME ">") { \
914 CGPM.addPass(RequireAnalysisPass< \
915 std::remove_reference<decltype(CREATE_PASS)>::type, \
916 LazyCallGraph::SCC, CGSCCAnalysisManager, LazyCallGraph &, \
917 CGSCCUpdateResult &>()); \
920 if (Name == "invalidate<" NAME ">") { \
921 CGPM.addPass(InvalidateAnalysisPass< \
922 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
925 #include "PassRegistry.def"
930 bool PassBuilder::parseFunctionPass(FunctionPassManager &FPM,
931 const PipelineElement &E,
932 bool VerifyEachPass, bool DebugLogging) {
934 auto &InnerPipeline = E.InnerPipeline;
936 // First handle complex passes like the pass managers which carry pipelines.
937 if (!InnerPipeline.empty()) {
938 if (Name == "function") {
939 FunctionPassManager NestedFPM(DebugLogging);
940 if (!parseFunctionPassPipeline(NestedFPM, InnerPipeline, VerifyEachPass,
943 // Add the nested pass manager with the appropriate adaptor.
944 FPM.addPass(std::move(NestedFPM));
947 if (Name == "loop") {
948 LoopPassManager LPM(DebugLogging);
949 if (!parseLoopPassPipeline(LPM, InnerPipeline, VerifyEachPass,
952 // Add the nested pass manager with the appropriate adaptor.
953 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM)));
956 if (auto Count = parseRepeatPassName(Name)) {
957 FunctionPassManager NestedFPM(DebugLogging);
958 if (!parseFunctionPassPipeline(NestedFPM, InnerPipeline, VerifyEachPass,
961 FPM.addPass(createRepeatedPass(*Count, std::move(NestedFPM)));
964 // Normal passes can't have pipelines.
968 // Now expand the basic registered passes from the .inc file.
969 #define FUNCTION_PASS(NAME, CREATE_PASS) \
970 if (Name == NAME) { \
971 FPM.addPass(CREATE_PASS); \
974 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
975 if (Name == "require<" NAME ">") { \
977 RequireAnalysisPass< \
978 std::remove_reference<decltype(CREATE_PASS)>::type, Function>()); \
981 if (Name == "invalidate<" NAME ">") { \
982 FPM.addPass(InvalidateAnalysisPass< \
983 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
986 #include "PassRegistry.def"
991 bool PassBuilder::parseLoopPass(LoopPassManager &LPM, const PipelineElement &E,
992 bool VerifyEachPass, bool DebugLogging) {
993 StringRef Name = E.Name;
994 auto &InnerPipeline = E.InnerPipeline;
996 // First handle complex passes like the pass managers which carry pipelines.
997 if (!InnerPipeline.empty()) {
998 if (Name == "loop") {
999 LoopPassManager NestedLPM(DebugLogging);
1000 if (!parseLoopPassPipeline(NestedLPM, InnerPipeline, VerifyEachPass,
1003 // Add the nested pass manager with the appropriate adaptor.
1004 LPM.addPass(std::move(NestedLPM));
1007 if (auto Count = parseRepeatPassName(Name)) {
1008 LoopPassManager NestedLPM(DebugLogging);
1009 if (!parseLoopPassPipeline(NestedLPM, InnerPipeline, VerifyEachPass,
1012 LPM.addPass(createRepeatedPass(*Count, std::move(NestedLPM)));
1015 // Normal passes can't have pipelines.
1019 // Now expand the basic registered passes from the .inc file.
1020 #define LOOP_PASS(NAME, CREATE_PASS) \
1021 if (Name == NAME) { \
1022 LPM.addPass(CREATE_PASS); \
1025 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \
1026 if (Name == "require<" NAME ">") { \
1027 LPM.addPass(RequireAnalysisPass< \
1028 std::remove_reference<decltype(CREATE_PASS)>::type, Loop, \
1029 LoopAnalysisManager, LoopStandardAnalysisResults &, \
1033 if (Name == "invalidate<" NAME ">") { \
1034 LPM.addPass(InvalidateAnalysisPass< \
1035 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
1038 #include "PassRegistry.def"
1043 bool PassBuilder::parseAAPassName(AAManager &AA, StringRef Name) {
1044 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
1045 if (Name == NAME) { \
1046 AA.registerModuleAnalysis< \
1047 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
1050 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
1051 if (Name == NAME) { \
1052 AA.registerFunctionAnalysis< \
1053 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
1056 #include "PassRegistry.def"
1061 bool PassBuilder::parseLoopPassPipeline(LoopPassManager &LPM,
1062 ArrayRef<PipelineElement> Pipeline,
1063 bool VerifyEachPass,
1064 bool DebugLogging) {
1065 for (const auto &Element : Pipeline) {
1066 if (!parseLoopPass(LPM, Element, VerifyEachPass, DebugLogging))
1068 // FIXME: No verifier support for Loop passes!
1073 bool PassBuilder::parseFunctionPassPipeline(FunctionPassManager &FPM,
1074 ArrayRef<PipelineElement> Pipeline,
1075 bool VerifyEachPass,
1076 bool DebugLogging) {
1077 for (const auto &Element : Pipeline) {
1078 if (!parseFunctionPass(FPM, Element, VerifyEachPass, DebugLogging))
1081 FPM.addPass(VerifierPass());
1086 bool PassBuilder::parseCGSCCPassPipeline(CGSCCPassManager &CGPM,
1087 ArrayRef<PipelineElement> Pipeline,
1088 bool VerifyEachPass,
1089 bool DebugLogging) {
1090 for (const auto &Element : Pipeline) {
1091 if (!parseCGSCCPass(CGPM, Element, VerifyEachPass, DebugLogging))
1093 // FIXME: No verifier support for CGSCC passes!
1098 void PassBuilder::crossRegisterProxies(LoopAnalysisManager &LAM,
1099 FunctionAnalysisManager &FAM,
1100 CGSCCAnalysisManager &CGAM,
1101 ModuleAnalysisManager &MAM) {
1102 MAM.registerPass([&] { return FunctionAnalysisManagerModuleProxy(FAM); });
1103 MAM.registerPass([&] { return CGSCCAnalysisManagerModuleProxy(CGAM); });
1104 CGAM.registerPass([&] { return ModuleAnalysisManagerCGSCCProxy(MAM); });
1105 FAM.registerPass([&] { return CGSCCAnalysisManagerFunctionProxy(CGAM); });
1106 FAM.registerPass([&] { return ModuleAnalysisManagerFunctionProxy(MAM); });
1107 FAM.registerPass([&] { return LoopAnalysisManagerFunctionProxy(LAM); });
1108 LAM.registerPass([&] { return FunctionAnalysisManagerLoopProxy(FAM); });
1111 bool PassBuilder::parseModulePassPipeline(ModulePassManager &MPM,
1112 ArrayRef<PipelineElement> Pipeline,
1113 bool VerifyEachPass,
1114 bool DebugLogging) {
1115 for (const auto &Element : Pipeline) {
1116 if (!parseModulePass(MPM, Element, VerifyEachPass, DebugLogging))
1119 MPM.addPass(VerifierPass());
1124 // Primary pass pipeline description parsing routine.
1125 // FIXME: Should this routine accept a TargetMachine or require the caller to
1126 // pre-populate the analysis managers with target-specific stuff?
1127 bool PassBuilder::parsePassPipeline(ModulePassManager &MPM,
1128 StringRef PipelineText, bool VerifyEachPass,
1129 bool DebugLogging) {
1130 auto Pipeline = parsePipelineText(PipelineText);
1131 if (!Pipeline || Pipeline->empty())
1134 // If the first name isn't at the module layer, wrap the pipeline up
1136 StringRef FirstName = Pipeline->front().Name;
1138 if (!isModulePassName(FirstName)) {
1139 if (isCGSCCPassName(FirstName))
1140 Pipeline = {{"cgscc", std::move(*Pipeline)}};
1141 else if (isFunctionPassName(FirstName))
1142 Pipeline = {{"function", std::move(*Pipeline)}};
1143 else if (isLoopPassName(FirstName))
1144 Pipeline = {{"function", {{"loop", std::move(*Pipeline)}}}};
1146 // Unknown pass name!
1150 return parseModulePassPipeline(MPM, *Pipeline, VerifyEachPass, DebugLogging);
1153 bool PassBuilder::parseAAPipeline(AAManager &AA, StringRef PipelineText) {
1154 // If the pipeline just consists of the word 'default' just replace the AA
1155 // manager with our default one.
1156 if (PipelineText == "default") {
1157 AA = buildDefaultAAPipeline();
1161 while (!PipelineText.empty()) {
1163 std::tie(Name, PipelineText) = PipelineText.split(',');
1164 if (!parseAAPassName(AA, Name))