LLVM: llvm::PassBuilder Class Reference (original) (raw)

This class provides access to building LLVM's passes. More...

#include "[llvm/Passes/PassBuilder.h](llvm%5F2Passes%5F2PassBuilder%5F8h%5Fsource.html)"

Public Member Functions
LLVM_ABI PassBuilder (TargetMachine *TM=nullptr, PipelineTuningOptions PTO=PipelineTuningOptions(), std::optional< PGOOptions > PGOOpt=std::nullopt, PassInstrumentationCallbacks *PIC=nullptr, IntrusiveRefCntPtr< vfs::FileSystem > FS=vfs::getRealFileSystem())
LLVM_ABI void crossRegisterProxies (LoopAnalysisManager &LAM, FunctionAnalysisManager &FAM, CGSCCAnalysisManager &CGAM, ModuleAnalysisManager &MAM, MachineFunctionAnalysisManager *MFAM=nullptr)
Cross register the analysis managers through their proxies.
LLVM_ABI void registerModuleAnalyses (ModuleAnalysisManager &MAM)
Registers all available module analysis passes.
LLVM_ABI void registerCGSCCAnalyses (CGSCCAnalysisManager &CGAM)
Registers all available CGSCC analysis passes.
LLVM_ABI void registerFunctionAnalyses (FunctionAnalysisManager &FAM)
Registers all available function analysis passes.
LLVM_ABI void registerLoopAnalyses (LoopAnalysisManager &LAM)
Registers all available loop analysis passes.
LLVM_ABI void registerMachineFunctionAnalyses (MachineFunctionAnalysisManager &MFAM)
Registers all available machine function analysis passes.
LLVM_ABI FunctionPassManager buildFunctionSimplificationPipeline (OptimizationLevel Level, ThinOrFullLTOPhase Phase)
Construct the core LLVM function canonicalization and simplification pipeline.
LLVM_ABI ModulePassManager buildModuleSimplificationPipeline (OptimizationLevel Level, ThinOrFullLTOPhase Phase)
Construct the core LLVM module canonicalization and simplification pipeline.
LLVM_ABI ModuleInlinerWrapperPass buildInlinerPipeline (OptimizationLevel Level, ThinOrFullLTOPhase Phase)
Construct the module pipeline that performs inlining as well as the inlining-driven cleanups.
LLVM_ABI ModulePassManager buildModuleInlinerPipeline (OptimizationLevel Level, ThinOrFullLTOPhase Phase)
Construct the module pipeline that performs inlining with module inliner pass.
LLVM_ABI ModulePassManager buildModuleOptimizationPipeline (OptimizationLevel Level, ThinOrFullLTOPhase LTOPhase)
Construct the core LLVM module optimization pipeline.
LLVM_ABI ModulePassManager buildPerModuleDefaultPipeline (OptimizationLevel Level, ThinOrFullLTOPhase Phase=ThinOrFullLTOPhase::None)
Build a per-module default optimization pipeline.
LLVM_ABI ModulePassManager buildFatLTODefaultPipeline (OptimizationLevel Level, bool ThinLTO, bool EmitSummary)
Build a fat object default optimization pipeline.
LLVM_ABI ModulePassManager buildThinLTOPreLinkDefaultPipeline (OptimizationLevel Level)
Build a pre-link, ThinLTO-targeting default optimization pipeline to a pass manager.
LLVM_ABI ModulePassManager buildThinLTODefaultPipeline (OptimizationLevel Level, const ModuleSummaryIndex *ImportSummary)
Build a ThinLTO default optimization pipeline to a pass manager.
LLVM_ABI ModulePassManager buildLTOPreLinkDefaultPipeline (OptimizationLevel Level)
Build a pre-link, LTO-targeting default optimization pipeline to a pass manager.
LLVM_ABI ModulePassManager buildLTODefaultPipeline (OptimizationLevel Level, ModuleSummaryIndex *ExportSummary)
Build an LTO default optimization pipeline to a pass manager.
LLVM_ABI ModulePassManager buildO0DefaultPipeline (OptimizationLevel Level, ThinOrFullLTOPhase Phase=ThinOrFullLTOPhase::None)
Build an O0 pipeline with the minimal semantically required passes.
LLVM_ABI AAManager buildDefaultAAPipeline ()
Build the default AAManager with the default alias analysis pipeline registered.
LLVM_ABI Error parsePassPipeline (ModulePassManager &MPM, StringRef PipelineText)
Parse a textual pass pipeline description into a ModulePassManager.
LLVM_ABI Error parsePassPipeline (CGSCCPassManager &CGPM, StringRef PipelineText)
{{@ Parse a textual pass pipeline description into a specific PassManager
LLVM_ABI Error parsePassPipeline (FunctionPassManager &FPM, StringRef PipelineText)
LLVM_ABI Error parsePassPipeline (LoopPassManager &LPM, StringRef PipelineText)
LLVM_ABI Error parsePassPipeline (MachineFunctionPassManager &MFPM, StringRef PipelineText)
Parse a textual MIR pipeline into the provided MachineFunctionPass manager.
LLVM_ABI Error parseAAPipeline (AAManager &AA, StringRef PipelineText)
Parse a textual alias analysis pipeline into the provided AA manager.
LLVM_ABI std::optional< RegAllocFilterFunc > parseRegAllocFilter (StringRef RegAllocFilterName)
Parse RegAllocFilterName to get RegAllocFilterFunc.
LLVM_ABI void printPassNames (raw_ostream &OS)
Print pass names.
void registerPeepholeEPCallback (const std::function< void(FunctionPassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerLateLoopOptimizationsEPCallback (const std::function< void(LoopPassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerLoopOptimizerEndEPCallback (const std::function< void(LoopPassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerScalarOptimizerLateEPCallback (const std::function< void(FunctionPassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerCGSCCOptimizerLateEPCallback (const std::function< void(CGSCCPassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerVectorizerStartEPCallback (const std::function< void(FunctionPassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerVectorizerEndEPCallback (const std::function< void(FunctionPassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerPipelineStartEPCallback (const std::function< void(ModulePassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerPipelineEarlySimplificationEPCallback (const std::function< void(ModulePassManager &, OptimizationLevel, ThinOrFullLTOPhase)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerOptimizerEarlyEPCallback (const std::function< void(ModulePassManager &, OptimizationLevel, ThinOrFullLTOPhase Phase)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerOptimizerLastEPCallback (const std::function< void(ModulePassManager &, OptimizationLevel, ThinOrFullLTOPhase)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerFullLinkTimeOptimizationEarlyEPCallback (const std::function< void(ModulePassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerFullLinkTimeOptimizationLastEPCallback (const std::function< void(ModulePassManager &, OptimizationLevel)> &C)
Register a callback for a default optimizer pipeline extension point.
void registerParseAACallback (const std::function< bool(StringRef Name, AAManager &AA)> &C)
Register a callback for parsing an AliasAnalysis Name to populate the given AAManager AA.
void registerAnalysisRegistrationCallback (const std::function< void(CGSCCAnalysisManager &)> &C)
{{@ Register callbacks for analysis registration with this PassBuilder instance.
void registerAnalysisRegistrationCallback (const std::function< void(FunctionAnalysisManager &)> &C)
void registerAnalysisRegistrationCallback (const std::function< void(LoopAnalysisManager &)> &C)
void registerAnalysisRegistrationCallback (const std::function< void(ModuleAnalysisManager &)> &C)
void registerAnalysisRegistrationCallback (const std::function< void(MachineFunctionAnalysisManager &)> &C)
void registerPipelineParsingCallback (const std::function< bool(StringRef Name, CGSCCPassManager &, ArrayRef< PipelineElement >)> &C)
{{@ Register pipeline parsing callbacks with this pass builder instance.
void registerPipelineParsingCallback (const std::function< bool(StringRef Name, FunctionPassManager &, ArrayRef< PipelineElement >)> &C)
void registerPipelineParsingCallback (const std::function< bool(StringRef Name, LoopPassManager &, ArrayRef< PipelineElement >)> &C)
void registerPipelineParsingCallback (const std::function< bool(StringRef Name, ModulePassManager &, ArrayRef< PipelineElement >)> &C)
void registerPipelineParsingCallback (const std::function< bool(StringRef Name, MachineFunctionPassManager &, ArrayRef< PipelineElement >)> &C)
void registerRegClassFilterParsingCallback (const std::function< RegAllocFilterFunc(StringRef)> &C)
Register callbacks to parse target specific filter field if regalloc pass needs it.
LLVM_ABI void registerParseTopLevelPipelineCallback (const std::function< bool(ModulePassManager &, ArrayRef< PipelineElement >)> &C)
Register a callback for a top-level pipeline entry.
LLVM_ABI void addPGOInstrPassesForO0 (ModulePassManager &MPM, bool RunProfileGen, bool IsCS, bool AtomicCounterUpdate, std::string ProfileFile, std::string ProfileRemappingFile)
Add PGOInstrumenation passes for O0 only.
PassInstrumentationCallbacks * getPassInstrumentationCallbacks () const
Returns PIC.
IntrusiveRefCntPtr< vfs::FileSystem > getVirtualFileSystemPtr () const
Returns the virtual file system.
LLVM_ABI void invokePeepholeEPCallbacks (FunctionPassManager &FPM, OptimizationLevel Level)
LLVM_ABI void invokeLateLoopOptimizationsEPCallbacks (LoopPassManager &LPM, OptimizationLevel Level)
LLVM_ABI void invokeLoopOptimizerEndEPCallbacks (LoopPassManager &LPM, OptimizationLevel Level)
LLVM_ABI void invokeScalarOptimizerLateEPCallbacks (FunctionPassManager &FPM, OptimizationLevel Level)
LLVM_ABI void invokeCGSCCOptimizerLateEPCallbacks (CGSCCPassManager &CGPM, OptimizationLevel Level)
LLVM_ABI void invokeVectorizerStartEPCallbacks (FunctionPassManager &FPM, OptimizationLevel Level)
LLVM_ABI void invokeVectorizerEndEPCallbacks (FunctionPassManager &FPM, OptimizationLevel Level)
LLVM_ABI void invokeOptimizerEarlyEPCallbacks (ModulePassManager &MPM, OptimizationLevel Level, ThinOrFullLTOPhase Phase)
LLVM_ABI void invokeOptimizerLastEPCallbacks (ModulePassManager &MPM, OptimizationLevel Level, ThinOrFullLTOPhase Phase)
LLVM_ABI void invokeFullLinkTimeOptimizationEarlyEPCallbacks (ModulePassManager &MPM, OptimizationLevel Level)
LLVM_ABI void invokeFullLinkTimeOptimizationLastEPCallbacks (ModulePassManager &MPM, OptimizationLevel Level)
LLVM_ABI void invokePipelineStartEPCallbacks (ModulePassManager &MPM, OptimizationLevel Level)
LLVM_ABI void invokePipelineEarlySimplificationEPCallbacks (ModulePassManager &MPM, OptimizationLevel Level, ThinOrFullLTOPhase Phase)
Static Public Member Functions
static bool checkParametrizedPassName (StringRef Name, StringRef PassName)
template
static auto parsePassParameters (ParametersParseCallableT &&Parser, StringRef Name, StringRef PassName) -> decltype(Parser(StringRef{}))
This performs customized parsing of pass name with parameters.
static LLVM_ABI Expected< bool > parseSinglePassOption (StringRef Params, StringRef OptionName, StringRef PassName)
Handle passes only accept one bool-valued parameter.

This class provides access to building LLVM's passes.

Its members provide the baseline state available to passes during their construction. The PassRegistry.def file specifies how to construct all of the built-in passes, and those may reference these members during construction.

Definition at line 114 of file PassBuilder.h.

◆ addPGOInstrPassesForO0()

void PassBuilder::addPGOInstrPassesForO0 ( ModulePassManager & MPM,
bool RunProfileGen,
bool IsCS,
bool AtomicCounterUpdate,
std::string ProfileFile,
std::string ProfileRemappingFile )

◆ buildDefaultAAPipeline()

AAManager PassBuilder::buildDefaultAAPipeline ( )

◆ buildFatLTODefaultPipeline()

Build a fat object default optimization pipeline.

This builds a pipeline that runs the LTO/ThinLTO pre-link pipeline, and emits a section containing the pre-link bitcode along side the object code generated in non-LTO compilation.

Definition at line 1746 of file PassBuilderPipelines.cpp.

References addAnnotationRemarksPass(), llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), llvm::lowertypetests::All, buildLTOPreLinkDefaultPipeline(), buildModuleOptimizationPipeline(), buildThinLTODefaultPipeline(), buildThinLTOPreLinkDefaultPipeline(), llvm::createModuleToPostOrderCGSCCPassAdaptor(), llvm::None, llvm::OptimizationLevel::O0, and llvm::PGOOptions::SampleUse.

◆ buildFunctionSimplificationPipeline()

Construct the core LLVM function canonicalization and simplification pipeline.

This is a long pipeline and uses most of the per-function optimization passes in LLVM to canonicalize and simplify the IR. It is suitable to run repeatedly over the IR and is not expected to destroy important information about the semantics of the IR.

Note that Level cannot be O0 here. The pipelines produced are only intended for use when attempting to optimize code. If frontends require some transformations for semantic reasons, they should explicitly build them.

Phase indicates the current ThinLTO phase.

Definition at line 578 of file PassBuilderPipelines.cpp.

References llvm::ExtraLoopPassManager< MarkerTy >::addPass(), llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), llvm::AreStatisticsEnabled(), assert(), llvm::createFunctionToLoopPassAdaptor(), llvm::EnableConstraintElimination, llvm::EnableDFAJumpThreading, llvm::EnableGVNHoist, llvm::EnableGVNSink, llvm::EnableJumpTableToSwitch, llvm::EnableKnowledgeRetention, llvm::EnableLoopFlatten, llvm::EnableLoopHeaderDuplication, llvm::FullLTOPostLink, invokeLateLoopOptimizationsEPCallbacks(), invokeLoopOptimizerEndEPCallbacks(), invokePeepholeEPCallbacks(), invokeScalarOptimizerLateEPCallbacks(), llvm::PGOOptions::IRUse, isLTOPreLink(), llvm::ModifyCFG, llvm::OptimizationLevel::O0, llvm::OptimizationLevel::O3, llvm::OptimizationLevel::Oz, Phase, llvm::RunNewGVN, llvm::PGOOptions::SampleUse, llvm::ThinLTOPostLink, and llvm::ThinLTOPreLink.

Referenced by buildInlinerPipeline(), and buildModuleInlinerPipeline().

◆ buildInlinerPipeline()

Construct the module pipeline that performs inlining as well as the inlining-driven cleanups.

Definition at line 928 of file PassBuilderPipelines.cpp.

References llvm::ModuleInlinerWrapperPass::addModulePass(), llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), llvm::AttributorRun, buildFunctionSimplificationPipeline(), llvm::CGSCC, llvm::CGSCCInliner, llvm::createCGSCCToFunctionPassAdaptor(), llvm::createModuleToFunctionPassAdaptor(), llvm::InlineParams::EnableDeferral, llvm::EnableGlobalAnalyses, llvm::EnablePGOInlineDeferral, llvm::getInlineParams(), getInlineParamsFromOptLevel(), llvm::InlineParams::HotCallSiteThreshold, invokeCGSCCOptimizerLateEPCallbacks(), isLTOPreLink(), llvm::MaxDevirtIterations, llvm::OptimizationLevel::O0, llvm::OptimizationLevel::O2, llvm::OptimizationLevel::O3, llvm::PerformMandatoryInliningsFirst, Phase, llvm::PGOOptions::SampleUse, llvm::ThinLTOPreLink, and llvm::UseInlineAdvisor.

Referenced by buildModuleSimplificationPipeline().

◆ buildLTODefaultPipeline()

Build an LTO default optimization pipeline to a pass manager.

This provides a good default optimization pipeline for link-time optimization and code generation. It is particularly tuned to fit well when IR coming into the LTO phase was first run through buildLTOPreLinkDefaultPipeline, and the two coordinate closely.

Definition at line 1936 of file PassBuilderPipelines.cpp.

References addAnnotationRemarksPass(), llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), llvm::lowertypetests::Assume, buildCoroWrapper(), llvm::CGSCCInliner, llvm::createCGSCCToFunctionPassAdaptor(), llvm::createFunctionToLoopPassAdaptor(), llvm::createModuleToFunctionPassAdaptor(), llvm::createModuleToPostOrderCGSCCPassAdaptor(), llvm::PGOOptions::CSIRInstr, llvm::PGOOptions::CSIRUse, llvm::EnableConstraintElimination, llvm::EnableGlobalAnalyses, llvm::EnableHotColdSplit, llvm::EnableLoopFlatten, llvm::EnableMemProfContextDisambiguation, llvm::EnableModuleInliner, llvm::FullLTOPostLink, getInlineParamsFromOptLevel(), invokeFullLinkTimeOptimizationEarlyEPCallbacks(), invokeFullLinkTimeOptimizationLastEPCallbacks(), invokePeepholeEPCallbacks(), invokeVectorizerEndEPCallbacks(), invokeVectorizerStartEPCallbacks(), llvm::ModifyCFG, llvm::OptimizationLevel::O0, llvm::OptimizationLevel::O1, llvm::Optimize, llvm::OptimizationLevel::Os, llvm::OptimizationLevel::Oz, llvm::RunNewGVN, llvm::PGOOptions::SampleUse, llvm::UseInlineAdvisor, and llvm::ModuleSummaryIndex::withSupportsHotColdNew().

◆ buildLTOPreLinkDefaultPipeline()

◆ buildModuleInlinerPipeline()

Construct the module pipeline that performs inlining with module inliner pass.

Definition at line 1027 of file PassBuilderPipelines.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), buildFunctionSimplificationPipeline(), llvm::createModuleToFunctionPassAdaptor(), llvm::createModuleToPostOrderCGSCCPassAdaptor(), llvm::InlineParams::EnableDeferral, llvm::EnablePGOInlineDeferral, getInlineParamsFromOptLevel(), llvm::InlineParams::HotCallSiteThreshold, isLTOPreLink(), llvm::OptimizationLevel::O0, Phase, llvm::PGOOptions::SampleUse, llvm::ThinLTOPostLink, llvm::ThinLTOPreLink, llvm::UseCtxProfile, and llvm::UseInlineAdvisor.

Referenced by buildModuleSimplificationPipeline(), and buildThinLTODefaultPipeline().

◆ buildModuleOptimizationPipeline()

Construct the core LLVM module optimization pipeline.

This pipeline focuses on optimizing the execution speed of the IR. It uses cost modeling and thresholds to balance code growth against runtime improvements. It includes vectorization and other information destroying transformations. It also cannot generally be run repeatedly on a module without potentially seriously regressing either runtime performance of the code or serious code size growth.

Note that Level cannot be O0 here. The pipelines produced are only intended for use when attempting to optimize code. If frontends require some transformations for semantic reasons, they should explicitly build them.

Definition at line 1460 of file PassBuilderPipelines.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), llvm::lowertypetests::Assume, llvm::CGSCCInliner, llvm::createFunctionToLoopPassAdaptor(), llvm::createModuleToFunctionPassAdaptor(), llvm::PGOOptions::CSIRInstr, llvm::PGOOptions::CSIRUse, llvm::EnableCHR, llvm::EnableGlobalAnalyses, llvm::EnableHotColdSplit, llvm::EnableIROutliner, llvm::EnableLoopHeaderDuplication, llvm::EnableMatrix, llvm::EnableModuleInliner, getInlineParamsFromOptLevel(), invokeOptimizerEarlyEPCallbacks(), invokeOptimizerLastEPCallbacks(), invokeVectorizerEndEPCallbacks(), invokeVectorizerStartEPCallbacks(), isLTOPostLink(), isLTOPreLink(), llvm::None, llvm::OptimizationLevel::O3, llvm::OptimizationLevel::Oz, llvm::RunPartialInlining, llvm::UseInlineAdvisor, and llvm::UseLoopVersioningLICM.

Referenced by buildFatLTODefaultPipeline(), buildPerModuleDefaultPipeline(), and buildThinLTODefaultPipeline().

◆ buildModuleSimplificationPipeline()

Construct the core LLVM module canonicalization and simplification pipeline.

This pipeline focuses on canonicalizing and simplifying the entire module of IR. Much like the function simplification pipeline above, it is suitable to run repeatedly over the IR and is not expected to destroy important information. It does, however, perform inlining and other heuristic based simplifications that are not strictly reversible.

Note that Level cannot be O0 here. The pipelines produced are only intended for use when attempting to optimize code. If frontends require some transformations for semantic reasons, they should explicitly build them.

Phase indicates the current ThinLTO phase.

Definition at line 1075 of file PassBuilderPipelines.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), assert(), llvm::lowertypetests::Assume, llvm::AttributorRun, buildInlinerPipeline(), buildModuleInlinerPipeline(), llvm::createModuleToFunctionPassAdaptor(), llvm::PGOOptions::CSIRInstr, llvm::CTXPROF, llvm::EnableModuleInliner, llvm::EnableSampledInstr, llvm::FlattenedProfileUsed, llvm::FullLTOPostLink, llvm::InstrumentColdFuncOnlyPath, invokePeepholeEPCallbacks(), invokePipelineEarlySimplificationEPCallbacks(), llvm::PGOOptions::IRInstr, llvm::PGOOptions::IRUse, llvm::PGOCtxProfLoweringPass::isCtxIRPGOInstrEnabled(), isLTOPreLink(), llvm::ModifyCFG, llvm::MODULE, llvm::OptimizationLevel::O0, llvm::OptimizationLevel::O3, llvm::OptimizationLevel::Os, llvm::OptimizationLevel::Oz, llvm::PGOInstrumentColdFunctionOnly, Phase, llvm::PGOOptions::SampleUse, llvm::ThinLTOPostLink, llvm::ThinLTOPreLink, and llvm::UseCtxProfile.

Referenced by buildPerModuleDefaultPipeline(), buildThinLTODefaultPipeline(), and buildThinLTOPreLinkDefaultPipeline().

◆ buildO0DefaultPipeline()

Build an O0 pipeline with the minimal semantically required passes.

This should only be used for non-LTO and LTO pre-link pipelines.

Definition at line 2306 of file PassBuilderPipelines.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), addPGOInstrPassesForO0(), assert(), buildCoroWrapper(), llvm::createFunctionToLoopPassAdaptor(), llvm::createModuleToFunctionPassAdaptor(), llvm::createModuleToPostOrderCGSCCPassAdaptor(), llvm::EnableMatrix, invokeCGSCCOptimizerLateEPCallbacks(), invokeLateLoopOptimizationsEPCallbacks(), invokeLoopOptimizerEndEPCallbacks(), invokeOptimizerEarlyEPCallbacks(), invokeOptimizerLastEPCallbacks(), invokePipelineEarlySimplificationEPCallbacks(), invokePipelineStartEPCallbacks(), invokeScalarOptimizerLateEPCallbacks(), invokeVectorizerEndEPCallbacks(), invokeVectorizerStartEPCallbacks(), llvm::PGOOptions::IRInstr, llvm::PGOOptions::IRUse, llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::isEmpty(), isLTOPreLink(), llvm::None, llvm::OptimizationLevel::O0, Phase, and llvm::PGOOptions::SampleUse.

Referenced by buildPerModuleDefaultPipeline(), and buildThinLTOPreLinkDefaultPipeline().

◆ buildPerModuleDefaultPipeline()

Build a per-module default optimization pipeline.

This provides a good default optimization pipeline for per-module optimization and code generation without any link-time optimization. It typically correspond to frontend "-O[123]" options for optimization levels O1, O2 and O3 resp.

Definition at line 1698 of file PassBuilderPipelines.cpp.

References addAnnotationRemarksPass(), llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), assert(), buildModuleOptimizationPipeline(), buildModuleSimplificationPipeline(), buildO0DefaultPipeline(), llvm::createModuleToFunctionPassAdaptor(), invokePipelineStartEPCallbacks(), isLTOPreLink(), llvm::None, llvm::OptimizationLevel::O0, Phase, and llvm::PGOOptions::SampleUse.

Referenced by buildLTOPreLinkDefaultPipeline().

◆ buildThinLTODefaultPipeline()

Build a ThinLTO default optimization pipeline to a pass manager.

This provides a good default optimization pipeline for link-time optimization and code generation. It is particularly tuned to fit well when IR coming into the LTO phase was first run through buildThinLTOPreLinkDefaultPipeline, and the two coordinate closely.

Definition at line 1856 of file PassBuilderPipelines.cpp.

References addAnnotationRemarksPass(), llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), llvm::lowertypetests::Assume, buildCoroWrapper(), buildModuleInlinerPipeline(), buildModuleOptimizationPipeline(), buildModuleSimplificationPipeline(), llvm::EnableMemProfContextDisambiguation, llvm::OptimizationLevel::O0, llvm::PGOOptions::SampleUse, llvm::ThinLTOPostLink, llvm::UseCtxProfile, and llvm::ModuleSummaryIndex::withSupportsHotColdNew().

Referenced by buildFatLTODefaultPipeline().

◆ buildThinLTOPreLinkDefaultPipeline()

Build a pre-link, ThinLTO-targeting default optimization pipeline to a pass manager.

This adds the pre-link optimizations tuned to prepare a module for a ThinLTO run. It works to minimize the IR which needs to be analyzed without making irreversible decisions which could be made better during the LTO run.

Definition at line 1795 of file PassBuilderPipelines.cpp.

References addAnnotationRemarksPass(), llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), buildModuleSimplificationPipeline(), buildO0DefaultPipeline(), llvm::createModuleToFunctionPassAdaptor(), invokeOptimizerEarlyEPCallbacks(), invokeOptimizerLastEPCallbacks(), invokePipelineStartEPCallbacks(), llvm::OptimizationLevel::O0, llvm::RunPartialInlining, llvm::PGOOptions::SampleUse, llvm::ThinLTOPreLink, and llvm::UseCtxProfile.

Referenced by buildFatLTODefaultPipeline().

◆ checkParametrizedPassName()

◆ crossRegisterProxies()

◆ getPassInstrumentationCallbacks()

Returns PIC.

External libraries can use this to register pass instrumentation callbacks.

Definition at line 642 of file PassBuilder.h.

◆ getVirtualFileSystemPtr()

◆ invokeCGSCCOptimizerLateEPCallbacks()

◆ invokeFullLinkTimeOptimizationEarlyEPCallbacks()

◆ invokeFullLinkTimeOptimizationLastEPCallbacks()

◆ invokeLateLoopOptimizationsEPCallbacks()

◆ invokeLoopOptimizerEndEPCallbacks()

◆ invokeOptimizerEarlyEPCallbacks()

◆ invokeOptimizerLastEPCallbacks()

◆ invokePeepholeEPCallbacks()

◆ invokePipelineEarlySimplificationEPCallbacks()

◆ invokePipelineStartEPCallbacks()

◆ invokeScalarOptimizerLateEPCallbacks()

◆ invokeVectorizerEndEPCallbacks()

◆ invokeVectorizerStartEPCallbacks()

◆ parseAAPipeline()

◆ parsePassParameters()

template

auto llvm::PassBuilder::parsePassParameters ( ParametersParseCallableT && Parser, StringRef Name, StringRef PassName ) -> decltype(Parser(StringRef{})) inlinestatic

This performs customized parsing of pass name with parameters.

We do not need parametrization of passes in textual pipeline very often, yet on a rare occasion ability to specify parameters right there can be useful.

Name - parameterized specification of a pass from a textual pipeline is a string in a form of : PassName '<' parameter-list '>'

Parameter list is being parsed by the parser callable argument, Parser, It takes a string-ref of parameters and returns either StringError or a parameter list in a form of a custom parameters type, all wrapped into Expected<> template class.

Definition at line 712 of file PassBuilder.h.

References PassName.

◆ parsePassPipeline() [1/5]

◆ parsePassPipeline() [2/5]

◆ parsePassPipeline() [3/5]

◆ parsePassPipeline() [4/5]

◆ parsePassPipeline() [5/5]

Parse a textual pass pipeline description into a [ModulePassManager](namespacellvm.html#a79ab9199d2ba6a1c9cac2b79efc194a3 "Convenience typedef for a pass manager over modules.").

The format of the textual pass pipeline description looks something like:

module(function(instcombine,sroa),dce,cgscc(inliner,function(...)),...)

Pass managers have ()s describing the nest structure of passes. All passes are comma separated. As a special shortcut, if the very first pass is not a module pass (as a module pass manager is), this will automatically form the shortest stack of pass managers that allow inserting that first pass. So, assuming function passes 'fpassN', CGSCC passes 'cgpassN', and loop passes 'lpassN', all of these are valid:

fpass1,fpass2,fpass3 cgpass1,cgpass2,cgpass3 lpass1,lpass2,lpass3

And they are equivalent to the following (resp.):

module(function(fpass1,fpass2,fpass3)) module(cgscc(cgpass1,cgpass2,cgpass3)) module(function(loop(lpass1,lpass2,lpass3)))

This shortcut is especially useful for debugging and testing small pass combinations.

The sequence of passes aren't necessarily the exact same kind of pass. You can mix different levels implicitly if adaptor passes are defined to make them work. For example,

mpass1,fpass1,fpass2,mpass2,lpass1

This pipeline uses only one pass manager: the top-level module manager. fpass1,fpass2 and lpass1 are added into the top-level module manager using only adaptor passes. No nested function/loop pass managers are added. The purpose is to allow easy pass testing when the user specifically want the pass to run under a adaptor directly. This is preferred when a pipeline is largely of one type, but one or just a few passes are of different types(See PassBuilder.cpp for examples).

Definition at line 2602 of file PassBuilder.cpp.

References llvm::CallingConv::C, llvm::formatv(), llvm::StringRef::front(), llvm::inconvertibleErrorCode(), isCGSCCPassName(), isFunctionPassName(), isLoopNestPassName(), isLoopPassName(), isMachineFunctionPassName(), isModulePassName(), llvm::make_error(), and llvm::Error::success().

◆ parseRegAllocFilter()

◆ parseSinglePassOption()

◆ printPassNames()

◆ registerAnalysisRegistrationCallback() [1/5]

void llvm::PassBuilder::registerAnalysisRegistrationCallback ( const std::function< void(CGSCCAnalysisManager &)> & C) inline

◆ registerAnalysisRegistrationCallback() [2/5]

◆ registerAnalysisRegistrationCallback() [3/5]

void llvm::PassBuilder::registerAnalysisRegistrationCallback ( const std::function< void(LoopAnalysisManager &)> & C) inline

◆ registerAnalysisRegistrationCallback() [4/5]

◆ registerAnalysisRegistrationCallback() [5/5]

◆ registerCGSCCAnalyses()

Registers all available CGSCC analysis passes.

This is an interface that can be used to populate a [CGSCCAnalysisManager](namespacellvm.html#a571b2bbf074b46c75300bd8f14c5ab72 "The CGSCC analysis manager.") with all registered CGSCC analyses. Callers can still manually register any additional analyses. Callers can also pre-register analyses and this will not override those.

Definition at line 656 of file PassBuilder.cpp.

References llvm::CallingConv::C, and CGAM.

◆ registerCGSCCOptimizerLateEPCallback()

◆ registerFullLinkTimeOptimizationEarlyEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding optimizations at the start of the full LTO pipeline.

Definition at line 539 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerFullLinkTimeOptimizationLastEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding optimizations at the end of the full LTO pipeline.

Definition at line 548 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerFunctionAnalyses()

◆ registerLateLoopOptimizationsEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding late loop canonicalization and simplification passes. This is the last point in the loop optimization pipeline before loop deletion. Each pass added here must be an instance of LoopPass. This is the place to add passes that can remove loops, such as target- specific loop idiom recognition.

Definition at line 437 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerLoopAnalyses()

Registers all available loop analysis passes.

This is an interface that can be used to populate a [LoopAnalysisManager](namespacellvm.html#a58dde534a0ea2a23cb6c779c5c283f75 "The loop analysis manager.") with all registered loop analyses. Callers can still manually register any additional analyses.

Definition at line 697 of file PassBuilder.cpp.

References llvm::CallingConv::C, and LAM.

◆ registerLoopOptimizerEndEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding loop passes to the end of the loop optimizer.

Definition at line 447 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerMachineFunctionAnalyses()

Registers all available machine function analysis passes.

This is an interface that can be used to populate a [MachineFunctionAnalysisManager](namespacellvm.html#a470d9c59b0e56709d5dd0ba1c9ea81eb) with all registered function analyses. Callers can still manually register any additional analyses. Callers can also pre-register analyses and this will not override those.

Definition at line 686 of file PassBuilder.cpp.

References llvm::CallingConv::C.

◆ registerModuleAnalyses()

Registers all available module analysis passes.

This is an interface that can be used to populate a [ModuleAnalysisManager](namespacellvm.html#af9c9208365fd9ce11392b4d79485e259 "Convenience typedef for the Module analysis manager.") with all registered module analyses. Callers can still manually register any additional analyses. Callers can also pre-register analyses and this will not override those.

Definition at line 647 of file PassBuilder.cpp.

References llvm::CallingConv::C, and MAM.

◆ registerOptimizerEarlyEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding optimizations before the function optimization pipeline.

Definition at line 519 of file PassBuilder.h.

References llvm::CallingConv::C, and Phase.

◆ registerOptimizerLastEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding optimizations at the very end of the function optimization pipeline.

Definition at line 529 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerParseAACallback()

◆ registerParseTopLevelPipelineCallback()

◆ registerPeepholeEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding passes that perform peephole optimizations similar to the instruction combiner. These passes will be inserted after each instance of the instruction combiner pass.

Definition at line 423 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerPipelineEarlySimplificationEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding optimization right after passes that do basic simplification of the input IR.

Definition at line 509 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerPipelineParsingCallback() [1/5]

◆ registerPipelineParsingCallback() [2/5]

◆ registerPipelineParsingCallback() [3/5]

◆ registerPipelineParsingCallback() [4/5]

◆ registerPipelineParsingCallback() [5/5]

◆ registerPipelineStartEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding optimization once at the start of the pipeline. This does not apply to 'backend' compiles (LTO and ThinLTO link-time pipelines).

Definition at line 500 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerRegClassFilterParsingCallback()

◆ registerScalarOptimizerLateEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding optimization passes after most of the main optimizations, but before the last cleanup-ish optimizations.

Definition at line 457 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerVectorizerEndEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding optimization passes after the vectorizer and other highly target specific optimization passes are executed.

Definition at line 490 of file PassBuilder.h.

References llvm::CallingConv::C.

◆ registerVectorizerStartEPCallback()

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding optimization passes before the vectorizer and other highly target specific optimization passes are executed.

Definition at line 479 of file PassBuilder.h.

References llvm::CallingConv::C.

The documentation for this class was generated from the following files: