Added a first version of a Perm mover.
[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 #if 0
106         if(idx < payload[0].u.node.idx)
107                 return 0;
108
109         if(idx > payload[n - 1].u.node.idx)
110                 return n - 1;
111 #endif
112
113         /* start a binary search for the requested node. */
114         while(lo < hi) {
115                 int md          = lo + ((hi - lo) >> 1);
116                 unsigned md_idx = payload[md].u.node.idx;
117
118                 if(idx > md_idx)
119                         lo = md + 1;
120                 else if(idx < md_idx)
121                         hi = md;
122                 else {
123                         res = md;
124                         assert(payload[res].u.node.idx == idx);
125                         break;
126                 }
127
128                 res = lo;
129         }
130
131 #ifdef LV_INTESIVE_CHECKS
132         {
133                 unsigned i;
134                 for(i = res; i < n; ++i)
135                         assert(payload[i].u.node.idx >= idx);
136
137                 for(i = 0; i < res; ++i)
138                         assert(payload[i].u.node.idx < idx);
139         }
140 #endif
141
142         return res;
143 }
144
145 #else
146
147 /**
148  * This function searches linearly for the node in the array.
149  */
150 static INLINE unsigned _be_liveness_bsearch(struct _be_lv_info_t *arr, unsigned idx) {
151         unsigned n  = arr[0].u.head.n_members;
152         unsigned i;
153
154         for(i = 0; i < n; ++i) {
155                 if(arr[i + 1].u.node.idx == idx)
156                         return i;
157         }
158
159         return i;
160 }
161 #endif
162
163 struct _be_lv_info_node_t *be_lv_get(const struct _be_lv_t *li, const ir_node *bl, const ir_node *irn)
164 {
165         struct _be_lv_info_t *irn_live = phase_get_irn_data(&li->ph, bl);
166
167         if(irn_live) {
168                 unsigned idx = get_irn_idx(irn);
169
170                 /* Get the position of the index in the array. */
171                 int pos = _be_liveness_bsearch(irn_live, idx);
172
173                 /* Get the record in question. 1 must be added, since the first record contains information about the array and must be skipped. */
174                 struct _be_lv_info_node_t *res = &irn_live[pos + 1].u.node;
175
176                 /* Check, if the irn is in deed in the array. */
177                 if(res->idx == idx)
178                         return res;
179         }
180
181         return NULL;
182 }
183
184 static struct _be_lv_info_node_t *be_lv_get_or_set(struct _be_lv_t *li, ir_node *bl, ir_node *irn)
185 {
186         struct _be_lv_info_t *irn_live = phase_get_or_set_irn_data(&li->ph, bl);
187
188         unsigned idx = get_irn_idx(irn);
189
190         /* Get the position of the index in the array. */
191         unsigned pos = _be_liveness_bsearch(irn_live, idx);
192
193         /* Get the record in question. 1 must be added, since the first record contains information about the array and must be skipped. */
194         struct _be_lv_info_node_t *res = &irn_live[pos + 1].u.node;
195
196         /* Check, if the irn is in deed in the array. */
197         if(res->idx != idx) {
198                 struct _be_lv_info_t *payload;
199                 unsigned n_members = irn_live[0].u.head.n_members;
200                 unsigned n_size    = irn_live[0].u.head.n_size;
201                 unsigned i;
202
203                 if(n_members + 1 >= n_size) {
204                         /* double the array size. Remember that the first entry is
205                          * metadata about the array and not a real array element */
206                         unsigned old_size_bytes  = (n_size + 1) * sizeof(irn_live[0]);
207                         unsigned new_size        = (2 * n_size) + 1;
208                         size_t   new_size_bytes  = new_size * sizeof(irn_live[0]);
209                         struct _be_lv_info_t *nw = phase_alloc(&li->ph, new_size_bytes);
210                         memcpy(nw, irn_live, old_size_bytes);
211                         memset(((char*) nw) + old_size_bytes, 0,
212                                new_size_bytes - old_size_bytes);
213                         nw[0].u.head.n_size = new_size - 1;
214                         irn_live = nw;
215                         phase_set_irn_data(&li->ph, bl, nw);
216                 }
217
218                 payload = &irn_live[1];
219                 for(i = n_members; i > pos; --i) {
220                         payload[i] = payload[i - 1];
221                 }
222
223                 ++irn_live[0].u.head.n_members;
224
225                 res = &payload[pos].u.node;
226                 res->idx    = idx;
227                 res->flags  = 0;
228         }
229
230 #ifdef LV_INTESIVE_CHECKS
231         {
232                 unsigned i;
233                 unsigned n = irn_live[0].u.head.n_members;
234                 unsigned last = 0;
235                 struct _be_lv_info_t *payload = &irn_live[1];
236
237                 for(i = 0; i < n; ++i) {
238                         assert(payload[i].u.node.idx >= last);
239                         last = payload[i].u.node.idx;
240                 }
241         }
242 #endif
243
244         return res;
245 }
246
247 /**
248  * Removes a node from the list of live variables of a block.
249  * @return 1 if the node was live at that block, 0 if not.
250  */
251 static int be_lv_remove(struct _be_lv_t *li, ir_node *bl, ir_node *irn)
252 {
253         struct _be_lv_info_t *irn_live = phase_get_irn_data(&li->ph, bl);
254
255         if(irn_live) {
256                 unsigned n   = irn_live[0].u.head.n_members;
257                 unsigned idx = get_irn_idx(irn);
258                 unsigned pos = _be_liveness_bsearch(irn_live, idx);
259                 struct _be_lv_info_t *payload  = irn_live + 1;
260                 struct _be_lv_info_node_t *res = &payload[pos].u.node;
261
262                 /* The node is in deed in the block's array. Let's remove it. */
263                 if(res->idx == idx) {
264                         unsigned i;
265
266                         for(i = pos + 1; i < n; ++i)
267                                 payload[i - 1] = payload[i];
268
269                         payload[n - 1].u.node.idx   = 0;
270                         payload[n - 1].u.node.flags = 0;
271
272                         --irn_live[0].u.head.n_members;
273                         DBG((dbg, LEVEL_3, "\tdeleting %+F from %+F at pos %d\n", irn, bl, pos));
274                         return 1;
275                 }
276         }
277
278         return 0;
279 }
280
281 static void register_node(be_lv_t *lv, const ir_node *irn)
282 {
283         unsigned idx = get_irn_idx(irn);
284         if(idx >= bitset_size(lv->nodes)) {
285                 bitset_t *nw = bitset_malloc(2 * idx);
286                 bitset_copy(nw, lv->nodes);
287                 bitset_free(lv->nodes);
288                 lv->nodes = nw;
289         }
290
291         bitset_set(lv->nodes, idx);
292 }
293
294 /**
295  * Mark a node as live-in in a block.
296  */
297 static INLINE void mark_live_in(be_lv_t *lv, ir_node *block, ir_node *irn)
298 {
299         struct _be_lv_info_node_t *n = be_lv_get_or_set(lv, block, irn);
300         DBG((dbg, LEVEL_2, "marking %+F live in at %+F\n", irn, block));
301         n->flags |= be_lv_state_in;
302         register_node(lv, irn);
303 }
304
305 /**
306  * Mark a node as live-out in a block.
307  */
308 static INLINE void mark_live_out(be_lv_t *lv, ir_node *block, ir_node *irn)
309 {
310         struct _be_lv_info_node_t *n = be_lv_get_or_set(lv, block, irn);
311         DBG((dbg, LEVEL_2, "marking %+F live out at %+F\n", irn, block));
312         n->flags |= be_lv_state_out | be_lv_state_end;
313         register_node(lv, irn);
314 }
315
316 /**
317  * Mark a node as live-end in a block.
318  */
319 static INLINE void mark_live_end(be_lv_t *lv, ir_node *block, ir_node *irn)
320 {
321         struct _be_lv_info_node_t *n = be_lv_get_or_set(lv, block, irn);
322         DBG((dbg, LEVEL_2, "marking %+F live end at %+F\n", irn, block));
323         n->flags |= be_lv_state_end;
324         register_node(lv, irn);
325 }
326
327 /**
328  * Mark a node (value) live out at a certain block. Do this also
329  * transitively, i.e. if the block is not the block of the value's
330  * definition, all predecessors are also marked live.
331  * @param def The node (value).
332  * @param block The block to mark the value live out of.
333  * @param visited A set were all visited blocks are recorded.
334  * @param is_true_out Is the node real out there or only live at the end
335  * of the block.
336  */
337 static void live_end_at_block(be_lv_t *lv, ir_node *def, ir_node *block, bitset_t *visited, int is_true_out)
338 {
339         mark_live_end(lv, block, def);
340         if(is_true_out)
341                 mark_live_out(lv, block, def);
342
343         if(!bitset_contains_irn(visited, block)) {
344                 bitset_add_irn(visited, block);
345
346                 /*
347                 * If this block is not the definition block, we have to go up
348                 * further.
349                 */
350                 if(get_nodes_block(def) != block) {
351                         int i, n;
352
353                         mark_live_in(lv, block, def);
354
355                         for(i = 0, n = get_Block_n_cfgpreds(block); i < n; ++i)
356                                 live_end_at_block(lv, def, get_Block_cfgpred_block(block, i), visited, 1);
357                 }
358
359         }
360 }
361
362 struct _lv_walker_t {
363         be_lv_t *lv;
364         void *data;
365 };
366
367 /**
368  * Liveness analysis for a value.
369  * This functions is meant to be called by a firm walker, to compute the
370  * set of all blocks a value is live in.
371  * @param irn The node (value).
372  * @param env Ignored.
373  */
374 static void liveness_for_node(ir_node *irn, void *data)
375 {
376         struct _lv_walker_t *walker = data;
377         be_lv_t *lv       = walker->lv;
378         bitset_t *visited = walker->data;
379         const ir_edge_t *edge;
380         ir_node *def_block;
381
382         /* Don't compute liveness information for non-data nodes. */
383         if(!is_liveness_node(irn))
384                 return;
385
386         bitset_clear_all(visited);
387         def_block = get_nodes_block(irn);
388
389         /* Go over all uses of the value */
390         foreach_out_edge(irn, edge) {
391                 ir_node *use = edge->src;
392                 ir_node *use_block;
393
394                 /*
395                  * If the usage is no data node, skip this use, since it does not
396                  * affect the liveness of the node.
397                  */
398                 if(!is_liveness_node(use))
399                         continue;
400
401                 /* Get the block where the usage is in. */
402                 use_block = get_nodes_block(use);
403
404                 /*
405                  * If the use is a phi function, determine the corresponding block
406                  * through which the value reaches the phi function and mark the
407                  * value as live out of that block.
408                  */
409                 if(is_Phi(use)) {
410                         ir_node *pred_block = get_Block_cfgpred_block(use_block, edge->pos);
411                         live_end_at_block(lv, irn, pred_block, visited, 0);
412                 }
413
414                 /*
415                  * Else, the value is live in at this block. Mark it and call live
416                  * out on the predecessors.
417                  */
418                 else if(def_block != use_block) {
419                         int i, n;
420
421                         mark_live_in(lv, use_block, irn);
422
423                         for(i = 0, n = get_Block_n_cfgpreds(use_block); i < n; ++i) {
424                                 ir_node *pred_block = get_Block_cfgpred_block(use_block, i);
425                                 live_end_at_block(lv, irn, pred_block, visited, 1);
426                         }
427                 }
428         }
429 }
430
431 static void lv_remove_irn_walker(ir_node *bl, void *data)
432 {
433         struct _lv_walker_t *w = data;
434         be_lv_t *lv  = w->lv;
435         ir_node *irn = w->data;
436         be_lv_remove(lv, bl, irn);
437 }
438
439 static const char *lv_flags_to_str(unsigned flags)
440 {
441         static const char *states[] = {
442                 "---",
443                 "i--",
444                 "-e-",
445                 "ie-",
446                 "--o",
447                 "i-o",
448                 "-eo",
449                 "ieo"
450         };
451
452         return states[flags & 7];
453 }
454
455 static void lv_dump_block(void *context, FILE *f, const ir_node *bl)
456 {
457         if(is_Block(bl)) {
458                 be_lv_t *lv = context;
459                 struct _be_lv_info_t *info = phase_get_irn_data(&lv->ph, bl);
460
461                 fprintf(f, "liveness:\n");
462                 if(info) {
463                         unsigned n = info[0].u.head.n_members;
464                         unsigned i;
465
466                         for(i = 0; i < n; ++i) {
467                                 struct _be_lv_info_node_t *n = &info[i+1].u.node;
468                                 ir_fprintf(f, "%s %+F\n", lv_flags_to_str(n->flags), get_idx_irn(lv->irg, n->idx));
469                         }
470                 }
471         }
472 }
473
474 static void *lv_phase_data_init(ir_phase *phase, ir_node *irn, void *old)
475 {
476         struct _be_lv_info_t *info = phase_alloc(phase, LV_STD_SIZE * sizeof(info[0]));
477         memset(info, 0, LV_STD_SIZE * sizeof(info[0]));
478         info[0].u.head.n_size = LV_STD_SIZE - 1;
479         return info;
480 }
481
482 static void collect_nodes(ir_node *irn, void *data)
483 {
484         struct obstack *obst = data;
485         if (is_liveness_node(irn))
486                 obstack_ptr_grow(obst, irn);
487 }
488
489 static int node_idx_cmp(const void *a, const void *b)
490 {
491         int ia = get_irn_idx(a);
492         int ib = get_irn_idx(b);
493         return ia - ib;
494 }
495
496 static void compute_liveness(be_lv_t *lv)
497 {
498         struct obstack obst;
499         struct _lv_walker_t w;
500         ir_node **nodes;
501         int i, n;
502
503         obstack_init(&obst);
504         irg_walk_graph(lv->irg, collect_nodes, NULL, &obst);
505         n      = obstack_object_size(&obst) / sizeof(nodes[0]);
506         nodes  = obstack_finish(&obst);
507
508         /*
509          * inserting the variables sorted by their ID is probably
510          * more efficient since the binary sorted set insertion
511          * will not need to move arounf the data.
512          * However, if sorting the variables a priori pays off
513          * needs to be checked, hence the define.
514          */
515 #ifdef LV_COMPUTE_SORTED
516         qsort(nodes, n, sizeof(nodes[0]), node_idx_cmp);
517 #endif
518
519         w.lv   = lv;
520         w.data = bitset_obstack_alloc(&obst, get_irg_last_idx(lv->irg));
521
522         for (i = 0; i < n; ++i)
523                 liveness_for_node(nodes[i], &w);
524
525         obstack_free(&obst, NULL);
526         register_hook(hook_node_info, &lv->hook_info);
527 }
528
529 void be_liveness_assure_sets(be_lv_t *lv)
530 {
531         if (!lv->nodes) {
532                 lv->nodes = bitset_malloc(2 * get_irg_last_idx(lv->irg));
533                 phase_init(&lv->ph, "liveness", lv->irg, PHASE_DEFAULT_GROWTH, lv_phase_data_init, NULL);
534                 compute_liveness(lv);
535         }
536 }
537
538 void be_liveness_assure_chk(be_lv_t *lv)
539 {
540 #ifndef USE_LIVE_CHK
541         be_liveness_assure_sets(be_lv_t *lv);
542 #endif
543 }
544
545 void be_liveness_invalidate(be_lv_t *lv)
546 {
547         if (lv && lv->nodes) {
548                 unregister_hook(hook_node_info, &lv->hook_info);
549                 phase_free(&lv->ph);
550                 bitset_free(lv->nodes);
551                 lv->nodes = NULL;
552         }
553 }
554
555 /* Compute the inter block liveness for a graph. */
556 be_lv_t *be_liveness(ir_graph *irg)
557 {
558         be_lv_t *lv = xmalloc(sizeof(lv[0]));
559
560         memset(lv, 0, sizeof(lv[0]));
561         lv->irg = irg;
562         lv->lvc = lv_chk_new(irg);
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 pset *be_liveness_transfer(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *irn, pset *live)
754 {
755         int i, n;
756
757         /* You should better break out of your loop when hitting the first phi function. */
758         assert(!is_Phi(irn) && "liveness_transfer produces invalid results for phi nodes");
759
760         if(arch_irn_consider_in_reg_alloc(arch_env, cls, irn)) {
761                 ir_node *del = pset_remove_ptr(live, irn);
762                 (void) del;
763                 assert(irn == del);
764         }
765
766         for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
767                 ir_node *op = get_irn_n(irn, i);
768
769                 if(arch_irn_consider_in_reg_alloc(arch_env, cls, op))
770                         pset_insert_ptr(live, op);
771         }
772
773         return live;
774 }
775
776 void be_liveness_transfer_ir_nodeset(const arch_env_t *arch_env,
777                                      const arch_register_class_t *cls,
778                                      ir_node *node, ir_nodeset_t *nodeset)
779 {
780         int i, arity;
781
782         /* You should better break out of your loop when hitting the first phi
783          * function. */
784         assert(!is_Phi(node) && "liveness_transfer produces invalid results for phi nodes");
785
786         if(arch_irn_consider_in_reg_alloc(arch_env, cls, node)) {
787                 ir_nodeset_remove(nodeset, node);
788         }
789
790         arity = get_irn_arity(node);
791         for(i = 0; i < arity; ++i) {
792                 ir_node *op = get_irn_n(node, i);
793
794                 if(arch_irn_consider_in_reg_alloc(arch_env, cls, op))
795                         ir_nodeset_insert(nodeset, op);
796         }
797 }
798
799
800
801 pset *be_liveness_end_of_block(const be_lv_t *lv, const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *bl, pset *live)
802 {
803         int i;
804         assert(lv->nodes && "live sets must be computed");
805         be_lv_foreach(lv, bl, be_lv_state_end, i) {
806                 ir_node *irn = be_lv_get_irn(lv, bl, i);
807                 if(arch_irn_consider_in_reg_alloc(arch_env, cls, irn))
808                         pset_insert_ptr(live, irn);
809         }
810
811         return live;
812 }
813
814 void be_liveness_end_of_block_ir_nodeset(const be_lv_t *lv,
815                                          const arch_env_t *arch_env,
816                                          const arch_register_class_t *cls,
817                                          const ir_node *block,
818                                          ir_nodeset_t *live)
819 {
820         int i;
821
822         assert(lv->nodes && "live sets must be computed");
823         be_lv_foreach(lv, block, be_lv_state_end, i) {
824                 ir_node *node = be_lv_get_irn(lv, block, i);
825                 if(!arch_irn_consider_in_reg_alloc(arch_env, cls, node))
826                         continue;
827
828                 ir_nodeset_insert(live, node);
829         }
830 }
831
832
833
834 pset *be_liveness_nodes_live_at(const be_lv_t *lv, const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *pos, pset *live)
835 {
836         const ir_node *bl = is_Block(pos) ? pos : get_nodes_block(pos);
837         ir_node *irn;
838
839         be_liveness_end_of_block(lv, arch_env, cls, bl, live);
840         sched_foreach_reverse(bl, irn) {
841                 /*
842                  * If we encounter the node we want to insert the Perm after,
843                  * exit immediately, so that this node is still live
844                  */
845                 if(irn == pos)
846                         return live;
847
848                 be_liveness_transfer(arch_env, cls, irn, live);
849         }
850
851         return live;
852 }
853
854 pset *be_liveness_nodes_live_at_input(const be_lv_t *lv, const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *pos, pset *live)
855 {
856         const ir_node *bl = is_Block(pos) ? pos : get_nodes_block(pos);
857         ir_node *irn;
858
859         assert(lv->nodes && "live sets must be computed");
860         be_liveness_end_of_block(lv, arch_env, cls, bl, live);
861         sched_foreach_reverse(bl, irn) {
862                 be_liveness_transfer(arch_env, cls, irn, live);
863                 if(irn == pos)
864                         return live;
865         }
866
867         return live;
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         for (i = 0; blocks[i]; ++i) {
896                 ir_node *bl = blocks[i];
897
898                 for (j = 0; nodes[j]; ++j) {
899                         ir_node *irn = nodes[j];
900                         if (!is_Block(irn)) {
901                                 int lvr_in  = be_is_live_in (lv, bl, irn);
902                                 int lvr_out = be_is_live_out(lv, bl, irn);
903                                 int lvr_end = be_is_live_end(lv, bl, irn);
904
905                                 int lvc_in  = lv_chk_bl_in (lvc, bl, irn);
906                                 int lvc_out = lv_chk_bl_out(lvc, bl, irn);
907                                 int lvc_end = lv_chk_bl_end(lvc, bl, irn);
908
909                                 if (lvr_in - lvc_in != 0)
910                                         ir_fprintf(stderr, "live in  info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_in, lvc_in);
911
912                                 if (lvr_end - lvc_end != 0)
913                                         ir_fprintf(stderr, "live end info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_end, lvc_end);
914
915                                 if (lvr_out - lvc_out != 0)
916                                         ir_fprintf(stderr, "live out info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_out, lvc_out);
917                         }
918                 }
919         }
920
921
922         obstack_free(&obst, NULL);
923 }
924
925 void be_init_live(void)
926 {
927         FIRM_DBG_REGISTER(dbg, "firm.be.liveness");
928 }
929
930 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_live);