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