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(VariableDeclaration *b: unbound_blocks)
76 bind_uniform(b->layout, b->block_declaration->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() && !var.block_declaration)
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 if(var.block_declaration)
228 bool push_constant = has_layout_qualifier(var.layout.get(), "push_constant");
229 if(!push_constant && !visit_uniform(var.block_declaration->block_name, var.layout))
230 unbound_blocks.push_back(&var);
234 const TypeDeclaration *base_type = get_ultimate_base_type(var.type_declaration);
235 if(dynamic_cast<const ImageTypeDeclaration *>(base_type) && !visit_uniform(var.name, var.layout))
236 unbound_textures.push_back(&var);
242 void DepthRangeConverter::apply(Stage &stage, const Features &features)
244 if(stage.type!=Stage::VERTEX || features.target_api==VULKAN)
247 stage.content.visit(*this);
250 void DepthRangeConverter::visit(FunctionDeclaration &func)
252 if(func.definition==&func && func.name=="main")
254 VariableReference *position = new VariableReference;
255 position->name = "gl_Position";
257 MemberAccess *z = new MemberAccess;
261 Literal *scale = new Literal;
262 scale->token = "2.0";
265 BinaryExpression *multiply = new BinaryExpression;
266 multiply->oper = &Operator::get_operator("*", Operator::BINARY);
268 multiply->right = scale;
270 MemberAccess *w = new MemberAccess;
271 w->left = position->clone();
274 BinaryExpression *subtract = new BinaryExpression;
275 subtract->oper = &Operator::get_operator("-", Operator::BINARY);
276 subtract->left = multiply;
279 Assignment *assign = new Assignment;
280 assign->oper = &Operator::get_operator("=", Operator::BINARY);
281 assign->left = z->clone();
282 assign->right = subtract;
284 ExpressionStatement *statement = new ExpressionStatement;
285 statement->expression = assign;
287 func.body.body.push_back(statement);
292 void PrecisionConverter::apply(Stage &s)
295 s.content.visit(*this);
296 NodeRemover().apply(s, nodes_to_remove);
299 void PrecisionConverter::visit(Block &block)
301 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
303 if(&block==&stage->content)
309 void PrecisionConverter::visit(Precision &prec)
311 if(stage->required_features.target_api==OPENGL_ES)
312 have_default.insert(prec.type);
314 nodes_to_remove.insert(&prec);
317 void PrecisionConverter::visit(VariableDeclaration &var)
319 if(stage->required_features.target_api!=OPENGL_ES)
321 var.precision.clear();
325 const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
326 const TypeDeclaration *type = var.type_declaration;
329 if(dynamic_cast<const ImageTypeDeclaration *>(type))
331 default_prec = "lowp";
334 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
336 if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
338 type = basic->base_type;
346 if(!have_default.count(type->name))
348 Precision *prec = new Precision;
349 prec->precision = default_prec;
350 prec->type = type->name;
351 stage->content.body.insert(insert_point, prec);
353 have_default.insert(type->name);
358 void FeatureConverter::apply(Stage &s, const Features &feat)
363 if(!stage->required_features.glsl_version)
364 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
369 void FeatureConverter::unsupported(const string &reason)
371 Diagnostic diagnostic;
372 diagnostic.severity = Diagnostic::ERR;
373 diagnostic.source = GENERATED_SOURCE;
375 diagnostic.message = reason;
376 stage->diagnostics.push_back(diagnostic);
379 bool FeatureConverter::check_version(const Version &feature_version) const
381 if(features.glsl_version<feature_version)
383 else if(stage->required_features.glsl_version<feature_version)
384 stage->required_features.glsl_version = feature_version;
389 bool FeatureConverter::check_extension(bool Features::*extension) const
391 if(!(features.*extension))
394 stage->required_features.*extension = true;
400 void StructuralFeatureConverter::apply()
402 if(supports_stage(stage->type))
404 stage->content.visit(*this);
405 NodeRemover().apply(*stage, nodes_to_remove);
408 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
411 void StructuralFeatureConverter::visit(Block &block)
413 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
415 if(&block==&stage->content)
416 uniform_insert_point = i;
421 void StructuralFeatureConverter::visit(RefPtr<Expression> &expr)
423 r_replaced_reference = 0;
425 if(r_replaced_reference)
426 expr = r_replaced_reference;
427 r_replaced_reference = 0;
430 bool StructuralFeatureConverter::supports_stage(Stage::Type st) const
432 if(st==Stage::GEOMETRY)
434 if(features.target_api==VULKAN)
436 else if(features.target_api==OPENGL_ES)
437 return check_version(Version(3, 20));
439 return check_version(Version(1, 50));
445 bool StructuralFeatureConverter::supports_unified_interface_syntax() 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(VariableReference &var)
457 if(var.declaration==frag_out && !supports_unified_interface_syntax())
459 var.name = "gl_FragColor";
463 r_flattened_interface = nodes_to_remove.count(var.declaration);
466 void StructuralFeatureConverter::visit(MemberAccess &memacc)
468 r_flattened_interface = false;
470 if(r_flattened_interface)
472 VariableReference *var = new VariableReference;
473 var->name = memacc.member;
474 r_replaced_reference = var;
478 void StructuralFeatureConverter::visit(Assignment &assign)
480 TraversingVisitor::visit(assign);
481 if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
482 assign.target.declaration = 0;
485 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
487 if(features.target_api==VULKAN)
489 else if(features.target_api==OPENGL_ES)
490 return check_version(Version(3, 0));
492 return check_version(Version(1, 30));
495 void StructuralFeatureConverter::visit(FunctionCall &call)
497 if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
499 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
501 const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
502 if(arg_image && !supports_unified_sampling_functions())
504 string suffix = call.name.substr(7);
505 call.name = (arg_image->shadow ? "shadow" : "texture");
507 switch(arg_image->dimensions)
509 case ImageTypeDeclaration::ONE: call.name += "1D"; break;
510 case ImageTypeDeclaration::TWO: call.name += "2D"; break;
511 case ImageTypeDeclaration::THREE: call.name += "3D"; break;
512 case ImageTypeDeclaration::CUBE: call.name += "Cube"; break;
517 /* Array textures and the unified sampling function name were
518 both introduced in GLSL 1.30. */
519 if(arg_image->dimensions==ImageTypeDeclaration::ONE || arg_image->dimensions==ImageTypeDeclaration::TWO)
520 check_extension(&Features::ext_texture_array);
521 call.name += "Array";
529 TraversingVisitor::visit(call);
532 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
534 if(features.target_api==VULKAN)
536 else if(features.target_api==OPENGL_ES)
539 return check_version(Version(3, 0));
541 return check_version(Version(3, 20));
543 else if(check_version(Version(1, 50)))
545 else if(iface=="uniform")
546 return check_extension(&Features::arb_uniform_buffer_object);
551 void StructuralFeatureConverter::visit(VariableDeclaration &var)
553 if(var.block_declaration)
555 bool push_constant = has_layout_qualifier(var.layout.get(), "push_constant");
556 if(!supports_interface_blocks(var.interface) || (push_constant && features.target_api!=VULKAN))
558 if(var.name.find(' ')==string::npos)
559 unsupported("ARB_uniform_buffer_object required for interface block instances");
562 for(const RefPtr<Statement> &s: var.block_declaration->members.body)
563 if(VariableDeclaration *mem = dynamic_cast<VariableDeclaration *>(s.get()))
564 mem->interface = var.interface;
565 stage->content.body.splice(uniform_insert_point, var.block_declaration->members.body);
566 nodes_to_remove.insert(&var);
567 nodes_to_remove.insert(var.block_declaration);
572 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
573 if(stage->type==Stage::FRAGMENT && var.interface=="out")
576 nodes_to_remove.insert(&var);
579 TraversingVisitor::visit(var);
583 void QualifierConverter::apply()
585 stage->content.visit(*this);
588 bool QualifierConverter::supports_interface_layouts() const
590 if(features.target_api==VULKAN)
592 else if(features.target_api==OPENGL_ES)
593 return check_version(Version(3, 0));
594 else if(check_version(Version(3, 30)))
596 else if(check_version(Version(1, 30)))
597 return check_extension(&Features::arb_explicit_attrib_location);
602 bool QualifierConverter::supports_stage_interface_layouts() const
604 if(features.target_api==VULKAN)
606 else if(features.target_api==OPENGL_ES)
607 return check_version(Version(3, 10));
608 else if(check_version(Version(4, 10)))
611 return check_extension(&Features::arb_separate_shader_objects);
614 bool QualifierConverter::supports_centroid_sampling() const
616 if(features.target_api==VULKAN)
618 else if(features.target_api==OPENGL_ES)
619 return check_version(Version(3, 0));
620 else if(check_version(Version(1, 20)))
623 return check_extension(&Features::ext_gpu_shader4);
626 bool QualifierConverter::supports_sample_sampling() const
628 if(features.target_api==VULKAN)
630 else if(features.target_api==OPENGL_ES)
631 return check_version(Version(3, 20));
632 else if(check_version(Version(4, 0)))
635 return check_extension(&Features::arb_gpu_shader5);
638 bool QualifierConverter::supports_uniform_location() const
640 if(features.target_api==VULKAN)
642 else if(features.target_api==OPENGL_ES)
643 return check_version(Version(3, 10));
644 else if(check_version(Version(4, 30)))
647 return check_extension(&Features::arb_explicit_uniform_location);
650 bool QualifierConverter::supports_binding() const
652 if(features.target_api==VULKAN)
654 else if(features.target_api==OPENGL_ES)
655 return check_version(Version(3, 10));
657 return check_version(Version(4, 20));
660 bool QualifierConverter::supports_interface_block_location() const
662 if(features.target_api==VULKAN)
664 else if(features.target_api==OPENGL_ES)
665 return check_version(Version(3, 20));
666 else if(check_version(Version(4, 40)))
669 return check_extension(&Features::arb_enhanced_layouts);
672 void QualifierConverter::visit(VariableDeclaration &var)
676 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
678 if(i->name=="location")
680 bool supported = true;
681 bool external = false;
682 if(var.block_declaration)
683 supported = supports_interface_block_location();
684 else if(var.interface=="in")
686 external = (stage->type==Stage::VERTEX);
687 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
689 else if(var.interface=="out")
691 external = (stage->type==Stage::FRAGMENT);
692 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
693 if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
697 unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
700 else if(var.interface=="uniform")
701 supported = supports_uniform_location();
706 stage->locations[var.name] = i->value;
707 i = var.layout->qualifiers.erase(i);
712 else if(i->name=="binding" && !supports_binding())
714 if(var.block_declaration)
715 stage->uniform_block_bindings[var.block_declaration->block_name] = i->value;
716 else if(dynamic_cast<const ImageTypeDeclaration *>(get_ultimate_base_type(var.type_declaration)))
717 stage->texture_bindings[var.name] = i->value;
719 i = var.layout->qualifiers.erase(i);
725 if(var.layout->qualifiers.empty())
729 if(var.sampling=="centroid")
731 if(!supports_centroid_sampling())
732 var.sampling = string();
734 else if(var.sampling=="sample")
736 if(!supports_sample_sampling())
737 var.sampling = string();
740 if(var.name=="gl_ClipDistance")
741 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
742 stage->n_clip_distances = literal_size->value.value<int>();
744 TraversingVisitor::visit(var);