]> git.tdb.fi Git - libs/gl.git/blobdiff - source/glsl/optimize.cpp
Further improve inlining of GLSL functions
[libs/gl.git] / source / glsl / optimize.cpp
index 5813e2d9a2a196a6fe759b730641dea562f6bdfa..d26c6e2d519179ac531dd2a635c85e605d98e9e8 100644 (file)
@@ -8,20 +8,21 @@ namespace GL {
 namespace SL {
 
 InlineableFunctionLocator::InlineableFunctionLocator():
-       in_function(0)
+       current_function(0),
+       return_count(0)
 { }
 
 void InlineableFunctionLocator::visit(FunctionCall &call)
 {
        FunctionDeclaration *def = call.declaration;
-       if(def && def->definition!=def)
+       if(def)
                def = def->definition;
 
        if(def)
        {
                unsigned &count = refcounts[def];
                ++count;
-               if(count>1 || def==in_function)
+               if(count>1 || def==current_function)
                        inlineable.erase(def);
        }
 
@@ -31,37 +32,177 @@ void InlineableFunctionLocator::visit(FunctionCall &call)
 void InlineableFunctionLocator::visit(FunctionDeclaration &func)
 {
        unsigned &count = refcounts[func.definition];
-       if(!count && func.parameters.empty())
+       if(count<=1 && func.parameters.empty())
                inlineable.insert(func.definition);
 
-       SetForScope<FunctionDeclaration *> set(in_function, &func);
+       SetForScope<FunctionDeclaration *> set(current_function, &func);
+       return_count = 0;
        TraversingVisitor::visit(func);
 }
 
+void InlineableFunctionLocator::visit(Conditional &)
+{
+       inlineable.erase(current_function);
+}
+
+void InlineableFunctionLocator::visit(Iteration &)
+{
+       inlineable.erase(current_function);
+}
+
+void InlineableFunctionLocator::visit(Return &)
+{
+       if(return_count)
+               inlineable.erase(current_function);
+       ++return_count;
+}
 
-FunctionInliner::FunctionInliner(const set<FunctionDeclaration *> &in):
-       inlineable(in),
-       extract_result(0)
+
+InlineContentInjector::InlineContentInjector():
+       source_func(0),
+       remap_names(false),
+       deps_only(false)
 { }
 
+const string &InlineContentInjector::apply(Stage &stage, FunctionDeclaration &target_func, Block &tgtb, const NodeList<Statement>::iterator &ins_pt, FunctionDeclaration &src)
+{
+       target_block = &tgtb;
+       source_func = &src;
+       for(NodeList<Statement>::iterator i=src.body.body.begin(); i!=src.body.body.end(); ++i)
+       {
+               inlined_statement = 0;
+               (*i)->visit(*this);
+               if(!inlined_statement)
+                       inlined_statement = (*i)->clone();
+
+               SetFlag set_remap(remap_names);
+               inlined_statement->visit(*this);
+               tgtb.body.insert(ins_pt, inlined_statement);
+       }
+
+       NodeReorderer().apply(stage, target_func, dependencies);
+
+       return result_name;
+}
+
+string InlineContentInjector::create_unused_name(const string &base, bool always_prefix)
+{
+       string result = base;
+       if(always_prefix || target_block->variables.count(result))
+               result = format("_%s_%s", source_func->name, base);
+       unsigned initial_size = result.size();
+       for(unsigned i=1; target_block->variables.count(result); ++i)
+       {
+               result.erase(initial_size);
+               result += format("_%d", i);
+       }
+       return result;
+}
+
+void InlineContentInjector::visit(VariableReference &var)
+{
+       if(remap_names)
+       {
+               map<string, VariableDeclaration *>::const_iterator i = variable_map.find(var.name);
+               if(i!=variable_map.end())
+                       var.name = i->second->name;
+       }
+       else if(var.declaration)
+       {
+               SetFlag set_deps(deps_only);
+               dependencies.insert(var.declaration);
+               var.declaration->visit(*this);
+       }
+}
+
+void InlineContentInjector::visit(InterfaceBlockReference &iface)
+{
+       if(!remap_names && iface.declaration)
+       {
+               SetFlag set_deps(deps_only);
+               dependencies.insert(iface.declaration);
+               iface.declaration->visit(*this);
+       }
+}
+
+void InlineContentInjector::visit(FunctionCall &call)
+{
+       if(!remap_names && call.declaration)
+               dependencies.insert(call.declaration);
+       TraversingVisitor::visit(call);
+}
+
+void InlineContentInjector::visit(VariableDeclaration &var)
+{
+       TraversingVisitor::visit(var);
+
+       if(var.type_declaration)
+       {
+               SetFlag set_deps(deps_only);
+               dependencies.insert(var.type_declaration);
+               var.type_declaration->visit(*this);
+       }
+
+       if(!remap_names && !deps_only)
+       {
+               RefPtr<VariableDeclaration> inlined_var = var.clone();
+               inlined_var->name = create_unused_name(var.name, false);
+               inlined_statement = inlined_var;
+
+               variable_map[var.name] = inlined_var.get();
+       }
+}
+
+void InlineContentInjector::visit(Return &ret)
+{
+       TraversingVisitor::visit(ret);
+
+       if(ret.expression)
+       {
+               result_name = create_unused_name("return", true);
+               RefPtr<VariableDeclaration> var = new VariableDeclaration;
+               var->source = ret.source;
+               var->line = ret.line;
+               var->type = source_func->return_type;
+               var->name = result_name;
+               var->init_expression = ret.expression->clone();
+               inlined_statement = var;
+       }
+}
+
+
+FunctionInliner::FunctionInliner():
+       current_function(0),
+       any_inlined(false)
+{ }
+
+bool FunctionInliner::apply(Stage &s)
+{
+       stage = &s;
+       inlineable = InlineableFunctionLocator().apply(s);
+       any_inlined = false;
+       s.content.visit(*this);
+       return any_inlined;
+}
+
 void FunctionInliner::visit_and_inline(RefPtr<Expression> &ptr)
 {
        inline_result = 0;
        ptr->visit(*this);
        if(inline_result)
+       {
                ptr = inline_result;
+               any_inlined = true;
+       }
 }
 
 void FunctionInliner::visit(Block &block)
 {
-       if(extract_result)
-               --extract_result;
-
+       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)
        {
+               insert_point = i;
                (*i)->visit(*this);
-               if(extract_result)
-                       --extract_result;
        }
 }
 
@@ -90,18 +231,34 @@ void FunctionInliner::visit(FunctionCall &call)
                visit_and_inline(*i);
 
        FunctionDeclaration *def = call.declaration;
-       if(def && def->definition!=def)
+       if(def)
                def = def->definition;
 
        if(def && inlineable.count(def))
        {
-               extract_result = 2;
-               def->visit(*this);
+               string result_name = InlineContentInjector().apply(*stage, *current_function, *current_block, insert_point, *def);
+
+               // This will later get removed by UnusedVariableRemover
+               if(result_name.empty())
+                       result_name = "msp_unused_from_inline";
+
+               RefPtr<VariableReference> ref = new VariableReference;
+               ref->name = result_name;
+               inline_result = ref;
+
+               /* Inlined variables need to be resolved before this function can be
+               inlined further. */
+               inlineable.erase(current_function);
        }
        else
                inline_result = 0;
 }
 
+void FunctionInliner::visit(ExpressionStatement &expr)
+{
+       visit_and_inline(expr.expression);
+}
+
 void FunctionInliner::visit(VariableDeclaration &var)
 {
        if(var.init_expression)
@@ -109,24 +266,37 @@ void FunctionInliner::visit(VariableDeclaration &var)
        inline_result = 0;
 }
 
-void FunctionInliner::visit(Return &ret)
+void FunctionInliner::visit(FunctionDeclaration &func)
 {
-       TraversingVisitor::visit(ret);
+       SetForScope<FunctionDeclaration *> set_func(current_function, &func);
+       TraversingVisitor::visit(func);
+}
 
-       if(extract_result)
-               inline_result = ret.expression->clone();
+void FunctionInliner::visit(Return &ret)
+{
+       if(ret.expression)
+               visit_and_inline(ret.expression);
 }
 
 
 ConstantConditionEliminator::ConstantConditionEliminator():
-       scope_level(0),
        record_only(false)
 { }
 
+void ConstantConditionEliminator::apply(Stage &stage)
+{
+       stage.content.visit(*this);
+       NodeRemover().apply(stage, nodes_to_remove);
+}
+
 void ConstantConditionEliminator::visit(Block &block)
 {
-       SetForScope<unsigned> set(scope_level, scope_level+1);
-       BlockModifier::visit(block);
+       SetForScope<Block *> set_block(current_block, &block);
+       for(NodeList<Statement>::iterator i=block.body.begin(); i!=block.body.end(); ++i)
+       {
+               insert_point = i;
+               (*i)->visit(*this);
+       }
 
        for(map<string, VariableDeclaration *>::const_iterator i=block.variables.begin(); i!=block.variables.end(); ++i)
                variable_values.erase(i->second);
@@ -146,7 +316,13 @@ void ConstantConditionEliminator::visit(Assignment &assign)
 
 void ConstantConditionEliminator::visit(VariableDeclaration &var)
 {
-       if(var.constant || scope_level>1)
+       bool constant = var.constant;
+       if(constant && var.layout)
+       {
+               for(vector<Layout::Qualifier>::const_iterator i=var.layout->qualifiers.begin(); (constant && i!=var.layout->qualifiers.end()); ++i)
+                       constant = (i->name!="constant_id");
+       }
+       if((constant || current_block->parent) && var.init_expression)
                variable_values[&var] = var.init_expression.get();
 }
 
@@ -158,7 +334,9 @@ void ConstantConditionEliminator::visit(Conditional &cond)
                cond.condition->visit(eval);
                if(eval.is_result_valid())
                {
-                       flatten_block(eval.get_result() ? cond.body : cond.else_body);
+                       Block &block = (eval.get_result() ? cond.body : cond.else_body);
+                       current_block->body.splice(insert_point, block.body);
+                       nodes_to_remove.insert(&cond);
                        return;
                }
        }
@@ -180,7 +358,7 @@ void ConstantConditionEliminator::visit(Iteration &iter)
                        iter.condition->visit(eval);
                        if(eval.is_result_valid() && !eval.get_result())
                        {
-                               remove_node = true;
+                               nodes_to_remove.insert(&iter);
                                return;
                        }
                }
