]> git.tdb.fi Git - libs/gl.git/blobdiff - source/glsl/compiler.cpp
Use default member initializers for simple types
[libs/gl.git] / source / glsl / compiler.cpp
index 347e16ad301dba1881b604713a68476095ccf0f2..506fba1c417c62657ee98292febc5102a5a752cd 100644 (file)
@@ -1,14 +1,20 @@
 #include <msp/core/algorithm.h>
-#include <msp/gl/extensions/ext_gpu_shader4.h>
 #include <msp/strings/format.h>
-#include "compatibility.h"
+#include <msp/strings/utils.h>
+#include "builtin.h"
 #include "compiler.h"
+#include "debug.h"
+#include "deviceinfo.h"
 #include "error.h"
+#include "finalize.h"
 #include "generate.h"
+#include "glsl_error.h"
+#include "modulecache.h"
 #include "optimize.h"
 #include "output.h"
-#include "resources.h"
-#include "shader.h"
+#include "resolve.h"
+#include "spirv.h"
+#include "validate.h"
 
 #undef interface
 
@@ -19,7 +25,11 @@ namespace GL {
 namespace SL {
 
 Compiler::Compiler():
-       module(0)
+       features(DeviceInfo::get_global().glsl_features)
+{ }
+
+Compiler::Compiler(const Features &f):
+       features(f)
 { }
 
 Compiler::~Compiler()
@@ -38,17 +48,17 @@ void Compiler::clear()
 void Compiler::set_source(const string &source, const string &src_name)
 {
        clear();
-       Parser parser;
        imported_names.push_back(src_name);
-       append_module(parser.parse(source, src_name, 1), 0);
+       ModuleCache mod_cache(0);
+       append_module(mod_cache.add_module(source, src_name), mod_cache);
 }
 
 void Compiler::load_source(IO::Base &io, DataFile::Collection *res, const string &src_name)
 {
        clear();
-       Parser parser;
        imported_names.push_back(src_name);
-       append_module(parser.parse(io, src_name, 1), res);
+       ModuleCache mod_cache(res);
+       append_module(mod_cache.add_module(io, src_name), mod_cache);
 }
 
 void Compiler::load_source(IO::Base &io, const string &src_name)
@@ -56,83 +66,185 @@ void Compiler::load_source(IO::Base &io, const string &src_name)
        load_source(io, 0, src_name);
 }
 
-void Compiler::compile()
+void Compiler::specialize(const map<string, int> &sv)
+{
+       specialized = true;
+       spec_values = sv;
+}
+
+void Compiler::compile(Mode mode)
 {
-       for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
-               generate(*i);
-       for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); )
+       if(specialized && mode!=PROGRAM)
+               throw invalid_operation("Compiler::compile");
+
+       for(Stage &s: module->stages)
+               generate(s);
+       ConstantIdAssigner().apply(*module, features);
+
+       for(Stage &s: module->stages)
+               validate(s);
+       GlobalInterfaceValidator().apply(*module);
+
+       bool valid = true;
+       for(Stage &s: module->stages)
+               if(!check_errors(s))
+                       valid = false;
+       if(!valid)
+               throw invalid_shader_source(get_diagnostics());
+
+       if(specialized)
+       {
+               for(Stage &s: module->stages)
+                       ConstantSpecializer().apply(s, spec_values);
+       }
+       for(auto i=module->stages.begin(); i!=module->stages.end(); )
        {
-               if(optimize(*i))
+               OptimizeResult result = optimize(*i);
+               if(result==REDO_PREVIOUS)
                        i = module->stages.begin();
-               else
+               else if(result!=REDO_STAGE)
                        ++i;
        }
-       for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
-               finalize(*i);
+
+       LocationAllocator().apply(*module, features);
+       for(Stage &s: module->stages)
+               finalize(s, mode);
+
+       compiled = true;
 }
 
