2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Backend ABI implementation.
23 * @author Sebastian Hack, Michael Beck
35 #include "irgraph_t.h"
38 #include "iredges_t.h"
41 #include "irprintf_t.h"
47 #include "raw_bitset.h"
55 #include "besched_t.h"
57 #include "bessaconstr.h"
59 typedef struct _be_abi_call_arg_t {
60 unsigned is_res : 1; /**< 1: the call argument is a return value. 0: it's a call parameter. */
61 unsigned in_reg : 1; /**< 1: this argument is transmitted in registers. */
62 unsigned on_stack : 1; /**< 1: this argument is transmitted on the stack. */
65 const arch_register_t *reg;
68 unsigned alignment; /**< stack alignment */
69 unsigned space_before; /**< allocate space before */
70 unsigned space_after; /**< allocate space after */
73 struct _be_abi_call_t {
74 be_abi_call_flags_t flags;
76 const be_abi_callbacks_t *cb;
77 ir_type *between_type;
79 const arch_register_class_t *cls_addr;
82 struct _be_abi_irg_t {
84 be_stack_layout_t *frame; /**< The stack frame model. */
85 be_irg_t *birg; /**< The back end IRG. */
86 const arch_isa_t *isa; /**< The isa. */
87 survive_dce_t *dce_survivor;
89 be_abi_call_t *call; /**< The ABI call information. */
90 ir_type *method_type; /**< The type of the method of the IRG. */
92 ir_node *init_sp; /**< The node representing the stack pointer
93 at the start of the function. */
95 ir_node *reg_params; /**< The reg params node. */
96 pmap *regs; /**< A map of all callee-save and ignore regs to
97 their Projs to the RegParams node. */
99 int start_block_bias; /**< The stack bias at the end of the start block. */
101 void *cb; /**< ABI Callback self pointer. */
103 pmap *keep_map; /**< mapping blocks to keep nodes. */
104 pset *ignore_regs; /**< Additional registers which shall be ignored. */
106 ir_node **calls; /**< flexible array containing all be_Call nodes */
108 arch_register_req_t sp_req;
109 arch_register_req_t sp_cls_req;
111 DEBUG_ONLY(firm_dbg_module_t *dbg;) /**< The debugging module. */
114 static heights_t *ir_heights;
116 /* Flag: if set, try to omit the frame pointer if called by the backend */
117 static int be_omit_fp = 1;
120 _ ____ ___ ____ _ _ _ _
121 / \ | __ )_ _| / ___|__ _| | | |__ __ _ ___| | _____
122 / _ \ | _ \| | | | / _` | | | '_ \ / _` |/ __| |/ / __|
123 / ___ \| |_) | | | |__| (_| | | | |_) | (_| | (__| <\__ \
124 /_/ \_\____/___| \____\__,_|_|_|_.__/ \__,_|\___|_|\_\___/
126 These callbacks are used by the backend to set the parameters
127 for a specific call type.
131 * Set compare function: compares two ABI call object arguments.
133 static int cmp_call_arg(const void *a, const void *b, size_t n)
135 const be_abi_call_arg_t *p = a, *q = b;
137 return !(p->is_res == q->is_res && p->pos == q->pos);
141 * Get or set an ABI call object argument.
143 * @param call the abi call
144 * @param is_res true for call results, false for call arguments
145 * @param pos position of the argument
146 * @param do_insert true if the argument is set, false if it's retrieved
148 static be_abi_call_arg_t *get_or_set_call_arg(be_abi_call_t *call, int is_res, int pos, int do_insert)
150 be_abi_call_arg_t arg;
153 memset(&arg, 0, sizeof(arg));
157 hash = is_res * 128 + pos;
160 ? set_insert(call->params, &arg, sizeof(arg), hash)
161 : set_find(call->params, &arg, sizeof(arg), hash);
165 * Retrieve an ABI call object argument.
167 * @param call the ABI call object
168 * @param is_res true for call results, false for call arguments
169 * @param pos position of the argument
171 static INLINE be_abi_call_arg_t *get_call_arg(be_abi_call_t *call, int is_res, int pos)
173 return get_or_set_call_arg(call, is_res, pos, 0);
176 /* Set the flags for a call. */
177 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb)
183 void be_abi_call_set_pop(be_abi_call_t *call, int pop)
189 /* Set register class for call address */
190 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls)
192 call->cls_addr = cls;
196 void be_abi_call_param_stack(be_abi_call_t *call, int arg_pos, ir_mode *load_mode, unsigned alignment, unsigned space_before, unsigned space_after)
198 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
200 arg->load_mode = load_mode;
201 arg->alignment = alignment;
202 arg->space_before = space_before;
203 arg->space_after = space_after;
204 assert(alignment > 0 && "Alignment must be greater than 0");
207 void be_abi_call_param_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
209 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
214 void be_abi_call_res_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
216 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 1, arg_pos, 1);
221 /* Get the flags of a ABI call object. */
222 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call)
228 * Constructor for a new ABI call object.
230 * @return the new ABI call object
232 static be_abi_call_t *be_abi_call_new(const arch_register_class_t *cls_addr)
234 be_abi_call_t *call = xmalloc(sizeof(call[0]));
235 memset(call, 0, sizeof(call[0]));
238 call->params = new_set(cmp_call_arg, 16);
240 call->cls_addr = cls_addr;
242 call->flags.bits.try_omit_fp = be_omit_fp;
248 * Destructor for an ABI call object.
250 static void be_abi_call_free(be_abi_call_t *call)
252 del_set(call->params);
258 | ___| __ __ _ _ __ ___ ___ | | | | __ _ _ __ __| | (_)_ __ __ _
259 | |_ | '__/ _` | '_ ` _ \ / _ \ | |_| |/ _` | '_ \ / _` | | | '_ \ / _` |
260 | _|| | | (_| | | | | | | __/ | _ | (_| | | | | (_| | | | | | | (_| |
261 |_| |_| \__,_|_| |_| |_|\___| |_| |_|\__,_|_| |_|\__,_|_|_|_| |_|\__, |
264 Handling of the stack frame. It is composed of three types:
265 1) The type of the arguments which are pushed on the stack.
266 2) The "between type" which consists of stuff the call of the
267 function pushes on the stack (like the return address and
268 the old base pointer for ia32).
269 3) The Firm frame type which consists of all local variables
273 static int get_stack_entity_offset(be_stack_layout_t *frame, ir_entity *ent, int bias)
275 ir_type *t = get_entity_owner(ent);
276 int ofs = get_entity_offset(ent);
280 /* Find the type the entity is contained in. */
281 for(index = 0; index < N_FRAME_TYPES; ++index) {
282 if(frame->order[index] == t)
286 /* Add the size of all the types below the one of the entity to the entity's offset */
287 for(i = 0; i < index; ++i)
288 ofs += get_type_size_bytes(frame->order[i]);
290 /* correct the offset by the initial position of the frame pointer */
291 ofs -= frame->initial_offset;
293 /* correct the offset with the current bias. */
300 * Retrieve the entity with given offset from a frame type.
302 static ir_entity *search_ent_with_offset(ir_type *t, int offset)
306 for(i = 0, n = get_compound_n_members(t); i < n; ++i) {
307 ir_entity *ent = get_compound_member(t, i);
308 if(get_entity_offset(ent) == offset)
315 static int stack_frame_compute_initial_offset(be_stack_layout_t *frame)
317 ir_type *base = frame->stack_dir < 0 ? frame->between_type : frame->frame_type;
318 ir_entity *ent = search_ent_with_offset(base, 0);
320 frame->initial_offset = ent ? get_stack_entity_offset(frame, ent, 0) : 0;
322 return frame->initial_offset;
326 * Initializes the frame layout from parts
328 * @param frame the stack layout that will be initialized
329 * @param args the stack argument layout type
330 * @param between the between layout type
331 * @param locals the method frame type
332 * @param stack_dir the stack direction
333 * @param param_map an array mapping method argument positions to the stack argument type
335 * @return the initialized stack layout
337 static be_stack_layout_t *stack_frame_init(be_stack_layout_t *frame, ir_type *args,
338 ir_type *between, ir_type *locals, int stack_dir,
339 ir_entity *param_map[])
341 frame->arg_type = args;
342 frame->between_type = between;
343 frame->frame_type = locals;
344 frame->initial_offset = 0;
345 frame->stack_dir = stack_dir;
346 frame->order[1] = between;
347 frame->param_map = param_map;
350 frame->order[0] = args;
351 frame->order[2] = locals;
354 frame->order[0] = locals;
355 frame->order[2] = args;
361 /** Dumps the stack layout to file. */
362 static void stack_layout_dump(FILE *file, be_stack_layout_t *frame)
366 ir_fprintf(file, "initial offset: %d\n", frame->initial_offset);
367 for (j = 0; j < N_FRAME_TYPES; ++j) {
368 ir_type *t = frame->order[j];
370 ir_fprintf(file, "type %d: %F size: %d\n", j, t, get_type_size_bytes(t));
371 for (i = 0, n = get_compound_n_members(t); i < n; ++i) {
372 ir_entity *ent = get_compound_member(t, i);
373 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));
380 * Returns non-zero if the call argument at given position
381 * is transfered on the stack.
383 static INLINE int is_on_stack(be_abi_call_t *call, int pos)
385 be_abi_call_arg_t *arg = get_call_arg(call, 0, pos);
386 return arg && !arg->in_reg;
396 Adjustment of the calls inside a graph.
401 * Transform a call node into a be_Call node.
403 * @param env The ABI environment for the current irg.
404 * @param irn The call node.
405 * @param curr_sp The stack pointer node to use.
406 * @return The stack pointer after the call.
408 static ir_node *adjust_call(be_abi_irg_t *env, ir_node *irn, ir_node *curr_sp)
410 ir_graph *irg = env->birg->irg;
411 const arch_env_t *arch_env = env->birg->main_env->arch_env;
412 const arch_isa_t *isa = arch_env->isa;
413 ir_type *call_tp = get_Call_type(irn);
414 ir_node *call_ptr = get_Call_ptr(irn);
415 int n_params = get_method_n_params(call_tp);
416 ir_node *curr_mem = get_Call_mem(irn);
417 ir_node *bl = get_nodes_block(irn);
418 pset *results = pset_new_ptr(8);
419 pset *caller_save = pset_new_ptr(8);
420 pset *states = pset_new_ptr(2);
422 int stack_dir = arch_isa_stack_dir(isa);
423 const arch_register_t *sp = arch_isa_sp(isa);
424 be_abi_call_t *call = be_abi_call_new(sp->reg_class);
425 ir_mode *mach_mode = sp->reg_class->mode;
426 struct obstack *obst = &env->obst;
427 int no_alloc = call->flags.bits.frame_is_setup_on_call;
428 int n_res = get_method_n_ress(call_tp);
430 ir_node *res_proj = NULL;
431 int n_reg_params = 0;
432 int n_stack_params = 0;
438 int n_reg_results = 0;
439 const arch_register_t *reg;
440 const ir_edge_t *edge;
442 int *stack_param_idx;
445 /* Let the isa fill out the abi description for that call node. */
446 arch_isa_get_call_abi(isa, call_tp, call);
448 /* Insert code to put the stack arguments on the stack. */
449 assert(get_Call_n_params(irn) == n_params);
450 for (i = 0; i < n_params; ++i) {
451 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
454 int arg_size = get_type_size_bytes(get_method_param_type(call_tp, i));
456 stack_size += round_up2(arg->space_before, arg->alignment);
457 stack_size += round_up2(arg_size, arg->alignment);
458 stack_size += round_up2(arg->space_after, arg->alignment);
459 obstack_int_grow(obst, i);
463 stack_param_idx = obstack_finish(obst);
465 /* Collect all arguments which are passed in registers. */
466 for (i = 0; i < n_params; ++i) {
467 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
468 if (arg && arg->in_reg) {
469 obstack_int_grow(obst, i);
473 reg_param_idxs = obstack_finish(obst);
475 /* If there are some parameters which shall be passed on the stack. */
476 if (n_stack_params > 0) {
478 int do_seq = call->flags.bits.store_args_sequential && !no_alloc;
481 * Reverse list of stack parameters if call arguments are from left to right.
482 * We must them reverse again if they are pushed (not stored) and the stack
483 * direction is downwards.
485 if (call->flags.bits.left_to_right ^ (do_seq && stack_dir < 0)) {
486 for (i = 0; i < n_stack_params >> 1; ++i) {
487 int other = n_stack_params - i - 1;
488 int tmp = stack_param_idx[i];
489 stack_param_idx[i] = stack_param_idx[other];
490 stack_param_idx[other] = tmp;
495 * If the stack is decreasing and we do not want to store sequentially,
496 * or someone else allocated the call frame
497 * we allocate as much space on the stack all parameters need, by
498 * moving the stack pointer along the stack's direction.
500 if (stack_dir < 0 && !do_seq && !no_alloc) {
501 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, stack_size);
504 curr_mem = get_Call_mem(irn);
506 obstack_ptr_grow(obst, curr_mem);
509 for (i = 0; i < n_stack_params; ++i) {
510 int p = stack_param_idx[i];
511 be_abi_call_arg_t *arg = get_call_arg(call, 0, p);
512 ir_node *param = get_Call_param(irn, p);
513 ir_node *addr = curr_sp;
515 ir_type *param_type = get_method_param_type(call_tp, p);
516 int param_size = get_type_size_bytes(param_type) + arg->space_after;
519 * If we wanted to build the arguments sequentially,
520 * the stack pointer for the next must be incremented,
521 * and the memory value propagated.
525 addr = curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, param_size + arg->space_before);
526 add_irn_dep(curr_sp, curr_mem);
529 curr_ofs += arg->space_before;
530 curr_ofs = round_up2(curr_ofs, arg->alignment);
532 /* Make the expression to compute the argument's offset. */
534 ir_mode *constmode = mach_mode;
535 if(mode_is_reference(mach_mode)) {
538 addr = new_r_Const_long(irg, bl, constmode, curr_ofs);
539 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
543 /* Insert a store for primitive arguments. */
544 if (is_atomic_type(param_type)) {
546 ir_node *mem_input = do_seq ? curr_mem : new_NoMem();
547 store = new_r_Store(irg, bl, mem_input, addr, param);
548 mem = new_r_Proj(irg, bl, store, mode_M, pn_Store_M);
551 /* Make a mem copy for compound arguments. */
555 assert(mode_is_reference(get_irn_mode(param)));
556 copy = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
557 mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
560 curr_ofs += param_size;
565 obstack_ptr_grow(obst, mem);
568 in = (ir_node **) obstack_finish(obst);
570 /* We need the sync only, if we didn't build the stores sequentially. */
572 if (n_stack_params >= 1) {
573 curr_mem = new_r_Sync(irg, bl, n_stack_params + 1, in);
575 curr_mem = get_Call_mem(irn);
578 obstack_free(obst, in);
581 /* Collect caller save registers */
582 for (i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
584 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
585 for (j = 0; j < cls->n_regs; ++j) {
586 const arch_register_t *reg = arch_register_for_index(cls, j);
587 if (arch_register_type_is(reg, caller_save)) {
588 pset_insert_ptr(caller_save, (void *) reg);
590 if (arch_register_type_is(reg, state)) {
591 pset_insert_ptr(caller_save, (void*) reg);
592 pset_insert_ptr(states, (void*) reg);
597 /* search the greatest result proj number */
599 res_projs = alloca(n_res * sizeof(res_projs[0]));
600 memset(res_projs, 0, n_res * sizeof(res_projs[0]));
602 foreach_out_edge(irn, edge) {
603 const ir_edge_t *res_edge;
604 ir_node *irn = get_edge_src_irn(edge);
606 if(!is_Proj(irn) || get_Proj_proj(irn) != pn_Call_T_result)
609 foreach_out_edge(irn, res_edge) {
611 ir_node *res = get_edge_src_irn(res_edge);
613 assert(is_Proj(res));
615 proj = get_Proj_proj(res);
616 assert(proj < n_res);
617 assert(res_projs[proj] == NULL);
618 res_projs[proj] = res;
624 /** TODO: this is not correct for cases where return values are passed
625 * on the stack, but no known ABI does this currentl...
627 n_reg_results = n_res;
629 /* make the back end call node and set its register requirements. */
630 for (i = 0; i < n_reg_params; ++i) {
631 obstack_ptr_grow(obst, get_Call_param(irn, reg_param_idxs[i]));
633 foreach_pset(states, reg) {
634 const arch_register_class_t *cls = arch_register_get_class(reg);
636 ir_node *regnode = be_abi_reg_map_get(env->regs, reg);
637 ir_fprintf(stderr, "Adding %+F\n", regnode);
639 ir_node *regnode = new_rd_Unknown(irg, arch_register_class_mode(cls));
640 obstack_ptr_grow(obst, regnode);
642 n_ins = n_reg_params + pset_count(states);
644 in = obstack_finish(obst);
646 if (env->call->flags.bits.call_has_imm && is_SymConst(call_ptr)) {
648 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem,
650 n_reg_results + pn_be_Call_first_res + pset_count(caller_save),
651 n_ins, in, get_Call_type(irn));
652 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
655 low_call = be_new_Call(get_irn_dbg_info(irn), irg, bl, curr_mem,
657 n_reg_results + pn_be_Call_first_res + pset_count(caller_save),
658 n_ins, in, get_Call_type(irn));
660 be_Call_set_pop(low_call, call->pop);
661 ARR_APP1(ir_node *, env->calls, low_call);
663 /* create new stack pointer */
664 curr_sp = new_r_Proj(irg, bl, low_call, get_irn_mode(curr_sp),
666 be_set_constr_single_reg(low_call, BE_OUT_POS(pn_be_Call_sp), sp);
667 arch_set_irn_register(arch_env, curr_sp, sp);
668 be_node_set_flags(low_call, BE_OUT_POS(pn_be_Call_sp),
669 arch_irn_flags_ignore | arch_irn_flags_modify_sp);
671 for(i = 0; i < n_res; ++i) {
673 ir_node *proj = res_projs[i];
674 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
676 /* returns values on stack not supported yet */
680 shift the proj number to the right, since we will drop the
681 unspeakable Proj_T from the Call. Therefore, all real argument
682 Proj numbers must be increased by pn_be_Call_first_res
684 pn = i + pn_be_Call_first_res;
687 ir_type *res_type = get_method_res_type(call_tp, i);
688 ir_mode *mode = get_type_mode(res_type);
689 proj = new_r_Proj(irg, bl, low_call, mode, pn);
692 set_Proj_pred(proj, low_call);
693 set_Proj_proj(proj, pn);
697 pset_remove_ptr(caller_save, arg->reg);
702 Set the register class of the call address to
703 the backend provided class (default: stack pointer class)
705 be_node_set_reg_class(low_call, be_pos_Call_ptr, call->cls_addr);
707 DBG((env->dbg, LEVEL_3, "\tcreated backend call %+F\n", low_call));
709 /* Set the register classes and constraints of the Call parameters. */
710 for (i = 0; i < n_reg_params; ++i) {
711 int index = reg_param_idxs[i];
712 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
713 assert(arg->reg != NULL);
715 be_set_constr_single_reg(low_call, be_pos_Call_first_arg + i, arg->reg);
718 /* Set the register constraints of the results. */
719 for (i = 0; i < n_res; ++i) {
720 ir_node *proj = res_projs[i];
721 const be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
722 int pn = get_Proj_proj(proj);
725 be_set_constr_single_reg(low_call, BE_OUT_POS(pn), arg->reg);
726 arch_set_irn_register(arch_env, proj, arg->reg);
728 obstack_free(obst, in);
729 exchange(irn, low_call);
731 /* kill the ProjT node */
732 if (res_proj != NULL) {
733 be_kill_node(res_proj);
736 /* Make additional projs for the caller save registers
737 and the Keep node which keeps them alive. */
738 if (1 || pset_count(caller_save) + n_reg_results > 0) {
739 const arch_register_t *reg;
744 = pn_be_Call_first_res + n_reg_results;
746 /* also keep the stack pointer */
748 set_irn_link(curr_sp, (void*) sp);
749 obstack_ptr_grow(obst, curr_sp);
751 for (reg = pset_first(caller_save); reg; reg = pset_next(caller_save), ++n) {
752 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode,
755 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
756 be_set_constr_single_reg(low_call, BE_OUT_POS(curr_res_proj), reg);
757 arch_set_irn_register(arch_env, proj, reg);
759 /* a call can produce ignore registers, in this case set the flag and register for the Proj */
760 if (arch_register_type_is(reg, ignore)) {
761 be_node_set_flags(low_call, BE_OUT_POS(curr_res_proj),
762 arch_irn_flags_ignore);
765 set_irn_link(proj, (void*) reg);
766 obstack_ptr_grow(obst, proj);
770 for(i = 0; i < n_reg_results; ++i) {
771 ir_node *proj = res_projs[i];
772 const arch_register_t *reg = arch_get_irn_register(arch_env, proj);
773 set_irn_link(proj, (void*) reg);
774 obstack_ptr_grow(obst, proj);
778 /* create the Keep for the caller save registers */
779 in = (ir_node **) obstack_finish(obst);
780 keep = be_new_Keep(NULL, irg, bl, n, in);
781 for (i = 0; i < n; ++i) {
782 const arch_register_t *reg = get_irn_link(in[i]);
783 be_node_set_reg_class(keep, i, reg->reg_class);
785 obstack_free(obst, in);
788 /* Clean up the stack. */
789 assert(stack_size >= call->pop);
790 stack_size -= call->pop;
792 if (stack_size > 0) {
793 ir_node *mem_proj = NULL;
795 foreach_out_edge(low_call, edge) {
796 ir_node *irn = get_edge_src_irn(edge);
797 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
804 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_be_Call_M_regular);
805 keep_alive(mem_proj);
808 /* Clean up the stack frame if we allocated it */
810 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, -stack_size);
814 be_abi_call_free(call);
815 obstack_free(obst, stack_param_idx);
818 del_pset(caller_save);
824 * Adjust the size of a node representing a stack alloc or free for the minimum stack alignment.
826 * @param alignment the minimum stack alignment
827 * @param size the node containing the non-aligned size
828 * @param irg the irg where new nodes are allocated on
829 * @param irg the block where new nodes are allocated on
830 * @param dbg debug info for new nodes
832 * @return a node representing the aligned size
834 static ir_node *adjust_alloc_size(unsigned stack_alignment, ir_node *size,
835 ir_graph *irg, ir_node *block, dbg_info *dbg)
837 if (stack_alignment > 1) {
838 ir_mode *mode = get_irn_mode(size);
839 tarval *tv = new_tarval_from_long(stack_alignment-1, mode);
840 ir_node *mask = new_r_Const(irg, block, mode, tv);
842 size = new_rd_Add(dbg, irg, block, size, mask, mode);
844 tv = new_tarval_from_long(-(long)stack_alignment, mode);
845 mask = new_r_Const(irg, block, mode, tv);
846 size = new_rd_And(dbg, irg, block, size, mask, mode);
852 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
854 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp)
863 const ir_edge_t *edge;
864 ir_node *new_alloc, *size, *addr, *ins[2];
865 unsigned stack_alignment;
867 if (get_Alloc_where(alloc) != stack_alloc) {
872 block = get_nodes_block(alloc);
873 irg = get_irn_irg(block);
876 type = get_Alloc_type(alloc);
878 foreach_out_edge(alloc, edge) {
879 ir_node *irn = get_edge_src_irn(edge);
881 assert(is_Proj(irn));
882 switch(get_Proj_proj(irn)) {
894 /* Beware: currently Alloc nodes without a result might happen,
895 only escape analysis kills them and this phase runs only for object
896 oriented source. We kill the Alloc here. */
897 if (alloc_res == NULL && alloc_mem) {
898 exchange(alloc_mem, get_Alloc_mem(alloc));
902 dbg = get_irn_dbg_info(alloc);
904 /* we might need to multiply the size with the element size */
905 if(type != get_unknown_type() && get_type_size_bytes(type) != 1) {
906 tarval *tv = new_tarval_from_long(get_type_size_bytes(type),
908 ir_node *cnst = new_rd_Const(dbg, irg, block, mode_Iu, tv);
909 ir_node *mul = new_rd_Mul(dbg, irg, block, get_Alloc_size(alloc),
913 size = get_Alloc_size(alloc);
916 /* The stack pointer will be modified in an unknown manner.
917 We cannot omit it. */
918 env->call->flags.bits.try_omit_fp = 0;
920 /* FIXME: size must be here round up for the stack alignment, but
921 this must be transmitted from the backend. */
923 size = adjust_alloc_size(stack_alignment, size, irg, block, dbg);
924 new_alloc = be_new_AddSP(env->isa->sp, irg, block, curr_sp, size);
925 set_irn_dbg_info(new_alloc, dbg);
927 if(alloc_mem != NULL) {
931 addsp_mem = new_r_Proj(irg, block, new_alloc, mode_M, pn_be_AddSP_M);
933 /* We need to sync the output mem of the AddSP with the input mem
934 edge into the alloc node. */
935 ins[0] = get_Alloc_mem(alloc);
937 sync = new_r_Sync(irg, block, 2, ins);
939 exchange(alloc_mem, sync);
942 exchange(alloc, new_alloc);
944 /* fix projnum of alloca res */
945 set_Proj_proj(alloc_res, pn_be_AddSP_res);
948 curr_sp = new_r_Proj(irg, block, new_alloc, get_irn_mode(curr_sp),
956 * The Free is transformed into a back end free node and connected to the stack nodes.
958 static ir_node *adjust_free(be_abi_irg_t *env, ir_node *free, ir_node *curr_sp)
962 ir_node *subsp, *mem, *res, *size, *sync;
966 unsigned stack_alignment;
969 if (get_Free_where(free) != stack_alloc) {
974 block = get_nodes_block(free);
975 irg = get_irn_irg(block);
976 type = get_Free_type(free);
977 sp_mode = env->isa->sp->reg_class->mode;
978 dbg = get_irn_dbg_info(free);
980 /* we might need to multiply the size with the element size */
981 if(type != get_unknown_type() && get_type_size_bytes(type) != 1) {
982 tarval *tv = new_tarval_from_long(get_type_size_bytes(type), mode_Iu);
983 ir_node *cnst = new_rd_Const(dbg, irg, block, mode_Iu, tv);
984 ir_node *mul = new_rd_Mul(dbg, irg, block, get_Free_size(free),
988 size = get_Free_size(free);
991 /* FIXME: size must be here round up for the stack alignment, but
992 this must be transmitted from the backend. */
994 size = adjust_alloc_size(stack_alignment, size, irg, block, dbg);
996 /* The stack pointer will be modified in an unknown manner.
997 We cannot omit it. */
998 env->call->flags.bits.try_omit_fp = 0;
999 subsp = be_new_SubSP(env->isa->sp, irg, block, curr_sp, size);
1000 set_irn_dbg_info(subsp, dbg);
1002 mem = new_r_Proj(irg, block, subsp, mode_M, pn_be_SubSP_M);
1003 res = new_r_Proj(irg, block, subsp, sp_mode, pn_be_SubSP_sp);
1005 /* we need to sync the memory */
1006 in[0] = get_Free_mem(free);
1008 sync = new_r_Sync(irg, block, 2, in);
1010 /* and make the AddSP dependent on the former memory */
1011 add_irn_dep(subsp, get_Free_mem(free));
1014 exchange(free, sync);
1020 /* the following function is replaced by the usage of the heights module */
1023 * Walker for dependent_on().
1024 * This function searches a node tgt recursively from a given node
1025 * but is restricted to the given block.
1026 * @return 1 if tgt was reachable from curr, 0 if not.
1028 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl)
1032 if (get_nodes_block(curr) != bl)
1038 /* Phi functions stop the recursion inside a basic block */
1039 if (! is_Phi(curr)) {
1040 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
1041 if (check_dependence(get_irn_n(curr, i), tgt, bl))
1051 * Check if a node is somehow data dependent on another one.
1052 * both nodes must be in the same basic block.
1053 * @param n1 The first node.
1054 * @param n2 The second node.
1055 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
1057 static int dependent_on(ir_node *n1, ir_node *n2)
1059 assert(get_nodes_block(n1) == get_nodes_block(n2));
1061 return heights_reachable_in_block(ir_heights, n1, n2);
1064 static int cmp_call_dependency(const void *c1, const void *c2)
1066 ir_node *n1 = *(ir_node **) c1;
1067 ir_node *n2 = *(ir_node **) c2;
1070 Classical qsort() comparison function behavior:
1071 0 if both elements are equal
1072 1 if second is "smaller" that first
1073 -1 if first is "smaller" that second
1075 if (dependent_on(n1, n2))
1078 if (dependent_on(n2, n1))
1085 * Walker: links all Call/alloc/Free nodes to the Block they are contained.
1087 static void link_calls_in_block_walker(ir_node *irn, void *data)
1089 ir_opcode code = get_irn_opcode(irn);
1091 if (code == iro_Call ||
1092 (code == iro_Alloc && get_Alloc_where(irn) == stack_alloc) ||
1093 (code == iro_Free && get_Free_where(irn) == stack_alloc)) {
1094 be_abi_irg_t *env = data;
1095 ir_node *bl = get_nodes_block(irn);
1096 void *save = get_irn_link(bl);
1098 if (code == iro_Call)
1099 env->call->flags.bits.irg_is_leaf = 0;
1101 set_irn_link(irn, save);
1102 set_irn_link(bl, irn);
1108 * Process all Call nodes inside a basic block.
1109 * Note that the link field of the block must contain a linked list of all
1110 * Call nodes inside the Block. We first order this list according to data dependency
1111 * and that connect the calls together.
1113 static void process_calls_in_block(ir_node *bl, void *data)
1115 be_abi_irg_t *env = data;
1116 ir_node *curr_sp = env->init_sp;
1120 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
1121 obstack_ptr_grow(&env->obst, irn);
1123 /* If there were call nodes in the block. */
1129 nodes = obstack_finish(&env->obst);
1131 /* order the call nodes according to data dependency */
1132 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependency);
1134 for(i = n - 1; i >= 0; --i) {
1135 ir_node *irn = nodes[i];
1137 DBG((env->dbg, LEVEL_3, "\tprocessing call %+F\n", irn));
1138 switch(get_irn_opcode(irn)) {
1140 curr_sp = adjust_call(env, irn, curr_sp);
1143 curr_sp = adjust_alloc(env, irn, curr_sp);
1146 curr_sp = adjust_free(env, irn, curr_sp);
1149 panic("invalid call");
1154 obstack_free(&env->obst, nodes);
1156 /* Keep the last stack state in the block by tying it to Keep node,
1157 * the proj from calls is already kept */
1158 if(curr_sp != env->init_sp
1159 && !(is_Proj(curr_sp) && be_is_Call(get_Proj_pred(curr_sp)))) {
1161 keep = be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl),
1163 pmap_insert(env->keep_map, bl, keep);
1167 set_irn_link(bl, curr_sp);
1168 } /* process_calls_in_block */
1171 * Adjust all call nodes in the graph to the ABI conventions.
1173 static void process_calls(be_abi_irg_t *env)
1175 ir_graph *irg = env->birg->irg;
1177 env->call->flags.bits.irg_is_leaf = 1;
1178 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, env);
1180 ir_heights = heights_new(env->birg->irg);
1181 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
1182 heights_free(ir_heights);
1186 * Computes the stack argument layout type.
1187 * Changes a possibly allocated value param type by moving
1188 * entities to the stack layout type.
1190 * @param env the ABI environment
1191 * @param call the current call ABI
1192 * @param method_type the method type
1193 * @param param_map an array mapping method arguments to the stack layout type
1195 * @return the stack argument layout type
1197 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type, ir_entity ***param_map)
1199 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
1200 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
1201 int n = get_method_n_params(method_type);
1202 int curr = inc > 0 ? 0 : n - 1;
1208 ir_type *val_param_tp = get_method_value_param_type(method_type);
1209 ident *id = get_entity_ident(get_irg_entity(env->birg->irg));
1212 *param_map = map = obstack_alloc(&env->obst, n * sizeof(ir_entity *));
1213 res = new_type_struct(mangle_u(id, new_id_from_chars("arg_type", 8)));
1214 for (i = 0; i < n; ++i, curr += inc) {
1215 ir_type *param_type = get_method_param_type(method_type, curr);
1216 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
1219 if (arg->on_stack) {
1221 /* the entity was already created, move it to the param type */
1222 arg->stack_ent = get_method_value_param_ent(method_type, i);
1223 remove_struct_member(val_param_tp, arg->stack_ent);
1224 set_entity_owner(arg->stack_ent, res);
1225 add_struct_member(res, arg->stack_ent);
1226 /* must be automatic to set a fixed layout */
1227 set_entity_allocation(arg->stack_ent, allocation_automatic);
1230 snprintf(buf, sizeof(buf), "param_%d", i);
1231 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
1233 ofs += arg->space_before;
1234 ofs = round_up2(ofs, arg->alignment);
1235 set_entity_offset(arg->stack_ent, ofs);
1236 ofs += arg->space_after;
1237 ofs += get_type_size_bytes(param_type);
1238 map[i] = arg->stack_ent;
1241 set_type_size_bytes(res, ofs);
1242 set_type_state(res, layout_fixed);
1247 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
1250 struct obstack obst;
1252 obstack_init(&obst);
1254 /* Create a Perm after the RegParams node to delimit it. */
1255 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1256 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1261 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
1262 const arch_register_t *reg = &cls->regs[j];
1263 ir_node *irn = pmap_get(regs, (void *) reg);
1265 if(irn && !arch_register_type_is(reg, ignore)) {
1267 obstack_ptr_grow(&obst, irn);
1268 set_irn_link(irn, (void *) reg);
1272 obstack_ptr_grow(&obst, NULL);
1273 in = obstack_finish(&obst);
1275 perm = be_new_Perm(cls, irg, bl, n_regs, in);
1276 for(j = 0; j < n_regs; ++j) {
1277 ir_node *arg = in[j];
1278 arch_register_t *reg = get_irn_link(arg);
1279 pmap_insert(regs, reg, arg);
1280 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
1283 obstack_free(&obst, in);
1286 obstack_free(&obst, NULL);
1291 const arch_register_t *reg;
1295 static int cmp_regs(const void *a, const void *b)
1297 const reg_node_map_t *p = a;
1298 const reg_node_map_t *q = b;
1300 if(p->reg->reg_class == q->reg->reg_class)
1301 return p->reg->index - q->reg->index;
1303 return p->reg->reg_class - q->reg->reg_class;
1306 static reg_node_map_t *reg_map_to_arr(struct obstack *obst, pmap *reg_map)
1309 int n = pmap_count(reg_map);
1311 reg_node_map_t *res = obstack_alloc(obst, n * sizeof(res[0]));
1313 pmap_foreach(reg_map, ent) {
1314 res[i].reg = ent->key;
1315 res[i].irn = ent->value;
1319 qsort(res, n, sizeof(res[0]), cmp_regs);
1324 * Creates a barrier.
1326 static ir_node *create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs, int in_req)
1328 ir_graph *irg = env->birg->irg;
1329 int n_regs = pmap_count(regs);
1335 rm = reg_map_to_arr(&env->obst, regs);
1337 for(n = 0; n < n_regs; ++n)
1338 obstack_ptr_grow(&env->obst, rm[n].irn);
1341 obstack_ptr_grow(&env->obst, *mem);
1345 in = (ir_node **) obstack_finish(&env->obst);
1346 irn = be_new_Barrier(irg, bl, n, in);
1347 obstack_free(&env->obst, in);
1349 for(n = 0; n < n_regs; ++n) {
1350 const arch_register_t *reg = rm[n].reg;
1352 int pos = BE_OUT_POS(n);
1355 proj = new_r_Proj(irg, bl, irn, get_irn_mode(rm[n].irn), n);
1356 be_node_set_reg_class(irn, n, reg->reg_class);
1358 be_set_constr_single_reg(irn, n, reg);
1359 be_set_constr_single_reg(irn, pos, reg);
1360 be_node_set_reg_class(irn, pos, reg->reg_class);
1361 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1363 /* if the proj projects a ignore register or a node which is set to ignore, propagate this property. */
1364 if(arch_register_type_is(reg, ignore) || arch_irn_is(env->birg->main_env->arch_env, in[n], ignore))
1365 flags |= arch_irn_flags_ignore;
1367 if(arch_irn_is(env->birg->main_env->arch_env, in[n], modify_sp))
1368 flags |= arch_irn_flags_modify_sp;
1370 be_node_set_flags(irn, pos, flags);
1372 pmap_insert(regs, (void *) reg, proj);
1376 *mem = new_r_Proj(irg, bl, irn, mode_M, n);
1379 obstack_free(&env->obst, rm);
1384 * Creates a be_Return for a Return node.
1386 * @param @env the abi environment
1387 * @param irn the Return node or NULL if there was none
1388 * @param bl the block where the be_Retun should be placed
1389 * @param mem the current memory
1390 * @param n_res number of return results
1392 static ir_node *create_be_return(be_abi_irg_t *env, ir_node *irn, ir_node *bl,
1393 ir_node *mem, int n_res)
1395 be_abi_call_t *call = env->call;
1396 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1398 pmap *reg_map = pmap_create();
1399 ir_node *keep = pmap_get(env->keep_map, bl);
1406 const arch_register_t **regs;
1410 get the valid stack node in this block.
1411 If we had a call in that block there is a Keep constructed by process_calls()
1412 which points to the last stack modification in that block. we'll use
1413 it then. Else we use the stack from the start block and let
1414 the ssa construction fix the usage.
1416 stack = be_abi_reg_map_get(env->regs, isa->sp);
1418 stack = get_irn_n(keep, 0);
1420 remove_End_keepalive(get_irg_end(env->birg->irg), keep);
1423 /* Insert results for Return into the register map. */
1424 for(i = 0; i < n_res; ++i) {
1425 ir_node *res = get_Return_res(irn, i);
1426 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1427 assert(arg->in_reg && "return value must be passed in register");
1428 pmap_insert(reg_map, (void *) arg->reg, res);
1431 /* Add uses of the callee save registers. */
1432 pmap_foreach(env->regs, ent) {
1433 const arch_register_t *reg = ent->key;
1434 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1435 pmap_insert(reg_map, ent->key, ent->value);
1438 be_abi_reg_map_set(reg_map, isa->sp, stack);
1440 /* Make the Epilogue node and call the arch's epilogue maker. */
1441 create_barrier(env, bl, &mem, reg_map, 1);
1442 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1445 Maximum size of the in array for Return nodes is
1446 return args + callee save/ignore registers + memory + stack pointer
1448 in_max = pmap_count(reg_map) + n_res + 2;
1450 in = obstack_alloc(&env->obst, in_max * sizeof(in[0]));
1451 regs = obstack_alloc(&env->obst, in_max * sizeof(regs[0]));
1454 in[1] = be_abi_reg_map_get(reg_map, isa->sp);
1459 /* clear SP entry, since it has already been grown. */
1460 pmap_insert(reg_map, (void *) isa->sp, NULL);
1461 for(i = 0; i < n_res; ++i) {
1462 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1464 in[n] = be_abi_reg_map_get(reg_map, arg->reg);
1465 regs[n++] = arg->reg;
1467 /* Clear the map entry to mark the register as processed. */
1468 be_abi_reg_map_set(reg_map, arg->reg, NULL);
1471 /* grow the rest of the stuff. */
1472 pmap_foreach(reg_map, ent) {
1475 regs[n++] = ent->key;
1479 /* The in array for the new back end return is now ready. */
1481 dbgi = get_irn_dbg_info(irn);
1485 /* we have to pop the shadow parameter in in case of struct returns */
1487 ret = be_new_Return(dbgi, env->birg->irg, bl, n_res, pop, n, in);
1489 /* Set the register classes of the return's parameter accordingly. */
1490 for(i = 0; i < n; ++i)
1492 be_node_set_reg_class(ret, i, regs[i]->reg_class);
1494 /* Free the space of the Epilog's in array and the register <-> proj map. */
1495 obstack_free(&env->obst, in);
1496 pmap_destroy(reg_map);
1501 typedef struct lower_frame_sels_env_t {
1503 ir_entity *value_param_list; /**< the list of all value param entities */
1504 ir_entity *value_param_tail; /**< the tail of the list of all value param entities */
1505 } lower_frame_sels_env_t;
1508 * Walker: Replaces Sels of frame type and
1509 * value param type entities by FrameAddress.
1510 * Links all used entities.
1512 static void lower_frame_sels_walker(ir_node *irn, void *data) {
1513 lower_frame_sels_env_t *ctx = data;
1516 ir_graph *irg = current_ir_graph;
1517 ir_node *frame = get_irg_frame(irg);
1518 ir_node *param_base = get_irg_value_param_base(irg);
1519 ir_node *ptr = get_Sel_ptr(irn);
1521 if (ptr == frame || ptr == param_base) {
1522 be_abi_irg_t *env = ctx->env;
1523 ir_entity *ent = get_Sel_entity(irn);
1524 ir_node *bl = get_nodes_block(irn);
1527 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
1530 /* check, if it's a param sel and if have not seen this entity before */
1531 if (ptr == param_base &&
1532 ent != ctx->value_param_tail &&
1533 get_entity_link(ent) == NULL) {
1534 set_entity_link(ent, ctx->value_param_list);
1535 ctx->value_param_list = ent;
1536 if (ctx->value_param_tail == NULL) ctx->value_param_tail = ent;
1543 * Check if a value parameter is transmitted as a register.
1544 * This might happen if the address of an parameter is taken which is
1545 * transmitted in registers.
1547 * Note that on some architectures this case must be handled specially
1548 * because the place of the backing store is determined by their ABI.
1550 * In the default case we move the entity to the frame type and create
1551 * a backing store into the first block.
1553 static void fix_address_of_parameter_access(be_abi_irg_t *env, ir_entity *value_param_list) {
1554 be_abi_call_t *call = env->call;
1555 ir_graph *irg = env->birg->irg;
1556 ir_entity *ent, *next_ent, *new_list;
1558 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1561 for (ent = value_param_list; ent; ent = next_ent) {
1562 int i = get_struct_member_index(get_entity_owner(ent), ent);
1563 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1565 next_ent = get_entity_link(ent);
1567 DBG((dbg, LEVEL_2, "\targ #%d need backing store\n", i));
1568 set_entity_link(ent, new_list);
1573 /* ok, change the graph */
1574 ir_node *start_bl = get_irg_start_block(irg);
1575 ir_node *first_bl = NULL;
1576 ir_node *frame, *imem, *nmem, *store, *mem, *args, *args_bl;
1577 const ir_edge_t *edge;
1578 optimization_state_t state;
1581 foreach_block_succ(start_bl, edge) {
1582 ir_node *succ = get_edge_src_irn(edge);
1583 if (start_bl != succ) {
1589 /* we had already removed critical edges, so the following
1590 assertion should be always true. */
1591 assert(get_Block_n_cfgpreds(first_bl) == 1);
1593 /* now create backing stores */
1594 frame = get_irg_frame(irg);
1595 imem = get_irg_initial_mem(irg);
1597 save_optimization_state(&state);
1599 nmem = new_r_Proj(irg, first_bl, get_irg_start(irg), mode_M, pn_Start_M);
1600 restore_optimization_state(&state);
1602 /* reroute all edges to the new memory source */
1603 edges_reroute(imem, nmem, irg);
1607 args = get_irg_args(irg);
1608 args_bl = get_nodes_block(args);
1609 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1610 int i = get_struct_member_index(get_entity_owner(ent), ent);
1611 ir_type *tp = get_entity_type(ent);
1612 ir_mode *mode = get_type_mode(tp);
1615 /* address for the backing store */
1616 addr = be_new_FrameAddr(env->isa->sp->reg_class, irg, first_bl, frame, ent);
1619 mem = new_r_Proj(irg, first_bl, store, mode_M, pn_Store_M);
1621 /* the backing store itself */
1622 store = new_r_Store(irg, first_bl, mem, addr,
1623 new_r_Proj(irg, args_bl, args, mode, i));
1625 /* the new memory Proj gets the last Proj from store */
1626 set_Proj_pred(nmem, store);
1627 set_Proj_proj(nmem, pn_Store_M);
1629 /* move all entities to the frame type */
1630 frame_tp = get_irg_frame_type(irg);
1631 offset = get_type_size_bytes(frame_tp);
1632 for (ent = new_list; ent; ent = get_entity_link(ent)) {
1633 ir_type *tp = get_entity_type(ent);
1634 unsigned align = get_type_alignment_bytes(tp);
1636 offset += align - 1;
1637 offset &= ~(align - 1);
1638 set_entity_owner(ent, frame_tp);
1639 add_class_member(frame_tp, ent);
1640 /* must be automatic to set a fixed layout */
1641 set_entity_allocation(ent, allocation_automatic);
1642 set_entity_offset(ent, offset);
1643 offset += get_type_size_bytes(tp);
1645 set_type_size_bytes(frame_tp, offset);
1651 * The start block has no jump, instead it has an initial exec Proj.
1652 * The backend wants to handle all blocks the same way, so we replace
1653 * the out cfg edge with a real jump.
1655 static void fix_start_block(ir_node *block, void *env) {
1658 ir_node *start_block;
1661 /* we processed the start block, return */
1665 irg = get_irn_irg(block);
1666 start_block = get_irg_start_block(irg);
1668 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
1669 ir_node *pred = get_Block_cfgpred(block, i);
1670 ir_node *pred_block = get_nodes_block(pred);
1672 /* ok, we are in the block, having start as cfg predecessor */
1673 if (pred_block == start_block) {
1674 ir_node *jump = new_r_Jmp(irg, pred_block);
1675 set_Block_cfgpred(block, i, jump);
1683 * Modify the irg itself and the frame type.
1685 static void modify_irg(be_abi_irg_t *env)
1687 be_abi_call_t *call = env->call;
1688 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1689 const arch_register_t *sp = arch_isa_sp(isa);
1690 ir_graph *irg = env->birg->irg;
1691 ir_node *bl = get_irg_start_block(irg);
1692 ir_node *end = get_irg_end_block(irg);
1693 ir_node *old_mem = get_irg_initial_mem(irg);
1694 ir_node *new_mem_proj;
1696 ir_type *method_type = get_entity_type(get_irg_entity(irg));
1697 pset *dont_save = pset_new_ptr(8);
1704 const arch_register_t *fp_reg;
1705 ir_node *frame_pointer;
1706 ir_node *reg_params_bl;
1709 ir_node *value_param_base;
1710 const ir_edge_t *edge;
1711 ir_type *arg_type, *bet_type, *tp;
1712 lower_frame_sels_env_t ctx;
1713 ir_entity **param_map;
1715 bitset_t *used_proj_nr;
1716 DEBUG_ONLY(firm_dbg_module_t *dbg = env->dbg;)
1718 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1720 /* set the links of all frame entities to NULL, we use it
1721 to detect if an entity is already linked in the value_param_list */
1722 tp = get_method_value_param_type(method_type);
1724 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
1725 set_entity_link(get_struct_member(tp, i), NULL);
1728 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1730 ctx.value_param_list = NULL;
1731 ctx.value_param_tail = NULL;
1732 irg_walk_graph(irg, lower_frame_sels_walker, NULL, &ctx);
1734 /* value_param_base anchor is not needed anymore now */
1735 value_param_base = get_irg_value_param_base(irg);
1736 be_kill_node(value_param_base);
1737 set_irg_value_param_base(irg, new_r_Bad(irg));
1739 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1740 env->regs = pmap_create();
1742 used_proj_nr = bitset_alloca(1024);
1743 n_params = get_method_n_params(method_type);
1744 args = obstack_alloc(&env->obst, n_params * sizeof(args[0]));
1745 memset(args, 0, n_params * sizeof(args[0]));
1747 /* Check if a value parameter is transmitted as a register.
1748 * This might happen if the address of an parameter is taken which is
1749 * transmitted in registers.
1751 * Note that on some architectures this case must be handled specially
1752 * because the place of the backing store is determined by their ABI.
1754 * In the default case we move the entity to the frame type and create
1755 * a backing store into the first block.
1757 fix_address_of_parameter_access(env, ctx.value_param_list);
1759 /* Fill the argument vector */
1760 arg_tuple = get_irg_args(irg);
1761 foreach_out_edge(arg_tuple, edge) {
1762 ir_node *irn = get_edge_src_irn(edge);
1763 if (! is_Anchor(irn)) {
1764 int nr = get_Proj_proj(irn);
1766 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1770 arg_type = compute_arg_type(env, call, method_type, ¶m_map);
1771 bet_type = call->cb->get_between_type(env->cb);
1772 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir, param_map);
1774 /* Count the register params and add them to the number of Projs for the RegParams node */
1775 for(i = 0; i < n_params; ++i) {
1776 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1777 if(arg->in_reg && args[i]) {
1778 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1779 assert(i == get_Proj_proj(args[i]));
1781 /* For now, associate the register with the old Proj from Start representing that argument. */
1782 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1783 bitset_set(used_proj_nr, i);
1784 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1788 /* Collect all callee-save registers */
1789 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1790 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1791 for(j = 0; j < cls->n_regs; ++j) {
1792 const arch_register_t *reg = &cls->regs[j];
1793 if(arch_register_type_is(reg, callee_save) ||
1794 arch_register_type_is(reg, state)) {
1795 pmap_insert(env->regs, (void *) reg, NULL);
1800 pmap_insert(env->regs, (void *) sp, NULL);
1801 pmap_insert(env->regs, (void *) isa->bp, NULL);
1802 reg_params_bl = get_irg_start_block(irg);
1803 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1804 add_irn_dep(env->reg_params, get_irg_start(irg));
1807 * make proj nodes for the callee save registers.
1808 * memorize them, since Return nodes get those as inputs.
1810 * Note, that if a register corresponds to an argument, the regs map contains
1811 * the old Proj from start for that argument.
1814 rm = reg_map_to_arr(&env->obst, env->regs);
1815 for(i = 0, n = pmap_count(env->regs); i < n; ++i) {
1816 arch_register_t *reg = (void *) rm[i].reg;
1817 ir_mode *mode = reg->reg_class->mode;
1819 int pos = BE_OUT_POS((int) nr);
1825 bitset_set(used_proj_nr, nr);
1826 proj = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1827 pmap_insert(env->regs, (void *) reg, proj);
1828 be_set_constr_single_reg(env->reg_params, pos, reg);
1829 arch_set_irn_register(env->birg->main_env->arch_env, proj, reg);
1832 * If the register is an ignore register,
1833 * The Proj for that register shall also be ignored during register allocation.
1835 if(arch_register_type_is(reg, ignore))
1836 flags |= arch_irn_flags_ignore;
1839 flags |= arch_irn_flags_modify_sp;
1841 be_node_set_flags(env->reg_params, pos, flags);
1843 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1845 obstack_free(&env->obst, rm);
1847 /* create a new initial memory proj */
1848 assert(is_Proj(old_mem));
1849 new_mem_proj = new_r_Proj(irg, get_nodes_block(old_mem),
1850 new_r_Unknown(irg, mode_T), mode_M,
1851 get_Proj_proj(old_mem));
1854 /* Generate the Prologue */
1855 fp_reg = call->cb->prologue(env->cb, &mem, env->regs);
1857 /* do the stack allocation BEFORE the barrier, or spill code
1858 might be added before it */
1859 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1860 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, BE_STACK_FRAME_SIZE_EXPAND);
1861 be_abi_reg_map_set(env->regs, sp, env->init_sp);
1863 create_barrier(env, bl, &mem, env->regs, 0);
1865 env->init_sp = be_abi_reg_map_get(env->regs, sp);
1866 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1868 frame_pointer = be_abi_reg_map_get(env->regs, fp_reg);
1869 set_irg_frame(irg, frame_pointer);
1870 pset_insert_ptr(env->ignore_regs, fp_reg);
1872 /* rewire old mem users to new mem */
1873 set_Proj_pred(new_mem_proj, get_Proj_pred(old_mem));
1874 exchange(old_mem, mem);
1876 set_irg_initial_mem(irg, mem);
1878 /* Now, introduce stack param nodes for all parameters passed on the stack */
1879 for(i = 0; i < n_params; ++i) {
1880 ir_node *arg_proj = args[i];
1881 ir_node *repl = NULL;
1883 if(arg_proj != NULL) {
1884 be_abi_call_arg_t *arg;
1885 ir_type *param_type;
1886 int nr = get_Proj_proj(arg_proj);
1889 nr = MIN(nr, n_params);
1890 arg = get_call_arg(call, 0, nr);
1891 param_type = get_method_param_type(method_type, nr);
1894 repl = pmap_get(env->regs, (void *) arg->reg);
1895 } else if(arg->on_stack) {
1896 ir_node *addr = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1898 /* For atomic parameters which are actually used, we create a Load node. */
1899 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1900 ir_mode *mode = get_type_mode(param_type);
1901 ir_mode *load_mode = arg->load_mode;
1903 ir_node *load = new_r_Load(irg, reg_params_bl, new_NoMem(), addr, load_mode);
1904 set_irn_pinned(load, op_pin_state_floats);
1905 repl = new_r_Proj(irg, reg_params_bl, load, load_mode, pn_Load_res);
1907 if (mode != load_mode) {
1908 repl = new_r_Conv(irg, reg_params_bl, repl, mode);
1911 /* The stack parameter is not primitive (it is a struct or array),
1912 * we thus will create a node representing the parameter's address
1918 assert(repl != NULL);
1920 /* Beware: the mode of the register parameters is always the mode of the register class
1921 which may be wrong. Add Conv's then. */
1922 mode = get_irn_mode(args[i]);
1923 if (mode != get_irn_mode(repl)) {
1924 repl = new_r_Conv(irg, get_irn_n(repl, -1), repl, mode);
1926 exchange(args[i], repl);
1930 /* the arg proj is not needed anymore now and should be only used by the anchor */
1931 assert(get_irn_n_edges(arg_tuple) == 1);
1932 be_kill_node(arg_tuple);
1933 set_irg_args(irg, new_rd_Bad(irg));
1935 /* All Return nodes hang on the End node, so look for them there. */
1936 for (i = 0, n = get_Block_n_cfgpreds(end); i < n; ++i) {
1937 ir_node *irn = get_Block_cfgpred(end, i);
1939 if (is_Return(irn)) {
1940 ir_node *blk = get_nodes_block(irn);
1941 ir_node *mem = get_Return_mem(irn);
1942 ir_node *ret = create_be_return(env, irn, blk, mem, get_Return_n_ress(irn));
1946 /* if we have endless loops here, n might be <= 0. Do NOT create a be_Return then,
1947 the code is dead and will never be executed. */
1949 del_pset(dont_save);
1950 obstack_free(&env->obst, args);
1952 /* handle start block here (place a jump in the block) */
1954 irg_block_walk_graph(irg, fix_start_block, NULL, &i);
1957 /** Fix the state inputs of calls that still hang on unknowns */
1959 void fix_call_state_inputs(be_abi_irg_t *env)
1961 const arch_isa_t *isa = env->isa;
1963 arch_register_t **stateregs = NEW_ARR_F(arch_register_t*, 0);
1965 /* Collect caller save registers */
1966 n = arch_isa_get_n_reg_class(isa);
1967 for(i = 0; i < n; ++i) {
1969 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1970 for(j = 0; j < cls->n_regs; ++j) {
1971 const arch_register_t *reg = arch_register_for_index(cls, j);
1972 if(arch_register_type_is(reg, state)) {
1973 ARR_APP1(arch_register_t*, stateregs, (arch_register_t *)reg);
1978 n = ARR_LEN(env->calls);
1979 n_states = ARR_LEN(stateregs);
1980 for(i = 0; i < n; ++i) {
1982 ir_node *call = env->calls[i];
1984 arity = get_irn_arity(call);
1986 /* the statereg inputs are the last n inputs of the calls */
1987 for(s = 0; s < n_states; ++s) {
1988 int inp = arity - n_states + s;
1989 const arch_register_t *reg = stateregs[s];
1990 ir_node *regnode = be_abi_reg_map_get(env->regs, reg);
1992 set_irn_n(call, inp, regnode);
1997 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1999 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
2000 ir_node *old_frame = get_irg_frame(birg->irg);
2001 ir_graph *irg = birg->irg;
2005 optimization_state_t state;
2006 unsigned *limited_bitset;
2008 be_omit_fp = birg->main_env->options->omit_fp;
2010 obstack_init(&env->obst);
2012 env->isa = birg->main_env->arch_env->isa;
2013 env->method_type = get_entity_type(get_irg_entity(irg));
2014 env->call = be_abi_call_new(env->isa->sp->reg_class);
2015 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
2017 env->ignore_regs = pset_new_ptr_default();
2018 env->keep_map = pmap_create();
2019 env->dce_survivor = new_survive_dce();
2022 env->sp_req.type = arch_register_req_type_limited;
2023 env->sp_req.cls = arch_register_get_class(env->isa->sp);
2024 limited_bitset = rbitset_obstack_alloc(&env->obst, env->sp_req.cls->n_regs);
2025 rbitset_set(limited_bitset, arch_register_get_index(env->isa->sp));
2026 env->sp_req.limited = limited_bitset;
2028 env->sp_cls_req.type = arch_register_req_type_normal;
2029 env->sp_cls_req.cls = arch_register_get_class(env->isa->sp);
2031 /* Beware: later we replace this node by the real one, ensure it is not CSE'd
2032 to another Unknown or the stack pointer gets used */
2033 save_optimization_state(&state);
2035 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
2036 restore_optimization_state(&state);
2037 FIRM_DBG_REGISTER(env->dbg, "firm.be.abi");
2039 env->calls = NEW_ARR_F(ir_node*, 0);
2041 /* Lower all call nodes in the IRG. */
2045 Beware: init backend abi call object after processing calls,
2046 otherwise some information might be not yet available.
2048 env->cb = env->call->cb->init(env->call, birg->main_env->arch_env, irg);
2050 /* Process the IRG */
2053 /* fix call inputs for state registers */
2054 fix_call_state_inputs(env);
2056 /* We don't need the keep map anymore. */
2057 pmap_destroy(env->keep_map);
2059 /* calls array is not needed anymore */
2060 DEL_ARR_F(env->calls);
2062 /* reroute the stack origin of the calls to the true stack origin. */
2063 exchange(dummy, env->init_sp);
2064 exchange(old_frame, get_irg_frame(irg));
2066 /* Make some important node pointers survive the dead node elimination. */
2067 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
2068 pmap_foreach(env->regs, ent) {
2069 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
2072 env->call->cb->done(env->cb);
2077 void be_abi_free(be_abi_irg_t *env)
2079 be_abi_call_free(env->call);
2080 free_survive_dce(env->dce_survivor);
2081 del_pset(env->ignore_regs);
2082 pmap_destroy(env->regs);
2083 obstack_free(&env->obst, NULL);
2087 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs)
2089 arch_register_t *reg;
2091 for(reg = pset_first(abi->ignore_regs); reg; reg = pset_next(abi->ignore_regs))
2092 if(reg->reg_class == cls)
2093 bitset_set(bs, reg->index);
2096 /* Returns the stack layout from a abi environment. */
2097 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi) {
2104 | ___(_)_ __ / ___|| |_ __ _ ___| | __
2105 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
2106 | _| | |> < ___) | || (_| | (__| <
2107 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
2111 typedef ir_node **node_array;
2113 typedef struct fix_stack_walker_env_t {
2114 node_array sp_nodes;
2115 const arch_env_t *arch_env;
2116 } fix_stack_walker_env_t;
2119 * Walker. Collect all stack modifying nodes.
2121 static void collect_stack_nodes_walker(ir_node *node, void *data)
2123 fix_stack_walker_env_t *env = data;
2125 if (arch_irn_is(env->arch_env, node, modify_sp)) {
2126 assert(get_irn_mode(node) != mode_M && get_irn_mode(node) != mode_T);
2127 ARR_APP1(ir_node*, env->sp_nodes, node);
2131 void be_abi_fix_stack_nodes(be_abi_irg_t *env)
2133 be_ssa_construction_env_t senv;
2136 be_irg_t *birg = env->birg;
2137 be_lv_t *lv = be_get_birg_liveness(birg);
2138 fix_stack_walker_env_t walker_env;
2141 walker_env.sp_nodes = NEW_ARR_F(ir_node*, 0);
2142 walker_env.arch_env = birg->main_env->arch_env;
2143 isa = walker_env.arch_env->isa;
2145 irg_walk_graph(birg->irg, collect_stack_nodes_walker, NULL, &walker_env);
2147 /* nothing to be done if we didn't find any node, in fact we mustn't
2148 * continue, as for endless loops incsp might have had no users and is bad
2151 len = ARR_LEN(walker_env.sp_nodes);
2153 DEL_ARR_F(walker_env.sp_nodes);
2157 be_ssa_construction_init(&senv, birg);
2158 be_ssa_construction_add_copies(&senv, walker_env.sp_nodes,
2159 ARR_LEN(walker_env.sp_nodes));
2160 be_ssa_construction_fix_users_array(&senv, walker_env.sp_nodes,
2161 ARR_LEN(walker_env.sp_nodes));
2164 len = ARR_LEN(walker_env.sp_nodes);
2165 for(i = 0; i < len; ++i) {
2166 be_liveness_update(lv, walker_env.sp_nodes[i]);
2168 be_ssa_construction_update_liveness_phis(&senv, lv);
2171 phis = be_ssa_construction_get_new_phis(&senv);
2173 /* set register requirements for stack phis */
2174 len = ARR_LEN(phis);
2175 for(i = 0; i < len; ++i) {
2176 ir_node *phi = phis[i];
2177 be_set_phi_reg_req(walker_env.arch_env, phi, &env->sp_req);
2178 be_set_phi_flags(walker_env.arch_env, phi, arch_irn_flags_ignore | arch_irn_flags_modify_sp);
2179 arch_set_irn_register(walker_env.arch_env, phi, env->isa->sp);
2181 be_ssa_construction_destroy(&senv);
2183 DEL_ARR_F(walker_env.sp_nodes);
2186 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
2188 const arch_env_t *arch_env = env->birg->main_env->arch_env;
2189 int omit_fp = env->call->flags.bits.try_omit_fp;
2192 sched_foreach(bl, irn) {
2196 Check, if the node relates to an entity on the stack frame.
2197 If so, set the true offset (including the bias) for that
2200 ir_entity *ent = arch_get_frame_entity(arch_env, irn);
2202 int offset = get_stack_entity_offset(env->frame, ent, bias);
2203 arch_set_frame_offset(arch_env, irn, offset);
2204 DBG((env->dbg, LEVEL_2, "%F has offset %d (including bias %d)\n", ent, offset, bias));
2207 if(omit_fp || be_is_IncSP(irn)) {
2209 * If the node modifies the stack pointer by a constant offset,
2210 * record that in the bias.
2212 ofs = arch_get_sp_bias(arch_env, irn);
2214 if(be_is_IncSP(irn)) {
2215 if(ofs == BE_STACK_FRAME_SIZE_EXPAND) {
2216 ofs = (int)get_type_size_bytes(get_irg_frame_type(env->birg->irg));
2217 be_set_IncSP_offset(irn, ofs);
2218 } else if(ofs == BE_STACK_FRAME_SIZE_SHRINK) {
2219 ofs = - (int)get_type_size_bytes(get_irg_frame_type(env->birg->irg));
2220 be_set_IncSP_offset(irn, ofs);
2233 * A helper struct for the bias walker.
2236 be_abi_irg_t *env; /**< The ABI irg environment. */
2237 int start_block_bias; /**< The bias at the end of the start block. */
2238 ir_node *start_block; /**< The start block of the current graph. */
2242 * Block-Walker: fix all stack offsets
2244 static void stack_bias_walker(ir_node *bl, void *data)
2246 struct bias_walk *bw = data;
2247 if (bl != bw->start_block) {
2248 process_stack_bias(bw->env, bl, bw->start_block_bias);
2252 void be_abi_fix_stack_bias(be_abi_irg_t *env)
2254 ir_graph *irg = env->birg->irg;
2255 struct bias_walk bw;
2257 stack_frame_compute_initial_offset(env->frame);
2258 // stack_layout_dump(stdout, env->frame);
2260 /* Determine the stack bias at the end of the start block. */
2261 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
2263 /* fix the bias is all other blocks */
2265 bw.start_block = get_irg_start_block(irg);
2266 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
2269 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
2271 assert(arch_register_type_is(reg, callee_save));
2272 assert(pmap_contains(abi->regs, (void *) reg));
2273 return pmap_get(abi->regs, (void *) reg);
2276 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg)
2278 assert(arch_register_type_is(reg, ignore));
2279 assert(pmap_contains(abi->regs, (void *) reg));
2280 return pmap_get(abi->regs, (void *) reg);
2284 * Returns non-zero if the ABI has omitted the frame pointer in
2285 * the current graph.
2287 int be_abi_omit_fp(const be_abi_irg_t *abi) {
2288 return abi->call->flags.bits.try_omit_fp;