an instruction for type-safe pointer arithmetic to access elements of arrays and structs More...

#include "llvm/IR/Instructions.h"

Inheritance diagram for llvm::GetElementPtrInst:

Public Member Functions
	DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
	Transparently provide more efficient getOperand methods.
Type *	getSourceElementType () const
void	setSourceElementType (Type *Ty)
void	setResultElementType (Type *Ty)
Type *	getResultElementType () const
unsigned	getAddressSpace () const
	Returns the address space of this instruction's pointer type.
op_iterator	idx_begin ()
const_op_iterator	idx_begin () const
op_iterator	idx_end ()
const_op_iterator	idx_end () const
iterator_range< op_iterator >	indices ()
iterator_range< const_op_iterator >	indices () const
Value *	getPointerOperand ()
const Value *	getPointerOperand () const
Type *	getPointerOperandType () const
	Method to return the pointer operand as a PointerType.
unsigned	getPointerAddressSpace () const
	Returns the address space of the pointer operand.
unsigned	getNumIndices () const
bool	hasIndices () const
LLVM_ABI bool	hasAllZeroIndices () const
	Return true if all of the indices of this GEP are zeros.
LLVM_ABI bool	hasAllConstantIndices () const
	Return true if all of the indices of this GEP are constant integers.
LLVM_ABI void	setNoWrapFlags (GEPNoWrapFlags NW)
	Set nowrap flags for GEP instruction.
LLVM_ABI void	setIsInBounds (bool b=true)
	Set or clear the inbounds flag on this GEP instruction.
LLVM_ABI GEPNoWrapFlags	getNoWrapFlags () const
	Get the nowrap flags for the GEP instruction.
LLVM_ABI bool	isInBounds () const
	Determine whether the GEP has the inbounds flag.
LLVM_ABI bool	hasNoUnsignedSignedWrap () const
	Determine whether the GEP has the nusw flag.
LLVM_ABI bool	hasNoUnsignedWrap () const
	Determine whether the GEP has the nuw flag.
LLVM_ABI bool	accumulateConstantOffset (const DataLayout &DL, APInt &Offset) const
	Accumulate the constant address offset of this GEP if possible.
LLVM_ABI bool	collectOffset (const DataLayout &DL, unsigned BitWidth, SmallMapVector< Value *, APInt, 4 > &VariableOffsets, APInt &ConstantOffset) const
Public Member Functions inherited from llvm::Instruction
LLVM_ABI iterator_range< simple_ilist< DbgRecord >::iterator >	cloneDebugInfoFrom (const Instruction *From, std::optional< simple_ilist< DbgRecord >::iterator > FromHere=std::nullopt, bool InsertAtHead=false)
	Clone any debug-info attached to `From` onto this instruction.
iterator_range< simple_ilist< DbgRecord >::iterator >	getDbgRecordRange () const
	Return a range over the DbgRecords attached to this instruction.
LLVM_ABI std::optional< simple_ilist< DbgRecord >::iterator >	getDbgReinsertionPosition ()
	Return an iterator to the position of the "Next" DbgRecord after this instruction, or std::nullopt.
LLVM_ABI bool	hasDbgRecords () const
	Returns true if any DbgRecords are attached to this instruction.
LLVM_ABI void	adoptDbgRecords (BasicBlock *BB, InstListType::iterator It, bool InsertAtHead)
	Transfer any DbgRecords on the position `It` onto this instruction, by simply adopting the sequence of DbgRecords (which is efficient) if possible, by merging two sequences otherwise.
LLVM_ABI void	dropDbgRecords ()
	Erase any DbgRecords attached to this instruction.
LLVM_ABI void	dropOneDbgRecord (DbgRecord *I)
	Erase a single DbgRecord `I` that is attached to this instruction.
LLVM_ABI void	handleMarkerRemoval ()
	Handle the debug-info implications of this instruction being removed.
	Instruction (const Instruction &)=delete
Instruction &	operator= (const Instruction &)=delete
Instruction *	user_back ()
	Specialize the methods defined in Value, as we know that an instruction can only be used by other instructions.
const Instruction *	user_back () const
LLVM_ABI const Module *	getModule () const
	Return the module owning the function this instruction belongs to or nullptr it the function does not have a module.
Module *	getModule ()
LLVM_ABI const Function *	getFunction () const
	Return the function this instruction belongs to.
Function *	getFunction ()
LLVM_ABI const DataLayout &	getDataLayout () const
	Get the data layout of the module this instruction belongs to.
LLVM_ABI void	removeFromParent ()
	This method unlinks 'this' from the containing basic block, but does not delete it.
LLVM_ABI InstListType::iterator	eraseFromParent ()
	This method unlinks 'this' from the containing basic block and deletes it.
LLVM_ABI	LLVM_DEPRECATED ("Use iterators as instruction positions", "") void insertBefore(Instruction *InsertPos)
	Insert an unlinked instruction into a basic block immediately before the specified instruction.
LLVM_ABI void	insertBefore (InstListType::iterator InsertPos)
	Insert an unlinked instruction into a basic block immediately before the specified position.
LLVM_ABI void	insertAfter (Instruction *InsertPos)
	Insert an unlinked instruction into a basic block immediately after the specified instruction.
LLVM_ABI void	insertAfter (InstListType::iterator InsertPos)
	Insert an unlinked instruction into a basic block immediately after the specified position.
LLVM_ABI InstListType::iterator	insertInto (BasicBlock *ParentBB, InstListType::iterator It)
	Inserts an unlinked instruction into `ParentBB` at position `It` and returns the iterator of the inserted instruction.
LLVM_ABI void	insertBefore (BasicBlock &BB, InstListType::iterator InsertPos)
LLVM_ABI	LLVM_DEPRECATED ("Use iterators as instruction positions", "") void moveBefore(Instruction *MovePos)
	Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right before MovePos.
LLVM_ABI void	moveBefore (InstListType::iterator InsertPos)
	Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right before MovePos.
LLVM_ABI void	moveBeforePreserving (InstListType::iterator MovePos)
	Perform a moveBefore operation, while signalling that the caller intends to preserve the original ordering of instructions.
LLVM_ABI void	moveBeforePreserving (BasicBlock &BB, InstListType::iterator I)
	Perform a moveBefore operation, while signalling that the caller intends to preserve the original ordering of instructions.
LLVM_ABI	LLVM_DEPRECATED ("Use iterators as instruction positions", "") void moveBeforePreserving(Instruction *MovePos)
	Perform a moveBefore operation, while signalling that the caller intends to preserve the original ordering of instructions.
LLVM_ABI void	moveBefore (BasicBlock &BB, InstListType::iterator I)
	Unlink this instruction and insert into BB before I.
LLVM_ABI void	moveAfter (Instruction *MovePos)
	Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right after MovePos.
LLVM_ABI void	moveAfter (InstListType::iterator MovePos)
	Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right after MovePos.
LLVM_ABI void	moveAfterPreserving (Instruction *MovePos)
	See moveBeforePreserving .
LLVM_ABI bool	comesBefore (const Instruction *Other) const
	Given an instruction Other in the same basic block as this instruction, return true if this instruction comes before Other.
