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

#include "llvm/Passes/PassBuilder.h"

Classes
struct	PipelineElement
	A struct to capture parsed pass pipeline names. More...

Public Types
enum	ThinLTOPhase { ThinLTOPhase::None, ThinLTOPhase::PreLink, ThinLTOPhase::PostLink }
	ThinLTO phase. More...

enum	OptimizationLevel { O0, O1, O2, O3, Os, Oz }
	LLVM-provided high-level optimization levels. More...

Public Member Functions
	PassBuilder (TargetMachine TM=nullptr, Optional< PGOOptions > PGOOpt=None, PassInstrumentationCallbacks PIC=nullptr)

void	crossRegisterProxies (LoopAnalysisManager &LAM, FunctionAnalysisManager &FAM, CGSCCAnalysisManager &CGAM, ModuleAnalysisManager &MAM)
	Cross register the analysis managers through their proxies. More...

void	registerModuleAnalyses (ModuleAnalysisManager &MAM)
	Registers all available module analysis passes. More...

void	registerCGSCCAnalyses (CGSCCAnalysisManager &CGAM)
	Registers all available CGSCC analysis passes. More...

void	registerFunctionAnalyses (FunctionAnalysisManager &FAM)
	Registers all available function analysis passes. More...

void	registerLoopAnalyses (LoopAnalysisManager &LAM)
	Registers all available loop analysis passes. More...

FunctionPassManager	buildFunctionSimplificationPipeline (OptimizationLevel Level, ThinLTOPhase Phase, bool DebugLogging=false)
	Construct the core LLVM function canonicalization and simplification pipeline. More...

ModulePassManager	buildModuleSimplificationPipeline (OptimizationLevel Level, ThinLTOPhase Phase, bool DebugLogging=false)
	Construct the core LLVM module canonicalization and simplification pipeline. More...

ModulePassManager	buildModuleOptimizationPipeline (OptimizationLevel Level, bool DebugLogging=false)
	Construct the core LLVM module optimization pipeline. More...

ModulePassManager	buildPerModuleDefaultPipeline (OptimizationLevel Level, bool DebugLogging=false)
	Build a per-module default optimization pipeline. More...

ModulePassManager	buildThinLTOPreLinkDefaultPipeline (OptimizationLevel Level, bool DebugLogging=false)
	Build a pre-link, ThinLTO-targeting default optimization pipeline to a pass manager. More...

ModulePassManager	buildThinLTODefaultPipeline (OptimizationLevel Level, bool DebugLogging, const ModuleSummaryIndex *ImportSummary)
	Build an ThinLTO default optimization pipeline to a pass manager. More...

ModulePassManager	buildLTOPreLinkDefaultPipeline (OptimizationLevel Level, bool DebugLogging=false)
	Build a pre-link, LTO-targeting default optimization pipeline to a pass manager. More...

ModulePassManager	buildLTODefaultPipeline (OptimizationLevel Level, bool DebugLogging, ModuleSummaryIndex *ExportSummary)
	Build an LTO default optimization pipeline to a pass manager. More...

AAManager	buildDefaultAAPipeline ()
	Build the default `AAManager` with the default alias analysis pipeline registered. More...

Error	parsePassPipeline (ModulePassManager &MPM, StringRef PipelineText, bool VerifyEachPass=true, bool DebugLogging=false)
	Parse a textual pass pipeline description into a `ModulePassManager`. More...

