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

ConstantExpr - a constant value that is initialized with an expression using other constant values. More...

#include <Constants.h>

Inheritance diagram for llvm::ConstantExpr:
[legend]
Collaboration diagram for llvm::ConstantExpr:
[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
 getOpcode - Return the opcode at the root of this constant expression More...
 
unsigned getPredicate () const
 getPredicate - Return the ICMP or FCMP predicate value. More...
 
ArrayRef< unsignedgetIndices () const
 getIndices - Assert that this is an insertvalue or exactvalue expression and return the list of indices. More...
 
const char * getOpcodeName () const
 getOpcodeName - Return a string representation for an opcode. More...
 
ConstantgetWithOperandReplaced (unsigned OpNo, Constant *Op) const
 getWithOperandReplaced - Return a constant expression identical to this one, but with the specified operand set to the specified value. More...
 
ConstantgetWithOperands (ArrayRef< Constant * > Ops) const
 getWithOperands - This returns the current constant expression with the operands replaced with the specified values. More...
 
ConstantgetWithOperands (ArrayRef< Constant * > Ops, Type *Ty, bool OnlyIfReduced=false) const
 Get the current expression with the operands replaced. More...
 
InstructiongetAsInstruction ()
 getAsInstruction - Returns an Instruction which implements the same operation as this ConstantExpr. More...
 
- Public Member Functions inherited from llvm::Constant
bool isNullValue () const
 isNullValue - 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
 isAllOnesValue - Return true if this is the value that would be returned by getAllOnesValue. More...
 
bool isNegativeZeroValue () const
 isNegativeZeroValue - 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
 canTrap - Return true if evaluation of this constant could trap. More...
 
bool isThreadDependent () const
 isThreadDependent - 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
 isConstantUsed - Return true if the constant has users other than constant exprs and other dangling things. More...
 
PossibleRelocationsTy getRelocationInfo () const
 getRelocationInfo - This method classifies the entry according to whether or not it may generate a relocation entry. More...
 
ConstantgetAggregateElement (unsigned Elt) const
 getAggregateElement - 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
 getSplatValue - 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 *, Use *)
 This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants. More...
 
void removeDeadConstantUsers () const
 removeDeadConstantUsers - If there are any dead constant users dangling off of this constant, remove them. More...
 
ConstantstripPointerCasts ()
 
const ConstantstripPointerCasts () const
 
- Public Member Functions inherited from llvm::User
 ~User () override
 
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...
 
UsegetOperandList ()
 
const UsegetOperandList () const
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setFunctionNumOperands (unsigned NumOps)
 Set the number of operands on a Function. 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 ()
 
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
virtual ~Value ()
 
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 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...
 
bool use_empty () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratoruses ()
 
iterator_range
< const_use_iterator
uses () const
 
bool user_empty () 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_iteratorusers ()
 
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...
 
void intersectOptionalDataWith (const Value *V)
 Clear any optional flags not set in the given Value. 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...
 
ValuestripPointerCasts ()
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
const ValuestripPointerCasts () const
 
ValuestripPointerCastsNoFollowAliases ()
 Strip off pointer casts and all-zero GEPs. More...
 
const ValuestripPointerCastsNoFollowAliases () const
 
ValuestripInBoundsConstantOffsets ()
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
const ValuestripInBoundsConstantOffsets () const
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 
ValuestripInBoundsOffsets ()
 Strip off pointer casts and inbounds GEPs. More...
 
const ValuestripInBoundsOffsets () const
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 Translate PHI node to its predecessor from the given basic block. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 
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) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST) 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 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 ConstantgetBinOpIdentity (unsigned Opcode, Type *Ty)
 getBinOpIdentity - Return the identity for the given binary operation, i.e. More...
 
static ConstantgetBinOpAbsorber (unsigned Opcode, Type *Ty)
 getBinOpAbsorber - 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, 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, Type *OnlyIfReducedTy=nullptr)
 Getelementptr form. More...
 
static ConstantgetGetElementPtr (Type *Ty, Constant *C, Constant *Idx, bool InBounds=false, Type *OnlyIfReducedTy=nullptr)
 
static ConstantgetGetElementPtr (Type *Ty, Constant *C, ArrayRef< Value * > IdxList, bool InBounds=false, 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, Constant *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)
 
static ConstantgetAllOnesValue (Type *Ty)
 Get the all ones value. More...
 
static ConstantgetIntegerValue (Type *Ty, const APInt &V)
 getIntegerValue - 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

 ConstantExpr (Type *ty, unsigned Opcode, Use *Ops, unsigned NumOps)
 
