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