A CRTP mix‐in for passes that should not be skipped.

Synopsis

Declared in <llvm/IR/PassManager.h>

template<typename DerivedT>
struct RequiredPassInfoMixin;

Member Functions

Name

Description

printPipeline

Print this pass as a single name in a textual pipeline.

Static Member Functions

Name

Description

isRequired

Return true; required passes cannot be skipped.

Derived Classes

Name

Description

AddDiscriminatorsPass

Pass that adds DWARF path discriminators to the IR.

AddressSanitizerPass

Public interface to the address sanitizer module pass for instrumenting code to check for various memory errors.

AliasSetsPrinterPass

Printer pass for AliasSetTracker results.

AllocTokenPass

A module pass that rewrites heap allocations to use token‐enabled allocation functions based on various source‐level properties.

AlwaysInlinerPass

Inlines functions marked as "always_inline".

AnnotationRemarksPass

A pass that emits optimization remarks for instructions with !annotation.

AssignGUIDPass

Module pass that assigns a globally unique identifier to every global value.

AssumptionPrinterPass

Printer pass for the AssumptionAnalysis results.

AtomicExpandPass

New PM pass that expands atomic instructions for the target.

BitcodeWriterPass

Pass for writing a module of IR out to a bitcode file.

BlockFrequencyPrinterPass

Printer pass for the BlockFrequencyInfo results.

BoundsCheckingPass

A pass to instrument code and perform run‐time bounds checking on loads, stores, and other memory intrinsics.

BranchProbabilityPrinterPass

Printer pass for the BranchProbabilityAnalysis results.

BranchRelaxationPass

New PM pass that relaxes out‐of‐range machine branches.

CFGOnlyPrinterPass

Pass that writes a function CFG to a DOT file without block bodies.

CFGOnlyViewerPass

Pass that displays a function CFG in a Graphviz viewer without block bodies.

CFGPrinterPass

Pass that writes a function CFG to a DOT file.

CFGSCCPrinterPass

Printer pass for strongly connected components of a function CFG.

CFGViewerPass

Pass that displays a function CFG in a Graphviz viewer.

CFIFixupPass

New PM pass that inserts CFI remember/restore instructions.

CFIInstrInserterPass

New PM pass that inserts correcting CFI instructions.

CGSCCToFunctionPassAdaptor

Adaptor that maps from a SCC to its functions.

CallGraphDOTPrinterPass

Pass for printing the call graph to a dot file

CallGraphPrinterPass

Printer pass for the CallGraphAnalysis results.

CallGraphSCCsPrinterPass

Printer pass for the summarized CallGraphAnalysis results.

CallGraphViewerPass

Pass for viewing the call graph

CheckDebugMachineModulePass

New PM pass that checks Machine IR debug info after mir‐debugify.

CopyProfPass

Early‐stage pass that instruments special member functions to call into the CopyProf runtime.

CopyProfStoresPass

Late‐stage pass that instruments store instructions to detect whether an object copy has been modified before it is destructed.

CoroCleanupPass

Pass that lowers all remaining coroutine intrinsics.

CoroConditionalWrapper

Module pass that runs nested passes only when the module declares coroutine intrinsics.

CoroEarlyPass

Pass that lowers early coroutine intrinsics.

CoroElidePass

Pass that replaces dynamic coroutine frame allocation with alloca.

CoroSplitPass

Pass that builds the coroutine frame and outlines resume and destroy functions.

CostModelPrinterPass

Printer pass for cost modeling results.

CtxProfAnalysisPrinterPass

Printer pass for the CtxProfAnalysis results.

CycleInfoPrinterPass

Printer pass for the CycleInfo.

CycleInfoVerifierPass

Verifier pass for the CycleInfo.

DDGAnalysisPrinterPass

Textual printer pass for the DDG of a loop.

DDGDotPrinterPass

Pass that writes the data‐dependence graph of a loop as DOT.

DOTGraphTraitsPrinter

Pass mixin that writes an analysis graph for a function to a DOT file.

DOTGraphTraitsViewer

Pass mixin that displays an analysis graph for a function in a viewer.

DXILMetadataAnalysisPrinterPass

Printer pass for the DXILMetadataAnalysis results.

