111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// Copyright (c) 2016 Google Inc. 211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// 311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// Permission is hereby granted, free of charge, to any person obtaining a 411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// copy of this software and/or associated documentation files (the 511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// "Materials"), to deal in the Materials without restriction, including 611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// without limitation the rights to use, copy, modify, merge, publish, 711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// distribute, sublicense, and/or sell copies of the Materials, and to 811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// permit persons to whom the Materials are furnished to do so, subject to 911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// the following conditions: 1011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// 1111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// The above copyright notice and this permission notice shall be included 1211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// in all copies or substantial portions of the Materials. 1311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// 1411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS 1511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// KHRONOS STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS 1611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// SPECIFICATIONS AND HEADER INFORMATION ARE LOCATED AT 1711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// https://www.khronos.org/registry/ 1811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// 1911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 2011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 2111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 2211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 2311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 2411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 2511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS. 2611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 2711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#ifndef SPIRV_TOOLS_LIBSPIRV_HPP_ 2811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define SPIRV_TOOLS_LIBSPIRV_HPP_ 2911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 3011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include <memory> 3111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include <string> 3211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include <vector> 3311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 3411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include "module.h" 3511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include "spirv-tools/libspirv.h" 3611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 3711cd02dfb91661c65134cac258cf5924270e9d2Dan Albertnamespace spvtools { 3811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 3911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// C++ interface for SPIRV-Tools functionalities. It wraps the context 4011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// (including target environment and the corresponding SPIR-V grammar) and 4111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// provides methods for assembling, disassembling, validating, and optimizing. 4211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// 4311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// Instances of this class are thread-safe. 4411cd02dfb91661c65134cac258cf5924270e9d2Dan Albertclass SpvTools { 4511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert public: 4611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Creates an instance targeting the given environment |env|. 4711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert SpvTools(spv_target_env env) : context_(spvContextCreate(env)) {} 4811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 4911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert ~SpvTools() { spvContextDestroy(context_); } 5011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 5111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // TODO(antiagainst): handle error message in the following APIs. 5211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 5311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Assembles the given assembly |text| and writes the result to |binary|. 5411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Returns SPV_SUCCESS on successful assembling. 5511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert spv_result_t Assemble(const std::string& text, std::vector<uint32_t>* binary); 5611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 5711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Disassembles the given SPIR-V |binary| and returns the assembly. Returns 5811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // SPV_SUCCESS on successful disassembling. 5911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert spv_result_t Disassemble(const std::vector<uint32_t>& binary, 6011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert std::string* text); 6111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 6211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Builds and returns a Module from the given SPIR-V |binary|. 6311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert std::unique_ptr<ir::Module> BuildModule(const std::vector<uint32_t>& binary); 6411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 6511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Builds and returns a Module from the given SPIR-V assembly |text|. 6611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert std::unique_ptr<ir::Module> BuildModule(const std::string& text); 6711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 6811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert private: 6911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Context for the current invocation. Thread-safety of this class depends on 7011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // the constness of this field. 7111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert spv_context context_; 7211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert}; 7311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 7411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert} // namespace spvtools 7511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 7611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#endif // SPIRV_TOOLS_LIBSPIRV_HPP_ 77