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

   1 /*
   2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Backend ABI implementation.
  23  * @author      Sebastian Hack, Michael Beck
  24  * @version     $Id$
  25  */
  26 #include "config.h"
  27
  28 #include "obst.h"
  29
  30 #include "irgopt.h"
  31
  32 #include "irgraph_t.h"
  33 #include "irnode_t.h"
  34 #include "ircons_t.h"
  35 #include "iredges_t.h"
  36 #include "irgmod.h"
  37 #include "irgwalk.h"
  38 #include "irprintf_t.h"
  39 #include "irgopt.h"
  40 #include "irbitset.h"
  41 #include "iropt_t.h"
  42 #include "heights.h"
  43 #include "pdeq.h"
  44 #include "irtools.h"
  45 #include "raw_bitset.h"
  46 #include "error.h"
  47 #include "pset_new.h"
  48
  49 #include "be.h"
  50 #include "beabi.h"
  51 #include "bearch.h"
  52 #include "benode.h"
  53 #include "belive_t.h"
  54 #include "besched.h"
  55 #include "beirg.h"
  56 #include "bessaconstr.h"
  57 #include "bemodule.h"
  58 #include "betranshlp.h"
  59
  60 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
  61
  62 typedef struct be_abi_call_arg_t {
  63         unsigned is_res   : 1;  /**< 1: the call argument is a return value. 0: it's a call parameter. */
  64         unsigned in_reg   : 1;  /**< 1: this argument is transmitted in registers. */
  65         unsigned on_stack : 1;  /**< 1: this argument is transmitted on the stack. */
  66         unsigned callee   : 1;  /**< 1: someone called us. 0: We call another function */
  67
  68         int                    pos;
  69         const arch_register_t *reg;
  70         ir_entity             *stack_ent;
  71         ir_mode               *load_mode;
  72         unsigned               alignment;    /**< stack alignment */
  73         unsigned               space_before; /**< allocate space before */
  74         unsigned               space_after;  /**< allocate space after */
  75 } be_abi_call_arg_t;
  76
  77 struct be_abi_call_t {
  78         be_abi_call_flags_t          flags;  /**< Flags describing the ABI behavior on calls */
  79         int                          pop;    /**< number of bytes the stack frame is shrinked by the callee on return. */
  80         const be_abi_callbacks_t    *cb;
  81         ir_type                     *between_type;
  82         set                         *params;
  83         const arch_register_class_t *cls_addr; /**< register class of the call address */
  84 };
  85
  86 /**
  87  * The ABI information for the current graph.
  88  */
  89 struct be_abi_irg_t {
  90         be_abi_call_t        *call;         /**< The ABI call information. */
  91
  92         ir_node              *init_sp;      /**< The node representing the stack pointer
  93                                                  at the start of the function. */
  94
  95         ir_node              *start;        /**< The be_Start params node. */
  96         pmap                 *regs;         /**< A map of all callee-save and ignore regs to
  97                                                  their Projs to the RegParams node. */
  98         int                  start_block_bias; /**< The stack bias at the end of the start block. */
  99
 100         pmap                 *keep_map;     /**< mapping blocks to keep nodes. */
 101
 102         ir_node              **calls;       /**< flexible array containing all be_Call nodes */
 103 };
 104
 105 static ir_heights_t *ir_heights;
 106
 107 /** Flag: if set, try to omit the frame pointer in all routines. */
 108 static int be_omit_fp = 1;
 109
 110 static ir_node *be_abi_reg_map_get(pmap *map, const arch_register_t *reg)
 111 {
 112         return (ir_node*)pmap_get(map, reg);
 113 }
 114
 115 static void be_abi_reg_map_set(pmap *map, const arch_register_t* reg,
 116                                ir_node *node)
 117 {
 118         pmap_insert(map, reg, node);
 119 }
 120
 121 /*
 122      _    ____ ___    ____      _ _ _                _
 123     / \  | __ )_ _|  / ___|__ _| | | |__   __ _  ___| | _____
 124    / _ \ |  _ \| |  | |   / _` | | | '_ \ / _` |/ __| |/ / __|
 125   / ___ \| |_) | |  | |__| (_| | | | |_) | (_| | (__|   <\__ \
 126  /_/   \_\____/___|  \____\__,_|_|_|_.__/ \__,_|\___|_|\_\___/
 127
 128   These callbacks are used by the backend to set the parameters
 129   for a specific call type.
 130 */
 131
 132 /**
 133  * Set compare function: compares two ABI call object arguments.
 134  */
 135 static int cmp_call_arg(const void *a, const void *b, size_t n)
 136 {
 137         const be_abi_call_arg_t *p = (const be_abi_call_arg_t*)a;
 138         const be_abi_call_arg_t *q = (const be_abi_call_arg_t*)b;
 139         (void) n;
 140         return !(p->is_res == q->is_res && p->pos == q->pos && p->callee == q->callee);
 141 }
 142
 143 /**
 144  * Get  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 callee    context type - if we are callee or caller
 150  */
 151 static be_abi_call_arg_t *get_call_arg(be_abi_call_t *call, int is_res, int pos, int callee)
 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         arg.callee = callee;
 160
 161         hash = is_res * 128 + pos;
 162
 163         return (be_abi_call_arg_t*)set_find(call->params, &arg, sizeof(arg), hash);
 164 }
 165
 166 /**
 167  * Set an ABI call object argument.
 168  */
 169 static void remember_call_arg(be_abi_call_arg_t *arg, be_abi_call_t *call, be_abi_context_t context)
 170 {
 171         unsigned hash = arg->is_res * 128 + arg->pos;
 172         if (context & ABI_CONTEXT_CALLEE) {
 173                 arg->callee = 1;
 174                 set_insert(call->params, arg, sizeof(*arg), hash);
 175         }
 176         if (context & ABI_CONTEXT_CALLER) {
 177                 arg->callee = 0;
 178                 set_insert(call->params, arg, sizeof(*arg), hash);
 179         }
 180 }
 181
 182 /* Set the flags for a call. */
 183 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb)
 184 {
 185         call->flags = flags;
 186         call->cb    = cb;
 187 }
 188
 189 /* Sets the number of bytes the stackframe is shrinked by the callee on return */
 190 void be_abi_call_set_pop(be_abi_call_t *call, int pop)
 191 {
 192         assert(pop >= 0);
 193         call->pop = pop;
 194 }
 195
 196 /* Set register class for call address */
 197 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls)
 198 {
 199         call->cls_addr = cls;
 200 }
 201
 202
 203 void be_abi_call_param_stack(be_abi_call_t *call, int arg_pos,
 204                              ir_mode *load_mode, unsigned alignment,
 205                              unsigned space_before, unsigned space_after,
 206                              be_abi_context_t context)
 207 {
 208         be_abi_call_arg_t arg;
 209         memset(&arg, 0, sizeof(arg));
 210         assert(alignment > 0 && "Alignment must be greater than 0");
 211         arg.on_stack     = 1;
 212         arg.load_mode    = load_mode;
 213         arg.alignment    = alignment;
 214         arg.space_before = space_before;
 215         arg.space_after  = space_after;
 216         arg.is_res       = 0;
 217         arg.pos          = arg_pos;
 218
 219         remember_call_arg(&arg, call, context);
 220 }
 221
 222 void be_abi_call_param_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg, be_abi_context_t context)
 223 {
 224         be_abi_call_arg_t arg;
 225         memset(&arg, 0, sizeof(arg));
 226
 227         arg.in_reg = 1;
 228         arg.reg    = reg;
 229         arg.is_res = 0;
 230         arg.pos    = arg_pos;
 231
 232         remember_call_arg(&arg, call, context);
 233 }
 234
 235 void be_abi_call_res_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg, be_abi_context_t context)
 236 {
 237         be_abi_call_arg_t arg;
 238         memset(&arg, 0, sizeof(arg));
 239
 240         arg.in_reg = 1;
 241         arg.reg    = reg;
 242         arg.is_res = 1;
 243         arg.pos    = arg_pos;
 244
 245         remember_call_arg(&arg, call, context);
 246 }
 247
 248 /* Get the flags of a ABI call object. */
 249 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call)
 250 {
 251         return call->flags;
 252 }
 253
 254 /**
 255  * Constructor for a new ABI call object.
 256  *
 257  * @param cls_addr  register class of the call address
 258  *
 259  * @return the new ABI call object
 260  */
 261 static be_abi_call_t *be_abi_call_new(const arch_register_class_t *cls_addr)
 262 {
 263         be_abi_call_t *call = XMALLOCZ(be_abi_call_t);
 264
 265         call->flags.val  = 0;
 266         call->params     = new_set(cmp_call_arg, 16);
 267         call->cb         = NULL;
 268         call->cls_addr   = cls_addr;
 269
 270         call->flags.bits.try_omit_fp = be_omit_fp;
 271
 272         return call;
 273 }
 274
 275 /**
 276  * Destructor for an ABI call object.
 277  */
 278 static void be_abi_call_free(be_abi_call_t *call)
 279 {
 280         del_set(call->params);
 281         free(call);
 282 }
 283
 284 /**
 285  * Initializes the frame layout from parts
 286  *
 287  * @param frame     the stack layout that will be initialized
 288  * @param args      the stack argument layout type
 289  * @param between   the between layout type
 290  * @param locals    the method frame type
 291  * @param param_map an array mapping method argument positions to the stack argument type
 292  *
 293  * @return the initialized stack layout
 294  */
 295 static be_stack_layout_t *stack_frame_init(be_stack_layout_t *frame, ir_type *args,
 296                                            ir_type *between, ir_type *locals,
 297                                            ir_entity *param_map[])
 298 {
 299         frame->arg_type       = args;
 300         frame->between_type   = between;
 301         frame->frame_type     = locals;
 302         frame->initial_offset = 0;
 303         frame->initial_bias   = 0;
 304         frame->order[1]       = between;
 305         frame->param_map      = param_map;
 306
 307         /* typical decreasing stack: locals have the
 308          * lowest addresses, arguments the highest */
 309         frame->order[0] = locals;
 310         frame->order[2] = args;
 311         return frame;
 312 }
 313
 314 /*
 315    ____      _ _
 316   / ___|__ _| | |___
 317  | |   / _` | | / __|
 318  | |__| (_| | | \__ \
 319   \____\__,_|_|_|___/
 320
 321   Adjustment of the calls inside a graph.
 322
 323 */
 324
 325 /**
 326  * Transform a call node into a be_Call node.
 327  *
 328  * @param env The ABI environment for the current irg.
 329  * @param irn The call node.
 330  * @param curr_sp The stack pointer node to use.
 331  * @return The stack pointer after the call.
 332  */
 333 static ir_node *adjust_call(be_abi_irg_t *env, ir_node *irn, ir_node *curr_sp)
 334 {
 335         ir_graph *irg              = get_irn_irg(irn);
 336         const arch_env_t *arch_env = be_get_irg_arch_env(irg);
 337         ir_type *call_tp           = get_Call_type(irn);
 338         ir_node *call_ptr          = get_Call_ptr(irn);
 339         size_t   n_params          = get_method_n_params(call_tp);
 340         ir_node *curr_mem          = get_Call_mem(irn);
 341         ir_node *bl                = get_nodes_block(irn);
 342         int stack_size             = 0;
 343         const arch_register_t *sp  = arch_env->sp;
 344         be_abi_call_t *call        = be_abi_call_new(sp->reg_class);
 345         ir_mode *mach_mode         = sp->reg_class->mode;
 346         int no_alloc               = call->flags.bits.frame_is_setup_on_call;
 347         int n_res                  = get_method_n_ress(call_tp);
 348         int do_seq                 = call->flags.bits.store_args_sequential && !no_alloc;
 349
 350         ir_node *res_proj  = NULL;
 351         int n_reg_params   = 0;
 352         int n_stack_params = 0;
 353         int n_ins;
 354
 355         const arch_register_t **states = NEW_ARR_F(const arch_register_t*, 0);
 356         const arch_register_t **destroyed_regs = NEW_ARR_F(const arch_register_t*, 0);
 357         ir_node                *low_call;
 358         ir_node               **in;
 359         ir_node               **res_projs;
 360         int                     n_reg_results = 0;
 361         const ir_edge_t        *edge;
 362         int                    *reg_param_idxs;
 363         int                    *stack_param_idx;
 364         int                     i, n, destroy_all_regs;
 365         size_t                  s;
 366         size_t                  p;
 367         dbg_info               *dbgi;
 368
 369         /* Let the isa fill out the abi description for that call node. */
 370         arch_env_get_call_abi(arch_env, call_tp, call);
 371
 372         /* Insert code to put the stack arguments on the stack. */
 373         assert(get_Call_n_params(irn) == n_params);
 374         stack_param_idx = ALLOCAN(int, n_params);
 375         for (p = 0; p < n_params; ++p) {
 376                 be_abi_call_arg_t *arg = get_call_arg(call, 0, p, 0);
 377                 assert(arg);
 378                 if (arg->on_stack) {
 379                         int arg_size = get_type_size_bytes(get_method_param_type(call_tp, p));
 380
 381                         stack_size += round_up2(arg->space_before, arg->alignment);
 382                         stack_size += round_up2(arg_size, arg->alignment);
 383                         stack_size += round_up2(arg->space_after, arg->alignment);
 384
 385                         stack_param_idx[n_stack_params++] = p;
 386                 }
 387         }
 388
 389         /* Collect all arguments which are passed in registers. */
 390         reg_param_idxs = ALLOCAN(int, n_params);
 391         for (p = 0; p < n_params; ++p) {
 392                 be_abi_call_arg_t *arg = get_call_arg(call, 0, p, 0);
 393                 if (arg && arg->in_reg) {
 394                         reg_param_idxs[n_reg_params++] = p;
 395                 }
 396         }
 397
 398         /*
 399          * If the stack is decreasing and we do not want to store sequentially,
 400          * or someone else allocated the call frame
 401          * we allocate as much space on the stack all parameters need, by
 402          * moving the stack pointer along the stack's direction.
 403          *
 404          * Note: we also have to do this for stack_size == 0, because we may have
 405          * to adjust stack alignment for the call.
 406          */
 407         if (!do_seq && !no_alloc) {
 408                 curr_sp = be_new_IncSP(sp, bl, curr_sp, stack_size, 1);
 409         }
 410
 411         dbgi = get_irn_dbg_info(irn);
 412         /* If there are some parameters which shall be passed on the stack. */
 413         if (n_stack_params > 0) {
 414                 int       curr_ofs = 0;
 415                 ir_node **in       = ALLOCAN(ir_node*, n_stack_params+1);
 416                 unsigned  n_in     = 0;
 417
 418                 /*
 419                  * Reverse list of stack parameters if call arguments are from left to right.
 420                  * We must them reverse again if they are pushed (not stored) and the stack
 421                  * direction is downwards.
 422                  */
 423                 if (call->flags.bits.left_to_right ^ do_seq) {
 424                         for (i = 0; i < n_stack_params >> 1; ++i) {
 425                                 int other  = n_stack_params - i - 1;
 426                                 int tmp    = stack_param_idx[i];
 427                                 stack_param_idx[i]     = stack_param_idx[other];
 428                                 stack_param_idx[other] = tmp;
 429                         }
 430                 }
 431
 432                 curr_mem = get_Call_mem(irn);
 433                 if (! do_seq) {
 434                         in[n_in++] = curr_mem;
 435                 }
 436
 437                 for (i = 0; i < n_stack_params; ++i) {
 438                         int p                  = stack_param_idx[i];
 439                         be_abi_call_arg_t *arg = get_call_arg(call, 0, p, 0);
 440                         ir_node *param         = get_Call_param(irn, p);
 441                         ir_node *addr          = curr_sp;
 442                         ir_node *mem           = NULL;
 443                         ir_type *param_type    = get_method_param_type(call_tp, p);
 444                         int param_size         = get_type_size_bytes(param_type) + arg->space_after;
 445
 446                         /*
 447                          * If we wanted to build the arguments sequentially,
 448                          * the stack pointer for the next must be incremented,
 449                          * and the memory value propagated.
 450                          */
 451                         if (do_seq) {
 452                                 curr_ofs = 0;
 453                                 addr = curr_sp = be_new_IncSP(sp, bl, curr_sp,
 454                                                               param_size + arg->space_before, 0);
 455                                 add_irn_dep(curr_sp, curr_mem);
 456                         } else {
 457                                 curr_ofs += arg->space_before;
 458                                 curr_ofs =  round_up2(curr_ofs, arg->alignment);
 459
 460                                 /* Make the expression to compute the argument's offset. */
 461                                 if (curr_ofs > 0) {
 462                                         ir_mode *constmode = mach_mode;
 463                                         if (mode_is_reference(mach_mode)) {
 464                                                 constmode = mode_Is;
 465                                         }
 466                                         addr = new_r_Const_long(irg, constmode, curr_ofs);
 467                                         addr = new_r_Add(bl, curr_sp, addr, mach_mode);
 468                                 }
 469                         }
 470
 471                         /* Insert a store for primitive arguments. */
 472                         if (is_atomic_type(param_type)) {
 473                                 ir_node *mem_input = do_seq ? curr_mem : new_r_NoMem(irg);
 474                                 ir_node *store     = new_rd_Store(dbgi, bl, mem_input, addr, param, cons_none);
 475                                 mem   = new_r_Proj(store, mode_M, pn_Store_M);
 476                         } else {
 477                                 /* Make a mem copy for compound arguments. */
 478                                 ir_node *copy;
 479
 480                                 assert(mode_is_reference(get_irn_mode(param)));
 481                                 copy = new_rd_CopyB(dbgi, bl, curr_mem, addr, param, param_type);
 482                                 mem = new_r_Proj(copy, mode_M, pn_CopyB_M);
 483                         }
 484
 485                         curr_ofs += param_size;
 486
 487                         if (do_seq)
 488                                 curr_mem = mem;
 489                         else
 490                                 in[n_in++] = mem;
 491                 }
 492
 493                 /* We need the sync only, if we didn't build the stores sequentially. */
 494                 if (! do_seq) {
 495                         if (n_stack_params >= 1) {
 496                                 curr_mem = new_r_Sync(bl, n_in, in);
 497                         } else {
 498                                 curr_mem = get_Call_mem(irn);
 499                         }
 500                 }
 501         }
 502
 503         /* check for the return_twice property */
 504         destroy_all_regs = 0;
 505         if (is_SymConst_addr_ent(call_ptr)) {
 506                 ir_entity *ent = get_SymConst_entity(call_ptr);
 507
 508                 if (get_entity_additional_properties(ent) & mtp_property_returns_twice)
 509                         destroy_all_regs = 1;
 510         } else {
 511                 ir_type *call_tp = get_Call_type(irn);
 512
 513                 if (get_method_additional_properties(call_tp) & mtp_property_returns_twice)
 514                         destroy_all_regs = 1;
 515         }
 516
 517         /* Put caller save into the destroyed set and state registers in the states
 518          * set */
 519         for (i = 0, n = arch_env->n_register_classes; i < n; ++i) {
 520                 unsigned j;
 521                 const arch_register_class_t *cls = &arch_env->register_classes[i];
 522                 for (j = 0; j < cls->n_regs; ++j) {
 523                         const arch_register_t *reg = arch_register_for_index(cls, j);
 524
 525                         /* even if destroyed all is specified, neither SP nor FP are
 526                          * destroyed (else bad things will happen) */
 527                         if (reg == arch_env->sp || reg == arch_env->bp)
 528                                 continue;
 529
 530                         if (reg->type & arch_register_type_state) {
 531                                 ARR_APP1(const arch_register_t*, destroyed_regs, reg);
 532                                 ARR_APP1(const arch_register_t*, states, reg);
 533                                 /* we're already in the destroyed set so no need for further
 534                                  * checking */
 535                                 continue;
 536                         }
 537                         if (destroy_all_regs || (reg->type & arch_register_type_caller_save)) {
 538                                 if (!(reg->type & arch_register_type_ignore)) {
 539                                         ARR_APP1(const arch_register_t*, destroyed_regs, reg);
 540                                 }
 541                         }
 542                 }
 543         }
 544
 545         /* search the largest result proj number */
 546         res_projs = ALLOCANZ(ir_node*, n_res);
 547
 548         foreach_out_edge(irn, edge) {
 549                 const ir_edge_t *res_edge;
 550                 ir_node         *irn = get_edge_src_irn(edge);
 551
 552                 if (!is_Proj(irn) || get_Proj_proj(irn) != pn_Call_T_result)
 553                         continue;
 554
 555                 foreach_out_edge(irn, res_edge) {
 556                         int proj;
 557                         ir_node *res = get_edge_src_irn(res_edge);
 558
 559                         assert(is_Proj(res));
 560
 561                         proj = get_Proj_proj(res);
 562                         assert(proj < n_res);
 563                         assert(res_projs[proj] == NULL);
 564                         res_projs[proj] = res;
 565                 }
 566                 res_proj = irn;
 567                 break;
 568         }
 569
 570         /** TODO: this is not correct for cases where return values are passed
 571          * on the stack, but no known ABI does this currently...
 572          */
 573         n_reg_results = n_res;
 574
 575         n_ins = 0;
 576         in    = ALLOCAN(ir_node*, n_reg_params + ARR_LEN(states));
 577
 578         /* make the back end call node and set its register requirements. */
 579         for (i = 0; i < n_reg_params; ++i) {
 580                 in[n_ins++] = get_Call_param(irn, reg_param_idxs[i]);
 581         }
 582
 583         /* add state registers ins */
 584         for (s = 0; s < ARR_LEN(states); ++s) {
 585                 const arch_register_t       *reg = states[s];
 586                 const arch_register_class_t *cls = arch_register_get_class(reg);
 587                 ir_node *regnode = new_r_Unknown(irg, arch_register_class_mode(cls));
 588                 in[n_ins++]      = regnode;
 589         }
 590         assert(n_ins == (int) (n_reg_params + ARR_LEN(states)));
 591
 592         /* ins collected, build the call */
 593         if (env->call->flags.bits.call_has_imm && is_SymConst(call_ptr)) {
 594                 /* direct call */
 595                 low_call = be_new_Call(dbgi, irg, bl, curr_mem, curr_sp, curr_sp,
 596                                        n_reg_results + pn_be_Call_first_res + ARR_LEN(destroyed_regs),
 597                                        n_ins, in, get_Call_type(irn));
 598                 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
 599         } else {
 600                 /* indirect call */
 601                 low_call = be_new_Call(dbgi, irg, bl, curr_mem, curr_sp, call_ptr,
 602                                        n_reg_results + pn_be_Call_first_res + ARR_LEN(destroyed_regs),
 603                                        n_ins, in, get_Call_type(irn));
 604         }
 605         be_Call_set_pop(low_call, call->pop);
 606
 607         /* put the call into the list of all calls for later processing */
 608         ARR_APP1(ir_node *, env->calls, low_call);
 609
 610         /* create new stack pointer */
 611         curr_sp = new_r_Proj(low_call, get_irn_mode(curr_sp), pn_be_Call_sp);
 612         be_set_constr_single_reg_out(low_call, pn_be_Call_sp, sp,
 613                         arch_register_req_type_ignore | arch_register_req_type_produces_sp);
 614         arch_set_irn_register(curr_sp, sp);
 615
 616         /* now handle results */
 617         for (i = 0; i < n_res; ++i) {
 618                 int pn;
 619                 ir_node           *proj = res_projs[i];
 620                 be_abi_call_arg_t *arg  = get_call_arg(call, 1, i, 0);
 621
 622                 /* returns values on stack not supported yet */
 623                 assert(arg->in_reg);
 624
 625                 /*
 626                         shift the proj number to the right, since we will drop the
 627                         unspeakable Proj_T from the Call. Therefore, all real argument
 628                         Proj numbers must be increased by pn_be_Call_first_res
 629                 */
 630                 pn = i + pn_be_Call_first_res;
 631
 632                 if (proj == NULL) {
 633                         ir_type *res_type = get_method_res_type(call_tp, i);
 634                         ir_mode *mode     = get_type_mode(res_type);
 635                         proj              = new_r_Proj(low_call, mode, pn);
 636                         res_projs[i]      = proj;
 637                 } else {
 638                         set_Proj_pred(proj, low_call);
 639                         set_Proj_proj(proj, pn);
 640                 }
 641
 642                 if (arg->in_reg) {
 643                         /* remove register from destroyed regs */
 644                         size_t j;
 645                         size_t n = ARR_LEN(destroyed_regs);
 646                         for (j = 0; j < n; ++j) {
 647                                 if (destroyed_regs[j] == arg->reg) {
 648                                         destroyed_regs[j] = destroyed_regs[n-1];
 649                                         ARR_SHRINKLEN(destroyed_regs,n-1);
 650                                         break;
 651                                 }
 652                         }
 653                 }
 654         }
 655
 656         /*
 657                 Set the register class of the call address to
 658                 the backend provided class (default: stack pointer class)
 659         */
 660         be_node_set_reg_class_in(low_call, n_be_Call_ptr, call->cls_addr);
 661
 662         DBG((dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
 663
 664         /* Set the register classes and constraints of the Call parameters. */
 665         for (i = 0; i < n_reg_params; ++i) {
 666                 int index = reg_param_idxs[i];
 667                 be_abi_call_arg_t *arg = get_call_arg(call, 0, index, 0);
 668                 assert(arg->reg != NULL);
 669
 670                 be_set_constr_single_reg_in(low_call, n_be_Call_first_arg + i,
 671                                             arg->reg, arch_register_req_type_none);
 672         }
 673
 674         /* Set the register constraints of the results. */
 675         for (i = 0; i < n_res; ++i) {
 676                 ir_node                 *proj = res_projs[i];
 677                 const be_abi_call_arg_t *arg  = get_call_arg(call, 1, i, 0);
 678                 int                      pn   = get_Proj_proj(proj);
 679
 680                 assert(arg->in_reg);
 681                 be_set_constr_single_reg_out(low_call, pn, arg->reg,
 682                                              arch_register_req_type_none);
 683                 arch_set_irn_register(proj, arg->reg);
 684         }
 685         exchange(irn, low_call);
 686
 687         /* kill the ProjT node */
 688         if (res_proj != NULL) {
 689                 kill_node(res_proj);
 690         }
 691
 692         /* Make additional projs for the caller save registers
 693            and the Keep node which keeps them alive. */
 694         {
 695                 ir_node               **in, *keep;
 696                 int                   i;
 697                 size_t                d;
 698                 int                   n = 0;
 699                 int                   curr_res_proj = pn_be_Call_first_res + n_reg_results;
 700                 int                   n_ins;
 701
 702                 n_ins = ARR_LEN(destroyed_regs) + n_reg_results + 1;
 703                 in    = ALLOCAN(ir_node *, n_ins);
 704
 705                 /* also keep the stack pointer */
 706                 set_irn_link(curr_sp, (void*) sp);
 707                 in[n++] = curr_sp;
 708
 709                 for (d = 0; d < ARR_LEN(destroyed_regs); ++d) {
 710                         const arch_register_t *reg = destroyed_regs[d];
 711                         ir_node *proj = new_r_Proj(low_call, reg->reg_class->mode, curr_res_proj);
 712
 713                         /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
 714                         be_set_constr_single_reg_out(low_call, curr_res_proj, reg,
 715                                                      arch_register_req_type_none);
 716                         arch_set_irn_register(proj, reg);
 717
 718                         set_irn_link(proj, (void*) reg);
 719                         in[n++] = proj;
 720                         ++curr_res_proj;
 721                 }
 722
 723                 for (i = 0; i < n_reg_results; ++i) {
 724                         ir_node *proj = res_projs[i];
 725                         const arch_register_t *reg = arch_get_irn_register(proj);
 726                         set_irn_link(proj, (void*) reg);
 727                         in[n++] = proj;
 728                 }
 729                 assert(n <= n_ins);
 730
 731                 /* create the Keep for the caller save registers */
 732                 keep = be_new_Keep(bl, n, in);
 733                 for (i = 0; i < n; ++i) {
 734                         const arch_register_t *reg = (const arch_register_t*)get_irn_link(in[i]);
 735                         be_node_set_reg_class_in(keep, i, reg->reg_class);
 736                 }
 737         }
 738
 739         /* Clean up the stack. */
 740         assert(stack_size >= call->pop);
 741         stack_size -= call->pop;
 742
 743         if (stack_size > 0) {
 744                 ir_node *mem_proj = NULL;
 745
 746                 foreach_out_edge(low_call, edge) {
 747                         ir_node *irn = get_edge_src_irn(edge);
 748                         if (is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
 749                                 mem_proj = irn;
 750                                 break;
 751                         }
 752                 }
 753
 754                 if (! mem_proj) {
 755                         mem_proj = new_r_Proj(low_call, mode_M, pn_be_Call_M_regular);
 756                         keep_alive(mem_proj);
 757                 }
 758         }
 759         /* Clean up the stack frame or revert alignment fixes if we allocated it */
 760         if (! no_alloc) {
 761                 curr_sp = be_new_IncSP(sp, bl, curr_sp, -stack_size, 0);
 762         }
 763
 764         be_abi_call_free(call);
 765
 766         DEL_ARR_F(states);
 767         DEL_ARR_F(destroyed_regs);
 768
 769         return curr_sp;
 770 }
 771
 772 /**
 773  * Adjust the size of a node representing a stack alloc or free for the minimum stack alignment.
 774  *
 775  * @param alignment  the minimum stack alignment
 776  * @param size       the node containing the non-aligned size
 777  * @param block      the block where new nodes are allocated on
 778  * @param dbg        debug info for new nodes
 779  *
 780  * @return a node representing the aligned size
 781  */
 782 static ir_node *adjust_alloc_size(unsigned stack_alignment, ir_node *size,
 783                                   ir_node *block, dbg_info *dbg)
 784 {
 785         if (stack_alignment > 1) {
 786                 ir_mode   *mode;
 787                 ir_tarval *tv;
 788                 ir_node   *mask;
 789                 ir_graph  *irg;
 790
 791                 assert(is_po2(stack_alignment));
 792
 793                 mode = get_irn_mode(size);
 794                 tv   = new_tarval_from_long(stack_alignment-1, mode);
 795                 irg  = get_Block_irg(block);
 796                 mask = new_r_Const(irg, tv);
 797                 size = new_rd_Add(dbg, block, size, mask, mode);
 798
 799                 tv   = new_tarval_from_long(-(long)stack_alignment, mode);
 800                 mask = new_r_Const(irg, tv);
 801                 size = new_rd_And(dbg, block, size, mask, mode);
 802         }
 803         return size;
 804 }
 805 /**
 806  * Adjust an alloca.
 807  * The alloca is transformed into a back end alloca node and connected to the stack nodes.
 808  */
 809 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp)
 810 {
 811         ir_node          *block     = get_nodes_block(alloc);
 812         ir_graph         *irg       = get_Block_irg(block);
 813         const arch_env_t *arch_env  = be_get_irg_arch_env(irg);
 814         ir_node          *alloc_mem = NULL;
 815         ir_node          *alloc_res = NULL;
 816         ir_type          *type      = get_Alloc_type(alloc);
 817         dbg_info         *dbg;
 818
 819         const ir_edge_t *edge;
 820         ir_node *new_alloc;
 821         ir_node *count;
 822         ir_node *size;
 823         ir_node *ins[2];
 824         unsigned stack_alignment;
 825
 826         /* all non-stack Alloc nodes should already be lowered before the backend */
 827         assert(get_Alloc_where(alloc) == stack_alloc);
 828
 829         foreach_out_edge(alloc, edge) {
 830                 ir_node *irn = get_edge_src_irn(edge);
 831
 832                 assert(is_Proj(irn));
 833                 switch (get_Proj_proj(irn)) {
 834                 case pn_Alloc_M:
 835                         alloc_mem = irn;
 836                         break;
 837                 case pn_Alloc_res:
 838                         alloc_res = irn;
 839                         break;
 840                 default:
 841                         break;
 842                 }
 843         }
 844
 845         /* Beware: currently Alloc nodes without a result might happen,
 846            only escape analysis kills them and this phase runs only for object
 847            oriented source. We kill the Alloc here. */
 848         if (alloc_res == NULL && alloc_mem) {
 849                 exchange(alloc_mem, get_Alloc_mem(alloc));
 850                 return curr_sp;
 851         }
 852
 853         dbg   = get_irn_dbg_info(alloc);
 854         count = get_Alloc_count(alloc);
 855
 856         /* we might need to multiply the count with the element size */
 857         if (type != firm_unknown_type && get_type_size_bytes(type) != 1) {
 858                 ir_mode   *mode  = get_irn_mode(count);
 859                 ir_tarval *tv    = new_tarval_from_long(get_type_size_bytes(type),
 860                                                         mode);
 861                 ir_node   *cnst = new_rd_Const(dbg, irg, tv);
 862                 size            = new_rd_Mul(dbg, block, count, cnst, mode);
 863         } else {
 864                 size = count;
 865         }
 866
 867         /* The stack pointer will be modified in an unknown manner.
 868            We cannot omit it. */
 869         env->call->flags.bits.try_omit_fp = 0;
 870
 871         stack_alignment = 1 << arch_env->stack_alignment;
 872         size            = adjust_alloc_size(stack_alignment, size, block, dbg);
 873         new_alloc       = be_new_AddSP(arch_env->sp, block, curr_sp, size);
 874         set_irn_dbg_info(new_alloc, dbg);
 875
 876         if (alloc_mem != NULL) {
 877                 ir_node *addsp_mem;
 878                 ir_node *sync;
 879
 880                 addsp_mem = new_r_Proj(new_alloc, mode_M, pn_be_AddSP_M);
 881
 882                 /* We need to sync the output mem of the AddSP with the input mem
 883                    edge into the alloc node. */
 884                 ins[0] = get_Alloc_mem(alloc);
 885                 ins[1] = addsp_mem;
 886                 sync = new_r_Sync(block, 2, ins);
 887
 888                 exchange(alloc_mem, sync);
 889         }
 890
 891         exchange(alloc, new_alloc);
 892
 893         /* fix projnum of alloca res */
 894         set_Proj_proj(alloc_res, pn_be_AddSP_res);
 895
 896         curr_sp = new_r_Proj(new_alloc,  get_irn_mode(curr_sp), pn_be_AddSP_sp);
 897
 898         return curr_sp;
 899 }
 900
 901 /**
 902  * Adjust a Free.
 903  * The Free is transformed into a back end free node and connected to the stack nodes.
 904  */
 905 static ir_node *adjust_free(be_abi_irg_t *env, ir_node *free, ir_node *curr_sp)
 906 {
 907         ir_node          *block    = get_nodes_block(free);
 908         ir_graph         *irg      = get_irn_irg(free);
 909         ir_type          *type     = get_Free_type(free);
 910         const arch_env_t *arch_env = be_get_irg_arch_env(irg);
 911         ir_mode          *sp_mode  = arch_env->sp->reg_class->mode;
 912         dbg_info         *dbg      = get_irn_dbg_info(free);
 913         ir_node  *subsp, *mem, *res, *size, *sync;
 914         ir_node *in[2];
 915         unsigned stack_alignment;
 916
 917         /* all non-stack-alloc Free nodes should already be lowered before the
 918          * backend phase */
 919         assert(get_Free_where(free) == stack_alloc);
 920
 921         /* we might need to multiply the size with the element size */
 922         if (type != firm_unknown_type && get_type_size_bytes(type) != 1) {
 923                 ir_tarval *tv   = new_tarval_from_long(get_type_size_bytes(type), mode_Iu);
 924                 ir_node   *cnst = new_rd_Const(dbg, irg, tv);
 925                 ir_node   *mul  = new_rd_Mul(dbg, block, get_Free_size(free),
 926                                              cnst, mode_Iu);
 927                 size = mul;
 928         } else {
 929                 size = get_Free_size(free);
 930         }
 931
 932         stack_alignment = 1 << arch_env->stack_alignment;
 933         size            = adjust_alloc_size(stack_alignment, size, block, dbg);
 934
 935         /* The stack pointer will be modified in an unknown manner.
 936            We cannot omit it. */
 937         env->call->flags.bits.try_omit_fp = 0;
 938         subsp = be_new_SubSP(arch_env->sp, block, curr_sp, size);
 939         set_irn_dbg_info(subsp, dbg);
 940
 941         mem = new_r_Proj(subsp, mode_M, pn_be_SubSP_M);
 942         res = new_r_Proj(subsp, sp_mode, pn_be_SubSP_sp);
 943
 944         /* we need to sync the memory */
 945         in[0] = get_Free_mem(free);
 946         in[1] = mem;
 947         sync = new_r_Sync(block, 2, in);
 948
 949         /* and make the AddSP dependent on the former memory */
 950         add_irn_dep(subsp, get_Free_mem(free));
 951
 952         /* kill the free */
 953         exchange(free, sync);
 954         curr_sp = res;
 955
 956         return curr_sp;
 957 }
 958
 959 /**
 960  * Check if a node is somehow data dependent on another one.
 961  * both nodes must be in the same basic block.
 962  * @param n1 The first node.
 963  * @param n2 The second node.
 964  * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
 965  */
 966 static int dependent_on(ir_node *n1, ir_node *n2)
 967 {
 968         assert(get_nodes_block(n1) == get_nodes_block(n2));
 969
 970         return heights_reachable_in_block(ir_heights, n1, n2);
 971 }
 972
 973 static int cmp_call_dependency(const void *c1, const void *c2)
 974 {
 975         ir_node *n1 = *(ir_node **) c1;
 976         ir_node *n2 = *(ir_node **) c2;
 977         unsigned h1, h2;
 978
 979         /*
 980                 Classical qsort() comparison function behavior:
 981                 0  if both elements are equal
 982                 1  if second is "smaller" that first
 983                 -1 if first is "smaller" that second
 984         */
 985         if (dependent_on(n1, n2))
 986                 return -1;
 987
 988         if (dependent_on(n2, n1))
 989                 return 1;
 990
 991         /* The nodes have no depth order, but we need a total order because qsort()
 992          * is not stable.
 993          *
 994          * Additionally, we need to respect transitive dependencies. Consider a
 995          * Call a depending on Call b and an independent Call c.
 996          * We MUST NOT order c > a and b > c. */
 997         h1 = get_irn_height(ir_heights, n1);
 998         h2 = get_irn_height(ir_heights, n2);
 999         if (h1 < h2) return -1;
1000         if (h1 > h2) return  1;
1001         /* Same height, so use a random (but stable) order */
1002         return get_irn_idx(n1) - get_irn_idx(n2);
1003 }
1004
1005 /**
1006  * Walker: links all Call/Alloc/Free nodes to the Block they are contained.
1007  * Clears the irg_is_leaf flag if a Call is detected.
1008  */
1009 static void link_ops_in_block_walker(ir_node *irn, void *data)
1010 {
1011         be_abi_irg_t *env  = (be_abi_irg_t*)data;
1012         unsigned      code = get_irn_opcode(irn);
1013
1014         if (code == iro_Call ||
1015            (code == iro_Alloc && get_Alloc_where(irn) == stack_alloc) ||
1016            (code == iro_Free && get_Free_where(irn) == stack_alloc)) {
1017                 ir_node *bl       = get_nodes_block(irn);
1018                 void *save        = get_irn_link(bl);
1019
1020                 if (code == iro_Call)
1021                         env->call->flags.bits.irg_is_leaf = 0;
1022
1023                 set_irn_link(irn, save);
1024                 set_irn_link(bl, irn);
1025         }
1026
1027         if (code == iro_Builtin && get_Builtin_kind(irn) == ir_bk_return_address) {
1028                 ir_node       *param = get_Builtin_param(irn, 0);
1029                 ir_tarval     *tv    = get_Const_tarval(param);
1030                 unsigned long  value = get_tarval_long(tv);
1031                 /* use ebp, so the climbframe algo works... */
1032                 if (value > 0) {
1033                         env->call->flags.bits.try_omit_fp = 0;
1034                 }
1035         }
1036 }
1037
1038 /**
1039  * Block-walker:
1040  * Process all Call/Alloc/Free nodes inside a basic block.
1041  * Note that the link field of the block must contain a linked list of all
1042  * nodes inside the Block. We first order this list according to data dependency
1043  * and that connect the nodes together.
1044  */
1045 static void process_ops_in_block(ir_node *bl, void *data)
1046 {
1047         be_abi_irg_t   *env     = (be_abi_irg_t*)data;
1048         ir_node        *curr_sp = env->init_sp;
1049         ir_node        *irn;
1050         ir_node       **nodes;
1051         int             n;
1052         int             n_nodes;
1053
1054         n_nodes = 0;
1055         for (irn = (ir_node*)get_irn_link(bl); irn != NULL;
1056              irn = (ir_node*)get_irn_link(irn)) {
1057                 ++n_nodes;
1058         }
1059
1060         nodes = ALLOCAN(ir_node*, n_nodes);
1061         for (irn = (ir_node*)get_irn_link(bl), n = 0; irn != NULL;
1062              irn = (ir_node*)get_irn_link(irn), ++n) {
1063                 nodes[n] = irn;
1064         }
1065
1066         /* If there were call nodes in the block. */
1067         if (n > 0) {
1068                 ir_node *keep;
1069                 int i;
1070
1071                 /* order the call nodes according to data dependency */
1072                 qsort(nodes, n_nodes, sizeof(nodes[0]), cmp_call_dependency);
1073
1074                 for (i = n_nodes - 1; i >= 0; --i) {
1075                         ir_node *irn = nodes[i];
1076
1077                         DBG((dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
1078                         switch (get_irn_opcode(irn)) {
1079                         case iro_Call:
1080                                 if (! be_omit_fp) {
1081                                         /* The stack pointer will be modified due to a call. */
1082                                         env->call->flags.bits.try_omit_fp = 0;
1083                                 }
1084                                 curr_sp = adjust_call(env, irn, curr_sp);
1085                                 break;
1086                         case iro_Alloc:
1087                                 if (get_Alloc_where(irn) == stack_alloc)
1088                                         curr_sp = adjust_alloc(env, irn, curr_sp);
1089                                 break;
1090                         case iro_Free:
1091                                 if (get_Free_where(irn) == stack_alloc)
1092                                         curr_sp = adjust_free(env, irn, curr_sp);
1093                                 break;
1094                         default:
1095                                 panic("invalid call");
1096                         }
1097                 }
1098
1099                 /* Keep the last stack state in the block by tying it to Keep node,
1100                  * the proj from calls is already kept */
1101                 if (curr_sp != env->init_sp &&
1102                     !(is_Proj(curr_sp) && be_is_Call(get_Proj_pred(curr_sp)))) {
1103                         nodes[0] = curr_sp;
1104                         keep     = be_new_Keep(bl, 1, nodes);
1105                         pmap_insert(env->keep_map, bl, keep);
1106                 }
1107         }
1108
1109         set_irn_link(bl, curr_sp);
1110 }
1111
1112 /**
1113  * Adjust all call nodes in the graph to the ABI conventions.
1114  */
1115 static void process_calls(ir_graph *irg)
1116 {
1117         be_abi_irg_t *abi = be_get_irg_abi(irg);
1118
1119         abi->call->flags.bits.irg_is_leaf = 1;
1120         irg_walk_graph(irg, firm_clear_link, link_ops_in_block_walker, abi);
1121
1122         ir_heights = heights_new(irg);
1123         irg_block_walk_graph(irg, NULL, process_ops_in_block, abi);
1124         heights_free(ir_heights);
1125 }
1126
1127 /**
1128  * Computes the stack argument layout type.
1129  * Changes a possibly allocated value param type by moving
1130  * entities to the stack layout type.
1131  *
1132  * @param env           the ABI environment
1133  * @param call          the current call ABI
1134  * @param method_type   the method type
1135  * @param val_param_tp  the value parameter type, will be destroyed
1136  * @param param_map     an array mapping method arguments to the stack layout type
1137  *
1138  * @return the stack argument layout type
1139  */
1140 static ir_type *compute_arg_type(be_abi_irg_t *env, ir_graph *irg,
1141                                  be_abi_call_t *call,
1142                                                                  ir_type *method_type, ir_type *val_param_tp,
1143                                                                  ir_entity ***param_map)
1144 {
1145         int dir  = env->call->flags.bits.left_to_right ? 1 : -1;
1146         int inc  = -dir;
1147         int n    = get_method_n_params(method_type);
1148         int curr = inc > 0 ? 0 : n - 1;
1149         struct obstack *obst = be_get_be_obst(irg);
1150         int ofs  = 0;
1151
1152         char buf[128];
1153         ir_type *res;
1154         int i;
1155         ident *id = get_entity_ident(get_irg_entity(irg));
1156         ir_entity **map;
1157
1158         *param_map = map = OALLOCN(obst, ir_entity*, n);
1159         res = new_type_struct(id_mangle_u(id, new_id_from_chars("arg_type", 8)));
1160         for (i = 0; i < n; ++i, curr += inc) {
1161                 ir_type *param_type    = get_method_param_type(method_type, curr);
1162                 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr, 1);
1163
1164                 map[i] = NULL;
1165                 if (arg->on_stack) {
1166                         if (val_param_tp != NULL) {
1167                                 /* the entity was already created, create a copy in the param type */
1168                                 ir_entity *val_ent = get_method_value_param_ent(method_type, i);
1169                                 arg->stack_ent = copy_entity_own(val_ent, res);
1170                                 set_entity_link(val_ent, arg->stack_ent);
1171                                 set_entity_link(arg->stack_ent, NULL);
1172                         } else {
1173                                 /* create a new entity */
1174                                 snprintf(buf, sizeof(buf), "param_%d", i);
1175                                 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1176                         }
1177                         ofs += arg->space_before;
1178                         ofs = round_up2(ofs, arg->alignment);
1179                         set_entity_offset(arg->stack_ent, ofs);
1180                         ofs += arg->space_after;
1181                         ofs += get_type_size_bytes(param_type);
1182                         map[i] = arg->stack_ent;
1183                 }
1184         }
1185         set_type_size_bytes(res, ofs);
1186         set_type_state(res, layout_fixed);
1187         return res;
1188 }
1189
1190 typedef struct {
1191         const arch_register_t *reg;
1192         ir_node *irn;
1193 } reg_node_map_t;
1194
1195 static int cmp_regs(const void *a, const void *b)
1196 {
1197         const reg_node_map_t *p = (const reg_node_map_t*)a;
1198         const reg_node_map_t *q = (const reg_node_map_t*)b;
1199
1200         if (p->reg->reg_class == q->reg->reg_class)
1201                 return p->reg->index - q->reg->index;
1202         else
1203                 return p->reg->reg_class < q->reg->reg_class ? -1 : +1;
1204 }
1205
1206 static void reg_map_to_arr(reg_node_map_t *res, pmap *reg_map)
1207 {
1208         pmap_entry *ent;
1209         size_t n = pmap_count(reg_map);
1210         size_t i = 0;
1211
1212         foreach_pmap(reg_map, ent) {
1213                 res[i].reg = (const arch_register_t*)ent->key;
1214                 res[i].irn = (ir_node*)ent->value;
1215                 i++;
1216         }
1217
1218         qsort(res, n, sizeof(res[0]), cmp_regs);
1219 }
1220
1221 /**
1222  * Creates a be_Return for a Return node.
1223  *
1224  * @param @env  the abi environment
1225  * @param irn   the Return node or NULL if there was none
1226  * @param bl    the block where the be_Retun should be placed
1227  * @param mem   the current memory
1228  * @param n_res number of return results
1229  */
1230 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl,
1231                 ir_node *mem, int n_res)
1232 {
1233         be_abi_call_t    *call     = env->call;
1234         ir_graph         *irg      = get_Block_irg(bl);
1235         const arch_env_t *arch_env = be_get_irg_arch_env(irg);
1236         dbg_info *dbgi;
1237         pmap *reg_map  = pmap_create();
1238         ir_node *keep  = (ir_node*)pmap_get(env->keep_map, bl);
1239         size_t in_max;
1240         ir_node *ret;
1241         int i, n;
1242         unsigned pop;
1243         ir_node **in;
1244         ir_node *stack;
1245         const arch_register_t **regs;
1246         pmap_entry *ent;
1247
1248         /*
1249                 get the valid stack node in this block.
1250                 If we had a call in that block there is a Keep constructed by process_calls()
1251                 which points to the last stack modification in that block. we'll use
1252                 it then. Else we use the stack from the start block and let
1253                 the ssa construction fix the usage.
1254         */
1255         stack = be_abi_reg_map_get(env->regs, arch_env->sp);
1256         if (keep) {
1257                 stack = get_irn_n(keep, 0);
1258                 kill_node(keep);
1259                 remove_End_keepalive(get_irg_end(irg), keep);
1260         }
1261
1262         /* Insert results for Return into the register map. */
1263         for (i = 0; i < n_res; ++i) {
1264                 ir_node *res           = get_Return_res(irn, i);
1265                 be_abi_call_arg_t *arg = get_call_arg(call, 1, i, 1);
1266                 assert(arg->in_reg && "return value must be passed in register");
1267                 pmap_insert(reg_map, (void *) arg->reg, res);
1268         }
1269
1270         /* Add uses of the callee save registers. */
1271         foreach_pmap(env->regs, ent) {
1272                 const arch_register_t *reg = (const arch_register_t*)ent->key;
1273                 if (reg->type & (arch_register_type_callee_save | arch_register_type_ignore))
1274                         pmap_insert(reg_map, ent->key, ent->value);
1275         }
1276
1277         be_abi_reg_map_set(reg_map, arch_env->sp, stack);
1278
1279         /*
1280                 Maximum size of the in array for Return nodes is
1281                 return args + callee save/ignore registers + memory + stack pointer
1282         */
1283         in_max = pmap_count(reg_map) + n_res + 2;
1284
1285         in   = ALLOCAN(ir_node*,               in_max);
1286         regs = ALLOCAN(arch_register_t const*, in_max);
1287
1288         in[0]   = mem;
1289         in[1]   = be_abi_reg_map_get(reg_map, arch_env->sp);
1290         regs[0] = NULL;
1291         regs[1] = arch_env->sp;
1292         n       = 2;
1293
1294         /* clear SP entry, since it has already been grown. */
1295         pmap_insert(reg_map, (void *) arch_env->sp, NULL);
1296         for (i = 0; i < n_res; ++i) {
1297                 be_abi_call_arg_t *arg = get_call_arg(call, 1, i, 1);
1298
1299                 in[n]     = be_abi_reg_map_get(reg_map, arg->reg);
1300                 regs[n++] = arg->reg;
1301
1302                 /* Clear the map entry to mark the register as processed. */
1303                 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1304         }
1305
1306         /* grow the rest of the stuff. */
1307         foreach_pmap(reg_map, ent) {
1308                 if (ent->value) {
1309                         in[n]     = (ir_node*)ent->value;
1310                         regs[n++] = (const arch_register_t*)ent->key;
1311                 }
1312         }
1313
1314         /* The in array for the new back end return is now ready. */
1315         if (irn != NULL) {
1316                 dbgi = get_irn_dbg_info(irn);
1317         } else {
1318                 dbgi = NULL;
1319         }
1320         /* we have to pop the shadow parameter in in case of struct returns */
1321         pop = call->pop;
1322         ret = be_new_Return(dbgi, irg, bl, n_res, pop, 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] == NULL)
1327                         continue;
1328
1329                 be_set_constr_single_reg_in(ret, i, regs[i], arch_register_req_type_none);
1330         }
1331
1332         /* Free the space of the Epilog's in array and the register <-> proj map. */
1333         pmap_destroy(reg_map);
1334
1335         return ret;
1336 }
1337
1338 typedef struct ent_pos_pair ent_pos_pair;
1339 struct ent_pos_pair {
1340         ir_entity    *ent;   /**< a value param entity */
1341         int          pos;    /**< its parameter number */
1342         ent_pos_pair *next;  /**< for linking */
1343 };
1344
1345 typedef struct lower_frame_sels_env_t {
1346         ent_pos_pair *value_param_list;          /**< the list of all value param entities */
1347         ir_node      *frame;                     /**< the current frame */
1348         const arch_register_class_t *sp_class;   /**< register class of the stack pointer */
1349         const arch_register_class_t *link_class; /**< register class of the link pointer */
1350         ir_type      *value_tp;                  /**< the value type if any */
1351         ir_type      *frame_tp;                  /**< the frame type */
1352         int          static_link_pos;            /**< argument number of the hidden static link */
1353 } lower_frame_sels_env_t;
1354
1355 /**
1356  * Return an entity from the backend for an value param entity.
1357  *
1358  * @param ent  an value param type entity
1359  * @param ctx  context
1360  */
1361 static ir_entity *get_argument_entity(ir_entity *ent, lower_frame_sels_env_t *ctx)
1362 {
1363         ir_entity *argument_ent = (ir_entity*)get_entity_link(ent);
1364
1365         if (argument_ent == NULL) {
1366                 /* we have NO argument entity yet: This is bad, as we will
1367                 * need one for backing store.
1368                 * Create one here.
1369                 */
1370                 ir_type *frame_tp = ctx->frame_tp;
1371                 unsigned offset   = get_type_size_bytes(frame_tp);
1372                 ir_type  *tp      = get_entity_type(ent);
1373                 unsigned align    = get_type_alignment_bytes(tp);
1374
1375                 offset += align - 1;
1376                 offset &= ~(align - 1);
1377
1378                 argument_ent = copy_entity_own(ent, frame_tp);
1379
1380                 /* must be automatic to set a fixed layout */
1381                 set_entity_offset(argument_ent, offset);
1382                 offset += get_type_size_bytes(tp);
1383
1384                 set_type_size_bytes(frame_tp, offset);
1385                 set_entity_link(ent, argument_ent);
1386         }
1387         return argument_ent;
1388 }
1389 /**
1390  * Walker: Replaces Sels of frame type and
1391  * value param type entities by FrameAddress.
1392  * Links all used entities.
1393  */
1394 static void lower_frame_sels_walker(ir_node *irn, void *data)
1395 {
1396         lower_frame_sels_env_t *ctx = (lower_frame_sels_env_t*)data;
1397
1398         if (is_Sel(irn)) {
1399                 ir_node *ptr = get_Sel_ptr(irn);
1400
1401                 if (ptr == ctx->frame) {
1402                         ir_entity    *ent = get_Sel_entity(irn);
1403                         ir_node      *bl  = get_nodes_block(irn);
1404                         ir_node      *nw;
1405                         int          pos = 0;
1406                         int          is_value_param = 0;
1407
1408                         if (get_entity_owner(ent) == ctx->value_tp) {
1409                                 is_value_param = 1;
1410
1411                                 /* replace by its copy from the argument type */
1412                                 pos = get_struct_member_index(ctx->value_tp, ent);
1413                                 ent = get_argument_entity(ent, ctx);
1414                         }
1415
1416                         nw = be_new_FrameAddr(ctx->sp_class, bl, ctx->frame, ent);
1417                         exchange(irn, nw);
1418
1419                         /* check, if it's a param Sel and if have not seen this entity before */
1420                         if (is_value_param && get_entity_link(ent) == NULL) {
1421                                 ent_pos_pair pair;
1422
1423                                 pair.ent  = ent;
1424                                 pair.pos  = pos;
1425                                 pair.next = NULL;
1426                                 ARR_APP1(ent_pos_pair, ctx->value_param_list, pair);
1427                                 /* just a mark */
1428                                 set_entity_link(ent, ctx->value_param_list);
1429                         }
1430                 }
1431         }
1432 }
1433
1434 /**
1435  * Check if a value parameter is transmitted as a register.
1436  * This might happen if the address of an parameter is taken which is
1437  * transmitted in registers.
1438  *
1439  * Note that on some architectures this case must be handled specially
1440  * because the place of the backing store is determined by their ABI.
1441  *
1442  * In the default case we move the entity to the frame type and create
1443  * a backing store into the first block.
1444  */
1445 static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_graph *irg,
1446                                             ent_pos_pair *value_param_list)
1447 {
1448         be_abi_call_t    *call     = env->call;
1449         const arch_env_t *arch_env = be_get_irg_arch_env(irg);
1450         ent_pos_pair  *entry, *new_list;
1451         ir_type       *frame_tp;
1452         int           i, n = ARR_LEN(value_param_list);
1453
1454         new_list = NULL;
1455         for (i = 0; i < n; ++i) {
1456                 int               pos  = value_param_list[i].pos;
1457                 be_abi_call_arg_t *arg = get_call_arg(call, 0, pos, 1);
1458
1459                 if (arg->in_reg) {
1460                         DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", pos));
1461                         value_param_list[i].next = new_list;
1462                         new_list = &value_param_list[i];
1463                 }
1464         }
1465         if (new_list != NULL) {
1466                 /* ok, change the graph */
1467                 ir_node *start_bl = get_irg_start_block(irg);
1468                 ir_node *first_bl = get_first_block_succ(start_bl);
1469                 ir_node *frame, *imem, *nmem, *store, *mem, *args;
1470                 optimization_state_t state;
1471                 unsigned offset;
1472
1473                 assert(first_bl && first_bl != start_bl);
1474                 /* we had already removed critical edges, so the following
1475                    assertion should be always true. */
1476                 assert(get_Block_n_cfgpreds(first_bl) == 1);
1477
1478                 /* now create backing stores */
1479                 frame = get_irg_frame(irg);
1480                 imem = get_irg_initial_mem(irg);
1481
1482                 save_optimization_state(&state);
1483                 set_optimize(0);
1484                 nmem = new_r_Proj(get_irg_start(irg), mode_M, pn_Start_M);
1485                 restore_optimization_state(&state);
1486
1487                 /* reroute all edges to the new memory source */
1488                 edges_reroute(imem, nmem);
1489
1490                 store   = NULL;
1491                 mem     = imem;
1492                 args    = get_irg_args(irg);
1493                 for (entry = new_list; entry != NULL; entry = entry->next) {
1494                         int     i     = entry->pos;
1495                         ir_type *tp   = get_entity_type(entry->ent);
1496                         ir_mode *mode = get_type_mode(tp);
1497                         ir_node *addr;
1498
1499                         /* address for the backing store */
1500                         addr = be_new_FrameAddr(arch_env->sp->reg_class, first_bl, frame, entry->ent);
1501
1502                         if (store)
1503                                 mem = new_r_Proj(store, mode_M, pn_Store_M);
1504
1505                         /* the backing store itself */
1506                         store = new_r_Store(first_bl, mem, addr,
1507                                             new_r_Proj(args, mode, i), cons_none);
1508                 }
1509                 /* the new memory Proj gets the last Proj from store */
1510                 set_Proj_pred(nmem, store);
1511                 set_Proj_proj(nmem, pn_Store_M);
1512
1513                 /* move all entities to the frame type */
1514                 frame_tp = get_irg_frame_type(irg);
1515                 offset   = get_type_size_bytes(frame_tp);
1516
1517                 /* we will add new entities: set the layout to undefined */
1518                 assert(get_type_state(frame_tp) == layout_fixed);
1519                 set_type_state(frame_tp, layout_undefined);
1520                 for (entry = new_list; entry != NULL; entry = entry->next) {
1521                         ir_entity *ent = entry->ent;
1522
1523                         /* If the entity is still on the argument type, move it to the
1524                          * frame type.
1525                          * This happens if the value_param type was build due to compound
1526                          * params. */
1527                         if (get_entity_owner(ent) != frame_tp) {
1528                                 ir_type  *tp   = get_entity_type(ent);
1529                                 unsigned align = get_type_alignment_bytes(tp);
1530
1531                                 offset += align - 1;
1532                                 offset &= ~(align - 1);
1533                                 set_entity_owner(ent, frame_tp);
1534                                 /* must be automatic to set a fixed layout */
1535                                 set_entity_offset(ent, offset);
1536                                 offset += get_type_size_bytes(tp);
1537                         }
1538                 }
1539                 set_type_size_bytes(frame_tp, offset);
1540                 /* fix the layout again */
1541                 set_type_state(frame_tp, layout_fixed);
1542         }
1543 }
1544
1545 /**
1546  * The start block has no jump, instead it has an initial exec Proj.
1547  * The backend wants to handle all blocks the same way, so we replace
1548  * the out cfg edge with a real jump.
1549  */
1550 static void fix_start_block(ir_graph *irg)
1551 {
1552         ir_node *initial_X   = get_irg_initial_exec(irg);
1553         ir_node *start_block = get_irg_start_block(irg);
1554         ir_node *jmp         = new_r_Jmp(start_block);
1555
1556         assert(is_Proj(initial_X));
1557         exchange(initial_X, jmp);
1558         set_irg_initial_exec(irg, new_r_Bad(irg));
1559 }
1560
1561 /**
1562  * Update the entity of Sels to the outer value parameters.
1563  */
1564 static void update_outer_frame_sels(ir_node *irn, void *env)
1565 {
1566         lower_frame_sels_env_t *ctx = (lower_frame_sels_env_t*)env;
1567         ir_node                *ptr;
1568         ir_entity              *ent;
1569         int                    pos = 0;
1570
1571         if (! is_Sel(irn))
1572                 return;
1573         ptr = get_Sel_ptr(irn);
1574         if (! is_arg_Proj(ptr))
1575                 return;
1576         if (get_Proj_proj(ptr) != ctx->static_link_pos)
1577                 return;
1578         ent   = get_Sel_entity(irn);
1579
1580         if (get_entity_owner(ent) == ctx->value_tp) {
1581                 /* replace by its copy from the argument type */
1582                 pos = get_struct_member_index(ctx->value_tp, ent);
1583                 ent = get_argument_entity(ent, ctx);
1584                 set_Sel_entity(irn, ent);
1585
1586                 /* check, if we have not seen this entity before */
1587                 if (get_entity_link(ent) == NULL) {
1588                         ent_pos_pair pair;
1589
1590                         pair.ent  = ent;
1591                         pair.pos  = pos;
1592                         pair.next = NULL;
1593                         ARR_APP1(ent_pos_pair, ctx->value_param_list, pair);
1594                         /* just a mark */
1595                         set_entity_link(ent, ctx->value_param_list);
1596                 }
1597         }
1598 }
1599
1600 /**
1601  * Fix access to outer local variables.
1602  */
1603 static void fix_outer_variable_access(be_abi_irg_t *env,
1604                                       lower_frame_sels_env_t *ctx)
1605 {
1606         int      i;
1607         ir_graph *irg;
1608         (void) env;
1609
1610         for (i = get_class_n_members(ctx->frame_tp) - 1; i >= 0; --i) {
1611                 ir_entity *ent = get_class_member(ctx->frame_tp, i);
1612
1613                 if (! is_method_entity(ent))
1614                         continue;
1615
1616                 irg = get_entity_irg(ent);
1617                 if (irg == NULL)
1618                         continue;
1619
1620                 /*
1621                  * FIXME: find the number of the static link parameter
1622                  * for now we assume 0 here
1623                  */
1624                 ctx->static_link_pos = 0;
1625
1626                 irg_walk_graph(irg, NULL, update_outer_frame_sels, ctx);
1627         }
1628 }
1629
1630 /**
1631  * Modify the irg itself and the frame type.
1632  */
1633 static void modify_irg(ir_graph *irg)
1634 {
1635         be_abi_irg_t          *env          = be_get_irg_abi(irg);
1636         be_abi_call_t         *call         = env->call;
1637         const arch_env_t      *arch_env     = be_get_irg_arch_env(irg);
1638         const arch_register_t *sp           = arch_env->sp;
1639         ir_type               *method_type  = get_entity_type(get_irg_entity(irg));
1640         be_irg_t              *birg         = be_birg_from_irg(irg);
1641         struct obstack        *obst         = be_get_be_obst(irg);
1642         be_stack_layout_t     *stack_layout = be_get_irg_stack_layout(irg);
1643         ir_node *end;
1644         ir_node *old_mem;
1645         ir_node *new_mem_proj;
1646         ir_node *mem;
1647
1648         int n_params;
1649         int i, n;
1650         unsigned j;
1651         unsigned frame_size;
1652
1653         reg_node_map_t *rm;
1654         const arch_register_t *fp_reg;
1655         ir_node *frame_pointer;
1656         ir_node *start_bl;
1657         ir_node **args;
1658         ir_node *arg_tuple;
1659         const ir_edge_t *edge;
1660         ir_type *arg_type, *bet_type, *tp;
1661         lower_frame_sels_env_t ctx;
1662         ir_entity **param_map;
1663
1664         DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1665
1666         old_mem = get_irg_initial_mem(irg);
1667
1668         irp_reserve_resources(irp, IR_RESOURCE_ENTITY_LINK);
1669
1670         /* set the links of all frame entities to NULL, we use it
1671            to detect if an entity is already linked in the value_param_list */
1672         tp = get_method_value_param_type(method_type);
1673         ctx.value_tp = tp;
1674         if (tp != NULL) {
1675                 /* clear the links of the clone type, let the
1676                    original entities point to its clones */
1677                 for (i = get_struct_n_members(tp) - 1; i >= 0; --i) {
1678                         ir_entity *mem  = get_struct_member(tp, i);
1679                         set_entity_link(mem, NULL);
1680                 }
1681         }
1682
1683         arg_type = compute_arg_type(env, irg, call, method_type, tp, &param_map);
1684
1685         /* Convert the Sel nodes in the irg to frame addr nodes: */
1686         ctx.value_param_list = NEW_ARR_F(ent_pos_pair, 0);
1687         ctx.frame            = get_irg_frame(irg);
1688         ctx.sp_class         = arch_env->sp->reg_class;
1689         ctx.link_class       = arch_env->link_class;
1690         ctx.frame_tp         = get_irg_frame_type(irg);
1691
1692         /* layout the stackframe now */
1693         if (get_type_state(ctx.frame_tp) == layout_undefined) {
1694                 default_layout_compound_type(ctx.frame_tp);
1695         }
1696
1697         /* we will possible add new entities to the frame: set the layout to undefined */
1698         assert(get_type_state(ctx.frame_tp) == layout_fixed);
1699         set_type_state(ctx.frame_tp, layout_undefined);
1700
1701         irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1702
1703         /* fix the frame type layout again */
1704         set_type_state(ctx.frame_tp, layout_fixed);
1705         /* align stackframe to 4 byte */
1706         frame_size = get_type_size_bytes(ctx.frame_tp);
1707         if (frame_size % 4 != 0) {
1708                 set_type_size_bytes(ctx.frame_tp, frame_size + 4 - (frame_size % 4));
1709         }
1710
1711         env->regs  = pmap_create();
1712
1713         n_params = get_method_n_params(method_type);
1714         args     = OALLOCNZ(obst, ir_node*, n_params);
1715
1716         /*
1717          * for inner function we must now fix access to outer frame entities.
1718          */
1719         fix_outer_variable_access(env, &ctx);
1720
1721         /* Check if a value parameter is transmitted as a register.
1722          * This might happen if the address of an parameter is taken which is
1723          * transmitted in registers.
1724          *
1725          * Note that on some architectures this case must be handled specially
1726          * because the place of the backing store is determined by their ABI.
1727          *
1728          * In the default case we move the entity to the frame type and create
1729          * a backing store into the first block.
1730          */
1731         fix_address_of_parameter_access(env, irg, ctx.value_param_list);
1732
1733         DEL_ARR_F(ctx.value_param_list);
1734         irp_free_resources(irp, IR_RESOURCE_ENTITY_LINK);
1735
1736         /* Fill the argument vector */
1737         arg_tuple = get_irg_args(irg);
1738         foreach_out_edge(arg_tuple, edge) {
1739                 ir_node *irn = get_edge_src_irn(edge);
1740                 if (! is_Anchor(irn)) {
1741                         int nr       = get_Proj_proj(irn);
1742                         args[nr]     = irn;
1743                         DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1744                 }
1745         }
1746
1747         stack_layout->sp_relative = call->flags.bits.try_omit_fp;
1748         bet_type = call->cb->get_between_type(irg);
1749         stack_frame_init(stack_layout, arg_type, bet_type,
1750                          get_irg_frame_type(irg), param_map);
1751
1752         /* Count the register params and add them to the number of Projs for the RegParams node */
1753         for (i = 0; i < n_params; ++i) {
1754                 be_abi_call_arg_t *arg = get_call_arg(call, 0, i, 1);
1755                 if (arg->in_reg && args[i]) {
1756                         assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1757                         assert(i == get_Proj_proj(args[i]));
1758
1759                         /* For now, associate the register with the old Proj from Start representing that argument. */
1760                         pmap_insert(env->regs, (void *) arg->reg, args[i]);
1761                         DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1762                 }
1763         }
1764
1765         /* Collect all callee-save registers */
1766         for (i = 0, n = arch_env->n_register_classes; i < n; ++i) {
1767                 const arch_register_class_t *cls = &arch_env->register_classes[i];
1768                 for (j = 0; j < cls->n_regs; ++j) {
1769                         const arch_register_t *reg = &cls->regs[j];
1770                         if (reg->type & (arch_register_type_callee_save | arch_register_type_state)) {
1771                                 pmap_insert(env->regs, (void *) reg, NULL);
1772                         }
1773                 }
1774         }
1775
1776         fp_reg = call->flags.bits.try_omit_fp ? arch_env->sp : arch_env->bp;
1777         rbitset_clear(birg->allocatable_regs, fp_reg->global_index);
1778
1779         /* handle start block here (place a jump in the block) */
1780         fix_start_block(irg);
1781
1782         pmap_insert(env->regs, (void *) sp, NULL);
1783         pmap_insert(env->regs, (void *) arch_env->bp, NULL);
1784         start_bl   = get_irg_start_block(irg);
1785         env->start = be_new_Start(NULL, start_bl, pmap_count(env->regs) + 1);
1786         set_irg_start(irg, env->start);
1787
1788         /*
1789          * make proj nodes for the callee save registers.
1790          * memorize them, since Return nodes get those as inputs.
1791          *
1792          * Note, that if a register corresponds to an argument, the regs map
1793          * contains the old Proj from start for that argument.
1794          */
1795         rm = ALLOCAN(reg_node_map_t, pmap_count(env->regs));
1796         reg_map_to_arr(rm, env->regs);
1797         for (i = 0, n = pmap_count(env->regs); i < n; ++i) {
1798                 const arch_register_t    *reg      = rm[i].reg;
1799                 ir_mode                  *mode     = reg->reg_class->mode;
1800                 long                      nr       = i;
1801                 arch_register_req_type_t  add_type = arch_register_req_type_none;
1802                 ir_node                  *proj;
1803
1804                 if (reg == sp)
1805                         add_type |= arch_register_req_type_produces_sp;
1806                 if (!rbitset_is_set(birg->allocatable_regs, reg->global_index)) {
1807                         add_type |= arch_register_req_type_ignore;
1808                 }
1809
1810                 assert(nr >= 0);
1811                 proj = new_r_Proj(env->start, mode, nr + 1);
1812                 pmap_insert(env->regs, (void *) reg, proj);
1813                 be_set_constr_single_reg_out(env->start, nr + 1, reg, add_type);
1814                 arch_set_irn_register(proj, reg);
1815
1816                 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1817         }
1818
1819         /* create a new initial memory proj */
1820         assert(is_Proj(old_mem));
1821         arch_set_out_register_req(env->start, 0, arch_no_register_req);
1822         new_mem_proj = new_r_Proj(env->start, mode_M, 0);
1823         mem = new_mem_proj;
1824         set_irg_initial_mem(irg, mem);
1825
1826         env->init_sp = be_abi_reg_map_get(env->regs, sp);
1827
1828         /* set new frame_pointer */
1829         frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1830         set_irg_frame(irg, frame_pointer);
1831
1832         /* rewire old mem users to new mem */
1833         exchange(old_mem, mem);
1834
1835         /* keep the mem (for functions with an endless loop = no return) */
1836         keep_alive(mem);
1837
1838         set_irg_initial_mem(irg, mem);
1839
1840         /* Now, introduce stack param nodes for all parameters passed on the stack */
1841         for (i = 0; i < n_params; ++i) {
1842                 ir_node *arg_proj = args[i];
1843                 ir_node *repl     = NULL;
1844
1845                 if (arg_proj != NULL) {
1846                         be_abi_call_arg_t *arg;
1847                         ir_type *param_type;
1848                         int     nr = get_Proj_proj(arg_proj);
1849                         ir_mode *mode;
1850
1851                         nr         = MIN(nr, n_params);
1852                         arg        = get_call_arg(call, 0, nr, 1);
1853                         param_type = get_method_param_type(method_type, nr);
1854
1855                         if (arg->in_reg) {
1856                                 repl = (ir_node*)pmap_get(env->regs, arg->reg);
1857                         } else if (arg->on_stack) {
1858                                 ir_node *addr = be_new_FrameAddr(sp->reg_class, start_bl, frame_pointer, arg->stack_ent);
1859
1860                                 /* For atomic parameters which are actually used, we create a Load node. */
1861                                 if (is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1862                                         ir_mode *mode      = get_type_mode(param_type);
1863                                         ir_mode *load_mode = arg->load_mode;
1864
1865                                         ir_node *load = new_r_Load(start_bl, new_r_NoMem(irg), addr, load_mode, cons_floats);
1866                                         repl = new_r_Proj(load, load_mode, pn_Load_res);
1867
1868                                         if (mode != load_mode) {
1869                                                 repl = new_r_Conv(start_bl, repl, mode);
1870                                         }
1871                                 } else {
1872                                         /* The stack parameter is not primitive (it is a struct or array),
1873                                          * we thus will create a node representing the parameter's address
1874                                          * on the stack. */
1875                                         repl = addr;
1876                                 }
1877                         }
1878
1879                         assert(repl != NULL);
1880
1881                         /* Beware: the mode of the register parameters is always the mode of the register class
1882                            which may be wrong. Add Conv's then. */
1883                         mode = get_irn_mode(args[i]);
1884                         if (mode != get_irn_mode(repl)) {
1885                                 repl = new_r_Conv(get_nodes_block(repl), repl, mode);
1886                         }
1887                         exchange(args[i], repl);
1888                 }
1889         }
1890
1891         /* the arg proj is not needed anymore now and should be only used by the anchor */
1892         assert(get_irn_n_edges(arg_tuple) == 1);
1893         kill_node(arg_tuple);
1894         set_irg_args(irg, new_r_Bad(irg));
1895
1896         /* All Return nodes hang on the End node, so look for them there. */
1897         end = get_irg_end_block(irg);
1898         for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1899                 ir_node *irn = get_Block_cfgpred(end, i);
1900
1901                 if (is_Return(irn)) {
1902                         ir_node *blk = get_nodes_block(irn);
1903                         ir_node *mem = get_Return_mem(irn);
1904                         ir_node *ret = create_be_return(env, irn, blk, mem, get_Return_n_ress(irn));
1905                         exchange(irn, ret);
1906                 }
1907         }
1908
1909         /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return then,
1910            the code is dead and will never be executed. */
1911 }
1912
1913 /** Fix the state inputs of calls that still hang on unknowns */
1914 static void fix_call_state_inputs(ir_graph *irg)
1915 {
1916         be_abi_irg_t     *env      = be_get_irg_abi(irg);
1917         const arch_env_t *arch_env = be_get_irg_arch_env(irg);
1918         int i, n, n_states;
1919         arch_register_t **stateregs = NEW_ARR_F(arch_register_t*, 0);
1920
1921         /* Collect caller save registers */
1922         n = arch_env->n_register_classes;
1923         for (i = 0; i < n; ++i) {
1924                 unsigned j;
1925                 const arch_register_class_t *cls = &arch_env->register_classes[i];
1926                 for (j = 0; j < cls->n_regs; ++j) {
1927                         const arch_register_t *reg = arch_register_for_index(cls, j);
1928                         if (reg->type & arch_register_type_state) {
1929                                 ARR_APP1(arch_register_t*, stateregs, (arch_register_t *)reg);
1930                         }
1931                 }
1932         }
1933
1934         n = ARR_LEN(env->calls);
1935         n_states = ARR_LEN(stateregs);
1936         for (i = 0; i < n; ++i) {
1937                 int s, arity;
1938                 ir_node *call = env->calls[i];
1939
1940                 arity = get_irn_arity(call);
1941
1942                 /* the state reg inputs are the last n inputs of the calls */
1943                 for (s = 0; s < n_states; ++s) {
1944                         int inp = arity - n_states + s;
1945                         const arch_register_t *reg = stateregs[s];
1946                         ir_node *regnode = be_abi_reg_map_get(env->regs, reg);
1947
1948                         set_irn_n(call, inp, regnode);
1949                 }
1950         }
1951
1952         DEL_ARR_F(stateregs);
1953 }
1954
1955 /**
1956  * Create a trampoline entity for the given method.
1957  */
1958 static ir_entity *create_trampoline(be_main_env_t *be, ir_entity *method)
1959 {
1960         ir_type   *type   = get_entity_type(method);
1961         ident     *old_id = get_entity_ld_ident(method);
1962         ident     *id     = id_mangle3("", old_id, "$stub");
1963         ir_type   *parent = be->pic_trampolines_type;
1964         ir_entity *ent    = new_entity(parent, old_id, type);
1965         set_entity_ld_ident(ent, id);
1966         set_entity_visibility(ent, ir_visibility_private);
1967
1968         return ent;
1969 }
1970
1971 /**
1972  * Returns the trampoline entity for the given method.
1973  */
1974 static ir_entity *get_trampoline(be_main_env_t *env, ir_entity *method)
1975 {
1976         ir_entity *result = (ir_entity*)pmap_get(env->ent_trampoline_map, method);
1977         if (result == NULL) {
1978                 result = create_trampoline(env, method);
1979                 pmap_insert(env->ent_trampoline_map, method, result);
1980         }
1981
1982         return result;
1983 }
1984
1985 static ir_entity *create_pic_symbol(be_main_env_t *be, ir_entity *entity)
1986 {
1987         ident     *old_id = get_entity_ld_ident(entity);
1988         ident     *id     = id_mangle3("", old_id, "$non_lazy_ptr");
1989         ir_type   *e_type = get_entity_type(entity);
1990         ir_type   *type   = new_type_pointer(e_type);
1991         ir_type   *parent = be->pic_symbols_type;
1992         ir_entity *ent    = new_entity(parent, old_id, type);
1993         set_entity_ld_ident(ent, id);
1994         set_entity_visibility(ent, ir_visibility_private);
1995
1996         return ent;
1997 }
1998
1999 static ir_entity *get_pic_symbol(be_main_env_t *env, ir_entity *entity)
2000 {
2001         ir_entity *result = (ir_entity*)pmap_get(env->ent_pic_symbol_map, entity);
2002         if (result == NULL) {
2003                 result = create_pic_symbol(env, entity);
2004                 pmap_insert(env->ent_pic_symbol_map, entity, result);
2005         }
2006
2007         return result;
2008 }
2009
2010
2011
2012 /**
2013  * Returns non-zero if a given entity can be accessed using a relative address.
2014  */
2015 static int can_address_relative(ir_entity *entity)
2016 {
2017         return get_entity_visibility(entity) != ir_visibility_external
2018                 && !(get_entity_linkage(entity) & IR_LINKAGE_MERGE);
2019 }
2020
2021 static ir_node *get_pic_base(ir_graph *irg)
2022 {
2023         const arch_env_t *arch_env = be_get_irg_arch_env(irg);
2024         if (arch_env->impl->get_pic_base == NULL)
2025                 return NULL;
2026         return arch_env->impl->get_pic_base(irg);
2027 }
2028
2029 /** patches SymConsts to work in position independent code */
2030 static void fix_pic_symconsts(ir_node *node, void *data)
2031 {
2032         ir_graph         *irg = get_irn_irg(node);
2033         be_main_env_t    *be  = be_get_irg_main_env(irg);
2034         ir_node          *pic_base;
2035         ir_node          *add;
2036         ir_node          *block;
2037         ir_mode          *mode;
2038         ir_node          *load;
2039         ir_node          *load_res;
2040         int               arity, i;
2041         (void) data;
2042
2043         arity = get_irn_arity(node);
2044         for (i = 0; i < arity; ++i) {
2045                 dbg_info  *dbgi;
2046                 ir_node   *pred = get_irn_n(node, i);
2047                 ir_entity *entity;
2048                 ir_entity *pic_symbol;
2049                 ir_node   *pic_symconst;
2050
2051                 if (!is_SymConst(pred))
2052                         continue;
2053
2054                 entity = get_SymConst_entity(pred);
2055                 block  = get_nodes_block(pred);
2056
2057                 /* calls can jump to relative addresses, so we can directly jump to
2058                    the (relatively) known call address or the trampoline */
2059                 if (i == 1 && is_Call(node)) {
2060                         ir_entity *trampoline;
2061                         ir_node   *trampoline_const;
2062
2063                         if (can_address_relative(entity))
2064                                 continue;
2065
2066                         dbgi             = get_irn_dbg_info(pred);
2067                         trampoline       = get_trampoline(be, entity);
2068                         trampoline_const = new_rd_SymConst_addr_ent(dbgi, irg, mode_P_code,
2069                                                                     trampoline);
2070                         set_irn_n(node, i, trampoline_const);
2071                         continue;
2072                 }
2073
2074                 /* everything else is accessed relative to EIP */
2075                 mode     = get_irn_mode(pred);
2076                 pic_base = get_pic_base(irg);
2077
2078                 /* all ok now for locally constructed stuff */
2079                 if (can_address_relative(entity)) {
2080                         ir_node *add = new_r_Add(block, pic_base, pred, mode);
2081
2082                         /* make sure the walker doesn't visit this add again */
2083                         mark_irn_visited(add);
2084                         set_irn_n(node, i, add);
2085                         continue;
2086                 }
2087
2088                 /* get entry from pic symbol segment */
2089                 dbgi         = get_irn_dbg_info(pred);
2090                 pic_symbol   = get_pic_symbol(be, entity);
2091                 pic_symconst = new_rd_SymConst_addr_ent(dbgi, irg, mode_P_code,
2092                                                         pic_symbol);
2093                 add = new_r_Add(block, pic_base, pic_symconst, mode);
2094                 mark_irn_visited(add);
2095
2096                 /* we need an extra indirection for global data outside our current
2097                    module. The loads are always safe and can therefore float
2098                    and need no memory input */
2099                 load     = new_r_Load(block, new_r_NoMem(irg), add, mode, cons_floats);
2100                 load_res = new_r_Proj(load, mode, pn_Load_res);
2101
2102                 set_irn_n(node, i, load_res);
2103         }
2104 }
2105
2106 void be_abi_introduce(ir_graph *irg)
2107 {
2108         be_abi_irg_t     *env         = XMALLOCZ(be_abi_irg_t);
2109         ir_node          *old_frame   = get_irg_frame(irg);
2110         be_options_t     *options     = be_get_irg_options(irg);
2111         const arch_env_t *arch_env    = be_get_irg_arch_env(irg);
2112         ir_entity        *entity      = get_irg_entity(irg);
2113         ir_type          *method_type = get_entity_type(entity);
2114         be_irg_t         *birg        = be_birg_from_irg(irg);
2115         struct obstack   *obst        = &birg->obst;
2116         ir_node          *dummy       = new_r_Dummy(irg,
2117                                                     arch_env->sp->reg_class->mode);
2118         unsigned          r;
2119
2120         /* determine allocatable registers */
2121         assert(birg->allocatable_regs == NULL);
2122         birg->allocatable_regs = rbitset_obstack_alloc(obst, arch_env->n_registers);
2123         for (r = 0; r < arch_env->n_registers; ++r) {
2124                 const arch_register_t *reg = &arch_env->registers[r];
2125                 if ( !(reg->type & arch_register_type_ignore)) {
2126                         rbitset_set(birg->allocatable_regs, r);
2127                 }
2128         }
2129
2130         /* break here if backend provides a custom API.
2131          * Note: we shouldn't have to setup any be_abi_irg_t* stuff at all,
2132          * but need more cleanup to make this work
2133          */
2134         be_set_irg_abi(irg, env);
2135
2136         be_omit_fp      = options->omit_fp;
2137
2138         env->keep_map     = pmap_create();
2139         env->call         = be_abi_call_new(arch_env->sp->reg_class);
2140         arch_env_get_call_abi(arch_env, method_type, env->call);
2141
2142         env->init_sp = dummy;
2143         env->calls   = NEW_ARR_F(ir_node*, 0);
2144
2145         if (options->pic) {
2146                 irg_walk_graph(irg, fix_pic_symconsts, NULL, env);
2147         }
2148
2149         /* Lower all call nodes in the IRG. */
2150         process_calls(irg);
2151
2152         /* Process the IRG */
2153         modify_irg(irg);
2154
2155         /* fix call inputs for state registers */
2156         fix_call_state_inputs(irg);
2157
2158         /* We don't need the keep map anymore. */
2159         pmap_destroy(env->keep_map);
2160         env->keep_map = NULL;
2161
2162         /* calls array is not needed anymore */
2163         DEL_ARR_F(env->calls);
2164         env->calls = NULL;
2165
2166         /* reroute the stack origin of the calls to the true stack origin. */
2167         exchange(dummy, env->init_sp);
2168         exchange(old_frame, get_irg_frame(irg));
2169
2170         pmap_destroy(env->regs);
2171         env->regs = NULL;
2172 }
2173
2174 void be_abi_free(ir_graph *irg)
2175 {
2176         be_abi_irg_t *env = be_get_irg_abi(irg);
2177
2178         if (env->call != NULL)
2179                 be_abi_call_free(env->call);
2180         free(env);
2181         assert(env->regs == NULL);
2182
2183         be_set_irg_abi(irg, NULL);
2184 }
2185
2186 void be_put_allocatable_regs(const ir_graph *irg,
2187                              const arch_register_class_t *cls, bitset_t *bs)
2188 {
2189         be_irg_t *birg             = be_birg_from_irg(irg);
2190         unsigned *allocatable_regs = birg->allocatable_regs;
2191         unsigned  i;
2192
2193         assert(bitset_size(bs) == cls->n_regs);
2194         bitset_clear_all(bs);
2195         for (i = 0; i < cls->n_regs; ++i) {
2196                 const arch_register_t *reg = &cls->regs[i];
2197                 if (rbitset_is_set(allocatable_regs, reg->global_index))
2198                         bitset_set(bs, i);
2199         }
2200 }
2201
2202 unsigned be_get_n_allocatable_regs(const ir_graph *irg,
2203                                    const arch_register_class_t *cls)
2204 {
2205         bitset_t *bs = bitset_alloca(cls->n_regs);
2206         be_put_allocatable_regs(irg, cls, bs);
2207         return bitset_popcount(bs);
2208 }
2209
2210 void be_set_allocatable_regs(const ir_graph *irg,
2211                              const arch_register_class_t *cls,
2212                              unsigned *raw_bitset)
2213 {
2214         be_irg_t *birg             = be_birg_from_irg(irg);
2215         unsigned *allocatable_regs = birg->allocatable_regs;
2216         unsigned  i;
2217
2218         rbitset_clear_all(raw_bitset, cls->n_regs);
2219         for (i = 0; i < cls->n_regs; ++i) {
2220                 const arch_register_t *reg = &cls->regs[i];
2221                 if (rbitset_is_set(allocatable_regs, reg->global_index))
2222                         rbitset_set(raw_bitset, i);
2223         }
2224 }
2225
2226 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_abi);
2227 void be_init_abi(void)
2228 {
2229         FIRM_DBG_REGISTER(dbg, "firm.be.abi");
2230 }