4 * @author Sebastian Hack
19 #include "irgraph_t.h"
22 #include "iredges_t.h"
25 #include "irprintf_t.h"
37 #include "besched_t.h"
40 typedef struct _be_abi_call_arg_t {
41 unsigned is_res : 1; /**< 1: the call argument is a return value. 0: it's a call parameter. */
42 unsigned in_reg : 1; /**< 1: this argument is transmitted in registers. */
43 unsigned on_stack : 1; /**< 1: this argument is transmitted on the stack. */
46 const arch_register_t *reg;
49 unsigned space_before;
53 struct _be_abi_call_t {
54 be_abi_call_flags_t flags;
55 const be_abi_callbacks_t *cb;
56 ir_type *between_type;
58 const arch_register_class_t *cls_addr;
61 struct _be_abi_irg_t {
63 be_stack_layout_t *frame; /**< The stack frame model. */
64 be_irg_t *birg; /**< The back end IRG. */
65 const arch_isa_t *isa; /**< The isa. */
66 survive_dce_t *dce_survivor;
68 be_abi_call_t *call; /**< The ABI call information. */
69 ir_type *method_type; /**< The type of the method of the IRG. */
71 ir_node *init_sp; /**< The node representing the stack pointer
72 at the start of the function. */
74 ir_node *start_barrier; /**< The barrier of the start block */
76 ir_node *reg_params; /**< The reg params node. */
77 pmap *regs; /**< A map of all callee-save and ignore regs to
78 their Projs to the RegParams node. */
80 pset *stack_phis; /**< The set of all Phi nodes inserted due to
81 stack pointer modifying nodes. */
83 int start_block_bias; /**< The stack bias at the end of the start block. */
85 void *cb; /**< ABI Callback self pointer. */
87 pmap *keep_map; /**< mapping blocks to keep nodes. */
88 pset *ignore_regs; /**< Additional registers which shall be ignored. */
90 arch_irn_handler_t irn_handler;
91 arch_irn_ops_t irn_ops;
92 DEBUG_ONLY(firm_dbg_module_t *dbg;) /**< The debugging module. */
95 #define get_abi_from_handler(ptr) firm_container_of(ptr, be_abi_irg_t, irn_handler)
96 #define get_abi_from_ops(ptr) firm_container_of(ptr, be_abi_irg_t, irn_ops)
98 /* Forward, since be need it in be_abi_introduce(). */
99 static const arch_irn_ops_if_t abi_irn_ops;
100 static const arch_irn_handler_t abi_irn_handler;
101 static heights_t *ir_heights;
103 /* Flag: if set, try to omit the frame pointer if called by the backend */
104 static int be_omit_fp = 1;
107 _ ____ ___ ____ _ _ _ _
108 / \ | __ )_ _| / ___|__ _| | | |__ __ _ ___| | _____
109 / _ \ | _ \| | | | / _` | | | '_ \ / _` |/ __| |/ / __|
110 / ___ \| |_) | | | |__| (_| | | | |_) | (_| | (__| <\__ \
111 /_/ \_\____/___| \____\__,_|_|_|_.__/ \__,_|\___|_|\_\___/
113 These callbacks are used by the backend to set the parameters
114 for a specific call type.
118 * Set compare function: compares two ABI call object arguments.
120 static int cmp_call_arg(const void *a, const void *b, size_t n)
122 const be_abi_call_arg_t *p = a, *q = b;
123 return !(p->is_res == q->is_res && p->pos == q->pos);
127 * Get or set an ABI call object argument.
129 * @param call the abi call
130 * @param is_res true for call results, false for call arguments
131 * @param pos position of the argument
132 * @param do_insert true if the argument is set, false if it's retrieved
134 static be_abi_call_arg_t *get_or_set_call_arg(be_abi_call_t *call, int is_res, int pos, int do_insert)
136 be_abi_call_arg_t arg;
139 memset(&arg, 0, sizeof(arg));
143 hash = is_res * 128 + pos;
146 ? set_insert(call->params, &arg, sizeof(arg), hash)
147 : set_find(call->params, &arg, sizeof(arg), hash);
151 * Retrieve an ABI call object argument.
153 * @param call the ABI call object
154 * @param is_res true for call results, false for call arguments
155 * @param pos position of the argument
157 static INLINE be_abi_call_arg_t *get_call_arg(be_abi_call_t *call, int is_res, int pos)
159 return get_or_set_call_arg(call, is_res, pos, 0);
162 /* Set the flags for a call. */
163 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb)
170 /* Set register class for call address */
171 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls)
173 call->cls_addr = cls;
177 void be_abi_call_param_stack(be_abi_call_t *call, int arg_pos, unsigned alignment, unsigned space_before, unsigned space_after)
179 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
181 arg->alignment = alignment;
182 arg->space_before = space_before;
183 arg->space_after = space_after;
184 assert(alignment > 0 && "Alignment must be greater than 0");
187 void be_abi_call_param_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
189 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
194 void be_abi_call_res_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
196 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 1, arg_pos, 1);
201 /* Get the flags of a ABI call object. */
202 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call)
208 * Constructor for a new ABI call object.
210 * @return the new ABI call object
212 static be_abi_call_t *be_abi_call_new(void)
214 be_abi_call_t *call = xmalloc(sizeof(call[0]));
217 call->params = new_set(cmp_call_arg, 16);
219 call->cls_addr = NULL;
221 call->flags.bits.try_omit_fp = be_omit_fp;
227 * Destructor for an ABI call object.
229 static void be_abi_call_free(be_abi_call_t *call)
231 del_set(call->params);
237 | ___| __ __ _ _ __ ___ ___ | | | | __ _ _ __ __| | (_)_ __ __ _
238 | |_ | '__/ _` | '_ ` _ \ / _ \ | |_| |/ _` | '_ \ / _` | | | '_ \ / _` |
239 | _|| | | (_| | | | | | | __/ | _ | (_| | | | | (_| | | | | | | (_| |
240 |_| |_| \__,_|_| |_| |_|\___| |_| |_|\__,_|_| |_|\__,_|_|_|_| |_|\__, |
243 Handling of the stack frame. It is composed of three types:
244 1) The type of the arguments which are pushed on the stack.
245 2) The "between type" which consists of stuff the call of the
246 function pushes on the stack (like the return address and
247 the old base pointer for ia32).
248 3) The Firm frame type which consists of all local variables
252 static int get_stack_entity_offset(be_stack_layout_t *frame, ir_entity *ent, int bias)
254 ir_type *t = get_entity_owner(ent);
255 int ofs = get_entity_offset(ent);
259 /* Find the type the entity is contained in. */
260 for(index = 0; index < N_FRAME_TYPES; ++index) {
261 if(frame->order[index] == t)
265 /* Add the size of all the types below the one of the entity to the entity's offset */
266 for(i = 0; i < index; ++i)
267 ofs += get_type_size_bytes(frame->order[i]);
269 /* correct the offset by the initial position of the frame pointer */
270 ofs -= frame->initial_offset;
272 /* correct the offset with the current bias. */
279 * Retrieve the entity with given offset from a frame type.
281 static ir_entity *search_ent_with_offset(ir_type *t, int offset)
285 for(i = 0, n = get_compound_n_members(t); i < n; ++i) {
286 ir_entity *ent = get_compound_member(t, i);
287 if(get_entity_offset(ent) == offset)
294 static int stack_frame_compute_initial_offset(be_stack_layout_t *frame)
296 ir_type *base = frame->stack_dir < 0 ? frame->between_type : frame->frame_type;
297 ir_entity *ent = search_ent_with_offset(base, 0);
299 frame->initial_offset = ent ? get_stack_entity_offset(frame, ent, 0) : 0;
301 return frame->initial_offset;
305 * Initializes the frame layout from parts
307 * @param frame the stack layout that will be initialized
308 * @param args the stack argument layout type
309 * @param between the between layout type
310 * @param locals the method frame type
311 * @param stack_dir the stack direction
312 * @param param_map an array mapping method argument positions to the stack argument type
314 * @return the initialized stack layout
316 static be_stack_layout_t *stack_frame_init(be_stack_layout_t *frame, ir_type *args,
317 ir_type *between, ir_type *locals, int stack_dir,
318 ir_entity *param_map[])
320 frame->arg_type = args;
321 frame->between_type = between;
322 frame->frame_type = locals;
323 frame->initial_offset = 0;
324 frame->stack_dir = stack_dir;
325 frame->order[1] = between;
326 frame->param_map = param_map;
329 frame->order[0] = args;
330 frame->order[2] = locals;
333 frame->order[0] = locals;
334 frame->order[2] = args;
340 /** Dumps the stack layout to file. */
341 static void stack_layout_dump(FILE *file, be_stack_layout_t *frame)
345 ir_fprintf(file, "initial offset: %d\n", frame->initial_offset);
346 for (j = 0; j < N_FRAME_TYPES; ++j) {
347 ir_type *t = frame->order[j];
349 ir_fprintf(file, "type %d: %F size: %d\n", j, t, get_type_size_bytes(t));
350 for (i = 0, n = get_compound_n_members(t); i < n; ++i) {
351 ir_entity *ent = get_compound_member(t, i);
352 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, ir_node *alloca_copy)
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 int no_alloc = call->flags.bits.frame_is_setup_on_call;
405 ir_node *res_proj = NULL;
406 int curr_res_proj = pn_Call_max;
413 const ir_edge_t *edge;
418 /* Let the isa fill out the abi description for that call node. */
419 arch_isa_get_call_abi(isa, mt, call);
421 /* Insert code to put the stack arguments on the stack. */
422 assert(get_Call_n_params(irn) == n_params);
423 for(i = 0; i < n_params; ++i) {
424 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
427 int arg_size = get_type_size_bytes(get_method_param_type(mt, i));
429 stack_size += round_up2(arg->space_before, arg->alignment);
430 stack_size += round_up2(arg_size, arg->alignment);
431 stack_size += round_up2(arg->space_after, arg->alignment);
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, stack_size);
476 add_irn_dep(curr_sp, alloca_copy);
482 obstack_ptr_grow(obst, get_Call_mem(irn));
483 curr_mem = new_NoMem();
485 curr_mem = get_Call_mem(irn);
488 assert(mode_is_reference(mach_mode) && "machine mode must be pointer");
489 for(i = 0; i < n_pos; ++i) {
491 be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
492 ir_node *param = get_Call_param(irn, p);
493 ir_node *addr = curr_sp;
495 ir_type *param_type = get_method_param_type(mt, p);
496 int param_size = get_type_size_bytes(param_type) + arg->space_after;
499 * If we wanted to build the arguments sequentially,
500 * the stack pointer for the next must be incremented,
501 * and the memory value propagated.
505 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, param_size + arg->space_before);
507 add_irn_dep(curr_sp, alloca_copy);
510 add_irn_dep(curr_sp, curr_mem);
513 curr_ofs += arg->space_before;
514 curr_ofs = round_up2(curr_ofs, arg->alignment);
516 /* Make the expression to compute the argument's offset. */
518 addr = new_r_Const_long(irg, bl, mode_Is, curr_ofs);
519 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
523 /* Insert a store for primitive arguments. */
524 if (is_atomic_type(param_type)) {
526 store = new_r_Store(irg, bl, curr_mem, addr, param);
527 mem = new_r_Proj(irg, bl, store, mode_M, pn_Store_M);
530 /* Make a mem copy for compound arguments. */
534 assert(mode_is_reference(get_irn_mode(param)));
535 copy = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
536 mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
539 curr_ofs += param_size;
544 obstack_ptr_grow(obst, mem);
547 in = (ir_node **) obstack_finish(obst);
549 /* We need the sync only, if we didn't build the stores sequentially. */
552 curr_mem = new_r_Sync(irg, bl, n_pos + 1, in);
554 curr_mem = get_Call_mem(irn);
557 obstack_free(obst, in);
560 /* Collect caller save registers */
561 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
563 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
564 for(j = 0; j < cls->n_regs; ++j) {
565 const arch_register_t *reg = arch_register_for_index(cls, j);
566 if(arch_register_type_is(reg, caller_save))
567 pset_insert_ptr(caller_save, (void *) reg);
571 /* search the greatest result proj number */
573 /* TODO: what if the result is NOT used? Currently there is
574 * no way to detect this later, especially there is no way to
575 * see this in the proj numbers.
576 * While this is ok for the register allocator, it is bad for
577 * backends which need to change the be_Call further (x87 simulator
578 * for instance. However for this particular case the call_type is
581 foreach_out_edge(irn, edge) {
582 const ir_edge_t *res_edge;
583 ir_node *irn = get_edge_src_irn(edge);
585 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_T_result) {
587 foreach_out_edge(irn, res_edge) {
589 be_abi_call_arg_t *arg;
590 ir_node *res = get_edge_src_irn(res_edge);
592 assert(is_Proj(res));
594 proj = get_Proj_proj(res);
595 arg = get_call_arg(call, 1, proj);
598 shift the proj number to the right, since we will drop the
599 unspeakable Proj_T from the Call. Therefore, all real argument
600 Proj numbers must be increased by pn_be_Call_first_res
602 proj += pn_be_Call_first_res;
603 set_Proj_proj(res, proj);
604 obstack_ptr_grow(obst, res);
606 if(proj > curr_res_proj)
607 curr_res_proj = proj;
609 pset_remove_ptr(caller_save, arg->reg);
610 //pmap_insert(arg_regs, arg->reg, INT_TO_PTR(proj + 1))
617 obstack_ptr_grow(obst, NULL);
618 res_projs = obstack_finish(obst);
620 /* make the back end call node and set its register requirements. */
621 for(i = 0; i < n_low_args; ++i)
622 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
624 in = obstack_finish(obst);
626 if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
627 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, curr_sp,
628 curr_res_proj + pset_count(caller_save), n_low_args, in,
630 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
634 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, call_ptr,
635 curr_res_proj + pset_count(caller_save), n_low_args, in,
639 Set the register class of the call address to the same as the stack pointer's
640 if it's not set by the backend in the abi callback.
642 be_node_set_reg_class(low_call, be_pos_Call_ptr, call->cls_addr ? call->cls_addr : sp->reg_class);
644 /* Set input requirement for stack pointer. */
645 be_node_set_reg_class(low_call, be_pos_Call_sp, arch_get_irn_reg_class(isa->main_env->arch_env, curr_sp, -1));
647 DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
649 /* Set the register classes and constraints of the Call parameters. */
650 for(i = 0; i < n_low_args; ++i) {
651 int index = low_args[i];
652 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
653 assert(arg->reg != NULL);
655 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + index, arg->reg);
658 /* Set the register constraints of the results. */
659 for(i = 0; res_projs[i]; ++i) {
660 ir_node *irn = res_projs[i];
661 int proj = get_Proj_proj(irn);
663 /* Correct Proj number since it has been adjusted! (see above) */
664 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
667 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
669 obstack_free(obst, in);
670 exchange(irn, low_call);
672 /* redirect the result projs to the lowered call instead of the Proj_T */
673 for(i = 0; res_projs[i]; ++i)
674 set_Proj_pred(res_projs[i], low_call);
676 /* Make additional projs for the caller save registers
677 and the Keep node which keeps them alive. */
678 if(pset_count(caller_save) > 0) {
679 const arch_register_t *reg;
683 for(reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
684 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
686 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
687 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
688 set_irn_link(proj, (void *) reg);
689 obstack_ptr_grow(obst, proj);
693 in = (ir_node **) obstack_finish(obst);
694 keep = be_new_Keep(NULL, irg, bl, n, in);
695 for(i = 0; i < n; ++i) {
696 const arch_register_t *reg = get_irn_link(in[i]);
697 be_node_set_reg_class(keep, i, reg->reg_class);
699 obstack_free(obst, in);
702 /* Clean up the stack. */
704 ir_node *mem_proj = NULL;
706 foreach_out_edge(low_call, edge) {
707 ir_node *irn = get_edge_src_irn(edge);
708 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
715 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
716 keep_alive(mem_proj);
719 /* Clean up the stack frame if we allocated it */
721 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
722 add_irn_dep(curr_sp, mem_proj);
724 add_irn_dep(curr_sp, alloca_copy);
730 be_abi_call_free(call);
731 obstack_free(obst, pos);
733 del_pset(caller_save);
740 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
742 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
744 if (get_Alloc_where(alloc) == stack_alloc) {
745 ir_node *bl = get_nodes_block(alloc);
746 ir_graph *irg = get_irn_irg(bl);
747 ir_node *alloc_mem = NULL;
748 ir_node *alloc_res = NULL;
750 const ir_edge_t *edge;
756 foreach_out_edge(alloc, edge) {
757 ir_node *irn = get_edge_src_irn(edge);
759 assert(is_Proj(irn));
760 switch(get_Proj_proj(irn)) {
772 /* Beware: currently Alloc nodes without a result might happen,
773 only escape analysis kills them and this phase runs only for object
774 oriented source. We kill the Alloc here. */
775 if (alloc_res == NULL && alloc_mem) {
776 exchange(alloc_mem, get_Alloc_mem(alloc));
780 /* The stack pointer will be modified in an unknown manner.
781 We cannot omit it. */
782 env->call->flags.bits.try_omit_fp = 0;
783 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
785 if(alloc_mem != NULL) {
789 addsp_mem = new_r_Proj(irg, bl, new_alloc, mode_M, pn_be_AddSP_M);
791 // We need to sync the output mem of the AddSP with the input mem
792 // edge into the alloc node
793 ins[0] = get_Alloc_mem(alloc);
795 sync = new_r_Sync(irg, bl, 2, ins);
797 exchange(alloc_mem, sync);
800 exchange(alloc, new_alloc);
802 /* fix projnum of alloca res */
803 set_Proj_proj(alloc_res, pn_be_AddSP_res);
805 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
807 /* copy the address away, since it could be used after further stack pointer modifications. */
808 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
809 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, bl, curr_sp);
811 /* Let all users of the Alloc() result now point to the copy. */
812 edges_reroute(alloc_res, copy, irg);
814 /* Rewire the copy appropriately. */
815 set_irn_n(copy, be_pos_Copy_op, addr);
824 * The Free is transformed into a back end free node and connected to the stack nodes.
826 static ir_node *adjust_free(be_abi_irg_t *env, ir_node *free, ir_node *curr_sp)
828 if (get_Free_where(free) == stack_alloc) {
829 ir_node *bl = get_nodes_block(free);
830 ir_graph *irg = get_irn_irg(bl);
831 ir_node *addsp, *mem, *res;
833 /* The stack pointer will be modified in an unknown manner.
834 We cannot omit it. */
835 env->call->flags.bits.try_omit_fp = 0;
836 addsp = be_new_SubSP(env->isa->sp, irg, bl, curr_sp, get_Free_size(free));
838 mem = new_r_Proj(irg, bl, addsp, mode_M, pn_be_SubSP_M);
839 res = new_r_Proj(irg, bl, addsp, mode_P_data, pn_be_SubSP_res);
847 /* the following function is replaced by the usage of the heights module */
850 * Walker for dependent_on().
851 * This function searches a node tgt recursively from a given node
852 * but is restricted to the given block.
853 * @return 1 if tgt was reachable from curr, 0 if not.
855 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
859 if (get_nodes_block(curr) != bl)
865 /* Phi functions stop the recursion inside a basic block */
866 if (! is_Phi(curr)) {
867 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
868 if (check_dependence(get_irn_n(curr, i), tgt, bl))
878 * Check if a node is somehow data dependent on another one.
879 * both nodes must be in the same basic block.
880 * @param n1 The first node.
881 * @param n2 The second node.
882 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
884 static int dependent_on(ir_node *n1, ir_node *n2)
886 ir_node *bl = get_nodes_block(n1);
888 assert(bl == get_nodes_block(n2));
890 return heights_reachable_in_block(ir_heights, n1, n2);
891 //return check_dependence(n1, n2, bl);
894 static int cmp_call_dependecy(const void *c1, const void *c2)
896 ir_node *n1 = *(ir_node **) c1;
897 ir_node *n2 = *(ir_node **) c2;
900 Classical qsort() comparison function behavior:
901 0 if both elements are equal
902 1 if second is "smaller" that first
903 -1 if first is "smaller" that second
905 if (dependent_on(n1, n2))
908 if (dependent_on(n2, n1))
915 * Walker: links all Call/alloc/Free nodes to the Block they are contained.
917 static void link_calls_in_block_walker(ir_node *irn, void *data)
919 opcode code = get_irn_opcode(irn);
921 if (code == iro_Call ||
922 (code == iro_Alloc && get_Alloc_where(irn) == stack_alloc) ||
923 (code == iro_Free && get_Free_where(irn) == stack_alloc)) {
924 be_abi_irg_t *env = data;
925 ir_node *bl = get_nodes_block(irn);
926 void *save = get_irn_link(bl);
928 if (code == iro_Call)
929 env->call->flags.bits.irg_is_leaf = 0;
931 set_irn_link(irn, save);
932 set_irn_link(bl, irn);
938 * Process all Call nodes inside a basic block.
939 * Note that the link field of the block must contain a linked list of all
940 * Call nodes inside the Block. We first order this list according to data dependency
941 * and that connect the calls together.
943 static void process_calls_in_block(ir_node *bl, void *data)
945 be_abi_irg_t *env = data;
946 ir_node *curr_sp = env->init_sp;
950 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
951 obstack_ptr_grow(&env->obst, irn);
953 /* If there were call nodes in the block. */
957 ir_node *copy = NULL;
960 nodes = obstack_finish(&env->obst);
962 /* order the call nodes according to data dependency */
963 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
965 for(i = n - 1; i >= 0; --i) {
966 ir_node *irn = nodes[i];
968 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
969 switch(get_irn_opcode(irn)) {
971 curr_sp = adjust_call(env, irn, curr_sp, copy);
974 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
977 curr_sp = adjust_free(env, irn, curr_sp);
984 obstack_free(&env->obst, nodes);
986 /* Keep the last stack state in the block by tying it to Keep node */
988 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
989 pmap_insert(env->keep_map, bl, keep);
992 set_irn_link(bl, curr_sp);
993 } /* process_calls_in_block */
996 * Adjust all call nodes in the graph to the ABI conventions.
998 static void process_calls(be_abi_irg_t *env)
1000 ir_graph *irg = env->birg->irg;
1002 env->call->flags.bits.irg_is_leaf = 1;
1003 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
1005 ir_heights = heights_new(env->birg->irg);
1006 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
1007 heights_free(ir_heights);
1011 static ir_node *setup_frame(be_abi_irg_t *env)
1013 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1014 const arch_register_t *sp = isa->sp;
1015 const arch_register_t *bp = isa->bp;
1016 be_abi_call_flags_bits_t flags = env->call->flags.bits;
1017 ir_graph *irg = env->birg->irg;
1018 ir_node *bl = get_irg_start_block(irg);
1019 ir_node *no_mem = get_irg_no_mem(irg);
1020 ir_node *old_frame = get_irg_frame(irg);
1021 ir_node *stack = pmap_get(env->regs, (void *) sp);
1022 ir_node *frame = pmap_get(env->regs, (void *) bp);
1024 int stack_nr = get_Proj_proj(stack);
1026 if(flags.try_omit_fp) {
1027 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
1032 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
1034 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
1035 if(!flags.fp_free) {
1036 be_set_constr_single_reg(frame, -1, bp);
1037 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
1038 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
1041 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
1044 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
1045 env->init_sp = stack;
1046 set_irg_frame(irg, frame);
1047 edges_reroute(old_frame, frame, irg);
1052 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1054 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1055 const arch_register_t *sp = isa->sp;
1056 const arch_register_t *bp = isa->bp;
1057 ir_graph *irg = env->birg->irg;
1058 ir_node *ret_mem = get_Return_mem(ret);
1059 ir_node *frame = get_irg_frame(irg);
1060 ir_node *bl = get_nodes_block(ret);
1061 ir_node *stack = get_irn_link(bl);
1065 if(env->call->flags.bits.try_omit_fp) {
1066 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1070 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1071 be_set_constr_single_reg(stack, -1, sp);
1072 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1075 pmap_foreach(env->regs, ent) {
1076 const arch_register_t *reg = ent->key;
1077 ir_node *irn = ent->value;
1080 obstack_ptr_grow(&env->obst, stack);
1082 obstack_ptr_grow(&env->obst, frame);
1083 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1084 obstack_ptr_grow(obst, irn);
1091 * Computes the stack argument layout type.
1092 * Changes a possibly allocated value param type by moving
1093 * entities to the stack layout type.
1095 * @param env the ABI environment
1096 * @param call the current call ABI
1097 * @param method_type the method type
1098 * @param param_map an array mapping method arguments to the stack layout type
1100 * @return the stack argument layout type
1102 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type, ir_entity ***param_map)
1104 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1105 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1106 int n = get_method_n_params(method_type);
1107 int curr = inc > 0 ? 0 : n - 1;
1113 ir_type *val_param_tp = get_method_value_param_type(method_type);
1114 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1117 *param_map = map = obstack_alloc(&env->obst, n * sizeof(ir_entity *));
1118 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1119 for (i = 0; i < n; ++i, curr += inc) {
1120 ir_type *param_type = get_method_param_type(method_type, curr);
1121 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1124 if (arg->on_stack) {
1126 /* the entity was already created, move it to the param type */
1127 arg->stack_ent = get_method_value_param_ent(method_type, i);
1128 remove_struct_member(val_param_tp, arg->stack_ent);
1129 set_entity_owner(arg->stack_ent, res);
1130 add_struct_member(res, arg->stack_ent);
1131 /* must be automatic to set a fixed layout */
1132 set_entity_allocation(arg->stack_ent, allocation_automatic);
1135 snprintf(buf, sizeof(buf), "param_%d", i);
1136 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1138 ofs += arg->space_before;
1139 ofs = round_up2(ofs, arg->alignment);
1140 set_entity_offset(arg->stack_ent, ofs);
1141 ofs += arg->space_after;
1142 ofs += get_type_size_bytes(param_type);
1143 map[i] = arg->stack_ent;
1146 set_type_size_bytes(res, ofs);
1147 set_type_state(res, layout_fixed);
1152 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1155 struct obstack obst;
1157 obstack_init(&obst);
1159 /* Create a Perm after the RegParams node to delimit it. */
1160 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1161 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1166 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1167 const arch_register_t *reg = &cls->regs[j];
1168 ir_node *irn = pmap_get(regs, (void *) reg);
1170 if(irn && !arch_register_type_is(reg, ignore)) {
1172 obstack_ptr_grow(&obst, irn);
1173 set_irn_link(irn, (void *) reg);
1177 obstack_ptr_grow(&obst, NULL);
1178 in = obstack_finish(&obst);
1180 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1181 for(j = 0; j < n_regs; ++j) {
1182 ir_node *arg = in[j];
1183 arch_register_t *reg = get_irn_link(arg);
1184 pmap_insert(regs, reg, arg);
1185 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1188 obstack_free(&obst, in);
1191 obstack_free(&obst, NULL);
1196 const arch_register_t *reg;
1200 static int cmp_regs(const void *a, const void *b)
1202 const reg_node_map_t *p = a;
1203 const reg_node_map_t *q = b;
1205 if(p->reg->reg_class == q->reg->reg_class)
1206 return p->reg->index - q->reg->index;
1208 return p->reg->reg_class - q->reg->reg_class;
1211 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1214 int n = pmap_count(reg_map);
1216 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1218 pmap_foreach(reg_map, ent) {
1219 res[i].reg = ent->key;
1220 res[i].irn = ent->value;
1224 qsort(res, n, sizeof(res[0]), cmp_regs);
1229 * Creates a barrier.
1231 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1233 ir_graph *irg = env->birg->irg;
1234 int n_regs = pmap_count(regs);
1240 rm = reg_map_to_arr(&env->obst, regs);
1242 for(n = 0; n < n_regs; ++n)
1243 obstack_ptr_grow(&env->obst, rm[n].irn);
1246 obstack_ptr_grow(&env->obst, *mem);
1250 in = (ir_node **) obstack_finish(&env->obst);
1251 irn = be_new_Barrier(irg, bl, n, in);
1252 obstack_free(&env->obst, in);
1254 for(n = 0; n < n_regs; ++n) {
1255 const arch_register_t *reg = rm[n].reg;
1257 int pos = BE_OUT_POS(n);
1260 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1261 be_node_set_reg_class(irn, n, reg->reg_class);
1263 be_set_constr_single_reg(irn, n, reg);
1264 be_set_constr_single_reg(irn, pos, reg);
1265 be_node_set_reg_class(irn, pos, reg->reg_class);
1266 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1268 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1269 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1270 flags |= arch_irn_flags_ignore;
1272 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1273 flags |= arch_irn_flags_modify_sp;
1275 be_node_set_flags(irn, pos, flags);
1277 pmap_insert(regs, (void *) reg, proj);
1281 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1284 obstack_free(&env->obst, rm);
1289 * Creates a be_Return for a Return node.
1291 * @param @env the abi environment
1292 * @param irn the Return node or NULL if there was none
1293 * @param bl the block where the be_Retun should be placed
1294 * @param mem the current memory
1295 * @param n_res number of return results
1297 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1298 be_abi_call_t *call = env->call;
1299 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1301 pmap *reg_map = pmap_create();
1302 ir_node *keep = pmap_get(env->keep_map, bl);
1308 const arch_register_t **regs;
1312 get the valid stack node in this block.
1313 If we had a call in that block there is a Keep constructed by process_calls()
1314 which points to the last stack modification in that block. we'll use
1315 it then. Else we use the stack from the start block and let
1316 the ssa construction fix the usage.
1318 stack = be_abi_reg_map_get(env->regs, isa->sp);
1320 ir_node *bad = new_r_Bad(env->birg->irg);
1321 stack = get_irn_n(keep, 0);
1322 set_nodes_block(keep, bad);
1323 set_irn_n(keep, 0, bad);
1324 // exchange(keep, new_r_Bad(env->birg->irg));
1327 /* Insert results for Return into the register map. */
1328 for(i = 0; i < n_res; ++i) {
1329 ir_node *res = get_Return_res(irn, i);
1330 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1331 assert(arg->in_reg && "return value must be passed in register");
1332 pmap_insert(reg_map, (void *) arg->reg, res);
1335 /* Add uses of the callee save registers. */
1336 pmap_foreach(env->regs, ent) {
1337 const arch_register_t *reg = ent->key;
1338 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1339 pmap_insert(reg_map, ent->key, ent->value);
1342 be_abi_reg_map_set(reg_map, isa->sp, stack);
1344 /* Make the Epilogue node and call the arch's epilogue maker. */
1345 create_barrier(env, bl, &mem, reg_map, 1);
1346 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1349 Maximum size of the in array for Return nodes is
1350 return args + callee save/ignore registers + memory + stack pointer
1352 in_max = pmap_count(reg_map) + n_res + 2;
1354 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1355 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1358 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1363 /* clear SP entry, since it has already been grown. */
1364 pmap_insert(reg_map, (void *) isa->sp, NULL);
1365 for(i = 0; i < n_res; ++i) {
1366 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1368 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1369 regs[n++] = arg->reg;
1371 /* Clear the map entry to mark the register as processed. */
1372 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1375 /* grow the rest of the stuff. */
1376 pmap_foreach(reg_map, ent) {
1379 regs[n++] = ent->key;
1383 /* The in array for the new back end return is now ready. */
1384 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1386 /* Set the register classes of the return's parameter accordingly. */
1387 for(i = 0; i < n; ++i)
1389 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1391 /* Free the space of the Epilog's in array and the register <-> proj map. */
1392 obstack_free(&env->obst, in);
1393 pmap_destroy(reg_map);
1398 typedef struct lower_frame_sels_env_t {
1400 ir_entity *value_param_list; /**< the list of all value param entities */
1401 } lower_frame_sels_env_t;
1404 * Walker: Replaces Sels of frame type and
1405 * value param type entities by FrameAddress.
1407 static void lower_frame_sels_walker(ir_node *irn, void *data)
1409 lower_frame_sels_env_t *ctx = data;
1412 ir_graph *irg = current_ir_graph;
1413 ir_node *frame = get_irg_frame(irg);
1414 ir_node *param_base = get_irg_value_param_base(irg);
1415 ir_node *ptr = get_Sel_ptr(irn);
1417 if (ptr == frame || ptr == param_base) {
1418 be_abi_irg_t *env = ctx->env;
1419 ir_entity *ent = get_Sel_entity(irn);
1420 ir_node *bl = get_nodes_block(irn);
1423 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1426 /* check, if it's a param sel and if have not seen this entity immediatly before */
1427 if (ptr == param_base && ctx->value_param_list != ent) {
1428 set_entity_link(ent, ctx->value_param_list);
1429 ctx->value_param_list = ent;
1436 * Check if a value parameter is transmitted as a register.
1437 * This might happen if the address of an parameter is taken which is
1438 * transmitted in registers.
1440 * Note that on some architectures this case must be handled specially
1441 * because the place of the backing store is determined by their ABI.
1443 * In the default case we move the entity to the frame type and create
1444 * a backing store into the first block.
1446 static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_param_list) {
1447 be_abi_call_t *call = env->call;
1448 ir_graph *irg = env->birg->irg;
1449 ir_entity *ent, *next_ent, *new_list;
1451 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1454 for (ent = value_param_list; ent; ent = next_ent) {
1455 int i = get_struct_member_index(get_entity_owner(ent), ent);
1456 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1458 next_ent = get_entity_link(ent);
1460 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1461 set_entity_link(ent, new_list);
1466 /* ok, change the graph */
1467 ir_node *start_bl = get_irg_start_block(irg);
1468 ir_node *first_bl = NULL;
1469 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1470 const ir_edge_t *edge;
1471 optimization_state_t state;
1474 foreach_block_succ(start_bl, edge) {
1475 ir_node *succ = get_edge_src_irn(edge);
1476 if (start_bl != succ) {
1482 /* we had already removed critical edges, so the following
1483 assertion should be always true. */
1484 assert(get_Block_n_cfgpreds(first_bl) == 1);
1486 /* now create backing stores */
1487 frame = get_irg_frame(irg);
1488 imem = get_irg_initial_mem(irg);
1490 save_optimization_state(&state);
1492 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1493 restore_optimization_state(&state);
1495 /* reroute all edges to the new memory source */
1496 edges_reroute(imem, nmem, irg);
1500 args = get_irg_args(irg);
1501 args_bl = get_nodes_block(args);
1502 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1503 int i = get_struct_member_index(get_entity_owner(ent), ent);
1504 ir_type *tp = get_entity_type(ent);
1505 ir_mode *mode = get_type_mode(tp);
1508 /* address for the backing store */
1509 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1512 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1514 /* the backing store itself */
1515 store = new_r_Store(irg, first_bl, mem, addr,
1516 new_r_Proj(irg, args_bl, args, mode, i));
1518 /* the new memory Proj gets the last Proj from store */
1519 set_Proj_pred(nmem, store);
1520 set_Proj_proj(nmem, pn_Store_M);
1522 /* move all entities to the frame type */
1523 frame_tp = get_irg_frame_type(irg);
1524 offset = get_type_size_bytes(frame_tp);
1525 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1526 ir_type *tp = get_entity_type(ent);
1527 int align = get_type_alignment_bytes(tp);
1529 offset += align - 1;
1531 set_entity_owner(ent, frame_tp);
1532 add_class_member(frame_tp, ent);
1533 /* must be automatic to set a fixed layout */
1534 set_entity_allocation(ent, allocation_automatic);
1535 set_entity_offset(ent, offset);
1536 offset += get_type_size_bytes(tp);
1538 set_type_size_bytes(frame_tp, offset);
1543 * Modify the irg itself and the frame type.
1545 static void modify_irg(be_abi_irg_t *env)
1547 be_abi_call_t *call = env->call;
1548 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1549 const arch_register_t *sp = arch_isa_sp(isa);
1550 ir_graph *irg = env->birg->irg;
1551 ir_node *bl = get_irg_start_block(irg);
1552 ir_node *end = get_irg_end_block(irg);
1553 ir_node *mem = get_irg_initial_mem(irg);
1554 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1555 pset *dont_save = pset_new_ptr(8);
1561 const arch_register_t *fp_reg;
1562 ir_node *frame_pointer;
1564 ir_node *reg_params_bl;
1567 const ir_edge_t *edge;
1568 ir_type *arg_type, *bet_type;
1569 lower_frame_sels_env_t ctx;
1570 ir_entity **param_map;
1572 bitset_t *used_proj_nr;
1573 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1575 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1577 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1579 ctx.value_param_list = NULL;
1580 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1582 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1583 env->regs = pmap_create();
1585 used_proj_nr = bitset_alloca(1024);
1586 n_params = get_method_n_params(method_type);
1587 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1588 memset(args, 0, n_params * sizeof(args[0]));
1590 /* Check if a value parameter is transmitted as a register.
1591 * This might happen if the address of an parameter is taken which is
1592 * transmitted in registers.
1594 * Note that on some architectures this case must be handled specially
1595 * because the place of the backing store is determined by their ABI.
1597 * In the default case we move the entity to the frame type and create
1598 * a backing store into the first block.
1600 fix_address_of_parameter_access(env, ctx.value_param_list);
1602 /* Fill the argument vector */
1603 arg_tuple = get_irg_args(irg);
1604 foreach_out_edge(arg_tuple, edge) {
1605 ir_node *irn = get_edge_src_irn(edge);
1606 int nr = get_Proj_proj(irn);
1608 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1611 arg_type = compute_arg_type(env, call, method_type, ¶m_map);
1612 bet_type = call->cb->get_between_type(env->cb);
1613 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir, param_map);
1615 /* Count the register params and add them to the number of Projs for the RegParams node */
1616 for(i = 0; i < n_params; ++i) {
1617 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1618 if(arg->in_reg && args[i]) {
1619 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1620 assert(i == get_Proj_proj(args[i]));
1622 /* For now, associate the register with the old Proj from Start representing that argument. */
1623 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1624 bitset_set(used_proj_nr, i);
1625 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1629 /* Collect all callee-save registers */
1630 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1631 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1632 for(j = 0; j < cls->n_regs; ++j) {
1633 const arch_register_t *reg = &cls->regs[j];
1634 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1635 pmap_insert(env->regs, (void *) reg, NULL);
1639 pmap_insert(env->regs, (void *) sp, NULL);
1640 pmap_insert(env->regs, (void *) isa->bp, NULL);
1641 reg_params_bl = get_irg_start_block(irg);
1642 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1643 add_irn_dep(env->reg_params, get_irg_start(irg));
1646 * make proj nodes for the callee save registers.
1647 * memorize them, since Return nodes get those as inputs.
1649 * Note, that if a register corresponds to an argument, the regs map contains
1650 * the old Proj from start for that argument.
1653 rm = reg_map_to_arr(&env->obst, env->regs);
1654 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1655 arch_register_t *reg = (void *) rm[i].reg;
1656 ir_node *arg_proj = rm[i].irn;
1657 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1659 int pos = BE_OUT_POS((int) nr);
1665 bitset_set(used_proj_nr, nr);
1666 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1667 pmap_insert(env->regs, (void *) reg, proj);
1668 be_set_constr_single_reg(env->reg_params, pos, reg);
1669 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1672 * If the register is an ignore register,
1673 * The Proj for that register shall also be ignored during register allocation.
1675 if(arch_register_type_is(reg, ignore))
1676 flags |= arch_irn_flags_ignore;
1679 flags |= arch_irn_flags_modify_sp;
1681 be_node_set_flags(env->reg_params, pos, flags);
1683 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1685 obstack_free(&env->obst, rm);
1687 /* Generate the Prologue */
1688 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1690 /* do the stack allocation BEFORE the barrier, or spill code
1691 might be added before it */
1692 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1693 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1694 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1696 env->start_barrier = barrier = create_barrier(env, bl, &mem, env->regs, 0);
1698 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1699 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1701 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1702 set_irg_frame(irg, frame_pointer);
1703 pset_insert_ptr(env->ignore_regs, fp_reg);
1705 /* Now, introduce stack param nodes for all parameters passed on the stack */
1706 for(i = 0; i < n_params; ++i) {
1707 ir_node *arg_proj = args[i];
1708 ir_node *repl = NULL;
1710 if(arg_proj != NULL) {
1711 be_abi_call_arg_t *arg;
1712 ir_type *param_type;
1713 int nr = get_Proj_proj(arg_proj);
1715 nr = MIN(nr, n_params);
1716 arg = get_call_arg(call, 0, nr);
1717 param_type = get_method_param_type(method_type, nr);
1720 repl = pmap_get(env->regs, (void *) arg->reg);
1723 else if(arg->on_stack) {
1724 /* For atomic parameters which are actually used, we create a StackParam node. */
1725 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1726 ir_mode *mode = get_type_mode(param_type);
1727 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1728 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1731 /* The stack parameter is not primitive (it is a struct or array),
1732 we thus will create a node representing the parameter's address
1735 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1739 assert(repl != NULL);
1740 edges_reroute(args[i], repl, irg);
1744 /* All Return nodes hang on the End node, so look for them there. */
1745 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1746 ir_node *irn = get_Block_cfgpred(end, i);
1748 if (is_Return(irn)) {
1749 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1753 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1754 the code is dead and will never be executed. */
1756 del_pset(dont_save);
1757 obstack_free(&env->obst, args);
1760 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1762 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1763 ir_node *old_frame = get_irg_frame(birg->irg);
1764 ir_graph *irg = birg->irg;
1768 optimization_state_t state;
1770 be_omit_fp = birg->main_env->options->omit_fp;
1772 obstack_init(&env->obst);
1774 env->isa = birg->main_env->arch_env->isa;
1775 env->method_type = get_entity_type(get_irg_entity(irg));
1776 env->call = be_abi_call_new();
1777 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1779 env->ignore_regs = pset_new_ptr_default();
1780 env->keep_map = pmap_create();
1781 env->dce_survivor = new_survive_dce();
1783 env->stack_phis = pset_new_ptr(16);
1784 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1785 to another Unknown or the stack pointer gets used */
1786 save_optimization_state(&state);
1788 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1789 restore_optimization_state(&state);
1790 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1792 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1793 env->irn_ops.impl = &abi_irn_ops;
1795 /* Lower all call nodes in the IRG. */
1799 Beware: init backend abi call object after processing calls,
1800 otherwise some information might be not yet available.
1802 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1804 /* Process the IRG */
1807 /* We don't need the keep map anymore. */
1808 pmap_destroy(env->keep_map);
1810 /* reroute the stack origin of the calls to the true stack origin. */
1811 edges_reroute(dummy, env->init_sp, irg);
1812 edges_reroute(old_frame, get_irg_frame(irg), irg);
1814 /* Make some important node pointers survive the dead node elimination. */
1815 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1816 pmap_foreach(env->regs, ent)
1817 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1819 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1821 env->call->cb->done(env->cb);
1826 void be_abi_free(be_abi_irg_t *env)
1828 free_survive_dce(env->dce_survivor);
1829 del_pset(env->stack_phis);
1830 del_pset(env->ignore_regs);
1831 pmap_destroy(env->regs);
1832 obstack_free(&env->obst, NULL);
1833 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1837 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1839 arch_register_t *reg;
1841 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1842 if(reg->reg_class == cls)
1843 bitset_set(bs, reg->index);
1846 /* Returns the stack layout from a abi environment. */
1847 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi) {
1854 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1855 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1856 | _| | |> < ___) | || (_| | (__| <
1857 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1861 struct fix_stack_walker_info {
1863 const arch_env_t *aenv;
1867 * Walker. Collect all stack modifying nodes.
1869 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1871 struct fix_stack_walker_info *info = data;
1876 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1877 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1878 pset_insert_ptr(info->nodes, irn);
1882 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1884 pset *stack_nodes = pset_new_ptr(16);
1885 struct fix_stack_walker_info info;
1887 info.nodes = stack_nodes;
1888 info.aenv = env->birg->main_env->arch_env;
1890 be_assure_dom_front(env->birg);
1892 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1893 pset_insert_ptr(stack_nodes, env->init_sp);
1894 be_ssa_constr_set_phis(env->birg->dom_front, lv, stack_nodes, env->stack_phis);
1895 del_pset(stack_nodes);
1898 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1900 const arch_env_t *arch_env = env->birg->main_env->arch_env;
1901 int omit_fp = env->call->flags.bits.try_omit_fp;
1904 sched_foreach(bl, irn) {
1907 Check, if the node relates to an entity on the stack frame.
1908 If so, set the true offset (including the bias) for that
1911 ir_entity *ent = arch_get_frame_entity(arch_env, irn);
1913 int offset = get_stack_entity_offset(env->frame, ent, bias);
1914 arch_set_frame_offset(arch_env, irn, offset);
1915 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
1919 If the node modifies the stack pointer by a constant offset,
1920 record that in the bias.
1922 if(arch_irn_is(arch_env, irn, modify_sp)) {
1923 int ofs = arch_get_sp_bias(arch_env, irn);
1925 if(be_is_IncSP(irn)) {
1926 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
1927 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1928 be_set_IncSP_offset(irn, ofs);
1929 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
1930 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1931 be_set_IncSP_offset(irn, ofs);
1944 * A helper struct for the bias walker.
1947 be_abi_irg_t *env; /**< The ABI irg environment. */
1948 int start_block_bias; /**< The bias at the end of the start block. */
1949 ir_node *start_block; /**< The start block of the current graph. */
1953 * Block-Walker: fix all stack offsets
1955 static void stack_bias_walker(ir_node *bl, void *data)
1957 struct bias_walk *bw = data;
1958 if (bl != bw->start_block) {
1959 process_stack_bias(bw->env, bl, bw->start_block_bias);
1963 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1965 ir_graph *irg = env->birg->irg;
1966 struct bias_walk bw;
1968 stack_frame_compute_initial_offset(env->frame);
1969 // stack_layout_dump(stdout, env->frame);
1971 /* Determine the stack bias at the end of the start block. */
1972 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1974 /* fix the bias is all other blocks */
1976 bw.start_block = get_irg_start_block(irg);
1977 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1980 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1982 assert(arch_register_type_is(reg, callee_save));
1983 assert(pmap_contains(abi->regs, (void *) reg));
1984 return pmap_get(abi->regs, (void *) reg);
1987 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1989 assert(arch_register_type_is(reg, ignore));
1990 assert(pmap_contains(abi->regs, (void *) reg));
1991 return pmap_get(abi->regs, (void *) reg);
1994 ir_node *be_abi_get_start_barrier(be_abi_irg_t *abi)
1996 return abi->start_barrier;
2000 _____ _____ _ _ _ _ _ _
2001 |_ _| __ \| \ | | | | | | | | |
2002 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
2003 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
2004 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
2005 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
2007 for Phi nodes which are created due to stack modifying nodes
2008 such as IncSP, AddSP and SetSP.
2010 These Phis are always to be ignored by the reg alloc and are
2011 fixed on the SP register of the ISA.
2014 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
2016 const be_abi_irg_t *abi = get_abi_from_handler(handler);
2017 const void *res = NULL;
2019 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
2020 res = &abi->irn_ops;
2025 static void be_abi_limited(void *data, bitset_t *bs)
2027 be_abi_irg_t *abi = data;
2028 bitset_clear_all(bs);
2029 bitset_set(bs, abi->isa->sp->index);
2032 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)
2034 be_abi_irg_t *abi = get_abi_from_ops(self);
2035 const arch_register_t *reg = abi->isa->sp;
2037 memset(req, 0, sizeof(req[0]));
2039 if(pos == BE_OUT_POS(0)) {
2040 req->cls = reg->reg_class;
2041 req->type = arch_register_req_type_limited;
2042 req->limited = be_abi_limited;
2043 req->limited_env = abi;
2046 else if(pos >= 0 && pos < get_irn_arity(irn)) {
2047 req->cls = reg->reg_class;
2048 req->type = arch_register_req_type_normal;
2054 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
2058 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
2060 const be_abi_irg_t *abi = get_abi_from_ops(self);
2061 return abi->isa->sp;
2064 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
2066 return arch_irn_class_normal;
2069 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2071 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2074 static ir_entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2079 static void abi_set_frame_entity(const void *_self, ir_node *irn, ir_entity *ent)
2083 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2087 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2092 static const arch_irn_ops_if_t abi_irn_ops = {
2093 abi_get_irn_reg_req,
2098 abi_get_frame_entity,
2099 abi_set_frame_entity,
2100 abi_set_frame_offset,
2102 NULL, /* get_inverse */
2103 NULL, /* get_op_estimated_cost */
2104 NULL, /* possible_memory_operand */
2105 NULL, /* perform_memory_operand */
2108 static const arch_irn_handler_t abi_irn_handler = {
2113 * Returns non-zero if the ABI has omitted the frame pointer in
2114 * the current graph.
2116 int be_abi_omit_fp(const be_abi_irg_t *abi) {
2117 return abi->call->flags.bits.try_omit_fp;