third_party/SPIRV-Tools/source/disassemble.cpp - SwiftShader - Git at Google

 // Copyright (c) 2015-2020 The Khronos Group Inc.
 // Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights
 // reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.

 // This file contains a disassembler:  It converts a SPIR-V binary
 // to text.

 #include <algorithm>
 #include <cassert>
 #include <cstring>
 #include <iomanip>
 #include <memory>
 #include <unordered_map>
 #include <utility>

 #include "source/assembly_grammar.h"
 #include "source/binary.h"
 #include "source/diagnostic.h"
 #include "source/disassemble.h"
 #include "source/ext_inst.h"
 #include "source/name_mapper.h"
 #include "source/opcode.h"
 #include "source/parsed_operand.h"
 #include "source/print.h"
 #include "source/spirv_constant.h"
 #include "source/spirv_endian.h"
 #include "source/util/hex_float.h"
 #include "source/util/make_unique.h"
 #include "spirv-tools/libspirv.h"

 namespace {

 // A Disassembler instance converts a SPIR-V binary to its assembly
 // representation.
 class Disassembler {
  public:
   Disassembler(const spvtools::AssemblyGrammar& grammar, uint32_t options,
                spvtools::NameMapper name_mapper)
       : grammar_(grammar),
         print_(spvIsInBitfield(SPV_BINARY_TO_TEXT_OPTION_PRINT, options)),
         color_(spvIsInBitfield(SPV_BINARY_TO_TEXT_OPTION_COLOR, options)),
         indent_(spvIsInBitfield(SPV_BINARY_TO_TEXT_OPTION_INDENT, options)
                     ? kStandardIndent
                     : 0),
         text_(),
         out_(print_ ? out_stream() : out_stream(text_)),
         stream_(out_.get()),
         header_(!spvIsInBitfield(SPV_BINARY_TO_TEXT_OPTION_NO_HEADER, options)),
         show_byte_offset_(spvIsInBitfield(
             SPV_BINARY_TO_TEXT_OPTION_SHOW_BYTE_OFFSET, options)),
         byte_offset_(0),
         name_mapper_(std::move(name_mapper)) {}

   // Emits the assembly header for the module, and sets up internal state
   // so subsequent callbacks can handle the cases where the entire module
   // is either big-endian or little-endian.
   spv_result_t HandleHeader(spv_endianness_t endian, uint32_t version,
                             uint32_t generator, uint32_t id_bound,
                             uint32_t schema);
   // Emits the assembly text for the given instruction.
   spv_result_t HandleInstruction(const spv_parsed_instruction_t& inst);

   // If not printing, populates text_result with the accumulated text.
   // Returns SPV_SUCCESS on success.
   spv_result_t SaveTextResult(spv_text* text_result) const;

  private:
   enum { kStandardIndent = 15 };

   using out_stream = spvtools::out_stream;

   // Emits an operand for the given instruction, where the instruction
   // is at offset words from the start of the binary.
   void EmitOperand(const spv_parsed_instruction_t& inst,
                    const uint16_t operand_index);

   // Emits a mask expression for the given mask word of the specified type.
   void EmitMaskOperand(const spv_operand_type_t type, const uint32_t word);

   // Resets the output color, if color is turned on.
   void ResetColor() {
     if (color_) out_.get() << spvtools::clr::reset{print_};
   }
   // Sets the output to grey, if color is turned on.
   void SetGrey() {
     if (color_) out_.get() << spvtools::clr::grey{print_};
   }
   // Sets the output to blue, if color is turned on.
   void SetBlue() {
     if (color_) out_.get() << spvtools::clr::blue{print_};
   }
   // Sets the output to yellow, if color is turned on.
   void SetYellow() {
     if (color_) out_.get() << spvtools::clr::yellow{print_};
   }
   // Sets the output to red, if color is turned on.
   void SetRed() {
     if (color_) out_.get() << spvtools::clr::red{print_};
   }
   // Sets the output to green, if color is turned on.
   void SetGreen() {
     if (color_) out_.get() << spvtools::clr::green{print_};
   }

   const spvtools::AssemblyGrammar& grammar_;
   const bool print_;  // Should we also print to the standard output stream?
   const bool color_;  // Should we print in colour?
   const int indent_;  // How much to indent. 0 means don't indent
   spv_endianness_t endian_;  // The detected endianness of the binary.
   std::stringstream text_;   // Captures the text, if not printing.
   out_stream out_;  // The Output stream.  Either to text_ or standard output.
   std::ostream& stream_;  // The output std::stream.
   const bool header_;     // Should we output header as the leading comment?
   const bool show_byte_offset_;  // Should we print byte offset, in hex?
   size_t byte_offset_;           // The number of bytes processed so far.
   spvtools::NameMapper name_mapper_;
 };

 spv_result_t Disassembler::HandleHeader(spv_endianness_t endian,
                                         uint32_t version, uint32_t generator,
                                         uint32_t id_bound, uint32_t schema) {
   endian_ = endian;

   if (header_) {
     SetGrey();
     const char* generator_tool =
         spvGeneratorStr(SPV_GENERATOR_TOOL_PART(generator));
     stream_ << "; SPIR-V\n"
             << "; Version: " << SPV_SPIRV_VERSION_MAJOR_PART(version) << "."
             << SPV_SPIRV_VERSION_MINOR_PART(version) << "\n"
             << "; Generator: " << generator_tool;
     // For unknown tools, print the numeric tool value.
     if (0 == strcmp("Unknown", generator_tool)) {
       stream_ << "(" << SPV_GENERATOR_TOOL_PART(generator) << ")";
     }
     // Print the miscellaneous part of the generator word on the same
     // line as the tool name.
     stream_ << "; " << SPV_GENERATOR_MISC_PART(generator) << "\n"
             << "; Bound: " << id_bound << "\n"
             << "; Schema: " << schema << "\n";
     ResetColor();
   }

   byte_offset_ = SPV_INDEX_INSTRUCTION * sizeof(uint32_t);

   return SPV_SUCCESS;
 }

 spv_result_t Disassembler::HandleInstruction(
     const spv_parsed_instruction_t& inst) {
   if (inst.result_id) {
     SetBlue();
     const std::string id_name = name_mapper_(inst.result_id);
     if (indent_)
       stream_ << std::setw(std::max(0, indent_ - 3 - int(id_name.size())));
     stream_ << "%" << id_name;
     ResetColor();
     stream_ << " = ";
   } else {
     stream_ << std::string(indent_, ' ');
   }

   stream_ << "Op" << spvOpcodeString(static_cast<SpvOp>(inst.opcode));

   for (uint16_t i = 0; i < inst.num_operands; i++) {
     const spv_operand_type_t type = inst.operands[i].type;
     assert(type != SPV_OPERAND_TYPE_NONE);
     if (type == SPV_OPERAND_TYPE_RESULT_ID) continue;
     stream_ << " ";
     EmitOperand(inst, i);
   }

   if (show_byte_offset_) {
     SetGrey();
     auto saved_flags = stream_.flags();
     auto saved_fill = stream_.fill();
     stream_ << " ; 0x" << std::setw(8) << std::hex << std::setfill('0')
             << byte_offset_;
     stream_.flags(saved_flags);
     stream_.fill(saved_fill);
     ResetColor();
   }

   byte_offset_ += inst.num_words * sizeof(uint32_t);

   stream_ << "\n";
   return SPV_SUCCESS;
 }

 void Disassembler::EmitOperand(const spv_parsed_instruction_t& inst,
                                const uint16_t operand_index) {
   assert(operand_index < inst.num_operands);
   const spv_parsed_operand_t& operand = inst.operands[operand_index];
   const uint32_t word = inst.words[operand.offset];
   switch (operand.type) {
     case SPV_OPERAND_TYPE_RESULT_ID:
       assert(false && "<result-id> is not supposed to be handled here");
       SetBlue();
       stream_ << "%" << name_mapper_(word);
       break;
     case SPV_OPERAND_TYPE_ID:
     case SPV_OPERAND_TYPE_TYPE_ID:
     case SPV_OPERAND_TYPE_SCOPE_ID:
     case SPV_OPERAND_TYPE_MEMORY_SEMANTICS_ID:
       SetYellow();
       stream_ << "%" << name_mapper_(word);
       break;
     case SPV_OPERAND_TYPE_EXTENSION_INSTRUCTION_NUMBER: {
       spv_ext_inst_desc ext_inst;
       SetRed();
       if (grammar_.lookupExtInst(inst.ext_inst_type, word, &ext_inst) ==
           SPV_SUCCESS) {
         stream_ << ext_inst->name;
       } else {
         if (!spvExtInstIsNonSemantic(inst.ext_inst_type)) {
           assert(false && "should have caught this earlier");
         } else {
           // for non-semantic instruction sets we can just print the number
           stream_ << word;
         }
       }
     } break;
     case SPV_OPERAND_TYPE_SPEC_CONSTANT_OP_NUMBER: {
       spv_opcode_desc opcode_desc;
       if (grammar_.lookupOpcode(SpvOp(word), &opcode_desc))
         assert(false && "should have caught this earlier");
       SetRed();
       stream_ << opcode_desc->name;
     } break;
     case SPV_OPERAND_TYPE_LITERAL_INTEGER:
     case SPV_OPERAND_TYPE_TYPED_LITERAL_NUMBER: {
       SetRed();
       spvtools::EmitNumericLiteral(&stream_, inst, operand);
       ResetColor();
     } break;
     case SPV_OPERAND_TYPE_LITERAL_STRING: {
       stream_ << "\"";
       SetGreen();
       // Strings are always little-endian, and null-terminated.
       // Write out the characters, escaping as needed, and without copying
       // the entire string.
       auto c_str = reinterpret_cast<const char*>(inst.words + operand.offset);
       for (auto p = c_str; *p; ++p) {
         if (*p == '"' || *p == '\\') stream_ << '\\';
         stream_ << *p;
       }
       ResetColor();
       stream_ << '"';
     } break;
     case SPV_OPERAND_TYPE_CAPABILITY:
     case SPV_OPERAND_TYPE_SOURCE_LANGUAGE:
     case SPV_OPERAND_TYPE_EXECUTION_MODEL:
     case SPV_OPERAND_TYPE_ADDRESSING_MODEL:
     case SPV_OPERAND_TYPE_MEMORY_MODEL:
     case SPV_OPERAND_TYPE_EXECUTION_MODE:
     case SPV_OPERAND_TYPE_STORAGE_CLASS:
     case SPV_OPERAND_TYPE_DIMENSIONALITY:
     case SPV_OPERAND_TYPE_SAMPLER_ADDRESSING_MODE:
     case SPV_OPERAND_TYPE_SAMPLER_FILTER_MODE:
     case SPV_OPERAND_TYPE_SAMPLER_IMAGE_FORMAT:
     case SPV_OPERAND_TYPE_FP_ROUNDING_MODE:
     case SPV_OPERAND_TYPE_LINKAGE_TYPE:
     case SPV_OPERAND_TYPE_ACCESS_QUALIFIER:
     case SPV_OPERAND_TYPE_FUNCTION_PARAMETER_ATTRIBUTE:
     case SPV_OPERAND_TYPE_DECORATION:
     case SPV_OPERAND_TYPE_BUILT_IN:
     case SPV_OPERAND_TYPE_GROUP_OPERATION:
     case SPV_OPERAND_TYPE_KERNEL_ENQ_FLAGS:
     case SPV_OPERAND_TYPE_KERNEL_PROFILING_INFO:
     case SPV_OPERAND_TYPE_RAY_FLAGS:
     case SPV_OPERAND_TYPE_RAY_QUERY_INTERSECTION:
     case SPV_OPERAND_TYPE_RAY_QUERY_COMMITTED_INTERSECTION_TYPE:
     case SPV_OPERAND_TYPE_RAY_QUERY_CANDIDATE_INTERSECTION_TYPE:
     case SPV_OPERAND_TYPE_DEBUG_BASE_TYPE_ATTRIBUTE_ENCODING:
     case SPV_OPERAND_TYPE_DEBUG_COMPOSITE_TYPE:
     case SPV_OPERAND_TYPE_DEBUG_TYPE_QUALIFIER:
     case SPV_OPERAND_TYPE_DEBUG_OPERATION:
     case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_BASE_TYPE_ATTRIBUTE_ENCODING:
     case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_COMPOSITE_TYPE:
     case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_TYPE_QUALIFIER:
     case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_OPERATION:
     case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_IMPORTED_ENTITY: {
       spv_operand_desc entry;
       if (grammar_.lookupOperand(operand.type, word, &entry))
         assert(false && "should have caught this earlier");
       stream_ << entry->name;
     } break;
     case SPV_OPERAND_TYPE_FP_FAST_MATH_MODE:
     case SPV_OPERAND_TYPE_FUNCTION_CONTROL:
     case SPV_OPERAND_TYPE_LOOP_CONTROL:
     case SPV_OPERAND_TYPE_IMAGE:
     case SPV_OPERAND_TYPE_MEMORY_ACCESS:
     case SPV_OPERAND_TYPE_SELECTION_CONTROL:
     case SPV_OPERAND_TYPE_DEBUG_INFO_FLAGS:
     case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_INFO_FLAGS:
       EmitMaskOperand(operand.type, word);
       break;
     default:
       assert(false && "unhandled or invalid case");
   }
   ResetColor();
 }

 void Disassembler::EmitMaskOperand(const spv_operand_type_t type,
                                    const uint32_t word) {
   // Scan the mask from least significant bit to most significant bit.  For each
   // set bit, emit the name of that bit. Separate multiple names with '|'.
   uint32_t remaining_word = word;
   uint32_t mask;
   int num_emitted = 0;
   for (mask = 1; remaining_word; mask <<= 1) {
     if (remaining_word & mask) {
       remaining_word ^= mask;
       spv_operand_desc entry;
       if (grammar_.lookupOperand(type, mask, &entry))
         assert(false && "should have caught this earlier");
       if (num_emitted) stream_ << "|";
       stream_ << entry->name;
       num_emitted++;
     }
   }
   if (!num_emitted) {
     // An operand value of 0 was provided, so represent it by the name
     // of the 0 value. In many cases, that's "None".
     spv_operand_desc entry;
     if (SPV_SUCCESS == grammar_.lookupOperand(type, 0, &entry))
       stream_ << entry->name;
   }
 }

 spv_result_t Disassembler::SaveTextResult(spv_text* text_result) const {
   if (!print_) {
     size_t length = text_.str().size();
     char* str = new char[length + 1];
     if (!str) return SPV_ERROR_OUT_OF_MEMORY;
     strncpy(str, text_.str().c_str(), length + 1);
     spv_text text = new spv_text_t();
     if (!text) {
       delete[] str;
       return SPV_ERROR_OUT_OF_MEMORY;
     }
     text->str = str;
     text->length = length;
     *text_result = text;
   }
   return SPV_SUCCESS;
 }

 spv_result_t DisassembleHeader(void* user_data, spv_endianness_t endian,
                                uint32_t /* magic */, uint32_t version,
                                uint32_t generator, uint32_t id_bound,
                                uint32_t schema) {
   assert(user_data);
   auto disassembler = static_cast<Disassembler*>(user_data);
   return disassembler->HandleHeader(endian, version, generator, id_bound,
                                     schema);
 }

 spv_result_t DisassembleInstruction(
     void* user_data, const spv_parsed_instruction_t* parsed_instruction) {
   assert(user_data);
   auto disassembler = static_cast<Disassembler*>(user_data);
   return disassembler->HandleInstruction(*parsed_instruction);
 }

 // Simple wrapper class to provide extra data necessary for targeted
 // instruction disassembly.
 class WrappedDisassembler {
  public:
   WrappedDisassembler(Disassembler* dis, const uint32_t* binary, size_t wc)
       : disassembler_(dis), inst_binary_(binary), word_count_(wc) {}

   Disassembler* disassembler() { return disassembler_; }
   const uint32_t* inst_binary() const { return inst_binary_; }
   size_t word_count() const { return word_count_; }

  private:
   Disassembler* disassembler_;
   const uint32_t* inst_binary_;
   const size_t word_count_;
 };

 spv_result_t DisassembleTargetHeader(void* user_data, spv_endianness_t endian,
                                      uint32_t /* magic */, uint32_t version,
                                      uint32_t generator, uint32_t id_bound,
                                      uint32_t schema) {
   assert(user_data);
   auto wrapped = static_cast<WrappedDisassembler*>(user_data);
   return wrapped->disassembler()->HandleHeader(endian, version, generator,
                                                id_bound, schema);
 }

 spv_result_t DisassembleTargetInstruction(
     void* user_data, const spv_parsed_instruction_t* parsed_instruction) {
   assert(user_data);
   auto wrapped = static_cast<WrappedDisassembler*>(user_data);
   // Check if this is the instruction we want to disassemble.
   if (wrapped->word_count() == parsed_instruction->num_words &&
       std::equal(wrapped->inst_binary(),
                  wrapped->inst_binary() + wrapped->word_count(),
                  parsed_instruction->words)) {
     // Found the target instruction. Disassemble it and signal that we should
     // stop searching so we don't output the same instruction again.
     if (auto error =
             wrapped->disassembler()->HandleInstruction(*parsed_instruction))
       return error;
     return SPV_REQUESTED_TERMINATION;
   }
   return SPV_SUCCESS;
 }

 }  // namespace

 spv_result_t spvBinaryToText(const spv_const_context context,
                              const uint32_t* code, const size_t wordCount,
                              const uint32_t options, spv_text* pText,
                              spv_diagnostic* pDiagnostic) {
   spv_context_t hijack_context = *context;
   if (pDiagnostic) {
     *pDiagnostic = nullptr;
     spvtools::UseDiagnosticAsMessageConsumer(&hijack_context, pDiagnostic);
   }

   const spvtools::AssemblyGrammar grammar(&hijack_context);
   if (!grammar.isValid()) return SPV_ERROR_INVALID_TABLE;

   // Generate friendly names for Ids if requested.
   std::unique_ptr<spvtools::FriendlyNameMapper> friendly_mapper;
   spvtools::NameMapper name_mapper = spvtools::GetTrivialNameMapper();
   if (options & SPV_BINARY_TO_TEXT_OPTION_FRIENDLY_NAMES) {
     friendly_mapper = spvtools::MakeUnique<spvtools::FriendlyNameMapper>(
         &hijack_context, code, wordCount);
     name_mapper = friendly_mapper->GetNameMapper();
   }

   // Now disassemble!
   Disassembler disassembler(grammar, options, name_mapper);
   if (auto error = spvBinaryParse(&hijack_context, &disassembler, code,
                                   wordCount, DisassembleHeader,
                                   DisassembleInstruction, pDiagnostic)) {
     return error;
   }

   return disassembler.SaveTextResult(pText);
 }

 std::string spvtools::spvInstructionBinaryToText(const spv_target_env env,
                                                  const uint32_t* instCode,
                                                  const size_t instWordCount,
                                                  const uint32_t* code,
                                                  const size_t wordCount,
                                                  const uint32_t options) {
   spv_context context = spvContextCreate(env);
   const spvtools::AssemblyGrammar grammar(context);
   if (!grammar.isValid()) {
     spvContextDestroy(context);
     return "";
   }

   // Generate friendly names for Ids if requested.
   std::unique_ptr<spvtools::FriendlyNameMapper> friendly_mapper;
   spvtools::NameMapper name_mapper = spvtools::GetTrivialNameMapper();
   if (options & SPV_BINARY_TO_TEXT_OPTION_FRIENDLY_NAMES) {
     friendly_mapper = spvtools::MakeUnique<spvtools::FriendlyNameMapper>(
         context, code, wordCount);
     name_mapper = friendly_mapper->GetNameMapper();
   }

   // Now disassemble!
   Disassembler disassembler(grammar, options, name_mapper);
   WrappedDisassembler wrapped(&disassembler, instCode, instWordCount);
   spvBinaryParse(context, &wrapped, code, wordCount, DisassembleTargetHeader,
                  DisassembleTargetInstruction, nullptr);

   spv_text text = nullptr;
   std::string output;
   if (disassembler.SaveTextResult(&text) == SPV_SUCCESS) {
     output.assign(text->str, text->str + text->length);
     // Drop trailing newline characters.
     while (!output.empty() && output.back() == '\n') output.pop_back();
   }
   spvTextDestroy(text);
   spvContextDestroy(context);

   return output;
 }
	// Copyright (c) 2015-2020 The Khronos Group Inc.
	// Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights
	// reserved.
	//
	// Licensed under the Apache License, Version 2.0 (the "License");
	// you may not use this file except in compliance with the License.
	// You may obtain a copy of the License at
	//
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS,
	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	// See the License for the specific language governing permissions and
	// limitations under the License.

	// This file contains a disassembler: It converts a SPIR-V binary
	// to text.

	#include <algorithm>
	#include <cassert>
	#include <cstring>
	#include <iomanip>
	#include <memory>
	#include <unordered_map>
	#include <utility>

	#include "source/assembly_grammar.h"
	#include "source/binary.h"
	#include "source/diagnostic.h"
	#include "source/disassemble.h"
	#include "source/ext_inst.h"
	#include "source/name_mapper.h"
	#include "source/opcode.h"
	#include "source/parsed_operand.h"
	#include "source/print.h"
	#include "source/spirv_constant.h"
	#include "source/spirv_endian.h"
	#include "source/util/hex_float.h"
	#include "source/util/make_unique.h"
	#include "spirv-tools/libspirv.h"

	namespace {

	// A Disassembler instance converts a SPIR-V binary to its assembly
	// representation.
	class Disassembler {
	public:
	Disassembler(const spvtools::AssemblyGrammar& grammar, uint32_t options,
	spvtools::NameMapper name_mapper)
	: grammar_(grammar),
	print_(spvIsInBitfield(SPV_BINARY_TO_TEXT_OPTION_PRINT, options)),
	color_(spvIsInBitfield(SPV_BINARY_TO_TEXT_OPTION_COLOR, options)),
	indent_(spvIsInBitfield(SPV_BINARY_TO_TEXT_OPTION_INDENT, options)
	? kStandardIndent
	: 0),
	text_(),
	out_(print_ ? out_stream() : out_stream(text_)),
	stream_(out_.get()),
	header_(!spvIsInBitfield(SPV_BINARY_TO_TEXT_OPTION_NO_HEADER, options)),
	show_byte_offset_(spvIsInBitfield(
	SPV_BINARY_TO_TEXT_OPTION_SHOW_BYTE_OFFSET, options)),
	byte_offset_(0),
	name_mapper_(std::move(name_mapper)) {}

	// Emits the assembly header for the module, and sets up internal state
	// so subsequent callbacks can handle the cases where the entire module
	// is either big-endian or little-endian.
	spv_result_t HandleHeader(spv_endianness_t endian, uint32_t version,
	uint32_t generator, uint32_t id_bound,
	uint32_t schema);
	// Emits the assembly text for the given instruction.
	spv_result_t HandleInstruction(const spv_parsed_instruction_t& inst);

	// If not printing, populates text_result with the accumulated text.
	// Returns SPV_SUCCESS on success.
	spv_result_t SaveTextResult(spv_text* text_result) const;

	private:
	enum { kStandardIndent = 15 };

	using out_stream = spvtools::out_stream;

	// Emits an operand for the given instruction, where the instruction
	// is at offset words from the start of the binary.
	void EmitOperand(const spv_parsed_instruction_t& inst,
	const uint16_t operand_index);

	// Emits a mask expression for the given mask word of the specified type.
	void EmitMaskOperand(const spv_operand_type_t type, const uint32_t word);

	// Resets the output color, if color is turned on.
	void ResetColor() {
	if (color_) out_.get() << spvtools::clr::reset{print_};
	}
	// Sets the output to grey, if color is turned on.
	void SetGrey() {
	if (color_) out_.get() << spvtools::clr::grey{print_};
	}
	// Sets the output to blue, if color is turned on.
	void SetBlue() {
	if (color_) out_.get() << spvtools::clr::blue{print_};
	}
	// Sets the output to yellow, if color is turned on.
	void SetYellow() {
	if (color_) out_.get() << spvtools::clr::yellow{print_};
	}
	// Sets the output to red, if color is turned on.
	void SetRed() {
	if (color_) out_.get() << spvtools::clr::red{print_};
	}
	// Sets the output to green, if color is turned on.
	void SetGreen() {
	if (color_) out_.get() << spvtools::clr::green{print_};
	}

	const spvtools::AssemblyGrammar& grammar_;
	const bool print_; // Should we also print to the standard output stream?
	const bool color_; // Should we print in colour?
	const int indent_; // How much to indent. 0 means don't indent
	spv_endianness_t endian_; // The detected endianness of the binary.
	std::stringstream text_; // Captures the text, if not printing.
	out_stream out_; // The Output stream. Either to text_ or standard output.
	std::ostream& stream_; // The output std::stream.
	const bool header_; // Should we output header as the leading comment?
	const bool show_byte_offset_; // Should we print byte offset, in hex?
	size_t byte_offset_; // The number of bytes processed so far.
	spvtools::NameMapper name_mapper_;
	};

	spv_result_t Disassembler::HandleHeader(spv_endianness_t endian,
	uint32_t version, uint32_t generator,
	uint32_t id_bound, uint32_t schema) {
	endian_ = endian;

	if (header_) {
	SetGrey();
	const char* generator_tool =
	spvGeneratorStr(SPV_GENERATOR_TOOL_PART(generator));
	stream_ << "; SPIR-V\n"
	<< "; Version: " << SPV_SPIRV_VERSION_MAJOR_PART(version) << "."
	<< SPV_SPIRV_VERSION_MINOR_PART(version) << "\n"
	<< "; Generator: " << generator_tool;
	// For unknown tools, print the numeric tool value.
	if (0 == strcmp("Unknown", generator_tool)) {
	stream_ << "(" << SPV_GENERATOR_TOOL_PART(generator) << ")";
	}
	// Print the miscellaneous part of the generator word on the same
	// line as the tool name.
	stream_ << "; " << SPV_GENERATOR_MISC_PART(generator) << "\n"
	<< "; Bound: " << id_bound << "\n"
	<< "; Schema: " << schema << "\n";
	ResetColor();
	}

	byte_offset_ = SPV_INDEX_INSTRUCTION * sizeof(uint32_t);

	return SPV_SUCCESS;
	}

	spv_result_t Disassembler::HandleInstruction(
	const spv_parsed_instruction_t& inst) {
	if (inst.result_id) {
	SetBlue();
	const std::string id_name = name_mapper_(inst.result_id);
	if (indent_)
	stream_ << std::setw(std::max(0, indent_ - 3 - int(id_name.size())));
	stream_ << "%" << id_name;
	ResetColor();
	stream_ << " = ";
	} else {
	stream_ << std::string(indent_, ' ');
	}

	stream_ << "Op" << spvOpcodeString(static_cast<SpvOp>(inst.opcode));

	for (uint16_t i = 0; i < inst.num_operands; i++) {
	const spv_operand_type_t type = inst.operands[i].type;
	assert(type != SPV_OPERAND_TYPE_NONE);
	if (type == SPV_OPERAND_TYPE_RESULT_ID) continue;
	stream_ << " ";
	EmitOperand(inst, i);
	}

	if (show_byte_offset_) {
	SetGrey();
	auto saved_flags = stream_.flags();
	auto saved_fill = stream_.fill();
	stream_ << " ; 0x" << std::setw(8) << std::hex << std::setfill('0')
	<< byte_offset_;
	stream_.flags(saved_flags);
	stream_.fill(saved_fill);
	ResetColor();
	}

	byte_offset_ += inst.num_words * sizeof(uint32_t);

	stream_ << "\n";
	return SPV_SUCCESS;
	}

	void Disassembler::EmitOperand(const spv_parsed_instruction_t& inst,
	const uint16_t operand_index) {
	assert(operand_index < inst.num_operands);
	const spv_parsed_operand_t& operand = inst.operands[operand_index];
	const uint32_t word = inst.words[operand.offset];
	switch (operand.type) {
	case SPV_OPERAND_TYPE_RESULT_ID:
	assert(false && "<result-id> is not supposed to be handled here");
	SetBlue();
	stream_ << "%" << name_mapper_(word);
	break;
	case SPV_OPERAND_TYPE_ID:
	case SPV_OPERAND_TYPE_TYPE_ID:
	case SPV_OPERAND_TYPE_SCOPE_ID:
	case SPV_OPERAND_TYPE_MEMORY_SEMANTICS_ID:
	SetYellow();
	stream_ << "%" << name_mapper_(word);
	break;
	case SPV_OPERAND_TYPE_EXTENSION_INSTRUCTION_NUMBER: {
	spv_ext_inst_desc ext_inst;
	SetRed();
	if (grammar_.lookupExtInst(inst.ext_inst_type, word, &ext_inst) ==
	SPV_SUCCESS) {
	stream_ << ext_inst->name;
	} else {
	if (!spvExtInstIsNonSemantic(inst.ext_inst_type)) {
	assert(false && "should have caught this earlier");
	} else {
	// for non-semantic instruction sets we can just print the number
	stream_ << word;
	}
	}
	} break;
	case SPV_OPERAND_TYPE_SPEC_CONSTANT_OP_NUMBER: {
	spv_opcode_desc opcode_desc;
	if (grammar_.lookupOpcode(SpvOp(word), &opcode_desc))
	assert(false && "should have caught this earlier");
	SetRed();
	stream_ << opcode_desc->name;
	} break;
	case SPV_OPERAND_TYPE_LITERAL_INTEGER:
	case SPV_OPERAND_TYPE_TYPED_LITERAL_NUMBER: {
	SetRed();
	spvtools::EmitNumericLiteral(&stream_, inst, operand);
	ResetColor();
	} break;
	case SPV_OPERAND_TYPE_LITERAL_STRING: {
	stream_ << "\"";
	SetGreen();
	// Strings are always little-endian, and null-terminated.
	// Write out the characters, escaping as needed, and without copying
	// the entire string.
	auto c_str = reinterpret_cast<const char*>(inst.words + operand.offset);
	for (auto p = c_str; *p; ++p) {
	if (p == '"' \|\| p == '\\') stream_ << '\\';
	stream_ << *p;
	}
	ResetColor();
	stream_ << '"';
	} break;
	case SPV_OPERAND_TYPE_CAPABILITY:
	case SPV_OPERAND_TYPE_SOURCE_LANGUAGE:
	case SPV_OPERAND_TYPE_EXECUTION_MODEL:
	case SPV_OPERAND_TYPE_ADDRESSING_MODEL:
	case SPV_OPERAND_TYPE_MEMORY_MODEL:
	case SPV_OPERAND_TYPE_EXECUTION_MODE:
	case SPV_OPERAND_TYPE_STORAGE_CLASS:
	case SPV_OPERAND_TYPE_DIMENSIONALITY:
	case SPV_OPERAND_TYPE_SAMPLER_ADDRESSING_MODE:
	case SPV_OPERAND_TYPE_SAMPLER_FILTER_MODE:
	case SPV_OPERAND_TYPE_SAMPLER_IMAGE_FORMAT:
	case SPV_OPERAND_TYPE_FP_ROUNDING_MODE:
	case SPV_OPERAND_TYPE_LINKAGE_TYPE:
	case SPV_OPERAND_TYPE_ACCESS_QUALIFIER:
	case SPV_OPERAND_TYPE_FUNCTION_PARAMETER_ATTRIBUTE:
	case SPV_OPERAND_TYPE_DECORATION:
	case SPV_OPERAND_TYPE_BUILT_IN:
	case SPV_OPERAND_TYPE_GROUP_OPERATION:
	case SPV_OPERAND_TYPE_KERNEL_ENQ_FLAGS:
	case SPV_OPERAND_TYPE_KERNEL_PROFILING_INFO:
	case SPV_OPERAND_TYPE_RAY_FLAGS:
	case SPV_OPERAND_TYPE_RAY_QUERY_INTERSECTION:
	case SPV_OPERAND_TYPE_RAY_QUERY_COMMITTED_INTERSECTION_TYPE:
	case SPV_OPERAND_TYPE_RAY_QUERY_CANDIDATE_INTERSECTION_TYPE:
	case SPV_OPERAND_TYPE_DEBUG_BASE_TYPE_ATTRIBUTE_ENCODING:
	case SPV_OPERAND_TYPE_DEBUG_COMPOSITE_TYPE:
	case SPV_OPERAND_TYPE_DEBUG_TYPE_QUALIFIER:
	case SPV_OPERAND_TYPE_DEBUG_OPERATION:
	case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_BASE_TYPE_ATTRIBUTE_ENCODING:
	case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_COMPOSITE_TYPE:
	case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_TYPE_QUALIFIER:
	case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_OPERATION:
	case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_IMPORTED_ENTITY: {
	spv_operand_desc entry;
	if (grammar_.lookupOperand(operand.type, word, &entry))
	assert(false && "should have caught this earlier");
	stream_ << entry->name;
	} break;
	case SPV_OPERAND_TYPE_FP_FAST_MATH_MODE:
	case SPV_OPERAND_TYPE_FUNCTION_CONTROL:
	case SPV_OPERAND_TYPE_LOOP_CONTROL:
	case SPV_OPERAND_TYPE_IMAGE:
	case SPV_OPERAND_TYPE_MEMORY_ACCESS:
	case SPV_OPERAND_TYPE_SELECTION_CONTROL:
	case SPV_OPERAND_TYPE_DEBUG_INFO_FLAGS:
	case SPV_OPERAND_TYPE_CLDEBUG100_DEBUG_INFO_FLAGS:
	EmitMaskOperand(operand.type, word);
	break;
	default:
	assert(false && "unhandled or invalid case");
	}
	ResetColor();
	}

	void Disassembler::EmitMaskOperand(const spv_operand_type_t type,
	const uint32_t word) {
	// Scan the mask from least significant bit to most significant bit. For each
	// set bit, emit the name of that bit. Separate multiple names with '\|'.
	uint32_t remaining_word = word;
	uint32_t mask;
	int num_emitted = 0;
	for (mask = 1; remaining_word; mask <<= 1) {
	if (remaining_word & mask) {
	remaining_word ^= mask;
	spv_operand_desc entry;
	if (grammar_.lookupOperand(type, mask, &entry))
	assert(false && "should have caught this earlier");
	if (num_emitted) stream_ << "\|";
	stream_ << entry->name;
	num_emitted++;
	}
	}
	if (!num_emitted) {
	// An operand value of 0 was provided, so represent it by the name
	// of the 0 value. In many cases, that's "None".
	spv_operand_desc entry;
	if (SPV_SUCCESS == grammar_.lookupOperand(type, 0, &entry))
	stream_ << entry->name;
	}
	}

	spv_result_t Disassembler::SaveTextResult(spv_text* text_result) const {
	if (!print_) {
	size_t length = text_.str().size();
	char* str = new char[length + 1];
	if (!str) return SPV_ERROR_OUT_OF_MEMORY;
	strncpy(str, text_.str().c_str(), length + 1);
	spv_text text = new spv_text_t();
	if (!text) {
	delete[] str;
	return SPV_ERROR_OUT_OF_MEMORY;
	}
	text->str = str;
	text->length = length;
	*text_result = text;
	}
	return SPV_SUCCESS;
	}

	spv_result_t DisassembleHeader(void* user_data, spv_endianness_t endian,
	uint32_t /* magic */, uint32_t version,
	uint32_t generator, uint32_t id_bound,
	uint32_t schema) {
	assert(user_data);
	auto disassembler = static_cast<Disassembler*>(user_data);
	return disassembler->HandleHeader(endian, version, generator, id_bound,
	schema);
	}

	spv_result_t DisassembleInstruction(
	void* user_data, const spv_parsed_instruction_t* parsed_instruction) {
	assert(user_data);
	auto disassembler = static_cast<Disassembler*>(user_data);
	return disassembler->HandleInstruction(*parsed_instruction);
	}

	// Simple wrapper class to provide extra data necessary for targeted
	// instruction disassembly.
	class WrappedDisassembler {
	public:
	WrappedDisassembler(Disassembler* dis, const uint32_t* binary, size_t wc)
	: disassembler_(dis), inst_binary_(binary), word_count_(wc) {}

	Disassembler* disassembler() { return disassembler_; }
	const uint32_t* inst_binary() const { return inst_binary_; }
	size_t word_count() const { return word_count_; }

	private:
	Disassembler* disassembler_;
	const uint32_t* inst_binary_;
	const size_t word_count_;
	};

	spv_result_t DisassembleTargetHeader(void* user_data, spv_endianness_t endian,
	uint32_t /* magic */, uint32_t version,
	uint32_t generator, uint32_t id_bound,
	uint32_t schema) {
	assert(user_data);
	auto wrapped = static_cast<WrappedDisassembler*>(user_data);
	return wrapped->disassembler()->HandleHeader(endian, version, generator,
	id_bound, schema);
	}

	spv_result_t DisassembleTargetInstruction(
	void* user_data, const spv_parsed_instruction_t* parsed_instruction) {
	assert(user_data);
	auto wrapped = static_cast<WrappedDisassembler*>(user_data);
	// Check if this is the instruction we want to disassemble.
	if (wrapped->word_count() == parsed_instruction->num_words &&
	std::equal(wrapped->inst_binary(),
	wrapped->inst_binary() + wrapped->word_count(),
	parsed_instruction->words)) {
	// Found the target instruction. Disassemble it and signal that we should
	// stop searching so we don't output the same instruction again.
	if (auto error =
	wrapped->disassembler()->HandleInstruction(*parsed_instruction))
	return error;
	return SPV_REQUESTED_TERMINATION;
	}
	return SPV_SUCCESS;
	}

	} // namespace

	spv_result_t spvBinaryToText(const spv_const_context context,
	const uint32_t* code, const size_t wordCount,
	const uint32_t options, spv_text* pText,
	spv_diagnostic* pDiagnostic) {
	spv_context_t hijack_context = *context;
	if (pDiagnostic) {
	*pDiagnostic = nullptr;
	spvtools::UseDiagnosticAsMessageConsumer(&hijack_context, pDiagnostic);
	}

	const spvtools::AssemblyGrammar grammar(&hijack_context);
	if (!grammar.isValid()) return SPV_ERROR_INVALID_TABLE;

	// Generate friendly names for Ids if requested.
	std::unique_ptr<spvtools::FriendlyNameMapper> friendly_mapper;
	spvtools::NameMapper name_mapper = spvtools::GetTrivialNameMapper();
	if (options & SPV_BINARY_TO_TEXT_OPTION_FRIENDLY_NAMES) {
	friendly_mapper = spvtools::MakeUnique<spvtools::FriendlyNameMapper>(
	&hijack_context, code, wordCount);
	name_mapper = friendly_mapper->GetNameMapper();
	}

	// Now disassemble!
	Disassembler disassembler(grammar, options, name_mapper);
	if (auto error = spvBinaryParse(&hijack_context, &disassembler, code,
	wordCount, DisassembleHeader,
	DisassembleInstruction, pDiagnostic)) {
	return error;
	}

	return disassembler.SaveTextResult(pText);
	}

	std::string spvtools::spvInstructionBinaryToText(const spv_target_env env,
	const uint32_t* instCode,
	const size_t instWordCount,
	const uint32_t* code,
	const size_t wordCount,
	const uint32_t options) {
	spv_context context = spvContextCreate(env);
	const spvtools::AssemblyGrammar grammar(context);
	if (!grammar.isValid()) {
	spvContextDestroy(context);
	return "";
	}

	// Generate friendly names for Ids if requested.
	std::unique_ptr<spvtools::FriendlyNameMapper> friendly_mapper;
	spvtools::NameMapper name_mapper = spvtools::GetTrivialNameMapper();
	if (options & SPV_BINARY_TO_TEXT_OPTION_FRIENDLY_NAMES) {
	friendly_mapper = spvtools::MakeUnique<spvtools::FriendlyNameMapper>(
	context, code, wordCount);
	name_mapper = friendly_mapper->GetNameMapper();
	}

	// Now disassemble!
	Disassembler disassembler(grammar, options, name_mapper);
	WrappedDisassembler wrapped(&disassembler, instCode, instWordCount);
	spvBinaryParse(context, &wrapped, code, wordCount, DisassembleTargetHeader,
	DisassembleTargetInstruction, nullptr);

	spv_text text = nullptr;
	std::string output;
	if (disassembler.SaveTextResult(&text) == SPV_SUCCESS) {
	output.assign(text->str, text->str + text->length);
	// Drop trailing newline characters.
	while (!output.empty() && output.back() == '\n') output.pop_back();
	}
	spvTextDestroy(text);
	spvContextDestroy(context);

	return output;
	}