A cleanup scope which generates the cleanup blocks lazily. More...

#include "/home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/CodeGen/CGCleanup.h"

Inheritance diagram for clang::CodeGen::EHCleanupScope:

Collaboration diagram for clang::CodeGen::EHCleanupScope:

[legend]

Public Member Functions
size_t	getAllocatedSize () const

	EHCleanupScope (bool isNormal, bool isEH, unsigned cleanupSize, unsigned fixupDepth, EHScopeStack::stable_iterator enclosingNormal, EHScopeStack::stable_iterator enclosingEH)

void	Destroy ()

	~EHCleanupScope ()=delete

bool	isNormalCleanup () const

llvm::BasicBlock *	getNormalBlock () const

void	setNormalBlock (llvm::BasicBlock *BB)

bool	isEHCleanup () const

bool	isActive () const

void	setActive (bool A)

bool	isLifetimeMarker () const

void	setLifetimeMarker ()

bool	hasActiveFlag () const

Address	getActiveFlag () const

void	setActiveFlag (Address Var)

void	setTestFlagInNormalCleanup ()

bool	shouldTestFlagInNormalCleanup () const

void	setTestFlagInEHCleanup ()

bool	shouldTestFlagInEHCleanup () const

unsigned	getFixupDepth () const

EHScopeStack::stable_iterator	getEnclosingNormalCleanup () const

size_t	getCleanupSize () const

void *	getCleanupBuffer ()

EHScopeStack::Cleanup *	getCleanup ()

bool	hasBranches () const
	True if this cleanup scope has any branch-afters or branch-throughs.

void	addBranchAfter (llvm::ConstantInt Index, llvm::BasicBlock Block)
	Add a branch-after to this cleanup scope.

unsigned	getNumBranchAfters () const
	Return the number of unique branch-afters on this scope.

llvm::BasicBlock *	getBranchAfterBlock (unsigned I) const

llvm::ConstantInt *	getBranchAfterIndex (unsigned I) const

bool	addBranchThrough (llvm::BasicBlock *Block)
	Add a branch-through to this cleanup scope.

bool	hasBranchThroughs () const
	Determines if this cleanup scope has any branch throughs.

Public Member Functions inherited from clang::CodeGen::EHScope
	EHScope (Kind kind, EHScopeStack::stable_iterator enclosingEHScope)

Kind	getKind () const

llvm::BasicBlock *	getCachedLandingPad () const

void	setCachedLandingPad (llvm::BasicBlock *block)

llvm::BasicBlock *	getCachedEHDispatchBlock () const

void	setCachedEHDispatchBlock (llvm::BasicBlock *block)

bool	hasEHBranches () const

EHScopeStack::stable_iterator	getEnclosingEHScope () const

Static Public Member Functions
static size_t	getSizeForCleanupSize (size_t Size)
	Gets the size required for a lazy cleanup scope with the given cleanup-data requirements.

static bool	classof (const EHScope *Scope)

Additional Inherited Members
Public Types inherited from clang::CodeGen::EHScope
enum	Kind { Cleanup , Catch , Terminate , Filter }

Protected Attributes inherited from clang::CodeGen::EHScope
union {
CommonBitFields CommonBits

CatchBitFields CatchBits

CleanupBitFields CleanupBits

FilterBitFields FilterBits

};

Detailed Description

A cleanup scope which generates the cleanup blocks lazily.

Definition at line 231 of file CGCleanup.h.

Constructor & Destructor Documentation

◆ EHCleanupScope()

clang::CodeGen::EHCleanupScope::EHCleanupScope	(	bool	isNormal,
		bool	isEH,
		unsigned	cleanupSize,
		unsigned	fixupDepth,
		EHScopeStack::stable_iterator	enclosingNormal,
		EHScopeStack::stable_iterator	enclosingEH
	)

inline

Definition at line 286 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ ~EHCleanupScope()

clang::CodeGen::EHCleanupScope::~EHCleanupScope ( )

delete

Member Function Documentation

◆ addBranchAfter()