- Protected Member Functions inherited from llvm::Constant
 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...
 
 User (Type *ty, unsigned vty, Use *OpList, 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...
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 

Friends

struct ConstantExprKeyType
 
class Constant
 

Additional Inherited Members

- Public Types inherited from llvm::Constant
enum  PossibleRelocationsTy { NoRelocation = 0, LocalRelocation = 1, GlobalRelocations = 2 }
 
- Public Types inherited from llvm::User
typedef Useop_iterator
 
typedef const Useconst_op_iterator
 
typedef iterator_range
< op_iterator
op_range
 
typedef iterator_range
< const_op_iterator
const_op_range
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
typedef use_iterator_impl< Useuse_iterator
 
typedef use_iterator_impl
< const Use
const_use_iterator
 
typedef user_iterator_impl< Useruser_iterator
 
typedef user_iterator_impl
< const User
const_user_iterator
 
- 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 = 29 }
 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
 
bool IsUsedByMD: 1
 
bool HasName: 1
 
bool HasHungOffUses: 1
 

Detailed Description

ConstantExpr - 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 852 of file Constants.h.

Constructor & Destructor Documentation

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

Definition at line 860 of file Constants.h.

Member Function Documentation

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

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

Definition at line 1191 of file Constants.h.

References llvm::Value::getValueID().

llvm::ConstantExpr::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Constant  )

Transparently provide more efficient getOperand methods.

Constant * ConstantExpr::get ( unsigned  Opcode,
Constant C1,
Constant C2,
unsigned  Flags = 0,
Type OnlyIfReducedTy = nullptr 
)
static
Constant * ConstantExpr::getAdd ( Constant C1,
Constant C2,
bool  HasNUW = false,
bool  HasNSW = false 
)
static
Constant * ConstantExpr::getAddrSpaceCast ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
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 1958 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(), getPtrToInt(), and One.

Referenced by getFoldedAlignOf(), and LLVMAlignOf().

Constant * ConstantExpr::getAnd ( Constant C1,
Constant C2 
)
static
Constant * ConstantExpr::getAShr ( Constant C1,
Constant C2,
bool  isExact = false 
)
static
Instruction * ConstantExpr::getAsInstruction ( )
Constant * ConstantExpr::getBinOpAbsorber ( unsigned  Opcode,
Type Ty 
)
static

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

References llvm::APIntOps::And(), llvm::Constant::getAllOnesValue(), llvm::Constant::getNullValue(), and llvm::APIntOps::Or().

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

getBinOpIdentity - Return the identity for the given binary operation, i.e.

a constant C such that X op C = X and C op X = X for every X. It returns null if the operator doesn't have an identity.

Definition at line 2349 of file Constants.cpp.

References llvm::APIntOps::And(), llvm::ConstantInt::get(), llvm::Constant::getAllOnesValue(), llvm::Constant::getNullValue(), llvm::APIntOps::Or(), and llvm::APIntOps::Xor().

Referenced by LinearizeExprTree().

