class LoadInst

Declaration

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

Description

An instruction for reading from memory. This uses the SubclassData field in Value to store whether or not the load is volatile.

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

Inherits from: UnaryInstruction

Member Variables

private SyncScope::ID SSID

The synchronization scope ID of this load instruction. Not quite enough room in SubClassData for everything, so synchronization scope ID gets its own field.

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

• private void AssertOK()
• public LoadInst(llvm::Type * Ty, llvm::Value * Ptr, const llvm::Twine & NameStr, llvm::Instruction * InsertBefore)
• public LoadInst(llvm::Type * Ty, llvm::Value * Ptr, const llvm::Twine & NameStr, llvm::BasicBlock * InsertAtEnd)
• public LoadInst(llvm::Type * Ty, llvm::Value * Ptr, const llvm::Twine & NameStr, bool isVolatile, llvm::Instruction * InsertBefore)
• public LoadInst(llvm::Type * Ty, llvm::Value * Ptr, const llvm::Twine & NameStr, bool isVolatile, llvm::BasicBlock * InsertAtEnd)
• public LoadInst(llvm::Type * Ty, llvm::Value * Ptr, const llvm::Twine & NameStr, bool isVolatile, llvm::Align Align, llvm::Instruction * InsertBefore = nullptr)
• public LoadInst(llvm::Type * Ty, llvm::Value * Ptr, const llvm::Twine & NameStr, bool isVolatile, llvm::Align Align, llvm::BasicBlock * InsertAtEnd)
• public LoadInst(llvm::Type * Ty, llvm::Value * Ptr, const llvm::Twine & NameStr, bool isVolatile, llvm::Align Align, llvm::AtomicOrdering Order, SyncScope::ID SSID = SyncScope::System, llvm::Instruction * InsertBefore = nullptr)
• public LoadInst(llvm::Type * Ty, llvm::Value * Ptr, const llvm::Twine & NameStr, bool isVolatile, llvm::Align Align, llvm::AtomicOrdering Order, SyncScope::ID SSID, llvm::BasicBlock * InsertAtEnd)
• public static bool classof(const llvm::Value * V)
• public static bool classof(const llvm::Instruction * I)
• protected llvm::LoadInst * cloneImpl() const
• public llvm::Align getAlign() const
• public llvm::AtomicOrdering getOrdering() const
• public unsigned int getPointerAddressSpace() const
• public llvm::Value * getPointerOperand()
• public const llvm::Value * getPointerOperand() const
• public static unsigned int getPointerOperandIndex()
• public llvm::Type * getPointerOperandType() const
• public SyncScope::ID getSyncScopeID() const
• public bool isSimple() const
• public bool isUnordered() const
• public bool isVolatile() const
• public void setAlignment(llvm::Align Align)
• public void setAtomic(llvm::AtomicOrdering Ordering, SyncScope::ID SSID = SyncScope::System)
• public void setOrdering(llvm::AtomicOrdering Ordering)
• private template <typename Bitfield>void setSubclassData(typename Bitfield::Type Value)
• public void setSyncScopeID(SyncScope::ID SSID)
• public void setVolatile(bool V)

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

¶void AssertOK()

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

¶LoadInst(llvm::Type* Ty,
         llvm::Value* Ptr,
         const llvm::Twine& NameStr,
         llvm::Instruction* InsertBefore)

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

Parameters

llvm::Type* Ty

llvm::Value* Ptr

const llvm::Twine& NameStr

llvm::Instruction* InsertBefore

