lower_calls.c 22.1 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
2
/*
 * This file is part of libFirm.
3
 * Copyright (C) 2012 University of Karlsruhe.
Christian Würdig's avatar
Christian Würdig committed
4
5
 */

Michael Beck's avatar
Michael Beck committed
6
7
8
/**
 * @file
 * @brief   Lowering of Calls with compound parameters and return types.
9
 * @author  Michael Beck, Matthias Braun
10
 */
11
12
#include <stdbool.h>

13
#include "firm_types.h"
14
#include "lower_calls.h"
15
#include "lowering.h"
16
17
18
19
20
21
22
#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"
23
#include "irmemory.h"
24
#include "irmemory_t.h"
25
#include "irtools.h"
26
#include "iroptimize.h"
27
#include "array_t.h"
28
#include "pmap.h"
29
#include "error.h"
30
#include "util.h"
31

32
33
static pmap *pointer_types;
static pmap *lowered_mtps;
34
35
36

/**
 * Default implementation for finding a pointer type for a given element type.
Manuel Mohr's avatar
Manuel Mohr committed
37
 * Simply create a new one.
38
 */
39
static ir_type *get_pointer_type(ir_type *dest_type)
40
{
41
	ir_type *res = pmap_get(ir_type, pointer_types, dest_type);
42
43
44
	if (res == NULL) {
		res = new_type_pointer(dest_type);
		pmap_insert(pointer_types, dest_type, res);
45
46
	}
	return res;
47
}
48

49
50
51
static void fix_parameter_entities(ir_graph *irg, size_t n_compound_ret)
{
	ir_type *frame_type = get_irg_frame_type(irg);
52
	size_t   n_members  = get_compound_n_members(frame_type);
53

yb9976's avatar
yb9976 committed
54
	for (size_t i = 0; i < n_members; ++i) {
55
56
57
58
59
		ir_entity *member = get_compound_member(frame_type, i);
		if (!is_parameter_entity(member))
			continue;

		/* increase parameter number since we added a new parameter in front */
yb9976's avatar
yb9976 committed
60
		size_t num = get_entity_parameter_number(member);
61
62
		if (num == IR_VA_START_PARAMETER_NUMBER)
			continue;
63
64
65
66
		set_entity_parameter_number(member, num + n_compound_ret);
	}
}

67
68
69
70
71
static void remove_compound_param_entities(ir_graph *irg)
{
	ir_type *frame_type = get_irg_frame_type(irg);
	size_t   n_members  = get_compound_n_members(frame_type);

yb9976's avatar
yb9976 committed
72
73
	for (size_t i = n_members; i-- > 0; ) {
		ir_entity *member = get_compound_member(frame_type, i);
74
75
76
		if (!is_parameter_entity(member))
			continue;

yb9976's avatar
yb9976 committed
77
		ir_type *type = get_entity_type(member);
78
		if (is_aggregate_type(type)) {
79
80
81
82
83
			free_entity(member);
		}
	}
}

84
85
86
87
/**
 * Creates a new lowered type for a method type with compound
 * 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)
89
{
90
91
92
	if (!is_Method_type(mtp))
		return mtp;

yb9976's avatar
yb9976 committed
93
	ir_type *lowered = pmap_get(ir_type, lowered_mtps, mtp);
94
	if (lowered != NULL)
95
96
		return lowered;

97
	/* check if the type has to be lowered at all */
yb9976's avatar
yb9976 committed
98
99
100
101
	bool   must_be_lowered = false;
	size_t n_params        = get_method_n_params(mtp);
	size_t n_ress          = get_method_n_ress(mtp);
	for (size_t i = 0; i < n_ress; ++i) {
102
		ir_type *res_tp = get_method_res_type(mtp, i);
103
		if (is_aggregate_type(res_tp)) {
104
105
			must_be_lowered = true;
			break;
106
		}
107
	}
108
	if (!must_be_lowered && !(flags & LF_DONT_LOWER_ARGUMENTS)) {
yb9976's avatar
yb9976 committed
109
		for (size_t i = 0; i < n_params; ++i) {
110
			ir_type *param_type = get_method_param_type(mtp, i);
111
			if (is_aggregate_type(param_type)) {
112
113
114
115
116
				must_be_lowered = true;
				break;
			}
		}
	}
