3 * File name: ir/ir/iredges.c
4 * Purpose: Always available outs.
5 * Author: Sebastian Hack
6 * Modified by: Michael Beck, Andreas Schoesser
9 * Copyright: (c) 1998-2006 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
14 * Always available outs.
15 * @author Sebastian Hack
32 #include "iredgekinds.h"
33 #include "iredges_t.h"
43 * A function that allows for setting an edge.
44 * This abstraction is necessary since different edge kind have
45 * different methods of setting edges.
47 typedef void (set_edge_func_t)(ir_node *src, int pos, ir_node *tgt);
49 typedef int (get_edge_src_arity_func_t)(const ir_node *src);
51 typedef int (get_edge_src_first_func_t)(const ir_node *src);
53 typedef ir_node *(get_edge_src_n_func_t)(const ir_node *src, int pos);
56 * Additional data for an edge kind.
60 set_edge_func_t *set_edge;
61 get_edge_src_first_func_t *get_first;
62 get_edge_src_arity_func_t *get_arity;
63 get_edge_src_n_func_t *get_n;
64 } ir_edge_kind_info_t;
66 static int get_zero(const ir_node *irn)
71 static int get_irn_first(const ir_node *irn)
73 return 0 - !is_Block(irn);
76 static ir_node *get_block_n(const ir_node *irn, int pos)
78 return is_Block(irn) ? get_Block_cfgpred_block((ir_node *) irn, pos) : 0;
81 static const ir_edge_kind_info_t edge_kind_info[EDGE_KIND_LAST] = {
82 { "normal" , set_irn_n, get_irn_first, get_irn_arity, get_irn_n },
83 { "block succs", NULL, get_zero, get_irn_arity, get_block_n },
84 { "dependency", set_irn_dep, get_zero, get_irn_deps, get_irn_dep }
87 #define foreach_tgt(irn, i, n, kind) for(i = edge_kind_info[kind].get_first(irn), n = edge_kind_info[kind].get_arity(irn); i < n; ++i)
88 #define get_n(irn, pos, kind) (edge_kind_info[kind].get_n(irn, pos))
89 #define get_kind_str(kind) (edge_kind_info[kind].name)
91 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
94 * This flag is set to 1, if the edges get initialized for an irg.
95 * Then register additional data is forbidden.
97 static int edges_used = 0;
100 * Summed size of all users private data
103 static int edges_private_size = 0;
104 #define EDGE_SIZE (sizeof(ir_edge_t) + edges_private_size)
107 * If set to 1, the list heads are checked every time an edge is changed.
109 static int edges_dbg = 0;
111 /* a static variable holding the last number assigned to a new edge */
112 static long last_edge_num = -1;
114 static INLINE long edge_get_id(const ir_edge_t *e) {
117 #else /* DEBUG_libfirm */
119 #endif /* DEBUG_libfirm */
123 * Announce to reserve extra space for each edge to be allocated.
124 * @Param n: Size of the space to reserve
125 * @ Returns: Offset at which the private data will begin
126 * Several users can reserve extra space for private usage.
127 * Each user has to remember his given offset and the size of his private data.
128 * To be called before FIRM is initialized.
130 int edges_register_private_data(size_t n)
132 int res = edges_private_size;
134 assert(!edges_used && "you cannot register private edge data, if edges have been initialized");
136 edges_private_size += n;
141 * Reset the user's private data at offset 'offset'
142 * The user has to remember his offset and the size of his data!
143 * Caution: Using wrong values here can destroy other users private data!
146 void edges_reset_private_data(ir_graph *irg, int offset, size_t size)
148 irg_edge_info_t *info = _get_irg_edge_info(irg, EDGE_KIND_NORMAL);
151 foreach_set(info->edges, edge)
153 memset(edge + sizeof(*edge) + offset, 0, size);
157 #define TIMES37(x) (((x) << 5) + ((x) << 2) + (x))
159 #define get_irn_out_list_head(irn) (&get_irn_out_info(irn)->outs)
161 static int edge_cmp(const void *p1, const void *p2, size_t len)
163 const ir_edge_t *e1 = p1;
164 const ir_edge_t *e2 = p2;
165 int res = e1->src == e2->src && e1->pos == e2->pos;
170 #define edge_hash(edge) (TIMES37((edge)->pos) + HASH_PTR((edge)->src))
173 * Initialize the out information for a graph.
174 * @note Dead node elimination can call this on an already initialized graph.
176 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind)
178 if(edges_activated_kind(irg, kind)) {
179 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
184 amount = set_count(info->edges);
185 del_set(info->edges);
187 info->edges = new_set(edge_cmp, amount);
192 * Get the edge object of an outgoing edge at a node.
193 * @param irg The graph, the node is in.
194 * @param src The node at which the edge originates.
195 * @param pos The position of the edge.
196 * @return The corresponding edge object or NULL,
197 * if no such edge exists.
199 const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *src, int pos, ir_edge_kind_t kind)
201 if (edges_activated_kind(irg, kind)) {
202 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
205 key.src = (ir_node *)src;
207 return set_find(info->edges, &key, EDGE_SIZE, edge_hash(&key));
214 * Get the edge object of an outgoing edge at a node.
215 * Looks for an edge for all kinds.
218 const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos)
220 const ir_edge_t *edge;
221 if((edge = get_irn_edge_kind(irg, src, pos, EDGE_KIND_NORMAL)) == NULL)
222 edge = get_irn_edge_kind(irg, src, pos, EDGE_KIND_BLOCK);
227 * Change the out count
229 static INLINE void edge_change_cnt(ir_node *tgt, ir_edge_kind_t kind, int ofs) {
230 irn_edge_info_t *info = _get_irn_edge_info(tgt, kind);
231 info->out_count += ofs;
235 * Verify the edge list of a node, ie. ensure it's a loop:
236 * head -> e_1 -> ... -> e_n -> head
238 static INLINE void vrfy_list_head(ir_node *irn, ir_edge_kind_t kind) {
241 pset *lh_set = pset_new_ptr(16);
242 const struct list_head *head = _get_irn_outs_head(irn, kind);
243 const struct list_head *pos;
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);
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);
252 fprintf(stderr, "- edge(%ld) is invalid\n", edge_get_id(edge));
254 ir_fprintf(stderr, "- edge(%ld) %+F(%d)\n", edge_get_id(edge), edge->src, edge->pos);
259 pset_insert_ptr(lh_set, pos);
267 /* The edge from (src, pos) -> old_tgt is redirected to tgt */
268 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_edge_kind_t kind, ir_graph *irg)
270 const char *msg = "";
272 assert(edges_activated_kind(irg, kind));
275 * Only do something, if the old and new target differ.
278 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
279 set *edges = info->edges;
280 ir_edge_t *templ = alloca(EDGE_SIZE);
283 /* Initialize the edge template to search in the set. */
284 memset(templ, 0, EDGE_SIZE);
290 DEBUG_ONLY(templ->src_nr = get_irn_node_nr(src));
293 * If the target is NULL, the edge shall be deleted.
296 /* search the edge in the set. */
297 edge = set_find(edges, templ, EDGE_SIZE, edge_hash(templ));
299 /* mark the edge invalid if it was found */
302 list_del(&edge->list);
308 #endif /* DEBUG_libfirm */
309 edge_change_cnt(old_tgt, kind, -1);
312 /* If the edge was not found issue a warning on the debug stream */
314 msg = "edge to delete not found!\n";
319 * The target is not NULL and the old target differs
320 * from the new target, the edge shall be moved (if the
321 * old target was != NULL) or added (if the old target was
325 struct list_head *head = _get_irn_outs_head(tgt, kind);
327 assert(head->next && head->prev &&
328 "target list head must have been initialized");
330 /* If the old target is not null, the edge is moved. */
332 edge = set_find(edges, templ, EDGE_SIZE, edge_hash(templ));
333 assert(edge && "edge to redirect not found!");
334 assert(! edge->invalid && "Invalid edge encountered");
338 list_move(&edge->list, head);
339 edge_change_cnt(old_tgt, kind, -1);
342 /* The old target was null, thus, the edge is newly created. */
344 edge = set_insert(edges, templ, EDGE_SIZE, edge_hash(templ));
346 assert(! edge->invalid && "Freshly inserted edge is invalid?!?");
347 assert(edge->list.next == NULL && edge->list.prev == NULL &&
348 "New edge must not have list head initialized");
351 list_add(&edge->list, head);
353 edge->edge_nr = ++last_edge_num;
354 #endif /* DEBUG_libfirm */
357 edge_change_cnt(tgt, kind, +1);
360 /* verify list heads */
363 vrfy_list_head(tgt, kind);
365 vrfy_list_head(old_tgt, kind);
369 /* If the target and the old target are equal, nothing is done. */
370 DBG((dbg, LEVEL_5, "announce out edge: %+F %d-> %+F(%+F): %s\n", src, pos, tgt, old_tgt, msg));
373 void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_graph *irg)
375 if(edges_activated_kind(irg, EDGE_KIND_NORMAL)) {
376 edges_notify_edge_kind(src, pos, tgt, old_tgt, EDGE_KIND_NORMAL, irg);
379 if (edges_activated_kind(irg, EDGE_KIND_BLOCK) && is_Block(src)) {
380 /* do not use get_nodes_block() here, it fails when running unpinned */
381 ir_node *bl_old = old_tgt ? get_irn_n(skip_Proj(old_tgt), -1) : NULL;
382 ir_node *bl_tgt = NULL;
385 bl_tgt = is_Bad(tgt) ? tgt : get_irn_n(skip_Proj(tgt), -1);
387 edges_notify_edge_kind(src, pos, bl_tgt, bl_old, EDGE_KIND_BLOCK, irg);
392 void edges_node_deleted_kind(ir_node *old, ir_edge_kind_t kind, ir_graph *irg)
396 if(!edges_activated_kind(irg, kind))
399 DBG((dbg, LEVEL_5, "node deleted (kind: %s): %+F\n", get_kind_str(kind), old));
401 foreach_tgt(old, i, n, kind) {
402 ir_node *old_tgt = get_n(old, i, kind);
403 edges_notify_edge_kind(old, i, NULL, old_tgt, kind, irg);
407 struct build_walker {
411 unsigned problem_found;
415 * Post-Walker: notify all edges
417 static void build_edges_walker(ir_node *irn, void *data) {
418 struct build_walker *w = data;
421 if (! edges_activated_kind(w->irg, w->kind))
424 foreach_tgt(irn, i, n, w->kind)
425 edges_notify_edge_kind(irn, i, get_n(irn, i, w->kind), NULL, w->kind, w->irg);
429 * Pre-Walker: initializes the list-heads and set the out-count
432 static void init_lh_walker(ir_node *irn, void *data) {
433 struct build_walker *w = data;
434 INIT_LIST_HEAD(_get_irn_outs_head(irn, w->kind));
435 _get_irn_edge_info(irn, w->kind)->out_count = 0;
439 * Visitor: initializes the list-heads and set the out-count
440 * of all nodes to 0 of nodes that are not seen so far.
442 static void visitor(ir_node *irn, void *data) {
443 if (irn_not_visited(irn)) {
444 mark_irn_visited(irn);
445 init_lh_walker(irn, data);
450 * Build the initial edge set.
451 * Beware, this is not a simple task because it suffers from two
453 * - the anchor set allows access to Nodes that may not be reachable from
455 * - the identities add nodes to the "root set" that are not yet reachable
456 * from End. However, after some transformations, the CSE may revival these
459 * These problems can be fixed using different strategies:
460 * - Add an age flag to every node. Whenever the edge of a node is older
461 * then the current edge, invalidate the edges of this node.
462 * While this would help for revivaled nodes, it increases memory and runtime.
463 * - Delete the identities set.
464 * Solves the revival problem, but may increase the memory consumption, as
465 * nodes cannot be revivaled at all.
466 * - Manually iterate over the identities root set. This did not consume more memory
467 * but increase the computation time because the |identities| >= |V|
469 * Currently, we use the last option.
471 void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind)
473 struct build_walker w;
474 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
480 edges_init_graph_kind(irg, kind);
481 //irg_walk_graph(irg, init_lh_walker, build_edges_walker, &w);
482 inc_irg_visited(irg);
483 irg_walk_anchors(irg, init_lh_walker, build_edges_walker, &w);
484 visit_all_identities(irg, visitor, &w);
487 void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind)
489 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
493 del_set(info->edges);
498 int (edges_activated_kind)(const ir_graph *irg, ir_edge_kind_t kind)
500 return _edges_activated_kind(irg, kind);
505 * Reroute all use-edges from a node to another.
506 * @param from The node whose use-edges shall be withdrawn.
507 * @param to The node to which all the use-edges of @p from shall be
509 * @param irg The graph.
511 void edges_reroute_kind(ir_node *from, ir_node *to, ir_edge_kind_t kind, ir_graph *irg)
513 set_edge_func_t *set_edge = edge_kind_info[kind].set_edge;
515 if(set_edge && edges_activated_kind(irg, kind)) {
516 struct list_head *head = _get_irn_outs_head(from, kind);
518 DBG((dbg, LEVEL_5, "reroute from %+F to %+F\n", from, to));
520 while(head != head->next) {
521 ir_edge_t *edge = list_entry(head->next, ir_edge_t, list);
522 assert(edge->pos >= -1);
523 set_edge(edge->src, edge->pos, to);
528 static void verify_set_presence(ir_node *irn, void *data)
530 struct build_walker *w = data;
531 set *edges = _get_irg_edge_info(w->irg, w->kind)->edges;
534 foreach_tgt(irn, i, n, w->kind) {
540 e = set_find(edges, &templ, EDGE_SIZE, edge_hash(&templ));
544 w->problem_found = 1;
545 ir_fprintf(stderr, "Edge Verifier: edge %+F,%d (kind: \"%s\") is missing\n",
546 irn, i, get_kind_str(w->kind));
551 static void verify_list_presence(ir_node *irn, void *data)
553 struct build_walker *w = data;
556 bitset_set(w->reachable, get_irn_idx(irn));
558 /* check list heads */
559 vrfy_list_head(irn, w->kind);
561 foreach_out_edge_kind(irn, e, w->kind) {
564 if (w->kind == EDGE_KIND_NORMAL && get_irn_arity(e->src) <= e->pos) {
565 w->problem_found = 1;
566 ir_fprintf(stderr, "Edge Verifier: edge(%ld) %+F -> %+F recorded at src position %d, but src has arity %d\n",
567 edge_get_id(e), e->src, irn, e->pos, get_irn_arity(e->src));
571 tgt = get_n(e->src, e->pos, w->kind);
574 w->problem_found = 1;
575 ir_fprintf(stderr, "Edge Verifier: edge(%ld) %+F,%d (kind \"%s\") is no out edge of %+F but of %+F\n",
576 edge_get_id(e), e->src, e->pos, get_kind_str(w->kind), irn, tgt);
581 int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind)
583 struct build_walker w;
584 set *edges = _get_irg_edge_info(irg, kind)->edges;
589 w.reachable = bitset_alloca(get_irg_last_idx(irg));
592 /* Clear the present bit in all edges available. */
593 for (e = set_first(edges); e; e = set_next(edges))
596 irg_walk_graph(irg, verify_set_presence, verify_list_presence, &w);
599 * Dump all edges which are not invalid and not present.
600 * These edges are superfluous and their presence in the
603 for (e = set_first(edges); e; e = set_next(edges)) {
604 if (! e->invalid && ! e->present && bitset_is_set(w.reachable, get_irn_idx(e->src))) {
606 ir_fprintf(stderr, "Edge Verifier: edge(%ld) %+F,%d is superfluous\n", edge_get_id(e), e->src, e->pos);
610 return w.problem_found;
613 #define IGNORE_NODE(irn) (is_Bad((irn)) || is_Block((irn)))
616 * Clear link field of all nodes.
618 static void clear_links(ir_node *irn, void *env) {
619 struct build_walker *w = env;
622 set_irn_link(irn, NULL);
624 if (IGNORE_NODE(irn))
627 bs = bitset_malloc(get_irg_last_idx(w->irg));
628 set_irn_link(irn, bs);
632 * Increases count (stored in link field) for all operands of a node.
634 static void count_user(ir_node *irn, void *env) {
638 first = get_irn_first(irn);
639 for (i = get_irn_arity(irn) - 1; i >= first; --i) {
640 ir_node *op = get_irn_n(irn, i);
641 bitset_t *bs = get_irn_link(op);
644 bitset_set(bs, get_irn_idx(irn));
649 * Verifies if collected count, number of edges in list and stored edge count are in sync.
651 static void verify_edge_counter(ir_node *irn, void *env) {
652 struct build_walker *w = env;
657 const struct list_head *head;
658 const struct list_head *pos;
660 if (IGNORE_NODE(irn))
663 bs = get_irn_link(irn);
665 ref_cnt = bitset_popcnt(bs);
666 edge_cnt = _get_irn_edge_info(irn, EDGE_KIND_NORMAL)->out_count;
667 head = _get_irn_outs_head(irn, EDGE_KIND_NORMAL);
669 /* We can iterate safely here, list heads have already been verified. */
670 list_for_each(pos, head) {
671 ir_edge_t *edge = list_entry(pos, ir_edge_t, list);
672 if (! is_Bad(edge->src))
676 if (edge_cnt != list_cnt) {
677 w->problem_found = 1;
678 ir_fprintf(stderr, "Edge Verifier: edge count is %d, but %d edge(s) are recorded in list at %+F\n",
679 edge_cnt, list_cnt, irn);
682 if (ref_cnt != list_cnt) {
685 w->problem_found = 1;
686 ir_fprintf(stderr, "Edge Verifier: %+F reachable by %d node(s), but %d edge(s) recorded in list\n",
687 irn, ref_cnt, list_cnt);
689 list_for_each(pos, head) {
690 ir_edge_t *edge = list_entry(pos, ir_edge_t, list);
691 if (! is_Bad(edge->src))
692 bitset_flip(bs, get_irn_idx(edge->src));
695 if (ref_cnt < list_cnt)
696 fprintf(stderr," following nodes are recorded in list, but not as user:\n");
698 fprintf(stderr," following nodes are user, but not recorded in list:\n");
701 bitset_foreach(bs, idx) {
702 ir_node *src = get_idx_irn(w->irg, idx);
703 ir_fprintf(stderr, " %+F", src);
705 fprintf(stderr, "\n");
712 * Verifies the out edges of an irg.
714 int edges_verify(ir_graph *irg) {
715 struct build_walker w;
716 int problem_found = 0;
721 /* verify normal edges only */
722 problem_found = edges_verify_kind(irg, EDGE_KIND_NORMAL);
725 w.kind = EDGE_KIND_NORMAL;
729 inc_irg_visited(irg);
730 irg_walk_anchors(irg, clear_links, count_user, &w);
731 irg_walk_anchors(irg, NULL, verify_edge_counter, &w);
733 return problem_found ? 1 : w.problem_found;
736 void init_edges(void)
738 FIRM_DBG_REGISTER(dbg, DBG_EDGES);
739 /* firm_dbg_set_mask(dbg, -1); */
742 void edges_init_dbg(int do_dbg) {
746 void edges_activate(ir_graph *irg)
748 edges_activate_kind(irg, EDGE_KIND_NORMAL);
749 edges_activate_kind(irg, EDGE_KIND_BLOCK);
752 void edges_deactivate(ir_graph *irg)
754 edges_deactivate_kind(irg, EDGE_KIND_NORMAL);
755 edges_deactivate_kind(irg, EDGE_KIND_BLOCK);
758 int edges_assure(ir_graph *irg)
760 int activated = edges_activated(irg);
768 void edges_node_deleted(ir_node *irn, ir_graph *irg)
770 edges_node_deleted_kind(irn, EDGE_KIND_NORMAL, irg);
771 edges_node_deleted_kind(irn, EDGE_KIND_BLOCK, irg);
775 const ir_edge_t *(get_irn_out_edge_first_kind)(const ir_node *irn, ir_edge_kind_t kind)
777 return _get_irn_out_edge_first_kind(irn, kind);
780 const ir_edge_t *(get_irn_out_edge_next)(const ir_node *irn, const ir_edge_t *last)
782 return _get_irn_out_edge_next(irn, last);
785 ir_node *(get_edge_src_irn)(const ir_edge_t *edge)
787 return _get_edge_src_irn(edge);
790 int (get_edge_src_pos)(const ir_edge_t *edge)
792 return _get_edge_src_pos(edge);
795 int (get_irn_n_edges_kind)(const ir_node *irn, ir_edge_kind_t kind)
797 return _get_irn_n_edges_kind(irn, kind);
800 void dump_all_out_edges(ir_node *irn)
803 for(i = 0; i < EDGE_KIND_LAST; ++i) {
804 const ir_edge_t *edge;
806 printf("kind \"%s\"\n", get_kind_str(i));
807 foreach_out_edge_kind(irn, edge, i) {
808 ir_printf("\t%+F(%d)\n", edge->src, edge->pos);