LLVM 20.0.0git
Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::sandboxir::AllocaInst Class Referencefinal

#include "llvm/SandboxIR/SandboxIR.h"

Inheritance diagram for llvm::sandboxir::AllocaInst:
Inheritance graph
[legend]

Public Member Functions

bool isArrayAllocation () const
 Return true if there is an allocation size parameter to the allocation instruction that is not 1.
 
ValuegetArraySize ()
 Get the number of elements allocated.
 
const ValuegetArraySize () const
 
PointerTypegetType () const
 Overload to return most specific pointer type.
 
unsigned getAddressSpace () const
 Return the address space for the allocation.
 
std::optional< TypeSizegetAllocationSize (const DataLayout &DL) const
 Get allocation size in bytes.
 
std::optional< TypeSizegetAllocationSizeInBits (const DataLayout &DL) const
 Get allocation size in bits.
 
TypegetAllocatedType () const
 Return the type that is being allocated by the instruction.
 
void setAllocatedType (Type *Ty)
 for use only in special circumstances that need to generically transform a whole instruction (eg: IR linking and vectorization).
 
Align getAlign () const
 Return the alignment of the memory that is being allocated by the instruction.
 
void setAlignment (Align Align)
 
bool isStaticAlloca () const
 Return true if this alloca is in the entry block of the function and is a constant size.
 
bool isUsedWithInAlloca () const
 Return true if this alloca is used as an inalloca argument to a call.
 
void setUsedWithInAlloca (bool V)
 Specify whether this alloca is used to represent the arguments to a call.
 
- Public Member Functions inherited from llvm::sandboxir::SingleLLVMInstructionImpl< llvm::UnaryInstruction >
unsigned getUseOperandNo (const Use &Use) const final
 \Returns the operand index of Use.
 
unsigned getNumOfIRInstrs () const final
 This is used by BasicBlock::iterator.
 
void verify () const final
 Should crash if there is something wrong with the instruction.
 
void dumpOS (raw_ostream &OS) const override
 
- Public Member Functions inherited from llvm::sandboxir::Instruction
virtual unsigned getNumOfIRInstrs () const =0
 This is used by BasicBlock::iterator.
 
BBIterator getIterator () const
 \Returns a BasicBlock::iterator for this Instruction.
 
InstructiongetNextNode () const
 \Returns the next sandboxir::Instruction in the block, or nullptr if at the end of the block.
 
InstructiongetPrevNode () const
 \Returns the previous sandboxir::Instruction in the block, or nullptr if at the beginning of the block.
 
Opcode getOpcode () const
 \Returns this Instruction's opcode.
 
void removeFromParent ()
 Detach this from its parent BasicBlock without deleting it.
 
void eraseFromParent ()
 Detach this Value from its parent and delete it.
 
void insertBefore (Instruction *BeforeI)
 Insert this detached instruction before BeforeI.
 
void insertAfter (Instruction *AfterI)
 Insert this detached instruction after AfterI.
 
void insertInto (BasicBlock *BB, const BBIterator &WhereIt)
 Insert this detached instruction into BB at WhereIt.
 
void moveBefore (BasicBlock &BB, const BBIterator &WhereIt)
 Move this instruction to WhereIt.
 
void moveBefore (Instruction *Before)
 Move this instruction before Before.
 
void moveAfter (Instruction *After)
 Move this instruction after After.
 
BasicBlockgetParent () const
 \Returns the BasicBlock containing this Instruction, or null if it is detached.
 
bool hasNoUnsignedWrap () const
 Determine whether the no signed wrap flag is set.
 
void setHasNoUnsignedWrap (bool B=true)
 Set or clear the nuw flag on this instruction, which must be an operator which supports this flag.
 
bool hasNoSignedWrap () const
 Determine whether the no signed wrap flag is set.
 
void setHasNoSignedWrap (bool B=true)
 Set or clear the nsw flag on this instruction, which must be an operator which supports this flag.
 
bool isFast () const
 Determine whether all fast-math-flags are set.
 
void setFast (bool B)
 Set or clear all fast-math-flags on this instruction, which must be an operator which supports this flag.
 
bool hasAllowReassoc () const
 Determine whether the allow-reassociation flag is set.
 
void setHasAllowReassoc (bool B)
 Set or clear the reassociation flag on this instruction, which must be an operator which supports this flag.
 
bool isExact () const
 Determine whether the exact flag is set.
 
void setIsExact (bool B=true)
 Set or clear the exact flag on this instruction, which must be an operator which supports this flag.
 
bool hasNoNaNs () const
 Determine whether the no-NaNs flag is set.
 
void setHasNoNaNs (bool B)
 Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag.
 
bool hasNoInfs () const
 Determine whether the no-infs flag is set.
 
void setHasNoInfs (bool B)
 Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag.
 
bool hasNoSignedZeros () const
 Determine whether the no-signed-zeros flag is set.
 