117
118
119
	if (!must_be_lowered)
		return mtp;

yb9976's avatar
yb9976 committed
120
121
122
123
	ir_type **params    = ALLOCANZ(ir_type*, n_params + n_ress);
	ir_type **results   = ALLOCANZ(ir_type*, n_ress);
	size_t    nn_params = 0;
	size_t    nn_ress   = 0;
124
125

	/* add a hidden parameter in front for every compound result */
yb9976's avatar
yb9976 committed
126
	for (size_t i = 0; i < n_ress; ++i) {
127
128
		ir_type *res_tp = get_method_res_type(mtp, i);

129
		if (is_aggregate_type(res_tp)) {
130
131
132
133
134
135
136
137
138
			/* this compound will be allocated on callers stack and its
			   address will be transmitted as a hidden parameter. */
			ir_type *ptr_tp = get_pointer_type(res_tp);
			params[nn_params++] = ptr_tp;
			if (flags & LF_RETURN_HIDDEN)
				results[nn_ress++] = ptr_tp;
		} else {
			/* scalar result */
			results[nn_ress++] = res_tp;
139
140
		}
	}
141
	/* copy over parameter types */
yb9976's avatar
yb9976 committed
142
	for (size_t i = 0; i < n_params; ++i) {
143
		ir_type *param_type = get_method_param_type(mtp, i);
144
145
		if (!(flags & LF_DONT_LOWER_ARGUMENTS)
		    && is_aggregate_type(param_type)) {
146
147
148
149
		    /* turn parameter into a pointer type */
		    param_type = new_type_pointer(param_type);
		}
		params[nn_params++] = param_type;
150
151
152
	}
	assert(nn_ress <= n_ress);
	assert(nn_params <= n_params + n_ress);
153
154

	/* create the new type */
155
156
	lowered = new_type_method(nn_params, nn_ress);
	set_type_dbg_info(lowered, get_type_dbg_info(mtp));
157
158

	/* fill it */
yb9976's avatar
yb9976 committed
159
	for (size_t i = 0; i < nn_params; ++i)
160
		set_method_param_type(lowered, i, params[i]);
yb9976's avatar
yb9976 committed
161
	for (size_t i = 0; i < nn_ress; ++i)
162
163
		set_method_res_type(lowered, i, results[i]);

164
	set_method_variadicity(lowered, get_method_variadicity(mtp));
165

yb9976's avatar
yb9976 committed
166
	unsigned cconv = get_method_calling_convention(mtp);
167
168
169
170
171
	if (nn_params > n_params) {
		cconv |= cc_compound_ret;
	}
	set_method_calling_convention(lowered, cconv);

yb9976's avatar
yb9976 committed
172
	mtp_additional_properties mtp_properties = get_method_additional_properties(mtp);
173
174
175
176
	/* after lowering the call is not const anymore, since it writes to the
	 * memory for the return value passed to it */
	mtp_properties &= ~mtp_property_const;
	set_method_additional_properties(lowered, mtp_properties);
177

178
	/* associate the lowered type with the original one for easier access */
179
	set_higher_type(lowered, mtp);
180
	pmap_insert(lowered_mtps, mtp, lowered);
181
182

	return lowered;
183
184
185
}

/**
186
187
188
189
 * A call list entry.
 */
typedef struct cl_entry cl_entry;
struct cl_entry {
190
191
192
	cl_entry *next;   /**< Pointer to the next entry. */
	ir_node  *call;   /**< Pointer to the Call node. */
	ir_node  *copyb;  /**< List of all CopyB nodes. */
193
194
	bool      has_compound_ret   : 1;
	bool      has_compound_param : 1;
195
196
197
198
};

/**
 * Walker environment for fix_args_and_collect_calls().
199
 */
