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 bool LocationAllocator::visit_uniform(const string &name, RefPtr<Layout> &layout)
174 int bind_point = (layout ? get_layout_value(*layout, "binding") : -1);
177 used_bindings[0].insert(bind_point);
178 uniforms[name].bind_point = bind_point;
180 return bind_point>=0;
183 void LocationAllocator::visit(VariableDeclaration &var)
185 if(!var.name.compare(0, 3, "gl_"))
188 if(!var.interface.empty())
190 int location = (var.layout ? get_layout_value(*var.layout, "location") : -1);
192 if(location<0 && var.linked_declaration && var.linked_declaration->layout)
194 location = get_layout_value(*var.linked_declaration->layout, "location");
196 add_layout_value(var.layout, "location", location);
201 unsigned size = LocationCounter().apply(var);
202 for(unsigned i=0; i<size; ++i)
203 used_locations[var.interface].insert(location+i);
204 if(var.interface=="uniform")
205 uniforms[var.name].location = location;
208 unplaced_variables.push_back(&var);
211 if(var.interface=="uniform")
213 const TypeDeclaration *base_type = get_ultimate_base_type(var.type_declaration);
214 if(dynamic_cast<const ImageTypeDeclaration *>(base_type) && !visit_uniform(var.name, var.layout))
215 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());
233 if(!push_constant && !visit_uniform(iface.block_name, iface.layout))
234 unbound_blocks.push_back(&iface);
239 void PrecisionConverter::apply(Stage &s)
242 s.content.visit(*this);
243 NodeRemover().apply(s, nodes_to_remove);
246 void PrecisionConverter::visit(Block &block)
248 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
250 if(&block==&stage->content)
256 void PrecisionConverter::visit(Precision &prec)
258 if(stage->required_features.target_api==OPENGL_ES)
259 have_default.insert(prec.type);
261 nodes_to_remove.insert(&prec);
264 void PrecisionConverter::visit(VariableDeclaration &var)
266 if(stage->required_features.target_api!=OPENGL_ES)
268 var.precision.clear();
272 const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
273 const TypeDeclaration *type = var.type_declaration;
276 if(dynamic_cast<const ImageTypeDeclaration *>(type))
278 default_prec = "lowp";
281 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
283 if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
285 type = basic->base_type;
293 if(!have_default.count(type->name))
295 Precision *prec = new Precision;
296 prec->precision = default_prec;
297 prec->type = type->name;
298 stage->content.body.insert(insert_point, prec);
300 have_default.insert(type->name);
305 void FeatureConverter::apply(Stage &s, const Features &feat)
310 if(!stage->required_features.glsl_version)
311 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
316 void FeatureConverter::unsupported(const string &reason)
318 Diagnostic diagnostic;
319 diagnostic.severity = Diagnostic::ERR;
320 diagnostic.source = GENERATED_SOURCE;
322 diagnostic.message = reason;
323 stage->diagnostics.push_back(diagnostic);
326 bool FeatureConverter::check_version(const Version &feature_version) const
328 if(features.glsl_version<feature_version)
330 else if(stage->required_features.glsl_version<feature_version)
331 stage->required_features.glsl_version = feature_version;
336 bool FeatureConverter::check_extension(bool Features::*extension) const
338 if(!(features.*extension))
341 stage->required_features.*extension = true;
347 void StructuralFeatureConverter::apply()
349 if(supports_stage(stage->type))
351 stage->content.visit(*this);
352 NodeRemover().apply(*stage, nodes_to_remove);
355 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
358 void StructuralFeatureConverter::visit(Block &block)
360 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
362 if(&block==&stage->content)
363 uniform_insert_point = i;
368 void StructuralFeatureConverter::visit(RefPtr<Expression> &expr)
370 r_replaced_reference = 0;
372 if(r_replaced_reference)
373 expr = r_replaced_reference;
374 r_replaced_reference = 0;
377 bool StructuralFeatureConverter::supports_stage(Stage::Type st) const
379 if(st==Stage::GEOMETRY)
381 if(features.target_api==VULKAN)
383 else if(features.target_api==OPENGL_ES)
384 return check_version(Version(3, 20));
386 return check_version(Version(1, 50));
392 bool StructuralFeatureConverter::supports_unified_interface_syntax() const
394 if(features.target_api==VULKAN)
396 else if(features.target_api==OPENGL_ES)
397 return check_version(Version(3, 0));
399 return check_version(Version(1, 30));
402 void StructuralFeatureConverter::visit(VariableReference &var)
404 if(var.declaration==frag_out && !supports_unified_interface_syntax())
406 var.name = "gl_FragColor";
411 void StructuralFeatureConverter::visit(InterfaceBlockReference &iface)
413 r_flattened_interface = nodes_to_remove.count(iface.declaration);
416 void StructuralFeatureConverter::visit(MemberAccess &memacc)
418 r_flattened_interface = false;
420 if(r_flattened_interface)
422 VariableReference *var = new VariableReference;
423 var->name = memacc.member;
424 r_replaced_reference = var;
428 void StructuralFeatureConverter::visit(Assignment &assign)
430 TraversingVisitor::visit(assign);
431 if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
432 assign.target.declaration = 0;
435 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
437 if(features.target_api==VULKAN)
439 else if(features.target_api==OPENGL_ES)
440 return check_version(Version(3, 0));
442 return check_version(Version(1, 30));
445 void StructuralFeatureConverter::visit(FunctionCall &call)
447 if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
449 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
451 const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
452 if(arg_image && !supports_unified_sampling_functions())
454 string suffix = call.name.substr(7);
455 call.name = (arg_image->shadow ? "shadow" : "texture");
457 switch(arg_image->dimensions)
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;
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";
479 TraversingVisitor::visit(call);
482 void StructuralFeatureConverter::visit(VariableDeclaration &var)
484 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
485 if(stage->type==Stage::FRAGMENT && var.interface=="out")
488 nodes_to_remove.insert(&var);
491 TraversingVisitor::visit(var);
494 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
496 if(features.target_api==VULKAN)
498 else if(features.target_api==OPENGL_ES)
501 return check_version(Version(3, 0));
503 return check_version(Version(3, 20));
505 else if(check_version(Version(1, 50)))
507 else if(iface=="uniform")
508 return check_extension(&Features::arb_uniform_buffer_object);
513 void StructuralFeatureConverter::visit(InterfaceBlock &iface)
515 bool push_constant = false;
518 auto i = find_member(iface.layout->qualifiers, string("push_constant"), &Layout::Qualifier::name);
519 push_constant = (i!=iface.layout->qualifiers.end());
522 if((!supports_interface_blocks(iface.interface) || (push_constant && features.target_api!=VULKAN)) && iface.type_declaration)
524 if(!iface.instance_name.empty())
525 unsupported("ARB_uniform_buffer_object required for interface block instances");
526 else if(iface.struct_declaration)
528 for(const RefPtr<Statement> &s: iface.struct_declaration->members.body)
529 if(VariableDeclaration *var = dynamic_cast<VariableDeclaration *>(s.get()))
530 var->interface = iface.interface;
531 stage->content.body.splice(uniform_insert_point, iface.struct_declaration->members.body);
532 nodes_to_remove.insert(&iface);
533 nodes_to_remove.insert(iface.struct_declaration);
536 /* If the interface block is an array, it should have an instance
537 name too, so this should never be reached */
538 throw logic_error("Unexpected interface block configuration");
543 void QualifierConverter::apply()
545 stage->content.visit(*this);
548 bool QualifierConverter::supports_interface_layouts() const
550 if(features.target_api==VULKAN)
552 else if(features.target_api==OPENGL_ES)
553 return check_version(Version(3, 0));
554 else if(check_version(Version(3, 30)))
556 else if(check_version(Version(1, 30)))
557 return check_extension(&Features::arb_explicit_attrib_location);
562 bool QualifierConverter::supports_stage_interface_layouts() const
564 if(features.target_api==VULKAN)
566 else if(features.target_api==OPENGL_ES)
567 return check_version(Version(3, 10));
568 else if(check_version(Version(4, 10)))
571 return check_extension(&Features::arb_separate_shader_objects);
574 bool QualifierConverter::supports_centroid_sampling() const
576 if(features.target_api==VULKAN)
578 else if(features.target_api==OPENGL_ES)
579 return check_version(Version(3, 0));
580 else if(check_version(Version(1, 20)))
583 return check_extension(&Features::ext_gpu_shader4);
586 bool QualifierConverter::supports_sample_sampling() const
588 if(features.target_api==VULKAN)
590 else if(features.target_api==OPENGL_ES)
591 return check_version(Version(3, 20));
592 else if(check_version(Version(4, 0)))
595 return check_extension(&Features::arb_gpu_shader5);
598 bool QualifierConverter::supports_uniform_location() const
600 if(features.target_api==VULKAN)
602 else if(features.target_api==OPENGL_ES)
603 return check_version(Version(3, 10));
604 else if(check_version(Version(4, 30)))
607 return check_extension(&Features::arb_explicit_uniform_location);
610 bool QualifierConverter::supports_binding() const
612 if(features.target_api==VULKAN)
614 else if(features.target_api==OPENGL_ES)
615 return check_version(Version(3, 10));
617 return check_version(Version(4, 20));
620 void QualifierConverter::visit(VariableDeclaration &var)
624 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
626 if(i->name=="location")
628 bool supported = true;
629 bool external = false;
630 if(var.interface=="in")
632 external = (stage->type==Stage::VERTEX);
633 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
635 else if(var.interface=="out")
637 external = (stage->type==Stage::FRAGMENT);
638 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
639 if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
643 unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
646 else if(var.interface=="uniform")
647 supported = supports_uniform_location();
652 stage->locations[var.name] = i->value;
653 i = var.layout->qualifiers.erase(i);
658 else if(i->name=="binding" && !supports_binding())
660 if(dynamic_cast<const ImageTypeDeclaration *>(get_ultimate_base_type(var.type_declaration)))
661 stage->texture_bindings[var.name] = i->value;
663 i = var.layout->qualifiers.erase(i);
669 if(var.layout->qualifiers.empty())
673 if(var.sampling=="centroid")
675 if(!supports_centroid_sampling())
676 var.sampling = string();
678 else if(var.sampling=="sample")
680 if(!supports_sample_sampling())
681 var.sampling = string();
684 if(var.name=="gl_ClipDistance")
685 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
686 stage->n_clip_distances = literal_size->value.value<int>();
688 TraversingVisitor::visit(var);
691 bool QualifierConverter::supports_interface_block_location() const
693 if(features.target_api==VULKAN)
695 else if(features.target_api==OPENGL_ES)
696 return check_version(Version(3, 20));
697 else if(check_version(Version(4, 40)))
700 return check_extension(&Features::arb_enhanced_layouts);
703 void QualifierConverter::visit(InterfaceBlock &iface)
707 for(auto i=iface.layout->qualifiers.begin(); i!=iface.layout->qualifiers.end(); )
709 if(i->name=="location" && !supports_interface_block_location())
710 i = iface.layout->qualifiers.erase(i);
711 else if(i->name=="binding" && !supports_binding())
713 stage->uniform_block_bindings[iface.block_name] = i->value;
714 i = iface.layout->qualifiers.erase(i);
720 if(iface.layout->qualifiers.empty())