class GetElementPtrInst

Declaration

class GetElementPtrInst : public Instruction { /* full declaration omitted */ };

Description

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

Declared at: llvm/include/llvm/IR/Instructions.h:929

Inherits from: Instruction

Member Variables

private llvm::Type* SourceElementType

private llvm::Type* ResultElementType

Inherited from Value:

protected SubclassOptionalData

protected NumUserOperands

protected IsUsedByMD

protected HasName

protected HasMetadata

protected HasHungOffUses

protected HasDescriptor

public static MaxAlignmentExponent = 32

public static MaximumAlignment = 1ULL << MaxAlignmentExponent

Method Overview

• public static llvm::GetElementPtrInst * Create(llvm::Type * PointeeType, llvm::Value * Ptr, ArrayRef<llvm::Value *> IdxList, const llvm::Twine & NameStr = "", llvm::Instruction * InsertBefore = nullptr)
• public static llvm::GetElementPtrInst * Create(llvm::Type * PointeeType, llvm::Value * Ptr, ArrayRef<llvm::Value *> IdxList, const llvm::Twine & NameStr, llvm::BasicBlock * InsertAtEnd)
• public static llvm::GetElementPtrInst * CreateInBounds(llvm::Type * PointeeType, llvm::Value * Ptr, ArrayRef<llvm::Value *> IdxList, const llvm::Twine & NameStr = "", llvm::Instruction * InsertBefore = nullptr)
• public static llvm::GetElementPtrInst * CreateInBounds(llvm::Type * PointeeType, llvm::Value * Ptr, ArrayRef<llvm::Value *> IdxList, const llvm::Twine & NameStr, llvm::BasicBlock * InsertAtEnd)
• private inline GetElementPtrInst(llvm::Type * PointeeType, llvm::Value * Ptr, ArrayRef<llvm::Value *> IdxList, unsigned int Values, const llvm::Twine & NameStr, llvm::Instruction * InsertBefore)
• private inline GetElementPtrInst(llvm::Type * PointeeType, llvm::Value * Ptr, ArrayRef<llvm::Value *> IdxList, unsigned int Values, const llvm::Twine & NameStr, llvm::BasicBlock * InsertAtEnd)
• private GetElementPtrInst(const llvm::GetElementPtrInst & GEPI)
• public bool accumulateConstantOffset(const llvm::DataLayout & DL, llvm::APInt & Offset) const
• public static bool classof(const llvm::Value * V)
• public static bool classof(const llvm::Instruction * I)
• protected llvm::GetElementPtrInst * cloneImpl() const
• public bool collectOffset(const llvm::DataLayout & DL, unsigned int BitWidth, MapVector<llvm::Value *, llvm::APInt> & VariableOffsets, llvm::APInt & ConstantOffset) const
• public unsigned int getAddressSpace() const
• public static llvm::Type * getGEPReturnType(llvm::Type * ElTy, llvm::Value * Ptr, ArrayRef<llvm::Value *> IdxList)
• public static llvm::Type * getIndexedType(llvm::Type * Ty, ArrayRef<llvm::Value *> IdxList)
• public static llvm::Type * getIndexedType(llvm::Type * Ty, ArrayRef<llvm::Constant *> IdxList)
• public static llvm::Type * getIndexedType(llvm::Type * Ty, ArrayRef<uint64_t> IdxList)
• public unsigned int getNumIndices() const
• public unsigned int getPointerAddressSpace() const
• public const llvm::Value * getPointerOperand() const
• public llvm::Value * getPointerOperand()
• public static unsigned int getPointerOperandIndex()
• public llvm::Type * getPointerOperandType() const
• public llvm::Type * getResultElementType() const
• public llvm::Type * getSourceElementType() const
• public static llvm::Type * getTypeAtIndex(llvm::Type * Ty, uint64_t Idx)
• public static llvm::Type * getTypeAtIndex(llvm::Type * Ty, llvm::Value * Idx)
• public bool hasAllConstantIndices() const
• public bool hasAllZeroIndices() const
• public bool hasIndices() const
• public inline llvm::User::const_op_iterator idx_begin() const
• public inline llvm::User::op_iterator idx_begin()
• public inline llvm::User::const_op_iterator idx_end() const
• public inline llvm::User::op_iterator idx_end()
• public inline iterator_range<llvm::User::const_op_iterator> indices() const
• public inline iterator_range<llvm::User::op_iterator> indices()
• private void init(llvm::Value * Ptr, ArrayRef<llvm::Value *> IdxList, const llvm::Twine & NameStr)
• public bool isInBounds() const
• public void setIsInBounds(bool b = true)
• public void setResultElementType(llvm::Type * Ty)
• public void setSourceElementType(llvm::Type * Ty)

