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/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_KHR_16bit_storage",
90 SPIRV::Extension::Extension::SPV_KHR_16bit_storage},
91 {"SPV_KHR_device_group", SPIRV::Extension::Extension::SPV_KHR_device_group},
92 {"SPV_KHR_fragment_shading_rate",
93 SPIRV::Extension::Extension::SPV_KHR_fragment_shading_rate},
94 {"SPV_KHR_multiview", SPIRV::Extension::Extension::SPV_KHR_multiview},
95 {"SPV_KHR_post_depth_coverage",
96 SPIRV::Extension::Extension::SPV_KHR_post_depth_coverage},
97 {"SPV_KHR_shader_draw_parameters",
98 SPIRV::Extension::Extension::SPV_KHR_shader_draw_parameters},
99 {"SPV_KHR_ray_tracing", SPIRV::Extension::Extension::SPV_KHR_ray_tracing},
100 {"SPV_KHR_uniform_group_instructions",
101 SPIRV::Extension::Extension::SPV_KHR_uniform_group_instructions},
102 {"SPV_KHR_no_integer_wrap_decoration",
103 SPIRV::Extension::Extension::SPV_KHR_no_integer_wrap_decoration},
104 {"SPV_KHR_float_controls",
105 SPIRV::Extension::Extension::SPV_KHR_float_controls},
106 {"SPV_KHR_expect_assume",
107 SPIRV::Extension::Extension::SPV_KHR_expect_assume},
108 {"SPV_KHR_bit_instructions",
109 SPIRV::Extension::Extension::SPV_KHR_bit_instructions},
110 {"SPV_KHR_integer_dot_product",
111 SPIRV::Extension::Extension::SPV_KHR_integer_dot_product},
112 {"SPV_KHR_linkonce_odr", SPIRV::Extension::Extension::SPV_KHR_linkonce_odr},
113 {"SPV_KHR_fma", SPIRV::Extension::Extension::SPV_KHR_fma},
114 {"SPV_INTEL_inline_assembly",
115 SPIRV::Extension::Extension::SPV_INTEL_inline_assembly},
116 {"SPV_INTEL_bindless_images",
117 SPIRV::Extension::Extension::SPV_INTEL_bindless_images},
118 {"SPV_INTEL_bfloat16_arithmetic",
119 SPIRV::Extension::Extension::SPV_INTEL_bfloat16_arithmetic},
120 {"SPV_INTEL_bfloat16_conversion",
121 SPIRV::Extension::Extension::SPV_INTEL_bfloat16_conversion},
122 {"SPV_KHR_subgroup_rotate",
123 SPIRV::Extension::Extension::SPV_KHR_subgroup_rotate},
124 {"SPV_INTEL_variable_length_array",
125 SPIRV::Extension::Extension::SPV_INTEL_variable_length_array},
126 {"SPV_INTEL_function_pointers",
127 SPIRV::Extension::Extension::SPV_INTEL_function_pointers},
128 {"SPV_KHR_shader_clock", SPIRV::Extension::Extension::SPV_KHR_shader_clock},
129 {"SPV_KHR_cooperative_matrix",
130 SPIRV::Extension::Extension::SPV_KHR_cooperative_matrix},
131 {"SPV_KHR_non_semantic_info",
132 SPIRV::Extension::Extension::SPV_KHR_non_semantic_info},
133 {"SPV_KHR_ray_query", SPIRV::Extension::Extension::SPV_KHR_ray_query},
134 {"SPV_EXT_shader_image_int64",
135 SPIRV::Extension::Extension::SPV_EXT_shader_image_int64},
136 {"SPV_KHR_fragment_shader_barycentric",
137 SPIRV::Extension::Extension::SPV_KHR_fragment_shader_barycentric},
138 {"SPV_KHR_physical_storage_buffer",
139 SPIRV::Extension::Extension::SPV_KHR_physical_storage_buffer},
140 {"SPV_KHR_vulkan_memory_model",
141 SPIRV::Extension::Extension::SPV_KHR_vulkan_memory_model},
142 {"SPV_NV_shader_subgroup_partitioned",
143 SPIRV::Extension::Extension::SPV_NV_shader_subgroup_partitioned},
144 {"SPV_INTEL_long_composites",
145 SPIRV::Extension::Extension::SPV_INTEL_long_composites},
146 {"SPV_INTEL_fp_max_error",
147 SPIRV::Extension::Extension::SPV_INTEL_fp_max_error},
148 {"SPV_INTEL_subgroup_matrix_multiply_accumulate",
149 SPIRV::Extension::Extension::
150 SPV_INTEL_subgroup_matrix_multiply_accumulate},
151 {"SPV_INTEL_ternary_bitwise_function",
152 SPIRV::Extension::Extension::SPV_INTEL_ternary_bitwise_function},
153 {"SPV_INTEL_2d_block_io",
154 SPIRV::Extension::Extension::SPV_INTEL_2d_block_io},
155 {"SPV_INTEL_int4", SPIRV::Extension::Extension::SPV_INTEL_int4},
156 {"SPV_KHR_float_controls2",
157 SPIRV::Extension::Extension::SPV_KHR_float_controls2},
158 {"SPV_INTEL_tensor_float32_conversion",
159 SPIRV::Extension::Extension::SPV_INTEL_tensor_float32_conversion},
160 {"SPV_KHR_bfloat16", SPIRV::Extension::Extension::SPV_KHR_bfloat16},
161 {"SPV_EXT_relaxed_printf_string_address_space",
162 SPIRV::Extension::Extension::SPV_EXT_relaxed_printf_string_address_space},
163 {"SPV_INTEL_predicated_io",
164 SPIRV::Extension::Extension::SPV_INTEL_predicated_io},
165 {"SPV_KHR_maximal_reconvergence",
166 SPIRV::Extension::Extension::SPV_KHR_maximal_reconvergence},
167 {"SPV_INTEL_kernel_attributes",
168 SPIRV::Extension::Extension::SPV_INTEL_kernel_attributes},
169 {"SPV_ALTERA_blocking_pipes",
170 SPIRV::Extension::Extension::SPV_ALTERA_blocking_pipes},
171 {"SPV_INTEL_int4", SPIRV::Extension::Extension::SPV_INTEL_int4},
172 {"SPV_ALTERA_arbitrary_precision_fixed_point",
173 SPIRV::Extension::Extension::SPV_ALTERA_arbitrary_precision_fixed_point},
174 {"SPV_EXT_image_raw10_raw12",
175 SPIRV::Extension::Extension::SPV_EXT_image_raw10_raw12},
176 {"SPV_INTEL_unstructured_loop_controls",
177 SPIRV::Extension::Extension::SPV_INTEL_unstructured_loop_controls}};
178
179bool SPIRVExtensionsParser::parse(cl::Option &O, StringRef ArgName,
180 StringRef ArgValue, ExtensionSet &Vals) {
181 SmallVector<StringRef, 10> Tokens;
182 ArgValue.split(Tokens, ",", -1, false);
183
184 ExtensionSet EnabledExtensions;
185
186 auto M = partition(Tokens, [](auto &&T) { return T.starts_with('+'); });
187
188 if (std::any_of(M, Tokens.end(), equal_to("all")))
189 for (auto &&El : make_second_range(SPIRVExtensionMap))
190 Vals.insert(El);
191
192 for (auto &&Token : make_range(Tokens.begin(), M)) {
193 StringRef ExtensionName = Token.substr(1);
194 auto NameValuePair = SPIRVExtensionMap.find(ExtensionName);
195
196 if (NameValuePair == SPIRVExtensionMap.end())
197 return O.error("Unknown SPIR-V extension: " + Token.str());
198
199 EnabledExtensions.insert(NameValuePair->second);
200 }
201
202 for (auto &&Token : make_range(M, Tokens.end())) {
203 if (Token == "all")
204 continue;
205
206 if (Token.size() == 3 && Token.upper() == "KHR") {
207 for (const auto &[ExtensionName, ExtensionEnum] : SPIRVExtensionMap)
208 if (StringRef(ExtensionName).starts_with("SPV_KHR_"))
209 Vals.insert(ExtensionEnum);
210 continue;
211 }
212
213 if (Token.empty() || (!Token.starts_with("+") && !Token.starts_with("-")))
214 return O.error("Invalid extension list format: " + Token);
215
216 auto NameValuePair = SPIRVExtensionMap.find(Token.substr(1));
217
218 if (NameValuePair == SPIRVExtensionMap.end())
219 return O.error("Unknown SPIR-V extension: " + Token.str());
220 if (EnabledExtensions.count(NameValuePair->second))
221 return O.error(
222 "Extension cannot be allowed and disallowed at the same time: " +
223 NameValuePair->first());
224 DisabledExtensions.insert(NameValuePair->second);
225 Vals.erase(NameValuePair->second);
226 }
227
228 Vals.insert(EnabledExtensions.begin(), EnabledExtensions.end());
229
230 return false;
231}
232
233StringRef
234SPIRVExtensionsParser::checkExtensions(const std::vector<std::string> &ExtNames,
235 ExtensionSet &AllowedExtensions) {
236 for (const auto &Ext : ExtNames) {
237 if (Ext == "all") {
238 for (const auto &[ExtensionName, ExtensionEnum] : SPIRVExtensionMap)
239 AllowedExtensions.insert(ExtensionEnum);
240 break;
241 }
242 auto It = SPIRVExtensionMap.find(Ext);
243 if (It == SPIRVExtensionMap.end())
244 return Ext;
245 AllowedExtensions.insert(It->second);
246 }
247 return StringRef();
248}
249
250ExtensionSet SPIRVExtensionsParser::getValidExtensions(const Triple &TT) {
251 ExtensionSet R;
252 SPIRV::Environment::Environment CurrentEnvironment =
253 SPIRV::Environment::Environment::EnvOpenCL;
254 if (TT.getOS() == Triple::Vulkan)
255 CurrentEnvironment = SPIRV::Environment::Environment::EnvVulkan;
256
257 for (const auto &[ExtensionName, ExtensionEnum] : SPIRVExtensionMap) {
258 EnvironmentList AllowedEnv = getSymbolicOperandAllowedEnvironments(
259 SPIRV::OperandCategory::OperandCategory::ExtensionOperand,
260 ExtensionEnum);
261
262 if (llvm::is_contained(AllowedEnv, CurrentEnvironment) &&
263 !llvm::is_contained(DisabledExtensions, ExtensionEnum))
264 R.insert(ExtensionEnum);
265 }
266
267 return R;
268}
StringMap.h
This file defines the StringMap class.
T
#define T
Definition Mips16ISelLowering.cpp:282
SPIRVExtensionMap
static const StringMap< 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::StringMap
StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...
Definition StringMap.h:133
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:730
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:591
llvm::Triple
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:47
llvm::detail::DenseSetImpl::insert
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:202
llvm::detail::DenseSetImpl::erase
bool erase(const ValueT &V)
Definition DenseSet.h:100
llvm::detail::DenseSetImpl::count
size_type count(const_arg_type_t< ValueT > V) const
Return 1 if the specified key is in the set, 0 otherwise.
Definition DenseSet.h:180
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:258
llvm::ExtensionSet
DenseSet< SPIRV::Extension::Extension > ExtensionSet
Definition SPIRVBaseInfo.h:260
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:2173
llvm::getSymbolicOperandAllowedEnvironments
EnvironmentList getSymbolicOperandAllowedEnvironments(SPIRV::OperandCategory::OperandCategory Category, uint32_t Value)
Definition SPIRVBaseInfo.cpp:145
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:2033
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:1409
llvm::is_contained
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Definition STLExtras.h:1947
llvm::SPIRVExtensionsParser::checkExtensions
static StringRef checkExtensions(const std::vector< std::string > &ExtNames, ExtensionSet &AllowedExtensions)
Validates and converts extension names into internal enum values.
Definition SPIRVCommandLine.cpp:234
llvm::SPIRVExtensionsParser::getValidExtensions
static ExtensionSet getValidExtensions(const Triple &TT)
Returns the list of extensions that are valid for a particular target environment (i....
Definition SPIRVCommandLine.cpp:250
llvm::SPIRVExtensionsParser::parse
bool parse(cl::Option &O, StringRef ArgName, StringRef ArgValue, ExtensionSet &Vals)
Parses SPIR-V extension name from CLI arguments.
Definition SPIRVCommandLine.cpp:179
Generated on for LLVM by doxygen 1.14.0