200
typedef struct wlk_env_t {
Michael Beck's avatar
Michael Beck committed
201
	size_t               arg_shift;        /**< The Argument index shift for parameters. */
202
203
	struct obstack       obst;             /**< An obstack to allocate the data on. */
	cl_entry             *cl_list;         /**< The call list. */
204
	compound_call_lowering_flags flags;
205
	ir_type              *lowered_mtp;     /**< The lowered method type of the current irg if any. */
206
207
	bool                  only_local_mem:1;/**< Set if only local memory access was found. */
	bool                  changed:1;       /**< Set if the current graph was changed. */
208
209
210
} wlk_env;

/**
211
212
213
214
215
216
217
 * 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.
 */
218
static cl_entry *get_call_entry(ir_node *call, wlk_env *env)
219
{
220
	cl_entry *res = (cl_entry*)get_irn_link(call);
221
	if (res == NULL) {
222
		res = OALLOC(&env->obst, cl_entry);
223
224
225
226
227
228
229
		res->next  = env->cl_list;
		res->call  = call;
		res->copyb = NULL;
		set_irn_link(call, res);
		env->cl_list = res;
	}
	return res;
230
231
232
}

/**
233
234
235
236
237
238
 * Finds the base address of an address by skipping Sel's and address
 * calculation.
 *
 * @param adr   the address
 * @param pEnt  points to the base entity if any
 */
239
240
static ir_node *find_base_adr(ir_node *ptr, ir_entity **pEnt)
{
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
	ir_entity *ent = NULL;
	assert(mode_is_reference(get_irn_mode(ptr)));

	for (;;) {
		if (is_Sel(ptr)) {
			ent = get_Sel_entity(ptr);
			ptr = get_Sel_ptr(ptr);
		}
		else if (is_Add(ptr)) {
			ir_node *left = get_Add_left(ptr);
			if (mode_is_reference(get_irn_mode(left)))
				ptr = left;
			else
				ptr = get_Add_right(ptr);
			ent = NULL;
		} else if (is_Sub(ptr)) {
			ptr = get_Sub_left(ptr);
			ent = NULL;
		} else {
			*pEnt = ent;
			return ptr;
		}
	}
}

/**
 * Check if a given pointer represents non-local memory.
 */
269
270
static void check_ptr(ir_node *ptr, wlk_env *env)
{
yb9976's avatar
yb9976 committed
271
	ir_entity *ent;
272
273
274

	/* still alias free */
	ptr = find_base_adr(ptr, &ent);
yb9976's avatar
yb9976 committed
275
	ir_storage_class_class_t sc = get_base_sc(classify_pointer(ptr, ent));
276
277
	if (sc != ir_sc_localvar && sc != ir_sc_malloced) {
		/* non-local memory access */
278
		env->only_local_mem = false;
279
280
281
	}
}

282
283
284
285
286
287
288
289
290
291
292
293
/*
 * Returns non-zero if a Call is surely a self-recursive Call.
 * Beware: if this functions returns 0, the call might be self-recursive!
 */
static bool is_self_recursive_Call(const ir_node *call)
{
	const ir_node *callee = get_Call_ptr(call);

	if (is_SymConst_addr_ent(callee)) {
		const ir_entity *ent = get_SymConst_entity(callee);
		const ir_graph  *irg = get_entity_irg(ent);
		if (irg == get_irn_irg(call))
294
			return true;
295
	}
296
	return false;
297
298
}

299
300
/**
 * Post walker: shift all parameter indexes
301
 * and collect Calls with compound returns in the call list.
302
303
 * If a non-alias free memory access is found, reset the alias free
 * flag.
304
 */