@@ -198,29 +376,29 @@ void ConstantConditionEliminator::visit(Iteration &iter)
 }
 
 
-UnusedVariableLocator::VariableInfo::VariableInfo():
+UnusedVariableRemover::VariableInfo::VariableInfo():
        local(false),
        conditionally_assigned(false),
        referenced(false)
 { }
 
 
-UnusedVariableLocator::UnusedVariableLocator():
+UnusedVariableRemover::UnusedVariableRemover():
        aggregate(0),
        assignment(0),
        assignment_target(false),
        assign_to_subscript(false),
-       global_scope(true)
+       side_effects(false)
 { }
 
-const set<Node *> &UnusedVariableLocator::apply(Stage &s)
+bool UnusedVariableRemover::apply(Stage &stage)
 {
        variables.push_back(BlockVariableMap());
-       visit(s.content);
+       stage.content.visit(*this);
        BlockVariableMap &global_variables = variables.back();
        for(BlockVariableMap::iterator i=global_variables.begin(); i!=global_variables.end(); ++i)
        {
-               if(i->first->interface=="out" && (s.type==Stage::FRAGMENT || i->first->linked_declaration || !i->first->name.compare(0, 3, "gl_")))
+               if(i->first->interface=="out" && (stage.type==Stage::FRAGMENT || i->first->linked_declaration || !i->first->name.compare(0, 3, "gl_")))
                        continue;
                if(!i->second.referenced)
                {
@@ -230,10 +408,12 @@ const set<Node *> &UnusedVariableLocator::apply(Stage &s)
        }
        variables.pop_back();
 
-       return unused_nodes;
+       NodeRemover().apply(stage, unused_nodes);
+
+       return !unused_nodes.empty();
 }
 
-void UnusedVariableLocator::visit(VariableReference &var)
+void UnusedVariableRemover::visit(VariableReference &var)
 {
        map<VariableDeclaration *, Node *>::iterator i = aggregates.find(var.declaration);
        if(i!=aggregates.end())
@@ -242,18 +422,30 @@ void UnusedVariableLocator::visit(VariableReference &var)
        if(var.declaration && !assignment_target)
        {
                VariableInfo &var_info = variables.back()[var.declaration];
-               var_info.assignments.clear();
+               clear_assignments(var_info, false);
                var_info.referenced = true;
        }
 }
 
-void UnusedVariableLocator::visit(MemberAccess &memacc)
+void UnusedVariableRemover::visit(InterfaceBlockReference &iface)
+{
+       unused_nodes.erase(iface.declaration);
+}
+
+void UnusedVariableRemover::visit(MemberAccess &memacc)
 {
        TraversingVisitor::visit(memacc);
        unused_nodes.erase(memacc.declaration);
 }
 
-void UnusedVariableLocator::visit(BinaryExpression &binary)
+void UnusedVariableRemover::visit(UnaryExpression &unary)
+{
+       TraversingVisitor::visit(unary);
+       if(unary.oper=="++" || unary.oper=="--")
+               side_effects = true;
+}
+
+void UnusedVariableRemover::visit(BinaryExpression &binary)
 {
        if(binary.oper=="[")
        {
@@ -267,7 +459,7 @@ void UnusedVariableLocator::visit(BinaryExpression &binary)
                TraversingVisitor::visit(binary);
 }
 
-void UnusedVariableLocator::visit(Assignment &assign)
+void UnusedVariableRemover::visit(Assignment &assign)
 {
        {
                assign_to_subscript = false;
@@ -276,9 +468,16 @@ void UnusedVariableLocator::visit(Assignment &assign)
        }
        assign.right->visit(*this);
        assignment = &assign;
+       side_effects = true;
 }
 
-void UnusedVariableLocator::record_assignment(VariableDeclaration &var, Node &node, bool chained)
+void UnusedVariableRemover::visit(FunctionCall &call)
+{
+       TraversingVisitor::visit(call);
+       side_effects = true;
+}
+
+void UnusedVariableRemover::record_assignment(VariableDeclaration &var, Node &node, bool chained)
 {
        VariableInfo &var_info = variables.back()[&var];
        if(!chained)
@@ -287,7 +486,7 @@ void UnusedVariableLocator::record_assignment(VariableDeclaration &var, Node &no
        var_info.conditionally_assigned = false;
 }
 
-void UnusedVariableLocator::clear_assignments(VariableInfo &var_info, bool mark_unused)
+void UnusedVariableRemover::clear_assignments(VariableInfo &var_info, bool mark_unused)
 {
        if(mark_unused)
        {
@@ -297,22 +496,25 @@ void UnusedVariableLocator::clear_assignments(VariableInfo &var_info, bool mark_
        var_info.assignments.clear();
 }
 
-void UnusedVariableLocator::visit(ExpressionStatement &expr)
+void UnusedVariableRemover::visit(ExpressionStatement &expr)
 {
        assignment = 0;
+       side_effects = false;
        TraversingVisitor::visit(expr);
        if(assignment && assignment->target_declaration)
                record_assignment(*assignment->target_declaration, expr, (assignment->self_referencing || assign_to_subscript));
+       if(!side_effects)
+               unused_nodes.insert(&expr);
 }
 
-void UnusedVariableLocator::visit(StructDeclaration &strct)
+void UnusedVariableRemover::visit(StructDeclaration &strct)
 {
        SetForScope<Node *> set(aggregate, &strct);
        unused_nodes.insert(&strct);
        TraversingVisitor::visit(strct);
 }
 
-void UnusedVariableLocator::visit(VariableDeclaration &var)
+void UnusedVariableRemover::visit(VariableDeclaration &var)
 {
        if(aggregate)
                aggregates[&var] = aggregate;
@@ -326,23 +528,20 @@ void UnusedVariableLocator::visit(VariableDeclaration &var)
        TraversingVisitor::visit(var);
 }
 
-void UnusedVariableLocator::visit(InterfaceBlock &iface)
+void UnusedVariableRemover::visit(InterfaceBlock &iface)
 {
        SetForScope<Node *> set(aggregate, &iface);
        unused_nodes.insert(&iface);
        TraversingVisitor::visit(iface);
 }
 
-void UnusedVariableLocator::visit(FunctionDeclaration &func)
+void UnusedVariableRemover::visit(FunctionDeclaration &func)
 {
        variables.push_back(BlockVariableMap());
 
-       {
-               SetForScope<bool> set(global_scope, false);
-               for(NodeArray<VariableDeclaration>::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
-                       (*i)->visit(*this);
-               func.body.visit(*this);
-       }
+       for(NodeArray<VariableDeclaration>::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
+               (*i)->visit(*this);
+       func.body.visit(*this);
 
        BlockVariableMap &block_variables = variables.back();
        for(BlockVariableMap::iterator i=block_variables.begin(); i!=block_variables.end(); ++i)
@@ -352,7 +551,7 @@ void UnusedVariableLocator::visit(FunctionDeclaration &func)
        merge_down_variables();
 }
 
-void UnusedVariableLocator::merge_down_variables()
+void UnusedVariableRemover::merge_down_variables()
 {
        BlockVariableMap &parent_variables = variables[variables.size()-2];
        BlockVariableMap &block_variables = variables.back();
@@ -381,7 +580,7 @@ void UnusedVariableLocator::merge_down_variables()
        variables.pop_back();
 }
 
-void UnusedVariableLocator::visit(Conditional &cond)
+void UnusedVariableRemover::visit(Conditional &cond)
 {
        cond.condition->visit(*this);
        variables.push_back(BlockVariableMap());
@@ -414,7 +613,7 @@ void UnusedVariableLocator::visit(Conditional &cond)
        merge_down_variables();
 }
 
-void UnusedVariableLocator::visit(Iteration &iter)
+void UnusedVariableRemover::visit(Iteration &iter)
 {
        variables.push_back(BlockVariableMap());
        TraversingVisitor::visit(iter);
@@ -422,13 +621,20 @@ void UnusedVariableLocator::visit(Iteration &iter)
        BlockVariableMap &block_variables = variables.back();
        for(BlockVariableMap::iterator i=block_variables.begin(); i!=block_variables.end(); ++i)
                if(!i->second.local && i->second.referenced)
-                       i->second.assignments.clear();
+                       clear_assignments(i->second, false);
 
        merge_down_variables();
 }
 
 
-void UnusedFunctionLocator::visit(FunctionCall &call)
+bool UnusedFunctionRemover::apply(Stage &stage)
+{
+       stage.content.visit(*this);
+       NodeRemover().apply(stage, unused_nodes);
+       return !unused_nodes.empty();
+}
+
+void UnusedFunctionRemover::visit(FunctionCall &call)
 {
        TraversingVisitor::visit(call);
 
@@ -437,7 +643,7 @@ void UnusedFunctionLocator::visit(FunctionCall &call)
                used_definitions.insert(call.declaration->definition);
 }
 
-void UnusedFunctionLocator::visit(FunctionDeclaration &func)
+void UnusedFunctionRemover::visit(FunctionDeclaration &func)
 {
        TraversingVisitor::visit(func);