void clang::CodeGen::EHCleanupScope::addBranchAfter	(	llvm::ConstantInt *	Index,
		llvm::BasicBlock *	Block
	)

inline

Add a branch-after to this cleanup scope.

A branch-after is a branch from a point protected by this (normal) cleanup to a point in the normal cleanup scope immediately containing it. For example, for (;;) { A a; break; } contains a branch-after.

Branch-afters each have their own destination out of the cleanup, guaranteed distinct from anything else threaded through it. Therefore branch-afters usually force a switch after the cleanup.

Definition at line 372 of file CGCleanup.h.

References clang::Block.

◆ addBranchThrough()

bool clang::CodeGen::EHCleanupScope::addBranchThrough ( llvm::BasicBlock * Block )

inline

Add a branch-through to this cleanup scope.

A branch-through is a branch from a scope protected by this (normal) cleanup to an enclosing scope other than the immediately-enclosing normal cleanup scope.

In the following example, the branch through B's scope is a branch-through, while the branch through A's scope is a branch-after: for (;;) { A a; B b; break; }

All branch-throughs have a common destination out of the cleanup, one possibly shared with the fall-through. Therefore branch-throughs usually don't force a switch after the cleanup.

Returns: true if the branch-through was new to this scope

Definition at line 409 of file CGCleanup.h.

References clang::Block.

◆ classof()

static bool clang::CodeGen::EHCleanupScope::classof ( const EHScope * Scope )

inlinestatic

Definition at line 419 of file CGCleanup.h.

References clang::CodeGen::EHScope::Cleanup.

◆ Destroy()

void clang::CodeGen::EHCleanupScope::Destroy ( )

inline

Definition at line 305 of file CGCleanup.h.

◆ getActiveFlag()

Address clang::CodeGen::EHCleanupScope::getActiveFlag ( ) const

inline

Definition at line 324 of file CGCleanup.h.

◆ getAllocatedSize()

size_t clang::CodeGen::EHCleanupScope::getAllocatedSize ( ) const

inline

Definition at line 282 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ getBranchAfterBlock()

llvm::BasicBlock * clang::CodeGen::EHCleanupScope::getBranchAfterBlock ( unsigned I ) const

inline

Definition at line 384 of file CGCleanup.h.

References getNumBranchAfters().

◆ getBranchAfterIndex()

llvm::ConstantInt * clang::CodeGen::EHCleanupScope::getBranchAfterIndex ( unsigned I ) const

inline

Definition at line 389 of file CGCleanup.h.

References getNumBranchAfters().

◆ getCleanup()

EHScopeStack::Cleanup * clang::CodeGen::EHCleanupScope::getCleanup ( )

inline

Definition at line 354 of file CGCleanup.h.

References getCleanupBuffer().

◆ getCleanupBuffer()

void * clang::CodeGen::EHCleanupScope::getCleanupBuffer ( )

inline

Definition at line 352 of file CGCleanup.h.

Referenced by getCleanup().

◆ getCleanupSize()

size_t clang::CodeGen::EHCleanupScope::getCleanupSize ( ) const

inline

Definition at line 351 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ getEnclosingNormalCleanup()

EHScopeStack::stable_iterator clang::CodeGen::EHCleanupScope::getEnclosingNormalCleanup ( ) const

inline

Definition at line 347 of file CGCleanup.h.

◆ getFixupDepth()

unsigned clang::CodeGen::EHCleanupScope::getFixupDepth ( ) const

inline

Definition at line 346 of file CGCleanup.h.

◆ getNormalBlock()

llvm::BasicBlock * clang::CodeGen::EHCleanupScope::getNormalBlock ( ) const

inline

Definition at line 312 of file CGCleanup.h.

Referenced by destroyOptimisticNormalEntry().

◆ getNumBranchAfters()

unsigned clang::CodeGen::EHCleanupScope::getNumBranchAfters ( ) const

inline

Return the number of unique branch-afters on this scope.

Definition at line 380 of file CGCleanup.h.

Referenced by getBranchAfterBlock(), and getBranchAfterIndex().

◆ getSizeForCleanupSize()

static size_t clang::CodeGen::EHCleanupScope::getSizeForCleanupSize ( size_t Size )

