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 #ifdef ENABLE_OPT
45 #include <vector>
46 #include <ostream>
47 #endif
48 
49 #include "glslang/MachineIndependent/localintermediate.h"
50 #include "Logger.h"
51 
52 namespace glslang {
53 
54 struct SpvOptions {
SpvOptionsSpvOptions55     SpvOptions() : generateDebugInfo(false), disableOptimizer(true),
56         optimizeSize(false), disassemble(false), validate(false) { }
57     bool generateDebugInfo;
58     bool disableOptimizer;
59     bool optimizeSize;
60     bool disassemble;
61     bool validate;
62 };
63 
64 #ifdef ENABLE_OPT
65 
66 // Use the SPIRV-Tools disassembler to print SPIR-V.
67 void SpirvToolsDisassemble(std::ostream& out, const std::vector<unsigned int>& spirv);
68 
69 // Apply the SPIRV-Tools validator to generated SPIR-V.
70 void SpirvToolsValidate(const glslang::TIntermediate& intermediate, std::vector<unsigned int>& spirv,
71                         spv::SpvBuildLogger*, bool prelegalization);
72 
73 // Apply the SPIRV-Tools optimizer to generated SPIR-V, for the purpose of
74 // legalizing HLSL SPIR-V.
75 void SpirvToolsLegalize(const glslang::TIntermediate& intermediate, std::vector<unsigned int>& spirv,
76                         spv::SpvBuildLogger*, const SpvOptions*);
77 
78 #endif
79 
80 } // end namespace glslang
81 
82 #endif // GLSLANG_SPV_TOOLS_H
83