- invalidate loop info if graph was changed
[libfirm] / ir / lower / lower_calls.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Lowering of Calls with compound parameters and return types.
23  * @author  Michael Beck
24  * @version $Id$
25  */
26
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "lowering.h"
32 #include "irprog_t.h"
33 #include "irnode_t.h"
34 #include "type_t.h"
35 #include "irmode_t.h"
36 #include "ircons.h"
37 #include "irgmod.h"
38 #include "irgwalk.h"
39 #include "irtools.h"
40 #include "iroptimize.h"
41 #include "array.h"
42 #include "pmap.h"
43 #include "xmalloc.h"
44
45 /** A type map for def_find_pointer_type. */
46 static pmap *type_map;
47
48 /**
49  * Default implementation for finding a pointer type for a given element type.
50  * Simple create a new one.
51  */
52 static ir_type *def_find_pointer_type(ir_type *e_type, ir_mode *mode, int alignment)
53 {
54         ir_type *res;
55         pmap_entry *e;
56
57         /* Mode and alignment are always identical in all calls to def_find_pointer_type(), so
58            we simply can use a map from the element type to the pointer type. */
59         e = pmap_find(type_map, e_type);
60         if (e)
61                 res = e->value;
62         else {
63                 res = new_type_pointer(mangle_u(get_type_ident(e_type), new_id_from_chars("Ptr", 3)), e_type, mode);
64                 set_type_alignment_bytes(res, alignment);
65                 pmap_insert(type_map, e_type, res);
66         }
67         return res;
68 }
69
70 /**
71  * Creates a new lowered type for a method type with compound
72  * arguments. The new type is associated to the old one and returned.
73  *
74  * @param lp   parameter struct
75  * @param mtp  the method type to lower
76  *
77  * The current implementation expects that a lowered type already
78  * includes the necessary changes ...
79  */
80 static ir_type *create_modified_mtd_type(const lower_params_t *lp, ir_type *mtp)
81 {
82         ir_type *lowered, *ptr_tp;
83         ir_type **params, **results, *res_tp;
84         ir_mode *modes[MAX_REGISTER_RET_VAL];
85         int n_ress, n_params, nn_ress, nn_params, i, first_variadic;
86         ident *id;
87         add_hidden hidden_params;
88         int        changed = 0;
89         variadicity var;
90
91         if (is_lowered_type(mtp)) {
92                 /* the type is already lowered. Not handled yet. */
93                 assert(0 && "lowered types NYI");
94         }
95
96         lowered = get_associated_type(mtp);
97         if (lowered)
98                 return lowered;
99
100         n_ress   = get_method_n_ress(mtp);
101         NEW_ARR_A(ir_type *, results, n_ress);
102
103         n_params = get_method_n_params(mtp);
104         NEW_ARR_A(ir_type *, params, n_params + n_ress);
105
106         first_variadic = get_method_first_variadic_param_index(mtp);
107
108         hidden_params = lp->hidden_params;
109         if (hidden_params == ADD_HIDDEN_SMART &&
110                 get_method_variadicity(mtp) == variadicity_variadic)
111                 hidden_params = ADD_HIDDEN_ALWAYS_IN_FRONT;
112
113         if (hidden_params == ADD_HIDDEN_ALWAYS_IN_FRONT) {
114                 /* add hidden in front */
115                 for (nn_ress = nn_params = i = 0; i < n_ress; ++i) {
116                         res_tp = get_method_res_type(mtp, i);
117
118                         if (is_compound_type(res_tp)) {
119                                 int n_regs = 0;
120
121                                 if (lp->flags & LF_SMALL_CMP_IN_REGS)
122                                         n_regs = lp->ret_compound_in_regs(res_tp, modes);
123
124                                 if (n_regs > 0) {
125                                         /* this compound will be returned solely in registers */
126                                         assert(0);
127                                 }
128                                 else {
129                                         /* this compound will be allocated on callers stack and its
130                                            address will be transmitted as a hidden parameter. */
131                                         ptr_tp = lp->find_pointer_type(res_tp, get_modeP_data(), lp->def_ptr_alignment);
132                                         params[nn_params++] = ptr_tp;
133                                         changed++;
134                                         if (lp->flags & LF_RETURN_HIDDEN)
135                                                 results[nn_ress++] = ptr_tp;
136                                 }
137                         }
138                         else
139                                 results[nn_ress++] = res_tp;
140                 }
141
142                 /* move the index of the first variadic parameter */
143                 first_variadic += nn_params;
144
145                 for (i = 0; i < n_params; ++i)
146                         params[nn_params++] = get_method_param_type(mtp, i);
147         }
148         else {
149                 /* add hidden parameters last */
150                 assert(get_method_variadicity(mtp) == variadicity_non_variadic &&
151                         "Cannot add hidden parameters at end of variadic function");
152
153                 for (nn_params = 0; nn_params < n_params; ++nn_params)
154                         params[nn_params] = get_method_param_type(mtp, nn_params);
155
156                 for (nn_ress = i = 0; i < n_ress; ++i) {
157                         res_tp = get_method_res_type(mtp, i);
158
159                         if (is_compound_type(res_tp))
160                                 params[nn_params++] = lp->find_pointer_type(res_tp, get_modeP_data(), lp->def_ptr_alignment);
161                         else
162                                 results[nn_ress++] = res_tp;
163                 }
164         }
165
166         /* create the new type */
167         id = mangle_u(new_id_from_chars("L", 1), get_type_ident(mtp));
168         lowered = new_d_type_method(id, nn_params, nn_ress, get_type_dbg_info(mtp));
169
170         /* fill it */
171         for (i = 0; i < nn_params; ++i)
172                 set_method_param_type(lowered, i, params[i]);
173         for (i = 0; i < nn_ress; ++i)
174                 set_method_res_type(lowered, i, results[i]);
175
176         var = get_method_variadicity(mtp);
177         set_method_variadicity(lowered, var);
178         if (var == variadicity_variadic)
179                 set_method_first_variadic_param_index(lowered, first_variadic);
180
181         /* associate the lowered type with the original one for easier access */
182         if(changed) {
183                 set_method_calling_convention(lowered, get_method_calling_convention(mtp) | cc_compound_ret);
184         }
185         set_lowered_type(mtp, lowered);
186
187         return lowered;
188 }
189
190 /**
191  * A call list entry.
192  */
193 typedef struct cl_entry cl_entry;
194 struct cl_entry {
195         cl_entry *next;   /**< Pointer to the next entry. */
196         ir_node  *call;   /**< Pointer to the Call node. */
197         ir_node  *copyb;  /**< List of all CopyB nodes. */
198 };
199
200 /**
201  * Walker environment for fix_args_and_collect_calls().
202  */
203 typedef struct _wlk_env_t {
204         int                  arg_shift;     /**< The Argument index shift for parameters. */
205         int                  first_hidden;  /**< The index of the first hidden argument. */
206         struct obstack       obst;          /**< An obstack to allocate the data on. */
207         cl_entry             *cl_list;      /**< The call list. */
208         pmap                 *dummy_map;    /**< A map for finding the dummy arguments. */
209         unsigned             dnr;           /**< The dummy index number. */
210         const lower_params_t *params;       /**< lowering parameters */
211         int                  changed;       /**< set if the current graph was changed */
212 } wlk_env;
213
214 /**
215  * Return the call list entry of a call node.
216  * If no entry exists yet, allocate one and enter the node into
217  * the call list of the environment.
218  *
219  * @param call   A Call node.
220  * @param env    The environment.
221  */
222 static cl_entry *get_Call_entry(ir_node *call, wlk_env *env) {
223         cl_entry *res = get_irn_link(call);
224         if (res == NULL) {
225                 cl_entry *res = obstack_alloc(&env->obst, sizeof(*res));
226                 res->next  = env->cl_list;
227                 res->call  = call;
228                 res->copyb = NULL;
229                 set_irn_link(call, res);
230                 env->cl_list = res;
231         }
232         return res;
233 }
234
235 /**
236  * Post walker: shift all parameter indeces
237  * and collect Calls with compound returns in the call list.
238  */
239 static void fix_args_and_collect_calls(ir_node *n, void *ctx) {
240         wlk_env *env = ctx;
241         int i;
242         ir_type *ctp;
243         ir_op *op = get_irn_op(n);
244
245         if (env->arg_shift > 0 && op == op_Proj) {
246                 ir_node *pred = get_Proj_pred(n);
247
248                 /* Fix the argument numbers */
249                 if (pred == get_irg_args(current_ir_graph)) {
250                         long pnr = get_Proj_proj(n);
251                         set_Proj_proj(n, pnr + env->arg_shift);
252                         env->changed = 1;
253                 }
254         } else if (op == op_Call) {
255                 ctp = get_Call_type(n);
256                 if (env->params->flags & LF_COMPOUND_RETURN) {
257                         /* check for compound returns */
258                         for (i = get_method_n_ress(ctp) -1; i >= 0; --i) {
259                                 if (is_compound_type(get_method_res_type(ctp, i))) {
260                                         /*
261                                          * This is a call with a compound return. As the result
262                                          * might be ignored, we must put it in the list.
263                                          */
264                                         (void)get_Call_entry(n, env);
265                                         break;
266                                 }
267                         }
268                 }
269         } else if (op == op_CopyB && env->params->flags & LF_COMPOUND_RETURN) {
270                 /* check for compound returns */
271                 ir_node *src = get_CopyB_src(n);
272                 /* older scheme using value_res_ent */
273                 if (is_Sel(src)) {
274                         ir_node *proj = get_Sel_ptr(src);
275                         if (is_Proj(proj) && get_Proj_proj(proj) == pn_Call_P_value_res_base) {
276                                 ir_node *call = get_Proj_pred(proj);
277                                 if (is_Call(call)) {
278                                         /* found a CopyB from compound Call result */
279                                         cl_entry *e = get_Call_entry(call, env);
280                                         set_irn_link(n, e->copyb);
281                                         e->copyb = n;
282                                 }
283                         }
284                 } else
285                         /* new scheme: compound results are determined by the call type only */
286                         if (is_Proj(src)) {
287                                 ir_node *proj = get_Proj_pred(src);
288                                 if (is_Proj(proj) && get_Proj_proj(proj) == pn_Call_T_result) {
289                                         ir_node *call = get_Proj_pred(proj);
290                                         if (is_Call(call)) {
291                                                 ctp = get_Call_type(call);
292                                                 if (is_compound_type(get_method_res_type(ctp, get_Proj_proj(src)))) {
293                                                         /* found a CopyB from compound Call result */
294                                                         cl_entry *e = get_Call_entry(call, env);
295                                                         set_irn_link(n, e->copyb);
296                                                         e->copyb = n;
297                                                 }
298                                         }
299                                 }
300                         }
301         }
302 }
303
304 /**
305  * Returns non-zero if a node is a compound address
306  * of a frame-type entity.
307  *
308  * @param ft   the frame type
309  * @param adr  the node
310  */
311 static int is_compound_address(ir_type *ft, ir_node *adr)
312 {
313         ir_entity *ent;
314
315         if (! is_Sel(adr))
316                 return 0;
317         if (get_Sel_n_indexs(adr) != 0)
318                 return 0;
319         ent = get_Sel_entity(adr);
320         return get_entity_owner(ent) == ft;
321 }
322
323 /** A pair for the copy-return-optimization. */
324 typedef struct cr_pair {
325         ir_entity *ent; /**< the entity than can be removed from the frame */
326         ir_node *arg;   /**< the argument that replaces the entities address */
327 } cr_pair;
328
329 /**
330  * Post walker: fixes all entities addresses for the copy-return
331  * optimization.
332  *
333  * Note: We expect the length of the cr_pair array (ie number of compound
334  * return values) to be 1 (C, C++) in almost all cases, so ignore the
335  * linear search complexity here.
336  */
337 static void do_copy_return_opt(ir_node *n, void *ctx) {
338         cr_pair *arr = ctx;
339         int i;
340
341         if (is_Sel(n)) {
342                 ir_entity *ent = get_Sel_entity(n);
343
344                 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
345                         if (ent == arr[i].ent) {
346                                 exchange(n, arr[i].arg);
347                                 break;
348                         }
349                 }
350         }
351 }
352
353 /**
354  * Return a Sel node that selects a dummy argument of type tp.
355  * Dummy arguments are only needed once and we use a map
356  * to store them.
357  * We could even assign all dummy arguments the same offset
358  * in the frame type ...
359  *
360  * @param irg    the graph
361  * @param block  the block where a newly create Sel should be placed
362  * @param tp     the type of the dummy entity that should be create
363  * @param env    the environment
364  */
365 static ir_node *get_dummy_sel(ir_graph *irg, ir_node *block, ir_type *tp, wlk_env *env)
366 {
367         ir_entity *ent;
368         pmap_entry *e;
369
370         /* use a map the check if we already create such an entity */
371         e = pmap_find(env->dummy_map, tp);
372         if (e)
373                 ent = e->value;
374         else {
375                 ir_type *ft = get_irg_frame_type(irg);
376                 char buf[16];
377
378                 snprintf(buf, sizeof(buf), "dummy.%u", env->dnr++);
379                 ent = new_entity(ft, new_id_from_str(buf), tp);
380                 pmap_insert(env->dummy_map, tp, ent);
381
382                 if (get_type_state(ft) == layout_fixed) {
383                         /* Fix the layout again */
384                         assert(0 && "Fixed layout not implemented");
385                 }
386         }
387         return new_r_simpleSel(
388                 irg,
389                 block,
390                 get_irg_no_mem(irg),
391                 get_irg_frame(irg),
392                 ent);
393 }
394
395 /**
396  * Add the hidden parameter from the CopyB node to the Call node.
397  *
398  * @param irg    the graph
399  * @param n_com  number of compound results (will be number of hidden parameters)
400  * @param ins    in array to store the hidden parameters into
401  * @param entry  the call list
402  * @param env    the environment
403  */
404 static void add_hidden_param(ir_graph *irg, int n_com, ir_node **ins, cl_entry *entry, wlk_env *env)
405 {
406         ir_node *p, *n, *src, *mem, *blk;
407         ir_entity *ent;
408         ir_type *owner;
409         int idx, n_args;
410
411         n_args = 0;
412         for (p = entry->copyb; p; p = n) {
413                 n   = get_irn_link(p);
414                 src = get_CopyB_src(p);
415
416                 /* old scheme using value_res_ent */
417                 if (is_Sel(src)) {
418                         ent = get_Sel_entity(src);
419                         owner = get_entity_owner(ent);
420
421                         /* find the hidden parameter index */
422                         for (idx = 0; idx < get_struct_n_members(owner); ++idx)
423                                 if (get_struct_member(owner, idx) == ent)
424                                         break;
425                         assert(idx < get_struct_n_members(owner));
426                 }
427                 else
428
429                         /* new scheme: compound returns are determined by the call type and are Proj's */
430                         idx = get_Proj_proj(src);
431
432                 ins[idx] = get_CopyB_dst(p);
433                 mem      = get_CopyB_mem(p);
434                 blk      = get_nodes_block(p);
435
436                 /* get rid of the CopyB */
437                 turn_into_tuple(p, pn_CopyB_max);
438                 set_Tuple_pred(p, pn_CopyB_M_regular, mem);
439                 set_Tuple_pred(p, pn_CopyB_M_except,  get_irg_bad(irg));
440                 set_Tuple_pred(p, pn_CopyB_X_regular, new_r_Jmp(irg, blk));
441                 set_Tuple_pred(p, pn_CopyB_X_except,  get_irg_bad(irg));
442                 ++n_args;
443         }
444
445         /* now create dummy entities for function with ignored return value */
446         if (n_args < n_com) {
447                 ir_type *ctp = get_Call_type(entry->call);
448                 int i, j;
449
450                 if (is_lowered_type(ctp))
451                         ctp = get_associated_type(ctp);
452
453                 for (j = i = 0; i < get_method_n_ress(ctp); ++i) {
454                         ir_type *rtp = get_method_res_type(ctp, i);
455                         if (is_compound_type(rtp)) {
456                                 if (ins[j] == NULL)
457                                         ins[j] = get_dummy_sel(irg, get_nodes_block(entry->call), rtp, env);
458                                 ++j;
459                         }
460                 }
461         }
462 }
463
464 /**
465  * Fix all calls on a call list by adding hidden parameters.
466  *
467  * @param irg  the graph
468  * @param env  the environment
469  */
470 static void fix_call_list(ir_graph *irg, wlk_env *env) {
471         const lower_params_t *lp = env->params;
472         cl_entry *p;
473         ir_node *call, **new_in;
474         ir_type *ctp, *lowered_mtp;
475         add_hidden hidden_params;
476         int i, n_params, n_com, pos;
477
478         new_in = NEW_ARR_F(ir_node *, 0);
479         for (p = env->cl_list; p; p = p->next) {
480                 call = p->call;
481                 ctp = get_Call_type(call);
482                 lowered_mtp = create_modified_mtd_type(lp, ctp);
483                 set_Call_type(call, lowered_mtp);
484
485                 hidden_params = lp->hidden_params;
486                 if (hidden_params == ADD_HIDDEN_SMART &&
487                         get_method_variadicity(ctp) == variadicity_variadic)
488                         hidden_params = ADD_HIDDEN_ALWAYS_IN_FRONT;
489
490                 n_params = get_Call_n_params(call);
491
492                 n_com = 0;
493                 for (i = get_method_n_ress(ctp) - 1; i >= 0; --i) {
494                         if (is_compound_type(get_method_res_type(ctp, i)))
495                                 ++n_com;
496                 }
497                 pos = 2;
498                 ARR_RESIZE(ir_node *, new_in, n_params + n_com + pos);
499                 memset(new_in, 0, sizeof(*new_in) * (n_params + n_com + pos));
500                 if (hidden_params == ADD_HIDDEN_ALWAYS_IN_FRONT) {
501                         add_hidden_param(irg, n_com, &new_in[pos], p, env);
502                         pos += n_com;
503                 }
504                 /* copy all other parameters */
505                 for (i = 0; i < n_params; ++i)
506                         new_in[pos++] = get_Call_param(call, i);
507                 if (hidden_params == ADD_HIDDEN_ALWAYS_LAST) {
508                         add_hidden_param(irg, n_com, &new_in[pos], p, env);
509                         pos += n_com;
510                 }
511                 new_in[0] = get_Call_mem(call);
512                 new_in[1] = get_Call_ptr(call);
513
514                 set_irn_in(call, n_params + n_com + 2, new_in);
515         }
516 }
517
518 /**
519  * Transform a graph. If it has compound parameter returns,
520  * remove them and use the hidden parameter instead.
521  * If it calls methods with compound parameter returns, add hidden
522  * parameters.
523  *
524  * @param lp   parameter struct
525  * @param irg  the graph to transform
526  */
527 static void transform_irg(const lower_params_t *lp, ir_graph *irg)
528 {
529         ir_entity *ent = get_irg_entity(irg);
530         ir_type *mtp, *lowered_mtp, *tp, *ft;
531         int i, j, k, n_ress = 0, n_ret_com = 0, n_cr_opt;
532         ir_node **new_in, *ret, *endbl, *bl, *mem, *copy;
533         cr_pair *cr_opt;
534         wlk_env env;
535         add_hidden hidden_params;
536
537         assert(ent && "Cannot tranform graph without an entity");
538         assert(get_irg_phase_state(irg) == phase_high && "call lowering must be done in phase high");
539
540         mtp = get_entity_type(ent);
541
542         if (lp->flags & LF_COMPOUND_RETURN) {
543                 /* calculate the number of compound returns */
544                 n_ress = get_method_n_ress(mtp);
545                 for (n_ret_com = i = 0; i < n_ress; ++i) {
546                         tp = get_method_res_type(mtp, i);
547
548                         if (is_compound_type(tp))
549                                 ++n_ret_com;
550                 }
551         }
552
553         if (n_ret_com) {
554                 /* much easier if we have only one return */
555                 normalize_one_return(irg);
556
557                 /* This graph has a compound argument. Create a new type */
558                 lowered_mtp = create_modified_mtd_type(lp, mtp);
559                 set_entity_type(ent, lowered_mtp);
560
561                 hidden_params = lp->hidden_params;
562                 if (hidden_params == ADD_HIDDEN_SMART &&
563                         get_method_variadicity(mtp) == variadicity_variadic)
564                         hidden_params = ADD_HIDDEN_ALWAYS_IN_FRONT;
565
566                 if (hidden_params == ADD_HIDDEN_ALWAYS_IN_FRONT) {
567                         /* hidden arguments are added first */
568                         env.arg_shift    = n_ret_com;
569                         env.first_hidden = 0;
570                 }
571                 else {
572                         /* hidden arguments are added last */
573                         env.arg_shift    = 0;
574                         env.first_hidden = get_method_n_params(mtp);
575                 }
576         } else {
577                 /* we must only search for calls */
578                 env.arg_shift = 0;
579         }
580         obstack_init(&env.obst);
581         env.cl_list   = NULL;
582         env.dummy_map = pmap_create_ex(8);
583         env.dnr       = 0;
584         env.params    = lp;
585         env.changed   = 0;
586
587         /* scan the code, fix argument numbers and collect calls. */
588         irg_walk_graph(irg, firm_clear_link, fix_args_and_collect_calls, &env);
589
590         /* fix all calls */
591         if (env.cl_list) {
592                 fix_call_list(irg, &env);
593                 env.changed = 1;
594         }
595
596         if (n_ret_com) {
597                 /*
598                 * Now fix the Return node of the current graph.
599                 */
600                 env.changed = 1;
601
602                 /* STEP 1: find the return. This is simple, we have normalized the graph. */
603                 endbl = get_irg_end_block(irg);
604                 ret = NULL;
605                 for (i = get_Block_n_cfgpreds(endbl) - 1; i >= 0; --i) {
606                         ir_node *pred = get_Block_cfgpred(endbl, i);
607
608                         if (is_Return(pred)) {
609                                 ret = pred;
610                                 break;
611                         }
612                 }
613                 /* there should always be a return */
614                 assert(ret);
615
616                 /*
617                  * STEP 2: fix it. For all compound return values add a CopyB,
618                  * all others are copied.
619                  */
620                 NEW_ARR_A(ir_node *, new_in, n_ress + 1);
621
622                 bl  = get_nodes_block(ret);
623                 mem = get_Return_mem(ret);
624
625                 ft = get_irg_frame_type(irg);
626                 NEW_ARR_A(cr_pair, cr_opt, n_ret_com);
627                 n_cr_opt = 0;
628                 for (j = 1, i = k = 0; i < n_ress; ++i) {
629                         ir_node *pred = get_Return_res(ret, i);
630                         tp = get_method_res_type(mtp, i);
631
632                         if (is_compound_type(tp)) {
633                                 ir_node *arg = get_irg_args(irg);
634                                 arg = new_r_Proj(irg, get_nodes_block(arg), arg, mode_P_data, env.first_hidden + k);
635                                 ++k;
636
637                                 if (is_compound_address(ft, pred)) {
638                                         /* we can do the copy-return optimization here */
639                                         cr_opt[n_cr_opt].ent = get_Sel_entity(pred);
640                                         cr_opt[n_cr_opt].arg = arg;
641                                         ++n_cr_opt;
642                                 } else { /* copy-return optimization is impossible, do the copy. */
643                                         copy = new_r_CopyB(
644                                                 irg, bl,
645                                                 mem,
646                                                 arg,
647                                                 pred,
648                                                 tp
649                                                 );
650                                         mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
651                                 }
652                                 if (lp->flags & LF_RETURN_HIDDEN) {
653                                         new_in[j] = arg;
654                                         ++j;
655                                 }
656                         } else { /* scalar return value */
657                                 new_in[j] = pred;
658                                 ++j;
659                         }
660                 }
661                 /* replace the in of the Return */
662                 new_in[0] = mem;
663                 set_irn_in(ret, j, new_in);
664
665                 if (n_cr_opt > 0) {
666                         irg_walk_graph(irg, NULL, do_copy_return_opt, cr_opt);
667
668                         for (i = ARR_LEN(cr_opt) - 1; i >= 0; --i) {
669                                 remove_class_member(ft, cr_opt[i].ent);
670                         }
671                 }
672         } /* if (n_ret_com) */
673
674         pmap_destroy(env.dummy_map);
675         obstack_free(&env.obst, NULL);
676
677         if (env.changed) {
678                 /* invalidate the analysis info */
679                 set_irg_outs_inconsistent(irg);
680                 set_irg_loopinfo_state(irg, loopinfo_inconsistent);
681         }
682 }
683
684 /**
685  * Returns non-zero if the given type is a method
686  * type that must be lowered.
687  *
688  * @param lp  lowering parameters
689  * @param tp  The type.
690  */
691 static int must_be_lowered(const lower_params_t *lp, ir_type *tp) {
692   int i, n_ress;
693   ir_type *res_tp;
694
695   if (is_Method_type(tp)) {
696     if (lp->flags & LF_COMPOUND_RETURN) {
697       /* check for compound returns */
698       n_ress = get_method_n_ress(tp);
699       for (i = 0; i < n_ress; ++i) {
700         res_tp = get_method_res_type(tp, i);
701
702         if (is_compound_type(res_tp))
703           return 1;
704       }
705     }
706   }
707   return 0;
708 }
709
710 /**
711  * type-walker: lower all method types of entities
712  * and points-to types.
713  */
714 static void lower_method_types(type_or_ent *tore, void *env)
715 {
716         const lower_params_t *lp = env;
717         ir_type *tp;
718
719         /* fix method entities */
720         if (is_entity(tore)) {
721                 ir_entity *ent = (ir_entity *)tore;
722                 tp = get_entity_type(ent);
723
724                 if (must_be_lowered(lp, tp)) {
725                         tp = create_modified_mtd_type(lp, tp);
726                         set_entity_type(ent, tp);
727                 }
728         } else {
729                 tp = (ir_type *)tore;
730
731                 /* fix pointer to methods */
732                 if (is_Pointer_type(tp)) {
733                         ir_type *etp = get_pointer_points_to_type(tp);
734                         if (must_be_lowered(lp, etp)) {
735                                 etp = create_modified_mtd_type(lp, etp);
736                                 set_pointer_points_to_type(tp, etp);
737                         }
738                 }
739         }
740 }
741
742 /*
743  * Lower calls with compound parameters and return types.
744  * This function does the following transformations:
745  *
746  * - Adds a new (hidden) pointer parameter for
747  *   any return compound type.
748  *
749  * - Use of the hidden parameters in the function code.
750  *
751  * - Change all calls to functions with compound return
752  *   by providing space for the hidden parameter on the callers
753  *   stack.
754  *
755  * - Replace a possible block copy after the function call.
756  */
757 void lower_calls_with_compounds(const lower_params_t *params)
758 {
759         int i;
760         ir_graph *irg;
761         lower_params_t param = *params;
762
763         if (param.find_pointer_type == NULL) {
764                 param.find_pointer_type = def_find_pointer_type;
765                 type_map = pmap_create_ex(8);
766         }
767         else
768                 type_map = NULL;
769
770         /* first step: Transform all graphs */
771         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
772                 irg = get_irp_irg(i);
773
774                 if (irg == get_const_code_irg())
775                         continue;
776
777                 transform_irg(&param, irg);
778         }
779
780         /* second step: Lower all method types of visible entities */
781         type_walk(NULL, lower_method_types, &param);
782
783         if (type_map)
784                 pmap_destroy(type_map);
785 }