LLVM  6.0.0svn
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< unsignedgetIndices () const
 Assert that this is an insertvalue or exactvalue expression and return the list of indices. More...
 
const chargetOpcodeName () const
 Return a string representation for an opcode. More...
 
ConstantgetWithOperandReplaced (unsigned OpNo, Constant *Op) const
 Return a constant expression identical to this one, but with the specified operand set to the specified value. 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 ()
 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 isAllOnesValue () const
 Return true if this is the value that would be returned by getAllOnesValue. More...
 
bool isNegativeZeroValue () const
 Return true if the value is what would be returned by getZeroValueForNegation. More...
 
bool isZeroValue () const
 Return true if the value is negative zero or null value. More...
 
bool isNotMinSignedValue () const
 Return true if the value is not the smallest signed value. More...
 
bool isMinSignedValue () const
 Return true if the value is the smallest signed value. More...
 
bool canTrap () const
 Return true if evaluation of this constant could trap. More...
 
bool isThreadDependent () const
 Return true if the value can vary between threads. More...
 
bool isDLLImportDependent () const
 Return true if the value is dependent on a dllimport variable. More...
 
bool isConstantUsed () const
 Return true if the constant has users other than constant expressions and other dangling things. More...
 
bool needsRelocation () const
 This method classifies the entry according to whether or not it may generate a relocation entry. More...
 
ConstantgetAggregateElement (unsigned Elt) const
 For aggregates (struct/array/vector) return the constant that corresponds to the specified element if possible, or null if not. More...
 
ConstantgetAggregateElement (Constant *Elt) const
 
ConstantgetSplatValue () const
 If this is a splat vector constant, meaning that all of the elements have the same value, return that value. More...
 
const APIntgetUniqueInteger () const
 If C is a constant integer then return its value, otherwise C must be a vector of constant integers, all equal, and the common value is returned. More...
 
void destroyConstant ()
 Called if some element of this constant is no longer valid. More...
 
void handleOperandChange (Value *, Value *)
 This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants. More...
 
void removeDeadConstantUsers () const
 If there are any dead constant users dangling off of this constant, remove them. More...
 
const ConstantstripPointerCasts () const
 
ConstantstripPointerCasts ()
 
- Public Member Functions inherited from llvm::User
 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *, unsigned)
 Placement delete - required by std, but never called. More...
 
void operator delete (void *, unsigned, bool)
 Placement delete - required by std, but never called. More...
 
const UsegetOperandList () const
 
UsegetOperandList ()
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
ArrayRef< const uint8_t > getDescriptor () const
 Returns the descriptor co-allocated with this User instance. More...
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance. More...
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
const_value_op_iterator value_op_begin () const
 
const_value_op_iterator value_op_end () const
 
iterator_range< const_value_op_iteratoroperand_values () const
 
void dropAllReferences ()
 Drop all references to operands. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value. More...
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
use_iterator materialized_use_begin ()
 
const_use_iterator materialized_use_begin () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
bool user_empty () const
 
user_iterator materialized_user_begin ()
 
const_user_iterator materialized_user_begin () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one user of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N users. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N users or more. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndBarriers () const
 Strip off pointer casts, all-zero GEPs, aliases and barriers. More...
 
ValuestripPointerCastsAndBarriers ()
 
const ValuestripPointerCastsNoFollowAliases () const
 Strip off pointer casts and all-zero GEPs. More...
 
ValuestripPointerCastsNoFollowAliases ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets () const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets ()
 
unsigned getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
 
unsigned getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 

Static Public Member Functions

static 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)
 Return the identity for the given binary operation, i.e. 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, 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, 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)
 Constructor to create a '0' constant of arbitrary type. More...
 
static ConstantgetAllOnesValue (Type *Ty)
 Get the all ones value. More...
 
static ConstantgetIntegerValue (Type *Ty, const APInt &V)
 Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value. More...
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 

Protected Member Functions

 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...
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
 ~User ()=default
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 

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 const unsigned MaxAlignmentExponent = 29
 The maximum alignment for instructions. More...
 
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 28 }
 The number of operands in the subclass. More...
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ConstantExpr()

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

Definition at line 870 of file Constants.h.

References C, and llvm::Value::setValueSubclassData().

Member Function Documentation

◆ classof()

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

◆ DECLARE_TRANSPARENT_OPERAND_ACCESSORS()

llvm::ConstantExpr::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Constant  )

Transparently provide more efficient getOperand methods.

◆ get()

