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

A constant value that is initialized with an expression using other constant values. More...

#include "llvm/IR/Constants.h"

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

Public Member Functions

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

Static Public Member Functions

static ConstantgetAlignOf (Type *Ty)
 getAlignOf constant expr - computes the alignment of a type in a target independent way (Note: the return type is an i64). More...
 
static ConstantgetSizeOf (Type *Ty)
 getSizeOf constant expr - computes the (alloc) size of a type (in address-units, not bits) in a target independent way (Note: the return type is an i64). More...
 
static ConstantgetOffsetOf (StructType *STy, unsigned FieldNo)
 getOffsetOf constant expr - computes the offset of a struct field in a target independent way (Note: the return type is an i64). More...
 
static ConstantgetOffsetOf (Type *Ty, Constant *FieldNo)
 getOffsetOf constant expr - This is a generalized form of getOffsetOf, which supports any aggregate type, and any Constant index. More...
 
static ConstantgetNeg (Constant *C, bool HasNUW=false, bool HasNSW=false)
 
static ConstantgetFNeg (Constant *C)
 
static ConstantgetNot (Constant *C)
 
static ConstantgetAdd (Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
 
static ConstantgetFAdd (Constant *C1, Constant *C2)
 
static ConstantgetSub (Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
 
static ConstantgetFSub (Constant *C1, Constant *C2)
 
static ConstantgetMul (Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
 
static ConstantgetFMul (Constant *C1, Constant *C2)
 
static ConstantgetUDiv (Constant *C1, Constant *C2, bool isExact=false)
 
static ConstantgetSDiv (Constant *C1, Constant *C2, bool isExact=false)
 
static ConstantgetFDiv (Constant *C1, Constant *C2)
 
static ConstantgetURem (Constant *C1, Constant *C2)
 
static ConstantgetSRem (Constant *C1, Constant *C2)
 
static ConstantgetFRem (Constant *C1, Constant *C2)
 
static ConstantgetAnd (Constant *C1, Constant *C2)
 
static ConstantgetOr (Constant *C1, Constant *C2)
 
static ConstantgetXor (Constant *C1, Constant *C2)
 
static ConstantgetUMin (Constant *C1, Constant *C2)
 
static ConstantgetShl (Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
 
static ConstantgetLShr (Constant *C1, Constant *C2, bool isExact=false)
 
static ConstantgetAShr (Constant *C1, Constant *C2, bool isExact=false)
 
static ConstantgetTrunc (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetSExt (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetZExt (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetFPTrunc (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetFPExtend (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetUIToFP (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetSIToFP (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetFPToUI (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetFPToSI (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetPtrToInt (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetIntToPtr (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetBitCast (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetAddrSpaceCast (Constant *C, Type *Ty, bool OnlyIfReduced=false)
 
static ConstantgetNSWNeg (Constant *C)
 
static ConstantgetNUWNeg (Constant *C)
 
static ConstantgetNSWAdd (Constant *C1, Constant *C2)
 
static ConstantgetNUWAdd (Constant *C1, Constant *C2)
 
static ConstantgetNSWSub (Constant *C1, Constant *C2)
 
static ConstantgetNUWSub (Constant *C1, Constant *C2)
 
static ConstantgetNSWMul (Constant *C1, Constant *C2)
 
static ConstantgetNUWMul (Constant *C1, Constant *C2)
 
static ConstantgetNSWShl (Constant *C1, Constant *C2)
 
static ConstantgetNUWShl (Constant *C1, Constant *C2)
 
static ConstantgetExactSDiv (Constant *C1, Constant *C2)
 
static ConstantgetExactUDiv (Constant *C1, Constant *C2)
 
static ConstantgetExactAShr (Constant *C1, Constant *C2)
 
static ConstantgetExactLShr (Constant *C1, Constant *C2)
 
static ConstantgetExactLogBase2 (Constant *C)
 If C is a scalar/fixed width vector of known powers of 2, then this function returns a new scalar/fixed width vector obtained from logBase2 of C. More...
 
static ConstantgetBinOpIdentity (unsigned Opcode, Type *Ty, bool AllowRHSConstant=false)
 Return the identity constant for a binary opcode. More...
 
static ConstantgetBinOpAbsorber (unsigned Opcode, Type *Ty)
 Return the absorbing element for the given binary operation, i.e. More...
 
static ConstantgetCast (unsigned ops, Constant *C, Type *Ty, bool OnlyIfReduced=false)
 Convenience function for getting a Cast operation. More...
 
static ConstantgetZExtOrBitCast (Constant *C, Type *Ty)
 
static ConstantgetSExtOrBitCast (Constant *C, Type *Ty)
 
static ConstantgetTruncOrBitCast (Constant *C, Type *Ty)
 
static ConstantgetPointerCast (Constant *C, Type *Ty)
 Create a BitCast, AddrSpaceCast, or a PtrToInt cast constant expression. More...
 
static ConstantgetPointerBitCastOrAddrSpaceCast (Constant *C, Type *Ty)
 Create a BitCast or AddrSpaceCast for a pointer type depending on the address space. More...
 
static ConstantgetIntegerCast (Constant *C, Type *Ty, bool IsSigned)
 Create a ZExt, Bitcast or Trunc for integer -> integer casts. More...
 
static ConstantgetFPCast (Constant *C, Type *Ty)
 Create a FPExt, Bitcast or FPTrunc for fp -> fp casts. More...
 
static ConstantgetSelect (Constant *C, Constant *V1, Constant *V2, Type *OnlyIfReducedTy=nullptr)
 Select constant expr. More...
 
static Constantget (unsigned Opcode, Constant *C1, unsigned Flags=0, Type *OnlyIfReducedTy=nullptr)
 get - Return a unary operator constant expression, folding if possible. More...
 
static Constantget (unsigned Opcode, Constant *C1, Constant *C2, unsigned Flags=0, Type *OnlyIfReducedTy=nullptr)
 get - Return a binary or shift operator constant expression, folding if possible. More...
 
static ConstantgetCompare (unsigned short pred, Constant *C1, Constant *C2, bool OnlyIfReduced=false)
 Return an ICmp or FCmp comparison operator constant expression. More...
 
static ConstantgetICmp (unsigned short pred, Constant *LHS, Constant *RHS, bool OnlyIfReduced=false)
 get* - Return some common constants without having to specify the full Instruction::OPCODE identifier. More...
 
static ConstantgetFCmp (unsigned short pred, Constant *LHS, Constant *RHS, bool OnlyIfReduced=false)
 
static ConstantgetGetElementPtr (Type *Ty, Constant *C, ArrayRef< Constant * > IdxList, bool InBounds=false, Optional< unsigned > InRangeIndex=None, Type *OnlyIfReducedTy=nullptr)
 Getelementptr form. More...
 
static ConstantgetGetElementPtr (Type *Ty, Constant *C, Constant *Idx, bool InBounds=false, Optional< unsigned > InRangeIndex=None, Type *OnlyIfReducedTy=nullptr)
 
static ConstantgetGetElementPtr (Type *Ty, Constant *C, ArrayRef< Value * > IdxList, bool InBounds=false, Optional< unsigned > InRangeIndex=None, Type *OnlyIfReducedTy=nullptr)
 
static ConstantgetInBoundsGetElementPtr (Type *Ty, Constant *C, ArrayRef< Constant * > IdxList)
 Create an "inbounds" getelementptr. More...
 
static ConstantgetInBoundsGetElementPtr (Type *Ty, Constant *C, Constant *Idx)
 
static ConstantgetInBoundsGetElementPtr (Type *Ty, Constant *C, ArrayRef< Value * > IdxList)
 
static ConstantgetExtractElement (Constant *Vec, Constant *Idx, Type *OnlyIfReducedTy=nullptr)
 
static ConstantgetInsertElement (Constant *Vec, Constant *Elt, Constant *Idx, Type *OnlyIfReducedTy=nullptr)
 
static ConstantgetShuffleVector (Constant *V1, Constant *V2, ArrayRef< int > Mask, Type *OnlyIfReducedTy=nullptr)
 
static ConstantgetExtractValue (Constant *Agg, ArrayRef< unsigned > Idxs, Type *OnlyIfReducedTy=nullptr)
 
static ConstantgetInsertValue (Constant *Agg, Constant *Val, ArrayRef< unsigned > Idxs, Type *OnlyIfReducedTy=nullptr)
 
static bool classof (const Value *V)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
- Static Public Member Functions inherited from llvm::Constant
static bool classof (const Value *V)
 
static ConstantgetNullValue (Type *Ty)
 Constructor to create a '0' constant of arbitrary type. More...
 
static ConstantgetAllOnesValue (Type *Ty)
 
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 ConstantreplaceUndefsWith (Constant *C, Constant *Replacement)
 Try to replace undefined constant C or undefined elements in C with Replacement. More...
 
static ConstantmergeUndefsWith (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

 ConstantExpr (Type *ty, unsigned Opcode, Use *Ops, unsigned NumOps)
 
 ~ConstantExpr ()=default
 
- Protected Member Functions inherited from llvm::Constant
 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>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID. More...
 
bool hasMetadata () const
 Return true if this value has any metadata attached to it. More...
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind. More...
 
void clearMetadata ()
 Erase all metadata attached to this Value. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any. More...
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order. More...
 
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
 
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached. More...
 
bool hasMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment. More...
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment. More...
 
void addMetadata (StringRef Kind, MDNode &MD)
 

Friends

struct ConstantExprKeyType
 
class Constant
 

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 constexpr unsigned MaxAlignmentExponent = 32
 The maximum alignment for instructions. More...
 
static constexpr uint64_t MaximumAlignment = 1ULL << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 27 }
 The number of operands in the subclass. More...
 
- 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 HasMetadata: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Detailed Description

A constant value that is initialized with an expression using other constant values.

This class uses the standard Instruction opcodes to define the various constant expressions. The Opcode field for the ConstantExpr class is maintained in the Value::SubclassData field.

Definition at line 936 of file Constants.h.

Constructor & Destructor Documentation

◆ ConstantExpr()

llvm::ConstantExpr::ConstantExpr ( Type ty,
unsigned  Opcode,
Use Ops,
unsigned  NumOps 
)
inlineprotected

Definition at line 944 of file Constants.h.

◆ ~ConstantExpr()

llvm::ConstantExpr::~ConstantExpr ( )
protecteddefault

Member Function Documentation

◆ classof()

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

Methods for support type inquiry through isa, cast, and dyn_cast:

Definition at line 1320 of file Constants.h.

References llvm::Value::getValueID().

◆ DECLARE_TRANSPARENT_OPERAND_ACCESSORS()

llvm::ConstantExpr::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Constant  )

Transparently provide more efficient getOperand methods.

◆ get() [1/2]

Constant * ConstantExpr::get ( unsigned  Opcode,
Constant C1,
Constant C2,
unsigned  Flags = 0,
Type OnlyIfReducedTy = nullptr 
)
static

get - Return a binary or shift operator constant expression, folding if possible.

Parameters
OnlyIfReducedTysee getWithOperands() docs.

Definition at line 2298 of file Constants.cpp.

References llvm::MCID::Add, assert(), C1, llvm::ConstantFoldBinaryInstruction(), llvm::LLVMContextImpl::ExprConstants, R600_InstFlag::FC, llvm::Value::getType(), and llvm::Instruction::isBinaryOp().

◆ get() [2/2]

Constant * ConstantExpr::get ( unsigned  Opcode,
Constant C1,
unsigned  Flags = 0,
Type OnlyIfReducedTy = nullptr 
)
static

◆ getAdd()

Constant * ConstantExpr::getAdd ( Constant C1,
Constant C2,
bool  HasNUW = false,
bool  HasNSW = false 
)
static

◆ getAddrSpaceCast()

Constant * ConstantExpr::getAddrSpaceCast ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getAlignOf()

Constant * ConstantExpr::getAlignOf ( Type Ty)
static

getAlignOf constant expr - computes the alignment of a type in a target independent way (Note: the return type is an i64).

Definition at line 2367 of file Constants.cpp.

References GEP, llvm::ConstantInt::get(), llvm::StructType::get(), llvm::Type::getContext(), getGetElementPtr(), llvm::Type::getInt1Ty(), llvm::Type::getInt32Ty(), llvm::Type::getInt64Ty(), llvm::Constant::getNullValue(), llvm::Type::getPointerTo(), and getPtrToInt().

Referenced by LLVMAlignOf().

◆ getAnd()

Constant * ConstantExpr::getAnd ( Constant C1,
Constant C2 
)
static

◆ getAShr()

Constant * ConstantExpr::getAShr ( Constant C1,
Constant C2,
bool  isExact = false 
)
static

◆ getAsInstruction()

Instruction * ConstantExpr::getAsInstruction ( ) const

◆ getBinOpAbsorber()

Constant * ConstantExpr::getBinOpAbsorber ( unsigned  Opcode,
Type Ty 
)
static

Return the absorbing element for the given binary operation, i.e.

a constant C such that X op C = C and C op X = C for every X. For example, this returns zero for integer multiplication. It returns null if the operator doesn't have an absorbing element.

Definition at line 2858 of file Constants.cpp.

References llvm::Constant::getAllOnesValue(), and llvm::Constant::getNullValue().

◆ getBinOpIdentity()

Constant * ConstantExpr::getBinOpIdentity ( unsigned  Opcode,
Type Ty,
bool  AllowRHSConstant = false 
)
static

Return the identity constant for a binary opcode.

The identity constant C is defined as X op C = X and C op X = X for every X when the binary operation is commutative. If the binop is not commutative, callers can acquire the operand 1 identity constant by setting AllowRHSConstant to true. For example, any shift has a zero identity constant for operand 1: X shift 0 = X. Return nullptr if the operator does not have an identity constant.

Definition at line 2812 of file Constants.cpp.

References llvm::MCID::Add, assert(), llvm::ConstantInt::get(), llvm::ConstantFP::get(), llvm::Constant::getAllOnesValue(), llvm::ConstantFP::getNegativeZero(), llvm::Constant::getNullValue(), llvm::Instruction::isBinaryOp(), llvm::Instruction::isCommutative(), and llvm_unreachable.

Referenced by llvm::ConstantFoldBinaryInstruction(), foldSelectBinOpIdentity(), llvm::InstCombinerImpl::foldSelectIntoOp(), foldSelectShuffleWith1Binop(), getIdentityValue(), llvm::InstCombiner::getSafeVectorConstantForBinop(), LinearizeExprTree(), llvm::InstCombinerImpl::SimplifyUsingDistributiveLaws(), and simplifyWithOpReplaced().

◆ getBitCast()

Constant * ConstantExpr::getBitCast ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getCast()

Constant * ConstantExpr::getCast ( unsigned  ops,
Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getCompare()

Constant * ConstantExpr::getCompare ( unsigned short  pred,
Constant C1,
Constant C2,
bool  OnlyIfReduced = false 
)
static

Return an ICmp or FCmp comparison operator constant expression.

Parameters
OnlyIfReducedsee getWithOperands() docs.

Definition at line 2398 of file Constants.cpp.

References assert(), C1, llvm::CmpInst::FCMP_FALSE, llvm::CmpInst::FCMP_OEQ, llvm::CmpInst::FCMP_OGE, llvm::CmpInst::FCMP_OGT, llvm::CmpInst::FCMP_OLE, llvm::CmpInst::FCMP_OLT, llvm::CmpInst::FCMP_ONE, llvm::CmpInst::FCMP_ORD, llvm::CmpInst::FCMP_TRUE, llvm::CmpInst::FCMP_UEQ, llvm::CmpInst::FCMP_UGE, llvm::CmpInst::FCMP_UGT, llvm::CmpInst::FCMP_ULE, llvm::CmpInst::FCMP_ULT, llvm::CmpInst::FCMP_UNE, llvm::CmpInst::FCMP_UNO, getFCmp(), getICmp(), llvm::Value::getType(), llvm::CmpInst::ICMP_EQ, llvm::CmpInst::ICMP_NE, llvm::CmpInst::ICMP_SGE, llvm::CmpInst::ICMP_SGT, llvm::CmpInst::ICMP_SLE, llvm::CmpInst::ICMP_SLT, llvm::CmpInst::ICMP_UGE, llvm::CmpInst::ICMP_UGT, llvm::CmpInst::ICMP_ULE, llvm::CmpInst::ICMP_ULT, and llvm_unreachable.

Referenced by computeUnlikelySuccessors(), llvm::JumpThreadingPass::computeValueKnownInPredecessorsImpl(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCompareInstOperands(), llvm::ConstantFoldCompareInstruction(), llvm::TargetFolder::CreateFCmp(), llvm::ConstantFolder::CreateFCmp(), llvm::TargetFolder::CreateICmp(), llvm::ConstantFolder::CreateICmp(), llvm::JumpThreadingPass::evaluateOnPredecessorEdge(), llvm::InstCombinerImpl::foldICmpSelectConstant(), llvm::InstCombinerImpl::foldICmpWithConstant(), llvm::InstCombinerImpl::foldOpIntoPhi(), llvm::InstCombinerImpl::FoldOpIntoSelect(), llvm::ValueLatticeElement::getCompare(), getWithOperands(), and llvm::GCNTTIImpl::instCombineIntrinsic().

◆ getExactAShr()

static Constant* llvm::ConstantExpr::getExactAShr ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1068 of file Constants.h.

References C1.

◆ getExactLogBase2()

Constant * ConstantExpr::getExactLogBase2 ( Constant C)
static

If C is a scalar/fixed width vector of known powers of 2, then this function returns a new scalar/fixed width vector obtained from logBase2 of C.

Undef vector elements are set to zero. Return a null pointer otherwise.

Definition at line 2783 of file Constants.cpp.

References E, llvm::ConstantInt::get(), llvm::ConstantVector::get(), llvm::Constant::getAggregateElement(), llvm::Constant::getNullValue(), llvm::Type::getScalarType(), I, llvm::APInt::isPowerOf2(), llvm::APInt::logBase2(), llvm::PatternMatch::m_APInt(), and llvm::PatternMatch::match().

Referenced by detectShiftUntilBitTestIdiom(), foldUDivPow2Cst(), foldUDivShl(), llvm::InstCombinerImpl::visitMul(), and llvm::InstCombinerImpl::visitSDiv().

◆ getExactLShr()

static Constant* llvm::ConstantExpr::getExactLShr ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1072 of file Constants.h.

References C1.

◆ getExactSDiv()

static Constant* llvm::ConstantExpr::getExactSDiv ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1060 of file Constants.h.

References C1.

Referenced by LLVMConstExactSDiv().

◆ getExactUDiv()

static Constant* llvm::ConstantExpr::getExactUDiv ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1064 of file Constants.h.

References C1.

Referenced by LLVMConstExactUDiv().

◆ getExtractElement()

Constant * ConstantExpr::getExtractElement ( Constant Vec,
Constant Idx,
Type OnlyIfReducedTy = nullptr 
)
static

◆ getExtractValue()

Constant * ConstantExpr::getExtractValue ( Constant Agg,
ArrayRef< unsigned >  Idxs,
Type OnlyIfReducedTy = nullptr 
)
static

◆ getFAdd()

Constant * ConstantExpr::getFAdd ( Constant C1,
Constant C2 
)
static

Definition at line 2697 of file Constants.cpp.

References C1, and get().

Referenced by llvm::ConstantFolder::CreateFAdd(), llvm::TargetFolder::CreateFAdd(), and LLVMConstFAdd().

◆ getFCmp()

Constant * ConstantExpr::getFCmp ( unsigned short  pred,
Constant LHS,
Constant RHS,
bool  OnlyIfReduced = false 
)
static

◆ getFDiv()

Constant * ConstantExpr::getFDiv ( Constant C1,
Constant C2 
)
static

◆ getFMul()

Constant * ConstantExpr::getFMul ( Constant C1,
Constant C2 
)
static

◆ getFNeg()

Constant * ConstantExpr::getFNeg ( Constant C)
static

◆ getFPCast()

Constant * ConstantExpr::getFPCast ( Constant C,
Type Ty 
)
static

Create a FPExt, Bitcast or FPTrunc for fp -> fp casts.

Parameters
CThe integer constant to be casted
TyThe integer type to cast to

Definition at line 2083 of file Constants.cpp.

References assert(), getCast(), llvm::Type::getScalarSizeInBits(), and llvm::Type::isFPOrFPVectorTy().

Referenced by llvm::TargetFolder::CreateFPCast(), llvm::ConstantFolder::CreateFPCast(), and LLVMConstFPCast().

◆ getFPExtend()

Constant * ConstantExpr::getFPExtend ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getFPToSI()

Constant * ConstantExpr::getFPToSI ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getFPToUI()

Constant * ConstantExpr::getFPToUI ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getFPTrunc()

Constant * ConstantExpr::getFPTrunc ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getFRem()

Constant * ConstantExpr::getFRem ( Constant C1,
Constant C2 
)
static

Definition at line 2745 of file Constants.cpp.

References C1, and get().

Referenced by llvm::TargetFolder::CreateFRem(), llvm::ConstantFolder::CreateFRem(), and LLVMConstFRem().

◆ getFSub()

Constant * ConstantExpr::getFSub ( Constant C1,
Constant C2 
)
static

◆ getGetElementPtr() [1/3]

static Constant* llvm::ConstantExpr::getGetElementPtr ( Type Ty,
Constant C,
ArrayRef< Constant * >  IdxList,
bool  InBounds = false,
Optional< unsigned >  InRangeIndex = None,
Type OnlyIfReducedTy = nullptr 
)
inlinestatic

◆ getGetElementPtr() [2/3]

Constant * ConstantExpr::getGetElementPtr ( Type Ty,
Constant C,
ArrayRef< Value * >  IdxList,
bool  InBounds = false,
Optional< unsigned >  InRangeIndex = None,
Type OnlyIfReducedTy = nullptr 
)
static

◆ getGetElementPtr() [3/3]

static Constant* llvm::ConstantExpr::getGetElementPtr ( Type Ty,
Constant C,
Constant Idx,
bool  InBounds = false,
Optional< unsigned >  InRangeIndex = None,
Type OnlyIfReducedTy = nullptr 
)
inlinestatic

Definition at line 1219 of file Constants.h.

◆ getICmp()

Constant * ConstantExpr::getICmp ( unsigned short  pred,
Constant LHS,
Constant RHS,
bool  OnlyIfReduced = false 
)
static

◆ getInBoundsGetElementPtr() [1/3]

static Constant* llvm::ConstantExpr::getInBoundsGetElementPtr ( Type Ty,
Constant C,
ArrayRef< Constant * >  IdxList 
)
inlinestatic

Create an "inbounds" getelementptr.

See the documentation for the "inbounds" flag in LangRef.html for details.

Definition at line 1237 of file Constants.h.

Referenced by llvm::IRBuilderBase::CreateGlobalStringPtr(), llvm::TargetFolder::CreateInBoundsGetElementPtr(), llvm::ConstantFolder::CreateInBoundsGetElementPtr(), llvm::NoFolder::CreateInBoundsGetElementPtr(), FoldBitCast(), and LLVMConstInBoundsGEP().

◆ getInBoundsGetElementPtr() [2/3]

static Constant* llvm::ConstantExpr::getInBoundsGetElementPtr ( Type Ty,
Constant C,
ArrayRef< Value * >  IdxList 
)
inlinestatic

Definition at line 1248 of file Constants.h.

◆ getInBoundsGetElementPtr() [3/3]

static Constant* llvm::ConstantExpr::getInBoundsGetElementPtr ( Type Ty,
Constant C,
Constant Idx 
)
inlinestatic

Definition at line 1241 of file Constants.h.

◆ getIndices()

ArrayRef< unsigned > ConstantExpr::getIndices ( ) const

Assert that this is an insertvalue or exactvalue expression and return the list of indices.

Definition at line 1517 of file Constants.cpp.

Referenced by getAsInstruction(), and getWithOperands().

◆ getInsertElement()

Constant * ConstantExpr::getInsertElement ( Constant Vec,
Constant Elt,
Constant Idx,
Type OnlyIfReducedTy = nullptr 
)
static

◆ getInsertValue()

Constant * ConstantExpr::getInsertValue ( Constant Agg,
Constant Val,
ArrayRef< unsigned >  Idxs,
Type OnlyIfReducedTy = nullptr 
)
static

◆ getIntegerCast()

Constant * ConstantExpr::getIntegerCast ( Constant C,
Type Ty,
bool  IsSigned 
)
static

◆ getIntToPtr()

Constant * ConstantExpr::getIntToPtr ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getLShr()

Constant * ConstantExpr::getLShr ( Constant C1,
Constant C2,
bool  isExact = false 
)
static

◆ getMul()

Constant * ConstantExpr::getMul ( Constant C1,
Constant C2,
bool  HasNUW = false,
bool  HasNSW = false 
)
static

◆ getNeg()

Constant * ConstantExpr::getNeg ( Constant C,
bool  HasNUW = false,
bool  HasNSW = false 
)
static

◆ getNot()

Constant * ConstantExpr::getNot ( Constant C)
static

◆ getNSWAdd()

static Constant* llvm::ConstantExpr::getNSWAdd ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1028 of file Constants.h.

References C1.

Referenced by LLVMConstNSWAdd().

◆ getNSWMul()

static Constant* llvm::ConstantExpr::getNSWMul ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1044 of file Constants.h.

References C1.

Referenced by LLVMConstNSWMul().

◆ getNSWNeg()

static Constant* llvm::ConstantExpr::getNSWNeg ( Constant C)
inlinestatic

Definition at line 1025 of file Constants.h.

Referenced by LLVMConstNSWNeg().

◆ getNSWShl()

static Constant* llvm::ConstantExpr::getNSWShl ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1052 of file Constants.h.

References C1.

◆ getNSWSub()

static Constant* llvm::ConstantExpr::getNSWSub ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1036 of file Constants.h.

References C1.

Referenced by LLVMConstNSWSub().

◆ getNUWAdd()

static Constant* llvm::ConstantExpr::getNUWAdd ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1032 of file Constants.h.

References C1.

Referenced by LLVMConstNUWAdd().

◆ getNUWMul()

static Constant* llvm::ConstantExpr::getNUWMul ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1048 of file Constants.h.

References C1.

Referenced by LLVMConstNUWMul().

◆ getNUWNeg()

static Constant* llvm::ConstantExpr::getNUWNeg ( Constant C)
inlinestatic

Definition at line 1026 of file Constants.h.

Referenced by LLVMConstNUWNeg().

◆ getNUWShl()

static Constant* llvm::ConstantExpr::getNUWShl ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1056 of file Constants.h.

References C1.

Referenced by llvm::InstCombinerImpl::foldICmpAndConstConst().

◆ getNUWSub()

static Constant* llvm::ConstantExpr::getNUWSub ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 1040 of file Constants.h.

References C1.

Referenced by LLVMConstNUWSub().

◆ getOffsetOf() [1/2]

Constant * ConstantExpr::getOffsetOf ( StructType STy,
unsigned  FieldNo 
)
static

getOffsetOf constant expr - computes the offset of a struct field in a target independent way (Note: the return type is an i64).

Definition at line 2380 of file Constants.cpp.

References llvm::ConstantInt::get(), llvm::Type::getContext(), and llvm::Type::getInt32Ty().

◆ getOffsetOf() [2/2]

Constant * ConstantExpr::getOffsetOf ( Type Ty,
Constant FieldNo 
)
static

getOffsetOf constant expr - This is a generalized form of getOffsetOf, which supports any aggregate type, and any Constant index.

Definition at line 2385 of file Constants.cpp.

References GEP, llvm::ConstantInt::get(), llvm::Type::getContext(), getGetElementPtr(), llvm::Type::getInt64Ty(), llvm::Constant::getNullValue(), getPtrToInt(), and llvm::PointerType::getUnqual().

◆ getOpcode()

unsigned llvm::ConstantExpr::getOpcode ( ) const
inline

Return the opcode at the root of this constant expression.

Definition at line 1267 of file Constants.h.

Referenced by evaluateFCmpRelation(), evaluateICmpRelation(), getAsInstruction(), getOpcodeName(), getWithOperands(), hasIndices(), isCast(), isCompare(), and isGEPWithNoNotionalOverIndexing().

◆ getOpcodeName()

const char * ConstantExpr::getOpcodeName ( ) const

Return a string representation for an opcode.

Definition at line 2878 of file Constants.cpp.

References getOpcode(), and llvm::Instruction::getOpcodeName().

◆ getOr()

Constant * ConstantExpr::getOr ( Constant C1,
Constant C2 
)
static

◆ getPointerBitCastOrAddrSpaceCast()

Constant * ConstantExpr::getPointerBitCastOrAddrSpaceCast ( Constant C,
Type Ty 
)
static

Create a BitCast or AddrSpaceCast for a pointer type depending on the address space.

Parameters
CThe constant to addrspacecast or bitcast
TyThe type to bitcast or addrspacecast C to

Definition at line 2060 of file Constants.cpp.

References assert(), getAddrSpaceCast(), getBitCast(), llvm::Type::getPointerAddressSpace(), llvm::Type::isPtrOrPtrVectorTy(), and S.

Referenced by appendToUsedList(), llvm::ConstantFolder::CreatePointerBitCastOrAddrSpaceCast(), llvm::TargetFolder::CreatePointerBitCastOrAddrSpaceCast(), llvm::EmbedBitcodeInModule(), llvm::InstCombinerImpl::foldGEPICmp(), and setUsedInitializer().

◆ getPointerCast()

Constant * ConstantExpr::getPointerCast ( Constant C,
Type Ty 
)
static

◆ getPredicate()

unsigned ConstantExpr::getPredicate ( ) const

Return the ICMP or FCMP predicate value.

Assert if this is not an ICMP or FCMP constant expression.

Definition at line 1525 of file Constants.cpp.

Referenced by getAsInstruction(), and getWithOperands().

◆ getPtrToInt()

Constant * ConstantExpr::getPtrToInt ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getSDiv()

Constant * ConstantExpr::getSDiv ( Constant C1,
Constant C2,
bool  isExact = false 
)
static

◆ getSelect()

Constant * ConstantExpr::getSelect ( Constant C,
Constant V1,
Constant V2,
Type OnlyIfReducedTy = nullptr 
)
static

◆ getSExt()

Constant * ConstantExpr::getSExt ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getSExtOrBitCast()

Constant * ConstantExpr::getSExtOrBitCast ( Constant C,
Type Ty 
)
static
Parameters
CThe constant to sext or bitcast
TyThe type to sext or bitcast C to

Definition at line 2033 of file Constants.cpp.

References getBitCast(), llvm::Type::getScalarSizeInBits(), and getSExt().

Referenced by llvm::TargetFolder::CreateSExtOrBitCast(), llvm::ConstantFolder::CreateSExtOrBitCast(), foldGEPOfGEP(), getAsConstantIndexedAddress(), and LLVMConstSExtOrBitCast().

◆ getShl()

Constant * ConstantExpr::getShl ( Constant C1,
Constant C2,
bool  HasNUW = false,
bool  HasNSW = false 
)
static

◆ getShuffleMask()

ArrayRef< int > ConstantExpr::getShuffleMask ( ) const

Assert that this is a shufflevector and return the mask.

See class ShuffleVectorInst for a description of the mask representation.

Definition at line 1529 of file Constants.cpp.

Referenced by getAsInstruction(), and getWithOperands().

◆ getShuffleMaskForBitcode()

Constant * ConstantExpr::getShuffleMaskForBitcode ( ) const

Assert that this is a shufflevector and return the mask.

TODO: This is a temporary hack until we update the bitcode format for shufflevector.

Definition at line 1533 of file Constants.cpp.

◆ getShuffleVector()

Constant * ConstantExpr::getShuffleVector ( Constant V1,
Constant V2,
ArrayRef< int Mask,
Type OnlyIfReducedTy = nullptr 
)
static

◆ getSIToFP()

Constant * ConstantExpr::getSIToFP ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getSizeOf()

Constant * ConstantExpr::getSizeOf ( Type Ty)
static

getSizeOf constant expr - computes the (alloc) size of a type (in address-units, not bits) in a target independent way (Note: the return type is an i64).

Definition at line 2357 of file Constants.cpp.

References GEP, llvm::ConstantInt::get(), llvm::Type::getContext(), getGetElementPtr(), llvm::Type::getInt32Ty(), llvm::Type::getInt64Ty(), llvm::Constant::getNullValue(), getPtrToInt(), and llvm::PointerType::getUnqual().

Referenced by llvm::IRBuilderBase::CreatePtrDiff(), LLVMBuildArrayMalloc(), LLVMBuildMalloc(), and LLVMSizeOf().

◆ getSRem()

Constant * ConstantExpr::getSRem ( Constant C1,
Constant C2 
)
static

◆ getSub()

Constant * ConstantExpr::getSub ( Constant C1,
Constant C2,
bool  HasNUW = false,
bool  HasNSW = false 
)
static

◆ getTrunc()

Constant * ConstantExpr::getTrunc ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getTruncOrBitCast()

Constant * ConstantExpr::getTruncOrBitCast ( Constant C,
Type Ty 
)
static
Parameters
CThe constant to trunc or bitcast
TyThe type to trunc or bitcast C to

Definition at line 2039 of file Constants.cpp.

References getBitCast(), llvm::Type::getScalarSizeInBits(), and getTrunc().

Referenced by llvm::TargetFolder::CreateTruncOrBitCast(), llvm::ConstantFolder::CreateTruncOrBitCast(), LLVMBuildArrayMalloc(), LLVMBuildMalloc(), and LLVMConstTruncOrBitCast().

◆ getUDiv()

Constant * ConstantExpr::getUDiv ( Constant C1,
Constant C2,
bool  isExact = false 
)
static

◆ getUIToFP()

Constant * ConstantExpr::getUIToFP ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getUMin()

Constant * ConstantExpr::getUMin ( Constant C1,
Constant C2 
)
static

Definition at line 2761 of file Constants.cpp.

References C1, getICmp(), getSelect(), and llvm::CmpInst::ICMP_ULT.

Referenced by llvm::InstCombinerImpl::visitTrunc().

◆ getURem()

Constant * ConstantExpr::getURem ( Constant C1,
Constant C2 
)
static

◆ getWithOperands() [1/2]

Constant* llvm::ConstantExpr::getWithOperands ( ArrayRef< Constant * >  Ops) const
inline

This returns the current constant expression with the operands replaced with the specified values.

The specified array must have the same number of operands as our current one.

Definition at line 1293 of file Constants.h.

References llvm::Intrinsic::getType().

◆ getWithOperands() [2/2]

Constant * ConstantExpr::getWithOperands ( ArrayRef< Constant * >  Ops,
Type Ty,
bool  OnlyIfReduced = false,
Type SrcTy = nullptr 
) const

Get the current expression with the operands replaced.

Return the current constant expression with the operands replaced with Ops and the type with Ty. The new operands must have the same number as the current ones.

If OnlyIfReduced is true, nullptr will be returned unless something gets constant-folded, the type changes, or the expression is otherwise canonicalized. This parameter should almost always be false.

Definition at line 1537 of file Constants.cpp.

References assert(), llvm::ArrayRef< T >::begin(), llvm::ArrayRef< T >::end(), llvm::lltok::equal, get(), getCast(), getCompare(), getExtractElement(), getExtractValue(), getFNeg(), getGetElementPtr(), getIndices(), getInsertElement(), getInsertValue(), llvm::User::getNumOperands(), getOpcode(), llvm::User::getOperand(), getPredicate(), getSelect(), getShuffleMask(), getShuffleVector(), llvm::Value::getType(), llvm::User::op_begin(), llvm::MCID::Select, llvm::ArrayRef< T >::size(), llvm::ArrayRef< T >::slice(), and llvm::Value::SubclassOptionalData.

◆ getXor()

Constant * ConstantExpr::getXor ( Constant C1,
Constant C2 
)
static

◆ getZExt()

Constant * ConstantExpr::getZExt ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static

◆ getZExtOrBitCast()

Constant * ConstantExpr::getZExtOrBitCast ( Constant C,
Type Ty 
)
static

◆ hasIndices()

bool ConstantExpr::hasIndices ( ) const

Return true if this is an insertvalue or extractvalue expression, and the getIndices() method may be used.

Definition at line 1512 of file Constants.cpp.

References getOpcode().

◆ isCast()

bool ConstantExpr::isCast ( ) const

Return true if this is a convert constant expression.

Definition at line 1482 of file Constants.cpp.

References getOpcode(), and llvm::Instruction::isCast().

◆ isCompare()

bool ConstantExpr::isCompare ( ) const

Return true if this is a compare constant expression.

Definition at line 1486 of file Constants.cpp.

References getOpcode().

◆ isGEPWithNoNotionalOverIndexing()

bool ConstantExpr::isGEPWithNoNotionalOverIndexing ( ) const

Return true if this is a getelementptr expression and all the index operands are compile-time known integers within the corresponding notional static array extents.

Note that this is not equivalant to, a subset of, or a superset of the "inbounds" property.

Definition at line 1490 of file Constants.cpp.

References E, llvm::gep_type_begin(), llvm::gep_type_end(), getOpcode(), llvm::generic_gep_type_iterator< ItTy >::getSequentialNumElements(), llvm::generic_gep_type_iterator< ItTy >::isBoundedSequential(), and llvm::User::op_begin().

Referenced by evaluateICmpRelation().

Friends And Related Function Documentation

◆ Constant

friend class Constant
friend

Definition at line 938 of file Constants.h.

◆ ConstantExprKeyType

friend struct ConstantExprKeyType
friend

Definition at line 937 of file Constants.h.


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