* basic-block.h (ei_safe_edge): New function.
[official-gcc.git] / gcc / dominance.c
blob29232f99d3ee7a10a7192ce3e43d1199906710d1
1 /* Calculate (post)dominators in slightly super-linear time.
2 Copyright (C) 2000, 2003, 2004 Free Software Foundation, Inc.
3 Contributed by Michael Matz (matz@ifh.de).
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
15 License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA. */
22 /* This file implements the well known algorithm from Lengauer and Tarjan
23 to compute the dominators in a control flow graph. A basic block D is said
24 to dominate another block X, when all paths from the entry node of the CFG
25 to X go also over D. The dominance relation is a transitive reflexive
26 relation and its minimal transitive reduction is a tree, called the
27 dominator tree. So for each block X besides the entry block exists a
28 block I(X), called the immediate dominator of X, which is the parent of X
29 in the dominator tree.
31 The algorithm computes this dominator tree implicitly by computing for
32 each block its immediate dominator. We use tree balancing and path
33 compression, so its the O(e*a(e,v)) variant, where a(e,v) is the very
34 slowly growing functional inverse of the Ackerman function. */
36 #include "config.h"
37 #include "system.h"
38 #include "coretypes.h"
39 #include "tm.h"
40 #include "rtl.h"
41 #include "hard-reg-set.h"
42 #include "basic-block.h"
43 #include "errors.h"
44 #include "et-forest.h"
46 /* Whether the dominators and the postdominators are available. */
47 enum dom_state dom_computed[2];
49 /* We name our nodes with integers, beginning with 1. Zero is reserved for
50 'undefined' or 'end of list'. The name of each node is given by the dfs
51 number of the corresponding basic block. Please note, that we include the
52 artificial ENTRY_BLOCK (or EXIT_BLOCK in the post-dom case) in our lists to
53 support multiple entry points. As it has no real basic block index we use
54 'last_basic_block' for that. Its dfs number is of course 1. */
56 /* Type of Basic Block aka. TBB */
57 typedef unsigned int TBB;
59 /* We work in a poor-mans object oriented fashion, and carry an instance of
60 this structure through all our 'methods'. It holds various arrays
61 reflecting the (sub)structure of the flowgraph. Most of them are of type
62 TBB and are also indexed by TBB. */
64 struct dom_info
66 /* The parent of a node in the DFS tree. */
67 TBB *dfs_parent;
68 /* For a node x key[x] is roughly the node nearest to the root from which
69 exists a way to x only over nodes behind x. Such a node is also called
70 semidominator. */
71 TBB *key;
72 /* The value in path_min[x] is the node y on the path from x to the root of
73 the tree x is in with the smallest key[y]. */
74 TBB *path_min;
75 /* bucket[x] points to the first node of the set of nodes having x as key. */
76 TBB *bucket;
77 /* And next_bucket[x] points to the next node. */
78 TBB *next_bucket;
79 /* After the algorithm is done, dom[x] contains the immediate dominator
80 of x. */
81 TBB *dom;
83 /* The following few fields implement the structures needed for disjoint
84 sets. */
85 /* set_chain[x] is the next node on the path from x to the representant
86 of the set containing x. If set_chain[x]==0 then x is a root. */
87 TBB *set_chain;
88 /* set_size[x] is the number of elements in the set named by x. */
89 unsigned int *set_size;
90 /* set_child[x] is used for balancing the tree representing a set. It can
91 be understood as the next sibling of x. */
92 TBB *set_child;
94 /* If b is the number of a basic block (BB->index), dfs_order[b] is the
95 number of that node in DFS order counted from 1. This is an index
96 into most of the other arrays in this structure. */
97 TBB *dfs_order;
98 /* If x is the DFS-index of a node which corresponds with a basic block,
99 dfs_to_bb[x] is that basic block. Note, that in our structure there are
100 more nodes that basic blocks, so only dfs_to_bb[dfs_order[bb->index]]==bb
101 is true for every basic block bb, but not the opposite. */
102 basic_block *dfs_to_bb;
104 /* This is the next free DFS number when creating the DFS tree. */
105 unsigned int dfsnum;
106 /* The number of nodes in the DFS tree (==dfsnum-1). */
107 unsigned int nodes;
109 /* Blocks with bits set here have a fake edge to EXIT. These are used
110 to turn a DFS forest into a proper tree. */
111 bitmap fake_exit_edge;
114 static void init_dom_info (struct dom_info *, enum cdi_direction);
115 static void free_dom_info (struct dom_info *);
116 static void calc_dfs_tree_nonrec (struct dom_info *, basic_block,
117 enum cdi_direction);
118 static void calc_dfs_tree (struct dom_info *, enum cdi_direction);
119 static void compress (struct dom_info *, TBB);
120 static TBB eval (struct dom_info *, TBB);
121 static void link_roots (struct dom_info *, TBB, TBB);
122 static void calc_idoms (struct dom_info *, enum cdi_direction);
123 void debug_dominance_info (enum cdi_direction);
125 /* Keeps track of the*/
126 static unsigned n_bbs_in_dom_tree[2];
128 /* Helper macro for allocating and initializing an array,
129 for aesthetic reasons. */
130 #define init_ar(var, type, num, content) \
131 do \
133 unsigned int i = 1; /* Catch content == i. */ \
134 if (! (content)) \
135 (var) = xcalloc ((num), sizeof (type)); \
136 else \
138 (var) = xmalloc ((num) * sizeof (type)); \
139 for (i = 0; i < num; i++) \
140 (var)[i] = (content); \
143 while (0)
145 /* Allocate all needed memory in a pessimistic fashion (so we round up).
146 This initializes the contents of DI, which already must be allocated. */
148 static void
149 init_dom_info (struct dom_info *di, enum cdi_direction dir)
151 /* We need memory for n_basic_blocks nodes and the ENTRY_BLOCK or
152 EXIT_BLOCK. */
153 unsigned int num = n_basic_blocks + 1 + 1;
154 init_ar (di->dfs_parent, TBB, num, 0);
155 init_ar (di->path_min, TBB, num, i);
156 init_ar (di->key, TBB, num, i);
157 init_ar (di->dom, TBB, num, 0);
159 init_ar (di->bucket, TBB, num, 0);
160 init_ar (di->next_bucket, TBB, num, 0);
162 init_ar (di->set_chain, TBB, num, 0);
163 init_ar (di->set_size, unsigned int, num, 1);
164 init_ar (di->set_child, TBB, num, 0);
166 init_ar (di->dfs_order, TBB, (unsigned int) last_basic_block + 1, 0);
167 init_ar (di->dfs_to_bb, basic_block, num, 0);
169 di->dfsnum = 1;
170 di->nodes = 0;
172 di->fake_exit_edge = dir ? BITMAP_XMALLOC () : NULL;
175 #undef init_ar
177 /* Free all allocated memory in DI, but not DI itself. */
179 static void
180 free_dom_info (struct dom_info *di)
182 free (di->dfs_parent);
183 free (di->path_min);
184 free (di->key);
185 free (di->dom);
186 free (di->bucket);
187 free (di->next_bucket);
188 free (di->set_chain);
189 free (di->set_size);
190 free (di->set_child);
191 free (di->dfs_order);
192 free (di->dfs_to_bb);
193 BITMAP_XFREE (di->fake_exit_edge);
196 /* The nonrecursive variant of creating a DFS tree. DI is our working
197 structure, BB the starting basic block for this tree and REVERSE
198 is true, if predecessors should be visited instead of successors of a
199 node. After this is done all nodes reachable from BB were visited, have
200 assigned their dfs number and are linked together to form a tree. */
202 static void
203 calc_dfs_tree_nonrec (struct dom_info *di, basic_block bb,
204 enum cdi_direction reverse)
206 /* We call this _only_ if bb is not already visited. */
207 edge e;
208 TBB child_i, my_i = 0;
209 edge_iterator *stack;
210 edge_iterator ei, einext;
211 int sp;
212 /* Start block (ENTRY_BLOCK_PTR for forward problem, EXIT_BLOCK for backward
213 problem). */
214 basic_block en_block;
215 /* Ending block. */
216 basic_block ex_block;
218 stack = xmalloc ((n_basic_blocks + 3) * sizeof (edge_iterator));
219 sp = 0;
221 /* Initialize our border blocks, and the first edge. */
222 if (reverse)
224 ei = ei_start (bb->preds);
225 en_block = EXIT_BLOCK_PTR;
226 ex_block = ENTRY_BLOCK_PTR;
228 else
230 ei = ei_start (bb->succs);
231 en_block = ENTRY_BLOCK_PTR;
232 ex_block = EXIT_BLOCK_PTR;
235 /* When the stack is empty we break out of this loop. */
236 while (1)
238 basic_block bn;
240 /* This loop traverses edges e in depth first manner, and fills the
241 stack. */
242 while (!ei_end_p (ei))
244 e = ei_edge (ei);
246 /* Deduce from E the current and the next block (BB and BN), and the
247 next edge. */
248 if (reverse)
250 bn = e->src;
252 /* If the next node BN is either already visited or a border
253 block the current edge is useless, and simply overwritten
254 with the next edge out of the current node. */
255 if (bn == ex_block || di->dfs_order[bn->index])
257 ei_next (&ei);
258 continue;
260 bb = e->dest;
261 einext = ei_start (bn->preds);
263 else
265 bn = e->dest;
266 if (bn == ex_block || di->dfs_order[bn->index])
268 ei_next (&ei);
269 continue;
271 bb = e->src;
272 einext = ei_start (bn->succs);
275 gcc_assert (bn != en_block);
277 /* Fill the DFS tree info calculatable _before_ recursing. */
278 if (bb != en_block)
279 my_i = di->dfs_order[bb->index];
280 else
281 my_i = di->dfs_order[last_basic_block];
282 child_i = di->dfs_order[bn->index] = di->dfsnum++;
283 di->dfs_to_bb[child_i] = bn;
284 di->dfs_parent[child_i] = my_i;
286 /* Save the current point in the CFG on the stack, and recurse. */
287 stack[sp++] = ei;
288 ei = einext;
291 if (!sp)
292 break;
293 ei = stack[--sp];
295 /* OK. The edge-list was exhausted, meaning normally we would
296 end the recursion. After returning from the recursive call,
297 there were (may be) other statements which were run after a
298 child node was completely considered by DFS. Here is the
299 point to do it in the non-recursive variant.
300 E.g. The block just completed is in e->dest for forward DFS,
301 the block not yet completed (the parent of the one above)
302 in e->src. This could be used e.g. for computing the number of
303 descendants or the tree depth. */
304 ei_next (&ei);
306 free (stack);
309 /* The main entry for calculating the DFS tree or forest. DI is our working
310 structure and REVERSE is true, if we are interested in the reverse flow
311 graph. In that case the result is not necessarily a tree but a forest,
312 because there may be nodes from which the EXIT_BLOCK is unreachable. */
314 static void
315 calc_dfs_tree (struct dom_info *di, enum cdi_direction reverse)
317 /* The first block is the ENTRY_BLOCK (or EXIT_BLOCK if REVERSE). */
318 basic_block begin = reverse ? EXIT_BLOCK_PTR : ENTRY_BLOCK_PTR;
319 di->dfs_order[last_basic_block] = di->dfsnum;
320 di->dfs_to_bb[di->dfsnum] = begin;
321 di->dfsnum++;
323 calc_dfs_tree_nonrec (di, begin, reverse);
325 if (reverse)
327 /* In the post-dom case we may have nodes without a path to EXIT_BLOCK.
328 They are reverse-unreachable. In the dom-case we disallow such
329 nodes, but in post-dom we have to deal with them.
331 There are two situations in which this occurs. First, noreturn
332 functions. Second, infinite loops. In the first case we need to
333 pretend that there is an edge to the exit block. In the second
334 case, we wind up with a forest. We need to process all noreturn
335 blocks before we know if we've got any infinite loops. */
337 basic_block b;
338 bool saw_unconnected = false;
340 FOR_EACH_BB_REVERSE (b)
342 if (EDGE_COUNT (b->succs) > 0)
344 if (di->dfs_order[b->index] == 0)
345 saw_unconnected = true;
346 continue;
348 bitmap_set_bit (di->fake_exit_edge, b->index);
349 di->dfs_order[b->index] = di->dfsnum;
350 di->dfs_to_bb[di->dfsnum] = b;
351 di->dfs_parent[di->dfsnum] = di->dfs_order[last_basic_block];
352 di->dfsnum++;
353 calc_dfs_tree_nonrec (di, b, reverse);
356 if (saw_unconnected)
358 FOR_EACH_BB_REVERSE (b)
360 if (di->dfs_order[b->index])
361 continue;
362 bitmap_set_bit (di->fake_exit_edge, b->index);
363 di->dfs_order[b->index] = di->dfsnum;
364 di->dfs_to_bb[di->dfsnum] = b;
365 di->dfs_parent[di->dfsnum] = di->dfs_order[last_basic_block];
366 di->dfsnum++;
367 calc_dfs_tree_nonrec (di, b, reverse);
372 di->nodes = di->dfsnum - 1;
374 /* This aborts e.g. when there is _no_ path from ENTRY to EXIT at all. */
375 gcc_assert (di->nodes == (unsigned int) n_basic_blocks + 1);
378 /* Compress the path from V to the root of its set and update path_min at the
379 same time. After compress(di, V) set_chain[V] is the root of the set V is
380 in and path_min[V] is the node with the smallest key[] value on the path
381 from V to that root. */
383 static void
384 compress (struct dom_info *di, TBB v)
386 /* Btw. It's not worth to unrecurse compress() as the depth is usually not
387 greater than 5 even for huge graphs (I've not seen call depth > 4).
388 Also performance wise compress() ranges _far_ behind eval(). */
389 TBB parent = di->set_chain[v];
390 if (di->set_chain[parent])
392 compress (di, parent);
393 if (di->key[di->path_min[parent]] < di->key[di->path_min[v]])
394 di->path_min[v] = di->path_min[parent];
395 di->set_chain[v] = di->set_chain[parent];
399 /* Compress the path from V to the set root of V if needed (when the root has
400 changed since the last call). Returns the node with the smallest key[]
401 value on the path from V to the root. */
403 static inline TBB
404 eval (struct dom_info *di, TBB v)
406 /* The representant of the set V is in, also called root (as the set
407 representation is a tree). */
408 TBB rep = di->set_chain[v];
410 /* V itself is the root. */
411 if (!rep)
412 return di->path_min[v];
414 /* Compress only if necessary. */
415 if (di->set_chain[rep])
417 compress (di, v);
418 rep = di->set_chain[v];
421 if (di->key[di->path_min[rep]] >= di->key[di->path_min[v]])
422 return di->path_min[v];
423 else
424 return di->path_min[rep];
427 /* This essentially merges the two sets of V and W, giving a single set with
428 the new root V. The internal representation of these disjoint sets is a
429 balanced tree. Currently link(V,W) is only used with V being the parent
430 of W. */
432 static void
433 link_roots (struct dom_info *di, TBB v, TBB w)
435 TBB s = w;
437 /* Rebalance the tree. */
438 while (di->key[di->path_min[w]] < di->key[di->path_min[di->set_child[s]]])
440 if (di->set_size[s] + di->set_size[di->set_child[di->set_child[s]]]
441 >= 2 * di->set_size[di->set_child[s]])
443 di->set_chain[di->set_child[s]] = s;
444 di->set_child[s] = di->set_child[di->set_child[s]];
446 else
448 di->set_size[di->set_child[s]] = di->set_size[s];
449 s = di->set_chain[s] = di->set_child[s];
453 di->path_min[s] = di->path_min[w];
454 di->set_size[v] += di->set_size[w];
455 if (di->set_size[v] < 2 * di->set_size[w])
457 TBB tmp = s;
458 s = di->set_child[v];
459 di->set_child[v] = tmp;
462 /* Merge all subtrees. */
463 while (s)
465 di->set_chain[s] = v;
466 s = di->set_child[s];
470 /* This calculates the immediate dominators (or post-dominators if REVERSE is
471 true). DI is our working structure and should hold the DFS forest.
472 On return the immediate dominator to node V is in di->dom[V]. */
474 static void
475 calc_idoms (struct dom_info *di, enum cdi_direction reverse)
477 TBB v, w, k, par;
478 basic_block en_block;
479 edge_iterator ei, einext;
481 if (reverse)
482 en_block = EXIT_BLOCK_PTR;
483 else
484 en_block = ENTRY_BLOCK_PTR;
486 /* Go backwards in DFS order, to first look at the leafs. */
487 v = di->nodes;
488 while (v > 1)
490 basic_block bb = di->dfs_to_bb[v];
491 edge e;
493 par = di->dfs_parent[v];
494 k = v;
496 ei = (reverse) ? ei_start (bb->succs) : ei_start (bb->preds);
498 if (reverse)
500 /* If this block has a fake edge to exit, process that first. */
501 if (bitmap_bit_p (di->fake_exit_edge, bb->index))
503 einext = ei;
504 einext.index = 0;
505 goto do_fake_exit_edge;
509 /* Search all direct predecessors for the smallest node with a path
510 to them. That way we have the smallest node with also a path to
511 us only over nodes behind us. In effect we search for our
512 semidominator. */
513 while (!ei_end_p (ei))
515 TBB k1;
516 basic_block b;
518 e = ei_edge (ei);
519 b = (reverse) ? e->dest : e->src;
520 einext = ei;
521 ei_next (&einext);
523 if (b == en_block)
525 do_fake_exit_edge:
526 k1 = di->dfs_order[last_basic_block];
528 else
529 k1 = di->dfs_order[b->index];
531 /* Call eval() only if really needed. If k1 is above V in DFS tree,
532 then we know, that eval(k1) == k1 and key[k1] == k1. */
533 if (k1 > v)
534 k1 = di->key[eval (di, k1)];
535 if (k1 < k)
536 k = k1;
538 ei = einext;
541 di->key[v] = k;
542 link_roots (di, par, v);
543 di->next_bucket[v] = di->bucket[k];
544 di->bucket[k] = v;
546 /* Transform semidominators into dominators. */
547 for (w = di->bucket[par]; w; w = di->next_bucket[w])
549 k = eval (di, w);
550 if (di->key[k] < di->key[w])
551 di->dom[w] = k;
552 else
553 di->dom[w] = par;
555 /* We don't need to cleanup next_bucket[]. */
556 di->bucket[par] = 0;
557 v--;
560 /* Explicitly define the dominators. */
561 di->dom[1] = 0;
562 for (v = 2; v <= di->nodes; v++)
563 if (di->dom[v] != di->key[v])
564 di->dom[v] = di->dom[di->dom[v]];
567 /* Assign dfs numbers starting from NUM to NODE and its sons. */
569 static void
570 assign_dfs_numbers (struct et_node *node, int *num)
572 struct et_node *son;
574 node->dfs_num_in = (*num)++;
576 if (node->son)
578 assign_dfs_numbers (node->son, num);
579 for (son = node->son->right; son != node->son; son = son->right)
580 assign_dfs_numbers (son, num);
583 node->dfs_num_out = (*num)++;
586 /* Compute the data necessary for fast resolving of dominator queries in a
587 static dominator tree. */
589 static void
590 compute_dom_fast_query (enum cdi_direction dir)
592 int num = 0;
593 basic_block bb;
595 gcc_assert (dom_computed[dir] >= DOM_NO_FAST_QUERY);
597 if (dom_computed[dir] == DOM_OK)
598 return;
600 FOR_ALL_BB (bb)
602 if (!bb->dom[dir]->father)
603 assign_dfs_numbers (bb->dom[dir], &num);
606 dom_computed[dir] = DOM_OK;
609 /* The main entry point into this module. DIR is set depending on whether
610 we want to compute dominators or postdominators. */
612 void
613 calculate_dominance_info (enum cdi_direction dir)
615 struct dom_info di;
616 basic_block b;
618 if (dom_computed[dir] == DOM_OK)
619 return;
621 if (dom_computed[dir] != DOM_NO_FAST_QUERY)
623 if (dom_computed[dir] != DOM_NONE)
624 free_dominance_info (dir);
626 gcc_assert (!n_bbs_in_dom_tree[dir]);
628 FOR_ALL_BB (b)
630 b->dom[dir] = et_new_tree (b);
632 n_bbs_in_dom_tree[dir] = n_basic_blocks + 2;
634 init_dom_info (&di, dir);
635 calc_dfs_tree (&di, dir);
636 calc_idoms (&di, dir);
638 FOR_EACH_BB (b)
640 TBB d = di.dom[di.dfs_order[b->index]];
642 if (di.dfs_to_bb[d])
643 et_set_father (b->dom[dir], di.dfs_to_bb[d]->dom[dir]);
646 free_dom_info (&di);
647 dom_computed[dir] = DOM_NO_FAST_QUERY;
650 compute_dom_fast_query (dir);
653 /* Free dominance information for direction DIR. */
654 void
655 free_dominance_info (enum cdi_direction dir)
657 basic_block bb;
659 if (!dom_computed[dir])
660 return;
662 FOR_ALL_BB (bb)
664 delete_from_dominance_info (dir, bb);
667 /* If there are any nodes left, something is wrong. */
668 gcc_assert (!n_bbs_in_dom_tree[dir]);
670 dom_computed[dir] = DOM_NONE;
673 /* Return the immediate dominator of basic block BB. */
674 basic_block
675 get_immediate_dominator (enum cdi_direction dir, basic_block bb)
677 struct et_node *node = bb->dom[dir];
679 gcc_assert (dom_computed[dir]);
681 if (!node->father)
682 return NULL;
684 return node->father->data;
687 /* Set the immediate dominator of the block possibly removing
688 existing edge. NULL can be used to remove any edge. */
689 inline void
690 set_immediate_dominator (enum cdi_direction dir, basic_block bb,
691 basic_block dominated_by)
693 struct et_node *node = bb->dom[dir];
695 gcc_assert (dom_computed[dir]);
697 if (node->father)
699 if (node->father->data == dominated_by)
700 return;
701 et_split (node);
704 if (dominated_by)
705 et_set_father (node, dominated_by->dom[dir]);
707 if (dom_computed[dir] == DOM_OK)
708 dom_computed[dir] = DOM_NO_FAST_QUERY;
711 /* Store all basic blocks immediately dominated by BB into BBS and return
712 their number. */
714 get_dominated_by (enum cdi_direction dir, basic_block bb, basic_block **bbs)
716 int n;
717 struct et_node *node = bb->dom[dir], *son = node->son, *ason;
719 gcc_assert (dom_computed[dir]);
721 if (!son)
723 *bbs = NULL;
724 return 0;
727 for (ason = son->right, n = 1; ason != son; ason = ason->right)
728 n++;
730 *bbs = xmalloc (n * sizeof (basic_block));
731 (*bbs)[0] = son->data;
732 for (ason = son->right, n = 1; ason != son; ason = ason->right)
733 (*bbs)[n++] = ason->data;
735 return n;
738 /* Redirect all edges pointing to BB to TO. */
739 void
740 redirect_immediate_dominators (enum cdi_direction dir, basic_block bb,
741 basic_block to)
743 struct et_node *bb_node = bb->dom[dir], *to_node = to->dom[dir], *son;
745 gcc_assert (dom_computed[dir]);
747 if (!bb_node->son)
748 return;
750 while (bb_node->son)
752 son = bb_node->son;
754 et_split (son);
755 et_set_father (son, to_node);
758 if (dom_computed[dir] == DOM_OK)
759 dom_computed[dir] = DOM_NO_FAST_QUERY;
762 /* Find first basic block in the tree dominating both BB1 and BB2. */
763 basic_block
764 nearest_common_dominator (enum cdi_direction dir, basic_block bb1, basic_block bb2)
766 gcc_assert (dom_computed[dir]);
768 if (!bb1)
769 return bb2;
770 if (!bb2)
771 return bb1;
773 return et_nca (bb1->dom[dir], bb2->dom[dir])->data;
776 /* Return TRUE in case BB1 is dominated by BB2. */
777 bool
778 dominated_by_p (enum cdi_direction dir, basic_block bb1, basic_block bb2)
780 struct et_node *n1 = bb1->dom[dir], *n2 = bb2->dom[dir];
782 gcc_assert (dom_computed[dir]);
784 if (dom_computed[dir] == DOM_OK)
785 return (n1->dfs_num_in >= n2->dfs_num_in
786 && n1->dfs_num_out <= n2->dfs_num_out);
788 return et_below (n1, n2);
791 /* Verify invariants of dominator structure. */
792 void
793 verify_dominators (enum cdi_direction dir)
795 int err = 0;
796 basic_block bb;
798 gcc_assert (dom_computed[dir]);
800 FOR_EACH_BB (bb)
802 basic_block dom_bb;
804 dom_bb = recount_dominator (dir, bb);
805 if (dom_bb != get_immediate_dominator (dir, bb))
807 error ("dominator of %d should be %d, not %d",
808 bb->index, dom_bb->index, get_immediate_dominator(dir, bb)->index);
809 err = 1;
813 if (dir == CDI_DOMINATORS
814 && dom_computed[dir] >= DOM_NO_FAST_QUERY)
816 FOR_EACH_BB (bb)
818 if (!dominated_by_p (dir, bb, ENTRY_BLOCK_PTR))
820 error ("ENTRY does not dominate bb %d", bb->index);
821 err = 1;
826 gcc_assert (!err);
829 /* Determine immediate dominator (or postdominator, according to DIR) of BB,
830 assuming that dominators of other blocks are correct. We also use it to
831 recompute the dominators in a restricted area, by iterating it until it
832 reaches a fixed point. */
834 basic_block
835 recount_dominator (enum cdi_direction dir, basic_block bb)
837 basic_block dom_bb = NULL;
838 edge e;
839 edge_iterator ei;
841 gcc_assert (dom_computed[dir]);
843 if (dir == CDI_DOMINATORS)
845 FOR_EACH_EDGE (e, ei, bb->preds)
847 /* Ignore the predecessors that either are not reachable from
848 the entry block, or whose dominator was not determined yet. */
849 if (!dominated_by_p (dir, e->src, ENTRY_BLOCK_PTR))
850 continue;
852 if (!dominated_by_p (dir, e->src, bb))
853 dom_bb = nearest_common_dominator (dir, dom_bb, e->src);
856 else
858 FOR_EACH_EDGE (e, ei, bb->succs)
860 if (!dominated_by_p (dir, e->dest, bb))
861 dom_bb = nearest_common_dominator (dir, dom_bb, e->dest);
865 return dom_bb;
868 /* Iteratively recount dominators of BBS. The change is supposed to be local
869 and not to grow further. */
870 void
871 iterate_fix_dominators (enum cdi_direction dir, basic_block *bbs, int n)
873 int i, changed = 1;
874 basic_block old_dom, new_dom;
876 gcc_assert (dom_computed[dir]);
878 for (i = 0; i < n; i++)
879 set_immediate_dominator (dir, bbs[i], NULL);
881 while (changed)
883 changed = 0;
884 for (i = 0; i < n; i++)
886 old_dom = get_immediate_dominator (dir, bbs[i]);
887 new_dom = recount_dominator (dir, bbs[i]);
888 if (old_dom != new_dom)
890 changed = 1;
891 set_immediate_dominator (dir, bbs[i], new_dom);
896 for (i = 0; i < n; i++)
897 gcc_assert (get_immediate_dominator (dir, bbs[i]));
900 void
901 add_to_dominance_info (enum cdi_direction dir, basic_block bb)
903 gcc_assert (dom_computed[dir]);
904 gcc_assert (!bb->dom[dir]);
906 n_bbs_in_dom_tree[dir]++;
908 bb->dom[dir] = et_new_tree (bb);
910 if (dom_computed[dir] == DOM_OK)
911 dom_computed[dir] = DOM_NO_FAST_QUERY;
914 void
915 delete_from_dominance_info (enum cdi_direction dir, basic_block bb)
917 gcc_assert (dom_computed[dir]);
919 et_free_tree (bb->dom[dir]);
920 bb->dom[dir] = NULL;
921 n_bbs_in_dom_tree[dir]--;
923 if (dom_computed[dir] == DOM_OK)
924 dom_computed[dir] = DOM_NO_FAST_QUERY;
927 /* Returns the first son of BB in the dominator or postdominator tree
928 as determined by DIR. */
930 basic_block
931 first_dom_son (enum cdi_direction dir, basic_block bb)
933 struct et_node *son = bb->dom[dir]->son;
935 return son ? son->data : NULL;
938 /* Returns the next dominance son after BB in the dominator or postdominator
939 tree as determined by DIR, or NULL if it was the last one. */
941 basic_block
942 next_dom_son (enum cdi_direction dir, basic_block bb)
944 struct et_node *next = bb->dom[dir]->right;
946 return next->father->son == next ? NULL : next->data;
949 void
950 debug_dominance_info (enum cdi_direction dir)
952 basic_block bb, bb2;
953 FOR_EACH_BB (bb)
954 if ((bb2 = get_immediate_dominator (dir, bb)))
955 fprintf (stderr, "%i %i\n", bb->index, bb2->index);