replaced inline by __inline to allow to be compiled in gcc and msvc modes
[libfirm] / ir / lower / lower_calls.c
index 0836de7..606d9f7 100644 (file)
@@ -1,25 +1,34 @@
 /*
- * Project:     libFIRM
- * File name:   ir/lower/lower_calls.c
- * Purpose:     lowering of Calls with compound parameters
- * Author:      Michael Beck
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2005 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
+
+/**
+ * @file
+ * @brief   Lowering of Calls with compound parameters and return types.
+ * @author  Michael Beck
+ * @version $Id$
  */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-#ifdef HAVE_ALLOCA_H
-#include <alloca.h>
-#endif
-#ifdef HAVE_MALLOC_H
-#include <malloc.h>
-#endif
-
+#include "lowering.h"
 #include "irprog_t.h"
 #include "irnode_t.h"
 #include "type_t.h"
 #include "ircons.h"
 #include "irgmod.h"
 #include "irgwalk.h"
-#include "typewalk.h"
-#include "lower_calls.h"
-#include "return.h"
 #include "irtools.h"
+#include "iroptimize.h"
 #include "array.h"
 #include "pmap.h"
+#include "xmalloc.h"
 
 /** A type map for def_find_pointer_type. */
 static pmap *type_map;
@@ -67,12 +75,13 @@ static ir_type *def_find_pointer_type(ir_type *e_type, ir_mode *mode, int alignm
  * @param mtp  the method type to lower
  *
  * The current implementation expects that a lowered type already
- * includes the necessery changes ...
+ * includes the necessary changes ...
  */
 static ir_type *create_modified_mtd_type(const lower_params_t *lp, ir_type *mtp)
 {
-  ir_type *lowered;
+  ir_type *lowered, *ptr_tp;
   ir_type **params, **results, *res_tp;
+  ir_mode *modes[MAX_REGISTER_RET_VAL];
   int n_ress, n_params, nn_ress, nn_params, i, first_variadic;
   ident *id;
   add_hidden hidden_params;
@@ -105,8 +114,25 @@ static ir_type *create_modified_mtd_type(const lower_params_t *lp, ir_type *mtp)
     for (nn_ress = nn_params = i = 0; i < n_ress; ++i) {
       res_tp = get_method_res_type(mtp, i);
 
-      if (is_compound_type(res_tp))
-        params[nn_params++] = lp->find_pointer_type(res_tp, get_modeP_data(), lp->def_ptr_alignment);
+      if (is_compound_type(res_tp)) {
+        int n_regs = 0;
+
+        if (lp->flags & LF_SMALL_CMP_IN_REGS)
+          n_regs = lp->ret_compound_in_regs(res_tp, modes);
+
+        if (n_regs > 0) {
+          /* this compound will be returned solely in registers */
+          assert(0);
+        }
+        else {
+          /* this compound will be allocated on callers stack and its
+             address will be transmitted as a hidden parameter. */
+          ptr_tp = lp->find_pointer_type(res_tp, get_modeP_data(), lp->def_ptr_alignment);
+          params[nn_params++] = ptr_tp;
+          if (lp->flags & LF_RETURN_HIDDEN)
+            results[nn_ress++] = ptr_tp;
+        }
+      }
       else
         results[nn_ress++] = res_tp;
     }
@@ -170,12 +196,13 @@ struct cl_entry {
  * Walker environment for fix_args_and_collect_calls().
  */
 typedef struct _wlk_env_t {
-  int            arg_shift;     /**< The Argument index shift for parameters. */
-  int            first_hidden;  /**< The index of the first hidden argument. */
-  struct obstack obst;          /**< An obstack to allocate the data on. */
-  cl_entry       *cl_list;      /**< The call list. */
-  pmap           *dummy_map;    /**< A map for finding the dummy arguments. */
-  unsigned       dnr;           /**< The dummy index number. */
+  int                  arg_shift;     /**< The Argument index shift for parameters. */
+  int                  first_hidden;  /**< The index of the first hidden argument. */
+  struct obstack       obst;          /**< An obstack to allocate the data on. */
+  cl_entry             *cl_list;      /**< The call list. */
+  pmap                 *dummy_map;    /**< A map for finding the dummy arguments. */
+  unsigned             dnr;           /**< The dummy index number. */
+  const lower_params_t *params;       /**< lowering parameters */
 } wlk_env;
 
 /**
@@ -220,17 +247,22 @@ static void fix_args_and_collect_calls(ir_node *n, void *ctx) {
   }
   else if (op == op_Call) {
     ctp = get_Call_type(n);
-    for (i = get_method_n_ress(ctp) -1; i >= 0; --i) {
-      if (is_compound_type(get_method_res_type(ctp, i))) {
-        /*
-         * This is a call with a compound return. As the result
-         * might be ignored, we must put it in the list.
-         */
-        (void)get_Call_entry(n, env);
+    if (env->params->flags & LF_COMPOUND_RETURN) {
+      /* check for compound returns */
+      for (i = get_method_n_ress(ctp) -1; i >= 0; --i) {
+        if (is_compound_type(get_method_res_type(ctp, i))) {
+          /*
+           * This is a call with a compound return. As the result
+           * might be ignored, we must put it in the list.
+           */
+          (void)get_Call_entry(n, env);
+          break;
+        }
       }
     }
   }
-  else if (op == op_CopyB) {
+  else if (op == op_CopyB && env->params->flags & LF_COMPOUND_RETURN) {
+    /* check for compound returns */
     ir_node *src = get_CopyB_src(n);
     /* older scheme using value_res_ent */
     if (is_Sel(src)) {
@@ -273,7 +305,7 @@ static void fix_args_and_collect_calls(ir_node *n, void *ctx) {
  */
 static int is_compound_address(ir_type *ft, ir_node *adr)
 {
-  entity *ent;
+  ir_entity *ent;
 
   if (! is_Sel(adr))
     return 0;
@@ -285,7 +317,7 @@ static int is_compound_address(ir_type *ft, ir_node *adr)
 
 /** A pair for the copy-return-optimization. */
 typedef struct cr_pair {
-  entity *ent;    /**< the entity than can be removed from the frame */
+  ir_entity *ent; /**< the entity than can be removed from the frame */
   ir_node *arg;   /**< the argument that replaces the entities address */
 } cr_pair;
 
@@ -302,7 +334,7 @@ static void do_copy_return_opt(ir_node *n, void *ctx) {
   int i;
 
   if (is_Sel(n)) {
-    entity *ent = get_Sel_entity(n);
+    ir_entity *ent = get_Sel_entity(n);
 
     for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
       if (ent == arr[i].ent) {
@@ -327,34 +359,32 @@ static void do_copy_return_opt(ir_node *n, void *ctx) {
  */
 static ir_node *get_dummy_sel(ir_graph *irg, ir_node *block, ir_type *tp, wlk_env *env)
 {
-  ir_node *sel;
+  ir_entity *ent;
   pmap_entry *e;
 
   /* use a map the check if we already create such an entity */
   e = pmap_find(env->dummy_map, tp);
   if (e)
-    sel = e->value;
+    ent = e->value;
   else {
     ir_type *ft = get_irg_frame_type(irg);
-    entity *ent;
     char buf[16];
 
     snprintf(buf, sizeof(buf), "dummy.%u", env->dnr++);
     ent = new_entity(ft, new_id_from_str(buf), tp);
-    sel = new_r_simpleSel(
-      irg,
-      block,
-      get_irg_no_mem(irg),
-      get_irg_frame(irg),
-      ent);
-    pmap_insert(env->dummy_map, tp, sel);
+    pmap_insert(env->dummy_map, tp, ent);
 
     if (get_type_state(ft) == layout_fixed) {
       /* Fix the layout again */
       assert(0 && "Fixed layout not implemented");
     }
   }
-  return sel;
+  return new_r_simpleSel(
+    irg,
+    block,
+    get_irg_no_mem(irg),
+    get_irg_frame(irg),
+    ent);
 }
 
 /**
@@ -368,8 +398,8 @@ static ir_node *get_dummy_sel(ir_graph *irg, ir_node *block, ir_type *tp, wlk_en
  */
 static void add_hidden_param(ir_graph *irg, int n_com, ir_node **ins, cl_entry *entry, wlk_env *env)
 {
-  ir_node *p, *n, *src, *mem;
-  entity *ent;
+  ir_node *p, *n, *src, *mem, *blk;
+  ir_entity *ent;
   ir_type *owner;
   int idx, n_args;
 
@@ -396,12 +426,14 @@ static void add_hidden_param(ir_graph *irg, int n_com, ir_node **ins, cl_entry *
 
     ins[idx] = get_CopyB_dst(p);
     mem      = get_CopyB_mem(p);
+    blk      = get_nodes_block(p);
 
     /* get rid of the CopyB */
     turn_into_tuple(p, pn_CopyB_max);
     set_Tuple_pred(p, pn_CopyB_M_regular, mem);
-    set_Tuple_pred(p, pn_CopyB_M_except, get_irg_bad(irg));
-    set_Tuple_pred(p, pn_CopyB_X_except, get_irg_bad(irg));
+    set_Tuple_pred(p, pn_CopyB_M_except,  get_irg_bad(irg));
+    set_Tuple_pred(p, pn_CopyB_X_regular, new_r_Jmp(irg, blk));
+    set_Tuple_pred(p, pn_CopyB_X_except,  get_irg_bad(irg));
     ++n_args;
   }
 
@@ -427,17 +459,16 @@ static void add_hidden_param(ir_graph *irg, int n_com, ir_node **ins, cl_entry *
 /**
  * Fix all calls on a call list by adding hidden parameters.
  *
- * @param lp   the parameter struct
  * @param irg  the graph
  * @param env  the environment
  */
-static void fix_call_list(const lower_params_t *lp, ir_graph *irg, wlk_env *env) {
+static void fix_call_list(ir_graph *irg, wlk_env *env) {
+  const lower_params_t *lp = env->params;
   cl_entry *p;
   ir_node *call, **new_in;
   ir_type *ctp, *lowered_mtp;
   add_hidden hidden_params;
   int i, n_params, n_com, pos;
-  unsigned dnr = 0;
 
   new_in = NEW_ARR_F(ir_node *, 0);
   for (p = env->cl_list; p; p = p->next) {
@@ -490,9 +521,9 @@ static void fix_call_list(const lower_params_t *lp, ir_graph *irg, wlk_env *env)
  */
 static void transform_irg(const lower_params_t *lp, ir_graph *irg)
 {
-  entity *ent = get_irg_entity(irg);
-  ir_type *mtp, *lowered_mtp, *res_tp, *ft;
-  int i, j, k, n_ress, n_com, n_cr_opt;
+  ir_entity *ent = get_irg_entity(irg);
+  ir_type *mtp, *lowered_mtp, *tp, *ft;
+  int i, j, k, n_ress = 0, n_ret_com = 0, n_cr_opt;
   ir_node **new_in, *ret, *endbl, *bl, *mem, *copy;
   cr_pair *cr_opt;
   wlk_env env;
@@ -501,16 +532,20 @@ static void transform_irg(const lower_params_t *lp, ir_graph *irg)
   assert(ent && "Cannot tranform graph without an entity");
   assert(get_irg_phase_state(irg) == phase_high && "call lowering must be done in phase high");
 
-  mtp    = get_entity_type(ent);
-  n_ress = get_method_n_ress(mtp);
-  for (n_com = i = 0; i < n_ress; ++i) {
-    res_tp = get_method_res_type(mtp, i);
+  mtp = get_entity_type(ent);
+
+  if (lp->flags & LF_COMPOUND_RETURN) {
+    /* calculate the number of compound returns */
+    n_ress = get_method_n_ress(mtp);
+    for (n_ret_com = i = 0; i < n_ress; ++i) {
+      tp = get_method_res_type(mtp, i);
 
-    if (is_compound_type(res_tp))
-      ++n_com;
+      if (is_compound_type(tp))
+        ++n_ret_com;
+    }
   }
 
-  if (n_com) {
+  if (n_ret_com) {
     /* much easier if we have only one return */
     normalize_one_return(irg);
 
@@ -525,7 +560,7 @@ static void transform_irg(const lower_params_t *lp, ir_graph *irg)
 
     if (hidden_params == ADD_HIDDEN_ALWAYS_IN_FRONT) {
       /* hidden arguments are added first */
-      env.arg_shift    = n_com;
+      env.arg_shift    = n_ret_com;
       env.first_hidden = 0;
     }
     else {
@@ -542,15 +577,16 @@ static void transform_irg(const lower_params_t *lp, ir_graph *irg)
   env.cl_list   = NULL;
   env.dummy_map = pmap_create_ex(8);
   env.dnr       = 0;
+  env.params    = lp;
 
   /* scan the code, fix argument numbers and collect calls. */
   irg_walk_graph(irg, firm_clear_link, fix_args_and_collect_calls, &env);
 
   /* fix all calls */
   if (env.cl_list)
-    fix_call_list(lp, irg, &env);
+    fix_call_list(irg, &env);
 
-  if (n_com) {
+  if (n_ret_com) {
     /*
      * Now fix the Return node of the current graph.
      */
@@ -573,19 +609,19 @@ static void transform_irg(const lower_params_t *lp, ir_graph *irg)
      * STEP 2: fix it. For all compound return values add a CopyB,
      * all others are copied.
      */
-    NEW_ARR_A(ir_node *, new_in, n_ress - n_com + 1);
+    NEW_ARR_A(ir_node *, new_in, n_ress + 1);
 
     bl  = get_nodes_block(ret);
     mem = get_Return_mem(ret);
 
     ft = get_irg_frame_type(irg);
-    NEW_ARR_A(cr_pair, cr_opt, n_com);
+    NEW_ARR_A(cr_pair, cr_opt, n_ret_com);
     n_cr_opt = 0;
     for (j = 1, i = k = 0; i < n_ress; ++i) {
       ir_node *pred = get_Return_res(ret, i);
-      res_tp = get_method_res_type(mtp, i);
+      tp = get_method_res_type(mtp, i);
 
-      if (is_compound_type(res_tp)) {
+      if (is_compound_type(tp)) {
         ir_node *arg = get_irg_args(irg);
         arg = new_r_Proj(irg, get_nodes_block(arg), arg, mode_P_data, env.first_hidden + k);
         ++k;
@@ -602,16 +638,21 @@ static void transform_irg(const lower_params_t *lp, ir_graph *irg)
                   mem,
                   arg,
                   pred,
-                  res_tp
+                  tp
                  );
           mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
         }
+        if (lp->flags & LF_RETURN_HIDDEN) {
+          new_in[j] = arg;
+          ++j;
+        }
       }
-      else { /* skalar return value */
+      else { /* scalar return value */
         new_in[j] = pred;
         ++j;
       }
     }
+    /* replace the in of the Return */
     new_in[0] = mem;
     set_irn_in(ret, j, new_in);
 
@@ -622,7 +663,7 @@ static void transform_irg(const lower_params_t *lp, ir_graph *irg)
         remove_class_member(ft, cr_opt[i].ent);
       }
     }
-  } /* n_com */
+  } /* if (n_ret_com) */
 
   pmap_destroy(env.dummy_map);
   obstack_free(&env.obst, NULL);
@@ -632,19 +673,23 @@ static void transform_irg(const lower_params_t *lp, ir_graph *irg)
  * Returns non-zero if the given type is a method
  * type that must be lowered.
  *
+ * @param lp  lowering parameters
  * @param tp  The type.
  */
-static int must_be_lowered(ir_type *tp) {
+static int must_be_lowered(const lower_params_t *lp, ir_type *tp) {
   int i, n_ress;
   ir_type *res_tp;
 
   if (is_Method_type(tp)) {
-    n_ress = get_method_n_ress(tp);
-    for (i = 0; i < n_ress; ++i) {
-      res_tp = get_method_res_type(tp, i);
-
-      if (is_compound_type(res_tp))
-        return 1;
+    if (lp->flags & LF_COMPOUND_RETURN) {
+      /* check for compound returns */
+      n_ress = get_method_n_ress(tp);
+      for (i = 0; i < n_ress; ++i) {
+        res_tp = get_method_res_type(tp, i);
+
+        if (is_compound_type(res_tp))
+          return 1;
+      }
     }
   }
   return 0;
@@ -661,10 +706,10 @@ static void lower_method_types(type_or_ent *tore, void *env)
 
   /* fix method entities */
   if (is_entity(tore)) {
-    entity *ent = (entity *)tore;
+    ir_entity *ent = (ir_entity *)tore;
     tp = get_entity_type(ent);
 
-    if (must_be_lowered(tp)) {
+    if (must_be_lowered(lp, tp)) {
       tp = create_modified_mtd_type(lp, tp);
       set_entity_type(ent, tp);
     }
@@ -675,7 +720,7 @@ static void lower_method_types(type_or_ent *tore, void *env)
     /* fix pointer to methods */
     if (is_Pointer_type(tp)) {
       ir_type *etp = get_pointer_points_to_type(tp);
-      if (must_be_lowered(etp)) {
+      if (must_be_lowered(lp, etp)) {
         etp = create_modified_mtd_type(lp, etp);
         set_pointer_points_to_type(tp, etp);
       }
@@ -684,7 +729,7 @@ static void lower_method_types(type_or_ent *tore, void *env)
 }
 
 /*
- * Lower calls with compound return types.
+ * Lower calls with compound parameters and return types.
  * This function does the following transformations:
  *
  * - Adds a new (hidden) pointer parameter for
@@ -698,7 +743,7 @@ static void lower_method_types(type_or_ent *tore, void *env)
  *
  * - Replace a possible block copy after the function call.
  */
-void lower_compound_ret_calls(const lower_params_t *params)
+void lower_calls_with_compounds(const lower_params_t *params)
 {
   int i;
   ir_graph *irg;