class PHINode

Declaration

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

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

Inherits from: Instruction

Member Variables

Inherited from Value:

protected SubclassOptionalData

protected NumUserOperands

protected IsUsedByMD

protected HasName

protected HasHungOffUses

protected HasDescriptor

public static MaxAlignmentExponent = 29

public static MaximumAlignment = 1U << MaxAlignmentExponent

Method Overview

• public static llvm::PHINode * Create(llvm::Type * Ty, unsigned int NumReservedValues, const llvm::Twine & NameStr = "", llvm::Instruction * InsertBefore = nullptr)
• public static llvm::PHINode * Create(llvm::Type * Ty, unsigned int NumReservedValues, const llvm::Twine & NameStr, llvm::BasicBlock * InsertAtEnd)
• public void addIncoming(llvm::Value * V, llvm::BasicBlock * BB)
• protected void allocHungoffUses(unsigned int N)
• public llvm::PHINode::block_iterator block_begin()
• public llvm::PHINode::const_block_iterator block_begin() const
• public llvm::PHINode::block_iterator block_end()
• public llvm::PHINode::const_block_iterator block_end() const
• public iterator_range<llvm::PHINode::block_iterator> blocks()
• public iterator_range<llvm::PHINode::const_block_iterator> blocks() const
• public static bool classof(const llvm::Value * V)
• public static bool classof(const llvm::Instruction * I)
• protected llvm::PHINode * cloneImpl() const
• public int getBasicBlockIndex(const llvm::BasicBlock * BB) const
• public llvm::BasicBlock * getIncomingBlock(Value::const_user_iterator I) const
• public llvm::BasicBlock * getIncomingBlock(const llvm::Use & U) const
• public llvm::BasicBlock * getIncomingBlock(unsigned int i) const
• public llvm::Value * getIncomingValue(unsigned int i) const
• public llvm::Value * getIncomingValueForBlock(const llvm::BasicBlock * BB) const
• public static unsigned int getIncomingValueNumForOperand(unsigned int i)
• public unsigned int getNumIncomingValues() const
• public static unsigned int getOperandNumForIncomingValue(unsigned int i)
• public bool hasConstantOrUndefValue() const
• public llvm::Value * hasConstantValue() const
• public llvm::User::const_op_range incoming_values() const
• public llvm::User::op_range incoming_values()
• public llvm::Value * removeIncomingValue(unsigned int Idx, bool DeletePHIIfEmpty = true)
• public llvm::Value * removeIncomingValue(const llvm::BasicBlock * BB, bool DeletePHIIfEmpty = true)
• public void replaceIncomingBlockWith(const llvm::BasicBlock * Old, llvm::BasicBlock * New)
• public void setIncomingBlock(unsigned int i, llvm::BasicBlock * BB)
• public void setIncomingValue(unsigned int i, llvm::Value * V)
• public void setIncomingValueForBlock(const llvm::BasicBlock * BB, llvm::Value * V)

Inherited from Instruction:

• public andIRFlags
• public applyMergedLocation
• public classof
• public clone
• public copyFastMathFlags
• public copyFastMathFlags
• public copyIRFlags
• public copyMetadata
• public dropPoisonGeneratingFlags
• 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 getSubclassDataFromInstruction
• 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 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 isEHPad
• public isExact
• public isExceptionalTerminator
• public isExceptionalTerminator
• public isFast
• public isFenceLike
• public isFuncletPad
• public isFuncletPad
• public isIdempotent
• public isIdempotent
• public isIdenticalTo
• public isIdenticalToWhenDefined
• public isIndirectTerminator
• public isIndirectTerminator
• public isIntDivRem
• public isIntDivRem
• public isLifetimeStartOrEnd
• public isLogicalShift
• public isNilpotent
• public isNilpotent
• public isSafeToRemove
• public isSameOperationAs
• public isShift
• public isShift
• public isTerminator
• public isTerminator
• public isUnaryOp
• public isUnaryOp
• public isUsedOutsideOfBlock
• 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 setHasAllowReassoc
• public setHasAllowReciprocal
• public setHasApproxFunc
• public setHasNoInfs
• public setHasNoNaNs
• public setHasNoSignedWrap
• public setHasNoSignedZeros
• public setHasNoUnsignedWrap
• protected setInstructionSubclassData
• public setIsExact
• public setMetadata
• public setMetadata
• public setProfWeight
• public setSuccessor
• public swapProfMetadata
• public user_back
• public user_back

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 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
• public addUse
• public assertModuleIsMaterialized
• public assertModuleIsMaterializedImpl
• public clearSubclassOptionalData
• public deleteValue
• public dump
• public getContext
• public getName
• public getNumUses
• public getPointerAlignment
• public getPointerDereferenceableBytes
• public getRawSubclassOptionalData
• protected getSubclassDataFromValue
• public getType
• public getValueID
• public getValueName
• public hasNUses
• public hasNUsesOrMore
• public hasName
• public hasOneUse
• public hasSameSubclassOptionalData
• public hasValueHandle
• public isSwiftError
• 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
• 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 stripPointerCastsAndInvariantGroups
• public stripPointerCastsAndInvariantGroups
• 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::PHINode* Create(
    llvm::Type* Ty,
    unsigned int NumReservedValues,
    const llvm::Twine& NameStr = "",
    llvm::Instruction* InsertBefore = nullptr)

