2 // Copyright (C) 2016-2017 Google, Inc.
3 // Copyright (C) 2020 The Khronos Group Inc.
5 // All rights reserved.
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
11 // Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
14 // Redistributions in binary form must reproduce the above
15 // copyright notice, this list of conditions and the following
16 // disclaimer in the documentation and/or other materials provided
17 // with the distribution.
19 // Neither the name of 3Dlabs Inc. Ltd. nor the names of its
20 // contributors may be used to endorse or promote products derived
21 // from this software without specific prior written permission.
23 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27 // COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 // POSSIBILITY OF SUCH DAMAGE.
38 #include <gtest/gtest.h>
40 #include "TestFixture.h"
42 #include "glslang/MachineIndependent/iomapper.h"
43 #include "glslang/MachineIndependent/reflection.h"
46 namespace glslangtest {
50 std::vector<std::string> fileNames;
54 using GlslMapIOTest = GlslangTest <::testing::TestWithParam<IoMapData>>;
57 std::string interfaceName(T symbol) {
58 return symbol.getType()->getBasicType() == glslang::EbtBlock ? std::string(symbol.getType()->getTypeName().c_str()) : symbol.name;
61 bool verifyIOMapping(std::string& linkingError, glslang::TProgram& program) {
64 // Verify IO Mapping by generating reflection for each stage individually
65 // and comparing layout qualifiers on the results
68 int reflectionOptions = EShReflectionDefault;
69 //reflectionOptions |= EShReflectionStrictArraySuffix;
70 //reflectionOptions |= EShReflectionBasicArraySuffix;
71 reflectionOptions |= EShReflectionIntermediateIO;
72 reflectionOptions |= EShReflectionSeparateBuffers;
73 reflectionOptions |= EShReflectionAllBlockVariables;
74 //reflectionOptions |= EShReflectionUnwrapIOBlocks;
76 success &= program.buildReflection(reflectionOptions);
78 // check that the reflection output from the individual stages all makes sense..
79 std::vector<glslang::TReflection> stageReflections;
80 for (int s = 0; s < EShLangCount; ++s) {
81 if (program.getIntermediate((EShLanguage)s)) {
82 stageReflections.emplace_back((EShReflectionOptions)reflectionOptions, (EShLanguage)s, (EShLanguage)s);
83 success &= stageReflections.back().addStage((EShLanguage)s, *program.getIntermediate((EShLanguage)s));
87 // check that input/output locations match between stages
88 auto it = stageReflections.begin();
90 for (; nextIt != stageReflections.end(); it++, nextIt++) {
91 int numOut = it->getNumPipeOutputs();
92 std::map<std::string, const glslang::TObjectReflection*> pipeOut;
94 for (int i = 0; i < numOut; i++) {
95 const glslang::TObjectReflection& out = it->getPipeOutput(i);
96 std::string name = interfaceName(out);
100 int numIn = nextIt->getNumPipeInputs();
101 for (int i = 0; i < numIn; i++) {
102 auto in = nextIt->getPipeInput(i);
103 std::string name = interfaceName(in);
104 auto out = pipeOut.find(name);
106 if (out != pipeOut.end()) {
107 auto inQualifier = in.getType()->getQualifier();
108 auto outQualifier = out->second->getType()->getQualifier();
109 success &= outQualifier.layoutLocation == inQualifier.layoutLocation;
112 if (!in.getType()->isStruct()) {
114 for (auto outIt : pipeOut) {
115 if (outIt.second->getType()->isStruct()) {
116 unsigned int baseLoc = outIt.second->getType()->getQualifier().hasLocation() ?
117 outIt.second->getType()->getQualifier().layoutLocation :
118 std::numeric_limits<unsigned int>::max();
119 for (size_t j = 0; j < outIt.second->getType()->getStruct()->size(); j++) {
120 baseLoc = (*outIt.second->getType()->getStruct())[j].type->getQualifier().hasLocation() ?
121 (*outIt.second->getType()->getStruct())[j].type->getQualifier().layoutLocation : baseLoc;
122 if (baseLoc != std::numeric_limits<unsigned int>::max()) {
123 if (baseLoc == in.getType()->getQualifier().layoutLocation) {
127 baseLoc += glslang::TIntermediate::computeTypeLocationSize(*(*outIt.second->getType()->getStruct())[j].type, EShLangVertex);
138 unsigned int baseLoc = in.getType()->getQualifier().hasLocation() ? in.getType()->getQualifier().layoutLocation : -1;
139 for (size_t j = 0; j < in.getType()->getStruct()->size(); j++) {
140 baseLoc = (*in.getType()->getStruct())[j].type->getQualifier().hasLocation() ?
141 (*in.getType()->getStruct())[j].type->getQualifier().layoutLocation : baseLoc;
142 if (baseLoc != std::numeric_limits<unsigned int>::max()) {
143 bool isMemberFound = false;
144 for (auto outIt : pipeOut) {
145 if (baseLoc == outIt.second->getType()->getQualifier().layoutLocation) {
146 isMemberFound = true;
150 if (!isMemberFound) {
154 baseLoc += glslang::TIntermediate::computeTypeLocationSize(*(*in.getType()->getStruct())[j].type, EShLangVertex);
162 // compare uniforms in each stage to the program
164 int totalUniforms = program.getNumUniformVariables();
165 std::map<std::string, const glslang::TObjectReflection*> programUniforms;
166 for (int i = 0; i < totalUniforms; i++) {
167 const glslang::TObjectReflection& uniform = program.getUniform(i);
168 std::string name = interfaceName(uniform);
169 programUniforms[name] = &uniform;
171 it = stageReflections.begin();
172 for (; it != stageReflections.end(); it++) {
173 int numUniform = it->getNumUniforms();
174 std::map<std::string, glslang::TObjectReflection> uniforms;
176 for (int i = 0; i < numUniform; i++) {
177 glslang::TObjectReflection uniform = it->getUniform(i);
178 std::string name = interfaceName(uniform);
179 auto programUniform = programUniforms.find(name);
181 if (programUniform != programUniforms.end()) {
182 auto stageQualifier = uniform.getType()->getQualifier();
183 auto programQualifier = programUniform->second->getType()->getQualifier();
185 success &= stageQualifier.layoutLocation == programQualifier.layoutLocation;
186 success &= stageQualifier.layoutBinding == programQualifier.layoutBinding;
187 success &= stageQualifier.layoutSet == programQualifier.layoutSet;
196 // compare uniform blocks in each stage to the program table
198 int totalUniforms = program.getNumUniformBlocks();
199 std::map<std::string, const glslang::TObjectReflection*> programUniforms;
200 for (int i = 0; i < totalUniforms; i++) {
201 const glslang::TObjectReflection& uniform = program.getUniformBlock(i);
202 std::string name = interfaceName(uniform);
203 programUniforms[name] = &uniform;
205 it = stageReflections.begin();
206 for (; it != stageReflections.end(); it++) {
207 int numUniform = it->getNumUniformBlocks();
208 std::map<std::string, glslang::TObjectReflection> uniforms;
210 for (int i = 0; i < numUniform; i++) {
211 glslang::TObjectReflection uniform = it->getUniformBlock(i);
212 std::string name = interfaceName(uniform);
213 auto programUniform = programUniforms.find(name);
215 if (programUniform != programUniforms.end()) {
216 auto stageQualifier = uniform.getType()->getQualifier();
217 auto programQualifier = programUniform->second->getType()->getQualifier();
219 success &= stageQualifier.layoutLocation == programQualifier.layoutLocation;
220 success &= stageQualifier.layoutBinding == programQualifier.layoutBinding;
221 success &= stageQualifier.layoutSet == programQualifier.layoutSet;
231 linkingError += "Mismatched cross-stage IO\n";
237 TEST_P(GlslMapIOTest, FromFile)
239 const auto& fileNames = GetParam().fileNames;
240 Semantics semantics = GetParam().semantics;
241 const size_t fileCount = fileNames.size();
242 const EShMessages controls = DeriveOptions(Source::GLSL, semantics, Target::BothASTAndSpv);
243 GlslangResult result;
245 // Compile each input shader file.
247 std::vector<std::unique_ptr<glslang::TShader>> shaders;
248 for (size_t i = 0; i < fileCount; ++i) {
249 std::string contents;
250 tryLoadFile(GlobalTestSettings.testRoot + "/" + fileNames[i],
252 shaders.emplace_back(
253 new glslang::TShader(GetShaderStage(GetSuffix(fileNames[i]))));
254 auto* shader = shaders.back().get();
256 shader->setAutoMapLocations(true);
257 shader->setAutoMapBindings(true);
259 if (controls & EShMsgSpvRules) {
260 if (controls & EShMsgVulkanRules) {
261 shader->setEnvInput((controls & EShMsgReadHlsl) ? glslang::EShSourceHlsl
262 : glslang::EShSourceGlsl,
263 shader->getStage(), glslang::EShClientVulkan, 100);
264 shader->setEnvClient(glslang::EShClientVulkan, glslang::EShTargetVulkan_1_1);
265 shader->setEnvTarget(glslang::EShTargetSpv, glslang::EShTargetSpv_1_0);
267 shader->setEnvInput((controls & EShMsgReadHlsl) ? glslang::EShSourceHlsl
268 : glslang::EShSourceGlsl,
269 shader->getStage(), glslang::EShClientOpenGL, 100);
270 shader->setEnvClient(glslang::EShClientOpenGL, glslang::EShTargetOpenGL_450);
271 shader->setEnvTarget(glslang::EshTargetSpv, glslang::EShTargetSpv_1_0);
275 success &= compile(shader, contents, "", controls);
277 result.shaderResults.push_back(
278 { fileNames[i], shader->getInfoLog(), shader->getInfoDebugLog() });
282 glslang::TProgram program;
283 for (const auto& shader : shaders) program.addShader(shader.get());
284 success &= program.link(controls);
285 result.linkingOutput = program.getInfoLog();
286 result.linkingError = program.getInfoDebugLog();
288 unsigned int stage = 0;
289 glslang::TIntermediate* firstIntermediate = nullptr;
290 while (!program.getIntermediate((EShLanguage)stage) && stage < EShLangCount) { stage++; }
291 firstIntermediate = program.getIntermediate((EShLanguage)stage);
293 glslang::TDefaultGlslIoResolver resolver(*firstIntermediate);
294 glslang::TGlslIoMapper ioMapper;
297 success &= program.mapIO(&resolver, &ioMapper);
298 result.linkingOutput = program.getInfoLog();
299 result.linkingError = program.getInfoDebugLog();
302 success &= verifyIOMapping(result.linkingError, program);
303 result.validationResult = success;
305 if (success && (controls & EShMsgSpvRules)) {
306 for (int stage = 0; stage < EShLangCount; ++stage) {
307 if (program.getIntermediate((EShLanguage)stage)) {
308 spv::SpvBuildLogger logger;
309 std::vector<uint32_t> spirv_binary;
310 options().disableOptimizer = false;
311 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage),
312 spirv_binary, &logger, &options());
314 std::ostringstream disassembly_stream;
316 spv::Disassemble(disassembly_stream, spirv_binary);
317 result.spirvWarningsErrors += logger.getAllMessages();
318 result.spirv += disassembly_stream.str();
319 result.validationResult &= !options().validate || logger.getAllMessages().empty();
324 std::ostringstream stream;
325 outputResultToStream(&stream, result, controls);
327 // Check with expected results.
328 const std::string expectedOutputFname =
329 GlobalTestSettings.testRoot + "/baseResults/" + fileNames.front() + ".out";
330 std::string expectedOutput;
331 tryLoadFile(expectedOutputFname, "expected output", &expectedOutput);
333 checkEqAndUpdateIfRequested(expectedOutput, stream.str(), expectedOutputFname,
334 result.spirvWarningsErrors);
338 INSTANTIATE_TEST_SUITE_P(
340 ::testing::ValuesIn(std::vector<IoMapData>({
341 {{"iomap.crossStage.vert", "iomap.crossStage.frag" }, Semantics::OpenGL},
342 {{"iomap.crossStage.2.vert", "iomap.crossStage.2.geom", "iomap.crossStage.2.frag" }, Semantics::OpenGL},
343 {{"iomap.blockOutVariableIn.vert", "iomap.blockOutVariableIn.frag"}, Semantics::OpenGL},
344 {{"iomap.variableOutBlockIn.vert", "iomap.variableOutBlockIn.frag"}, Semantics::OpenGL},
345 {{"iomap.blockOutVariableIn.2.vert", "iomap.blockOutVariableIn.geom"}, Semantics::OpenGL},
346 {{"iomap.variableOutBlockIn.2.vert", "iomap.variableOutBlockIn.geom"}, Semantics::OpenGL},
348 {{"iomap.crossStage.vk.vert", "iomap.crossStage.vk.geom", "iomap.crossStage.vk.frag" }, Semantics::Vulkan},
353 } // anonymous namespace
354 } // namespace glslangtest