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);
481 assert(mode_is_reference(mach_mode) && "machine mode must be pointer");
482 for(i = 0; i < n_pos; ++i) {
484 be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
485 ir_node *param = get_Call_param(irn, p);
486 ir_node *addr = curr_sp;
488 ir_type *param_type = get_method_param_type(mt, p);
489 int param_size = get_type_size_bytes(param_type) + arg->space_after;
492 * If we wanted to build the arguments sequentially,
493 * the stack pointer for the next must be incremented,
494 * and the memory value propagated.
498 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, param_size + arg->space_before);
500 add_irn_dep(curr_sp, alloca_copy);
503 add_irn_dep(curr_sp, curr_mem);
506 curr_ofs += arg->space_before;
507 curr_ofs = round_up2(curr_ofs, arg->alignment);
509 /* Make the expression to compute the argument's offset. */
511 addr = new_r_Const_long(irg, bl, mode_Is, curr_ofs);
512 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
516 /* Insert a store for primitive arguments. */
517 if (is_atomic_type(param_type)) {
518 mem = new_r_Store(irg, bl, curr_mem, addr, param);
519 mem = new_r_Proj(irg, bl, mem, mode_M, pn_Store_M);
522 /* Make a mem copy for compound arguments. */
524 assert(mode_is_reference(get_irn_mode(param)));
525 mem = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
526 mem = new_r_Proj(irg, bl, mem, mode_M, pn_CopyB_M_regular);
529 curr_ofs += param_size;
534 obstack_ptr_grow(obst, mem);
537 in = (ir_node **) obstack_finish(obst);
539 /* We need the sync only, if we didn't build the stores sequentially. */
541 curr_mem = new_r_Sync(irg, bl, n_pos, in);
542 obstack_free(obst, in);
545 /* Collect caller save registers */
546 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
548 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
549 for(j = 0; j < cls->n_regs; ++j) {
550 const arch_register_t *reg = arch_register_for_index(cls, j);
551 if(arch_register_type_is(reg, caller_save))
552 pset_insert_ptr(caller_save, (void *) reg);
556 /* search the greatest result proj number */
558 /* TODO: what if the result is NOT used? Currently there is
559 * no way to detect this later, especially there is no way to
560 * see this in the proj numbers.
561 * While this is ok for the register allocator, it is bad for
562 * backends which need to change the be_Call further (x87 simulator
563 * for instance. However for this particular case the call_type is
566 foreach_out_edge(irn, edge) {
567 const ir_edge_t *res_edge;
568 ir_node *irn = get_edge_src_irn(edge);
570 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_T_result) {
572 foreach_out_edge(irn, res_edge) {
574 be_abi_call_arg_t *arg;
575 ir_node *res = get_edge_src_irn(res_edge);
577 assert(is_Proj(res));
579 proj = get_Proj_proj(res);
580 arg = get_call_arg(call, 1, proj);
583 shift the proj number to the right, since we will drop the
584 unspeakable Proj_T from the Call. Therefore, all real argument
585 Proj numbers must be increased by pn_be_Call_first_res
587 proj += pn_be_Call_first_res;
588 set_Proj_proj(res, proj);
589 obstack_ptr_grow(obst, res);
591 if(proj > curr_res_proj)
592 curr_res_proj = proj;
594 pset_remove_ptr(caller_save, arg->reg);
595 //pmap_insert(arg_regs, arg->reg, INT_TO_PTR(proj + 1))
602 obstack_ptr_grow(obst, NULL);
603 res_projs = obstack_finish(obst);
605 /* make the back end call node and set its register requirements. */
606 for(i = 0; i < n_low_args; ++i)
607 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
609 in = obstack_finish(obst);
611 if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
612 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, curr_sp,
613 curr_res_proj + pset_count(caller_save), n_low_args, in,
615 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
619 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem, curr_sp, call_ptr,
620 curr_res_proj + pset_count(caller_save), n_low_args, in,
625 Set the register class of the call address to the same as the stack pointer's.
626 That' probably buggy for some architectures.
628 be_node_set_reg_class(low_call, be_pos_Call_ptr, sp->reg_class);
630 DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
632 /* Set the register classes and constraints of the Call parameters. */
633 for(i = 0; i < n_low_args; ++i) {
634 int index = low_args[i];
635 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
636 assert(arg->reg != NULL);
638 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + index, arg->reg);
641 /* Set the register constraints of the results. */
642 for(i = 0; res_projs[i]; ++i) {
643 ir_node *irn = res_projs[i];
644 int proj = get_Proj_proj(irn);
646 /* Correct Proj number since it has been adjusted! (see above) */
647 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
650 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
652 obstack_free(obst, in);
653 exchange(irn, low_call);
655 /* redirect the result projs to the lowered call instead of the Proj_T */
656 for(i = 0; res_projs[i]; ++i)
657 set_Proj_pred(res_projs[i], low_call);
659 /* Make additional projs for the caller save registers
660 and the Keep node which keeps them alive. */
661 if(pset_count(caller_save) > 0) {
662 const arch_register_t *reg;
666 for(reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
667 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj);
669 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
670 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
671 set_irn_link(proj, (void *) reg);
672 obstack_ptr_grow(obst, proj);
676 in = (ir_node **) obstack_finish(obst);
677 keep = be_new_Keep(NULL, irg, bl, n, in);
678 for(i = 0; i < n; ++i) {
679 const arch_register_t *reg = get_irn_link(in[i]);
680 be_node_set_reg_class(keep, i, reg->reg_class);
682 obstack_free(obst, in);
685 /* Clean up the stack. */
687 ir_node *mem_proj = NULL;
689 foreach_out_edge(low_call, edge) {
690 ir_node *irn = get_edge_src_irn(edge);
691 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
698 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
700 /* Clean up the stack frame if we allocated it */
702 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
703 add_irn_dep(curr_sp, mem_proj);
705 add_irn_dep(curr_sp, alloca_copy);
711 be_abi_call_free(call);
712 obstack_free(obst, pos);
714 del_pset(caller_save);
721 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
723 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
725 if (get_Alloc_where(alloc) == stack_alloc) {
726 ir_node *bl = get_nodes_block(alloc);
727 ir_graph *irg = get_irn_irg(bl);
728 ir_node *alloc_mem = NULL;
729 ir_node *alloc_res = NULL;
731 const ir_edge_t *edge;
736 foreach_out_edge(alloc, edge) {
737 ir_node *irn = get_edge_src_irn(edge);
739 assert(is_Proj(irn));
740 switch(get_Proj_proj(irn)) {
752 /* Beware: currently Alloc nodes without a result might happen,
753 only escape analysis kills them and this phase runs only for object
754 oriented source. We kill the Alloc here. */
755 if (alloc_res == NULL && alloc_mem) {
756 exchange(alloc_mem, get_Alloc_mem(alloc));
760 /* The stack pointer will be modified in an unknown manner.
761 We cannot omit it. */
762 env->call->flags.bits.try_omit_fp = 0;
763 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
765 exchange(alloc, new_alloc);
767 if(alloc_mem != NULL)
768 set_Proj_proj(alloc_mem, pn_be_AddSP_M);
770 /* fix projnum of alloca res */
771 set_Proj_proj(alloc_res, pn_be_AddSP_res);
773 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
775 /* copy the address away, since it could be used after further stack pointer modifications. */
776 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
777 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, bl, curr_sp);
779 /* Let all users of the Alloc() result now point to the copy. */
780 edges_reroute(alloc_res, copy, irg);
782 /* Rewire the copy appropriately. */
783 set_irn_n(copy, be_pos_Copy_op, addr);
791 /* the following function is replaced by the usage of the heights module */
794 * Walker for dependent_on().
795 * This function searches a node tgt recursively from a given node
796 * but is restricted to the given block.
797 * @return 1 if tgt was reachable from curr, 0 if not.
799 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
803 if (get_nodes_block(curr) != bl)
809 /* Phi functions stop the recursion inside a basic block */
810 if (! is_Phi(curr)) {
811 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
812 if (check_dependence(get_irn_n(curr, i), tgt, bl))
822 * Check if a node is somehow data dependent on another one.
823 * both nodes must be in the same basic block.
824 * @param n1 The first node.
825 * @param n2 The second node.
826 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
828 static int dependent_on(ir_node *n1, ir_node *n2)
830 ir_node *bl = get_nodes_block(n1);
832 assert(bl == get_nodes_block(n2));
834 return heights_reachable_in_block(ir_heights, n1, n2);
835 //return check_dependence(n1, n2, bl);
838 static int cmp_call_dependecy(const void *c1, const void *c2)
840 ir_node *n1 = *(ir_node **) c1;
841 ir_node *n2 = *(ir_node **) c2;
844 Classical qsort() comparison function behavior:
845 0 if both elements are equal
846 1 if second is "smaller" that first
847 -1 if first is "smaller" that second
849 if (dependent_on(n1, n2))
852 if (dependent_on(n2, n1))
859 * Walker: links all Call nodes to the Block they are contained.
861 static void link_calls_in_block_walker(ir_node *irn, void *data)
863 if(is_Call(irn) || (get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)) {
864 be_abi_irg_t *env = data;
865 ir_node *bl = get_nodes_block(irn);
866 void *save = get_irn_link(bl);
869 env->call->flags.bits.irg_is_leaf = 0;
871 set_irn_link(irn, save);
872 set_irn_link(bl, irn);
878 * Process all Call nodes inside a basic block.
879 * Note that the link field of the block must contain a linked list of all
880 * Call nodes inside the Block. We first order this list according to data dependency
881 * and that connect the calls together.
883 static void process_calls_in_block(ir_node *bl, void *data)
885 be_abi_irg_t *env = data;
886 ir_node *curr_sp = env->init_sp;
890 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
891 obstack_ptr_grow(&env->obst, irn);
893 /* If there were call nodes in the block. */
897 ir_node *copy = NULL;
900 nodes = obstack_finish(&env->obst);
902 /* order the call nodes according to data dependency */
903 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
905 for(i = n - 1; i >= 0; --i) {
906 ir_node *irn = nodes[i];
908 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
909 switch(get_irn_opcode(irn)) {
911 curr_sp = adjust_call(env, irn, curr_sp, copy);
914 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
921 obstack_free(&env->obst, nodes);
923 /* Keep the last stack state in the block by tying it to Keep node */
925 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
926 pmap_insert(env->keep_map, bl, keep);
929 set_irn_link(bl, curr_sp);
933 * Adjust all call nodes in the graph to the ABI conventions.
935 static void process_calls(be_abi_irg_t *env)
937 ir_graph *irg = env->birg->irg;
939 env->call->flags.bits.irg_is_leaf = 1;
940 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
942 ir_heights = heights_new(env->birg->irg);
943 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
944 heights_free(ir_heights);
947 static void collect_return_walker(ir_node *irn, void *data)
949 if(get_irn_opcode(irn) == iro_Return) {
950 struct obstack *obst = data;
951 obstack_ptr_grow(obst, irn);
956 static ir_node *setup_frame(be_abi_irg_t *env)
958 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
959 const arch_register_t *sp = isa->sp;
960 const arch_register_t *bp = isa->bp;
961 be_abi_call_flags_bits_t flags = env->call->flags.bits;
962 ir_graph *irg = env->birg->irg;
963 ir_node *bl = get_irg_start_block(irg);
964 ir_node *no_mem = get_irg_no_mem(irg);
965 ir_node *old_frame = get_irg_frame(irg);
966 ir_node *stack = pmap_get(env->regs, (void *) sp);
967 ir_node *frame = pmap_get(env->regs, (void *) bp);
969 int stack_nr = get_Proj_proj(stack);
971 if(flags.try_omit_fp) {
972 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
977 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
979 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
981 be_set_constr_single_reg(frame, -1, bp);
982 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
983 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
986 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
989 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
990 env->init_sp = stack;
991 set_irg_frame(irg, frame);
992 edges_reroute(old_frame, frame, irg);
997 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
999 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1000 const arch_register_t *sp = isa->sp;
1001 const arch_register_t *bp = isa->bp;
1002 ir_graph *irg = env->birg->irg;
1003 ir_node *ret_mem = get_Return_mem(ret);
1004 ir_node *frame = get_irg_frame(irg);
1005 ir_node *bl = get_nodes_block(ret);
1006 ir_node *stack = get_irn_link(bl);
1010 if(env->call->flags.bits.try_omit_fp) {
1011 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1015 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1016 be_set_constr_single_reg(stack, -1, sp);
1017 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1020 pmap_foreach(env->regs, ent) {
1021 const arch_register_t *reg = ent->key;
1022 ir_node *irn = ent->value;
1025 obstack_ptr_grow(&env->obst, stack);
1027 obstack_ptr_grow(&env->obst, frame);
1028 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1029 obstack_ptr_grow(obst, irn);
1036 * Computes the stack argument layout type.
1037 * Changes a possibly allocated value param type by moving
1038 * entities to the stack layout type.
1040 * @param env the ABI environment
1041 * @param call the current call ABI
1042 * @param method_type the method type
1044 * @return the stack argument layout type
1046 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type)
1048 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1049 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1050 int n = get_method_n_params(method_type);
1051 int curr = inc > 0 ? 0 : n - 1;
1057 ir_type *val_param_tp = get_method_value_param_type(method_type);
1058 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1060 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1061 for (i = 0; i < n; ++i, curr += inc) {
1062 ir_type *param_type = get_method_param_type(method_type, curr);
1063 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1065 if (arg->on_stack) {
1067 /* the entity was already created, move it to the param type */
1068 arg->stack_ent = get_method_value_param_ent(method_type, i);
1069 remove_struct_member(val_param_tp, arg->stack_ent);
1070 set_entity_owner(arg->stack_ent, res);
1071 add_struct_member(res, arg->stack_ent);
1072 /* must be automatic to set a fixed layout */
1073 set_entity_allocation(arg->stack_ent, allocation_automatic);
1076 snprintf(buf, sizeof(buf), "param_%d", i);
1077 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1079 ofs += arg->space_before;
1080 ofs = round_up2(ofs, arg->alignment);
1081 set_entity_offset_bytes(arg->stack_ent, ofs);
1082 ofs += arg->space_after;
1083 ofs += get_type_size_bytes(param_type);
1086 set_type_size_bytes(res, ofs);
1087 set_type_state(res, layout_fixed);
1091 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1094 struct obstack obst;
1096 obstack_init(&obst);
1098 /* Create a Perm after the RegParams node to delimit it. */
1099 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1100 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1105 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1106 const arch_register_t *reg = &cls->regs[j];
1107 ir_node *irn = pmap_get(regs, (void *) reg);
1109 if(irn && !arch_register_type_is(reg, ignore)) {
1111 obstack_ptr_grow(&obst, irn);
1112 set_irn_link(irn, (void *) reg);
1116 obstack_ptr_grow(&obst, NULL);
1117 in = obstack_finish(&obst);
1119 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1120 for(j = 0; j < n_regs; ++j) {
1121 ir_node *arg = in[j];
1122 arch_register_t *reg = get_irn_link(arg);
1123 pmap_insert(regs, reg, arg);
1124 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1127 obstack_free(&obst, in);
1130 obstack_free(&obst, NULL);
1134 const arch_register_t *reg;
1138 static int cmp_regs(const void *a, const void *b)
1140 const reg_node_map_t *p = a;
1141 const reg_node_map_t *q = b;
1143 if(p->reg->reg_class == q->reg->reg_class)
1144 return p->reg->index - q->reg->index;
1146 return p->reg->reg_class - q->reg->reg_class;
1149 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1152 int n = pmap_count(reg_map);
1154 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1156 pmap_foreach(reg_map, ent) {
1157 res[i].reg = ent->key;
1158 res[i].irn = ent->value;
1162 qsort(res, n, sizeof(res[0]), cmp_regs);
1167 * Creates a barrier.
1169 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1171 ir_graph *irg = env->birg->irg;
1172 int n_regs = pmap_count(regs);
1178 rm = reg_map_to_arr(&env->obst, regs);
1180 for(n = 0; n < n_regs; ++n)
1181 obstack_ptr_grow(&env->obst, rm[n].irn);
1184 obstack_ptr_grow(&env->obst, *mem);
1188 in = (ir_node **) obstack_finish(&env->obst);
1189 irn = be_new_Barrier(irg, bl, n, in);
1190 obstack_free(&env->obst, in);
1192 for(n = 0; n < n_regs; ++n) {
1193 const arch_register_t *reg = rm[n].reg;
1195 int pos = BE_OUT_POS(n);
1198 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1199 be_node_set_reg_class(irn, n, reg->reg_class);
1201 be_set_constr_single_reg(irn, n, reg);
1202 be_set_constr_single_reg(irn, pos, reg);
1203 be_node_set_reg_class(irn, pos, reg->reg_class);
1204 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1206 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1207 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1208 flags |= arch_irn_flags_ignore;
1210 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1211 flags |= arch_irn_flags_modify_sp;
1213 be_node_set_flags(irn, pos, flags);
1215 pmap_insert(regs, (void *) reg, proj);
1219 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1222 obstack_free(&env->obst, rm);
1227 * Creates a be_Return for a Return node.
1229 * @param @env the abi environment
1230 * @param irn the Return node or NULL if there was none
1231 * @param bl the block where the be_Retun should be placed
1232 * @param mem the current memory
1233 * @param n_res number of return results
1235 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1236 be_abi_call_t *call = env->call;
1237 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1239 pmap *reg_map = pmap_create();
1240 ir_node *keep = pmap_get(env->keep_map, bl);
1246 const arch_register_t **regs;
1250 get the valid stack node in this block.
1251 If we had a call in that block there is a Keep constructed by process_calls()
1252 which points to the last stack modification in that block. we'll use
1253 it then. Else we use the stack from the start block and let
1254 the ssa construction fix the usage.
1256 stack = be_abi_reg_map_get(env->regs, isa->sp);
1258 ir_node *bad = new_r_Bad(env->birg->irg);
1259 stack = get_irn_n(keep, 0);
1260 set_nodes_block(keep, bad);
1261 set_irn_n(keep, 0, bad);
1262 // exchange(keep, new_r_Bad(env->birg->irg));
1265 /* Insert results for Return into the register map. */
1266 for(i = 0; i < n_res; ++i) {
1267 ir_node *res = get_Return_res(irn, i);
1268 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1269 assert(arg->in_reg && "return value must be passed in register");
1270 pmap_insert(reg_map, (void *) arg->reg, res);
1273 /* Add uses of the callee save registers. */
1274 pmap_foreach(env->regs, ent) {
1275 const arch_register_t *reg = ent->key;
1276 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1277 pmap_insert(reg_map, ent->key, ent->value);
1280 be_abi_reg_map_set(reg_map, isa->sp, stack);
1282 /* Make the Epilogue node and call the arch's epilogue maker. */
1283 create_barrier(env, bl, &mem, reg_map, 1);
1284 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1287 Maximum size of the in array for Return nodes is
1288 return args + callee save/ignore registers + memory + stack pointer
1290 in_max = pmap_count(reg_map) + n_res + 2;
1292 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1293 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1296 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1301 /* clear SP entry, since it has already been grown. */
1302 pmap_insert(reg_map, (void *) isa->sp, NULL);
1303 for(i = 0; i < n_res; ++i) {
1304 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1306 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1307 regs[n++] = arg->reg;
1309 /* Clear the map entry to mark the register as processed. */
1310 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1313 /* grow the rest of the stuff. */
1314 pmap_foreach(reg_map, ent) {
1317 regs[n++] = ent->key;
1321 /* The in array for the new back end return is now ready. */
1322 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1324 /* Set the register classes of the return's parameter accordingly. */
1325 for(i = 0; i < n; ++i)
1327 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1329 /* Free the space of the Epilog's in array and the register <-> proj map. */
1330 obstack_free(&env->obst, in);
1331 pmap_destroy(reg_map);
1336 typedef struct lower_frame_sels_env_t {
1338 entity *value_param_list; /**< the list of all value param antities */
1339 } lower_frame_sels_env_t;
1342 * Walker: Replaces Sels of frame type and
1343 * value param type entities by FrameAddress.
1345 static void lower_frame_sels_walker(ir_node *irn, void *data)
1347 lower_frame_sels_env_t *ctx = data;
1350 ir_graph *irg = current_ir_graph;
1351 ir_node *frame = get_irg_frame(irg);
1352 ir_node *param_base = get_irg_value_param_base(irg);
1353 ir_node *ptr = get_Sel_ptr(irn);
1355 if (ptr == frame || ptr == param_base) {
1356 be_abi_irg_t *env = ctx->env;
1357 entity *ent = get_Sel_entity(irn);
1358 ir_node *bl = get_nodes_block(irn);
1361 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1364 if (ptr == param_base) {
1365 set_entity_link(ent, ctx->value_param_list);
1366 ctx->value_param_list = ent;
1373 * Check if a value parameter is transmitted as a register.
1374 * This might happen if the address of an parameter is taken which is
1375 * transmitted in registers.
1377 * Note that on some architectures this case must be handled specially
1378 * because the place of the backing store is determined by their ABI.
1380 * In the default case we move the entity to the frame type and create
1381 * a backing store into the first block.
1383 static void fix_address_of_parameter_access(be_abi_irg_t *env, entity *value_param_list) {
1384 be_abi_call_t *call = env->call;
1385 ir_graph *irg = env->birg->irg;
1386 entity *ent, *next_ent, *new_list;
1388 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1391 for (ent = value_param_list; ent; ent = next_ent) {
1392 int i = get_struct_member_index(get_entity_owner(ent), ent);
1393 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1395 next_ent = get_entity_link(ent);
1397 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1398 set_entity_link(ent, new_list);
1403 /* ok, change the graph */
1404 ir_node *start_bl = get_irg_start_block(irg);
1405 ir_node *first_bl = NULL;
1406 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1407 const ir_edge_t *edge;
1408 optimization_state_t state;
1411 foreach_block_succ(start_bl, edge) {
1412 ir_node *succ = get_edge_src_irn(edge);
1413 if (start_bl != succ) {
1419 /* we had already removed critical edges, so the following
1420 assertion should be always true. */
1421 assert(get_Block_n_cfgpreds(first_bl) == 1);
1423 /* now create backing stores */
1424 frame = get_irg_frame(irg);
1425 imem = get_irg_initial_mem(irg);
1427 save_optimization_state(&state);
1429 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1430 restore_optimization_state(&state);
1432 /* reroute all edges to the new memory source */
1433 edges_reroute(imem, nmem, irg);
1437 args = get_irg_args(irg);
1438 args_bl = get_nodes_block(args);
1439 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1440 int i = get_struct_member_index(get_entity_owner(ent), ent);
1441 ir_type *tp = get_entity_type(ent);
1442 ir_mode *mode = get_type_mode(tp);
1445 /* address for the backing store */
1446 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1449 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1451 /* the backing store itself */
1452 store = new_r_Store(irg, first_bl, mem, addr,
1453 new_r_Proj(irg, args_bl, args, mode, i));
1455 /* the new memory Proj gets the last Proj from store */
1456 set_Proj_pred(nmem, store);
1457 set_Proj_proj(nmem, pn_Store_M);
1459 /* move all entities to the frame type */
1460 frame_tp = get_irg_frame_type(irg);
1461 offset = get_type_size_bytes(frame_tp);
1462 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1463 ir_type *tp = get_entity_type(ent);
1464 int align = get_type_alignment_bytes(tp);
1466 offset += align - 1;
1468 set_entity_owner(ent, frame_tp);
1469 add_class_member(frame_tp, ent);
1470 /* must be automatic to set a fixed layout */
1471 set_entity_allocation(ent, allocation_automatic);
1472 set_entity_offset_bytes(ent, offset);
1473 offset += get_type_size_bytes(tp);
1475 set_type_size_bytes(frame_tp, offset);
1480 * Modify the irg itself and the frame type.
1482 static void modify_irg(be_abi_irg_t *env)
1484 be_abi_call_t *call = env->call;
1485 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1486 const arch_register_t *sp = arch_isa_sp(isa);
1487 ir_graph *irg = env->birg->irg;
1488 ir_node *bl = get_irg_start_block(irg);
1489 ir_node *end = get_irg_end_block(irg);
1490 ir_node *no_mem = get_irg_no_mem(irg);
1491 ir_node *mem = get_irg_initial_mem(irg);
1492 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1493 pset *dont_save = pset_new_ptr(8);
1499 const arch_register_t *fp_reg;
1500 ir_node *frame_pointer;
1502 ir_node *reg_params_bl;
1505 const ir_edge_t *edge;
1506 ir_type *arg_type, *bet_type;
1507 lower_frame_sels_env_t ctx;
1509 bitset_t *used_proj_nr;
1510 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1512 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1514 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1516 ctx.value_param_list = NULL;
1517 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1519 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1520 env->regs = pmap_create();
1522 used_proj_nr = bitset_alloca(1024);
1523 n_params = get_method_n_params(method_type);
1524 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1525 memset(args, 0, n_params * sizeof(args[0]));
1527 /* Check if a value parameter is transmitted as a register.
1528 * This might happen if the address of an parameter is taken which is
1529 * transmitted in registers.
1531 * Note that on some architectures this case must be handled specially
1532 * because the place of the backing store is determined by their ABI.
1534 * In the default case we move the entity to the frame type and create
1535 * a backing store into the first block.
1537 fix_address_of_parameter_access(env, ctx.value_param_list);
1539 /* Fill the argument vector */
1540 arg_tuple = get_irg_args(irg);
1541 foreach_out_edge(arg_tuple, edge) {
1542 ir_node *irn = get_edge_src_irn(edge);
1543 int nr = get_Proj_proj(irn);
1545 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1548 arg_type = compute_arg_type(env, call, method_type);
1549 bet_type = call->cb->get_between_type(env->cb);
1550 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir);
1552 /* Count the register params and add them to the number of Projs for the RegParams node */
1553 for(i = 0; i < n_params; ++i) {
1554 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1555 if(arg->in_reg && args[i]) {
1556 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1557 assert(i == get_Proj_proj(args[i]));
1559 /* For now, associate the register with the old Proj from Start representing that argument. */
1560 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1561 bitset_set(used_proj_nr, i);
1562 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1566 /* Collect all callee-save registers */
1567 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1568 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1569 for(j = 0; j < cls->n_regs; ++j) {
1570 const arch_register_t *reg = &cls->regs[j];
1571 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1572 pmap_insert(env->regs, (void *) reg, NULL);
1576 pmap_insert(env->regs, (void *) sp, NULL);
1577 pmap_insert(env->regs, (void *) isa->bp, NULL);
1578 reg_params_bl = get_irg_start_block(irg);
1579 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1582 * make proj nodes for the callee save registers.
1583 * memorize them, since Return nodes get those as inputs.
1585 * Note, that if a register corresponds to an argument, the regs map contains
1586 * the old Proj from start for that argument.
1589 rm = reg_map_to_arr(&env->obst, env->regs);
1590 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1591 arch_register_t *reg = (void *) rm[i].reg;
1592 ir_node *arg_proj = rm[i].irn;
1593 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1595 int pos = BE_OUT_POS((int) nr);
1601 bitset_set(used_proj_nr, nr);
1602 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1603 pmap_insert(env->regs, (void *) reg, proj);
1604 be_set_constr_single_reg(env->reg_params, pos, reg);
1605 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1608 * If the register is an ignore register,
1609 * The Proj for that register shall also be ignored during register allocation.
1611 if(arch_register_type_is(reg, ignore))
1612 flags |= arch_irn_flags_ignore;
1615 flags |= arch_irn_flags_modify_sp;
1617 be_node_set_flags(env->reg_params, pos, flags);
1619 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1621 obstack_free(&env->obst, rm);
1623 /* Generate the Prologue */
1624 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1626 /* do the stack allocation BEFORE the barrier, or spill code
1627 might be added before it */
1628 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1629 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1630 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1632 barrier = create_barrier(env, bl, &mem, env->regs, 0);
1634 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1635 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1637 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1638 set_irg_frame(irg, frame_pointer);
1639 pset_insert_ptr(env->ignore_regs, fp_reg);
1641 /* Now, introduce stack param nodes for all parameters passed on the stack */
1642 for(i = 0; i < n_params; ++i) {
1643 ir_node *arg_proj = args[i];
1644 ir_node *repl = NULL;
1646 if(arg_proj != NULL) {
1647 be_abi_call_arg_t *arg;
1648 ir_type *param_type;
1649 int nr = get_Proj_proj(arg_proj);
1651 nr = MIN(nr, n_params);
1652 arg = get_call_arg(call, 0, nr);
1653 param_type = get_method_param_type(method_type, nr);
1656 repl = pmap_get(env->regs, (void *) arg->reg);
1659 else if(arg->on_stack) {
1660 /* For atomic parameters which are actually used, we create a StackParam node. */
1661 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1662 ir_mode *mode = get_type_mode(param_type);
1663 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1664 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1667 /* The stack parameter is not primitive (it is a struct or array),
1668 we thus will create a node representing the parameter's address
1671 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1675 assert(repl != NULL);
1676 edges_reroute(args[i], repl, irg);
1680 /* All Return nodes hang on the End node, so look for them there. */
1681 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1682 ir_node *irn = get_Block_cfgpred(end, i);
1684 if (is_Return(irn)) {
1685 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1689 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1690 the code is dead and will never be executed. */
1692 del_pset(dont_save);
1693 obstack_free(&env->obst, args);
1697 * Walker: puts all Alloc(stack_alloc) on a obstack
1699 static void collect_alloca_walker(ir_node *irn, void *data)
1701 be_abi_irg_t *env = data;
1702 if(get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)
1703 obstack_ptr_grow(&env->obst, irn);
1706 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1708 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1709 ir_node *old_frame = get_irg_frame(birg->irg);
1710 ir_graph *irg = birg->irg;
1714 optimization_state_t state;
1716 obstack_init(&env->obst);
1718 env->isa = birg->main_env->arch_env->isa;
1719 env->method_type = get_entity_type(get_irg_entity(irg));
1720 env->call = be_abi_call_new();
1721 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1723 env->ignore_regs = pset_new_ptr_default();
1724 env->keep_map = pmap_create();
1725 env->dce_survivor = new_survive_dce();
1727 env->stack_phis = pset_new_ptr(16);
1728 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1729 to another Unknown or the stack pointer gets used */
1730 save_optimization_state(&state);
1732 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1733 restore_optimization_state(&state);
1734 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1736 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1737 env->irn_ops.impl = &abi_irn_ops;
1739 /* Lower all call nodes in the IRG. */
1743 Beware: init backend abi call object after processing calls,
1744 otherwise some information might be not yet available.
1746 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1748 /* Process the IRG */
1751 /* We don't need the keep map anymore. */
1752 pmap_destroy(env->keep_map);
1754 /* reroute the stack origin of the calls to the true stack origin. */
1755 edges_reroute(dummy, env->init_sp, irg);
1756 edges_reroute(old_frame, get_irg_frame(irg), irg);
1758 /* Make some important node pointers survive the dead node elimination. */
1759 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1760 pmap_foreach(env->regs, ent)
1761 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1763 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1765 env->call->cb->done(env->cb);
1769 void be_abi_free(be_abi_irg_t *env)
1771 free_survive_dce(env->dce_survivor);
1772 del_pset(env->stack_phis);
1773 del_pset(env->ignore_regs);
1774 pmap_destroy(env->regs);
1775 obstack_free(&env->obst, NULL);
1776 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1780 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1782 arch_register_t *reg;
1784 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1785 if(reg->reg_class == cls)
1786 bitset_set(bs, reg->index);
1793 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1794 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1795 | _| | |> < ___) | || (_| | (__| <
1796 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1800 struct fix_stack_walker_info {
1802 const arch_env_t *aenv;
1806 * Walker. Collect all stack modifying nodes.
1808 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1810 struct fix_stack_walker_info *info = data;
1815 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1816 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1817 pset_insert_ptr(info->nodes, irn);
1821 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1823 dom_front_info_t *df;
1824 pset *stack_nodes = pset_new_ptr(16);
1825 struct fix_stack_walker_info info;
1827 info.nodes = stack_nodes;
1828 info.aenv = env->birg->main_env->arch_env;
1830 /* We need dominance frontiers for fix up */
1831 df = be_compute_dominance_frontiers(env->birg->irg);
1832 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1833 pset_insert_ptr(stack_nodes, env->init_sp);
1834 be_ssa_constr_set_phis(df, lv, stack_nodes, env->stack_phis);
1835 del_pset(stack_nodes);
1837 /* free these dominance frontiers */
1838 be_free_dominance_frontiers(df);
1841 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1843 const arch_env_t *arch_env = env->birg->main_env->arch_env;
1844 int omit_fp = env->call->flags.bits.try_omit_fp;
1847 sched_foreach(bl, irn) {
1850 Check, if the node relates to an entity on the stack frame.
1851 If so, set the true offset (including the bias) for that
1854 entity *ent = arch_get_frame_entity(arch_env, irn);
1856 int offset = get_stack_entity_offset(env->frame, ent, bias);
1857 arch_set_frame_offset(arch_env, irn, offset);
1858 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
1862 If the node modifies the stack pointer by a constant offset,
1863 record that in the bias.
1865 if(arch_irn_is(arch_env, irn, modify_sp)) {
1866 int ofs = arch_get_sp_bias(arch_env, irn);
1868 if(be_is_IncSP(irn)) {
1869 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
1870 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1871 be_set_IncSP_offset(irn, ofs);
1872 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
1873 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1874 be_set_IncSP_offset(irn, ofs);
1887 * A helper struct for the bias walker.
1890 be_abi_irg_t *env; /**< The ABI irg environment. */
1891 int start_block_bias; /**< The bias at the end of the start block. */
1892 ir_node *start_block; /**< The start block of the current graph. */
1896 * Block-Walker: fix all stack offsets
1898 static void stack_bias_walker(ir_node *bl, void *data)
1900 struct bias_walk *bw = data;
1901 if (bl != bw->start_block) {
1902 process_stack_bias(bw->env, bl, bw->start_block_bias);
1906 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1908 ir_graph *irg = env->birg->irg;
1909 struct bias_walk bw;
1911 stack_frame_compute_initial_offset(env->frame);
1912 // stack_layout_dump(stdout, env->frame);
1914 /* Determine the stack bias at the end of the start block. */
1915 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1917 /* fix the bias is all other blocks */
1919 bw.start_block = get_irg_start_block(irg);
1920 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1923 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1925 assert(arch_register_type_is(reg, callee_save));
1926 assert(pmap_contains(abi->regs, (void *) reg));
1927 return pmap_get(abi->regs, (void *) reg);
1931 _____ _____ _ _ _ _ _ _
1932 |_ _| __ \| \ | | | | | | | | |
1933 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
1934 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
1935 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
1936 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
1938 for Phi nodes which are created due to stack modifying nodes
1939 such as IncSP, AddSP and SetSP.
1941 These Phis are always to be ignored by the reg alloc and are
1942 fixed on the SP register of the ISA.
1945 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
1947 const be_abi_irg_t *abi = get_abi_from_handler(handler);
1948 const void *res = NULL;
1950 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
1951 res = &abi->irn_ops;
1956 static void be_abi_limited(void *data, bitset_t *bs)
1958 be_abi_irg_t *abi = data;
1959 bitset_clear_all(bs);
1960 bitset_set(bs, abi->isa->sp->index);
1963 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)
1965 be_abi_irg_t *abi = get_abi_from_ops(self);
1966 const arch_register_t *reg = abi->isa->sp;
1968 memset(req, 0, sizeof(req[0]));
1970 if(pos == BE_OUT_POS(0)) {
1971 req->cls = reg->reg_class;
1972 req->type = arch_register_req_type_limited;
1973 req->limited = be_abi_limited;
1974 req->limited_env = abi;
1977 else if(pos >= 0 && pos < get_irn_arity(irn)) {
1978 req->cls = reg->reg_class;
1979 req->type = arch_register_req_type_normal;
1985 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
1989 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
1991 const be_abi_irg_t *abi = get_abi_from_ops(self);
1992 return abi->isa->sp;
1995 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
1997 return arch_irn_class_normal;
2000 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2002 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2005 static entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2010 static void abi_set_frame_entity(const void *_self, ir_node *irn, entity *ent)
2014 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2018 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2023 static const arch_irn_ops_if_t abi_irn_ops = {
2024 abi_get_irn_reg_req,
2029 abi_get_frame_entity,
2030 abi_set_frame_entity,
2031 abi_set_frame_offset,
2033 NULL, /* get_inverse */
2034 NULL, /* get_op_estimated_cost */
2035 NULL, /* possible_memory_operand */
2036 NULL, /* perform_memory_operand */
2039 static const arch_irn_handler_t abi_irn_handler = {