LLVM_ABI std::optional< InstListType::iterator >	getInsertionPointAfterDef ()
	Get the first insertion point at which the result of this instruction is defined.
unsigned	getOpcode () const
	Returns a member of one of the enums like Instruction::Add.
const char *	getOpcodeName () const
bool	isTerminator () const
bool	isUnaryOp () const
bool	isBinaryOp () const
bool	isIntDivRem () const
bool	isFPDivRem () const
bool	isShift () const
bool	isCast () const
bool	isFuncletPad () const
bool	isSpecialTerminator () const
LLVM_ABI bool	isOnlyUserOfAnyOperand ()
	It checks if this instruction is the only user of at least one of its operands.
bool	isLogicalShift () const
	Return true if this is a logical shift left or a logical shift right.
bool	isArithmeticShift () const
	Return true if this is an arithmetic shift right.
bool	isBitwiseLogicOp () const
	Return true if this is and/or/xor.
bool	hasMetadata () const
	Return true if this instruction has any metadata attached to it.
LLVM_ABI bool	hasNonDebugLocLoopMetadata () const
bool	hasMetadataOtherThanDebugLoc () const
	Return true if this instruction has metadata attached to it other than a debug location.
bool	hasMetadata (unsigned KindID) const
	Return true if this instruction has the given type of metadata attached.
bool	hasMetadata (StringRef Kind) const
	Return true if this instruction has the given type of metadata attached.
MDNode *	getMetadata (unsigned KindID) const
	Get the metadata of given kind attached to this Instruction.
MDNode *	getMetadata (StringRef Kind) const
	Get the metadata of given kind attached to this Instruction.
void	getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
	Get all metadata attached to this Instruction.
void	getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
	This does the same thing as getAllMetadata, except that it filters out the debug location.
LLVM_ABI void	setMetadata (unsigned KindID, MDNode *Node)
	Set the metadata of the specified kind to the specified node.
LLVM_ABI void	setMetadata (StringRef Kind, MDNode *Node)
LLVM_ABI void	copyMetadata (const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >())
	Copy metadata from `SrcInst` to this instruction.
LLVM_ABI void	eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
	Erase all metadata that matches the predicate.
LLVM_ABI void	swapProfMetadata ()
	If the instruction has "branch_weights" MD_prof metadata and the MDNode has three operands (including name string), swap the order of the metadata.
LLVM_ABI void	addAnnotationMetadata (StringRef Annotation)
	Adds an !annotation metadata node with `Annotation` to this instruction.
LLVM_ABI void	addAnnotationMetadata (SmallVector< StringRef > Annotations)
	Adds an !annotation metadata node with an array of `Annotations` as a tuple to this instruction.
LLVM_ABI AAMDNodes	getAAMetadata () const
	Returns the AA metadata for this instruction.
LLVM_ABI void	setAAMetadata (const AAMDNodes &N)
	Sets the AA metadata on this instruction from the AAMDNodes structure.
LLVM_ABI void	setNoSanitizeMetadata ()
	Sets the nosanitize metadata on this instruction.
LLVM_ABI bool	extractProfTotalWeight (uint64_t &TotalVal) const
	Retrieve total raw weight values of a branch.
void	setDebugLoc (DebugLoc Loc)
	Set the debug location information for this instruction.
const DebugLoc &	getDebugLoc () const
	Return the debug location for this node as a DebugLoc.
LLVM_ABI const DebugLoc &	getStableDebugLoc () const
	Fetch the debug location for this node, unless this is a debug intrinsic, in which case fetch the debug location of the next non-debug node.
LLVM_ABI void	setHasNoUnsignedWrap (bool b=true)
	Set or clear the nuw flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasNoSignedWrap (bool b=true)
	Set or clear the nsw flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setIsExact (bool b=true)
	Set or clear the exact flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setNonNeg (bool b=true)
	Set or clear the nneg flag on this instruction, which must be a zext instruction.
LLVM_ABI bool	hasNoUnsignedWrap () const LLVM_READONLY
	Determine whether the no unsigned wrap flag is set.
LLVM_ABI bool	hasNoSignedWrap () const LLVM_READONLY
	Determine whether the no signed wrap flag is set.
LLVM_ABI bool	hasNonNeg () const LLVM_READONLY
	Determine whether the the nneg flag is set.
LLVM_ABI bool	hasPoisonGeneratingFlags () const LLVM_READONLY
	Return true if this operator has flags which may cause this instruction to evaluate to poison despite having non-poison inputs.
LLVM_ABI void	dropPoisonGeneratingFlags ()
	Drops flags that may cause this instruction to evaluate to poison despite having non-poison inputs.
LLVM_ABI bool	hasPoisonGeneratingMetadata () const LLVM_READONLY
	Return true if this instruction has poison-generating metadata.
LLVM_ABI void	dropPoisonGeneratingMetadata ()
	Drops metadata that may generate poison.
LLVM_ABI bool	hasPoisonGeneratingReturnAttributes () const LLVM_READONLY
	Return true if this instruction has poison-generating attribute.
LLVM_ABI void	dropPoisonGeneratingReturnAttributes ()
	Drops return attributes that may generate poison.
bool	hasPoisonGeneratingAnnotations () const
	Return true if this instruction has poison-generating flags, return attributes or metadata.
void	dropPoisonGeneratingAnnotations ()
	Drops flags, return attributes and metadata that may generate poison.
LLVM_ABI void	dropUBImplyingAttrsAndUnknownMetadata (ArrayRef< unsigned > KnownIDs={})
	This function drops non-debug unknown metadata (through dropUnknownNonDebugMetadata).
LLVM_ABI void	dropUBImplyingAttrsAndMetadata (ArrayRef< unsigned > Keep={})
	Drop any attributes or metadata that can cause immediate undefined behavior.
LLVM_ABI bool	hasUBImplyingAttrs () const LLVM_READONLY
	Return true if this instruction has UB-implying attributes that can cause immediate undefined behavior.
LLVM_ABI bool	isExact () const LLVM_READONLY
	Determine whether the exact flag is set.
LLVM_ABI void	setFast (bool B)
	Set or clear all fast-math-flags on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasAllowReassoc (bool B)
	Set or clear the reassociation flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasNoNaNs (bool B)
	Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasNoInfs (bool B)
	Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasNoSignedZeros (bool B)
	Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasAllowReciprocal (bool B)
	Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasAllowContract (bool B)
	Set or clear the allow-contract flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasApproxFunc (bool B)
	Set or clear the approximate-math-functions flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setFastMathFlags (FastMathFlags FMF)
	Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags.
LLVM_ABI 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.
LLVM_ABI bool	isFast () const LLVM_READONLY
	Determine whether all fast-math-flags are set.
LLVM_ABI bool	hasAllowReassoc () const LLVM_READONLY
	Determine whether the allow-reassociation flag is set.
LLVM_ABI bool	hasNoNaNs () const LLVM_READONLY
	Determine whether the no-NaNs flag is set.
