class ReturnInst

Declaration

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

Description

Return a value (possibly void), from a function. Execution does not continue in this function any longer.

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

Inherits from: Instruction

Member Variables

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::ReturnInst * Create(llvm::LLVMContext & C, llvm::Value * retVal = nullptr, llvm::Instruction * InsertBefore = nullptr)
• public static llvm::ReturnInst * Create(llvm::LLVMContext & C, llvm::Value * retVal, llvm::BasicBlock * InsertAtEnd)
• public static llvm::ReturnInst * Create(llvm::LLVMContext & C, llvm::BasicBlock * InsertAtEnd)
• private ReturnInst(const llvm::ReturnInst & RI)
• private ReturnInst(llvm::LLVMContext & C, llvm::Value * retVal = nullptr, llvm::Instruction * InsertBefore = nullptr)
• private ReturnInst(llvm::LLVMContext & C, llvm::Value * retVal, llvm::BasicBlock * InsertAtEnd)
• private ReturnInst(llvm::LLVMContext & C, llvm::BasicBlock * InsertAtEnd)
• public static bool classof(const llvm::Instruction * I)
• public static bool classof(const llvm::Value * V)
• protected llvm::ReturnInst * cloneImpl() const
• public unsigned int getNumSuccessors() const
• public llvm::Value * getReturnValue() const
• private llvm::BasicBlock * getSuccessor(unsigned int idx) const
• private void setSuccessor(unsigned int idx, llvm::BasicBlock * B)

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::ReturnInst* Create(
    llvm::LLVMContext& C,
    llvm::Value* retVal = nullptr,
    llvm::Instruction* InsertBefore = nullptr)

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

Parameters

llvm::LLVMContext& C

llvm::Value* retVal = nullptr

llvm::Instruction* InsertBefore = nullptr

¶static llvm::ReturnInst* Create(
    llvm::LLVMContext& C,
    llvm::Value* retVal,
    llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::LLVMContext& C

llvm::Value* retVal

llvm::BasicBlock* InsertAtEnd

¶static llvm::ReturnInst* Create(
    llvm::LLVMContext& C,
    llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::LLVMContext& C

llvm::BasicBlock* InsertAtEnd

¶ReturnInst(const llvm::ReturnInst& RI)

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

Parameters

const llvm::ReturnInst& RI

¶ReturnInst(
    llvm::LLVMContext& C,
    llvm::Value* retVal = nullptr,
    llvm::Instruction* InsertBefore = nullptr)

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

Parameters

llvm::LLVMContext& C

llvm::Value* retVal = nullptr

llvm::Instruction* InsertBefore = nullptr

¶ReturnInst(llvm::LLVMContext& C,
           llvm::Value* retVal,
           llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::LLVMContext& C

llvm::Value* retVal

llvm::BasicBlock* InsertAtEnd

¶ReturnInst(llvm::LLVMContext& C,
           llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::LLVMContext& C

llvm::BasicBlock* InsertAtEnd

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

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

Parameters

const llvm::Instruction* I

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

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

Parameters

const llvm::Value* V

¶llvm::ReturnInst* cloneImpl() const

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

¶unsigned int getNumSuccessors() const

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

¶llvm::Value* getReturnValue() const

Description

Convenience accessor. Returns null if there is no return value.

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

¶llvm::BasicBlock* getSuccessor(
    unsigned int idx) const

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

Parameters

unsigned int idx

¶void setSuccessor(unsigned int idx,
                  llvm::BasicBlock* B)

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

Parameters

unsigned int idx

llvm::BasicBlock* B