A parsed version of the target data layout string in and methods for querying it. More...

#include "llvm/IR/DataLayout.h"

Public Types
enum class	FunctionPtrAlignType { Independent , MultipleOfFunctionAlign }

Public Member Functions
	DataLayout (StringRef LayoutDescription)
	Constructs a DataLayout from a specification string. See reset().

	DataLayout (const Module *M)
	Initialize target data from properties stored in the module.

	DataLayout (const DataLayout &DL)

	~DataLayout ()

DataLayout &	operator= (const DataLayout &DL)

bool	operator== (const DataLayout &Other) const

bool	operator!= (const DataLayout &Other) const

void	init (const Module *M)

void	reset (StringRef LayoutDescription)
	Parse a data layout string (with fallback to default values).

bool	isLittleEndian () const
	Layout endianness...

bool	isBigEndian () const

const std::string &	getStringRepresentation () const
	Returns the string representation of the DataLayout.

bool	isDefault () const
	Test if the DataLayout was constructed from an empty string.

bool	isLegalInteger (uint64_t Width) const
	Returns true if the specified type is known to be a native integer type supported by the CPU.

bool	isIllegalInteger (uint64_t Width) const

bool	exceedsNaturalStackAlignment (Align Alignment) const
	Returns true if the given alignment exceeds the natural stack alignment.

Align	getStackAlignment () const

unsigned	getAllocaAddrSpace () const

MaybeAlign	getFunctionPtrAlign () const
	Returns the alignment of function pointers, which may or may not be related to the alignment of functions.

FunctionPtrAlignType	getFunctionPtrAlignType () const
	Return the type of function pointer alignment.

unsigned	getProgramAddressSpace () const

unsigned	getDefaultGlobalsAddressSpace () const

bool	hasMicrosoftFastStdCallMangling () const

bool	doNotMangleLeadingQuestionMark () const
	Returns true if symbols with leading question marks should not receive IR mangling.

bool	hasLinkerPrivateGlobalPrefix () const

StringRef	getLinkerPrivateGlobalPrefix () const

char	getGlobalPrefix () const

StringRef	getPrivateGlobalPrefix () const

bool	fitsInLegalInteger (unsigned Width) const
	Returns true if the specified type fits in a native integer type supported by the CPU.

Align	getPointerABIAlignment (unsigned AS) const
	Layout pointer alignment.

Align	getPointerPrefAlignment (unsigned AS=0) const
	Return target's alignment for stack-based pointers FIXME: The defaults need to be removed once all of the backends/clients are updated.

unsigned	getPointerSize (unsigned AS=0) const
	Layout pointer size in bytes, rounded up to a whole number of bytes.

unsigned	getMaxIndexSize () const
	Returns the maximum index size over all address spaces.

unsigned	getIndexSize (unsigned AS) const
	rounded up to a whole number of bytes.

ArrayRef< unsigned >	getNonIntegralAddressSpaces () const
	Return the address spaces containing non-integral pointers.

bool	isNonIntegralAddressSpace (unsigned AddrSpace) const

bool	isNonIntegralPointerType (PointerType *PT) const

bool	isNonIntegralPointerType (Type *Ty) const

unsigned	getPointerSizeInBits (unsigned AS=0) const
	Layout pointer size, in bits FIXME: The defaults need to be removed once all of the backends/clients are updated.

unsigned	getMaxIndexSizeInBits () const
	Returns the maximum index size over all address spaces.

unsigned	getIndexSizeInBits (unsigned AS) const
	Size in bits of index used for address calculation in getelementptr.

unsigned	getPointerTypeSizeInBits (Type *) const
	Layout pointer size, in bits, based on the type.

unsigned	getIndexTypeSizeInBits (Type *Ty) const
	Layout size of the index used in GEP calculation.

unsigned	getPointerTypeSize (Type *Ty) const

TypeSize	getTypeSizeInBits (Type *Ty) const
	Size examples:

TypeSize	getTypeStoreSize (Type *Ty) const
	Returns the maximum number of bytes that may be overwritten by storing the specified type.

TypeSize	getTypeStoreSizeInBits (Type *Ty) const
	Returns the maximum number of bits that may be overwritten by storing the specified type; always a multiple of 8.

bool	typeSizeEqualsStoreSize (Type *Ty) const
	Returns true if no extra padding bits are needed when storing the specified type.

TypeSize	getTypeAllocSize (Type *Ty) const
	Returns the offset in bytes between successive objects of the specified type, including alignment padding.

TypeSize	getTypeAllocSizeInBits (Type *Ty) const
	Returns the offset in bits between successive objects of the specified type, including alignment padding; always a multiple of 8.

uint64_t	getABITypeAlignment (Type *Ty) const
	Returns the minimum ABI-required alignment for the specified type.

Align	getABITypeAlign (Type *Ty) const
	Returns the minimum ABI-required alignment for the specified type.

Align	getValueOrABITypeAlignment (MaybeAlign Alignment, Type *Ty) const
	Helper function to return `Alignment` if it's set or the result of `getABITypeAlignment(Ty)`, in any case the result is a valid alignment.

Align	getABIIntegerTypeAlignment (unsigned BitWidth) const
	Returns the minimum ABI-required alignment for an integer type of the specified bitwidth.

uint64_t	getPrefTypeAlignment (Type *Ty) const
	Returns the preferred stack/global alignment for the specified type.

Align	getPrefTypeAlign (Type *Ty) const
	Returns the preferred stack/global alignment for the specified type.

IntegerType *	getIntPtrType (LLVMContext &C, unsigned AddressSpace=0) const
	Returns an integer type with size at least as big as that of a pointer in the given address space.

Type *	getIntPtrType (Type *) const
	Returns an integer (vector of integer) type with size at least as big as that of a pointer of the given pointer (vector of pointer) type.

Type *	getSmallestLegalIntType (LLVMContext &C, unsigned Width=0) const
	Returns the smallest integer type with size at least as big as Width bits.

Type *	getLargestLegalIntType (LLVMContext &C) const
	Returns the largest legal integer type, or null if none are set.

unsigned	getLargestLegalIntTypeSizeInBits () const
	Returns the size of largest legal integer type size, or 0 if none are set.

IntegerType *	getIndexType (LLVMContext &C, unsigned AddressSpace) const
	Returns the type of a GEP index in AddressSpace.

