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)
171 int desc_set = get_layout_value(layout.get(), "set");
172 int bind_point = get_layout_value(layout.get(), "binding");
174 if(features.target_api==VULKAN)
176 if(desc_set<0 && bind_point>=0)
179 add_layout_qualifier(layout, Layout::Qualifier("set", desc_set));
183 uniforms[name].desc_set = desc_set;
185 else if(desc_set>=0 && bind_point<0)
187 auto i = find_member(layout->qualifiers, string("set"), &Layout::Qualifier::name);
188 layout->qualifiers.erase(i);
193 used_bindings[desc_set].insert(bind_point);
194 uniforms[name].bind_point = bind_point;
197 return bind_point>=0;
200 void LocationAllocator::visit(VariableDeclaration &var)
202 if(!var.name.compare(0, 3, "gl_"))
205 if(!var.interface.empty() && !var.block_declaration)
207 int location = get_layout_value(var.layout.get(), "location");
209 if(location<0 && var.linked_declaration && var.linked_declaration->layout)
211 location = get_layout_value(var.linked_declaration->layout.get(), "location");
213 add_layout_qualifier(var.layout, Layout::Qualifier("location", location));
218 unsigned size = LocationCounter().apply(var);
219 for(unsigned i=0; i<size; ++i)
220 used_locations[var.interface].insert(location+i);
221 if(var.interface=="uniform")
222 uniforms[var.name].location = location;
225 unplaced_variables.push_back(&var);
228 if(var.interface=="uniform")
230 if(var.block_declaration)
232 bool push_constant = has_layout_qualifier(var.layout.get(), "push_constant");
233 if(!push_constant && !visit_uniform(var.block_declaration->block_name, var.layout))
234 unbound_blocks.push_back(&var);
238 const TypeDeclaration *base_type = get_ultimate_base_type(var.type_declaration);
239 if(dynamic_cast<const ImageTypeDeclaration *>(base_type) && !visit_uniform(var.name, var.layout))
240 unbound_textures.push_back(&var);
246 void DepthRangeConverter::apply(Stage &stage, const Features &features)
248 if(stage.type!=Stage::VERTEX || features.target_api==VULKAN)
251 stage.content.visit(*this);
254 void DepthRangeConverter::visit(VariableReference &var)
256 const StructDeclaration *strct = dynamic_cast<const StructDeclaration *>(var.type);
257 r_gl_pervertex = (strct && strct->block_name=="gl_PerVertex");
260 void DepthRangeConverter::visit(MemberAccess &memacc)
262 r_gl_pervertex = false;
263 memacc.left->visit(*this);
264 r_gl_position = (r_gl_pervertex && memacc.member=="gl_Position");
267 void DepthRangeConverter::visit(Swizzle &swiz)
269 r_gl_position = false;
270 swiz.left->visit(*this);
271 if(assignment_target && r_gl_position && swiz.count==1 && swiz.components[0]==2)
272 r_position_z_assigned = true;
275 void DepthRangeConverter::visit(Assignment &assign)
278 SetFlag set_target(assignment_target);
279 assign.left->visit(*this);
281 assign.right->visit(*this);
284 void DepthRangeConverter::visit(FunctionDeclaration &func)
286 r_position_z_assigned = false;
287 TraversingVisitor::visit(func);
289 if(func.definition==&func && func.name=="main" && !r_position_z_assigned)
291 VariableReference *position = new VariableReference;
292 position->name = "gl_Position";
294 MemberAccess *z = new MemberAccess;
298 Literal *scale = new Literal;
299 scale->token = "2.0";
302 BinaryExpression *multiply = new BinaryExpression;
303 multiply->oper = &Operator::get_operator("*", Operator::BINARY);
305 multiply->right = scale;
307 MemberAccess *w = new MemberAccess;
308 w->left = position->clone();
311 BinaryExpression *subtract = new BinaryExpression;
312 subtract->oper = &Operator::get_operator("-", Operator::BINARY);
313 subtract->left = multiply;
316 Assignment *assign = new Assignment;
317 assign->oper = &Operator::get_operator("=", Operator::BINARY);
318 assign->left = z->clone();
319 assign->right = subtract;
321 ExpressionStatement *statement = new ExpressionStatement;
322 statement->expression = assign;
324 func.body.body.push_back(statement);
329 void PrecisionConverter::apply(Stage &s)
332 s.content.visit(*this);
333 NodeRemover().apply(s, nodes_to_remove);
336 void PrecisionConverter::visit(Block &block)
338 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
340 if(&block==&stage->content)
346 void PrecisionConverter::visit(Precision &prec)
348 if(stage->required_features.target_api==OPENGL_ES)
349 have_default.insert(prec.type);
351 nodes_to_remove.insert(&prec);
354 void PrecisionConverter::visit(VariableDeclaration &var)
356 if(stage->required_features.target_api!=OPENGL_ES)
358 var.precision.clear();
362 const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
363 const TypeDeclaration *type = var.type_declaration;
366 if(dynamic_cast<const ImageTypeDeclaration *>(type))
368 default_prec = "lowp";
371 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
373 if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
375 type = basic->base_type;
383 if(!have_default.count(type->name))
385 Precision *prec = new Precision;
386 prec->precision = default_prec;
387 prec->type = type->name;
388 stage->content.body.insert(insert_point, prec);
390 have_default.insert(type->name);
395 void FeatureConverter::apply(Stage &s, const Features &feat)
400 if(!stage->required_features.glsl_version)
401 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
406 void FeatureConverter::unsupported(const string &reason)
408 Diagnostic diagnostic;
409 diagnostic.severity = Diagnostic::ERR;
410 diagnostic.source = GENERATED_SOURCE;
412 diagnostic.message = reason;
413 stage->diagnostics.push_back(diagnostic);
416 bool FeatureConverter::check_version(const Version &feature_version) const
418 if(features.glsl_version<feature_version)
420 else if(stage->required_features.glsl_version<feature_version)
421 stage->required_features.glsl_version = feature_version;
426 bool FeatureConverter::check_extension(bool Features::*extension) const
428 if(!(features.*extension))
431 stage->required_features.*extension = true;
437 void StructuralFeatureConverter::apply()
439 if(supports_stage(stage->type))
441 stage->content.visit(*this);
442 NodeRemover().apply(*stage, nodes_to_remove);
445 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
448 void StructuralFeatureConverter::visit(Block &block)
450 for(auto i=block.body.begin(); i!=block.body.end(); ++i)
452 if(&block==&stage->content)
453 uniform_insert_point = i;
458 void StructuralFeatureConverter::visit(RefPtr<Expression> &expr)
460 r_replaced_reference = 0;
462 if(r_replaced_reference)
463 expr = r_replaced_reference;
464 r_replaced_reference = 0;
467 bool StructuralFeatureConverter::supports_stage(Stage::Type st) const
469 if(st==Stage::GEOMETRY)
471 if(features.target_api==OPENGL_ES)
472 return check_version(Version(3, 20));
474 return check_version(Version(1, 50));
480 bool StructuralFeatureConverter::supports_unified_interface_syntax() const
482 if(features.target_api==OPENGL_ES)
483 return check_version(Version(3, 0));
485 return check_version(Version(1, 30));
488 void StructuralFeatureConverter::visit(VariableReference &var)
490 if(var.declaration==frag_out && !supports_unified_interface_syntax())
492 var.name = "gl_FragColor";
496 r_flattened_interface = nodes_to_remove.count(var.declaration);
499 void StructuralFeatureConverter::visit(MemberAccess &memacc)
501 r_flattened_interface = false;
503 if(r_flattened_interface)
505 VariableReference *var = new VariableReference;
506 var->name = memacc.member;
507 r_replaced_reference = var;
511 void StructuralFeatureConverter::visit(Assignment &assign)
513 TraversingVisitor::visit(assign);
514 if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
515 assign.target.declaration = 0;
518 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
520 if(features.target_api==OPENGL_ES)
521 return check_version(Version(3, 0));
523 return check_version(Version(1, 30));
526 void StructuralFeatureConverter::visit(FunctionCall &call)
528 if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
530 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
532 const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
533 if(arg_image && !supports_unified_sampling_functions())
535 string suffix = call.name.substr(7);
536 call.name = (arg_image->shadow ? "shadow" : "texture");
538 switch(arg_image->dimensions)
540 case ImageTypeDeclaration::ONE: call.name += "1D"; break;
541 case ImageTypeDeclaration::TWO: call.name += "2D"; break;
542 case ImageTypeDeclaration::THREE: call.name += "3D"; break;
543 case ImageTypeDeclaration::CUBE: call.name += "Cube"; break;
548 /* Array textures and the unified sampling function name were
549 both introduced in GLSL 1.30. */
550 if(arg_image->dimensions==ImageTypeDeclaration::ONE || arg_image->dimensions==ImageTypeDeclaration::TWO)
551 check_extension(&Features::ext_texture_array);
552 call.name += "Array";
560 TraversingVisitor::visit(call);
563 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
565 if(features.target_api==OPENGL_ES)
568 return check_version(Version(3, 0));
570 return check_version(Version(3, 20));
572 else if(check_version(Version(1, 50)))
574 else if(iface=="uniform")
575 return check_extension(&Features::arb_uniform_buffer_object);
580 void StructuralFeatureConverter::visit(VariableDeclaration &var)
582 if(var.block_declaration)
584 bool push_constant = has_layout_qualifier(var.layout.get(), "push_constant");
585 if(!supports_interface_blocks(var.interface) || (push_constant && features.target_api!=VULKAN))
587 if(var.name.find(' ')==string::npos)
588 unsupported("ARB_uniform_buffer_object required for interface block instances");
591 for(const RefPtr<Statement> &s: var.block_declaration->members.body)
592 if(VariableDeclaration *mem = dynamic_cast<VariableDeclaration *>(s.get()))
593 mem->interface = var.interface;
594 stage->content.body.splice(uniform_insert_point, var.block_declaration->members.body);
595 nodes_to_remove.insert(&var);
596 nodes_to_remove.insert(var.block_declaration);
601 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
602 if(stage->type==Stage::FRAGMENT && var.interface=="out")
605 nodes_to_remove.insert(&var);
608 TraversingVisitor::visit(var);
612 void QualifierConverter::apply()
614 stage->content.visit(*this);
617 bool QualifierConverter::supports_interface_layouts() const
619 if(features.target_api==OPENGL_ES)
620 return check_version(Version(3, 0));
621 else if(check_version(Version(3, 30)))
623 else if(check_version(Version(1, 30)))
624 return check_extension(&Features::arb_explicit_attrib_location);
629 bool QualifierConverter::supports_stage_interface_layouts() const
631 if(features.target_api==OPENGL_ES)
632 return check_version(Version(3, 10));
633 else if(check_version(Version(4, 10)))
636 return check_extension(&Features::arb_separate_shader_objects);
639 bool QualifierConverter::supports_centroid_sampling() const
641 if(features.target_api==OPENGL_ES)
642 return check_version(Version(3, 0));
643 else if(check_version(Version(1, 20)))
646 return check_extension(&Features::ext_gpu_shader4);
649 bool QualifierConverter::supports_sample_sampling() const
651 if(features.target_api==OPENGL_ES)
652 return check_version(Version(3, 20));
653 else if(check_version(Version(4, 0)))
656 return check_extension(&Features::arb_gpu_shader5);
659 bool QualifierConverter::supports_uniform_location() const
661 if(features.target_api==OPENGL_ES)
662 return check_version(Version(3, 10));
663 else if(check_version(Version(4, 30)))
666 return check_extension(&Features::arb_explicit_uniform_location);
669 bool QualifierConverter::supports_binding() const
671 if(features.target_api==OPENGL_ES)
672 return check_version(Version(3, 10));
674 return check_version(Version(4, 20));
677 bool QualifierConverter::supports_interface_block_location() const
679 if(features.target_api==OPENGL_ES)
680 return check_version(Version(3, 20));
681 else if(check_version(Version(4, 40)))
684 return check_extension(&Features::arb_enhanced_layouts);
687 void QualifierConverter::visit(VariableDeclaration &var)
691 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
693 if(i->name=="location")
695 bool supported = true;
696 bool external = false;
697 if(var.block_declaration)
698 supported = supports_interface_block_location();
699 else if(var.interface=="in")
701 external = (stage->type==Stage::VERTEX);
702 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
704 else if(var.interface=="out")
706 external = (stage->type==Stage::FRAGMENT);
707 supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
708 if(external && !supported && !check_extension(&Features::ext_gpu_shader4))
712 unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
715 else if(var.interface=="uniform")
716 supported = supports_uniform_location();
721 stage->locations[var.name] = i->value;
722 i = var.layout->qualifiers.erase(i);
727 else if(i->name=="binding" && !supports_binding())
729 if(var.block_declaration)
730 stage->uniform_block_bindings[var.block_declaration->block_name] = i->value;
731 else if(dynamic_cast<const ImageTypeDeclaration *>(get_ultimate_base_type(var.type_declaration)))
732 stage->texture_bindings[var.name] = i->value;
734 i = var.layout->qualifiers.erase(i);
740 if(var.layout->qualifiers.empty())
744 if(var.sampling=="centroid")
746 if(!supports_centroid_sampling())
747 var.sampling = string();
749 else if(var.sampling=="sample")
751 if(!supports_sample_sampling())
752 var.sampling = string();
755 if(var.name=="gl_ClipDistance")
756 if(const Literal *literal_size = dynamic_cast<const Literal *>(var.array_size.get()))
757 stage->n_clip_distances = literal_size->value.value<int>();
759 TraversingVisitor::visit(var);