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 *type = var.type_declaration;
214 while(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
215 type = basic->base_type;
216 if(dynamic_cast<const ImageTypeDeclaration *>(type) && !visit_uniform(var.name, var.layout))
217 unbound_textures.push_back(&var);
221 void LocationAllocator::visit(InterfaceBlock &iface)
223 if(!iface.instance_name.compare(0, 3, "gl_"))
226 if(iface.interface=="uniform")
228 bool push_constant = false;
231 auto i = find_member(iface.layout->qualifiers, string("push_constant"), &Layout::Qualifier::name);
232 push_constant = (i!=iface.layout->qualifiers.end());
235 if(!push_constant && !visit_uniform(iface.block_name, iface.layout))
236 unbound_blocks.push_back(&iface);
241 void PrecisionConverter::apply(Stage &s)
244 s.content.visit(*this);
245 NodeRemover().apply(s, nodes_to_remove);
248 void PrecisionConverter::visit(Block &block)
250 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
252 if(&block==&stage->content)
258 void PrecisionConverter::visit(Precision &prec)
260 if(stage->required_features.target_api==OPENGL_ES)
261 have_default.insert(prec.type);
263 nodes_to_remove.insert(&prec);
266 void PrecisionConverter::visit(VariableDeclaration &var)
268 if(stage->required_features.target_api!=OPENGL_ES)
270 var.precision.clear();
274 const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
275 const TypeDeclaration *type = var.type_declaration;
278 if(dynamic_cast<const ImageTypeDeclaration *>(type))
280 default_prec = "lowp";
283 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
285 if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
287 type = basic->base_type;
295 if(!have_default.count(type->name))
297 Precision *prec = new Precision;
298 prec->precision = default_prec;
299 prec->type = type->name;
300 stage->content.body.insert(insert_point, prec);
302 have_default.insert(type->name);
307 void FeatureConverter::apply(Stage &s, const Features &feat)
312 if(!stage->required_features.glsl_version)
313 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
318 void FeatureConverter::unsupported(const string &reason)
320 Diagnostic diagnostic;
321 diagnostic.severity = Diagnostic::ERR;
322 diagnostic.source = GENERATED_SOURCE;
324 diagnostic.message = reason;
325 stage->diagnostics.push_back(diagnostic);
328 bool FeatureConverter::check_version(const Version &feature_version) const
330 if(features.glsl_version<feature_version)
332 else if(stage->required_features.glsl_version<feature_version)
333 stage->required_features.glsl_version = feature_version;
338 bool FeatureConverter::check_extension(bool Features::*extension) const
340 if(!(features.*extension))
343 stage->required_features.*extension = true;
349 void StructuralFeatureConverter::apply()
351 if(supports_stage(stage->type))
353 stage->content.visit(*this);
354 NodeRemover().apply(*stage, nodes_to_remove);
357 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
360 void StructuralFeatureConverter::visit(Block &block)
362 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
364 if(&block==&stage->content)
365 uniform_insert_point = i;
370 void StructuralFeatureConverter::visit(RefPtr<Expression> &expr)
372 r_replaced_reference = 0;
374 if(r_replaced_reference)
375 expr = r_replaced_reference;
376 r_replaced_reference = 0;
379 bool StructuralFeatureConverter::supports_stage(Stage::Type st) const
381 if(st==Stage::GEOMETRY)
383 if(features.target_api==VULKAN)
385 else if(features.target_api==OPENGL_ES)
386 return check_version(Version(3, 20));
388 return check_version(Version(1, 50));
394 bool StructuralFeatureConverter::supports_unified_interface_syntax() const
396 if(features.target_api==VULKAN)
398 else if(features.target_api==OPENGL_ES)
399 return check_version(Version(3, 0));
401 return check_version(Version(1, 30));
404 void StructuralFeatureConverter::visit(VariableReference &var)
406 if(var.declaration==frag_out && !supports_unified_interface_syntax())
408 var.name = "gl_FragColor";
413 void StructuralFeatureConverter::visit(InterfaceBlockReference &iface)
415 r_flattened_interface = nodes_to_remove.count(iface.declaration);
418 void StructuralFeatureConverter::visit(MemberAccess &memacc)
420 r_flattened_interface = false;
422 if(r_flattened_interface)
424 VariableReference *var = new VariableReference;
425 var->name = memacc.member;
426 r_replaced_reference = var;
430 void StructuralFeatureConverter::visit(Assignment &assign)
432 TraversingVisitor::visit(assign);
433 if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
434 assign.target.declaration = 0;
437 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
439 if(features.target_api==VULKAN)
441 else if(features.target_api==OPENGL_ES)
442 return check_version(Version(3, 0));
444 return check_version(Version(1, 30));
447 void StructuralFeatureConverter::visit(FunctionCall &call)
449 if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
451 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
453 const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
454 if(arg_image && !supports_unified_sampling_functions())
456 string suffix = call.name.substr(7);
457 call.name = (arg_image->shadow ? "shadow" : "texture");
459 switch(arg_image->dimensions)
461 case ImageTypeDeclaration::ONE: call.name += "1D"; break;
462 case ImageTypeDeclaration::TWO: call.name += "2D"; break;
463 case ImageTypeDeclaration::THREE: call.name += "3D"; break;
464 case ImageTypeDeclaration::CUBE: call.name += "Cube"; break;
469 /* Array textures and the unified sampling function name were
470 both introduced in GLSL 1.30. */
471 if(arg_image->dimensions==ImageTypeDeclaration::ONE || arg_image->dimensions==ImageTypeDeclaration::TWO)
472 check_extension(&Features::ext_texture_array);
473 call.name += "Array";
481 TraversingVisitor::visit(call);
484 void StructuralFeatureConverter::visit(VariableDeclaration &var)
486 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
487 if(stage->type==Stage::FRAGMENT && var.interface=="out")
490 nodes_to_remove.insert(&var);
493 TraversingVisitor::visit(var);
496 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
498 if(features.target_api==VULKAN)
500 else if(features.target_api==OPENGL_ES)
503 return check_version(Version(3, 0));
505 return check_version(Version(3, 20));
507 else if(check_version(Version(1, 50)))
509 else if(iface=="uniform")
510 return check_extension(&Features::arb_uniform_buffer_object);
515 void StructuralFeatureConverter::visit(InterfaceBlock &iface)
517 bool push_constant = false;
520 auto i = find_member(iface.layout->qualifiers, string("push_constant"), &Layout::Qualifier::name);
521 push_constant = (i!=iface.layout->qualifiers.end());
524 if((!supports_interface_blocks(iface.interface) || (push_constant && features.target_api!=VULKAN)) && iface.type_declaration)
526 if(!iface.instance_name.empty())
527 unsupported("ARB_uniform_buffer_object required for interface block instances");
528 else if(iface.struct_declaration)
530 for(const RefPtr<Statement> &s: iface.struct_declaration->members.body)
531 if(VariableDeclaration *var = dynamic_cast<VariableDeclaration *>(s.get()))
532 var->interface = iface.interface;
533 stage->content.body.splice(uniform_insert_point, iface.struct_declaration->members.body);
534 nodes_to_remove.insert(&iface);
535 nodes_to_remove.insert(iface.struct_declaration);
538 /* If the interface block is an array, it should have an instance
539 name too, so this should never be reached */
540 throw logic_error("Unexpected interface block configuration");
545 void QualifierConverter::apply()
547 stage->content.visit(*this);
550 bool QualifierConverter::supports_interface_layouts() const
552 if(features.target_api==VULKAN)
554 else if(features.target_api==OPENGL_ES)
555 return check_version(Version(3, 0));
556 else if(check_version(Version(3, 30)))
558 else if(check_version(Version(1, 30)))
559 return check_extension(&Features::arb_explicit_attrib_location);
564 bool QualifierConverter::supports_stage_interface_layouts() const
566 if(features.target_api==VULKAN)
568 else if(features.target_api==OPENGL_ES)
569 return check_version(Version(3, 10));
570 else if(check_version(Version(4, 10)))
573 return check_extension(&Features::arb_separate_shader_objects);
576 bool QualifierConverter::supports_centroid_sampling() const
578 if(features.target_api==VULKAN)
580 else if(features.target_api==OPENGL_ES)
581 return check_version(Version(3, 0));
582 else if(check_version(Version(1, 20)))
585 return check_extension(&Features::ext_gpu_shader4);
588 bool QualifierConverter::supports_sample_sampling() const
590 if(features.target_api==VULKAN)
592 else if(features.target_api==OPENGL_ES)
593 return check_version(Version(3, 20));
594 else if(check_version(Version(4, 0)))
597 return check_extension(&Features::arb_gpu_shader5);
600 bool QualifierConverter::supports_uniform_location() const
602 if(features.target_api==VULKAN)
604 else if(features.target_api==OPENGL_ES)
605 return check_version(Version(3, 10));
606 else if(check_version(Version(4, 30)))
609 return check_extension(&Features::arb_explicit_uniform_location);
612 bool QualifierConverter::supports_binding() const
614 if(features.target_api==VULKAN)
616 else if(features.target_api==OPENGL_ES)
617 return check_version(Version(3, 10));
619 return check_version(Version(4, 20));
622 void QualifierConverter::visit(VariableDeclaration &var)
626 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
628 if(i->name=="location")
630 bool supported = true;
631 bool external = false;
632 if(var.interface=="in")
634 external = (stage->type==Stage::VERTEX);
635 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
637 else if(var.interface=="out")
639 external = (stage->type==Stage::FRAGMENT);
640 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
641 if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
645 unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
648 else if(var.interface=="uniform")
649 supported = supports_uniform_location();
654 stage->locations[var.name] = i->value;
655 i = var.layout->qualifiers.erase(i);
660 else if(i->name=="binding" && !supports_binding())
662 const TypeDeclaration *type = var.type_declaration;
663 while(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
664 type = basic->base_type;
665 if(dynamic_cast<const ImageTypeDeclaration *>(type))
666 stage->texture_bindings[var.name] = i->value;
668 i = var.layout->qualifiers.erase(i);
674 if(var.layout->qualifiers.empty())
678 if(var.sampling=="centroid")
680 if(!supports_centroid_sampling())
681 var.sampling = string();
683 else if(var.sampling=="sample")
685 if(!supports_sample_sampling())
686 var.sampling = string();
689 if(var.name=="gl_ClipDistance")
690 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
691 stage->n_clip_distances = literal_size->value.value<int>();
693 TraversingVisitor::visit(var);
696 bool QualifierConverter::supports_interface_block_location() const
698 if(features.target_api==VULKAN)
700 else if(features.target_api==OPENGL_ES)
701 return check_version(Version(3, 20));
702 else if(check_version(Version(4, 40)))
705 return check_extension(&Features::arb_enhanced_layouts);
708 void QualifierConverter::visit(InterfaceBlock &iface)
712 for(auto i=iface.layout->qualifiers.begin(); i!=iface.layout->qualifiers.end(); )
714 if(i->name=="location" && !supports_interface_block_location())
715 i = iface.layout->qualifiers.erase(i);
716 else if(i->name=="binding" && !supports_binding())
718 stage->uniform_block_bindings[iface.block_name] = i->value;
719 i = iface.layout->qualifiers.erase(i);
725 if(iface.layout->qualifiers.empty())