class ExtractValueInst

Declaration

class ExtractValueInst : public UnaryInstruction { /* full declaration omitted */ };

Description

This instruction extracts a struct member or array element value from an aggregate value.

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

Inherits from: UnaryInstruction

Member Variables

private SmallVector<unsigned int, 4> Indices

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::ExtractValueInst * Create(llvm::Value * Agg, ArrayRef<unsigned int> Idxs, const llvm::Twine & NameStr = "", llvm::Instruction * InsertBefore = nullptr)
• public static llvm::ExtractValueInst * Create(llvm::Value * Agg, ArrayRef<unsigned int> Idxs, const llvm::Twine & NameStr, llvm::BasicBlock * InsertAtEnd)
• private inline ExtractValueInst(llvm::Value * Agg, ArrayRef<unsigned int> Idxs, const llvm::Twine & NameStr, llvm::Instruction * InsertBefore)
• private inline ExtractValueInst(llvm::Value * Agg, ArrayRef<unsigned int> Idxs, const llvm::Twine & NameStr, llvm::BasicBlock * InsertAtEnd)
• private ExtractValueInst(const llvm::ExtractValueInst & EVI)
• public static bool classof(const llvm::Value * V)
• public static bool classof(const llvm::Instruction * I)
• protected llvm::ExtractValueInst * cloneImpl() const
• public llvm::Value * getAggregateOperand()
• public const llvm::Value * getAggregateOperand() const
• public static unsigned int getAggregateOperandIndex()
• public static llvm::Type * getIndexedType(llvm::Type * Agg, ArrayRef<unsigned int> Idxs)
• public ArrayRef<unsigned int> getIndices() const
• public unsigned int getNumIndices() const
• public bool hasIndices() const
• public inline llvm::ExtractValueInst::idx_iterator idx_begin() const
• public inline llvm::ExtractValueInst::idx_iterator idx_end() const
• public inline iterator_range<llvm::ExtractValueInst::idx_iterator> indices() const
• private void init(ArrayRef<unsigned int> Idxs, const llvm::Twine & NameStr)

Inherited from UnaryInstruction:

• public classof
• public classof

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::ExtractValueInst* Create(
    llvm::Value* Agg,
    ArrayRef<unsigned int> Idxs,
    const llvm::Twine& NameStr = "",
    llvm::Instruction* InsertBefore = nullptr)

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

Parameters

llvm::Value* Agg

ArrayRef<unsigned int> Idxs

const llvm::Twine& NameStr = ""

llvm::Instruction* InsertBefore = nullptr

¶static llvm::ExtractValueInst* Create(
    llvm::Value* Agg,
    ArrayRef<unsigned int> Idxs,
    const llvm::Twine& NameStr,
    llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::Value* Agg

ArrayRef<unsigned int> Idxs

const llvm::Twine& NameStr

llvm::BasicBlock* InsertAtEnd

¶inline ExtractValueInst(
    llvm::Value* Agg,
    ArrayRef<unsigned int> Idxs,
    const llvm::Twine& NameStr,
    llvm::Instruction* InsertBefore)

Description

Constructors - Create a extractvalue instruction with a base aggregate value and a 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:2420

Parameters

llvm::Value* Agg

ArrayRef<unsigned int> Idxs

const llvm::Twine& NameStr

llvm::Instruction* InsertBefore

¶inline ExtractValueInst(
    llvm::Value* Agg,
    ArrayRef<unsigned int> Idxs,
    const llvm::Twine& NameStr,
    llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::Value* Agg

ArrayRef<unsigned int> Idxs

const llvm::Twine& NameStr

llvm::BasicBlock* InsertAtEnd

¶ExtractValueInst(
    const llvm::ExtractValueInst& EVI)

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

Parameters

const llvm::ExtractValueInst& EVI

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

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

Parameters

const llvm::Value* V

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

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

Parameters

const llvm::Instruction* I

¶llvm::ExtractValueInst* cloneImpl() const

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

¶llvm::Value* getAggregateOperand()

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

¶const llvm::Value* getAggregateOperand() const

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

¶static unsigned int getAggregateOperandIndex()

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

¶static llvm::Type* getIndexedType(
    llvm::Type* Agg,
    ArrayRef<unsigned int> Idxs)

Description

Returns the type of the element that would be extracted with an extractvalue instruction with the specified parameters. Null is returned if the indices are invalid for the specified type.

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

Parameters

llvm::Type* Agg

ArrayRef<unsigned int> Idxs

¶ArrayRef<unsigned int> getIndices() const

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

¶unsigned int getNumIndices() const

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

¶bool hasIndices() const

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

¶inline llvm::ExtractValueInst::idx_iterator
idx_begin() const

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

¶inline llvm::ExtractValueInst::idx_iterator
idx_end() const

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

¶inline iterator_range<
    llvm::ExtractValueInst::idx_iterator>
indices() const

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

¶void init(ArrayRef<unsigned int> Idxs,
          const llvm::Twine& NameStr)

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

Parameters

ArrayRef<unsigned int> Idxs

const llvm::Twine& NameStr