lower_calls.c 21.9 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Michael Beck's avatar
Michael Beck committed
20
21
22
23
24
/**
 * @file
 * @brief   Lowering of Calls with compound parameters and return types.
 * @author  Michael Beck
 * @version $Id$
25
26
27
28
29
30
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

31
#include "lowering.h"
32
33
34
35
36
37
38
#include "irprog_t.h"
#include "irnode_t.h"
#include "type_t.h"
#include "irmode_t.h"
#include "ircons.h"
#include "irgmod.h"
#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
46
47
48
49
50
51
52
53

/** A type map for def_find_pointer_type. */
static pmap *type_map;

/**
 * Default implementation for finding a pointer type for a given element type.
 * Simple create a new one.
 */
static ir_type *def_find_pointer_type(ir_type *e_type, ir_mode *mode, int alignment)
{
54
55
56
57
58
59
60
61
62
63
64
65
66
67
	ir_type *res;
	pmap_entry *e;

	/* Mode and alignment are always identical in all calls to def_find_pointer_type(), so
	   we simply can use a map from the element type to the pointer type. */
	e = pmap_find(type_map, e_type);
	if (e)
		res = e->value;
	else {
		res = new_type_pointer(mangle_u(get_type_ident(e_type), new_id_from_chars("Ptr", 3)), e_type, mode);
		set_type_alignment_bytes(res, alignment);
		pmap_insert(type_map, e_type, res);
	}
	return res;
68
}
69
70
71
72

/**
 * Creates a new lowered type for a method type with compound
 * arguments. The new type is associated to the old one and returned.
73
74
75
76
77
 *
 * @param lp   parameter struct
 * @param mtp  the method type to lower
 *
 * The current implementation expects that a lowered type already
78
 * includes the necessary changes ...
79
80
81
 */
static ir_type *create_modified_mtd_type(const lower_params_t *lp, ir_type *mtp)
{
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
	ir_type *lowered, *ptr_tp;
	ir_type **params, **results, *res_tp;
	ir_mode *modes[MAX_REGISTER_RET_VAL];
	int n_ress, n_params, nn_ress, nn_params, i, first_variadic;
	ident *id;
	add_hidden hidden_params;
	int        changed = 0;
	variadicity var;

	if (is_lowered_type(mtp)) {
		/* the type is already lowered. Not handled yet. */
		assert(0 && "lowered types NYI");
	}

	lowered = get_associated_type(mtp);
	if (lowered)
		return lowered;

	n_ress   = get_method_n_ress(mtp);
	NEW_ARR_A(ir_type *, results, n_ress);

	n_params = get_method_n_params(mtp);
	NEW_ARR_A(ir_type *, params, n_params + n_ress);

	first_variadic = get_method_first_variadic_param_index(mtp);

	hidden_params = lp->hidden_params;
	if (hidden_params == ADD_HIDDEN_SMART &&
		get_method_variadicity(mtp) == variadicity_variadic)
		hidden_params = ADD_HIDDEN_ALWAYS_IN_FRONT;

	if (hidden_params == ADD_HIDDEN_ALWAYS_IN_FRONT) {
		/* add hidden in front */
		for (nn_ress = nn_params = i = 0; i < n_ress; ++i) {
			res_tp = get_method_res_type(mtp, i);

			if (is_compound_type(res_tp)) {
				int n_regs = 0;

				if (lp->flags & LF_SMALL_CMP_IN_REGS)
					n_regs = lp->ret_compound_in_regs(res_tp, modes);

				if (n_regs > 0) {
					/* this compound will be returned solely in registers */
					assert(0);
				}
				else {
					/* this compound will be allocated on callers stack and its
					   address will be transmitted as a hidden parameter. */
					ptr_tp = lp->find_pointer_type(res_tp, get_modeP_data(), lp->def_ptr_alignment);
					params[nn_params++] = ptr_tp;
					changed++;
					if (lp->flags & LF_RETURN_HIDDEN)
						results[nn_ress++] = ptr_tp;
				}
			}
			else
				results[nn_ress++] = res_tp;
		}

		/* move the index of the first variadic parameter */
		first_variadic += nn_params;

		for (i = 0; i < n_params; ++i)
			params[nn_params++] = get_method_param_type(mtp, i);
	}
	else {
		/* add hidden parameters last */
		assert(get_method_variadicity(mtp) == variadicity_non_variadic &&
			"Cannot add hidden parameters at end of variadic function");

		for (nn_params = 0; nn_params < n_params; ++nn_params)
			params[nn_params] = get_method_param_type(mtp, nn_params);

		for (nn_ress = i = 0; i < n_ress; ++i) {
			res_tp = get_method_res_type(mtp, i);

			if (is_compound_type(res_tp))
				params[nn_params++] = lp->find_pointer_type(res_tp, get_modeP_data(), lp->def_ptr_alignment);
			else
				results[nn_ress++] = res_tp;
		}
	}

	/* create the new type */
	id = mangle_u(new_id_from_chars("L", 1), get_type_ident(mtp));
	lowered = new_d_type_method(id, nn_params, nn_ress, get_type_dbg_info(mtp));

	/* fill it */
	for (i = 0; i < nn_params; ++i)
		set_method_param_type(lowered, i, params[i]);
	for (i = 0; i < nn_ress; ++i)
		set_method_res_type(lowered, i, results[i]);

	var = get_method_variadicity(mtp);
	set_method_variadicity(lowered, var);
	if (var == variadicity_variadic)
		set_method_first_variadic_param_index(lowered, first_variadic);

	/* associate the lowered type with the original one for easier access */
	if(changed) {
		set_method_calling_convention(lowered, get_method_calling_convention(mtp) | cc_compound_ret);
	}
	set_lowered_type(mtp, lowered);

	return lowered;
188
189
190
}