Type *	getIndexType (Type *PtrTy) const
	Returns the type of a GEP index.

int64_t	getIndexedOffsetInType (Type ElemTy, ArrayRef< Value > Indices) const
	Returns the offset from the beginning of the type for the specified indices.

SmallVector< APInt >	getGEPIndicesForOffset (Type *&ElemTy, APInt &Offset) const
	Get GEP indices to access Offset inside ElemTy.

std::optional< APInt >	getGEPIndexForOffset (Type *&ElemTy, APInt &Offset) const
	Get single GEP index to access Offset inside ElemTy.

const StructLayout *	getStructLayout (StructType *Ty) const
	Returns a StructLayout object, indicating the alignment of the struct, its size, and the offsets of its fields.

Align	getPreferredAlign (const GlobalVariable *GV) const
	Returns the preferred alignment of the specified global.

Static Public Member Functions
static Expected< DataLayout >	parse (StringRef LayoutDescription)
	Parse a data layout string and return the layout.

static const char *	getManglingComponent (const Triple &T)

Detailed Description

A parsed version of the target data layout string in and methods for querying it.

The target data layout string is specified by the target - a frontend generating LLVM IR is required to generate the right target data for the target being codegen'd to.

Definition at line 110 of file DataLayout.h.

Member Enumeration Documentation

◆ FunctionPtrAlignType

enum class llvm::DataLayout::FunctionPtrAlignType

strong

Enumerator
Independent	The function pointer alignment is independent of the function alignment.
MultipleOfFunctionAlign	The function pointer alignment is a multiple of the function alignment.

Definition at line 112 of file DataLayout.h.

Constructor & Destructor Documentation

◆ DataLayout() [1/3]

llvm::DataLayout::DataLayout ( StringRef LayoutDescription )

inlineexplicit

Constructs a DataLayout from a specification string. See reset().

Definition at line 193 of file DataLayout.h.

References reset().

◆ DataLayout() [2/3]

DataLayout::DataLayout ( const Module * M )

explicit

Initialize target data from properties stored in the module.

Definition at line 553 of file DataLayout.cpp.

References init().

◆ DataLayout() [3/3]

llvm::DataLayout::DataLayout ( const DataLayout & DL )

inline

Definition at line 200 of file DataLayout.h.

References DL.

◆ ~DataLayout()

DataLayout::~DataLayout ( )

Definition at line 714 of file DataLayout.cpp.

Member Function Documentation

◆ doNotMangleLeadingQuestionMark()

bool llvm::DataLayout::doNotMangleLeadingQuestionMark ( ) const

inline

Returns true if symbols with leading question marks should not receive IR mangling.

True for Windows mangling modes.

Definition at line 300 of file DataLayout.h.

◆ exceedsNaturalStackAlignment()

bool llvm::DataLayout::exceedsNaturalStackAlignment ( Align Alignment ) const

inline

Returns true if the given alignment exceeds the natural stack alignment.

Definition at line 267 of file DataLayout.h.

◆ fitsInLegalInteger()

bool llvm::DataLayout::fitsInLegalInteger ( unsigned Width ) const

inline

Returns true if the specified type fits in a native integer type supported by the CPU.

For example, if the CPU only supports i32 as a native integer type, then i27 fits in a legal integer type but i45 does not.

Definition at line 355 of file DataLayout.h.

◆ getABIIntegerTypeAlignment()

Align llvm::DataLayout::getABIIntegerTypeAlignment ( unsigned BitWidth ) const

inline

Returns the minimum ABI-required alignment for an integer type of the specified bitwidth.

Definition at line 534 of file DataLayout.h.

References llvm::BitWidth.

Referenced by llvm::MachineJumpTableInfo::getEntryAlignment().

◆ getABITypeAlign()

Align DataLayout::getABITypeAlign ( Type * Ty ) const

Returns the minimum ABI-required alignment for the specified type.

Definition at line 868 of file DataLayout.cpp.

Referenced by llvm::analyzeArguments(), llvm::FastISel::createMachineMemOperandFor(), getABITypeAlignment(), llvm::SelectionDAG::getConstantPool(), llvm::SelectionDAG::getEVTAlign(), llvm::X86TTIImpl::getMemoryOpCost(), llvm::OpenMPIRBuilder::getOrCreateInternalVariable(), getPreferredAlign(), getTypeAllocSize(), getValueOrABITypeAlignment(), llvm::FastISel::lowerCallTo(), llvm::PPCTargetLowering::PerformDAGCombine(), and solveDIType().

◆ getABITypeAlignment()

uint64_t DataLayout::getABITypeAlignment ( Type * Ty ) const

Returns the minimum ABI-required alignment for the specified type.

TODO: Remove this function once the transition to Align is over.

FIXME: Deprecate this function once migration to Align is over.

Definition at line 864 of file DataLayout.cpp.

References getABITypeAlign(), and llvm::Align::value().

◆ getAllocaAddrSpace()

unsigned llvm::DataLayout::getAllocaAddrSpace ( ) const

inline

Definition at line 276 of file DataLayout.h.

Referenced by llvm::TargetMachine::getAllocaPointerSize(), llvm::MachinePointerInfo::getUnknownStack(), and llvm::ObjectSizeOffsetEvaluator::visitAllocaInst().

◆ getDefaultGlobalsAddressSpace()

unsigned llvm::DataLayout::getDefaultGlobalsAddressSpace ( ) const

inline

Definition at line 290 of file DataLayout.h.

Referenced by llvm::OpenMPIRBuilder::emitOffloadingEntry(), and llvm::OpenMPIRBuilder::getOrCreateIdent().

◆ getFunctionPtrAlign()

MaybeAlign llvm::DataLayout::getFunctionPtrAlign ( ) const

inline

Returns the alignment of function pointers, which may or may not be related to the alignment of functions.

See also: getFunctionPtrAlignType

Definition at line 281 of file DataLayout.h.

◆ getFunctionPtrAlignType()

FunctionPtrAlignType llvm::DataLayout::getFunctionPtrAlignType ( ) const

inline

Return the type of function pointer alignment.

See also: getFunctionPtrAlign

Definition at line 285 of file DataLayout.h.

◆ getGEPIndexForOffset()

