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