/**
191
192
193
194
 * A call list entry.
 */
typedef struct cl_entry cl_entry;
struct cl_entry {
195
196
197
	cl_entry *next;   /**< Pointer to the next entry. */
	ir_node  *call;   /**< Pointer to the Call node. */
	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
205
206
207
208
209
210
211
212
	int                  arg_shift;       /**< The Argument index shift for parameters. */
	int                  first_hidden;    /**< The index of the first hidden argument. */
	struct obstack       obst;            /**< An obstack to allocate the data on. */
	cl_entry             *cl_list;        /**< The call list. */
	pmap                 *dummy_map;      /**< A map for finding the dummy arguments. */
	unsigned             dnr;             /**< The dummy index number. */
	const lower_params_t *params;         /**< Lowering parameters. */
	unsigned             non_local_mem:1; /**< Set if non-local memory access was found. */
	unsigned             changed:1;       /**< Set if the current graph was changed. */
213
214
215
} wlk_env;

/**
216
217
218
219
220
221
222
223
 * Return the call list entry of a call node.
 * If no entry exists yet, allocate one and enter the node into
 * the call list of the environment.
 *
 * @param call   A Call node.
 * @param env    The environment.
 */
static cl_entry *get_Call_entry(ir_node *call, wlk_env *env) {
224
225
226
227
228
229
230
231
232
233
	cl_entry *res = get_irn_link(call);
	if (res == NULL) {
		cl_entry *res = obstack_alloc(&env->obst, sizeof(*res));
		res->next  = env->cl_list;
		res->call  = call;
		res->copyb = NULL;
		set_irn_link(call, res);
		env->cl_list = res;
	}
	return res;
234
235
236
237
238
}

/**
 * Post walker: shift all parameter indeces
 * and collect Calls with compound returns in the call list.
239
 */
