spirv/profile.h

Go to the documentation of this file.

// Copyright 2026 The IREE Authors
//
// Licensed under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
#ifndef LOOMC_TARGET_SPIRV_PROFILE_H_
#define LOOMC_TARGET_SPIRV_PROFILE_H_
 
#include "loomc/result.h"
#include "loomc/target/spirv/base.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum loomc_spirv_feature_e {
  LOOMC_SPIRV_FEATURE_UNKNOWN = 0,

  LOOMC_SPIRV_FEATURE_VULKAN_SHADER = 1,

  LOOMC_SPIRV_FEATURE_PHYSICAL_STORAGE_BUFFER = 2,

  LOOMC_SPIRV_FEATURE_FLOAT16 = 3,

  LOOMC_SPIRV_FEATURE_FLOAT64 = 4,

  LOOMC_SPIRV_FEATURE_INT8 = 5,

  LOOMC_SPIRV_FEATURE_INT16 = 6,

  LOOMC_SPIRV_FEATURE_STORAGE_BUFFER_8BIT_ACCESS = 7,

  LOOMC_SPIRV_FEATURE_STORAGE_BUFFER_16BIT_ACCESS = 8,

  LOOMC_SPIRV_FEATURE_COOPERATIVE_VECTOR_NV = 9,

  LOOMC_SPIRV_FEATURE_COOPERATIVE_VECTOR_TRAINING_NV = 10,

  LOOMC_SPIRV_FEATURE_COOPERATIVE_MATRIX_KHR = 11,

  LOOMC_SPIRV_FEATURE_BFLOAT16_TYPE_KHR = 12,

  LOOMC_SPIRV_FEATURE_BFLOAT16_DOT_PRODUCT_KHR = 13,

  LOOMC_SPIRV_FEATURE_BFLOAT16_COOPERATIVE_MATRIX_KHR = 14,

  LOOMC_SPIRV_FEATURE_INT64 = 15,

  LOOMC_SPIRV_FEATURE_COUNT = 16,
} loomc_spirv_feature_t;

typedef uint64_t loomc_spirv_feature_bits_t;

#define LOOMC_SPIRV_VERSION(major, minor) \
  ((((uint32_t)(major)) << 16) | (((uint32_t)(minor)) << 8))

#define LOOMC_SPIRV_VERSION_1_0 LOOMC_SPIRV_VERSION(1, 0)

#define LOOMC_SPIRV_VERSION_1_1 LOOMC_SPIRV_VERSION(1, 1)

#define LOOMC_SPIRV_VERSION_1_2 LOOMC_SPIRV_VERSION(1, 2)

#define LOOMC_SPIRV_VERSION_1_3 LOOMC_SPIRV_VERSION(1, 3)

#define LOOMC_SPIRV_VERSION_1_4 LOOMC_SPIRV_VERSION(1, 4)

#define LOOMC_SPIRV_VERSION_1_5 LOOMC_SPIRV_VERSION(1, 5)

#define LOOMC_SPIRV_VERSION_1_6 LOOMC_SPIRV_VERSION(1, 6)

static inline uint32_t loomc_spirv_max_version_from_vulkan_api_version(
    uint32_t vulkan_major, uint32_t vulkan_minor) {
  if (vulkan_major > 1 || (vulkan_major == 1 && vulkan_minor >= 3)) {
    return LOOMC_SPIRV_VERSION_1_6;
  }
  if (vulkan_major == 1 && vulkan_minor >= 2) {
    return LOOMC_SPIRV_VERSION_1_5;
  }
  if (vulkan_major == 1 && vulkan_minor >= 1) {
    return LOOMC_SPIRV_VERSION_1_3;
  }
  return LOOMC_SPIRV_VERSION_1_0;
}

static inline loomc_spirv_feature_bits_t loomc_spirv_feature_bit(
    loomc_spirv_feature_t feature) {
  return feature > LOOMC_SPIRV_FEATURE_UNKNOWN &&
                 feature < LOOMC_SPIRV_FEATURE_COUNT
             ? (UINT64_C(1) << feature)
             : 0u;
}

