A memory block, either on the stack or in the heap. More...

#include "/home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/AST/Interp/InterpBlock.h"

Collaboration diagram for clang::interp::Block:

[legend]

Public Member Functions
	Block (const std::optional< unsigned > &DeclID, Descriptor *Desc, bool IsStatic=false, bool IsExtern=false)

	Block (Descriptor *Desc, bool IsStatic=false, bool IsExtern=false)

Descriptor *	getDescriptor () const
	Returns the block's descriptor.

bool	hasPointers () const
	Checks if the block has any live pointers.

bool	isExtern () const
	Checks if the block is extern.

bool	isStatic () const
	Checks if the block has static storage duration.

bool	isTemporary () const
	Checks if the block is temporary.

unsigned	getSize () const
	Returns the size of the block.

std::optional< unsigned >	getDeclID () const
	Returns the declaration ID.

char *	data ()
	Returns a pointer to the stored data.

const char *	data () const

char *	rawData ()
	Returns a pointer to the raw data, including metadata.

const char *	rawData () const

template<typename T >
T &	deref ()
	Returns a view over the data.

void	invokeCtor ()
	Invokes the constructor.

void	invokeDtor ()

Protected Member Functions
	Block (Descriptor *Desc, bool IsExtern, bool IsStatic, bool IsDead)

void	cleanup ()

void	addPointer (Pointer *P)

void	removePointer (Pointer *P)

void	movePointer (Pointer From, Pointer To)

Protected Attributes
Pointer *	Pointers = nullptr
	Start of the chain of pointers.

std::optional< unsigned >	DeclID
	Unique identifier of the declaration.

bool	IsStatic = false
	Flag indicating if the block has static storage duration.

bool	IsExtern = false
	Flag indicating if the block is an extern.

bool	IsDead = false
	Flag indicating if the pointer is dead.

Descriptor *	Desc
	Pointer to the stack slot descriptor.

Friends
class	Pointer

class	DeadBlock

class	InterpState

Detailed Description

A memory block, either on the stack or in the heap.

The storage described by the block is immediately followed by optional metadata, which is followed by the actual data.

Block* rawData() data() │ │ │ │ │ │ ▼ ▼ ▼ ┌───────────────┬─────────────────────────┬─────────────────┐ │ Block │ Metadata │ Data │ │ sizeof(Block) │ Desc->getMetadataSize() │ Desc->getSize() │ └───────────────┴─────────────────────────┴─────────────────┘

Desc->getAllocSize() describes the size after the Block, i.e. the data size and the metadata size.

Definition at line 49 of file InterpBlock.h.

Constructor & Destructor Documentation

◆ Block() [1/3]

clang::interp::Block::Block	(	const std::optional< unsigned > &	DeclID,
		Descriptor *	Desc,
		bool	IsStatic = `false`,
		bool	IsExtern = `false`
	)

inline

Definition at line 52 of file InterpBlock.h.

◆ Block() [2/3]

clang::interp::Block::Block	(	Descriptor *	Desc,
		bool	IsStatic = `false`,
		bool	IsExtern = `false`
	)

inline

Definition at line 56 of file InterpBlock.h.

◆ Block() [3/3]

clang::interp::Block::Block	(	Descriptor *	Desc,
		bool	IsExtern,
		bool	IsStatic,
		bool	IsDead
	)

inlineprotected

Definition at line 118 of file InterpBlock.h.

Member Function Documentation

◆ addPointer()

void Block::addPointer ( Pointer * P )

protected

Definition at line 21 of file InterpBlock.cpp.

References IsStatic, P, and Pointers.

Referenced by clang::interp::Pointer::operator=().

◆ cleanup()

void Block::cleanup ( )

protected

Definition at line 42 of file InterpBlock.cpp.

References IsDead, and Pointers.

Referenced by clang::interp::Pointer::operator=(), and clang::interp::Pointer::~Pointer().

◆ data() [1/2]

char * clang::interp::Block::data ( )

inline

Returns a pointer to the stored data.

You are allowed to read Desc->getSize() bytes from this address.

Definition at line 77 of file InterpBlock.h.

References Desc, clang::interp::Descriptor::getMetadataSize(), and rawData().

Referenced by clang::interp::DeadBlock::data(), clang::interp::InterpState::deallocate(), deref(), invokeCtor(), and invokeDtor().

◆ data() [2/2]

const char * clang::interp::Block::data ( ) const

inline

Definition at line 82 of file InterpBlock.h.

References Desc, clang::interp::Descriptor::getMetadataSize(), and rawData().

◆ deref()

template<typename T >

T & clang::interp::Block::deref ( )

inline

Returns a view over the data.

Definition at line 97 of file InterpBlock.h.

References data().

◆ getDeclID()

std::optional< unsigned > clang::interp::Block::getDeclID ( ) const

inline

Returns the declaration ID.

Definition at line 73 of file InterpBlock.h.

References DeclID.

Referenced by clang::interp::Pointer::getDeclID().

◆ getDescriptor()

Descriptor * clang::interp::Block::getDescriptor ( ) const

inline

Returns the block's descriptor.

Definition at line 61 of file InterpBlock.h.

References Desc.

Referenced by clang::interp::InterpState::deallocate().

◆ getSize()

unsigned clang::interp::Block::getSize ( ) const

inline

Returns the size of the block.

Definition at line 71 of file InterpBlock.h.

References Desc, and clang::interp::Descriptor::getAllocSize().

Referenced by clang::interp::InterpState::deallocate(), and clang::interp::Pointer::print().

◆ hasPointers()

