Inline functions consisting of a return of an expression.

6 files changed, 652 insertions, 1 deletions

diff --git a/Makefile.am b/Makefile.am
index 32c804c..6fac0a8 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -29,7 +29,8 @@ glsl_SOURCES = symbol_table.c hash_table.c glsl_types.cpp \
 	ir.cpp hir_field_selection.cpp builtin_function.cpp \
 	ir_print_visitor.cpp ir_variable.cpp ir_function.cpp \
 	ir_constant_expression.cpp \
-	ir_constant_folding.cpp
+	ir_constant_folding.cpp \
+	ir_function_inlining.cpp
 
 BUILT_SOURCES = glsl_parser.h builtin_types.h glsl_parser.cpp glsl_lexer.cpp
 CLEANFILES = $(BUILT_SOURCES)
diff --git a/glsl_parser_extras.cpp b/glsl_parser_extras.cpp
index fd44e96..a4a67c8 100644
--- a/glsl_parser_extras.cpp
+++ b/glsl_parser_extras.cpp
@@ -35,6 +35,7 @@
 #include "glsl_parser_extras.h"
 #include "glsl_parser.h"
 #include "ir_constant_folding.h"
+#include "ir_function_inlining.h"
 #include "ir_print_visitor.h"
 
 const char *
@@ -753,6 +754,8 @@ main(int argc, char **argv)
 
    /* Optimization passes */
    if (!state.error) {
+      do_function_inlining(&instructions);
+
       /* Constant folding */
       ir_constant_folding_visitor constant_folding;
       visit_exec_list(&instructions, &constant_folding);
diff --git a/ir.h b/ir.h
index 34e2858..2d3a8cd 100644
--- a/ir.h
+++ b/ir.h
@@ -55,6 +55,9 @@ public:
    virtual class ir_dereference *       as_dereference()      { return NULL; }
    virtual class ir_rvalue *            as_rvalue()           { return NULL; }
    virtual class ir_loop *              as_loop()             { return NULL; }
+   virtual class ir_assignment *        as_assignment()       { return NULL; }
+   virtual class ir_call *              as_call()             { return NULL; }
+   virtual class ir_return *            as_return()           { return NULL; }
    /*@}*/
 
 protected:
@@ -361,6 +364,11 @@ public:
       v->visit(this);
    }
 
+   virtual ir_assignment * as_assignment()
+   {
+      return this;
+   }
+
    /**
     * Left-hand side of the assignment.
     */
@@ -461,6 +469,8 @@ public:
       v->visit(this);
    }
 
+   ir_expression *clone();
+
    ir_expression_operation operation;
    ir_rvalue *operands[2];
 };
@@ -479,6 +489,11 @@ public:
       actual_parameters->move_nodes_to(& this->actual_parameters);
    }
 
+   virtual ir_call *as_call()
+   {
+      return this;
+   }
+
    virtual void accept(ir_visitor *v)
    {
       v->visit(this);
@@ -505,6 +520,17 @@ public:
       return callee->function_name();
    }
 
+   const ir_function_signature *get_callee()
+   {
+      return callee;
+   }
+
+   /**
+    * Generates an inline version of the function before @ir,
+    * returning the return value of the function.
+    */
+   ir_rvalue *generate_inline(ir_instruction *ir);
+
 private:
    ir_call()
       : callee(NULL)
@@ -547,6 +573,11 @@ public:
       /* empty */
    }
 
