beuses.c 10.5 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
2
 * Copyright (C) 1995-2011 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.
 */

Sebastian Hack's avatar
Sebastian Hack committed
20
/**
Christian Würdig's avatar
Christian Würdig committed
21
22
23
24
25
 * @file
 * @brief       Methods to compute when a value will be used again.
 * @author      Sebastian Hack, Matthias Braun
 * @date        27.06.2005
 * @version     $Id$
Sebastian Hack's avatar
Sebastian Hack committed
26
 */
27
#include "config.h"
Sebastian Hack's avatar
Sebastian Hack committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

#include <limits.h>
#include <stdlib.h>

#include "config.h"
#include "obst.h"
#include "pmap.h"
#include "debug.h"

#include "irgwalk.h"
#include "irnode_t.h"
#include "ircons_t.h"
#include "irgraph_t.h"
#include "iredges_t.h"
#include "irdom_t.h"
43
#include "irtools.h"
Sebastian Hack's avatar
Sebastian Hack committed
44
45
46
47

#include "be_t.h"
#include "beutil.h"
#include "belive_t.h"
48
#include "benode.h"
49
#include "besched.h"
Sebastian Hack's avatar
Sebastian Hack committed
50
#include "beirgmod.h"
51
#include "bearch.h"
Christian Würdig's avatar
Christian Würdig committed
52
#include "beuses.h"
Sebastian Hack's avatar
Sebastian Hack committed
53

Matthias Braun's avatar
Matthias Braun committed
54
55
#define UNKNOWN_OUTERMOST_LOOP  ((unsigned)-1)

56
typedef struct be_use_t {
57
58
	const ir_node *block;
	const ir_node *node;
Matthias Braun's avatar
Matthias Braun committed
59
	unsigned outermost_loop;
Daniel Grund's avatar
Daniel Grund committed
60
	unsigned next_use;
61
	ir_visited_t visited;
Sebastian Hack's avatar
Sebastian Hack committed
62
63
} be_use_t;

64
65
66
/**
 * The "uses" environment.
 */
67
struct be_uses_t {
68
69
70
71
72
	set *uses;                          /**< cache: contains all computed uses so far. */
	ir_graph *irg;                      /**< the graph for this environment. */
	const be_lv_t *lv;                  /**< the liveness for the graph. */
	ir_visited_t visited_counter;       /**< current search counter. */
	DEBUG_ONLY(firm_dbg_module_t *dbg;  /**< debug module for debug messages. */)
Sebastian Hack's avatar
Sebastian Hack committed
73
74
};

75
76
77
/**
 * Set-compare two uses.
 */
Sebastian Hack's avatar
Sebastian Hack committed
78
79
static int cmp_use(const void *a, const void *b, size_t n)
{
80
81
	const be_use_t *p = (const be_use_t*)a;
	const be_use_t *q = (const be_use_t*)b;
82
83
	(void) n;

84
	return !(p->block == q->block && p->node == q->node);
Sebastian Hack's avatar
Sebastian Hack committed
85
86
}

87
static be_next_use_t get_next_use(be_uses_t *env, ir_node *from,
88
								  const ir_node *def, int skip_from_uses);
89

90
91
92
93
94
95
96
97
/**
 * Return the use for the given definition in the given block if exists,
 * else create it.
 *
 * @param env    the uses environment
 * @param block  the block we search the use in
 * @param def    the definition of the value we are searching
 */
98
static const be_use_t *get_or_set_use_block(be_uses_t *env,
99
100
                                            const ir_node *block,
                                            const ir_node *def)
