LLVM  14.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
llvm::User Class Reference

#include "llvm/IR/User.h"

Inheritance diagram for llvm::User:
Inheritance graph
[legend]
Collaboration diagram for llvm::User:
Collaboration graph
[legend]

Classes

struct  const_value_op_iterator
 
struct  value_op_iterator
 Iterator for directly iterating over the operand Values. More...
 

Public Types

using op_iterator = Use *
 
using const_op_iterator = const Use *
 
using op_range = iterator_range< op_iterator >
 
using const_op_range = iterator_range< const_op_iterator >
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
using use_iterator = use_iterator_impl< Use >
 
using const_use_iterator = use_iterator_impl< const Use >
 
using user_iterator = user_iterator_impl< User >
 
using const_user_iterator = user_iterator_impl< const User >
 

Public Member Functions

 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *Usr, unsigned)
 Placement delete - required by std, called if the ctor throws. More...
 
void operator delete (void *Usr, unsigned, unsigned)
 Placement delete - required by std, called if the ctor throws. More...
 
const UsegetOperandList () const
 
UsegetOperandList ()
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
ArrayRef< const uint8_t > getDescriptor () const
 Returns the descriptor co-allocated with this User instance. More...
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance. More...
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
bool isDroppable () const
 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. More...
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
const_value_op_iterator value_op_begin () const
 
const_value_op_iterator value_op_end () const
 
iterator_range< const_value_op_iteratoroperand_values () const
 
void dropAllReferences ()
 Drop all references to operands. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value. More...
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
std::string getNameOrAsOperand () const
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value. More...
 
void replaceUsesWithIf (Value *New, llvm::function_ref< bool(Use &U)> ShouldReplace)
 Go through the uses list for this definition and make each use point to "V" if the callback ShouldReplace returns true for the given Use. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
bool materialized_use_empty () const
 
use_iterator materialized_use_begin ()
 
const_use_iterator materialized_use_begin () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
bool user_empty () const
 
user_iterator materialized_user_begin ()
 
const_user_iterator materialized_user_begin () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one use of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N uses. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N uses or more. More...
 
bool hasOneUser () const
 Return true if there is exactly one user of this value. More...
 
UsegetSingleUndroppableUse ()
 Return true if there is exactly one use of this value that cannot be dropped. More...
 
const UsegetSingleUndroppableUse () const
 
UsergetUniqueUndroppableUser ()
 Return true if there is exactly one unique user of this value that cannot be dropped (that user can have multiple uses of this value). More...
 
const UsergetUniqueUndroppableUser () const
 
bool hasNUndroppableUses (unsigned N) const
 Return true if there this value. More...
 
bool hasNUndroppableUsesOrMore (unsigned N) const
 Return true if this value has N uses or more. More...
 
void dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;})
 Remove every uses that can safely be removed. More...
 
void dropDroppableUsesIn (User &Usr)
 Remove every use of this value in User that can safely be removed. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
bool isTransitiveUsedByMetadataOnly () const
 
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs and address space casts. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndAliases () const
 Strip off pointer casts, all-zero GEPs, address space casts, and aliases. More...
 
ValuestripPointerCastsAndAliases ()
 
const ValuestripPointerCastsSameRepresentation () const
 Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same. More...
 
ValuestripPointerCastsSameRepresentation ()
 
const ValuestripPointerCastsForAliasAnalysis () const
 Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info. More...
 
ValuestripPointerCastsForAliasAnalysis ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr) const
 Accumulate the constant offset this value has compared to a base pointer. More...
 
ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds)
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false. More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {})
 
bool canBeFreed () const
 Return true if the memory object referred to by V can by freed in the scope for which the SSA value defining the allocation is statically defined. More...
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
 
Align getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 

Static Public Member Functions

static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::Value
static void dropDroppableUse (Use &U)
 Remove the droppable use U. More...
 

Protected Member Functions

void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated. More...
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated. More...
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
 ~User ()=default
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID. More...
 
bool hasMetadata () const
 Return true if this value has any metadata attached to it. More...
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind. More...
 
void clearMetadata ()
 Erase all metadata attached to this Value. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any. More...
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order. More...
 
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
 
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached. More...
 
bool hasMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment. More...
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment. More...
 
void addMetadata (StringRef Kind, MDNode &MD)
 