void setHasNoSignedZeros (bool B)
 Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag.
 
bool hasAllowReciprocal () const
 Determine whether the allow-reciprocal flag is set.
 
void setHasAllowReciprocal (bool B)
 Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag.
 
bool hasAllowContract () const
 Determine whether the allow-contract flag is set.
 
void setHasAllowContract (bool B)
 Set or clear the allow-contract flag on this instruction, which must be an operator which supports this flag.
 
bool hasApproxFunc () const
 Determine whether the approximate-math-functions flag is set.
 
void setHasApproxFunc (bool B)
 Set or clear the approximate-math-functions flag on this instruction, which must be an operator which supports this flag.
 
FastMathFlags getFastMathFlags () const
 Convenience function for getting all the fast-math flags, which must be an operator which supports these flags.
 
void setFastMathFlags (FastMathFlags FMF)
 Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags.
 
void copyFastMathFlags (FastMathFlags FMF)
 Convenience function for transferring all fast-math flag values to this instruction, which must be an operator which supports these flags.
 
void dumpOS (raw_ostream &OS) const override
 
- 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
 
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
 
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
 
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.
 
TypegetType () const
 
ContextgetContext () const
 
void replaceUsesWithIf (Value *OtherV, llvm::function_ref< bool(const Use &)> ShouldReplace)
 
void replaceAllUsesWith (Value *Other)
 
StringRef getName () const
 \Returns the LLVM IR name of the bottom-most LLVM value.
 
virtual void verify () const =0
 Should crash if there is something wrong with the instruction.
 
std::string getUid () const
 Returns the unique id in the form 'SB<number>.' like 'SB1.'.
 
virtual void dumpCommonHeader (raw_ostream &OS) const
 
void dumpCommonFooter (raw_ostream &OS) const
 
void dumpCommonPrefix (raw_ostream &OS) const
 
void dumpCommonSuffix (raw_ostream &OS) const
 
void printAsOperandCommon (raw_ostream &OS) const
 
virtual void dumpOS (raw_ostream &OS) const =0
 
LLVM_DUMP_METHOD void dump () const
 

Static Public Member Functions

static AllocaInstcreate (Type *Ty, unsigned AddrSpace, BBIterator WhereIt, BasicBlock *WhereBB, Context &Ctx, Value *ArraySize=nullptr, const Twine &Name="")
 
static AllocaInstcreate (Type *Ty, unsigned AddrSpace, Instruction *InsertBefore, Context &Ctx, Value *ArraySize=nullptr, const Twine &Name="")
 
static AllocaInstcreate (Type *Ty, unsigned AddrSpace, BasicBlock *InsertAtEnd, Context &Ctx, Value *ArraySize=nullptr, const Twine &Name="")
 
static bool classof (const Value *From)
 
- Static Public Member Functions inherited from llvm::sandboxir::UnaryInstruction
static bool classof (const Instruction *I)
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::sandboxir::Instruction
static const chargetOpcodeName (Opcode Opc)
 
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::Instruction
enum class  Opcode { OP , OPCODES , DEF_INSTR }
 
- 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 { DEF_VALUE , DEF_USER , DEF_INSTR }
 
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::UnaryInstruction
 UnaryInstruction (ClassID ID, Opcode Opc, llvm::Instruction *LLVMI, Context &Ctx)
 
- Protected Member Functions inherited from llvm::sandboxir::Instruction
 Instruction (ClassID ID, Opcode Opc, llvm::Instruction *I, sandboxir::Context &SBCtx)
 
llvm::InstructiongetTopmostLLVMInstruction () const
 A SandboxIR Instruction may map to multiple LLVM IR Instruction.
 
virtual SmallVector< llvm::Instruction *, 1 > getLLVMInstrs () const =0
 \Returns the LLVM IR Instructions that this SandboxIR maps to in program order.
 
- 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.
 
virtual Use getOperandUseInternal (unsigned OpIdx, bool Verify) const =0
 \Returns the Use for the OpIdx'th operand.
 
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.
 
virtual unsigned getUseOperandNo (const Use &Use) const =0
 \Returns the operand index of Use.
 
void swapOperandsInternal (unsigned OpIdxA, unsigned OpIdxB)
 
void verifyUserOfLLVMUse (const llvm::Use &Use) const
 
- Protected Member Functions inherited from llvm::sandboxir::Value
void clearValue ()
 
 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::Instruction
Opcode Opc
 
- 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 1603 of file SandboxIR.h.

Member Function Documentation

◆ classof()

static bool llvm::sandboxir::AllocaInst::classof ( const Value From)
inlinestatic

Definition at line 1674 of file SandboxIR.h.

References From, and I.

◆ create() [1/3]

AllocaInst * AllocaInst::create ( Type Ty,
unsigned  AddrSpace,
BasicBlock InsertAtEnd,
Context Ctx,
Value ArraySize = nullptr,
const Twine Name = "" 
)
static