Inherited from Instruction:

• public addAnnotationMetadata
• public andIRFlags
• public applyMergedLocation
• public classof
• public clone
• public comesBefore
• public copyFastMathFlags
• public copyFastMathFlags
• public copyIRFlags
• public copyMetadata
• public dropLocation
• public dropPoisonGeneratingFlags
• public dropUndefImplyingAttrsAndUnknownMetadata
• public dropUnknownNonDebugMetadata
• public dropUnknownNonDebugMetadata
• public dropUnknownNonDebugMetadata
• public dropUnknownNonDebugMetadata
• public eraseFromParent
• public extractProfMetadata
• public extractProfTotalWeight
• public getAAMetadata
• public getAllMetadata
• public getAllMetadataOtherThanDebugLoc
• public getDebugLoc
• public getFastMathFlags
• public getFunction
• public getFunction
• public getMetadata
• public getMetadata
• public getModule
• public getModule
• public getNextNonDebugInstruction
• public getNextNonDebugInstruction
• public getNumSuccessors
• public getOpcode
• public getOpcodeName
• public getOpcodeName
• public getParent
• public getParent
• public getPrevNonDebugInstruction
• public getPrevNonDebugInstruction
• protected getSubclassData
• public getSuccessor
• public hasAllowContract
• public hasAllowReassoc
• public hasAllowReciprocal
• public hasApproxFunc
• public hasAtomicLoad
• public hasAtomicStore
• public hasMetadata
• public hasMetadata
• public hasMetadata
• public hasMetadataOtherThanDebugLoc
• public hasNoInfs
• public hasNoNaNs
• public hasNoSignedWrap
• public hasNoSignedZeros
• public hasNoUnsignedWrap
• public hasPoisonGeneratingFlags
• public insertAfter
• public insertBefore
• public isArithmeticShift
• public isAssociative
• public isAssociative
• public isAtomic
• public isBinaryOp
• public isBinaryOp
• public isBitwiseLogicOp
• public isBitwiseLogicOp
• public isCast
• public isCast
• public isCommutative
• public isCommutative
• public isDebugOrPseudoInst
• public isEHPad
• public isExact
• public isExceptionalTerminator
• public isExceptionalTerminator
• public isFast
• public isFenceLike
• public isFuncletPad
• public isFuncletPad
• public isIdempotent
• public isIdempotent
• public isIdenticalTo
• public isIdenticalToWhenDefined
• public isIntDivRem
• public isIntDivRem
• public isLaunderOrStripInvariantGroup
• public isLifetimeStartOrEnd
• public isLogicalShift
• public isNilpotent
• public isNilpotent
• public isOnlyUserOfAnyOperand
• public isSafeToRemove
• public isSameOperationAs
• public isShift
• public isShift
• public isTerminator
• public isTerminator
• public isUnaryOp
• public isUnaryOp
• public isUsedOutsideOfBlock
• public isVolatile
• public mayHaveSideEffects
• public mayReadFromMemory
• public mayReadOrWriteMemory
• public mayThrow
• public mayWriteToMemory
• public moveAfter
• public moveBefore
• public moveBefore
• public removeFromParent
• public replaceSuccessorWith
• public setAAMetadata
• public setDebugLoc
• public setFast
• public setFastMathFlags
• public setHasAllowContract
• public setHasAllowReassoc
• public setHasAllowReciprocal
• public setHasApproxFunc
• public setHasNoInfs
• public setHasNoNaNs
• public setHasNoSignedWrap
• public setHasNoSignedZeros
• public setHasNoUnsignedWrap
• public setIsExact
• public setMetadata
• public setMetadata
• protected setSubclassData
• public setSuccessor
• public swapProfMetadata
• public updateLocationAfterHoist
• public user_back
• public user_back
• public willReturn

Inherited from User:

