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 *addsp, *mem, *res, *size;
881 if (get_Free_where(free) != stack_alloc) {
886 block = get_nodes_block(free);
887 irg = get_irn_irg(block);
888 type = get_Free_type(free);
890 /* we might need to multiply the size with the element size */
891 if(type != get_unknown_type() && get_type_size_bytes(type) != 1) {
892 tarval *tv = new_tarval_from_long(get_type_size_bytes(type), mode_Iu);
893 ir_node *cnst = new_rd_Const(NULL, irg, block, mode_Iu, tv);
894 ir_node *mul = new_rd_Mul(NULL, irg, block, get_Free_size(free),
898 size = get_Free_size(free);
901 /* The stack pointer will be modified in an unknown manner.
902 We cannot omit it. */
903 env->call->flags.bits.try_omit_fp = 0;
904 addsp = be_new_SubSP(env->isa->sp, irg, block, curr_sp, size);
906 mem = new_r_Proj(irg, block, addsp, mode_M, pn_be_SubSP_M);
907 res = new_r_Proj(irg, block, addsp, mode_P_data, pn_be_SubSP_res);
915 /* the following function is replaced by the usage of the heights module */
918 * Walker for dependent_on().
919 * This function searches a node tgt recursively from a given node
920 * but is restricted to the given block.
921 * @return 1 if tgt was reachable from curr, 0 if not.
923 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
927 if (get_nodes_block(curr) != bl)
933 /* Phi functions stop the recursion inside a basic block */
934 if (! is_Phi(curr)) {
935 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
936 if (check_dependence(get_irn_n(curr, i), tgt, bl))
946 * Check if a node is somehow data dependent on another one.
947 * both nodes must be in the same basic block.
948 * @param n1 The first node.
949 * @param n2 The second node.
950 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
952 static int dependent_on(ir_node *n1, ir_node *n2)
954 ir_node *bl = get_nodes_block(n1);
956 assert(bl == get_nodes_block(n2));
958 return heights_reachable_in_block(ir_heights, n1, n2);
959 //return check_dependence(n1, n2, bl);
962 static int cmp_call_dependecy(const void *c1, const void *c2)
964 ir_node *n1 = *(ir_node **) c1;
965 ir_node *n2 = *(ir_node **) c2;
968 Classical qsort() comparison function behavior:
969 0 if both elements are equal
970 1 if second is "smaller" that first
971 -1 if first is "smaller" that second
973 if (dependent_on(n1, n2))
976 if (dependent_on(n2, n1))
983 * Walker: links all Call/alloc/Free nodes to the Block they are contained.
985 static void link_calls_in_block_walker(ir_node *irn, void *data)
987 ir_opcode code = get_irn_opcode(irn);
989 if (code == iro_Call ||
990 (code == iro_Alloc && get_Alloc_where(irn) == stack_alloc) ||
991 (code == iro_Free && get_Free_where(irn) == stack_alloc)) {
992 be_abi_irg_t *env = data;
993 ir_node *bl = get_nodes_block(irn);
994 void *save = get_irn_link(bl);
996 if (code == iro_Call)
997 env->call->flags.bits.irg_is_leaf = 0;
999 set_irn_link(irn, save);
1000 set_irn_link(bl, irn);
1006 * Process all Call nodes inside a basic block.
1007 * Note that the link field of the block must contain a linked list of all
1008 * Call nodes inside the Block. We first order this list according to data dependency
1009 * and that connect the calls together.
1011 static void process_calls_in_block(ir_node *bl, void *data)
1013 be_abi_irg_t *env = data;
1014 ir_node *curr_sp = env->init_sp;
1018 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
1019 obstack_ptr_grow(&env->obst, irn);
1021 /* If there were call nodes in the block. */
1025 ir_node *copy = NULL;
1028 nodes = obstack_finish(&env->obst);
1030 /* order the call nodes according to data dependency */
1031 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
1033 for(i = n - 1; i >= 0; --i) {
1034 ir_node *irn = nodes[i];
1036 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
1037 switch(get_irn_opcode(irn)) {
1039 curr_sp = adjust_call(env, irn, curr_sp, copy);
1042 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
1045 curr_sp = adjust_free(env, irn, curr_sp);
1052 obstack_free(&env->obst, nodes);
1054 /* Keep the last stack state in the block by tying it to Keep node */
1056 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
1057 pmap_insert(env->keep_map, bl, keep);
1060 set_irn_link(bl, curr_sp);
1061 } /* process_calls_in_block */
1064 * Adjust all call nodes in the graph to the ABI conventions.
1066 static void process_calls(be_abi_irg_t *env)
1068 ir_graph *irg = env->birg->irg;
1070 env->call->flags.bits.irg_is_leaf = 1;
1071 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
1073 ir_heights = heights_new(env->birg->irg);
1074 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
1075 heights_free(ir_heights);
1079 static ir_node *setup_frame(be_abi_irg_t *env)
1081 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1082 const arch_register_t *sp = isa->sp;
1083 const arch_register_t *bp = isa->bp;
1084 be_abi_call_flags_bits_t flags = env->call->flags.bits;
1085 ir_graph *irg = env->birg->irg;
1086 ir_node *bl = get_irg_start_block(irg);
1087 ir_node *no_mem = get_irg_no_mem(irg);
1088 ir_node *old_frame = get_irg_frame(irg);
1089 ir_node *stack = pmap_get(env->regs, (void *) sp);
1090 ir_node *frame = pmap_get(env->regs, (void *) bp);
1092 int stack_nr = get_Proj_proj(stack);
1094 if(flags.try_omit_fp) {
1095 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
1100 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
1102 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
1103 if(!flags.fp_free) {
1104 be_set_constr_single_reg(frame, -1, bp);
1105 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
1106 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
1109 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
1112 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
1113 env->init_sp = stack;
1114 set_irg_frame(irg, frame);
1115 edges_reroute(old_frame, frame, irg);
1120 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1122 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1123 const arch_register_t *sp = isa->sp;
1124 const arch_register_t *bp = isa->bp;
1125 ir_graph *irg = env->birg->irg;
1126 ir_node *ret_mem = get_Return_mem(ret);
1127 ir_node *frame = get_irg_frame(irg);
1128 ir_node *bl = get_nodes_block(ret);
1129 ir_node *stack = get_irn_link(bl);
1133 if(env->call->flags.bits.try_omit_fp) {
1134 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1138 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1139 be_set_constr_single_reg(stack, -1, sp);
1140 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1143 pmap_foreach(env->regs, ent) {
1144 const arch_register_t *reg = ent->key;
1145 ir_node *irn = ent->value;
1148 obstack_ptr_grow(&env->obst, stack);
1150 obstack_ptr_grow(&env->obst, frame);
1151 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1152 obstack_ptr_grow(obst, irn);
1159 * Computes the stack argument layout type.
1160 * Changes a possibly allocated value param type by moving
1161 * entities to the stack layout type.
1163 * @param env the ABI environment
1164 * @param call the current call ABI
1165 * @param method_type the method type
1166 * @param param_map an array mapping method arguments to the stack layout type
1168 * @return the stack argument layout type
1170 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type, ir_entity ***param_map)
1172 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1173 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1174 int n = get_method_n_params(method_type);
1175 int curr = inc > 0 ? 0 : n - 1;
1181 ir_type *val_param_tp = get_method_value_param_type(method_type);
1182 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1185 *param_map = map = obstack_alloc(&env->obst, n * sizeof(ir_entity *));
1186 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1187 for (i = 0; i < n; ++i, curr += inc) {
1188 ir_type *param_type = get_method_param_type(method_type, curr);
1189 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1192 if (arg->on_stack) {
1194 /* the entity was already created, move it to the param type */
1195 arg->stack_ent = get_method_value_param_ent(method_type, i);
1196 remove_struct_member(val_param_tp, arg->stack_ent);
1197 set_entity_owner(arg->stack_ent, res);
1198 add_struct_member(res, arg->stack_ent);
1199 /* must be automatic to set a fixed layout */
1200 set_entity_allocation(arg->stack_ent, allocation_automatic);
1203 snprintf(buf, sizeof(buf), "param_%d", i);
1204 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1206 ofs += arg->space_before;
1207 ofs = round_up2(ofs, arg->alignment);
1208 set_entity_offset(arg->stack_ent, ofs);
1209 ofs += arg->space_after;
1210 ofs += get_type_size_bytes(param_type);
1211 map[i] = arg->stack_ent;
1214 set_type_size_bytes(res, ofs);
1215 set_type_state(res, layout_fixed);
1220 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1223 struct obstack obst;
1225 obstack_init(&obst);
1227 /* Create a Perm after the RegParams node to delimit it. */
1228 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1229 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1234 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1235 const arch_register_t *reg = &cls->regs[j];
1236 ir_node *irn = pmap_get(regs, (void *) reg);
1238 if(irn && !arch_register_type_is(reg, ignore)) {
1240 obstack_ptr_grow(&obst, irn);
1241 set_irn_link(irn, (void *) reg);
1245 obstack_ptr_grow(&obst, NULL);
1246 in = obstack_finish(&obst);
1248 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1249 for(j = 0; j < n_regs; ++j) {
1250 ir_node *arg = in[j];
1251 arch_register_t *reg = get_irn_link(arg);
1252 pmap_insert(regs, reg, arg);
1253 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1256 obstack_free(&obst, in);
1259 obstack_free(&obst, NULL);
1264 const arch_register_t *reg;
1268 static int cmp_regs(const void *a, const void *b)
1270 const reg_node_map_t *p = a;
1271 const reg_node_map_t *q = b;
1273 if(p->reg->reg_class == q->reg->reg_class)
1274 return p->reg->index - q->reg->index;
1276 return p->reg->reg_class - q->reg->reg_class;
1279 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1282 int n = pmap_count(reg_map);
1284 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1286 pmap_foreach(reg_map, ent) {
1287 res[i].reg = ent->key;
1288 res[i].irn = ent->value;
1292 qsort(res, n, sizeof(res[0]), cmp_regs);
1297 * Creates a barrier.
1299 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1301 ir_graph *irg = env->birg->irg;
1302 int n_regs = pmap_count(regs);
1308 rm = reg_map_to_arr(&env->obst, regs);
1310 for(n = 0; n < n_regs; ++n)
1311 obstack_ptr_grow(&env->obst, rm[n].irn);
1314 obstack_ptr_grow(&env->obst, *mem);
1318 in = (ir_node **) obstack_finish(&env->obst);
1319 irn = be_new_Barrier(irg, bl, n, in);
1320 obstack_free(&env->obst, in);
1322 for(n = 0; n < n_regs; ++n) {
1323 const arch_register_t *reg = rm[n].reg;
1325 int pos = BE_OUT_POS(n);
1328 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1329 be_node_set_reg_class(irn, n, reg->reg_class);
1331 be_set_constr_single_reg(irn, n, reg);
1332 be_set_constr_single_reg(irn, pos, reg);
1333 be_node_set_reg_class(irn, pos, reg->reg_class);
1334 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1336 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1337 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1338 flags |= arch_irn_flags_ignore;
1340 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1341 flags |= arch_irn_flags_modify_sp;
1343 be_node_set_flags(irn, pos, flags);
1345 pmap_insert(regs, (void *) reg, proj);
1349 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1352 obstack_free(&env->obst, rm);
1357 * Creates a be_Return for a Return node.
1359 * @param @env the abi environment
1360 * @param irn the Return node or NULL if there was none
1361 * @param bl the block where the be_Retun should be placed
1362 * @param mem the current memory
1363 * @param n_res number of return results
1365 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1366 be_abi_call_t *call = env->call;
1367 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1369 pmap *reg_map = pmap_create();
1370 ir_node *keep = pmap_get(env->keep_map, bl);
1376 const arch_register_t **regs;
1380 get the valid stack node in this block.
1381 If we had a call in that block there is a Keep constructed by process_calls()
1382 which points to the last stack modification in that block. we'll use
1383 it then. Else we use the stack from the start block and let
1384 the ssa construction fix the usage.
1386 stack = be_abi_reg_map_get(env->regs, isa->sp);
1388 ir_node *bad = new_r_Bad(env->birg->irg);
1389 stack = get_irn_n(keep, 0);
1390 set_nodes_block(keep, bad);
1391 set_irn_n(keep, 0, bad);
1392 // exchange(keep, new_r_Bad(env->birg->irg));
1395 /* Insert results for Return into the register map. */
1396 for(i = 0; i < n_res; ++i) {
1397 ir_node *res = get_Return_res(irn, i);
1398 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1399 assert(arg->in_reg && "return value must be passed in register");
1400 pmap_insert(reg_map, (void *) arg->reg, res);
1403 /* Add uses of the callee save registers. */
1404 pmap_foreach(env->regs, ent) {
1405 const arch_register_t *reg = ent->key;
1406 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1407 pmap_insert(reg_map, ent->key, ent->value);
1410 be_abi_reg_map_set(reg_map, isa->sp, stack);
1412 /* Make the Epilogue node and call the arch's epilogue maker. */
1413 create_barrier(env, bl, &mem, reg_map, 1);
1414 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1417 Maximum size of the in array for Return nodes is
1418 return args + callee save/ignore registers + memory + stack pointer
1420 in_max = pmap_count(reg_map) + n_res + 2;
1422 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1423 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1426 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1431 /* clear SP entry, since it has already been grown. */
1432 pmap_insert(reg_map, (void *) isa->sp, NULL);
1433 for(i = 0; i < n_res; ++i) {
1434 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1436 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1437 regs[n++] = arg->reg;
1439 /* Clear the map entry to mark the register as processed. */
1440 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1443 /* grow the rest of the stuff. */
1444 pmap_foreach(reg_map, ent) {
1447 regs[n++] = ent->key;
1451 /* The in array for the new back end return is now ready. */
1452 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1454 /* Set the register classes of the return's parameter accordingly. */
1455 for(i = 0; i < n; ++i)
1457 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1459 /* Free the space of the Epilog's in array and the register <-> proj map. */
1460 obstack_free(&env->obst, in);
1461 pmap_destroy(reg_map);
1466 typedef struct lower_frame_sels_env_t {
1468 ir_entity *value_param_list; /**< the list of all value param entities */
1469 } lower_frame_sels_env_t;
1472 * Walker: Replaces Sels of frame type and
1473 * value param type entities by FrameAddress.
1475 static void lower_frame_sels_walker(ir_node *irn, void *data)
1477 lower_frame_sels_env_t *ctx = data;
1480 ir_graph *irg = current_ir_graph;
1481 ir_node *frame = get_irg_frame(irg);
1482 ir_node *param_base = get_irg_value_param_base(irg);
1483 ir_node *ptr = get_Sel_ptr(irn);
1485 if (ptr == frame || ptr == param_base) {
1486 be_abi_irg_t *env = ctx->env;
1487 ir_entity *ent = get_Sel_entity(irn);
1488 ir_node *bl = get_nodes_block(irn);
1491 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1494 /* check, if it's a param sel and if have not seen this entity immediatly before */
1495 if (ptr == param_base && ctx->value_param_list != ent) {
1496 set_entity_link(ent, ctx->value_param_list);
1497 ctx->value_param_list = ent;
1504 * Check if a value parameter is transmitted as a register.
1505 * This might happen if the address of an parameter is taken which is
1506 * transmitted in registers.
1508 * Note that on some architectures this case must be handled specially
1509 * because the place of the backing store is determined by their ABI.
1511 * In the default case we move the entity to the frame type and create
1512 * a backing store into the first block.
1514 static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_param_list) {
1515 be_abi_call_t *call = env->call;
1516 ir_graph *irg = env->birg->irg;
1517 ir_entity *ent, *next_ent, *new_list;
1519 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1522 for (ent = value_param_list; ent; ent = next_ent) {
1523 int i = get_struct_member_index(get_entity_owner(ent), ent);
1524 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1526 next_ent = get_entity_link(ent);
1528 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1529 set_entity_link(ent, new_list);
1534 /* ok, change the graph */
1535 ir_node *start_bl = get_irg_start_block(irg);
1536 ir_node *first_bl = NULL;
1537 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1538 const ir_edge_t *edge;
1539 optimization_state_t state;
1542 foreach_block_succ(start_bl, edge) {
1543 ir_node *succ = get_edge_src_irn(edge);
1544 if (start_bl != succ) {
1550 /* we had already removed critical edges, so the following
1551 assertion should be always true. */
1552 assert(get_Block_n_cfgpreds(first_bl) == 1);
1554 /* now create backing stores */
1555 frame = get_irg_frame(irg);
1556 imem = get_irg_initial_mem(irg);
1558 save_optimization_state(&state);
1560 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1561 restore_optimization_state(&state);
1563 /* reroute all edges to the new memory source */
1564 edges_reroute(imem, nmem, irg);
1568 args = get_irg_args(irg);
1569 args_bl = get_nodes_block(args);
1570 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1571 int i = get_struct_member_index(get_entity_owner(ent), ent);
1572 ir_type *tp = get_entity_type(ent);
1573 ir_mode *mode = get_type_mode(tp);
1576 /* address for the backing store */
1577 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1580 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1582 /* the backing store itself */
1583 store = new_r_Store(irg, first_bl, mem, addr,
1584 new_r_Proj(irg, args_bl, args, mode, i));
1586 /* the new memory Proj gets the last Proj from store */
1587 set_Proj_pred(nmem, store);
1588 set_Proj_proj(nmem, pn_Store_M);
1590 /* move all entities to the frame type */
1591 frame_tp = get_irg_frame_type(irg);
1592 offset = get_type_size_bytes(frame_tp);
1593 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1594 ir_type *tp = get_entity_type(ent);
1595 int align = get_type_alignment_bytes(tp);
1597 offset += align - 1;
1599 set_entity_owner(ent, frame_tp);
1600 add_class_member(frame_tp, ent);
1601 /* must be automatic to set a fixed layout */
1602 set_entity_allocation(ent, allocation_automatic);
1603 set_entity_offset(ent, offset);
1604 offset += get_type_size_bytes(tp);
1606 set_type_size_bytes(frame_tp, offset);
1611 * The start block has no jump, instead it has an initial exec Proj.
1612 * The backend wants to handle all blocks the same way, so we replace
1613 * the out cfg edge with a real jump.
1615 static void fix_start_block(ir_node *block, void *env) {
1618 ir_node *start_block;
1621 /* we processed the start block, return */
1625 irg = get_irn_irg(block);
1626 start_block = get_irg_start_block(irg);
1628 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
1629 ir_node *pred = get_Block_cfgpred(block, i);
1630 ir_node *pred_block = get_nodes_block(pred);
1632 /* ok, we are in the block, having start as cfg predecessor */
1633 if (pred_block == start_block) {
1634 ir_node *jump = new_r_Jmp(irg, pred_block);
1635 set_Block_cfgpred(block, i, jump);
1642 * Modify the irg itself and the frame type.
1644 static void modify_irg(be_abi_irg_t *env)
1646 be_abi_call_t *call = env->call;
1647 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1648 const arch_register_t *sp = arch_isa_sp(isa);
1649 ir_graph *irg = env->birg->irg;
1650 ir_node *bl = get_irg_start_block(irg);
1651 ir_node *end = get_irg_end_block(irg);
1652 ir_node *mem = get_irg_initial_mem(irg);
1653 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1654 pset *dont_save = pset_new_ptr(8);
1660 const arch_register_t *fp_reg;
1661 ir_node *frame_pointer;
1663 ir_node *reg_params_bl;
1666 ir_node *value_param_base;
1667 const ir_edge_t *edge;
1668 ir_type *arg_type, *bet_type;
1669 lower_frame_sels_env_t ctx;
1670 ir_entity **param_map;
1672 bitset_t *used_proj_nr;
1673 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1675 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1677 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1679 ctx.value_param_list = NULL;
1680 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1682 /* value_param_base anchor is not needed anymore now */
1683 value_param_base = get_irg_value_param_base(irg);
1684 be_kill_node(value_param_base);
1685 set_irg_value_param_base(irg, new_r_Bad(irg));
1687 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1688 env->regs = pmap_create();
1690 used_proj_nr = bitset_alloca(1024);
1691 n_params = get_method_n_params(method_type);
1692 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1693 memset(args, 0, n_params * sizeof(args[0]));
1695 /* Check if a value parameter is transmitted as a register.
1696 * This might happen if the address of an parameter is taken which is
1697 * transmitted in registers.
1699 * Note that on some architectures this case must be handled specially
1700 * because the place of the backing store is determined by their ABI.
1702 * In the default case we move the entity to the frame type and create
1703 * a backing store into the first block.
1705 fix_address_of_parameter_access(env, ctx.value_param_list);
1707 /* Fill the argument vector */
1708 arg_tuple = get_irg_args(irg);
1709 foreach_out_edge(arg_tuple, edge) {
1710 ir_node *irn = get_edge_src_irn(edge);
1711 int nr = get_Proj_proj(irn);
1713 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1716 arg_type = compute_arg_type(env, call, method_type, ¶m_map);
1717 bet_type = call->cb->get_between_type(env->cb);
1718 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir, param_map);
1720 /* Count the register params and add them to the number of Projs for the RegParams node */
1721 for(i = 0; i < n_params; ++i) {
1722 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1723 if(arg->in_reg && args[i]) {
1724 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1725 assert(i == get_Proj_proj(args[i]));
1727 /* For now, associate the register with the old Proj from Start representing that argument. */
1728 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1729 bitset_set(used_proj_nr, i);
1730 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1734 /* Collect all callee-save registers */
1735 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1736 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1737 for(j = 0; j < cls->n_regs; ++j) {
1738 const arch_register_t *reg = &cls->regs[j];
1739 if(arch_register_type_is(reg, callee_save))
1740 pmap_insert(env->regs, (void *) reg, NULL);
1744 pmap_insert(env->regs, (void *) sp, NULL);
1745 pmap_insert(env->regs, (void *) isa->bp, NULL);
1746 reg_params_bl = get_irg_start_block(irg);
1747 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1748 add_irn_dep(env->reg_params, get_irg_start(irg));
1751 * make proj nodes for the callee save registers.
1752 * memorize them, since Return nodes get those as inputs.
1754 * Note, that if a register corresponds to an argument, the regs map contains
1755 * the old Proj from start for that argument.
1758 rm = reg_map_to_arr(&env->obst, env->regs);
1759 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1760 arch_register_t *reg = (void *) rm[i].reg;
1761 ir_mode *mode = reg->reg_class->mode;
1763 int pos = BE_OUT_POS((int) nr);
1769 bitset_set(used_proj_nr, nr);
1770 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1771 pmap_insert(env->regs, (void *) reg, proj);
1772 be_set_constr_single_reg(env->reg_params, pos, reg);
1773 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1776 * If the register is an ignore register,
1777 * The Proj for that register shall also be ignored during register allocation.
1779 if(arch_register_type_is(reg, ignore))
1780 flags |= arch_irn_flags_ignore;
1783 flags |= arch_irn_flags_modify_sp;
1785 be_node_set_flags(env->reg_params, pos, flags);
1787 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1789 obstack_free(&env->obst, rm);
1791 /* Generate the Prologue */
1792 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1794 /* do the stack allocation BEFORE the barrier, or spill code
1795 might be added before it */
1796 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1797 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1798 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1800 env->start_barrier = barrier = create_barrier(env, bl, &mem, env->regs, 0);
1802 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1803 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1805 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1806 set_irg_frame(irg, frame_pointer);
1807 pset_insert_ptr(env->ignore_regs, fp_reg);
1809 set_irg_initial_mem(irg, mem);
1811 /* Now, introduce stack param nodes for all parameters passed on the stack */
1812 for(i = 0; i < n_params; ++i) {
1813 ir_node *arg_proj = args[i];
1814 ir_node *repl = NULL;
1816 if(arg_proj != NULL) {
1817 be_abi_call_arg_t *arg;
1818 ir_type *param_type;
1819 int nr = get_Proj_proj(arg_proj);
1821 nr = MIN(nr, n_params);
1822 arg = get_call_arg(call, 0, nr);
1823 param_type = get_method_param_type(method_type, nr);
1826 repl = pmap_get(env->regs, (void *) arg->reg);
1829 else if(arg->on_stack) {
1830 /* For atomic parameters which are actually used, we create a StackParam node. */
1831 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1832 ir_mode *mode = get_type_mode(param_type);
1833 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1834 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1837 /* The stack parameter is not primitive (it is a struct or array),
1838 we thus will create a node representing the parameter's address
1841 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1845 assert(repl != NULL);
1846 exchange(args[i], repl);
1850 /* the arg proj is not needed anymore now */
1851 assert(get_irn_n_edges(arg_tuple) == 0);
1852 be_kill_node(arg_tuple);
1853 set_irg_args(irg, new_rd_Bad(irg));
1855 /* All Return nodes hang on the End node, so look for them there. */
1856 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1857 ir_node *irn = get_Block_cfgpred(end, i);
1859 if (is_Return(irn)) {
1860 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1864 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1865 the code is dead and will never be executed. */
1867 del_pset(dont_save);
1868 obstack_free(&env->obst, args);
1870 /* handle start block here (place a jump in the block) */
1872 irg_block_walk_graph(irg, fix_start_block, NULL, &temp);
1875 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1877 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1878 ir_node *old_frame = get_irg_frame(birg->irg);
1879 ir_graph *irg = birg->irg;
1883 optimization_state_t state;
1885 be_omit_fp = birg->main_env->options->omit_fp;
1887 obstack_init(&env->obst);
1889 env->isa = birg->main_env->arch_env->isa;
1890 env->method_type = get_entity_type(get_irg_entity(irg));
1891 env->call = be_abi_call_new(env->isa->sp->reg_class);
1892 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1894 env->ignore_regs = pset_new_ptr_default();
1895 env->keep_map = pmap_create();
1896 env->dce_survivor = new_survive_dce();
1898 env->stack_phis = pset_new_ptr(16);
1899 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1900 to another Unknown or the stack pointer gets used */
1901 save_optimization_state(&state);
1903 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1904 restore_optimization_state(&state);
1905 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1907 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1908 env->irn_ops.impl = &abi_irn_ops;
1910 /* Lower all call nodes in the IRG. */
1914 Beware: init backend abi call object after processing calls,
1915 otherwise some information might be not yet available.
1917 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1919 /* Process the IRG */
1922 /* We don't need the keep map anymore. */
1923 pmap_destroy(env->keep_map);
1925 /* reroute the stack origin of the calls to the true stack origin. */
1926 exchange(dummy, env->init_sp);
1927 exchange(old_frame, get_irg_frame(irg));
1929 /* Make some important node pointers survive the dead node elimination. */
1930 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1931 pmap_foreach(env->regs, ent)
1932 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1934 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1936 env->call->cb->done(env->cb);
1941 void be_abi_free(be_abi_irg_t *env)
1943 free_survive_dce(env->dce_survivor);
1944 del_pset(env->stack_phis);
1945 del_pset(env->ignore_regs);
1946 pmap_destroy(env->regs);
1947 obstack_free(&env->obst, NULL);
1948 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1952 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1954 arch_register_t *reg;
1956 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1957 if(reg->reg_class == cls)
1958 bitset_set(bs, reg->index);
1961 /* Returns the stack layout from a abi environment. */
1962 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi) {
1969 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1970 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1971 | _| | |> < ___) | || (_| | (__| <
1972 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1976 struct fix_stack_walker_info {
1978 const arch_env_t *aenv;
1982 * Walker. Collect all stack modifying nodes.
1984 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1986 struct fix_stack_walker_info *info = data;
1991 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1992 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1993 pset_insert_ptr(info->nodes, irn);
1997 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1999 pset *stack_nodes = pset_new_ptr(16);
2000 struct fix_stack_walker_info info;
2003 info.nodes = stack_nodes;
2004 info.aenv = env->birg->main_env->arch_env;
2006 be_assure_dom_front(env->birg);
2009 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
2010 pset_insert_ptr(stack_nodes, env->init_sp);
2012 if (env->call->cb->collect_stack_phis)
2013 collect_phis = env->call->cb->collect_stack_phis(env->cb);
2014 be_ssa_constr_set_phis(env->birg->dom_front, lv, stack_nodes, collect_phis ? env->stack_phis : NULL);
2015 del_pset(stack_nodes);
2018 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
2020 const arch_env_t *arch_env = env->birg->main_env->arch_env;
2021 int omit_fp = env->call->flags.bits.try_omit_fp;
2024 sched_foreach(bl, irn) {
2027 Check, if the node relates to an entity on the stack frame.
2028 If so, set the true offset (including the bias) for that
2031 ir_entity *ent = arch_get_frame_entity(arch_env, irn);
2033 int offset = get_stack_entity_offset(env->frame, ent, bias);
2034 arch_set_frame_offset(arch_env, irn, offset);
2035 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
2039 If the node modifies the stack pointer by a constant offset,
2040 record that in the bias.
2042 if(arch_irn_is(arch_env, irn, modify_sp)) {
2043 int ofs = arch_get_sp_bias(arch_env, irn);
2045 if(be_is_IncSP(irn)) {
2046 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
2047 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
2048 be_set_IncSP_offset(irn, ofs);
2049 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
2050 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
2051 be_set_IncSP_offset(irn, ofs);
2064 * A helper struct for the bias walker.
2067 be_abi_irg_t *env; /**< The ABI irg environment. */
2068 int start_block_bias; /**< The bias at the end of the start block. */
2069 ir_node *start_block; /**< The start block of the current graph. */
2073 * Block-Walker: fix all stack offsets
2075 static void stack_bias_walker(ir_node *bl, void *data)
2077 struct bias_walk *bw = data;
2078 if (bl != bw->start_block) {
2079 process_stack_bias(bw->env, bl, bw->start_block_bias);
2083 void be_abi_fix_stack_bias(be_abi_irg_t *env)
2085 ir_graph *irg = env->birg->irg;
2086 struct bias_walk bw;
2088 stack_frame_compute_initial_offset(env->frame);
2089 // stack_layout_dump(stdout, env->frame);
2091 /* Determine the stack bias at the end of the start block. */
2092 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
2094 /* fix the bias is all other blocks */
2096 bw.start_block = get_irg_start_block(irg);
2097 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
2100 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
2102 assert(arch_register_type_is(reg, callee_save));
2103 assert(pmap_contains(abi->regs, (void *) reg));
2104 return pmap_get(abi->regs, (void *) reg);
2107 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg)
2109 assert(arch_register_type_is(reg, ignore));
2110 assert(pmap_contains(abi->regs, (void *) reg));
2111 return pmap_get(abi->regs, (void *) reg);
2114 ir_node *be_abi_get_start_barrier(be_abi_irg_t *abi)
2116 return abi->start_barrier;
2120 _____ _____ _ _ _ _ _ _
2121 |_ _| __ \| \ | | | | | | | | |
2122 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
2123 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
2124 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
2125 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
2127 for Phi nodes which are created due to stack modifying nodes
2128 such as IncSP, AddSP and SetSP.
2130 These Phis are always to be ignored by the reg alloc and are
2131 fixed on the SP register of the ISA.
2134 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
2136 const be_abi_irg_t *abi = get_abi_from_handler(handler);
2137 const void *res = NULL;
2139 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
2140 res = &abi->irn_ops;
2145 static void be_abi_limited(void *data, bitset_t *bs)
2147 be_abi_irg_t *abi = data;
2148 bitset_clear_all(bs);
2149 bitset_set(bs, abi->isa->sp->index);
2152 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)
2154 be_abi_irg_t *abi = get_abi_from_ops(self);
2155 const arch_register_t *reg = abi->isa->sp;
2157 memset(req, 0, sizeof(req[0]));
2159 if(pos == BE_OUT_POS(0)) {
2160 req->cls = reg->reg_class;
2161 req->type = arch_register_req_type_limited;
2162 req->limited = be_abi_limited;
2163 req->limited_env = abi;
2166 else if(pos >= 0 && pos < get_irn_arity(irn)) {
2167 req->cls = reg->reg_class;
2168 req->type = arch_register_req_type_normal;
2174 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
2178 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
2180 const be_abi_irg_t *abi = get_abi_from_ops(self);
2181 return abi->isa->sp;
2184 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
2186 return arch_irn_class_normal;
2189 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2191 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2194 static ir_entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2199 static void abi_set_frame_entity(const void *_self, ir_node *irn, ir_entity *ent)
2203 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2207 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2212 static const arch_irn_ops_if_t abi_irn_ops = {
2213 abi_get_irn_reg_req,
2218 abi_get_frame_entity,
2219 abi_set_frame_entity,
2220 abi_set_frame_offset,
2222 NULL, /* get_inverse */
2223 NULL, /* get_op_estimated_cost */
2224 NULL, /* possible_memory_operand */
2225 NULL, /* perform_memory_operand */
2228 static const arch_irn_handler_t abi_irn_handler = {
2233 * Returns non-zero if the ABI has omitted the frame pointer in
2234 * the current graph.
2236 int be_abi_omit_fp(const be_abi_irg_t *abi) {
2237 return abi->call->flags.bits.try_omit_fp;