]> git.tdb.fi Git - libs/gl.git/blob - source/glsl/finalize.cpp
Add a utility function for following a chain of base types
[libs/gl.git] / source / glsl / finalize.cpp
1 #include <msp/core/algorithm.h>
2 #include <msp/core/hash.h>
3 #include <msp/core/raii.h>
4 #include <msp/strings/lexicalcast.h>
5 #include "finalize.h"
6 #include "glsl_error.h"
7 #include "reflect.h"
8
9 using namespace std;
10
11 namespace Msp {
12 namespace GL {
13 namespace SL {
14
15 void StructOrganizer::visit(StructDeclaration &strct)
16 {
17         SetForScope<int> set_offset(offset, 0);
18         TraversingVisitor::visit(strct);
19 }
20
21 void StructOrganizer::visit(VariableDeclaration &var)
22 {
23         if(offset>=0)
24         {
25                 int *layout_offset = 0;
26                 bool has_matrix_order = false;
27                 if(var.layout)
28                 {
29                         for(Layout::Qualifier &q: var.layout->qualifiers)
30                         {
31                                 if(q.name=="offset" && q.has_value)
32                                 {
33                                         layout_offset = &q.value;
34                                         if(q.value>=offset)
35                                                 offset = q.value;
36                                 }
37                                 else if(q.name=="column_major" || q.name=="row_major")
38                                         has_matrix_order = true;
39                         }
40                 }
41
42                 MemoryRequirementsCalculator::Result mem_reqs = MemoryRequirementsCalculator().apply(var);
43                 offset += mem_reqs.alignment-1;
44                 offset -= offset%mem_reqs.alignment;
45
46                 if(layout_offset)
47                         *layout_offset = offset;
48                 else
49                 {
50                         if(!var.layout)
51                                 var.layout = new Layout;
52
53                         var.layout->qualifiers.push_back(Layout::Qualifier("offset", offset));
54                 }
55
56                 if(!has_matrix_order)
57                 {
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"));
63                 }
64
65                 offset += mem_reqs.size;
66         }
67 }
68
69
70 void LocationAllocator::apply(Module &module, const Features &features)
71 {
72         for(Stage &s: module.stages)
73                 apply(s);
74
75         if(features.target_api!=VULKAN)
76                 allocate_locations("uniform");
77
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);
82 }
83
84 void LocationAllocator::apply(Stage &stage)
85 {
86         swap(used_locations["in"], used_locations["out"]);
87         used_locations["out"].clear();
88
89         stage.content.visit(*this);
90
91         allocate_locations("in");
92         allocate_locations("out");
93 }
94
95 void LocationAllocator::allocate_locations(const string &iface)
96 {
97         auto write = unplaced_variables.begin();
98         unsigned next = 0;
99         for(auto i=unplaced_variables.begin(); i!=unplaced_variables.end(); ++i)
100         {
101                 if((*i)->interface!=iface)
102                 {
103                         if(write!=i)
104                                 *write = *i;
105                         ++write;
106                         continue;
107                 }
108
109                 if((*i)->interface=="uniform")
110                 {
111                         auto j = uniforms.find((*i)->name);
112                         if(j!=uniforms.end() && j->second.location>=0)
113                         {
114                                 add_layout_value((*i)->layout, "location", j->second.location);
115                                 continue;
116                         }
117                 }
118
119                 set<unsigned> &used = used_locations[(*i)->interface];
120
121                 unsigned size = LocationCounter().apply(**i);
122                 while(1)
123                 {
124                         int blocking = -1;
125                         for(unsigned j=0; j<size; ++j)
126                                 if(used.count(next+j))
127                                         blocking = next+j;
128                         if(blocking<0)
129                                 break;
130                         next = blocking+1;
131                 }
132
133                 add_layout_value((*i)->layout, "location", next);
134                 if((*i)->interface=="uniform")
135                         uniforms[(*i)->name].location = next;
136
137                 for(unsigned j=0; j<size; ++j)
138                         used.insert(next+j);
139                 next += size;
140         }
141
142         unplaced_variables.erase(write, unplaced_variables.end());
143 }
144
145 void LocationAllocator::bind_uniform(RefPtr<Layout> &layout, const string &name, unsigned range)
146 {
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);
150         else
151         {
152                 set<unsigned> &used = used_bindings[0];
153
154                 unsigned bind_point = fold32(hash64(name))%range;
155                 while(used.count(bind_point))
156                         bind_point = (bind_point+1)%range;
157
158                 add_layout_value(layout, "binding", bind_point);
159                 uniforms[name].bind_point = bind_point;
160                 used.insert(bind_point);
161         }
162 }
163
164 void LocationAllocator::add_layout_value(RefPtr<Layout> &layout, const string &name, unsigned value)
165 {
166         if(!layout)
167                 layout = new Layout;
168
169         layout->qualifiers.push_back(Layout::Qualifier(name, value));
170 }
171
172 bool LocationAllocator::visit_uniform(const string &name, RefPtr<Layout> &layout)
173 {
174         int bind_point = (layout ? get_layout_value(*layout, "binding") : -1);
175         if(bind_point>=0)
176         {
177                 used_bindings[0].insert(bind_point);
178                 uniforms[name].bind_point = bind_point;
179         }
180         return bind_point>=0;
181 }
182
183 void LocationAllocator::visit(VariableDeclaration &var)
184 {
185         if(!var.name.compare(0, 3, "gl_"))
186                 return;
187
188         if(!var.interface.empty())
189         {
190                 int location = (var.layout ? get_layout_value(*var.layout, "location") : -1);
191
192                 if(location<0 && var.linked_declaration && var.linked_declaration->layout)
193                 {
194                         location = get_layout_value(*var.linked_declaration->layout, "location");
195                         if(location>=0)
196                                 add_layout_value(var.layout, "location", location);
197                 }
198
199                 if(location>=0)
200                 {
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;
206                 }
207                 else
208                         unplaced_variables.push_back(&var);
209         }
210
211         if(var.interface=="uniform")
212         {
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);
216         }
217 }
218
219 void LocationAllocator::visit(InterfaceBlock &iface)
220 {
221         if(!iface.instance_name.compare(0, 3, "gl_"))
222                 return;
223
224         if(iface.interface=="uniform")
225         {
226                 bool push_constant = false;
227                 if(iface.layout)
228                 {
229                         auto i = find_member(iface.layout->qualifiers, string("push_constant"), &Layout::Qualifier::name);
230                         push_constant = (i!=iface.layout->qualifiers.end());
231                 }
232
233                 if(!push_constant && !visit_uniform(iface.block_name, iface.layout))
234                         unbound_blocks.push_back(&iface);
235         }
236 }
237
238
239 void PrecisionConverter::apply(Stage &s)
240 {
241         stage = &s;
242         s.content.visit(*this);
243         NodeRemover().apply(s, nodes_to_remove);
244 }
245
246 void PrecisionConverter::visit(Block &block)
247 {
248         for(auto i=block.body.begin(); i!=block.body.end(); ++i)
249         {
250                 if(&block==&stage->content)
251                         insert_point = i;
252                 (*i)->visit(*this);
253         }
254 }
255
256 void PrecisionConverter::visit(Precision &prec)
257 {
258         if(stage->required_features.target_api==OPENGL_ES)
259                 have_default.insert(prec.type);
260         else
261                 nodes_to_remove.insert(&prec);
262 }
263
264 void PrecisionConverter::visit(VariableDeclaration &var)
265 {
266         if(stage->required_features.target_api!=OPENGL_ES)
267         {
268                 var.precision.clear();
269                 return;
270         }
271
272         const char *default_prec = (stage->type==Stage::FRAGMENT ? "mediump" : "highp");
273         const TypeDeclaration *type = var.type_declaration;
274         while(type)
275         {
276                 if(dynamic_cast<const ImageTypeDeclaration *>(type))
277                 {
278                         default_prec = "lowp";
279                         break;
280                 }
281                 else if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
282                 {
283                         if(basic->kind==BasicTypeDeclaration::INT || basic->kind==BasicTypeDeclaration::FLOAT)
284                                 break;
285                         type = basic->base_type;
286                 }
287                 else
288                         return;
289         }
290         if(!type)
291                 return;
292
293         if(!have_default.count(type->name))
294         {
295                 Precision *prec = new Precision;
296                 prec->precision = default_prec;
297                 prec->type = type->name;
298                 stage->content.body.insert(insert_point, prec);
299
300                 have_default.insert(type->name);
301         }
302 }
303
304
305 void FeatureConverter::apply(Stage &s, const Features &feat)
306 {
307         stage = &s;
308         features = feat;
309
310         if(!stage->required_features.glsl_version)
311                 stage->required_features.glsl_version = Version(1, (stage->required_features.target_api==OPENGL_ES ? 0 : 10));
312
313         apply();
314 }
315
316 void FeatureConverter::unsupported(const string &reason)
317 {
318         Diagnostic diagnostic;
319         diagnostic.severity = Diagnostic::ERR;
320         diagnostic.source = GENERATED_SOURCE;
321         diagnostic.line = 0;
322         diagnostic.message = reason;
323         stage->diagnostics.push_back(diagnostic);
324 }
325
326 bool FeatureConverter::check_version(const Version &feature_version) const
327 {
328         if(features.glsl_version<feature_version)
329                 return false;
330         else if(stage->required_features.glsl_version<feature_version)
331                 stage->required_features.glsl_version = feature_version;
332
333         return true;
334 }
335
336 bool FeatureConverter::check_extension(bool Features::*extension) const
337 {
338         if(!(features.*extension))
339                 return false;
340
341         stage->required_features.*extension = true;
342
343         return true;
344 }
345
346
347 void StructuralFeatureConverter::apply()
348 {
349         if(supports_stage(stage->type))
350         {
351                 stage->content.visit(*this);
352                 NodeRemover().apply(*stage, nodes_to_remove);
353         }
354         else
355                 unsupported(format("Stage %s is not supported", Stage::get_stage_name(stage->type)));
356 }
357
358 void StructuralFeatureConverter::visit(Block &block)
359 {
360         for(auto i=block.body.begin(); i!=block.body.end(); ++i)
361         {
362                 if(&block==&stage->content)
363                         uniform_insert_point = i;
364                 (*i)->visit(*this);
365         }
366 }
367
368 void StructuralFeatureConverter::visit(RefPtr<Expression> &expr)
369 {
370         r_replaced_reference = 0;
371         expr->visit(*this);
372         if(r_replaced_reference)
373                 expr = r_replaced_reference;
374         r_replaced_reference = 0;
375 }
376
377 bool StructuralFeatureConverter::supports_stage(Stage::Type st) const
378 {
379         if(st==Stage::GEOMETRY)
380         {
381                 if(features.target_api==VULKAN)
382                         return true;
383                 else if(features.target_api==OPENGL_ES)
384                         return check_version(Version(3, 20));
385                 else
386                         return check_version(Version(1, 50));
387         }
388         else
389                 return true;
390 }
391
392 bool StructuralFeatureConverter::supports_unified_interface_syntax() const
393 {
394         if(features.target_api==VULKAN)
395                 return true;
396         else if(features.target_api==OPENGL_ES)
397                 return check_version(Version(3, 0));
398         else
399                 return check_version(Version(1, 30));
400 }
401
402 void StructuralFeatureConverter::visit(VariableReference &var)
403 {
404         if(var.declaration==frag_out && !supports_unified_interface_syntax())
405         {
406                 var.name = "gl_FragColor";
407                 var.declaration = 0;
408         }
409 }
410
411 void StructuralFeatureConverter::visit(InterfaceBlockReference &iface)
412 {
413         r_flattened_interface = nodes_to_remove.count(iface.declaration);
414 }
415
416 void StructuralFeatureConverter::visit(MemberAccess &memacc)
417 {
418         r_flattened_interface = false;
419         visit(memacc.left);
420         if(r_flattened_interface)
421         {
422                 VariableReference *var = new VariableReference;
423                 var->name = memacc.member;
424                 r_replaced_reference = var;
425         }
426 }
427
428 void StructuralFeatureConverter::visit(Assignment &assign)
429 {
430         TraversingVisitor::visit(assign);
431         if(assign.target.declaration==frag_out && !supports_unified_interface_syntax())
432                 assign.target.declaration = 0;
433 }
434
435 bool StructuralFeatureConverter::supports_unified_sampling_functions() const
436 {
437         if(features.target_api==VULKAN)
438                 return true;
439         else if(features.target_api==OPENGL_ES)
440                 return check_version(Version(3, 0));
441         else
442                 return check_version(Version(1, 30));
443 }
444
445 void StructuralFeatureConverter::visit(FunctionCall &call)
446 {
447         if(call.declaration && call.declaration->source==BUILTIN_SOURCE)
448         {
449                 if(!call.name.compare(0, 7, "texture") && call.arguments.size()>=1)
450                 {
451                         const ImageTypeDeclaration *arg_image = dynamic_cast<const ImageTypeDeclaration *>(call.arguments.front()->type);
452                         if(arg_image && !supports_unified_sampling_functions())
453                         {
454                                 string suffix = call.name.substr(7);
455                                 call.name = (arg_image->shadow ? "shadow" : "texture");
456
457                                 switch(arg_image->dimensions)
458                                 {
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;
463                                 }
464
465                                 if(arg_image->array)
466                                 {
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";
472                                 }
473
474                                 call.name += suffix;
475                         }
476                 }
477         }
478
479         TraversingVisitor::visit(call);
480 }
481
482 void StructuralFeatureConverter::visit(VariableDeclaration &var)
483 {
484         if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
485                 if(stage->type==Stage::FRAGMENT && var.interface=="out")
486                 {
487                         frag_out = &var;
488                         nodes_to_remove.insert(&var);
489                 }
490
491         TraversingVisitor::visit(var);
492 }
493
494 bool StructuralFeatureConverter::supports_interface_blocks(const string &iface) const
495 {
496         if(features.target_api==VULKAN)
497                 return true;
498         else if(features.target_api==OPENGL_ES)
499         {
500                 if(iface=="uniform")
501                         return check_version(Version(3, 0));
502                 else
503                         return check_version(Version(3, 20));
504         }
505         else if(check_version(Version(1, 50)))
506                 return true;
507         else if(iface=="uniform")
508                 return check_extension(&Features::arb_uniform_buffer_object);
509         else
510                 return false;
511 }
512
513 void StructuralFeatureConverter::visit(InterfaceBlock &iface)
514 {
515         bool push_constant = false;
516         if(iface.layout)
517         {
518                 auto i = find_member(iface.layout->qualifiers, string("push_constant"), &Layout::Qualifier::name);
519                 push_constant = (i!=iface.layout->qualifiers.end());
520         }
521
522         if((!supports_interface_blocks(iface.interface) || (push_constant && features.target_api!=VULKAN)) && iface.type_declaration)
523         {
524                 if(!iface.instance_name.empty())
525                         unsupported("ARB_uniform_buffer_object required for interface block instances");
526                 else if(iface.struct_declaration)
527                 {
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);
534                 }
535                 else
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");
539         }
540 }
541
542
543 void QualifierConverter::apply()
544 {
545         stage->content.visit(*this);
546 }
547
548 bool QualifierConverter::supports_interface_layouts() const
549 {
550         if(features.target_api==VULKAN)
551                 return true;
552         else if(features.target_api==OPENGL_ES)
553                 return check_version(Version(3, 0));
554         else if(check_version(Version(3, 30)))
555                 return true;
556         else if(check_version(Version(1, 30)))
557                 return check_extension(&Features::arb_explicit_attrib_location);
558         else
559                 return false;
560 }
561
562 bool QualifierConverter::supports_stage_interface_layouts() const
563 {
564         if(features.target_api==VULKAN)
565                 return true;
566         else if(features.target_api==OPENGL_ES)
567                 return check_version(Version(3, 10));
568         else if(check_version(Version(4, 10)))
569                 return true;
570         else
571                 return check_extension(&Features::arb_separate_shader_objects);
572 }
573
574 bool QualifierConverter::supports_centroid_sampling() const
575 {
576         if(features.target_api==VULKAN)
577                 return true;
578         else if(features.target_api==OPENGL_ES)
579                 return check_version(Version(3, 0));
580         else if(check_version(Version(1, 20)))
581                 return true;
582         else
583                 return check_extension(&Features::ext_gpu_shader4);
584 }
585
586 bool QualifierConverter::supports_sample_sampling() const
587 {
588         if(features.target_api==VULKAN)
589                 return true;
590         else if(features.target_api==OPENGL_ES)
591                 return check_version(Version(3, 20));
592         else if(check_version(Version(4, 0)))
593                 return true;
594         else
595                 return check_extension(&Features::arb_gpu_shader5);
596 }
597
598 bool QualifierConverter::supports_uniform_location() const
599 {
600         if(features.target_api==VULKAN)
601                 return true;
602         else if(features.target_api==OPENGL_ES)
603                 return check_version(Version(3, 10));
604         else if(check_version(Version(4, 30)))
605                 return true;
606         else
607                 return check_extension(&Features::arb_explicit_uniform_location);
608 }
609
610 bool QualifierConverter::supports_binding() const
611 {
612         if(features.target_api==VULKAN)
613                 return true;
614         else if(features.target_api==OPENGL_ES)
615                 return check_version(Version(3, 10));
616         else
617                 return check_version(Version(4, 20));
618 }
619
620 void QualifierConverter::visit(VariableDeclaration &var)
621 {
622         if(var.layout)
623         {
624                 for(auto i=var.layout->qualifiers.begin(); i!=var.layout->qualifiers.end(); )
625                 {
626                         if(i->name=="location")
627                         {
628                                 bool supported = true;
629                                 bool external = false;
630                                 if(var.interface=="in")
631                                 {
632                                         external = (stage->type==Stage::VERTEX);
633                                         supported = (external ? supports_interface_layouts() : supports_stage_interface_layouts());
634                                 }
635                                 else if(var.interface=="out")
636                                 {
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))
640                                         {
641                                                 external = false;
642                                                 if(i->value!=0)
643                                                         unsupported("EXT_gpu_shader4 required for multiple fragment shader outputs");
644                                         }
645                                 }
646                                 else if(var.interface=="uniform")
647                                         supported = supports_uniform_location();
648
649                                 if(!supported)
650                                 {
651                                         if(external)
652                                                 stage->locations[var.name] = i->value;
653                                         i = var.layout->qualifiers.erase(i);
654                                 }
655                                 else
656                                         ++i;
657                         }
658                         else if(i->name=="binding" && !supports_binding())
659                         {
660                                 if(dynamic_cast<const ImageTypeDeclaration *>(get_ultimate_base_type(var.type_declaration)))
661                                         stage->texture_bindings[var.name] = i->value;
662
663                                 i = var.layout->qualifiers.erase(i);
664                         }
665                         else
666                                 ++i;
667                 }
668
669                 if(var.layout->qualifiers.empty())
670                         var.layout = 0;
671         }
672
673         if(var.sampling=="centroid")
674         {
675                 if(!supports_centroid_sampling())
676                         var.sampling = string();
677         }
678         else if(var.sampling=="sample")
679         {
680                 if(!supports_sample_sampling())
681                         var.sampling = string();
682         }
683
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>();
687
688         TraversingVisitor::visit(var);
689 }
690
691 bool QualifierConverter::supports_interface_block_location() const
692 {
693         if(features.target_api==VULKAN)
694                 return true;
695         else if(features.target_api==OPENGL_ES)
696                 return check_version(Version(3, 20));
697         else if(check_version(Version(4, 40)))
698                 return true;
699         else
700                 return check_extension(&Features::arb_enhanced_layouts);
701 }
702
703 void QualifierConverter::visit(InterfaceBlock &iface)
704 {
705         if(iface.layout)
706         {
707                 for(auto i=iface.layout->qualifiers.begin(); i!=iface.layout->qualifiers.end(); )
708                 {
709                         if(i->name=="location" && !supports_interface_block_location())
710                                 i = iface.layout->qualifiers.erase(i);
711                         else if(i->name=="binding" && !supports_binding())
712                         {
713                                 stage->uniform_block_bindings[iface.block_name] = i->value;
714                                 i = iface.layout->qualifiers.erase(i);
715                         }
716                         else
717                                 ++i;
718                 }
719
720                 if(iface.layout->qualifiers.empty())
721                         iface.layout = 0;
722         }
723 }
724
725 } // namespace SL
726 } // namespace GL
727 } // namespace Msp