src/tint/lang/spirv/validate/validate.cc

// Copyright 2023 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include "src/tint/lang/spirv/validate/validate.h"

#include <memory>
#include <string>
#include <utility>

#include "spirv-tools/libspirv.hpp"

namespace tint::spirv::validate {

Result<SuccessType> Validate(Slice<const uint32_t> spirv, spv_target_env target_env) {
    Vector<diag::Diagnostic, 4> diags;
    diags.Push(diag::Diagnostic{});  // Filled in on error

    spvtools::SpirvTools tools(target_env);
    tools.SetMessageConsumer(
        [&](spv_message_level_t level, const char*, const spv_position_t& pos, const char* msg) {
            diag::Diagnostic diag;
            diag.message = msg;
            diag.source.range.begin.line = static_cast<uint32_t>(pos.line) + 1;
            diag.source.range.begin.column = static_cast<uint32_t>(pos.column) + 1;
            diag.source.range.end = diag.source.range.begin;
            switch (level) {
                case SPV_MSG_FATAL:
                case SPV_MSG_INTERNAL_ERROR:
                case SPV_MSG_ERROR:
                    diag.severity = diag::Severity::Error;
                    break;
                case SPV_MSG_WARNING:
                    diag.severity = diag::Severity::Warning;
                    break;
                case SPV_MSG_INFO:
                case SPV_MSG_DEBUG:
                    diag.severity = diag::Severity::Note;
                    break;
            }
            diags.Push(std::move(diag));
        });

    // Don't prepare to emit friendly names. The preparation costs
    // time by scanning the whole module and building a string table.
    spvtools::ValidatorOptions val_opts;
    val_opts.SetFriendlyNames(false);

    if (tools.Validate(spirv.data, spirv.len, val_opts)) {
        return Success;
    }

    std::string disassembly;
    if (tools.Disassemble(
            spirv.data, spirv.len, &disassembly,
            SPV_BINARY_TO_TEXT_OPTION_INDENT | SPV_BINARY_TO_TEXT_OPTION_FRIENDLY_NAMES)) {
        diag::Diagnostic& err = diags.Front();
        err.message = "SPIR-V failed validation.\n\nDisassembly:\n" + std::move(disassembly);
        err.severity = diag::Severity::Error;
    } else {
        diag::Diagnostic& err = diags.Front();
        err.message = "SPIR-V failed validation and disassembly\n";
        err.severity = diag::Severity::Error;
    }
    auto file = std::make_shared<Source::File>("spirv", disassembly);
    for (auto& diag : diags) {
        diag.source.file = file.get();
        diag.owned_file = file;
    }
    return Failure{diag::List{std::move(diags)}};
}

}  // namespace tint::spirv::validate