]>
Commit | Line | Data |
---|---|---|
3245eea0 | 1 | /* Define control and data flow tables, and regsets. |
3d994c6b | 2 | Copyright (C) 1987, 1997, 1998, 1999, 2000 Free Software Foundation, Inc. |
3245eea0 CH |
3 | |
4 | This file is part of GNU CC. | |
5 | ||
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) | |
9 | any later version. | |
10 | ||
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. | |
15 | ||
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 | |
940d9d63 RK |
18 | the Free Software Foundation, 59 Temple Place - Suite 330, |
19 | Boston, MA 02111-1307, USA. */ | |
3245eea0 | 20 | |
4dc9341c MH |
21 | #ifndef _BASIC_BLOCK_H |
22 | #define _BASIC_BLOCK_H 1 | |
3245eea0 | 23 | |
19d18142 | 24 | #include "bitmap.h" |
5f6c11d6 | 25 | #include "sbitmap.h" |
e881bb1b | 26 | #include "varray.h" |
19d18142 | 27 | |
b1dbfa1d BS |
28 | /* Head of register set linked list. */ |
29 | typedef bitmap_head regset_head; | |
30 | /* A pointer to a regset_head. */ | |
31 | typedef bitmap regset; | |
32 | ||
33 | /* Initialize a new regset. */ | |
34 | #define INIT_REG_SET(HEAD) bitmap_initialize (HEAD) | |
19d18142 RK |
35 | |
36 | /* Clear a register set by freeing up the linked list. */ | |
37 | #define CLEAR_REG_SET(HEAD) bitmap_clear (HEAD) | |
38 | ||
39 | /* Copy a register set to another register set. */ | |
40 | #define COPY_REG_SET(TO, FROM) bitmap_copy (TO, FROM) | |
41 | ||
d3a923ee RH |
42 | /* Compare two register sets. */ |
43 | #define REG_SET_EQUAL_P(A, B) bitmap_equal_p (A, B) | |
44 | ||
19d18142 RK |
45 | /* `and' a register set with a second register set. */ |
46 | #define AND_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_AND) | |
47 | ||
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) | |
51 | ||
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) | |
54 | ||
d3a923ee RH |
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) | |
57 | ||
19d18142 RK |
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) | |
916b1701 MM |
61 | |
62 | /* Clear a single register in a register set. */ | |
19d18142 | 63 | #define CLEAR_REGNO_REG_SET(HEAD, REG) bitmap_clear_bit (HEAD, REG) |
916b1701 MM |
64 | |
65 | /* Set a single register in a register set. */ | |
19d18142 | 66 | #define SET_REGNO_REG_SET(HEAD, REG) bitmap_set_bit (HEAD, REG) |
916b1701 MM |
67 | |
68 | /* Return true if a register is set in a register set. */ | |
19d18142 | 69 | #define REGNO_REG_SET_P(TO, REG) bitmap_bit_p (TO, REG) |
916b1701 MM |
70 | |
71 | /* Copy the hard registers in a register set to the hard register set. */ | |
72 | #define REG_SET_TO_HARD_REG_SET(TO, FROM) \ | |
73 | do { \ | |
74 | int i_; \ | |
75 | CLEAR_HARD_REG_SET (TO); \ | |
af089bd1 | 76 | for (i_ = 0; i_ < FIRST_PSEUDO_REGISTER; i_++) \ |
916b1701 MM |
77 | if (REGNO_REG_SET_P (FROM, i_)) \ |
78 | SET_HARD_REG_BIT (TO, i_); \ | |
79 | } while (0) | |
80 | ||
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) \ | |
19d18142 | 84 | EXECUTE_IF_SET_IN_BITMAP (REGSET, MIN, REGNUM, CODE) |
916b1701 MM |
85 | |
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) \ | |
19d18142 | 90 | EXECUTE_IF_AND_COMPL_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, CODE) |
916b1701 | 91 | |
22fa5b8a MM |
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) | |
97 | ||
916b1701 | 98 | /* Allocate a register set with oballoc. */ |
19d18142 | 99 | #define OBSTACK_ALLOC_REG_SET(OBSTACK) BITMAP_OBSTACK_ALLOC (OBSTACK) |
916b1701 MM |
100 | |
101 | /* Allocate a register set with alloca. */ | |
19d18142 RK |
102 | #define ALLOCA_REG_SET() BITMAP_ALLOCA () |
103 | ||
104 | /* Do any cleanup needed on a regset when it is no longer used. */ | |
105 | #define FREE_REG_SET(REGSET) BITMAP_FREE(REGSET) | |
106 | ||
107 | /* Do any one-time initializations needed for regsets. */ | |
108 | #define INIT_ONCE_REG_SET() BITMAP_INIT_ONCE () | |
109 | ||
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. */ | |
e881bb1b | 113 | #define MAX_REGNO_REG_SET(NUM_REGS, NEW_P, RENUMBER_P) |
916b1701 | 114 | |
e881bb1b RH |
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; | |
3245eea0 | 119 | |
e881bb1b RH |
120 | /* The two blocks at the ends of the edge. */ |
121 | struct basic_block_def *src, *dest; | |
122 | ||
123 | /* Instructions queued on the edge. */ | |
124 | rtx insns; | |
125 | ||
126 | /* Auxiliary info specific to a pass. */ | |
127 | void *aux; | |
3245eea0 | 128 | |
e881bb1b RH |
129 | int flags; /* see EDGE_* below */ |
130 | int probability; /* biased by REG_BR_PROB_BASE */ | |
131 | } *edge; | |
3245eea0 | 132 | |
e881bb1b RH |
133 | #define EDGE_FALLTHRU 1 |
134 | #define EDGE_CRITICAL 2 | |
135 | #define EDGE_ABNORMAL 4 | |
136 | #define EDGE_ABNORMAL_CALL 8 | |
137 | #define EDGE_EH 16 | |
138 | #define EDGE_FAKE 32 | |
3245eea0 | 139 | |
3245eea0 | 140 | |
e881bb1b RH |
141 | /* Basic block information indexed by block number. */ |
142 | typedef struct basic_block_def { | |
143 | /* The first and last insns of the block. */ | |
144 | rtx head, end; | |
3245eea0 | 145 | |
e881bb1b RH |
146 | /* The edges into and out of the block. */ |
147 | edge pred, succ; | |
4d1d8045 | 148 | |
e881bb1b RH |
149 | /* Liveness info. */ |
150 | regset local_set; | |
151 | regset global_live_at_start; | |
152 | regset global_live_at_end; | |
4d1d8045 | 153 | |
e881bb1b RH |
154 | /* Auxiliary info specific to a pass. */ |
155 | void *aux; | |
3245eea0 | 156 | |
e881bb1b RH |
157 | /* The index of this block. */ |
158 | int index; | |
159 | /* The loop depth of this block plus one. */ | |
160 | int loop_depth; | |
336a6399 RH |
161 | |
162 | /* The active eh region before head and after end. */ | |
163 | int eh_beg, eh_end; | |
e881bb1b RH |
164 | } *basic_block; |
165 | ||
166 | /* Number of basic blocks in the current function. */ | |
167 | ||
168 | extern int n_basic_blocks; | |
169 | ||
d3a923ee RH |
170 | /* Number of edges in the current function. */ |
171 | ||
172 | extern int n_edges; | |
173 | ||
e881bb1b RH |
174 | /* Index by basic block number, get basic block struct info. */ |
175 | ||
176 | extern varray_type basic_block_info; | |
177 | ||
178 | #define BASIC_BLOCK(N) (VARRAY_BB (basic_block_info, (N))) | |
3245eea0 | 179 | |
19d18142 RK |
180 | /* What registers are live at the setjmp call. */ |
181 | ||
182 | extern regset regs_live_at_setjmp; | |
183 | ||
3245eea0 CH |
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. */ | |
190 | ||
191 | #define REG_BLOCK_UNKNOWN -1 | |
192 | #define REG_BLOCK_GLOBAL -2 | |
b1f21e0a | 193 | |
6feacd09 | 194 | #define REG_BASIC_BLOCK(N) (VARRAY_REG (reg_n_info, N)->basic_block) |
5ece9746 JL |
195 | \f |
196 | /* Stuff for recording basic block info. */ | |
197 | ||
e881bb1b RH |
198 | #define BLOCK_HEAD(B) (BASIC_BLOCK (B)->head) |
199 | #define BLOCK_END(B) (BASIC_BLOCK (B)->end) | |
5ece9746 JL |
200 | |
201 | /* Special block numbers [markers] for entry and exit. */ | |
202 | #define ENTRY_BLOCK (-1) | |
203 | #define EXIT_BLOCK (-2) | |
204 | ||
e881bb1b RH |
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]) | |
209 | ||
e881bb1b RH |
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) | |
213 | ||
3d994c6b KG |
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)); | |
e881bb1b | 217 | |
3d994c6b | 218 | extern void free_basic_block_vars PARAMS ((int)); |
52becdc0 | 219 | |
3d994c6b KG |
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)); | |
e881bb1b | 226 | |
4dc9341c MH |
227 | |
228 | /* Structure to hold information for each natural loop. */ | |
229 | struct loop | |
230 | { | |
231 | int num; | |
232 | ||
233 | /* Basic block of loop header. */ | |
234 | basic_block header; | |
235 | ||
236 | /* Basic block of loop latch. */ | |
237 | basic_block latch; | |
238 | ||
239 | /* Basic block of loop pre-header or NULL if it does not exist. */ | |
240 | basic_block pre_header; | |
241 | ||
65169dcf JE |
242 | /* The first block in the loop. This is not necessarily the same as |
243 | the loop header. */ | |
244 | basic_block first; | |
245 | ||
246 | /* The last block in the loop. This is not necessarily the same as | |
247 | the loop latch. */ | |
248 | basic_block last; | |
249 | ||
4dc9341c MH |
250 | /* Bitmap of blocks contained within the loop. */ |
251 | sbitmap nodes; | |
252 | ||
253 | /* Number of blocks contained within the loop. */ | |
254 | int num_nodes; | |
255 | ||
256 | /* Array of edges that exit the loop. */ | |
257 | edge *exits; | |
258 | ||
259 | /* Number of edges that exit the loop. */ | |
260 | int num_exits; | |
261 | ||
262 | /* The loop nesting depth. */ | |
263 | int depth; | |
264 | ||
265 | /* The height of the loop (enclosed loop levels) within the loop | |
266 | hierarchy tree. */ | |
267 | int level; | |
268 | ||
269 | /* The outer (parent) loop or NULL if outermost loop. */ | |
270 | struct loop *outer; | |
271 | ||
272 | /* The first inner (child) loop or NULL if innermost loop. */ | |
273 | struct loop *inner; | |
274 | ||
275 | /* Link to the next (sibling) loop. */ | |
276 | struct loop *next; | |
277 | ||
278 | /* Non-zero if the loop shares a header with another loop. */ | |
279 | int shared; | |
280 | ||
281 | /* Non-zero if the loop is invalid (e.g., contains setjmp.). */ | |
282 | int invalid; | |
283 | ||
284 | /* Auxiliary info specific to a pass. */ | |
52b38064 | 285 | void *aux; |
a2be868f MH |
286 | |
287 | /* The following are currently used by loop.c but they are likely to | |
288 | disappear as loop.c is converted to use the CFG. */ | |
289 | ||
290 | /* Non-zero if the loop has a NOTE_INSN_LOOP_VTOP. */ | |
291 | rtx vtop; | |
292 | ||
293 | /* Non-zero if the loop has a NOTE_INSN_LOOP_CONT. | |
294 | A continue statement will generate a branch to NEXT_INSN (cont). */ | |
295 | rtx cont; | |
296 | ||
297 | /* The dominator of cont. */ | |
298 | rtx cont_dominator; | |
299 | ||
300 | /* The NOTE_INSN_LOOP_BEG. */ | |
301 | rtx start; | |
302 | ||
303 | /* The NOTE_INSN_LOOP_END. */ | |
304 | rtx end; | |
305 | ||
306 | /* For a rotated loop that is entered near the bottom, | |
307 | this is the label at the top. Otherwise it is zero. */ | |
308 | rtx top; | |
309 | ||
310 | /* Place in the loop where control enters. */ | |
311 | rtx scan_start; | |
312 | ||
313 | /* List of all LABEL_REFs which refer to code labels outside the | |
314 | loop. Used by routines that need to know all loop exits, such as | |
315 | final_biv_value and final_giv_value. | |
316 | ||
317 | This does not include loop exits due to return instructions. | |
318 | This is because all bivs and givs are pseudos, and hence must be | |
319 | dead after a return, so the presense of a return does not affect | |
320 | any of the optimizations that use this info. It is simpler to | |
321 | just not include return instructions on this list. */ | |
322 | rtx exit_labels; | |
323 | ||
324 | /* The number of LABEL_REFs on exit_labels for this loop and all | |
325 | loops nested inside it. */ | |
326 | int exit_count; | |
4dc9341c MH |
327 | }; |
328 | ||
65169dcf JE |
329 | #define FLOW_LOOP_FIRST_BLOCK(loop) sbitmap_first_set_bit ((loop).nodes) |
330 | #define FLOW_LOOP_LAST_BLOCK(loop) sbitmap_last_set_bit ((loop).nodes) | |
4dc9341c MH |
331 | |
332 | /* Structure to hold CFG information about natural loops within a function. */ | |
333 | struct loops | |
334 | { | |
335 | /* Number of natural loops in the function. */ | |
336 | int num; | |
337 | ||
d6181b1b MH |
338 | /* Maxium nested loop level in the function. */ |
339 | int levels; | |
340 | ||
4dc9341c MH |
341 | /* Array of natural loop descriptors (scanning this array in reverse order |
342 | will find the inner loops before their enclosing outer loops). */ | |
343 | struct loop *array; | |
344 | ||
345 | /* Pointer to root of loop heirachy tree. */ | |
346 | struct loop *tree; | |
347 | ||
348 | /* Information derived from the CFG. */ | |
349 | struct cfg | |
350 | { | |
351 | /* The bitmap vector of dominators or NULL if not computed. */ | |
352 | sbitmap *dom; | |
353 | ||
354 | /* The ordering of the basic blocks in a depth first search. */ | |
355 | int *dfs_order; | |
356 | } cfg; | |
357 | ||
358 | /* Headers shared by multiple loops that should be merged. */ | |
359 | sbitmap shared_headers; | |
360 | }; | |
361 | ||
3d994c6b KG |
362 | extern int flow_loops_find PARAMS ((struct loops *)); |
363 | extern void flow_loops_free PARAMS ((struct loops *)); | |
364 | extern void flow_loops_dump PARAMS ((const struct loops *, FILE *, int)); | |
4dc9341c MH |
365 | |
366 | ||
410538ea AM |
367 | /* This structure maintains an edge list vector. */ |
368 | struct edge_list | |
369 | { | |
370 | int num_blocks; | |
371 | int num_edges; | |
372 | edge *index_to_edge; | |
373 | }; | |
374 | ||
375 | /* This is the value which indicates no edge is present. */ | |
376 | #define EDGE_INDEX_NO_EDGE -1 | |
377 | ||
378 | /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE | |
379 | if there is no edge between the 2 basic blocks. */ | |
380 | #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ))) | |
381 | ||
382 | /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic | |
383 | block which is either the pred or succ end of the indexed edge. */ | |
384 | #define INDEX_EDGE_PRED_BB(el, index) ((el)->index_to_edge[(index)]->src) | |
385 | #define INDEX_EDGE_SUCC_BB(el, index) ((el)->index_to_edge[(index)]->dest) | |
386 | ||
387 | /* INDEX_EDGE returns a pointer to the edge. */ | |
388 | #define INDEX_EDGE(el, index) ((el)->index_to_edge[(index)]) | |
389 | ||
390 | /* Number of edges in the compressed edge list. */ | |
391 | #define NUM_EDGES(el) ((el)->num_edges) | |
392 | ||
3d994c6b KG |
393 | struct edge_list * create_edge_list PARAMS ((void)); |
394 | void free_edge_list PARAMS ((struct edge_list *)); | |
395 | void print_edge_list PARAMS ((FILE *, struct edge_list *)); | |
396 | void verify_edge_list PARAMS ((FILE *, struct edge_list *)); | |
397 | int find_edge_index PARAMS ((struct edge_list *, | |
398 | basic_block, basic_block)); | |
410538ea | 399 | |
3d994c6b KG |
400 | extern void compute_flow_dominators PARAMS ((sbitmap *, sbitmap *)); |
401 | extern void compute_immediate_dominators PARAMS ((int *, sbitmap *)); | |
077692c6 | 402 | |
49c3bb12 | 403 | |
d3a923ee RH |
404 | enum update_life_extent |
405 | { | |
715e7fbc RH |
406 | UPDATE_LIFE_LOCAL = 0, |
407 | UPDATE_LIFE_GLOBAL = 1, | |
5a425893 | 408 | UPDATE_LIFE_GLOBAL_RM_NOTES = 2 |
d3a923ee RH |
409 | }; |
410 | ||
49c3bb12 RH |
411 | /* Flags for life_analysis and update_life_info. */ |
412 | ||
413 | #define PROP_DEATH_NOTES 1 /* Create DEAD and UNUSED notes. */ | |
414 | #define PROP_LOG_LINKS 2 /* Create LOG_LINKS. */ | |
415 | #define PROP_REG_INFO 4 /* Update regs_ever_live et al. */ | |
416 | #define PROP_KILL_DEAD_CODE 8 /* Remove dead code. */ | |
417 | #define PROP_SCAN_DEAD_CODE 16 /* Scan for dead code. */ | |
418 | #define PROP_AUTOINC 32 /* Create autoinc mem references. */ | |
419 | #define PROP_FINAL 63 /* All of the above. */ | |
420 | ||
3d994c6b KG |
421 | extern void update_life_info PARAMS ((sbitmap, enum update_life_extent, |
422 | int)); | |
423 | extern int count_or_remove_death_notes PARAMS ((sbitmap, int)); | |
d3a923ee | 424 | |
077692c6 | 425 | /* In lcm.c */ |
3d994c6b KG |
426 | extern struct edge_list *pre_edge_lcm PARAMS ((FILE *, int, sbitmap *, |
427 | sbitmap *, sbitmap *, | |
428 | sbitmap *, sbitmap **, | |
429 | sbitmap **)); | |
430 | extern struct edge_list *pre_edge_rev_lcm PARAMS ((FILE *, int, sbitmap *, | |
431 | sbitmap *, sbitmap *, | |
432 | sbitmap *, sbitmap **, | |
433 | sbitmap **)); | |
434 | extern void compute_available PARAMS ((sbitmap *, sbitmap *, | |
435 | sbitmap *, sbitmap *)); | |
a05924f9 JH |
436 | |
437 | /* In emit-rtl.c. */ | |
3d994c6b KG |
438 | extern rtx emit_block_insn_after PARAMS ((rtx, rtx, basic_block)); |
439 | extern rtx emit_block_insn_before PARAMS ((rtx, rtx, basic_block)); | |
4dc9341c | 440 | |
f1ebdfc5 JE |
441 | /* In predict.c */ |
442 | extern void estimate_probability PARAMS ((struct loops *)); | |
443 | ||
4dc9341c | 444 | #endif /* _BASIC_BLOCK_H */ |