240
static void fix_args_and_collect_calls(ir_node *n, void *ctx) {
241
242
243
	wlk_env *env = ctx;
	int i;
	ir_type *ctp;
244
	ir_opcode code = get_irn_opcode(n);
245

246
247
248
249
250
251
252
253
	if (code == iro_Load || code == iro_Store) {
		ir_node *ptr = get_irn_n(n, 1);

		if (! is_Sel(ptr))
			env->non_local_mem = 1;
		else if (get_Sel_ptr(ptr) != get_irg_frame(current_ir_graph))
			env->non_local_mem = 1;
	} else if (env->arg_shift > 0 && code == iro_Proj) {
254
255
256
257
258
259
260
261
		ir_node *pred = get_Proj_pred(n);

		/* Fix the argument numbers */
		if (pred == get_irg_args(current_ir_graph)) {
			long pnr = get_Proj_proj(n);
			set_Proj_proj(n, pnr + env->arg_shift);
			env->changed = 1;
		}
262
	} else if (code == iro_Call) {
263
264
265
266
267
268
269
270
271
272
273
274
275
276
		ctp = get_Call_type(n);
		if (env->params->flags & LF_COMPOUND_RETURN) {
			/* check for compound returns */
			for (i = get_method_n_ress(ctp) -1; i >= 0; --i) {
				if (is_compound_type(get_method_res_type(ctp, i))) {
					/*
					 * This is a call with a compound return. As the result
					 * might be ignored, we must put it in the list.
					 */
					(void)get_Call_entry(n, env);
					break;
				}
			}
		}
277
	} else if (code == iro_CopyB && env->params->flags & LF_COMPOUND_RETURN) {
278
279
280
281
282
283
284
285
286
287
288
289
290
291
		/* check for compound returns */
		ir_node *src = get_CopyB_src(n);
		/* older scheme using value_res_ent */
		if (is_Sel(src)) {
			ir_node *proj = get_Sel_ptr(src);
			if (is_Proj(proj) && get_Proj_proj(proj) == pn_Call_P_value_res_base) {
				ir_node *call = get_Proj_pred(proj);
				if (is_Call(call)) {
					/* found a CopyB from compound Call result */
					cl_entry *e = get_Call_entry(call, env);
					set_irn_link(n, e->copyb);
					e->copyb = n;
				}
			}
292
		} else {
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
			/* new scheme: compound results are determined by the call type only */
			if (is_Proj(src)) {
				ir_node *proj = get_Proj_pred(src);
				if (is_Proj(proj) && get_Proj_proj(proj) == pn_Call_T_result) {
					ir_node *call = get_Proj_pred(proj);
					if (is_Call(call)) {
						ctp = get_Call_type(call);
						if (is_compound_type(get_method_res_type(ctp, get_Proj_proj(src)))) {
							/* found a CopyB from compound Call result */
							cl_entry *e = get_Call_entry(call, env);
							set_irn_link(n, e->copyb);
							e->copyb = n;
						}
					}
				}
			}
309
		}
310
	}
311
312
313
}

/**
314
315
 * Returns non-zero if a node is a compound address
 * of a frame-type entity.
316
317
318
319
320
321
 *
 * @param ft   the frame type
 * @param adr  the node
 */
static int is_compound_address(ir_type *ft, ir_node *adr)
{
322
323
324
325
326
327
328
329
	ir_entity *ent;

	if (! is_Sel(adr))
		return 0;
	if (get_Sel_n_indexs(adr) != 0)
		return 0;
	ent = get_Sel_entity(adr);
	return get_entity_owner(ent) == ft;
330
331
}

332
/** A pair for the copy-return-optimization. */
333
typedef struct cr_pair {
334
335
	ir_entity *ent; /**< the entity than can be removed from the frame */
	ir_node *arg;   /**< the argument that replaces the entities address */
336
337
338
339
340
341
} cr_pair;

/**
 * Post walker: fixes all entities addresses for the copy-return
 * optimization.
 *
342
343
344
 * Note: We expect the length of the cr_pair array (ie number of compound
 * return values) to be 1 (C, C++) in almost all cases, so ignore the
 * linear search complexity here.
345
346
 */
