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)
79 const TypeDeclaration *base_type = get_ultimate_base_type(t->type_declaration);
80 unsigned range = (static_cast<const ImageTypeDeclaration *>(base_type)->sampled ?
81 features.texture_binding_range : features.storage_texture_binding_range);
82 bind_uniform(t->layout, t->name, range);
86 void LocationAllocator::apply(Stage &stage)
88 swap(used_locations["in"], used_locations["out"]);
89 used_locations["out"].clear();
91 stage.content.visit(*this);
93 allocate_locations("in");
94 allocate_locations("out");
97 void LocationAllocator::allocate_locations(const string &iface)
99 auto write = unplaced_variables.begin();
101 for(auto i=unplaced_variables.begin(); i!=unplaced_variables.end(); ++i)
103 if((*i)->interface!=iface)
111 if((*i)->interface=="uniform")
113 auto j = uniforms.find((*i)->name);
114 if(j!=uniforms.end() && j->second.location>=0)
116 add_layout_qualifier((*i)->layout, Layout::Qualifier("location", j->second.location));
124 set<unsigned> &used = used_locations[(*i)->interface];
126 unsigned size = LocationCounter().apply(**i);
130 for(unsigned j=0; j<size; ++j)
131 if(used.count(next+j))
138 add_layout_qualifier((*i)->layout, Layout::Qualifier("location", next));
139 if((*i)->interface=="uniform")
140 uniforms[(*i)->name].location = next;
142 for(unsigned j=0; j<size; ++j)
147 unplaced_variables.erase(write, unplaced_variables.end());
150 void LocationAllocator::bind_uniform(RefPtr<Layout> &layout, const string &name, unsigned range)
152 auto i = uniforms.find(name);
154 int desc_set = (i!=uniforms.end() ? i->second.desc_set : 0);
155 if(features.target_api==VULKAN && get_layout_value(layout.get(), "set")<0)
156 add_layout_qualifier(layout, Layout::Qualifier("set", desc_set));
158 if(i!=uniforms.end() && i->second.bind_point>=0)
159 add_layout_qualifier(layout, Layout::Qualifier("binding", i->second.bind_point));
162 set<unsigned> &used = used_bindings[desc_set];
164 unsigned bind_point = hash_fold<32>(hash<64>(name))%range;
165 while(used.count(bind_point))
166 bind_point = (bind_point+1)%range;
168 add_layout_qualifier(layout, Layout::Qualifier("binding", bind_point));
169 uniforms[name].bind_point = bind_point;
170 used.insert(bind_point);
174 bool LocationAllocator::visit_uniform(const string &name, RefPtr<Layout> &layout)
176 int desc_set = get_layout_value(layout.get(), "set");
177 int bind_point = get_layout_value(layout.get(), "binding");
179 if(features.target_api==VULKAN)
181 if(desc_set<0 && bind_point>=0)
184 add_layout_qualifier(layout, Layout::Qualifier("set", desc_set));
188 uniforms[name].desc_set = desc_set;
190 else if(desc_set>=0 && bind_point<0)
192 auto i = find_member(layout->qualifiers, string("set"), &Layout::Qualifier::name);
193 layout->qualifiers.erase(i);
198 used_bindings[desc_set].insert(bind_point);
199 uniforms[name].bind_point = bind_point;
202 return bind_point>=0;
205 void LocationAllocator::visit(VariableDeclaration &var)
207 if(!var.name.compare(0, 3, "gl_"))
210 if(!var.interface.empty() && !var.block_declaration)
212 int location = get_layout_value(var.layout.get(), "location");
214 if(location<0 && var.linked_declaration && var.linked_declaration->layout)
216 location = get_layout_value(var.linked_declaration->layout.get(), "location");
218 add_layout_qualifier(var.layout, Layout::Qualifier("location", location));
223 unsigned size = LocationCounter().apply(var);
224 for(unsigned i=0; i<size; ++i)
225 used_locations[var.interface].insert(location+i);
226 if(var.interface=="uniform")
227 uniforms[var.name].location = location;
230 unplaced_variables.push_back(&var);
233 if(var.interface=="uniform")
235 if(var.block_declaration)
237 bool push_constant = has_layout_qualifier(var.layout.get(), "push_constant");
238 if(!push_constant && !visit_uniform(var.block_declaration->block_name, var.layout))
239 unbound_blocks.push_back(&var);
243 const TypeDeclaration *base_type = get_ultimate_base_type(var.type_declaration);
244 if(dynamic_cast<const ImageTypeDeclaration *>(base_type) && !visit_uniform(var.name, var.layout))
245 unbound_textures.push_back(&var);
251 void DepthRangeConverter::apply(Stage &stage, const Features &features)
253 if(stage.type!=Stage::VERTEX || features.target_api==VULKAN)
256 stage.content.visit(*this);
259 void DepthRangeConverter::visit(VariableReference &var)
261 const StructDeclaration *strct = dynamic_cast<const StructDeclaration *>(var.type);
262 r_gl_pervertex = (strct && strct->block_name=="gl_PerVertex");
265 void DepthRangeConverter::visit(MemberAccess &memacc)
267 r_gl_pervertex = false;
268 memacc.left->visit(*this);
269 r_gl_position = (r_gl_pervertex && memacc.member=="gl_Position");
272 void DepthRangeConverter::visit(Swizzle &swiz)
274 r_gl_position = false;
275 swiz.left->visit(*this);
276 if(assignment_target && r_gl_position && swiz.count==1 && swiz.components[0]==2)
277 r_position_z_assigned = true;
280 void DepthRangeConverter::visit(Assignment &assign)
283 SetFlag set_target(assignment_target);
284 assign.left->visit(*this);
286 assign.right->visit(*this);
289 void DepthRangeConverter::visit(FunctionDeclaration &func)
291 r_position_z_assigned = false;
292 TraversingVisitor::visit(func);
294 if(func.definition==&func && func.name=="main" && !r_position_z_assigned)
296 VariableReference *position = new VariableReference;
297 position->name = "gl_Position";
299 MemberAccess *z = new MemberAccess;
303 Literal *scale = new Literal;
304 scale->token = "2.0";
307 BinaryExpression *multiply = new BinaryExpression;
308 multiply->oper = &Operator::get_operator("*", Operator::BINARY);
310 multiply->right = scale;
312 MemberAccess *w = new MemberAccess;
313 w->left = position->clone();
316 BinaryExpression *subtract = new BinaryExpression;
317 subtract->oper = &Operator::get_operator("-", Operator::BINARY);
318 subtract->left = multiply;
321 Assignment *assign = new Assignment;
322 assign->oper = &Operator::get_operator("=", Operator::BINARY);
323 assign->left = z->clone();
324 assign->right = subtract;
326 ExpressionStatement *statement = new ExpressionStatement;
327 statement->expression = assign;
329 func.body.body.push_back(statement);
334 void PrecisionConverter::apply(Stage &s)
337 s.content.visit(*this);
338 NodeRemover().apply(s, nodes_to_remove);
341 void PrecisionConverter::visit(Block &block)
343 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
345 if(&block==&stage->content)
351 void PrecisionConverter::visit(Precision &prec)
353 if(stage->required_features.target_api==OPENGL_ES)
354 have_default.insert(prec.type);
356 nodes_to_remove.insert(&prec);
359 void PrecisionConverter::visit(VariableDeclaration &var)
361 if(stage->required_features.target_api!=OPENGL_ES)
363 var.precision.clear();
367 const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
368 const TypeDeclaration *type = var.type_declaration;
371 if(dynamic_cast<const ImageTypeDeclaration *>(type))
373 default_prec = "lowp";
376 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
378 if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
380 type = basic->base_type;
388 if(!have_default.count(type->name))
390 Precision *prec = new Precision;
391 prec->precision = default_prec;
392 prec->type = type->name;
393 stage->content.body.insert(insert_point, prec);
395 have_default.insert(type->name);
400 void FeatureConverter::apply(Stage &s, const Features &feat)
405 if(!stage->required_features.glsl_version)
406 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
411 void FeatureConverter::unsupported(const string &reason)
413 Diagnostic diagnostic;
414 diagnostic.severity = Diagnostic::ERR;
415 diagnostic.source = GENERATED_SOURCE;
417 diagnostic.message = reason;
418 stage->diagnostics.push_back(diagnostic);
421 bool FeatureConverter::check_version(const Version &feature_version) const
423 if(features.glsl_version<feature_version)
425 else if(stage->required_features.glsl_version<feature_version)
426 stage->required_features.glsl_version = feature_version;
431 bool FeatureConverter::check_extension(bool Features::*extension) const
433 if(!(features.*extension))
436 stage->required_features.*extension = true;
442 void StructuralFeatureConverter::apply()
444 if(supports_stage(stage->type))
446 stage->content.visit(*this);
447 NodeRemover().apply(*stage, nodes_to_remove);
450 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
453 void StructuralFeatureConverter::visit(Block &block)
455 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
457 if(&block==&stage->content)
458 uniform_insert_point = i;
463 void StructuralFeatureConverter::visit(RefPtr<Expression> &expr)
465 r_replaced_reference = 0;
467 if(r_replaced_reference)
468 expr = r_replaced_reference;
469 r_replaced_reference = 0;
472 bool StructuralFeatureConverter::supports_stage(Stage::Type st) const
474 if(st==Stage::TESS_CONTROL || st==Stage::TESS_EVAL)
476 if(features.target_api==OPENGL_ES)
477 return check_version(Version(3, 20));
479 return check_version(Version(4, 0));
481 else if(st==Stage::GEOMETRY)
483 if(features.target_api==OPENGL_ES)
484 return check_version(Version(3, 20));
486 return check_version(Version(1, 50));
488 else if(st==Stage::COMPUTE)
490 if(features.target_api==OPENGL_ES)
491 return check_version(Version(3, 10));
493 return check_version(Version(4, 30));
499 bool StructuralFeatureConverter::supports_unified_interface_syntax() const
501 if(features.target_api==OPENGL_ES)
502 return check_version(Version(3, 0));
504 return check_version(Version(1, 30));
507 void StructuralFeatureConverter::visit(VariableReference &var)
509 if(var.declaration==frag_out && !supports_unified_interface_syntax())
511 var.name = "gl_FragColor";
515 r_flattened_interface = nodes_to_remove.count(var.declaration);
518 void StructuralFeatureConverter::visit(MemberAccess &memacc)
520 r_flattened_interface = false;
522 if(r_flattened_interface)
524 VariableReference *var = new VariableReference;
525 var->name = memacc.member;
526 r_replaced_reference = var;
530 void StructuralFeatureConverter::visit(Assignment &assign)
532 TraversingVisitor::visit(assign);
533 if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
534 assign.target.declaration = 0;
537 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
539 if(features.target_api==OPENGL_ES)
540 return check_version(Version(3, 0));
542 return check_version(Version(1, 30));
545 void StructuralFeatureConverter::visit(FunctionCall &call)
547 if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
549 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
551 const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
552 if(arg_image && !supports_unified_sampling_functions())
554 string suffix = call.name.substr(7);
555 call.name = (arg_image->shadow ? "shadow" : "texture");
557 switch(arg_image->dimensions)
559 case ImageTypeDeclaration::ONE: call.name += "1D"; break;
560 case ImageTypeDeclaration::TWO: call.name += "2D"; break;
561 case ImageTypeDeclaration::THREE: call.name += "3D"; break;
562 case ImageTypeDeclaration::CUBE: call.name += "Cube"; break;
567 /* Array textures and the unified sampling function name were
568 both introduced in GLSL 1.30. */
569 if(arg_image->dimensions==ImageTypeDeclaration::ONE || arg_image->dimensions==ImageTypeDeclaration::TWO)
570 check_extension(&Features::ext_texture_array);
571 call.name += "Array";
579 TraversingVisitor::visit(call);
582 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
584 if(features.target_api==OPENGL_ES)
587 return check_version(Version(3, 0));
589 return check_version(Version(3, 20));
591 else if(check_version(Version(1, 50)))
593 else if(iface=="uniform")
594 return check_extension(&Features::arb_uniform_buffer_object);
599 void StructuralFeatureConverter::visit(VariableDeclaration &var)
601 if(var.block_declaration)
603 bool push_constant = has_layout_qualifier(var.layout.get(), "push_constant");
604 if(!supports_interface_blocks(var.interface) || (push_constant && features.target_api!=VULKAN))
606 if(var.name.find(' ')==string::npos)
607 unsupported("ARB_uniform_buffer_object required for interface block instances");
610 for(const RefPtr<Statement> &s: var.block_declaration->members.body)
611 if(VariableDeclaration *mem = dynamic_cast<VariableDeclaration *>(s.get()))
612 mem->interface = var.interface;
613 stage->content.body.splice(uniform_insert_point, var.block_declaration->members.body);
614 nodes_to_remove.insert(&var);
615 nodes_to_remove.insert(var.block_declaration);
620 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
621 if(stage->type==Stage::FRAGMENT && var.interface=="out")
624 nodes_to_remove.insert(&var);
627 TraversingVisitor::visit(var);
631 void QualifierConverter::apply()
633 stage->content.visit(*this);
636 bool QualifierConverter::supports_interface_layouts() const
638 if(features.target_api==OPENGL_ES)
639 return check_version(Version(3, 0));
640 else if(check_version(Version(3, 30)))
642 else if(check_version(Version(1, 30)))
643 return check_extension(&Features::arb_explicit_attrib_location);
648 bool QualifierConverter::supports_stage_interface_layouts() const
650 if(features.target_api==OPENGL_ES)
651 return check_version(Version(3, 10));
652 else if(check_version(Version(4, 10)))
655 return check_extension(&Features::arb_separate_shader_objects);
658 bool QualifierConverter::supports_centroid_sampling() const
660 if(features.target_api==OPENGL_ES)
661 return check_version(Version(3, 0));
662 else if(check_version(Version(1, 20)))
665 return check_extension(&Features::ext_gpu_shader4);
668 bool QualifierConverter::supports_sample_sampling() const
670 if(features.target_api==OPENGL_ES)
671 return check_version(Version(3, 20));
672 else if(check_version(Version(4, 0)))
675 return check_extension(&Features::arb_gpu_shader5);
678 bool QualifierConverter::supports_uniform_location() const
680 if(features.target_api==OPENGL_ES)
681 return check_version(Version(3, 10));
682 else if(check_version(Version(4, 30)))
685 return check_extension(&Features::arb_explicit_uniform_location);
688 bool QualifierConverter::supports_binding() const
690 if(features.target_api==OPENGL_ES)
691 return check_version(Version(3, 10));
693 return check_version(Version(4, 20));
696 bool QualifierConverter::supports_interface_block_location() const
698 if(features.target_api==OPENGL_ES)
699 return check_version(Version(3, 20));
700 else if(check_version(Version(4, 40)))
703 return check_extension(&Features::arb_enhanced_layouts);
706 void QualifierConverter::visit(VariableDeclaration &var)
710 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
712 if(i->name=="location")
714 bool supported = true;
715 bool external = false;
716 if(var.block_declaration)
717 supported = supports_interface_block_location();
718 else if(var.interface=="in")
720 external = (stage->type==Stage::VERTEX);
721 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
723 else if(var.interface=="out")
725 external = (stage->type==Stage::FRAGMENT);
726 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
727 if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
731 unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
734 else if(var.interface=="uniform")
735 supported = supports_uniform_location();
740 stage->locations[var.name] = i->value;
741 i = var.layout->qualifiers.erase(i);
746 else if(i->name=="binding" && !supports_binding())
748 if(var.block_declaration)
749 stage->uniform_block_bindings[var.block_declaration->block_name] = i->value;
750 else if(dynamic_cast<const ImageTypeDeclaration *>(get_ultimate_base_type(var.type_declaration)))
751 stage->texture_bindings[var.name] = i->value;
753 i = var.layout->qualifiers.erase(i);
759 if(var.layout->qualifiers.empty())
763 if(var.sampling=="centroid")
765 if(!supports_centroid_sampling())
766 var.sampling = string();
768 else if(var.sampling=="sample")
770 if(!supports_sample_sampling())
771 var.sampling = string();
774 if(var.name=="gl_ClipDistance")
775 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
776 stage->n_clip_distances = literal_size->value.value<int>();
778 TraversingVisitor::visit(var);