Correct comment: xvcg wants LF, not CR.
[libfirm] / ir / ir / iredges.c
1 /*
2  * Copyright (C) 1995-2011 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   Always available outs.
23  * @author  Sebastian Hack, Michael Beck, Andreas Schoesser
24  * @date    14.1.2005
25  * @brief
26  *   This are out-edges (also called def-use edges) that are dynamically
27  *   updated as the graph changes.
28  */
29 #include "config.h"
30
31 #include "irnode_t.h"
32 #include "iropt_t.h"
33 #include "iredgekinds.h"
34 #include "iredges_t.h"
35 #include "irgwalk.h"
36 #include "irdump_t.h"
37 #include "irprintf.h"
38 #include "debug.h"
39 #include "set.h"
40 #include "bitset.h"
41 #include "error.h"
42 #include "irpass_t.h"
43
44 #include "iredgeset.h"
45 #include "hashptr.h"
46
47 #define DO_REHASH
48 #define SCALAR_RETURN
49 #define HashSet                   ir_edgeset_t
50 #define HashSetIterator           ir_edgeset_iterator_t
51 #define ValueType                 ir_edge_t*
52 #define NullValue                 NULL
53 #define DeletedValue              ((ir_edge_t*)-1)
54 #define Hash(this,key)            (hash_ptr(key->src) ^ (key->pos * 40013))
55 #define KeysEqual(this,key1,key2) ((key1->src) == (key2->src) && (key1->pos == key2->pos))
56 #define SetRangeEmpty(ptr,size)   memset(ptr, 0, (size) * sizeof((ptr)[0]))
57
58 #define hashset_init            ir_edgeset_init
59 void ir_edgeset_init_size(ir_edgeset_t *self, size_t size);
60 #define hashset_init_size       ir_edgeset_init_size
61 #define hashset_destroy         ir_edgeset_destroy
62 #define hashset_insert          ir_edgeset_insert
63 #define hashset_remove          ir_edgeset_remove
64 ir_edge_t *ir_edgeset_find(const ir_edgeset_t *self, const ir_edge_t*);
65 #define hashset_find            ir_edgeset_find
66 size_t ir_edgeset_size(const ir_edgeset_t *self);
67 #define hashset_size            ir_edgeset_size
68 #define hashset_iterator_init   ir_edgeset_iterator_init
69 #define hashset_iterator_next   ir_edgeset_iterator_next
70 #define hashset_remove_iterator ir_edgeset_remove_iterator
71
72 #include "hashset.c"
73
74 /**
75  * A function that allows for setting an edge.
76  * This abstraction is necessary since different edge kind have
77  * different methods of setting edges.
78  */
79 typedef void (set_edge_func_t)(ir_node *src, int pos, ir_node *tgt);
80
81 /**
82  * A function that returns the "arity" of a given edge kind
83  * for a node.
84  */
85 typedef int (get_edge_src_arity_func_t)(const ir_node *src);
86
87 /**
88  * A function that returns the pos'th edge of a given edge kind for a node.
89  */
90 typedef ir_node *(get_edge_src_n_func_t)(const ir_node *src, int pos);
91
92 /**
93  * Additional data for an edge kind.
94  */
95 typedef struct {
96         const char                *name;       /**< name of this edge kind */
97         set_edge_func_t           *set_edge;   /**< the set_edge function */
98         int                       first_idx;   /**< index of the first possible edge */
99         get_edge_src_arity_func_t *get_arity;  /**< the get_arity function */
100         get_edge_src_n_func_t     *get_n;      /**< the get_n function */
101 } ir_edge_kind_info_t;
102
103 /**
104  * Get the predecessor block.
105  */
106 static ir_node *get_block_n(const ir_node *block, int pos)
107 {
108         if (is_Block(block))
109                 return get_Block_cfgpred_block(block, pos);
110         /* might be a Bad */
111         return NULL;
112 }
113
114 static ir_node *get_irn_safe_n(const ir_node *node, int n)
115 {
116         if (n == -1 && is_Block(node))
117                 return NULL;
118         return get_irn_n(node, n);
119 }
120
121 static const ir_edge_kind_info_t edge_kind_info[EDGE_KIND_LAST] = {
122         { "normal"     , set_irn_n,   -1, get_irn_arity,  get_irn_safe_n },
123         { "block succs", NULL,         0, get_irn_arity,  get_block_n    },
124         { "dependency",  set_irn_dep,  0, get_irn_deps,   get_irn_dep    }
125 };
126
127 #define foreach_tgt(irn, i, n, kind) for (i = edge_kind_info[kind].first_idx, n = edge_kind_info[kind].get_arity(irn); i < n; ++i)
128 #define get_n(irn, pos, kind)        (edge_kind_info[kind].get_n(irn, pos))
129 #define get_kind_str(kind)           (edge_kind_info[kind].name)
130
131 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
132
133 /**
134  * This flag is set to 1, if the edges get initialized for an irg.
135  * Then register additional data is forbidden.
136  */
137 static int edges_used = 0;
138
139 /**
140  * Summed size of all users private data
141  */
142
143 static size_t edges_private_size = 0;
144 #define EDGE_SIZE (sizeof(ir_edge_t) + edges_private_size)
145
146 /**
147  * If set to 1, the list heads are checked every time an edge is changed.
148  */
149 static int edges_dbg = 0;
150
151 /**
152  * Returns an ID for the given edge.
153  */
154 static inline long edge_get_id(const ir_edge_t *e)
155 {
156         return (long)e;
157 }
158
159 size_t edges_register_private_data(size_t n)
160 {
161         size_t res = edges_private_size;
162
163         assert(!edges_used && "you cannot register private edge data, if edges have been initialized");
164
165         edges_private_size += n;
166         return res;
167 }
168
169 void edges_reset_private_data(ir_graph *irg, int offset, unsigned size)
170 {
171         irg_edge_info_t       *info = get_irg_edge_info(irg, EDGE_KIND_NORMAL);
172         ir_edge_t             *edge;
173         ir_edgeset_iterator_t  iter;
174
175         foreach_ir_edgeset(&info->edges, edge, iter) {
176                 memset(edge + sizeof(*edge) + offset, 0, size);
177         }
178 }
179
180 #define TIMES37(x) (((x) << 5) + ((x) << 2) + (x))
181
182 #define get_irn_out_list_head(irn) (&get_irn_out_info(irn)->outs)
183
184 #define edge_hash(edge) (TIMES37((edge)->pos) + hash_ptr((edge)->src))
185
186 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind)
187 {
188         if (edges_activated_kind(irg, kind)) {
189                 irg_edge_info_t *info = get_irg_edge_info(irg, kind);
190                 size_t amount = irg->estimated_node_count * 2;
191
192                 edges_used = 1;
193                 if (info->allocated) {
194                         amount = ir_edgeset_size(&info->edges);
195                         ir_edgeset_destroy(&info->edges);
196                         obstack_free(&info->edges_obst, NULL);
197                 }
198                 obstack_init(&info->edges_obst);
199                 INIT_LIST_HEAD(&info->free_edges);
200                 ir_edgeset_init_size(&info->edges, amount);
201                 info->allocated = 1;
202         }
203 }
204
205 const ir_edge_t *get_irn_edge_kind(const ir_node *src, int pos, ir_edge_kind_t kind)
206 {
207         ir_graph *irg = get_irn_irg(src);
208         if (edges_activated_kind(irg, kind)) {
209                 irg_edge_info_t *info = get_irg_edge_info(irg, kind);
210                 ir_edge_t       key;
211
212                 key.src = (ir_node *)src;
213                 key.pos = pos;
214
215                 return ir_edgeset_find(&info->edges, &key);
216         }
217
218         return NULL;
219 }
220
221 /**
222  * Change the out count
223  *
224  * @param tgt  the edge target
225  * @param kind the kind of the edge
226  */
227 static inline void edge_change_cnt(ir_node *tgt, ir_edge_kind_t kind, int ofs)
228 {
229         irn_edge_info_t *info = get_irn_edge_info(tgt, kind);
230         info->out_count += ofs;
231 }
232
233 /**
234  * Verify the edge list of a node, ie. ensure it's a loop:
235  * head -> e_1 -> ... -> e_n -> head
236  */
237 static inline void verify_list_head(ir_node *irn, ir_edge_kind_t kind)
238 {
239         int                    err     = 0;
240         int                    num     = 0;
241         pset                   *lh_set = pset_new_ptr(16);
242         const struct list_head *head   = &get_irn_edge_info(irn, kind)->outs_head;
243         const struct list_head *pos;
244
245         list_for_each(pos, head) {
246                 if (pset_find_ptr(lh_set, pos)) {
247                         const ir_edge_t *edge = list_entry(pos, ir_edge_t, list);
248
249                         ir_fprintf(stderr, "EDGE Verifier: edge list broken (self loop not to head) for %+F:\n", irn);
250                         fprintf(stderr, "- at list entry %d\n", num);
251                         if (edge->invalid)
252                                 fprintf(stderr, "- edge(%ld) is invalid\n", edge_get_id(edge));
253                         if (edge->src)
254                                 ir_fprintf(stderr, "- edge(%ld) %+F(%d)\n", edge_get_id(edge), edge->src, edge->pos);
255                         err = 1;
256                         break;
257                 }
258                 num++;
259                 pset_insert_ptr(lh_set, pos);
260         }
261
262         del_pset(lh_set);
263
264         assert(err == 0);
265 }
266
267 void edges_dump_kind(ir_graph *irg, ir_edge_kind_t kind)
268 {
269         irg_edge_info_t *info;
270         ir_edgeset_t    *edges;
271         ir_edgeset_iterator_t iter;
272         ir_edge_t      *e;
273
274         if (!edges_activated_kind(irg, kind))
275                 return;
276
277         info  = get_irg_edge_info(irg, kind);
278         edges = &info->edges;
279         foreach_ir_edgeset(edges, e, iter) {
280                 ir_printf("%+F %d %d\n", e->src, e->pos, e->invalid);
281         }
282 }
283
284 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt,
285                             ir_node *old_tgt, ir_edge_kind_t kind,
286                             ir_graph *irg)
287 {
288         const char      *msg = "";
289         irg_edge_info_t *info;
290         ir_edgeset_t    *edges;
291         ir_edge_t        templ;
292
293         assert(edges_activated_kind(irg, kind));
294
295         /*
296          * Only do something, if the old and new target differ.
297          */
298         if (tgt == old_tgt)
299                 return;
300
301         info  = get_irg_edge_info(irg, kind);
302         edges = &info->edges;
303
304         /* Initialize the edge template to search in the set. */
305         templ.src = src;
306         templ.pos = pos;
307
308         /*
309          * If the target is NULL, the edge shall be deleted.
310          */
311         if (tgt == NULL) {
312                 /* search the edge in the set. */
313                 ir_edge_t *edge = ir_edgeset_find(edges, &templ);
314
315                 /* mark the edge invalid if it was found */
316                 if (edge) {
317                         msg = "deleting";
318                         list_del(&edge->list);
319                         ir_edgeset_remove(edges, edge);
320                         list_add(&edge->list, &info->free_edges);
321                         edge->invalid = 1;
322                         edge->pos = -2;
323                         edge->src = NULL;
324                         edge_change_cnt(old_tgt, kind, -1);
325                 } else {
326                         /* If the edge was not found issue a warning on the debug stream */
327                         msg = "edge to delete not found!\n";
328                 }
329         } else {
330                 /*
331                  * The target is not NULL and the old target differs
332                  * from the new target, the edge shall be moved (if the
333                  * old target was != NULL) or added (if the old target was
334                  * NULL).
335                  */
336                 struct list_head *head = &get_irn_edge_info(tgt, kind)->outs_head;
337
338                 assert(head->next && head->prev &&
339                                 "target list head must have been initialized");
340
341                 /* If the old target is not null, the edge is moved. */
342                 if (old_tgt) {
343                         ir_edge_t *edge = ir_edgeset_find(edges, &templ);
344                         assert(edge && "edge to redirect not found!");
345                         assert(! edge->invalid && "Invalid edge encountered");
346
347                         msg = "redirecting";
348
349                         list_move(&edge->list, head);
350                         edge_change_cnt(old_tgt, kind, -1);
351                 } else {
352                         /* The old target was NULL, thus, the edge is newly created. */
353                         ir_edge_t *new_edge;
354                         ir_edge_t *edge;
355
356                         if (list_empty(&info->free_edges)) {
357                                 edge = (ir_edge_t*)obstack_alloc(&info->edges_obst, EDGE_SIZE);
358                         } else {
359                                 edge = list_entry(info->free_edges.next, ir_edge_t, list);
360                                 list_del(&edge->list);
361                         }
362
363                         edge->src       = src;
364                         edge->pos       = pos;
365                         edge->invalid   = 0;
366                         edge->present   = 0;
367                         edge->kind      = kind;
368                         edge->list.next = NULL;
369                         edge->list.prev = NULL;
370                         memset(edge + 1, 0, edges_private_size);
371
372                         new_edge = ir_edgeset_insert(edges, edge);
373                         if (new_edge != edge) {
374                                 panic("new edge exists already");
375                         }
376
377                         msg = "adding";
378                         list_add(&edge->list, head);
379                 }
380
381                 edge_change_cnt(tgt, kind, +1);
382         }
383
384 #ifndef DEBUG_libfirm
385         /* verify list heads */
386         if (edges_dbg) {
387                 if (tgt)
388                         verify_list_head(tgt, kind);
389                 if (old_tgt)
390                         verify_list_head(old_tgt, kind);
391         }
392 #endif
393
394         DBG((dbg, LEVEL_5, "announce out edge: %+F %d-> %+F(%+F): %s\n", src, pos, tgt, old_tgt, msg));
395 }
396
397 void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt,
398                        ir_graph *irg)
399 {
400         if (edges_activated_kind(irg, EDGE_KIND_NORMAL)) {
401                 edges_notify_edge_kind(src, pos, tgt, old_tgt, EDGE_KIND_NORMAL, irg);
402         }
403
404         if (edges_activated_kind(irg, EDGE_KIND_BLOCK)) {
405                 if (is_Block(src)) {
406                         ir_node *bl_old = old_tgt ? get_nodes_block(old_tgt) : NULL;
407                         ir_node *bl_tgt = NULL;
408
409                         if (tgt)
410                                 bl_tgt = is_Bad(tgt) ? tgt : get_nodes_block(tgt);
411
412                         edges_notify_edge_kind(src, pos, bl_tgt, bl_old, EDGE_KIND_BLOCK, irg);
413                 } else if (get_irn_mode(src) == mode_X && old_tgt != NULL && is_Block(old_tgt)) {
414                         /* moving a jump node from one block to another */
415                         const ir_edge_t *edge;
416                         const ir_edge_t *next;
417                         foreach_out_edge_kind_safe(old_tgt, edge, next, EDGE_KIND_BLOCK) {
418                                 ir_node *succ       = get_edge_src_irn(edge);
419                                 int      succ_pos   = get_edge_src_pos(edge);
420                                 ir_node *block_pred = get_Block_cfgpred(succ, succ_pos);
421                                 if (block_pred != src)
422                                         continue;
423                                 edges_notify_edge_kind(succ, succ_pos, tgt, old_tgt,
424                                                        EDGE_KIND_BLOCK, irg);
425                         }
426                 }
427         }
428 }
429
430 /**
431  * Delete all in edges of a given kind from the node old.
432  *
433  * @param old   the node
434  * @param kind  the kind of edges to remove
435  * @param irg   the irg of the old node
436  */
437 static void edges_node_deleted_kind(ir_node *old, ir_edge_kind_t kind)
438 {
439         int i, n;
440         ir_graph *irg = get_irn_irg(old);
441
442         if (!edges_activated_kind(irg, kind))
443                 return;
444
445         DBG((dbg, LEVEL_5, "node deleted (kind: %s): %+F\n", get_kind_str(kind), old));
446
447         foreach_tgt(old, i, n, kind) {
448                 ir_node *old_tgt = get_n(old, i, kind);
449                 edges_notify_edge_kind(old, i, NULL, old_tgt, kind, irg);
450         }
451 }
452
453 /**
454  * A node might be revivaled by CSE. Assure its edges.
455  *
456  * @param irn   the node
457  * @param kind  the kind of edges to remove
458  * @param irg   the irg of the old node
459  */
460 static void edges_node_revival_kind(ir_node *irn, ir_edge_kind_t kind)
461 {
462         irn_edge_info_t *info;
463         int             i, n;
464         ir_graph        *irg = get_irn_irg(irn);
465
466         if (!edges_activated_kind(irg, kind))
467                 return;
468
469         info = get_irn_edge_info(irn, kind);
470         if (info->edges_built)
471                 return;
472
473         DBG((dbg, LEVEL_5, "node revivaled (kind: %s): %+F\n", get_kind_str(kind), irn));
474
475         foreach_tgt(irn, i, n, kind) {
476                 ir_node *tgt = get_n(irn, i, kind);
477                 edges_notify_edge_kind(irn, i, tgt, NULL, kind, irg);
478         }
479         info->edges_built = 1;
480 }
481
482 typedef struct build_walker {
483         ir_edge_kind_t kind;
484         bitset_t       *reachable;
485         unsigned       problem_found;
486 } build_walker;
487
488 /**
489  * Post-Walker: notify all edges
490  */
491 static void build_edges_walker(ir_node *irn, void *data)
492 {
493         build_walker          *w = (build_walker*)data;
494         int                   i, n;
495         ir_edge_kind_t        kind = w->kind;
496         ir_graph              *irg = get_irn_irg(irn);
497
498         foreach_tgt(irn, i, n, kind) {
499                 ir_node *pred = get_n(irn, i, kind);
500                 edges_notify_edge_kind(irn, i, pred, NULL, kind, irg);
501         }
502         get_irn_edge_info(irn, kind)->edges_built = 1;
503 }
504
505 /**
506  * Pre-Walker: initializes the list-heads and set the out-count
507  * of all nodes to 0.
508  */
509 static void init_lh_walker(ir_node *irn, void *data)
510 {
511         build_walker   *w    = (build_walker*)data;
512         ir_edge_kind_t  kind = w->kind;
513         list_head      *head = &get_irn_edge_info(irn, kind)->outs_head;
514         INIT_LIST_HEAD(head);
515         get_irn_edge_info(irn, kind)->edges_built = 0;
516         get_irn_edge_info(irn, kind)->out_count   = 0;
517 }
518
519 /**
520  * Pre-Walker: initializes the list-heads and set the out-count
521  * of all nodes to 0.
522  *
523  * Additionally touches DEP nodes, as they might be DEAD.
524  * THIS IS UGLY, but I don't find a better way until we
525  *
526  * a) ensure that dead nodes are not used as input
527  * b) it might be sufficient to add those stupid NO_REG nodes
528  * to the anchor
529  */
530 static void init_lh_walker_dep(ir_node *irn, void *data)
531 {
532         build_walker   *w    = (build_walker*)data;
533         ir_edge_kind_t  kind = w->kind;
534         list_head      *head = &get_irn_edge_info(irn, kind)->outs_head;
535         int             i;
536
537         INIT_LIST_HEAD(head);
538         get_irn_edge_info(irn, kind)->edges_built = 0;
539         get_irn_edge_info(irn, kind)->out_count   = 0;
540
541         for (i = get_irn_deps(irn) - 1; i >= 0; --i) {
542                 ir_node *dep = get_irn_dep(irn, i);
543
544                 head = &get_irn_edge_info(dep, kind)->outs_head;
545
546                 INIT_LIST_HEAD(head);
547                 get_irn_edge_info(dep, kind)->edges_built = 0;
548                 get_irn_edge_info(dep, kind)->out_count   = 0;
549         }
550 }
551
552 typedef struct visitor_info_t {
553         irg_walk_func *visit;
554         void *data;
555 } visitor_info_t;
556
557 /**
558  * Visitor: initializes the list-heads and set the out-count
559  * of all nodes to 0 of nodes that are not seen so far.
560  */
561 static void visitor(ir_node *irn, void *data)
562 {
563         visitor_info_t *info = (visitor_info_t*)data;
564
565         if (is_Deleted(irn))
566                 return;
567         if (!is_Block(irn) && is_Deleted(get_nodes_block(irn)))
568                 return;
569
570         if (!irn_visited_else_mark(irn)) {
571                 info->visit(irn, info->data);
572         }
573 }
574
575 void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind)
576 {
577         /*
578          * Build the initial edge set.
579          * Beware, this is not a simple task because it suffers from two
580          * difficulties:
581          * - the anchor set allows access to Nodes that may not be reachable from
582          *   the End node
583          * - the identities add nodes to the "root set" that are not yet reachable
584          *   from End. However, after some transformations, the CSE may revival these
585          *   nodes
586          *
587          * These problems can be fixed using different strategies:
588          * - Add an age flag to every node. Whenever the edge of a node is older
589          *   then the current edge, invalidate the edges of this node.
590          *   While this would help for revivaled nodes, it increases memory and runtime.
591          * - Delete the identities set.
592          *   Solves the revival problem, but may increase the memory consumption, as
593          *   nodes cannot be revivaled at all.
594          * - Manually iterate over the identities root set. This did not consume more memory
595          *   but increase the computation time because the |identities| >= |V|
596          *
597          * Currently, we use the last option.
598          */
599         struct build_walker w;
600         irg_edge_info_t     *info = get_irg_edge_info(irg, kind);
601         visitor_info_t      visit;
602
603         w.kind = kind;
604
605         visit.data = &w;
606
607         assert(!info->activated);
608
609         info->activated = 1;
610         edges_init_graph_kind(irg, kind);
611         if (kind == EDGE_KIND_DEP) {
612                 irg_walk_anchors(irg, init_lh_walker_dep, NULL, &w);
613                 /* Argh: Dep nodes might be dead, so we MUST visit identities first */
614                 visit.visit = init_lh_walker_dep;
615                 visit_all_identities(irg, visitor, &visit);
616                 irg_walk_anchors(irg, NULL, build_edges_walker, &w);
617         } else {
618                 visit.visit = init_lh_walker;
619                 visit_all_identities(irg, visitor, &visit);
620                 irg_walk_anchors(irg, init_lh_walker, build_edges_walker, &w);
621         }
622 }
623
624 void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind)
625 {
626         irg_edge_info_t *info = get_irg_edge_info(irg, kind);
627
628         info->activated = 0;
629         if (info->allocated) {
630                 obstack_free(&info->edges_obst, NULL);
631                 ir_edgeset_destroy(&info->edges);
632                 info->allocated = 0;
633         }
634 }
635
636 int (edges_activated_kind)(const ir_graph *irg, ir_edge_kind_t kind)
637 {
638         return edges_activated_kind_(irg, kind);
639 }
640
641 void edges_reroute_kind(ir_node *from, ir_node *to, ir_edge_kind_t kind)
642 {
643         ir_graph *irg = get_irn_irg(from);
644         set_edge_func_t *set_edge = edge_kind_info[kind].set_edge;
645
646         if (set_edge && edges_activated_kind(irg, kind)) {
647                 struct list_head *head = &get_irn_edge_info(from, kind)->outs_head;
648
649                 DBG((dbg, LEVEL_5, "reroute from %+F to %+F\n", from, to));
650
651                 while (head != head->next) {
652                         ir_edge_t *edge = list_entry(head->next, ir_edge_t, list);
653                         assert(edge->pos >= -1);
654                         set_edge(edge->src, edge->pos, to);
655                 }
656         }
657 }
658
659 static void verify_set_presence(ir_node *irn, void *data)
660 {
661         build_walker *w     = (build_walker*)data;
662         ir_graph     *irg   = get_irn_irg(irn);
663         ir_edgeset_t *edges = &get_irg_edge_info(irg, w->kind)->edges;
664         int i, n;
665
666         foreach_tgt(irn, i, n, w->kind) {
667                 ir_edge_t templ, *e;
668
669                 templ.src = irn;
670                 templ.pos = i;
671
672                 e = ir_edgeset_find(edges, &templ);
673                 if (e != NULL) {
674                         e->present = 1;
675                 } else {
676                         w->problem_found = 1;
677                 }
678         }
679 }
680
681 static void verify_list_presence(ir_node *irn, void *data)
682 {
683         build_walker    *w = (build_walker*)data;
684         const ir_edge_t *e;
685
686         bitset_set(w->reachable, get_irn_idx(irn));
687
688         /* check list heads */
689         verify_list_head(irn, w->kind);
690
691         foreach_out_edge_kind(irn, e, w->kind) {
692                 ir_node *tgt;
693
694                 if (w->kind == EDGE_KIND_NORMAL && get_irn_arity(e->src) <= e->pos) {
695                         w->problem_found = 1;
696                         continue;
697                 }
698
699                 tgt = get_n(e->src, e->pos, w->kind);
700
701                 if (irn != tgt) {
702                         w->problem_found = 1;
703                 }
704         }
705 }
706
707 int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind)
708 {
709         struct build_walker w;
710         ir_edgeset_t        *edges = &get_irg_edge_info(irg, kind)->edges;
711         ir_edge_t           *e;
712         ir_edgeset_iterator_t  iter;
713
714         w.kind          = kind;
715         w.reachable     = bitset_alloca(get_irg_last_idx(irg));
716         w.problem_found = 0;
717
718         /* Clear the present bit in all edges available. */
719         foreach_ir_edgeset(edges, e, iter) {
720                 e->present = 0;
721         }
722
723         irg_walk_graph(irg, verify_set_presence, verify_list_presence, &w);
724
725         /*
726          * Dump all edges which are not invalid and not present.
727          * These edges are superfluous and their presence in the
728          * edge set is wrong.
729          */
730         foreach_ir_edgeset(edges, e, iter) {
731                 if (! e->invalid && ! e->present && bitset_is_set(w.reachable, get_irn_idx(e->src))) {
732                         w.problem_found = 1;
733                         ir_fprintf(stderr, "Edge Verifier: edge(%ld) %+F,%d is superfluous\n", edge_get_id(e), e->src, e->pos);
734                 }
735         }
736
737         return w.problem_found;
738 }
739
740 #define IGNORE_NODE(irn) (is_Bad((irn)) || is_Block((irn)))
741
742 /**
743  * Clear link field of all nodes.
744  */
745 static void clear_links(ir_node *irn, void *env)
746 {
747         bitset_t     *bs;
748         ir_graph     *irg;
749         (void) env;
750
751         if (IGNORE_NODE(irn)) {
752                 set_irn_link(irn, NULL);
753                 return;
754         }
755
756         irg = get_irn_irg(irn);
757         bs  = bitset_malloc(get_irg_last_idx(irg));
758         set_irn_link(irn, bs);
759 }
760
761 /**
762  * Increases count (stored in link field) for all operands of a node.
763  */
764 static void count_user(ir_node *irn, void *env)
765 {
766         int i;
767         int first;
768         (void) env;
769
770         first = is_Block(irn) ? 0 : -1;
771         for (i = get_irn_arity(irn) - 1; i >= first; --i) {
772                 ir_node  *op = get_irn_n(irn, i);
773                 bitset_t *bs = (bitset_t*)get_irn_link(op);
774
775                 if (bs)
776                         bitset_set(bs, get_irn_idx(irn));
777         }
778 }
779
780 /**
781  * Verifies if collected count, number of edges in list and stored edge count are in sync.
782  */
783 static void verify_edge_counter(ir_node *irn, void *env)
784 {
785         build_walker           *w = (build_walker*)env;
786         bitset_t               *bs;
787         int                    list_cnt;
788         int                    ref_cnt;
789         int                    edge_cnt;
790         size_t                 idx;
791         const struct list_head *head;
792         const struct list_head *pos;
793         ir_graph               *irg;
794
795         if (IGNORE_NODE(irn))
796                 return;
797
798         bs       = (bitset_t*)get_irn_link(irn);
799         list_cnt = 0;
800         ref_cnt  = 0;
801         edge_cnt = get_irn_edge_info(irn, EDGE_KIND_NORMAL)->out_count;
802         head     = &get_irn_edge_info(irn, EDGE_KIND_NORMAL)->outs_head;
803
804         /* We can iterate safely here, list heads have already been verified. */
805         list_for_each(pos, head) {
806                 ++list_cnt;
807         }
808
809         /* check all nodes that reference us and count edges that point number
810          * of ins that actually point to us */
811         irg = get_irn_irg(irn);
812         ref_cnt = 0;
813         bitset_foreach(bs, idx) {
814                 int i, arity;
815                 ir_node *src = get_idx_irn(irg, idx);
816
817                 arity = get_irn_arity(src);
818                 for (i = 0; i < arity; ++i) {
819                         ir_node *in = get_irn_n(src, i);
820                         if (in == irn)
821                                 ++ref_cnt;
822                 }
823         }
824
825         if (edge_cnt != list_cnt) {
826                 w->problem_found = 1;
827                 ir_fprintf(stderr, "Edge Verifier: edge count is %d, but %d edge(s) are recorded in list at %+F\n",
828                         edge_cnt, list_cnt, irn);
829         }
830
831         if (ref_cnt != list_cnt) {
832                 w->problem_found = 1;
833                 ir_fprintf(stderr, "Edge Verifier: %+F reachable by %d node(s), but the list contains %d edge(s)\n",
834                         irn, ref_cnt, list_cnt);
835         }
836
837         bitset_free(bs);
838 }
839
840 int edges_verify(ir_graph *irg)
841 {
842         struct build_walker w;
843         int    problem_found = 0;
844
845         /* verify normal edges only */
846         problem_found  = edges_verify_kind(irg, EDGE_KIND_NORMAL);
847
848         w.kind          = EDGE_KIND_NORMAL;
849         w.problem_found = 0;
850
851         /* verify counter */
852         irg_walk_anchors(irg, clear_links, count_user, &w);
853         irg_walk_anchors(irg, NULL, verify_edge_counter, &w);
854
855         return problem_found ? 1 : w.problem_found;
856 }
857
858 typedef struct pass_t {
859         ir_graph_pass_t pass;
860         unsigned        assert_on_problem;
861 } pass_t;
862
863 /**
864  * Wrapper to edges_verify to be run as an ir_graph pass.
865  */
866 static int edges_verify_wrapper(ir_graph *irg, void *context)
867 {
868         pass_t *pass           = (pass_t*)context;
869         int     problems_found = edges_verify(irg);
870         /* do NOT rerun the pass if verify is ok :-) */
871         assert(problems_found && pass->assert_on_problem);
872         return 0;
873 }
874
875 ir_graph_pass_t *irg_verify_edges_pass(const char *name, unsigned assert_on_problem)
876 {
877         pass_t *pass = XMALLOCZ(pass_t);
878
879         def_graph_pass_constructor(
880                 &pass->pass, name ? name : "edges_verify", edges_verify_wrapper);
881
882         /* neither dump nor verify */
883         pass->pass.dump_irg   = (DUMP_ON_IRG_FUNC)ir_prog_no_dump;
884         pass->pass.verify_irg = (RUN_ON_IRG_FUNC)ir_prog_no_verify;
885
886         pass->assert_on_problem = assert_on_problem;
887         return &pass->pass;
888 }
889
890 void init_edges(void)
891 {
892         FIRM_DBG_REGISTER(dbg, DBG_EDGES);
893 }
894
895 void edges_init_dbg(int do_dbg)
896 {
897         edges_dbg = do_dbg;
898 }
899
900 void edges_activate(ir_graph *irg)
901 {
902         edges_activate_kind(irg, EDGE_KIND_NORMAL);
903         edges_activate_kind(irg, EDGE_KIND_BLOCK);
904         if (get_irg_phase_state(irg) == phase_backend)
905                 edges_activate_kind(irg, EDGE_KIND_DEP);
906 }
907
908 void edges_deactivate(ir_graph *irg)
909 {
910         if (get_irg_phase_state(irg) == phase_backend)
911                 edges_deactivate_kind(irg, EDGE_KIND_DEP);
912         edges_deactivate_kind(irg, EDGE_KIND_BLOCK);
913         edges_deactivate_kind(irg, EDGE_KIND_NORMAL);
914 }
915
916 int edges_assure(ir_graph *irg)
917 {
918         int activated = 0;
919
920         if (edges_activated_kind(irg, EDGE_KIND_BLOCK)) {
921                 activated = 1;
922         } else {
923                 edges_activate_kind(irg, EDGE_KIND_BLOCK);
924         }
925         if (edges_activated_kind(irg, EDGE_KIND_NORMAL)) {
926                 activated = 1;
927         } else {
928                 edges_activate_kind(irg, EDGE_KIND_NORMAL);
929         }
930
931         return activated;
932 }
933
934 int edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind)
935 {
936         int activated = edges_activated_kind(irg, kind);
937
938         if (!activated)
939                 edges_activate_kind(irg, kind);
940
941         return activated;
942 }
943
944 void edges_node_deleted(ir_node *irn)
945 {
946         edges_node_deleted_kind(irn, EDGE_KIND_NORMAL);
947         edges_node_deleted_kind(irn, EDGE_KIND_BLOCK);
948 }
949
950 void edges_node_revival(ir_node *irn)
951 {
952         edges_node_revival_kind(irn, EDGE_KIND_NORMAL);
953         edges_node_revival_kind(irn, EDGE_KIND_BLOCK);
954 }
955
956 const ir_edge_t *(get_irn_out_edge_first_kind)(const ir_node *irn, ir_edge_kind_t kind)
957 {
958         return get_irn_out_edge_first_kind_(irn, kind);
959 }
960
961 const ir_edge_t *(get_irn_out_edge_next)(const ir_node *irn, const ir_edge_t *last)
962 {
963         return get_irn_out_edge_next_(irn, last);
964 }
965
966 ir_node *(get_edge_src_irn)(const ir_edge_t *edge)
967 {
968         return get_edge_src_irn_(edge);
969 }
970
971 int (get_edge_src_pos)(const ir_edge_t *edge)
972 {
973         return get_edge_src_pos_(edge);
974 }
975
976 int (get_irn_n_edges_kind)(const ir_node *irn, ir_edge_kind_t kind)
977 {
978         return get_irn_n_edges_kind_(irn, kind);
979 }
980
981 static void irg_walk_edges2(ir_node *node, irg_walk_func *pre,
982                             irg_walk_func *post, void *env)
983 {
984         const ir_edge_t *edge, *next;
985
986         if (irn_visited_else_mark(node))
987                 return;
988
989         if (pre != NULL)
990                 pre(node, env);
991
992         foreach_out_edge_kind_safe(node, edge, next, EDGE_KIND_NORMAL) {
993                 /* find the corresponding successor block. */
994                 ir_node *pred = get_edge_src_irn(edge);
995                 irg_walk_edges2(pred, pre, post, env);
996         }
997
998         if (post != NULL)
999                 post(node, env);
1000 }
1001
1002 void irg_walk_edges(ir_node *node, irg_walk_func *pre, irg_walk_func *post,
1003                     void *env)
1004 {
1005         ir_graph *irg = get_irn_irg(node);
1006
1007         assert(edges_activated(irg));
1008         assert(is_Block(node));
1009
1010         ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
1011
1012         inc_irg_visited(irg);
1013         irg_walk_edges2(node, pre, post, env);
1014
1015         ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
1016 }
1017
1018 static void irg_block_edges_walk2(ir_node *bl, irg_walk_func *pre,
1019                                   irg_walk_func *post, void *env)
1020 {
1021         const ir_edge_t *edge, *next;
1022
1023         if (!Block_block_visited(bl)) {
1024                 mark_Block_block_visited(bl);
1025
1026                 if (pre)
1027                         pre(bl, env);
1028
1029                 foreach_out_edge_kind_safe(bl, edge, next, EDGE_KIND_BLOCK) {
1030                         /* find the corresponding successor block. */
1031                         ir_node *pred = get_edge_src_irn(edge);
1032                         irg_block_edges_walk2(pred, pre, post, env);
1033                 }
1034
1035                 if (post)
1036                         post(bl, env);
1037         }
1038 }
1039
1040 void irg_block_edges_walk(ir_node *node, irg_walk_func *pre,
1041                           irg_walk_func *post, void *env)
1042 {
1043         ir_graph *irg = get_irn_irg(node);
1044
1045         assert(edges_activated(irg));
1046         assert(is_Block(node));
1047
1048         ir_reserve_resources(irg, IR_RESOURCE_BLOCK_VISITED);
1049
1050         inc_irg_block_visited(irg);
1051         irg_block_edges_walk2(node, pre, post, env);
1052
1053         ir_free_resources(irg, IR_RESOURCE_BLOCK_VISITED);
1054 }