1 /* Calculate (post)dominators header file.
2    Copyright (C) 2014-2016 Free Software Foundation, Inc.
3 
4    This file is part of GCC.
5 
6    GCC is free software; you can redistribute it and/or modify it
7    under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3, or (at your option)
9    any later version.
10 
11    GCC is distributed in the hope that it will be useful, but WITHOUT
12    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
14    License for more details.
15 
16    You should have received a copy of the GNU General Public License
17    along with GCC; see the file COPYING3.  If not see
18    <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef GCC_DOMINANCE_H
21 #define GCC_DOMINANCE_H
22 
23 enum cdi_direction
24 {
25   CDI_DOMINATORS = 1,
26   CDI_POST_DOMINATORS = 2
27 };
28 
29 /* State of dominance information.  */
30 
31 enum dom_state
32 {
33   DOM_NONE,		/* Not computed at all.  */
34   DOM_NO_FAST_QUERY,	/* The data is OK, but the fast query data are not usable.  */
35   DOM_OK		/* Everything is ok.  */
36 };
37 
38 extern void calculate_dominance_info (enum cdi_direction);
39 extern void free_dominance_info (function *, enum cdi_direction);
40 extern void free_dominance_info (enum cdi_direction);
41 extern basic_block get_immediate_dominator (enum cdi_direction, basic_block);
42 extern void set_immediate_dominator (enum cdi_direction, basic_block,
43 				     basic_block);
44 extern vec<basic_block> get_dominated_by (enum cdi_direction, basic_block);
45 extern vec<basic_block> get_dominated_by_region (enum cdi_direction,
46 							 basic_block *,
47 							 unsigned);
48 extern vec<basic_block> get_dominated_to_depth (enum cdi_direction,
49 							basic_block, int);
50 extern vec<basic_block> get_all_dominated_blocks (enum cdi_direction,
51 							  basic_block);
52 extern void redirect_immediate_dominators (enum cdi_direction, basic_block,
53 					   basic_block);
54 extern basic_block nearest_common_dominator (enum cdi_direction,
55 					     basic_block, basic_block);
56 extern basic_block nearest_common_dominator_for_set (enum cdi_direction,
57 						     bitmap);
58 extern bool dominated_by_p (enum cdi_direction, const_basic_block,
59 			    const_basic_block);
60 unsigned bb_dom_dfs_in (enum cdi_direction, basic_block);
61 unsigned bb_dom_dfs_out (enum cdi_direction, basic_block);
62 extern void verify_dominators (enum cdi_direction);
63 
64 /* Verify invariants of computed dominance information, if internal consistency
65    checks are enabled.  */
66 
67 static inline void
checking_verify_dominators(cdi_direction dir)68 checking_verify_dominators (cdi_direction dir)
69 {
70   if (flag_checking)
71     verify_dominators (dir);
72 }
73 
74 basic_block recompute_dominator (enum cdi_direction, basic_block);
75 extern void iterate_fix_dominators (enum cdi_direction,
76 				    vec<basic_block> , bool);
77 extern void add_to_dominance_info (enum cdi_direction, basic_block);
78 extern void delete_from_dominance_info (enum cdi_direction, basic_block);
79 extern basic_block first_dom_son (enum cdi_direction, basic_block);
80 extern basic_block next_dom_son (enum cdi_direction, basic_block);
81 extern enum dom_state dom_info_state (function *, enum cdi_direction);
82 extern enum dom_state dom_info_state (enum cdi_direction);
83 extern void set_dom_info_availability (enum cdi_direction, enum dom_state);
84 extern bool dom_info_available_p (function *, enum cdi_direction);
85 extern bool dom_info_available_p (enum cdi_direction);
86 
87 
88 
89 #endif /* GCC_DOMINANCE_H */
90