class LandingPadInst

Declaration

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

Description

The landingpad instruction holds all of the information necessary to generate correct exception handling. The landingpad instruction cannot be moved from the top of a landing pad block, which itself is accessible only from the 'unwind' edge of an invoke. This uses the SubclassData field in Value to store whether or not the landingpad is a cleanup.

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

Inherits from: Instruction

Member Variables

private unsigned int ReservedSpace

The number of operands actually allocated. NumOperands is the number actually in use.

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::LandingPadInst * Create(llvm::Type * RetTy, unsigned int NumReservedClauses, const llvm::Twine & NameStr = "", llvm::Instruction * InsertBefore = nullptr)
• public static llvm::LandingPadInst * Create(llvm::Type * RetTy, unsigned int NumReservedClauses, const llvm::Twine & NameStr, llvm::BasicBlock * InsertAtEnd)
• private LandingPadInst(llvm::Type * RetTy, unsigned int NumReservedValues, const llvm::Twine & NameStr, llvm::Instruction * InsertBefore)
• private LandingPadInst(llvm::Type * RetTy, unsigned int NumReservedValues, const llvm::Twine & NameStr, llvm::BasicBlock * InsertAtEnd)
• private LandingPadInst(const llvm::LandingPadInst & LP)
• public void addClause(llvm::Constant * ClauseVal)
• public static bool classof(const llvm::Value * V)
• public static bool classof(const llvm::Instruction * I)
• protected llvm::LandingPadInst * cloneImpl() const
• public llvm::Constant * getClause(unsigned int Idx) const
• public unsigned int getNumClauses() const
• private void growOperands(unsigned int Size)
• private void init(unsigned int NumReservedValues, const llvm::Twine & NameStr)
• public bool isCatch(unsigned int Idx) const
• public bool isCleanup() const
• public bool isFilter(unsigned int Idx) const
• public void reserveClauses(unsigned int Size)
• public void setCleanup(bool V)

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::LandingPadInst* Create(
    llvm::Type* RetTy,
    unsigned int NumReservedClauses,
    const llvm::Twine& NameStr = "",
    llvm::Instruction* InsertBefore = nullptr)

Description

Constructors - NumReservedClauses is a hint for the number of incoming clauses that this landingpad will have (use 0 if you really have no idea).

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

Parameters

llvm::Type* RetTy

unsigned int NumReservedClauses

const llvm::Twine& NameStr = ""

llvm::Instruction* InsertBefore = nullptr

¶static llvm::LandingPadInst* Create(
    llvm::Type* RetTy,
    unsigned int NumReservedClauses,
    const llvm::Twine& NameStr,
    llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::Type* RetTy

unsigned int NumReservedClauses

const llvm::Twine& NameStr

llvm::BasicBlock* InsertAtEnd

¶LandingPadInst(llvm::Type* RetTy,
               unsigned int NumReservedValues,
               const llvm::Twine& NameStr,
               llvm::Instruction* InsertBefore)

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

Parameters

llvm::Type* RetTy

unsigned int NumReservedValues

const llvm::Twine& NameStr

llvm::Instruction* InsertBefore

¶LandingPadInst(llvm::Type* RetTy,
               unsigned int NumReservedValues,
               const llvm::Twine& NameStr,
               llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::Type* RetTy

unsigned int NumReservedValues

const llvm::Twine& NameStr

llvm::BasicBlock* InsertAtEnd

¶LandingPadInst(const llvm::LandingPadInst& LP)

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

Parameters

const llvm::LandingPadInst& LP

¶void addClause(llvm::Constant* ClauseVal)

Description

Add a catch or filter clause to the landing pad.

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

Parameters

llvm::Constant* ClauseVal

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

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

Parameters

const llvm::Value* V

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

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

Parameters

const llvm::Instruction* I

¶llvm::LandingPadInst* cloneImpl() const

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

¶llvm::Constant* getClause(unsigned int Idx) const

Description

Get the value of the clause at index Idx. Use isCatch/isFilter to determine what type of clause this is.

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

Parameters

unsigned int Idx

¶unsigned int getNumClauses() const

Description

Get the number of clauses for this landing pad.

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

¶void growOperands(unsigned int Size)

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

Parameters

unsigned int Size

¶void init(unsigned int NumReservedValues,
          const llvm::Twine& NameStr)

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

Parameters

unsigned int NumReservedValues

const llvm::Twine& NameStr

¶bool isCatch(unsigned int Idx) const

Description

Return 'true' if the clause and index Idx is a catch clause.

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

Parameters

unsigned int Idx

¶bool isCleanup() const

Description

Return 'true' if this landingpad instruction is a cleanup. I.e., it should be run when unwinding even if its landing pad doesn't catch the exception.

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

¶bool isFilter(unsigned int Idx) const

Description

Return 'true' if the clause and index Idx is a filter clause.

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

Parameters

unsigned int Idx

¶void reserveClauses(unsigned int Size)

Description

Grow the size of the operand list to accommodate the new number of clauses.

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

Parameters

unsigned int Size

¶void setCleanup(bool V)

Description

Indicate that this landingpad instruction is a cleanup.

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

Parameters

bool V