typedef enum loomc_spirv_limit_e {
  LOOMC_SPIRV_LIMIT_UNKNOWN = 0,

  LOOMC_SPIRV_LIMIT_MAX_WORKGROUP_SIZE_X = 1,

  LOOMC_SPIRV_LIMIT_MAX_WORKGROUP_SIZE_Y = 2,

  LOOMC_SPIRV_LIMIT_MAX_WORKGROUP_SIZE_Z = 3,

  LOOMC_SPIRV_LIMIT_MAX_FLAT_WORKGROUP_SIZE = 4,

  LOOMC_SPIRV_LIMIT_MAX_WORKGROUP_STORAGE_BYTES = 5,

  LOOMC_SPIRV_LIMIT_SUBGROUP_SIZE = 6,

  LOOMC_SPIRV_LIMIT_MAX_WORKGROUP_COUNT_X = 7,

  LOOMC_SPIRV_LIMIT_MAX_WORKGROUP_COUNT_Y = 8,

  LOOMC_SPIRV_LIMIT_MAX_WORKGROUP_COUNT_Z = 9,

  LOOMC_SPIRV_LIMIT_MAX_GRID_SIZE_X = 10,

  LOOMC_SPIRV_LIMIT_MAX_GRID_SIZE_Y = 11,

  LOOMC_SPIRV_LIMIT_MAX_GRID_SIZE_Z = 12,

  LOOMC_SPIRV_LIMIT_MAX_FLAT_GRID_SIZE = 13,

  LOOMC_SPIRV_LIMIT_COUNT = 14,
} loomc_spirv_limit_t;

typedef enum loomc_spirv_environment_e {
  LOOMC_SPIRV_ENVIRONMENT_UNKNOWN = 0,

  LOOMC_SPIRV_ENVIRONMENT_MAX_SPIRV_VERSION = 1,

  LOOMC_SPIRV_ENVIRONMENT_COUNT = 2,
} loomc_spirv_environment_t;

typedef enum loomc_spirv_scalar_type_e {
  LOOMC_SPIRV_SCALAR_TYPE_UNKNOWN = 0,

  LOOMC_SPIRV_SCALAR_TYPE_F16 = 1,

  LOOMC_SPIRV_SCALAR_TYPE_F32 = 2,

  LOOMC_SPIRV_SCALAR_TYPE_F64 = 3,

  LOOMC_SPIRV_SCALAR_TYPE_BF16 = 4,

  LOOMC_SPIRV_SCALAR_TYPE_S8 = 5,

  LOOMC_SPIRV_SCALAR_TYPE_S16 = 6,

  LOOMC_SPIRV_SCALAR_TYPE_S32 = 7,

  LOOMC_SPIRV_SCALAR_TYPE_S64 = 8,

  LOOMC_SPIRV_SCALAR_TYPE_U8 = 9,

  LOOMC_SPIRV_SCALAR_TYPE_U16 = 10,

  LOOMC_SPIRV_SCALAR_TYPE_U32 = 11,

  LOOMC_SPIRV_SCALAR_TYPE_U64 = 12,
} loomc_spirv_scalar_type_t;

typedef enum loomc_spirv_scope_e {
  LOOMC_SPIRV_SCOPE_CROSS_DEVICE = 0,

  LOOMC_SPIRV_SCOPE_DEVICE = 1,

  LOOMC_SPIRV_SCOPE_WORKGROUP = 2,

  LOOMC_SPIRV_SCOPE_SUBGROUP = 3,

  LOOMC_SPIRV_SCOPE_INVOCATION = 4,

  LOOMC_SPIRV_SCOPE_QUEUE_FAMILY = 5,

  LOOMC_SPIRV_SCOPE_SHADER_CALL_KHR = 6,
} loomc_spirv_scope_t;

typedef enum loomc_spirv_cooperative_matrix_layout_flag_bits_e {
  LOOMC_SPIRV_COOPERATIVE_MATRIX_LAYOUT_ROW_MAJOR_BIT = 1u << 0,

  LOOMC_SPIRV_COOPERATIVE_MATRIX_LAYOUT_COLUMN_MAJOR_BIT = 1u << 1,
} loomc_spirv_cooperative_matrix_layout_flag_bits_t;