Static Protected Member Functions

template<int Idx, typename U >
static UseOpFrom (const U *that)
 

Friends

template<unsigned >
struct HungoffOperandTraits
 

Additional Inherited Members

- Static Public Attributes inherited from llvm::Value
static constexpr unsigned MaxAlignmentExponent = 32
 The maximum alignment for instructions. More...
 
static constexpr uint64_t MaximumAlignment = 1ULL << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 27 }
 The number of operands in the subclass. More...
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasMetadata: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Detailed Description

Definition at line 44 of file User.h.

Member Typedef Documentation

◆ const_op_iterator

Definition at line 230 of file User.h.

◆ const_op_range

Definition at line 232 of file User.h.

◆ op_iterator

Definition at line 229 of file User.h.

◆ op_range

Definition at line 231 of file User.h.

Constructor & Destructor Documentation

◆ User() [1/2]

llvm::User::User ( Type ty,
unsigned  vty,
Use ,
unsigned  NumOps 
)
inlineprotected

◆ ~User()

llvm::User::~User ( )
protecteddefault

◆ User() [2/2]

llvm::User::User ( const User )
delete

Member Function Documentation

◆ allocHungoffUses()

void llvm::User::allocHungoffUses ( unsigned  N,
bool  IsPhi = false 
)
protected

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

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

Definition at line 44 of file User.cpp.

References assert(), llvm::Value::HasHungOffUses, N, and llvm::size().

Referenced by llvm::MemoryPhi::allocHungoffUses(), llvm::PHINode::allocHungoffUses(), and growHungoffUses().

◆ classof()

static bool llvm::User::classof ( const Value V)
inlinestatic

Definition at line 311 of file User.h.

◆ dropAllReferences()

void llvm::User::dropAllReferences ( )
inline

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.

Definition at line 299 of file User.h.

References operands().

Referenced by llvm::GlobalVariable::dropAllReferences(), llvm::Function::dropAllReferences(), llvm::expandDivision(), llvm::expandDivisionUpTo32Bits(), llvm::expandDivisionUpTo64Bits(), llvm::expandRemainder(), llvm::expandRemainderUpTo32Bits(), llvm::expandRemainderUpTo64Bits(), llvm::MemorySSAUpdater::removeBlocks(), and llvm::MemorySSA::~MemorySSA().

◆ getDescriptor() [1/2]

MutableArrayRef<uint8_t> llvm::User::getDescriptor ( )

Returns the descriptor co-allocated with this User instance.

◆ getDescriptor() [2/2]

MutableArrayRef< uint8_t > llvm::User::getDescriptor ( ) const

Returns the descriptor co-allocated with this User instance.

Definition at line 93 of file User.cpp.

Referenced by llvm::CallBase::bundle_op_info_begin(), and llvm::CallBase::bundle_op_info_end().

◆ getNumOperands()

unsigned llvm::User::getNumOperands ( ) const
inline

Definition at line 191 of file User.h.

References llvm::Value::NumUserOperands.

