]> git.tdb.fi Git - libs/gl.git/blobdiff - source/core/module.cpp
Add support for loading SPIR-V shaders
[libs/gl.git] / source / core / module.cpp
index 74e886b06bcc06895cedcd9b0b77b00e5f0bc783..5287ae9c2ec369bbdfcf80242c738e4e2fdc75cf 100644 (file)
@@ -4,6 +4,44 @@
 
 using namespace std;
 
+enum SpirVConstants
+{
+       SPIRV_MAGIC = 0x07230203,
+       SPIRV_MAGIC_REVERSED = 0x03022307,
+
+       OP_NAME = 5,
+       OP_MEMBER_NAME = 6,
+       OP_ENTRY_POINT = 15,
+       OP_TYPE_VOID = 19,
+       OP_TYPE_BOOL = 20,
+       OP_TYPE_INT = 21,
+       OP_TYPE_FLOAT = 22,
+       OP_TYPE_VECTOR = 23,
+       OP_TYPE_MATRIX = 24,
+       OP_TYPE_IMAGE = 25,
+       OP_TYPE_SAMPLED_IMAGE = 27,
+       OP_TYPE_ARRAY = 28,
+       OP_TYPE_STRUCT = 30,
+       OP_TYPE_POINTER = 32,
+       OP_CONSTANT_TRUE = 41,
+       OP_CONSTANT_FALSE = 42,
+       OP_CONSTANT = 43,
+       OP_SPEC_CONSTANT_TRUE = 48,
+       OP_SPEC_CONSTANT_FALSE = 49,
+       OP_SPEC_CONSTANT = 50,
+       OP_VARIABLE = 59,
+       OP_DECORATE = 71,
+       OP_MEMBER_DECORATE = 72,
+
+       DECO_SPEC_ID = 1,
+       DECO_ARRAY_STRIDE = 6,
+       DECO_MATRIX_STRIDE = 7,
+       DECO_LOCATION = 30,
+       DECO_BINDING = 33,
+       DECO_DESCRIPTOR_SET = 34,
+       DECO_OFFSET = 35
+};
+
 namespace Msp {
 namespace GL {
 
@@ -39,5 +77,474 @@ void GlslModule::compile(SL::Compiler &compiler)
 #endif
 }
 
+
+SpirVModule::SpirVModule(const SpirVModule &other):
+       code(other.code),
+       entry_points(other.entry_points),
+       structs(other.structs),
+       variables(other.variables)
+{
+       remap_pointers_from(other);
+}
+
+SpirVModule &SpirVModule::operator=(const SpirVModule &other)
+{
+       code = other.code;
+       entry_points = other.entry_points;
+       structs = other.structs;
+       variables = other.variables;
+       remap_pointers_from(other);
+       return *this;
+}
+
+void SpirVModule::remap_pointers_from(const SpirVModule &other)
+{
+       for(vector<EntryPoint>::iterator i=entry_points.begin(); i!=entry_points.end(); ++i)
+               for(vector<const Variable *>::iterator j=i->globals.begin(); j!=i->globals.end(); ++j)
+                       *j = &variables[*j-&other.variables.front()];
+
+       for(vector<Variable>::iterator i=variables.begin(); i!=variables.end(); ++i)
+               if(i->struct_type)
+                       i->struct_type = &structs[i->struct_type-&other.structs.front()];
+
+       for(vector<Structure>::iterator i=structs.begin(); i!=structs.end(); ++i)
+               for(vector<StructMember>::iterator j=i->members.begin(); j!=i->members.end(); ++j)
+                       if(j->struct_type)
+                               j->struct_type = &structs[j->struct_type-&other.structs.front()];
+}
+
+void SpirVModule::load_code(IO::Base &io)
+{
+       UInt32 buffer[1024];
+       while(1)
+       {
+               unsigned len = io.read(reinterpret_cast<char *>(buffer), sizeof(buffer));
+               if(!len)
+                       break;
+               len /= 4;
+               code.reserve(code.size()+len);
+               code.insert(code.end(), buffer, buffer+len);
+       }
+
+       if(code.empty())
+               throw invalid_module("Empty SPIR-V code");
+
+       if(code[0]==SPIRV_MAGIC_REVERSED)
+       {
+               for(vector<UInt32>::iterator i=code.begin(); i!=code.end(); ++i)
+                       *i = ((*i&0xFF)<<24) || ((*i&0xFF00)<<8) | ((*i>>8)&0xFF00) | ((*i>>24)&0xFF);
+       }
+       else if(code[0]!=SPIRV_MAGIC)
+               throw invalid_module("SPIR-V magic number not found");
+
+       Reflection reflection;
+       reflection.reflect_code(code);
+
+       map<const Structure *, unsigned> struct_indices;
+       structs.reserve(reflection.structs.size());
+       for(map<unsigned, Structure>::const_iterator i=reflection.structs.begin(); i!=reflection.structs.end(); ++i)
+       {
+               struct_indices[&i->second] = structs.size();
+               structs.push_back(i->second);
+       }
+
+       for(vector<Structure>::iterator i=structs.begin(); i!=structs.end(); ++i)
+       {
+               for(vector<StructMember>::iterator j=i->members.begin(); j!=i->members.end(); ++j)
+               {
+                       if(j->struct_type)
+                       {
+                               map<const Structure *, unsigned>::const_iterator k = struct_indices.find(j->struct_type);
+                               j->struct_type = (k!=struct_indices.end() ? &structs[k->second] : 0);
+                       }
+               }
+
+               const StructMember *last_member = &i->members.back();
+               unsigned last_offset = last_member->offset;
+               while(last_member->struct_type)
+               {
+                       const StructMember *lm = &last_member->struct_type->members.back();
+                       if(last_member->array_size)
+                               last_offset += last_member->array_stride*(last_member->array_size-1);
+                       last_offset += lm->offset;
+                       last_member = lm;
+               }
+               
+               i->size = last_offset+get_type_size(last_member->type);
+               i->size = (i->size+15)&~15;
+       }
+
+       map<const Variable *, unsigned> var_indices;
+       variables.reserve(reflection.variables.size());
+       for(map<unsigned, Variable>::const_iterator i=reflection.variables.begin(); i!=reflection.variables.end(); ++i)
+       {
+               int dup_index = -1;
+               for(vector<Variable>::const_iterator j=variables.begin(); (dup_index<0 && j!=variables.end()); ++j)
+                       if(*j==i->second)
+                               dup_index = j-variables.begin();
+
+               if(dup_index>=0)
+                       var_indices[&i->second] = dup_index;
+               else
+               {
+                       var_indices[&i->second] = variables.size();
+                       variables.push_back(i->second);
+               }
+       }
+
+       for(vector<Variable>::iterator i=variables.begin(); i!=variables.end(); ++i)
+               if(i->struct_type)
+               {
+                       map<const Structure *, unsigned>::const_iterator j = struct_indices.find(i->struct_type);
+                       i->struct_type = (j!=struct_indices.end() ? &structs[j->second] : 0);
+               }
+
+       entry_points.reserve(reflection.entry_points.size());
+       for(map<unsigned, EntryPoint>::const_iterator i=reflection.entry_points.begin(); i!=reflection.entry_points.end(); ++i)
+       {
+               entry_points.push_back(i->second);
+               EntryPoint &entry = entry_points.back();
+               for(vector<const Variable *>::iterator j=entry.globals.begin(); j!=entry.globals.end(); ++j)
+               {
+                       map<const Variable *, unsigned>::const_iterator k = var_indices.find(*j);
+                       *j = (k!=var_indices.end() ? &variables[k->second] : 0);
+               }
+       }
+
+       for(map<unsigned, SpecConstant>::const_iterator i=reflection.spec_constants.begin(); i!=reflection.spec_constants.end(); ++i)
+               spec_constants.push_back(i->second);
+}
+
+void SpirVModule::compile(SL::Compiler &)
+{
+       throw logic_error("Not implemented yet");
+}
+
+
+SpirVModule::EntryPoint::EntryPoint():
+       stage(VERTEX)
+{ }
+
+
+SpirVModule::StructMember::StructMember():
+       type(VOID),
+       struct_type(0),
+       offset(0),
+       array_size(0),
+       array_stride(0),
+       matrix_stride(0)
+{ }
+
+
+SpirVModule::Variable::Variable():
+       type(VOID),
+       struct_type(0),
+       location(-1),
+       descriptor_set(-1),
+       binding(-1)
+{ }
+
+bool SpirVModule::Variable::operator==(const Variable &other) const
+{
+       if(storage!=UNIFORM_CONSTANT && storage!=UNIFORM)
+               return false;
+       if(storage!=other.storage || type!=other.type || struct_type!=other.struct_type)
+               return false;
+       if(location!=other.location || descriptor_set!=other.descriptor_set || binding!=other.binding)
+               return false;
+       return true;
+}
+
+
+SpirVModule::TypeInfo::TypeInfo():
+       type(VOID),
+       struct_type(0),
+       array_size(0),
+       array_stride(0),
+       storage(static_cast<StorageClass>(-1))
+{ }
+
+
+UInt32 SpirVModule::Reflection::get_opcode(UInt32 op)
+{
+       return op&0xFFFF;
+}
+
+SpirVModule::Reflection::CodeIterator SpirVModule::Reflection::get_op_end(const CodeIterator &op)
+{
+       return op+(*op>>16);
+}
+
+string SpirVModule::Reflection::read_string(CodeIterator &op, const CodeIterator &op_end)
+{
+       string result;
+       for(; op!=op_end; ++op)
+       {
+               unsigned word = *op;
+               for(unsigned i=0; i<4; ++i)
+               {
+                       char c = word&0xFF;
+                       if(!c)
+                       {
+                               ++op;
+                               return result;
+                       }
+                       result += c;
+                       word >>= 8;
+               }
+       }
+
+       throw invalid_module("Unterminated SPIR-V string literal");
+}
+
+void SpirVModule::Reflection::reflect_code(const vector<UInt32> &code)
+{
+       for(CodeIterator op=code.begin()+5; op!=code.end(); )
+       {
+               unsigned word_count = *op>>16;
+               if(word_count>code.end()-op)
+                       throw invalid_module("Truncated SPIR-V instruction");
+
+               switch(get_opcode(*op))
+               {
+               case OP_NAME: reflect_name(op); break;
+               case OP_MEMBER_NAME: reflect_member_name(op); break;
+               case OP_ENTRY_POINT: reflect_entry_point(op); break;
+               case OP_TYPE_VOID: reflect_void_type(op); break;
+               case OP_TYPE_BOOL: reflect_bool_type(op); break;
+               case OP_TYPE_INT: reflect_int_type(op); break;
+               case OP_TYPE_FLOAT: reflect_float_type(op); break;
+               case OP_TYPE_VECTOR: reflect_vector_type(op); break;
+               case OP_TYPE_MATRIX: reflect_vector_type(op); break;
+               case OP_TYPE_IMAGE: reflect_image_type(op); break;
+               case OP_TYPE_SAMPLED_IMAGE: reflect_sampled_image_type(op); break;
+               case OP_TYPE_ARRAY: reflect_array_type(op); break;
+               case OP_TYPE_STRUCT: reflect_struct_type(op); break;
+               case OP_TYPE_POINTER: reflect_pointer_type(op); break;
+               case OP_CONSTANT_TRUE: constants[*(op+2)] = true; break;
+               case OP_CONSTANT_FALSE: constants[*(op+2)] = false; break;
+               case OP_CONSTANT: reflect_constant(op); break;
+               case OP_SPEC_CONSTANT_TRUE:
+               case OP_SPEC_CONSTANT_FALSE:
+               case OP_SPEC_CONSTANT: reflect_spec_constant(op); break;
+               case OP_VARIABLE: reflect_variable(op); break;
+               case OP_DECORATE: reflect_decorate(op); break;
+               case OP_MEMBER_DECORATE: reflect_member_decorate(op); break;
+               }
+
+               op += word_count;
+       }
+}
+
+void SpirVModule::Reflection::reflect_name(CodeIterator op)
+{
+       CodeIterator op_end = get_op_end(op);
+       string &name = names[*(op+1)];
+       op += 2;
+       name = read_string(op, op_end);
+}
+
+void SpirVModule::Reflection::reflect_member_name(CodeIterator op)
+{
+       CodeIterator op_end = get_op_end(op);
+       Structure &strct = structs[*(op+1)];
+       unsigned index = *(op+2);
+       if(index>=strct.members.size())
+               strct.members.resize(index+1);
+       op += 3;
+       strct.members[index].name = read_string(op, op_end);
+}
+
+void SpirVModule::Reflection::reflect_entry_point(CodeIterator op)
+{
+       CodeIterator op_end = get_op_end(op);
+       EntryPoint &entry = entry_points[*(op+2)];
+       entry.stage = static_cast<Stage>(*(op+1));  // Execution model in SPIR-V spec
+       op += 3;
+       entry.name = read_string(op, op_end);
+
+       entry.globals.reserve(op_end-op);
+       for(; op!=op_end; ++op)
+               entry.globals.push_back(&variables[*op]);
+}
+
+void SpirVModule::Reflection::reflect_void_type(CodeIterator op)
+{
+       types[*(op+1)].type = VOID;
+}
+
+void SpirVModule::Reflection::reflect_bool_type(CodeIterator op)
+{
+       types[*(op+1)].type = BOOL;
+}
+
+void SpirVModule::Reflection::reflect_int_type(CodeIterator op)
+{
+       TypeInfo &type = types[*(op+1)];
+       unsigned size = *(op+2);
+       bool sign = *(op+3);
+       type.type = static_cast<DataType>(size/8 | sign*0x100);
+}
+
+void SpirVModule::Reflection::reflect_float_type(CodeIterator op)
+{
+       TypeInfo &type = types[*(op+1)];
+       unsigned size = *(op+2);
+       type.type = static_cast<DataType>(size/8 | 0x300);
+}
+
+void SpirVModule::Reflection::reflect_vector_type(CodeIterator op)
+{
+       TypeInfo &type = types[*(op+1)];
+       DataType component = types[*(op+2)].type;
+       unsigned count = *(op+3);
+       type.type = static_cast<DataType>((count<<12) | (component&0xF00) | ((component&0xFF)*count));
+}
+
+void SpirVModule::Reflection::reflect_matrix_type(CodeIterator op)
+{
+       TypeInfo &type = types[*(op+1)];
+       DataType column = types[*(op+2)].type;
+       unsigned count = *(op+3);
+       type.type = static_cast<DataType>((count<<16) | (column&0xF00) | ((column&0xFF)*count));
+}
+
+void SpirVModule::Reflection::reflect_image_type(CodeIterator op)
+{
+       TypeInfo &type = types[*(op+1)];
+       DataType sample = types[*(op+2)].type;
+       unsigned dimensions = *(op+3);
+       bool depth = *(op+4)==1;
+       bool array = *(op+5);
+       type.type = static_cast<DataType>((depth*0x200000) | (array*0x80000) | (dimensions+1) | sample);
+}
+
+void SpirVModule::Reflection::reflect_sampled_image_type(CodeIterator op)
+{
+       TypeInfo &type = types[*(op+1)];
+       DataType image = types[*(op+2)].type;
+       type.type = static_cast<DataType>(image | 0x100000);
+}
+
+void SpirVModule::Reflection::reflect_array_type(CodeIterator op)
+{
+       TypeInfo &type = types[*(op+1)];
+       const TypeInfo &elem = types[*(op+2)];
+       type.type = elem.type;
+       type.struct_type = elem.struct_type;
+       const Variant &size = constants[*(op+3)];
+       if(size.check_type<int>())
+               type.array_size = size.value<int>();
+       else if(size.check_type<unsigned>())
+               type.array_size = size.value<unsigned>();
+}
+
+void SpirVModule::Reflection::reflect_struct_type(CodeIterator op)
+{
+       CodeIterator op_end = get_op_end(op);
+       unsigned id = *(op+1);
+       Structure &strct = structs[id];
+       strct.name = names[id];
+       types[id].struct_type = &strct;
+       op += 2;
+
+       strct.members.resize(op_end-op);
+       vector<StructMember>::iterator mem = strct.members.begin();
+       for(; op!=op_end; ++op, ++mem)
+       {
+               TypeInfo &type = types[*op];
+               mem->type = type.type;
+               mem->struct_type = type.struct_type;
+               mem->array_size = type.array_size;
+               mem->array_stride = type.array_stride;
+       }
+}
+
+void SpirVModule::Reflection::reflect_pointer_type(CodeIterator op)
+{
+       TypeInfo &type = types[*(op+1)];
+       type = types[*(op+3)];
+       type.storage = static_cast<StorageClass>(*(op+2));
+}
+
+void SpirVModule::Reflection::reflect_constant(CodeIterator op)
+{
+       const TypeInfo &type = types[*(op+1)];
+       unsigned id = *(op+2);
+       if(type.type==INT)
+               constants[id] = static_cast<int>(*(op+3));
+       else if(type.type==UNSIGNED_INT)
+               constants[id] = static_cast<unsigned>(*(op+3));
+       else if(type.type==FLOAT)
+               constants[id] = *reinterpret_cast<const float *>(&*(op+3));
+}
+
+void SpirVModule::Reflection::reflect_spec_constant(CodeIterator op)
+{
+       unsigned id = *(op+2);
+       SpecConstant &spec = spec_constants[id];
+       spec.name = names[id];
+       spec.type = types[*(op+1)].type;
+}
+
+void SpirVModule::Reflection::reflect_variable(CodeIterator op)
+{
+       unsigned id = *(op+2);
+       Variable &var = variables[id];
+       var.name = names[id];
+       const TypeInfo &type = types[*(op+1)];
+       var.storage = type.storage;
+       var.type = type.type;
+       var.struct_type = type.struct_type;
+       var.array_size = type.array_size;
+}
+
+void SpirVModule::Reflection::reflect_decorate(CodeIterator op)
+{
+       unsigned id = *(op+1);
+       unsigned decoration = *(op+2);
+       op += 3;
+
+       switch(decoration)
+       {
+       case DECO_SPEC_ID:
+               spec_constants[id].constant_id = *op;
+               break;
+       case DECO_ARRAY_STRIDE:
+               types[id].array_stride = *op;
+               break;
+       case DECO_LOCATION:
+               variables[id].location = *op;
+               break;
+       case DECO_BINDING:
+               variables[id].binding = *op;
+               break;
+       case DECO_DESCRIPTOR_SET:
+               variables[id].descriptor_set = *op;
+               break;
+       }
+}
+
+void SpirVModule::Reflection::reflect_member_decorate(CodeIterator op)
+{
+       Structure &strct = structs[*(op+1)];
+       unsigned index = *(op+2);
+       if(index>=strct.members.size())
+               strct.members.resize(index+1);
+       unsigned decoration = *(op+3);
+       op += 4;
+
+       StructMember &member = strct.members[index];
+       switch(decoration)
+       {
+       case DECO_MATRIX_STRIDE:
+               member.matrix_stride = *op;
+               break;
+       case DECO_OFFSET:
+               member.offset = *op;
+               break;
+       }
+}
+
 } // namespace GL
 } // namespace Msp