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 ir_node *no_mem = get_irg_no_mem(irg);
404 int no_alloc = call->flags.bits.frame_is_setup_on_call;
406 ir_node *res_proj = NULL;
407 int curr_res_proj = pn_Call_max;
414 const ir_edge_t *edge;
419 /* Let the isa fill out the abi description for that call node. */
420 arch_isa_get_call_abi(isa, mt, call);
422 /* Insert code to put the stack arguments on the stack. */
423 assert(get_Call_n_params(irn) == n_params);
424 for(i = 0; i < n_params; ++i) {
425 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
428 stack_size += arg->space_before;
429 stack_size = round_up2(stack_size, arg->alignment);
430 stack_size += get_type_size_bytes(get_method_param_type(mt, i));
431 stack_size += arg->space_after;
432 obstack_int_grow(obst, i);
436 pos = obstack_finish(obst);
438 /* Collect all arguments which are passed in registers. */
439 for(i = 0, n = get_Call_n_params(irn); i < n; ++i) {
440 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
441 if(arg && arg->in_reg) {
442 obstack_int_grow(obst, i);
446 low_args = obstack_finish(obst);
448 /* If there are some parameters which shall be passed on the stack. */
451 int do_seq = call->flags.bits.store_args_sequential && !no_alloc;
454 * Reverse list of stack parameters if call arguments are from left to right.
455 * We must them reverse again in they are pushed (not stored) and the stack
456 * direction is downwards.
458 if (call->flags.bits.left_to_right ^ (do_seq && stack_dir < 0)) {
459 for(i = 0; i < n_pos >> 1; ++i) {
460 int other = n_pos - i - 1;
468 * If the stack is decreasing and we do not want to store sequentially,
469 * or someone else allocated the call frame
470 * we allocate as much space on the stack all parameters need, by
471 * moving the stack pointer along the stack's direction.
473 if(stack_dir < 0 && !do_seq && !no_alloc) {
474 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, stack_size);
476 add_irn_dep(curr_sp, alloca_copy);
482 obstack_ptr_grow(obst, get_Call_mem(irn));
483 curr_mem = new_NoMem();
485 curr_mem = get_Call_mem(irn);
488 assert(mode_is_reference(mach_mode) && "machine mode must be pointer");
489 for(i = 0; i < n_pos; ++i) {
491 be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
492 ir_node *param = get_Call_param(irn, p);
493 ir_node *addr = curr_sp;
495 ir_type *param_type = get_method_param_type(mt, p);
496 int param_size = get_type_size_bytes(param_type) + arg->space_after;
499 * If we wanted to build the arguments sequentially,
500 * the stack pointer for the next must be incremented,
501 * and the memory value propagated.
505 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, param_size + arg->space_before);
507 add_irn_dep(curr_sp, alloca_copy);
510 add_irn_dep(curr_sp, curr_mem);
513 curr_ofs += arg->space_before;
514 curr_ofs = round_up2(curr_ofs, arg->alignment);
516 /* Make the expression to compute the argument's offset. */
518 addr = new_r_Const_long(irg, bl, mode_Is, curr_ofs);
519 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
523 /* Insert a store for primitive arguments. */
524 if (is_atomic_type(param_type)) {
526 store = new_r_Store(irg, bl, curr_mem, addr, param);
527 mem = new_r_Proj(irg, bl, store, mode_M, pn_Store_M);
530 /* Make a mem copy for compound arguments. */
534 assert(mode_is_reference(get_irn_mode(param)));
535 copy = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
536 mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
539 curr_ofs += param_size;
544 obstack_ptr_grow(obst, mem);
547 in = (ir_node **) obstack_finish(obst);
549 /* We need the sync only, if we didn't build the stores sequentially. */
552 curr_mem = new_r_Sync(irg, bl, n_pos + 1, in);
554 curr_mem = get_Call_mem(irn);
557 obstack_free(obst, in);
560 /* Collect caller save registers */
561 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
563 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
564 for(j = 0; j < cls->n_regs; ++j) {
565 const arch_register_t *reg = arch_register_for_index(cls, j);
566 if(arch_register_type_is(reg, caller_save))
567 pset_insert_ptr(caller_save, (void *) reg);
571 /* search the greatest result proj number */
573 /* TODO: what if the result is NOT used? Currently there is
574 * no way to detect this later, especially there is no way to
575 * see this in the proj numbers.
576 * While this is ok for the register allocator, it is bad for
577 * backends which need to change the be_Call further (x87 simulator
578 * for instance. However for this particular case the call_type is
581 foreach_out_edge(irn, edge) {
582 const ir_edge_t *res_edge;
583 ir_node *irn = get_edge_src_irn(edge);
585 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_T_result) {
587 foreach_out_edge(irn, res_edge) {
589 be_abi_call_arg_t *arg;
590 ir_node *res = get_edge_src_irn(res_edge);
592 assert(is_Proj(res));
594 proj = get_Proj_proj(res);
595 arg = get_call_arg(call, 1, proj);
598 shift the proj number to the right, since we will drop the
599 unspeakable Proj_T from the Call. Therefore, all real argument
600 Proj numbers must be increased by pn_be_Call_first_res
602 proj += pn_be_Call_first_res;
603 set_Proj_proj(res, proj);
604 obstack_ptr_grow(obst, res);
606 if(proj > curr_res_proj)
607 curr_res_proj = proj;
609 pset_remove_ptr(caller_save, arg->reg);
610 //pmap_insert(arg_regs, arg->reg, INT_TO_PTR(proj + 1))
617 obstack_ptr_grow(obst, NULL);
618 res_projs = obstack_finish(obst);
620 /* make the back end call node and set its register requirements. */
621 for(i = 0; i < n_low_args; ++i)
622 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
624 in = obstack_finish(obst);
626 if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
627 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, curr_sp,
628 curr_res_proj + pset_count(caller_save), n_low_args, in,
630 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
634 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, call_ptr,
635 curr_res_proj + pset_count(caller_save), n_low_args, in,
640 Set the register class of the call address to the same as the stack pointer's.
641 That' probably buggy for some architectures.
643 be_node_set_reg_class(low_call, be_pos_Call_ptr, sp->reg_class);
645 DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
647 /* Set the register classes and constraints of the Call parameters. */
648 for(i = 0; i < n_low_args; ++i) {
649 int index = low_args[i];
650 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
651 assert(arg->reg != NULL);
653 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + index, arg->reg);
656 /* Set the register constraints of the results. */
657 for(i = 0; res_projs[i]; ++i) {
658 ir_node *irn = res_projs[i];
659 int proj = get_Proj_proj(irn);
661 /* Correct Proj number since it has been adjusted! (see above) */
662 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
665 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
667 obstack_free(obst, in);
668 exchange(irn, low_call);
670 /* redirect the result projs to the lowered call instead of the Proj_T */
671 for(i = 0; res_projs[i]; ++i)
672 set_Proj_pred(res_projs[i], low_call);
674 /* Make additional projs for the caller save registers
675 and the Keep node which keeps them alive. */
676 if(pset_count(caller_save) > 0) {
677 const arch_register_t *reg;
681 for(reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
682 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
684 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
685 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
686 set_irn_link(proj, (void *) reg);
687 obstack_ptr_grow(obst, proj);
691 in = (ir_node **) obstack_finish(obst);
692 keep = be_new_Keep(NULL, irg, bl, n, in);
693 for(i = 0; i < n; ++i) {
694 const arch_register_t *reg = get_irn_link(in[i]);
695 be_node_set_reg_class(keep, i, reg->reg_class);
697 obstack_free(obst, in);
700 /* Clean up the stack. */
702 ir_node *mem_proj = NULL;
704 foreach_out_edge(low_call, edge) {
705 ir_node *irn = get_edge_src_irn(edge);
706 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
713 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
714 keep_alive(mem_proj);
717 /* Clean up the stack frame if we allocated it */
719 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
720 add_irn_dep(curr_sp, mem_proj);
722 add_irn_dep(curr_sp, alloca_copy);
728 be_abi_call_free(call);
729 obstack_free(obst, pos);
731 del_pset(caller_save);
738 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
740 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
742 if (get_Alloc_where(alloc) == stack_alloc) {
743 ir_node *bl = get_nodes_block(alloc);
744 ir_graph *irg = get_irn_irg(bl);
745 ir_node *alloc_mem = NULL;
746 ir_node *alloc_res = NULL;
748 const ir_edge_t *edge;
753 foreach_out_edge(alloc, edge) {
754 ir_node *irn = get_edge_src_irn(edge);
756 assert(is_Proj(irn));
757 switch(get_Proj_proj(irn)) {
769 /* Beware: currently Alloc nodes without a result might happen,
770 only escape analysis kills them and this phase runs only for object
771 oriented source. We kill the Alloc here. */
772 if (alloc_res == NULL && alloc_mem) {
773 exchange(alloc_mem, get_Alloc_mem(alloc));
777 /* The stack pointer will be modified in an unknown manner.
778 We cannot omit it. */
779 env->call->flags.bits.try_omit_fp = 0;
780 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
782 exchange(alloc, new_alloc);
784 if(alloc_mem != NULL)
785 set_Proj_proj(alloc_mem, pn_be_AddSP_M);
787 /* fix projnum of alloca res */
788 set_Proj_proj(alloc_res, pn_be_AddSP_res);
790 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
792 /* copy the address away, since it could be used after further stack pointer modifications. */
793 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
794 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, bl, curr_sp);
796 /* Let all users of the Alloc() result now point to the copy. */
797 edges_reroute(alloc_res, copy, irg);
799 /* Rewire the copy appropriately. */
800 set_irn_n(copy, be_pos_Copy_op, addr);
808 /* the following function is replaced by the usage of the heights module */
811 * Walker for dependent_on().
812 * This function searches a node tgt recursively from a given node
813 * but is restricted to the given block.
814 * @return 1 if tgt was reachable from curr, 0 if not.
816 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
820 if (get_nodes_block(curr) != bl)
826 /* Phi functions stop the recursion inside a basic block */
827 if (! is_Phi(curr)) {
828 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
829 if (check_dependence(get_irn_n(curr, i), tgt, bl))
839 * Check if a node is somehow data dependent on another one.
840 * both nodes must be in the same basic block.
841 * @param n1 The first node.
842 * @param n2 The second node.
843 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
845 static int dependent_on(ir_node *n1, ir_node *n2)
847 ir_node *bl = get_nodes_block(n1);
849 assert(bl == get_nodes_block(n2));
851 return heights_reachable_in_block(ir_heights, n1, n2);
852 //return check_dependence(n1, n2, bl);
855 static int cmp_call_dependecy(const void *c1, const void *c2)
857 ir_node *n1 = *(ir_node **) c1;
858 ir_node *n2 = *(ir_node **) c2;
861 Classical qsort() comparison function behavior:
862 0 if both elements are equal
863 1 if second is "smaller" that first
864 -1 if first is "smaller" that second
866 if (dependent_on(n1, n2))
869 if (dependent_on(n2, n1))
876 * Walker: links all Call nodes to the Block they are contained.
878 static void link_calls_in_block_walker(ir_node *irn, void *data)
880 if(is_Call(irn) || (get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)) {
881 be_abi_irg_t *env = data;
882 ir_node *bl = get_nodes_block(irn);
883 void *save = get_irn_link(bl);
886 env->call->flags.bits.irg_is_leaf = 0;
888 set_irn_link(irn, save);
889 set_irn_link(bl, irn);
895 * Process all Call nodes inside a basic block.
896 * Note that the link field of the block must contain a linked list of all
897 * Call nodes inside the Block. We first order this list according to data dependency
898 * and that connect the calls together.
900 static void process_calls_in_block(ir_node *bl, void *data)
902 be_abi_irg_t *env = data;
903 ir_node *curr_sp = env->init_sp;
907 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
908 obstack_ptr_grow(&env->obst, irn);
910 /* If there were call nodes in the block. */
914 ir_node *copy = NULL;
917 nodes = obstack_finish(&env->obst);
919 /* order the call nodes according to data dependency */
920 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
922 for(i = n - 1; i >= 0; --i) {
923 ir_node *irn = nodes[i];
925 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
926 switch(get_irn_opcode(irn)) {
928 curr_sp = adjust_call(env, irn, curr_sp, copy);
931 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
938 obstack_free(&env->obst, nodes);
940 /* Keep the last stack state in the block by tying it to Keep node */
942 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
943 pmap_insert(env->keep_map, bl, keep);
946 set_irn_link(bl, curr_sp);
950 * Adjust all call nodes in the graph to the ABI conventions.
952 static void process_calls(be_abi_irg_t *env)
954 ir_graph *irg = env->birg->irg;
956 env->call->flags.bits.irg_is_leaf = 1;
957 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
959 ir_heights = heights_new(env->birg->irg);
960 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
961 heights_free(ir_heights);
964 static void collect_return_walker(ir_node *irn, void *data)
966 if(get_irn_opcode(irn) == iro_Return) {
967 struct obstack *obst = data;
968 obstack_ptr_grow(obst, irn);
973 static ir_node *setup_frame(be_abi_irg_t *env)
975 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
976 const arch_register_t *sp = isa->sp;
977 const arch_register_t *bp = isa->bp;
978 be_abi_call_flags_bits_t flags = env->call->flags.bits;
979 ir_graph *irg = env->birg->irg;
980 ir_node *bl = get_irg_start_block(irg);
981 ir_node *no_mem = get_irg_no_mem(irg);
982 ir_node *old_frame = get_irg_frame(irg);
983 ir_node *stack = pmap_get(env->regs, (void *) sp);
984 ir_node *frame = pmap_get(env->regs, (void *) bp);
986 int stack_nr = get_Proj_proj(stack);
988 if(flags.try_omit_fp) {
989 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
994 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
996 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
998 be_set_constr_single_reg(frame, -1, bp);
999 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
1000 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
1003 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
1006 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
1007 env->init_sp = stack;
1008 set_irg_frame(irg, frame);
1009 edges_reroute(old_frame, frame, irg);
1014 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1016 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1017 const arch_register_t *sp = isa->sp;
1018 const arch_register_t *bp = isa->bp;
1019 ir_graph *irg = env->birg->irg;
1020 ir_node *ret_mem = get_Return_mem(ret);
1021 ir_node *frame = get_irg_frame(irg);
1022 ir_node *bl = get_nodes_block(ret);
1023 ir_node *stack = get_irn_link(bl);
1027 if(env->call->flags.bits.try_omit_fp) {
1028 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1032 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1033 be_set_constr_single_reg(stack, -1, sp);
1034 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1037 pmap_foreach(env->regs, ent) {
1038 const arch_register_t *reg = ent->key;
1039 ir_node *irn = ent->value;
1042 obstack_ptr_grow(&env->obst, stack);
1044 obstack_ptr_grow(&env->obst, frame);
1045 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1046 obstack_ptr_grow(obst, irn);
1053 * Computes the stack argument layout type.
1054 * Changes a possibly allocated value param type by moving
1055 * entities to the stack layout type.
1057 * @param env the ABI environment
1058 * @param call the current call ABI
1059 * @param method_type the method type
1061 * @return the stack argument layout type
1063 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type)
1065 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1066 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1067 int n = get_method_n_params(method_type);
1068 int curr = inc > 0 ? 0 : n - 1;
1074 ir_type *val_param_tp = get_method_value_param_type(method_type);
1075 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1077 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1078 for (i = 0; i < n; ++i, curr += inc) {
1079 ir_type *param_type = get_method_param_type(method_type, curr);
1080 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1082 if (arg->on_stack) {
1084 /* the entity was already created, move it to the param type */
1085 arg->stack_ent = get_method_value_param_ent(method_type, i);
1086 remove_struct_member(val_param_tp, arg->stack_ent);
1087 set_entity_owner(arg->stack_ent, res);
1088 add_struct_member(res, arg->stack_ent);
1089 /* must be automatic to set a fixed layout */
1090 set_entity_allocation(arg->stack_ent, allocation_automatic);
1093 snprintf(buf, sizeof(buf), "param_%d", i);
1094 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1096 ofs += arg->space_before;
1097 ofs = round_up2(ofs, arg->alignment);
1098 set_entity_offset_bytes(arg->stack_ent, ofs);
1099 ofs += arg->space_after;
1100 ofs += get_type_size_bytes(param_type);
1103 set_type_size_bytes(res, ofs);
1104 set_type_state(res, layout_fixed);
1108 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1111 struct obstack obst;
1113 obstack_init(&obst);
1115 /* Create a Perm after the RegParams node to delimit it. */
1116 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1117 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1122 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1123 const arch_register_t *reg = &cls->regs[j];
1124 ir_node *irn = pmap_get(regs, (void *) reg);
1126 if(irn && !arch_register_type_is(reg, ignore)) {
1128 obstack_ptr_grow(&obst, irn);
1129 set_irn_link(irn, (void *) reg);
1133 obstack_ptr_grow(&obst, NULL);
1134 in = obstack_finish(&obst);
1136 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1137 for(j = 0; j < n_regs; ++j) {
1138 ir_node *arg = in[j];
1139 arch_register_t *reg = get_irn_link(arg);
1140 pmap_insert(regs, reg, arg);
1141 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1144 obstack_free(&obst, in);
1147 obstack_free(&obst, NULL);
1151 const arch_register_t *reg;
1155 static int cmp_regs(const void *a, const void *b)
1157 const reg_node_map_t *p = a;
1158 const reg_node_map_t *q = b;
1160 if(p->reg->reg_class == q->reg->reg_class)
1161 return p->reg->index - q->reg->index;
1163 return p->reg->reg_class - q->reg->reg_class;
1166 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1169 int n = pmap_count(reg_map);
1171 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1173 pmap_foreach(reg_map, ent) {
1174 res[i].reg = ent->key;
1175 res[i].irn = ent->value;
1179 qsort(res, n, sizeof(res[0]), cmp_regs);
1184 * Creates a barrier.
1186 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1188 ir_graph *irg = env->birg->irg;
1189 int n_regs = pmap_count(regs);
1195 rm = reg_map_to_arr(&env->obst, regs);
1197 for(n = 0; n < n_regs; ++n)
1198 obstack_ptr_grow(&env->obst, rm[n].irn);
1201 obstack_ptr_grow(&env->obst, *mem);
1205 in = (ir_node **) obstack_finish(&env->obst);
1206 irn = be_new_Barrier(irg, bl, n, in);
1207 obstack_free(&env->obst, in);
1209 for(n = 0; n < n_regs; ++n) {
1210 const arch_register_t *reg = rm[n].reg;
1212 int pos = BE_OUT_POS(n);
1215 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1216 be_node_set_reg_class(irn, n, reg->reg_class);
1218 be_set_constr_single_reg(irn, n, reg);
1219 be_set_constr_single_reg(irn, pos, reg);
1220 be_node_set_reg_class(irn, pos, reg->reg_class);
1221 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1223 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1224 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1225 flags |= arch_irn_flags_ignore;
1227 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1228 flags |= arch_irn_flags_modify_sp;
1230 be_node_set_flags(irn, pos, flags);
1232 pmap_insert(regs, (void *) reg, proj);
1236 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1239 obstack_free(&env->obst, rm);
1244 * Creates a be_Return for a Return node.
1246 * @param @env the abi environment
1247 * @param irn the Return node or NULL if there was none
1248 * @param bl the block where the be_Retun should be placed
1249 * @param mem the current memory
1250 * @param n_res number of return results
1252 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1253 be_abi_call_t *call = env->call;
1254 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1256 pmap *reg_map = pmap_create();
1257 ir_node *keep = pmap_get(env->keep_map, bl);
1263 const arch_register_t **regs;
1267 get the valid stack node in this block.
1268 If we had a call in that block there is a Keep constructed by process_calls()
1269 which points to the last stack modification in that block. we'll use
1270 it then. Else we use the stack from the start block and let
1271 the ssa construction fix the usage.
1273 stack = be_abi_reg_map_get(env->regs, isa->sp);
1275 ir_node *bad = new_r_Bad(env->birg->irg);
1276 stack = get_irn_n(keep, 0);
1277 set_nodes_block(keep, bad);
1278 set_irn_n(keep, 0, bad);
1279 // exchange(keep, new_r_Bad(env->birg->irg));
1282 /* Insert results for Return into the register map. */
1283 for(i = 0; i < n_res; ++i) {
1284 ir_node *res = get_Return_res(irn, i);
1285 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1286 assert(arg->in_reg && "return value must be passed in register");
1287 pmap_insert(reg_map, (void *) arg->reg, res);
1290 /* Add uses of the callee save registers. */
1291 pmap_foreach(env->regs, ent) {
1292 const arch_register_t *reg = ent->key;
1293 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1294 pmap_insert(reg_map, ent->key, ent->value);
1297 be_abi_reg_map_set(reg_map, isa->sp, stack);
1299 /* Make the Epilogue node and call the arch's epilogue maker. */
1300 create_barrier(env, bl, &mem, reg_map, 1);
1301 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1304 Maximum size of the in array for Return nodes is
1305 return args + callee save/ignore registers + memory + stack pointer
1307 in_max = pmap_count(reg_map) + n_res + 2;
1309 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1310 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1313 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1318 /* clear SP entry, since it has already been grown. */
1319 pmap_insert(reg_map, (void *) isa->sp, NULL);
1320 for(i = 0; i < n_res; ++i) {
1321 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1323 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1324 regs[n++] = arg->reg;
1326 /* Clear the map entry to mark the register as processed. */
1327 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1330 /* grow the rest of the stuff. */
1331 pmap_foreach(reg_map, ent) {
1334 regs[n++] = ent->key;
1338 /* The in array for the new back end return is now ready. */
1339 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1341 /* Set the register classes of the return's parameter accordingly. */
1342 for(i = 0; i < n; ++i)
1344 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1346 /* Free the space of the Epilog's in array and the register <-> proj map. */
1347 obstack_free(&env->obst, in);
1348 pmap_destroy(reg_map);
1353 typedef struct lower_frame_sels_env_t {
1355 entity *value_param_list; /**< the list of all value param antities */
1356 } lower_frame_sels_env_t;
1359 * Walker: Replaces Sels of frame type and
1360 * value param type entities by FrameAddress.
1362 static void lower_frame_sels_walker(ir_node *irn, void *data)
1364 lower_frame_sels_env_t *ctx = data;
1367 ir_graph *irg = current_ir_graph;
1368 ir_node *frame = get_irg_frame(irg);
1369 ir_node *param_base = get_irg_value_param_base(irg);
1370 ir_node *ptr = get_Sel_ptr(irn);
1372 if (ptr == frame || ptr == param_base) {
1373 be_abi_irg_t *env = ctx->env;
1374 entity *ent = get_Sel_entity(irn);
1375 ir_node *bl = get_nodes_block(irn);
1378 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1381 if (ptr == param_base) {
1382 set_entity_link(ent, ctx->value_param_list);
1383 ctx->value_param_list = ent;
1390 * Check if a value parameter is transmitted as a register.
1391 * This might happen if the address of an parameter is taken which is
1392 * transmitted in registers.
1394 * Note that on some architectures this case must be handled specially
1395 * because the place of the backing store is determined by their ABI.
1397 * In the default case we move the entity to the frame type and create
1398 * a backing store into the first block.
1400 static void fix_address_of_parameter_access(be_abi_irg_t *env, entity *value_param_list) {
1401 be_abi_call_t *call = env->call;
1402 ir_graph *irg = env->birg->irg;
1403 entity *ent, *next_ent, *new_list;
1405 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1408 for (ent = value_param_list; ent; ent = next_ent) {
1409 int i = get_struct_member_index(get_entity_owner(ent), ent);
1410 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1412 next_ent = get_entity_link(ent);
1414 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1415 set_entity_link(ent, new_list);
1420 /* ok, change the graph */
1421 ir_node *start_bl = get_irg_start_block(irg);
1422 ir_node *first_bl = NULL;
1423 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1424 const ir_edge_t *edge;
1425 optimization_state_t state;
1428 foreach_block_succ(start_bl, edge) {
1429 ir_node *succ = get_edge_src_irn(edge);
1430 if (start_bl != succ) {
1436 /* we had already removed critical edges, so the following
1437 assertion should be always true. */
1438 assert(get_Block_n_cfgpreds(first_bl) == 1);
1440 /* now create backing stores */
1441 frame = get_irg_frame(irg);
1442 imem = get_irg_initial_mem(irg);
1444 save_optimization_state(&state);
1446 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1447 restore_optimization_state(&state);
1449 /* reroute all edges to the new memory source */
1450 edges_reroute(imem, nmem, irg);
1454 args = get_irg_args(irg);
1455 args_bl = get_nodes_block(args);
1456 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1457 int i = get_struct_member_index(get_entity_owner(ent), ent);
1458 ir_type *tp = get_entity_type(ent);
1459 ir_mode *mode = get_type_mode(tp);
1462 /* address for the backing store */
1463 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1466 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1468 /* the backing store itself */
1469 store = new_r_Store(irg, first_bl, mem, addr,
1470 new_r_Proj(irg, args_bl, args, mode, i));
1472 /* the new memory Proj gets the last Proj from store */
1473 set_Proj_pred(nmem, store);
1474 set_Proj_proj(nmem, pn_Store_M);
1476 /* move all entities to the frame type */
1477 frame_tp = get_irg_frame_type(irg);
1478 offset = get_type_size_bytes(frame_tp);
1479 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1480 ir_type *tp = get_entity_type(ent);
1481 int align = get_type_alignment_bytes(tp);
1483 offset += align - 1;
1485 set_entity_owner(ent, frame_tp);
1486 add_class_member(frame_tp, ent);
1487 /* must be automatic to set a fixed layout */
1488 set_entity_allocation(ent, allocation_automatic);
1489 set_entity_offset_bytes(ent, offset);
1490 offset += get_type_size_bytes(tp);
1492 set_type_size_bytes(frame_tp, offset);
1497 * Modify the irg itself and the frame type.
1499 static void modify_irg(be_abi_irg_t *env)
1501 be_abi_call_t *call = env->call;
1502 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1503 const arch_register_t *sp = arch_isa_sp(isa);
1504 ir_graph *irg = env->birg->irg;
1505 ir_node *bl = get_irg_start_block(irg);
1506 ir_node *end = get_irg_end_block(irg);
1507 ir_node *no_mem = get_irg_no_mem(irg);
1508 ir_node *mem = get_irg_initial_mem(irg);
1509 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1510 pset *dont_save = pset_new_ptr(8);
1516 const arch_register_t *fp_reg;
1517 ir_node *frame_pointer;
1519 ir_node *reg_params_bl;
1522 const ir_edge_t *edge;
1523 ir_type *arg_type, *bet_type;
1524 lower_frame_sels_env_t ctx;
1526 bitset_t *used_proj_nr;
1527 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1529 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1531 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1533 ctx.value_param_list = NULL;
1534 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1536 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1537 env->regs = pmap_create();
1539 used_proj_nr = bitset_alloca(1024);
1540 n_params = get_method_n_params(method_type);
1541 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1542 memset(args, 0, n_params * sizeof(args[0]));
1544 /* Check if a value parameter is transmitted as a register.
1545 * This might happen if the address of an parameter is taken which is
1546 * transmitted in registers.
1548 * Note that on some architectures this case must be handled specially
1549 * because the place of the backing store is determined by their ABI.
1551 * In the default case we move the entity to the frame type and create
1552 * a backing store into the first block.
1554 fix_address_of_parameter_access(env, ctx.value_param_list);
1556 /* Fill the argument vector */
1557 arg_tuple = get_irg_args(irg);
1558 foreach_out_edge(arg_tuple, edge) {
1559 ir_node *irn = get_edge_src_irn(edge);
1560 int nr = get_Proj_proj(irn);
1562 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1565 arg_type = compute_arg_type(env, call, method_type);
1566 bet_type = call->cb->get_between_type(env->cb);
1567 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir);
1569 /* Count the register params and add them to the number of Projs for the RegParams node */
1570 for(i = 0; i < n_params; ++i) {
1571 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1572 if(arg->in_reg && args[i]) {
1573 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1574 assert(i == get_Proj_proj(args[i]));
1576 /* For now, associate the register with the old Proj from Start representing that argument. */
1577 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1578 bitset_set(used_proj_nr, i);
1579 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1583 /* Collect all callee-save registers */
1584 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1585 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1586 for(j = 0; j < cls->n_regs; ++j) {
1587 const arch_register_t *reg = &cls->regs[j];
1588 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1589 pmap_insert(env->regs, (void *) reg, NULL);
1593 pmap_insert(env->regs, (void *) sp, NULL);
1594 pmap_insert(env->regs, (void *) isa->bp, NULL);
1595 reg_params_bl = get_irg_start_block(irg);
1596 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1599 * make proj nodes for the callee save registers.
1600 * memorize them, since Return nodes get those as inputs.
1602 * Note, that if a register corresponds to an argument, the regs map contains
1603 * the old Proj from start for that argument.
1606 rm = reg_map_to_arr(&env->obst, env->regs);
1607 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1608 arch_register_t *reg = (void *) rm[i].reg;
1609 ir_node *arg_proj = rm[i].irn;
1610 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1612 int pos = BE_OUT_POS((int) nr);
1618 bitset_set(used_proj_nr, nr);
1619 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1620 pmap_insert(env->regs, (void *) reg, proj);
1621 be_set_constr_single_reg(env->reg_params, pos, reg);
1622 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1625 * If the register is an ignore register,
1626 * The Proj for that register shall also be ignored during register allocation.
1628 if(arch_register_type_is(reg, ignore))
1629 flags |= arch_irn_flags_ignore;
1632 flags |= arch_irn_flags_modify_sp;
1634 be_node_set_flags(env->reg_params, pos, flags);
1636 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1638 obstack_free(&env->obst, rm);
1640 /* Generate the Prologue */
1641 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1643 /* do the stack allocation BEFORE the barrier, or spill code
1644 might be added before it */
1645 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1646 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1647 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1649 barrier = create_barrier(env, bl, &mem, env->regs, 0);
1651 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1652 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1654 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1655 set_irg_frame(irg, frame_pointer);
1656 pset_insert_ptr(env->ignore_regs, fp_reg);
1658 /* Now, introduce stack param nodes for all parameters passed on the stack */
1659 for(i = 0; i < n_params; ++i) {
1660 ir_node *arg_proj = args[i];
1661 ir_node *repl = NULL;
1663 if(arg_proj != NULL) {
1664 be_abi_call_arg_t *arg;
1665 ir_type *param_type;
1666 int nr = get_Proj_proj(arg_proj);
1668 nr = MIN(nr, n_params);
1669 arg = get_call_arg(call, 0, nr);
1670 param_type = get_method_param_type(method_type, nr);
1673 repl = pmap_get(env->regs, (void *) arg->reg);
1676 else if(arg->on_stack) {
1677 /* For atomic parameters which are actually used, we create a StackParam node. */
1678 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1679 ir_mode *mode = get_type_mode(param_type);
1680 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1681 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1684 /* The stack parameter is not primitive (it is a struct or array),
1685 we thus will create a node representing the parameter's address
1688 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1692 assert(repl != NULL);
1693 edges_reroute(args[i], repl, irg);
1697 /* All Return nodes hang on the End node, so look for them there. */
1698 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1699 ir_node *irn = get_Block_cfgpred(end, i);
1701 if (is_Return(irn)) {
1702 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1706 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1707 the code is dead and will never be executed. */
1709 del_pset(dont_save);
1710 obstack_free(&env->obst, args);
1714 * Walker: puts all Alloc(stack_alloc) on a obstack
1716 static void collect_alloca_walker(ir_node *irn, void *data)
1718 be_abi_irg_t *env = data;
1719 if(get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)
1720 obstack_ptr_grow(&env->obst, irn);
1723 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1725 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1726 ir_node *old_frame = get_irg_frame(birg->irg);
1727 ir_graph *irg = birg->irg;
1731 optimization_state_t state;
1733 obstack_init(&env->obst);
1735 env->isa = birg->main_env->arch_env->isa;
1736 env->method_type = get_entity_type(get_irg_entity(irg));
1737 env->call = be_abi_call_new();
1738 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1740 env->ignore_regs = pset_new_ptr_default();
1741 env->keep_map = pmap_create();
1742 env->dce_survivor = new_survive_dce();
1744 env->stack_phis = pset_new_ptr(16);
1745 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1746 to another Unknown or the stack pointer gets used */
1747 save_optimization_state(&state);
1749 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1750 restore_optimization_state(&state);
1751 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1753 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1754 env->irn_ops.impl = &abi_irn_ops;
1756 /* Lower all call nodes in the IRG. */
1760 Beware: init backend abi call object after processing calls,
1761 otherwise some information might be not yet available.
1763 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1765 /* Process the IRG */
1768 /* We don't need the keep map anymore. */
1769 pmap_destroy(env->keep_map);
1771 /* reroute the stack origin of the calls to the true stack origin. */
1772 edges_reroute(dummy, env->init_sp, irg);
1773 edges_reroute(old_frame, get_irg_frame(irg), irg);
1775 /* Make some important node pointers survive the dead node elimination. */
1776 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1777 pmap_foreach(env->regs, ent)
1778 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1780 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1782 env->call->cb->done(env->cb);
1786 void be_abi_free(be_abi_irg_t *env)
1788 free_survive_dce(env->dce_survivor);
1789 del_pset(env->stack_phis);
1790 del_pset(env->ignore_regs);
1791 pmap_destroy(env->regs);
1792 obstack_free(&env->obst, NULL);
1793 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1797 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1799 arch_register_t *reg;
1801 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1802 if(reg->reg_class == cls)
1803 bitset_set(bs, reg->index);
1810 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1811 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1812 | _| | |> < ___) | || (_| | (__| <
1813 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1817 struct fix_stack_walker_info {
1819 const arch_env_t *aenv;
1823 * Walker. Collect all stack modifying nodes.
1825 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1827 struct fix_stack_walker_info *info = data;
1832 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1833 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1834 pset_insert_ptr(info->nodes, irn);
1838 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1840 dom_front_info_t *df;
1841 pset *stack_nodes = pset_new_ptr(16);
1842 struct fix_stack_walker_info info;
1844 info.nodes = stack_nodes;
1845 info.aenv = env->birg->main_env->arch_env;
1847 /* We need dominance frontiers for fix up */
1848 df = be_compute_dominance_frontiers(env->birg->irg);
1849 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1850 pset_insert_ptr(stack_nodes, env->init_sp);
1851 be_ssa_constr_set_phis(df, lv, stack_nodes, env->stack_phis);
1852 del_pset(stack_nodes);
1854 /* free these dominance frontiers */
1855 be_free_dominance_frontiers(df);
1858 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1860 const arch_env_t *arch_env = env->birg->main_env->arch_env;
1861 int omit_fp = env->call->flags.bits.try_omit_fp;
1864 sched_foreach(bl, irn) {
1867 Check, if the node relates to an entity on the stack frame.
1868 If so, set the true offset (including the bias) for that
1871 entity *ent = arch_get_frame_entity(arch_env, irn);
1873 int offset = get_stack_entity_offset(env->frame, ent, bias);
1874 arch_set_frame_offset(arch_env, irn, offset);
1875 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
1879 If the node modifies the stack pointer by a constant offset,
1880 record that in the bias.
1882 if(arch_irn_is(arch_env, irn, modify_sp)) {
1883 int ofs = arch_get_sp_bias(arch_env, irn);
1885 if(be_is_IncSP(irn)) {
1886 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
1887 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1888 be_set_IncSP_offset(irn, ofs);
1889 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
1890 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1891 be_set_IncSP_offset(irn, ofs);
1904 * A helper struct for the bias walker.
1907 be_abi_irg_t *env; /**< The ABI irg environment. */
1908 int start_block_bias; /**< The bias at the end of the start block. */
1909 ir_node *start_block; /**< The start block of the current graph. */
1913 * Block-Walker: fix all stack offsets
1915 static void stack_bias_walker(ir_node *bl, void *data)
1917 struct bias_walk *bw = data;
1918 if (bl != bw->start_block) {
1919 process_stack_bias(bw->env, bl, bw->start_block_bias);
1923 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1925 ir_graph *irg = env->birg->irg;
1926 struct bias_walk bw;
1928 stack_frame_compute_initial_offset(env->frame);
1929 // stack_layout_dump(stdout, env->frame);
1931 /* Determine the stack bias at the end of the start block. */
1932 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1934 /* fix the bias is all other blocks */
1936 bw.start_block = get_irg_start_block(irg);
1937 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1940 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1942 assert(arch_register_type_is(reg, callee_save));
1943 assert(pmap_contains(abi->regs, (void *) reg));
1944 return pmap_get(abi->regs, (void *) reg);
1948 _____ _____ _ _ _ _ _ _
1949 |_ _| __ \| \ | | | | | | | | |
1950 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
1951 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
1952 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
1953 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
1955 for Phi nodes which are created due to stack modifying nodes
1956 such as IncSP, AddSP and SetSP.
1958 These Phis are always to be ignored by the reg alloc and are
1959 fixed on the SP register of the ISA.
1962 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
1964 const be_abi_irg_t *abi = get_abi_from_handler(handler);
1965 const void *res = NULL;
1967 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
1968 res = &abi->irn_ops;
1973 static void be_abi_limited(void *data, bitset_t *bs)
1975 be_abi_irg_t *abi = data;
1976 bitset_clear_all(bs);
1977 bitset_set(bs, abi->isa->sp->index);
1980 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)
1982 be_abi_irg_t *abi = get_abi_from_ops(self);
1983 const arch_register_t *reg = abi->isa->sp;
1985 memset(req, 0, sizeof(req[0]));
1987 if(pos == BE_OUT_POS(0)) {
1988 req->cls = reg->reg_class;
1989 req->type = arch_register_req_type_limited;
1990 req->limited = be_abi_limited;
1991 req->limited_env = abi;
1994 else if(pos >= 0 && pos < get_irn_arity(irn)) {
1995 req->cls = reg->reg_class;
1996 req->type = arch_register_req_type_normal;
2002 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
2006 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
2008 const be_abi_irg_t *abi = get_abi_from_ops(self);
2009 return abi->isa->sp;
2012 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
2014 return arch_irn_class_normal;
2017 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2019 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2022 static entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2027 static void abi_set_frame_entity(const void *_self, ir_node *irn, entity *ent)
2031 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2035 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2040 static const arch_irn_ops_if_t abi_irn_ops = {
2041 abi_get_irn_reg_req,
2046 abi_get_frame_entity,
2047 abi_set_frame_entity,
2048 abi_set_frame_offset,
2050 NULL, /* get_inverse */
2051 NULL, /* get_op_estimated_cost */
2052 NULL, /* possible_memory_operand */
2053 NULL, /* perform_memory_operand */
2056 static const arch_irn_handler_t abi_irn_handler = {