std::optional< APInt > DataLayout::getGEPIndexForOffset	(	Type *&	ElemTy,
		APInt &	Offset
	)		const

Get single GEP index to access Offset inside ElemTy.

Returns std::nullopt if index cannot be computed, e.g. because the type is not an aggregate. ElemTy is updated to be the result element type and Offset to be the residual offset.

Definition at line 972 of file DataLayout.cpp.

References llvm::StructLayout::getElementContainingOffset(), getElementIndex(), llvm::StructLayout::getElementOffset(), llvm::StructLayout::getSizeInBytes(), getStructLayout(), getTypeAllocSize(), and llvm::Offset.

Referenced by getGEPIndicesForOffset().

◆ getGEPIndicesForOffset()

SmallVector< APInt > DataLayout::getGEPIndicesForOffset	(	Type *&	ElemTy,
		APInt &	Offset
	)		const

Get GEP indices to access Offset inside ElemTy.

ElemTy is updated to be the result element type and Offset to be the residual offset.

Definition at line 1002 of file DataLayout.cpp.

References assert(), getElementIndex(), getGEPIndexForOffset(), getTypeAllocSize(), llvm::Type::isSized(), llvm::Offset, and llvm::SmallVectorTemplateBase< T, bool >::push_back().

Referenced by llvm::InstCombinerImpl::visitGEPOfGEP().

◆ getGlobalPrefix()

char llvm::DataLayout::getGlobalPrefix ( ) const

inline

Definition at line 312 of file DataLayout.h.

References llvm_unreachable.

Referenced by llvm::emitLinkerFlagsForGlobalCOFF(), and llvm::orc::LLJITBuilderState::prepareForConstruction().

◆ getIndexedOffsetInType()

int64_t DataLayout::getIndexedOffsetInType	(	Type *	ElemTy,
		ArrayRef< Value * >	Indices
	)		const

Returns the offset from the beginning of the type for the specified indices.

Note that this takes the element type, not the pointer type. This is used to implement getelementptr.

Definition at line 923 of file DataLayout.cpp.

References assert(), llvm::gep_type_begin(), llvm::gep_type_end(), llvm::StructLayout::getElementOffset(), llvm::generic_gep_type_iterator< ItTy >::getIndexedType(), llvm::generic_gep_type_iterator< ItTy >::getOperand(), getStructLayout(), llvm::generic_gep_type_iterator< ItTy >::getStructTypeOrNull(), getTypeAllocSize(), and Idx.

Referenced by llvm::InstCombinerImpl::visitGEPOfGEP().

◆ getIndexSize()

unsigned DataLayout::getIndexSize ( unsigned AS ) const

rounded up to a whole number of bytes.

Definition at line 768 of file DataLayout.cpp.

References llvm::divideCeil().

◆ getIndexSizeInBits()

unsigned llvm::DataLayout::getIndexSizeInBits ( unsigned AS ) const

inline

Size in bits of index used for address calculation in getelementptr.

Definition at line 416 of file DataLayout.h.

References llvm::PointerAlignElem::IndexBitWidth.

Referenced by llvm::GISelKnownBits::computeKnownBitsImpl(), llvm::BasicTTIImplBase< T >::getEstimatedNumberOfCaseClusters(), getIndexType(), getIndexTypeSizeInBits(), simplifyGEPInst(), and llvm::InstCombinerImpl::visitGetElementPtrInst().

◆ getIndexType() [1/2]

IntegerType * DataLayout::getIndexType	(	LLVMContext &	C,
		unsigned	AddressSpace
	)		const

Returns the type of a GEP index in AddressSpace.

If it was not specified explicitly, it will be the integer type of the pointer width - IntPtrType.

Definition at line 908 of file DataLayout.cpp.

References llvm::CallingConv::C, llvm::IntegerType::get(), and getIndexSizeInBits().

Referenced by llvm::ObjectSizeOffsetEvaluator::compute(), llvm::InstCombinerImpl::foldCmpLoadFromIndexedGlobal(), llvm::ScalarEvolution::getEffectiveSCEVType(), simplifyAllocaArraySize(), llvm::ObjectSizeOffsetEvaluator::visitAllocaInst(), llvm::InstCombinerImpl::visitGetElementPtrInst(), and llvm::PtrUseVisitor< DerivedT >::visitPtr().

◆ getIndexType() [2/2]

Type * DataLayout::getIndexType ( Type * PtrTy ) const

Returns the type of a GEP index.

If it was not specified explicitly, it will be the integer type of the pointer width - IntPtrType.

Definition at line 913 of file DataLayout.cpp.

References assert(), llvm::IntegerType::get(), llvm::VectorType::get(), llvm::Type::getContext(), getIndexTypeSizeInBits(), and llvm::Type::isPtrOrPtrVectorTy().

◆ getIndexTypeSizeInBits()

unsigned DataLayout::getIndexTypeSizeInBits ( Type * Ty ) const

Layout size of the index used in GEP calculation.

The function should be called with pointer or vector of pointers type.

Definition at line 772 of file DataLayout.cpp.

References assert(), getIndexSizeInBits(), llvm::Type::getScalarType(), and llvm::Type::isPtrOrPtrVectorTy().

Referenced by llvm::ObjectSizeOffsetVisitor::compute(), getIndexType(), llvm::ScalarEvolution::getTypeSizeInBits(), llvm::simplifyLoadInst(), and llvm::InstCombinerImpl::visitGEPOfGEP().

◆ getIntPtrType() [1/2]

IntegerType * DataLayout::getIntPtrType	(	LLVMContext &	C,
		unsigned	AddressSpace = `0`
	)		const

Returns an integer type with size at least as big as that of a pointer in the given address space.

Definition at line 881 of file DataLayout.cpp.

References llvm::CallingConv::C, llvm::IntegerType::get(), and getPointerSizeInBits().

Referenced by llvm::OpenMPIRBuilder::emitOffloadingEntry(), llvm::ARMSelectionDAGInfo::EmitSpecializedLibcall(), llvm::HexagonSelectionDAGInfo::EmitTargetCodeForMemcpy(), llvm::XCoreSelectionDAGInfo::EmitTargetCodeForMemcpy(), llvm::InstCombinerImpl::foldICmpInstWithConstantNotInt(), llvm::SelectionDAG::getAtomicMemcpy(), llvm::SelectionDAG::getAtomicMemmove(), llvm::SelectionDAG::getAtomicMemset(), llvm::ScalarEvolution::getLosslessPtrToIntExpr(), llvm::SelectionDAG::getMemcpy(), llvm::SelectionDAG::getMemmove(), llvm::IntrinsicLowering::LowerIntrinsicCall(), simplifyCastInst(), llvm::InstCombinerImpl::visitIntToPtr(), and llvm::InstCombinerImpl::visitPtrToInt().