Constant * ConstantExpr::get ( unsigned  Opcode,
Constant C1,
Constant C2,
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 1801 of file Constants.cpp.

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

Referenced by getFoldedAlignOf(), and 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 ( )

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

References llvm::LLVMContextImpl::ExprConstants, llvm::Constant::getAllOnesValue(), llvm::Type::getContext(), llvm::Constant::getNullValue(), llvm::Value::getType(), and llvm::LLVMContext::pImpl.

Referenced by buildMultiplyTree().

◆ getBinOpIdentity()

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

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

References llvm::MCID::Add, llvm::ConstantInt::get(), llvm::Constant::getAllOnesValue(), and llvm::Constant::getNullValue().

Referenced by buildMultiplyTree(), getBinOpsForFactorization(), getIdentityValue(), and LinearizeExprTree().

◆ 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

◆ getExactAShr()

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

Definition at line 990 of file Constants.h.

◆ getExactLShr()

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

◆ getExactSDiv()

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

Definition at line 982 of file Constants.h.

Referenced by LLVMConstExactSDiv().

◆ getExactUDiv()

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

Definition at line 986 of file Constants.h.

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

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

References assert(), C, llvm::Type::getScalarSizeInBits(), llvm::Value::getType(), 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

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

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

References llvm::None.

◆ getGetElementPtr() [3/3]

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

◆ 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 1142 of file Constants.h.

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

◆ getInBoundsGetElementPtr() [2/3]

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

Definition at line 1146 of file Constants.h.

◆ getInBoundsGetElementPtr() [3/3]

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

Definition at line 1153 of file Constants.h.

References llvm::BitmaskEnumDetail::Mask().

◆ getIndices()

ArrayRef< unsigned > ConstantExpr::getIndices ( ) const

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

Definition at line 1085 of file Constants.cpp.

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

◆ 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 950 of file Constants.h.

Referenced by LLVMConstNSWAdd().

◆ getNSWMul()

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

Definition at line 966 of file Constants.h.

Referenced by LLVMConstNSWMul().

◆ getNSWNeg()

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

Definition at line 947 of file Constants.h.

Referenced by LLVMConstNSWNeg().

◆ getNSWShl()

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

Definition at line 974 of file Constants.h.

◆ getNSWSub()

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

Definition at line 958 of file Constants.h.

Referenced by LLVMConstNSWSub().

◆ getNUWAdd()

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

Definition at line 954 of file Constants.h.

Referenced by LLVMConstNUWAdd().

◆ getNUWMul()

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

Definition at line 970 of file Constants.h.

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

◆ getNUWNeg()

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

Definition at line 948 of file Constants.h.

Referenced by LLVMConstNUWNeg().

◆ getNUWShl()

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

Definition at line 978 of file Constants.h.

Referenced by processUGT_ADDCST_ADD().

◆ getNUWSub()

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

Definition at line 962 of file Constants.h.

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

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

Referenced by getFoldedOffsetOf().

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

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

◆ getOpcode()

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

◆ getOpcodeName()

const char * ConstantExpr::getOpcodeName ( ) const

Return a string representation for an opcode.

Definition at line 2242 of file Constants.cpp.

References E, llvm::GetElementPtrInst::getIndexedType(), llvm::Instruction::getOpcodeName(), llvm::User::getOperandList(), and llvm::ArrayRef< T >::size().

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

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

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

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

Referenced by INITIALIZE_PASS(), llvm::ConstantExprKeyType::operator==(), and llvm::Interpreter::visitInsertValueInst().

◆ 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

◆ getShl()

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

◆ getShuffleVector()

Constant * ConstantExpr::getShuffleVector ( Constant V1,
Constant V2,
Constant 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 1791 of file Constants.cpp.

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

Referenced by llvm::IRBuilder< TargetFolder >::CreatePtrDiff(), getFoldedSizeOf(), 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 1486 of file Constants.cpp.

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

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

◆ getURem()

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

◆ getWithOperandReplaced()

Constant * ConstantExpr::getWithOperandReplaced ( unsigned  OpNo,
Constant Op 
) const

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

Definition at line 1098 of file Constants.cpp.

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

◆ 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 1191 of file Constants.h.

References llvm::Value::getType().

Referenced by cloneConstantExprWithNewAddressSpace().

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

References assert(), llvm::ArrayRef< T >::begin(), llvm::ArrayRef< T >::end(), llvm::lltok::equal, get(), getCast(), getCompare(), getExtractElement(), getExtractValue(), getGetElementPtr(), getInsertElement(), getInsertValue(), llvm::User::getNumOperands(), llvm::User::getOperand(), getSelect(), 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
Parameters
CThe constant to zext or bitcast
TyThe type to zext or bitcast C to

Definition at line 1474 of file Constants.cpp.

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

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

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

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

◆ isCast()

bool ConstantExpr::isCast ( ) const

Return true if this is a convert constant expression.

Definition at line 1050 of file Constants.cpp.

References llvm::Instruction::isCast().

Referenced by foldConstantCastPair(), and llvm::NVPTXTargetLowering::getPrototype().

◆ isCompare()

bool ConstantExpr::isCompare ( ) const

Return true if this is a compare constant expression.

Definition at line 1054 of file Constants.cpp.

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

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

References llvm::dyn_cast(), E, llvm::gep_type_begin(), llvm::gep_type_end(), 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 864 of file Constants.h.

◆ ConstantExprKeyType

friend struct ConstantExprKeyType
friend

Definition at line 863 of file Constants.h.


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