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