typedef uint32_t loomc_spirv_cooperative_matrix_layout_flags_t;

typedef enum loomc_spirv_cooperative_matrix_operand_flag_bits_e {
  LOOMC_SPIRV_COOPERATIVE_MATRIX_OPERAND_A_SIGNED_COMPONENTS = 1u << 0,

  LOOMC_SPIRV_COOPERATIVE_MATRIX_OPERAND_B_SIGNED_COMPONENTS = 1u << 1,

  LOOMC_SPIRV_COOPERATIVE_MATRIX_OPERAND_C_SIGNED_COMPONENTS = 1u << 2,

  LOOMC_SPIRV_COOPERATIVE_MATRIX_OPERAND_RESULT_SIGNED_COMPONENTS = 1u << 3,

  LOOMC_SPIRV_COOPERATIVE_MATRIX_OPERAND_SATURATING_ACCUMULATION = 1u << 4,
} loomc_spirv_cooperative_matrix_operand_flag_bits_t;

typedef uint32_t loomc_spirv_cooperative_matrix_operand_flags_t;

typedef enum loomc_spirv_component_type_e {
  LOOMC_SPIRV_COMPONENT_TYPE_FLOAT16_NV = 0,

  LOOMC_SPIRV_COMPONENT_TYPE_FLOAT32_NV = 1,

  LOOMC_SPIRV_COMPONENT_TYPE_FLOAT64_NV = 2,

  LOOMC_SPIRV_COMPONENT_TYPE_SIGNED_INT8_NV = 3,

  LOOMC_SPIRV_COMPONENT_TYPE_SIGNED_INT16_NV = 4,

  LOOMC_SPIRV_COMPONENT_TYPE_SIGNED_INT32_NV = 5,

  LOOMC_SPIRV_COMPONENT_TYPE_SIGNED_INT64_NV = 6,

  LOOMC_SPIRV_COMPONENT_TYPE_UNSIGNED_INT8_NV = 7,

  LOOMC_SPIRV_COMPONENT_TYPE_UNSIGNED_INT16_NV = 8,

  LOOMC_SPIRV_COMPONENT_TYPE_UNSIGNED_INT32_NV = 9,

  LOOMC_SPIRV_COMPONENT_TYPE_UNSIGNED_INT64_NV = 10,

  LOOMC_SPIRV_COMPONENT_TYPE_SIGNED_INT8_PACKED_NV = 1000491000,

  LOOMC_SPIRV_COMPONENT_TYPE_UNSIGNED_INT8_PACKED_NV = 1000491001,

  LOOMC_SPIRV_COMPONENT_TYPE_FLOAT_E4_M3_NV = 1000491002,

  LOOMC_SPIRV_COMPONENT_TYPE_FLOAT_E5_M2_NV = 1000491003,
} loomc_spirv_component_type_t;

typedef enum loomc_spirv_cooperative_vector_matrix_layout_flag_bits_e {
  LOOMC_SPIRV_COOPERATIVE_VECTOR_MATRIX_LAYOUT_ROW_MAJOR_BIT = 1u << 0,

  LOOMC_SPIRV_COOPERATIVE_VECTOR_MATRIX_LAYOUT_COLUMN_MAJOR_BIT = 1u << 1,

  LOOMC_SPIRV_COOPERATIVE_VECTOR_MATRIX_LAYOUT_INFERENCING_OPTIMAL_BIT =
      (1u << 2),

  LOOMC_SPIRV_COOPERATIVE_VECTOR_MATRIX_LAYOUT_TRAINING_OPTIMAL_BIT = 1u << 3,
} loomc_spirv_cooperative_vector_matrix_layout_flag_bits_t;

typedef uint32_t loomc_spirv_cooperative_vector_matrix_layout_flags_t;

typedef enum loomc_spirv_cooperative_vector_flag_bits_e {
  LOOMC_SPIRV_COOPERATIVE_VECTOR_FLAG_TRANSPOSE = 1u << 0,

  LOOMC_SPIRV_COOPERATIVE_VECTOR_FLAG_TRAINING = 1u << 1,
} loomc_spirv_cooperative_vector_flag_bits_t;