static void do_copy_return_opt(ir_node *n, void *ctx) {
347
348
349
350
351
352
353
354
355
356
357
358
359
	cr_pair *arr = ctx;
	int i;

	if (is_Sel(n)) {
		ir_entity *ent = get_Sel_entity(n);

		for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
			if (ent == arr[i].ent) {
				exchange(n, arr[i].arg);
				break;
			}
		}
	}
360
361
362
}

/**
363
364
365
366
367
368
369
370
371
372
373
374
375
 * Return a Sel node that selects a dummy argument of type tp.
 * Dummy arguments are only needed once and we use a map
 * to store them.
 * We could even assign all dummy arguments the same offset
 * in the frame type ...
 *
 * @param irg    the graph
 * @param block  the block where a newly create Sel should be placed
 * @param tp     the type of the dummy entity that should be create
 * @param env    the environment
 */
static ir_node *get_dummy_sel(ir_graph *irg, ir_node *block, ir_type *tp, wlk_env *env)
{
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
	ir_entity *ent;
	pmap_entry *e;

	/* use a map the check if we already create such an entity */
	e = pmap_find(env->dummy_map, tp);
	if (e)
		ent = e->value;
	else {
		ir_type *ft = get_irg_frame_type(irg);
		char buf[16];

		snprintf(buf, sizeof(buf), "dummy.%u", env->dnr++);
		ent = new_entity(ft, new_id_from_str(buf), tp);
		pmap_insert(env->dummy_map, tp, ent);

		if (get_type_state(ft) == layout_fixed) {
			/* Fix the layout again */
			assert(0 && "Fixed layout not implemented");
		}
	}
	return new_r_simpleSel(
		irg,
		block,
		get_irg_no_mem(irg),
		get_irg_frame(irg),
		ent);
402
403
404
405
406
407
408
409
410
411
412
413
414
}

/**
 * Add the hidden parameter from the CopyB node to the Call node.
 *
 * @param irg    the graph
 * @param n_com  number of compound results (will be number of hidden parameters)
 * @param ins    in array to store the hidden parameters into
 * @param entry  the call list
 * @param env    the environment
 */
static void add_hidden_param(ir_graph *irg, int n_com, ir_node **ins, cl_entry *entry, wlk_env *env)
{
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
	ir_node *p, *n, *src, *mem, *blk;
	ir_entity *ent;
	ir_type *owner;
	int idx, n_args;

	n_args = 0;
	for (p = entry->copyb; p; p = n) {
		n   = get_irn_link(p);
		src = get_CopyB_src(p);

		/* old scheme using value_res_ent */
		if (is_Sel(src)) {
			ent = get_Sel_entity(src);
			owner = get_entity_owner(ent);

			/* find the hidden parameter index */
			for (idx = 0; idx < get_struct_n_members(owner); ++idx)
				if (get_struct_member(owner, idx) == ent)
					break;
			assert(idx < get_struct_n_members(owner));
435
		} else {
436
437
			/* new scheme: compound returns are determined by the call type and are Proj's */
			idx = get_Proj_proj(src);
438
		}
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469

		ins[idx] = get_CopyB_dst(p);
		mem      = get_CopyB_mem(p);
		blk      = get_nodes_block(p);

		/* get rid of the CopyB */
		turn_into_tuple(p, pn_CopyB_max);
		set_Tuple_pred(p, pn_CopyB_M_regular, mem);
		set_Tuple_pred(p, pn_CopyB_M_except,  get_irg_bad(irg));
		set_Tuple_pred(p, pn_CopyB_X_regular, new_r_Jmp(irg, blk));
		set_Tuple_pred(p, pn_CopyB_X_except,  get_irg_bad(irg));
		++n_args;
	}

	/* now create dummy entities for function with ignored return value */
	if (n_args < n_com) {
		ir_type *ctp = get_Call_type(entry->call);
		int i, j;

		if (is_lowered_type(ctp))
			ctp = get_associated_type(ctp);

		for (j = i = 0; i < get_method_n_ress(ctp); ++i) {
			ir_type *rtp = get_method_res_type(ctp, i);
			if (is_compound_type(rtp)) {
				if (ins[j] == NULL)
					ins[j] = get_dummy_sel(irg, get_nodes_block(entry->call), rtp, env);
				++j;
			}
		}
	}
470
471
472
473
}