305
306
static void fix_args_and_collect_calls(ir_node *n, void *ctx)
{
307
	wlk_env *env = (wlk_env*)ctx;
308
309
310
311
312

	switch (get_irn_opcode(n)) {
	case iro_Load:
	case iro_Store:
		if (env->only_local_mem) {
yb9976's avatar
yb9976 committed
313
			ir_node *ptr = get_irn_n(n, 1);
314
315
316
317
318
			check_ptr(ptr, env);
		}
		break;
	case iro_Proj:
		if (env->arg_shift > 0) {
yb9976's avatar
yb9976 committed
319
320
			ir_node  *pred = get_Proj_pred(n);
			ir_graph *irg  = get_irn_irg(n);
321
322

			/* Fix the argument numbers */
323
			if (pred == get_irg_args(irg)) {
324
325
				long pnr = get_Proj_proj(n);
				set_Proj_proj(n, pnr + env->arg_shift);
326
				env->changed = true;
327
328
329
			}
		}
		break;
330
	case iro_Call: {
331
332
333
		ir_type *ctp      = get_Call_type(n);
		size_t   n_ress   = get_method_n_ress(ctp);
		size_t   n_params = get_method_n_params(ctp);
334
335
		if (! is_self_recursive_Call(n)) {
			/* any non self recursive call might access global memory */
336
			env->only_local_mem = false;
337
		}
338

339
		/* check for compound returns */
yb9976's avatar
yb9976 committed
340
		for (size_t i = 0; i < n_ress; ++i) {
341
			ir_type *type = get_method_res_type(ctp, i);
342
			if (is_aggregate_type(type)) {
343
344
345
346
				/*
				 * This is a call with a compound return. As the result
				 * might be ignored, we must put it in the list.
				 */
347
348
349
350
351
				cl_entry *entry = get_call_entry(n, env);
				entry->has_compound_ret = true;
				break;
			}
		}
yb9976's avatar
yb9976 committed
352
		for (size_t i = 0; i < n_params; ++i) {
353
			ir_type *type = get_method_param_type(ctp, i);
354
			if (is_aggregate_type(type)) {
355
356
				cl_entry *entry = get_call_entry(n, env);
				entry->has_compound_param = true;
357
				break;
358
359
			}
		}
360
		break;
361
362
363
	}
	case iro_CopyB: {
		ir_node *src = get_CopyB_src(n);
364
365
366
367
368
		if (env->only_local_mem) {
			check_ptr(get_CopyB_src(n), env);
			if (env->only_local_mem)
				check_ptr(get_CopyB_dst(n), env);
		}
369
370
371
372
373
374
		/* check for compound returns */
		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)) {
375
					ir_type *ctp = get_Call_type(call);
376
					if (is_aggregate_type(get_method_res_type(ctp, get_Proj_proj(src)))) {
377
						/* found a CopyB from compound Call result */
378
						cl_entry *e = get_call_entry(call, env);
379
380
						set_irn_link(n, e->copyb);
						e->copyb = n;
381
382
383
					}
				}
			}
384
		}
385
		break;
386
	}
387
	case iro_Sel: {
388
389
390
		ir_entity *entity = get_Sel_entity(n);
		ir_type   *type   = get_entity_type(entity);

391
		if (is_parameter_entity(entity) && is_aggregate_type(type)) {
392
393
394
395
396
397
398
399
400
401
402
			if (! (env->flags & LF_DONT_LOWER_ARGUMENTS)) {
				/* note that num was already modified by fix_parameter_entities
				 * so no need to add env->arg_shift again */
				size_t num = get_entity_parameter_number(entity);
				ir_graph *irg  = get_irn_irg(n);
				ir_node  *args = get_irg_args(irg);
				ir_node  *ptr  = new_r_Proj(args, mode_P, num);
				exchange(n, ptr);
				/* hack to avoid us visiting the proj again */
				mark_irn_visited(ptr);
			}
403

404
405
			/* we need to copy compound parameters */
			env->only_local_mem = false;
406
407
408
		}
		break;
	}
409
410
411
	default:
		/* do nothing */
		break;
412
	}
413
414
415
}

/**
416
417
 * Returns non-zero if a node is a compound address
 * of a frame-type entity.
418
419
420
421
 *
 * @param ft   the frame type
 * @param adr  the node
 */
422
static bool is_compound_address(ir_type *ft, ir_node *adr)
423
{
424
	if (! is_Sel(adr))
425
		return false;
426
	if (get_Sel_n_indexs(adr) != 0)
427
		return false;
yb9976's avatar
yb9976 committed
428
	ir_entity *ent = get_Sel_entity(adr);
429
	return get_entity_owner(ent) == ft;
430
431
}

