class User

Declaration

class User : public Value { /* full declaration omitted */ };

Description

LLVM Value Representation This is a very important LLVM class. It is the base class of all values computed by a program that may be used as operands to other values. Value is the super class of other important classes such as Instruction and Function. All Values have a Type. Type is not a subclass of Value. Some values can have a name and they belong to some Module. Setting the name on the Value automatically updates the module's symbol table. Every value has a "use list" that keeps track of which other Values are using this Value. A Value can also have an arbitrary number of ValueHandle objects that watch it and listen to RAUW and Destroy events. See llvm/IR/ValueHandle.h for details.

Declared at: llvm/include/llvm/IR/User.h:44

Inherits from: Value

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

• protected template <int Idx>const llvm::Use & Op() const
• protected template <int Idx>llvm::Use & Op()
• protected template <int Idx, typename U>static llvm::Use & OpFrom(const U * that)
• protected User(llvm::Type * ty, unsigned int vty, llvm::Use *, unsigned int NumOps)
• public User(const llvm::User &)
• protected void allocHungoffUses(unsigned int N, bool IsPhi = false)
• private static inline void * allocateFixedOperandUser(size_t, unsigned int, unsigned int)
• public static bool classof(const llvm::Value * V)
• public void dropAllReferences()
• public MutableArrayRef<uint8_t> getDescriptor()
• public ArrayRef<const uint8_t> getDescriptor() const
• private const llvm::Use * getHungOffOperands() const
• private llvm::Use *& getHungOffOperands()
• private const llvm::Use * getIntrusiveOperands() const
• private llvm::Use * getIntrusiveOperands()
• public unsigned int getNumOperands() const
• public llvm::Value * getOperand(unsigned int i) const
• public const llvm::Use * getOperandList() const
• public llvm::Use * getOperandList()
• public const llvm::Use & getOperandUse(unsigned int i) const
• public llvm::Use & getOperandUse(unsigned int i)
• protected void growHungoffUses(unsigned int N, bool IsPhi = false)
• public bool isDroppable() const
• public llvm::User::op_iterator op_begin()
• public llvm::User::const_op_iterator op_begin() const
• public llvm::User::const_op_iterator op_end() const
• public llvm::User::op_iterator op_end()
• public iterator_range<llvm::User::value_op_iterator> operand_values()
• public iterator_range<llvm::User::const_value_op_iterator> operand_values() const
• public llvm::User::op_range operands()
• public llvm::User::const_op_range operands() const
• public bool replaceUsesOfWith(llvm::Value * From, llvm::Value * To)
• public void setGlobalVariableNumOperands(unsigned int NumOps)
• public void setNumHungOffUseOperands(unsigned int NumOps)
• public void setOperand(unsigned int i, llvm::Value * Val)
• private void setOperandList(llvm::Use * NewList)
• public llvm::User::value_op_iterator value_op_begin()
• public llvm::User::const_value_op_iterator value_op_begin() const
• public llvm::User::value_op_iterator value_op_end()
• public llvm::User::const_value_op_iterator value_op_end() const
• protected ~User()

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

¶template <int Idx>
const llvm::Use& Op() const

Declared at: llvm/include/llvm/IR/User.h:136

Templates

int Idx

¶template <int Idx>
llvm::Use& Op()

Declared at: llvm/include/llvm/IR/User.h:133

Templates

int Idx

¶template <int Idx, typename U>
static llvm::Use& OpFrom(const U* that)

Declared at: llvm/include/llvm/IR/User.h:127

Templates

int Idx

U

Parameters

const U* that

¶User(llvm::Type* ty,
     unsigned int vty,
     llvm::Use*,
     unsigned int NumOps)

Declared at: llvm/include/llvm/IR/User.h:73

Parameters

llvm::Type* ty

unsigned int vty

llvm::Use*

unsigned int NumOps

¶User(const llvm::User&)

Declared at: llvm/include/llvm/IR/User.h:97

Parameters

const llvm::User&

¶void allocHungoffUses(unsigned int N,
                      bool IsPhi = false)

Description

Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User.

Declared at: llvm/include/llvm/IR/User.h:87

Parameters

unsigned int N

bool IsPhi = false

identifies callers which are phi nodes and which need N BasicBlock* allocated along with N

¶static inline void* allocateFixedOperandUser(
    size_t,
    unsigned int,
    unsigned int)

Declared at: llvm/include/llvm/IR/User.h:49

Parameters

size_t

unsigned int

unsigned int

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

Declared at: llvm/include/llvm/IR/User.h:311

Parameters

const llvm::Value* V

¶void dropAllReferences()

Description

Drop all references to operands. This function is in charge of "letting go" of all objects that this User refers to. This allows one to 'delete' a whole class at a time, even though there may be circular references... First all references are dropped, and all use counts go to zero. Then everything is deleted for real. Note that no operations are valid on an object that has "dropped all references", except operator delete.

