]> git.tdb.fi Git - libs/gl.git/blobdiff - source/glsl/optimize.cpp
Add some comments to the more complex parts of the GLSL compiler
[libs/gl.git] / source / glsl / optimize.cpp
index d26c6e2d519179ac531dd2a635c85e605d98e9e8..a7786295f6e8c117e94f345c66ba615873d79e96 100644 (file)
@@ -1,4 +1,5 @@
 #include <msp/core/raii.h>
+#include <msp/strings/format.h>
 #include "optimize.h"
 
 using namespace std;
@@ -22,6 +23,8 @@ void InlineableFunctionLocator::visit(FunctionCall &call)
        {
                unsigned &count = refcounts[def];
                ++count;
+               /* Don't inline functions which are called more than once or are called
+               recursively. */
                if(count>1 || def==current_function)
                        inlineable.erase(def);
        }
@@ -40,18 +43,21 @@ void InlineableFunctionLocator::visit(FunctionDeclaration &func)
        TraversingVisitor::visit(func);
 }
 
-void InlineableFunctionLocator::visit(Conditional &)
+void InlineableFunctionLocator::visit(Conditional &cond)
 {
+       TraversingVisitor::visit(cond);
        inlineable.erase(current_function);
 }
 
-void InlineableFunctionLocator::visit(Iteration &)
+void InlineableFunctionLocator::visit(Iteration &iter)
 {
+       TraversingVisitor::visit(iter);
        inlineable.erase(current_function);
 }
 
-void InlineableFunctionLocator::visit(Return &)
+void InlineableFunctionLocator::visit(Return &ret)
 {
+       TraversingVisitor::visit(ret);
        if(return_count)
                inlineable.erase(current_function);
        ++return_count;
@@ -64,25 +70,25 @@ InlineContentInjector::InlineContentInjector():
        deps_only(false)
 { }
 
-const string &InlineContentInjector::apply(Stage &stage, FunctionDeclaration &target_func, Block &tgtb, const NodeList<Statement>::iterator &ins_pt, FunctionDeclaration &src)
+const string &InlineContentInjector::apply(Stage &stage, FunctionDeclaration &target_func, Block &tgt_blk, const NodeList<Statement>::iterator &ins_pt, FunctionDeclaration &src)
 {
-       target_block = &tgtb;
+       target_block = &tgt_blk;
        source_func = &src;
        for(NodeList<Statement>::iterator i=src.body.body.begin(); i!=src.body.body.end(); ++i)
        {
-               inlined_statement = 0;
+               r_inlined_statement = 0;
                (*i)->visit(*this);
-               if(!inlined_statement)
-                       inlined_statement = (*i)->clone();
+               if(!r_inlined_statement)
+                       r_inlined_statement = (*i)->clone();
 
                SetFlag set_remap(remap_names);
-               inlined_statement->visit(*this);
-               tgtb.body.insert(ins_pt, inlined_statement);
+               r_inlined_statement->visit(*this);
+               tgt_blk.body.insert(ins_pt, r_inlined_statement);
        }
 
        NodeReorderer().apply(stage, target_func, dependencies);
 
-       return result_name;
+       return r_result_name;
 }
 
 string InlineContentInjector::create_unused_name(const string &base, bool always_prefix)
@@ -147,7 +153,7 @@ void InlineContentInjector::visit(VariableDeclaration &var)
        {
                RefPtr<VariableDeclaration> inlined_var = var.clone();
                inlined_var->name = create_unused_name(var.name, false);
-               inlined_statement = inlined_var;
+               r_inlined_statement = inlined_var;
 
                variable_map[var.name] = inlined_var.get();
        }
@@ -159,45 +165,48 @@ void InlineContentInjector::visit(Return &ret)
 
        if(ret.expression)
        {
-               result_name = create_unused_name("return", true);
+               /* Create a new variable to hold the return value of the inlined
+               function. */
+               r_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->name = r_result_name;
                var->init_expression = ret.expression->clone();
-               inlined_statement = var;
+               r_inlined_statement = var;
        }
 }
 
 
 FunctionInliner::FunctionInliner():
        current_function(0),
