LLVM 22.0.0git
Public Types | Public Member Functions | Public Attributes | List of all members
llvm::ValueInfo Struct Reference

Struct that holds a reference to a particular GUID in a global value summary. More...

#include "llvm/IR/ModuleSummaryIndex.h"

Public Types

enum  Flags { HaveGV = 1 , ReadOnly = 2 , WriteOnly = 4 }
 

Public Member Functions

 ValueInfo ()=default
 
 ValueInfo (bool HaveGVs, const GlobalValueSummaryMapTy::value_type *R)
 
 operator bool () const
 
GlobalValue::GUID getGUID () const
 
const GlobalValue * getValue () const
 
ArrayRef< std::unique_ptr< GlobalValueSummary > > getSummaryList () const
 
bool hasName () const
 
StringRef name () const
 
bool haveGVs () const
 
bool isReadOnly () const
 
bool isWriteOnly () const
 
unsigned getAccessSpecifier () const
 
bool isValidAccessSpecifier () const
 
void setReadOnly ()
 
void setWriteOnly ()
 
const GlobalValueSummaryMapTy::value_type * getRef () const
 
LLVM_ABI GlobalValue::VisibilityTypes getELFVisibility () const
 Returns the most constraining visibility among summaries.
 
LLVM_ABI bool isDSOLocal (bool WithDSOLocalPropagation=false) const
 Checks if all summaries are DSO local (have the flag set).
 
LLVM_ABI bool canAutoHide () const
 Checks if all copies are eligible for auto-hiding (have flag set).
 

Public Attributes

PointerIntPair< const GlobalValueSummaryMapTy::value_type *, 3, int > RefAndFlags
 

Detailed Description

Struct that holds a reference to a particular GUID in a global value summary.

Definition at line 184 of file ModuleSummaryIndex.h.

Member Enumeration Documentation

◆ Flags

enum llvm::ValueInfo::Flags
Enumerator
HaveGV 
ReadOnly 
WriteOnly 

Definition at line 185 of file ModuleSummaryIndex.h.

Constructor & Destructor Documentation

◆ ValueInfo() [1/2]

llvm::ValueInfo::ValueInfo ( )
default

◆ ValueInfo() [2/2]

llvm::ValueInfo::ValueInfo ( bool  HaveGVs,
const GlobalValueSummaryMapTy::value_type *  R 
)
inline

Definition at line 190 of file ModuleSummaryIndex.h.

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

Member Function Documentation

◆ canAutoHide()

bool ValueInfo::canAutoHide ( ) const

Checks if all copies are eligible for auto-hiding (have flag set).

Definition at line 68 of file ModuleSummaryIndex.cpp.

References llvm::all_of(), and getSummaryList().

◆ getAccessSpecifier()

unsigned llvm::ValueInfo::getAccessSpecifier ( ) const
inline

Definition at line 226 of file ModuleSummaryIndex.h.

References assert(), llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getInt(), isValidAccessSpecifier(), ReadOnly, RefAndFlags, and WriteOnly.

Referenced by setReadOnly(), and setWriteOnly().

◆ getELFVisibility()

GlobalValue::VisibilityTypes ValueInfo::getELFVisibility ( ) const

Returns the most constraining visibility among summaries.

The visibilities, ordered from least to most constraining, are: default, protected and hidden.

Definition at line 43 of file ModuleSummaryIndex.cpp.

References llvm::GlobalValue::DefaultVisibility, getSummaryList(), llvm::GlobalValue::HiddenVisibility, llvm::make_pointee_range(), and llvm::GlobalValue::ProtectedVisibility.

◆ getGUID()

GlobalValue::GUID llvm::ValueInfo::getGUID ( ) const
inline

Definition at line 197 of file ModuleSummaryIndex.h.

References getRef().

Referenced by llvm::AliasSummary::getAliaseeGUID().

◆ getRef()

const GlobalValueSummaryMapTy::value_type * llvm::ValueInfo::getRef ( ) const
inline