Referenced by llvm::SwitchInst::addCase(), llvm::LandingPadInst::addClause(), llvm::IndirectBrInst::addDestination(), llvm::CatchSwitchInst::addHandler(), canReplaceGEPIdxWithZero(), canSinkInstructions(), llvm::GetElementPtrInst::cloneImpl(), llvm::CallInst::cloneImpl(), llvm::FuncletPadInst::cloneImpl(), llvm::ReturnInst::cloneImpl(), llvm::BranchInst::cloneImpl(), llvm::InvokeInst::cloneImpl(), llvm::CallBrInst::cloneImpl(), llvm::CatchReturnInst::cloneImpl(), llvm::CleanupReturnInst::cloneImpl(), llvm::FunctionComparator::cmpConstants(), llvm::FunctionComparator::cmpOperations(), CombineBaseUpdate(), doPromotion(), llvm::Function::dropAllReferences(), emitGlobalConstantArray(), emitGlobalConstantStruct(), llvm::Evaluator::EvaluateFunction(), evaluateICmpRelation(), llvm::AArch64TargetLowering::fallBackToDAGISel(), FindUsedValues(), findUsedValues(), llvm::InstCombinerImpl::foldGEPICmp(), llvm::InstCombinerImpl::foldPHIArgGEPIntoPHI(), llvm::InstCombinerImpl::foldSelectOpOp(), llvm::ConstantExpr::getAsInstruction(), getBranchWeight(), llvm::getGEPInductionOperand(), llvm::SCEVExpander::getIVIncOperand(), getLoopPhiForCounter(), llvm::SystemZTTIImpl::getMemoryOpCost(), llvm::GEPOperator::getNumIndices(), llvm::GetElementPtrInst::getNumIndices(), getOffsetFromIndices(), llvm::Function::getPersonalityFn(), llvm::Function::getPrefixData(), llvm::Function::getPrologueData(), llvm::ConstantVector::getSplatValue(), llvm::TargetTransformInfoImplCRTPBase< AMDGPUTTIImpl >::getUserCost(), llvm::ConstantExpr::getWithOperands(), growHungoffUses(), llvm::GetElementPtrInst::hasAllConstantIndices(), llvm::GetElementPtrInst::hasAllZeroIndices(), llvm::GEPOperator::hasIndices(), llvm::GetElementPtrInst::hasIndices(), isEmptyXXStructor(), llvm::Instruction::isIdenticalToWhenDefined(), AANoAliasCallSiteArgument::isKnownNoAliasDueToNoAliasPreservation(), isNotUsedOrFreeInLoop(), llvm::isPointerOffset(), isSafeSROAGEP(), llvm::isSafeToSpeculativelyExecute(), llvm::Instruction::isSameOperationAs(), llvm::VariadicOperandTraits< ConstantExpr, 1 >::op_begin(), llvm::HungoffOperandTraits< 3 >::op_end(), llvm::OptionalOperandTraits< GlobalVariable >::operands(), llvm::VariadicOperandTraits< ConstantExpr, 1 >::operands(), llvm::HungoffOperandTraits< 3 >::operands(), llvm::orc::CtorDtorIterator::operator*(), parseGlobalCtors(), llvm::PPCTargetLowering::PerformDAGCombine(), llvm::SwitchInst::removeCase(), llvm::IndirectBrInst::removeDestination(), removeGlobalCtors(), llvm::CatchSwitchInst::removeHandler(), llvm::PHINode::removeIncomingValue(), llvm::VPValue::replaceAllUsesWith(), replaceUsesOfWith(), llvm::ExecutionEngine::runStaticConstructorsDestructors(), llvm::InnerLoopVectorizer::scalarizeInstruction(), SimplifyUsingControlFlow(), sinkLastInstruction(), SRAGlobal(), llvm::MemorySSA::verifyOrderingDominationAndDefUses(), VisitGlobalVariableForEmission(), llvm::InstCombinerImpl::visitReturnInst(), llvm::InnerLoopVectorizer::widenPHIInstruction(), and WidenIV::widenWithVariantUse().

◆ getOperand()

Value* llvm::User::getOperand ( unsigned  i) const
inline

Definition at line 169 of file User.h.

References assert(), getOperandList(), i, and llvm::Value::NumUserOperands.

