nsz Git - libfirm/blob - ir/be/beabi.c

   1 /**
   2  * ABI lowering.
   3  *
   4  * @author Sebastian Hack
   5  * @date   7.3.2005
   6  * @cvsid  $Id$
   7  */
   8
   9 #ifdef HAVE_CONFIG_H
  10 # include "config.h"
  11 #endif
  12
  13 #include "obst.h"
  14 #include "offset.h"
  15
  16 #include "type.h"
  17 #include "irgopt.h"
  18
  19 #include "irgraph_t.h"
  20 #include "irnode_t.h"
  21 #include "ircons_t.h"
  22 #include "iredges_t.h"
  23 #include "irgmod.h"
  24 #include "irgwalk.h"
  25 #include "irprintf_t.h"
  26 #include "irgopt.h"
  27 #include "irbitset.h"
  28 #include "height.h"
  29 #include "pdeq.h"
  30 #include "irtools.h"
  31
  32 #include "be.h"
  33 #include "beabi.h"
  34 #include "bearch.h"
  35 #include "benode_t.h"
  36 #include "belive_t.h"
  37 #include "besched_t.h"
  38
  39 typedef struct _be_abi_call_arg_t {
  40         unsigned is_res   : 1;  /**< 1: the call argument is a return value. 0: it's a call parameter. */
  41         unsigned in_reg   : 1;  /**< 1: this argument is transmitted in registers. */
  42         unsigned on_stack : 1;  /**< 1: this argument is transmitted on the stack. */
  43
  44         int pos;
  45         const arch_register_t *reg;
  46         entity *stack_ent;
  47         unsigned alignment;
  48         unsigned space_before;
  49         unsigned space_after;
  50 } be_abi_call_arg_t;
  51
  52 struct _be_abi_call_t {
  53         be_abi_call_flags_t flags;
  54         const be_abi_callbacks_t *cb;
  55         ir_type *between_type;
  56         set *params;
  57 };
  58
  59 #define N_FRAME_TYPES 3
  60
  61 /**
  62  * This type describes the stack layout.
  63  * The stack is divided into 3 parts:
  64  * - arg_type:     A struct type describing the stack arguments and it's order.
  65  * - between_type: A struct type describing the stack layout between arguments
  66  *                 and frame type
  67  * - frame_type:   A class type descibing the frame layout
  68  */
  69 typedef struct _be_stack_layout_t {
  70         ir_type *arg_type;                 /**< A type describing the stack argument layout. */
  71         ir_type *between_type;             /**< A type describing the "between" layout. */
  72         ir_type *frame_type;               /**< The frame type. */
  73
  74         ir_type *order[N_FRAME_TYPES];     /**< arg, between and frame types ordered. */
  75
  76         int initial_offset;
  77         int stack_dir;                     /**< -1 for decreasing, 1 for increasing. */
  78 } be_stack_layout_t;
  79
  80 struct _be_abi_irg_t {
  81         struct obstack       obst;
  82         be_stack_layout_t    *frame;        /**< The stack frame model. */
  83         const be_irg_t       *birg;         /**< The back end IRG. */
  84         const arch_isa_t     *isa;          /**< The isa. */
  85         survive_dce_t        *dce_survivor;
  86
  87         be_abi_call_t        *call;         /**< The ABI call information. */
  88         ir_type              *method_type;  /**< The type of the method of the IRG. */
  89
  90         ir_node              *init_sp;      /**< The node representing the stack pointer
  91                                                                              at the start of the function. */
  92
  93         ir_node              *reg_params;   /**< The reg params node. */
  94         pmap                 *regs;         /**< A map of all callee-save and ignore regs to
  95                                                                                         their Projs to the RegParams node. */
  96
  97         pset                 *stack_phis;   /**< The set of all Phi nodes inserted due to
  98                                                                                         stack pointer modifying nodes. */
  99
 100         int                  start_block_bias;  /**< The stack bias at the end of the start block. */
 101
 102         void                 *cb;           /**< ABI Callback self pointer. */
 103
 104         pmap                 *keep_map;     /**< mapping blocks to keep nodes. */
 105         pset                 *ignore_regs;  /**< Additional registers which shall be ignored. */
 106
 107         arch_irn_handler_t irn_handler;
 108         arch_irn_ops_t     irn_ops;
 109         DEBUG_ONLY(firm_dbg_module_t    *dbg;)          /**< The debugging module. */
 110 };
 111
 112 #define get_abi_from_handler(ptr) firm_container_of(ptr, be_abi_irg_t, irn_handler)
 113 #define get_abi_from_ops(ptr)     firm_container_of(ptr, be_abi_irg_t, irn_ops)
 114
 115 /* Forward, since be need it in be_abi_introduce(). */
 116 static const arch_irn_ops_if_t abi_irn_ops;
 117 static const arch_irn_handler_t abi_irn_handler;
 118 static heights_t *ir_heights;
 119
 120 /* Flag: if set, try to omit the frame pointer if called by the backend */
 121 int be_omit_fp = 1;
 122
 123 /*
 124      _    ____ ___    ____      _ _ _                _
 125     / \  | __ )_ _|  / ___|__ _| | | |__   __ _  ___| | _____
 126    / _ \ |  _ \| |  | |   / _` | | | '_ \ / _` |/ __| |/ / __|
 127   / ___ \| |_) | |  | |__| (_| | | | |_) | (_| | (__|   <\__ \
 128  /_/   \_\____/___|  \____\__,_|_|_|_.__/ \__,_|\___|_|\_\___/
 129
 130   These callbacks are used by the backend to set the parameters
 131   for a specific call type.
 132 */
 133
 134 /**
 135  * Set compare function: compares two ABI call object arguments.
 136  */
 137 static int cmp_call_arg(const void *a, const void *b, size_t n)
 138 {
 139         const be_abi_call_arg_t *p = a, *q = b;
 140         return !(p->is_res == q->is_res && p->pos == q->pos);
 141 }
 142
 143 /**
 144  * Get or set an ABI call object argument.
 145  *
 146  * @param call      the abi call
 147  * @param is_res    true for call results, false for call arguments
 148  * @param pos       position of the argument
 149  * @param do_insert true if the argument is set, false if it's retrieved
 150  */
 151 static be_abi_call_arg_t *get_or_set_call_arg(be_abi_call_t *call, int is_res, int pos, int do_insert)
 152 {
 153         be_abi_call_arg_t arg;
 154         unsigned hash;
 155
 156         memset(&arg, 0, sizeof(arg));
 157         arg.is_res = is_res;
 158         arg.pos    = pos;
 159
 160         hash = is_res * 128 + pos;
 161
 162         return do_insert
 163                 ? set_insert(call->params, &arg, sizeof(arg), hash)
 164                 : set_find(call->params, &arg, sizeof(arg), hash);
 165 }
 166
 167 /**
 168  * Retrieve an ABI call object argument.
 169  *
 170  * @param call      the ABI call object
 171  * @param is_res    true for call results, false for call arguments
 172  * @param pos       position of the argument
 173  */
 174 static INLINE be_abi_call_arg_t *get_call_arg(be_abi_call_t *call, int is_res, int pos)
 175 {
 176         return get_or_set_call_arg(call, is_res, pos, 0);
 177 }
 178
 179 /* Set the flags for a call. */
 180 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb)
 181 {
 182         call->flags        = flags;
 183         call->cb           = cb;
 184 }
 185
 186 void be_abi_call_param_stack(be_abi_call_t *call, int arg_pos, unsigned alignment, unsigned space_before, unsigned space_after)
 187 {
 188         be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
 189         arg->on_stack     = 1;
 190         arg->alignment    = alignment;
 191         arg->space_before = space_before;
 192         arg->space_after  = space_after;
 193         assert(alignment > 0 && "Alignment must be greater than 0");
 194 }
 195
 196 void be_abi_call_param_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
 197 {
 198         be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
 199         arg->in_reg = 1;
 200         arg->reg = reg;
 201 }
 202
 203 void be_abi_call_res_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
 204 {
 205         be_abi_call_arg_t *arg = get_or_set_call_arg(call, 1, arg_pos, 1);
 206         arg->in_reg = 1;
 207         arg->reg = reg;
 208 }
 209
 210 /* Get the flags of a ABI call object. */
 211 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call)
 212 {
 213         return call->flags;
 214 }
 215
 216 /**
 217  * Constructor for a new ABI call object.
 218  *
 219  * @return the new ABI call object
 220  */
 221 static be_abi_call_t *be_abi_call_new(void)
 222 {
 223         be_abi_call_t *call = xmalloc(sizeof(call[0]));
 224         call->flags.val  = 0;
 225         call->params     = new_set(cmp_call_arg, 16);
 226         call->cb         = NULL;
 227
 228         call->flags.bits.try_omit_fp = be_omit_fp;
 229         return call;
 230 }
 231
 232 /**
 233  * Destructor for an ABI call object.
 234  */
 235 static void be_abi_call_free(be_abi_call_t *call)
 236 {
 237         del_set(call->params);
 238         free(call);
 239 }
 240
 241 /*
 242   _____                           _   _                 _ _ _
 243  |  ___| __ __ _ _ __ ___   ___  | | | | __ _ _ __   __| | (_)_ __   __ _
 244  | |_ | '__/ _` | '_ ` _ \ / _ \ | |_| |/ _` | '_ \ / _` | | | '_ \ / _` |
 245  |  _|| | | (_| | | | | | |  __/ |  _  | (_| | | | | (_| | | | | | | (_| |
 246  |_|  |_|  \__,_|_| |_| |_|\___| |_| |_|\__,_|_| |_|\__,_|_|_|_| |_|\__, |
 247                                                                     |___/
 248
 249   Handling of the stack frame. It is composed of three types:
 250   1) The type of the arguments which are pushed on the stack.
 251   2) The "between type" which consists of stuff the call of the
 252      function pushes on the stack (like the return address and
 253          the old base pointer for ia32).
 254   3) The Firm frame type which consists of all local variables
 255      and the spills.
 256 */
 257
 258 static int get_stack_entity_offset(be_stack_layout_t *frame, entity *ent, int bias)
 259 {
 260         ir_type *t = get_entity_owner(ent);
 261         int ofs    = get_entity_offset_bytes(ent);
 262
 263         int i, index;
 264
 265         /* Find the type the entity is contained in. */
 266         for(index = 0; index < N_FRAME_TYPES; ++index) {
 267                 if(frame->order[index] == t)
 268                         break;
 269         }
 270
 271         /* Add the size of all the types below the one of the entity to the entity's offset */
 272         for(i = 0; i < index; ++i)
 273                 ofs += get_type_size_bytes(frame->order[i]);
 274
 275         /* correct the offset by the initial position of the frame pointer */
 276         ofs -= frame->initial_offset;
 277
 278         /* correct the offset with the current bias. */
 279         ofs += bias;
 280
 281         return ofs;
 282 }
 283
 284 /**
 285  * Retrieve the entity with given offset from a frame type.
 286  */
 287 static entity *search_ent_with_offset(ir_type *t, int offset)
 288 {
 289         int i, n;
 290
 291         for(i = 0, n = get_compound_n_members(t); i < n; ++i) {
 292                 entity *ent = get_compound_member(t, i);
 293                 if(get_entity_offset_bytes(ent) == offset)
 294                         return ent;
 295         }
 296
 297         return NULL;
 298 }
 299
 300 static int stack_frame_compute_initial_offset(be_stack_layout_t *frame)
 301 {
 302         ir_type *base = frame->stack_dir < 0 ? frame->between_type : frame->frame_type;
 303         entity *ent   = search_ent_with_offset(base, 0);
 304         frame->initial_offset = 0;
 305         frame->initial_offset = get_stack_entity_offset(frame, ent, 0);
 306         return frame->initial_offset;
 307 }
 308
 309 /**
 310  * Initializes the frame layout from parts
 311  *
 312  * @param frame     the stack layout that will be initialized
 313  * @param args      the stack argument layout type
 314  * @param between   the between layout type
 315  * @param locals    the method frame type
 316  * @param stack_dir the stack direction
 317  *
 318  * @return the initialized stack layout
 319  */
 320 static be_stack_layout_t *stack_frame_init(be_stack_layout_t *frame, ir_type *args,
 321                                            ir_type *between, ir_type *locals, int stack_dir)
 322 {
 323         frame->arg_type       = args;
 324         frame->between_type   = between;
 325         frame->frame_type     = locals;
 326         frame->initial_offset = 0;
 327         frame->stack_dir      = stack_dir;
 328         frame->order[1]       = between;
 329
 330         if(stack_dir > 0) {
 331                 frame->order[0] = args;
 332                 frame->order[2] = locals;
 333         }
 334         else {
 335                 frame->order[0] = locals;
 336                 frame->order[2] = args;
 337         }
 338         return frame;
 339 }
 340
 341 /** Dumps the stack layout to file. */
 342 static void stack_layout_dump(FILE *file, be_stack_layout_t *frame)
 343 {
 344         int i, j, n;
 345
 346         ir_fprintf(file, "initial offset: %d\n", frame->initial_offset);
 347         for (j = 0; j < N_FRAME_TYPES; ++j) {
 348                 ir_type *t = frame->order[j];
 349
 350                 ir_fprintf(file, "type %d: %F size: %d\n", j, t, get_type_size_bytes(t));
 351                 for (i = 0, n = get_compound_n_members(t); i < n; ++i) {
 352                         entity *ent = get_compound_member(t, i);
 353                         ir_fprintf(file, "\t%F int ofs: %d glob ofs: %d\n", ent, get_entity_offset_bytes(ent), get_stack_entity_offset(frame, ent, 0));
 354                 }
 355         }
 356 }
 357
 358 /**
 359  * Returns non-zero if the call argument at given position
 360  * is transfered on the stack.
 361  */
 362 static INLINE int is_on_stack(be_abi_call_t *call, int pos)
 363 {
 364         be_abi_call_arg_t *arg = get_call_arg(call, 0, pos);
 365         return arg && !arg->in_reg;
 366 }
 367
 368 /*
 369    ____      _ _
 370   / ___|__ _| | |___
 371  | |   / _` | | / __|
 372  | |__| (_| | | \__ \
 373   \____\__,_|_|_|___/
 374
 375   Adjustment of the calls inside a graph.
 376
 377 */
 378
 379 /**
 380  * Transform a call node.
 381  * @param env The ABI environment for the current irg.
 382  * @param irn The call node.
 383  * @param curr_sp The stack pointer node to use.
 384  * @return The stack pointer after the call.
 385  */
 386 static ir_node *adjust_call(be_abi_irg_t *env, ir_node *irn, ir_node *curr_sp, ir_node *alloca_copy)
 387 {
 388         ir_graph *irg             = env->birg->irg;
 389         const arch_isa_t *isa     = env->birg->main_env->arch_env->isa;
 390         be_abi_call_t *call       = be_abi_call_new();
 391         ir_type *mt               = get_Call_type(irn);
 392         ir_node *call_ptr         = get_Call_ptr(irn);
 393         int n_params              = get_method_n_params(mt);
 394         ir_node *curr_mem         = get_Call_mem(irn);
 395         ir_node *bl               = get_nodes_block(irn);
 396         pset *results             = pset_new_ptr(8);
 397         pset *caller_save         = pset_new_ptr(8);
 398         int stack_size            = 0;
 399         int stack_dir             = arch_isa_stack_dir(isa);
 400         const arch_register_t *sp = arch_isa_sp(isa);
 401         ir_mode *mach_mode        = sp->reg_class->mode;
 402         struct obstack *obst      = &env->obst;
 403         ir_node *no_mem           = get_irg_no_mem(irg);
 404         int no_alloc              = call->flags.bits.frame_is_setup_on_call;
 405
 406         ir_node *res_proj = NULL;
 407         int curr_res_proj = pn_Call_max;
 408         int n_low_args    = 0;
 409         int n_pos         = 0;
 410
 411         ir_node *low_call;
 412         ir_node **in;
 413         ir_node **res_projs;
 414         const ir_edge_t *edge;
 415         int *low_args;
 416         int *pos;
 417         int i, n;
 418
 419         /* Let the isa fill out the abi description for that call node. */
 420         arch_isa_get_call_abi(isa, mt, call);
 421
 422         /* Insert code to put the stack arguments on the stack. */
 423         assert(get_Call_n_params(irn) == n_params);
 424         for(i = 0; i < n_params; ++i) {
 425                 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
 426                 assert(arg);
 427                 if(arg->on_stack) {
 428                         stack_size += arg->space_before;
 429                         stack_size =  round_up2(stack_size, arg->alignment);
 430                         stack_size += get_type_size_bytes(get_method_param_type(mt, i));
 431                         stack_size += arg->space_after;
 432                         obstack_int_grow(obst, i);
 433                         n_pos++;
 434                 }
 435         }
 436         pos = obstack_finish(obst);
 437
 438         /* Collect all arguments which are passed in registers. */
 439         for(i = 0, n = get_Call_n_params(irn); i < n; ++i) {
 440                 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
 441                 if(arg && arg->in_reg) {
 442                         obstack_int_grow(obst, i);
 443                         n_low_args++;
 444                 }
 445         }
 446         low_args = obstack_finish(obst);
 447
 448         /* If there are some parameters which shall be passed on the stack. */
 449         if(n_pos > 0) {
 450                 int curr_ofs      = 0;
 451                 int do_seq        = call->flags.bits.store_args_sequential && !no_alloc;
 452
 453                 /*
 454                  * Reverse list of stack parameters if call arguments are from left to right.
 455                  * We must them reverse again in they are pushed (not stored) and the stack
 456                  * direction is downwards.
 457                  */
 458                 if (call->flags.bits.left_to_right ^ (do_seq && stack_dir < 0)) {
 459                         for(i = 0; i < n_pos >> 1; ++i) {
 460                                 int other  = n_pos - i - 1;
 461                                 int tmp    = pos[i];
 462                                 pos[i]     = pos[other];
 463                                 pos[other] = tmp;
 464                         }
 465                 }
 466
 467                 /*
 468                  * If the stack is decreasing and we do not want to store sequentially,
 469                  * or someone else allocated the call frame
 470                  * we allocate as much space on the stack all parameters need, by
 471                  * moving the stack pointer along the stack's direction.
 472                  */
 473                 if(stack_dir < 0 && !do_seq && !no_alloc) {
 474                         curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, stack_size);
 475                         if(alloca_copy) {
 476                                 add_irn_dep(curr_sp, alloca_copy);
 477                                 alloca_copy = NULL;
 478                         }
 479                 }
 480
 481                 assert(mode_is_reference(mach_mode) && "machine mode must be pointer");
 482                 for(i = 0; i < n_pos; ++i) {
 483                         int p                  = pos[i];
 484                         be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
 485                         ir_node *param         = get_Call_param(irn, p);
 486                         ir_node *addr          = curr_sp;
 487                         ir_node *mem           = NULL;
 488                         ir_type *param_type    = get_method_param_type(mt, p);
 489                         int param_size         = get_type_size_bytes(param_type) + arg->space_after;
 490
 491                         /*
 492                          * If we wanted to build the arguments sequentially,
 493                          * the stack pointer for the next must be incremented,
 494                          * and the memory value propagated.
 495                          */
 496                         if (do_seq) {
 497                                 curr_ofs = 0;
 498                                 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, param_size + arg->space_before);
 499                                 if(alloca_copy) {
 500                                         add_irn_dep(curr_sp, alloca_copy);
 501                                         alloca_copy = NULL;
 502                                 }
 503                                 add_irn_dep(curr_sp, curr_mem);
 504                         }
 505                         else {
 506                                 curr_ofs += arg->space_before;
 507                                 curr_ofs =  round_up2(curr_ofs, arg->alignment);
 508
 509                                 /* Make the expression to compute the argument's offset. */
 510                                 if(curr_ofs > 0) {
 511                                         addr = new_r_Const_long(irg, bl, mode_Is, curr_ofs);
 512                                         addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
 513                                 }
 514                         }
 515
 516                         /* Insert a store for primitive arguments. */
 517                         if (is_atomic_type(param_type)) {
 518                                 mem = new_r_Store(irg, bl, curr_mem, addr, param);
 519                                 mem = new_r_Proj(irg, bl, mem, mode_M, pn_Store_M);
 520                         }
 521
 522                         /* Make a mem copy for compound arguments. */
 523                         else {
 524                                 assert(mode_is_reference(get_irn_mode(param)));
 525                                 mem = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
 526                                 mem = new_r_Proj(irg, bl, mem, mode_M, pn_CopyB_M_regular);
 527                         }
 528
 529                         curr_ofs += param_size;
 530
 531                         if (do_seq)
 532                                 curr_mem = mem;
 533                         else
 534                                 obstack_ptr_grow(obst, mem);
 535                 }
 536
 537                 in = (ir_node **) obstack_finish(obst);
 538
 539                 /* We need the sync only, if we didn't build the stores sequentially. */
 540                 if(!do_seq)
 541                         curr_mem = new_r_Sync(irg, bl, n_pos, in);
 542                 obstack_free(obst, in);
 543         }
 544
 545         /* Collect caller save registers */
 546         for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
 547                 int j;
 548                 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
 549                 for(j = 0; j < cls->n_regs; ++j) {
 550                         const arch_register_t *reg = arch_register_for_index(cls, j);
 551                         if(arch_register_type_is(reg, caller_save))
 552                                 pset_insert_ptr(caller_save, (void *) reg);
 553                 }
 554         }
 555
 556         /* search the greatest result proj number */
 557
 558         /* TODO: what if the result is NOT used? Currently there is
 559          * no way to detect this later, especially there is no way to
 560          * see this in the proj numbers.
 561          * While this is ok for the register allocator, it is bad for
 562          * backends which need to change the be_Call further (x87 simulator
 563          * for instance. However for this particular case the call_type is
 564          * sufficient.).
 565          */
 566         foreach_out_edge(irn, edge) {
 567                 const ir_edge_t *res_edge;
 568                 ir_node *irn = get_edge_src_irn(edge);
 569
 570                 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_T_result) {
 571                         res_proj = irn;
 572                         foreach_out_edge(irn, res_edge) {
 573                                 int proj;
 574                                 be_abi_call_arg_t *arg;
 575                                 ir_node *res = get_edge_src_irn(res_edge);
 576
 577                                 assert(is_Proj(res));
 578
 579                                 proj = get_Proj_proj(res);
 580                                 arg = get_call_arg(call, 1, proj);
 581
 582                                 /*
 583                                         shift the proj number to the right, since we will drop the
 584                                         unspeakable Proj_T from the Call. Therefore, all real argument
 585                                         Proj numbers must be increased by pn_be_Call_first_res
 586                                 */
 587                                 proj += pn_be_Call_first_res;
 588                                 set_Proj_proj(res, proj);
 589                                 obstack_ptr_grow(obst, res);
 590
 591                                 if(proj > curr_res_proj)
 592                                         curr_res_proj = proj;
 593                                 if(arg->in_reg) {
 594                                         pset_remove_ptr(caller_save, arg->reg);
 595                                         //pmap_insert(arg_regs, arg->reg, INT_TO_PTR(proj + 1))
 596                                 }
 597                         }
 598                 }
 599         }
 600
 601         curr_res_proj++;
 602         obstack_ptr_grow(obst, NULL);
 603         res_projs = obstack_finish(obst);
 604
 605         /* make the back end call node and set its register requirements. */
 606         for(i = 0; i < n_low_args; ++i)
 607                 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
 608
 609         in = obstack_finish(obst);
 610
 611         if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
 612                 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, curr_sp,
 613                                        curr_res_proj + pset_count(caller_save), n_low_args, in,
 614                                        get_Call_type(irn));
 615                 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
 616         }
 617
 618         else
 619                 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, call_ptr,
 620                                        curr_res_proj + pset_count(caller_save), n_low_args, in,
 621                                        get_Call_type(irn));
 622
 623         /*
 624                 TODO:
 625                 Set the register class of the call address to the same as the stack pointer's.
 626                 That' probably buggy for some architectures.
 627         */
 628         be_node_set_reg_class(low_call, be_pos_Call_ptr, sp->reg_class);
 629
 630         DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
 631
 632         /* Set the register classes and constraints of the Call parameters. */
 633         for(i = 0; i < n_low_args; ++i) {
 634                 int index = low_args[i];
 635                 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
 636                 assert(arg->reg != NULL);
 637
 638                 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + index, arg->reg);
 639         }
 640
 641         /* Set the register constraints of the results. */
 642         for(i = 0; res_projs[i]; ++i) {
 643                 ir_node *irn                 = res_projs[i];
 644                 int proj                     = get_Proj_proj(irn);
 645
 646                 /* Correct Proj number since it has been adjusted! (see above) */
 647                 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
 648
 649                 assert(arg->in_reg);
 650                 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
 651         }
 652         obstack_free(obst, in);
 653         exchange(irn, low_call);
 654
 655         /* redirect the result projs to the lowered call instead of the Proj_T */
 656         for(i = 0; res_projs[i]; ++i)
 657                 set_Proj_pred(res_projs[i], low_call);
 658
 659         /* Make additional projs for the caller save registers
 660            and the Keep node which keeps them alive. */
 661         if(pset_count(caller_save) > 0) {
 662                 const arch_register_t *reg;
 663                 ir_node **in, *keep;
 664                 int i, n;
 665
 666                 for(reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
 667                         ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
 668
 669                         /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
 670                         be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
 671                         set_irn_link(proj, (void *) reg);
 672                         obstack_ptr_grow(obst, proj);
 673                         curr_res_proj++;
 674                 }
 675
 676                 in   = (ir_node **) obstack_finish(obst);
 677                 keep = be_new_Keep(NULL, irg, bl, n, in);
 678                 for(i = 0; i < n; ++i) {
 679                         const arch_register_t *reg = get_irn_link(in[i]);
 680                         be_node_set_reg_class(keep, i, reg->reg_class);
 681                 }
 682                 obstack_free(obst, in);
 683         }
 684
 685         /* Clean up the stack. */
 686         if(stack_size > 0) {
 687                 ir_node *mem_proj = NULL;
 688
 689                 foreach_out_edge(low_call, edge) {
 690                         ir_node *irn = get_edge_src_irn(edge);
 691                         if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
 692                                 mem_proj = irn;
 693                                 break;
 694                         }
 695                 }
 696
 697                 if(!mem_proj)
 698                         mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
 699
 700                  /* Clean up the stack frame if we allocated it */
 701                 if(!no_alloc) {
 702                         curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
 703                         add_irn_dep(curr_sp, mem_proj);
 704                         if(alloca_copy) {
 705                                 add_irn_dep(curr_sp, alloca_copy);
 706                                 alloca_copy = NULL;
 707                         }
 708                 }
 709         }
 710
 711         be_abi_call_free(call);
 712         obstack_free(obst, pos);
 713         del_pset(results);
 714         del_pset(caller_save);
 715
 716         return curr_sp;
 717 }
 718
 719 /**
 720  * Adjust an alloca.
 721  * The alloca is transformed into a back end alloca node and connected to the stack nodes.
 722  */
 723 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
 724 {
 725         if (get_Alloc_where(alloc) == stack_alloc) {
 726                 ir_node *bl        = get_nodes_block(alloc);
 727                 ir_graph *irg      = get_irn_irg(bl);
 728                 ir_node *alloc_mem = NULL;
 729                 ir_node *alloc_res = NULL;
 730
 731                 const ir_edge_t *edge;
 732                 ir_node *new_alloc;
 733                 ir_node *addr;
 734                 ir_node *copy;
 735
 736                 foreach_out_edge(alloc, edge) {
 737                         ir_node *irn = get_edge_src_irn(edge);
 738
 739                         assert(is_Proj(irn));
 740                         switch(get_Proj_proj(irn)) {
 741                         case pn_Alloc_M:
 742                                 alloc_mem = irn;
 743                                 break;
 744                         case pn_Alloc_res:
 745                                 alloc_res = irn;
 746                                 break;
 747                         default:
 748                                 break;
 749                         }
 750                 }
 751
 752                 /* Beware: currently Alloc nodes without a result might happen,
 753                    only escape analysis kills them and this phase runs only for object
 754                    oriented source. We kill the Alloc here. */
 755                 if (alloc_res == NULL && alloc_mem) {
 756                         exchange(alloc_mem, get_Alloc_mem(alloc));
 757                         return curr_sp;
 758                 }
 759
 760                 /* The stack pointer will be modified in an unknown manner.
 761                    We cannot omit it. */
 762                 env->call->flags.bits.try_omit_fp = 0;
 763                 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
 764
 765                 exchange(alloc, new_alloc);
 766
 767                 if(alloc_mem != NULL)
 768                         set_Proj_proj(alloc_mem, pn_be_AddSP_M);
 769
 770                 /* fix projnum of alloca res */
 771                 set_Proj_proj(alloc_res, pn_be_AddSP_res);
 772
 773                 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
 774
 775                 /* copy the address away, since it could be used after further stack pointer modifications. */
 776                 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
 777                 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, bl, curr_sp);
 778
 779                 /* Let all users of the Alloc() result now point to the copy. */
 780                 edges_reroute(alloc_res, copy, irg);
 781
 782                 /* Rewire the copy appropriately. */
 783                 set_irn_n(copy, be_pos_Copy_op, addr);
 784
 785                 curr_sp = alloc_res;
 786         }
 787
 788         return curr_sp;
 789 }
 790
 791 /* the following function is replaced by the usage of the heights module */
 792 #if 0
 793 /**
 794  * Walker for dependent_on().
 795  * This function searches a node tgt recursively from a given node
 796  * but is restricted to the given block.
 797  * @return 1 if tgt was reachable from curr, 0 if not.
 798  */
 799 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
 800 {
 801         int n, i;
 802
 803         if (get_nodes_block(curr) != bl)
 804                 return 0;
 805
 806         if (curr == tgt)
 807                 return 1;
 808
 809         /* Phi functions stop the recursion inside a basic block */
 810         if (! is_Phi(curr)) {
 811                 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
 812                         if (check_dependence(get_irn_n(curr, i), tgt, bl))
 813                                 return 1;
 814                 }
 815         }
 816
 817         return 0;
 818 }
 819 #endif /* if 0 */
 820
 821 /**
 822  * Check if a node is somehow data dependent on another one.
 823  * both nodes must be in the same basic block.
 824  * @param n1 The first node.
 825  * @param n2 The second node.
 826  * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
 827  */
 828 static int dependent_on(ir_node *n1, ir_node *n2)
 829 {
 830         ir_node *bl   = get_nodes_block(n1);
 831
 832         assert(bl == get_nodes_block(n2));
 833
 834         return heights_reachable_in_block(ir_heights, n1, n2);
 835         //return check_dependence(n1, n2, bl);
 836 }
 837
 838 static int cmp_call_dependecy(const void *c1, const void *c2)
 839 {
 840         ir_node *n1 = *(ir_node **) c1;
 841         ir_node *n2 = *(ir_node **) c2;
 842
 843         /*
 844                 Classical qsort() comparison function behavior:
 845                 0  if both elements are equal
 846                 1  if second is "smaller" that first
 847                 -1 if first is "smaller" that second
 848         */
 849         if (dependent_on(n1, n2))
 850                 return -1;
 851
 852         if (dependent_on(n2, n1))
 853                 return 1;
 854
 855         return 0;
 856 }
 857
 858 /**
 859  * Walker: links all Call nodes to the Block they are contained.
 860  */
 861 static void link_calls_in_block_walker(ir_node *irn, void *data)
 862 {
 863         if(is_Call(irn) || (get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)) {
 864                 be_abi_irg_t *env = data;
 865                 ir_node *bl       = get_nodes_block(irn);
 866                 void *save        = get_irn_link(bl);
 867
 868                 if (is_Call(irn))
 869                         env->call->flags.bits.irg_is_leaf = 0;
 870
 871                 set_irn_link(irn, save);
 872                 set_irn_link(bl, irn);
 873         }
 874 }
 875
 876 /**
 877  * Block-walker:
 878  * Process all Call nodes inside a basic block.
 879  * Note that the link field of the block must contain a linked list of all
 880  * Call nodes inside the Block. We first order this list according to data dependency
 881  * and that connect the calls together.
 882  */
 883 static void process_calls_in_block(ir_node *bl, void *data)
 884 {
 885         be_abi_irg_t *env = data;
 886         ir_node *curr_sp  = env->init_sp;
 887         ir_node *irn;
 888         int n;
 889
 890         for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
 891                 obstack_ptr_grow(&env->obst, irn);
 892
 893         /* If there were call nodes in the block. */
 894         if(n > 0) {
 895                 ir_node *keep;
 896                 ir_node **nodes;
 897                 ir_node *copy = NULL;
 898                 int i;
 899
 900                 nodes = obstack_finish(&env->obst);
 901
 902                 /* order the call nodes according to data dependency */
 903                 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
 904
 905                 for(i = n - 1; i >= 0; --i) {
 906                         ir_node *irn = nodes[i];
 907
 908                         DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
 909                         switch(get_irn_opcode(irn)) {
 910                         case iro_Call:
 911                                 curr_sp = adjust_call(env, irn, curr_sp, copy);
 912                                 break;
 913                         case iro_Alloc:
 914                                 curr_sp = adjust_alloc(env, irn, curr_sp, &copy);
 915                                 break;
 916                         default:
 917                                 break;
 918                         }
 919                 }
 920
 921                 obstack_free(&env->obst, nodes);
 922
 923                 /* Keep the last stack state in the block by tying it to Keep node */
 924                 nodes[0] = curr_sp;
 925                 keep     = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
 926                 pmap_insert(env->keep_map, bl, keep);
 927         }
 928
 929         set_irn_link(bl, curr_sp);
 930 }
 931
 932 /**
 933  * Adjust all call nodes in the graph to the ABI conventions.
 934  */
 935 static void process_calls(be_abi_irg_t *env)
 936 {
 937         ir_graph *irg = env->birg->irg;
 938
 939         env->call->flags.bits.irg_is_leaf = 1;
 940         irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
 941
 942         ir_heights = heights_new(env->birg->irg);
 943         irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
 944         heights_free(ir_heights);
 945 }
 946
 947 static void collect_return_walker(ir_node *irn, void *data)
 948 {
 949         if(get_irn_opcode(irn) == iro_Return) {
 950                 struct obstack *obst = data;
 951                 obstack_ptr_grow(obst, irn);
 952         }
 953 }
 954
 955 #if 0 /*
 956 static ir_node *setup_frame(be_abi_irg_t *env)
 957 {
 958         const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
 959         const arch_register_t *sp = isa->sp;
 960         const arch_register_t *bp = isa->bp;
 961         be_abi_call_flags_bits_t flags = env->call->flags.bits;
 962         ir_graph *irg      = env->birg->irg;
 963         ir_node *bl        = get_irg_start_block(irg);
 964         ir_node *no_mem    = get_irg_no_mem(irg);
 965         ir_node *old_frame = get_irg_frame(irg);
 966         ir_node *stack     = pmap_get(env->regs, (void *) sp);
 967         ir_node *frame     = pmap_get(env->regs, (void *) bp);
 968
 969         int stack_nr       = get_Proj_proj(stack);
 970
 971         if(flags.try_omit_fp) {
 972                 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
 973                 frame = stack;
 974         }
 975
 976         else {
 977                 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
 978
 979                 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
 980                 if(!flags.fp_free) {
 981                         be_set_constr_single_reg(frame, -1, bp);
 982                         be_node_set_flags(frame, -1, arch_irn_flags_ignore);
 983                         arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
 984                 }
 985
 986                 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
 987         }
 988
 989         be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
 990         env->init_sp = stack;
 991         set_irg_frame(irg, frame);
 992         edges_reroute(old_frame, frame, irg);
 993
 994         return frame;
 995 }
 996
 997 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
 998 {
 999         const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1000         const arch_register_t *sp = isa->sp;
1001         const arch_register_t *bp = isa->bp;
1002         ir_graph *irg      = env->birg->irg;
1003         ir_node *ret_mem   = get_Return_mem(ret);
1004         ir_node *frame     = get_irg_frame(irg);
1005         ir_node *bl        = get_nodes_block(ret);
1006         ir_node *stack     = get_irn_link(bl);
1007
1008         pmap_entry *ent;
1009
1010         if(env->call->flags.bits.try_omit_fp) {
1011                 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1012         }
1013
1014         else {
1015                 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1016                 be_set_constr_single_reg(stack, -1, sp);
1017                 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1018         }
1019
1020         pmap_foreach(env->regs, ent) {
1021                 const arch_register_t *reg = ent->key;
1022                 ir_node *irn               = ent->value;
1023
1024                 if(reg == sp)
1025                         obstack_ptr_grow(&env->obst, stack);
1026                 else if(reg == bp)
1027                         obstack_ptr_grow(&env->obst, frame);
1028                 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1029                         obstack_ptr_grow(obst, irn);
1030         }
1031 }
1032 */
1033 #endif
1034
1035 /**
1036  * Computes the stack argument layout type.
1037  * Changes a possibly allocated value param type by moving
1038  * entities to the stack layout type.
1039  *
1040  * @param env          the ABI environment
1041  * @param call         the current call ABI
1042  * @param method_type  the method type
1043  *
1044  * @return the stack argument layout type
1045  */
1046 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type)
1047 {
1048         int dir  = env->call->flags.bits.left_to_right ? 1 : -1;
1049         int inc  = env->birg->main_env->arch_env->isa->stack_dir * dir;
1050         int n    = get_method_n_params(method_type);
1051         int curr = inc > 0 ? 0 : n - 1;
1052         int ofs  = 0;
1053
1054         char buf[128];
1055         ir_type *res;
1056         int i;
1057         ir_type *val_param_tp = get_method_value_param_type(method_type);
1058         ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1059
1060         res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1061         for (i = 0; i < n; ++i, curr += inc) {
1062                 ir_type *param_type    = get_method_param_type(method_type, curr);
1063                 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1064
1065                 if (arg->on_stack) {
1066                         if (val_param_tp) {
1067                                 /* the entity was already created, move it to the param type */
1068                                 arg->stack_ent = get_method_value_param_ent(method_type, i);
1069                                 remove_struct_member(val_param_tp, arg->stack_ent);
1070                                 set_entity_owner(arg->stack_ent, res);
1071                                 add_struct_member(res, arg->stack_ent);
1072                                 /* must be automatic to set a fixed layout */
1073                                 set_entity_allocation(arg->stack_ent, allocation_automatic);
1074                         }
1075                         else {
1076                                 snprintf(buf, sizeof(buf), "param_%d", i);
1077                                 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1078                         }
1079                         ofs += arg->space_before;
1080                         ofs = round_up2(ofs, arg->alignment);
1081                         set_entity_offset_bytes(arg->stack_ent, ofs);
1082                         ofs += arg->space_after;
1083                         ofs += get_type_size_bytes(param_type);
1084                 }
1085         }
1086         set_type_size_bytes(res, ofs);
1087         set_type_state(res, layout_fixed);
1088         return res;
1089 }
1090
1091 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1092 {
1093         int i, j, n;
1094         struct obstack obst;
1095
1096         obstack_init(&obst);
1097
1098         /* Create a Perm after the RegParams node to delimit it. */
1099         for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1100                 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1101                 ir_node *perm;
1102                 ir_node **in;
1103                 int n_regs;
1104
1105                 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1106                         const arch_register_t *reg = &cls->regs[j];
1107                         ir_node *irn = pmap_get(regs, (void *) reg);
1108
1109                         if(irn && !arch_register_type_is(reg, ignore)) {
1110                                 n_regs++;
1111                                 obstack_ptr_grow(&obst, irn);
1112                                 set_irn_link(irn, (void *) reg);
1113                         }
1114                 }
1115
1116                 obstack_ptr_grow(&obst, NULL);
1117                 in = obstack_finish(&obst);
1118                 if(n_regs > 0) {
1119                         perm = be_new_Perm(cls, irg, bl, n_regs, in);
1120                         for(j = 0; j < n_regs; ++j) {
1121                                 ir_node *arg = in[j];
1122                                 arch_register_t *reg = get_irn_link(arg);
1123                                 pmap_insert(regs, reg, arg);
1124                                 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1125                         }
1126                 }
1127                 obstack_free(&obst, in);
1128         }
1129
1130         obstack_free(&obst, NULL);
1131 }
1132
1133 typedef struct {
1134         const arch_register_t *reg;
1135         ir_node *irn;
1136 } reg_node_map_t;
1137
1138 static int cmp_regs(const void *a, const void *b)
1139 {
1140         const reg_node_map_t *p = a;
1141         const reg_node_map_t *q = b;
1142
1143         if(p->reg->reg_class == q->reg->reg_class)
1144                 return p->reg->index - q->reg->index;
1145         else
1146                 return p->reg->reg_class - q->reg->reg_class;
1147 }
1148
1149 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1150 {
1151         pmap_entry *ent;
1152         int n = pmap_count(reg_map);
1153         int i = 0;
1154         reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1155
1156         pmap_foreach(reg_map, ent) {
1157                 res[i].reg = ent->key;
1158                 res[i].irn = ent->value;
1159                 i++;
1160         }
1161
1162         qsort(res, n, sizeof(res[0]), cmp_regs);
1163         return res;
1164 }
1165
1166 /**
1167  * Creates a barrier.
1168  */
1169 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1170 {
1171         ir_graph *irg = env->birg->irg;
1172         int n_regs    = pmap_count(regs);
1173         int n;
1174         ir_node *irn;
1175         ir_node **in;
1176         reg_node_map_t *rm;
1177
1178         rm = reg_map_to_arr(&env->obst, regs);
1179
1180         for(n = 0; n < n_regs; ++n)
1181                 obstack_ptr_grow(&env->obst, rm[n].irn);
1182
1183         if(mem) {
1184                 obstack_ptr_grow(&env->obst, *mem);
1185                 n++;
1186         }
1187
1188         in = (ir_node **) obstack_finish(&env->obst);
1189         irn = be_new_Barrier(irg, bl, n, in);
1190         obstack_free(&env->obst, in);
1191
1192         for(n = 0; n < n_regs; ++n) {
1193                 const arch_register_t *reg = rm[n].reg;
1194                 int flags                  = 0;
1195                 int pos                    = BE_OUT_POS(n);
1196                 ir_node *proj;
1197
1198                 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1199                 be_node_set_reg_class(irn, n, reg->reg_class);
1200                 if(in_req)
1201                         be_set_constr_single_reg(irn, n, reg);
1202                 be_set_constr_single_reg(irn, pos, reg);
1203                 be_node_set_reg_class(irn, pos, reg->reg_class);
1204                 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1205
1206                 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1207                 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1208                         flags |= arch_irn_flags_ignore;
1209
1210                 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1211                         flags |= arch_irn_flags_modify_sp;
1212
1213                 be_node_set_flags(irn, pos, flags);
1214
1215                 pmap_insert(regs, (void *) reg, proj);
1216         }
1217
1218         if(mem) {
1219                 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1220         }
1221
1222         obstack_free(&env->obst, rm);
1223         return irn;
1224 }
1225
1226 /**
1227  * Creates a be_Return for a Return node.
1228  *
1229  * @param @env    the abi environment
1230  * @param irn     the Return node or NULL if there was none
1231  * @param bl      the block where the be_Retun should be placed
1232  * @param mem     the current memory
1233  * @param n_res   number of return results
1234  */
1235 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1236         be_abi_call_t *call = env->call;
1237         const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1238
1239         pmap *reg_map  = pmap_create();
1240         ir_node *keep  = pmap_get(env->keep_map, bl);
1241         int in_max;
1242         ir_node *ret;
1243         int i, n;
1244         ir_node **in;
1245         ir_node *stack;
1246         const arch_register_t **regs;
1247         pmap_entry *ent ;
1248
1249         /*
1250                 get the valid stack node in this block.
1251                 If we had a call in that block there is a Keep constructed by process_calls()
1252                 which points to the last stack modification in that block. we'll use
1253                 it then. Else we use the stack from the start block and let
1254                 the ssa construction fix the usage.
1255         */
1256         stack = be_abi_reg_map_get(env->regs, isa->sp);
1257         if (keep) {
1258                 ir_node *bad = new_r_Bad(env->birg->irg);
1259                 stack = get_irn_n(keep, 0);
1260                 set_nodes_block(keep, bad);
1261                 set_irn_n(keep, 0, bad);
1262                 // exchange(keep, new_r_Bad(env->birg->irg));
1263         }
1264
1265         /* Insert results for Return into the register map. */
1266         for(i = 0; i < n_res; ++i) {
1267                 ir_node *res           = get_Return_res(irn, i);
1268                 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1269                 assert(arg->in_reg && "return value must be passed in register");
1270                 pmap_insert(reg_map, (void *) arg->reg, res);
1271         }
1272
1273         /* Add uses of the callee save registers. */
1274         pmap_foreach(env->regs, ent) {
1275                 const arch_register_t *reg = ent->key;
1276                 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1277                         pmap_insert(reg_map, ent->key, ent->value);
1278         }
1279
1280         be_abi_reg_map_set(reg_map, isa->sp, stack);
1281
1282         /* Make the Epilogue node and call the arch's epilogue maker. */
1283         create_barrier(env, bl, &mem, reg_map, 1);
1284         call->cb->epilogue(env->cb, bl, &mem, reg_map);
1285
1286         /*
1287                 Maximum size of the in array for Return nodes is
1288                 return args + callee save/ignore registers + memory + stack pointer
1289         */
1290         in_max = pmap_count(reg_map) + n_res + 2;
1291
1292         in   = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1293         regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1294
1295         in[0]   = mem;
1296         in[1]   = be_abi_reg_map_get(reg_map, isa->sp);
1297         regs[0] = NULL;
1298         regs[1] = isa->sp;
1299         n       = 2;
1300
1301         /* clear SP entry, since it has already been grown. */
1302         pmap_insert(reg_map, (void *) isa->sp, NULL);
1303         for(i = 0; i < n_res; ++i) {
1304                 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1305
1306                 in[n]     = be_abi_reg_map_get(reg_map, arg->reg);
1307                 regs[n++] = arg->reg;
1308
1309                 /* Clear the map entry to mark the register as processed. */
1310                 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1311         }
1312
1313         /* grow the rest of the stuff. */
1314         pmap_foreach(reg_map, ent) {
1315                 if(ent->value) {
1316                         in[n]     = ent->value;
1317                         regs[n++] = ent->key;
1318                 }
1319         }
1320
1321         /* The in array for the new back end return is now ready. */
1322         ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1323
1324         /* Set the register classes of the return's parameter accordingly. */
1325         for(i = 0; i < n; ++i)
1326                 if(regs[i])
1327                         be_node_set_reg_class(ret, i, regs[i]->reg_class);
1328
1329         /* Free the space of the Epilog's in array and the register <-> proj map. */
1330         obstack_free(&env->obst, in);
1331         pmap_destroy(reg_map);
1332
1333         return ret;
1334 }
1335
1336 typedef struct lower_frame_sels_env_t {
1337         be_abi_irg_t *env;
1338         entity       *value_param_list;  /**< the list of all value param antities */
1339 } lower_frame_sels_env_t;
1340
1341 /**
1342  * Walker: Replaces Sels of frame type and
1343  * value param type entities by FrameAddress.
1344  */
1345 static void lower_frame_sels_walker(ir_node *irn, void *data)
1346 {
1347         lower_frame_sels_env_t *ctx = data;
1348
1349         if (is_Sel(irn)) {
1350                 ir_graph *irg        = current_ir_graph;
1351                 ir_node  *frame      = get_irg_frame(irg);
1352                 ir_node  *param_base = get_irg_value_param_base(irg);
1353                 ir_node  *ptr        = get_Sel_ptr(irn);
1354
1355                 if (ptr == frame || ptr == param_base) {
1356                         be_abi_irg_t *env = ctx->env;
1357                         entity       *ent = get_Sel_entity(irn);
1358                         ir_node      *bl  = get_nodes_block(irn);
1359                         ir_node      *nw;
1360
1361                         nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1362                         exchange(irn, nw);
1363
1364                         if (ptr == param_base) {
1365                                 set_entity_link(ent, ctx->value_param_list);
1366                                 ctx->value_param_list = ent;
1367                         }
1368                 }
1369         }
1370 }
1371
1372 /**
1373  * Check if a value parameter is transmitted as a register.
1374  * This might happen if the address of an parameter is taken which is
1375  * transmitted in registers.
1376  *
1377  * Note that on some architectures this case must be handled specially
1378  * because the place of the backing store is determined by their ABI.
1379  *
1380  * In the default case we move the entity to the frame type and create
1381  * a backing store into the first block.
1382  */
1383 static void fix_address_of_parameter_access(be_abi_irg_t *env, entity *value_param_list) {
1384         be_abi_call_t *call = env->call;
1385         ir_graph *irg       = env->birg->irg;
1386         entity *ent, *next_ent, *new_list;
1387         ir_type *frame_tp;
1388         DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1389
1390         new_list = NULL;
1391         for (ent = value_param_list; ent; ent = next_ent) {
1392                 int i = get_struct_member_index(get_entity_owner(ent), ent);
1393                 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1394
1395                 next_ent = get_entity_link(ent);
1396                 if (arg->in_reg) {
1397                         DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1398                         set_entity_link(ent, new_list);
1399                         new_list = ent;
1400                 }
1401         }
1402         if (new_list) {
1403                 /* ok, change the graph */
1404                 ir_node *start_bl = get_irg_start_block(irg);
1405                 ir_node *first_bl = NULL;
1406                 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1407                 const ir_edge_t *edge;
1408                 optimization_state_t state;
1409                 int offset;
1410
1411                 foreach_block_succ(start_bl, edge) {
1412                         ir_node *succ = get_edge_src_irn(edge);
1413                         if (start_bl != succ) {
1414                                 first_bl = succ;
1415                                 break;
1416                         }
1417                 }
1418                 assert(first_bl);
1419                 /* we had already removed critical edges, so the following
1420                    assertion should be always true. */
1421                 assert(get_Block_n_cfgpreds(first_bl) == 1);
1422
1423                 /* now create backing stores */
1424                 frame = get_irg_frame(irg);
1425                 imem = get_irg_initial_mem(irg);
1426
1427                 save_optimization_state(&state);
1428                 set_optimize(0);
1429                 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1430                 restore_optimization_state(&state);
1431
1432                 /* reroute all edges to the new memory source */
1433                 edges_reroute(imem, nmem, irg);
1434
1435                 store   = NULL;
1436                 mem     = imem;
1437                 args    = get_irg_args(irg);
1438                 args_bl = get_nodes_block(args);
1439                 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1440                         int     i     = get_struct_member_index(get_entity_owner(ent), ent);
1441                         ir_type *tp   = get_entity_type(ent);
1442                         ir_mode *mode = get_type_mode(tp);
1443                         ir_node *addr;
1444
1445                         /* address for the backing store */
1446                         addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1447
1448                         if (store)
1449                                 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1450
1451                         /* the backing store itself */
1452                         store = new_r_Store(irg, first_bl, mem, addr,
1453                                             new_r_Proj(irg, args_bl, args, mode, i));
1454                 }
1455                 /* the new memory Proj gets the last Proj from store */
1456                 set_Proj_pred(nmem, store);
1457                 set_Proj_proj(nmem, pn_Store_M);
1458
1459                 /* move all entities to the frame type */
1460                 frame_tp = get_irg_frame_type(irg);
1461                 offset   = get_type_size_bytes(frame_tp);
1462                 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1463                         ir_type *tp = get_entity_type(ent);
1464                         int align = get_type_alignment_bytes(tp);
1465
1466                         offset += align - 1;
1467                         offset &= -align;
1468                         set_entity_owner(ent, frame_tp);
1469                         add_class_member(frame_tp, ent);
1470                         /* must be automatic to set a fixed layout */
1471                         set_entity_allocation(ent, allocation_automatic);
1472                         set_entity_offset_bytes(ent, offset);
1473                         offset += get_type_size_bytes(tp);
1474                 }
1475                 set_type_size_bytes(frame_tp, offset);
1476         }
1477 }
1478
1479 /**
1480  * Modify the irg itself and the frame type.
1481  */
1482 static void modify_irg(be_abi_irg_t *env)
1483 {
1484         be_abi_call_t *call       = env->call;
1485         const arch_isa_t *isa     = env->birg->main_env->arch_env->isa;
1486         const arch_register_t *sp = arch_isa_sp(isa);
1487         ir_graph *irg             = env->birg->irg;
1488         ir_node *bl               = get_irg_start_block(irg);
1489         ir_node *end              = get_irg_end_block(irg);
1490         ir_node *no_mem           = get_irg_no_mem(irg);
1491         ir_node *mem              = get_irg_initial_mem(irg);
1492         ir_type *method_type      = get_entity_type(get_irg_entity(irg));
1493         pset *dont_save           = pset_new_ptr(8);
1494
1495         int n_params;
1496         int i, j, n;
1497
1498         reg_node_map_t *rm;
1499         const arch_register_t *fp_reg;
1500         ir_node *frame_pointer;
1501         ir_node *barrier;
1502         ir_node *reg_params_bl;
1503         ir_node **args;
1504         ir_node *arg_tuple;
1505         const ir_edge_t *edge;
1506         ir_type *arg_type, *bet_type;
1507         lower_frame_sels_env_t ctx;
1508
1509         bitset_t *used_proj_nr;
1510         DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1511
1512         DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1513
1514         /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1515         ctx.env              = env;
1516         ctx.value_param_list = NULL;
1517         irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1518
1519         env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1520         env->regs  = pmap_create();
1521
1522         used_proj_nr = bitset_alloca(1024);
1523         n_params     = get_method_n_params(method_type);
1524         args         = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1525         memset(args, 0, n_params * sizeof(args[0]));
1526
1527         /* Check if a value parameter is transmitted as a register.
1528          * This might happen if the address of an parameter is taken which is
1529          * transmitted in registers.
1530          *
1531          * Note that on some architectures this case must be handled specially
1532          * because the place of the backing store is determined by their ABI.
1533          *
1534          * In the default case we move the entity to the frame type and create
1535          * a backing store into the first block.
1536          */
1537         fix_address_of_parameter_access(env, ctx.value_param_list);
1538
1539         /* Fill the argument vector */
1540         arg_tuple = get_irg_args(irg);
1541         foreach_out_edge(arg_tuple, edge) {
1542                 ir_node *irn = get_edge_src_irn(edge);
1543                 int nr       = get_Proj_proj(irn);
1544                 args[nr]     = irn;
1545                 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1546         }
1547
1548         arg_type = compute_arg_type(env, call, method_type);
1549         bet_type = call->cb->get_between_type(env->cb);
1550         stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir);
1551
1552         /* Count the register params and add them to the number of Projs for the RegParams node */
1553         for(i = 0; i < n_params; ++i) {
1554                 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1555                 if(arg->in_reg && args[i]) {
1556                         assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1557                         assert(i == get_Proj_proj(args[i]));
1558
1559                         /* For now, associate the register with the old Proj from Start representing that argument. */
1560                         pmap_insert(env->regs, (void *) arg->reg, args[i]);
1561                         bitset_set(used_proj_nr, i);
1562                         DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1563                 }
1564         }
1565
1566         /* Collect all callee-save registers */
1567         for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1568                 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1569                 for(j = 0; j < cls->n_regs; ++j) {
1570                         const arch_register_t *reg = &cls->regs[j];
1571                         if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1572                                 pmap_insert(env->regs, (void *) reg, NULL);
1573                 }
1574         }
1575
1576         pmap_insert(env->regs, (void *) sp, NULL);
1577         pmap_insert(env->regs, (void *) isa->bp, NULL);
1578         reg_params_bl   = get_irg_start_block(irg);
1579         env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1580
1581         /*
1582          * make proj nodes for the callee save registers.
1583          * memorize them, since Return nodes get those as inputs.
1584          *
1585          * Note, that if a register corresponds to an argument, the regs map contains
1586          * the old Proj from start for that argument.
1587          */
1588
1589         rm = reg_map_to_arr(&env->obst, env->regs);
1590         for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1591                 arch_register_t *reg = (void *) rm[i].reg;
1592                 ir_node *arg_proj    = rm[i].irn;
1593                 ir_mode *mode        = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1594                 long nr              = i;
1595                 int pos              = BE_OUT_POS((int) nr);
1596                 int flags            = 0;
1597
1598                 ir_node *proj;
1599
1600                 assert(nr >= 0);
1601                 bitset_set(used_proj_nr, nr);
1602                 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1603                 pmap_insert(env->regs, (void *) reg, proj);
1604                 be_set_constr_single_reg(env->reg_params, pos, reg);
1605                 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1606
1607                 /*
1608                  * If the register is an ignore register,
1609                  * The Proj for that register shall also be ignored during register allocation.
1610                  */
1611                 if(arch_register_type_is(reg, ignore))
1612                         flags |= arch_irn_flags_ignore;
1613
1614                 if(reg == sp)
1615                         flags |= arch_irn_flags_modify_sp;
1616
1617                 be_node_set_flags(env->reg_params, pos, flags);
1618
1619                 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1620         }
1621         obstack_free(&env->obst, rm);
1622
1623         /* Generate the Prologue */
1624         fp_reg  = call->cb->prologue(env->cb, &mem, env->regs);
1625
1626         /* do the stack allocation BEFORE the barrier, or spill code
1627            might be added before it */
1628         env->init_sp  = be_abi_reg_map_get(env->regs, sp);
1629         env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1630         be_abi_reg_map_set(env->regs, sp, env->init_sp);
1631
1632         barrier = create_barrier(env, bl, &mem, env->regs, 0);
1633
1634         env->init_sp  = be_abi_reg_map_get(env->regs, sp);
1635         arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1636
1637         frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1638         set_irg_frame(irg, frame_pointer);
1639         pset_insert_ptr(env->ignore_regs, fp_reg);
1640
1641         /* Now, introduce stack param nodes for all parameters passed on the stack */
1642         for(i = 0; i < n_params; ++i) {
1643                 ir_node *arg_proj = args[i];
1644                 ir_node *repl     = NULL;
1645
1646                 if(arg_proj != NULL) {
1647                         be_abi_call_arg_t *arg;
1648                         ir_type *param_type;
1649                         int nr = get_Proj_proj(arg_proj);
1650
1651                         nr         = MIN(nr, n_params);
1652                         arg        = get_call_arg(call, 0, nr);
1653                         param_type = get_method_param_type(method_type, nr);
1654
1655                         if(arg->in_reg) {
1656                                 repl = pmap_get(env->regs, (void *) arg->reg);
1657                         }
1658
1659                         else if(arg->on_stack) {
1660                                 /* For atomic parameters which are actually used, we create a StackParam node. */
1661                                 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1662                                         ir_mode *mode                    = get_type_mode(param_type);
1663                                         const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1664                                         repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1665                                 }
1666
1667                                 /* The stack parameter is not primitive (it is a struct or array),
1668                                 we thus will create a node representing the parameter's address
1669                                 on the stack. */
1670                                 else {
1671                                         repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1672                                 }
1673                         }
1674
1675                         assert(repl != NULL);
1676                         edges_reroute(args[i], repl, irg);
1677                 }
1678         }
1679
1680         /* All Return nodes hang on the End node, so look for them there. */
1681         for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1682                 ir_node *irn = get_Block_cfgpred(end, i);
1683
1684                 if (is_Return(irn)) {
1685                         ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1686                         exchange(irn, ret);
1687                 }
1688         }
1689         /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1690            the code is dead and will never be executed. */
1691
1692         del_pset(dont_save);
1693         obstack_free(&env->obst, args);
1694 }
1695
1696 /**
1697  * Walker: puts all Alloc(stack_alloc) on a obstack
1698  */
1699 static void collect_alloca_walker(ir_node *irn, void *data)
1700 {
1701         be_abi_irg_t *env = data;
1702         if(get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)
1703                 obstack_ptr_grow(&env->obst, irn);
1704 }
1705
1706 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1707 {
1708         be_abi_irg_t *env  = xmalloc(sizeof(env[0]));
1709         ir_node *old_frame = get_irg_frame(birg->irg);
1710         ir_graph *irg      = birg->irg;
1711
1712         pmap_entry *ent;
1713         ir_node *dummy;
1714         optimization_state_t state;
1715
1716         obstack_init(&env->obst);
1717
1718         env->isa           = birg->main_env->arch_env->isa;
1719         env->method_type   = get_entity_type(get_irg_entity(irg));
1720         env->call          = be_abi_call_new();
1721         arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1722
1723         env->ignore_regs      = pset_new_ptr_default();
1724         env->keep_map         = pmap_create();
1725         env->dce_survivor     = new_survive_dce();
1726         env->birg             = birg;
1727         env->stack_phis       = pset_new_ptr(16);
1728         /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1729            to another Unknown or the stack pointer gets used */
1730         save_optimization_state(&state);
1731         set_optimize(0);
1732         env->init_sp = dummy  = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1733         restore_optimization_state(&state);
1734         FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1735
1736         memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1737         env->irn_ops.impl = &abi_irn_ops;
1738
1739         /* Lower all call nodes in the IRG. */
1740         process_calls(env);
1741
1742         /*
1743                 Beware: init backend abi call object after processing calls,
1744                 otherwise some information might be not yet available.
1745         */
1746         env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1747
1748         /* Process the IRG */
1749         modify_irg(env);
1750
1751         /* We don't need the keep map anymore. */
1752         pmap_destroy(env->keep_map);
1753
1754         /* reroute the stack origin of the calls to the true stack origin. */
1755         edges_reroute(dummy, env->init_sp, irg);
1756         edges_reroute(old_frame, get_irg_frame(irg), irg);
1757
1758         /* Make some important node pointers survive the dead node elimination. */
1759         survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1760         pmap_foreach(env->regs, ent)
1761                 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1762
1763         arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1764
1765         env->call->cb->done(env->cb);
1766         return env;
1767 }
1768
1769 void be_abi_free(be_abi_irg_t *env)
1770 {
1771         free_survive_dce(env->dce_survivor);
1772         del_pset(env->stack_phis);
1773         del_pset(env->ignore_regs);
1774         pmap_destroy(env->regs);
1775         obstack_free(&env->obst, NULL);
1776         arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1777         free(env);
1778 }
1779
1780 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1781 {
1782         arch_register_t *reg;
1783
1784         for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1785                 if(reg->reg_class == cls)
1786                         bitset_set(bs, reg->index);
1787 }
1788
1789
1790 /*
1791
1792   _____ _        ____  _             _
1793  |  ___(_)_  __ / ___|| |_ __ _  ___| | __
1794  | |_  | \ \/ / \___ \| __/ _` |/ __| |/ /
1795  |  _| | |>  <   ___) | || (_| | (__|   <
1796  |_|   |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1797
1798 */
1799
1800 struct fix_stack_walker_info {
1801         nodeset *nodes;
1802         const arch_env_t *aenv;
1803 };
1804
1805 /**
1806  * Walker. Collect all stack modifying nodes.
1807  */
1808 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1809 {
1810         struct fix_stack_walker_info *info = data;
1811
1812         if (is_Block(irn))
1813                 return;
1814
1815         if (arch_irn_is(info->aenv, irn, modify_sp)) {
1816                 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1817                 pset_insert_ptr(info->nodes, irn);
1818         }
1819 }
1820
1821 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1822 {
1823         dom_front_info_t *df;
1824         pset *stack_nodes = pset_new_ptr(16);
1825         struct fix_stack_walker_info info;
1826
1827         info.nodes = stack_nodes;
1828         info.aenv  = env->birg->main_env->arch_env;
1829
1830         /* We need dominance frontiers for fix up */
1831         df = be_compute_dominance_frontiers(env->birg->irg);
1832         irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1833         pset_insert_ptr(stack_nodes, env->init_sp);
1834         be_ssa_constr_set_phis(df, lv, stack_nodes, env->stack_phis);
1835         del_pset(stack_nodes);
1836
1837         /* free these dominance frontiers */
1838         be_free_dominance_frontiers(df);
1839 }
1840
1841 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1842 {
1843         const arch_env_t *arch_env = env->birg->main_env->arch_env;
1844         int omit_fp            = env->call->flags.bits.try_omit_fp;
1845         ir_node *irn;
1846
1847         sched_foreach(bl, irn) {
1848
1849                 /*
1850                    Check, if the node relates to an entity on the stack frame.
1851                    If so, set the true offset (including the bias) for that
1852                    node.
1853                  */
1854                 entity *ent = arch_get_frame_entity(arch_env, irn);
1855                 if(ent) {
1856                         int offset = get_stack_entity_offset(env->frame, ent, bias);
1857                         arch_set_frame_offset(arch_env, irn, offset);
1858                         DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
1859                 }
1860
1861                 /*
1862                    If the node modifies the stack pointer by a constant offset,
1863                    record that in the bias.
1864                  */
1865                 if(arch_irn_is(arch_env, irn, modify_sp)) {
1866                         int ofs = arch_get_sp_bias(arch_env, irn);
1867
1868                         if(be_is_IncSP(irn)) {
1869                                 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
1870                                         ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1871                                         be_set_IncSP_offset(irn, ofs);
1872                                 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
1873                                         ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1874                                         be_set_IncSP_offset(irn, ofs);
1875                                 }
1876                         }
1877
1878                         if(omit_fp)
1879                                 bias += ofs;
1880                 }
1881         }
1882
1883         return bias;
1884 }
1885
1886 /**
1887  * A helper struct for the bias walker.
1888  */
1889 struct bias_walk {
1890         be_abi_irg_t *env;     /**< The ABI irg environment. */
1891         int start_block_bias;  /**< The bias at the end of the start block. */
1892         ir_node *start_block;  /**< The start block of the current graph. */
1893 };
1894
1895 /**
1896  * Block-Walker: fix all stack offsets
1897  */
1898 static void stack_bias_walker(ir_node *bl, void *data)
1899 {
1900         struct bias_walk *bw = data;
1901         if (bl != bw->start_block) {
1902                 process_stack_bias(bw->env, bl, bw->start_block_bias);
1903         }
1904 }
1905
1906 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1907 {
1908         ir_graph *irg  = env->birg->irg;
1909         struct bias_walk bw;
1910
1911         stack_frame_compute_initial_offset(env->frame);
1912         // stack_layout_dump(stdout, env->frame);
1913
1914         /* Determine the stack bias at the end of the start block. */
1915         bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1916
1917         /* fix the bias is all other blocks */
1918         bw.env = env;
1919         bw.start_block = get_irg_start_block(irg);
1920         irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1921 }
1922
1923 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1924 {
1925         assert(arch_register_type_is(reg, callee_save));
1926         assert(pmap_contains(abi->regs, (void *) reg));
1927         return pmap_get(abi->regs, (void *) reg);
1928 }
1929
1930 /*
1931   _____ _____  _   _   _    _                 _ _
1932  |_   _|  __ \| \ | | | |  | |               | | |
1933    | | | |__) |  \| | | |__| | __ _ _ __   __| | | ___ _ __
1934    | | |  _  /| . ` | |  __  |/ _` | '_ \ / _` | |/ _ \ '__|
1935   _| |_| | \ \| |\  | | |  | | (_| | | | | (_| | |  __/ |
1936  |_____|_|  \_\_| \_| |_|  |_|\__,_|_| |_|\__,_|_|\___|_|
1937
1938   for Phi nodes which are created due to stack modifying nodes
1939   such as IncSP, AddSP and SetSP.
1940
1941   These Phis are always to be ignored by the reg alloc and are
1942   fixed on the SP register of the ISA.
1943 */
1944
1945 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
1946 {
1947         const be_abi_irg_t *abi = get_abi_from_handler(handler);
1948         const void *res = NULL;
1949
1950         if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
1951                 res = &abi->irn_ops;
1952
1953         return res;
1954 }
1955
1956 static void be_abi_limited(void *data, bitset_t *bs)
1957 {
1958         be_abi_irg_t *abi = data;
1959         bitset_clear_all(bs);
1960         bitset_set(bs, abi->isa->sp->index);
1961 }
1962
1963 static const arch_register_req_t *abi_get_irn_reg_req(const void *self, arch_register_req_t *req, const ir_node *irn, int pos)
1964 {
1965         be_abi_irg_t *abi          = get_abi_from_ops(self);
1966         const arch_register_t *reg = abi->isa->sp;
1967
1968         memset(req, 0, sizeof(req[0]));
1969
1970         if(pos == BE_OUT_POS(0)) {
1971                 req->cls         = reg->reg_class;
1972                 req->type        = arch_register_req_type_limited;
1973                 req->limited     = be_abi_limited;
1974                 req->limited_env = abi;
1975         }
1976
1977         else if(pos >= 0 && pos < get_irn_arity(irn)) {
1978                 req->cls  = reg->reg_class;
1979                 req->type = arch_register_req_type_normal;
1980         }
1981
1982         return req;
1983 }
1984
1985 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
1986 {
1987 }
1988
1989 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
1990 {
1991         const be_abi_irg_t *abi = get_abi_from_ops(self);
1992         return abi->isa->sp;
1993 }
1994
1995 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
1996 {
1997         return arch_irn_class_normal;
1998 }
1999
2000 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2001 {
2002         return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2003 }
2004
2005 static entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2006 {
2007         return NULL;
2008 }
2009
2010 static void abi_set_frame_entity(const void *_self, ir_node *irn, entity *ent)
2011 {
2012 }
2013
2014 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2015 {
2016 }
2017
2018 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2019 {
2020         return 0;
2021 }
2022
2023 static const arch_irn_ops_if_t abi_irn_ops = {
2024         abi_get_irn_reg_req,
2025         abi_set_irn_reg,
2026         abi_get_irn_reg,
2027         abi_classify,
2028         abi_get_flags,
2029         abi_get_frame_entity,
2030         abi_set_frame_entity,
2031         abi_set_frame_offset,
2032         abi_get_sp_bias,
2033         NULL,    /* get_inverse             */
2034         NULL,    /* get_op_estimated_cost   */
2035         NULL,    /* possible_memory_operand */
2036         NULL,    /* perform_memory_operand  */
2037 };
2038
2039 static const arch_irn_handler_t abi_irn_handler = {
2040         abi_get_irn_ops
2041 };