Sebastian Hack's avatar
Sebastian Hack committed
101
{
102
	unsigned hash = HASH_COMBINE(hash_irn(block), hash_irn(def));
103
104
	be_use_t temp;
	be_use_t* result;
105

106
107
	temp.block = block;
	temp.node = def;
108
	result = (be_use_t*)set_find(env->uses, &temp, sizeof(temp), hash);
Sebastian Hack's avatar
Sebastian Hack committed
109

110
	if (result == NULL) {
111
112
113
		// insert templ first as we might end in a loop in the get_next_use
		// call otherwise
		temp.next_use = USES_INFINITY;
Matthias Braun's avatar
Matthias Braun committed
114
		temp.outermost_loop = UNKNOWN_OUTERMOST_LOOP;
115
		temp.visited = 0;
116
		result = (be_use_t*)set_insert(env->uses, &temp, sizeof(temp), hash);
117
118
	}

Matthias Braun's avatar
Matthias Braun committed
119
	if (result->outermost_loop == UNKNOWN_OUTERMOST_LOOP && result->visited < env->visited_counter) {
120
		be_next_use_t next_use;
Sebastian Hack's avatar
Sebastian Hack committed
121

122
		result->visited = env->visited_counter;
123
		next_use = get_next_use(env, sched_first(block), def, 0);
Matthias Braun's avatar
Matthias Braun committed
124
		if (next_use.outermost_loop != UNKNOWN_OUTERMOST_LOOP) {
125
126
			result->next_use = next_use.time;
			result->outermost_loop = next_use.outermost_loop;
127
128
			DBG((env->dbg, LEVEL_5, "Setting nextuse of %+F in block %+F to %u (outermostloop %d)\n",
				def, block, result->next_use, result->outermost_loop));
129
		}
130
	}
131

132
	return result;
Sebastian Hack's avatar
Sebastian Hack committed
133
134
}

135
136
137
138
139
140
141
142
143
144
/**
 * Check if a value of the given definition is used in the given block
 * as a Phi argument.
 *
 * @param block  the block to check
 * @param def    the definition of the value
 *
 * @return non-zero if the value is used in the given block as a Phi argument
 * in one of its successor blocks.
 */
145
static int be_is_phi_argument(const ir_node *block, const ir_node *def)
146
{
147
	ir_node *node;
Matthias Braun's avatar
Matthias Braun committed
148
	ir_node *succ_block = NULL;
149
150
	int arity, i;

151
152
153
154
#if 1
	if (get_irn_n_edges_kind(block, EDGE_KIND_BLOCK) < 1)
#else
	if (get_irn_n_edges_kind(block, EDGE_KIND_BLOCK) != 1)
155
#endif
156
		return 0;
157

158
	succ_block = get_first_block_succ(block);
159
160

	arity = get_Block_n_cfgpreds(succ_block);
161
162
	if (arity <= 1) {
		/* no Phis in the successor */
163
		return 0;
164
	}
165

166
	/* find the index of block in its successor */
167
168
	for (i = 0; i < arity; ++i) {
		if (get_Block_cfgpred_block(succ_block, i) == block)
169
170
171
172
			break;
	}
	assert(i < arity);

173
174
	/* iterate over the Phi nodes in the successor and check if def is
	 * one of its arguments */
175
176
177
	sched_foreach(succ_block, node) {
		ir_node *arg;

178
179
		if (!is_Phi(node)) {
			/* found first non-Phi node, we can stop the search here */
180
			break;
181
		}
182
183

		arg = get_irn_n(node, i);
184
		if (arg == def)
185
186
187
188
			return 1;
	}

	return 0;
189
190
}

191
192
193
194
195
196
/**
 * Retrieve the scheduled index (the "step") of this node in its
 * block.
 *
 * @param node  the node
 */
197
static inline unsigned get_step(const ir_node *node)
198
{
199
200
201
202
203
204
205
206
207
208
209
210
211
	return (unsigned)PTR_TO_INT(get_irn_link(node));
}

/**
 * Set the scheduled index (the "step") of this node in its
 * block.
 *
 * @param node  the node
 * @param step  the scheduled index of the node
 */
static inline void set_step(ir_node *node, unsigned step)
{
	set_irn_link(node, INT_TO_PTR(step));
212
213
}

214
215
216
217
218
219
220
221
/**
 * Find the next use of a value defined by def, starting at node from.
 *
 * @param env             the uses environment
 * @param from            the node at which we should start the search
 * @param def             the definition of the value
 * @param skip_from_uses  if non-zero, ignore from uses
 */