Definition at line 245 of file ModuleSummaryIndex.h.

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

Referenced by getGUID(), getSummaryList(), getValue(), name(), and operator bool().

◆ getSummaryList()

ArrayRef< std::unique_ptr< GlobalValueSummary > > llvm::ValueInfo::getSummaryList ( ) const
inline

Definition at line 203 of file ModuleSummaryIndex.h.

References getRef().

Referenced by canAutoHide(), llvm::yaml::CustomMappingTraits< GlobalValueSummaryMapTy >::fixAliaseeLinks(), getELFVisibility(), llvm::AliasSummary::hasAliasee(), isDSOLocal(), and mustBeUnreachableFunction().

◆ getValue()

const GlobalValue * llvm::ValueInfo::getValue ( ) const
inline

Definition at line 198 of file ModuleSummaryIndex.h.

References assert(), getRef(), and haveGVs().

Referenced by hasName().

◆ hasName()

bool llvm::ValueInfo::hasName ( ) const
inline

Definition at line 209 of file ModuleSummaryIndex.h.

References getValue(), and haveGVs().

◆ haveGVs()

bool llvm::ValueInfo::haveGVs ( ) const
inline

Definition at line 217 of file ModuleSummaryIndex.h.

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

Referenced by getValue(), hasName(), and name().

◆ isDSOLocal()

bool ValueInfo::isDSOLocal ( bool  WithDSOLocalPropagation = false) const

Checks if all summaries are DSO local (have the flag set).

When DSOLocal propagation has been done, set the parameter to enable fast check.

Definition at line 55 of file ModuleSummaryIndex.cpp.

References llvm::all_of(), and getSummaryList().

◆ isReadOnly()

bool llvm::ValueInfo::isReadOnly ( ) const
inline

Definition at line 218 of file ModuleSummaryIndex.h.

References assert(), llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getInt(), isValidAccessSpecifier(), ReadOnly, and RefAndFlags.

Referenced by resolveFwdRef().

◆ isValidAccessSpecifier()

bool llvm::ValueInfo::isValidAccessSpecifier ( ) const
inline

Definition at line 230 of file ModuleSummaryIndex.h.

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

Referenced by getAccessSpecifier(), isReadOnly(), and isWriteOnly().

◆ isWriteOnly()

bool llvm::ValueInfo::isWriteOnly ( ) const
inline

Definition at line 222 of file ModuleSummaryIndex.h.

References assert(), llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getInt(), isValidAccessSpecifier(), RefAndFlags, and WriteOnly.

Referenced by resolveFwdRef().

◆ name()

StringRef llvm::ValueInfo::name ( ) const
inline

Definition at line 211 of file ModuleSummaryIndex.h.

References assert(), getRef(), and haveGVs().

◆ operator bool()

llvm::ValueInfo::operator bool ( ) const
inlineexplicit

Definition at line 195 of file ModuleSummaryIndex.h.

References getRef().

◆ setReadOnly()

void llvm::ValueInfo::setReadOnly ( )
inline

Definition at line 234 of file ModuleSummaryIndex.h.

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

Referenced by resolveFwdRef().

◆ setWriteOnly()

void llvm::ValueInfo::setWriteOnly ( )
inline

Definition at line 240 of file ModuleSummaryIndex.h.

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

Referenced by resolveFwdRef().

Member Data Documentation

◆ RefAndFlags

PointerIntPair<const GlobalValueSummaryMapTy::value_type *, 3, int> llvm::ValueInfo::RefAndFlags

Definition at line 187 of file ModuleSummaryIndex.h.

Referenced by getAccessSpecifier(), getRef(), haveGVs(), isReadOnly(), isValidAccessSpecifier(), isWriteOnly(), setReadOnly(), setWriteOnly(), and ValueInfo().

The documentation for this struct was generated from the following files:
Generated on Sat Aug 30 2025 19:49:38 for LLVM by doxygen 1.9.6