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