-       any_inlined(false)
+       r_any_inlined(false)
 { }
 
 bool FunctionInliner::apply(Stage &s)
 {
        stage = &s;
        inlineable = InlineableFunctionLocator().apply(s);
-       any_inlined = false;
+       r_any_inlined = false;
        s.content.visit(*this);
-       return any_inlined;
+       return r_any_inlined;
 }
 
 void FunctionInliner::visit_and_inline(RefPtr<Expression> &ptr)
 {
-       inline_result = 0;
+       r_inline_result = 0;
        ptr->visit(*this);
-       if(inline_result)
+       if(r_inline_result)
        {
-               ptr = inline_result;
-               any_inlined = true;
+               ptr = r_inline_result;
+               r_any_inlined = true;
        }
 }
 
 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)
        {
@@ -209,20 +218,20 @@ void FunctionInliner::visit(Block &block)
 void FunctionInliner::visit(UnaryExpression &unary)
 {
        visit_and_inline(unary.expression);
-       inline_result = 0;
+       r_inline_result = 0;
 }
 
 void FunctionInliner::visit(BinaryExpression &binary)
 {
        visit_and_inline(binary.left);
        visit_and_inline(binary.right);
-       inline_result = 0;
+       r_inline_result = 0;
 }
 
 void FunctionInliner::visit(MemberAccess &memacc)
 {
        visit_and_inline(memacc.left);
-       inline_result = 0;
+       r_inline_result = 0;
 }
 
 void FunctionInliner::visit(FunctionCall &call)
@@ -238,20 +247,20 @@ void FunctionInliner::visit(FunctionCall &call)
        {
                string result_name = InlineContentInjector().apply(*stage, *current_function, *current_block, insert_point, *def);
 
-               // This will later get removed by UnusedVariableRemover
+               // 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;
+               r_inline_result = ref;
 
                /* Inlined variables need to be resolved before this function can be
                inlined further. */
                inlineable.erase(current_function);
        }
        else
-               inline_result = 0;
+               r_inline_result = 0;
 }
 
 void FunctionInliner::visit(ExpressionStatement &expr)
@@ -263,7 +272,7 @@ void FunctionInliner::visit(VariableDeclaration &var)
 {
        if(var.init_expression)
                visit_and_inline(var.init_expression);
-       inline_result = 0;
+       r_inline_result = 0;
 }
 
 void FunctionInliner::visit(FunctionDeclaration &func)
@@ -272,6 +281,22 @@ void FunctionInliner::visit(FunctionDeclaration &func)
        TraversingVisitor::visit(func);
 }
 
