SPIRV/SpvTools.cpp

   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 #if ENABLE_OPT
  41
  42 #include <cstdio>
  43 #include <iostream>
  44
  45 #include "SpvTools.h"
  46 #include "spirv-tools/optimizer.hpp"
  47 #include "spirv-tools/libspirv.h"
  48
  49 namespace glslang {
  50
  51 // Translate glslang's view of target versioning to what SPIRV-Tools uses.
  52 spv_target_env MapToSpirvToolsEnv(const SpvVersion& spvVersion, spv::SpvBuildLogger* logger)
  53 {
  54     switch (spvVersion.vulkan) {
  55     case glslang::EShTargetVulkan_1_0:
  56         return spv_target_env::SPV_ENV_VULKAN_1_0;
  57     case glslang::EShTargetVulkan_1_1:
  58         switch (spvVersion.spv) {
  59         case EShTargetSpv_1_0:
  60         case EShTargetSpv_1_1:
  61         case EShTargetSpv_1_2:
  62         case EShTargetSpv_1_3:
  63             return spv_target_env::SPV_ENV_VULKAN_1_1;
  64         case EShTargetSpv_1_4:
  65             return spv_target_env::SPV_ENV_VULKAN_1_1_SPIRV_1_4;
  66         default:
  67             logger->missingFunctionality("Target version for SPIRV-Tools validator");
  68             return spv_target_env::SPV_ENV_VULKAN_1_1;
  69         }
  70     default:
  71         break;
  72     }
  73
  74     if (spvVersion.openGl > 0)
  75         return spv_target_env::SPV_ENV_OPENGL_4_5;
  76
  77     logger->missingFunctionality("Target version for SPIRV-Tools validator");
  78     return spv_target_env::SPV_ENV_UNIVERSAL_1_0;
  79 }
  80
  81
  82 // Use the SPIRV-Tools disassembler to print SPIR-V.
  83 void SpirvToolsDisassemble(std::ostream& out, const std::vector<unsigned int>& spirv)
  84 {
  85     // disassemble
  86     spv_context context = spvContextCreate(SPV_ENV_UNIVERSAL_1_3);
  87     spv_text text;
  88     spv_diagnostic diagnostic = nullptr;
  89     spvBinaryToText(context, spirv.data(), spirv.size(),
  90         SPV_BINARY_TO_TEXT_OPTION_FRIENDLY_NAMES | SPV_BINARY_TO_TEXT_OPTION_INDENT,
  91         &text, &diagnostic);
  92
  93     // dump
  94     if (diagnostic == nullptr)
  95         out << text->str;
  96     else
  97         spvDiagnosticPrint(diagnostic);
  98
  99     // teardown
 100     spvDiagnosticDestroy(diagnostic);
 101     spvContextDestroy(context);
 102 }
 103
 104 // Apply the SPIRV-Tools validator to generated SPIR-V.
 105 void SpirvToolsValidate(const glslang::TIntermediate& intermediate, std::vector<unsigned int>& spirv,
 106                         spv::SpvBuildLogger* logger, bool prelegalization)
 107 {
 108     // validate
 109     spv_context context = spvContextCreate(MapToSpirvToolsEnv(intermediate.getSpv(), logger));
 110     spv_const_binary_t binary = { spirv.data(), spirv.size() };
 111     spv_diagnostic diagnostic = nullptr;
 112     spv_validator_options options = spvValidatorOptionsCreate();
 113     spvValidatorOptionsSetRelaxBlockLayout(options, intermediate.usingHlslOffsets());
 114     spvValidatorOptionsSetBeforeHlslLegalization(options, prelegalization);
 115     spvValidateWithOptions(context, options, &binary, &diagnostic);
 116
 117     // report
 118     if (diagnostic != nullptr) {
 119         logger->error("SPIRV-Tools Validation Errors");
 120         logger->error(diagnostic->error);
 121     }
 122
 123     // tear down
 124     spvValidatorOptionsDestroy(options);
 125     spvDiagnosticDestroy(diagnostic);
 126     spvContextDestroy(context);
 127 }
 128
 129 // Apply the SPIRV-Tools optimizer to generated SPIR-V, for the purpose of
 130 // legalizing HLSL SPIR-V.
 131 void SpirvToolsLegalize(const glslang::TIntermediate&, std::vector<unsigned int>& spirv,
 132                         spv::SpvBuildLogger*, const SpvOptions* options)
 133 {
 134     spv_target_env target_env = SPV_ENV_UNIVERSAL_1_2;
 135
 136     spvtools::Optimizer optimizer(target_env);
 137     optimizer.SetMessageConsumer(
 138         [](spv_message_level_t level, const char *source, const spv_position_t &position, const char *message) {
 139             auto &out = std::cerr;
 140             switch (level)
 141             {
 142             case SPV_MSG_FATAL:
 143             case SPV_MSG_INTERNAL_ERROR:
 144             case SPV_MSG_ERROR:
 145                 out << "error: ";
 146                 break;
 147             case SPV_MSG_WARNING:
 148                 out << "warning: ";
 149                 break;
 150             case SPV_MSG_INFO:
 151             case SPV_MSG_DEBUG:
 152                 out << "info: ";
 153                 break;
 154             default:
 155                 break;
 156             }
 157             if (source)
 158             {
 159                 out << source << ":";
 160             }
 161             out << position.line << ":" << position.column << ":" << position.index << ":";
 162             if (message)
 163             {
 164                 out << " " << message;
 165             }
 166             out << std::endl;
 167         });
 168
 169     // If debug (specifically source line info) is being generated, propagate
 170     // line information into all SPIR-V instructions. This avoids loss of
 171     // information when instructions are deleted or moved. Later, remove
 172     // redundant information to minimize final SPRIR-V size.
 173     if (options->generateDebugInfo) {
 174         optimizer.RegisterPass(spvtools::CreatePropagateLineInfoPass());
 175     }
 176     optimizer.RegisterPass(spvtools::CreateWrapOpKillPass());
 177     optimizer.RegisterPass(spvtools::CreateDeadBranchElimPass());
 178     optimizer.RegisterPass(spvtools::CreateMergeReturnPass());
 179     optimizer.RegisterPass(spvtools::CreateInlineExhaustivePass());
 180     optimizer.RegisterPass(spvtools::CreateEliminateDeadFunctionsPass());
 181     optimizer.RegisterPass(spvtools::CreateScalarReplacementPass());
 182     optimizer.RegisterPass(spvtools::CreateLocalAccessChainConvertPass());
 183     optimizer.RegisterPass(spvtools::CreateLocalSingleBlockLoadStoreElimPass());
 184     optimizer.RegisterPass(spvtools::CreateLocalSingleStoreElimPass());
 185     optimizer.RegisterPass(spvtools::CreateSimplificationPass());
 186     optimizer.RegisterPass(spvtools::CreateAggressiveDCEPass());
 187     optimizer.RegisterPass(spvtools::CreateVectorDCEPass());
 188     optimizer.RegisterPass(spvtools::CreateDeadInsertElimPass());
 189     optimizer.RegisterPass(spvtools::CreateAggressiveDCEPass());
 190     optimizer.RegisterPass(spvtools::CreateDeadBranchElimPass());
 191     optimizer.RegisterPass(spvtools::CreateBlockMergePass());
 192     optimizer.RegisterPass(spvtools::CreateLocalMultiStoreElimPass());
 193     optimizer.RegisterPass(spvtools::CreateIfConversionPass());
 194     optimizer.RegisterPass(spvtools::CreateSimplificationPass());
 195     optimizer.RegisterPass(spvtools::CreateAggressiveDCEPass());
 196     optimizer.RegisterPass(spvtools::CreateVectorDCEPass());
 197     optimizer.RegisterPass(spvtools::CreateDeadInsertElimPass());
 198     if (options->optimizeSize) {
 199         optimizer.RegisterPass(spvtools::CreateRedundancyEliminationPass());
 200     }
 201     optimizer.RegisterPass(spvtools::CreateAggressiveDCEPass());
 202     optimizer.RegisterPass(spvtools::CreateCFGCleanupPass());
 203     if (options->generateDebugInfo) {
 204         optimizer.RegisterPass(spvtools::CreateRedundantLineInfoElimPass());
 205     }
 206
 207     spvtools::OptimizerOptions spvOptOptions;
 208     spvOptOptions.set_run_validator(false); // The validator may run as a seperate step later on
 209     optimizer.Run(spirv.data(), spirv.size(), &spirv, spvOptOptions);
 210 }
 211
 212 }; // end namespace glslang
 213
 214 #endif