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<bool> parseMergedLoadStoreMotionOptions(StringRef Params) { 756 bool Result = false; 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 == "split-footer-bb") { 763 Result = Enable; 764 } else { 765 return make_error<StringError>( 766 formatv("invalid MergedLoadStoreMotion pass parameter '{0}' ", 767 ParamName) 768 .str(), 769 inconvertibleErrorCode()); 770 } 771 } 772 return Result; 773 } 774 775 Expected<GVNOptions> parseGVNOptions(StringRef Params) { 776 GVNOptions Result; 777 while (!Params.empty()) { 778 StringRef ParamName; 779 std::tie(ParamName, Params) = Params.split(';'); 780 781 bool Enable = !ParamName.consume_front("no-"); 782 if (ParamName == "pre") { 783 Result.setPRE(Enable); 784 } else if (ParamName == "load-pre") { 785 Result.setLoadPRE(Enable); 786 } else if (ParamName == "split-backedge-load-pre") { 787 Result.setLoadPRESplitBackedge(Enable); 788 } else if (ParamName == "memdep") { 789 Result.setMemDep(Enable); 790 } else { 791 return make_error<StringError>( 792 formatv("invalid GVN pass parameter '{0}' ", ParamName).str(), 793 inconvertibleErrorCode()); 794 } 795 } 796 return Result; 797 } 798 799 Expected<StackLifetime::LivenessType> 800 parseStackLifetimeOptions(StringRef Params) { 801 StackLifetime::LivenessType Result = StackLifetime::LivenessType::May; 802 while (!Params.empty()) { 803 StringRef ParamName; 804 std::tie(ParamName, Params) = Params.split(';'); 805 806 if (ParamName == "may") { 807 Result = StackLifetime::LivenessType::May; 808 } else if (ParamName == "must") { 809 Result = StackLifetime::LivenessType::Must; 810 } else { 811 return make_error<StringError>( 812 formatv("invalid StackLifetime parameter '{0}' ", ParamName).str(), 813 inconvertibleErrorCode()); 814 } 815 } 816 return Result; 817 } 818 819 } // namespace 820 821 /// Tests whether a pass name starts with a valid prefix for a default pipeline 822 /// alias. 823 static bool startsWithDefaultPipelineAliasPrefix(StringRef Name) { 824 return Name.startswith("default") || Name.startswith("thinlto") || 825 Name.startswith("lto"); 826 } 827 828 /// Tests whether registered callbacks will accept a given pass name. 829 /// 830 /// When parsing a pipeline text, the type of the outermost pipeline may be 831 /// omitted, in which case the type is automatically determined from the first 832 /// pass name in the text. This may be a name that is handled through one of the 833 /// callbacks. We check this through the oridinary parsing callbacks by setting 834 /// up a dummy PassManager in order to not force the client to also handle this 835 /// type of query. 836 template <typename PassManagerT, typename CallbacksT> 837 static bool callbacksAcceptPassName(StringRef Name, CallbacksT &Callbacks) { 838 if (!Callbacks.empty()) { 839 PassManagerT DummyPM; 840 for (auto &CB : Callbacks) 841 if (CB(Name, DummyPM, {})) 842 return true; 843 } 844 return false; 845 } 846 847 template <typename CallbacksT> 848 static bool isModulePassName(StringRef Name, CallbacksT &Callbacks) { 849 // Manually handle aliases for pre-configured pipeline fragments. 850 if (startsWithDefaultPipelineAliasPrefix(Name)) 851 return DefaultAliasRegex.match(Name); 852 853 // Explicitly handle pass manager names. 854 if (Name == "module") 855 return true; 856 if (Name == "cgscc") 857 return true; 858 if (Name == "function" || Name == "function<eager-inv>") 859 return true; 860 861 // Explicitly handle custom-parsed pass names. 862 if (parseRepeatPassName(Name)) 863 return true; 864 865 #define MODULE_PASS(NAME, CREATE_PASS) \ 866 if (Name == NAME) \ 867 return true; 868 #define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 869 if (checkParametrizedPassName(Name, NAME)) \ 870 return true; 871 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \ 872 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \ 873 return true; 874 #include "PassRegistry.def" 875 876 return callbacksAcceptPassName<ModulePassManager>(Name, Callbacks); 877 } 878 879 template <typename CallbacksT> 880 static bool isCGSCCPassName(StringRef Name, CallbacksT &Callbacks) { 881 // Explicitly handle pass manager names. 882 if (Name == "cgscc") 883 return true; 884 if (Name == "function" || Name == "function<eager-inv>") 885 return true; 886 887 // Explicitly handle custom-parsed pass names. 888 if (parseRepeatPassName(Name)) 889 return true; 890 if (parseDevirtPassName(Name)) 891 return true; 892 893 #define CGSCC_PASS(NAME, CREATE_PASS) \ 894 if (Name == NAME) \ 895 return true; 896 #define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 897 if (checkParametrizedPassName(Name, NAME)) \ 898 return true; 899 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \ 900 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \ 901 return true; 902 #include "PassRegistry.def" 903 904 return callbacksAcceptPassName<CGSCCPassManager>(Name, Callbacks); 905 } 906 907 template <typename CallbacksT> 908 static bool isFunctionPassName(StringRef Name, CallbacksT &Callbacks) { 909 // Explicitly handle pass manager names. 910 if (Name == "function" || Name == "function<eager-inv>") 911 return true; 912 if (Name == "loop" || Name == "loop-mssa") 913 return true; 914 915 // Explicitly handle custom-parsed pass names. 916 if (parseRepeatPassName(Name)) 917 return true; 918 919 #define FUNCTION_PASS(NAME, CREATE_PASS) \ 920 if (Name == NAME) \ 921 return true; 922 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 923 if (checkParametrizedPassName(Name, NAME)) \ 924 return true; 925 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \ 926 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \ 927 return true; 928 #include "PassRegistry.def" 929 930 return callbacksAcceptPassName<FunctionPassManager>(Name, Callbacks); 931 } 932 933 template <typename CallbacksT> 934 static bool isLoopNestPassName(StringRef Name, CallbacksT &Callbacks, 935 bool &UseMemorySSA) { 936 UseMemorySSA = false; 937 938 // Explicitly handle custom-parsed pass names. 939 if (parseRepeatPassName(Name)) 940 return true; 941 942 if (Name == "lnicm") { 943 UseMemorySSA = true; 944 return true; 945 } 946 947 #define LOOPNEST_PASS(NAME, CREATE_PASS) \ 948 if (Name == NAME) \ 949 return true; 950 #include "PassRegistry.def" 951 952 return callbacksAcceptPassName<LoopPassManager>(Name, Callbacks); 953 } 954 955 template <typename CallbacksT> 956 static bool isLoopPassName(StringRef Name, CallbacksT &Callbacks, 957 bool &UseMemorySSA) { 958 UseMemorySSA = false; 959 960 // Explicitly handle custom-parsed pass names. 961 if (parseRepeatPassName(Name)) 962 return true; 963 964 if (Name == "licm") { 965 UseMemorySSA = true; 966 return true; 967 } 968 969 #define LOOP_PASS(NAME, CREATE_PASS) \ 970 if (Name == NAME) \ 971 return true; 972 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 973 if (checkParametrizedPassName(Name, NAME)) \ 974 return true; 975 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \ 976 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \ 977 return true; 978 #include "PassRegistry.def" 979 980 return callbacksAcceptPassName<LoopPassManager>(Name, Callbacks); 981 } 982 983 Optional<std::vector<PassBuilder::PipelineElement>> 984 PassBuilder::parsePipelineText(StringRef Text) { 985 std::vector<PipelineElement> ResultPipeline; 986 987 SmallVector<std::vector<PipelineElement> *, 4> PipelineStack = { 988 &ResultPipeline}; 989 for (;;) { 990 std::vector<PipelineElement> &Pipeline = *PipelineStack.back(); 991 size_t Pos = Text.find_first_of(",()"); 992 Pipeline.push_back({Text.substr(0, Pos), {}}); 993 994 // If we have a single terminating name, we're done. 995 if (Pos == Text.npos) 996 break; 997 998 char Sep = Text[Pos]; 999 Text = Text.substr(Pos + 1); 1000 if (Sep == ',') 1001 // Just a name ending in a comma, continue. 1002 continue; 1003 1004 if (Sep == '(') { 1005 // Push the inner pipeline onto the stack to continue processing. 1006 PipelineStack.push_back(&Pipeline.back().InnerPipeline); 1007 continue; 1008 } 1009 1010 assert(Sep == ')' && "Bogus separator!"); 1011 // When handling the close parenthesis, we greedily consume them to avoid 1012 // empty strings in the pipeline. 1013 do { 1014 // If we try to pop the outer pipeline we have unbalanced parentheses. 1015 if (PipelineStack.size() == 1) 1016 return None; 1017 1018 PipelineStack.pop_back(); 1019 } while (Text.consume_front(")")); 1020 1021 // Check if we've finished parsing. 1022 if (Text.empty()) 1023 break; 1024 1025 // Otherwise, the end of an inner pipeline always has to be followed by 1026 // a comma, and then we can continue. 1027 if (!Text.consume_front(",")) 1028 return None; 1029 } 1030 1031 if (PipelineStack.size() > 1) 1032 // Unbalanced paretheses. 1033 return None; 1034 1035 assert(PipelineStack.back() == &ResultPipeline && 1036 "Wrong pipeline at the bottom of the stack!"); 1037 return {std::move(ResultPipeline)}; 1038 } 1039 1040 Error PassBuilder::parseModulePass(ModulePassManager &MPM, 1041 const PipelineElement &E) { 1042 auto &Name = E.Name; 1043 auto &InnerPipeline = E.InnerPipeline; 1044 1045 // First handle complex passes like the pass managers which carry pipelines. 1046 if (!InnerPipeline.empty()) { 1047 if (Name == "module") { 1048 ModulePassManager NestedMPM; 1049 if (auto Err = parseModulePassPipeline(NestedMPM, InnerPipeline)) 1050 return Err; 1051 MPM.addPass(std::move(NestedMPM)); 1052 return Error::success(); 1053 } 1054 if (Name == "cgscc") { 1055 CGSCCPassManager CGPM; 1056 if (auto Err = parseCGSCCPassPipeline(CGPM, InnerPipeline)) 1057 return Err; 1058 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPM))); 1059 return Error::success(); 1060 } 1061 if (Name == "function" || Name == "function<eager-inv>") { 1062 FunctionPassManager FPM; 1063 if (auto Err = parseFunctionPassPipeline(FPM, InnerPipeline)) 1064 return Err; 1065 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM), 1066 Name != "function")); 1067 return Error::success(); 1068 } 1069 if (auto Count = parseRepeatPassName(Name)) { 1070 ModulePassManager NestedMPM; 1071 if (auto Err = parseModulePassPipeline(NestedMPM, InnerPipeline)) 1072 return Err; 1073 MPM.addPass(createRepeatedPass(*Count, std::move(NestedMPM))); 1074 return Error::success(); 1075 } 1076 1077 for (auto &C : ModulePipelineParsingCallbacks) 1078 if (C(Name, MPM, InnerPipeline)) 1079 return Error::success(); 1080 1081 // Normal passes can't have pipelines. 1082 return make_error<StringError>( 1083 formatv("invalid use of '{0}' pass as module pipeline", Name).str(), 1084 inconvertibleErrorCode()); 1085 ; 1086 } 1087 1088 // Manually handle aliases for pre-configured pipeline fragments. 1089 if (startsWithDefaultPipelineAliasPrefix(Name)) { 1090 SmallVector<StringRef, 3> Matches; 1091 if (!DefaultAliasRegex.match(Name, &Matches)) 1092 return make_error<StringError>( 1093 formatv("unknown default pipeline alias '{0}'", Name).str(), 1094 inconvertibleErrorCode()); 1095 1096 assert(Matches.size() == 3 && "Must capture two matched strings!"); 1097 1098 OptimizationLevel L = StringSwitch<OptimizationLevel>(Matches[2]) 1099 .Case("O0", OptimizationLevel::O0) 1100 .Case("O1", OptimizationLevel::O1) 1101 .Case("O2", OptimizationLevel::O2) 1102 .Case("O3", OptimizationLevel::O3) 1103 .Case("Os", OptimizationLevel::Os) 1104 .Case("Oz", OptimizationLevel::Oz); 1105 if (L == OptimizationLevel::O0 && Matches[1] != "thinlto" && 1106 Matches[1] != "lto") { 1107 MPM.addPass(buildO0DefaultPipeline(L, Matches[1] == "thinlto-pre-link" || 1108 Matches[1] == "lto-pre-link")); 1109 return Error::success(); 1110 } 1111 1112 // This is consistent with old pass manager invoked via opt, but 1113 // inconsistent with clang. Clang doesn't enable loop vectorization 1114 // but does enable slp vectorization at Oz. 1115 PTO.LoopVectorization = 1116 L.getSpeedupLevel() > 1 && L != OptimizationLevel::Oz; 1117 PTO.SLPVectorization = 1118 L.getSpeedupLevel() > 1 && L != OptimizationLevel::Oz; 1119 1120 if (Matches[1] == "default") { 1121 MPM.addPass(buildPerModuleDefaultPipeline(L)); 1122 } else if (Matches[1] == "thinlto-pre-link") { 1123 MPM.addPass(buildThinLTOPreLinkDefaultPipeline(L)); 1124 } else if (Matches[1] == "thinlto") { 1125 MPM.addPass(buildThinLTODefaultPipeline(L, nullptr)); 1126 } else if (Matches[1] == "lto-pre-link") { 1127 MPM.addPass(buildLTOPreLinkDefaultPipeline(L)); 1128 } else { 1129 assert(Matches[1] == "lto" && "Not one of the matched options!"); 1130 MPM.addPass(buildLTODefaultPipeline(L, nullptr)); 1131 } 1132 return Error::success(); 1133 } 1134 1135 // Finally expand the basic registered passes from the .inc file. 1136 #define MODULE_PASS(NAME, CREATE_PASS) \ 1137 if (Name == NAME) { \ 1138 MPM.addPass(CREATE_PASS); \ 1139 return Error::success(); \ 1140 } 1141 #define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1142 if (checkParametrizedPassName(Name, NAME)) { \ 1143 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1144 if (!Params) \ 1145 return Params.takeError(); \ 1146 MPM.addPass(CREATE_PASS(Params.get())); \ 1147 return Error::success(); \ 1148 } 1149 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \ 1150 if (Name == "require<" NAME ">") { \ 1151 MPM.addPass( \ 1152 RequireAnalysisPass< \ 1153 std::remove_reference<decltype(CREATE_PASS)>::type, Module>()); \ 1154 return Error::success(); \ 1155 } \ 1156 if (Name == "invalidate<" NAME ">") { \ 1157 MPM.addPass(InvalidateAnalysisPass< \ 1158 std::remove_reference<decltype(CREATE_PASS)>::type>()); \ 1159 return Error::success(); \ 1160 } 1161 #define CGSCC_PASS(NAME, CREATE_PASS) \ 1162 if (Name == NAME) { \ 1163 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(CREATE_PASS)); \ 1164 return Error::success(); \ 1165 } 1166 #define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1167 if (checkParametrizedPassName(Name, NAME)) { \ 1168 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1169 if (!Params) \ 1170 return Params.takeError(); \ 1171 MPM.addPass( \ 1172 createModuleToPostOrderCGSCCPassAdaptor(CREATE_PASS(Params.get()))); \ 1173 return Error::success(); \ 1174 } 1175 #define FUNCTION_PASS(NAME, CREATE_PASS) \ 1176 if (Name == NAME) { \ 1177 MPM.addPass(createModuleToFunctionPassAdaptor(CREATE_PASS)); \ 1178 return Error::success(); \ 1179 } 1180 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1181 if (checkParametrizedPassName(Name, NAME)) { \ 1182 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1183 if (!Params) \ 1184 return Params.takeError(); \ 1185 MPM.addPass(createModuleToFunctionPassAdaptor(CREATE_PASS(Params.get()))); \ 1186 return Error::success(); \ 1187 } 1188 #define LOOPNEST_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(NAME, CREATE_PASS) \ 1195 if (Name == NAME) { \ 1196 MPM.addPass(createModuleToFunctionPassAdaptor( \ 1197 createFunctionToLoopPassAdaptor(CREATE_PASS, false, false))); \ 1198 return Error::success(); \ 1199 } 1200 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1201 if (checkParametrizedPassName(Name, NAME)) { \ 1202 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1203 if (!Params) \ 1204 return Params.takeError(); \ 1205 MPM.addPass( \ 1206 createModuleToFunctionPassAdaptor(createFunctionToLoopPassAdaptor( \ 1207 CREATE_PASS(Params.get()), false, false))); \ 1208 return Error::success(); \ 1209 } 1210 #include "PassRegistry.def" 1211 1212 for (auto &C : ModulePipelineParsingCallbacks) 1213 if (C(Name, MPM, InnerPipeline)) 1214 return Error::success(); 1215 return make_error<StringError>( 1216 formatv("unknown module pass '{0}'", Name).str(), 1217 inconvertibleErrorCode()); 1218 } 1219 1220 Error PassBuilder::parseCGSCCPass(CGSCCPassManager &CGPM, 1221 const PipelineElement &E) { 1222 auto &Name = E.Name; 1223 auto &InnerPipeline = E.InnerPipeline; 1224 1225 // First handle complex passes like the pass managers which carry pipelines. 1226 if (!InnerPipeline.empty()) { 1227 if (Name == "cgscc") { 1228 CGSCCPassManager NestedCGPM; 1229 if (auto Err = parseCGSCCPassPipeline(NestedCGPM, InnerPipeline)) 1230 return Err; 1231 // Add the nested pass manager with the appropriate adaptor. 1232 CGPM.addPass(std::move(NestedCGPM)); 1233 return Error::success(); 1234 } 1235 if (Name == "function" || Name == "function<eager-inv>") { 1236 FunctionPassManager FPM; 1237 if (auto Err = parseFunctionPassPipeline(FPM, InnerPipeline)) 1238 return Err; 1239 // Add the nested pass manager with the appropriate adaptor. 1240 CGPM.addPass( 1241 createCGSCCToFunctionPassAdaptor(std::move(FPM), Name != "function")); 1242 return Error::success(); 1243 } 1244 if (auto Count = parseRepeatPassName(Name)) { 1245 CGSCCPassManager NestedCGPM; 1246 if (auto Err = parseCGSCCPassPipeline(NestedCGPM, InnerPipeline)) 1247 return Err; 1248 CGPM.addPass(createRepeatedPass(*Count, std::move(NestedCGPM))); 1249 return Error::success(); 1250 } 1251 if (auto MaxRepetitions = parseDevirtPassName(Name)) { 1252 CGSCCPassManager NestedCGPM; 1253 if (auto Err = parseCGSCCPassPipeline(NestedCGPM, InnerPipeline)) 1254 return Err; 1255 CGPM.addPass( 1256 createDevirtSCCRepeatedPass(std::move(NestedCGPM), *MaxRepetitions)); 1257 return Error::success(); 1258 } 1259 1260 for (auto &C : CGSCCPipelineParsingCallbacks) 1261 if (C(Name, CGPM, InnerPipeline)) 1262 return Error::success(); 1263 1264 // Normal passes can't have pipelines. 1265 return make_error<StringError>( 1266 formatv("invalid use of '{0}' pass as cgscc pipeline", Name).str(), 1267 inconvertibleErrorCode()); 1268 } 1269 1270 // Now expand the basic registered passes from the .inc file. 1271 #define CGSCC_PASS(NAME, CREATE_PASS) \ 1272 if (Name == NAME) { \ 1273 CGPM.addPass(CREATE_PASS); \ 1274 return Error::success(); \ 1275 } 1276 #define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1277 if (checkParametrizedPassName(Name, NAME)) { \ 1278 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1279 if (!Params) \ 1280 return Params.takeError(); \ 1281 CGPM.addPass(CREATE_PASS(Params.get())); \ 1282 return Error::success(); \ 1283 } 1284 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \ 1285 if (Name == "require<" NAME ">") { \ 1286 CGPM.addPass(RequireAnalysisPass< \ 1287 std::remove_reference<decltype(CREATE_PASS)>::type, \ 1288 LazyCallGraph::SCC, CGSCCAnalysisManager, LazyCallGraph &, \ 1289 CGSCCUpdateResult &>()); \ 1290 return Error::success(); \ 1291 } \ 1292 if (Name == "invalidate<" NAME ">") { \ 1293 CGPM.addPass(InvalidateAnalysisPass< \ 1294 std::remove_reference<decltype(CREATE_PASS)>::type>()); \ 1295 return Error::success(); \ 1296 } 1297 #define FUNCTION_PASS(NAME, CREATE_PASS) \ 1298 if (Name == NAME) { \ 1299 CGPM.addPass(createCGSCCToFunctionPassAdaptor(CREATE_PASS)); \ 1300 return Error::success(); \ 1301 } 1302 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1303 if (checkParametrizedPassName(Name, NAME)) { \ 1304 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1305 if (!Params) \ 1306 return Params.takeError(); \ 1307 CGPM.addPass(createCGSCCToFunctionPassAdaptor(CREATE_PASS(Params.get()))); \ 1308 return Error::success(); \ 1309 } 1310 #define LOOPNEST_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(NAME, CREATE_PASS) \ 1317 if (Name == NAME) { \ 1318 CGPM.addPass(createCGSCCToFunctionPassAdaptor( \ 1319 createFunctionToLoopPassAdaptor(CREATE_PASS, false, false))); \ 1320 return Error::success(); \ 1321 } 1322 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1323 if (checkParametrizedPassName(Name, NAME)) { \ 1324 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1325 if (!Params) \ 1326 return Params.takeError(); \ 1327 CGPM.addPass( \ 1328 createCGSCCToFunctionPassAdaptor(createFunctionToLoopPassAdaptor( \ 1329 CREATE_PASS(Params.get()), false, false))); \ 1330 return Error::success(); \ 1331 } 1332 #include "PassRegistry.def" 1333 1334 for (auto &C : CGSCCPipelineParsingCallbacks) 1335 if (C(Name, CGPM, InnerPipeline)) 1336 return Error::success(); 1337 return make_error<StringError>( 1338 formatv("unknown cgscc pass '{0}'", Name).str(), 1339 inconvertibleErrorCode()); 1340 } 1341 1342 Error PassBuilder::parseFunctionPass(FunctionPassManager &FPM, 1343 const PipelineElement &E) { 1344 auto &Name = E.Name; 1345 auto &InnerPipeline = E.InnerPipeline; 1346 1347 // First handle complex passes like the pass managers which carry pipelines. 1348 if (!InnerPipeline.empty()) { 1349 if (Name == "function") { 1350 FunctionPassManager NestedFPM; 1351 if (auto Err = parseFunctionPassPipeline(NestedFPM, InnerPipeline)) 1352 return Err; 1353 // Add the nested pass manager with the appropriate adaptor. 1354 FPM.addPass(std::move(NestedFPM)); 1355 return Error::success(); 1356 } 1357 if (Name == "loop" || Name == "loop-mssa") { 1358 LoopPassManager LPM; 1359 if (auto Err = parseLoopPassPipeline(LPM, InnerPipeline)) 1360 return Err; 1361 // Add the nested pass manager with the appropriate adaptor. 1362 bool UseMemorySSA = (Name == "loop-mssa"); 1363 bool UseBFI = llvm::any_of( 1364 InnerPipeline, [](auto Pipeline) { return Pipeline.Name == "licm"; }); 1365 bool UseBPI = llvm::any_of(InnerPipeline, [](auto Pipeline) { 1366 return Pipeline.Name == "loop-predication"; 1367 }); 1368 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM), UseMemorySSA, 1369 UseBFI, UseBPI)); 1370 return Error::success(); 1371 } 1372 if (auto Count = parseRepeatPassName(Name)) { 1373 FunctionPassManager NestedFPM; 1374 if (auto Err = parseFunctionPassPipeline(NestedFPM, InnerPipeline)) 1375 return Err; 1376 FPM.addPass(createRepeatedPass(*Count, std::move(NestedFPM))); 1377 return Error::success(); 1378 } 1379 1380 for (auto &C : FunctionPipelineParsingCallbacks) 1381 if (C(Name, FPM, InnerPipeline)) 1382 return Error::success(); 1383 1384 // Normal passes can't have pipelines. 1385 return make_error<StringError>( 1386 formatv("invalid use of '{0}' pass as function pipeline", Name).str(), 1387 inconvertibleErrorCode()); 1388 } 1389 1390 // Now expand the basic registered passes from the .inc file. 1391 #define FUNCTION_PASS(NAME, CREATE_PASS) \ 1392 if (Name == NAME) { \ 1393 FPM.addPass(CREATE_PASS); \ 1394 return Error::success(); \ 1395 } 1396 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1397 if (checkParametrizedPassName(Name, NAME)) { \ 1398 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1399 if (!Params) \ 1400 return Params.takeError(); \ 1401 FPM.addPass(CREATE_PASS(Params.get())); \ 1402 return Error::success(); \ 1403 } 1404 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \ 1405 if (Name == "require<" NAME ">") { \ 1406 FPM.addPass( \ 1407 RequireAnalysisPass< \ 1408 std::remove_reference<decltype(CREATE_PASS)>::type, Function>()); \ 1409 return Error::success(); \ 1410 } \ 1411 if (Name == "invalidate<" NAME ">") { \ 1412 FPM.addPass(InvalidateAnalysisPass< \ 1413 std::remove_reference<decltype(CREATE_PASS)>::type>()); \ 1414 return Error::success(); \ 1415 } 1416 // FIXME: UseMemorySSA is set to false. Maybe we could do things like: 1417 // bool UseMemorySSA = !("canon-freeze" || "loop-predication" || 1418 // "guard-widening"); 1419 // The risk is that it may become obsolete if we're not careful. 1420 #define LOOPNEST_PASS(NAME, CREATE_PASS) \ 1421 if (Name == NAME) { \ 1422 FPM.addPass(createFunctionToLoopPassAdaptor(CREATE_PASS, false, false)); \ 1423 return Error::success(); \ 1424 } 1425 #define LOOP_PASS(NAME, CREATE_PASS) \ 1426 if (Name == NAME) { \ 1427 FPM.addPass(createFunctionToLoopPassAdaptor(CREATE_PASS, false, false)); \ 1428 return Error::success(); \ 1429 } 1430 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1431 if (checkParametrizedPassName(Name, NAME)) { \ 1432 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1433 if (!Params) \ 1434 return Params.takeError(); \ 1435 FPM.addPass(createFunctionToLoopPassAdaptor(CREATE_PASS(Params.get()), \ 1436 false, false)); \ 1437 return Error::success(); \ 1438 } 1439 #include "PassRegistry.def" 1440 1441 for (auto &C : FunctionPipelineParsingCallbacks) 1442 if (C(Name, FPM, InnerPipeline)) 1443 return Error::success(); 1444 return make_error<StringError>( 1445 formatv("unknown function pass '{0}'", Name).str(), 1446 inconvertibleErrorCode()); 1447 } 1448 1449 Error PassBuilder::parseLoopPass(LoopPassManager &LPM, 1450 const PipelineElement &E) { 1451 StringRef Name = E.Name; 1452 auto &InnerPipeline = E.InnerPipeline; 1453 1454 // First handle complex passes like the pass managers which carry pipelines. 1455 if (!InnerPipeline.empty()) { 1456 if (Name == "loop") { 1457 LoopPassManager NestedLPM; 1458 if (auto Err = parseLoopPassPipeline(NestedLPM, InnerPipeline)) 1459 return Err; 1460 // Add the nested pass manager with the appropriate adaptor. 1461 LPM.addPass(std::move(NestedLPM)); 1462 return Error::success(); 1463 } 1464 if (auto Count = parseRepeatPassName(Name)) { 1465 LoopPassManager NestedLPM; 1466 if (auto Err = parseLoopPassPipeline(NestedLPM, InnerPipeline)) 1467 return Err; 1468 LPM.addPass(createRepeatedPass(*Count, std::move(NestedLPM))); 1469 return Error::success(); 1470 } 1471 1472 for (auto &C : LoopPipelineParsingCallbacks) 1473 if (C(Name, LPM, InnerPipeline)) 1474 return Error::success(); 1475 1476 // Normal passes can't have pipelines. 1477 return make_error<StringError>( 1478 formatv("invalid use of '{0}' pass as loop pipeline", Name).str(), 1479 inconvertibleErrorCode()); 1480 } 1481 1482 // Now expand the basic registered passes from the .inc file. 1483 #define LOOPNEST_PASS(NAME, CREATE_PASS) \ 1484 if (Name == NAME) { \ 1485 LPM.addPass(CREATE_PASS); \ 1486 return Error::success(); \ 1487 } 1488 #define LOOP_PASS(NAME, CREATE_PASS) \ 1489 if (Name == NAME) { \ 1490 LPM.addPass(CREATE_PASS); \ 1491 return Error::success(); \ 1492 } 1493 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1494 if (checkParametrizedPassName(Name, NAME)) { \ 1495 auto Params = parsePassParameters(PARSER, Name, NAME); \ 1496 if (!Params) \ 1497 return Params.takeError(); \ 1498 LPM.addPass(CREATE_PASS(Params.get())); \ 1499 return Error::success(); \ 1500 } 1501 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \ 1502 if (Name == "require<" NAME ">") { \ 1503 LPM.addPass(RequireAnalysisPass< \ 1504 std::remove_reference<decltype(CREATE_PASS)>::type, Loop, \ 1505 LoopAnalysisManager, LoopStandardAnalysisResults &, \ 1506 LPMUpdater &>()); \ 1507 return Error::success(); \ 1508 } \ 1509 if (Name == "invalidate<" NAME ">") { \ 1510 LPM.addPass(InvalidateAnalysisPass< \ 1511 std::remove_reference<decltype(CREATE_PASS)>::type>()); \ 1512 return Error::success(); \ 1513 } 1514 #include "PassRegistry.def" 1515 1516 for (auto &C : LoopPipelineParsingCallbacks) 1517 if (C(Name, LPM, InnerPipeline)) 1518 return Error::success(); 1519 return make_error<StringError>(formatv("unknown loop pass '{0}'", Name).str(), 1520 inconvertibleErrorCode()); 1521 } 1522 1523 bool PassBuilder::parseAAPassName(AAManager &AA, StringRef Name) { 1524 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1525 if (Name == NAME) { \ 1526 AA.registerModuleAnalysis< \ 1527 std::remove_reference<decltype(CREATE_PASS)>::type>(); \ 1528 return true; \ 1529 } 1530 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1531 if (Name == NAME) { \ 1532 AA.registerFunctionAnalysis< \ 1533 std::remove_reference<decltype(CREATE_PASS)>::type>(); \ 1534 return true; \ 1535 } 1536 #include "PassRegistry.def" 1537 1538 for (auto &C : AAParsingCallbacks) 1539 if (C(Name, AA)) 1540 return true; 1541 return false; 1542 } 1543 1544 Error PassBuilder::parseLoopPassPipeline(LoopPassManager &LPM, 1545 ArrayRef<PipelineElement> Pipeline) { 1546 for (const auto &Element : Pipeline) { 1547 if (auto Err = parseLoopPass(LPM, Element)) 1548 return Err; 1549 } 1550 return Error::success(); 1551 } 1552 1553 Error PassBuilder::parseFunctionPassPipeline( 1554 FunctionPassManager &FPM, ArrayRef<PipelineElement> Pipeline) { 1555 for (const auto &Element : Pipeline) { 1556 if (auto Err = parseFunctionPass(FPM, Element)) 1557 return Err; 1558 } 1559 return Error::success(); 1560 } 1561 1562 Error PassBuilder::parseCGSCCPassPipeline(CGSCCPassManager &CGPM, 1563 ArrayRef<PipelineElement> Pipeline) { 1564 for (const auto &Element : Pipeline) { 1565 if (auto Err = parseCGSCCPass(CGPM, Element)) 1566 return Err; 1567 } 1568 return Error::success(); 1569 } 1570 1571 void PassBuilder::crossRegisterProxies(LoopAnalysisManager &LAM, 1572 FunctionAnalysisManager &FAM, 1573 CGSCCAnalysisManager &CGAM, 1574 ModuleAnalysisManager &MAM) { 1575 MAM.registerPass([&] { return FunctionAnalysisManagerModuleProxy(FAM); }); 1576 MAM.registerPass([&] { return CGSCCAnalysisManagerModuleProxy(CGAM); }); 1577 CGAM.registerPass([&] { return ModuleAnalysisManagerCGSCCProxy(MAM); }); 1578 FAM.registerPass([&] { return CGSCCAnalysisManagerFunctionProxy(CGAM); }); 1579 FAM.registerPass([&] { return ModuleAnalysisManagerFunctionProxy(MAM); }); 1580 FAM.registerPass([&] { return LoopAnalysisManagerFunctionProxy(LAM); }); 1581 LAM.registerPass([&] { return FunctionAnalysisManagerLoopProxy(FAM); }); 1582 } 1583 1584 Error PassBuilder::parseModulePassPipeline(ModulePassManager &MPM, 1585 ArrayRef<PipelineElement> Pipeline) { 1586 for (const auto &Element : Pipeline) { 1587 if (auto Err = parseModulePass(MPM, Element)) 1588 return Err; 1589 } 1590 return Error::success(); 1591 } 1592 1593 // Primary pass pipeline description parsing routine for a \c ModulePassManager 1594 // FIXME: Should this routine accept a TargetMachine or require the caller to 1595 // pre-populate the analysis managers with target-specific stuff? 1596 Error PassBuilder::parsePassPipeline(ModulePassManager &MPM, 1597 StringRef PipelineText) { 1598 auto Pipeline = parsePipelineText(PipelineText); 1599 if (!Pipeline || Pipeline->empty()) 1600 return make_error<StringError>( 1601 formatv("invalid pipeline '{0}'", PipelineText).str(), 1602 inconvertibleErrorCode()); 1603 1604 // If the first name isn't at the module layer, wrap the pipeline up 1605 // automatically. 1606 StringRef FirstName = Pipeline->front().Name; 1607 1608 if (!isModulePassName(FirstName, ModulePipelineParsingCallbacks)) { 1609 bool UseMemorySSA; 1610 if (isCGSCCPassName(FirstName, CGSCCPipelineParsingCallbacks)) { 1611 Pipeline = {{"cgscc", std::move(*Pipeline)}}; 1612 } else if (isFunctionPassName(FirstName, 1613 FunctionPipelineParsingCallbacks)) { 1614 Pipeline = {{"function", std::move(*Pipeline)}}; 1615 } else if (isLoopNestPassName(FirstName, LoopPipelineParsingCallbacks, 1616 UseMemorySSA)) { 1617 Pipeline = {{"function", {{UseMemorySSA ? "loop-mssa" : "loop", 1618 std::move(*Pipeline)}}}}; 1619 } else if (isLoopPassName(FirstName, LoopPipelineParsingCallbacks, 1620 UseMemorySSA)) { 1621 Pipeline = {{"function", {{UseMemorySSA ? "loop-mssa" : "loop", 1622 std::move(*Pipeline)}}}}; 1623 } else { 1624 for (auto &C : TopLevelPipelineParsingCallbacks) 1625 if (C(MPM, *Pipeline)) 1626 return Error::success(); 1627 1628 // Unknown pass or pipeline name! 1629 auto &InnerPipeline = Pipeline->front().InnerPipeline; 1630 return make_error<StringError>( 1631 formatv("unknown {0} name '{1}'", 1632 (InnerPipeline.empty() ? "pass" : "pipeline"), FirstName) 1633 .str(), 1634 inconvertibleErrorCode()); 1635 } 1636 } 1637 1638 if (auto Err = parseModulePassPipeline(MPM, *Pipeline)) 1639 return Err; 1640 return Error::success(); 1641 } 1642 1643 // Primary pass pipeline description parsing routine for a \c CGSCCPassManager 1644 Error PassBuilder::parsePassPipeline(CGSCCPassManager &CGPM, 1645 StringRef PipelineText) { 1646 auto Pipeline = parsePipelineText(PipelineText); 1647 if (!Pipeline || Pipeline->empty()) 1648 return make_error<StringError>( 1649 formatv("invalid pipeline '{0}'", PipelineText).str(), 1650 inconvertibleErrorCode()); 1651 1652 StringRef FirstName = Pipeline->front().Name; 1653 if (!isCGSCCPassName(FirstName, CGSCCPipelineParsingCallbacks)) 1654 return make_error<StringError>( 1655 formatv("unknown cgscc pass '{0}' in pipeline '{1}'", FirstName, 1656 PipelineText) 1657 .str(), 1658 inconvertibleErrorCode()); 1659 1660 if (auto Err = parseCGSCCPassPipeline(CGPM, *Pipeline)) 1661 return Err; 1662 return Error::success(); 1663 } 1664 1665 // Primary pass pipeline description parsing routine for a \c 1666 // FunctionPassManager 1667 Error PassBuilder::parsePassPipeline(FunctionPassManager &FPM, 1668 StringRef PipelineText) { 1669 auto Pipeline = parsePipelineText(PipelineText); 1670 if (!Pipeline || Pipeline->empty()) 1671 return make_error<StringError>( 1672 formatv("invalid pipeline '{0}'", PipelineText).str(), 1673 inconvertibleErrorCode()); 1674 1675 StringRef FirstName = Pipeline->front().Name; 1676 if (!isFunctionPassName(FirstName, FunctionPipelineParsingCallbacks)) 1677 return make_error<StringError>( 1678 formatv("unknown function pass '{0}' in pipeline '{1}'", FirstName, 1679 PipelineText) 1680 .str(), 1681 inconvertibleErrorCode()); 1682 1683 if (auto Err = parseFunctionPassPipeline(FPM, *Pipeline)) 1684 return Err; 1685 return Error::success(); 1686 } 1687 1688 // Primary pass pipeline description parsing routine for a \c LoopPassManager 1689 Error PassBuilder::parsePassPipeline(LoopPassManager &CGPM, 1690 StringRef PipelineText) { 1691 auto Pipeline = parsePipelineText(PipelineText); 1692 if (!Pipeline || Pipeline->empty()) 1693 return make_error<StringError>( 1694 formatv("invalid pipeline '{0}'", PipelineText).str(), 1695 inconvertibleErrorCode()); 1696 1697 if (auto Err = parseLoopPassPipeline(CGPM, *Pipeline)) 1698 return Err; 1699 1700 return Error::success(); 1701 } 1702 1703 Error PassBuilder::parseAAPipeline(AAManager &AA, StringRef PipelineText) { 1704 // If the pipeline just consists of the word 'default' just replace the AA 1705 // manager with our default one. 1706 if (PipelineText == "default") { 1707 AA = buildDefaultAAPipeline(); 1708 return Error::success(); 1709 } 1710 1711 while (!PipelineText.empty()) { 1712 StringRef Name; 1713 std::tie(Name, PipelineText) = PipelineText.split(','); 1714 if (!parseAAPassName(AA, Name)) 1715 return make_error<StringError>( 1716 formatv("unknown alias analysis name '{0}'", Name).str(), 1717 inconvertibleErrorCode()); 1718 } 1719 1720 return Error::success(); 1721 } 1722 1723 bool PassBuilder::isAAPassName(StringRef PassName) { 1724 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1725 if (PassName == NAME) \ 1726 return true; 1727 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1728 if (PassName == NAME) \ 1729 return true; 1730 #include "PassRegistry.def" 1731 return false; 1732 } 1733 1734 bool PassBuilder::isAnalysisPassName(StringRef PassName) { 1735 #define MODULE_ANALYSIS(NAME, CREATE_PASS) \ 1736 if (PassName == NAME) \ 1737 return true; 1738 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \ 1739 if (PassName == NAME) \ 1740 return true; 1741 #define LOOP_ANALYSIS(NAME, CREATE_PASS) \ 1742 if (PassName == NAME) \ 1743 return true; 1744 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) \ 1745 if (PassName == NAME) \ 1746 return true; 1747 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1748 if (PassName == NAME) \ 1749 return true; 1750 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \ 1751 if (PassName == NAME) \ 1752 return true; 1753 #include "PassRegistry.def" 1754 return false; 1755 } 1756 1757 static void printPassName(StringRef PassName, raw_ostream &OS) { 1758 OS << " " << PassName << "\n"; 1759 } 1760 static void printPassName(StringRef PassName, StringRef Params, 1761 raw_ostream &OS) { 1762 OS << " " << PassName << "<" << Params << ">\n"; 1763 } 1764 1765 void PassBuilder::printPassNames(raw_ostream &OS) { 1766 // TODO: print pass descriptions when they are available 1767 1768 OS << "Module passes:\n"; 1769 #define MODULE_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1770 #include "PassRegistry.def" 1771 1772 OS << "Module passes with params:\n"; 1773 #define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1774 printPassName(NAME, PARAMS, OS); 1775 #include "PassRegistry.def" 1776 1777 OS << "Module analyses:\n"; 1778 #define MODULE_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1779 #include "PassRegistry.def" 1780 1781 OS << "Module alias analyses:\n"; 1782 #define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1783 #include "PassRegistry.def" 1784 1785 OS << "CGSCC passes:\n"; 1786 #define CGSCC_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1787 #include "PassRegistry.def" 1788 1789 OS << "CGSCC passes with params:\n"; 1790 #define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1791 printPassName(NAME, PARAMS, OS); 1792 #include "PassRegistry.def" 1793 1794 OS << "CGSCC analyses:\n"; 1795 #define CGSCC_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1796 #include "PassRegistry.def" 1797 1798 OS << "Function passes:\n"; 1799 #define FUNCTION_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1800 #include "PassRegistry.def" 1801 1802 OS << "Function passes with params:\n"; 1803 #define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1804 printPassName(NAME, PARAMS, OS); 1805 #include "PassRegistry.def" 1806 1807 OS << "Function analyses:\n"; 1808 #define FUNCTION_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1809 #include "PassRegistry.def" 1810 1811 OS << "Function alias analyses:\n"; 1812 #define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1813 #include "PassRegistry.def" 1814 1815 OS << "LoopNest passes:\n"; 1816 #define LOOPNEST_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1817 #include "PassRegistry.def" 1818 1819 OS << "Loop passes:\n"; 1820 #define LOOP_PASS(NAME, CREATE_PASS) printPassName(NAME, OS); 1821 #include "PassRegistry.def" 1822 1823 OS << "Loop passes with params:\n"; 1824 #define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \ 1825 printPassName(NAME, PARAMS, OS); 1826 #include "PassRegistry.def" 1827 1828 OS << "Loop analyses:\n"; 1829 #define LOOP_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS); 1830 #include "PassRegistry.def" 1831 } 1832 1833 void PassBuilder::registerParseTopLevelPipelineCallback( 1834 const std::function<bool(ModulePassManager &, ArrayRef<PipelineElement>)> 1835 &C) { 1836 TopLevelPipelineParsingCallbacks.push_back(C); 1837 } 1838