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 | 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. 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 vector constant with all finite and non-zero elements. More... | |
| bool | isNormalFP () const |
| Return true if this is a normal (as opposed to denormal) 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 | containsUndefElement () const |
| Return true if this is a vector constant that includes any undefined elements. 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. More... | |
| 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 () const |
| If this is a splat vector constant, meaning that all of the elements 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, bool) |
| 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... | |
| 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... | |
| 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 | 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 user of this value. More... | |
| bool | hasNUses (unsigned N) const |
| Return true if this Value has exactly N users. More... | |
| bool | hasNUsesOrMore (unsigned N) const |
| Return true if this value has N users or more. 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 aliases. More... | |
| Value * | stripPointerCasts () |
| const Value * | stripPointerCastsAndInvariantGroups () const |
| Strip off pointer casts, all-zero GEPs, aliases and invariant group info. More... | |
| Value * | stripPointerCastsAndInvariantGroups () |
| const Value * | stripPointerCastsNoFollowAliases () const |
| Strip off pointer casts and all-zero GEPs. More... | |
| Value * | stripPointerCastsNoFollowAliases () |
| const Value * | stripInBoundsConstantOffsets () const |
| Strip off pointer casts and all-constant inbounds GEPs. More... | |
| Value * | stripInBoundsConstantOffsets () |
| const Value * | stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const |
| Accumulate offsets from stripInBoundsConstantOffsets(). More... | |
| Value * | stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) |
| const Value * | stripInBoundsOffsets () const |
| Strip off pointer casts and inbounds GEPs. More... | |
| Value * | stripInBoundsOffsets () |
| uint64_t | getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const |
| Returns the number of bytes known to be dereferenceable for the pointer value. More... | |
| unsigned | 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 Public Member Functions inherited from llvm::User | |
| static bool | classof (const Value *V) |
Protected Member Functions | |
| Constant (Type *ty, ValueTy vty, Use *Ops, unsigned NumOps) | |
| 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... | |
| unsigned short | getSubclassDataFromValue () const |
| void | setValueSubclassData (unsigned short D) |
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 = 28 } |
| 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 | 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 42 of file Constant.h.
Constructor & Destructor Documentation
◆ Constant() [1/2]
Definition at line 44 of file Constant.h.
References canTrap(), containsUndefElement(), destroyConstant(), getAggregateElement(), getSplatValue(), getUniqueInteger(), hasExactInverseFP(), isAllOnesValue(), isConstantUsed(), isDLLImportDependent(), isFiniteNonZeroFP(), isMinSignedValue(), isNaN(), isNegativeZeroValue(), isNormalFP(), isNotMinSignedValue(), isNullValue(), isOneValue(), isThreadDependent(), isZeroValue(), needsRelocation(), and operator=().
Referenced by llvm::BlockAddress::get().
◆ 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 433 of file Constants.cpp.
References canTrapImpl().
Referenced by Constant(), and SplitCriticalSideEffectEdges().
◆ classof()
Definition at line 140 of file Constant.h.
References getAllOnesValue(), getIntegerValue(), getNullValue(), llvm::Value::getValueID(), handleOperandChange(), and removeDeadConstantUsers().
◆ containsUndefElement()
| bool Constant::containsUndefElement | ( | ) | const |
Return true if this is a vector constant that includes any undefined elements.
Definition at line 254 of file Constants.cpp.
References getAggregateElement(), and llvm::Value::getType().
Referenced by Constant(), foldSelectShuffle(), and foldSelectShuffleWith1Binop().
◆ 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 362 of file Constants.cpp.
References assert(), llvm::dbgs(), llvm::Value::getValueID(), llvm_unreachable, llvm::Value::use_empty(), and llvm::Value::user_back().
Referenced by Constant(), eliminateAvailableExternally(), handleOperandChange(), llvm::MergeBasicBlockIntoOnlyPred(), RemoveDeadConstant(), removeDeadUsersOfConstant(), replaceConstantExprOp(), llvm::BitcodeReaderValueList::resolveConstantForwardRefs(), llvm::GlobalDCEPass::run(), and llvm::BasicBlock::~BasicBlock().
◆ getAggregateElement() [1/2]
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 335 of file Constants.cpp.
Referenced by areInverseVectorBitmasks(), BatchCommitValueTo(), llvm::canConstantFoldCallTo(), canNarrowShiftAmt(), canonicalizeCmpWithConstant(), canonicalizeSaturatedSubtract(), computeKnownBits(), computeUnsignedMinMaxValuesFromKnownBits(), Constant(), llvm::ConstantFoldExtractElementInstruction(), llvm::ConstantFoldExtractValueInstruction(), llvm::ConstantFoldInsertValueInstruction(), llvm::ConstantFoldLoadThroughBitcast(), llvm::ConstantFoldLoadThroughGEPConstantExpr(), llvm::ConstantFoldLoadThroughGEPIndices(), containsUndefElement(), EvaluateStoreInto(), llvm::extractConstantMask(), llvm::findScalarElement(), foldConstantInsEltIntoShuffle(), foldIdentityExtractShuffle(), getAggregateElement(), getArrayElements(), getBinOpsForFactorization(), getLogBase2(), llvm::ShuffleVectorInst::getMaskValue(), llvm::getSafeVectorConstantForBinop(), llvm::ShuffleVectorInst::getShuffleMask(), getTargetConstantBitsFromNode(), getUniqueInteger(), hasExactInverseFP(), instrumentMaskedLoadOrStore(), isConstantIntVector(), isFiniteNonZeroFP(), isNaN(), isNormalFP(), isNotMinSignedValue(), isUndefShift(), isZero(), scalarConstantToHexString(), shouldMergeGEPs(), ShrinkDemandedConstant(), simplifyDivRem(), simplifyX86extrq(), simplifyX86pshufb(), simplifyX86vpermilvar(), simplifyX86vpermv(), TypeSizeToSizeIndex(), llvm::InstCombiner::visitSRem(), wrapConstantAsMetadata(), and WriteConstantInternal().
◆ getAggregateElement() [2/2]
Definition at line 351 of file Constants.cpp.
References assert(), getAggregateElement(), and llvm::Value::getType().
◆ 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 319 of file Constants.cpp.
References llvm::ConstantInt::get(), llvm::ConstantFP::get(), llvm::APInt::getAllOnesValue(), llvm::APFloat::getAllOnesValue(), llvm::Type::getContext(), llvm::Type::getPrimitiveSizeInBits(), llvm::ConstantVector::getSplat(), llvm::Type::isFloatingPointTy(), and llvm::Type::isPPC_FP128Ty().
Referenced by BitCastConstantVector(), llvm::canConstantFoldCallTo(), canonicalizeLowbitMask(), classof(), computeValueLLTs(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCompareInstruction(), createAndInstr(), llvm::IRBuilderBase::CreateMaskedGather(), llvm::IRBuilderBase::CreateMaskedScatter(), llvm::BinaryOperator::CreateNot(), DoInitialMatch(), EqualityPropUnSafe(), foldICmpShlOne(), foldICmpWithMinMax(), foldICmpWithTruncSignExtendedVal(), llvm::X86InstrInfo::foldMemoryOperandImpl(), foldXorToXor(), llvm::ConstantExpr::getBinOpAbsorber(), llvm::ConstantExpr::getBinOpIdentity(), getMaskedTypeForICmpPair(), llvm::ScalarEvolution::getNegativeSCEV(), llvm::ConstantExpr::getNot(), llvm::ScalarEvolution::getNotSCEV(), LLVMConstAllOnes(), LowerNegateToMultiply(), OptimizeAndOrXor(), processUGT_ADDCST_ADD(), SimplifyAddInst(), SimplifyAShrInst(), simplifyBinaryIntrinsic(), SimplifyOrInst(), SimplifySDivInst(), simplifyX86round(), SimplifyXorInst(), ThreadCmpOverSelect(), TypeSizeToSizeIndex(), upgradeMaskedCompare(), llvm::sroa::AllocaSliceRewriter::visit(), llvm::InstCombiner::visitCallInst(), llvm::InstCombiner::visitICmpInst(), llvm::InstCombiner::visitLShr(), llvm::InstCombiner::visitShl(), llvm::InstCombiner::visitUDiv(), llvm::InstCombiner::visitURem(), and llvm::InstCombiner::visitZExt().
◆ getIntegerValue()
Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value.
Definition at line 302 of file Constants.cpp.
References C, llvm::ConstantInt::get(), llvm::Type::getContext(), llvm::ConstantExpr::getIntToPtr(), llvm::Type::getScalarType(), and llvm::ConstantVector::getSplat().
Referenced by classof(), constantFoldUser(), createIRLevelProfileFlagVariable(), getConstantVector(), lowerBuildVectorAsBroadcast(), llvm::InstCombiner::replacedSelectWithOperand(), ShrinkDemandedConstant(), simplifyX86movmsk(), and llvm::InstCombiner::visitReturnInst().
◆ getNullValue()
Constructor to create a '0' constant of arbitrary type.
Definition at line 265 of file Constants.cpp.
References llvm::lltok::APFloat, llvm::Type::ArrayTyID, llvm::Type::DoubleTyID, 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::StructTyID, llvm::Type::TokenTyID, llvm::Type::VectorTyID, llvm::Type::X86_FP80TyID, and llvm::APFloatBase::x87DoubleExtended().
Referenced by addAssumeNonNull(), alwaysAvailable(), appendToGlobalArray(), ApplyX86MaskOn1BitsVec(), atomicSizeSupported(), BitCastConstantVector(), BreakUpSubtract(), llvm::canConstantFoldCallTo(), canonicalizeSaturatedSubtract(), canTransformToMemCmp(), classof(), CleanupConstantGlobalUsers(), collectFunctionUsers(), computeValueLLTs(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldCompareInstOperands(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldExtractElementInstruction(), llvm::ConstantFoldGetElementPtr(), llvm::ConstantFoldLoadFromConstPtr(), ConvertImplicitDefToConstZero(), llvm::SanitizerStatReport::create(), createAndInstr(), llvm::createHWAddressSanitizerPass(), llvm::IRBuilder< TargetFolder >::CreateIsNotNull(), llvm::IRBuilder< TargetFolder >::CreateIsNull(), llvm::createObjCARCOptPass(), llvm::createSeparateConstOffsetFromGEPPass(), llvm::createShadowStackGCLoweringPass(), despeculateCountZeros(), eliminateUnreachableBlock(), llvm::EmitGEPOffset(), EqualityPropUnSafe(), evaluateICmpRelation(), llvm::SCEVExpander::expandUnionPredicate(), ExtractConstantBytes(), findInitTrampoline(), llvm::CodeExtractor::findInputsOutputs(), llvm::SanitizerStatReport::finish(), FoldBitCast(), foldICmpShlOne(), foldICmpWithHighBitMask(), foldICmpWithMinMax(), foldICmpWithTruncSignExtendedVal(), foldLogOpOfMaskedICmps(), llvm::X86InstrInfo::foldMemoryOperandImpl(), foldShiftedShift(), foldXorToXor(), FunctionNumber(), llvm::ConstantExpr::getAlignOf(), getAsConstantIndexedAddress(), getBaseType(), llvm::ConstantExpr::getBinOpAbsorber(), llvm::ConstantExpr::getBinOpIdentity(), getFoldedSizeOf(), getNegativeIsTrueBoolVec(), llvm::ConstantExpr::getOffsetOf(), llvm::FastISel::getRegForValue(), llvm::getSafeVectorConstantForBinop(), llvm::ConstantAggregateZero::getSequentialElement(), llvm::ConstantExpr::getSizeOf(), getSplatValue(), llvm::ConstantAggregateZero::getStructElement(), llvm::ConstantFP::getZeroValueForNegation(), INITIALIZE_PASS(), insertSinCosCall(), instrumentMaskedLoadOrStore(), llvm::isBytewiseValue(), isCallPromotable(), IsNonLocalValue(), LLVMBuildCatchSwitch(), LLVMBuildCleanupPad(), LLVMConstNull(), llvm::NVPTXTargetLowering::LowerFormalArguments(), llvm::IntrinsicLowering::LowerIntrinsicCall(), LowerNegateToMultiply(), LowerToTLSExecModel(), moveUp(), needsRuntimeRegistrationOfSectionRange(), OptimizeAndOrXor(), OptimizeEmptyGlobalCXXDtors(), optimizeIntegerToVectorInsertions(), optimizeVectorResize(), patchAndReplaceAllUsesWith(), PerformHeapAllocSRoA(), PickMostRelevantLoop(), processUGT_ADDCST_ADD(), readWideAPInt(), llvm::InstCombiner::replacedSelectWithOperand(), reportLoadElim(), reportMayClobberedLoad(), RetagMask(), RewriteHeapSROALoadUser(), llvm::WholeProgramDevirtPass::run(), shouldInstrumentBlock(), shouldKeepInEntry(), ShrinkDemandedConstant(), SimplifyAddInst(), simplifyAllocaArraySize(), SimplifyAndInst(), simplifyBinaryIntrinsic(), simplifyDiv(), simplifyDivRem(), SimplifyFAddInst(), SimplifyFDivInst(), SimplifyFMulInst(), SimplifyFRemInst(), SimplifyFSubInst(), SimplifyGEPInst(), SimplifyICmpInst(), simplifyICmpWithBinOp(), SimplifyMulInst(), simplifyNeonTbl1(), simplifyRem(), SimplifyRightShift(), SimplifyShift(), SimplifyShlInst(), SimplifySRemInst(), SimplifySubInst(), simplifyX86MaskedLoad(), simplifyX86movmsk(), simplifyX86pshufb(), simplifyX86round(), simplifyX86varShift(), SimplifyXorInst(), SRAGlobal(), StackMallocSizeClass(), transformToIndexedCompare(), TypeSizeToSizeIndex(), upgradeAbs(), upgradeMaskedCompare(), llvm::UpgradeTBAANode(), UpgradeX86ALIGNIntrinsics(), UpgradeX86PSLLDQIntrinsics(), UpgradeX86PSRLDQIntrinsics(), llvm::InstCombiner::visitAnd(), llvm::InstCombiner::visitBitCast(), llvm::InstCombiner::visitCallInst(), llvm::InstCombiner::visitFCmpInst(), llvm::InstCombiner::visitGetElementPtrInst(), llvm::InstCombiner::visitICmpInst(), llvm::InstCombiner::visitLandingPadInst(), llvm::InstCombiner::visitLoadInst(), llvm::InstCombiner::visitSub(), llvm::InstCombiner::visitTrunc(), llvm::InstCombiner::visitURem(), llvm::InstCombiner::visitXor(), llvm::InstCombiner::visitZExt(), wrapConstantAsMetadata(), X86ChooseCmpImmediateOpcode(), and llvm::Evaluator::~Evaluator().
◆ getSplatValue()
| Constant * Constant::getSplatValue | ( | ) | const |
If this is a splat vector constant, meaning that all of the elements have the same value, return that value.
Otherwise return 0.
Definition at line 1368 of file Constants.cpp.
References assert(), getNullValue(), and llvm::Value::getType().
Referenced by computeKnownBitsFromOperator(), Constant(), foldICmpShlOne(), llvm::ConstantVector::getType(), getUniqueInteger(), llvm::CompositeType::indexValid(), 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 1389 of file Constants.cpp.
References assert(), C, getAggregateElement(), and getSplatValue().
Referenced by Constant().
◆ 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 2817 of file Constants.cpp.
References llvm::LLVMContextImpl::ArrayConstants, assert(), C, destroyConstant(), E, llvm::LLVMContextImpl::ExprConstants, llvm::ConstantAggregateZero::get(), llvm::UndefValue::get(), llvm::Value::getContext(), getImpl(), llvm::User::getNumOperands(), llvm::User::getOperand(), llvm::User::getOperandList(), llvm::Value::getType(), llvm::Value::getValueID(), isNullValue(), llvm_unreachable, llvm::RISCVFenceField::O, llvm::User::Op(), llvm::LLVMContext::pImpl, llvm::SmallVectorTemplateBase< T >::push_back(), llvm::Value::replaceAllUsesWith(), llvm::ConstantUniqueMap< ConstantClass >::replaceOperandsInPlace(), llvm::SmallVectorImpl< T >::reserve(), llvm::LLVMContextImpl::StructConstants, and llvm::LLVMContextImpl::VectorConstants.
Referenced by classof(), and isDirectCall().
◆ 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 228 of file Constants.cpp.
References getAggregateElement(), and llvm::Value::getType().
Referenced by Constant(), and foldFDivConstantDivisor().
◆ isAllOnesValue()
| bool Constant::isAllOnesValue | ( | ) | const |
Return true if this is the value that would be returned by getAllOnesValue.
Definition at line 100 of file Constants.cpp.
References getSplatValue().
Referenced by BitCastConstantVector(), Constant(), ConstantFold(), llvm::ConstantFoldSelectInstruction(), foldICmpShlOne(), isICmpTrue(), and TypeSizeToSizeIndex().
◆ isConstantUsed()
| bool Constant::isConstantUsed | ( | ) | const |
Return true if the constant has users other than constant expressions and other dangling things.
Definition at line 477 of file Constants.cpp.
References llvm::dyn_cast(), isConstantUsed(), and llvm::Value::users().
Referenced by Constant(), findPartitions(), and isConstantUsed().
◆ isDLLImportDependent()
| bool Constant::isDLLImportDependent | ( | ) | const |
Return true if the value is dependent on a dllimport variable.
Definition at line 470 of file Constants.cpp.
References ConstHasGlobalValuePredicate().
Referenced by Constant(), and ValidLookupTableConstant().
◆ isFiniteNonZeroFP()
| bool Constant::isFiniteNonZeroFP | ( | ) | const |
Return true if this is a finite and non-zero floating-point scalar constant or a vector constant with all finite and non-zero elements.
Definition at line 202 of file Constants.cpp.
References getAggregateElement(), and llvm::Value::getType().
Referenced by Constant(), and llvm::InstCombiner::visitFMul().
◆ isMinSignedValue()
| bool Constant::isMinSignedValue | ( | ) | const |
Return true if the value is the smallest signed value.
Definition at line 152 of file Constants.cpp.
References getSplatValue().
Referenced by Constant().
◆ 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 241 of file Constants.cpp.
References getAggregateElement(), and llvm::Value::getType().
Referenced by Constant(), and propagateNaN().
◆ isNegativeZeroValue()
| bool Constant::isNegativeZeroValue | ( | ) | const |
Return true if the value is what would be returned by getZeroValueForNegation.
Definition at line 39 of file Constants.cpp.
References llvm::Value::getType(), llvm::Type::isFPOrFPVectorTy(), and isNullValue().
Referenced by Constant().
◆ isNormalFP()
| bool Constant::isNormalFP | ( | ) | const |
Return true if this is a normal (as opposed to denormal) floating-point scalar constant or a vector constant with all normal elements.
Definition at line 215 of file Constants.cpp.
References getAggregateElement(), and llvm::Value::getType().
Referenced by Constant(), foldFDivConstantDividend(), foldFDivConstantDivisor(), and llvm::InstCombiner::visitFMul().
◆ isNotMinSignedValue()
| bool Constant::isNotMinSignedValue | ( | ) | const |
Return true if the value is not the smallest signed value.
Definition at line 178 of file Constants.cpp.
References getAggregateElement(), llvm::Value::getType(), llvm::Type::getVectorNumElements(), and isNotMinSignedValue().
Referenced by Constant(), isNotMinSignedValue(), llvm::InstCombiner::visitCallInst(), llvm::InstCombiner::visitMul(), and llvm::InstCombiner::visitSub().
◆ isNullValue()
| bool Constant::isNullValue | ( | ) | const |
Return true if this is the value that would be returned by getNullValue.
Definition at line 85 of file Constants.cpp.
Referenced by addConditions(), addTryBlockMapEntry(), BitCastConstantVector(), calculateSEHStateNumbers(), canonicalizeSaturatedSubtract(), llvm::FunctionComparator::cmpConstants(), computeBytesPoppedByCalleeForSRet(), computePointerICmp(), Constant(), ConstantFold(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldCompareInstOperands(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldExtractElementInstruction(), llvm::ConstantFoldGetElementPtr(), llvm::ConstantFoldSelectInstruction(), ConvertDoubleToBytes(), llvm::createShadowStackGCLoweringPass(), llvm::NVPTXAsmPrinter::doFinalization(), eliminateNoopStore(), emitSignedInt64(), evaluateICmpRelation(), ExtractConstantBytes(), foldICmpShlOne(), foldOperationIntoPhiValue(), forEachUser(), llvm::ConstantStruct::get(), getImplicitScaleFactor(), llvm::LazyValueInfo::getPredicateAt(), getPredicateResult(), handleOperandChange(), INITIALIZE_PASS(), llvm::isBytewiseValue(), isCatchAll(), isKnownNonZero(), isMulPowOf2(), isNegativeZeroValue(), isNullOrUndef(), isZeroValue(), llvm::AsmPrinter::lowerConstant(), llvm::SparseSolver< LatticeKey, LatticeVal, KeyInfo >::MarkBlockExecutable(), optimizeOnceStoredGlobal(), parseGlobalCtors(), passingValueIsAlwaysUndefined(), llvm::ExecutionEngine::runStaticConstructorsDestructors(), ShrinkDemandedConstant(), simplifyDivRem(), SwitchToLookupTable(), TryToShrinkGlobalToBoolean(), TurnSwitchRangeIntoICmp(), TypeSizeToSizeIndex(), and llvm::InstCombiner::visitCallInst().
◆ isOneValue()
| bool Constant::isOneValue | ( | ) | const |
Returns true if the value is one.
Definition at line 126 of file Constants.cpp.
References getSplatValue().
Referenced by canonicalizeSaturatedSubtract(), computeUnlikelySuccessors(), Constant(), and llvm::InstCombiner::visitSub().
◆ isThreadDependent()
| bool Constant::isThreadDependent | ( | ) | const |
Return true if the value can vary between threads.
Definition at line 463 of file Constants.cpp.
References ConstHasGlobalValuePredicate().
Referenced by Constant(), and ValidLookupTableConstant().
◆ isZeroValue()
| bool Constant::isZeroValue | ( | ) | const |
Return true if the value is negative zero or null value.
Definition at line 65 of file Constants.cpp.
References isNullValue().
Referenced by computeKnownBitsFromOperator(), computeUnlikelySuccessors(), Constant(), isZero(), shouldConvertImpl(), and TypeSizeToSizeIndex().
◆ needsRelocation()
| bool Constant::needsRelocation | ( | ) | const |
This method classifies the entry according to whether or not it may generate a relocation entry.
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 489 of file Constants.cpp.
References llvm::dyn_cast(), getFunction(), llvm::User::getNumOperands(), llvm::ConstantExpr::getOpcode(), and llvm::User::getOperand().
Referenced by Constant(), llvm::TargetLoweringObjectFile::getKindForGlobal(), and llvm::ARMTTIImpl::shouldBuildLookupTablesForConstant().
◆ operator=()
Referenced by Constant().
◆ 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 537 of file Constants.cpp.
References assert(), llvm::dyn_cast(), E, llvm::IntegerType::getBitWidth(), llvm::APInt::getBitWidth(), I, removeDeadUsersOfConstant(), llvm::Value::user_begin(), and llvm::Value::user_end().
Referenced by classof(), llvm::createDeadArgHackingPass(), deleteIfDead(), hasAddressTakenAndUsed(), mergeConstants(), OptimizeGlobalAliases(), llvm::LegacyInlinerBase::removeDeadFunctions(), llvm::GlobalDCEPass::run(), llvm::AlwaysInlinerPass::run(), and llvm::InlinerPass::run().
◆ stripPointerCasts() [1/2]
Definition at line 174 of file Constant.h.
References llvm::Value::stripPointerCasts().
Referenced by addTryBlockMapEntry(), llvm::WinException::beginFunclet(), llvm::DwarfCFIException::beginFunction(), llvm::WinException::beginFunction(), llvm::ConstantFoldLoadFromConstPtr(), llvm::emitFGetCUnlocked(), llvm::emitFGetSUnlocked(), llvm::emitFPutC(), llvm::emitFPutCUnlocked(), llvm::emitFPutS(), llvm::emitFPutSUnlocked(), llvm::emitFReadUnlocked(), llvm::emitFWrite(), llvm::emitFWriteUnlocked(), llvm::emitStrChr(), llvm::emitStrLen(), llvm::ARMAsmPrinter::EmitXXStructor(), llvm::WinException::endFunclet(), llvm::ARMException::endFunction(), llvm::WinException::endFunction(), getArrayElements(), getOrInsertValueProfilingCall(), getSqrtCall(), hasUsesToReplace(), INITIALIZE_PASS(), llvm::InlineFunction(), isKnownTypeIdMember(), OptimizeGlobalAliases(), llvm::WholeProgramDevirtPass::run(), stripPointerCasts(), and llvm::InstCombiner::visitLandingPadInst().
◆ stripPointerCasts() [2/2]
|
inline |
Definition at line 178 of file Constant.h.
References stripPointerCasts().
The documentation for this class was generated from the following files:
- include/llvm/IR/Constant.h
- lib/IR/Constants.cpp