• protected Op
• protected Op
• protected OpFrom
• protected allocHungoffUses
• public classof
• public dropAllReferences
• public getDescriptor
• public getDescriptor
• public getNumOperands
• public getOperand
• public getOperandList
• public getOperandList
• public getOperandUse
• public getOperandUse
• protected growHungoffUses
• public isDroppable
• public op_begin
• public op_begin
• public op_end
• public op_end
• public operand_values
• public operand_values
• public operands
• public operands
• public replaceUsesOfWith
• public setGlobalVariableNumOperands
• public setNumHungOffUseOperands
• public setOperand
• public value_op_begin
• public value_op_begin
• public value_op_end
• public value_op_end

Inherited from Value:

• public DoPHITranslation
• public DoPHITranslation
• protected addMetadata
• protected addMetadata
• public addUse
• public assertModuleIsMaterialized
• public assertModuleIsMaterializedImpl
• public canBeFreed
• protected clearMetadata
• public clearSubclassOptionalData
• public deleteValue
• public dropDroppableUse
• public dropDroppableUses
• public dropDroppableUsesIn
• public dump
• protected eraseMetadata
• protected getAllMetadata
• public getContext
• protected getMetadata
• protected getMetadata
• protected getMetadata
• protected getMetadata
• public getName
• public getNameOrAsOperand
• public getNumUses
• public getPointerAlignment
• public getPointerDereferenceableBytes
• public getRawSubclassOptionalData
• public getSingleUndroppableUse
• public getSingleUndroppableUse
• protected getSubclassDataFromValue
• public getType
• public getUniqueUndroppableUser
• public getUniqueUndroppableUser
• public getValueID
• public getValueName
• protected hasMetadata
• protected hasMetadata
• protected hasMetadata
• public hasNUndroppableUses
• public hasNUndroppableUsesOrMore
• public hasNUses
• public hasNUsesOrMore
• public hasName
• public hasOneUse
• public hasOneUser
• public hasSameSubclassOptionalData
• public hasValueHandle
• public isSwiftError
• public isTransitiveUsedByMetadataOnly
• public isUsedByMetadata
• public isUsedInBasicBlock
• public materialized_use_begin
• public materialized_use_begin
• public materialized_use_empty
• public materialized_user_begin
• public materialized_user_begin
• public materialized_users
• public materialized_users
• public materialized_uses
• public materialized_uses
• public mutateType
• public print
• public print
• public printAsOperand
• public printAsOperand
• public replaceAllUsesWith
• public replaceNonMetadataUsesWith
• public replaceUsesOutsideBlock
• public replaceUsesWithIf
• public reverseUseList
• protected setMetadata
• protected setMetadata
• public setName
• public setValueName
• protected setValueSubclassData
• public sortUseList
• public stripAndAccumulateConstantOffsets
• public stripAndAccumulateConstantOffsets
• public stripAndAccumulateInBoundsConstantOffsets
• public stripAndAccumulateInBoundsConstantOffsets
• public stripInBoundsConstantOffsets
• public stripInBoundsConstantOffsets
• public stripInBoundsOffsets
• public stripInBoundsOffsets
• public stripPointerCasts
• public stripPointerCasts
• public stripPointerCastsAndAliases
• public stripPointerCastsAndAliases
• public stripPointerCastsForAliasAnalysis
• public stripPointerCastsForAliasAnalysis
• public stripPointerCastsSameRepresentation
• public stripPointerCastsSameRepresentation
• public takeName
• public use_begin
• public use_begin
• public use_empty
• public use_end
• public use_end
• public user_back
• public user_back
• public user_begin
• public user_begin
• public user_empty
• public user_end
• public user_end
• public users
• public users
• public uses
• public uses

Methods

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

Declared at: llvm/include/llvm/IR/Instructions.h:955

Parameters

llvm::Type* PointeeType

llvm::Value* Ptr

ArrayRef<llvm::Value*> IdxList

const llvm::Twine& NameStr = ""

llvm::Instruction* InsertBefore = nullptr

¶static llvm::GetElementPtrInst* Create(
    llvm::Type* PointeeType,
    llvm::Value* Ptr,
    ArrayRef<llvm::Value*> IdxList,
    const llvm::Twine& NameStr,
    llvm::BasicBlock* InsertAtEnd)

Declared at: llvm/include/llvm/IR/Instructions.h:967

Parameters

llvm::Type* PointeeType

llvm::Value* Ptr

ArrayRef<llvm::Value*> IdxList

const llvm::Twine& NameStr

llvm::BasicBlock* InsertAtEnd

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

Description

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