LLVM_ABI bool	hasNoInfs () const LLVM_READONLY
	Determine whether the no-infs flag is set.
LLVM_ABI bool	hasNoSignedZeros () const LLVM_READONLY
	Determine whether the no-signed-zeros flag is set.
LLVM_ABI bool	hasAllowReciprocal () const LLVM_READONLY
	Determine whether the allow-reciprocal flag is set.
LLVM_ABI bool	hasAllowContract () const LLVM_READONLY
	Determine whether the allow-contract flag is set.
LLVM_ABI bool	hasApproxFunc () const LLVM_READONLY
	Determine whether the approximate-math-functions flag is set.
LLVM_ABI FastMathFlags	getFastMathFlags () const LLVM_READONLY
	Convenience function for getting all the fast-math flags, which must be an operator which supports these flags.
LLVM_ABI void	copyFastMathFlags (const Instruction *I)
	Copy I's fast-math flags.
LLVM_ABI void	copyIRFlags (const Value *V, bool IncludeWrapFlags=true)
	Convenience method to copy supported exact, fast-math, and (optionally) wrapping flags from V to this instruction.
LLVM_ABI void	andIRFlags (const Value *V)
	Logical 'and' of any supported wrapping, exact, and fast-math flags of V and this instruction.
LLVM_ABI void	applyMergedLocation (DebugLoc LocA, DebugLoc LocB)
	Merge 2 debug locations and apply it to the Instruction.
LLVM_ABI void	updateLocationAfterHoist ()
	Updates the debug location given that the instruction has been hoisted from a block to a predecessor of that block.
LLVM_ABI void	dropLocation ()
	Drop the instruction's debug location.
LLVM_ABI void	mergeDIAssignID (ArrayRef< const Instruction * > SourceInstructions)
	Merge the DIAssignID metadata from this instruction and those attached to instructions in `SourceInstructions`.
LLVM_ABI bool	isAssociative () const LLVM_READONLY
	Return true if the instruction is associative:
LLVM_ABI bool	isCommutative () const LLVM_READONLY
	Return true if the instruction is commutative:
bool	isIdempotent () const
	Return true if the instruction is idempotent:
bool	isNilpotent () const
	Return true if the instruction is nilpotent:
LLVM_ABI bool	mayWriteToMemory () const LLVM_READONLY
	Return true if this instruction may modify memory.
LLVM_ABI bool	mayReadFromMemory () const LLVM_READONLY
	Return true if this instruction may read memory.
bool	mayReadOrWriteMemory () const
	Return true if this instruction may read or write memory.
LLVM_ABI bool	isAtomic () const LLVM_READONLY
	Return true if this instruction has an AtomicOrdering of unordered or higher.
LLVM_ABI bool	hasAtomicLoad () const LLVM_READONLY
	Return true if this atomic instruction loads from memory.
LLVM_ABI bool	hasAtomicStore () const LLVM_READONLY
	Return true if this atomic instruction stores to memory.
LLVM_ABI bool	isVolatile () const LLVM_READONLY
	Return true if this instruction has a volatile memory access.
LLVM_ABI Type *	getAccessType () const LLVM_READONLY
	Return the type this instruction accesses in memory, if any.
LLVM_ABI bool	mayThrow (bool IncludePhaseOneUnwind=false) const LLVM_READONLY
	Return true if this instruction may throw an exception.
bool	isFenceLike () const
	Return true if this instruction behaves like a memory fence: it can load or store to memory location without being given a memory location.
LLVM_ABI bool	mayHaveSideEffects () const LLVM_READONLY
	Return true if the instruction may have side effects.
LLVM_ABI bool	isSafeToRemove () const LLVM_READONLY
	Return true if the instruction can be removed if the result is unused.
LLVM_ABI bool	willReturn () const LLVM_READONLY
	Return true if the instruction will return (unwinding is considered as a form of returning control flow here).
bool	isEHPad () const
	Return true if the instruction is a variety of EH-block.
LLVM_ABI bool	isLifetimeStartOrEnd () const LLVM_READONLY
	Return true if the instruction is a llvm.lifetime.start or llvm.lifetime.end marker.
LLVM_ABI bool	isLaunderOrStripInvariantGroup () const LLVM_READONLY
	Return true if the instruction is a llvm.launder.invariant.group or llvm.strip.invariant.group.
LLVM_ABI bool	isDebugOrPseudoInst () const LLVM_READONLY
	Return true if the instruction is a DbgInfoIntrinsic or PseudoProbeInst.
LLVM_ABI Instruction *	clone () const
	Create a copy of 'this' instruction that is identical in all ways except the following:
LLVM_ABI bool	isIdenticalTo (const Instruction *I) const LLVM_READONLY
	Return true if the specified instruction is exactly identical to the current one.
LLVM_ABI bool	isIdenticalToWhenDefined (const Instruction *I, bool IntersectAttrs=false) const LLVM_READONLY
	This is like isIdenticalTo, except that it ignores the SubclassOptionalData flags, which may specify conditions under which the instruction's result is undefined.
LLVM_ABI bool	isSameOperationAs (const Instruction *I, unsigned flags=0) const LLVM_READONLY
	This function determines if the specified instruction executes the same operation as the current one.
LLVM_ABI bool	hasSameSpecialState (const Instruction *I2, bool IgnoreAlignment=false, bool IntersectAttrs=false) const LLVM_READONLY
	This function determines if the speficied instruction has the same "special" characteristics as the current one.
LLVM_ABI bool	isUsedOutsideOfBlock (const BasicBlock *BB) const LLVM_READONLY
	Return true if there are any uses of this instruction in blocks other than the specified block.
LLVM_ABI unsigned	getNumSuccessors () const LLVM_READONLY
	Return the number of successors that this instruction has.
LLVM_ABI BasicBlock *	getSuccessor (unsigned Idx) const LLVM_READONLY
	Return the specified successor. This instruction must be a terminator.
LLVM_ABI void	setSuccessor (unsigned Idx, BasicBlock *BB)
	Update the specified successor to point at the provided block.
LLVM_ABI void	replaceSuccessorWith (BasicBlock OldBB, BasicBlock NewBB)
	Replace specified successor OldBB to point at the provided block.
LLVM_ABI void	dropUnknownNonDebugMetadata (ArrayRef< unsigned > KnownIDs={})
	Drop all unknown metadata except for debug locations.
Public Member Functions inherited from llvm::User
	User (const User &)=delete
LLVM_ABI void	operator delete (void *Usr)
	Free memory allocated for User and Use objects.
void	operator delete (void *Usr, HungOffOperandsAllocMarker)
	Placement delete - required by std, called if the ctor throws.
void	operator delete (void *Usr, IntrusiveOperandsAllocMarker)
	Placement delete - required by std, called if the ctor throws.
void	operator delete (void *Usr, IntrusiveOperandsAndDescriptorAllocMarker)
	Placement delete - required by std, called if the ctor throws.
