Added phi handler
[libfirm] / ir / be / belive.c
1 /**
2  * Interblock liveness analysis.
3  * @author Sebastian Hack
4  * @date 6.12.2004
5  */
6 #ifdef HAVE_CONFIG_H
7 #include "config.h"
8 #endif
9
10 #include "impl.h"
11 #include "iredges_t.h"
12 #include "irgwalk.h"
13 #include "irprintf_t.h"
14
15 #include "beutil.h"
16 #include "belive_t.h"
17 #include "besched_t.h"
18
19 #define DBG_MODULE "firm.be.liveness"
20
21 FIRM_IMPL2(is_live_in, int, const ir_node *, const ir_node *)
22 FIRM_IMPL2(is_live_out, int, const ir_node *, const ir_node *)
23 FIRM_IMPL2(is_live_end, int, const ir_node *, const ir_node *)
24
25 /** The offset of the liveness information in a firm node. */
26 size_t live_irg_data_offset = 0;
27
28 void be_liveness_init(void)
29 {
30   live_irg_data_offset = register_additional_graph_data(sizeof(irn_live_t));
31 }
32
33 static INLINE void mark_live_in(ir_node *block, const ir_node *irn)
34 {
35   _get_or_set_live(block, irn, live_state_in);
36 }
37
38 static INLINE void mark_live_out(ir_node *block, const ir_node *irn)
39 {
40   _get_or_set_live(block, irn, live_state_out | live_state_end);
41 }
42
43 static INLINE void mark_live_end(ir_node *block, const ir_node *irn)
44 {
45   _get_or_set_live(block, irn, live_state_end);
46 }
47
48 /**
49  * Mark a node (value) live out at a certain block. Do this also
50  * transitively, i.e. if the block is not the block of the value's
51  * definition, all predecessors are also marked live.
52  * @param def The node (value).
53  * @param block The block to mark the value live out of.
54  * @param visited A set were all visited blocks are recorded.
55  * @param is_true_out Is the node real out there or only live at the end
56  * of the block.
57  */
58 static void live_end_at_block(ir_node *def, ir_node *block,
59     pset *visited, int is_true_out)
60 {
61   mark_live_end(block, def);
62   if(is_true_out)
63     mark_live_out(block, def);
64
65   if(!pset_find_ptr(visited, block)) {
66
67     pset_insert_ptr(visited, block);
68
69     /*
70      * If this block is not the definition block, we have to go up
71      * further.
72      */
73     if(get_nodes_block(def) != block) {
74       int i, n;
75
76       mark_live_in(block, def);
77
78       for(i = 0, n = get_irn_arity(block); i < n; ++i)
79         live_end_at_block(def, get_Block_cfgpred_block(block, i), visited, 1);
80     }
81
82   }
83 }
84
85 /**
86  * Liveness analysis for a value.
87  * This functions is meant to be called by a firm walker, to compute the
88  * set of all blocks a value is live in.
89  * @param irn The node (value).
90  * @param env Ignored.
91  */
92 static void liveness_for_node(ir_node *irn, void *env)
93 {
94   const ir_edge_t *edge;
95   ir_node *def_block;
96   pset *visited;
97
98   /* Don't compute liveness information for non-data nodes. */
99   if(!is_data_node(irn))
100     return;
101
102   visited = pset_new_ptr(512);
103   def_block = get_nodes_block(irn);
104
105   /* Go over all uses of the value */
106   foreach_out_edge(irn, edge) {
107     ir_node *use = edge->src;
108     ir_node *use_block;
109
110     /*
111      * If the usage is no data node, skip this use, since it does not
112      * affect the liveness of the node.
113      */
114     if(!is_data_node(use))
115       continue;
116
117     /* Get the block where the usage is in. */
118     use_block = get_nodes_block(use);
119
120     /*
121      * If the use is a phi function, determine the corresponding block
122      * through which the value reaches the phi function and mark the
123      * value as live out of that block.
124      */
125     if(is_Phi(use)) {
126                         ir_node *pred_block = get_Block_cfgpred_block(use_block, edge->pos);
127                         live_end_at_block(irn, pred_block, visited, 0);
128     }
129
130     /*
131      * Else, the value is live in at this block. Mark it and call live
132      * out on the predecessors.
133      */
134     else if(def_block != use_block) {
135       int i, n;
136
137       mark_live_in(use_block, irn);
138
139       for(i = 0, n = get_irn_arity(use_block); i < n; ++i) {
140         ir_node *pred_block = get_nodes_block(get_irn_n(use_block, i));
141         live_end_at_block(irn, pred_block, visited, 1);
142       }
143     }
144   }
145
146   del_pset(visited);
147 }
148
149 static int cmp_irn_live(const void *a, const void *b, size_t size)
150 {
151   const irn_live_t *p = a;
152   const irn_live_t *q = b;
153
154   return !(p->block == q->block && p->irn == q->irn);
155 }
156
157 static int (*old_dump_block_func)(ir_node *self, FILE *F, dump_reason_t reason) = NULL;
158
159 static int dump_block_func(ir_node *self, FILE *F, dump_reason_t reason)
160 {
161         switch(reason) {
162         case dump_node_opcode_txt:
163                 fprintf(F, get_irn_opname(self));
164                 break;
165         case dump_node_mode_txt:
166                 fprintf(F, get_irn_modename(self));
167                 break;
168         case dump_node_nodeattr_txt:
169                 break;
170         case dump_node_info_txt:
171                 if(!get_irg_live_info(get_irn_irg(self))->live)
172                         return 0;
173 #if 0
174                 fprintf(F, "liveness information:\n");
175                 {
176                         irn_live_t *li;
177                         live_foreach(self, li) {
178                                 ir_fprintf(F, "%+F", li->irn);
179                                 if(live_is_in(li))
180                                         fprintf(F, " in");
181                                 if(live_is_end(li))
182                                         fprintf(F, " end");
183                                 if(live_is_out(li))
184                                         fprintf(F, " out");
185
186                                 fprintf(F, "\n");
187                         }
188                 }
189 #endif
190         }
191
192         return 0;
193 }
194
195 void be_liveness(ir_graph *irg)
196 {
197   irg_live_info_t *live_info = get_irg_live_info(irg);
198   if(live_info->live)
199     del_set(live_info->live);
200
201   live_info->live = new_set(cmp_irn_live, 8192);
202   irg_walk_graph(irg, liveness_for_node, NULL, NULL);
203
204   old_dump_block_func     = op_Block->ops.dump_node;
205   op_Block->ops.dump_node = dump_block_func;
206 }
207
208 static void dump_liveness_walker(ir_node *bl, void *data)
209 {
210         FILE *f = data;
211         const irn_live_t *li;
212         char buf[64];
213
214         ir_fprintf(f, "%+F\n", bl);
215         live_foreach(bl, li) {
216                 strcpy(buf, "");
217
218                 if(live_is_in(li))
219                         strcat(buf, "in ");
220
221                 if(live_is_end(li))
222                         strcat(buf, "end ");
223
224                 if(live_is_out(li))
225                         strcat(buf, "out ");
226
227                 ir_fprintf(f, "\t%+20F %s\n", li->irn, buf);
228         }
229 }
230
231 void be_liveness_dump(ir_graph *irg, FILE *f)
232 {
233         irg_block_walk_graph(irg, dump_liveness_walker, NULL, f);
234 }
235
236 void be_liveness_dumpto(ir_graph *irg, const char *cls_name)
237 {
238         FILE *f;
239         char buf[128];
240         ir_snprintf(buf, sizeof(buf), "%F_%s-live.txt", irg, cls_name);
241         if((f = fopen(buf, "wt")) != NULL) {
242                 be_liveness_dump(irg, f);
243                 fclose(f);
244         }
245 }
246
247 static void dom_check(ir_node *irn, void *data)
248 {
249         if(!is_Block(irn) && irn != get_irg_end(get_irn_irg(irn))) {
250                 int i, n;
251                 ir_node *bl = get_nodes_block(irn);
252
253                 for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
254                         ir_node *op     = get_irn_n(irn, i);
255                         ir_node *def_bl = get_nodes_block(op);
256                         ir_node *use_bl = bl;
257
258                         if(is_Phi(irn))
259                                 use_bl = get_Block_cfgpred_block(bl, i);
260
261                         if(!block_dominates(def_bl, use_bl)) {
262                                 ir_fprintf(stderr, "%+F in %+F must dominate %+F for user %+F\n", op, def_bl, use_bl, irn);
263                                 assert(0);
264                         }
265                 }
266         }
267 }
268
269 void be_check_dominance(ir_graph *irg)
270 {
271         irg_walk_graph(irg, dom_check, NULL, NULL);
272 }
273
274 pset *be_liveness_transfer(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *irn, pset *live)
275 {
276         firm_dbg_module_t *dbg = firm_dbg_register(DBG_MODULE);
277         int i, n;
278         ir_node *x;
279
280         DBG((dbg, LEVEL_1, "%+F\n", irn));
281         for(x = pset_first(live); x; x = pset_next(live))
282                 DBG((dbg, LEVEL_1, "\tlive: %+F\n", x));
283
284         if(arch_irn_consider_in_reg_alloc(arch_env, cls, irn))
285                 pset_remove_ptr(live, irn);
286
287         for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
288                 ir_node *op = get_irn_n(irn, i);
289
290                 if(arch_irn_consider_in_reg_alloc(arch_env, cls, op))
291                         pset_insert_ptr(live, op);
292         }
293
294         return live;
295 }
296
297 pset *be_liveness_end_of_block(const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *bl, pset *live)
298 {
299         irn_live_t *li;
300
301         live_foreach(bl, li) {
302                 ir_node *irn = (ir_node *) li->irn;
303                 if(live_is_end(li) && arch_irn_consider_in_reg_alloc(arch_env, cls, irn))
304                         pset_insert_ptr(live, irn);
305         }
306
307         return live;
308 }
309
310 pset *be_liveness_nodes_live_at(const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *pos, pset *live)
311 {
312         firm_dbg_module_t *dbg = firm_dbg_register(DBG_MODULE);
313         const ir_node *bl      = is_Block(pos) ? pos : get_nodes_block(pos);
314         ir_node *irn;
315
316         be_liveness_end_of_block(arch_env, cls, bl, live);
317
318         sched_foreach_reverse(bl, irn) {
319                 /*
320                  * If we encounter the node we want to insert the Perm after,
321                  * exit immediately, so that this node is still live
322                  */
323                 if(irn == pos)
324                         return live;
325
326                 be_liveness_transfer(arch_env, cls, irn, live);
327         }
328
329         return live;
330 }