1 #include <msp/core/algorithm.h>
2 #include <msp/core/hash.h>
3 #include <msp/core/raii.h>
4 #include <msp/strings/lexicalcast.h>
6 #include "glsl_error.h"
15 void StructOrganizer::visit(StructDeclaration &strct)
17 SetForScope<int> set_offset(offset, 0);
18 TraversingVisitor::visit(strct);
21 void StructOrganizer::visit(VariableDeclaration &var)
25 int *layout_offset = 0;
26 bool has_matrix_order = false;
29 for(Layout::Qualifier &q: var.layout->qualifiers)
31 if(q.name=="offset" && q.has_value)
33 layout_offset = &q.value;
37 else if(q.name=="column_major" || q.name=="row_major")
38 has_matrix_order = true;
42 MemoryRequirementsCalculator::Result mem_reqs = MemoryRequirementsCalculator().apply(var);
43 offset += mem_reqs.alignment-1;
44 offset -= offset%mem_reqs.alignment;
47 *layout_offset = offset;
51 var.layout = new Layout;
53 var.layout->qualifiers.push_back(Layout::Qualifier("offset", offset));
58 const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(var.type_declaration);
59 while(basic && basic->kind==BasicTypeDeclaration::ARRAY)
60 basic = dynamic_cast<const BasicTypeDeclaration *>(basic->base_type);
61 if(basic && basic->kind==BasicTypeDeclaration::MATRIX)
62 var.layout->qualifiers.push_back(Layout::Qualifier("column_major"));
65 offset += mem_reqs.size;
70 void LocationAllocator::apply(Module &module, const Features &features)
72 for(Stage &s: module.stages)
74 allocate_locations("uniform");
76 for(InterfaceBlock *b: unbound_blocks)
77 bind_uniform(b->layout, b->block_name, features.uniform_binding_range);
78 for(VariableDeclaration *t: unbound_textures)
79 bind_uniform(t->layout, t->name, features.texture_binding_range);
82 void LocationAllocator::apply(Stage &stage)
84 swap(used_locations["in"], used_locations["out"]);
85 used_locations["out"].clear();
87 stage.content.visit(*this);
89 allocate_locations("in");
90 allocate_locations("out");
93 void LocationAllocator::allocate_locations(const string &iface)
95 auto write = unplaced_variables.begin();
97 for(auto i=unplaced_variables.begin(); i!=unplaced_variables.end(); ++i)
99 if((*i)->interface!=iface)
107 if((*i)->interface=="uniform")
109 auto j = uniforms.find((*i)->name);
110 if(j!=uniforms.end() && j->second.location>=0)
112 add_layout_value((*i)->layout, "location", j->second.location);
117 set<unsigned> &used = used_locations[(*i)->interface];
119 unsigned size = LocationCounter().apply(**i);
123 for(unsigned j=0; j<size; ++j)
124 if(used.count(next+j))
131 add_layout_value((*i)->layout, "location", next);
132 if((*i)->interface=="uniform")
133 uniforms[(*i)->name].location = next;
135 for(unsigned j=0; j<size; ++j)
140 unplaced_variables.erase(write, unplaced_variables.end());
143 void LocationAllocator::bind_uniform(RefPtr<Layout> &layout, const string &name, unsigned range)
145 auto i = uniforms.find(name);
146 if(i!=uniforms.end() && i->second.bind_point>=0)
147 add_layout_value(layout, "binding", i->second.bind_point);
150 set<unsigned> &used = used_bindings[0];
152 unsigned bind_point = fold32(hash64(name))%range;
153 while(used.count(bind_point))
154 bind_point = (bind_point+1)%range;
156 add_layout_value(layout, "binding", bind_point);
157 uniforms[name].bind_point = bind_point;
158 used.insert(bind_point);
162 void LocationAllocator::add_layout_value(RefPtr<Layout> &layout, const string &name, unsigned value)
167 layout->qualifiers.push_back(Layout::Qualifier(name, value));
170 void LocationAllocator::visit(VariableDeclaration &var)
172 if(!var.name.compare(0, 3, "gl_"))
175 if(!var.interface.empty())
177 int location = (var.layout ? get_layout_value(*var.layout, "location") : -1);
179 if(location<0 && var.linked_declaration && var.linked_declaration->layout)
181 location = get_layout_value(*var.linked_declaration->layout, "location");
183 add_layout_value(var.layout, "location", location);
188 unsigned size = LocationCounter().apply(var);
189 for(unsigned i=0; i<size; ++i)
190 used_locations[var.interface].insert(location+i);
191 if(var.interface=="uniform")
192 uniforms[var.name].location = location;
195 unplaced_variables.push_back(&var);
198 if(var.interface=="uniform")
200 const TypeDeclaration *type = var.type_declaration;
201 while(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
202 type = basic->base_type;
203 if(dynamic_cast<const ImageTypeDeclaration *>(type))
205 int bind_point = (var.layout ? get_layout_value(*var.layout, "binding") : -1);
208 used_bindings[0].insert(bind_point);
209 uniforms[var.name].bind_point = bind_point;
212 unbound_textures.push_back(&var);
217 void LocationAllocator::visit(InterfaceBlock &iface)
219 if(!iface.instance_name.compare(0, 3, "gl_"))
222 if(iface.interface=="uniform")
224 bool push_constant = false;
227 auto i = find_member(iface.layout->qualifiers, string("push_constant"), &Layout::Qualifier::name);
228 push_constant = (i!=iface.layout->qualifiers.end());
233 int bind_point = (iface.layout ? get_layout_value(*iface.layout, "binding") : -1);
237 used_bindings[0].insert(bind_point);
238 uniforms[iface.block_name].bind_point = bind_point;
241 unbound_blocks.push_back(&iface);
247 void PrecisionConverter::apply(Stage &s)
250 s.content.visit(*this);
251 NodeRemover().apply(s, nodes_to_remove);
254 void PrecisionConverter::visit(Block &block)
256 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
258 if(&block==&stage->content)
264 void PrecisionConverter::visit(Precision &prec)
266 if(stage->required_features.target_api==OPENGL_ES)
267 have_default.insert(prec.type);
269 nodes_to_remove.insert(&prec);
272 void PrecisionConverter::visit(VariableDeclaration &var)
274 if(stage->required_features.target_api!=OPENGL_ES)
276 var.precision.clear();
280 const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
281 const TypeDeclaration *type = var.type_declaration;
284 if(dynamic_cast<const ImageTypeDeclaration *>(type))
286 default_prec = "lowp";
289 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
291 if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
293 type = basic->base_type;
301 if(!have_default.count(type->name))
303 Precision *prec = new Precision;
304 prec->precision = default_prec;
305 prec->type = type->name;
306 stage->content.body.insert(insert_point, prec);
308 have_default.insert(type->name);
313 void FeatureConverter::apply(Stage &s, const Features &feat)
317 if(supports_stage(s.type))
319 s.content.visit(*this);
320 NodeRemover().apply(s, nodes_to_remove);
322 if(!stage->required_features.glsl_version)
323 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
326 unsupported(format("Stage %s is not supported", Stage::get_stage_name(s.type)));
329 void FeatureConverter::unsupported(const string &reason)
331 Diagnostic diagnostic;
332 diagnostic.severity = Diagnostic::ERR;
333 diagnostic.source = GENERATED_SOURCE;
335 diagnostic.message = reason;
336 stage->diagnostics.push_back(diagnostic);
339 void FeatureConverter::visit(Block &block)
341 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
343 if(&block==&stage->content)
344 uniform_insert_point = i;
349 void FeatureConverter::visit(RefPtr<Expression> &expr)
351 r_replaced_reference = 0;
353 if(r_replaced_reference)
354 expr = r_replaced_reference;
355 r_replaced_reference = 0;
358 bool FeatureConverter::check_version(const Version &feature_version) const
360 if(features.glsl_version<feature_version)
362 else if(stage->required_features.glsl_version<feature_version)
363 stage->required_features.glsl_version = feature_version;
368 bool FeatureConverter::check_extension(bool Features::*extension) const
370 if(!(features.*extension))
373 stage->required_features.*extension = true;
378 bool FeatureConverter::supports_stage(Stage::Type st) const
380 if(st==Stage::GEOMETRY)
382 if(features.target_api==OPENGL_ES)
383 return check_version(Version(3, 20));
385 return check_version(Version(1, 50));
391 bool FeatureConverter::supports_unified_interface_syntax() const
393 if(features.target_api==OPENGL_ES)
394 return check_version(Version(3, 0));
396 return check_version(Version(1, 30));
399 void FeatureConverter::visit(VariableReference &var)
401 if(var.declaration==frag_out && !supports_unified_interface_syntax())
403 var.name = "gl_FragColor";
408 void FeatureConverter::visit(InterfaceBlockReference &iface)
410 r_flattened_interface = nodes_to_remove.count(iface.declaration);
413 void FeatureConverter::visit(MemberAccess &memacc)
415 r_flattened_interface = false;
417 if(r_flattened_interface)
419 VariableReference *var = new VariableReference;
420 var->name = memacc.member;
421 r_replaced_reference = var;
425 void FeatureConverter::visit(Assignment &assign)
427 TraversingVisitor::visit(assign);
428 if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
429 assign.target.declaration = 0;
432 bool FeatureConverter::supports_unified_sampling_functions() const
434 if(features.target_api==OPENGL_ES)
435 return check_version(Version(3, 0));
437 return check_version(Version(1, 30));
440 void FeatureConverter::visit(FunctionCall &call)
442 if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
444 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
446 const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
447 if(arg_image && !supports_unified_sampling_functions())
449 string suffix = call.name.substr(7);
450 call.name = (arg_image->shadow ? "shadow" : "texture");
452 switch(arg_image->dimensions)
454 case ImageTypeDeclaration::ONE: call.name += "1D"; break;
455 case ImageTypeDeclaration::TWO: call.name += "2D"; break;
456 case ImageTypeDeclaration::THREE: call.name += "3D"; break;
457 case ImageTypeDeclaration::CUBE: call.name += "Cube"; break;
462 /* Array textures and the unified sampling function name were
463 both introduced in GLSL 1.30. */
464 if(arg_image->dimensions==ImageTypeDeclaration::ONE || arg_image->dimensions==ImageTypeDeclaration::TWO)
465 check_extension(&Features::ext_texture_array);
466 call.name += "Array";
474 TraversingVisitor::visit(call);
477 bool FeatureConverter::supports_interface_layouts() const
479 if(features.target_api==OPENGL_ES)
480 return check_version(Version(3, 0));
481 else if(check_version(Version(3, 30)))
483 else if(check_version(Version(1, 30)))
484 return check_extension(&Features::arb_explicit_attrib_location);
489 bool FeatureConverter::supports_stage_interface_layouts() const
491 if(features.target_api==OPENGL_ES)
492 return check_version(Version(3, 10));
493 else if(check_version(Version(4, 10)))
496 return check_extension(&Features::arb_separate_shader_objects);
499 bool FeatureConverter::supports_centroid_sampling() const
501 if(features.target_api==OPENGL_ES)
502 return check_version(Version(3, 0));
503 else if(check_version(Version(1, 20)))
506 return check_extension(&Features::ext_gpu_shader4);
509 bool FeatureConverter::supports_sample_sampling() const
511 if(features.target_api==OPENGL_ES)
512 return check_version(Version(3, 20));
513 else if(check_version(Version(4, 0)))
516 return check_extension(&Features::arb_gpu_shader5);
519 bool FeatureConverter::supports_uniform_location() const
521 if(features.target_api==OPENGL_ES)
522 return check_version(Version(3, 10));
523 else if(check_version(Version(4, 30)))
526 return check_extension(&Features::arb_explicit_uniform_location);
529 bool FeatureConverter::supports_binding() const
531 if(features.target_api==OPENGL_ES)
532 return check_version(Version(3, 10));
534 return check_version(Version(4, 20));
537 void FeatureConverter::visit(VariableDeclaration &var)
541 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
543 if(i->name=="location")
545 bool supported = true;
546 bool external = false;
547 if(var.interface=="in")
549 external = (stage->type==Stage::VERTEX);
550 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
552 else if(var.interface=="out")
554 external = (stage->type==Stage::FRAGMENT);
555 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
556 if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
560 unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
563 else if(var.interface=="uniform")
564 supported = supports_uniform_location();
569 stage->locations[var.name] = i->value;
570 i = var.layout->qualifiers.erase(i);
575 else if(i->name=="binding" && !supports_binding())
577 const TypeDeclaration *type = var.type_declaration;
578 while(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
579 type = basic->base_type;
580 if(dynamic_cast<const ImageTypeDeclaration *>(type))
581 stage->texture_bindings[var.name] = i->value;
583 i = var.layout->qualifiers.erase(i);
589 if(var.layout->qualifiers.empty())
593 if(var.sampling=="centroid")
595 if(!supports_centroid_sampling())
596 var.sampling = string();
598 else if(var.sampling=="sample")
600 if(!supports_sample_sampling())
601 var.sampling = string();
604 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
606 if(stage->type==Stage::FRAGMENT && var.interface=="out")
609 nodes_to_remove.insert(&var);
613 if(var.name=="gl_ClipDistance")
614 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
615 stage->n_clip_distances = literal_size->value.value<int>();
617 TraversingVisitor::visit(var);
620 bool FeatureConverter::supports_interface_blocks(const string &iface) const
622 if(features.target_api==OPENGL_ES)
625 return check_version(Version(3, 0));
627 return check_version(Version(3, 20));
629 else if(check_version(Version(1, 50)))
631 else if(iface=="uniform")
632 return check_extension(&Features::arb_uniform_buffer_object);
637 bool FeatureConverter::supports_interface_block_location() const
639 if(features.target_api==OPENGL_ES)
640 return check_version(Version(3, 20));
641 else if(check_version(Version(4, 40)))
644 return check_extension(&Features::arb_enhanced_layouts);
647 void FeatureConverter::visit(InterfaceBlock &iface)
649 bool push_constant = false;
652 for(auto i=iface.layout->qualifiers.begin(); i!=iface.layout->qualifiers.end(); )
654 if(i->name=="location" && !supports_interface_block_location())
655 i = iface.layout->qualifiers.erase(i);
656 else if(i->name=="binding" && !supports_binding())
658 stage->uniform_block_bindings[iface.block_name] = i->value;
659 i = iface.layout->qualifiers.erase(i);
663 if(i->name=="push_constant")
664 push_constant = true;
669 if(iface.layout->qualifiers.empty())
673 if((!supports_interface_blocks(iface.interface) || push_constant) && iface.type_declaration)
675 if(!iface.instance_name.empty())
676 unsupported("ARB_uniform_buffer_object required for interface block instances");
677 else if(iface.struct_declaration)
679 for(const RefPtr<Statement> &s: iface.struct_declaration->members.body)
680 if(VariableDeclaration *var = dynamic_cast<VariableDeclaration *>(s.get()))
681 var->interface = iface.interface;
682 stage->content.body.splice(uniform_insert_point, iface.struct_declaration->members.body);
683 nodes_to_remove.insert(&iface);
684 nodes_to_remove.insert(iface.struct_declaration);
687 /* If the interface block is an array, it should have an instance
688 name too, so this should never be reached */
689 throw logic_error("Unexpected interface block configuration");