mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2024-11-27 05:40:06 +00:00
52e9cc9301
Adds an option to run the validator on the SPIR-V binary after each fuzzer pass has been applied, to help identify when the fuzzer has made the module invalid. Also adds a helper method to allow dumping of the sequence of transformations that have been applied to a JSON file.
114 lines
4.1 KiB
C++
114 lines
4.1 KiB
C++
// Copyright (c) 2019 Google LLC
|
|
//
|
|
// 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 TEST_FUZZ_FUZZ_TEST_UTIL_H_
|
|
#define TEST_FUZZ_FUZZ_TEST_UTIL_H_
|
|
|
|
#include "gtest/gtest.h"
|
|
|
|
#include <vector>
|
|
|
|
#include "source/fuzz/protobufs/spirvfuzz_protobufs.h"
|
|
#include "source/opt/build_module.h"
|
|
#include "source/opt/ir_context.h"
|
|
#include "spirv-tools/libspirv.h"
|
|
|
|
namespace spvtools {
|
|
namespace fuzz {
|
|
|
|
// Returns true if and only if the given binaries are bit-wise equal.
|
|
bool IsEqual(spv_target_env env, const std::vector<uint32_t>& expected_binary,
|
|
const std::vector<uint32_t>& actual_binary);
|
|
|
|
// Assembles the given text and returns true if and only if the resulting binary
|
|
// is bit-wise equal to the given binary.
|
|
bool IsEqual(spv_target_env env, const std::string& expected_text,
|
|
const std::vector<uint32_t>& actual_binary);
|
|
|
|
// Assembles the given text and turns the given IR into binary, then returns
|
|
// true if and only if the resulting binaries are bit-wise equal.
|
|
bool IsEqual(spv_target_env env, const std::string& expected_text,
|
|
const opt::IRContext* actual_ir);
|
|
|
|
// Turns the given IRs into binaries, then returns true if and only if the
|
|
// resulting binaries are bit-wise equal.
|
|
bool IsEqual(spv_target_env env, const opt::IRContext* ir_1,
|
|
const opt::IRContext* ir_2);
|
|
|
|
// Assembles the given IR context and returns true if and only if
|
|
// the resulting binary is valid.
|
|
bool IsValid(spv_target_env env, const opt::IRContext* ir);
|
|
|
|
// Assembles the given IR context, then returns its disassembly as a string.
|
|
// Useful for debugging.
|
|
std::string ToString(spv_target_env env, const opt::IRContext* ir);
|
|
|
|
// Returns the disassembly of the given binary as a string.
|
|
// Useful for debugging.
|
|
std::string ToString(spv_target_env env, const std::vector<uint32_t>& binary);
|
|
|
|
// Assembly options for writing fuzzer tests. It simplifies matters if
|
|
// numeric ids do not change.
|
|
const uint32_t kFuzzAssembleOption =
|
|
SPV_TEXT_TO_BINARY_OPTION_PRESERVE_NUMERIC_IDS;
|
|
// Disassembly options for writing fuzzer tests.
|
|
const uint32_t kFuzzDisassembleOption =
|
|
SPV_BINARY_TO_TEXT_OPTION_NO_HEADER | SPV_BINARY_TO_TEXT_OPTION_INDENT;
|
|
|
|
// A silent message consumer.
|
|
const spvtools::MessageConsumer kSilentConsumer =
|
|
[](spv_message_level_t, const char*, const spv_position_t&,
|
|
const char*) -> void {};
|
|
|
|
const spvtools::MessageConsumer kConsoleMessageConsumer =
|
|
[](spv_message_level_t level, const char*, const spv_position_t& position,
|
|
const char* message) -> void {
|
|
switch (level) {
|
|
case SPV_MSG_FATAL:
|
|
case SPV_MSG_INTERNAL_ERROR:
|
|
case SPV_MSG_ERROR:
|
|
std::cerr << "error: line " << position.index << ": " << message
|
|
<< std::endl;
|
|
break;
|
|
case SPV_MSG_WARNING:
|
|
std::cout << "warning: line " << position.index << ": " << message
|
|
<< std::endl;
|
|
break;
|
|
case SPV_MSG_INFO:
|
|
std::cout << "info: line " << position.index << ": " << message
|
|
<< std::endl;
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
};
|
|
|
|
// Dumps the SPIRV-V module in |context| to file |filename|. Useful for
|
|
// interactive debugging.
|
|
void DumpShader(opt::IRContext* context, const char* filename);
|
|
|
|
// Dumps |binary| to file |filename|. Useful for interactive debugging.
|
|
void DumpShader(const std::vector<uint32_t>& binary, const char* filename);
|
|
|
|
// Dumps |transformations| to file |filename| in JSON format. Useful for
|
|
// interactive debugging.
|
|
void DumpTransformationsJson(
|
|
const protobufs::TransformationSequence& transformations,
|
|
const char* filename);
|
|
|
|
} // namespace fuzz
|
|
} // namespace spvtools
|
|
|
|
#endif // TEST_FUZZ_FUZZ_TEST_UTIL_H_
|