SPIRV/SpvTools.h

   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 {
  56     bool generateDebugInfo {false};
  57     bool stripDebugInfo {false};
  58     bool disableOptimizer {true};
  59     bool optimizeSize {false};
  60     bool disassemble {false};
  61     bool validate {false};
  62     bool emitNonSemanticShaderDebugInfo {false};
  63     bool emitNonSemanticShaderDebugSource{ false };
  64     bool compileOnly{false};
  65 };
  66
  67 #if ENABLE_OPT
  68
  69 // Translate glslang's view of target versioning to what SPIRV-Tools uses.
  70 spv_target_env MapToSpirvToolsEnv(const SpvVersion& spvVersion, spv::SpvBuildLogger* logger);
  71
  72 // Use the SPIRV-Tools disassembler to print SPIR-V using a SPV_ENV_UNIVERSAL_1_3 environment.
  73 void SpirvToolsDisassemble(std::ostream& out, const std::vector<unsigned int>& spirv);
  74
  75 // Use the SPIRV-Tools disassembler to print SPIR-V with a provided SPIR-V environment.
  76 void SpirvToolsDisassemble(std::ostream& out, const std::vector<unsigned int>& spirv,
  77                            spv_target_env requested_context);
  78
  79 // Apply the SPIRV-Tools validator to generated SPIR-V.
  80 void SpirvToolsValidate(const glslang::TIntermediate& intermediate, std::vector<unsigned int>& spirv,
  81                         spv::SpvBuildLogger*, bool prelegalization);
  82
  83 // Apply the SPIRV-Tools optimizer to generated SPIR-V.  HLSL SPIR-V is legalized in the process.
  84 void SpirvToolsTransform(const glslang::TIntermediate& intermediate, std::vector<unsigned int>& spirv,
  85                          spv::SpvBuildLogger*, const SpvOptions*);
  86
  87 // Apply the SPIRV-Tools EliminateDeadInputComponents pass to generated SPIR-V. Put result in |spirv|.
  88 void SpirvToolsEliminateDeadInputComponents(spv_target_env target_env, std::vector<unsigned int>& spirv,
  89                                             spv::SpvBuildLogger*);
  90
  91 // Apply the SPIRV-Tools AnalyzeDeadOutputStores pass to generated SPIR-V. Put result in |live_locs|.
  92 // Return true if the result is valid.
  93 bool SpirvToolsAnalyzeDeadOutputStores(spv_target_env target_env, std::vector<unsigned int>& spirv,
  94                                        std::unordered_set<uint32_t>* live_locs,
  95                                        std::unordered_set<uint32_t>* live_builtins, spv::SpvBuildLogger*);
  96
  97 // Apply the SPIRV-Tools EliminateDeadOutputStores and AggressiveDeadCodeElimination passes to generated SPIR-V using
  98 // |live_locs|. Put result in |spirv|.
  99 void SpirvToolsEliminateDeadOutputStores(spv_target_env target_env, std::vector<unsigned int>& spirv,
 100                                          std::unordered_set<uint32_t>* live_locs,
 101                                          std::unordered_set<uint32_t>* live_builtins, spv::SpvBuildLogger*);
 102
 103 // Apply the SPIRV-Tools optimizer to strip debug info from SPIR-V.  This is implicitly done by
 104 // SpirvToolsTransform if spvOptions->stripDebugInfo is set, but can be called separately if
 105 // optimization is disabled.
 106 void SpirvToolsStripDebugInfo(const glslang::TIntermediate& intermediate,
 107         std::vector<unsigned int>& spirv, spv::SpvBuildLogger*);
 108
 109 #endif
 110
 111 } // end namespace glslang
 112
 113 #endif // GLSLANG_SPV_TOOLS_H