Declared at: llvm/include/llvm/IR/Instructions.h:982

Parameters

llvm::Type* PointeeType

llvm::Value* Ptr

ArrayRef<llvm::Value*> IdxList

const llvm::Twine& NameStr = ""

llvm::Instruction* InsertBefore = nullptr

¶static llvm::GetElementPtrInst* CreateInBounds(
    llvm::Type* PointeeType,
    llvm::Value* Ptr,
    ArrayRef<llvm::Value*> IdxList,
    const llvm::Twine& NameStr,
    llvm::BasicBlock* InsertAtEnd)

Declared at: llvm/include/llvm/IR/Instructions.h:991

Parameters

llvm::Type* PointeeType

llvm::Value* Ptr

ArrayRef<llvm::Value*> IdxList

const llvm::Twine& NameStr

llvm::BasicBlock* InsertAtEnd

¶inline GetElementPtrInst(
    llvm::Type* PointeeType,
    llvm::Value* Ptr,
    ArrayRef<llvm::Value*> IdxList,
    unsigned int Values,
    const llvm::Twine& NameStr,
    llvm::Instruction* InsertBefore)

Description

Constructors - Create a getelementptr instruction with a base pointer an list of indices. The first ctor can optionally insert before an existing instruction, the second appends the new instruction to the specified BasicBlock.

Declared at: llvm/include/llvm/IR/Instructions.h:939

Parameters

llvm::Type* PointeeType

llvm::Value* Ptr

ArrayRef<llvm::Value*> IdxList

unsigned int Values

const llvm::Twine& NameStr

llvm::Instruction* InsertBefore

¶inline GetElementPtrInst(
    llvm::Type* PointeeType,
    llvm::Value* Ptr,
    ArrayRef<llvm::Value*> IdxList,
    unsigned int Values,
    const llvm::Twine& NameStr,
    llvm::BasicBlock* InsertAtEnd)

Declared at: llvm/include/llvm/IR/Instructions.h:942

Parameters

llvm::Type* PointeeType

llvm::Value* Ptr

ArrayRef<llvm::Value*> IdxList

unsigned int Values

const llvm::Twine& NameStr

llvm::BasicBlock* InsertAtEnd

¶GetElementPtrInst(
    const llvm::GetElementPtrInst& GEPI)

Declared at: llvm/include/llvm/IR/Instructions.h:933

Parameters

const llvm::GetElementPtrInst& GEPI

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

Description

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.

Declared at: llvm/include/llvm/IR/Instructions.h:1130

Parameters

const llvm::DataLayout& DL

llvm::APInt& Offset

¶static bool classof(const llvm::Value* V)

Declared at: llvm/include/llvm/IR/Instructions.h:1138

Parameters

const llvm::Value* V

¶static bool classof(const llvm::Instruction* I)

Declared at: llvm/include/llvm/IR/Instructions.h:1135

Parameters

const llvm::Instruction* I

¶llvm::GetElementPtrInst* cloneImpl() const

Declared at: llvm/include/llvm/IR/Instructions.h:952

¶bool collectOffset(
    const llvm::DataLayout& DL,
    unsigned int BitWidth,
    MapVector<llvm::Value*, llvm::APInt>&
        VariableOffsets,
    llvm::APInt& ConstantOffset) const

Declared at: llvm/include/llvm/IR/Instructions.h:1131

Parameters

const llvm::DataLayout& DL

unsigned int BitWidth

MapVector<llvm::Value*, llvm::APInt>& VariableOffsets

llvm::APInt& ConstantOffset

¶unsigned int getAddressSpace() const

Description

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

Declared at: llvm/include/llvm/IR/Instructions.h:1016

¶static llvm::Type* getGEPReturnType(
    llvm::Type* ElTy,
    llvm::Value* Ptr,
    ArrayRef<llvm::Value*> IdxList)

Description

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

Declared at: llvm/include/llvm/IR/Instructions.h:1075

Parameters

llvm::Type* ElTy

llvm::Value* Ptr

ArrayRef<llvm::Value*> IdxList

¶static llvm::Type* getIndexedType(
    llvm::Type* Ty,
    ArrayRef<llvm::Value*> IdxList)

Description

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.

Declared at: llvm/include/llvm/IR/Instructions.h:1027

Parameters

llvm::Type* Ty

ArrayRef<llvm::Value*> IdxList

