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)
75 if(features.target_api!=VULKAN)
76 allocate_locations("uniform");
78 for(InterfaceBlock *b: unbound_blocks)
79 bind_uniform(b->layout, b->block_name, features.uniform_binding_range);
80 for(VariableDeclaration *t: unbound_textures)
81 bind_uniform(t->layout, t->name, features.texture_binding_range);
84 void LocationAllocator::apply(Stage &stage)
86 swap(used_locations["in"], used_locations["out"]);
87 used_locations["out"].clear();
89 stage.content.visit(*this);
91 allocate_locations("in");
92 allocate_locations("out");
95 void LocationAllocator::allocate_locations(const string &iface)
97 auto write = unplaced_variables.begin();
99 for(auto i=unplaced_variables.begin(); i!=unplaced_variables.end(); ++i)
101 if((*i)->interface!=iface)
109 if((*i)->interface=="uniform")
111 auto j = uniforms.find((*i)->name);
112 if(j!=uniforms.end() && j->second.location>=0)
114 add_layout_value((*i)->layout, "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_value((*i)->layout, "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);
148 if(i!=uniforms.end() && i->second.bind_point>=0)
149 add_layout_value(layout, "binding", i->second.bind_point);
152 set<unsigned> &used = used_bindings[0];
154 unsigned bind_point = fold32(hash64(name))%range;
155 while(used.count(bind_point))
156 bind_point = (bind_point+1)%range;
158 add_layout_value(layout, "binding", bind_point);
159 uniforms[name].bind_point = bind_point;
160 used.insert(bind_point);
164 void LocationAllocator::add_layout_value(RefPtr<Layout> &layout, const string &name, unsigned value)
169 layout->qualifiers.push_back(Layout::Qualifier(name, value));
172 void LocationAllocator::visit(VariableDeclaration &var)
174 if(!var.name.compare(0, 3, "gl_"))
177 if(!var.interface.empty())
179 int location = (var.layout ? get_layout_value(*var.layout, "location") : -1);
181 if(location<0 && var.linked_declaration && var.linked_declaration->layout)
183 location = get_layout_value(*var.linked_declaration->layout, "location");
185 add_layout_value(var.layout, "location", location);
190 unsigned size = LocationCounter().apply(var);
191 for(unsigned i=0; i<size; ++i)
192 used_locations[var.interface].insert(location+i);
193 if(var.interface=="uniform")
194 uniforms[var.name].location = location;
197 unplaced_variables.push_back(&var);
200 if(var.interface=="uniform")
202 const TypeDeclaration *type = var.type_declaration;
203 while(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
204 type = basic->base_type;
205 if(dynamic_cast<const ImageTypeDeclaration *>(type))
207 int bind_point = (var.layout ? get_layout_value(*var.layout, "binding") : -1);
210 used_bindings[0].insert(bind_point);
211 uniforms[var.name].bind_point = bind_point;
214 unbound_textures.push_back(&var);
219 void LocationAllocator::visit(InterfaceBlock &iface)
221 if(!iface.instance_name.compare(0, 3, "gl_"))
224 if(iface.interface=="uniform")
226 bool push_constant = false;
229 auto i = find_member(iface.layout->qualifiers, string("push_constant"), &Layout::Qualifier::name);
230 push_constant = (i!=iface.layout->qualifiers.end());
235 int bind_point = (iface.layout ? get_layout_value(*iface.layout, "binding") : -1);
239 used_bindings[0].insert(bind_point);
240 uniforms[iface.block_name].bind_point = bind_point;
243 unbound_blocks.push_back(&iface);
249 void PrecisionConverter::apply(Stage &s)
252 s.content.visit(*this);
253 NodeRemover().apply(s, nodes_to_remove);
256 void PrecisionConverter::visit(Block &block)
258 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
260 if(&block==&stage->content)
266 void PrecisionConverter::visit(Precision &prec)
268 if(stage->required_features.target_api==OPENGL_ES)
269 have_default.insert(prec.type);
271 nodes_to_remove.insert(&prec);
274 void PrecisionConverter::visit(VariableDeclaration &var)
276 if(stage->required_features.target_api!=OPENGL_ES)
278 var.precision.clear();
282 const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
283 const TypeDeclaration *type = var.type_declaration;
286 if(dynamic_cast<const ImageTypeDeclaration *>(type))
288 default_prec = "lowp";
291 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
293 if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
295 type = basic->base_type;
303 if(!have_default.count(type->name))
305 Precision *prec = new Precision;
306 prec->precision = default_prec;
307 prec->type = type->name;
308 stage->content.body.insert(insert_point, prec);
310 have_default.insert(type->name);
315 void FeatureConverter::apply(Stage &s, const Features &feat)
320 if(!stage->required_features.glsl_version)
321 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
326 void FeatureConverter::unsupported(const string &reason)
328 Diagnostic diagnostic;
329 diagnostic.severity = Diagnostic::ERR;
330 diagnostic.source = GENERATED_SOURCE;
332 diagnostic.message = reason;
333 stage->diagnostics.push_back(diagnostic);
336 bool FeatureConverter::check_version(const Version &feature_version) const
338 if(features.glsl_version<feature_version)
340 else if(stage->required_features.glsl_version<feature_version)
341 stage->required_features.glsl_version = feature_version;
346 bool FeatureConverter::check_extension(bool Features::*extension) const
348 if(!(features.*extension))
351 stage->required_features.*extension = true;
357 void StructuralFeatureConverter::apply()
359 if(supports_stage(stage->type))
361 stage->content.visit(*this);
362 NodeRemover().apply(*stage, nodes_to_remove);
365 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
368 void StructuralFeatureConverter::visit(Block &block)
370 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
372 if(&block==&stage->content)
373 uniform_insert_point = i;
378 void StructuralFeatureConverter::visit(RefPtr<Expression> &expr)
380 r_replaced_reference = 0;
382 if(r_replaced_reference)
383 expr = r_replaced_reference;
384 r_replaced_reference = 0;
387 bool StructuralFeatureConverter::supports_stage(Stage::Type st) const
389 if(st==Stage::GEOMETRY)
391 if(features.target_api==VULKAN)
393 else if(features.target_api==OPENGL_ES)
394 return check_version(Version(3, 20));
396 return check_version(Version(1, 50));
402 bool StructuralFeatureConverter::supports_unified_interface_syntax() const
404 if(features.target_api==VULKAN)
406 else if(features.target_api==OPENGL_ES)
407 return check_version(Version(3, 0));
409 return check_version(Version(1, 30));
412 void StructuralFeatureConverter::visit(VariableReference &var)
414 if(var.declaration==frag_out && !supports_unified_interface_syntax())
416 var.name = "gl_FragColor";
421 void StructuralFeatureConverter::visit(InterfaceBlockReference &iface)
423 r_flattened_interface = nodes_to_remove.count(iface.declaration);
426 void StructuralFeatureConverter::visit(MemberAccess &memacc)
428 r_flattened_interface = false;
430 if(r_flattened_interface)
432 VariableReference *var = new VariableReference;
433 var->name = memacc.member;
434 r_replaced_reference = var;
438 void StructuralFeatureConverter::visit(Assignment &assign)
440 TraversingVisitor::visit(assign);
441 if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
442 assign.target.declaration = 0;
445 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
447 if(features.target_api==VULKAN)
449 else if(features.target_api==OPENGL_ES)
450 return check_version(Version(3, 0));
452 return check_version(Version(1, 30));
455 void StructuralFeatureConverter::visit(FunctionCall &call)
457 if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
459 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
461 const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
462 if(arg_image && !supports_unified_sampling_functions())
464 string suffix = call.name.substr(7);
465 call.name = (arg_image->shadow ? "shadow" : "texture");
467 switch(arg_image->dimensions)
469 case ImageTypeDeclaration::ONE: call.name += "1D"; break;
470 case ImageTypeDeclaration::TWO: call.name += "2D"; break;
471 case ImageTypeDeclaration::THREE: call.name += "3D"; break;
472 case ImageTypeDeclaration::CUBE: call.name += "Cube"; break;
477 /* Array textures and the unified sampling function name were
478 both introduced in GLSL 1.30. */
479 if(arg_image->dimensions==ImageTypeDeclaration::ONE || arg_image->dimensions==ImageTypeDeclaration::TWO)
480 check_extension(&Features::ext_texture_array);
481 call.name += "Array";
489 TraversingVisitor::visit(call);
492 void StructuralFeatureConverter::visit(VariableDeclaration &var)
494 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
495 if(stage->type==Stage::FRAGMENT && var.interface=="out")
498 nodes_to_remove.insert(&var);
501 TraversingVisitor::visit(var);
504 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
506 if(features.target_api==VULKAN)
508 else if(features.target_api==OPENGL_ES)
511 return check_version(Version(3, 0));
513 return check_version(Version(3, 20));
515 else if(check_version(Version(1, 50)))
517 else if(iface=="uniform")
518 return check_extension(&Features::arb_uniform_buffer_object);
523 void StructuralFeatureConverter::visit(InterfaceBlock &iface)
525 bool push_constant = false;
528 auto i = find_member(iface.layout->qualifiers, string("push_constant"), &Layout::Qualifier::name);
529 push_constant = (i!=iface.layout->qualifiers.end());
532 if((!supports_interface_blocks(iface.interface) || (push_constant && features.target_api!=VULKAN)) && iface.type_declaration)
534 if(!iface.instance_name.empty())
535 unsupported("ARB_uniform_buffer_object required for interface block instances");
536 else if(iface.struct_declaration)
538 for(const RefPtr<Statement> &s: iface.struct_declaration->members.body)
539 if(VariableDeclaration *var = dynamic_cast<VariableDeclaration *>(s.get()))
540 var->interface = iface.interface;
541 stage->content.body.splice(uniform_insert_point, iface.struct_declaration->members.body);
542 nodes_to_remove.insert(&iface);
543 nodes_to_remove.insert(iface.struct_declaration);
546 /* If the interface block is an array, it should have an instance
547 name too, so this should never be reached */
548 throw logic_error("Unexpected interface block configuration");
553 void QualifierConverter::apply()
555 stage->content.visit(*this);
558 bool QualifierConverter::supports_interface_layouts() const
560 if(features.target_api==VULKAN)
562 else if(features.target_api==OPENGL_ES)
563 return check_version(Version(3, 0));
564 else if(check_version(Version(3, 30)))
566 else if(check_version(Version(1, 30)))
567 return check_extension(&Features::arb_explicit_attrib_location);
572 bool QualifierConverter::supports_stage_interface_layouts() const
574 if(features.target_api==VULKAN)
576 else if(features.target_api==OPENGL_ES)
577 return check_version(Version(3, 10));
578 else if(check_version(Version(4, 10)))
581 return check_extension(&Features::arb_separate_shader_objects);
584 bool QualifierConverter::supports_centroid_sampling() const
586 if(features.target_api==VULKAN)
588 else if(features.target_api==OPENGL_ES)
589 return check_version(Version(3, 0));
590 else if(check_version(Version(1, 20)))
593 return check_extension(&Features::ext_gpu_shader4);
596 bool QualifierConverter::supports_sample_sampling() const
598 if(features.target_api==VULKAN)
600 else if(features.target_api==OPENGL_ES)
601 return check_version(Version(3, 20));
602 else if(check_version(Version(4, 0)))
605 return check_extension(&Features::arb_gpu_shader5);
608 bool QualifierConverter::supports_uniform_location() const
610 if(features.target_api==VULKAN)
612 else if(features.target_api==OPENGL_ES)
613 return check_version(Version(3, 10));
614 else if(check_version(Version(4, 30)))
617 return check_extension(&Features::arb_explicit_uniform_location);
620 bool QualifierConverter::supports_binding() const
622 if(features.target_api==VULKAN)
624 else if(features.target_api==OPENGL_ES)
625 return check_version(Version(3, 10));
627 return check_version(Version(4, 20));
630 void QualifierConverter::visit(VariableDeclaration &var)
634 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
636 if(i->name=="location")
638 bool supported = true;
639 bool external = false;
640 if(var.interface=="in")
642 external = (stage->type==Stage::VERTEX);
643 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
645 else if(var.interface=="out")
647 external = (stage->type==Stage::FRAGMENT);
648 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
649 if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
653 unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
656 else if(var.interface=="uniform")
657 supported = supports_uniform_location();
662 stage->locations[var.name] = i->value;
663 i = var.layout->qualifiers.erase(i);
668 else if(i->name=="binding" && !supports_binding())
670 const TypeDeclaration *type = var.type_declaration;
671 while(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
672 type = basic->base_type;
673 if(dynamic_cast<const ImageTypeDeclaration *>(type))
674 stage->texture_bindings[var.name] = i->value;
676 i = var.layout->qualifiers.erase(i);
682 if(var.layout->qualifiers.empty())
686 if(var.sampling=="centroid")
688 if(!supports_centroid_sampling())
689 var.sampling = string();
691 else if(var.sampling=="sample")
693 if(!supports_sample_sampling())
694 var.sampling = string();
697 if(var.name=="gl_ClipDistance")
698 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
699 stage->n_clip_distances = literal_size->value.value<int>();
701 TraversingVisitor::visit(var);
704 bool QualifierConverter::supports_interface_block_location() const
706 if(features.target_api==VULKAN)
708 else if(features.target_api==OPENGL_ES)
709 return check_version(Version(3, 20));
710 else if(check_version(Version(4, 40)))
713 return check_extension(&Features::arb_enhanced_layouts);
716 void QualifierConverter::visit(InterfaceBlock &iface)
720 for(auto i=iface.layout->qualifiers.begin(); i!=iface.layout->qualifiers.end(); )
722 if(i->name=="location" && !supports_interface_block_location())
723 i = iface.layout->qualifiers.erase(i);
724 else if(i->name=="binding" && !supports_binding())
726 stage->uniform_block_bindings[iface.block_name] = i->value;
727 i = iface.layout->qualifiers.erase(i);
733 if(iface.layout->qualifiers.empty())