SPIRV-Tools/test/binary_to_text.literal_test.cpp
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

88 lines
3.3 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.
#include <string>
#include <utility>
#include <vector>
#include "gmock/gmock.h"
#include "test/test_fixture.h"
#include "test/unit_spirv.h"
namespace spvtools {
namespace {
using ::testing::Eq;
using RoundTripLiteralsTest =
spvtest::TextToBinaryTestBase<::testing::TestWithParam<std::string>>;
static const bool kSwapEndians[] = {false, true};
TEST_P(RoundTripLiteralsTest, Sample) {
for (bool endian_swap : kSwapEndians) {
EXPECT_THAT(
EncodeAndDecodeSuccessfully(GetParam(), SPV_BINARY_TO_TEXT_OPTION_NONE,
SPV_ENV_UNIVERSAL_1_0, endian_swap),
Eq(GetParam()));
}
}
// clang-format off
INSTANTIATE_TEST_SUITE_P(
StringLiterals, RoundTripLiteralsTest,
::testing::ValuesIn(std::vector<std::string>{
"OpName %1 \"\"\n", // empty
"OpName %1 \"foo\"\n", // normal
"OpName %1 \"foo bar\"\n", // string with spaces
"OpName %1 \"foo\tbar\"\n", // string with tab
"OpName %1 \"\tfoo\"\n", // starts with tab
"OpName %1 \" foo\"\n", // starts with space
"OpName %1 \"foo \"\n", // ends with space
"OpName %1 \"foo\t\"\n", // ends with tab
"OpName %1 \"foo\nbar\"\n", // contains newline
"OpName %1 \"\nfoo\nbar\"\n", // starts with newline
"OpName %1 \"\n\n\nfoo\nbar\"\n", // multiple newlines
"OpName %1 \"\\\"foo\nbar\\\"\"\n", // escaped quote
"OpName %1 \"\\\\foo\nbar\\\\\"\n", // escaped backslash
"OpName %1 \"\xE4\xBA\xB2\"\n", // UTF-8
}));
// clang-format on
using RoundTripSpecialCaseLiteralsTest = spvtest::TextToBinaryTestBase<
::testing::TestWithParam<std::pair<std::string, std::string>>>;
// Test case where the generated disassembly is not the same as the
// assembly passed in.
TEST_P(RoundTripSpecialCaseLiteralsTest, Sample) {
for (bool endian_swap : kSwapEndians) {
EXPECT_THAT(EncodeAndDecodeSuccessfully(std::get<0>(GetParam()),
SPV_BINARY_TO_TEXT_OPTION_NONE,
SPV_ENV_UNIVERSAL_1_0, endian_swap),
Eq(std::get<1>(GetParam())));
}
}
// clang-format off
INSTANTIATE_TEST_SUITE_P(
StringLiterals, RoundTripSpecialCaseLiteralsTest,
::testing::ValuesIn(std::vector<std::pair<std::string, std::string>>{
{"OpName %1 \"\\foo\"\n", "OpName %1 \"foo\"\n"}, // Escape f
{"OpName %1 \"\\\nfoo\"\n", "OpName %1 \"\nfoo\"\n"}, // Escape newline
{"OpName %1 \"\\\xE4\xBA\xB2\"\n", "OpName %1 \"\xE4\xBA\xB2\"\n"}, // Escape utf-8
}));
// clang-format on
} // namespace
} // namespace spvtools