llvm::ProfileSummaryInfoWrapperPass

An analysis pass based on legacy pass manager to deliver ProfileSummaryInfo.

Synopsis

Declared in <llvm/Analysis/ProfileSummaryInfo.h>

class ProfileSummaryInfoWrapperPass
    : public ImmutablePass

Base Classes

Name

Description

ImmutablePass

ImmutablePass class ‐ This class is used to provide information that does not need to be run. This is useful for things like target information.

Member Functions

Name

Description

ProfileSummaryInfoWrapperPass [constructor]

Default constructor

operator= [deleted]

Copy assignment operator

assignPassManager

Each pass is responsible for assigning a pass manager to itself. PMS is the stack of available pass manager.

createPrinterPass [virtual]

createPrinterPass ‐ Get a module printer pass.

doFinalization

doFinalization ‐ Virtual method overriden by subclasses to do any necessary clean up after all passes have run.

doInitialization

doInitialization ‐ Virtual method overridden by subclasses to do any necessary initialization before any pass is run.

dump

dumpPassStructure [virtual]

getAnalysis

getAnalysis<AnalysisType>() ‐ This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function.

getAnalysisID

getAnalysisIfAvailable

getAnalysisIfAvailable<AnalysisType>() ‐ Subclasses use this function to get analysis information that might be around, for example to update it. This is different than getAnalysis in that it can fail (if the analysis results haven't been computed), so should only be used if you can handle the case when the analysis is not available. This method is often used by transformation APIs to update analysis results for a pass automatically as the transform is performed.

getAnalysisUsage

getAnalysisUsage ‐ This function should be overriden by passes that need analysis information to do their job. If a pass specifies that it uses a particular analysis result to this function, it can then use the getAnalysis<AnalysisType>() function, below.

getAsImmutablePass [virtual]

getAsPMDataManager [virtual]

getPSI

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

getPassName [virtual]

getPassName ‐ Return a nice clean name for a pass. This usually implemented in terms of the name that is registered by one of the Registration templates, but can be overloaded directly.

getPotentialPassManagerType [virtual]

Return what kind of Pass Manager can manage this pass.

getResolver

initializePass [virtual]

initializePass ‐ This method may be overriden by immutable passes to allow them to perform various initialization actions they require. This is primarily because an ImmutablePass can "require" another ImmutablePass, and if it does, the overloaded version of initializePass may get access to these passes with getAnalysis<>.

mustPreserveAnalysisID

mustPreserveAnalysisID ‐ This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID. This obviously cannot give you a properly typed instance of the class if you don't have the class name available (use getAnalysisIfAvailable if you do), but it can tell you if you need to preserve the pass at least.

preparePassManager [virtual]

Check if available pass managers are suitable for this pass or not.

print [virtual]

print ‐ Print out the internal state of the pass. This is called by Analyze to print out the contents of an analysis. Otherwise it is not necessary to implement this method. Beware that the module pointer MAY be null. This automatically forwards to a virtual function that does not provide the Module* in case the analysis doesn't need it it can just be ignored.

releaseMemory [virtual]

releaseMemory() ‐ This member can be implemented by a pass if it wants to be able to release its memory when it is no longer needed. The default behavior of passes is to hold onto memory for the entire duration of their lifetime (which is the entire compile time). For pipelined passes, this is not a big deal because that memory gets recycled every time the pass is invoked on another program unit. For IP passes, it is more important to free memory when it is unused.

runOnModule

runOnModule overloads

setResolver

verifyAnalysis [virtual]

verifyAnalysis() ‐ This member can be implemented by a analysis pass to check state of analysis information.