222
static be_next_use_t get_next_use(be_uses_t *env, ir_node *from,
223
								  const ir_node *def, int skip_from_uses)
Sebastian Hack's avatar
Sebastian Hack committed
224
{
225
	unsigned  step;
226
	ir_node  *block = get_nodes_block(from);
227
	ir_node  *next_use_node;
228
229
	ir_node  *node;
	unsigned  timestep;
230
	unsigned  next_use_step;
231
	const ir_edge_t *edge;
Sebastian Hack's avatar
Sebastian Hack committed
232

233
	assert(skip_from_uses == 0 || skip_from_uses == 1);
234
	if (skip_from_uses) {
235
236
237
		from = sched_next(from);
	}

238
	next_use_node = NULL;
239
240
241
	next_use_step = INT_MAX;
	timestep      = get_step(from);
	foreach_out_edge(def, edge) {
242
		unsigned node_step;
Michael Beck's avatar
Michael Beck committed
243
		node = get_edge_src_irn(edge);
244

245
		if (is_Anchor(node))
246
			continue;
247
		if (get_nodes_block(node) != block)
248
			continue;
249
		if (is_Phi(node))
250
251
252
			continue;

		node_step = get_step(node);
253
		if (node_step < timestep)
254
			continue;
255
		if (node_step < next_use_step) {
256
			next_use_node = node;
257
258
259
260
			next_use_step = node_step;
		}
	}

261
	if (next_use_node != NULL) {
262
263
264
		be_next_use_t result;
		result.time           = next_use_step - timestep + skip_from_uses;
		result.outermost_loop = get_loop_depth(get_irn_loop(block));
265
		result.before         = next_use_node;
266
267
268
269
270
271
		return result;
	}

	node = sched_last(block);
	step = get_step(node) + 1 + timestep + skip_from_uses;

272
	if (be_is_phi_argument(block, def)) {
273
274
275
		// TODO we really should continue searching the uses of the phi,
		// as a phi isn't a real use that implies a reload (because we could
		// easily spill the whole phi)
276
277

		be_next_use_t result;
278
		result.time           = step;
279
		result.outermost_loop = get_loop_depth(get_irn_loop(block));
280
		result.before         = block;
281
		return result;
282
	}
283
284

	{
Matthias Braun's avatar
Matthias Braun committed
285
286
	unsigned  next_use   = USES_INFINITY;
	unsigned  outermost_loop;
287
	be_next_use_t result;
Matthias Braun's avatar
Matthias Braun committed
288
289
290
291
292
293
	ir_loop  *loop          = get_irn_loop(block);
	unsigned  loopdepth     = get_loop_depth(loop);
	int       found_visited = 0;
	int       found_use     = 0;
	ir_graph *irg           = get_irn_irg(block);
	ir_node  *startblock    = get_irg_start_block(irg);
294

295
	result.before  = NULL;
296
	outermost_loop = loopdepth;
297
298
299
	foreach_block_succ(block, edge) {
		const be_use_t *use;
		const ir_node *succ_block = get_edge_src_irn(edge);
300
		ir_loop *succ_loop;
301
		unsigned use_dist;
Christian Würdig's avatar
Christian Würdig committed
302

303
		if (succ_block == startblock)
304
			continue;
Sebastian Hack's avatar
Sebastian Hack committed
305

306
		DBG((env->dbg, LEVEL_5, "Checking succ of block %+F: %+F (for use of %+F)\n", block, succ_block, def));
307
		if (!be_is_live_in(env->lv, succ_block, def)) {
308
309
310
311
			//next_use = USES_INFINITY;
			DBG((env->dbg, LEVEL_5, "   not live in\n"));
			continue;
		}
312

313
		use = get_or_set_use_block(env, succ_block, def);
Matthias Braun's avatar
Matthias Braun committed
314
		DBG((env->dbg, LEVEL_5, "Found %u (loopdepth %u) (we're in block %+F)\n", use->next_use,
315
					use->outermost_loop, block));
316
		if (USES_IS_INFINITE(use->next_use)) {
Matthias Braun's avatar
Matthias Braun committed
317
			if (use->outermost_loop == UNKNOWN_OUTERMOST_LOOP) {
318
				found_visited = 1;
319
			}
320
321
			continue;
		}
322

323
324
		found_use = 1;
		use_dist = use->next_use;
325

326
		succ_loop = get_irn_loop(succ_block);
327
		if (get_loop_depth(succ_loop) < loopdepth) {
328
			unsigned factor = (loopdepth - get_loop_depth(succ_loop)) * 5000;
329
330
331
			DBG((env->dbg, LEVEL_5, "Increase usestep because of loop out edge %d -> %d (%u)\n", factor));
			// TODO we should use the number of nodes in the loop or so...
			use_dist += factor;
Sebastian Hack's avatar
Sebastian Hack committed
332
		}
333

334
		if (use_dist < next_use) {
335
			next_use       = use_dist;
336
			outermost_loop = use->outermost_loop;
337
			result.before  = use->node;
338
		}
Daniel Grund's avatar
Daniel Grund committed
339
	}
Sebastian Hack's avatar
Sebastian Hack committed
340

341
	if (loopdepth < outermost_loop)
342
		outermost_loop = loopdepth;
Sebastian Hack's avatar
Sebastian Hack committed
343

344
	result.time           = next_use + step;
345
	result.outermost_loop = outermost_loop;
Sebastian Hack's avatar
Sebastian Hack committed
346

347
	if (!found_use && found_visited) {
348
349
		// the current result is correct for the current search, but isn't
		// generally correct, so mark it
Matthias Braun's avatar
Matthias Braun committed
350
		result.outermost_loop = UNKNOWN_OUTERMOST_LOOP;
351
	}
Matthias Braun's avatar
Matthias Braun committed
352
	DBG((env->dbg, LEVEL_5, "Result: %d (outerloop: %u)\n", result.time, result.outermost_loop));
353
	return result;
354
	}
Sebastian Hack's avatar
Sebastian Hack committed
355
356
}

