LLVM  6.0.0svn
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::Constant Class Reference

This is an important base class in LLVM. More...

#include "llvm/IR/Constant.h"

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

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 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...
 
ConstantgetAggregateElement (unsigned Elt) const
 For aggregates (struct/array/vector) return the constant that corresponds to the specified element if possible, or null if not. More...
 
ConstantgetAggregateElement (Constant *Elt) const
 
ConstantgetSplatValue () const
 If this is a splat vector constant, meaning that all of the elements have the same value, return that value. More...
 
const APIntgetUniqueInteger () 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 ConstantstripPointerCasts () const
 
ConstantstripPointerCasts ()
 
- 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 *, unsigned)
 Placement delete - required by std, but never called. More...
 
void operator delete (void *, unsigned, bool)
 Placement delete - required by std, but never called. 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...
 
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...
 
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
 
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 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 ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndBarriers () const
 Strip off pointer casts, all-zero GEPs, aliases and barriers. More...
 
ValuestripPointerCastsAndBarriers ()
 
const ValuestripPointerCastsNoFollowAliases () const
 Strip off pointer casts and all-zero GEPs. More...
 
ValuestripPointerCastsNoFollowAliases ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets () const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets ()
 
unsigned 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 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 ConstantgetNullValue (Type *Ty)
 Constructor to create a '0' constant of arbitrary type. More...
 
static ConstantgetAllOnesValue (Type *Ty)
 Get the all ones value. More...
 
static ConstantgetIntegerValue (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>
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...
 
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 UseOpFrom (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]

llvm::Constant::Constant ( Type ty,
ValueTy  vty,
Use Ops,
unsigned  NumOps 
)
inlineprotected

◆ Constant() [2/2]

llvm::Constant::Constant ( const Constant )
delete

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 371 of file Constants.cpp.

References canTrapImpl().

Referenced by Constant(), and SplitCriticalSideEffectEdges().

◆ classof()

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

◆ 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 300 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]

Constant * Constant::getAggregateElement ( unsigned  Elt) const

◆ getAggregateElement() [2/2]

Constant * Constant::getAggregateElement ( Constant Elt) const

Definition at line 293 of file Constants.cpp.

References assert(), getAggregateElement(), and llvm::Value::getType().

◆ getAllOnesValue()

Constant * Constant::getAllOnesValue ( Type Ty)
static

Get the all ones value.

Returns
the value for an integer or vector of integer constant of the given type that has all its bits set to true.