Description

Constructors - NumReservedValues is a hint for the number of incoming edges that this phi node will have (use 0 if you really have no idea).

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

Parameters

llvm::Type* Ty

unsigned int NumReservedValues

const llvm::Twine& NameStr = ""

llvm::Instruction* InsertBefore = nullptr

¶static llvm::PHINode* Create(
    llvm::Type* Ty,
    unsigned int NumReservedValues,
    const llvm::Twine& NameStr,
    llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::Type* Ty

unsigned int NumReservedValues

const llvm::Twine& NameStr

llvm::BasicBlock* InsertAtEnd

¶void addIncoming(llvm::Value* V,
                 llvm::BasicBlock* BB)

Description

Add an incoming value to the end of the PHI list

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

Parameters

llvm::Value* V

llvm::BasicBlock* BB

¶void allocHungoffUses(unsigned int N)

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

Parameters

unsigned int N

¶llvm::PHINode::block_iterator block_begin()

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

¶llvm::PHINode::const_block_iterator block_begin()
    const

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

¶llvm::PHINode::block_iterator block_end()

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

¶llvm::PHINode::const_block_iterator block_end()
    const

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

¶iterator_range<llvm::PHINode::block_iterator>
blocks()

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

¶iterator_range<
    llvm::PHINode::const_block_iterator>
blocks() const

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

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

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

Parameters

const llvm::Value* V

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

Description

Methods for support type inquiry through isa, cast, and dyn_cast:

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

Parameters

const llvm::Instruction* I

¶llvm::PHINode* cloneImpl() const

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

¶int getBasicBlockIndex(
    const llvm::BasicBlock* BB) const

Description

Return the first index of the specified basic block in the value list for this PHI. Returns -1 if no instance.

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

Parameters

const llvm::BasicBlock* BB

¶llvm::BasicBlock* getIncomingBlock(
    Value::const_user_iterator I) const

Description

Return incoming basic block corresponding to value use iterator.

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

Parameters

Value::const_user_iterator I

¶llvm::BasicBlock* getIncomingBlock(
    const llvm::Use& U) const

Description

Return incoming basic block corresponding to an operand of the PHI.

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

Parameters

const llvm::Use& U

¶llvm::BasicBlock* getIncomingBlock(
    unsigned int i) const

Description

Return incoming basic block number @p i.

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

Parameters

unsigned int i

¶llvm::Value* getIncomingValue(
    unsigned int i) const

Description

Return incoming value number x

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

Parameters

unsigned int i

¶llvm::Value* getIncomingValueForBlock(
    const llvm::BasicBlock* BB) const

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

Parameters

const llvm::BasicBlock* BB

¶static unsigned int getIncomingValueNumForOperand(
    unsigned int i)

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

Parameters

unsigned int i

¶unsigned int getNumIncomingValues() const

Description

Return the number of incoming edges

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

¶static unsigned int getOperandNumForIncomingValue(
    unsigned int i)

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

Parameters

unsigned int i

¶bool hasConstantOrUndefValue() const

Description

Whether the specified PHI node always merges together the same value, assuming undefs are equal to a unique non-undef value.

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

¶llvm::Value* hasConstantValue() const

Description

If the specified PHI node always merges together the same value, return the value, otherwise return null.

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

¶llvm::User::const_op_range incoming_values() const

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

¶llvm::User::op_range incoming_values()

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

¶llvm::Value* removeIncomingValue(
    unsigned int Idx,
    bool DeletePHIIfEmpty = true)

Description

Remove an incoming value. This is useful if a predecessor basic block is deleted. The value removed is returned. If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty is true), the PHI node is destroyed and any uses of it are replaced with dummy values. The only time there should be zero incoming values to a PHI node is when the block is dead, so this strategy is sound.

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

Parameters

unsigned int Idx

bool DeletePHIIfEmpty = true

¶llvm::Value* removeIncomingValue(
    const llvm::BasicBlock* BB,
    bool DeletePHIIfEmpty = true)

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

Parameters

const llvm::BasicBlock* BB

bool DeletePHIIfEmpty = true

¶void replaceIncomingBlockWith(
    const llvm::BasicBlock* Old,
    llvm::BasicBlock* New)

Description

Replace every incoming basic block \p Old to basic block \p New.

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

Parameters

const llvm::BasicBlock* Old

llvm::BasicBlock* New

¶void setIncomingBlock(unsigned int i,
                      llvm::BasicBlock* BB)

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

Parameters

unsigned int i

llvm::BasicBlock* BB

¶void setIncomingValue(unsigned int i,
                      llvm::Value* V)

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

Parameters

unsigned int i

llvm::Value* V

¶void setIncomingValueForBlock(
    const llvm::BasicBlock* BB,
    llvm::Value* V)

Description

Set every incoming value(s) for block \p BB to \p V.

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

Parameters

const llvm::BasicBlock* BB

llvm::Value* V