LLVM 20.0.0git
Public Member Functions | Static Public Member Functions | List of all members
llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > Class Template Reference

PointerIntPair - This class implements a pair of a pointer and small integer. More...

#include "llvm/ADT/PointerIntPair.h"

Inheritance diagram for llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >:
Inheritance graph
[legend]

Public Member Functions

constexpr PointerIntPair ()=default
 
 PointerIntPair (PointerTy PtrVal, IntType IntVal)
 
 PointerIntPair (PointerTy PtrVal)
 
PointerTy getPointer () const
 
IntType getInt () const
 
void setPointer (PointerTy PtrVal) &
 
void setInt (IntType IntVal) &
 
void initWithPointer (PointerTy PtrVal) &
 
void setPointerAndInt (PointerTy PtrVal, IntType IntVal) &
 
PointerTy const * getAddrOfPointer () const
 
PointerTy * getAddrOfPointer ()
 
void * getOpaqueValue () const
 
void setFromOpaqueValue (void *Val) &
 
bool operator== (const PointerIntPair &RHS) const
 
bool operator!= (const PointerIntPair &RHS) const
 
bool operator< (const PointerIntPair &RHS) const
 
bool operator> (const PointerIntPair &RHS) const
 
bool operator<= (const PointerIntPair &RHS) const
 
bool operator>= (const PointerIntPair &RHS) const
 

Static Public Member Functions

static PointerIntPair getFromOpaqueValue (void *V)
 
static PointerIntPair getFromOpaqueValue (const void *V)
 

Detailed Description

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
class llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >

PointerIntPair - This class implements a pair of a pointer and small integer.

It is designed to represent this in the space required by one pointer by bitmangling the integer into the low part of the pointer. This can only be done for small integers: typically up to 3 bits, but it depends on the number of bits available according to PointerLikeTypeTraits for the type.

Note that PointerIntPair always puts the IntVal part in the highest bits possible. For example, PointerIntPair<void*, 1, bool> will put the bit for the bool into bit #2, not bit #0, which allows the low two bits to be used for something else. For example, this allows: PointerIntPair<PointerIntPair<void*, 1, bool>, 1, bool> ... and the two bools will land in different bits.

Definition at line 80 of file PointerIntPair.h.

Constructor & Destructor Documentation

◆ PointerIntPair() [1/3]

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
constexpr llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::PointerIntPair ( )
constexprdefault

◆ PointerIntPair() [2/3]

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::PointerIntPair ( PointerTy  PtrVal,
IntType  IntVal 
)
inline

Definition at line 88 of file PointerIntPair.h.

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

◆ PointerIntPair() [3/3]

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::PointerIntPair ( PointerTy  PtrVal)
inlineexplicit

Definition at line 92 of file PointerIntPair.h.

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

Member Function Documentation

◆ getAddrOfPointer() [1/2]

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
PointerTy * llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getAddrOfPointer ( )
inline

Definition at line 119 of file PointerIntPair.h.

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

◆ getAddrOfPointer() [2/2]

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
PointerTy const * llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getAddrOfPointer ( ) const
inline

Definition at line 115 of file PointerIntPair.h.

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

Referenced by llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getAddrOfPointer().

◆ getFromOpaqueValue() [1/2]

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
static PointerIntPair llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getFromOpaqueValue ( const void *  V)
inlinestatic

Definition at line 142 of file PointerIntPair.h.

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

◆ getFromOpaqueValue() [2/2]

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
static PointerIntPair llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getFromOpaqueValue ( void *  V)
inlinestatic

Definition at line 134 of file PointerIntPair.h.

References P.

Referenced by llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getFromOpaqueValue(), and llvm::PointerLikeTypeTraits< PointerIntPair< PointerTy, IntBits, IntType, PtrTraits > >::getFromVoidPointer().

◆ getInt()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
IntType llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getInt ( ) const
inline

Definition at line 96 of file PointerIntPair.h.

Referenced by llvm::GlobalsAAResult::FunctionInfo::addModRefInfo(), emitNonLazySymbolPointer(), llvm::get(), llvm::ValueInfo::getAccessSpecifier(), llvm::cfg::Update< NodePtr >::getKind(), llvm::GlobalsAAResult::FunctionInfo::getModRefInfo(), llvm::ValueInfo::haveGVs(), llvm::MCSectionELF::isComdat(), llvm::RecordVal::isNonconcreteOK(), llvm::ValueInfo::isReadOnly(), llvm::RegionNodeBase< Tr >::isSubRegion(), llvm::RecordVal::isTemplateArg(), llvm::ValueInfo::isValidAccessSpecifier(), llvm::ValueInfo::isWriteOnly(), llvm::GlobalsAAResult::FunctionInfo::mayReadAnyGlobal(), llvm::GlobalsAAResult::FunctionInfo::setMayReadAnyGlobal(), llvm::ValueInfo::setReadOnly(), llvm::ValueInfo::setWriteOnly(), llvm::IntervalMapImpl::NodeRef::size(), and llvm::PtrUseVisitor< DerivedT >::visitPtr().