¶static llvm::Type* getIndexedType(
    llvm::Type* Ty,
    ArrayRef<llvm::Constant*> IdxList)

Declared at: llvm/include/llvm/IR/Instructions.h:1028

Parameters

llvm::Type* Ty

ArrayRef<llvm::Constant*> IdxList

¶static llvm::Type* getIndexedType(
    llvm::Type* Ty,
    ArrayRef<uint64_t> IdxList)

Declared at: llvm/include/llvm/IR/Instructions.h:1029

Parameters

llvm::Type* Ty

ArrayRef<uint64_t> IdxList

¶unsigned int getNumIndices() const

Declared at: llvm/include/llvm/IR/Instructions.h:1097

¶unsigned int getPointerAddressSpace() const

Description

Returns the address space of the pointer operand.

Declared at: llvm/include/llvm/IR/Instructions.h:1069

¶const llvm::Value* getPointerOperand() const

Declared at: llvm/include/llvm/IR/Instructions.h:1055

¶llvm::Value* getPointerOperand()

Declared at: llvm/include/llvm/IR/Instructions.h:1052

¶static unsigned int getPointerOperandIndex()

Declared at: llvm/include/llvm/IR/Instructions.h:1058

¶llvm::Type* getPointerOperandType() const

Description

Method to return the pointer operand as a PointerType.

Declared at: llvm/include/llvm/IR/Instructions.h:1064

¶llvm::Type* getResultElementType() const

Declared at: llvm/include/llvm/IR/Instructions.h:1009

¶llvm::Type* getSourceElementType() const

Declared at: llvm/include/llvm/IR/Instructions.h:1004

¶static llvm::Type* getTypeAtIndex(llvm::Type* Ty,
                                  uint64_t Idx)

Declared at: llvm/include/llvm/IR/Instructions.h:1037

Parameters

llvm::Type* Ty

uint64_t Idx

¶static llvm::Type* getTypeAtIndex(
    llvm::Type* Ty,
    llvm::Value* Idx)

Description

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.

Declared at: llvm/include/llvm/IR/Instructions.h:1036

Parameters

llvm::Type* Ty

llvm::Value* Idx

¶bool hasAllConstantIndices() const

Description

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.

Declared at: llvm/include/llvm/IR/Instructions.h:1113

¶bool hasAllZeroIndices() const

Description

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.

Declared at: llvm/include/llvm/IR/Instructions.h:1108

¶bool hasIndices() const

Declared at: llvm/include/llvm/IR/Instructions.h:1101

¶inline llvm::User::const_op_iterator idx_begin()
    const

Declared at: llvm/include/llvm/IR/Instructions.h:1040

¶inline llvm::User::op_iterator idx_begin()

Declared at: llvm/include/llvm/IR/Instructions.h:1039

¶inline llvm::User::const_op_iterator idx_end()
    const

Declared at: llvm/include/llvm/IR/Instructions.h:1042

¶inline llvm::User::op_iterator idx_end()

Declared at: llvm/include/llvm/IR/Instructions.h:1041

¶inline iterator_range<
    llvm::User::const_op_iterator>
indices() const

Declared at: llvm/include/llvm/IR/Instructions.h:1048

¶inline iterator_range<llvm::User::op_iterator>
indices()

Declared at: llvm/include/llvm/IR/Instructions.h:1044

¶void init(llvm::Value* Ptr,
          ArrayRef<llvm::Value*> IdxList,
          const llvm::Twine& NameStr)

Declared at: llvm/include/llvm/IR/Instructions.h:946

Parameters

llvm::Value* Ptr

ArrayRef<llvm::Value*> IdxList

const llvm::Twine& NameStr

¶bool isInBounds() const

Description

Determine whether the GEP has the inbounds flag.

Declared at: llvm/include/llvm/IR/Instructions.h:1120

¶void setIsInBounds(bool b = true)

Description

Set or clear the inbounds flag on this GEP instruction. See LangRef.html for the meaning of inbounds on a getelementptr.

Declared at: llvm/include/llvm/IR/Instructions.h:1117

Parameters

bool b = true

¶void setResultElementType(llvm::Type* Ty)

Declared at: llvm/include/llvm/IR/Instructions.h:1007

Parameters

llvm::Type* Ty

¶void setSourceElementType(llvm::Type* Ty)

Declared at: llvm/include/llvm/IR/Instructions.h:1006

Parameters

llvm::Type* Ty