inlinestatic

Gets the size required for a lazy cleanup scope with the given cleanup-data requirements.

Definition at line 278 of file CGCleanup.h.

◆ hasActiveFlag()

bool clang::CodeGen::EHCleanupScope::hasActiveFlag ( ) const

inline

Definition at line 323 of file CGCleanup.h.

References clang::CodeGen::Address::isValid().

◆ hasBranches()

bool clang::CodeGen::EHCleanupScope::hasBranches ( ) const

inline

True if this cleanup scope has any branch-afters or branch-throughs.

Definition at line 359 of file CGCleanup.h.

◆ hasBranchThroughs()

bool clang::CodeGen::EHCleanupScope::hasBranchThroughs ( ) const

inline

Determines if this cleanup scope has any branch throughs.

Definition at line 414 of file CGCleanup.h.

◆ isActive()

bool clang::CodeGen::EHCleanupScope::isActive ( ) const

inline

Definition at line 317 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ isEHCleanup()

bool clang::CodeGen::EHCleanupScope::isEHCleanup ( ) const

inline

Definition at line 315 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ isLifetimeMarker()

bool clang::CodeGen::EHCleanupScope::isLifetimeMarker ( ) const

inline

Definition at line 320 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ isNormalCleanup()

bool clang::CodeGen::EHCleanupScope::isNormalCleanup ( ) const

inline

Definition at line 311 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ setActive()

void clang::CodeGen::EHCleanupScope::setActive ( bool A )

inline

Definition at line 318 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ setActiveFlag()

void clang::CodeGen::EHCleanupScope::setActiveFlag ( Address Var )

inline

Definition at line 327 of file CGCleanup.h.

References clang::CodeGen::Address::getAlignment(), and clang::CharUnits::isOne().

◆ setLifetimeMarker()

void clang::CodeGen::EHCleanupScope::setLifetimeMarker ( )

inline

Definition at line 321 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ setNormalBlock()

void clang::CodeGen::EHCleanupScope::setNormalBlock ( llvm::BasicBlock * BB )

inline

Definition at line 313 of file CGCleanup.h.

◆ setTestFlagInEHCleanup()

void clang::CodeGen::EHCleanupScope::setTestFlagInEHCleanup ( )

inline

Definition at line 339 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ setTestFlagInNormalCleanup()

void clang::CodeGen::EHCleanupScope::setTestFlagInNormalCleanup ( )

inline

Definition at line 332 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ shouldTestFlagInEHCleanup()

bool clang::CodeGen::EHCleanupScope::shouldTestFlagInEHCleanup ( ) const

inline

Definition at line 342 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

◆ shouldTestFlagInNormalCleanup()

bool clang::CodeGen::EHCleanupScope::shouldTestFlagInNormalCleanup ( ) const

inline

Definition at line 335 of file CGCleanup.h.

References clang::CodeGen::EHScope::CleanupBits.

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

lib/CodeGen/CGCleanup.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EHCleanupScope()

◆ ~EHCleanupScope()

Member Function Documentation

◆ addBranchAfter()

◆ addBranchThrough()

◆ classof()

◆ Destroy()

◆ getActiveFlag()

◆ getAllocatedSize()

◆ getBranchAfterBlock()

◆ getBranchAfterIndex()

◆ getCleanup()

◆ getCleanupBuffer()

◆ getCleanupSize()

◆ getEnclosingNormalCleanup()

◆ getFixupDepth()

◆ getNormalBlock()

◆ getNumBranchAfters()

◆ getSizeForCleanupSize()

◆ hasActiveFlag()

◆ hasBranches()

◆ hasBranchThroughs()

◆ isActive()

◆ isEHCleanup()

◆ isLifetimeMarker()

◆ isNormalCleanup()

◆ setActive()

◆ setActiveFlag()

◆ setLifetimeMarker()

◆ setNormalBlock()

◆ setTestFlagInEHCleanup()

◆ setTestFlagInNormalCleanup()

◆ shouldTestFlagInEHCleanup()

◆ shouldTestFlagInNormalCleanup()