John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 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 | |
pheonix | c897c3b | 2020-11-02 13:40:50 -0800 | [diff] [blame^] | 44 | #if ENABLE_OPT |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 45 | #include <vector> |
| 46 | #include <ostream> |
pheonix | c897c3b | 2020-11-02 13:40:50 -0800 | [diff] [blame^] | 47 | #include "spirv-tools/libspirv.h" |
John Kessenich | 155d351 | 2019-08-08 23:29:20 -0600 | [diff] [blame] | 48 | #endif |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 49 | |
John Kessenich | b5d9dee | 2019-12-09 03:12:10 -0700 | [diff] [blame] | 50 | #include "glslang/MachineIndependent/localintermediate.h" |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 51 | #include "Logger.h" |
| 52 | |
| 53 | namespace glslang { |
| 54 | |
| 55 | struct SpvOptions { |
Shahbaz Youssefi | d52dce5 | 2020-06-17 12:47:44 -0400 | [diff] [blame] | 56 | SpvOptions() : generateDebugInfo(false), stripDebugInfo(false), disableOptimizer(true), |
John Kessenich | c340425 | 2018-08-23 15:29:08 -0600 | [diff] [blame] | 57 | optimizeSize(false), disassemble(false), validate(false) { } |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 58 | bool generateDebugInfo; |
Shahbaz Youssefi | d52dce5 | 2020-06-17 12:47:44 -0400 | [diff] [blame] | 59 | bool stripDebugInfo; |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 60 | bool disableOptimizer; |
| 61 | bool optimizeSize; |
| 62 | bool disassemble; |
John Kessenich | c340425 | 2018-08-23 15:29:08 -0600 | [diff] [blame] | 63 | bool validate; |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 64 | }; |
| 65 | |
pheonix | c897c3b | 2020-11-02 13:40:50 -0800 | [diff] [blame^] | 66 | #if ENABLE_OPT |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 67 | |
pheonix | c897c3b | 2020-11-02 13:40:50 -0800 | [diff] [blame^] | 68 | // Use the SPIRV-Tools disassembler to print SPIR-V using a SPV_ENV_UNIVERSAL_1_3 environment. |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 69 | void SpirvToolsDisassemble(std::ostream& out, const std::vector<unsigned int>& spirv); |
| 70 | |
pheonix | c897c3b | 2020-11-02 13:40:50 -0800 | [diff] [blame^] | 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 | |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 75 | // Apply the SPIRV-Tools validator to generated SPIR-V. |
| 76 | void SpirvToolsValidate(const glslang::TIntermediate& intermediate, std::vector<unsigned int>& spirv, |
Jeff Bolz | fd556e3 | 2019-06-07 14:42:08 -0500 | [diff] [blame] | 77 | spv::SpvBuildLogger*, bool prelegalization); |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 78 | |
Shahbaz Youssefi | d52dce5 | 2020-06-17 12:47:44 -0400 | [diff] [blame] | 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*); |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 88 | |
| 89 | #endif |
| 90 | |
Nico Weber | 76577b1 | 2019-02-21 11:05:21 -0500 | [diff] [blame] | 91 | } // end namespace glslang |
John Kessenich | 717c80a | 2018-08-23 15:17:10 -0600 | [diff] [blame] | 92 | |
Nico Weber | 76577b1 | 2019-02-21 11:05:21 -0500 | [diff] [blame] | 93 | #endif // GLSLANG_SPV_TOOLS_H |