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 if 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);
689 /* a call can produce ignore registers, in this case set the flag and register for the Proj */
690 if (arch_register_type_is(reg, ignore)) {
691 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
692 be_node_set_flags(low_call, BE_OUT_POS(curr_res_proj), arch_irn_flags_ignore);
695 set_irn_link(proj, (void *) reg);
696 obstack_ptr_grow(obst, proj);
700 /* create the Keep for the caller save registers */
701 in = (ir_node **) obstack_finish(obst);
702 keep = be_new_Keep(NULL, irg, bl, n, in);
703 for (i = 0; i < n; ++i) {
704 const arch_register_t *reg = get_irn_link(in[i]);
705 be_node_set_reg_class(keep, i, reg->reg_class);
707 obstack_free(obst, in);
710 /* Clean up the stack. */
712 ir_node *mem_proj = NULL;
714 foreach_out_edge(low_call, edge) {
715 ir_node *irn = get_edge_src_irn(edge);
716 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
723 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
724 keep_alive(mem_proj);
727 /* Clean up the stack frame if we allocated it */
729 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
730 add_irn_dep(curr_sp, mem_proj);
732 add_irn_dep(curr_sp, alloca_copy);
738 be_abi_call_free(call);
739 obstack_free(obst, pos);
741 del_pset(caller_save);
748 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
750 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
752 if (get_Alloc_where(alloc) == stack_alloc) {
753 ir_node *bl = get_nodes_block(alloc);
754 ir_graph *irg = get_irn_irg(bl);
755 ir_node *alloc_mem = NULL;
756 ir_node *alloc_res = NULL;
758 const ir_edge_t *edge;
764 foreach_out_edge(alloc, edge) {
765 ir_node *irn = get_edge_src_irn(edge);
767 assert(is_Proj(irn));
768 switch(get_Proj_proj(irn)) {
780 /* Beware: currently Alloc nodes without a result might happen,
781 only escape analysis kills them and this phase runs only for object
782 oriented source. We kill the Alloc here. */
783 if (alloc_res == NULL && alloc_mem) {
784 exchange(alloc_mem, get_Alloc_mem(alloc));
788 /* The stack pointer will be modified in an unknown manner.
789 We cannot omit it. */
790 env->call->flags.bits.try_omit_fp = 0;
791 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
793 if(alloc_mem != NULL) {
797 addsp_mem = new_r_Proj(irg, bl, new_alloc, mode_M, pn_be_AddSP_M);
799 // We need to sync the output mem of the AddSP with the input mem
800 // edge into the alloc node
801 ins[0] = get_Alloc_mem(alloc);
803 sync = new_r_Sync(irg, bl, 2, ins);
805 exchange(alloc_mem, sync);
808 exchange(alloc, new_alloc);
810 /* fix projnum of alloca res */
811 set_Proj_proj(alloc_res, pn_be_AddSP_res);
813 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
815 /* copy the address away, since it could be used after further stack pointer modifications. */
816 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
817 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, bl, curr_sp);
819 /* Let all users of the Alloc() result now point to the copy. */
820 edges_reroute(alloc_res, copy, irg);
822 /* Rewire the copy appropriately. */
823 set_irn_n(copy, be_pos_Copy_op, addr);
832 * The Free is transformed into a back end free node and connected to the stack nodes.
834 static ir_node *adjust_free(be_abi_irg_t *env, ir_node *free, ir_node *curr_sp)
836 if (get_Free_where(free) == stack_alloc) {
837 ir_node *bl = get_nodes_block(free);
838 ir_graph *irg = get_irn_irg(bl);
839 ir_node *addsp, *mem, *res;
841 /* The stack pointer will be modified in an unknown manner.
842 We cannot omit it. */
843 env->call->flags.bits.try_omit_fp = 0;
844 addsp = be_new_SubSP(env->isa->sp, irg, bl, curr_sp, get_Free_size(free));
846 mem = new_r_Proj(irg, bl, addsp, mode_M, pn_be_SubSP_M);
847 res = new_r_Proj(irg, bl, addsp, mode_P_data, pn_be_SubSP_res);
855 /* the following function is replaced by the usage of the heights module */
858 * Walker for dependent_on().
859 * This function searches a node tgt recursively from a given node
860 * but is restricted to the given block.
861 * @return 1 if tgt was reachable from curr, 0 if not.
863 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
867 if (get_nodes_block(curr) != bl)
873 /* Phi functions stop the recursion inside a basic block */
874 if (! is_Phi(curr)) {
875 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
876 if (check_dependence(get_irn_n(curr, i), tgt, bl))
886 * Check if a node is somehow data dependent on another one.
887 * both nodes must be in the same basic block.
888 * @param n1 The first node.
889 * @param n2 The second node.
890 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
892 static int dependent_on(ir_node *n1, ir_node *n2)
894 ir_node *bl = get_nodes_block(n1);
896 assert(bl == get_nodes_block(n2));
898 return heights_reachable_in_block(ir_heights, n1, n2);
899 //return check_dependence(n1, n2, bl);
902 static int cmp_call_dependecy(const void *c1, const void *c2)
904 ir_node *n1 = *(ir_node **) c1;
905 ir_node *n2 = *(ir_node **) c2;
908 Classical qsort() comparison function behavior:
909 0 if both elements are equal
910 1 if second is "smaller" that first
911 -1 if first is "smaller" that second
913 if (dependent_on(n1, n2))
916 if (dependent_on(n2, n1))
923 * Walker: links all Call/alloc/Free nodes to the Block they are contained.
925 static void link_calls_in_block_walker(ir_node *irn, void *data)
927 opcode code = get_irn_opcode(irn);
929 if (code == iro_Call ||
930 (code == iro_Alloc && get_Alloc_where(irn) == stack_alloc) ||
931 (code == iro_Free && get_Free_where(irn) == stack_alloc)) {
932 be_abi_irg_t *env = data;
933 ir_node *bl = get_nodes_block(irn);
934 void *save = get_irn_link(bl);
936 if (code == iro_Call)
937 env->call->flags.bits.irg_is_leaf = 0;
939 set_irn_link(irn, save);
940 set_irn_link(bl, irn);
946 * Process all Call nodes inside a basic block.
947 * Note that the link field of the block must contain a linked list of all
948 * Call nodes inside the Block. We first order this list according to data dependency
949 * and that connect the calls together.
951 static void process_calls_in_block(ir_node *bl, void *data)
953 be_abi_irg_t *env = data;
954 ir_node *curr_sp = env->init_sp;
958 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
959 obstack_ptr_grow(&env->obst, irn);
961 /* If there were call nodes in the block. */
965 ir_node *copy = NULL;
968 nodes = obstack_finish(&env->obst);
970 /* order the call nodes according to data dependency */
971 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
973 for(i = n - 1; i >= 0; --i) {
974 ir_node *irn = nodes[i];
976 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
977 switch(get_irn_opcode(irn)) {
979 curr_sp = adjust_call(env, irn, curr_sp, copy);
982 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
985 curr_sp = adjust_free(env, irn, curr_sp);
992 obstack_free(&env->obst, nodes);
994 /* Keep the last stack state in the block by tying it to Keep node */
996 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
997 pmap_insert(env->keep_map, bl, keep);
1000 set_irn_link(bl, curr_sp);
1001 } /* process_calls_in_block */
1004 * Adjust all call nodes in the graph to the ABI conventions.
1006 static void process_calls(be_abi_irg_t *env)
1008 ir_graph *irg = env->birg->irg;
1010 env->call->flags.bits.irg_is_leaf = 1;
1011 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
1013 ir_heights = heights_new(env->birg->irg);
1014 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
1015 heights_free(ir_heights);
1019 static ir_node *setup_frame(be_abi_irg_t *env)
1021 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1022 const arch_register_t *sp = isa->sp;
1023 const arch_register_t *bp = isa->bp;
1024 be_abi_call_flags_bits_t flags = env->call->flags.bits;
1025 ir_graph *irg = env->birg->irg;
1026 ir_node *bl = get_irg_start_block(irg);
1027 ir_node *no_mem = get_irg_no_mem(irg);
1028 ir_node *old_frame = get_irg_frame(irg);
1029 ir_node *stack = pmap_get(env->regs, (void *) sp);
1030 ir_node *frame = pmap_get(env->regs, (void *) bp);
1032 int stack_nr = get_Proj_proj(stack);
1034 if(flags.try_omit_fp) {
1035 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
1040 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
1042 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
1043 if(!flags.fp_free) {
1044 be_set_constr_single_reg(frame, -1, bp);
1045 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
1046 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
1049 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
1052 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
1053 env->init_sp = stack;
1054 set_irg_frame(irg, frame);
1055 edges_reroute(old_frame, frame, irg);
1060 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1062 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1063 const arch_register_t *sp = isa->sp;
1064 const arch_register_t *bp = isa->bp;
1065 ir_graph *irg = env->birg->irg;
1066 ir_node *ret_mem = get_Return_mem(ret);
1067 ir_node *frame = get_irg_frame(irg);
1068 ir_node *bl = get_nodes_block(ret);
1069 ir_node *stack = get_irn_link(bl);
1073 if(env->call->flags.bits.try_omit_fp) {
1074 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1078 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1079 be_set_constr_single_reg(stack, -1, sp);
1080 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1083 pmap_foreach(env->regs, ent) {
1084 const arch_register_t *reg = ent->key;
1085 ir_node *irn = ent->value;
1088 obstack_ptr_grow(&env->obst, stack);
1090 obstack_ptr_grow(&env->obst, frame);
1091 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1092 obstack_ptr_grow(obst, irn);
1099 * Computes the stack argument layout type.
1100 * Changes a possibly allocated value param type by moving
1101 * entities to the stack layout type.
1103 * @param env the ABI environment
1104 * @param call the current call ABI
1105 * @param method_type the method type
1106 * @param param_map an array mapping method arguments to the stack layout type
1108 * @return the stack argument layout type
1110 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type, ir_entity ***param_map)
1112 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1113 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1114 int n = get_method_n_params(method_type);
1115 int curr = inc > 0 ? 0 : n - 1;
1121 ir_type *val_param_tp = get_method_value_param_type(method_type);
1122 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1125 *param_map = map = obstack_alloc(&env->obst, n * sizeof(ir_entity *));
1126 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1127 for (i = 0; i < n; ++i, curr += inc) {
1128 ir_type *param_type = get_method_param_type(method_type, curr);
1129 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1132 if (arg->on_stack) {
1134 /* the entity was already created, move it to the param type */
1135 arg->stack_ent = get_method_value_param_ent(method_type, i);
1136 remove_struct_member(val_param_tp, arg->stack_ent);
1137 set_entity_owner(arg->stack_ent, res);
1138 add_struct_member(res, arg->stack_ent);
1139 /* must be automatic to set a fixed layout */
1140 set_entity_allocation(arg->stack_ent, allocation_automatic);
1143 snprintf(buf, sizeof(buf), "param_%d", i);
1144 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1146 ofs += arg->space_before;
1147 ofs = round_up2(ofs, arg->alignment);
1148 set_entity_offset(arg->stack_ent, ofs);
1149 ofs += arg->space_after;
1150 ofs += get_type_size_bytes(param_type);
1151 map[i] = arg->stack_ent;
1154 set_type_size_bytes(res, ofs);
1155 set_type_state(res, layout_fixed);
1160 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1163 struct obstack obst;
1165 obstack_init(&obst);
1167 /* Create a Perm after the RegParams node to delimit it. */
1168 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1169 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1174 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1175 const arch_register_t *reg = &cls->regs[j];
1176 ir_node *irn = pmap_get(regs, (void *) reg);
1178 if(irn && !arch_register_type_is(reg, ignore)) {
1180 obstack_ptr_grow(&obst, irn);
1181 set_irn_link(irn, (void *) reg);
1185 obstack_ptr_grow(&obst, NULL);
1186 in = obstack_finish(&obst);
1188 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1189 for(j = 0; j < n_regs; ++j) {
1190 ir_node *arg = in[j];
1191 arch_register_t *reg = get_irn_link(arg);
1192 pmap_insert(regs, reg, arg);
1193 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1196 obstack_free(&obst, in);
1199 obstack_free(&obst, NULL);
1204 const arch_register_t *reg;
1208 static int cmp_regs(const void *a, const void *b)
1210 const reg_node_map_t *p = a;
1211 const reg_node_map_t *q = b;
1213 if(p->reg->reg_class == q->reg->reg_class)
1214 return p->reg->index - q->reg->index;
1216 return p->reg->reg_class - q->reg->reg_class;
1219 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1222 int n = pmap_count(reg_map);
1224 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1226 pmap_foreach(reg_map, ent) {
1227 res[i].reg = ent->key;
1228 res[i].irn = ent->value;
1232 qsort(res, n, sizeof(res[0]), cmp_regs);
1237 * Creates a barrier.
1239 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1241 ir_graph *irg = env->birg->irg;
1242 int n_regs = pmap_count(regs);
1248 rm = reg_map_to_arr(&env->obst, regs);
1250 for(n = 0; n < n_regs; ++n)
1251 obstack_ptr_grow(&env->obst, rm[n].irn);
1254 obstack_ptr_grow(&env->obst, *mem);
1258 in = (ir_node **) obstack_finish(&env->obst);
1259 irn = be_new_Barrier(irg, bl, n, in);
1260 obstack_free(&env->obst, in);
1262 for(n = 0; n < n_regs; ++n) {
1263 const arch_register_t *reg = rm[n].reg;
1265 int pos = BE_OUT_POS(n);
1268 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1269 be_node_set_reg_class(irn, n, reg->reg_class);
1271 be_set_constr_single_reg(irn, n, reg);
1272 be_set_constr_single_reg(irn, pos, reg);
1273 be_node_set_reg_class(irn, pos, reg->reg_class);
1274 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1276 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1277 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1278 flags |= arch_irn_flags_ignore;
1280 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1281 flags |= arch_irn_flags_modify_sp;
1283 be_node_set_flags(irn, pos, flags);
1285 pmap_insert(regs, (void *) reg, proj);
1289 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1292 obstack_free(&env->obst, rm);
1297 * Creates a be_Return for a Return node.
1299 * @param @env the abi environment
1300 * @param irn the Return node or NULL if there was none
1301 * @param bl the block where the be_Retun should be placed
1302 * @param mem the current memory
1303 * @param n_res number of return results
1305 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1306 be_abi_call_t *call = env->call;
1307 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1309 pmap *reg_map = pmap_create();
1310 ir_node *keep = pmap_get(env->keep_map, bl);
1316 const arch_register_t **regs;
1320 get the valid stack node in this block.
1321 If we had a call in that block there is a Keep constructed by process_calls()
1322 which points to the last stack modification in that block. we'll use
1323 it then. Else we use the stack from the start block and let
1324 the ssa construction fix the usage.
1326 stack = be_abi_reg_map_get(env->regs, isa->sp);
1328 ir_node *bad = new_r_Bad(env->birg->irg);
1329 stack = get_irn_n(keep, 0);
1330 set_nodes_block(keep, bad);
1331 set_irn_n(keep, 0, bad);
1332 // exchange(keep, new_r_Bad(env->birg->irg));
1335 /* Insert results for Return into the register map. */
1336 for(i = 0; i < n_res; ++i) {
1337 ir_node *res = get_Return_res(irn, i);
1338 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1339 assert(arg->in_reg && "return value must be passed in register");
1340 pmap_insert(reg_map, (void *) arg->reg, res);
1343 /* Add uses of the callee save registers. */
1344 pmap_foreach(env->regs, ent) {
1345 const arch_register_t *reg = ent->key;
1346 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1347 pmap_insert(reg_map, ent->key, ent->value);
1350 be_abi_reg_map_set(reg_map, isa->sp, stack);
1352 /* Make the Epilogue node and call the arch's epilogue maker. */
1353 create_barrier(env, bl, &mem, reg_map, 1);
1354 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1357 Maximum size of the in array for Return nodes is
1358 return args + callee save/ignore registers + memory + stack pointer
1360 in_max = pmap_count(reg_map) + n_res + 2;
1362 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1363 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1366 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1371 /* clear SP entry, since it has already been grown. */
1372 pmap_insert(reg_map, (void *) isa->sp, NULL);
1373 for(i = 0; i < n_res; ++i) {
1374 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1376 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1377 regs[n++] = arg->reg;
1379 /* Clear the map entry to mark the register as processed. */
1380 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1383 /* grow the rest of the stuff. */
1384 pmap_foreach(reg_map, ent) {
1387 regs[n++] = ent->key;
1391 /* The in array for the new back end return is now ready. */
1392 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1394 /* Set the register classes of the return's parameter accordingly. */
1395 for(i = 0; i < n; ++i)
1397 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1399 /* Free the space of the Epilog's in array and the register <-> proj map. */
1400 obstack_free(&env->obst, in);
1401 pmap_destroy(reg_map);
1406 typedef struct lower_frame_sels_env_t {
1408 ir_entity *value_param_list; /**< the list of all value param entities */
1409 } lower_frame_sels_env_t;
1412 * Walker: Replaces Sels of frame type and
1413 * value param type entities by FrameAddress.
1415 static void lower_frame_sels_walker(ir_node *irn, void *data)
1417 lower_frame_sels_env_t *ctx = data;
1420 ir_graph *irg = current_ir_graph;
1421 ir_node *frame = get_irg_frame(irg);
1422 ir_node *param_base = get_irg_value_param_base(irg);
1423 ir_node *ptr = get_Sel_ptr(irn);
1425 if (ptr == frame || ptr == param_base) {
1426 be_abi_irg_t *env = ctx->env;
1427 ir_entity *ent = get_Sel_entity(irn);
1428 ir_node *bl = get_nodes_block(irn);
1431 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1434 /* check, if it's a param sel and if have not seen this entity immediatly before */
1435 if (ptr == param_base && ctx->value_param_list != ent) {
1436 set_entity_link(ent, ctx->value_param_list);
1437 ctx->value_param_list = ent;
1444 * Check if a value parameter is transmitted as a register.
1445 * This might happen if the address of an parameter is taken which is
1446 * transmitted in registers.
1448 * Note that on some architectures this case must be handled specially
1449 * because the place of the backing store is determined by their ABI.
1451 * In the default case we move the entity to the frame type and create
1452 * a backing store into the first block.
1454 static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_param_list) {
1455 be_abi_call_t *call = env->call;
1456 ir_graph *irg = env->birg->irg;
1457 ir_entity *ent, *next_ent, *new_list;
1459 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1462 for (ent = value_param_list; ent; ent = next_ent) {
1463 int i = get_struct_member_index(get_entity_owner(ent), ent);
1464 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1466 next_ent = get_entity_link(ent);
1468 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1469 set_entity_link(ent, new_list);
1474 /* ok, change the graph */
1475 ir_node *start_bl = get_irg_start_block(irg);
1476 ir_node *first_bl = NULL;
1477 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1478 const ir_edge_t *edge;
1479 optimization_state_t state;
1482 foreach_block_succ(start_bl, edge) {
1483 ir_node *succ = get_edge_src_irn(edge);
1484 if (start_bl != succ) {
1490 /* we had already removed critical edges, so the following
1491 assertion should be always true. */
1492 assert(get_Block_n_cfgpreds(first_bl) == 1);
1494 /* now create backing stores */
1495 frame = get_irg_frame(irg);
1496 imem = get_irg_initial_mem(irg);
1498 save_optimization_state(&state);
1500 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1501 restore_optimization_state(&state);
1503 /* reroute all edges to the new memory source */
1504 edges_reroute(imem, nmem, irg);
1508 args = get_irg_args(irg);
1509 args_bl = get_nodes_block(args);
1510 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1511 int i = get_struct_member_index(get_entity_owner(ent), ent);
1512 ir_type *tp = get_entity_type(ent);
1513 ir_mode *mode = get_type_mode(tp);
1516 /* address for the backing store */
1517 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1520 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1522 /* the backing store itself */
1523 store = new_r_Store(irg, first_bl, mem, addr,
1524 new_r_Proj(irg, args_bl, args, mode, i));
1526 /* the new memory Proj gets the last Proj from store */
1527 set_Proj_pred(nmem, store);
1528 set_Proj_proj(nmem, pn_Store_M);
1530 /* move all entities to the frame type */
1531 frame_tp = get_irg_frame_type(irg);
1532 offset = get_type_size_bytes(frame_tp);
1533 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1534 ir_type *tp = get_entity_type(ent);
1535 int align = get_type_alignment_bytes(tp);
1537 offset += align - 1;
1539 set_entity_owner(ent, frame_tp);
1540 add_class_member(frame_tp, ent);
1541 /* must be automatic to set a fixed layout */
1542 set_entity_allocation(ent, allocation_automatic);
1543 set_entity_offset(ent, offset);
1544 offset += get_type_size_bytes(tp);
1546 set_type_size_bytes(frame_tp, offset);
1551 * Modify the irg itself and the frame type.
1553 static void modify_irg(be_abi_irg_t *env)
1555 be_abi_call_t *call = env->call;
1556 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1557 const arch_register_t *sp = arch_isa_sp(isa);
1558 ir_graph *irg = env->birg->irg;
1559 ir_node *bl = get_irg_start_block(irg);
1560 ir_node *end = get_irg_end_block(irg);
1561 ir_node *mem = get_irg_initial_mem(irg);
1562 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1563 pset *dont_save = pset_new_ptr(8);
1569 const arch_register_t *fp_reg;
1570 ir_node *frame_pointer;
1572 ir_node *reg_params_bl;
1575 const ir_edge_t *edge;
1576 ir_type *arg_type, *bet_type;
1577 lower_frame_sels_env_t ctx;
1578 ir_entity **param_map;
1580 bitset_t *used_proj_nr;
1581 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1583 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1585 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1587 ctx.value_param_list = NULL;
1588 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1590 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1591 env->regs = pmap_create();
1593 used_proj_nr = bitset_alloca(1024);
1594 n_params = get_method_n_params(method_type);
1595 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1596 memset(args, 0, n_params * sizeof(args[0]));
1598 /* Check if a value parameter is transmitted as a register.
1599 * This might happen if the address of an parameter is taken which is
1600 * transmitted in registers.
1602 * Note that on some architectures this case must be handled specially
1603 * because the place of the backing store is determined by their ABI.
1605 * In the default case we move the entity to the frame type and create
1606 * a backing store into the first block.
1608 fix_address_of_parameter_access(env, ctx.value_param_list);
1610 /* Fill the argument vector */
1611 arg_tuple = get_irg_args(irg);
1612 foreach_out_edge(arg_tuple, edge) {
1613 ir_node *irn = get_edge_src_irn(edge);
1614 int nr = get_Proj_proj(irn);
1616 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1619 arg_type = compute_arg_type(env, call, method_type, ¶m_map);
1620 bet_type = call->cb->get_between_type(env->cb);
1621 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir, param_map);
1623 /* Count the register params and add them to the number of Projs for the RegParams node */
1624 for(i = 0; i < n_params; ++i) {
1625 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1626 if(arg->in_reg && args[i]) {
1627 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1628 assert(i == get_Proj_proj(args[i]));
1630 /* For now, associate the register with the old Proj from Start representing that argument. */
1631 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1632 bitset_set(used_proj_nr, i);
1633 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1637 /* Collect all callee-save registers */
1638 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1639 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1640 for(j = 0; j < cls->n_regs; ++j) {
1641 const arch_register_t *reg = &cls->regs[j];
1642 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1643 pmap_insert(env->regs, (void *) reg, NULL);
1647 pmap_insert(env->regs, (void *) sp, NULL);
1648 pmap_insert(env->regs, (void *) isa->bp, NULL);
1649 reg_params_bl = get_irg_start_block(irg);
1650 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1651 add_irn_dep(env->reg_params, get_irg_start(irg));
1654 * make proj nodes for the callee save registers.
1655 * memorize them, since Return nodes get those as inputs.
1657 * Note, that if a register corresponds to an argument, the regs map contains
1658 * the old Proj from start for that argument.
1661 rm = reg_map_to_arr(&env->obst, env->regs);
1662 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1663 arch_register_t *reg = (void *) rm[i].reg;
1664 ir_node *arg_proj = rm[i].irn;
1665 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1667 int pos = BE_OUT_POS((int) nr);
1673 bitset_set(used_proj_nr, nr);
1674 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1675 pmap_insert(env->regs, (void *) reg, proj);
1676 be_set_constr_single_reg(env->reg_params, pos, reg);
1677 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1680 * If the register is an ignore register,
1681 * The Proj for that register shall also be ignored during register allocation.
1683 if(arch_register_type_is(reg, ignore))
1684 flags |= arch_irn_flags_ignore;
1687 flags |= arch_irn_flags_modify_sp;
1689 be_node_set_flags(env->reg_params, pos, flags);
1691 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1693 obstack_free(&env->obst, rm);
1695 /* Generate the Prologue */
1696 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1698 /* do the stack allocation BEFORE the barrier, or spill code
1699 might be added before it */
1700 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1701 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1702 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1704 env->start_barrier = barrier = create_barrier(env, bl, &mem, env->regs, 0);
1706 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1707 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1709 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1710 set_irg_frame(irg, frame_pointer);
1711 pset_insert_ptr(env->ignore_regs, fp_reg);
1713 /* Now, introduce stack param nodes for all parameters passed on the stack */
1714 for(i = 0; i < n_params; ++i) {
1715 ir_node *arg_proj = args[i];
1716 ir_node *repl = NULL;
1718 if(arg_proj != NULL) {
1719 be_abi_call_arg_t *arg;
1720 ir_type *param_type;
1721 int nr = get_Proj_proj(arg_proj);
1723 nr = MIN(nr, n_params);
1724 arg = get_call_arg(call, 0, nr);
1725 param_type = get_method_param_type(method_type, nr);
1728 repl = pmap_get(env->regs, (void *) arg->reg);
1731 else if(arg->on_stack) {
1732 /* For atomic parameters which are actually used, we create a StackParam node. */
1733 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1734 ir_mode *mode = get_type_mode(param_type);
1735 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1736 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1739 /* The stack parameter is not primitive (it is a struct or array),
1740 we thus will create a node representing the parameter's address
1743 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1747 assert(repl != NULL);
1748 edges_reroute(args[i], repl, irg);
1752 /* All Return nodes hang on the End node, so look for them there. */
1753 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1754 ir_node *irn = get_Block_cfgpred(end, i);
1756 if (is_Return(irn)) {
1757 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1761 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1762 the code is dead and will never be executed. */
1764 del_pset(dont_save);
1765 obstack_free(&env->obst, args);
1768 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1770 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1771 ir_node *old_frame = get_irg_frame(birg->irg);
1772 ir_graph *irg = birg->irg;
1776 optimization_state_t state;
1778 be_omit_fp = birg->main_env->options->omit_fp;
1780 obstack_init(&env->obst);
1782 env->isa = birg->main_env->arch_env->isa;
1783 env->method_type = get_entity_type(get_irg_entity(irg));
1784 env->call = be_abi_call_new();
1785 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1787 env->ignore_regs = pset_new_ptr_default();
1788 env->keep_map = pmap_create();
1789 env->dce_survivor = new_survive_dce();
1791 env->stack_phis = pset_new_ptr(16);
1792 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1793 to another Unknown or the stack pointer gets used */
1794 save_optimization_state(&state);
1796 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1797 restore_optimization_state(&state);
1798 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1800 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1801 env->irn_ops.impl = &abi_irn_ops;
1803 /* Lower all call nodes in the IRG. */
1807 Beware: init backend abi call object after processing calls,
1808 otherwise some information might be not yet available.
1810 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1812 /* Process the IRG */
1815 /* We don't need the keep map anymore. */
1816 pmap_destroy(env->keep_map);
1818 /* reroute the stack origin of the calls to the true stack origin. */
1819 edges_reroute(dummy, env->init_sp, irg);
1820 edges_reroute(old_frame, get_irg_frame(irg), irg);
1822 /* Make some important node pointers survive the dead node elimination. */
1823 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1824 pmap_foreach(env->regs, ent)
1825 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1827 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1829 env->call->cb->done(env->cb);
1834 void be_abi_free(be_abi_irg_t *env)
1836 free_survive_dce(env->dce_survivor);
1837 del_pset(env->stack_phis);
1838 del_pset(env->ignore_regs);
1839 pmap_destroy(env->regs);
1840 obstack_free(&env->obst, NULL);
1841 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1845 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1847 arch_register_t *reg;
1849 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1850 if(reg->reg_class == cls)
1851 bitset_set(bs, reg->index);
1854 /* Returns the stack layout from a abi environment. */
1855 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi) {
1862 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1863 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1864 | _| | |> < ___) | || (_| | (__| <
1865 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1869 struct fix_stack_walker_info {
1871 const arch_env_t *aenv;
1875 * Walker. Collect all stack modifying nodes.
1877 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1879 struct fix_stack_walker_info *info = data;
1884 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1885 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1886 pset_insert_ptr(info->nodes, irn);
1890 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1892 pset *stack_nodes = pset_new_ptr(16);
1893 struct fix_stack_walker_info info;
1895 info.nodes = stack_nodes;
1896 info.aenv = env->birg->main_env->arch_env;
1898 be_assure_dom_front(env->birg);
1900 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1901 pset_insert_ptr(stack_nodes, env->init_sp);
1902 be_ssa_constr_set_phis(env->birg->dom_front, lv, stack_nodes, env->stack_phis);
1903 del_pset(stack_nodes);
1906 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1908 const arch_env_t *arch_env = env->birg->main_env->arch_env;
1909 int omit_fp = env->call->flags.bits.try_omit_fp;
1912 sched_foreach(bl, irn) {
1915 Check, if the node relates to an entity on the stack frame.
1916 If so, set the true offset (including the bias) for that
1919 ir_entity *ent = arch_get_frame_entity(arch_env, irn);
1921 int offset = get_stack_entity_offset(env->frame, ent, bias);
1922 arch_set_frame_offset(arch_env, irn, offset);
1923 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
1927 If the node modifies the stack pointer by a constant offset,
1928 record that in the bias.
1930 if(arch_irn_is(arch_env, irn, modify_sp)) {
1931 int ofs = arch_get_sp_bias(arch_env, irn);
1933 if(be_is_IncSP(irn)) {
1934 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
1935 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1936 be_set_IncSP_offset(irn, ofs);
1937 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
1938 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1939 be_set_IncSP_offset(irn, ofs);
1952 * A helper struct for the bias walker.
1955 be_abi_irg_t *env; /**< The ABI irg environment. */
1956 int start_block_bias; /**< The bias at the end of the start block. */
1957 ir_node *start_block; /**< The start block of the current graph. */
1961 * Block-Walker: fix all stack offsets
1963 static void stack_bias_walker(ir_node *bl, void *data)
1965 struct bias_walk *bw = data;
1966 if (bl != bw->start_block) {
1967 process_stack_bias(bw->env, bl, bw->start_block_bias);
1971 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1973 ir_graph *irg = env->birg->irg;
1974 struct bias_walk bw;
1976 stack_frame_compute_initial_offset(env->frame);
1977 // stack_layout_dump(stdout, env->frame);
1979 /* Determine the stack bias at the end of the start block. */
1980 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1982 /* fix the bias is all other blocks */
1984 bw.start_block = get_irg_start_block(irg);
1985 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1988 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1990 assert(arch_register_type_is(reg, callee_save));
1991 assert(pmap_contains(abi->regs, (void *) reg));
1992 return pmap_get(abi->regs, (void *) reg);
1995 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1997 assert(arch_register_type_is(reg, ignore));
1998 assert(pmap_contains(abi->regs, (void *) reg));
1999 return pmap_get(abi->regs, (void *) reg);
2002 ir_node *be_abi_get_start_barrier(be_abi_irg_t *abi)
2004 return abi->start_barrier;
2008 _____ _____ _ _ _ _ _ _
2009 |_ _| __ \| \ | | | | | | | | |
2010 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
2011 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
2012 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
2013 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
2015 for Phi nodes which are created due to stack modifying nodes
2016 such as IncSP, AddSP and SetSP.
2018 These Phis are always to be ignored by the reg alloc and are
2019 fixed on the SP register of the ISA.
2022 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
2024 const be_abi_irg_t *abi = get_abi_from_handler(handler);
2025 const void *res = NULL;
2027 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
2028 res = &abi->irn_ops;
2033 static void be_abi_limited(void *data, bitset_t *bs)
2035 be_abi_irg_t *abi = data;
2036 bitset_clear_all(bs);
2037 bitset_set(bs, abi->isa->sp->index);
2040 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)
2042 be_abi_irg_t *abi = get_abi_from_ops(self);
2043 const arch_register_t *reg = abi->isa->sp;
2045 memset(req, 0, sizeof(req[0]));
2047 if(pos == BE_OUT_POS(0)) {
2048 req->cls = reg->reg_class;
2049 req->type = arch_register_req_type_limited;
2050 req->limited = be_abi_limited;
2051 req->limited_env = abi;
2054 else if(pos >= 0 && pos < get_irn_arity(irn)) {
2055 req->cls = reg->reg_class;
2056 req->type = arch_register_req_type_normal;
2062 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
2066 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
2068 const be_abi_irg_t *abi = get_abi_from_ops(self);
2069 return abi->isa->sp;
2072 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
2074 return arch_irn_class_normal;
2077 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2079 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2082 static ir_entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2087 static void abi_set_frame_entity(const void *_self, ir_node *irn, ir_entity *ent)
2091 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2095 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2100 static const arch_irn_ops_if_t abi_irn_ops = {
2101 abi_get_irn_reg_req,
2106 abi_get_frame_entity,
2107 abi_set_frame_entity,
2108 abi_set_frame_offset,
2110 NULL, /* get_inverse */
2111 NULL, /* get_op_estimated_cost */
2112 NULL, /* possible_memory_operand */
2113 NULL, /* perform_memory_operand */
2116 static const arch_irn_handler_t abi_irn_handler = {
2121 * Returns non-zero if the ABI has omitted the frame pointer in
2122 * the current graph.
2124 int be_abi_omit_fp(const be_abi_irg_t *abi) {
2125 return abi->call->flags.bits.try_omit_fp;