432
/** A pair for the copy-return-optimization. */
433
typedef struct cr_pair {
434
435
	ir_entity *ent; /**< the entity than can be removed from the frame */
	ir_node *arg;   /**< the argument that replaces the entities address */
436
437
438
439
440
441
} cr_pair;

/**
 * Post walker: fixes all entities addresses for the copy-return
 * optimization.
 *
yb9976's avatar
yb9976 committed
442
 * Note: We expect the length of the cr_pair array (i.e. number of compound
443
444
 * return values) to be 1 (C, C++) in almost all cases, so ignore the
 * linear search complexity here.
445
 */
446
447
static void do_copy_return_opt(ir_node *n, void *ctx)
{
448
449
	if (is_Sel(n)) {
		ir_entity *ent = get_Sel_entity(n);
450
		cr_pair   *arr = (cr_pair*)ctx;
451

yb9976's avatar
yb9976 committed
452
		for (size_t i = 0, l = ARR_LEN(arr); i < l; ++i) {
453
454
455
456
457
458
			if (ent == arr[i].ent) {
				exchange(n, arr[i].arg);
				break;
			}
		}
	}
459
460
461
}

/**
462
463
464
465
466
467
 * Return a Sel node that selects a dummy argument of type tp.
 *
 * @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
 */
468
static ir_node *get_dummy_sel(ir_graph *irg, ir_node *block, ir_type *tp)
469
{
yb9976's avatar
yb9976 committed
470
	ir_type *ft = get_irg_frame_type(irg);
471
472
473
	if (get_type_state(ft) == layout_fixed) {
		/* Fix the layout again */
		panic("Fixed layout not implemented");
474
	}
475

yb9976's avatar
yb9976 committed
476
477
	ident     *dummy_id = id_unique("dummy.%u");
	ir_entity *ent      = new_entity(ft, dummy_id, tp);
478
	return new_r_simpleSel(block, get_irg_no_mem(irg), get_irg_frame(irg), ent);
479
480
481
482
483
}

/**
 * Add the hidden parameter from the CopyB node to the Call node.
 */
484
static void add_hidden_param(ir_graph *irg, size_t n_com, ir_node **ins,
485
                             cl_entry *entry, ir_type *ctp)
486
{
yb9976's avatar
yb9976 committed
487
	size_t n_args = 0;
488

yb9976's avatar
yb9976 committed
489
	for (ir_node *p = entry->copyb, *n; p; p = n) {
490
491
492
		ir_node *src = get_CopyB_src(p);
		size_t   idx = get_Proj_proj(src);
		n = (ir_node*)get_irn_link(p);
493

494
495
496
		/* consider only the first CopyB */
		if (ins[idx] == NULL) {
			/* use the memory output of the call and not the input of the CopyB
497
			 * otherwise stuff breaks if the call was mtp_property_const,
yb9976's avatar
yb9976 committed
498
			 * because then the CopyB skips the call. But after lowering the
499
			 * call is not const anymore, and its memory has to be used */
500
501
502
503
			ir_node *mem = new_r_Proj(entry->call, mode_M, pn_Call_M);

			ins[idx] = get_CopyB_dst(p);
			/* get rid of the CopyB */
504
			exchange(p, mem);
505
506
			++n_args;
		}
507
508
509
510
	}

	/* now create dummy entities for function with ignored return value */
	if (n_args < n_com) {
yb9976's avatar
yb9976 committed
511
		for (size_t i = 0, j = 0; i < get_method_n_ress(ctp); ++i) {
512
			ir_type *rtp = get_method_res_type(ctp, i);
513
			if (is_aggregate_type(rtp)) {
514
				if (ins[j] == NULL)
515
					ins[j] = get_dummy_sel(irg, get_nodes_block(entry->call), rtp);
516
517
518
519
				++j;
			}
		}
	}
520
521
}

