MLIR  19.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
mlir::spirv::ArrayType Class Reference

#include "mlir/Dialect/SPIRV/IR/SPIRVTypes.h"

+ Inheritance diagram for mlir::spirv::ArrayType:

Public Types

using Base = StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits... >
 Utility declarations for the concrete attribute class. More...
 
- Public Types inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
using Base = StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits... >
 Utility declarations for the concrete attribute class. More...
 
using ImplType = StorageT
 
using HasTraitFn = bool(*)(TypeID)
 

Public Member Functions

unsigned getNumElements () const
 
Type getElementType () const
 
unsigned getArrayStride () const
 Returns the array stride in bytes. More...
 
void getExtensions (SPIRVType::ExtensionArrayRefVector &extensions, std::optional< StorageClass > storage=std::nullopt)
 
void getCapabilities (SPIRVType::CapabilityArrayRefVector &capabilities, std::optional< StorageClass > storage=std::nullopt)
 
std::optional< int64_t > getSizeInBytes ()
 Returns the array size in bytes. More...
 
- Public Member Functions inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
ImplTypegetImpl () const
 Utility for easy access to the storage instance. More...
 

Static Public Member Functions

static ArrayType get (Type elementType, unsigned elementCount)
 
static ArrayType get (Type elementType, unsigned elementCount, unsigned stride)
 Returns an array type with the given stride in bytes. More...
 
- Static Public Member Functions inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
static TypeID getTypeID ()
 Return a unique identifier for the concrete type. More...
 
template<typename T >
static bool classof (T val)
 Provide an implementation of 'classof' that compares the type id of the provided value with that of the concrete type. More...
 
static detail::InterfaceMap getInterfaceMap ()
 Returns an interface map for the interfaces registered to this storage user. More...
 
static HasTraitFn getHasTraitFn ()
 Returns the function that returns true if the given Trait ID matches the IDs of any of the traits defined by the storage user. More...
 
static auto getWalkImmediateSubElementsFn ()
 Returns a function that walks immediate sub elements of a given instance of the storage user. More...
 
static auto getReplaceImmediateSubElementsFn ()
 Returns a function that replaces immediate sub elements of a given instance of the storage user. More...
 
template<typename... IfaceModels>
static void attachInterface (MLIRContext &context)
 Attach the given models as implementations of the corresponding interfaces for the concrete storage user class. More...
 
template<typename... Args>
static ConcreteT get (MLIRContext *ctx, Args &&...args)
 Get or create a new ConcreteT instance within the ctx. More...
 
template<typename... Args>
static ConcreteT getChecked (const Location &loc, Args &&...args)
 Get or create a new ConcreteT instance within the ctx, defined at the given, potentially unknown, location. More...
 
template<typename... Args>
static ConcreteT getChecked (function_ref< InFlightDiagnostic()> emitErrorFn, MLIRContext *ctx, Args... args)
 Get or create a new ConcreteT instance within the ctx. More...
 
static ConcreteT getFromOpaquePointer (const void *ptr)
 Get an instance of the concrete type from a void pointer. More...
 

Static Public Attributes

static constexpr StringLiteral name = "spirv.array"
 

Additional Inherited Members

- Protected Member Functions inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
template<typename... Args>
LogicalResult mutate (Args &&...args)
 Mutate the current storage instance. More...
 
- Static Protected Member Functions inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
template<typename... Args>
static LogicalResult verify (Args... args)
 Default implementation that just returns success. More...
 

Detailed Description

Definition at line 129 of file SPIRVTypes.h.

Member Typedef Documentation

◆ Base

using mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >::Base = StorageUserBase<ConcreteT, BaseT, StorageT, UniquerT, Traits...>

Utility declarations for the concrete attribute class.

Definition at line 101 of file StorageUniquerSupport.h.

Member Function Documentation

◆ get() [1/2]

ArrayType ArrayType::get ( Type  elementType,
unsigned  elementCount 
)
static

◆ get() [2/2]

ArrayType ArrayType::get ( Type  elementType,
unsigned  elementCount,
unsigned  stride 
)
static

Returns an array type with the given stride in bytes.

Definition at line 58 of file SPIRVTypes.cpp.

References mlir::get(), and mlir::Type::getContext().

◆ getArrayStride()

unsigned ArrayType::getArrayStride ( ) const

Returns the array stride in bytes.

0 means no stride decorated on this type.

Definition at line 68 of file SPIRVTypes.cpp.

References mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >::getImpl().

Referenced by convertArrayType(), getSizeInBytes(), print(), and mlir::spirv::Serializer::processTypeDecoration< spirv::ArrayType >().

◆ getCapabilities()

void ArrayType::getCapabilities ( SPIRVType::CapabilityArrayRefVector capabilities,
std::optional< StorageClass >  storage = std::nullopt 
)

Definition at line 75 of file SPIRVTypes.cpp.

References getElementType().

◆ getElementType()

Type ArrayType::getElementType ( ) const

◆ getExtensions()

void ArrayType::getExtensions ( SPIRVType::ExtensionArrayRefVector extensions,
std::optional< StorageClass >  storage = std::nullopt 
)

Definition at line 70 of file SPIRVTypes.cpp.

References getElementType().

◆ getNumElements()

unsigned ArrayType::getNumElements ( ) const

◆ getSizeInBytes()

std::optional< int64_t > ArrayType::getSizeInBytes ( )

Returns the array size in bytes.

Since array type may have an explicit stride declaration (in bytes), we also include it in the calculation.

Definition at line 82 of file SPIRVTypes.cpp.

References getArrayStride(), getElementType(), and getNumElements().

Member Data Documentation

◆ name

constexpr StringLiteral mlir::spirv::ArrayType::name = "spirv.array"
staticconstexpr

Definition at line 134 of file SPIRVTypes.h.


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