◆ getIntPtrType() [2/2]

Type * DataLayout::getIntPtrType ( Type * Ty ) const

Returns an integer (vector of integer) type with size at least as big as that of a pointer of the given pointer (vector of pointer) type.

Definition at line 886 of file DataLayout.cpp.

References assert(), llvm::IntegerType::get(), llvm::VectorType::get(), llvm::Type::getContext(), getPointerTypeSizeInBits(), and llvm::Type::isPtrOrPtrVectorTy().

◆ getLargestLegalIntType()

Type * llvm::DataLayout::getLargestLegalIntType ( LLVMContext & C ) const

inline

Returns the largest legal integer type, or null if none are set.

Definition at line 565 of file DataLayout.h.

References llvm::CallingConv::C, llvm::Type::getIntNTy(), and getLargestLegalIntTypeSizeInBits().

◆ getLargestLegalIntTypeSizeInBits()

unsigned DataLayout::getLargestLegalIntTypeSizeInBits ( ) const

Returns the size of largest legal integer type size, or 0 if none are set.

Definition at line 903 of file DataLayout.cpp.

References llvm::SmallVectorTemplateCommon< T, typename >::begin(), and llvm::SmallVectorTemplateCommon< T, typename >::end().

Referenced by getLargestLegalIntType().

◆ getLinkerPrivateGlobalPrefix()

StringRef llvm::DataLayout::getLinkerPrivateGlobalPrefix ( ) const

inline

Definition at line 306 of file DataLayout.h.

◆ getManglingComponent()

const char * DataLayout::getManglingComponent ( const Triple & T )

static

Definition at line 169 of file DataLayout.cpp.

References llvm::Triple::x86.

Referenced by computeDataLayout(), and getDataLayoutString().

◆ getMaxIndexSize()

unsigned DataLayout::getMaxIndexSize ( ) const

Returns the maximum index size over all address spaces.

Definition at line 752 of file DataLayout.cpp.

References llvm::divideCeil(), and P.

Referenced by getMaxIndexSizeInBits().

◆ getMaxIndexSizeInBits()

unsigned llvm::DataLayout::getMaxIndexSizeInBits ( ) const

inline

Returns the maximum index size over all address spaces.

Definition at line 411 of file DataLayout.h.

References getMaxIndexSize().

◆ getNonIntegralAddressSpaces()

ArrayRef< unsigned > llvm::DataLayout::getNonIntegralAddressSpaces ( ) const

inline

Return the address spaces containing non-integral pointers.

Pointers in this address space don't have a well-defined bitwise representation.

Definition at line 385 of file DataLayout.h.

Referenced by isNonIntegralAddressSpace().

◆ getPointerABIAlignment()

Align DataLayout::getPointerABIAlignment ( unsigned AS ) const

Layout pointer alignment.

Definition at line 740 of file DataLayout.cpp.

References llvm::PointerAlignElem::ABIAlign.

Referenced by llvm::MachineJumpTableInfo::getEntryAlignment().

◆ getPointerPrefAlignment()

Align DataLayout::getPointerPrefAlignment ( unsigned AS = 0 ) const

Return target's alignment for stack-based pointers FIXME: The defaults need to be removed once all of the backends/clients are updated.

Definition at line 744 of file DataLayout.cpp.

References llvm::PointerAlignElem::PrefAlign.

◆ getPointerSize()

unsigned DataLayout::getPointerSize ( unsigned AS = 0 ) const

Layout pointer size in bytes, rounded up to a whole number of bytes.

FIXME: The defaults need to be removed once all of the backends/clients are updated.

Definition at line 748 of file DataLayout.cpp.

References llvm::divideCeil().

Referenced by llvm::SystemZXPLINKFrameLowering::determineFrameLayout(), llvm::TargetLoweringBase::emitPatchPoint(), llvm::TargetMachine::getAllocaPointerSize(), llvm::MachineJumpTableInfo::getEntrySize(), llvm::TargetMachine::getPointerSize(), llvm::TargetMachine::getProgramPointerSize(), and isTargetNullPtr().

◆ getPointerSizeInBits()

unsigned llvm::DataLayout::getPointerSizeInBits ( unsigned AS = 0 ) const

inline

Layout pointer size, in bits FIXME: The defaults need to be removed once all of the backends/clients are updated.

Definition at line 406 of file DataLayout.h.

References llvm::PointerAlignElem::TypeBitWidth.

Referenced by llvm::InstructionSelector::executeMatchTable(), llvm::InstCombinerImpl::foldIntegerTypedPHI(), llvm::ExecutionEngine::getConstantValue(), getIntPtrType(), llvm::TargetMachine::getPointerSizeInBits(), getPointerTypeSizeInBits(), getTypeSizeInBits(), lle_X_sprintf(), llvm::GCNTTIImpl::rewriteIntrinsicWithAddressSpace(), simplifyGEPInst(), unpackFromMemLoc(), llvm::InstCombinerImpl::visitIntToPtr(), and llvm::InstCombinerImpl::visitPtrToInt().

◆ getPointerTypeSize()

unsigned llvm::DataLayout::getPointerTypeSize ( Type * Ty ) const

inline

Definition at line 431 of file DataLayout.h.

References getPointerTypeSizeInBits().

◆ getPointerTypeSizeInBits()

unsigned DataLayout::getPointerTypeSizeInBits ( Type * Ty ) const

Layout pointer size, in bits, based on the type.

If this function is called with a pointer type, then the type size of the pointer is returned. If this function is called with a vector of pointers, then the type size of the pointer is returned. This should only be called with a pointer or vector of pointers.

Definition at line 761 of file DataLayout.cpp.

References assert(), getPointerSizeInBits(), llvm::Type::getScalarType(), and llvm::Type::isPtrOrPtrVectorTy().

