+/**
+A shader module in SPIR-V binary format.
+
+When the module's contents are set from GLSL source, it will be automatically
+compiled to SPIR-V. Pre-compiled SPIR-V modules can also be loaded.
+
+Afterwards reflection data is available, providing information about variables
+forming the module's interface.
+*/
+class SpirVModule: public Module, public SpirVModuleBackend
+{
+ friend SpirVModuleBackend;
+
+public:
+ enum Stage
+ {
+ VERTEX = 0,
+ GEOMETRY = 3,
+ FRAGMENT = 4
+ };
+
+ enum StorageClass
+ {
+ UNIFORM_CONSTANT = 0,
+ INPUT = 1,
+ UNIFORM = 2,
+ OUTPUT = 3,
+ PUSH_CONSTANT = 9
+ };
+
+ enum BuiltinSemantic
+ {
+ NOT_BUILTIN = -1,
+ POSITION = 0,
+ CLIP_DISTANCE = 3,
+ LAYER = 9,
+ FRAG_DEPTH = 22
+ };
+
+ struct Constant;
+ struct Structure;
+ struct Variable;
+
+ struct EntryPoint
+ {
+ std::string name;
+ unsigned id = 0;
+ Stage stage = VERTEX;
+ std::vector<const Variable *> globals;
+ };
+
+ struct StructMember
+ {
+ std::string name;
+ DataType type = VOID;
+ const Structure *struct_type = 0;
+ unsigned offset = 0;
+ unsigned array_size = 0;
+ unsigned array_stride = 0;
+ unsigned matrix_stride = 0;
+ BuiltinSemantic builtin = NOT_BUILTIN;
+ };
+
+ struct Structure
+ {
+ std::string name;
+ unsigned id = 0;
+ unsigned size = 0;
+ std::vector<StructMember> members;
+ };
+
+ struct Variable
+ {
+ std::string name;
+ unsigned id = 0;
+ DataType type = VOID;
+ const Structure *struct_type = 0;
+ StorageClass storage = static_cast<StorageClass>(-1);
+ unsigned array_size = 0;
+ int location = -1;
+ unsigned descriptor_set = 0;
+ int binding = -1;
+ BuiltinSemantic builtin = NOT_BUILTIN;
+
+ bool operator==(const Variable &) const;
+ };
+
+ struct Constant
+ {
+ std::string name;
+ unsigned id = 0;
+ int constant_id = -1;
+ DataType type = VOID;
+ union
+ {
+ int i_value = 0;
+ float f_value;
+ };
+ };
+
+ struct InstructionBlock
+ {
+ unsigned id = 0;
+ bool negate_condition = false;
+ const Constant *condition = 0;
+ std::vector<const Variable *> accessed_variables;
+ std::vector<const InstructionBlock *> successors;
+ };
+
+private:
+ struct TypeInfo
+ {
+ DataType type = VOID;
+ const Structure *struct_type = 0;
+ unsigned array_size = 0;
+ unsigned array_stride = 0;
+ StorageClass storage = static_cast<StorageClass>(-1);
+ };
+
+ struct Reflection
+ {
+ typedef std::vector<std::uint32_t>::const_iterator CodeIterator;
+
+ std::map<unsigned, std::string> names;
+ std::map<unsigned, Constant> constants;
+ std::map<unsigned, TypeInfo> types;
+ std::map<unsigned, EntryPoint> entry_points;
+ std::map<unsigned, Structure> structs;
+ std::map<unsigned, Variable> variables;
+ std::map<unsigned, InstructionBlock> blocks;
+ std::map<unsigned, unsigned> access_chain_bases;
+ Constant true_condition;
+ InstructionBlock *current_block = 0;
+
+ static std::uint32_t get_opcode(std::uint32_t);
+ static CodeIterator get_op_end(const CodeIterator &);
+ static std::string read_string(CodeIterator &, const CodeIterator &);
+
+ void reflect_code(const std::vector<std::uint32_t> &);
+ void reflect_name(CodeIterator);
+ void reflect_member_name(CodeIterator);
+ void reflect_entry_point(CodeIterator);
+ void reflect_void_type(CodeIterator);
+ void reflect_bool_type(CodeIterator);
+ void reflect_int_type(CodeIterator);
+ void reflect_float_type(CodeIterator);
+ void reflect_vector_type(CodeIterator);
+ void reflect_matrix_type(CodeIterator);
+ void reflect_image_type(CodeIterator);
+ void reflect_sampled_image_type(CodeIterator);
+ void reflect_array_type(CodeIterator);
+ void reflect_struct_type(CodeIterator);
+ void reflect_pointer_type(CodeIterator);
+ void reflect_constant(CodeIterator);
+ void reflect_variable(CodeIterator);
+ void reflect_access(CodeIterator);
+ void reflect_access_chain(CodeIterator);
+ void reflect_decorate(CodeIterator);
+ void reflect_member_decorate(CodeIterator);
+ void reflect_label(CodeIterator);
+ void reflect_branch(CodeIterator);
+ void reflect_branch_conditional(CodeIterator);
+ };
+
+ std::vector<std::uint32_t> code;
+ std::vector<EntryPoint> entry_points;
+ std::vector<Structure> structs;
+ std::vector<Variable> variables;
+ std::vector<Constant> spec_constants;
+ std::vector<InstructionBlock> blocks;
+ bool specializable = false;
+
+public:
+ virtual Format get_format() const { return SPIR_V; }
+
+ /** Loads a SPIR-V binary from a file or other I/O object. */
+ void load_code(IO::Base &);
+private:
+ virtual void compile(SL::Compiler &);
+ void reflect();
+
+public:
+ const std::vector<std::uint32_t> &get_code() const { return code; }
+ const std::vector<EntryPoint> &get_entry_points() const { return entry_points; }
+ const std::vector<Variable> &get_variables() const { return variables; }
+ const std::vector<Constant> &get_spec_constants() const { return spec_constants; }
+ const std::vector<InstructionBlock> &get_blocks() const { return blocks; }
+ bool is_specializable() const { return specializable; }
+
+ /** Creates a new module which is a specialized version of this one. */
+ SpirVModule *specialize(const std::map<std::string, int> &) const;
+
+private:
+ std::vector<const InstructionBlock *> collect_visited_blocks(const std::map<unsigned, int> &) const;
+ void collect_visited_blocks(unsigned, std::vector<std::uint8_t> &) const;
+
+public:
+ void set_debug_name(const std::string &n) { SpirVModuleBackend::set_debug_name(n); }
+};
+