DXILResourcePrinterPass

Printer pass for the DXILResourceAnalysis results.

DataFlowSanitizerPass

Module pass that instruments code for dynamic data‐flow analysis (DFSan).

DebugAssignmentTrackingPrinterPass

Printer pass for DebugAssignmentTrackingAnalysis results.

DelinearizationPrinterPass

Printer pass that delinearizes memory accesses in a function.

DemandedBitsPrinterPass

Printer pass for DemandedBits

DependenceAnalysisPrinterPass

Printer pass to dump DA results.

DetectDeadLanesPass

Pass that detects dead and undefined subregister lanes in a machine function.

DominanceFrontierPrinterPass

Printer pass for the DominanceFrontier.

DominatorTreePrinterPass

Printer pass for the DominatorTree.

DominatorTreeVerifierPass

Verifier pass for the DominatorTree.

DropTypeTestsPass

Pass that drops type‐test intrinsics and related uses.

DwarfEHPreparePass

New PM pass that prepares DWARF exception handling for code generation.

EHContGuardTargetsPass

New PM pass that records Windows EH Continuation Guard targets.

EmbedBitcodePass

Pass embeds a copy of the module optimized with the provided pass pipeline into a global variable.

EntryExitInstrumenterPass

Pass that instruments function entry and exit with profiling hooks.

ExpandIRInstsPass

New PM pass that expands certain IR instructions for the target.

ExpandPostRAPseudosPass

New PM pass that expands post‐RA pseudo instructions.

ExpandReductionsPass

New PM pass that expands reduction intrinsics for the target.

ExpandVariadicsPass

Pass that expands variadic functions into fixed‐arity equivalents.

ExtraFunctionPassManager

A pass manager that runs extra function passes when a marker analysis is present.

ExtraLoopPassManager

A pass manager that runs extra loop passes when a marker analysis is present.

FEntryInserterPass

New PM pass that inserts fentry calls into function prologues.

FatLtoCleanup

Pass that cleans up IR for the FatLTO pipeline.

FinalizeBundleTestPass

New PM test pass that finalizes a bundle for each basic block.

FinalizeISelPass

New PM pass that finalizes ISel and expands pseudo‐instructions.

FixIrreduciblePass

Pass that converts irreducible control‐flow into natural loops.

FreeMachineFunctionPass

Pass that explicitly frees the MachineFunction for a function.

FuncletLayoutPass

New PM pass that lays out funclets contiguously.

FunctionPropertiesPrinterPass

Printer pass for the FunctionPropertiesAnalysis results.

FunctionPropertiesStatisticsPass

Statistics pass for the FunctionPropertiesAnalysis results.

FunctionToLoopPassAdaptor

Adaptor that maps from a function to its loops.

FunctionToMachineFunctionPassAdaptor

Trivial adaptor that maps from a function to its machine function.

GCLoweringPass

Pass that lowers GC read/write intrinsics and initializes roots.

GISelValueTrackingPrinterPass

Printer pass for GISelValueTracking analysis results.

HWAddressSanitizerPass

This is a public interface to the hardware address sanitizer.

HashRecognizePrinterPass

Printer pass for the HashRecognize analysis.

HipStdParAcceleratorCodeSelectionPass

Pass that keeps only functions reachable from HIPSTDPAR kernels.

HipStdParAllocationInterpositionPass

Pass that redirects allocations to accelerator‐accessible runtime APIs.

HipStdParMathFixupPass

Pass that rewrites math calls through the HIPSTDPAR forwarding layer.

IR2VecPrinterPass

This pass prints the IR2Vec embeddings for instructions, basic blocks, and functions.

IR2VecVocabPrinterPass

This pass prints the embeddings in the vocabulary

IRTranslatorPass

New PM pass that translates LLVM IR into MachineInstr for GlobalISel.

IVUsersPrinterPass

Printer pass for the IVUsers for a loop.

IndirectBrExpandPass

New PM pass that expands indirectbr instructions into switches.

InitUndefPass

New PM pass that initializes undef values with temporary pseudos.

InlineAdvisorAnalysisPrinterPass

Printer pass for the InlineAdvisorAnalysis results.

InlineAsmPreparePass