Referenced by llvm::InstCombinerImpl::foldICmpUsingKnownBits(), llvm::InstCombinerImpl::foldICmpWithCastOp(), llvm::TargetTransformInfoImplBase::getCastInstrCost(), llvm::TargetTransformInfoImplCRTPBase< T >::getGEPCost(), llvm::SelectionDAG::getGlobalAddress(), getIntPtrType(), getPointerTypeSize(), and llvm::SelectionDAG::InferPtrAlign().

◆ getPreferredAlign()

Align DataLayout::getPreferredAlign ( const GlobalVariable * GV ) const

Returns the preferred alignment of the specified global.

getPreferredAlign - Return the preferred alignment of the specified global.

This includes an explicitly requested alignment (if the global has one).

Definition at line 1019 of file DataLayout.cpp.

References getABITypeAlign(), llvm::GlobalObject::getAlign(), getPrefTypeAlign(), getTypeSizeInBits(), llvm::GlobalValue::getValueType(), llvm::GlobalVariable::hasInitializer(), and llvm::GlobalObject::hasSection().

Referenced by getAlign(), getELFSectionNameForGlobal(), promoteToConstantPool(), llvm::TargetLoweringObjectFileMachO::SelectSectionForGlobal(), and llvm::TargetLoweringObjectFileXCOFF::SelectSectionForGlobal().

◆ getPrefTypeAlign()

Align DataLayout::getPrefTypeAlign ( Type * Ty ) const

Returns the preferred stack/global alignment for the specified type.

This is always at least as good as the ABI alignment.

Definition at line 877 of file DataLayout.cpp.

Referenced by llvm::TargetLowering::CTTZTableLookup(), llvm::OpenMPIRBuilder::emitTargetKernel(), llvm::PPCInstrInfo::finalizeInsInstrs(), llvm::SelectionDAG::getConstantPool(), getPreferredAlign(), getPrefTypeAlign(), getPrefTypeAlignment(), llvm::X86TTIImpl::getVectorInstrCost(), ReplaceLoadVector(), solveDIType(), llvm::InstCombinerImpl::visitLoadInst(), llvm::SelectionDAGBuilder::visitSPDescriptorParent(), and llvm::InstCombinerImpl::visitStoreInst().

◆ getPrefTypeAlignment()

uint64_t DataLayout::getPrefTypeAlignment ( Type * Ty ) const

Returns the preferred stack/global alignment for the specified type.

TODO: Remove this function once the transition to Align is over.

This is always at least as good as the ABI alignment. FIXME: Deprecate this function once migration to Align is over.

Definition at line 873 of file DataLayout.cpp.

References getPrefTypeAlign(), and llvm::Align::value().

◆ getPrivateGlobalPrefix()

StringRef llvm::DataLayout::getPrivateGlobalPrefix ( ) const

inline

Definition at line 328 of file DataLayout.h.

References llvm_unreachable.

Referenced by llvm::TargetLoweringObjectFileMachO::getIndirectSymViaGOTPCRel(), llvm::TargetLoweringObjectFile::getSymbolWithGlobalValueBase(), and llvm::MipsAsmPrinter::printOperand().

◆ getProgramAddressSpace()

unsigned llvm::DataLayout::getProgramAddressSpace ( ) const

inline

Definition at line 289 of file DataLayout.h.

Referenced by llvm::Module::getOrInsertFunction(), llvm::TargetMachine::getProgramPointerSize(), and maybePrintCallAddrSpace().

◆ getSmallestLegalIntType()

Type * DataLayout::getSmallestLegalIntType	(	LLVMContext &	C,
		unsigned	Width = `0`
	)		const

Returns the smallest integer type with size at least as big as Width bits.

Definition at line 896 of file DataLayout.cpp.

References llvm::CallingConv::C, and llvm::Type::getIntNTy().

Referenced by llvm::InstCombinerImpl::foldCmpLoadFromIndexedGlobal().

◆ getStackAlignment()

Align llvm::DataLayout::getStackAlignment ( ) const

inline

Definition at line 271 of file DataLayout.h.

References assert().

Referenced by CC_AArch64_Custom_Block().

◆ getStringRepresentation()

const std::string & llvm::DataLayout::getStringRepresentation ( ) const

inline

Returns the string representation of the DataLayout.

This representation is in the same format accepted by the string constructor above. This should not be used to compare two DataLayout as different string can represent the same layout.

Definition at line 246 of file DataLayout.h.

Referenced by llvm::orc::LLJIT::applyDataLayout(), and llvm::orc::LLJITBuilderState::prepareForConstruction().

◆ getStructLayout()

const StructLayout * DataLayout::getStructLayout ( StructType * Ty ) const

Returns a StructLayout object, indicating the alignment of the struct, its size, and the offsets of its fields.

Note that this information is lazily cached.

Definition at line 718 of file DataLayout.cpp.

References llvm::StructType::getNumElements(), and llvm::safe_malloc().

Referenced by llvm::TargetTransformInfoImplCRTPBase< T >::getGEPCost(), getGEPIndexForOffset(), getIndexedOffsetInType(), llvm::ScalarEvolution::getOffsetOfExpr(), getTypeSizeInBits(), llvm::ExecutionEngine::InitializeMemory(), llvm::FastISel::selectGetElementPtr(), and solveDIType().

◆ getTypeAllocSize()

TypeSize llvm::DataLayout::getTypeAllocSize ( Type * Ty ) const

inline

Returns the offset in bytes between successive objects of the specified type, including alignment padding.

If Ty is a scalable vector type, the scalable property will be set and the runtime size will be a positive integer multiple of the base size.

This is the amount that alloca reserves for this type. For example, returns 12 or 16 for x86_fp80, depending on alignment.

Definition at line 500 of file DataLayout.h.

References llvm::alignTo(), getABITypeAlign(), getTypeStoreSize(), and value.

