switch scalar replacement to new style debug output
[libfirm] / ir / opt / opt_inline.c
index 990a324..0fd8328 100644 (file)
@@ -50,6 +50,7 @@
 #include "irouts.h"
 #include "irloop_t.h"
 #include "irbackedge_t.h"
+#include "opt_inline_t.h"
 #include "cgana.h"
 #include "trouts.h"
 #include "error.h"
@@ -60,6 +61,7 @@
 #include "irhooks.h"
 #include "irtools.h"
 
+DEBUG_ONLY(static firm_dbg_module_t *dbg;)
 
 /*------------------------------------------------------------------*/
 /* Routines for dead node elimination / copying garbage collection  */
@@ -1137,6 +1139,8 @@ int inline_method(ir_node *call, ir_graph *called_graph) {
 /* Apply inlineing to small methods.                                */
 /********************************************************************/
 
+static struct obstack  temp_obst;
+
 /** Represents a possible inlinable call in a graph. */
 typedef struct _call_entry call_entry;
 struct _call_entry {
@@ -1210,9 +1214,6 @@ void inline_small_irgs(ir_graph *irg, int size) {
   ir_graph *rem = current_ir_graph;
        inline_env_t env;
        call_entry *entry;
-       DEBUG_ONLY(firm_dbg_module_t *dbg;)
-
-       FIRM_DBG_REGISTER(dbg, "firm.opt.inline");
 
        current_ir_graph = irg;
        /* Handle graph state */
@@ -1229,15 +1230,23 @@ void inline_small_irgs(ir_graph *irg, int size) {
        irg_walk_graph(irg, NULL, collect_calls, &env);
 
        if (env.head != NULL) {
+               int did_inline = 0;
+
                /* There are calls to inline */
                collect_phiprojs(irg);
                for (entry = env.head; entry != NULL; entry = entry->next) {
                        ir_graph *callee = entry->callee;
                        if (((_obstack_memory_used(callee->obst) - (int)obstack_room(callee->obst)) < size) ||
                            (get_irg_inline_property(callee) >= irg_inline_forced)) {
-                               inline_method(entry->call, callee);
+                               did_inline |= inline_method(entry->call, callee);
                        }
                }
+               if (did_inline != 0) {
+                       /* this irg got calls inlined */
+                       set_irg_outs_inconsistent(irg);
+                       set_irg_doms_inconsistent(irg);
+                       set_irg_loopinfo_inconsistent(irg);
+               }
        }
        obstack_free(&env.obst, NULL);
        current_ir_graph = rem;
@@ -1256,14 +1265,16 @@ typedef struct {
        int n_call_nodes_orig;   /**< for statistics */
        int n_callers;           /**< Number of known graphs that call this graphs. */
        int n_callers_orig;      /**< for statistics */
-       int got_inline;          /**< Set, if at leat one call inside this graph was inlined. */
+       unsigned got_inline:1;   /**< Set, if at least one call inside this graph was inlined. */
+       unsigned local_vars:1;   /**< Set, if a inlined function gets the address of an inlined variable. */
+       unsigned *local_weights; /**< Once allocated, the beneficial weight for transmitting local addresses. */
 } inline_irg_env;
 
 /**
  * Allocate a new environment for inlining.
  */
-static inline_irg_env *alloc_inline_irg_env(struct obstack *obst) {
-       inline_irg_env *env    = obstack_alloc(obst, sizeof(*env));
+static inline_irg_env *alloc_inline_irg_env(void) {
+       inline_irg_env *env    = obstack_alloc(&temp_obst, sizeof(*env));
        env->n_nodes           = -2; /* do not count count Start, End */
        env->n_blocks          = -2; /* do not count count Start, End Block */
        env->n_nodes_orig      = -2; /* do not count Start, End */
@@ -1274,11 +1285,12 @@ static inline_irg_env *alloc_inline_irg_env(struct obstack *obst) {
        env->n_callers         = 0;
        env->n_callers_orig    = 0;
        env->got_inline        = 0;
+       env->local_vars        = 0;
+       env->local_weights     = NULL;
        return env;
 }
 
 typedef struct walker_env {
-       struct obstack *obst; /**< the obstack for allocations. */
        inline_irg_env *x;    /**< the inline environment */
        char ignore_runtime;  /**< the ignore runtime flag */
        char ignore_callers;  /**< if set, do change callers data */
@@ -1333,7 +1345,7 @@ static void collect_calls2(ir_node *call, void *ctx) {
                }
 
                /* link it in the list of possible inlinable entries */
-               entry = obstack_alloc(env->obst, sizeof(*entry));
+               entry = obstack_alloc(&temp_obst, sizeof(*entry));
                entry->call   = call;
                entry->callee = callee;
                entry->next   = NULL;
@@ -1366,14 +1378,14 @@ INLINE static int is_smaller(ir_graph *callee, int size) {
 /**
  * Append the nodes of the list src to the nodes of the list in environment dst.
  */
-static void append_call_list(struct obstack *obst, inline_irg_env *dst, call_entry *src) {
+static void append_call_list(inline_irg_env *dst, call_entry *src) {
        call_entry *entry, *nentry;
 
        /* Note that the src list points to Call nodes in the inlined graph, but
           we need Call nodes in our graph. Luckily the inliner leaves this information
           in the link field. */
        for (entry = src; entry != NULL; entry = entry->next) {
-               nentry = obstack_alloc(obst, sizeof(*nentry));
+               nentry = obstack_alloc(&temp_obst, sizeof(*nentry));
                nentry->call   = get_irn_link(entry->call);
                nentry->callee = entry->callee;
                nentry->next   = NULL;
@@ -1399,14 +1411,11 @@ void inline_leave_functions(int maxsize, int leavesize, int size, int ignore_run
        wenv_t           wenv;
        call_entry       *entry, *tail;
        const call_entry *centry;
-       struct obstack   obst;
        pmap             *copied_graphs;
        pmap_entry       *pm_entry;
-       DEBUG_ONLY(firm_dbg_module_t *dbg;)
 
-       FIRM_DBG_REGISTER(dbg, "firm.opt.inline");
        rem = current_ir_graph;
-       obstack_init(&obst);
+       obstack_init(&temp_obst);
 
        /* a map for the copied graphs, used to inline recursive calls */
        copied_graphs = pmap_create();
@@ -1414,10 +1423,9 @@ void inline_leave_functions(int maxsize, int leavesize, int size, int ignore_run
        /* extend all irgs by a temporary data structure for inlining. */
        n_irgs = get_irp_n_irgs();
        for (i = 0; i < n_irgs; ++i)
-               set_irg_link(get_irp_irg(i), alloc_inline_irg_env(&obst));
+               set_irg_link(get_irp_irg(i), alloc_inline_irg_env());
 
        /* Precompute information in temporary data structure. */
-       wenv.obst           = &obst;
        wenv.ignore_runtime = ignore_runtime;
        wenv.ignore_callers = 0;
        for (i = 0; i < n_irgs; ++i) {
@@ -1535,7 +1543,7 @@ void inline_leave_functions(int maxsize, int leavesize, int size, int ignore_run
                                        phiproj_computed = 0;
 
                                        /* allocate new environment */
-                                       callee_env = alloc_inline_irg_env(&obst);
+                                       callee_env = alloc_inline_irg_env();
                                        set_irg_link(copy, callee_env);
 
                                        wenv.x              = callee_env;
@@ -1570,7 +1578,7 @@ void inline_leave_functions(int maxsize, int leavesize, int size, int ignore_run
                                        /* callee was inline. Append it's call list. */
                                        env->got_inline = 1;
                                        --env->n_call_nodes;
-                                       append_call_list(&obst, env, callee_env->call_head);
+                                       append_call_list(env, callee_env->call_head);
                                        env->n_call_nodes += callee_env->n_call_nodes;
                                        env->n_nodes += callee_env->n_nodes;
                                        --callee_env->n_callers;
@@ -1603,6 +1611,7 @@ void inline_leave_functions(int maxsize, int leavesize, int size, int ignore_run
                        /* this irg got calls inlined */
                        set_irg_outs_inconsistent(irg);
                        set_irg_doms_inconsistent(irg);
+                       set_irg_loopinfo_inconsistent(irg);
 
                        optimize_graph_df(irg);
                        optimize_cf(irg);
@@ -1625,19 +1634,132 @@ void inline_leave_functions(int maxsize, int leavesize, int size, int ignore_run
        }
        pmap_destroy(copied_graphs);
 
-       obstack_free(&obst, NULL);
+       obstack_free(&temp_obst, NULL);
        current_ir_graph = rem;
 }
 
+/**
+ * Calculate the parameter weights for transmitting the address of a local variable.
+ */
+static unsigned calc_method_local_weight(ir_node *arg) {
+       int      i, j, k;
+       unsigned v, weight = 0;
+
+       for (i = get_irn_n_outs(arg) - 1; i >= 0; --i) {
+               ir_node *succ = get_irn_out(arg, i);
+
+               switch (get_irn_opcode(succ)) {
+               case iro_Load:
+               case iro_Store:
+                       /* Loads and Store can be removed */
+                       weight += 3;
+                       break;
+               case iro_Sel:
+                       /* check if all args are constant */
+                       for (j = get_Sel_n_indexs(succ) - 1; j >= 0; --j) {
+                               ir_node *idx = get_Sel_index(succ, j);
+                               if (! is_Const(idx))
+                                       return 0;
+                       }
+                       /* Check users on this Sel. Note: if a 0 is returned here, there was
+                          some unsupported node. */
+                       v = calc_method_local_weight(succ);
+                       if (v == 0)
+                               return 0;
+                       /* we can kill one Sel with constant indexes, this is cheap */
+                       weight += v + 1;
+                       break;
+               case iro_Id:
+                       /* when looking backward we might find Id nodes */
+                       weight += calc_method_local_weight(succ);
+                       break;
+               case iro_Tuple:
+                       /* unoptimized tuple */
+                       for (j = get_Tuple_n_preds(succ) - 1; j >= 0; --j) {
+                               ir_node *pred = get_Tuple_pred(succ, j);
+                               if (pred == arg) {
+                                       /* look for Proj(j) */
+                                       for (k = get_irn_n_outs(succ) - 1; k >= 0; --k) {
+                                               ir_node *succ_succ = get_irn_out(succ, k);
+                                               if (is_Proj(succ_succ)) {
+                                                       if (get_Proj_proj(succ_succ) == j) {
+                                                               /* found */
+                                                               weight += calc_method_local_weight(succ_succ);
+                                                       }
+                                               } else {
+                                                       /* this should NOT happen */
+                                                       return 0;
+                                               }
+                                       }
+                               }
+                       }
+               default:
+                       /* any other node: unsupported yet or bad. */
+                       return 0;
+               }
+       }
+       return weight;
+}
+
+/**
+ * Calculate the parameter weights for transmitting the address of a local variable.
+ */
+static void analyze_irg_local_weights(inline_irg_env *env, ir_graph *irg) {
+       ir_entity *ent = get_irg_entity(irg);
+       ir_type  *mtp;
+       int      nparams, i, proj_nr;
+       ir_node  *irg_args, *arg;
+
+       mtp      = get_entity_type(ent);
+       nparams  = get_method_n_params(mtp);
+
+       /* allocate a new array. currently used as 'analysed' flag */
+       env->local_weights = NEW_ARR_D(unsigned, &temp_obst, nparams);
+
+       /* If the method haven't parameters we have nothing to do. */
+       if (nparams <= 0)
+               return;
+
+       assure_irg_outs(irg);
+       irg_args = get_irg_args(irg);
+       for (i = get_irn_n_outs(irg_args) - 1; i >= 0; --i) {
+               arg     = get_irn_out(irg_args, i);
+               proj_nr = get_Proj_proj(arg);
+               env->local_weights[proj_nr] = calc_method_local_weight(arg);
+       }
+}
+
+/**
+ * Calculate the benefice for transmitting an local variable address.
+ * After inlining, the local variable might be transformed into a
+ * SSA variable by scalar_replacement().
+ */
+static unsigned get_method_local_adress_weight(ir_graph *callee, int pos) {
+       inline_irg_env *env = get_irg_link(callee);
+
+       if (env->local_weights != NULL) {
+               if (pos < ARR_LEN(env->local_weights))
+                       return env->local_weights[pos];
+               return 0;
+       }
+
+       analyze_irg_local_weights(env, callee);
+
+       if (pos < ARR_LEN(env->local_weights))
+               return env->local_weights[pos];
+       return 0;
+}
+
 /**
  * calculate a benefice value for inlining the given call.
  */
-static int calc_inline_benefice(ir_node *call, ir_graph *callee) {
+static int calc_inline_benefice(ir_node *call, ir_graph *callee, unsigned *local_adr) {
        ir_entity *ent = get_irg_entity(callee);
+       ir_node   *frame_ptr;
        ir_type   *mtp;
        int       weight = 0;
        int       i, n_params;
-       unsigned  cc;
+       unsigned  cc, v;
 
        inline_irg_env *curr_env, *callee_env;
 
@@ -1664,15 +1786,29 @@ static int calc_inline_benefice(ir_node *call, ir_graph *callee) {
        }
 
        /* constant parameters improve the benefice */
+       frame_ptr = get_irg_frame(current_ir_graph);
        for (i = 0; i < n_params; ++i) {
                ir_node *param = get_Call_param(call, i);
 
                if (is_Const(param) || is_SymConst(param))
                        weight += get_method_param_weight(ent, i);
+               else if (is_Sel(param) && get_Sel_ptr(param) == frame_ptr) {
+                       /*
+                        * An address of a local variable is transmitted. After inlining,
+                        * scalar_replacement might be able to remove the local variable,
+                        * so honor this.
+                        */
+                       v = get_method_local_adress_weight(callee, i);
+                       weight += v;
+                       if (v > 0)
+                               *local_adr = 1;
+               }
        }
 
        callee_env = get_irg_link(callee);
-       if (callee_env->n_callers_orig == 1 && callee != current_ir_graph) {
+       if (get_entity_visibility(ent) == visibility_local &&
+           callee_env->n_callers_orig == 1 &&
+           callee != current_ir_graph) {
                /* we are the only caller, give big bonus */
                weight += 5000;
        }
@@ -1704,14 +1840,11 @@ void inline_functions(int inline_threshold) {
        wenv_t           wenv;
        call_entry       *entry, *tail;
        const call_entry *centry;
-       struct obstack   obst;
        pmap             *copied_graphs;
        pmap_entry       *pm_entry;
-       DEBUG_ONLY(firm_dbg_module_t *dbg;)
 
-       FIRM_DBG_REGISTER(dbg, "firm.opt.inline");
        rem = current_ir_graph;
-       obstack_init(&obst);
+       obstack_init(&temp_obst);
 
        /* a map for the copied graphs, used to inline recursive calls */
        copied_graphs = pmap_create();
@@ -1719,10 +1852,9 @@ void inline_functions(int inline_threshold) {
        /* extend all irgs by a temporary data structure for inlining. */
        n_irgs = get_irp_n_irgs();
        for (i = 0; i < n_irgs; ++i)
-               set_irg_link(get_irp_irg(i), alloc_inline_irg_env(&obst));
+               set_irg_link(get_irp_irg(i), alloc_inline_irg_env());
 
        /* Precompute information in temporary data structure. */
-       wenv.obst           = &obst;
        wenv.ignore_runtime = 0;
        wenv.ignore_callers = 0;
        for (i = 0; i < n_irgs; ++i) {
@@ -1749,10 +1881,16 @@ void inline_functions(int inline_threshold) {
                        ir_graph   *callee;
                        pmap_entry *e;
                        int        benefice;
+                       unsigned   local_adr;
 
                        call   = entry->call;
                        callee = entry->callee;
 
+                       /* calculate the benifice on the original call to prevent excessive inlining */
+                       local_adr = 0;
+                       benefice = calc_inline_benefice(call, callee, &local_adr);
+                       DB((dbg, SET_LEVEL_2, "In %+F Call %+F has benefice %d\n", current_ir_graph, callee, benefice));
+
                        e = pmap_find(copied_graphs, callee);
                        if (e != NULL) {
                                /*
@@ -1762,10 +1900,7 @@ void inline_functions(int inline_threshold) {
                                callee = e->value;
                        }
 
-                       benefice = calc_inline_benefice(call, callee);
-                       DB((dbg, SET_LEVEL_2, "In %+F Call %+F has benefice %d\n", current_ir_graph, callee, benefice));
-
-                       if (benefice > inline_threshold ||
+                       if (benefice > -inline_threshold ||
                                (get_irg_inline_property(callee) >= irg_inline_forced)) {
                                if (current_ir_graph == callee) {
                                        /*
@@ -1788,7 +1923,7 @@ void inline_functions(int inline_threshold) {
                                        phiproj_computed = 0;
 
                                        /* allocate new environment */
-                                       callee_env = alloc_inline_irg_env(&obst);
+                                       callee_env = alloc_inline_irg_env();
                                        set_irg_link(copy, callee_env);
 
                                        wenv.x              = callee_env;
@@ -1822,8 +1957,10 @@ void inline_functions(int inline_threshold) {
 
                                        /* callee was inline. Append it's call list. */
                                        env->got_inline = 1;
+                                       if (local_adr)
+                                               env->local_vars = 1;
                                        --env->n_call_nodes;
-                                       append_call_list(&obst, env, callee_env->call_head);
+                                       append_call_list(env, callee_env->call_head);
                                        env->n_call_nodes += callee_env->n_call_nodes;
                                        env->n_nodes += callee_env->n_nodes;
                                        --callee_env->n_callers;
@@ -1856,7 +1993,10 @@ void inline_functions(int inline_threshold) {
                        /* this irg got calls inlined */
                        set_irg_outs_inconsistent(irg);
                        set_irg_doms_inconsistent(irg);
+                       set_irg_loopinfo_inconsistent(irg);
 
+                       if (env->local_vars)
+                               scalar_replacement_opt(irg);
                        optimize_graph_df(irg);
                        optimize_cf(irg);
                }
@@ -1878,6 +2018,10 @@ void inline_functions(int inline_threshold) {
        }
        pmap_destroy(copied_graphs);
 
-       obstack_free(&obst, NULL);
+       obstack_free(&temp_obst, NULL);
        current_ir_graph = rem;
 }
+
+void firm_init_inline(void) {
+       FIRM_DBG_REGISTER(dbg, "firm.opt.inline");
+}