#include <msp/core/algorithm.h>
-#include <msp/gl/extensions/ext_gpu_shader4.h>
#include <msp/strings/format.h>
-#include <msp/strings/regex.h>
#include <msp/strings/utils.h>
-#include "compatibility.h"
+#include "builtin.h"
#include "compiler.h"
+#include "debug.h"
#include "error.h"
+#include "finalize.h"
#include "generate.h"
+#include "glsl_error.h"
+#include "modulecache.h"
#include "optimize.h"
#include "output.h"
-#include "shader.h"
+#include "resolve.h"
+#include "spirv.h"
+#include "validate.h"
#undef interface
namespace GL {
namespace SL {
-Compiler::Compiler():
- resources(0),
- module(0)
+Compiler::Compiler(const Features &f):
+ features(f)
{ }
Compiler::~Compiler()
delete module;
}
-void Compiler::compile(const string &source, const string &src_name)
+void Compiler::clear()
{
- resources = 0;
delete module;
module = new Module();
- Parser parser;
+ imported_names.clear();
+ module->source_map.set_name(0, "<generated>");
+}
+
+void Compiler::set_source(const string &source, const string &src_name)
+{
+ clear();
imported_names.push_back(src_name);
- append_module(parser.parse(source, src_name, 1));
- process();
+ ModuleCache mod_cache(0);
+ append_module(mod_cache.add_module(source, src_name), mod_cache);
}
-void Compiler::compile(IO::Base &io, Resources *res, const string &src_name)
+void Compiler::load_source(IO::Base &io, DataFile::Collection *res, const string &src_name)
{
- resources = res;
- delete module;
- module = new Module();
- Parser parser;
+ clear();
imported_names.push_back(src_name);
- append_module(parser.parse(io, src_name, 1));
- process();
+ 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)
+{
+ load_source(io, 0, src_name);
}
-void Compiler::compile(IO::Base &io, const string &src_name)
+void Compiler::specialize(const map<string, int> &sv)
{
- compile(io, 0, src_name);
+ specialized = true;
+ spec_values = sv;
}
-void Compiler::add_shaders(Program &program)
+void Compiler::compile(Mode mode)
{
- if(!module)
- throw invalid_operation("Compiler::add_shaders");
+ if(specialized && mode!=PROGRAM)
+ throw invalid_operation("Compiler::compile");
+
+ for(Stage &s: module->stages)
+ generate(s);
+ ConstantIdAssigner().apply(*module, features);
+ LocationAllocator().apply(*module, features, false);
+
+ 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());
- try
+ if(specialized)
{
- 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);
- }
- }
- }
+ for(Stage &s: module->stages)
+ ConstantSpecializer().apply(s, spec_values);
}
- catch(const compile_error &e)
+ if(mode==PROGRAM)
{
- static const Regex r_message("^(([0-9]+)\\(([0-9]+)\\) :|ERROR: ([0-9]+):([0-9]+):) (.*)$");
- vector<string> lines = split(e.what(), '\n');
- string translated;
- for(vector<string>::const_iterator i=lines.begin(); i!=lines.end(); ++i)
+ for(Stage &s: module->stages)
+ DepthRangeConverter().apply(s, features);
+ }
+ for(auto i=module->stages.begin(); i!=module->stages.end(); )
+ {
+ OptimizeResult result = optimize(*i);
+ if(result==REDO_PREVIOUS)
+ i = module->stages.begin();
+ else if(result!=REDO_STAGE)
+ ++i;
+ }
+
+ Stage *prev_stage = 0;
+ for(auto i=module->stages.begin(); i!=module->stages.end(); )
+ {
+ if(i->functions.empty())
+ i = module->stages.erase(i);
+ else
{
- RegMatch m = r_message.match(*i);
- if(m)
- {
- unsigned index = 0;
- unsigned line = 0;
- if(m[2])
- {
- index = lexical_cast<unsigned>(m[2].str);
- line = lexical_cast<unsigned>(m[3].str);
- }
- else if(m[4])
- {
- index = lexical_cast<unsigned>(m[4].str);
- line = lexical_cast<unsigned>(m[5].str);
- }
- const char *src = "<unknown>";
- if(index==0)
- src = "<generated>";
- else if(index-1<imported_names.size())
- src = imported_names[index-1].c_str();
- translated += format("%s:%d: %s", src, line, m[6].str);
- }
- else
- translated += *i;
- translated += '\n';
+ i->previous = prev_stage;
+ prev_stage = &*i;
+ ++i;
}
+ }
+
+ for(Stage &s: module->stages)
+ {
+ StructuralFeatureConverter().apply(s, features);
+ resolve(s, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS);
+ }
+ LocationAllocator().apply(*module, features);
+ for(Stage &s: module->stages)
+ finalize(s, mode);
+
+ compiled = true;
+}
+
+string Compiler::get_combined_glsl() const
+{
+ if(!compiled)
+ throw invalid_operation("Compiler::get_combined_glsl");
+
+ string glsl;
- throw compile_error(translated);
+ 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)
+ {
+ 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;
}
-void Compiler::append_module(Module &mod)
+string Compiler::get_stage_glsl(Stage::Type stage_type) const
{
- vector<Import *> imports = NodeGatherer<Import>().apply(mod.shared);
- for(vector<Import *>::iterator i=imports.begin(); i!=imports.end(); ++i)
- import((*i)->module);
- NodeRemover(set<Node *>(imports.begin(), imports.end())).apply(mod.shared);
+ 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, features);
+ 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;
+}
+
+unsigned Compiler::get_n_clip_distances() const
+{
+ if(!compiled)
+ throw invalid_operation("Compiler::get_n_clip_distances");
+ auto i = find_member(module->stages, Stage::VERTEX, &Stage::type);
+ return (i!=module->stages.end() ? i->n_clip_distances : 0);
+}
+
+const SourceMap &Compiler::get_source_map() const
+{
+ return module->source_map;
+}
+
+string Compiler::get_stage_debug(Stage::Type stage_type, bool use_colors) const
+{
+ auto i = find_member(module->stages, stage_type, &Stage::type);
+ if(i!=module->stages.end())
+ return DumpTree(use_colors).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;
+ 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;
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::process()
+void Compiler::import(ModuleCache &mod_cache, const string &name)
{
- 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(optimize(*i))
- i = module->stages.begin();
- else
- ++i;
- }
- for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
- finalize(*i);
-}
-
-void Compiler::import(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, imported_names.size()));
+ 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);
+
+ // Initial resolving pass
+ resolve(stage);
- DeclarationReorderer().apply(stage);
- FunctionResolver().apply(stage);
- VariableResolver().apply(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);
+
+ ArraySizer().apply(stage);
+ resolve(stage, RESOLVE_EXPRESSIONS);
}
-bool Compiler::optimize(Stage &stage)
+template<typename T>
+bool Compiler::resolve(Stage &stage, unsigned &flags, unsigned bit)
{
- ConstantConditionEliminator().apply(stage);
+ if(!(flags&bit))
+ return false;
- set<FunctionDeclaration *> inlineable = InlineableFunctionLocator().apply(stage);
- FunctionInliner(inlineable).apply(stage);
+ flags &= ~bit;
+ return T().apply(stage);
+}
- set<Node *> unused = UnusedVariableLocator().apply(stage);
- set<Node *> unused2 = UnusedFunctionLocator().apply(stage);
- unused.insert(unused2.begin(), unused2.end());
- NodeRemover(unused).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;
+ }
+}
- return !unused.empty();
+void Compiler::validate(Stage &stage)
+{
+ DeclarationValidator().apply(stage, features);
+ IdentifierValidator().apply(stage);
+ ReferenceValidator().apply(stage);
+ ExpressionValidator().apply(stage);
+ FlowControlValidator().apply(stage);
+ StageInterfaceValidator().apply(stage);
}
-void Compiler::finalize(Stage &stage)
+bool Compiler::check_errors(Stage &stage)
{
- if(get_gl_api()==OPENGL_ES2)
- DefaultPrecisionGenerator().apply(stage);
- else
- PrecisionRemover().apply(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);
+ if(ConstantConditionEliminator().apply(stage))
+ resolve(stage, RESOLVE_VARIABLES);
+
+ bool any_inlined = false;
+ if(FunctionInliner().apply(stage))
+ {
+ resolve(stage, RESOLVE_TYPES|RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
+ any_inlined = true;
+ }
+ if(AggregateDismantler().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;
+ }
+
+ /* 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 any_removed ? REDO_PREVIOUS : any_inlined ? REDO_STAGE : NEXT_STAGE;
+}
+
+void Compiler::finalize(Stage &stage, Mode mode)
+{
+ QualifierConverter().apply(stage, features);
+ PrecisionConverter().apply(stage);
+ 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