3 * File name: ir/ir/iredges.c
4 * Purpose: Always available outs.
5 * Author: Sebastian Hack
6 * Modified by: Michael Beck
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"
42 * A function that allows for setting an edge.
43 * This abstraction is necessary since different edge kind have
44 * different methods of setting edges.
46 typedef void (set_edge_func_t)(ir_node *src, int pos, ir_node *tgt);
48 typedef int (get_edge_src_arity_func_t)(const ir_node *src);
50 typedef int (get_edge_src_first_func_t)(const ir_node *src);
52 typedef ir_node *(get_edge_src_n_func_t)(const ir_node *src, int pos);
55 * Additional data for an edge kind.
59 set_edge_func_t *set_edge;
60 get_edge_src_first_func_t *get_first;
61 get_edge_src_arity_func_t *get_arity;
62 get_edge_src_n_func_t *get_n;
63 } ir_edge_kind_info_t;
65 static int get_zero(const ir_node *irn)
70 static int get_irn_first(const ir_node *irn)
72 return 0 - !is_Block(irn);
75 static ir_node *get_block_n(const ir_node *irn, int pos)
77 return is_Block(irn) ? get_Block_cfgpred_block((ir_node *) irn, pos) : 0;
80 static const ir_edge_kind_info_t edge_kind_info[EDGE_KIND_LAST] = {
81 { "normal" , set_irn_n, get_irn_first, get_irn_arity, get_irn_n },
82 { "block succs", NULL, get_zero, get_irn_arity, get_block_n },
83 { "dependency", set_irn_dep, get_zero, get_irn_deps, get_irn_dep }
86 #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)
87 #define get_n(irn, pos, kind) (edge_kind_info[kind].get_n(irn, pos))
88 #define get_kind_str(kind) (edge_kind_info[kind].name)
90 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
93 * This flag is set to 1, if the edges get initialized for an irg.
94 * Then register additional data is forbidden.
96 static int edges_used = 0;
98 static int edges_private_size = 0;
101 * If set to 1, the list heads are checked every time an edge is changed.
103 static int edges_dbg = 0;
105 int edges_register_private_data(size_t n)
107 int res = edges_private_size;
109 assert(!edges_used && "you cannot register private edge data, if edges have been initialized");
111 edges_private_size += n;
115 #define TIMES37(x) (((x) << 5) + ((x) << 2) + (x))
117 #define get_irn_out_list_head(irn) (&get_irn_out_info(irn)->outs)
119 static int edge_cmp(const void *p1, const void *p2, size_t len)
121 const ir_edge_t *e1 = p1;
122 const ir_edge_t *e2 = p2;
123 int res = e1->src == e2->src && e1->pos == e2->pos;
128 #define edge_hash(edge) (TIMES37((edge)->pos) + HASH_PTR((edge)->src))
131 * Initialize the out information for a graph.
132 * @note Dead node elimination can call this on an already initialized graph.
134 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind)
136 if(edges_activated_kind(irg, kind)) {
137 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
142 amount = set_count(info->edges);
143 del_set(info->edges);
145 info->edges = new_set(edge_cmp, amount);
150 * Get the edge object of an outgoing edge at a node.
151 * @param irg The graph, the node is in.
152 * @param src The node at which the edge originates.
153 * @param pos The position of the edge.
154 * @return The corresponding edge object or NULL,
155 * if no such edge exists.
157 const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *src, int pos, ir_edge_kind_t kind)
159 if (edges_activated_kind(irg, kind)) {
160 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
163 key.src = (ir_node *)src;
166 return set_find(info->edges, &key, sizeof(key), edge_hash(&key));
173 * Change the out count
175 static INLINE void edge_change_cnt(ir_node *tgt, ir_edge_kind_t kind, int ofs) {
176 irn_edge_info_t *info = _get_irn_edge_info(tgt, kind);
177 info->out_count += ofs;
181 * Verify the edge list of a node, ie. ensure it's a loop:
182 * head -> e_1 -> ... -> e_n -> head
184 static INLINE void vrfy_list_head(ir_node *irn, ir_edge_kind_t kind) {
187 pset *lh_set = pset_new_ptr(16);
188 const struct list_head *head = _get_irn_outs_head(irn, kind);
189 const struct list_head *pos;
191 list_for_each(pos, head) {
192 if (pset_find_ptr(lh_set, pos)) {
193 const ir_edge_t *edge = list_entry(pos, ir_edge_t, list);
195 ir_fprintf(stderr, "EDGE Verifier: edge list broken (self loop not to head) for %+F:\n", irn);
196 fprintf(stderr, "- at list entry %d\n", num);
198 fprintf(stderr, "- edge is invalid\n");
200 ir_fprintf(stderr, "- edge %+F(%d)\n", edge->src, edge->pos);
205 pset_insert_ptr(lh_set, pos);
213 /* The edge from (src, pos) -> old_tgt is redirected to tgt */
214 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)
216 const char *msg = "";
218 assert(edges_activated_kind(irg, kind));
221 * Only do something, if the old and new target differ.
223 if (tgt != old_tgt) {
224 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
225 set *edges = info->edges;
226 ir_edge_t *templ = alloca(sizeof(templ[0]));
229 /* Initialize the edge template to search in the set. */
230 memset(templ, 0, sizeof(templ[0]));
236 DEBUG_ONLY(templ->src_nr = get_irn_node_nr(src));
239 * If the target is NULL, the edge shall be deleted.
242 /* search the edge in the set. */
243 edge = set_find(edges, templ, sizeof(templ[0]), edge_hash(templ));
245 /* mark the edge invalid if it was found */
248 list_del(&edge->list);
252 edge_change_cnt(old_tgt, kind, -1);
255 /* If the edge was not found issue a warning on the debug stream */
257 msg = "edge to delete not found!\n";
262 * The target is not NULL and the old target differs
263 * from the new target, the edge shall be moved (if the
264 * old target was != NULL) or added (if the old target was
268 struct list_head *head = _get_irn_outs_head(tgt, kind);
270 assert(head->next && head->prev &&
271 "target list head must have been initialized");
273 /* If the old target is not null, the edge is moved. */
275 edge = set_find(edges, templ, sizeof(templ[0]), edge_hash(templ));
276 assert(edge && "edge to redirect not found!");
277 assert(! edge->invalid && "Invalid edge encountered");
281 list_move(&edge->list, head);
282 edge_change_cnt(old_tgt, kind, -1);
285 /* The old target was null, thus, the edge is newly created. */
287 edge = set_insert(edges, templ, sizeof(templ[0]), edge_hash(templ));
289 assert(! edge->invalid && "Freshly inserted edge is invalid?!?");
290 assert(edge->list.next == NULL && edge->list.prev == NULL &&
291 "New edge must not have list head initialized");
294 list_add(&edge->list, head);
297 edge_change_cnt(tgt, kind, +1);
300 /* verify list heads */
303 vrfy_list_head(tgt, kind);
305 vrfy_list_head(old_tgt, kind);
309 /* If the target and the old target are equal, nothing is done. */
310 DBG((dbg, LEVEL_5, "announce out edge: %+F %d-> %+F(%+F): %s\n", src, pos, tgt, old_tgt, msg));
313 void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_graph *irg)
315 if(edges_activated_kind(irg, EDGE_KIND_NORMAL)) {
316 edges_notify_edge_kind(src, pos, tgt, old_tgt, EDGE_KIND_NORMAL, irg);
319 if (edges_activated_kind(irg, EDGE_KIND_BLOCK) && is_Block(src)) {
320 /* do not use get_nodes_block() here, it fails when running unpinned */
321 ir_node *bl_old = old_tgt ? get_irn_n(skip_Proj(old_tgt), -1) : NULL;
322 ir_node *bl_tgt = NULL;
325 bl_tgt = is_Bad(tgt) ? tgt : get_irn_n(skip_Proj(tgt), -1);
327 edges_notify_edge_kind(src, pos, bl_tgt, bl_old, EDGE_KIND_BLOCK, irg);
332 void edges_node_deleted_kind(ir_node *old, ir_edge_kind_t kind, ir_graph *irg)
336 if(!edges_activated_kind(irg, kind))
339 DBG((dbg, LEVEL_5, "node deleted (kind: %s): %+F\n", get_kind_str(kind), old));
341 foreach_tgt(old, i, n, kind) {
342 ir_node *old_tgt = get_n(old, i, kind);
343 edges_notify_edge_kind(old, i, NULL, old_tgt, kind, irg);
347 struct build_walker {
350 unsigned problem_found;
354 * Post-Walker: notify all edges
356 static void build_edges_walker(ir_node *irn, void *data) {
357 struct build_walker *w = data;
360 if(!edges_activated_kind(w->irg, w->kind))
363 foreach_tgt(irn, i, n, w->kind)
364 edges_notify_edge_kind(irn, i, get_n(irn, i, w->kind), NULL, w->kind, w->irg);
368 * Pre-Walker: initializes the list-heads and set the out-count
371 static void init_lh_walker(ir_node *irn, void *data) {
372 struct build_walker *w = data;
373 INIT_LIST_HEAD(_get_irn_outs_head(irn, w->kind));
374 _get_irn_edge_info(irn, w->kind)->out_count = 0;
378 * Visitor: initializes the list-heads and set the out-count
379 * of all nodes to 0 of nodes that are not seen so far.
381 static void visitor(ir_node *irn, void *data) {
382 if (irn_not_visited(irn)) {
383 mark_irn_visited(irn);
384 init_lh_walker(irn, data);
389 * Build the initial edge set.
390 * Beware, this is not a simple task because it suffers from two
392 * - the anchor set allows access to Nodes that may not be reachable from
394 * - the identities add nodes to the "root set" that are not yet reachable
395 * from End. However, after some transformations, the CSE may revival these
398 * These problems can be fixed using different strategies:
399 * - Add an age flag to every node. Whenever the edge of a node is older
400 * then the current edge, invalidate the edges of this node.
401 * While this would help for revivaled nodes, it increases memory and runtime.
402 * - Delete the identities set.
403 * Solves the revival problem, but may increase the memory consumption, as
404 * nodes cannot be revivaled at all.
405 * - Manually iterate over the identities root set. This did not consume more memory
406 * but increase the computation time because the |identities| >= |V|
408 * Currently, we use the last option.
410 void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind)
412 struct build_walker w;
413 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
419 edges_init_graph_kind(irg, kind);
420 //irg_walk_graph(irg, init_lh_walker, build_edges_walker, &w);
421 inc_irg_visited(irg);
422 irg_walk_anchors(irg, init_lh_walker, build_edges_walker, &w);
423 visit_all_identities(irg, visitor, &w);
426 void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind)
428 irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
432 del_set(info->edges);
437 int (edges_activated_kind)(const ir_graph *irg, ir_edge_kind_t kind)
439 return _edges_activated_kind(irg, kind);
444 * Reroute all use-edges from a node to another.
445 * @param from The node whose use-edges shall be withdrawn.
446 * @param to The node to which all the use-edges of @p from shall be
448 * @param irg The graph.
450 void edges_reroute_kind(ir_node *from, ir_node *to, ir_edge_kind_t kind, ir_graph *irg)
452 set_edge_func_t *set_edge = edge_kind_info[kind].set_edge;
454 if(set_edge && edges_activated_kind(irg, kind)) {
455 struct list_head *head = _get_irn_outs_head(from, kind);
457 DBG((dbg, LEVEL_5, "reroute from %+F to %+F\n", from, to));
459 while(head != head->next) {
460 ir_edge_t *edge = list_entry(head->next, ir_edge_t, list);
461 assert(edge->pos >= -1);
462 set_edge(edge->src, edge->pos, to);
467 static void verify_set_presence(ir_node *irn, void *data)
469 struct build_walker *w = data;
470 set *edges = _get_irg_edge_info(w->irg, w->kind)->edges;
473 foreach_tgt(irn, i, n, w->kind) {
479 e = set_find(edges, &templ, sizeof(templ), edge_hash(&templ));
483 w->problem_found = 1;
484 ir_fprintf(stderr, "Edge Verifier: edge %+F,%d (kind: \"%s\") is missing\n", irn, i, get_kind_str(w->kind));
489 static void verify_list_presence(ir_node *irn, void *data)
491 struct build_walker *w = data;
494 /* check list heads */
495 vrfy_list_head(irn, w->kind);
497 foreach_out_edge_kind(irn, e, w->kind) {
498 ir_node *tgt = get_n(e->src, e->pos, w->kind);
500 w->problem_found = 1;
501 ir_fprintf(stderr, "Edge Verifier: edge %+F,%d (kind \"%s\") is no out edge of %+F but of %+F\n",
502 e->src, e->pos, get_kind_str(w->kind), irn, tgt);
507 int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind)
509 struct build_walker w;
510 set *edges = _get_irg_edge_info(irg, kind)->edges;
517 /* Clear the present bit in all edges available. */
518 for (e = set_first(edges); e; e = set_next(edges))
521 irg_walk_graph(irg, verify_set_presence, verify_list_presence, &w);
524 * Dump all edges which are not invalid and not present.
525 * These edges are superfluous and their presence in the
528 for (e = set_first(edges); e; e = set_next(edges)) {
529 if (! e->invalid && ! e->present) {
531 ir_fprintf(stderr, "Edge Verifier: edge %+F,%d is superfluous\n", e->src, e->pos);
535 return w.problem_found;
539 * Clear link field of all nodes.
541 static void clear_links(ir_node *irn, void *env) {
545 set_irn_link(irn, 0);
549 * Increases count (stored in link field) for all operands of a node.
551 static void count_user(ir_node *irn, void *env) {
554 for (i = get_irn_arity(irn) - 1; i >= 0; --i) {
555 ir_node *op = get_irn_n(irn, i);
556 int cnt = (int)get_irn_link(op);
559 set_irn_link(op, (void *)cnt);
564 * Verifies if collected count, number of edges in list and stored edge count are in sync.
566 static void verify_edge_counter(ir_node *irn, void *env) {
567 struct build_walker *w = env;
569 int ref_cnt = (int)get_irn_link(irn);
570 int edge_cnt = _get_irn_edge_info(irn, EDGE_KIND_NORMAL)->out_count;
571 const struct list_head *head = _get_irn_outs_head(irn, EDGE_KIND_NORMAL);
572 const struct list_head *pos;
577 /* We can iterate safely here, list heads have already been verified. */
578 list_for_each(pos, head)
581 if (edge_cnt != list_cnt) {
582 w->problem_found = 1;
583 ir_fprintf(stderr, "Edge Verifier: edge count is %d, but %d edges are recorded in list at %+F\n",
584 edge_cnt, list_cnt, irn);
587 if (ref_cnt != list_cnt) {
588 w->problem_found = 1;
589 ir_fprintf(stderr, "Edge Verifier: %+F reachable by %d node, but %d edges recorded in list\n",
590 irn, ref_cnt, list_cnt);
595 * Verifies the out edges of an irg.
597 int edges_verify(ir_graph *irg) {
599 struct build_walker w;
600 int problem_found = 0;
602 /* verify all edge kinds */
603 // for (i = 0; i < EDGE_KIND_LAST; ++i) {
604 // int res = edges_verify_kind(irg, i);
605 // problem_found = problem_found ? 1 : res;
607 // problem_found = edges_verify_kind(irg, EDGE_KIND_NORMAL);
610 w.kind = EDGE_KIND_NORMAL;
614 irg_walk_graph(irg, clear_links, count_user, NULL);
615 irg_walk_anchors(irg, clear_links, count_user, NULL);
616 irg_walk_graph(irg, NULL, verify_edge_counter, &w);
618 return problem_found ? 1 : w.problem_found;
621 void init_edges(void)
623 FIRM_DBG_REGISTER(dbg, DBG_EDGES);
624 /* firm_dbg_set_mask(dbg, -1); */
627 void edges_init_dbg(int do_dbg) {
631 void edges_activate(ir_graph *irg)
633 edges_activate_kind(irg, EDGE_KIND_NORMAL);
634 edges_activate_kind(irg, EDGE_KIND_BLOCK);
637 void edges_deactivate(ir_graph *irg)
639 edges_deactivate_kind(irg, EDGE_KIND_NORMAL);
640 edges_deactivate_kind(irg, EDGE_KIND_BLOCK);
643 int edges_assure(ir_graph *irg)
645 int activated = edges_activated(irg);
653 void edges_node_deleted(ir_node *irn, ir_graph *irg)
655 edges_node_deleted_kind(irn, EDGE_KIND_NORMAL, irg);
656 edges_node_deleted_kind(irn, EDGE_KIND_BLOCK, irg);
660 const ir_edge_t *(get_irn_out_edge_first_kind)(const ir_node *irn, ir_edge_kind_t kind)
662 return _get_irn_out_edge_first_kind(irn, kind);
665 const ir_edge_t *(get_irn_out_edge_next)(const ir_node *irn, const ir_edge_t *last)
667 return _get_irn_out_edge_next(irn, last);
670 ir_node *(get_edge_src_irn)(const ir_edge_t *edge)
672 return _get_edge_src_irn(edge);
675 int (get_edge_src_pos)(const ir_edge_t *edge)
677 return _get_edge_src_pos(edge);
680 int (get_irn_n_edges_kind)(const ir_node *irn, ir_edge_kind_t kind)
682 return _get_irn_n_edges_kind(irn, kind);
685 void dump_all_out_edges(ir_node *irn)
688 for(i = 0; i < EDGE_KIND_LAST; ++i) {
689 const ir_edge_t *edge;
691 printf("kind \"%s\"\n", get_kind_str(i));
692 foreach_out_edge_kind(irn, edge, i) {
693 ir_printf("\t%+F(%d)\n", edge->src, edge->pos);