-void Compiler::add_shaders(Program &program)
+string Compiler::get_combined_glsl() const
 {
-       if(!module)
-               throw invalid_operation("Compiler::add_shaders");
+       if(!compiled)
+               throw invalid_operation("Compiler::get_combined_glsl");
 
-       try
-       {
-               for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
-               {
-                       string stage_src = Formatter().apply(*i);
-
-                       if(i->type==Stage::VERTEX)
-                       {
-                               program.attach_shader_owned(new VertexShader(stage_src));
-                               for(map<string, unsigned>::iterator j=i->locations.begin(); j!=i->locations.end(); ++j)
-                                       program.bind_attribute(j->second, j->first);
-                       }
-                       else if(i->type==Stage::GEOMETRY)
-                               program.attach_shader_owned(new GeometryShader(stage_src));
-                       else if(i->type==Stage::FRAGMENT)
-                       {
-                               program.attach_shader_owned(new FragmentShader(stage_src));
-                               if(EXT_gpu_shader4)
-                               {
-                                       for(map<string, unsigned>::iterator j=i->locations.begin(); j!=i->locations.end(); ++j)
-                                               program.bind_fragment_data(j->second, j->first);
-                               }
-                       }
-               }
-       }
-       catch(const compile_error &e)
+       string glsl;
+
+       unsigned source_count = module->source_map.get_count();
+       for(unsigned i=1; i<source_count; ++i)
+               glsl += format("#pragma MSP source(%d, \"%s\")\n", i, module->source_map.get_name(i));
+       for(Stage &s: module->stages)
        {
-               throw compile_error(module->source_map.translate_errors(e.what()));
+               glsl += format("#pragma MSP stage(%s)\n", Stage::get_stage_name(s.type));
+               glsl += Formatter().apply(s);
+               glsl += '\n';
        }
+
+       return glsl;
+}
+
+vector<Stage::Type> Compiler::get_stages() const
+{
+       vector<Stage::Type> stage_types;
+       stage_types.reserve(module->stages.size());
+       for(const Stage &s: module->stages)
+               stage_types.push_back(s.type);
+       return stage_types;
+}
+
+string Compiler::get_stage_glsl(Stage::Type stage_type) const
+{
+       if(!compiled)
+               throw invalid_operation("Compiler::get_stage_glsl");
+       auto i = find_member(module->stages, stage_type, &Stage::type);
+       if(i!=module->stages.end())
+               return Formatter().apply(*i);
+       throw key_error(Stage::get_stage_name(stage_type));
+}
+
+vector<uint32_t> Compiler::get_combined_spirv() const
+{
+       if(!compiled)
+               throw invalid_operation("Compiler::get_combined_spirv");
+       SpirVGenerator gen;
+       gen.apply(*module);
+       return gen.get_code();
+}
+
+const map<string, unsigned> &Compiler::get_vertex_attributes() const
+{
+       if(!compiled)
+               throw invalid_operation("Compiler::get_vertex_attributes");
+       auto i = find_member(module->stages, Stage::VERTEX, &Stage::type);
+       if(i!=module->stages.end())
+               return i->locations;
+       throw invalid_operation("Compiler::get_vertex_attributes");
+}
+
+const map<string, unsigned> &Compiler::get_fragment_outputs() const
+{
+       if(!compiled)
+               throw invalid_operation("Compiler::get_fragment_outputs");
+       auto i = find_member(module->stages, Stage::FRAGMENT, &Stage::type);
+       if(i!=module->stages.end())
+               return i->locations;
+       throw invalid_operation("Compiler::get_fragment_outputs");
+}
+
+const map<string, unsigned> &Compiler::get_texture_bindings() const
+{
+       if(!compiled)
+               throw invalid_operation("Compiler::get_texture_bindings");
+       return module->shared.texture_bindings;
+}
+
+const map<string, unsigned> &Compiler::get_uniform_block_bindings() const
+{
+       if(!compiled)
+               throw invalid_operation("Compiler::get_uniform_block_bindings");
+       return module->shared.uniform_block_bindings;
 }
 
-void Compiler::append_module(Module &mod, DataFile::Collection *res)
+const SourceMap &Compiler::get_source_map() const
+{
+       return module->source_map;
+}
+
+string Compiler::get_stage_debug(Stage::Type stage_type) const
+{
+       auto i = find_member(module->stages, stage_type, &Stage::type);
+       if(i!=module->stages.end())
+               return DumpTree().apply(*i);
+       throw key_error(Stage::get_stage_name(stage_type));
+}
+
+string Compiler::get_diagnostics() const
+{
+       string combined;
+       for(const Stage &s: module->stages)
+               for(const Diagnostic &d: s.diagnostics)
+                       if(d.source!=INTERNAL_SOURCE)
+                               append(combined, "\n", format("%s:%d: %s", module->source_map.get_name(d.source), d.line, d.message));
+       return combined;
+}
+
+void Compiler::append_module(const Module &mod, ModuleCache &mod_cache)
 {
        module->source_map.merge_from(mod.source_map);
 
-       vector<Import *> imports = NodeGatherer<Import>().apply(mod.shared);
-       for(vector<Import *>::iterator i=imports.begin(); i!=imports.end(); ++i)
-               import(res, (*i)->module);
-       NodeRemover(set<Node *>(imports.begin(), imports.end())).apply(mod.shared);
+       vector<Import *> imports;
+       for(const RefPtr<Statement> &s: mod.shared.content.body)
+               if(Import *imp = dynamic_cast<Import *>(s.get()))
+                       imports.push_back(imp);
+       for(Import *i: imports)
+               import(mod_cache, i->module);
 
        append_stage(mod.shared);
-       for(list<Stage>::iterator i=mod.stages.begin(); i!=mod.stages.end(); ++i)
-               append_stage(*i);
+       for(const Stage &s: mod.stages)
+               append_stage(s);
 }
 
