LLVM 23.0.0git
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
llvm::ValueHandleBase Class Reference

This is the common base class of value handles. More...

#include "llvm/IR/ValueHandle.h"

Inheritance diagram for llvm::ValueHandleBase:
[legend]

Public Member Functions

 ValueHandleBase (HandleBaseKind Kind)
 ValueHandleBase (HandleBaseKind Kind, Value *V)
 ~ValueHandleBase ()
Value * operator= (Value *RHS)
Value * operator= (const ValueHandleBase &RHS)
Value * operator= (ValueHandleBase &&RHS)
Value * operator-> () const
Value & operator* () const

Static Public Member Functions

static LLVM_ABI void ValueIsDeleted (Value *V)
static LLVM_ABI void ValueIsRAUWd (Value *Old, Value *New)

Protected Types

enum  HandleBaseKind { Assert , Callback , Weak , WeakTracking }
 This indicates what sub class the handle actually is. More...

Protected Member Functions

 ValueHandleBase (const ValueHandleBase &RHS)
 ValueHandleBase (HandleBaseKind Kind, const ValueHandleBase &RHS)
 ValueHandleBase (HandleBaseKind Kind, ValueHandleBase &&RHS)
Value * getValPtr () const
LLVM_ABI void RemoveFromUseList ()
 Remove this ValueHandle from its current use list.
void clearValPtr ()
 Clear the underlying pointer without clearing the use list.

Static Protected Member Functions

static bool isValid (Value *V)

Friends

class Value
template<typename ValueTy>
class PoisoningVH

Detailed Description

This is the common base class of value handles.

ValueHandle's are smart pointers to Value's that have special behavior when the value is deleted or ReplaceAllUsesWith'd. See the specific handles below for details.

Definition at line 30 of file ValueHandle.h.

Member Enumeration Documentation

◆ HandleBaseKind

enum llvm::ValueHandleBase::HandleBaseKind
protected

This indicates what sub class the handle actually is.

This is to avoid having a vtable for the light-weight handle pointers. The fully general Callback version does have a vtable.

Enumerator
Assert 
Callback 
Weak 
WeakTracking 

Definition at line 39 of file ValueHandle.h.

Constructor & Destructor Documentation

◆ ValueHandleBase() [1/5]

llvm::ValueHandleBase::ValueHandleBase ( const ValueHandleBase & RHS)
inlineprotected

Definition at line 41 of file ValueHandle.h.

References RHS, and ValueHandleBase().

Referenced by llvm::CallbackVH::CallbackVH(), llvm::CallbackVH::CallbackVH(), operator=(), operator=(), llvm::WeakTrackingVH::operator=(), llvm::WeakVH::operator=(), ValueHandleBase(), ValueHandleBase(), ValueHandleBase(), llvm::WeakTrackingVH::WeakTrackingVH(), llvm::WeakTrackingVH::WeakTrackingVH(), llvm::WeakTrackingVH::WeakTrackingVH(), llvm::WeakVH::WeakVH(), llvm::WeakVH::WeakVH(), and llvm::WeakVH::WeakVH().

◆ ValueHandleBase() [2/5]

llvm::ValueHandleBase::ValueHandleBase ( HandleBaseKind Kind,
const ValueHandleBase & RHS )
inlineprotected

Definition at line 44 of file ValueHandle.h.

References getValPtr(), isValid(), RHS, and ValueHandleBase().

◆ ValueHandleBase() [3/5]

llvm::ValueHandleBase::ValueHandleBase ( HandleBaseKind Kind,
ValueHandleBase && RHS )
inlineprotected

Definition at line 50 of file ValueHandle.h.

References getValPtr(), isValid(), RHS, and ValueHandleBase().

◆ ValueHandleBase() [4/5]

llvm::ValueHandleBase::ValueHandleBase ( HandleBaseKind Kind)
inlineexplicit

Definition at line 67 of file ValueHandle.h.

◆ ValueHandleBase() [5/5]

llvm::ValueHandleBase::ValueHandleBase ( HandleBaseKind Kind,
Value * V )
inline

Definition at line 69 of file ValueHandle.h.

References getValPtr(), isValid(), and Value.

◆ ~ValueHandleBase()

llvm::ValueHandleBase::~ValueHandleBase ( )
inline

Definition at line 75 of file ValueHandle.h.

References getValPtr(), isValid(), and RemoveFromUseList().

Member Function Documentation

◆ clearValPtr()

void llvm::ValueHandleBase::clearValPtr ( )
inlineprotected

Clear the underlying pointer without clearing the use list.

This should only be used if a derived class has manually removed the handle from the use list.