Referenced by AddReturnAttributes(), llvm::LanaiInstrInfo::analyzeBranch(), BreakUpSubtract(), canEvaluateShiftedShift(), CanGenerateTest(), canonicalizeBitCastExtElt(), canonicalizeInsertSplat(), canonicalizeSaturatedAdd(), canonicalizeSaturatedSubtract(), CanPHITrans(), canReplaceGEPIdxWithZero(), canSinkInstructions(), CheckForPhysRegDependency(), checkIfSafeAddSequence(), checkOrderedReduction(), checkOverflow(), WidenIV::cloneArithmeticIVUser(), WidenIV::cloneBitwiseIVUser(), llvm::AllocaInst::cloneImpl(), llvm::LoadInst::cloneImpl(), llvm::StoreInst::cloneImpl(), llvm::AtomicCmpXchgInst::cloneImpl(), llvm::AtomicRMWInst::cloneImpl(), llvm::SelectInst::cloneImpl(), llvm::VAArgInst::cloneImpl(), llvm::ExtractElementInst::cloneImpl(), llvm::InsertElementInst::cloneImpl(), llvm::ShuffleVectorInst::cloneImpl(), llvm::TruncInst::cloneImpl(), llvm::ZExtInst::cloneImpl(), llvm::SExtInst::cloneImpl(), llvm::FPTruncInst::cloneImpl(), llvm::FPExtInst::cloneImpl(), llvm::UIToFPInst::cloneImpl(), llvm::SIToFPInst::cloneImpl(), llvm::FPToUIInst::cloneImpl(), llvm::FPToSIInst::cloneImpl(), llvm::IntToPtrInst::cloneImpl(), llvm::PtrToIntInst::cloneImpl(), llvm::BitCastInst::cloneImpl(), llvm::AddrSpaceCastInst::cloneImpl(), llvm::FreezeInst::cloneImpl(), llvm::FunctionComparator::cmpConstants(), llvm::FunctionComparator::cmpOperations(), llvm::collectCmpOps(), collectShuffleElements(), collectSingleShuffleElements(), CombineBaseUpdate(), combineScalarToVector(), combineTargetShuffle(), CombineVLDDUP(), llvm::InstCombinerImpl::commonCastTransforms(), llvm::InstCombinerImpl::commonPointerCastTransforms(), computeKnownBitsFromOperator(), computeUnlikelySuccessors(), llvm::ConstantFoldCompareInstOperands(), llvm::ConstantFoldCompareInstruction(), constantFoldUser(), convertBitCastToGEP(), ConvertShiftToMul(), despeculateCountZeros(), detectPopcountIdiom(), detectShiftUntilZeroIdiom(), dominatesAllUsesOf(), dropRedundantMaskingOfLeftShiftInput(), emitGlobalConstantArray(), emitGlobalConstantStruct(), emitGlobalConstantVector(), equalityPropUnSafe(), llvm::Evaluator::EvaluateFunction(), evaluateICmpRelation(), llvm::VPPredInstPHIRecipe::execute(), llvm::expandDivision(), llvm::expandDivisionUpTo32Bits(), llvm::expandDivisionUpTo64Bits(), llvm::expandRemainder(), llvm::expandRemainderUpTo32Bits(), llvm::expandRemainderUpTo64Bits(), ExtendUsesToFormExtLoad(), llvm::AArch64TargetLowering::fallBackToDAGISel(), findBuildAggregate_rec(), findDemandedEltsBySingleUser(), findFinalIVValue(), findGlobalCtors(), findInitTrampoline(), findInitTrampolineFromAlloca(), findInitTrampolineFromBB(), llvm::findScalarElement(), findSelectThroughCast(), FindSingleUseMultiplyFactors(), FindUsedValues(), findUsedValues(), foldAndOrOfEqualityCmpsWithConstants(), foldBitCastBitwiseLogic(), foldBitCastSelect(), llvm::InstCombinerImpl::foldCmpLoadFromIndexedGlobal(), foldConstantInsEltIntoShuffle(), llvm::InstCombinerImpl::foldFCmpIntToFPConst(), foldFCmpReciprocalAndZero(), llvm::InstCombinerImpl::foldGEPICmp(), foldGuardedFunnelShift(), llvm::InstCombinerImpl::foldICmpBinOp(), llvm::InstCombinerImpl::foldICmpBinOpEqualityWithConstant(), llvm::InstCombinerImpl::foldICmpDivConstant(), llvm::InstCombinerImpl::foldICmpInstWithConstantNotInt(), llvm::InstCombinerImpl::foldICmpShlConstant(), llvm::InstCombinerImpl::foldICmpShrConstant(), llvm::InstCombinerImpl::foldICmpSRemConstant(), llvm::InstCombinerImpl::foldICmpSubConstant(), llvm::InstCombinerImpl::foldICmpTruncConstant(), llvm::InstCombinerImpl::foldICmpUDivConstant(), llvm::InstCombinerImpl::foldICmpWithCastOp(), foldICmpWithZextOrSext(), foldIdentityExtractShuffle(), foldIdentityPaddedShuffles(), foldInsEltIntoIdentityShuffle(), foldInsEltIntoSplat(), foldInsSequenceIntoSplat(), llvm::InstCombinerImpl::foldIntegerTypedPHI(), foldIsPowerOf2(), llvm::InstCombinerImpl::foldItoFPtoI(), foldLogicCastConstant(), llvm::InstCombinerImpl::foldPHIArgBinOpIntoPHI(), llvm::InstCombinerImpl::foldPHIArgGEPIntoPHI(), llvm::InstCombinerImpl::foldPHIArgLoadIntoPHI(), llvm::InstCombinerImpl::foldPHIArgOpIntoPHI(), foldSelectBinOpIdentity(), foldSelectICmpAndOr(), foldSelectICmpLshrAshr(), llvm::InstCombinerImpl::foldSelectOpOp(), foldSelectShuffle(), foldSelectShuffleWith1Binop(), llvm::InstCombinerImpl::FoldShiftByConstant(), foldShiftedShift(), foldShiftIntoShiftInAnotherHandOfAndInICmp(), foldShuffleWithInsert(), foldSignedTruncationCheck(), foldTruncShuffle(), llvm::InstCombinerImpl::foldVectorBinop(), foldVecTruncToExtElt(), llvm::InstCombinerImpl::freezeDominatedUses(), llvm::InsertValueInst::getAggregateOperand(), llvm::GlobalAlias::getAliaseeObject(), getAlternateBinop(), llvm::CallBase::getArgOperand(), llvm::AllocaInst::getArraySize(), llvm::Loop::LoopBounds::getBounds(), getBranchCondString(), llvm::Loop::LoopBounds::getCanonicalPredicate(), getCastsForInductionPHI(), llvm::AtomicCmpXchgInst::getCompareOperand(), llvm::ExecutionEngine::getConstantValue(), llvm::MemoryUseOrDef::getDefiningAccess(), WidenIV::getExtendedOperandRecurrence(), llvm::getGEPInductionOperand(), llvm::CallBrInst::getIndirectDestLabel(), llvm::GlobalIndirectSymbol::getIndirectSymbol(), llvm::Loop::getInductionVariable(), llvm::InsertValueInst::getInsertedValueOperand(), getInvertibleOperands(), llvm::SCEVExpander::getIVIncOperand(), getLoopPhiForCounter(), getMaskedTypeForICmpPair(), llvm::SystemZTTIImpl::getMemoryOpCost(), llvm::AtomicCmpXchgInst::getNewValOperand(), getOffsetFromIndices(), llvm::LoadInst::getPointerOperand(), llvm::StoreInst::getPointerOperand(), llvm::GEPOperator::getPointerOperand(), llvm::PtrToIntOperator::getPointerOperand(), llvm::AddrSpaceCastOperator::getPointerOperand(), llvm::AtomicCmpXchgInst::getPointerOperand(), llvm::GetElementPtrInst::getPointerOperand(), llvm::PtrToIntInst::getPointerOperand(), llvm::AddrSpaceCastInst::getPointerOperand(), getRecurrenceVar(), llvm::objcarc::getreturnRVOperand(), getSalvageOpsForBinOp(), llvm::NoAliasScopeDeclInst::getScopeList(), getShape(), getShuffleDemandedElts(), llvm::Constant::getSplatValue(), llvm::ConstantVector::getSplatValue(), llvm::BitCastOperator::getSrcTy(), llvm::GlobalStatus::getStoredOnceValue(), llvm::ScalarEvolution::getStrengthenedNoWrapFlagsFromBinOp(), llvm::BasicBlock::getTerminatingMustTailCall(), llvm::SITargetLowering::getTgtMemIntrinsic(), llvm::CanonicalLoopInfo::getTripCount(), llvm::TargetTransformInfoImplCRTPBase< AMDGPUTTIImpl >::getUserCost(), getValueFromICmpCondition(), llvm::StoreInst::getValueOperand(), llvm::slpvectorizer::BoUpSLP::getVectorElementSize(), llvm::ConstantExpr::getWithOperands(), handleBrSelExpect(), AAValueSimplifyFloating::handleCmp(), handleIndirectSymViaGOTPCRel(), handlePhiDef(), llvm::GetElementPtrInst::hasAllConstantIndices(), llvm::GetElementPtrInst::hasAllZeroIndices(), hoistInsEltConst(), AANoAliasFloating::initialize(), inlineRetainOrClaimRVCalls(), instCombineConvertFromSVBool(), instCombineSVEDup(), instCombineSVETBL(), instCombineSVEVectorBinOp(), instCombineSVEVectorMul(), isAddOfNonZero(), isAllocSiteRemovable(), llvm::GCNTTIImpl::isAlwaysUniform(), llvm::AllocaInst::isArrayAllocation(), isEqualImpl(), isExtractBitsCandidateUse(), llvm::SystemZTTIImpl::isFoldableLoad(), llvm::InductionDescriptor::isFPInductionPHI(), isGOTEquivalentCandidate(), isI32Insn(), isImpliedCondICmps(), llvm::isImpliedCondition(), llvm::CastInst::isIntegerCast(), isLoadInvariantInLoop(), isLoopExitTestBasedOn(), llvm::CastInst::isLosslessCast(), llvm::SystemZTargetLowering::isMaskAndCmp0FoldingBeneficial(), llvm::AArch64TargetLowering::isMaskAndCmp0FoldingBeneficial(), llvm::CastInst::isNoopCast(), llvm::isPointerOffset(), llvm::AArch64TargetLowering::isProfitableToHoist(), llvm::PPCTargetLowering::isProfitableToHoist(), isRepeatedByteSequence(), isReturnNonNull(), isSafeAndProfitableToSinkLoad(), isSafeSROAGEP(), isSafeToEliminateVarargsCast(), llvm::isSafeToSpeculativelyExecute(), llvm::Instruction::isSameOperationAs(), isShuffleEquivalentToSelect(), isShuffleExtractingFromLHS(), isSSATMinMaxPattern(), lookThroughCast(), llvm::FastISel::lowerCallTo(), llvm::AArch64TargetLowering::lowerInterleavedStore(), llvm::ARMTargetLowering::lowerInterleavedStore(), llvm::IntrinsicLowering::LowerIntrinsicCall(), lowerIsConstantIntrinsic(), LowerNegateToMultiply(), AAHeapToStackFunction::manifest(), llvm::matchDecomposedSelectPattern(), llvm::InstCombinerImpl::mergeStoreIntoSuccessor(), narrowInsElt(), narrowSDivOrSRem(), narrowVectorSelect(), llvm::orc::CtorDtorIterator::operator*(), llvm::FastISel::optimizeCmpPredicate(), OptimizeExtractBits(), optimizeIntegerToVectorInsertions(), OptimizeNoopCopyExpression(), parseGlobalCtors(), llvm::PPCTargetLowering::PerformDAGCombine(), PerformMVEVLDCombine(), performNEONPostLDSTCombine(), performPostLD1Combine(), processAnd(), processAShr(), processBinOp(), llvm::JumpThreadingPass::processBranchOnXOR(), processMinMaxIntrinsic(), processSExt(), processUDivOrURem(), processUGT_ADDCST_ADD(), llvm::InstCombinerImpl::PromoteCastOfAllocation(), llvm::promoteLoopAccessesToScalars(), llvm::InstCombinerImpl::pushFreezeToPreventPoisonFromPropagating(), reassociateFCmps(), removeGlobalCtors(), llvm::VPValue::replaceAllUsesWith(), replaceConditionalBranchesOnConstant(), llvm::replaceCreatedSSACopys(), replaceExtractElements(), replaceUsesOfWith(), replaceWithTileLoad(), reuseTableCompare(), rewriteSingleStoreAlloca(), llvm::ExecutionEngine::runStaticConstructorsDestructors(), llvm::InnerLoopVectorizer::scalarizeInstruction(), llvm::FastISel::selectExtractValue(), setLimitsForBinOp(), setLimitsForIntrinsic(), ShouldBreakUpSubtract(), llvm::ARMTargetLowering::shouldExpandAtomicCmpXchgInIR(), llvm::ARMTargetLowering::shouldSinkOperands(), llvm::AArch64TargetLowering::shouldSinkOperands(), shrinkInsertElt(), shrinkSplatShuffle(), simplifyAMDGCNImageIntrinsic(), simplifyAndOfICmpsWithAdd(), simplifyAndOrOfFCmps(), simplifyAndOrOfICmpsWithConstants(), simplifyAndOrOfICmpsWithLimitConst(), simplifyAndOrOfICmpsWithZero(), simplifyAssocCastAssoc(), SimplifyAssociativeBinOp(), llvm::InstCombinerImpl::SimplifyAssociativeOrCommutative(), llvm::InstCombinerImpl::SimplifyDemandedVectorElts(), llvm::ARMTTIImpl::simplifyDemandedVectorEltsIntrinsic(), SimplifyICmpInst(), simplifyICmpWithBinOp(), simplifyOrOfICmpsWithAdd(), llvm::JumpThreadingPass::simplifyPartiallyRedundantLoad(), llvm::InstCombinerImpl::simplifyRangeCheck(), SimplifyRelativeLoad(), llvm::InstCombinerImpl::simplifyShrShlDemandedBits(), SimplifyUsingControlFlow(), llvm::InstCombinerImpl::SimplifyUsingDistributiveLaws(), simplifyX86MaskedLoad(), simplifyX86MaskedStore(), sinkAndCmp0Expression(), SinkCast(), sinkLastInstruction(), SinkShiftAndTruncate(), llvm::InstCombinerImpl::SliceUpIllegalIntegerPHI(), SRAGlobal(), llvm::InnerLoopVectorizer::truncateToMinimalBitwidths(), tryPromoteAllocaToVector(), TryToShrinkGlobalToBoolean(), llvm::JumpThreadingPass::tryToUnfoldSelect(), tryUnmergingGEPsAcrossIndirectBr(), UpgradeX86BinaryIntrinsics(), upgradeX86ConcatShift(), upgradeX86Rotate(), llvm::InstCombinerImpl::visitAddrSpaceCast(), llvm::InstCombinerImpl::visitAnd(), llvm::InstCombinerImpl::visitBitCast(), llvm::InstCombinerImpl::visitExtractElementInst(), llvm::InstCombinerImpl::visitFCmpInst(), llvm::InstCombinerImpl::visitFPExt(), llvm::InstCombinerImpl::visitFPTrunc(), VisitGlobalVariableForEmission(), llvm::InstCombinerImpl::visitInsertValueInst(), llvm::InstCombinerImpl::visitIntToPtr(), visitIVCast(), llvm::InstCombinerImpl::visitLandingPadInst(), llvm::InstCombinerImpl::visitLoadInst(), llvm::InstCombinerImpl::visitMul(), llvm::InstCombinerImpl::visitPHINode(), llvm::InstCombinerImpl::visitReturnInst(), llvm::InstCombinerImpl::visitSExt(), llvm::InstCombinerImpl::visitShl(), llvm::InstCombinerImpl::visitShuffleVectorInst(), llvm::InstCombinerImpl::visitTrunc(), llvm::InstCombinerImpl::visitZExt(), llvm::InnerLoopVectorizer::widenInstruction(), and WidenIV::widenWithVariantUse().

