1//===--- SPIRVCommandLine.cpp ---- Command Line Options ---------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file contains definitions of classes and functions needed for
10// processing, parsing, and using CLI options for the SPIR-V backend.
11//
12//===----------------------------------------------------------------------===//
13
14#include "SPIRVCommandLine.h"
15#include "MCTargetDesc/SPIRVBaseInfo.h"
16#include "llvm/ADT/STLExtras.h"
17#include "llvm/ADT/StringMap.h"
18#include "llvm/TargetParser/Triple.h"
19
20#include <functional>
21#include <iterator>
22#include <string>
23#include <utility>
24#include <vector>
25
26#define DEBUG_TYPE "spirv-commandline"
27
28using namespace llvm;
29
30ExtensionSet SPIRVExtensionsParser::DisabledExtensions;
31
32static const StringMap<SPIRV::Extension::Extension> SPIRVExtensionMap = {
33 {"SPV_EXT_shader_atomic_float_add",
34 SPIRV::Extension::Extension::SPV_EXT_shader_atomic_float_add},
35 {"SPV_EXT_shader_atomic_float16_add",
36 SPIRV::Extension::Extension::SPV_EXT_shader_atomic_float16_add},
37 {"SPV_EXT_shader_atomic_float_min_max",
38 SPIRV::Extension::Extension::SPV_EXT_shader_atomic_float_min_max},
39 {"SPV_INTEL_16bit_atomics",
40 SPIRV::Extension::Extension::SPV_INTEL_16bit_atomics},
41 {"SPV_NV_shader_atomic_fp16_vector",
42 SPIRV::Extension::Extension::SPV_NV_shader_atomic_fp16_vector},
43 {"SPV_EXT_arithmetic_fence",
44 SPIRV::Extension::Extension::SPV_EXT_arithmetic_fence},
45 {"SPV_EXT_demote_to_helper_invocation",
46 SPIRV::Extension::Extension::SPV_EXT_demote_to_helper_invocation},
47 {"SPV_EXT_descriptor_indexing",
48 SPIRV::Extension::Extension::SPV_EXT_descriptor_indexing},
49 {"SPV_EXT_fragment_fully_covered",
50 SPIRV::Extension::Extension::SPV_EXT_fragment_fully_covered},
51 {"SPV_EXT_fragment_invocation_density",
52 SPIRV::Extension::Extension::SPV_EXT_fragment_invocation_density},
53 {"SPV_EXT_fragment_shader_interlock",
54 SPIRV::Extension::Extension::SPV_EXT_fragment_shader_interlock},
55 {"SPV_EXT_mesh_shader", SPIRV::Extension::Extension::SPV_EXT_mesh_shader},
56 {"SPV_EXT_shader_stencil_export",
57 SPIRV::Extension::Extension::SPV_EXT_shader_stencil_export},
58 {"SPV_EXT_shader_viewport_index_layer",
59 SPIRV::Extension::Extension::SPV_EXT_shader_viewport_index_layer},
60 {"SPV_GOOGLE_hlsl_functionality1",
61 SPIRV::Extension::Extension::SPV_GOOGLE_hlsl_functionality1},
62 {"SPV_GOOGLE_user_type", SPIRV::Extension::Extension::SPV_GOOGLE_user_type},
63 {"SPV_ALTERA_arbitrary_precision_integers",
64 SPIRV::Extension::Extension::SPV_ALTERA_arbitrary_precision_integers},
65 {"SPV_ALTERA_arbitrary_precision_floating_point",
66 SPIRV::Extension::Extension::
67 SPV_ALTERA_arbitrary_precision_floating_point},
68 {"SPV_INTEL_cache_controls",
69 SPIRV::Extension::Extension::SPV_INTEL_cache_controls},
70 {"SPV_INTEL_float_controls2",
71 SPIRV::Extension::Extension::SPV_INTEL_float_controls2},
72 {"SPV_INTEL_global_variable_fpga_decorations",
73 SPIRV::Extension::Extension::SPV_INTEL_global_variable_fpga_decorations},
74 {"SPV_INTEL_global_variable_host_access",
75 SPIRV::Extension::Extension::SPV_INTEL_global_variable_host_access},
76 {"SPV_INTEL_optnone", SPIRV::Extension::Extension::SPV_INTEL_optnone},
77 {"SPV_EXT_optnone", SPIRV::Extension::Extension::SPV_EXT_optnone},
78 {"SPV_INTEL_usm_storage_classes",
79 SPIRV::Extension::Extension::SPV_INTEL_usm_storage_classes},
80 {"SPV_INTEL_split_barrier",
81 SPIRV::Extension::Extension::SPV_INTEL_split_barrier},
82 {"SPV_INTEL_subgroups", SPIRV::Extension::Extension::SPV_INTEL_subgroups},
83 {"SPV_INTEL_media_block_io",
84 SPIRV::Extension::Extension::SPV_INTEL_media_block_io},
85 {"SPV_INTEL_memory_access_aliasing",
86 SPIRV::Extension::Extension::SPV_INTEL_memory_access_aliasing},
87 {"SPV_INTEL_joint_matrix",
88 SPIRV::Extension::Extension::SPV_INTEL_joint_matrix},
89 {"SPV_INTEL_masked_gather_scatter",
90 SPIRV::Extension::Extension::SPV_INTEL_masked_gather_scatter},
91 {"SPV_KHR_16bit_storage",
92 SPIRV::Extension::Extension::SPV_KHR_16bit_storage},
93 {"SPV_KHR_device_group", SPIRV::Extension::Extension::SPV_KHR_device_group},
94 {"SPV_KHR_fragment_shading_rate",
95 SPIRV::Extension::Extension::SPV_KHR_fragment_shading_rate},
96 {"SPV_KHR_multiview", SPIRV::Extension::Extension::SPV_KHR_multiview},
97 {"SPV_KHR_post_depth_coverage",
98 SPIRV::Extension::Extension::SPV_KHR_post_depth_coverage},
99 {"SPV_KHR_shader_draw_parameters",
100 SPIRV::Extension::Extension::SPV_KHR_shader_draw_parameters},
101 {"SPV_KHR_ray_tracing", SPIRV::Extension::Extension::SPV_KHR_ray_tracing},
102 {"SPV_KHR_uniform_group_instructions",
103 SPIRV::Extension::Extension::SPV_KHR_uniform_group_instructions},
104 {"SPV_KHR_no_integer_wrap_decoration",
105 SPIRV::Extension::Extension::SPV_KHR_no_integer_wrap_decoration},
106 {"SPV_KHR_float_controls",
107 SPIRV::Extension::Extension::SPV_KHR_float_controls},
108 {"SPV_KHR_expect_assume",
109 SPIRV::Extension::Extension::SPV_KHR_expect_assume},
110 {"SPV_KHR_bit_instructions",
111 SPIRV::Extension::Extension::SPV_KHR_bit_instructions},
112 {"SPV_KHR_integer_dot_product",
113 SPIRV::Extension::Extension::SPV_KHR_integer_dot_product},
114 {"SPV_KHR_linkonce_odr", SPIRV::Extension::Extension::SPV_KHR_linkonce_odr},
115 {"SPV_KHR_fma", SPIRV::Extension::Extension::SPV_KHR_fma},
116 {"SPV_INTEL_inline_assembly",
117 SPIRV::Extension::Extension::SPV_INTEL_inline_assembly},
118 {"SPV_INTEL_bindless_images",
119 SPIRV::Extension::Extension::SPV_INTEL_bindless_images},
120 {"SPV_INTEL_bfloat16_arithmetic",
121 SPIRV::Extension::Extension::SPV_INTEL_bfloat16_arithmetic},
122 {"SPV_INTEL_bfloat16_conversion",
123 SPIRV::Extension::Extension::SPV_INTEL_bfloat16_conversion},
124 {"SPV_KHR_subgroup_rotate",
125 SPIRV::Extension::Extension::SPV_KHR_subgroup_rotate},
126 {"SPV_INTEL_variable_length_array",
127 SPIRV::Extension::Extension::SPV_INTEL_variable_length_array},
128 {"SPV_INTEL_function_pointers",
129 SPIRV::Extension::Extension::SPV_INTEL_function_pointers},
130 {"SPV_KHR_shader_clock", SPIRV::Extension::Extension::SPV_KHR_shader_clock},
131 {"SPV_KHR_cooperative_matrix",
132 SPIRV::Extension::Extension::SPV_KHR_cooperative_matrix},
133 {"SPV_KHR_non_semantic_info",
134 SPIRV::Extension::Extension::SPV_KHR_non_semantic_info},
135 {"SPV_KHR_ray_query", SPIRV::Extension::Extension::SPV_KHR_ray_query},
136 {"SPV_EXT_shader_image_int64",
137 SPIRV::Extension::Extension::SPV_EXT_shader_image_int64},
138 {"SPV_KHR_fragment_shader_barycentric",
139 SPIRV::Extension::Extension::SPV_KHR_fragment_shader_barycentric},
140 {"SPV_KHR_physical_storage_buffer",
141 SPIRV::Extension::Extension::SPV_KHR_physical_storage_buffer},
142 {"SPV_KHR_vulkan_memory_model",
143 SPIRV::Extension::Extension::SPV_KHR_vulkan_memory_model},
144 {"SPV_NV_shader_subgroup_partitioned",
145 SPIRV::Extension::Extension::SPV_NV_shader_subgroup_partitioned},
146 {"SPV_INTEL_long_composites",
147 SPIRV::Extension::Extension::SPV_INTEL_long_composites},
148 {"SPV_INTEL_fp_max_error",
149 SPIRV::Extension::Extension::SPV_INTEL_fp_max_error},
150 {"SPV_INTEL_subgroup_matrix_multiply_accumulate",
151 SPIRV::Extension::Extension::
152 SPV_INTEL_subgroup_matrix_multiply_accumulate},
153 {"SPV_INTEL_ternary_bitwise_function",
154 SPIRV::Extension::Extension::SPV_INTEL_ternary_bitwise_function},
155 {"SPV_INTEL_2d_block_io",
156 SPIRV::Extension::Extension::SPV_INTEL_2d_block_io},
157 {"SPV_INTEL_int4", SPIRV::Extension::Extension::SPV_INTEL_int4},
158 {"SPV_KHR_float_controls2",
159 SPIRV::Extension::Extension::SPV_KHR_float_controls2},
160 {"SPV_INTEL_tensor_float32_conversion",
161 SPIRV::Extension::Extension::SPV_INTEL_tensor_float32_conversion},
162 {"SPV_KHR_bfloat16", SPIRV::Extension::Extension::SPV_KHR_bfloat16},
163 {"SPV_EXT_relaxed_printf_string_address_space",
164 SPIRV::Extension::Extension::SPV_EXT_relaxed_printf_string_address_space},
165 {"SPV_INTEL_predicated_io",
166 SPIRV::Extension::Extension::SPV_INTEL_predicated_io},
167 {"SPV_KHR_maximal_reconvergence",
168 SPIRV::Extension::Extension::SPV_KHR_maximal_reconvergence},
169 {"SPV_INTEL_kernel_attributes",
170 SPIRV::Extension::Extension::SPV_INTEL_kernel_attributes},
171 {"SPV_ALTERA_blocking_pipes",
172 SPIRV::Extension::Extension::SPV_ALTERA_blocking_pipes},
173 {"SPV_ALTERA_arbitrary_precision_fixed_point",
174 SPIRV::Extension::Extension::SPV_ALTERA_arbitrary_precision_fixed_point},
175 {"SPV_EXT_image_raw10_raw12",
176 SPIRV::Extension::Extension::SPV_EXT_image_raw10_raw12},
177 {"SPV_INTEL_unstructured_loop_controls",
178 SPIRV::Extension::Extension::SPV_INTEL_unstructured_loop_controls},
179 {"SPV_AMD_weak_linkage", SPIRV::Extension::Extension::SPV_AMD_weak_linkage},
180 {"SPV_KHR_abort", SPIRV::Extension::Extension::SPV_KHR_abort},
181 {"SPV_KHR_poison_freeze",
182 SPIRV::Extension::Extension::SPV_KHR_poison_freeze}};
183
184bool SPIRVExtensionsParser::parse(cl::Option &O, StringRef ArgName,
185 StringRef ArgValue, ExtensionSet &Vals) {
186 SmallVector<StringRef, 10> Tokens;
187 ArgValue.split(A&: Tokens, Separator: ",", MaxSplit: -1, KeepEmpty: false);
188
189 ExtensionSet EnabledExtensions;
190
191 auto M = partition(Range&: Tokens, P: [](auto &&T) { return T.starts_with('+'); });
192
193 if (std::any_of(first: M, last: Tokens.end(), pred: equal_to(Arg: "all")))
194 for (auto &&El : make_second_range(c: SPIRVExtensionMap))
195 Vals.insert(V: El);
196
197 for (auto &&Token : make_range(x: Tokens.begin(), y: M)) {
198 StringRef ExtensionName = Token.substr(Start: 1);
199 auto NameValuePair = SPIRVExtensionMap.find(Key: ExtensionName);
200
201 if (NameValuePair == SPIRVExtensionMap.end())
202 return O.error(Message: "Unknown SPIR-V extension: " + Token);
203
204 EnabledExtensions.insert(V: NameValuePair->second);
205 }
206
207 for (auto &&Token : make_range(x: M, y: Tokens.end())) {
208 if (Token == "all")
209 continue;
210
211 if (Token.size() == 3 && Token.upper() == "KHR") {
212 for (const auto &[ExtensionName, ExtensionEnum] : SPIRVExtensionMap)
213 if (StringRef(ExtensionName).starts_with(Prefix: "SPV_KHR_"))
214 Vals.insert(V: ExtensionEnum);
215 continue;
216 }
217
218 if (Token.empty() || (!Token.starts_with(Prefix: "+") && !Token.starts_with(Prefix: "-")))
219 return O.error(Message: "Invalid extension list format: " + Token);
220
221 auto NameValuePair = SPIRVExtensionMap.find(Key: Token.substr(Start: 1));
222
223 if (NameValuePair == SPIRVExtensionMap.end())
224 return O.error(Message: "Unknown SPIR-V extension: " + Token);
225 if (EnabledExtensions.count(V: NameValuePair->second))
226 return O.error(
227 Message: "Extension cannot be allowed and disallowed at the same time: " +
228 NameValuePair->first());
229 DisabledExtensions.insert(V: NameValuePair->second);
230 Vals.erase(V: NameValuePair->second);
231 }
232
233 Vals.insert(I: EnabledExtensions.begin(), E: EnabledExtensions.end());
234
235 return false;
236}
237
238StringRef
239SPIRVExtensionsParser::checkExtensions(ArrayRef<std::string> ExtNames,
240 ExtensionSet &AllowedExtensions) {
241 for (const auto &Ext : ExtNames) {
242 if (Ext == "all") {
243 for (const auto &[ExtensionName, ExtensionEnum] : SPIRVExtensionMap)
244 AllowedExtensions.insert(V: ExtensionEnum);
245 break;
246 }
247 auto It = SPIRVExtensionMap.find(Key: Ext);
248 if (It == SPIRVExtensionMap.end())
249 return Ext;
250 AllowedExtensions.insert(V: It->second);
251 }
252 return StringRef();
253}
254
255ExtensionSet SPIRVExtensionsParser::getValidExtensions(const Triple &TT) {
256 ExtensionSet R;
257 SPIRV::Environment::Environment CurrentEnvironment =
258 SPIRV::Environment::Environment::EnvOpenCL;
259 if (TT.getOS() == Triple::Vulkan)
260 CurrentEnvironment = SPIRV::Environment::Environment::EnvVulkan;
261
262 for (const auto &[ExtensionName, ExtensionEnum] : SPIRVExtensionMap) {
263 EnvironmentList AllowedEnv = getSymbolicOperandAllowedEnvironments(
264 Category: SPIRV::OperandCategory::OperandCategory::ExtensionOperand,
265 Value: ExtensionEnum);
266
267 if (llvm::is_contained(Range&: AllowedEnv, Element: CurrentEnvironment) &&
268 !llvm::is_contained(Range&: DisabledExtensions, Element: ExtensionEnum))
269 R.insert(V: ExtensionEnum);
270 }
271
272 return R;
273}
274