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