◆ getOperandList() [1/2]

Use* llvm::User::getOperandList ( )
inline

Definition at line 165 of file User.h.

References getOperandList().

◆ getOperandList() [2/2]

const Use* llvm::User::getOperandList ( ) const
inline

◆ getOperandUse() [1/2]

Use& llvm::User::getOperandUse ( unsigned  i)
inline

Definition at line 186 of file User.h.

References assert(), getOperandList(), i, and llvm::Value::NumUserOperands.

◆ getOperandUse() [2/2]

const Use& llvm::User::getOperandUse ( unsigned  i) const
inline

◆ growHungoffUses()

void llvm::User::growHungoffUses ( unsigned  N,
bool  IsPhi = false 
)
protected

Grow the number of hung off uses.

Note that allocHungoffUses should be called if there are no uses.

Definition at line 61 of file User.cpp.

References allocHungoffUses(), assert(), copy, getNumOperands(), getOperandList(), llvm::Value::HasHungOffUses, and llvm::Use::zap().

◆ isDroppable()

bool llvm::User::isDroppable ( ) const

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.

Definition at line 109 of file User.cpp.

Referenced by llvm::Value::dropDroppableUsesIn(), isIntegerWideningViableForSlice(), isUnDroppableUser(), isVectorPromotionViableForSlice(), onlyUsedByLifetimeMarkersOrDroppableInstsHelper(), removeIntrinsicUsers(), and AAMemoryBehaviorFloating::updateImpl().

