source/core/module.cpp

   1 #include <msp/core/algorithm.h>
   2 #include <msp/io/print.h>
   3 #include "module.h"
   4 #include "resources.h"
   5
   6 using namespace std;
   7
   8 enum SpirVConstants
   9 {
  10         SPIRV_MAGIC = 0x07230203,
  11         SPIRV_MAGIC_REVERSED = 0x03022307,
  12
  13         OP_NAME = 5,
  14         OP_MEMBER_NAME = 6,
  15         OP_ENTRY_POINT = 15,
  16         OP_TYPE_VOID = 19,
  17         OP_TYPE_BOOL = 20,
  18         OP_TYPE_INT = 21,
  19         OP_TYPE_FLOAT = 22,
  20         OP_TYPE_VECTOR = 23,
  21         OP_TYPE_MATRIX = 24,
  22         OP_TYPE_IMAGE = 25,
  23         OP_TYPE_SAMPLED_IMAGE = 27,
  24         OP_TYPE_ARRAY = 28,
  25         OP_TYPE_STRUCT = 30,
  26         OP_TYPE_POINTER = 32,
  27         OP_CONSTANT_TRUE = 41,
  28         OP_CONSTANT_FALSE = 42,
  29         OP_CONSTANT = 43,
  30         OP_SPEC_CONSTANT_TRUE = 48,
  31         OP_SPEC_CONSTANT_FALSE = 49,
  32         OP_SPEC_CONSTANT = 50,
  33         OP_VARIABLE = 59,
  34         OP_DECORATE = 71,
  35         OP_MEMBER_DECORATE = 72,
  36
  37         DECO_SPEC_ID = 1,
  38         DECO_ARRAY_STRIDE = 6,
  39         DECO_MATRIX_STRIDE = 7,
  40         DECO_BUILTIN = 11,
  41         DECO_LOCATION = 30,
  42         DECO_BINDING = 33,
  43         DECO_DESCRIPTOR_SET = 34,
  44         DECO_OFFSET = 35
  45 };
  46
  47 namespace Msp {
  48 namespace GL {
  49
  50 void Module::set_source(const string &src)
  51 {
  52         SL::Compiler compiler;
  53         compiler.set_source(src);
  54         compile(compiler);
  55 }
  56
  57 void Module::load_source(IO::Base &io, Resources *res, const string &name)
  58 {
  59         SL::Compiler compiler;
  60         compiler.load_source(io, res, name);
  61         compile(compiler);
  62 }
  63
  64 void Module::load_source(IO::Base &io, const string &name)
  65 {
  66         load_source(io, 0, name);
  67 }
  68
  69
  70 void GlslModule::compile(SL::Compiler &compiler)
  71 {
  72         compiler.compile(SL::Compiler::MODULE);
  73         prepared_source = compiler.get_combined_glsl();
  74         source_map = compiler.get_source_map();
  75
  76 #ifdef DEBUG
  77         string diagnostics = compiler.get_diagnostics();
  78         if(!diagnostics.empty())
  79                 IO::print("Module diagnostics:\n%s\n", diagnostics);
  80 #endif
  81 }
  82
  83
  84 SpirVModule::SpirVModule(const SpirVModule &other):
  85         code(other.code),
  86         entry_points(other.entry_points),
  87         structs(other.structs),
  88         variables(other.variables)
  89 {
  90         remap_pointers_from(other);
  91 }
  92
  93 SpirVModule &SpirVModule::operator=(const SpirVModule &other)
  94 {
  95         code = other.code;
  96         entry_points = other.entry_points;
  97         structs = other.structs;
  98         variables = other.variables;
  99         remap_pointers_from(other);
 100         return *this;
 101 }
 102
 103 void SpirVModule::remap_pointers_from(const SpirVModule &other)
 104 {
 105         for(EntryPoint &e: entry_points)
 106                 for(const Variable *&v: e.globals)
 107                         v = &variables[v-&other.variables.front()];
 108
 109         for(Variable &v: variables)
 110                 if(v.struct_type)
 111                         v.struct_type = &structs[v.struct_type-&other.structs.front()];
 112
 113         for(Structure &s: structs)
 114                 for(StructMember &m: s.members)
 115                         if(m.struct_type)
 116                                 m.struct_type = &structs[m.struct_type-&other.structs.front()];
 117 }
 118
 119 void SpirVModule::load_code(IO::Base &io)
 120 {
 121         uint32_t buffer[1024];
 122         while(1)
 123         {
 124                 unsigned len = io.read(reinterpret_cast<char *>(buffer), sizeof(buffer));
 125                 if(!len)
 126                         break;
 127                 len /= 4;
 128                 code.reserve(code.size()+len);
 129                 code.insert(code.end(), buffer, buffer+len);
 130         }
 131
 132         reflect();
 133 }
 134
 135 void SpirVModule::compile(SL::Compiler &compiler)
 136 {
 137         compiler.compile(SL::Compiler::SPIRV);
 138         code = compiler.get_combined_spirv();
 139         reflect();
 140 }
 141
 142 void SpirVModule::reflect()
 143 {
 144         if(code.empty())
 145                 throw invalid_module("Empty SPIR-V code");
 146
 147         if(code[0]==SPIRV_MAGIC_REVERSED)
 148         {
 149                 for(uint32_t &c: code)
 150                         c = ((c&0xFF)<<24) || ((c&0xFF00)<<8) | ((c>>8)&0xFF00) | ((c>>24)&0xFF);
 151         }
 152         else if(code[0]!=SPIRV_MAGIC)
 153                 throw invalid_module("SPIR-V magic number not found");
 154
 155         Reflection reflection;
 156         reflection.reflect_code(code);
 157
 158         map<const Constant *, unsigned> spec_indices;
 159         for(const auto &kvp: reflection.constants)
 160                 if(kvp.second.constant_id>=0)
 161                 {
 162                         spec_indices[&kvp.second] = spec_constants.size();
 163                         spec_constants.push_back(kvp.second);
 164                 }
 165
 166         map<const Structure *, unsigned> struct_indices;
 167         structs.reserve(reflection.structs.size());
 168         for(const auto &kvp: reflection.structs)
 169         {
 170                 struct_indices[&kvp.second] = structs.size();
 171                 structs.push_back(kvp.second);
 172         }
 173
 174         for(Structure &s: structs)
 175         {
 176                 for(StructMember &m: s.members)
 177                         if(m.struct_type)
 178                         {
 179                                 auto i = struct_indices.find(m.struct_type);
 180                                 m.struct_type = (i!=struct_indices.end() ? &structs[i->second] : 0);
 181                         }
 182
 183                 const StructMember *last_member = &s.members.back();
 184                 unsigned last_offset = last_member->offset;
 185                 while(last_member->struct_type)
 186                 {
 187                         const StructMember *lm = &last_member->struct_type->members.back();
 188                         if(last_member->array_size)
 189                                 last_offset += last_member->array_stride*(last_member->array_size-1);
 190                         last_offset += lm->offset;
 191                         last_member = lm;
 192                 }
 193
 194                 s.size = last_offset+get_type_size(last_member->type);
 195                 s.size = (s.size+15)&~15;
 196         }
 197
 198         map<const Variable *, unsigned> var_indices;
 199         variables.reserve(reflection.variables.size());
 200         for(const auto &kvp: reflection.variables)
 201         {
 202                 auto i = find_if(variables, [&kvp](const Variable &v){ return v==kvp.second; });
 203                 if(i!=variables.end())
 204                         var_indices[&kvp.second] = i-variables.begin();
 205                 else
 206                 {
 207                         var_indices[&kvp.second] = variables.size();
 208                         variables.push_back(kvp.second);
 209                 }
 210         }
 211
 212         for(Variable &v: variables)
 213                 if(v.struct_type)
 214                 {
 215                         auto i = struct_indices.find(v.struct_type);
 216                         v.struct_type = (i!=struct_indices.end() ? &structs[i->second] : 0);
 217                 }
 218
 219         entry_points.reserve(reflection.entry_points.size());
 220         for(const auto &kvp: reflection.entry_points)
 221         {
 222                 entry_points.push_back(kvp.second);
 223                 EntryPoint &entry = entry_points.back();
 224                 for(const Variable *&v: entry.globals)
 225                 {
 226                         auto i = var_indices.find(v);
 227                         v = (i!=var_indices.end() ? &variables[i->second] : 0);
 228                 }
 229         }
 230 }
 231
 232
 233 bool SpirVModule::Variable::operator==(const Variable &other) const
 234 {
 235         if(storage!=UNIFORM_CONSTANT && storage!=UNIFORM)
 236                 return false;
 237         if(storage!=other.storage || type!=other.type || struct_type!=other.struct_type)
 238                 return false;
 239         if(location!=other.location || descriptor_set!=other.descriptor_set || binding!=other.binding)
 240                 return false;
 241         return true;
 242 }
 243
 244
 245 uint32_t SpirVModule::Reflection::get_opcode(uint32_t op)
 246 {
 247         return op&0xFFFF;
 248 }
 249
 250 SpirVModule::Reflection::CodeIterator SpirVModule::Reflection::get_op_end(const CodeIterator &op)
 251 {
 252         return op+(*op>>16);
 253 }
 254
 255 string SpirVModule::Reflection::read_string(CodeIterator &op, const CodeIterator &op_end)
 256 {
 257         string result;
 258         for(; op!=op_end; ++op)
 259         {
 260                 unsigned word = *op;
 261                 for(unsigned i=0; i<4; ++i)
 262                 {
 263                         char c = word&0xFF;
 264                         if(!c)
 265                         {
 266                                 ++op;
 267                                 return result;
 268                         }
 269                         result += c;
 270                         word >>= 8;
 271                 }
 272         }
 273
 274         throw invalid_module("Unterminated SPIR-V string literal");
 275 }
 276
 277 void SpirVModule::Reflection::reflect_code(const vector<uint32_t> &code)
 278 {
 279         for(CodeIterator op=code.begin()+5; op!=code.end(); )
 280         {
 281                 unsigned word_count = *op>>16;
 282                 if(word_count>static_cast<unsigned>(code.end()-op))
 283                         throw invalid_module("Truncated SPIR-V instruction");
 284
 285                 switch(get_opcode(*op))
 286                 {
 287                 case OP_NAME: reflect_name(op); break;
 288                 case OP_MEMBER_NAME: reflect_member_name(op); break;
 289                 case OP_ENTRY_POINT: reflect_entry_point(op); break;
 290                 case OP_TYPE_VOID: reflect_void_type(op); break;
 291                 case OP_TYPE_BOOL: reflect_bool_type(op); break;
 292                 case OP_TYPE_INT: reflect_int_type(op); break;
 293                 case OP_TYPE_FLOAT: reflect_float_type(op); break;
 294                 case OP_TYPE_VECTOR: reflect_vector_type(op); break;
 295                 case OP_TYPE_MATRIX: reflect_matrix_type(op); break;
 296                 case OP_TYPE_IMAGE: reflect_image_type(op); break;
 297                 case OP_TYPE_SAMPLED_IMAGE: reflect_sampled_image_type(op); break;
 298                 case OP_TYPE_ARRAY: reflect_array_type(op); break;
 299                 case OP_TYPE_STRUCT: reflect_struct_type(op); break;
 300                 case OP_TYPE_POINTER: reflect_pointer_type(op); break;
 301                 case OP_CONSTANT_TRUE:
 302                 case OP_CONSTANT_FALSE:
 303                 case OP_CONSTANT:
 304                 case OP_SPEC_CONSTANT_TRUE:
 305                 case OP_SPEC_CONSTANT_FALSE:
 306                 case OP_SPEC_CONSTANT: reflect_constant(op); break;
 307                 case OP_VARIABLE: reflect_variable(op); break;
 308                 case OP_DECORATE: reflect_decorate(op); break;
 309                 case OP_MEMBER_DECORATE: reflect_member_decorate(op); break;
 310                 }
 311
 312                 op += word_count;
 313         }
 314 }
 315
 316 void SpirVModule::Reflection::reflect_name(CodeIterator op)
 317 {
 318         CodeIterator op_end = get_op_end(op);
 319         string &name = names[*(op+1)];
 320         op += 2;
 321         name = read_string(op, op_end);
 322 }
 323
 324 void SpirVModule::Reflection::reflect_member_name(CodeIterator op)
 325 {
 326         CodeIterator op_end = get_op_end(op);
 327         Structure &strct = structs[*(op+1)];
 328         unsigned index = *(op+2);
 329         if(index>=strct.members.size())
 330                 strct.members.resize(index+1);
 331         op += 3;
 332         strct.members[index].name = read_string(op, op_end);
 333 }
 334
 335 void SpirVModule::Reflection::reflect_entry_point(CodeIterator op)
 336 {
 337         CodeIterator op_end = get_op_end(op);
 338         EntryPoint &entry = entry_points[*(op+2)];
 339         entry.stage = static_cast<Stage>(*(op+1));  // Execution model in SPIR-V spec
 340         op += 3;
 341         entry.name = read_string(op, op_end);
 342
 343         entry.globals.reserve(op_end-op);
 344         for(; op!=op_end; ++op)
 345                 entry.globals.push_back(&variables[*op]);
 346 }
 347
 348 void SpirVModule::Reflection::reflect_void_type(CodeIterator op)
 349 {
 350         types[*(op+1)].type = VOID;
 351 }
 352
 353 void SpirVModule::Reflection::reflect_bool_type(CodeIterator op)
 354 {
 355         types[*(op+1)].type = BOOL;
 356 }
 357
 358 void SpirVModule::Reflection::reflect_int_type(CodeIterator op)
 359 {
 360         TypeInfo &type = types[*(op+1)];
 361         unsigned size = *(op+2);
 362         bool sign = *(op+3);
 363         type.type = static_cast<DataType>(size/8 | sign*0x100);
 364 }
 365
 366 void SpirVModule::Reflection::reflect_float_type(CodeIterator op)
 367 {
 368         TypeInfo &type = types[*(op+1)];
 369         unsigned size = *(op+2);
 370         type.type = static_cast<DataType>(size/8 | 0x300);
 371 }
 372
 373 void SpirVModule::Reflection::reflect_vector_type(CodeIterator op)
 374 {
 375         TypeInfo &type = types[*(op+1)];
 376         DataType component = types[*(op+2)].type;
 377         unsigned count = *(op+3);
 378         type.type = static_cast<DataType>(((count-1)<<12) | (component&0xF00) | ((component&0xFF)*count));
 379 }
 380
 381 void SpirVModule::Reflection::reflect_matrix_type(CodeIterator op)
 382 {
 383         TypeInfo &type = types[*(op+1)];
 384         DataType column = types[*(op+2)].type;
 385         unsigned count = *(op+3);
 386         type.type = static_cast<DataType>(((count-1)<<14) | (column&0x3F00) | ((column&0xFF)*count));
 387 }
 388
 389 void SpirVModule::Reflection::reflect_image_type(CodeIterator op)
 390 {
 391         TypeInfo &type = types[*(op+1)];
 392         DataType sample = types[*(op+2)].type;
 393         unsigned dimensions = *(op+3);
 394         bool depth = *(op+4)==1;
 395         bool array = *(op+5);
 396         type.type = static_cast<DataType>((depth*0x200000) | (array*0x80000) | (dimensions+1) | sample);
 397 }
 398
 399 void SpirVModule::Reflection::reflect_sampled_image_type(CodeIterator op)
 400 {
 401         TypeInfo &type = types[*(op+1)];
 402         DataType image = types[*(op+2)].type;
 403         type.type = static_cast<DataType>(image | 0x100000);
 404 }
 405
 406 void SpirVModule::Reflection::reflect_array_type(CodeIterator op)
 407 {
 408         TypeInfo &type = types[*(op+1)];
 409         const TypeInfo &elem = types[*(op+2)];
 410         type.type = elem.type;
 411         type.struct_type = elem.struct_type;
 412
 413         const Constant &size = constants[*(op+3)];
 414         if(size.type==INT || size.type==UNSIGNED_INT)
 415                 type.array_size = size.i_value;
 416 }
 417
 418 void SpirVModule::Reflection::reflect_struct_type(CodeIterator op)
 419 {
 420         CodeIterator op_end = get_op_end(op);
 421         unsigned id = *(op+1);
 422         Structure &strct = structs[id];
 423         strct.name = names[id];
 424         types[id].struct_type = &strct;
 425         op += 2;
 426
 427         strct.members.resize(op_end-op);
 428         auto mem = strct.members.begin();
 429         for(; op!=op_end; ++op, ++mem)
 430         {
 431                 TypeInfo &type = types[*op];
 432                 mem->type = type.type;
 433                 mem->struct_type = type.struct_type;
 434                 mem->array_size = type.array_size;
 435                 mem->array_stride = type.array_stride;
 436         }
 437 }
 438
 439 void SpirVModule::Reflection::reflect_pointer_type(CodeIterator op)
 440 {
 441         TypeInfo &type = types[*(op+1)];
 442         type = types[*(op+3)];
 443         type.storage = static_cast<StorageClass>(*(op+2));
 444 }
 445
 446 void SpirVModule::Reflection::reflect_constant(CodeIterator op)
 447 {
 448         unsigned id = *(op+2);
 449         Constant &cnst = constants[id];
 450         cnst.name = names[id];
 451         cnst.type = types[*(op+1)].type;
 452         if(*op==OP_CONSTANT_TRUE || *op==OP_SPEC_CONSTANT_TRUE)
 453                 cnst.i_value = true;
 454         else if(*op==OP_CONSTANT_FALSE || *op==OP_SPEC_CONSTANT_FALSE)
 455                 cnst.i_value = false;
 456         else if(cnst.type==INT || cnst.type==UNSIGNED_INT)
 457                 cnst.i_value = *(op+3);
 458         else if(cnst.type==FLOAT)
 459                 cnst.f_value = *reinterpret_cast<const float *>(&*(op+3));
 460 }
 461
 462 void SpirVModule::Reflection::reflect_variable(CodeIterator op)
 463 {
 464         unsigned id = *(op+2);
 465         Variable &var = variables[id];
 466         var.name = names[id];
 467         const TypeInfo &type = types[*(op+1)];
 468         var.storage = type.storage;
 469         var.type = type.type;
 470         var.struct_type = type.struct_type;
 471         var.array_size = type.array_size;
 472 }
 473
 474 void SpirVModule::Reflection::reflect_decorate(CodeIterator op)
 475 {
 476         unsigned id = *(op+1);
 477         unsigned decoration = *(op+2);
 478         op += 3;
 479
 480         switch(decoration)
 481         {
 482         case DECO_SPEC_ID:
 483                 constants[id].constant_id = *op;
 484                 break;
 485         case DECO_ARRAY_STRIDE:
 486                 types[id].array_stride = *op;
 487                 break;
 488         case DECO_BUILTIN:
 489                 variables[id].builtin = static_cast<BuiltinSemantic>(*op);
 490                 break;
 491         case DECO_LOCATION:
 492                 variables[id].location = *op;
 493                 break;
 494         case DECO_BINDING:
 495                 variables[id].binding = *op;
 496                 break;
 497         case DECO_DESCRIPTOR_SET:
 498                 variables[id].descriptor_set = *op;
 499                 break;
 500         }
 501 }
 502
 503 void SpirVModule::Reflection::reflect_member_decorate(CodeIterator op)
 504 {
 505         Structure &strct = structs[*(op+1)];
 506         unsigned index = *(op+2);
 507         if(index>=strct.members.size())
 508                 strct.members.resize(index+1);
 509         unsigned decoration = *(op+3);
 510         op += 4;
 511
 512         StructMember &member = strct.members[index];
 513         switch(decoration)
 514         {
 515         case DECO_MATRIX_STRIDE:
 516                 member.matrix_stride = *op;
 517                 break;
 518         case DECO_BUILTIN:
 519                 member.builtin = static_cast<BuiltinSemantic>(*op);
 520                 break;
 521         case DECO_OFFSET:
 522                 member.offset = *op;
 523                 break;
 524         }
 525 }
 526
 527 } // namespace GL
 528 } // namespace Msp