LLVM  6.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
llvm::IntegerType Class Reference

Class to represent integer types. More...

#include "llvm/IR/DerivedTypes.h"

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

Public Types

enum  { MIN_INT_BITS = 1, MAX_INT_BITS = (1<<24)-1 }
 This enum is just used to hold constants we need for IntegerType. More...
 
- Public Types inherited from llvm::Type
enum  TypeID {
  VoidTyID = 0, HalfTyID, FloatTyID, DoubleTyID,
  X86_FP80TyID, FP128TyID, PPC_FP128TyID, LabelTyID,
  MetadataTyID, X86_MMXTyID, TokenTyID, IntegerTyID,
  FunctionTyID, StructTyID, ArrayTyID, PointerTyID,
  VectorTyID
}
 Definitions of all of the base types for the Type system. More...
 
using subtype_iterator = Type *const *
 
using subtype_reverse_iterator = std::reverse_iterator< subtype_iterator >
 

Public Member Functions

unsigned getBitWidth () const
 Get the number of bits in this IntegerType. More...
 
uint64_t getBitMask () const
 Return a bitmask with ones set for all of the bits that can be set by an unsigned version of this type. More...
 
uint64_t getSignBit () const
 Return a uint64_t with just the most significant bit set (the sign bit, if the value is treated as a signed number). More...
 
APInt getMask () const
 For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc. More...
 
bool isPowerOf2ByteWidth () const
 This method determines if the width of this IntegerType is a power-of-2 in terms of 8 bit bytes. More...
 
