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);
699 keep_alive(mem_proj);
702 /* Clean up the stack frame if we allocated it */
704 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
705 add_irn_dep(curr_sp, mem_proj);
707 add_irn_dep(curr_sp, alloca_copy);
713 be_abi_call_free(call);
714 obstack_free(obst, pos);
716 del_pset(caller_save);
723 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
725 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp, ir_node **result_copy)
727 if (get_Alloc_where(alloc) == stack_alloc) {
728 ir_node *bl = get_nodes_block(alloc);
729 ir_graph *irg = get_irn_irg(bl);
730 ir_node *alloc_mem = NULL;
731 ir_node *alloc_res = NULL;
733 const ir_edge_t *edge;
738 foreach_out_edge(alloc, edge) {
739 ir_node *irn = get_edge_src_irn(edge);
741 assert(is_Proj(irn));
742 switch(get_Proj_proj(irn)) {
754 /* Beware: currently Alloc nodes without a result might happen,
755 only escape analysis kills them and this phase runs only for object
756 oriented source. We kill the Alloc here. */
757 if (alloc_res == NULL && alloc_mem) {
758 exchange(alloc_mem, get_Alloc_mem(alloc));
762 /* The stack pointer will be modified in an unknown manner.
763 We cannot omit it. */
764 env->call->flags.bits.try_omit_fp = 0;
765 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
767 exchange(alloc, new_alloc);
769 if(alloc_mem != NULL)
770 set_Proj_proj(alloc_mem, pn_be_AddSP_M);
772 /* fix projnum of alloca res */
773 set_Proj_proj(alloc_res, pn_be_AddSP_res);
775 addr = env->isa->stack_dir < 0 ? alloc_res : curr_sp;
777 /* copy the address away, since it could be used after further stack pointer modifications. */
778 /* Let it point curr_sp just for the moment, I'll reroute it in a second. */
779 *result_copy = copy = be_new_Copy(env->isa->sp->reg_class, irg, bl, curr_sp);
781 /* Let all users of the Alloc() result now point to the copy. */
782 edges_reroute(alloc_res, copy, irg);
784 /* Rewire the copy appropriately. */
785 set_irn_n(copy, be_pos_Copy_op, addr);
793 /* the following function is replaced by the usage of the heights module */
796 * Walker for dependent_on().
797 * This function searches a node tgt recursively from a given node
798 * but is restricted to the given block.
799 * @return 1 if tgt was reachable from curr, 0 if not.
801 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
805 if (get_nodes_block(curr) != bl)
811 /* Phi functions stop the recursion inside a basic block */
812 if (! is_Phi(curr)) {
813 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
814 if (check_dependence(get_irn_n(curr, i), tgt, bl))
824 * Check if a node is somehow data dependent on another one.
825 * both nodes must be in the same basic block.
826 * @param n1 The first node.
827 * @param n2 The second node.
828 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
830 static int dependent_on(ir_node *n1, ir_node *n2)
832 ir_node *bl = get_nodes_block(n1);
834 assert(bl == get_nodes_block(n2));
836 return heights_reachable_in_block(ir_heights, n1, n2);
837 //return check_dependence(n1, n2, bl);
840 static int cmp_call_dependecy(const void *c1, const void *c2)
842 ir_node *n1 = *(ir_node **) c1;
843 ir_node *n2 = *(ir_node **) c2;
846 Classical qsort() comparison function behavior:
847 0 if both elements are equal
848 1 if second is "smaller" that first
849 -1 if first is "smaller" that second
851 if (dependent_on(n1, n2))
854 if (dependent_on(n2, n1))
861 * Walker: links all Call nodes to the Block they are contained.
863 static void link_calls_in_block_walker(ir_node *irn, void *data)
865 if(is_Call(irn) || (get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)) {
866 be_abi_irg_t *env = data;
867 ir_node *bl = get_nodes_block(irn);
868 void *save = get_irn_link(bl);
871 env->call->flags.bits.irg_is_leaf = 0;
873 set_irn_link(irn, save);
874 set_irn_link(bl, irn);
880 * Process all Call nodes inside a basic block.
881 * Note that the link field of the block must contain a linked list of all
882 * Call nodes inside the Block. We first order this list according to data dependency
883 * and that connect the calls together.
885 static void process_calls_in_block(ir_node *bl, void *data)
887 be_abi_irg_t *env = data;
888 ir_node *curr_sp = env->init_sp;
892 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
893 obstack_ptr_grow(&env->obst, irn);
895 /* If there were call nodes in the block. */
899 ir_node *copy = NULL;
902 nodes = obstack_finish(&env->obst);
904 /* order the call nodes according to data dependency */
905 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
907 for(i = n - 1; i >= 0; --i) {
908 ir_node *irn = nodes[i];
910 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
911 switch(get_irn_opcode(irn)) {
913 curr_sp = adjust_call(env, irn, curr_sp, copy);
916 curr_sp = adjust_alloc(env, irn, curr_sp, ©);
923 obstack_free(&env->obst, nodes);
925 /* Keep the last stack state in the block by tying it to Keep node */
927 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
928 pmap_insert(env->keep_map, bl, keep);
931 set_irn_link(bl, curr_sp);
935 * Adjust all call nodes in the graph to the ABI conventions.
937 static void process_calls(be_abi_irg_t *env)
939 ir_graph *irg = env->birg->irg;
941 env->call->flags.bits.irg_is_leaf = 1;
942 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
944 ir_heights = heights_new(env->birg->irg);
945 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
946 heights_free(ir_heights);
949 static void collect_return_walker(ir_node *irn, void *data)
951 if(get_irn_opcode(irn) == iro_Return) {
952 struct obstack *obst = data;
953 obstack_ptr_grow(obst, irn);
958 static ir_node *setup_frame(be_abi_irg_t *env)
960 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
961 const arch_register_t *sp = isa->sp;
962 const arch_register_t *bp = isa->bp;
963 be_abi_call_flags_bits_t flags = env->call->flags.bits;
964 ir_graph *irg = env->birg->irg;
965 ir_node *bl = get_irg_start_block(irg);
966 ir_node *no_mem = get_irg_no_mem(irg);
967 ir_node *old_frame = get_irg_frame(irg);
968 ir_node *stack = pmap_get(env->regs, (void *) sp);
969 ir_node *frame = pmap_get(env->regs, (void *) bp);
971 int stack_nr = get_Proj_proj(stack);
973 if(flags.try_omit_fp) {
974 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE_EXPAND);
979 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
981 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
983 be_set_constr_single_reg(frame, -1, bp);
984 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
985 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
988 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE_EXPAND);
991 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
992 env->init_sp = stack;
993 set_irg_frame(irg, frame);
994 edges_reroute(old_frame, frame, irg);
999 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
1001 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1002 const arch_register_t *sp = isa->sp;
1003 const arch_register_t *bp = isa->bp;
1004 ir_graph *irg = env->birg->irg;
1005 ir_node *ret_mem = get_Return_mem(ret);
1006 ir_node *frame = get_irg_frame(irg);
1007 ir_node *bl = get_nodes_block(ret);
1008 ir_node *stack = get_irn_link(bl);
1012 if(env->call->flags.bits.try_omit_fp) {
1013 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, -BE_STACK_FRAME_SIZE_SHRINK);
1017 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
1018 be_set_constr_single_reg(stack, -1, sp);
1019 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
1022 pmap_foreach(env->regs, ent) {
1023 const arch_register_t *reg = ent->key;
1024 ir_node *irn = ent->value;
1027 obstack_ptr_grow(&env->obst, stack);
1029 obstack_ptr_grow(&env->obst, frame);
1030 else if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1031 obstack_ptr_grow(obst, irn);
1038 * Computes the stack argument layout type.
1039 * Changes a possibly allocated value param type by moving
1040 * entities to the stack layout type.
1042 * @param env the ABI environment
1043 * @param call the current call ABI
1044 * @param method_type the method type
1046 * @return the stack argument layout type
1048 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type)
1050 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1051 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1052 int n = get_method_n_params(method_type);
1053 int curr = inc > 0 ? 0 : n - 1;
1059 ir_type *val_param_tp = get_method_value_param_type(method_type);
1060 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1062 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1063 for (i = 0; i < n; ++i, curr += inc) {
1064 ir_type *param_type = get_method_param_type(method_type, curr);
1065 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1067 if (arg->on_stack) {
1069 /* the entity was already created, move it to the param type */
1070 arg->stack_ent = get_method_value_param_ent(method_type, i);
1071 remove_struct_member(val_param_tp, arg->stack_ent);
1072 set_entity_owner(arg->stack_ent, res);
1073 add_struct_member(res, arg->stack_ent);
1074 /* must be automatic to set a fixed layout */
1075 set_entity_allocation(arg->stack_ent, allocation_automatic);
1078 snprintf(buf, sizeof(buf), "param_%d", i);
1079 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1081 ofs += arg->space_before;
1082 ofs = round_up2(ofs, arg->alignment);
1083 set_entity_offset_bytes(arg->stack_ent, ofs);
1084 ofs += arg->space_after;
1085 ofs += get_type_size_bytes(param_type);
1088 set_type_size_bytes(res, ofs);
1089 set_type_state(res, layout_fixed);
1093 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1096 struct obstack obst;
1098 obstack_init(&obst);
1100 /* Create a Perm after the RegParams node to delimit it. */
1101 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1102 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1107 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1108 const arch_register_t *reg = &cls->regs[j];
1109 ir_node *irn = pmap_get(regs, (void *) reg);
1111 if(irn && !arch_register_type_is(reg, ignore)) {
1113 obstack_ptr_grow(&obst, irn);
1114 set_irn_link(irn, (void *) reg);
1118 obstack_ptr_grow(&obst, NULL);
1119 in = obstack_finish(&obst);
1121 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1122 for(j = 0; j < n_regs; ++j) {
1123 ir_node *arg = in[j];
1124 arch_register_t *reg = get_irn_link(arg);
1125 pmap_insert(regs, reg, arg);
1126 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1129 obstack_free(&obst, in);
1132 obstack_free(&obst, NULL);
1136 const arch_register_t *reg;
1140 static int cmp_regs(const void *a, const void *b)
1142 const reg_node_map_t *p = a;
1143 const reg_node_map_t *q = b;
1145 if(p->reg->reg_class == q->reg->reg_class)
1146 return p->reg->index - q->reg->index;
1148 return p->reg->reg_class - q->reg->reg_class;
1151 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1154 int n = pmap_count(reg_map);
1156 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1158 pmap_foreach(reg_map, ent) {
1159 res[i].reg = ent->key;
1160 res[i].irn = ent->value;
1164 qsort(res, n, sizeof(res[0]), cmp_regs);
1169 * Creates a barrier.
1171 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1173 ir_graph *irg = env->birg->irg;
1174 int n_regs = pmap_count(regs);
1180 rm = reg_map_to_arr(&env->obst, regs);
1182 for(n = 0; n < n_regs; ++n)
1183 obstack_ptr_grow(&env->obst, rm[n].irn);
1186 obstack_ptr_grow(&env->obst, *mem);
1190 in = (ir_node **) obstack_finish(&env->obst);
1191 irn = be_new_Barrier(irg, bl, n, in);
1192 obstack_free(&env->obst, in);
1194 for(n = 0; n < n_regs; ++n) {
1195 const arch_register_t *reg = rm[n].reg;
1197 int pos = BE_OUT_POS(n);
1200 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1201 be_node_set_reg_class(irn, n, reg->reg_class);
1203 be_set_constr_single_reg(irn, n, reg);
1204 be_set_constr_single_reg(irn, pos, reg);
1205 be_node_set_reg_class(irn, pos, reg->reg_class);
1206 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1208 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1209 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1210 flags |= arch_irn_flags_ignore;
1212 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1213 flags |= arch_irn_flags_modify_sp;
1215 be_node_set_flags(irn, pos, flags);
1217 pmap_insert(regs, (void *) reg, proj);
1221 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1224 obstack_free(&env->obst, rm);
1229 * Creates a be_Return for a Return node.
1231 * @param @env the abi environment
1232 * @param irn the Return node or NULL if there was none
1233 * @param bl the block where the be_Retun should be placed
1234 * @param mem the current memory
1235 * @param n_res number of return results
1237 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl, ir_node *mem, int n_res) {
1238 be_abi_call_t *call = env->call;
1239 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1241 pmap *reg_map = pmap_create();
1242 ir_node *keep = pmap_get(env->keep_map, bl);
1248 const arch_register_t **regs;
1252 get the valid stack node in this block.
1253 If we had a call in that block there is a Keep constructed by process_calls()
1254 which points to the last stack modification in that block. we'll use
1255 it then. Else we use the stack from the start block and let
1256 the ssa construction fix the usage.
1258 stack = be_abi_reg_map_get(env->regs, isa->sp);
1260 ir_node *bad = new_r_Bad(env->birg->irg);
1261 stack = get_irn_n(keep, 0);
1262 set_nodes_block(keep, bad);
1263 set_irn_n(keep, 0, bad);
1264 // exchange(keep, new_r_Bad(env->birg->irg));
1267 /* Insert results for Return into the register map. */
1268 for(i = 0; i < n_res; ++i) {
1269 ir_node *res = get_Return_res(irn, i);
1270 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1271 assert(arg->in_reg && "return value must be passed in register");
1272 pmap_insert(reg_map, (void *) arg->reg, res);
1275 /* Add uses of the callee save registers. */
1276 pmap_foreach(env->regs, ent) {
1277 const arch_register_t *reg = ent->key;
1278 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1279 pmap_insert(reg_map, ent->key, ent->value);
1282 be_abi_reg_map_set(reg_map, isa->sp, stack);
1284 /* Make the Epilogue node and call the arch's epilogue maker. */
1285 create_barrier(env, bl, &mem, reg_map, 1);
1286 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1289 Maximum size of the in array for Return nodes is
1290 return args + callee save/ignore registers + memory + stack pointer
1292 in_max = pmap_count(reg_map) + n_res + 2;
1294 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1295 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1298 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1303 /* clear SP entry, since it has already been grown. */
1304 pmap_insert(reg_map, (void *) isa->sp, NULL);
1305 for(i = 0; i < n_res; ++i) {
1306 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1308 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1309 regs[n++] = arg->reg;
1311 /* Clear the map entry to mark the register as processed. */
1312 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1315 /* grow the rest of the stuff. */
1316 pmap_foreach(reg_map, ent) {
1319 regs[n++] = ent->key;
1323 /* The in array for the new back end return is now ready. */
1324 ret = be_new_Return(irn ? get_irn_dbg_info(irn) : NULL, env->birg->irg, bl, n_res, n, in);
1326 /* Set the register classes of the return's parameter accordingly. */
1327 for(i = 0; i < n; ++i)
1329 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1331 /* Free the space of the Epilog's in array and the register <-> proj map. */
1332 obstack_free(&env->obst, in);
1333 pmap_destroy(reg_map);
1338 typedef struct lower_frame_sels_env_t {
1340 entity *value_param_list; /**< the list of all value param antities */
1341 } lower_frame_sels_env_t;
1344 * Walker: Replaces Sels of frame type and
1345 * value param type entities by FrameAddress.
1347 static void lower_frame_sels_walker(ir_node *irn, void *data)
1349 lower_frame_sels_env_t *ctx = data;
1352 ir_graph *irg = current_ir_graph;
1353 ir_node *frame = get_irg_frame(irg);
1354 ir_node *param_base = get_irg_value_param_base(irg);
1355 ir_node *ptr = get_Sel_ptr(irn);
1357 if (ptr == frame || ptr == param_base) {
1358 be_abi_irg_t *env = ctx->env;
1359 entity *ent = get_Sel_entity(irn);
1360 ir_node *bl = get_nodes_block(irn);
1363 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1366 if (ptr == param_base) {
1367 set_entity_link(ent, ctx->value_param_list);
1368 ctx->value_param_list = ent;
1375 * Check if a value parameter is transmitted as a register.
1376 * This might happen if the address of an parameter is taken which is
1377 * transmitted in registers.
1379 * Note that on some architectures this case must be handled specially
1380 * because the place of the backing store is determined by their ABI.
1382 * In the default case we move the entity to the frame type and create
1383 * a backing store into the first block.
1385 static void fix_address_of_parameter_access(be_abi_irg_t *env, entity *value_param_list) {
1386 be_abi_call_t *call = env->call;
1387 ir_graph *irg = env->birg->irg;
1388 entity *ent, *next_ent, *new_list;
1390 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1393 for (ent = value_param_list; ent; ent = next_ent) {
1394 int i = get_struct_member_index(get_entity_owner(ent), ent);
1395 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1397 next_ent = get_entity_link(ent);
1399 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1400 set_entity_link(ent, new_list);
1405 /* ok, change the graph */
1406 ir_node *start_bl = get_irg_start_block(irg);
1407 ir_node *first_bl = NULL;
1408 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1409 const ir_edge_t *edge;
1410 optimization_state_t state;
1413 foreach_block_succ(start_bl, edge) {
1414 ir_node *succ = get_edge_src_irn(edge);
1415 if (start_bl != succ) {
1421 /* we had already removed critical edges, so the following
1422 assertion should be always true. */
1423 assert(get_Block_n_cfgpreds(first_bl) == 1);
1425 /* now create backing stores */
1426 frame = get_irg_frame(irg);
1427 imem = get_irg_initial_mem(irg);
1429 save_optimization_state(&state);
1431 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1432 restore_optimization_state(&state);
1434 /* reroute all edges to the new memory source */
1435 edges_reroute(imem, nmem, irg);
1439 args = get_irg_args(irg);
1440 args_bl = get_nodes_block(args);
1441 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1442 int i = get_struct_member_index(get_entity_owner(ent), ent);
1443 ir_type *tp = get_entity_type(ent);
1444 ir_mode *mode = get_type_mode(tp);
1447 /* address for the backing store */
1448 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1451 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1453 /* the backing store itself */
1454 store = new_r_Store(irg, first_bl, mem, addr,
1455 new_r_Proj(irg, args_bl, args, mode, i));
1457 /* the new memory Proj gets the last Proj from store */
1458 set_Proj_pred(nmem, store);
1459 set_Proj_proj(nmem, pn_Store_M);
1461 /* move all entities to the frame type */
1462 frame_tp = get_irg_frame_type(irg);
1463 offset = get_type_size_bytes(frame_tp);
1464 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1465 ir_type *tp = get_entity_type(ent);
1466 int align = get_type_alignment_bytes(tp);
1468 offset += align - 1;
1470 set_entity_owner(ent, frame_tp);
1471 add_class_member(frame_tp, ent);
1472 /* must be automatic to set a fixed layout */
1473 set_entity_allocation(ent, allocation_automatic);
1474 set_entity_offset_bytes(ent, offset);
1475 offset += get_type_size_bytes(tp);
1477 set_type_size_bytes(frame_tp, offset);
1482 * Modify the irg itself and the frame type.
1484 static void modify_irg(be_abi_irg_t *env)
1486 be_abi_call_t *call = env->call;
1487 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1488 const arch_register_t *sp = arch_isa_sp(isa);
1489 ir_graph *irg = env->birg->irg;
1490 ir_node *bl = get_irg_start_block(irg);
1491 ir_node *end = get_irg_end_block(irg);
1492 ir_node *no_mem = get_irg_no_mem(irg);
1493 ir_node *mem = get_irg_initial_mem(irg);
1494 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1495 pset *dont_save = pset_new_ptr(8);
1501 const arch_register_t *fp_reg;
1502 ir_node *frame_pointer;
1504 ir_node *reg_params_bl;
1507 const ir_edge_t *edge;
1508 ir_type *arg_type, *bet_type;
1509 lower_frame_sels_env_t ctx;
1511 bitset_t *used_proj_nr;
1512 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1514 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1516 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1518 ctx.value_param_list = NULL;
1519 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1521 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1522 env->regs = pmap_create();
1524 used_proj_nr = bitset_alloca(1024);
1525 n_params = get_method_n_params(method_type);
1526 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1527 memset(args, 0, n_params * sizeof(args[0]));
1529 /* Check if a value parameter is transmitted as a register.
1530 * This might happen if the address of an parameter is taken which is
1531 * transmitted in registers.
1533 * Note that on some architectures this case must be handled specially
1534 * because the place of the backing store is determined by their ABI.
1536 * In the default case we move the entity to the frame type and create
1537 * a backing store into the first block.
1539 fix_address_of_parameter_access(env, ctx.value_param_list);
1541 /* Fill the argument vector */
1542 arg_tuple = get_irg_args(irg);
1543 foreach_out_edge(arg_tuple, edge) {
1544 ir_node *irn = get_edge_src_irn(edge);
1545 int nr = get_Proj_proj(irn);
1547 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1550 arg_type = compute_arg_type(env, call, method_type);
1551 bet_type = call->cb->get_between_type(env->cb);
1552 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir);
1554 /* Count the register params and add them to the number of Projs for the RegParams node */
1555 for(i = 0; i < n_params; ++i) {
1556 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1557 if(arg->in_reg && args[i]) {
1558 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1559 assert(i == get_Proj_proj(args[i]));
1561 /* For now, associate the register with the old Proj from Start representing that argument. */
1562 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1563 bitset_set(used_proj_nr, i);
1564 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1568 /* Collect all callee-save registers */
1569 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1570 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1571 for(j = 0; j < cls->n_regs; ++j) {
1572 const arch_register_t *reg = &cls->regs[j];
1573 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1574 pmap_insert(env->regs, (void *) reg, NULL);
1578 pmap_insert(env->regs, (void *) sp, NULL);
1579 pmap_insert(env->regs, (void *) isa->bp, NULL);
1580 reg_params_bl = get_irg_start_block(irg);
1581 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1584 * make proj nodes for the callee save registers.
1585 * memorize them, since Return nodes get those as inputs.
1587 * Note, that if a register corresponds to an argument, the regs map contains
1588 * the old Proj from start for that argument.
1591 rm = reg_map_to_arr(&env->obst, env->regs);
1592 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1593 arch_register_t *reg = (void *) rm[i].reg;
1594 ir_node *arg_proj = rm[i].irn;
1595 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1597 int pos = BE_OUT_POS((int) nr);
1603 bitset_set(used_proj_nr, nr);
1604 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1605 pmap_insert(env->regs, (void *) reg, proj);
1606 be_set_constr_single_reg(env->reg_params, pos, reg);
1607 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1610 * If the register is an ignore register,
1611 * The Proj for that register shall also be ignored during register allocation.
1613 if(arch_register_type_is(reg, ignore))
1614 flags |= arch_irn_flags_ignore;
1617 flags |= arch_irn_flags_modify_sp;
1619 be_node_set_flags(env->reg_params, pos, flags);
1621 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1623 obstack_free(&env->obst, rm);
1625 /* Generate the Prologue */
1626 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1628 /* do the stack allocation BEFORE the barrier, or spill code
1629 might be added before it */
1630 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1631 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1632 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1634 barrier = create_barrier(env, bl, &mem, env->regs, 0);
1636 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1637 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1639 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1640 set_irg_frame(irg, frame_pointer);
1641 pset_insert_ptr(env->ignore_regs, fp_reg);
1643 /* Now, introduce stack param nodes for all parameters passed on the stack */
1644 for(i = 0; i < n_params; ++i) {
1645 ir_node *arg_proj = args[i];
1646 ir_node *repl = NULL;
1648 if(arg_proj != NULL) {
1649 be_abi_call_arg_t *arg;
1650 ir_type *param_type;
1651 int nr = get_Proj_proj(arg_proj);
1653 nr = MIN(nr, n_params);
1654 arg = get_call_arg(call, 0, nr);
1655 param_type = get_method_param_type(method_type, nr);
1658 repl = pmap_get(env->regs, (void *) arg->reg);
1661 else if(arg->on_stack) {
1662 /* For atomic parameters which are actually used, we create a StackParam node. */
1663 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1664 ir_mode *mode = get_type_mode(param_type);
1665 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1666 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1669 /* The stack parameter is not primitive (it is a struct or array),
1670 we thus will create a node representing the parameter's address
1673 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1677 assert(repl != NULL);
1678 edges_reroute(args[i], repl, irg);
1682 /* All Return nodes hang on the End node, so look for them there. */
1683 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1684 ir_node *irn = get_Block_cfgpred(end, i);
1686 if (is_Return(irn)) {
1687 ir_node *ret = create_be_return(env, irn, get_nodes_block(irn), get_Return_mem(irn), get_Return_n_ress(irn));
1691 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return than,
1692 the code is dead and will never be executed. */
1694 del_pset(dont_save);
1695 obstack_free(&env->obst, args);
1699 * Walker: puts all Alloc(stack_alloc) on a obstack
1701 static void collect_alloca_walker(ir_node *irn, void *data)
1703 be_abi_irg_t *env = data;
1704 if(get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)
1705 obstack_ptr_grow(&env->obst, irn);
1708 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1710 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1711 ir_node *old_frame = get_irg_frame(birg->irg);
1712 ir_graph *irg = birg->irg;
1716 optimization_state_t state;
1718 obstack_init(&env->obst);
1720 env->isa = birg->main_env->arch_env->isa;
1721 env->method_type = get_entity_type(get_irg_entity(irg));
1722 env->call = be_abi_call_new();
1723 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1725 env->ignore_regs = pset_new_ptr_default();
1726 env->keep_map = pmap_create();
1727 env->dce_survivor = new_survive_dce();
1729 env->stack_phis = pset_new_ptr(16);
1730 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
1731 to another Unknown or the stack pointer gets used */
1732 save_optimization_state(&state);
1734 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1735 restore_optimization_state(&state);
1736 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
1738 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1739 env->irn_ops.impl = &abi_irn_ops;
1741 /* Lower all call nodes in the IRG. */
1745 Beware: init backend abi call object after processing calls,
1746 otherwise some information might be not yet available.
1748 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
1750 /* Process the IRG */
1753 /* We don't need the keep map anymore. */
1754 pmap_destroy(env->keep_map);
1756 /* reroute the stack origin of the calls to the true stack origin. */
1757 edges_reroute(dummy, env->init_sp, irg);
1758 edges_reroute(old_frame, get_irg_frame(irg), irg);
1760 /* Make some important node pointers survive the dead node elimination. */
1761 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1762 pmap_foreach(env->regs, ent)
1763 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1765 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1767 env->call->cb->done(env->cb);
1771 void be_abi_free(be_abi_irg_t *env)
1773 free_survive_dce(env->dce_survivor);
1774 del_pset(env->stack_phis);
1775 del_pset(env->ignore_regs);
1776 pmap_destroy(env->regs);
1777 obstack_free(&env->obst, NULL);
1778 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1782 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
1784 arch_register_t *reg;
1786 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
1787 if(reg->reg_class == cls)
1788 bitset_set(bs, reg->index);
1795 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1796 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1797 | _| | |> < ___) | || (_| | (__| <
1798 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1802 struct fix_stack_walker_info {
1804 const arch_env_t *aenv;
1808 * Walker. Collect all stack modifying nodes.
1810 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1812 struct fix_stack_walker_info *info = data;
1817 if (arch_irn_is(info->aenv, irn, modify_sp)) {
1818 assert(get_irn_mode(irn) != mode_M && get_irn_mode(irn) != mode_T);
1819 pset_insert_ptr(info->nodes, irn);
1823 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv)
1825 dom_front_info_t *df;
1826 pset *stack_nodes = pset_new_ptr(16);
1827 struct fix_stack_walker_info info;
1829 info.nodes = stack_nodes;
1830 info.aenv = env->birg->main_env->arch_env;
1832 /* We need dominance frontiers for fix up */
1833 df = be_compute_dominance_frontiers(env->birg->irg);
1834 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, &info);
1835 pset_insert_ptr(stack_nodes, env->init_sp);
1836 be_ssa_constr_set_phis(df, lv, stack_nodes, env->stack_phis);
1837 del_pset(stack_nodes);
1839 /* free these dominance frontiers */
1840 be_free_dominance_frontiers(df);
1843 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1845 const arch_env_t *arch_env = env->birg->main_env->arch_env;
1846 int omit_fp = env->call->flags.bits.try_omit_fp;
1849 sched_foreach(bl, irn) {
1852 Check, if the node relates to an entity on the stack frame.
1853 If so, set the true offset (including the bias) for that
1856 entity *ent = arch_get_frame_entity(arch_env, irn);
1858 int offset = get_stack_entity_offset(env->frame, ent, bias);
1859 arch_set_frame_offset(arch_env, irn, offset);
1860 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
1864 If the node modifies the stack pointer by a constant offset,
1865 record that in the bias.
1867 if(arch_irn_is(arch_env, irn, modify_sp)) {
1868 int ofs = arch_get_sp_bias(arch_env, irn);
1870 if(be_is_IncSP(irn)) {
1871 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
1872 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1873 be_set_IncSP_offset(irn, ofs);
1874 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
1875 ofs = - get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1876 be_set_IncSP_offset(irn, ofs);
1889 * A helper struct for the bias walker.
1892 be_abi_irg_t *env; /**< The ABI irg environment. */
1893 int start_block_bias; /**< The bias at the end of the start block. */
1894 ir_node *start_block; /**< The start block of the current graph. */
1898 * Block-Walker: fix all stack offsets
1900 static void stack_bias_walker(ir_node *bl, void *data)
1902 struct bias_walk *bw = data;
1903 if (bl != bw->start_block) {
1904 process_stack_bias(bw->env, bl, bw->start_block_bias);
1908 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1910 ir_graph *irg = env->birg->irg;
1911 struct bias_walk bw;
1913 stack_frame_compute_initial_offset(env->frame);
1914 // stack_layout_dump(stdout, env->frame);
1916 /* Determine the stack bias at the end of the start block. */
1917 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1919 /* fix the bias is all other blocks */
1921 bw.start_block = get_irg_start_block(irg);
1922 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1925 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1927 assert(arch_register_type_is(reg, callee_save));
1928 assert(pmap_contains(abi->regs, (void *) reg));
1929 return pmap_get(abi->regs, (void *) reg);
1933 _____ _____ _ _ _ _ _ _
1934 |_ _| __ \| \ | | | | | | | | |
1935 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
1936 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
1937 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
1938 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
1940 for Phi nodes which are created due to stack modifying nodes
1941 such as IncSP, AddSP and SetSP.
1943 These Phis are always to be ignored by the reg alloc and are
1944 fixed on the SP register of the ISA.
1947 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
1949 const be_abi_irg_t *abi = get_abi_from_handler(handler);
1950 const void *res = NULL;
1952 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
1953 res = &abi->irn_ops;
1958 static void be_abi_limited(void *data, bitset_t *bs)
1960 be_abi_irg_t *abi = data;
1961 bitset_clear_all(bs);
1962 bitset_set(bs, abi->isa->sp->index);
1965 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)
1967 be_abi_irg_t *abi = get_abi_from_ops(self);
1968 const arch_register_t *reg = abi->isa->sp;
1970 memset(req, 0, sizeof(req[0]));
1972 if(pos == BE_OUT_POS(0)) {
1973 req->cls = reg->reg_class;
1974 req->type = arch_register_req_type_limited;
1975 req->limited = be_abi_limited;
1976 req->limited_env = abi;
1979 else if(pos >= 0 && pos < get_irn_arity(irn)) {
1980 req->cls = reg->reg_class;
1981 req->type = arch_register_req_type_normal;
1987 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
1991 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
1993 const be_abi_irg_t *abi = get_abi_from_ops(self);
1994 return abi->isa->sp;
1997 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
1999 return arch_irn_class_normal;
2002 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
2004 return arch_irn_flags_ignore | arch_irn_flags_modify_sp;
2007 static entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
2012 static void abi_set_frame_entity(const void *_self, ir_node *irn, entity *ent)
2016 static void abi_set_frame_offset(const void *_self, ir_node *irn, int bias)
2020 static int abi_get_sp_bias(const void *self, const ir_node *irn)
2025 static const arch_irn_ops_if_t abi_irn_ops = {
2026 abi_get_irn_reg_req,
2031 abi_get_frame_entity,
2032 abi_set_frame_entity,
2033 abi_set_frame_offset,
2035 NULL, /* get_inverse */
2036 NULL, /* get_op_estimated_cost */
2037 NULL, /* possible_memory_operand */
2038 NULL, /* perform_memory_operand */
2041 static const arch_irn_handler_t abi_irn_handler = {