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 #define N_FRAME_TYPES 3
62 * This type describes the stack layout.
63 * The stack is divided into 3 parts:
64 * - arg_type: A struct type describing the stack arguments and it's order.
65 * - between_type: A struct type describing the stack layout between arguments
67 * - frame_type: A class type descibing the frame layout
69 typedef struct _be_stack_layout_t {
70 ir_type *arg_type; /**< A type describing the stack argument layout. */
71 ir_type *between_type; /**< A type describing the "between" layout. */
72 ir_type *frame_type; /**< The frame type. */
74 ir_type *order[N_FRAME_TYPES]; /**< arg, between and frame types ordered. */
77 int stack_dir; /**< -1 for decreasing, 1 for increasing. */
80 struct _be_abi_irg_t {
82 be_stack_layout_t *frame; /**< The stack frame model. */
83 const be_irg_t *birg; /**< The back end IRG. */
84 const arch_isa_t *isa; /**< The isa. */
85 survive_dce_t *dce_survivor;
87 be_abi_call_t *call; /**< The ABI call information. */
88 ir_type *method_type; /**< The type of the method of the IRG. */
90 ir_node *init_sp; /**< The node representing the stack pointer
91 at the start of the function. */
93 ir_node *reg_params; /**< The reg params node. */
94 pmap *regs; /**< A map of all callee-save and ignore regs to
95 their Projs to the RegParams node. */
97 pset *stack_phis; /**< The set of all Phi nodes inserted due to
98 stack pointer modifying nodes. */
100 int start_block_bias; /**< The stack bias at the end of the start block. */
102 void *cb; /**< ABI Callback self pointer. */
104 pmap *keep_map; /**< mapping blocks to keep nodes. */
105 pset *ignore_regs; /**< Additional registers which shall be ignored. */
107 arch_irn_handler_t irn_handler;
108 arch_irn_ops_t irn_ops;
109 DEBUG_ONLY(firm_dbg_module_t *dbg;) /**< The debugging module. */
112 #define get_abi_from_handler(ptr) firm_container_of(ptr, be_abi_irg_t, irn_handler)
113 #define get_abi_from_ops(ptr) firm_container_of(ptr, be_abi_irg_t, irn_ops)
115 /* Forward, since be need it in be_abi_introduce(). */
116 static const arch_irn_ops_if_t abi_irn_ops;
117 static const arch_irn_handler_t abi_irn_handler;
118 static heights_t *ir_heights;
120 /* Flag: if set, try to omit the frame pointer if called by the backend */
124 _ ____ ___ ____ _ _ _ _
125 / \ | __ )_ _| / ___|__ _| | | |__ __ _ ___| | _____
126 / _ \ | _ \| | | | / _` | | | '_ \ / _` |/ __| |/ / __|
127 / ___ \| |_) | | | |__| (_| | | | |_) | (_| | (__| <\__ \
128 /_/ \_\____/___| \____\__,_|_|_|_.__/ \__,_|\___|_|\_\___/
130 These callbacks are used by the backend to set the parameters
131 for a specific call type.
135 * Set compare function: compares two ABI call object arguments.
137 static int cmp_call_arg(const void *a, const void *b, size_t n)
139 const be_abi_call_arg_t *p = a, *q = b;
140 return !(p->is_res == q->is_res && p->pos == q->pos);
144 * Get or set an ABI call object argument.
146 * @param call the abi call
147 * @param is_res true for call results, false for call arguments
148 * @param pos position of the argument
149 * @param do_insert true if the argument is set, false if it's retrieved
151 static be_abi_call_arg_t *get_or_set_call_arg(be_abi_call_t *call, int is_res, int pos, int do_insert)
153 be_abi_call_arg_t arg;
156 memset(&arg, 0, sizeof(arg));
160 hash = is_res * 128 + pos;
163 ? set_insert(call->params, &arg, sizeof(arg), hash)
164 : set_find(call->params, &arg, sizeof(arg), hash);
168 * Retrieve an ABI call object argument.
170 * @param call the ABI call object
171 * @param is_res true for call results, false for call arguments
172 * @param pos position of the argument
174 static INLINE be_abi_call_arg_t *get_call_arg(be_abi_call_t *call, int is_res, int pos)
176 return get_or_set_call_arg(call, is_res, pos, 0);
179 /* Set the flags for a call. */
180 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb)
186 void be_abi_call_param_stack(be_abi_call_t *call, int arg_pos, unsigned alignment, unsigned space_before, unsigned space_after)
188 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
190 arg->alignment = alignment;
191 arg->space_before = space_before;
192 arg->space_after = space_after;
193 assert(alignment > 0 && "Alignment must be greater than 0");
196 void be_abi_call_param_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
198 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
203 void be_abi_call_res_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
205 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 1, arg_pos, 1);
210 /* Get the flags of a ABI call object. */
211 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call)
217 * Constructor for a new ABI call object.
219 * @return the new ABI call object
221 static be_abi_call_t *be_abi_call_new(void)
223 be_abi_call_t *call = xmalloc(sizeof(call[0]));
225 call->params = new_set(cmp_call_arg, 16);
228 call->flags.bits.try_omit_fp = be_omit_fp;
233 * Destructor for an ABI call object.
235 static void be_abi_call_free(be_abi_call_t *call)
237 del_set(call->params);
243 | ___| __ __ _ _ __ ___ ___ | | | | __ _ _ __ __| | (_)_ __ __ _
244 | |_ | '__/ _` | '_ ` _ \ / _ \ | |_| |/ _` | '_ \ / _` | | | '_ \ / _` |
245 | _|| | | (_| | | | | | | __/ | _ | (_| | | | | (_| | | | | | | (_| |
246 |_| |_| \__,_|_| |_| |_|\___| |_| |_|\__,_|_| |_|\__,_|_|_|_| |_|\__, |
249 Handling of the stack frame. It is composed of three types:
250 1) The type of the arguments which are pushed on the stack.
251 2) The "between type" which consists of stuff the call of the
252 function pushes on the stack (like the return address and
253 the old base pointer for ia32).
254 3) The Firm frame type which consists of all local variables
258 static int get_stack_entity_offset(be_stack_layout_t *frame, entity *ent, int bias)
260 ir_type *t = get_entity_owner(ent);
261 int ofs = get_entity_offset_bytes(ent);
265 /* Find the type the entity is contained in. */
266 for(index = 0; index < N_FRAME_TYPES; ++index) {
267 if(frame->order[index] == t)
271 /* Add the size of all the types below the one of the entity to the entity's offset */
272 for(i = 0; i < index; ++i)
273 ofs += get_type_size_bytes(frame->order[i]);
275 /* correct the offset by the initial position of the frame pointer */
276 ofs -= frame->initial_offset;
278 /* correct the offset with the current bias. */
285 * Retrieve the entity with given offset from a frame type.
287 static entity *search_ent_with_offset(ir_type *t, int offset)
291 for(i = 0, n = get_compound_n_members(t); i < n; ++i) {
292 entity *ent = get_compound_member(t, i);
293 if(get_entity_offset_bytes(ent) == offset)
300 static int stack_frame_compute_initial_offset(be_stack_layout_t *frame)
302 ir_type *base = frame->stack_dir < 0 ? frame->between_type : frame->frame_type;
303 entity *ent = search_ent_with_offset(base, 0);
304 frame->initial_offset = 0;
305 frame->initial_offset = get_stack_entity_offset(frame, ent, 0);
306 return frame->initial_offset;
310 * Initializes the frame layout from parts
312 * @param frame the stack layout that will be initialized
313 * @param args the stack argument layout type
314 * @param between the between layout type
315 * @param locals the method frame type
316 * @param stack_dir the stack direction
318 * @return the initialized stack layout
320 static be_stack_layout_t *stack_frame_init(be_stack_layout_t *frame, ir_type *args,
321 ir_type *between, ir_type *locals, int stack_dir)
323 frame->arg_type = args;
324 frame->between_type = between;
325 frame->frame_type = locals;
326 frame->initial_offset = 0;
327 frame->stack_dir = stack_dir;
328 frame->order[1] = between;
331 frame->order[0] = args;
332 frame->order[2] = locals;
335 frame->order[0] = locals;
336 frame->order[2] = args;
341 /** Dumps the stack layout to file. */
342 static void stack_layout_dump(FILE *file, be_stack_layout_t *frame)
346 ir_fprintf(file, "initial offset: %d\n", frame->initial_offset);
347 for (j = 0; j < N_FRAME_TYPES; ++j) {
348 ir_type *t = frame->order[j];
350 ir_fprintf(file, "type %d: %F size: %d\n", j, t, get_type_size_bytes(t));
351 for (i = 0, n = get_compound_n_members(t); i < n; ++i) {
352 entity *ent = get_compound_member(t, i);
353 ir_fprintf(file, "\t%F int ofs: %d glob ofs: %d\n", ent, get_entity_offset_bytes(ent), get_stack_entity_offset(frame, ent, 0));
359 * Returns non-zero if the call argument at given position
360 * is transfered on the stack.
362 static INLINE int is_on_stack(be_abi_call_t *call, int pos)
364 be_abi_call_arg_t *arg = get_call_arg(call, 0, pos);
365 return arg && !arg->in_reg;
375 Adjustment of the calls inside a graph.
380 * Transform a call node.
381 * @param env The ABI environment for the current irg.
382 * @param irn The call node.
383 * @param curr_sp The stack pointer node to use.
384 * @return The stack pointer after the call.
386 static ir_node *adjust_call(be_abi_irg_t *env, ir_node *irn, ir_node *curr_sp, ir_node *alloca_copy)
388 ir_graph *irg = env->birg->irg;
389 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
390 be_abi_call_t *call = be_abi_call_new();
391 ir_type *mt = get_Call_type(irn);
392 ir_node *call_ptr = get_Call_ptr(irn);
393 int n_params = get_method_n_params(mt);
394 ir_node *curr_mem = get_Call_mem(irn);
395 ir_node *bl = get_nodes_block(irn);
396 pset *results = pset_new_ptr(8);
397 pset *caller_save = pset_new_ptr(8);
399 int stack_dir = arch_isa_stack_dir(isa);
400 const arch_register_t *sp = arch_isa_sp(isa);
401 ir_mode *mach_mode = sp->reg_class->mode;
402 struct obstack *obst = &env->obst;
403 int no_alloc = call->flags.bits.frame_is_setup_on_call;
405 ir_node *res_proj = NULL;
406 int curr_res_proj = pn_Call_max;
413 const ir_edge_t *edge;
418 /* Let the isa fill out the abi description for that call node. */
419 arch_isa_get_call_abi(isa, mt, call);
421 /* Insert code to put the stack arguments on the stack. */
422 assert(get_Call_n_params(irn) == n_params);
423 for(i = 0; i < n_params; ++i) {
424 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
427 stack_size += arg->space_before;
428 stack_size = round_up2(stack_size, arg->alignment);
429 stack_size += get_type_size_bytes(get_method_param_type(mt, i));
430 stack_size += arg->space_after;
431 obstack_int_grow(obst, i);
435 pos = obstack_finish(obst);
437 /* Collect all arguments which are passed in registers. */
438 for(i = 0, n = get_Call_n_params(irn); i < n; ++i) {
439 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
440 if(arg && arg->in_reg) {
441 obstack_int_grow(obst, i);
445 low_args = obstack_finish(obst);
447 /* If there are some parameters which shall be passed on the stack. */
450 int do_seq = call->flags.bits.store_args_sequential && !no_alloc;
453 * Reverse list of stack parameters if call arguments are from left to right.
454 * We must them reverse again in they are pushed (not stored) and the stack
455 * direction is downwards.
457 if (call->flags.bits.left_to_right ^ (do_seq && stack_dir < 0)) {
458 for(i = 0; i < n_pos >> 1; ++i) {
459 int other = n_pos - i - 1;
467 * If the stack is decreasing and we do not want to store sequentially,
468 * or someone else allocated the call frame
469 * we allocate as much space on the stack all parameters need, by
470 * moving the stack pointer along the stack's direction.
472 if(stack_dir < 0 && !do_seq && !no_alloc) {
473 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, stack_size);
475 add_irn_dep(curr_sp, alloca_copy);
481 obstack_ptr_grow(obst, get_Call_mem(irn));
482 curr_mem = new_NoMem();
484 curr_mem = get_Call_mem(irn);
487 assert(mode_is_reference(mach_mode) && "machine mode must be pointer");
488 for(i = 0; i < n_pos; ++i) {
490 be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
491 ir_node *param = get_Call_param(irn, p);
492 ir_node *addr = curr_sp;
494 ir_type *param_type = get_method_param_type(mt, p);
495 int param_size = get_type_size_bytes(param_type) + arg->space_after;
498 * If we wanted to build the arguments sequentially,
499 * the stack pointer for the next must be incremented,
500 * and the memory value propagated.
504 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, param_size + arg->space_before);
506 add_irn_dep(curr_sp, alloca_copy);
509 add_irn_dep(curr_sp, curr_mem);
512 curr_ofs += arg->space_before;
513 curr_ofs = round_up2(curr_ofs, arg->alignment);
515 /* Make the expression to compute the argument's offset. */
517 addr = new_r_Const_long(irg, bl, mode_Is, curr_ofs);
518 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
522 /* Insert a store for primitive arguments. */
523 if (is_atomic_type(param_type)) {
525 store = new_r_Store(irg, bl, curr_mem, addr, param);
526 mem = new_r_Proj(irg, bl, store, mode_M, pn_Store_M);
529 /* Make a mem copy for compound arguments. */
533 assert(mode_is_reference(get_irn_mode(param)));
534 copy = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
535 mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
538 curr_ofs += param_size;
543 obstack_ptr_grow(obst, mem);
546 in = (ir_node **) obstack_finish(obst);
548 /* We need the sync only, if we didn't build the stores sequentially. */
551 curr_mem = new_r_Sync(irg, bl, n_pos + 1, in);
553 curr_mem = get_Call_mem(irn);
556 obstack_free(obst, in);
559 /* Collect caller save registers */
560 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
562 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
563 for(j = 0; j < cls->n_regs; ++j) {
564 const arch_register_t *reg = arch_register_for_index(cls, j);
565 if(arch_register_type_is(reg, caller_save))
566 pset_insert_ptr(caller_save, (void *) reg);
570 /* search the greatest result proj number */
572 /* TODO: what if the result is NOT used? Currently there is
573 * no way to detect this later, especially there is no way to
574 * see this in the proj numbers.
575 * While this is ok for the register allocator, it is bad for
576 * backends which need to change the be_Call further (x87 simulator
577 * for instance. However for this particular case the call_type is
580 foreach_out_edge(irn, edge) {
581 const ir_edge_t *res_edge;
582 ir_node *irn = get_edge_src_irn(edge);
584 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_T_result) {
586 foreach_out_edge(irn, res_edge) {
588 be_abi_call_arg_t *arg;
589 ir_node *res = get_edge_src_irn(res_edge);
591 assert(is_Proj(res));
593 proj = get_Proj_proj(res);
594 arg = get_call_arg(call, 1, proj);
597 shift the proj number to the right, since we will drop the
598 unspeakable Proj_T from the Call. Therefore, all real argument
599 Proj numbers must be increased by pn_be_Call_first_res
601 proj += pn_be_Call_first_res;
602 set_Proj_proj(res, proj);
603 obstack_ptr_grow(obst, res);
605 if(proj > curr_res_proj)
606 curr_res_proj = proj;
608 pset_remove_ptr(caller_save, arg->reg);
609 //pmap_insert(arg_regs, arg->reg, INT_TO_PTR(proj + 1))
616 obstack_ptr_grow(obst, NULL);
617 res_projs = obstack_finish(obst);
619 /* make the back end call node and set its register requirements. */
620 for(i = 0; i < n_low_args; ++i)
621 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
623 in = obstack_finish(obst);
625 if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
626 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, curr_sp,
627 curr_res_proj + pset_count(caller_save), n_low_args, in,
629 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
633 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, call_ptr,
634 curr_res_proj + pset_count(caller_save), n_low_args, in,
639 Set the register class of the call address to the same as the stack pointer's.
640 That' probably buggy for some architectures.
642 be_node_set_reg_class(low_call, be_pos_Call_ptr, sp->reg_class);
644 DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
646 /* Set the register classes and constraints of the Call parameters. */
647 for(i = 0; i < n_low_args; ++i) {
648 int index = low_args[i];
649 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
650 assert(arg->reg != NULL);
652 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + index, arg->reg);
655 /* Set the register constraints of the results. */
656 for(i = 0; res_projs[i]; ++i) {
657 ir_node *irn = res_projs[i];
658 int proj = get_Proj_proj(irn);
660 /* Correct Proj number since it has been adjusted! (see above) */
661 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
664 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
666 obstack_free(obst, in);
667 exchange(irn, low_call);
669 /* redirect the result projs to the lowered call instead of the Proj_T */
670 for(i = 0; res_projs[i]; ++i)
671 set_Proj_pred(res_projs[i], low_call);
673 /* Make additional projs for the caller save registers
674 and the Keep node which keeps them alive. */
675 if(pset_count(caller_save) > 0) {
676 const arch_register_t *reg;
680 for(reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
681 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
683 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
684 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
685 set_irn_link(proj, (void *) reg);
686 obstack_ptr_grow(obst, proj);
690 in = (ir_node **) obstack_finish(obst);
691 keep = be_new_Keep(NULL, irg, bl, n, in);
692 for(i = 0; i < n; ++i) {
693 const arch_register_t *reg = get_irn_link(in[i]);
694 be_node_set_reg_class(keep, i, reg->reg_class);
696 obstack_free(obst, in);
699 /* Clean up the stack. */
701 ir_node *mem_proj = NULL;
703 foreach_out_edge(low_call, edge) {
704 ir_node *irn = get_edge_src_irn(edge);
705 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
712 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
713 keep_alive(mem_proj);
716 /* Clean up the stack frame if we allocated it */
718 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
719 add_irn_dep(curr_sp, mem_proj);
721 add_irn_dep(curr_sp, alloca_copy);
727 be_abi_call_free(call);
728 obstack_free(obst, pos);
730 del_pset(caller_save);
737 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
739 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
741 if (get_Alloc_where(alloc) == stack_alloc) {
742 ir_node *bl = get_nodes_block(alloc);
743 ir_graph *irg = get_irn_irg(bl);
744 ir_node *alloc_mem = NULL;
745 ir_node *alloc_res = NULL;
747 const ir_edge_t *edge;
752 foreach_out_edge(alloc, edge) {
753 ir_node *irn = get_edge_src_irn(edge);
755 assert(is_Proj(irn));
756 switch(get_Proj_proj(irn)) {
768 /* Beware: currently Alloc nodes without a result might happen,
769 only escape analysis kills them and this phase runs only for object
770 oriented source. We kill the Alloc here. */
771 if (alloc_res == NULL && alloc_mem) {
772 exchange(alloc_mem, get_Alloc_mem(alloc));
776 /* The stack pointer will be modified in an unknown manner.
777 We cannot omit it. */
778 env->call->flags.bits.try_omit_fp = 0;
779 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
781 exchange(alloc, new_alloc);
783 if(alloc_mem != NULL)
784 set_Proj_proj(alloc_mem, pn_be_AddSP_M);
786 /* fix projnum of alloca res */
787 set_Proj_proj(alloc_res, pn_be_AddSP_res);
789 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
791 /* copy the address away, since it could be used after further stack pointer modifications. */
792 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
793 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, bl, curr_sp);
795 /* Let all users of the Alloc() result now point to the copy. */
796 edges_reroute(alloc_res, copy, irg);
798 /* Rewire the copy appropriately. */
799 set_irn_n(copy, be_pos_Copy_op, addr);
807 /* the following function is replaced by the usage of the heights module */
810 * Walker for dependent_on().
811 * This function searches a node tgt recursively from a given node
812 * but is restricted to the given block.
813 * @return 1 if tgt was reachable from curr, 0 if not.
815 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
819 if (get_nodes_block(curr) != bl)
825 /* Phi functions stop the recursion inside a basic block */
826 if (! is_Phi(curr)) {
827 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
828 if (check_dependence(get_irn_n(curr, i), tgt, bl))
838 * Check if a node is somehow data dependent on another one.
839 * both nodes must be in the same basic block.
840 * @param n1 The first node.
841 * @param n2 The second node.
842 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
844 static int dependent_on(ir_node *n1, ir_node *n2)
846 ir_node *bl = get_nodes_block(n1);
848 assert(bl == get_nodes_block(n2));
850 return heights_reachable_in_block(ir_heights, n1, n2);
851 //return check_dependence(n1, n2, bl);
854 static int cmp_call_dependecy(const void *c1, const void *c2)
856 ir_node *n1 = *(ir_node **) c1;
857 ir_node *n2 = *(ir_node **) c2;
860 Classical qsort() comparison function behavior:
861 0 if both elements are equal
862 1 if second is "smaller" that first
863 -1 if first is "smaller" that second
865 if (dependent_on(n1, n2))
868 if (dependent_on(n2, n1))
875 * Walker: links all Call nodes to the Block they are contained.
877 static void link_calls_in_block_walker(ir_node *irn, void *data)
879 if(is_Call(irn) || (get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)) {
880 be_abi_irg_t *env = data;
881 ir_node *bl = get_nodes_block(irn);
882 void *save = get_irn_link(bl);
885 env->call->flags.bits.irg_is_leaf = 0;
887 set_irn_link(irn, save);
888 set_irn_link(bl, irn);
894 * Process all Call nodes inside a basic block.
895 * Note that the link field of the block must contain a linked list of all
896 * Call nodes inside the Block. We first order this list according to data dependency
897 * and that connect the calls together.
899 static void process_calls_in_block(ir_node *bl, void *data)
901 be_abi_irg_t *env = data;
902 ir_node *curr_sp = env->init_sp;
906 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
907 obstack_ptr_grow(&env->obst, irn);
909 /* If there were call nodes in the block. */
913 ir_node *copy = NULL;
916 nodes = obstack_finish(&env->obst);
918 /* order the call nodes according to data dependency */
919 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
921 for(i = n - 1; i >= 0; --i) {
922 ir_node *irn = nodes[i];
924 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
925 switch(get_irn_opcode(irn)) {
927 curr_sp = adjust_call(env, irn, curr_sp, copy);
930 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
937 obstack_free(&env->obst, nodes);
939 /* Keep the last stack state in the block by tying it to Keep node */
941 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
942 pmap_insert(env->keep_map, bl, keep);
945 set_irn_link(bl, curr_sp);
949 * Adjust all call nodes in the graph to the ABI conventions.
951 static void process_calls(be_abi_irg_t *env)
953 ir_graph *irg = env->birg->irg;
955 env->call->flags.bits.irg_is_leaf = 1;
956 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
958 ir_heights = heights_new(env->birg->irg);
959 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
960 heights_free(ir_heights);
963 static void collect_return_walker(ir_node *irn, void *data)
965 if(get_irn_opcode(irn) == iro_Return) {
966 struct obstack *obst = data;
967 obstack_ptr_grow(obst, irn);
972 static ir_node *setup_frame(be_abi_irg_t *env)
974 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
975 const arch_register_t *sp = isa->sp;
976 const arch_register_t *bp = isa->bp;
977 be_abi_call_flags_bits_t flags = env->call->flags.bits;
978 ir_graph *irg = env->birg->irg;
979 ir_node *bl = get_irg_start_block(irg);
980 ir_node *no_mem = get_irg_no_mem(irg);
981 ir_node *old_frame = get_irg_frame(irg);
982 ir_node *stack = pmap_get(env->regs, (void *) sp);
983 ir_node *frame = pmap_get(env->regs, (void *) bp);
985 int stack_nr = get_Proj_proj(stack);
987 if(flags.try_omit_fp) {
988 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
993 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
995 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
997 be_set_constr_single_reg(frame, -1, bp);
998 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
999 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
1002 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
1005 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
1006 env->init_sp = stack;
1007 set_irg_frame(irg, frame);
1008 edges_reroute(old_frame, frame, irg);
1013 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1015 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1016 const arch_register_t *sp = isa->sp;
1017 const arch_register_t *bp = isa->bp;
1018 ir_graph *irg = env->birg->irg;
1019 ir_node *ret_mem = get_Return_mem(ret);
1020 ir_node *frame = get_irg_frame(irg);
1021 ir_node *bl = get_nodes_block(ret);
1022 ir_node *stack = get_irn_link(bl);
1026 if(env->call->flags.bits.try_omit_fp) {
1027 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1031 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1032 be_set_constr_single_reg(stack, -1, sp);
1033 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1036 pmap_foreach(env->regs, ent) {
1037 const arch_register_t *reg = ent->key;
1038 ir_node *irn = ent->value;
1041 obstack_ptr_grow(&env->obst, stack);
1043 obstack_ptr_grow(&env->obst, frame);
1044 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1045 obstack_ptr_grow(obst, irn);
1052 * Computes the stack argument layout type.
1053 * Changes a possibly allocated value param type by moving
1054 * entities to the stack layout type.
1056 * @param env the ABI environment
1057 * @param call the current call ABI
1058 * @param method_type the method type
1060 * @return the stack argument layout type
1062 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type)
1064 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1065 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1066 int n = get_method_n_params(method_type);
1067 int curr = inc > 0 ? 0 : n - 1;
1073 ir_type *val_param_tp = get_method_value_param_type(method_type);
1074 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1076 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1077 for (i = 0; i < n; ++i, curr += inc) {
1078 ir_type *param_type = get_method_param_type(method_type, curr);
1079 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1081 if (arg->on_stack) {
1083 /* the entity was already created, move it to the param type */
1084 arg->stack_ent = get_method_value_param_ent(method_type, i);
1085 remove_struct_member(val_param_tp, arg->stack_ent);
1086 set_entity_owner(arg->stack_ent, res);
1087 add_struct_member(res, arg->stack_ent);
1088 /* must be automatic to set a fixed layout */
1089 set_entity_allocation(arg->stack_ent, allocation_automatic);
1092 snprintf(buf, sizeof(buf), "param_%d", i);
1093 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1095 ofs += arg->space_before;
1096 ofs = round_up2(ofs, arg->alignment);
1097 set_entity_offset_bytes(arg->stack_ent, ofs);
1098 ofs += arg->space_after;
1099 ofs += get_type_size_bytes(param_type);
1102 set_type_size_bytes(res, ofs);
1103 set_type_state(res, layout_fixed);
1107 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1110 struct obstack obst;
1112 obstack_init(&obst);
1114 /* Create a Perm after the RegParams node to delimit it. */
1115 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1116 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1121 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1122 const arch_register_t *reg = &cls->regs[j];
1123 ir_node *irn = pmap_get(regs, (void *) reg);
1125 if(irn && !arch_register_type_is(reg, ignore)) {
1127 obstack_ptr_grow(&obst, irn);
1128 set_irn_link(irn, (void *) reg);
1132 obstack_ptr_grow(&obst, NULL);
1133 in = obstack_finish(&obst);
1135 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1136 for(j = 0; j < n_regs; ++j) {
1137 ir_node *arg = in[j];
1138 arch_register_t *reg = get_irn_link(arg);
1139 pmap_insert(regs, reg, arg);
1140 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1143 obstack_free(&obst, in);
1146 obstack_free(&obst, NULL);
1150 const arch_register_t *reg;
1154 static int cmp_regs(const void *a, const void *b)
1156 const reg_node_map_t *p = a;
1157 const reg_node_map_t *q = b;
1159 if(p->reg->reg_class == q->reg->reg_class)
1160 return p->reg->index - q->reg->index;
1162 return p->reg->reg_class - q->reg->reg_class;
1165 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1168 int n = pmap_count(reg_map);
1170 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1172 pmap_foreach(reg_map, ent) {
1173 res[i].reg = ent->key;
1174 res[i].irn = ent->value;
1178 qsort(res, n, sizeof(res[0]), cmp_regs);
1183 * Creates a barrier.
1185 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1187 ir_graph *irg = env->birg->irg;
1188 int n_regs = pmap_count(regs);
1194 rm = reg_map_to_arr(&env->obst, regs);
1196 for(n = 0; n < n_regs; ++n)
1197 obstack_ptr_grow(&env->obst, rm[n].irn);
1200 obstack_ptr_grow(&env->obst, *mem);
1204 in = (ir_node **) obstack_finish(&env->obst);
1205 irn = be_new_Barrier(irg, bl, n, in);
1206 obstack_free(&env->obst, in);
1208 for(n = 0; n < n_regs; ++n) {
1209 const arch_register_t *reg = rm[n].reg;
1211 int pos = BE_OUT_POS(n);
1214 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1215 be_node_set_reg_class(irn, n, reg->reg_class);
1217 be_set_constr_single_reg(irn, n, reg);
1218 be_set_constr_single_reg(irn, pos, reg);
1219 be_node_set_reg_class(irn, pos, reg->reg_class);
1220 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1222 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1223 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1224 flags |= arch_irn_flags_ignore;
1226 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1227 flags |= arch_irn_flags_modify_sp;
1229 be_node_set_flags(irn, pos, flags);
1231 pmap_insert(regs, (void *) reg, proj);
1235 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1238 obstack_free(&env->obst, rm);
1243 * Creates a be_Return for a Return node.
1245 * @param @env the abi environment
1246 * @param irn the Return node or NULL if there was none
1247 * @param bl the block where the be_Retun should be placed
1248 * @param mem the current memory
1249 * @param n_res number of return results
1251 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1252 be_abi_call_t *call = env->call;
1253 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1255 pmap *reg_map = pmap_create();
1256 ir_node *keep = pmap_get(env->keep_map, bl);
1262 const arch_register_t **regs;
1266 get the valid stack node in this block.
1267 If we had a call in that block there is a Keep constructed by process_calls()
1268 which points to the last stack modification in that block. we'll use
1269 it then. Else we use the stack from the start block and let
1270 the ssa construction fix the usage.
1272 stack = be_abi_reg_map_get(env->regs, isa->sp);
1274 ir_node *bad = new_r_Bad(env->birg->irg);
1275 stack = get_irn_n(keep, 0);
1276 set_nodes_block(keep, bad);
1277 set_irn_n(keep, 0, bad);
1278 // exchange(keep, new_r_Bad(env->birg->irg));
1281 /* Insert results for Return into the register map. */
1282 for(i = 0; i < n_res; ++i) {
1283 ir_node *res = get_Return_res(irn, i);
1284 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1285 assert(arg->in_reg && "return value must be passed in register");
1286 pmap_insert(reg_map, (void *) arg->reg, res);
1289 /* Add uses of the callee save registers. */
1290 pmap_foreach(env->regs, ent) {
1291 const arch_register_t *reg = ent->key;
1292 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1293 pmap_insert(reg_map, ent->key, ent->value);
1296 be_abi_reg_map_set(reg_map, isa->sp, stack);
1298 /* Make the Epilogue node and call the arch's epilogue maker. */
1299 create_barrier(env, bl, &mem, reg_map, 1);
1300 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1303 Maximum size of the in array for Return nodes is
1304 return args + callee save/ignore registers + memory + stack pointer
1306 in_max = pmap_count(reg_map) + n_res + 2;
1308 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1309 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1312 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1317 /* clear SP entry, since it has already been grown. */
1318 pmap_insert(reg_map, (void *) isa->sp, NULL);
1319 for(i = 0; i < n_res; ++i) {
1320 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1322 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1323 regs[n++] = arg->reg;
1325 /* Clear the map entry to mark the register as processed. */
1326 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1329 /* grow the rest of the stuff. */
1330 pmap_foreach(reg_map, ent) {
1333 regs[n++] = ent->key;
1337 /* The in array for the new back end return is now ready. */
1338 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1340 /* Set the register classes of the return's parameter accordingly. */
1341 for(i = 0; i < n; ++i)
1343 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1345 /* Free the space of the Epilog's in array and the register <-> proj map. */
1346 obstack_free(&env->obst, in);
1347 pmap_destroy(reg_map);
1352 typedef struct lower_frame_sels_env_t {
1354 entity *value_param_list; /**< the list of all value param antities */
1355 } lower_frame_sels_env_t;
1358 * Walker: Replaces Sels of frame type and
1359 * value param type entities by FrameAddress.
1361 static void lower_frame_sels_walker(ir_node *irn, void *data)
1363 lower_frame_sels_env_t *ctx = data;
1366 ir_graph *irg = current_ir_graph;
1367 ir_node *frame = get_irg_frame(irg);
1368 ir_node *param_base = get_irg_value_param_base(irg);
1369 ir_node *ptr = get_Sel_ptr(irn);
1371 if (ptr == frame || ptr == param_base) {
1372 be_abi_irg_t *env = ctx->env;
1373 entity *ent = get_Sel_entity(irn);
1374 ir_node *bl = get_nodes_block(irn);
1377 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1380 if (ptr == param_base) {
1381 set_entity_link(ent, ctx->value_param_list);
1382 ctx->value_param_list = ent;
1389 * Check if a value parameter is transmitted as a register.
1390 * This might happen if the address of an parameter is taken which is
1391 * transmitted in registers.
1393 * Note that on some architectures this case must be handled specially
1394 * because the place of the backing store is determined by their ABI.
1396 * In the default case we move the entity to the frame type and create
1397 * a backing store into the first block.
1399 static void fix_address_of_parameter_access(be_abi_irg_t *env, entity *value_param_list) {
1400 be_abi_call_t *call = env->call;
1401 ir_graph *irg = env->birg->irg;
1402 entity *ent, *next_ent, *new_list;
1404 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1407 for (ent = value_param_list; ent; ent = next_ent) {
1408 int i = get_struct_member_index(get_entity_owner(ent), ent);
1409 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1411 next_ent = get_entity_link(ent);
1413 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1414 set_entity_link(ent, new_list);
1419 /* ok, change the graph */
1420 ir_node *start_bl = get_irg_start_block(irg);
1421 ir_node *first_bl = NULL;
1422 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1423 const ir_edge_t *edge;
1424 optimization_state_t state;
1427 foreach_block_succ(start_bl, edge) {
1428 ir_node *succ = get_edge_src_irn(edge);
1429 if (start_bl != succ) {
1435 /* we had already removed critical edges, so the following
1436 assertion should be always true. */
1437 assert(get_Block_n_cfgpreds(first_bl) == 1);
1439 /* now create backing stores */
1440 frame = get_irg_frame(irg);
1441 imem = get_irg_initial_mem(irg);
1443 save_optimization_state(&state);
1445 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1446 restore_optimization_state(&state);
1448 /* reroute all edges to the new memory source */
1449 edges_reroute(imem, nmem, irg);
1453 args = get_irg_args(irg);
1454 args_bl = get_nodes_block(args);
1455 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1456 int i = get_struct_member_index(get_entity_owner(ent), ent);
1457 ir_type *tp = get_entity_type(ent);
1458 ir_mode *mode = get_type_mode(tp);
1461 /* address for the backing store */
1462 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1465 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1467 /* the backing store itself */
1468 store = new_r_Store(irg, first_bl, mem, addr,
1469 new_r_Proj(irg, args_bl, args, mode, i));
1471 /* the new memory Proj gets the last Proj from store */
1472 set_Proj_pred(nmem, store);
1473 set_Proj_proj(nmem, pn_Store_M);
1475 /* move all entities to the frame type */
1476 frame_tp = get_irg_frame_type(irg);
1477 offset = get_type_size_bytes(frame_tp);
1478 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1479 ir_type *tp = get_entity_type(ent);
1480 int align = get_type_alignment_bytes(tp);
1482 offset += align - 1;
1484 set_entity_owner(ent, frame_tp);
1485 add_class_member(frame_tp, ent);
1486 /* must be automatic to set a fixed layout */
1487 set_entity_allocation(ent, allocation_automatic);
1488 set_entity_offset_bytes(ent, offset);
1489 offset += get_type_size_bytes(tp);
1491 set_type_size_bytes(frame_tp, offset);
1496 * Modify the irg itself and the frame type.
1498 static void modify_irg(be_abi_irg_t *env)
1500 be_abi_call_t *call = env->call;
1501 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1502 const arch_register_t *sp = arch_isa_sp(isa);
1503 ir_graph *irg = env->birg->irg;
1504 ir_node *bl = get_irg_start_block(irg);
1505 ir_node *end = get_irg_end_block(irg);
1506 ir_node *mem = get_irg_initial_mem(irg);
1507 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1508 pset *dont_save = pset_new_ptr(8);
1514 const arch_register_t *fp_reg;
1515 ir_node *frame_pointer;
1517 ir_node *reg_params_bl;
1520 const ir_edge_t *edge;
1521 ir_type *arg_type, *bet_type;
1522 lower_frame_sels_env_t ctx;
1524 bitset_t *used_proj_nr;
1525 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1527 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1529 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1531 ctx.value_param_list = NULL;
1532 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1534 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1535 env->regs = pmap_create();
1537 used_proj_nr = bitset_alloca(1024);
1538 n_params = get_method_n_params(method_type);
1539 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1540 memset(args, 0, n_params * sizeof(args[0]));
1542 /* Check if a value parameter is transmitted as a register.
1543 * This might happen if the address of an parameter is taken which is
1544 * transmitted in registers.
1546 * Note that on some architectures this case must be handled specially
1547 * because the place of the backing store is determined by their ABI.
1549 * In the default case we move the entity to the frame type and create
1550 * a backing store into the first block.
1552 fix_address_of_parameter_access(env, ctx.value_param_list);
1554 /* Fill the argument vector */
1555 arg_tuple = get_irg_args(irg);
1556 foreach_out_edge(arg_tuple, edge) {
1557 ir_node *irn = get_edge_src_irn(edge);
1558 int nr = get_Proj_proj(irn);
1560 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1563 arg_type = compute_arg_type(env, call, method_type);
1564 bet_type = call->cb->get_between_type(env->cb);
1565 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir);
1567 /* Count the register params and add them to the number of Projs for the RegParams node */
1568 for(i = 0; i < n_params; ++i) {
1569 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1570 if(arg->in_reg && args[i]) {
1571 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1572 assert(i == get_Proj_proj(args[i]));
1574 /* For now, associate the register with the old Proj from Start representing that argument. */
1575 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1576 bitset_set(used_proj_nr, i);
1577 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1581 /* Collect all callee-save registers */
1582 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1583 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1584 for(j = 0; j < cls->n_regs; ++j) {
1585 const arch_register_t *reg = &cls->regs[j];
1586 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1587 pmap_insert(env->regs, (void *) reg, NULL);
1591 pmap_insert(env->regs, (void *) sp, NULL);
1592 pmap_insert(env->regs, (void *) isa->bp, NULL);
1593 reg_params_bl = get_irg_start_block(irg);
1594 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1597 * make proj nodes for the callee save registers.
1598 * memorize them, since Return nodes get those as inputs.
1600 * Note, that if a register corresponds to an argument, the regs map contains
1601 * the old Proj from start for that argument.
1604 rm = reg_map_to_arr(&env->obst, env->regs);
1605 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1606 arch_register_t *reg = (void *) rm[i].reg;
1607 ir_node *arg_proj = rm[i].irn;
1608 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1610 int pos = BE_OUT_POS((int) nr);
1616 bitset_set(used_proj_nr, nr);
1617 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1618 pmap_insert(env->regs, (void *) reg, proj);
1619 be_set_constr_single_reg(env->reg_params, pos, reg);
1620 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1623 * If the register is an ignore register,
1624 * The Proj for that register shall also be ignored during register allocation.
1626 if(arch_register_type_is(reg, ignore))
1627 flags |= arch_irn_flags_ignore;
1630 flags |= arch_irn_flags_modify_sp;
1632 be_node_set_flags(env->reg_params, pos, flags);
1634 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1636 obstack_free(&env->obst, rm);
1638 /* Generate the Prologue */
1639 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1641 /* do the stack allocation BEFORE the barrier, or spill code
1642 might be added before it */
1643 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1644 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1645 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1647 barrier = create_barrier(env, bl, &mem, env->regs, 0);
1649 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1650 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1652 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1653 set_irg_frame(irg, frame_pointer);
1654 pset_insert_ptr(env->ignore_regs, fp_reg);
1656 /* Now, introduce stack param nodes for all parameters passed on the stack */
1657 for(i = 0; i < n_params; ++i) {
1658 ir_node *arg_proj = args[i];
1659 ir_node *repl = NULL;
1661 if(arg_proj != NULL) {
1662 be_abi_call_arg_t *arg;
1663 ir_type *param_type;
1664 int nr = get_Proj_proj(arg_proj);
1666 nr = MIN(nr, n_params);
1667 arg = get_call_arg(call, 0, nr);
1668 param_type = get_method_param_type(method_type, nr);
1671 repl = pmap_get(env->regs, (void *) arg->reg);
1674 else if(arg->on_stack) {
1675 /* For atomic parameters which are actually used, we create a StackParam node. */
1676 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1677 ir_mode *mode = get_type_mode(param_type);
1678 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1679 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1682 /* The stack parameter is not primitive (it is a struct or array),
1683 we thus will create a node representing the parameter's address
1686 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1690 assert(repl != NULL);
1691 edges_reroute(args[i], repl, irg);
1695 /* All Return nodes hang on the End node, so look for them there. */
1696 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1697 ir_node *irn = get_Block_cfgpred(end, i);
1699 if (is_Return(irn)) {
1700 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1704 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1705 the code is dead and will never be executed. */
1707 del_pset(dont_save);
1708 obstack_free(&env->obst, args);
1712 * Walker: puts all Alloc(stack_alloc) on a obstack
1714 static void collect_alloca_walker(ir_node *irn, void *data)
1716 be_abi_irg_t *env = data;
1717 if(get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)
1718 obstack_ptr_grow(&env->obst, irn);
1721 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1723 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1724 ir_node *old_frame = get_irg_frame(birg->irg);
1725 ir_graph *irg = birg->irg;
1729 optimization_state_t state;
1731 obstack_init(&env->obst);
1733 env->isa = birg->main_env->arch_env->isa;
1734 env->method_type = get_entity_type(get_irg_entity(irg));
1735 env->call = be_abi_call_new();
1736 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1738 env->ignore_regs = pset_new_ptr_default();
1739 env->keep_map = pmap_create();
1740 env->dce_survivor = new_survive_dce();
1742 env->stack_phis = pset_new_ptr(16);
1743 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1744 to another Unknown or the stack pointer gets used */
1745 save_optimization_state(&state);
1747 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1748 restore_optimization_state(&state);
1749 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1751 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1752 env->irn_ops.impl = &abi_irn_ops;
1754 /* Lower all call nodes in the IRG. */
1758 Beware: init backend abi call object after processing calls,
1759 otherwise some information might be not yet available.
1761 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1763 /* Process the IRG */
1766 /* We don't need the keep map anymore. */
1767 pmap_destroy(env->keep_map);
1769 /* reroute the stack origin of the calls to the true stack origin. */
1770 edges_reroute(dummy, env->init_sp, irg);
1771 edges_reroute(old_frame, get_irg_frame(irg), irg);
1773 /* Make some important node pointers survive the dead node elimination. */
1774 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1775 pmap_foreach(env->regs, ent)
1776 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1778 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1780 env->call->cb->done(env->cb);
1784 void be_abi_free(be_abi_irg_t *env)
1786 free_survive_dce(env->dce_survivor);
1787 del_pset(env->stack_phis);
1788 del_pset(env->ignore_regs);
1789 pmap_destroy(env->regs);
1790 obstack_free(&env->obst, NULL);
1791 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1795 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1797 arch_register_t *reg;
1799 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1800 if(reg->reg_class == cls)
1801 bitset_set(bs, reg->index);
1808 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1809 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1810 | _| | |> < ___) | || (_| | (__| <
1811 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1815 struct fix_stack_walker_info {
1817 const arch_env_t *aenv;
1821 * Walker. Collect all stack modifying nodes.
1823 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1825 struct fix_stack_walker_info *info = data;
1830 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1831 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1832 pset_insert_ptr(info->nodes, irn);
1836 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1838 dom_front_info_t *df;
1839 pset *stack_nodes = pset_new_ptr(16);
1840 struct fix_stack_walker_info info;
1842 info.nodes = stack_nodes;
1843 info.aenv = env->birg->main_env->arch_env;
1845 /* We need dominance frontiers for fix up */
1846 df = be_compute_dominance_frontiers(env->birg->irg);
1847 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1848 pset_insert_ptr(stack_nodes, env->init_sp);
1849 be_ssa_constr_set_phis(df, lv, stack_nodes, env->stack_phis);
1850 del_pset(stack_nodes);
1852 /* free these dominance frontiers */
1853 be_free_dominance_frontiers(df);
1856 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1858 const arch_env_t *arch_env = env->birg->main_env->arch_env;
1859 int omit_fp = env->call->flags.bits.try_omit_fp;
1862 sched_foreach(bl, irn) {
1865 Check, if the node relates to an entity on the stack frame.
1866 If so, set the true offset (including the bias) for that
1869 entity *ent = arch_get_frame_entity(arch_env, irn);
1871 int offset = get_stack_entity_offset(env->frame, ent, bias);
1872 arch_set_frame_offset(arch_env, irn, offset);
1873 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
1877 If the node modifies the stack pointer by a constant offset,
1878 record that in the bias.
1880 if(arch_irn_is(arch_env, irn, modify_sp)) {
1881 int ofs = arch_get_sp_bias(arch_env, irn);
1883 if(be_is_IncSP(irn)) {
1884 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
1885 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1886 be_set_IncSP_offset(irn, ofs);
1887 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
1888 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1889 be_set_IncSP_offset(irn, ofs);
1902 * A helper struct for the bias walker.
1905 be_abi_irg_t *env; /**< The ABI irg environment. */
1906 int start_block_bias; /**< The bias at the end of the start block. */
1907 ir_node *start_block; /**< The start block of the current graph. */
1911 * Block-Walker: fix all stack offsets
1913 static void stack_bias_walker(ir_node *bl, void *data)
1915 struct bias_walk *bw = data;
1916 if (bl != bw->start_block) {
1917 process_stack_bias(bw->env, bl, bw->start_block_bias);
1921 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1923 ir_graph *irg = env->birg->irg;
1924 struct bias_walk bw;
1926 stack_frame_compute_initial_offset(env->frame);
1927 // stack_layout_dump(stdout, env->frame);
1929 /* Determine the stack bias at the end of the start block. */
1930 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1932 /* fix the bias is all other blocks */
1934 bw.start_block = get_irg_start_block(irg);
1935 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1938 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1940 assert(arch_register_type_is(reg, callee_save));
1941 assert(pmap_contains(abi->regs, (void *) reg));
1942 return pmap_get(abi->regs, (void *) reg);
1946 _____ _____ _ _ _ _ _ _
1947 |_ _| __ \| \ | | | | | | | | |
1948 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
1949 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
1950 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
1951 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
1953 for Phi nodes which are created due to stack modifying nodes
1954 such as IncSP, AddSP and SetSP.
1956 These Phis are always to be ignored by the reg alloc and are
1957 fixed on the SP register of the ISA.
1960 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
1962 const be_abi_irg_t *abi = get_abi_from_handler(handler);
1963 const void *res = NULL;
1965 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
1966 res = &abi->irn_ops;
1971 static void be_abi_limited(void *data, bitset_t *bs)
1973 be_abi_irg_t *abi = data;
1974 bitset_clear_all(bs);
1975 bitset_set(bs, abi->isa->sp->index);
1978 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)
1980 be_abi_irg_t *abi = get_abi_from_ops(self);
1981 const arch_register_t *reg = abi->isa->sp;
1983 memset(req, 0, sizeof(req[0]));
1985 if(pos == BE_OUT_POS(0)) {
1986 req->cls = reg->reg_class;
1987 req->type = arch_register_req_type_limited;
1988 req->limited = be_abi_limited;
1989 req->limited_env = abi;
1992 else if(pos >= 0 && pos < get_irn_arity(irn)) {
1993 req->cls = reg->reg_class;
1994 req->type = arch_register_req_type_normal;
2000 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
2004 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
2006 const be_abi_irg_t *abi = get_abi_from_ops(self);
2007 return abi->isa->sp;
2010 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
2012 return arch_irn_class_normal;
2015 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2017 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2020 static entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2025 static void abi_set_frame_entity(const void *_self, ir_node *irn, entity *ent)
2029 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2033 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2038 static const arch_irn_ops_if_t abi_irn_ops = {
2039 abi_get_irn_reg_req,
2044 abi_get_frame_entity,
2045 abi_set_frame_entity,
2046 abi_set_frame_offset,
2048 NULL, /* get_inverse */
2049 NULL, /* get_op_estimated_cost */
2050 NULL, /* possible_memory_operand */
2051 NULL, /* perform_memory_operand */
2054 static const arch_irn_handler_t abi_irn_handler = {