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