]> git.tdb.fi Git - libs/gl.git/blob - source/glsl/compiler.cpp
Remove the NodeGatherer visitor
[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 "compatibility.h"
6 #include "compiler.h"
7 #include "debug.h"
8 #include "error.h"
9 #include "generate.h"
10 #include "glsl_error.h"
11 #include "optimize.h"
12 #include "output.h"
13 #include "resources.h"
14 #include "validate.h"
15
16 #undef interface
17
18 using namespace std;
19
20 namespace Msp {
21 namespace GL {
22 namespace SL {
23
24 Compiler::Compiler():
25         features(Features::from_context()),
26         module(0),
27         specialized(false)
28 { }
29
30 Compiler::Compiler(const Features &f):
31         features(f),
32         module(0),
33         specialized(false)
34 { }
35
36 Compiler::~Compiler()
37 {
38         delete module;
39 }
40
41 void Compiler::clear()
42 {
43         delete module;
44         module = new Module();
45         imported_names.clear();
46         module->source_map.set_name(0, "<generated>");
47 }
48
49 void Compiler::set_source(const string &source, const string &src_name)
50 {
51         clear();
52         Parser parser;
53         imported_names.push_back(src_name);
54         append_module(parser.parse(source, src_name, 1), 0);
55 }
56
57 void Compiler::load_source(IO::Base &io, DataFile::Collection *res, const string &src_name)
58 {
59         clear();
60         Parser parser;
61         imported_names.push_back(src_name);
62         append_module(parser.parse(io, src_name, 1), res);
63 }
64
65 void Compiler::load_source(IO::Base &io, const string &src_name)
66 {
67         load_source(io, 0, src_name);
68 }
69
70 void Compiler::specialize(const map<string, int> &sv)
71 {
72         specialized = true;
73         spec_values = sv;
74 }
75
76 void Compiler::compile(Mode mode)
77 {
78         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
79                 generate(*i, mode);
80
81         bool valid = true;
82         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
83                 if(!validate(*i))
84                         valid = false;
85         if(!valid)
86                 throw invalid_shader_source(get_diagnostics());
87
88         unsigned n = 0;
89         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++n)
90         {
91                 OptimizeResult result = optimize(*i);
92                 if(result==REDO_PREVIOUS)
93                         i = module->stages.begin();
94                 else if(result!=REDO_STAGE)
95                         ++i;
96         }
97         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
98                 finalize(*i, mode);
99 }
100
101 string Compiler::get_combined_glsl() const
102 {
103         string glsl;
104
105         unsigned source_count = module->source_map.get_count();
106         for(unsigned i=1; i<source_count; ++i)
107                 glsl += format("#pragma MSP source(%d, \"%s\")\n", i, module->source_map.get_name(i));
108         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
109         {
110                 glsl += format("#pragma MSP stage(%s)\n", Stage::get_stage_name(i->type));
111                 glsl += Formatter().apply(*i, MODULE);
112                 glsl += '\n';
113         }
114
115         return glsl;
116 }
117
118 vector<Stage::Type> Compiler::get_stages() const
119 {
120         vector<Stage::Type> stage_types;
121         stage_types.reserve(module->stages.size());
122         for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
123                 stage_types.push_back(i->type);
124         return stage_types;
125 }
126
127 string Compiler::get_stage_glsl(Stage::Type stage_type) const
128 {
129         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
130                 if(i->type==stage_type)
131                         return Formatter().apply(*i, PROGRAM);
132         throw key_error(Stage::get_stage_name(stage_type));
133 }
134
135 const map<string, unsigned> &Compiler::get_vertex_attributes() const
136 {
137         for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
138                 if(i->type==Stage::VERTEX)
139                         return i->locations;
140         throw invalid_operation("Compiler::get_vertex_attributes");
141 }
142
143 const map<string, unsigned> &Compiler::get_fragment_outputs() const
144 {
145         for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
146                 if(i->type==Stage::FRAGMENT)
147                         return i->locations;
148         throw invalid_operation("Compiler::get_fragment_outputs");
149 }
150
151 const SourceMap &Compiler::get_source_map() const
152 {
153         return module->source_map;
154 }
155
156 string Compiler::get_stage_debug(Stage::Type stage_type) const
157 {
158         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
159                 if(i->type==stage_type)
160                         return DumpTree().apply(*i);
161         throw key_error(Stage::get_stage_name(stage_type));
162 }
163
164 string Compiler::get_diagnostics() const
165 {
166         string combined;
167         for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
168                 for(vector<Diagnostic>::const_iterator j=i->diagnostics.begin(); j!=i->diagnostics.end(); ++j)
169                         append(combined, "\n", format("%s:%d: %s", module->source_map.get_name(j->source), j->line, j->message));
170         return combined;
171 }
172
173 void Compiler::append_module(Module &mod, DataFile::Collection *res)
174 {
175         module->source_map.merge_from(mod.source_map);
176
177         vector<Import *> imports;
178         for(NodeList<Statement>::const_iterator i=mod.shared.content.body.begin(); i!=mod.shared.content.body.end(); ++i)
179                 if(Import *imp = dynamic_cast<Import *>(i->get()))
180                         imports.push_back(imp);
181         for(vector<Import *>::iterator i=imports.begin(); i!=imports.end(); ++i)
182                 import(res, (*i)->module);
183         NodeRemover().apply(mod.shared, set<Node *>(imports.begin(), imports.end()));
184
185         append_stage(mod.shared);
186         for(list<Stage>::iterator i=mod.stages.begin(); i!=mod.stages.end(); ++i)
187                 append_stage(*i);
188 }
189
190 void Compiler::append_stage(Stage &stage)
191 {
192         Stage *target = 0;
193         if(stage.type==Stage::SHARED)
194                 target = &module->shared;
195         else
196         {
197                 list<Stage>::iterator i;
198                 for(i=module->stages.begin(); (i!=module->stages.end() && i->type<stage.type); ++i) ;
199                 if(i==module->stages.end() || i->type>stage.type)
200                 {
201                         list<Stage>::iterator j = module->stages.insert(i, stage.type);
202                         if(i!=module->stages.end())
203                                 i->previous = &*j;
204                         i = j;
205                         if(i!=module->stages.begin())
206                                 i->previous = &*--j;
207                 }
208
209                 target = &*i;
210         }
211
212         if(stage.required_features.glsl_version>target->required_features.glsl_version)
213                 target->required_features.glsl_version = stage.required_features.glsl_version;
214         for(NodeList<Statement>::iterator i=stage.content.body.begin(); i!=stage.content.body.end(); ++i)
215                 target->content.body.push_back(*i);
216         DeclarationCombiner().apply(*target);
217 }
218
219 void Compiler::import(DataFile::Collection *resources, const string &name)
220 {
221         string fn = name+".glsl";
222         if(find(imported_names, fn)!=imported_names.end())
223                 return;
224         imported_names.push_back(fn);
225
226         RefPtr<IO::Seekable> io = (resources ? resources->open_raw(fn) : Resources::get_builtins().open(fn));
227         if(!io)
228                 throw runtime_error(format("module %s not found", name));
229         Parser import_parser;
230         append_module(import_parser.parse(*io, fn, module->source_map.get_count()), resources);
231 }
232
233 void Compiler::generate(Stage &stage, Mode mode)
234 {
235         stage.required_features.gl_api = features.gl_api;
236         if(module->shared.required_features.glsl_version>stage.required_features.glsl_version)
237                 stage.required_features.glsl_version = module->shared.required_features.glsl_version;
238
239         inject_block(stage.content, module->shared.content);
240         if(const Stage *builtins = get_builtins(stage.type))
241                 inject_block(stage.content, builtins->content);
242         if(const Stage *builtins = get_builtins(Stage::SHARED))
243                 inject_block(stage.content, builtins->content);
244
245         // Initial resolving pass
246         resolve(stage);
247
248         /* All variables local to a stage have been resolved.  Resolve non-local
249         variables through interfaces. */
250         InterfaceGenerator().apply(stage);
251         resolve(stage, RESOLVE_BLOCKS|RESOLVE_TYPES|RESOLVE_VARIABLES);
252
253         ConstantSpecializer().apply(stage, (mode==PROGRAM && specialized ? &spec_values : 0));
254         if(mode==PROGRAM)
255         {
256                 LegacyConverter().apply(stage, features);
257                 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS);
258         }
259 }
260
261 template<typename T>
262 bool Compiler::resolve(Stage &stage, unsigned &flags, unsigned bit)
263 {
264         if(!(flags&bit))
265                 return false;
266
267         flags &= ~bit;
268         return T().apply(stage);
269 }
270
271 void Compiler::resolve(Stage &stage, unsigned flags)
272 {
273         while(flags)
274         {
275                 if(resolve<BlockHierarchyResolver>(stage, flags, RESOLVE_BLOCKS))
276                         ;
277                 else if(resolve<TypeResolver>(stage, flags, RESOLVE_TYPES))
278                         flags |= RESOLVE_VARIABLES|RESOLVE_EXPRESSIONS;
279                 else if(resolve<VariableResolver>(stage, flags, RESOLVE_VARIABLES))
280                         flags |= RESOLVE_EXPRESSIONS;
281                 else if(resolve<FunctionResolver>(stage, flags, RESOLVE_FUNCTIONS))
282                         flags |= RESOLVE_EXPRESSIONS;
283                 else if(resolve<ExpressionResolver>(stage, flags, RESOLVE_EXPRESSIONS))
284                         flags |= RESOLVE_VARIABLES;
285         }
286 }
287
288 bool Compiler::validate(Stage &stage)
289 {
290         TypeValidator().apply(stage);
291         DeclarationValidator().apply(stage);
292         ReferenceValidator().apply(stage);
293         ExpressionValidator().apply(stage);
294
295         for(vector<Diagnostic>::const_iterator i=stage.diagnostics.begin(); i!=stage.diagnostics.end(); ++i)
296                 if(i->severity==Diagnostic::ERR)
297                         return false;
298
299         return true;
300 }
301
302 Compiler::OptimizeResult Compiler::optimize(Stage &stage)
303 {
304         ConstantConditionEliminator().apply(stage);
305
306         bool any_inlined = false;
307         if(FunctionInliner().apply(stage))
308         {
309                 resolve(stage, RESOLVE_TYPES|RESOLVE_VARIABLES|RESOLVE_EXPRESSIONS);
310                 any_inlined = true;
311         }
312         if(ExpressionInliner().apply(stage))
313         {
314                 resolve(stage, RESOLVE_VARIABLES|RESOLVE_EXPRESSIONS);
315                 any_inlined = true;
316         }
317
318         /* Removing variables or functions may cause things from the previous stage
319         to become unused. */
320         bool any_removed = UnusedVariableRemover().apply(stage);
321         any_removed |= UnusedFunctionRemover().apply(stage);
322         any_removed |= UnusedTypeRemover().apply(stage);
323
324         return any_removed ? REDO_PREVIOUS : any_inlined ? REDO_STAGE : NEXT_STAGE;
325 }
326
327 void Compiler::finalize(Stage &stage, Mode mode)
328 {
329         if(get_gl_api()==OPENGL_ES2 && mode==PROGRAM)
330                 DefaultPrecisionGenerator().apply(stage);
331         else if(mode==MODULE)
332                 PrecisionRemover().apply(stage);
333 }
334
335 void Compiler::inject_block(Block &target, const Block &source)
336 {
337         NodeList<Statement>::iterator insert_point = target.body.begin();
338         for(NodeList<Statement>::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
339                 target.body.insert(insert_point, (*i)->clone());
340 }
341
342 } // namespace SL
343 } // namespace GL
344 } // namespace Msp