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 LIBSPIRV_OPT_IR_LOADER_H_ 2811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define LIBSPIRV_OPT_IR_LOADER_H_ 2911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 3011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include <memory> 3111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 3211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include "basic_block.h" 3311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include "instruction.h" 3411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include "module.h" 3511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include "spirv-tools/libspirv.h" 3611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 3711cd02dfb91661c65134cac258cf5924270e9d2Dan Albertnamespace spvtools { 3811cd02dfb91661c65134cac258cf5924270e9d2Dan Albertnamespace ir { 3911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 4011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// Loader class for constructing SPIR-V in-memory IR representation. Methods in 4111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// this class are designed to work with the interface for spvBinaryParse() in 4211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// libspirv.h so that we can leverage the syntax checks implemented behind it. 4311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// 4411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// The user is expected to call SetModuleHeader() to fill in the module's 4511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// header, and then AddInstruction() for each decoded instruction, and finally 4611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// EndModule() to finalize the module. The instructions processed in sequence 4711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert// by AddInstruction() should comprise a valid SPIR-V module. 4811cd02dfb91661c65134cac258cf5924270e9d2Dan Albertclass IrLoader { 4911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert public: 5011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Instantiates a builder to construct the given |module| gradually. 5111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert IrLoader(Module* module) : module_(module) {} 5211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 5311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Sets the fields in the module's header to the given parameters. 5411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert void SetModuleHeader(uint32_t magic, uint32_t version, uint32_t generator, 5511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert uint32_t bound, uint32_t reserved) { 5611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert module_->SetHeader({magic, version, generator, bound, reserved}); 5711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert } 5811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Adds an instruction to the module. This method will properly capture and 5911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // store the data provided in |inst| so that |inst| is no longer needed after 6011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // returning. 6111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert void AddInstruction(const spv_parsed_instruction_t* inst); 6211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Finalizes the module construction. This must be called after the module 6311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // header has been set and all instructions have been added. 6411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Resolves internal bookkeeping. 6511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert void EndModule(); 6611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 6711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert private: 6811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // The module to be built. 6911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert Module* module_; 7011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // The current Function under construction. 7111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert std::unique_ptr<Function> function_; 7211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // The current BasicBlock under construction. 7311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert std::unique_ptr<BasicBlock> block_; 7411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert // Line related debug instructions accumulated thus far. 7511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert std::vector<Instruction> dbg_line_info_; 7611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert}; 7711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 7811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert} // namespace ir 7911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert} // namespace spvtools 8011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert 8111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#endif // LIBSPIRV_OPT_IR_LOADER_H_ 82