const Use *	getOperandList () const
Use *	getOperandList ()
Value *	getOperand (unsigned i) const
void	setOperand (unsigned i, Value *Val)
const Use &	getOperandUse (unsigned i) const
Use &	getOperandUse (unsigned i)
unsigned	getNumOperands () const
LLVM_ABI ArrayRef< const uint8_t >	getDescriptor () const
	Returns the descriptor co-allocated with this User instance.
LLVM_ABI MutableArrayRef< uint8_t >	getDescriptor ()
	Returns the descriptor co-allocated with this User instance.
void	setNumHungOffUseOperands (unsigned NumOps)
	Subclasses with hung off uses need to manage the operand count themselves.
LLVM_ABI bool	isDroppable () const
	A droppable user is a user for which uses can be dropped without affecting correctness and should be dropped rather than preventing a transformation from happening.
op_iterator	op_begin ()
const_op_iterator	op_begin () const
op_iterator	op_end ()
const_op_iterator	op_end () const
op_range	operands ()
const_op_range	operands () const
value_op_iterator	value_op_begin ()
value_op_iterator	value_op_end ()
iterator_range< value_op_iterator >	operand_values ()
const_value_op_iterator	value_op_begin () const
const_value_op_iterator	value_op_end () const
iterator_range< const_value_op_iterator >	operand_values () const
void	dropAllReferences ()
	Drop all references to operands.
LLVM_ABI bool	replaceUsesOfWith (Value From, Value To)
	Replace uses of one Value with another.
Public Member Functions inherited from llvm::Value
	Value (const Value &)=delete
Value &	operator= (const Value &)=delete
LLVM_ABI void	deleteValue ()
	Delete a pointer to a generic Value.
LLVM_ABI void	dump () const
	Support for debugging, callable in GDB: V->dump()
Type *	getType () const
	All values are typed, get the type of this value.
LLVM_ABI LLVMContext &	getContext () const
	All values hold a context through their type.
bool	hasName () const
LLVM_ABI ValueName *	getValueName () const
LLVM_ABI void	setValueName (ValueName *VN)
LLVM_ABI StringRef	getName () const
	Return a constant reference to the value's name.
LLVM_ABI void	setName (const Twine &Name)
	Change the name of the value.
LLVM_ABI void	takeName (Value *V)
	Transfer the name from V to this value.
LLVM_ABI std::string	getNameOrAsOperand () const
LLVM_ABI void	replaceAllUsesWith (Value *V)
	Change all uses of this to point to a new Value.
LLVM_ABI void	replaceNonMetadataUsesWith (Value *V)
	Change non-metadata uses of this to point to a new Value.
LLVM_ABI void	replaceUsesWithIf (Value *New, llvm::function_ref< bool(Use &U)> ShouldReplace)
	Go through the uses list for this definition and make each use point to "V" if the callback ShouldReplace returns true for the given Use.
LLVM_ABI void	replaceUsesOutsideBlock (Value V, BasicBlock BB)
	replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block.
LLVM_ABI void	assertModuleIsMaterializedImpl () const
void	assertModuleIsMaterialized () const
bool	hasUseList () const
	Check if this Value has a use-list.
bool	use_empty () const
bool	materialized_use_empty () const
use_iterator	materialized_use_begin ()
const_use_iterator	materialized_use_begin () const
use_iterator	use_begin ()
const_use_iterator	use_begin () const
use_iterator	use_end ()
const_use_iterator	use_end () const
iterator_range< use_iterator >	materialized_uses ()
iterator_range< const_use_iterator >	materialized_uses () const
iterator_range< use_iterator >	uses ()
iterator_range< const_use_iterator >	uses () const
bool	user_empty () const
user_iterator	materialized_user_begin ()
const_user_iterator	materialized_user_begin () const
user_iterator	user_begin ()
const_user_iterator	user_begin () const
user_iterator	user_end ()
const_user_iterator	user_end () const
User *	user_back ()
const User *	user_back () const
iterator_range< user_iterator >	materialized_users ()
iterator_range< const_user_iterator >	materialized_users () const
iterator_range< user_iterator >	users ()
iterator_range< const_user_iterator >	users () const
bool	hasOneUse () const
	Return true if there is exactly one use of this value.
LLVM_ABI bool	hasNUses (unsigned N) const
	Return true if this Value has exactly N uses.
LLVM_ABI bool	hasNUsesOrMore (unsigned N) const
	Return true if this value has N uses or more.
LLVM_ABI bool	hasOneUser () const
	Return true if there is exactly one user of this value.
LLVM_ABI Use *	getSingleUndroppableUse ()
	Return true if there is exactly one use of this value that cannot be dropped.
const Use *	getSingleUndroppableUse () const
LLVM_ABI User *	getUniqueUndroppableUser ()
	Return true if there is exactly one unique user of this value that cannot be dropped (that user can have multiple uses of this value).
const User *	getUniqueUndroppableUser () const
LLVM_ABI bool	hasNUndroppableUses (unsigned N) const
	Return true if there this value.
LLVM_ABI bool	hasNUndroppableUsesOrMore (unsigned N) const
	Return true if this value has N uses or more.
LLVM_ABI void	dropDroppableUses (llvm::function_ref< bool(const Use )> ShouldDrop=[](const Use ) { return true;})
	Remove every uses that can safely be removed.
LLVM_ABI void	dropDroppableUsesIn (User &Usr)
	Remove every use of this value in `User` that can safely be removed.
LLVM_ABI bool	isUsedInBasicBlock (const BasicBlock *BB) const
	Check if this value is used in the specified basic block.
LLVM_ABI unsigned	getNumUses () const
	This method computes the number of uses of this Value.
void	addUse (Use &U)
	This method should only be used by the Use class.
unsigned	getValueID () const
	Return an ID for the concrete type of this object.
unsigned	getRawSubclassOptionalData () const
	Return the raw optional flags value contained in this value.
void	clearSubclassOptionalData ()
	Clear the optional flags contained in this value.
bool	hasSameSubclassOptionalData (const Value *V) const
	Check the optional flags for equality.
bool	hasValueHandle () const
	Return true if there is a value handle associated with this value.
bool	isUsedByMetadata () const
	Return true if there is metadata referencing this value.
LLVM_ABI bool	isSwiftError () const
	Return true if this value is a swifterror value.
LLVM_ABI const Value *	stripPointerCasts () const
	Strip off pointer casts, all-zero GEPs and address space casts.
Value *	stripPointerCasts ()
LLVM_ABI const Value *	stripPointerCastsAndAliases () const
	Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
Value *	stripPointerCastsAndAliases ()
LLVM_ABI const Value *	stripPointerCastsSameRepresentation () const
	Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same.
Value *	stripPointerCastsSameRepresentation ()
LLVM_ABI const Value *	stripPointerCastsForAliasAnalysis () const
	Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info.
Value *	stripPointerCastsForAliasAnalysis ()
LLVM_ABI const Value *	stripInBoundsConstantOffsets () const
	Strip off pointer casts and all-constant inbounds GEPs.
Value *	stripInBoundsConstantOffsets ()
LLVM_ABI const Value *	stripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false) const
	Accumulate the constant offset this value has compared to a base pointer.
