MLIR  18.0.0git
Public Member Functions | List of all members
mlir::SPIRVTypeConverter Class Reference

Type conversion from builtin types to SPIR-V types for shader interface. More...

#include "mlir/Dialect/SPIRV/Transforms/SPIRVConversion.h"

+ Inheritance diagram for mlir::SPIRVTypeConverter:

Public Member Functions

 SPIRVTypeConverter (spirv::TargetEnvAttr targetAttr, const SPIRVConversionOptions &options={})
 
Type getIndexType () const
 Gets the SPIR-V correspondence for the standard index type. More...
 
unsigned getIndexTypeBitwidth () const
 Gets the bitwidth of the index type when converted to SPIR-V. More...
 
const spirv::TargetEnvgetTargetEnv () const
 
const SPIRVConversionOptionsgetOptions () const
 Returns the options controlling the SPIR-V type converter. More...
 
bool allows (spirv::Capability capability) const
 Checks if the SPIR-V capability inquired is supported. More...
 
- Public Member Functions inherited from mlir::TypeConverter
virtual ~TypeConverter ()=default
 
 TypeConverter ()=default
 
 TypeConverter (const TypeConverter &other)
 
TypeConverteroperator= (const TypeConverter &other)
 
template<typename FnT , typename T = typename llvm::function_traits< std::decay_t<FnT>>::template arg_t<0>>
void addConversion (FnT &&callback)
 Register a conversion function. More...
 
template<typename FnT , typename T = typename llvm::function_traits< std::decay_t<FnT>>::template arg_t<1>>
void addArgumentMaterialization (FnT &&callback)
 Register a materialization function, which must be convertible to the following form: std::optional<Value>(OpBuilder &, T, ValueRange, Location), where T is any subclass of Type. More...
 
template<typename FnT , typename T = typename llvm::function_traits< std::decay_t<FnT>>::template arg_t<1>>
void addSourceMaterialization (FnT &&callback)
 This method registers a materialization that will be called when converting a legal type to an illegal source type. More...
 
template<typename FnT , typename T = typename llvm::function_traits< std::decay_t<FnT>>::template arg_t<1>>
void addTargetMaterialization (FnT &&callback)
 This method registers a materialization that will be called when converting type from an illegal, or source, type to a legal type. More...
 
template<typename FnT , typename T = typename llvm::function_traits<std::decay_t<FnT>>::template arg_t<0>, typename A = typename llvm::function_traits<std::decay_t<FnT>>::template arg_t<1>>
void addTypeAttributeConversion (FnT &&callback)
 Register a conversion function for attributes within types. More...
 
LogicalResult convertType (Type t, SmallVectorImpl< Type > &results) const
 Convert the given type. More...
 
Type convertType (Type t) const
 This hook simplifies defining 1-1 type conversions. More...
 
template<typename TargetType >
TargetType convertType (Type t) const
 Attempts a 1-1 type conversion, expecting the result type to be TargetType. More...
 
LogicalResult convertTypes (TypeRange types, SmallVectorImpl< Type > &results) const
 Convert the given set of types, filling 'results' as necessary. More...
 
bool isLegal (Type type) const
 Return true if the given type is legal for this type converter, i.e. More...
 
template<typename RangeT >
std::enable_if_t<!std::is_convertible< RangeT, Type >::value &&!std::is_convertible< RangeT, Operation * >::value, bool > isLegal (RangeT &&range) const
 Return true if all of the given types are legal for this type converter. More...
 
bool isLegal (Operation *op) const
 Return true if the given operation has legal operand and result types. More...
 
bool isLegal (Region *region) const
 Return true if the types of block arguments within the region are legal. More...
 
bool isSignatureLegal (FunctionType ty) const
 Return true if the inputs and outputs of the given function type are legal. More...
 
LogicalResult convertSignatureArg (unsigned inputNo, Type type, SignatureConversion &result) const
 This method allows for converting a specific argument of a signature. More...
 
LogicalResult convertSignatureArgs (TypeRange types, SignatureConversion &result, unsigned origInputOffset=0) const
 
std::optional< SignatureConversionconvertBlockSignature (Block *block) const
 This function converts the type signature of the given block, by invoking 'convertSignatureArg' for each argument. More...
 
Value materializeArgumentConversion (OpBuilder &builder, Location loc, Type resultType, ValueRange inputs) const
 Materialize a conversion from a set of types into one result type by generating a cast sequence of some kind. More...
 
Value materializeSourceConversion (OpBuilder &builder, Location loc, Type resultType, ValueRange inputs) const
 
Value materializeTargetConversion (OpBuilder &builder, Location loc, Type resultType, ValueRange inputs) const
 
std::optional< AttributeconvertTypeAttribute (Type type, Attribute attr) const
 Convert an attribute present attr from within the type type using the registered conversion functions. More...
 

Detailed Description

Type conversion from builtin types to SPIR-V types for shader interface.

For memref types, this converter additionally performs type wrapping to satisfy shader interface requirements: shader interface types must be pointers to structs.

Definition at line 72 of file SPIRVConversion.h.

Constructor & Destructor Documentation

◆ SPIRVTypeConverter()

SPIRVTypeConverter::SPIRVTypeConverter ( spirv::TargetEnvAttr  targetAttr,
const SPIRVConversionOptions options = {} 
)
explicit

Member Function Documentation

◆ allows()

bool SPIRVTypeConverter::allows ( spirv::Capability  capability) const

Checks if the SPIR-V capability inquired is supported.

Definition at line 135 of file SPIRVConversion.cpp.

References mlir::spirv::TargetEnv::allows().

Referenced by mlir::spirv::getElementPtr().

◆ getIndexType()

Type SPIRVTypeConverter::getIndexType ( ) const

Gets the SPIR-V correspondence for the standard index type.

Definition at line 127 of file SPIRVConversion.cpp.

References getIndexType().

Referenced by mlir::spirv::getOpenCLElementPtr(), mlir::spirv::getVulkanElementPtr(), and SPIRVTypeConverter().

◆ getIndexTypeBitwidth()

unsigned mlir::SPIRVTypeConverter::getIndexTypeBitwidth ( ) const
inline

Gets the bitwidth of the index type when converted to SPIR-V.

Definition at line 81 of file SPIRVConversion.h.

References mlir::SPIRVConversionOptions::use64bitIndex.

◆ getOptions()

const SPIRVConversionOptions& mlir::SPIRVTypeConverter::getOptions ( ) const
inline

Returns the options controlling the SPIR-V type converter.

Definition at line 88 of file SPIRVConversion.h.

◆ getTargetEnv()

const spirv::TargetEnv& mlir::SPIRVTypeConverter::getTargetEnv ( ) const
inline

Definition at line 85 of file SPIRVConversion.h.


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