]> git.tdb.fi Git - libs/gl.git/blobdiff - source/glsl/optimize.cpp
Fix function inlining regressions
[libs/gl.git] / source / glsl / optimize.cpp
index 2a9bfb17273aa743c7dd7af8608065f7b66058a0..7b3f8f28c8ad00007b520446ed5c2cc1180c49d0 100644 (file)
@@ -34,8 +34,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,39 +70,73 @@ void InlineableFunctionLocator::visit(Return &ret)
 
 InlineContentInjector::InlineContentInjector():
        source_func(0),
-       remap_names(false),
-       deps_only(false)
+       pass(DEPENDS)
 { }
 
-const string &InlineContentInjector::apply(Stage &stage, FunctionDeclaration &target_func, Block &tgt_blk, 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, FunctionCall &call)
 {
-       target_block = &tgt_blk;
-       source_func = &src;
-       remap_prefix = source_func->name;
+       source_func = call.declaration->definition;
+
+       // Collect all declarations the inlined function depends on.
+       pass = DEPENDS;
+       source_func->visit(*this);
+
+       /* 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();
 
-       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)
+       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);
+       }
+
+       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();
+
+       tgt_blk.body.splice(ins_pt, staging_block.body);
 
        NodeReorderer().apply(stage, target_func, dependencies);
 
@@ -107,42 +145,38 @@ const string &InlineContentInjector::apply(Stage &stage, FunctionDeclaration &ta
 
 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)
+       else if(pass==DEPENDS && var.declaration)
        {
-               SetFlag set_deps(deps_only);
-               if(!variable_map.count(var.name))
-               {
-                       dependencies.insert(var.declaration);
-                       referenced_names.insert(var.name);
-               }
+               dependencies.insert(var.declaration);
                var.declaration->visit(*this);
        }
+       else if(pass==REFERENCED)
+               referenced_names.insert(var.name);
 }
 
 void InlineContentInjector::visit(InterfaceBlockReference &iface)
 {
-       if(!remap_names && iface.declaration)
+       if(pass==DEPENDS && iface.declaration)
        {
-               SetFlag set_deps(deps_only);
                dependencies.insert(iface.declaration);
-               referenced_names.insert(iface.name);
                iface.declaration->visit(*this);
        }
+       else if(pass==REFERENCED)
+               referenced_names.insert(iface.name);
 }
 
 void InlineContentInjector::visit(FunctionCall &call)
 {
-       if(!remap_names && call.declaration)
-       {
+       if(pass==DEPENDS && call.declaration)
                dependencies.insert(call.declaration);
+       else if(pass==REFERENCED)
                referenced_names.insert(call.name);
-       }
        TraversingVisitor::visit(call);
 }
 
@@ -150,33 +184,39 @@ 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)
+       else if(pass==DEPENDS && 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 +230,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 +259,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 +268,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 +293,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 +301,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)
@@ -487,12 +533,301 @@ void ExpressionInliner::visit(Iteration &iter)
 }
 
 
+BasicTypeDeclaration::Kind ConstantFolder::get_value_kind(const Variant &value)
+{
+       if(value.check_type<bool>())
+               return BasicTypeDeclaration::BOOL;
+       else if(value.check_type<int>())
+               return BasicTypeDeclaration::INT;
+       else if(value.check_type<float>())
+               return BasicTypeDeclaration::FLOAT;
+       else
+               return BasicTypeDeclaration::VOID;
+}
+
+template<typename T>
+T ConstantFolder::evaluate_logical(char oper, T left, T right)
+{
+       switch(oper)
+       {
+       case '&': return left&right;
+       case '|': return left|right;
+       case '^': return left^right;
+       default: return T();
+       }
+}
+
+template<typename T>
+bool ConstantFolder::evaluate_relation(const char *oper, T left, T right)
+{
+       switch(oper[0]|oper[1])
+       {
+       case '<': return left<right;
+       case '<'|'=': return left<=right;
+       case '>': return left>right;
+       case '>'|'=': return left>=right;
+       default: return false;
+       }
+}
+
+template<typename T>
+T ConstantFolder::evaluate_arithmetic(char oper, T left, T right)
+{
+       switch(oper)
+       {
+       case '+': return left+right;
+       case '-': return left-right;
+       case '*': return left*right;
+       case '/': return left/right;
+       default: return T();
+       }
+}
+
+void ConstantFolder::set_result(const Variant &value, bool literal)
+{
+       r_constant_value = value;
+       r_constant = true;
+       r_literal = literal;
+}
+
+void ConstantFolder::visit(RefPtr<Expression> &expr)
+{
+       r_constant_value = Variant();
+       r_constant = false;
+       r_literal = false;
+       r_uses_iter_var = false;
+       expr->visit(*this);
+       /* Don't replace literals since they'd only be replaced with an identical
+       literal.  Also skip anything that uses an iteration variable, but pass on
+       the result so the Iteration visiting function can handle it. */
+       if(!r_constant || r_literal || r_uses_iter_var)
+               return;
+
+       BasicTypeDeclaration::Kind kind = get_value_kind(r_constant_value);
+       if(kind==BasicTypeDeclaration::VOID)
+       {
+               r_constant = false;
+               return;
+       }
+
+       RefPtr<Literal> literal = new Literal;
+       if(kind==BasicTypeDeclaration::BOOL)
+               literal->token = (r_constant_value.value<bool>() ? "true" : "false");
+       else if(kind==BasicTypeDeclaration::INT)
+               literal->token = lexical_cast<string>(r_constant_value.value<int>());
+       else if(kind==BasicTypeDeclaration::FLOAT)
+               literal->token = lexical_cast<string>(r_constant_value.value<float>());
+       literal->value = r_constant_value;
+       expr = literal;
+}
+
+void ConstantFolder::visit(Literal &literal)
+{
+       set_result(literal.value, true);
+}
+
+void ConstantFolder::visit(VariableReference &var)
+{
+       /* If an iteration variable is initialized with a constant value, return
+       that value here for the purpose of evaluating the loop condition for the
+       first iteration. */
+       if(var.declaration==iteration_var)
+       {
+               set_result(iter_init_value);
+               r_uses_iter_var = true;
+       }
+}
+
+void ConstantFolder::visit(MemberAccess &memacc)
+{
+       TraversingVisitor::visit(memacc);
+       r_constant = false;
+}
+
+void ConstantFolder::visit(Swizzle &swizzle)
+{
+       TraversingVisitor::visit(swizzle);
+       r_constant = false;
+}
+
+void ConstantFolder::visit(UnaryExpression &unary)
+{
+       TraversingVisitor::visit(unary);
+       bool can_fold = r_constant;
+       r_constant = false;
+       if(!can_fold)
+               return;
+
+       BasicTypeDeclaration::Kind kind = get_value_kind(r_constant_value);
+
+       char oper = unary.oper->token[0];
+       char oper2 = unary.oper->token[1];
+       if(oper=='!')
+       {
+               if(kind==BasicTypeDeclaration::BOOL)
+                       set_result(!r_constant_value.value<bool>());
+       }
+       else if(oper=='~')
+       {
+               if(kind==BasicTypeDeclaration::INT)
+                       set_result(~r_constant_value.value<int>());
+       }
+       else if(oper=='-' && !oper2)
+       {
+               if(kind==BasicTypeDeclaration::INT)
+                       set_result(-r_constant_value.value<int>());
+               else if(kind==BasicTypeDeclaration::FLOAT)
+                       set_result(-r_constant_value.value<float>());
+       }
+}
+
+void ConstantFolder::visit(BinaryExpression &binary)
+{
+       visit(binary.left);
+       bool left_constant = r_constant;
+       bool left_iter_var = r_uses_iter_var;
+       Variant left_value = r_constant_value;
+       visit(binary.right);
+       if(left_iter_var)
+               r_uses_iter_var = true;
+
+       bool can_fold = (left_constant && r_constant);
+       r_constant = false;
+       if(!can_fold)
+               return;
+
+       BasicTypeDeclaration::Kind left_kind = get_value_kind(left_value);
+       BasicTypeDeclaration::Kind right_kind = get_value_kind(r_constant_value);
+       // Currently only expressions with both sides of equal types are handled.
+       if(left_kind!=right_kind)
+               return;
+
+       char oper = binary.oper->token[0];
+       char oper2 = binary.oper->token[1];
+       if(oper=='&' || oper=='|' || oper=='^')
+       {
+               if(oper2==oper && left_kind==BasicTypeDeclaration::BOOL)
+                       set_result(evaluate_logical(oper, left_value.value<bool>(), r_constant_value.value<bool>()));
+               else if(!oper2 && left_kind==BasicTypeDeclaration::INT)
+                       set_result(evaluate_logical(oper, left_value.value<int>(), r_constant_value.value<int>()));
+       }
+       else if((oper=='<' || oper=='>') && oper2!=oper)
+       {
+               if(left_kind==BasicTypeDeclaration::INT)
+                       set_result(evaluate_relation(binary.oper->token, left_value.value<int>(), r_constant_value.value<int>()));
+               else if(left_kind==BasicTypeDeclaration::FLOAT)
+                       set_result(evaluate_relation(binary.oper->token, left_value.value<float>(), r_constant_value.value<float>()));
+       }
+       else if((oper=='=' || oper=='!') && oper2=='=')
+       {
+               if(left_kind==BasicTypeDeclaration::INT)
+                       set_result((left_value.value<int>()==r_constant_value.value<int>()) == (oper=='='));
+               if(left_kind==BasicTypeDeclaration::FLOAT)
+                       set_result((left_value.value<float>()==r_constant_value.value<float>()) == (oper=='='));
+       }
+       else if(oper=='+' || oper=='-' || oper=='*' || oper=='/')
+       {
+               if(left_kind==BasicTypeDeclaration::INT)
+                       set_result(evaluate_arithmetic(oper, left_value.value<int>(), r_constant_value.value<int>()));
+               else if(left_kind==BasicTypeDeclaration::FLOAT)
+                       set_result(evaluate_arithmetic(oper, left_value.value<float>(), r_constant_value.value<float>()));
+       }
+       else if(oper=='%' || ((oper=='<' || oper=='>') && oper2==oper))
+       {
+               if(left_kind!=BasicTypeDeclaration::INT)
+                       return;
+
+               if(oper=='%')
+                       set_result(left_value.value<int>()%r_constant_value.value<int>());
+               else if(oper=='<')
+                       set_result(left_value.value<int>()<<r_constant_value.value<int>());
+               else if(oper=='>')
+                       set_result(left_value.value<int>()>>r_constant_value.value<int>());
+       }
+}
+
+void ConstantFolder::visit(Assignment &assign)
+{
+       TraversingVisitor::visit(assign);
+       r_constant = false;
+}
+
+void ConstantFolder::visit(TernaryExpression &ternary)
+{
+       TraversingVisitor::visit(ternary);
+       r_constant = false;
+}
+
+void ConstantFolder::visit(FunctionCall &call)
+{
+       TraversingVisitor::visit(call);
+       r_constant = false;
+}
+
+void ConstantFolder::visit(VariableDeclaration &var)
+{
+       if(iteration_init && var.init_expression)
+       {
+               visit(var.init_expression);
+               if(r_constant)
+               {
+                       /* Record the value of a constant initialization expression of an
+                       iteration, so it can be used to evaluate the loop condition. */
+                       iteration_var = &var;
+                       iter_init_value = r_constant_value;
+               }
+       }
+       else
+               TraversingVisitor::visit(var);
+}
+
+void ConstantFolder::visit(Iteration &iter)
+{
+       SetForScope<Block *> set_block(current_block, &iter.body);
+
+       /* The iteration variable is not normally inlined into expressions, so we
+       process it specially here.  If the initial value causes the loop condition
+       to evaluate to false, then the expression can be folded. */
+       iteration_var = 0;
+       if(iter.init_statement)
+       {
+               SetFlag set_init(iteration_init);
+               iter.init_statement->visit(*this);
+       }
+
+       if(iter.condition)
+       {
+               visit(iter.condition);
+               if(r_constant && r_constant_value.check_type<bool>() && !r_constant_value.value<bool>())
+               {
+                       RefPtr<Literal> literal = new Literal;
+                       literal->token = "false";
+                       literal->value = r_constant_value;
+                       iter.condition = literal;
+               }
+       }
+       iteration_var = 0;
+
+       iter.body.visit(*this);
+       if(iter.loop_expression)
+               visit(iter.loop_expression);
+}
+
+
 void ConstantConditionEliminator::apply(Stage &stage)
 {
        stage.content.visit(*this);
        NodeRemover().apply(stage, nodes_to_remove);
 }
 
