2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * File name: ir/ir/iredges.c
23 * Purpose: Always available outs.
24 * Author: Sebastian Hack
25 * Modified by: Michael Beck, Andreas Schoesser
28 * Copyright: (c) 1998-2006 Universität Karlsruhe
32 * Always available outs.
33 * @author Sebastian Hack
43 #include "iredgekinds.h"
44 #include "iredges_t.h"
55 * A function that allows for setting an edge.
56 * This abstraction is necessary since different edge kind have
57 * different methods of setting edges.
59 typedef void (set_edge_func_t)(ir_node *src, int pos, ir_node *tgt);
61 typedef int (get_edge_src_arity_func_t)(const ir_node *src);
63 typedef int (get_edge_src_first_func_t)(const ir_node *src);
65 typedef ir_node *(get_edge_src_n_func_t)(const ir_node *src, int pos);
68 * Additional data for an edge kind.
72 set_edge_func_t *set_edge;
73 get_edge_src_first_func_t *get_first;
74 get_edge_src_arity_func_t *get_arity;
75 get_edge_src_n_func_t *get_n;
76 } ir_edge_kind_info_t;
78 static int get_zero(const ir_node *irn)
83 static int get_irn_first(const ir_node *irn)
85 return 0 - !is_Block(irn);
88 static ir_node *get_block_n(const ir_node *irn, int pos)
90 return is_Block(irn) ? get_Block_cfgpred_block((ir_node *) irn, pos) : 0;
93 static const ir_edge_kind_info_t edge_kind_info[EDGE_KIND_LAST] = {
94 { "normal" , set_irn_n, get_irn_first, get_irn_arity, get_irn_n },
95 { "block succs", NULL, get_zero, get_irn_arity, get_block_n },
96 { "dependency", set_irn_dep, get_zero, get_irn_deps, get_irn_dep }
99 #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)
100 #define get_n(irn, pos, kind) (edge_kind_info[kind].get_n(irn, pos))
101 #define get_kind_str(kind) (edge_kind_info[kind].name)
103 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
106 * This flag is set to 1, if the edges get initialized for an irg.
107 * Then register additional data is forbidden.
109 static int edges_used = 0;
112 * Summed size of all users private data
115 static int edges_private_size = 0;
116 #define EDGE_SIZE (sizeof(ir_edge_t) + edges_private_size)
119 * If set to 1, the list heads are checked every time an edge is changed.
121 static int edges_dbg = 0;
124 /* a static variable holding the last number assigned to a new edge */
125 static long last_edge_num = -1;
128 static INLINE long edge_get_id(const ir_edge_t *e) {
131 #else /* DEBUG_libfirm */
133 #endif /* DEBUG_libfirm */
137 * Announce to reserve extra space for each edge to be allocated.
138 * @Param n: Size of the space to reserve
139 * @ Returns: Offset at which the private data will begin
140 * Several users can reserve extra space for private usage.
141 * Each user has to remember his given offset and the size of his private data.
142 * To be called before FIRM is initialized.
144 int edges_register_private_data(size_t n)
146 int res = edges_private_size;
148 assert(!edges_used && "you cannot register private edge data, if edges have been initialized");
150 edges_private_size += n;
155 * Reset the user's private data at offset 'offset'
156 * The user has to remember his offset and the size of his data!
157 * Caution: Using wrong values here can destroy other users private data!
160 void edges_reset_private_data(ir_graph *irg, int offset, size_t size)
162 irg_edge_info_t *info = _get_irg_edge_info(irg, EDGE_KIND_NORMAL);
165 foreach_set(info->edges, edge)
167 memset(edge + sizeof(*edge) + offset, 0, size);
171 #define TIMES37(x) (((x) << 5) + ((x) << 2) + (x))
173 #define get_irn_out_list_head(irn) (&get_irn_out_info(irn)->outs)
175 static int edge_cmp(const void *p1, const void *p2, size_t len)
177 const ir_edge_t *e1 = p1;
178 const ir_edge_t *e2 = p2;
180 if(e1->src != e2->src)
182 if(e1->pos != e1->pos)
188 #define edge_hash(edge) (TIMES37((edge)->pos) + HASH_PTR((edge)->src))
191 * Initialize the out information for a graph.
192 * @note Dead node elimination can call this on an already initialized graph.
194 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind)
196 if(edges_activated_kind(irg, kind)) {
197 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
202 amount = set_count(info->edges);
203 del_set(info->edges);
205 info->edges = new_set(edge_cmp, amount);
210 * Get the edge object of an outgoing edge at a node.
211 * @param irg The graph, the node is in.
212 * @param src The node at which the edge originates.
213 * @param pos The position of the edge.
214 * @return The corresponding edge object or NULL,
215 * if no such edge exists.
217 const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *src, int pos, ir_edge_kind_t kind)
219 if (edges_activated_kind(irg, kind)) {
220 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
223 key.src = (ir_node *)src;
225 return set_find(info->edges, &key, EDGE_SIZE, edge_hash(&key));
232 * Get the edge object of an outgoing edge at a node.
233 * Looks for an edge for all kinds.
236 const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos)
238 const ir_edge_t *edge;
239 if((edge = get_irn_edge_kind(irg, src, pos, EDGE_KIND_NORMAL)) == NULL)
240 edge = get_irn_edge_kind(irg, src, pos, EDGE_KIND_BLOCK);
245 * Change the out count
247 static INLINE void edge_change_cnt(ir_node *tgt, ir_edge_kind_t kind, int ofs) {
248 irn_edge_info_t *info = _get_irn_edge_info(tgt, kind);
249 info->out_count += ofs;
253 * Verify the edge list of a node, ie. ensure it's a loop:
254 * head -> e_1 -> ... -> e_n -> head
256 static INLINE void vrfy_list_head(ir_node *irn, ir_edge_kind_t kind) {
259 pset *lh_set = pset_new_ptr(16);
260 const struct list_head *head = _get_irn_outs_head(irn, kind);
261 const struct list_head *pos;
263 list_for_each(pos, head) {
264 if (pset_find_ptr(lh_set, pos)) {
265 const ir_edge_t *edge = list_entry(pos, ir_edge_t, list);
267 ir_fprintf(stderr, "EDGE Verifier: edge list broken (self loop not to head) for %+F:\n", irn);
268 fprintf(stderr, "- at list entry %d\n", num);
270 fprintf(stderr, "- edge(%ld) is invalid\n", edge_get_id(edge));
272 ir_fprintf(stderr, "- edge(%ld) %+F(%d)\n", edge_get_id(edge), edge->src, edge->pos);
277 pset_insert_ptr(lh_set, pos);
285 /* The edge from (src, pos) -> old_tgt is redirected to tgt */
286 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt,
287 ir_node *old_tgt, ir_edge_kind_t kind,
290 const char *msg = "";
291 irg_edge_info_t *info;
296 assert(edges_activated_kind(irg, kind));
299 * Only do something, if the old and new target differ.
304 info = _get_irg_edge_info(irg, kind);
306 templ = alloca(EDGE_SIZE);
308 /* Initialize the edge template to search in the set. */
309 memset(templ, 0, EDGE_SIZE);
315 DEBUG_ONLY(templ->src_nr = get_irn_node_nr(src));
318 * If the target is NULL, the edge shall be deleted.
321 /* search the edge in the set. */
322 edge = set_find(edges, templ, EDGE_SIZE, edge_hash(templ));
324 /* mark the edge invalid if it was found */
327 list_del(&edge->list);
333 #endif /* DEBUG_libfirm */
334 edge_change_cnt(old_tgt, kind, -1);
337 /* If the edge was not found issue a warning on the debug stream */
339 msg = "edge to delete not found!\n";
344 * The target is not NULL and the old target differs
345 * from the new target, the edge shall be moved (if the
346 * old target was != NULL) or added (if the old target was
350 struct list_head *head = _get_irn_outs_head(tgt, kind);
352 assert(head->next && head->prev &&
353 "target list head must have been initialized");
355 /* If the old target is not null, the edge is moved. */
357 edge = set_find(edges, templ, EDGE_SIZE, edge_hash(templ));
358 assert(edge && "edge to redirect not found!");
359 assert(! edge->invalid && "Invalid edge encountered");
363 list_move(&edge->list, head);
364 edge_change_cnt(old_tgt, kind, -1);
367 /* The old target was null, thus, the edge is newly created. */
369 edge = set_insert(edges, templ, EDGE_SIZE, edge_hash(templ));
371 assert(! edge->invalid && "Freshly inserted edge is invalid?!?");
372 assert(edge->list.next == NULL && edge->list.prev == NULL &&
373 "New edge must not have list head initialized");
376 list_add(&edge->list, head);
378 edge->edge_nr = ++last_edge_num;
379 #endif /* DEBUG_libfirm */
382 edge_change_cnt(tgt, kind, +1);
385 #ifndef DEBUG_libfirm
386 /* verify list heads */
389 vrfy_list_head(tgt, kind);
391 vrfy_list_head(old_tgt, kind);
395 DBG((dbg, LEVEL_5, "announce out edge: %+F %d-> %+F(%+F): %s\n", src, pos, tgt, old_tgt, msg));
398 void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_graph *irg)
400 if(edges_activated_kind(irg, EDGE_KIND_NORMAL)) {
401 edges_notify_edge_kind(src, pos, tgt, old_tgt, EDGE_KIND_NORMAL, irg);
404 if (edges_activated_kind(irg, EDGE_KIND_BLOCK) && is_Block(src)) {
405 /* do not use get_nodes_block() here, it fails when running unpinned */
406 ir_node *bl_old = old_tgt ? get_irn_n(skip_Proj(old_tgt), -1) : NULL;
407 ir_node *bl_tgt = NULL;
410 bl_tgt = is_Bad(tgt) ? tgt : get_irn_n(skip_Proj(tgt), -1);
412 edges_notify_edge_kind(src, pos, bl_tgt, bl_old, EDGE_KIND_BLOCK, irg);
417 void edges_node_deleted_kind(ir_node *old, ir_edge_kind_t kind, ir_graph *irg)
421 if(!edges_activated_kind(irg, kind))
424 DBG((dbg, LEVEL_5, "node deleted (kind: %s): %+F\n", get_kind_str(kind), old));
426 foreach_tgt(old, i, n, kind) {
427 ir_node *old_tgt = get_n(old, i, kind);
428 edges_notify_edge_kind(old, i, NULL, old_tgt, kind, irg);
432 struct build_walker {
436 unsigned problem_found;
440 * Post-Walker: notify all edges
442 static void build_edges_walker(ir_node *irn, void *data) {
443 struct build_walker *w = data;
446 if (! edges_activated_kind(w->irg, w->kind))
449 foreach_tgt(irn, i, n, w->kind)
450 edges_notify_edge_kind(irn, i, get_n(irn, i, w->kind), NULL, w->kind, w->irg);
454 * Pre-Walker: initializes the list-heads and set the out-count
457 static void init_lh_walker(ir_node *irn, void *data) {
458 struct build_walker *w = data;
459 INIT_LIST_HEAD(_get_irn_outs_head(irn, w->kind));
460 _get_irn_edge_info(irn, w->kind)->out_count = 0;
464 * Visitor: initializes the list-heads and set the out-count
465 * of all nodes to 0 of nodes that are not seen so far.
467 static void visitor(ir_node *irn, void *data) {
468 if (irn_not_visited(irn)) {
469 mark_irn_visited(irn);
470 init_lh_walker(irn, data);
475 * Build the initial edge set.
476 * Beware, this is not a simple task because it suffers from two
478 * - the anchor set allows access to Nodes that may not be reachable from
480 * - the identities add nodes to the "root set" that are not yet reachable
481 * from End. However, after some transformations, the CSE may revival these
484 * These problems can be fixed using different strategies:
485 * - Add an age flag to every node. Whenever the edge of a node is older
486 * then the current edge, invalidate the edges of this node.
487 * While this would help for revivaled nodes, it increases memory and runtime.
488 * - Delete the identities set.
489 * Solves the revival problem, but may increase the memory consumption, as
490 * nodes cannot be revivaled at all.
491 * - Manually iterate over the identities root set. This did not consume more memory
492 * but increase the computation time because the |identities| >= |V|
494 * Currently, we use the last option.
496 void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind)
498 struct build_walker w;
499 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
505 edges_init_graph_kind(irg, kind);
506 //irg_walk_graph(irg, init_lh_walker, build_edges_walker, &w);
507 inc_irg_visited(irg);
508 irg_walk_anchors(irg, init_lh_walker, build_edges_walker, &w);
509 visit_all_identities(irg, visitor, &w);
512 void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind)
514 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
518 del_set(info->edges);
523 int (edges_activated_kind)(const ir_graph *irg, ir_edge_kind_t kind)
525 return _edges_activated_kind(irg, kind);
530 * Reroute all use-edges from a node to another.
531 * @param from The node whose use-edges shall be withdrawn.
532 * @param to The node to which all the use-edges of @p from shall be
534 * @param irg The graph.
536 void edges_reroute_kind(ir_node *from, ir_node *to, ir_edge_kind_t kind, ir_graph *irg)
538 set_edge_func_t *set_edge = edge_kind_info[kind].set_edge;
540 if(set_edge && edges_activated_kind(irg, kind)) {
541 struct list_head *head = _get_irn_outs_head(from, kind);
543 DBG((dbg, LEVEL_5, "reroute from %+F to %+F\n", from, to));
545 while(head != head->next) {
546 ir_edge_t *edge = list_entry(head->next, ir_edge_t, list);
547 assert(edge->pos >= -1);
548 set_edge(edge->src, edge->pos, to);
553 static void verify_set_presence(ir_node *irn, void *data)
555 struct build_walker *w = data;
556 set *edges = _get_irg_edge_info(w->irg, w->kind)->edges;
559 foreach_tgt(irn, i, n, w->kind) {
565 e = set_find(edges, &templ, EDGE_SIZE, edge_hash(&templ));
569 w->problem_found = 1;
570 ir_fprintf(stderr, "Edge Verifier: edge %+F,%d -> %+F (kind: \"%s\") is missing\n",
571 irn, i, get_n(irn, i, w->kind), get_kind_str(w->kind));
576 static void verify_list_presence(ir_node *irn, void *data)
578 struct build_walker *w = data;
581 bitset_set(w->reachable, get_irn_idx(irn));
583 /* check list heads */
584 vrfy_list_head(irn, w->kind);
586 foreach_out_edge_kind(irn, e, w->kind) {
589 if (w->kind == EDGE_KIND_NORMAL && get_irn_arity(e->src) <= e->pos) {
590 w->problem_found = 1;
591 ir_fprintf(stderr, "Edge Verifier: edge(%ld) %+F -> %+F recorded at src position %d, but src has arity %d\n",
592 edge_get_id(e), e->src, irn, e->pos, get_irn_arity(e->src));
596 tgt = get_n(e->src, e->pos, w->kind);
599 w->problem_found = 1;
600 ir_fprintf(stderr, "Edge Verifier: edge(%ld) %+F,%d (kind \"%s\") is no out edge of %+F but of %+F\n",
601 edge_get_id(e), e->src, e->pos, get_kind_str(w->kind), irn, tgt);
606 int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind)
608 struct build_walker w;
609 set *edges = _get_irg_edge_info(irg, kind)->edges;
614 w.reachable = bitset_alloca(get_irg_last_idx(irg));
617 /* Clear the present bit in all edges available. */
618 for (e = set_first(edges); e; e = set_next(edges))
621 irg_walk_graph(irg, verify_set_presence, verify_list_presence, &w);
624 * Dump all edges which are not invalid and not present.
625 * These edges are superfluous and their presence in the
628 for (e = set_first(edges); e; e = set_next(edges)) {
629 if (! e->invalid && ! e->present && bitset_is_set(w.reachable, get_irn_idx(e->src))) {
631 ir_fprintf(stderr, "Edge Verifier: edge(%ld) %+F,%d is superfluous\n", edge_get_id(e), e->src, e->pos);
635 return w.problem_found;
638 #define IGNORE_NODE(irn) (is_Bad((irn)) || is_Block((irn)))
641 * Clear link field of all nodes.
643 static void clear_links(ir_node *irn, void *env) {
644 struct build_walker *w = env;
647 if (IGNORE_NODE(irn)) {
648 set_irn_link(irn, NULL);
652 bs = bitset_malloc(get_irg_last_idx(w->irg));
653 set_irn_link(irn, bs);
657 * Increases count (stored in link field) for all operands of a node.
659 static void count_user(ir_node *irn, void *env) {
663 first = get_irn_first(irn);
664 for (i = get_irn_arity(irn) - 1; i >= first; --i) {
665 ir_node *op = get_irn_n(irn, i);
666 bitset_t *bs = get_irn_link(op);
669 bitset_set(bs, get_irn_idx(irn));
674 * Verifies if collected count, number of edges in list and stored edge count are in sync.
676 static void verify_edge_counter(ir_node *irn, void *env) {
677 struct build_walker *w = env;
683 const struct list_head *head;
684 const struct list_head *pos;
686 if (IGNORE_NODE(irn))
689 bs = get_irn_link(irn);
692 edge_cnt = _get_irn_edge_info(irn, EDGE_KIND_NORMAL)->out_count;
693 head = _get_irn_outs_head(irn, EDGE_KIND_NORMAL);
695 /* We can iterate safely here, list heads have already been verified. */
696 list_for_each(pos, head) {
700 /* check all nodes that reference us and count edges that point number
701 * of ins that actually point to us */
703 bitset_foreach(bs, idx) {
705 ir_node *src = get_idx_irn(w->irg, idx);
707 arity = get_irn_arity(src);
708 for(i = 0; i < arity; ++i) {
709 ir_node *in = get_irn_n(src, i);
715 if (edge_cnt != list_cnt) {
716 w->problem_found = 1;
717 ir_fprintf(stderr, "Edge Verifier: edge count is %d, but %d edge(s) are recorded in list at %+F\n",
718 edge_cnt, list_cnt, irn);
721 if (ref_cnt != list_cnt) {
722 w->problem_found = 1;
723 ir_fprintf(stderr, "Edge Verifier: %+F reachable by %d node(s), but the list contains %d edge(s)\n",
724 irn, ref_cnt, list_cnt);
726 // Matze: buggy if a node has multiple ins pointing at irn
728 list_for_each(pos, head) {
729 ir_edge_t *edge = list_entry(pos, ir_edge_t, list);
730 bitset_flip(bs, get_irn_idx(edge->src));
733 if (ref_cnt < list_cnt)
734 fprintf(stderr," following nodes are recorded in list, but not as user:\n");
736 fprintf(stderr," following nodes are user, but not recorded in list:\n");
739 bitset_foreach(bs, idx) {
740 ir_node *src = get_idx_irn(w->irg, idx);
741 ir_fprintf(stderr, " %+F", src);
743 fprintf(stderr, "\n");
751 * Verifies the out edges of an irg.
753 int edges_verify(ir_graph *irg) {
754 struct build_walker w;
755 int problem_found = 0;
757 /* verify normal edges only */
758 problem_found = edges_verify_kind(irg, EDGE_KIND_NORMAL);
761 w.kind = EDGE_KIND_NORMAL;
765 inc_irg_visited(irg);
766 irg_walk_anchors(irg, clear_links, count_user, &w);
767 inc_irg_visited(irg);
768 irg_walk_anchors(irg, NULL, verify_edge_counter, &w);
770 return problem_found ? 1 : w.problem_found;
773 void init_edges(void)
775 FIRM_DBG_REGISTER(dbg, DBG_EDGES);
776 /* firm_dbg_set_mask(dbg, -1); */
779 void edges_init_dbg(int do_dbg) {
783 void edges_activate(ir_graph *irg)
785 edges_activate_kind(irg, EDGE_KIND_NORMAL);
786 edges_activate_kind(irg, EDGE_KIND_BLOCK);
789 void edges_deactivate(ir_graph *irg)
791 edges_deactivate_kind(irg, EDGE_KIND_NORMAL);
792 edges_deactivate_kind(irg, EDGE_KIND_BLOCK);
795 int edges_assure(ir_graph *irg)
797 int activated = edges_activated(irg);
805 void edges_node_deleted(ir_node *irn, ir_graph *irg)
807 edges_node_deleted_kind(irn, EDGE_KIND_NORMAL, irg);
808 edges_node_deleted_kind(irn, EDGE_KIND_BLOCK, irg);
812 const ir_edge_t *(get_irn_out_edge_first_kind)(const ir_node *irn, ir_edge_kind_t kind)
814 return _get_irn_out_edge_first_kind(irn, kind);
817 const ir_edge_t *(get_irn_out_edge_next)(const ir_node *irn, const ir_edge_t *last)
819 return _get_irn_out_edge_next(irn, last);
822 ir_node *(get_edge_src_irn)(const ir_edge_t *edge)
824 return _get_edge_src_irn(edge);
827 int (get_edge_src_pos)(const ir_edge_t *edge)
829 return _get_edge_src_pos(edge);
832 int (get_irn_n_edges_kind)(const ir_node *irn, ir_edge_kind_t kind)
834 return _get_irn_n_edges_kind(irn, kind);
837 void dump_all_out_edges(ir_node *irn)
840 for(i = 0; i < EDGE_KIND_LAST; ++i) {
841 const ir_edge_t *edge;
843 printf("kind \"%s\"\n", get_kind_str(i));
844 foreach_out_edge_kind(irn, edge, i) {
845 ir_printf("\t%+F(%d)\n", edge->src, edge->pos);