522
static void fix_compound_ret(cl_entry *entry, ir_type *ctp)
523
{
yb9976's avatar
yb9976 committed
524
525
526
527
528
	ir_node *call  = entry->call;
	size_t   n_com = 0;
	size_t   n_res = get_method_n_ress(ctp);

	for (size_t i = 0; i < n_res; ++i) {
529
		ir_type *type = get_method_res_type(ctp, i);
530
		if (is_aggregate_type(type))
531
532
533
			++n_com;
	}

yb9976's avatar
yb9976 committed
534
535
536
537
538
	ir_graph  *irg      = get_irn_irg(call);
	size_t     n_params = get_Call_n_params(call);
	size_t     pos      = 0;
	ir_node  **new_in   = ALLOCANZ(ir_node*, n_params + n_com + (n_Call_max+1));

539
540
541
	new_in[pos++] = get_Call_mem(call);
	new_in[pos++] = get_Call_ptr(call);
	assert(pos == n_Call_max+1);
542
	add_hidden_param(irg, n_com, &new_in[pos], entry, ctp);
543
544
545
	pos += n_com;

	/* copy all other parameters */
yb9976's avatar
yb9976 committed
546
	for (size_t i = 0; i < n_params; ++i) {
547
548
549
550
551
552
553
		ir_node *param = get_Call_param(call, i);
		new_in[pos++] = param;
	}
	assert(pos == n_params+n_com+(n_Call_max+1));
	set_irn_in(call, pos, new_in);
}

Manuel Mohr's avatar
Manuel Mohr committed
554
static ir_entity *create_compound_arg_entity(ir_graph *irg, ir_type *type)
555
556
557
558
559
{
	ir_type   *frame  = get_irg_frame_type(irg);
	ident     *id     = id_unique("$compound_param.%u");
	ir_entity *entity = new_entity(frame, id, type);
	/* TODO:
560
	 * we could do some optimizations here and create a big union type for all
561
562
563
564
565
566
567
568
569
570
571
572
573
	 * different call types in a function */
	return entity;
}

static void fix_compound_params(cl_entry *entry, ir_type *ctp)
{
	ir_node  *call     = entry->call;
	dbg_info *dbgi     = get_irn_dbg_info(call);
	ir_node  *mem      = get_Call_mem(call);
	ir_graph *irg      = get_irn_irg(call);
	ir_node  *nomem    = new_r_NoMem(irg);
	ir_node  *frame    = get_irg_frame(irg);
	size_t    n_params = get_method_n_params(ctp);
yb9976's avatar
yb9976 committed
574
575
576

	for (size_t i = 0; i < n_params; ++i) {
		ir_type *type = get_method_param_type(ctp, i);
577
		if (!is_aggregate_type(type))
578
579
			continue;

yb9976's avatar
yb9976 committed
580
581
582
583
584
585
		ir_node   *arg         = get_Call_param(call, i);
		ir_entity *arg_entity  = create_compound_arg_entity(irg, type);
		ir_node   *block       = get_nodes_block(call);
		ir_node   *sel         = new_rd_simpleSel(dbgi, block, nomem, frame, arg_entity);
		bool       is_volatile = is_partly_volatile(arg);
		mem = new_rd_CopyB(dbgi, block, mem, sel, arg, type, is_volatile ? cons_volatile : cons_none);
586
587
588
589
590
591
592
		set_Call_param(call, i, sel);
	}
	set_Call_mem(call, mem);
}

static void fix_calls(wlk_env *env)
{
yb9976's avatar
yb9976 committed
593
	for (cl_entry *entry = env->cl_list; entry; entry = entry->next) {
594
595
596
597
		ir_node *call        = entry->call;
		ir_type *ctp         = get_Call_type(call);
		ir_type *lowered_mtp = lower_mtp(env->flags, ctp);
		set_Call_type(call, lowered_mtp);
598

599
600
601
602
		if (entry->has_compound_param) {
			fix_compound_params(entry, ctp);
		}
		if (entry->has_compound_ret) {
603
			fix_compound_ret(entry, ctp);
604
605
		}
	}
606
607
608
609
610
611
612
613
}

/**
 * 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.
 *
614
615
 * @param irg  the graph to transform
 */
