LLVM 22.0.0git
llvm::sandboxir::PoisonValue Class Referencefinal

#include "llvm/SandboxIR/Constant.h"

Inheritance diagram for llvm::sandboxir::PoisonValue:
[legend]

Public Member Functions

LLVM_ABI PoisonValuegetSequentialElement () const
 If this poison has array or vector type, return a poison with the right element type.
LLVM_ABI PoisonValuegetStructElement (unsigned Elt) const
 If this poison has struct type, return a poison with the right element type for the specified element.
LLVM_ABI PoisonValuegetElementValue (Constant *C) const
 Return an poison of the right value for the specified GEP index if we can, otherwise return null (e.g.
LLVM_ABI PoisonValuegetElementValue (unsigned Idx) const
 Return an poison of the right value for the specified GEP index.
void verify () const override
 Should crash if there is something wrong with the instruction.
void dumpOS (raw_ostream &OS) const override
Public Member Functions inherited from llvm::sandboxir::UndefValue
LLVM_ABI UndefValuegetSequentialElement () const
 If this Undef has array or vector type, return a undef with the right element type.
LLVM_ABI UndefValuegetStructElement (unsigned Elt) const
 If this undef has struct type, return a undef with the right element type for the specified element.
LLVM_ABI UndefValuegetElementValue (Constant *C) const
 Return an undef of the right value for the specified GEP index if we can, otherwise return null (e.g.
LLVM_ABI UndefValuegetElementValue (unsigned Idx) const
 Return an undef of the right value for the specified GEP index.
unsigned getNumElements () const
 Return the number of elements in the array, vector, or struct.
unsigned getUseOperandNo (const Use &Use) const final
 \Returns the operand index of Use.
void verify () const override
 Should crash if there is something wrong with the instruction.
void dumpOS (raw_ostream &OS) const override
Public Member Functions inherited from llvm::sandboxir::Constant
sandboxir::ContextgetParent () const
Public Member Functions inherited from llvm::sandboxir::User
virtual op_iterator op_begin ()
virtual op_iterator op_end ()
virtual const_op_iterator op_begin () const
virtual const_op_iterator op_end () const
op_range operands ()
const_op_range operands () const
ValuegetOperand (unsigned OpIdx) const
Use getOperandUse (unsigned OpIdx) const
 \Returns the operand edge for OpIdx.
virtual unsigned getNumOperands () const
virtual void setOperand (unsigned OperandIdx, Value *Operand)
bool replaceUsesOfWith (Value *FromV, Value *ToV)
 Replaces any operands that match FromV with ToV.
void verify () const override
 Should crash if there is something wrong with the instruction.
void dumpCommonHeader (raw_ostream &OS) const final
void dumpOS (raw_ostream &OS) const override
Public Member Functions inherited from llvm::sandboxir::Value
virtual ~Value ()=default
ClassID getSubclassID () const
LLVM_ABI use_iterator use_begin ()
const_use_iterator use_begin () const
use_iterator use_end ()
const_use_iterator use_end () const
iterator_range< use_iteratoruses ()
iterator_range< const_use_iteratoruses () const
LLVM_ABI user_iterator user_begin ()
user_iterator user_end ()
const_user_iterator user_begin () const
const_user_iterator user_end () const
iterator_range< user_iteratorusers ()
iterator_range< const_user_iteratorusers () const
LLVM_ABI unsigned getNumUses () const
 \Returns the number of user edges (not necessarily to unique users).
bool hasNUsesOrMore (unsigned Num) const
 Return true if this value has N uses or more.
bool hasNUses (unsigned Num) const
 Return true if this Value has exactly N uses.
LLVM_ABI TypegetType () const
ContextgetContext () const
LLVM_ABI void replaceUsesWithIf (Value *OtherV, llvm::function_ref< bool(const Use &)> ShouldReplace)
LLVM_ABI void replaceAllUsesWith (Value *Other)
StringRef getName () const
 \Returns the LLVM IR name of the bottom-most LLVM value.
std::string getUid () const
 Returns the unique id in the form 'SB<number>.' like 'SB1.'.
void dumpCommonFooter (raw_ostream &OS) const
void dumpCommonPrefix (raw_ostream &OS) const
void dumpCommonSuffix (raw_ostream &OS) const
void printAsOperandCommon (raw_ostream &OS) const
LLVM_DUMP_METHOD void dump () const

Static Public Member Functions

static LLVM_ABI PoisonValueget (Type *T)
 Static factory methods - Return an 'poison' object of the specified type.
static bool classof (const sandboxir::Value *From)
 For isa/dyn_cast.
Static Public Member Functions inherited from llvm::sandboxir::UndefValue
static LLVM_ABI UndefValueget (Type *T)
 Static factory methods - Return an 'undef' object of the specified type.
static bool classof (const sandboxir::Value *From)
 For isa/dyn_cast.
Static Public Member Functions inherited from llvm::sandboxir::Constant
static bool classof (const sandboxir::Value *From)
 For isa/dyn_cast.
Static Public Member Functions inherited from llvm::sandboxir::User
static bool classof (const Value *From)
 For isa/dyn_cast.

Friends

class Context

Additional Inherited Members

Public Types inherited from llvm::sandboxir::User
using op_iterator = OperandUseIterator
using const_op_iterator = OperandUseIterator
using op_range = iterator_range<op_iterator>
using const_op_range = iterator_range<const_op_iterator>
Public Types inherited from llvm::sandboxir::Value
enum class  ClassID : unsigned
using use_iterator = UserUseIterator
using const_use_iterator = UserUseIterator
using user_iterator = mapped_iterator<sandboxir::UserUseIterator, UseToUser>
using const_user_iterator = user_iterator
Protected Member Functions inherited from llvm::sandboxir::UndefValue
 UndefValue (llvm::UndefValue *C, Context &Ctx)
 UndefValue (ClassID ID, llvm::Constant *C, Context &Ctx)
Protected Member Functions inherited from llvm::sandboxir::Constant
 Constant (llvm::Constant *C, sandboxir::Context &SBCtx)
 Constant (ClassID ID, llvm::Constant *C, sandboxir::Context &SBCtx)
Use getOperandUseInternal (unsigned OpIdx, bool Verify) const override
 \Returns the Use for the OpIdx'th operand.
Protected Member Functions inherited from llvm::sandboxir::User
 User (ClassID ID, llvm::Value *V, Context &Ctx)
Use getOperandUseDefault (unsigned OpIdx, bool Verify) const
 \Returns the Use edge that corresponds to OpIdx.
unsigned getUseOperandNoDefault (const Use &Use) const
 The default implementation works only for single-LLVMIR-instruction Users and only if they match exactly the LLVM instruction.
void swapOperandsInternal (unsigned OpIdxA, unsigned OpIdxB)
void verifyUserOfLLVMUse (const llvm::Use &Use) const
Protected Member Functions inherited from llvm::sandboxir::Value
void clearValue ()
LLVM_ABI Value (ClassID SubclassID, llvm::Value *Val, Context &Ctx)
 Value (const Value &)=delete
 Disable copies.
Valueoperator= (const Value &)=delete
Static Protected Member Functions inherited from llvm::sandboxir::Value
static const chargetSubclassIDStr (ClassID ID)
Protected Attributes inherited from llvm::sandboxir::Value
ClassID SubclassID
 For isa/dyn_cast.
unsigned UID
 A unique ID used for forming the name (used for debugging).
llvm::ValueVal = nullptr
 The LLVM Value that corresponds to this SandboxIR Value.
ContextCtx
 All values point to the context.

Detailed Description

Definition at line 848 of file Constant.h.

Member Function Documentation

◆ classof()

bool llvm::sandboxir::PoisonValue::classof ( const sandboxir::Value * From)
inlinestatic

For isa/dyn_cast.

Definition at line 873 of file Constant.h.

References llvm::sandboxir::Value::getSubclassID().

◆ dumpOS()

void llvm::sandboxir::PoisonValue::dumpOS ( raw_ostream & OS) const
inlineoverridevirtual

◆ get()

PoisonValue * llvm::sandboxir::PoisonValue::get ( Type * T)
static

Static factory methods - Return an 'poison' object of the specified type.

Definition at line 259 of file Constant.cpp.

References llvm::cast(), llvm::PoisonValue::get(), and T.

◆ getElementValue() [1/2]

PoisonValue * llvm::sandboxir::PoisonValue::getElementValue ( Constant * C) const

Return an poison of the right value for the specified GEP index if we can, otherwise return null (e.g.

if C is a ConstantExpr).

Definition at line 274 of file Constant.cpp.

References llvm::CallingConv::C, llvm::cast(), llvm::sandboxir::Value::Ctx, and llvm::sandboxir::Value::Val.

◆ getElementValue() [2/2]

PoisonValue * llvm::sandboxir::PoisonValue::getElementValue ( unsigned Idx) const

Return an poison of the right value for the specified GEP index.

Definition at line 280 of file Constant.cpp.

References llvm::cast(), llvm::sandboxir::Value::Ctx, and llvm::sandboxir::Value::Val.

◆ getSequentialElement()

PoisonValue * llvm::sandboxir::PoisonValue::getSequentialElement ( ) const

If this poison has array or vector type, return a poison with the right element type.

Definition at line 264 of file Constant.cpp.

References llvm::cast(), llvm::sandboxir::Value::Ctx, and llvm::sandboxir::Value::Val.

◆ getStructElement()

PoisonValue * llvm::sandboxir::PoisonValue::getStructElement ( unsigned Elt) const

If this poison has struct type, return a poison with the right element type for the specified element.

Definition at line 269 of file Constant.cpp.

References llvm::cast(), llvm::sandboxir::Value::Ctx, and llvm::sandboxir::Value::Val.

◆ verify()

void llvm::sandboxir::PoisonValue::verify ( ) const
inlineoverridevirtual

Should crash if there is something wrong with the instruction.

Reimplemented from llvm::sandboxir::Constant.

Definition at line 877 of file Constant.h.

References assert(), llvm::isa(), and llvm::sandboxir::Value::Val.

◆ Context

friend class Context
friend

Definition at line 851 of file Constant.h.

References llvm::CallingConv::C, Context, LLVM_ABI, and T.

Referenced by Context.


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