Value *	stripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false)
const Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
	This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false.
Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
LLVM_ABI const Value *	stripInBoundsOffsets (function_ref< void(const Value )> Func=[](const Value ) {}) const
	Strip off pointer casts and inbounds GEPs.
Value *	stripInBoundsOffsets (function_ref< void(const Value )> Func=[](const Value ) {})
LLVM_ABI std::optional< int64_t >	getPointerOffsetFrom (const Value *Other, const DataLayout &DL) const
	If this ptr is provably equal to `Other` plus a constant offset, return that offset in bytes.
LLVM_ABI bool	canBeFreed () const
	Return true if the memory object referred to by V can by freed in the scope for which the SSA value defining the allocation is statically defined.
LLVM_ABI uint64_t	getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
	Returns the number of bytes known to be dereferenceable for the pointer value.
LLVM_ABI Align	getPointerAlignment (const DataLayout &DL) const
	Returns an alignment of the pointer value.
LLVM_ABI const Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB) const
	Translate PHI node to its predecessor from the given basic block.
Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB)
void	mutateType (Type *Ty)
	Mutate the type of this Value to be of the specified type.
template<class Compare>
void	sortUseList (Compare Cmp)
	Sort the use-list.
LLVM_ABI void	reverseUseList ()
	Reverse the use-list.
LLVM_ABI void	print (raw_ostream &O, bool IsForDebug=false) const
	Implement operator<< on Value.
LLVM_ABI void	print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
LLVM_ABI void	printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
	Print the name of this Value out to the specified raw_ostream.
LLVM_ABI void	printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
Public Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
Instruction *	getPrevNode ()
Instruction *	getNextNode ()
	Get the next node, or `nullptr` for the list tail.
Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
self_iterator	getIterator ()
reverse_self_iterator	getReverseIterator ()
std::enable_if_t< T::is_sentinel_tracking_explicit, bool >	isSentinel () const
	Check whether this is the sentinel node.
Public Member Functions inherited from llvm::ilist_detail::node_parent_access< ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >, ilist_detail::compute_node_options< Instruction, Options... >::type::parent_ty >
const ilist_detail::compute_node_options< Instruction, Options... >::type::parent_ty *	getParent () const
void	setParent (ilist_detail::compute_node_options< Instruction, Options... >::type::parent_ty *Parent)

