LLVM  6.0.0svn
Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::ConstantDataVector Class Referencefinal

A vector constant whose element type is a simple 1/2/4/8-byte integer or float/double, and whose elements are just simple data values (i.e. More...

#include "llvm/IR/Constants.h"

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

Public Member Functions

 ConstantDataVector (const ConstantDataVector &)=delete
 
bool isSplat () const
 Returns true if this is a splat constant, meaning that all elements have the same value. More...
 
ConstantgetSplatValue () const
 If this is a splat constant, meaning that all of the elements have the same value, return that value. More...
 
VectorTypegetType () const
 Specialize the getType() method to always return a VectorType, which reduces the amount of casting needed in parts of the compiler. More...
 
- Public Member Functions inherited from llvm::ConstantDataSequential
 ConstantDataSequential (const ConstantDataSequential &)=delete
 
uint64_t getElementAsInteger (unsigned i) const
 If this is a sequential container of integers (of any size), return the specified element in the low bits of a uint64_t. More...
 
APInt getElementAsAPInt (unsigned i) const
 If this is a sequential container of integers (of any size), return the specified element as an APInt. More...
 
APFloat getElementAsAPFloat (unsigned i) const
 If this is a sequential container of floating point type, return the specified element as an APFloat. More...
 
float getElementAsFloat (unsigned i) const
 If this is an sequential container of floats, return the specified element as a float. More...
 
double getElementAsDouble (unsigned i) const
 If this is an sequential container of doubles, return the specified element as a double. More...
 
ConstantgetElementAsConstant (unsigned i) const
 Return a Constant for a specified index's element. More...
 
SequentialTypegetType () const
 Specialize the getType() method to always return a SequentialType, which reduces the amount of casting needed in parts of the compiler. More...
 
TypegetElementType () const
 Return the element type of the array/vector. More...
 
unsigned getNumElements () const
 Return the number of elements in the array or vector. More...
 
uint64_t getElementByteSize () const
 Return the size (in bytes) of each element in the array/vector. More...
 
bool isString (unsigned CharSize=8) const
 This method returns true if this is an array of CharSize integers. More...
 
bool isCString () const
 This method returns true if the array "isString", ends with a null byte, and does not contains any other null bytes. More...
 
StringRef getAsString () const
 If this array is isString(), then this method returns the array as a StringRef. More...
 
StringRef getAsCString () const
 If this array is isCString(), then this method returns the array (without the trailing null byte) as a StringRef. More...
 
StringRef getRawDataValues () const
 Return the raw, underlying, bytes of this data. More...
 
- Public Member Functions inherited from llvm::ConstantData
 ConstantData (const ConstantData &)=delete
 
- 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 Constantget (LLVMContext &Context, ArrayRef< uint8_t > Elts)
 get() constructors - Return a constant with vector type with an element count and element type matching the ArrayRef passed in. More...
 
static Constantget (LLVMContext &Context, ArrayRef< uint16_t > Elts)
 
static Constantget (LLVMContext &Context, ArrayRef< uint32_t > Elts)
 
static Constantget (LLVMContext &Context, ArrayRef< uint64_t > Elts)
 
static Constantget (LLVMContext &Context, ArrayRef< float > Elts)
 
static Constantget (LLVMContext &Context, ArrayRef< double > Elts)
 
static ConstantgetFP (LLVMContext &Context, ArrayRef< uint16_t > Elts)
 getFP() constructors - Return a constant with vector type with an element count and element type of float with the precision matching the number of bits in the ArrayRef passed in. More...
 
static ConstantgetFP (LLVMContext &Context, ArrayRef< uint32_t > Elts)
 
static ConstantgetFP (LLVMContext &Context, ArrayRef< uint64_t > Elts)
 
static ConstantgetSplat (unsigned NumElts, Constant *Elt)
 Return a ConstantVector with the specified constant in each element. More...
 
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::ConstantDataSequential
static bool isElementTypeCompatible (Type *Ty)
 Return true if a ConstantDataSequential can be formed with a vector or array of the specified element type. More...
 
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::ConstantData
static bool classof (const Value *V)
 Methods to 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)
 

Friends

class ConstantDataSequential
 

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...
 
- Protected Member Functions inherited from llvm::ConstantDataSequential
 ConstantDataSequential (Type *ty, ValueTy VT, const char *Data)
 
 ~ConstantDataSequential ()
 
- Protected Member Functions inherited from llvm::ConstantData
 ConstantData (Type *Ty, ValueTy VT)
 
void * operator new (size_t s)
 
- 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)
 