◆ Op() [1/2]

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

◆ Op() [2/2]

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

Definition at line 136 of file User.h.

◆ op_begin() [1/2]

op_iterator llvm::User::op_begin ( )
inline

◆ op_begin() [2/2]

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

Definition at line 235 of file User.h.

References getOperandList().

◆ op_end() [1/2]

op_iterator llvm::User::op_end ( )
inline

◆ op_end() [2/2]

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

Definition at line 239 of file User.h.

References getOperandList(), and llvm::Value::NumUserOperands.

◆ operand_values() [1/2]

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

◆ operand_values() [2/2]

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

Definition at line 287 of file User.h.

References llvm::make_range(), value_op_begin(), and value_op_end().

◆ operands() [1/2]

op_range llvm::User::operands ( )
inline

◆ operands() [2/2]

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

Definition at line 245 of file User.h.

References op_begin(), and op_end().

◆ operator delete() [1/3]

LLVM_NO_SANITIZE_MEMORY_ATTRIBUTE void llvm::User::operator delete ( void *  Usr)

◆ operator delete() [2/3]

void llvm::User::operator delete ( void *  Usr,
unsigned   
)
inline

Placement delete - required by std, called if the ctor throws.

Definition at line 102 of file User.h.

References llvm_unreachable.

◆ operator delete() [3/3]