357
be_next_use_t be_get_next_use(be_uses_t *env, ir_node *from,
358
                         const ir_node *def, int skip_from_uses)
359
{
360
361
	++env->visited_counter;
	return get_next_use(env, from, def, skip_from_uses);
362
363
}

364
365
366
367
368
369
370
/**
 * Pre-block walker, set the step number for every scheduled node
 * in increasing order.
 *
 * After this, two scheduled nodes can be easily compared for the
 * "scheduled earlier in block" property.
 */
371
static void set_sched_step_walker(ir_node *block, void *data)
372
373
374
{
	ir_node  *node;
	unsigned step = 0;
375
	(void) data;
376
377

	sched_foreach(block, node) {
378
		set_step(node, step);
379
		if (is_Phi(node))
380
381
382
383
384
			continue;
		++step;
	}
}

385
be_uses_t *be_begin_uses(ir_graph *irg, const be_lv_t *lv)
Sebastian Hack's avatar
Sebastian Hack committed
386
{
387
	be_uses_t *env = XMALLOC(be_uses_t);
Sebastian Hack's avatar
Sebastian Hack committed
388

389
	edges_assure(irg);
Sebastian Hack's avatar
Sebastian Hack committed
390

391
392
393
394
395
	//set_using_irn_link(irg);

	/* precalculate sched steps */
	irg_block_walk_graph(irg, set_sched_step_walker, NULL, NULL);

396
397
398
399
400
	env->uses = new_set(cmp_use, 512);
	env->irg = irg;
	env->lv = lv;
	env->visited_counter = 0;
	FIRM_DBG_REGISTER(env->dbg, "firm.be.uses");
Sebastian Hack's avatar
Sebastian Hack committed
401

402
	return env;
Sebastian Hack's avatar
Sebastian Hack committed
403
404
}

405
void be_end_uses(be_uses_t *env)
Sebastian Hack's avatar
Sebastian Hack committed
406
{
407
	//clear_using_irn_link(env->irg);
408
409
	del_set(env->uses);
	free(env);
Sebastian Hack's avatar
Sebastian Hack committed
410
}