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

ConstantDataSequential - A vector or array 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 <Constants.h>

Inheritance diagram for llvm::ConstantDataSequential:
[legend]
Collaboration diagram for llvm::ConstantDataSequential:
[legend]

Public Member Functions

uint64_t getElementAsInteger (unsigned i) const
 getElementAsInteger - If this is a sequential container of integers (of any size), return the specified element in the low bits of a uint64_t. More...
 
APFloat getElementAsAPFloat (unsigned i) const
 getElementAsAPFloat - If this is a sequential container of floating point type, return the specified element as an APFloat. More...
 
float getElementAsFloat (unsigned i) const
 getElementAsFloat - If this is an sequential container of floats, return the specified element as a float. More...
 
double getElementAsDouble (unsigned i) const
 getElementAsDouble - If this is an sequential container of doubles, return the specified element as a double. More...
 
ConstantgetElementAsConstant (unsigned i) const
 getElementAsConstant - Return a Constant for a specified index's element. More...
 
SequentialTypegetType () const
 getType - Specialize the getType() method to always return a SequentialType, which reduces the amount of casting needed in parts of the compiler. More...
 
TypegetElementType () const
 getElementType - Return the element type of the array/vector. More...
 
unsigned getNumElements () const
 getNumElements - Return the number of elements in the array or vector. More...
 
uint64_t getElementByteSize () const
 getElementByteSize - Return the size (in bytes) of each element in the array/vector. More...
 
bool isString () const
 isString - This method returns true if this is an array of i8. More...
 
bool isCString () const
 isCString - This method returns true if the array "isString", ends with a nul byte, and does not contains any other nul bytes. More...
 
StringRef getAsString () const
 getAsString - If this array is isString(), then this method returns the array as a StringRef. More...
 
StringRef getAsCString () const
 getAsCString - If this array is isCString(), then this method returns the array (without the trailing null byte) as a StringRef. More...
 
StringRef getRawDataValues () const
 getRawDataValues - Return the raw, underlying, bytes of this data. 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 bool isElementTypeCompatible (const Type *Ty)
 isElementTypeCompatible - 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::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

 ConstantDataSequential (Type *ty, ValueTy VT, const char *Data)
 
 ~ConstantDataSequential () override
 
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...
 
 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)
 

Static Protected Member Functions

static ConstantgetImpl (StringRef Bytes, Type *Ty)
 getImpl - 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)
 

Friends

class LLVMContextImpl
 
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...
 
- 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

ConstantDataSequential - A vector or array 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.

This is the common base class of ConstantDataArray and ConstantDataVector.

Definition at line 557 of file Constants.h.

Constructor & Destructor Documentation

llvm::ConstantDataSequential::ConstantDataSequential ( Type ty,
ValueTy  VT,
const char *  Data 
)
inlineexplicitprotected

Definition at line 576 of file Constants.h.

llvm::ConstantDataSequential::~ConstantDataSequential ( )
inlineoverrideprotected

Definition at line 578 of file Constants.h.

Member Function Documentation

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

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

Definition at line 667 of file Constants.h.

References llvm::Value::getValueID().

StringRef llvm::ConstantDataSequential::getAsCString ( ) const
inline

getAsCString - If this array is isCString(), then this method returns the array (without the trailing null byte) as a StringRef.

Otherwise, it asserts out.

Definition at line 654 of file Constants.h.

References getAsString(), isCString(), llvm::StringRef::size(), and llvm::StringRef::substr().

StringRef llvm::ConstantDataSequential::getAsString ( ) const
inline

getAsString - If this array is isString(), then this method returns the array as a StringRef.

Otherwise, it asserts out.

Definition at line 645 of file Constants.h.

References getRawDataValues(), and isString().

Referenced by emitGlobalConstantDataSequential(), getAsCString(), llvm::getConstantStringInfo(), and isCString().

APFloat ConstantDataSequential::getElementAsAPFloat ( unsigned  Elt) const

getElementAsAPFloat - If this is a sequential container of floating point type, return the specified element as an APFloat.

Definition at line 2745 of file Constants.cpp.

References llvm::lltok::APFloat, llvm::Type::DoubleTyID, llvm::Type::FloatTyID, getElementType(), getTypeID(), llvm::APFloat::IEEEdouble, llvm::APFloat::IEEEsingle, and llvm_unreachable.

Referenced by getElementAsConstant().

Constant * ConstantDataSequential::getElementAsConstant ( unsigned  Elt) const

getElementAsConstant - Return a Constant for a specified index's element.

Note that this has to compute a new constant to return, so it isn't as efficient as getElementAsInteger/Float/Double.

Definition at line 2784 of file Constants.cpp.

References llvm::ConstantInt::get(), llvm::ConstantFP::get(), llvm::Value::getContext(), getElementAsAPFloat(), getElementAsInteger(), and getElementType().

Referenced by getLogBase2Vector(), and llvm::ConstantDataVector::getSplatValue().

double ConstantDataSequential::getElementAsDouble ( unsigned  Elt) const