Error	parsePassPipeline (CGSCCPassManager &CGPM, StringRef PipelineText, bool VerifyEachPass=true, bool DebugLogging=false)
	{{@ Parse a textual pass pipeline description into a specific PassManager More...

Error	parsePassPipeline (FunctionPassManager &FPM, StringRef PipelineText, bool VerifyEachPass=true, bool DebugLogging=false)

Error	parsePassPipeline (LoopPassManager &LPM, StringRef PipelineText, bool VerifyEachPass=true, bool DebugLogging=false)

Error	parseAAPipeline (AAManager &AA, StringRef PipelineText)
	Parse a textual alias analysis pipeline into the provided AA manager. More...

void	registerPeepholeEPCallback (const std::function< void(FunctionPassManager &, OptimizationLevel)> &C)
	Register a callback for a default optimizer pipeline extension point. More...

void	registerLateLoopOptimizationsEPCallback (const std::function< void(LoopPassManager &, OptimizationLevel)> &C)
	Register a callback for a default optimizer pipeline extension point. More...

void	registerLoopOptimizerEndEPCallback (const std::function< void(LoopPassManager &, OptimizationLevel)> &C)
	Register a callback for a default optimizer pipeline extension point. More...

void	registerScalarOptimizerLateEPCallback (const std::function< void(FunctionPassManager &, OptimizationLevel)> &C)
	Register a callback for a default optimizer pipeline extension point. More...

void	registerCGSCCOptimizerLateEPCallback (const std::function< void(CGSCCPassManager &, OptimizationLevel)> &C)
	Register a callback for a default optimizer pipeline extension point. More...

void	registerVectorizerStartEPCallback (const std::function< void(FunctionPassManager &, OptimizationLevel)> &C)
	Register a callback for a default optimizer pipeline extension point. More...

void	registerPipelineStartEPCallback (const std::function< void(ModulePassManager &)> &C)
	Register a callback for a default optimizer pipeline extension point. More...

void	registerOptimizerLastEPCallback (const std::function< void(FunctionPassManager &, OptimizationLevel)> &C)
	Register a callback for a default optimizer pipeline extension point. More...

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`. More...

void	registerAnalysisRegistrationCallback (const std::function< void(CGSCCAnalysisManager &)> &C)
	{{@ Register callbacks for analysis registration with this PassBuilder instance. More...

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	registerPipelineParsingCallback (const std::function< bool(StringRef Name, CGSCCPassManager &, ArrayRef< PipelineElement >)> &C)
	{{@ Register pipeline parsing callbacks with this pass builder instance. More...

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	registerParseTopLevelPipelineCallback (const std::function< bool(ModulePassManager &, ArrayRef< PipelineElement >, bool VerifyEachPass, bool DebugLogging)> &C)
	Register a callback for a top-level pipeline entry. More...

Detailed Description

This class provides access to building LLVM's passes.

It's 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 63 of file PassBuilder.h.

Member Enumeration Documentation

◆ OptimizationLevel

enum llvm::PassBuilder::OptimizationLevel

LLVM-provided high-level optimization levels.

This enumerates the LLVM-provided high-level optimization levels. Each level has a specific goal and rationale.

Enumerator
O0	Disable as many optimizations as possible. This doesn't completely disable the optimizer in all cases, for example always_inline functions can be required to be inlined for correctness.
O1	Optimize quickly without destroying debuggability. FIXME: The current and historical behavior of this level does not agree with this goal, but we would like to move toward this goal in the future. This level is tuned to produce a result from the optimizer as quickly as possible and to avoid destroying debuggability. This tends to result in a very good development mode where the compiled code will be immediately executed as part of testing. As a consequence, where possible, we would like to produce efficient-to-execute code, but not if it significantly slows down compilation or would prevent even basic debugging of the resulting binary. As an example, complex loop transformations such as versioning, vectorization, or fusion might not make sense here due to the degree to which the executed code would differ from the source code, and the potential compile time cost.
O2	Optimize for fast execution as much as possible without triggering significant incremental compile time or code size growth. The key idea is that optimizations at this level should "pay for themselves". So if an optimization increases compile time by 5% or increases code size by 5% for a particular benchmark, that benchmark should also be one which sees a 5% runtime improvement. If the compile time or code size penalties happen on average across a diverse range of LLVM users' benchmarks, then the improvements should as well. And no matter what, the compile time needs to not grow superlinearly with the size of input to LLVM so that users can control the runtime of the optimizer in this mode. This is expected to be a good default optimization level for the vast majority of users.
O3	Optimize for fast execution as much as possible. This mode is significantly more aggressive in trading off compile time and code size to get execution time improvements. The core idea is that this mode should include any optimization that helps execution time on balance across a diverse collection of benchmarks, even if it increases code size or compile time for some benchmarks without corresponding improvements to execution time. Despite being willing to trade more compile time off to get improved execution time, this mode still tries to avoid superlinear growth in order to make even significantly slower compile times at least scale reasonably. This does not preclude very substantial constant factor costs though.
Os	Similar to `O2` but tries to optimize for small code size instead of fast execution without triggering significant incremental execution time slowdowns. The logic here is exactly the same as `O2`, but with code size and execution time metrics swapped. A consequence of the different core goal is that this should in general produce substantially smaller executables that still run in a reasonable amount of time.
Oz	A very specialized mode that will optimize for code size at any and all costs. This is useful primarily when there are absolute size limitations and any effort taken to reduce the size is worth it regardless of the execution time impact. You should expect this level to produce rather slow, but very small, code.

Definition at line 98 of file PassBuilder.h.

◆ ThinLTOPhase

enum llvm::PassBuilder::ThinLTOPhase

strong

ThinLTO phase.

This enumerates the LLVM ThinLTO optimization phases.

Enumerator
None	No ThinLTO behavior needed.
PreLink
PostLink

Definition at line 85 of file PassBuilder.h.

Constructor & Destructor Documentation

◆ PassBuilder()

llvm::PassBuilder::PassBuilder	(	TargetMachine *	TM = `nullptr`,
		Optional< PGOOptions >	PGOOpt = `None`,
		PassInstrumentationCallbacks *	PIC = `nullptr`
	)

inlineexplicit

Definition at line 180 of file PassBuilder.h.

References Phase.

Member Function Documentation

◆ buildDefaultAAPipeline()

AAManager PassBuilder::buildDefaultAAPipeline ( )

Build the default AAManager with the default alias analysis pipeline registered.

Definition at line 1203 of file PassBuilder.cpp.

References llvm::AAManager::registerFunctionAnalysis(), and llvm::AAManager::registerModuleAnalysis().

◆ buildFunctionSimplificationPipeline()

FunctionPassManager PassBuilder::buildFunctionSimplificationPipeline	(	OptimizationLevel	Level,
		ThinLTOPhase	Phase,
		bool	DebugLogging = `false`
	)

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 363 of file PassBuilder.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), assert(), C, llvm::createCGSCCToFunctionPassAdaptor(), llvm::createFunctionToLoopPassAdaptor(), llvm::createModuleToFunctionPassAdaptor(), llvm::createModuleToPostOrderCGSCCPassAdaptor(), llvm::InlineParams::DefaultThreshold, llvm::InstrProfOptions::DoCounterPromotion, EnableCHR, EnableEarlyCSEMemSSA, EnableGVNHoist, EnableGVNSink, llvm::InlineParams::HintThreshold, llvm::InstrProfOptions::InstrProfileOutput, isOptimizingForSize(), and RunNewGVN.

◆ buildLTODefaultPipeline()

ModulePassManager PassBuilder::buildLTODefaultPipeline	(	OptimizationLevel	Level,
		bool	DebugLogging,
		ModuleSummaryIndex *	ExportSummary
	)

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 addPreLinkLTODefaultPipeline, and the two coordinate closely.

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 1012 of file PassBuilder.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), assert(), llvm::createModuleToFunctionPassAdaptor(), llvm::createModuleToPostOrderCGSCCPassAdaptor(), getInlineParamsFromOptLevel(), and RunNewGVN.

◆ buildLTOPreLinkDefaultPipeline()

ModulePassManager PassBuilder::buildLTOPreLinkDefaultPipeline	(	OptimizationLevel	Level,
		bool	DebugLogging = `false`
	)

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

This adds the pre-link optimizations tuned to work well with a later LTO 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.

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 1004 of file PassBuilder.cpp.

References assert().

◆ buildModuleOptimizationPipeline()

ModulePassManager PassBuilder::buildModuleOptimizationPipeline	(	OptimizationLevel	Level,
		bool	DebugLogging = `false`
	)

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 742 of file PassBuilder.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), C, llvm::createFunctionToLoopPassAdaptor(), llvm::createModuleToFunctionPassAdaptor(), EnableUnrollAndJam, and RunPartialInlining.

◆ buildModuleSimplificationPipeline()

ModulePassManager PassBuilder::buildModuleSimplificationPipeline	(	OptimizationLevel	Level,
		ThinLTOPhase	Phase,
		bool	DebugLogging = `false`
	)

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 585 of file PassBuilder.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), C, llvm::createCGSCCToFunctionPassAdaptor(), llvm::createDevirtSCCRepeatedPass(), llvm::createModuleToFunctionPassAdaptor(), llvm::createModuleToPostOrderCGSCCPassAdaptor(), EnableSyntheticCounts, getInlineParamsFromOptLevel(), llvm::InlineParams::HotCallSiteThreshold, and MaxDevirtIterations.

◆ buildPerModuleDefaultPipeline()

ModulePassManager PassBuilder::buildPerModuleDefaultPipeline	(	OptimizationLevel	Level,
		bool	DebugLogging = `false`
	)

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.

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 894 of file PassBuilder.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), assert(), C, llvm::createModuleToFunctionPassAdaptor(), and llvm::None.

◆ buildThinLTODefaultPipeline()

ModulePassManager PassBuilder::buildThinLTODefaultPipeline	(	OptimizationLevel	Level,
		bool	DebugLogging,
		const ModuleSummaryIndex *	ImportSummary
	)

Build an 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 addPreLinkLTODefaultPipeline, and the two coordinate closely.

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 959 of file PassBuilder.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass().

◆ buildThinLTOPreLinkDefaultPipeline()

ModulePassManager PassBuilder::buildThinLTOPreLinkDefaultPipeline	(	OptimizationLevel	Level,
		bool	DebugLogging = `false`
	)

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.

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 921 of file PassBuilder.cpp.

References llvm::PassManager< IRUnitT, AnalysisManagerT, ExtraArgTs >::addPass(), assert(), C, llvm::createModuleToFunctionPassAdaptor(), and RunPartialInlining.

◆ crossRegisterProxies()

void PassBuilder::crossRegisterProxies	(	LoopAnalysisManager &	LAM,
		FunctionAnalysisManager &	FAM,
		CGSCCAnalysisManager &	CGAM,
		ModuleAnalysisManager &	MAM
	)

Cross register the analysis managers through their proxies.

This is an interface that can be used to cross register each

Definition at line 1918 of file PassBuilder.cpp.

References llvm::AnalysisManager< IRUnitT, ExtraArgTs >::registerPass().

◆ parseAAPipeline()

Error PassBuilder::parseAAPipeline	(	AAManager &	AA,
		StringRef	PipelineText
	)

Parse a textual alias analysis pipeline into the provided AA manager.

The format of the textual AA pipeline is a comma separated list of AA pass names:

basic-aa,globals-aa,...

The AA manager is set up such that the provided alias analyses are tried in the order specified. See the AAManaager documentation for details about the logic used. This routine just provides the textual mapping between AA names and the analyses to register with the manager.

Returns false if the text cannot be parsed cleanly. The specific state of the AA manager is unspecified if such an error is encountered and this returns false.

Definition at line 2055 of file PassBuilder.cpp.

References llvm::StringRef::empty(), llvm::formatv(), llvm::inconvertibleErrorCode(), Name, llvm::StringRef::split(), and llvm::Error::success().

◆ parsePassPipeline() [1/4]

Error PassBuilder::parsePassPipeline	(	ModulePassManager &	MPM,
		StringRef	PipelineText,
		bool	VerifyEachPass = `true`,
		bool	DebugLogging = `false`
	)

Parse a textual pass pipeline description into a ModulePassManager.

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. Note that these shortcuts don't introduce any other magic. If the sequence of passes aren't all the exact same kind of pass, it will be an error. You cannot mix different levels implicitly, you must explicitly form a pass manager in which to nest passes.

Definition at line 1947 of file PassBuilder.cpp.

References C, llvm::ArrayRef< T >::empty(), llvm::formatv(), llvm::ArrayRef< T >::front(), llvm::inconvertibleErrorCode(), isCGSCCPassName(), isFunctionPassName(), isLoopPassName(), isModulePassName(), and llvm::Error::success().

◆ parsePassPipeline() [2/4]

Error PassBuilder::parsePassPipeline	(	CGSCCPassManager &	CGPM,
		StringRef	PipelineText,
		bool	VerifyEachPass = `true`,
		bool	DebugLogging = `false`
	)

{{@ Parse a textual pass pipeline description into a specific PassManager

Automatic deduction of an appropriate pass manager stack is not supported. For example, to insert a loop pass 'lpass' into a FunctinoPassManager, this is the valid pipeline text:

function(lpass)

Definition at line 1990 of file PassBuilder.cpp.

References llvm::ArrayRef< T >::empty(), llvm::formatv(), llvm::ArrayRef< T >::front(), llvm::inconvertibleErrorCode(), and isCGSCCPassName().

◆ parsePassPipeline() [3/4]

Error PassBuilder::parsePassPipeline	(	FunctionPassManager &	FPM,
		StringRef	PipelineText,
		bool	VerifyEachPass = `true`,
		bool	DebugLogging = `false`
	)

Definition at line 2015 of file PassBuilder.cpp.

References llvm::ArrayRef< T >::empty(), llvm::formatv(), llvm::ArrayRef< T >::front(), llvm::inconvertibleErrorCode(), and isFunctionPassName().

◆ parsePassPipeline() [4/4]

Error PassBuilder::parsePassPipeline	(	LoopPassManager &	LPM,
		StringRef	PipelineText,
		bool	VerifyEachPass = `true`,
		bool	DebugLogging = `false`
	)

Definition at line 2039 of file PassBuilder.cpp.

References llvm::ArrayRef< T >::empty(), llvm::formatv(), and llvm::inconvertibleErrorCode().

◆ registerAnalysisRegistrationCallback() [1/4]

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

inline

{{@ Register callbacks for analysis registration with this PassBuilder instance.

Callees register their analyses with the given AnalysisManager objects.

Definition at line 526 of file PassBuilder.h.

References C.

◆ registerAnalysisRegistrationCallback() [2/4]

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

inline

Definition at line 530 of file PassBuilder.h.

References C.

◆ registerAnalysisRegistrationCallback() [3/4]

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

inline

Definition at line 534 of file PassBuilder.h.

References C.

◆ registerAnalysisRegistrationCallback() [4/4]

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

inline

Definition at line 538 of file PassBuilder.h.

References C.

◆ registerCGSCCAnalyses()

void PassBuilder::registerCGSCCAnalyses ( CGSCCAnalysisManager & CGAM )

Registers all available CGSCC analysis passes.

This is an interface that can be used to populate a CGSCCAnalysisManager 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 335 of file PassBuilder.cpp.

References C.

◆ registerCGSCCOptimizerLateEPCallback()

void llvm::PassBuilder::registerCGSCCOptimizerLateEPCallback ( const std::function< void(CGSCCPassManager &, OptimizationLevel)> & C )

inline

Register a callback for a default optimizer pipeline extension point.

This extension point allows adding CallGraphSCC passes at the end of the main CallGraphSCC passes and before any function simplification passes run by CGPassManager.

Definition at line 478 of file PassBuilder.h.

References C.

◆ registerFunctionAnalyses()

void PassBuilder::registerFunctionAnalyses ( FunctionAnalysisManager & FAM )

Registers all available function analysis passes.

This is an interface that can be used to populate a FunctionAnalysisManager 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 344 of file PassBuilder.cpp.

References C.

◆ registerLateLoopOptimizationsEPCallback()

void llvm::PassBuilder::registerLateLoopOptimizationsEPCallback ( const std::function< void(LoopPassManager &, OptimizationLevel)> & C )

inline

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 447 of file PassBuilder.h.

References C.

◆ registerLoopAnalyses()

void PassBuilder::registerLoopAnalyses ( LoopAnalysisManager & LAM )

Registers all available loop analysis passes.

This is an interface that can be used to populate a LoopAnalysisManager with all registered loop analyses. Callers can still manually register any additional analyses.

Definition at line 353 of file PassBuilder.cpp.

References C.

◆ registerLoopOptimizerEndEPCallback()

void llvm::PassBuilder::registerLoopOptimizerEndEPCallback ( const std::function< void(LoopPassManager &, OptimizationLevel)> & C )

inline

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 457 of file PassBuilder.h.

References C.

◆ registerModuleAnalyses()

void PassBuilder::registerModuleAnalyses ( ModuleAnalysisManager & MAM )

Registers all available module analysis passes.

This is an interface that can be used to populate a ModuleAnalysisManager 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 326 of file PassBuilder.cpp.

References C.

◆ registerOptimizerLastEPCallback()

void llvm::PassBuilder::registerOptimizerLastEPCallback ( const std::function< void(FunctionPassManager &, OptimizationLevel)> & C )

inline

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. A key difference between this and the legacy PassManager's OptimizerLast callback is that this extension point is not triggered at O0. Extensions to the O0 pipeline should append their passes to the end of the overall pipeline.

Definition at line 511 of file PassBuilder.h.

References C.

◆ registerParseAACallback()

void llvm::PassBuilder::registerParseAACallback ( const std::function< bool(StringRef Name, AAManager &AA)> & C )

inline

Register a callback for parsing an AliasAnalysis Name to populate the given AAManager AA.

Definition at line 518 of file PassBuilder.h.

References C.

◆ registerParseTopLevelPipelineCallback()

void llvm::PassBuilder::registerParseTopLevelPipelineCallback ( const std::function< bool(ModulePassManager &, ArrayRef< PipelineElement >, bool VerifyEachPass, bool DebugLogging)> & C )

inline

Register a callback for a top-level pipeline entry.

If the PassManager type is not given at the top level of the pipeline text, this Callback should be used to determine the appropriate stack of PassManagers and populate the passed ModulePassManager.

Definition at line 575 of file PassBuilder.h.

References C, E, function, Name, llvm::PGOOptions::ProfileGenFile, llvm::PGOOptions::ProfileRemappingFile, llvm::PGOOptions::ProfileUseFile, and llvm::PGOOptions::RunProfileGen.

◆ registerPeepholeEPCallback()

void llvm::PassBuilder::registerPeepholeEPCallback ( const std::function< void(FunctionPassManager &, OptimizationLevel)> & C )

inline

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 433 of file PassBuilder.h.

References C.

◆ registerPipelineParsingCallback() [1/4]

void llvm::PassBuilder::registerPipelineParsingCallback ( const std::function< bool(StringRef Name, CGSCCPassManager &, ArrayRef< PipelineElement >)> & C )

inline

{{@ Register pipeline parsing callbacks with this pass builder instance.

Using these callbacks, callers can parse both a single pass name, as well as entire sub-pipelines, and populate the PassManager instance accordingly.

Definition at line 548 of file PassBuilder.h.

References C.

◆ registerPipelineParsingCallback() [2/4]

void llvm::PassBuilder::registerPipelineParsingCallback ( const std::function< bool(StringRef Name, FunctionPassManager &, ArrayRef< PipelineElement >)> & C )

inline

Definition at line 553 of file PassBuilder.h.

References C.

◆ registerPipelineParsingCallback() [3/4]

void llvm::PassBuilder::registerPipelineParsingCallback ( const std::function< bool(StringRef Name, LoopPassManager &, ArrayRef< PipelineElement >)> & C )

inline

Definition at line 558 of file PassBuilder.h.

References C.

◆ registerPipelineParsingCallback() [4/4]

void llvm::PassBuilder::registerPipelineParsingCallback ( const std::function< bool(StringRef Name, ModulePassManager &, ArrayRef< PipelineElement >)> & C )

inline

Definition at line 563 of file PassBuilder.h.

References C.

◆ registerPipelineStartEPCallback()

void llvm::PassBuilder::registerPipelineStartEPCallback ( const std::function< void(ModulePassManager &)> & C )

inline

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 499 of file PassBuilder.h.

References C.

◆ registerScalarOptimizerLateEPCallback()

void llvm::PassBuilder::registerScalarOptimizerLateEPCallback ( const std::function< void(FunctionPassManager &, OptimizationLevel)> & C )

inline

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 467 of file PassBuilder.h.

References C.

◆ registerVectorizerStartEPCallback()

void llvm::PassBuilder::registerVectorizerStartEPCallback ( const std::function< void(FunctionPassManager &, OptimizationLevel)> & C )

inline

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 489 of file PassBuilder.h.

References C.

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

include/llvm/Passes/PassBuilder.h
lib/Passes/PassBuilder.cpp

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ OptimizationLevel

◆ ThinLTOPhase

Constructor & Destructor Documentation

◆ PassBuilder()

Member Function Documentation

◆ buildDefaultAAPipeline()

◆ buildFunctionSimplificationPipeline()

◆ buildLTODefaultPipeline()

◆ buildLTOPreLinkDefaultPipeline()

◆ buildModuleOptimizationPipeline()

◆ buildModuleSimplificationPipeline()

◆ buildPerModuleDefaultPipeline()

◆ buildThinLTODefaultPipeline()

◆ buildThinLTOPreLinkDefaultPipeline()

◆ crossRegisterProxies()

◆ parseAAPipeline()

◆ parsePassPipeline() [1/4]

◆ parsePassPipeline() [2/4]

◆ parsePassPipeline() [3/4]

◆ parsePassPipeline() [4/4]

◆ registerAnalysisRegistrationCallback() [1/4]

◆ registerAnalysisRegistrationCallback() [2/4]

◆ registerAnalysisRegistrationCallback() [3/4]

◆ registerAnalysisRegistrationCallback() [4/4]

◆ registerCGSCCAnalyses()

◆ registerCGSCCOptimizerLateEPCallback()

◆ registerFunctionAnalyses()

◆ registerLateLoopOptimizationsEPCallback()

◆ registerLoopAnalyses()

◆ registerLoopOptimizerEndEPCallback()

◆ registerModuleAnalyses()

◆ registerOptimizerLastEPCallback()

◆ registerParseAACallback()

◆ registerParseTopLevelPipelineCallback()

◆ registerPeepholeEPCallback()

◆ registerPipelineParsingCallback() [1/4]

◆ registerPipelineParsingCallback() [2/4]

◆ registerPipelineParsingCallback() [3/4]

◆ registerPipelineParsingCallback() [4/4]

◆ registerPipelineStartEPCallback()

◆ registerScalarOptimizerLateEPCallback()

◆ registerVectorizerStartEPCallback()