Constant * ConstantExpr::getBitCast ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getCast ( unsigned  ops,
Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getCompare ( unsigned short  pred,
Constant C1,
Constant C2,
bool  OnlyIfReduced = false 
)
static
static Constant* llvm::ConstantExpr::getExactAShr ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 969 of file Constants.h.

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

Definition at line 972 of file Constants.h.

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

Definition at line 963 of file Constants.h.

Referenced by LLVMConstExactSDiv().

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

Definition at line 966 of file Constants.h.

Constant * ConstantExpr::getExtractElement ( Constant Vec,
Constant Idx,
Type OnlyIfReducedTy = nullptr 
)
static
Constant * ConstantExpr::getExtractValue ( Constant Agg,
ArrayRef< unsigned Idxs,
Type OnlyIfReducedTy = nullptr 
)
static
Constant * ConstantExpr::getFAdd ( Constant C1,
Constant C2 
)
static
Constant * ConstantExpr::getFCmp ( unsigned short  pred,
Constant LHS,
Constant RHS,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getFDiv ( Constant C1,
Constant C2 
)
static
Constant * ConstantExpr::getFMul ( Constant C1,
Constant C2 
)
static
Constant * ConstantExpr::getFNeg ( Constant C)
static
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 1687 of file Constants.cpp.

References llvm::C, getCast(), llvm::Type::getScalarSizeInBits(), llvm::Value::getType(), and llvm::Type::isFPOrFPVectorTy().

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

Constant * ConstantExpr::getFPExtend ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getFPToSI ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getFPToUI ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getFPTrunc ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getFRem ( Constant C1,
Constant C2 
)
static
Constant * ConstantExpr::getFSub ( Constant C1,
Constant C2 
)
static
static Constant* llvm::ConstantExpr::getGetElementPtr ( Type Ty,
Constant C,
ArrayRef< Constant * >  IdxList,
bool  InBounds = false,
Type OnlyIfReducedTy = nullptr 
)
inlinestatic
static Constant* llvm::ConstantExpr::getGetElementPtr ( Type Ty,
Constant C,
Constant Idx,
bool  InBounds = false,
Type OnlyIfReducedTy = nullptr 
)
inlinestatic

Definition at line 1100 of file Constants.h.

Constant * ConstantExpr::getGetElementPtr ( Type Ty,
Constant C,
ArrayRef< Value * >  IdxList,
bool  InBounds = false,
Type OnlyIfReducedTy = nullptr 
)
static
Constant * ConstantExpr::getICmp ( unsigned short  pred,
Constant LHS,
Constant RHS,
bool  OnlyIfReduced = false 
)
static
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 1115 of file Constants.h.

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

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

Definition at line 1119 of file Constants.h.

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

Definition at line 1126 of file Constants.h.

ArrayRef< unsigned > ConstantExpr::getIndices ( ) const

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

Definition at line 1215 of file Constants.cpp.

Referenced by getAsInstruction(), getWithOperands(), and llvm::ConstantExprKeyType::operator==().

Constant * ConstantExpr::getInsertElement ( Constant Vec,
Constant Elt,
Constant Idx,
Type OnlyIfReducedTy = nullptr 
)
static
Constant * ConstantExpr::getInsertValue ( Constant Agg,
Constant Val,
ArrayRef< unsigned Idxs,
Type OnlyIfReducedTy = nullptr 
)
static
Constant * ConstantExpr::getIntegerCast ( Constant C,
Type Ty,
bool  isSigned 
)
static
Constant * ConstantExpr::getIntToPtr ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getLShr ( Constant C1,
Constant C2,
bool  isExact = false 
)
static
Constant * ConstantExpr::getMul ( Constant C1,
Constant C2,
bool  HasNUW = false,
bool  HasNSW = false 
)
static
Constant * ConstantExpr::getNeg ( Constant C,
bool  HasNUW = false,
bool  HasNSW = false 
)
static
Constant * ConstantExpr::getNot ( Constant C)
static
static Constant* llvm::ConstantExpr::getNSWAdd ( Constant C1,
Constant C2 
)
inlinestatic

Definition at line 939 of file Constants.h.

Referenced by LLVMConstNSWAdd().

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

Definition at line 951 of file Constants.h.

Referenced by LLVMConstNSWMul().

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

Definition at line 937 of file Constants.h.

Referenced by LLVMConstNSWNeg().

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

Definition at line 957 of file Constants.h.

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

Definition at line 945 of file Constants.h.

Referenced by LLVMConstNSWSub().

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

Definition at line 942 of file Constants.h.

Referenced by LLVMConstNUWAdd().

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

Definition at line 954 of file Constants.h.

Referenced by getFoldedOffsetOf(), getFoldedSizeOf(), and LLVMConstNUWMul().

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

Definition at line 938 of file Constants.h.

Referenced by LLVMConstNUWNeg().

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

Definition at line 960 of file Constants.h.

Referenced by llvm::InstCombiner::visitICmpInstWithInstAndIntCst().

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

Definition at line 948 of file Constants.h.

Referenced by LLVMConstNUWSub().

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

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

Referenced by getFoldedOffsetOf().

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

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

unsigned llvm::ConstantExpr::getOpcode ( ) const
inline
const char * ConstantExpr::getOpcodeName ( ) const

getOpcodeName - Return a string representation for an opcode.

Definition at line 2393 of file Constants.cpp.

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

Constant * ConstantExpr::getOr ( Constant C1,
Constant C2 
)
static
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 1663 of file Constants.cpp.

References getAddrSpaceCast(), getBitCast(), llvm::Type::getPointerAddressSpace(), llvm::Value::getType(), and llvm::Type::isPtrOrPtrVectorTy().

Referenced by llvm::ConstantFolder::CreatePointerBitCastOrAddrSpaceCast(), llvm::TargetFolder::CreatePointerBitCastOrAddrSpaceCast(), setUsedInitializer(), and llvm::InstCombiner::visitAllocaInst().

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

Create a BitCast, AddrSpaceCast, or a PtrToInt cast constant expression.

Parameters
CThe pointer value to be casted (operand 0)
TyThe type to which cast should be made

Definition at line 1648 of file Constants.cpp.

References getAddrSpaceCast(), getBitCast(), llvm::Type::getPointerAddressSpace(), getPtrToInt(), llvm::Value::getType(), llvm::Type::isIntOrIntVectorTy(), and llvm::Type::isPtrOrPtrVectorTy().

Referenced by llvm::ConstantFoldCastInstruction(), llvm::ConstantFolder::CreatePointerCast(), llvm::TargetFolder::CreatePointerCast(), INITIALIZE_PASS(), LLVMConstPointerCast(), and StripPtrCastKeepAS().

unsigned ConstantExpr::getPredicate ( ) const

getPredicate - Return the ICMP or FCMP predicate value.

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

Definition at line 1223 of file Constants.cpp.

References isCompare().

Referenced by ConstantFoldConstantExpressionImpl(), getAsInstruction(), getWithOperands(), and llvm::ConstantExprKeyType::operator==().

Constant * ConstantExpr::getPtrToInt ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getSDiv ( Constant C1,
Constant C2,
bool  isExact = false 
)
static
Constant * ConstantExpr::getSelect ( Constant C,
Constant V1,
Constant V2,
Type OnlyIfReducedTy = nullptr 
)
static
Constant * ConstantExpr::getSExt ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
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 1636 of file Constants.cpp.

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

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

Constant * ConstantExpr::getShl ( Constant C1,
Constant C2,
bool  HasNUW = false,
bool  HasNSW = false 
)
static
Constant * ConstantExpr::getShuffleVector ( Constant V1,
Constant V2,
Constant Mask,
Type OnlyIfReducedTy = nullptr 
)
static
Constant * ConstantExpr::getSIToFP ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
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 1948 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::IRBuilder< true, TargetFolder >::CreatePtrDiff(), getFoldedSizeOf(), LLVMBuildArrayMalloc(), LLVMBuildMalloc(), and LLVMSizeOf().

Constant * ConstantExpr::getSRem ( Constant C1,
Constant C2 
)
static
Constant * ConstantExpr::getSub ( Constant C1,
Constant C2,
bool  HasNUW = false,
bool  HasNSW = false 
)
static
Constant * ConstantExpr::getTrunc ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
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 1642 of file Constants.cpp.

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

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

Constant * ConstantExpr::getUDiv ( Constant C1,
Constant C2,
bool  isExact = false 
)
static
Constant * ConstantExpr::getUIToFP ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getURem ( Constant C1,
Constant C2 
)
static
Constant * ConstantExpr::getWithOperandReplaced ( unsigned  OpNo,
Constant Op 
) const

getWithOperandReplaced - Return a constant expression identical to this one, but with the specified operand set to the specified value.

Definition at line 1231 of file Constants.cpp.

References llvm::User::getNumOperands(), llvm::User::getOperand(), llvm::Value::getType(), getWithOperands(), llvm::User::Op(), and llvm::SmallVectorTemplateBase< T, isPodLike< T >::value >::push_back().

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

getWithOperands - 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 1164 of file Constants.h.

References llvm::Intrinsic::getType().

Referenced by getWithOperandReplaced().

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

Get the current expression with the operands replaced.

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

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.

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

Definition at line 1247 of file Constants.cpp.

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

Constant * ConstantExpr::getXor ( Constant C1,
Constant C2 
)
static
Constant * ConstantExpr::getZExt ( Constant C,
Type Ty,
bool  OnlyIfReduced = false 
)
static
Constant * ConstantExpr::getZExtOrBitCast ( Constant C,
Type Ty 
)
static
Parameters
CThe constant to zext or bitcast
TyThe type to zext or bitcast C to

Definition at line 1630 of file Constants.cpp.

References getBitCast(), llvm::Type::getScalarSizeInBits(), llvm::Value::getType(), and getZExt().

Referenced by llvm::ConstantFolder::CreateZExtOrBitCast(), llvm::TargetFolder::CreateZExtOrBitCast(), and LLVMConstZExtOrBitCast().

bool ConstantExpr::hasIndices ( ) const

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

Definition at line 1210 of file Constants.cpp.

References getOpcode().

Referenced by llvm::ConstantExprKeyType::operator==().

bool ConstantExpr::isCast ( ) const

Return true if this is a convert constant expression.

Definition at line 1177 of file Constants.cpp.

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

Referenced by foldConstantCastPair().

bool ConstantExpr::isCompare ( ) const

Return true if this is a compare constant expression.

Definition at line 1181 of file Constants.cpp.

References getOpcode().

Referenced by ConstantFoldConstantExpressionImpl(), getPredicate(), and llvm::ConstantExprKeyType::operator==().

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

References llvm::dyn_cast(), llvm::gep_type_begin(), llvm::gep_type_end(), llvm::APInt::getActiveBits(), getOpcode(), llvm::ConstantInt::getValue(), llvm::ConstantInt::getZExtValue(), and llvm::User::op_begin().

Referenced by evaluateICmpRelation().

Friends And Related Function Documentation

friend class Constant
friend

Definition at line 855 of file Constants.h.

friend struct ConstantExprKeyType
friend

Definition at line 853 of file Constants.h.


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