Referenced by llvm::GCNTTIImpl::adjustInliningThreshold(), llvm::analyzeArguments(), llvm::ExecutionEngine::emitGlobalVariable(), llvm::CSKYAsmPrinter::emitMachineConstantPoolValue(), llvm::SystemZAsmPrinter::emitMachineConstantPoolValue(), llvm::ARMAsmPrinter::emitXXStructor(), llvm::InstCombinerImpl::foldCmpLoadFromIndexedGlobal(), llvm::ARMTTIImpl::getGatherScatterOpCost(), llvm::TargetTransformInfoImplCRTPBase< T >::getGEPCost(), getGEPIndexForOffset(), getGEPIndicesForOffset(), getIndexedOffsetInType(), getTypeAllocSizeInBits(), llvm::dxil::CBufferDataLayout::getTypeAllocSizeInBytes(), llvm::AMDGPUTTIImpl::getUnrollingPreferences(), llvm::ExecutionEngine::InitializeMemory(), llvm::HexagonTargetObjectFile::isGlobalInSmallSection(), llvm::RISCVELFTargetObjectFile::isGlobalInSmallSection(), llvm::SparcTargetLowering::LowerCall_32(), llvm::FastISel::lowerCallTo(), llvm::X86TargetLowering::markLibCallAttributes(), performGlobalAddressCombine(), promoteToConstantPool(), llvm::FastISel::selectGetElementPtr(), llvm::FunctionLoweringInfo::set(), simplifyGEPInst(), llvm::InstCombinerImpl::visitAllocaInst(), llvm::ObjectSizeOffsetVisitor::visitAllocaInst(), llvm::ObjectSizeOffsetEvaluator::visitAllocaInst(), llvm::Interpreter::visitAllocaInst(), llvm::ObjectSizeOffsetVisitor::visitArgument(), llvm::InstCombinerImpl::visitGetElementPtrInst(), and llvm::ObjectSizeOffsetVisitor::visitGlobalVariable().

◆ getTypeAllocSizeInBits()

TypeSize llvm::DataLayout::getTypeAllocSizeInBits ( Type * Ty ) const

inline

Returns the offset in bits between successive objects of the specified type, including alignment padding; always a multiple of 8.

If Ty is a scalable vector type, the scalable property will be set and the runtime size will be a positive integer multiple of the base size.

This is the amount that alloca reserves for this type. For example, returns 96 or 128 for x86_fp80, depending on alignment.

Definition at line 513 of file DataLayout.h.

References getTypeAllocSize().

Referenced by getTypeSizeInBits().

◆ getTypeSizeInBits()

TypeSize llvm::DataLayout::getTypeSizeInBits ( Type * Ty ) const

inline

Size examples:

Type SizeInBits StoreSizeInBits AllocSizeInBits[*]

i1 1 8 8 i8 8 8 8 i19 19 24 32 i32 32 32 32 i100 100 104 128 i128 128 128 128 Float 32 32 32 Double 64 64 64 X86_FP80 80 80 96

[*] The alloc size depends on the alignment, and thus on the target. These values are for x86-32 linux. Returns the number of bits necessary to hold the specified type.

If Ty is a scalable vector type, the scalable property will be set and the runtime size will be a positive integer multiple of the base size.

For example, returns 36 for i36 and 80 for x86_fp80. The type passed must have a size (Type::isSized() must return true).

Definition at line 673 of file DataLayout.h.

References llvm::Type::ArrayTyID, assert(), llvm::Type::BFloatTyID, llvm::Type::DoubleTyID, llvm::TypeSize::Fixed(), llvm::Type::FixedVectorTyID, llvm::Type::FloatTyID, llvm::Type::FP128TyID, llvm::VectorType::getElementCount(), llvm::ArrayType::getElementType(), llvm::VectorType::getElementType(), llvm::details::FixedOrScalableQuantity< LeafTy, ValueTy >::getFixedValue(), llvm::Type::getIntegerBitWidth(), llvm::ArrayType::getNumElements(), llvm::Type::getPointerAddressSpace(), getPointerSizeInBits(), llvm::StructLayout::getSizeInBits(), getStructLayout(), getTypeAllocSizeInBits(), llvm::Type::getTypeID(), getTypeSizeInBits(), llvm::Type::HalfTyID, llvm::Type::IntegerTyID, llvm::Type::isSized(), llvm::Type::LabelTyID, llvm_unreachable, llvm::Type::PointerTyID, llvm::Type::PPC_FP128TyID, llvm::Type::ScalableVectorTyID, llvm::Type::StructTyID, llvm::Type::TargetExtTyID, llvm::Type::X86_AMXTyID, llvm::Type::X86_FP80TyID, and llvm::Type::X86_MMXTyID.

Referenced by buildFrameDebugInfo(), llvm::FastISel::canFoldAddIntoGEP(), llvm::InstCombinerImpl::foldIntegerTypedPHI(), llvm::TargetTransformInfoImplBase::getCastInstrCost(), llvm::ExecutionEngine::getConstantValue(), llvm::HexagonTTIImpl::getInstructionCost(), llvm::ARMTTIImpl::getInterleavedMemoryOpCost(), llvm::X86TTIImpl::getInterleavedMemoryOpCost(), llvm::RISCVTTIImpl::getIntImmCost(), llvm::X86TTIImpl::getMemoryOpCost(), getPreferredAlign(), llvm::RISCVTTIImpl::getRegUsageForType(), llvm::X86TTIImpl::getReplicationShuffleCost(), llvm::GCNTTIImpl::getShuffleCost(), llvm::ScalarEvolution::getTypeSizeInBits(), getTypeSizeInBits(), getTypeStoreSize(), llvm::GCNTTIImpl::getVectorInstrCost(), llvm::R600TTIImpl::getVectorInstrCost(), simplifyAMDGCNMemoryIntrinsicDemanded(), simplifyGEPInst(), simplifyICmpInst(), solveDIType(), typeSizeEqualsStoreSize(), and llvm::InstCombinerImpl::visitShuffleVectorInst().

◆ getTypeStoreSize()

TypeSize llvm::DataLayout::getTypeStoreSize ( Type * Ty ) const

inline

Returns the maximum number of bytes that may be overwritten by storing the specified type.

If Ty is a scalable vector type, the scalable property will be set and the runtime size will be a positive integer multiple of the base size.

For example, returns 5 for i36 and 10 for x86_fp80.

Definition at line 468 of file DataLayout.h.

References llvm::divideCeil(), llvm::details::FixedOrScalableQuantity< LeafTy, ValueTy >::getKnownMinValue(), getTypeSizeInBits(), and llvm::details::FixedOrScalableQuantity< LeafTy, ValueTy >::isScalable().

