// 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. #include "fuzzers/tint_common_fuzzer.h" #include #include #include #include #include #include #if TINT_BUILD_SPV_READER #include "spirv-tools/libspirv.hpp" #endif // TINT_BUILD_SPV_READER #include "src/ast/module.h" #include "src/diagnostic/formatter.h" #include "src/program.h" namespace tint { namespace fuzzers { namespace { [[noreturn]] void FatalError(const tint::diag::List& diags, const std::string& msg = "") { auto printer = tint::diag::Printer::create(stderr, true); if (!msg.empty()) { printer->write(msg + "\n", {diag::Color::kRed, true}); } tint::diag::Formatter().format(diags, printer.get()); __builtin_trap(); } [[noreturn]] void TintInternalCompilerErrorReporter( const tint::diag::List& diagnostics) { FatalError(diagnostics); } transform::VertexAttributeDescriptor ExtractVertexAttributeDescriptor( Reader* r) { transform::VertexAttributeDescriptor desc{}; desc.format = r->enum_class( static_cast(transform::VertexFormat::kLastEntry) + 1); desc.offset = r->read(); desc.shader_location = r->read(); return desc; } transform::VertexBufferLayoutDescriptor ExtractVertexBufferLayoutDescriptor( Reader* r) { transform::VertexBufferLayoutDescriptor desc; desc.array_stride = r->read(); desc.step_mode = r->enum_class( static_cast(transform::InputStepMode::kLastEntry) + 1); desc.attributes = r->vector(ExtractVertexAttributeDescriptor); return desc; } bool SPIRVToolsValidationCheck(const tint::Program& program, const std::vector& spirv) { spvtools::SpirvTools tools(SPV_ENV_VULKAN_1_1); const tint::diag::List& diags = program.Diagnostics(); tools.SetMessageConsumer([diags](spv_message_level_t, const char*, const spv_position_t& pos, const char* msg) { std::stringstream out; out << "Unexpected spirv-val error:\n" << (pos.line + 1) << ":" << (pos.column + 1) << ": " << msg << std::endl; auto printer = tint::diag::Printer::create(stderr, true); printer->write(out.str(), {diag::Color::kYellow, false}); tint::diag::Formatter().format(diags, printer.get()); }); return tools.Validate(spirv.data(), spirv.size(), spvtools::ValidatorOptions()); } } // namespace Reader::Reader(const uint8_t* data, size_t size) : data_(data), size_(size) {} std::string Reader::string() { auto count = read(); if (failed_ || size_ < count) { mark_failed(); return ""; } std::string out(data_, data_ + count); data_ += count; size_ -= count; return out; } void Reader::mark_failed() { size_ = 0; failed_ = true; } void Reader::read(void* out, size_t n) { if (n > size_) { mark_failed(); return; } memcpy(&out, data_, n); data_ += n; size_ -= n; } void ExtractBindingRemapperInputs(Reader* r, tint::transform::DataMap* inputs) { struct Config { uint8_t old_group; uint8_t old_binding; uint8_t new_group; uint8_t new_binding; ast::Access new_access; }; std::vector configs = r->vector(); transform::BindingRemapper::BindingPoints binding_points; transform::BindingRemapper::AccessControls accesses; for (const auto& config : configs) { binding_points[{config.old_binding, config.old_group}] = { config.new_binding, config.new_group}; accesses[{config.old_binding, config.old_group}] = config.new_access; } inputs->Add(binding_points, accesses); } void ExtractFirstIndexOffsetInputs(Reader* r, tint::transform::DataMap* inputs) { struct Config { uint32_t group; uint32_t binding; }; Config config = r->read(); inputs->Add(config.binding, config.group); } void ExtractSingleEntryPointInputs(Reader* r, tint::transform::DataMap* inputs) { std::string input = r->string(); transform::SingleEntryPoint::Config cfg(input); inputs->Add(cfg); } void ExtractVertexPullingInputs(Reader* r, tint::transform::DataMap* inputs) { transform::VertexPulling::Config cfg; cfg.entry_point_name = r->string(); cfg.vertex_state = r->vector(ExtractVertexBufferLayoutDescriptor); cfg.pulling_group = r->read(); inputs->Add(cfg); } CommonFuzzer::CommonFuzzer(InputFormat input, OutputFormat output) : input_(input), output_(output), transform_manager_(nullptr), inspector_enabled_(false) {} CommonFuzzer::~CommonFuzzer() = default; int CommonFuzzer::Run(const uint8_t* data, size_t size) { tint::SetInternalCompilerErrorReporter(&TintInternalCompilerErrorReporter); Program program; #if TINT_BUILD_WGSL_READER std::unique_ptr file; #endif // TINT_BUILD_WGSL_READER #if TINT_BUILD_SPV_READER std::vector spirv_input(size / sizeof(uint32_t)); std::memcpy(spirv_input.data(), data, size); #endif // TINT_BUILD_SPV_READER switch (input_) { #if TINT_BUILD_WGSL_READER case InputFormat::kWGSL: { std::string str(reinterpret_cast(data), size); file = std::make_unique("test.wgsl", str); program = reader::wgsl::Parse(file.get()); break; } #endif // TINT_BUILD_WGSL_READER #if TINT_BUILD_SPV_READER case InputFormat::kSpv: { if (!spirv_input.empty()) { program = reader::spirv::Parse(spirv_input); } break; } #endif // TINT_BUILD_SPV_READER default: return 0; } if (output_ == OutputFormat::kNone) { return 0; } if (!program.IsValid()) { errors_ = diag::Formatter().format(program.Diagnostics()); return 0; } #if TINT_BUILD_SPV_READER if (input_ == InputFormat::kSpv && !SPIRVToolsValidationCheck(program, spirv_input)) { FatalError(program.Diagnostics(), "Fuzzing detected invalid input spirv not being caught by Tint"); } #endif // TINT_BUILD_SPV_READER if (inspector_enabled_) { inspector::Inspector inspector(&program); auto entry_points = inspector.GetEntryPoints(); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } for (auto& ep : entry_points) { auto remapped_name = inspector.GetRemappedNameForEntryPoint(ep.name); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } auto constant_ids = inspector.GetConstantIDs(); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } auto uniform_bindings = inspector.GetUniformBufferResourceBindings(ep.name); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } auto storage_bindings = inspector.GetStorageBufferResourceBindings(ep.name); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } auto readonly_bindings = inspector.GetReadOnlyStorageBufferResourceBindings(ep.name); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } auto sampler_bindings = inspector.GetSamplerResourceBindings(ep.name); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } auto comparison_sampler_bindings = inspector.GetComparisonSamplerResourceBindings(ep.name); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } auto sampled_texture_bindings = inspector.GetSampledTextureResourceBindings(ep.name); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } auto multisampled_texture_bindings = inspector.GetMultisampledTextureResourceBindings(ep.name); if (inspector.has_error()) { errors_ = inspector.error(); return 0; } } } if (transform_manager_) { auto out = transform_manager_->Run(&program, transform_inputs_); if (!out.program.IsValid()) { // Transforms can produce error messages for bad input. // Catch ICEs and errors from non transform systems. for (const auto& diag : out.program.Diagnostics()) { if (diag.severity > diag::Severity::Error || diag.system != diag::System::Transform) { FatalError(out.program.Diagnostics(), "Fuzzing detected valid input program being transformed " "into an invalid output program"); } } } program = std::move(out.program); } switch (output_) { case OutputFormat::kWGSL: { #if TINT_BUILD_WGSL_WRITER writer::wgsl::Options options; auto result = writer::wgsl::Generate(&program, options); generated_wgsl_ = std::move(result.wgsl); if (!result.success) { FatalError(program.Diagnostics(), "WGSL writer failed: " + result.error); } #endif // TINT_BUILD_WGSL_WRITER break; } case OutputFormat::kSpv: { #if TINT_BUILD_SPV_WRITER writer::spirv::Options options; auto result = writer::spirv::Generate(&program, options); generated_spirv_ = std::move(result.spirv); if (!result.success) { FatalError(program.Diagnostics(), "SPIR-V writer failed: " + result.error); } if (!SPIRVToolsValidationCheck(program, generated_spirv_)) { FatalError(program.Diagnostics(), "Fuzzing detected invalid spirv being emitted by Tint"); } #endif // TINT_BUILD_SPV_WRITER break; } case OutputFormat::kHLSL: { #if TINT_BUILD_HLSL_WRITER writer::hlsl::Options options; auto result = writer::hlsl::Generate(&program, options); generated_hlsl_ = std::move(result.hlsl); if (!result.success) { FatalError(program.Diagnostics(), "HLSL writer failed: " + result.error); } #endif // TINT_BUILD_HLSL_WRITER break; } case OutputFormat::kMSL: { #if TINT_BUILD_MSL_WRITER writer::msl::Options options; auto result = writer::msl::Generate(&program, options); generated_msl_ = std::move(result.msl); if (!result.success) { FatalError(program.Diagnostics(), "MSL writer failed: " + result.error); } #endif // TINT_BUILD_MSL_WRITER break; } case OutputFormat::kNone: break; } return 0; } } // namespace fuzzers } // namespace tint