New PM pass that prepares inline asm for SelectionDAG codegen.

InlineCostAnnotationPrinterPass

Pass that prints per‐instruction inline cost annotations for debugging.

InstCountPass

Pass that counts instructions and reports them as statistics.

InstructionSelectPass

New PM pass that selects generic machine instructions to target instructions.

InstrumentorPass

The Instrumentor pass.

InvalidateAnalysisPass

A no‐op pass template which simply forces a specific analysis result to be invalidated.

JMCInstrumenterPass

New PM pass that instruments functions for Just My Code debugging.

KCFIPass

A pass that emits generic KCFI indirect call checks for targets that do not lower KCFI operand bundles in the back‐end.

KernelInfoPrinter

Pass that emits optimization remarks about GPU kernel function properties.

LazyCallGraphDOTPrinterPass

A pass which prints the call graph as a DOT file to a raw_ostream.

LazyCallGraphPrinterPass

A pass which prints the call graph to a raw_ostream.

LazyValueInfoPrinterPass

Printer pass for the LazyValueAnalysis results.

LegalizerPass

New PM pass that legalizes generic machine instructions for GlobalISel.

LintPass

Function pass that lints IR for undefined or unintended behavior.

LiveDebugValuesPass

New PM pass that extends variable debug locations across basic blocks.

LiveDebugVariablesPrinterPass

Printer pass for the LiveDebugVariablesAnalysis results.

LiveIntervalsPrinterPass

Printer pass for the LiveIntervalsAnalysis results.

LiveStacksPrinterPass

Printer pass for the LiveStacksAnalysis results.

LiveVariablesPrinterPass

Printer pass for the LiveVariablesAnalysis results.

LoadStoreOptPass

New PM pass that merges consecutive GlobalISel loads and stores.

LocalStackSlotAllocationPass

New PM pass that pre‐allocates local frame indices to stack slots.

LocalizerPass

New PM pass that localizes constant‐like instructions near their uses.

LoopAccessInfoPrinterPass

Printer pass for the LoopAccessInfo results.

LoopCachePrinterPass

Printer pass for the CacheCost results.

LoopNestPrinterPass

Printer pass for the LoopNest results.

LoopPrinterPass

Printer pass for the LoopAnalysis results.

LoopVerifierPass

Verifier pass for the LoopAnalysis results.

LowerAllowCheckPass

Pass that lowers allow‐check intrinsics to remove optional traps from hot code.

LowerAtomicPass

A pass that lowers atomic intrinsic into non‐atomic intrinsics.

LowerCommentStringPass

Pass that lowers loadtime comment string metadata for supported targets.

LowerEmuTLSPass

New PM pass that adds __emutls_[vt].* variables for emulated TLS.

LowerInvokePass

Pass that converts invoke instructions to call instructions.

LowerMatrixIntrinsicsPass

Pass that lowers matrix intrinsics to vector operations.

LowerSwitchPass

Pass that rewrites switch instructions as a sequence of branches.

LowerTypeTestsPass

Pass that lowers type metadata and type‐test intrinsics.

MachineBlockFrequencyPrinterPass

Printer pass for the MachineBlockFrequencyInfo results.

MachineBlockHashInfoPrinterPass

Printer pass for the MachineBlockHashInfoAnalysis results.

MachineBlockPlacementStatsPass

New PM pass that collects statistics about basic block placement.

MachineBranchProbabilityPrinterPass

Printer pass for the MachineBranchProbabilityAnalysis results.

MachineCFGPrinterPass

Pass that writes a machine function CFG to a DOT file.

MachineCombinerPass

New PM pass that combines machine instructions to shorten critical paths.

MachineCycleInfoPrinterPass

Printer pass for the MachineCycleAnalysis results.

MachineDominatorTreePrinterPass

Machine function pass which print MachineDominatorTree.

MachineKCFIPass

New PM pass that implements kernel control‐flow integrity.

MachineLoopPrinterPass

Printer pass for the LoopAnalysis results.

MachinePostDominatorTreePrinterPass

Machine function pass which prints MachinePostDominatorTree.

MachineRegionInfoPrinterPass

Printer pass for the MachineRegionInfo analysis results.

MachineSanitizerBinaryMetadataPass