Referenced by llvm::FastISel::createMachineMemOperandFor(), llvm::OpenMPIRBuilder::createTask(), emitGlobalConstantLargeInt(), llvm::X86TTIImpl::getInterleavedMemoryOpCostAVX512(), llvm::RISCVTTIImpl::getPointersChainCost(), llvm::X86TTIImpl::getShuffleCost(), getTypeAllocSize(), getTypeStoreSizeInBits(), llvm::X86TTIImpl::isLegalNTLoad(), llvm::TargetTransformInfoImplBase::isLegalNTLoad(), llvm::X86TTIImpl::isLegalNTStore(), llvm::TargetTransformInfoImplBase::isLegalNTStore(), llvm::ExecutionEngine::LoadValueFromMemory(), llvm::SPIRVCallLowering::lowerCall(), llvm::promoteLoopAccessesToScalars(), llvm::IRTranslator::runOnMachineFunction(), and llvm::ExecutionEngine::StoreValueToMemory().

◆ getTypeStoreSizeInBits()

TypeSize llvm::DataLayout::getTypeStoreSizeInBits ( Type * Ty ) const

inline

Returns the maximum number of bits that may be overwritten by storing the specified type; always a multiple of 8.

If Ty is a scalable vector type, the scalable property will be set and the runtime size will be a positive integer multiple of the base size.

For example, returns 40 for i36 and 80 for x86_fp80.

Definition at line 480 of file DataLayout.h.

References getTypeStoreSize().

Referenced by typeSizeEqualsStoreSize().

◆ getValueOrABITypeAlignment()

Align llvm::DataLayout::getValueOrABITypeAlignment	(	MaybeAlign	Alignment,
		Type *	Ty
	)		const

inline

Helper function to return Alignment if it's set or the result of getABITypeAlignment(Ty), in any case the result is a valid alignment.

Definition at line 527 of file DataLayout.h.

References getABITypeAlign().

◆ hasLinkerPrivateGlobalPrefix()

bool llvm::DataLayout::hasLinkerPrivateGlobalPrefix ( ) const

inline

Definition at line 304 of file DataLayout.h.

◆ hasMicrosoftFastStdCallMangling()

bool llvm::DataLayout::hasMicrosoftFastStdCallMangling ( ) const

inline

Definition at line 294 of file DataLayout.h.

◆ init()

void DataLayout::init ( const Module * M )

Definition at line 557 of file DataLayout.cpp.

Referenced by DataLayout().

◆ isBigEndian()

bool llvm::DataLayout::isBigEndian ( ) const

inline

Definition at line 239 of file DataLayout.h.

Referenced by llvm::DwarfExpression::addConstantFP(), canCombineShuffleToExtendVectorInreg(), combineShuffleToAnyExtendVectorInreg(), combineShuffleToZeroExtendVectorInReg(), combineTruncationShuffle(), createGPRPairNode(), emitGlobalConstantFP(), llvm::RISCVInstrInfo::foldMemoryOperandImpl(), foldVecTruncToExtElt(), getCopyFromParts(), getCopyToParts(), getPPCf128HiElementSelector(), isExtendedBUILD_VECTOR(), isVMOVModifiedImm(), llvm::LegalizerHelper::lowerLoad(), LowerPredicateLoad(), LowerPredicateStore(), llvm::CombinerHelper::matchLoadOrCombine(), narrowExtractedVectorLoad(), optimizeIntegerToVectorInsertions(), optimizeVectorResizeWithIntegerBitCasts(), PerformBITCASTCombine(), PerformSTORECombine(), PerformTruncatingStoreCombine(), PerformVMOVRRDCombine(), reduceBuildVecToShuffleWithZero(), llvm::LegalizerHelper::reduceLoadStoreWidth(), ReplaceATOMIC_LOAD_128Results(), ReplaceCMP_SWAP_128Results(), ReplaceCMP_SWAP_64Results(), llvm::TargetLowering::scalarizeVectorLoad(), llvm::TargetLowering::scalarizeVectorStore(), SkipExtensionForVMULL(), llvm::InstCombinerImpl::visitBitCast(), llvm::InstCombinerImpl::visitInsertElementInst(), llvm::InstCombinerImpl::visitShuffleVectorInst(), and llvm::InstCombinerImpl::visitTrunc().

◆ isDefault()

bool llvm::DataLayout::isDefault ( ) const

inline

Test if the DataLayout was constructed from an empty string.

Definition at line 251 of file DataLayout.h.

Referenced by llvm::ExecutionEngine::getMangledName().

◆ isIllegalInteger()

bool llvm::DataLayout::isIllegalInteger ( uint64_t Width ) const

inline

Definition at line 264 of file DataLayout.h.

References isLegalInteger().

◆ isLegalInteger()

bool llvm::DataLayout::isLegalInteger ( uint64_t Width ) const

inline

Returns true if the specified type is known to be a native integer type supported by the CPU.

For example, i64 is not native on most 32-bit CPUs and i37 is not native on any known one. This returns false if the integer width is not legal.

The width is specified in bits.

Definition at line 260 of file DataLayout.h.

References llvm::is_contained().

Referenced by llvm::InstCombinerImpl::foldICmpShlConstant(), llvm::TargetTransformInfoImplBase::getCastInstrCost(), isIllegalInteger(), llvm::InstCombinerImpl::visitBitCast(), visitIVCast(), and llvm::InstCombinerImpl::visitPHINode().

◆ isLittleEndian()

bool llvm::DataLayout::isLittleEndian ( ) const

inline

Layout endianness...

Definition at line 238 of file DataLayout.h.