+void FunctionInliner::visit(Conditional &cond)
+{
+       visit_and_inline(cond.condition);
+       cond.body.visit(*this);
+}
+
+void FunctionInliner::visit(Iteration &iter)
+{
+       SetForScope<Block *> set_block(current_block, &iter.body);
+       if(iter.init_statement)
+               iter.init_statement->visit(*this);
+       /* Skip the condition and loop expression parts because they're executed on
+       every iteration of the loop */
+       iter.body.visit(*this);
+}
+
 void FunctionInliner::visit(Return &ret)
 {
        if(ret.expression)
@@ -305,7 +330,7 @@ void ConstantConditionEliminator::visit(Block &block)
 void ConstantConditionEliminator::visit(UnaryExpression &unary)
 {
        if(VariableReference *var = dynamic_cast<VariableReference *>(unary.expression.get()))
-               if(unary.oper=="++" || unary.oper=="--")
+               if(unary.oper->token[1]=='+' || unary.oper->token[1]=='-')
                        variable_values.erase(var->declaration);
 }
 
@@ -385,10 +410,10 @@ UnusedVariableRemover::VariableInfo::VariableInfo():
 
 UnusedVariableRemover::UnusedVariableRemover():
        aggregate(0),
-       assignment(0),
+       r_assignment(0),
        assignment_target(false),
-       assign_to_subscript(false),
-       side_effects(false)
+       r_assign_to_subfield(false),
+       r_side_effects(false)
 { }
 
 bool UnusedVariableRemover::apply(Stage &stage)
@@ -398,8 +423,12 @@ bool UnusedVariableRemover::apply(Stage &stage)
        BlockVariableMap &global_variables = variables.back();
        for(BlockVariableMap::iterator i=global_variables.begin(); i!=global_variables.end(); ++i)
        {
+               /* Don't remove output variables which are used by the next stage or the
+               graphics API. */
                if(i->first->interface=="out" && (stage.type==Stage::FRAGMENT || i->first->linked_declaration || !i->first->name.compare(0, 3, "gl_")))
                        continue;
+
+               // Mark other unreferenced global variables as unused.
                if(!i->second.referenced)
                {
                        unused_nodes.insert(i->first);
@@ -422,6 +451,7 @@ void UnusedVariableRemover::visit(VariableReference &var)
        if(var.declaration && !assignment_target)
        {
                VariableInfo &var_info = variables.back()[var.declaration];
+               // Previous assignments are used by this reference.
                clear_assignments(var_info, false);
                var_info.referenced = true;
        }
@@ -434,6 +464,7 @@ void UnusedVariableRemover::visit(InterfaceBlockReference &iface)
 
 void UnusedVariableRemover::visit(MemberAccess &memacc)
 {
+       r_assign_to_subfield = true;
        TraversingVisitor::visit(memacc);
        unused_nodes.erase(memacc.declaration);
 }
@@ -441,18 +472,18 @@ void UnusedVariableRemover::visit(MemberAccess &memacc)
 void UnusedVariableRemover::visit(UnaryExpression &unary)
 {
        TraversingVisitor::visit(unary);
-       if(unary.oper=="++" || unary.oper=="--")
-               side_effects = true;
+       if(unary.oper->token[1]=='+' || unary.oper->token[1]=='-')
+               r_side_effects = true;
 }
 
 void UnusedVariableRemover::visit(BinaryExpression &binary)
 {
-       if(binary.oper=="[")
+       if(binary.oper->token[0]=='[')
        {
                if(assignment_target)
-                       assign_to_subscript = true;
+                       r_assign_to_subfield = true;
                binary.left->visit(*this);
-               SetForScope<bool> set(assignment_target, false);
+               SetFlag set(assignment_target, false);
                binary.right->visit(*this);
        }
        else
@@ -462,24 +493,27 @@ void UnusedVariableRemover::visit(BinaryExpression &binary)
 void UnusedVariableRemover::visit(Assignment &assign)
 {
        {
-               assign_to_subscript = false;
-               SetForScope<bool> set(assignment_target, !assign.self_referencing);
+               SetFlag set(assignment_target, !assign.self_referencing);
                assign.left->visit(*this);
        }
        assign.right->visit(*this);
-       assignment = &assign;
-       side_effects = true;
+       r_assignment = &assign;
+       r_side_effects = true;
 }
 
 void UnusedVariableRemover::visit(FunctionCall &call)
 {
        TraversingVisitor::visit(call);
-       side_effects = true;
+       /* Treat function calls as having side effects so expression statements
+       consisting of nothing but a function call won't be optimized away. */
+       r_side_effects = true;
 }
 
 void UnusedVariableRemover::record_assignment(VariableDeclaration &var, Node &node, bool chained)
 {
        VariableInfo &var_info = variables.back()[&var];
+       /* An assignment which completely replaces the value of the variable causes
+       any previous unreferenced assignments to be unused. */
        if(!chained)
                clear_assignments(var_info, true);
        var_info.assignments.push_back(&node);
@@ -498,12 +532,13 @@ void UnusedVariableRemover::clear_assignments(VariableInfo &var_info, bool mark_
 
 void UnusedVariableRemover::visit(ExpressionStatement &expr)
 {
-       assignment = 0;
-       side_effects = false;
+       r_assignment = 0;
+       r_assign_to_subfield = false;
+       r_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)
+       if(r_assignment && r_assignment->target_declaration)
+               record_assignment(*r_assignment->target_declaration, expr, (r_assignment->self_referencing || r_assign_to_subfield));
+       if(!r_side_effects)
                unused_nodes.insert(&expr);
 }
 
@@ -544,10 +579,18 @@ void UnusedVariableRemover::visit(FunctionDeclaration &func)
        func.body.visit(*this);
 
        BlockVariableMap &block_variables = variables.back();
+
+       /* Mark global variables as conditionally assigned so assignments in other
+       functions won't be removed. */
        for(BlockVariableMap::iterator i=block_variables.begin(); i!=block_variables.end(); ++i)
-               i->second.conditionally_assigned = true;
+               if(!i->second.local)
+                       i->second.conditionally_assigned = true;
+
+       /* Always treat function parameters as referenced.  Removing unused
+       parameters is not currently supported. */
        for(NodeArray<VariableDeclaration>::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
                block_variables[i->get()].referenced = true;
+
        merge_down_variables();
 }
 
@@ -561,7 +604,9 @@ void UnusedVariableRemover::merge_down_variables()
                {
                        if(!i->second.referenced)
                                unused_nodes.insert(i->first);
-                       clear_assignments(i->second, i->first->interface!="out");
+                       /* Any unreferenced assignments when a variable runs out of scope
+                       become unused. */
+                       clear_assignments(i->second, true);
                        continue;
                }
 
@@ -570,6 +615,7 @@ void UnusedVariableRemover::merge_down_variables()
                        parent_variables.insert(*i);
                else
                {
+                       // Merge a non-local variable's state into the parent scope.
                        if(i->second.referenced || !i->second.conditionally_assigned)
                                clear_assignments(j->second, !i->second.referenced);
                        j->second.conditionally_assigned = i->second.conditionally_assigned;
@@ -590,20 +636,25 @@ void UnusedVariableRemover::visit(Conditional &cond)
        swap(variables.back(), if_variables);
        cond.else_body.visit(*this);
 
+       // Combine variables from both branches.
        BlockVariableMap &else_variables = variables.back();
        for(BlockVariableMap::iterator i=else_variables.begin(); i!=else_variables.end(); ++i)
        {
                BlockVariableMap::iterator j = if_variables.find(i->first);
                if(j!=if_variables.end())
                {
+                       // The variable was found in both branches.
                        i->second.assignments.insert(i->second.assignments.end(), j->second.assignments.begin(), j->second.assignments.end());
                        i->second.conditionally_assigned |= j->second.conditionally_assigned;
                        if_variables.erase(j);
                }
                else
+                       // Mark variables found in only one branch as conditionally assigned.
                        i->second.conditionally_assigned = true;
        }
 
+       /* Move variables which were only used in the if block into the combined
+       block. */
        for(BlockVariableMap::iterator i=if_variables.begin(); i!=if_variables.end(); ++i)
        {
                i->second.conditionally_assigned = true;
@@ -617,12 +668,6 @@ void UnusedVariableRemover::visit(Iteration &iter)
 {
        variables.push_back(BlockVariableMap());
        TraversingVisitor::visit(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)
-                       clear_assignments(i->second, false);
-
        merge_down_variables();
 }