Changed API of liveness
[libfirm] / ir / be / belive.c
1 /*
2  * Copyright (C) 1995-2007 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       Interblock liveness analysis.
23  * @author      Sebastian Hack
24  * @date        06.12.2004
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "impl.h"
32 #include "iredges_t.h"
33 #include "irgwalk.h"
34 #include "irprintf_t.h"
35 #include "irbitset.h"
36 #include "irdump_t.h"
37 #include "irnodeset.h"
38
39 #include "dfs_t.h"
40 #include "absgraph.h"
41
42 #include "beutil.h"
43 #include "belive_t.h"
44 #include "beirg_t.h"
45 #include "besched_t.h"
46 #include "bemodule.h"
47
48 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
49
50 /* see comment in compute_liveness() */
51 #define LV_COMPUTE_SORTED
52 #define LV_STD_SIZE             64
53 #define LV_USE_BINARY_SEARCH
54 #undef  LV_INTESIVE_CHECKS
55
56 void be_live_chk_compare(be_lv_t *lv, lv_chk_t *lvc);
57
58 static INLINE int is_liveness_node(const ir_node *irn)
59 {
60         switch(get_irn_opcode(irn)) {
61         case iro_Block:
62         case iro_Bad:
63         case iro_End:
64         case iro_Anchor:
65                 return 0;
66         default:;
67         }
68
69         return 1;
70 }
71
72 int (be_lv_next_irn)(const struct _be_lv_t *lv, const ir_node *bl, unsigned flags, int i)
73 {
74         return _be_lv_next_irn(lv, bl, flags, i);
75 }
76
77 const ir_node * (be_lv_get_irn)(const struct _be_lv_t *lv, const ir_node *bl, int i)
78 {
79         return _be_lv_get_irn(lv, bl, i);
80 }
81
82 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn)
83 {
84         return _be_is_live_xxx(lv, block, irn, be_lv_state_in);
85 }
86
87 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn)
88 {
89         return _be_is_live_xxx(lv, block, irn, be_lv_state_out);
90 }
91
92 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn)
93 {
94         return _be_is_live_xxx(lv, block, irn, be_lv_state_end);
95 }
96
97
98 #ifdef LV_USE_BINARY_SEARCH
99 static INLINE unsigned _be_liveness_bsearch(struct _be_lv_info_t *arr, unsigned idx)
100 {
101         struct _be_lv_info_t *payload = arr + 1;
102
103         unsigned n   = arr[0].u.head.n_members;
104         unsigned res = 0;
105         int lo       = 0;
106         int hi       = n;
107
108         if(n == 0)
109                 return 0;
110
111         while(lo < hi) {
112                 int md          = lo + ((hi - lo) >> 1);
113                 unsigned md_idx = payload[md].u.node.idx;
114
115                 if(idx > md_idx)
116                         lo = md + 1;
117                 else if(idx < md_idx)
118                         hi = md;
119                 else {
120                         res = md;
121                         assert(payload[res].u.node.idx == idx);
122                         break;
123                 }
124
125                 res = lo;
126         }
127
128 #ifdef LV_INTESIVE_CHECKS
129         {
130                 unsigned i;
131                 for(i = res; i < n; ++i)
132                         assert(payload[i].u.node.idx >= idx);
133
134                 for(i = 0; i < res; ++i)
135                         assert(payload[i].u.node.idx < idx);
136         }
137 #endif
138
139         return res;
140 }
141
142 #else
143
144 /**
145  * This function searches linearly for the node in the array.
146  */
147 static INLINE unsigned _be_liveness_bsearch(struct _be_lv_info_t *arr, unsigned idx) {
148         unsigned n  = arr[0].u.head.n_members;
149         unsigned i;
150
151         for(i = 0; i < n; ++i) {
152                 if(arr[i + 1].u.node.idx == idx)
153                         return i;
154         }
155
156         return i;
157 }
158 #endif
159
160 struct _be_lv_info_node_t *be_lv_get(const struct _be_lv_t *li, const ir_node *bl, const ir_node *irn)
161 {
162         struct _be_lv_info_t *irn_live = phase_get_irn_data(&li->ph, bl);
163
164         if(irn_live) {
165                 unsigned idx = get_irn_idx(irn);
166
167                 /* Get the position of the index in the array. */
168                 int pos = _be_liveness_bsearch(irn_live, idx);
169
170                 /* Get the record in question. 1 must be added, since the first record contains information about the array and must be skipped. */
171                 struct _be_lv_info_node_t *res = &irn_live[pos + 1].u.node;
172
173                 /* Check, if the irn is in deed in the array. */
174                 if(res->idx == idx)
175                         return res;
176         }
177
178         return NULL;
179 }
180
181 static struct _be_lv_info_node_t *be_lv_get_or_set(struct _be_lv_t *li, ir_node *bl, ir_node *irn)
182 {
183         struct _be_lv_info_t *irn_live = phase_get_or_set_irn_data(&li->ph, bl);
184
185         unsigned idx = get_irn_idx(irn);
186
187         /* Get the position of the index in the array. */
188         unsigned pos = _be_liveness_bsearch(irn_live, idx);
189
190         /* Get the record in question. 1 must be added, since the first record contains information about the array and must be skipped. */
191         struct _be_lv_info_node_t *res = &irn_live[pos + 1].u.node;
192
193         /* Check, if the irn is in deed in the array. */
194         if(res->idx != idx) {
195                 struct _be_lv_info_t *payload;
196                 unsigned n_members = irn_live[0].u.head.n_members;
197                 unsigned n_size    = irn_live[0].u.head.n_size;
198                 unsigned i;
199
200                 if(n_members + 1 >= n_size) {
201                         /* double the array size. Remember that the first entry is
202                          * metadata about the array and not a real array element */
203                         unsigned old_size_bytes  = (n_size + 1) * sizeof(irn_live[0]);
204                         unsigned new_size        = (2 * n_size) + 1;
205                         size_t   new_size_bytes  = new_size * sizeof(irn_live[0]);
206                         struct _be_lv_info_t *nw = phase_alloc(&li->ph, new_size_bytes);
207                         memcpy(nw, irn_live, old_size_bytes);
208                         memset(((char*) nw) + old_size_bytes, 0,
209                                new_size_bytes - old_size_bytes);
210                         nw[0].u.head.n_size = new_size - 1;
211                         irn_live = nw;
212                         phase_set_irn_data(&li->ph, bl, nw);
213                 }
214
215                 payload = &irn_live[1];
216                 for(i = n_members; i > pos; --i) {
217                         payload[i] = payload[i - 1];
218                 }
219
220                 ++irn_live[0].u.head.n_members;
221
222                 res = &payload[pos].u.node;
223                 res->idx    = idx;
224                 res->flags  = 0;
225         }
226
227 #ifdef LV_INTESIVE_CHECKS
228         {
229                 unsigned i;
230                 unsigned n = irn_live[0].u.head.n_members;
231                 unsigned last = 0;
232                 struct _be_lv_info_t *payload = &irn_live[1];
233
234                 for(i = 0; i < n; ++i) {
235                         assert(payload[i].u.node.idx >= last);
236                         last = payload[i].u.node.idx;
237                 }
238         }
239 #endif
240
241         return res;
242 }
243
244 /**
245  * Removes a node from the list of live variables of a block.
246  * @return 1 if the node was live at that block, 0 if not.
247  */
248 static int be_lv_remove(struct _be_lv_t *li, ir_node *bl, ir_node *irn)
249 {
250         struct _be_lv_info_t *irn_live = phase_get_irn_data(&li->ph, bl);
251
252         if(irn_live) {
253                 unsigned n   = irn_live[0].u.head.n_members;
254                 unsigned idx = get_irn_idx(irn);
255                 unsigned pos = _be_liveness_bsearch(irn_live, idx);
256                 struct _be_lv_info_t *payload  = irn_live + 1;
257                 struct _be_lv_info_node_t *res = &payload[pos].u.node;
258
259                 /* The node is in deed in the block's array. Let's remove it. */
260                 if(res->idx == idx) {
261                         unsigned i;
262
263                         for(i = pos + 1; i < n; ++i)
264                                 payload[i - 1] = payload[i];
265
266                         payload[n - 1].u.node.idx   = 0;
267                         payload[n - 1].u.node.flags = 0;
268
269                         --irn_live[0].u.head.n_members;
270                         DBG((dbg, LEVEL_3, "\tdeleting %+F from %+F at pos %d\n", irn, bl, pos));
271                         return 1;
272                 }
273         }
274
275         return 0;
276 }
277
278 static void register_node(be_lv_t *lv, const ir_node *irn)
279 {
280         unsigned idx = get_irn_idx(irn);
281         if(idx >= bitset_size(lv->nodes)) {
282                 bitset_t *nw = bitset_malloc(2 * idx);
283                 bitset_copy(nw, lv->nodes);
284                 bitset_free(lv->nodes);
285                 lv->nodes = nw;
286         }
287
288         bitset_set(lv->nodes, idx);
289 }
290
291 /**
292  * Mark a node as live-in in a block.
293  */
294 static INLINE void mark_live_in(be_lv_t *lv, ir_node *block, ir_node *irn)
295 {
296         struct _be_lv_info_node_t *n = be_lv_get_or_set(lv, block, irn);
297         DBG((dbg, LEVEL_2, "marking %+F live in at %+F\n", irn, block));
298         n->flags |= be_lv_state_in;
299         register_node(lv, irn);
300 }
301
302 /**
303  * Mark a node as live-out in a block.
304  */
305 static INLINE void mark_live_out(be_lv_t *lv, ir_node *block, ir_node *irn)
306 {
307         struct _be_lv_info_node_t *n = be_lv_get_or_set(lv, block, irn);
308         DBG((dbg, LEVEL_2, "marking %+F live out at %+F\n", irn, block));
309         n->flags |= be_lv_state_out | be_lv_state_end;
310         register_node(lv, irn);
311 }
312
313 /**
314  * Mark a node as live-end in a block.
315  */
316 static INLINE void mark_live_end(be_lv_t *lv, ir_node *block, ir_node *irn)
317 {
318         struct _be_lv_info_node_t *n = be_lv_get_or_set(lv, block, irn);
319         DBG((dbg, LEVEL_2, "marking %+F live end at %+F\n", irn, block));
320         n->flags |= be_lv_state_end;
321         register_node(lv, irn);
322 }
323
324 /**
325  * Mark a node (value) live out at a certain block. Do this also
326  * transitively, i.e. if the block is not the block of the value's
327  * definition, all predecessors are also marked live.
328  * @param def The node (value).
329  * @param block The block to mark the value live out of.
330  * @param visited A set were all visited blocks are recorded.
331  * @param is_true_out Is the node real out there or only live at the end
332  * of the block.
333  */
334 static void live_end_at_block(be_lv_t *lv, ir_node *def, ir_node *block, bitset_t *visited, int is_true_out)
335 {
336         mark_live_end(lv, block, def);
337         if(is_true_out)
338                 mark_live_out(lv, block, def);
339
340         if(!bitset_contains_irn(visited, block)) {
341                 bitset_add_irn(visited, block);
342
343                 /*
344                 * If this block is not the definition block, we have to go up
345                 * further.
346                 */
347                 if(get_nodes_block(def) != block) {
348                         int i, n;
349
350                         mark_live_in(lv, block, def);
351
352                         for(i = 0, n = get_Block_n_cfgpreds(block); i < n; ++i)
353                                 live_end_at_block(lv, def, get_Block_cfgpred_block(block, i), visited, 1);
354                 }
355
356         }
357 }
358
359 struct _lv_walker_t {
360         be_lv_t *lv;
361         void *data;
362 };
363
364 /**
365  * Liveness analysis for a value.
366  * This functions is meant to be called by a firm walker, to compute the
367  * set of all blocks a value is live in.
368  * @param irn The node (value).
369  * @param env Ignored.
370  */
371 static void liveness_for_node(ir_node *irn, void *data)
372 {
373         struct _lv_walker_t *walker = data;
374         be_lv_t *lv       = walker->lv;
375         bitset_t *visited = walker->data;
376         const ir_edge_t *edge;
377         ir_node *def_block;
378
379         /* Don't compute liveness information for non-data nodes. */
380         if(!is_liveness_node(irn))
381                 return;
382
383         bitset_clear_all(visited);
384         def_block = get_nodes_block(irn);
385
386         /* Go over all uses of the value */
387         foreach_out_edge(irn, edge) {
388                 ir_node *use = edge->src;
389                 ir_node *use_block;
390
391                 DBG((dbg, LEVEL_4, "%+F: use at %+F, pos %d in %+F\n", irn, use, edge->pos, get_block(use)));
392                 assert(get_irn_n(use, edge->pos) == irn);
393
394                 /*
395                  * If the usage is no data node, skip this use, since it does not
396                  * affect the liveness of the node.
397                  */
398                 if(!is_liveness_node(use))
399                         continue;
400
401                 /* Get the block where the usage is in. */
402                 use_block = get_nodes_block(use);
403
404                 /*
405                  * If the use is a phi function, determine the corresponding block
406                  * through which the value reaches the phi function and mark the
407                  * value as live out of that block.
408                  */
409                 if(is_Phi(use)) {
410                         ir_node *pred_block = get_Block_cfgpred_block(use_block, edge->pos);
411                         live_end_at_block(lv, irn, pred_block, visited, 0);
412                 }
413
414                 /*
415                  * Else, the value is live in at this block. Mark it and call live
416                  * out on the predecessors.
417                  */
418                 else if(def_block != use_block) {
419                         int i, n;
420
421                         mark_live_in(lv, use_block, irn);
422
423                         for(i = 0, n = get_Block_n_cfgpreds(use_block); i < n; ++i) {
424                                 ir_node *pred_block = get_Block_cfgpred_block(use_block, i);
425                                 live_end_at_block(lv, irn, pred_block, visited, 1);
426                         }
427                 }
428         }
429 }
430
431 static void lv_remove_irn_walker(ir_node *bl, void *data)
432 {
433         struct _lv_walker_t *w = data;
434         be_lv_t *lv  = w->lv;
435         ir_node *irn = w->data;
436         be_lv_remove(lv, bl, irn);
437 }
438
439 static const char *lv_flags_to_str(unsigned flags)
440 {
441         static const char *states[] = {
442                 "---",
443                 "i--",
444                 "-e-",
445                 "ie-",
446                 "--o",
447                 "i-o",
448                 "-eo",
449                 "ieo"
450         };
451
452         return states[flags & 7];
453 }
454
455 static void lv_dump_block(void *context, FILE *f, const ir_node *bl)
456 {
457         if(is_Block(bl)) {
458                 be_lv_t *lv = context;
459                 struct _be_lv_info_t *info = phase_get_irn_data(&lv->ph, bl);
460
461                 fprintf(f, "liveness:\n");
462                 if(info) {
463                         unsigned n = info[0].u.head.n_members;
464                         unsigned i;
465
466                         for(i = 0; i < n; ++i) {
467                                 struct _be_lv_info_node_t *n = &info[i+1].u.node;
468                                 ir_fprintf(f, "%s %+F\n", lv_flags_to_str(n->flags), get_idx_irn(lv->irg, n->idx));
469                         }
470                 }
471         }
472 }
473
474 static void *lv_phase_data_init(ir_phase *phase, ir_node *irn, void *old)
475 {
476         struct _be_lv_info_t *info = phase_alloc(phase, LV_STD_SIZE * sizeof(info[0]));
477         (void) irn;
478         (void) old;
479
480         memset(info, 0, LV_STD_SIZE * sizeof(info[0]));
481         info[0].u.head.n_size = LV_STD_SIZE - 1;
482         return info;
483 }
484
485 static void collect_nodes(ir_node *irn, void *data)
486 {
487         struct obstack *obst = data;
488         if (is_liveness_node(irn))
489                 obstack_ptr_grow(obst, irn);
490 }
491
492 static int node_idx_cmp(const void *a, const void *b)
493 {
494         const ir_node *p = *(ir_node **) a;
495         const ir_node *q = *(ir_node **) b;
496         int ia = get_irn_idx(p);
497         int ib = get_irn_idx(q);
498         return ia - ib;
499 }
500
501 static void compute_liveness(be_lv_t *lv)
502 {
503         struct obstack obst;
504         struct _lv_walker_t w;
505         ir_node **nodes;
506         int i, n;
507
508         obstack_init(&obst);
509         irg_walk_graph(lv->irg, collect_nodes, NULL, &obst);
510         n      = obstack_object_size(&obst) / sizeof(nodes[0]);
511         nodes  = obstack_finish(&obst);
512
513         /*
514          * inserting the variables sorted by their ID is probably
515          * more efficient since the binary sorted set insertion
516          * will not need to move arounf the data.
517          * However, if sorting the variables a priori pays off
518          * needs to be checked, hence the define.
519          */
520 #ifdef LV_COMPUTE_SORTED
521         qsort(nodes, n, sizeof(nodes[0]), node_idx_cmp);
522 #endif
523
524         w.lv   = lv;
525         w.data = bitset_obstack_alloc(&obst, get_irg_last_idx(lv->irg));
526
527         for (i = 0; i < n; ++i)
528                 liveness_for_node(nodes[i], &w);
529
530         obstack_free(&obst, NULL);
531         register_hook(hook_node_info, &lv->hook_info);
532 }
533
534 void be_liveness_assure_sets(be_lv_t *lv)
535 {
536         if (!lv->nodes) {
537                 lv->nodes = bitset_malloc(2 * get_irg_last_idx(lv->irg));
538                 phase_init(&lv->ph, "liveness", lv->irg, PHASE_DEFAULT_GROWTH, lv_phase_data_init, NULL);
539                 compute_liveness(lv);
540                 /* be_live_chk_compare(lv, lv->lvc); */
541         }
542 }
543
544 void be_liveness_assure_chk(be_lv_t *lv)
545 {
546 #ifndef USE_LIVE_CHK
547         be_liveness_assure_sets(lv);
548 #else
549         (void) lv;
550 #endif
551 }
552
553 void be_liveness_invalidate(be_lv_t *lv)
554 {
555         if (lv && lv->nodes) {
556                 unregister_hook(hook_node_info, &lv->hook_info);
557                 phase_free(&lv->ph);
558                 bitset_free(lv->nodes);
559                 lv->nodes = NULL;
560         }
561 }
562
563 /* Compute the inter block liveness for a graph. */
564 be_lv_t *be_liveness(const be_irg_t *birg)
565 {
566         be_lv_t *lv = xmalloc(sizeof(lv[0]));
567
568         memset(lv, 0, sizeof(lv[0]));
569         lv->irg  = be_get_birg_irg(birg);
570         lv->birg = birg;
571 #ifdef USE_LIVE_CHK
572         lv->dfs  = dfs_new(&absgraph_irg_cfg_succ, lv->irg);
573         lv->lvc  = lv_chk_new(lv->irg, lv->dfs);
574 #endif
575         lv->hook_info.context = lv;
576         lv->hook_info.hook._hook_node_info = lv_dump_block;
577
578         return lv;
579 }
580
581 void be_liveness_recompute(be_lv_t *lv)
582 {
583         unsigned last_idx = get_irg_last_idx(lv->irg);
584         if(last_idx >= bitset_size(lv->nodes)) {
585                 bitset_free(lv->nodes);
586                 lv->nodes = bitset_malloc(last_idx * 2);
587         }
588
589         else
590                 bitset_clear_all(lv->nodes);
591
592         phase_free(&lv->ph);
593         phase_init(&lv->ph, "liveness", lv->irg, PHASE_DEFAULT_GROWTH, lv_phase_data_init, NULL);
594         compute_liveness(lv);
595 }
596
597
598 void be_liveness_free(be_lv_t *lv)
599 {
600         be_liveness_invalidate(lv);
601         free(lv);
602 }
603
604 void be_liveness_remove(be_lv_t *lv, ir_node *irn)
605 {
606         if (lv->nodes) {
607                 unsigned idx = get_irn_idx(irn);
608                 struct _lv_walker_t w;
609
610                 /*
611                  * Removes a single irn from the liveness information.
612                  * Since an irn can only be live at blocks dominated by the block of its
613                  * definition, we only have to process that dominance subtree.
614                  */
615                 w.lv   = lv;
616                 w.data = irn;
617                 dom_tree_walk(get_nodes_block(irn), lv_remove_irn_walker, NULL, &w);
618                 if(idx < bitset_size(lv->nodes))
619                         bitset_clear(lv->nodes, idx);
620         }
621 }
622
623 void be_liveness_introduce(be_lv_t *lv, ir_node *irn)
624 {
625         if (lv->nodes) {
626                 struct _lv_walker_t w;
627                 w.lv   = lv;
628                 w.data = bitset_malloc(get_irg_last_idx(lv->irg));
629                 liveness_for_node(irn, &w);
630                 bitset_free(w.data);
631         }
632 }
633
634 void be_liveness_update(be_lv_t *lv, ir_node *irn)
635 {
636         be_liveness_remove(lv, irn);
637         be_liveness_introduce(lv, irn);
638 }
639
640 static void lv_check_walker(ir_node *bl, void *data)
641 {
642         struct _lv_walker_t *w = data;
643         be_lv_t *lv    = w->lv;
644         be_lv_t *fresh = w->data;
645
646         struct _be_lv_info_t *curr = phase_get_irn_data(&lv->ph, bl);
647         struct _be_lv_info_t *fr   = phase_get_irn_data(&fresh->ph, bl);
648
649         if(!fr && curr && curr[0].u.head.n_members > 0) {
650                 unsigned i;
651
652                 ir_fprintf(stderr, "%+F liveness should be empty but current liveness contains:\n", bl);
653                 for(i = 0; i < curr[0].u.head.n_members; ++i) {
654                         ir_fprintf(stderr, "\t%+F\n", get_idx_irn(lv->irg, curr[1 + i].u.node.idx));
655                 }
656         }
657
658         else if(curr) {
659                 unsigned n_curr  = curr[0].u.head.n_members;
660                 unsigned n_fresh = fr[0].u.head.n_members;
661
662                 unsigned i;
663
664                 if(n_curr != n_fresh) {
665                         ir_fprintf(stderr, "%+F: liveness set sizes differ. curr %d, correct %d\n", bl, n_curr, n_fresh);
666
667                         ir_fprintf(stderr, "current:\n");
668                         for(i = 0; i < n_curr; ++i) {
669                                 struct _be_lv_info_node_t *n = &curr[1 + i].u.node;
670                                 ir_fprintf(stderr, "%+F %u %+F %s\n", bl, i, get_idx_irn(lv->irg, n->idx), lv_flags_to_str(n->flags));
671                         }
672
673                         ir_fprintf(stderr, "correct:\n");
674                         for(i = 0; i < n_fresh; ++i) {
675                                 struct _be_lv_info_node_t *n = &fr[1 + i].u.node;
676                                 ir_fprintf(stderr, "%+F %u %+F %s\n", bl, i, get_idx_irn(lv->irg, n->idx), lv_flags_to_str(n->flags));
677                         }
678                 }
679         }
680 }
681
682 void be_liveness_check(be_lv_t *lv)
683 {
684         struct _lv_walker_t w;
685         be_lv_t *fresh = be_liveness(lv->birg);
686
687         w.lv   = lv;
688         w.data = fresh;
689         irg_block_walk_graph(lv->irg, lv_check_walker, NULL, &w);
690         be_liveness_free(fresh);
691 }
692
693
694 static void lv_dump_block_walker(ir_node *irn, void *data)
695 {
696         struct _lv_walker_t *w = data;
697         if(is_Block(irn))
698                 lv_dump_block(w->lv, w->data, irn);
699 }
700
701
702 /* Dump the liveness information for a graph. */
703 void be_liveness_dump(const be_lv_t *lv, FILE *f)
704 {
705         struct _lv_walker_t w;
706
707         w.lv   = (be_lv_t *) lv;
708         w.data = f;
709         irg_block_walk_graph(lv->irg, lv_dump_block_walker, NULL, &w);
710 }
711
712 /* Dump the liveness information for a graph. */
713 void be_liveness_dumpto(const be_lv_t *lv, const char *cls_name)
714 {
715         FILE *f;
716         char buf[128];
717         ir_snprintf(buf, sizeof(buf), "%F_%s-live.txt", lv->irg, cls_name);
718         if((f = fopen(buf, "wt")) != NULL) {
719                 be_liveness_dump(lv, f);
720                 fclose(f);
721         }
722 }
723
724 /**
725  * Walker: checks the every predecessors of a node dominate
726  * the note.
727  */
728 static void dom_check(ir_node *irn, void *data)
729 {
730         int *problem_found = data;
731
732         if(!is_Block(irn) && irn != get_irg_end(get_irn_irg(irn))) {
733                 int i, n;
734                 ir_node *bl = get_nodes_block(irn);
735
736                 for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
737                         ir_node *op     = get_irn_n(irn, i);
738                         ir_node *def_bl = get_nodes_block(op);
739                         ir_node *use_bl = bl;
740
741                         if(is_Phi(irn))
742                                 use_bl = get_Block_cfgpred_block(bl, i);
743
744                         if(get_irn_opcode(use_bl) != iro_Bad
745                              && get_irn_opcode(def_bl) != iro_Bad
746                              && !block_dominates(def_bl, use_bl)) {
747                                 ir_fprintf(stderr, "Verify warning: %+F in %+F must dominate %+F for user %+F (%s)\n", op, def_bl, use_bl, irn, get_irg_dump_name(get_irn_irg(op)));
748                                 *problem_found = 1;
749                         }
750                 }
751         }
752 }
753
754 /* Check, if the SSA dominance property is fulfilled. */
755 int be_check_dominance(ir_graph *irg)
756 {
757         int problem_found = 0;
758
759         assure_doms(irg);
760         irg_walk_graph(irg, dom_check, NULL, &problem_found);
761
762         return !problem_found;
763 }
764
765 void be_liveness_transfer(const arch_env_t *arch_env,
766                           const arch_register_class_t *cls,
767                           ir_node *node, ir_nodeset_t *nodeset)
768 {
769         int i, arity;
770
771         /* You should better break out of your loop when hitting the first phi
772          * function. */
773         assert(!is_Phi(node) && "liveness_transfer produces invalid results for phi nodes");
774
775         if (get_irn_mode(node) == mode_T) {
776                 const ir_edge_t *edge;
777
778                 foreach_out_edge(node, edge) {
779                         ir_node *proj = get_edge_src_irn(edge);
780
781                         if (arch_irn_consider_in_reg_alloc(arch_env, cls, proj)) {
782                                 ir_nodeset_remove(nodeset, proj);
783                         }
784                 }
785         }
786
787         if (arch_irn_consider_in_reg_alloc(arch_env, cls, node)) {
788                 ir_nodeset_remove(nodeset, node);
789         }
790
791         arity = get_irn_arity(node);
792         for (i = 0; i < arity; ++i) {
793                 ir_node *op = get_irn_n(node, i);
794
795                 if (arch_irn_consider_in_reg_alloc(arch_env, cls, op))
796                         ir_nodeset_insert(nodeset, op);
797         }
798 }
799
800
801
802 void be_liveness_end_of_block(const be_lv_t *lv, const arch_env_t *arch_env,
803                               const arch_register_class_t *cls,
804                               const ir_node *block, ir_nodeset_t *live)
805 {
806         int i;
807
808         assert(lv->nodes && "live sets must be computed");
809         be_lv_foreach(lv, block, be_lv_state_end, i) {
810                 ir_node *node = be_lv_get_irn(lv, block, i);
811                 if(!arch_irn_consider_in_reg_alloc(arch_env, cls, node))
812                         continue;
813
814                 ir_nodeset_insert(live, node);
815         }
816 }
817
818
819
820 void be_liveness_nodes_live_at(const be_lv_t *lv, const arch_env_t *arch_env,
821                                const arch_register_class_t *cls,
822                                const ir_node *pos, ir_nodeset_t *live)
823 {
824         const ir_node *bl = is_Block(pos) ? pos : get_nodes_block(pos);
825         ir_node *irn;
826
827         be_liveness_end_of_block(lv, arch_env, cls, bl, live);
828         sched_foreach_reverse(bl, irn) {
829                 /*
830                  * If we encounter the node we want to insert the Perm after,
831                  * exit immediately, so that this node is still live
832                  */
833                 if(irn == pos)
834                         return;
835
836                 be_liveness_transfer(arch_env, cls, irn, live);
837         }
838 }
839
840 void be_liveness_nodes_live_at_input(const be_lv_t *lv,
841                                      const arch_env_t *arch_env,
842                                      const arch_register_class_t *cls,
843                                      const ir_node *pos, ir_nodeset_t *live)
844 {
845         const ir_node *bl = is_Block(pos) ? pos : get_nodes_block(pos);
846         ir_node *irn;
847
848         assert(lv->nodes && "live sets must be computed");
849         be_liveness_end_of_block(lv, arch_env, cls, bl, live);
850         sched_foreach_reverse(bl, irn) {
851                 be_liveness_transfer(arch_env, cls, irn, live);
852                 if(irn == pos)
853                         return;
854         }
855 }
856
857 static void collect_node(ir_node *irn, void *data)
858 {
859         struct obstack *obst = data;
860         obstack_ptr_grow(obst, irn);
861 }
862
863 void be_live_chk_compare(be_lv_t *lv, lv_chk_t *lvc)
864 {
865         ir_graph *irg    = lv->irg;
866
867         struct obstack obst;
868         ir_node **nodes;
869         ir_node **blocks;
870         int i, j;
871
872         obstack_init(&obst);
873
874         irg_block_walk_graph(irg, collect_node, NULL, &obst);
875         obstack_ptr_grow(&obst, NULL);
876         blocks = obstack_finish(&obst);
877
878         irg_walk_graph(irg, collect_node, NULL, &obst);
879         obstack_ptr_grow(&obst, NULL);
880         nodes = obstack_finish(&obst);
881
882         for (i = 0; blocks[i]; ++i) {
883                 ir_node *bl = blocks[i];
884
885                 for (j = 0; nodes[j]; ++j) {
886                         ir_node *irn = nodes[j];
887                         if (!is_Block(irn)) {
888                                 int lvr_in  = be_is_live_in (lv, bl, irn);
889                                 int lvr_out = be_is_live_out(lv, bl, irn);
890                                 int lvr_end = be_is_live_end(lv, bl, irn);
891
892                                 int lvc_in  = lv_chk_bl_in (lvc, bl, irn);
893                                 int lvc_out = lv_chk_bl_out(lvc, bl, irn);
894                                 int lvc_end = lv_chk_bl_end(lvc, bl, irn);
895
896                                 if (lvr_in - lvc_in != 0)
897                                         ir_fprintf(stderr, "live in  info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_in, lvc_in);
898
899                                 if (lvr_end - lvc_end != 0)
900                                         ir_fprintf(stderr, "live end info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_end, lvc_end);
901
902                                 if (lvr_out - lvc_out != 0)
903                                         ir_fprintf(stderr, "live out info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_out, lvc_out);
904                         }
905                 }
906         }
907
908
909         obstack_free(&obst, NULL);
910 }
911
912 void be_init_live(void)
913 {
914         FIRM_DBG_REGISTER(dbg, "firm.be.liveness");
915 }
916
917 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_live);