getElementAsDouble - If this is an sequential container of doubles, return the specified element as a double.

getElementAsDouble - If this is an sequential container of doubles, return the specified element as a float.

Definition at line 2773 of file Constants.cpp.

References getElementType().

Referenced by emitGlobalConstantDataSequential(), and llvm::ExecutionEngine::getConstantValue().

float ConstantDataSequential::getElementAsFloat ( unsigned  Elt) const

getElementAsFloat - If this is an sequential container of floats, return the specified element as a float.

Definition at line 2764 of file Constants.cpp.

References getElementType().

Referenced by emitGlobalConstantDataSequential(), and llvm::ExecutionEngine::getConstantValue().

uint64_t ConstantDataSequential::getElementAsInteger ( unsigned  Elt) const

getElementAsInteger - If this is a sequential container of integers (of any size), return the specified element in the low bits of a uint64_t.

Definition at line 2723 of file Constants.cpp.

References getElementType(), and llvm_unreachable.

Referenced by emitGlobalConstantDataSequential(), FoldBitCast(), llvm::ExecutionEngine::getConstantValue(), getElementAsConstant(), and WriteConstants().

uint64_t ConstantDataSequential::getElementByteSize ( ) const

getElementByteSize - Return the size (in bytes) of each element in the array/vector.

getElementByteSize - Return the size in bytes of the elements in the data.

The size of the elements is known to be a multiple of one byte.

Definition at line 2457 of file Constants.cpp.

References getElementType(), and llvm::Type::getPrimitiveSizeInBits().

Referenced by emitGlobalConstantDataSequential(), getRawDataValues(), and llvm::ConstantDataVector::getSplatValue().

Type * ConstantDataSequential::getElementType ( ) const
Constant * ConstantDataSequential::getImpl ( StringRef  Elements,
Type Ty 
)
staticprotected

getImpl - This is the underlying implementation of all of the ConstantDataSequential::get methods.

They all thunk down to here, providing the correct element type. We take the bytes in as a StringRef because we want an underlying "char*" to avoid TBAA type punning violations.

StringMap bucket, linked up by their Next pointers. Walk the list.

Definition at line 2480 of file Constants.cpp.

References llvm::LLVMContextImpl::CDSConstants, llvm::ConstantAggregateZero::get(), llvm::Type::getContext(), llvm::Type::getSequentialElementType(), isAllZeros(), isElementTypeCompatible(), llvm::LLVMContext::pImpl, and llvm::Slot.

Referenced by llvm::ConstantDataArray::get(), llvm::ConstantDataVector::get(), llvm::ConstantDataArray::getFP(), and llvm::ConstantDataVector::getFP().

unsigned ConstantDataSequential::getNumElements ( ) const
StringRef ConstantDataSequential::getRawDataValues ( ) const

getRawDataValues - Return the raw, underlying, bytes of this data.

Note that this is an extremely tricky thing to work with, as it exposes the host endianness of the data elements.

Definition at line 2425 of file Constants.cpp.

References getElementByteSize(), and getNumElements().

Referenced by getAsString(), llvm::ConstantDataVector::getSplatValue(), and isRepeatedByteSequence().

SequentialType* llvm::ConstantDataSequential::getType ( ) const
inline

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

Definition at line 619 of file Constants.h.

References llvm::Value::getType().

Referenced by emitGlobalConstantDataSequential(), getElementType(), getNumElements(), and isString().

bool ConstantDataSequential::isCString ( ) const

isCString - This method returns true if the array "isString", ends with a nul byte, and does not contains any other nul bytes.

Definition at line 2798 of file Constants.cpp.

References llvm::StringRef::back(), llvm::StringRef::drop_back(), llvm::StringRef::find(), getAsString(), isString(), and llvm::StringRef::npos.

Referenced by getAsCString(), and WriteConstants().

bool ConstantDataSequential::isElementTypeCompatible ( const Type Ty)
static

isElementTypeCompatible - Return true if a ConstantDataSequential can be formed with a vector or array of the specified element type.

ConstantDataArray only works with normal float and int types that are stored densely in memory, not with things like i42 or x86_f80.

Definition at line 2433 of file Constants.cpp.

References llvm::Type::isDoubleTy(), llvm::Type::isFloatTy(), and IT().

Referenced by getImpl(), llvm::ConstantVector::getSplat(), and llvm::ConstantDataVector::getSplat().

bool ConstantDataSequential::isString ( ) const

isString - This method returns true if this is an array of i8.

Definition at line 2792 of file Constants.cpp.

References getElementType(), getType(), and llvm::Type::isIntegerTy().

Referenced by emitGlobalConstantDataSequential(), getAsString(), llvm::getConstantStringInfo(), and isCString().

void* llvm::ConstantDataSequential::operator new ( size_t  s)
inlineprotected

Definition at line 584 of file Constants.h.

Friends And Related Function Documentation

friend class Constant
friend

Definition at line 571 of file Constants.h.

friend class LLVMContextImpl
friend

Definition at line 558 of file Constants.h.


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