According to the Vulkan spec "15.6.4. Offset and Stride Assignment": "There are different alignment requirements depending on the specific resources and on the features enabled on the device. More...

#include "mlir/Dialect/SPIRV/Utils/LayoutUtils.h"

Public Types
using	Size = uint64_t

Static Public Member Functions
static spirv::StructType	decorateType (spirv::StructType structType)
	Returns a new StructType with layout decoration. More...

static bool	isLegalType (Type type)
	Checks whether a type is legal in terms of Vulkan layout info decoration. More...

Detailed Description

According to the Vulkan spec "15.6.4. Offset and Stride Assignment": "There are different alignment requirements depending on the specific resources and on the features enabled on the device.

"

There are 3 types of alignment: scalar, base, extended. See the spec for details.

Note: Even if scalar alignment is supported, it is generally more performant to use the base alignment. So here the calculation is based on base alignment.

The memory layout must obey the following rules:

The Offset decoration of any member must be a multiple of its alignment.
Any ArrayStride or MatrixStride decoration must be a multiple of the alignment of the array or matrix as defined above.

According to the SPIR-V spec: "The ArrayStride, MatrixStride, and Offset decorations must be large enough to hold the size of the objects they affect (that is, specifying overlap is invalid)."

Definition at line 49 of file LayoutUtils.h.

Member Typedef Documentation

◆ Size

using mlir::VulkanLayoutUtils::Size = uint64_t

Definition at line 51 of file LayoutUtils.h.

Member Function Documentation

◆ decorateType()

spirv::StructType VulkanLayoutUtils::decorateType ( spirv::StructType structType )

static

Returns a new StructType with layout decoration.

Definition at line 21 of file LayoutUtils.cpp.

Referenced by convertStructTypeWithOffset(), and createGlobalVarForEntryPointArgument().

◆ isLegalType()

bool VulkanLayoutUtils::isLegalType ( Type type )

static

Checks whether a type is legal in terms of Vulkan layout info decoration.

A type is dynamically illegal if it's a composite type in the StorageBuffer, PhysicalStorageBuffer, Uniform, and PushConstant Storage Classes without layout information.

Definition at line 163 of file LayoutUtils.cpp.

References mlir::spirv::StructType::getNumElements(), and mlir::spirv::StructType::hasOffset().

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

include/mlir/Dialect/SPIRV/Utils/LayoutUtils.h
lib/Dialect/SPIRV/Utils/LayoutUtils.cpp