+ConstantConditionEliminator::ConstantStatus ConstantConditionEliminator::check_constant_condition(const Expression &expr)
+{
+       if(const Literal *literal = dynamic_cast<const Literal *>(&expr))
+               if(literal->value.check_type<bool>())
+                       return (literal->value.value<bool>() ? CONSTANT_TRUE : CONSTANT_FALSE);
+       return NOT_CONSTANT;
+}
+
 void ConstantConditionEliminator::visit(Block &block)
 {
        SetForScope<Block *> set_block(current_block, &block);
@@ -503,16 +838,35 @@ void ConstantConditionEliminator::visit(Block &block)
        }
 }
 
+void ConstantConditionEliminator::visit(RefPtr<Expression> &expr)
+{
+       r_ternary_result = 0;
+       expr->visit(*this);
+       if(r_ternary_result)
+               expr = r_ternary_result;
+       r_ternary_result = 0;
+}
+
+void ConstantConditionEliminator::visit(TernaryExpression &ternary)
+{
+       ConstantStatus result = check_constant_condition(*ternary.condition);
+       if(result!=NOT_CONSTANT)
+               r_ternary_result = (result==CONSTANT_TRUE ? ternary.true_expr : ternary.false_expr);
+       else
+               r_ternary_result = 0;
+}
+
 void ConstantConditionEliminator::visit(Conditional &cond)
 {
-       if(Literal *literal = dynamic_cast<Literal *>(cond.condition.get()))
-               if(literal->value.check_type<bool>())
-               {
-                       Block &block = (literal->value.value<bool>() ? cond.body : cond.else_body);
-                       current_block->body.splice(insert_point, block.body);
-                       nodes_to_remove.insert(&cond);
-                       return;
-               }
+       ConstantStatus result = check_constant_condition(*cond.condition);
+       if(result!=NOT_CONSTANT)
+       {
+               Block &block = (result==CONSTANT_TRUE ? cond.body : cond.else_body);
+               // TODO should check variable names for conflicts.  Potentially reuse InlineContentInjector?
+               current_block->body.splice(insert_point, block.body);
+               nodes_to_remove.insert(&cond);
+               return;
+       }
 
        TraversingVisitor::visit(cond);
 }
@@ -521,14 +875,8 @@ void ConstantConditionEliminator::visit(Iteration &iter)
 {
        if(iter.condition)
        {
-               /* If the loop condition is always false on the first iteration, the
-               entire loop can be removed */
-               ExpressionEvaluator::ValueMap values;
-               if(VariableDeclaration *var = dynamic_cast<VariableDeclaration *>(iter.init_statement.get()))
-                       values[var] = var->init_expression.get();
-               ExpressionEvaluator eval(values);
-               iter.condition->visit(eval);
-               if(eval.is_result_valid() && !eval.get_result())
+               ConstantStatus result = check_constant_condition(*iter.condition);
+               if(result==CONSTANT_FALSE)
                {
                        nodes_to_remove.insert(&iter);
                        return;
@@ -771,7 +1119,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_")));
 
@@ -793,7 +1141,7 @@ void UnusedVariableRemover::visit(InterfaceBlock &iface)
        else
        {
                VariableInfo &var_info = variables[&iface];
-               var_info.output = (iface.interface=="out" && (iface.linked_block || !iface.name.compare(0, 3, "gl_")));
+               var_info.output = (iface.interface=="out" && (iface.linked_block || !iface.block_name.compare(0, 3, "gl_")));
        }
 }