◆ getOpaqueValue()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
void * llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getOpaqueValue ( ) const
inline

Definition at line 126 of file PointerIntPair.h.

Referenced by llvm::IntervalMapImpl::NodeRef::operator bool(), and llvm::IRPosition::operator void *().

◆ getPointer()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
PointerTy llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getPointer ( ) const
inline

Definition at line 94 of file PointerIntPair.h.

Referenced by llvm::GlobalsAAResult::FunctionInfo::addFunctionInfo(), llvm::GlobalsAAResult::FunctionInfo::addModRefInfoForGlobal(), emitNonLazySymbolPointer(), llvm::GlobalsAAResult::FunctionInfo::eraseModRefInfoForGlobal(), llvm::GlobalsAAResult::FunctionInfo::FunctionInfo(), llvm::IntervalMapImpl::NodeRef::get(), llvm::get(), llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getAddrOfPointer(), llvm::TargetLoweringObjectFileMachO::getCFIPersonalitySymbol(), llvm::RegionNodeBase< Tr >::getEntry(), llvm::MCSectionELF::getGroup(), llvm::TargetLoweringObjectFileMachO::getIndirectSymViaGOTPCRel(), llvm::GlobalsAAResult::FunctionInfo::getModRefInfoForGlobal(), llvm::ValueInfo::getRef(), llvm::cfg::Update< NodePtr >::getTo(), llvm::TargetLoweringObjectFileELF::getTTypeGlobalReference(), llvm::TargetLoweringObjectFileMachO::getTTypeGlobalReference(), llvm::SparcELFTargetObjectFile::getTTypeGlobalReference(), llvm::RecordVal::getType(), llvm::SlotIndex::isValid(), llvm::GlobalsAAResult::FunctionInfo::operator=(), llvm::IntervalMapImpl::NodeRef::operator==(), llvm::IntervalMapImpl::NodeRef::subtree(), llvm::PtrUseVisitor< DerivedT >::visitPtr(), and llvm::GlobalsAAResult::FunctionInfo::~FunctionInfo().

◆ initWithPointer()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
void llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::initWithPointer ( PointerTy  PtrVal) &
inline

Definition at line 106 of file PointerIntPair.h.

Referenced by llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::PointerIntPair().

◆ operator!=()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::operator!= ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &  RHS) const
inline

Definition at line 151 of file PointerIntPair.h.

References RHS.

◆ operator<()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::operator< ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &  RHS) const
inline

Definition at line 155 of file PointerIntPair.h.

References RHS.

◆ operator<=()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::operator<= ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &  RHS) const
inline

Definition at line 158 of file PointerIntPair.h.

References RHS.

◆ operator==()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::operator== ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &  RHS) const
inline

Definition at line 147 of file PointerIntPair.h.

References RHS.

◆ operator>()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::operator> ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &  RHS) const
inline

Definition at line 156 of file PointerIntPair.h.

References RHS.

◆ operator>=()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::operator>= ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &  RHS) const
inline

Definition at line 162 of file PointerIntPair.h.

References RHS.

◆ setFromOpaqueValue()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
void llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setFromOpaqueValue ( void *  Val) &
inline

Definition at line 130 of file PointerIntPair.h.

◆ setInt()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
void llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setInt ( IntType  IntVal) &
inline

Definition at line 102 of file PointerIntPair.h.

Referenced by llvm::GlobalsAAResult::FunctionInfo::addModRefInfo(), llvm::GlobalsAAResult::FunctionInfo::setMayReadAnyGlobal(), llvm::ValueInfo::setReadOnly(), llvm::IntervalMapImpl::NodeRef::setSize(), llvm::ValueInfo::setWriteOnly(), and llvm::ValueInfo::ValueInfo().

◆ setPointer()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
void llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setPointer ( PointerTy  PtrVal) &
inline

Definition at line 98 of file PointerIntPair.h.

Referenced by llvm::GlobalsAAResult::FunctionInfo::addModRefInfoForGlobal(), llvm::GlobalsAAResult::FunctionInfo::FunctionInfo(), llvm::GlobalsAAResult::FunctionInfo::operator=(), and llvm::ValueInfo::ValueInfo().

◆ setPointerAndInt()

template<typename PointerTy , unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>, typename Info = PointerIntPairInfo<PointerTy, IntBits, PtrTraits>>
void llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::setPointerAndInt ( PointerTy  PtrVal,
IntType  IntVal 
) &
inline

Definition at line 110 of file PointerIntPair.h.

Referenced by llvm::GlobalsAAResult::FunctionInfo::operator=(), and llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::PointerIntPair().

The documentation for this class was generated from the following file:
Generated on Mon Jun 16 2025 22:06:30 for LLVM by doxygen 1.9.6