- Static Protected Member Functions inherited from llvm::ConstantDataSequential
static ConstantgetImpl (StringRef Bytes, Type *Ty)
 This is the underlying implementation of all of the ConstantDataSequential::get methods. 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 vector constant whose element type is a simple 1/2/4/8-byte integer or float/double, and whose elements are just simple data values (i.e.

ConstantInt/ConstantFP). This Constant node has no operands because it stores all of the elements of the constant as densely packed data, instead of as Value*'s.

Definition at line 735 of file Constants.h.

Constructor & Destructor Documentation

◆ ConstantDataVector()

llvm::ConstantDataVector::ConstantDataVector ( const ConstantDataVector )
delete

Member Function Documentation

◆ classof()

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

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

Definition at line 783 of file Constants.h.

References llvm::Value::getValueID().

◆ get() [1/6]

Constant * ConstantDataVector::get ( LLVMContext Context,
ArrayRef< uint8_t >  Elts 
)
static

get() constructors - Return a constant with vector type with an element count and element type matching the ArrayRef passed in.

Note that this can return a ConstantAggregateZero object.

Definition at line 2467 of file Constants.cpp.

References llvm::Data, llvm::ArrayRef< T >::data(), llvm::VectorType::get(), getImpl(), llvm::Type::getInt8Ty(), and llvm::ArrayRef< T >::size().

Referenced by llvm::X86TargetLowering::BuildFILD(), llvm::IRBuilder< TargetFolder >::CreateShuffleVector(), llvm::AMDGPULibCalls::fold(), llvm::log2(), optimizeVectorResize(), and readWideAPInt().

◆ get() [2/6]

Constant * ConstantDataVector::get ( LLVMContext Context,
ArrayRef< uint16_t >  Elts 
)
static

◆ get() [3/6]

Constant * ConstantDataVector::get ( LLVMContext Context,
ArrayRef< uint32_t Elts 
)
static

◆ get() [4/6]

Constant * ConstantDataVector::get ( LLVMContext Context,
ArrayRef< uint64_t >  Elts 
)
static

◆ get() [5/6]

Constant * ConstantDataVector::get ( LLVMContext Context,
ArrayRef< float >  Elts 
)
static

◆ get() [6/6]

Constant * ConstantDataVector::get ( LLVMContext Context,
ArrayRef< double >  Elts 
)
static

◆ getFP() [1/3]

Constant * ConstantDataVector::getFP ( LLVMContext Context,
ArrayRef< uint16_t >  Elts 
)
static

getFP() constructors - Return a constant with vector type with an element count and element type of float with the precision matching the number of bits in the ArrayRef passed in.

(i.e. half for 16bits, float for 32bits, double for 64bits) Note that this can return a ConstantAggregateZero object.

Definition at line 2503 of file Constants.cpp.

References llvm::Data, llvm::ArrayRef< T >::data(), llvm::VectorType::get(), llvm::Type::getHalfTy(), getImpl(), and llvm::ArrayRef< T >::size().

Referenced by readWideAPInt().

◆ getFP() [2/3]

Constant * ConstantDataVector::getFP ( LLVMContext Context,
ArrayRef< uint32_t Elts 
)
static

◆ getFP() [3/3]

Constant * ConstantDataVector::getFP ( LLVMContext Context,
ArrayRef< uint64_t >  Elts 
)
static

◆ getSplat()

Constant * ConstantDataVector::getSplat ( unsigned  NumElts,
Constant Elt 
)
static

Return a ConstantVector with the specified constant in each element.

The specified constant has to be a of a compatible type (i8/i16/ i32/i64/float/double) and must be a ConstantFP or ConstantInt.

Definition at line 2522 of file Constants.cpp.

References assert(), llvm::Value::getContext(), llvm::ConstantVector::getSplat(), and llvm::Value::getType().

Referenced by llvm::ConstantVector::getSplat(), and llvm::log2().

◆ getSplatValue()

Constant * ConstantDataVector::getSplatValue ( ) const

If this is a splat constant, meaning that all of the elements have the same value, return that value.

Otherwise return NULL.

Definition at line 2682 of file Constants.cpp.

References isSplat().

Referenced by llvm::log2().

◆ getType()

VectorType* llvm::ConstantDataVector::getType ( ) const
inline

Specialize the getType() method to always return a VectorType, which reduces the amount of casting needed in parts of the compiler.

Definition at line 778 of file Constants.h.

References llvm::Value::getType().

◆ isSplat()

bool ConstantDataVector::isSplat ( ) const

Returns true if this is a splat constant, meaning that all elements have the same value.

Definition at line 2670 of file Constants.cpp.

References memcmp.

Friends And Related Function Documentation

◆ ConstantDataSequential

friend class ConstantDataSequential
friend

Definition at line 736 of file Constants.h.


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