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 &features)
67 for(Stage &s: module.stages)
70 if(features.target_api!=VULKAN)
71 allocate_locations("uniform");
73 for(InterfaceBlock *b: unbound_blocks)
74 bind_uniform(b->layout, b->block_name, features.uniform_binding_range);
75 for(VariableDeclaration *t: unbound_textures)
76 bind_uniform(t->layout, t->name, features.texture_binding_range);
79 void LocationAllocator::apply(Stage &stage)
81 swap(used_locations["in"], used_locations["out"]);
82 used_locations["out"].clear();
84 stage.content.visit(*this);
86 allocate_locations("in");
87 allocate_locations("out");
90 void LocationAllocator::allocate_locations(const string &iface)
92 auto write = unplaced_variables.begin();
94 for(auto i=unplaced_variables.begin(); i!=unplaced_variables.end(); ++i)
96 if((*i)->interface!=iface)
104 if((*i)->interface=="uniform")
106 auto j = uniforms.find((*i)->name);
107 if(j!=uniforms.end() && j->second.location>=0)
109 add_layout_qualifier((*i)->layout, Layout::Qualifier("location", j->second.location));
114 set<unsigned> &used = used_locations[(*i)->interface];
116 unsigned size = LocationCounter().apply(**i);
120 for(unsigned j=0; j<size; ++j)
121 if(used.count(next+j))
128 add_layout_qualifier((*i)->layout, Layout::Qualifier("location", next));
129 if((*i)->interface=="uniform")
130 uniforms[(*i)->name].location = next;
132 for(unsigned j=0; j<size; ++j)
137 unplaced_variables.erase(write, unplaced_variables.end());
140 void LocationAllocator::bind_uniform(RefPtr<Layout> &layout, const string &name, unsigned range)
142 auto i = uniforms.find(name);
143 if(i!=uniforms.end() && i->second.bind_point>=0)
144 add_layout_qualifier(layout, Layout::Qualifier("binding", i->second.bind_point));
147 set<unsigned> &used = used_bindings[0];
149 unsigned bind_point = fold32(hash64(name))%range;
150 while(used.count(bind_point))
151 bind_point = (bind_point+1)%range;
153 add_layout_qualifier(layout, Layout::Qualifier("binding", bind_point));
154 uniforms[name].bind_point = bind_point;
155 used.insert(bind_point);
159 bool LocationAllocator::visit_uniform(const string &name, RefPtr<Layout> &layout)
161 int bind_point = get_layout_value(layout.get(), "binding");
164 used_bindings[0].insert(bind_point);
165 uniforms[name].bind_point = bind_point;
167 return bind_point>=0;
170 void LocationAllocator::visit(VariableDeclaration &var)
172 if(!var.name.compare(0, 3, "gl_"))
175 if(!var.interface.empty())
177 int location = get_layout_value(var.layout.get(), "location");
179 if(location<0 && var.linked_declaration && var.linked_declaration->layout)
181 location = get_layout_value(var.linked_declaration->layout.get(), "location");
183 add_layout_qualifier(var.layout, Layout::Qualifier("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 *base_type = get_ultimate_base_type(var.type_declaration);
201 if(dynamic_cast<const ImageTypeDeclaration *>(base_type) && !visit_uniform(var.name, var.layout))
202 unbound_textures.push_back(&var);
206 void LocationAllocator::visit(InterfaceBlock &iface)
208 if(!iface.instance_name.compare(0, 3, "gl_"))
211 if(iface.interface=="uniform")
213 bool push_constant = has_layout_qualifier(iface.layout.get(), "push_constant");
214 if(!push_constant && !visit_uniform(iface.block_name, iface.layout))
215 unbound_blocks.push_back(&iface);
220 void PrecisionConverter::apply(Stage &s)
223 s.content.visit(*this);
224 NodeRemover().apply(s, nodes_to_remove);
227 void PrecisionConverter::visit(Block &block)
229 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
231 if(&block==&stage->content)
237 void PrecisionConverter::visit(Precision &prec)
239 if(stage->required_features.target_api==OPENGL_ES)
240 have_default.insert(prec.type);
242 nodes_to_remove.insert(&prec);
245 void PrecisionConverter::visit(VariableDeclaration &var)
247 if(stage->required_features.target_api!=OPENGL_ES)
249 var.precision.clear();
253 const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
254 const TypeDeclaration *type = var.type_declaration;
257 if(dynamic_cast<const ImageTypeDeclaration *>(type))
259 default_prec = "lowp";
262 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
264 if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
266 type = basic->base_type;
274 if(!have_default.count(type->name))
276 Precision *prec = new Precision;
277 prec->precision = default_prec;
278 prec->type = type->name;
279 stage->content.body.insert(insert_point, prec);
281 have_default.insert(type->name);
286 void FeatureConverter::apply(Stage &s, const Features &feat)
291 if(!stage->required_features.glsl_version)
292 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
297 void FeatureConverter::unsupported(const string &reason)
299 Diagnostic diagnostic;
300 diagnostic.severity = Diagnostic::ERR;
301 diagnostic.source = GENERATED_SOURCE;
303 diagnostic.message = reason;
304 stage->diagnostics.push_back(diagnostic);
307 bool FeatureConverter::check_version(const Version &feature_version) const
309 if(features.glsl_version<feature_version)
311 else if(stage->required_features.glsl_version<feature_version)
312 stage->required_features.glsl_version = feature_version;
317 bool FeatureConverter::check_extension(bool Features::*extension) const
319 if(!(features.*extension))
322 stage->required_features.*extension = true;
328 void StructuralFeatureConverter::apply()
330 if(supports_stage(stage->type))
332 stage->content.visit(*this);
333 NodeRemover().apply(*stage, nodes_to_remove);
336 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
339 void StructuralFeatureConverter::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 StructuralFeatureConverter::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 StructuralFeatureConverter::supports_stage(Stage::Type st) const
360 if(st==Stage::GEOMETRY)
362 if(features.target_api==VULKAN)
364 else if(features.target_api==OPENGL_ES)
365 return check_version(Version(3, 20));
367 return check_version(Version(1, 50));
373 bool StructuralFeatureConverter::supports_unified_interface_syntax() const
375 if(features.target_api==VULKAN)
377 else if(features.target_api==OPENGL_ES)
378 return check_version(Version(3, 0));
380 return check_version(Version(1, 30));
383 void StructuralFeatureConverter::visit(VariableReference &var)
385 if(var.declaration==frag_out && !supports_unified_interface_syntax())
387 var.name = "gl_FragColor";
392 void StructuralFeatureConverter::visit(InterfaceBlockReference &iface)
394 r_flattened_interface = nodes_to_remove.count(iface.declaration);
397 void StructuralFeatureConverter::visit(MemberAccess &memacc)
399 r_flattened_interface = false;
401 if(r_flattened_interface)
403 VariableReference *var = new VariableReference;
404 var->name = memacc.member;
405 r_replaced_reference = var;
409 void StructuralFeatureConverter::visit(Assignment &assign)
411 TraversingVisitor::visit(assign);
412 if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
413 assign.target.declaration = 0;
416 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
418 if(features.target_api==VULKAN)
420 else if(features.target_api==OPENGL_ES)
421 return check_version(Version(3, 0));
423 return check_version(Version(1, 30));
426 void StructuralFeatureConverter::visit(FunctionCall &call)
428 if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
430 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
432 const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
433 if(arg_image && !supports_unified_sampling_functions())
435 string suffix = call.name.substr(7);
436 call.name = (arg_image->shadow ? "shadow" : "texture");
438 switch(arg_image->dimensions)
440 case ImageTypeDeclaration::ONE: call.name += "1D"; break;
441 case ImageTypeDeclaration::TWO: call.name += "2D"; break;
442 case ImageTypeDeclaration::THREE: call.name += "3D"; break;
443 case ImageTypeDeclaration::CUBE: call.name += "Cube"; break;
448 /* Array textures and the unified sampling function name were
449 both introduced in GLSL 1.30. */
450 if(arg_image->dimensions==ImageTypeDeclaration::ONE || arg_image->dimensions==ImageTypeDeclaration::TWO)
451 check_extension(&Features::ext_texture_array);
452 call.name += "Array";
460 TraversingVisitor::visit(call);
463 void StructuralFeatureConverter::visit(VariableDeclaration &var)
465 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
466 if(stage->type==Stage::FRAGMENT && var.interface=="out")
469 nodes_to_remove.insert(&var);
472 TraversingVisitor::visit(var);
475 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
477 if(features.target_api==VULKAN)
479 else if(features.target_api==OPENGL_ES)
482 return check_version(Version(3, 0));
484 return check_version(Version(3, 20));
486 else if(check_version(Version(1, 50)))
488 else if(iface=="uniform")
489 return check_extension(&Features::arb_uniform_buffer_object);
494 void StructuralFeatureConverter::visit(InterfaceBlock &iface)
496 bool push_constant = has_layout_qualifier(iface.layout.get(), "push_constant");
497 if((!supports_interface_blocks(iface.interface) || (push_constant && features.target_api!=VULKAN)) && iface.type_declaration)
499 if(!iface.instance_name.empty())
500 unsupported("ARB_uniform_buffer_object required for interface block instances");
501 else if(iface.struct_declaration)
503 for(const RefPtr<Statement> &s: iface.struct_declaration->members.body)
504 if(VariableDeclaration *var = dynamic_cast<VariableDeclaration *>(s.get()))
505 var->interface = iface.interface;
506 stage->content.body.splice(uniform_insert_point, iface.struct_declaration->members.body);
507 nodes_to_remove.insert(&iface);
508 nodes_to_remove.insert(iface.struct_declaration);
511 /* If the interface block is an array, it should have an instance
512 name too, so this should never be reached */
513 throw logic_error("Unexpected interface block configuration");
518 void QualifierConverter::apply()
520 stage->content.visit(*this);
523 bool QualifierConverter::supports_interface_layouts() const
525 if(features.target_api==VULKAN)
527 else if(features.target_api==OPENGL_ES)
528 return check_version(Version(3, 0));
529 else if(check_version(Version(3, 30)))
531 else if(check_version(Version(1, 30)))
532 return check_extension(&Features::arb_explicit_attrib_location);
537 bool QualifierConverter::supports_stage_interface_layouts() const
539 if(features.target_api==VULKAN)
541 else if(features.target_api==OPENGL_ES)
542 return check_version(Version(3, 10));
543 else if(check_version(Version(4, 10)))
546 return check_extension(&Features::arb_separate_shader_objects);
549 bool QualifierConverter::supports_centroid_sampling() 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(1, 20)))
558 return check_extension(&Features::ext_gpu_shader4);
561 bool QualifierConverter::supports_sample_sampling() const
563 if(features.target_api==VULKAN)
565 else if(features.target_api==OPENGL_ES)
566 return check_version(Version(3, 20));
567 else if(check_version(Version(4, 0)))
570 return check_extension(&Features::arb_gpu_shader5);
573 bool QualifierConverter::supports_uniform_location() const
575 if(features.target_api==VULKAN)
577 else if(features.target_api==OPENGL_ES)
578 return check_version(Version(3, 10));
579 else if(check_version(Version(4, 30)))
582 return check_extension(&Features::arb_explicit_uniform_location);
585 bool QualifierConverter::supports_binding() const
587 if(features.target_api==VULKAN)
589 else if(features.target_api==OPENGL_ES)
590 return check_version(Version(3, 10));
592 return check_version(Version(4, 20));
595 void QualifierConverter::visit(VariableDeclaration &var)
599 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
601 if(i->name=="location")
603 bool supported = true;
604 bool external = false;
605 if(var.interface=="in")
607 external = (stage->type==Stage::VERTEX);
608 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
610 else if(var.interface=="out")
612 external = (stage->type==Stage::FRAGMENT);
613 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
614 if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
618 unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
621 else if(var.interface=="uniform")
622 supported = supports_uniform_location();
627 stage->locations[var.name] = i->value;
628 i = var.layout->qualifiers.erase(i);
633 else if(i->name=="binding" && !supports_binding())
635 if(dynamic_cast<const ImageTypeDeclaration *>(get_ultimate_base_type(var.type_declaration)))
636 stage->texture_bindings[var.name] = i->value;
638 i = var.layout->qualifiers.erase(i);
644 if(var.layout->qualifiers.empty())
648 if(var.sampling=="centroid")
650 if(!supports_centroid_sampling())
651 var.sampling = string();
653 else if(var.sampling=="sample")
655 if(!supports_sample_sampling())
656 var.sampling = string();
659 if(var.name=="gl_ClipDistance")
660 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
661 stage->n_clip_distances = literal_size->value.value<int>();
663 TraversingVisitor::visit(var);
666 bool QualifierConverter::supports_interface_block_location() const
668 if(features.target_api==VULKAN)
670 else if(features.target_api==OPENGL_ES)
671 return check_version(Version(3, 20));
672 else if(check_version(Version(4, 40)))
675 return check_extension(&Features::arb_enhanced_layouts);
678 void QualifierConverter::visit(InterfaceBlock &iface)
682 for(auto i=iface.layout->qualifiers.begin(); i!=iface.layout->qualifiers.end(); )
684 if(i->name=="location" && !supports_interface_block_location())
685 i = iface.layout->qualifiers.erase(i);
686 else if(i->name=="binding" && !supports_binding())
688 stage->uniform_block_bindings[iface.block_name] = i->value;
689 i = iface.layout->qualifiers.erase(i);
695 if(iface.layout->qualifiers.empty())