¶LoadInst(llvm::Type* Ty,
         llvm::Value* Ptr,
         const llvm::Twine& NameStr,
         llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::Type* Ty

llvm::Value* Ptr

const llvm::Twine& NameStr

llvm::BasicBlock* InsertAtEnd

¶LoadInst(llvm::Type* Ty,
         llvm::Value* Ptr,
         const llvm::Twine& NameStr,
         bool isVolatile,
         llvm::Instruction* InsertBefore)

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

Parameters

llvm::Type* Ty

llvm::Value* Ptr

const llvm::Twine& NameStr

bool isVolatile

llvm::Instruction* InsertBefore

¶LoadInst(llvm::Type* Ty,
         llvm::Value* Ptr,
         const llvm::Twine& NameStr,
         bool isVolatile,
         llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::Type* Ty

llvm::Value* Ptr

const llvm::Twine& NameStr

bool isVolatile

llvm::BasicBlock* InsertAtEnd

¶LoadInst(
    llvm::Type* Ty,
    llvm::Value* Ptr,
    const llvm::Twine& NameStr,
    bool isVolatile,
    llvm::Align Align,
    llvm::Instruction* InsertBefore = nullptr)

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

Parameters

llvm::Type* Ty

llvm::Value* Ptr

const llvm::Twine& NameStr

bool isVolatile

llvm::Align Align

llvm::Instruction* InsertBefore = nullptr

¶LoadInst(llvm::Type* Ty,
         llvm::Value* Ptr,
         const llvm::Twine& NameStr,
         bool isVolatile,
         llvm::Align Align,
         llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::Type* Ty

llvm::Value* Ptr

const llvm::Twine& NameStr

bool isVolatile

llvm::Align Align

llvm::BasicBlock* InsertAtEnd

¶LoadInst(
    llvm::Type* Ty,
    llvm::Value* Ptr,
    const llvm::Twine& NameStr,
    bool isVolatile,
    llvm::Align Align,
    llvm::AtomicOrdering Order,
    SyncScope::ID SSID = SyncScope::System,
    llvm::Instruction* InsertBefore = nullptr)

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

Parameters

llvm::Type* Ty

llvm::Value* Ptr

const llvm::Twine& NameStr

bool isVolatile

llvm::Align Align

llvm::AtomicOrdering Order

SyncScope::ID SSID = SyncScope::System

llvm::Instruction* InsertBefore = nullptr

¶LoadInst(llvm::Type* Ty,
         llvm::Value* Ptr,
         const llvm::Twine& NameStr,
         bool isVolatile,
         llvm::Align Align,
         llvm::AtomicOrdering Order,
         SyncScope::ID SSID,
         llvm::BasicBlock* InsertAtEnd)

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

Parameters

llvm::Type* Ty

llvm::Value* Ptr

const llvm::Twine& NameStr

bool isVolatile

llvm::Align Align

llvm::AtomicOrdering Order

SyncScope::ID SSID

llvm::BasicBlock* InsertAtEnd

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

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

Parameters

const llvm::Value* V

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

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

Parameters

const llvm::Instruction* I

¶llvm::LoadInst* cloneImpl() const

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

¶llvm::Align getAlign() const

Description

Return the alignment of the access that is being performed.

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

¶llvm::AtomicOrdering getOrdering() const

Description

Returns the ordering constraint of this load instruction.

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

¶unsigned int getPointerAddressSpace() const

Description

Returns the address space of the pointer operand.

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

¶llvm::Value* getPointerOperand()

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

¶const llvm::Value* getPointerOperand() const

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

¶static unsigned int getPointerOperandIndex()

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

¶llvm::Type* getPointerOperandType() const

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

¶SyncScope::ID getSyncScopeID() const

Description

Returns the synchronization scope ID of this load instruction.

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

¶bool isSimple() const

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

¶bool isUnordered() const

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

¶bool isVolatile() const

Description

Return true if this is a load from a volatile memory location.

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

¶void setAlignment(llvm::Align Align)

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

Parameters

llvm::Align Align

¶void setAtomic(
    llvm::AtomicOrdering Ordering,
    SyncScope::ID SSID = SyncScope::System)

Description

Sets the ordering constraint and the synchronization scope ID of this load instruction.

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

Parameters

llvm::AtomicOrdering Ordering

SyncScope::ID SSID = SyncScope::System

¶void setOrdering(llvm::AtomicOrdering Ordering)

Description

Sets the ordering constraint of this load instruction. May not be Release or AcquireRelease.

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

Parameters

llvm::AtomicOrdering Ordering

¶template <typename Bitfield>
void setSubclassData(
    typename Bitfield::Type Value)

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

Templates

Bitfield

Parameters

typename Bitfield::Type Value

¶void setSyncScopeID(SyncScope::ID SSID)

Description

Sets the synchronization scope ID of this load instruction.

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

Parameters

SyncScope::ID SSID

¶void setVolatile(bool V)

Description

Specify whether this is a volatile load or not.

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

Parameters

bool V