New PM pass that finalizes sanitizer binary metadata for a machine function.

MachineTraceMetricsVerifierPass

Verifier pass for MachineTraceMetrics.

MachineUniformityPrinterPass

Printer pass for the MachineUniformityAnalysis results.

MachineVerifierPass

New PM pass that verifies the integrity of machine code.

MemDerefPrinterPass

Printer pass for whether values are known dereferenceable pointers.

MemProfilerPass

Public interface to the memory profiler pass for instrumenting code to profile memory accesses.

MemorySSAPrinterPass

Printer pass for MemorySSA.

MemorySSAVerifierPass

Verifier pass for MemorySSA.

MemorySSAWalkerPrinterPass

Printer pass for MemorySSA via the walker.

MemorySanitizerPass

A module pass for msan instrumentation.

ModuleCopyProfPass

Module‐level pass that inserts the CopyProf runtime initialization constructor and hooks it into llvm.global_ctors.

ModuleDebugInfoPrinterPass

Printer pass for module‐level debug info metadata.

ModuleMemProfilerPass

Public interface to the memory profiler module pass for instrumenting code to profile memory allocations and accesses.

ModuleThreadSanitizerPass

A module pass for tsan instrumentation.

ModuleToFunctionPassAdaptor

Trivial adaptor that maps from a module to its functions.

ModuleToPostOrderCGSCCPassAdaptor

The core module pass which does a post‐order walk of the SCCs and runs a CGSCC pass over each one.

MustBeExecutedContextPrinterPass

Printer pass for must‐be‐executed contexts.

MustExecutePrinterPass

Printer pass for the must‐execute analysis.

NameAnonGlobalPass

Simple pass that provides a name to every anonymous globals.

NumericalStabilitySanitizerPass

A function pass for nsan instrumentation.

PHIEliminationPass

New PM pass that eliminates machine instruction PHI nodes by inserting copies.

PassManager

Manages and runs a sequence of passes over a particular unit of IR.

PassManager<MachineFunction>

PassManager<Loop, LoopAnalysisManager, LoopStandardAnalysisResults&, LPMUpdater&>

Specialized pass manager that runs a mixed pipeline of loop and loop‐nest passes over a loop nest.

PassManager<LazyCallGraph::SCC, CGSCCAnalysisManager, LazyCallGraph&, CGSCCUpdateResult&>

PatchableFunctionPass

New PM pass that inserts patchable prologue markers for the "patchable‐function" and "patchable‐function‐entry" attributes.

PhiValuesPrinterPass

A pass for printing the PhiValues for a function.

PhysicalRegisterUsageInfoPrinterPass

Printer pass for the PhysicalRegisterUsageAnalysis results.

PostDominatorTreePrinterPass

Printer pass for the PostDominatorTree.

PostRAHazardRecognizerPass

New PM pass that runs the post‐RA hazard recognizer and emits noops.

PreISelIntrinsicLoweringPass

Pass that lowers selected intrinsics before instruction selection.

PredicateInfoPrinterPass

Printer pass for PredicateInfo.

PredicateInfoVerifierPass

Verifier pass for PredicateInfo.

PrintFunctionPass

Pass (for the new pass manager) for printing a Function as LLVM's text IR assembly.

PrintLoopPass

Pass for printing a loop's contents as textual IR.

PrintMIRPass

Pass that prints a machine function in the MIR serialization format.

PrintMIRPreparePass

Pass that prints LLVM IR of a module in the MIR serialization format.

PrintModulePass

Pass (for the new pass manager) for printing a Module as LLVM's text IR assembly.

ProcessImplicitDefsPass

New PM pass that processes IMPLICIT_DEF instructions.

ProfileSummaryPrinterPass

Printer pass that uses ProfileSummaryAnalysis.

PrologEpilogInserterPass

New PM pass that inserts function prologs and epilogs.

ReachingDefPrinterPass

Printer pass for the ReachingDefInfo results.

RealtimeSanitizerPass

Create ctor and init functions.

RegAllocFastPass

New PM pass that performs fast (local) register allocation.

RegBankSelectPass

New PM pass that assigns register banks to generic virtual registers.

RegUsageInfoCollectorPass

New PM pass that collects physical register usage for IPRA.

