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