blob: b520a1ea91aff7eeae0882682a8e68dc49f1b392 [file] [log] [blame]
// Copyright (c) 2018 Google Inc.
// 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
#include <iosfwd>
#include <string>
#include "source/name_mapper.h"
#include "spirv-tools/libspirv.h"
namespace spvtools {
// Decodes the given SPIR-V instruction binary representation to its assembly
// text. The context is inferred from the provided module binary. The options
// parameter is a bit field of spv_binary_to_text_options_t (note: the option
// SPV_BINARY_TO_TEXT_OPTION_PRINT will be ignored). Decoded text will be
// stored into *text. Any error will be written into *diagnostic if diagnostic
// is non-null.
std::string spvInstructionBinaryToText(const spv_target_env env,
const uint32_t* inst_binary,
const size_t inst_word_count,
const uint32_t* binary,
const size_t word_count,
const uint32_t options);
class AssemblyGrammar;
namespace disassemble {
// Shared code with other tools (than the disassembler) that might need to
// output disassembly. An InstructionDisassembler instance converts SPIR-V
// binary for an instruction to its assembly representation.
class InstructionDisassembler {
InstructionDisassembler(const AssemblyGrammar& grammar, std::ostream& stream,
uint32_t options, NameMapper name_mapper);
// Emits the assembly header for the module.
void EmitHeaderSpirv();
void EmitHeaderVersion(uint32_t version);
void EmitHeaderGenerator(uint32_t generator);
void EmitHeaderIdBound(uint32_t id_bound);
void EmitHeaderSchema(uint32_t schema);
// Emits the assembly text for the given instruction.
void EmitInstruction(const spv_parsed_instruction_t& inst,
size_t inst_byte_offset);
// Emits a comment between different sections of the module.
void EmitSectionComment(const spv_parsed_instruction_t& inst,
bool& inserted_decoration_space,
bool& inserted_debug_space,
bool& inserted_type_space);
// Resets the output color, if color is turned on.
void ResetColor();
// Set the output color, if color is turned on.
void SetGrey();
void SetBlue();
void SetYellow();
void SetRed();
void SetGreen();
// 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);
const spvtools::AssemblyGrammar& grammar_;
std::ostream& stream_;
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
const int comment_; // Should we comment the source
const bool show_byte_offset_; // Should we print byte offset, in hex?
spvtools::NameMapper name_mapper_;
} // namespace disassemble
} // namespace spvtools