llvm::LazyBranchProbabilityInfoPass

Synopsis

Declared in <llvm/Analysis/LazyBranchProbabilityInfo.h>

class LazyBranchProbabilityInfoPass
    : public FunctionPass

Description

This is an alternative analysis pass to BranchProbabilityInfoWrapperPass. The difference is that with this pass the branch probabilities are not computed when the analysis pass is executed but rather when the BPI results is explicitly requested by the analysis client.

There are some additional requirements for any client pass that wants to use the analysis:

1. The pass needs to initialize dependent passes with:

INITIALIZE_PASS_DEPENDENCY(LazyBPIPass)

2. Similarly, getAnalysisUsage should call:

LazyBranchProbabilityInfoPass::getLazyBPIAnalysisUsage(AU)

3. The computed BPI should be requested with getAnalysis<LazyBranchProbabilityInfoPass>().getBPI() before CycleInfo could be invalidated for example by changing the CFG.

Note that it is expected that we wouldn't need this functionality for the new PM since with the new PM, analyses are executed on demand.

Base Classes

Name	Description
`FunctionPass`	FunctionPass class - This class is used to implement most global optimizations. Optimizations should subclass this class if they meet the following constraints:

Member Functions

Name	Description
`LazyBranchProbabilityInfoPass` [constructor]	Construct a LazyBranchProbabilityInfoPass.
`operator=` [deleted]	Passes are not assignable.
`assignPassManager`	`assignPassManager` overloads
`createPrinterPass` [virtual]	createPrinterPass - Get a function printer pass.
`doFinalization` [virtual]	Perform any cleanup needed after all passes have run.
`doInitialization` [virtual]	Perform any initialization needed before any pass is run.
`dump`	Print this pass's state to stderr for debugging.
`dumpPassStructure` [virtual]	Print the pass nesting structure for -debug-passes=PassStructure.
`getAnalysis`	`getAnalysis` overloads
`getAnalysisID`	`getAnalysisID` overloads
`getAnalysisIfAvailable`	Get an optional analysis result that may already be available.
`getAnalysisUsage` [virtual]	Declare the analyses required and preserved by this pass.
`getAsImmutablePass` [virtual]	Return this pass as an ImmutablePass, or null if it is not one.
`getAsPMDataManager` [virtual]	Return this pass as a PMDataManager when it is a nested pass manager.
`getBPI`	Compute and return the branch probabilities.
`getPassArgument`	Return a nice clean name for a pass corresponding to that used to enable the pass in opt.
`getPassID`	getPassID - Return the PassID number that corresponds to this pass.
`getPassKind`	Return the kind of pass (module, function, loop, etc.).
`getPassName` [virtual]	Return a human-readable name for this pass.
`getPotentialPassManagerType` [virtual]	Return what kind of Pass Manager can manage this pass.
`getResolver`	Return the analysis resolver installed for this pass.
`mustPreserveAnalysisID`	Report whether the analysis identified by `AID` must be preserved.
`preparePassManager` [virtual]	Check whether available pass managers are suitable for this pass.
`print` [virtual]	Print the computed branch probabilities.
`printIRUnit` [virtual]	Serialize the IR unit this pass operates on for --print-changed.
`releaseMemory` [virtual]	Release the cached lazy BPI between runs.
`runOnFunction` [virtual]	Set up lazy BPI analysis for function `F.`
`setResolver`	Install the analysis resolver used to satisfy this pass's dependencies.
`verifyAnalysis` [virtual]	verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information.

Static Member Functions

Name	Description
`createPass`	Construct a new instance of the pass identified by `ID.`
`getLazyBPIAnalysisUsage`	Helper for client passes to set up the analysis usage on behalf of this pass.
`lookupPassInfo`	`lookupPassInfo` overloads

Static Data Members

Name	Description
`ID`	Pass identification, replacement for typeid.

Protected Member Functions

Name	Description
`skipFunction`	Check whether this optional pass should be skipped for `F.`

Non-Member Functions

Name	Description
`getBestSimplifyQuery`	Build a SimplifyQuery from analyses currently valid in a pass.
`getPassTimer`	Request the timer for this legacy-pass-manager's pass instance.
`isBitcodeWriterPass`	Check whether a pass is a BitcodeWriterPass.
`isIRPrintingPass`	Return true if a pass is for IR printing.