LLVM: llvm::StaticDataProfileInfoWrapperPass Class Reference

LLVM 22.0.0git

Public Member Functions | Static Public Attributes | List of all members

llvm::StaticDataProfileInfoWrapperPass Class Reference

This wraps the StaticDataProfileInfo object as an immutable pass, for a backend pass to operate on. More...

#include "llvm/Analysis/StaticDataProfileInfo.h"

Inheritance diagram for llvm::StaticDataProfileInfoWrapperPass:

Public Member Functions

StaticDataProfileInfoWrapperPass ()

bool doInitialization (Module &M) override

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

bool doFinalization (Module &M) override

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

StaticDataProfileInfo & getStaticDataProfileInfo ()

const StaticDataProfileInfo & getStaticDataProfileInfo () const

void getAnalysisUsage (AnalysisUsage &AU) const override

This pass provides StaticDataProfileInfo for reads/writes but does not modify M or other analysis.

Public Member Functions inherited from llvm::ImmutablePass

ImmutablePass (char &pid)

~ImmutablePass () override

virtual void initializePass ()

initializePass - This method may be overriden by immutable passes to allow them to perform various initialization actions they require.

ImmutablePass * getAsImmutablePass () override

bool runOnModule (Module &) override

ImmutablePasses are never run.

Public Member Functions inherited from llvm::ModulePass

ModulePass (char &pid)

~ModulePass () override

Pass * createPrinterPass (raw_ostream &OS, const std::string &Banner) const override

createPrinterPass - Get a module printer pass.

void assignPassManager (PMStack &PMS, PassManagerType T) override

Find appropriate Module Pass Manager in the PM Stack and add self into that manager.

PassManagerType getPotentialPassManagerType () const override

Return what kind of Pass Manager can manage this pass.

Public Member Functions inherited from llvm::Pass

Pass (PassKind K, char &pid)

Pass (const Pass &)=delete

Pass & operator= (const Pass &)=delete

virtual ~Pass ()

PassKind getPassKind () const

virtual StringRef getPassName () const

getPassName - Return a nice clean name for a pass.

StringRef getPassArgument () const

Return a nice clean name for a pass corresponding to that used to enable the pass in opt.

AnalysisID getPassID () const

getPassID - Return the PassID number that corresponds to this pass.

virtual void print (raw_ostream &OS, const Module *M) const

print - Print out the internal state of the pass.

void dump () const

virtual void preparePassManager (PMStack &)

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

void setResolver (AnalysisResolver *AR)

AnalysisResolver * getResolver () const

virtual void releaseMemory ()

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.

virtual PMDataManager * getAsPMDataManager ()

virtual void verifyAnalysis () const

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

virtual void dumpPassStructure (unsigned Offset=0)

template<typename AnalysisType>

AnalysisType * getAnalysisIfAvailable () const

getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to get analysis information that might be around, for example to update it.

bool mustPreserveAnalysisID (char &AID) const

mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID.

template<typename AnalysisType>

AnalysisType & getAnalysis () const

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

template<typename AnalysisType>

AnalysisType & getAnalysis (Function &F, bool *Changed=nullptr)

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

template<typename AnalysisType>

AnalysisType & getAnalysisID (AnalysisID PI) const

template<typename AnalysisType>

AnalysisType & getAnalysisID (AnalysisID PI, Function &F, bool *Changed=nullptr)

Static Public Attributes

static char ID = 0

Additional Inherited Members

Static Public Member Functions inherited from llvm::Pass

static const PassInfo * lookupPassInfo (const void *TI)

static const PassInfo * lookupPassInfo (StringRef Arg)

static Pass * createPass (AnalysisID ID)

Protected Member Functions inherited from llvm::ModulePass

bool skipModule (const Module &M) const

Optional passes call this function to check whether the pass should be skipped.

Detailed Description

This wraps the StaticDataProfileInfo object as an immutable pass, for a backend pass to operate on.

Definition at line 93 of file StaticDataProfileInfo.h.

Constructor & Destructor Documentation

◆ StaticDataProfileInfoWrapperPass()

llvm::StaticDataProfileInfoWrapperPass::StaticDataProfileInfoWrapperPass ( )

References doFinalization(), and doInitialization().

Member Function Documentation

◆ doFinalization()

bool StaticDataProfileInfoWrapperPass::doFinalization ( Module & )

overridevirtual

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

Reimplemented from llvm::Pass.

Definition at line 182 of file StaticDataProfileInfo.cpp.

Referenced by StaticDataProfileInfoWrapperPass().

◆ doInitialization()

bool StaticDataProfileInfoWrapperPass::doInitialization ( Module & )

overridevirtual

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

Reimplemented from llvm::Pass.

Definition at line 173 of file StaticDataProfileInfo.cpp.

References llvm::mdconst::extract_or_null().

Referenced by StaticDataProfileInfoWrapperPass().

◆ getAnalysisUsage()

void llvm::StaticDataProfileInfoWrapperPass::getAnalysisUsage ( AnalysisUsage & AU ) const

inlineoverridevirtual

This pass provides StaticDataProfileInfo for reads/writes but does not modify M or other analysis.

All analysis are preserved.

Reimplemented from llvm::Pass.

Definition at line 107 of file StaticDataProfileInfo.h.

References llvm::AnalysisUsage::setPreservesAll().

◆ getStaticDataProfileInfo() [1/2]

StaticDataProfileInfo & llvm::StaticDataProfileInfoWrapperPass::getStaticDataProfileInfo ( )

inline

Definition at line 100 of file StaticDataProfileInfo.h.

◆ getStaticDataProfileInfo() [2/2]

const StaticDataProfileInfo & llvm::StaticDataProfileInfoWrapperPass::getStaticDataProfileInfo ( ) const

inline

Definition at line 101 of file StaticDataProfileInfo.h.

Member Data Documentation

◆ ID

char StaticDataProfileInfoWrapperPass::ID = 0

static

Definition at line 95 of file StaticDataProfileInfo.h.

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

include/llvm/Analysis/StaticDataProfileInfo.h
lib/Analysis/StaticDataProfileInfo.cpp

Generated on for LLVM by doxygen 1.14.0