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(const arch_register_class_t *cls_addr)
214 be_abi_call_t *call = xmalloc(sizeof(call[0]));
217 call->params = new_set(cmp_call_arg, 16);
219 call->cls_addr = cls_addr;
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 ir_type *mt = get_Call_type(irn);
391 ir_node *call_ptr = get_Call_ptr(irn);
392 int n_params = get_method_n_params(mt);
393 ir_node *curr_mem = get_Call_mem(irn);
394 ir_node *bl = get_nodes_block(irn);
395 pset *results = pset_new_ptr(8);
396 pset *caller_save = pset_new_ptr(8);
398 int stack_dir = arch_isa_stack_dir(isa);
399 const arch_register_t *sp = arch_isa_sp(isa);
400 be_abi_call_t *call = be_abi_call_new(sp->reg_class);
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 for(i = 0; i < n_pos; ++i) {
490 be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
491 ir_node *param = get_Call_param(irn, p);
492 ir_node *addr = curr_sp;
494 ir_type *param_type = get_method_param_type(mt, p);
495 int param_size = get_type_size_bytes(param_type) + arg->space_after;
498 * If we wanted to build the arguments sequentially,
499 * the stack pointer for the next must be incremented,
500 * and the memory value propagated.
504 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, param_size + arg->space_before);
506 add_irn_dep(curr_sp, alloca_copy);
509 add_irn_dep(curr_sp, curr_mem);
512 curr_ofs += arg->space_before;
513 curr_ofs = round_up2(curr_ofs, arg->alignment);
515 /* Make the expression to compute the argument's offset. */
517 ir_mode *constmode = mach_mode;
518 if(mode_is_reference(mach_mode)) {
521 addr = new_r_Const_long(irg, bl, constmode, curr_ofs);
522 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
526 /* Insert a store for primitive arguments. */
527 if (is_atomic_type(param_type)) {
529 store = new_r_Store(irg, bl, curr_mem, addr, param);
530 mem = new_r_Proj(irg, bl, store, mode_M, pn_Store_M);
533 /* Make a mem copy for compound arguments. */
537 assert(mode_is_reference(get_irn_mode(param)));
538 copy = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
539 mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
542 curr_ofs += param_size;
547 obstack_ptr_grow(obst, mem);
550 in = (ir_node **) obstack_finish(obst);
552 /* We need the sync only, if we didn't build the stores sequentially. */
555 curr_mem = new_r_Sync(irg, bl, n_pos + 1, in);
557 curr_mem = get_Call_mem(irn);
560 obstack_free(obst, in);
563 /* Collect caller save registers */
564 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
566 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
567 for(j = 0; j < cls->n_regs; ++j) {
568 const arch_register_t *reg = arch_register_for_index(cls, j);
569 if(arch_register_type_is(reg, caller_save))
570 pset_insert_ptr(caller_save, (void *) reg);
574 /* search the greatest result proj number */
576 /* TODO: what if the result is NOT used? Currently there is
577 * no way to detect this later, especially there is no way to
578 * see this in the proj numbers.
579 * While this is ok for the register allocator, it is bad for
580 * backends which need to change the be_Call further (x87 simulator
581 * for instance. However for this particular case the call_type is
584 foreach_out_edge(irn, edge) {
585 const ir_edge_t *res_edge;
586 ir_node *irn = get_edge_src_irn(edge);
588 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_T_result) {
590 foreach_out_edge(irn, res_edge) {
592 be_abi_call_arg_t *arg;
593 ir_node *res = get_edge_src_irn(res_edge);
595 assert(is_Proj(res));
597 proj = get_Proj_proj(res);
598 arg = get_call_arg(call, 1, proj);
601 shift the proj number to the right, since we will drop the
602 unspeakable Proj_T from the Call. Therefore, all real argument
603 Proj numbers must be increased by pn_be_Call_first_res
605 proj += pn_be_Call_first_res;
606 set_Proj_proj(res, proj);
607 obstack_ptr_grow(obst, res);
609 if(proj > curr_res_proj)
610 curr_res_proj = proj;
612 pset_remove_ptr(caller_save, arg->reg);
613 //pmap_insert(arg_regs, arg->reg, INT_TO_PTR(proj + 1))
620 obstack_ptr_grow(obst, NULL);
621 res_projs = obstack_finish(obst);
623 /* make the back end call node and set its register requirements. */
624 for(i = 0; i < n_low_args; ++i)
625 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
627 in = obstack_finish(obst);
629 if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
630 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, curr_sp,
631 curr_res_proj + pset_count(caller_save), n_low_args, in,
633 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
637 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, call_ptr,
638 curr_res_proj + pset_count(caller_save), n_low_args, in,
642 Set the register class of the call address to
643 the backend provided class (default: stack pointer class)
645 be_node_set_reg_class(low_call, be_pos_Call_ptr, call->cls_addr);
647 /* Set input requirement for stack pointer. */
648 be_node_set_reg_class(low_call, be_pos_Call_sp, arch_get_irn_reg_class(isa->main_env->arch_env, curr_sp, -1));
650 DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
652 /* Set the register classes and constraints of the Call parameters. */
653 for(i = 0; i < n_low_args; ++i) {
654 int index = low_args[i];
655 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
656 assert(arg->reg != NULL);
658 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + index, arg->reg);
661 /* Set the register constraints of the results. */
662 for (i = 0; res_projs[i]; ++i) {
663 ir_node *irn = res_projs[i];
664 int proj = get_Proj_proj(irn);
666 /* Correct Proj number since it has been adjusted! (see above) */
667 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
670 const arch_register_class_t *cls = arch_register_get_class(arg->reg);
671 ir_mode *mode = arch_register_class_mode(cls);
672 set_irn_mode(irn, mode);
675 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
677 obstack_free(obst, in);
678 exchange(irn, low_call);
680 /* redirect the result projs to the lowered call instead of the Proj_T */
681 for (i = 0; res_projs[i]; ++i)
682 set_Proj_pred(res_projs[i], low_call);
684 /* set the now unnecessary projT to bad */
685 if(res_proj != NULL) {
686 be_kill_node(res_proj);
689 /* Make additional projs for the caller save registers
690 and the Keep node which keeps them alive. */
691 if (pset_count(caller_save) > 0) {
692 const arch_register_t *reg;
696 for (reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
697 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
699 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
700 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
702 /* a call can produce ignore registers, in this case set the flag and register for the Proj */
703 if (arch_register_type_is(reg, ignore)) {
704 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
705 be_node_set_flags(low_call, BE_OUT_POS(curr_res_proj), arch_irn_flags_ignore);
708 set_irn_link(proj, (void *) reg);
709 obstack_ptr_grow(obst, proj);
713 /* create the Keep for the caller save registers */
714 in = (ir_node **) obstack_finish(obst);
715 keep = be_new_Keep(NULL, irg, bl, n, in);
716 for (i = 0; i < n; ++i) {
717 const arch_register_t *reg = get_irn_link(in[i]);
718 be_node_set_reg_class(keep, i, reg->reg_class);
720 obstack_free(obst, in);
723 /* Clean up the stack. */
725 ir_node *mem_proj = NULL;
727 foreach_out_edge(low_call, edge) {
728 ir_node *irn = get_edge_src_irn(edge);
729 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
736 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
737 keep_alive(mem_proj);
740 /* Clean up the stack frame if we allocated it */
742 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
743 add_irn_dep(curr_sp, mem_proj);
745 add_irn_dep(curr_sp, alloca_copy);
751 be_abi_call_free(call);
752 obstack_free(obst, pos);
754 del_pset(caller_save);
761 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
763 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
771 const ir_edge_t *edge;
778 if (get_Alloc_where(alloc) != stack_alloc) {
783 block = get_nodes_block(alloc);
784 irg = get_irn_irg(block);
787 type = get_Alloc_type(alloc);
789 foreach_out_edge(alloc, edge) {
790 ir_node *irn = get_edge_src_irn(edge);
792 assert(is_Proj(irn));
793 switch(get_Proj_proj(irn)) {
805 /* Beware: currently Alloc nodes without a result might happen,
806 only escape analysis kills them and this phase runs only for object
807 oriented source. We kill the Alloc here. */
808 if (alloc_res == NULL && alloc_mem) {
809 exchange(alloc_mem, get_Alloc_mem(alloc));
813 /* we might need to multiply the size with the element size */
814 if(type != get_unknown_type() && get_type_size_bytes(type) != 1) {
815 tarval *tv = new_tarval_from_long(get_type_size_bytes(type), mode_Iu);
816 ir_node *cnst = new_rd_Const(NULL, irg, block, mode_Iu, tv);
817 ir_node *mul = new_rd_Mul(NULL, irg, block, get_Alloc_size(alloc),
821 size = get_Alloc_size(alloc);
824 /* The stack pointer will be modified in an unknown manner.
825 We cannot omit it. */
826 env->call->flags.bits.try_omit_fp = 0;
827 new_alloc = be_new_AddSP(env->isa->sp, irg, block, curr_sp, size);
829 if(alloc_mem != NULL) {
833 addsp_mem = new_r_Proj(irg, block, new_alloc, mode_M, pn_be_AddSP_M);
835 // We need to sync the output mem of the AddSP with the input mem
836 // edge into the alloc node
837 ins[0] = get_Alloc_mem(alloc);
839 sync = new_r_Sync(irg, block, 2, ins);
841 exchange(alloc_mem, sync);
844 exchange(alloc, new_alloc);
846 /* fix projnum of alloca res */
847 set_Proj_proj(alloc_res, pn_be_AddSP_res);
849 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
851 /* copy the address away, since it could be used after further stack pointer modifications. */
852 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
853 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, block, curr_sp);
855 /* Let all users of the Alloc() result now point to the copy. */
856 edges_reroute(alloc_res, copy, irg);
858 /* Rewire the copy appropriately. */
859 set_irn_n(copy, be_pos_Copy_op, addr);
868 * The Free is transformed into a back end free node and connected to the stack nodes.
870 static ir_node *adjust_free(be_abi_irg_t *env, ir_node *free, ir_node *curr_sp)
874 ir_node *addsp, *mem, *res, *size;
877 if (get_Free_where(free) != stack_alloc) {
882 block = get_nodes_block(free);
883 irg = get_irn_irg(block);
884 type = get_Free_type(free);
886 /* we might need to multiply the size with the element size */
887 if(type != get_unknown_type() && get_type_size_bytes(type) != 1) {
888 tarval *tv = new_tarval_from_long(get_type_size_bytes(type), mode_Iu);
889 ir_node *cnst = new_rd_Const(NULL, irg, block, mode_Iu, tv);
890 ir_node *mul = new_rd_Mul(NULL, irg, block, get_Free_size(free),
894 size = get_Free_size(free);
897 /* The stack pointer will be modified in an unknown manner.
898 We cannot omit it. */
899 env->call->flags.bits.try_omit_fp = 0;
900 addsp = be_new_SubSP(env->isa->sp, irg, block, curr_sp, size);
902 mem = new_r_Proj(irg, block, addsp, mode_M, pn_be_SubSP_M);
903 res = new_r_Proj(irg, block, addsp, mode_P_data, pn_be_SubSP_res);
911 /* the following function is replaced by the usage of the heights module */
914 * Walker for dependent_on().
915 * This function searches a node tgt recursively from a given node
916 * but is restricted to the given block.
917 * @return 1 if tgt was reachable from curr, 0 if not.
919 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
923 if (get_nodes_block(curr) != bl)
929 /* Phi functions stop the recursion inside a basic block */
930 if (! is_Phi(curr)) {
931 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
932 if (check_dependence(get_irn_n(curr, i), tgt, bl))
942 * Check if a node is somehow data dependent on another one.
943 * both nodes must be in the same basic block.
944 * @param n1 The first node.
945 * @param n2 The second node.
946 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
948 static int dependent_on(ir_node *n1, ir_node *n2)
950 ir_node *bl = get_nodes_block(n1);
952 assert(bl == get_nodes_block(n2));
954 return heights_reachable_in_block(ir_heights, n1, n2);
955 //return check_dependence(n1, n2, bl);
958 static int cmp_call_dependecy(const void *c1, const void *c2)
960 ir_node *n1 = *(ir_node **) c1;
961 ir_node *n2 = *(ir_node **) c2;
964 Classical qsort() comparison function behavior:
965 0 if both elements are equal
966 1 if second is "smaller" that first
967 -1 if first is "smaller" that second
969 if (dependent_on(n1, n2))
972 if (dependent_on(n2, n1))
979 * Walker: links all Call/alloc/Free nodes to the Block they are contained.
981 static void link_calls_in_block_walker(ir_node *irn, void *data)
983 ir_opcode code = get_irn_opcode(irn);
985 if (code == iro_Call ||
986 (code == iro_Alloc && get_Alloc_where(irn) == stack_alloc) ||
987 (code == iro_Free && get_Free_where(irn) == stack_alloc)) {
988 be_abi_irg_t *env = data;
989 ir_node *bl = get_nodes_block(irn);
990 void *save = get_irn_link(bl);
992 if (code == iro_Call)
993 env->call->flags.bits.irg_is_leaf = 0;
995 set_irn_link(irn, save);
996 set_irn_link(bl, irn);
1002 * Process all Call nodes inside a basic block.
1003 * Note that the link field of the block must contain a linked list of all
1004 * Call nodes inside the Block. We first order this list according to data dependency
1005 * and that connect the calls together.
1007 static void process_calls_in_block(ir_node *bl, void *data)
1009 be_abi_irg_t *env = data;
1010 ir_node *curr_sp = env->init_sp;
1014 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
1015 obstack_ptr_grow(&env->obst, irn);
1017 /* If there were call nodes in the block. */
1021 ir_node *copy = NULL;
1024 nodes = obstack_finish(&env->obst);
1026 /* order the call nodes according to data dependency */
1027 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
1029 for(i = n - 1; i >= 0; --i) {
1030 ir_node *irn = nodes[i];
1032 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
1033 switch(get_irn_opcode(irn)) {
1035 curr_sp = adjust_call(env, irn, curr_sp, copy);
1038 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
1041 curr_sp = adjust_free(env, irn, curr_sp);
1048 obstack_free(&env->obst, nodes);
1050 /* Keep the last stack state in the block by tying it to Keep node */
1052 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
1053 pmap_insert(env->keep_map, bl, keep);
1056 set_irn_link(bl, curr_sp);
1057 } /* process_calls_in_block */
1060 * Adjust all call nodes in the graph to the ABI conventions.
1062 static void process_calls(be_abi_irg_t *env)
1064 ir_graph *irg = env->birg->irg;
1066 env->call->flags.bits.irg_is_leaf = 1;
1067 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
1069 ir_heights = heights_new(env->birg->irg);
1070 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
1071 heights_free(ir_heights);
1075 static ir_node *setup_frame(be_abi_irg_t *env)
1077 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1078 const arch_register_t *sp = isa->sp;
1079 const arch_register_t *bp = isa->bp;
1080 be_abi_call_flags_bits_t flags = env->call->flags.bits;
1081 ir_graph *irg = env->birg->irg;
1082 ir_node *bl = get_irg_start_block(irg);
1083 ir_node *no_mem = get_irg_no_mem(irg);
1084 ir_node *old_frame = get_irg_frame(irg);
1085 ir_node *stack = pmap_get(env->regs, (void *) sp);
1086 ir_node *frame = pmap_get(env->regs, (void *) bp);
1088 int stack_nr = get_Proj_proj(stack);
1090 if(flags.try_omit_fp) {
1091 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
1096 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
1098 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
1099 if(!flags.fp_free) {
1100 be_set_constr_single_reg(frame, -1, bp);
1101 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
1102 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
1105 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
1108 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
1109 env->init_sp = stack;
1110 set_irg_frame(irg, frame);
1111 edges_reroute(old_frame, frame, irg);
1116 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1118 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1119 const arch_register_t *sp = isa->sp;
1120 const arch_register_t *bp = isa->bp;
1121 ir_graph *irg = env->birg->irg;
1122 ir_node *ret_mem = get_Return_mem(ret);
1123 ir_node *frame = get_irg_frame(irg);
1124 ir_node *bl = get_nodes_block(ret);
1125 ir_node *stack = get_irn_link(bl);
1129 if(env->call->flags.bits.try_omit_fp) {
1130 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1134 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1135 be_set_constr_single_reg(stack, -1, sp);
1136 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1139 pmap_foreach(env->regs, ent) {
1140 const arch_register_t *reg = ent->key;
1141 ir_node *irn = ent->value;
1144 obstack_ptr_grow(&env->obst, stack);
1146 obstack_ptr_grow(&env->obst, frame);
1147 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1148 obstack_ptr_grow(obst, irn);
1155 * Computes the stack argument layout type.
1156 * Changes a possibly allocated value param type by moving
1157 * entities to the stack layout type.
1159 * @param env the ABI environment
1160 * @param call the current call ABI
1161 * @param method_type the method type
1162 * @param param_map an array mapping method arguments to the stack layout type
1164 * @return the stack argument layout type
1166 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type, ir_entity ***param_map)
1168 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1169 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1170 int n = get_method_n_params(method_type);
1171 int curr = inc > 0 ? 0 : n - 1;
1177 ir_type *val_param_tp = get_method_value_param_type(method_type);
1178 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1181 *param_map = map = obstack_alloc(&env->obst, n * sizeof(ir_entity *));
1182 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1183 for (i = 0; i < n; ++i, curr += inc) {
1184 ir_type *param_type = get_method_param_type(method_type, curr);
1185 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1188 if (arg->on_stack) {
1190 /* the entity was already created, move it to the param type */
1191 arg->stack_ent = get_method_value_param_ent(method_type, i);
1192 remove_struct_member(val_param_tp, arg->stack_ent);
1193 set_entity_owner(arg->stack_ent, res);
1194 add_struct_member(res, arg->stack_ent);
1195 /* must be automatic to set a fixed layout */
1196 set_entity_allocation(arg->stack_ent, allocation_automatic);
1199 snprintf(buf, sizeof(buf), "param_%d", i);
1200 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1202 ofs += arg->space_before;
1203 ofs = round_up2(ofs, arg->alignment);
1204 set_entity_offset(arg->stack_ent, ofs);
1205 ofs += arg->space_after;
1206 ofs += get_type_size_bytes(param_type);
1207 map[i] = arg->stack_ent;
1210 set_type_size_bytes(res, ofs);
1211 set_type_state(res, layout_fixed);
1216 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1219 struct obstack obst;
1221 obstack_init(&obst);
1223 /* Create a Perm after the RegParams node to delimit it. */
1224 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1225 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1230 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1231 const arch_register_t *reg = &cls->regs[j];
1232 ir_node *irn = pmap_get(regs, (void *) reg);
1234 if(irn && !arch_register_type_is(reg, ignore)) {
1236 obstack_ptr_grow(&obst, irn);
1237 set_irn_link(irn, (void *) reg);
1241 obstack_ptr_grow(&obst, NULL);
1242 in = obstack_finish(&obst);
1244 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1245 for(j = 0; j < n_regs; ++j) {
1246 ir_node *arg = in[j];
1247 arch_register_t *reg = get_irn_link(arg);
1248 pmap_insert(regs, reg, arg);
1249 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1252 obstack_free(&obst, in);
1255 obstack_free(&obst, NULL);
1260 const arch_register_t *reg;
1264 static int cmp_regs(const void *a, const void *b)
1266 const reg_node_map_t *p = a;
1267 const reg_node_map_t *q = b;
1269 if(p->reg->reg_class == q->reg->reg_class)
1270 return p->reg->index - q->reg->index;
1272 return p->reg->reg_class - q->reg->reg_class;
1275 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1278 int n = pmap_count(reg_map);
1280 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1282 pmap_foreach(reg_map, ent) {
1283 res[i].reg = ent->key;
1284 res[i].irn = ent->value;
1288 qsort(res, n, sizeof(res[0]), cmp_regs);
1293 * Creates a barrier.
1295 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1297 ir_graph *irg = env->birg->irg;
1298 int n_regs = pmap_count(regs);
1304 rm = reg_map_to_arr(&env->obst, regs);
1306 for(n = 0; n < n_regs; ++n)
1307 obstack_ptr_grow(&env->obst, rm[n].irn);
1310 obstack_ptr_grow(&env->obst, *mem);
1314 in = (ir_node **) obstack_finish(&env->obst);
1315 irn = be_new_Barrier(irg, bl, n, in);
1316 obstack_free(&env->obst, in);
1318 for(n = 0; n < n_regs; ++n) {
1319 const arch_register_t *reg = rm[n].reg;
1321 int pos = BE_OUT_POS(n);
1324 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1325 be_node_set_reg_class(irn, n, reg->reg_class);
1327 be_set_constr_single_reg(irn, n, reg);
1328 be_set_constr_single_reg(irn, pos, reg);
1329 be_node_set_reg_class(irn, pos, reg->reg_class);
1330 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1332 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1333 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1334 flags |= arch_irn_flags_ignore;
1336 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1337 flags |= arch_irn_flags_modify_sp;
1339 be_node_set_flags(irn, pos, flags);
1341 pmap_insert(regs, (void *) reg, proj);
1345 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1348 obstack_free(&env->obst, rm);
1353 * Creates a be_Return for a Return node.
1355 * @param @env the abi environment
1356 * @param irn the Return node or NULL if there was none
1357 * @param bl the block where the be_Retun should be placed
1358 * @param mem the current memory
1359 * @param n_res number of return results
1361 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1362 be_abi_call_t *call = env->call;
1363 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1365 pmap *reg_map = pmap_create();
1366 ir_node *keep = pmap_get(env->keep_map, bl);
1372 const arch_register_t **regs;
1376 get the valid stack node in this block.
1377 If we had a call in that block there is a Keep constructed by process_calls()
1378 which points to the last stack modification in that block. we'll use
1379 it then. Else we use the stack from the start block and let
1380 the ssa construction fix the usage.
1382 stack = be_abi_reg_map_get(env->regs, isa->sp);
1384 ir_node *bad = new_r_Bad(env->birg->irg);
1385 stack = get_irn_n(keep, 0);
1386 set_nodes_block(keep, bad);
1387 set_irn_n(keep, 0, bad);
1388 // exchange(keep, new_r_Bad(env->birg->irg));
1391 /* Insert results for Return into the register map. */
1392 for(i = 0; i < n_res; ++i) {
1393 ir_node *res = get_Return_res(irn, i);
1394 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1395 assert(arg->in_reg && "return value must be passed in register");
1396 pmap_insert(reg_map, (void *) arg->reg, res);
1399 /* Add uses of the callee save registers. */
1400 pmap_foreach(env->regs, ent) {
1401 const arch_register_t *reg = ent->key;
1402 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1403 pmap_insert(reg_map, ent->key, ent->value);
1406 be_abi_reg_map_set(reg_map, isa->sp, stack);
1408 /* Make the Epilogue node and call the arch's epilogue maker. */
1409 create_barrier(env, bl, &mem, reg_map, 1);
1410 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1413 Maximum size of the in array for Return nodes is
1414 return args + callee save/ignore registers + memory + stack pointer
1416 in_max = pmap_count(reg_map) + n_res + 2;
1418 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1419 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1422 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1427 /* clear SP entry, since it has already been grown. */
1428 pmap_insert(reg_map, (void *) isa->sp, NULL);
1429 for(i = 0; i < n_res; ++i) {
1430 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1432 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1433 regs[n++] = arg->reg;
1435 /* Clear the map entry to mark the register as processed. */
1436 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1439 /* grow the rest of the stuff. */
1440 pmap_foreach(reg_map, ent) {
1443 regs[n++] = ent->key;
1447 /* The in array for the new back end return is now ready. */
1448 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1450 /* Set the register classes of the return's parameter accordingly. */
1451 for(i = 0; i < n; ++i)
1453 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1455 /* Free the space of the Epilog's in array and the register <-> proj map. */
1456 obstack_free(&env->obst, in);
1457 pmap_destroy(reg_map);
1462 typedef struct lower_frame_sels_env_t {
1464 ir_entity *value_param_list; /**< the list of all value param entities */
1465 } lower_frame_sels_env_t;
1468 * Walker: Replaces Sels of frame type and
1469 * value param type entities by FrameAddress.
1471 static void lower_frame_sels_walker(ir_node *irn, void *data)
1473 lower_frame_sels_env_t *ctx = data;
1476 ir_graph *irg = current_ir_graph;
1477 ir_node *frame = get_irg_frame(irg);
1478 ir_node *param_base = get_irg_value_param_base(irg);
1479 ir_node *ptr = get_Sel_ptr(irn);
1481 if (ptr == frame || ptr == param_base) {
1482 be_abi_irg_t *env = ctx->env;
1483 ir_entity *ent = get_Sel_entity(irn);
1484 ir_node *bl = get_nodes_block(irn);
1487 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1490 /* check, if it's a param sel and if have not seen this entity immediatly before */
1491 if (ptr == param_base && ctx->value_param_list != ent) {
1492 set_entity_link(ent, ctx->value_param_list);
1493 ctx->value_param_list = ent;
1500 * Check if a value parameter is transmitted as a register.
1501 * This might happen if the address of an parameter is taken which is
1502 * transmitted in registers.
1504 * Note that on some architectures this case must be handled specially
1505 * because the place of the backing store is determined by their ABI.
1507 * In the default case we move the entity to the frame type and create
1508 * a backing store into the first block.
1510 static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_param_list) {
1511 be_abi_call_t *call = env->call;
1512 ir_graph *irg = env->birg->irg;
1513 ir_entity *ent, *next_ent, *new_list;
1515 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1518 for (ent = value_param_list; ent; ent = next_ent) {
1519 int i = get_struct_member_index(get_entity_owner(ent), ent);
1520 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1522 next_ent = get_entity_link(ent);
1524 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1525 set_entity_link(ent, new_list);
1530 /* ok, change the graph */
1531 ir_node *start_bl = get_irg_start_block(irg);
1532 ir_node *first_bl = NULL;
1533 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1534 const ir_edge_t *edge;
1535 optimization_state_t state;
1538 foreach_block_succ(start_bl, edge) {
1539 ir_node *succ = get_edge_src_irn(edge);
1540 if (start_bl != succ) {
1546 /* we had already removed critical edges, so the following
1547 assertion should be always true. */
1548 assert(get_Block_n_cfgpreds(first_bl) == 1);
1550 /* now create backing stores */
1551 frame = get_irg_frame(irg);
1552 imem = get_irg_initial_mem(irg);
1554 save_optimization_state(&state);
1556 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1557 restore_optimization_state(&state);
1559 /* reroute all edges to the new memory source */
1560 edges_reroute(imem, nmem, irg);
1564 args = get_irg_args(irg);
1565 args_bl = get_nodes_block(args);
1566 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1567 int i = get_struct_member_index(get_entity_owner(ent), ent);
1568 ir_type *tp = get_entity_type(ent);
1569 ir_mode *mode = get_type_mode(tp);
1572 /* address for the backing store */
1573 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1576 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1578 /* the backing store itself */
1579 store = new_r_Store(irg, first_bl, mem, addr,
1580 new_r_Proj(irg, args_bl, args, mode, i));
1582 /* the new memory Proj gets the last Proj from store */
1583 set_Proj_pred(nmem, store);
1584 set_Proj_proj(nmem, pn_Store_M);
1586 /* move all entities to the frame type */
1587 frame_tp = get_irg_frame_type(irg);
1588 offset = get_type_size_bytes(frame_tp);
1589 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1590 ir_type *tp = get_entity_type(ent);
1591 int align = get_type_alignment_bytes(tp);
1593 offset += align - 1;
1595 set_entity_owner(ent, frame_tp);
1596 add_class_member(frame_tp, ent);
1597 /* must be automatic to set a fixed layout */
1598 set_entity_allocation(ent, allocation_automatic);
1599 set_entity_offset(ent, offset);
1600 offset += get_type_size_bytes(tp);
1602 set_type_size_bytes(frame_tp, offset);
1607 * The start block has no jump, instead it has an initial exec Proj.
1608 * The backend wants to handle all blocks the same way, so we replace
1609 * the out cfg edge with a real jump.
1611 static void fix_start_block(ir_node *block, void *env) {
1614 ir_node *start_block;
1617 /* we processed the start block, return */
1621 irg = get_irn_irg(block);
1622 start_block = get_irg_start_block(irg);
1624 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
1625 ir_node *pred = get_Block_cfgpred(block, i);
1626 ir_node *pred_block = get_nodes_block(pred);
1628 /* ok, we are in the block, having start as cfg predecessor */
1629 if (pred_block == start_block) {
1630 ir_node *jump = new_r_Jmp(irg, pred_block);
1631 set_Block_cfgpred(block, i, jump);
1638 * Modify the irg itself and the frame type.
1640 static void modify_irg(be_abi_irg_t *env)
1642 be_abi_call_t *call = env->call;
1643 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1644 const arch_register_t *sp = arch_isa_sp(isa);
1645 ir_graph *irg = env->birg->irg;
1646 ir_node *bl = get_irg_start_block(irg);
1647 ir_node *end = get_irg_end_block(irg);
1648 ir_node *mem = get_irg_initial_mem(irg);
1649 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1650 pset *dont_save = pset_new_ptr(8);
1656 const arch_register_t *fp_reg;
1657 ir_node *frame_pointer;
1659 ir_node *reg_params_bl;
1662 ir_node *value_param_base;
1663 const ir_edge_t *edge;
1664 ir_type *arg_type, *bet_type;
1665 lower_frame_sels_env_t ctx;
1666 ir_entity **param_map;
1668 bitset_t *used_proj_nr;
1669 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1671 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1673 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1675 ctx.value_param_list = NULL;
1676 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1678 /* value_param_base anchor is not needed anymore now */
1679 value_param_base = get_irg_value_param_base(irg);
1680 be_kill_node(value_param_base);
1681 set_irg_value_param_base(irg, new_r_Bad(irg));
1683 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1684 env->regs = pmap_create();
1686 used_proj_nr = bitset_alloca(1024);
1687 n_params = get_method_n_params(method_type);
1688 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1689 memset(args, 0, n_params * sizeof(args[0]));
1691 /* Check if a value parameter is transmitted as a register.
1692 * This might happen if the address of an parameter is taken which is
1693 * transmitted in registers.
1695 * Note that on some architectures this case must be handled specially
1696 * because the place of the backing store is determined by their ABI.
1698 * In the default case we move the entity to the frame type and create
1699 * a backing store into the first block.
1701 fix_address_of_parameter_access(env, ctx.value_param_list);
1703 /* Fill the argument vector */
1704 arg_tuple = get_irg_args(irg);
1705 foreach_out_edge(arg_tuple, edge) {
1706 ir_node *irn = get_edge_src_irn(edge);
1707 int nr = get_Proj_proj(irn);
1709 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1712 arg_type = compute_arg_type(env, call, method_type, ¶m_map);
1713 bet_type = call->cb->get_between_type(env->cb);
1714 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir, param_map);
1716 /* Count the register params and add them to the number of Projs for the RegParams node */
1717 for(i = 0; i < n_params; ++i) {
1718 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1719 if(arg->in_reg && args[i]) {
1720 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1721 assert(i == get_Proj_proj(args[i]));
1723 /* For now, associate the register with the old Proj from Start representing that argument. */
1724 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1725 bitset_set(used_proj_nr, i);
1726 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1730 /* Collect all callee-save registers */
1731 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1732 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1733 for(j = 0; j < cls->n_regs; ++j) {
1734 const arch_register_t *reg = &cls->regs[j];
1735 if(arch_register_type_is(reg, callee_save))
1736 pmap_insert(env->regs, (void *) reg, NULL);
1740 pmap_insert(env->regs, (void *) sp, NULL);
1741 pmap_insert(env->regs, (void *) isa->bp, NULL);
1742 reg_params_bl = get_irg_start_block(irg);
1743 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1744 add_irn_dep(env->reg_params, get_irg_start(irg));
1747 * make proj nodes for the callee save registers.
1748 * memorize them, since Return nodes get those as inputs.
1750 * Note, that if a register corresponds to an argument, the regs map contains
1751 * the old Proj from start for that argument.
1754 rm = reg_map_to_arr(&env->obst, env->regs);
1755 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1756 arch_register_t *reg = (void *) rm[i].reg;
1757 ir_mode *mode = reg->reg_class->mode;
1759 int pos = BE_OUT_POS((int) nr);
1765 bitset_set(used_proj_nr, nr);
1766 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1767 pmap_insert(env->regs, (void *) reg, proj);
1768 be_set_constr_single_reg(env->reg_params, pos, reg);
1769 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1772 * If the register is an ignore register,
1773 * The Proj for that register shall also be ignored during register allocation.
1775 if(arch_register_type_is(reg, ignore))
1776 flags |= arch_irn_flags_ignore;
1779 flags |= arch_irn_flags_modify_sp;
1781 be_node_set_flags(env->reg_params, pos, flags);
1783 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1785 obstack_free(&env->obst, rm);
1787 /* Generate the Prologue */
1788 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1790 /* do the stack allocation BEFORE the barrier, or spill code
1791 might be added before it */
1792 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1793 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1794 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1796 env->start_barrier = barrier = create_barrier(env, bl, &mem, env->regs, 0);
1798 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1799 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1801 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1802 set_irg_frame(irg, frame_pointer);
1803 pset_insert_ptr(env->ignore_regs, fp_reg);
1805 set_irg_initial_mem(irg, mem);
1807 /* Now, introduce stack param nodes for all parameters passed on the stack */
1808 for(i = 0; i < n_params; ++i) {
1809 ir_node *arg_proj = args[i];
1810 ir_node *repl = NULL;
1812 if(arg_proj != NULL) {
1813 be_abi_call_arg_t *arg;
1814 ir_type *param_type;
1815 int nr = get_Proj_proj(arg_proj);
1817 nr = MIN(nr, n_params);
1818 arg = get_call_arg(call, 0, nr);
1819 param_type = get_method_param_type(method_type, nr);
1822 repl = pmap_get(env->regs, (void *) arg->reg);
1825 else if(arg->on_stack) {
1826 /* For atomic parameters which are actually used, we create a StackParam node. */
1827 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1828 ir_mode *mode = get_type_mode(param_type);
1829 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1830 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1833 /* The stack parameter is not primitive (it is a struct or array),
1834 we thus will create a node representing the parameter's address
1837 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1841 assert(repl != NULL);
1842 exchange(args[i], repl);
1846 /* the arg proj is not needed anymore now */
1847 assert(get_irn_n_edges(arg_tuple) == 0);
1848 be_kill_node(arg_tuple);
1849 set_irg_args(irg, new_rd_Bad(irg));
1851 /* All Return nodes hang on the End node, so look for them there. */
1852 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1853 ir_node *irn = get_Block_cfgpred(end, i);
1855 if (is_Return(irn)) {
1856 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1860 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1861 the code is dead and will never be executed. */
1863 del_pset(dont_save);
1864 obstack_free(&env->obst, args);
1866 /* handle start block here (place a jump in the block) */
1868 irg_block_walk_graph(irg, fix_start_block, NULL, &temp);
1871 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1873 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1874 ir_node *old_frame = get_irg_frame(birg->irg);
1875 ir_graph *irg = birg->irg;
1879 optimization_state_t state;
1881 be_omit_fp = birg->main_env->options->omit_fp;
1883 obstack_init(&env->obst);
1885 env->isa = birg->main_env->arch_env->isa;
1886 env->method_type = get_entity_type(get_irg_entity(irg));
1887 env->call = be_abi_call_new(env->isa->sp->reg_class);
1888 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1890 env->ignore_regs = pset_new_ptr_default();
1891 env->keep_map = pmap_create();
1892 env->dce_survivor = new_survive_dce();
1894 env->stack_phis = pset_new_ptr(16);
1895 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1896 to another Unknown or the stack pointer gets used */
1897 save_optimization_state(&state);
1899 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1900 restore_optimization_state(&state);
1901 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1903 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1904 env->irn_ops.impl = &abi_irn_ops;
1906 /* Lower all call nodes in the IRG. */
1910 Beware: init backend abi call object after processing calls,
1911 otherwise some information might be not yet available.
1913 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1915 /* Process the IRG */
1918 /* We don't need the keep map anymore. */
1919 pmap_destroy(env->keep_map);
1921 /* reroute the stack origin of the calls to the true stack origin. */
1922 exchange(dummy, env->init_sp);
1923 exchange(old_frame, get_irg_frame(irg));
1925 /* Make some important node pointers survive the dead node elimination. */
1926 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1927 pmap_foreach(env->regs, ent)
1928 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1930 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1932 env->call->cb->done(env->cb);
1937 void be_abi_free(be_abi_irg_t *env)
1939 free_survive_dce(env->dce_survivor);
1940 del_pset(env->stack_phis);
1941 del_pset(env->ignore_regs);
1942 pmap_destroy(env->regs);
1943 obstack_free(&env->obst, NULL);
1944 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1948 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1950 arch_register_t *reg;
1952 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1953 if(reg->reg_class == cls)
1954 bitset_set(bs, reg->index);
1957 /* Returns the stack layout from a abi environment. */
1958 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi) {
1965 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1966 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1967 | _| | |> < ___) | || (_| | (__| <
1968 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1972 struct fix_stack_walker_info {
1974 const arch_env_t *aenv;
1978 * Walker. Collect all stack modifying nodes.
1980 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1982 struct fix_stack_walker_info *info = data;
1987 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1988 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1989 pset_insert_ptr(info->nodes, irn);
1993 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1995 pset *stack_nodes = pset_new_ptr(16);
1996 struct fix_stack_walker_info info;
1999 info.nodes = stack_nodes;
2000 info.aenv = env->birg->main_env->arch_env;
2002 be_assure_dom_front(env->birg);
2005 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
2006 pset_insert_ptr(stack_nodes, env->init_sp);
2008 if (env->call->cb->collect_stack_phis)
2009 collect_phis = env->call->cb->collect_stack_phis(env->cb);
2010 be_ssa_constr_set_phis(env->birg->dom_front, lv, stack_nodes, collect_phis ? env->stack_phis : NULL);
2011 del_pset(stack_nodes);
2014 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
2016 const arch_env_t *arch_env = env->birg->main_env->arch_env;
2017 int omit_fp = env->call->flags.bits.try_omit_fp;
2020 sched_foreach(bl, irn) {
2023 Check, if the node relates to an entity on the stack frame.
2024 If so, set the true offset (including the bias) for that
2027 ir_entity *ent = arch_get_frame_entity(arch_env, irn);
2029 int offset = get_stack_entity_offset(env->frame, ent, bias);
2030 arch_set_frame_offset(arch_env, irn, offset);
2031 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
2035 If the node modifies the stack pointer by a constant offset,
2036 record that in the bias.
2038 if(arch_irn_is(arch_env, irn, modify_sp)) {
2039 int ofs = arch_get_sp_bias(arch_env, irn);
2041 if(be_is_IncSP(irn)) {
2042 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
2043 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
2044 be_set_IncSP_offset(irn, ofs);
2045 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
2046 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
2047 be_set_IncSP_offset(irn, ofs);
2060 * A helper struct for the bias walker.
2063 be_abi_irg_t *env; /**< The ABI irg environment. */
2064 int start_block_bias; /**< The bias at the end of the start block. */
2065 ir_node *start_block; /**< The start block of the current graph. */
2069 * Block-Walker: fix all stack offsets
2071 static void stack_bias_walker(ir_node *bl, void *data)
2073 struct bias_walk *bw = data;
2074 if (bl != bw->start_block) {
2075 process_stack_bias(bw->env, bl, bw->start_block_bias);
2079 void be_abi_fix_stack_bias(be_abi_irg_t *env)
2081 ir_graph *irg = env->birg->irg;
2082 struct bias_walk bw;
2084 stack_frame_compute_initial_offset(env->frame);
2085 // stack_layout_dump(stdout, env->frame);
2087 /* Determine the stack bias at the end of the start block. */
2088 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
2090 /* fix the bias is all other blocks */
2092 bw.start_block = get_irg_start_block(irg);
2093 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
2096 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
2098 assert(arch_register_type_is(reg, callee_save));
2099 assert(pmap_contains(abi->regs, (void *) reg));
2100 return pmap_get(abi->regs, (void *) reg);
2103 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg)
2105 assert(arch_register_type_is(reg, ignore));
2106 assert(pmap_contains(abi->regs, (void *) reg));
2107 return pmap_get(abi->regs, (void *) reg);
2110 ir_node *be_abi_get_start_barrier(be_abi_irg_t *abi)
2112 return abi->start_barrier;
2116 _____ _____ _ _ _ _ _ _
2117 |_ _| __ \| \ | | | | | | | | |
2118 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
2119 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
2120 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
2121 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
2123 for Phi nodes which are created due to stack modifying nodes
2124 such as IncSP, AddSP and SetSP.
2126 These Phis are always to be ignored by the reg alloc and are
2127 fixed on the SP register of the ISA.
2130 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
2132 const be_abi_irg_t *abi = get_abi_from_handler(handler);
2133 const void *res = NULL;
2135 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
2136 res = &abi->irn_ops;
2141 static void be_abi_limited(void *data, bitset_t *bs)
2143 be_abi_irg_t *abi = data;
2144 bitset_clear_all(bs);
2145 bitset_set(bs, abi->isa->sp->index);
2148 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)
2150 be_abi_irg_t *abi = get_abi_from_ops(self);
2151 const arch_register_t *reg = abi->isa->sp;
2153 memset(req, 0, sizeof(req[0]));
2155 if(pos == BE_OUT_POS(0)) {
2156 req->cls = reg->reg_class;
2157 req->type = arch_register_req_type_limited;
2158 req->limited = be_abi_limited;
2159 req->limited_env = abi;
2162 else if(pos >= 0 && pos < get_irn_arity(irn)) {
2163 req->cls = reg->reg_class;
2164 req->type = arch_register_req_type_normal;
2170 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
2174 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
2176 const be_abi_irg_t *abi = get_abi_from_ops(self);
2177 return abi->isa->sp;
2180 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
2182 return arch_irn_class_normal;
2185 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2187 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2190 static ir_entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2195 static void abi_set_frame_entity(const void *_self, ir_node *irn, ir_entity *ent)
2199 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2203 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2208 static const arch_irn_ops_if_t abi_irn_ops = {
2209 abi_get_irn_reg_req,
2214 abi_get_frame_entity,
2215 abi_set_frame_entity,
2216 abi_set_frame_offset,
2218 NULL, /* get_inverse */
2219 NULL, /* get_op_estimated_cost */
2220 NULL, /* possible_memory_operand */
2221 NULL, /* perform_memory_operand */
2224 static const arch_irn_handler_t abi_irn_handler = {
2229 * Returns non-zero if the ABI has omitted the frame pointer in
2230 * the current graph.
2232 int be_abi_omit_fp(const be_abi_irg_t *abi) {
2233 return abi->call->flags.bits.try_omit_fp;