This is an important base class in LLVM. More...
#include "llvm/IR/Constant.h"
Public Member Functions | |
| void | operator= (const Constant &)=delete |
| Constant (const Constant &)=delete | |
| bool | isNullValue () const |
| Return true if this is the value that would be returned by getNullValue. More... | |
| bool | isOneValue () const |
| Returns true if the value is one. More... | |
| bool | isNotOneValue () const |
| Return true if the value is not the one value, or, for vectors, does not contain one value elements. More... | |
| bool | isAllOnesValue () const |
| Return true if this is the value that would be returned by getAllOnesValue. More... | |
| bool | isNegativeZeroValue () const |
| Return true if the value is what would be returned by getZeroValueForNegation. More... | |
| bool | isZeroValue () const |
| Return true if the value is negative zero or null value. More... | |
| bool | isNotMinSignedValue () const |
| Return true if the value is not the smallest signed value, or, for vectors, does not contain smallest signed value elements. More... | |
| bool | isMinSignedValue () const |
| Return true if the value is the smallest signed value. More... | |
| bool | isFiniteNonZeroFP () const |
| Return true if this is a finite and non-zero floating-point scalar constant or a fixed width vector constant with all finite and non-zero elements. More... | |
| bool | isNormalFP () const |
| Return true if this is a normal (as opposed to denormal, infinity, nan, or zero) floating-point scalar constant or a vector constant with all normal elements. More... | |
| bool | hasExactInverseFP () const |
| Return true if this scalar has an exact multiplicative inverse or this vector has an exact multiplicative inverse for each element in the vector. More... | |
| bool | isNaN () const |
| Return true if this is a floating-point NaN constant or a vector floating-point constant with all NaN elements. More... | |
| bool | isElementWiseEqual (Value *Y) const |
| Return true if this constant and a constant 'Y' are element-wise equal. More... | |
| bool | containsUndefOrPoisonElement () const |
| Return true if this is a vector constant that includes any undef or poison elements. More... | |
| bool | containsPoisonElement () const |
| Return true if this is a vector constant that includes any poison elements. More... | |
| bool | containsConstantExpression () const |
| Return true if this is a fixed width vector constant that includes any constant expressions. More... | |
| bool | canTrap () const |
| Return true if evaluation of this constant could trap. More... | |
| bool | isThreadDependent () const |
| Return true if the value can vary between threads. More... | |
| bool | isDLLImportDependent () const |
| Return true if the value is dependent on a dllimport variable. More... | |
| bool | isConstantUsed () const |
| Return true if the constant has users other than constant expressions and other dangling things. More... | |
| bool | needsRelocation () const |
| This method classifies the entry according to whether or not it may generate a relocation entry (either static or dynamic). More... | |
| bool | needsDynamicRelocation () const |
| Constant * | getAggregateElement (unsigned Elt) const |
| For aggregates (struct/array/vector) return the constant that corresponds to the specified element if possible, or null if not. More... | |
| Constant * | getAggregateElement (Constant *Elt) const |
| Constant * | getSplatValue (bool AllowUndefs=false) const |
| If all elements of the vector constant have the same value, return that value. More... | |
| const APInt & | getUniqueInteger () const |
| If C is a constant integer then return its value, otherwise C must be a vector of constant integers, all equal, and the common value is returned. More... | |
| void | destroyConstant () |
| Called if some element of this constant is no longer valid. More... | |
| void | handleOperandChange (Value *, Value *) |
| This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants. More... | |
| void | removeDeadConstantUsers () const |
| If there are any dead constant users dangling off of this constant, remove them. More... | |
| const Constant * | stripPointerCasts () const |
| Constant * | stripPointerCasts () |
 Public Member Functions inherited from llvm::User | |