void llvm::User::operator delete ( void *  Usr,
unsigned  ,
unsigned   
)
inline

Placement delete - required by std, called if the ctor throws.

Definition at line 114 of file User.h.

References llvm_unreachable.

◆ operator new() [1/3]

void * llvm::User::operator new ( size_t  Size)
protected

Allocate a User with an operand pointer co-allocated.

This is used for subclasses which need to allocate a variable number of operands, ie, 'hung off uses'.

Definition at line 155 of file User.cpp.

References llvm::Value::HasDescriptor, llvm::Value::HasHungOffUses, llvm::Value::NumUserOperands, and llvm::Check::Size.

◆ operator new() [2/3]

void * llvm::User::operator new ( size_t  Size,
unsigned  Us 
)
protected

Allocate a User with the operands co-allocated.

This is used for subclasses which have a fixed number of operands.

Definition at line 147 of file User.cpp.

References llvm::Check::Size.

◆ operator new() [3/3]

void * llvm::User::operator new ( size_t  Size,
unsigned  Us,
unsigned  DescBytes 
)
protected

Allocate a User with the operands co-allocated.

If DescBytes is non-zero then allocate an additional DescBytes bytes before the operands. These bytes can be accessed by calling getDescriptor.

DescBytes needs to be divisible by sizeof(void *). The allocated descriptor, if any, is aligned to sizeof(void *) bytes.

