- mostly implemented access to outer frame variables, however offset, is wrong yet
[libfirm] / ir / be / beabi.c
index 2e7aad1..e9ee9d6 100644 (file)
@@ -342,7 +342,7 @@ static int stack_frame_compute_initial_offset(be_stack_layout_t *frame)
  * @param args      the stack argument layout type
  * @param between   the between layout type
  * @param locals    the method frame type
- * @param stack_dir the stack direction
+ * @param stack_dir the stack direction: < 0 decreasing, > 0 increasing addresses
  * @param param_map an array mapping method argument positions to the stack argument type
  *
  * @return the initialized stack layout
@@ -365,6 +365,8 @@ static be_stack_layout_t *stack_frame_init(be_stack_layout_t *frame, ir_type *ar
                frame->order[2] = locals;
        }
        else {
+               /* typical decreasing stack: locals have the
+                * lowest addresses, arguments the highest */
                frame->order[0] = locals;
                frame->order[2] = args;
        }
@@ -429,8 +431,8 @@ static ir_node *adjust_call(be_abi_irg_t *env, ir_node *irn, ir_node *curr_sp)
        ir_node *curr_mem          = get_Call_mem(irn);
        ir_node *bl                = get_nodes_block(irn);
        int stack_size             = 0;
-       int stack_dir              = arch_env_stack_dir(arch_env);
-       const arch_register_t *sp  = arch_env_sp(arch_env);
+       int stack_dir              = arch_env->stack_dir;
+       const arch_register_t *sp  = arch_env->sp;
        be_abi_call_t *call        = be_abi_call_new(sp->reg_class);
        ir_mode *mach_mode         = sp->reg_class->mode;
        struct obstack *obst       = &env->obst;
@@ -1224,14 +1226,17 @@ static void process_calls(be_abi_irg_t *env)
  * Changes a possibly allocated value param type by moving
  * entities to the stack layout type.
  *
- * @param env          the ABI environment
- * @param call         the current call ABI
- * @param method_type  the method type
- * @param param_map    an array mapping method arguments to the stack layout type
+ * @param env           the ABI environment
+ * @param call          the current call ABI
+ * @param method_type   the method type
+ * @param val_param_tp  the value parameter type, will be destroyed
+ * @param param_map     an array mapping method arguments to the stack layout type
  *
  * @return the stack argument layout type
  */
