mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2024-12-25 01:01:04 +00:00
7183ad526e
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
84 lines
3.0 KiB
C++
84 lines
3.0 KiB
C++
// Copyright (c) 2017 Pierre Moreau
|
|
//
|
|
// 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 SPIRV_TOOLS_LINKER_HPP_
|
|
#define SPIRV_TOOLS_LINKER_HPP_
|
|
|
|
#include <cstdint>
|
|
|
|
#include <memory>
|
|
#include <vector>
|
|
|
|
#include "libspirv.hpp"
|
|
|
|
namespace spvtools {
|
|
|
|
class LinkerOptions {
|
|
public:
|
|
LinkerOptions() : create_library_(false), verify_ids_(false) {}
|
|
|
|
// Returns whether a library or an executable should be produced by the
|
|
// linking phase.
|
|
//
|
|
// All exported symbols are kept when creating a library, whereas they will
|
|
// be removed when creating an executable.
|
|
// The returned value will be true if creating a library, and false if
|
|
// creating an executable.
|
|
bool GetCreateLibrary() const { return create_library_; }
|
|
|
|
// Sets whether a library or an executable should be produced.
|
|
void SetCreateLibrary(bool create_library) {
|
|
create_library_ = create_library;
|
|
}
|
|
|
|
// Returns whether to verify the uniqueness of the unique ids in the merged
|
|
// context.
|
|
bool GetVerifyIds() const { return verify_ids_; }
|
|
|
|
// Sets whether to verify the uniqueness of the unique ids in the merged
|
|
// context.
|
|
void SetVerifyIds(bool verify_ids) { verify_ids_ = verify_ids; }
|
|
|
|
private:
|
|
bool create_library_;
|
|
bool verify_ids_;
|
|
};
|
|
|
|
// Links one or more SPIR-V modules into a new SPIR-V module. That is, combine
|
|
// several SPIR-V modules into one, resolving link dependencies between them.
|
|
//
|
|
// At least one binary has to be provided in |binaries|. Those binaries do not
|
|
// have to be valid, but they should be at least parseable.
|
|
// The functions can fail due to the following:
|
|
// * The given context was not initialised using `spvContextCreate()`;
|
|
// * No input modules were given;
|
|
// * One or more of those modules were not parseable;
|
|
// * The input modules used different addressing or memory models;
|
|
// * The ID or global variable number limit were exceeded;
|
|
// * Some entry points were defined multiple times;
|
|
// * Some imported symbols did not have an exported counterpart;
|
|
// * Possibly other reasons.
|
|
spv_result_t Link(const Context& context,
|
|
const std::vector<std::vector<uint32_t>>& binaries,
|
|
std::vector<uint32_t>* linked_binary,
|
|
const LinkerOptions& options = LinkerOptions());
|
|
spv_result_t Link(const Context& context, const uint32_t* const* binaries,
|
|
const size_t* binary_sizes, size_t num_binaries,
|
|
std::vector<uint32_t>* linked_binary,
|
|
const LinkerOptions& options = LinkerOptions());
|
|
|
|
} // namespace spvtools
|
|
|
|
#endif // SPIRV_TOOLS_LINKER_HPP_
|