Class to represent integer types. More...

#include "llvm/IR/DerivedTypes.h"

Inheritance diagram for llvm::IntegerType:

Collaboration diagram for llvm::IntegerType:

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

LLVMContext &	getContext () 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 fltSemantics &	getFltSemantics () 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	isIntOrPtrTy () const
	Return true if this is an integer type or a pointer type. 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...

Type *	getScalarType () 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

Type *	getContainedType (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

Type *	getFunctionParamType (unsigned i) const

unsigned	getFunctionNumParams () const

bool	isFunctionVarArg () const

StringRef	getStructName () const

unsigned	getStructNumElements () const

Type *	getStructElementType (unsigned N) const

Type *	getSequentialElementType () const

uint64_t	getArrayNumElements () const

Type *	getArrayElementType () const

unsigned	getVectorNumElements () const

Type *	getVectorElementType () const

Type *	getPointerElementType () const

unsigned	getPointerAddressSpace () const
	Get the address space of this pointer or pointer vector type. More...

PointerType *	getPointerTo (unsigned AddrSpace=0) const
	Return a pointer to the current type. More...

Static Public Member Functions
static IntegerType *	get (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 Type *	getPrimitiveType (LLVMContext &C, TypeID IDNumber)
	Return a type based on an identifier. More...

static Type *	getVoidTy (LLVMContext &C)

static Type *	getLabelTy (LLVMContext &C)

static Type *	getHalfTy (LLVMContext &C)

static Type *	getFloatTy (LLVMContext &C)

static Type *	getDoubleTy (LLVMContext &C)

static Type *	getMetadataTy (LLVMContext &C)

static Type *	getX86_FP80Ty (LLVMContext &C)

static Type *	getFP128Ty (LLVMContext &C)

static Type *	getPPC_FP128Ty (LLVMContext &C)

static Type *	getX86_MMXTy (LLVMContext &C)

static Type *	getTokenTy (LLVMContext &C)

static IntegerType *	getIntNTy (LLVMContext &C, unsigned N)

static IntegerType *	getInt1Ty (LLVMContext &C)

static IntegerType *	getInt8Ty (LLVMContext &C)

static IntegerType *	getInt16Ty (LLVMContext &C)

static IntegerType *	getInt32Ty (LLVMContext &C)

static IntegerType *	getInt64Ty (LLVMContext &C)

static IntegerType *	getInt128Ty (LLVMContext &C)

template<typename ScalarTy >
static Type *	getScalarTy (LLVMContext &C)

static PointerType *	getHalfPtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getFloatPtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getDoublePtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getX86_FP80PtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getFP128PtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getPPC_FP128PtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getX86_MMXPtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getIntNPtrTy (LLVMContext &C, unsigned N, unsigned AS=0)

static PointerType *	getInt1PtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getInt8PtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getInt16PtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getInt32PtrTy (LLVMContext &C, unsigned AS=0)

static PointerType *	getInt64PtrTy (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 const	ContainedTys = 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 atomicSizeSupported(), BinomialCoefficient(), BitCastConstantVector(), llvm::MachineIRBuilder::buildConstant(), llvm::slpvectorizer::BoUpSLP::canMapToVector(), CanShareConstantPoolEntry(), canTransformToMemCmp(), llvm::VNCoercion::coerceAvailableValueToLoadTypeHelper(), collectInsertionElements(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldCompareInstruction(), llvm::ConstantFoldSelectInstruction(), llvm::ConstantFoldShuffleVectorInstruction(), createAccessTag(), llvm::DIBuilder::createBitFieldMemberType(), llvm::createEfficiencySanitizerPass(), llvm::DIBuilder::createInheritance(), CreateLoadIns(), llvm::MDBuilder::createRange(), DecodeFixedType(), llvm::Evaluator::EvaluateBlock(), llvm::SCEVExpander::expandUnionPredicate(), ExtractConstantBytes(), llvm::FastISel::fastEmit_ri_(), foldICmpShlOne(), llvm::ConstantInt::get(), getAccessType(), getAsConstantIndexedAddress(), llvm::VectorType::getExtendedElementVectorType(), getFoldedAlignOf(), getFoldedSizeOf(), llvm::DataLayout::getIndexType(), llvm::VectorType::getInteger(), llvm::Type::getIntNTy(), llvm::DataLayout::getIntPtrType(), llvm::VNCoercion::getLoadValueForLoad(), GetLoopInvariantInsertPosition(), getMemCmpLoad(), llvm::VNCoercion::getMemInstValueForLoadHelper(), getNegativeIsTrueBoolVec(), getRangeForAffineARHelper(), getRelevantOperands(), llvm::ScalarEvolution::getSignExtendExpr(), llvm::VNCoercion::getStoreValueForLoadHelper(), llvm::slpvectorizer::BoUpSLP::getTreeCost(), llvm::VectorType::getTruncatedElementVectorType(), llvm::EVT::getTypeForEVT(), llvm::ScalarEvolution::getUDivExpr(), llvm::ScalarEvolution::getURemExpr(), llvm::X86TTIImpl::getUserCost(), llvm::ScalarEvolution::getZeroExtendExpr(), INITIALIZE_PASS(), instrumentMaskedLoadOrStore(), isAddRecSExtable(), isAddSExtable(), IsIncrementNSW(), IsIncrementNUW(), isMulSExtable(), llvm::LegalizerHelper::libcall(), LLVMIntTypeInContext(), lookThroughAnd(), llvm::HexagonTargetLowering::LowerBITCAST(), llvm::Intrinsic::matchIntrinsicType(), llvm::TargetLowering::ParseConstraints(), performMaskedAtomicOp(), processUGT_ADDCST_ADD(), llvm::LoopVectorizationCostModel::setCostBasedWideningDecision(), switchToSelect(), llvm::InnerLoopVectorizer::truncateToMinimalBitwidths(), TypeSizeToSizeIndex(), unifyBitWidth(), llvm::slpvectorizer::BoUpSLP::vectorizeTree(), and llvm::InstCombiner::visitSwitchInst().