616
static void transform_irg(compound_call_lowering_flags flags, ir_graph *irg)
617
{
618
619
620
621
622
	ir_entity *ent         = get_irg_entity(irg);
	ir_type   *mtp         = get_entity_type(ent);
	size_t     n_ress      = get_method_n_ress(mtp);
	size_t     n_params    = get_method_n_params(mtp);
	size_t     n_param_com = 0;
yb9976's avatar
yb9976 committed
623
	wlk_env    env;
624

625
	/* calculate the number of compound returns */
626
	size_t n_ret_com = 0;
yb9976's avatar
yb9976 committed
627
	for (size_t i = 0; i < n_ress; ++i) {
628
		ir_type *type = get_method_res_type(mtp, i);
629
		if (is_aggregate_type(type))
630
			++n_ret_com;
631
	}
yb9976's avatar
yb9976 committed
632
	for (size_t i = 0; i < n_params; ++i) {
633
		ir_type *type = get_method_param_type(mtp, i);
634
		if (is_aggregate_type(type))
635
636
			++n_param_com;
	}
637

638
639
	if (n_ret_com > 0)
		fix_parameter_entities(irg, n_ret_com);
640

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

645
		/* hidden arguments are added first */
646
		env.arg_shift = n_ret_com;
647
648
649
650
	} else {
		/* we must only search for calls */
		env.arg_shift = 0;
	}
651

yb9976's avatar
yb9976 committed
652
	ir_type *lowered_mtp = lower_mtp(flags, mtp);
653
654
	set_entity_type(ent, lowered_mtp);

655
	obstack_init(&env.obst);
656
	env.cl_list        = NULL;
657
	env.flags          = flags;
658
	env.lowered_mtp    = lowered_mtp;
659
660
	env.only_local_mem = true;
	env.changed        = false;
661
662

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

666
667
668
	if (n_param_com > 0 && !(flags & LF_DONT_LOWER_ARGUMENTS))
		remove_compound_param_entities(irg);

669
	/* fix all calls */
