4 * @author Sebastian Hack
16 #include "irgraph_t.h"
19 #include "iredges_t.h"
22 #include "irprintf_t.h"
30 #include "besched_t.h"
32 #define MAX(x, y) ((x) > (y) ? (x) : (y))
33 #define MIN(x, y) ((x) < (y) ? (x) : (y))
35 typedef struct _be_abi_call_arg_t {
38 unsigned on_stack : 1;
41 const arch_register_t *reg;
45 struct _be_abi_call_t {
46 be_abi_call_flags_t flags;
47 const be_abi_callbacks_t *cb;
52 #define N_FRAME_TYPES 3
54 typedef struct _be_stack_frame_t {
59 type *order[N_FRAME_TYPES]; /**< arg, between and frame types ordered. */
65 struct _be_stack_slot_t {
66 struct _be_stack_frame_t *frame;
70 struct _be_abi_irg_t {
72 firm_dbg_module_t *dbg; /**< The debugging module. */
73 be_stack_frame_t *frame; /**< The stack frame model. */
74 const be_irg_t *birg; /**< The back end IRG. */
75 const arch_isa_t *isa; /**< The isa. */
76 survive_dce_t *dce_survivor;
78 be_abi_call_t *call; /**< The ABI call information. */
79 type *method_type; /**< The type of the method of the IRG. */
81 ir_node *init_sp; /**< The node representing the stack pointer
82 at the start of the function. */
84 ir_node *reg_params; /**< The reg params node. */
85 pmap *regs; /**< A map of all callee-save and ignore regs to
86 their Projs to the RegParams node. */
88 pset *stack_phis; /**< The set of all Phi nodes inserted due to
89 stack pointer modifying nodes. */
91 int start_block_bias; /**< The stack bias at the end of the start block. */
93 void *cb; /**< ABI Callback self pointer. */
95 arch_irn_handler_t irn_handler;
96 arch_irn_ops_t irn_ops;
99 #define abi_offset_of(type,member) ((char *) &(((type *) 0)->member) - (char *) 0)
100 #define abi_get_relative(ptr, member) ((void *) ((char *) (ptr) - abi_offset_of(be_abi_irg_t, member)))
101 #define get_abi_from_handler(ptr) abi_get_relative(ptr, irn_handler)
102 #define get_abi_from_ops(ptr) abi_get_relative(ptr, irn_ops)
104 /* Forward, since be need it in be_abi_introduce(). */
105 static const arch_irn_ops_if_t abi_irn_ops;
106 static const arch_irn_handler_t abi_irn_handler;
109 _ ____ ___ ____ _ _ _ _
110 / \ | __ )_ _| / ___|__ _| | | |__ __ _ ___| | _____
111 / _ \ | _ \| | | | / _` | | | '_ \ / _` |/ __| |/ / __|
112 / ___ \| |_) | | | |__| (_| | | | |_) | (_| | (__| <\__ \
113 /_/ \_\____/___| \____\__,_|_|_|_.__/ \__,_|\___|_|\_\___/
115 These callbacks are used by the backend to set the parameters
116 for a specific call type.
119 static int cmp_call_arg(const void *a, const void *b, size_t n)
121 const be_abi_call_arg_t *p = a, *q = b;
122 return !(p->is_res == q->is_res && p->pos == q->pos);
125 static be_abi_call_arg_t *get_or_set_call_arg(be_abi_call_t *call, int is_res, int pos, int do_insert)
127 be_abi_call_arg_t arg;
130 memset(&arg, 0, sizeof(arg));
134 hash = is_res * 100 + pos;
137 ? set_insert(call->params, &arg, sizeof(arg), hash)
138 : set_find(call->params, &arg, sizeof(arg), hash);
141 static INLINE be_abi_call_arg_t *get_call_arg(be_abi_call_t *call, int is_res, int pos)
143 return get_or_set_call_arg(call, is_res, pos, 0);
146 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb)
152 void be_abi_call_param_stack(be_abi_call_t *call, int arg_pos)
154 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
158 void be_abi_call_param_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
160 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 0, arg_pos, 1);
165 void be_abi_call_res_reg(be_abi_call_t *call, int arg_pos, const arch_register_t *reg)
167 be_abi_call_arg_t *arg = get_or_set_call_arg(call, 1, arg_pos, 1);
172 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call)
177 be_abi_call_t *be_abi_call_new(void)
179 be_abi_call_t *call = malloc(sizeof(call[0]));
181 call->params = new_set(cmp_call_arg, 16);
186 void be_abi_call_free(be_abi_call_t *call)
188 del_set(call->params);
194 | ___| __ __ _ _ __ ___ ___ | | | | __ _ _ __ __| | (_)_ __ __ _
195 | |_ | '__/ _` | '_ ` _ \ / _ \ | |_| |/ _` | '_ \ / _` | | | '_ \ / _` |
196 | _|| | | (_| | | | | | | __/ | _ | (_| | | | | (_| | | | | | | (_| |
197 |_| |_| \__,_|_| |_| |_|\___| |_| |_|\__,_|_| |_|\__,_|_|_|_| |_|\__, |
200 Handling of the stack frame. It is composed of three types:
201 1) The type of the arguments which are pushed on the stack.
202 2) The "between type" which consists of stuff the call of the
203 function pushes on the stack (like the return address and
204 the old base pointer for ia32).
205 3) The Firm frame type which consists of all local variables
209 static int get_stack_entity_offset(be_stack_frame_t *frame, entity *ent, int bias)
211 type *t = get_entity_owner(ent);
212 int ofs = get_entity_offset_bytes(ent);
216 /* Find the type the entity is contained in. */
217 for(index = 0; index < N_FRAME_TYPES; ++index) {
218 if(frame->order[index] == t)
222 /* Add the size of all the types below the one of the entity to the entity's offset */
223 for(i = 0; i < index; ++i)
224 ofs += get_type_size_bytes(frame->order[i]);
226 /* correct the offset by the initial position of the frame pointer */
227 ofs -= frame->initial_offset;
229 /* correct the offset with the current bias. */
235 static entity *search_ent_with_offset(type *t, int offset)
239 for(i = 0, n = get_class_n_members(t); i < n; ++i) {
240 entity *ent = get_class_member(t, i);
241 if(get_entity_offset_bytes(ent) == offset)
248 static int stack_frame_compute_initial_offset(be_stack_frame_t *frame)
250 type *base = frame->stack_dir < 0 ? frame->between_type : frame->frame_type;
251 entity *ent = search_ent_with_offset(base, 0);
252 frame->initial_offset = 0;
253 frame->initial_offset = get_stack_entity_offset(frame, ent, 0);
254 return frame->initial_offset;
257 static be_stack_frame_t *stack_frame_init(be_stack_frame_t *frame, type *args, type *between, type *locals, int stack_dir)
259 frame->arg_type = args;
260 frame->between_type = between;
261 frame->frame_type = locals;
262 frame->initial_offset = 0;
263 frame->stack_dir = stack_dir;
264 frame->order[1] = between;
267 frame->order[0] = args;
268 frame->order[2] = locals;
272 frame->order[0] = locals;
273 frame->order[2] = args;
279 static void stack_frame_dump(FILE *file, be_stack_frame_t *frame)
283 ir_fprintf(file, "initial offset: %d\n", frame->initial_offset);
284 for(j = 0; j < N_FRAME_TYPES; ++j) {
285 type *t = frame->order[j];
287 ir_fprintf(file, "type %d: %Fm size: %d\n", j, t, get_type_size_bytes(t));
288 for(i = 0, n = get_class_n_members(t); i < n; ++i) {
289 entity *ent = get_class_member(t, i);
290 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));
296 * If irn is a Sel node computing the address of an entity
297 * on the frame type return the entity, else NULL.
299 static INLINE entity *get_sel_ent(ir_node *irn)
301 if(get_irn_opcode(irn) == iro_Sel
302 && get_Sel_ptr(irn) == get_irg_frame(get_irn_irg(irn))) {
304 return get_Sel_entity(irn);
311 * Walker: Replaces Loads, Stores and Sels of frame type entities
312 * by FrameLoad, FrameStore and FrameAdress.
314 static void lower_frame_sels_walker(ir_node *irn, void *data)
317 entity *ent = get_sel_ent(irn);
320 be_abi_irg_t *env = data;
321 ir_node *bl = get_nodes_block(irn);
322 ir_graph *irg = get_irn_irg(bl);
323 ir_node *frame = get_irg_frame(irg);
325 nw = be_new_FrameAddr(env->isa->sp->reg_class, irg, bl, frame, ent);
332 static INLINE int is_on_stack(be_abi_call_t *call, int pos)
334 be_abi_call_arg_t *arg = get_call_arg(call, 0, pos);
335 return arg && !arg->in_reg;
345 Adjustment of the calls inside a graph.
350 * Transform a call node.
351 * @param env The ABI environment for the current irg.
352 * @param irn The call node.
353 * @param curr_sp The stack pointer node to use.
354 * @return The stack pointer after the call.
356 static ir_node *adjust_call(be_abi_irg_t *env, ir_node *irn, ir_node *curr_sp)
358 ir_graph *irg = env->birg->irg;
359 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
360 be_abi_call_t *call = be_abi_call_new();
361 ir_type *mt = get_Call_type(irn);
362 ir_node *call_ptr = get_Call_ptr(irn);
363 int n_params = get_method_n_params(mt);
364 ir_node *curr_mem = get_Call_mem(irn);
365 ir_node *bl = get_nodes_block(irn);
366 pset *results = pset_new_ptr(8);
367 pset *caller_save = pset_new_ptr(8);
369 int stack_dir = arch_isa_stack_dir(isa);
370 const arch_register_t *sp = arch_isa_sp(isa);
371 ir_mode *mach_mode = sp->reg_class->mode;
372 struct obstack *obst = &env->obst;
373 ir_node *no_mem = get_irg_no_mem(irg);
375 ir_node *res_proj = NULL;
376 int curr_res_proj = pn_Call_max;
383 const ir_edge_t *edge;
388 /* Let the isa fill out the abi description for that call node. */
389 arch_isa_get_call_abi(isa, mt, call);
391 /* Insert code to put the stack arguments on the stack. */
392 assert(get_Call_n_params(irn) == n_params);
393 for(i = 0; i < n_params; ++i) {
394 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
397 stack_size += get_type_size_bytes(get_method_param_type(mt, i));
398 obstack_int_grow(obst, i);
402 pos = obstack_finish(obst);
404 /* Collect all arguments which are passed in registers. */
405 for(i = 0, n = get_Call_n_params(irn); i < n; ++i) {
406 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
407 if(arg && arg->in_reg) {
408 obstack_int_grow(obst, i);
412 low_args = obstack_finish(obst);
414 /* If there are some parameters which shall be passed on the stack. */
417 int do_seq = call->flags.bits.store_args_sequential;
419 /* Reverse list of stack parameters if call arguments are from left to right */
420 if(call->flags.bits.left_to_right) {
421 for(i = 0; i < n_pos / 2; ++i) {
422 int other = n_pos - i - 1;
430 * If the stack is decreasing and we do not want to store sequentially,
431 * we allocate as much space on the stack all parameters need, by
432 * moving the stack pointer along the stack's direction.
434 if(stack_dir < 0 && !do_seq) {
435 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, no_mem, stack_size, be_stack_dir_along);
438 assert(mode_is_reference(mach_mode) && "machine mode must be pointer");
439 for(i = 0; i < n_pos; ++i) {
441 ir_node *param = get_Call_param(irn, p);
442 ir_node *addr = curr_sp;
444 type *param_type = get_method_param_type(mt, p);
445 int param_size = get_type_size_bytes(param_type);
447 /* Make the expression to compute the argument's offset. */
449 addr = new_r_Const_long(irg, bl, mode_Is, curr_ofs);
450 addr = new_r_Add(irg, bl, curr_sp, addr, mach_mode);
453 /* Insert a store for primitive arguments. */
454 if(is_atomic_type(param_type)) {
455 mem = new_r_Store(irg, bl, curr_mem, addr, param);
456 mem = new_r_Proj(irg, bl, mem, mode_M, pn_Store_M);
459 /* Make a memcopy for compound arguments. */
461 assert(mode_is_reference(get_irn_mode(param)));
462 mem = new_r_CopyB(irg, bl, curr_mem, addr, param, param_type);
463 mem = new_r_Proj(irg, bl, mem, mode_M, pn_CopyB_M_regular);
466 obstack_ptr_grow(obst, mem);
468 curr_ofs += param_size;
471 * If we wanted to build the arguments sequentially,
472 * the stack pointer for the next must be incremented,
473 * and the memory value propagated.
477 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, no_mem, param_size, be_stack_dir_along);
482 in = (ir_node **) obstack_finish(obst);
484 /* We need the sync only, if we didn't build the stores sequentially. */
486 curr_mem = new_r_Sync(irg, bl, n_pos, in);
487 obstack_free(obst, in);
490 /* Collect caller save registers */
491 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
493 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
494 for(j = 0; j < cls->n_regs; ++j) {
495 const arch_register_t *reg = arch_register_for_index(cls, j);
496 if(arch_register_type_is(reg, caller_save))
497 pset_insert_ptr(caller_save, (void *) reg);
501 /* search the greatest result proj number */
502 foreach_out_edge(irn, edge) {
503 const ir_edge_t *res_edge;
504 ir_node *irn = get_edge_src_irn(edge);
506 if(is_Proj(irn) && get_irn_mode(irn) == mode_T) {
508 foreach_out_edge(irn, res_edge) {
510 be_abi_call_arg_t *arg;
511 ir_node *res = get_edge_src_irn(res_edge);
513 assert(is_Proj(res));
515 proj = get_Proj_proj(res);
516 arg = get_call_arg(call, 1, proj);
519 shift the proj number to the right, since we will drop the
520 unspeakable Proj_T from the Call. Therefore, all real argument
521 Proj numbers must be increased by pn_Call_max
524 set_Proj_proj(res, proj);
525 obstack_ptr_grow(obst, res);
527 if(proj > curr_res_proj)
528 curr_res_proj = proj;
530 pset_remove_ptr(caller_save, arg->reg);
535 obstack_ptr_grow(obst, NULL);
536 res_projs = obstack_finish(obst);
538 /* make the back end call node and set its register requirements. */
539 for(i = 0; i < n_low_args; ++i)
540 obstack_ptr_grow(obst, get_Call_param(irn, low_args[i]));
542 in = obstack_finish(obst);
543 if(env->call->flags.bits.call_has_imm && get_irn_opcode(call_ptr) == iro_SymConst) {
544 low_call = be_new_Call(irg, bl, curr_mem, curr_sp, curr_sp, curr_res_proj, n_low_args, in);
545 be_Call_set_entity(low_call, get_SymConst_entity(call_ptr));
549 low_call = be_new_Call(irg, bl, curr_mem, curr_sp, call_ptr, curr_res_proj, n_low_args, in);
551 /* Set the register classes and constraints of the Call parameters. */
552 for(i = 0; i < n_low_args; ++i) {
553 int index = low_args[i];
554 be_abi_call_arg_t *arg = get_call_arg(call, 0, index);
555 assert(arg->reg != NULL);
556 be_set_constr_single_reg(low_call, index, arg->reg);
559 /* Set the register constraints of the results. */
560 for(i = 0; res_projs[i]; ++i) {
561 ir_node *irn = res_projs[i];
562 int proj = get_Proj_proj(irn);
564 /* Correct Proj number since it has been adjusted! (see above) */
565 const be_abi_call_arg_t *arg = get_call_arg(call, 1, proj - pn_Call_max);
568 be_set_constr_single_reg(low_call, BE_OUT_POS(proj), arg->reg);
570 obstack_free(obst, in);
571 exchange(irn, low_call);
573 /* redirect the result projs to the lowered call instead of the Proj_T */
574 for(i = 0; res_projs[i]; ++i)
575 set_Proj_pred(res_projs[i], low_call);
577 /* Make additional projs for the caller save registers
578 and the Keep node which keeps them alive. */
579 if(pset_count(caller_save) > 0) {
580 const arch_register_t *reg;
584 for(reg = pset_first(caller_save), n = 0; reg; reg = pset_next(caller_save), ++n) {
585 ir_node *proj = new_r_Proj(irg, bl, low_call, reg->reg_class->mode, curr_res_proj++);
587 /* memorize the register in the link field. we need afterwards to set the register class of the keep correctly. */
588 set_irn_link(proj, (void *) reg);
589 obstack_ptr_grow(obst, proj);
592 in = (ir_node **) obstack_finish(obst);
593 keep = be_new_Keep(NULL, irg, bl, n, in);
594 for(i = 0; i < n; ++i) {
595 const arch_register_t *reg = get_irn_link(in[i]);
596 be_node_set_reg_class(keep, i, reg->reg_class);
598 obstack_free(obst, in);
601 /* Clean up the stack. */
603 ir_node *mem_proj = NULL;
605 foreach_out_edge(low_call, edge) {
606 ir_node *irn = get_edge_src_irn(edge);
607 if(is_Proj(irn) && get_Proj_proj(irn) == pn_Call_M) {
614 mem_proj = new_r_Proj(irg, bl, low_call, mode_M, pn_Call_M);
616 /* Make a Proj for the stack pointer. */
617 curr_sp = be_new_IncSP(sp, irg, bl, curr_sp, mem_proj, stack_size, be_stack_dir_against);
620 be_abi_call_free(call);
621 obstack_free(obst, pos);
623 del_pset(caller_save);
630 * The alloca is transformed into a back end alloca node and connected to the stack nodes.
632 static ir_node *adjust_alloc(be_abi_irg_t *env, ir_node *alloc, ir_node *curr_sp)
634 if(get_Alloc_where(alloc) == stack_alloc) {
635 ir_node *bl = get_nodes_block(alloc);
636 ir_graph *irg = get_irn_irg(bl);
637 ir_node *alloc_mem = NULL;
638 ir_node *alloc_res = NULL;
640 const ir_edge_t *edge;
643 env->call->flags.bits.try_omit_fp = 0;
645 new_alloc = be_new_AddSP(env->isa->sp, irg, bl, curr_sp, get_Alloc_size(alloc));
647 foreach_out_edge(alloc, edge) {
648 ir_node *irn = get_edge_src_irn(edge);
650 assert(is_Proj(irn));
651 switch(get_Proj_proj(irn)) {
663 assert(alloc_res != NULL);
664 exchange(alloc_res, env->isa->stack_dir < 0 ? new_alloc : curr_sp);
666 if(alloc_mem != NULL)
667 exchange(alloc_mem, new_r_NoMem(irg));
676 * Walker for dependent_on().
677 * This function searches a node tgt recursively from a given node
678 * but is restricted to the given block.
679 * @return 1 if tgt was reachable from curr, 0 if not.
681 static int check_dependence(ir_node *curr, ir_node *tgt, ir_node *bl, unsigned long visited_nr)
685 if(get_irn_visited(curr) >= visited_nr)
688 set_irn_visited(curr, visited_nr);
689 if(get_nodes_block(curr) != bl)
695 for(i = 0, n = get_irn_arity(curr); i < n; ++i) {
696 if(check_dependence(get_irn_n(curr, i), tgt, bl, visited_nr))
704 * Check if a node is somehow data dependent on another one.
705 * both nodes must be in the same basic block.
706 * @param n1 The first node.
707 * @param n2 The second node.
708 * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
710 static int dependent_on(ir_node *n1, ir_node *n2)
712 ir_node *bl = get_nodes_block(n1);
713 ir_graph *irg = get_irn_irg(bl);
714 long vis_nr = get_irg_visited(irg) + 1;
716 assert(bl == get_nodes_block(n2));
717 set_irg_visited(irg, vis_nr);
718 return check_dependence(n1, n2, bl, vis_nr);
721 static int cmp_call_dependecy(const void *c1, const void *c2)
723 ir_node *n1 = *(ir_node **) c1;
724 ir_node *n2 = *(ir_node **) c2;
727 Classical qsort() comparison function behavior:
728 0 if both elements are equal
729 1 if second is "smaller" that first
730 -1 if first is "smaller" that second
732 return n1 == n2 ? 0 : (dependent_on(n1, n2) ? -1 : 1);
735 static void link_calls_in_block_walker(ir_node *irn, void *data)
738 ir_node *bl = get_nodes_block(irn);
739 void *save = get_irn_link(bl);
741 set_irn_link(irn, save);
742 set_irn_link(bl, irn);
747 * Process all call nodes inside a basic block.
748 * Note that the link field of the block must contain a linked list of all
749 * Call nodes inside the block. We first order this list according to data dependency
750 * and that connect the calls together.
752 static void process_calls_in_block(ir_node *bl, void *data)
754 be_abi_irg_t *env = data;
755 ir_node *curr_sp = env->init_sp;
759 for(irn = get_irn_link(bl), n = 0; irn; irn = get_irn_link(irn), ++n)
760 obstack_ptr_grow(&env->obst, irn);
762 /* If there were call nodes in the block. */
767 nodes = obstack_finish(&env->obst);
769 /* order the call nodes according to data dependency */
770 qsort(nodes, n, sizeof(nodes[0]), cmp_call_dependecy);
772 for(i = n - 1; i >= 0; --i) {
773 ir_node *irn = nodes[i];
775 switch(get_irn_opcode(irn)) {
777 curr_sp = adjust_call(env, irn, curr_sp);
780 curr_sp = adjust_alloc(env, irn, curr_sp);
787 obstack_free(&env->obst, nodes);
789 /* Keep the last stack state in the block by tying it to Keep node */
791 be_new_Keep(env->isa->sp->reg_class, get_irn_irg(bl), bl, 1, nodes);
794 set_irn_link(bl, curr_sp);
798 * Adjust all call nodes in the graph to the ABI conventions.
800 static void process_calls(be_abi_irg_t *env)
802 ir_graph *irg = env->birg->irg;
804 irg_walk_graph(irg, firm_clear_link, link_calls_in_block_walker, NULL);
805 irg_block_walk_graph(irg, NULL, process_calls_in_block, env);
808 static void collect_return_walker(ir_node *irn, void *data)
810 if(get_irn_opcode(irn) == iro_Return) {
811 struct obstack *obst = data;
812 obstack_ptr_grow(obst, irn);
816 static ir_node *setup_frame(be_abi_irg_t *env)
818 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
819 const arch_register_t *sp = isa->sp;
820 const arch_register_t *bp = isa->bp;
821 be_abi_call_flags_bits_t flags = env->call->flags.bits;
822 ir_graph *irg = env->birg->irg;
823 ir_node *bl = get_irg_start_block(irg);
824 ir_node *no_mem = get_irg_no_mem(irg);
825 ir_node *old_frame = get_irg_frame(irg);
826 ir_node *stack = pmap_get(env->regs, (void *) sp);
827 ir_node *frame = pmap_get(env->regs, (void *) bp);
829 int stack_nr = get_Proj_proj(stack);
831 if(flags.try_omit_fp) {
832 stack = be_new_IncSP(sp, irg, bl, stack, no_mem, BE_STACK_FRAME_SIZE, be_stack_dir_along);
837 frame = be_new_Copy(bp->reg_class, irg, bl, stack);
839 be_node_set_flags(frame, -1, arch_irn_flags_dont_spill);
841 be_set_constr_single_reg(frame, -1, bp);
842 be_node_set_flags(frame, -1, arch_irn_flags_ignore);
843 arch_set_irn_register(env->birg->main_env->arch_env, frame, bp);
846 stack = be_new_IncSP(sp, irg, bl, stack, frame, BE_STACK_FRAME_SIZE, be_stack_dir_along);
849 be_node_set_flags(env->reg_params, -(stack_nr + 1), arch_irn_flags_ignore);
850 env->init_sp = stack;
851 set_irg_frame(irg, frame);
852 edges_reroute(old_frame, frame, irg);
857 static void clearup_frame(be_abi_irg_t *env, ir_node *ret, pmap *reg_map, struct obstack *obst)
859 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
860 const arch_register_t *sp = isa->sp;
861 const arch_register_t *bp = isa->bp;
862 ir_graph *irg = env->birg->irg;
863 ir_node *ret_mem = get_Return_mem(ret);
864 ir_node *frame = get_irg_frame(irg);
865 ir_node *bl = get_nodes_block(ret);
866 ir_node *stack = get_irn_link(bl);
870 if(env->call->flags.bits.try_omit_fp) {
871 stack = be_new_IncSP(sp, irg, bl, stack, ret_mem, BE_STACK_FRAME_SIZE, be_stack_dir_against);
875 stack = be_new_SetSP(sp, irg, bl, stack, frame, ret_mem);
876 be_set_constr_single_reg(stack, -1, sp);
877 be_node_set_flags(stack, -1, arch_irn_flags_ignore);
880 pmap_foreach(env->regs, ent) {
881 const arch_register_t *reg = ent->key;
882 ir_node *irn = ent->value;
889 obstack_ptr_grow(obst, irn);
893 static ir_type *compute_arg_type(be_abi_irg_t *env, be_abi_call_t *call, ir_type *method_type)
895 int dir = env->call->flags.bits.left_to_right ? 1 : -1;
896 int inc = env->birg->main_env->arch_env->isa->stack_dir * dir;
897 int n = get_method_n_params(method_type);
898 int curr = inc > 0 ? 0 : n - 1;
905 snprintf(buf, sizeof(buf), "%s_arg_type", get_entity_name(get_irg_entity(env->birg->irg)));
906 res = new_type_class(new_id_from_str(buf));
908 for(i = 0; i < n; ++i, curr += inc) {
909 type *param_type = get_method_param_type(method_type, curr);
910 be_abi_call_arg_t *arg = get_call_arg(call, 0, curr);
913 snprintf(buf, sizeof(buf), "param_%d", i);
914 arg->stack_ent = new_entity(res, new_id_from_str(buf), param_type);
915 set_entity_offset_bytes(arg->stack_ent, ofs);
916 ofs += get_type_size_bytes(param_type);
920 set_type_size_bytes(res, ofs);
924 static void create_register_perms(const arch_isa_t *isa, ir_graph *irg, ir_node *bl, pmap *regs)
931 /* Create a Perm after the RegParams node to delimit it. */
932 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
933 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
938 for(n_regs = 0, j = 0; j < cls->n_regs; ++j) {
939 const arch_register_t *reg = &cls->regs[j];
940 ir_node *irn = pmap_get(regs, (void *) reg);
942 if(irn && !arch_register_type_is(reg, ignore)) {
944 obstack_ptr_grow(&obst, irn);
945 set_irn_link(irn, (void *) reg);
949 obstack_ptr_grow(&obst, NULL);
950 in = obstack_finish(&obst);
952 perm = be_new_Perm(cls, irg, bl, n_regs, in);
953 for(j = 0; j < n_regs; ++j) {
954 ir_node *arg = in[j];
955 arch_register_t *reg = get_irn_link(arg);
956 pmap_insert(regs, reg, arg);
957 be_set_constr_single_reg(perm, BE_OUT_POS(j), reg);
960 obstack_free(&obst, in);
963 obstack_free(&obst, NULL);
966 static void create_barrier(be_abi_irg_t *env, ir_node *bl, ir_node **mem, pmap *regs)
968 ir_graph *irg = env->birg->irg;
975 for(ent = pmap_first(regs), n = 0; ent; ent = pmap_next(regs), ++n)
976 obstack_ptr_grow(&env->obst, ent->value);
979 obstack_ptr_grow(&env->obst, *mem);
983 in = (ir_node **) obstack_finish(&env->obst);
984 irn = be_new_Barrier(env->birg->irg, bl, n, in);
985 obstack_free(&env->obst, in);
987 for(ent = pmap_first(regs), n = 0; ent; ent = pmap_next(regs), ++n) {
988 int pos = BE_OUT_POS(n);
989 const arch_register_t *reg = ent->key;
991 ent->value = new_r_Proj(env->birg->irg, bl, irn, get_irn_mode(ent->value), n);
992 be_set_constr_single_reg(irn, n, reg);
993 be_set_constr_single_reg(irn, pos, reg);
994 be_node_set_reg_class(irn, pos, reg->reg_class);
995 arch_set_irn_register(env->birg->main_env->arch_env, ent->value, reg);
996 if(arch_register_type_is(reg, ignore))
997 be_node_set_flags(irn, pos, arch_irn_flags_ignore);
1001 *mem = new_r_Proj(env->birg->irg, bl, irn, mode_M, n);
1006 * Modify the irg itself and the frame type.
1008 static void modify_irg(be_abi_irg_t *env)
1010 firm_dbg_module_t *dbg = env->dbg;
1011 be_abi_call_t *call = env->call;
1012 const arch_isa_t *isa = env->birg->main_env->arch_env->isa;
1013 const arch_register_t *sp = arch_isa_sp(isa);
1014 ir_graph *irg = env->birg->irg;
1015 ir_node *bl = get_irg_start_block(irg);
1016 ir_node *end = get_irg_end_block(irg);
1017 ir_node *arg_tuple = get_irg_args(irg);
1018 ir_node *no_mem = get_irg_no_mem(irg);
1019 type *method_type = get_entity_type(get_irg_entity(irg));
1020 pset *dont_save = pset_new_ptr(8);
1021 pmap *reg_proj_map = pmap_create();
1022 int n_params = get_method_n_params(method_type);
1028 const arch_register_t *fp_reg;
1029 ir_node *frame_pointer;
1030 ir_node *reg_params_bl;
1032 const ir_edge_t *edge;
1033 ir_type *arg_type, *bet_type;
1036 bitset_t *used_proj_nr;
1038 DBG((dbg, LEVEL_1, "introducing abi on %+F\n", irg));
1040 /* Convert the Sel nodes in the irg to frame load/store/addr nodes. */
1041 irg_walk_graph(irg, lower_frame_sels_walker, NULL, env);
1043 env->frame = obstack_alloc(&env->obst, sizeof(env->frame[0]));
1044 env->regs = pmap_create();
1046 /* Find the maximum proj number of the argument tuple proj */
1047 foreach_out_edge(arg_tuple, edge) {
1048 ir_node *irn = get_edge_src_irn(edge);
1049 int nr = get_Proj_proj(irn);
1050 max_arg = MAX(max_arg, nr);
1053 args = obstack_alloc(&env->obst, max_arg * sizeof(args[0]));
1054 memset(args, 0, max_arg * sizeof(args[0]));
1055 used_proj_nr = bitset_alloca(1024);
1057 /* Fill the argument vector */
1058 foreach_out_edge(arg_tuple, edge) {
1059 ir_node *irn = get_edge_src_irn(edge);
1060 int nr = get_Proj_proj(irn);
1062 DBG((dbg, LEVEL_2, "\treading arg: %d -> %+F\n", nr, irn));
1065 arg_type = compute_arg_type(env, call, method_type);
1066 bet_type = call->cb->get_between_type(env->cb);
1067 stack_frame_init(env->frame, arg_type, bet_type, get_irg_frame_type(irg), isa->stack_dir);
1069 /* Count the register params and add them to the number of Projs for the RegParams node */
1070 for(i = 0; i < n_params; ++i) {
1071 be_abi_call_arg_t *arg = get_call_arg(call, 0, i);
1073 assert(arg->reg != sp && "cannot use stack pointer as parameter register");
1074 assert(i == get_Proj_proj(args[i]));
1076 /* For now, associate the register with the old Proj from Start representing that argument. */
1077 pmap_insert(env->regs, (void *) arg->reg, args[i]);
1078 bitset_set(used_proj_nr, i);
1079 DBG((dbg, LEVEL_2, "\targ #%d -> reg %s\n", i, arg->reg->name));
1083 /* Collect all callee-save registers */
1084 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
1085 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
1086 for(j = 0; j < cls->n_regs; ++j) {
1087 const arch_register_t *reg = &cls->regs[j];
1088 if(arch_register_type_is(reg, callee_save))
1089 pmap_insert(env->regs, (void *) reg, NULL);
1093 pmap_insert(env->regs, (void *) sp, NULL);
1094 pmap_insert(env->regs, (void *) isa->bp, NULL);
1095 reg_params_bl = get_irg_start_block(irg);
1096 env->reg_params = be_new_RegParams(irg, reg_params_bl, pmap_count(env->regs));
1099 * make proj nodes for the callee save registers.
1100 * memorize them, since Return nodes get those as inputs.
1102 * Note, that if a register corresponds to an argument, the regs map contains
1103 * the old Proj from start for that argument.
1105 pmap_foreach(env->regs, ent) {
1106 arch_register_t *reg = ent->key;
1107 ir_node *arg_proj = ent->value;
1108 ir_mode *mode = arg_proj ? get_irn_mode(arg_proj) : reg->reg_class->mode;
1109 long nr = arg_proj ? get_Proj_proj(arg_proj) : (long) bitset_next_clear(used_proj_nr, 0);
1110 int pos = BE_OUT_POS((int) nr);
1113 bitset_set(used_proj_nr, nr);
1114 ent->value = new_r_Proj(irg, reg_params_bl, env->reg_params, mode, nr);
1115 be_set_constr_single_reg(env->reg_params, pos, reg);
1116 arch_set_irn_register(env->birg->main_env->arch_env, ent->value, reg);
1119 * If the register is an ignore register,
1120 * The Proj for that register shall also be ignored during register allocation.
1122 if(arch_register_type_is(reg, ignore))
1123 be_node_set_flags(env->reg_params, pos, arch_irn_flags_ignore);
1125 DBG((dbg, LEVEL_2, "\tregister save proj #%d -> reg %s\n", nr, reg->name));
1128 /* Generate the Prologue */
1129 fp_reg = call->cb->prologue(env->cb, env->regs);
1130 create_barrier(env, bl, NULL, env->regs);
1131 env->init_sp = pmap_get(env->regs, (void *) sp);
1132 env->init_sp = be_new_IncSP(sp, irg, bl, env->init_sp, no_mem, BE_STACK_FRAME_SIZE, be_stack_dir_along);
1133 arch_set_irn_register(env->birg->main_env->arch_env, env->init_sp, sp);
1134 pmap_insert(env->regs, (void *) sp, env->init_sp);
1135 frame_pointer = pmap_get(env->regs, (void *) fp_reg);
1136 set_irg_frame(irg, frame_pointer);
1138 /* Now, introduce stack param nodes for all parameters passed on the stack */
1139 for(i = 0; i < max_arg; ++i) {
1140 ir_node *arg_proj = args[i];
1141 ir_node *repl = NULL;
1143 if(arg_proj != NULL) {
1144 be_abi_call_arg_t *arg;
1145 ir_type *param_type;
1146 int nr = get_Proj_proj(arg_proj);
1148 nr = MIN(nr, n_params);
1149 arg = get_call_arg(call, 0, nr);
1150 param_type = get_method_param_type(method_type, nr);
1153 repl = pmap_get(env->regs, (void *) arg->reg);
1156 else if(arg->on_stack) {
1157 /* For atomic parameters which are actually used, we create a StackParam node. */
1158 if(is_atomic_type(param_type) && get_irn_n_edges(args[i]) > 0) {
1159 ir_mode *mode = get_type_mode(param_type);
1160 const arch_register_class_t *cls = arch_isa_get_reg_class_for_mode(isa, mode);
1161 repl = be_new_StackParam(cls, isa->bp->reg_class, irg, reg_params_bl, mode, frame_pointer, arg->stack_ent);
1164 /* The stack parameter is not primitive (it is a struct or array),
1165 we thus will create a node representing the parameter's address
1168 repl = be_new_FrameAddr(sp->reg_class, irg, reg_params_bl, frame_pointer, arg->stack_ent);
1172 assert(repl != NULL);
1173 exchange(args[i], repl);
1177 /* All Return nodes hang on the End node, so look for them there. */
1178 for(i = 0, n = get_irn_arity(end); i < n; ++i) {
1179 ir_node *irn = get_irn_n(end, i);
1181 if(get_irn_opcode(irn) == iro_Return) {
1182 ir_node *bl = get_nodes_block(irn);
1183 int n_res = get_Return_n_ress(irn);
1184 pmap *reg_map = pmap_create();
1185 ir_node *mem = get_Return_mem(irn);
1190 pmap_insert(reg_map, (void *) sp, pmap_get(env->regs, (void *) sp));
1192 /* Insert results for Return into the register map. */
1193 for(i = 0; i < n_res; ++i) {
1194 ir_node *res = get_Return_res(irn, i);
1195 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1196 assert(arg->in_reg && "return value must be passed in register");
1197 pmap_insert(reg_map, (void *) arg->reg, res);
1200 /* Add uses of the callee save registers. */
1201 pmap_foreach(env->regs, ent) {
1202 const arch_register_t *reg = ent->key;
1203 if(arch_register_type_is(reg, callee_save) || arch_register_type_is(reg, ignore))
1204 pmap_insert(reg_map, ent->key, ent->value);
1207 /* Make the Epilogue node and call the arch's epilogue maker. */
1208 create_barrier(env, bl, &mem, reg_map);
1209 call->cb->epilogue(env->cb, bl, &mem, reg_map);
1211 obstack_ptr_grow(&env->obst, mem);
1212 obstack_ptr_grow(&env->obst, pmap_get(reg_map, (void *) sp));
1214 /* clear SP entry, since it has already been grown. */
1215 pmap_insert(reg_map, (void *) sp, NULL);
1216 for(i = 0; i < n_res; ++i) {
1217 ir_node *res = get_Return_res(irn, i);
1218 be_abi_call_arg_t *arg = get_call_arg(call, 1, i);
1220 obstack_ptr_grow(&env->obst, pmap_get(reg_map, (void *) arg->reg));
1222 /* Clear the map entry to mark the register as processed. */
1223 pmap_insert(reg_map, (void *) arg->reg, NULL);
1226 /* grow the rest of the stuff. */
1227 pmap_foreach(reg_map, ent) {
1229 obstack_ptr_grow(&env->obst, ent->value);
1232 /* The in array for the new back end return is now ready. */
1233 n = obstack_object_size(&env->obst) / sizeof(in[0]);
1234 in = obstack_finish(&env->obst);
1235 ret = be_new_Return(irg, bl, n, in);
1237 /* Free the space of the Epilog's in array and the register <-> proj map. */
1238 obstack_free(&env->obst, in);
1240 pmap_destroy(reg_map);
1244 obstack_free(&env->obst, args);
1248 * Walker: puts all Alloc(stack_alloc) on a obstack
1250 static void collect_alloca_walker(ir_node *irn, void *data)
1252 be_abi_irg_t *env = data;
1253 if(get_irn_opcode(irn) == iro_Alloc && get_Alloc_where(irn) == stack_alloc)
1254 obstack_ptr_grow(&env->obst, irn);
1257 be_abi_irg_t *be_abi_introduce(be_irg_t *birg)
1259 be_abi_irg_t *env = xmalloc(sizeof(env[0]));
1260 ir_node *old_frame = get_irg_frame(birg->irg);
1261 ir_graph *irg = birg->irg;
1266 env->isa = birg->main_env->arch_env->isa;
1267 env->method_type = get_entity_type(get_irg_entity(irg));
1268 env->call = be_abi_call_new();
1269 arch_isa_get_call_abi(env->isa, env->method_type, env->call);
1271 env->dce_survivor = new_survive_dce();
1273 env->dbg = firm_dbg_register("firm.be.abi");
1274 env->stack_phis = pset_new_ptr(16);
1275 env->init_sp = dummy = new_r_Unknown(irg, env->isa->sp->reg_class->mode);
1277 env->cb = env->call->cb->init(env->call, env->isa, irg);
1279 obstack_init(&env->obst);
1281 memcpy(&env->irn_handler, &abi_irn_handler, sizeof(abi_irn_handler));
1282 env->irn_ops.impl = &abi_irn_ops;
1284 /* Lower all call nodes in the IRG. */
1287 /* Process the IRG */
1290 /* reroute the stack origin of the calls to the true stack origin. */
1291 edges_reroute(dummy, env->init_sp, irg);
1292 edges_reroute(old_frame, get_irg_frame(irg), irg);
1294 /* Make some important node pointers survive the dead node elimination. */
1295 survive_dce_register_irn(env->dce_survivor, &env->init_sp);
1296 pmap_foreach(env->regs, ent)
1297 survive_dce_register_irn(env->dce_survivor, (ir_node **) &ent->value);
1299 arch_env_push_irn_handler(env->birg->main_env->arch_env, &env->irn_handler);
1301 env->call->cb->done(env->cb);
1306 void be_abi_free(be_abi_irg_t *env)
1308 free_survive_dce(env->dce_survivor);
1309 del_pset(env->stack_phis);
1310 pmap_destroy(env->regs);
1311 obstack_free(&env->obst, NULL);
1312 arch_env_pop_irn_handler(env->birg->main_env->arch_env);
1320 | ___(_)_ __ / ___|| |_ __ _ ___| | __
1321 | |_ | \ \/ / \___ \| __/ _` |/ __| |/ /
1322 | _| | |> < ___) | || (_| | (__| <
1323 |_| |_/_/\_\ |____/ \__\__,_|\___|_|\_\
1327 static void collect_stack_nodes_walker(ir_node *irn, void *data)
1331 if(be_is_AddSP(irn) || be_is_IncSP(irn) || be_is_SetSP(irn))
1332 pset_insert_ptr(s, irn);
1335 void be_abi_fix_stack_nodes(be_abi_irg_t *env)
1337 dom_front_info_t *df;
1340 /* We need dominance frontiers for fix up */
1341 df = be_compute_dominance_frontiers(env->birg->irg);
1342 stack_nodes = pset_new_ptr(16);
1343 pset_insert_ptr(stack_nodes, env->init_sp);
1344 irg_walk_graph(env->birg->irg, collect_stack_nodes_walker, NULL, stack_nodes);
1345 be_ssa_constr_set_phis(df, stack_nodes, env->stack_phis);
1346 del_pset(stack_nodes);
1348 /* Liveness could have changed due to Phi nodes. */
1349 be_liveness(env->birg->irg);
1351 /* free these dominance frontiers */
1352 be_free_dominance_frontiers(df);
1356 * Translates a direction of an IncSP node (either be_stack_dir_against, or ...along)
1357 * into -1 or 1, respectively.
1358 * @param irn The node.
1359 * @return 1, if the direction of the IncSP was along, -1 if against.
1361 static int get_dir(ir_node *irn)
1363 return 1 - 2 * (be_get_IncSP_direction(irn) == be_stack_dir_against);
1366 static int process_stack_bias(be_abi_irg_t *env, ir_node *bl, int bias)
1368 const arch_env_t *aenv = env->birg->main_env->arch_env;
1370 int start_bias = bias;
1371 int omit_fp = env->call->flags.bits.try_omit_fp;
1373 sched_foreach(bl, irn) {
1376 If the node modifies the stack pointer by a constant offset,
1377 record that in the bias.
1379 if(be_is_IncSP(irn)) {
1380 int ofs = be_get_IncSP_offset(irn);
1381 int dir = get_dir(irn);
1383 if(ofs == BE_STACK_FRAME_SIZE) {
1384 ofs = get_type_size_bytes(get_irg_frame_type(env->birg->irg));
1385 be_set_IncSP_offset(irn, ofs);
1393 Else check, if the node relates to an entity on the stack frame.
1394 If so, set the true offset (including the bias) for that
1398 entity *ent = arch_get_frame_entity(aenv, irn);
1400 int offset = get_stack_entity_offset(env->frame, ent, bias);
1401 arch_set_frame_offset(aenv, irn, offset);
1402 DBG((env->dbg, LEVEL_2, "%F has offset %d\n", ent, offset));
1411 * A helper struct for the bias walker.
1414 be_abi_irg_t *env; /**< The ABI irg environment. */
1415 int start_block_bias; /**< The bias at the end of the start block. */
1418 static void stack_bias_walker(ir_node *bl, void *data)
1420 if(bl != get_irg_start_block(get_irn_irg(bl))) {
1421 struct bias_walk *bw = data;
1422 process_stack_bias(bw->env, bl, bw->start_block_bias);
1426 void be_abi_fix_stack_bias(be_abi_irg_t *env)
1428 ir_graph *irg = env->birg->irg;
1429 struct bias_walk bw;
1431 stack_frame_compute_initial_offset(env->frame);
1432 // stack_frame_dump(stdout, env->frame);
1434 /* Determine the stack bias at the and of the start block. */
1435 bw.start_block_bias = process_stack_bias(env, get_irg_start_block(irg), 0);
1437 /* fix the bias is all other blocks */
1439 irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
1442 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg)
1444 assert(arch_register_type_is(reg, callee_save));
1445 assert(pmap_contains(abi->regs, (void *) reg));
1446 return pmap_get(abi->regs, (void *) reg);
1450 _____ _____ _ _ _ _ _ _
1451 |_ _| __ \| \ | | | | | | | | |
1452 | | | |__) | \| | | |__| | __ _ _ __ __| | | ___ _ __
1453 | | | _ /| . ` | | __ |/ _` | '_ \ / _` | |/ _ \ '__|
1454 _| |_| | \ \| |\ | | | | | (_| | | | | (_| | | __/ |
1455 |_____|_| \_\_| \_| |_| |_|\__,_|_| |_|\__,_|_|\___|_|
1457 for Phi nodes which are created due to stack modifying nodes
1458 such as IncSP, AddSP and SetSP.
1460 These Phis are always to be ignored by the reg alloc and are
1461 fixed on the SP register of the ISA.
1464 static const void *abi_get_irn_ops(const arch_irn_handler_t *handler, const ir_node *irn)
1466 const be_abi_irg_t *abi = get_abi_from_handler(handler);
1467 const void *res = NULL;
1469 if(is_Phi(irn) && pset_find_ptr(abi->stack_phis, (void *) irn))
1470 res = &abi->irn_ops;
1475 static void be_abi_limited(void *data, bitset_t *bs)
1477 be_abi_irg_t *abi = data;
1478 bitset_clear_all(bs);
1479 bitset_set(bs, abi->isa->sp->index);
1482 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)
1484 be_abi_irg_t *abi = get_abi_from_ops(self);
1485 const arch_register_t *reg = abi->isa->sp;
1487 memset(req, 0, sizeof(req[0]));
1489 if(pos == BE_OUT_POS(0)) {
1490 req->cls = reg->reg_class;
1491 req->type = arch_register_req_type_limited;
1492 req->limited = be_abi_limited;
1493 req->limited_env = abi;
1496 else if(pos >= 0 && pos < get_irn_arity(irn)) {
1497 req->cls = reg->reg_class;
1498 req->type = arch_register_req_type_normal;
1504 static void abi_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
1508 static const arch_register_t *abi_get_irn_reg(const void *self, const ir_node *irn)
1510 const be_abi_irg_t *abi = get_abi_from_ops(self);
1511 return abi->isa->sp;
1514 static arch_irn_class_t abi_classify(const void *_self, const ir_node *irn)
1516 return arch_irn_class_normal;
1519 static arch_irn_flags_t abi_get_flags(const void *_self, const ir_node *irn)
1521 return arch_irn_flags_ignore;
1524 static entity *abi_get_frame_entity(const void *_self, const ir_node *irn)
1529 static void abi_set_stack_bias(const void *_self, ir_node *irn, int bias)
1533 static const arch_irn_ops_if_t abi_irn_ops = {
1534 abi_get_irn_reg_req,
1539 abi_get_frame_entity,
1543 static const arch_irn_handler_t abi_irn_handler = {