LLVM 17.0.0git
Classes | Public Member Functions | List of all members
llvm::GlobalsAAResult::FunctionInfo Class Reference

The mod/ref information collected for a particular function. More...

Public Member Functions

 FunctionInfo ()=default
 Checks to document the invariants of the bit packing here.
 
 ~FunctionInfo ()
 
 FunctionInfo (const FunctionInfo &Arg)
 
 FunctionInfo (FunctionInfo &&Arg)
 
FunctionInfo & operator= (const FunctionInfo &RHS)
 
FunctionInfo & operator= (FunctionInfo &&RHS)
 
ModRefInfo globalClearMayReadAnyGlobal (int I) const
 This method clears MayReadAnyGlobal bit added by GlobalsAAResult to return the corresponding ModRefInfo.
 
ModRefInfo getModRefInfo () const
 Returns the ModRefInfo info for this function.
 
void addModRefInfo (ModRefInfo NewMRI)
 Adds new ModRefInfo for this function to its state.
 
bool mayReadAnyGlobal () const
 Returns whether this function may read any global variable, and we don't know which global.
 
void setMayReadAnyGlobal ()
 Sets this function as potentially reading from any global.
 
ModRefInfo getModRefInfoForGlobal (const GlobalValue &GV) const
 Returns the ModRefInfo info for this function w.r.t.
 
void addFunctionInfo (const FunctionInfo &FI)
 Add mod/ref info from another function into ours, saturating towards ModRef.
 
void addModRefInfoForGlobal (const GlobalValue &GV, ModRefInfo NewMRI)
 
void eraseModRefInfoForGlobal (const GlobalValue &GV)
 Clear a global's ModRef info.
 

Detailed Description

The mod/ref information collected for a particular function.

We collect information about mod/ref behavior of a function here, both in general and as pertains to specific globals. We only have this detailed information when we know something useful about the behavior. If we saturate to fully general mod/ref, we remove the info for the function.

Definition at line 63 of file GlobalsModRef.cpp.

Constructor & Destructor Documentation

◆ FunctionInfo() [1/3]

llvm::GlobalsAAResult::FunctionInfo::FunctionInfo ( )
default

Checks to document the invariants of the bit packing here.

◆ ~FunctionInfo()

llvm::GlobalsAAResult::FunctionInfo::~FunctionInfo ( )
inline

Definition at line 102 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getPointer().

◆ FunctionInfo() [2/3]

llvm::GlobalsAAResult::FunctionInfo::FunctionInfo ( const FunctionInfo &  Arg)
inline

Definition at line 108 of file GlobalsModRef.cpp.

References Arg, and llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setPointer().

◆ FunctionInfo() [3/3]

llvm::GlobalsAAResult::FunctionInfo::FunctionInfo ( FunctionInfo &&  Arg)
inline

Definition at line 113 of file GlobalsModRef.cpp.

References Arg.

Member Function Documentation

◆ addFunctionInfo()

void llvm::GlobalsAAResult::FunctionInfo::addFunctionInfo ( const FunctionInfo &  FI)
inline

Add mod/ref info from another function into ours, saturating towards ModRef.

Definition at line 169 of file GlobalsModRef.cpp.

References llvm::GlobalsAAResult::FunctionInfo::addModRefInfo(), llvm::GlobalsAAResult::FunctionInfo::addModRefInfoForGlobal(), G, llvm::GlobalsAAResult::FunctionInfo::getModRefInfo(), llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getPointer(), llvm::GlobalsAAResult::FunctionInfo::mayReadAnyGlobal(), P, and llvm::GlobalsAAResult::FunctionInfo::setMayReadAnyGlobal().

◆ addModRefInfo()

void llvm::GlobalsAAResult::FunctionInfo::addModRefInfo ( ModRefInfo  NewMRI)
inline

Adds new ModRefInfo for this function to its state.

Definition at line 143 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getInt(), and llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setInt().

Referenced by llvm::GlobalsAAResult::FunctionInfo::addFunctionInfo().

◆ addModRefInfoForGlobal()

void llvm::GlobalsAAResult::FunctionInfo::addModRefInfoForGlobal ( const GlobalValue &  GV,
ModRefInfo  NewMRI 
)
inline

Definition at line 180 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getPointer(), P, and llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setPointer().

Referenced by llvm::GlobalsAAResult::FunctionInfo::addFunctionInfo().

◆ eraseModRefInfoForGlobal()

void llvm::GlobalsAAResult::FunctionInfo::eraseModRefInfoForGlobal ( const GlobalValue &  GV)
inline

Clear a global's ModRef info.

Should be used when a global is being deleted.

Definition at line 192 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getPointer(), and P.

◆ getModRefInfo()

ModRefInfo llvm::GlobalsAAResult::FunctionInfo::getModRefInfo ( ) const
inline

Returns the ModRefInfo info for this function.

Definition at line 138 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getInt(), and llvm::GlobalsAAResult::FunctionInfo::globalClearMayReadAnyGlobal().

Referenced by llvm::GlobalsAAResult::FunctionInfo::addFunctionInfo().

◆ getModRefInfoForGlobal()

ModRefInfo llvm::GlobalsAAResult::FunctionInfo::getModRefInfoForGlobal ( const GlobalValue &  GV) const
inline

Returns the ModRefInfo info for this function w.r.t.

a particular global, which may be more precise than the general information above.

Definition at line 156 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getPointer(), I, llvm::GlobalsAAResult::FunctionInfo::mayReadAnyGlobal(), llvm::NoModRef, P, and llvm::Ref.

◆ globalClearMayReadAnyGlobal()

ModRefInfo llvm::GlobalsAAResult::FunctionInfo::globalClearMayReadAnyGlobal ( int  I) const
inline

This method clears MayReadAnyGlobal bit added by GlobalsAAResult to return the corresponding ModRefInfo.

Definition at line 133 of file GlobalsModRef.cpp.

References I, and llvm::ModRef.

Referenced by llvm::GlobalsAAResult::FunctionInfo::getModRefInfo().

◆ mayReadAnyGlobal()

bool llvm::GlobalsAAResult::FunctionInfo::mayReadAnyGlobal ( ) const
inline

Returns whether this function may read any global variable, and we don't know which global.

Definition at line 149 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getInt().

Referenced by llvm::GlobalsAAResult::FunctionInfo::addFunctionInfo(), and llvm::GlobalsAAResult::FunctionInfo::getModRefInfoForGlobal().

◆ operator=() [1/2]

FunctionInfo & llvm::GlobalsAAResult::FunctionInfo::operator= ( const FunctionInfo &  RHS)
inline

Definition at line 117 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getPointer(), RHS, llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setPointer(), and llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setPointerAndInt().

◆ operator=() [2/2]

FunctionInfo & llvm::GlobalsAAResult::FunctionInfo::operator= ( FunctionInfo &&  RHS)
inline

Definition at line 124 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getPointer(), RHS, and llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setPointerAndInt().

◆ setMayReadAnyGlobal()

void llvm::GlobalsAAResult::FunctionInfo::setMayReadAnyGlobal ( )
inline

Sets this function as potentially reading from any global.

Definition at line 152 of file GlobalsModRef.cpp.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getInt(), and llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setInt().

Referenced by llvm::GlobalsAAResult::FunctionInfo::addFunctionInfo().

The documentation for this class was generated from the following file:
Generated on Fri Jun 2 2023 18:59:57 for LLVM by doxygen 1.9.6