/**
 * Fix all calls on a call list by adding hidden parameters.
474
 *
475
476
477
 * @param irg  the graph
 * @param env  the environment
 */
478
static void fix_call_list(ir_graph *irg, wlk_env *env) {
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
	const lower_params_t *lp = env->params;
	cl_entry *p;
	ir_node *call, **new_in;
	ir_type *ctp, *lowered_mtp;
	add_hidden hidden_params;
	int i, n_params, n_com, pos;

	new_in = NEW_ARR_F(ir_node *, 0);
	for (p = env->cl_list; p; p = p->next) {
		call = p->call;
		ctp = get_Call_type(call);
		lowered_mtp = create_modified_mtd_type(lp, ctp);
		set_Call_type(call, lowered_mtp);

		hidden_params = lp->hidden_params;
		if (hidden_params == ADD_HIDDEN_SMART &&
			get_method_variadicity(ctp) == variadicity_variadic)
			hidden_params = ADD_HIDDEN_ALWAYS_IN_FRONT;

		n_params = get_Call_n_params(call);

		n_com = 0;
		for (i = get_method_n_ress(ctp) - 1; i >= 0; --i) {
			if (is_compound_type(get_method_res_type(ctp, i)))
				++n_com;
		}
		pos = 2;
		ARR_RESIZE(ir_node *, new_in, n_params + n_com + pos);
		memset(new_in, 0, sizeof(*new_in) * (n_params + n_com + pos));
		if (hidden_params == ADD_HIDDEN_ALWAYS_IN_FRONT) {
			add_hidden_param(irg, n_com, &new_in[pos], p, env);
			pos += n_com;
		}
		/* copy all other parameters */
		for (i = 0; i < n_params; ++i)
			new_in[pos++] = get_Call_param(call, i);
		if (hidden_params == ADD_HIDDEN_ALWAYS_LAST) {
			add_hidden_param(irg, n_com, &new_in[pos], p, env);
			pos += n_com;
		}
		new_in[0] = get_Call_mem(call);
		new_in[1] = get_Call_ptr(call);

		set_irn_in(call, n_params + n_com + 2, new_in);
	}
524
525
526
527
528
529
530
531
532
}

/**
 * Transform a graph. If it has compound parameter returns,
 * remove them and use the hidden parameter instead.
 * If it calls methods with compound parameter returns, add hidden
 * parameters.
 *
 * @param lp   parameter struct
533
534
535
536
 * @param irg  the graph to transform
 */
