]> git.tdb.fi Git - libs/gl.git/blob - source/glsl/compiler.cpp
4f2080ab9c59afb8c8b6018aed6cac2d60c40d09
[libs/gl.git] / source / glsl / compiler.cpp
1 #include <msp/core/algorithm.h>
2 #include <msp/strings/format.h>
3 #include <msp/strings/utils.h>
4 #include "builtin.h"
5 #include "compiler.h"
6 #include "debug.h"
7 #include "error.h"
8 #include "finalize.h"
9 #include "generate.h"
10 #include "glsl_error.h"
11 #include "modulecache.h"
12 #include "optimize.h"
13 #include "output.h"
14 #include "resolve.h"
15 #include "spirv.h"
16 #include "validate.h"
17
18 #undef interface
19
20 using namespace std;
21
22 namespace Msp {
23 namespace GL {
24 namespace SL {
25
26 Compiler::Compiler():
27         features(Features::from_context()),
28         module(0),
29         compiled(false),
30         specialized(false)
31 { }
32
33 Compiler::Compiler(const Features &f):
34         features(f),
35         module(0),
36         compiled(false),
37         specialized(false)
38 { }
39
40 Compiler::~Compiler()
41 {
42         delete module;
43 }
44
45 void Compiler::clear()
46 {
47         delete module;
48         module = new Module();
49         imported_names.clear();
50         module->source_map.set_name(0, "<generated>");
51 }
52
53 void Compiler::set_source(const string &source, const string &src_name)
54 {
55         clear();
56         imported_names.push_back(src_name);
57         ModuleCache mod_cache(0);
58         append_module(mod_cache.add_module(source, src_name), mod_cache);
59 }
60
61 void Compiler::load_source(IO::Base &io, DataFile::Collection *res, const string &src_name)
62 {
63         clear();
64         imported_names.push_back(src_name);
65         ModuleCache mod_cache(res);
66         append_module(mod_cache.add_module(io, src_name), mod_cache);
67 }
68
69 void Compiler::load_source(IO::Base &io, const string &src_name)
70 {
71         load_source(io, 0, src_name);
72 }
73
74 void Compiler::specialize(const map<string, int> &sv)
75 {
76         specialized = true;
77         spec_values = sv;
78 }
79
80 void Compiler::compile(Mode mode)
81 {
82         if(specialized && mode!=PROGRAM)
83                 throw invalid_operation("Compiler::compile");
84
85         for(Stage &s: module->stages)
86                 generate(s);
87         ConstantIdAssigner().apply(*module, features);
88
89         for(Stage &s: module->stages)
90                 validate(s);
91         GlobalInterfaceValidator().apply(*module);
92
93         bool valid = true;
94         for(Stage &s: module->stages)
95                 if(!check_errors(s))
96                         valid = false;
97         if(!valid)
98                 throw invalid_shader_source(get_diagnostics());
99
100         if(specialized)
101         {
102                 for(Stage &s: module->stages)
103                         ConstantSpecializer().apply(s, spec_values);
104         }
105         for(auto i=module->stages.begin(); i!=module->stages.end(); )
106         {
107                 OptimizeResult result = optimize(*i);
108                 if(result==REDO_PREVIOUS)
109                         i = module->stages.begin();
110                 else if(result!=REDO_STAGE)
111                         ++i;
112         }
113
114         LocationAllocator().apply(*module, features);
115         for(Stage &s: module->stages)
116                 finalize(s, mode);
117
118         compiled = true;
119 }
120
121 string Compiler::get_combined_glsl() const
122 {
123         if(!compiled)
124                 throw invalid_operation("Compiler::get_combined_glsl");
125
126         string glsl;
127
128         unsigned source_count = module->source_map.get_count();
129         for(unsigned i=1; i<source_count; ++i)
130                 glsl += format("#pragma MSP source(%d, \"%s\")\n", i, module->source_map.get_name(i));
131         for(Stage &s: module->stages)
132         {
133                 glsl += format("#pragma MSP stage(%s)\n", Stage::get_stage_name(s.type));
134                 glsl += Formatter().apply(s);
135                 glsl += '\n';
136         }
137
138         return glsl;
139 }
140
141 vector<Stage::Type> Compiler::get_stages() const
142 {
143         vector<Stage::Type> stage_types;
144         stage_types.reserve(module->stages.size());
145         for(const Stage &s: module->stages)
146                 stage_types.push_back(s.type);
147         return stage_types;
148 }
149
150 string Compiler::get_stage_glsl(Stage::Type stage_type) const
151 {
152         if(!compiled)
153                 throw invalid_operation("Compiler::get_stage_glsl");
154         auto i = find_member(module->stages, stage_type, &Stage::type);
155         if(i!=module->stages.end())
156                 return Formatter().apply(*i);
157         throw key_error(Stage::get_stage_name(stage_type));
158 }
159
160 vector<UInt32> Compiler::get_combined_spirv() const
161 {
162         if(!compiled)
163                 throw invalid_operation("Compiler::get_combined_spirv");
164         SpirVGenerator gen;
165         gen.apply(*module);
166         return gen.get_code();
167 }
168
169 const map<string, unsigned> &Compiler::get_vertex_attributes() const
170 {
171         if(!compiled)
172                 throw invalid_operation("Compiler::get_vertex_attributes");
173         auto i = find_member(module->stages, Stage::VERTEX, &Stage::type);
174         if(i!=module->stages.end())
175                 return i->locations;
176         throw invalid_operation("Compiler::get_vertex_attributes");
177 }
178
179 const map<string, unsigned> &Compiler::get_fragment_outputs() const
180 {
181         if(!compiled)
182                 throw invalid_operation("Compiler::get_fragment_outputs");
183         auto i = find_member(module->stages, Stage::FRAGMENT, &Stage::type);
184         if(i!=module->stages.end())
185                 return i->locations;
186         throw invalid_operation("Compiler::get_fragment_outputs");
187 }
188
189 const map<string, unsigned> &Compiler::get_texture_bindings() const
190 {
191         if(!compiled)
192                 throw invalid_operation("Compiler::get_texture_bindings");
193         return module->shared.texture_bindings;
194 }
195
196 const map<string, unsigned> &Compiler::get_uniform_block_bindings() const
197 {
198         if(!compiled)
199                 throw invalid_operation("Compiler::get_uniform_block_bindings");
200         return module->shared.uniform_block_bindings;
201 }
202
203 const SourceMap &Compiler::get_source_map() const
204 {
205         return module->source_map;
206 }
207
208 string Compiler::get_stage_debug(Stage::Type stage_type) const
209 {
210         auto i = find_member(module->stages, stage_type, &Stage::type);
211         if(i!=module->stages.end())
212                 return DumpTree().apply(*i);
213         throw key_error(Stage::get_stage_name(stage_type));
214 }
215
216 string Compiler::get_diagnostics() const
217 {
218         string combined;
219         for(const Stage &s: module->stages)
220                 for(const Diagnostic &d: s.diagnostics)
221                         if(d.source!=INTERNAL_SOURCE)
222                                 append(combined, "\n", format("%s:%d: %s", module->source_map.get_name(d.source), d.line, d.message));
223         return combined;
224 }
225
226 void Compiler::append_module(const Module &mod, ModuleCache &mod_cache)
227 {
228         module->source_map.merge_from(mod.source_map);
229
230         vector<Import *> imports;
231         for(const RefPtr<Statement> &s: mod.shared.content.body)
232                 if(Import *imp = dynamic_cast<Import *>(s.get()))
233                         imports.push_back(imp);
234         for(Import *i: imports)
235                 import(mod_cache, i->module);
236
237         append_stage(mod.shared);
238         for(const Stage &s: mod.stages)
239                 append_stage(s);
240 }
241
242 void Compiler::append_stage(const Stage &stage)
243 {
244         Stage *target = 0;
245         if(stage.type==Stage::SHARED)
246                 target = &module->shared;
247         else
248         {
249                 auto i = find_if(module->stages, [&stage](const Stage &s){ return s.type>=stage.type; });
250                 if(i==module->stages.end() || i->type>stage.type)
251                 {
252                         auto j = module->stages.insert(i, stage.type);
253                         if(i!=module->stages.end())
254                                 i->previous = &*j;
255                         i = j;
256                         if(i!=module->stages.begin())
257                                 i->previous = &*--j;
258                 }
259
260                 target = &*i;
261         }
262
263         if(stage.required_features.glsl_version>target->required_features.glsl_version)
264                 target->required_features.glsl_version = stage.required_features.glsl_version;
265         for(const RefPtr<Statement> &s: stage.content.body)
266                 if(!dynamic_cast<Import *>(s.get()))
267                         target->content.body.push_back(s);
268 }
269
270 void Compiler::import(ModuleCache &mod_cache, const string &name)
271 {
272         if(find(imported_names, name)!=imported_names.end())
273                 return;
274         imported_names.push_back(name);
275
276         append_module(mod_cache.get_module(name), mod_cache);
277 }
278
279 void Compiler::generate(Stage &stage)
280 {
281         stage.required_features.gl_api = features.gl_api;
282         if(module->shared.required_features.glsl_version>stage.required_features.glsl_version)
283                 stage.required_features.glsl_version = module->shared.required_features.glsl_version;
284
285         inject_block(stage.content, module->shared.content);
286         if(const Stage *builtins = get_builtins(stage.type))
287                 inject_block(stage.content, builtins->content);
288         if(const Stage *builtins = get_builtins(Stage::SHARED))
289                 inject_block(stage.content, builtins->content);
290
291         // Initial resolving pass
292         resolve(stage);
293
294         /* All variables local to a stage have been resolved.  Resolve non-local
295         variables through interfaces. */
296         InterfaceGenerator().apply(stage);
297         resolve(stage, RESOLVE_BLOCKS|RESOLVE_TYPES|RESOLVE_VARIABLES);
298 }
299
300 template<typename T>
301 bool Compiler::resolve(Stage &stage, unsigned &flags, unsigned bit)
302 {
303         if(!(flags&bit))
304                 return false;
305
306         flags &= ~bit;
307         return T().apply(stage);
308 }
309
310 void Compiler::resolve(Stage &stage, unsigned flags)
311 {
312         while(flags)
313         {
314                 if(resolve<BlockHierarchyResolver>(stage, flags, RESOLVE_BLOCKS))
315                         ;
316                 else if(resolve<TypeResolver>(stage, flags, RESOLVE_TYPES))
317                         flags |= RESOLVE_BLOCKS|RESOLVE_VARIABLES|RESOLVE_EXPRESSIONS;
318                 else if(resolve<VariableResolver>(stage, flags, RESOLVE_VARIABLES))
319                         flags |= RESOLVE_EXPRESSIONS;
320                 else if(resolve<FunctionResolver>(stage, flags, RESOLVE_FUNCTIONS))
321                         flags |= RESOLVE_EXPRESSIONS;
322                 else if(resolve<ExpressionResolver>(stage, flags, RESOLVE_EXPRESSIONS))
323                         flags |= RESOLVE_VARIABLES|RESOLVE_FUNCTIONS;
324         }
325 }
326
327 void Compiler::validate(Stage &stage)
328 {
329         DeclarationValidator().apply(stage);
330         IdentifierValidator().apply(stage);
331         ReferenceValidator().apply(stage);
332         ExpressionValidator().apply(stage);
333         FlowControlValidator().apply(stage);
334         StageInterfaceValidator().apply(stage);
335 }
336
337 bool Compiler::check_errors(Stage &stage)
338 {
339         stable_sort(stage.diagnostics, &diagnostic_line_order);
340         return !any_of(stage.diagnostics.begin(), stage.diagnostics.end(),
341                 [](const Diagnostic &d){ return d.severity==Diagnostic::ERR; });
342 }
343
344 bool Compiler::diagnostic_line_order(const Diagnostic &diag1, const Diagnostic &diag2)
345 {
346         if(diag1.provoking_source!=diag2.provoking_source)
347         {
348                 // Sort builtins first and imported modules according to import order.
349                 if(diag1.provoking_source<=BUILTIN_SOURCE)
350                         return diag1.provoking_source<diag2.provoking_source;
351                 else if(diag2.provoking_source<=BUILTIN_SOURCE)
352                         return false;
353                 else
354                         return diag1.provoking_source>diag2.provoking_source;
355         }
356         return diag1.provoking_line<diag2.provoking_line;
357 }
358
359 Compiler::OptimizeResult Compiler::optimize(Stage &stage)
360 {
361         if(ConstantFolder().apply(stage))
362                 resolve(stage, RESOLVE_EXPRESSIONS);
363         ConstantConditionEliminator().apply(stage);
364
365         bool any_inlined = false;
366         if(FunctionInliner().apply(stage))
367         {
368                 resolve(stage, RESOLVE_TYPES|RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
369                 any_inlined = true;
370         }
371         if(ExpressionInliner().apply(stage))
372         {
373                 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
374                 any_inlined = true;
375         }
376
377         /* Removing variables or functions may cause things from the previous stage
378         to become unused. */
379         bool any_removed = UnreachableCodeRemover().apply(stage);
380         any_removed |= UnusedVariableRemover().apply(stage);
381         any_removed |= UnusedFunctionRemover().apply(stage);
382         any_removed |= UnusedTypeRemover().apply(stage);
383
384         return any_removed ? REDO_PREVIOUS : any_inlined ? REDO_STAGE : NEXT_STAGE;
385 }
386
387 void Compiler::finalize(Stage &stage, Mode mode)
388 {
389         if(mode==PROGRAM)
390         {
391                 LegacyConverter().apply(stage, features);
392                 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS);
393                 PrecisionConverter().apply(stage);
394         }
395         else if(mode==SPIRV)
396                 StructOrganizer().apply(stage);
397
398         // Collect bindings from all stages into the shared stage's maps
399         module->shared.texture_bindings.insert(stage.texture_bindings.begin(), stage.texture_bindings.end());
400         module->shared.uniform_block_bindings.insert(stage.uniform_block_bindings.begin(), stage.uniform_block_bindings.end());
401 }
402
403 void Compiler::inject_block(Block &target, const Block &source)
404 {
405         auto insert_point = target.body.begin();
406         for(const RefPtr<Statement> &s: source.body)
407                 target.body.insert(insert_point, s->clone());
408 }
409
410 } // namespace SL
411 } // namespace GL
412 } // namespace Msp