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