static void transform_irg(const lower_params_t *lp, ir_graph *irg)
{
537
538
539
540
541
542
543
	ir_graph   * rem = current_ir_graph;
	ir_entity  *ent = get_irg_entity(irg);
	ir_type    *mtp, *lowered_mtp, *tp, *ft;
	int        i, j, k, n_ress = 0, n_ret_com = 0, n_cr_opt;
	ir_node    **new_in, *ret, *endbl, *bl, *mem, *copy;
	cr_pair    *cr_opt;
	wlk_env    env;
544
545
	add_hidden hidden_params;

546
547
	current_ir_graph = irg;

548
	assert(ent && "Cannot transform graph without an entity");
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
	assert(get_irg_phase_state(irg) == phase_high && "call lowering must be done in phase high");

	mtp = get_entity_type(ent);

	if (lp->flags & LF_COMPOUND_RETURN) {
		/* calculate the number of compound returns */
		n_ress = get_method_n_ress(mtp);
		for (n_ret_com = i = 0; i < n_ress; ++i) {
			tp = get_method_res_type(mtp, i);

			if (is_compound_type(tp))
				++n_ret_com;
		}
	}

	if (n_ret_com) {
		/* much easier if we have only one return */
		normalize_one_return(irg);

		/* This graph has a compound argument. Create a new type */
		lowered_mtp = create_modified_mtd_type(lp, mtp);
		set_entity_type(ent, lowered_mtp);

		hidden_params = lp->hidden_params;
		if (hidden_params == ADD_HIDDEN_SMART &&
			get_method_variadicity(mtp) == variadicity_variadic)
			hidden_params = ADD_HIDDEN_ALWAYS_IN_FRONT;

		if (hidden_params == ADD_HIDDEN_ALWAYS_IN_FRONT) {
			/* hidden arguments are added first */
			env.arg_shift    = n_ret_com;
			env.first_hidden = 0;
581
		} else {
582
583
584
585
586
587
588
589
590
			/* hidden arguments are added last */
			env.arg_shift    = 0;
			env.first_hidden = get_method_n_params(mtp);
		}
	} else {
		/* we must only search for calls */
		env.arg_shift = 0;
	}
	obstack_init(&env.obst);
591
592
593
594
595
596
	env.cl_list       = NULL;
	env.dummy_map     = pmap_create_ex(8);
	env.dnr           = 0;
	env.params        = lp;
	env.non_local_mem = 0;
	env.changed       = 0;
597
598
599
600
601
602
603
604
605
606
607
608

	/* scan the code, fix argument numbers and collect calls. */
	irg_walk_graph(irg, firm_clear_link, fix_args_and_collect_calls, &env);

	/* fix all calls */
	if (env.cl_list) {
		fix_call_list(irg, &env);
		env.changed = 1;
	}

	if (n_ret_com) {
		/*
609
610
		 * Now fix the Return node of the current graph.
		 */
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
		env.changed = 1;

		/* STEP 1: find the return. This is simple, we have normalized the graph. */
		endbl = get_irg_end_block(irg);
		ret = NULL;
		for (i = get_Block_n_cfgpreds(endbl) - 1; i >= 0; --i) {
			ir_node *pred = get_Block_cfgpred(endbl, i);

			if (is_Return(pred)) {
				ret = pred;
				break;
			}
		}
		/* there should always be a return */
		assert(ret);

		/*
		 * STEP 2: fix it. For all compound return values add a CopyB,
		 * all others are copied.
		 */
		NEW_ARR_A(ir_node *, new_in, n_ress + 1);

		bl  = get_nodes_block(ret);
		mem = get_Return_mem(ret);

		ft = get_irg_frame_type(irg);
		NEW_ARR_A(cr_pair, cr_opt, n_ret_com);
		n_cr_opt = 0;
		for (j = 1, i = k = 0; i < n_ress; ++i) {
			ir_node *pred = get_Return_res(ret, i);
			tp = get_method_res_type(mtp, i);

			if (is_compound_type(tp)) {
				ir_node *arg = get_irg_args(irg);
				arg = new_r_Proj(irg, get_nodes_block(arg), arg, mode_P_data, env.first_hidden + k);
				++k;

648
649
650
651
				if (is_Unknown(pred)) {
					/* The Return(Unknown) is the Firm construct for a missing return.
					   Do nothing. */
				} else {
652
653
654
655
656
657
658
659
					/**
					 * Sorrily detecting that copy-return is possible isn't that simple.
					 * We must check, that the hidden address is alias free during the whole
					 * function.
					 * A simple heuristic: all Loads/Stores inside
					 * the function access only local frame.
					 */
					if (!env.non_local_mem && is_compound_address(ft, pred)) {
660
661
662
663
664
665
666
667
668
669
670
671
672
673
						/* we can do the copy-return optimization here */
						cr_opt[n_cr_opt].ent = get_Sel_entity(pred);
						cr_opt[n_cr_opt].arg = arg;
						++n_cr_opt;
					} else { /* copy-return optimization is impossible, do the copy. */
						copy = new_r_CopyB(
							irg, bl,
							mem,
							arg,
							pred,
							tp
							);
						mem = new_r_Proj(irg, bl, copy, mode_M, pn_CopyB_M_regular);
					}
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
				}
				if (lp->flags & LF_RETURN_HIDDEN) {
					new_in[j] = arg;
					++j;
				}
			} else { /* scalar return value */
				new_in[j] = pred;
				++j;
			}
		}
		/* replace the in of the Return */
		new_in[0] = mem;
		set_irn_in(ret, j, new_in);

		if (n_cr_opt > 0) {
			irg_walk_graph(irg, NULL, do_copy_return_opt, cr_opt);

			for (i = ARR_LEN(cr_opt) - 1; i >= 0; --i) {
				remove_class_member(ft, cr_opt[i].ent);
			}
		}
	} /* if (n_ret_com) */

	pmap_destroy(env.dummy_map);
	obstack_free(&env.obst, NULL);

	if (env.changed) {
		/* invalidate the analysis info */
		set_irg_outs_inconsistent(irg);
		set_irg_loopinfo_state(irg, loopinfo_inconsistent);
	}
705
	current_ir_graph = rem;
706
707
708
709
710
711
}

