clang 22.0.0git
Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::interp::Pointer Class Reference

A pointer to a memory block, live or dead. More...

#include "/work/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/AST/ByteCode/Pointer.h"

Public Member Functions

 Pointer ()
 Pointer (IntPointer &&IntPtr)
 Pointer (Block *B)
 Pointer (Block *B, uint64_t BaseAndOffset)
 Pointer (const Pointer &P)
 Pointer (Pointer &&P)
 Pointer (uint64_t Address, const Descriptor *Desc, uint64_t Offset=0)
 Pointer (const Function *F, uint64_t Offset=0)
 Pointer (const Type *TypePtr, const Type *TypeInfoType, uint64_t Offset=0)
 Pointer (Block *Pointee, unsigned Base, uint64_t Offset)
 ~Pointer ()
Pointer & operator= (const Pointer &P)
Pointer & operator= (Pointer &&P)
bool operator== (const Pointer &P) const
 Equality operators are just for tests.
bool operator!= (const Pointer &P) const
APValue toAPValue (const ASTContext &ASTCtx) const
 Converts the pointer to an APValue.
std::string toDiagnosticString (const ASTContext &Ctx) const
 Converts the pointer to a string usable in diagnostics.
uint64_t getIntegerRepresentation () const
std::optional< APValue > toRValue (const Context &Ctx, QualType ResultType) const
 Converts the pointer to an APValue that is an rvalue.
Pointer atIndex (uint64_t Idx) const
 Offsets a pointer inside an array.
Pointer atField (unsigned Off) const
 Creates a pointer to a field.
Pointer atFieldSub (unsigned Off) const
 Subtract the given offset from the current Base and Offset of the pointer.
Pointer narrow () const
 Restricts the scope of an array element pointer.
Pointer expand () const
 Expands a pointer to the containing array, undoing narrowing.
bool isZero () const
 Checks if the pointer is null.
bool isLive () const
 Checks if the pointer is live.
bool isField () const
 Checks if the item is a field in an object.
const Descriptor * getDeclDesc () const
 Accessor for information about the declaration site.
SourceLocation getDeclLoc () const
DeclTy getSource () const
 Returns the expression or declaration the pointer has been created for.
Pointer getBase () const
 Returns a pointer to the object of which this pointer is a field.
Pointer getArray () const
 Returns the parent array.
const Descriptor * getFieldDesc () const
 Accessors for information about the innermost field.
QualType getType () const
 Returns the type of the innermost field.
Pointer getDeclPtr () const
size_t elemSize () const
 Returns the element size of the innermost field.
size_t getSize () const
 Returns the total size of the innermost field.
unsigned getOffset () const
 Returns the offset into an array.
bool isArrayRoot () const
 Whether this array refers to an array, but not to the first element.
bool inArray () const
 Checks if the innermost field is an array.
bool inUnion () const
bool inPrimitiveArray () const
 Checks if the structure is a primitive array.
bool isUnknownSizeArray () const
 Checks if the structure is an array of unknown size.
bool isArrayElement () const
 Checks if the pointer points to an array.
bool isRoot () const
 Pointer points directly to a block.
bool canBeInitialized () const
 If this pointer has an InlineDescriptor we can use to initialize.
const BlockPointer & asBlockPointer () const
const IntPointer & asIntPointer () const
const FunctionPointer & asFunctionPointer () const
const TypeidPointer & asTypeidPointer () const
bool isBlockPointer () const
bool isIntegralPointer () const
bool isFunctionPointer () const
bool isTypeidPointer () const
const Record * getRecord () const
 Returns the record descriptor of a class.
const Record * getElemRecord () const
 Returns the element record type, if this is a non-primive array.
const FieldDecl * getField () const
 Returns the field information.
bool isExtern () const
 Checks if the storage is extern.
bool isStatic () const
 Checks if the storage is static.
bool isTemporary () const
 Checks if the storage is temporary.
bool isDynamic () const
 Checks if the storage has been dynamically allocated.
bool isStaticTemporary () const
 Checks if the storage is a static temporary.
bool isMutable () const
 Checks if the field is mutable.
bool isWeak () const
bool isActive () const
 Checks if the object is active.
bool isBaseClass () const
 Checks if a structure is a base class.
bool isVirtualBaseClass () const
bool isDummy () const
 Checks if the pointer points to a dummy value.
bool isConst () const
 Checks if an object or a subfield is mutable.
bool isConstInMutable () const
bool isVolatile () const
 Checks if an object or a subfield is volatile.
UnsignedOrNone getDeclID () const
 Returns the declaration ID.
uint64_t getByteOffset () const
 Returns the byte offset from the start.
unsigned getNumElems () const
 Returns the number of elements.