+   virtual ir_return *as_return()
+   {
+      return this;
+   }
+
    ir_rvalue *get_value() const
    {
       return value;
@@ -632,6 +663,17 @@ class ir_swizzle : public ir_rvalue {
 public:
    ir_swizzle(ir_rvalue *, unsigned x, unsigned y, unsigned z, unsigned w,
               unsigned count);
+   ir_swizzle(ir_rvalue *val, ir_swizzle_mask mask)
+      : val(val), mask(mask)
+   {
+      /* empty */
+   }
+
+   ir_swizzle *clone()
+   {
+      return new ir_swizzle(this->val, this->mask);
+   }
+
    /**
     * Construct an ir_swizzle from the textual representation.  Can fail.
     */
@@ -703,6 +745,11 @@ public:
       v->visit(this);
    }
 
+   ir_constant *clone()
+   {
+      return new ir_constant(this->type, &this->value);
+   }
+
    /**
     * Value of the constant.
     *
diff --git a/ir_function_inlining.cpp b/ir_function_inlining.cpp
new file mode 100644
index 0000000..b6434b8
--- /dev/null
+++ b/ir_function_inlining.cpp
@@ -0,0 +1,522 @@
+/*
+ * Copyright © 2010 Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * \file ir_function_inlining.cpp
+ *
+ * Replaces calls to functions with the body of the function.
+ */
+
+#define NULL 0
+#include "ir.h"
+#include "ir_visitor.h"
+#include "ir_function_inlining.h"
+#include "glsl_types.h"
+
+class variable_remap : public exec_node {
+public:
+   variable_remap(const ir_variable *old_var, ir_variable *new_var)
+      : old_var(old_var), new_var(new_var)
+   {
+      /* empty */
+   }
+   const ir_variable *old_var;
+   ir_variable *new_var;
+};
+
+class ir_function_cloning_visitor : public ir_visitor {
+public:
+   ir_function_cloning_visitor(ir_variable *retval)
+      : retval(retval)
+   {
+      /* empty */
+   }
+
+   virtual ~ir_function_cloning_visitor()
+   {
+      /* empty */
+   }
+
+   void remap_variable(const ir_variable *old_var, ir_variable *new_var) {
+      variable_remap *remap = new variable_remap(old_var, new_var);
+      this->remap_list.push_tail(remap);
+   }
+
+   ir_variable *get_remapped_variable(ir_variable *var) {
+      foreach_iter(exec_list_iterator, iter, this->remap_list) {
+	 variable_remap *remap = (variable_remap *)iter.get();
+
+	 if (var == remap->old_var)
+	    return remap->new_var;
+      }
+
+      /* Not a reapped variable, so a global scoped reference, for example. */
+      return var;
+   }
+
+   /* List of variable_remap for mapping from original function body variables
+    * to inlined function body variables.
+    */
+   exec_list remap_list;
+
+   /* Return value for the inlined function. */
+   ir_variable *retval;
+
+   /**
+    * \name Visit methods
+    *
+    * As typical for the visitor pattern, there must be one \c visit method for
+    * each concrete subclass of \c ir_instruction.  Virtual base classes within
+    * the hierarchy should not have \c visit methods.
+    */
+   /*@{*/
+   virtual void visit(ir_variable *);
+   virtual void visit(ir_label *);
+   virtual void visit(ir_loop *);
+   virtual void visit(ir_loop_jump *);
+   virtual void visit(ir_function_signature *);
+   virtual void visit(ir_function *);
+   virtual void visit(ir_expression *);
+   virtual void visit(ir_swizzle *);
+   virtual void visit(ir_dereference *);
+   virtual void visit(ir_assignment *);
+   virtual void visit(ir_constant *);
+   virtual void visit(ir_call *);
+   virtual void visit(ir_return *);
+   virtual void visit(ir_if *);
+   /*@}*/
+
+   ir_instruction *result;
+};
+
+void
+ir_function_cloning_visitor::visit(ir_variable *ir)
+{
+   ir_variable *new_var = ir->clone();
+
+   this->result = new_var;
+
+   this->remap_variable(ir, new_var);
+}
+
+void
+ir_function_cloning_visitor::visit(ir_label *ir)
+{
+   (void)ir;
+   this->result = NULL;
+}
+
+void
+ir_function_cloning_visitor::visit(ir_loop *ir)
+{
+   (void)ir;
+   this->result = NULL;
+}
+
+void
+ir_function_cloning_visitor::visit(ir_loop_jump *ir)
+{
+   (void) ir;
+   this->result = NULL;
+}
+
+
+void
+ir_function_cloning_visitor::visit(ir_function_signature *ir)
+{
+   (void)ir;
+   this->result = NULL;
+}
+
+
+void
+ir_function_cloning_visitor::visit(ir_function *ir)
+{
+   (void) ir;
+   this->result = NULL;
+}
+
+void
+ir_function_cloning_visitor::visit(ir_expression *ir)
+{
+   unsigned int operand;
+   ir_rvalue *op[2] = {NULL, NULL};
+
+   for (operand = 0; operand < ir->get_num_operands(); operand++) {
+      ir->operands[operand]->accept(this);
+      op[operand] = this->result->as_rvalue();
+      assert(op[operand]);
+   }
+
+   this->result = new ir_expression(ir->operation, ir->type, op[0], op[1]);
+}
+
+
+void
+ir_function_cloning_visitor::visit(ir_swizzle *ir)
+{
+   ir->val->accept(this);
+
+   this->result = new ir_swizzle(this->result->as_rvalue(), ir->mask);
+}
+
+void
+ir_function_cloning_visitor::visit(ir_dereference *ir)
+{
+   if (ir->mode == ir_dereference::ir_reference_variable) {
+      ir_variable *old_var = ir->var->as_variable();
+
+      /* If it's a deref of a real variable, then we need to remap it if
+       * it was local to the function.
+       */
+      if (old_var) {
+	 ir_variable *new_var;
+
+	 new_var = this->get_remapped_variable(old_var);
+
+	 this->result = new ir_dereference(new_var);
+      } else {
+	 ir->var->accept(this);
+
+	 this->result = new ir_dereference(this->result);
+      }
+   } else {
+      this->result = NULL;
+   }
+}
+
+void
+ir_function_cloning_visitor::visit(ir_assignment *ir)
+{
+   ir_rvalue *lhs, *rhs, *condition;
+
+   ir->lhs->accept(this);
+   lhs = this->result->as_rvalue();
+
+   ir->rhs->accept(this);
+   rhs = this->result->as_rvalue();
+
+   ir->condition->accept(this);
+   condition = this->result->as_rvalue();
+
+   this->result = new ir_assignment(lhs, rhs, condition);
+}
+
+
+void
+ir_function_cloning_visitor::visit(ir_constant *ir)
+{
+   this->result = ir->clone();
+}
+
+
+void
+ir_function_cloning_visitor::visit(ir_call *ir)
+{
+   exec_list parameters;
+
+   foreach_iter(exec_list_iterator, iter, *ir) {
+      ir_rvalue *param = (ir_rvalue *)iter.get();
+
+      param->accept(this);
+      parameters.push_tail(this->result);
+   }
+
+   this->result = new ir_call(ir->get_callee(), &parameters);
+}
+
+
+void
+ir_function_cloning_visitor::visit(ir_return *ir)
+{
+   ir_rvalue *rval;
+
+   assert(this->retval);
+
+   rval = ir->get_value();
+   rval->accept(this);
+   rval = this->result->as_rvalue();
+   assert(rval);
+
+   result = new ir_assignment(new ir_dereference(this->retval),
+			      ir->get_value(), NULL);
+}
+
+
+void
+ir_function_cloning_visitor::visit(ir_if *ir)
+{
+   (void) ir;
+   result = NULL;
+}
+
+bool
+can_inline(ir_call *call)
+{
+   bool found_return = false;
+
+   /* FINISHME: Right now we only allow a single statement that is a return.
+    */
+   foreach_iter(exec_list_iterator, iter, call->get_callee()->body) {
+      ir_instruction *ir = (ir_instruction *)iter.get();
+      if (ir->get_next()->get_next() != NULL)
+	 return false;
+
+      if (!ir->as_return())
+	 return false;
+
+      found_return = true;
+   }
+
+   return found_return;
+}
+
+bool
+do_function_inlining(exec_list *instructions)
+{
+   bool progress;
+
+   foreach_iter(exec_list_iterator, iter, *instructions) {
+      ir_instruction *ir = (ir_instruction *)iter.get();
+      ir_assignment *assign = ir->as_assignment();
+      ir_call *call;
+
+      if (assign) {
+	 call = assign->rhs->as_call();
+	 if (!call || !can_inline(call))
+	    continue;
+
+	 /* generates the parameter setup, function body, and returns the return
+	  * value of the function
+	  */
+	 ir_rvalue *rhs = call->generate_inline(ir);
+	 assert(rhs);
+
+	 assign->rhs = rhs;
+	 progress = true;
+      } else if ((call = ir->as_call()) && can_inline(call)) {
+	 (void)call->generate_inline(ir);
+	 ir->remove();
+	 progress = true;
+      } else {
+	 ir_function_inlining_visitor v;
+	 ir->accept(&v);
+      }
+   }
+
+   return progress;
+}
+
+ir_rvalue *
+ir_call::generate_inline(ir_instruction *next_ir)
+{
+   ir_variable **parameters;
+   int num_parameters;
+   int i;
+   ir_variable *retval = NULL;
+
+   num_parameters = 0;
+   foreach_iter(exec_list_iterator, iter_sig, this->callee->parameters)
+      num_parameters++;
+
+   parameters = new ir_variable *[num_parameters];
+
+   /* Generate storage for the return value. */
+   if (this->callee->return_type) {
+      retval = new ir_variable(this->callee->return_type, "__retval");
+      next_ir->insert_before(retval);
+   }
+
+   ir_function_cloning_visitor v = ir_function_cloning_visitor(retval);
+
+   /* Generate the declarations for the parameters to our inlined code,
+    * and set up the mapping of real function body variables to ours.
+    */
+   i = 0;
+   exec_list_iterator sig_param_iter = this->callee->parameters.iterator();
+   exec_list_iterator param_iter = this->actual_parameters.iterator();
+   for (i = 0; i < num_parameters; i++) {
+      const ir_variable *const sig_param = (ir_variable *) sig_param_iter.get();
+      ir_rvalue *param = (ir_rvalue *) param_iter.get();
+
+      /* Generate a new variable for the parameter. */
+      parameters[i] = sig_param->clone();
+      next_ir->insert_before(parameters[i]);
+
+      v.remap_variable(sig_param, parameters[i]);
+
+      /* Move the actual param into our param variable if it's an 'in' type. */
+      if (parameters[i]->mode == ir_var_in ||
+	  parameters[i]->mode == ir_var_inout) {
+	 ir_assignment *assign;
+
+	 assign = new ir_assignment(new ir_dereference(parameters[i]),
+				    param, NULL);
+	 next_ir->insert_before(assign);
+      }
+
+      sig_param_iter.next();
+      param_iter.next();
+   }
+
+   /* Generate the inlined body of the function. */
+   foreach_iter(exec_list_iterator, iter, callee->body) {
+      ir_instruction *ir = (ir_instruction *)iter.get();
+
+      ir->accept(&v);
+      assert(v.result);
+      next_ir->insert_before(v.result);
+   }
+
+   /* Generate the declarations for the parameters to our inlined code,
+    * and set up the mapping of real function body variables to ours.
+    */
+   i = 0;
+   param_iter = this->actual_parameters.iterator();
+   for (i = 0; i < num_parameters; i++) {
+      ir_instruction *const param = (ir_instruction *) param_iter.get();
+
+      /* Move the actual param into our param variable if it's an 'in' type. */
+      if (parameters[i]->mode == ir_var_out ||
+	  parameters[i]->mode == ir_var_inout) {
+	 ir_assignment *assign;
+
+	 assign = new ir_assignment(param->as_rvalue(),
+				    new ir_dereference(parameters[i]),
+				    NULL);
+	 next_ir->insert_before(assign);
+      }
+
+      param_iter.next();
+   }
+
+   delete(parameters);
+
+   if (retval)
+      return new ir_dereference(retval);
+   else
+      return NULL;
+}
+
+void
+ir_function_inlining_visitor::visit(ir_variable *ir)
+{
+   (void) ir;
+}
+
+
+void
+ir_function_inlining_visitor::visit(ir_label *ir)
+{
+   ir->signature->accept(this);
+}
+
+void
+ir_function_inlining_visitor::visit(ir_loop *ir)
+{
+   do_function_inlining(&ir->body_instructions);
+}
+
+void
+ir_function_inlining_visitor::visit(ir_loop_jump *ir)
+{
+   (void) ir;
+}
+
+
+void
+ir_function_inlining_visitor::visit(ir_function_signature *ir)
+{
+   do_function_inlining(&ir->body);
+}
+
+
+void
+ir_function_inlining_visitor::visit(ir_function *ir)
+{
+   (void) ir;
+}
+
+void
+ir_function_inlining_visitor::visit(ir_expression *ir)
+{
+   unsigned int operand;
+
+   for (operand = 0; operand < ir->get_num_operands(); operand++) {
+      ir->operands[operand]->accept(this);
+   }
+}
+
+
+void
+ir_function_inlining_visitor::visit(ir_swizzle *ir)
+{
+   ir->val->accept(this);
+}
+
+
+void
+ir_function_inlining_visitor::visit(ir_dereference *ir)
+{
+   if (ir->mode == ir_dereference::ir_reference_array) {
+      ir->selector.array_index->accept(this);
+   }
+   ir->var->accept(this);
+}
+
+void
+ir_function_inlining_visitor::visit(ir_assignment *ir)
+{
+   ir->rhs->accept(this);
+}
+
+
+void
+ir_function_inlining_visitor::visit(ir_constant *ir)
+{
+   (void) ir;
+}
+
+
+void
+ir_function_inlining_visitor::visit(ir_call *ir)
+{
+   (void) ir;
+}
+
+
+void
+ir_function_inlining_visitor::visit(ir_return *ir)
+{
+   (void) ir;
+}
+
+
+void
+ir_function_inlining_visitor::visit(ir_if *ir)
+{
+   ir->condition->accept(this);
+
+   do_function_inlining(&ir->then_instructions);
+   do_function_inlining(&ir->else_instructions);
+}
diff --git a/ir_function_inlining.h b/ir_function_inlining.h
new file mode 100644
index 0000000..60c80a6
--- /dev/null
+++ b/ir_function_inlining.h
@@ -0,0 +1,67 @@
+/*
+ * Copyright © 2010 Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * \file ir_function_inlining.h
+ *
+ * Replaces calls to functions with the body of the function.
+ */
+
+class ir_function_inlining_visitor : public ir_visitor {
+public:
+   ir_function_inlining_visitor()
+   {
+      /* empty */
+   }
+
+   virtual ~ir_function_inlining_visitor()
+   {
+      /* empty */
+   }
+
+   /**
+    * \name Visit methods
+    *
+    * As typical for the visitor pattern, there must be one \c visit method for
+    * each concrete subclass of \c ir_instruction.  Virtual base classes within
+    * the hierarchy should not have \c visit methods.
+    */
+   /*@{*/
+   virtual void visit(ir_variable *);
+   virtual void visit(ir_label *);
+   virtual void visit(ir_loop *);
+   virtual void visit(ir_loop_jump *);
+   virtual void visit(ir_function_signature *);
+   virtual void visit(ir_function *);
+   virtual void visit(ir_expression *);
+   virtual void visit(ir_swizzle *);
+   virtual void visit(ir_dereference *);
+   virtual void visit(ir_assignment *);
+   virtual void visit(ir_constant *);
+   virtual void visit(ir_call *);
+   virtual void visit(ir_return *);
+   virtual void visit(ir_if *);
+   /*@}*/
+};
+
+bool do_function_inlining(exec_list *instructions);
diff --git a/list.h b/list.h
index 054be7e..afa32f1 100644
--- a/list.h
+++ b/list.h
@@ -126,6 +126,17 @@ struct exec_node {
       this->next->prev = after;
       this->next = after;
    }
+   /**
+    * Insert a node in the list before the current node
+    */
+   void insert_before(exec_node *before)
+   {
+      before->next = this;
+      before->prev = this->prev;
+
+      this->prev->next = before;
+      this->prev = before;
+   }
 #endif
 };