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
43
44
45
46

#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"

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

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

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

63
64
65
/**
 * The "uses" environment.
 */
66
struct be_uses_t {
67
68
69
70
71
	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
72
73
};

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

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

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

89
90
91
92
93
94
95
96
/**
 * 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
 */
97
static const be_use_t *get_or_set_use_block(be_uses_t *env,
98
99
                                            const ir_node *block,
                                            const ir_node *def)
Sebastian Hack's avatar
Sebastian Hack committed
100
{
101
	unsigned hash = HASH_COMBINE(hash_irn(block), hash_irn(def));
102
103
	be_use_t temp;
	be_use_t* result;
104

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

109
	if (result == NULL) {
110
111
112
		// 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
113
		temp.outermost_loop = UNKNOWN_OUTERMOST_LOOP;
114
		temp.visited = 0;
115
		result = (be_use_t*)set_insert(env->uses, &temp, sizeof(temp), hash);
116
117
	}

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

121
		result->visited = env->visited_counter;
122
		next_use = get_next_use(env, sched_first(block), def, 0);
Matthias Braun's avatar
Matthias Braun committed
123
		if (next_use.outermost_loop != UNKNOWN_OUTERMOST_LOOP) {
124
125
			result->next_use = next_use.time;
			result->outermost_loop = next_use.outermost_loop;
126
127
			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));
128
		}
129
	}
130

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

134
135
136
137
138
139
140
141
142
143
/**
 * 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.
 */
144
static int be_is_phi_argument(const ir_node *block, const ir_node *def)
145
{
146
	ir_node *node;
Matthias Braun's avatar
Matthias Braun committed
147
	ir_node *succ_block = NULL;
148
149
	int arity, i;

150
151
152
153
#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)
154
#endif
155
		return 0;
156

157
	succ_block = get_first_block_succ(block);
158
159

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

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

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

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

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

	return 0;
188
189
}

190
191
192
193
194
195
/**
 * Retrieve the scheduled index (the "step") of this node in its
 * block.
 *
 * @param node  the node
 */
196
static inline unsigned get_step(const ir_node *node)
197
{
198
199
200
201
202
203
204
205
206
207
208
209
210
	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));
211
212
}

213
214
215
216
217
218
219
220
/**
 * 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
 */
221
static be_next_use_t get_next_use(be_uses_t *env, ir_node *from,
222
								  const ir_node *def, int skip_from_uses)
Sebastian Hack's avatar
Sebastian Hack committed
223
{
224
	unsigned  step;
225
	ir_node  *block = get_nodes_block(from);
226
	ir_node  *next_use_node;
227
228
	ir_node  *node;
	unsigned  timestep;
229
	unsigned  next_use_step;
230
	const ir_edge_t *edge;
Sebastian Hack's avatar
Sebastian Hack committed
231

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

237
	next_use_node = NULL;
238
239
240
	next_use_step = INT_MAX;
	timestep      = get_step(from);
	foreach_out_edge(def, edge) {
241
242
		node = get_edge_src_irn(edge);
		unsigned node_step;
243

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

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

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

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

271
	if (be_is_phi_argument(block, def)) {
272
273
274
		// 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)
275
276

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

	{
Matthias Braun's avatar
Matthias Braun committed
284
285
	unsigned  next_use   = USES_INFINITY;
	unsigned  outermost_loop;
286
	be_next_use_t result;
Matthias Braun's avatar
Matthias Braun committed
287
288
289
290
291
292
	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);
293

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

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

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

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

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

325
		succ_loop = get_irn_loop(succ_block);
326
		if (get_loop_depth(succ_loop) < loopdepth) {
327
			unsigned factor = (loopdepth - get_loop_depth(succ_loop)) * 5000;
328
329
330
			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
331
		}
332

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

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

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

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

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

363
364
365
366
367
368
369
/**
 * 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.
 */
370
static void set_sched_step_walker(ir_node *block, void *data)
371
372
373
{
	ir_node  *node;
	unsigned step = 0;
374
	(void) data;
375
376

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

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

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

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

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

395
396
397
398
399
	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
400

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

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