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 int pn = get_Proj_proj(res_projs[i]);
665 /* Correct Proj number since it has been adjusted! (see above) */
666 const be_abi_call_arg_t *arg = get_call_arg(call, 1, pn - pn_Call_max);
668 /* Matze: we need the information about the real mode for later
669 * transforms (signed/unsigend compares, stores...), so leave the fixup
670 * for the backend transform phase... */
673 const arch_register_class_t *cls = arch_register_get_class(arg->reg);
674 ir_mode *mode = arch_register_class_mode(cls);
675 set_irn_mode(irn, mode);
679 be_set_constr_single_reg(low_call, BE_OUT_POS(pn), arg->reg);
681 obstack_free(obst, in);
682 exchange(irn, low_call);
684 /* redirect the result projs to the lowered call instead of the Proj_T */
685 for (i = 0; res_projs[i]; ++i)
686 set_Proj_pred(res_projs[i], low_call);
688 /* set the now unnecessary projT to bad */
689 if(res_proj != NULL) {
690 be_kill_node(res_proj);
693 /* Make additional projs for the caller save registers
694 and the Keep node which keeps them alive. */
695 if (pset_count(caller_save) > 0) {
696 const arch_register_t *reg;
700 for (reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
701 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
703 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
704 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
706 /* a call can produce ignore registers, in this case set the flag and register for the Proj */
707 if (arch_register_type_is(reg, ignore)) {
708 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
709 be_node_set_flags(low_call, BE_OUT_POS(curr_res_proj), arch_irn_flags_ignore);
712 set_irn_link(proj, (void *) reg);
713 obstack_ptr_grow(obst, proj);
717 /* create the Keep for the caller save registers */
718 in = (ir_node **) obstack_finish(obst);
719 keep = be_new_Keep(NULL, irg, bl, n, in);
720 for (i = 0; i < n; ++i) {
721 const arch_register_t *reg = get_irn_link(in[i]);
722 be_node_set_reg_class(keep, i, reg->reg_class);
724 obstack_free(obst, in);
727 /* Clean up the stack. */
729 ir_node *mem_proj = NULL;
731 foreach_out_edge(low_call, edge) {
732 ir_node *irn = get_edge_src_irn(edge);
733 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
740 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
741 keep_alive(mem_proj);
744 /* Clean up the stack frame if we allocated it */
746 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
747 add_irn_dep(curr_sp, mem_proj);
749 add_irn_dep(curr_sp, alloca_copy);
755 be_abi_call_free(call);
756 obstack_free(obst, pos);
758 del_pset(caller_save);
765 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
767 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
775 const ir_edge_t *edge;
782 if (get_Alloc_where(alloc) != stack_alloc) {
787 block = get_nodes_block(alloc);
788 irg = get_irn_irg(block);
791 type = get_Alloc_type(alloc);
793 foreach_out_edge(alloc, edge) {
794 ir_node *irn = get_edge_src_irn(edge);
796 assert(is_Proj(irn));
797 switch(get_Proj_proj(irn)) {
809 /* Beware: currently Alloc nodes without a result might happen,
810 only escape analysis kills them and this phase runs only for object
811 oriented source. We kill the Alloc here. */
812 if (alloc_res == NULL && alloc_mem) {
813 exchange(alloc_mem, get_Alloc_mem(alloc));
817 /* we might need to multiply the size with the element size */
818 if(type != get_unknown_type() && get_type_size_bytes(type) != 1) {
819 tarval *tv = new_tarval_from_long(get_type_size_bytes(type), mode_Iu);
820 ir_node *cnst = new_rd_Const(NULL, irg, block, mode_Iu, tv);
821 ir_node *mul = new_rd_Mul(NULL, irg, block, get_Alloc_size(alloc),
825 size = get_Alloc_size(alloc);
828 /* The stack pointer will be modified in an unknown manner.
829 We cannot omit it. */
830 env->call->flags.bits.try_omit_fp = 0;
831 new_alloc = be_new_AddSP(env->isa->sp, irg, block, curr_sp, size);
833 if(alloc_mem != NULL) {
837 addsp_mem = new_r_Proj(irg, block, new_alloc, mode_M, pn_be_AddSP_M);
839 // We need to sync the output mem of the AddSP with the input mem
840 // edge into the alloc node
841 ins[0] = get_Alloc_mem(alloc);
843 sync = new_r_Sync(irg, block, 2, ins);
845 exchange(alloc_mem, sync);
848 exchange(alloc, new_alloc);
850 /* fix projnum of alloca res */
851 set_Proj_proj(alloc_res, pn_be_AddSP_res);
853 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
855 /* copy the address away, since it could be used after further stack pointer modifications. */
856 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
857 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, block, curr_sp);
859 /* Let all users of the Alloc() result now point to the copy. */
860 edges_reroute(alloc_res, copy, irg);
862 /* Rewire the copy appropriately. */
863 set_irn_n(copy, be_pos_Copy_op, addr);
872 * The Free is transformed into a back end free node and connected to the stack nodes.
874 static ir_node *adjust_free(be_abi_irg_t *env, ir_node *free, ir_node *curr_sp)
878 ir_node *subsp, *mem, *res, *size, *sync;
882 if (get_Free_where(free) != stack_alloc) {
887 block = get_nodes_block(free);
888 irg = get_irn_irg(block);
889 type = get_Free_type(free);
891 /* we might need to multiply the size with the element size */
892 if(type != get_unknown_type() && get_type_size_bytes(type) != 1) {
893 tarval *tv = new_tarval_from_long(get_type_size_bytes(type), mode_Iu);
894 ir_node *cnst = new_rd_Const(NULL, irg, block, mode_Iu, tv);
895 ir_node *mul = new_rd_Mul(NULL, irg, block, get_Free_size(free),
899 size = get_Free_size(free);
902 /* The stack pointer will be modified in an unknown manner.
903 We cannot omit it. */
904 env->call->flags.bits.try_omit_fp = 0;
905 subsp = be_new_SubSP(env->isa->sp, irg, block, curr_sp, size);
907 mem = new_r_Proj(irg, block, subsp, mode_M, pn_be_SubSP_M);
908 res = new_r_Proj(irg, block, subsp, mode_P_data, pn_be_SubSP_res);
910 /* we need to sync the memory */
911 in[0] = get_Free_mem(free);
913 sync = new_r_Sync(irg, block, 2, in);
915 /* and make the AddSP dependent on the former memory */
916 add_irn_dep(subsp, get_Free_mem(free));
919 exchange(free, sync);
925 /* the following function is replaced by the usage of the heights module */
928 * Walker for dependent_on().
929 * This function searches a node tgt recursively from a given node
930 * but is restricted to the given block.
931 * @return 1 if tgt was reachable from curr, 0 if not.
933 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
937 if (get_nodes_block(curr) != bl)
943 /* Phi functions stop the recursion inside a basic block */
944 if (! is_Phi(curr)) {
945 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
946 if (check_dependence(get_irn_n(curr, i), tgt, bl))
956 * Check if a node is somehow data dependent on another one.
957 * both nodes must be in the same basic block.
958 * @param n1 The first node.
959 * @param n2 The second node.
960 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
962 static int dependent_on(ir_node *n1, ir_node *n2)
964 ir_node *bl = get_nodes_block(n1);
966 assert(bl == get_nodes_block(n2));
968 return heights_reachable_in_block(ir_heights, n1, n2);
969 //return check_dependence(n1, n2, bl);
972 static int cmp_call_dependecy(const void *c1, const void *c2)
974 ir_node *n1 = *(ir_node **) c1;
975 ir_node *n2 = *(ir_node **) c2;
978 Classical qsort() comparison function behavior:
979 0 if both elements are equal
980 1 if second is "smaller" that first
981 -1 if first is "smaller" that second
983 if (dependent_on(n1, n2))
986 if (dependent_on(n2, n1))
993 * Walker: links all Call/alloc/Free nodes to the Block they are contained.
995 static void link_calls_in_block_walker(ir_node *irn, void *data)
997 ir_opcode code = get_irn_opcode(irn);
999 if (code == iro_Call ||
1000 (code == iro_Alloc && get_Alloc_where(irn) == stack_alloc) ||
1001 (code == iro_Free && get_Free_where(irn) == stack_alloc)) {
1002 be_abi_irg_t *env = data;
1003 ir_node *bl = get_nodes_block(irn);
1004 void *save = get_irn_link(bl);
1006 if (code == iro_Call)
1007 env->call->flags.bits.irg_is_leaf = 0;
1009 set_irn_link(irn, save);
1010 set_irn_link(bl, irn);
1016 * Process all Call nodes inside a basic block.
1017 * Note that the link field of the block must contain a linked list of all
1018 * Call nodes inside the Block. We first order this list according to data dependency
1019 * and that connect the calls together.
1021 static void process_calls_in_block(ir_node *bl, void *data)
1023 be_abi_irg_t *env = data;
1024 ir_node *curr_sp = env->init_sp;
1028 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
1029 obstack_ptr_grow(&env->obst, irn);
1031 /* If there were call nodes in the block. */
1035 ir_node *copy = NULL;
1038 nodes = obstack_finish(&env->obst);
1040 /* order the call nodes according to data dependency */
1041 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
1043 for(i = n - 1; i >= 0; --i) {
1044 ir_node *irn = nodes[i];
1046 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
1047 switch(get_irn_opcode(irn)) {
1049 curr_sp = adjust_call(env, irn, curr_sp, copy);
1052 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
1055 curr_sp = adjust_free(env, irn, curr_sp);
1062 obstack_free(&env->obst, nodes);
1064 /* Keep the last stack state in the block by tying it to Keep node */
1066 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
1067 pmap_insert(env->keep_map, bl, keep);
1070 set_irn_link(bl, curr_sp);
1071 } /* process_calls_in_block */
1074 * Adjust all call nodes in the graph to the ABI conventions.
1076 static void process_calls(be_abi_irg_t *env)
1078 ir_graph *irg = env->birg->irg;
1080 env->call->flags.bits.irg_is_leaf = 1;
1081 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
1083 ir_heights = heights_new(env->birg->irg);
1084 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
1085 heights_free(ir_heights);
1089 static ir_node *setup_frame(be_abi_irg_t *env)
1091 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1092 const arch_register_t *sp = isa->sp;
1093 const arch_register_t *bp = isa->bp;
1094 be_abi_call_flags_bits_t flags = env->call->flags.bits;
1095 ir_graph *irg = env->birg->irg;
1096 ir_node *bl = get_irg_start_block(irg);
1097 ir_node *no_mem = get_irg_no_mem(irg);
1098 ir_node *old_frame = get_irg_frame(irg);
1099 ir_node *stack = pmap_get(env->regs, (void *) sp);
1100 ir_node *frame = pmap_get(env->regs, (void *) bp);
1102 int stack_nr = get_Proj_proj(stack);
1104 if(flags.try_omit_fp) {
1105 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
1110 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
1112 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
1113 if(!flags.fp_free) {
1114 be_set_constr_single_reg(frame, -1, bp);
1115 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
1116 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
1119 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
1122 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
1123 env->init_sp = stack;
1124 set_irg_frame(irg, frame);
1125 edges_reroute(old_frame, frame, irg);
1130 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1132 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1133 const arch_register_t *sp = isa->sp;
1134 const arch_register_t *bp = isa->bp;
1135 ir_graph *irg = env->birg->irg;
1136 ir_node *ret_mem = get_Return_mem(ret);
1137 ir_node *frame = get_irg_frame(irg);
1138 ir_node *bl = get_nodes_block(ret);
1139 ir_node *stack = get_irn_link(bl);
1143 if(env->call->flags.bits.try_omit_fp) {
1144 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1148 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1149 be_set_constr_single_reg(stack, -1, sp);
1150 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1153 pmap_foreach(env->regs, ent) {
1154 const arch_register_t *reg = ent->key;
1155 ir_node *irn = ent->value;
1158 obstack_ptr_grow(&env->obst, stack);
1160 obstack_ptr_grow(&env->obst, frame);
1161 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1162 obstack_ptr_grow(obst, irn);
1169 * Computes the stack argument layout type.
1170 * Changes a possibly allocated value param type by moving
1171 * entities to the stack layout type.
1173 * @param env the ABI environment
1174 * @param call the current call ABI
1175 * @param method_type the method type
1176 * @param param_map an array mapping method arguments to the stack layout type
1178 * @return the stack argument layout type
1180 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type, ir_entity ***param_map)
1182 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1183 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1184 int n = get_method_n_params(method_type);
1185 int curr = inc > 0 ? 0 : n - 1;
1191 ir_type *val_param_tp = get_method_value_param_type(method_type);
1192 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1195 *param_map = map = obstack_alloc(&env->obst, n * sizeof(ir_entity *));
1196 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1197 for (i = 0; i < n; ++i, curr += inc) {
1198 ir_type *param_type = get_method_param_type(method_type, curr);
1199 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1202 if (arg->on_stack) {
1204 /* the entity was already created, move it to the param type */
1205 arg->stack_ent = get_method_value_param_ent(method_type, i);
1206 remove_struct_member(val_param_tp, arg->stack_ent);
1207 set_entity_owner(arg->stack_ent, res);
1208 add_struct_member(res, arg->stack_ent);
1209 /* must be automatic to set a fixed layout */
1210 set_entity_allocation(arg->stack_ent, allocation_automatic);
1213 snprintf(buf, sizeof(buf), "param_%d", i);
1214 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1216 ofs += arg->space_before;
1217 ofs = round_up2(ofs, arg->alignment);
1218 set_entity_offset(arg->stack_ent, ofs);
1219 ofs += arg->space_after;
1220 ofs += get_type_size_bytes(param_type);
1221 map[i] = arg->stack_ent;
1224 set_type_size_bytes(res, ofs);
1225 set_type_state(res, layout_fixed);
1230 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1233 struct obstack obst;
1235 obstack_init(&obst);
1237 /* Create a Perm after the RegParams node to delimit it. */
1238 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1239 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1244 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1245 const arch_register_t *reg = &cls->regs[j];
1246 ir_node *irn = pmap_get(regs, (void *) reg);
1248 if(irn && !arch_register_type_is(reg, ignore)) {
1250 obstack_ptr_grow(&obst, irn);
1251 set_irn_link(irn, (void *) reg);
1255 obstack_ptr_grow(&obst, NULL);
1256 in = obstack_finish(&obst);
1258 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1259 for(j = 0; j < n_regs; ++j) {
1260 ir_node *arg = in[j];
1261 arch_register_t *reg = get_irn_link(arg);
1262 pmap_insert(regs, reg, arg);
1263 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1266 obstack_free(&obst, in);
1269 obstack_free(&obst, NULL);
1274 const arch_register_t *reg;
1278 static int cmp_regs(const void *a, const void *b)
1280 const reg_node_map_t *p = a;
1281 const reg_node_map_t *q = b;
1283 if(p->reg->reg_class == q->reg->reg_class)
1284 return p->reg->index - q->reg->index;
1286 return p->reg->reg_class - q->reg->reg_class;
1289 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1292 int n = pmap_count(reg_map);
1294 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1296 pmap_foreach(reg_map, ent) {
1297 res[i].reg = ent->key;
1298 res[i].irn = ent->value;
1302 qsort(res, n, sizeof(res[0]), cmp_regs);
1307 * Creates a barrier.
1309 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1311 ir_graph *irg = env->birg->irg;
1312 int n_regs = pmap_count(regs);
1318 rm = reg_map_to_arr(&env->obst, regs);
1320 for(n = 0; n < n_regs; ++n)
1321 obstack_ptr_grow(&env->obst, rm[n].irn);
1324 obstack_ptr_grow(&env->obst, *mem);
1328 in = (ir_node **) obstack_finish(&env->obst);
1329 irn = be_new_Barrier(irg, bl, n, in);
1330 obstack_free(&env->obst, in);
1332 for(n = 0; n < n_regs; ++n) {
1333 const arch_register_t *reg = rm[n].reg;
1335 int pos = BE_OUT_POS(n);
1338 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1339 be_node_set_reg_class(irn, n, reg->reg_class);
1341 be_set_constr_single_reg(irn, n, reg);
1342 be_set_constr_single_reg(irn, pos, reg);
1343 be_node_set_reg_class(irn, pos, reg->reg_class);
1344 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1346 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1347 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1348 flags |= arch_irn_flags_ignore;
1350 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1351 flags |= arch_irn_flags_modify_sp;
1353 be_node_set_flags(irn, pos, flags);
1355 pmap_insert(regs, (void *) reg, proj);
1359 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1362 obstack_free(&env->obst, rm);
1367 * Creates a be_Return for a Return node.
1369 * @param @env the abi environment
1370 * @param irn the Return node or NULL if there was none
1371 * @param bl the block where the be_Retun should be placed
1372 * @param mem the current memory
1373 * @param n_res number of return results
1375 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1376 be_abi_call_t *call = env->call;
1377 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1379 pmap *reg_map = pmap_create();
1380 ir_node *keep = pmap_get(env->keep_map, bl);
1386 const arch_register_t **regs;
1390 get the valid stack node in this block.
1391 If we had a call in that block there is a Keep constructed by process_calls()
1392 which points to the last stack modification in that block. we'll use
1393 it then. Else we use the stack from the start block and let
1394 the ssa construction fix the usage.
1396 stack = be_abi_reg_map_get(env->regs, isa->sp);
1398 ir_node *bad = new_r_Bad(env->birg->irg);
1399 stack = get_irn_n(keep, 0);
1400 set_nodes_block(keep, bad);
1401 set_irn_n(keep, 0, bad);
1402 // exchange(keep, new_r_Bad(env->birg->irg));
1405 /* Insert results for Return into the register map. */
1406 for(i = 0; i < n_res; ++i) {
1407 ir_node *res = get_Return_res(irn, i);
1408 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1409 assert(arg->in_reg && "return value must be passed in register");
1410 pmap_insert(reg_map, (void *) arg->reg, res);
1413 /* Add uses of the callee save registers. */
1414 pmap_foreach(env->regs, ent) {
1415 const arch_register_t *reg = ent->key;
1416 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1417 pmap_insert(reg_map, ent->key, ent->value);
1420 be_abi_reg_map_set(reg_map, isa->sp, stack);
1422 /* Make the Epilogue node and call the arch's epilogue maker. */
1423 create_barrier(env, bl, &mem, reg_map, 1);
1424 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1427 Maximum size of the in array for Return nodes is
1428 return args + callee save/ignore registers + memory + stack pointer
1430 in_max = pmap_count(reg_map) + n_res + 2;
1432 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1433 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1436 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1441 /* clear SP entry, since it has already been grown. */
1442 pmap_insert(reg_map, (void *) isa->sp, NULL);
1443 for(i = 0; i < n_res; ++i) {
1444 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1446 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1447 regs[n++] = arg->reg;
1449 /* Clear the map entry to mark the register as processed. */
1450 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1453 /* grow the rest of the stuff. */
1454 pmap_foreach(reg_map, ent) {
1457 regs[n++] = ent->key;
1461 /* The in array for the new back end return is now ready. */
1462 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1464 /* Set the register classes of the return's parameter accordingly. */
1465 for(i = 0; i < n; ++i)
1467 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1469 /* Free the space of the Epilog's in array and the register <-> proj map. */
1470 obstack_free(&env->obst, in);
1471 pmap_destroy(reg_map);
1476 typedef struct lower_frame_sels_env_t {
1478 ir_entity *value_param_list; /**< the list of all value param entities */
1479 } lower_frame_sels_env_t;
1482 * Walker: Replaces Sels of frame type and
1483 * value param type entities by FrameAddress.
1485 static void lower_frame_sels_walker(ir_node *irn, void *data)
1487 lower_frame_sels_env_t *ctx = data;
1490 ir_graph *irg = current_ir_graph;
1491 ir_node *frame = get_irg_frame(irg);
1492 ir_node *param_base = get_irg_value_param_base(irg);
1493 ir_node *ptr = get_Sel_ptr(irn);
1495 if (ptr == frame || ptr == param_base) {
1496 be_abi_irg_t *env = ctx->env;
1497 ir_entity *ent = get_Sel_entity(irn);
1498 ir_node *bl = get_nodes_block(irn);
1501 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1504 /* check, if it's a param sel and if have not seen this entity immediatly before */
1505 if (ptr == param_base && ctx->value_param_list != ent) {
1506 set_entity_link(ent, ctx->value_param_list);
1507 ctx->value_param_list = ent;
1514 * Check if a value parameter is transmitted as a register.
1515 * This might happen if the address of an parameter is taken which is
1516 * transmitted in registers.
1518 * Note that on some architectures this case must be handled specially
1519 * because the place of the backing store is determined by their ABI.
1521 * In the default case we move the entity to the frame type and create
1522 * a backing store into the first block.
1524 static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_param_list) {
1525 be_abi_call_t *call = env->call;
1526 ir_graph *irg = env->birg->irg;
1527 ir_entity *ent, *next_ent, *new_list;
1529 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1532 for (ent = value_param_list; ent; ent = next_ent) {
1533 int i = get_struct_member_index(get_entity_owner(ent), ent);
1534 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1536 next_ent = get_entity_link(ent);
1538 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1539 set_entity_link(ent, new_list);
1544 /* ok, change the graph */
1545 ir_node *start_bl = get_irg_start_block(irg);
1546 ir_node *first_bl = NULL;
1547 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1548 const ir_edge_t *edge;
1549 optimization_state_t state;
1552 foreach_block_succ(start_bl, edge) {
1553 ir_node *succ = get_edge_src_irn(edge);
1554 if (start_bl != succ) {
1560 /* we had already removed critical edges, so the following
1561 assertion should be always true. */
1562 assert(get_Block_n_cfgpreds(first_bl) == 1);
1564 /* now create backing stores */
1565 frame = get_irg_frame(irg);
1566 imem = get_irg_initial_mem(irg);
1568 save_optimization_state(&state);
1570 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1571 restore_optimization_state(&state);
1573 /* reroute all edges to the new memory source */
1574 edges_reroute(imem, nmem, irg);
1578 args = get_irg_args(irg);
1579 args_bl = get_nodes_block(args);
1580 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1581 int i = get_struct_member_index(get_entity_owner(ent), ent);
1582 ir_type *tp = get_entity_type(ent);
1583 ir_mode *mode = get_type_mode(tp);
1586 /* address for the backing store */
1587 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1590 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1592 /* the backing store itself */
1593 store = new_r_Store(irg, first_bl, mem, addr,
1594 new_r_Proj(irg, args_bl, args, mode, i));
1596 /* the new memory Proj gets the last Proj from store */
1597 set_Proj_pred(nmem, store);
1598 set_Proj_proj(nmem, pn_Store_M);
1600 /* move all entities to the frame type */
1601 frame_tp = get_irg_frame_type(irg);
1602 offset = get_type_size_bytes(frame_tp);
1603 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1604 ir_type *tp = get_entity_type(ent);
1605 int align = get_type_alignment_bytes(tp);
1607 offset += align - 1;
1609 set_entity_owner(ent, frame_tp);
1610 add_class_member(frame_tp, ent);
1611 /* must be automatic to set a fixed layout */
1612 set_entity_allocation(ent, allocation_automatic);
1613 set_entity_offset(ent, offset);
1614 offset += get_type_size_bytes(tp);
1616 set_type_size_bytes(frame_tp, offset);
1621 * The start block has no jump, instead it has an initial exec Proj.
1622 * The backend wants to handle all blocks the same way, so we replace
1623 * the out cfg edge with a real jump.
1625 static void fix_start_block(ir_node *block, void *env) {
1628 ir_node *start_block;
1631 /* we processed the start block, return */
1635 irg = get_irn_irg(block);
1636 start_block = get_irg_start_block(irg);
1638 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
1639 ir_node *pred = get_Block_cfgpred(block, i);
1640 ir_node *pred_block = get_nodes_block(pred);
1642 /* ok, we are in the block, having start as cfg predecessor */
1643 if (pred_block == start_block) {
1644 ir_node *jump = new_r_Jmp(irg, pred_block);
1645 set_Block_cfgpred(block, i, jump);
1652 * Modify the irg itself and the frame type.
1654 static void modify_irg(be_abi_irg_t *env)
1656 be_abi_call_t *call = env->call;
1657 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1658 const arch_register_t *sp = arch_isa_sp(isa);
1659 ir_graph *irg = env->birg->irg;
1660 ir_node *bl = get_irg_start_block(irg);
1661 ir_node *end = get_irg_end_block(irg);
1662 ir_node *mem = get_irg_initial_mem(irg);
1663 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1664 pset *dont_save = pset_new_ptr(8);
1670 const arch_register_t *fp_reg;
1671 ir_node *frame_pointer;
1673 ir_node *reg_params_bl;
1676 ir_node *value_param_base;
1677 const ir_edge_t *edge;
1678 ir_type *arg_type, *bet_type;
1679 lower_frame_sels_env_t ctx;
1680 ir_entity **param_map;
1682 bitset_t *used_proj_nr;
1683 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1685 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1687 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1689 ctx.value_param_list = NULL;
1690 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1692 /* value_param_base anchor is not needed anymore now */
1693 value_param_base = get_irg_value_param_base(irg);
1694 be_kill_node(value_param_base);
1695 set_irg_value_param_base(irg, new_r_Bad(irg));
1697 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1698 env->regs = pmap_create();
1700 used_proj_nr = bitset_alloca(1024);
1701 n_params = get_method_n_params(method_type);
1702 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1703 memset(args, 0, n_params * sizeof(args[0]));
1705 /* Check if a value parameter is transmitted as a register.
1706 * This might happen if the address of an parameter is taken which is
1707 * transmitted in registers.
1709 * Note that on some architectures this case must be handled specially
1710 * because the place of the backing store is determined by their ABI.
1712 * In the default case we move the entity to the frame type and create
1713 * a backing store into the first block.
1715 fix_address_of_parameter_access(env, ctx.value_param_list);
1717 /* Fill the argument vector */
1718 arg_tuple = get_irg_args(irg);
1719 foreach_out_edge(arg_tuple, edge) {
1720 ir_node *irn = get_edge_src_irn(edge);
1721 int nr = get_Proj_proj(irn);
1723 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1726 arg_type = compute_arg_type(env, call, method_type, ¶m_map);
1727 bet_type = call->cb->get_between_type(env->cb);
1728 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir, param_map);
1730 /* Count the register params and add them to the number of Projs for the RegParams node */
1731 for(i = 0; i < n_params; ++i) {
1732 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1733 if(arg->in_reg && args[i]) {
1734 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1735 assert(i == get_Proj_proj(args[i]));
1737 /* For now, associate the register with the old Proj from Start representing that argument. */
1738 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1739 bitset_set(used_proj_nr, i);
1740 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1744 /* Collect all callee-save registers */
1745 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1746 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1747 for(j = 0; j < cls->n_regs; ++j) {
1748 const arch_register_t *reg = &cls->regs[j];
1749 if(arch_register_type_is(reg, callee_save))
1750 pmap_insert(env->regs, (void *) reg, NULL);
1754 pmap_insert(env->regs, (void *) sp, NULL);
1755 pmap_insert(env->regs, (void *) isa->bp, NULL);
1756 reg_params_bl = get_irg_start_block(irg);
1757 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1758 add_irn_dep(env->reg_params, get_irg_start(irg));
1761 * make proj nodes for the callee save registers.
1762 * memorize them, since Return nodes get those as inputs.
1764 * Note, that if a register corresponds to an argument, the regs map contains
1765 * the old Proj from start for that argument.
1768 rm = reg_map_to_arr(&env->obst, env->regs);
1769 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1770 arch_register_t *reg = (void *) rm[i].reg;
1771 ir_mode *mode = reg->reg_class->mode;
1773 int pos = BE_OUT_POS((int) nr);
1779 bitset_set(used_proj_nr, nr);
1780 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1781 pmap_insert(env->regs, (void *) reg, proj);
1782 be_set_constr_single_reg(env->reg_params, pos, reg);
1783 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1786 * If the register is an ignore register,
1787 * The Proj for that register shall also be ignored during register allocation.
1789 if(arch_register_type_is(reg, ignore))
1790 flags |= arch_irn_flags_ignore;
1793 flags |= arch_irn_flags_modify_sp;
1795 be_node_set_flags(env->reg_params, pos, flags);
1797 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1799 obstack_free(&env->obst, rm);
1801 /* Generate the Prologue */
1802 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1804 /* do the stack allocation BEFORE the barrier, or spill code
1805 might be added before it */
1806 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1807 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1808 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1810 env->start_barrier = barrier = create_barrier(env, bl, &mem, env->regs, 0);
1812 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1813 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1815 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1816 set_irg_frame(irg, frame_pointer);
1817 pset_insert_ptr(env->ignore_regs, fp_reg);
1819 set_irg_initial_mem(irg, mem);
1821 /* Now, introduce stack param nodes for all parameters passed on the stack */
1822 for(i = 0; i < n_params; ++i) {
1823 ir_node *arg_proj = args[i];
1824 ir_node *repl = NULL;
1826 if(arg_proj != NULL) {
1827 be_abi_call_arg_t *arg;
1828 ir_type *param_type;
1829 int nr = get_Proj_proj(arg_proj);
1831 nr = MIN(nr, n_params);
1832 arg = get_call_arg(call, 0, nr);
1833 param_type = get_method_param_type(method_type, nr);
1836 repl = pmap_get(env->regs, (void *) arg->reg);
1839 else if(arg->on_stack) {
1840 /* For atomic parameters which are actually used, we create a StackParam node. */
1841 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1842 ir_mode *mode = get_type_mode(param_type);
1843 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1844 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1847 /* The stack parameter is not primitive (it is a struct or array),
1848 we thus will create a node representing the parameter's address
1851 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1855 assert(repl != NULL);
1856 exchange(args[i], repl);
1860 /* the arg proj is not needed anymore now */
1861 assert(get_irn_n_edges(arg_tuple) == 0);
1862 be_kill_node(arg_tuple);
1863 set_irg_args(irg, new_rd_Bad(irg));
1865 /* All Return nodes hang on the End node, so look for them there. */
1866 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1867 ir_node *irn = get_Block_cfgpred(end, i);
1869 if (is_Return(irn)) {
1870 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1874 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1875 the code is dead and will never be executed. */
1877 del_pset(dont_save);
1878 obstack_free(&env->obst, args);
1880 /* handle start block here (place a jump in the block) */
1882 irg_block_walk_graph(irg, fix_start_block, NULL, &temp);
1885 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1887 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1888 ir_node *old_frame = get_irg_frame(birg->irg);
1889 ir_graph *irg = birg->irg;
1893 optimization_state_t state;
1895 be_omit_fp = birg->main_env->options->omit_fp;
1897 obstack_init(&env->obst);
1899 env->isa = birg->main_env->arch_env->isa;
1900 env->method_type = get_entity_type(get_irg_entity(irg));
1901 env->call = be_abi_call_new(env->isa->sp->reg_class);
1902 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1904 env->ignore_regs = pset_new_ptr_default();
1905 env->keep_map = pmap_create();
1906 env->dce_survivor = new_survive_dce();
1908 env->stack_phis = pset_new_ptr(16);
1909 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1910 to another Unknown or the stack pointer gets used */
1911 save_optimization_state(&state);
1913 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1914 restore_optimization_state(&state);
1915 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1917 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1918 env->irn_ops.impl = &abi_irn_ops;
1920 /* Lower all call nodes in the IRG. */
1924 Beware: init backend abi call object after processing calls,
1925 otherwise some information might be not yet available.
1927 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1929 /* Process the IRG */
1932 /* We don't need the keep map anymore. */
1933 pmap_destroy(env->keep_map);
1935 /* reroute the stack origin of the calls to the true stack origin. */
1936 exchange(dummy, env->init_sp);
1937 exchange(old_frame, get_irg_frame(irg));
1939 /* Make some important node pointers survive the dead node elimination. */
1940 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1941 pmap_foreach(env->regs, ent)
1942 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1944 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1946 env->call->cb->done(env->cb);
1951 void be_abi_free(be_abi_irg_t *env)
1953 free_survive_dce(env->dce_survivor);
1954 del_pset(env->stack_phis);
1955 del_pset(env->ignore_regs);
1956 pmap_destroy(env->regs);
1957 obstack_free(&env->obst, NULL);
1958 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1962 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1964 arch_register_t *reg;
1966 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1967 if(reg->reg_class == cls)
1968 bitset_set(bs, reg->index);
1971 /* Returns the stack layout from a abi environment. */
1972 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi) {
1979 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1980 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1981 | _| | |> < ___) | || (_| | (__| <
1982 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1986 struct fix_stack_walker_info {
1988 const arch_env_t *aenv;
1992 * Walker. Collect all stack modifying nodes.
1994 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1996 struct fix_stack_walker_info *info = data;
2001 if (arch_irn_is(info->aenv, irn, modify_sp)) {
2002 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
2003 pset_insert_ptr(info->nodes, irn);
2007 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
2009 pset *stack_nodes = pset_new_ptr(16);
2010 struct fix_stack_walker_info info;
2013 info.nodes = stack_nodes;
2014 info.aenv = env->birg->main_env->arch_env;
2016 be_assure_dom_front(env->birg);
2019 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
2020 pset_insert_ptr(stack_nodes, env->init_sp);
2022 if (env->call->cb->collect_stack_phis)
2023 collect_phis = env->call->cb->collect_stack_phis(env->cb);
2024 be_ssa_constr_set_phis(env->birg->dom_front, lv, stack_nodes, collect_phis ? env->stack_phis : NULL);
2025 del_pset(stack_nodes);
2028 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
2030 const arch_env_t *arch_env = env->birg->main_env->arch_env;
2031 int omit_fp = env->call->flags.bits.try_omit_fp;
2034 sched_foreach(bl, irn) {
2037 Check, if the node relates to an entity on the stack frame.
2038 If so, set the true offset (including the bias) for that
2041 ir_entity *ent = arch_get_frame_entity(arch_env, irn);
2043 int offset = get_stack_entity_offset(env->frame, ent, bias);
2044 arch_set_frame_offset(arch_env, irn, offset);
2045 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
2049 If the node modifies the stack pointer by a constant offset,
2050 record that in the bias.
2052 if(arch_irn_is(arch_env, irn, modify_sp)) {
2053 int ofs = arch_get_sp_bias(arch_env, irn);
2055 if(be_is_IncSP(irn)) {
2056 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
2057 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
2058 be_set_IncSP_offset(irn, ofs);
2059 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
2060 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
2061 be_set_IncSP_offset(irn, ofs);
2074 * A helper struct for the bias walker.
2077 be_abi_irg_t *env; /**< The ABI irg environment. */
2078 int start_block_bias; /**< The bias at the end of the start block. */
2079 ir_node *start_block; /**< The start block of the current graph. */
2083 * Block-Walker: fix all stack offsets
2085 static void stack_bias_walker(ir_node *bl, void *data)
2087 struct bias_walk *bw = data;
2088 if (bl != bw->start_block) {
2089 process_stack_bias(bw->env, bl, bw->start_block_bias);
2093 void be_abi_fix_stack_bias(be_abi_irg_t *env)
2095 ir_graph *irg = env->birg->irg;
2096 struct bias_walk bw;
2098 stack_frame_compute_initial_offset(env->frame);
2099 // stack_layout_dump(stdout, env->frame);
2101 /* Determine the stack bias at the end of the start block. */
2102 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
2104 /* fix the bias is all other blocks */
2106 bw.start_block = get_irg_start_block(irg);
2107 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
2110 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
2112 assert(arch_register_type_is(reg, callee_save));
2113 assert(pmap_contains(abi->regs, (void *) reg));
2114 return pmap_get(abi->regs, (void *) reg);
2117 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg)
2119 assert(arch_register_type_is(reg, ignore));
2120 assert(pmap_contains(abi->regs, (void *) reg));
2121 return pmap_get(abi->regs, (void *) reg);
2124 ir_node *be_abi_get_start_barrier(be_abi_irg_t *abi)
2126 return abi->start_barrier;
2130 _____ _____ _ _ _ _ _ _
2131 |_ _| __ \| \ | | | | | | | | |
2132 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
2133 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
2134 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
2135 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
2137 for Phi nodes which are created due to stack modifying nodes
2138 such as IncSP, AddSP and SetSP.
2140 These Phis are always to be ignored by the reg alloc and are
2141 fixed on the SP register of the ISA.
2144 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
2146 const be_abi_irg_t *abi = get_abi_from_handler(handler);
2147 const void *res = NULL;
2149 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
2150 res = &abi->irn_ops;
2155 static void be_abi_limited(void *data, bitset_t *bs)
2157 be_abi_irg_t *abi = data;
2158 bitset_clear_all(bs);
2159 bitset_set(bs, abi->isa->sp->index);
2162 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)
2164 be_abi_irg_t *abi = get_abi_from_ops(self);
2165 const arch_register_t *reg = abi->isa->sp;
2167 memset(req, 0, sizeof(req[0]));
2169 if(pos == BE_OUT_POS(0)) {
2170 req->cls = reg->reg_class;
2171 req->type = arch_register_req_type_limited;
2172 req->limited = be_abi_limited;
2173 req->limited_env = abi;
2176 else if(pos >= 0 && pos < get_irn_arity(irn)) {
2177 req->cls = reg->reg_class;
2178 req->type = arch_register_req_type_normal;
2184 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
2188 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
2190 const be_abi_irg_t *abi = get_abi_from_ops(self);
2191 return abi->isa->sp;
2194 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
2196 return arch_irn_class_normal;
2199 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2201 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2204 static ir_entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2209 static void abi_set_frame_entity(const void *_self, ir_node *irn, ir_entity *ent)
2213 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2217 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2222 static const arch_irn_ops_if_t abi_irn_ops = {
2223 abi_get_irn_reg_req,
2228 abi_get_frame_entity,
2229 abi_set_frame_entity,
2230 abi_set_frame_offset,
2232 NULL, /* get_inverse */
2233 NULL, /* get_op_estimated_cost */
2234 NULL, /* possible_memory_operand */
2235 NULL, /* perform_memory_operand */
2238 static const arch_irn_handler_t abi_irn_handler = {
2243 * Returns non-zero if the ABI has omitted the frame pointer in
2244 * the current graph.
2246 int be_abi_omit_fp(const be_abi_irg_t *abi) {
2247 return abi->call->flags.bits.try_omit_fp;