Declared at: llvm/include/llvm/IR/User.h:299

¶MutableArrayRef<uint8_t> getDescriptor()

Description

Returns the descriptor co-allocated with this User instance.

Declared at: llvm/include/llvm/IR/User.h:197

¶ArrayRef<const uint8_t> getDescriptor() const

Description

Returns the descriptor co-allocated with this User instance.

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

¶const llvm::Use* getHungOffOperands() const

Declared at: llvm/include/llvm/IR/User.h:141

¶llvm::Use*& getHungOffOperands()

Declared at: llvm/include/llvm/IR/User.h:145

¶const llvm::Use* getIntrusiveOperands() const

Declared at: llvm/include/llvm/IR/User.h:147

¶llvm::Use* getIntrusiveOperands()

Declared at: llvm/include/llvm/IR/User.h:151

¶unsigned int getNumOperands() const

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

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

Declared at: llvm/include/llvm/IR/User.h:169

Parameters

unsigned int i

¶const llvm::Use* getOperandList() const

Declared at: llvm/include/llvm/IR/User.h:162

¶llvm::Use* getOperandList()

Declared at: llvm/include/llvm/IR/User.h:165

¶const llvm::Use& getOperandUse(
    unsigned int i) const

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

Parameters

unsigned int i

¶llvm::Use& getOperandUse(unsigned int i)

Declared at: llvm/include/llvm/IR/User.h:186

Parameters

unsigned int i

¶void growHungoffUses(unsigned int N,
                     bool IsPhi = false)

Description

Grow the number of hung off uses. Note that allocHungoffUses should be called if there are no uses.

Declared at: llvm/include/llvm/IR/User.h:91

Parameters

unsigned int N

bool IsPhi = false

¶bool isDroppable() const

Description

A droppable user is a user for which uses can be dropped without affecting correctness and should be dropped rather than preventing a transformation from happening.

Declared at: llvm/include/llvm/IR/User.h:224

¶llvm::User::op_iterator op_begin()

Declared at: llvm/include/llvm/IR/User.h:234

¶llvm::User::const_op_iterator op_begin() const

Declared at: llvm/include/llvm/IR/User.h:235

¶llvm::User::const_op_iterator op_end() const

Declared at: llvm/include/llvm/IR/User.h:239

¶llvm::User::op_iterator op_end()

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

¶iterator_range<llvm::User::value_op_iterator>
operand_values()

Declared at: llvm/include/llvm/IR/User.h:266

¶iterator_range<
    llvm::User::const_value_op_iterator>
operand_values() const

Declared at: llvm/include/llvm/IR/User.h:287

¶llvm::User::op_range operands()

Declared at: llvm/include/llvm/IR/User.h:242

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

Declared at: llvm/include/llvm/IR/User.h:245

¶bool replaceUsesOfWith(llvm::Value* From,
                       llvm::Value* To)

Description

Replace uses of one Value with another. Replaces all references to the "From" definition with references to the "To" definition. Returns whether any uses were replaced.

Declared at: llvm/include/llvm/IR/User.h:308

Parameters

llvm::Value* From

llvm::Value* To

¶void setGlobalVariableNumOperands(
    unsigned int NumOps)

Description

Set the number of operands on a GlobalVariable. GlobalVariable always allocates space for a single operands, but doesn't always use it. FIXME: As that the number of operands is used to find the start of the allocated memory in operator delete, we need to always think we have 1 operand before delete.

Declared at: llvm/include/llvm/IR/User.h:207

Parameters

unsigned int NumOps

¶void setNumHungOffUseOperands(unsigned int NumOps)

Description

Subclasses with hung off uses need to manage the operand count themselves. In these instances, the operand count isn't used to find the OperandList, so there's no issue in having the operand count change.

Declared at: llvm/include/llvm/IR/User.h:215

Parameters

unsigned int NumOps

¶void setOperand(unsigned int i, llvm::Value* Val)

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

Parameters

unsigned int i

llvm::Value* Val

¶void setOperandList(llvm::Use* NewList)

Declared at: llvm/include/llvm/IR/User.h:155

Parameters

llvm::Use* NewList

¶llvm::User::value_op_iterator value_op_begin()

Declared at: llvm/include/llvm/IR/User.h:260

¶llvm::User::const_value_op_iterator
value_op_begin() const

Declared at: llvm/include/llvm/IR/User.h:281

¶llvm::User::value_op_iterator value_op_end()

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

¶llvm::User::const_value_op_iterator value_op_end()
    const

Declared at: llvm/include/llvm/IR/User.h:284

¶~User()

Declared at: llvm/include/llvm/IR/User.h:94