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