SPIRV-Tools/source/val/instruction.h
Marius Hillenbrand 1ed847f438
Fix endianness of string literals (#4622)
* Fix endianness of string literals

To get correct and consistent encoding and decoding of string literals
on big-endian platforms, use spvtools::utils::MakeString and MakeVector
(or wrapper functions) consistently for handling string literals.

- add variant of MakeVector that encodes a string literal into an
  existing vector of words
- add variants of MakeString
- add a wrapper spvDecodeLiteralStringOperand in source/
- fix wrapper Operand::AsString to use MakeString (source/opt)
- remove Operand::AsCString as broken and unused
- add a variant of GetOperandAs for string literals (source/val)
... and apply those wrappers throughout the code.

Fixes  #149

* Extend round trip test for StringLiterals to flip word order

In the encoding/decoding roundtrip tests for string literals, include
a case that flips byte order in words after encoding and then checks for
successful decoding. That is, on a little-endian host flip to big-endian
byte order and then decode, and vice versa.

* BinaryParseTest.InstructionWithStringOperand: also flip byte order

Test binary parsing of string operands both with the host's and with the
reversed byte order.
2021-12-08 12:01:26 -05:00

156 lines
5.2 KiB
C++

// Copyright (c) 2015-2016 The Khronos Group 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
//
// 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.
#ifndef SOURCE_VAL_INSTRUCTION_H_
#define SOURCE_VAL_INSTRUCTION_H_
#include <cassert>
#include <cstdint>
#include <functional>
#include <utility>
#include <vector>
#include "source/ext_inst.h"
#include "source/table.h"
#include "spirv-tools/libspirv.h"
namespace spvtools {
namespace val {
class BasicBlock;
class Function;
/// Wraps the spv_parsed_instruction struct along with use and definition of the
/// instruction's result id
class Instruction {
public:
explicit Instruction(const spv_parsed_instruction_t* inst);
/// Registers the use of the Instruction in instruction \p inst at \p index
void RegisterUse(const Instruction* inst, uint32_t index);
uint32_t id() const { return inst_.result_id; }
uint32_t type_id() const { return inst_.type_id; }
SpvOp opcode() const { return static_cast<SpvOp>(inst_.opcode); }
/// Returns the Function where the instruction was defined. nullptr if it was
/// defined outside of a Function
const Function* function() const { return function_; }
void set_function(Function* func) { function_ = func; }
/// Returns the BasicBlock where the instruction was defined. nullptr if it
/// was defined outside of a BasicBlock
const BasicBlock* block() const { return block_; }
void set_block(BasicBlock* b) { block_ = b; }
/// Returns a vector of pairs of all references to this instruction's result
/// id. The first element is the instruction in which this result id was
/// referenced and the second is the index of the word in that instruction
/// where this result id appeared
const std::vector<std::pair<const Instruction*, uint32_t>>& uses() const {
return uses_;
}
/// The word used to define the Instruction
uint32_t word(size_t index) const { return words_[index]; }
/// The words used to define the Instruction
const std::vector<uint32_t>& words() const { return words_; }
/// Returns the operand at |idx|.
const spv_parsed_operand_t& operand(size_t idx) const {
return operands_[idx];
}
/// The operands of the Instruction
const std::vector<spv_parsed_operand_t>& operands() const {
return operands_;
}
/// Provides direct access to the stored C instruction object.
const spv_parsed_instruction_t& c_inst() const { return inst_; }
/// Provides direct access to instructions spv_ext_inst_type_t object.
const spv_ext_inst_type_t& ext_inst_type() const {
return inst_.ext_inst_type;
}
bool IsNonSemantic() const {
return opcode() == SpvOp::SpvOpExtInst &&
spvExtInstIsNonSemantic(inst_.ext_inst_type);
}
/// True if this is an OpExtInst for debug info extension.
bool IsDebugInfo() const {
return opcode() == SpvOp::SpvOpExtInst &&
spvExtInstIsDebugInfo(inst_.ext_inst_type);
}
// Casts the words belonging to the operand under |index| to |T| and returns.
template <typename T>
T GetOperandAs(size_t index) const {
const spv_parsed_operand_t& o = operands_.at(index);
assert(o.num_words * 4 >= sizeof(T));
assert(o.offset + o.num_words <= inst_.num_words);
return *reinterpret_cast<const T*>(&words_[o.offset]);
}
size_t LineNum() const { return line_num_; }
void SetLineNum(size_t pos) { line_num_ = pos; }
private:
const std::vector<uint32_t> words_;
const std::vector<spv_parsed_operand_t> operands_;
spv_parsed_instruction_t inst_;
size_t line_num_ = 0;
/// The function in which this instruction was declared
Function* function_ = nullptr;
/// The basic block in which this instruction was declared
BasicBlock* block_ = nullptr;
/// This is a vector of pairs of all references to this instruction's result
/// id. The first element is the instruction in which this result id was
/// referenced and the second is the index of the word in the referencing
/// instruction where this instruction appeared
std::vector<std::pair<const Instruction*, uint32_t>> uses_;
};
bool operator<(const Instruction& lhs, const Instruction& rhs);
bool operator<(const Instruction& lhs, uint32_t rhs);
bool operator==(const Instruction& lhs, const Instruction& rhs);
bool operator==(const Instruction& lhs, uint32_t rhs);
template <>
std::string Instruction::GetOperandAs<std::string>(size_t index) const;
} // namespace val
} // namespace spvtools
// custom specialization of std::hash for Instruction
namespace std {
template <>
struct hash<spvtools::val::Instruction> {
typedef spvtools::val::Instruction argument_type;
typedef std::size_t result_type;
result_type operator()(const argument_type& inst) const {
return hash<uint32_t>()(inst.id());
}
};
} // namespace std
#endif // SOURCE_VAL_INSTRUCTION_H_