670
671
672
	if (env.cl_list != NULL) {
		fix_calls(&env);
		env.changed = true;
673
674
675
	}

	if (n_ret_com) {
Michael Beck's avatar
Michael Beck committed
676
677
		int idx;

678
		/* STEP 1: find the return. This is simple, we have normalized the graph. */
yb9976's avatar
yb9976 committed
679
680
		ir_node *endbl = get_irg_end_block(irg);
		ir_node *ret   = NULL;
Michael Beck's avatar
Michael Beck committed
681
682
		for (idx = get_Block_n_cfgpreds(endbl) - 1; idx >= 0; --idx) {
			ir_node *pred = get_Block_cfgpred(endbl, idx);
683
684
685
686
687
688

			if (is_Return(pred)) {
				ret = pred;
				break;
			}
		}
Andreas Zwinkau's avatar
Andreas Zwinkau committed
689
690

		/* in case of infinite loops, there might be no return */
Andreas Zwinkau's avatar
Andreas Zwinkau committed
691
692
693
694
		if (ret != NULL) {
			/*
			 * Now fix the Return node of the current graph.
			 */
695
			env.changed = true;
Andreas Zwinkau's avatar
Andreas Zwinkau committed
696
697
698
699
700

			/*
			 * STEP 2: fix it. For all compound return values add a CopyB,
			 * all others are copied.
			 */
yb9976's avatar
yb9976 committed
701
702
703
704
705
706
707
			ir_node  *bl       = get_nodes_block(ret);
			ir_node  *mem      = get_Return_mem(ret);
			ir_type  *ft       = get_irg_frame_type(irg);
			size_t    n_cr_opt = 0;
			size_t    j        = 1;
			ir_node **new_in;
			cr_pair  *cr_opt;
Andreas Zwinkau's avatar
Andreas Zwinkau committed
708
709
			NEW_ARR_A(ir_node *, new_in, n_ress + 1);
			NEW_ARR_A(cr_pair, cr_opt, n_ret_com);
yb9976's avatar
yb9976 committed
710
711

			for (size_t i = 0, k = 0; i < n_ress; ++i) {
Andreas Zwinkau's avatar
Andreas Zwinkau committed
712
				ir_node *pred = get_Return_res(ret, i);
yb9976's avatar
yb9976 committed
713
				ir_type *tp   = get_method_res_type(mtp, i);
Andreas Zwinkau's avatar
Andreas Zwinkau committed
714

715
				if (is_aggregate_type(tp)) {
Andreas Zwinkau's avatar
Andreas Zwinkau committed
716
					ir_node *arg = get_irg_args(irg);
717
					arg = new_r_Proj(arg, mode_P_data, k);
Andreas Zwinkau's avatar
Andreas Zwinkau committed
718
719
720
					++k;

					if (is_Unknown(pred)) {
721
722
						/* The Return(Unknown) is the Firm construct for a
						 * missing return. Do nothing. */
Andreas Zwinkau's avatar
Andreas Zwinkau committed
723
724
					} else {
						/**
725
726
727
						 * 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.
Andreas Zwinkau's avatar
Andreas Zwinkau committed
728
729
730
731
732
733
734
735
						 * A simple heuristic: all Loads/Stores inside
						 * the function access only local frame.
						 */
						if (env.only_local_mem && is_compound_address(ft, pred)) {
							/* 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;
736
737
738
						} else {
							/* copy-return optimization is impossible, do the
							 * copy. */
739
740
741
							bool is_volatile = is_partly_volatile(pred);

							mem = new_r_CopyB(bl, mem, arg, pred, tp, is_volatile ? cons_volatile : cons_none);
Andreas Zwinkau's avatar
Andreas Zwinkau committed
742
						}
743
					}
744
					if (flags & LF_RETURN_HIDDEN) {
Andreas Zwinkau's avatar
Andreas Zwinkau committed
745
746
747
748
749
						new_in[j] = arg;
						++j;
					}
				} else { /* scalar return value */
					new_in[j] = pred;
750
751
752
					++j;
				}
			}
Andreas Zwinkau's avatar
Andreas Zwinkau committed
753
754
755
			/* replace the in of the Return */
			new_in[0] = mem;
			set_irn_in(ret, j, new_in);
756

Andreas Zwinkau's avatar
Andreas Zwinkau committed
757
758
			if (n_cr_opt > 0) {
				irg_walk_graph(irg, NULL, do_copy_return_opt, cr_opt);
759

yb9976's avatar
yb9976 committed
760
				for (size_t c = 0, n = ARR_LEN(cr_opt); c < n; ++c) {
761
					free_entity(cr_opt[c].ent);
Andreas Zwinkau's avatar
Andreas Zwinkau committed
762
				}
763
764
			}
		}
765
	}
766
767

	obstack_free(&env.obst, NULL);
768
}
769

770
static void lower_method_types(type_or_ent tore, void *env)
771
{
772
773
	const compound_call_lowering_flags *flags
		= (const compound_call_lowering_flags*)env;
774
775

	/* fix method entities */
776
	if (is_entity(tore.ent)) {
777
778
779
780
		ir_entity *ent     = tore.ent;
		ir_type   *tp      = get_entity_type(ent);
		ir_type   *lowered = lower_mtp(*flags, tp);
		set_entity_type(ent, lowered);
781
	} else {
782
		ir_type *tp = tore.typ;
783
784
785

		/* fix pointer to methods */
		if (is_Pointer_type(tp)) {
786
787
788
			ir_type *points_to         = get_pointer_points_to_type(tp);
			ir_type *lowered_points_to = lower_mtp(*flags, points_to);
			set_pointer_points_to_type(tp, lowered_points_to);
789
790
		}
	}
791
792
}

793
void lower_calls_with_compounds(compound_call_lowering_flags flags)
794
{
795
796
	pointer_types = pmap_create();
	lowered_mtps = pmap_create();
797

798
	/* first step: Transform all graphs */
yb9976's avatar
yb9976 committed
799
	for (size_t i = 0, n = get_irp_n_irgs(); i < n; ++i) {
800
801
		ir_graph *irg = get_irp_irg(i);
		transform_irg(flags, irg);
802
	}
803

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

807
808
	pmap_destroy(lowered_mtps);
	pmap_destroy(pointer_types);
809
}