simplify confusing entity/owner interfaces. There is no public way anymore to add...
[libfirm] / ir / opt / scalar_replace.c
index c25a84a..a9eec0a 100644 (file)
@@ -29,6 +29,7 @@
 
 #include "iroptimize.h"
 #include "scalar_replace.h"
+#include "opt_init.h"
 #include "irflag_t.h"
 #include "irouts.h"
 #include "set.h"
@@ -40,6 +41,7 @@
 #include "irgwalk.h"
 #include "irgmod.h"
 #include "irnode_t.h"
+#include "irpass.h"
 #include "irtools.h"
 #include "xmalloc.h"
 #include "debug.h"
@@ -73,7 +75,6 @@ typedef struct _path_t {
 
 typedef struct _scalars_t {
        ir_entity *ent;              /**< A entity for scalar replacement. */
-       ir_type *ent_owner;          /**< The owner of this entity. */
 } scalars_t;
 
 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
@@ -83,7 +84,8 @@ DEBUG_ONLY(static firm_dbg_module_t *dbg;)
  *
  * @return 0 if they are identically
  */
-static int path_cmp(const void *elt, const void *key, size_t size) {
+static int path_cmp(const void *elt, const void *key, size_t size)
+{
        const path_t *p1 = elt;
        const path_t *p2 = key;
        (void) size;
@@ -97,7 +99,8 @@ static int path_cmp(const void *elt, const void *key, size_t size) {
  *
  * @return 0 if they are identically
  */
-static int ent_cmp(const void *elt, const void *key, size_t size) {
+static int ent_cmp(const void *elt, const void *key, size_t size)
+{
        const scalars_t *c1 = elt;
        const scalars_t *c2 = key;
        (void) size;
@@ -108,7 +111,8 @@ static int ent_cmp(const void *elt, const void *key, size_t size) {
 /**
  * Calculate a hash value for a path.
  */
-static unsigned path_hash(const path_t *path) {
+static unsigned path_hash(const path_t *path)
+{
        unsigned hash = 0;
        unsigned i;
 
@@ -123,7 +127,8 @@ static unsigned path_hash(const path_t *path) {
  *
  * @param sel  the Sel node that will be checked
  */
-static int is_const_sel(ir_node *sel) {
+static int is_const_sel(ir_node *sel)
+{
        int i, n = get_Sel_n_indexs(sel);
 
        for (i = 0; i < n; ++i) {
@@ -152,7 +157,8 @@ static int is_const_sel(ir_node *sel) {
  * @param mode     the mode of the Load/Store
  * @param ent_mode the mode of the accessed entity
  */
-static int check_load_store_mode(ir_mode *mode, ir_mode *ent_mode) {
+static int check_load_store_mode(ir_mode *mode, ir_mode *ent_mode)
+{
        if (ent_mode != mode) {
                if (ent_mode == NULL ||
                    get_mode_size_bits(ent_mode) != get_mode_size_bits(mode) ||
@@ -211,9 +217,14 @@ int is_address_taken(ir_node *sel)
                        break;
 
                case iro_Sel: {
-                       /* Check the Sel successor of Sel */
-                       int res = is_address_taken(succ);
+                       int       res;
+                       ir_entity *entity = get_Sel_entity(succ);
+                       /* we can't handle unions correctly yet -> address taken */
+                       if (is_Union_type(get_entity_owner(entity)))
+                               return 1;
 
+                       /* Check the Sel successor of Sel */
+                       res = is_address_taken(succ);
                        if (res)
                                return 1;
                        break;
@@ -268,36 +279,35 @@ int is_address_taken(ir_node *sel)
  *
  * @param ent  the entity that will be scalar replaced
  * @param sel  a Sel node that selects some fields of this entity
- *
- * Uses the visited flag to mark already linked Sel nodes.
  */
-static void link_all_leave_sels(ir_entity *ent, ir_node *sel) {
-       int i, flag = 1;
+static int link_all_leave_sels(ir_entity *ent, ir_node *sel)
+{
+       int i, is_leave = 1;
 
        for (i = get_irn_n_outs(sel) - 1; i >= 0; --i) {
                ir_node *succ = get_irn_out(sel, i);
 
                if (is_Sel(succ)) {
+                       /* the current leave has further Sel's, no leave */
+                       is_leave = 0;
                        link_all_leave_sels(ent, succ);
-                       flag = 0;
+               } else if (is_Id(succ)) {
+                       is_leave &= link_all_leave_sels(ent, succ);
                }
        }
 
-       if (flag) {
-               /* if Sel nodes with memory inputs are used, a entity can be
-                * visited more than once causing a ring here, so we use the
-                * node flag to mark linked nodes
-                */
-               if (irn_visited_else_mark(sel))
-                       return;
+       if (is_leave) {
+               /* beware of Id's */
+               sel = skip_Id(sel);
 
                /* we know we are at a leave, because this function is only
-                * called if the address is NOT taken, so succ must be a Load
-                * or a Store node
+                * called if the address is NOT taken, so sel's successor(s)
+                * must be Loads or Stores
                 */
                set_irn_link(sel, get_entity_link(ent));
                set_entity_link(ent, sel);
        }
+       return is_leave;
 }
 
 /* we need a special address that serves as an address taken marker */
@@ -318,15 +328,13 @@ static void *ADDRESS_TAKEN = &_x;
  * @return  non-zero if at least one entity could be replaced
  *          potentially
  */
-static int find_possible_replacements(ir_graph *irg) {
+static int find_possible_replacements(ir_graph *irg)
+{
        ir_node *irg_frame;
        ir_type *frame_tp;
-       int     i;
+       int     i, j, k, static_link_arg;
        int     res = 0;
 
-       ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
-       inc_irg_visited(irg);
-
        /*
         * First, clear the link field of all interesting entities.
         */
@@ -336,6 +344,38 @@ static int find_possible_replacements(ir_graph *irg) {
                set_entity_link(ent, NULL);
        }
 
+       /* check for inner functions:
+        * FIXME: need a way to get the argument position for the static link */
+       static_link_arg = 0;
+       for (i = get_class_n_members(frame_tp) - 1; i >= 0; --i) {
+               ir_entity *ent = get_class_member(frame_tp, i);
+               if (is_method_entity(ent)) {
+                       ir_graph *inner_irg = get_entity_irg(ent);
+                       ir_node  *args;
+
+                       assure_irg_outs(inner_irg);
+                       args = get_irg_args(inner_irg);
+                       for (j = get_irn_n_outs(args) - 1; j >= 0; --j) {
+                               ir_node *arg = get_irn_out(args, j);
+
+                               if (get_Proj_proj(arg) == static_link_arg) {
+                                       for (k = get_irn_n_outs(arg) - 1; k >= 0; --k) {
+                                               ir_node *succ = get_irn_out(arg, k);
+
+                                               if (is_Sel(succ)) {
+                                                       ir_entity *ent = get_Sel_entity(succ);
+
+                                                       if (get_entity_owner(ent) == frame_tp) {
+                                                               /* found an access to the outer frame */
+                                                               set_entity_link(ent, ADDRESS_TAKEN);
+                                                       }
+                                               }
+                                       }
+                               }
+                       }
+               }
+       }
+
        /*
         * Check the ir_graph for Sel nodes. If the entity of Sel
         * isn't a scalar replacement set the link of this entity
@@ -349,6 +389,11 @@ static int find_possible_replacements(ir_graph *irg) {
                        ir_entity *ent = get_Sel_entity(succ);
                        ir_type *ent_type;
 
+                       /* we are only interested in entities on the frame, NOT
+                          on the value type */
+                       if (get_entity_owner(ent) != frame_tp)
+                               continue;
+
                        if (get_entity_link(ent) == ADDRESS_TAKEN)
                                continue;
 
@@ -368,7 +413,8 @@ static int find_possible_replacements(ir_graph *irg) {
                        /* we can handle arrays, structs and atomic types yet */
                        if (is_Array_type(ent_type) || is_Struct_type(ent_type) || is_atomic_type(ent_type)) {
                                if (is_address_taken(succ)) {
-                                       if (get_entity_link(ent)) /* killing one */
+                                        /* killing one */
+                                       if (get_entity_link(ent))
                                                --res;
                                        set_entity_link(ent, ADDRESS_TAKEN);
                                } else {
@@ -381,7 +427,6 @@ static int find_possible_replacements(ir_graph *irg) {
                }
        }
 
-       ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
        return res;
 }
 
@@ -391,7 +436,8 @@ static int find_possible_replacements(ir_graph *irg) {
  * @param sel  the Sel node
  * @param len  the length of the path so far
  */
-static path_t *find_path(ir_node *sel, unsigned len) {
+static path_t *find_path(ir_node *sel, unsigned len)
+{
        int pos, i, n;
        path_t *res;
        ir_node *pred = get_Sel_ptr(sel);
@@ -508,7 +554,8 @@ typedef struct _env_t {
 /**
  * topological post-walker.
  */
-static void topologic_walker(ir_node *node, void *ctx) {
+static void topologic_walker(ir_node *node, void *ctx)
+{
        env_t        *env = ctx;
        ir_node      *adr, *block, *mem, *val;
        ir_mode      *mode;
@@ -579,13 +626,14 @@ static void topologic_walker(ir_node *node, void *ctx) {
 
                DB((dbg, SET_LEVEL_3, "replacing by value %u\n", vnum));
 
+               block = get_nodes_block(node);
+               set_cur_block(block);
+
                /* Beware: A Store can contain a hidden conversion in Firm. */
                val = get_Store_value(node);
                if (get_irn_mode(val) != env->modes[vnum])
                        val = new_d_Conv(get_irn_dbg_info(node), val, env->modes[vnum]);
 
-               block = get_nodes_block(node);
-               set_cur_block(block);
                set_value(vnum, val);
 
                mem = get_Store_mem(node);
@@ -604,7 +652,8 @@ static void topologic_walker(ir_node *node, void *ctx) {
  * @param modes   A flexible array, containing all the modes of
  *                the value numbers.
  */
-static void do_scalar_replacements(pset *sels, int nvals, ir_mode **modes) {
+static void do_scalar_replacements(pset *sels, int nvals, ir_mode **modes)
+{
        env_t env;
 
        ssa_cons_start(current_ir_graph, nvals);
@@ -628,7 +677,8 @@ static void do_scalar_replacements(pset *sels, int nvals, ir_mode **modes) {
  *
  * @param irg  The current ir graph.
  */
-int scalar_replacement_opt(ir_graph *irg) {
+int scalar_replacement_opt(ir_graph *irg)
+{
        unsigned  nvals;
        int       i;
        scalars_t key, *value;
@@ -636,29 +686,31 @@ int scalar_replacement_opt(ir_graph *irg) {
        ir_mode   **modes;
        set       *set_ent;
        pset      *sels;
-       ir_type   *ent_type;
+       ir_type   *ent_type, *frame_tp;
        ir_graph  *rem;
        int       res = 0;
 
-       if (! get_opt_scalar_replacement())
-               return 0;
-
        rem = current_ir_graph;
        current_ir_graph = irg;
 
        /* Call algorithm that computes the out edges */
        assure_irg_outs(irg);
 
+       /* we use the link field to store the VNUM */
+       ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
+       irp_reserve_resources(irp, IR_RESOURCE_ENTITY_LINK);
+
        /* Find possible scalar replacements */
        if (find_possible_replacements(irg)) {
-               DB((dbg, SET_LEVEL_1, "Scalar Replacement: %s\n", get_entity_name(get_irg_entity(irg))));
+               DB((dbg, SET_LEVEL_1, "Scalar Replacement: %+F\n", irg));
 
                /* Insert in set the scalar replacements. */
                irg_frame = get_irg_frame(irg);
-               nvals = 0;
-               modes = NEW_ARR_F(ir_mode *, 16);
-               set_ent = new_set(ent_cmp, 8);
-               sels    = pset_new_ptr(8);
+               nvals     = 0;
+               modes     = NEW_ARR_F(ir_mode *, 16);
+               set_ent   = new_set(ent_cmp, 8);
+               sels      = pset_new_ptr(8);
+               frame_tp  = get_irg_frame_type(irg);
 
                for (i = get_irn_n_outs(irg_frame) - 1; i >= 0; --i) {
                        ir_node *succ = get_irn_out(irg_frame, i);
@@ -666,13 +718,17 @@ int scalar_replacement_opt(ir_graph *irg) {
                        if (is_Sel(succ)) {
                                ir_entity *ent = get_Sel_entity(succ);
 
+                               /* we are only interested in entities on the frame, NOT
+                                  on the value type */
+                               if (get_entity_owner(ent) != frame_tp)
+                                       continue;
+
                                if (get_entity_link(ent) == NULL || get_entity_link(ent) == ADDRESS_TAKEN)
                                        continue;
 
                                ent_type = get_entity_type(ent);
 
                                key.ent       = ent;
-                               key.ent_owner = get_entity_owner(ent);
                                set_insert(set_ent, &key, sizeof(key), HASH_PTR(key.ent));
 
 #ifdef DEBUG_libfirm
@@ -698,7 +754,7 @@ int scalar_replacement_opt(ir_graph *irg) {
                        do_scalar_replacements(sels, nvals, modes);
 
                        foreach_set(set_ent, value) {
-                               remove_class_member(value->ent_owner, value->ent);
+                               free_entity(value->ent);
                        }
 
                        /*
@@ -716,10 +772,20 @@ int scalar_replacement_opt(ir_graph *irg) {
                DEL_ARR_F(modes);
        }
 
+       ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
+       irp_free_resources(irp, IR_RESOURCE_ENTITY_LINK);
+
        current_ir_graph = rem;
        return res;
 }
 
-void firm_init_scalar_replace(void) {
+ir_graph_pass_t *scalar_replacement_opt_pass(const char *name)
+{
+       return def_graph_pass_ret(name ? name : "scalar_rep",
+                                 scalar_replacement_opt);
+}
+
+void firm_init_scalar_replace(void)
+{
        FIRM_DBG_REGISTER(dbg, "firm.opt.scalar_replace");
 }