typedef uint32_t loomc_spirv_cooperative_vector_flags_t;

typedef enum loomc_spirv_storage_class_flag_bits_e {
  LOOMC_SPIRV_STORAGE_CLASS_BIT_WORKGROUP = 1u << 0,

  LOOMC_SPIRV_STORAGE_CLASS_BIT_STORAGE_BUFFER = 1u << 1,

  LOOMC_SPIRV_STORAGE_CLASS_BIT_PHYSICAL_STORAGE_BUFFER = 1u << 2,
} loomc_spirv_storage_class_flag_bits_t;

typedef uint32_t loomc_spirv_storage_class_flags_t;

typedef enum loomc_spirv_profile_preset_e {
  LOOMC_SPIRV_PROFILE_PRESET_NONE = 0,

  LOOMC_SPIRV_PROFILE_PRESET_VULKAN_1_3_BDA = 1,
} loomc_spirv_profile_preset_t;

typedef struct loomc_spirv_feature_fact_t {
  loomc_spirv_feature_t feature;

  loomc_target_fact_state_t state;

  loomc_string_view_t provenance;
} loomc_spirv_feature_fact_t;

typedef struct loomc_spirv_limit_fact_t {
  loomc_spirv_limit_t limit;

  loomc_target_fact_state_t state;

  uint64_t value;

  loomc_string_view_t provenance;
} loomc_spirv_limit_fact_t;

typedef struct loomc_spirv_limit_value_t {
  loomc_target_fact_state_t state;

  uint64_t value;
} loomc_spirv_limit_value_t;

typedef struct loomc_spirv_environment_fact_t {
  loomc_spirv_environment_t environment;

  loomc_target_fact_state_t state;

  uint64_t value;

  loomc_string_view_t provenance;
} loomc_spirv_environment_fact_t;

typedef struct loomc_spirv_environment_value_t {
  loomc_target_fact_state_t state;

  uint64_t value;
} loomc_spirv_environment_value_t;

typedef struct loomc_spirv_cooperative_matrix_row_t
    loomc_spirv_cooperative_matrix_row_t;

typedef struct loomc_spirv_cooperative_vector_row_t
    loomc_spirv_cooperative_vector_row_t;

typedef struct loomc_spirv_profile_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_string_view_t identifier;

  loomc_spirv_profile_preset_t preset;

  const loomc_spirv_feature_fact_t* feature_facts;

  loomc_host_size_t feature_fact_count;

  const loomc_spirv_limit_fact_t* limit_facts;

  loomc_host_size_t limit_fact_count;

  const loomc_spirv_environment_fact_t* environment_facts;

  loomc_host_size_t environment_fact_count;

  const loomc_spirv_cooperative_matrix_row_t* cooperative_matrix_rows;

  loomc_host_size_t cooperative_matrix_row_count;

  const loomc_spirv_cooperative_vector_row_t* cooperative_vector_rows;

  loomc_host_size_t cooperative_vector_row_count;
} loomc_spirv_profile_options_t;

typedef struct loomc_spirv_profile_info_t {
  uint32_t minimum_spirv_version;

  uint32_t addressing_model;

  uint32_t memory_model;

  loomc_host_size_t extension_count;

  loomc_host_size_t capability_count;

  loomc_host_size_t opcode_count;

  loomc_host_size_t storage_class_count;

  loomc_host_size_t decoration_count;

  loomc_host_size_t cooperative_matrix_row_count;

  loomc_host_size_t cooperative_vector_row_count;
} loomc_spirv_profile_info_t;

typedef struct loomc_spirv_cooperative_matrix_row_t {
  loomc_string_view_t name;

  loomc_target_fact_state_t state;

  loomc_string_view_t provenance;

  loomc_spirv_feature_bits_t required_features;

  uint16_t m_size;

  uint16_t n_size;

  uint16_t k_size;

  loomc_spirv_scalar_type_t lhs_type;

  loomc_spirv_scalar_type_t rhs_type;

  loomc_spirv_scalar_type_t accumulator_type;

  loomc_spirv_scalar_type_t result_type;

  loomc_spirv_scope_t scope;

  loomc_spirv_cooperative_matrix_layout_flags_t layout_flags;

  loomc_spirv_storage_class_flags_t storage_class_flags;

  loomc_spirv_cooperative_matrix_operand_flags_t operand_flags;
} loomc_spirv_cooperative_matrix_row_t;

