contrib/llvm/lib/Passes/PassBuilder.cpp

   1 //===- Parsing, selection, and construction of pass pipelines -------------===//
   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 /// \file
  10 ///
  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
  14 /// pipelines.
  15 ///
  16 //===----------------------------------------------------------------------===//
  17
  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/MemorySSA.h"
  43 #include "llvm/Analysis/ModuleSummaryAnalysis.h"
  44 #include "llvm/Analysis/OptimizationDiagnosticInfo.h"
  45 #include "llvm/Analysis/PostDominators.h"
  46 #include "llvm/Analysis/ProfileSummaryInfo.h"
  47 #include "llvm/Analysis/RegionInfo.h"
  48 #include "llvm/Analysis/ScalarEvolution.h"
  49 #include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
  50 #include "llvm/Analysis/ScopedNoAliasAA.h"
  51 #include "llvm/Analysis/TargetLibraryInfo.h"
  52 #include "llvm/Analysis/TargetTransformInfo.h"
  53 #include "llvm/Analysis/TypeBasedAliasAnalysis.h"
  54 #include "llvm/CodeGen/PreISelIntrinsicLowering.h"
  55 #include "llvm/CodeGen/UnreachableBlockElim.h"
  56 #include "llvm/IR/Dominators.h"
  57 #include "llvm/IR/IRPrintingPasses.h"
  58 #include "llvm/IR/PassManager.h"
  59 #include "llvm/IR/Verifier.h"
  60 #include "llvm/Support/Debug.h"
  61 #include "llvm/Support/Regex.h"
  62 #include "llvm/Target/TargetMachine.h"
  63 #include "llvm/Transforms/GCOVProfiler.h"
  64 #include "llvm/Transforms/IPO/AlwaysInliner.h"
  65 #include "llvm/Transforms/IPO/ArgumentPromotion.h"
  66 #include "llvm/Transforms/IPO/ConstantMerge.h"
  67 #include "llvm/Transforms/IPO/CrossDSOCFI.h"
  68 #include "llvm/Transforms/IPO/DeadArgumentElimination.h"
  69 #include "llvm/Transforms/IPO/ElimAvailExtern.h"
  70 #include "llvm/Transforms/IPO/ForceFunctionAttrs.h"
  71 #include "llvm/Transforms/IPO/FunctionAttrs.h"
  72 #include "llvm/Transforms/IPO/FunctionImport.h"
  73 #include "llvm/Transforms/IPO/GlobalDCE.h"
  74 #include "llvm/Transforms/IPO/GlobalOpt.h"
  75 #include "llvm/Transforms/IPO/GlobalSplit.h"
  76 #include "llvm/Transforms/IPO/InferFunctionAttrs.h"
  77 #include "llvm/Transforms/IPO/Inliner.h"
  78 #include "llvm/Transforms/IPO/Internalize.h"
  79 #include "llvm/Transforms/IPO/LowerTypeTests.h"
  80 #include "llvm/Transforms/IPO/PartialInlining.h"
  81 #include "llvm/Transforms/IPO/SCCP.h"
  82 #include "llvm/Transforms/IPO/StripDeadPrototypes.h"
  83 #include "llvm/Transforms/IPO/WholeProgramDevirt.h"
  84 #include "llvm/Transforms/InstCombine/InstCombine.h"
  85 #include "llvm/Transforms/InstrProfiling.h"
  86 #include "llvm/Transforms/PGOInstrumentation.h"
  87 #include "llvm/Transforms/SampleProfile.h"
  88 #include "llvm/Transforms/Scalar/ADCE.h"
  89 #include "llvm/Transforms/Scalar/AlignmentFromAssumptions.h"
  90 #include "llvm/Transforms/Scalar/BDCE.h"
  91 #include "llvm/Transforms/Scalar/ConstantHoisting.h"
  92 #include "llvm/Transforms/Scalar/CorrelatedValuePropagation.h"
  93 #include "llvm/Transforms/Scalar/DCE.h"
  94 #include "llvm/Transforms/Scalar/DeadStoreElimination.h"
  95 #include "llvm/Transforms/Scalar/EarlyCSE.h"
  96 #include "llvm/Transforms/Scalar/Float2Int.h"
  97 #include "llvm/Transforms/Scalar/GVN.h"
  98 #include "llvm/Transforms/Scalar/GuardWidening.h"
  99 #include "llvm/Transforms/Scalar/IVUsersPrinter.h"
 100 #include "llvm/Transforms/Scalar/IndVarSimplify.h"
 101 #include "llvm/Transforms/Scalar/JumpThreading.h"
 102 #include "llvm/Transforms/Scalar/LICM.h"
 103 #include "llvm/Transforms/Scalar/LoopAccessAnalysisPrinter.h"
 104 #include "llvm/Transforms/Scalar/LoopDataPrefetch.h"
 105 #include "llvm/Transforms/Scalar/LoopDeletion.h"
 106 #include "llvm/Transforms/Scalar/LoopDistribute.h"
 107 #include "llvm/Transforms/Scalar/LoopIdiomRecognize.h"
 108 #include "llvm/Transforms/Scalar/LoopInstSimplify.h"
 109 #include "llvm/Transforms/Scalar/LoopLoadElimination.h"
 110 #include "llvm/Transforms/Scalar/LoopPassManager.h"
 111 #include "llvm/Transforms/Scalar/LoopPredication.h"
 112 #include "llvm/Transforms/Scalar/LoopRotation.h"
 113 #include "llvm/Transforms/Scalar/LoopSimplifyCFG.h"
 114 #include "llvm/Transforms/Scalar/LoopSink.h"
 115 #include "llvm/Transforms/Scalar/LoopStrengthReduce.h"
 116 #include "llvm/Transforms/Scalar/LoopUnrollPass.h"
 117 #include "llvm/Transforms/Scalar/LowerAtomic.h"
 118 #include "llvm/Transforms/Scalar/LowerExpectIntrinsic.h"
 119 #include "llvm/Transforms/Scalar/LowerGuardIntrinsic.h"
 120 #include "llvm/Transforms/Scalar/MemCpyOptimizer.h"
 121 #include "llvm/Transforms/Scalar/MergedLoadStoreMotion.h"
 122 #include "llvm/Transforms/Scalar/NaryReassociate.h"
 123 #include "llvm/Transforms/Scalar/NewGVN.h"
 124 #include "llvm/Transforms/Scalar/PartiallyInlineLibCalls.h"
 125 #include "llvm/Transforms/Scalar/Reassociate.h"
 126 #include "llvm/Transforms/Scalar/SCCP.h"
 127 #include "llvm/Transforms/Scalar/SROA.h"
 128 #include "llvm/Transforms/Scalar/SimplifyCFG.h"
 129 #include "llvm/Transforms/Scalar/Sink.h"
 130 #include "llvm/Transforms/Scalar/SpeculativeExecution.h"
 131 #include "llvm/Transforms/Scalar/TailRecursionElimination.h"
 132 #include "llvm/Transforms/Utils/AddDiscriminators.h"
 133 #include "llvm/Transforms/Utils/BreakCriticalEdges.h"
 134 #include "llvm/Transforms/Utils/LCSSA.h"
 135 #include "llvm/Transforms/Utils/LibCallsShrinkWrap.h"
 136 #include "llvm/Transforms/Utils/LoopSimplify.h"
 137 #include "llvm/Transforms/Utils/LowerInvoke.h"
 138 #include "llvm/Transforms/Utils/Mem2Reg.h"
 139 #include "llvm/Transforms/Utils/NameAnonGlobals.h"
 140 #include "llvm/Transforms/Utils/PredicateInfo.h"
 141 #include "llvm/Transforms/Utils/SimplifyInstructions.h"
 142 #include "llvm/Transforms/Utils/SymbolRewriter.h"
 143 #include "llvm/Transforms/Vectorize/LoopVectorize.h"
 144 #include "llvm/Transforms/Vectorize/SLPVectorizer.h"
 145
 146 #include <type_traits>
 147
 148 using namespace llvm;
 149
 150 static cl::opt<unsigned> MaxDevirtIterations("pm-max-devirt-iterations",
 151                                              cl::ReallyHidden, cl::init(4));
 152
 153 static Regex DefaultAliasRegex("^(default|lto-pre-link|lto)<(O[0123sz])>$");
 154
 155 static bool isOptimizingForSize(PassBuilder::OptimizationLevel Level) {
 156   switch (Level) {
 157   case PassBuilder::O0:
 158   case PassBuilder::O1:
 159   case PassBuilder::O2:
 160   case PassBuilder::O3:
 161     return false;
 162
 163   case PassBuilder::Os:
 164   case PassBuilder::Oz:
 165     return true;
 166   }
 167   llvm_unreachable("Invalid optimization level!");
 168 }
 169
 170 namespace {
 171
 172 /// \brief No-op module pass which does nothing.
 173 struct NoOpModulePass {
 174   PreservedAnalyses run(Module &M, ModuleAnalysisManager &) {
 175     return PreservedAnalyses::all();
 176   }
 177   static StringRef name() { return "NoOpModulePass"; }
 178 };
 179
 180 /// \brief No-op module analysis.
 181 class NoOpModuleAnalysis : public AnalysisInfoMixin<NoOpModuleAnalysis> {
 182   friend AnalysisInfoMixin<NoOpModuleAnalysis>;
 183   static AnalysisKey Key;
 184
 185 public:
 186   struct Result {};
 187   Result run(Module &, ModuleAnalysisManager &) { return Result(); }
 188   static StringRef name() { return "NoOpModuleAnalysis"; }
 189 };
 190
 191 /// \brief No-op CGSCC pass which does nothing.
 192 struct NoOpCGSCCPass {
 193   PreservedAnalyses run(LazyCallGraph::SCC &C, CGSCCAnalysisManager &,
 194                         LazyCallGraph &, CGSCCUpdateResult &UR) {
 195     return PreservedAnalyses::all();
 196   }
 197   static StringRef name() { return "NoOpCGSCCPass"; }
 198 };
 199
 200 /// \brief No-op CGSCC analysis.
 201 class NoOpCGSCCAnalysis : public AnalysisInfoMixin<NoOpCGSCCAnalysis> {
 202   friend AnalysisInfoMixin<NoOpCGSCCAnalysis>;
 203   static AnalysisKey Key;
 204
 205 public:
 206   struct Result {};
 207   Result run(LazyCallGraph::SCC &, CGSCCAnalysisManager &, LazyCallGraph &G) {
 208     return Result();
 209   }
 210   static StringRef name() { return "NoOpCGSCCAnalysis"; }
 211 };
 212
 213 /// \brief No-op function pass which does nothing.
 214 struct NoOpFunctionPass {
 215   PreservedAnalyses run(Function &F, FunctionAnalysisManager &) {
 216     return PreservedAnalyses::all();
 217   }
 218   static StringRef name() { return "NoOpFunctionPass"; }
 219 };
 220
 221 /// \brief No-op function analysis.
 222 class NoOpFunctionAnalysis : public AnalysisInfoMixin<NoOpFunctionAnalysis> {
 223   friend AnalysisInfoMixin<NoOpFunctionAnalysis>;
 224   static AnalysisKey Key;
 225
 226 public:
 227   struct Result {};
 228   Result run(Function &, FunctionAnalysisManager &) { return Result(); }
 229   static StringRef name() { return "NoOpFunctionAnalysis"; }
 230 };
 231
 232 /// \brief No-op loop pass which does nothing.
 233 struct NoOpLoopPass {
 234   PreservedAnalyses run(Loop &L, LoopAnalysisManager &,
 235                         LoopStandardAnalysisResults &, LPMUpdater &) {
 236     return PreservedAnalyses::all();
 237   }
 238   static StringRef name() { return "NoOpLoopPass"; }
 239 };
 240
 241 /// \brief No-op loop analysis.
 242 class NoOpLoopAnalysis : public AnalysisInfoMixin<NoOpLoopAnalysis> {
 243   friend AnalysisInfoMixin<NoOpLoopAnalysis>;
 244   static AnalysisKey Key;
 245
 246 public:
 247   struct Result {};
 248   Result run(Loop &, LoopAnalysisManager &, LoopStandardAnalysisResults &) {
 249     return Result();
 250   }
 251   static StringRef name() { return "NoOpLoopAnalysis"; }
 252 };
 253
 254 AnalysisKey NoOpModuleAnalysis::Key;
 255 AnalysisKey NoOpCGSCCAnalysis::Key;
 256 AnalysisKey NoOpFunctionAnalysis::Key;
 257 AnalysisKey NoOpLoopAnalysis::Key;
 258
 259 } // End anonymous namespace.
 260
 261 void PassBuilder::registerModuleAnalyses(ModuleAnalysisManager &MAM) {
 262 #define MODULE_ANALYSIS(NAME, CREATE_PASS)                                     \
 263   MAM.registerPass([&] { return CREATE_PASS; });
 264 #include "PassRegistry.def"
 265 }
 266
 267 void PassBuilder::registerCGSCCAnalyses(CGSCCAnalysisManager &CGAM) {
 268 #define CGSCC_ANALYSIS(NAME, CREATE_PASS)                                      \
 269   CGAM.registerPass([&] { return CREATE_PASS; });
 270 #include "PassRegistry.def"
 271 }
 272
 273 void PassBuilder::registerFunctionAnalyses(FunctionAnalysisManager &FAM) {
 274 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS)                                   \
 275   FAM.registerPass([&] { return CREATE_PASS; });
 276 #include "PassRegistry.def"
 277 }
 278
 279 void PassBuilder::registerLoopAnalyses(LoopAnalysisManager &LAM) {
 280 #define LOOP_ANALYSIS(NAME, CREATE_PASS)                                       \
 281   LAM.registerPass([&] { return CREATE_PASS; });
 282 #include "PassRegistry.def"
 283 }
 284
 285 FunctionPassManager
 286 PassBuilder::buildFunctionSimplificationPipeline(OptimizationLevel Level,
 287                                                  bool DebugLogging) {
 288   assert(Level != O0 && "Must request optimizations!");
 289   FunctionPassManager FPM(DebugLogging);
 290
 291   // Form SSA out of local memory accesses after breaking apart aggregates into
 292   // scalars.
 293   FPM.addPass(SROA());
 294
 295   // Catch trivial redundancies
 296   FPM.addPass(EarlyCSEPass());
 297
 298   // Speculative execution if the target has divergent branches; otherwise nop.
 299   FPM.addPass(SpeculativeExecutionPass());
 300
 301   // Optimize based on known information about branches, and cleanup afterward.
 302   FPM.addPass(JumpThreadingPass());
 303   FPM.addPass(CorrelatedValuePropagationPass());
 304   FPM.addPass(SimplifyCFGPass());
 305   FPM.addPass(InstCombinePass());
 306
 307   if (!isOptimizingForSize(Level))
 308     FPM.addPass(LibCallsShrinkWrapPass());
 309
 310   FPM.addPass(TailCallElimPass());
 311   FPM.addPass(SimplifyCFGPass());
 312
 313   // Form canonically associated expression trees, and simplify the trees using
 314   // basic mathematical properties. For example, this will form (nearly)
 315   // minimal multiplication trees.
 316   FPM.addPass(ReassociatePass());
 317
 318   // Add the primary loop simplification pipeline.
 319   // FIXME: Currently this is split into two loop pass pipelines because we run
 320   // some function passes in between them. These can and should be replaced by
 321   // loop pass equivalenst but those aren't ready yet. Specifically,
 322   // `SimplifyCFGPass` and `InstCombinePass` are used. We have
 323   // `LoopSimplifyCFGPass` which isn't yet powerful enough, and the closest to
 324   // the other we have is `LoopInstSimplify`.
 325   LoopPassManager LPM1(DebugLogging), LPM2(DebugLogging);
 326
 327   // Rotate Loop - disable header duplication at -Oz
 328   LPM1.addPass(LoopRotatePass(Level != Oz));
 329   LPM1.addPass(LICMPass());
 330 #if 0
 331   // The LoopUnswitch pass isn't yet ported to the new pass manager.
 332   LPM1.addPass(LoopUnswitchPass(/* OptimizeForSize */ Level != O3));
 333 #endif
 334   LPM2.addPass(IndVarSimplifyPass());
 335   LPM2.addPass(LoopIdiomRecognizePass());
 336   LPM2.addPass(LoopDeletionPass());
 337   LPM2.addPass(LoopUnrollPass::createFull(Level));
 338
 339   // We provide the opt remark emitter pass for LICM to use. We only need to do
 340   // this once as it is immutable.
 341   FPM.addPass(RequireAnalysisPass<OptimizationRemarkEmitterAnalysis, Function>());
 342   FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM1)));
 343   FPM.addPass(SimplifyCFGPass());
 344   FPM.addPass(InstCombinePass());
 345   FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM2)));
 346
 347   // Eliminate redundancies.
 348   if (Level != O1) {
 349     // These passes add substantial compile time so skip them at O1.
 350     FPM.addPass(MergedLoadStoreMotionPass());
 351     FPM.addPass(GVN());
 352   }
 353
 354   // Specially optimize memory movement as it doesn't look like dataflow in SSA.
 355   FPM.addPass(MemCpyOptPass());
 356
 357   // Sparse conditional constant propagation.
 358   // FIXME: It isn't clear why we do this *after* loop passes rather than
 359   // before...
 360   FPM.addPass(SCCPPass());
 361
 362   // Delete dead bit computations (instcombine runs after to fold away the dead
 363   // computations, and then ADCE will run later to exploit any new DCE
 364   // opportunities that creates).
 365   FPM.addPass(BDCEPass());
 366
 367   // Run instcombine after redundancy and dead bit elimination to exploit
 368   // opportunities opened up by them.
 369   FPM.addPass(InstCombinePass());
 370
 371   // Re-consider control flow based optimizations after redundancy elimination,
 372   // redo DCE, etc.
 373   FPM.addPass(JumpThreadingPass());
 374   FPM.addPass(CorrelatedValuePropagationPass());
 375   FPM.addPass(DSEPass());
 376   FPM.addPass(createFunctionToLoopPassAdaptor(LICMPass()));
 377
 378   // Finally, do an expensive DCE pass to catch all the dead code exposed by
 379   // the simplifications and basic cleanup after all the simplifications.
 380   FPM.addPass(ADCEPass());
 381   FPM.addPass(SimplifyCFGPass());
 382   FPM.addPass(InstCombinePass());
 383
 384   return FPM;
 385 }
 386
 387 static void addPGOInstrPasses(ModulePassManager &MPM, bool DebugLogging,
 388                               PassBuilder::OptimizationLevel Level,
 389                               bool RunProfileGen, std::string ProfileGenFile,
 390                               std::string ProfileUseFile) {
 391   // Generally running simplification passes and the inliner with an high
 392   // threshold results in smaller executables, but there may be cases where
 393   // the size grows, so let's be conservative here and skip this simplification
 394   // at -Os/Oz.
 395   if (!isOptimizingForSize(Level)) {
 396     InlineParams IP;
 397
 398     // In the old pass manager, this is a cl::opt. Should still this be one?
 399     IP.DefaultThreshold = 75;
 400
 401     // FIXME: The hint threshold has the same value used by the regular inliner.
 402     // This should probably be lowered after performance testing.
 403     // FIXME: this comment is cargo culted from the old pass manager, revisit).
 404     IP.HintThreshold = 325;
 405
 406     CGSCCPassManager CGPipeline(DebugLogging);
 407
 408     CGPipeline.addPass(InlinerPass(IP));
 409
 410     FunctionPassManager FPM;
 411     FPM.addPass(SROA());
 412     FPM.addPass(EarlyCSEPass());    // Catch trivial redundancies.
 413     FPM.addPass(SimplifyCFGPass()); // Merge & remove basic blocks.
 414     FPM.addPass(InstCombinePass()); // Combine silly sequences.
 415
 416     // FIXME: Here the old pass manager inserts peephole extensions.
 417     // Add them when they're supported.
 418     CGPipeline.addPass(createCGSCCToFunctionPassAdaptor(std::move(FPM)));
 419
 420     MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPipeline)));
 421   }
 422
 423   if (RunProfileGen) {
 424     MPM.addPass(PGOInstrumentationGen());
 425
 426     // Add the profile lowering pass.
 427     InstrProfOptions Options;
 428     if (!ProfileGenFile.empty())
 429       Options.InstrProfileOutput = ProfileGenFile;
 430     MPM.addPass(InstrProfiling(Options));
 431   }
 432
 433   if (!ProfileUseFile.empty())
 434     MPM.addPass(PGOInstrumentationUse(ProfileUseFile));
 435 }
 436
 437 ModulePassManager
 438 PassBuilder::buildPerModuleDefaultPipeline(OptimizationLevel Level,
 439                                            bool DebugLogging) {
 440   assert(Level != O0 && "Must request optimizations for the default pipeline!");
 441   ModulePassManager MPM(DebugLogging);
 442
 443   // Force any function attributes we want the rest of the pipeline te observe.
 444   MPM.addPass(ForceFunctionAttrsPass());
 445
 446   // Do basic inference of function attributes from known properties of system
 447   // libraries and other oracles.
 448   MPM.addPass(InferFunctionAttrsPass());
 449
 450   // Create an early function pass manager to cleanup the output of the
 451   // frontend.
 452   FunctionPassManager EarlyFPM(DebugLogging);
 453   EarlyFPM.addPass(SimplifyCFGPass());
 454   EarlyFPM.addPass(SROA());
 455   EarlyFPM.addPass(EarlyCSEPass());
 456   EarlyFPM.addPass(LowerExpectIntrinsicPass());
 457   EarlyFPM.addPass(GVNHoistPass());
 458   MPM.addPass(createModuleToFunctionPassAdaptor(std::move(EarlyFPM)));
 459
 460   // Interprocedural constant propagation now that basic cleanup has occured
 461   // and prior to optimizing globals.
 462   // FIXME: This position in the pipeline hasn't been carefully considered in
 463   // years, it should be re-analyzed.
 464   MPM.addPass(IPSCCPPass());
 465
 466   // Optimize globals to try and fold them into constants.
 467   MPM.addPass(GlobalOptPass());
 468
 469   // Promote any localized globals to SSA registers.
 470   // FIXME: Should this instead by a run of SROA?
 471   // FIXME: We should probably run instcombine and simplify-cfg afterward to
 472   // delete control flows that are dead once globals have been folded to
 473   // constants.
 474   MPM.addPass(createModuleToFunctionPassAdaptor(PromotePass()));
 475
 476   // Remove any dead arguments exposed by cleanups and constand folding
 477   // globals.
 478   MPM.addPass(DeadArgumentEliminationPass());
 479
 480   // Create a small function pass pipeline to cleanup after all the global
 481   // optimizations.
 482   FunctionPassManager GlobalCleanupPM(DebugLogging);
 483   GlobalCleanupPM.addPass(InstCombinePass());
 484   GlobalCleanupPM.addPass(SimplifyCFGPass());
 485   MPM.addPass(createModuleToFunctionPassAdaptor(std::move(GlobalCleanupPM)));
 486
 487   // Add all the requested passes for PGO Instrumentation, if requested.
 488   if (PGOOpt) {
 489     assert(PGOOpt->RunProfileGen || PGOOpt->SamplePGO ||
 490            !PGOOpt->ProfileUseFile.empty());
 491     addPGOInstrPasses(MPM, DebugLogging, Level, PGOOpt->RunProfileGen,
 492                       PGOOpt->ProfileGenFile, PGOOpt->ProfileUseFile);
 493   }
 494
 495   // Indirect call promotion that promotes intra-module targes only.
 496   MPM.addPass(PGOIndirectCallPromotion(false, PGOOpt && PGOOpt->SamplePGO));
 497
 498   // Require the GlobalsAA analysis for the module so we can query it within
 499   // the CGSCC pipeline.
 500   MPM.addPass(RequireAnalysisPass<GlobalsAA, Module>());
 501
 502   // Now begin the main postorder CGSCC pipeline.
 503   // FIXME: The current CGSCC pipeline has its origins in the legacy pass
 504   // manager and trying to emulate its precise behavior. Much of this doesn't
 505   // make a lot of sense and we should revisit the core CGSCC structure.
 506   CGSCCPassManager MainCGPipeline(DebugLogging);
 507
 508   // Note: historically, the PruneEH pass was run first to deduce nounwind and
 509   // generally clean up exception handling overhead. It isn't clear this is
 510   // valuable as the inliner doesn't currently care whether it is inlining an
 511   // invoke or a call.
 512
 513   // Run the inliner first. The theory is that we are walking bottom-up and so
 514   // the callees have already been fully optimized, and we want to inline them
 515   // into the callers so that our optimizations can reflect that.
 516   // FIXME; Customize the threshold based on optimization level.
 517   MainCGPipeline.addPass(InlinerPass());
 518
 519   // Now deduce any function attributes based in the current code.
 520   MainCGPipeline.addPass(PostOrderFunctionAttrsPass());
 521
 522   // When at O3 add argument promotion to the pass pipeline.
 523   // FIXME: It isn't at all clear why this should be limited to O3.
 524   if (Level == O3)
 525     MainCGPipeline.addPass(ArgumentPromotionPass());
 526
 527   // Lastly, add the core function simplification pipeline nested inside the
 528   // CGSCC walk.
 529   MainCGPipeline.addPass(createCGSCCToFunctionPassAdaptor(
 530       buildFunctionSimplificationPipeline(Level, DebugLogging)));
 531
 532   // We wrap the CGSCC pipeline in a devirtualization repeater. This will try
 533   // to detect when we devirtualize indirect calls and iterate the SCC passes
 534   // in that case to try and catch knock-on inlining or function attrs
 535   // opportunities. Then we add it to the module pipeline by walking the SCCs
 536   // in postorder (or bottom-up).
 537   MPM.addPass(
 538       createModuleToPostOrderCGSCCPassAdaptor(createDevirtSCCRepeatedPass(
 539           std::move(MainCGPipeline), MaxDevirtIterations, DebugLogging)));
 540
 541   // This ends the canonicalization and simplification phase of the pipeline.
 542   // At this point, we expect to have canonical and simple IR which we begin
 543   // *optimizing* for efficient execution going forward.
 544
 545   // Eliminate externally available functions now that inlining is over -- we
 546   // won't emit these anyways.
 547   MPM.addPass(EliminateAvailableExternallyPass());
 548
 549   // Do RPO function attribute inference across the module to forward-propagate
 550   // attributes where applicable.
 551   // FIXME: Is this really an optimization rather than a canonicalization?
 552   MPM.addPass(ReversePostOrderFunctionAttrsPass());
 553
 554   // Re-require GloblasAA here prior to function passes. This is particularly
 555   // useful as the above will have inlined, DCE'ed, and function-attr
 556   // propagated everything. We should at this point have a reasonably minimal
 557   // and richly annotated call graph. By computing aliasing and mod/ref
 558   // information for all local globals here, the late loop passes and notably
 559   // the vectorizer will be able to use them to help recognize vectorizable
 560   // memory operations.
 561   MPM.addPass(RequireAnalysisPass<GlobalsAA, Module>());
 562
 563   FunctionPassManager OptimizePM(DebugLogging);
 564   OptimizePM.addPass(Float2IntPass());
 565   // FIXME: We need to run some loop optimizations to re-rotate loops after
 566   // simplify-cfg and others undo their rotation.
 567
 568   // Optimize the loop execution. These passes operate on entire loop nests
 569   // rather than on each loop in an inside-out manner, and so they are actually
 570   // function passes.
 571
 572   // First rotate loops that may have been un-rotated by prior passes.
 573   OptimizePM.addPass(createFunctionToLoopPassAdaptor(LoopRotatePass()));
 574
 575   // Distribute loops to allow partial vectorization.  I.e. isolate dependences
 576   // into separate loop that would otherwise inhibit vectorization.  This is
 577   // currently only performed for loops marked with the metadata
 578   // llvm.loop.distribute=true or when -enable-loop-distribute is specified.
 579   OptimizePM.addPass(LoopDistributePass());
 580
 581   // Now run the core loop vectorizer.
 582   OptimizePM.addPass(LoopVectorizePass());
 583
 584   // Eliminate loads by forwarding stores from the previous iteration to loads
 585   // of the current iteration.
 586   OptimizePM.addPass(LoopLoadEliminationPass());
 587
 588   // Cleanup after the loop optimization passes.
 589   OptimizePM.addPass(InstCombinePass());
 590
 591
 592   // Now that we've formed fast to execute loop structures, we do further
 593   // optimizations. These are run afterward as they might block doing complex
 594   // analyses and transforms such as what are needed for loop vectorization.
 595
 596   // Optimize parallel scalar instruction chains into SIMD instructions.
 597   OptimizePM.addPass(SLPVectorizerPass());
 598
 599   // Cleanup after all of the vectorizers.
 600   OptimizePM.addPass(SimplifyCFGPass());
 601   OptimizePM.addPass(InstCombinePass());
 602
 603   // Unroll small loops to hide loop backedge latency and saturate any parallel
 604   // execution resources of an out-of-order processor. We also then need to
 605   // clean up redundancies and loop invariant code.
 606   // FIXME: It would be really good to use a loop-integrated instruction
 607   // combiner for cleanup here so that the unrolling and LICM can be pipelined
 608   // across the loop nests.
 609   OptimizePM.addPass(createFunctionToLoopPassAdaptor(LoopUnrollPass::create(Level)));
 610   OptimizePM.addPass(InstCombinePass());
 611   OptimizePM.addPass(RequireAnalysisPass<OptimizationRemarkEmitterAnalysis, Function>());
 612   OptimizePM.addPass(createFunctionToLoopPassAdaptor(LICMPass()));
 613
 614   // Now that we've vectorized and unrolled loops, we may have more refined
 615   // alignment information, try to re-derive it here.
 616   OptimizePM.addPass(AlignmentFromAssumptionsPass());
 617
 618   // LoopSink pass sinks instructions hoisted by LICM, which serves as a
 619   // canonicalization pass that enables other optimizations. As a result,
 620   // LoopSink pass needs to be a very late IR pass to avoid undoing LICM
 621   // result too early.
 622   OptimizePM.addPass(LoopSinkPass());
 623
 624   // And finally clean up LCSSA form before generating code.
 625   OptimizePM.addPass(InstSimplifierPass());
 626
 627   // LoopSink (and other loop passes since the last simplifyCFG) might have
 628   // resulted in single-entry-single-exit or empty blocks. Clean up the CFG.
 629   OptimizePM.addPass(SimplifyCFGPass());
 630
 631   // Add the core optimizing pipeline.
 632   MPM.addPass(createModuleToFunctionPassAdaptor(std::move(OptimizePM)));
 633
 634   // Now we need to do some global optimization transforms.
 635   // FIXME: It would seem like these should come first in the optimization
 636   // pipeline and maybe be the bottom of the canonicalization pipeline? Weird
 637   // ordering here.
 638   MPM.addPass(GlobalDCEPass());
 639   MPM.addPass(ConstantMergePass());
 640
 641   return MPM;
 642 }
 643
 644 ModulePassManager
 645 PassBuilder::buildLTOPreLinkDefaultPipeline(OptimizationLevel Level,
 646                                             bool DebugLogging) {
 647   assert(Level != O0 && "Must request optimizations for the default pipeline!");
 648   // FIXME: We should use a customized pre-link pipeline!
 649   return buildPerModuleDefaultPipeline(Level, DebugLogging);
 650 }
 651
 652 ModulePassManager PassBuilder::buildLTODefaultPipeline(OptimizationLevel Level,
 653                                                        bool DebugLogging) {
 654   assert(Level != O0 && "Must request optimizations for the default pipeline!");
 655   ModulePassManager MPM(DebugLogging);
 656
 657   // Remove unused virtual tables to improve the quality of code generated by
 658   // whole-program devirtualization and bitset lowering.
 659   MPM.addPass(GlobalDCEPass());
 660
 661   // Force any function attributes we want the rest of the pipeline to observe.
 662   MPM.addPass(ForceFunctionAttrsPass());
 663
 664   // Do basic inference of function attributes from known properties of system
 665   // libraries and other oracles.
 666   MPM.addPass(InferFunctionAttrsPass());
 667
 668   if (Level > 1) {
 669     // Indirect call promotion. This should promote all the targets that are
 670     // left by the earlier promotion pass that promotes intra-module targets.
 671     // This two-step promotion is to save the compile time. For LTO, it should
 672     // produce the same result as if we only do promotion here.
 673     MPM.addPass(PGOIndirectCallPromotion(true /* InLTO */,
 674                                          PGOOpt && PGOOpt->SamplePGO));
 675
 676     // Propagate constants at call sites into the functions they call.  This
 677     // opens opportunities for globalopt (and inlining) by substituting function
 678     // pointers passed as arguments to direct uses of functions.
 679    MPM.addPass(IPSCCPPass());
 680   }
 681
 682   // Now deduce any function attributes based in the current code.
 683   MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(
 684               PostOrderFunctionAttrsPass()));
 685
 686   // Do RPO function attribute inference across the module to forward-propagate
 687   // attributes where applicable.
 688   // FIXME: Is this really an optimization rather than a canonicalization?
 689   MPM.addPass(ReversePostOrderFunctionAttrsPass());
 690
 691   // Use inragne annotations on GEP indices to split globals where beneficial.
 692   MPM.addPass(GlobalSplitPass());
 693
 694   // Run whole program optimization of virtual call when the list of callees
 695   // is fixed.
 696   MPM.addPass(WholeProgramDevirtPass());
 697
 698   // Stop here at -O1.
 699   if (Level == 1)
 700     return MPM;
 701
 702   // Optimize globals to try and fold them into constants.
 703   MPM.addPass(GlobalOptPass());
 704
 705   // Promote any localized globals to SSA registers.
 706   MPM.addPass(createModuleToFunctionPassAdaptor(PromotePass()));
 707
 708   // Linking modules together can lead to duplicate global constant, only
 709   // keep one copy of each constant.
 710   MPM.addPass(ConstantMergePass());
 711
 712   // Remove unused arguments from functions.
 713   MPM.addPass(DeadArgumentEliminationPass());
 714
 715   // Reduce the code after globalopt and ipsccp.  Both can open up significant
 716   // simplification opportunities, and both can propagate functions through
 717   // function pointers.  When this happens, we often have to resolve varargs
 718   // calls, etc, so let instcombine do this.
 719   // FIXME: add peephole extensions here as the legacy PM does.
 720   MPM.addPass(createModuleToFunctionPassAdaptor(InstCombinePass()));
 721
 722   // Note: historically, the PruneEH pass was run first to deduce nounwind and
 723   // generally clean up exception handling overhead. It isn't clear this is
 724   // valuable as the inliner doesn't currently care whether it is inlining an
 725   // invoke or a call.
 726   // Run the inliner now.
 727   MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(InlinerPass()));
 728
 729   // Optimize globals again after we ran the inliner.
 730   MPM.addPass(GlobalOptPass());
 731
 732   // Garbage collect dead functions.
 733   // FIXME: Add ArgumentPromotion pass after once it's ported.
 734   MPM.addPass(GlobalDCEPass());
 735
 736   FunctionPassManager FPM(DebugLogging);
 737
 738   // The IPO Passes may leave cruft around. Clean up after them.
 739   // FIXME: add peephole extensions here as the legacy PM does.
 740   FPM.addPass(InstCombinePass());
 741   FPM.addPass(JumpThreadingPass());
 742
 743   // Break up allocas
 744   FPM.addPass(SROA());
 745
 746   // Run a few AA driver optimizations here and now to cleanup the code.
 747   MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
 748
 749   MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(
 750               PostOrderFunctionAttrsPass()));
 751   // FIXME: here we run IP alias analysis in the legacy PM.
 752
 753   FunctionPassManager MainFPM;
 754
 755   // FIXME: once we fix LoopPass Manager, add LICM here.
 756   // FIXME: once we provide support for enabling MLSM, add it here.
 757   // FIXME: once we provide support for enabling NewGVN, add it here.
 758   MainFPM.addPass(GVN());
 759
 760   // Remove dead memcpy()'s.
 761   MainFPM.addPass(MemCpyOptPass());
 762
 763   // Nuke dead stores.
 764   MainFPM.addPass(DSEPass());
 765
 766   // FIXME: at this point, we run a bunch of loop passes:
 767   // indVarSimplify, loopDeletion, loopInterchange, loopUnrool,
 768   // loopVectorize. Enable them once the remaining issue with LPM
 769   // are sorted out.
 770
 771   MainFPM.addPass(InstCombinePass());
 772   MainFPM.addPass(SimplifyCFGPass());
 773   MainFPM.addPass(SCCPPass());
 774   MainFPM.addPass(InstCombinePass());
 775   MainFPM.addPass(BDCEPass());
 776
 777   // FIXME: We may want to run SLPVectorizer here.
 778   // After vectorization, assume intrinsics may tell us more
 779   // about pointer alignments.
 780 #if 0
 781   MainFPM.add(AlignmentFromAssumptionsPass());
 782 #endif
 783
 784   // FIXME: Conditionally run LoadCombine here, after it's ported
 785   // (in case we still have this pass, given its questionable usefulness).
 786
 787   // FIXME: add peephole extensions to the PM here.
 788   MainFPM.addPass(InstCombinePass());
 789   MainFPM.addPass(JumpThreadingPass());
 790   MPM.addPass(createModuleToFunctionPassAdaptor(std::move(MainFPM)));
 791
 792   // Create a function that performs CFI checks for cross-DSO calls with
 793   // targets in the current module.
 794   MPM.addPass(CrossDSOCFIPass());
 795
 796   // Lower type metadata and the type.test intrinsic. This pass supports
 797   // clang's control flow integrity mechanisms (-fsanitize=cfi*) and needs
 798   // to be run at link time if CFI is enabled. This pass does nothing if
 799   // CFI is disabled.
 800   // Enable once we add support for the summary in the new PM.
 801 #if 0
 802   MPM.addPass(LowerTypeTestsPass(Summary ? PassSummaryAction::Export :
 803                                            PassSummaryAction::None,
 804                                 Summary));
 805 #endif
 806
 807   // Add late LTO optimization passes.
 808   // Delete basic blocks, which optimization passes may have killed.
 809   MPM.addPass(createModuleToFunctionPassAdaptor(SimplifyCFGPass()));
 810
 811   // Drop bodies of available eternally objects to improve GlobalDCE.
 812   MPM.addPass(EliminateAvailableExternallyPass());
 813
 814   // Now that we have optimized the program, discard unreachable functions.
 815   MPM.addPass(GlobalDCEPass());
 816
 817   // FIXME: Enable MergeFuncs, conditionally, after ported, maybe.
 818   return MPM;
 819 }
 820
 821 AAManager PassBuilder::buildDefaultAAPipeline() {
 822   AAManager AA;
 823
 824   // The order in which these are registered determines their priority when
 825   // being queried.
 826
 827   // First we register the basic alias analysis that provides the majority of
 828   // per-function local AA logic. This is a stateless, on-demand local set of
 829   // AA techniques.
 830   AA.registerFunctionAnalysis<BasicAA>();
 831
 832   // Next we query fast, specialized alias analyses that wrap IR-embedded
 833   // information about aliasing.
 834   AA.registerFunctionAnalysis<ScopedNoAliasAA>();
 835   AA.registerFunctionAnalysis<TypeBasedAA>();
 836
 837   // Add support for querying global aliasing information when available.
 838   // Because the `AAManager` is a function analysis and `GlobalsAA` is a module
 839   // analysis, all that the `AAManager` can do is query for any *cached*
 840   // results from `GlobalsAA` through a readonly proxy.
 841   AA.registerModuleAnalysis<GlobalsAA>();
 842
 843   return AA;
 844 }
 845
 846 static Optional<int> parseRepeatPassName(StringRef Name) {
 847   if (!Name.consume_front("repeat<") || !Name.consume_back(">"))
 848     return None;
 849   int Count;
 850   if (Name.getAsInteger(0, Count) || Count <= 0)
 851     return None;
 852   return Count;
 853 }
 854
 855 static Optional<int> parseDevirtPassName(StringRef Name) {
 856   if (!Name.consume_front("devirt<") || !Name.consume_back(">"))
 857     return None;
 858   int Count;
 859   if (Name.getAsInteger(0, Count) || Count <= 0)
 860     return None;
 861   return Count;
 862 }
 863
 864 static bool isModulePassName(StringRef Name) {
 865   // Manually handle aliases for pre-configured pipeline fragments.
 866   if (Name.startswith("default") || Name.startswith("lto"))
 867     return DefaultAliasRegex.match(Name);
 868
 869   // Explicitly handle pass manager names.
 870   if (Name == "module")
 871     return true;
 872   if (Name == "cgscc")
 873     return true;
 874   if (Name == "function")
 875     return true;
 876
 877   // Explicitly handle custom-parsed pass names.
 878   if (parseRepeatPassName(Name))
 879     return true;
 880
 881 #define MODULE_PASS(NAME, CREATE_PASS)                                         \
 882   if (Name == NAME)                                                            \
 883     return true;
 884 #define MODULE_ANALYSIS(NAME, CREATE_PASS)                                     \
 885   if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">")           \
 886     return true;
 887 #include "PassRegistry.def"
 888
 889   return false;
 890 }
 891
 892 static bool isCGSCCPassName(StringRef Name) {
 893   // Explicitly handle pass manager names.
 894   if (Name == "cgscc")
 895     return true;
 896   if (Name == "function")
 897     return true;
 898
 899   // Explicitly handle custom-parsed pass names.
 900   if (parseRepeatPassName(Name))
 901     return true;
 902   if (parseDevirtPassName(Name))
 903     return true;
 904
 905 #define CGSCC_PASS(NAME, CREATE_PASS)                                          \
 906   if (Name == NAME)                                                            \
 907     return true;
 908 #define CGSCC_ANALYSIS(NAME, CREATE_PASS)                                      \
 909   if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">")           \
 910     return true;
 911 #include "PassRegistry.def"
 912
 913   return false;
 914 }
 915
 916 static bool isFunctionPassName(StringRef Name) {
 917   // Explicitly handle pass manager names.
 918   if (Name == "function")
 919     return true;
 920   if (Name == "loop")
 921     return true;
 922
 923   // Explicitly handle custom-parsed pass names.
 924   if (parseRepeatPassName(Name))
 925     return true;
 926
 927 #define FUNCTION_PASS(NAME, CREATE_PASS)                                       \
 928   if (Name == NAME)                                                            \
 929     return true;
 930 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS)                                   \
 931   if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">")           \
 932     return true;
 933 #include "PassRegistry.def"
 934
 935   return false;
 936 }
 937
 938 static bool isLoopPassName(StringRef Name) {
 939   // Explicitly handle pass manager names.
 940   if (Name == "loop")
 941     return true;
 942
 943   // Explicitly handle custom-parsed pass names.
 944   if (parseRepeatPassName(Name))
 945     return true;
 946
 947 #define LOOP_PASS(NAME, CREATE_PASS)                                           \
 948   if (Name == NAME)                                                            \
 949     return true;
 950 #define LOOP_ANALYSIS(NAME, CREATE_PASS)                                       \
 951   if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">")           \
 952     return true;
 953 #include "PassRegistry.def"
 954
 955   return false;
 956 }
 957
 958 Optional<std::vector<PassBuilder::PipelineElement>>
 959 PassBuilder::parsePipelineText(StringRef Text) {
 960   std::vector<PipelineElement> ResultPipeline;
 961
 962   SmallVector<std::vector<PipelineElement> *, 4> PipelineStack = {
 963       &ResultPipeline};
 964   for (;;) {
 965     std::vector<PipelineElement> &Pipeline = *PipelineStack.back();
 966     size_t Pos = Text.find_first_of(",()");
 967     Pipeline.push_back({Text.substr(0, Pos), {}});
 968
 969     // If we have a single terminating name, we're done.
 970     if (Pos == Text.npos)
 971       break;
 972
 973     char Sep = Text[Pos];
 974     Text = Text.substr(Pos + 1);
 975     if (Sep == ',')
 976       // Just a name ending in a comma, continue.
 977       continue;
 978
 979     if (Sep == '(') {
 980       // Push the inner pipeline onto the stack to continue processing.
 981       PipelineStack.push_back(&Pipeline.back().InnerPipeline);
 982       continue;
 983     }
 984
 985     assert(Sep == ')' && "Bogus separator!");
 986     // When handling the close parenthesis, we greedily consume them to avoid
 987     // empty strings in the pipeline.
 988     do {
 989       // If we try to pop the outer pipeline we have unbalanced parentheses.
 990       if (PipelineStack.size() == 1)
 991         return None;
 992
 993       PipelineStack.pop_back();
 994     } while (Text.consume_front(")"));
 995
 996     // Check if we've finished parsing.
 997     if (Text.empty())
 998       break;
 999
1000     // Otherwise, the end of an inner pipeline always has to be followed by
1001     // a comma, and then we can continue.
1002     if (!Text.consume_front(","))
1003       return None;
1004   }
1005
1006   if (PipelineStack.size() > 1)
1007     // Unbalanced paretheses.
1008     return None;
1009
1010   assert(PipelineStack.back() == &ResultPipeline &&
1011          "Wrong pipeline at the bottom of the stack!");
1012   return {std::move(ResultPipeline)};
1013 }
1014
1015 bool PassBuilder::parseModulePass(ModulePassManager &MPM,
1016                                   const PipelineElement &E, bool VerifyEachPass,
1017                                   bool DebugLogging) {
1018   auto &Name = E.Name;
1019   auto &InnerPipeline = E.InnerPipeline;
1020
1021   // First handle complex passes like the pass managers which carry pipelines.
1022   if (!InnerPipeline.empty()) {
1023     if (Name == "module") {
1024       ModulePassManager NestedMPM(DebugLogging);
1025       if (!parseModulePassPipeline(NestedMPM, InnerPipeline, VerifyEachPass,
1026                                    DebugLogging))
1027         return false;
1028       MPM.addPass(std::move(NestedMPM));
1029       return true;
1030     }
1031     if (Name == "cgscc") {
1032       CGSCCPassManager CGPM(DebugLogging);
1033       if (!parseCGSCCPassPipeline(CGPM, InnerPipeline, VerifyEachPass,
1034                                   DebugLogging))
1035         return false;
1036       MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPM),
1037                                                           DebugLogging));
1038       return true;
1039     }
1040     if (Name == "function") {
1041       FunctionPassManager FPM(DebugLogging);
1042       if (!parseFunctionPassPipeline(FPM, InnerPipeline, VerifyEachPass,
1043                                      DebugLogging))
1044         return false;
1045       MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
1046       return true;
1047     }
1048     if (auto Count = parseRepeatPassName(Name)) {
1049       ModulePassManager NestedMPM(DebugLogging);
1050       if (!parseModulePassPipeline(NestedMPM, InnerPipeline, VerifyEachPass,
1051                                    DebugLogging))
1052         return false;
1053       MPM.addPass(createRepeatedPass(*Count, std::move(NestedMPM)));
1054       return true;
1055     }
1056     // Normal passes can't have pipelines.
1057     return false;
1058   }
1059
1060   // Manually handle aliases for pre-configured pipeline fragments.
1061   if (Name.startswith("default") || Name.startswith("lto")) {
1062     SmallVector<StringRef, 3> Matches;
1063     if (!DefaultAliasRegex.match(Name, &Matches))
1064       return false;
1065     assert(Matches.size() == 3 && "Must capture two matched strings!");
1066
1067     OptimizationLevel L = StringSwitch<OptimizationLevel>(Matches[2])
1068         .Case("O0", O0)
1069         .Case("O1", O1)
1070         .Case("O2", O2)
1071         .Case("O3", O3)
1072         .Case("Os", Os)
1073         .Case("Oz", Oz);
1074     if (L == O0)
1075       // At O0 we do nothing at all!
1076       return true;
1077
1078     if (Matches[1] == "default") {
1079       MPM.addPass(buildPerModuleDefaultPipeline(L, DebugLogging));
1080     } else if (Matches[1] == "lto-pre-link") {
1081       MPM.addPass(buildLTOPreLinkDefaultPipeline(L, DebugLogging));
1082     } else {
1083       assert(Matches[1] == "lto" && "Not one of the matched options!");
1084       MPM.addPass(buildLTODefaultPipeline(L, DebugLogging));
1085     }
1086     return true;
1087   }
1088
1089   // Finally expand the basic registered passes from the .inc file.
1090 #define MODULE_PASS(NAME, CREATE_PASS)                                         \
1091   if (Name == NAME) {                                                          \
1092     MPM.addPass(CREATE_PASS);                                                  \
1093     return true;                                                               \
1094   }
1095 #define MODULE_ANALYSIS(NAME, CREATE_PASS)                                     \
1096   if (Name == "require<" NAME ">") {                                           \
1097     MPM.addPass(                                                               \
1098         RequireAnalysisPass<                                                   \
1099             std::remove_reference<decltype(CREATE_PASS)>::type, Module>());    \
1100     return true;                                                               \
1101   }                                                                            \
1102   if (Name == "invalidate<" NAME ">") {                                        \
1103     MPM.addPass(InvalidateAnalysisPass<                                        \
1104                 std::remove_reference<decltype(CREATE_PASS)>::type>());        \
1105     return true;                                                               \
1106   }
1107 #include "PassRegistry.def"
1108
1109   return false;
1110 }
1111
1112 bool PassBuilder::parseCGSCCPass(CGSCCPassManager &CGPM,
1113                                  const PipelineElement &E, bool VerifyEachPass,
1114                                  bool DebugLogging) {
1115   auto &Name = E.Name;
1116   auto &InnerPipeline = E.InnerPipeline;
1117
1118   // First handle complex passes like the pass managers which carry pipelines.
1119   if (!InnerPipeline.empty()) {
1120     if (Name == "cgscc") {
1121       CGSCCPassManager NestedCGPM(DebugLogging);
1122       if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
1123                                   DebugLogging))
1124         return false;
1125       // Add the nested pass manager with the appropriate adaptor.
1126       CGPM.addPass(std::move(NestedCGPM));
1127       return true;
1128     }
1129     if (Name == "function") {
1130       FunctionPassManager FPM(DebugLogging);
1131       if (!parseFunctionPassPipeline(FPM, InnerPipeline, VerifyEachPass,
1132                                      DebugLogging))
1133         return false;
1134       // Add the nested pass manager with the appropriate adaptor.
1135       CGPM.addPass(
1136           createCGSCCToFunctionPassAdaptor(std::move(FPM), DebugLogging));
1137       return true;
1138     }
1139     if (auto Count = parseRepeatPassName(Name)) {
1140       CGSCCPassManager NestedCGPM(DebugLogging);
1141       if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
1142                                   DebugLogging))
1143         return false;
1144       CGPM.addPass(createRepeatedPass(*Count, std::move(NestedCGPM)));
1145       return true;
1146     }
1147     if (auto MaxRepetitions = parseDevirtPassName(Name)) {
1148       CGSCCPassManager NestedCGPM(DebugLogging);
1149       if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
1150                                   DebugLogging))
1151         return false;
1152       CGPM.addPass(createDevirtSCCRepeatedPass(std::move(NestedCGPM),
1153                                                *MaxRepetitions, DebugLogging));
1154       return true;
1155     }
1156     // Normal passes can't have pipelines.
1157     return false;
1158   }
1159
1160   // Now expand the basic registered passes from the .inc file.
1161 #define CGSCC_PASS(NAME, CREATE_PASS)                                          \
1162   if (Name == NAME) {                                                          \
1163     CGPM.addPass(CREATE_PASS);                                                 \
1164     return true;                                                               \
1165   }
1166 #define CGSCC_ANALYSIS(NAME, CREATE_PASS)                                      \
1167   if (Name == "require<" NAME ">") {                                           \
1168     CGPM.addPass(RequireAnalysisPass<                                          \
1169                  std::remove_reference<decltype(CREATE_PASS)>::type,           \
1170                  LazyCallGraph::SCC, CGSCCAnalysisManager, LazyCallGraph &,    \
1171                  CGSCCUpdateResult &>());                                      \
1172     return true;                                                               \
1173   }                                                                            \
1174   if (Name == "invalidate<" NAME ">") {                                        \
1175     CGPM.addPass(InvalidateAnalysisPass<                                       \
1176                  std::remove_reference<decltype(CREATE_PASS)>::type>());       \
1177     return true;                                                               \
1178   }
1179 #include "PassRegistry.def"
1180
1181   return false;
1182 }
1183
1184 bool PassBuilder::parseFunctionPass(FunctionPassManager &FPM,
1185                                     const PipelineElement &E,
1186                                     bool VerifyEachPass, bool DebugLogging) {
1187   auto &Name = E.Name;
1188   auto &InnerPipeline = E.InnerPipeline;
1189
1190   // First handle complex passes like the pass managers which carry pipelines.
1191   if (!InnerPipeline.empty()) {
1192     if (Name == "function") {
1193       FunctionPassManager NestedFPM(DebugLogging);
1194       if (!parseFunctionPassPipeline(NestedFPM, InnerPipeline, VerifyEachPass,
1195                                      DebugLogging))
1196         return false;
1197       // Add the nested pass manager with the appropriate adaptor.
1198       FPM.addPass(std::move(NestedFPM));
1199       return true;
1200     }
1201     if (Name == "loop") {
1202       LoopPassManager LPM(DebugLogging);
1203       if (!parseLoopPassPipeline(LPM, InnerPipeline, VerifyEachPass,
1204                                  DebugLogging))
1205         return false;
1206       // Add the nested pass manager with the appropriate adaptor.
1207       FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM)));
1208       return true;
1209     }
1210     if (auto Count = parseRepeatPassName(Name)) {
1211       FunctionPassManager NestedFPM(DebugLogging);
1212       if (!parseFunctionPassPipeline(NestedFPM, InnerPipeline, VerifyEachPass,
1213                                      DebugLogging))
1214         return false;
1215       FPM.addPass(createRepeatedPass(*Count, std::move(NestedFPM)));
1216       return true;
1217     }
1218     // Normal passes can't have pipelines.
1219     return false;
1220   }
1221
1222   // Now expand the basic registered passes from the .inc file.
1223 #define FUNCTION_PASS(NAME, CREATE_PASS)                                       \
1224   if (Name == NAME) {                                                          \
1225     FPM.addPass(CREATE_PASS);                                                  \
1226     return true;                                                               \
1227   }
1228 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS)                                   \
1229   if (Name == "require<" NAME ">") {                                           \
1230     FPM.addPass(                                                               \
1231         RequireAnalysisPass<                                                   \
1232             std::remove_reference<decltype(CREATE_PASS)>::type, Function>());  \
1233     return true;                                                               \
1234   }                                                                            \
1235   if (Name == "invalidate<" NAME ">") {                                        \
1236     FPM.addPass(InvalidateAnalysisPass<                                        \
1237                 std::remove_reference<decltype(CREATE_PASS)>::type>());        \
1238     return true;                                                               \
1239   }
1240 #include "PassRegistry.def"
1241
1242   return false;
1243 }
1244
1245 bool PassBuilder::parseLoopPass(LoopPassManager &LPM, const PipelineElement &E,
1246                                 bool VerifyEachPass, bool DebugLogging) {
1247   StringRef Name = E.Name;
1248   auto &InnerPipeline = E.InnerPipeline;
1249
1250   // First handle complex passes like the pass managers which carry pipelines.
1251   if (!InnerPipeline.empty()) {
1252     if (Name == "loop") {
1253       LoopPassManager NestedLPM(DebugLogging);
1254       if (!parseLoopPassPipeline(NestedLPM, InnerPipeline, VerifyEachPass,
1255                                  DebugLogging))
1256         return false;
1257       // Add the nested pass manager with the appropriate adaptor.
1258       LPM.addPass(std::move(NestedLPM));
1259       return true;
1260     }
1261     if (auto Count = parseRepeatPassName(Name)) {
1262       LoopPassManager NestedLPM(DebugLogging);
1263       if (!parseLoopPassPipeline(NestedLPM, InnerPipeline, VerifyEachPass,
1264                                  DebugLogging))
1265         return false;
1266       LPM.addPass(createRepeatedPass(*Count, std::move(NestedLPM)));
1267       return true;
1268     }
1269     // Normal passes can't have pipelines.
1270     return false;
1271   }
1272
1273   // Now expand the basic registered passes from the .inc file.
1274 #define LOOP_PASS(NAME, CREATE_PASS)                                           \
1275   if (Name == NAME) {                                                          \
1276     LPM.addPass(CREATE_PASS);                                                  \
1277     return true;                                                               \
1278   }
1279 #define LOOP_ANALYSIS(NAME, CREATE_PASS)                                       \
1280   if (Name == "require<" NAME ">") {                                           \
1281     LPM.addPass(RequireAnalysisPass<                                           \
1282                 std::remove_reference<decltype(CREATE_PASS)>::type, Loop,      \
1283                 LoopAnalysisManager, LoopStandardAnalysisResults &,            \
1284                 LPMUpdater &>());                                              \
1285     return true;                                                               \
1286   }                                                                            \
1287   if (Name == "invalidate<" NAME ">") {                                        \
1288     LPM.addPass(InvalidateAnalysisPass<                                        \
1289                 std::remove_reference<decltype(CREATE_PASS)>::type>());        \
1290     return true;                                                               \
1291   }
1292 #include "PassRegistry.def"
1293
1294   return false;
1295 }
1296
1297 bool PassBuilder::parseAAPassName(AAManager &AA, StringRef Name) {
1298 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS)                               \
1299   if (Name == NAME) {                                                          \
1300     AA.registerModuleAnalysis<                                                 \
1301         std::remove_reference<decltype(CREATE_PASS)>::type>();                 \
1302     return true;                                                               \
1303   }
1304 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS)                             \
1305   if (Name == NAME) {                                                          \
1306     AA.registerFunctionAnalysis<                                               \
1307         std::remove_reference<decltype(CREATE_PASS)>::type>();                 \
1308     return true;                                                               \
1309   }
1310 #include "PassRegistry.def"
1311
1312   return false;
1313 }
1314
1315 bool PassBuilder::parseLoopPassPipeline(LoopPassManager &LPM,
1316                                         ArrayRef<PipelineElement> Pipeline,
1317                                         bool VerifyEachPass,
1318                                         bool DebugLogging) {
1319   for (const auto &Element : Pipeline) {
1320     if (!parseLoopPass(LPM, Element, VerifyEachPass, DebugLogging))
1321       return false;
1322     // FIXME: No verifier support for Loop passes!
1323   }
1324   return true;
1325 }
1326
1327 bool PassBuilder::parseFunctionPassPipeline(FunctionPassManager &FPM,
1328                                             ArrayRef<PipelineElement> Pipeline,
1329                                             bool VerifyEachPass,
1330                                             bool DebugLogging) {
1331   for (const auto &Element : Pipeline) {
1332     if (!parseFunctionPass(FPM, Element, VerifyEachPass, DebugLogging))
1333       return false;
1334     if (VerifyEachPass)
1335       FPM.addPass(VerifierPass());
1336   }
1337   return true;
1338 }
1339
1340 bool PassBuilder::parseCGSCCPassPipeline(CGSCCPassManager &CGPM,
1341                                          ArrayRef<PipelineElement> Pipeline,
1342                                          bool VerifyEachPass,
1343                                          bool DebugLogging) {
1344   for (const auto &Element : Pipeline) {
1345     if (!parseCGSCCPass(CGPM, Element, VerifyEachPass, DebugLogging))
1346       return false;
1347     // FIXME: No verifier support for CGSCC passes!
1348   }
1349   return true;
1350 }
1351
1352 void PassBuilder::crossRegisterProxies(LoopAnalysisManager &LAM,
1353                                        FunctionAnalysisManager &FAM,
1354                                        CGSCCAnalysisManager &CGAM,
1355                                        ModuleAnalysisManager &MAM) {
1356   MAM.registerPass([&] { return FunctionAnalysisManagerModuleProxy(FAM); });
1357   MAM.registerPass([&] { return CGSCCAnalysisManagerModuleProxy(CGAM); });
1358   CGAM.registerPass([&] { return ModuleAnalysisManagerCGSCCProxy(MAM); });
1359   FAM.registerPass([&] { return CGSCCAnalysisManagerFunctionProxy(CGAM); });
1360   FAM.registerPass([&] { return ModuleAnalysisManagerFunctionProxy(MAM); });
1361   FAM.registerPass([&] { return LoopAnalysisManagerFunctionProxy(LAM); });
1362   LAM.registerPass([&] { return FunctionAnalysisManagerLoopProxy(FAM); });
1363 }
1364
1365 bool PassBuilder::parseModulePassPipeline(ModulePassManager &MPM,
1366                                           ArrayRef<PipelineElement> Pipeline,
1367                                           bool VerifyEachPass,
1368                                           bool DebugLogging) {
1369   for (const auto &Element : Pipeline) {
1370     if (!parseModulePass(MPM, Element, VerifyEachPass, DebugLogging))
1371       return false;
1372     if (VerifyEachPass)
1373       MPM.addPass(VerifierPass());
1374   }
1375   return true;
1376 }
1377
1378 // Primary pass pipeline description parsing routine.
1379 // FIXME: Should this routine accept a TargetMachine or require the caller to
1380 // pre-populate the analysis managers with target-specific stuff?
1381 bool PassBuilder::parsePassPipeline(ModulePassManager &MPM,
1382                                     StringRef PipelineText, bool VerifyEachPass,
1383                                     bool DebugLogging) {
1384   auto Pipeline = parsePipelineText(PipelineText);
1385   if (!Pipeline || Pipeline->empty())
1386     return false;
1387
1388   // If the first name isn't at the module layer, wrap the pipeline up
1389   // automatically.
1390   StringRef FirstName = Pipeline->front().Name;
1391
1392   if (!isModulePassName(FirstName)) {
1393     if (isCGSCCPassName(FirstName))
1394       Pipeline = {{"cgscc", std::move(*Pipeline)}};
1395     else if (isFunctionPassName(FirstName))
1396       Pipeline = {{"function", std::move(*Pipeline)}};
1397     else if (isLoopPassName(FirstName))
1398       Pipeline = {{"function", {{"loop", std::move(*Pipeline)}}}};
1399     else
1400       // Unknown pass name!
1401       return false;
1402   }
1403
1404   return parseModulePassPipeline(MPM, *Pipeline, VerifyEachPass, DebugLogging);
1405 }
1406
1407 bool PassBuilder::parseAAPipeline(AAManager &AA, StringRef PipelineText) {
1408   // If the pipeline just consists of the word 'default' just replace the AA
1409   // manager with our default one.
1410   if (PipelineText == "default") {
1411     AA = buildDefaultAAPipeline();
1412     return true;
1413   }
1414
1415   while (!PipelineText.empty()) {
1416     StringRef Name;
1417     std::tie(Name, PipelineText) = PipelineText.split(',');
1418     if (!parseAAPassName(AA, Name))
1419       return false;
1420   }
1421
1422   return true;
1423 }