2ad2399c0da071326a6ad1092e1528de6f4a8e81
[libfirm] / ir / be / beuses.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Methods to compute when a value will be used again.
23  * @author      Sebastian Hack, Matthias Braun
24  * @date        27.06.2005
25  * @version     $Id$
26  */
27 #include "config.h"
28
29 #include <limits.h>
30 #include <stdlib.h>
31
32 #include "config.h"
33 #include "obst.h"
34 #include "pmap.h"
35 #include "debug.h"
36
37 #include "irgwalk.h"
38 #include "irnode_t.h"
39 #include "ircons_t.h"
40 #include "irgraph_t.h"
41 #include "iredges_t.h"
42 #include "irdom_t.h"
43
44 #include "be_t.h"
45 #include "beutil.h"
46 #include "belive_t.h"
47 #include "benode.h"
48 #include "besched.h"
49 #include "beirgmod.h"
50 #include "bearch.h"
51 #include "beuses.h"
52
53 #define SCAN_INTERBLOCK_USES
54
55 typedef struct _be_use_t {
56         const ir_node *block;
57         const ir_node *node;
58         int outermost_loop;
59         unsigned next_use;
60         unsigned visited;
61 } be_use_t;
62
63 struct _be_uses_t {
64         set *uses;
65         ir_graph *irg;
66         const be_lv_t *lv;
67         unsigned visited_counter;
68         DEBUG_ONLY(firm_dbg_module_t *dbg;)
69 };
70
71 static int cmp_use(const void *a, const void *b, size_t n)
72 {
73         const be_use_t *p = a;
74         const be_use_t *q = b;
75         (void) n;
76
77         return !(p->block == q->block && p->node == q->node);
78 }
79
80 static be_next_use_t get_next_use(be_uses_t *env, ir_node *from,
81                                                                   unsigned from_step, const ir_node *def,
82                                                                   int skip_from_uses);
83
84 static const be_use_t *get_or_set_use_block(be_uses_t *env,
85                                             const ir_node *block,
86                                             const ir_node *def)
87 {
88         unsigned hash = HASH_COMBINE(hash_irn(block), hash_irn(def));
89         be_use_t temp;
90         be_use_t* result;
91
92         temp.block = block;
93         temp.node = def;
94         result = set_find(env->uses, &temp, sizeof(temp), hash);
95
96         if (result == NULL) {
97                 // insert templ first as we might end in a loop in the get_next_use
98                 // call otherwise
99                 temp.next_use = USES_INFINITY;
100                 temp.outermost_loop = -1;
101                 temp.visited = 0;
102                 result = set_insert(env->uses, &temp, sizeof(temp), hash);
103         }
104
105         if (result->outermost_loop < 0 && result->visited < env->visited_counter) {
106                 be_next_use_t next_use;
107
108                 result->visited = env->visited_counter;
109                 next_use = get_next_use(env, sched_first(block), 0, def, 0);
110                 if (next_use.outermost_loop >= 0) {
111                         result->next_use = next_use.time;
112                         result->outermost_loop = next_use.outermost_loop;
113                         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));
114                 }
115         }
116
117         return result;
118 }
119
120 static int be_is_phi_argument(const ir_node *block, const ir_node *def)
121 {
122         ir_node *node;
123         ir_node *succ_block = NULL;
124         const ir_edge_t *edge;
125         int arity, i;
126
127 #if 1
128         if (get_irn_n_edges_kind(block, EDGE_KIND_BLOCK) < 1)
129 #else
130         if (get_irn_n_edges_kind(block, EDGE_KIND_BLOCK) != 1)
131 #endif
132                 return 0;
133
134         foreach_block_succ(block, edge) {
135                 succ_block = get_edge_src_irn(edge);
136                 break;
137         }
138
139         arity = get_Block_n_cfgpreds(succ_block);
140         if (arity <= 1)
141                 return 0;
142
143         for (i = 0; i < arity; ++i) {
144                 if (get_Block_cfgpred_block(succ_block, i) == block)
145                         break;
146         }
147         assert(i < arity);
148
149         sched_foreach(succ_block, node) {
150                 ir_node *arg;
151
152                 if (!is_Phi(node))
153                         break;
154
155                 arg = get_irn_n(node, i);
156                 if (arg == def)
157                         return 1;
158         }
159
160         return 0;
161 }
162
163 static inline unsigned get_step(const ir_node *node)
164 {
165         return PTR_TO_INT(get_irn_link(node));
166 }
167
168 static be_next_use_t get_next_use(be_uses_t *env, ir_node *from,
169                                                                   unsigned from_step, const ir_node *def,
170                                                                   int skip_from_uses)
171 {
172         unsigned  step  = from_step;
173         ir_node  *block = get_nodes_block(from);
174         ir_node  *next_use;
175         ir_node  *node;
176         unsigned  timestep;
177         unsigned  next_use_step;
178         const ir_edge_t *edge;
179
180 #if 1
181         assert(skip_from_uses == 0 || skip_from_uses == 1);
182         if (skip_from_uses) {
183                 from = sched_next(from);
184         }
185
186         next_use      = NULL;
187         next_use_step = INT_MAX;
188         timestep      = get_step(from);
189         foreach_out_edge(def, edge) {
190                 ir_node  *node = get_edge_src_irn(edge);
191                 unsigned  node_step;
192
193                 if (is_Anchor(node))
194                         continue;
195                 if (get_nodes_block(node) != block)
196                         continue;
197                 if (is_Phi(node))
198                         continue;
199
200                 node_step = get_step(node);
201                 if (node_step < timestep)
202                         continue;
203                 if (node_step < next_use_step) {
204                         next_use      = node;
205                         next_use_step = node_step;
206                 }
207         }
208
209         if (next_use != NULL) {
210                 be_next_use_t result;
211                 result.time           = next_use_step - timestep + skip_from_uses;
212                 result.outermost_loop = get_loop_depth(get_irn_loop(block));
213                 result.before         = next_use;
214                 return result;
215         }
216
217         node = sched_last(block);
218         step = get_step(node) + 1 + timestep + skip_from_uses;
219
220 #else
221         if (skip_from_uses) {
222                 from = sched_next(from);
223                 ++step;
224         }
225
226         sched_foreach_from(from, node) {
227                 int i, arity;
228
229                 if (is_Phi(node)) {
230                         step++;
231                         continue;
232                 }
233
234                 arity = get_irn_arity(node);
235                 for (i = 0; i < arity; ++i) {
236                         const ir_node *operand = get_irn_n(node, i);
237
238                         if (operand == def) {
239                                 be_next_use_t result;
240
241                                 DBG((env->dbg, LEVEL_3, "found use of %+F at %+F\n", operand, node));
242
243                                 /**
244                                  * Spills/Reloads are a special case, they're not really a
245                                  * usage of a value, continue searching
246                                  */
247                                 if (be_is_Spill(node) || be_is_Reload(node)) {
248                                         return be_get_next_use(env, node, step, node, 1);
249                                 }
250
251                                 result.time           = step;
252                                 result.outermost_loop = get_loop_depth(get_irn_loop(block));
253                                 result.before         = node;
254                                 return result;
255                         }
256                 }
257
258                 step++;
259         }
260 #endif
261
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)
266
267                 be_next_use_t result;
268                 result.time           = step;
269                 result.outermost_loop = get_loop_depth(get_irn_loop(block));
270                 result.before         = block;
271                 return result;
272         }
273
274 #ifdef SCAN_INTERBLOCK_USES
275         {
276         unsigned next_use   = USES_INFINITY;
277         int outermost_loop;
278         be_next_use_t result;
279         ir_loop *loop       = get_irn_loop(block);
280         int loopdepth       = get_loop_depth(loop);
281         int found_visited   = 0;
282         int found_use       = 0;
283         ir_graph *irg       = get_irn_irg(block);
284         ir_node *startblock = get_irg_start_block(irg);
285
286         result.before  = NULL;
287         outermost_loop = loopdepth;
288         foreach_block_succ(block, edge) {
289                 const be_use_t *use;
290                 const ir_node *succ_block = get_edge_src_irn(edge);
291                 ir_loop *succ_loop;
292                 unsigned use_dist;
293
294                 if (succ_block == startblock)
295                         continue;
296
297                 DBG((env->dbg, LEVEL_5, "Checking succ of block %+F: %+F (for use of %+F)\n", block, succ_block, def));
298                 if (!be_is_live_in(env->lv, succ_block, def)) {
299                         //next_use = USES_INFINITY;
300                         DBG((env->dbg, LEVEL_5, "   not live in\n"));
301                         continue;
302                 }
303
304                 use = get_or_set_use_block(env, succ_block, def);
305                 DBG((env->dbg, LEVEL_5, "Found %u (loopdepth %d) (we're in block %+F)\n", use->next_use,
306                                         use->outermost_loop, block));
307                 if (USES_IS_INFINITE(use->next_use)) {
308                         if (use->outermost_loop < 0) {
309                                 found_visited = 1;
310                         }
311                         continue;
312                 }
313
314                 found_use = 1;
315                 use_dist = use->next_use;
316
317                 succ_loop = get_irn_loop(succ_block);
318                 if (get_loop_depth(succ_loop) < loopdepth) {
319                         unsigned factor = (loopdepth - get_loop_depth(succ_loop)) * 5000;
320                         DBG((env->dbg, LEVEL_5, "Increase usestep because of loop out edge %d -> %d (%u)\n", factor));
321                         // TODO we should use the number of nodes in the loop or so...
322                         use_dist += factor;
323                 }
324
325                 if (use_dist < next_use) {
326                         next_use       = use_dist;
327                         outermost_loop = use->outermost_loop;
328                         result.before  = use->node;
329                 }
330         }
331
332         if (loopdepth < outermost_loop)
333                 outermost_loop = loopdepth;
334
335         result.time           = next_use + step;
336         result.outermost_loop = outermost_loop;
337
338         if (!found_use && found_visited) {
339                 // the current result is correct for the current search, but isn't
340                 // generally correct, so mark it
341                 result.outermost_loop = -1;
342         }
343         DBG((env->dbg, LEVEL_5, "Result: %d (outerloop: %d)\n", result.time, result.outermost_loop));
344         return result;
345         }
346 #else
347         return USES_INFINITY;
348 #endif
349 }
350
351 be_next_use_t be_get_next_use(be_uses_t *env, ir_node *from,
352                          unsigned from_step, const ir_node *def,
353                          int skip_from_uses)
354 {
355         env->visited_counter++;
356         return get_next_use(env, from, from_step, def, skip_from_uses);
357 }
358
359 static void set_sched_step_walker(ir_node *block, void *data)
360 {
361         ir_node  *node;
362         unsigned step = 0;
363         (void) data;
364
365         sched_foreach(block, node) {
366                 set_irn_link(node, INT_TO_PTR(step));
367                 if (is_Phi(node))
368                         continue;
369                 ++step;
370         }
371 }
372
373 be_uses_t *be_begin_uses(ir_graph *irg, const be_lv_t *lv)
374 {
375         be_uses_t *env = XMALLOC(be_uses_t);
376
377         edges_assure(irg);
378
379         //set_using_irn_link(irg);
380
381         /* precalculate sched steps */
382         irg_block_walk_graph(irg, set_sched_step_walker, NULL, NULL);
383
384         env->uses = new_set(cmp_use, 512);
385         env->irg = irg;
386         env->lv = lv;
387         env->visited_counter = 0;
388         FIRM_DBG_REGISTER(env->dbg, "firm.be.uses");
389
390         return env;
391 }
392
393 void be_end_uses(be_uses_t *env)
394 {
395         //clear_using_irn_link(env->irg);
396         del_set(env->uses);
397         free(env);
398 }