RegUsageInfoPropagationPass

New PM pass that propagates callee register usage masks onto call sites.

RegionInfoPrinterPass

Printer pass for the RegionInfo.

RegionInfoVerifierPass

Verifier pass for the RegionInfo.

RegisterCoalescerPass

New PM pass that coalesces copy‐related virtual registers.

RemoveRedundantDebugValuesPass

New PM pass that removes redundant DBG_VALUE instructions.

RenameIndependentSubregsPass

New PM pass that renames independently used subregisters.

ReplaceWithVeclib

New PM pass that replaces vector intrinsics with vector‐library calls.

RequireAnalysisPass

A utility pass template to force an analysis result to be available.

RequireAnalysisPass<AnalysisT, LazyCallGraph::SCC, CGSCCAnalysisManager, LazyCallGraph&, CGSCCUpdateResult&>

An explicit specialization of the require analysis template pass.

SCEVDivisionPrinterPass

Printer pass that shows SCEVDivision results for signed divides in a function.

SafeStackPass

New PM pass that splits the stack into a safe stack and an unsafe stack.

SafepointIRVerifierPass

Create an instance of the safepoint verifier pass which can be added to a pass pipeline to check for relocation bugs.

SanitizerBinaryMetadataPass

The pass should be inserted after optimizations.

SanitizerCoveragePass

Module pass that instruments functions for SanitizerCoverage.

ScalarEvolutionPrinterPass

Printer pass for the ScalarEvolutionAnalysis results.

ScalarEvolutionVerifierPass

Verifier pass for the ScalarEvolutionAnalysis results.

ScalarizeMaskedMemIntrinPass

Pass that scalarizes masked memory intrinsics unsupported by the target.

SelectionDAGISelPass

New pass‐manager wrapper that runs SelectionDAG instruction selection.

ShadowStackGCLoweringPass

New PM pass that implements the custom lowering used by the shadow stack GC.

SjLjEHPreparePass

New PM pass that prepares setjmp/longjmp exception handling for code generation.

SlotIndexesPrinterPass

Printer pass for the SlotIndexes analysis.

StackColoringPass

New PM pass that merges disjoint stack slots to reduce frame size.

StackFrameLayoutAnalysisPass

New PM pass that dumps the stack frame layout via remarks.

StackLifetimePrinterPass

Printer pass for testing.

StackProtectorPass

New PM pass that inserts stack protectors into functions that need them.

StackSafetyGlobalPrinterPass

Printer pass for the StackSafetyGlobalAnalysis results.

StackSafetyPrinterPass

Printer pass for the StackSafetyAnalysis results.

StripDebugMachineModulePass

New PM pass that strips debug info from Machine IR in a module.

StructuralHashPrinterPass

Printer pass for StructuralHashes

StructurizeCFGPass

Pass that transforms regions into structured control flow.

ThinLTOBitcodeWriterPass

Pass that prepares a module for ThinLTO and writes bitcode.

ThreadSanitizerPass

A function pass for tsan instrumentation.

TwoAddressInstructionPass

New PM pass that rewrites two‐address instructions to use tied operands.

TypeSanitizerPass

A module pass for tysan instrumentation.

UniformityInfoPrinterPass

Printer pass for the UniformityInfo.

UnifyLoopExitsPass

Pass that redirects each natural loop's exiting edges through one block.

UnpackMachineBundlesPass

New PM pass that unpacks machine instruction bundles.

UnreachableBlockElimPass

New PM pass that deletes IR basic blocks unreachable from the entry node.

UnreachableMachineBlockElimPass

New PM pass that deletes machine basic blocks unreachable from the entry.

VerifierPass

New pass manager pass that verifies IR and optionally aborts on failure.

VirtRegMapPrinterPass

Printer pass for the VirtRegMapAnalysis results.

VirtRegRewriterPass

Pass that rewrites virtual registers to physical registers via VirtRegMap.

WasmEHPreparePass

New PM pass that prepares WebAssembly exception handling for code generation.

WinEHPreparePass

New PM pass that prepares Windows exception handling for code generation.

XRayInstrumentationPass

New PM pass that inserts XRay instrumentation into machine functions.

Created with MrDocs