-static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type, ir_entity ***param_map)
+static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call,
+                                                                ir_type *method_type, ir_type *val_param_tp,
+                                                                ir_entity ***param_map)
 {
        int dir  = env->call->flags.bits.left_to_right ? 1 : -1;
        int inc  = env->birg->main_env->arch_env->stack_dir * dir;
@@ -1242,7 +1247,6 @@ static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type
        char buf[128];
        ir_type *res;
        int i;
-       ir_type *val_param_tp = get_method_value_param_type(method_type);
        ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
        ir_entity **map;
 
@@ -1254,16 +1258,16 @@ static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type
 
                map[i] = NULL;
                if (arg->on_stack) {
-                       if (val_param_tp) {
-                               /* the entity was already created, move it to the param type */
-                               arg->stack_ent = get_method_value_param_ent(method_type, i);
-                               remove_struct_member(val_param_tp, arg->stack_ent);
-                               set_entity_owner(arg->stack_ent, res);
-                               add_struct_member(res, arg->stack_ent);
+                       if (val_param_tp != NULL) {
+                               /* the entity was already created, create a copy in the param type */
+                               ir_entity *val_ent = get_method_value_param_ent(method_type, i);
+                               arg->stack_ent = copy_entity_own(val_ent, res);
+                               set_entity_link(val_ent, arg->stack_ent);
+                               set_entity_link(arg->stack_ent, NULL);
                                /* must be automatic to set a fixed layout */
                                set_entity_allocation(arg->stack_ent, allocation_automatic);
-                       }
-                       else {
+                       } else {
+                               /* create a new entity */
                                snprintf(buf, sizeof(buf), "param_%d", i);
                                arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
                        }
@@ -1494,42 +1498,95 @@ static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl,
        return ret;
 }
 
+typedef struct ent_pos_pair ent_pos_pair;
+struct ent_pos_pair {
+       ir_entity    *ent;   /**< a value param entity */
+       int          pos;    /**< its parameter number */
+       ent_pos_pair *next;  /**< for linking */
+};
+
 typedef struct lower_frame_sels_env_t {
-       be_abi_irg_t *env;
-       ir_entity    *value_param_list;  /**< the list of all value param entities */
-       ir_entity    *value_param_tail;  /**< the tail of the list of all value param entities */
+       ent_pos_pair *value_param_list;          /**< the list of all value param entities */
+       ir_node      *frame;                     /**< the current frame */
+       const arch_register_class_t *sp_class;   /**< register class of the stack pointer */
+       const arch_register_class_t *link_class; /**< register class of the link pointer */
+       ir_type      *value_tp;                  /**< the value type if any */
+       ir_type      *frame_tp;                  /**< the frame type */
+       int          static_link_pos;            /**< argument number of the hidden static link */
 } lower_frame_sels_env_t;
 
+/**
+ * Return an entity from the backend for an value param entity.
+ *
+ * @param ent  an value param type entity
+ * @param ctx  context
+ */
+static ir_entity *get_argument_entity(ir_entity *ent, lower_frame_sels_env_t *ctx)
+{
+       ir_entity *argument_ent = get_entity_link(ent);
+
+       if (argument_ent == NULL) {
+               /* we have NO argument entity yet: This is bad, as we will
+               * need one for backing store.
+               * Create one here.
+               */
+               ir_type *frame_tp = ctx->frame_tp;
+               unsigned offset   = get_type_size_bytes(frame_tp);
+               ir_type  *tp      = get_entity_type(ent);
+               unsigned align    = get_type_alignment_bytes(tp);
+
+               offset += align - 1;
+               offset &= ~(align - 1);
+
+               argument_ent = copy_entity_own(ent, frame_tp);
+
+               /* must be automatic to set a fixed layout */
+               set_entity_allocation(argument_ent, allocation_automatic);
+               set_entity_offset(argument_ent, offset);
+               offset += get_type_size_bytes(tp);
+
+               set_type_size_bytes(frame_tp, offset);
+               set_entity_link(ent, argument_ent);
+       }
+       return argument_ent;
+}
 /**
  * Walker: Replaces Sels of frame type and
  * value param type entities by FrameAddress.
  * Links all used entities.
  */
-static void lower_frame_sels_walker(ir_node *irn, void *data) {
+static void lower_frame_sels_walker(ir_node *irn, void *data)
+{
        lower_frame_sels_env_t *ctx = data;
 
        if (is_Sel(irn)) {
-               ir_graph *irg        = current_ir_graph;
-               ir_node  *frame      = get_irg_frame(irg);
-               ir_node  *param_base = get_irg_value_param_base(irg);
-               ir_node  *ptr        = get_Sel_ptr(irn);
+               ir_node *ptr = get_Sel_ptr(irn);
 
-               if (ptr == frame || ptr == param_base) {
-                       be_abi_irg_t *env = ctx->env;
+               if (ptr == ctx->frame) {
                        ir_entity    *ent = get_Sel_entity(irn);
                        ir_node      *bl  = get_nodes_block(irn);
                        ir_node      *nw;
+                       int          pos = 0;
+
+                       if (get_entity_owner(ent) == ctx->value_tp) {
+                               /* replace by its copy from the argument type */
+                               pos = get_struct_member_index(ctx->value_tp, ent);
+                               ent = get_argument_entity(ent, ctx);
+                       }
 
-                       nw = be_new_FrameAddr(env->arch_env->sp->reg_class, irg, bl, frame, ent);
+                       nw = be_new_FrameAddr(ctx->sp_class, current_ir_graph, bl, ctx->frame, ent);
                        exchange(irn, nw);
 
                        /* check, if it's a param sel and if have not seen this entity before */
-                       if (ptr == param_base &&
-                           ent != ctx->value_param_tail &&
-                           get_entity_link(ent) == NULL) {
+                       if (get_entity_owner(ent) == ctx->value_tp && get_entity_link(ent) == NULL) {
+                               ent_pos_pair pair;
+
+                               pair.ent  = ent;
+                               pair.pos  = pos;
+                               pair.next = NULL;
+                               ARR_APP1(ent_pos_pair, ctx->value_param_list, pair);
+                               /* just a mark */
                                set_entity_link(ent, ctx->value_param_list);
-                               ctx->value_param_list = ent;
-                               if (ctx->value_param_tail == NULL) ctx->value_param_tail = ent;
                        }
                }
        }
@@ -1546,26 +1603,27 @@ static void lower_frame_sels_walker(ir_node *irn, void *data) {
  * In the default case we move the entity to the frame type and create
  * a backing store into the first block.
  */
-static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_param_list) {
+static void fix_address_of_parameter_access(be_abi_irg_t *env, ent_pos_pair *value_param_list)
+{
        be_abi_call_t *call = env->call;
-       ir_graph *irg       = env->birg->irg;
-       ir_entity *ent, *next_ent, *new_list;
-       ir_type *frame_tp;
+       ir_graph      *irg  = env->birg->irg;
+       ent_pos_pair  *entry, *new_list;
+       ir_type       *frame_tp;
+       int           i, n = ARR_LEN(value_param_list);
        DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
 
        new_list = NULL;
-       for (ent = value_param_list; ent; ent = next_ent) {
-               int i = get_struct_member_index(get_entity_owner(ent), ent);
-               be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
+       for (i = 0; i < n; ++i) {
+               int               pos  = value_param_list[i].pos;
+               be_abi_call_arg_t *arg = get_call_arg(call, 0, pos);
 
-               next_ent = get_entity_link(ent);
                if (arg->in_reg) {
-                       DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
-                       set_entity_link(ent, new_list);
-                       new_list = ent;
+                       DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", pos));
+                       value_param_list[i].next = new_list;
+                       new_list = &value_param_list[i];
                }
        }
-       if (new_list) {
+       if (new_list != NULL) {
                /* ok, change the graph */
                ir_node *start_bl = get_irg_start_block(irg);
                ir_node *first_bl = NULL;
@@ -1602,14 +1660,14 @@ static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_
                mem     = imem;
                args    = get_irg_args(irg);
                args_bl = get_nodes_block(args);
-               for (ent = new_list; ent; ent = get_entity_link(ent)) {
-                       int     i     = get_struct_member_index(get_entity_owner(ent), ent);
-                       ir_type *tp   = get_entity_type(ent);
+               for (entry = new_list; entry != NULL; entry = entry->next) {
+                       int     i     = entry->pos;
+                       ir_type *tp   = get_entity_type(entry->ent);
                        ir_mode *mode = get_type_mode(tp);
                        ir_node *addr;
 
                        /* address for the backing store */
-                       addr = be_new_FrameAddr(env->arch_env->sp->reg_class, irg, first_bl, frame, ent);
+                       addr = be_new_FrameAddr(env->arch_env->sp->reg_class, irg, first_bl, frame, entry->ent);
 
                        if (store)
                                mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
@@ -1629,18 +1687,25 @@ static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_
                /* we will add new entities: set the layout to undefined */
                assert(get_type_state(frame_tp) == layout_fixed);
                set_type_state(frame_tp, layout_undefined);
-               for (ent = new_list; ent; ent = get_entity_link(ent)) {
-                       ir_type  *tp   = get_entity_type(ent);
-                       unsigned align = get_type_alignment_bytes(tp);
-
-                       offset += align - 1;
-                       offset &= ~(align - 1);
-                       set_entity_owner(ent, frame_tp);
-                       add_class_member(frame_tp, ent);
-                       /* must be automatic to set a fixed layout */
-                       set_entity_allocation(ent, allocation_automatic);
-                       set_entity_offset(ent, offset);
-                       offset += get_type_size_bytes(tp);
+               for (entry = new_list; entry != NULL; entry = entry->next) {
+                       ir_entity *ent = entry->ent;
+
+                       /* If the entity is still on the argument type, move it to the frame type.
+                          This happens if the value_param type was build due to compound
+                          params. */
+                       if (get_entity_owner(ent) != frame_tp) {
+                               ir_type  *tp   = get_entity_type(ent);
+                               unsigned align = get_type_alignment_bytes(tp);
+
+                               offset += align - 1;
+                               offset &= ~(align - 1);
+                               set_entity_owner(ent, frame_tp);
+                               add_class_member(frame_tp, ent);
+                               /* must be automatic to set a fixed layout */
+                               set_entity_allocation(ent, allocation_automatic);
+                               set_entity_offset(ent, offset);
+                               offset += get_type_size_bytes(tp);
+                       }
                }
                set_type_size_bytes(frame_tp, offset);
                /* fix the layout again */
@@ -1653,7 +1718,8 @@ static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_
  * The backend wants to handle all blocks the same way, so we replace
  * the out cfg edge with a real jump.
  */
-static void fix_start_block(ir_graph *irg) {
+static void fix_start_block(ir_graph *irg)
+{
        ir_node         *initial_X   = get_irg_initial_exec(irg);
        ir_node         *start_block = get_irg_start_block(irg);
        const ir_edge_t *edge;
@@ -1672,7 +1738,69 @@ static void fix_start_block(ir_graph *irg) {
                        return;
                }
        }
-       panic("Initial exec has no follow block");
+       panic("Initial exec has no follow block in %+F", irg);
+}
+
+static void lower_outer_frame_sels(ir_node *irn, void *env) {
+       lower_frame_sels_env_t *ctx = env;
+       ir_node                *ptr, *bl, *nw;
+       ir_entity              *ent;
+       int                    pos = 0;
+
+       if (! is_Sel(irn))
+               return;
+       ptr = get_Sel_ptr(irn);
+       if (! is_arg_Proj(ptr))
+               return;
+       if (get_Proj_proj(ptr) != ctx->static_link_pos)
+               return;
+       ent   = get_Sel_entity(irn);
+
+       if (get_entity_owner(ent) == ctx->value_tp) {
+               /* replace by its copy from the argument type */
+               pos = get_struct_member_index(ctx->value_tp, ent);
+               ent = get_argument_entity(ent, ctx);
+       }
+       bl = get_nodes_block(irn);
+       nw = be_new_FrameAddr(ctx->link_class, current_ir_graph, bl, ptr, ent);
+       exchange(irn, nw);
+
+       /* check, if it's a param sel and if have not seen this entity before */
+       if (get_entity_owner(ent) == ctx->value_tp && get_entity_link(ent) == NULL) {
+               ent_pos_pair pair;
+
+               pair.ent  = ent;
+               pair.pos  = pos;
+               pair.next = NULL;
+               ARR_APP1(ent_pos_pair, ctx->value_param_list, pair);
+               /* just a mark */
+               set_entity_link(ent, ctx->value_param_list);
+       }
+}
+
+/**
+ * Fix access to outer local variables.
+ */
+static void fix_outer_variable_access(be_abi_irg_t *env, lower_frame_sels_env_t *ctx)
+{
+       int      i;
+       ir_graph *irg;
+
+       for (i = get_class_n_members(ctx->frame_tp) - 1; i >= 0; --i) {
+               ir_entity *ent = get_class_member(ctx->frame_tp, i);
+
+               if (! is_method_entity(ent))
+                       continue;
+
+               /*
+                * FIXME: find the number of the static link parameter
+                * for now we assume 0 here
+                */
+               ctx->static_link_pos = 0;
+
+               irg = get_entity_irg(ent);
+               irg_walk_graph(irg, NULL, lower_outer_frame_sels, ctx);
+       }
 }
 
 /**
@@ -1682,7 +1810,7 @@ static void modify_irg(be_abi_irg_t *env)
 {
        be_abi_call_t *call       = env->call;
        const arch_env_t *arch_env= env->birg->main_env->arch_env;
-       const arch_register_t *sp = arch_env_sp(arch_env);
+       const arch_register_t *sp = arch_env->sp;
        ir_graph *irg             = env->birg->irg;
        ir_node *start_bl;
        ir_node *end;
@@ -1701,13 +1829,11 @@ static void modify_irg(be_abi_irg_t *env)
        ir_node *reg_params_bl;
        ir_node **args;
        ir_node *arg_tuple;
-       ir_node *value_param_base;
        const ir_edge_t *edge;
        ir_type *arg_type, *bet_type, *tp;
        lower_frame_sels_env_t ctx;
        ir_entity **param_map;
 
-       bitset_t *used_proj_nr;
        DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
 
        DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
@@ -1717,32 +1843,49 @@ static void modify_irg(be_abi_irg_t *env)
        old_mem = get_irg_initial_mem(irg);
 
        irp_reserve_resources(irp, IR_RESOURCE_ENTITY_LINK);
+
        /* set the links of all frame entities to NULL, we use it
           to detect if an entity is already linked in the value_param_list */
        tp = get_method_value_param_type(method_type);
+       ctx.value_tp = tp;
        if (tp != NULL) {
-               for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
-                       set_entity_link(get_struct_member(tp, i), NULL);
+               /* clear the links of the clone type, let the
+                  original entities point to its clones */
+               for (i = get_struct_n_members(tp) - 1; i >= 0; --i) {
+                       ir_entity *mem  = get_struct_member(tp, i);
+                       set_entity_link(mem, NULL);
+               }
        }
 
-       /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
-       ctx.env              = env;
-       ctx.value_param_list = NULL;
-       ctx.value_param_tail = NULL;
+       arg_type = compute_arg_type(env, call, method_type, tp, &param_map);
+
+       /* Convert the Sel nodes in the irg to frame addr nodes: */
+       ctx.value_param_list = NEW_ARR_F(ent_pos_pair, 0);
+       ctx.frame            = get_irg_frame(irg);
+       ctx.sp_class         = env->arch_env->sp->reg_class;
+       ctx.link_class       = env->arch_env->link_class;
+       ctx.frame_tp         = get_irg_frame_type(irg);
+
+       /* we will possible add new entities to the frame: set the layout to undefined */
+       assert(get_type_state(ctx.frame_tp) == layout_fixed);
+       set_type_state(ctx.frame_tp, layout_undefined);
+
        irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
 
-       /* value_param_base anchor is not needed anymore now */
-       value_param_base = get_irg_value_param_base(irg);
-       kill_node(value_param_base);
-       set_irg_value_param_base(irg, new_r_Bad(irg));
+       /* fix the frame type layout again */
+       set_type_state(ctx.frame_tp, layout_fixed);
 
        env->regs  = pmap_create();
 
-       used_proj_nr = bitset_alloca(1024);
-       n_params     = get_method_n_params(method_type);
-       args         = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
+       n_params = get_method_n_params(method_type);
+       args     = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
        memset(args, 0, n_params * sizeof(args[0]));
 
+       /*
+        * for inner function we must now fix access to outer frame entities.
+        */
+       fix_outer_variable_access(env, &ctx);
+
        /* Check if a value parameter is transmitted as a register.
         * This might happen if the address of an parameter is taken which is
         * transmitted in registers.
@@ -1754,6 +1897,8 @@ static void modify_irg(be_abi_irg_t *env)
         * a backing store into the first block.
         */
        fix_address_of_parameter_access(env, ctx.value_param_list);
+
+       DEL_ARR_F(ctx.value_param_list);
        irp_free_resources(irp, IR_RESOURCE_ENTITY_LINK);
 
        /* Fill the argument vector */
@@ -1767,7 +1912,6 @@ static void modify_irg(be_abi_irg_t *env)
                }
        }
 
-       arg_type = compute_arg_type(env, call, method_type, &param_map);
        bet_type = call->cb->get_between_type(env->cb);
        stack_frame_init(&env->frame, arg_type, bet_type, get_irg_frame_type(irg), arch_env->stack_dir, param_map);
 
@@ -1780,7 +1924,6 @@ static void modify_irg(be_abi_irg_t *env)
 
                        /* For now, associate the register with the old Proj from Start representing that argument. */
                        pmap_insert(env->regs, (void *) arg->reg, args[i]);
-                       bitset_set(used_proj_nr, i);
                        DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
                }
        }
@@ -1823,7 +1966,6 @@ static void modify_irg(be_abi_irg_t *env)
                        add_type |= arch_register_req_type_produces_sp | arch_register_req_type_ignore;
 
                assert(nr >= 0);
-               bitset_set(used_proj_nr, nr);
                proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
                pmap_insert(env->regs, (void *) reg, proj);
                be_set_constr_single_reg_out(env->reg_params, nr, reg, add_type);
@@ -2264,7 +2406,8 @@ void be_abi_set_non_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *
 }
 
 /* Returns the stack layout from a abi environment. */
-const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi) {
+const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi)
+{
        return &abi->frame;
 }
 
@@ -2377,7 +2520,7 @@ static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int real_bias)
                   node.
                 */
                ir_entity *ent = arch_get_frame_entity(irn);
-               if (ent) {
+               if (ent != NULL) {
                        int bias   = omit_fp ? real_bias : 0;
                        int offset = get_stack_entity_offset(&env->frame, ent, bias);
                        arch_set_frame_offset(irn, offset);
@@ -2491,6 +2634,7 @@ ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg)
  * Returns non-zero if the ABI has omitted the frame pointer in
  * the current graph.
  */
-int be_abi_omit_fp(const be_abi_irg_t *abi) {
+int be_abi_omit_fp(const be_abi_irg_t *abi)
+{
        return abi->call->flags.bits.try_omit_fp;
 }