| 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 Use * | getOperandList () const |
| Use * | getOperandList () |
| Value * | getOperand (unsigned i) const |
| void | setOperand (unsigned i, Value *Val) |
| const Use & | getOperandUse (unsigned i) const |
| Use & | getOperandUse (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_iterator > | operand_values () |
| const_value_op_iterator | value_op_begin () const |
| const_value_op_iterator | value_op_end () const |
| iterator_range< const_value_op_iterator > | operand_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 | |
| Value & | operator= (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... | |
| Type * | getType () const |
| All values are typed, get the type of this value. More... | |
| LLVMContext & | getContext () const |
| All values hold a context through their type. More... | |
| bool | hasName () const |
| ValueName * | getValueName () 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_iterator > | materialized_uses () |
| iterator_range< const_use_iterator > | materialized_uses () const |
| iterator_range< use_iterator > | uses () |
| iterator_range< const_use_iterator > | uses () 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 |
| User * | user_back () |
| const User * | user_back () const |
| iterator_range< user_iterator > | materialized_users () |
| iterator_range< const_user_iterator > | materialized_users () const |
| iterator_range< user_iterator > | users () |
| iterator_range< const_user_iterator > | users () 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... | |
| Use * | getSingleUndroppableUse () |
| Return true if there is exactly one use of this value that cannot be dropped. More... | |
| const Use * | getSingleUndroppableUse () 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 | isSwiftError () const |
| Return true if this value is a swifterror value. More... | |
| const Value * | stripPointerCasts () const |
| Strip off pointer casts, all-zero GEPs and address space casts. More... | |
| Value * | stripPointerCasts () |
| const Value * | stripPointerCastsAndAliases () const |
| Strip off pointer casts, all-zero GEPs, address space casts, and aliases. More... | |
| Value * | stripPointerCastsAndAliases () |
| const Value * | stripPointerCastsSameRepresentation () const |
| Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same. More... | |
| Value * | stripPointerCastsSameRepresentation () |
| const Value * | stripPointerCastsForAliasAnalysis () const |
| Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info. More... | |
| Value * | stripPointerCastsForAliasAnalysis () |
| const Value * | stripInBoundsConstantOffsets () const |
| Strip off pointer casts and all-constant inbounds GEPs. More... | |
| Value * | stripInBoundsConstantOffsets () |
| const Value * | stripAndAccumulateConstantOffsets (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... | |
| Value * | stripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds) |
| const Value * | stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const |
| This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false. More... | |
| Value * | stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) |
| const Value * | stripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const |
| Strip off pointer casts and inbounds GEPs. More... | |
| Value * | stripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) |
| uint64_t | getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) 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 Value * | DoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const |
| Translate PHI node to its predecessor from the given basic block. More... | |
| Value * | DoPHITranslation (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 Constant * | getNullValue (Type *Ty) |
| Constructor to create a '0' constant of arbitrary type. More... | |
| static Constant * | getAllOnesValue (Type *Ty) |
| static Constant * | getIntegerValue (Type *Ty, const APInt &V) |
| Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value. More... | |
| static Constant * | replaceUndefsWith (Constant *C, Constant *Replacement) |
| Try to replace undefined constant C or undefined elements in C with Replacement. More... | |
| static Constant * | mergeUndefsWith (Constant *C, Constant *Other) |
| Merges undefs of a Constant with another Constant, along with the undefs already present. More... | |
| Static Public Member Functions inherited from llvm::User | |
| 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 | |
| Constant (Type *ty, ValueTy vty, Use *Ops, unsigned NumOps) | |
| ~Constant ()=default | |
| Protected Member Functions inherited from llvm::User | |
| 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> | |
| Use & | Op () |
| template<int Idx> | |
| const Use & | Op () 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) |
| MDNode * | getMetadata (unsigned KindID) const |
| Get the current metadata attachments for the given kind, if any. More... | |
| MDNode * | getMetadata (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) |
Additional Inherited Members | |
| Public Types inherited from llvm::User | |
| 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 > |
| Static Public Attributes inherited from llvm::Value | |
| static const unsigned | MaxAlignmentExponent = 29 |
| The maximum alignment for instructions. More... | |
| static const unsigned | MaximumAlignment = 1u << MaxAlignmentExponent |
| Protected Types inherited from llvm::Value | |
| enum | : unsigned { NumUserOperandsBits = 27 } |
| The number of operands in the subclass. More... | |
| Static Protected Member Functions inherited from llvm::User | |
| template<int Idx, typename U > | |
| static Use & | OpFrom (const U *that) |
| 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
This is an important base class in LLVM.
It provides the common facilities of all constant values in an LLVM program. A constant is a value that is immutable at runtime. Functions are constants because their address is immutable. Same with global variables.
All constants share the capabilities provided in this class. All constants can have a null value. They can have an operand list. Constants can be simple (integer and floating point values), complex (arrays and structures), or expression based (computations yielding a constant value composed of only certain operators and other constant values).
Note that Constants are immutable (once created they never change) and are fully shared by structural equivalence. This means that two structurally equivalent constants will always have the same address. Constants are created on demand as needed and never deleted: thus clients don't have to worry about the lifetime of the objects. LLVM Constant Representation
Definition at line 41 of file Constant.h.
Constructor & Destructor Documentation
◆ Constant() [1/2]
Definition at line 43 of file Constant.h.
◆ ~Constant()
|
protecteddefault |
◆ Constant() [2/2]
Member Function Documentation
◆ canTrap()
| bool Constant::canTrap | ( | ) | const |
Return true if evaluation of this constant could trap.
This is true for things like constant expressions that could divide by zero.
Definition at line 599 of file Constants.cpp.
References canTrapImpl().
◆ classof()
Definition at line 167 of file Constant.h.
References llvm::Value::getValueID().
◆ containsConstantExpression()
| bool Constant::containsConstantExpression | ( | ) | const |
Return true if this is a fixed width vector constant that includes any constant expressions.
Definition at line 337 of file Constants.cpp.
References llvm::numbers::e, getType(), and i.
Referenced by llvm::InstCombinerImpl::visitCallInst().
◆ containsPoisonElement()
| bool Constant::containsPoisonElement | ( | ) | const |
Return true if this is a vector constant that includes any poison elements.
Definition at line 332 of file Constants.cpp.
References containsUndefinedElement().
Referenced by llvm::ConstantFoldSelectInstruction().
◆ containsUndefOrPoisonElement()
| bool Constant::containsUndefOrPoisonElement | ( | ) | const |
Return true if this is a vector constant that includes any undef or poison elements.
Since it is impossible to inspect a scalable vector element- wise at compile time, this function returns true only if the entire vector is undef or poison.
Definition at line 327 of file Constants.cpp.
References containsUndefinedElement().
◆ destroyConstant()
| void Constant::destroyConstant | ( | ) |
Called if some element of this constant is no longer valid.
At this point only other constants may be on the use_list for this constant. Any constants on our Use list must also be destroy'd. The implementation must be sure to remove the constant from the list of available cached constants. Implementations should implement destroyConstantImpl to remove constants from any pools/maps they are contained it.
First call destroyConstantImpl on the subclass. This gives the subclass a chance to remove the constant from any maps/pools it's contained in.
Definition at line 455 of file Constants.cpp.
References assert(), llvm::dbgs(), llvm::deleteConstant(), and llvm_unreachable.
Referenced by handleOperandChange(), llvm::MergeBasicBlockIntoOnlyPred(), llvm::BitcodeReaderValueList::resolveConstantForwardRefs(), and llvm::BasicBlock::~BasicBlock().
◆ getAggregateElement() [1/2]
Definition at line 444 of file Constants.cpp.
References assert(), and llvm::Value::getType().
◆ getAggregateElement() [2/2]
| Constant * Constant::getAggregateElement | ( | unsigned | Elt | ) | const |
For aggregates (struct/array/vector) return the constant that corresponds to the specified element if possible, or null if not.
This can return null if the element index is a ConstantExpr, if 'this' is a constant expr or if the constant does not fit into an uint64_t.
Definition at line 421 of file Constants.cpp.
References llvm::User::getNumOperands(), and getType().
Referenced by areInverseVectorBitmasks(), CheckAndCreateOffsetAdd(), checkOffsetSize(), llvm::SelectionDAG::computeKnownBits(), computeKnownBits(), llvm::SelectionDAG::ComputeNumSignBits(), llvm::ConstantFoldExtractElementInstruction(), llvm::ConstantFoldExtractValueInstruction(), llvm::ConstantFoldInsertValueInstruction(), llvm::ConstantFoldLoadThroughBitcast(), llvm::ConstantFoldLoadThroughGEPConstantExpr(), llvm::ConstantFoldLoadThroughGEPIndices(), llvm::extractConstantMask(), llvm::findScalarElement(), foldConstantInsEltIntoShuffle(), foldICmpWithLowBitMaskedVal(), llvm::InstCombinerImpl::foldVectorBinop(), llvm::ConstantExpr::getExactLogBase2(), llvm::InstCombiner::getFlippedStrictnessPredicateAndConstant(), getTargetConstantBitsFromNode(), getUniqueInteger(), isConstantIntVector(), llvm::isKnownNeverInfinity(), llvm::isKnownNeverNaN(), isKnownNonZero(), isZero(), llvm::PatternMatch::cstval_pred_ty< Predicate, ConstantVal >::match(), replaceUndefsWith(), llvm::InstCombinerImpl::SimplifyDemandedVectorElts(), simplifyDivRem(), simplifyNeonTbl1(), SimplifySelectInst(), simplifyX86extrq(), simplifyX86pshufb(), simplifyX86vpermilvar(), simplifyX86vpermv(), and llvm::InstCombinerImpl::visitSRem().
◆ getAllOnesValue()
- Returns
- the value for an integer or vector of integer constant of the given type that has all its bits set to true. Get the all ones value
Definition at line 405 of file Constants.cpp.
References llvm::ConstantInt::get(), llvm::ConstantFP::get(), llvm::APInt::getAllOnesValue(), llvm::APFloat::getAllOnesValue(), llvm::Type::getContext(), llvm::VectorType::getElementCount(), llvm::VectorType::getElementType(), llvm::Type::getFltSemantics(), llvm::Type::getPrimitiveSizeInBits(), llvm::ConstantVector::getSplat(), and llvm::Type::isFloatingPointTy().
Referenced by BitCastConstantVector(), canonicalizeLowbitMask(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldLoadThroughBitcast(), llvm::IRBuilderBase::CreateMaskedGather(), llvm::IRBuilderBase::CreateMaskedScatter(), llvm::BinaryOperator::CreateNot(), DoInitialMatch(), dropRedundantMaskingOfLeftShiftInput(), llvm::InstCombinerImpl::foldICmpBinOp(), foldICmpBitCast(), llvm::InstCombinerImpl::foldICmpEqIntrinsicWithConstant(), llvm::InstCombinerImpl::foldICmpIntrinsicWithConstant(), llvm::InstCombinerImpl::foldICmpShrConstant(), foldICmpWithZextOrSext(), llvm::InstCombinerImpl::foldICmpXorConstant(), llvm::InstCombinerImpl::foldIRemByPowerOfTwoToBitTest(), llvm::X86InstrInfo::foldMemoryOperandImpl(), llvm::ConstantExpr::getBinOpAbsorber(), llvm::ConstantExpr::getBinOpIdentity(), getMaskedTypeForICmpPair(), llvm::ConstantExpr::getNot(), getSign32(), handleOtherCmpSelSimplifications(), LLVMConstAllOnes(), LowerNegateToMultiply(), OptimizeAndOrXor(), SimplifyAddInst(), SimplifyAShrInst(), simplifyBinaryIntrinsic(), llvm::InstCombinerImpl::SimplifyDemandedUseBits(), simplifyLogicOfAddSub(), SimplifyOrInst(), SimplifySDivInst(), SimplifyXorInst(), upgradeMaskedCompare(), upgradeX86vpcom(), llvm::InstCombinerImpl::visitFreeze(), llvm::InstCombinerImpl::visitICmpInst(), llvm::InstCombinerImpl::visitLShr(), visitMaskedMerge(), llvm::InstCombinerImpl::visitOr(), llvm::InstCombinerImpl::visitSDiv(), llvm::InstCombinerImpl::visitShl(), llvm::InstCombinerImpl::visitSub(), llvm::InstCombinerImpl::visitUDiv(), llvm::InstCombinerImpl::visitURem(), and llvm::InstCombinerImpl::visitXor().
◆ getIntegerValue()
Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value.
Definition at line 388 of file Constants.cpp.
References llvm::ConstantInt::get(), llvm::Type::getContext(), llvm::ConstantExpr::getIntToPtr(), llvm::Type::getScalarType(), and llvm::ConstantVector::getSplat().
Referenced by constantFoldUser(), llvm::createIRLevelProfileFlagVar(), llvm::InstCombinerImpl::foldICmpUsingKnownBits(), getConstantVector(), lowerBuildVectorAsBroadcast(), llvm::InstCombinerImpl::SimplifyDemandedUseBits(), llvm::InstCombinerImpl::SimplifyMultipleUseDemandedBits(), simplifyX86pack(), llvm::InstCombinerImpl::visitFreeze(), and llvm::InstCombinerImpl::visitReturnInst().
◆ getNullValue()
Constructor to create a '0' constant of arbitrary type.
Definition at line 347 of file Constants.cpp.
References llvm::Type::ArrayTyID, llvm::APFloatBase::BFloat(), llvm::Type::BFloatTyID, llvm::Type::DoubleTyID, llvm::Type::FixedVectorTyID, llvm::Type::FloatTyID, llvm::Type::FP128TyID, llvm::ConstantInt::get(), llvm::ConstantFP::get(), llvm::ConstantAggregateZero::get(), llvm::ConstantPointerNull::get(), llvm::ConstantTokenNone::get(), llvm::Type::getContext(), llvm::APInt::getNullValue(), llvm::Type::getTypeID(), llvm::APFloat::getZero(), llvm::Type::HalfTyID, llvm::APFloatBase::IEEEdouble(), llvm::APFloatBase::IEEEhalf(), llvm::APFloatBase::IEEEquad(), llvm::APFloatBase::IEEEsingle(), llvm::Type::IntegerTyID, llvm_unreachable, llvm::Type::PointerTyID, llvm::Type::PPC_FP128TyID, llvm::APFloatBase::PPCDoubleDouble(), llvm::Type::ScalableVectorTyID, llvm::Type::StructTyID, llvm::Type::TokenTyID, llvm::Type::X86_FP80TyID, and llvm::APFloatBase::x87DoubleExtended().
Referenced by addAssumeNonNull(), appendToGlobalArray(), ApplyX86MaskOn1BitsVec(), BitCastConstantVector(), BreakUpSubtract(), CleanupConstantGlobalUsers(), combineTargetShuffle(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldCompareInstOperands(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldGetElementPtr(), llvm::ConstantFoldLoadFromConstPtr(), llvm::ConstantFoldLoadThroughBitcast(), convertImplicitDefToConstZero(), llvm::ShuffleVectorInst::convertShuffleMaskForBitcode(), llvm::SanitizerStatReport::create(), llvm::FixedPointBuilder< IRBuilderTy >::CreateFloatingToFixed(), llvm::IRBuilderBase::CreateIsNotNull(), llvm::IRBuilderBase::CreateIsNull(), llvm::OpenMPIRBuilder::createParallel(), llvm::FixedPointBuilder< IRBuilderTy >::CreateSub(), despeculateCountZeros(), llvm::EmitGEPOffset(), llvm::OpenMPIRBuilder::emitTaskyieldImpl(), evaluateICmpRelation(), llvm::SCEVExpander::expandUnionPredicate(), ExtractConstantBytes(), llvm::SanitizerStatReport::finish(), FoldBitCast(), llvm::InstCombinerImpl::foldGEPICmp(), llvm::InstCombinerImpl::foldICmpAndConstant(), llvm::InstCombinerImpl::foldICmpAndConstConst(), llvm::InstCombinerImpl::foldICmpBinOp(), llvm::InstCombinerImpl::foldICmpBinOpEqualityWithConstant(), foldICmpBitCast(), llvm::InstCombinerImpl::foldICmpEqIntrinsicWithConstant(), llvm::InstCombinerImpl::foldICmpEquality(), llvm::InstCombinerImpl::foldICmpInstWithConstantNotInt(), llvm::InstCombinerImpl::foldICmpIntrinsicWithConstant(), llvm::InstCombinerImpl::foldICmpMulConstant(), llvm::InstCombinerImpl::foldICmpOrConstant(), llvm::InstCombinerImpl::foldICmpShlConstant(), llvm::InstCombinerImpl::foldICmpShlConstConst(), llvm::InstCombinerImpl::foldICmpShrConstant(), llvm::InstCombinerImpl::foldICmpShrConstConst(), llvm::InstCombinerImpl::foldICmpSRemConstant(), llvm::InstCombinerImpl::foldICmpUsingKnownBits(), foldICmpWithHighBitMask(), foldICmpWithZextOrSext(), foldICmpXNegX(), llvm::InstCombinerImpl::foldICmpXorConstant(), foldLogOpOfMaskedICmps(), llvm::X86InstrInfo::foldMemoryOperandImpl(), foldSetClearBits(), foldShiftedShift(), foldShiftIntoShiftInAnotherHandOfAndInICmp(), llvm::InstCombinerImpl::foldSignBitTest(), llvm::ConstantExpr::getAlignOf(), getAsConstantIndexedAddress(), llvm::ConstantExpr::getBinOpAbsorber(), llvm::ConstantExpr::getBinOpIdentity(), llvm::ConstantExpr::getExactLogBase2(), getFoldedSizeOfImpl(), getKnownSign(), getNegativeIsTrueBoolVec(), llvm::ConstantExpr::getOffsetOf(), llvm::OpenMPIRBuilder::getOrCreateIdent(), llvm::InstCombiner::getSafeVectorConstantForBinop(), llvm::ConstantAggregateZero::getSequentialElement(), getSign32(), llvm::ConstantExpr::getSizeOf(), llvm::ScalarEvolution::getSizeOfScalableVectorExpr(), getSplatValue(), getStrlenWithNull(), llvm::ConstantAggregateZero::getStructElement(), llvm::ConstantFP::getZeroValueForNegation(), INITIALIZE_PASS(), llvm::GCNTTIImpl::instCombineIntrinsic(), llvm::isBytewiseValue(), LLVMBuildCatchSwitch(), LLVMBuildCleanupPad(), LLVMConstNull(), llvm::NVPTXTargetLowering::LowerFormalArguments(), llvm::IntrinsicLowering::LowerIntrinsicCall(), LowerNegateToMultiply(), LowerToTLSExecModel(), OptimizeAndOrXor(), OptimizeEmptyGlobalCXXDtors(), optimizeIntegerToVectorInsertions(), optimizeMemCmpConstantSize(), optimizeVectorResizeWithIntegerBitCasts(), PerformHeapAllocSRoA(), RewriteHeapSROALoadUser(), runPass(), SimplifyAddInst(), simplifyAllocaArraySize(), SimplifyAndInst(), llvm::InstCombinerImpl::SimplifyAnyMemSet(), llvm::InstCombinerImpl::SimplifyAnyMemTransfer(), simplifyBinaryIntrinsic(), llvm::X86TTIImpl::simplifyDemandedUseBitsIntrinsic(), simplifyDiv(), simplifyDivRem(), SimplifyFAddInst(), SimplifyFDivInst(), SimplifyFMAFMul(), SimplifyFRemInst(), SimplifyFSubInst(), SimplifyICmpInst(), simplifyICmpWithBinOp(), simplifyLogicOfAddSub(), SimplifyMulInst(), simplifyNeonTbl1(), simplifyRem(), SimplifyRightShift(), SimplifyShift(), SimplifyShlInst(), SimplifySRemInst(), SimplifySubInst(), simplifyX86MaskedLoad(), simplifyX86movmsk(), simplifyX86pshufb(), simplifyX86varShift(), SimplifyXorInst(), SRAGlobal(), llvm::UpgradeGlobalVariable(), upgradeMaskedCompare(), llvm::UpgradeTBAANode(), UpgradeX86ALIGNIntrinsics(), UpgradeX86PSLLDQIntrinsics(), UpgradeX86PSRLDQIntrinsics(), upgradeX86vpcom(), llvm::InstCombinerImpl::visitAnd(), llvm::InstCombinerImpl::visitBitCast(), llvm::InstCombinerImpl::visitFCmpInst(), llvm::InstCombinerImpl::visitFreeze(), llvm::InstCombinerImpl::visitGetElementPtrInst(), llvm::InstCombinerImpl::visitICmpInst(), llvm::InstCombinerImpl::visitLandingPadInst(), llvm::InstCombinerImpl::visitLoadInst(), llvm::InstCombinerImpl::visitShl(), llvm::InstCombinerImpl::visitSub(), llvm::InstCombinerImpl::visitTrunc(), llvm::InstCombinerImpl::visitURem(), llvm::InstCombinerImpl::visitXor(), and llvm::Evaluator::~Evaluator().
◆ getSplatValue()
If all elements of the vector constant have the same value, return that value.
Otherwise, return nullptr. Ignore undefined elements by setting AllowUndefs to true.
Definition at line 1666 of file Constants.cpp.
References llvm::all_of(), assert(), getNullValue(), llvm::User::getOperand(), llvm::Value::getType(), I, Index, and llvm::BitmaskEnumDetail::Mask().
Referenced by BitCastConstantVector(), llvm::SelectionDAG::computeKnownBits(), computeKnownBitsFromOperator(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldUnaryInstruction(), foldVectorCmp(), getUniqueInteger(), isAllOnesValue(), isMinSignedValue(), and isOneValue().
◆ getUniqueInteger()
If C is a constant integer then return its value, otherwise C must be a vector of constant integers, all equal, and the common value is returned.
Definition at line 1725 of file Constants.cpp.
References assert(), getAggregateElement(), and getSplatValue().
Referenced by foldShiftIntoShiftInAnotherHandOfAndInICmp().
◆ handleOperandChange()
This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants.
Update this constant array to change uses of 'From' to be uses of 'To'.
Basically this method goes through the trouble of building a new constant that is equivalent to the current one, with all uses of From replaced with uses of To. After this construction is completed, all of the users of 'this' are replaced to use the new constant, and then 'this' is deleted. In general, you should not call this method, instead, use Value::replaceAllUsesWith, which automatically dispatches to this method as needed.
This must update the uniquing data structures etc.
Note that we intentionally replace all uses of From with To here. Consider a large array that uses 'From' 1000 times. By handling this case all here, ConstantArray::handleOperandChange is only invoked once, and that single invocation handles all 1000 uses. Handling them one at a time would work, but would be really slow because it would have to unique each updated array instance.
Definition at line 3288 of file Constants.cpp.
References assert(), destroyConstant(), llvm::Value::getValueID(), llvm_unreachable, and llvm::Value::replaceAllUsesWith().
◆ hasExactInverseFP()
| bool Constant::hasExactInverseFP | ( | ) | const |
Return true if this scalar has an exact multiplicative inverse or this vector has an exact multiplicative inverse for each element in the vector.
Definition at line 255 of file Constants.cpp.
References llvm::numbers::e, getType(), and i.
◆ isAllOnesValue()
| bool Constant::isAllOnesValue | ( | ) | const |
Return true if this is the value that would be returned by getAllOnesValue.
Definition at line 101 of file Constants.cpp.
References getSplatValue().
Referenced by BitCastConstantVector(), llvm::InstCombinerImpl::foldICmpBinOpEqualityWithConstant(), llvm::InstCombinerImpl::foldICmpSelectConstant(), and llvm::InstCombinerImpl::SimplifyDemandedVectorElts().
◆ isConstantUsed()
| bool Constant::isConstantUsed | ( | ) | const |
Return true if the constant has users other than constant expressions and other dangling things.
Definition at line 643 of file Constants.cpp.
References isConstantUsed(), and users.
Referenced by findPartitions(), and isConstantUsed().
◆ isDLLImportDependent()
| bool Constant::isDLLImportDependent | ( | ) | const |
Return true if the value is dependent on a dllimport variable.
Definition at line 636 of file Constants.cpp.
References ConstHasGlobalValuePredicate().
◆ isElementWiseEqual()
| bool Constant::isElementWiseEqual | ( | Value * | Y | ) | const |
Return true if this constant and a constant 'Y' are element-wise equal.
This is identical to just comparing the pointers, with the exception that for vectors, if only one of the constants has an undef element in some lane, the constants still match.
Definition at line 283 of file Constants.cpp.
References C1, llvm::ConstantExpr::getBitCast(), llvm::ConstantExpr::getICmp(), llvm::VectorType::getInteger(), getType(), llvm::CmpInst::ICMP_EQ, llvm::PatternMatch::m_One(), llvm::PatternMatch::match(), and Y.
Referenced by llvm::InstCombinerImpl::visitSExt().
◆ isFiniteNonZeroFP()
| bool Constant::isFiniteNonZeroFP | ( | ) | const |
Return true if this is a finite and non-zero floating-point scalar constant or a fixed width vector constant with all finite and non-zero elements.
Definition at line 227 of file Constants.cpp.
References llvm::numbers::e, getType(), and i.
◆ isMinSignedValue()
| bool Constant::isMinSignedValue | ( | ) | const |
Return true if the value is the smallest signed value.
Definition at line 177 of file Constants.cpp.
References getSplatValue().
◆ isNaN()
| bool Constant::isNaN | ( | ) | const |
Return true if this is a floating-point NaN constant or a vector floating-point constant with all NaN elements.
Definition at line 269 of file Constants.cpp.
References llvm::numbers::e, getType(), and i.
◆ isNegativeZeroValue()
| bool Constant::isNegativeZeroValue | ( | ) | const |
Return true if the value is what would be returned by getZeroValueForNegation.
Definition at line 40 of file Constants.cpp.
References getType().
◆ isNormalFP()
| bool Constant::isNormalFP | ( | ) | const |
Return true if this is a normal (as opposed to denormal, infinity, nan, or zero) floating-point scalar constant or a vector constant with all normal elements.
See APFloat::isNormal.
Definition at line 241 of file Constants.cpp.
References llvm::numbers::e, getType(), and i.
Referenced by foldFDivConstantDividend(), and llvm::InstCombinerImpl::visitFMul().
◆ isNotMinSignedValue()
| bool Constant::isNotMinSignedValue | ( | ) | const |
Return true if the value is not the smallest signed value, or, for vectors, does not contain smallest signed value elements.
Definition at line 203 of file Constants.cpp.
References getType(), i, and isNotMinSignedValue().
Referenced by isNotMinSignedValue(), and llvm::InstCombinerImpl::visitMul().
◆ isNotOneValue()
| bool Constant::isNotOneValue | ( | ) | const |
Return true if the value is not the one value, or, for vectors, does not contain one value elements.
Definition at line 153 of file Constants.cpp.
References getType(), i, and isNotOneValue().
Referenced by isNotOneValue().
◆ isNullValue()
| bool Constant::isNullValue | ( | ) | const |
Return true if this is the value that would be returned by getNullValue.
Definition at line 86 of file Constants.cpp.
Referenced by addConditions(), addTryBlockMapEntry(), annotateAnyAllocSite(), llvm::ScalarEvolution::applyLoopGuards(), BitCastConstantVector(), calculateSEHStateNumbers(), llvm::FunctionComparator::cmpConstants(), computePointerICmp(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldCompareInstOperands(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldGetElementPtr(), eliminateNoopStore(), llvm::Evaluator::EvaluateBlock(), ExtractConstantBytes(), llvm::InstCombinerImpl::foldICmpInstWithConstantNotInt(), llvm::InstCombinerImpl::foldOpIntoPhi(), foldShiftIntoShiftInAnotherHandOfAndInICmp(), llvm::ConstantStruct::get(), llvm::getConstantDataArrayInfo(), getPredicateResult(), llvm::ConstantVector::getSplat(), llvm::GCNTTIImpl::instCombineIntrinsic(), isCatchAll(), isKnownNonZero(), llvm::AsmPrinter::lowerConstant(), optimizeOnceStoredGlobal(), parseGlobalCtors(), llvm::InstCombinerImpl::SimplifyDemandedVectorElts(), simplifyDivRem(), llvm::ScalarEvolution::SimplifyICmpOperands(), SwitchToLookupTable(), and TryToShrinkGlobalToBoolean().
◆ isOneValue()
| bool Constant::isOneValue | ( | ) | const |
Returns true if the value is one.
Definition at line 127 of file Constants.cpp.
References getSplatValue().
◆ isThreadDependent()
| bool Constant::isThreadDependent | ( | ) | const |
Return true if the value can vary between threads.
Definition at line 629 of file Constants.cpp.
References ConstHasGlobalValuePredicate().
◆ isZeroValue()
| bool Constant::isZeroValue | ( | ) | const |
Return true if the value is negative zero or null value.
Definition at line 66 of file Constants.cpp.
Referenced by computeKnownBitsFromOperator(), and shouldConvertImpl().
◆ mergeUndefsWith()
Merges undefs of a Constant with another Constant, along with the undefs already present.
Other doesn't have to be the same type as C, but both must either be scalars or vectors with the same element count. If no changes are made, the constant C is returned.
Definition at line 780 of file Constants.cpp.
References assert(), llvm::ConstantVector::get(), llvm::UndefValue::get(), I, llvm::PatternMatch::m_Undef(), llvm::PatternMatch::match(), and Other.
Referenced by matchFunnelShift(), llvm::InstCombinerImpl::visitAnd(), llvm::InstCombinerImpl::visitSExt(), and llvm::InstCombinerImpl::visitTrunc().
◆ needsDynamicRelocation()
| bool Constant::needsDynamicRelocation | ( | ) | const |
Definition at line 655 of file Constants.cpp.
◆ needsRelocation()
| bool Constant::needsRelocation | ( | ) | const |
This method classifies the entry according to whether or not it may generate a relocation entry (either static or dynamic).
This must be conservative, so if it might codegen to a relocatable entry, it should say so.
FIXME: This really should not be in IR.
Definition at line 659 of file Constants.cpp.
◆ operator=()
◆ removeDeadConstantUsers()
| void Constant::removeDeadConstantUsers | ( | ) | const |
If there are any dead constant users dangling off of this constant, remove them.
This method is useful for clients that want to check to see if a global is unused, but don't want to deal with potentially dead constants hanging off of the globals.
Definition at line 729 of file Constants.cpp.
References E, I, and removeDeadUsersOfConstant().
Referenced by deleteIfDead(), llvm::CallGraphUpdater::finalize(), hasAddressTakenAndUsed(), mergeConstants(), llvm::CallGraphUpdater::replaceFunctionWith(), and llvm::GlobalValue::~GlobalValue().
◆ replaceUndefsWith()
Try to replace undefined constant C or undefined elements in C with Replacement.
If no changes are made, the constant C is returned.
Definition at line 756 of file Constants.cpp.
References assert(), llvm::ConstantVector::get(), getAggregateElement(), llvm::Value::getType(), i, llvm::PatternMatch::m_Undef(), and llvm::PatternMatch::match().
Referenced by dropRedundantMaskingOfLeftShiftInput(), foldICmpWithLowBitMaskedVal(), llvm::InstCombiner::getFlippedStrictnessPredicateAndConstant(), llvm::InstCombinerImpl::visitAnd(), visitMaskedMerge(), and llvm::InstCombinerImpl::visitXor().
◆ stripPointerCasts() [1/2]
|
inline |
Definition at line 205 of file Constant.h.
References stripPointerCasts().
◆ stripPointerCasts() [2/2]
Definition at line 201 of file Constant.h.
References llvm::Value::stripPointerCasts().
Referenced by addTryBlockMapEntry(), llvm::ARMAsmPrinter::emitXXStructor(), llvm::Evaluator::EvaluateBlock(), hasUsesToReplace(), llvm::InlineFunction(), OptimizeGlobalAliases(), stripPointerCasts(), llvm::tryPromoteCall(), and llvm::InstCombinerImpl::visitLandingPadInst().
The documentation for this class was generated from the following files:
- include/llvm/IR/Constant.h
- lib/IR/Constants.cpp