-void Compiler::append_stage(Stage &stage)
+void Compiler::append_stage(const Stage &stage)
 {
        Stage *target = 0;
        if(stage.type==Stage::SHARED)
                target = &module->shared;
        else
        {
-               list<Stage>::iterator i;
-               for(i=module->stages.begin(); (i!=module->stages.end() && i->type<stage.type); ++i) ;
+               auto i = find_if(module->stages, [&stage](const Stage &s){ return s.type>=stage.type; });
                if(i==module->stages.end() || i->type>stage.type)
                {
-                       list<Stage>::iterator j = module->stages.insert(i, stage.type);
+                       auto j = module->stages.insert(i, stage.type);
                        if(i!=module->stages.end())
                                i->previous = &*j;
                        i = j;
@@ -143,71 +255,151 @@ void Compiler::append_stage(Stage &stage)
                target = &*i;
        }
 
-       if(stage.required_version>target->required_version)
-               target->required_version = stage.required_version;
-       for(NodeList<Statement>::iterator i=stage.content.body.begin(); i!=stage.content.body.end(); ++i)
-               target->content.body.push_back(*i);
-       DeclarationCombiner().apply(*target);
+       if(stage.required_features.glsl_version>target->required_features.glsl_version)
+               target->required_features.glsl_version = stage.required_features.glsl_version;
+       for(const RefPtr<Statement> &s: stage.content.body)
+               if(!dynamic_cast<Import *>(s.get()))
+                       target->content.body.push_back(s);
 }
 
-void Compiler::import(DataFile::Collection *resources, const string &name)
+void Compiler::import(ModuleCache &mod_cache, const string &name)
 {
-       string fn = name+".glsl";
-       if(find(imported_names, fn)!=imported_names.end())
+       if(find(imported_names, name)!=imported_names.end())
                return;
-       imported_names.push_back(fn);
+       imported_names.push_back(name);
 
-       RefPtr<IO::Seekable> io = (resources ? resources->open_raw(fn) : Resources::get_builtins().open(fn));
-       if(!io)
-               throw runtime_error(format("module %s not found", name));
-       Parser import_parser;
-       append_module(import_parser.parse(*io, fn, module->source_map.get_count()), resources);
+       append_module(mod_cache.get_module(name), mod_cache);
 }
 
 void Compiler::generate(Stage &stage)
 {
-       if(module->shared.required_version>stage.required_version)
-               stage.required_version = module->shared.required_version;
+       stage.required_features.target_api = features.target_api;
+       if(module->shared.required_features.glsl_version>stage.required_features.glsl_version)
+               stage.required_features.glsl_version = module->shared.required_features.glsl_version;
+
        inject_block(stage.content, module->shared.content);
+       if(const Stage *builtins = get_builtins(stage.type))
+               inject_block(stage.content, builtins->content);
+       if(const Stage *builtins = get_builtins(Stage::SHARED))
+               inject_block(stage.content, builtins->content);
 
-       DeclarationReorderer().apply(stage);
-       FunctionResolver().apply(stage);
-       VariableResolver().apply(stage);
+       // Initial resolving pass
+       resolve(stage);
+
+       /* All variables local to a stage have been resolved.  Resolve non-local
+       variables through interfaces. */
        InterfaceGenerator().apply(stage);
-       VariableResolver().apply(stage);
-       DeclarationReorderer().apply(stage);
-       FunctionResolver().apply(stage);
-       LegacyConverter().apply(stage);
+       resolve(stage, RESOLVE_BLOCKS|RESOLVE_TYPES|RESOLVE_VARIABLES);
+}
+
+template<typename T>
+bool Compiler::resolve(Stage &stage, unsigned &flags, unsigned bit)
+{
+       if(!(flags&bit))
+               return false;
+
+       flags &= ~bit;
+       return T().apply(stage);
+}
+
+void Compiler::resolve(Stage &stage, unsigned flags)
+{
+       while(flags)
+       {
+               if(resolve<BlockHierarchyResolver>(stage, flags, RESOLVE_BLOCKS))
+                       ;
+               else if(resolve<TypeResolver>(stage, flags, RESOLVE_TYPES))
+                       flags |= RESOLVE_BLOCKS|RESOLVE_VARIABLES|RESOLVE_EXPRESSIONS;
+               else if(resolve<VariableResolver>(stage, flags, RESOLVE_VARIABLES))
+                       flags |= RESOLVE_EXPRESSIONS;
+               else if(resolve<FunctionResolver>(stage, flags, RESOLVE_FUNCTIONS))
+                       flags |= RESOLVE_EXPRESSIONS;
+               else if(resolve<ExpressionResolver>(stage, flags, RESOLVE_EXPRESSIONS))
+                       flags |= RESOLVE_VARIABLES|RESOLVE_FUNCTIONS;
+       }
 }
 
-bool Compiler::optimize(Stage &stage)
+void Compiler::validate(Stage &stage)
 {
+       DeclarationValidator().apply(stage);
+       IdentifierValidator().apply(stage);
+       ReferenceValidator().apply(stage);
+       ExpressionValidator().apply(stage);
+       FlowControlValidator().apply(stage);
+       StageInterfaceValidator().apply(stage);
+}
+
+bool Compiler::check_errors(Stage &stage)
+{
+       stable_sort(stage.diagnostics, &diagnostic_line_order);
+       return !any_of(stage.diagnostics.begin(), stage.diagnostics.end(),
+               [](const Diagnostic &d){ return d.severity==Diagnostic::ERR; });
+}
+
+bool Compiler::diagnostic_line_order(const Diagnostic &diag1, const Diagnostic &diag2)
+{
+       if(diag1.provoking_source!=diag2.provoking_source)
+       {
+               // Sort builtins first and imported modules according to import order.
+               if(diag1.provoking_source<=BUILTIN_SOURCE)
+                       return diag1.provoking_source<diag2.provoking_source;
+               else if(diag2.provoking_source<=BUILTIN_SOURCE)
+                       return false;
+               else
+                       return diag1.provoking_source>diag2.provoking_source;
+       }
+       return diag1.provoking_line<diag2.provoking_line;
+}
+
+Compiler::OptimizeResult Compiler::optimize(Stage &stage)
+{
+       if(ConstantFolder().apply(stage))
+               resolve(stage, RESOLVE_EXPRESSIONS);
        ConstantConditionEliminator().apply(stage);
 
-       set<FunctionDeclaration *> inlineable = InlineableFunctionLocator().apply(stage);
-       FunctionInliner(inlineable).apply(stage);
+       bool any_inlined = false;
+       if(FunctionInliner().apply(stage))
+       {
+               resolve(stage, RESOLVE_TYPES|RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
+               any_inlined = true;
+       }
+       if(ExpressionInliner().apply(stage))
+       {
+               resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
+               any_inlined = true;
+       }
 
-       set<Node *> unused = UnusedVariableLocator().apply(stage);
-       set<Node *> unused2 = UnusedFunctionLocator().apply(stage);
-       unused.insert(unused2.begin(), unused2.end());
-       NodeRemover(unused).apply(stage);
+       /* Removing variables or functions may cause things from the previous stage
+       to become unused. */
+       bool any_removed = UnreachableCodeRemover().apply(stage);
+       any_removed |= UnusedVariableRemover().apply(stage);
+       any_removed |= UnusedFunctionRemover().apply(stage);
+       any_removed |= UnusedTypeRemover().apply(stage);
 
-       return !unused.empty();
+       return any_removed ? REDO_PREVIOUS : any_inlined ? REDO_STAGE : NEXT_STAGE;
 }
 
-void Compiler::finalize(Stage &stage)
+void Compiler::finalize(Stage &stage, Mode mode)
 {
-       if(get_gl_api()==OPENGL_ES2)
-               DefaultPrecisionGenerator().apply(stage);
-       else
-               PrecisionRemover().apply(stage);
+       if(mode==PROGRAM)
+       {
+               LegacyConverter().apply(stage, features);
+               resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS);
+               PrecisionConverter().apply(stage);
+       }
+       else if(mode==SPIRV)
+               StructOrganizer().apply(stage);
+
+       // Collect bindings from all stages into the shared stage's maps
+       module->shared.texture_bindings.insert(stage.texture_bindings.begin(), stage.texture_bindings.end());
+       module->shared.uniform_block_bindings.insert(stage.uniform_block_bindings.begin(), stage.uniform_block_bindings.end());
 }
 
 void Compiler::inject_block(Block &target, const Block &source)
 {
-       NodeList<Statement>::iterator insert_point = target.body.begin();
-       for(NodeList<Statement>::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
-               target.body.insert(insert_point, (*i)->clone());
+       auto insert_point = target.body.begin();
+       for(const RefPtr<Statement> &s: source.body)
+               target.body.insert(insert_point, s->clone());
 }
 
 } // namespace SL