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;
49 add_layout_qualifier(var.layout, Layout::Qualifier("offset", offset));
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"));
60 offset += mem_reqs.size;
65 void LocationAllocator::apply(Module &module, const Features &f, bool a)
69 for(Stage &s: module.stages)
72 if(features.target_api!=VULKAN)
73 allocate_locations("uniform");
75 for(InterfaceBlock *b: unbound_blocks)
76 bind_uniform(b->layout, b->block_name, features.uniform_binding_range);
77 for(VariableDeclaration *t: unbound_textures)
78 bind_uniform(t->layout, t->name, features.texture_binding_range);
81 void LocationAllocator::apply(Stage &stage)
83 swap(used_locations["in"], used_locations["out"]);
84 used_locations["out"].clear();
86 stage.content.visit(*this);
88 allocate_locations("in");
89 allocate_locations("out");
92 void LocationAllocator::allocate_locations(const string &iface)
94 auto write = unplaced_variables.begin();
96 for(auto i=unplaced_variables.begin(); i!=unplaced_variables.end(); ++i)
98 if((*i)->interface!=iface)
106 if((*i)->interface=="uniform")
108 auto j = uniforms.find((*i)->name);
109 if(j!=uniforms.end() && j->second.location>=0)
111 add_layout_qualifier((*i)->layout, Layout::Qualifier("location", j->second.location));
119 set<unsigned> &used = used_locations[(*i)->interface];
121 unsigned size = LocationCounter().apply(**i);
125 for(unsigned j=0; j<size; ++j)
126 if(used.count(next+j))
133 add_layout_qualifier((*i)->layout, Layout::Qualifier("location", next));
134 if((*i)->interface=="uniform")
135 uniforms[(*i)->name].location = next;
137 for(unsigned j=0; j<size; ++j)
142 unplaced_variables.erase(write, unplaced_variables.end());
145 void LocationAllocator::bind_uniform(RefPtr<Layout> &layout, const string &name, unsigned range)
147 auto i = uniforms.find(name);
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));
153 if(i!=uniforms.end() && i->second.bind_point>=0)
154 add_layout_qualifier(layout, Layout::Qualifier("binding", i->second.bind_point));
157 set<unsigned> &used = used_bindings[desc_set];
159 unsigned bind_point = hash_fold<32>(hash<64>(name))%range;
160 while(used.count(bind_point))
161 bind_point = (bind_point+1)%range;
163 add_layout_qualifier(layout, Layout::Qualifier("binding", bind_point));
164 uniforms[name].bind_point = bind_point;
165 used.insert(bind_point);
169 bool LocationAllocator::visit_uniform(const string &name, RefPtr<Layout> &layout)
172 int bind_point = get_layout_value(layout.get(), "binding");
174 if(features.target_api==VULKAN)
176 desc_set = get_layout_value(layout.get(), "set");
177 if(desc_set<0 && bind_point>=0)
180 add_layout_qualifier(layout, Layout::Qualifier("set", desc_set));
184 uniforms[name].desc_set = desc_set;
189 used_bindings[desc_set].insert(bind_point);
190 uniforms[name].bind_point = bind_point;
193 return bind_point>=0;
196 void LocationAllocator::visit(VariableDeclaration &var)
198 if(!var.name.compare(0, 3, "gl_"))
201 if(!var.interface.empty())
203 int location = get_layout_value(var.layout.get(), "location");
205 if(location<0 && var.linked_declaration && var.linked_declaration->layout)
207 location = get_layout_value(var.linked_declaration->layout.get(), "location");
209 add_layout_qualifier(var.layout, Layout::Qualifier("location", location));
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;
221 unplaced_variables.push_back(&var);
224 if(var.interface=="uniform")
226 const TypeDeclaration *base_type = get_ultimate_base_type(var.type_declaration);
227 if(dynamic_cast<const ImageTypeDeclaration *>(base_type) && !visit_uniform(var.name, var.layout))
228 unbound_textures.push_back(&var);
232 void LocationAllocator::visit(InterfaceBlock &iface)
234 if(!iface.instance_name.compare(0, 3, "gl_"))
237 if(iface.interface=="uniform")
239 bool push_constant = has_layout_qualifier(iface.layout.get(), "push_constant");
240 if(!push_constant && !visit_uniform(iface.block_name, iface.layout))
241 unbound_blocks.push_back(&iface);
246 void PrecisionConverter::apply(Stage &s)
249 s.content.visit(*this);
250 NodeRemover().apply(s, nodes_to_remove);
253 void PrecisionConverter::visit(Block &block)
255 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
257 if(&block==&stage->content)
263 void PrecisionConverter::visit(Precision &prec)
265 if(stage->required_features.target_api==OPENGL_ES)
266 have_default.insert(prec.type);
268 nodes_to_remove.insert(&prec);
271 void PrecisionConverter::visit(VariableDeclaration &var)
273 if(stage->required_features.target_api!=OPENGL_ES)
275 var.precision.clear();
279 const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
280 const TypeDeclaration *type = var.type_declaration;
283 if(dynamic_cast<const ImageTypeDeclaration *>(type))
285 default_prec = "lowp";
288 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
290 if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
292 type = basic->base_type;
300 if(!have_default.count(type->name))
302 Precision *prec = new Precision;
303 prec->precision = default_prec;
304 prec->type = type->name;
305 stage->content.body.insert(insert_point, prec);
307 have_default.insert(type->name);
312 void FeatureConverter::apply(Stage &s, const Features &feat)
317 if(!stage->required_features.glsl_version)
318 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
323 void FeatureConverter::unsupported(const string &reason)
325 Diagnostic diagnostic;
326 diagnostic.severity = Diagnostic::ERR;
327 diagnostic.source = GENERATED_SOURCE;
329 diagnostic.message = reason;
330 stage->diagnostics.push_back(diagnostic);
333 bool FeatureConverter::check_version(const Version &feature_version) const
335 if(features.glsl_version<feature_version)
337 else if(stage->required_features.glsl_version<feature_version)
338 stage->required_features.glsl_version = feature_version;
343 bool FeatureConverter::check_extension(bool Features::*extension) const
345 if(!(features.*extension))
348 stage->required_features.*extension = true;
354 void StructuralFeatureConverter::apply()
356 if(supports_stage(stage->type))
358 stage->content.visit(*this);
359 NodeRemover().apply(*stage, nodes_to_remove);
362 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
365 void StructuralFeatureConverter::visit(Block &block)
367 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
369 if(&block==&stage->content)
370 uniform_insert_point = i;
375 void StructuralFeatureConverter::visit(RefPtr<Expression> &expr)
377 r_replaced_reference = 0;
379 if(r_replaced_reference)
380 expr = r_replaced_reference;
381 r_replaced_reference = 0;
384 bool StructuralFeatureConverter::supports_stage(Stage::Type st) const
386 if(st==Stage::GEOMETRY)
388 if(features.target_api==VULKAN)
390 else if(features.target_api==OPENGL_ES)
391 return check_version(Version(3, 20));
393 return check_version(Version(1, 50));
399 bool StructuralFeatureConverter::supports_unified_interface_syntax() const
401 if(features.target_api==VULKAN)
403 else if(features.target_api==OPENGL_ES)
404 return check_version(Version(3, 0));
406 return check_version(Version(1, 30));
409 void StructuralFeatureConverter::visit(VariableReference &var)
411 if(var.declaration==frag_out && !supports_unified_interface_syntax())
413 var.name = "gl_FragColor";
418 void StructuralFeatureConverter::visit(InterfaceBlockReference &iface)
420 r_flattened_interface = nodes_to_remove.count(iface.declaration);
423 void StructuralFeatureConverter::visit(MemberAccess &memacc)
425 r_flattened_interface = false;
427 if(r_flattened_interface)
429 VariableReference *var = new VariableReference;
430 var->name = memacc.member;
431 r_replaced_reference = var;
435 void StructuralFeatureConverter::visit(Assignment &assign)
437 TraversingVisitor::visit(assign);
438 if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
439 assign.target.declaration = 0;
442 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
444 if(features.target_api==VULKAN)
446 else if(features.target_api==OPENGL_ES)
447 return check_version(Version(3, 0));
449 return check_version(Version(1, 30));
452 void StructuralFeatureConverter::visit(FunctionCall &call)
454 if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
456 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
458 const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
459 if(arg_image && !supports_unified_sampling_functions())
461 string suffix = call.name.substr(7);
462 call.name = (arg_image->shadow ? "shadow" : "texture");
464 switch(arg_image->dimensions)
466 case ImageTypeDeclaration::ONE: call.name += "1D"; break;
467 case ImageTypeDeclaration::TWO: call.name += "2D"; break;
468 case ImageTypeDeclaration::THREE: call.name += "3D"; break;
469 case ImageTypeDeclaration::CUBE: call.name += "Cube"; break;
474 /* Array textures and the unified sampling function name were
475 both introduced in GLSL 1.30. */
476 if(arg_image->dimensions==ImageTypeDeclaration::ONE || arg_image->dimensions==ImageTypeDeclaration::TWO)
477 check_extension(&Features::ext_texture_array);
478 call.name += "Array";
486 TraversingVisitor::visit(call);
489 void StructuralFeatureConverter::visit(VariableDeclaration &var)
491 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
492 if(stage->type==Stage::FRAGMENT && var.interface=="out")
495 nodes_to_remove.insert(&var);
498 TraversingVisitor::visit(var);
501 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
503 if(features.target_api==VULKAN)
505 else if(features.target_api==OPENGL_ES)
508 return check_version(Version(3, 0));
510 return check_version(Version(3, 20));
512 else if(check_version(Version(1, 50)))
514 else if(iface=="uniform")
515 return check_extension(&Features::arb_uniform_buffer_object);
520 void StructuralFeatureConverter::visit(InterfaceBlock &iface)
522 bool push_constant = has_layout_qualifier(iface.layout.get(), "push_constant");
523 if((!supports_interface_blocks(iface.interface) || (push_constant && features.target_api!=VULKAN)) && iface.type_declaration)
525 if(!iface.instance_name.empty())
526 unsupported("ARB_uniform_buffer_object required for interface block instances");
527 else if(iface.struct_declaration)
529 for(const RefPtr<Statement> &s: iface.struct_declaration->members.body)
530 if(VariableDeclaration *var = dynamic_cast<VariableDeclaration *>(s.get()))
531 var->interface = iface.interface;
532 stage->content.body.splice(uniform_insert_point, iface.struct_declaration->members.body);
533 nodes_to_remove.insert(&iface);
534 nodes_to_remove.insert(iface.struct_declaration);
537 /* If the interface block is an array, it should have an instance
538 name too, so this should never be reached */
539 throw logic_error("Unexpected interface block configuration");
544 void QualifierConverter::apply()
546 stage->content.visit(*this);
549 bool QualifierConverter::supports_interface_layouts() const
551 if(features.target_api==VULKAN)
553 else if(features.target_api==OPENGL_ES)
554 return check_version(Version(3, 0));
555 else if(check_version(Version(3, 30)))
557 else if(check_version(Version(1, 30)))
558 return check_extension(&Features::arb_explicit_attrib_location);
563 bool QualifierConverter::supports_stage_interface_layouts() const
565 if(features.target_api==VULKAN)
567 else if(features.target_api==OPENGL_ES)
568 return check_version(Version(3, 10));
569 else if(check_version(Version(4, 10)))
572 return check_extension(&Features::arb_separate_shader_objects);
575 bool QualifierConverter::supports_centroid_sampling() const
577 if(features.target_api==VULKAN)
579 else if(features.target_api==OPENGL_ES)
580 return check_version(Version(3, 0));
581 else if(check_version(Version(1, 20)))
584 return check_extension(&Features::ext_gpu_shader4);
587 bool QualifierConverter::supports_sample_sampling() const
589 if(features.target_api==VULKAN)
591 else if(features.target_api==OPENGL_ES)
592 return check_version(Version(3, 20));
593 else if(check_version(Version(4, 0)))
596 return check_extension(&Features::arb_gpu_shader5);
599 bool QualifierConverter::supports_uniform_location() const
601 if(features.target_api==VULKAN)
603 else if(features.target_api==OPENGL_ES)
604 return check_version(Version(3, 10));
605 else if(check_version(Version(4, 30)))
608 return check_extension(&Features::arb_explicit_uniform_location);
611 bool QualifierConverter::supports_binding() const
613 if(features.target_api==VULKAN)
615 else if(features.target_api==OPENGL_ES)
616 return check_version(Version(3, 10));
618 return check_version(Version(4, 20));
621 void QualifierConverter::visit(VariableDeclaration &var)
625 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
627 if(i->name=="location")
629 bool supported = true;
630 bool external = false;
631 if(var.interface=="in")
633 external = (stage->type==Stage::VERTEX);
634 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
636 else if(var.interface=="out")
638 external = (stage->type==Stage::FRAGMENT);
639 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
640 if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
644 unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
647 else if(var.interface=="uniform")
648 supported = supports_uniform_location();
653 stage->locations[var.name] = i->value;
654 i = var.layout->qualifiers.erase(i);
659 else if(i->name=="binding" && !supports_binding())
661 if(dynamic_cast<const ImageTypeDeclaration *>(get_ultimate_base_type(var.type_declaration)))
662 stage->texture_bindings[var.name] = i->value;
664 i = var.layout->qualifiers.erase(i);
670 if(var.layout->qualifiers.empty())
674 if(var.sampling=="centroid")
676 if(!supports_centroid_sampling())
677 var.sampling = string();
679 else if(var.sampling=="sample")
681 if(!supports_sample_sampling())
682 var.sampling = string();
685 if(var.name=="gl_ClipDistance")
686 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
687 stage->n_clip_distances = literal_size->value.value<int>();
689 TraversingVisitor::visit(var);
692 bool QualifierConverter::supports_interface_block_location() const
694 if(features.target_api==VULKAN)
696 else if(features.target_api==OPENGL_ES)
697 return check_version(Version(3, 20));
698 else if(check_version(Version(4, 40)))
701 return check_extension(&Features::arb_enhanced_layouts);
704 void QualifierConverter::visit(InterfaceBlock &iface)
708 for(auto i=iface.layout->qualifiers.begin(); i!=iface.layout->qualifiers.end(); )
710 if(i->name=="location" && !supports_interface_block_location())
711 i = iface.layout->qualifiers.erase(i);
712 else if(i->name=="binding" && !supports_binding())
714 stage->uniform_block_bindings[iface.block_name] = i->value;
715 i = iface.layout->qualifiers.erase(i);
721 if(iface.layout->qualifiers.empty())