4 * @author Sebastian Hack
19 #include "irgraph_t.h"
22 #include "iredges_t.h"
25 #include "irprintf_t.h"
37 #include "besched_t.h"
39 typedef struct _be_abi_call_arg_t {
40 unsigned is_res : 1; /**< 1: the call argument is a return value. 0: it's a call parameter. */
41 unsigned in_reg : 1; /**< 1: this argument is transmitted in registers. */
42 unsigned on_stack : 1; /**< 1: this argument is transmitted on the stack. */
45 const arch_register_t *reg;
48 unsigned space_before;
52 struct _be_abi_call_t {
53 be_abi_call_flags_t flags;
54 const be_abi_callbacks_t *cb;
55 ir_type *between_type;
59 struct _be_abi_irg_t {
61 be_stack_layout_t *frame; /**< The stack frame model. */
62 const be_irg_t *birg; /**< The back end IRG. */
63 const arch_isa_t *isa; /**< The isa. */
64 survive_dce_t *dce_survivor;
66 be_abi_call_t *call; /**< The ABI call information. */
67 ir_type *method_type; /**< The type of the method of the IRG. */
69 ir_node *init_sp; /**< The node representing the stack pointer
70 at the start of the function. */
72 ir_node *reg_params; /**< The reg params node. */
73 pmap *regs; /**< A map of all callee-save and ignore regs to
74 their Projs to the RegParams node. */
76 pset *stack_phis; /**< The set of all Phi nodes inserted due to
77 stack pointer modifying nodes. */
79 int start_block_bias; /**< The stack bias at the end of the start block. */
81 void *cb; /**< ABI Callback self pointer. */
83 pmap *keep_map; /**< mapping blocks to keep nodes. */
84 pset *ignore_regs; /**< Additional registers which shall be ignored. */
86 arch_irn_handler_t irn_handler;
87 arch_irn_ops_t irn_ops;
88 DEBUG_ONLY(firm_dbg_module_t *dbg;) /**< The debugging module. */
91 #define get_abi_from_handler(ptr) firm_container_of(ptr, be_abi_irg_t, irn_handler)
92 #define get_abi_from_ops(ptr) firm_container_of(ptr, be_abi_irg_t, irn_ops)
94 /* Forward, since be need it in be_abi_introduce(). */
95 static const arch_irn_ops_if_t abi_irn_ops;
96 static const arch_irn_handler_t abi_irn_handler;
97 static heights_t *ir_heights;
99 /* Flag: if set, try to omit the frame pointer if called by the backend */
100 static int be_omit_fp = 1;
103 _ ____ ___ ____ _ _ _ _
104 / \ | __ )_ _| / ___|__ _| | | |__ __ _ ___| | _____
105 / _ \ | _ \| | | | / _` | | | '_ \ / _` |/ __| |/ / __|
106 / ___ \| |_) | | | |__| (_| | | | |_) | (_| | (__| <\__ \
107 /_/ \_\____/___| \____\__,_|_|_|_.__/ \__,_|\___|_|\_\___/
109 These callbacks are used by the backend to set the parameters
110 for a specific call type.
114 * Set compare function: compares two ABI call object arguments.
116 static int cmp_call_arg(const void *a, const void *b, size_t n)
118 const be_abi_call_arg_t *p = a, *q = b;
119 return !(p->is_res == q->is_res && p->pos == q->pos);
123 * Get or set an ABI call object argument.
125 * @param call the abi call
126 * @param is_res true for call results, false for call arguments
127 * @param pos position of the argument
128 * @param do_insert true if the argument is set, false if it's retrieved
130 static be_abi_call_arg_t *get_or_set_call_arg(be_abi_call_t *call, int is_res, int pos, int do_insert)
132 be_abi_call_arg_t arg;
135 memset(&arg, 0, sizeof(arg));
139 hash = is_res * 128 + pos;
142 ? set_insert(call->params, &arg, sizeof(arg), hash)
143 : set_find(call->params, &arg, sizeof(arg), hash);
147 * Retrieve an ABI call object argument.
149 * @param call the ABI call object
150 * @param is_res true for call results, false for call arguments
151 * @param pos position of the argument
153 static INLINE be_abi_call_arg_t *get_call_arg(be_abi_call_t *call, int is_res, int pos)
155 return get_or_set_call_arg(call, is_res, pos, 0);
158 /* Set the flags for a call. */
159 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb)
165 void be_abi_call_param_stack(be_abi_call_t *call, int arg_pos, unsigned alignment, unsigned space_before, unsigned space_after)
167 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
169 arg->alignment = alignment;
170 arg->space_before = space_before;
171 arg->space_after = space_after;
172 assert(alignment > 0 && "Alignment must be greater than 0");
175 void be_abi_call_param_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
177 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
182 void be_abi_call_res_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
184 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 1, arg_pos, 1);
189 /* Get the flags of a ABI call object. */
190 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call)
196 * Constructor for a new ABI call object.
198 * @return the new ABI call object
200 static be_abi_call_t *be_abi_call_new(void)
202 be_abi_call_t *call = xmalloc(sizeof(call[0]));
204 call->params = new_set(cmp_call_arg, 16);
207 call->flags.bits.try_omit_fp = be_omit_fp;
212 * Destructor for an ABI call object.
214 static void be_abi_call_free(be_abi_call_t *call)
216 del_set(call->params);
222 | ___| __ __ _ _ __ ___ ___ | | | | __ _ _ __ __| | (_)_ __ __ _
223 | |_ | '__/ _` | '_ ` _ \ / _ \ | |_| |/ _` | '_ \ / _` | | | '_ \ / _` |
224 | _|| | | (_| | | | | | | __/ | _ | (_| | | | | (_| | | | | | | (_| |
225 |_| |_| \__,_|_| |_| |_|\___| |_| |_|\__,_|_| |_|\__,_|_|_|_| |_|\__, |
228 Handling of the stack frame. It is composed of three types:
229 1) The type of the arguments which are pushed on the stack.
230 2) The "between type" which consists of stuff the call of the
231 function pushes on the stack (like the return address and
232 the old base pointer for ia32).
233 3) The Firm frame type which consists of all local variables
237 static int get_stack_entity_offset(be_stack_layout_t *frame, entity *ent, int bias)
239 ir_type *t = get_entity_owner(ent);
240 int ofs = get_entity_offset_bytes(ent);
244 /* Find the type the entity is contained in. */
245 for(index = 0; index < N_FRAME_TYPES; ++index) {
246 if(frame->order[index] == t)
250 /* Add the size of all the types below the one of the entity to the entity's offset */
251 for(i = 0; i < index; ++i)
252 ofs += get_type_size_bytes(frame->order[i]);
254 /* correct the offset by the initial position of the frame pointer */
255 ofs -= frame->initial_offset;
257 /* correct the offset with the current bias. */
264 * Retrieve the entity with given offset from a frame type.
266 static entity *search_ent_with_offset(ir_type *t, int offset)
270 for(i = 0, n = get_compound_n_members(t); i < n; ++i) {
271 entity *ent = get_compound_member(t, i);
272 if(get_entity_offset_bytes(ent) == offset)
279 static int stack_frame_compute_initial_offset(be_stack_layout_t *frame)
281 ir_type *base = frame->stack_dir < 0 ? frame->between_type : frame->frame_type;
282 entity *ent = search_ent_with_offset(base, 0);
283 frame->initial_offset = 0;
284 frame->initial_offset = get_stack_entity_offset(frame, ent, 0);
285 return frame->initial_offset;
289 * Initializes the frame layout from parts
291 * @param frame the stack layout that will be initialized
292 * @param args the stack argument layout type
293 * @param between the between layout type
294 * @param locals the method frame type
295 * @param stack_dir the stack direction
296 * @param param_map an array mapping method argument positions to the stack argument type
298 * @return the initialized stack layout
300 static be_stack_layout_t *stack_frame_init(be_stack_layout_t *frame, ir_type *args,
301 ir_type *between, ir_type *locals, int stack_dir,
304 frame->arg_type = args;
305 frame->between_type = between;
306 frame->frame_type = locals;
307 frame->initial_offset = 0;
308 frame->stack_dir = stack_dir;
309 frame->order[1] = between;
310 frame->param_map = param_map;
313 frame->order[0] = args;
314 frame->order[2] = locals;
317 frame->order[0] = locals;
318 frame->order[2] = args;
324 /** Dumps the stack layout to file. */
325 static void stack_layout_dump(FILE *file, be_stack_layout_t *frame)
329 ir_fprintf(file, "initial offset: %d\n", frame->initial_offset);
330 for (j = 0; j < N_FRAME_TYPES; ++j) {
331 ir_type *t = frame->order[j];
333 ir_fprintf(file, "type %d: %F size: %d\n", j, t, get_type_size_bytes(t));
334 for (i = 0, n = get_compound_n_members(t); i < n; ++i) {
335 entity *ent = get_compound_member(t, i);
336 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));
343 * Returns non-zero if the call argument at given position
344 * is transfered on the stack.
346 static INLINE int is_on_stack(be_abi_call_t *call, int pos)
348 be_abi_call_arg_t *arg = get_call_arg(call, 0, pos);
349 return arg && !arg->in_reg;
359 Adjustment of the calls inside a graph.
364 * Transform a call node.
365 * @param env The ABI environment for the current irg.
366 * @param irn The call node.
367 * @param curr_sp The stack pointer node to use.
368 * @return The stack pointer after the call.
370 static ir_node *adjust_call(be_abi_irg_t *env, ir_node *irn, ir_node *curr_sp, ir_node *alloca_copy)
372 ir_graph *irg = env->birg->irg;
373 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
374 be_abi_call_t *call = be_abi_call_new();
375 ir_type *mt = get_Call_type(irn);
376 ir_node *call_ptr = get_Call_ptr(irn);
377 int n_params = get_method_n_params(mt);
378 ir_node *curr_mem = get_Call_mem(irn);
379 ir_node *bl = get_nodes_block(irn);
380 pset *results = pset_new_ptr(8);
381 pset *caller_save = pset_new_ptr(8);
383 int stack_dir = arch_isa_stack_dir(isa);
384 const arch_register_t *sp = arch_isa_sp(isa);
385 ir_mode *mach_mode = sp->reg_class->mode;
386 struct obstack *obst = &env->obst;
387 int no_alloc = call->flags.bits.frame_is_setup_on_call;
389 ir_node *res_proj = NULL;
390 int curr_res_proj = pn_Call_max;
397 const ir_edge_t *edge;
402 /* Let the isa fill out the abi description for that call node. */
403 arch_isa_get_call_abi(isa, mt, call);
405 /* Insert code to put the stack arguments on the stack. */
406 assert(get_Call_n_params(irn) == n_params);
407 for(i = 0; i < n_params; ++i) {
408 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
411 stack_size += arg->space_before;
412 stack_size = round_up2(stack_size, arg->alignment);
413 stack_size += get_type_size_bytes(get_method_param_type(mt, i));
414 stack_size += arg->space_after;
415 obstack_int_grow(obst, i);
419 pos = obstack_finish(obst);
421 /* Collect all arguments which are passed in registers. */
422 for(i = 0, n = get_Call_n_params(irn); i < n; ++i) {
423 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
424 if(arg && arg->in_reg) {
425 obstack_int_grow(obst, i);
429 low_args = obstack_finish(obst);
431 /* If there are some parameters which shall be passed on the stack. */
434 int do_seq = call->flags.bits.store_args_sequential && !no_alloc;
437 * Reverse list of stack parameters if call arguments are from left to right.
438 * We must them reverse again in they are pushed (not stored) and the stack
439 * direction is downwards.
441 if (call->flags.bits.left_to_right ^ (do_seq && stack_dir < 0)) {
442 for(i = 0; i < n_pos >> 1; ++i) {
443 int other = n_pos - i - 1;
451 * If the stack is decreasing and we do not want to store sequentially,
452 * or someone else allocated the call frame
453 * we allocate as much space on the stack all parameters need, by
454 * moving the stack pointer along the stack's direction.
456 if(stack_dir < 0 && !do_seq && !no_alloc) {
457 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, stack_size);
459 add_irn_dep(curr_sp, alloca_copy);
465 obstack_ptr_grow(obst, get_Call_mem(irn));
466 curr_mem = new_NoMem();
468 curr_mem = get_Call_mem(irn);
471 assert(mode_is_reference(mach_mode) && "machine mode must be pointer");
472 for(i = 0; i < n_pos; ++i) {
474 be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
475 ir_node *param = get_Call_param(irn, p);
476 ir_node *addr = curr_sp;
478 ir_type *param_type = get_method_param_type(mt, p);
479 int param_size = get_type_size_bytes(param_type) + arg->space_after;
482 * If we wanted to build the arguments sequentially,
483 * the stack pointer for the next must be incremented,
484 * and the memory value propagated.
488 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, param_size + arg->space_before);
490 add_irn_dep(curr_sp, alloca_copy);
493 add_irn_dep(curr_sp, curr_mem);
496 curr_ofs += arg->space_before;
497 curr_ofs = round_up2(curr_ofs, arg->alignment);
499 /* Make the expression to compute the argument's offset. */
501 addr = new_r_Const_long(irg, bl, mode_Is, curr_ofs);
502 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
506 /* Insert a store for primitive arguments. */
507 if (is_atomic_type(param_type)) {
509 store = new_r_Store(irg, bl, curr_mem, addr, param);
510 mem = new_r_Proj(irg, bl, store, mode_M, pn_Store_M);
513 /* Make a mem copy for compound arguments. */
517 assert(mode_is_reference(get_irn_mode(param)));
518 copy = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
519 mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
522 curr_ofs += param_size;
527 obstack_ptr_grow(obst, mem);
530 in = (ir_node **) obstack_finish(obst);
532 /* We need the sync only, if we didn't build the stores sequentially. */
535 curr_mem = new_r_Sync(irg, bl, n_pos + 1, in);
537 curr_mem = get_Call_mem(irn);
540 obstack_free(obst, in);
543 /* Collect caller save registers */
544 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
546 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
547 for(j = 0; j < cls->n_regs; ++j) {
548 const arch_register_t *reg = arch_register_for_index(cls, j);
549 if(arch_register_type_is(reg, caller_save))
550 pset_insert_ptr(caller_save, (void *) reg);
554 /* search the greatest result proj number */
556 /* TODO: what if the result is NOT used? Currently there is
557 * no way to detect this later, especially there is no way to
558 * see this in the proj numbers.
559 * While this is ok for the register allocator, it is bad for
560 * backends which need to change the be_Call further (x87 simulator
561 * for instance. However for this particular case the call_type is
564 foreach_out_edge(irn, edge) {
565 const ir_edge_t *res_edge;
566 ir_node *irn = get_edge_src_irn(edge);
568 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_T_result) {
570 foreach_out_edge(irn, res_edge) {
572 be_abi_call_arg_t *arg;
573 ir_node *res = get_edge_src_irn(res_edge);
575 assert(is_Proj(res));
577 proj = get_Proj_proj(res);
578 arg = get_call_arg(call, 1, proj);
581 shift the proj number to the right, since we will drop the
582 unspeakable Proj_T from the Call. Therefore, all real argument
583 Proj numbers must be increased by pn_be_Call_first_res
585 proj += pn_be_Call_first_res;
586 set_Proj_proj(res, proj);
587 obstack_ptr_grow(obst, res);
589 if(proj > curr_res_proj)
590 curr_res_proj = proj;
592 pset_remove_ptr(caller_save, arg->reg);
593 //pmap_insert(arg_regs, arg->reg, INT_TO_PTR(proj + 1))
600 obstack_ptr_grow(obst, NULL);
601 res_projs = obstack_finish(obst);
603 /* make the back end call node and set its register requirements. */
604 for(i = 0; i < n_low_args; ++i)
605 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
607 in = obstack_finish(obst);
609 if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
610 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, curr_sp,
611 curr_res_proj + pset_count(caller_save), n_low_args, in,
613 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
617 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, call_ptr,
618 curr_res_proj + pset_count(caller_save), n_low_args, in,
623 Set the register class of the call address to the same as the stack pointer's.
624 That' probably buggy for some architectures.
626 be_node_set_reg_class(low_call, be_pos_Call_ptr, sp->reg_class);
628 DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
630 /* Set the register classes and constraints of the Call parameters. */
631 for(i = 0; i < n_low_args; ++i) {
632 int index = low_args[i];
633 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
634 assert(arg->reg != NULL);
636 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + index, arg->reg);
639 /* Set the register constraints of the results. */
640 for(i = 0; res_projs[i]; ++i) {
641 ir_node *irn = res_projs[i];
642 int proj = get_Proj_proj(irn);
644 /* Correct Proj number since it has been adjusted! (see above) */
645 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
648 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
650 obstack_free(obst, in);
651 exchange(irn, low_call);
653 /* redirect the result projs to the lowered call instead of the Proj_T */
654 for(i = 0; res_projs[i]; ++i)
655 set_Proj_pred(res_projs[i], low_call);
657 /* Make additional projs for the caller save registers
658 and the Keep node which keeps them alive. */
659 if(pset_count(caller_save) > 0) {
660 const arch_register_t *reg;
664 for(reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
665 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
667 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
668 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
669 set_irn_link(proj, (void *) reg);
670 obstack_ptr_grow(obst, proj);
674 in = (ir_node **) obstack_finish(obst);
675 keep = be_new_Keep(NULL, irg, bl, n, in);
676 for(i = 0; i < n; ++i) {
677 const arch_register_t *reg = get_irn_link(in[i]);
678 be_node_set_reg_class(keep, i, reg->reg_class);
680 obstack_free(obst, in);
683 /* Clean up the stack. */
685 ir_node *mem_proj = NULL;
687 foreach_out_edge(low_call, edge) {
688 ir_node *irn = get_edge_src_irn(edge);
689 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
696 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
697 keep_alive(mem_proj);
700 /* Clean up the stack frame if we allocated it */
702 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
703 add_irn_dep(curr_sp, mem_proj);
705 add_irn_dep(curr_sp, alloca_copy);
711 be_abi_call_free(call);
712 obstack_free(obst, pos);
714 del_pset(caller_save);
721 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
723 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
725 if (get_Alloc_where(alloc) == stack_alloc) {
726 ir_node *bl = get_nodes_block(alloc);
727 ir_graph *irg = get_irn_irg(bl);
728 ir_node *alloc_mem = NULL;
729 ir_node *alloc_res = NULL;
731 const ir_edge_t *edge;
737 foreach_out_edge(alloc, edge) {
738 ir_node *irn = get_edge_src_irn(edge);
740 assert(is_Proj(irn));
741 switch(get_Proj_proj(irn)) {
753 /* Beware: currently Alloc nodes without a result might happen,
754 only escape analysis kills them and this phase runs only for object
755 oriented source. We kill the Alloc here. */
756 if (alloc_res == NULL && alloc_mem) {
757 exchange(alloc_mem, get_Alloc_mem(alloc));
761 /* The stack pointer will be modified in an unknown manner.
762 We cannot omit it. */
763 env->call->flags.bits.try_omit_fp = 0;
764 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
766 if(alloc_mem != NULL) {
770 addsp_mem = new_r_Proj(irg, bl, new_alloc, mode_M, pn_be_AddSP_M);
772 // We need to sync the output mem of the AddSP with the input mem
773 // edge into the alloc node
774 ins[0] = get_Alloc_mem(alloc);
776 sync = new_r_Sync(irg, bl, 2, ins);
778 exchange(alloc_mem, sync);
781 exchange(alloc, new_alloc);
783 /* fix projnum of alloca res */
784 set_Proj_proj(alloc_res, pn_be_AddSP_res);
786 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
788 /* copy the address away, since it could be used after further stack pointer modifications. */
789 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
790 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, bl, curr_sp);
792 /* Let all users of the Alloc() result now point to the copy. */
793 edges_reroute(alloc_res, copy, irg);
795 /* Rewire the copy appropriately. */
796 set_irn_n(copy, be_pos_Copy_op, addr);
805 * The Free is transformed into a back end free node and connected to the stack nodes.
807 static ir_node *adjust_free(be_abi_irg_t *env, ir_node *free, ir_node *curr_sp)
809 if (get_Free_where(free) == stack_alloc) {
810 ir_node *bl = get_nodes_block(free);
811 ir_graph *irg = get_irn_irg(bl);
812 ir_node *addsp, *mem, *res;
814 /* The stack pointer will be modified in an unknown manner.
815 We cannot omit it. */
816 env->call->flags.bits.try_omit_fp = 0;
817 addsp = be_new_SubSP(env->isa->sp, irg, bl, curr_sp, get_Free_size(free));
819 mem = new_r_Proj(irg, bl, addsp, mode_M, pn_be_SubSP_M);
820 res = new_r_Proj(irg, bl, addsp, mode_P_data, pn_be_SubSP_res);
828 /* the following function is replaced by the usage of the heights module */
831 * Walker for dependent_on().
832 * This function searches a node tgt recursively from a given node
833 * but is restricted to the given block.
834 * @return 1 if tgt was reachable from curr, 0 if not.
836 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
840 if (get_nodes_block(curr) != bl)
846 /* Phi functions stop the recursion inside a basic block */
847 if (! is_Phi(curr)) {
848 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
849 if (check_dependence(get_irn_n(curr, i), tgt, bl))
859 * Check if a node is somehow data dependent on another one.
860 * both nodes must be in the same basic block.
861 * @param n1 The first node.
862 * @param n2 The second node.
863 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
865 static int dependent_on(ir_node *n1, ir_node *n2)
867 ir_node *bl = get_nodes_block(n1);
869 assert(bl == get_nodes_block(n2));
871 return heights_reachable_in_block(ir_heights, n1, n2);
872 //return check_dependence(n1, n2, bl);
875 static int cmp_call_dependecy(const void *c1, const void *c2)
877 ir_node *n1 = *(ir_node **) c1;
878 ir_node *n2 = *(ir_node **) c2;
881 Classical qsort() comparison function behavior:
882 0 if both elements are equal
883 1 if second is "smaller" that first
884 -1 if first is "smaller" that second
886 if (dependent_on(n1, n2))
889 if (dependent_on(n2, n1))
896 * Walker: links all Call/alloc/Free nodes to the Block they are contained.
898 static void link_calls_in_block_walker(ir_node *irn, void *data)
900 opcode code = get_irn_opcode(irn);
902 if (code == iro_Call ||
903 (code == iro_Alloc && get_Alloc_where(irn) == stack_alloc) ||
904 (code == iro_Free && get_Free_where(irn) == stack_alloc)) {
905 be_abi_irg_t *env = data;
906 ir_node *bl = get_nodes_block(irn);
907 void *save = get_irn_link(bl);
909 if (code == iro_Call)
910 env->call->flags.bits.irg_is_leaf = 0;
912 set_irn_link(irn, save);
913 set_irn_link(bl, irn);
919 * Process all Call nodes inside a basic block.
920 * Note that the link field of the block must contain a linked list of all
921 * Call nodes inside the Block. We first order this list according to data dependency
922 * and that connect the calls together.
924 static void process_calls_in_block(ir_node *bl, void *data)
926 be_abi_irg_t *env = data;
927 ir_node *curr_sp = env->init_sp;
931 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
932 obstack_ptr_grow(&env->obst, irn);
934 /* If there were call nodes in the block. */
938 ir_node *copy = NULL;
941 nodes = obstack_finish(&env->obst);
943 /* order the call nodes according to data dependency */
944 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
946 for(i = n - 1; i >= 0; --i) {
947 ir_node *irn = nodes[i];
949 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
950 switch(get_irn_opcode(irn)) {
952 curr_sp = adjust_call(env, irn, curr_sp, copy);
955 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
958 curr_sp = adjust_free(env, irn, curr_sp);
965 obstack_free(&env->obst, nodes);
967 /* Keep the last stack state in the block by tying it to Keep node */
969 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
970 pmap_insert(env->keep_map, bl, keep);
973 set_irn_link(bl, curr_sp);
974 } /* process_calls_in_block */
977 * Adjust all call nodes in the graph to the ABI conventions.
979 static void process_calls(be_abi_irg_t *env)
981 ir_graph *irg = env->birg->irg;
983 env->call->flags.bits.irg_is_leaf = 1;
984 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
986 ir_heights = heights_new(env->birg->irg);
987 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
988 heights_free(ir_heights);
992 static ir_node *setup_frame(be_abi_irg_t *env)
994 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
995 const arch_register_t *sp = isa->sp;
996 const arch_register_t *bp = isa->bp;
997 be_abi_call_flags_bits_t flags = env->call->flags.bits;
998 ir_graph *irg = env->birg->irg;
999 ir_node *bl = get_irg_start_block(irg);
1000 ir_node *no_mem = get_irg_no_mem(irg);
1001 ir_node *old_frame = get_irg_frame(irg);
1002 ir_node *stack = pmap_get(env->regs, (void *) sp);
1003 ir_node *frame = pmap_get(env->regs, (void *) bp);
1005 int stack_nr = get_Proj_proj(stack);
1007 if(flags.try_omit_fp) {
1008 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
1013 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
1015 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
1016 if(!flags.fp_free) {
1017 be_set_constr_single_reg(frame, -1, bp);
1018 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
1019 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
1022 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
1025 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
1026 env->init_sp = stack;
1027 set_irg_frame(irg, frame);
1028 edges_reroute(old_frame, frame, irg);
1033 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1035 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1036 const arch_register_t *sp = isa->sp;
1037 const arch_register_t *bp = isa->bp;
1038 ir_graph *irg = env->birg->irg;
1039 ir_node *ret_mem = get_Return_mem(ret);
1040 ir_node *frame = get_irg_frame(irg);
1041 ir_node *bl = get_nodes_block(ret);
1042 ir_node *stack = get_irn_link(bl);
1046 if(env->call->flags.bits.try_omit_fp) {
1047 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1051 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1052 be_set_constr_single_reg(stack, -1, sp);
1053 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1056 pmap_foreach(env->regs, ent) {
1057 const arch_register_t *reg = ent->key;
1058 ir_node *irn = ent->value;
1061 obstack_ptr_grow(&env->obst, stack);
1063 obstack_ptr_grow(&env->obst, frame);
1064 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1065 obstack_ptr_grow(obst, irn);
1072 * Computes the stack argument layout type.
1073 * Changes a possibly allocated value param type by moving
1074 * entities to the stack layout type.
1076 * @param env the ABI environment
1077 * @param call the current call ABI
1078 * @param method_type the method type
1079 * @param param_map an array mapping method arguments to the stack layout type
1081 * @return the stack argument layout type
1083 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type, entity ***param_map)
1085 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1086 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1087 int n = get_method_n_params(method_type);
1088 int curr = inc > 0 ? 0 : n - 1;
1094 ir_type *val_param_tp = get_method_value_param_type(method_type);
1095 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1098 *param_map = map = obstack_alloc(&env->obst, n * sizeof(entity *));
1099 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1100 for (i = 0; i < n; ++i, curr += inc) {
1101 ir_type *param_type = get_method_param_type(method_type, curr);
1102 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1105 if (arg->on_stack) {
1107 /* the entity was already created, move it to the param type */
1108 arg->stack_ent = get_method_value_param_ent(method_type, i);
1109 remove_struct_member(val_param_tp, arg->stack_ent);
1110 set_entity_owner(arg->stack_ent, res);
1111 add_struct_member(res, arg->stack_ent);
1112 /* must be automatic to set a fixed layout */
1113 set_entity_allocation(arg->stack_ent, allocation_automatic);
1116 snprintf(buf, sizeof(buf), "param_%d", i);
1117 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1119 ofs += arg->space_before;
1120 ofs = round_up2(ofs, arg->alignment);
1121 set_entity_offset_bytes(arg->stack_ent, ofs);
1122 ofs += arg->space_after;
1123 ofs += get_type_size_bytes(param_type);
1124 map[i] = arg->stack_ent;
1127 set_type_size_bytes(res, ofs);
1128 set_type_state(res, layout_fixed);
1133 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1136 struct obstack obst;
1138 obstack_init(&obst);
1140 /* Create a Perm after the RegParams node to delimit it. */
1141 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1142 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1147 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1148 const arch_register_t *reg = &cls->regs[j];
1149 ir_node *irn = pmap_get(regs, (void *) reg);
1151 if(irn && !arch_register_type_is(reg, ignore)) {
1153 obstack_ptr_grow(&obst, irn);
1154 set_irn_link(irn, (void *) reg);
1158 obstack_ptr_grow(&obst, NULL);
1159 in = obstack_finish(&obst);
1161 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1162 for(j = 0; j < n_regs; ++j) {
1163 ir_node *arg = in[j];
1164 arch_register_t *reg = get_irn_link(arg);
1165 pmap_insert(regs, reg, arg);
1166 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1169 obstack_free(&obst, in);
1172 obstack_free(&obst, NULL);
1177 const arch_register_t *reg;
1181 static int cmp_regs(const void *a, const void *b)
1183 const reg_node_map_t *p = a;
1184 const reg_node_map_t *q = b;
1186 if(p->reg->reg_class == q->reg->reg_class)
1187 return p->reg->index - q->reg->index;
1189 return p->reg->reg_class - q->reg->reg_class;
1192 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1195 int n = pmap_count(reg_map);
1197 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1199 pmap_foreach(reg_map, ent) {
1200 res[i].reg = ent->key;
1201 res[i].irn = ent->value;
1205 qsort(res, n, sizeof(res[0]), cmp_regs);
1210 * Creates a barrier.
1212 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1214 ir_graph *irg = env->birg->irg;
1215 int n_regs = pmap_count(regs);
1221 rm = reg_map_to_arr(&env->obst, regs);
1223 for(n = 0; n < n_regs; ++n)
1224 obstack_ptr_grow(&env->obst, rm[n].irn);
1227 obstack_ptr_grow(&env->obst, *mem);
1231 in = (ir_node **) obstack_finish(&env->obst);
1232 irn = be_new_Barrier(irg, bl, n, in);
1233 obstack_free(&env->obst, in);
1235 for(n = 0; n < n_regs; ++n) {
1236 const arch_register_t *reg = rm[n].reg;
1238 int pos = BE_OUT_POS(n);
1241 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1242 be_node_set_reg_class(irn, n, reg->reg_class);
1244 be_set_constr_single_reg(irn, n, reg);
1245 be_set_constr_single_reg(irn, pos, reg);
1246 be_node_set_reg_class(irn, pos, reg->reg_class);
1247 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1249 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1250 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1251 flags |= arch_irn_flags_ignore;
1253 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1254 flags |= arch_irn_flags_modify_sp;
1256 be_node_set_flags(irn, pos, flags);
1258 pmap_insert(regs, (void *) reg, proj);
1262 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1265 obstack_free(&env->obst, rm);
1270 * Creates a be_Return for a Return node.
1272 * @param @env the abi environment
1273 * @param irn the Return node or NULL if there was none
1274 * @param bl the block where the be_Retun should be placed
1275 * @param mem the current memory
1276 * @param n_res number of return results
1278 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1279 be_abi_call_t *call = env->call;
1280 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1282 pmap *reg_map = pmap_create();
1283 ir_node *keep = pmap_get(env->keep_map, bl);
1289 const arch_register_t **regs;
1293 get the valid stack node in this block.
1294 If we had a call in that block there is a Keep constructed by process_calls()
1295 which points to the last stack modification in that block. we'll use
1296 it then. Else we use the stack from the start block and let
1297 the ssa construction fix the usage.
1299 stack = be_abi_reg_map_get(env->regs, isa->sp);
1301 ir_node *bad = new_r_Bad(env->birg->irg);
1302 stack = get_irn_n(keep, 0);
1303 set_nodes_block(keep, bad);
1304 set_irn_n(keep, 0, bad);
1305 // exchange(keep, new_r_Bad(env->birg->irg));
1308 /* Insert results for Return into the register map. */
1309 for(i = 0; i < n_res; ++i) {
1310 ir_node *res = get_Return_res(irn, i);
1311 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1312 assert(arg->in_reg && "return value must be passed in register");
1313 pmap_insert(reg_map, (void *) arg->reg, res);
1316 /* Add uses of the callee save registers. */
1317 pmap_foreach(env->regs, ent) {
1318 const arch_register_t *reg = ent->key;
1319 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1320 pmap_insert(reg_map, ent->key, ent->value);
1323 be_abi_reg_map_set(reg_map, isa->sp, stack);
1325 /* Make the Epilogue node and call the arch's epilogue maker. */
1326 create_barrier(env, bl, &mem, reg_map, 1);
1327 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1330 Maximum size of the in array for Return nodes is
1331 return args + callee save/ignore registers + memory + stack pointer
1333 in_max = pmap_count(reg_map) + n_res + 2;
1335 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1336 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1339 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1344 /* clear SP entry, since it has already been grown. */
1345 pmap_insert(reg_map, (void *) isa->sp, NULL);
1346 for(i = 0; i < n_res; ++i) {
1347 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1349 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1350 regs[n++] = arg->reg;
1352 /* Clear the map entry to mark the register as processed. */
1353 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1356 /* grow the rest of the stuff. */
1357 pmap_foreach(reg_map, ent) {
1360 regs[n++] = ent->key;
1364 /* The in array for the new back end return is now ready. */
1365 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1367 /* Set the register classes of the return's parameter accordingly. */
1368 for(i = 0; i < n; ++i)
1370 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1372 /* Free the space of the Epilog's in array and the register <-> proj map. */
1373 obstack_free(&env->obst, in);
1374 pmap_destroy(reg_map);
1379 typedef struct lower_frame_sels_env_t {
1381 entity *value_param_list; /**< the list of all value param entities */
1382 } lower_frame_sels_env_t;
1385 * Walker: Replaces Sels of frame type and
1386 * value param type entities by FrameAddress.
1388 static void lower_frame_sels_walker(ir_node *irn, void *data)
1390 lower_frame_sels_env_t *ctx = data;
1393 ir_graph *irg = current_ir_graph;
1394 ir_node *frame = get_irg_frame(irg);
1395 ir_node *param_base = get_irg_value_param_base(irg);
1396 ir_node *ptr = get_Sel_ptr(irn);
1398 if (ptr == frame || ptr == param_base) {
1399 be_abi_irg_t *env = ctx->env;
1400 entity *ent = get_Sel_entity(irn);
1401 ir_node *bl = get_nodes_block(irn);
1404 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1407 if (ptr == param_base) {
1408 set_entity_link(ent, ctx->value_param_list);
1409 ctx->value_param_list = ent;
1416 * Check if a value parameter is transmitted as a register.
1417 * This might happen if the address of an parameter is taken which is
1418 * transmitted in registers.
1420 * Note that on some architectures this case must be handled specially
1421 * because the place of the backing store is determined by their ABI.
1423 * In the default case we move the entity to the frame type and create
1424 * a backing store into the first block.
1426 static void fix_address_of_parameter_access(be_abi_irg_t *env, entity *value_param_list) {
1427 be_abi_call_t *call = env->call;
1428 ir_graph *irg = env->birg->irg;
1429 entity *ent, *next_ent, *new_list;
1431 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1434 for (ent = value_param_list; ent; ent = next_ent) {
1435 int i = get_struct_member_index(get_entity_owner(ent), ent);
1436 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1438 next_ent = get_entity_link(ent);
1440 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1441 set_entity_link(ent, new_list);
1446 /* ok, change the graph */
1447 ir_node *start_bl = get_irg_start_block(irg);
1448 ir_node *first_bl = NULL;
1449 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1450 const ir_edge_t *edge;
1451 optimization_state_t state;
1454 foreach_block_succ(start_bl, edge) {
1455 ir_node *succ = get_edge_src_irn(edge);
1456 if (start_bl != succ) {
1462 /* we had already removed critical edges, so the following
1463 assertion should be always true. */
1464 assert(get_Block_n_cfgpreds(first_bl) == 1);
1466 /* now create backing stores */
1467 frame = get_irg_frame(irg);
1468 imem = get_irg_initial_mem(irg);
1470 save_optimization_state(&state);
1472 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1473 restore_optimization_state(&state);
1475 /* reroute all edges to the new memory source */
1476 edges_reroute(imem, nmem, irg);
1480 args = get_irg_args(irg);
1481 args_bl = get_nodes_block(args);
1482 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1483 int i = get_struct_member_index(get_entity_owner(ent), ent);
1484 ir_type *tp = get_entity_type(ent);
1485 ir_mode *mode = get_type_mode(tp);
1488 /* address for the backing store */
1489 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1492 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1494 /* the backing store itself */
1495 store = new_r_Store(irg, first_bl, mem, addr,
1496 new_r_Proj(irg, args_bl, args, mode, i));
1498 /* the new memory Proj gets the last Proj from store */
1499 set_Proj_pred(nmem, store);
1500 set_Proj_proj(nmem, pn_Store_M);
1502 /* move all entities to the frame type */
1503 frame_tp = get_irg_frame_type(irg);
1504 offset = get_type_size_bytes(frame_tp);
1505 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1506 ir_type *tp = get_entity_type(ent);
1507 int align = get_type_alignment_bytes(tp);
1509 offset += align - 1;
1511 set_entity_owner(ent, frame_tp);
1512 add_class_member(frame_tp, ent);
1513 /* must be automatic to set a fixed layout */
1514 set_entity_allocation(ent, allocation_automatic);
1515 set_entity_offset_bytes(ent, offset);
1516 offset += get_type_size_bytes(tp);
1518 set_type_size_bytes(frame_tp, offset);
1523 * Modify the irg itself and the frame type.
1525 static void modify_irg(be_abi_irg_t *env)
1527 be_abi_call_t *call = env->call;
1528 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1529 const arch_register_t *sp = arch_isa_sp(isa);
1530 ir_graph *irg = env->birg->irg;
1531 ir_node *bl = get_irg_start_block(irg);
1532 ir_node *end = get_irg_end_block(irg);
1533 ir_node *mem = get_irg_initial_mem(irg);
1534 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1535 pset *dont_save = pset_new_ptr(8);
1541 const arch_register_t *fp_reg;
1542 ir_node *frame_pointer;
1544 ir_node *reg_params_bl;
1547 const ir_edge_t *edge;
1548 ir_type *arg_type, *bet_type;
1549 lower_frame_sels_env_t ctx;
1552 bitset_t *used_proj_nr;
1553 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1555 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1557 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1559 ctx.value_param_list = NULL;
1560 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1562 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1563 env->regs = pmap_create();
1565 used_proj_nr = bitset_alloca(1024);
1566 n_params = get_method_n_params(method_type);
1567 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1568 memset(args, 0, n_params * sizeof(args[0]));
1570 /* Check if a value parameter is transmitted as a register.
1571 * This might happen if the address of an parameter is taken which is
1572 * transmitted in registers.
1574 * Note that on some architectures this case must be handled specially
1575 * because the place of the backing store is determined by their ABI.
1577 * In the default case we move the entity to the frame type and create
1578 * a backing store into the first block.
1580 fix_address_of_parameter_access(env, ctx.value_param_list);
1582 /* Fill the argument vector */
1583 arg_tuple = get_irg_args(irg);
1584 foreach_out_edge(arg_tuple, edge) {
1585 ir_node *irn = get_edge_src_irn(edge);
1586 int nr = get_Proj_proj(irn);
1588 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1591 arg_type = compute_arg_type(env, call, method_type, ¶m_map);
1592 bet_type = call->cb->get_between_type(env->cb);
1593 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir, param_map);
1595 /* Count the register params and add them to the number of Projs for the RegParams node */
1596 for(i = 0; i < n_params; ++i) {
1597 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1598 if(arg->in_reg && args[i]) {
1599 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1600 assert(i == get_Proj_proj(args[i]));
1602 /* For now, associate the register with the old Proj from Start representing that argument. */
1603 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1604 bitset_set(used_proj_nr, i);
1605 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1609 /* Collect all callee-save registers */
1610 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1611 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1612 for(j = 0; j < cls->n_regs; ++j) {
1613 const arch_register_t *reg = &cls->regs[j];
1614 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1615 pmap_insert(env->regs, (void *) reg, NULL);
1619 pmap_insert(env->regs, (void *) sp, NULL);
1620 pmap_insert(env->regs, (void *) isa->bp, NULL);
1621 reg_params_bl = get_irg_start_block(irg);
1622 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1625 * make proj nodes for the callee save registers.
1626 * memorize them, since Return nodes get those as inputs.
1628 * Note, that if a register corresponds to an argument, the regs map contains
1629 * the old Proj from start for that argument.
1632 rm = reg_map_to_arr(&env->obst, env->regs);
1633 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1634 arch_register_t *reg = (void *) rm[i].reg;
1635 ir_node *arg_proj = rm[i].irn;
1636 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1638 int pos = BE_OUT_POS((int) nr);
1644 bitset_set(used_proj_nr, nr);
1645 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1646 pmap_insert(env->regs, (void *) reg, proj);
1647 be_set_constr_single_reg(env->reg_params, pos, reg);
1648 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1651 * If the register is an ignore register,
1652 * The Proj for that register shall also be ignored during register allocation.
1654 if(arch_register_type_is(reg, ignore))
1655 flags |= arch_irn_flags_ignore;
1658 flags |= arch_irn_flags_modify_sp;
1660 be_node_set_flags(env->reg_params, pos, flags);
1662 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1664 obstack_free(&env->obst, rm);
1666 /* Generate the Prologue */
1667 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1669 /* do the stack allocation BEFORE the barrier, or spill code
1670 might be added before it */
1671 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1672 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1673 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1675 barrier = create_barrier(env, bl, &mem, env->regs, 0);
1677 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1678 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1680 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1681 set_irg_frame(irg, frame_pointer);
1682 pset_insert_ptr(env->ignore_regs, fp_reg);
1684 /* Now, introduce stack param nodes for all parameters passed on the stack */
1685 for(i = 0; i < n_params; ++i) {
1686 ir_node *arg_proj = args[i];
1687 ir_node *repl = NULL;
1689 if(arg_proj != NULL) {
1690 be_abi_call_arg_t *arg;
1691 ir_type *param_type;
1692 int nr = get_Proj_proj(arg_proj);
1694 nr = MIN(nr, n_params);
1695 arg = get_call_arg(call, 0, nr);
1696 param_type = get_method_param_type(method_type, nr);
1699 repl = pmap_get(env->regs, (void *) arg->reg);
1702 else if(arg->on_stack) {
1703 /* For atomic parameters which are actually used, we create a StackParam node. */
1704 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1705 ir_mode *mode = get_type_mode(param_type);
1706 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1707 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1710 /* The stack parameter is not primitive (it is a struct or array),
1711 we thus will create a node representing the parameter's address
1714 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1718 assert(repl != NULL);
1719 edges_reroute(args[i], repl, irg);
1723 /* All Return nodes hang on the End node, so look for them there. */
1724 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1725 ir_node *irn = get_Block_cfgpred(end, i);
1727 if (is_Return(irn)) {
1728 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1732 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1733 the code is dead and will never be executed. */
1735 del_pset(dont_save);
1736 obstack_free(&env->obst, args);
1739 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1741 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1742 ir_node *old_frame = get_irg_frame(birg->irg);
1743 ir_graph *irg = birg->irg;
1747 optimization_state_t state;
1749 be_omit_fp = birg->main_env->options->omit_fp;
1751 obstack_init(&env->obst);
1753 env->isa = birg->main_env->arch_env->isa;
1754 env->method_type = get_entity_type(get_irg_entity(irg));
1755 env->call = be_abi_call_new();
1756 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1758 env->ignore_regs = pset_new_ptr_default();
1759 env->keep_map = pmap_create();
1760 env->dce_survivor = new_survive_dce();
1762 env->stack_phis = pset_new_ptr(16);
1763 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1764 to another Unknown or the stack pointer gets used */
1765 save_optimization_state(&state);
1767 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1768 restore_optimization_state(&state);
1769 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1771 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1772 env->irn_ops.impl = &abi_irn_ops;
1774 /* Lower all call nodes in the IRG. */
1778 Beware: init backend abi call object after processing calls,
1779 otherwise some information might be not yet available.
1781 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1783 /* Process the IRG */
1786 /* We don't need the keep map anymore. */
1787 pmap_destroy(env->keep_map);
1789 /* reroute the stack origin of the calls to the true stack origin. */
1790 edges_reroute(dummy, env->init_sp, irg);
1791 edges_reroute(old_frame, get_irg_frame(irg), irg);
1793 /* Make some important node pointers survive the dead node elimination. */
1794 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1795 pmap_foreach(env->regs, ent)
1796 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1798 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1800 env->call->cb->done(env->cb);
1804 void be_abi_free(be_abi_irg_t *env)
1806 free_survive_dce(env->dce_survivor);
1807 del_pset(env->stack_phis);
1808 del_pset(env->ignore_regs);
1809 pmap_destroy(env->regs);
1810 obstack_free(&env->obst, NULL);
1811 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1815 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1817 arch_register_t *reg;
1819 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1820 if(reg->reg_class == cls)
1821 bitset_set(bs, reg->index);
1824 /* Returns the stack layout from a abi environment. */
1825 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi) {
1832 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1833 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1834 | _| | |> < ___) | || (_| | (__| <
1835 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1839 struct fix_stack_walker_info {
1841 const arch_env_t *aenv;
1845 * Walker. Collect all stack modifying nodes.
1847 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1849 struct fix_stack_walker_info *info = data;
1854 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1855 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1856 pset_insert_ptr(info->nodes, irn);
1860 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1862 dom_front_info_t *df;
1863 pset *stack_nodes = pset_new_ptr(16);
1864 struct fix_stack_walker_info info;
1866 info.nodes = stack_nodes;
1867 info.aenv = env->birg->main_env->arch_env;
1869 /* We need dominance frontiers for fix up */
1870 df = be_compute_dominance_frontiers(env->birg->irg);
1871 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1872 pset_insert_ptr(stack_nodes, env->init_sp);
1873 be_ssa_constr_set_phis(df, lv, stack_nodes, env->stack_phis);
1874 del_pset(stack_nodes);
1876 /* free these dominance frontiers */
1877 be_free_dominance_frontiers(df);
1880 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1882 const arch_env_t *arch_env = env->birg->main_env->arch_env;
1883 int omit_fp = env->call->flags.bits.try_omit_fp;
1886 sched_foreach(bl, irn) {
1889 Check, if the node relates to an entity on the stack frame.
1890 If so, set the true offset (including the bias) for that
1893 entity *ent = arch_get_frame_entity(arch_env, irn);
1895 int offset = get_stack_entity_offset(env->frame, ent, bias);
1896 arch_set_frame_offset(arch_env, irn, offset);
1897 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
1901 If the node modifies the stack pointer by a constant offset,
1902 record that in the bias.
1904 if(arch_irn_is(arch_env, irn, modify_sp)) {
1905 int ofs = arch_get_sp_bias(arch_env, irn);
1907 if(be_is_IncSP(irn)) {
1908 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
1909 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1910 be_set_IncSP_offset(irn, ofs);
1911 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
1912 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1913 be_set_IncSP_offset(irn, ofs);
1926 * A helper struct for the bias walker.
1929 be_abi_irg_t *env; /**< The ABI irg environment. */
1930 int start_block_bias; /**< The bias at the end of the start block. */
1931 ir_node *start_block; /**< The start block of the current graph. */
1935 * Block-Walker: fix all stack offsets
1937 static void stack_bias_walker(ir_node *bl, void *data)
1939 struct bias_walk *bw = data;
1940 if (bl != bw->start_block) {
1941 process_stack_bias(bw->env, bl, bw->start_block_bias);
1945 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1947 ir_graph *irg = env->birg->irg;
1948 struct bias_walk bw;
1950 stack_frame_compute_initial_offset(env->frame);
1951 // stack_layout_dump(stdout, env->frame);
1953 /* Determine the stack bias at the end of the start block. */
1954 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1956 /* fix the bias is all other blocks */
1958 bw.start_block = get_irg_start_block(irg);
1959 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1962 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1964 assert(arch_register_type_is(reg, callee_save));
1965 assert(pmap_contains(abi->regs, (void *) reg));
1966 return pmap_get(abi->regs, (void *) reg);
1970 _____ _____ _ _ _ _ _ _
1971 |_ _| __ \| \ | | | | | | | | |
1972 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
1973 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
1974 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
1975 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
1977 for Phi nodes which are created due to stack modifying nodes
1978 such as IncSP, AddSP and SetSP.
1980 These Phis are always to be ignored by the reg alloc and are
1981 fixed on the SP register of the ISA.
1984 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
1986 const be_abi_irg_t *abi = get_abi_from_handler(handler);
1987 const void *res = NULL;
1989 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
1990 res = &abi->irn_ops;
1995 static void be_abi_limited(void *data, bitset_t *bs)
1997 be_abi_irg_t *abi = data;
1998 bitset_clear_all(bs);
1999 bitset_set(bs, abi->isa->sp->index);
2002 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)
2004 be_abi_irg_t *abi = get_abi_from_ops(self);
2005 const arch_register_t *reg = abi->isa->sp;
2007 memset(req, 0, sizeof(req[0]));
2009 if(pos == BE_OUT_POS(0)) {
2010 req->cls = reg->reg_class;
2011 req->type = arch_register_req_type_limited;
2012 req->limited = be_abi_limited;
2013 req->limited_env = abi;
2016 else if(pos >= 0 && pos < get_irn_arity(irn)) {
2017 req->cls = reg->reg_class;
2018 req->type = arch_register_req_type_normal;
2024 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
2028 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
2030 const be_abi_irg_t *abi = get_abi_from_ops(self);
2031 return abi->isa->sp;
2034 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
2036 return arch_irn_class_normal;
2039 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2041 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2044 static entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2049 static void abi_set_frame_entity(const void *_self, ir_node *irn, entity *ent)
2053 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2057 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2062 static const arch_irn_ops_if_t abi_irn_ops = {
2063 abi_get_irn_reg_req,
2068 abi_get_frame_entity,
2069 abi_set_frame_entity,
2070 abi_set_frame_offset,
2072 NULL, /* get_inverse */
2073 NULL, /* get_op_estimated_cost */
2074 NULL, /* possible_memory_operand */
2075 NULL, /* perform_memory_operand */
2078 static const arch_irn_handler_t abi_irn_handler = {