1 /* Define control and data flow tables, and regsets.
2 Copyright (C) 1987, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
4 This file is part of GNU CC.
6 GNU CC is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU CC is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU CC; see the file COPYING. If not, write to
18 the Free Software Foundation, 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 #ifndef _BASIC_BLOCK_H
22 #define _BASIC_BLOCK_H 1
28 /* Head of register set linked list. */
29 typedef bitmap_head regset_head;
30 /* A pointer to a regset_head. */
31 typedef bitmap regset;
33 /* Initialize a new regset. */
34 #define INIT_REG_SET(HEAD) bitmap_initialize (HEAD)
36 /* Clear a register set by freeing up the linked list. */
37 #define CLEAR_REG_SET(HEAD) bitmap_clear (HEAD)
39 /* Copy a register set to another register set. */
40 #define COPY_REG_SET(TO, FROM) bitmap_copy (TO, FROM)
42 /* Compare two register sets. */
43 #define REG_SET_EQUAL_P(A, B) bitmap_equal_p (A, B)
45 /* `and' a register set with a second register set. */
46 #define AND_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_AND)
48 /* `and' the complement of a register set with a register set. */
49 #define AND_COMPL_REG_SET(TO, FROM) \
50 bitmap_operation (TO, TO, FROM, BITMAP_AND_COMPL)
52 /* Inclusive or a register set with a second register set. */
53 #define IOR_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_IOR)
55 /* Exclusive or a register set with a second register set. */
56 #define XOR_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_XOR)
58 /* Or into TO the register set FROM1 `and'ed with the complement of FROM2. */
59 #define IOR_AND_COMPL_REG_SET(TO, FROM1, FROM2) \
60 bitmap_ior_and_compl (TO, FROM1, FROM2)
62 /* Clear a single register in a register set. */
63 #define CLEAR_REGNO_REG_SET(HEAD, REG) bitmap_clear_bit (HEAD, REG)
65 /* Set a single register in a register set. */
66 #define SET_REGNO_REG_SET(HEAD, REG) bitmap_set_bit (HEAD, REG)
68 /* Return true if a register is set in a register set. */
69 #define REGNO_REG_SET_P(TO, REG) bitmap_bit_p (TO, REG)
71 /* Copy the hard registers in a register set to the hard register set. */
72 #define REG_SET_TO_HARD_REG_SET(TO, FROM) \
75 CLEAR_HARD_REG_SET (TO); \
76 for (i_ = 0; i_ < FIRST_PSEUDO_REGISTER; i_++) \
77 if (REGNO_REG_SET_P (FROM, i_)) \
78 SET_HARD_REG_BIT (TO, i_); \
81 /* Loop over all registers in REGSET, starting with MIN, setting REGNUM to the
82 register number and executing CODE for all registers that are set. */
83 #define EXECUTE_IF_SET_IN_REG_SET(REGSET, MIN, REGNUM, CODE) \
84 EXECUTE_IF_SET_IN_BITMAP (REGSET, MIN, REGNUM, CODE)
86 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
87 REGNUM to the register number and executing CODE for all registers that are
88 set in the first regset and not set in the second. */
89 #define EXECUTE_IF_AND_COMPL_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, CODE) \
90 EXECUTE_IF_AND_COMPL_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, CODE)
92 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
93 REGNUM to the register number and executing CODE for all registers that are
94 set in both regsets. */
95 #define EXECUTE_IF_AND_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, CODE) \
96 EXECUTE_IF_AND_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, CODE)
98 /* Allocate a register set with oballoc. */
99 #define OBSTACK_ALLOC_REG_SET(OBSTACK) BITMAP_OBSTACK_ALLOC (OBSTACK)
101 /* Allocate a register set with alloca. */
102 #define ALLOCA_REG_SET() BITMAP_ALLOCA ()
104 /* Do any cleanup needed on a regset when it is no longer used. */
105 #define FREE_REG_SET(REGSET) BITMAP_FREE(REGSET)
107 /* Do any one-time initializations needed for regsets. */
108 #define INIT_ONCE_REG_SET() BITMAP_INIT_ONCE ()
110 /* Grow any tables needed when the number of registers is calculated
111 or extended. For the linked list allocation, nothing needs to
112 be done, other than zero the statistics on the first allocation. */
113 #define MAX_REGNO_REG_SET(NUM_REGS, NEW_P, RENUMBER_P)
115 /* Control flow edge information. */
116 typedef struct edge_def {
117 /* Links through the predecessor and successor lists. */
118 struct edge_def *pred_next, *succ_next;
120 /* The two blocks at the ends of the edge. */
121 struct basic_block_def *src, *dest;
123 /* Instructions queued on the edge. */
126 /* Auxiliary info specific to a pass. */
129 int flags; /* see EDGE_* below */
130 int probability; /* biased by REG_BR_PROB_BASE */
133 #define EDGE_FALLTHRU 1
134 #define EDGE_CRITICAL 2
135 #define EDGE_ABNORMAL 4
136 #define EDGE_ABNORMAL_CALL 8
141 /* Basic block information indexed by block number. */
142 typedef struct basic_block_def {
143 /* The first and last insns of the block. */
146 /* The edges into and out of the block. */
151 regset global_live_at_start;
152 regset global_live_at_end;
154 /* Auxiliary info specific to a pass. */
157 /* The index of this block. */
159 /* The loop depth of this block plus one. */
162 /* The active eh region before head and after end. */
166 /* Number of basic blocks in the current function. */
168 extern int n_basic_blocks;
170 /* Number of edges in the current function. */
174 /* Index by basic block number, get basic block struct info. */
176 extern varray_type basic_block_info;
178 #define BASIC_BLOCK(N) (VARRAY_BB (basic_block_info, (N)))
180 /* What registers are live at the setjmp call. */
182 extern regset regs_live_at_setjmp;
184 /* Indexed by n, gives number of basic block that (REG n) is used in.
185 If the value is REG_BLOCK_GLOBAL (-2),
186 it means (REG n) is used in more than one basic block.
187 REG_BLOCK_UNKNOWN (-1) means it hasn't been seen yet so we don't know.
188 This information remains valid for the rest of the compilation
189 of the current function; it is used to control register allocation. */
191 #define REG_BLOCK_UNKNOWN -1
192 #define REG_BLOCK_GLOBAL -2
194 #define REG_BASIC_BLOCK(N) (VARRAY_REG (reg_n_info, N)->basic_block)
196 /* Stuff for recording basic block info. */
198 #define BLOCK_HEAD(B) (BASIC_BLOCK (B)->head)
199 #define BLOCK_END(B) (BASIC_BLOCK (B)->end)
201 /* Special block numbers [markers] for entry and exit. */
202 #define ENTRY_BLOCK (-1)
203 #define EXIT_BLOCK (-2)
205 /* Similarly, block pointers for the edge list. */
206 extern struct basic_block_def entry_exit_blocks[2];
207 #define ENTRY_BLOCK_PTR (&entry_exit_blocks[0])
208 #define EXIT_BLOCK_PTR (&entry_exit_blocks[1])
210 extern varray_type basic_block_for_insn;
211 #define BLOCK_FOR_INSN(INSN) VARRAY_BB (basic_block_for_insn, INSN_UID (INSN))
212 #define BLOCK_NUM(INSN) (BLOCK_FOR_INSN (INSN)->index + 0)
214 extern void compute_bb_for_insn PARAMS ((int));
215 extern void set_block_for_insn PARAMS ((rtx, basic_block));
216 extern void set_block_num PARAMS ((rtx, int));
218 extern void free_basic_block_vars PARAMS ((int));
220 extern basic_block split_edge PARAMS ((edge));
221 extern void insert_insn_on_edge PARAMS ((rtx, edge));
222 extern void commit_edge_insertions PARAMS ((void));
223 extern void remove_fake_edges PARAMS ((void));
224 extern void add_noreturn_fake_exit_edges PARAMS ((void));
225 extern void flow_delete_insn_chain PARAMS ((rtx, rtx));
228 /* Structure to hold information for each natural loop. */
233 /* Basic block of loop header. */
236 /* Basic block of loop latch. */
239 /* Basic block of loop pre-header or NULL if it does not exist. */
240 basic_block pre_header;
242 /* Bitmap of blocks contained within the loop. */
245 /* Number of blocks contained within the loop. */
248 /* Array of edges that exit the loop. */
251 /* Number of edges that exit the loop. */
254 /* The loop nesting depth. */
257 /* The height of the loop (enclosed loop levels) within the loop
261 /* The outer (parent) loop or NULL if outermost loop. */
264 /* The first inner (child) loop or NULL if innermost loop. */
267 /* Link to the next (sibling) loop. */
270 /* Non-zero if the loop shares a header with another loop. */
273 /* Non-zero if the loop is invalid (e.g., contains setjmp.). */
276 /* Auxiliary info specific to a pass. */
281 /* Structure to hold CFG information about natural loops within a function. */
284 /* Number of natural loops in the function. */
287 /* Array of natural loop descriptors (scanning this array in reverse order
288 will find the inner loops before their enclosing outer loops). */
291 /* Pointer to root of loop heirachy tree. */
294 /* Information derived from the CFG. */
297 /* The bitmap vector of dominators or NULL if not computed. */
300 /* The ordering of the basic blocks in a depth first search. */
304 /* Headers shared by multiple loops that should be merged. */
305 sbitmap shared_headers;
308 extern int flow_loops_find PARAMS ((struct loops *));
309 extern void flow_loops_free PARAMS ((struct loops *));
310 extern void flow_loops_dump PARAMS ((const struct loops *, FILE *, int));
313 /* This structure maintains an edge list vector. */
321 /* This is the value which indicates no edge is present. */
322 #define EDGE_INDEX_NO_EDGE -1
324 /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE
325 if there is no edge between the 2 basic blocks. */
326 #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ)))
328 /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic
329 block which is either the pred or succ end of the indexed edge. */
330 #define INDEX_EDGE_PRED_BB(el, index) ((el)->index_to_edge[(index)]->src)
331 #define INDEX_EDGE_SUCC_BB(el, index) ((el)->index_to_edge[(index)]->dest)
333 /* INDEX_EDGE returns a pointer to the edge. */
334 #define INDEX_EDGE(el, index) ((el)->index_to_edge[(index)])
336 /* Number of edges in the compressed edge list. */
337 #define NUM_EDGES(el) ((el)->num_edges)
339 struct edge_list * create_edge_list PARAMS ((void));
340 void free_edge_list PARAMS ((struct edge_list *));
341 void print_edge_list PARAMS ((FILE *, struct edge_list *));
342 void verify_edge_list PARAMS ((FILE *, struct edge_list *));
343 int find_edge_index PARAMS ((struct edge_list *,
344 basic_block, basic_block));
346 extern void compute_flow_dominators PARAMS ((sbitmap *, sbitmap *));
347 extern void compute_immediate_dominators PARAMS ((int *, sbitmap *));
350 enum update_life_extent
352 UPDATE_LIFE_LOCAL = 0,
353 UPDATE_LIFE_GLOBAL = 1,
354 UPDATE_LIFE_GLOBAL_RM_NOTES = 2
357 /* Flags for life_analysis and update_life_info. */
359 #define PROP_DEATH_NOTES 1 /* Create DEAD and UNUSED notes. */
360 #define PROP_LOG_LINKS 2 /* Create LOG_LINKS. */
361 #define PROP_REG_INFO 4 /* Update regs_ever_live et al. */
362 #define PROP_KILL_DEAD_CODE 8 /* Remove dead code. */
363 #define PROP_SCAN_DEAD_CODE 16 /* Scan for dead code. */
364 #define PROP_AUTOINC 32 /* Create autoinc mem references. */
365 #define PROP_FINAL 63 /* All of the above. */
367 extern void update_life_info PARAMS ((sbitmap, enum update_life_extent,
369 extern int count_or_remove_death_notes PARAMS ((sbitmap, int));
372 extern struct edge_list *pre_edge_lcm PARAMS ((FILE *, int, sbitmap *,
373 sbitmap *, sbitmap *,
374 sbitmap *, sbitmap **,
376 extern struct edge_list *pre_edge_rev_lcm PARAMS ((FILE *, int, sbitmap *,
377 sbitmap *, sbitmap *,
378 sbitmap *, sbitmap **,
380 extern void compute_available PARAMS ((sbitmap *, sbitmap *,
381 sbitmap *, sbitmap *));
384 extern rtx emit_block_insn_after PARAMS ((rtx, rtx, basic_block));
385 extern rtx emit_block_insn_before PARAMS ((rtx, rtx, basic_block));
387 #endif /* _BASIC_BLOCK_H */