4 * @author Sebastian Hack
19 #include "irgraph_t.h"
22 #include "iredges_t.h"
25 #include "irprintf_t.h"
37 #include "besched_t.h"
39 typedef struct _be_abi_call_arg_t {
40 unsigned is_res : 1; /**< 1: the call argument is a return value. 0: it's a call parameter. */
41 unsigned in_reg : 1; /**< 1: this argument is transmitted in registers. */
42 unsigned on_stack : 1; /**< 1: this argument is transmitted on the stack. */
45 const arch_register_t *reg;
48 unsigned space_before;
52 struct _be_abi_call_t {
53 be_abi_call_flags_t flags;
54 const be_abi_callbacks_t *cb;
55 ir_type *between_type;
59 #define N_FRAME_TYPES 3
62 * This type describes the stack layout.
63 * The stack is divided into 3 parts:
64 * - arg_type: A struct type describing the stack arguments and it's order.
65 * - between_type: A struct type describing the stack layout between arguments
67 * - frame_type: A class type descibing the frame layout
69 typedef struct _be_stack_layout_t {
70 ir_type *arg_type; /**< A type describing the stack argument layout. */
71 ir_type *between_type; /**< A type describing the "between" layout. */
72 ir_type *frame_type; /**< The frame type. */
74 ir_type *order[N_FRAME_TYPES]; /**< arg, between and frame types ordered. */
77 int stack_dir; /**< -1 for decreasing, 1 for increasing. */
80 struct _be_abi_irg_t {
82 be_stack_layout_t *frame; /**< The stack frame model. */
83 const be_irg_t *birg; /**< The back end IRG. */
84 const arch_isa_t *isa; /**< The isa. */
85 survive_dce_t *dce_survivor;
87 be_abi_call_t *call; /**< The ABI call information. */
88 ir_type *method_type; /**< The type of the method of the IRG. */
90 ir_node *init_sp; /**< The node representing the stack pointer
91 at the start of the function. */
93 ir_node *reg_params; /**< The reg params node. */
94 pmap *regs; /**< A map of all callee-save and ignore regs to
95 their Projs to the RegParams node. */
97 pset *stack_phis; /**< The set of all Phi nodes inserted due to
98 stack pointer modifying nodes. */
100 int start_block_bias; /**< The stack bias at the end of the start block. */
102 void *cb; /**< ABI Callback self pointer. */
104 pmap *keep_map; /**< mapping blocks to keep nodes. */
105 pset *ignore_regs; /**< Additional registers which shall be ignored. */
107 arch_irn_handler_t irn_handler;
108 arch_irn_ops_t irn_ops;
109 DEBUG_ONLY(firm_dbg_module_t *dbg;) /**< The debugging module. */
112 #define get_abi_from_handler(ptr) firm_container_of(ptr, be_abi_irg_t, irn_handler)
113 #define get_abi_from_ops(ptr) firm_container_of(ptr, be_abi_irg_t, irn_ops)
115 /* Forward, since be need it in be_abi_introduce(). */
116 static const arch_irn_ops_if_t abi_irn_ops;
117 static const arch_irn_handler_t abi_irn_handler;
118 static heights_t *ir_heights;
120 /* Flag: if set, try to omit the frame pointer if called by the backend */
124 _ ____ ___ ____ _ _ _ _
125 / \ | __ )_ _| / ___|__ _| | | |__ __ _ ___| | _____
126 / _ \ | _ \| | | | / _` | | | '_ \ / _` |/ __| |/ / __|
127 / ___ \| |_) | | | |__| (_| | | | |_) | (_| | (__| <\__ \
128 /_/ \_\____/___| \____\__,_|_|_|_.__/ \__,_|\___|_|\_\___/
130 These callbacks are used by the backend to set the parameters
131 for a specific call type.
135 * Set compare function: compares two ABI call object arguments.
137 static int cmp_call_arg(const void *a, const void *b, size_t n)
139 const be_abi_call_arg_t *p = a, *q = b;
140 return !(p->is_res == q->is_res && p->pos == q->pos);
144 * Get or set an ABI call object argument.
146 * @param call the abi call
147 * @param is_res true for call results, false for call arguments
148 * @param pos position of the argument
149 * @param do_insert true if the argument is set, false if it's retrieved
151 static be_abi_call_arg_t *get_or_set_call_arg(be_abi_call_t *call, int is_res, int pos, int do_insert)
153 be_abi_call_arg_t arg;
156 memset(&arg, 0, sizeof(arg));
160 hash = is_res * 128 + pos;
163 ? set_insert(call->params, &arg, sizeof(arg), hash)
164 : set_find(call->params, &arg, sizeof(arg), hash);
168 * Retrieve an ABI call object argument.
170 * @param call the ABI call object
171 * @param is_res true for call results, false for call arguments
172 * @param pos position of the argument
174 static INLINE be_abi_call_arg_t *get_call_arg(be_abi_call_t *call, int is_res, int pos)
176 return get_or_set_call_arg(call, is_res, pos, 0);
179 /* Set the flags for a call. */
180 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb)
186 void be_abi_call_param_stack(be_abi_call_t *call, int arg_pos, unsigned alignment, unsigned space_before, unsigned space_after)
188 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
190 arg->alignment = alignment;
191 arg->space_before = space_before;
192 arg->space_after = space_after;
193 assert(alignment > 0 && "Alignment must be greater than 0");
196 void be_abi_call_param_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
198 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
203 void be_abi_call_res_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
205 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 1, arg_pos, 1);
210 /* Get the flags of a ABI call object. */
211 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call)
217 * Constructor for a new ABI call object.
219 * @return the new ABI call object
221 static be_abi_call_t *be_abi_call_new(void)
223 be_abi_call_t *call = xmalloc(sizeof(call[0]));
225 call->params = new_set(cmp_call_arg, 16);
228 call->flags.bits.try_omit_fp = be_omit_fp;
233 * Destructor for an ABI call object.
235 static void be_abi_call_free(be_abi_call_t *call)
237 del_set(call->params);
243 | ___| __ __ _ _ __ ___ ___ | | | | __ _ _ __ __| | (_)_ __ __ _
244 | |_ | '__/ _` | '_ ` _ \ / _ \ | |_| |/ _` | '_ \ / _` | | | '_ \ / _` |
245 | _|| | | (_| | | | | | | __/ | _ | (_| | | | | (_| | | | | | | (_| |
246 |_| |_| \__,_|_| |_| |_|\___| |_| |_|\__,_|_| |_|\__,_|_|_|_| |_|\__, |
249 Handling of the stack frame. It is composed of three types:
250 1) The type of the arguments which are pushed on the stack.
251 2) The "between type" which consists of stuff the call of the
252 function pushes on the stack (like the return address and
253 the old base pointer for ia32).
254 3) The Firm frame type which consists of all local variables
258 static int get_stack_entity_offset(be_stack_layout_t *frame, entity *ent, int bias)
260 ir_type *t = get_entity_owner(ent);
261 int ofs = get_entity_offset_bytes(ent);
265 /* Find the type the entity is contained in. */
266 for(index = 0; index < N_FRAME_TYPES; ++index) {
267 if(frame->order[index] == t)
271 /* Add the size of all the types below the one of the entity to the entity's offset */
272 for(i = 0; i < index; ++i)
273 ofs += get_type_size_bytes(frame->order[i]);
275 /* correct the offset by the initial position of the frame pointer */
276 ofs -= frame->initial_offset;
278 /* correct the offset with the current bias. */
285 * Retrieve the entity with given offset from a frame type.
287 static entity *search_ent_with_offset(ir_type *t, int offset)
291 for(i = 0, n = get_compound_n_members(t); i < n; ++i) {
292 entity *ent = get_compound_member(t, i);
293 if(get_entity_offset_bytes(ent) == offset)
300 static int stack_frame_compute_initial_offset(be_stack_layout_t *frame)
302 ir_type *base = frame->stack_dir < 0 ? frame->between_type : frame->frame_type;
303 entity *ent = search_ent_with_offset(base, 0);
304 frame->initial_offset = 0;
305 frame->initial_offset = get_stack_entity_offset(frame, ent, 0);
306 return frame->initial_offset;
310 * Initializes the frame layout from parts
312 * @param frame the stack layout that will be initialized
313 * @param args the stack argument layout type
314 * @param between the between layout type
315 * @param locals the method frame type
316 * @param stack_dir the stack direction
318 * @return the initialized stack layout
320 static be_stack_layout_t *stack_frame_init(be_stack_layout_t *frame, ir_type *args,
321 ir_type *between, ir_type *locals, int stack_dir)
323 frame->arg_type = args;
324 frame->between_type = between;
325 frame->frame_type = locals;
326 frame->initial_offset = 0;
327 frame->stack_dir = stack_dir;
328 frame->order[1] = between;
331 frame->order[0] = args;
332 frame->order[2] = locals;
335 frame->order[0] = locals;
336 frame->order[2] = args;
341 /** Dumps the stack layout to file. */
342 static void stack_layout_dump(FILE *file, be_stack_layout_t *frame)
346 ir_fprintf(file, "initial offset: %d\n", frame->initial_offset);
347 for (j = 0; j < N_FRAME_TYPES; ++j) {
348 ir_type *t = frame->order[j];
350 ir_fprintf(file, "type %d: %F size: %d\n", j, t, get_type_size_bytes(t));
351 for (i = 0, n = get_compound_n_members(t); i < n; ++i) {
352 entity *ent = get_compound_member(t, i);
353 ir_fprintf(file, "\t%F int ofs: %d glob ofs: %d\n", ent, get_entity_offset_bytes(ent), get_stack_entity_offset(frame, ent, 0));
359 * Returns non-zero if the call argument at given position
360 * is transfered on the stack.
362 static INLINE int is_on_stack(be_abi_call_t *call, int pos)
364 be_abi_call_arg_t *arg = get_call_arg(call, 0, pos);
365 return arg && !arg->in_reg;
375 Adjustment of the calls inside a graph.
380 * Transform a call node.
381 * @param env The ABI environment for the current irg.
382 * @param irn The call node.
383 * @param curr_sp The stack pointer node to use.
384 * @return The stack pointer after the call.
386 static ir_node *adjust_call(be_abi_irg_t *env, ir_node *irn, ir_node *curr_sp)
388 ir_graph *irg = env->birg->irg;
389 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
390 be_abi_call_t *call = be_abi_call_new();
391 ir_type *mt = get_Call_type(irn);
392 ir_node *call_ptr = get_Call_ptr(irn);
393 int n_params = get_method_n_params(mt);
394 ir_node *curr_mem = get_Call_mem(irn);
395 ir_node *bl = get_nodes_block(irn);
396 pset *results = pset_new_ptr(8);
397 pset *caller_save = pset_new_ptr(8);
399 int stack_dir = arch_isa_stack_dir(isa);
400 const arch_register_t *sp = arch_isa_sp(isa);
401 ir_mode *mach_mode = sp->reg_class->mode;
402 struct obstack *obst = &env->obst;
403 ir_node *no_mem = get_irg_no_mem(irg);
404 int no_alloc = call->flags.bits.frame_is_setup_on_call;
406 ir_node *res_proj = NULL;
407 int curr_res_proj = pn_Call_max;
414 const ir_edge_t *edge;
419 /* Let the isa fill out the abi description for that call node. */
420 arch_isa_get_call_abi(isa, mt, call);
422 /* Insert code to put the stack arguments on the stack. */
423 assert(get_Call_n_params(irn) == n_params);
424 for(i = 0; i < n_params; ++i) {
425 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
428 stack_size += arg->space_before;
429 stack_size = round_up2(stack_size, arg->alignment);
430 stack_size += get_type_size_bytes(get_method_param_type(mt, i));
431 stack_size += arg->space_after;
432 obstack_int_grow(obst, i);
436 pos = obstack_finish(obst);
438 /* Collect all arguments which are passed in registers. */
439 for(i = 0, n = get_Call_n_params(irn); i < n; ++i) {
440 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
441 if(arg && arg->in_reg) {
442 obstack_int_grow(obst, i);
446 low_args = obstack_finish(obst);
448 /* If there are some parameters which shall be passed on the stack. */
451 int do_seq = call->flags.bits.store_args_sequential && !no_alloc;
454 * Reverse list of stack parameters if call arguments are from left to right.
455 * We must them reverse again in they are pushed (not stored) and the stack
456 * direction is downwards.
458 if (call->flags.bits.left_to_right ^ (do_seq && stack_dir < 0)) {
459 for(i = 0; i < n_pos >> 1; ++i) {
460 int other = n_pos - i - 1;
468 * If the stack is decreasing and we do not want to store sequentially,
469 * or someone else allocated the call frame
470 * we allocate as much space on the stack all parameters need, by
471 * moving the stack pointer along the stack's direction.
473 if(stack_dir < 0 && !do_seq && !no_alloc) {
474 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, no_mem, stack_size, be_stack_dir_expand);
477 assert(mode_is_reference(mach_mode) && "machine mode must be pointer");
478 for(i = 0; i < n_pos; ++i) {
480 be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
481 ir_node *param = get_Call_param(irn, p);
482 ir_node *addr = curr_sp;
484 ir_type *param_type = get_method_param_type(mt, p);
485 int param_size = get_type_size_bytes(param_type) + arg->space_after;
488 * If we wanted to build the arguments sequentially,
489 * the stack pointer for the next must be incremented,
490 * and the memory value propagated.
494 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, curr_mem,
495 param_size + arg->space_before, be_stack_dir_expand);
498 curr_ofs += arg->space_before;
499 curr_ofs = round_up2(curr_ofs, arg->alignment);
501 /* Make the expression to compute the argument's offset. */
503 addr = new_r_Const_long(irg, bl, mode_Is, curr_ofs);
504 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
508 /* Insert a store for primitive arguments. */
509 if (is_atomic_type(param_type)) {
510 mem = new_r_Store(irg, bl, curr_mem, addr, param);
511 mem = new_r_Proj(irg, bl, mem, mode_M, pn_Store_M);
514 /* Make a mem copy for compound arguments. */
516 assert(mode_is_reference(get_irn_mode(param)));
517 mem = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
518 mem = new_r_Proj(irg, bl, mem, mode_M, pn_CopyB_M_regular);
521 curr_ofs += param_size;
526 obstack_ptr_grow(obst, mem);
529 in = (ir_node **) obstack_finish(obst);
531 /* We need the sync only, if we didn't build the stores sequentially. */
533 curr_mem = new_r_Sync(irg, bl, n_pos, in);
534 obstack_free(obst, in);
537 /* Collect caller save registers */
538 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
540 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
541 for(j = 0; j < cls->n_regs; ++j) {
542 const arch_register_t *reg = arch_register_for_index(cls, j);
543 if(arch_register_type_is(reg, caller_save))
544 pset_insert_ptr(caller_save, (void *) reg);
548 /* search the greatest result proj number */
550 /* TODO: what if the result is NOT used? Currently there is
551 * no way to detect this later, especially there is no way to
552 * see this in the proj numbers.
553 * While this is ok for the register allocator, it is bad for
554 * backends which need to change the be_Call further (x87 simulator
555 * for instance. However for this particular case the call_type is
558 foreach_out_edge(irn, edge) {
559 const ir_edge_t *res_edge;
560 ir_node *irn = get_edge_src_irn(edge);
562 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_T_result) {
564 foreach_out_edge(irn, res_edge) {
566 be_abi_call_arg_t *arg;
567 ir_node *res = get_edge_src_irn(res_edge);
569 assert(is_Proj(res));
571 proj = get_Proj_proj(res);
572 arg = get_call_arg(call, 1, proj);
575 shift the proj number to the right, since we will drop the
576 unspeakable Proj_T from the Call. Therefore, all real argument
577 Proj numbers must be increased by pn_be_Call_first_res
579 proj += pn_be_Call_first_res;
580 set_Proj_proj(res, proj);
581 obstack_ptr_grow(obst, res);
583 if(proj > curr_res_proj)
584 curr_res_proj = proj;
586 pset_remove_ptr(caller_save, arg->reg);
587 //pmap_insert(arg_regs, arg->reg, INT_TO_PTR(proj + 1))
594 obstack_ptr_grow(obst, NULL);
595 res_projs = obstack_finish(obst);
597 /* make the back end call node and set its register requirements. */
598 for(i = 0; i < n_low_args; ++i)
599 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
601 in = obstack_finish(obst);
603 if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
604 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, curr_sp,
605 curr_res_proj + pset_count(caller_save), n_low_args, in,
607 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
611 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, call_ptr,
612 curr_res_proj + pset_count(caller_save), n_low_args, in,
617 Set the register class of the call address to the same as the stack pointer's.
618 That' probably buggy for some architectures.
620 be_node_set_reg_class(low_call, be_pos_Call_ptr, sp->reg_class);
622 DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
624 /* Set the register classes and constraints of the Call parameters. */
625 for(i = 0; i < n_low_args; ++i) {
626 int index = low_args[i];
627 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
628 assert(arg->reg != NULL);
630 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + index, arg->reg);
633 /* Set the register constraints of the results. */
634 for(i = 0; res_projs[i]; ++i) {
635 ir_node *irn = res_projs[i];
636 int proj = get_Proj_proj(irn);
638 /* Correct Proj number since it has been adjusted! (see above) */
639 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
642 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
644 obstack_free(obst, in);
645 exchange(irn, low_call);
647 /* redirect the result projs to the lowered call instead of the Proj_T */
648 for(i = 0; res_projs[i]; ++i)
649 set_Proj_pred(res_projs[i], low_call);
651 /* Make additional projs for the caller save registers
652 and the Keep node which keeps them alive. */
653 if(pset_count(caller_save) > 0) {
654 const arch_register_t *reg;
658 for(reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
659 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
661 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
662 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
663 set_irn_link(proj, (void *) reg);
664 obstack_ptr_grow(obst, proj);
668 in = (ir_node **) obstack_finish(obst);
669 keep = be_new_Keep(NULL, irg, bl, n, in);
670 for(i = 0; i < n; ++i) {
671 const arch_register_t *reg = get_irn_link(in[i]);
672 be_node_set_reg_class(keep, i, reg->reg_class);
674 obstack_free(obst, in);
677 /* Clean up the stack. */
679 ir_node *mem_proj = NULL;
681 foreach_out_edge(low_call, edge) {
682 ir_node *irn = get_edge_src_irn(edge);
683 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
690 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
692 /* Clean up the stack frame if we allocated it */
694 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, mem_proj, stack_size, be_stack_dir_shrink);
697 be_abi_call_free(call);
698 obstack_free(obst, pos);
700 del_pset(caller_save);
707 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
709 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp)
711 if (get_Alloc_where(alloc) == stack_alloc) {
712 ir_node *bl = get_nodes_block(alloc);
713 ir_graph *irg = get_irn_irg(bl);
714 ir_node *alloc_mem = NULL;
715 ir_node *alloc_res = NULL;
717 const ir_edge_t *edge;
720 foreach_out_edge(alloc, edge) {
721 ir_node *irn = get_edge_src_irn(edge);
723 assert(is_Proj(irn));
724 switch(get_Proj_proj(irn)) {
736 /* Beware: currently Alloc nodes without a result might happen,
737 only escape analysis kills them and this phase runs only for object
738 oriented source. We kill the Alloc here. */
739 if (alloc_res == NULL && alloc_mem) {
740 exchange(alloc_mem, get_Alloc_mem(alloc));
744 /* The stack pointer will be modified in an unknown manner.
745 We cannot omit it. */
746 env->call->flags.bits.try_omit_fp = 0;
747 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
749 exchange(alloc, env->isa->stack_dir < 0 ? new_alloc : curr_sp);
751 if(alloc_mem != NULL)
752 set_Proj_proj(alloc_mem, pn_be_AddSP_M);
754 /* fix projnum of alloca res */
755 set_Proj_proj(alloc_res, pn_be_AddSP_res);
763 /* the following function is replaced by the usage of the heights module */
766 * Walker for dependent_on().
767 * This function searches a node tgt recursively from a given node
768 * but is restricted to the given block.
769 * @return 1 if tgt was reachable from curr, 0 if not.
771 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
775 if (get_nodes_block(curr) != bl)
781 /* Phi functions stop the recursion inside a basic block */
782 if (! is_Phi(curr)) {
783 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
784 if (check_dependence(get_irn_n(curr, i), tgt, bl))
794 * Check if a node is somehow data dependent on another one.
795 * both nodes must be in the same basic block.
796 * @param n1 The first node.
797 * @param n2 The second node.
798 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
800 static int dependent_on(ir_node *n1, ir_node *n2)
802 ir_node *bl = get_nodes_block(n1);
804 assert(bl == get_nodes_block(n2));
806 return heights_reachable_in_block(ir_heights, n1, n2);
807 //return check_dependence(n1, n2, bl);
810 static int cmp_call_dependecy(const void *c1, const void *c2)
812 ir_node *n1 = *(ir_node **) c1;
813 ir_node *n2 = *(ir_node **) c2;
816 Classical qsort() comparison function behavior:
817 0 if both elements are equal
818 1 if second is "smaller" that first
819 -1 if first is "smaller" that second
821 if (dependent_on(n1, n2))
824 if (dependent_on(n2, n1))
831 * Walker: links all Call nodes to the Block they are contained.
833 static void link_calls_in_block_walker(ir_node *irn, void *data)
835 if(is_Call(irn) || (get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)) {
836 be_abi_irg_t *env = data;
837 ir_node *bl = get_nodes_block(irn);
838 void *save = get_irn_link(bl);
841 env->call->flags.bits.irg_is_leaf = 0;
843 set_irn_link(irn, save);
844 set_irn_link(bl, irn);
850 * Process all Call nodes inside a basic block.
851 * Note that the link field of the block must contain a linked list of all
852 * Call nodes inside the Block. We first order this list according to data dependency
853 * and that connect the calls together.
855 static void process_calls_in_block(ir_node *bl, void *data)
857 be_abi_irg_t *env = data;
858 ir_node *curr_sp = env->init_sp;
862 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
863 obstack_ptr_grow(&env->obst, irn);
865 /* If there were call nodes in the block. */
871 nodes = obstack_finish(&env->obst);
873 /* order the call nodes according to data dependency */
874 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
876 for(i = n - 1; i >= 0; --i) {
877 ir_node *irn = nodes[i];
879 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
880 switch(get_irn_opcode(irn)) {
882 curr_sp = adjust_call(env, irn, curr_sp);
885 curr_sp = adjust_alloc(env, irn, curr_sp);
892 obstack_free(&env->obst, nodes);
894 /* Keep the last stack state in the block by tying it to Keep node */
896 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
897 pmap_insert(env->keep_map, bl, keep);
900 set_irn_link(bl, curr_sp);
904 * Adjust all call nodes in the graph to the ABI conventions.
906 static void process_calls(be_abi_irg_t *env)
908 ir_graph *irg = env->birg->irg;
910 env->call->flags.bits.irg_is_leaf = 1;
911 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
913 ir_heights = heights_new(env->birg->irg);
914 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
915 heights_free(ir_heights);
918 static void collect_return_walker(ir_node *irn, void *data)
920 if(get_irn_opcode(irn) == iro_Return) {
921 struct obstack *obst = data;
922 obstack_ptr_grow(obst, irn);
927 static ir_node *setup_frame(be_abi_irg_t *env)
929 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
930 const arch_register_t *sp = isa->sp;
931 const arch_register_t *bp = isa->bp;
932 be_abi_call_flags_bits_t flags = env->call->flags.bits;
933 ir_graph *irg = env->birg->irg;
934 ir_node *bl = get_irg_start_block(irg);
935 ir_node *no_mem = get_irg_no_mem(irg);
936 ir_node *old_frame = get_irg_frame(irg);
937 ir_node *stack = pmap_get(env->regs, (void *) sp);
938 ir_node *frame = pmap_get(env->regs, (void *) bp);
940 int stack_nr = get_Proj_proj(stack);
942 if(flags.try_omit_fp) {
943 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE, be_stack_dir_expand);
948 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
950 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
952 be_set_constr_single_reg(frame, -1, bp);
953 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
954 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
957 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE, be_stack_dir_expand);
960 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
961 env->init_sp = stack;
962 set_irg_frame(irg, frame);
963 edges_reroute(old_frame, frame, irg);
968 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
970 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
971 const arch_register_t *sp = isa->sp;
972 const arch_register_t *bp = isa->bp;
973 ir_graph *irg = env->birg->irg;
974 ir_node *ret_mem = get_Return_mem(ret);
975 ir_node *frame = get_irg_frame(irg);
976 ir_node *bl = get_nodes_block(ret);
977 ir_node *stack = get_irn_link(bl);
981 if(env->call->flags.bits.try_omit_fp) {
982 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, BE_STACK_FRAME_SIZE, be_stack_dir_shrink);
986 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
987 be_set_constr_single_reg(stack, -1, sp);
988 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
991 pmap_foreach(env->regs, ent) {
992 const arch_register_t *reg = ent->key;
993 ir_node *irn = ent->value;
996 obstack_ptr_grow(&env->obst, stack);
998 obstack_ptr_grow(&env->obst, frame);
999 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1000 obstack_ptr_grow(obst, irn);
1007 * Computes the stack argument layout type.
1008 * Changes a possibly allocated value param type by moving
1009 * entities to the stack layout type.
1011 * @param env the ABI environment
1012 * @param call the current call ABI
1013 * @param method_type the method type
1015 * @return the stack argument layout type
1017 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type)
1019 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1020 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1021 int n = get_method_n_params(method_type);
1022 int curr = inc > 0 ? 0 : n - 1;
1028 ir_type *val_param_tp = get_method_value_param_type(method_type);
1029 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1031 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1032 for (i = 0; i < n; ++i, curr += inc) {
1033 ir_type *param_type = get_method_param_type(method_type, curr);
1034 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1036 if (arg->on_stack) {
1038 /* the entity was already created, move it to the param type */
1039 arg->stack_ent = get_method_value_param_ent(method_type, i);
1040 remove_struct_member(val_param_tp, arg->stack_ent);
1041 set_entity_owner(arg->stack_ent, res);
1042 add_struct_member(res, arg->stack_ent);
1043 /* must be automatic to set a fixed layout */
1044 set_entity_allocation(arg->stack_ent, allocation_automatic);
1047 snprintf(buf, sizeof(buf), "param_%d", i);
1048 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1050 ofs += arg->space_before;
1051 ofs = round_up2(ofs, arg->alignment);
1052 set_entity_offset_bytes(arg->stack_ent, ofs);
1053 ofs += arg->space_after;
1054 ofs += get_type_size_bytes(param_type);
1057 set_type_size_bytes(res, ofs);
1058 set_type_state(res, layout_fixed);
1062 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1065 struct obstack obst;
1067 obstack_init(&obst);
1069 /* Create a Perm after the RegParams node to delimit it. */
1070 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1071 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1076 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1077 const arch_register_t *reg = &cls->regs[j];
1078 ir_node *irn = pmap_get(regs, (void *) reg);
1080 if(irn && !arch_register_type_is(reg, ignore)) {
1082 obstack_ptr_grow(&obst, irn);
1083 set_irn_link(irn, (void *) reg);
1087 obstack_ptr_grow(&obst, NULL);
1088 in = obstack_finish(&obst);
1090 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1091 for(j = 0; j < n_regs; ++j) {
1092 ir_node *arg = in[j];
1093 arch_register_t *reg = get_irn_link(arg);
1094 pmap_insert(regs, reg, arg);
1095 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1098 obstack_free(&obst, in);
1101 obstack_free(&obst, NULL);
1105 const arch_register_t *reg;
1109 static int cmp_regs(const void *a, const void *b)
1111 const reg_node_map_t *p = a;
1112 const reg_node_map_t *q = b;
1114 if(p->reg->reg_class == q->reg->reg_class)
1115 return p->reg->index - q->reg->index;
1117 return p->reg->reg_class - q->reg->reg_class;
1120 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1123 int n = pmap_count(reg_map);
1125 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1127 pmap_foreach(reg_map, ent) {
1128 res[i].reg = ent->key;
1129 res[i].irn = ent->value;
1133 qsort(res, n, sizeof(res[0]), cmp_regs);
1138 * Creates a barrier.
1140 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1142 ir_graph *irg = env->birg->irg;
1143 int n_regs = pmap_count(regs);
1149 rm = reg_map_to_arr(&env->obst, regs);
1151 for(n = 0; n < n_regs; ++n)
1152 obstack_ptr_grow(&env->obst, rm[n].irn);
1155 obstack_ptr_grow(&env->obst, *mem);
1159 in = (ir_node **) obstack_finish(&env->obst);
1160 irn = be_new_Barrier(irg, bl, n, in);
1161 obstack_free(&env->obst, in);
1163 for(n = 0; n < n_regs; ++n) {
1164 const arch_register_t *reg = rm[n].reg;
1166 int pos = BE_OUT_POS(n);
1169 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1170 be_node_set_reg_class(irn, n, reg->reg_class);
1172 be_set_constr_single_reg(irn, n, reg);
1173 be_set_constr_single_reg(irn, pos, reg);
1174 be_node_set_reg_class(irn, pos, reg->reg_class);
1175 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1177 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1178 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1179 flags |= arch_irn_flags_ignore;
1181 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1182 flags |= arch_irn_flags_modify_sp;
1184 be_node_set_flags(irn, pos, flags);
1186 pmap_insert(regs, (void *) reg, proj);
1190 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1193 obstack_free(&env->obst, rm);
1198 * Creates a be_Return for a Return node.
1200 * @param @env the abi environment
1201 * @param irn the Return node or NULL if there was none
1202 * @param bl the block where the be_Retun should be placed
1203 * @param mem the current memory
1204 * @param n_res number of return results
1206 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1207 be_abi_call_t *call = env->call;
1208 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1210 pmap *reg_map = pmap_create();
1211 ir_node *keep = pmap_get(env->keep_map, bl);
1217 const arch_register_t **regs;
1221 get the valid stack node in this block.
1222 If we had a call in that block there is a Keep constructed by process_calls()
1223 which points to the last stack modification in that block. we'll use
1224 it then. Else we use the stack from the start block and let
1225 the ssa construction fix the usage.
1227 stack = be_abi_reg_map_get(env->regs, isa->sp);
1229 ir_node *bad = new_r_Bad(env->birg->irg);
1230 stack = get_irn_n(keep, 0);
1231 set_nodes_block(keep, bad);
1232 set_irn_n(keep, 0, bad);
1233 // exchange(keep, new_r_Bad(env->birg->irg));
1236 /* Insert results for Return into the register map. */
1237 for(i = 0; i < n_res; ++i) {
1238 ir_node *res = get_Return_res(irn, i);
1239 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1240 assert(arg->in_reg && "return value must be passed in register");
1241 pmap_insert(reg_map, (void *) arg->reg, res);
1244 /* Add uses of the callee save registers. */
1245 pmap_foreach(env->regs, ent) {
1246 const arch_register_t *reg = ent->key;
1247 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1248 pmap_insert(reg_map, ent->key, ent->value);
1251 be_abi_reg_map_set(reg_map, isa->sp, stack);
1253 /* Make the Epilogue node and call the arch's epilogue maker. */
1254 create_barrier(env, bl, &mem, reg_map, 1);
1255 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1258 Maximum size of the in array for Return nodes is
1259 return args + callee save/ignore registers + memory + stack pointer
1261 in_max = pmap_count(reg_map) + n_res + 2;
1263 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1264 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1267 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1272 /* clear SP entry, since it has already been grown. */
1273 pmap_insert(reg_map, (void *) isa->sp, NULL);
1274 for(i = 0; i < n_res; ++i) {
1275 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1277 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1278 regs[n++] = arg->reg;
1280 /* Clear the map entry to mark the register as processed. */
1281 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1284 /* grow the rest of the stuff. */
1285 pmap_foreach(reg_map, ent) {
1288 regs[n++] = ent->key;
1292 /* The in array for the new back end return is now ready. */
1293 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1295 /* Set the register classes of the return's parameter accordingly. */
1296 for(i = 0; i < n; ++i)
1298 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1300 /* Free the space of the Epilog's in array and the register <-> proj map. */
1301 obstack_free(&env->obst, in);
1302 pmap_destroy(reg_map);
1307 typedef struct lower_frame_sels_env_t {
1309 entity *value_param_list; /**< the list of all value param antities */
1310 } lower_frame_sels_env_t;
1313 * Walker: Replaces Sels of frame type and
1314 * value param type entities by FrameAddress.
1316 static void lower_frame_sels_walker(ir_node *irn, void *data)
1318 lower_frame_sels_env_t *ctx = data;
1321 ir_graph *irg = current_ir_graph;
1322 ir_node *frame = get_irg_frame(irg);
1323 ir_node *param_base = get_irg_value_param_base(irg);
1324 ir_node *ptr = get_Sel_ptr(irn);
1326 if (ptr == frame || ptr == param_base) {
1327 be_abi_irg_t *env = ctx->env;
1328 entity *ent = get_Sel_entity(irn);
1329 ir_node *bl = get_nodes_block(irn);
1332 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1335 if (ptr == param_base) {
1336 set_entity_link(ent, ctx->value_param_list);
1337 ctx->value_param_list = ent;
1344 * Check if a value parameter is transmitted as a register.
1345 * This might happen if the address of an parameter is taken which is
1346 * transmitted in registers.
1348 * Note that on some architectures this case must be handled specially
1349 * because the place of the backing store is determined by their ABI.
1351 * In the default case we move the entity to the frame type and create
1352 * a backing store into the first block.
1354 static void fix_address_of_parameter_access(be_abi_irg_t *env, entity *value_param_list) {
1355 be_abi_call_t *call = env->call;
1356 ir_graph *irg = env->birg->irg;
1357 entity *ent, *next_ent, *new_list;
1359 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1362 for (ent = value_param_list; ent; ent = next_ent) {
1363 int i = get_struct_member_index(get_entity_owner(ent), ent);
1364 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1366 next_ent = get_entity_link(ent);
1368 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1369 set_entity_link(ent, new_list);
1374 /* ok, change the graph */
1375 ir_node *start_bl = get_irg_start_block(irg);
1376 ir_node *first_bl = NULL;
1377 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1378 const ir_edge_t *edge;
1379 optimization_state_t state;
1382 foreach_block_succ(start_bl, edge) {
1383 ir_node *succ = get_edge_src_irn(edge);
1384 if (start_bl != succ) {
1390 /* we had already removed critical edges, so the following
1391 assertion should be always true. */
1392 assert(get_Block_n_cfgpreds(first_bl) == 1);
1394 /* now create backing stores */
1395 frame = get_irg_frame(irg);
1396 imem = get_irg_initial_mem(irg);
1398 save_optimization_state(&state);
1400 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1401 restore_optimization_state(&state);
1403 /* reroute all edges to the new memory source */
1404 edges_reroute(imem, nmem, irg);
1408 args = get_irg_args(irg);
1409 args_bl = get_nodes_block(args);
1410 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1411 int i = get_struct_member_index(get_entity_owner(ent), ent);
1412 ir_type *tp = get_entity_type(ent);
1413 ir_mode *mode = get_type_mode(tp);
1416 /* address for the backing store */
1417 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1420 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1422 /* the backing store itself */
1423 store = new_r_Store(irg, first_bl, mem, addr,
1424 new_r_Proj(irg, args_bl, args, mode, i));
1426 /* the new memory Proj gets the last Proj from store */
1427 set_Proj_pred(nmem, store);
1428 set_Proj_proj(nmem, pn_Store_M);
1430 /* move all entities to the frame type */
1431 frame_tp = get_irg_frame_type(irg);
1432 offset = get_type_size_bytes(frame_tp);
1433 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1434 ir_type *tp = get_entity_type(ent);
1435 int align = get_type_alignment_bytes(tp);
1437 offset += align - 1;
1439 set_entity_owner(ent, frame_tp);
1440 add_class_member(frame_tp, ent);
1441 /* must be automatic to set a fixed layout */
1442 set_entity_allocation(ent, allocation_automatic);
1443 set_entity_offset_bytes(ent, offset);
1444 offset += get_type_size_bytes(tp);
1446 set_type_size_bytes(frame_tp, offset);
1451 * Modify the irg itself and the frame type.
1453 static void modify_irg(be_abi_irg_t *env)
1455 be_abi_call_t *call = env->call;
1456 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1457 const arch_register_t *sp = arch_isa_sp(isa);
1458 ir_graph *irg = env->birg->irg;
1459 ir_node *bl = get_irg_start_block(irg);
1460 ir_node *end = get_irg_end_block(irg);
1461 ir_node *no_mem = get_irg_no_mem(irg);
1462 ir_node *mem = get_irg_initial_mem(irg);
1463 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1464 pset *dont_save = pset_new_ptr(8);
1470 const arch_register_t *fp_reg;
1471 ir_node *frame_pointer;
1473 ir_node *reg_params_bl;
1476 const ir_edge_t *edge;
1477 ir_type *arg_type, *bet_type;
1478 lower_frame_sels_env_t ctx;
1480 bitset_t *used_proj_nr;
1481 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1483 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1485 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1487 ctx.value_param_list = NULL;
1488 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1490 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1491 env->regs = pmap_create();
1493 used_proj_nr = bitset_alloca(1024);
1494 n_params = get_method_n_params(method_type);
1495 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1496 memset(args, 0, n_params * sizeof(args[0]));
1498 /* Check if a value parameter is transmitted as a register.
1499 * This might happen if the address of an parameter is taken which is
1500 * transmitted in registers.
1502 * Note that on some architectures this case must be handled specially
1503 * because the place of the backing store is determined by their ABI.
1505 * In the default case we move the entity to the frame type and create
1506 * a backing store into the first block.
1508 fix_address_of_parameter_access(env, ctx.value_param_list);
1510 /* Fill the argument vector */
1511 arg_tuple = get_irg_args(irg);
1512 foreach_out_edge(arg_tuple, edge) {
1513 ir_node *irn = get_edge_src_irn(edge);
1514 int nr = get_Proj_proj(irn);
1516 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1519 arg_type = compute_arg_type(env, call, method_type);
1520 bet_type = call->cb->get_between_type(env->cb);
1521 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir);
1523 /* Count the register params and add them to the number of Projs for the RegParams node */
1524 for(i = 0; i < n_params; ++i) {
1525 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1526 if(arg->in_reg && args[i]) {
1527 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1528 assert(i == get_Proj_proj(args[i]));
1530 /* For now, associate the register with the old Proj from Start representing that argument. */
1531 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1532 bitset_set(used_proj_nr, i);
1533 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1537 /* Collect all callee-save registers */
1538 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1539 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1540 for(j = 0; j < cls->n_regs; ++j) {
1541 const arch_register_t *reg = &cls->regs[j];
1542 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1543 pmap_insert(env->regs, (void *) reg, NULL);
1547 pmap_insert(env->regs, (void *) sp, NULL);
1548 pmap_insert(env->regs, (void *) isa->bp, NULL);
1549 reg_params_bl = get_irg_start_block(irg);
1550 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1553 * make proj nodes for the callee save registers.
1554 * memorize them, since Return nodes get those as inputs.
1556 * Note, that if a register corresponds to an argument, the regs map contains
1557 * the old Proj from start for that argument.
1560 rm = reg_map_to_arr(&env->obst, env->regs);
1561 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1562 arch_register_t *reg = (void *) rm[i].reg;
1563 ir_node *arg_proj = rm[i].irn;
1564 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1566 int pos = BE_OUT_POS((int) nr);
1572 bitset_set(used_proj_nr, nr);
1573 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1574 pmap_insert(env->regs, (void *) reg, proj);
1575 be_set_constr_single_reg(env->reg_params, pos, reg);
1576 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1579 * If the register is an ignore register,
1580 * The Proj for that register shall also be ignored during register allocation.
1582 if(arch_register_type_is(reg, ignore))
1583 flags |= arch_irn_flags_ignore;
1586 flags |= arch_irn_flags_modify_sp;
1588 be_node_set_flags(env->reg_params, pos, flags);
1590 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1592 obstack_free(&env->obst, rm);
1594 /* Generate the Prologue */
1595 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1597 /* do the stack allocation BEFORE the barrier, or spill code
1598 might be added before it */
1599 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1600 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, no_mem, BE_STACK_FRAME_SIZE, be_stack_dir_expand);
1601 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1603 barrier = create_barrier(env, bl, &mem, env->regs, 0);
1605 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1606 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1608 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1609 set_irg_frame(irg, frame_pointer);
1610 pset_insert_ptr(env->ignore_regs, fp_reg);
1612 /* Now, introduce stack param nodes for all parameters passed on the stack */
1613 for(i = 0; i < n_params; ++i) {
1614 ir_node *arg_proj = args[i];
1615 ir_node *repl = NULL;
1617 if(arg_proj != NULL) {
1618 be_abi_call_arg_t *arg;
1619 ir_type *param_type;
1620 int nr = get_Proj_proj(arg_proj);
1622 nr = MIN(nr, n_params);
1623 arg = get_call_arg(call, 0, nr);
1624 param_type = get_method_param_type(method_type, nr);
1627 repl = pmap_get(env->regs, (void *) arg->reg);
1630 else if(arg->on_stack) {
1631 /* For atomic parameters which are actually used, we create a StackParam node. */
1632 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1633 ir_mode *mode = get_type_mode(param_type);
1634 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1635 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1638 /* The stack parameter is not primitive (it is a struct or array),
1639 we thus will create a node representing the parameter's address
1642 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1646 assert(repl != NULL);
1647 edges_reroute(args[i], repl, irg);
1651 /* All Return nodes hang on the End node, so look for them there. */
1652 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1653 ir_node *irn = get_Block_cfgpred(end, i);
1655 if (is_Return(irn)) {
1656 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1660 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1661 the code is dead and will never be executed. */
1663 del_pset(dont_save);
1664 obstack_free(&env->obst, args);
1668 * Walker: puts all Alloc(stack_alloc) on a obstack
1670 static void collect_alloca_walker(ir_node *irn, void *data)
1672 be_abi_irg_t *env = data;
1673 if(get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)
1674 obstack_ptr_grow(&env->obst, irn);
1677 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1679 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1680 ir_node *old_frame = get_irg_frame(birg->irg);
1681 ir_graph *irg = birg->irg;
1685 optimization_state_t state;
1687 obstack_init(&env->obst);
1689 env->isa = birg->main_env->arch_env->isa;
1690 env->method_type = get_entity_type(get_irg_entity(irg));
1691 env->call = be_abi_call_new();
1692 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1694 env->ignore_regs = pset_new_ptr_default();
1695 env->keep_map = pmap_create();
1696 env->dce_survivor = new_survive_dce();
1698 env->stack_phis = pset_new_ptr(16);
1699 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1700 to another Unknown or the stack pointer gets used */
1701 save_optimization_state(&state);
1703 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1704 restore_optimization_state(&state);
1705 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1707 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1709 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1710 env->irn_ops.impl = &abi_irn_ops;
1712 /* Lower all call nodes in the IRG. */
1715 /* Process the IRG */
1718 /* We don't need the keep map anymore. */
1719 pmap_destroy(env->keep_map);
1721 /* reroute the stack origin of the calls to the true stack origin. */
1722 edges_reroute(dummy, env->init_sp, irg);
1723 edges_reroute(old_frame, get_irg_frame(irg), irg);
1725 /* Make some important node pointers survive the dead node elimination. */
1726 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1727 pmap_foreach(env->regs, ent)
1728 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1730 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1732 env->call->cb->done(env->cb);
1736 void be_abi_free(be_abi_irg_t *env)
1738 free_survive_dce(env->dce_survivor);
1739 del_pset(env->stack_phis);
1740 del_pset(env->ignore_regs);
1741 pmap_destroy(env->regs);
1742 obstack_free(&env->obst, NULL);
1743 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1747 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1749 arch_register_t *reg;
1751 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1752 if(reg->reg_class == cls)
1753 bitset_set(bs, reg->index);
1760 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1761 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1762 | _| | |> < ___) | || (_| | (__| <
1763 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1767 struct fix_stack_walker_info {
1769 const arch_env_t *aenv;
1773 * Walker. Collect all stack modifying nodes.
1775 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1777 struct fix_stack_walker_info *info = data;
1779 if(arch_irn_is(info->aenv, irn, modify_sp))
1780 pset_insert_ptr(info->nodes, irn);
1783 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1785 dom_front_info_t *df;
1786 pset *stack_nodes = pset_new_ptr(16);
1787 struct fix_stack_walker_info info;
1789 info.nodes = stack_nodes;
1790 info.aenv = env->birg->main_env->arch_env;
1792 /* We need dominance frontiers for fix up */
1793 df = be_compute_dominance_frontiers(env->birg->irg);
1794 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1795 pset_insert_ptr(stack_nodes, env->init_sp);
1796 be_ssa_constr_set_phis(df, lv, stack_nodes, env->stack_phis);
1797 del_pset(stack_nodes);
1799 /* free these dominance frontiers */
1800 be_free_dominance_frontiers(df);
1804 * Translates a direction of an IncSP node (either be_stack_dir_shrink, or ...expand)
1805 * into -1 or 1, respectively.
1806 * @param irn The node.
1807 * @return 1, if the direction of the IncSP was along, -1 if against.
1809 static int get_dir(ir_node *irn)
1811 return 1 - 2 * (be_get_IncSP_direction(irn) == be_stack_dir_shrink);
1814 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1816 const arch_env_t *aenv = env->birg->main_env->arch_env;
1817 int omit_fp = env->call->flags.bits.try_omit_fp;
1820 sched_foreach(bl, irn) {
1823 If the node modifies the stack pointer by a constant offset,
1824 record that in the bias.
1826 if(be_is_IncSP(irn)) {
1827 int ofs = be_get_IncSP_offset(irn);
1828 int dir = get_dir(irn);
1830 if(ofs == BE_STACK_FRAME_SIZE) {
1831 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1832 be_set_IncSP_offset(irn, ofs);
1840 Else check, if the node relates to an entity on the stack frame.
1841 If so, set the true offset (including the bias) for that
1845 entity *ent = arch_get_frame_entity(aenv, irn);
1847 int offset = get_stack_entity_offset(env->frame, ent, bias);
1848 arch_set_frame_offset(aenv, irn, offset);
1849 DBG((env->dbg, LEVEL_2, "%F has offset %d\n", ent, offset));
1858 * A helper struct for the bias walker.
1861 be_abi_irg_t *env; /**< The ABI irg environment. */
1862 int start_block_bias; /**< The bias at the end of the start block. */
1863 ir_node *start_block; /**< The start block of the current graph. */
1867 * Block-Walker: fix all stack offsets
1869 static void stack_bias_walker(ir_node *bl, void *data)
1871 struct bias_walk *bw = data;
1872 if (bl != bw->start_block) {
1873 process_stack_bias(bw->env, bl, bw->start_block_bias);
1877 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1879 ir_graph *irg = env->birg->irg;
1880 struct bias_walk bw;
1882 stack_frame_compute_initial_offset(env->frame);
1883 // stack_layout_dump(stdout, env->frame);
1885 /* Determine the stack bias at the end of the start block. */
1886 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1888 /* fix the bias is all other blocks */
1890 bw.start_block = get_irg_start_block(irg);
1891 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1894 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1896 assert(arch_register_type_is(reg, callee_save));
1897 assert(pmap_contains(abi->regs, (void *) reg));
1898 return pmap_get(abi->regs, (void *) reg);
1902 _____ _____ _ _ _ _ _ _
1903 |_ _| __ \| \ | | | | | | | | |
1904 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
1905 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
1906 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
1907 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
1909 for Phi nodes which are created due to stack modifying nodes
1910 such as IncSP, AddSP and SetSP.
1912 These Phis are always to be ignored by the reg alloc and are
1913 fixed on the SP register of the ISA.
1916 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
1918 const be_abi_irg_t *abi = get_abi_from_handler(handler);
1919 const void *res = NULL;
1921 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
1922 res = &abi->irn_ops;
1927 static void be_abi_limited(void *data, bitset_t *bs)
1929 be_abi_irg_t *abi = data;
1930 bitset_clear_all(bs);
1931 bitset_set(bs, abi->isa->sp->index);
1934 static const arch_register_req_t *abi_get_irn_reg_req(const void *self, arch_register_req_t *req, const ir_node *irn, int pos)
1936 be_abi_irg_t *abi = get_abi_from_ops(self);
1937 const arch_register_t *reg = abi->isa->sp;
1939 memset(req, 0, sizeof(req[0]));
1941 if(pos == BE_OUT_POS(0)) {
1942 req->cls = reg->reg_class;
1943 req->type = arch_register_req_type_limited;
1944 req->limited = be_abi_limited;
1945 req->limited_env = abi;
1948 else if(pos >= 0 && pos < get_irn_arity(irn)) {
1949 req->cls = reg->reg_class;
1950 req->type = arch_register_req_type_normal;
1956 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
1960 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
1962 const be_abi_irg_t *abi = get_abi_from_ops(self);
1963 return abi->isa->sp;
1966 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
1968 return arch_irn_class_normal;
1971 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
1973 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
1976 static entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
1981 static void abi_set_stack_bias(const void *_self, ir_node *irn, int bias)
1985 static const arch_irn_ops_if_t abi_irn_ops = {
1986 abi_get_irn_reg_req,
1991 abi_get_frame_entity,
1995 static const arch_irn_handler_t abi_irn_handler = {