1 // Copyright (c) 2016 Google 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 <vector>
16
17 #include "gmock/gmock.h"
18 #include "source/spirv_target_env.h"
19 #include "test/unit_spirv.h"
20
21 namespace spvtools {
22 namespace {
23
24 using ::testing::AnyOf;
25 using ::testing::Eq;
26 using ::testing::StartsWith;
27 using ::testing::ValuesIn;
28
29 using TargetEnvTest = ::testing::TestWithParam<spv_target_env>;
TEST_P(TargetEnvTest,CreateContext)30 TEST_P(TargetEnvTest, CreateContext) {
31 spv_target_env env = GetParam();
32 spv_context context = spvContextCreate(env);
33 ASSERT_NE(nullptr, context);
34 spvContextDestroy(context); // Avoid leaking
35 }
36
TEST_P(TargetEnvTest,ValidDescription)37 TEST_P(TargetEnvTest, ValidDescription) {
38 const char* description = spvTargetEnvDescription(GetParam());
39 ASSERT_NE(nullptr, description);
40 ASSERT_THAT(description, StartsWith("SPIR-V "));
41 }
42
TEST_P(TargetEnvTest,ValidSpirvVersion)43 TEST_P(TargetEnvTest, ValidSpirvVersion) {
44 auto spirv_version = spvVersionForTargetEnv(GetParam());
45 ASSERT_THAT(spirv_version, AnyOf(0x10000, 0x10100, 0x10200, 0x10300));
46 }
47
48 INSTANTIATE_TEST_SUITE_P(AllTargetEnvs, TargetEnvTest,
49 ValuesIn(spvtest::AllTargetEnvironments()));
50
TEST(GetContextTest,InvalidTargetEnvProducesNull)51 TEST(GetContextTest, InvalidTargetEnvProducesNull) {
52 // Use a value beyond the last valid enum value.
53 spv_context context = spvContextCreate(static_cast<spv_target_env>(30));
54 EXPECT_EQ(context, nullptr);
55 }
56
57 // A test case for parsing an environment string.
58 struct ParseCase {
59 const char* input;
60 bool success; // Expect to successfully parse?
61 spv_target_env env; // The parsed environment, if successful.
62 };
63
64 using TargetParseTest = ::testing::TestWithParam<ParseCase>;
65
TEST_P(TargetParseTest,Samples)66 TEST_P(TargetParseTest, Samples) {
67 spv_target_env env;
68 bool parsed = spvParseTargetEnv(GetParam().input, &env);
69 EXPECT_THAT(parsed, Eq(GetParam().success));
70 if (parsed) {
71 EXPECT_THAT(env, Eq(GetParam().env));
72 }
73 }
74
75 INSTANTIATE_TEST_SUITE_P(
76 TargetParsing, TargetParseTest,
77 ValuesIn(std::vector<ParseCase>{
78 {"spv1.0", true, SPV_ENV_UNIVERSAL_1_0},
79 {"spv1.1", true, SPV_ENV_UNIVERSAL_1_1},
80 {"spv1.2", true, SPV_ENV_UNIVERSAL_1_2},
81 {"spv1.3", true, SPV_ENV_UNIVERSAL_1_3},
82 {"vulkan1.0", true, SPV_ENV_VULKAN_1_0},
83 {"vulkan1.1", true, SPV_ENV_VULKAN_1_1},
84 {"vulkan1.2", true, SPV_ENV_VULKAN_1_2},
85 {"opencl2.1", true, SPV_ENV_OPENCL_2_1},
86 {"opencl2.2", true, SPV_ENV_OPENCL_2_2},
87 {"opengl4.0", true, SPV_ENV_OPENGL_4_0},
88 {"opengl4.1", true, SPV_ENV_OPENGL_4_1},
89 {"opengl4.2", true, SPV_ENV_OPENGL_4_2},
90 {"opengl4.3", true, SPV_ENV_OPENGL_4_3},
91 {"opengl4.5", true, SPV_ENV_OPENGL_4_5},
92 {"opencl1.2", true, SPV_ENV_OPENCL_1_2},
93 {"opencl1.2embedded", true, SPV_ENV_OPENCL_EMBEDDED_1_2},
94 {"opencl2.0", true, SPV_ENV_OPENCL_2_0},
95 {"opencl2.0embedded", true, SPV_ENV_OPENCL_EMBEDDED_2_0},
96 {"opencl2.1embedded", true, SPV_ENV_OPENCL_EMBEDDED_2_1},
97 {"opencl2.2embedded", true, SPV_ENV_OPENCL_EMBEDDED_2_2},
98 {"opencl2.3", false, SPV_ENV_UNIVERSAL_1_0},
99 {"opencl3.0", false, SPV_ENV_UNIVERSAL_1_0},
100 {"vulkan1.9", false, SPV_ENV_UNIVERSAL_1_0},
101 {"vulkan2.0", false, SPV_ENV_UNIVERSAL_1_0},
102 {nullptr, false, SPV_ENV_UNIVERSAL_1_0},
103 {"", false, SPV_ENV_UNIVERSAL_1_0},
104 {"abc", false, SPV_ENV_UNIVERSAL_1_0},
105 }));
106
107 // A test case for parsing an environment string.
108 struct ParseVulkanCase {
109 uint32_t vulkan;
110 uint32_t spirv;
111 bool success; // Expect to successfully parse?
112 spv_target_env env; // The parsed environment, if successful.
113 };
114
115 using TargetParseVulkanTest = ::testing::TestWithParam<ParseVulkanCase>;
116
TEST_P(TargetParseVulkanTest,Samples)117 TEST_P(TargetParseVulkanTest, Samples) {
118 spv_target_env env;
119 bool parsed = spvParseVulkanEnv(GetParam().vulkan, GetParam().spirv, &env);
120 EXPECT_THAT(parsed, Eq(GetParam().success));
121 if (parsed) {
122 EXPECT_THAT(env, Eq(GetParam().env));
123 }
124 }
125
126 #define VK(MAJ, MIN) ((MAJ << 22) | (MIN << 12))
127 #define SPV(MAJ, MIN) ((MAJ << 16) | (MIN << 8))
128 INSTANTIATE_TEST_SUITE_P(
129 TargetVulkanParsing, TargetParseVulkanTest,
130 ValuesIn(std::vector<ParseVulkanCase>{
131 // Vulkan 1.0 cases
132 {VK(1, 0), SPV(1, 0), true, SPV_ENV_VULKAN_1_0},
133 {VK(1, 0), SPV(1, 1), true, SPV_ENV_VULKAN_1_1},
134 {VK(1, 0), SPV(1, 2), true, SPV_ENV_VULKAN_1_1},
135 {VK(1, 0), SPV(1, 3), true, SPV_ENV_VULKAN_1_1},
136 {VK(1, 0), SPV(1, 4), true, SPV_ENV_VULKAN_1_1_SPIRV_1_4},
137 {VK(1, 0), SPV(1, 5), true, SPV_ENV_VULKAN_1_2},
138 {VK(1, 0), SPV(1, 6), true, SPV_ENV_VULKAN_1_3},
139 {VK(1, 0), SPV(1, 7), false, SPV_ENV_UNIVERSAL_1_0},
140 // Vulkan 1.1 cases
141 {VK(1, 1), SPV(1, 0), true, SPV_ENV_VULKAN_1_1},
142 {VK(1, 1), SPV(1, 1), true, SPV_ENV_VULKAN_1_1},
143 {VK(1, 1), SPV(1, 2), true, SPV_ENV_VULKAN_1_1},
144 {VK(1, 1), SPV(1, 3), true, SPV_ENV_VULKAN_1_1},
145 {VK(1, 1), SPV(1, 4), true, SPV_ENV_VULKAN_1_1_SPIRV_1_4},
146 {VK(1, 1), SPV(1, 5), true, SPV_ENV_VULKAN_1_2},
147 {VK(1, 1), SPV(1, 6), true, SPV_ENV_VULKAN_1_3},
148 {VK(1, 1), SPV(1, 7), false, SPV_ENV_UNIVERSAL_1_0},
149 // Vulkan 1.2 cases
150 {VK(1, 2), SPV(1, 0), true, SPV_ENV_VULKAN_1_2},
151 {VK(1, 2), SPV(1, 1), true, SPV_ENV_VULKAN_1_2},
152 {VK(1, 2), SPV(1, 2), true, SPV_ENV_VULKAN_1_2},
153 {VK(1, 2), SPV(1, 3), true, SPV_ENV_VULKAN_1_2},
154 {VK(1, 2), SPV(1, 4), true, SPV_ENV_VULKAN_1_2},
155 {VK(1, 2), SPV(1, 5), true, SPV_ENV_VULKAN_1_2},
156 {VK(1, 2), SPV(1, 6), true, SPV_ENV_VULKAN_1_3},
157 {VK(1, 2), SPV(1, 7), false, SPV_ENV_UNIVERSAL_1_0},
158 // Vulkan 1.3 cases
159 {VK(1, 3), SPV(1, 0), true, SPV_ENV_VULKAN_1_3},
160 {VK(1, 3), SPV(1, 1), true, SPV_ENV_VULKAN_1_3},
161 {VK(1, 3), SPV(1, 2), true, SPV_ENV_VULKAN_1_3},
162 {VK(1, 3), SPV(1, 3), true, SPV_ENV_VULKAN_1_3},
163 {VK(1, 3), SPV(1, 4), true, SPV_ENV_VULKAN_1_3},
164 {VK(1, 3), SPV(1, 5), true, SPV_ENV_VULKAN_1_3},
165 {VK(1, 3), SPV(1, 6), true, SPV_ENV_VULKAN_1_3},
166 {VK(1, 3), SPV(1, 7), false, SPV_ENV_UNIVERSAL_1_0},
167 // Vulkan 2.0 cases
168 {VK(2, 0), SPV(1, 0), false, SPV_ENV_UNIVERSAL_1_0},
169 // Vulkan 99.0 cases
170 {VK(99, 0), SPV(1, 0), false, SPV_ENV_UNIVERSAL_1_0},
171 }));
172
173 // A test case for parsing the text header of disassembly.
174 struct ParseEnvInDisassemblyCase {
175 std::string text;
176 bool success; // Expect to successfully parse?
177 spv_target_env env; // The parsed environment, if successful.
178 };
179
180 using TargetParseEnvInDisassemblyTest =
181 ::testing::TestWithParam<ParseEnvInDisassemblyCase>;
182
183 constexpr spv_target_env kSentinelEnv = SPV_ENV_OPENCL_2_2;
184
TEST_P(TargetParseEnvInDisassemblyTest,Samples)185 TEST_P(TargetParseEnvInDisassemblyTest, Samples) {
186 const std::string& text = GetParam().text;
187 const std::vector<char> text_vec(text.begin(), text.end());
188 spv_target_env got_env = kSentinelEnv;
189 bool parsed = spvReadEnvironmentFromText(text_vec, &got_env);
190 EXPECT_EQ(parsed, GetParam().success);
191 EXPECT_EQ(got_env, GetParam().env) << '"' << text << '"';
192 }
193
194 INSTANTIATE_TEST_SUITE_P(
195 TargetTextParsing, TargetParseEnvInDisassemblyTest,
196 ValuesIn(std::vector<ParseEnvInDisassemblyCase>{
197 {"; Version: 1.0", true, SPV_ENV_UNIVERSAL_1_0},
198 {"; Version: 1.1", true, SPV_ENV_UNIVERSAL_1_1},
199 {"; Version: 1.2", true, SPV_ENV_UNIVERSAL_1_2},
200 {"; Version: 1.3", true, SPV_ENV_UNIVERSAL_1_3},
201 {"; Version: 1.4", true, SPV_ENV_UNIVERSAL_1_4},
202 {"; Version: 1.5", true, SPV_ENV_UNIVERSAL_1_5},
203 {"; Version: 1.6", true, SPV_ENV_UNIVERSAL_1_6},
204 {"; Version: 1.7", false, kSentinelEnv},
205 {"; Version: 1.8", false, kSentinelEnv},
206 {"; Version: 1.9", false, kSentinelEnv},
207 {"; Version: 2.0", false, kSentinelEnv},
208
209 // Check trailing text
210 {"; Version: 1.1\n", true, SPV_ENV_UNIVERSAL_1_1},
211 {"; Version: 1.1\t", true, SPV_ENV_UNIVERSAL_1_1},
212 {"; Version: 1.1 ", true, SPV_ENV_UNIVERSAL_1_1},
213 {"; Version: 1.1x", true, SPV_ENV_UNIVERSAL_1_1},
214 // Not a digit.
215 {"; Version: 1.10", false, kSentinelEnv},
216
217 // Unexpected prefix
218 {";Version: 1.1", false, kSentinelEnv},
219
220 // Leading spaces
221 {" \t ; Version: 1.1", true, SPV_ENV_UNIVERSAL_1_1},
222 // Previous lines
223 {"; SPIR-V\n; Version: 1.1", true, SPV_ENV_UNIVERSAL_1_1},
224
225 // After a non-header line
226 {"OpCapability Shader\n; Version: 1.1", false, kSentinelEnv}}));
227
228 } // anonymous namespace
229 } // namespace spvtools
230