Skip to content

Commit aba5310

Browse files
aratajewigcbot
aratajew
authored and
igcbot
committed
Implement interface for SPIRV extensions and compilation options
This change implements tablegen file which is used to generate: - documentation for supported SPIRV extensions - YAML file with supported SPIRV extensions that is passed to Neo via new interface
1 parent 86a8111 commit aba5310

14 files changed

+533
-2
lines changed

‎IGC/AdaptorOCL/CMakeLists.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ list(APPEND IGC_BUILD__SRC__AdaptorOCL
4545
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/impl/gt_system_info_impl.cpp"
4646
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/impl/platform_impl.cpp"
4747
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/impl/igc_builtins_impl.cpp"
48+
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/impl/igc_options_and_capabilities_impl.cpp"
4849
${CIF_SOURCES_EXPORT_ABSOLUTE_PATH})
4950
list(APPEND IGC_BUILD__HDR__IGC_AdaptorOCL
5051
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/impl/igc_features_and_workarounds_impl.h"
@@ -55,6 +56,7 @@ list(APPEND IGC_BUILD__SRC__AdaptorOCL
5556
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/impl/gt_system_info_impl.h"
5657
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/impl/platform_impl.h"
5758
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/impl/igc_builtins_impl.h"
59+
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/impl/igc_options_and_capabilities_impl.h"
5860

5961
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/igc_features_and_workarounds.h"
6062
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/igc_ocl_device_ctx.h"
@@ -64,6 +66,7 @@ list(APPEND IGC_BUILD__SRC__AdaptorOCL
6466
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/gt_system_info.h"
6567
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/platform.h"
6668
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/igc_builtins.h"
69+
"${CMAKE_CURRENT_SOURCE_DIR}/ocl_igc_interface/igc_options_and_capabilities.h"
6770
${CIF_HEADERS_ABSOLUTE_PATH})
6871

6972
set(IGC_BUILD__SRC__IGC_AdaptorOCL ${IGC_BUILD__SRC__IGC_AdaptorOCL} PARENT_SCOPE) # set directly
@@ -124,6 +127,9 @@ add_library("${IGC_BUILD__PROJ__AdaptorOCL}" STATIC
124127
set_target_properties("${IGC_BUILD__PROJ__AdaptorOCL}" PROPERTIES FOLDER "Libraries/Adaptors")
125128

126129
add_dependencies("${IGC_BUILD__PROJ__AdaptorOCL}" "${IGC_BUILD__PROJ__GenISAIntrinsics}")
130+
if(USE_SPIRV_EXTENSIONS_YAML_GENERATOR)
131+
add_dependencies(${IGC_BUILD__PROJ__AdaptorOCL} IGCCSPIRVExtensionsYaml)
132+
endif()
127133
set_property(TARGET "${IGC_BUILD__PROJ__AdaptorOCL}" PROPERTY PROJECT_LABEL "${IGC_BUILD__PROJ_LABEL__AdaptorOCL}")
128134

129135
if(IGC_BUILD__VC_ENABLED)

‎IGC/AdaptorOCL/Utils/YamlAndDocsTblgen/CMakeLists.txt‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#=========================== begin_copyright_notice ============================
2+
#
3+
# Copyright (C) 2025 Intel Corporation
4+
#
5+
# SPDX-License-Identifier: MIT
6+
#
7+
#============================ end_copyright_notice =============================
8+
9+
include(TableGen)
10+
11+
add_tablegen(igcc-yaml-docs-tblgen IGCC_YAML_DOCS_TBLGEN
12+
IGCCOptionsAndCapabilitiesEmitter.cpp
13+
)
14+
15+
set(LLVM_LINK_COMPONENTS
16+
Support
17+
TableGen
18+
)
19+
20+
llvm_update_compile_flags(igcc-yaml-docs-tblgen)
21+
22+
# Always link static TableGen explicitly — never rely on libLLVM.so here
23+
# TableGen is never part of libLLVM.so (ref: llvm-project/llvm/tools/llvm-shlib/CMakeLists.txt)
24+
target_link_libraries(igcc-yaml-docs-tblgen PRIVATE
25+
LLVMSupport
26+
LLVMTableGen
27+
)

‎IGC/AdaptorOCL/Utils/YamlAndDocsTblgen/IGCCOptionsAndCapabilitiesEmitter.cpp‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
/*========================== begin_copyright_notice ============================
2+
3+
Copyright (C) 2025 Intel Corporation
4+
5+
SPDX-License-Identifier: MIT
6+
7+
============================= end_copyright_notice ===========================*/
8+
//===----------------------------------------------------------------------===//
9+
//
10+
/// \file
11+
/// This tablegen backend emits headers for YAML interfaces related to
12+
/// igc-compute options and capabilities, like supported SPIR-V extensions.
13+
///
14+
/// It is also capable of emitting documentation for the supported SPIR-V
15+
/// extensions and compilation options
16+
//===----------------------------------------------------------------------===//
17+
#include "llvm/ADT/StringExtras.h"
18+
#include "llvm/ADT/StringRef.h"
19+
#include "llvm/Support/CommandLine.h"
20+
#include "llvm/Support/Debug.h"
21+
#include "llvm/Support/InitLLVM.h"
22+
#include "llvm/Support/YAMLTraits.h"
23+
#include "llvm/Support/raw_ostream.h"
24+
#include "llvm/TableGen/Error.h"
25+
#include "llvm/TableGen/Main.h"
26+
#include "llvm/TableGen/Record.h"
27+
#include "llvm/TableGen/TableGenBackend.h"
28+
29+
using namespace llvm;
30+
using namespace std;
31+
32+
#define DEBUG_TYPE "IGCCOptionsAndCapabilitiesEmitter"
33+
34+
namespace {
35+
struct SPIRVExtensionInfo {
36+
StringRef ExtName;
37+
StringRef ExtSpecURL;
38+
std::vector<StringRef> ExtCapabilities;
39+
};
40+
41+
struct SPIRVExtensionsList {
42+
std::vector<SPIRVExtensionInfo> Extensions;
43+
};
44+
} // namespace
45+
46+
LLVM_YAML_IS_SEQUENCE_VECTOR(SPIRVExtensionInfo)
47+
namespace llvm {
48+
namespace yaml {
49+
50+
template <> struct MappingTraits<SPIRVExtensionInfo> {
51+
static void mapping(IO &IO, SPIRVExtensionInfo &info) {
52+
IO.mapRequired("name", info.ExtName);
53+
IO.mapRequired("spec_url", info.ExtSpecURL);
54+
IO.mapRequired("supported_capabilities", info.ExtCapabilities);
55+
}
56+
};
57+
58+
template <> struct MappingTraits<SPIRVExtensionsList> {
59+
static void mapping(IO &IO, SPIRVExtensionsList &ExtList) { IO.mapRequired("spirv_extensions", ExtList.Extensions); }
60+
};
61+
} // namespace yaml
62+
} // namespace llvm
63+
64+
namespace {
65+
66+
class IGCCOptionsAndCapabilitiesEmitter {
67+
const RecordKeeper &Records;
68+
69+
public:
70+
IGCCOptionsAndCapabilitiesEmitter(const RecordKeeper &R) : Records(R) {}
71+
void emitSPIRVYaml(raw_ostream &OS);
72+
void emitSPIRVDocs(raw_ostream &OS);
73+
void emitOptionsDocs(raw_ostream &OS);
74+
75+
private:
76+
void getSPIRVExtensionList(SPIRVExtensionsList &ExtList);
77+
};
78+
79+
} // end anonymous namespace
80+
81+
void IGCCOptionsAndCapabilitiesEmitter::getSPIRVExtensionList(SPIRVExtensionsList &ExtList) {
82+
auto AllExtensions = Records.getAllDerivedDefinitions("SPIRVExtension");
83+
for (const Record *Ext : AllExtensions) {
84+
StringRef ExtName = Ext->getValueAsString("ExtName");
85+
StringRef ExtSpecURL = Ext->getValueAsString("ExtSpecURL");
86+
auto Capabilities = Ext->getValueAsListOfStrings("ExtCapabilities");
87+
ExtList.Extensions.push_back({ExtName, ExtSpecURL, Capabilities});
88+
}
89+
}
90+
91+
void IGCCOptionsAndCapabilitiesEmitter::emitSPIRVYaml(raw_ostream &OS) {
92+
OS << "#ifndef IGCC_LIB_INTERFACE_SPIRV_EXTENSIONS_H\n";
93+
OS << "#define IGCC_LIB_INTERFACE_SPIRV_EXTENSIONS_H\n";
94+
OS << "static const char SPIRVExtensionsYAML[] = R\"(\n";
95+
yaml::Output Yout(OS);
96+
SPIRVExtensionsList ExtList;
97+
getSPIRVExtensionList(ExtList);
98+
Yout << ExtList;
99+
OS << ")\";\n";
100+
OS << "#endif\n";
101+
}
102+
103+
void IGCCOptionsAndCapabilitiesEmitter::emitSPIRVDocs(raw_ostream &OS) {
104+
SPIRVExtensionsList ExtList;
105+
getSPIRVExtensionList(ExtList);
106+
OS << "# Supported SPIR-V Extensions\n";
107+
for (const auto &Ext : ExtList.Extensions) {
108+
OS << "### " << Ext.ExtName << "\n";
109+
OS << " - Spec URL: " << Ext.ExtSpecURL << "\n";
110+
OS << " - Supported Capabilities:\n";
111+
for (const auto &Cap : Ext.ExtCapabilities) {
112+
OS << " - " << Cap << "\n";
113+
}
114+
}
115+
}
116+
117+
void IGCCOptionsAndCapabilitiesEmitter::emitOptionsDocs(raw_ostream &OS) {
118+
// To be implemented
119+
}
120+
121+
static void emitSPIRVYaml(const RecordKeeper &Records, raw_ostream &OS) {
122+
IGCCOptionsAndCapabilitiesEmitter(Records).emitSPIRVYaml(OS);
123+
}
124+
125+
static void emitSPIRVDocs(const RecordKeeper &Records, raw_ostream &OS) {
126+
IGCCOptionsAndCapabilitiesEmitter(Records).emitSPIRVDocs(OS);
127+
}
128+
129+
static void emitOptionsDocs(const RecordKeeper &Records, raw_ostream &OS) {
130+
IGCCOptionsAndCapabilitiesEmitter(Records).emitOptionsDocs(OS);
131+
}
132+
133+
namespace {
134+
enum ActionType { EmitSPIRVYaml, EmitSPIRVDocs, EmitOptionsDocs };
135+
136+
cl::opt<ActionType> Action(cl::desc("Action to perform:"),
137+
cl::values(clEnumValN(EmitSPIRVYaml, "gen-igcc-spirv-extensions-yaml",
138+
"Generate IGCCompute supported SPIR-V extensions YAML"),
139+
clEnumValN(EmitSPIRVDocs, "gen-igcc-spirv-extensions-docs",
140+
"Generate IGCCompute supported SPIR-V extensions documentation"),
141+
clEnumValN(EmitOptionsDocs, "gen-igcc-options-docs",
142+
"Generate IGCCompute supported options documentation")));
143+
} // namespace
144+
145+
static bool OptionsAndDocsTblgenMain(raw_ostream &OS, RecordKeeper &Records) {
146+
switch (Action) {
147+
case EmitSPIRVYaml:
148+
emitSPIRVYaml(Records, OS);
149+
break;
150+
case EmitSPIRVDocs:
151+
emitSPIRVDocs(Records, OS);
152+
break;
153+
case EmitOptionsDocs:
154+
emitOptionsDocs(Records, OS);
155+
break;
156+
}
157+
158+
return false;
159+
}
160+
161+
int main(int argc, char **argv) {
162+
InitLLVM y(argc, argv);
163+
cl::ParseCommandLineOptions(argc, argv);
164+
return TableGenMain(argv[0], &OptionsAndDocsTblgenMain);
165+
}

‎IGC/AdaptorOCL/docs/autogen/supported-spirv-extensions.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Supported SPIR-V Extensions
2+
### SPV_INTEL_2d_block_io
3+
- Spec URL: https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_2d_block_io.asciidoc
4+
- Supported Capabilities:
5+
- Subgroup2DBlockIOINTEL
6+
- Subgroup2DBlockTransformINTEL
7+
- Subgroup2DBlockTransposeINTEL
8+
### SPV_INTEL_bfloat16_conversion
9+
- Spec URL: https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_bfloat16_conversion.asciidoc
10+
- Supported Capabilities:
11+
- BFloat16ConversionINTEL
12+
### SPV_INTEL_cache_controls
13+
- Spec URL: https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_cache_controls.asciidoc
14+
- Supported Capabilities:
15+
- CacheControlsINTEL
16+
### SPV_INTEL_fp_fast_math_mode
17+
- Spec URL: https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_fp_fast_math_mode.asciidoc
18+
- Supported Capabilities:
19+
- FPFastMathModeINTEL
20+
### SPV_INTEL_subgroups
21+
- Spec URL: https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_subgroups.asciidoc
22+
- Supported Capabilities:
23+
- SubgroupShuffleINTEL
24+
- SubgroupBufferBlockIOINTEL
25+
- SubgroupImageBlockIOINTEL

‎IGC/AdaptorOCL/ocl_igc_interface/extensions/CMakeLists.txt‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#=========================== begin_copyright_notice ============================
2+
#
3+
# Copyright (C) 2025 Intel Corporation
4+
#
5+
# SPDX-License-Identifier: MIT
6+
#
7+
#============================ end_copyright_notice =============================
8+
9+
# Generate the docs for the supported SPIR-V extensions
10+
set(DOC_FILENAME "supported-spirv-extensions")
11+
set(OUT_DOC_FILE ${CMAKE_SOURCE_DIR}/IGC/AdaptorOCL/docs/autogen/${DOC_FILENAME}.md)
12+
13+
set(LLVM_TARGET_DEFINITIONS SPIRVExtensions.td)
14+
set(IGCC_LIB_INTERFACES_DOCS_TABLEGEN_EXE igcc-yaml-docs-tblgen)
15+
tablegen(IGCC_LIB_INTERFACES_DOCS ${DOC_FILENAME}.md -gen-igcc-spirv-extensions-docs)
16+
add_public_tablegen_target(IGCCSPIRVExtensionsDocs)
17+
18+
add_custom_command(
19+
OUTPUT ${OUT_DOC_FILE}
20+
COMMAND ${CMAKE_COMMAND} -E copy
21+
${CMAKE_CURRENT_BINARY_DIR}/${DOC_FILENAME}.md
22+
${OUT_DOC_FILE}
23+
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${DOC_FILENAME}.md)
24+
25+
add_custom_target(${DOC_FILENAME}DocGen DEPENDS ${OUT_DOC_FILE})
26+
add_dependencies(${DOC_FILENAME}DocGen IGCCSPIRVExtensionsDocs)
27+
28+
# Generate the header with YAML descriptions of the supported SPIR-V extensions
29+
set(IGCC_LIB_INTERFACES_TABLEGEN_EXE igcc-yaml-docs-tblgen)
30+
set(LLVM_TARGET_DEFINITIONS SPIRVExtensions.td)
31+
tablegen(IGCC_LIB_INTERFACES IGCCSPIRVExtensionsYaml.inc -gen-igcc-spirv-extensions-yaml)
32+
add_public_tablegen_target(IGCCSPIRVExtensionsYaml)
33+
add_dependencies(IGCCSPIRVExtensionsYaml IGCCSPIRVExtensionsDocs)
34+
add_dependencies(IGCCSPIRVExtensionsYaml ${DOC_FILENAME}DocGen)

‎IGC/AdaptorOCL/ocl_igc_interface/extensions/SPIRVExtensions.td‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/*========================== begin_copyright_notice ============================
2+
3+
Copyright (C) 2025 Intel Corporation
4+
5+
SPDX-License-Identifier: MIT
6+
7+
============================= end_copyright_notice ===========================*/
8+
//===- SPIRVExtensions.td - SPIR-V Extensions supported by igc-compute ----*- tablegen -*-===//
9+
//
10+
// This file declares a set of SPIR-V extensions supported by igc-compute.
11+
//
12+
//===-------------------------------------------------------------------------------------===//
13+
14+
// Note! After editing this file, please run the build locally, to generate the documentation.
15+
16+
// SPIRVExtension class accepts:
17+
// 1) The extension name
18+
// 2) A list of supported capabilities in this extension
19+
// 3) Specification URL
20+
class SPIRVExtension<
21+
string ExtensionName,
22+
list<string> Capabilities,
23+
string SpecURL
24+
> {
25+
string ExtName = ExtensionName;
26+
list<string> ExtCapabilities = Capabilities;
27+
string ExtSpecURL = SpecURL;
28+
}
29+
30+
// Note: the list is incomplete. TODO: extend the list with all supported extensions.
31+
32+
def SPV_INTEL_subgroups : SPIRVExtension<
33+
"SPV_INTEL_subgroups",
34+
[ "SubgroupShuffleINTEL",
35+
"SubgroupBufferBlockIOINTEL",
36+
"SubgroupImageBlockIOINTEL" ],
37+
"https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_subgroups.asciidoc"
38+
>;
39+
40+
def SPV_INTEL_bfloat16_conversion : SPIRVExtension<
41+
"SPV_INTEL_bfloat16_conversion",
42+
[ "BFloat16ConversionINTEL" ],
43+
"https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_bfloat16_conversion.asciidoc"
44+
>;
45+
46+
def SPV_INTEL_2d_block_io : SPIRVExtension<
47+
"SPV_INTEL_2d_block_io",
48+
[ "Subgroup2DBlockIOINTEL",
49+
"Subgroup2DBlockTransformINTEL",
50+
"Subgroup2DBlockTransposeINTEL" ],
51+
"https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_2d_block_io.asciidoc"
52+
>;
53+
54+
def SPV_INTEL_cache_controls : SPIRVExtension<
55+
"SPV_INTEL_cache_controls",
56+
[ "CacheControlsINTEL" ],
57+
"https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_cache_controls.asciidoc"
58+
>;
59+
60+
def SPV_INTEL_fp_fast_math_mode : SPIRVExtension<
61+
"SPV_INTEL_fp_fast_math_mode",
62+
[ "FPFastMathModeINTEL" ],
63+
"https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/INTEL/SPV_INTEL_fp_fast_math_mode.asciidoc"
64+
>;
65+

‎IGC/AdaptorOCL/ocl_igc_interface/igc_ocl_device_ctx.h‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ SPDX-License-Identifier: MIT
1818
#include "ocl_igc_interface/ocl_gen_binary.h"
1919
#include "ocl_igc_interface/platform.h"
2020
#include "ocl_igc_interface/igc_builtins.h"
21+
#include "ocl_igc_interface/igc_options_and_capabilities.h"
2122

2223
#include "cif/macros/enable.h"
2324
#include "OCLAPI/oclapi.h"
@@ -103,9 +104,23 @@ CIF_DEFINE_INTERFACE_VER_WITH_COMPATIBILITY(IgcOclDeviceCtx, 4, 3) {
103104
OCL_API_CALL virtual IgcBuiltinsBase *GetIgcBuiltinsHandleImpl(CIF::Version_t ver);
104105
};
105106

107+
CIF_DEFINE_INTERFACE_VER_WITH_COMPATIBILITY(IgcOclDeviceCtx, 5, 4) {
108+
CIF_INHERIT_CONSTRUCTOR();
109+
110+
template <typename IgcOptionsAndCapabilitiesInterface = IgcOptionsAndCapabilitiesLatest>
111+
CIF::RAII::UPtr_t<IgcOptionsAndCapabilitiesInterface> GetIgcOptionsAndCapabilitiesHandle() {
112+
return CIF::RAII::RetainAndPack<IgcOptionsAndCapabilitiesInterface>(
113+
GetIgcOptionsAndCapabilitiesHandleImpl(IgcOptionsAndCapabilitiesInterface::GetVersion()));
114+
}
115+
116+
protected:
117+
virtual IgcOptionsAndCapabilitiesBase *GetIgcOptionsAndCapabilitiesHandleImpl(CIF::Version_t ver);
118+
};
119+
106120
CIF_GENERATE_VERSIONS_LIST_AND_DECLARE_INTERFACE_DEPENDENCIES(IgcOclDeviceCtx, IGC::Platform, IGC::GTSystemInfo,
107121
IGC::OclGenBinary, IGC::IgcFeaturesAndWorkarounds,
108-
IGC::IgcOclTranslationCtx, IGC::IgcBuiltins);
122+
IGC::IgcOclTranslationCtx, IGC::IgcBuiltins,
123+
IGC::IgcOptionsAndCapabilities);
109124
CIF_MARK_LATEST_VERSION(IgcOclDeviceCtxLatest, IgcOclDeviceCtx);
110125
using IgcOclDeviceCtxTagOCL = IgcOclDeviceCtx<3>; // Note : can tag with different version for
111126
// transition periods

0 commit comments

Comments
 (0)