1 //===- Parsing and selection of pass pipelines ----------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 /// \file 9 /// 10 /// This file provides the implementation of the PassBuilder based on our 11 /// static pass registry as well as related functionality. It also provides 12 /// helpers to aid in analyzing, debugging, and testing passes and pass 13 /// pipelines. 14 /// 15 //===----------------------------------------------------------------------===// 16 17 #include "llvm/Passes/PassBuilder.h" 18 #include "llvm/ADT/StringSwitch.h" 19 #include "llvm/Analysis/AliasAnalysisEvaluator.h" 20 #include "llvm/Analysis/AliasSetTracker.h" 21 #include "llvm/Analysis/AssumptionCache.h" 22 #include "llvm/Analysis/BasicAliasAnalysis.h" 23 #include "llvm/Analysis/BlockFrequencyInfo.h" 24 #include "llvm/Analysis/BranchProbabilityInfo.h" 25 #include "llvm/Analysis/CFGPrinter.h" 26 #include "llvm/Analysis/CFLAndersAliasAnalysis.h" 27 #include "llvm/Analysis/CFLSteensAliasAnalysis.h" 28 #include "llvm/Analysis/CGSCCPassManager.h" 29 #include "llvm/Analysis/CallGraph.h" 30 #include "llvm/Analysis/CallPrinter.h" 31 #include "llvm/Analysis/CostModel.h" 32 #include "llvm/Analysis/CycleAnalysis.h" 33 #include "llvm/Analysis/DDG.h" 34 #include "llvm/Analysis/DDGPrinter.h" 35 #include "llvm/Analysis/Delinearization.h" 36 #include "llvm/Analysis/DemandedBits.h" 37 #include "llvm/Analysis/DependenceAnalysis.h" 38 #include "llvm/Analysis/DivergenceAnalysis.h" 39 #include "llvm/Analysis/DomPrinter.h" 40 #include "llvm/Analysis/DominanceFrontier.h" 41 #include "llvm/Analysis/FunctionPropertiesAnalysis.h" 42 #include "llvm/Analysis/GlobalsModRef.h" 43 #include "llvm/Analysis/IRSimilarityIdentifier.h" 44 #include "llvm/Analysis/IVUsers.h" 45 #include "llvm/Analysis/InlineAdvisor.h" 46 #include "llvm/Analysis/InlineSizeEstimatorAnalysis.h" 47 #include "llvm/Analysis/InstCount.h" 48 #include "llvm/Analysis/LazyCallGraph.h" 49 #include "llvm/Analysis/LazyValueInfo.h" 50 #include "llvm/Analysis/Lint.h" 51 #include "llvm/Analysis/LoopAccessAnalysis.h" 52 #include "llvm/Analysis/LoopCacheAnalysis.h" 53 #include "llvm/Analysis/LoopInfo.h" 54 #include "llvm/Analysis/LoopNestAnalysis.h" 55 #include "llvm/Analysis/MemDerefPrinter.h" 56 #include "llvm/Analysis/MemoryDependenceAnalysis.h" 57 #include "llvm/Analysis/MemorySSA.h" 58 #include "llvm/Analysis/ModuleDebugInfoPrinter.h" 59 #include "llvm/Analysis/ModuleSummaryAnalysis.h" 60 #include "llvm/Analysis/MustExecute.h" 61 #include "llvm/Analysis/ObjCARCAliasAnalysis.h" 62 #include "llvm/Analysis/OptimizationRemarkEmitter.h" 63 #include "llvm/Analysis/PhiValues.h" 64 #include "llvm/Analysis/PostDominators.h" 65 #include "llvm/Analysis/ProfileSummaryInfo.h" 66 #include "llvm/Analysis/RegionInfo.h" 67 #include "llvm/Analysis/ScalarEvolution.h" 68 #include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h" 69 #include "llvm/Analysis/ScopedNoAliasAA.h" 70 #include "llvm/Analysis/StackLifetime.h" 71 #include "llvm/Analysis/StackSafetyAnalysis.h" 72 #include "llvm/Analysis/TargetLibraryInfo.h" 73 #include "llvm/Analysis/TargetTransformInfo.h" 74 #include "llvm/Analysis/TypeBasedAliasAnalysis.h" 75 #include "llvm/IR/Dominators.h" 76 #include "llvm/IR/IRPrintingPasses.h" 77 #include "llvm/IR/PassManager.h" 78 #include "llvm/IR/PrintPasses.h" 79 #include "llvm/IR/SafepointIRVerifier.h" 80 #include "llvm/IR/Verifier.h" 81 #include "llvm/Support/CommandLine.h" 82 #include "llvm/Support/Debug.h" 83 #include "llvm/Support/ErrorHandling.h" 84 #include "llvm/Support/FormatVariadic.h" 85 #include "llvm/Support/Regex.h" 86 #include "llvm/Target/TargetMachine.h" 87 #include "llvm/Transforms/AggressiveInstCombine/AggressiveInstCombine.h" 88 #include "llvm/Transforms/Coroutines/CoroCleanup.h" 89 #include "llvm/Transforms/Coroutines/CoroEarly.h" 90 #include "llvm/Transforms/Coroutines/CoroElide.h" 91 #include "llvm/Transforms/Coroutines/CoroSplit.h" 92 #include "llvm/Transforms/IPO/AlwaysInliner.h" 93 #include "llvm/Transforms/IPO/Annotation2Metadata.h" 94 #include "llvm/Transforms/IPO/ArgumentPromotion.h" 95 #include "llvm/Transforms/IPO/Attributor.h" 96 #include "llvm/Transforms/IPO/BlockExtractor.h" 97 #include "llvm/Transforms/IPO/CalledValuePropagation.h" 98 #include "llvm/Transforms/IPO/ConstantMerge.h" 99 #include "llvm/Transforms/IPO/CrossDSOCFI.h" 100 #include "llvm/Transforms/IPO/DeadArgumentElimination.h" 101 #include "llvm/Transforms/IPO/ElimAvailExtern.h" 102 #include "llvm/Transforms/IPO/ForceFunctionAttrs.h" 103 #include "llvm/Transforms/IPO/FunctionAttrs.h" 104 #include "llvm/Transforms/IPO/FunctionImport.h" 105 #include "llvm/Transforms/IPO/GlobalDCE.h" 106 #include "llvm/Transforms/IPO/GlobalOpt.h" 107 #include "llvm/Transforms/IPO/GlobalSplit.h" 108 #include "llvm/Transforms/IPO/HotColdSplitting.h" 109 #include "llvm/Transforms/IPO/IROutliner.h" 110 #include "llvm/Transforms/IPO/InferFunctionAttrs.h" 111 #include "llvm/Transforms/IPO/Inliner.h" 112 #include "llvm/Transforms/IPO/Internalize.h" 113 #include "llvm/Transforms/IPO/LoopExtractor.h" 114 #include "llvm/Transforms/IPO/LowerTypeTests.h" 115 #include "llvm/Transforms/IPO/MergeFunctions.h" 116 #include "llvm/Transforms/IPO/ModuleInliner.h" 117 #include "llvm/Transforms/IPO/OpenMPOpt.h" 118 #include "llvm/Transforms/IPO/PartialInlining.h" 119 #include "llvm/Transforms/IPO/SCCP.h" 120 #include "llvm/Transforms/IPO/SampleProfile.h" 121 #include "llvm/Transforms/IPO/SampleProfileProbe.h" 122 #include "llvm/Transforms/IPO/StripDeadPrototypes.h" 123 #include "llvm/Transforms/IPO/StripSymbols.h" 124 #include "llvm/Transforms/IPO/SyntheticCountsPropagation.h" 125 #include "llvm/Transforms/IPO/WholeProgramDevirt.h" 126 #include "llvm/Transforms/InstCombine/InstCombine.h" 127 #include "llvm/Transforms/Instrumentation.h" 128 #include "llvm/Transforms/Instrumentation/AddressSanitizer.h" 129 #include "llvm/Transforms/Instrumentation/BoundsChecking.h" 130 #include "llvm/Transforms/Instrumentation/CGProfile.h" 131 #include "llvm/Transforms/Instrumentation/ControlHeightReduction.h" 132 #include "llvm/Transforms/Instrumentation/DataFlowSanitizer.h" 133 #include "llvm/Transforms/Instrumentation/GCOVProfiler.h" 134 #include "llvm/Transforms/Instrumentation/HWAddressSanitizer.h" 135 #include "llvm/Transforms/Instrumentation/InstrOrderFile.h" 136 #include "llvm/Transforms/Instrumentation/InstrProfiling.h" 137 #include "llvm/Transforms/Instrumentation/MemProfiler.h" 138 #include "llvm/Transforms/Instrumentation/MemorySanitizer.h" 139 #include "llvm/Transforms/Instrumentation/PGOInstrumentation.h" 140 #include "llvm/Transforms/Instrumentation/PoisonChecking.h" 141 #include "llvm/Transforms/Instrumentation/SanitizerCoverage.h" 142 #include "llvm/Transforms/Instrumentation/ThreadSanitizer.h" 143 #include "llvm/Transforms/ObjCARC.h" 144 #include "llvm/Transforms/Scalar/ADCE.h" 145 #include "llvm/Transforms/Scalar/AlignmentFromAssumptions.h" 146 #include "llvm/Transforms/Scalar/AnnotationRemarks.h" 147 #include "llvm/Transforms/Scalar/BDCE.h" 148 #include "llvm/Transforms/Scalar/CallSiteSplitting.h" 149 #include "llvm/Transforms/Scalar/ConstantHoisting.h" 150 #include "llvm/Transforms/Scalar/ConstraintElimination.h" 151 #include "llvm/Transforms/Scalar/CorrelatedValuePropagation.h" 152 #include "llvm/Transforms/Scalar/DCE.h" 153 #include "llvm/Transforms/Scalar/DFAJumpThreading.h" 154 #include "llvm/Transforms/Scalar/DeadStoreElimination.h" 155 #include "llvm/Transforms/Scalar/DivRemPairs.h" 156 #include "llvm/Transforms/Scalar/EarlyCSE.h" 157 #include "llvm/Transforms/Scalar/FlattenCFG.h" 158 #include "llvm/Transforms/Scalar/Float2Int.h" 159 #include "llvm/Transforms/Scalar/GVN.h" 160 #include "llvm/Transforms/Scalar/GuardWidening.h" 161 #include "llvm/Transforms/Scalar/IVUsersPrinter.h" 162 #include "llvm/Transforms/Scalar/IndVarSimplify.h" 163 #include "llvm/Transforms/Scalar/InductiveRangeCheckElimination.h" 164 #include "llvm/Transforms/Scalar/InferAddressSpaces.h" 165 #include "llvm/Transforms/Scalar/InstSimplifyPass.h" 166 #include "llvm/Transforms/Scalar/JumpThreading.h" 167 #include "llvm/Transforms/Scalar/LICM.h" 168 #include "llvm/Transforms/Scalar/LoopAccessAnalysisPrinter.h" 169 #include "llvm/Transforms/Scalar/LoopBoundSplit.h" 170 #include "llvm/Transforms/Scalar/LoopDataPrefetch.h" 171 #include "llvm/Transforms/Scalar/LoopDeletion.h" 172 #include "llvm/Transforms/Scalar/LoopDistribute.h" 173 #include "llvm/Transforms/Scalar/LoopFlatten.h" 174 #include "llvm/Transforms/Scalar/LoopFuse.h" 175 #include "llvm/Transforms/Scalar/LoopIdiomRecognize.h" 176 #include "llvm/Transforms/Scalar/LoopInstSimplify.h" 177 #include "llvm/Transforms/Scalar/LoopInterchange.h" 178 #include "llvm/Transforms/Scalar/LoopLoadElimination.h" 179 #include "llvm/Transforms/Scalar/LoopPassManager.h" 180 #include "llvm/Transforms/Scalar/LoopPredication.h" 181 #include "llvm/Transforms/Scalar/LoopReroll.h" 182 #include "llvm/Transforms/Scalar/LoopRotation.h" 183 #include "llvm/Transforms/Scalar/LoopSimplifyCFG.h" 184 #include "llvm/Transforms/Scalar/LoopSink.h" 185 #include "llvm/Transforms/Scalar/LoopStrengthReduce.h" 186 #include "llvm/Transforms/Scalar/LoopUnrollAndJamPass.h" 187 #include "llvm/Transforms/Scalar/LoopUnrollPass.h" 188 #include "llvm/Transforms/Scalar/LoopVersioningLICM.h" 189 #include "llvm/Transforms/Scalar/LowerAtomicPass.h" 190 #include "llvm/Transforms/Scalar/LowerConstantIntrinsics.h" 191 #include "llvm/Transforms/Scalar/LowerExpectIntrinsic.h" 192 #include "llvm/Transforms/Scalar/LowerGuardIntrinsic.h" 193 #include "llvm/Transforms/Scalar/LowerMatrixIntrinsics.h" 194 #include "llvm/Transforms/Scalar/LowerWidenableCondition.h" 195 #include "llvm/Transforms/Scalar/MakeGuardsExplicit.h" 196 #include "llvm/Transforms/Scalar/MemCpyOptimizer.h" 197 #include "llvm/Transforms/Scalar/MergeICmps.h" 198 #include "llvm/Transforms/Scalar/MergedLoadStoreMotion.h" 199 #include "llvm/Transforms/Scalar/NaryReassociate.h" 200 #include "llvm/Transforms/Scalar/NewGVN.h" 201 #include "llvm/Transforms/Scalar/PartiallyInlineLibCalls.h" 202 #include "llvm/Transforms/Scalar/Reassociate.h" 203 #include "llvm/Transforms/Scalar/Reg2Mem.h" 204 #include "llvm/Transforms/Scalar/RewriteStatepointsForGC.h" 205 #include "llvm/Transforms/Scalar/SCCP.h" 206 #include "llvm/Transforms/Scalar/SROA.h" 207 #include "llvm/Transforms/Scalar/ScalarizeMaskedMemIntrin.h" 208 #include "llvm/Transforms/Scalar/Scalarizer.h" 209 #include "llvm/Transforms/Scalar/SeparateConstOffsetFromGEP.h" 210 #include "llvm/Transforms/Scalar/SimpleLoopUnswitch.h" 211 #include "llvm/Transforms/Scalar/SimplifyCFG.h" 212 #include "llvm/Transforms/Scalar/Sink.h" 213 #include "llvm/Transforms/Scalar/SpeculativeExecution.h" 214 #include "llvm/Transforms/Scalar/StraightLineStrengthReduce.h" 215 #include "llvm/Transforms/Scalar/StructurizeCFG.h" 216 #include "llvm/Transforms/Scalar/TLSVariableHoist.h" 217 #include "llvm/Transforms/Scalar/TailRecursionElimination.h" 218 #include "llvm/Transforms/Scalar/WarnMissedTransforms.h" 219 #include "llvm/Transforms/Utils/AddDiscriminators.h" 220 #include "llvm/Transforms/Utils/AssumeBundleBuilder.h" 221 #include "llvm/Transforms/Utils/BreakCriticalEdges.h" 222 #include "llvm/Transforms/Utils/CanonicalizeAliases.h" 223 #include "llvm/Transforms/Utils/CanonicalizeFreezeInLoops.h" 224 #include "llvm/Transforms/Utils/Debugify.h" 225 #include "llvm/Transforms/Utils/EntryExitInstrumenter.h" 226 #include "llvm/Transforms/Utils/FixIrreducible.h" 227 #include "llvm/Transforms/Utils/HelloWorld.h" 228 #include "llvm/Transforms/Utils/InjectTLIMappings.h" 229 #include "llvm/Transforms/Utils/InstructionNamer.h" 230 #include "llvm/Transforms/Utils/LCSSA.h" 231 #include "llvm/Transforms/Utils/LibCallsShrinkWrap.h" 232 #include "llvm/Transforms/Utils/LoopSimplify.h" 233 #include "llvm/Transforms/Utils/LoopVersioning.h" 234 #include "llvm/Transforms/Utils/LowerGlobalDtors.h" 235 #include "llvm/Transforms/Utils/LowerInvoke.h" 236 #include "llvm/Transforms/Utils/LowerSwitch.h" 237 #include "llvm/Transforms/Utils/Mem2Reg.h" 238 #include "llvm/Transforms/Utils/MetaRenamer.h" 239 #include "llvm/Transforms/Utils/NameAnonGlobals.h" 240 #include "llvm/Transforms/Utils/PredicateInfo.h" 241 #include "llvm/Transforms/Utils/RelLookupTableConverter.h" 242 #include "llvm/Transforms/Utils/StripGCRelocates.h" 243 #include "llvm/Transforms/Utils/StripNonLineTableDebugInfo.h" 244 #include "llvm/Transforms/Utils/SymbolRewriter.h" 245 #include "llvm/Transforms/Utils/UnifyFunctionExitNodes.h" 246 #include "llvm/Transforms/Utils/UnifyLoopExits.h" 247 #include "llvm/Transforms/Vectorize/LoadStoreVectorizer.h" 248 #include "llvm/Transforms/Vectorize/LoopVectorize.h" 249 #include "llvm/Transforms/Vectorize/SLPVectorizer.h" 250 #include "llvm/Transforms/Vectorize/VectorCombine.h" 251 252 using namespace llvm; 253 254 static const Regex DefaultAliasRegex( 255 "^(default|thinlto-pre-link|thinlto|lto-pre-link|lto)<(O[0123sz])>$"); 256 257 namespace llvm { 258 cl::opt<bool> PrintPipelinePasses( 259 "print-pipeline-passes", 260 cl::desc("Print a '-passes' compatible string describing the pipeline " 261 "(best-effort only).")); 262 } // namespace llvm 263 264 namespace { 265 266 // The following passes/analyses have custom names, otherwise their name will 267 // include `(anonymous namespace)`. These are special since they are only for 268 // testing purposes and don't live in a header file. 269 270 /// No-op module pass which does nothing. 271 struct NoOpModulePass : PassInfoMixin<NoOpModulePass> { 272 PreservedAnalyses run(Module &M, ModuleAnalysisManager &) { 273 return PreservedAnalyses::all(); 274 } 275 276 static StringRef name() { return "NoOpModulePass"; } 277 }; 278 279 /// No-op module analysis. 280 class NoOpModuleAnalysis : public AnalysisInfoMixin<NoOpModuleAnalysis> { 281 friend AnalysisInfoMixin<NoOpModuleAnalysis>; 282 static AnalysisKey Key; 283 284 public: 285 struct Result {}; 286 Result run(Module &, ModuleAnalysisManager &) { return Result(); } 287 static StringRef name() { return "NoOpModuleAnalysis"; } 288 }; 289 290 /// No-op CGSCC pass which does nothing. 291 struct NoOpCGSCCPass : PassInfoMixin<NoOpCGSCCPass> { 292 PreservedAnalyses run(LazyCallGraph::SCC &C, CGSCCAnalysisManager &, 293 LazyCallGraph &, CGSCCUpdateResult &UR) { 294 return PreservedAnalyses::all(); 295 } 296 static StringRef name() { return "NoOpCGSCCPass"; } 297 }; 298 299 /// No-op CGSCC analysis. 300 class NoOpCGSCCAnalysis : public AnalysisInfoMixin<NoOpCGSCCAnalysis> { 301 friend AnalysisInfoMixin<NoOpCGSCCAnalysis>; 302 static AnalysisKey Key; 303 304 public: 305 struct Result {}; 306 Result run(LazyCallGraph::SCC &, CGSCCAnalysisManager &, LazyCallGraph &G) { 307 return Result(); 308 } 309 static StringRef name() { return "NoOpCGSCCAnalysis"; } 310 }; 311 312 /// No-op function pass which does nothing. 313 struct NoOpFunctionPass : PassInfoMixin<NoOpFunctionPass> { 314 PreservedAnalyses run(Function &F, FunctionAnalysisManager &) { 315 return PreservedAnalyses::all(); 316 } 317 static StringRef name() { return "NoOpFunctionPass"; } 318 }; 319 320 /// No-op function analysis. 321 class NoOpFunctionAnalysis : public AnalysisInfoMixin<NoOpFunctionAnalysis> { 322 friend AnalysisInfoMixin<NoOpFunctionAnalysis>; 323 static AnalysisKey Key; 324 325 public: 326 struct Result {}; 327 Result run(Function &, FunctionAnalysisManager &) { return Result(); } 328 static StringRef name() { return "NoOpFunctionAnalysis"; } 329 }; 330 331 /// No-op loop nest pass which does nothing. 332 struct NoOpLoopNestPass : PassInfoMixin<NoOpLoopNestPass> { 333 PreservedAnalyses run(LoopNest &L, LoopAnalysisManager &, 334 LoopStandardAnalysisResults &, LPMUpdater &) { 335 return PreservedAnalyses::all(); 336 } 337 static StringRef name() { return "NoOpLoopNestPass"; } 338 }; 339 340 /// No-op loop pass which does nothing. 341 struct NoOpLoopPass : PassInfoMixin<NoOpLoopPass> { 342 PreservedAnalyses run(Loop &L, LoopAnalysisManager &, 343 LoopStandardAnalysisResults &, LPMUpdater &) { 344 return PreservedAnalyses::all(); 345 } 346 static StringRef name() { return "NoOpLoopPass"; } 347 }; 348 349 /// No-op loop analysis. 350 class NoOpLoopAnalysis : public AnalysisInfoMixin<NoOpLoopAnalysis> { 351 friend AnalysisInfoMixin<NoOpLoopAnalysis>; 352 static AnalysisKey Key; 353 354 public: 355 struct Result {}; 356 Result run(Loop &, LoopAnalysisManager &, LoopStandardAnalysisResults &) { 357 return Result(); 358 } 359 static StringRef name() { return "NoOpLoopAnalysis"; } 360 }; 361 362 AnalysisKey NoOpModuleAnalysis::Key; 363 AnalysisKey NoOpCGSCCAnalysis::Key; 364 AnalysisKey NoOpFunctionAnalysis::Key; 365 AnalysisKey NoOpLoopAnalysis::Key; 366 367 /// Whether or not we should populate a PassInstrumentationCallbacks's class to 368 /// pass name map. 369 /// 370 /// This is for optimization purposes so we don't populate it if we never use 371 /// it. This should be updated if new pass instrumentation wants to use the map. 372 /// We currently only use this for --print-before/after. 373 bool shouldPopulateClassToPassNames() { 374 return PrintPipelinePasses || !printBeforePasses().empty() || 375 !printAfterPasses().empty(); 376 } 377 378 } // namespace 379 380 PassBuilder::PassBuilder(TargetMachine *TM, PipelineTuningOptions PTO, 381 Optional<PGOOptions> PGOOpt, 382 PassInstrumentationCallbacks *PIC) 383 : TM(TM), PTO(PTO), PGOOpt(PGOOpt), PIC(PIC) { 384 if (TM) 385 TM->registerPassBuilderCallbacks(*this); 386 if (PIC && shouldPopulateClassToPassNames()) { 387 #define MODULE_PASS(NAME, CREATE_PASS) \ 388 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME); 389 #define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 390 PIC->addClassToPassName(CLASS, NAME); 391 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \ 392 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME); 393 #define FUNCTION_PASS(NAME, CREATE_PASS) \ 394 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME); 395 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 396 PIC->addClassToPassName(CLASS, NAME); 397 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \ 398 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME); 399 #define LOOPNEST_PASS(NAME, CREATE_PASS) \ 400 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME); 401 #define LOOP_PASS(NAME, CREATE_PASS) \ 402 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME); 403 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 404 PIC->addClassToPassName(CLASS, NAME); 405 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \ 406 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME); 407 #define CGSCC_PASS(NAME, CREATE_PASS) \ 408 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME); 409 #define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 410 PIC->addClassToPassName(CLASS, NAME); 411 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \ 412 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME); 413 #include "PassRegistry.def" 414 } 415 } 416 417 void PassBuilder::registerModuleAnalyses(ModuleAnalysisManager &MAM) { 418 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \ 419 MAM.registerPass([&] { return CREATE_PASS; }); 420 #include "PassRegistry.def" 421 422 for (auto &C : ModuleAnalysisRegistrationCallbacks) 423 C(MAM); 424 } 425 426 void PassBuilder::registerCGSCCAnalyses(CGSCCAnalysisManager &CGAM) { 427 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \ 428 CGAM.registerPass([&] { return CREATE_PASS; }); 429 #include "PassRegistry.def" 430 431 for (auto &C : CGSCCAnalysisRegistrationCallbacks) 432 C(CGAM); 433 } 434 435 void PassBuilder::registerFunctionAnalyses(FunctionAnalysisManager &FAM) { 436 // We almost always want the default alias analysis pipeline. 437 // If a user wants a different one, they can register their own before calling 438 // registerFunctionAnalyses(). 439 FAM.registerPass([&] { return buildDefaultAAPipeline(); }); 440 441 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \ 442 FAM.registerPass([&] { return CREATE_PASS; }); 443 #include "PassRegistry.def" 444 445 for (auto &C : FunctionAnalysisRegistrationCallbacks) 446 C(FAM); 447 } 448 449 void PassBuilder::registerLoopAnalyses(LoopAnalysisManager &LAM) { 450 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \ 451 LAM.registerPass([&] { return CREATE_PASS; }); 452 #include "PassRegistry.def" 453 454 for (auto &C : LoopAnalysisRegistrationCallbacks) 455 C(LAM); 456 } 457 458 static Optional<int> parseRepeatPassName(StringRef Name) { 459 if (!Name.consume_front("repeat<") || !Name.consume_back(">")) 460 return None; 461 int Count; 462 if (Name.getAsInteger(0, Count) || Count <= 0) 463 return None; 464 return Count; 465 } 466 467 static Optional<int> parseDevirtPassName(StringRef Name) { 468 if (!Name.consume_front("devirt<") || !Name.consume_back(">")) 469 return None; 470 int Count; 471 if (Name.getAsInteger(0, Count) || Count < 0) 472 return None; 473 return Count; 474 } 475 476 static bool checkParametrizedPassName(StringRef Name, StringRef PassName) { 477 if (!Name.consume_front(PassName)) 478 return false; 479 // normal pass name w/o parameters == default parameters 480 if (Name.empty()) 481 return true; 482 return Name.startswith("<") && Name.endswith(">"); 483 } 484 485 namespace { 486 487 /// This performs customized parsing of pass name with parameters. 488 /// 489 /// We do not need parametrization of passes in textual pipeline very often, 490 /// yet on a rare occasion ability to specify parameters right there can be 491 /// useful. 492 /// 493 /// \p Name - parameterized specification of a pass from a textual pipeline 494 /// is a string in a form of : 495 /// PassName '<' parameter-list '>' 496 /// 497 /// Parameter list is being parsed by the parser callable argument, \p Parser, 498 /// It takes a string-ref of parameters and returns either StringError or a 499 /// parameter list in a form of a custom parameters type, all wrapped into 500 /// Expected<> template class. 501 /// 502 template <typename ParametersParseCallableT> 503 auto parsePassParameters(ParametersParseCallableT &&Parser, StringRef Name, 504 StringRef PassName) -> decltype(Parser(StringRef{})) { 505 using ParametersT = typename decltype(Parser(StringRef{}))::value_type; 506 507 StringRef Params = Name; 508 if (!Params.consume_front(PassName)) { 509 assert(false && 510 "unable to strip pass name from parametrized pass specification"); 511 } 512 if (!Params.empty() && 513 (!Params.consume_front("<") || !Params.consume_back(">"))) { 514 assert(false && "invalid format for parametrized pass name"); 515 } 516 517 Expected<ParametersT> Result = Parser(Params); 518 assert((Result || Result.template errorIsA<StringError>()) && 519 "Pass parameter parser can only return StringErrors."); 520 return Result; 521 } 522 523 /// Parser of parameters for LoopUnroll pass. 524 Expected<LoopUnrollOptions> parseLoopUnrollOptions(StringRef Params) { 525 LoopUnrollOptions UnrollOpts; 526 while (!Params.empty()) { 527 StringRef ParamName; 528 std::tie(ParamName, Params) = Params.split(';'); 529 int OptLevel = StringSwitch<int>(ParamName) 530 .Case("O0", 0) 531 .Case("O1", 1) 532 .Case("O2", 2) 533 .Case("O3", 3) 534 .Default(-1); 535 if (OptLevel >= 0) { 536 UnrollOpts.setOptLevel(OptLevel); 537 continue; 538 } 539 if (ParamName.consume_front("full-unroll-max=")) { 540 int Count; 541 if (ParamName.getAsInteger(0, Count)) 542 return make_error<StringError>( 543 formatv("invalid LoopUnrollPass parameter '{0}' ", ParamName).str(), 544 inconvertibleErrorCode()); 545 UnrollOpts.setFullUnrollMaxCount(Count); 546 continue; 547 } 548 549 bool Enable = !ParamName.consume_front("no-"); 550 if (ParamName == "partial") { 551 UnrollOpts.setPartial(Enable); 552 } else if (ParamName == "peeling") { 553 UnrollOpts.setPeeling(Enable); 554 } else if (ParamName == "profile-peeling") { 555 UnrollOpts.setProfileBasedPeeling(Enable); 556 } else if (ParamName == "runtime") { 557 UnrollOpts.setRuntime(Enable); 558 } else if (ParamName == "upperbound") { 559 UnrollOpts.setUpperBound(Enable); 560 } else { 561 return make_error<StringError>( 562 formatv("invalid LoopUnrollPass parameter '{0}' ", ParamName).str(), 563 inconvertibleErrorCode()); 564 } 565 } 566 return UnrollOpts; 567 } 568 569 Expected<bool> parseSinglePassOption(StringRef Params, StringRef OptionName, 570 StringRef PassName) { 571 bool Result = false; 572 while (!Params.empty()) { 573 StringRef ParamName; 574 std::tie(ParamName, Params) = Params.split(';'); 575 576 if (ParamName == OptionName) { 577 Result = true; 578 } else { 579 return make_error<StringError>( 580 formatv("invalid {1} pass parameter '{0}' ", ParamName, PassName) 581 .str(), 582 inconvertibleErrorCode()); 583 } 584 } 585 return Result; 586 } 587 588 Expected<bool> parseInlinerPassOptions(StringRef Params) { 589 return parseSinglePassOption(Params, "only-mandatory", "InlinerPass"); 590 } 591 592 Expected<bool> parseCoroSplitPassOptions(StringRef Params) { 593 return parseSinglePassOption(Params, "reuse-storage", "CoroSplitPass"); 594 } 595 596 Expected<bool> parseEarlyCSEPassOptions(StringRef Params) { 597 return parseSinglePassOption(Params, "memssa", "EarlyCSE"); 598 } 599 600 Expected<bool> parseEntryExitInstrumenterPassOptions(StringRef Params) { 601 return parseSinglePassOption(Params, "post-inline", "EntryExitInstrumenter"); 602 } 603 604 Expected<bool> parseLoopExtractorPassOptions(StringRef Params) { 605 return parseSinglePassOption(Params, "single", "LoopExtractor"); 606 } 607 608 Expected<bool> parseLowerMatrixIntrinsicsPassOptions(StringRef Params) { 609 return parseSinglePassOption(Params, "minimal", "LowerMatrixIntrinsics"); 610 } 611 612 Expected<AddressSanitizerOptions> parseASanPassOptions(StringRef Params) { 613 AddressSanitizerOptions Result; 614 while (!Params.empty()) { 615 StringRef ParamName; 616 std::tie(ParamName, Params) = Params.split(';'); 617 618 if (ParamName == "kernel") { 619 Result.CompileKernel = true; 620 } else { 621 return make_error<StringError>( 622 formatv("invalid AddressSanitizer pass parameter '{0}' ", ParamName) 623 .str(), 624 inconvertibleErrorCode()); 625 } 626 } 627 return Result; 628 } 629 630 Expected<HWAddressSanitizerOptions> parseHWASanPassOptions(StringRef Params) { 631 HWAddressSanitizerOptions Result; 632 while (!Params.empty()) { 633 StringRef ParamName; 634 std::tie(ParamName, Params) = Params.split(';'); 635 636 if (ParamName == "recover") { 637 Result.Recover = true; 638 } else if (ParamName == "kernel") { 639 Result.CompileKernel = true; 640 } else { 641 return make_error<StringError>( 642 formatv("invalid HWAddressSanitizer pass parameter '{0}' ", ParamName) 643 .str(), 644 inconvertibleErrorCode()); 645 } 646 } 647 return Result; 648 } 649 650 Expected<MemorySanitizerOptions> parseMSanPassOptions(StringRef Params) { 651 MemorySanitizerOptions Result; 652 while (!Params.empty()) { 653 StringRef ParamName; 654 std::tie(ParamName, Params) = Params.split(';'); 655 656 if (ParamName == "recover") { 657 Result.Recover = true; 658 } else if (ParamName == "kernel") { 659 Result.Kernel = true; 660 } else if (ParamName.consume_front("track-origins=")) { 661 if (ParamName.getAsInteger(0, Result.TrackOrigins)) 662 return make_error<StringError>( 663 formatv("invalid argument to MemorySanitizer pass track-origins " 664 "parameter: '{0}' ", 665 ParamName) 666 .str(), 667 inconvertibleErrorCode()); 668 } else if (ParamName == "eager-checks") { 669 Result.EagerChecks = true; 670 } else { 671 return make_error<StringError>( 672 formatv("invalid MemorySanitizer pass parameter '{0}' ", ParamName) 673 .str(), 674 inconvertibleErrorCode()); 675 } 676 } 677 return Result; 678 } 679 680 /// Parser of parameters for SimplifyCFG pass. 681 Expected<SimplifyCFGOptions> parseSimplifyCFGOptions(StringRef Params) { 682 SimplifyCFGOptions Result; 683 while (!Params.empty()) { 684 StringRef ParamName; 685 std::tie(ParamName, Params) = Params.split(';'); 686 687 bool Enable = !ParamName.consume_front("no-"); 688 if (ParamName == "forward-switch-cond") { 689 Result.forwardSwitchCondToPhi(Enable); 690 } else if (ParamName == "switch-range-to-icmp") { 691 Result.convertSwitchRangeToICmp(Enable); 692 } else if (ParamName == "switch-to-lookup") { 693 Result.convertSwitchToLookupTable(Enable); 694 } else if (ParamName == "keep-loops") { 695 Result.needCanonicalLoops(Enable); 696 } else if (ParamName == "hoist-common-insts") { 697 Result.hoistCommonInsts(Enable); 698 } else if (ParamName == "sink-common-insts") { 699 Result.sinkCommonInsts(Enable); 700 } else if (Enable && ParamName.consume_front("bonus-inst-threshold=")) { 701 APInt BonusInstThreshold; 702 if (ParamName.getAsInteger(0, BonusInstThreshold)) 703 return make_error<StringError>( 704 formatv("invalid argument to SimplifyCFG pass bonus-threshold " 705 "parameter: '{0}' ", 706 ParamName).str(), 707 inconvertibleErrorCode()); 708 Result.bonusInstThreshold(BonusInstThreshold.getSExtValue()); 709 } else { 710 return make_error<StringError>( 711 formatv("invalid SimplifyCFG pass parameter '{0}' ", ParamName).str(), 712 inconvertibleErrorCode()); 713 } 714 } 715 return Result; 716 } 717 718 /// Parser of parameters for LoopVectorize pass. 719 Expected<LoopVectorizeOptions> parseLoopVectorizeOptions(StringRef Params) { 720 LoopVectorizeOptions Opts; 721 while (!Params.empty()) { 722 StringRef ParamName; 723 std::tie(ParamName, Params) = Params.split(';'); 724 725 bool Enable = !ParamName.consume_front("no-"); 726 if (ParamName == "interleave-forced-only") { 727 Opts.setInterleaveOnlyWhenForced(Enable); 728 } else if (ParamName == "vectorize-forced-only") { 729 Opts.setVectorizeOnlyWhenForced(Enable); 730 } else { 731 return make_error<StringError>( 732 formatv("invalid LoopVectorize parameter '{0}' ", ParamName).str(), 733 inconvertibleErrorCode()); 734 } 735 } 736 return Opts; 737 } 738 739 Expected<std::pair<bool, bool>> parseLoopUnswitchOptions(StringRef Params) { 740 std::pair<bool, bool> Result = {false, true}; 741 while (!Params.empty()) { 742 StringRef ParamName; 743 std::tie(ParamName, Params) = Params.split(';'); 744 745 bool Enable = !ParamName.consume_front("no-"); 746 if (ParamName == "nontrivial") { 747 Result.first = Enable; 748 } else if (ParamName == "trivial") { 749 Result.second = Enable; 750 } else { 751 return make_error<StringError>( 752 formatv("invalid LoopUnswitch pass parameter '{0}' ", ParamName) 753 .str(), 754 inconvertibleErrorCode()); 755 } 756 } 757 return Result; 758 } 759 760 Expected<LICMOptions> parseLICMOptions(StringRef Params) { 761 LICMOptions Result; 762 while (!Params.empty()) { 763 StringRef ParamName; 764 std::tie(ParamName, Params) = Params.split(';'); 765 766 bool Enable = !ParamName.consume_front("no-"); 767 if (ParamName == "allowspeculation") { 768 Result.AllowSpeculation = Enable; 769 } else { 770 return make_error<StringError>( 771 formatv("invalid LICM pass parameter '{0}' ", ParamName).str(), 772 inconvertibleErrorCode()); 773 } 774 } 775 return Result; 776 } 777 778 Expected<bool> parseMergedLoadStoreMotionOptions(StringRef Params) { 779 bool Result = false; 780 while (!Params.empty()) { 781 StringRef ParamName; 782 std::tie(ParamName, Params) = Params.split(';'); 783 784 bool Enable = !ParamName.consume_front("no-"); 785 if (ParamName == "split-footer-bb") { 786 Result = Enable; 787 } else { 788 return make_error<StringError>( 789 formatv("invalid MergedLoadStoreMotion pass parameter '{0}' ", 790 ParamName) 791 .str(), 792 inconvertibleErrorCode()); 793 } 794 } 795 return Result; 796 } 797 798 Expected<GVNOptions> parseGVNOptions(StringRef Params) { 799 GVNOptions Result; 800 while (!Params.empty()) { 801 StringRef ParamName; 802 std::tie(ParamName, Params) = Params.split(';'); 803 804 bool Enable = !ParamName.consume_front("no-"); 805 if (ParamName == "pre") { 806 Result.setPRE(Enable); 807 } else if (ParamName == "load-pre") { 808 Result.setLoadPRE(Enable); 809 } else if (ParamName == "split-backedge-load-pre") { 810 Result.setLoadPRESplitBackedge(Enable); 811 } else if (ParamName == "memdep") { 812 Result.setMemDep(Enable); 813 } else { 814 return make_error<StringError>( 815 formatv("invalid GVN pass parameter '{0}' ", ParamName).str(), 816 inconvertibleErrorCode()); 817 } 818 } 819 return Result; 820 } 821 822 Expected<StackLifetime::LivenessType> 823 parseStackLifetimeOptions(StringRef Params) { 824 StackLifetime::LivenessType Result = StackLifetime::LivenessType::May; 825 while (!Params.empty()) { 826 StringRef ParamName; 827 std::tie(ParamName, Params) = Params.split(';'); 828 829 if (ParamName == "may") { 830 Result = StackLifetime::LivenessType::May; 831 } else if (ParamName == "must") { 832 Result = StackLifetime::LivenessType::Must; 833 } else { 834 return make_error<StringError>( 835 formatv("invalid StackLifetime parameter '{0}' ", ParamName).str(), 836 inconvertibleErrorCode()); 837 } 838 } 839 return Result; 840 } 841 842 } // namespace 843 844 /// Tests whether a pass name starts with a valid prefix for a default pipeline 845 /// alias. 846 static bool startsWithDefaultPipelineAliasPrefix(StringRef Name) { 847 return Name.startswith("default") || Name.startswith("thinlto") || 848 Name.startswith("lto"); 849 } 850 851 /// Tests whether registered callbacks will accept a given pass name. 852 /// 853 /// When parsing a pipeline text, the type of the outermost pipeline may be 854 /// omitted, in which case the type is automatically determined from the first 855 /// pass name in the text. This may be a name that is handled through one of the 856 /// callbacks. We check this through the oridinary parsing callbacks by setting 857 /// up a dummy PassManager in order to not force the client to also handle this 858 /// type of query. 859 template <typename PassManagerT, typename CallbacksT> 860 static bool callbacksAcceptPassName(StringRef Name, CallbacksT &Callbacks) { 861 if (!Callbacks.empty()) { 862 PassManagerT DummyPM; 863 for (auto &CB : Callbacks) 864 if (CB(Name, DummyPM, {})) 865 return true; 866 } 867 return false; 868 } 869 870 template <typename CallbacksT> 871 static bool isModulePassName(StringRef Name, CallbacksT &Callbacks) { 872 // Manually handle aliases for pre-configured pipeline fragments. 873 if (startsWithDefaultPipelineAliasPrefix(Name)) 874 return DefaultAliasRegex.match(Name); 875 876 // Explicitly handle pass manager names. 877 if (Name == "module") 878 return true; 879 if (Name == "cgscc") 880 return true; 881 if (Name == "function" || Name == "function<eager-inv>") 882 return true; 883 884 // Explicitly handle custom-parsed pass names. 885 if (parseRepeatPassName(Name)) 886 return true; 887 888 #define MODULE_PASS(NAME, CREATE_PASS) \ 889 if (Name == NAME) \ 890 return true; 891 #define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 892 if (checkParametrizedPassName(Name, NAME)) \ 893 return true; 894 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \ 895 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \ 896 return true; 897 #include "PassRegistry.def" 898 899 return callbacksAcceptPassName<ModulePassManager>(Name, Callbacks); 900 } 901 902 template <typename CallbacksT> 903 static bool isCGSCCPassName(StringRef Name, CallbacksT &Callbacks) { 904 // Explicitly handle pass manager names. 905 if (Name == "cgscc") 906 return true; 907 if (Name == "function" || Name == "function<eager-inv>") 908 return true; 909 910 // Explicitly handle custom-parsed pass names. 911 if (parseRepeatPassName(Name)) 912 return true; 913 if (parseDevirtPassName(Name)) 914 return true; 915 916 #define CGSCC_PASS(NAME, CREATE_PASS) \ 917 if (Name == NAME) \ 918 return true; 919 #define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 920 if (checkParametrizedPassName(Name, NAME)) \ 921 return true; 922 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \ 923 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \ 924 return true; 925 #include "PassRegistry.def" 926 927 return callbacksAcceptPassName<CGSCCPassManager>(Name, Callbacks); 928 } 929 930 template <typename CallbacksT> 931 static bool isFunctionPassName(StringRef Name, CallbacksT &Callbacks) { 932 // Explicitly handle pass manager names. 933 if (Name == "function" || Name == "function<eager-inv>") 934 return true; 935 if (Name == "loop" || Name == "loop-mssa") 936 return true; 937 938 // Explicitly handle custom-parsed pass names. 939 if (parseRepeatPassName(Name)) 940 return true; 941 942 #define FUNCTION_PASS(NAME, CREATE_PASS) \ 943 if (Name == NAME) \ 944 return true; 945 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 946 if (checkParametrizedPassName(Name, NAME)) \ 947 return true; 948 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \ 949 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \ 950 return true; 951 #include "PassRegistry.def" 952 953 return callbacksAcceptPassName<FunctionPassManager>(Name, Callbacks); 954 } 955 956 template <typename CallbacksT> 957 static bool isLoopNestPassName(StringRef Name, CallbacksT &Callbacks, 958 bool &UseMemorySSA) { 959 UseMemorySSA = false; 960 961 // Explicitly handle custom-parsed pass names. 962 if (parseRepeatPassName(Name)) 963 return true; 964 965 if (Name == "lnicm") { 966 UseMemorySSA = true; 967 return true; 968 } 969 970 #define LOOPNEST_PASS(NAME, CREATE_PASS) \ 971 if (Name == NAME) \ 972 return true; 973 #include "PassRegistry.def" 974 975 return callbacksAcceptPassName<LoopPassManager>(Name, Callbacks); 976 } 977 978 template <typename CallbacksT> 979 static bool isLoopPassName(StringRef Name, CallbacksT &Callbacks, 980 bool &UseMemorySSA) { 981 UseMemorySSA = false; 982 983 // Explicitly handle custom-parsed pass names. 984 if (parseRepeatPassName(Name)) 985 return true; 986 987 if (Name == "licm") { 988 UseMemorySSA = true; 989 return true; 990 } 991 992 #define LOOP_PASS(NAME, CREATE_PASS) \ 993 if (Name == NAME) \ 994 return true; 995 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 996 if (checkParametrizedPassName(Name, NAME)) \ 997 return true; 998 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \ 999 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \ 1000 return true; 1001 #include "PassRegistry.def" 1002 1003 return callbacksAcceptPassName<LoopPassManager>(Name, Callbacks); 1004 } 1005 1006 Optional<std::vector<PassBuilder::PipelineElement>> 1007 PassBuilder::parsePipelineText(StringRef Text) { 1008 std::vector<PipelineElement> ResultPipeline; 1009 1010 SmallVector<std::vector<PipelineElement> *, 4> PipelineStack = { 1011 &ResultPipeline}; 1012 for (;;) { 1013 std::vector<PipelineElement> &Pipeline = *PipelineStack.back(); 1014 size_t Pos = Text.find_first_of(",()"); 1015 Pipeline.push_back({Text.substr(0, Pos), {}}); 1016 1017 // If we have a single terminating name, we're done. 1018 if (Pos == Text.npos) 1019 break; 1020 1021 char Sep = Text[Pos]; 1022 Text = Text.substr(Pos + 1); 1023 if (Sep == ',') 1024 // Just a name ending in a comma, continue. 1025 continue; 1026 1027 if (Sep == '(') { 1028 // Push the inner pipeline onto the stack to continue processing. 1029 PipelineStack.push_back(&Pipeline.back().InnerPipeline); 1030 continue; 1031 } 1032 1033 assert(Sep == ')' && "Bogus separator!"); 1034 // When handling the close parenthesis, we greedily consume them to avoid 1035 // empty strings in the pipeline. 1036 do { 1037 // If we try to pop the outer pipeline we have unbalanced parentheses. 1038 if (PipelineStack.size() == 1) 1039 return None; 1040 1041 PipelineStack.pop_back(); 1042 } while (Text.consume_front(")")); 1043 1044 // Check if we've finished parsing. 1045 if (Text.empty()) 1046 break; 1047 1048 // Otherwise, the end of an inner pipeline always has to be followed by 1049 // a comma, and then we can continue. 1050 if (!Text.consume_front(",")) 1051 return None; 1052 } 1053 1054 if (PipelineStack.size() > 1) 1055 // Unbalanced paretheses. 1056 return None; 1057 1058 assert(PipelineStack.back() == &ResultPipeline && 1059 "Wrong pipeline at the bottom of the stack!"); 1060 return {std::move(ResultPipeline)}; 1061 } 1062 1063 Error PassBuilder::parseModulePass(ModulePassManager &MPM, 1064 const PipelineElement &E) { 1065 auto &Name = E.Name; 1066 auto &InnerPipeline = E.InnerPipeline; 1067 1068 // First handle complex passes like the pass managers which carry pipelines. 1069 if (!InnerPipeline.empty()) { 1070 if (Name == "module") { 1071 ModulePassManager NestedMPM; 1072 if (auto Err = parseModulePassPipeline(NestedMPM, InnerPipeline)) 1073 return Err; 1074 MPM.addPass(std::move(NestedMPM)); 1075 return Error::success(); 1076 } 1077 if (Name == "cgscc") { 1078 CGSCCPassManager CGPM; 1079 if (auto Err = parseCGSCCPassPipeline(CGPM, InnerPipeline)) 1080 return Err; 1081 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPM))); 1082 return Error::success(); 1083 } 1084 if (Name == "function" || Name == "function<eager-inv>") { 1085 FunctionPassManager FPM; 1086 if (auto Err = parseFunctionPassPipeline(FPM, InnerPipeline)) 1087 return Err; 1088 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM), 1089 Name != "function")); 1090 return Error::success(); 1091 } 1092 if (auto Count = parseRepeatPassName(Name)) { 1093 ModulePassManager NestedMPM; 1094 if (auto Err = parseModulePassPipeline(NestedMPM, InnerPipeline)) 1095 return Err; 1096 MPM.addPass(createRepeatedPass(*Count, std::move(NestedMPM))); 1097 return Error::success(); 1098 } 1099 1100 for (auto &C : ModulePipelineParsingCallbacks) 1101 if (C(Name, MPM, InnerPipeline)) 1102 return Error::success(); 1103 1104 // Normal passes can't have pipelines. 1105 return make_error<StringError>( 1106 formatv("invalid use of '{0}' pass as module pipeline", Name).str(), 1107 inconvertibleErrorCode()); 1108 ; 1109 } 1110 1111 // Manually handle aliases for pre-configured pipeline fragments. 1112 if (startsWithDefaultPipelineAliasPrefix(Name)) { 1113 SmallVector<StringRef, 3> Matches; 1114 if (!DefaultAliasRegex.match(Name, &Matches)) 1115 return make_error<StringError>( 1116 formatv("unknown default pipeline alias '{0}'", Name).str(), 1117 inconvertibleErrorCode()); 1118 1119 assert(Matches.size() == 3 && "Must capture two matched strings!"); 1120 1121 OptimizationLevel L = StringSwitch<OptimizationLevel>(Matches[2]) 1122 .Case("O0", OptimizationLevel::O0) 1123 .Case("O1", OptimizationLevel::O1) 1124 .Case("O2", OptimizationLevel::O2) 1125 .Case("O3", OptimizationLevel::O3) 1126 .Case("Os", OptimizationLevel::Os) 1127 .Case("Oz", OptimizationLevel::Oz); 1128 if (L == OptimizationLevel::O0 && Matches[1] != "thinlto" && 1129 Matches[1] != "lto") { 1130 MPM.addPass(buildO0DefaultPipeline(L, Matches[1] == "thinlto-pre-link" || 1131 Matches[1] == "lto-pre-link")); 1132 return Error::success(); 1133 } 1134 1135 // This is consistent with old pass manager invoked via opt, but 1136 // inconsistent with clang. Clang doesn't enable loop vectorization 1137 // but does enable slp vectorization at Oz. 1138 PTO.LoopVectorization = 1139 L.getSpeedupLevel() > 1 && L != OptimizationLevel::Oz; 1140 PTO.SLPVectorization = 1141 L.getSpeedupLevel() > 1 && L != OptimizationLevel::Oz; 1142 1143 if (Matches[1] == "default") { 1144 MPM.addPass(buildPerModuleDefaultPipeline(L)); 1145 } else if (Matches[1] == "thinlto-pre-link") { 1146 MPM.addPass(buildThinLTOPreLinkDefaultPipeline(L)); 1147 } else if (Matches[1] == "thinlto") { 1148 MPM.addPass(buildThinLTODefaultPipeline(L, nullptr)); 1149 } else if (Matches[1] == "lto-pre-link") { 1150 MPM.addPass(buildLTOPreLinkDefaultPipeline(L)); 1151 } else { 1152 assert(Matches[1] == "lto" && "Not one of the matched options!"); 1153 MPM.addPass(buildLTODefaultPipeline(L, nullptr)); 1154 } 1155 return Error::success(); 1156 } 1157 1158 // Finally expand the basic registered passes from the .inc file. 1159 #define MODULE_PASS(NAME, CREATE_PASS) \ 1160 if (Name == NAME) { \ 1161 MPM.addPass(CREATE_PASS); \ 1162 return Error::success(); \ 1163 } 1164 #define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1165 if (checkParametrizedPassName(Name, NAME)) { \ 1166 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1167 if (!Params) \ 1168 return Params.takeError(); \ 1169 MPM.addPass(CREATE_PASS(Params.get())); \ 1170 return Error::success(); \ 1171 } 1172 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \ 1173 if (Name == "require<" NAME ">") { \ 1174 MPM.addPass( \ 1175 RequireAnalysisPass< \ 1176 std::remove_reference<decltype(CREATE_PASS)>::type, Module>()); \ 1177 return Error::success(); \ 1178 } \ 1179 if (Name == "invalidate<" NAME ">") { \ 1180 MPM.addPass(InvalidateAnalysisPass< \ 1181 std::remove_reference<decltype(CREATE_PASS)>::type>()); \ 1182 return Error::success(); \ 1183 } 1184 #define CGSCC_PASS(NAME, CREATE_PASS) \ 1185 if (Name == NAME) { \ 1186 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(CREATE_PASS)); \ 1187 return Error::success(); \ 1188 } 1189 #define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1190 if (checkParametrizedPassName(Name, NAME)) { \ 1191 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1192 if (!Params) \ 1193 return Params.takeError(); \ 1194 MPM.addPass( \ 1195 createModuleToPostOrderCGSCCPassAdaptor(CREATE_PASS(Params.get()))); \ 1196 return Error::success(); \ 1197 } 1198 #define FUNCTION_PASS(NAME, CREATE_PASS) \ 1199 if (Name == NAME) { \ 1200 MPM.addPass(createModuleToFunctionPassAdaptor(CREATE_PASS)); \ 1201 return Error::success(); \ 1202 } 1203 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1204 if (checkParametrizedPassName(Name, NAME)) { \ 1205 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1206 if (!Params) \ 1207 return Params.takeError(); \ 1208 MPM.addPass(createModuleToFunctionPassAdaptor(CREATE_PASS(Params.get()))); \ 1209 return Error::success(); \ 1210 } 1211 #define LOOPNEST_PASS(NAME, CREATE_PASS) \ 1212 if (Name == NAME) { \ 1213 MPM.addPass(createModuleToFunctionPassAdaptor( \ 1214 createFunctionToLoopPassAdaptor(CREATE_PASS, false, false))); \ 1215 return Error::success(); \ 1216 } 1217 #define LOOP_PASS(NAME, CREATE_PASS) \ 1218 if (Name == NAME) { \ 1219 MPM.addPass(createModuleToFunctionPassAdaptor( \ 1220 createFunctionToLoopPassAdaptor(CREATE_PASS, false, false))); \ 1221 return Error::success(); \ 1222 } 1223 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1224 if (checkParametrizedPassName(Name, NAME)) { \ 1225 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1226 if (!Params) \ 1227 return Params.takeError(); \ 1228 MPM.addPass( \ 1229 createModuleToFunctionPassAdaptor(createFunctionToLoopPassAdaptor( \ 1230 CREATE_PASS(Params.get()), false, false))); \ 1231 return Error::success(); \ 1232 } 1233 #include "PassRegistry.def" 1234 1235 for (auto &C : ModulePipelineParsingCallbacks) 1236 if (C(Name, MPM, InnerPipeline)) 1237 return Error::success(); 1238 return make_error<StringError>( 1239 formatv("unknown module pass '{0}'", Name).str(), 1240 inconvertibleErrorCode()); 1241 } 1242 1243 Error PassBuilder::parseCGSCCPass(CGSCCPassManager &CGPM, 1244 const PipelineElement &E) { 1245 auto &Name = E.Name; 1246 auto &InnerPipeline = E.InnerPipeline; 1247 1248 // First handle complex passes like the pass managers which carry pipelines. 1249 if (!InnerPipeline.empty()) { 1250 if (Name == "cgscc") { 1251 CGSCCPassManager NestedCGPM; 1252 if (auto Err = parseCGSCCPassPipeline(NestedCGPM, InnerPipeline)) 1253 return Err; 1254 // Add the nested pass manager with the appropriate adaptor. 1255 CGPM.addPass(std::move(NestedCGPM)); 1256 return Error::success(); 1257 } 1258 if (Name == "function" || Name == "function<eager-inv>") { 1259 FunctionPassManager FPM; 1260 if (auto Err = parseFunctionPassPipeline(FPM, InnerPipeline)) 1261 return Err; 1262 // Add the nested pass manager with the appropriate adaptor. 1263 CGPM.addPass( 1264 createCGSCCToFunctionPassAdaptor(std::move(FPM), Name != "function")); 1265 return Error::success(); 1266 } 1267 if (auto Count = parseRepeatPassName(Name)) { 1268 CGSCCPassManager NestedCGPM; 1269 if (auto Err = parseCGSCCPassPipeline(NestedCGPM, InnerPipeline)) 1270 return Err; 1271 CGPM.addPass(createRepeatedPass(*Count, std::move(NestedCGPM))); 1272 return Error::success(); 1273 } 1274 if (auto MaxRepetitions = parseDevirtPassName(Name)) { 1275 CGSCCPassManager NestedCGPM; 1276 if (auto Err = parseCGSCCPassPipeline(NestedCGPM, InnerPipeline)) 1277 return Err; 1278 CGPM.addPass( 1279 createDevirtSCCRepeatedPass(std::move(NestedCGPM), *MaxRepetitions)); 1280 return Error::success(); 1281 } 1282 1283 for (auto &C : CGSCCPipelineParsingCallbacks) 1284 if (C(Name, CGPM, InnerPipeline)) 1285 return Error::success(); 1286 1287 // Normal passes can't have pipelines. 1288 return make_error<StringError>( 1289 formatv("invalid use of '{0}' pass as cgscc pipeline", Name).str(), 1290 inconvertibleErrorCode()); 1291 } 1292 1293 // Now expand the basic registered passes from the .inc file. 1294 #define CGSCC_PASS(NAME, CREATE_PASS) \ 1295 if (Name == NAME) { \ 1296 CGPM.addPass(CREATE_PASS); \ 1297 return Error::success(); \ 1298 } 1299 #define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1300 if (checkParametrizedPassName(Name, NAME)) { \ 1301 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1302 if (!Params) \ 1303 return Params.takeError(); \ 1304 CGPM.addPass(CREATE_PASS(Params.get())); \ 1305 return Error::success(); \ 1306 } 1307 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \ 1308 if (Name == "require<" NAME ">") { \ 1309 CGPM.addPass(RequireAnalysisPass< \ 1310 std::remove_reference<decltype(CREATE_PASS)>::type, \ 1311 LazyCallGraph::SCC, CGSCCAnalysisManager, LazyCallGraph &, \ 1312 CGSCCUpdateResult &>()); \ 1313 return Error::success(); \ 1314 } \ 1315 if (Name == "invalidate<" NAME ">") { \ 1316 CGPM.addPass(InvalidateAnalysisPass< \ 1317 std::remove_reference<decltype(CREATE_PASS)>::type>()); \ 1318 return Error::success(); \ 1319 } 1320 #define FUNCTION_PASS(NAME, CREATE_PASS) \ 1321 if (Name == NAME) { \ 1322 CGPM.addPass(createCGSCCToFunctionPassAdaptor(CREATE_PASS)); \ 1323 return Error::success(); \ 1324 } 1325 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1326 if (checkParametrizedPassName(Name, NAME)) { \ 1327 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1328 if (!Params) \ 1329 return Params.takeError(); \ 1330 CGPM.addPass(createCGSCCToFunctionPassAdaptor(CREATE_PASS(Params.get()))); \ 1331 return Error::success(); \ 1332 } 1333 #define LOOPNEST_PASS(NAME, CREATE_PASS) \ 1334 if (Name == NAME) { \ 1335 CGPM.addPass(createCGSCCToFunctionPassAdaptor( \ 1336 createFunctionToLoopPassAdaptor(CREATE_PASS, false, false))); \ 1337 return Error::success(); \ 1338 } 1339 #define LOOP_PASS(NAME, CREATE_PASS) \ 1340 if (Name == NAME) { \ 1341 CGPM.addPass(createCGSCCToFunctionPassAdaptor( \ 1342 createFunctionToLoopPassAdaptor(CREATE_PASS, false, false))); \ 1343 return Error::success(); \ 1344 } 1345 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1346 if (checkParametrizedPassName(Name, NAME)) { \ 1347 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1348 if (!Params) \ 1349 return Params.takeError(); \ 1350 CGPM.addPass( \ 1351 createCGSCCToFunctionPassAdaptor(createFunctionToLoopPassAdaptor( \ 1352 CREATE_PASS(Params.get()), false, false))); \ 1353 return Error::success(); \ 1354 } 1355 #include "PassRegistry.def" 1356 1357 for (auto &C : CGSCCPipelineParsingCallbacks) 1358 if (C(Name, CGPM, InnerPipeline)) 1359 return Error::success(); 1360 return make_error<StringError>( 1361 formatv("unknown cgscc pass '{0}'", Name).str(), 1362 inconvertibleErrorCode()); 1363 } 1364 1365 Error PassBuilder::parseFunctionPass(FunctionPassManager &FPM, 1366 const PipelineElement &E) { 1367 auto &Name = E.Name; 1368 auto &InnerPipeline = E.InnerPipeline; 1369 1370 // First handle complex passes like the pass managers which carry pipelines. 1371 if (!InnerPipeline.empty()) { 1372 if (Name == "function") { 1373 FunctionPassManager NestedFPM; 1374 if (auto Err = parseFunctionPassPipeline(NestedFPM, InnerPipeline)) 1375 return Err; 1376 // Add the nested pass manager with the appropriate adaptor. 1377 FPM.addPass(std::move(NestedFPM)); 1378 return Error::success(); 1379 } 1380 if (Name == "loop" || Name == "loop-mssa") { 1381 LoopPassManager LPM; 1382 if (auto Err = parseLoopPassPipeline(LPM, InnerPipeline)) 1383 return Err; 1384 // Add the nested pass manager with the appropriate adaptor. 1385 bool UseMemorySSA = (Name == "loop-mssa"); 1386 bool UseBFI = llvm::any_of( 1387 InnerPipeline, [](auto Pipeline) { return Pipeline.Name == "licm"; }); 1388 bool UseBPI = llvm::any_of(InnerPipeline, [](auto Pipeline) { 1389 return Pipeline.Name == "loop-predication"; 1390 }); 1391 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM), UseMemorySSA, 1392 UseBFI, UseBPI)); 1393 return Error::success(); 1394 } 1395 if (auto Count = parseRepeatPassName(Name)) { 1396 FunctionPassManager NestedFPM; 1397 if (auto Err = parseFunctionPassPipeline(NestedFPM, InnerPipeline)) 1398 return Err; 1399 FPM.addPass(createRepeatedPass(*Count, std::move(NestedFPM))); 1400 return Error::success(); 1401 } 1402 1403 for (auto &C : FunctionPipelineParsingCallbacks) 1404 if (C(Name, FPM, InnerPipeline)) 1405 return Error::success(); 1406 1407 // Normal passes can't have pipelines. 1408 return make_error<StringError>( 1409 formatv("invalid use of '{0}' pass as function pipeline", Name).str(), 1410 inconvertibleErrorCode()); 1411 } 1412 1413 // Now expand the basic registered passes from the .inc file. 1414 #define FUNCTION_PASS(NAME, CREATE_PASS) \ 1415 if (Name == NAME) { \ 1416 FPM.addPass(CREATE_PASS); \ 1417 return Error::success(); \ 1418 } 1419 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1420 if (checkParametrizedPassName(Name, NAME)) { \ 1421 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1422 if (!Params) \ 1423 return Params.takeError(); \ 1424 FPM.addPass(CREATE_PASS(Params.get())); \ 1425 return Error::success(); \ 1426 } 1427 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \ 1428 if (Name == "require<" NAME ">") { \ 1429 FPM.addPass( \ 1430 RequireAnalysisPass< \ 1431 std::remove_reference<decltype(CREATE_PASS)>::type, Function>()); \ 1432 return Error::success(); \ 1433 } \ 1434 if (Name == "invalidate<" NAME ">") { \ 1435 FPM.addPass(InvalidateAnalysisPass< \ 1436 std::remove_reference<decltype(CREATE_PASS)>::type>()); \ 1437 return Error::success(); \ 1438 } 1439 // FIXME: UseMemorySSA is set to false. Maybe we could do things like: 1440 // bool UseMemorySSA = !("canon-freeze" || "loop-predication" || 1441 // "guard-widening"); 1442 // The risk is that it may become obsolete if we're not careful. 1443 #define LOOPNEST_PASS(NAME, CREATE_PASS) \ 1444 if (Name == NAME) { \ 1445 FPM.addPass(createFunctionToLoopPassAdaptor(CREATE_PASS, false, false)); \ 1446 return Error::success(); \ 1447 } 1448 #define LOOP_PASS(NAME, CREATE_PASS) \ 1449 if (Name == NAME) { \ 1450 FPM.addPass(createFunctionToLoopPassAdaptor(CREATE_PASS, false, false)); \ 1451 return Error::success(); \ 1452 } 1453 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1454 if (checkParametrizedPassName(Name, NAME)) { \ 1455 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1456 if (!Params) \ 1457 return Params.takeError(); \ 1458 FPM.addPass(createFunctionToLoopPassAdaptor(CREATE_PASS(Params.get()), \ 1459 false, false)); \ 1460 return Error::success(); \ 1461 } 1462 #include "PassRegistry.def" 1463 1464 for (auto &C : FunctionPipelineParsingCallbacks) 1465 if (C(Name, FPM, InnerPipeline)) 1466 return Error::success(); 1467 return make_error<StringError>( 1468 formatv("unknown function pass '{0}'", Name).str(), 1469 inconvertibleErrorCode()); 1470 } 1471 1472 Error PassBuilder::parseLoopPass(LoopPassManager &LPM, 1473 const PipelineElement &E) { 1474 StringRef Name = E.Name; 1475 auto &InnerPipeline = E.InnerPipeline; 1476 1477 // First handle complex passes like the pass managers which carry pipelines. 1478 if (!InnerPipeline.empty()) { 1479 if (Name == "loop") { 1480 LoopPassManager NestedLPM; 1481 if (auto Err = parseLoopPassPipeline(NestedLPM, InnerPipeline)) 1482 return Err; 1483 // Add the nested pass manager with the appropriate adaptor. 1484 LPM.addPass(std::move(NestedLPM)); 1485 return Error::success(); 1486 } 1487 if (auto Count = parseRepeatPassName(Name)) { 1488 LoopPassManager NestedLPM; 1489 if (auto Err = parseLoopPassPipeline(NestedLPM, InnerPipeline)) 1490 return Err; 1491 LPM.addPass(createRepeatedPass(*Count, std::move(NestedLPM))); 1492 return Error::success(); 1493 } 1494 1495 for (auto &C : LoopPipelineParsingCallbacks) 1496 if (C(Name, LPM, InnerPipeline)) 1497 return Error::success(); 1498 1499 // Normal passes can't have pipelines. 1500 return make_error<StringError>( 1501 formatv("invalid use of '{0}' pass as loop pipeline", Name).str(), 1502 inconvertibleErrorCode()); 1503 } 1504 1505 // Now expand the basic registered passes from the .inc file. 1506 #define LOOPNEST_PASS(NAME, CREATE_PASS) \ 1507 if (Name == NAME) { \ 1508 LPM.addPass(CREATE_PASS); \ 1509 return Error::success(); \ 1510 } 1511 #define LOOP_PASS(NAME, CREATE_PASS) \ 1512 if (Name == NAME) { \ 1513 LPM.addPass(CREATE_PASS); \ 1514 return Error::success(); \ 1515 } 1516 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1517 if (checkParametrizedPassName(Name, NAME)) { \ 1518 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1519 if (!Params) \ 1520 return Params.takeError(); \ 1521 LPM.addPass(CREATE_PASS(Params.get())); \ 1522 return Error::success(); \ 1523 } 1524 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \ 1525 if (Name == "require<" NAME ">") { \ 1526 LPM.addPass(RequireAnalysisPass< \ 1527 std::remove_reference<decltype(CREATE_PASS)>::type, Loop, \ 1528 LoopAnalysisManager, LoopStandardAnalysisResults &, \ 1529 LPMUpdater &>()); \ 1530 return Error::success(); \ 1531 } \ 1532 if (Name == "invalidate<" NAME ">") { \ 1533 LPM.addPass(InvalidateAnalysisPass< \ 1534 std::remove_reference<decltype(CREATE_PASS)>::type>()); \ 1535 return Error::success(); \ 1536 } 1537 #include "PassRegistry.def" 1538 1539 for (auto &C : LoopPipelineParsingCallbacks) 1540 if (C(Name, LPM, InnerPipeline)) 1541 return Error::success(); 1542 return make_error<StringError>(formatv("unknown loop pass '{0}'", Name).str(), 1543 inconvertibleErrorCode()); 1544 } 1545 1546 bool PassBuilder::parseAAPassName(AAManager &AA, StringRef Name) { 1547 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1548 if (Name == NAME) { \ 1549 AA.registerModuleAnalysis< \ 1550 std::remove_reference<decltype(CREATE_PASS)>::type>(); \ 1551 return true; \ 1552 } 1553 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1554 if (Name == NAME) { \ 1555 AA.registerFunctionAnalysis< \ 1556 std::remove_reference<decltype(CREATE_PASS)>::type>(); \ 1557 return true; \ 1558 } 1559 #include "PassRegistry.def" 1560 1561 for (auto &C : AAParsingCallbacks) 1562 if (C(Name, AA)) 1563 return true; 1564 return false; 1565 } 1566 1567 Error PassBuilder::parseLoopPassPipeline(LoopPassManager &LPM, 1568 ArrayRef<PipelineElement> Pipeline) { 1569 for (const auto &Element : Pipeline) { 1570 if (auto Err = parseLoopPass(LPM, Element)) 1571 return Err; 1572 } 1573 return Error::success(); 1574 } 1575 1576 Error PassBuilder::parseFunctionPassPipeline( 1577 FunctionPassManager &FPM, ArrayRef<PipelineElement> Pipeline) { 1578 for (const auto &Element : Pipeline) { 1579 if (auto Err = parseFunctionPass(FPM, Element)) 1580 return Err; 1581 } 1582 return Error::success(); 1583 } 1584 1585 Error PassBuilder::parseCGSCCPassPipeline(CGSCCPassManager &CGPM, 1586 ArrayRef<PipelineElement> Pipeline) { 1587 for (const auto &Element : Pipeline) { 1588 if (auto Err = parseCGSCCPass(CGPM, Element)) 1589 return Err; 1590 } 1591 return Error::success(); 1592 } 1593 1594 void PassBuilder::crossRegisterProxies(LoopAnalysisManager &LAM, 1595 FunctionAnalysisManager &FAM, 1596 CGSCCAnalysisManager &CGAM, 1597 ModuleAnalysisManager &MAM) { 1598 MAM.registerPass([&] { return FunctionAnalysisManagerModuleProxy(FAM); }); 1599 MAM.registerPass([&] { return CGSCCAnalysisManagerModuleProxy(CGAM); }); 1600 CGAM.registerPass([&] { return ModuleAnalysisManagerCGSCCProxy(MAM); }); 1601 FAM.registerPass([&] { return CGSCCAnalysisManagerFunctionProxy(CGAM); }); 1602 FAM.registerPass([&] { return ModuleAnalysisManagerFunctionProxy(MAM); }); 1603 FAM.registerPass([&] { return LoopAnalysisManagerFunctionProxy(LAM); }); 1604 LAM.registerPass([&] { return FunctionAnalysisManagerLoopProxy(FAM); }); 1605 } 1606 1607 Error PassBuilder::parseModulePassPipeline(ModulePassManager &MPM, 1608 ArrayRef<PipelineElement> Pipeline) { 1609 for (const auto &Element : Pipeline) { 1610 if (auto Err = parseModulePass(MPM, Element)) 1611 return Err; 1612 } 1613 return Error::success(); 1614 } 1615 1616 // Primary pass pipeline description parsing routine for a \c ModulePassManager 1617 // FIXME: Should this routine accept a TargetMachine or require the caller to 1618 // pre-populate the analysis managers with target-specific stuff? 1619 Error PassBuilder::parsePassPipeline(ModulePassManager &MPM, 1620 StringRef PipelineText) { 1621 auto Pipeline = parsePipelineText(PipelineText); 1622 if (!Pipeline || Pipeline->empty()) 1623 return make_error<StringError>( 1624 formatv("invalid pipeline '{0}'", PipelineText).str(), 1625 inconvertibleErrorCode()); 1626 1627 // If the first name isn't at the module layer, wrap the pipeline up 1628 // automatically. 1629 StringRef FirstName = Pipeline->front().Name; 1630 1631 if (!isModulePassName(FirstName, ModulePipelineParsingCallbacks)) { 1632 bool UseMemorySSA; 1633 if (isCGSCCPassName(FirstName, CGSCCPipelineParsingCallbacks)) { 1634 Pipeline = {{"cgscc", std::move(*Pipeline)}}; 1635 } else if (isFunctionPassName(FirstName, 1636 FunctionPipelineParsingCallbacks)) { 1637 Pipeline = {{"function", std::move(*Pipeline)}}; 1638 } else if (isLoopNestPassName(FirstName, LoopPipelineParsingCallbacks, 1639 UseMemorySSA)) { 1640 Pipeline = {{"function", {{UseMemorySSA ? "loop-mssa" : "loop", 1641 std::move(*Pipeline)}}}}; 1642 } else if (isLoopPassName(FirstName, LoopPipelineParsingCallbacks, 1643 UseMemorySSA)) { 1644 Pipeline = {{"function", {{UseMemorySSA ? "loop-mssa" : "loop", 1645 std::move(*Pipeline)}}}}; 1646 } else { 1647 for (auto &C : TopLevelPipelineParsingCallbacks) 1648 if (C(MPM, *Pipeline)) 1649 return Error::success(); 1650 1651 // Unknown pass or pipeline name! 1652 auto &InnerPipeline = Pipeline->front().InnerPipeline; 1653 return make_error<StringError>( 1654 formatv("unknown {0} name '{1}'", 1655 (InnerPipeline.empty() ? "pass" : "pipeline"), FirstName) 1656 .str(), 1657 inconvertibleErrorCode()); 1658 } 1659 } 1660 1661 if (auto Err = parseModulePassPipeline(MPM, *Pipeline)) 1662 return Err; 1663 return Error::success(); 1664 } 1665 1666 // Primary pass pipeline description parsing routine for a \c CGSCCPassManager 1667 Error PassBuilder::parsePassPipeline(CGSCCPassManager &CGPM, 1668 StringRef PipelineText) { 1669 auto Pipeline = parsePipelineText(PipelineText); 1670 if (!Pipeline || Pipeline->empty()) 1671 return make_error<StringError>( 1672 formatv("invalid pipeline '{0}'", PipelineText).str(), 1673 inconvertibleErrorCode()); 1674 1675 StringRef FirstName = Pipeline->front().Name; 1676 if (!isCGSCCPassName(FirstName, CGSCCPipelineParsingCallbacks)) 1677 return make_error<StringError>( 1678 formatv("unknown cgscc pass '{0}' in pipeline '{1}'", FirstName, 1679 PipelineText) 1680 .str(), 1681 inconvertibleErrorCode()); 1682 1683 if (auto Err = parseCGSCCPassPipeline(CGPM, *Pipeline)) 1684 return Err; 1685 return Error::success(); 1686 } 1687 1688 // Primary pass pipeline description parsing routine for a \c 1689 // FunctionPassManager 1690 Error PassBuilder::parsePassPipeline(FunctionPassManager &FPM, 1691 StringRef PipelineText) { 1692 auto Pipeline = parsePipelineText(PipelineText); 1693 if (!Pipeline || Pipeline->empty()) 1694 return make_error<StringError>( 1695 formatv("invalid pipeline '{0}'", PipelineText).str(), 1696 inconvertibleErrorCode()); 1697 1698 StringRef FirstName = Pipeline->front().Name; 1699 if (!isFunctionPassName(FirstName, FunctionPipelineParsingCallbacks)) 1700 return make_error<StringError>( 1701 formatv("unknown function pass '{0}' in pipeline '{1}'", FirstName, 1702 PipelineText) 1703 .str(), 1704 inconvertibleErrorCode()); 1705 1706 if (auto Err = parseFunctionPassPipeline(FPM, *Pipeline)) 1707 return Err; 1708 return Error::success(); 1709 } 1710 1711 // Primary pass pipeline description parsing routine for a \c LoopPassManager 1712 Error PassBuilder::parsePassPipeline(LoopPassManager &CGPM, 1713 StringRef PipelineText) { 1714 auto Pipeline = parsePipelineText(PipelineText); 1715 if (!Pipeline || Pipeline->empty()) 1716 return make_error<StringError>( 1717 formatv("invalid pipeline '{0}'", PipelineText).str(), 1718 inconvertibleErrorCode()); 1719 1720 if (auto Err = parseLoopPassPipeline(CGPM, *Pipeline)) 1721 return Err; 1722 1723 return Error::success(); 1724 } 1725 1726 Error PassBuilder::parseAAPipeline(AAManager &AA, StringRef PipelineText) { 1727 // If the pipeline just consists of the word 'default' just replace the AA 1728 // manager with our default one. 1729 if (PipelineText == "default") { 1730 AA = buildDefaultAAPipeline(); 1731 return Error::success(); 1732 } 1733 1734 while (!PipelineText.empty()) { 1735 StringRef Name; 1736 std::tie(Name, PipelineText) = PipelineText.split(','); 1737 if (!parseAAPassName(AA, Name)) 1738 return make_error<StringError>( 1739 formatv("unknown alias analysis name '{0}'", Name).str(), 1740 inconvertibleErrorCode()); 1741 } 1742 1743 return Error::success(); 1744 } 1745 1746 bool PassBuilder::isAAPassName(StringRef PassName) { 1747 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1748 if (PassName == NAME) \ 1749 return true; 1750 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1751 if (PassName == NAME) \ 1752 return true; 1753 #include "PassRegistry.def" 1754 return false; 1755 } 1756 1757 bool PassBuilder::isAnalysisPassName(StringRef PassName) { 1758 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \ 1759 if (PassName == NAME) \ 1760 return true; 1761 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \ 1762 if (PassName == NAME) \ 1763 return true; 1764 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \ 1765 if (PassName == NAME) \ 1766 return true; 1767 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \ 1768 if (PassName == NAME) \ 1769 return true; 1770 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1771 if (PassName == NAME) \ 1772 return true; 1773 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1774 if (PassName == NAME) \ 1775 return true; 1776 #include "PassRegistry.def" 1777 return false; 1778 } 1779 1780 static void printPassName(StringRef PassName, raw_ostream &OS) { 1781 OS << " " << PassName << "\n"; 1782 } 1783 static void printPassName(StringRef PassName, StringRef Params, 1784 raw_ostream &OS) { 1785 OS << " " << PassName << "<" << Params << ">\n"; 1786 } 1787 1788 void PassBuilder::printPassNames(raw_ostream &OS) { 1789 // TODO: print pass descriptions when they are available 1790 1791 OS << "Module passes:\n"; 1792 #define MODULE_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1793 #include "PassRegistry.def" 1794 1795 OS << "Module passes with params:\n"; 1796 #define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1797 printPassName(NAME, PARAMS, OS); 1798 #include "PassRegistry.def" 1799 1800 OS << "Module analyses:\n"; 1801 #define MODULE_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1802 #include "PassRegistry.def" 1803 1804 OS << "Module alias analyses:\n"; 1805 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1806 #include "PassRegistry.def" 1807 1808 OS << "CGSCC passes:\n"; 1809 #define CGSCC_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1810 #include "PassRegistry.def" 1811 1812 OS << "CGSCC passes with params:\n"; 1813 #define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1814 printPassName(NAME, PARAMS, OS); 1815 #include "PassRegistry.def" 1816 1817 OS << "CGSCC analyses:\n"; 1818 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1819 #include "PassRegistry.def" 1820 1821 OS << "Function passes:\n"; 1822 #define FUNCTION_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1823 #include "PassRegistry.def" 1824 1825 OS << "Function passes with params:\n"; 1826 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1827 printPassName(NAME, PARAMS, OS); 1828 #include "PassRegistry.def" 1829 1830 OS << "Function analyses:\n"; 1831 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1832 #include "PassRegistry.def" 1833 1834 OS << "Function alias analyses:\n"; 1835 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1836 #include "PassRegistry.def" 1837 1838 OS << "LoopNest passes:\n"; 1839 #define LOOPNEST_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1840 #include "PassRegistry.def" 1841 1842 OS << "Loop passes:\n"; 1843 #define LOOP_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1844 #include "PassRegistry.def" 1845 1846 OS << "Loop passes with params:\n"; 1847 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1848 printPassName(NAME, PARAMS, OS); 1849 #include "PassRegistry.def" 1850 1851 OS << "Loop analyses:\n"; 1852 #define LOOP_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1853 #include "PassRegistry.def" 1854 } 1855 1856 void PassBuilder::registerParseTopLevelPipelineCallback( 1857 const std::function<bool(ModulePassManager &, ArrayRef<PipelineElement>)> 1858 &C) { 1859 TopLevelPipelineParsingCallbacks.push_back(C); 1860 } 1861