2 * Copyright (C) 1995-2011 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 Lowering of Calls with compound parameters and return types.
23 * @author Michael Beck
30 #include "lower_calls.h"
41 #include "iroptimize.h"
46 static pmap *pointer_types;
47 static pmap *lowered_mtps;
50 * Default implementation for finding a pointer type for a given element type.
51 * Simple create a new one.
53 static ir_type *get_pointer_type(ir_type *dest_type)
55 ir_type *res = (ir_type*)pmap_get(pointer_types, dest_type);
57 res = new_type_pointer(dest_type);
58 pmap_insert(pointer_types, dest_type, res);
63 static void fix_parameter_entities(ir_graph *irg, size_t n_compound_ret)
65 ir_type *frame_type = get_irg_frame_type(irg);
66 size_t n_compound = get_compound_n_members(frame_type);
69 if (n_compound_ret == 0)
72 for (i = 0; i < n_compound; ++i) {
73 ir_entity *member = get_compound_member(frame_type, i);
75 if (!is_parameter_entity(member))
78 /* increase parameter number since we added a new parameter in front */
79 num = get_entity_parameter_number(member);
80 set_entity_parameter_number(member, num + n_compound_ret);
85 * Creates a new lowered type for a method type with compound
86 * arguments. The new type is associated to the old one and returned.
88 static ir_type *lower_mtp(compound_call_lowering_flags flags, ir_type *mtp)
90 bool must_be_lowered = false;
100 if (!is_Method_type(mtp))
103 lowered = (ir_type*)pmap_get(lowered_mtps, mtp);
107 /* check if the type has to be lowered at all */
108 n_ress = get_method_n_ress(mtp);
109 for (i = 0; i < n_ress; ++i) {
110 ir_type *res_tp = get_method_res_type(mtp, i);
111 if (is_compound_type(res_tp)) {
112 must_be_lowered = true;
116 if (!must_be_lowered)
119 n_params = get_method_n_params(mtp);
120 results = ALLOCANZ(ir_type*, n_ress);
121 params = ALLOCANZ(ir_type*, n_params + n_ress);
125 /* add a hidden parameter in front for every compound result */
126 for (i = 0; i < n_ress; ++i) {
127 ir_type *res_tp = get_method_res_type(mtp, i);
129 if (is_compound_type(res_tp)) {
130 /* this compound will be allocated on callers stack and its
131 address will be transmitted as a hidden parameter. */
132 ir_type *ptr_tp = get_pointer_type(res_tp);
133 params[nn_params++] = ptr_tp;
134 if (flags & LF_RETURN_HIDDEN)
135 results[nn_ress++] = ptr_tp;
138 results[nn_ress++] = res_tp;
141 /* copy over parameter types */
142 for (i = 0; i < n_params; ++i) {
143 params[nn_params++] = get_method_param_type(mtp, i);
145 assert(nn_ress <= n_ress);
146 assert(nn_params <= n_params + n_ress);
148 /* create the new type */
149 lowered = new_d_type_method(nn_params, nn_ress, get_type_dbg_info(mtp));
152 for (i = 0; i < nn_params; ++i)
153 set_method_param_type(lowered, i, params[i]);
154 for (i = 0; i < nn_ress; ++i)
155 set_method_res_type(lowered, i, results[i]);
157 set_method_variadicity(lowered, get_method_variadicity(mtp));
159 /* associate the lowered type with the original one for easier access */
160 set_method_calling_convention(lowered, get_method_calling_convention(mtp) | cc_compound_ret);
162 set_lowered_type(mtp, lowered);
163 pmap_insert(lowered_mtps, mtp, lowered);
171 typedef struct cl_entry cl_entry;
173 cl_entry *next; /**< Pointer to the next entry. */
174 ir_node *call; /**< Pointer to the Call node. */
175 ir_node *copyb; /**< List of all CopyB nodes. */
179 * Walker environment for fix_args_and_collect_calls().
181 typedef struct wlk_env_t {
182 size_t arg_shift; /**< The Argument index shift for parameters. */
183 struct obstack obst; /**< An obstack to allocate the data on. */
184 cl_entry *cl_list; /**< The call list. */
185 pmap *dummy_map; /**< A map for finding the dummy arguments. */
186 compound_call_lowering_flags flags;
187 ir_type *lowered_mtp; /**< The lowered method type of the current irg if any. */
188 unsigned only_local_mem:1; /**< Set if only local memory access was found. */
189 unsigned changed:1; /**< Set if the current graph was changed. */
193 * Return the call list entry of a call node.
194 * If no entry exists yet, allocate one and enter the node into
195 * the call list of the environment.
197 * @param call A Call node.
198 * @param env The environment.
200 static cl_entry *get_Call_entry(ir_node *call, wlk_env *env)
202 cl_entry *res = (cl_entry*)get_irn_link(call);
204 res = OALLOC(&env->obst, cl_entry);
205 res->next = env->cl_list;
208 set_irn_link(call, res);
215 * Finds the base address of an address by skipping Sel's and address
218 * @param adr the address
219 * @param pEnt points to the base entity if any
221 static ir_node *find_base_adr(ir_node *ptr, ir_entity **pEnt)
223 ir_entity *ent = NULL;
224 assert(mode_is_reference(get_irn_mode(ptr)));
228 ent = get_Sel_entity(ptr);
229 ptr = get_Sel_ptr(ptr);
231 else if (is_Add(ptr)) {
232 ir_node *left = get_Add_left(ptr);
233 if (mode_is_reference(get_irn_mode(left)))
236 ptr = get_Add_right(ptr);
238 } else if (is_Sub(ptr)) {
239 ptr = get_Sub_left(ptr);
249 * Check if a given pointer represents non-local memory.
251 static void check_ptr(ir_node *ptr, wlk_env *env)
253 ir_storage_class_class_t sc;
256 /* still alias free */
257 ptr = find_base_adr(ptr, &ent);
258 sc = get_base_sc(classify_pointer(ptr, ent));
259 if (sc != ir_sc_localvar && sc != ir_sc_malloced) {
260 /* non-local memory access */
261 env->only_local_mem = 0;
266 * Returns non-zero if a Call is surely a self-recursive Call.
267 * Beware: if this functions returns 0, the call might be self-recursive!
269 static bool is_self_recursive_Call(const ir_node *call)
271 const ir_node *callee = get_Call_ptr(call);
273 if (is_SymConst_addr_ent(callee)) {
274 const ir_entity *ent = get_SymConst_entity(callee);
275 const ir_graph *irg = get_entity_irg(ent);
276 if (irg == get_irn_irg(call))
283 * Post walker: shift all parameter indexes
284 * and collect Calls with compound returns in the call list.
285 * If a non-alias free memory access is found, reset the alias free
288 static void fix_args_and_collect_calls(ir_node *n, void *ctx)
290 wlk_env *env = (wlk_env*)ctx;
294 switch (get_irn_opcode(n)) {
297 if (env->only_local_mem) {
298 ptr = get_irn_n(n, 1);
303 if (env->arg_shift > 0) {
304 ir_node *pred = get_Proj_pred(n);
305 ir_graph *irg = get_irn_irg(n);
307 /* Fix the argument numbers */
308 if (pred == get_irg_args(irg)) {
309 long pnr = get_Proj_proj(n);
310 set_Proj_proj(n, pnr + env->arg_shift);
318 if (! is_self_recursive_Call(n)) {
319 /* any non self recursive call might access global memory */
320 env->only_local_mem = 0;
323 ctp = get_Call_type(n);
324 /* check for compound returns */
325 for (i = 0, n_res = get_method_n_ress(ctp); i < n_res; ++i) {
326 if (is_compound_type(get_method_res_type(ctp, i))) {
328 * This is a call with a compound return. As the result
329 * might be ignored, we must put it in the list.
331 (void)get_Call_entry(n, env);
338 ir_node *src = get_CopyB_src(n);
339 if (env->only_local_mem) {
340 check_ptr(get_CopyB_src(n), env);
341 if (env->only_local_mem)
342 check_ptr(get_CopyB_dst(n), env);
344 /* check for compound returns */
346 ir_node *proj = get_Proj_pred(src);
347 if (is_Proj(proj) && get_Proj_proj(proj) == pn_Call_T_result) {
348 ir_node *call = get_Proj_pred(proj);
350 ctp = get_Call_type(call);
351 if (is_compound_type(get_method_res_type(ctp, get_Proj_proj(src)))) {
352 /* found a CopyB from compound Call result */
353 cl_entry *e = get_Call_entry(call, env);
354 set_irn_link(n, e->copyb);
369 * Returns non-zero if a node is a compound address
370 * of a frame-type entity.
372 * @param ft the frame type
373 * @param adr the node
375 static bool is_compound_address(ir_type *ft, ir_node *adr)
381 if (get_Sel_n_indexs(adr) != 0)
383 ent = get_Sel_entity(adr);
384 return get_entity_owner(ent) == ft;
387 /** A pair for the copy-return-optimization. */
388 typedef struct cr_pair {
389 ir_entity *ent; /**< the entity than can be removed from the frame */
390 ir_node *arg; /**< the argument that replaces the entities address */
394 * Post walker: fixes all entities addresses for the copy-return
397 * Note: We expect the length of the cr_pair array (i.e. number of compound
398 * return values) to be 1 (C, C++) in almost all cases, so ignore the
399 * linear search complexity here.
401 static void do_copy_return_opt(ir_node *n, void *ctx)
404 ir_entity *ent = get_Sel_entity(n);
405 cr_pair *arr = (cr_pair*)ctx;
408 for (i = 0, l = ARR_LEN(arr); i < l; ++i) {
409 if (ent == arr[i].ent) {
410 exchange(n, arr[i].arg);
418 * Return a Sel node that selects a dummy argument of type tp.
419 * Dummy arguments are only needed once and we use a map
421 * We could even assign all dummy arguments the same offset
422 * in the frame type ...
424 * @param irg the graph
425 * @param block the block where a newly create Sel should be placed
426 * @param tp the type of the dummy entity that should be create
427 * @param env the environment
429 static ir_node *get_dummy_sel(ir_graph *irg, ir_node *block, ir_type *tp,
435 /* use a map the check if we already create such an entity */
436 e = pmap_find(env->dummy_map, tp);
438 ent = (ir_entity*)e->value;
440 ir_type *ft = get_irg_frame_type(irg);
441 ident *dummy_id = id_unique("dummy.%u");
442 ent = new_entity(ft, dummy_id, tp);
443 pmap_insert(env->dummy_map, tp, ent);
445 if (get_type_state(ft) == layout_fixed) {
446 /* Fix the layout again */
447 panic("Fixed layout not implemented");
450 return new_r_simpleSel(block, get_irg_no_mem(irg), get_irg_frame(irg), ent);
454 * Add the hidden parameter from the CopyB node to the Call node.
456 * @param irg the graph
457 * @param n_com number of compound results (will be number of hidden parameters)
458 * @param ins in array to store the hidden parameters into
459 * @param entry the call list
460 * @param env the environment
462 static void add_hidden_param(ir_graph *irg, size_t n_com, ir_node **ins,
463 cl_entry *entry, wlk_env *env)
465 ir_node *p, *n, *mem, *blk;
469 for (p = entry->copyb; p; p = n) {
470 ir_node *src = get_CopyB_src(p);
471 size_t idx = get_Proj_proj(src);
472 n = (ir_node*)get_irn_link(p);
474 ins[idx] = get_CopyB_dst(p);
475 mem = get_CopyB_mem(p);
476 blk = get_nodes_block(p);
478 /* get rid of the CopyB */
479 turn_into_tuple(p, pn_CopyB_max+1);
480 set_Tuple_pred(p, pn_CopyB_M, mem);
481 set_Tuple_pred(p, pn_CopyB_X_regular, new_r_Jmp(blk));
482 set_Tuple_pred(p, pn_CopyB_X_except, new_r_Bad(irg, mode_X));
486 /* now create dummy entities for function with ignored return value */
487 if (n_args < n_com) {
488 ir_type *ctp = get_Call_type(entry->call);
492 if (is_lowered_type(ctp))
493 ctp = get_associated_type(ctp);
495 for (j = i = 0; i < get_method_n_ress(ctp); ++i) {
496 ir_type *rtp = get_method_res_type(ctp, i);
497 if (is_compound_type(rtp)) {
499 ins[j] = get_dummy_sel(irg, get_nodes_block(entry->call), rtp, env);
507 * Fix all calls on a call list by adding hidden parameters.
509 * @param irg the graph
510 * @param env the environment
512 static void fix_call_list(ir_graph *irg, wlk_env *env)
515 ir_node *call, **new_in;
516 ir_type *ctp, *lowered_mtp;
517 size_t i, n_res, n_params, n_com, pos;
519 new_in = NEW_ARR_F(ir_node *, 0);
520 for (p = env->cl_list; p; p = p->next) {
522 ctp = get_Call_type(call);
523 lowered_mtp = lower_mtp(env->flags, ctp);
524 set_Call_type(call, lowered_mtp);
526 n_params = get_Call_n_params(call);
529 for (i = 0, n_res = get_method_n_ress(ctp); i < n_res; ++i) {
530 if (is_compound_type(get_method_res_type(ctp, i)))
534 ARR_RESIZE(ir_node *, new_in, n_params + n_com + pos);
535 memset(new_in, 0, sizeof(*new_in) * (n_params + n_com + pos));
536 add_hidden_param(irg, n_com, &new_in[pos], p, env);
538 /* copy all other parameters */
539 for (i = 0; i < n_params; ++i)
540 new_in[pos++] = get_Call_param(call, i);
541 new_in[0] = get_Call_mem(call);
542 new_in[1] = get_Call_ptr(call);
544 set_irn_in(call, n_params + n_com + 2, new_in);
549 * Transform a graph. If it has compound parameter returns,
550 * remove them and use the hidden parameter instead.
551 * If it calls methods with compound parameter returns, add hidden
554 * @param irg the graph to transform
556 static void transform_irg(compound_call_lowering_flags flags, ir_graph *irg)
558 ir_entity *ent = get_irg_entity(irg);
559 ir_type *mtp, *lowered_mtp, *tp, *ft;
560 size_t i, j, k, n_ress = 0, n_ret_com = 0;
562 ir_node **new_in, *ret, *endbl, *bl, *mem, *copy;
566 mtp = get_entity_type(ent);
568 /* calculate the number of compound returns */
569 n_ress = get_method_n_ress(mtp);
570 for (n_ret_com = i = 0; i < n_ress; ++i) {
571 tp = get_method_res_type(mtp, i);
573 if (is_compound_type(tp))
577 fix_parameter_entities(irg, n_ret_com);
580 /* much easier if we have only one return */
581 normalize_one_return(irg);
583 /* This graph has a compound argument. Create a new type */
584 lowered_mtp = lower_mtp(flags, mtp);
585 set_entity_type(ent, lowered_mtp);
587 /* hidden arguments are added first */
588 env.arg_shift = n_ret_com;
590 /* we must only search for calls */
594 obstack_init(&env.obst);
596 env.dummy_map = pmap_create_ex(8);
598 env.lowered_mtp = lowered_mtp;
599 env.only_local_mem = 1;
602 /* scan the code, fix argument numbers and collect calls. */
603 irg_walk_graph(irg, firm_clear_link, fix_args_and_collect_calls, &env);
607 fix_call_list(irg, &env);
614 /* STEP 1: find the return. This is simple, we have normalized the graph. */
615 endbl = get_irg_end_block(irg);
617 for (idx = get_Block_n_cfgpreds(endbl) - 1; idx >= 0; --idx) {
618 ir_node *pred = get_Block_cfgpred(endbl, idx);
620 if (is_Return(pred)) {
626 /* in case of infinite loops, there might be no return */
629 * Now fix the Return node of the current graph.
634 * STEP 2: fix it. For all compound return values add a CopyB,
635 * all others are copied.
637 NEW_ARR_A(ir_node *, new_in, n_ress + 1);
639 bl = get_nodes_block(ret);
640 mem = get_Return_mem(ret);
642 ft = get_irg_frame_type(irg);
643 NEW_ARR_A(cr_pair, cr_opt, n_ret_com);
645 for (j = 1, i = k = 0; i < n_ress; ++i) {
646 ir_node *pred = get_Return_res(ret, i);
647 tp = get_method_res_type(mtp, i);
649 if (is_compound_type(tp)) {
650 ir_node *arg = get_irg_args(irg);
651 arg = new_r_Proj(arg, mode_P_data, k);
654 if (is_Unknown(pred)) {
655 /* The Return(Unknown) is the Firm construct for a
656 * missing return. Do nothing. */
659 * Sorrily detecting that copy-return is possible isn't
660 * that simple. We must check, that the hidden address
661 * is alias free during the whole function.
662 * A simple heuristic: all Loads/Stores inside
663 * the function access only local frame.
665 if (env.only_local_mem && is_compound_address(ft, pred)) {
666 /* we can do the copy-return optimization here */
667 cr_opt[n_cr_opt].ent = get_Sel_entity(pred);
668 cr_opt[n_cr_opt].arg = arg;
670 } else { /* copy-return optimization is impossible, do the copy. */
678 mem = new_r_Proj(copy, mode_M, pn_CopyB_M);
681 if (flags & LF_RETURN_HIDDEN) {
685 } else { /* scalar return value */
690 /* replace the in of the Return */
692 set_irn_in(ret, j, new_in);
698 irg_walk_graph(irg, NULL, do_copy_return_opt, cr_opt);
700 for (c = 0, n = ARR_LEN(cr_opt); c < n; ++c) {
701 free_entity(cr_opt[c].ent);
707 pmap_destroy(env.dummy_map);
708 obstack_free(&env.obst, NULL);
711 static void lower_method_types(type_or_ent tore, void *env)
713 const compound_call_lowering_flags *flags
714 = (const compound_call_lowering_flags*)env;
716 /* fix method entities */
717 if (is_entity(tore.ent)) {
718 ir_entity *ent = tore.ent;
719 ir_type *tp = get_entity_type(ent);
720 ir_type *lowered = lower_mtp(*flags, tp);
721 set_entity_type(ent, lowered);
723 ir_type *tp = tore.typ;
725 /* fix pointer to methods */
726 if (is_Pointer_type(tp)) {
727 ir_type *points_to = get_pointer_points_to_type(tp);
728 ir_type *lowered_points_to = lower_mtp(*flags, points_to);
729 set_pointer_points_to_type(tp, lowered_points_to);
734 void lower_calls_with_compounds(compound_call_lowering_flags flags)
738 pointer_types = pmap_create();
739 lowered_mtps = pmap_create();
741 /* first step: Transform all graphs */
742 for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
743 ir_graph *irg = get_irp_irg(i);
744 transform_irg(flags, irg);
747 /* second step: Lower all method types of visible entities */
748 type_walk(NULL, lower_method_types, &flags);
750 pmap_destroy(lowered_mtps);
751 pmap_destroy(pointer_types);