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