The main mechanism for performing data layout queries. More...

#include "mlir/Interfaces/DataLayoutInterfaces.h"

Public Member Functions
	DataLayout ()

	DataLayout (DataLayoutOpInterface op)

	DataLayout (ModuleOp op)

llvm::TypeSize	getTypeSize (Type t) const
	Returns the size of the given type in the current scope. More...

llvm::TypeSize	getTypeSizeInBits (Type t) const
	Returns the size in bits of the given type in the current scope. More...

uint64_t	getTypeABIAlignment (Type t) const
	Returns the required alignment of the given type in the current scope. More...

uint64_t	getTypePreferredAlignment (Type t) const
	Returns the preferred of the given type in the current scope. More...

std::optional< uint64_t >	getTypeIndexBitwidth (Type t) const
	Returns the bitwidth that should be used when performing index computations for the given pointer-like type in the current scope. More...

Attribute	getEndianness () const
	Returns the specified endianness. More...

Attribute	getAllocaMemorySpace () const
	Returns the memory space used for AllocaOps. More...

Attribute	getProgramMemorySpace () const
	Returns the memory space used for program memory operations. More...

Attribute	getGlobalMemorySpace () const
	Returns the memory space used for global operations. More...

uint64_t	getStackAlignment () const
	Returns the natural alignment of the stack in bits. More...

std::optional< Attribute >	getDevicePropertyValue (TargetSystemSpecInterface::DeviceID, StringAttr propertyName) const
	Returns the value of the specified property if the property is defined for the given device ID, otherwise returns std::nullopt. More...

Static Public Member Functions
static DataLayout	closest (Operation *op)
	Returns the layout of the closest parent operation carrying layout info. More...

Detailed Description

The main mechanism for performing data layout queries.

Instances of this class can be created for an operation implementing DataLayoutOpInterface. Upon construction, a layout spec combining that of the given operation with all its ancestors will be computed and used to handle further requests. For efficiency, results to all requests will be cached in this object. Therefore, if the data layout spec for the scoping operation, or any of the enclosing operations, changes, the cache is no longer valid. The user is responsible creating a new DataLayout object after any spec change. In debug mode, the cache validity is being checked in every request.

Definition at line 201 of file DataLayoutInterfaces.h.

Constructor & Destructor Documentation

◆ DataLayout() [1/3]

mlir::DataLayout::DataLayout ( )

explicit

Definition at line 451 of file DataLayoutInterfaces.cpp.

◆ DataLayout() [2/3]

mlir::DataLayout::DataLayout ( DataLayoutOpInterface op )

explicit

Definition at line 453 of file DataLayoutInterfaces.cpp.

References checkMissingLayout(), and collectParentLayouts().

◆ DataLayout() [3/3]

mlir::DataLayout::DataLayout ( ModuleOp op )

explicit

Definition at line 464 of file DataLayoutInterfaces.cpp.

References checkMissingLayout(), and collectParentLayouts().

Member Function Documentation

◆ closest()

mlir::DataLayout mlir::DataLayout::closest ( Operation * op )

static

Returns the layout of the closest parent operation carrying layout info.

Definition at line 475 of file DataLayoutInterfaces.cpp.

References mlir::Operation::getParentOp().

Referenced by defaultIsSmallAlloc(), handleByValArgument(), memcpyEnsureOnlySafeAccesses(), and verifyAtomicMemOp().

◆ getAllocaMemorySpace()

mlir::Attribute mlir::DataLayout::getAllocaMemorySpace ( ) const

Returns the memory space used for AllocaOps.

Definition at line 599 of file DataLayoutInterfaces.cpp.

References mlir::detail::getDefaultAllocaMemorySpace().

◆ getDevicePropertyValue()

std::optional< Attribute > mlir::DataLayout::getDevicePropertyValue	(	TargetSystemSpecInterface::DeviceID	deviceID,
		StringAttr	propertyName
	)		const

Returns the value of the specified property if the property is defined for the given device ID, otherwise returns std::nullopt.

Definition at line 663 of file DataLayoutInterfaces.cpp.

References mlir::detail::getDevicePropertyValue().

◆ getEndianness()

mlir::Attribute mlir::DataLayout::getEndianness ( ) const

Returns the specified endianness.

Definition at line 583 of file DataLayoutInterfaces.cpp.

References mlir::detail::getDefaultEndianness().

Referenced by isBigEndian().

◆ getGlobalMemorySpace()

mlir::Attribute mlir::DataLayout::getGlobalMemorySpace ( ) const

Returns the memory space used for global operations.

Definition at line 631 of file DataLayoutInterfaces.cpp.

References mlir::detail::getDefaultGlobalMemorySpace().

◆ getProgramMemorySpace()

mlir::Attribute mlir::DataLayout::getProgramMemorySpace ( ) const

Returns the memory space used for program memory operations.

Definition at line 615 of file DataLayoutInterfaces.cpp.

References mlir::detail::getDefaultProgramMemorySpace().

◆ getStackAlignment()

uint64_t mlir::DataLayout::getStackAlignment ( ) const

Returns the natural alignment of the stack in bits.

Alignment promotion of stack variables should be limited to the natural stack alignment to prevent dynamic stack alignment. Returns zero if the stack alignment is unspecified.

Definition at line 647 of file DataLayoutInterfaces.cpp.

References mlir::detail::getDefaultStackAlignment().

Referenced by tryToEnforceAllocaAlignment().