#include <msp/core/raii.h>
+#include <msp/strings/format.h>
#include "optimize.h"
using namespace std;
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)
+ /* Don't inline functions which are called more than once or are called
+ recursively. */
+ if(count>1 || def==current_function)
inlineable.erase(def);
}
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 &cond)
+{
+ TraversingVisitor::visit(cond);
+ inlineable.erase(current_function);
+}
+
+void InlineableFunctionLocator::visit(Iteration &iter)
+{
+ TraversingVisitor::visit(iter);
+ inlineable.erase(current_function);
+}
+
+void InlineableFunctionLocator::visit(Return &ret)
+{
+ TraversingVisitor::visit(ret);
+ if(return_count)
+ inlineable.erase(current_function);
+ ++return_count;
+}
+
+
+InlineContentInjector::InlineContentInjector():
+ source_func(0),
+ remap_names(false),
+ deps_only(false)
+{ }
+
+const string &InlineContentInjector::apply(Stage &stage, FunctionDeclaration &target_func, Block &tgt_blk, const NodeList<Statement>::iterator &ins_pt, FunctionDeclaration &src)
+{
+ target_block = &tgt_blk;
+ source_func = &src;
+ for(NodeList<Statement>::iterator i=src.body.body.begin(); i!=src.body.body.end(); ++i)
+ {
+ r_inlined_statement = 0;
+ (*i)->visit(*this);
+ if(!r_inlined_statement)
+ r_inlined_statement = (*i)->clone();
+
+ SetFlag set_remap(remap_names);
+ r_inlined_statement->visit(*this);
+ tgt_blk.body.insert(ins_pt, r_inlined_statement);
+ }
+
+ NodeReorderer().apply(stage, target_func, dependencies);
+
+ return r_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);
+ r_inlined_statement = inlined_var;
+
+ variable_map[var.name] = inlined_var.get();
+ }
+}
+
+void InlineContentInjector::visit(Return &ret)
+{
+ TraversingVisitor::visit(ret);
+
+ if(ret.expression)
+ {
+ /* 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 = r_result_name;
+ var->init_expression = ret.expression->clone();
+ r_inlined_statement = var;
+ }
+}
+
FunctionInliner::FunctionInliner():
- extract_result(0)
+ current_function(0),
+ r_any_inlined(false)
{ }
-void FunctionInliner::apply(Stage &stage)
+bool FunctionInliner::apply(Stage &s)
{
- inlineable = InlineableFunctionLocator().apply(stage);
- visit(stage.content);
+ stage = &s;
+ inlineable = InlineableFunctionLocator().apply(s);
+ r_any_inlined = false;
+ s.content.visit(*this);
+ 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)
- ptr = inline_result;
+ if(r_inline_result)
+ {
+ ptr = r_inline_result;
+ r_any_inlined = true;
+ }
}
void FunctionInliner::visit(Block &block)
{
- if(extract_result)
- --extract_result;
-
+ 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)
{
+ insert_point = i;
(*i)->visit(*this);
- if(extract_result)
- --extract_result;
}
}
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)
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;
+ 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)
+{
+ visit_and_inline(expr.expression);
}
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(Return &ret)
+void FunctionInliner::visit(FunctionDeclaration &func)
{
- TraversingVisitor::visit(ret);
+ SetForScope<FunctionDeclaration *> set_func(current_function, &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);
+}
- 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),
- current_block(0),
record_only(false)
{ }
void ConstantConditionEliminator::apply(Stage &stage)
{
- visit(stage.content);
+ stage.content.visit(*this);
NodeRemover().apply(stage, nodes_to_remove);
}
void ConstantConditionEliminator::visit(Block &block)
{
- SetForScope<unsigned> set(scope_level, scope_level+1);
SetForScope<Block *> set_block(current_block, &block);
for(NodeList<Statement>::iterator i=block.body.begin(); i!=block.body.end(); ++i)
{
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);
}
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();
}
UnusedVariableRemover::UnusedVariableRemover():
aggregate(0),
- assignment(0),
+ r_assignment(0),
assignment_target(false),
- assign_to_subscript(false),
- global_scope(true)
+ r_assign_to_subfield(false),
+ r_side_effects(false)
{ }
bool UnusedVariableRemover::apply(Stage &stage)
{
variables.push_back(BlockVariableMap());
- visit(stage.content);
+ stage.content.visit(*this);
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);
if(var.declaration && !assignment_target)
{
VariableInfo &var_info = variables.back()[var.declaration];
- var_info.assignments.clear();
+ // Previous assignments are used by this reference.
+ clear_assignments(var_info, false);
var_info.referenced = true;
}
}
+void UnusedVariableRemover::visit(InterfaceBlockReference &iface)
+{
+ unused_nodes.erase(iface.declaration);
+}
+
void UnusedVariableRemover::visit(MemberAccess &memacc)
{
+ r_assign_to_subfield = true;
TraversingVisitor::visit(memacc);
unused_nodes.erase(memacc.declaration);
}
+void UnusedVariableRemover::visit(UnaryExpression &unary)
+{
+ TraversingVisitor::visit(unary);
+ 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
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;
+ r_assignment = &assign;
+ r_side_effects = true;
+}
+
+void UnusedVariableRemover::visit(FunctionCall &call)
+{
+ TraversingVisitor::visit(call);
+ /* 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);
void UnusedVariableRemover::visit(ExpressionStatement &expr)
{
- assignment = 0;
+ 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(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);
}
void UnusedVariableRemover::visit(StructDeclaration &strct)
{
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();
+
+ /* 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();
}
{
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;
}
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;
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;
{
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)
- i->second.assignments.clear();
-
merge_down_variables();
}
bool UnusedFunctionRemover::apply(Stage &stage)
{
- visit(stage.content);
+ stage.content.visit(*this);
NodeRemover().apply(stage, unused_nodes);
return !unused_nodes.empty();
}