typedef struct loomc_spirv_cooperative_vector_row_t {
  loomc_string_view_t name;

  loomc_target_fact_state_t state;

  loomc_string_view_t provenance;

  loomc_spirv_feature_bits_t required_features;

  uint16_t m_size;

  uint16_t k_size;

  loomc_spirv_component_type_t input_type;

  loomc_spirv_component_type_t input_interpretation;

  loomc_spirv_component_type_t matrix_interpretation;

  loomc_spirv_component_type_t bias_interpretation;

  loomc_spirv_component_type_t result_type;

  loomc_spirv_cooperative_vector_matrix_layout_flags_t matrix_layout_flags;

  loomc_spirv_storage_class_flags_t storage_class_flags;

  loomc_spirv_cooperative_vector_flags_t flags;
} loomc_spirv_cooperative_vector_row_t;

LOOMC_API_EXPORT loomc_status_t loomc_target_profile_create_spirv(
    loomc_target_environment_t* target_environment,
    const loomc_spirv_profile_options_t* options, loomc_allocator_t allocator,
    loomc_target_profile_t** out_profile, loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_spirv_target_profile_refine(
    const loomc_target_profile_t* base_profile,
    const loomc_spirv_profile_options_t* options, loomc_allocator_t allocator,
    loomc_target_profile_t** out_profile, loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_spirv_target_profile_query_feature(
    const loomc_target_profile_t* profile, loomc_spirv_feature_t feature,
    loomc_target_fact_state_t* out_state);

LOOMC_API_EXPORT loomc_status_t loomc_spirv_target_profile_query_limit(
    const loomc_target_profile_t* profile, loomc_spirv_limit_t limit,
    loomc_spirv_limit_value_t* out_value);

LOOMC_API_EXPORT loomc_status_t loomc_spirv_target_profile_query_environment(
    const loomc_target_profile_t* profile,
    loomc_spirv_environment_t environment,
    loomc_spirv_environment_value_t* out_value);

LOOMC_API_EXPORT loomc_status_t
loomc_spirv_target_profile_query_info(const loomc_target_profile_t* profile,
                                      loomc_spirv_profile_info_t* out_info);

LOOMC_API_EXPORT loomc_status_t loomc_spirv_target_profile_extension_at(
    const loomc_target_profile_t* profile, loomc_host_size_t index,
    loomc_string_view_t* out_extension);

LOOMC_API_EXPORT loomc_status_t loomc_spirv_target_profile_capability_at(
    const loomc_target_profile_t* profile, loomc_host_size_t index,
    uint32_t* out_capability);

LOOMC_API_EXPORT loomc_status_t loomc_spirv_target_profile_opcode_at(
    const loomc_target_profile_t* profile, loomc_host_size_t index,
    uint32_t* out_opcode);

LOOMC_API_EXPORT loomc_status_t loomc_spirv_target_profile_storage_class_at(
    const loomc_target_profile_t* profile, loomc_host_size_t index,
    uint32_t* out_storage_class);

LOOMC_API_EXPORT loomc_status_t loomc_spirv_target_profile_decoration_at(
    const loomc_target_profile_t* profile, loomc_host_size_t index,
    uint32_t* out_decoration);

LOOMC_API_EXPORT loomc_status_t
loomc_spirv_target_profile_cooperative_matrix_row_at(
    const loomc_target_profile_t* profile, loomc_host_size_t index,
    loomc_spirv_cooperative_matrix_row_t* out_row);

LOOMC_API_EXPORT loomc_status_t
loomc_spirv_target_profile_cooperative_vector_row_at(
    const loomc_target_profile_t* profile, loomc_host_size_t index,
    loomc_spirv_cooperative_vector_row_t* out_row);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_TARGET_SPIRV_PROFILE_H_