]> git.tdb.fi Git - libs/gl.git/blobdiff - source/glsl/optimize.cpp
Don't return references from apply functions
[libs/gl.git] / source / glsl / optimize.cpp
index 7473fe2ca598ad996ee6c3263385f938986e80e2..32f7ce67959b388fa1bc2c2fb58ecc344a11bb87 100644 (file)
@@ -1,6 +1,7 @@
 #include <msp/core/raii.h>
 #include <msp/strings/format.h>
 #include "optimize.h"
+#include "reflect.h"
 
 using namespace std;
 
@@ -8,6 +9,55 @@ namespace Msp {
 namespace GL {
 namespace SL {
 
+ConstantSpecializer::ConstantSpecializer():
+       values(0)
+{ }
+
+void ConstantSpecializer::apply(Stage &stage, const map<string, int> &v)
+{
+       values = &v;
+       stage.content.visit(*this);
+}
+
+void ConstantSpecializer::visit(VariableDeclaration &var)
+{
+       bool specializable = false;
+       if(var.layout)
+       {
+               vector<Layout::Qualifier> &qualifiers = var.layout->qualifiers;
+               for(vector<Layout::Qualifier>::iterator i=qualifiers.begin(); (!specializable && i!=qualifiers.end()); ++i)
+                       if(i->name=="constant_id")
+                       {
+                               specializable = true;
+                               qualifiers.erase(i);
+                       }
+
+               if(qualifiers.empty())
+                       var.layout = 0;
+       }
+
+       if(specializable)
+       {
+               map<string, int>::const_iterator i = values->find(var.name);
+               if(i!=values->end())
+               {
+                       RefPtr<Literal> literal = new Literal;
+                       if(var.type=="bool")
+                       {
+                               literal->token = (i->second ? "true" : "false");
+                               literal->value = static_cast<bool>(i->second);
+                       }
+                       else if(var.type=="int")
+                       {
+                               literal->token = lexical_cast<string>(i->second);
+                               literal->value = i->second;
+                       }
+                       var.init_expression = literal;
+               }
+       }
+}
+
+
 InlineableFunctionLocator::InlineableFunctionLocator():
        current_function(0),
        return_count(0)
@@ -34,8 +84,12 @@ void InlineableFunctionLocator::visit(FunctionCall &call)
 
 void InlineableFunctionLocator::visit(FunctionDeclaration &func)
 {
+       bool has_out_params = false;
+       for(NodeArray<VariableDeclaration>::const_iterator i=func.parameters.begin(); (!has_out_params && i!=func.parameters.end()); ++i)
+               has_out_params = ((*i)->interface=="out");
+
        unsigned &count = refcounts[func.definition];
-       if(count<=1 && func.parameters.empty())
+       if(count<=1 && !has_out_params)
                inlineable.insert(func.definition);
 
        SetForScope<FunctionDeclaration *> set(current_function, &func);
@@ -66,83 +120,97 @@ void InlineableFunctionLocator::visit(Return &ret)
 
 InlineContentInjector::InlineContentInjector():
        source_func(0),
-       remap_names(false),
-       deps_only(false)
+       pass(REFERENCED)
 { }
 
-const string &InlineContentInjector::apply(Stage &stage, FunctionDeclaration &target_func, Block &tgt_blk, const NodeList<Statement>::iterator &ins_pt, FunctionDeclaration &src)
+string InlineContentInjector::apply(Stage &stage, FunctionDeclaration &target_func, Block &tgt_blk, const NodeList<Statement>::iterator &ins_pt, FunctionCall &call)
 {
-       target_block = &tgt_blk;
-       source_func = &src;
-       remap_prefix = source_func->name;
+       source_func = call.declaration->definition;
+
+       /* Populate referenced_names from the target function so we can rename
+       variables from the inlined function that would conflict. */
+       pass = REFERENCED;
+       target_func.visit(*this);
+
+       /* Inline and rename passes must be interleaved so used variable names are
+       known when inlining the return statement. */
+       pass = INLINE;
+       staging_block.parent = &tgt_blk;
+       staging_block.variables.clear();
+
+       std::vector<RefPtr<VariableDeclaration> > params;
+       params.reserve(source_func->parameters.size());
+       for(NodeArray<VariableDeclaration>::iterator i=source_func->parameters.begin(); i!=source_func->parameters.end(); ++i)
+       {
+               RefPtr<VariableDeclaration> var = (*i)->clone();
+               var->interface.clear();
+
+               SetForScope<Pass> set_pass(pass, RENAME);
+               var->visit(*this);
+
+               staging_block.body.push_back_nocopy(var);
+               params.push_back(var);
+       }
 
-       vector<RefPtr<Statement> > inlined;
-       inlined.reserve(src.body.body.size());
-       for(NodeList<Statement>::iterator i=src.body.body.begin(); i!=src.body.body.end(); ++i)
+       for(NodeList<Statement>::iterator i=source_func->body.body.begin(); i!=source_func->body.body.end(); ++i)
        {
                r_inlined_statement = 0;
                (*i)->visit(*this);
                if(!r_inlined_statement)
                        r_inlined_statement = (*i)->clone();
 
-               SetForScope<unsigned> set_remap(remap_names, 2);
+               SetForScope<Pass> set_pass(pass, RENAME);
                r_inlined_statement->visit(*this);
-               inlined.push_back(r_inlined_statement);
-       }
 
-       // Insert the variables here to enable further inlinings to avoid conflicts.
-       tgt_blk.variables.insert(variable_map.begin(), variable_map.end());
+               staging_block.body.push_back_nocopy(r_inlined_statement);
+       }
 
-       SetForScope<unsigned> set_remap(remap_names, 1);
-       SetForScope<string> set_prefix(remap_prefix, target_func.name);
-       variable_map.clear();
+       /* Now collect names from the staging block.  Local variables that would
+       have conflicted with the target function were renamed earlier. */
+       pass = REFERENCED;
+       referenced_names.clear();
+       staging_block.variables.clear();
+       staging_block.visit(*this);
+
+       /* Rename variables in the target function so they don't interfere with
+       global identifiers used by the source function. */
+       pass = RENAME;
+       staging_block.parent = source_func->body.parent;
        target_func.visit(*this);
 
-       tgt_blk.body.insert(ins_pt, inlined.begin(), inlined.end());
+       // Put the argument expressions in place after all renaming has been done.
+       for(unsigned i=0; i<source_func->parameters.size(); ++i)
+               params[i]->init_expression = call.arguments[i]->clone();
 
-       NodeReorderer().apply(stage, target_func, dependencies);
+       tgt_blk.body.splice(ins_pt, staging_block.body);
+
+       NodeReorderer().apply(stage, target_func, DependencyCollector().apply(*source_func));
 
        return r_result_name;
 }
 
 void InlineContentInjector::visit(VariableReference &var)
 {
-       if(remap_names)
+       if(pass==RENAME)
        {
-               map<string, VariableDeclaration *>::const_iterator i = variable_map.find(var.name);
-               if(i!=variable_map.end())
+               map<string, VariableDeclaration *>::const_iterator i = staging_block.variables.find(var.name);
+               if(i!=staging_block.variables.end())
                        var.name = i->second->name;
        }
-       else if(var.declaration)
-       {
-               SetFlag set_deps(deps_only);
-               if(!variable_map.count(var.name))
-               {
-                       dependencies.insert(var.declaration);
-                       referenced_names.insert(var.name);
-               }
-               var.declaration->visit(*this);
-       }
+       else if(pass==REFERENCED)
+               referenced_names.insert(var.name);
 }
 
 void InlineContentInjector::visit(InterfaceBlockReference &iface)
 {
-       if(!remap_names && iface.declaration)
-       {
-               SetFlag set_deps(deps_only);
-               dependencies.insert(iface.declaration);
+       if(pass==REFERENCED)
                referenced_names.insert(iface.name);
-               iface.declaration->visit(*this);
-       }
 }
 
 void InlineContentInjector::visit(FunctionCall &call)
 {
-       if(!remap_names && call.declaration)
-       {
-               dependencies.insert(call.declaration);
+       if(pass==REFERENCED)
                referenced_names.insert(call.name);
-       }
        TraversingVisitor::visit(call);
 }
 
@@ -150,33 +218,34 @@ void InlineContentInjector::visit(VariableDeclaration &var)
 {
        TraversingVisitor::visit(var);
 
-       if(remap_names)
+       if(pass==RENAME)
        {
-               if(remap_names==2 || referenced_names.count(var.name))
+               /* Check against conflicts with the other context as well as variables
+               already renamed here. */
+               bool conflict = (staging_block.variables.count(var.name) || referenced_names.count(var.name));
+               staging_block.variables[var.name] = &var;
+               if(conflict)
                {
-                       string mapped_name = get_unused_variable_name(*target_block, var.name, remap_prefix);
-                       variable_map[var.name] = &var;
-                       var.name = mapped_name;
+                       string mapped_name = get_unused_variable_name(staging_block, var.name);
+                       if(mapped_name!=var.name)
+                       {
+                               staging_block.variables[mapped_name] = &var;
+                               var.name = mapped_name;
+                       }
                }
        }
-       else if(var.type_declaration)
-       {
-               SetFlag set_deps(deps_only);
-               dependencies.insert(var.type_declaration);
-               referenced_names.insert(var.type_declaration->name);
-               var.type_declaration->visit(*this);
-       }
+       else if(pass==REFERENCED)
+               referenced_names.insert(var.type);
 }
 
 void InlineContentInjector::visit(Return &ret)
 {
        TraversingVisitor::visit(ret);
 
-       if(!remap_names && ret.expression)
+       if(pass==INLINE && ret.expression)
        {
-               /* Create a new variable to hold the return value of the inlined
-               function. */
-               r_result_name = get_unused_variable_name(*target_block, "_return", source_func->name);
+               // Create a new variable to hold the return value of the inlined function.
+               r_result_name = get_unused_variable_name(staging_block, "_return");
                RefPtr<VariableDeclaration> var = new VariableDeclaration;
                var->source = ret.source;
                var->line = ret.line;
@@ -190,7 +259,8 @@ void InlineContentInjector::visit(Return &ret)
 
 FunctionInliner::FunctionInliner():
        current_function(0),
-       r_any_inlined(false)
+       r_any_inlined(false),
+       r_inlined_here(false)
 { }
 
 bool FunctionInliner::apply(Stage &s)
@@ -218,7 +288,7 @@ void FunctionInliner::visit(Block &block)
 {
        SetForScope<Block *> set_block(current_block, &block);
        SetForScope<NodeList<Statement>::iterator> save_insert_point(insert_point, block.body.begin());
-       for(NodeList<Statement>::iterator i=block.body.begin(); i!=block.body.end(); ++i)
+       for(NodeList<Statement>::iterator i=block.body.begin(); (!r_inlined_here && i!=block.body.end()); ++i)
        {
                insert_point = i;
                (*i)->visit(*this);
@@ -227,20 +297,23 @@ void FunctionInliner::visit(Block &block)
 
 void FunctionInliner::visit(FunctionCall &call)
 {
-       for(NodeArray<Expression>::iterator i=call.arguments.begin(); i!=call.arguments.end(); ++i)
+       for(NodeArray<Expression>::iterator i=call.arguments.begin(); (!r_inlined_here && i!=call.arguments.end()); ++i)
                visit(*i);
 
+       if(r_inlined_here)
+               return;
+
        FunctionDeclaration *def = call.declaration;
        if(def)
                def = def->definition;
 
        if(def && inlineable.count(def))
        {
-               string result_name = InlineContentInjector().apply(*stage, *current_function, *current_block, insert_point, *def);
+               string result_name = InlineContentInjector().apply(*stage, *current_function, *current_block, insert_point, call);
 
                // This will later get removed by UnusedVariableRemover.
                if(result_name.empty())
-                       result_name = "msp_unused_from_inline";
+                       result_name = "_msp_unused_from_inline";
 
                RefPtr<VariableReference> ref = new VariableReference;
                ref->name = result_name;
@@ -249,6 +322,7 @@ void FunctionInliner::visit(FunctionCall &call)
                /* Inlined variables need to be resolved before this function can be
                inlined further. */
                inlineable.erase(current_function);
+               r_inlined_here = true;
        }
 }
 
@@ -256,6 +330,7 @@ void FunctionInliner::visit(FunctionDeclaration &func)
 {
        SetForScope<FunctionDeclaration *> set_func(current_function, &func);
        TraversingVisitor::visit(func);
+       r_inlined_here = false;
 }
 
 void FunctionInliner::visit(Iteration &iter)
@@ -273,15 +348,6 @@ void FunctionInliner::visit(Iteration &iter)
 }
 
 
-ExpressionInliner::ExpressionInfo::ExpressionInfo():
-       expression(0),
-       assign_scope(0),
-       inline_point(0),
-       trivial(false),
-       available(true)
-{ }
-
-
 ExpressionInliner::ExpressionInliner():
        r_ref_info(0),
        r_any_inlined(false),
@@ -931,10 +997,6 @@ bool UnusedVariableRemover::apply(Stage &s)
                if(i->used_by.empty())
                        unused_nodes.insert(i->node);
 
-       for(map<string, InterfaceBlock *>::const_iterator i=s.interface_blocks.begin(); i!=s.interface_blocks.end(); ++i)
-               if(i->second->instance_name.empty())
-                       unused_nodes.insert(i->second);
-
        for(BlockVariableMap::const_iterator i=variables.begin(); i!=variables.end(); ++i)
        {
                if(i->second.output)
@@ -1073,7 +1135,7 @@ void UnusedVariableRemover::visit(VariableDeclaration &var)
        /* Mark variables as output if they're used by the next stage or the
        graphics API. */
        if(interface_block)
-               var_info.output = (interface_block->interface=="out" && (interface_block->linked_block || !interface_block->name.compare(0, 3, "gl_")));
+               var_info.output = (interface_block->interface=="out" && (interface_block->linked_block || !interface_block->block_name.compare(0, 3, "gl_")));
        else
                var_info.output = (var.interface=="out" && (stage->type==Stage::FRAGMENT || var.linked_declaration || !var.name.compare(0, 3, "gl_")));
 
@@ -1087,16 +1149,8 @@ void UnusedVariableRemover::visit(VariableDeclaration &var)
 
 void UnusedVariableRemover::visit(InterfaceBlock &iface)
 {
-       if(iface.instance_name.empty())
-       {
-               SetForScope<InterfaceBlock *> set_block(interface_block, &iface);
-               iface.struct_declaration->members.visit(*this);
-       }
-       else
-       {
-               VariableInfo &var_info = variables[&iface];
-               var_info.output = (iface.interface=="out" && (iface.linked_block || !iface.name.compare(0, 3, "gl_")));
-       }
+       VariableInfo &var_info = variables[&iface];
+       var_info.output = (iface.interface=="out" && (iface.linked_block || !iface.block_name.compare(0, 3, "gl_")));
 }
 
 void UnusedVariableRemover::merge_variables(const BlockVariableMap &other_vars)