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 int arg_size = get_type_size_bytes(get_method_param_type(mt, i));
413 stack_size += round_up2(arg->space_before, arg->alignment);
414 stack_size += round_up2(arg_size, arg->alignment);
415 stack_size += round_up2(arg->space_after, arg->alignment);
416 obstack_int_grow(obst, i);
420 pos = obstack_finish(obst);
422 /* Collect all arguments which are passed in registers. */
423 for(i = 0, n = get_Call_n_params(irn); i < n; ++i) {
424 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
425 if(arg && arg->in_reg) {
426 obstack_int_grow(obst, i);
430 low_args = obstack_finish(obst);
432 /* If there are some parameters which shall be passed on the stack. */
435 int do_seq = call->flags.bits.store_args_sequential && !no_alloc;
438 * Reverse list of stack parameters if call arguments are from left to right.
439 * We must them reverse again in they are pushed (not stored) and the stack
440 * direction is downwards.
442 if (call->flags.bits.left_to_right ^ (do_seq && stack_dir < 0)) {
443 for(i = 0; i < n_pos >> 1; ++i) {
444 int other = n_pos - i - 1;
452 * If the stack is decreasing and we do not want to store sequentially,
453 * or someone else allocated the call frame
454 * we allocate as much space on the stack all parameters need, by
455 * moving the stack pointer along the stack's direction.
457 if(stack_dir < 0 && !do_seq && !no_alloc) {
458 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, stack_size);
460 add_irn_dep(curr_sp, alloca_copy);
466 obstack_ptr_grow(obst, get_Call_mem(irn));
467 curr_mem = new_NoMem();
469 curr_mem = get_Call_mem(irn);
472 assert(mode_is_reference(mach_mode) && "machine mode must be pointer");
473 for(i = 0; i < n_pos; ++i) {
475 be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
476 ir_node *param = get_Call_param(irn, p);
477 ir_node *addr = curr_sp;
479 ir_type *param_type = get_method_param_type(mt, p);
480 int param_size = get_type_size_bytes(param_type) + arg->space_after;
483 * If we wanted to build the arguments sequentially,
484 * the stack pointer for the next must be incremented,
485 * and the memory value propagated.
489 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, param_size + arg->space_before);
491 add_irn_dep(curr_sp, alloca_copy);
494 add_irn_dep(curr_sp, curr_mem);
497 curr_ofs += arg->space_before;
498 curr_ofs = round_up2(curr_ofs, arg->alignment);
500 /* Make the expression to compute the argument's offset. */
502 addr = new_r_Const_long(irg, bl, mode_Is, curr_ofs);
503 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
507 /* Insert a store for primitive arguments. */
508 if (is_atomic_type(param_type)) {
510 store = new_r_Store(irg, bl, curr_mem, addr, param);
511 mem = new_r_Proj(irg, bl, store, mode_M, pn_Store_M);
514 /* Make a mem copy for compound arguments. */
518 assert(mode_is_reference(get_irn_mode(param)));
519 copy = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
520 mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
523 curr_ofs += param_size;
528 obstack_ptr_grow(obst, mem);
531 in = (ir_node **) obstack_finish(obst);
533 /* We need the sync only, if we didn't build the stores sequentially. */
536 curr_mem = new_r_Sync(irg, bl, n_pos + 1, in);
538 curr_mem = get_Call_mem(irn);
541 obstack_free(obst, in);
544 /* Collect caller save registers */
545 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
547 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
548 for(j = 0; j < cls->n_regs; ++j) {
549 const arch_register_t *reg = arch_register_for_index(cls, j);
550 if(arch_register_type_is(reg, caller_save))
551 pset_insert_ptr(caller_save, (void *) reg);
555 /* search the greatest result proj number */
557 /* TODO: what if the result is NOT used? Currently there is
558 * no way to detect this later, especially there is no way to
559 * see this in the proj numbers.
560 * While this is ok for the register allocator, it is bad for
561 * backends which need to change the be_Call further (x87 simulator
562 * for instance. However for this particular case the call_type is
565 foreach_out_edge(irn, edge) {
566 const ir_edge_t *res_edge;
567 ir_node *irn = get_edge_src_irn(edge);
569 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_T_result) {
571 foreach_out_edge(irn, res_edge) {
573 be_abi_call_arg_t *arg;
574 ir_node *res = get_edge_src_irn(res_edge);
576 assert(is_Proj(res));
578 proj = get_Proj_proj(res);
579 arg = get_call_arg(call, 1, proj);
582 shift the proj number to the right, since we will drop the
583 unspeakable Proj_T from the Call. Therefore, all real argument
584 Proj numbers must be increased by pn_be_Call_first_res
586 proj += pn_be_Call_first_res;
587 set_Proj_proj(res, proj);
588 obstack_ptr_grow(obst, res);
590 if(proj > curr_res_proj)
591 curr_res_proj = proj;
593 pset_remove_ptr(caller_save, arg->reg);
594 //pmap_insert(arg_regs, arg->reg, INT_TO_PTR(proj + 1))
601 obstack_ptr_grow(obst, NULL);
602 res_projs = obstack_finish(obst);
604 /* make the back end call node and set its register requirements. */
605 for(i = 0; i < n_low_args; ++i)
606 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
608 in = obstack_finish(obst);
610 if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
611 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, curr_sp,
612 curr_res_proj + pset_count(caller_save), n_low_args, in,
614 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
618 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, call_ptr,
619 curr_res_proj + pset_count(caller_save), n_low_args, in,
624 Set the register class of the call address to the same as the stack pointer's.
625 That' probably buggy for some architectures.
627 be_node_set_reg_class(low_call, be_pos_Call_ptr, sp->reg_class);
629 DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
631 /* Set the register classes and constraints of the Call parameters. */
632 for(i = 0; i < n_low_args; ++i) {
633 int index = low_args[i];
634 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
635 assert(arg->reg != NULL);
637 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + index, arg->reg);
640 /* Set the register constraints of the results. */
641 for(i = 0; res_projs[i]; ++i) {
642 ir_node *irn = res_projs[i];
643 int proj = get_Proj_proj(irn);
645 /* Correct Proj number since it has been adjusted! (see above) */
646 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
649 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
651 obstack_free(obst, in);
652 exchange(irn, low_call);
654 /* redirect the result projs to the lowered call instead of the Proj_T */
655 for(i = 0; res_projs[i]; ++i)
656 set_Proj_pred(res_projs[i], low_call);
658 /* Make additional projs for the caller save registers
659 and the Keep node which keeps them alive. */
660 if(pset_count(caller_save) > 0) {
661 const arch_register_t *reg;
665 for(reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
666 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
668 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
669 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
670 set_irn_link(proj, (void *) reg);
671 obstack_ptr_grow(obst, proj);
675 in = (ir_node **) obstack_finish(obst);
676 keep = be_new_Keep(NULL, irg, bl, n, in);
677 for(i = 0; i < n; ++i) {
678 const arch_register_t *reg = get_irn_link(in[i]);
679 be_node_set_reg_class(keep, i, reg->reg_class);
681 obstack_free(obst, in);
684 /* Clean up the stack. */
686 ir_node *mem_proj = NULL;
688 foreach_out_edge(low_call, edge) {
689 ir_node *irn = get_edge_src_irn(edge);
690 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
697 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
698 keep_alive(mem_proj);
701 /* Clean up the stack frame if we allocated it */
703 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
704 add_irn_dep(curr_sp, mem_proj);
706 add_irn_dep(curr_sp, alloca_copy);
712 be_abi_call_free(call);
713 obstack_free(obst, pos);
715 del_pset(caller_save);
722 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
724 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
726 if (get_Alloc_where(alloc) == stack_alloc) {
727 ir_node *bl = get_nodes_block(alloc);
728 ir_graph *irg = get_irn_irg(bl);
729 ir_node *alloc_mem = NULL;
730 ir_node *alloc_res = NULL;
732 const ir_edge_t *edge;
738 foreach_out_edge(alloc, edge) {
739 ir_node *irn = get_edge_src_irn(edge);
741 assert(is_Proj(irn));
742 switch(get_Proj_proj(irn)) {
754 /* Beware: currently Alloc nodes without a result might happen,
755 only escape analysis kills them and this phase runs only for object
756 oriented source. We kill the Alloc here. */
757 if (alloc_res == NULL && alloc_mem) {
758 exchange(alloc_mem, get_Alloc_mem(alloc));
762 /* The stack pointer will be modified in an unknown manner.
763 We cannot omit it. */
764 env->call->flags.bits.try_omit_fp = 0;
765 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
767 if(alloc_mem != NULL) {
771 addsp_mem = new_r_Proj(irg, bl, new_alloc, mode_M, pn_be_AddSP_M);
773 // We need to sync the output mem of the AddSP with the input mem
774 // edge into the alloc node
775 ins[0] = get_Alloc_mem(alloc);
777 sync = new_r_Sync(irg, bl, 2, ins);
779 exchange(alloc_mem, sync);
782 exchange(alloc, new_alloc);
784 /* fix projnum of alloca res */
785 set_Proj_proj(alloc_res, pn_be_AddSP_res);
787 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
789 /* copy the address away, since it could be used after further stack pointer modifications. */
790 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
791 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, bl, curr_sp);
793 /* Let all users of the Alloc() result now point to the copy. */
794 edges_reroute(alloc_res, copy, irg);
796 /* Rewire the copy appropriately. */
797 set_irn_n(copy, be_pos_Copy_op, addr);
806 * The Free is transformed into a back end free node and connected to the stack nodes.
808 static ir_node *adjust_free(be_abi_irg_t *env, ir_node *free, ir_node *curr_sp)
810 if (get_Free_where(free) == stack_alloc) {
811 ir_node *bl = get_nodes_block(free);
812 ir_graph *irg = get_irn_irg(bl);
813 ir_node *addsp, *mem, *res;
815 /* The stack pointer will be modified in an unknown manner.
816 We cannot omit it. */
817 env->call->flags.bits.try_omit_fp = 0;
818 addsp = be_new_SubSP(env->isa->sp, irg, bl, curr_sp, get_Free_size(free));
820 mem = new_r_Proj(irg, bl, addsp, mode_M, pn_be_SubSP_M);
821 res = new_r_Proj(irg, bl, addsp, mode_P_data, pn_be_SubSP_res);
829 /* the following function is replaced by the usage of the heights module */
832 * Walker for dependent_on().
833 * This function searches a node tgt recursively from a given node
834 * but is restricted to the given block.
835 * @return 1 if tgt was reachable from curr, 0 if not.
837 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
841 if (get_nodes_block(curr) != bl)
847 /* Phi functions stop the recursion inside a basic block */
848 if (! is_Phi(curr)) {
849 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
850 if (check_dependence(get_irn_n(curr, i), tgt, bl))
860 * Check if a node is somehow data dependent on another one.
861 * both nodes must be in the same basic block.
862 * @param n1 The first node.
863 * @param n2 The second node.
864 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
866 static int dependent_on(ir_node *n1, ir_node *n2)
868 ir_node *bl = get_nodes_block(n1);
870 assert(bl == get_nodes_block(n2));
872 return heights_reachable_in_block(ir_heights, n1, n2);
873 //return check_dependence(n1, n2, bl);
876 static int cmp_call_dependecy(const void *c1, const void *c2)
878 ir_node *n1 = *(ir_node **) c1;
879 ir_node *n2 = *(ir_node **) c2;
882 Classical qsort() comparison function behavior:
883 0 if both elements are equal
884 1 if second is "smaller" that first
885 -1 if first is "smaller" that second
887 if (dependent_on(n1, n2))
890 if (dependent_on(n2, n1))
897 * Walker: links all Call/alloc/Free nodes to the Block they are contained.
899 static void link_calls_in_block_walker(ir_node *irn, void *data)
901 opcode code = get_irn_opcode(irn);
903 if (code == iro_Call ||
904 (code == iro_Alloc && get_Alloc_where(irn) == stack_alloc) ||
905 (code == iro_Free && get_Free_where(irn) == stack_alloc)) {
906 be_abi_irg_t *env = data;
907 ir_node *bl = get_nodes_block(irn);
908 void *save = get_irn_link(bl);
910 if (code == iro_Call)
911 env->call->flags.bits.irg_is_leaf = 0;
913 set_irn_link(irn, save);
914 set_irn_link(bl, irn);
920 * Process all Call nodes inside a basic block.
921 * Note that the link field of the block must contain a linked list of all
922 * Call nodes inside the Block. We first order this list according to data dependency
923 * and that connect the calls together.
925 static void process_calls_in_block(ir_node *bl, void *data)
927 be_abi_irg_t *env = data;
928 ir_node *curr_sp = env->init_sp;
932 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
933 obstack_ptr_grow(&env->obst, irn);
935 /* If there were call nodes in the block. */
939 ir_node *copy = NULL;
942 nodes = obstack_finish(&env->obst);
944 /* order the call nodes according to data dependency */
945 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
947 for(i = n - 1; i >= 0; --i) {
948 ir_node *irn = nodes[i];
950 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
951 switch(get_irn_opcode(irn)) {
953 curr_sp = adjust_call(env, irn, curr_sp, copy);
956 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
959 curr_sp = adjust_free(env, irn, curr_sp);
966 obstack_free(&env->obst, nodes);
968 /* Keep the last stack state in the block by tying it to Keep node */
970 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
971 pmap_insert(env->keep_map, bl, keep);
974 set_irn_link(bl, curr_sp);
975 } /* process_calls_in_block */
978 * Adjust all call nodes in the graph to the ABI conventions.
980 static void process_calls(be_abi_irg_t *env)
982 ir_graph *irg = env->birg->irg;
984 env->call->flags.bits.irg_is_leaf = 1;
985 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
987 ir_heights = heights_new(env->birg->irg);
988 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
989 heights_free(ir_heights);
993 static ir_node *setup_frame(be_abi_irg_t *env)
995 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
996 const arch_register_t *sp = isa->sp;
997 const arch_register_t *bp = isa->bp;
998 be_abi_call_flags_bits_t flags = env->call->flags.bits;
999 ir_graph *irg = env->birg->irg;
1000 ir_node *bl = get_irg_start_block(irg);
1001 ir_node *no_mem = get_irg_no_mem(irg);
1002 ir_node *old_frame = get_irg_frame(irg);
1003 ir_node *stack = pmap_get(env->regs, (void *) sp);
1004 ir_node *frame = pmap_get(env->regs, (void *) bp);
1006 int stack_nr = get_Proj_proj(stack);
1008 if(flags.try_omit_fp) {
1009 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
1014 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
1016 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
1017 if(!flags.fp_free) {
1018 be_set_constr_single_reg(frame, -1, bp);
1019 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
1020 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
1023 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
1026 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
1027 env->init_sp = stack;
1028 set_irg_frame(irg, frame);
1029 edges_reroute(old_frame, frame, irg);
1034 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1036 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1037 const arch_register_t *sp = isa->sp;
1038 const arch_register_t *bp = isa->bp;
1039 ir_graph *irg = env->birg->irg;
1040 ir_node *ret_mem = get_Return_mem(ret);
1041 ir_node *frame = get_irg_frame(irg);
1042 ir_node *bl = get_nodes_block(ret);
1043 ir_node *stack = get_irn_link(bl);
1047 if(env->call->flags.bits.try_omit_fp) {
1048 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1052 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1053 be_set_constr_single_reg(stack, -1, sp);
1054 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1057 pmap_foreach(env->regs, ent) {
1058 const arch_register_t *reg = ent->key;
1059 ir_node *irn = ent->value;
1062 obstack_ptr_grow(&env->obst, stack);
1064 obstack_ptr_grow(&env->obst, frame);
1065 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1066 obstack_ptr_grow(obst, irn);
1073 * Computes the stack argument layout type.
1074 * Changes a possibly allocated value param type by moving
1075 * entities to the stack layout type.
1077 * @param env the ABI environment
1078 * @param call the current call ABI
1079 * @param method_type the method type
1080 * @param param_map an array mapping method arguments to the stack layout type
1082 * @return the stack argument layout type
1084 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type, entity ***param_map)
1086 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1087 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1088 int n = get_method_n_params(method_type);
1089 int curr = inc > 0 ? 0 : n - 1;
1095 ir_type *val_param_tp = get_method_value_param_type(method_type);
1096 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1099 *param_map = map = obstack_alloc(&env->obst, n * sizeof(entity *));
1100 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1101 for (i = 0; i < n; ++i, curr += inc) {
1102 ir_type *param_type = get_method_param_type(method_type, curr);
1103 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1106 if (arg->on_stack) {
1108 /* the entity was already created, move it to the param type */
1109 arg->stack_ent = get_method_value_param_ent(method_type, i);
1110 remove_struct_member(val_param_tp, arg->stack_ent);
1111 set_entity_owner(arg->stack_ent, res);
1112 add_struct_member(res, arg->stack_ent);
1113 /* must be automatic to set a fixed layout */
1114 set_entity_allocation(arg->stack_ent, allocation_automatic);
1117 snprintf(buf, sizeof(buf), "param_%d", i);
1118 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1120 ofs += arg->space_before;
1121 ofs = round_up2(ofs, arg->alignment);
1122 set_entity_offset_bytes(arg->stack_ent, ofs);
1123 ofs += arg->space_after;
1124 ofs += get_type_size_bytes(param_type);
1125 map[i] = arg->stack_ent;
1128 set_type_size_bytes(res, ofs);
1129 set_type_state(res, layout_fixed);
1134 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1137 struct obstack obst;
1139 obstack_init(&obst);
1141 /* Create a Perm after the RegParams node to delimit it. */
1142 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1143 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1148 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1149 const arch_register_t *reg = &cls->regs[j];
1150 ir_node *irn = pmap_get(regs, (void *) reg);
1152 if(irn && !arch_register_type_is(reg, ignore)) {
1154 obstack_ptr_grow(&obst, irn);
1155 set_irn_link(irn, (void *) reg);
1159 obstack_ptr_grow(&obst, NULL);
1160 in = obstack_finish(&obst);
1162 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1163 for(j = 0; j < n_regs; ++j) {
1164 ir_node *arg = in[j];
1165 arch_register_t *reg = get_irn_link(arg);
1166 pmap_insert(regs, reg, arg);
1167 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1170 obstack_free(&obst, in);
1173 obstack_free(&obst, NULL);
1178 const arch_register_t *reg;
1182 static int cmp_regs(const void *a, const void *b)
1184 const reg_node_map_t *p = a;
1185 const reg_node_map_t *q = b;
1187 if(p->reg->reg_class == q->reg->reg_class)
1188 return p->reg->index - q->reg->index;
1190 return p->reg->reg_class - q->reg->reg_class;
1193 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1196 int n = pmap_count(reg_map);
1198 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1200 pmap_foreach(reg_map, ent) {
1201 res[i].reg = ent->key;
1202 res[i].irn = ent->value;
1206 qsort(res, n, sizeof(res[0]), cmp_regs);
1211 * Creates a barrier.
1213 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1215 ir_graph *irg = env->birg->irg;
1216 int n_regs = pmap_count(regs);
1222 rm = reg_map_to_arr(&env->obst, regs);
1224 for(n = 0; n < n_regs; ++n)
1225 obstack_ptr_grow(&env->obst, rm[n].irn);
1228 obstack_ptr_grow(&env->obst, *mem);
1232 in = (ir_node **) obstack_finish(&env->obst);
1233 irn = be_new_Barrier(irg, bl, n, in);
1234 obstack_free(&env->obst, in);
1236 for(n = 0; n < n_regs; ++n) {
1237 const arch_register_t *reg = rm[n].reg;
1239 int pos = BE_OUT_POS(n);
1242 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1243 be_node_set_reg_class(irn, n, reg->reg_class);
1245 be_set_constr_single_reg(irn, n, reg);
1246 be_set_constr_single_reg(irn, pos, reg);
1247 be_node_set_reg_class(irn, pos, reg->reg_class);
1248 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1250 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1251 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1252 flags |= arch_irn_flags_ignore;
1254 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1255 flags |= arch_irn_flags_modify_sp;
1257 be_node_set_flags(irn, pos, flags);
1259 pmap_insert(regs, (void *) reg, proj);
1263 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1266 obstack_free(&env->obst, rm);
1271 * Creates a be_Return for a Return node.
1273 * @param @env the abi environment
1274 * @param irn the Return node or NULL if there was none
1275 * @param bl the block where the be_Retun should be placed
1276 * @param mem the current memory
1277 * @param n_res number of return results
1279 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1280 be_abi_call_t *call = env->call;
1281 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1283 pmap *reg_map = pmap_create();
1284 ir_node *keep = pmap_get(env->keep_map, bl);
1290 const arch_register_t **regs;
1294 get the valid stack node in this block.
1295 If we had a call in that block there is a Keep constructed by process_calls()
1296 which points to the last stack modification in that block. we'll use
1297 it then. Else we use the stack from the start block and let
1298 the ssa construction fix the usage.
1300 stack = be_abi_reg_map_get(env->regs, isa->sp);
1302 ir_node *bad = new_r_Bad(env->birg->irg);
1303 stack = get_irn_n(keep, 0);
1304 set_nodes_block(keep, bad);
1305 set_irn_n(keep, 0, bad);
1306 // exchange(keep, new_r_Bad(env->birg->irg));
1309 /* Insert results for Return into the register map. */
1310 for(i = 0; i < n_res; ++i) {
1311 ir_node *res = get_Return_res(irn, i);
1312 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1313 assert(arg->in_reg && "return value must be passed in register");
1314 pmap_insert(reg_map, (void *) arg->reg, res);
1317 /* Add uses of the callee save registers. */
1318 pmap_foreach(env->regs, ent) {
1319 const arch_register_t *reg = ent->key;
1320 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1321 pmap_insert(reg_map, ent->key, ent->value);
1324 be_abi_reg_map_set(reg_map, isa->sp, stack);
1326 /* Make the Epilogue node and call the arch's epilogue maker. */
1327 create_barrier(env, bl, &mem, reg_map, 1);
1328 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1331 Maximum size of the in array for Return nodes is
1332 return args + callee save/ignore registers + memory + stack pointer
1334 in_max = pmap_count(reg_map) + n_res + 2;
1336 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1337 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1340 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1345 /* clear SP entry, since it has already been grown. */
1346 pmap_insert(reg_map, (void *) isa->sp, NULL);
1347 for(i = 0; i < n_res; ++i) {
1348 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1350 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1351 regs[n++] = arg->reg;
1353 /* Clear the map entry to mark the register as processed. */
1354 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1357 /* grow the rest of the stuff. */
1358 pmap_foreach(reg_map, ent) {
1361 regs[n++] = ent->key;
1365 /* The in array for the new back end return is now ready. */
1366 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1368 /* Set the register classes of the return's parameter accordingly. */
1369 for(i = 0; i < n; ++i)
1371 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1373 /* Free the space of the Epilog's in array and the register <-> proj map. */
1374 obstack_free(&env->obst, in);
1375 pmap_destroy(reg_map);
1380 typedef struct lower_frame_sels_env_t {
1382 entity *value_param_list; /**< the list of all value param entities */
1383 } lower_frame_sels_env_t;
1386 * Walker: Replaces Sels of frame type and
1387 * value param type entities by FrameAddress.
1389 static void lower_frame_sels_walker(ir_node *irn, void *data)
1391 lower_frame_sels_env_t *ctx = data;
1394 ir_graph *irg = current_ir_graph;
1395 ir_node *frame = get_irg_frame(irg);
1396 ir_node *param_base = get_irg_value_param_base(irg);
1397 ir_node *ptr = get_Sel_ptr(irn);
1399 if (ptr == frame || ptr == param_base) {
1400 be_abi_irg_t *env = ctx->env;
1401 entity *ent = get_Sel_entity(irn);
1402 ir_node *bl = get_nodes_block(irn);
1405 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1408 if (ptr == param_base) {
1409 set_entity_link(ent, ctx->value_param_list);
1410 ctx->value_param_list = ent;
1417 * Check if a value parameter is transmitted as a register.
1418 * This might happen if the address of an parameter is taken which is
1419 * transmitted in registers.
1421 * Note that on some architectures this case must be handled specially
1422 * because the place of the backing store is determined by their ABI.
1424 * In the default case we move the entity to the frame type and create
1425 * a backing store into the first block.
1427 static void fix_address_of_parameter_access(be_abi_irg_t *env, entity *value_param_list) {
1428 be_abi_call_t *call = env->call;
1429 ir_graph *irg = env->birg->irg;
1430 entity *ent, *next_ent, *new_list;
1432 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1435 for (ent = value_param_list; ent; ent = next_ent) {
1436 int i = get_struct_member_index(get_entity_owner(ent), ent);
1437 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1439 next_ent = get_entity_link(ent);
1441 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1442 set_entity_link(ent, new_list);
1447 /* ok, change the graph */
1448 ir_node *start_bl = get_irg_start_block(irg);
1449 ir_node *first_bl = NULL;
1450 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1451 const ir_edge_t *edge;
1452 optimization_state_t state;
1455 foreach_block_succ(start_bl, edge) {
1456 ir_node *succ = get_edge_src_irn(edge);
1457 if (start_bl != succ) {
1463 /* we had already removed critical edges, so the following
1464 assertion should be always true. */
1465 assert(get_Block_n_cfgpreds(first_bl) == 1);
1467 /* now create backing stores */
1468 frame = get_irg_frame(irg);
1469 imem = get_irg_initial_mem(irg);
1471 save_optimization_state(&state);
1473 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1474 restore_optimization_state(&state);
1476 /* reroute all edges to the new memory source */
1477 edges_reroute(imem, nmem, irg);
1481 args = get_irg_args(irg);
1482 args_bl = get_nodes_block(args);
1483 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1484 int i = get_struct_member_index(get_entity_owner(ent), ent);
1485 ir_type *tp = get_entity_type(ent);
1486 ir_mode *mode = get_type_mode(tp);
1489 /* address for the backing store */
1490 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1493 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1495 /* the backing store itself */
1496 store = new_r_Store(irg, first_bl, mem, addr,
1497 new_r_Proj(irg, args_bl, args, mode, i));
1499 /* the new memory Proj gets the last Proj from store */
1500 set_Proj_pred(nmem, store);
1501 set_Proj_proj(nmem, pn_Store_M);
1503 /* move all entities to the frame type */
1504 frame_tp = get_irg_frame_type(irg);
1505 offset = get_type_size_bytes(frame_tp);
1506 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1507 ir_type *tp = get_entity_type(ent);
1508 int align = get_type_alignment_bytes(tp);
1510 offset += align - 1;
1512 set_entity_owner(ent, frame_tp);
1513 add_class_member(frame_tp, ent);
1514 /* must be automatic to set a fixed layout */
1515 set_entity_allocation(ent, allocation_automatic);
1516 set_entity_offset_bytes(ent, offset);
1517 offset += get_type_size_bytes(tp);
1519 set_type_size_bytes(frame_tp, offset);
1524 * Modify the irg itself and the frame type.
1526 static void modify_irg(be_abi_irg_t *env)
1528 be_abi_call_t *call = env->call;
1529 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1530 const arch_register_t *sp = arch_isa_sp(isa);
1531 ir_graph *irg = env->birg->irg;
1532 ir_node *bl = get_irg_start_block(irg);
1533 ir_node *end = get_irg_end_block(irg);
1534 ir_node *mem = get_irg_initial_mem(irg);
1535 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1536 pset *dont_save = pset_new_ptr(8);
1542 const arch_register_t *fp_reg;
1543 ir_node *frame_pointer;
1545 ir_node *reg_params_bl;
1548 const ir_edge_t *edge;
1549 ir_type *arg_type, *bet_type;
1550 lower_frame_sels_env_t ctx;
1553 bitset_t *used_proj_nr;
1554 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1556 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1558 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1560 ctx.value_param_list = NULL;
1561 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1563 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1564 env->regs = pmap_create();
1566 used_proj_nr = bitset_alloca(1024);
1567 n_params = get_method_n_params(method_type);
1568 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1569 memset(args, 0, n_params * sizeof(args[0]));
1571 /* Check if a value parameter is transmitted as a register.
1572 * This might happen if the address of an parameter is taken which is
1573 * transmitted in registers.
1575 * Note that on some architectures this case must be handled specially
1576 * because the place of the backing store is determined by their ABI.
1578 * In the default case we move the entity to the frame type and create
1579 * a backing store into the first block.
1581 fix_address_of_parameter_access(env, ctx.value_param_list);
1583 /* Fill the argument vector */
1584 arg_tuple = get_irg_args(irg);
1585 foreach_out_edge(arg_tuple, edge) {
1586 ir_node *irn = get_edge_src_irn(edge);
1587 int nr = get_Proj_proj(irn);
1589 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1592 arg_type = compute_arg_type(env, call, method_type, ¶m_map);
1593 bet_type = call->cb->get_between_type(env->cb);
1594 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir, param_map);
1596 /* Count the register params and add them to the number of Projs for the RegParams node */
1597 for(i = 0; i < n_params; ++i) {
1598 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1599 if(arg->in_reg && args[i]) {
1600 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1601 assert(i == get_Proj_proj(args[i]));
1603 /* For now, associate the register with the old Proj from Start representing that argument. */
1604 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1605 bitset_set(used_proj_nr, i);
1606 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1610 /* Collect all callee-save registers */
1611 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1612 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1613 for(j = 0; j < cls->n_regs; ++j) {
1614 const arch_register_t *reg = &cls->regs[j];
1615 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1616 pmap_insert(env->regs, (void *) reg, NULL);
1620 pmap_insert(env->regs, (void *) sp, NULL);
1621 pmap_insert(env->regs, (void *) isa->bp, NULL);
1622 reg_params_bl = get_irg_start_block(irg);
1623 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1626 * make proj nodes for the callee save registers.
1627 * memorize them, since Return nodes get those as inputs.
1629 * Note, that if a register corresponds to an argument, the regs map contains
1630 * the old Proj from start for that argument.
1633 rm = reg_map_to_arr(&env->obst, env->regs);
1634 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1635 arch_register_t *reg = (void *) rm[i].reg;
1636 ir_node *arg_proj = rm[i].irn;
1637 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1639 int pos = BE_OUT_POS((int) nr);
1645 bitset_set(used_proj_nr, nr);
1646 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1647 pmap_insert(env->regs, (void *) reg, proj);
1648 be_set_constr_single_reg(env->reg_params, pos, reg);
1649 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1652 * If the register is an ignore register,
1653 * The Proj for that register shall also be ignored during register allocation.
1655 if(arch_register_type_is(reg, ignore))
1656 flags |= arch_irn_flags_ignore;
1659 flags |= arch_irn_flags_modify_sp;
1661 be_node_set_flags(env->reg_params, pos, flags);
1663 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1665 obstack_free(&env->obst, rm);
1667 /* Generate the Prologue */
1668 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1670 /* do the stack allocation BEFORE the barrier, or spill code
1671 might be added before it */
1672 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1673 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1674 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1676 barrier = create_barrier(env, bl, &mem, env->regs, 0);
1678 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1679 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1681 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1682 set_irg_frame(irg, frame_pointer);
1683 pset_insert_ptr(env->ignore_regs, fp_reg);
1685 /* Now, introduce stack param nodes for all parameters passed on the stack */
1686 for(i = 0; i < n_params; ++i) {
1687 ir_node *arg_proj = args[i];
1688 ir_node *repl = NULL;
1690 if(arg_proj != NULL) {
1691 be_abi_call_arg_t *arg;
1692 ir_type *param_type;
1693 int nr = get_Proj_proj(arg_proj);
1695 nr = MIN(nr, n_params);
1696 arg = get_call_arg(call, 0, nr);
1697 param_type = get_method_param_type(method_type, nr);
1700 repl = pmap_get(env->regs, (void *) arg->reg);
1703 else if(arg->on_stack) {
1704 /* For atomic parameters which are actually used, we create a StackParam node. */
1705 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1706 ir_mode *mode = get_type_mode(param_type);
1707 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1708 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1711 /* The stack parameter is not primitive (it is a struct or array),
1712 we thus will create a node representing the parameter's address
1715 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1719 assert(repl != NULL);
1720 edges_reroute(args[i], repl, irg);
1724 /* All Return nodes hang on the End node, so look for them there. */
1725 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1726 ir_node *irn = get_Block_cfgpred(end, i);
1728 if (is_Return(irn)) {
1729 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1733 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1734 the code is dead and will never be executed. */
1736 del_pset(dont_save);
1737 obstack_free(&env->obst, args);
1740 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1742 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1743 ir_node *old_frame = get_irg_frame(birg->irg);
1744 ir_graph *irg = birg->irg;
1748 optimization_state_t state;
1750 be_omit_fp = birg->main_env->options->omit_fp;
1752 obstack_init(&env->obst);
1754 env->isa = birg->main_env->arch_env->isa;
1755 env->method_type = get_entity_type(get_irg_entity(irg));
1756 env->call = be_abi_call_new();
1757 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1759 env->ignore_regs = pset_new_ptr_default();
1760 env->keep_map = pmap_create();
1761 env->dce_survivor = new_survive_dce();
1763 env->stack_phis = pset_new_ptr(16);
1764 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1765 to another Unknown or the stack pointer gets used */
1766 save_optimization_state(&state);
1768 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1769 restore_optimization_state(&state);
1770 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1772 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1773 env->irn_ops.impl = &abi_irn_ops;
1775 /* Lower all call nodes in the IRG. */
1779 Beware: init backend abi call object after processing calls,
1780 otherwise some information might be not yet available.
1782 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1784 /* Process the IRG */
1787 /* We don't need the keep map anymore. */
1788 pmap_destroy(env->keep_map);
1790 /* reroute the stack origin of the calls to the true stack origin. */
1791 edges_reroute(dummy, env->init_sp, irg);
1792 edges_reroute(old_frame, get_irg_frame(irg), irg);
1794 /* Make some important node pointers survive the dead node elimination. */
1795 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1796 pmap_foreach(env->regs, ent)
1797 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1799 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1801 env->call->cb->done(env->cb);
1806 void be_abi_free(be_abi_irg_t *env)
1808 free_survive_dce(env->dce_survivor);
1809 del_pset(env->stack_phis);
1810 del_pset(env->ignore_regs);
1811 pmap_destroy(env->regs);
1812 obstack_free(&env->obst, NULL);
1813 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1817 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1819 arch_register_t *reg;
1821 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1822 if(reg->reg_class == cls)
1823 bitset_set(bs, reg->index);
1826 /* Returns the stack layout from a abi environment. */
1827 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi) {
1834 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1835 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1836 | _| | |> < ___) | || (_| | (__| <
1837 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1841 struct fix_stack_walker_info {
1843 const arch_env_t *aenv;
1847 * Walker. Collect all stack modifying nodes.
1849 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1851 struct fix_stack_walker_info *info = data;
1856 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1857 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1858 pset_insert_ptr(info->nodes, irn);
1862 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1864 dom_front_info_t *df;
1865 pset *stack_nodes = pset_new_ptr(16);
1866 struct fix_stack_walker_info info;
1868 info.nodes = stack_nodes;
1869 info.aenv = env->birg->main_env->arch_env;
1871 /* We need dominance frontiers for fix up */
1872 df = be_compute_dominance_frontiers(env->birg->irg);
1873 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1874 pset_insert_ptr(stack_nodes, env->init_sp);
1875 be_ssa_constr_set_phis(df, lv, stack_nodes, env->stack_phis);
1876 del_pset(stack_nodes);
1878 /* free these dominance frontiers */
1879 be_free_dominance_frontiers(df);
1882 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1884 const arch_env_t *arch_env = env->birg->main_env->arch_env;
1885 int omit_fp = env->call->flags.bits.try_omit_fp;
1888 sched_foreach(bl, irn) {
1891 Check, if the node relates to an entity on the stack frame.
1892 If so, set the true offset (including the bias) for that
1895 entity *ent = arch_get_frame_entity(arch_env, irn);
1897 int offset = get_stack_entity_offset(env->frame, ent, bias);
1898 arch_set_frame_offset(arch_env, irn, offset);
1899 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
1903 If the node modifies the stack pointer by a constant offset,
1904 record that in the bias.
1906 if(arch_irn_is(arch_env, irn, modify_sp)) {
1907 int ofs = arch_get_sp_bias(arch_env, irn);
1909 if(be_is_IncSP(irn)) {
1910 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
1911 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1912 be_set_IncSP_offset(irn, ofs);
1913 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
1914 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1915 be_set_IncSP_offset(irn, ofs);
1928 * A helper struct for the bias walker.
1931 be_abi_irg_t *env; /**< The ABI irg environment. */
1932 int start_block_bias; /**< The bias at the end of the start block. */
1933 ir_node *start_block; /**< The start block of the current graph. */
1937 * Block-Walker: fix all stack offsets
1939 static void stack_bias_walker(ir_node *bl, void *data)
1941 struct bias_walk *bw = data;
1942 if (bl != bw->start_block) {
1943 process_stack_bias(bw->env, bl, bw->start_block_bias);
1947 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1949 ir_graph *irg = env->birg->irg;
1950 struct bias_walk bw;
1952 stack_frame_compute_initial_offset(env->frame);
1953 // stack_layout_dump(stdout, env->frame);
1955 /* Determine the stack bias at the end of the start block. */
1956 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1958 /* fix the bias is all other blocks */
1960 bw.start_block = get_irg_start_block(irg);
1961 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1964 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1966 assert(arch_register_type_is(reg, callee_save));
1967 assert(pmap_contains(abi->regs, (void *) reg));
1968 return pmap_get(abi->regs, (void *) reg);
1971 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1973 assert(arch_register_type_is(reg, ignore));
1974 assert(pmap_contains(abi->regs, (void *) reg));
1975 return pmap_get(abi->regs, (void *) reg);
1979 _____ _____ _ _ _ _ _ _
1980 |_ _| __ \| \ | | | | | | | | |
1981 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
1982 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
1983 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
1984 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
1986 for Phi nodes which are created due to stack modifying nodes
1987 such as IncSP, AddSP and SetSP.
1989 These Phis are always to be ignored by the reg alloc and are
1990 fixed on the SP register of the ISA.
1993 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
1995 const be_abi_irg_t *abi = get_abi_from_handler(handler);
1996 const void *res = NULL;
1998 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
1999 res = &abi->irn_ops;
2004 static void be_abi_limited(void *data, bitset_t *bs)
2006 be_abi_irg_t *abi = data;
2007 bitset_clear_all(bs);
2008 bitset_set(bs, abi->isa->sp->index);
2011 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)
2013 be_abi_irg_t *abi = get_abi_from_ops(self);
2014 const arch_register_t *reg = abi->isa->sp;
2016 memset(req, 0, sizeof(req[0]));
2018 if(pos == BE_OUT_POS(0)) {
2019 req->cls = reg->reg_class;
2020 req->type = arch_register_req_type_limited;
2021 req->limited = be_abi_limited;
2022 req->limited_env = abi;
2025 else if(pos >= 0 && pos < get_irn_arity(irn)) {
2026 req->cls = reg->reg_class;
2027 req->type = arch_register_req_type_normal;
2033 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
2037 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
2039 const be_abi_irg_t *abi = get_abi_from_ops(self);
2040 return abi->isa->sp;
2043 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
2045 return arch_irn_class_normal;
2048 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2050 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2053 static entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2058 static void abi_set_frame_entity(const void *_self, ir_node *irn, entity *ent)
2062 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2066 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2071 static const arch_irn_ops_if_t abi_irn_ops = {
2072 abi_get_irn_reg_req,
2077 abi_get_frame_entity,
2078 abi_set_frame_entity,
2079 abi_set_frame_offset,
2081 NULL, /* get_inverse */
2082 NULL, /* get_op_estimated_cost */
2083 NULL, /* possible_memory_operand */
2084 NULL, /* perform_memory_operand */
2087 static const arch_irn_handler_t abi_irn_handler = {
2092 * Returns non-zero if the ABI has omitted the frame pointer in
2093 * the current graph.
2095 int be_abi_omit_fp(const be_abi_irg_t *abi) {
2096 return abi->call->flags.bits.try_omit_fp;