◆ create() [2/3]

AllocaInst * AllocaInst::create ( Type Ty,
unsigned  AddrSpace,
BBIterator  WhereIt,
BasicBlock WhereBB,
Context Ctx,
Value ArraySize = nullptr,
const Twine Name = "" 
)
static

◆ create() [3/3]

AllocaInst * AllocaInst::create ( Type Ty,
unsigned  AddrSpace,
Instruction InsertBefore,
Context Ctx,
Value ArraySize = nullptr,
const Twine Name = "" 
)
static

◆ getAddressSpace()

unsigned llvm::sandboxir::AllocaInst::getAddressSpace ( ) const
inline

Return the address space for the allocation.

Definition at line 1636 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

◆ getAlign()

Align llvm::sandboxir::AllocaInst::getAlign ( ) const
inline

Return the alignment of the memory that is being allocated by the instruction.

Definition at line 1658 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

◆ getAllocatedType()

Type * llvm::sandboxir::AllocaInst::getAllocatedType ( ) const
inline

Return the type that is being allocated by the instruction.

Definition at line 1650 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

Referenced by setAllocatedType().

◆ getAllocationSize()

std::optional< TypeSize > llvm::sandboxir::AllocaInst::getAllocationSize ( const DataLayout DL) const
inline

Get allocation size in bytes.

Returns std::nullopt if size can't be determined, e.g. in case of a VLA.

Definition at line 1641 of file SandboxIR.h.

References DL, and llvm::sandboxir::Value::Val.

◆ getAllocationSizeInBits()

std::optional< TypeSize > llvm::sandboxir::AllocaInst::getAllocationSizeInBits ( const DataLayout DL) const
inline

Get allocation size in bits.

Returns std::nullopt if size can't be determined, e.g. in case of a VLA.

Definition at line 1646 of file SandboxIR.h.

References DL, and llvm::sandboxir::Value::Val.

◆ getArraySize() [1/2]

Value * AllocaInst::getArraySize ( )

Get the number of elements allocated.

For a simple allocation of a single element, this will return a constant 1 value.

Definition at line 1469 of file SandboxIR.cpp.

References llvm::sandboxir::Value::Ctx, getArraySize(), llvm::sandboxir::Context::getValue(), and llvm::sandboxir::Value::Val.

Referenced by getArraySize().

◆ getArraySize() [2/2]

const Value * llvm::sandboxir::AllocaInst::getArraySize ( ) const
inline

Definition at line 1628 of file SandboxIR.h.

References getArraySize().

◆ getType()

PointerType * llvm::sandboxir::AllocaInst::getType ( ) const
inline

Overload to return most specific pointer type.

Definition at line 1632 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

◆ isArrayAllocation()

bool llvm::sandboxir::AllocaInst::isArrayAllocation ( ) const
inline

Return true if there is an allocation size parameter to the allocation instruction that is not 1.

Definition at line 1622 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

◆ isStaticAlloca()

bool llvm::sandboxir::AllocaInst::isStaticAlloca ( ) const
inline

Return true if this alloca is in the entry block of the function and is a constant size.

If so, the code generator will fold it into the prolog/epilog code, so it is basically free.

Definition at line 1663 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

◆ isUsedWithInAlloca()

bool llvm::sandboxir::AllocaInst::isUsedWithInAlloca ( ) const
inline

Return true if this alloca is used as an inalloca argument to a call.

Such allocas are never considered static even if they are in the entry block.

Definition at line 1668 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

Referenced by setUsedWithInAlloca().

◆ setAlignment()

void AllocaInst::setAlignment ( Align  Align)

◆ setAllocatedType()

void AllocaInst::setAllocatedType ( Type Ty)

for use only in special circumstances that need to generically transform a whole instruction (eg: IR linking and vectorization).

Definition at line 1447 of file SandboxIR.cpp.

References llvm::sandboxir::Value::Ctx, llvm::sandboxir::Tracker::emplaceIfTracking(), getAllocatedType(), llvm::sandboxir::Context::getTracker(), setAllocatedType(), and llvm::sandboxir::Value::Val.

Referenced by setAllocatedType().

◆ setUsedWithInAlloca()

void AllocaInst::setUsedWithInAlloca ( bool  V)

Specify whether this alloca is used to represent the arguments to a call.

Definition at line 1462 of file SandboxIR.cpp.

References llvm::sandboxir::Value::Ctx, llvm::sandboxir::Tracker::emplaceIfTracking(), llvm::sandboxir::Context::getTracker(), isUsedWithInAlloca(), setUsedWithInAlloca(), and llvm::sandboxir::Value::Val.

Referenced by setUsedWithInAlloca().

Friends And Related Function Documentation

◆ Context

friend class Context
friend

Definition at line 1607 of file SandboxIR.h.


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