Definition at line 261 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(), classof(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCompareInstruction(), createAndInstr(), llvm::IRBuilderBase::CreateMaskedGather(), llvm::IRBuilderBase::CreateMaskedScatter(), llvm::BinaryOperator::CreateNot(), createPrivateNonConstGlobalForString(), DoInitialMatch(), EqualityPropUnSafe(), foldICmpShlOne(), foldICmpWithMinMax(), llvm::X86InstrInfo::foldMemoryOperandImpl(), llvm::IRTranslator::getAnalysisUsage(), llvm::ConstantExpr::getBinOpAbsorber(), llvm::ConstantExpr::getBinOpIdentity(), getMaskedTypeForICmpPair(), llvm::ScalarEvolution::getNegativeSCEV(), llvm::ConstantExpr::getNot(), llvm::ScalarEvolution::getNotSCEV(), insertSinCosCall(), LLVMConstAllOnes(), LowerNegateToMultiply(), OptimizeAndOrXor(), SimplifyAddInst(), SimplifyOrInst(), SimplifyXorInst(), ThreadCmpOverSelect(), transformToIndexedCompare(), upgradeMaskedCompare(), llvm::sroa::AllocaSliceRewriter::visit(), llvm::InstCombiner::visitICmpInst(), llvm::InstCombiner::visitURem(), and llvm::InstCombiner::visitZExt().

◆ getIntegerValue()

Constant * Constant::getIntegerValue ( Type Ty,
const APInt V 
)
static

◆ getNullValue()

Constant * Constant::getNullValue ( Type Ty)
static

Constructor to create a '0' constant of arbitrary type.

Definition at line 207 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(), appendToGlobalArray(), atomicSizeSupported(), BitCastConstantVector(), BreakUpSubtract(), llvm::canConstantFoldCallTo(), classof(), CleanupConstantGlobalUsers(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldCompareInstOperands(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldExtractElementInstruction(), llvm::ConstantFoldGetElementPtr(), llvm::ConstantFoldLoadFromConstPtr(), ConvertImplicitDefToConstZero(), llvm::SanitizerStatReport::create(), createAndInstr(), llvm::IRBuilder< TargetFolder >::CreateIsNotNull(), llvm::IRBuilder< TargetFolder >::CreateIsNull(), llvm::createObjCARCOptPass(), createPrivateNonConstGlobalForString(), llvm::createSeparateConstOffsetFromGEPPass(), llvm::createShadowStackGCLoweringPass(), despeculateCountZeros(), eliminateUnreachableBlock(), llvm::EmitGEPOffset(), EqualityPropUnSafe(), evaluateICmpRelation(), llvm::SCEVExpander::expandUnionPredicate(), ExtractConstantBytes(), findInitTrampoline(), llvm::CodeExtractor::findInputsOutputs(), FindPhiPredForUseInBlock(), llvm::SanitizerStatReport::finish(), FoldBitCast(), foldICmpShlOne(), foldICmpWithMinMax(), foldLogOpOfMaskedICmps(), llvm::X86InstrInfo::foldMemoryOperandImpl(), foldSelectICmpAndOr(), foldShiftedShift(), foldUDivNegCst(), functionHasLines(), FunctionNumber(), llvm::ConstantExpr::getAlignOf(), llvm::IRTranslator::getAnalysisUsage(), getAsConstantIndexedAddress(), getBaseType(), llvm::ConstantExpr::getBinOpAbsorber(), llvm::ConstantExpr::getBinOpIdentity(), getFoldedSizeOf(), getNegativeIsTrueBoolVec(), llvm::ConstantExpr::getOffsetOf(), llvm::FastISel::getRegForValue(), getRetComponentType(), llvm::ConstantAggregateZero::getSequentialElement(), llvm::ConstantExpr::getSizeOf(), getSplatValue(), llvm::ConstantAggregateZero::getStructElement(), getX86SSEConditionCode(), llvm::ConstantFP::getZeroValueForNegation(), hasUnaryFloatFn(), INITIALIZE_PASS(), insertSinCosCall(), instrumentMaskedLoadOrStore(), llvm::isBytewiseValue(), isCallPromotable(), isCopyOfAPHI(), IsIncrementNUW(), IsNonLocalValue(), 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(), rewriteGEPAsOffset(), RewriteHeapSROALoadUser(), llvm::WholeProgramDevirtPass::run(), shouldInstrumentBlock(), ShrinkDemandedConstant(), simplifyAllocaArraySize(), SimplifyAndInst(), simplifyDiv(), simplifyDivRem(), SimplifyFAddInst(), SimplifyFSubInst(), SimplifyGEPInst(), SimplifyICmpInst(), simplifyICmpWithBinOp(), SimplifyIntrinsic(), SimplifyMulInst(), SimplifyRightShift(), SimplifyShlInst(), SimplifySubInst(), simplifyX86MaskedLoad(), simplifyX86movmsk(), simplifyX86pshufb(), simplifyX86varShift(), SimplifyXorInst(), SplitAddRecs(), SRAGlobal(), StackMallocSizeClass(), transformToIndexedCompare(), upgradeAbs(), llvm::UpgradeIntrinsicCall(), 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::visitMul(), llvm::InstCombiner::visitTrunc(), 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 1273 of file Constants.cpp.

References assert(), getNullValue(), and llvm::Value::getType().

Referenced by computeKnownBitsFromOperator(), Constant(), llvm::ConstantVector::getType(), getUniqueInteger(), llvm::CompositeType::indexValid(), isAllOnesValue(), isMinSignedValue(), isNotMinSignedValue(), and isOneValue().

◆ getUniqueInteger()

const APInt & Constant::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.

Definition at line 1294 of file Constants.cpp.

References assert(), C, getAggregateElement(), and getSplatValue().

Referenced by Constant(), and foldICmpShlOne().

◆ handleOperandChange()

void Constant::handleOperandChange ( Value From,
Value To 
)

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 2701 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, isPodLike< T >::value >::push_back(), llvm::Value::replaceAllUsesWith(), llvm::ConstantUniqueMap< ConstantClass >::replaceOperandsInPlace(), llvm::SmallVectorImpl< T >::reserve(), llvm::LLVMContextImpl::StructConstants, and llvm::LLVMContextImpl::VectorConstants.

Referenced by classof().

◆ 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(), Constant(), ConstantFold(), llvm::ConstantFoldSelectInstruction(), createPrivateNonConstGlobalForString(), foldICmpShlOne(), and isICmpTrue().

◆ isConstantUsed()

bool Constant::isConstantUsed ( ) const

Return true if the constant has users other than constant expressions and other dangling things.

Definition at line 415 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 408 of file Constants.cpp.

References ConstHasGlobalValuePredicate().

Referenced by Constant(), and ValidLookupTableConstant().

◆ isMinSignedValue()

bool Constant::isMinSignedValue ( ) const

Return true if the value is the smallest signed value.

Definition at line 153 of file Constants.cpp.

References getSplatValue().

Referenced by Constant().

◆ 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 llvm::Value::getType(), llvm::Type::isFPOrFPVectorTy(), and isNullValue().

Referenced by Constant().

◆ isNotMinSignedValue()

bool Constant::isNotMinSignedValue ( ) const

Return true if the value is not the smallest signed value.

Definition at line 179 of file Constants.cpp.

References getSplatValue().

Referenced by Constant(), 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 86 of file Constants.cpp.

Referenced by addTryBlockMapEntry(), BitCastConstantVector(), calculateSEHStateNumbers(), llvm::FunctionComparator::cmpConstants(), computeBytesPoppedByCalleeForSRet(), computePointerICmp(), Constant(), ConstantFold(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldCompareInstOperands(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldExtractElementInstruction(), llvm::ConstantFoldGetElementPtr(), llvm::ConstantFoldSelectInstruction(), ConvertDoubleToBytes(), createPrivateNonConstGlobalForString(), llvm::createShadowStackGCLoweringPass(), llvm::NVPTXAsmPrinter::doFinalization(), eliminateNoopStore(), emitSignedInt64(), evaluateICmpRelation(), ExtractConstantBytes(), foldICmpShlOne(), foldOperationIntoPhiValue(), foldSelectICmpAndOr(), forEachUser(), llvm::ConstantStruct::get(), getImplicitScaleFactor(), llvm::SparseSolver::getOrInitValueState(), llvm::LazyValueInfo::getPredicateAt(), getPredicateResult(), handleOperandChange(), llvm::NVPTXAsmPrinter::ignoreLoc(), isCatchAll(), isKnownNonZero(), isMulPowOf2(), isNegativeZeroValue(), isSuitableForBSS(), isZeroValue(), llvm::AsmPrinter::lowerConstant(), optimizeOnceStoredGlobal(), passingValueIsAlwaysUndefined(), llvm::ExecutionEngine::runStaticConstructorsDestructors(), ShrinkDemandedConstant(), simplifyDivRem(), SwitchToLookupTable(), TryToShrinkGlobalToBoolean(), TurnSwitchRangeIntoICmp(), llvm::InstCombiner::visitCallInst(), and llvm::InstCombiner::visitFCmpInst().

◆ isOneValue()

bool Constant::isOneValue ( ) const

Returns true if the value is one.

Definition at line 127 of file Constants.cpp.

References getSplatValue().

Referenced by Constant(), foldSelectICmpAndOr(), and llvm::InstCombiner::visitSub().

◆ isThreadDependent()

bool Constant::isThreadDependent ( ) const

Return true if the value can vary between threads.

Definition at line 401 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 66 of file Constants.cpp.

References isNullValue().

Referenced by computeKnownBitsFromOperator(), Constant(), createPrivateNonConstGlobalForString(), isZero(), and shouldConvertImpl().

◆ 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 427 of file Constants.cpp.

References llvm::dyn_cast(), llvm::User::getNumOperands(), llvm::ConstantExpr::getOpcode(), and llvm::User::getOperand().

Referenced by Constant(), llvm::TargetLoweringObjectFile::getKindForGlobal(), and llvm::ARMTTIImpl::shouldBuildLookupTablesForConstant().

◆ operator=()

void llvm::Constant::operator= ( const Constant )
delete

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 475 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 AddressIsTaken(), classof(), llvm::createDeadArgHackingPass(), deleteIfDead(), hasAddressTakenAndUsed(), mergeConstants(), OptimizeGlobalAliases(), llvm::LegacyInlinerBase::removeDeadFunctions(), llvm::AlwaysInlinerPass::run(), llvm::GlobalDCEPass::run(), and llvm::InlinerPass::run().

◆ stripPointerCasts() [1/2]

const Constant* llvm::Constant::stripPointerCasts ( ) const
inline

◆ stripPointerCasts() [2/2]

Constant* llvm::Constant::stripPointerCasts ( )
inline

Definition at line 157 of file Constant.h.

References stripPointerCasts().


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