Definition at line 145 of file ValueHandle.h.

◆ getValPtr()

Value * llvm::ValueHandleBase::getValPtr ( ) const
inlineprotected

Definition at line 130 of file ValueHandle.h.

References Value.

Referenced by llvm::SCEVUnknown::getType(), llvm::IVStrideUse::getUser(), llvm::SCEVUnknown::getValue(), llvm::PreservedCFGCheckerInstrumentation::BBGuard::isPoisoned(), llvm::CallbackVH::operator Value *(), llvm::WeakTrackingVH::operator Value *(), llvm::WeakVH::operator Value *(), operator*(), operator->(), operator=(), operator=(), operator=(), llvm::WeakTrackingVH::pointsToAliveValue(), llvm::ValueMapCallbackVH< KeyT, ValueT, Config >::Unwrap(), ValueHandleBase(), ValueHandleBase(), ValueHandleBase(), and ~ValueHandleBase().

◆ isValid()

bool llvm::ValueHandleBase::isValid ( Value * V)
inlinestaticprotected

Definition at line 132 of file ValueHandle.h.

References Value.

Referenced by operator=(), operator=(), operator=(), llvm::WeakTrackingVH::pointsToAliveValue(), ValueHandleBase(), ValueHandleBase(), ValueHandleBase(), and ~ValueHandleBase().

◆ operator*()

Value & llvm::ValueHandleBase::operator* ( ) const
inline

Definition at line 123 of file ValueHandle.h.

References assert(), getValPtr(), and Value.

◆ operator->()

Value * llvm::ValueHandleBase::operator-> ( ) const
inline

Definition at line 122 of file ValueHandle.h.

References getValPtr(), and Value.

◆ operator=() [1/3]

Value * llvm::ValueHandleBase::operator= ( const ValueHandleBase & RHS)
inline

Definition at line 91 of file ValueHandle.h.

References getValPtr(), isValid(), RemoveFromUseList(), RHS, Value, and ValueHandleBase().

◆ operator=() [2/3]

Value * llvm::ValueHandleBase::operator= ( Value * RHS)
inline

Definition at line 80 of file ValueHandle.h.

References getValPtr(), isValid(), RemoveFromUseList(), RHS, and Value.

Referenced by llvm::WeakTrackingVH::operator=(), llvm::WeakTrackingVH::operator=(), llvm::WeakVH::operator=(), llvm::WeakVH::operator=(), and llvm::CallbackVH::setValPtr().

◆ operator=() [3/3]

Value * llvm::ValueHandleBase::operator= ( ValueHandleBase && RHS)
inline

Definition at line 102 of file ValueHandle.h.

References getValPtr(), isValid(), RemoveFromUseList(), RHS, Value, and ValueHandleBase().

◆ RemoveFromUseList()

void ValueHandleBase::RemoveFromUseList ( )
protected

Remove this ValueHandle from its current use list.

Definition at line 1204 of file Value.cpp.

Referenced by operator=(), operator=(), operator=(), and ~ValueHandleBase().

◆ ValueIsDeleted()

void ValueHandleBase::ValueIsDeleted ( Value * V)
static

Definition at line 1233 of file Value.cpp.

◆ ValueIsRAUWd()

void ValueHandleBase::ValueIsRAUWd ( Value * Old,
Value * New )
static

Definition at line 1286 of file Value.cpp.

Referenced by llvm::MemorySSAUpdater::removeMemoryAccess(), and llvm::SSAUpdaterBulk::RewriteAllUses().

◆ PoisoningVH

template<typename ValueTy>
friend class PoisoningVH
friend

Definition at line 32 of file ValueHandle.h.

References PoisoningVH.

Referenced by PoisoningVH.

◆ Value

friend class Value
friend

Definition at line 31 of file ValueHandle.h.

References Value.

Referenced by llvm::CallbackVH::allUsesReplacedWith(), llvm::PreservedCFGCheckerInstrumentation::BBGuard::allUsesReplacedWith(), llvm::CallbackVH::CallbackVH(), llvm::CallbackVH::CallbackVH(), getValPtr(), isValid(), llvm::CallbackVH::operator Value *(), llvm::WeakTrackingVH::operator Value *(), llvm::WeakVH::operator Value *(), operator*(), operator->(), operator=(), operator=(), operator=(), llvm::WeakTrackingVH::operator=(), llvm::WeakTrackingVH::operator=(), llvm::WeakVH::operator=(), llvm::WeakVH::operator=(), llvm::CallbackVH::setValPtr(), Value, ValueHandleBase(), llvm::WeakTrackingVH::WeakTrackingVH(), and llvm::WeakVH::WeakVH().

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