Static Public Member Functions
static GetElementPtrInst *	Create (Type PointeeType, Value Ptr, ArrayRef< Value * > IdxList, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static GetElementPtrInst *	Create (Type PointeeType, Value Ptr, ArrayRef< Value * > IdxList, GEPNoWrapFlags NW, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static GetElementPtrInst *	CreateInBounds (Type PointeeType, Value Ptr, ArrayRef< Value * > IdxList, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
	Create an "inbounds" getelementptr.
static LLVM_ABI Type *	getIndexedType (Type Ty, ArrayRef< Value > IdxList)
	Returns the result type of a getelementptr with the given source element type and indexes.
static LLVM_ABI Type *	getIndexedType (Type Ty, ArrayRef< Constant > IdxList)
static LLVM_ABI Type *	getIndexedType (Type *Ty, ArrayRef< uint64_t > IdxList)
static LLVM_ABI Type *	getTypeAtIndex (Type Ty, Value Idx)
	Return the type of the element at the given index of an indexable type.
static LLVM_ABI Type *	getTypeAtIndex (Type *Ty, uint64_t Idx)
static unsigned	getPointerOperandIndex ()
static Type *	getGEPReturnType (Value Ptr, ArrayRef< Value > IdxList)
	Returns the pointer type returned by the GEP instruction, which may be a vector of pointers.
static bool	classof (const Instruction *I)
static bool	classof (const Value *V)
Static Public Member Functions inherited from llvm::Instruction
static LLVM_ABI const char *	getOpcodeName (unsigned Opcode)
static bool	isTerminator (unsigned Opcode)
static bool	isUnaryOp (unsigned Opcode)
static bool	isBinaryOp (unsigned Opcode)
static bool	isIntDivRem (unsigned Opcode)
static bool	isFPDivRem (unsigned Opcode)
static bool	isShift (unsigned Opcode)
	Determine if the Opcode is one of the shift instructions.
static bool	isBitwiseLogicOp (unsigned Opcode)
	Determine if the Opcode is and/or/xor.
static bool	isCast (unsigned Opcode)
	Determine if the Opcode is one of the CastInst instructions.
static bool	isFuncletPad (unsigned Opcode)
	Determine if the Opcode is one of the FuncletPadInst instructions.
static bool	isSpecialTerminator (unsigned Opcode)
	Returns true if the Opcode is a "special" terminator that does more than branch to a successor (e.g.
static bool	isAssociative (unsigned Opcode)
static bool	isCommutative (unsigned Opcode)
static bool	isIdempotent (unsigned Opcode)
static bool	isNilpotent (unsigned Opcode)
static bool	classof (const Value *V)
	Methods for support type inquiry through isa, cast, and dyn_cast:
Static Public Member Functions inherited from llvm::User
static bool	classof (const Value *V)
Static Public Member Functions inherited from llvm::Value
static LLVM_ABI void	dropDroppableUse (Use &U)
	Remove the droppable use `U`.

Protected Member Functions
LLVM_ABI GetElementPtrInst *	cloneImpl () const
Protected Member Functions inherited from llvm::Instruction
LLVM_ABI	~Instruction ()
template<typename BitfieldElement>
BitfieldElement::Type	getSubclassData () const
template<typename BitfieldElement>
void	setSubclassData (typename BitfieldElement::Type Value)
LLVM_ABI	Instruction (Type *Ty, unsigned iType, AllocInfo AllocInfo, InsertPosition InsertBefore=nullptr)
Protected Member Functions inherited from llvm::User
void *	operator new (size_t Size)=delete
LLVM_ABI void *	operator new (size_t Size, HungOffOperandsAllocMarker)
	Allocate a User with an operand pointer co-allocated.
LLVM_ABI void *	operator new (size_t Size, IntrusiveOperandsAllocMarker allocTrait)
	Allocate a User with the operands co-allocated.
LLVM_ABI void *	operator new (size_t Size, IntrusiveOperandsAndDescriptorAllocMarker allocTrait)
	Allocate a User with the operands co-allocated.
	User (Type *ty, unsigned vty, AllocInfo AllocInfo)
LLVM_ABI void	allocHungoffUses (unsigned N, bool IsPhi=false)
	Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User.
LLVM_ABI void	growHungoffUses (unsigned N, bool IsPhi=false)
	Grow the number of hung off uses.
	~User ()=default
template<int Idx>
Use &	Op ()
template<int Idx>
const Use &	Op () const
Protected Member Functions inherited from llvm::Value
LLVM_ABI	Value (Type *Ty, unsigned scid)
LLVM_ABI	~Value ()
	Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID.
LLVM_ABI void	getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
	Appends all metadata attached to this value to `MDs`, sorting by KindID.
bool	hasMetadata () const
	Return true if this value has any metadata attached to it.
LLVM_ABI bool	eraseMetadata (unsigned KindID)
	Erase all metadata attachments with the given kind.
LLVM_ABI void	eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
	Erase all metadata attachments matching the given predicate.
LLVM_ABI void	clearMetadata ()
	Erase all metadata attached to this Value.
LLVM_ABI MDNode *	getMetadataImpl (unsigned KindID) const
	Get metadata for the given kind, if any.
unsigned short	getSubclassDataFromValue () const
void	setValueSubclassData (unsigned short D)
MDNode *	getMetadata (unsigned KindID) const
	Get the current metadata attachments for the given kind, if any.
LLVM_ABI MDNode *	getMetadata (StringRef Kind) const
LLVM_ABI void	getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
	Appends all attachments with the given ID to `MDs` in insertion order.
LLVM_ABI void	getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
bool	hasMetadata (unsigned KindID) const
	Return true if this value has the given type of metadata attached.
bool	hasMetadata (StringRef Kind) const
LLVM_ABI void	setMetadata (unsigned KindID, MDNode *Node)
	Set a particular kind of metadata attachment.
LLVM_ABI void	setMetadata (StringRef Kind, MDNode *Node)
LLVM_ABI void	addMetadata (unsigned KindID, MDNode &MD)
	Add a metadata attachment.
LLVM_ABI void	addMetadata (StringRef Kind, MDNode &MD)
Protected Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
	ilist_node_with_parent ()=default
Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
	ilist_node_impl ()=default

Friends
class	Instruction
	Iterator for Instructions in a `BasicBlock.

Additional Inherited Members
Public Types inherited from llvm::Instruction
enum	OperationEquivalenceFlags { CompareIgnoringAlignment = 1 << 0 , CompareUsingScalarTypes = 1 << 1 , CompareUsingIntersectedAttrs = 1 << 2 }
	When checking for operation equivalence (using isSameOperationAs) it is sometimes useful to ignore certain attributes. More...
enum	TermOps
enum	UnaryOps
enum	BinaryOps
enum	MemoryOps
enum	CastOps
enum	FuncletPadOps
enum	OtherOps
using	InstListType
Public Types inherited from llvm::User
using	op_iterator = Use*
using	const_op_iterator = const Use*
using	op_range = iterator_range<op_iterator>
using	const_op_range = iterator_range<const_op_iterator>
Public Types inherited from llvm::Value
enum	ValueTy
	Concrete subclass of this. More...
using	use_iterator = use_iterator_impl<Use>
using	const_use_iterator = use_iterator_impl<const Use>
using	user_iterator = user_iterator_impl<User>
using	const_user_iterator = user_iterator_impl<const User>
Public Attributes inherited from llvm::Instruction
DbgMarker *	DebugMarker = nullptr
	Optional marker recording the position for debugging information that takes effect immediately before this instruction.
Static Public Attributes inherited from llvm::Value
static constexpr unsigned	MaxAlignmentExponent = 32
	The maximum alignment for instructions.
static constexpr uint64_t	MaximumAlignment = 1ULL << MaxAlignmentExponent
Protected Types inherited from llvm::Instruction
using	OpaqueField = Bitfield::Element<uint16_t, 0, 15>
template<unsigned Offset>
using	AlignmentBitfieldElementT
template<unsigned Offset>
using	BoolBitfieldElementT = typename Bitfield::Element<bool, Offset, 1>
template<unsigned Offset>
using	AtomicOrderingBitfieldElementT
Protected Types inherited from llvm::Value
enum	: unsigned { NumUserOperandsBits = 27 }
	The number of operands in the subclass. More...
Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
using	self_iterator
using	const_self_iterator
using	reverse_self_iterator
using	const_reverse_self_iterator
Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U>
static Use &	OpFrom (const U *that)
Protected Attributes inherited from llvm::Value
unsigned char	SubclassOptionalData: 7
	Hold subclass data that can be dropped.
unsigned	NumUserOperands: NumUserOperandsBits
unsigned	IsUsedByMD: 1
unsigned	HasName: 1
unsigned	HasMetadata: 1
unsigned	HasHungOffUses: 1
unsigned	HasDescriptor: 1

Detailed Description

an instruction for type-safe pointer arithmetic to access elements of arrays and structs

Definition at line 949 of file Instructions.h.

Member Function Documentation

◆ accumulateConstantOffset()

bool GetElementPtrInst::accumulateConstantOffset	(	const DataLayout &	DL,
		APInt &	Offset ) const

Accumulate the constant address offset of this GEP if possible.

This routine accepts an APInt into which it will accumulate the constant offset of this GEP if the GEP is in fact constant. If the GEP is not all-constant, it returns false and the value of the offset APInt is undefined (it is not preserved!). The APInt passed into this routine must be at least as wide as the IntPtr type for the address space of the base GEP pointer.

Definition at line 1650 of file Instructions.cpp.

References llvm::cast(), DL, and llvm::Offset.

Referenced by llvm::detail::PtrUseVisitorBase::adjustOffsetForGEP().

◆ classof() [1/2]

bool llvm::GetElementPtrInst::classof ( const Instruction * I )

inlinestatic

Definition at line 1144 of file Instructions.h.

References I, and Instruction.

Referenced by classof().

◆ classof() [2/2]

bool llvm::GetElementPtrInst::classof ( const Value * V )

inlinestatic

Definition at line 1147 of file Instructions.h.

References llvm::cast(), classof(), and llvm::isa().

◆ cloneImpl()

GetElementPtrInst * GetElementPtrInst::cloneImpl ( ) const

protected

Definition at line 4334 of file Instructions.cpp.

References llvm::User::getNumOperands().

◆ collectOffset()

bool GetElementPtrInst::collectOffset	(	const DataLayout &	DL,
		unsigned	BitWidth,
		SmallMapVector< Value *, APInt, 4 > &	VariableOffsets,
		APInt &	ConstantOffset ) const

Definition at line 1656 of file Instructions.cpp.

References llvm::BitWidth, llvm::cast(), and DL.

◆ Create() [1/2]

GetElementPtrInst * llvm::GetElementPtrInst::Create	(	Type *	PointeeType,
		Value *	Ptr,
		ArrayRef< Value * >	IdxList,
		const Twine &	NameStr = "",
		InsertPosition	InsertBefore = nullptr )

inlinestatic

◆ Create() [2/2]

GetElementPtrInst * llvm::GetElementPtrInst::Create	(	Type *	PointeeType,
		Value *	Ptr,
		ArrayRef< Value * >	IdxList,
		GEPNoWrapFlags	NW,
		const Twine &	NameStr = "",
		InsertPosition	InsertBefore = nullptr )

inlinestatic

Definition at line 984 of file Instructions.h.

References Create(), GEP, and Ptr.

◆ CreateInBounds()

GetElementPtrInst * llvm::GetElementPtrInst::CreateInBounds	(	Type *	PointeeType,
		Value *	Ptr,
		ArrayRef< Value * >	IdxList,
		const Twine &	NameStr = "",
		InsertPosition	InsertBefore = nullptr )

inlinestatic

Create an "inbounds" getelementptr.

See the documentation for the "inbounds" flag in LangRef.html for details.

Definition at line 997 of file Instructions.h.

References Create(), llvm::GEPNoWrapFlags::inBounds(), and Ptr.

Referenced by llvm::IRBuilderBase::CreateConstInBoundsGEP1_32(), llvm::IRBuilderBase::CreateConstInBoundsGEP1_64(), llvm::IRBuilderBase::CreateConstInBoundsGEP2_32(), llvm::IRBuilderBase::CreateConstInBoundsGEP2_64(), replaceWithGEP(), tryToShorten(), and llvm::InstCombinerImpl::visitGetElementPtrInst().

◆ DECLARE_TRANSPARENT_OPERAND_ACCESSORS()

llvm::GetElementPtrInst::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Value )

Transparently provide more efficient getOperand methods.

◆ getAddressSpace()

unsigned llvm::GetElementPtrInst::getAddressSpace ( ) const

inline

Returns the address space of this instruction's pointer type.

Definition at line 1017 of file Instructions.h.

References getPointerAddressSpace().

◆ getGEPReturnType()

Type * llvm::GetElementPtrInst::getGEPReturnType	(	Value *	Ptr,
		ArrayRef< Value * >	IdxList )

inlinestatic

Returns the pointer type returned by the GEP instruction, which may be a vector of pointers.

Definition at line 1076 of file Instructions.h.

References llvm::dyn_cast(), llvm::VectorType::get(), and Ptr.

Referenced by llvm::ConstantFoldGetElementPtr(), llvm::IRBuilderBase::CreatePreserveArrayAccessIndex(), llvm::IRBuilderBase::CreatePreserveStructAccessIndex(), and llvm::ConstantExpr::getGetElementPtr().

◆ getIndexedType() [1/3]

Type * GetElementPtrInst::getIndexedType	(	Type *	Ty,
		ArrayRef< Constant * >	IdxList )

static

Definition at line 1587 of file Instructions.cpp.

References getIndexedTypeInternal().

◆ getIndexedType() [2/3]

Type * GetElementPtrInst::getIndexedType	(	Type *	Ty,
		ArrayRef< uint64_t >	IdxList )

static

Definition at line 1592 of file Instructions.cpp.

References getIndexedTypeInternal().

◆ getIndexedType() [3/3]

Type * GetElementPtrInst::getIndexedType	(	Type *	Ty,
		ArrayRef< Value * >	IdxList )

static

Returns the result type of a getelementptr with the given source element type and indexes.

Null is returned if the indices are invalid for the specified source element type.

Definition at line 1583 of file Instructions.cpp.

References getIndexedTypeInternal().

Referenced by canReplaceGEPIdxWithZero(), llvm::ConstantExpr::getGetElementPtr(), simplifyGEPInst(), and llvm::InstCombinerImpl::visitGetElementPtrInst().

◆ getNoWrapFlags()

GEPNoWrapFlags GetElementPtrInst::getNoWrapFlags ( ) const

Get the nowrap flags for the GEP instruction.

Definition at line 1634 of file Instructions.cpp.

References llvm::cast().

Referenced by llvm::InstCombinerImpl::foldPHIArgGEPIntoPHI().

◆ getNumIndices()

unsigned llvm::GetElementPtrInst::getNumIndices ( ) const

inline

Definition at line 1091 of file Instructions.h.

References llvm::User::getNumOperands().

◆ getPointerAddressSpace()

unsigned llvm::GetElementPtrInst::getPointerAddressSpace ( ) const

inline

Returns the address space of the pointer operand.

Definition at line 1070 of file Instructions.h.

References llvm::Type::getPointerAddressSpace(), and getPointerOperandType().

Referenced by getAddressSpace().

◆ getPointerOperand() [1/2]

Value * llvm::GetElementPtrInst::getPointerOperand ( )

inline

Definition at line 1053 of file Instructions.h.

References llvm::User::getOperand().

Referenced by llvm::FunctionComparator::cmpOperations(), and getPointerOperandType().

◆ getPointerOperand() [2/2]

const Value * llvm::GetElementPtrInst::getPointerOperand ( ) const

inline

Definition at line 1056 of file Instructions.h.

References llvm::User::getOperand().

◆ getPointerOperandIndex()

unsigned llvm::GetElementPtrInst::getPointerOperandIndex ( )

inlinestatic

Definition at line 1059 of file Instructions.h.

Referenced by llvm::sandboxir::GetElementPtrInst::getPointerOperandIndex().

◆ getPointerOperandType()

Type * llvm::GetElementPtrInst::getPointerOperandType ( ) const

inline

Method to return the pointer operand as a PointerType.

Definition at line 1065 of file Instructions.h.

References getPointerOperand(), and llvm::Value::getType().

Referenced by getPointerAddressSpace().

◆ getResultElementType()

Type * llvm::GetElementPtrInst::getResultElementType ( ) const

inline

Definition at line 1012 of file Instructions.h.

◆ getSourceElementType()

Type * llvm::GetElementPtrInst::getSourceElementType ( ) const

inline

Definition at line 1007 of file Instructions.h.

Referenced by canReplaceGEPIdxWithZero(), and llvm::InstCombinerImpl::foldPHIArgGEPIntoPHI().

◆ getTypeAtIndex() [1/2]

Type * GetElementPtrInst::getTypeAtIndex	(	Type *	Ty,
		uint64_t	Idx )

static

Definition at line 1558 of file Instructions.cpp.

References llvm::dyn_cast(), Struct, and llvm::Vector.

◆ getTypeAtIndex() [2/2]

Type * GetElementPtrInst::getTypeAtIndex	(	Type *	Ty,
		Value *	Idx )

static

Return the type of the element at the given index of an indexable type.

This is equivalent to "getIndexedType(Agg, {Zero, Idx})".

Returns null if the type can't be indexed, or the given index is not legal for the given type.

Definition at line 1543 of file Instructions.cpp.

References llvm::dyn_cast(), llvm::Value::getType(), llvm::Type::isIntOrIntVectorTy(), Struct, and llvm::Vector.

Referenced by foldGEPOfPhi(), llvm::ScalarEvolution::getGEPExpr(), and getIndexedTypeInternal().

◆ hasAllConstantIndices()

bool GetElementPtrInst::hasAllConstantIndices ( ) const

Return true if all of the indices of this GEP are constant integers.

hasAllConstantIndices - Return true if all of the indices of this GEP are constant integers.

If so, the result pointer and the first operand have a constant offset between them.

Definition at line 1613 of file Instructions.cpp.

References llvm::User::getNumOperands(), llvm::User::getOperand(), and llvm::isa().

◆ hasAllZeroIndices()

bool GetElementPtrInst::hasAllZeroIndices ( ) const

Return true if all of the indices of this GEP are zeros.

hasAllZeroIndices - Return true if all of the indices of this GEP are zeros.

If so, the result pointer and the first operand have the same value, just potentially different types.

Definition at line 1599 of file Instructions.cpp.

References llvm::dyn_cast(), llvm::User::getNumOperands(), and llvm::User::getOperand().

◆ hasIndices()

bool llvm::GetElementPtrInst::hasIndices ( ) const

inline

Definition at line 1095 of file Instructions.h.

References llvm::User::getNumOperands().

◆ hasNoUnsignedSignedWrap()

bool GetElementPtrInst::hasNoUnsignedSignedWrap ( ) const

Determine whether the GEP has the nusw flag.

Definition at line 1642 of file Instructions.cpp.

References llvm::cast().

◆ hasNoUnsignedWrap()

bool GetElementPtrInst::hasNoUnsignedWrap ( ) const

Determine whether the GEP has the nuw flag.

Definition at line 1646 of file Instructions.cpp.

References llvm::cast().

◆ idx_begin() [1/2]

op_iterator llvm::GetElementPtrInst::idx_begin ( )

inline

Definition at line 1040 of file Instructions.h.

References llvm::User::op_begin().

Referenced by canReplaceGEPIdxWithZero(), indices(), and indices().

◆ idx_begin() [2/2]

const_op_iterator llvm::GetElementPtrInst::idx_begin ( ) const

inline

Definition at line 1041 of file Instructions.h.

References llvm::User::op_begin().

◆ idx_end() [1/2]

op_iterator llvm::GetElementPtrInst::idx_end ( )

inline

Definition at line 1042 of file Instructions.h.

References llvm::User::op_end().

Referenced by indices(), and indices().

◆ idx_end() [2/2]

const_op_iterator llvm::GetElementPtrInst::idx_end ( ) const

inline

Definition at line 1043 of file Instructions.h.

References llvm::User::op_end().

◆ indices() [1/2]

iterator_range< op_iterator > llvm::GetElementPtrInst::indices ( )

inline

Definition at line 1045 of file Instructions.h.

References idx_begin(), idx_end(), and llvm::make_range().

◆ indices() [2/2]

iterator_range< const_op_iterator > llvm::GetElementPtrInst::indices ( ) const

inline

Definition at line 1049 of file Instructions.h.

References idx_begin(), idx_end(), and llvm::make_range().

◆ isInBounds()

bool GetElementPtrInst::isInBounds ( ) const

Determine whether the GEP has the inbounds flag.

Definition at line 1638 of file Instructions.cpp.

References llvm::cast().

Referenced by canReplaceGEPIdxWithZero().

◆ setIsInBounds()

void GetElementPtrInst::setIsInBounds ( bool b = true )

Set or clear the inbounds flag on this GEP instruction.

See LangRef.html for the meaning of inbounds on a getelementptr. TODO: Remove this method in favor of setNoWrapFlags().

Definition at line 1625 of file Instructions.cpp.

References B(), llvm::cast(), llvm::GEPNoWrapFlags::inBounds(), setNoWrapFlags(), and llvm::GEPNoWrapFlags::withoutInBounds().

◆ setNoWrapFlags()

void GetElementPtrInst::setNoWrapFlags ( GEPNoWrapFlags NW )

Set nowrap flags for GEP instruction.

Definition at line 1621 of file Instructions.cpp.

References llvm::GEPNoWrapFlags::getRaw(), and llvm::Value::SubclassOptionalData.

Referenced by LLVMGEPSetNoWrapFlags(), setIsInBounds(), and llvm::InstCombinerImpl::visitExtractElementInst().

◆ setResultElementType()

void llvm::GetElementPtrInst::setResultElementType ( Type * Ty )

inline

Definition at line 1010 of file Instructions.h.

◆ setSourceElementType()

void llvm::GetElementPtrInst::setSourceElementType ( Type * Ty )

inline

Definition at line 1009 of file Instructions.h.

◆ Instruction

friend class Instruction

friend

Iterator for Instructions in a `BasicBlock.

/ \Returns an sandboxir::Instruction & when derereferenced. class BBIterator { public: using difference_type = std::ptrdiff_t; using value_type = Instruction; using pointer = value_type *; using reference = value_type &; using iterator_category = std::bidirectional_iterator_tag;

private: llvm::BasicBlock *BB; llvm::BasicBlock::iterator It; Context *Ctx; LLVM_ABI pointer getInstr(llvm::BasicBlock::iterator It) const;

public: BBIterator() : BB(nullptr), Ctx(nullptr) {} BBIterator(llvm::BasicBlock <em>BB, llvm::BasicBlock::iterator It, Context *Ctx) : BB(BB), It(It), Ctx(Ctx) {} reference operator() const { return *getInstr(It); } LLVM_ABI BBIterator &operator++(); BBIterator operator++(int) { auto Copy = *this; ++*this; return Copy; } LLVM_ABI BBIterator &operator--(); BBIterator operator--(int) { auto Copy = *this; –*this; return Copy; } bool operator==(const BBIterator &Other) const { assert(Ctx == Other.Ctx && "BBIterators in different context!"); return It == Other.It; } bool operator!=(const BBIterator &Other) const { return !(*this == Other); } / \Returns the SBInstruction that corresponds to this iterator, or null if / the instruction is not found in the IR-to-SandboxIR tables. pointer get() const { return getInstr(It); } / \Returns the parent BB. LLVM_ABI BasicBlock *getNodeParent() const; };

/ Contains a list of sandboxir::Instruction's. class BasicBlock : public Value { / Builds a graph that contains all values in BB in their original form / i.e., no vectorization is taking place here. LLVM_ABI void buildBasicBlockFromLLVMIR(llvm::BasicBlock *LLVMBB); friend class Context; // For buildBasicBlockFromIR

Definition at line 968 of file Instructions.h.

References Instruction, and LLVM_ABI.

Referenced by classof(), and Instruction.

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

include/llvm/IR/Instructions.h
lib/IR/Instructions.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ accumulateConstantOffset()

◆ classof() [1/2]

◆ classof() [2/2]

◆ cloneImpl()

◆ collectOffset()

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateInBounds()

◆ DECLARE_TRANSPARENT_OPERAND_ACCESSORS()

◆ getAddressSpace()

◆ getGEPReturnType()

◆ getIndexedType() [1/3]

◆ getIndexedType() [2/3]

◆ getIndexedType() [3/3]

◆ getNoWrapFlags()

◆ getNumIndices()

◆ getPointerAddressSpace()

◆ getPointerOperand() [1/2]

◆ getPointerOperand() [2/2]

◆ getPointerOperandIndex()

◆ getPointerOperandType()

◆ getResultElementType()

◆ getSourceElementType()

◆ getTypeAtIndex() [1/2]

◆ getTypeAtIndex() [2/2]

◆ hasAllConstantIndices()

◆ hasAllZeroIndices()

◆ hasIndices()

◆ hasNoUnsignedSignedWrap()

◆ hasNoUnsignedWrap()

◆ idx_begin() [1/2]

◆ idx_begin() [2/2]

◆ idx_end() [1/2]

◆ idx_end() [2/2]

◆ indices() [1/2]

◆ indices() [2/2]

◆ isInBounds()

◆ setIsInBounds()

◆ setNoWrapFlags()

◆ setResultElementType()

◆ setSourceElementType()

Friends And Related Symbol Documentation

◆ Instruction