Referenced by llvm::DwarfUnit::addConstantValue(), addShuffleForVecExtend(), llvm::SparcTargetLowering::bitcastConstantFPToInt(), combineBVOfVecSExt(), llvm::SelectionDAG::computeKnownBits(), llvm::SelectionDAG::ComputeNumSignBits(), llvm::DwarfDebug::emitDebugLocEntry(), llvm::TargetLowering::expandMULO(), llvm::TargetLowering::expandUnalignedLoad(), llvm::TargetLowering::expandUnalignedStore(), llvm::SelectionDAG::FoldConstantArithmetic(), getMemsetStringVal(), llvm::PPC::getSplatIdxForPPCMnemonics(), llvm::TargetInstrInfo::getStackSlotRange(), llvm::PPCTTIImpl::instCombineIntrinsic(), llvm::PPC::isVMRGEOShuffleMask(), llvm::PPC::isVMRGHShuffleMask(), llvm::PPC::isVMRGLShuffleMask(), llvm::PPC::isVPKUDUMShuffleMask(), llvm::PPC::isVPKUHUMShuffleMask(), llvm::PPC::isVPKUWUMShuffleMask(), llvm::PPC::isVSLDOIShuffleMask(), LowerF64Op(), LowerFNEGorFABS(), llvm::SparcTargetLowering::LowerFormalArguments_32(), LowerSTORE(), performUzpCombine(), llvm::IRTranslator::runOnMachineFunction(), ShrinkLoadReplaceStoreWithStore(), llvm::TargetLowering::SimplifyDemandedBits(), llvm::TargetLowering::SimplifyDemandedVectorElts(), llvm::TargetLowering::SimplifyMultipleUseDemandedBits(), and llvm::TargetLowering::SimplifySetCC().

◆ isNonIntegralAddressSpace()

bool llvm::DataLayout::isNonIntegralAddressSpace ( unsigned AddrSpace ) const

inline

Definition at line 389 of file DataLayout.h.

References getNonIntegralAddressSpaces(), and llvm::is_contained().

Referenced by llvm::GISelKnownBits::computeKnownBitsImpl(), isNonIntegralPointerType(), and llvm::LegalizerHelper::lowerMergeValues().

◆ isNonIntegralPointerType() [1/2]

bool llvm::DataLayout::isNonIntegralPointerType ( PointerType * PT ) const

inline

Definition at line 394 of file DataLayout.h.

References llvm::PointerType::getAddressSpace(), and isNonIntegralAddressSpace().

Referenced by isNonIntegralPointerType().

◆ isNonIntegralPointerType() [2/2]

bool llvm::DataLayout::isNonIntegralPointerType ( Type * Ty ) const

inline

Definition at line 398 of file DataLayout.h.

References isNonIntegralPointerType().

◆ operator!=()

bool llvm::DataLayout::operator!= ( const DataLayout & Other ) const

inline

Definition at line 226 of file DataLayout.h.

References llvm::Other.

◆ operator=()

DataLayout & llvm::DataLayout::operator= ( const DataLayout & DL )

inline

Definition at line 204 of file DataLayout.h.

References DL.

◆ operator==()

bool DataLayout::operator== ( const DataLayout & Other ) const

Definition at line 559 of file DataLayout.cpp.

References llvm::Other.

◆ parse()

Expected< DataLayout > DataLayout::parse ( StringRef LayoutDescription )

static

Parse a data layout string and return the layout.

Return an error description on failure.

Definition at line 223 of file DataLayout.cpp.

◆ reset()

void DataLayout::reset ( StringRef LayoutDescription )

Parse a data layout string (with fallback to default values).

Definition at line 195 of file DataLayout.cpp.

References llvm::SmallVectorImpl< T >::clear(), DefaultAlignments, llvm::LayoutAlignElem::get(), Independent, and llvm::report_fatal_error().

Referenced by DataLayout(), and llvm::Module::setDataLayout().

◆ typeSizeEqualsStoreSize()

bool llvm::DataLayout::typeSizeEqualsStoreSize ( Type * Ty ) const

inline

Returns true if no extra padding bits are needed when storing the specified type.

For example, returns false for i19 that has a 24-bit store size.

Definition at line 488 of file DataLayout.h.

References getTypeSizeInBits(), and getTypeStoreSizeInBits().

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

include/llvm/IR/DataLayout.h
lib/IR/DataLayout.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ FunctionPtrAlignType

Constructor & Destructor Documentation

◆ DataLayout() [1/3]

◆ DataLayout() [2/3]

◆ DataLayout() [3/3]

◆ ~DataLayout()

Member Function Documentation

◆ doNotMangleLeadingQuestionMark()

◆ exceedsNaturalStackAlignment()

◆ fitsInLegalInteger()

◆ getABIIntegerTypeAlignment()

◆ getABITypeAlign()

◆ getABITypeAlignment()

◆ getAllocaAddrSpace()

◆ getDefaultGlobalsAddressSpace()

◆ getFunctionPtrAlign()

◆ getFunctionPtrAlignType()

◆ getGEPIndexForOffset()

◆ getGEPIndicesForOffset()

◆ getGlobalPrefix()

◆ getIndexedOffsetInType()

◆ getIndexSize()

◆ getIndexSizeInBits()

◆ getIndexType() [1/2]

◆ getIndexType() [2/2]

◆ getIndexTypeSizeInBits()

◆ getIntPtrType() [1/2]

◆ getIntPtrType() [2/2]

◆ getLargestLegalIntType()

◆ getLargestLegalIntTypeSizeInBits()

◆ getLinkerPrivateGlobalPrefix()

◆ getManglingComponent()

◆ getMaxIndexSize()

◆ getMaxIndexSizeInBits()

◆ getNonIntegralAddressSpaces()

◆ getPointerABIAlignment()

◆ getPointerPrefAlignment()

◆ getPointerSize()

◆ getPointerSizeInBits()

◆ getPointerTypeSize()

◆ getPointerTypeSizeInBits()

◆ getPreferredAlign()

◆ getPrefTypeAlign()

◆ getPrefTypeAlignment()

◆ getPrivateGlobalPrefix()

◆ getProgramAddressSpace()

◆ getSmallestLegalIntType()

◆ getStackAlignment()

◆ getStringRepresentation()

◆ getStructLayout()

◆ getTypeAllocSize()

◆ getTypeAllocSizeInBits()

◆ getTypeSizeInBits()

◆ getTypeStoreSize()

◆ getTypeStoreSizeInBits()

◆ getValueOrABITypeAlignment()

◆ hasLinkerPrivateGlobalPrefix()

◆ hasMicrosoftFastStdCallMangling()

◆ init()

◆ isBigEndian()

◆ isDefault()

◆ isIllegalInteger()

◆ isLegalInteger()

◆ isLittleEndian()

◆ isNonIntegralAddressSpace()

◆ isNonIntegralPointerType() [1/2]

◆ isNonIntegralPointerType() [2/2]

◆ operator!=()

◆ operator=()

◆ operator==()

◆ parse()

◆ reset()

◆ typeSizeEqualsStoreSize()