This is used for subclasses which have a fixed number of operands.

Definition at line 151 of file User.cpp.

References llvm::Check::Size.

◆ OpFrom()

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

Definition at line 127 of file User.h.

References that.

◆ replaceUsesOfWith()

void llvm::User::replaceUsesOfWith ( Value From,
Value To 
)

◆ setGlobalVariableNumOperands()

void llvm::User::setGlobalVariableNumOperands ( unsigned  NumOps)
inline

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.

Definition at line 207 of file User.h.

References assert(), and llvm::Value::NumUserOperands.

Referenced by llvm::GlobalVariable::operator delete(), and llvm::GlobalVariable::setInitializer().

◆ setNumHungOffUseOperands()

void llvm::User::setNumHungOffUseOperands ( unsigned  NumOps)
inline

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.

Definition at line 215 of file User.h.

References assert(), llvm::Value::HasHungOffUses, llvm::Value::NumUserOperands, and llvm::Value::NumUserOperandsBits.

Referenced by llvm::SwitchInst::addCase(), llvm::LandingPadInst::addClause(), llvm::IndirectBrInst::addDestination(), llvm::CatchSwitchInst::addHandler(), llvm::Function::dropAllReferences(), llvm::SwitchInst::removeCase(), llvm::IndirectBrInst::removeDestination(), llvm::CatchSwitchInst::removeHandler(), and llvm::PHINode::removeIncomingValue().

◆ setOperand()

void llvm::User::setOperand ( unsigned  i,
Value Val 
)
inline

◆ value_op_begin() [1/2]

value_op_iterator llvm::User::value_op_begin ( )
inline

◆ value_op_begin() [2/2]

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

Definition at line 281 of file User.h.

References op_begin().

◆ value_op_end() [1/2]

value_op_iterator llvm::User::value_op_end ( )
inline

◆ value_op_end() [2/2]

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

Definition at line 284 of file User.h.

References op_end().

Friends And Related Function Documentation

◆ HungoffOperandTraits

template<unsigned >
friend struct HungoffOperandTraits
friend

Definition at line 46 of file User.h.


The documentation for this class was generated from the following files: