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/CFGSCCPrinter.h"
26#include "llvm/Analysis/CGSCCPassManager.h"
27#include "llvm/Analysis/CallGraph.h"
28#include "llvm/Analysis/CallPrinter.h"
29#include "llvm/Analysis/CostModel.h"
30#include "llvm/Analysis/CtxProfAnalysis.h"
31#include "llvm/Analysis/CycleAnalysis.h"
32#include "llvm/Analysis/DDG.h"
33#include "llvm/Analysis/DDGPrinter.h"
34#include "llvm/Analysis/DXILMetadataAnalysis.h"
35#include "llvm/Analysis/DXILResource.h"
36#include "llvm/Analysis/Delinearization.h"
37#include "llvm/Analysis/DemandedBits.h"
38#include "llvm/Analysis/DependenceAnalysis.h"
39#include "llvm/Analysis/DomPrinter.h"
40#include "llvm/Analysis/DominanceFrontier.h"
41#include "llvm/Analysis/EphemeralValuesCache.h"
42#include "llvm/Analysis/FunctionPropertiesAnalysis.h"
43#include "llvm/Analysis/GlobalsModRef.h"
44#include "llvm/Analysis/HashRecognize.h"
45#include "llvm/Analysis/IR2Vec.h"
46#include "llvm/Analysis/IVUsers.h"
47#include "llvm/Analysis/InlineAdvisor.h"
48#include "llvm/Analysis/InstCount.h"
49#include "llvm/Analysis/KernelInfo.h"
50#include "llvm/Analysis/LastRunTrackingAnalysis.h"
51#include "llvm/Analysis/LazyCallGraph.h"
52#include "llvm/Analysis/LazyValueInfo.h"
53#include "llvm/Analysis/Lint.h"
54#include "llvm/Analysis/LoopAccessAnalysis.h"
55#include "llvm/Analysis/LoopCacheAnalysis.h"
56#include "llvm/Analysis/LoopInfo.h"
57#include "llvm/Analysis/LoopNestAnalysis.h"
58#include "llvm/Analysis/MemDerefPrinter.h"
59#include "llvm/Analysis/MemoryDependenceAnalysis.h"
60#include "llvm/Analysis/MemorySSA.h"
61#include "llvm/Analysis/ModuleDebugInfoPrinter.h"
62#include "llvm/Analysis/ModuleSummaryAnalysis.h"
63#include "llvm/Analysis/MustExecute.h"
64#include "llvm/Analysis/ObjCARCAliasAnalysis.h"
65#include "llvm/Analysis/PhiValues.h"
66#include "llvm/Analysis/PostDominators.h"
67#include "llvm/Analysis/ProfileSummaryInfo.h"
68#include "llvm/Analysis/RegionInfo.h"
69#include "llvm/Analysis/RuntimeLibcallInfo.h"
70#include "llvm/Analysis/ScalarEvolution.h"
71#include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
72#include "llvm/Analysis/ScalarEvolutionDivision.h"
73#include "llvm/Analysis/ScopedNoAliasAA.h"
74#include "llvm/Analysis/StackLifetime.h"
75#include "llvm/Analysis/StackSafetyAnalysis.h"
76#include "llvm/Analysis/StructuralHash.h"
77#include "llvm/Analysis/TargetLibraryInfo.h"
78#include "llvm/Analysis/TargetTransformInfo.h"
79#include "llvm/Analysis/TypeBasedAliasAnalysis.h"
80#include "llvm/Analysis/UniformityAnalysis.h"
81#include "llvm/CodeGen/AssignmentTrackingAnalysis.h"
82#include "llvm/CodeGen/AtomicExpand.h"
83#include "llvm/CodeGen/BasicBlockSectionsProfileReader.h"
84#include "llvm/CodeGen/BranchFoldingPass.h"
85#include "llvm/CodeGen/BranchRelaxation.h"
86#include "llvm/CodeGen/CodeGenPrepare.h"
87#include "llvm/CodeGen/ComplexDeinterleavingPass.h"
88#include "llvm/CodeGen/DeadMachineInstructionElim.h"
89#include "llvm/CodeGen/DetectDeadLanes.h"
90#include "llvm/CodeGen/DwarfEHPrepare.h"
91#include "llvm/CodeGen/EarlyIfConversion.h"
92#include "llvm/CodeGen/EdgeBundles.h"
93#include "llvm/CodeGen/ExpandIRInsts.h"
94#include "llvm/CodeGen/ExpandMemCmp.h"
95#include "llvm/CodeGen/ExpandPostRAPseudos.h"
96#include "llvm/CodeGen/ExpandReductions.h"
97#include "llvm/CodeGen/FEntryInserter.h"
98#include "llvm/CodeGen/FinalizeISel.h"
99#include "llvm/CodeGen/FixupStatepointCallerSaved.h"
100#include "llvm/CodeGen/GCEmptyBasicBlocks.h"
101#include "llvm/CodeGen/GCMetadata.h"
102#include "llvm/CodeGen/GlobalISel/CSEInfo.h"
103#include "llvm/CodeGen/GlobalISel/GISelValueTracking.h"
104#include "llvm/CodeGen/GlobalMerge.h"
105#include "llvm/CodeGen/GlobalMergeFunctions.h"
106#include "llvm/CodeGen/HardwareLoops.h"
107#include "llvm/CodeGen/IndirectBrExpand.h"
108#include "llvm/CodeGen/InitUndef.h"
109#include "llvm/CodeGen/InlineAsmPrepare.h"
110#include "llvm/CodeGen/InterleavedAccess.h"
111#include "llvm/CodeGen/InterleavedLoadCombine.h"
112#include "llvm/CodeGen/JMCInstrumenter.h"
113#include "llvm/CodeGen/LiveDebugValuesPass.h"
114#include "llvm/CodeGen/LiveDebugVariables.h"
115#include "llvm/CodeGen/LiveIntervals.h"
116#include "llvm/CodeGen/LiveRegMatrix.h"
117#include "llvm/CodeGen/LiveStacks.h"
118#include "llvm/CodeGen/LiveVariables.h"
119#include "llvm/CodeGen/LocalStackSlotAllocation.h"
120#include "llvm/CodeGen/LowerEmuTLS.h"
121#include "llvm/CodeGen/MIRPrinter.h"
122#include "llvm/CodeGen/MachineBlockFrequencyInfo.h"
123#include "llvm/CodeGen/MachineBlockPlacement.h"
124#include "llvm/CodeGen/MachineBranchProbabilityInfo.h"
125#include "llvm/CodeGen/MachineCSE.h"
126#include "llvm/CodeGen/MachineCopyPropagation.h"
127#include "llvm/CodeGen/MachineDominanceFrontier.h"
128#include "llvm/CodeGen/MachineDominators.h"
129#include "llvm/CodeGen/MachineFunctionAnalysis.h"
130#include "llvm/CodeGen/MachineInstrBundle.h"
131#include "llvm/CodeGen/MachineLICM.h"
132#include "llvm/CodeGen/MachineLateInstrsCleanup.h"
133#include "llvm/CodeGen/MachinePassManager.h"
134#include "llvm/CodeGen/MachinePostDominators.h"
135#include "llvm/CodeGen/MachineRegisterInfo.h"
136#include "llvm/CodeGen/MachineScheduler.h"
137#include "llvm/CodeGen/MachineSink.h"
138#include "llvm/CodeGen/MachineTraceMetrics.h"
139#include "llvm/CodeGen/MachineUniformityAnalysis.h"
140#include "llvm/CodeGen/MachineVerifier.h"
141#include "llvm/CodeGen/OptimizePHIs.h"
142#include "llvm/CodeGen/PEI.h"
143#include "llvm/CodeGen/PHIElimination.h"
144#include "llvm/CodeGen/PatchableFunction.h"
145#include "llvm/CodeGen/PeepholeOptimizer.h"
146#include "llvm/CodeGen/PostRAHazardRecognizer.h"
147#include "llvm/CodeGen/PostRAMachineSink.h"
148#include "llvm/CodeGen/PostRASchedulerList.h"
149#include "llvm/CodeGen/PreISelIntrinsicLowering.h"
150#include "llvm/CodeGen/ProcessImplicitDefs.h"
151#include "llvm/CodeGen/ReachingDefAnalysis.h"
152#include "llvm/CodeGen/RegAllocEvictionAdvisor.h"
153#include "llvm/CodeGen/RegAllocFast.h"
154#include "llvm/CodeGen/RegAllocGreedyPass.h"
155#include "llvm/CodeGen/RegAllocPriorityAdvisor.h"
156#include "llvm/CodeGen/RegUsageInfoCollector.h"
157#include "llvm/CodeGen/RegUsageInfoPropagate.h"
158#include "llvm/CodeGen/RegisterCoalescerPass.h"
159#include "llvm/CodeGen/RegisterUsageInfo.h"
160#include "llvm/CodeGen/RemoveLoadsIntoFakeUses.h"
161#include "llvm/CodeGen/RemoveRedundantDebugValues.h"
162#include "llvm/CodeGen/RenameIndependentSubregs.h"
163#include "llvm/CodeGen/ReplaceWithVeclib.h"
164#include "llvm/CodeGen/SafeStack.h"
165#include "llvm/CodeGen/SanitizerBinaryMetadata.h"
166#include "llvm/CodeGen/SelectOptimize.h"
167#include "llvm/CodeGen/ShadowStackGCLowering.h"
168#include "llvm/CodeGen/ShrinkWrap.h"
169#include "llvm/CodeGen/SjLjEHPrepare.h"
170#include "llvm/CodeGen/SlotIndexes.h"
171#include "llvm/CodeGen/SpillPlacement.h"
172#include "llvm/CodeGen/StackColoring.h"
173#include "llvm/CodeGen/StackFrameLayoutAnalysisPass.h"
174#include "llvm/CodeGen/StackProtector.h"
175#include "llvm/CodeGen/StackSlotColoring.h"
176#include "llvm/CodeGen/TailDuplication.h"
177#include "llvm/CodeGen/TargetPassConfig.h"
178#include "llvm/CodeGen/TwoAddressInstructionPass.h"
179#include "llvm/CodeGen/TypePromotion.h"
180#include "llvm/CodeGen/UnreachableBlockElim.h"
181#include "llvm/CodeGen/VirtRegMap.h"
182#include "llvm/CodeGen/WasmEHPrepare.h"
183#include "llvm/CodeGen/WinEHPrepare.h"
184#include "llvm/CodeGen/XRayInstrumentation.h"
185#include "llvm/IR/DebugInfo.h"
186#include "llvm/IR/Dominators.h"
187#include "llvm/IR/PassManager.h"
188#include "llvm/IR/SafepointIRVerifier.h"
189#include "llvm/IR/Verifier.h"
190#include "llvm/IRPrinter/IRPrintingPasses.h"
191#include "llvm/Passes/OptimizationLevel.h"
192#include "llvm/Support/CodeGen.h"
193#include "llvm/Support/CommandLine.h"
194#include "llvm/Support/Debug.h"
195#include "llvm/Support/Error.h"
196#include "llvm/Support/ErrorHandling.h"
197#include "llvm/Support/FormatVariadic.h"
198#include "llvm/Support/Regex.h"
199#include "llvm/Target/TargetMachine.h"
200#include "llvm/Transforms/AggressiveInstCombine/AggressiveInstCombine.h"
201#include "llvm/Transforms/CFGuard.h"
202#include "llvm/Transforms/Coroutines/CoroAnnotationElide.h"
203#include "llvm/Transforms/Coroutines/CoroCleanup.h"
204#include "llvm/Transforms/Coroutines/CoroConditionalWrapper.h"
205#include "llvm/Transforms/Coroutines/CoroEarly.h"
206#include "llvm/Transforms/Coroutines/CoroElide.h"
207#include "llvm/Transforms/Coroutines/CoroSplit.h"
208#include "llvm/Transforms/HipStdPar/HipStdPar.h"
209#include "llvm/Transforms/IPO/AlwaysInliner.h"
210#include "llvm/Transforms/IPO/Annotation2Metadata.h"
211#include "llvm/Transforms/IPO/ArgumentPromotion.h"
212#include "llvm/Transforms/IPO/Attributor.h"
213#include "llvm/Transforms/IPO/BlockExtractor.h"
214#include "llvm/Transforms/IPO/CalledValuePropagation.h"
215#include "llvm/Transforms/IPO/ConstantMerge.h"
216#include "llvm/Transforms/IPO/CrossDSOCFI.h"
217#include "llvm/Transforms/IPO/DeadArgumentElimination.h"
218#include "llvm/Transforms/IPO/ElimAvailExtern.h"
219#include "llvm/Transforms/IPO/EmbedBitcodePass.h"
220#include "llvm/Transforms/IPO/ExpandVariadics.h"
221#include "llvm/Transforms/IPO/FatLTOCleanup.h"
222#include "llvm/Transforms/IPO/ForceFunctionAttrs.h"
223#include "llvm/Transforms/IPO/FunctionAttrs.h"
224#include "llvm/Transforms/IPO/FunctionImport.h"
225#include "llvm/Transforms/IPO/GlobalDCE.h"
226#include "llvm/Transforms/IPO/GlobalOpt.h"
227#include "llvm/Transforms/IPO/GlobalSplit.h"
228#include "llvm/Transforms/IPO/HotColdSplitting.h"
229#include "llvm/Transforms/IPO/IROutliner.h"
230#include "llvm/Transforms/IPO/InferFunctionAttrs.h"
231#include "llvm/Transforms/IPO/Internalize.h"
232#include "llvm/Transforms/IPO/LoopExtractor.h"
233#include "llvm/Transforms/IPO/LowerTypeTests.h"
234#include "llvm/Transforms/IPO/MemProfContextDisambiguation.h"
235#include "llvm/Transforms/IPO/MergeFunctions.h"
236#include "llvm/Transforms/IPO/OpenMPOpt.h"
237#include "llvm/Transforms/IPO/PartialInlining.h"
238#include "llvm/Transforms/IPO/SCCP.h"
239#include "llvm/Transforms/IPO/SampleProfile.h"
240#include "llvm/Transforms/IPO/SampleProfileProbe.h"
241#include "llvm/Transforms/IPO/StripDeadPrototypes.h"
242#include "llvm/Transforms/IPO/StripSymbols.h"
243#include "llvm/Transforms/IPO/WholeProgramDevirt.h"
244#include "llvm/Transforms/InstCombine/InstCombine.h"
245#include "llvm/Transforms/Instrumentation/AddressSanitizer.h"
246#include "llvm/Transforms/Instrumentation/AllocToken.h"
247#include "llvm/Transforms/Instrumentation/BoundsChecking.h"
248#include "llvm/Transforms/Instrumentation/CGProfile.h"
249#include "llvm/Transforms/Instrumentation/ControlHeightReduction.h"
250#include "llvm/Transforms/Instrumentation/DataFlowSanitizer.h"
251#include "llvm/Transforms/Instrumentation/GCOVProfiler.h"
252#include "llvm/Transforms/Instrumentation/HWAddressSanitizer.h"
253#include "llvm/Transforms/Instrumentation/InstrProfiling.h"
254#include "llvm/Transforms/Instrumentation/KCFI.h"
255#include "llvm/Transforms/Instrumentation/LowerAllowCheckPass.h"
256#include "llvm/Transforms/Instrumentation/MemProfInstrumentation.h"
257#include "llvm/Transforms/Instrumentation/MemProfUse.h"
258#include "llvm/Transforms/Instrumentation/MemorySanitizer.h"
259#include "llvm/Transforms/Instrumentation/NumericalStabilitySanitizer.h"
260#include "llvm/Transforms/Instrumentation/PGOCtxProfFlattening.h"
261#include "llvm/Transforms/Instrumentation/PGOCtxProfLowering.h"
262#include "llvm/Transforms/Instrumentation/PGOForceFunctionAttrs.h"
263#include "llvm/Transforms/Instrumentation/PGOInstrumentation.h"
264#include "llvm/Transforms/Instrumentation/RealtimeSanitizer.h"
265#include "llvm/Transforms/Instrumentation/SanitizerBinaryMetadata.h"
266#include "llvm/Transforms/Instrumentation/SanitizerCoverage.h"
267#include "llvm/Transforms/Instrumentation/ThreadSanitizer.h"
268#include "llvm/Transforms/Instrumentation/TypeSanitizer.h"
269#include "llvm/Transforms/ObjCARC.h"
270#include "llvm/Transforms/Scalar/ADCE.h"
271#include "llvm/Transforms/Scalar/AlignmentFromAssumptions.h"
272#include "llvm/Transforms/Scalar/AnnotationRemarks.h"
273#include "llvm/Transforms/Scalar/BDCE.h"
274#include "llvm/Transforms/Scalar/CallSiteSplitting.h"
275#include "llvm/Transforms/Scalar/ConstantHoisting.h"
276#include "llvm/Transforms/Scalar/ConstraintElimination.h"
277#include "llvm/Transforms/Scalar/CorrelatedValuePropagation.h"
278#include "llvm/Transforms/Scalar/DCE.h"
279#include "llvm/Transforms/Scalar/DFAJumpThreading.h"
280#include "llvm/Transforms/Scalar/DeadStoreElimination.h"
281#include "llvm/Transforms/Scalar/DivRemPairs.h"
282#include "llvm/Transforms/Scalar/DropUnnecessaryAssumes.h"
283#include "llvm/Transforms/Scalar/EarlyCSE.h"
284#include "llvm/Transforms/Scalar/FlattenCFG.h"
285#include "llvm/Transforms/Scalar/Float2Int.h"
286#include "llvm/Transforms/Scalar/GVN.h"
287#include "llvm/Transforms/Scalar/GuardWidening.h"
288#include "llvm/Transforms/Scalar/IVUsersPrinter.h"
289#include "llvm/Transforms/Scalar/IndVarSimplify.h"
290#include "llvm/Transforms/Scalar/InductiveRangeCheckElimination.h"
291#include "llvm/Transforms/Scalar/InferAddressSpaces.h"
292#include "llvm/Transforms/Scalar/InferAlignment.h"
293#include "llvm/Transforms/Scalar/InstSimplifyPass.h"
294#include "llvm/Transforms/Scalar/JumpTableToSwitch.h"
295#include "llvm/Transforms/Scalar/JumpThreading.h"
296#include "llvm/Transforms/Scalar/LICM.h"
297#include "llvm/Transforms/Scalar/LoopAccessAnalysisPrinter.h"
298#include "llvm/Transforms/Scalar/LoopBoundSplit.h"
299#include "llvm/Transforms/Scalar/LoopDataPrefetch.h"
300#include "llvm/Transforms/Scalar/LoopDeletion.h"
301#include "llvm/Transforms/Scalar/LoopDistribute.h"
302#include "llvm/Transforms/Scalar/LoopFlatten.h"
303#include "llvm/Transforms/Scalar/LoopFuse.h"
304#include "llvm/Transforms/Scalar/LoopIdiomRecognize.h"
305#include "llvm/Transforms/Scalar/LoopInstSimplify.h"
306#include "llvm/Transforms/Scalar/LoopInterchange.h"
307#include "llvm/Transforms/Scalar/LoopLoadElimination.h"
308#include "llvm/Transforms/Scalar/LoopPassManager.h"
309#include "llvm/Transforms/Scalar/LoopPredication.h"
310#include "llvm/Transforms/Scalar/LoopRotation.h"
311#include "llvm/Transforms/Scalar/LoopSimplifyCFG.h"
312#include "llvm/Transforms/Scalar/LoopSink.h"
313#include "llvm/Transforms/Scalar/LoopStrengthReduce.h"
314#include "llvm/Transforms/Scalar/LoopTermFold.h"
315#include "llvm/Transforms/Scalar/LoopUnrollAndJamPass.h"
316#include "llvm/Transforms/Scalar/LoopUnrollPass.h"
317#include "llvm/Transforms/Scalar/LoopVersioningLICM.h"
318#include "llvm/Transforms/Scalar/LowerAtomicPass.h"
319#include "llvm/Transforms/Scalar/LowerConstantIntrinsics.h"
320#include "llvm/Transforms/Scalar/LowerExpectIntrinsic.h"
321#include "llvm/Transforms/Scalar/LowerGuardIntrinsic.h"
322#include "llvm/Transforms/Scalar/LowerMatrixIntrinsics.h"
323#include "llvm/Transforms/Scalar/LowerWidenableCondition.h"
324#include "llvm/Transforms/Scalar/MakeGuardsExplicit.h"
325#include "llvm/Transforms/Scalar/MemCpyOptimizer.h"
326#include "llvm/Transforms/Scalar/MergeICmps.h"
327#include "llvm/Transforms/Scalar/MergedLoadStoreMotion.h"
328#include "llvm/Transforms/Scalar/NaryReassociate.h"
329#include "llvm/Transforms/Scalar/NewGVN.h"
330#include "llvm/Transforms/Scalar/PartiallyInlineLibCalls.h"
331#include "llvm/Transforms/Scalar/PlaceSafepoints.h"
332#include "llvm/Transforms/Scalar/Reassociate.h"
333#include "llvm/Transforms/Scalar/Reg2Mem.h"
334#include "llvm/Transforms/Scalar/RewriteStatepointsForGC.h"
335#include "llvm/Transforms/Scalar/SCCP.h"
336#include "llvm/Transforms/Scalar/SROA.h"
337#include "llvm/Transforms/Scalar/ScalarizeMaskedMemIntrin.h"
338#include "llvm/Transforms/Scalar/Scalarizer.h"
339#include "llvm/Transforms/Scalar/SeparateConstOffsetFromGEP.h"
340#include "llvm/Transforms/Scalar/SimpleLoopUnswitch.h"
341#include "llvm/Transforms/Scalar/SimplifyCFG.h"
342#include "llvm/Transforms/Scalar/Sink.h"
343#include "llvm/Transforms/Scalar/SpeculativeExecution.h"
344#include "llvm/Transforms/Scalar/StraightLineStrengthReduce.h"
345#include "llvm/Transforms/Scalar/StructurizeCFG.h"
346#include "llvm/Transforms/Scalar/TailRecursionElimination.h"
347#include "llvm/Transforms/Scalar/WarnMissedTransforms.h"
348#include "llvm/Transforms/Utils/AddDiscriminators.h"
349#include "llvm/Transforms/Utils/AssumeBundleBuilder.h"
350#include "llvm/Transforms/Utils/BreakCriticalEdges.h"
351#include "llvm/Transforms/Utils/CanonicalizeAliases.h"
352#include "llvm/Transforms/Utils/CanonicalizeFreezeInLoops.h"
353#include "llvm/Transforms/Utils/CountVisits.h"
354#include "llvm/Transforms/Utils/DXILUpgrade.h"
355#include "llvm/Transforms/Utils/Debugify.h"
356#include "llvm/Transforms/Utils/DeclareRuntimeLibcalls.h"
357#include "llvm/Transforms/Utils/EntryExitInstrumenter.h"
358#include "llvm/Transforms/Utils/FixIrreducible.h"
359#include "llvm/Transforms/Utils/HelloWorld.h"
360#include "llvm/Transforms/Utils/IRNormalizer.h"
361#include "llvm/Transforms/Utils/InjectTLIMappings.h"
362#include "llvm/Transforms/Utils/InstructionNamer.h"
363#include "llvm/Transforms/Utils/LibCallsShrinkWrap.h"
364#include "llvm/Transforms/Utils/LoopSimplify.h"
365#include "llvm/Transforms/Utils/LoopVersioning.h"
366#include "llvm/Transforms/Utils/LowerGlobalDtors.h"
367#include "llvm/Transforms/Utils/LowerIFunc.h"
368#include "llvm/Transforms/Utils/LowerInvoke.h"
369#include "llvm/Transforms/Utils/LowerSwitch.h"
370#include "llvm/Transforms/Utils/Mem2Reg.h"
371#include "llvm/Transforms/Utils/MetaRenamer.h"
372#include "llvm/Transforms/Utils/MoveAutoInit.h"
373#include "llvm/Transforms/Utils/NameAnonGlobals.h"
374#include "llvm/Transforms/Utils/PredicateInfo.h"
375#include "llvm/Transforms/Utils/ProfileVerify.h"
376#include "llvm/Transforms/Utils/RelLookupTableConverter.h"
377#include "llvm/Transforms/Utils/StripGCRelocates.h"
378#include "llvm/Transforms/Utils/StripNonLineTableDebugInfo.h"
379#include "llvm/Transforms/Utils/SymbolRewriter.h"
380#include "llvm/Transforms/Utils/UnifyFunctionExitNodes.h"
381#include "llvm/Transforms/Utils/UnifyLoopExits.h"
382#include "llvm/Transforms/Vectorize/LoadStoreVectorizer.h"
383#include "llvm/Transforms/Vectorize/LoopIdiomVectorize.h"
384#include "llvm/Transforms/Vectorize/LoopVectorize.h"
385#include "llvm/Transforms/Vectorize/SLPVectorizer.h"
386#include "llvm/Transforms/Vectorize/SandboxVectorizer/SandboxVectorizer.h"
387#include "llvm/Transforms/Vectorize/VectorCombine.h"
388#include <optional>
389
390using namespace llvm;
391
392cl::opt<bool> llvm::PrintPipelinePasses(
393 "print-pipeline-passes",
394 cl::desc("Print a '-passes' compatible string describing the pipeline "
395 "(best-effort only)."));
396
397AnalysisKey NoOpModuleAnalysis::Key;
398AnalysisKey NoOpCGSCCAnalysis::Key;
399AnalysisKey NoOpFunctionAnalysis::Key;
400AnalysisKey NoOpLoopAnalysis::Key;
401
402namespace {
403
404// Passes for testing crashes.
405// DO NOT USE THIS EXCEPT FOR TESTING!
406class TriggerCrashModulePass : public PassInfoMixin<TriggerCrashModulePass> {
407public:
408 PreservedAnalyses run(Module &, ModuleAnalysisManager &) {
409 abort();
410 return PreservedAnalyses::all();
411 }
412 static StringRef name() { return "TriggerCrashModulePass"; }
413};
414
415class TriggerCrashFunctionPass
416 : public PassInfoMixin<TriggerCrashFunctionPass> {
417public:
418 PreservedAnalyses run(Function &, FunctionAnalysisManager &) {
419 abort();
420 return PreservedAnalyses::all();
421 }
422 static StringRef name() { return "TriggerCrashFunctionPass"; }
423};
424
425// A pass for testing message reporting of -verify-each failures.
426// DO NOT USE THIS EXCEPT FOR TESTING!
427class TriggerVerifierErrorPass
428 : public PassInfoMixin<TriggerVerifierErrorPass> {
429public:
430 PreservedAnalyses run(Module &M, ModuleAnalysisManager &) {
431 // Intentionally break the Module by creating an alias without setting the
432 // aliasee.
433 auto *PtrTy = PointerType::getUnqual(C&: M.getContext());
434 GlobalAlias::create(Ty: PtrTy, AddressSpace: PtrTy->getAddressSpace(),
435 Linkage: GlobalValue::LinkageTypes::InternalLinkage,
436 Name: "__bad_alias", Aliasee: nullptr, Parent: &M);
437 return PreservedAnalyses::none();
438 }
439
440 PreservedAnalyses run(Function &F, FunctionAnalysisManager &) {
441 // Intentionally break the Function by inserting a terminator
442 // instruction in the middle of a basic block.
443 BasicBlock &BB = F.getEntryBlock();
444 new UnreachableInst(F.getContext(), BB.getTerminator()->getIterator());
445 return PreservedAnalyses::none();
446 }
447
448 PreservedAnalyses run(MachineFunction &MF, MachineFunctionAnalysisManager &) {
449 // Intentionally create a virtual register and set NoVRegs property.
450 auto &MRI = MF.getRegInfo();
451 MRI.createGenericVirtualRegister(Ty: LLT::scalar(SizeInBits: 8));
452 MF.getProperties().setNoVRegs();
453 return PreservedAnalyses::all();
454 }
455
456 static StringRef name() { return "TriggerVerifierErrorPass"; }
457};
458
459// A pass requires all MachineFunctionProperties.
460// DO NOT USE THIS EXCEPT FOR TESTING!
461class RequireAllMachineFunctionPropertiesPass
462 : public PassInfoMixin<RequireAllMachineFunctionPropertiesPass> {
463public:
464 PreservedAnalyses run(MachineFunction &MF, MachineFunctionAnalysisManager &) {
465 MFPropsModifier _(*this, MF);
466 return PreservedAnalyses::none();
467 }
468
469 static MachineFunctionProperties getRequiredProperties() {
470 return MachineFunctionProperties()
471 .setFailedISel()
472 .setFailsVerification()
473 .setIsSSA()
474 .setLegalized()
475 .setNoPHIs()
476 .setNoVRegs()
477 .setRegBankSelected()
478 .setSelected()
479 .setTiedOpsRewritten()
480 .setTracksDebugUserValues()
481 .setTracksLiveness();
482 }
483 static StringRef name() { return "RequireAllMachineFunctionPropertiesPass"; }
484};
485
486} // namespace
487
488static std::optional<OptimizationLevel> parseOptLevel(StringRef S) {
489 return StringSwitch<std::optional<OptimizationLevel>>(S)
490 .Case(S: "O0", Value: OptimizationLevel::O0)
491 .Case(S: "O1", Value: OptimizationLevel::O1)
492 .Case(S: "O2", Value: OptimizationLevel::O2)
493 .Case(S: "O3", Value: OptimizationLevel::O3)
494 .Case(S: "Os", Value: OptimizationLevel::Os)
495 .Case(S: "Oz", Value: OptimizationLevel::Oz)
496 .Default(Value: std::nullopt);
497}
498
499static Expected<OptimizationLevel> parseOptLevelParam(StringRef S) {
500 std::optional<OptimizationLevel> OptLevel = parseOptLevel(S);
501 if (OptLevel)
502 return *OptLevel;
503 return make_error<StringError>(
504 Args: formatv(Fmt: "invalid optimization level '{}'", Vals&: S).str(),
505 Args: inconvertibleErrorCode());
506}
507
508PassBuilder::PassBuilder(TargetMachine *TM, PipelineTuningOptions PTO,
509 std::optional<PGOOptions> PGOOpt,
510 PassInstrumentationCallbacks *PIC,
511 IntrusiveRefCntPtr<vfs::FileSystem> FS)
512 : TM(TM), PTO(PTO), PGOOpt(PGOOpt), PIC(PIC), FS(std::move(FS)) {
513 if (TM)
514 TM->registerPassBuilderCallbacks(*this);
515 if (PIC) {
516 PIC->registerClassToPassNameCallback(C: [this, PIC]() {
517 // MSVC requires this to be captured if it's used inside decltype.
518 // Other compilers consider it an unused lambda capture.
519 (void)this;
520#define MODULE_PASS(NAME, CREATE_PASS) \
521 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
522#define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
523 PIC->addClassToPassName(CLASS, NAME);
524#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
525 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
526#define FUNCTION_PASS(NAME, CREATE_PASS) \
527 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
528#define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
529 PIC->addClassToPassName(CLASS, NAME);
530#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
531 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
532#define LOOPNEST_PASS(NAME, CREATE_PASS) \
533 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
534#define LOOP_PASS(NAME, CREATE_PASS) \
535 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
536#define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
537 PIC->addClassToPassName(CLASS, NAME);
538#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
539 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
540#define CGSCC_PASS(NAME, CREATE_PASS) \
541 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
542#define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
543 PIC->addClassToPassName(CLASS, NAME);
544#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
545 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
546#include "PassRegistry.def"
547
548#define MACHINE_FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
549 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
550#define MACHINE_FUNCTION_PASS(NAME, CREATE_PASS) \
551 PIC->addClassToPassName(decltype(CREATE_PASS)::name(), NAME);
552#define MACHINE_FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, \
553 PARAMS) \
554 PIC->addClassToPassName(CLASS, NAME);
555#include "llvm/Passes/MachinePassRegistry.def"
556 });
557 }
558
559 // Module-level callbacks without LTO phase
560 registerPipelineParsingCallback(
561 C: [this](StringRef Name, ModulePassManager &PM,
562 ArrayRef<PassBuilder::PipelineElement>) {
563#define MODULE_CALLBACK(NAME, INVOKE) \
564 if (PassBuilder::checkParametrizedPassName(Name, NAME)) { \
565 auto L = PassBuilder::parsePassParameters(parseOptLevelParam, Name, NAME); \
566 if (!L) { \
567 errs() << NAME ": " << toString(L.takeError()) << '\n'; \
568 return false; \
569 } \
570 INVOKE(PM, L.get()); \
571 return true; \
572 }
573#include "PassRegistry.def"
574 return false;
575 });
576
577 // Module-level callbacks with LTO phase (use Phase::None for string API)
578 registerPipelineParsingCallback(
579 C: [this](StringRef Name, ModulePassManager &PM,
580 ArrayRef<PassBuilder::PipelineElement>) {
581#define MODULE_LTO_CALLBACK(NAME, INVOKE) \
582 if (PassBuilder::checkParametrizedPassName(Name, NAME)) { \
583 auto L = PassBuilder::parsePassParameters(parseOptLevelParam, Name, NAME); \
584 if (!L) { \
585 errs() << NAME ": " << toString(L.takeError()) << '\n'; \
586 return false; \
587 } \
588 INVOKE(PM, L.get(), ThinOrFullLTOPhase::None); \
589 return true; \
590 }
591#include "PassRegistry.def"
592 return false;
593 });
594
595 // Function-level callbacks
596 registerPipelineParsingCallback(
597 C: [this](StringRef Name, FunctionPassManager &PM,
598 ArrayRef<PassBuilder::PipelineElement>) {
599#define FUNCTION_CALLBACK(NAME, INVOKE) \
600 if (PassBuilder::checkParametrizedPassName(Name, NAME)) { \
601 auto L = PassBuilder::parsePassParameters(parseOptLevelParam, Name, NAME); \
602 if (!L) { \
603 errs() << NAME ": " << toString(L.takeError()) << '\n'; \
604 return false; \
605 } \
606 INVOKE(PM, L.get()); \
607 return true; \
608 }
609#include "PassRegistry.def"
610 return false;
611 });
612
613 // CGSCC-level callbacks
614 registerPipelineParsingCallback(
615 C: [this](StringRef Name, CGSCCPassManager &PM,
616 ArrayRef<PassBuilder::PipelineElement>) {
617#define CGSCC_CALLBACK(NAME, INVOKE) \
618 if (PassBuilder::checkParametrizedPassName(Name, NAME)) { \
619 auto L = PassBuilder::parsePassParameters(parseOptLevelParam, Name, NAME); \
620 if (!L) { \
621 errs() << NAME ": " << toString(L.takeError()) << '\n'; \
622 return false; \
623 } \
624 INVOKE(PM, L.get()); \
625 return true; \
626 }
627#include "PassRegistry.def"
628 return false;
629 });
630
631 // Loop-level callbacks
632 registerPipelineParsingCallback(
633 C: [this](StringRef Name, LoopPassManager &PM,
634 ArrayRef<PassBuilder::PipelineElement>) {
635#define LOOP_CALLBACK(NAME, INVOKE) \
636 if (PassBuilder::checkParametrizedPassName(Name, NAME)) { \
637 auto L = PassBuilder::parsePassParameters(parseOptLevelParam, Name, NAME); \
638 if (!L) { \
639 errs() << NAME ": " << toString(L.takeError()) << '\n'; \
640 return false; \
641 } \
642 INVOKE(PM, L.get()); \
643 return true; \
644 }
645#include "PassRegistry.def"
646 return false;
647 });
648}
649
650void PassBuilder::registerModuleAnalyses(ModuleAnalysisManager &MAM) {
651#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
652 MAM.registerPass([&] { return CREATE_PASS; });
653#include "PassRegistry.def"
654
655 for (auto &C : ModuleAnalysisRegistrationCallbacks)
656 C(MAM);
657}
658
659void PassBuilder::registerCGSCCAnalyses(CGSCCAnalysisManager &CGAM) {
660#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
661 CGAM.registerPass([&] { return CREATE_PASS; });
662#include "PassRegistry.def"
663
664 for (auto &C : CGSCCAnalysisRegistrationCallbacks)
665 C(CGAM);
666}
667
668void PassBuilder::registerFunctionAnalyses(FunctionAnalysisManager &FAM) {
669 // We almost always want the default alias analysis pipeline.
670 // If a user wants a different one, they can register their own before calling
671 // registerFunctionAnalyses().
672 FAM.registerPass(PassBuilder: [&] { return buildDefaultAAPipeline(); });
673
674#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
675 if constexpr (std::is_constructible_v< \
676 std::remove_reference_t<decltype(CREATE_PASS)>, \
677 const TargetMachine &>) { \
678 if (TM) \
679 FAM.registerPass([&] { return CREATE_PASS; }); \
680 } else { \
681 FAM.registerPass([&] { return CREATE_PASS; }); \
682 }
683#include "PassRegistry.def"
684
685 for (auto &C : FunctionAnalysisRegistrationCallbacks)
686 C(FAM);
687}
688
689void PassBuilder::registerMachineFunctionAnalyses(
690 MachineFunctionAnalysisManager &MFAM) {
691
692#define MACHINE_FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
693 MFAM.registerPass([&] { return CREATE_PASS; });
694#include "llvm/Passes/MachinePassRegistry.def"
695
696 for (auto &C : MachineFunctionAnalysisRegistrationCallbacks)
697 C(MFAM);
698}
699
700void PassBuilder::registerLoopAnalyses(LoopAnalysisManager &LAM) {
701#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
702 LAM.registerPass([&] { return CREATE_PASS; });
703#include "PassRegistry.def"
704
705 for (auto &C : LoopAnalysisRegistrationCallbacks)
706 C(LAM);
707}
708
709static std::optional<std::pair<bool, bool>>
710parseFunctionPipelineName(StringRef Name) {
711 std::pair<bool, bool> Params;
712 if (!Name.consume_front(Prefix: "function"))
713 return std::nullopt;
714 if (Name.empty())
715 return Params;
716 if (!Name.consume_front(Prefix: "<") || !Name.consume_back(Suffix: ">"))
717 return std::nullopt;
718 while (!Name.empty()) {
719 auto [Front, Back] = Name.split(Separator: ';');
720 Name = Back;
721 if (Front == "eager-inv")
722 Params.first = true;
723 else if (Front == "no-rerun")
724 Params.second = true;
725 else
726 return std::nullopt;
727 }
728 return Params;
729}
730
731static std::optional<int> parseDevirtPassName(StringRef Name) {
732 if (!Name.consume_front(Prefix: "devirt<") || !Name.consume_back(Suffix: ">"))
733 return std::nullopt;
734 int Count;
735 if (Name.getAsInteger(Radix: 0, Result&: Count) || Count < 0)
736 return std::nullopt;
737 return Count;
738}
739
740Expected<bool> PassBuilder::parseSinglePassOption(StringRef Params,
741 StringRef OptionName,
742 StringRef PassName) {
743 bool Result = false;
744 while (!Params.empty()) {
745 StringRef ParamName;
746 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
747
748 if (ParamName == OptionName) {
749 Result = true;
750 } else {
751 return make_error<StringError>(
752 Args: formatv(Fmt: "invalid {} pass parameter '{}'", Vals&: PassName, Vals&: ParamName).str(),
753 Args: inconvertibleErrorCode());
754 }
755 }
756 return Result;
757}
758
759namespace {
760
761/// Parser of parameters for HardwareLoops pass.
762Expected<HardwareLoopOptions> parseHardwareLoopOptions(StringRef Params) {
763 HardwareLoopOptions HardwareLoopOpts;
764
765 while (!Params.empty()) {
766 StringRef ParamName;
767 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
768 if (ParamName.consume_front(Prefix: "hardware-loop-decrement=")) {
769 int Count;
770 if (ParamName.getAsInteger(Radix: 0, Result&: Count))
771 return make_error<StringError>(
772 Args: formatv(Fmt: "invalid HardwareLoopPass parameter '{}'", Vals&: ParamName).str(),
773 Args: inconvertibleErrorCode());
774 HardwareLoopOpts.setDecrement(Count);
775 continue;
776 }
777 if (ParamName.consume_front(Prefix: "hardware-loop-counter-bitwidth=")) {
778 int Count;
779 if (ParamName.getAsInteger(Radix: 0, Result&: Count))
780 return make_error<StringError>(
781 Args: formatv(Fmt: "invalid HardwareLoopPass parameter '{}'", Vals&: ParamName).str(),
782 Args: inconvertibleErrorCode());
783 HardwareLoopOpts.setCounterBitwidth(Count);
784 continue;
785 }
786 if (ParamName == "force-hardware-loops") {
787 HardwareLoopOpts.setForce(true);
788 } else if (ParamName == "force-hardware-loop-phi") {
789 HardwareLoopOpts.setForcePhi(true);
790 } else if (ParamName == "force-nested-hardware-loop") {
791 HardwareLoopOpts.setForceNested(true);
792 } else if (ParamName == "force-hardware-loop-guard") {
793 HardwareLoopOpts.setForceGuard(true);
794 } else {
795 return make_error<StringError>(
796 Args: formatv(Fmt: "invalid HardwarePass parameter '{}'", Vals&: ParamName).str(),
797 Args: inconvertibleErrorCode());
798 }
799 }
800 return HardwareLoopOpts;
801}
802
803/// Parser of parameters for Lint pass.
804Expected<bool> parseLintOptions(StringRef Params) {
805 return PassBuilder::parseSinglePassOption(Params, OptionName: "abort-on-error",
806 PassName: "LintPass");
807}
808
809/// Parser of parameters for LoopUnroll pass.
810Expected<LoopUnrollOptions> parseLoopUnrollOptions(StringRef Params) {
811 LoopUnrollOptions UnrollOpts;
812 while (!Params.empty()) {
813 StringRef ParamName;
814 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
815 std::optional<OptimizationLevel> OptLevel = parseOptLevel(S: ParamName);
816 // Don't accept -Os/-Oz.
817 if (OptLevel && !OptLevel->isOptimizingForSize()) {
818 UnrollOpts.setOptLevel(OptLevel->getSpeedupLevel());
819 continue;
820 }
821 if (ParamName.consume_front(Prefix: "full-unroll-max=")) {
822 int Count;
823 if (ParamName.getAsInteger(Radix: 0, Result&: Count))
824 return make_error<StringError>(
825 Args: formatv(Fmt: "invalid LoopUnrollPass parameter '{}'", Vals&: ParamName).str(),
826 Args: inconvertibleErrorCode());
827 UnrollOpts.setFullUnrollMaxCount(Count);
828 continue;
829 }
830
831 bool Enable = !ParamName.consume_front(Prefix: "no-");
832 if (ParamName == "partial") {
833 UnrollOpts.setPartial(Enable);
834 } else if (ParamName == "peeling") {
835 UnrollOpts.setPeeling(Enable);
836 } else if (ParamName == "profile-peeling") {
837 UnrollOpts.setProfileBasedPeeling(Enable);
838 } else if (ParamName == "runtime") {
839 UnrollOpts.setRuntime(Enable);
840 } else if (ParamName == "upperbound") {
841 UnrollOpts.setUpperBound(Enable);
842 } else {
843 return make_error<StringError>(
844 Args: formatv(Fmt: "invalid LoopUnrollPass parameter '{}'", Vals&: ParamName).str(),
845 Args: inconvertibleErrorCode());
846 }
847 }
848 return UnrollOpts;
849}
850
851Expected<bool> parseGlobalDCEPassOptions(StringRef Params) {
852 return PassBuilder::parseSinglePassOption(
853 Params, OptionName: "vfe-linkage-unit-visibility", PassName: "GlobalDCE");
854}
855
856Expected<bool> parseCGProfilePassOptions(StringRef Params) {
857 return PassBuilder::parseSinglePassOption(Params, OptionName: "in-lto-post-link",
858 PassName: "CGProfile");
859}
860
861Expected<bool> parseInlinerPassOptions(StringRef Params) {
862 return PassBuilder::parseSinglePassOption(Params, OptionName: "only-mandatory",
863 PassName: "InlinerPass");
864}
865
866Expected<bool> parseCoroSplitPassOptions(StringRef Params) {
867 return PassBuilder::parseSinglePassOption(Params, OptionName: "reuse-storage",
868 PassName: "CoroSplitPass");
869}
870
871Expected<bool> parsePostOrderFunctionAttrsPassOptions(StringRef Params) {
872 return PassBuilder::parseSinglePassOption(
873 Params, OptionName: "skip-non-recursive-function-attrs", PassName: "PostOrderFunctionAttrs");
874}
875
876Expected<CFGuardPass::Mechanism> parseCFGuardPassOptions(StringRef Params) {
877 if (Params.empty())
878 return CFGuardPass::Mechanism::Check;
879
880 auto [Param, RHS] = Params.split(Separator: ';');
881 if (!RHS.empty())
882 return make_error<StringError>(
883 Args: formatv(Fmt: "too many CFGuardPass parameters '{}'", Vals&: Params).str(),
884 Args: inconvertibleErrorCode());
885
886 if (Param == "check")
887 return CFGuardPass::Mechanism::Check;
888 if (Param == "dispatch")
889 return CFGuardPass::Mechanism::Dispatch;
890
891 return make_error<StringError>(
892 Args: formatv(Fmt: "invalid CFGuardPass mechanism: '{}'", Vals&: Param).str(),
893 Args: inconvertibleErrorCode());
894}
895
896Expected<bool> parseEarlyCSEPassOptions(StringRef Params) {
897 return PassBuilder::parseSinglePassOption(Params, OptionName: "memssa", PassName: "EarlyCSE");
898}
899
900Expected<bool> parseEntryExitInstrumenterPassOptions(StringRef Params) {
901 return PassBuilder::parseSinglePassOption(Params, OptionName: "post-inline",
902 PassName: "EntryExitInstrumenter");
903}
904
905Expected<bool> parseDropUnnecessaryAssumesPassOptions(StringRef Params) {
906 return PassBuilder::parseSinglePassOption(Params, OptionName: "drop-deref",
907 PassName: "DropUnnecessaryAssumes");
908}
909
910Expected<bool> parseLoopExtractorPassOptions(StringRef Params) {
911 return PassBuilder::parseSinglePassOption(Params, OptionName: "single", PassName: "LoopExtractor");
912}
913
914Expected<bool> parseLowerMatrixIntrinsicsPassOptions(StringRef Params) {
915 return PassBuilder::parseSinglePassOption(Params, OptionName: "minimal",
916 PassName: "LowerMatrixIntrinsics");
917}
918
919Expected<IRNormalizerOptions> parseIRNormalizerPassOptions(StringRef Params) {
920 IRNormalizerOptions Result;
921 while (!Params.empty()) {
922 StringRef ParamName;
923 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
924
925 bool Enable = !ParamName.consume_front(Prefix: "no-");
926 if (ParamName == "preserve-order")
927 Result.PreserveOrder = Enable;
928 else if (ParamName == "rename-all")
929 Result.RenameAll = Enable;
930 else if (ParamName == "fold-all") // FIXME: Name mismatch
931 Result.FoldPreOutputs = Enable;
932 else if (ParamName == "reorder-operands")
933 Result.ReorderOperands = Enable;
934 else {
935 return make_error<StringError>(
936 Args: formatv(Fmt: "invalid normalize pass parameter '{}'", Vals&: ParamName).str(),
937 Args: inconvertibleErrorCode());
938 }
939 }
940
941 return Result;
942}
943
944Expected<AddressSanitizerOptions> parseASanPassOptions(StringRef Params) {
945 AddressSanitizerOptions Result;
946 while (!Params.empty()) {
947 StringRef ParamName;
948 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
949
950 if (ParamName == "kernel") {
951 Result.CompileKernel = true;
952 } else if (ParamName == "use-after-scope") {
953 Result.UseAfterScope = true;
954 } else {
955 return make_error<StringError>(
956 Args: formatv(Fmt: "invalid AddressSanitizer pass parameter '{}'", Vals&: ParamName)
957 .str(),
958 Args: inconvertibleErrorCode());
959 }
960 }
961 return Result;
962}
963
964Expected<HWAddressSanitizerOptions> parseHWASanPassOptions(StringRef Params) {
965 HWAddressSanitizerOptions Result;
966 while (!Params.empty()) {
967 StringRef ParamName;
968 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
969
970 if (ParamName == "recover") {
971 Result.Recover = true;
972 } else if (ParamName == "kernel") {
973 Result.CompileKernel = true;
974 } else {
975 return make_error<StringError>(
976 Args: formatv(Fmt: "invalid HWAddressSanitizer pass parameter '{}'", Vals&: ParamName)
977 .str(),
978 Args: inconvertibleErrorCode());
979 }
980 }
981 return Result;
982}
983
984Expected<EmbedBitcodeOptions> parseEmbedBitcodePassOptions(StringRef Params) {
985 EmbedBitcodeOptions Result;
986 while (!Params.empty()) {
987 StringRef ParamName;
988 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
989
990 if (ParamName == "thinlto") {
991 Result.IsThinLTO = true;
992 } else if (ParamName == "emit-summary") {
993 Result.EmitLTOSummary = true;
994 } else {
995 return make_error<StringError>(
996 Args: formatv(Fmt: "invalid EmbedBitcode pass parameter '{}'", Vals&: ParamName).str(),
997 Args: inconvertibleErrorCode());
998 }
999 }
1000 return Result;
1001}
1002
1003Expected<LowerAllowCheckPass::Options>
1004parseLowerAllowCheckPassOptions(StringRef Params) {
1005 LowerAllowCheckPass::Options Result;
1006 while (!Params.empty()) {
1007 StringRef ParamName;
1008 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1009
1010 // Format is <cutoffs[1,2,3]=70000;cutoffs[5,6,8]=90000>
1011 //
1012 // Parsing allows duplicate indices (last one takes precedence).
1013 // It would technically be in spec to specify
1014 // cutoffs[0]=70000,cutoffs[1]=90000,cutoffs[0]=80000,...
1015 if (ParamName.starts_with(Prefix: "cutoffs[")) {
1016 StringRef IndicesStr;
1017 StringRef CutoffStr;
1018
1019 std::tie(args&: IndicesStr, args&: CutoffStr) = ParamName.split(Separator: "]=");
1020 // cutoffs[1,2,3
1021 // 70000
1022
1023 int cutoff;
1024 if (CutoffStr.getAsInteger(Radix: 0, Result&: cutoff))
1025 return make_error<StringError>(
1026 Args: formatv(Fmt: "invalid LowerAllowCheck pass cutoffs parameter '{}' ({})",
1027 Vals&: CutoffStr, Vals&: Params)
1028 .str(),
1029 Args: inconvertibleErrorCode());
1030
1031 if (!IndicesStr.consume_front(Prefix: "cutoffs[") || IndicesStr == "")
1032 return make_error<StringError>(
1033 Args: formatv(Fmt: "invalid LowerAllowCheck pass index parameter '{}' ({})",
1034 Vals&: IndicesStr, Vals&: CutoffStr)
1035 .str(),
1036 Args: inconvertibleErrorCode());
1037
1038 while (IndicesStr != "") {
1039 StringRef firstIndexStr;
1040 std::tie(args&: firstIndexStr, args&: IndicesStr) = IndicesStr.split(Separator: '|');
1041
1042 unsigned int index;
1043 if (firstIndexStr.getAsInteger(Radix: 0, Result&: index))
1044 return make_error<StringError>(
1045 Args: formatv(
1046 Fmt: "invalid LowerAllowCheck pass index parameter '{}' ({}) {}",
1047 Vals&: firstIndexStr, Vals&: IndicesStr)
1048 .str(),
1049 Args: inconvertibleErrorCode());
1050
1051 // In the common case (sequentially increasing indices), we will issue
1052 // O(n) resize requests. We assume the underlying data structure has
1053 // O(1) runtime for each added element.
1054 if (index >= Result.cutoffs.size())
1055 Result.cutoffs.resize(new_size: index + 1, x: 0);
1056
1057 Result.cutoffs[index] = cutoff;
1058 }
1059 } else if (ParamName.starts_with(Prefix: "runtime_check")) {
1060 StringRef ValueString;
1061 std::tie(args: std::ignore, args&: ValueString) = ParamName.split(Separator: "=");
1062 int runtime_check;
1063 if (ValueString.getAsInteger(Radix: 0, Result&: runtime_check)) {
1064 return make_error<StringError>(
1065 Args: formatv(Fmt: "invalid LowerAllowCheck pass runtime_check parameter '{}' "
1066 "({})",
1067 Vals&: ValueString, Vals&: Params)
1068 .str(),
1069 Args: inconvertibleErrorCode());
1070 }
1071 Result.runtime_check = runtime_check;
1072 } else {
1073 return make_error<StringError>(
1074 Args: formatv(Fmt: "invalid LowerAllowCheck pass parameter '{}'", Vals&: ParamName)
1075 .str(),
1076 Args: inconvertibleErrorCode());
1077 }
1078 }
1079
1080 return Result;
1081}
1082
1083Expected<MemorySanitizerOptions> parseMSanPassOptions(StringRef Params) {
1084 MemorySanitizerOptions Result;
1085 while (!Params.empty()) {
1086 StringRef ParamName;
1087 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1088
1089 if (ParamName == "recover") {
1090 Result.Recover = true;
1091 } else if (ParamName == "kernel") {
1092 Result.Kernel = true;
1093 } else if (ParamName.consume_front(Prefix: "track-origins=")) {
1094 if (ParamName.getAsInteger(Radix: 0, Result&: Result.TrackOrigins))
1095 return make_error<StringError>(
1096 Args: formatv(Fmt: "invalid argument to MemorySanitizer pass track-origins "
1097 "parameter: '{}'",
1098 Vals&: ParamName)
1099 .str(),
1100 Args: inconvertibleErrorCode());
1101 } else if (ParamName == "eager-checks") {
1102 Result.EagerChecks = true;
1103 } else {
1104 return make_error<StringError>(
1105 Args: formatv(Fmt: "invalid MemorySanitizer pass parameter '{}'", Vals&: ParamName)
1106 .str(),
1107 Args: inconvertibleErrorCode());
1108 }
1109 }
1110 return Result;
1111}
1112
1113Expected<AllocTokenOptions> parseAllocTokenPassOptions(StringRef Params) {
1114 AllocTokenOptions Result;
1115 while (!Params.empty()) {
1116 StringRef ParamName;
1117 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1118
1119 if (ParamName.consume_front(Prefix: "mode=")) {
1120 if (auto Mode = getAllocTokenModeFromString(Name: ParamName))
1121 Result.Mode = *Mode;
1122 else
1123 return make_error<StringError>(
1124 Args: formatv(Fmt: "invalid argument to AllocToken pass mode "
1125 "parameter: '{}'",
1126 Vals&: ParamName)
1127 .str(),
1128 Args: inconvertibleErrorCode());
1129 } else {
1130 return make_error<StringError>(
1131 Args: formatv(Fmt: "invalid AllocToken pass parameter '{}'", Vals&: ParamName).str(),
1132 Args: inconvertibleErrorCode());
1133 }
1134 }
1135 return Result;
1136}
1137
1138/// Parser of parameters for SimplifyCFG pass.
1139Expected<SimplifyCFGOptions> parseSimplifyCFGOptions(StringRef Params) {
1140 SimplifyCFGOptions Result;
1141 while (!Params.empty()) {
1142 StringRef ParamName;
1143 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1144
1145 bool Enable = !ParamName.consume_front(Prefix: "no-");
1146 if (ParamName == "speculate-blocks") {
1147 Result.speculateBlocks(B: Enable);
1148 } else if (ParamName == "simplify-cond-branch") {
1149 Result.setSimplifyCondBranch(Enable);
1150 } else if (ParamName == "forward-switch-cond") {
1151 Result.forwardSwitchCondToPhi(B: Enable);
1152 } else if (ParamName == "switch-range-to-icmp") {
1153 Result.convertSwitchRangeToICmp(B: Enable);
1154 } else if (ParamName == "switch-to-arithmetic") {
1155 Result.convertSwitchToArithmetic(B: Enable);
1156 } else if (ParamName == "switch-to-lookup") {
1157 Result.convertSwitchToLookupTable(B: Enable);
1158 } else if (ParamName == "keep-loops") {
1159 Result.needCanonicalLoops(B: Enable);
1160 } else if (ParamName == "hoist-common-insts") {
1161 Result.hoistCommonInsts(B: Enable);
1162 } else if (ParamName == "hoist-loads-stores-with-cond-faulting") {
1163 Result.hoistLoadsStoresWithCondFaulting(B: Enable);
1164 } else if (ParamName == "sink-common-insts") {
1165 Result.sinkCommonInsts(B: Enable);
1166 } else if (ParamName == "speculate-unpredictables") {
1167 Result.speculateUnpredictables(B: Enable);
1168 } else if (Enable && ParamName.consume_front(Prefix: "bonus-inst-threshold=")) {
1169 APInt BonusInstThreshold;
1170 if (ParamName.getAsInteger(Radix: 0, Result&: BonusInstThreshold))
1171 return make_error<StringError>(
1172 Args: formatv(Fmt: "invalid argument to SimplifyCFG pass bonus-threshold "
1173 "parameter: '{}'",
1174 Vals&: ParamName)
1175 .str(),
1176 Args: inconvertibleErrorCode());
1177 Result.bonusInstThreshold(I: BonusInstThreshold.getSExtValue());
1178 } else {
1179 return make_error<StringError>(
1180 Args: formatv(Fmt: "invalid SimplifyCFG pass parameter '{}'", Vals&: ParamName).str(),
1181 Args: inconvertibleErrorCode());
1182 }
1183 }
1184 return Result;
1185}
1186
1187Expected<InstCombineOptions> parseInstCombineOptions(StringRef Params) {
1188 InstCombineOptions Result;
1189 // When specifying "instcombine" in -passes enable fix-point verification by
1190 // default, as this is what most tests should use.
1191 Result.setVerifyFixpoint(true);
1192 while (!Params.empty()) {
1193 StringRef ParamName;
1194 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1195
1196 bool Enable = !ParamName.consume_front(Prefix: "no-");
1197 if (ParamName == "verify-fixpoint") {
1198 Result.setVerifyFixpoint(Enable);
1199 } else if (Enable && ParamName.consume_front(Prefix: "max-iterations=")) {
1200 APInt MaxIterations;
1201 if (ParamName.getAsInteger(Radix: 0, Result&: MaxIterations))
1202 return make_error<StringError>(
1203 Args: formatv(Fmt: "invalid argument to InstCombine pass max-iterations "
1204 "parameter: '{}'",
1205 Vals&: ParamName)
1206 .str(),
1207 Args: inconvertibleErrorCode());
1208 Result.setMaxIterations((unsigned)MaxIterations.getZExtValue());
1209 } else {
1210 return make_error<StringError>(
1211 Args: formatv(Fmt: "invalid InstCombine pass parameter '{}'", Vals&: ParamName).str(),
1212 Args: inconvertibleErrorCode());
1213 }
1214 }
1215 return Result;
1216}
1217
1218/// Parser of parameters for LoopVectorize pass.
1219Expected<LoopVectorizeOptions> parseLoopVectorizeOptions(StringRef Params) {
1220 LoopVectorizeOptions Opts;
1221 while (!Params.empty()) {
1222 StringRef ParamName;
1223 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1224
1225 bool Enable = !ParamName.consume_front(Prefix: "no-");
1226 if (ParamName == "interleave-forced-only") {
1227 Opts.setInterleaveOnlyWhenForced(Enable);
1228 } else if (ParamName == "vectorize-forced-only") {
1229 Opts.setVectorizeOnlyWhenForced(Enable);
1230 } else {
1231 return make_error<StringError>(
1232 Args: formatv(Fmt: "invalid LoopVectorize parameter '{}'", Vals&: ParamName).str(),
1233 Args: inconvertibleErrorCode());
1234 }
1235 }
1236 return Opts;
1237}
1238
1239Expected<std::pair<bool, bool>> parseLoopUnswitchOptions(StringRef Params) {
1240 std::pair<bool, bool> Result = {false, true};
1241 while (!Params.empty()) {
1242 StringRef ParamName;
1243 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1244
1245 bool Enable = !ParamName.consume_front(Prefix: "no-");
1246 if (ParamName == "nontrivial") {
1247 Result.first = Enable;
1248 } else if (ParamName == "trivial") {
1249 Result.second = Enable;
1250 } else {
1251 return make_error<StringError>(
1252 Args: formatv(Fmt: "invalid LoopUnswitch pass parameter '{}'", Vals&: ParamName).str(),
1253 Args: inconvertibleErrorCode());
1254 }
1255 }
1256 return Result;
1257}
1258
1259Expected<LICMOptions> parseLICMOptions(StringRef Params) {
1260 LICMOptions Result;
1261 while (!Params.empty()) {
1262 StringRef ParamName;
1263 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1264
1265 bool Enable = !ParamName.consume_front(Prefix: "no-");
1266 if (ParamName == "allowspeculation") {
1267 Result.AllowSpeculation = Enable;
1268 } else {
1269 return make_error<StringError>(
1270 Args: formatv(Fmt: "invalid LICM pass parameter '{}'", Vals&: ParamName).str(),
1271 Args: inconvertibleErrorCode());
1272 }
1273 }
1274 return Result;
1275}
1276
1277Expected<std::pair<bool, bool>> parseLoopRotateOptions(StringRef Params) {
1278 std::pair<bool, bool> Result = {true, false};
1279 while (!Params.empty()) {
1280 StringRef ParamName;
1281 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1282
1283 bool Enable = !ParamName.consume_front(Prefix: "no-");
1284 if (ParamName == "header-duplication") {
1285 Result.first = Enable;
1286 } else if (ParamName == "prepare-for-lto") {
1287 Result.second = Enable;
1288 } else {
1289 return make_error<StringError>(
1290 Args: formatv(Fmt: "invalid LoopRotate pass parameter '{}'", Vals&: ParamName).str(),
1291 Args: inconvertibleErrorCode());
1292 }
1293 }
1294 return Result;
1295}
1296
1297Expected<bool> parseMergedLoadStoreMotionOptions(StringRef Params) {
1298 bool Result = false;
1299 while (!Params.empty()) {
1300 StringRef ParamName;
1301 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1302
1303 bool Enable = !ParamName.consume_front(Prefix: "no-");
1304 if (ParamName == "split-footer-bb") {
1305 Result = Enable;
1306 } else {
1307 return make_error<StringError>(
1308 Args: formatv(Fmt: "invalid MergedLoadStoreMotion pass parameter '{}'",
1309 Vals&: ParamName)
1310 .str(),
1311 Args: inconvertibleErrorCode());
1312 }
1313 }
1314 return Result;
1315}
1316
1317Expected<GVNOptions> parseGVNOptions(StringRef Params) {
1318 GVNOptions Result;
1319 while (!Params.empty()) {
1320 StringRef ParamName;
1321 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1322
1323 bool Enable = !ParamName.consume_front(Prefix: "no-");
1324 if (ParamName == "pre") {
1325 Result.setPRE(Enable);
1326 } else if (ParamName == "load-pre") {
1327 Result.setLoadPRE(Enable);
1328 } else if (ParamName == "split-backedge-load-pre") {
1329 Result.setLoadPRESplitBackedge(Enable);
1330 } else if (ParamName == "memdep") {
1331 // MemDep and MemorySSA are mutually exclusive.
1332 Result.setMemDep(Enable);
1333 Result.setMemorySSA(!Enable);
1334 } else if (ParamName == "memoryssa") {
1335 // MemDep and MemorySSA are mutually exclusive.
1336 Result.setMemorySSA(Enable);
1337 Result.setMemDep(!Enable);
1338 } else {
1339 return make_error<StringError>(
1340 Args: formatv(Fmt: "invalid GVN pass parameter '{}'", Vals&: ParamName).str(),
1341 Args: inconvertibleErrorCode());
1342 }
1343 }
1344 return Result;
1345}
1346
1347Expected<IPSCCPOptions> parseIPSCCPOptions(StringRef Params) {
1348 IPSCCPOptions Result;
1349 while (!Params.empty()) {
1350 StringRef ParamName;
1351 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1352
1353 bool Enable = !ParamName.consume_front(Prefix: "no-");
1354 if (ParamName == "func-spec")
1355 Result.setFuncSpec(Enable);
1356 else
1357 return make_error<StringError>(
1358 Args: formatv(Fmt: "invalid IPSCCP pass parameter '{}'", Vals&: ParamName).str(),
1359 Args: inconvertibleErrorCode());
1360 }
1361 return Result;
1362}
1363
1364Expected<ScalarizerPassOptions> parseScalarizerOptions(StringRef Params) {
1365 ScalarizerPassOptions Result;
1366 while (!Params.empty()) {
1367 StringRef ParamName;
1368 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1369
1370 if (ParamName.consume_front(Prefix: "min-bits=")) {
1371 if (ParamName.getAsInteger(Radix: 0, Result&: Result.ScalarizeMinBits)) {
1372 return make_error<StringError>(
1373 Args: formatv(Fmt: "invalid argument to Scalarizer pass min-bits "
1374 "parameter: '{}'",
1375 Vals&: ParamName)
1376 .str(),
1377 Args: inconvertibleErrorCode());
1378 }
1379
1380 continue;
1381 }
1382
1383 bool Enable = !ParamName.consume_front(Prefix: "no-");
1384 if (ParamName == "load-store")
1385 Result.ScalarizeLoadStore = Enable;
1386 else if (ParamName == "variable-insert-extract")
1387 Result.ScalarizeVariableInsertExtract = Enable;
1388 else {
1389 return make_error<StringError>(
1390 Args: formatv(Fmt: "invalid Scalarizer pass parameter '{}'", Vals&: ParamName).str(),
1391 Args: inconvertibleErrorCode());
1392 }
1393 }
1394
1395 return Result;
1396}
1397
1398Expected<SROAOptions> parseSROAOptions(StringRef Params) {
1399 if (Params.empty() || Params == "modify-cfg")
1400 return SROAOptions::ModifyCFG;
1401 if (Params == "preserve-cfg")
1402 return SROAOptions::PreserveCFG;
1403 return make_error<StringError>(
1404 Args: formatv(Fmt: "invalid SROA pass parameter '{}' (either preserve-cfg or "
1405 "modify-cfg can be specified)",
1406 Vals&: Params)
1407 .str(),
1408 Args: inconvertibleErrorCode());
1409}
1410
1411Expected<StackLifetime::LivenessType>
1412parseStackLifetimeOptions(StringRef Params) {
1413 StackLifetime::LivenessType Result = StackLifetime::LivenessType::May;
1414 while (!Params.empty()) {
1415 StringRef ParamName;
1416 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1417
1418 if (ParamName == "may") {
1419 Result = StackLifetime::LivenessType::May;
1420 } else if (ParamName == "must") {
1421 Result = StackLifetime::LivenessType::Must;
1422 } else {
1423 return make_error<StringError>(
1424 Args: formatv(Fmt: "invalid StackLifetime parameter '{}'", Vals&: ParamName).str(),
1425 Args: inconvertibleErrorCode());
1426 }
1427 }
1428 return Result;
1429}
1430
1431Expected<bool> parseDependenceAnalysisPrinterOptions(StringRef Params) {
1432 return PassBuilder::parseSinglePassOption(Params, OptionName: "normalized-results",
1433 PassName: "DependenceAnalysisPrinter");
1434}
1435
1436Expected<bool> parseSeparateConstOffsetFromGEPPassOptions(StringRef Params) {
1437 return PassBuilder::parseSinglePassOption(Params, OptionName: "lower-gep",
1438 PassName: "SeparateConstOffsetFromGEP");
1439}
1440
1441Expected<bool> parseStructurizeCFGPassOptions(StringRef Params) {
1442 return PassBuilder::parseSinglePassOption(Params, OptionName: "skip-uniform-regions",
1443 PassName: "StructurizeCFG");
1444}
1445
1446Expected<OptimizationLevel>
1447parseFunctionSimplificationPipelineOptions(StringRef Params) {
1448 std::optional<OptimizationLevel> L = parseOptLevel(S: Params);
1449 if (!L || *L == OptimizationLevel::O0) {
1450 return make_error<StringError>(
1451 Args: formatv(Fmt: "invalid function-simplification parameter '{}'", Vals&: Params).str(),
1452 Args: inconvertibleErrorCode());
1453 };
1454 return *L;
1455}
1456
1457Expected<bool> parseMemorySSAPrinterPassOptions(StringRef Params) {
1458 return PassBuilder::parseSinglePassOption(Params, OptionName: "no-ensure-optimized-uses",
1459 PassName: "MemorySSAPrinterPass");
1460}
1461
1462Expected<bool> parseSpeculativeExecutionPassOptions(StringRef Params) {
1463 return PassBuilder::parseSinglePassOption(Params, OptionName: "only-if-divergent-target",
1464 PassName: "SpeculativeExecutionPass");
1465}
1466
1467Expected<std::string> parseMemProfUsePassOptions(StringRef Params) {
1468 std::string Result;
1469 while (!Params.empty()) {
1470 StringRef ParamName;
1471 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1472
1473 if (ParamName.consume_front(Prefix: "profile-filename=")) {
1474 Result = ParamName.str();
1475 } else {
1476 return make_error<StringError>(
1477 Args: formatv(Fmt: "invalid MemProfUse pass parameter '{}'", Vals&: ParamName).str(),
1478 Args: inconvertibleErrorCode());
1479 }
1480 }
1481 return Result;
1482}
1483
1484Expected<StructuralHashOptions>
1485parseStructuralHashPrinterPassOptions(StringRef Params) {
1486 if (Params.empty())
1487 return StructuralHashOptions::None;
1488 if (Params == "detailed")
1489 return StructuralHashOptions::Detailed;
1490 if (Params == "call-target-ignored")
1491 return StructuralHashOptions::CallTargetIgnored;
1492 return make_error<StringError>(
1493 Args: formatv(Fmt: "invalid structural hash printer parameter '{}'", Vals&: Params).str(),
1494 Args: inconvertibleErrorCode());
1495}
1496
1497Expected<bool> parseWinEHPrepareOptions(StringRef Params) {
1498 return PassBuilder::parseSinglePassOption(Params, OptionName: "demote-catchswitch-only",
1499 PassName: "WinEHPreparePass");
1500}
1501
1502Expected<GlobalMergeOptions> parseGlobalMergeOptions(StringRef Params) {
1503 GlobalMergeOptions Result;
1504 while (!Params.empty()) {
1505 StringRef ParamName;
1506 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1507
1508 bool Enable = !ParamName.consume_front(Prefix: "no-");
1509 if (ParamName == "group-by-use")
1510 Result.GroupByUse = Enable;
1511 else if (ParamName == "ignore-single-use")
1512 Result.IgnoreSingleUse = Enable;
1513 else if (ParamName == "merge-const")
1514 Result.MergeConstantGlobals = Enable;
1515 else if (ParamName == "merge-const-aggressive")
1516 Result.MergeConstAggressive = Enable;
1517 else if (ParamName == "merge-external")
1518 Result.MergeExternal = Enable;
1519 else if (ParamName.consume_front(Prefix: "max-offset=")) {
1520 if (ParamName.getAsInteger(Radix: 0, Result&: Result.MaxOffset))
1521 return make_error<StringError>(
1522 Args: formatv(Fmt: "invalid GlobalMergePass parameter '{}'", Vals&: ParamName).str(),
1523 Args: inconvertibleErrorCode());
1524 } else {
1525 return make_error<StringError>(
1526 Args: formatv(Fmt: "invalid global-merge pass parameter '{}'", Vals&: Params).str(),
1527 Args: inconvertibleErrorCode());
1528 }
1529 }
1530 return Result;
1531}
1532
1533Expected<SmallVector<std::string, 0>> parseInternalizeGVs(StringRef Params) {
1534 SmallVector<std::string, 1> PreservedGVs;
1535 while (!Params.empty()) {
1536 StringRef ParamName;
1537 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1538
1539 if (ParamName.consume_front(Prefix: "preserve-gv=")) {
1540 PreservedGVs.push_back(Elt: ParamName.str());
1541 } else {
1542 return make_error<StringError>(
1543 Args: formatv(Fmt: "invalid Internalize pass parameter '{}'", Vals&: ParamName).str(),
1544 Args: inconvertibleErrorCode());
1545 }
1546 }
1547
1548 return Expected<SmallVector<std::string, 0>>(std::move(PreservedGVs));
1549}
1550
1551Expected<RegAllocFastPass::Options>
1552parseRegAllocFastPassOptions(PassBuilder &PB, StringRef Params) {
1553 RegAllocFastPass::Options Opts;
1554 while (!Params.empty()) {
1555 StringRef ParamName;
1556 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1557
1558 if (ParamName.consume_front(Prefix: "filter=")) {
1559 std::optional<RegAllocFilterFunc> Filter =
1560 PB.parseRegAllocFilter(RegAllocFilterName: ParamName);
1561 if (!Filter) {
1562 return make_error<StringError>(
1563 Args: formatv(Fmt: "invalid regallocfast register filter '{}'", Vals&: ParamName)
1564 .str(),
1565 Args: inconvertibleErrorCode());
1566 }
1567 Opts.Filter = *Filter;
1568 Opts.FilterName = ParamName;
1569 continue;
1570 }
1571
1572 if (ParamName == "no-clear-vregs") {
1573 Opts.ClearVRegs = false;
1574 continue;
1575 }
1576
1577 return make_error<StringError>(
1578 Args: formatv(Fmt: "invalid regallocfast pass parameter '{}'", Vals&: ParamName).str(),
1579 Args: inconvertibleErrorCode());
1580 }
1581 return Opts;
1582}
1583
1584Expected<BoundsCheckingPass::Options>
1585parseBoundsCheckingOptions(StringRef Params) {
1586 BoundsCheckingPass::Options Options;
1587 while (!Params.empty()) {
1588 StringRef ParamName;
1589 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1590 if (ParamName == "trap") {
1591 Options.Rt = std::nullopt;
1592 } else if (ParamName == "rt") {
1593 Options.Rt = {
1594 /*MinRuntime=*/false,
1595 /*MayReturn=*/true,
1596 /*HandlerPreserveAllRegs=*/false,
1597 };
1598 } else if (ParamName == "rt-abort") {
1599 Options.Rt = {
1600 /*MinRuntime=*/false,
1601 /*MayReturn=*/false,
1602 /*HandlerPreserveAllRegs=*/false,
1603 };
1604 } else if (ParamName == "min-rt") {
1605 Options.Rt = {
1606 /*MinRuntime=*/true,
1607 /*MayReturn=*/true,
1608 /*HandlerPreserveAllRegs=*/false,
1609 };
1610 } else if (ParamName == "min-rt-abort") {
1611 Options.Rt = {
1612 /*MinRuntime=*/true,
1613 /*MayReturn=*/false,
1614 /*HandlerPreserveAllRegs=*/false,
1615 };
1616 } else if (ParamName == "merge") {
1617 Options.Merge = true;
1618 } else if (ParamName == "handler-preserve-all-regs") {
1619 if (Options.Rt)
1620 Options.Rt->HandlerPreserveAllRegs = true;
1621 } else {
1622 StringRef ParamEQ;
1623 StringRef Val;
1624 std::tie(args&: ParamEQ, args&: Val) = ParamName.split(Separator: '=');
1625 int8_t Id;
1626 if (ParamEQ == "guard" && !Val.getAsInteger(Radix: 0, Result&: Id)) {
1627 Options.GuardKind = Id;
1628 } else {
1629 return make_error<StringError>(
1630 Args: formatv(Fmt: "invalid BoundsChecking pass parameter '{}'", Vals&: ParamName)
1631 .str(),
1632 Args: inconvertibleErrorCode());
1633 }
1634 }
1635 }
1636 return Options;
1637}
1638
1639Expected<CodeGenOptLevel> parseExpandIRInstsOptions(StringRef Param) {
1640 if (Param.empty())
1641 return CodeGenOptLevel::None;
1642
1643 // Parse a CodeGenOptLevel, e.g. "O1", "O2", "O3".
1644 auto [Prefix, Digit] = Param.split(Separator: 'O');
1645
1646 uint8_t N;
1647 if (!Prefix.empty() || Digit.getAsInteger(Radix: 10, Result&: N))
1648 return createStringError(Fmt: "invalid expand-ir-insts pass parameter '%s'",
1649 Vals: Param.str().c_str());
1650
1651 std::optional<CodeGenOptLevel> Level = CodeGenOpt::getLevel(OL: N);
1652 if (!Level.has_value())
1653 return createStringError(
1654 Fmt: "invalid optimization level for expand-ir-insts pass: %s",
1655 Vals: Digit.str().c_str());
1656
1657 return *Level;
1658}
1659
1660Expected<RAGreedyPass::Options>
1661parseRegAllocGreedyFilterFunc(PassBuilder &PB, StringRef Params) {
1662 if (Params.empty() || Params == "all")
1663 return RAGreedyPass::Options();
1664
1665 std::optional<RegAllocFilterFunc> Filter = PB.parseRegAllocFilter(RegAllocFilterName: Params);
1666 if (Filter)
1667 return RAGreedyPass::Options{*Filter, Params};
1668
1669 return make_error<StringError>(
1670 Args: formatv(Fmt: "invalid regallocgreedy register filter '{}'", Vals&: Params).str(),
1671 Args: inconvertibleErrorCode());
1672}
1673
1674Expected<bool> parseMachineSinkingPassOptions(StringRef Params) {
1675 return PassBuilder::parseSinglePassOption(Params, OptionName: "enable-sink-fold",
1676 PassName: "MachineSinkingPass");
1677}
1678
1679Expected<bool> parseMachineBlockPlacementPassOptions(StringRef Params) {
1680 bool AllowTailMerge = true;
1681 if (!Params.empty()) {
1682 AllowTailMerge = !Params.consume_front(Prefix: "no-");
1683 if (Params != "tail-merge")
1684 return make_error<StringError>(
1685 Args: formatv(Fmt: "invalid MachineBlockPlacementPass parameter '{}'", Vals&: Params)
1686 .str(),
1687 Args: inconvertibleErrorCode());
1688 }
1689 return AllowTailMerge;
1690}
1691
1692Expected<bool> parseVirtRegRewriterPassOptions(StringRef Params) {
1693 bool ClearVirtRegs = true;
1694 if (!Params.empty()) {
1695 ClearVirtRegs = !Params.consume_front(Prefix: "no-");
1696 if (Params != "clear-vregs")
1697 return make_error<StringError>(
1698 Args: formatv(Fmt: "invalid VirtRegRewriter pass parameter '{}'", Vals&: Params).str(),
1699 Args: inconvertibleErrorCode());
1700 }
1701 return ClearVirtRegs;
1702}
1703
1704struct FatLTOOptions {
1705 OptimizationLevel OptLevel;
1706 bool ThinLTO = false;
1707 bool EmitSummary = false;
1708};
1709
1710Expected<FatLTOOptions> parseFatLTOOptions(StringRef Params) {
1711 FatLTOOptions Result;
1712 bool HaveOptLevel = false;
1713 while (!Params.empty()) {
1714 StringRef ParamName;
1715 std::tie(args&: ParamName, args&: Params) = Params.split(Separator: ';');
1716
1717 if (ParamName == "thinlto") {
1718 Result.ThinLTO = true;
1719 } else if (ParamName == "emit-summary") {
1720 Result.EmitSummary = true;
1721 } else if (std::optional<OptimizationLevel> OptLevel =
1722 parseOptLevel(S: ParamName)) {
1723 Result.OptLevel = *OptLevel;
1724 HaveOptLevel = true;
1725 } else {
1726 return make_error<StringError>(
1727 Args: formatv(Fmt: "invalid fatlto-pre-link pass parameter '{}'", Vals&: ParamName)
1728 .str(),
1729 Args: inconvertibleErrorCode());
1730 }
1731 }
1732 if (!HaveOptLevel)
1733 return make_error<StringError>(
1734 Args: "missing optimization level for fatlto-pre-link pipeline",
1735 Args: inconvertibleErrorCode());
1736 return Result;
1737}
1738
1739} // namespace
1740
1741/// Tests whether registered callbacks will accept a given pass name.
1742///
1743/// When parsing a pipeline text, the type of the outermost pipeline may be
1744/// omitted, in which case the type is automatically determined from the first
1745/// pass name in the text. This may be a name that is handled through one of the
1746/// callbacks. We check this through the oridinary parsing callbacks by setting
1747/// up a dummy PassManager in order to not force the client to also handle this
1748/// type of query.
1749template <typename PassManagerT, typename CallbacksT>
1750static bool callbacksAcceptPassName(StringRef Name, CallbacksT &Callbacks) {
1751 if (!Callbacks.empty()) {
1752 PassManagerT DummyPM;
1753 for (auto &CB : Callbacks)
1754 if (CB(Name, DummyPM, {}))
1755 return true;
1756 }
1757 return false;
1758}
1759
1760template <typename CallbacksT>
1761static bool isModulePassName(StringRef Name, CallbacksT &Callbacks) {
1762 StringRef NameNoBracket = Name.take_until(F: [](char C) { return C == '<'; });
1763
1764 // Explicitly handle pass manager names.
1765 if (Name == "module")
1766 return true;
1767 if (Name == "cgscc")
1768 return true;
1769 if (NameNoBracket == "function")
1770 return true;
1771 if (Name == "coro-cond")
1772 return true;
1773
1774#define MODULE_PASS(NAME, CREATE_PASS) \
1775 if (Name == NAME) \
1776 return true;
1777#define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
1778 if (PassBuilder::checkParametrizedPassName(Name, NAME)) \
1779 return true;
1780#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
1781 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
1782 return true;
1783#include "PassRegistry.def"
1784
1785 return callbacksAcceptPassName<ModulePassManager>(Name, Callbacks);
1786}
1787
1788template <typename CallbacksT>
1789static bool isCGSCCPassName(StringRef Name, CallbacksT &Callbacks) {
1790 // Explicitly handle pass manager names.
1791 StringRef NameNoBracket = Name.take_until(F: [](char C) { return C == '<'; });
1792 if (Name == "cgscc")
1793 return true;
1794 if (NameNoBracket == "function")
1795 return true;
1796
1797 // Explicitly handle custom-parsed pass names.
1798 if (parseDevirtPassName(Name))
1799 return true;
1800
1801#define CGSCC_PASS(NAME, CREATE_PASS) \
1802 if (Name == NAME) \
1803 return true;
1804#define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
1805 if (PassBuilder::checkParametrizedPassName(Name, NAME)) \
1806 return true;
1807#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
1808 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
1809 return true;
1810#include "PassRegistry.def"
1811
1812 return callbacksAcceptPassName<CGSCCPassManager>(Name, Callbacks);
1813}
1814
1815template <typename CallbacksT>
1816static bool isFunctionPassName(StringRef Name, CallbacksT &Callbacks) {
1817 // Explicitly handle pass manager names.
1818 StringRef NameNoBracket = Name.take_until(F: [](char C) { return C == '<'; });
1819 if (NameNoBracket == "function")
1820 return true;
1821 if (Name == "loop" || Name == "loop-mssa" || Name == "machine-function")
1822 return true;
1823
1824#define FUNCTION_PASS(NAME, CREATE_PASS) \
1825 if (Name == NAME) \
1826 return true;
1827#define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
1828 if (PassBuilder::checkParametrizedPassName(Name, NAME)) \
1829 return true;
1830#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
1831 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
1832 return true;
1833#include "PassRegistry.def"
1834
1835 return callbacksAcceptPassName<FunctionPassManager>(Name, Callbacks);
1836}
1837
1838template <typename CallbacksT>
1839static bool isMachineFunctionPassName(StringRef Name, CallbacksT &Callbacks) {
1840 // Explicitly handle pass manager names.
1841 if (Name == "machine-function")
1842 return true;
1843
1844#define MACHINE_FUNCTION_PASS(NAME, CREATE_PASS) \
1845 if (Name == NAME) \
1846 return true;
1847#define MACHINE_FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, \
1848 PARAMS) \
1849 if (PassBuilder::checkParametrizedPassName(Name, NAME)) \
1850 return true;
1851
1852#define MACHINE_FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
1853 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
1854 return true;
1855
1856#include "llvm/Passes/MachinePassRegistry.def"
1857
1858 return callbacksAcceptPassName<MachineFunctionPassManager>(Name, Callbacks);
1859}
1860
1861template <typename CallbacksT>
1862static bool isLoopNestPassName(StringRef Name, CallbacksT &Callbacks,
1863 bool &UseMemorySSA) {
1864 UseMemorySSA = false;
1865
1866 if (PassBuilder::checkParametrizedPassName(Name, PassName: "lnicm")) {
1867 UseMemorySSA = true;
1868 return true;
1869 }
1870
1871#define LOOPNEST_PASS(NAME, CREATE_PASS) \
1872 if (Name == NAME) \
1873 return true;
1874#include "PassRegistry.def"
1875
1876 return callbacksAcceptPassName<LoopPassManager>(Name, Callbacks);
1877}
1878
1879template <typename CallbacksT>
1880static bool isLoopPassName(StringRef Name, CallbacksT &Callbacks,
1881 bool &UseMemorySSA) {
1882 UseMemorySSA = false;
1883
1884 if (PassBuilder::checkParametrizedPassName(Name, PassName: "licm")) {
1885 UseMemorySSA = true;
1886 return true;
1887 }
1888
1889#define LOOP_PASS(NAME, CREATE_PASS) \
1890 if (Name == NAME) \
1891 return true;
1892#define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
1893 if (PassBuilder::checkParametrizedPassName(Name, NAME)) \
1894 return true;
1895#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
1896 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
1897 return true;
1898#include "PassRegistry.def"
1899
1900 return callbacksAcceptPassName<LoopPassManager>(Name, Callbacks);
1901}
1902
1903std::optional<std::vector<PassBuilder::PipelineElement>>
1904PassBuilder::parsePipelineText(StringRef Text) {
1905 std::vector<PipelineElement> ResultPipeline;
1906
1907 SmallVector<std::vector<PipelineElement> *, 4> PipelineStack = {
1908 &ResultPipeline};
1909 for (;;) {
1910 std::vector<PipelineElement> &Pipeline = *PipelineStack.back();
1911 size_t Pos = Text.find_first_of(Chars: ",()");
1912 Pipeline.push_back(x: {.Name: Text.substr(Start: 0, N: Pos), .InnerPipeline: {}});
1913
1914 // If we have a single terminating name, we're done.
1915 if (Pos == Text.npos)
1916 break;
1917
1918 char Sep = Text[Pos];
1919 Text = Text.substr(Start: Pos + 1);
1920 if (Sep == ',')
1921 // Just a name ending in a comma, continue.
1922 continue;
1923
1924 if (Sep == '(') {
1925 // Push the inner pipeline onto the stack to continue processing.
1926 PipelineStack.push_back(Elt: &Pipeline.back().InnerPipeline);
1927 continue;
1928 }
1929
1930 assert(Sep == ')' && "Bogus separator!");
1931 // When handling the close parenthesis, we greedily consume them to avoid
1932 // empty strings in the pipeline.
1933 do {
1934 // If we try to pop the outer pipeline we have unbalanced parentheses.
1935 if (PipelineStack.size() == 1)
1936 return std::nullopt;
1937
1938 PipelineStack.pop_back();
1939 } while (Text.consume_front(Prefix: ")"));
1940
1941 // Check if we've finished parsing.
1942 if (Text.empty())
1943 break;
1944
1945 // Otherwise, the end of an inner pipeline always has to be followed by
1946 // a comma, and then we can continue.
1947 if (!Text.consume_front(Prefix: ","))
1948 return std::nullopt;
1949 }
1950
1951 if (PipelineStack.size() > 1)
1952 // Unbalanced paretheses.
1953 return std::nullopt;
1954
1955 assert(PipelineStack.back() == &ResultPipeline &&
1956 "Wrong pipeline at the bottom of the stack!");
1957 return {std::move(ResultPipeline)};
1958}
1959
1960static void setupOptionsForPipelineAlias(PipelineTuningOptions &PTO,
1961 OptimizationLevel L) {
1962 // This is consistent with old pass manager invoked via opt, but
1963 // inconsistent with clang. Clang doesn't enable loop vectorization
1964 // but does enable slp vectorization at Oz.
1965 PTO.LoopVectorization = L.getSpeedupLevel() > 1 && L != OptimizationLevel::Oz;
1966 PTO.SLPVectorization = L.getSpeedupLevel() > 1 && L != OptimizationLevel::Oz;
1967}
1968
1969Error PassBuilder::parseModulePass(ModulePassManager &MPM,
1970 const PipelineElement &E) {
1971 auto &Name = E.Name;
1972 auto &InnerPipeline = E.InnerPipeline;
1973
1974 // First handle complex passes like the pass managers which carry pipelines.
1975 if (!InnerPipeline.empty()) {
1976 if (Name == "module") {
1977 ModulePassManager NestedMPM;
1978 if (auto Err = parseModulePassPipeline(MPM&: NestedMPM, Pipeline: InnerPipeline))
1979 return Err;
1980 MPM.addPass(Pass: std::move(NestedMPM));
1981 return Error::success();
1982 }
1983 if (Name == "coro-cond") {
1984 ModulePassManager NestedMPM;
1985 if (auto Err = parseModulePassPipeline(MPM&: NestedMPM, Pipeline: InnerPipeline))
1986 return Err;
1987 MPM.addPass(Pass: CoroConditionalWrapper(std::move(NestedMPM)));
1988 return Error::success();
1989 }
1990 if (Name == "cgscc") {
1991 CGSCCPassManager CGPM;
1992 if (auto Err = parseCGSCCPassPipeline(CGPM, Pipeline: InnerPipeline))
1993 return Err;
1994 MPM.addPass(Pass: createModuleToPostOrderCGSCCPassAdaptor(Pass: std::move(CGPM)));
1995 return Error::success();
1996 }
1997 if (auto Params = parseFunctionPipelineName(Name)) {
1998 if (Params->second)
1999 return make_error<StringError>(
2000 Args: "cannot have a no-rerun module to function adaptor",
2001 Args: inconvertibleErrorCode());
2002 FunctionPassManager FPM;
2003 if (auto Err = parseFunctionPassPipeline(FPM, Pipeline: InnerPipeline))
2004 return Err;
2005 MPM.addPass(
2006 Pass: createModuleToFunctionPassAdaptor(Pass: std::move(FPM), EagerlyInvalidate: Params->first));
2007 return Error::success();
2008 }
2009
2010 for (auto &C : ModulePipelineParsingCallbacks)
2011 if (C(Name, MPM, InnerPipeline))
2012 return Error::success();
2013
2014 // Normal passes can't have pipelines.
2015 return make_error<StringError>(
2016 Args: formatv(Fmt: "invalid use of '{}' pass as module pipeline", Vals: Name).str(),
2017 Args: inconvertibleErrorCode());
2018 ;
2019 }
2020
2021 // Finally expand the basic registered passes from the .inc file.
2022#define MODULE_PASS(NAME, CREATE_PASS) \
2023 if (Name == NAME) { \
2024 MPM.addPass(CREATE_PASS); \
2025 return Error::success(); \
2026 }
2027#define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2028 if (checkParametrizedPassName(Name, NAME)) { \
2029 auto Params = parsePassParameters(PARSER, Name, NAME); \
2030 if (!Params) \
2031 return Params.takeError(); \
2032 MPM.addPass(CREATE_PASS(Params.get())); \
2033 return Error::success(); \
2034 }
2035#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
2036 if (Name == "require<" NAME ">") { \
2037 MPM.addPass( \
2038 RequireAnalysisPass< \
2039 std::remove_reference_t<decltype(CREATE_PASS)>, Module>()); \
2040 return Error::success(); \
2041 } \
2042 if (Name == "invalidate<" NAME ">") { \
2043 MPM.addPass(InvalidateAnalysisPass< \
2044 std::remove_reference_t<decltype(CREATE_PASS)>>()); \
2045 return Error::success(); \
2046 }
2047#define CGSCC_PASS(NAME, CREATE_PASS) \
2048 if (Name == NAME) { \
2049 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(CREATE_PASS)); \
2050 return Error::success(); \
2051 }
2052#define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2053 if (checkParametrizedPassName(Name, NAME)) { \
2054 auto Params = parsePassParameters(PARSER, Name, NAME); \
2055 if (!Params) \
2056 return Params.takeError(); \
2057 MPM.addPass( \
2058 createModuleToPostOrderCGSCCPassAdaptor(CREATE_PASS(Params.get()))); \
2059 return Error::success(); \
2060 }
2061#define FUNCTION_PASS(NAME, CREATE_PASS) \
2062 if (Name == NAME) { \
2063 if constexpr (std::is_constructible_v< \
2064 std::remove_reference_t<decltype(CREATE_PASS)>, \
2065 const TargetMachine &>) { \
2066 if (!TM) \
2067 return make_error<StringError>( \
2068 formatv("pass '{0}' requires TargetMachine", Name).str(), \
2069 inconvertibleErrorCode()); \
2070 } \
2071 MPM.addPass(createModuleToFunctionPassAdaptor(CREATE_PASS)); \
2072 return Error::success(); \
2073 }
2074#define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2075 if (checkParametrizedPassName(Name, NAME)) { \
2076 auto Params = parsePassParameters(PARSER, Name, NAME); \
2077 if (!Params) \
2078 return Params.takeError(); \
2079 auto CreatePass = CREATE_PASS; \
2080 if constexpr (std::is_constructible_v< \
2081 std::remove_reference_t<decltype(CreatePass( \
2082 Params.get()))>, \
2083 const TargetMachine &, \
2084 std::remove_reference_t<decltype(Params.get())>>) { \
2085 if (!TM) { \
2086 return make_error<StringError>( \
2087 formatv("pass '{0}' requires TargetMachine", Name).str(), \
2088 inconvertibleErrorCode()); \
2089 } \
2090 } \
2091 MPM.addPass(createModuleToFunctionPassAdaptor(CREATE_PASS(Params.get()))); \
2092 return Error::success(); \
2093 }
2094#define LOOPNEST_PASS(NAME, CREATE_PASS) \
2095 if (Name == NAME) { \
2096 MPM.addPass(createModuleToFunctionPassAdaptor( \
2097 createFunctionToLoopPassAdaptor(CREATE_PASS, false))); \
2098 return Error::success(); \
2099 }
2100#define LOOP_PASS(NAME, CREATE_PASS) \
2101 if (Name == NAME) { \
2102 MPM.addPass(createModuleToFunctionPassAdaptor( \
2103 createFunctionToLoopPassAdaptor(CREATE_PASS, false))); \
2104 return Error::success(); \
2105 }
2106#define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2107 if (checkParametrizedPassName(Name, NAME)) { \
2108 auto Params = parsePassParameters(PARSER, Name, NAME); \
2109 if (!Params) \
2110 return Params.takeError(); \
2111 MPM.addPass(createModuleToFunctionPassAdaptor( \
2112 createFunctionToLoopPassAdaptor(CREATE_PASS(Params.get()), false))); \
2113 return Error::success(); \
2114 }
2115#include "PassRegistry.def"
2116
2117 for (auto &C : ModulePipelineParsingCallbacks)
2118 if (C(Name, MPM, InnerPipeline))
2119 return Error::success();
2120 return make_error<StringError>(
2121 Args: formatv(Fmt: "unknown module pass '{}'", Vals: Name).str(),
2122 Args: inconvertibleErrorCode());
2123}
2124
2125Error PassBuilder::parseCGSCCPass(CGSCCPassManager &CGPM,
2126 const PipelineElement &E) {
2127 auto &Name = E.Name;
2128 auto &InnerPipeline = E.InnerPipeline;
2129
2130 // First handle complex passes like the pass managers which carry pipelines.
2131 if (!InnerPipeline.empty()) {
2132 if (Name == "cgscc") {
2133 CGSCCPassManager NestedCGPM;
2134 if (auto Err = parseCGSCCPassPipeline(CGPM&: NestedCGPM, Pipeline: InnerPipeline))
2135 return Err;
2136 // Add the nested pass manager with the appropriate adaptor.
2137 CGPM.addPass(Pass: std::move(NestedCGPM));
2138 return Error::success();
2139 }
2140 if (auto Params = parseFunctionPipelineName(Name)) {
2141 FunctionPassManager FPM;
2142 if (auto Err = parseFunctionPassPipeline(FPM, Pipeline: InnerPipeline))
2143 return Err;
2144 // Add the nested pass manager with the appropriate adaptor.
2145 CGPM.addPass(Pass: createCGSCCToFunctionPassAdaptor(
2146 Pass: std::move(FPM), EagerlyInvalidate: Params->first, NoRerun: Params->second));
2147 return Error::success();
2148 }
2149 if (auto MaxRepetitions = parseDevirtPassName(Name)) {
2150 CGSCCPassManager NestedCGPM;
2151 if (auto Err = parseCGSCCPassPipeline(CGPM&: NestedCGPM, Pipeline: InnerPipeline))
2152 return Err;
2153 CGPM.addPass(
2154 Pass: createDevirtSCCRepeatedPass(Pass: std::move(NestedCGPM), MaxIterations: *MaxRepetitions));
2155 return Error::success();
2156 }
2157
2158 for (auto &C : CGSCCPipelineParsingCallbacks)
2159 if (C(Name, CGPM, InnerPipeline))
2160 return Error::success();
2161
2162 // Normal passes can't have pipelines.
2163 return make_error<StringError>(
2164 Args: formatv(Fmt: "invalid use of '{}' pass as cgscc pipeline", Vals: Name).str(),
2165 Args: inconvertibleErrorCode());
2166 }
2167
2168// Now expand the basic registered passes from the .inc file.
2169#define CGSCC_PASS(NAME, CREATE_PASS) \
2170 if (Name == NAME) { \
2171 CGPM.addPass(CREATE_PASS); \
2172 return Error::success(); \
2173 }
2174#define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2175 if (checkParametrizedPassName(Name, NAME)) { \
2176 auto Params = parsePassParameters(PARSER, Name, NAME); \
2177 if (!Params) \
2178 return Params.takeError(); \
2179 CGPM.addPass(CREATE_PASS(Params.get())); \
2180 return Error::success(); \
2181 }
2182#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
2183 if (Name == "require<" NAME ">") { \
2184 CGPM.addPass(RequireAnalysisPass< \
2185 std::remove_reference_t<decltype(CREATE_PASS)>, \
2186 LazyCallGraph::SCC, CGSCCAnalysisManager, LazyCallGraph &, \
2187 CGSCCUpdateResult &>()); \
2188 return Error::success(); \
2189 } \
2190 if (Name == "invalidate<" NAME ">") { \
2191 CGPM.addPass(InvalidateAnalysisPass< \
2192 std::remove_reference_t<decltype(CREATE_PASS)>>()); \
2193 return Error::success(); \
2194 }
2195#define FUNCTION_PASS(NAME, CREATE_PASS) \
2196 if (Name == NAME) { \
2197 if constexpr (std::is_constructible_v< \
2198 std::remove_reference_t<decltype(CREATE_PASS)>, \
2199 const TargetMachine &>) { \
2200 if (!TM) \
2201 return make_error<StringError>( \
2202 formatv("pass '{0}' requires TargetMachine", Name).str(), \
2203 inconvertibleErrorCode()); \
2204 } \
2205 CGPM.addPass(createCGSCCToFunctionPassAdaptor(CREATE_PASS)); \
2206 return Error::success(); \
2207 }
2208#define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2209 if (checkParametrizedPassName(Name, NAME)) { \
2210 auto Params = parsePassParameters(PARSER, Name, NAME); \
2211 if (!Params) \
2212 return Params.takeError(); \
2213 auto CreatePass = CREATE_PASS; \
2214 if constexpr (std::is_constructible_v< \
2215 std::remove_reference_t<decltype(CreatePass( \
2216 Params.get()))>, \
2217 const TargetMachine &, \
2218 std::remove_reference_t<decltype(Params.get())>>) { \
2219 if (!TM) { \
2220 return make_error<StringError>( \
2221 formatv("pass '{0}' requires TargetMachine", Name).str(), \
2222 inconvertibleErrorCode()); \
2223 } \
2224 } \
2225 CGPM.addPass(createCGSCCToFunctionPassAdaptor(CREATE_PASS(Params.get()))); \
2226 return Error::success(); \
2227 }
2228#define LOOPNEST_PASS(NAME, CREATE_PASS) \
2229 if (Name == NAME) { \
2230 CGPM.addPass(createCGSCCToFunctionPassAdaptor( \
2231 createFunctionToLoopPassAdaptor(CREATE_PASS, false))); \
2232 return Error::success(); \
2233 }
2234#define LOOP_PASS(NAME, CREATE_PASS) \
2235 if (Name == NAME) { \
2236 CGPM.addPass(createCGSCCToFunctionPassAdaptor( \
2237 createFunctionToLoopPassAdaptor(CREATE_PASS, false))); \
2238 return Error::success(); \
2239 }
2240#define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2241 if (checkParametrizedPassName(Name, NAME)) { \
2242 auto Params = parsePassParameters(PARSER, Name, NAME); \
2243 if (!Params) \
2244 return Params.takeError(); \
2245 CGPM.addPass(createCGSCCToFunctionPassAdaptor( \
2246 createFunctionToLoopPassAdaptor(CREATE_PASS(Params.get()), false))); \
2247 return Error::success(); \
2248 }
2249#include "PassRegistry.def"
2250
2251 for (auto &C : CGSCCPipelineParsingCallbacks)
2252 if (C(Name, CGPM, InnerPipeline))
2253 return Error::success();
2254 return make_error<StringError>(Args: formatv(Fmt: "unknown cgscc pass '{}'", Vals: Name).str(),
2255 Args: inconvertibleErrorCode());
2256}
2257
2258Error PassBuilder::parseFunctionPass(FunctionPassManager &FPM,
2259 const PipelineElement &E) {
2260 auto &Name = E.Name;
2261 auto &InnerPipeline = E.InnerPipeline;
2262
2263 // First handle complex passes like the pass managers which carry pipelines.
2264 if (!InnerPipeline.empty()) {
2265 if (Name == "function") {
2266 FunctionPassManager NestedFPM;
2267 if (auto Err = parseFunctionPassPipeline(FPM&: NestedFPM, Pipeline: InnerPipeline))
2268 return Err;
2269 // Add the nested pass manager with the appropriate adaptor.
2270 FPM.addPass(Pass: std::move(NestedFPM));
2271 return Error::success();
2272 }
2273 if (Name == "loop" || Name == "loop-mssa") {
2274 LoopPassManager LPM;
2275 if (auto Err = parseLoopPassPipeline(LPM, Pipeline: InnerPipeline))
2276 return Err;
2277 // Add the nested pass manager with the appropriate adaptor.
2278 bool UseMemorySSA = (Name == "loop-mssa");
2279 FPM.addPass(
2280 Pass: createFunctionToLoopPassAdaptor(LPM: std::move(LPM), UseMemorySSA));
2281 return Error::success();
2282 }
2283 if (Name == "machine-function") {
2284 MachineFunctionPassManager MFPM;
2285 if (auto Err = parseMachinePassPipeline(MFPM, Pipeline: InnerPipeline))
2286 return Err;
2287 FPM.addPass(Pass: createFunctionToMachineFunctionPassAdaptor(Pass: std::move(MFPM)));
2288 return Error::success();
2289 }
2290
2291 for (auto &C : FunctionPipelineParsingCallbacks)
2292 if (C(Name, FPM, InnerPipeline))
2293 return Error::success();
2294
2295 // Normal passes can't have pipelines.
2296 return make_error<StringError>(
2297 Args: formatv(Fmt: "invalid use of '{}' pass as function pipeline", Vals: Name).str(),
2298 Args: inconvertibleErrorCode());
2299 }
2300
2301// Now expand the basic registered passes from the .inc file.
2302#define FUNCTION_PASS(NAME, CREATE_PASS) \
2303 if (Name == NAME) { \
2304 if constexpr (std::is_constructible_v< \
2305 std::remove_reference_t<decltype(CREATE_PASS)>, \
2306 const TargetMachine &>) { \
2307 if (!TM) \
2308 return make_error<StringError>( \
2309 formatv("pass '{0}' requires TargetMachine", Name).str(), \
2310 inconvertibleErrorCode()); \
2311 } \
2312 FPM.addPass(CREATE_PASS); \
2313 return Error::success(); \
2314 }
2315#define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2316 if (checkParametrizedPassName(Name, NAME)) { \
2317 auto Params = parsePassParameters(PARSER, Name, NAME); \
2318 if (!Params) \
2319 return Params.takeError(); \
2320 auto CreatePass = CREATE_PASS; \
2321 if constexpr (std::is_constructible_v< \
2322 std::remove_reference_t<decltype(CreatePass( \
2323 Params.get()))>, \
2324 const TargetMachine &, \
2325 std::remove_reference_t<decltype(Params.get())>>) { \
2326 if (!TM) { \
2327 return make_error<StringError>( \
2328 formatv("pass '{0}' requires TargetMachine", Name).str(), \
2329 inconvertibleErrorCode()); \
2330 } \
2331 } \
2332 FPM.addPass(CREATE_PASS(Params.get())); \
2333 return Error::success(); \
2334 }
2335#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
2336 if (Name == "require<" NAME ">") { \
2337 if constexpr (std::is_constructible_v< \
2338 std::remove_reference_t<decltype(CREATE_PASS)>, \
2339 const TargetMachine &>) { \
2340 if (!TM) \
2341 return make_error<StringError>( \
2342 formatv("pass '{0}' requires TargetMachine", Name).str(), \
2343 inconvertibleErrorCode()); \
2344 } \
2345 FPM.addPass( \
2346 RequireAnalysisPass<std::remove_reference_t<decltype(CREATE_PASS)>, \
2347 Function>()); \
2348 return Error::success(); \
2349 } \
2350 if (Name == "invalidate<" NAME ">") { \
2351 FPM.addPass(InvalidateAnalysisPass< \
2352 std::remove_reference_t<decltype(CREATE_PASS)>>()); \
2353 return Error::success(); \
2354 }
2355// FIXME: UseMemorySSA is set to false. Maybe we could do things like:
2356// bool UseMemorySSA = !("canon-freeze" || "loop-predication" ||
2357// "guard-widening");
2358// The risk is that it may become obsolete if we're not careful.
2359#define LOOPNEST_PASS(NAME, CREATE_PASS) \
2360 if (Name == NAME) { \
2361 FPM.addPass(createFunctionToLoopPassAdaptor(CREATE_PASS, false)); \
2362 return Error::success(); \
2363 }
2364#define LOOP_PASS(NAME, CREATE_PASS) \
2365 if (Name == NAME) { \
2366 FPM.addPass(createFunctionToLoopPassAdaptor(CREATE_PASS, false)); \
2367 return Error::success(); \
2368 }
2369#define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2370 if (checkParametrizedPassName(Name, NAME)) { \
2371 auto Params = parsePassParameters(PARSER, Name, NAME); \
2372 if (!Params) \
2373 return Params.takeError(); \
2374 FPM.addPass( \
2375 createFunctionToLoopPassAdaptor(CREATE_PASS(Params.get()), false)); \
2376 return Error::success(); \
2377 }
2378#include "PassRegistry.def"
2379
2380 for (auto &C : FunctionPipelineParsingCallbacks)
2381 if (C(Name, FPM, InnerPipeline))
2382 return Error::success();
2383 return make_error<StringError>(
2384 Args: formatv(Fmt: "unknown function pass '{}'", Vals: Name).str(),
2385 Args: inconvertibleErrorCode());
2386}
2387
2388Error PassBuilder::parseLoopPass(LoopPassManager &LPM,
2389 const PipelineElement &E) {
2390 StringRef Name = E.Name;
2391 auto &InnerPipeline = E.InnerPipeline;
2392
2393 // First handle complex passes like the pass managers which carry pipelines.
2394 if (!InnerPipeline.empty()) {
2395 if (Name == "loop") {
2396 LoopPassManager NestedLPM;
2397 if (auto Err = parseLoopPassPipeline(LPM&: NestedLPM, Pipeline: InnerPipeline))
2398 return Err;
2399 // Add the nested pass manager with the appropriate adaptor.
2400 LPM.addPass(Pass: std::move(NestedLPM));
2401 return Error::success();
2402 }
2403
2404 for (auto &C : LoopPipelineParsingCallbacks)
2405 if (C(Name, LPM, InnerPipeline))
2406 return Error::success();
2407
2408 // Normal passes can't have pipelines.
2409 return make_error<StringError>(
2410 Args: formatv(Fmt: "invalid use of '{}' pass as loop pipeline", Vals&: Name).str(),
2411 Args: inconvertibleErrorCode());
2412 }
2413
2414// Now expand the basic registered passes from the .inc file.
2415#define LOOPNEST_PASS(NAME, CREATE_PASS) \
2416 if (Name == NAME) { \
2417 LPM.addPass(CREATE_PASS); \
2418 return Error::success(); \
2419 }
2420#define LOOP_PASS(NAME, CREATE_PASS) \
2421 if (Name == NAME) { \
2422 LPM.addPass(CREATE_PASS); \
2423 return Error::success(); \
2424 }
2425#define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2426 if (checkParametrizedPassName(Name, NAME)) { \
2427 auto Params = parsePassParameters(PARSER, Name, NAME); \
2428 if (!Params) \
2429 return Params.takeError(); \
2430 LPM.addPass(CREATE_PASS(Params.get())); \
2431 return Error::success(); \
2432 }
2433#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
2434 if (Name == "require<" NAME ">") { \
2435 LPM.addPass(RequireAnalysisPass< \
2436 std::remove_reference_t<decltype(CREATE_PASS)>, Loop, \
2437 LoopAnalysisManager, LoopStandardAnalysisResults &, \
2438 LPMUpdater &>()); \
2439 return Error::success(); \
2440 } \
2441 if (Name == "invalidate<" NAME ">") { \
2442 LPM.addPass(InvalidateAnalysisPass< \
2443 std::remove_reference_t<decltype(CREATE_PASS)>>()); \
2444 return Error::success(); \
2445 }
2446#include "PassRegistry.def"
2447
2448 for (auto &C : LoopPipelineParsingCallbacks)
2449 if (C(Name, LPM, InnerPipeline))
2450 return Error::success();
2451 return make_error<StringError>(Args: formatv(Fmt: "unknown loop pass '{}'", Vals&: Name).str(),
2452 Args: inconvertibleErrorCode());
2453}
2454
2455Error PassBuilder::parseMachinePass(MachineFunctionPassManager &MFPM,
2456 const PipelineElement &E) {
2457 StringRef Name = E.Name;
2458 // Handle any nested pass managers.
2459 if (!E.InnerPipeline.empty()) {
2460 if (E.Name == "machine-function") {
2461 MachineFunctionPassManager NestedPM;
2462 if (auto Err = parseMachinePassPipeline(MFPM&: NestedPM, Pipeline: E.InnerPipeline))
2463 return Err;
2464 MFPM.addPass(Pass: std::move(NestedPM));
2465 return Error::success();
2466 }
2467 return make_error<StringError>(Args: "invalid pipeline",
2468 Args: inconvertibleErrorCode());
2469 }
2470
2471#define MACHINE_MODULE_PASS(NAME, CREATE_PASS) \
2472 if (Name == NAME) { \
2473 MFPM.addPass(CREATE_PASS); \
2474 return Error::success(); \
2475 }
2476#define MACHINE_FUNCTION_PASS(NAME, CREATE_PASS) \
2477 if (Name == NAME) { \
2478 MFPM.addPass(CREATE_PASS); \
2479 return Error::success(); \
2480 }
2481#define MACHINE_FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, \
2482 PARAMS) \
2483 if (checkParametrizedPassName(Name, NAME)) { \
2484 auto Params = parsePassParameters(PARSER, Name, NAME); \
2485 if (!Params) \
2486 return Params.takeError(); \
2487 MFPM.addPass(CREATE_PASS(Params.get())); \
2488 return Error::success(); \
2489 }
2490#define MACHINE_FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
2491 if (Name == "require<" NAME ">") { \
2492 MFPM.addPass( \
2493 RequireAnalysisPass<std::remove_reference_t<decltype(CREATE_PASS)>, \
2494 MachineFunction>()); \
2495 return Error::success(); \
2496 } \
2497 if (Name == "invalidate<" NAME ">") { \
2498 MFPM.addPass(InvalidateAnalysisPass< \
2499 std::remove_reference_t<decltype(CREATE_PASS)>>()); \
2500 return Error::success(); \
2501 }
2502#include "llvm/Passes/MachinePassRegistry.def"
2503
2504 for (auto &C : MachineFunctionPipelineParsingCallbacks)
2505 if (C(Name, MFPM, E.InnerPipeline))
2506 return Error::success();
2507 return make_error<StringError>(
2508 Args: formatv(Fmt: "unknown machine pass '{}'", Vals&: Name).str(),
2509 Args: inconvertibleErrorCode());
2510}
2511
2512bool PassBuilder::parseAAPassName(AAManager &AA, StringRef Name) {
2513#define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
2514 if (Name == NAME) { \
2515 AA.registerModuleAnalysis< \
2516 std::remove_reference_t<decltype(CREATE_PASS)>>(); \
2517 return true; \
2518 }
2519#define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
2520 if (Name == NAME) { \
2521 AA.registerFunctionAnalysis< \
2522 std::remove_reference_t<decltype(CREATE_PASS)>>(); \
2523 return true; \
2524 }
2525#include "PassRegistry.def"
2526
2527 for (auto &C : AAParsingCallbacks)
2528 if (C(Name, AA))
2529 return true;
2530 return false;
2531}
2532
2533Error PassBuilder::parseMachinePassPipeline(
2534 MachineFunctionPassManager &MFPM, ArrayRef<PipelineElement> Pipeline) {
2535 for (const auto &Element : Pipeline) {
2536 if (auto Err = parseMachinePass(MFPM, E: Element))
2537 return Err;
2538 }
2539 return Error::success();
2540}
2541
2542Error PassBuilder::parseLoopPassPipeline(LoopPassManager &LPM,
2543 ArrayRef<PipelineElement> Pipeline) {
2544 for (const auto &Element : Pipeline) {
2545 if (auto Err = parseLoopPass(LPM, E: Element))
2546 return Err;
2547 }
2548 return Error::success();
2549}
2550
2551Error PassBuilder::parseFunctionPassPipeline(
2552 FunctionPassManager &FPM, ArrayRef<PipelineElement> Pipeline) {
2553 for (const auto &Element : Pipeline) {
2554 if (auto Err = parseFunctionPass(FPM, E: Element))
2555 return Err;
2556 }
2557 return Error::success();
2558}
2559
2560Error PassBuilder::parseCGSCCPassPipeline(CGSCCPassManager &CGPM,
2561 ArrayRef<PipelineElement> Pipeline) {
2562 for (const auto &Element : Pipeline) {
2563 if (auto Err = parseCGSCCPass(CGPM, E: Element))
2564 return Err;
2565 }
2566 return Error::success();
2567}
2568
2569void PassBuilder::crossRegisterProxies(LoopAnalysisManager &LAM,
2570 FunctionAnalysisManager &FAM,
2571 CGSCCAnalysisManager &CGAM,
2572 ModuleAnalysisManager &MAM,
2573 MachineFunctionAnalysisManager *MFAM) {
2574 MAM.registerPass(PassBuilder: [&] { return FunctionAnalysisManagerModuleProxy(FAM); });
2575 MAM.registerPass(PassBuilder: [&] { return CGSCCAnalysisManagerModuleProxy(CGAM); });
2576 CGAM.registerPass(PassBuilder: [&] { return ModuleAnalysisManagerCGSCCProxy(MAM); });
2577 FAM.registerPass(PassBuilder: [&] { return CGSCCAnalysisManagerFunctionProxy(CGAM); });
2578 FAM.registerPass(PassBuilder: [&] { return ModuleAnalysisManagerFunctionProxy(MAM); });
2579 FAM.registerPass(PassBuilder: [&] { return LoopAnalysisManagerFunctionProxy(LAM); });
2580 LAM.registerPass(PassBuilder: [&] { return FunctionAnalysisManagerLoopProxy(FAM); });
2581 if (MFAM) {
2582 MAM.registerPass(
2583 PassBuilder: [&] { return MachineFunctionAnalysisManagerModuleProxy(*MFAM); });
2584 FAM.registerPass(
2585 PassBuilder: [&] { return MachineFunctionAnalysisManagerFunctionProxy(*MFAM); });
2586 MFAM->registerPass(
2587 PassBuilder: [&] { return ModuleAnalysisManagerMachineFunctionProxy(MAM); });
2588 MFAM->registerPass(
2589 PassBuilder: [&] { return FunctionAnalysisManagerMachineFunctionProxy(FAM); });
2590 }
2591}
2592
2593Error PassBuilder::parseModulePassPipeline(ModulePassManager &MPM,
2594 ArrayRef<PipelineElement> Pipeline) {
2595 for (const auto &Element : Pipeline) {
2596 if (auto Err = parseModulePass(MPM, E: Element))
2597 return Err;
2598 }
2599 return Error::success();
2600}
2601
2602// Primary pass pipeline description parsing routine for a \c ModulePassManager
2603// FIXME: Should this routine accept a TargetMachine or require the caller to
2604// pre-populate the analysis managers with target-specific stuff?
2605Error PassBuilder::parsePassPipeline(ModulePassManager &MPM,
2606 StringRef PipelineText) {
2607 auto Pipeline = parsePipelineText(Text: PipelineText);
2608 if (!Pipeline || Pipeline->empty())
2609 return make_error<StringError>(
2610 Args: formatv(Fmt: "invalid pipeline '{}'", Vals&: PipelineText).str(),
2611 Args: inconvertibleErrorCode());
2612
2613 // If the first name isn't at the module layer, wrap the pipeline up
2614 // automatically.
2615 StringRef FirstName = Pipeline->front().Name;
2616
2617 if (!isModulePassName(Name: FirstName, Callbacks&: ModulePipelineParsingCallbacks)) {
2618 bool UseMemorySSA;
2619 if (isCGSCCPassName(Name: FirstName, Callbacks&: CGSCCPipelineParsingCallbacks)) {
2620 Pipeline = {{.Name: "cgscc", .InnerPipeline: std::move(*Pipeline)}};
2621 } else if (isFunctionPassName(Name: FirstName,
2622 Callbacks&: FunctionPipelineParsingCallbacks)) {
2623 Pipeline = {{.Name: "function", .InnerPipeline: std::move(*Pipeline)}};
2624 } else if (isLoopNestPassName(Name: FirstName, Callbacks&: LoopPipelineParsingCallbacks,
2625 UseMemorySSA)) {
2626 Pipeline = {{.Name: "function", .InnerPipeline: {{.Name: UseMemorySSA ? "loop-mssa" : "loop",
2627 .InnerPipeline: std::move(*Pipeline)}}}};
2628 } else if (isLoopPassName(Name: FirstName, Callbacks&: LoopPipelineParsingCallbacks,
2629 UseMemorySSA)) {
2630 Pipeline = {{.Name: "function", .InnerPipeline: {{.Name: UseMemorySSA ? "loop-mssa" : "loop",
2631 .InnerPipeline: std::move(*Pipeline)}}}};
2632 } else if (isMachineFunctionPassName(
2633 Name: FirstName, Callbacks&: MachineFunctionPipelineParsingCallbacks)) {
2634 Pipeline = {{.Name: "function", .InnerPipeline: {{.Name: "machine-function", .InnerPipeline: std::move(*Pipeline)}}}};
2635 } else {
2636 for (auto &C : TopLevelPipelineParsingCallbacks)
2637 if (C(MPM, *Pipeline))
2638 return Error::success();
2639
2640 // Unknown pass or pipeline name!
2641 auto &InnerPipeline = Pipeline->front().InnerPipeline;
2642 return make_error<StringError>(
2643 Args: formatv(Fmt: "unknown {} name '{}'",
2644 Vals: (InnerPipeline.empty() ? "pass" : "pipeline"), Vals&: FirstName)
2645 .str(),
2646 Args: inconvertibleErrorCode());
2647 }
2648 }
2649
2650 if (auto Err = parseModulePassPipeline(MPM, Pipeline: *Pipeline))
2651 return Err;
2652 return Error::success();
2653}
2654
2655// Primary pass pipeline description parsing routine for a \c CGSCCPassManager
2656Error PassBuilder::parsePassPipeline(CGSCCPassManager &CGPM,
2657 StringRef PipelineText) {
2658 auto Pipeline = parsePipelineText(Text: PipelineText);
2659 if (!Pipeline || Pipeline->empty())
2660 return make_error<StringError>(
2661 Args: formatv(Fmt: "invalid pipeline '{}'", Vals&: PipelineText).str(),
2662 Args: inconvertibleErrorCode());
2663
2664 StringRef FirstName = Pipeline->front().Name;
2665 if (!isCGSCCPassName(Name: FirstName, Callbacks&: CGSCCPipelineParsingCallbacks))
2666 return make_error<StringError>(
2667 Args: formatv(Fmt: "unknown cgscc pass '{}' in pipeline '{}'", Vals&: FirstName,
2668 Vals&: PipelineText)
2669 .str(),
2670 Args: inconvertibleErrorCode());
2671
2672 if (auto Err = parseCGSCCPassPipeline(CGPM, Pipeline: *Pipeline))
2673 return Err;
2674 return Error::success();
2675}
2676
2677// Primary pass pipeline description parsing routine for a \c
2678// FunctionPassManager
2679Error PassBuilder::parsePassPipeline(FunctionPassManager &FPM,
2680 StringRef PipelineText) {
2681 auto Pipeline = parsePipelineText(Text: PipelineText);
2682 if (!Pipeline || Pipeline->empty())
2683 return make_error<StringError>(
2684 Args: formatv(Fmt: "invalid pipeline '{}'", Vals&: PipelineText).str(),
2685 Args: inconvertibleErrorCode());
2686
2687 StringRef FirstName = Pipeline->front().Name;
2688 if (!isFunctionPassName(Name: FirstName, Callbacks&: FunctionPipelineParsingCallbacks))
2689 return make_error<StringError>(
2690 Args: formatv(Fmt: "unknown function pass '{}' in pipeline '{}'", Vals&: FirstName,
2691 Vals&: PipelineText)
2692 .str(),
2693 Args: inconvertibleErrorCode());
2694
2695 if (auto Err = parseFunctionPassPipeline(FPM, Pipeline: *Pipeline))
2696 return Err;
2697 return Error::success();
2698}
2699
2700// Primary pass pipeline description parsing routine for a \c LoopPassManager
2701Error PassBuilder::parsePassPipeline(LoopPassManager &CGPM,
2702 StringRef PipelineText) {
2703 auto Pipeline = parsePipelineText(Text: PipelineText);
2704 if (!Pipeline || Pipeline->empty())
2705 return make_error<StringError>(
2706 Args: formatv(Fmt: "invalid pipeline '{}'", Vals&: PipelineText).str(),
2707 Args: inconvertibleErrorCode());
2708
2709 if (auto Err = parseLoopPassPipeline(LPM&: CGPM, Pipeline: *Pipeline))
2710 return Err;
2711
2712 return Error::success();
2713}
2714
2715Error PassBuilder::parsePassPipeline(MachineFunctionPassManager &MFPM,
2716 StringRef PipelineText) {
2717 auto Pipeline = parsePipelineText(Text: PipelineText);
2718 if (!Pipeline || Pipeline->empty())
2719 return make_error<StringError>(
2720 Args: formatv(Fmt: "invalid machine pass pipeline '{}'", Vals&: PipelineText).str(),
2721 Args: inconvertibleErrorCode());
2722
2723 if (auto Err = parseMachinePassPipeline(MFPM, Pipeline: *Pipeline))
2724 return Err;
2725
2726 return Error::success();
2727}
2728
2729Error PassBuilder::parseAAPipeline(AAManager &AA, StringRef PipelineText) {
2730 // If the pipeline just consists of the word 'default' just replace the AA
2731 // manager with our default one.
2732 if (PipelineText == "default") {
2733 AA = buildDefaultAAPipeline();
2734 return Error::success();
2735 }
2736
2737 while (!PipelineText.empty()) {
2738 StringRef Name;
2739 std::tie(args&: Name, args&: PipelineText) = PipelineText.split(Separator: ',');
2740 if (!parseAAPassName(AA, Name))
2741 return make_error<StringError>(
2742 Args: formatv(Fmt: "unknown alias analysis name '{}'", Vals&: Name).str(),
2743 Args: inconvertibleErrorCode());
2744 }
2745
2746 return Error::success();
2747}
2748
2749std::optional<RegAllocFilterFunc>
2750PassBuilder::parseRegAllocFilter(StringRef FilterName) {
2751 if (FilterName == "all")
2752 return nullptr;
2753 for (auto &C : RegClassFilterParsingCallbacks)
2754 if (auto F = C(FilterName))
2755 return F;
2756 return std::nullopt;
2757}
2758
2759static void printPassName(StringRef PassName, raw_ostream &OS) {
2760 OS << " " << PassName << "\n";
2761}
2762static void printPassName(StringRef PassName, StringRef Params,
2763 raw_ostream &OS) {
2764 OS << " " << PassName << "<" << Params << ">\n";
2765}
2766
2767void PassBuilder::printPassNames(raw_ostream &OS) {
2768 // TODO: print pass descriptions when they are available
2769
2770 OS << "Module passes:\n";
2771#define MODULE_PASS(NAME, CREATE_PASS) printPassName(NAME, OS);
2772#include "PassRegistry.def"
2773
2774 OS << "Module passes with params:\n";
2775#define MODULE_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2776 printPassName(NAME, PARAMS, OS);
2777#include "PassRegistry.def"
2778
2779 OS << "Module analyses:\n";
2780#define MODULE_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS);
2781#include "PassRegistry.def"
2782
2783 OS << "Module alias analyses:\n";
2784#define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS);
2785#include "PassRegistry.def"
2786
2787 OS << "CGSCC passes:\n";
2788#define CGSCC_PASS(NAME, CREATE_PASS) printPassName(NAME, OS);
2789#include "PassRegistry.def"
2790
2791 OS << "CGSCC passes with params:\n";
2792#define CGSCC_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2793 printPassName(NAME, PARAMS, OS);
2794#include "PassRegistry.def"
2795
2796 OS << "CGSCC analyses:\n";
2797#define CGSCC_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS);
2798#include "PassRegistry.def"
2799
2800 OS << "Function passes:\n";
2801#define FUNCTION_PASS(NAME, CREATE_PASS) printPassName(NAME, OS);
2802#include "PassRegistry.def"
2803
2804 OS << "Function passes with params:\n";
2805#define FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2806 printPassName(NAME, PARAMS, OS);
2807#include "PassRegistry.def"
2808
2809 OS << "Function analyses:\n";
2810#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS);
2811#include "PassRegistry.def"
2812
2813 OS << "Function alias analyses:\n";
2814#define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS);
2815#include "PassRegistry.def"
2816
2817 OS << "LoopNest passes:\n";
2818#define LOOPNEST_PASS(NAME, CREATE_PASS) printPassName(NAME, OS);
2819#include "PassRegistry.def"
2820
2821 OS << "Loop passes:\n";
2822#define LOOP_PASS(NAME, CREATE_PASS) printPassName(NAME, OS);
2823#include "PassRegistry.def"
2824
2825 OS << "Loop passes with params:\n";
2826#define LOOP_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER, PARAMS) \
2827 printPassName(NAME, PARAMS, OS);
2828#include "PassRegistry.def"
2829
2830 OS << "Loop analyses:\n";
2831#define LOOP_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS);
2832#include "PassRegistry.def"
2833
2834 OS << "Machine module passes (WIP):\n";
2835#define MACHINE_MODULE_PASS(NAME, CREATE_PASS) printPassName(NAME, OS);
2836#include "llvm/Passes/MachinePassRegistry.def"
2837
2838 OS << "Machine function passes (WIP):\n";
2839#define MACHINE_FUNCTION_PASS(NAME, CREATE_PASS) printPassName(NAME, OS);
2840#include "llvm/Passes/MachinePassRegistry.def"
2841
2842 OS << "Machine function analyses (WIP):\n";
2843#define MACHINE_FUNCTION_ANALYSIS(NAME, CREATE_PASS) printPassName(NAME, OS);
2844#include "llvm/Passes/MachinePassRegistry.def"
2845}
2846
2847void PassBuilder::registerParseTopLevelPipelineCallback(
2848 const std::function<bool(ModulePassManager &, ArrayRef<PipelineElement>)>
2849 &C) {
2850 TopLevelPipelineParsingCallbacks.push_back(Elt: C);
2851}
2852