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