mirror of
https://github.com/encounter/dawn-cmake.git
synced 2025-05-14 03:11:29 +00:00
0b3611b8c8
This change adds a new tint fuzzer that uses SPIRV-Tools to fuzz SPIR-V binaries. The fuzzer works on a corpus of SPIR-V shaders. For each shader from the corpus it uses one of `spirv-fuzz`, `spirv-reduce` or `spirv-opt` to mutate and then runs the shader through the Tint compiler in two steps: - Converts the mutated shader to WGSL. - Converts WGSL to some target language specified in the CLI arguments. The list of all supported CLI arguments and their description is in the cli.h file. Change-Id: I95c0741b78ccc600dd9a73c371d520bdf7814352 Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/41945 Kokoro: Kokoro <noreply+kokoro@google.com> Commit-Queue: Vasyl Teliman <vasniktel@gmail.com> Reviewed-by: David Neto <dneto@google.com> Reviewed-by: Alastair Donaldson <allydonaldson@googlemail.com>
97 lines
3.8 KiB
C++
97 lines
3.8 KiB
C++
// Copyright 2021 The Tint Authors.
|
|
//
|
|
// 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 FUZZERS_TINT_SPIRV_TOOLS_FUZZER_UTIL_H_
|
|
#define FUZZERS_TINT_SPIRV_TOOLS_FUZZER_UTIL_H_
|
|
|
|
#include <sstream>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "fuzzers/tint_common_fuzzer.h"
|
|
#include "fuzzers/tint_spirv_tools_fuzzer/mutator.h"
|
|
|
|
#include "spirv-tools/libspirv.hpp"
|
|
|
|
namespace tint {
|
|
namespace fuzzers {
|
|
namespace spvtools_fuzzer {
|
|
namespace util {
|
|
|
|
/// @param buffer will be used to output errors by the returned message
|
|
/// consumer. Must remain in scope as long as the returned consumer is in
|
|
/// scope.
|
|
/// @return the message consumer that will print errors to the `buffer`.
|
|
spvtools::MessageConsumer GetBufferMessageConsumer(std::stringstream* buffer);
|
|
|
|
/// Output errors from the SPV -> WGSL conversion.
|
|
///
|
|
/// @param message - the error message.
|
|
/// @param data - invalid SPIR-V binary.
|
|
/// @param size - the size of `data`.
|
|
/// @param error_dir - the directory, to which the binary will be printed to.
|
|
/// If it's empty, the invalid binary and supplemental files will not be
|
|
/// printed. Otherwise, it must have a `spv/` subdirectory.
|
|
void LogSpvError(const std::string& message,
|
|
const uint8_t* data,
|
|
size_t size,
|
|
const std::string& error_dir);
|
|
|
|
/// Output errors from the WGSL -> `output_format` conversion.
|
|
///
|
|
/// @param message - the error message.
|
|
/// @param data - the SPIR-V binary that generated the WGSL binary.
|
|
/// @param size - the size of `data`.
|
|
/// @param wgsl - the invalid WGSL binary.
|
|
/// @param output_format - the format which we attempted to convert `wgsl` to.
|
|
/// @param error_dir - the directory, to which the binary will be printed out.
|
|
/// If it's empty, the invalid binary and supplemental files will not be
|
|
/// printed. Otherwise, it must have a `wgsl/` subdirectory.
|
|
void LogWgslError(const std::string& message,
|
|
const uint8_t* data,
|
|
size_t size,
|
|
const std::string& wgsl,
|
|
OutputFormat output_format,
|
|
const std::string& error_dir);
|
|
|
|
/// Output errors produced by the mutator.
|
|
///
|
|
/// @param mutator - the mutator with invalid state.
|
|
/// @param error_dir - the directory, to which invalid files will be printed to.
|
|
/// If it's empty, the invalid binary and supplemental files will not be
|
|
/// printed. Otherwise, it must have a `mutator/` subdirectory.
|
|
void LogMutatorError(const Mutator& mutator, const std::string& error_dir);
|
|
|
|
/// Reads SPIR-V binary from `path` into `out`. Returns `true` if successful and
|
|
/// `false` otherwise (in this case, `out` is unchanged).
|
|
///
|
|
/// @param path - the path to the SPIR-V binary.
|
|
/// @param out - may be a `nullptr`. In this case, `false` is returned.
|
|
/// @return `true` if successful and `false` otherwise.
|
|
bool ReadBinary(const std::string& path, std::vector<uint32_t>* out);
|
|
|
|
/// Writes `binary` into `path`.
|
|
///
|
|
/// @param path - the path to write `binary` to.
|
|
/// @param binary - SPIR-V binary.
|
|
/// @return whether the operation was successful.
|
|
bool WriteBinary(const std::string& path, const std::vector<uint32_t>& binary);
|
|
|
|
} // namespace util
|
|
} // namespace spvtools_fuzzer
|
|
} // namespace fuzzers
|
|
} // namespace tint
|
|
|
|
#endif // FUZZERS_TINT_SPIRV_TOOLS_FUZZER_UTIL_H_
|