SPIRV-Tools/source/libspirv.cpp

172 lines
5.9 KiB
C++
Raw Normal View History

// Copyright (c) 2016 Google 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.
2016-09-16 20:12:04 +00:00
#include "spirv-tools/libspirv.hpp"
#include <cassert>
#include <iostream>
#include <string>
#include <utility>
#include <vector>
#include "source/table.h"
namespace spvtools {
Linker code cleanups Turn `Linker::Link()` into free functions As very little information was kept in the Linker class, we can get rid of the whole class and have the `Link()` as free functions instead; the environment target as well as the consumer are passed along through an `spv_context` object. The resulting linked_binary is passed as a pointer rather than a reference to follow the Google C++ Style guidelines. Addresses remaining comments from https://github.com/KhronosGroup/SPIRV-Tools/pull/693 about the SPIR-V linker. Fix variable naming in the linker Some of the variables were using mixed case, which did not follow the Google C++ Style guidelines. Linker: Use EXPECT_EQ when possible and update some test * Replace occurrences of ASSERT_EQ by EXPECT_EQ when possible; * Reformulated some of the error messages; * Added the symbol name in the error message when there is a type or decoration mismatch between the imported and exported declarations. Opt: List all duplicates removed by RemoveDuplicatePass in the header Opt: Make the const version of GetLabelInst() return a pointer For consistency with the non-const version, as well as other similar functions. Opt: Rename function_end to EndInst() As pointed out by dneto0 the previous name was quite confusing and could be mistaken with a function returning an end iterator. Also change the return type of the const version to a pointer rather than a reference, for consistency. Opt: Add performance comment to RemoveDuplicateTypes and decorations This comment was requested during the review of https://github.com/KhronosGroup/SPIRV-Tools/pull/693. Opt: Add comments and fix variable naming in RemoveDuplicatePass * Add missing comments to private functions; * Rename variables that were using mixed case; * Add TODO for moving AreTypesEqual out. Linker: Remove commented out code and add TODOs Linker: Merged together strings that were too much splitted Implement a C++ RAII wrapper around spv_context
2018-01-03 00:54:55 +00:00
Context::Context(spv_target_env env) : context_(spvContextCreate(env)) {}
Context::Context(Context&& other) : context_(other.context_) {
other.context_ = nullptr;
}
Context& Context::operator=(Context&& other) {
spvContextDestroy(context_);
context_ = other.context_;
other.context_ = nullptr;
return *this;
}
Context::~Context() { spvContextDestroy(context_); }
void Context::SetMessageConsumer(MessageConsumer consumer) {
SetContextMessageConsumer(context_, std::move(consumer));
Linker code cleanups Turn `Linker::Link()` into free functions As very little information was kept in the Linker class, we can get rid of the whole class and have the `Link()` as free functions instead; the environment target as well as the consumer are passed along through an `spv_context` object. The resulting linked_binary is passed as a pointer rather than a reference to follow the Google C++ Style guidelines. Addresses remaining comments from https://github.com/KhronosGroup/SPIRV-Tools/pull/693 about the SPIR-V linker. Fix variable naming in the linker Some of the variables were using mixed case, which did not follow the Google C++ Style guidelines. Linker: Use EXPECT_EQ when possible and update some test * Replace occurrences of ASSERT_EQ by EXPECT_EQ when possible; * Reformulated some of the error messages; * Added the symbol name in the error message when there is a type or decoration mismatch between the imported and exported declarations. Opt: List all duplicates removed by RemoveDuplicatePass in the header Opt: Make the const version of GetLabelInst() return a pointer For consistency with the non-const version, as well as other similar functions. Opt: Rename function_end to EndInst() As pointed out by dneto0 the previous name was quite confusing and could be mistaken with a function returning an end iterator. Also change the return type of the const version to a pointer rather than a reference, for consistency. Opt: Add performance comment to RemoveDuplicateTypes and decorations This comment was requested during the review of https://github.com/KhronosGroup/SPIRV-Tools/pull/693. Opt: Add comments and fix variable naming in RemoveDuplicatePass * Add missing comments to private functions; * Rename variables that were using mixed case; * Add TODO for moving AreTypesEqual out. Linker: Remove commented out code and add TODOs Linker: Merged together strings that were too much splitted Implement a C++ RAII wrapper around spv_context
2018-01-03 00:54:55 +00:00
}
spv_context& Context::CContext() { return context_; }
const spv_context& Context::CContext() const { return context_; }
// Structs for holding the data members for SpvTools.
2016-09-16 19:56:30 +00:00
struct SpirvTools::Impl {
explicit Impl(spv_target_env env) : context(spvContextCreate(env)) {
// The default consumer in spv_context_t is a null consumer, which provides
// equivalent functionality (from the user's perspective) as a real consumer
// does nothing.
}
~Impl() { spvContextDestroy(context); }
spv_context context; // C interface context object.
};
SpirvTools::SpirvTools(spv_target_env env) : impl_(new Impl(env)) {
assert(env != SPV_ENV_WEBGPU_0);
}
2016-09-16 19:56:30 +00:00
SpirvTools::~SpirvTools() {}
2016-09-16 19:56:30 +00:00
void SpirvTools::SetMessageConsumer(MessageConsumer consumer) {
SetContextMessageConsumer(impl_->context, std::move(consumer));
}
2016-09-16 19:56:30 +00:00
bool SpirvTools::Assemble(const std::string& text,
std::vector<uint32_t>* binary,
uint32_t options) const {
return Assemble(text.data(), text.size(), binary, options);
}
bool SpirvTools::Assemble(const char* text, const size_t text_size,
std::vector<uint32_t>* binary,
uint32_t options) const {
spv_binary spvbinary = nullptr;
spv_result_t status = spvTextToBinaryWithOptions(
impl_->context, text, text_size, options, &spvbinary, nullptr);
if (status == SPV_SUCCESS) {
binary->assign(spvbinary->code, spvbinary->code + spvbinary->wordCount);
}
spvBinaryDestroy(spvbinary);
return status == SPV_SUCCESS;
}
2016-09-16 19:56:30 +00:00
bool SpirvTools::Disassemble(const std::vector<uint32_t>& binary,
std::string* text, uint32_t options) const {
return Disassemble(binary.data(), binary.size(), text, options);
}
bool SpirvTools::Disassemble(const uint32_t* binary, const size_t binary_size,
std::string* text, uint32_t options) const {
spv_text spvtext = nullptr;
spv_result_t status = spvBinaryToText(impl_->context, binary, binary_size,
options, &spvtext, nullptr);
if (status == SPV_SUCCESS &&
(options & SPV_BINARY_TO_TEXT_OPTION_PRINT) == 0) {
assert(spvtext);
text->assign(spvtext->str, spvtext->str + spvtext->length);
}
spvTextDestroy(spvtext);
return status == SPV_SUCCESS;
}
struct CxxParserContext {
const HeaderParser& header_parser;
const InstructionParser& instruction_parser;
};
bool SpirvTools::Parse(const std::vector<uint32_t>& binary,
const HeaderParser& header_parser,
const InstructionParser& instruction_parser,
spv_diagnostic* diagnostic) {
CxxParserContext parser_context = {header_parser, instruction_parser};
spv_parsed_header_fn_t header_fn_wrapper =
[](void* user_data, spv_endianness_t endianness, uint32_t magic,
uint32_t version, uint32_t generator, uint32_t id_bound,
uint32_t reserved) {
CxxParserContext* ctx = reinterpret_cast<CxxParserContext*>(user_data);
spv_parsed_header_t header = {magic, version, generator, id_bound,
reserved};
return ctx->header_parser(endianness, header);
};
spv_parsed_instruction_fn_t instruction_fn_wrapper =
[](void* user_data, const spv_parsed_instruction_t* instruction) {
CxxParserContext* ctx = reinterpret_cast<CxxParserContext*>(user_data);
return ctx->instruction_parser(*instruction);
};
spv_result_t status = spvBinaryParse(
impl_->context, &parser_context, binary.data(), binary.size(),
header_fn_wrapper, instruction_fn_wrapper, diagnostic);
return status == SPV_SUCCESS;
}
2016-09-16 19:56:30 +00:00
bool SpirvTools::Validate(const std::vector<uint32_t>& binary) const {
return Validate(binary.data(), binary.size());
}
bool SpirvTools::Validate(const uint32_t* binary,
const size_t binary_size) const {
return spvValidateBinary(impl_->context, binary, binary_size, nullptr) ==
SPV_SUCCESS;
}
bool SpirvTools::Validate(const uint32_t* binary, const size_t binary_size,
spv_validator_options options) const {
spv_const_binary_t the_binary{binary, binary_size};
spv_diagnostic diagnostic = nullptr;
bool valid = spvValidateWithOptions(impl_->context, options, &the_binary,
&diagnostic) == SPV_SUCCESS;
if (!valid && impl_->context->consumer) {
impl_->context->consumer.operator()(
SPV_MSG_ERROR, nullptr, diagnostic->position, diagnostic->error);
}
spvDiagnosticDestroy(diagnostic);
return valid;
}
bool SpirvTools::IsValid() const { return impl_->context != nullptr; }
} // namespace spvtools