1// Copyright (c) 2015-2016 The Khronos Group Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#include "source/ext_inst.h"
16
17#include <cstring>
18
19// DebugInfo extended instruction set.
20// See https://www.khronos.org/registry/spir-v/specs/1.0/DebugInfo.html
21// TODO(dneto): DebugInfo.h should probably move to SPIRV-Headers.
22#include "DebugInfo.h"
23
24#include "source/latest_version_glsl_std_450_header.h"
25#include "source/latest_version_opencl_std_header.h"
26#include "source/macro.h"
27#include "source/spirv_definition.h"
28
29#include "debuginfo.insts.inc"
30#include "glsl.std.450.insts.inc"
31#include "opencl.debuginfo.100.insts.inc"
32#include "opencl.std.insts.inc"
33
34#include "spirv-tools/libspirv.h"
35#include "spv-amd-gcn-shader.insts.inc"
36#include "spv-amd-shader-ballot.insts.inc"
37#include "spv-amd-shader-explicit-vertex-parameter.insts.inc"
38#include "spv-amd-shader-trinary-minmax.insts.inc"
39
40static const spv_ext_inst_group_t kGroups_1_0[] = {
41 {SPV_EXT_INST_TYPE_GLSL_STD_450, ARRAY_SIZE(glsl_entries), glsl_entries},
42 {SPV_EXT_INST_TYPE_OPENCL_STD, ARRAY_SIZE(opencl_entries), opencl_entries},
43 {SPV_EXT_INST_TYPE_SPV_AMD_SHADER_EXPLICIT_VERTEX_PARAMETER,
44 ARRAY_SIZE(spv_amd_shader_explicit_vertex_parameter_entries),
45 spv_amd_shader_explicit_vertex_parameter_entries},
46 {SPV_EXT_INST_TYPE_SPV_AMD_SHADER_TRINARY_MINMAX,
47 ARRAY_SIZE(spv_amd_shader_trinary_minmax_entries),
48 spv_amd_shader_trinary_minmax_entries},
49 {SPV_EXT_INST_TYPE_SPV_AMD_GCN_SHADER,
50 ARRAY_SIZE(spv_amd_gcn_shader_entries), spv_amd_gcn_shader_entries},
51 {SPV_EXT_INST_TYPE_SPV_AMD_SHADER_BALLOT,
52 ARRAY_SIZE(spv_amd_shader_ballot_entries), spv_amd_shader_ballot_entries},
53 {SPV_EXT_INST_TYPE_DEBUGINFO, ARRAY_SIZE(debuginfo_entries),
54 debuginfo_entries},
55 {SPV_EXT_INST_TYPE_OPENCL_DEBUGINFO_100,
56 ARRAY_SIZE(opencl_debuginfo_100_entries), opencl_debuginfo_100_entries},
57};
58
59static const spv_ext_inst_table_t kTable_1_0 = {ARRAY_SIZE(kGroups_1_0),
60 kGroups_1_0};
61
62spv_result_t spvExtInstTableGet(spv_ext_inst_table* pExtInstTable,
63 spv_target_env env) {
64 if (!pExtInstTable) return SPV_ERROR_INVALID_POINTER;
65
66 switch (env) {
67 // The extended instruction sets are all version 1.0 so far.
68 case SPV_ENV_UNIVERSAL_1_0:
69 case SPV_ENV_VULKAN_1_0:
70 case SPV_ENV_UNIVERSAL_1_1:
71 case SPV_ENV_UNIVERSAL_1_2:
72 case SPV_ENV_OPENCL_1_2:
73 case SPV_ENV_OPENCL_EMBEDDED_1_2:
74 case SPV_ENV_OPENCL_2_0:
75 case SPV_ENV_OPENCL_EMBEDDED_2_0:
76 case SPV_ENV_OPENCL_2_1:
77 case SPV_ENV_OPENCL_EMBEDDED_2_1:
78 case SPV_ENV_OPENCL_2_2:
79 case SPV_ENV_OPENCL_EMBEDDED_2_2:
80 case SPV_ENV_OPENGL_4_0:
81 case SPV_ENV_OPENGL_4_1:
82 case SPV_ENV_OPENGL_4_2:
83 case SPV_ENV_OPENGL_4_3:
84 case SPV_ENV_OPENGL_4_5:
85 case SPV_ENV_UNIVERSAL_1_3:
86 case SPV_ENV_VULKAN_1_1:
87 case SPV_ENV_VULKAN_1_1_SPIRV_1_4:
88 case SPV_ENV_WEBGPU_0:
89 case SPV_ENV_UNIVERSAL_1_4:
90 case SPV_ENV_UNIVERSAL_1_5:
91 case SPV_ENV_VULKAN_1_2:
92 *pExtInstTable = &kTable_1_0;
93 return SPV_SUCCESS;
94 default:
95 return SPV_ERROR_INVALID_TABLE;
96 }
97}
98
99spv_ext_inst_type_t spvExtInstImportTypeGet(const char* name) {
100 // The names are specified by the respective extension instruction
101 // specifications.
102 if (!strcmp("GLSL.std.450", name)) {
103 return SPV_EXT_INST_TYPE_GLSL_STD_450;
104 }
105 if (!strcmp("OpenCL.std", name)) {
106 return SPV_EXT_INST_TYPE_OPENCL_STD;
107 }
108 if (!strcmp("SPV_AMD_shader_explicit_vertex_parameter", name)) {
109 return SPV_EXT_INST_TYPE_SPV_AMD_SHADER_EXPLICIT_VERTEX_PARAMETER;
110 }
111 if (!strcmp("SPV_AMD_shader_trinary_minmax", name)) {
112 return SPV_EXT_INST_TYPE_SPV_AMD_SHADER_TRINARY_MINMAX;
113 }
114 if (!strcmp("SPV_AMD_gcn_shader", name)) {
115 return SPV_EXT_INST_TYPE_SPV_AMD_GCN_SHADER;
116 }
117 if (!strcmp("SPV_AMD_shader_ballot", name)) {
118 return SPV_EXT_INST_TYPE_SPV_AMD_SHADER_BALLOT;
119 }
120 if (!strcmp("DebugInfo", name)) {
121 return SPV_EXT_INST_TYPE_DEBUGINFO;
122 }
123 if (!strcmp("OpenCL.DebugInfo.100", name)) {
124 return SPV_EXT_INST_TYPE_OPENCL_DEBUGINFO_100;
125 }
126 // ensure to add any known non-semantic extended instruction sets
127 // above this point, and update spvExtInstIsNonSemantic()
128 if (!strncmp("NonSemantic.", name, 12)) {
129 return SPV_EXT_INST_TYPE_NONSEMANTIC_UNKNOWN;
130 }
131 return SPV_EXT_INST_TYPE_NONE;
132}
133
134bool spvExtInstIsNonSemantic(const spv_ext_inst_type_t type) {
135 if (type == SPV_EXT_INST_TYPE_NONSEMANTIC_UNKNOWN) {
136 return true;
137 }
138 return false;
139}
140
141bool spvExtInstIsDebugInfo(const spv_ext_inst_type_t type) {
142 if (type == SPV_EXT_INST_TYPE_OPENCL_DEBUGINFO_100 ||
143 type == SPV_EXT_INST_TYPE_DEBUGINFO) {
144 return true;
145 }
146 return false;
147}
148
149spv_result_t spvExtInstTableNameLookup(const spv_ext_inst_table table,
150 const spv_ext_inst_type_t type,
151 const char* name,
152 spv_ext_inst_desc* pEntry) {
153 if (!table) return SPV_ERROR_INVALID_TABLE;
154 if (!pEntry) return SPV_ERROR_INVALID_POINTER;
155
156 for (uint32_t groupIndex = 0; groupIndex < table->count; groupIndex++) {
157 const auto& group = table->groups[groupIndex];
158 if (type != group.type) continue;
159 for (uint32_t index = 0; index < group.count; index++) {
160 const auto& entry = group.entries[index];
161 if (!strcmp(name, entry.name)) {
162 *pEntry = &entry;
163 return SPV_SUCCESS;
164 }
165 }
166 }
167
168 return SPV_ERROR_INVALID_LOOKUP;
169}
170
171spv_result_t spvExtInstTableValueLookup(const spv_ext_inst_table table,
172 const spv_ext_inst_type_t type,
173 const uint32_t value,
174 spv_ext_inst_desc* pEntry) {
175 if (!table) return SPV_ERROR_INVALID_TABLE;
176 if (!pEntry) return SPV_ERROR_INVALID_POINTER;
177
178 for (uint32_t groupIndex = 0; groupIndex < table->count; groupIndex++) {
179 const auto& group = table->groups[groupIndex];
180 if (type != group.type) continue;
181 for (uint32_t index = 0; index < group.count; index++) {
182 const auto& entry = group.entries[index];
183 if (value == entry.ext_inst) {
184 *pEntry = &entry;
185 return SPV_SUCCESS;
186 }
187 }
188 }
189
190 return SPV_ERROR_INVALID_LOOKUP;
191}
192