AuroraMiddleware/SPIRV-Tools
1
0
Fork 0
mirror of https://github.com/KhronosGroup/SPIRV-Tools synced 2024-11-27 05:40:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
a35919c008
SPIRV-Tools/test/BinaryParse.cpp

768 lines
36 KiB
C++
Raw Normal View History

Extend copyright to 2016.
2016-01-07 18:44:22 +00:00
// Copyright (c) 2015-2016 The Khronos Group Inc.
Refactor the binary parser. The binary parser has a C API, described in binary.h. Eventually we will make it public in libspirv.h. The API is event-driven in the sense that a callback is called when a valid header is parsed, and for each parsed instruction. Classify some operand types as "concrete". The binary parser uses only concrete operand types to describe parsed instructions. The old disassembler APIs are moved into disassemble.cpp TODO: Add unit tests for spvBinaryParse.
2015-10-30 20:06:15 +00:00
//
Relicense SPIRV-Tools under Apache 2.0 Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/383 Finalize v2016.4
2016-09-01 19:33:59 +00:00
// 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
Refactor the binary parser. The binary parser has a C API, described in binary.h. Eventually we will make it public in libspirv.h. The API is event-driven in the sense that a callback is called when a valid header is parsed, and for each parsed instruction. Classify some operand types as "concrete". The binary parser uses only concrete operand types to describe parsed instructions. The old disassembler APIs are moved into disassemble.cpp TODO: Add unit tests for spvBinaryParse.
2015-10-30 20:06:15 +00:00
//
Relicense SPIRV-Tools under Apache 2.0 Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/383 Finalize v2016.4
2016-09-01 19:33:59 +00:00
// http://www.apache.org/licenses/LICENSE-2.0
Refactor the binary parser. The binary parser has a C API, described in binary.h. Eventually we will make it public in libspirv.h. The API is event-driven in the sense that a callback is called when a valid header is parsed, and for each parsed instruction. Classify some operand types as "concrete". The binary parser uses only concrete operand types to describe parsed instructions. The old disassembler APIs are moved into disassemble.cpp TODO: Add unit tests for spvBinaryParse.
2015-10-30 20:06:15 +00:00
//
Relicense SPIRV-Tools under Apache 2.0 Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/383 Finalize v2016.4
2016-09-01 19:33:59 +00:00
// 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.
Refactor the binary parser. The binary parser has a C API, described in binary.h. Eventually we will make it public in libspirv.h. The API is event-driven in the sense that a callback is called when a valid header is parsed, and for each parsed instruction. Classify some operand types as "concrete". The binary parser uses only concrete operand types to describe parsed instructions. The old disassembler APIs are moved into disassemble.cpp TODO: Add unit tests for spvBinaryParse.
2015-10-30 20:06:15 +00:00
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
#include <sstream>
#include <string>
#include <vector>
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
#include "TestFixture.h"
#include "UnitSPIRV.h"
Remove dependency on SPIR-V headers in libspirv.h. For fulfilling this purpose, the |opcode| field in the |spv_parsed_instruction_t| struct is changed to of type uint16_t. Also add functions to query the information of a given SPIR-V target environment.
2016-03-31 21:26:31 +00:00
#include "gmock/gmock.h"
Use SPIR-V headers from the KhronosGroup/SPIRV-Headers repo.
2016-04-14 18:05:53 +00:00
#include "spirv/1.0/OpenCL.std.h"
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
// Returns true if two spv_parsed_operand_t values are equal.
// To use this operator, this definition must appear in the same namespace
// as spv_parsed_operand_t.
static bool operator==(const spv_parsed_operand_t& a,
const spv_parsed_operand_t& b) {
return a.offset == b.offset && a.num_words == b.num_words &&
a.type == b.type && a.number_kind == b.number_kind &&
a.number_bit_width == b.number_bit_width;
}
Refactor the binary parser. The binary parser has a C API, described in binary.h. Eventually we will make it public in libspirv.h. The API is event-driven in the sense that a callback is called when a valid header is parsed, and for each parsed instruction. Classify some operand types as "concrete". The binary parser uses only concrete operand types to describe parsed instructions. The old disassembler APIs are moved into disassemble.cpp TODO: Add unit tests for spvBinaryParse.
2015-10-30 20:06:15 +00:00
namespace {
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
using ::spvtest::Concatenate;
using ::spvtest::MakeInstruction;
using ::spvtest::MakeVector;
Add tests for SubgroupDispatch. Introduced in v1.1, SubgroupDispatch adds the following: - two new execution modes - one new capability - two new opcodes Extend ValidateBase methods to take a spv_target_env. Replace the context_ member with ScopedContext inside the said methods. Give ScopedContext wider visibility by moving it outside TextToBinaryTestBase.
2016-04-21 19:46:08 +00:00
using ::spvtest::ScopedContext;
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
using ::testing::AnyOf;
using ::testing::Eq;
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
using ::testing::InSequence;
using ::testing::Return;
using ::testing::_;
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
// An easily-constructible and comparable object for the contents of an
Mention that ParsedInstruction owns its components. Also close a parenthesis in ParsedInstruction printout.
2015-11-30 16:21:09 +00:00
// spv_parsed_instruction_t. Unlike spv_parsed_instruction_t, owns the memory
// of its components.
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
struct ParsedInstruction {
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
explicit ParsedInstruction(const spv_parsed_instruction_t& inst)
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
: words(inst.words, inst.words + inst.num_words),
Remove dependency on SPIR-V headers in libspirv.h. For fulfilling this purpose, the |opcode| field in the |spv_parsed_instruction_t| struct is changed to of type uint16_t. Also add functions to query the information of a given SPIR-V target environment.
2016-03-31 21:26:31 +00:00
opcode(static_cast<SpvOp>(inst.opcode)),
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
ext_inst_type(inst.ext_inst_type),
type_id(inst.type_id),
result_id(inst.result_id),
operands(inst.operands, inst.operands + inst.num_operands) {}
std::vector<uint32_t> words;
SpvOp opcode;
spv_ext_inst_type_t ext_inst_type;
uint32_t type_id;
uint32_t result_id;
std::vector<spv_parsed_operand_t> operands;
bool operator==(const ParsedInstruction& b) const {
return words == b.words && opcode == b.opcode &&
ext_inst_type == b.ext_inst_type && type_id == b.type_id &&
result_id == b.result_id && operands == b.operands;
}
};
// Prints a ParsedInstruction object to the given output stream, and returns
// the stream.
std::ostream& operator<<(std::ostream& os, const ParsedInstruction& inst) {
os << "\nParsedInstruction( {";
spvtest::PrintTo(spvtest::WordVector(inst.words), &os);
os << "}, opcode: " << int(inst.opcode)
<< " ext_inst_type: " << int(inst.ext_inst_type)
<< " type_id: " << inst.type_id << " result_id: " << inst.result_id;
for (const auto& operand : inst.operands) {
os << " { offset: " << operand.offset << " num_words: " << operand.num_words
<< " type: " << int(operand.type)
<< " number_kind: " << int(operand.number_kind)
<< " number_bit_width: " << int(operand.number_bit_width) << "}";
}
Mention that ParsedInstruction owns its components. Also close a parenthesis in ParsedInstruction printout.
2015-11-30 16:21:09 +00:00
os << ")";
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
return os;
}
// Sanity check for the equality operator on ParsedInstruction.
TEST(ParsedInstruction, ZeroInitializedAreEqual) {
spv_parsed_instruction_t pi = {};
ParsedInstruction a(pi);
ParsedInstruction b(pi);
EXPECT_THAT(a, ::testing::TypedEq<ParsedInstruction>(b));
}
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
// Googlemock class receiving Header/Instruction calls from spvBinaryParse().
class MockParseClient {
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
public:
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
MOCK_METHOD6(Header, spv_result_t(spv_endianness_t endian, uint32_t magic,
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
uint32_t version, uint32_t generator,
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
uint32_t id_bound, uint32_t reserved));
MOCK_METHOD1(Instruction, spv_result_t(const ParsedInstruction&));
};
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
// Casts user_data as MockParseClient and invokes its Header().
spv_result_t invoke_header(void* user_data, spv_endianness_t endian,
uint32_t magic, uint32_t version, uint32_t generator,
uint32_t id_bound, uint32_t reserved) {
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
return static_cast<MockParseClient*>(user_data)->Header(
endian, magic, version, generator, id_bound, reserved);
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
}
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
// Casts user_data as MockParseClient and invokes its Instruction().
spv_result_t invoke_instruction(
void* user_data, const spv_parsed_instruction_t* parsed_instruction) {
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
return static_cast<MockParseClient*>(user_data)->Instruction(
ParsedInstruction(*parsed_instruction));
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
}
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
// The SPIR-V module header words for the Khronos Assembler generator,
// for a module with an ID bound of 1.
const uint32_t kHeaderForBound1[] = {
SpvMagicNumber, SpvVersion,
SPV_GENERATOR_WORD(SPV_GENERATOR_KHRONOS_ASSEMBLER, 0), 1 /*bound*/,
0 /*schema*/};
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
// Returns the expected SPIR-V module header words for the Khronos
// Assembler generator, and with a given Id bound.
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
std::vector<uint32_t> ExpectedHeaderForBound(uint32_t bound) {
Add SPIR-V 1.1 grammar. Switch to SPIR-V 1.1 as default. Introduce SPV_ENV_UNIVERSAL_1_1. Add "1_0" to the internal variable names. Add spv_target_env to spv*GetTable().
2016-04-07 18:41:34 +00:00
return {SpvMagicNumber, 0x10000,
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
SPV_GENERATOR_WORD(SPV_GENERATOR_KHRONOS_ASSEMBLER, 0), bound, 0};
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
}
// Returns a parsed operand for a non-number value at the given word offset
// within an instruction.
spv_parsed_operand_t MakeSimpleOperand(uint16_t offset,
spv_operand_type_t type) {
return {offset, 1, type, SPV_NUMBER_NONE, 0};
}
// Returns a parsed operand for a literal unsigned integer value at the given
// word offset within an instruction.
spv_parsed_operand_t MakeLiteralNumberOperand(uint16_t offset) {
return {offset, 1, SPV_OPERAND_TYPE_LITERAL_INTEGER, SPV_NUMBER_UNSIGNED_INT,
32};
}
// Returns a parsed operand for a literal string value at the given
// word offset within an instruction.
spv_parsed_operand_t MakeLiteralStringOperand(uint16_t offset,
uint16_t length) {
return {offset, length, SPV_OPERAND_TYPE_LITERAL_STRING, SPV_NUMBER_NONE, 0};
}
// Returns a ParsedInstruction for an OpTypeVoid instruction that would
// generate the given result Id.
ParsedInstruction MakeParsedVoidTypeInstruction(uint32_t result_id) {
const auto void_inst = MakeInstruction(SpvOpTypeVoid, {result_id});
const auto void_operands = std::vector<spv_parsed_operand_t>{
MakeSimpleOperand(1, SPV_OPERAND_TYPE_RESULT_ID)};
const spv_parsed_instruction_t parsed_void_inst = {
void_inst.data(),
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
static_cast<uint16_t>(void_inst.size()),
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
SpvOpTypeVoid,
SPV_EXT_INST_TYPE_NONE,
0, // type id
result_id,
void_operands.data(),
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
static_cast<uint16_t>(void_operands.size())};
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
return ParsedInstruction(parsed_void_inst);
}
// Returns a ParsedInstruction for an OpTypeInt instruction that generates
// the given result Id for a 32-bit signed integer scalar type.
ParsedInstruction MakeParsedInt32TypeInstruction(uint32_t result_id) {
const auto i32_inst = MakeInstruction(SpvOpTypeInt, {result_id, 32, 1});
const auto i32_operands = std::vector<spv_parsed_operand_t>{
MakeSimpleOperand(1, SPV_OPERAND_TYPE_RESULT_ID),
MakeLiteralNumberOperand(2), MakeLiteralNumberOperand(3)};
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
spv_parsed_instruction_t parsed_i32_inst = {
i32_inst.data(),
static_cast<uint16_t>(i32_inst.size()),
SpvOpTypeInt,
SPV_EXT_INST_TYPE_NONE,
0, // type id
result_id,
i32_operands.data(),
static_cast<uint16_t>(i32_operands.size())};
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
return ParsedInstruction(parsed_i32_inst);
}
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
class BinaryParseTest : public spvtest::TextToBinaryTestBase<::testing::Test> {
protected:
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
void Parse(const SpirvVector& words, spv_result_t expected_result,
bool flip_words = false) {
SpirvVector flipped_words(words);
SCOPED_TRACE(flip_words ? "Flipped Endianness" : "Normal Endianness");
if (flip_words) {
std::transform(flipped_words.begin(), flipped_words.end(),
flipped_words.begin(), [](const uint32_t raw_word) {
return spvFixWord(raw_word,
I32_ENDIAN_HOST == I32_ENDIAN_BIG
? SPV_ENDIANNESS_LITTLE
: SPV_ENDIANNESS_BIG);
});
}
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
EXPECT_EQ(expected_result,
First tests for SPIR-V v1.1. Add test for named-barrier instructions and capability. Add spv_target_env as an optional argument to CompileSuccessfully() and CompileFailure(). Currently defaults to UNIVERSAL_1_0, though that could change in the future. Make spv_context a local variable in test methods instead of a TextToBinaryTestBase member. Introduce ScopedContext to make temp contexts easier.
2016-04-19 02:25:35 +00:00
spvBinaryParse(ScopedContext().context, &client_,
flipped_words.data(), flipped_words.size(),
invoke_header, invoke_instruction, &diagnostic_));
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
}
spv_diagnostic diagnostic_ = nullptr;
MockParseClient client_;
};
// Adds an EXPECT_CALL to client_->Header() with appropriate parameters,
// including bound. Returns the EXPECT_CALL result.
First tests for SPIR-V v1.1. Add test for named-barrier instructions and capability. Add spv_target_env as an optional argument to CompileSuccessfully() and CompileFailure(). Currently defaults to UNIVERSAL_1_0, though that could change in the future. Make spv_context a local variable in test methods instead of a TextToBinaryTestBase member. Introduce ScopedContext to make temp contexts easier.
2016-04-19 02:25:35 +00:00
#define EXPECT_HEADER(bound) \
EXPECT_CALL( \
client_, \
Header(AnyOf(SPV_ENDIANNESS_LITTLE, SPV_ENDIANNESS_BIG), SpvMagicNumber, \
0x10000, SPV_GENERATOR_WORD(SPV_GENERATOR_KHRONOS_ASSEMBLER, 0), \
bound, 0 /*reserved*/))
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
static const bool kSwapEndians[] = {false, true};
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
TEST_F(BinaryParseTest, EmptyModuleHasValidHeaderAndNoInstructionCallbacks) {
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
for (bool endian_swap : kSwapEndians) {
const auto words = CompileSuccessfully("");
EXPECT_HEADER(1).WillOnce(Return(SPV_SUCCESS));
EXPECT_CALL(client_, Instruction(_)).Times(0); // No instruction callback.
Parse(words, SPV_SUCCESS, endian_swap);
EXPECT_EQ(nullptr, diagnostic_);
}
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
}
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
TEST_F(BinaryParseTest,
ModuleWithSingleInstructionHasValidHeaderAndInstructionCallback) {
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
for (bool endian_swap : kSwapEndians) {
const auto words = CompileSuccessfully("%1 = OpTypeVoid");
InSequence calls_expected_in_specific_order;
EXPECT_HEADER(2).WillOnce(Return(SPV_SUCCESS));
EXPECT_CALL(client_, Instruction(MakeParsedVoidTypeInstruction(1)))
.WillOnce(Return(SPV_SUCCESS));
Parse(words, SPV_SUCCESS, endian_swap);
EXPECT_EQ(nullptr, diagnostic_);
}
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
}
TEST_F(BinaryParseTest, NullHeaderCallbackIsIgnored) {
Made compilation with gcc and clang more strict. Added additional compilation flags to gcc and clang builds. Adds -Wall -Wextra -Wno-long-long -Wshadow -Wundef -Wconversion -WNo-sign-conversion and -Wno-missing-field-initializers where appropriate. Does not add -Wundef to tests, because GTEST tests undefined macros all over the place.
2016-01-11 15:54:20 +00:00
const auto words = CompileSuccessfully("%1 = OpTypeVoid");
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
EXPECT_CALL(client_, Header(_, _, _, _, _, _))
.Times(0); // No header callback.
EXPECT_CALL(client_, Instruction(MakeParsedVoidTypeInstruction(1)))
.WillOnce(Return(SPV_SUCCESS));
First tests for SPIR-V v1.1. Add test for named-barrier instructions and capability. Add spv_target_env as an optional argument to CompileSuccessfully() and CompileFailure(). Currently defaults to UNIVERSAL_1_0, though that could change in the future. Make spv_context a local variable in test methods instead of a TextToBinaryTestBase member. Introduce ScopedContext to make temp contexts easier.
2016-04-19 02:25:35 +00:00
EXPECT_EQ(SPV_SUCCESS, spvBinaryParse(ScopedContext().context, &client_,
words.data(), words.size(), nullptr,
invoke_instruction, &diagnostic_));
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
EXPECT_EQ(nullptr, diagnostic_);
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
}
TEST_F(BinaryParseTest, NullInstructionCallbackIsIgnored) {
Made compilation with gcc and clang more strict. Added additional compilation flags to gcc and clang builds. Adds -Wall -Wextra -Wno-long-long -Wshadow -Wundef -Wconversion -WNo-sign-conversion and -Wno-missing-field-initializers where appropriate. Does not add -Wundef to tests, because GTEST tests undefined macros all over the place.
2016-01-11 15:54:20 +00:00
const auto words = CompileSuccessfully("%1 = OpTypeVoid");
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
EXPECT_HEADER((2)).WillOnce(Return(SPV_SUCCESS));
EXPECT_CALL(client_, Instruction(_)).Times(0); // No instruction callback.
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
EXPECT_EQ(SPV_SUCCESS,
First tests for SPIR-V v1.1. Add test for named-barrier instructions and capability. Add spv_target_env as an optional argument to CompileSuccessfully() and CompileFailure(). Currently defaults to UNIVERSAL_1_0, though that could change in the future. Make spv_context a local variable in test methods instead of a TextToBinaryTestBase member. Introduce ScopedContext to make temp contexts easier.
2016-04-19 02:25:35 +00:00
spvBinaryParse(ScopedContext().context, &client_, words.data(),
words.size(), invoke_header, nullptr, &diagnostic_));
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
EXPECT_EQ(nullptr, diagnostic_);
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
}
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
// Check the result of multiple instruction callbacks.
//
// This test exercises non-default values for the following members of the
// spv_parsed_instruction_t struct: words, num_words, opcode, result_id,
// operands, num_operands.
TEST_F(BinaryParseTest, TwoScalarTypesGenerateTwoInstructionCallbacks) {
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
for (bool endian_swap : kSwapEndians) {
const auto words = CompileSuccessfully(
"%1 = OpTypeVoid "
"%2 = OpTypeInt 32 1");
InSequence calls_expected_in_specific_order;
EXPECT_HEADER(3).WillOnce(Return(SPV_SUCCESS));
EXPECT_CALL(client_, Instruction(MakeParsedVoidTypeInstruction(1)))
.WillOnce(Return(SPV_SUCCESS));
EXPECT_CALL(client_, Instruction(MakeParsedInt32TypeInstruction(2)))
.WillOnce(Return(SPV_SUCCESS));
Parse(words, SPV_SUCCESS, endian_swap);
EXPECT_EQ(nullptr, diagnostic_);
}
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
}
TEST_F(BinaryParseTest, EarlyReturnWithZeroPassingCallbacks) {
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
for (bool endian_swap : kSwapEndians) {
const auto words = CompileSuccessfully(
"%1 = OpTypeVoid "
"%2 = OpTypeInt 32 1");
InSequence calls_expected_in_specific_order;
EXPECT_HEADER(3).WillOnce(Return(SPV_ERROR_INVALID_BINARY));
// Early exit means no calls to Instruction().
EXPECT_CALL(client_, Instruction(_)).Times(0);
Parse(words, SPV_ERROR_INVALID_BINARY, endian_swap);
// On error, the binary parser doesn't generate its own diagnostics.
EXPECT_EQ(nullptr, diagnostic_);
}
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
}
TEST_F(BinaryParseTest,
EarlyReturnWithZeroPassingCallbacksAndSpecifiedResultCode) {
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
for (bool endian_swap : kSwapEndians) {
const auto words = CompileSuccessfully(
"%1 = OpTypeVoid "
"%2 = OpTypeInt 32 1");
InSequence calls_expected_in_specific_order;
EXPECT_HEADER(3).WillOnce(Return(SPV_REQUESTED_TERMINATION));
// Early exit means no calls to Instruction().
EXPECT_CALL(client_, Instruction(_)).Times(0);
Parse(words, SPV_REQUESTED_TERMINATION, endian_swap);
// On early termination, the binary parser doesn't generate its own
// diagnostics.
EXPECT_EQ(nullptr, diagnostic_);
}
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
}
TEST_F(BinaryParseTest, EarlyReturnWithOnePassingCallback) {
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
for (bool endian_swap : kSwapEndians) {
const auto words = CompileSuccessfully(
"%1 = OpTypeVoid "
"%2 = OpTypeInt 32 1 "
"%3 = OpTypeFloat 32");
InSequence calls_expected_in_specific_order;
EXPECT_HEADER(4).WillOnce(Return(SPV_SUCCESS));
EXPECT_CALL(client_, Instruction(MakeParsedVoidTypeInstruction(1)))
.WillOnce(Return(SPV_REQUESTED_TERMINATION));
Parse(words, SPV_REQUESTED_TERMINATION, endian_swap);
// On early termination, the binary parser doesn't generate its own
// diagnostics.
EXPECT_EQ(nullptr, diagnostic_);
}
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
}
TEST_F(BinaryParseTest, EarlyReturnWithTwoPassingCallbacks) {
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
for (bool endian_swap : kSwapEndians) {
const auto words = CompileSuccessfully(
"%1 = OpTypeVoid "
"%2 = OpTypeInt 32 1 "
"%3 = OpTypeFloat 32");
InSequence calls_expected_in_specific_order;
EXPECT_HEADER(4).WillOnce(Return(SPV_SUCCESS));
EXPECT_CALL(client_, Instruction(MakeParsedVoidTypeInstruction(1)))
.WillOnce(Return(SPV_SUCCESS));
EXPECT_CALL(client_, Instruction(MakeParsedInt32TypeInstruction(2)))
.WillOnce(Return(SPV_REQUESTED_TERMINATION));
Parse(words, SPV_REQUESTED_TERMINATION, endian_swap);
// On early termination, the binary parser doesn't generate its own
// diagnostics.
EXPECT_EQ(nullptr, diagnostic_);
}
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
}
TEST_F(BinaryParseTest, InstructionWithStringOperand) {
const std::string str =
"the future is already here, it's just not evenly distributed";
const auto str_words = MakeVector(str);
const auto instruction = MakeInstruction(SpvOpName, {99}, str_words);
Made compilation with gcc and clang more strict. Added additional compilation flags to gcc and clang builds. Adds -Wall -Wextra -Wno-long-long -Wshadow -Wundef -Wconversion -WNo-sign-conversion and -Wno-missing-field-initializers where appropriate. Does not add -Wundef to tests, because GTEST tests undefined macros all over the place.
2016-01-11 15:54:20 +00:00
const auto words = Concatenate({ExpectedHeaderForBound(100), instruction});
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
InSequence calls_expected_in_specific_order;
EXPECT_HEADER(100).WillOnce(Return(SPV_SUCCESS));
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
const auto operands = std::vector<spv_parsed_operand_t>{
MakeSimpleOperand(1, SPV_OPERAND_TYPE_ID),
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
MakeLiteralStringOperand(2, static_cast<uint16_t>(str_words.size()))};
EXPECT_CALL(client_,
Instruction(ParsedInstruction(spv_parsed_instruction_t{
instruction.data(), static_cast<uint16_t>(instruction.size()),
SpvOpName, SPV_EXT_INST_TYPE_NONE, 0 /*type id*/,
0 /* No result id for OpName*/, operands.data(),
static_cast<uint16_t>(operands.size())})))
.WillOnce(Return(SPV_SUCCESS));
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
// Since we are actually checking the output, don't test the
// endian-swapped version.
Parse(words, SPV_SUCCESS, false);
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
EXPECT_EQ(nullptr, diagnostic_);
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
}
// Checks for non-zero values for the result_id and ext_inst_type members
// spv_parsed_instruction_t.
TEST_F(BinaryParseTest, ExtendedInstruction) {
Made compilation with gcc and clang more strict. Added additional compilation flags to gcc and clang builds. Adds -Wall -Wextra -Wno-long-long -Wshadow -Wundef -Wconversion -WNo-sign-conversion and -Wno-missing-field-initializers where appropriate. Does not add -Wundef to tests, because GTEST tests undefined macros all over the place.
2016-01-11 15:54:20 +00:00
const auto words = CompileSuccessfully(
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
"%extcl = OpExtInstImport \"OpenCL.std\" "
"%result = OpExtInst %float %extcl sqrt %x");
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
EXPECT_HEADER(5).WillOnce(Return(SPV_SUCCESS));
EXPECT_CALL(client_, Instruction(_)).WillOnce(Return(SPV_SUCCESS));
// We're only interested in the second call to Instruction():
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
const auto operands = std::vector<spv_parsed_operand_t>{
MakeSimpleOperand(1, SPV_OPERAND_TYPE_TYPE_ID),
MakeSimpleOperand(2, SPV_OPERAND_TYPE_RESULT_ID),
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
MakeSimpleOperand(3,
SPV_OPERAND_TYPE_ID), // Extended instruction set Id
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
MakeSimpleOperand(4, SPV_OPERAND_TYPE_EXTENSION_INSTRUCTION_NUMBER),
MakeSimpleOperand(5, SPV_OPERAND_TYPE_ID), // Id of the argument
};
const auto instruction = MakeInstruction(
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
SpvOpExtInst,
{2, 3, 1, static_cast<uint32_t>(OpenCLLIB::Entrypoints::Sqrt), 4});
EXPECT_CALL(client_,
Instruction(ParsedInstruction(spv_parsed_instruction_t{
instruction.data(), static_cast<uint16_t>(instruction.size()),
SpvOpExtInst, SPV_EXT_INST_TYPE_OPENCL_STD, 2 /*type id*/,
3 /*result id*/, operands.data(),
static_cast<uint16_t>(operands.size())})))
.WillOnce(Return(SPV_SUCCESS));
Fix endian-ness conversion in the binary parser. When we were swapping endian-ness in the binary parser, we would write outside of the bounds of our vector.
2016-01-11 18:54:30 +00:00
// Since we are actually checking the output, don't test the
// endian-swapped version.
Parse(words, SPV_SUCCESS, false);
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
EXPECT_EQ(nullptr, diagnostic_);
Several unit tests for spvBinaryParse Add a non-zero spv_result_t value SPV_REQUESTED_TERMINATION which should be used to signal an ok result, but signals early termination for a process, such as binary parsing. Tests include: - correct contents sent to header and instruction callbacks - non-zero status from a callback should terminate parsing, but the parser should not generate its own diagnostic. TODO: Check diagnostics generated by the parser itself.
2015-11-05 22:14:13 +00:00
}
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
// A binary parser diagnostic test case where we provide the words array
// pointer and word count explicitly.
struct WordsAndCountDiagnosticCase {
const uint32_t* words;
size_t num_words;
std::string expected_diagnostic;
};
using BinaryParseWordsAndCountDiagnosticTest = spvtest::TextToBinaryTestBase<
::testing::TestWithParam<WordsAndCountDiagnosticCase>>;
TEST_P(BinaryParseWordsAndCountDiagnosticTest, WordAndCountCases) {
EXPECT_EQ(
SPV_ERROR_INVALID_BINARY,
First tests for SPIR-V v1.1. Add test for named-barrier instructions and capability. Add spv_target_env as an optional argument to CompileSuccessfully() and CompileFailure(). Currently defaults to UNIVERSAL_1_0, though that could change in the future. Make spv_context a local variable in test methods instead of a TextToBinaryTestBase member. Introduce ScopedContext to make temp contexts easier.
2016-04-19 02:25:35 +00:00
spvBinaryParse(ScopedContext().context, nullptr, GetParam().words,
GetParam().num_words, nullptr, nullptr, &diagnostic));
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
ASSERT_NE(nullptr, diagnostic);
EXPECT_THAT(diagnostic->error, Eq(GetParam().expected_diagnostic));
}
INSTANTIATE_TEST_CASE_P(
BinaryParseDiagnostic, BinaryParseWordsAndCountDiagnosticTest,
::testing::ValuesIn(std::vector<WordsAndCountDiagnosticCase>{
{nullptr, 0, "Missing module."},
{kHeaderForBound1, 0,
"Module has incomplete header: only 0 words instead of 5"},
{kHeaderForBound1, 1,
"Module has incomplete header: only 1 words instead of 5"},
{kHeaderForBound1, 2,
"Module has incomplete header: only 2 words instead of 5"},
{kHeaderForBound1, 3,
"Module has incomplete header: only 3 words instead of 5"},
{kHeaderForBound1, 4,
"Module has incomplete header: only 4 words instead of 5"},
Remove dependency on SPIR-V headers in libspirv.h. For fulfilling this purpose, the |opcode| field in the |spv_parsed_instruction_t| struct is changed to of type uint16_t. Also add functions to query the information of a given SPIR-V target environment.
2016-03-31 21:26:31 +00:00
}), );
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
// A binary parser diagnostic test case where a vector of words is
// provided. We'll use this to express cases that can't be created
// via the assembler. Either we want to make a malformed instruction,
// or an invalid case the assembler would reject.
struct WordVectorDiagnosticCase {
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
std::vector<uint32_t> words;
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
std::string expected_diagnostic;
};
using BinaryParseWordVectorDiagnosticTest = spvtest::TextToBinaryTestBase<
::testing::TestWithParam<WordVectorDiagnosticCase>>;
TEST_P(BinaryParseWordVectorDiagnosticTest, WordVectorCases) {
const auto& words = GetParam().words;
First tests for SPIR-V v1.1. Add test for named-barrier instructions and capability. Add spv_target_env as an optional argument to CompileSuccessfully() and CompileFailure(). Currently defaults to UNIVERSAL_1_0, though that could change in the future. Make spv_context a local variable in test methods instead of a TextToBinaryTestBase member. Introduce ScopedContext to make temp contexts easier.
2016-04-19 02:25:35 +00:00
EXPECT_THAT(spvBinaryParse(ScopedContext().context, nullptr, words.data(),
words.size(), nullptr, nullptr, &diagnostic),
Basic SSA Validation Most uses of an ID must occur after the definition of the ID. Forward references are allowed for things like OpName, OpDecorate, and various cases of control-flow instructions such as OpBranch, OpPhi, and OpFunctionCall. TODO: Use CFG analysis for SSA checks. In particular, an ID defined inside a function body is only usable inside that function body. Also, use dominator info to catch some failing cases. Also: * Validator test cases use (standard) assignment form. * Update style to more closely follow the Google C++ style guide * Remove color-diagnostics flag. This is enabled by default on terminals with color. Prints hidden ASCII for terminals that can't handle color(Emacs) * Pass functors to SSAPass to check if the operand can be forward referenced based on its index value * Return SPV_ERROR_INVALID_ID for ID related errors spvBinaryParse returned SPV_ERROR_INVALID_BINARY for all types of errors. Since spvBinaryParse does some ID validation, this was returning inappropriate error codes for some tests. * Common fixture for validation tests. It only runs certian validation passes. * Add a SPV_VALIDATE_SSA_BIT for testing purposes * Fixtures now return error codes * Add OpName support in diag message and unit tests * Binary parsing can fail with invalid ID or invalid binary error code Tests include: * OpDecorate * OpName * OpMemberName * OpBranchConditional * OpSelectionMerge * OpMemberDecorate * OpGroupDecorate * OpDeviceEnqueue * Enable several tests failing in ID validation.
2015-11-18 20:43:43 +00:00
AnyOf(SPV_ERROR_INVALID_BINARY, SPV_ERROR_INVALID_ID));
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
ASSERT_NE(nullptr, diagnostic);
EXPECT_THAT(diagnostic->error, Eq(GetParam().expected_diagnostic));
}
INSTANTIATE_TEST_CASE_P(
BinaryParseDiagnostic, BinaryParseWordVectorDiagnosticTest,
::testing::ValuesIn(std::vector<WordVectorDiagnosticCase>{
{Concatenate({ExpectedHeaderForBound(1), {spvOpcodeMake(0, SpvOpNop)}}),
"Invalid instruction word count: 0"},
Made compilation with gcc and clang more strict. Added additional compilation flags to gcc and clang builds. Adds -Wall -Wextra -Wno-long-long -Wshadow -Wundef -Wconversion -WNo-sign-conversion and -Wno-missing-field-initializers where appropriate. Does not add -Wundef to tests, because GTEST tests undefined macros all over the place.
2016-01-11 15:54:20 +00:00
{Concatenate(
{ExpectedHeaderForBound(1),
{spvOpcodeMake(1, static_cast<SpvOp>(
std::numeric_limits<uint16_t>::max()))}}),
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
"Invalid opcode: 65535"},
{Concatenate({ExpectedHeaderForBound(1),
MakeInstruction(SpvOpNop, {42})}),
"Invalid instruction OpNop starting at word 5: expected "
"no more operands after 1 words, but stated word count is 2."},
Stated word count is several more than expected These are extra binary parsing cases.
2015-12-01 21:45:46 +00:00
// Supply several more unexpectd words.
{Concatenate({ExpectedHeaderForBound(1),
MakeInstruction(SpvOpNop, {42, 43, 44, 45, 46, 47})}),
"Invalid instruction OpNop starting at word 5: expected "
"no more operands after 1 words, but stated word count is 7."},
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
{Concatenate({ExpectedHeaderForBound(1),
MakeInstruction(SpvOpTypeVoid, {1, 2})}),
"Invalid instruction OpTypeVoid starting at word 5: expected "
"no more operands after 2 words, but stated word count is 3."},
{Concatenate({ExpectedHeaderForBound(1),
MakeInstruction(SpvOpTypeVoid, {1, 2, 5, 9, 10})}),
"Invalid instruction OpTypeVoid starting at word 5: expected "
"no more operands after 2 words, but stated word count is 6."},
{Concatenate({ExpectedHeaderForBound(1),
MakeInstruction(SpvOpTypeInt, {1, 32, 1, 9})}),
"Invalid instruction OpTypeInt starting at word 5: expected "
"no more operands after 4 words, but stated word count is 5."},
{Concatenate({ExpectedHeaderForBound(1),
MakeInstruction(SpvOpTypeInt, {1})}),
"End of input reached while decoding OpTypeInt starting at word 5:"
" expected more operands after 2 words."},
// Check several cases for running off the end of input.
// Detect a missing single word operand.
{Concatenate({ExpectedHeaderForBound(1),
{spvOpcodeMake(2, SpvOpTypeStruct)}}),
"End of input reached while decoding OpTypeStruct starting at word"
" 5: missing result ID operand at word offset 1."},
// Detect this a missing a multi-word operand to OpConstant.
// We also lie and say the OpConstant instruction has 5 words when
// it only has 3. Corresponds to something like this:
// %1 = OpTypeInt 64 0
// %2 = OpConstant %1 <missing>
{Concatenate({ExpectedHeaderForBound(3),
{MakeInstruction(SpvOpTypeInt, {1, 64, 0})},
{spvOpcodeMake(5, SpvOpConstant), 1, 2}}),
"End of input reached while decoding OpConstant starting at word"
" 9: missing possibly multi-word literal number operand at word "
"offset 3."},
// Detect when we provide only one word from the 64-bit literal,
// and again lie about the number of words in the instruction.
{Concatenate({ExpectedHeaderForBound(3),
{MakeInstruction(SpvOpTypeInt, {1, 64, 0})},
{spvOpcodeMake(5, SpvOpConstant), 1, 2, 42}}),
"End of input reached while decoding OpConstant starting at word"
" 9: truncated possibly multi-word literal number operand at word "
"offset 3."},
// Detect when a required string operand is missing.
// Also, lie about the length of the instruction.
{Concatenate({ExpectedHeaderForBound(3),
{spvOpcodeMake(3, SpvOpString), 1}}),
"End of input reached while decoding OpString starting at word"
" 5: missing literal string operand at word offset 2."},
// Detect when a required string operand is truncated: it's missing
// a null terminator. Catching the error avoids a buffer overrun.
{Concatenate({ExpectedHeaderForBound(3),
{spvOpcodeMake(4, SpvOpString), 1, 0x41414141,
0x41414141}}),
"End of input reached while decoding OpString starting at word"
" 5: truncated literal string operand at word offset 2."},
// Detect when an optional string operand is truncated: it's missing
// a null terminator. Catching the error avoids a buffer overrun.
// (It is valid for an optional string operand to be absent.)
{Concatenate({ExpectedHeaderForBound(3),
{spvOpcodeMake(6, SpvOpSource),
Merge PR #32. Simplify binary parser tests using GoogleMock.
2015-11-30 23:05:21 +00:00
static_cast<uint32_t>(SpvSourceLanguageOpenCL_C), 210,
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
1 /* file id */,
/*start of string*/ 0x41414141, 0x41414141}}),
"End of input reached while decoding OpSource starting at word"
" 5: truncated literal string operand at word offset 4."},
// (End of input exhaustion test cases.)
// In this case the instruction word count is too small, where
// it would truncate a multi-word operand to OpConstant.
{Concatenate({ExpectedHeaderForBound(3),
{MakeInstruction(SpvOpTypeInt, {1, 64, 0})},
{spvOpcodeMake(4, SpvOpConstant), 1, 2, 44, 44}}),
"Invalid word count: OpConstant starting at word 9 says it has 4"
" words, but found 5 words instead."},
// Word count is to small, where it would truncate a literal string.
{Concatenate({ExpectedHeaderForBound(2),
{spvOpcodeMake(3, SpvOpString), 1, 0x41414141, 0}}),
"Invalid word count: OpString starting at word 5 says it has 3"
" words, but found 4 words instead."},
binary parse test: extra words after string literal Covers the case where the string literal is the last operand. TODO: Case where one more operand is expected after the string literal. Occurs only for the LinkageAttributes decoration. To test that, we need to update the grammar as well.
2015-11-30 18:45:20 +00:00
// Word count is too large. The string terminates before the last
// word.
{Concatenate({ExpectedHeaderForBound(2),
{spvOpcodeMake(4, SpvOpString), 1 /* result id */},
MakeVector("abc"),
{0 /* this word does not belong*/}}),
"Invalid instruction OpString starting at word 5: expected no more"
" operands after 3 words, but stated word count is 4."},
OpDecorate should not accept any number of literal operands. This is a grammar fix. The Decoration operand of OpDecorate (and OpMemberDecorate) determines the remaining operands. Don't just allow any number of literal numbers as operands. (The OperandVariableLiterals operand class as the last member of the OpDecorate and OpMemberDecorate entries in in opcode.inc is an artifact of how the spec generates the opcode descriptions. It's not suitable for parsing those instructions.) Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/34
2015-11-30 19:39:31 +00:00
// Word count is too large. There are too many words after the string
// literal. A linkage attribute decoration is the only case in SPIR-V
// where a string operand is followed by another operand.
{Concatenate({ExpectedHeaderForBound(2),
{spvOpcodeMake(6, SpvOpDecorate), 1 /* target id */,
Use static_cast instead of constructor for uint32_t
2015-12-01 21:19:44 +00:00
static_cast<uint32_t>(SpvDecorationLinkageAttributes)},
OpDecorate should not accept any number of literal operands. This is a grammar fix. The Decoration operand of OpDecorate (and OpMemberDecorate) determines the remaining operands. Don't just allow any number of literal numbers as operands. (The OperandVariableLiterals operand class as the last member of the OpDecorate and OpMemberDecorate entries in in opcode.inc is an artifact of how the spec generates the opcode descriptions. It's not suitable for parsing those instructions.) Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/34
2015-11-30 19:39:31 +00:00
MakeVector("abc"),
Use static_cast instead of constructor for uint32_t
2015-12-01 21:19:44 +00:00
{static_cast<uint32_t>(SpvLinkageTypeImport),
OpDecorate should not accept any number of literal operands. This is a grammar fix. The Decoration operand of OpDecorate (and OpMemberDecorate) determines the remaining operands. Don't just allow any number of literal numbers as operands. (The OperandVariableLiterals operand class as the last member of the OpDecorate and OpMemberDecorate entries in in opcode.inc is an artifact of how the spec generates the opcode descriptions. It's not suitable for parsing those instructions.) Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/34
2015-11-30 19:39:31 +00:00
0 /* does not belong */}}),
"Invalid instruction OpDecorate starting at word 5: expected no more"
" operands after 5 words, but stated word count is 6."},
Stated word count is several more than expected These are extra binary parsing cases.
2015-12-01 21:45:46 +00:00
// Like the previous case, but with 5 extra words.
{Concatenate({ExpectedHeaderForBound(2),
{spvOpcodeMake(10, SpvOpDecorate), 1 /* target id */,
static_cast<uint32_t>(SpvDecorationLinkageAttributes)},
MakeVector("abc"),
{static_cast<uint32_t>(SpvLinkageTypeImport),
/* don't belong */ 0, 1, 2, 3, 4}}),
"Invalid instruction OpDecorate starting at word 5: expected no more"
" operands after 5 words, but stated word count is 10."},
// Like the previous two cases, but with OpMemberDecorate.
Use static_cast instead of constructor for uint32_t
2015-12-01 21:19:44 +00:00
{Concatenate({ExpectedHeaderForBound(2),
{spvOpcodeMake(7, SpvOpMemberDecorate), 1 /* target id */,
42 /* member index */,
static_cast<uint32_t>(SpvDecorationLinkageAttributes)},
MakeVector("abc"),
{static_cast<uint32_t>(SpvLinkageTypeImport),
0 /* does not belong */}}),
OpDecorate should not accept any number of literal operands. This is a grammar fix. The Decoration operand of OpDecorate (and OpMemberDecorate) determines the remaining operands. Don't just allow any number of literal numbers as operands. (The OperandVariableLiterals operand class as the last member of the OpDecorate and OpMemberDecorate entries in in opcode.inc is an artifact of how the spec generates the opcode descriptions. It's not suitable for parsing those instructions.) Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/34
2015-11-30 19:39:31 +00:00
"Invalid instruction OpMemberDecorate starting at word 5: expected no"
" more operands after 6 words, but stated word count is 7."},
Stated word count is several more than expected These are extra binary parsing cases.
2015-12-01 21:45:46 +00:00
{Concatenate({ExpectedHeaderForBound(2),
{spvOpcodeMake(11, SpvOpMemberDecorate),
1 /* target id */, 42 /* member index */,
static_cast<uint32_t>(SpvDecorationLinkageAttributes)},
MakeVector("abc"),
{static_cast<uint32_t>(SpvLinkageTypeImport),
/* don't belong */ 0, 1, 2, 3, 4}}),
"Invalid instruction OpMemberDecorate starting at word 5: expected no"
" more operands after 6 words, but stated word count is 11."},
OpDecorate should not accept any number of literal operands. This is a grammar fix. The Decoration operand of OpDecorate (and OpMemberDecorate) determines the remaining operands. Don't just allow any number of literal numbers as operands. (The OperandVariableLiterals operand class as the last member of the OpDecorate and OpMemberDecorate entries in in opcode.inc is an artifact of how the spec generates the opcode descriptions. It's not suitable for parsing those instructions.) Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/34
2015-11-30 19:39:31 +00:00
// Word count is too large. There should be no more words
// after the RelaxedPrecision decoration.
{Concatenate({ExpectedHeaderForBound(2),
{spvOpcodeMake(4, SpvOpDecorate), 1 /* target id */,
Use static_cast instead of constructor for uint32_t
2015-12-01 21:19:44 +00:00
static_cast<uint32_t>(SpvDecorationRelaxedPrecision),
OpDecorate should not accept any number of literal operands. This is a grammar fix. The Decoration operand of OpDecorate (and OpMemberDecorate) determines the remaining operands. Don't just allow any number of literal numbers as operands. (The OperandVariableLiterals operand class as the last member of the OpDecorate and OpMemberDecorate entries in in opcode.inc is an artifact of how the spec generates the opcode descriptions. It's not suitable for parsing those instructions.) Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/34
2015-11-30 19:39:31 +00:00
0 /* does not belong */}}),
"Invalid instruction OpDecorate starting at word 5: expected no"
" more operands after 3 words, but stated word count is 4."},
// Word count is too large. There should be only one word after
// the SpecId decoration enum word.
{Concatenate({ExpectedHeaderForBound(2),
{spvOpcodeMake(5, SpvOpDecorate), 1 /* target id */,
Use static_cast instead of constructor for uint32_t
2015-12-01 21:19:44 +00:00
static_cast<uint32_t>(SpvDecorationSpecId),
42 /* the spec id */, 0 /* does not belong */}}),
OpDecorate should not accept any number of literal operands. This is a grammar fix. The Decoration operand of OpDecorate (and OpMemberDecorate) determines the remaining operands. Don't just allow any number of literal numbers as operands. (The OperandVariableLiterals operand class as the last member of the OpDecorate and OpMemberDecorate entries in in opcode.inc is an artifact of how the spec generates the opcode descriptions. It's not suitable for parsing those instructions.) Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/34
2015-11-30 19:39:31 +00:00
"Invalid instruction OpDecorate starting at word 5: expected no"
" more operands after 4 words, but stated word count is 5."},
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
{Concatenate({ExpectedHeaderForBound(2),
{spvOpcodeMake(2, SpvOpTypeVoid), 0}}),
"Error: Result Id is 0"},
{Concatenate({
ExpectedHeaderForBound(2),
{spvOpcodeMake(2, SpvOpTypeVoid), 1},
{spvOpcodeMake(2, SpvOpTypeBool), 1},
}),
"Id 1 is defined more than once"},
{Concatenate({ExpectedHeaderForBound(3),
MakeInstruction(SpvOpExtInst, {2, 3, 100, 4, 5})}),
"OpExtInst set Id 100 does not reference an OpExtInstImport result "
"Id"},
Fix ExtInst parsing: no IdRef* at end The operands following the extended instruction literal number are determined by the extended instruction itself. So drop the zero-or-more IdRef pattern at the end of OpExtInst. It's arguable whether this should actually be a grammar fix. I've chosen to patch this in SPIRV-Tools instead of in the grammar file. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/233 Also fix two test cases for OpenCL extended instructions. These errors of supplying too many operands are now detected.
2016-06-14 20:41:27 +00:00
{Concatenate({ExpectedHeaderForBound(101),
MakeInstruction(SpvOpExtInstImport, {100},
MakeVector("OpenCL.std")),
// OpenCL cos is #14
MakeInstruction(SpvOpExtInst, {2, 3, 100, 14, 5, 999})}),
"Invalid instruction OpExtInst starting at word 10: expected no "
"more operands after 6 words, but stated word count is 7."},
Fix parser assert failure for a bad OpSwitch Emit a diagnostic if the OpSwitch selector refers to an ID that is valid but has no type. Discovered by afl-fuzz.
2015-12-23 18:21:43 +00:00
// In this case, the OpSwitch selector refers to an invalid ID.
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
{Concatenate({ExpectedHeaderForBound(3),
MakeInstruction(SpvOpSwitch, {1, 2, 42, 3})}),
"Invalid OpSwitch: selector id 1 has no type"},
Fix parser assert failure for a bad OpSwitch Emit a diagnostic if the OpSwitch selector refers to an ID that is valid but has no type. Discovered by afl-fuzz.
2015-12-23 18:21:43 +00:00
// In this case, the OpSwitch selector refers to an ID that has
// no type.
{Concatenate({ExpectedHeaderForBound(3),
MakeInstruction(SpvOpLabel, {1}),
MakeInstruction(SpvOpSwitch, {1, 2, 42, 3})}),
"Invalid OpSwitch: selector id 1 has no type"},
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
{Concatenate({ExpectedHeaderForBound(3),
MakeInstruction(SpvOpTypeInt, {1, 32, 0}),
MakeInstruction(SpvOpSwitch, {1, 3, 42, 3})}),
"Invalid OpSwitch: selector id 1 is a type, not a value"},
{Concatenate({ExpectedHeaderForBound(3),
MakeInstruction(SpvOpTypeFloat, {1, 32}),
MakeInstruction(SpvOpConstant, {1, 2, 0x78f00000}),
MakeInstruction(SpvOpSwitch, {2, 3, 42, 3})}),
"Invalid OpSwitch: selector id 2 is not a scalar integer"},
{Concatenate({ExpectedHeaderForBound(3),
MakeInstruction(SpvOpExtInstImport, {1},
MakeVector("invalid-import"))}),
"Invalid extended instruction import 'invalid-import'"},
{Concatenate({
ExpectedHeaderForBound(3),
MakeInstruction(SpvOpTypeInt, {1, 32, 0}),
MakeInstruction(SpvOpConstant, {2, 2, 42}),
}),
"Type Id 2 is not a type"},
{Concatenate({
ExpectedHeaderForBound(3), MakeInstruction(SpvOpTypeBool, {1}),
MakeInstruction(SpvOpConstant, {1, 2, 42}),
}),
"Type Id 1 is not a scalar numeric type"},
Remove dependency on SPIR-V headers in libspirv.h. For fulfilling this purpose, the |opcode| field in the |spv_parsed_instruction_t| struct is changed to of type uint16_t. Also add functions to query the information of a given SPIR-V target environment.
2016-03-31 21:26:31 +00:00
}), );
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
// A binary parser diagnostic case generated from an assembly text input.
struct AssemblyDiagnosticCase {
std::string assembly;
std::string expected_diagnostic;
};
using BinaryParseAssemblyDiagnosticTest = spvtest::TextToBinaryTestBase<
::testing::TestWithParam<AssemblyDiagnosticCase>>;
TEST_P(BinaryParseAssemblyDiagnosticTest, AssemblyCases) {
auto words = CompileSuccessfully(GetParam().assembly);
First tests for SPIR-V v1.1. Add test for named-barrier instructions and capability. Add spv_target_env as an optional argument to CompileSuccessfully() and CompileFailure(). Currently defaults to UNIVERSAL_1_0, though that could change in the future. Make spv_context a local variable in test methods instead of a TextToBinaryTestBase member. Introduce ScopedContext to make temp contexts easier.
2016-04-19 02:25:35 +00:00
EXPECT_THAT(spvBinaryParse(ScopedContext().context, nullptr, words.data(),
words.size(), nullptr, nullptr, &diagnostic),
Basic SSA Validation Most uses of an ID must occur after the definition of the ID. Forward references are allowed for things like OpName, OpDecorate, and various cases of control-flow instructions such as OpBranch, OpPhi, and OpFunctionCall. TODO: Use CFG analysis for SSA checks. In particular, an ID defined inside a function body is only usable inside that function body. Also, use dominator info to catch some failing cases. Also: * Validator test cases use (standard) assignment form. * Update style to more closely follow the Google C++ style guide * Remove color-diagnostics flag. This is enabled by default on terminals with color. Prints hidden ASCII for terminals that can't handle color(Emacs) * Pass functors to SSAPass to check if the operand can be forward referenced based on its index value * Return SPV_ERROR_INVALID_ID for ID related errors spvBinaryParse returned SPV_ERROR_INVALID_BINARY for all types of errors. Since spvBinaryParse does some ID validation, this was returning inappropriate error codes for some tests. * Common fixture for validation tests. It only runs certian validation passes. * Add a SPV_VALIDATE_SSA_BIT for testing purposes * Fixtures now return error codes * Add OpName support in diag message and unit tests * Binary parsing can fail with invalid ID or invalid binary error code Tests include: * OpDecorate * OpName * OpMemberName * OpBranchConditional * OpSelectionMerge * OpMemberDecorate * OpGroupDecorate * OpDeviceEnqueue * Enable several tests failing in ID validation.
2015-11-18 20:43:43 +00:00
AnyOf(SPV_ERROR_INVALID_BINARY, SPV_ERROR_INVALID_ID));
spvBinaryParse: fix overruns, handle image format Add unit tests for all diagnostics issued by spvBinaryParse. Handle image format operands in the binary parser and the disassembler. Document that the callback function pointers can be null, in which case they are ignored. Detect exhaustion of input when parsing an operand, to avoid buffer overruns on some invalid input cases. Fix the description strings for some operand types. Make the diagnostic messages for those operand types consistent between the assembler and binary parser. Fixes https://github.com/KhronosGroup/SPIRV-Tools/issues/29
2015-11-24 23:37:24 +00:00
ASSERT_NE(nullptr, diagnostic);
EXPECT_THAT(diagnostic->error, Eq(GetParam().expected_diagnostic));
}
INSTANTIATE_TEST_CASE_P(
BinaryParseDiagnostic, BinaryParseAssemblyDiagnosticTest,
::testing::ValuesIn(std::vector<AssemblyDiagnosticCase>{
{"%1 = OpConstant !0 42", "Error: Type Id is 0"},
// A required id is 0.
{"OpName !0 \"foo\"", "Id is 0"},
// An optional id is 0, in this case the optional
// initializer.
{"%2 = OpVariable %1 CrossWorkgroup !0", "Id is 0"},
{"OpControlBarrier !0 %1 %2", "scope ID is 0"},
{"OpControlBarrier %1 !0 %2", "scope ID is 0"},
{"OpControlBarrier %1 %2 !0", "memory semantics ID is 0"},
{"%import = OpExtInstImport \"GLSL.std.450\" "
"%result = OpExtInst %type %import !999999 %x",
"Invalid extended instruction number: 999999"},
{"%2 = OpSpecConstantOp %1 !1000 %2",
"Invalid OpSpecConstantOp opcode: 1000"},
{"OpCapability !9999", "Invalid capability operand: 9999"},
{"OpSource !9999 100", "Invalid source language operand: 9999"},
{"OpEntryPoint !9999", "Invalid execution model operand: 9999"},
{"OpMemoryModel !9999", "Invalid addressing model operand: 9999"},
{"OpMemoryModel Logical !9999", "Invalid memory model operand: 9999"},
{"OpExecutionMode %1 !9999", "Invalid execution mode operand: 9999"},
{"OpTypeForwardPointer %1 !9999",
"Invalid storage class operand: 9999"},
{"%2 = OpTypeImage %1 !9999", "Invalid dimensionality operand: 9999"},
{"%2 = OpTypeImage %1 1D 0 0 0 0 !9999",
"Invalid image format operand: 9999"},
{"OpDecorate %1 FPRoundingMode !9999",
"Invalid floating-point rounding mode operand: 9999"},
{"OpDecorate %1 LinkageAttributes \"C\" !9999",
"Invalid linkage type operand: 9999"},
{"%1 = OpTypePipe !9999", "Invalid access qualifier operand: 9999"},
{"OpDecorate %1 FuncParamAttr !9999",
"Invalid function parameter attribute operand: 9999"},
{"OpDecorate %1 !9999", "Invalid decoration operand: 9999"},
{"OpDecorate %1 BuiltIn !9999", "Invalid built-in operand: 9999"},
{"%2 = OpGroupIAdd %1 %3 !9999",
"Invalid group operation operand: 9999"},
{"OpDecorate %1 FPFastMathMode !63",
"Invalid floating-point fast math mode operand: 63 has invalid mask "
"component 32"},
{"%2 = OpFunction %2 !31",
"Invalid function control operand: 31 has invalid mask component 16"},
{"OpLoopMerge %1 %2 !7",
"Invalid loop control operand: 7 has invalid mask component 4"},
{"%2 = OpImageFetch %1 %image %coord !511",
"Invalid image operand: 511 has invalid mask component 256"},
{"OpSelectionMerge %1 !7",
"Invalid selection control operand: 7 has invalid mask component 4"},
Remove dependency on SPIR-V headers in libspirv.h. For fulfilling this purpose, the |opcode| field in the |spv_parsed_instruction_t| struct is changed to of type uint16_t. Also add functions to query the information of a given SPIR-V target environment.
2016-03-31 21:26:31 +00:00
}), );
Refactor the binary parser. The binary parser has a C API, described in binary.h. Eventually we will make it public in libspirv.h. The API is event-driven in the sense that a callback is called when a valid header is parsed, and for each parsed instruction. Classify some operand types as "concrete". The binary parser uses only concrete operand types to describe parsed instructions. The old disassembler APIs are moved into disassemble.cpp TODO: Add unit tests for spvBinaryParse.
2015-10-30 20:06:15 +00:00
} // anonymous namespace
Reference in New Issue Copy Permalink