1 // 2 // Copyright (C) 2014-2016 LunarG, Inc. 3 // Copyright (C) 2018 Google, Inc. 4 // 5 // All rights reserved. 6 // 7 // Redistribution and use in source and binary forms, with or without 8 // modification, are permitted provided that the following conditions 9 // are met: 10 // 11 // Redistributions of source code must retain the above copyright 12 // notice, this list of conditions and the following disclaimer. 13 // 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. 18 // 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. 22 // 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. 35 36 // 37 // Call into SPIRV-Tools to disassemble, validate, and optimize. 38 // 39 40 #pragma once 41 #ifndef GLSLANG_SPV_TOOLS_H 42 #define GLSLANG_SPV_TOOLS_H 43 44 #if ENABLE_OPT 45 #include <vector> 46 #include <ostream> 47 #include "spirv-tools/libspirv.h" 48 #endif 49 50 #include "glslang/MachineIndependent/localintermediate.h" 51 #include "Logger.h" 52 53 namespace glslang { 54 55 struct SpvOptions { SpvOptionsSpvOptions56 SpvOptions() : generateDebugInfo(false), stripDebugInfo(false), disableOptimizer(true), 57 optimizeSize(false), disassemble(false), validate(false) { } 58 bool generateDebugInfo; 59 bool stripDebugInfo; 60 bool disableOptimizer; 61 bool optimizeSize; 62 bool disassemble; 63 bool validate; 64 }; 65 66 #if ENABLE_OPT 67 68 // Use the SPIRV-Tools disassembler to print SPIR-V using a SPV_ENV_UNIVERSAL_1_3 environment. 69 void SpirvToolsDisassemble(std::ostream& out, const std::vector<unsigned int>& spirv); 70 71 // Use the SPIRV-Tools disassembler to print SPIR-V with a provided SPIR-V environment. 72 void SpirvToolsDisassemble(std::ostream& out, const std::vector<unsigned int>& spirv, 73 spv_target_env requested_context); 74 75 // Apply the SPIRV-Tools validator to generated SPIR-V. 76 void SpirvToolsValidate(const glslang::TIntermediate& intermediate, std::vector<unsigned int>& spirv, 77 spv::SpvBuildLogger*, bool prelegalization); 78 79 // Apply the SPIRV-Tools optimizer to generated SPIR-V. HLSL SPIR-V is legalized in the process. 80 void SpirvToolsTransform(const glslang::TIntermediate& intermediate, std::vector<unsigned int>& spirv, 81 spv::SpvBuildLogger*, const SpvOptions*); 82 83 // Apply the SPIRV-Tools optimizer to strip debug info from SPIR-V. This is implicitly done by 84 // SpirvToolsTransform if spvOptions->stripDebugInfo is set, but can be called separately if 85 // optimization is disabled. 86 void SpirvToolsStripDebugInfo(const glslang::TIntermediate& intermediate, 87 std::vector<unsigned int>& spirv, spv::SpvBuildLogger*); 88 89 #endif 90 91 } // end namespace glslang 92 93 #endif // GLSLANG_SPV_TOOLS_H 94