/**
 * Returns non-zero if the given type is a method
 * type that must be lowered.
 *
712
 * @param lp  lowering parameters
713
714
 * @param tp  The type.
 */
715
static int must_be_lowered(const lower_params_t *lp, ir_type *tp) {
716
717
718
719
  int i, n_ress;
  ir_type *res_tp;

  if (is_Method_type(tp)) {
720
721
722
723
724
725
726
727
728
    if (lp->flags & LF_COMPOUND_RETURN) {
      /* check for compound returns */
      n_ress = get_method_n_ress(tp);
      for (i = 0; i < n_ress; ++i) {
        res_tp = get_method_res_type(tp, i);

        if (is_compound_type(res_tp))
          return 1;
      }
729
730
    }
  }
731
732
  return 0;
}
733

734
735
736
737
738
739
/**
 * type-walker: lower all method types of entities
 * and points-to types.
 */
static void lower_method_types(type_or_ent *tore, void *env)
{
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
	const lower_params_t *lp = env;
	ir_type *tp;

	/* fix method entities */
	if (is_entity(tore)) {
		ir_entity *ent = (ir_entity *)tore;
		tp = get_entity_type(ent);

		if (must_be_lowered(lp, tp)) {
			tp = create_modified_mtd_type(lp, tp);
			set_entity_type(ent, tp);
		}
	} else {
		tp = (ir_type *)tore;

		/* fix pointer to methods */
		if (is_Pointer_type(tp)) {
			ir_type *etp = get_pointer_points_to_type(tp);
			if (must_be_lowered(lp, etp)) {
				etp = create_modified_mtd_type(lp, etp);
				set_pointer_points_to_type(tp, etp);
			}
		}
	}
764
765
766
}

/*
767
 * Lower calls with compound parameters and return types.
768
769
770
771
772
773
774
775
776
777
778
779
780
 * This function does the following transformations:
 *
 * - Adds a new (hidden) pointer parameter for
 *   any return compound type.
 *
 * - Use of the hidden parameters in the function code.
 *
 * - Change all calls to functions with compound return
 *   by providing space for the hidden parameter on the callers
 *   stack.
 *
 * - Replace a possible block copy after the function call.
 */
781
void lower_calls_with_compounds(const lower_params_t *params)
782
{
783
784
785
	int i;
	ir_graph *irg;
	lower_params_t param = *params;
786

787
788
789
	if (param.find_pointer_type == NULL) {
		param.find_pointer_type = def_find_pointer_type;
		type_map = pmap_create_ex(8);
790
	} else
791
		type_map = NULL;
792

793
794
795
	/* first step: Transform all graphs */
	for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
		irg = get_irp_irg(i);
796

797
798
		if (irg == get_const_code_irg())
			continue;
799

800
801
		transform_irg(&param, irg);
	}
802

803
804
	/* second step: Lower all method types of visible entities */
	type_walk(NULL, lower_method_types, &param);
805

806
807
	if (type_map)
		pmap_destroy(type_map);
808
}