bool clang::interp::Block::hasPointers ( ) const

inline

Checks if the block has any live pointers.

Definition at line 63 of file InterpBlock.h.

References Pointers.

Referenced by clang::interp::InterpState::deallocate().

◆ invokeCtor()

void clang::interp::Block::invokeCtor ( )

inline

Invokes the constructor.

Definition at line 100 of file InterpBlock.h.

References clang::interp::Descriptor::CtorFn, data(), Desc, clang::interp::Descriptor::getAllocSize(), clang::interp::Descriptor::IsConst, clang::interp::Descriptor::IsMutable, and rawData().

Referenced by clang::interp::EvalEmitter::createLocal(), and clang::interp::InterpFrame::InterpFrame().

◆ invokeDtor()

void clang::interp::Block::invokeDtor ( )

inline

Definition at line 108 of file InterpBlock.h.

References data(), Desc, and clang::interp::Descriptor::DtorFn.

◆ isExtern()

bool clang::interp::Block::isExtern ( ) const

inline

Checks if the block is extern.

Definition at line 65 of file InterpBlock.h.

References IsExtern.

Referenced by clang::interp::Pointer::isExtern().

◆ isStatic()

bool clang::interp::Block::isStatic ( ) const

inline

Checks if the block has static storage duration.

Definition at line 67 of file InterpBlock.h.

References IsStatic.

Referenced by clang::interp::Pointer::isStatic().

◆ isTemporary()

bool clang::interp::Block::isTemporary ( ) const

inline

Checks if the block is temporary.

Definition at line 69 of file InterpBlock.h.

References Desc, and clang::interp::Descriptor::IsTemporary.

Referenced by clang::interp::Pointer::isTemporary().

◆ movePointer()

void Block::movePointer	(	Pointer *	From,
		Pointer *	To
	)

protected

Definition at line 47 of file InterpBlock.cpp.

References IsStatic, and Pointers.

Referenced by clang::interp::Pointer::operator=(), and clang::interp::Pointer::Pointer().

◆ rawData() [1/2]

char * clang::interp::Block::rawData ( )

inline

Returns a pointer to the raw data, including metadata.

You are allowed to read Desc->getAllocSize() bytes from this address.

Definition at line 90 of file InterpBlock.h.

Referenced by data(), clang::interp::Pointer::deref(), clang::interp::Pointer::elem(), and invokeCtor().

◆ rawData() [2/2]

const char * clang::interp::Block::rawData ( ) const

inline

Definition at line 91 of file InterpBlock.h.

◆ removePointer()

void Block::removePointer ( Pointer * P )

protected

Definition at line 31 of file InterpBlock.cpp.

References IsStatic, P, and Pointers.

Referenced by clang::interp::Pointer::operator=(), and clang::interp::Pointer::~Pointer().

Friends And Related Function Documentation

◆ DeadBlock

friend class DeadBlock

friend

Definition at line 115 of file InterpBlock.h.

◆ InterpState

friend class InterpState

friend

Definition at line 116 of file InterpBlock.h.

◆ Pointer

friend class Pointer

friend

Definition at line 114 of file InterpBlock.h.

Member Data Documentation

◆ DeclID

std::optional<unsigned> clang::interp::Block::DeclID

protected

Unique identifier of the declaration.

Definition at line 132 of file InterpBlock.h.

Referenced by getDeclID().

◆ Desc

Descriptor* clang::interp::Block::Desc

protected

Pointer to the stack slot descriptor.

Definition at line 140 of file InterpBlock.h.

Referenced by ctorRecord(), data(), clang::interp::Pointer::getDeclDesc(), getDescriptor(), getSize(), invokeCtor(), invokeDtor(), and isTemporary().

◆ IsDead

bool clang::interp::Block::IsDead = false

protected

Flag indicating if the pointer is dead.

Definition at line 138 of file InterpBlock.h.

Referenced by cleanup(), and clang::interp::Pointer::isLive().

◆ IsExtern

bool clang::interp::Block::IsExtern = false

protected

Flag indicating if the block is an extern.

Definition at line 136 of file InterpBlock.h.

Referenced by isExtern().

◆ IsStatic

bool clang::interp::Block::IsStatic = false

protected

Flag indicating if the block has static storage duration.

Definition at line 134 of file InterpBlock.h.

Referenced by addPointer(), isStatic(), movePointer(), and removePointer().

◆ Pointers

Pointer* clang::interp::Block::Pointers = nullptr

protected

Start of the chain of pointers.

Definition at line 130 of file InterpBlock.h.

Referenced by addPointer(), cleanup(), clang::interp::DeadBlock::DeadBlock(), hasPointers(), movePointer(), and removePointer().

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

lib/AST/Interp/InterpBlock.h
lib/AST/Interp/InterpBlock.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Block() [1/3]

◆ Block() [2/3]

◆ Block() [3/3]

Member Function Documentation

◆ addPointer()

◆ cleanup()

◆ data() [1/2]

◆ data() [2/2]

◆ deref()

◆ getDeclID()

◆ getDescriptor()

◆ getSize()

◆ hasPointers()

◆ invokeCtor()

◆ invokeDtor()

◆ isExtern()

◆ isStatic()

◆ isTemporary()

◆ movePointer()

◆ rawData() [1/2]

◆ rawData() [2/2]

◆ removePointer()

Friends And Related Function Documentation

◆ DeadBlock

◆ InterpState

◆ Pointer

Member Data Documentation

◆ DeclID

◆ Desc

◆ IsDead

◆ IsExtern

◆ IsStatic

◆ Pointers