2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Methods to compute when a value will be used again.
23 * @author Sebastian Hack, Matthias Braun
39 #include "irgraph_t.h"
40 #include "iredges_t.h"
53 #define UNKNOWN_OUTERMOST_LOOP ((unsigned)-1)
55 typedef struct be_use_t {
58 unsigned outermost_loop;
64 * The "uses" environment.
67 set *uses; /**< cache: contains all computed uses so far. */
68 ir_graph *irg; /**< the graph for this environment. */
69 const be_lv_t *lv; /**< the liveness for the graph. */
70 ir_visited_t visited_counter; /**< current search counter. */
71 DEBUG_ONLY(firm_dbg_module_t *dbg; /**< debug module for debug messages. */)
75 * Set-compare two uses.
77 static int cmp_use(const void *a, const void *b, size_t n)
79 const be_use_t *p = (const be_use_t*)a;
80 const be_use_t *q = (const be_use_t*)b;
83 return !(p->block == q->block && p->node == q->node);
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);
90 * Return the use for the given definition in the given block if exists,
93 * @param env the uses environment
94 * @param block the block we search the use in
95 * @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,
101 unsigned hash = hash_combine(hash_irn(block), hash_irn(def));
107 result = set_find(be_use_t, env->uses, &temp, sizeof(temp), hash);
109 if (result == NULL) {
110 // insert templ first as we might end in a loop in the get_next_use
112 temp.next_use = USES_INFINITY;
113 temp.outermost_loop = UNKNOWN_OUTERMOST_LOOP;
115 result = set_insert(be_use_t, env->uses, &temp, sizeof(temp), hash);
118 if (result->outermost_loop == UNKNOWN_OUTERMOST_LOOP && result->visited < env->visited_counter) {
119 be_next_use_t next_use;
121 result->visited = env->visited_counter;
122 next_use = get_next_use(env, sched_first(block), def, 0);
123 if (next_use.outermost_loop != UNKNOWN_OUTERMOST_LOOP) {
124 result->next_use = next_use.time;
125 result->outermost_loop = next_use.outermost_loop;
126 DBG((env->dbg, LEVEL_5, "Setting nextuse of %+F in block %+F to %u (outermostloop %d)\n",
127 def, block, result->next_use, result->outermost_loop));
135 * Check if a value of the given definition is used in the given block
138 * @param block the block to check
139 * @param def the definition of the value
141 * @return non-zero if the value is used in the given block as a Phi argument
142 * in one of its successor blocks.
144 static int be_is_phi_argument(const ir_node *block, const ir_node *def)
147 if (get_irn_n_edges_kind(block, EDGE_KIND_BLOCK) < 1)
149 if (get_irn_n_edges_kind(block, EDGE_KIND_BLOCK) != 1)
153 ir_node *const succ_block = get_first_block_succ(block);
155 if (get_Block_n_cfgpreds(succ_block) <= 1) {
156 /* no Phis in the successor */
160 /* find the index of block in its successor */
161 int const i = get_Block_cfgpred_pos(succ_block, block);
164 /* iterate over the Phi nodes in the successor and check if def is
165 * one of its arguments */
166 sched_foreach(succ_block, node) {
170 /* found first non-Phi node, we can stop the search here */
174 arg = get_irn_n(node, i);
183 * Retrieve the scheduled index (the "step") of this node in its
186 * @param node the node
188 static inline unsigned get_step(const ir_node *node)
190 return (unsigned)PTR_TO_INT(get_irn_link(node));
194 * Set the scheduled index (the "step") of this node in its
197 * @param node the node
198 * @param step the scheduled index of the node
200 static inline void set_step(ir_node *node, unsigned step)
202 set_irn_link(node, INT_TO_PTR(step));
206 * Find the next use of a value defined by def, starting at node from.
208 * @param env the uses environment
209 * @param from the node at which we should start the search
210 * @param def the definition of the value
211 * @param skip_from_uses if non-zero, ignore from uses
213 static be_next_use_t get_next_use(be_uses_t *env, ir_node *from,
214 const ir_node *def, int skip_from_uses)
217 ir_node *block = get_nodes_block(from);
218 ir_node *next_use_node;
221 unsigned next_use_step;
223 assert(skip_from_uses == 0 || skip_from_uses == 1);
224 if (skip_from_uses) {
225 from = sched_next(from);
228 next_use_node = NULL;
229 next_use_step = INT_MAX;
230 timestep = get_step(from);
231 foreach_out_edge(def, edge) {
233 node = get_edge_src_irn(edge);
237 if (get_nodes_block(node) != block)
242 node_step = get_step(node);
243 if (node_step < timestep)
245 if (node_step < next_use_step) {
246 next_use_node = node;
247 next_use_step = node_step;
251 if (next_use_node != NULL) {
252 be_next_use_t result;
253 result.time = next_use_step - timestep + skip_from_uses;
254 result.outermost_loop = get_loop_depth(get_irn_loop(block));
255 result.before = next_use_node;
259 node = sched_last(block);
260 step = get_step(node) + 1 + timestep + skip_from_uses;
262 if (be_is_phi_argument(block, def)) {
263 // TODO we really should continue searching the uses of the phi,
264 // as a phi isn't a real use that implies a reload (because we could
265 // easily spill the whole phi)
267 be_next_use_t result;
269 result.outermost_loop = get_loop_depth(get_irn_loop(block));
270 result.before = block;
275 unsigned next_use = USES_INFINITY;
276 unsigned outermost_loop;
277 be_next_use_t result;
278 ir_loop *loop = get_irn_loop(block);
279 unsigned loopdepth = get_loop_depth(loop);
280 int found_visited = 0;
282 ir_graph *irg = get_irn_irg(block);
283 ir_node *startblock = get_irg_start_block(irg);
285 result.before = NULL;
286 outermost_loop = loopdepth;
287 foreach_block_succ(block, edge) {
289 const ir_node *succ_block = get_edge_src_irn(edge);
293 if (succ_block == startblock)
296 DBG((env->dbg, LEVEL_5, "Checking succ of block %+F: %+F (for use of %+F)\n", block, succ_block, def));
297 if (!be_is_live_in(env->lv, succ_block, def)) {
298 //next_use = USES_INFINITY;
299 DBG((env->dbg, LEVEL_5, " not live in\n"));
303 use = get_or_set_use_block(env, succ_block, def);
304 DBG((env->dbg, LEVEL_5, "Found %u (loopdepth %u) (we're in block %+F)\n", use->next_use,
305 use->outermost_loop, block));
306 if (USES_IS_INFINITE(use->next_use)) {
307 if (use->outermost_loop == UNKNOWN_OUTERMOST_LOOP) {
314 use_dist = use->next_use;
316 succ_loop = get_irn_loop(succ_block);
317 if (get_loop_depth(succ_loop) < loopdepth) {
318 unsigned factor = (loopdepth - get_loop_depth(succ_loop)) * 5000;
319 DBG((env->dbg, LEVEL_5, "Increase usestep because of loop out edge %d -> %d (%u)\n", factor));
320 // TODO we should use the number of nodes in the loop or so...
324 if (use_dist < next_use) {
326 outermost_loop = use->outermost_loop;
327 result.before = use->node;
331 if (loopdepth < outermost_loop)
332 outermost_loop = loopdepth;
334 result.time = next_use + step;
335 result.outermost_loop = outermost_loop;
337 if (!found_use && found_visited) {
338 // the current result is correct for the current search, but isn't
339 // generally correct, so mark it
340 result.outermost_loop = UNKNOWN_OUTERMOST_LOOP;
342 DBG((env->dbg, LEVEL_5, "Result: %d (outerloop: %u)\n", result.time, result.outermost_loop));
347 be_next_use_t be_get_next_use(be_uses_t *env, ir_node *from,
348 const ir_node *def, int skip_from_uses)
350 ++env->visited_counter;
351 return get_next_use(env, from, def, skip_from_uses);
355 * Pre-block walker, set the step number for every scheduled node
356 * in increasing order.
358 * After this, two scheduled nodes can be easily compared for the
359 * "scheduled earlier in block" property.
361 static void set_sched_step_walker(ir_node *block, void *data)
366 sched_foreach(block, node) {
367 set_step(node, step);
374 be_uses_t *be_begin_uses(ir_graph *irg, const be_lv_t *lv)
376 be_uses_t *env = XMALLOC(be_uses_t);
380 //set_using_irn_link(irg);
382 /* precalculate sched steps */
383 irg_block_walk_graph(irg, set_sched_step_walker, NULL, NULL);
385 env->uses = new_set(cmp_use, 512);
388 env->visited_counter = 0;
389 FIRM_DBG_REGISTER(env->dbg, "firm.be.uses");
394 void be_end_uses(be_uses_t *env)
396 //clear_using_irn_link(env->irg);