source/glsl/finalize.cpp

   1 #include <msp/core/algorithm.h>
   2 #include <msp/core/hash.h>
   3 #include <msp/core/raii.h>
   4 #include <msp/strings/lexicalcast.h>
   5 #include "finalize.h"
   6 #include "glsl_error.h"
   7 #include "reflect.h"
   8
   9 using namespace std;
  10
  11 namespace Msp {
  12 namespace GL {
  13 namespace SL {
  14
  15 void StructOrganizer::visit(StructDeclaration &strct)
  16 {
  17         SetForScope<int> set_offset(offset, 0);
  18         TraversingVisitor::visit(strct);
  19 }
  20
  21 void StructOrganizer::visit(VariableDeclaration &var)
  22 {
  23         if(offset>=0)
  24         {
  25                 int *layout_offset = 0;
  26                 bool has_matrix_order = false;
  27                 if(var.layout)
  28                 {
  29                         for(Layout::Qualifier &q: var.layout->qualifiers)
  30                         {
  31                                 if(q.name=="offset" && q.has_value)
  32                                 {
  33                                         layout_offset = &q.value;
  34                                         if(q.value>=offset)
  35                                                 offset = q.value;
  36                                 }
  37                                 else if(q.name=="column_major" || q.name=="row_major")
  38                                         has_matrix_order = true;
  39                         }
  40                 }
  41
  42                 MemoryRequirementsCalculator::Result mem_reqs = MemoryRequirementsCalculator().apply(var);
  43                 offset += mem_reqs.alignment-1;
  44                 offset -= offset%mem_reqs.alignment;
  45
  46                 if(layout_offset)
  47                         *layout_offset = offset;
  48                 else
  49                         add_layout_qualifier(var.layout, Layout::Qualifier("offset", offset));
  50
  51                 if(!has_matrix_order)
  52                 {
  53                         const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(var.type_declaration);
  54                         while(basic && basic->kind==BasicTypeDeclaration::ARRAY)
  55                                 basic = dynamic_cast<const BasicTypeDeclaration *>(basic->base_type);
  56                         if(basic && basic->kind==BasicTypeDeclaration::MATRIX)
  57                                 add_layout_qualifier(var.layout, Layout::Qualifier("column_major"));
  58                 }
  59
  60                 offset += mem_reqs.size;
  61         }
  62 }
  63
  64
  65 void LocationAllocator::apply(Module &module, const Features &f, bool a)
  66 {
  67         features = f;
  68         alloc_new = a;
  69         for(Stage &s: module.stages)
  70                 apply(s);
  71
  72         if(features.target_api!=VULKAN)
  73                 allocate_locations("uniform");
  74
  75         for(VariableDeclaration *b: unbound_blocks)
  76                 bind_uniform(b->layout, b->block_declaration->block_name, features.uniform_binding_range);
  77         for(VariableDeclaration *t: unbound_textures)
  78                 bind_uniform(t->layout, t->name, features.texture_binding_range);
  79 }
  80
  81 void LocationAllocator::apply(Stage &stage)
  82 {
  83         swap(used_locations["in"], used_locations["out"]);
  84         used_locations["out"].clear();
  85
  86         stage.content.visit(*this);
  87
  88         allocate_locations("in");
  89         allocate_locations("out");
  90 }
  91
  92 void LocationAllocator::allocate_locations(const string &iface)
  93 {
  94         auto write = unplaced_variables.begin();
  95         unsigned next = 0;
  96         for(auto i=unplaced_variables.begin(); i!=unplaced_variables.end(); ++i)
  97         {
  98                 if((*i)->interface!=iface)
  99                 {
 100                         if(write!=i)
 101                                 *write = *i;
 102                         ++write;
 103                         continue;
 104                 }
 105
 106                 if((*i)->interface=="uniform")
 107                 {
 108                         auto j = uniforms.find((*i)->name);
 109                         if(j!=uniforms.end() && j->second.location>=0)
 110                         {
 111                                 add_layout_qualifier((*i)->layout, Layout::Qualifier("location", j->second.location));
 112                                 continue;
 113                         }
 114                 }
 115
 116                 if(!alloc_new)
 117                         continue;
 118
 119                 set<unsigned> &used = used_locations[(*i)->interface];
 120
 121                 unsigned size = LocationCounter().apply(**i);
 122                 while(1)
 123                 {
 124                         int blocking = -1;
 125                         for(unsigned j=0; j<size; ++j)
 126                                 if(used.count(next+j))
 127                                         blocking = next+j;
 128                         if(blocking<0)
 129                                 break;
 130                         next = blocking+1;
 131                 }
 132
 133                 add_layout_qualifier((*i)->layout, Layout::Qualifier("location", next));
 134                 if((*i)->interface=="uniform")
 135                         uniforms[(*i)->name].location = next;
 136
 137                 for(unsigned j=0; j<size; ++j)
 138                         used.insert(next+j);
 139                 next += size;
 140         }
 141
 142         unplaced_variables.erase(write, unplaced_variables.end());
 143 }
 144
 145 void LocationAllocator::bind_uniform(RefPtr<Layout> &layout, const string &name, unsigned range)
 146 {
 147         auto i = uniforms.find(name);
 148
 149         int desc_set = (i!=uniforms.end() ? i->second.desc_set : 0);
 150         if(features.target_api==VULKAN && get_layout_value(layout.get(), "set")<0)
 151                 add_layout_qualifier(layout, Layout::Qualifier("set", desc_set));
 152
 153         if(i!=uniforms.end() && i->second.bind_point>=0)
 154                 add_layout_qualifier(layout, Layout::Qualifier("binding", i->second.bind_point));
 155         else if(alloc_new)
 156         {
 157                 set<unsigned> &used = used_bindings[desc_set];
 158
 159                 unsigned bind_point = hash_fold<32>(hash<64>(name))%range;
 160                 while(used.count(bind_point))
 161                         bind_point = (bind_point+1)%range;
 162
 163                 add_layout_qualifier(layout, Layout::Qualifier("binding", bind_point));
 164                 uniforms[name].bind_point = bind_point;
 165                 used.insert(bind_point);
 166         }
 167 }
 168
 169 bool LocationAllocator::visit_uniform(const string &name, RefPtr<Layout> &layout)
 170 {
 171         int desc_set = 0;
 172         int bind_point = get_layout_value(layout.get(), "binding");
 173
 174         if(features.target_api==VULKAN)
 175         {
 176                 desc_set = get_layout_value(layout.get(), "set");
 177                 if(desc_set<0 && bind_point>=0)
 178                 {
 179                         desc_set = 0;
 180                         add_layout_qualifier(layout, Layout::Qualifier("set", desc_set));
 181                 }
 182
 183                 if(desc_set>=0)
 184                         uniforms[name].desc_set = desc_set;
 185         }
 186
 187         if(bind_point>=0)
 188         {
 189                 used_bindings[desc_set].insert(bind_point);
 190                 uniforms[name].bind_point = bind_point;
 191         }
 192
 193         return bind_point>=0;
 194 }
 195
 196 void LocationAllocator::visit(VariableDeclaration &var)
 197 {
 198         if(!var.name.compare(0, 3, "gl_"))
 199                 return;
 200
 201         if(!var.interface.empty() && !var.block_declaration)
 202         {
 203                 int location = get_layout_value(var.layout.get(), "location");
 204
 205                 if(location<0 && var.linked_declaration && var.linked_declaration->layout)
 206                 {
 207                         location = get_layout_value(var.linked_declaration->layout.get(), "location");
 208                         if(location>=0)
 209                                 add_layout_qualifier(var.layout, Layout::Qualifier("location", location));
 210                 }
 211
 212                 if(location>=0)
 213                 {
 214                         unsigned size = LocationCounter().apply(var);
 215                         for(unsigned i=0; i<size; ++i)
 216                                 used_locations[var.interface].insert(location+i);
 217                         if(var.interface=="uniform")
 218                                 uniforms[var.name].location = location;
 219                 }
 220                 else
 221                         unplaced_variables.push_back(&var);
 222         }
 223
 224         if(var.interface=="uniform")
 225         {
 226                 if(var.block_declaration)
 227                 {
 228                         bool push_constant = has_layout_qualifier(var.layout.get(), "push_constant");
 229                         if(!push_constant && !visit_uniform(var.block_declaration->block_name, var.layout))
 230                                 unbound_blocks.push_back(&var);
 231                 }
 232                 else
 233                 {
 234                         const TypeDeclaration *base_type = get_ultimate_base_type(var.type_declaration);
 235                         if(dynamic_cast<const ImageTypeDeclaration *>(base_type) && !visit_uniform(var.name, var.layout))
 236                                 unbound_textures.push_back(&var);
 237                 }
 238         }
 239 }
 240
 241
 242 void PrecisionConverter::apply(Stage &s)
 243 {
 244         stage = &s;
 245         s.content.visit(*this);
 246         NodeRemover().apply(s, nodes_to_remove);
 247 }
 248
 249 void PrecisionConverter::visit(Block &block)
 250 {
 251         for(auto i=block.body.begin(); i!=block.body.end(); ++i)
 252         {
 253                 if(&block==&stage->content)
 254                         insert_point = i;
 255                 (*i)->visit(*this);
 256         }
 257 }
 258
 259 void PrecisionConverter::visit(Precision &prec)
 260 {
 261         if(stage->required_features.target_api==OPENGL_ES)
 262                 have_default.insert(prec.type);
 263         else
 264                 nodes_to_remove.insert(&prec);
 265 }
 266
 267 void PrecisionConverter::visit(VariableDeclaration &var)
 268 {
 269         if(stage->required_features.target_api!=OPENGL_ES)
 270         {
 271                 var.precision.clear();
 272                 return;
 273         }
 274
 275         const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
 276         const TypeDeclaration *type = var.type_declaration;
 277         while(type)
 278         {
 279                 if(dynamic_cast<const ImageTypeDeclaration *>(type))
 280                 {
 281                         default_prec = "lowp";
 282                         break;
 283                 }
 284                 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
 285                 {
 286                         if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
 287                                 break;
 288                         type = basic->base_type;
 289                 }
 290                 else
 291                         return;
 292         }
 293         if(!type)
 294                 return;
 295
 296         if(!have_default.count(type->name))
 297         {
 298                 Precision *prec = new Precision;
 299                 prec->precision = default_prec;
 300                 prec->type = type->name;
 301                 stage->content.body.insert(insert_point, prec);
 302
 303                 have_default.insert(type->name);
 304         }
 305 }
 306
 307
 308 void FeatureConverter::apply(Stage &s, const Features &feat)
 309 {
 310         stage = &s;
 311         features = feat;
 312
 313         if(!stage->required_features.glsl_version)
 314                 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
 315
 316         apply();
 317 }
 318
 319 void FeatureConverter::unsupported(const string &reason)
 320 {
 321         Diagnostic diagnostic;
 322         diagnostic.severity = Diagnostic::ERR;
 323         diagnostic.source = GENERATED_SOURCE;
 324         diagnostic.line = 0;
 325         diagnostic.message = reason;
 326         stage->diagnostics.push_back(diagnostic);
 327 }
 328
 329 bool FeatureConverter::check_version(const Version &feature_version) const
 330 {
 331         if(features.glsl_version<feature_version)
 332                 return false;
 333         else if(stage->required_features.glsl_version<feature_version)
 334                 stage->required_features.glsl_version = feature_version;
 335
 336         return true;
 337 }
 338
 339 bool FeatureConverter::check_extension(bool Features::*extension) const
 340 {
 341         if(!(features.*extension))
 342                 return false;
 343
 344         stage->required_features.*extension = true;
 345
 346         return true;
 347 }
 348
 349
 350 void StructuralFeatureConverter::apply()
 351 {
 352         if(supports_stage(stage->type))
 353         {
 354                 stage->content.visit(*this);
 355                 NodeRemover().apply(*stage, nodes_to_remove);
 356         }
 357         else
 358                 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
 359 }
 360
 361 void StructuralFeatureConverter::visit(Block &block)
 362 {
 363         for(auto i=block.body.begin(); i!=block.body.end(); ++i)
 364         {
 365                 if(&block==&stage->content)
 366                         uniform_insert_point = i;
 367                 (*i)->visit(*this);
 368         }
 369 }
 370
 371 void StructuralFeatureConverter::visit(RefPtr<Expression> &expr)
 372 {
 373         r_replaced_reference = 0;
 374         expr->visit(*this);
 375         if(r_replaced_reference)
 376                 expr = r_replaced_reference;
 377         r_replaced_reference = 0;
 378 }
 379
 380 bool StructuralFeatureConverter::supports_stage(Stage::Type st) const
 381 {
 382         if(st==Stage::GEOMETRY)
 383         {
 384                 if(features.target_api==VULKAN)
 385                         return true;
 386                 else if(features.target_api==OPENGL_ES)
 387                         return check_version(Version(3, 20));
 388                 else
 389                         return check_version(Version(1, 50));
 390         }
 391         else
 392                 return true;
 393 }
 394
 395 bool StructuralFeatureConverter::supports_unified_interface_syntax() const
 396 {
 397         if(features.target_api==VULKAN)
 398                 return true;
 399         else if(features.target_api==OPENGL_ES)
 400                 return check_version(Version(3, 0));
 401         else
 402                 return check_version(Version(1, 30));
 403 }
 404
 405 void StructuralFeatureConverter::visit(VariableReference &var)
 406 {
 407         if(var.declaration==frag_out && !supports_unified_interface_syntax())
 408         {
 409                 var.name = "gl_FragColor";
 410                 var.declaration = 0;
 411         }
 412
 413         r_flattened_interface = nodes_to_remove.count(var.declaration);
 414 }
 415
 416 void StructuralFeatureConverter::visit(MemberAccess &memacc)
 417 {
 418         r_flattened_interface = false;
 419         visit(memacc.left);
 420         if(r_flattened_interface)
 421         {
 422                 VariableReference *var = new VariableReference;
 423                 var->name = memacc.member;
 424                 r_replaced_reference = var;
 425         }
 426 }
 427
 428 void StructuralFeatureConverter::visit(Assignment &assign)
 429 {
 430         TraversingVisitor::visit(assign);
 431         if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
 432                 assign.target.declaration = 0;
 433 }
 434
 435 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
 436 {
 437         if(features.target_api==VULKAN)
 438                 return true;
 439         else if(features.target_api==OPENGL_ES)
 440                 return check_version(Version(3, 0));
 441         else
 442                 return check_version(Version(1, 30));
 443 }
 444
 445 void StructuralFeatureConverter::visit(FunctionCall &call)
 446 {
 447         if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
 448         {
 449                 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
 450                 {
 451                         const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
 452                         if(arg_image && !supports_unified_sampling_functions())
 453                         {
 454                                 string suffix = call.name.substr(7);
 455                                 call.name = (arg_image->shadow ? "shadow" : "texture");
 456
 457                                 switch(arg_image->dimensions)
 458                                 {
 459                                 case ImageTypeDeclaration::ONE: call.name += "1D"; break;
 460                                 case ImageTypeDeclaration::TWO: call.name += "2D"; break;
 461                                 case ImageTypeDeclaration::THREE: call.name += "3D"; break;
 462                                 case ImageTypeDeclaration::CUBE: call.name += "Cube"; break;
 463                                 }
 464
 465                                 if(arg_image->array)
 466                                 {
 467                                         /* Array textures and the unified sampling function name were
 468                                         both introduced in GLSL 1.30. */
 469                                         if(arg_image->dimensions==ImageTypeDeclaration::ONE || arg_image->dimensions==ImageTypeDeclaration::TWO)
 470                                                 check_extension(&Features::ext_texture_array);
 471                                         call.name += "Array";
 472                                 }
 473
 474                                 call.name += suffix;
 475                         }
 476                 }
 477         }
 478
 479         TraversingVisitor::visit(call);
 480 }
 481
 482 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
 483 {
 484         if(features.target_api==VULKAN)
 485                 return true;
 486         else if(features.target_api==OPENGL_ES)
 487         {
 488                 if(iface=="uniform")
 489                         return check_version(Version(3, 0));
 490                 else
 491                         return check_version(Version(3, 20));
 492         }
 493         else if(check_version(Version(1, 50)))
 494                 return true;
 495         else if(iface=="uniform")
 496                 return check_extension(&Features::arb_uniform_buffer_object);
 497         else
 498                 return false;
 499 }
 500
 501 void StructuralFeatureConverter::visit(VariableDeclaration &var)
 502 {
 503         if(var.block_declaration)
 504         {
 505                 bool push_constant = has_layout_qualifier(var.layout.get(), "push_constant");
 506                 if(!supports_interface_blocks(var.interface) || (push_constant && features.target_api!=VULKAN))
 507                 {
 508                         if(var.name.find(' ')==string::npos)
 509                                 unsupported("ARB_uniform_buffer_object required for interface block instances");
 510                         else
 511                         {
 512                                 for(const RefPtr<Statement> &s: var.block_declaration->members.body)
 513                                         if(VariableDeclaration *mem = dynamic_cast<VariableDeclaration *>(s.get()))
 514                                                 mem->interface = var.interface;
 515                                 stage->content.body.splice(uniform_insert_point, var.block_declaration->members.body);
 516                                 nodes_to_remove.insert(&var);
 517                                 nodes_to_remove.insert(var.block_declaration);
 518                         }
 519                 }
 520         }
 521
 522         if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
 523                 if(stage->type==Stage::FRAGMENT && var.interface=="out")
 524                 {
 525                         frag_out = &var;
 526                         nodes_to_remove.insert(&var);
 527                 }
 528
 529         TraversingVisitor::visit(var);
 530 }
 531
 532
 533 void QualifierConverter::apply()
 534 {
 535         stage->content.visit(*this);
 536 }
 537
 538 bool QualifierConverter::supports_interface_layouts() const
 539 {
 540         if(features.target_api==VULKAN)
 541                 return true;
 542         else if(features.target_api==OPENGL_ES)
 543                 return check_version(Version(3, 0));
 544         else if(check_version(Version(3, 30)))
 545                 return true;
 546         else if(check_version(Version(1, 30)))
 547                 return check_extension(&Features::arb_explicit_attrib_location);
 548         else
 549                 return false;
 550 }
 551
 552 bool QualifierConverter::supports_stage_interface_layouts() const
 553 {
 554         if(features.target_api==VULKAN)
 555                 return true;
 556         else if(features.target_api==OPENGL_ES)
 557                 return check_version(Version(3, 10));
 558         else if(check_version(Version(4, 10)))
 559                 return true;
 560         else
 561                 return check_extension(&Features::arb_separate_shader_objects);
 562 }
 563
 564 bool QualifierConverter::supports_centroid_sampling() const
 565 {
 566         if(features.target_api==VULKAN)
 567                 return true;
 568         else if(features.target_api==OPENGL_ES)
 569                 return check_version(Version(3, 0));
 570         else if(check_version(Version(1, 20)))
 571                 return true;
 572         else
 573                 return check_extension(&Features::ext_gpu_shader4);
 574 }
 575
 576 bool QualifierConverter::supports_sample_sampling() const
 577 {
 578         if(features.target_api==VULKAN)
 579                 return true;
 580         else if(features.target_api==OPENGL_ES)
 581                 return check_version(Version(3, 20));
 582         else if(check_version(Version(4, 0)))
 583                 return true;
 584         else
 585                 return check_extension(&Features::arb_gpu_shader5);
 586 }
 587
 588 bool QualifierConverter::supports_uniform_location() const
 589 {
 590         if(features.target_api==VULKAN)
 591                 return true;
 592         else if(features.target_api==OPENGL_ES)
 593                 return check_version(Version(3, 10));
 594         else if(check_version(Version(4, 30)))
 595                 return true;
 596         else
 597                 return check_extension(&Features::arb_explicit_uniform_location);
 598 }
 599
 600 bool QualifierConverter::supports_binding() const
 601 {
 602         if(features.target_api==VULKAN)
 603                 return true;
 604         else if(features.target_api==OPENGL_ES)
 605                 return check_version(Version(3, 10));
 606         else
 607                 return check_version(Version(4, 20));
 608 }
 609
 610 bool QualifierConverter::supports_interface_block_location() const
 611 {
 612         if(features.target_api==VULKAN)
 613                 return true;
 614         else if(features.target_api==OPENGL_ES)
 615                 return check_version(Version(3, 20));
 616         else if(check_version(Version(4, 40)))
 617                 return true;
 618         else
 619                 return check_extension(&Features::arb_enhanced_layouts);
 620 }
 621
 622 void QualifierConverter::visit(VariableDeclaration &var)
 623 {
 624         if(var.layout)
 625         {
 626                 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
 627                 {
 628                         if(i->name=="location")
 629                         {
 630                                 bool supported = true;
 631                                 bool external = false;
 632                                 if(var.block_declaration)
 633                                         supported = supports_interface_block_location();
 634                                 else if(var.interface=="in")
 635                                 {
 636                                         external = (stage->type==Stage::VERTEX);
 637                                         supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
 638                                 }
 639                                 else if(var.interface=="out")
 640                                 {
 641                                         external = (stage->type==Stage::FRAGMENT);
 642                                         supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
 643                                         if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
 644                                         {
 645                                                 external = false;
 646                                                 if(i->value!=0)
 647                                                         unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
 648                                         }
 649                                 }
 650                                 else if(var.interface=="uniform")
 651                                         supported = supports_uniform_location();
 652
 653                                 if(!supported)
 654                                 {
 655                                         if(external)
 656                                                 stage->locations[var.name] = i->value;
 657                                         i = var.layout->qualifiers.erase(i);
 658                                 }
 659                                 else
 660                                         ++i;
 661                         }
 662                         else if(i->name=="binding" && !supports_binding())
 663                         {
 664                                 if(var.block_declaration)
 665                                         stage->uniform_block_bindings[var.block_declaration->block_name] = i->value;
 666                                 else if(dynamic_cast<const ImageTypeDeclaration *>(get_ultimate_base_type(var.type_declaration)))
 667                                         stage->texture_bindings[var.name] = i->value;
 668
 669                                 i = var.layout->qualifiers.erase(i);
 670                         }
 671                         else
 672                                 ++i;
 673                 }
 674
 675                 if(var.layout->qualifiers.empty())
 676                         var.layout = 0;
 677         }
 678
 679         if(var.sampling=="centroid")
 680         {
 681                 if(!supports_centroid_sampling())
 682                         var.sampling = string();
 683         }
 684         else if(var.sampling=="sample")
 685         {
 686                 if(!supports_sample_sampling())
 687                         var.sampling = string();
 688         }
 689
 690         if(var.name=="gl_ClipDistance")
 691                 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
 692                         stage->n_clip_distances = literal_size->value.value<int>();
 693
 694         TraversingVisitor::visit(var);
 695 }
 696
 697 } // namespace SL
 698 } // namespace GL
 699 } // namespace Msp