give Bad nodes a mode
[libfirm] / ir / opt / tailrec.c
index 9bf3fa3..d1af572 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
 #include "irouts.h"
 #include "irhooks.h"
 #include "ircons_t.h"
-#include "irtools.h"
+#include "irpass.h"
 
 DEBUG_ONLY(static firm_dbg_module_t *dbg);
 
 /**
  * the environment for collecting data
  */
-typedef struct _collect_t {
+typedef struct collect_t {
        ir_node *proj_X;      /**< initial exec proj */
        ir_node *block;       /**< old first block */
        int     blk_idx;      /**< cfgpred index of the initial exec in block */
@@ -63,17 +63,18 @@ typedef struct _collect_t {
 /**
  * walker for collecting data, fills a collect_t environment
  */
-static void collect_data(ir_node *node, void *env) {
-       collect_t *data = env;
+static void collect_data(ir_node *node, void *env)
+{
+       collect_t *data = (collect_t*)env;
        ir_node *pred;
-       ir_op *op;
+       ir_opcode opcode;
 
        switch (get_irn_opcode(node)) {
        case iro_Proj:
                pred = get_Proj_pred(node);
 
-               op = get_irn_op(pred);
-               if (op == op_Proj) {
+               opcode = get_irn_opcode(pred);
+               if (opcode == iro_Proj) {
                        ir_node *start = get_Proj_pred(pred);
 
                        if (is_Start(start)) {
@@ -83,7 +84,7 @@ static void collect_data(ir_node *node, void *env) {
                                        data->proj_data = node;
                                }
                        }
-               } else if (op == op_Start) {
+               } else if (opcode == iro_Start) {
                        if (get_Proj_proj(node) == pn_Start_X_initial_exec) {
                                /* found ProjX(Start) */
                                data->proj_X = node;
@@ -96,7 +97,7 @@ static void collect_data(ir_node *node, void *env) {
                /*
                 * the first block has the initial exec as cfg predecessor
                 */
-               if (node != get_irg_start_block(current_ir_graph)) {
+               if (node != get_irg_start_block(get_irn_irg(node))) {
                        for (i = 0; i < n_pred; ++i) {
                                if (get_Block_cfgpred(node, i) == data->proj_X) {
                                        data->block   = node;
@@ -131,11 +132,11 @@ typedef struct tr_env {
 /**
  * do the graph reconstruction for tail-recursion elimination
  *
- * @param irg           the graph that will reconstructed
- * @param rets          linked list of all rets
- * @param n_tail_calls  number of tail-recursion calls
+ * @param irg  the graph that will reconstructed
+ * @param env  tail recursion environment
  */
-static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
+static void do_opt_tail_rec(ir_graph *irg, tr_env *env)
+{
        ir_node *end_block = get_irg_end_block(irg);
        ir_node *block, *jmp, *call, *calls;
        ir_node **in;
@@ -147,9 +148,6 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
        int rem            = get_optimize();
        ir_entity *ent     = get_irg_entity(irg);
        ir_type *method_tp = get_entity_type(ent);
-       ir_graph *old      = current_ir_graph;
-
-       current_ir_graph = irg;
 
        assert(env->n_tail_calls > 0);
 
@@ -178,7 +176,7 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
        irg_walk_graph(irg, NULL, collect_data, &data);
 
        /* check number of arguments */
-       call get_irn_link(end_block);
+       call     = (ir_node*)get_irn_link(end_block);
        n_params = get_Call_n_params(call);
 
        assert(data.proj_X && "Could not find initial exec from Start");
@@ -189,13 +187,15 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
        /* allocate in's for phi and block construction */
        NEW_ARR_A(ir_node *, in, env->n_tail_calls + 1);
 
-       in[0] = data.proj_X;
+       /* build a new header block for the loop we create */
+       i = 0;
+       in[i++] = data.proj_X;
 
        /* turn Return's into Jmp's */
-       for (i = 1, p = env->rets; p; p = n) {
+       for (p = env->rets; p; p = n) {
                ir_node *block = get_nodes_block(p);
 
-               n = get_irn_link(p);
+               n = (ir_node*)get_irn_link(p);
                in[i++] = new_r_Jmp(block);
 
                // exchange(p, new_r_Bad(irg));
@@ -204,9 +204,10 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
                 * the block to the keep-alive list */
                add_End_keepalive(get_irg_end(irg), block);
        }
+       assert(i == env->n_tail_calls + 1);
 
-       /* create a new block at start */
-       block = new_r_Block(irg, env->n_tail_calls + 1, in);
+       /* now create it */
+       block = new_r_Block(irg, i, in);
        jmp   = new_r_Jmp(block);
 
        /* the old first block is now the second one */
@@ -217,11 +218,11 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
 
        /* build the memory phi */
        i = 0;
-       in[i] = new_r_Proj(get_irg_start_block(irg), get_irg_start(irg), mode_M, pn_Start_M);
+       in[i] = new_r_Proj(get_irg_start(irg), mode_M, pn_Start_M);
        set_irg_initial_mem(irg, in[i]);
        ++i;
 
-       for (calls = call; calls; calls = get_irn_link(calls)) {
+       for (calls = call; calls != NULL; calls = (ir_node*)get_irn_link(calls)) {
                in[i] = get_Call_mem(calls);
                ++i;
        }
@@ -238,7 +239,8 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
                NEW_ARR_A(ir_node **, call_params, env->n_tail_calls);
 
                /* collect all parameters */
-               for (i = 0, calls = call; calls; calls = get_irn_link(calls)) {
+               for (i = 0, calls = call; calls != NULL;
+                    calls = (ir_node*)get_irn_link(calls)) {
                        call_params[i] = get_Call_param_arr(calls);
                        ++i;
                }
@@ -249,7 +251,7 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
                for (i = 0; i < n_params; ++i) {
                        ir_mode *mode = get_type_mode(get_method_param_type(method_tp, i));
 
-                       in[0] = new_r_Proj(args_bl, args, mode, i);
+                       in[0] = new_r_Proj(args, mode, i);
                        for (j = 0; j < env->n_tail_calls; ++j)
                                in[j + 1] = call_params[j][i];
 
@@ -266,7 +268,7 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
                long proj = get_Proj_proj(p);
 
                assert(0 <= proj && proj < n_params);
-               n = get_irn_link(p);
+               n = (ir_node*)get_irn_link(p);
                exchange(p, phis[proj + 1]);
        }
 
@@ -274,7 +276,7 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
        set_irg_doms_inconsistent(irg);
        set_irg_outs_inconsistent(irg);
        set_irg_extblk_inconsistent(irg);
-       set_irg_loopinfo_state(current_ir_graph, loopinfo_cf_inconsistent);
+       set_irg_loopinfo_state(irg, loopinfo_cf_inconsistent);
        set_trouts_inconsistent();
        set_irg_callee_info_state(irg, irg_callee_info_inconsistent);
 
@@ -283,44 +285,45 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
        /* check if we need new values */
        n_locs = 0;
        for (i = 0; i < env->n_ress; ++i) {
-               if (env->variants[i] != TR_DIRECT)
+               if (env->variants[i] != TR_DIRECT) {
                        ++n_locs;
+                       break;
+               }
        }
 
        if (n_locs > 0) {
-               ir_node *bad, *start_block;
+               ir_node *start_block;
                ir_node **in;
                ir_mode **modes;
 
-               NEW_ARR_A(ir_node *, in, n_locs);
-               NEW_ARR_A(ir_mode *, modes, n_locs);
-               ssa_cons_start(irg, n_locs);
+               NEW_ARR_A(ir_node *, in, env->n_ress);
+               NEW_ARR_A(ir_mode *, modes, env->n_ress);
+               ssa_cons_start(irg, env->n_ress);
 
                start_block = get_irg_start_block(irg);
-               set_cur_block(start_block);
+               set_r_cur_block(irg, start_block);
 
+               /* set the neutral elements for the iteration start */
                for (i = 0; i < env->n_ress; ++i) {
                        ir_type *tp = get_method_res_type(method_tp, i);
                        ir_mode *mode = get_type_mode(tp);
 
                        modes[i] = mode;
                        if (env->variants[i] == TR_ADD) {
-                               set_value(i, new_Const(get_mode_null(mode)));
+                               set_r_value(irg, i, new_r_Const(irg, get_mode_null(mode)));
                        } else if (env->variants[i] == TR_MUL) {
-                               set_value(i, new_Const(get_mode_one(mode)));
+                               set_r_value(irg, i, new_r_Const(irg, get_mode_one(mode)));
                        }
                }
                mature_immBlock(start_block);
 
                /* no: we can kill all returns */
-               bad = get_irg_bad(irg);
-
                for (p = env->rets; p; p = n) {
                        ir_node *block = get_nodes_block(p);
                        ir_node *call, *mem, *jmp, *tuple;
 
-                       set_cur_block(block);
-                       n = get_irn_link(p);
+                       set_r_cur_block(irg, block);
+                       n = (ir_node*)get_irn_link(p);
 
                        call = skip_Proj(get_Return_mem(p));
                        assert(is_Call(call));
@@ -329,47 +332,48 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
 
                        /* create a new jump, free of CSE */
                        set_optimize(0);
-                       jmp = new_Jmp();
+                       jmp = new_r_Jmp(block);
                        set_optimize(rem);
 
                        for (i = 0; i < env->n_ress; ++i) {
+                               ir_mode *mode = modes[i];
                                if (env->variants[i] != TR_DIRECT) {
-                                       in[i] = get_value(i, modes[i]);
+                                       in[i] = get_r_value(irg, i, mode);
                                } else {
-                                       in[i] = bad;
+                                       in[i] = new_r_Bad(irg, mode);
                                }
                        }
                        /* create a new tuple for the return values */
-                       tuple = new_Tuple(env->n_ress, in);
+                       tuple = new_r_Tuple(block, env->n_ress, in);
 
                        turn_into_tuple(call, pn_Call_max);
-                       set_Tuple_pred(call, pn_Call_M,                mem);
-                       set_Tuple_pred(call, pn_Call_X_regular,        jmp);
-                       set_Tuple_pred(call, pn_Call_X_except,         bad);
-                       set_Tuple_pred(call, pn_Call_T_result,         tuple);
-                       set_Tuple_pred(call, pn_Call_M_except,         mem);
-                       set_Tuple_pred(call, pn_Call_P_value_res_base, bad);
+                       set_Tuple_pred(call, pn_Call_M,         mem);
+                       set_Tuple_pred(call, pn_Call_X_regular, jmp);
+                       set_Tuple_pred(call, pn_Call_X_except,  new_r_Bad(irg, mode_X));
+                       set_Tuple_pred(call, pn_Call_T_result,  tuple);
 
                        for (i = 0; i < env->n_ress; ++i) {
                                ir_node *res = get_Return_res(p, i);
                                if (env->variants[i] != TR_DIRECT) {
-                                       set_value(i, res);
+                                       set_r_value(irg, i, res);
                                }
                        }
 
-                       exchange(p, bad);
+                       exchange(p, new_r_Bad(irg, mode_X));
                }
 
                /* finally fix all other returns */
                end_block = get_irg_end_block(irg);
                for (i = get_Block_n_cfgpreds(end_block) - 1; i >= 0; --i) {
                        ir_node *ret = get_Block_cfgpred(end_block, i);
+                       ir_node *block;
 
                        /* search all Returns of a block */
                        if (! is_Return(ret))
                                continue;
 
-                       set_cur_block(get_nodes_block(ret));
+                       block = get_nodes_block(ret);
+                       set_r_cur_block(irg, block);
                        for (j = 0; j < env->n_ress; ++j) {
                                ir_node *pred = get_Return_res(ret, j);
                                ir_node *n;
@@ -379,14 +383,14 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
                                        continue;
 
                                case TR_ADD:
-                                       n = get_value(j, modes[j]);
-                                       n = new_Add(n, pred, modes[j]);
+                                       n = get_r_value(irg, j, modes[j]);
+                                       n = new_r_Add(block, n, pred, modes[j]);
                                        set_Return_res(ret, j, n);
                                        break;
 
                                case TR_MUL:
-                                       n = get_value(j, modes[j]);
-                                       n = new_Mul(n, pred, modes[j]);
+                                       n = get_r_value(irg, j, modes[j]);
+                                       n = new_r_Mul(block, n, pred, modes[j]);
                                        set_Return_res(ret, j, n);
                                        break;
 
@@ -397,15 +401,14 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
                }
                ssa_cons_finish(irg);
        } else {
-               ir_node *bad = get_irg_bad(irg);
+               ir_node *bad = new_r_Bad(irg, mode_X);
 
                /* no: we can kill all returns */
                for (p = env->rets; p; p = n) {
-                       n = get_irn_link(p);
+                       n = (ir_node*)get_irn_link(p);
                        exchange(p, bad);
                }
        }
-       current_ir_graph = old;
 }
 
 /**
@@ -417,7 +420,8 @@ static void do_opt_tail_rec(ir_graph *irg, tr_env *env) {
  *
  * @return non-zero if it's ok to do tail recursion
  */
-static int check_lifetime_of_locals(ir_graph *irg) {
+static int check_lifetime_of_locals(ir_graph *irg)
+{
        ir_node *irg_frame;
        int i;
        ir_type *frame_tp = get_irg_frame_type(irg);
@@ -442,7 +446,8 @@ static int check_lifetime_of_locals(ir_graph *irg) {
 /**
  * Examine irn and detect the recursion variant.
  */
-static tail_rec_variants find_variant(ir_node *irn, ir_node *call) {
+static tail_rec_variants find_variant(ir_node *irn, ir_node *call)
+{
        ir_node           *a, *b;
        tail_rec_variants va, vb, res;
 
@@ -454,7 +459,7 @@ static tail_rec_variants find_variant(ir_node *irn, ir_node *call) {
        case iro_Add:
                /* try additive */
                a = get_Add_left(irn);
-               if (get_irn_MacroBlock(a) != get_irn_MacroBlock(call)) {
+               if (get_nodes_block(a) != get_nodes_block(call)) {
                        /* we are outside, ignore */
                        va = TR_UNKNOWN;
                } else {
@@ -463,7 +468,7 @@ static tail_rec_variants find_variant(ir_node *irn, ir_node *call) {
                                return TR_BAD;
                }
                b = get_Add_right(irn);
-               if (get_irn_MacroBlock(b) != get_irn_MacroBlock(call)) {
+               if (get_nodes_block(b) != get_nodes_block(call)) {
                        /* we are outside, ignore */
                        vb = TR_UNKNOWN;
                } else {
@@ -490,7 +495,7 @@ static tail_rec_variants find_variant(ir_node *irn, ir_node *call) {
        case iro_Sub:
                /* try additive, but return value must be left */
                a = get_Sub_left(irn);
-               if (get_irn_MacroBlock(a) != get_irn_MacroBlock(call)) {
+               if (get_nodes_block(a) != get_nodes_block(call)) {
                        /* we are outside, ignore */
                        va = TR_UNKNOWN;
                } else {
@@ -499,7 +504,7 @@ static tail_rec_variants find_variant(ir_node *irn, ir_node *call) {
                                return TR_BAD;
                }
                b = get_Sub_right(irn);
-               if (get_irn_MacroBlock(b) != get_irn_MacroBlock(call)) {
+               if (get_nodes_block(b) != get_nodes_block(call)) {
                        /* we are outside, ignore */
                        vb = TR_UNKNOWN;
                } else {
@@ -516,7 +521,7 @@ static tail_rec_variants find_variant(ir_node *irn, ir_node *call) {
        case iro_Mul:
                /* try multiplicative */
                a = get_Mul_left(irn);
-               if (get_irn_MacroBlock(a) != get_irn_MacroBlock(call)) {
+               if (get_nodes_block(a) != get_nodes_block(call)) {
                        /* we are outside, ignore */
                        va = TR_UNKNOWN;
                } else {
@@ -525,7 +530,7 @@ static tail_rec_variants find_variant(ir_node *irn, ir_node *call) {
                                return TR_BAD;
                }
                b = get_Mul_right(irn);
-               if (get_irn_MacroBlock(b) != get_irn_MacroBlock(call)) {
+               if (get_nodes_block(b) != get_nodes_block(call)) {
                        /* we are outside, ignore */
                        vb = TR_UNKNOWN;
                } else {
@@ -569,23 +574,29 @@ static tail_rec_variants find_variant(ir_node *irn, ir_node *call) {
 /*
  * convert simple tail-calls into loops
  */
-int opt_tail_rec_irg(ir_graph *irg) {
+int opt_tail_rec_irg(ir_graph *irg)
+{
        tr_env            env;
        ir_node           *end_block;
        int               i, n_ress, n_tail_calls = 0;
        ir_node           *rets = NULL;
        ir_type           *mtd_type, *call_type;
        ir_entity         *ent;
+       ir_graph          *rem;
+
+       FIRM_DBG_REGISTER(dbg, "firm.opt.tailrec");
 
        assure_irg_outs(irg);
 
        if (! check_lifetime_of_locals(irg))
                return 0;
 
+       rem = current_ir_graph;
+       current_ir_graph = irg;
 
        ent      = get_irg_entity(irg);
        mtd_type = get_entity_type(ent);
-    n_ress   = get_method_n_ress(mtd_type);
+       n_ress   = get_method_n_ress(mtd_type);
 
        env.variants = NULL;
        env.n_ress   = n_ress;
@@ -603,6 +614,8 @@ int opt_tail_rec_irg(ir_graph *irg) {
         */
        normalize_n_returns(irg);
 
+       ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
+
        end_block = get_irg_end_block(irg);
        set_irn_link(end_block, NULL);
 
@@ -648,11 +661,7 @@ int opt_tail_rec_irg(ir_graph *irg) {
                         * This can happen in C when no prototype is given
                         * or K&R style is used.
                         */
-#if 0
-                       printf("Warning: Tail recursion fails because of different method and call types:\n");
-                       dump_type(mtd_type);
-                       dump_type(call_type);
-#endif
+                       DB((dbg, LEVEL_3, "  tail recursion fails because of call type mismatch: %+F != %+F\n", mtd_type, call_type));
                        continue;
                }
 
@@ -671,6 +680,7 @@ int opt_tail_rec_irg(ir_graph *irg) {
                                env.variants[j] = var;
                        if (env.variants[j] != var) {
                                /* not compatible */
+                               DB((dbg, LEVEL_3, "  tail recursion fails for %d return value of %+F\n", j, ret));
                                break;
                        }
                }
@@ -688,53 +698,49 @@ int opt_tail_rec_irg(ir_graph *irg) {
        }
 
        /* now, end_block->link contains the list of all tail calls */
-       if (n_tail_calls <= 0)
-               return 0;
-
-       DB((dbg, LEVEL_2, "  Performing tail recursion for graph %s and %d Calls\n",
-           get_entity_ld_name(get_irg_entity(irg)), n_tail_calls));
+       if (n_tail_calls > 0) {
+               DB((dbg, LEVEL_2, "  Performing tail recursion for graph %s and %d Calls\n",
+                   get_entity_ld_name(get_irg_entity(irg)), n_tail_calls));
 
-       hook_tail_rec(irg, n_tail_calls);
-
-       env.n_tail_calls = n_tail_calls;
-       env.rets         = rets;
-       do_opt_tail_rec(irg, &env);
+               hook_tail_rec(irg, n_tail_calls);
 
+               env.n_tail_calls = n_tail_calls;
+               env.rets         = rets;
+               do_opt_tail_rec(irg, &env);
+       }
+       ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
+       current_ir_graph = rem;
        return n_tail_calls;
 }
 
-ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name, int verify, int dump)
+ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name)
 {
-       return def_graph_pass_ret(name ? name : "tailrec", verify, dump, opt_tail_rec_irg);
+       return def_graph_pass_ret(name ? name : "tailrec", opt_tail_rec_irg);
 }
 
 /*
  * optimize tail recursion away
  */
-void opt_tail_recursion(void) {
-       int i;
-       int n_opt_applications = 0;
-       ir_graph *irg;
+void opt_tail_recursion(void)
+{
+       size_t i, n;
+       size_t n_opt_applications = 0;
 
        FIRM_DBG_REGISTER(dbg, "firm.opt.tailrec");
 
-       for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
-               irg = get_irp_irg(i);
-
-               current_ir_graph = irg;
+       DB((dbg, LEVEL_1, "Performing tail recursion ...\n"));
+       for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
+               ir_graph *irg = get_irp_irg(i);
 
-               ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
                if (opt_tail_rec_irg(irg))
                        ++n_opt_applications;
-
-               ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
        }
 
-       DB((dbg, LEVEL_1, "Performed tail recursion for %d of %d graphs\n",
+       DB((dbg, LEVEL_1, "Done for %zu of %zu graphs.\n",
            n_opt_applications, get_irp_n_irgs()));
 }
 
-ir_prog_pass_t *opt_tail_recursion_pass(const char *name, int verify, int dump)
+ir_prog_pass_t *opt_tail_recursion_pass(const char *name)
 {
-       return def_prog_pass(name ? name : "tailrec", verify, dump, opt_tail_recursion);
+       return def_prog_pass(name ? name : "tailrec", opt_tail_recursion);
 }