LLVM 23.0.0git
SPIRVCommandLine.cpp
Go to the documentation of this file.
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/TargetParser/Triple.h"
18
19#include <functional>
20#include <iterator>
21#include <map>
22#include <set>
23#include <string>
24#include <utility>
25#include <vector>
26
27#define DEBUG_TYPE "spirv-commandline"
28
29using namespace llvm;
30
31static const std::map<StringRef, SPIRV::Extension::Extension>
32 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",
56 SPIRV::Extension::Extension::SPV_EXT_mesh_shader},
57 {"SPV_EXT_shader_stencil_export",
58 SPIRV::Extension::Extension::SPV_EXT_shader_stencil_export},
59 {"SPV_EXT_shader_viewport_index_layer",
60 SPIRV::Extension::Extension::SPV_EXT_shader_viewport_index_layer},
61 {"SPV_GOOGLE_hlsl_functionality1",
62 SPIRV::Extension::Extension::SPV_GOOGLE_hlsl_functionality1},
63 {"SPV_GOOGLE_user_type",
64 SPIRV::Extension::Extension::SPV_GOOGLE_user_type},
65 {"SPV_ALTERA_arbitrary_precision_integers",
66 SPIRV::Extension::Extension::SPV_ALTERA_arbitrary_precision_integers},
67 {"SPV_ALTERA_arbitrary_precision_floating_point",
68 SPIRV::Extension::Extension::
69 SPV_ALTERA_arbitrary_precision_floating_point},
70 {"SPV_INTEL_cache_controls",
71 SPIRV::Extension::Extension::SPV_INTEL_cache_controls},
72 {"SPV_INTEL_float_controls2",
73 SPIRV::Extension::Extension::SPV_INTEL_float_controls2},
74 {"SPV_INTEL_global_variable_fpga_decorations",
75 SPIRV::Extension::Extension::
76 SPV_INTEL_global_variable_fpga_decorations},
77 {"SPV_INTEL_global_variable_host_access",
78 SPIRV::Extension::Extension::SPV_INTEL_global_variable_host_access},
79 {"SPV_INTEL_optnone", SPIRV::Extension::Extension::SPV_INTEL_optnone},
80 {"SPV_EXT_optnone", SPIRV::Extension::Extension::SPV_EXT_optnone},
81 {"SPV_INTEL_usm_storage_classes",
82 SPIRV::Extension::Extension::SPV_INTEL_usm_storage_classes},
83 {"SPV_INTEL_split_barrier",
84 SPIRV::Extension::Extension::SPV_INTEL_split_barrier},
85 {"SPV_INTEL_subgroups",
86 SPIRV::Extension::Extension::SPV_INTEL_subgroups},
87 {"SPV_INTEL_media_block_io",
88 SPIRV::Extension::Extension::SPV_INTEL_media_block_io},
89 {"SPV_INTEL_memory_access_aliasing",
90 SPIRV::Extension::Extension::SPV_INTEL_memory_access_aliasing},
91 {"SPV_INTEL_joint_matrix",
92 SPIRV::Extension::Extension::SPV_INTEL_joint_matrix},
93 {"SPV_KHR_16bit_storage",
94 SPIRV::Extension::Extension::SPV_KHR_16bit_storage},
95 {"SPV_KHR_device_group",
96 SPIRV::Extension::Extension::SPV_KHR_device_group},
97 {"SPV_KHR_fragment_shading_rate",
98 SPIRV::Extension::Extension::SPV_KHR_fragment_shading_rate},
99 {"SPV_KHR_multiview", SPIRV::Extension::Extension::SPV_KHR_multiview},
100 {"SPV_KHR_post_depth_coverage",
101 SPIRV::Extension::Extension::SPV_KHR_post_depth_coverage},
102 {"SPV_KHR_shader_draw_parameters",
103 SPIRV::Extension::Extension::SPV_KHR_shader_draw_parameters},
104 {"SPV_KHR_ray_tracing",
105 SPIRV::Extension::Extension::SPV_KHR_ray_tracing},
106 {"SPV_KHR_uniform_group_instructions",
107 SPIRV::Extension::Extension::SPV_KHR_uniform_group_instructions},
108 {"SPV_KHR_no_integer_wrap_decoration",
109 SPIRV::Extension::Extension::SPV_KHR_no_integer_wrap_decoration},
110 {"SPV_KHR_float_controls",
111 SPIRV::Extension::Extension::SPV_KHR_float_controls},
112 {"SPV_KHR_expect_assume",
113 SPIRV::Extension::Extension::SPV_KHR_expect_assume},
114 {"SPV_KHR_bit_instructions",
115 SPIRV::Extension::Extension::SPV_KHR_bit_instructions},
116 {"SPV_KHR_integer_dot_product",
117 SPIRV::Extension::Extension::SPV_KHR_integer_dot_product},
118 {"SPV_KHR_linkonce_odr",
119 SPIRV::Extension::Extension::SPV_KHR_linkonce_odr},
120 {"SPV_KHR_fma", SPIRV::Extension::Extension::SPV_KHR_fma},
121 {"SPV_INTEL_inline_assembly",
122 SPIRV::Extension::Extension::SPV_INTEL_inline_assembly},
123 {"SPV_INTEL_bindless_images",
124 SPIRV::Extension::Extension::SPV_INTEL_bindless_images},
125 {"SPV_INTEL_bfloat16_arithmetic",
126 SPIRV::Extension::Extension::SPV_INTEL_bfloat16_arithmetic},
127 {"SPV_INTEL_bfloat16_conversion",
128 SPIRV::Extension::Extension::SPV_INTEL_bfloat16_conversion},
129 {"SPV_KHR_subgroup_rotate",
130 SPIRV::Extension::Extension::SPV_KHR_subgroup_rotate},
131 {"SPV_INTEL_variable_length_array",
132 SPIRV::Extension::Extension::SPV_INTEL_variable_length_array},
133 {"SPV_INTEL_function_pointers",
134 SPIRV::Extension::Extension::SPV_INTEL_function_pointers},
135 {"SPV_KHR_shader_clock",
136 SPIRV::Extension::Extension::SPV_KHR_shader_clock},
137 {"SPV_KHR_cooperative_matrix",
138 SPIRV::Extension::Extension::SPV_KHR_cooperative_matrix},
139 {"SPV_KHR_non_semantic_info",
140 SPIRV::Extension::Extension::SPV_KHR_non_semantic_info},
141 {"SPV_KHR_ray_query", SPIRV::Extension::Extension::SPV_KHR_ray_query},
142 {"SPV_EXT_shader_image_int64",
143 SPIRV::Extension::Extension::SPV_EXT_shader_image_int64},
144 {"SPV_KHR_fragment_shader_barycentric",
145 SPIRV::Extension::Extension::SPV_KHR_fragment_shader_barycentric},
146 {"SPV_KHR_physical_storage_buffer",
147 SPIRV::Extension::Extension::SPV_KHR_physical_storage_buffer},
148 {"SPV_KHR_vulkan_memory_model",
149 SPIRV::Extension::Extension::SPV_KHR_vulkan_memory_model},
150 {"SPV_NV_shader_subgroup_partitioned",
151 SPIRV::Extension::Extension::SPV_NV_shader_subgroup_partitioned},
152 {"SPV_INTEL_long_composites",
153 SPIRV::Extension::Extension::SPV_INTEL_long_composites},
154 {"SPV_INTEL_fp_max_error",
155 SPIRV::Extension::Extension::SPV_INTEL_fp_max_error},
156 {"SPV_INTEL_subgroup_matrix_multiply_accumulate",
157 SPIRV::Extension::Extension::
158 SPV_INTEL_subgroup_matrix_multiply_accumulate},
159 {"SPV_INTEL_ternary_bitwise_function",
160 SPIRV::Extension::Extension::SPV_INTEL_ternary_bitwise_function},
161 {"SPV_INTEL_2d_block_io",
162 SPIRV::Extension::Extension::SPV_INTEL_2d_block_io},
163 {"SPV_INTEL_int4", SPIRV::Extension::Extension::SPV_INTEL_int4},
164 {"SPV_KHR_float_controls2",
165 SPIRV::Extension::Extension::SPV_KHR_float_controls2},
166 {"SPV_INTEL_tensor_float32_conversion",
167 SPIRV::Extension::Extension::SPV_INTEL_tensor_float32_conversion},
168 {"SPV_KHR_bfloat16", SPIRV::Extension::Extension::SPV_KHR_bfloat16},
169 {"SPV_EXT_relaxed_printf_string_address_space",
170 SPIRV::Extension::Extension::
171 SPV_EXT_relaxed_printf_string_address_space},
172 {"SPV_INTEL_predicated_io",
173 SPIRV::Extension::Extension::SPV_INTEL_predicated_io},
174 {"SPV_KHR_maximal_reconvergence",
175 SPIRV::Extension::Extension::SPV_KHR_maximal_reconvergence},
176 {"SPV_INTEL_kernel_attributes",
177 SPIRV::Extension::Extension::SPV_INTEL_kernel_attributes},
178 {"SPV_ALTERA_blocking_pipes",
179 SPIRV::Extension::Extension::SPV_ALTERA_blocking_pipes},
180 {"SPV_INTEL_int4", SPIRV::Extension::Extension::SPV_INTEL_int4},
181 {"SPV_ALTERA_arbitrary_precision_fixed_point",
182 SPIRV::Extension::Extension::
183 SPV_ALTERA_arbitrary_precision_fixed_point},
184 {"SPV_EXT_image_raw10_raw12",
185 SPIRV::Extension::Extension::SPV_EXT_image_raw10_raw12}};
186
187bool SPIRVExtensionsParser::parse(cl::Option &O, StringRef ArgName,
188 StringRef ArgValue,
189 std::set<SPIRV::Extension::Extension> &Vals) {
190 SmallVector<StringRef, 10> Tokens;
191 ArgValue.split(Tokens, ",", -1, false);
192
193 std::set<SPIRV::Extension::Extension> EnabledExtensions;
194
195 auto M = partition(Tokens, [](auto &&T) { return T.starts_with('+'); });
196
197 if (std::any_of(M, Tokens.end(), equal_to("all")))
198 copy(make_second_range(SPIRVExtensionMap), std::inserter(Vals, Vals.end()));
199
200 for (auto &&Token : make_range(Tokens.begin(), M)) {
201 StringRef ExtensionName = Token.substr(1);
202 auto NameValuePair = SPIRVExtensionMap.find(ExtensionName);
203
204 if (NameValuePair == SPIRVExtensionMap.end())
205 return O.error("Unknown SPIR-V extension: " + Token.str());
206
207 EnabledExtensions.insert(NameValuePair->second);
208 }
209
210 for (auto &&Token : make_range(M, Tokens.end())) {
211 if (Token == "all")
212 continue;
213
214 if (Token.size() == 3 && Token.upper() == "KHR") {
215 for (const auto &[ExtensionName, ExtensionEnum] : SPIRVExtensionMap)
216 if (StringRef(ExtensionName).starts_with("SPV_KHR_"))
217 Vals.insert(ExtensionEnum);
218 continue;
219 }
220
221 if (Token.empty() || (!Token.starts_with("+") && !Token.starts_with("-")))
222 return O.error("Invalid extension list format: " + Token);
223
224 auto NameValuePair = SPIRVExtensionMap.find(Token.substr(1));
225
226 if (NameValuePair == SPIRVExtensionMap.cend())
227 return O.error("Unknown SPIR-V extension: " + Token.str());
228 if (EnabledExtensions.count(NameValuePair->second))
229 return O.error(
230 "Extension cannot be allowed and disallowed at the same time: " +
231 NameValuePair->first);
232
233 Vals.erase(NameValuePair->second);
234 }
235
236 Vals.insert(EnabledExtensions.cbegin(), EnabledExtensions.cend());
237
238 return false;
239}
240
241StringRef SPIRVExtensionsParser::checkExtensions(
242 const std::vector<std::string> &ExtNames,
243 std::set<SPIRV::Extension::Extension> &AllowedExtensions) {
244 for (const auto &Ext : ExtNames) {
245 if (Ext == "all") {
246 for (const auto &[ExtensionName, ExtensionEnum] : SPIRVExtensionMap)
247 AllowedExtensions.insert(ExtensionEnum);
248 break;
249 }
250 auto It = SPIRVExtensionMap.find(Ext);
251 if (It == SPIRVExtensionMap.end())
252 return Ext;
253 AllowedExtensions.insert(It->second);
254 }
255 return StringRef();
256}
257
258std::set<SPIRV::Extension::Extension>
259SPIRVExtensionsParser::getValidExtensions(const Triple &TT) {
260 std::set<SPIRV::Extension::Extension> R;
261 SPIRV::Environment::Environment CurrentEnvironment =
262 SPIRV::Environment::Environment::EnvOpenCL;
263 if (TT.getOS() == Triple::Vulkan)
264 CurrentEnvironment = SPIRV::Environment::Environment::EnvVulkan;
265
266 for (const auto &[ExtensionName, ExtensionEnum] : SPIRVExtensionMap) {
267 EnvironmentList AllowedEnv = getSymbolicOperandAllowedEnvironments(
268 SPIRV::OperandCategory::OperandCategory::ExtensionOperand,
269 ExtensionEnum);
270
271 if (llvm::is_contained(AllowedEnv, CurrentEnvironment))
272 R.insert(ExtensionEnum);
273 }
274
275 if (TT.getVendor() == Triple::AMD) {
276 // AMD uses the translator to recover LLVM-IR from SPIRV. Currently, the
277 // translator doesn't implement the SPV_KHR_float_controls2 extension.
278 R.erase(SPIRV::Extension::SPV_KHR_float_controls2);
279 }
280
281 return R;
282}
T
#define T
Definition Mips16ISelLowering.cpp:282
SPIRVExtensionMap
static const std::map< StringRef, SPIRV::Extension::Extension > SPIRVExtensionMap
Definition SPIRVCommandLine.cpp:32
STLExtras.h
This file contains some templates that are useful if you are working with the STL at all.
starts_with
DEMANGLE_NAMESPACE_BEGIN bool starts_with(std::string_view self, char C) noexcept
Definition StringViewExtras.h:24
llvm::SmallVector
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition SmallVector.h:1205
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
llvm::StringRef::split
std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition StringRef.h:712
llvm::StringRef::substr
constexpr StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition StringRef.h:573
llvm::Triple
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:47
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition Types.h:26
llvm::EnvironmentList
SmallVector< SPIRV::Environment::Environment, 8 > EnvironmentList
Definition SPIRVBaseInfo.h:257
llvm::make_range
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
Definition iterator_range.h:70
llvm::equal_to
constexpr auto equal_to(T &&Arg)
Functor variant of std::equal_to that can be used as a UnaryPredicate in functional algorithms like a...
Definition STLExtras.h:2163
llvm::getSymbolicOperandAllowedEnvironments
EnvironmentList getSymbolicOperandAllowedEnvironments(SPIRV::OperandCategory::OperandCategory Category, uint32_t Value)
Definition SPIRVBaseInfo.cpp:145
llvm::copy
OutputIt copy(R &&Range, OutputIt Out)
Definition STLExtras.h:1883
llvm::partition
auto partition(R &&Range, UnaryPredicate P)
Provide wrappers to std::partition which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:2023
llvm::make_second_range
auto make_second_range(ContainerTy &&c)
Given a container of pairs, return a range over the second elements.
Definition STLExtras.h:1407
llvm::is_contained
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Definition STLExtras.h:1945
llvm::SPIRVExtensionsParser::getValidExtensions
static std::set< SPIRV::Extension::Extension > getValidExtensions(const Triple &TT)
Returns the list of extensions that are valid for a particular target environment (i....
Definition SPIRVCommandLine.cpp:259
llvm::SPIRVExtensionsParser::parse
bool parse(cl::Option &O, StringRef ArgName, StringRef ArgValue, std::set< SPIRV::Extension::Extension > &Vals)
Parses SPIR-V extension name from CLI arguments.
Definition SPIRVCommandLine.cpp:187
llvm::SPIRVExtensionsParser::checkExtensions
static StringRef checkExtensions(const std::vector< std::string > &ExtNames, std::set< SPIRV::Extension::Extension > &AllowedExtensions)
Validates and converts extension names into internal enum values.
Definition SPIRVCommandLine.cpp:241
Generated on for LLVM by doxygen 1.14.0