const Block * block () const
const std::byte * getRawAddress () const
 If backed by actual data (i.e.
int64_t getIndex () const
 Returns the index into an array.
bool isOnePastEnd () const
 Checks if the index is one past end.
bool isPastEnd () const
 Checks if the pointer points past the end of the object.
bool isElementPastEnd () const
 Checks if the pointer is an out-of-bounds element pointer.
bool isZeroSizeArray () const
 Checks if the pointer is pointing to a zero-size array.
template<typename T>
T & deref () const
 Dereferences the pointer, if it's live.
template<typename T>
T & elem (unsigned I) const
 Dereferences the element at index I.
bool isDereferencable () const
 Whether this block can be read from at all.
void initialize () const
 Initializes a field.
void initializeElement (unsigned Index) const
 Initialized the given element of a primitive array.
void initializeAllElements () const
 Initialize all elements of a primitive array at once.
bool isInitialized () const
 Checks if an object was initialized.
bool isElementInitialized (unsigned Index) const
 Like isInitialized(), but for primitive arrays.
bool allElementsInitialized () const
void activate () const
 Activats a field.
void deactivate () const
 Deactivates an entire strurcutre.
Lifetime getLifetime () const
void endLifetime () const
void startLifetime () const
ComparisonCategoryResult compare (const Pointer &Other) const
 Compare two pointers.
bool pointsToLiteral () const
 Whether this points to a block that's been created for a "literal lvalue", i.e.
bool pointsToStringLiteral () const
void print (llvm::raw_ostream &OS) const
 Prints the pointer.
size_t computeOffsetForComparison () const
 Compute an integer that can be used to compare this pointer to another one.

Static Public Member Functions

static bool hasSameBase (const Pointer &A, const Pointer &B)
 Checks if two pointers are comparable.
static bool hasSameArray (const Pointer &A, const Pointer &B)
 Checks if two pointers can be subtracted.
static bool pointToSameBlock (const Pointer &A, const Pointer &B)
 Checks if both given pointers point to the same block.
static std::optional< std::pair< Pointer, Pointer > > computeSplitPoint (const Pointer &A, const Pointer &B)

Friends

class Block
class DeadBlock
class MemberPointer
class InterpState
struct InitMap
class DynamicAllocator
class Program

Detailed Description

A pointer to a memory block, live or dead.

This object can be allocated into interpreter stack frames. If pointing to a live block, it is a link in the chain of pointers pointing to the block.

In the simplest form, a Pointer has a Block* (the pointee) and both Base and Offset are 0, which means it will point to raw data.

The Base field is used to access metadata about the data. For primitive arrays, the Base is followed by an InitMap. In a variety of cases, the Base is preceded by an InlineDescriptor, which is used to track the initialization state, among other things.

The Offset field is used to access the actual data. In other words, the data the pointer decribes can be found at Pointee->rawData() + Pointer.Offset.

/// Pointee                      Offset
/// │                              │
/// │                              │
/// ▼                              ▼
/// ┌───────┬────────────┬─────────┬────────────────────────────┐
/// │ Block │ InlineDesc │ InitMap │ Actual Data                │
/// └───────┴────────────┴─────────┴────────────────────────────┘
///                      ▲
///                      │
///                      │
///                     Base
///

Definition at line 92 of file Pointer.h.

Constructor & Destructor Documentation

◆ Pointer() [1/10]

clang::interp::Pointer::Pointer ( )
inline

Definition at line 98 of file Pointer.h.

References Int, and clang::nullptr.

Referenced by activate(), atField(), atFieldSub(), atIndex(), compare(), computeOffsetForComparison(), computeSplitPoint(), expand(), getArray(), getBase(), getDeclPtr(), hasSameArray(), hasSameBase(), narrow(), operator!=(), operator=(), operator=(), operator==(), Pointer(), Pointer(), Pointer(), Pointer(), pointToSameBlock(), toAPValue(), and toRValue().

◆ Pointer() [2/10]

clang::interp::Pointer::Pointer ( IntPointer && IntPtr)
inline

Definition at line 99 of file Pointer.h.

References Int.

◆ Pointer() [3/10]

Pointer::Pointer ( Block * B)

Definition at line 26 of file Pointer.cpp.

References Block, and Pointer().

◆ Pointer() [4/10]

Pointer::Pointer ( Block * B,
uint64_t BaseAndOffset )

Definition at line 30 of file Pointer.cpp.

References Block, and Pointer().

◆ Pointer() [5/10]

Pointer::Pointer ( const Pointer & P)

Definition at line 44 of file Pointer.cpp.

References clang::interp::Block, BS, Fn, clang::interp::Fn, Int, clang::interp::Int, Pointer(), Typeid, and clang::interp::Typeid.

◆ Pointer() [6/10]

Pointer::Pointer ( Pointer && P)

Definition at line 64 of file Pointer.cpp.

References clang::interp::Block, BS, Fn, clang::interp::Fn, Int, clang::interp::Int, Pointer(), Typeid, and clang::interp::Typeid.

◆ Pointer() [7/10]

clang::interp::Pointer::Pointer ( uint64_t Address,
const Descriptor * Desc,
uint64_t Offset = 0 )
inline

Definition at line 105 of file Pointer.h.

References Int.

◆ Pointer() [8/10]

clang::interp::Pointer::Pointer ( const Function * F,
uint64_t Offset = 0 )
inline

Definition at line 107 of file Pointer.h.

References Fn.

◆ Pointer() [9/10]

clang::interp::Pointer::Pointer ( const Type * TypePtr,
const Type * TypeInfoType,
uint64_t Offset = 0 )
inline

Definition at line 109 of file Pointer.h.

References Typeid.

◆ Pointer() [10/10]

Pointer::Pointer ( Block * Pointee,
unsigned Base,
uint64_t Offset )

Definition at line 33 of file Pointer.cpp.

References Block, BS, clang::interp::Block::getDescriptor(), and clang::interp::Descriptor::getMetadataSize().

◆ ~Pointer()

Pointer::~Pointer ( )

Definition at line 83 of file Pointer.cpp.

References Block, BS, and isBlockPointer().

Member Function Documentation

◆ activate()

void Pointer::activate ( ) const

Activats a field.

Definition at line 577 of file Pointer.cpp.

References activate(), atField(), BS, deactivate(), std::function, getBase(), getRecord(), inUnion(), clang::interp::InlineDescriptor::IsActive, isRoot(), clang::interp::Record::isUnion(), and Pointer().

Referenced by clang::interp::Activate(), activate(), clang::interp::ActivateThisField(), clang::interp::CheckNewTypeMismatch(), clang::interp::copyRecord(), clang::interp::FinishInitActivate(), clang::interp::FinishInitActivatePop(), clang::interp::FinishInitGlobal(), and clang::interp::InitBitFieldActivate().

◆ allElementsInitialized()

bool Pointer::allElementsInitialized ( ) const

Definition at line 559 of file Pointer.cpp.

References block(), BS, getFieldDesc(), clang::interp::Initialized, clang::interp::GlobalInlineDescriptor::InitState, isArrayRoot(), isRoot(), isStatic(), and clang::interp::Block::rawData().

Referenced by clang::interp::CheckArrayInitialized().

◆ asBlockPointer()

const BlockPointer & clang::interp::Pointer::asBlockPointer ( ) const
inlinenodiscard

Definition at line 456 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by clang::interp::DynamicAllocator::cleanup(), computeSplitPoint(), clang::interp::DeadBlock::DeadBlock(), hasSameBase(), initialize(), isInitialized(), and clang::interp::OffsetHelper().

◆ asFunctionPointer()

const FunctionPointer & clang::interp::Pointer::asFunctionPointer ( ) const
inlinenodiscard

Definition at line 464 of file Pointer.h.

References Fn, and isFunctionPointer().

Referenced by clang::interp::CallPtr(), clang::interp::OffsetHelper(), print(), toAPValue(), and toDiagnosticString().

◆ asIntPointer()

const IntPointer & clang::interp::Pointer::asIntPointer ( ) const
inlinenodiscard

Definition at line 460 of file Pointer.h.

References Int, and isIntegralPointer().

Referenced by clang::interp::getField(), clang::interp::GetPtrBase(), clang::interp::GetPtrBasePop(), clang::interp::OffsetHelper(), toAPValue(), and toDiagnosticString().

◆ asTypeidPointer()

const TypeidPointer & clang::interp::Pointer::asTypeidPointer ( ) const
inlinenodiscard

Definition at line 468 of file Pointer.h.

References isTypeidPointer(), and Typeid.

Referenced by computeOffsetForComparison(), and print().

◆ atField()

Pointer clang::interp::Pointer::atField ( unsigned Off) const
inlinenodiscard

Creates a pointer to a field.

Definition at line 174 of file Pointer.h.

References BS, isBlockPointer(), and Pointer().

Referenced by activate(), clang::interp::ActivateThisField(), clang::interp::CheckFieldsInitialized(), clang::interp::collectBlocks(), clang::interp::copyRecord(), clang::interp::endLifetimeRecurse(), enumerateData(), clang::interp::finishGlobalRecurse(), clang::interp::MemberPointer::getBase(), clang::interp::GetField(), clang::interp::getField(), clang::interp::GetFieldPop(), clang::interp::GetPtrBase(), clang::interp::GetPtrBasePop(), clang::interp::InitBitField(), clang::interp::InitBitFieldActivate(), clang::interp::InitField(), clang::interp::InitFieldActivate(), clang::interp::SetField(), clang::interp::SetThreeWayComparisonField(), clang::interp::startLifetimeRecurse(), clang::interp::MemberPointer::toPointer(), and clang::interp::zeroAll().

◆ atFieldSub()

Pointer clang::interp::Pointer::atFieldSub ( unsigned Off) const
inlinenodiscard

Subtract the given offset from the current Base and Offset of the pointer.

Definition at line 182 of file Pointer.h.

References BS, and Pointer().

Referenced by clang::interp::MemberPointer::getBase(), and clang::interp::GetPtrDerivedPop().

◆ atIndex()

Pointer clang::interp::Pointer::atIndex ( uint64_t Idx) const
inlinenodiscard

Offsets a pointer inside an array.

Definition at line 157 of file Pointer.h.

References BS, elemSize(), Fn, getDeclDesc(), getFieldDesc(), getSize(), Int, isFunctionPointer(), isIntegralPointer(), and Pointer().

Referenced by clang::interp::arePotentiallyOverlappingStringLiterals(), clang::interp::ArrayDecay(), clang::interp::ArrayElem(), clang::interp::ArrayElemPop(), clang::interp::CheckArrayInitialized(), clang::interp::collectBlocks(), clang::interp::CopyArray(), clang::interp::copyComposite(), clang::interp::endLifetimeRecurse(), enumerateData(), clang::interp::finishGlobalRecurse(), clang::interp::interp__builtin_elementwise_countzeroes(), clang::interp::interp__builtin_is_aligned_up_down(), clang::interp::interp__builtin_memchr(), clang::interp::interp__builtin_nan(), clang::interp::interp__builtin_object_size(), clang::interp::interp__builtin_strcmp(), clang::interp::interp__builtin_strlen(), clang::interp::OffsetHelper(), clang::interp::RunDestructors(), clang::interp::startLifetimeRecurse(), and clang::interp::zeroAll().

◆ block()

const Block * clang::interp::Pointer::block ( ) const
inline

Definition at line 607 of file Pointer.h.

References Block, and BS.

Referenced by allElementsInitialized(), clang::interp::Call(), clang::interp::CallVirt(), clang::interp::CheckConst(), clang::interp::CheckDestructor(), clang::interp::CheckFinalLoad(), clang::interp::CheckLoad(), clang::interp::CheckMutable(), clang::interp::CheckNewTypeMismatch(), clang::interp::CheckStore(), clang::interp::collectBlocks(), clang::interp::Program::dump(), clang::interp::Free(), clang::interp::getField(), clang::interp::interp__builtin_is_within_lifetime(), clang::interp::interp__builtin_operator_delete(), clang::interp::interp__builtin_strlen(), isElementInitialized(), isInitialized(), operator=(), pointsToLiteral(), pointsToStringLiteral(), pointToSameBlock(), toAPValue(), and clang::interp::MemberPointer::toPointer().

◆ canBeInitialized()

bool clang::interp::Pointer::canBeInitialized ( ) const
inline

If this pointer has an InlineDescriptor we can use to initialize.

Definition at line 449 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by clang::interp::Activate(), clang::interp::ActivateThisField(), clang::interp::FinishInit(), clang::interp::FinishInitActivate(), clang::interp::FinishInitActivatePop(), clang::interp::FinishInitGlobal(), clang::interp::FinishInitPop(), and clang::interp::interp__builtin_overflowop().

◆ compare()

ComparisonCategoryResult clang::interp::Pointer::compare ( const Pointer & Other) const
inline

Compare two pointers.

Definition at line 754 of file Pointer.h.

References clang::Equal, clang::Greater, hasSameBase(), clang::Less, clang::Other, Pointer(), and clang::Unordered.

◆ computeOffsetForComparison()

size_t Pointer::computeOffsetForComparison ( ) const

Compute an integer that can be used to compare this pointer to another one.

This is usually NOT the same as the pointer offset regarding the AST record layout.

Definition at line 365 of file Pointer.cpp.

References asTypeidPointer(), clang::interp::Block, elemSize(), expand(), Fn, clang::interp::Fn, getArray(), getBase(), getIndex(), clang::interp::Record::getNumVirtualBases(), getRecord(), Int, clang::interp::Int, isArrayElement(), isBaseClass(), isOnePastEnd(), isRoot(), clang::interp::Record::isUnion(), isVirtualBaseClass(), clang::interp::InlineDescriptor::Offset, Pointer(), clang::Result, clang::interp::Typeid, and clang::interp::TypeidPointer::TypePtr.

Referenced by clang::interp::CmpHelperEQ< Pointer >().

◆ computeSplitPoint()

std::optional< std::pair< Pointer, Pointer > > Pointer::computeSplitPoint ( const Pointer & A,
const Pointer & B )
static

Definition at line 687 of file Pointer.cpp.

References asBlockPointer(), clang::interp::BlockPointer::Base, getBase(), isBlockPointer(), isRoot(), clang::interp::BlockPointer::Pointee, and Pointer().

Referenced by clang::interp::CmpHelper< Pointer >().

◆ deactivate()

void Pointer::deactivate ( ) const

Deactivates an entire strurcutre.

Definition at line 631 of file Pointer.cpp.

Referenced by activate().

◆ deref()

template<typename T>
T & clang::interp::Pointer::deref ( ) const
inline

Dereferences the pointer, if it's live.

Definition at line 668 of file Pointer.h.

References BS, isArrayRoot(), isBlockPointer(), isDereferencable(), isLive(), and clang::T.

Referenced by clang::interp::assignInteger(), clang::interp::collectBlocks(), clang::interp::copyComposite(), clang::interp::copyPrimitiveMemory(), clang::interp::copyPrimitiveMemory(), clang::interp::copyRecord(), clang::interp::DoBitCastPtr(), clang::interp::finishGlobalRecurse(), clang::interp::IncDecFloatHelper(), clang::interp::IncDecHelper(), clang::interp::IncDecPtrHelper(), clang::interp::InitField(), clang::interp::InitFieldActivate(), clang::interp::InitGlobal(), clang::interp::InitGlobalTemp(), clang::interp::interp__builtin_elementwise_countzeroes(), clang::interp::interp__builtin_memchr(), clang::interp::interp__builtin_nan(), clang::interp::interp__builtin_strcmp(), clang::interp::interp__builtin_strlen(), clang::interp::Load(), clang::interp::LoadPop(), clang::interp::readPointerToBuffer(), clang::interp::InterpFrame::setParam(), clang::interp::SetThreeWayComparisonField(), clang::interp::StoreActivate(), clang::interp::StoreActivatePop(), clang::interp::StoreBitFieldActivate(), clang::interp::StoreBitFieldActivatePop(), and toRValue().

◆ elem()

template<typename T>
T & clang::interp::Pointer::elem ( unsigned I) const
inline

Dereferences the element at index I.

This is equivalent to atIndex(I).deref<T>().

Definition at line 684 of file Pointer.h.

References BS, clang::interp::Descriptor::getElemSize(), getFieldDesc(), getNumElems(), isBlockPointer(), isDereferencable(), isLive(), and clang::T.

Referenced by clang::interp::ArrayElem(), clang::interp::ArrayElemPop(), clang::interp::collectBlocks(), clang::interp::convertBoolVectorToInt(), clang::interp::CopyArray(), clang::interp::copyComposite(), clang::interp::Program::createGlobalString(), clang::interp::Divc(), clang::interp::Context::evaluateString(), clang::interp::Context::evaluateStrlen(), clang::interp::interp__builtin_blend(), clang::interp::interp__builtin_elementwise_abs(), clang::interp::interp__builtin_elementwise_int_binop(), clang::interp::interp__builtin_elementwise_int_unaryop(), clang::interp::interp__builtin_elementwise_maxmin(), clang::interp::interp__builtin_elementwise_triop(), clang::interp::interp__builtin_elementwise_triop_fp(), clang::interp::interp__builtin_ia32_addsub(), clang::interp::interp__builtin_ia32_cmp_mask(), clang::interp::interp__builtin_ia32_cvt_vec2mask(), clang::interp::interp__builtin_ia32_cvtpd2ps(), clang::interp::interp__builtin_ia32_cvtsd2ss(), clang::interp::interp__builtin_ia32_multishiftqb(), clang::interp::interp__builtin_ia32_pmul(), clang::interp::interp__builtin_ia32_shift_with_count(), clang::interp::interp__builtin_ia32_shufbitqmb_mask(), clang::interp::interp__builtin_ia32_shuffle_generic(), clang::interp::interp__builtin_ia32_test_op(), clang::interp::interp__builtin_ia32_vcvtps2ph(), clang::interp::interp__builtin_ia32_vpconflict(), clang::interp::interp__builtin_select(), clang::interp::interp__builtin_select_scalar(), clang::interp::interp__builtin_vec_ext(), clang::interp::interp__builtin_vec_set(), clang::interp::interp__builtin_vector_reduce(), clang::interp::interp__builtin_x86_extract_vector(), clang::interp::interp__builtin_x86_extract_vector_masked(), clang::interp::interp__builtin_x86_insert_subvector(), clang::interp::interp__builtin_x86_pack(), clang::interp::interp_builtin_horizontal_fp_binop(), clang::interp::interp_builtin_horizontal_int_binop(), and clang::interp::Mulc().

◆ elemSize()

size_t clang::interp::Pointer::elemSize ( ) const
inline

Returns the element size of the innermost field.

Definition at line 363 of file Pointer.h.

References BS, getDeclDesc(), clang::interp::Descriptor::getElemSize(), getFieldDesc(), clang::interp::Descriptor::getSize(), Int, and isIntegralPointer().

Referenced by clang::interp::arePotentiallyOverlappingStringLiterals(), atIndex(), computeOffsetForComparison(), clang::interp::Context::evaluateString(), clang::interp::Context::evaluateStrlen(), getIndex(), getIntegerRepresentation(), getNumElems(), clang::interp::interp__builtin_memcpy(), and clang::interp::OffsetHelper().

◆ endLifetime()

void clang::interp::Pointer::endLifetime ( ) const
inline

Definition at line 737 of file Pointer.h.

References BS, clang::interp::Ended, and isBlockPointer().

Referenced by clang::interp::endLifetimeRecurse().

◆ expand()

Pointer clang::interp::Pointer::expand ( ) const
inlinenodiscard

Expands a pointer to the containing array, undoing narrowing.

Definition at line 224 of file Pointer.h.

References Block, BS, getDeclDesc(), clang::interp::Block::getDescriptor(), getSize(), inPrimitiveArray(), clang::interp::Descriptor::IsArray, isBlockPointer(), isElementPastEnd(), isRoot(), Next, and Pointer().

Referenced by computeOffsetForComparison(), clang::interp::computePointerOffset(), clang::interp::ExpandPtr(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_object_size(), clang::interp::pointsToLastObject(), and toAPValue().

◆ getArray()

Pointer clang::interp::Pointer::getArray ( ) const
inlinenodiscard

Returns the parent array.

Definition at line 321 of file Pointer.h.

References BS, and Pointer().

Referenced by computeOffsetForComparison(), clang::interp::computePointerOffset(), clang::interp::pointsToLastObject(), and toAPValue().

◆ getBase()

Pointer clang::interp::Pointer::getBase ( ) const
inlinenodiscard

Returns a pointer to the object of which this pointer is a field.

Definition at line 312 of file Pointer.h.

References BS, and Pointer().

Referenced by activate(), clang::interp::CallVirt(), clang::interp::CheckActive(), clang::interp::CheckNewTypeMismatch(), clang::interp::CheckVolatile(), computeOffsetForComparison(), clang::interp::computePointerOffset(), computeSplitPoint(), clang::interp::Free(), clang::interp::GetDynamicDecl(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_object_size(), clang::interp::pointsToLastObject(), and toAPValue().

◆ getByteOffset()

uint64_t clang::interp::Pointer::getByteOffset ( ) const
inline

Returns the byte offset from the start.

Definition at line 590 of file Pointer.h.

References Int, isIntegralPointer(), isOnePastEnd(), isTypeidPointer(), and Typeid.

Referenced by clang::interp::CheckDowncast(), clang::interp::CmpHelper< Pointer >(), clang::interp::getField(), and clang::interp::OffsetHelper().

◆ getDeclDesc()

const Descriptor * clang::interp::Pointer::getDeclDesc ( ) const
inline

Accessor for information about the declaration site.

Definition at line 287 of file Pointer.h.

References BS, Int, isBlockPointer(), isFunctionPointer(), isIntegralPointer(), and isTypeidPointer().

Referenced by atIndex(), clang::interp::CheckBCPResult(), clang::interp::CheckConstant(), clang::interp::CheckDowncast(), clang::interp::CheckExtern(), clang::interp::CheckFieldsInitialized(), clang::interp::CheckLiteralType(), clang::interp::Destroy(), clang::interp::DiagnoseUninitialized(), elemSize(), expand(), clang::interp::Free(), getDeclLoc(), clang::interp::GetDynamicDecl(), getFieldDesc(), clang::interp::GetPtrDerivedPop(), getSource(), clang::interp::InitGlobalTemp(), clang::interp::InitGlobalTempComp(), clang::interp::interp__builtin_assume_aligned(), clang::interp::interp__builtin_is_aligned_up_down(), clang::interp::interp__builtin_is_within_lifetime(), clang::interp::interp__builtin_object_size(), clang::interp::interp__builtin_operator_delete(), isConst(), clang::interp::isConstexprUnknown(), isVolatile(), and toAPValue().

◆ getDeclID()

UnsignedOrNone clang::interp::Pointer::getDeclID ( ) const
inline

Returns the declaration ID.

Definition at line 581 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by clang::interp::CheckConstant(), and CheckGlobal().

◆ getDeclLoc()

SourceLocation clang::interp::Pointer::getDeclLoc ( ) const
inline

Definition at line 297 of file Pointer.h.

References getDeclDesc(), and clang::interp::Descriptor::getLocation().

Referenced by clang::interp::CheckDeleteSource(), and clang::interp::CheckLive().

◆ getDeclPtr()

Pointer clang::interp::Pointer::getDeclPtr ( ) const
inlinenodiscard

Definition at line 360 of file Pointer.h.

References BS, and Pointer().

Referenced by clang::interp::CheckDowncast(), and toAPValue().

◆ getElemRecord()

const Record * clang::interp::Pointer::getElemRecord ( ) const
inline

Returns the element record type, if this is a non-primive array.

Definition at line 481 of file Pointer.h.

References clang::interp::Descriptor::ElemDesc, clang::interp::Descriptor::ElemRecord, and getFieldDesc().

Referenced by clang::interp::CheckArrayInitialized().

◆ getField()

const FieldDecl * clang::interp::Pointer::getField ( ) const
inline

Returns the field information.

Definition at line 486 of file Pointer.h.

References getFieldDesc().

Referenced by clang::interp::CheckArrayInitialized(), clang::interp::CheckMutable(), clang::interp::CheckVolatile(), clang::interp::computePointerOffset(), clang::interp::DoBitCastPtr(), and clang::interp::pointsToLastObject().

◆ getFieldDesc()

const Descriptor * clang::interp::Pointer::getFieldDesc ( ) const
inline

Accessors for information about the innermost field.

Definition at line 331 of file Pointer.h.

References getDeclDesc(), Int, isIntegralPointer(), and isRoot().

Referenced by allElementsInitialized(), clang::interp::ArrayElem(), clang::interp::ArrayElemPop(), atIndex(), clang::interp::CallVirt(), clang::interp::checkConstructor(), clang::interp::CheckNewTypeMismatch(), clang::interp::CheckVolatile(), clang::interp::CmpHelperEQ< Pointer >(), clang::interp::collectBlocks(), clang::interp::computePointerOffset(), clang::interp::convertBoolVectorToInt(), clang::interp::copyComposite(), clang::interp::copyRecord(), clang::interp::DoBitCast(), clang::interp::DoBitCastPtr(), elem(), elemSize(), clang::interp::endLifetimeRecurse(), enumerateData(), clang::interp::Context::evaluateString(), clang::interp::Context::evaluateStrlen(), clang::interp::finishGlobalRecurse(), getElemRecord(), clang::interp::getElemType(), clang::interp::getField(), getField(), getOffset(), getRecord(), getSize(), getType(), hasSameArray(), inArray(), initialize(), initializeAllElements(), initializeElement(), inPrimitiveArray(), clang::interp::interp__builtin_elementwise_abs(), clang::interp::interp__builtin_elementwise_countzeroes(), clang::interp::interp__builtin_elementwise_int_unaryop(), clang::interp::interp__builtin_ia32_cvt_vec2mask(), clang::interp::interp__builtin_ia32_vcvtps2ph(), clang::interp::interp__builtin_memchr(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_nan(), clang::interp::interp__builtin_object_size(), clang::interp::interp__builtin_operator_delete(), clang::interp::interp__builtin_select(), clang::interp::interp__builtin_strcmp(), clang::interp::interp__builtin_strlen(), clang::interp::interp__builtin_vec_ext(), clang::interp::interp__builtin_vector_reduce(), clang::interp::interp__builtin_x86_extract_vector(), clang::interp::interp__builtin_x86_extract_vector_masked(), clang::interp::interp__builtin_x86_insert_subvector(), isElementInitialized(), isField(), isInitialized(), isUnknownSizeArray(), clang::interp::isUserWritingOffTheEnd(), isZeroSizeArray(), clang::interp::Load(), clang::interp::LoadPop(), clang::interp::OffsetHelper(), clang::interp::operator<<(), clang::interp::startLifetimeRecurse(), toAPValue(), toRValue(), and clang::interp::zeroAll().

◆ getIndex()

int64_t clang::interp::Pointer::getIndex ( ) const
inline

Returns the index into an array.

Definition at line 617 of file Pointer.h.

References BS, elemSize(), getIntegerRepresentation(), getOffset(), isBlockPointer(), and isZero().

Referenced by clang::interp::arePotentiallyOverlappingStringLiterals(), clang::interp::CheckBCPResult(), computeOffsetForComparison(), clang::interp::computePointerOffset(), enumerateData(), clang::interp::Context::evaluateString(), clang::interp::Context::evaluateStrlen(), clang::interp::Free(), initialize(), clang::interp::interp__builtin_is_aligned_up_down(), clang::interp::interp__builtin_memchr(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_strcmp(), clang::interp::interp__builtin_strlen(), isInitialized(), clang::interp::OffsetHelper(), clang::interp::SubPtr(), and toAPValue().

◆ getIntegerRepresentation()

uint64_t clang::interp::Pointer::getIntegerRepresentation ( ) const
inline

Definition at line 144 of file Pointer.h.

References BS, elemSize(), Fn, Int, isFunctionPointer(), and isIntegralPointer().

Referenced by clang::interp::CastPointerIntegral(), clang::interp::CastPointerIntegralAP(), clang::interp::CastPointerIntegralAPS(), clang::interp::CmpHelperEQ< Pointer >(), getIndex(), clang::interp::interp__builtin_atomic_lock_free(), clang::interp::interp__builtin_memcpy(), clang::interp::OffsetHelper(), and clang::interp::SubPtr().

◆ getLifetime()

Lifetime clang::interp::Pointer::getLifetime ( ) const
inline

Definition at line 729 of file Pointer.h.

References BS, isBlockPointer(), and clang::interp::Started.

Referenced by clang::interp::CheckFinalLoad(), clang::interp::CheckLoad(), clang::interp::CheckStore(), clang::interp::Destroy(), clang::interp::endLifetimeRecurse(), clang::interp::interp__builtin_is_within_lifetime(), and clang::interp::startLifetimeRecurse().

◆ getNumElems()

unsigned clang::interp::Pointer::getNumElems ( ) const
inline

Returns the number of elements.

Definition at line 601 of file Pointer.h.

References elemSize(), getSize(), and isBlockPointer().

Referenced by clang::interp::arePotentiallyOverlappingStringLiterals(), clang::interp::computePointerOffset(), clang::interp::convertBoolVectorToInt(), elem(), clang::interp::Context::evaluateString(), clang::interp::Context::evaluateStrlen(), initializeElement(), clang::interp::interp__builtin_blend(), clang::interp::interp__builtin_elementwise_abs(), clang::interp::interp__builtin_elementwise_countzeroes(), clang::interp::interp__builtin_elementwise_int_unaryop(), clang::interp::interp__builtin_ia32_cmp_mask(), clang::interp::interp__builtin_ia32_cvt_vec2mask(), clang::interp::interp__builtin_ia32_cvtpd2ps(), clang::interp::interp__builtin_ia32_movmsk_op(), clang::interp::interp__builtin_ia32_phminposuw(), clang::interp::interp__builtin_ia32_pternlog(), clang::interp::interp__builtin_ia32_test_op(), clang::interp::interp__builtin_memcmp(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_nan(), clang::interp::interp__builtin_select(), clang::interp::interp__builtin_vec_ext(), clang::interp::interp__builtin_vector_reduce(), clang::interp::interp__builtin_x86_extract_vector(), clang::interp::interp__builtin_x86_extract_vector_masked(), clang::interp::interp__builtin_x86_insert_subvector(), clang::interp::OffsetHelper(), clang::interp::SubPtr(), and toAPValue().

◆ getOffset()

unsigned clang::interp::Pointer::getOffset ( ) const
inline

Returns the offset into an array.

Definition at line 381 of file Pointer.h.

References BS, getFieldDesc(), and isBlockPointer().

Referenced by clang::interp::CmpHelperEQ< Pointer >(), getIndex(), and isOnePastEnd().

◆ getRawAddress()

const std::byte * clang::interp::Pointer::getRawAddress ( ) const
inline

If backed by actual data (i.e.

a block pointer), return an address to that data.

Definition at line 611 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by clang::interp::arePotentiallyOverlappingStringLiterals(), clang::interp::Context::evaluateString(), and clang::interp::Context::evaluateStrlen().

◆ getRecord()

const Record * clang::interp::Pointer::getRecord ( ) const
inline

Returns the record descriptor of a class.

Definition at line 479 of file Pointer.h.

References clang::interp::Descriptor::ElemRecord, and getFieldDesc().

Referenced by activate(), clang::interp::CheckFieldsInitialized(), clang::interp::EvaluationResult::checkFullyInitialized(), clang::interp::CheckNewTypeMismatch(), computeOffsetForComparison(), clang::interp::computePointerOffset(), clang::interp::endLifetimeRecurse(), clang::interp::finishGlobalRecurse(), clang::interp::GetPtrDerivedPop(), clang::interp::pointsToLastObject(), clang::interp::SetThreeWayComparisonField(), clang::interp::startLifetimeRecurse(), toAPValue(), and clang::interp::MemberPointer::toPointer().

◆ getSize()

size_t clang::interp::Pointer::getSize ( ) const
inline

Returns the total size of the innermost field.

Definition at line 375 of file Pointer.h.

References getFieldDesc(), clang::interp::Descriptor::getSize(), and isBlockPointer().

Referenced by atIndex(), expand(), getNumElems(), and isOnePastEnd().

◆ getSource()

DeclTy clang::interp::Pointer::getSource ( ) const
inline

Returns the expression or declaration the pointer has been created for.

Definition at line 300 of file Pointer.h.

References Fn, clang::interp::Function::getDecl(), getDeclDesc(), clang::interp::Descriptor::getSource(), Int, isBlockPointer(), isFunctionPointer(), and isIntegralPointer().

◆ getType()

QualType clang::interp::Pointer::getType ( ) const
inline

Returns the type of the innermost field.

Definition at line 341 of file Pointer.h.

References BS, Fn, getFieldDesc(), clang::interp::Descriptor::getType(), getType(), inPrimitiveArray(), isFunctionPointer(), isTypeidPointer(), and Typeid.

Referenced by clang::interp::CheckBCPResult(), clang::interp::CheckConst(), clang::interp::CheckDowncast(), clang::interp::EvaluationResult::checkFullyInitialized(), clang::interp::EvaluationResult::checkReturnValue(), clang::interp::CheckVolatile(), clang::interp::DoBitCastPtr(), clang::interp::Free(), clang::interp::GetDynamicDecl(), getType(), clang::interp::interp__builtin_memchr(), clang::interp::interp__builtin_memcmp(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_object_size(), clang::interp::SetThreeWayComparisonField(), clang::interp::SubPtr(), toAPValue(), and toDiagnosticString().

◆ hasSameArray()

bool Pointer::hasSameArray ( const Pointer & A,
const Pointer & B )
static

Checks if two pointers can be subtracted.

Definition at line 659 of file Pointer.cpp.

References clang::interp::BlockPointer::Base, BS, getFieldDesc(), hasSameBase(), clang::interp::Descriptor::IsArray, and Pointer().

◆ hasSameBase()

bool Pointer::hasSameBase ( const Pointer & A,
const Pointer & B )
static

Checks if two pointers are comparable.

Definition at line 635 of file Pointer.cpp.

References asBlockPointer(), isFunctionPointer(), isIntegralPointer(), isTypeidPointer(), isZero(), clang::interp::BlockPointer::Pointee, and Pointer().

Referenced by clang::interp::CmpHelper< Pointer >(), clang::interp::CmpHelperEQ< Pointer >(), compare(), hasSameArray(), and clang::interp::SubPtr().

◆ inArray()

bool clang::interp::Pointer::inArray ( ) const
inline

Checks if the innermost field is an array.

Definition at line 402 of file Pointer.h.

References getFieldDesc(), clang::interp::Descriptor::IsArray, and isBlockPointer().

Referenced by clang::interp::interp__builtin_object_size(), isArrayElement(), isArrayRoot(), narrow(), and clang::interp::OffsetHelper().

◆ initialize()

void Pointer::initialize ( ) const

Initializes a field.

Definition at line 494 of file Pointer.cpp.

References asBlockPointer(), BS, getFieldDesc(), getIndex(), clang::interp::Descriptor::getNumElems(), clang::interp::Initialized, initializeElement(), clang::interp::GlobalInlineDescriptor::InitState, isBlockPointer(), clang::interp::Descriptor::isPrimitiveArray(), isRoot(), clang::interp::BlockPointer::Pointee, and clang::interp::Block::rawData().

Referenced by clang::interp::copyComposite(), clang::interp::copyRecord(), clang::interp::DoBitCastPtr(), enumerateData(), clang::interp::FinishInit(), clang::interp::FinishInitActivate(), clang::interp::FinishInitActivatePop(), clang::interp::FinishInitGlobal(), clang::interp::FinishInitPop(), clang::interp::Init(), clang::interp::InitBitField(), clang::interp::InitGlobal(), clang::interp::InitGlobalTemp(), clang::interp::InitPop(), clang::interp::interp__builtin_carryop(), clang::interp::interp__builtin_elementwise_countzeroes(), clang::interp::interp__builtin_overflowop(), clang::interp::SetField(), clang::interp::SetThreeWayComparisonField(), clang::interp::Store(), clang::interp::StoreBitField(), clang::interp::StoreBitFieldPop(), and clang::interp::StorePop().

◆ initializeAllElements()

void Pointer::initializeAllElements ( ) const

Initialize all elements of a primitive array at once.

This can be used in situations where we know we have initialized all elements of a primtive array.

Definition at line 546 of file Pointer.cpp.

References getFieldDesc(), and isArrayRoot().

Referenced by clang::interp::Program::createGlobalString(), clang::interp::interp__builtin_elementwise_abs(), clang::interp::interp__builtin_elementwise_int_binop(), clang::interp::interp__builtin_elementwise_int_unaryop(), clang::interp::interp__builtin_elementwise_triop(), clang::interp::interp__builtin_elementwise_triop_fp(), clang::interp::interp__builtin_ia32_cvtpd2ps(), clang::interp::interp__builtin_ia32_cvtsd2ss(), clang::interp::interp__builtin_ia32_multishiftqb(), clang::interp::interp__builtin_ia32_shift_with_count(), clang::interp::interp__builtin_ia32_shuffle_generic(), clang::interp::interp__builtin_ia32_vpconflict(), clang::interp::interp__builtin_select(), clang::interp::interp__builtin_select_scalar(), clang::interp::interp__builtin_vec_set(), clang::interp::interp__builtin_x86_extract_vector(), clang::interp::interp__builtin_x86_extract_vector_masked(), and clang::interp::interp__builtin_x86_insert_subvector().

◆ initializeElement()

void Pointer::initializeElement ( unsigned Index) const

Initialized the given element of a primitive array.

Definition at line 521 of file Pointer.cpp.

References BS, getFieldDesc(), clang::interp::Descriptor::getNumElems(), getNumElems(), and isStatic().

Referenced by clang::interp::CopyArray(), and initialize().

◆ inPrimitiveArray()

bool clang::interp::Pointer::inPrimitiveArray ( ) const
inline

Checks if the structure is a primitive array.

Definition at line 414 of file Pointer.h.

References getFieldDesc(), isBlockPointer(), and clang::interp::Descriptor::isPrimitiveArray().

Referenced by expand(), getType(), and narrow().

◆ inUnion()

bool clang::interp::Pointer::inUnion ( ) const
inline

Definition at line 407 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by activate(), clang::interp::CheckActive(), and clang::interp::CheckNewTypeMismatch().

◆ isActive()

bool clang::interp::Pointer::isActive ( ) const
inline

Checks if the object is active.

Definition at line 541 of file Pointer.h.

References isBlockPointer(), and isRoot().

Referenced by clang::interp::CheckActive(), clang::interp::CheckFieldsInitialized(), clang::interp::CheckNewTypeMismatch(), clang::interp::copyRecord(), clang::interp::interp__builtin_is_within_lifetime(), and toRValue().

◆ isArrayElement()

bool clang::interp::Pointer::isArrayElement ( ) const
inline

Checks if the pointer points to an array.

Definition at line 426 of file Pointer.h.

References clang::interp::BlockPointer::Base, BS, inArray(), and isBlockPointer().

Referenced by clang::interp::EvaluationResult::checkReturnValue(), computeOffsetForComparison(), clang::interp::computePointerOffset(), clang::interp::Free(), clang::interp::pointsToLastObject(), and toAPValue().

◆ isArrayRoot()

bool clang::interp::Pointer::isArrayRoot ( ) const
inline

Whether this array refers to an array, but not to the first element.

Definition at line 399 of file Pointer.h.

References BS, and inArray().

Referenced by allElementsInitialized(), deref(), initializeAllElements(), and toAPValue().

◆ isBaseClass()

bool clang::interp::Pointer::isBaseClass ( ) const
inline

Checks if a structure is a base class.

Definition at line 547 of file Pointer.h.

References isField().

Referenced by clang::interp::CallVirt(), computeOffsetForComparison(), clang::interp::computePointerOffset(), clang::interp::Free(), clang::interp::GetDynamicDecl(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_object_size(), and clang::interp::pointsToLastObject().

◆ isBlockPointer()

bool clang::interp::Pointer::isBlockPointer ( ) const
inline

Definition at line 473 of file Pointer.h.

References clang::interp::Block.

Referenced by asBlockPointer(), atField(), canBeInitialized(), clang::interp::CheckConst(), clang::interp::CheckConstant(), clang::interp::CheckFinalLoad(), clang::interp::EvaluationResult::checkFullyInitialized(), clang::interp::CheckLoad(), clang::interp::CheckNewTypeMismatch(), clang::interp::CheckPointerToIntegralCast(), clang::interp::CheckStore(), computeSplitPoint(), deref(), clang::interp::DoBitCast(), clang::interp::DoBitCastPtr(), clang::interp::DoMemcpy(), elem(), endLifetime(), expand(), clang::interp::ExpandPtr(), getDeclDesc(), getDeclID(), clang::interp::getField(), getIndex(), getLifetime(), getNumElems(), getOffset(), clang::interp::GetPtrBase(), clang::interp::GetPtrBasePop(), clang::interp::GetPtrDerivedPop(), getRawAddress(), getSize(), getSource(), inArray(), initialize(), inPrimitiveArray(), clang::interp::interp__builtin_assume_aligned(), clang::interp::interp__builtin_carryop(), clang::interp::interp__builtin_is_aligned_up_down(), clang::interp::interp__builtin_memcmp(), clang::interp::interp__builtin_object_size(), clang::interp::interp__builtin_overflowop(), clang::interp::interp__builtin_strcmp(), inUnion(), isActive(), isArrayElement(), clang::interp::isConstexprUnknown(), isConstInMutable(), isDereferencable(), isDummy(), isDynamic(), isElementInitialized(), isExtern(), isField(), isInitialized(), isLive(), isMutable(), isOnePastEnd(), isRoot(), isStatic(), isTemporary(), isUnknownSizeArray(), isVolatile(), isWeak(), clang::interp::Load(), clang::interp::LoadPop(), narrow(), clang::interp::OffsetHelper(), operator=(), operator=(), operator==(), pointsToLiteral(), pointsToStringLiteral(), pointToSameBlock(), startLifetime(), clang::interp::SubPtr(), and ~Pointer().

◆ isConst()

bool clang::interp::Pointer::isConst ( ) const
inline

Checks if an object or a subfield is mutable.

Definition at line 562 of file Pointer.h.

References getDeclDesc(), clang::interp::Descriptor::IsConst, isIntegralPointer(), and isRoot().

Referenced by clang::interp::CheckConst(), clang::interp::CheckExtern(), clang::interp::CheckLoad(), clang::interp::Context::evaluateString(), and clang::interp::GetDynamicDecl().

◆ isConstInMutable()

bool clang::interp::Pointer::isConstInMutable ( ) const
inline

Definition at line 567 of file Pointer.h.

References false, isBlockPointer(), and isRoot().

Referenced by clang::interp::CheckConst().

◆ isDereferencable()

bool clang::interp::Pointer::isDereferencable ( ) const
inline

Whether this block can be read from at all.

This is only true for block pointers that point to a valid location inside that block.

Definition at line 702 of file Pointer.h.

References isBlockPointer(), and isPastEnd().

Referenced by deref(), and elem().

◆ isDummy()

bool clang::interp::Pointer::isDummy ( ) const
inline

Checks if the pointer points to a dummy value.

Definition at line 552 of file Pointer.h.

References Block, BS, and isBlockPointer().

Referenced by clang::interp::Call(), clang::interp::CheckBCPResult(), clang::interp::CheckInvoke(), clang::interp::CheckPointerToIntegralCast(), clang::interp::CopyArray(), clang::interp::Context::evaluateStrlen(), clang::interp::IncDecHelper(), clang::interp::IncDecPtrHelper(), clang::interp::interp__builtin_carryop(), clang::interp::interp__builtin_memchr(), clang::interp::interp__builtin_memcmp(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_object_size(), clang::interp::interp__builtin_overflowop(), clang::interp::interp__builtin_strcmp(), clang::interp::isConstexprUnknown(), clang::interp::isUserWritingOffTheEnd(), and toRValue().

◆ isDynamic()

bool clang::interp::Pointer::isDynamic ( ) const
inline

Checks if the storage has been dynamically allocated.

Definition at line 514 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by clang::interp::CheckLive(), pointsToLiteral(), pointsToStringLiteral(), and toAPValue().

◆ isElementInitialized()

bool Pointer::isElementInitialized ( unsigned Index) const

Like isInitialized(), but for primitive arrays.

Definition at line 464 of file Pointer.cpp.

References block(), BS, getFieldDesc(), clang::interp::Initialized, clang::interp::GlobalInlineDescriptor::InitState, isBlockPointer(), isInitialized(), clang::interp::Descriptor::isPrimitiveArray(), isRoot(), isStatic(), and clang::interp::Block::rawData().

Referenced by clang::interp::CheckArrayInitialized(), and isInitialized().

◆ isElementPastEnd()

bool clang::interp::Pointer::isElementPastEnd ( ) const
inline

Checks if the pointer is an out-of-bounds element pointer.

Definition at line 656 of file Pointer.h.

Referenced by clang::interp::CheckRange(), expand(), print(), and clang::interp::SubPtr().

◆ isExtern()

bool clang::interp::Pointer::isExtern ( ) const
inline

Checks if the storage is extern.

Definition at line 493 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by clang::interp::CheckExtern(), and clang::interp::DiagnoseUninitialized().

◆ isField()

bool clang::interp::Pointer::isField ( ) const
inline

Checks if the item is a field in an object.

Definition at line 279 of file Pointer.h.

References clang::interp::Descriptor::asDecl(), getFieldDesc(), isBlockPointer(), and isRoot().

Referenced by clang::interp::CheckLive(), clang::interp::CheckLoad(), clang::interp::computePointerOffset(), isBaseClass(), isVirtualBaseClass(), and toAPValue().

◆ isFunctionPointer()

bool clang::interp::Pointer::isFunctionPointer ( ) const
inline

Definition at line 475 of file Pointer.h.

References clang::interp::Fn.

Referenced by asFunctionPointer(), atIndex(), clang::interp::CallPtr(), clang::interp::CheckBCPResult(), clang::interp::CheckPointerToIntegralCast(), clang::interp::CmpHelper< Pointer >(), clang::interp::CmpHelperEQ< Pointer >(), getDeclDesc(), getIntegerRepresentation(), getSource(), getType(), hasSameBase(), isWeak(), isZeroSizeArray(), clang::interp::OffsetHelper(), operator==(), toAPValue(), and toDiagnosticString().

◆ isInitialized()

bool Pointer::isInitialized ( ) const

Checks if an object was initialized.

Definition at line 441 of file Pointer.cpp.

References asBlockPointer(), block(), BS, getFieldDesc(), getIndex(), clang::interp::Initialized, clang::interp::GlobalInlineDescriptor::InitState, isBlockPointer(), isElementInitialized(), clang::interp::Descriptor::isPrimitiveArray(), isRoot(), and clang::interp::Block::rawData().

Referenced by clang::interp::CheckExtern(), clang::interp::CheckFieldsInitialized(), clang::interp::CheckFinalLoad(), clang::interp::CheckLoad(), clang::interp::copyRecord(), clang::interp::DecPtr(), clang::interp::DiagnoseUninitialized(), clang::interp::Program::dump(), clang::interp::IncPtr(), isElementInitialized(), clang::interp::Program::isGlobalInitialized(), and clang::interp::readPointerToBuffer().

◆ isIntegralPointer()

bool clang::interp::Pointer::isIntegralPointer ( ) const
inline

Definition at line 474 of file Pointer.h.

References clang::interp::Int.

Referenced by asIntPointer(), atIndex(), clang::interp::CheckBCPResult(), elemSize(), getByteOffset(), getDeclDesc(), clang::interp::getField(), getFieldDesc(), getIntegerRepresentation(), clang::interp::GetPtrBase(), clang::interp::GetPtrBasePop(), getSource(), hasSameBase(), clang::interp::interp__builtin_atomic_lock_free(), clang::interp::interp__builtin_memcpy(), isConst(), isPastEnd(), clang::interp::OffsetHelper(), operator==(), toAPValue(), toDiagnosticString(), and toRValue().

◆ isLive()

bool clang::interp::Pointer::isLive ( ) const
inline

Checks if the pointer is live.

Definition at line 273 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by clang::interp::CheckConst(), clang::interp::EvaluationResult::checkFullyInitialized(), clang::interp::CheckLive(), clang::interp::CheckMutable(), clang::interp::CheckVolatile(), clang::interp::copyComposite(), deref(), clang::interp::DiagnoseUninitialized(), clang::interp::DoBitCast(), clang::interp::DoBitCastPtr(), elem(), and toRValue().

◆ isMutable()

bool clang::interp::Pointer::isMutable ( ) const
inline

Checks if the field is mutable.

Definition at line 525 of file Pointer.h.

References isBlockPointer(), and isRoot().

Referenced by clang::interp::CheckConst(), and clang::interp::CheckMutable().

◆ isOnePastEnd()

bool clang::interp::Pointer::isOnePastEnd ( ) const
inline

Checks if the index is one past end.

Definition at line 634 of file Pointer.h.

References BS, getOffset(), getSize(), isBlockPointer(), isPastEnd(), and isUnknownSizeArray().

Referenced by clang::interp::arePotentiallyOverlappingStringLiterals(), clang::interp::CheckRange(), clang::interp::CheckSubobject(), clang::interp::CmpHelperEQ< Pointer >(), computeOffsetForComparison(), clang::interp::computePointerOffset(), clang::interp::Free(), getByteOffset(), clang::interp::interp__builtin_is_within_lifetime(), narrow(), clang::interp::OffsetHelper(), and toAPValue().

◆ isPastEnd()

bool clang::interp::Pointer::isPastEnd ( ) const
inline

Checks if the pointer points past the end of the object.

Definition at line 648 of file Pointer.h.

References BS, isIntegralPointer(), and isZero().

Referenced by isDereferencable(), isOnePastEnd(), and toRValue().

◆ isRoot()

bool clang::interp::Pointer::isRoot ( ) const
inline

Pointer points directly to a block.

Definition at line 442 of file Pointer.h.

References BS, isBlockPointer(), and isZero().

Referenced by activate(), allElementsInitialized(), clang::interp::ArrayDecay(), clang::interp::EvaluationResult::checkReturnValue(), clang::interp::CheckVolatile(), computeOffsetForComparison(), computeSplitPoint(), expand(), clang::interp::Free(), getFieldDesc(), initialize(), isActive(), isConst(), isConstInMutable(), isElementInitialized(), isField(), isInitialized(), isMutable(), isVolatile(), clang::interp::pointsToLastObject(), and print().

◆ isStatic()

bool clang::interp::Pointer::isStatic ( ) const
inline

Checks if the storage is static.

Definition at line 499 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by allElementsInitialized(), clang::interp::CheckConstant(), CheckGlobal(), clang::interp::GetDynamicDecl(), initializeElement(), isElementInitialized(), and isStaticTemporary().

◆ isStaticTemporary()

bool clang::interp::Pointer::isStaticTemporary ( ) const
inline

Checks if the storage is a static temporary.

Definition at line 522 of file Pointer.h.

References isStatic(), and isTemporary().

◆ isTemporary()

bool clang::interp::Pointer::isTemporary ( ) const
inline

Checks if the storage is temporary.

Definition at line 506 of file Pointer.h.

References BS, and isBlockPointer().

Referenced by clang::interp::CheckDeleteSource(), clang::interp::CheckLive(), and isStaticTemporary().

◆ isTypeidPointer()

bool clang::interp::Pointer::isTypeidPointer ( ) const
inline

Definition at line 476 of file Pointer.h.

References clang::interp::Typeid.

Referenced by asTypeidPointer(), clang::interp::CheckBCPResult(), clang::interp::CmpHelper< Pointer >(), getByteOffset(), getDeclDesc(), getType(), hasSameBase(), and toAPValue().

◆ isUnknownSizeArray()

bool clang::interp::Pointer::isUnknownSizeArray ( ) const
inline

Checks if the structure is an array of unknown size.

Definition at line 420 of file Pointer.h.

References getFieldDesc(), isBlockPointer(), and clang::interp::Descriptor::isUnknownSizeArray().

Referenced by clang::interp::ArrayDecay(), clang::interp::CheckArray(), clang::interp::CmpHelperEQ< Pointer >(), clang::interp::Context::evaluateStrlen(), clang::interp::interp__builtin_memcpy(), isOnePastEnd(), narrow(), and toAPValue().

◆ isVirtualBaseClass()

bool clang::interp::Pointer::isVirtualBaseClass ( ) const
inline

Definition at line 548 of file Pointer.h.

References isField().

Referenced by computeOffsetForComparison(), clang::interp::computePointerOffset(), and toAPValue().

◆ isVolatile()

bool clang::interp::Pointer::isVolatile ( ) const
inline

Checks if an object or a subfield is volatile.

Definition at line 574 of file Pointer.h.

References getDeclDesc(), isBlockPointer(), isRoot(), and clang::interp::Descriptor::IsVolatile.

Referenced by clang::interp::CheckVolatile().

◆ isWeak()

bool clang::interp::Pointer::isWeak ( ) const
inline

Definition at line 531 of file Pointer.h.

References BS, Fn, isBlockPointer(), and isFunctionPointer().

◆ isZero()

bool clang::interp::Pointer::isZero ( ) const
inline

Checks if the pointer is null.

Definition at line 259 of file Pointer.h.

References clang::interp::Block, BS, Fn, clang::interp::Fn, Int, clang::interp::Int, and clang::interp::Typeid.

Referenced by clang::interp::ArrayDecay(), clang::interp::Call(), clang::interp::CallPtr(), clang::interp::CheckBCPResult(), clang::interp::CheckFinalLoad(), clang::interp::EvaluationResult::checkFullyInitialized(), clang::interp::CheckLive(), clang::interp::CheckLoad(), clang::interp::CheckNewTypeMismatch(), clang::interp::CheckNonNullArgs(), clang::interp::CheckNull(), clang::interp::CheckPointerToIntegralCast(), clang::interp::CheckStore(), clang::interp::CmpHelperEQ< Pointer >(), clang::interp::Free(), getIndex(), hasSameBase(), clang::interp::interp__builtin_atomic_lock_free(), clang::interp::interp__builtin_is_within_lifetime(), clang::interp::interp__builtin_memchr(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_object_size(), clang::interp::interp__builtin_operator_delete(), isPastEnd(), isRoot(), narrow(), pointsToLiteral(), pointsToStringLiteral(), clang::interp::MemberPointer::takeInstance(), toAPValue(), toDiagnosticString(), and toRValue().

◆ isZeroSizeArray()

bool clang::interp::Pointer::isZeroSizeArray ( ) const
inline

Checks if the pointer is pointing to a zero-size array.

Definition at line 659 of file Pointer.h.

References getFieldDesc(), and isFunctionPointer().

Referenced by clang::interp::ArrayDecay(), clang::interp::CheckRange(), clang::interp::CheckRange(), clang::interp::Free(), and toAPValue().

◆ narrow()

Pointer clang::interp::Pointer::narrow ( ) const
inlinenodiscard

Restricts the scope of an array element pointer.

Definition at line 189 of file Pointer.h.

References BS, inArray(), inPrimitiveArray(), isBlockPointer(), isOnePastEnd(), isUnknownSizeArray(), isZero(), and Pointer().

Referenced by clang::interp::CheckArrayInitialized(), clang::interp::collectBlocks(), clang::interp::copyComposite(), clang::interp::endLifetimeRecurse(), enumerateData(), clang::interp::finishGlobalRecurse(), clang::interp::interp__builtin_object_size(), clang::interp::NarrowPtr(), clang::interp::RunDestructors(), clang::interp::startLifetimeRecurse(), and clang::interp::zeroAll().

◆ operator!=()

bool clang::interp::Pointer::operator!= ( const Pointer & P) const
inline

Definition at line 136 of file Pointer.h.

References Pointer().

◆ operator=() [1/2]

Pointer & Pointer::operator= ( const Pointer & P)

Definition at line 94 of file Pointer.cpp.

References clang::interp::BlockPointer::Base, Block, clang::interp::Block, block(), BS, Fn, clang::interp::Fn, Int, clang::interp::Int, isBlockPointer(), Pointer(), Typeid, and clang::interp::Typeid.

◆ operator=() [2/2]

Pointer & Pointer::operator= ( Pointer && P)

Definition at line 133 of file Pointer.cpp.

References Block, clang::interp::Block, BS, Fn, clang::interp::Fn, Int, clang::interp::Int, isBlockPointer(), Pointer(), Typeid, and clang::interp::Typeid.

◆ operator==()

bool clang::interp::Pointer::operator== ( const Pointer & P) const
inline

Equality operators are just for tests.

Definition at line 121 of file Pointer.h.

References clang::interp::BlockPointer::Base, BS, clang::interp::IntPointer::Desc, Fn, clang::interp::FunctionPointer::getFunction(), Int, isBlockPointer(), isFunctionPointer(), isIntegralPointer(), clang::interp::BlockPointer::Pointee, Pointer(), and clang::interp::IntPointer::Value.

◆ pointsToLiteral()

bool Pointer::pointsToLiteral ( ) const

Whether this points to a block that's been created for a "literal lvalue", i.e.

a non-MaterializeTemporaryExpr Expr.

Definition at line 664 of file Pointer.cpp.

References clang::interp::Descriptor::asExpr(), block(), clang::interp::Block::getDescriptor(), clang::isa(), isBlockPointer(), isDynamic(), and isZero().

◆ pointsToStringLiteral()

bool Pointer::pointsToStringLiteral ( ) const

Definition at line 675 of file Pointer.cpp.

References clang::interp::Descriptor::asExpr(), block(), clang::interp::Block::getDescriptor(), isBlockPointer(), isDynamic(), and isZero().

Referenced by clang::interp::CmpHelperEQ< Pointer >().

◆ pointToSameBlock()

bool Pointer::pointToSameBlock ( const Pointer & A,
const Pointer & B )
static

Checks if both given pointers point to the same block.

Definition at line 653 of file Pointer.cpp.

References block(), isBlockPointer(), and Pointer().

Referenced by clang::interp::interp__builtin_memcpy(), and clang::interp::runRecordDestructor().

◆ print()

void Pointer::print ( llvm::raw_ostream & OS) const

Prints the pointer.

Definition at line 327 of file Pointer.cpp.

References asFunctionPointer(), asTypeidPointer(), Block, clang::interp::Block, BS, clang::interp::Fn, clang::interp::FunctionPointer::getFunction(), clang::interp::Block::getSize(), Int, clang::interp::Int, isElementPastEnd(), isRoot(), clang::interp::Typeid, clang::interp::TypeidPointer::TypeInfoType, and clang::interp::TypeidPointer::TypePtr.

Referenced by clang::interp::operator<<().

◆ startLifetime()

void clang::interp::Pointer::startLifetime ( ) const
inline

Definition at line 745 of file Pointer.h.

References BS, isBlockPointer(), and clang::interp::Started.

Referenced by clang::interp::startLifetimeRecurse().

◆ toAPValue()

APValue Pointer::toAPValue ( const ASTContext & ASTCtx) const

Converts the pointer to an APValue.

Definition at line 172 of file Pointer.cpp.

References clang::APValue, clang::APValue::LValuePathEntry::ArrayIndex(), clang::interp::Descriptor::asDecl(), clang::interp::Descriptor::asExpr(), asFunctionPointer(), asIntPointer(), clang::interp::Descriptor::asValueDecl(), block(), clang::cast(), expand(), clang::CharUnits::fromQuantity(), getArray(), clang::Type::getAsRecordDecl(), clang::ASTContext::getASTRecordLayout(), getBase(), clang::ASTRecordLayout::getBaseClassOffset(), clang::interp::Descriptor::getDataType(), clang::interp::Function::getDecl(), clang::interp::Record::getDecl(), getDeclDesc(), getDeclPtr(), clang::RecordDecl::getDefinition(), clang::APValue::LValueBase::getDynamicAlloc(), clang::interp::Descriptor::getElemQualType(), clang::interp::Function::getExpr(), getFieldDesc(), clang::ASTRecordLayout::getFieldOffset(), getFieldOffset(), clang::interp::FunctionPointer::getFunction(), getIndex(), getNumElems(), getRecord(), clang::interp::Descriptor::getType(), getType(), clang::APValue::LValueBase::getTypeInfo(), clang::ASTContext::getTypeSizeInChars(), clang::ASTRecordLayout::getVBaseClassOffset(), isArrayElement(), isArrayRoot(), clang::Type::isArrayType(), isDynamic(), isField(), isFunctionPointer(), isIntegralPointer(), isOnePastEnd(), isTypeidPointer(), isUnknownSizeArray(), isVirtualBaseClass(), isZero(), isZeroSizeArray(), Pointer(), clang::ASTContext::toCharUnitsFromBits(), Typeid, and clang::CharUnits::Zero().

Referenced by clang::interp::GetDynamicDecl(), clang::interp::interp__builtin_assume_aligned(), toDiagnosticString(), and toRValue().

◆ toDiagnosticString()

std::string Pointer::toDiagnosticString ( const ASTContext & Ctx) const

Converts the pointer to a string usable in diagnostics.

Definition at line 428 of file Pointer.cpp.

References asFunctionPointer(), asIntPointer(), clang::APValue::getAsString(), getType(), isFunctionPointer(), isIntegralPointer(), isZero(), toAPValue(), and clang::interp::FunctionPointer::toDiagnosticString().

Referenced by clang::interp::CheckDeleteSource(), clang::interp::CmpHelper< Pointer >(), clang::interp::CmpHelperEQ< Pointer >(), clang::interp::Destroy(), clang::interp::Free(), clang::interp::getField(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_operator_delete(), and clang::interp::SubPtr().

◆ toRValue()

std::optional< APValue > Pointer::toRValue ( const Context & Ctx,
QualType ResultType ) const

Converts the pointer to an APValue that is an rvalue.

Definition at line 728 of file Pointer.cpp.

References clang::APValue, clang::interp::Descriptor::asFieldDecl(), bool, clang::interp::Context::classify(), deref(), clang::interp::Record::fields(), std::function, clang::interp::Floating::getAPFloat(), clang::APValue::getArrayInitializedElt(), clang::interp::Context::getASTContext(), clang::interp::Record::getBase(), clang::ASTContext::getCanonicalTagType(), clang::interp::Record::getField(), getFieldDesc(), clang::interp::Record::getNumBases(), clang::interp::Record::getNumFields(), clang::interp::Record::getNumVirtualBases(), clang::interp::Record::getVirtualBase(), INT_TYPE_SWITCH, isActive(), isDummy(), clang::Type::isFloatingType(), clang::Type::isIntegerType(), isIntegralPointer(), isLive(), clang::QualType::isNull(), isPastEnd(), isZero(), Ok, Pointer(), clang::Result, clang::T, toAPValue(), and TYPE_SWITCH.

◆ Block

friend class Block
friend

Definition at line 790 of file Pointer.h.

References Block.

Referenced by Block, block(), expand(), isDummy(), operator=(), operator=(), Pointer(), Pointer(), Pointer(), print(), and ~Pointer().

◆ DeadBlock

friend class DeadBlock
friend

Definition at line 791 of file Pointer.h.

References DeadBlock.

Referenced by DeadBlock.

◆ DynamicAllocator

friend class DynamicAllocator
friend

Definition at line 795 of file Pointer.h.

References DynamicAllocator.

Referenced by DynamicAllocator.

◆ InitMap

friend struct InitMap
friend

Definition at line 794 of file Pointer.h.

References InitMap.

Referenced by InitMap.

◆ InterpState

friend class InterpState
friend

Definition at line 793 of file Pointer.h.

References InterpState.

Referenced by InterpState.

◆ MemberPointer

friend class MemberPointer
friend

Definition at line 792 of file Pointer.h.

References MemberPointer.

Referenced by MemberPointer.

◆ Program

friend class Program
friend

Definition at line 796 of file Pointer.h.

References BS, and Program.

Referenced by Program.

Member Data Documentation

◆ BS

BlockPointer clang::interp::Pointer::BS

Definition at line 830 of file Pointer.h.

Referenced by activate(), allElementsInitialized(), asBlockPointer(), atField(), atFieldSub(), atIndex(), block(), canBeInitialized(), clang::interp::DynamicAllocator::cleanup(), clang::interp::DeadBlock::DeadBlock(), deref(), elem(), elemSize(), endLifetime(), expand(), getArray(), getBase(), getDeclDesc(), getDeclID(), getDeclPtr(), getIndex(), getIntegerRepresentation(), getLifetime(), getOffset(), getRawAddress(), getType(), hasSameArray(), initialize(), initializeElement(), inUnion(), isArrayElement(), isArrayRoot(), isDummy(), isDynamic(), isElementInitialized(), isExtern(), isInitialized(), isLive(), isOnePastEnd(), isPastEnd(), isRoot(), isStatic(), isTemporary(), isWeak(), isZero(), clang::interp::Block::movePointersTo(), narrow(), operator=(), operator=(), operator==(), Pointer(), Pointer(), Pointer(), print(), Program, startLifetime(), and ~Pointer().

◆ Fn

FunctionPointer clang::interp::Pointer::Fn

Definition at line 831 of file Pointer.h.

Referenced by asFunctionPointer(), atIndex(), computeOffsetForComparison(), getIntegerRepresentation(), getSource(), getType(), isWeak(), isZero(), operator=(), operator=(), operator==(), Pointer(), Pointer(), and Pointer().

◆ Int

IntPointer clang::interp::Pointer::Int

Definition at line 829 of file Pointer.h.

Referenced by asIntPointer(), atIndex(), computeOffsetForComparison(), elemSize(), getByteOffset(), getDeclDesc(), getFieldDesc(), getIntegerRepresentation(), getSource(), isZero(), operator=(), operator=(), operator==(), Pointer(), Pointer(), Pointer(), Pointer(), Pointer(), and print().

◆ Typeid

TypeidPointer clang::interp::Pointer::Typeid

Definition at line 832 of file Pointer.h.

Referenced by asTypeidPointer(), getByteOffset(), getType(), operator=(), operator=(), Pointer(), Pointer(), Pointer(), and toAPValue().

The documentation for this class was generated from the following files:
Generated on for clang by doxygen 1.14.0