- Public Member Functions inherited from llvm::Type
void print (raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const
 Print the current type. More...
 
void dump () const
 
LLVMContextgetContext () const
 Return the LLVMContext in which this type was uniqued. More...
 
TypeID getTypeID () const
 Return the type id for the type. More...
 
bool isVoidTy () const
 Return true if this is 'void'. More...
 
bool isHalfTy () const
 Return true if this is 'half', a 16-bit IEEE fp type. More...
 
bool isFloatTy () const
 Return true if this is 'float', a 32-bit IEEE fp type. More...
 
bool isDoubleTy () const
 Return true if this is 'double', a 64-bit IEEE fp type. More...
 
bool isX86_FP80Ty () const
 Return true if this is x86 long double. More...
 
bool isFP128Ty () const
 Return true if this is 'fp128'. More...
 
bool isPPC_FP128Ty () const
 Return true if this is powerpc long double. More...
 
bool isFloatingPointTy () const
 Return true if this is one of the six floating-point types. More...
 
const fltSemanticsgetFltSemantics () const
 
bool isX86_MMXTy () const
 Return true if this is X86 MMX. More...
 
bool isFPOrFPVectorTy () const
 Return true if this is a FP type or a vector of FP. More...
 
bool isLabelTy () const
 Return true if this is 'label'. More...
 
bool isMetadataTy () const
 Return true if this is 'metadata'. More...
 
bool isTokenTy () const
 Return true if this is 'token'. More...
 
bool isIntegerTy () const
 True if this is an instance of IntegerType. More...
 
bool isIntegerTy (unsigned Bitwidth) const
 Return true if this is an IntegerType of the given width. More...
 
bool isIntOrIntVectorTy () const
 Return true if this is an integer type or a vector of integer types. More...
 
bool isIntOrIntVectorTy (unsigned BitWidth) const
 Return true if this is an integer type or a vector of integer types of the given width. More...
 
bool isFunctionTy () const
 True if this is an instance of FunctionType. More...
 
bool isStructTy () const
 True if this is an instance of StructType. More...
 
bool isArrayTy () const
 True if this is an instance of ArrayType. More...
 
bool isPointerTy () const
 True if this is an instance of PointerType. More...
 
bool isPtrOrPtrVectorTy () const
 Return true if this is a pointer type or a vector of pointer types. More...
 
bool isVectorTy () const
 True if this is an instance of VectorType. More...
 
bool canLosslesslyBitCastTo (Type *Ty) const
 Return true if this type could be converted with a lossless BitCast to type 'Ty'. More...
 
bool isEmptyTy () const
 Return true if this type is empty, that is, it has no elements or all of its elements are empty. More...
 
bool isFirstClassType () const
 Return true if the type is "first class", meaning it is a valid type for a Value. More...
 
bool isSingleValueType () const
 Return true if the type is a valid type for a register in codegen. More...
 
bool isAggregateType () const
 Return true if the type is an aggregate type. More...
 
bool isSized (SmallPtrSetImpl< Type *> *Visited=nullptr) const
 Return true if it makes sense to take the size of this type. More...
 
unsigned getPrimitiveSizeInBits () const LLVM_READONLY
 Return the basic size of this type if it is a primitive type. More...
 
unsigned getScalarSizeInBits () const LLVM_READONLY
 If this is a vector type, return the getPrimitiveSizeInBits value for the element type. More...
 
int getFPMantissaWidth () const
 Return the width of the mantissa of this type. More...
 
TypegetScalarType () const
 If this is a vector type, return the element type, otherwise return 'this'. More...
 
subtype_iterator subtype_begin () const
 
subtype_iterator subtype_end () const
 
ArrayRef< Type * > subtypes () const
 
subtype_reverse_iterator subtype_rbegin () const
 
subtype_reverse_iterator subtype_rend () const
 
TypegetContainedType (unsigned i) const
 This method is used to implement the type iterator (defined at the end of the file). More...
 
unsigned getNumContainedTypes () const
 Return the number of types in the derived type. More...
 
unsigned getIntegerBitWidth () const
 
TypegetFunctionParamType (unsigned i) const
 
unsigned getFunctionNumParams () const
 
bool isFunctionVarArg () const
 
StringRef getStructName () const
 
unsigned getStructNumElements () const
 
TypegetStructElementType (unsigned N) const
 
TypegetSequentialElementType () const
 
uint64_t getArrayNumElements () const
 
TypegetArrayElementType () const
 
unsigned getVectorNumElements () const
 
TypegetVectorElementType () const
 
TypegetPointerElementType () const
 
unsigned getPointerAddressSpace () const
 Get the address space of this pointer or pointer vector type. More...
 
PointerTypegetPointerTo (unsigned AddrSpace=0) const
 Return a pointer to the current type. More...
 

Static Public Member Functions

static IntegerTypeget (LLVMContext &C, unsigned NumBits)
 This static method is the primary way of constructing an IntegerType. More...
 
static bool classof (const Type *T)
 Methods for support type inquiry through isa, cast, and dyn_cast. More...
 
- Static Public Member Functions inherited from llvm::Type
static TypegetPrimitiveType (LLVMContext &C, TypeID IDNumber)
 Return a type based on an identifier. More...
 
static TypegetVoidTy (LLVMContext &C)
 
static TypegetLabelTy (LLVMContext &C)
 
static TypegetHalfTy (LLVMContext &C)
 
static TypegetFloatTy (LLVMContext &C)
 
static TypegetDoubleTy (LLVMContext &C)
 
static TypegetMetadataTy (LLVMContext &C)
 
static TypegetX86_FP80Ty (LLVMContext &C)
 
static TypegetFP128Ty (LLVMContext &C)
 
static TypegetPPC_FP128Ty (LLVMContext &C)
 
static TypegetX86_MMXTy (LLVMContext &C)
 
static TypegetTokenTy (LLVMContext &C)
 
static IntegerTypegetIntNTy (LLVMContext &C, unsigned N)
 
static IntegerTypegetInt1Ty (LLVMContext &C)
 
static IntegerTypegetInt8Ty (LLVMContext &C)
 
static IntegerTypegetInt16Ty (LLVMContext &C)
 
static IntegerTypegetInt32Ty (LLVMContext &C)
 
static IntegerTypegetInt64Ty (LLVMContext &C)
 
static IntegerTypegetInt128Ty (LLVMContext &C)
 
static PointerTypegetHalfPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetFloatPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetDoublePtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_FP80PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetFP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetPPC_FP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_MMXPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetIntNPtrTy (LLVMContext &C, unsigned N, unsigned AS=0)
 
static PointerTypegetInt1PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt8PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt16PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt32PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt64PtrTy (LLVMContext &C, unsigned AS=0)
 

Protected Member Functions

 IntegerType (LLVMContext &C, unsigned NumBits)
 
- Protected Member Functions inherited from llvm::Type
 Type (LLVMContext &C, TypeID tid)
 
 ~Type ()=default
 
unsigned getSubclassData () const
 
void setSubclassData (unsigned val)
 

Friends

class LLVMContextImpl
 

Additional Inherited Members

- Static Protected Member Functions inherited from llvm::Type
static bool isSequentialType (TypeID TyID)
 
- Protected Attributes inherited from llvm::Type
unsigned NumContainedTys = 0
 Keeps track of how many Type*'s there are in the ContainedTys list. More...
 
Type *constContainedTys = nullptr
 A pointer to the array of Types contained by this Type. More...
 

Detailed Description

Class to represent integer types.

Note that this class is also used to represent the built-in integer types: Int1Ty, Int8Ty, Int16Ty, Int32Ty and Int64Ty. Integer representation type

Definition at line 40 of file DerivedTypes.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

This enum is just used to hold constants we need for IntegerType.

Enumerator
MIN_INT_BITS 

Minimum number of bits that can be specified.

MAX_INT_BITS 

Maximum number of bits that can be specified.

Note that bit width is stored in the Type classes SubclassData field which has 24 bits. This yields a maximum bit width of 16,777,215 bits.

Definition at line 50 of file DerivedTypes.h.

Constructor & Destructor Documentation

◆ IntegerType()

llvm::IntegerType::IntegerType ( LLVMContext C,
unsigned  NumBits 
)
inlineexplicitprotected

Definition at line 44 of file DerivedTypes.h.

References llvm::Type::setSubclassData().

Member Function Documentation

◆ classof()

static bool llvm::IntegerType::classof ( const Type T)
inlinestatic

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

Definition at line 92 of file DerivedTypes.h.

References llvm::Type::getTypeID(), and llvm::Type::IntegerTyID.

◆ get()

IntegerType * IntegerType::get ( LLVMContext C,
unsigned  NumBits 
)
static

This static method is the primary way of constructing an IntegerType.

If an IntegerType with the same NumBits value was previously instantiated, that instance will be returned. Otherwise a new one will be created. Only one instance with a given NumBits value is ever created. Get or create an IntegerType instance.

Definition at line 240 of file Type.cpp.

References assert(), llvm::Type::getInt128Ty(), llvm::Type::getInt16Ty(), llvm::Type::getInt1Ty(), llvm::Type::getInt32Ty(), llvm::Type::getInt64Ty(), llvm::Type::getInt8Ty(), llvm::LLVMContextImpl::IntegerTypes, llvm::LLVMContext::pImpl, and llvm::LLVMContextImpl::TypeAllocator.

Referenced by BinomialCoefficient(), BitCastConstantVector(), llvm::MachineIRBuilder::buildConstant(), CanBeSMin(), llvm::slpvectorizer::BoUpSLP::canMapToVector(), CanShareConstantPoolEntry(), llvm::VNCoercion::coerceAvailableValueToLoadTypeHelper(), collectInsertionElements(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldSelectInstruction(), llvm::ConstantFoldShuffleVectorInstruction(), llvm::DIBuilder::createBitFieldMemberType(), llvm::createEfficiencySanitizerPass(), createPrivateNonConstGlobalForString(), llvm::MDBuilder::createRange(), DecodeFixedType(), llvm::Evaluator::EvaluateBlock(), llvm::SCEVExpander::expandUnionPredicate(), ExtractConstantBytes(), llvm::FastISel::fastEmit_ri_(), foldICmpShlOne(), llvm::SCEVExpander::generateOverflowCheck(), llvm::ConstantInt::get(), llvm::TypeBuilder< types::i< num_bits >, cross >::get(), getAccessType(), getAsConstantIndexedAddress(), getAttrFromCode(), llvm::VectorType::getExtendedElementVectorType(), getFoldedAlignOf(), getFoldedSizeOf(), llvm::VectorType::getInteger(), llvm::X86TTIImpl::getIntImmCost(), llvm::Type::getIntNTy(), llvm::DataLayout::getIntPtrType(), llvm::VNCoercion::getLoadValueForLoad(), getMemCmpLoad(), llvm::VNCoercion::getMemInstValueForLoadHelper(), llvm::MDNode::getMostGenericTBAA(), getNegativeIsTrueBoolVec(), getPreStartForExtend(), getRangeForAffineARHelper(), llvm::ScalarEvolution::getSignExtendExpr(), llvm::VNCoercion::getStoreValueForLoadHelper(), llvm::slpvectorizer::BoUpSLP::getTreeCost(), llvm::VectorType::getTruncatedElementVectorType(), llvm::EVT::getTypeForEVT(), llvm::ScalarEvolution::getUDivExpr(), llvm::ScalarEvolution::getZeroExtendExpr(), hasUnaryFloatFn(), INITIALIZE_PASS(), instrumentMaskedLoadOrStore(), isAddRecSExtable(), isAddSExtable(), IsIncrementNSW(), IsIncrementNUW(), isMulSExtable(), isStrideMul(), largestIntegerVectorType(), llvm::LLLexer::LLLexer(), LLVMIntTypeInContext(), llvm::RecurrenceDescriptor::lookThroughAnd(), llvm::Intrinsic::matchIntrinsicType(), llvm::TargetLowering::ParseConstraints(), performMaskedAtomicOp(), processUGT_ADDCST_ADD(), rewriteGEPAsOffset(), false::Simplifier::simplify(), SwitchToSelect(), unifyBitWidth(), upgradeMaskedCompare(), llvm::slpvectorizer::BoUpSLP::vectorizeTree(), and llvm::InstCombiner::visitSwitchInst().

◆ getBitMask()

uint64_t llvm::IntegerType::getBitMask ( ) const
inline

Return a bitmask with ones set for all of the bits that can be set by an unsigned version of this type.

This is 0xFF for i8, 0xFFFF for i16, etc.

Definition at line 70 of file DerivedTypes.h.

References getBitWidth().

◆ getBitWidth()

unsigned llvm::IntegerType::getBitWidth ( ) const
inline

◆ getMask()

APInt IntegerType::getMask ( ) const

For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc.

Returns
a bit mask with ones set for all the bits of this type. Get a bit mask for this type.

Definition at line 269 of file Type.cpp.

References assert(), llvm::Type::ContainedTys, llvm::Type::FunctionTyID, llvm::APInt::getAllOnesValue(), getBitWidth(), llvm::Type::getContext(), llvm::Type::NumContainedTys, llvm::Type::setSubclassData(), llvm::ArrayRef< T >::size(), and llvm::Type::Type().

Referenced by getSignBit().

◆ getSignBit()

uint64_t llvm::IntegerType::getSignBit ( ) const
inline

Return a uint64_t with just the most significant bit set (the sign bit, if the value is treated as a signed number).

Definition at line 76 of file DerivedTypes.h.

References getBitWidth(), getMask(), and isPowerOf2ByteWidth().

Referenced by replaceAllUsesOfWithIn().

◆ isPowerOf2ByteWidth()

bool IntegerType::isPowerOf2ByteWidth ( ) const

This method determines if the width of this IntegerType is a power-of-2 in terms of 8 bit bytes.

Returns
true if this is a power-of-2 byte width. Is this a power-of-2 byte-width IntegerType ?

Definition at line 264 of file Type.cpp.

References getBitWidth(), and llvm::isPowerOf2_32().

Referenced by getSignBit().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 41 of file DerivedTypes.h.


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