OSDN Git Service

PR rtl-optimization/20756:
[pf3gnuchains/gcc-fork.git] / gcc / basic-block.h
1 /* Define control and data flow tables, and regsets.
2    Copyright (C) 1987, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
3    Free Software Foundation, Inc.
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
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.  */
21
22 #ifndef GCC_BASIC_BLOCK_H
23 #define GCC_BASIC_BLOCK_H
24
25 #include "bitmap.h"
26 #include "sbitmap.h"
27 #include "varray.h"
28 #include "partition.h"
29 #include "hard-reg-set.h"
30 #include "predict.h"
31 #include "vec.h"
32 #include "errors.h"
33 #include "function.h"
34
35 /* Head of register set linked list.  */
36 typedef bitmap_head regset_head;
37
38 /* A pointer to a regset_head.  */
39 typedef bitmap regset;
40
41 /* Allocate a register set with oballoc.  */
42 #define ALLOC_REG_SET(OBSTACK) BITMAP_ALLOC (OBSTACK)
43
44 /* Do any cleanup needed on a regset when it is no longer used.  */
45 #define FREE_REG_SET(REGSET) BITMAP_FREE (REGSET)
46
47 /* Initialize a new regset.  */
48 #define INIT_REG_SET(HEAD) bitmap_initialize (HEAD, &reg_obstack)
49
50 /* Clear a register set by freeing up the linked list.  */
51 #define CLEAR_REG_SET(HEAD) bitmap_clear (HEAD)
52
53 /* Copy a register set to another register set.  */
54 #define COPY_REG_SET(TO, FROM) bitmap_copy (TO, FROM)
55
56 /* Compare two register sets.  */
57 #define REG_SET_EQUAL_P(A, B) bitmap_equal_p (A, B)
58
59 /* `and' a register set with a second register set.  */
60 #define AND_REG_SET(TO, FROM) bitmap_and_into (TO, FROM)
61
62 /* `and' the complement of a register set with a register set.  */
63 #define AND_COMPL_REG_SET(TO, FROM) bitmap_and_compl_into (TO, FROM)
64
65 /* Inclusive or a register set with a second register set.  */
66 #define IOR_REG_SET(TO, FROM) bitmap_ior_into (TO, FROM)
67
68 /* Exclusive or a register set with a second register set.  */
69 #define XOR_REG_SET(TO, FROM) bitmap_xor_into (TO, FROM)
70
71 /* Or into TO the register set FROM1 `and'ed with the complement of FROM2.  */
72 #define IOR_AND_COMPL_REG_SET(TO, FROM1, FROM2) \
73   bitmap_ior_and_compl_into (TO, FROM1, FROM2)
74
75 /* Clear a single register in a register set.  */
76 #define CLEAR_REGNO_REG_SET(HEAD, REG) bitmap_clear_bit (HEAD, REG)
77
78 /* Set a single register in a register set.  */
79 #define SET_REGNO_REG_SET(HEAD, REG) bitmap_set_bit (HEAD, REG)
80
81 /* Return true if a register is set in a register set.  */
82 #define REGNO_REG_SET_P(TO, REG) bitmap_bit_p (TO, REG)
83
84 /* Copy the hard registers in a register set to the hard register set.  */
85 extern void reg_set_to_hard_reg_set (HARD_REG_SET *, bitmap);
86 #define REG_SET_TO_HARD_REG_SET(TO, FROM)                               \
87 do {                                                                    \
88   CLEAR_HARD_REG_SET (TO);                                              \
89   reg_set_to_hard_reg_set (&TO, FROM);                                  \
90 } while (0)
91
92 typedef bitmap_iterator reg_set_iterator;
93
94 /* Loop over all registers in REGSET, starting with MIN, setting REGNUM to the
95    register number and executing CODE for all registers that are set.  */
96 #define EXECUTE_IF_SET_IN_REG_SET(REGSET, MIN, REGNUM, RSI)     \
97   EXECUTE_IF_SET_IN_BITMAP (REGSET, MIN, REGNUM, RSI)
98
99 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
100    REGNUM to the register number and executing CODE for all registers that are
101    set in the first regset and not set in the second.  */
102 #define EXECUTE_IF_AND_COMPL_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, RSI) \
103   EXECUTE_IF_AND_COMPL_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, RSI)
104
105 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
106    REGNUM to the register number and executing CODE for all registers that are
107    set in both regsets.  */
108 #define EXECUTE_IF_AND_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, RSI) \
109   EXECUTE_IF_AND_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, RSI) \
110
111 /* Type we use to hold basic block counters.  Should be at least
112    64bit.  Although a counter cannot be negative, we use a signed
113    type, because erroneous negative counts can be generated when the
114    flow graph is manipulated by various optimizations.  A signed type
115    makes those easy to detect.  */
116 typedef HOST_WIDEST_INT gcov_type;
117
118 /* Control flow edge information.  */
119 struct edge_def GTY(())
120 {
121   /* The two blocks at the ends of the edge.  */
122   struct basic_block_def *src;
123   struct basic_block_def *dest;
124
125   /* Instructions queued on the edge.  */
126   union edge_def_insns {
127     rtx GTY ((tag ("0"))) r;
128     tree GTY ((tag ("1"))) t;
129   } GTY ((desc ("ir_type ()"))) insns;
130
131   /* Auxiliary info specific to a pass.  */
132   PTR GTY ((skip (""))) aux;
133
134   /* Location of any goto implicit in the edge, during tree-ssa.  */
135   source_locus goto_locus;
136
137   int flags;                    /* see EDGE_* below  */
138   int probability;              /* biased by REG_BR_PROB_BASE */
139   gcov_type count;              /* Expected number of executions calculated
140                                    in profile.c  */
141
142   /* The index number corresponding to this edge in the edge vector
143      dest->preds.  */
144   unsigned int dest_idx;
145 };
146
147 typedef struct edge_def *edge;
148 DEF_VEC_P(edge);
149 DEF_VEC_ALLOC_P(edge,gc);
150
151 #define EDGE_FALLTHRU           1       /* 'Straight line' flow */
152 #define EDGE_ABNORMAL           2       /* Strange flow, like computed
153                                            label, or eh */
154 #define EDGE_ABNORMAL_CALL      4       /* Call with abnormal exit
155                                            like an exception, or sibcall */
156 #define EDGE_EH                 8       /* Exception throw */
157 #define EDGE_FAKE               16      /* Not a real edge (profile.c) */
158 #define EDGE_DFS_BACK           32      /* A backwards edge */
159 #define EDGE_CAN_FALLTHRU       64      /* Candidate for straight line
160                                            flow.  */
161 #define EDGE_IRREDUCIBLE_LOOP   128     /* Part of irreducible loop.  */
162 #define EDGE_SIBCALL            256     /* Edge from sibcall to exit.  */
163 #define EDGE_LOOP_EXIT          512     /* Exit of a loop.  */
164 #define EDGE_TRUE_VALUE         1024    /* Edge taken when controlling
165                                            predicate is nonzero.  */
166 #define EDGE_FALSE_VALUE        2048    /* Edge taken when controlling
167                                            predicate is zero.  */
168 #define EDGE_EXECUTABLE         4096    /* Edge is executable.  Only
169                                            valid during SSA-CCP.  */
170 #define EDGE_CROSSING           8192    /* Edge crosses between hot
171                                            and cold sections, when we
172                                            do partitioning.  */
173 #define EDGE_ALL_FLAGS         16383
174
175 #define EDGE_COMPLEX    (EDGE_ABNORMAL | EDGE_ABNORMAL_CALL | EDGE_EH)
176
177 /* Counter summary from the last set of coverage counts read by
178    profile.c.  */
179 extern const struct gcov_ctr_summary *profile_info;
180
181 /* Declared in cfgloop.h.  */
182 struct loop;
183 struct loops;
184
185 /* Declared in tree-flow.h.  */
186 struct bb_ann_d;
187
188 /* A basic block is a sequence of instructions with only entry and
189    only one exit.  If any one of the instructions are executed, they
190    will all be executed, and in sequence from first to last.
191
192    There may be COND_EXEC instructions in the basic block.  The
193    COND_EXEC *instructions* will be executed -- but if the condition
194    is false the conditionally executed *expressions* will of course
195    not be executed.  We don't consider the conditionally executed
196    expression (which might have side-effects) to be in a separate
197    basic block because the program counter will always be at the same
198    location after the COND_EXEC instruction, regardless of whether the
199    condition is true or not.
200
201    Basic blocks need not start with a label nor end with a jump insn.
202    For example, a previous basic block may just "conditionally fall"
203    into the succeeding basic block, and the last basic block need not
204    end with a jump insn.  Block 0 is a descendant of the entry block.
205
206    A basic block beginning with two labels cannot have notes between
207    the labels.
208
209    Data for jump tables are stored in jump_insns that occur in no
210    basic block even though these insns can follow or precede insns in
211    basic blocks.  */
212
213 /* Basic block information indexed by block number.  */
214 struct basic_block_def GTY((chain_next ("%h.next_bb"), chain_prev ("%h.prev_bb")))
215 {
216   /* The first and last insns of the block.  */
217   rtx head_;
218   rtx end_;
219
220   /* Pointers to the first and last trees of the block.  */
221   tree stmt_list;
222
223   /* The edges into and out of the block.  */
224   VEC(edge,gc) *preds;
225   VEC(edge,gc) *succs;
226
227   /* The registers that are live on entry to this block.  */
228   bitmap GTY ((skip (""))) global_live_at_start;
229
230   /* The registers that are live on exit from this block.  */
231   bitmap GTY ((skip (""))) global_live_at_end;
232
233   /* Auxiliary info specific to a pass.  */
234   PTR GTY ((skip (""))) aux;
235
236   /* Innermost loop containing the block.  */
237   struct loop * GTY ((skip (""))) loop_father;
238
239   /* The dominance and postdominance information node.  */
240   struct et_node * GTY ((skip (""))) dom[2];
241
242   /* Previous and next blocks in the chain.  */
243   struct basic_block_def *prev_bb;
244   struct basic_block_def *next_bb;
245
246   /* The data used by basic block copying and reordering functions.  */
247   struct reorder_block_def * rbi;
248
249   /* Annotations used at the tree level.  */
250   struct bb_ann_d *tree_annotations;
251
252   /* Expected number of executions: calculated in profile.c.  */
253   gcov_type count;
254
255   /* The index of this block.  */
256   int index;
257
258   /* The loop depth of this block.  */
259   int loop_depth;
260
261   /* Expected frequency.  Normalized to be in range 0 to BB_FREQ_MAX.  */
262   int frequency;
263
264   /* Various flags.  See BB_* below.  */
265   int flags;
266
267   /* Which section block belongs in, when partitioning basic blocks.  */
268   int partition;
269 };
270
271 typedef struct basic_block_def *basic_block;
272
273 /* Structure to hold information about the blocks during reordering and
274    copying.  Needs to be put on a diet.  */
275
276 struct reorder_block_def GTY(())
277 {
278   rtx header;
279   rtx footer;
280
281   basic_block next;
282
283   /* These pointers may be unreliable as the first is only used for
284      debugging (and should probably be removed, and the second is only
285      used by copying.  The basic blocks pointed to may be removed and
286      that leaves these pointers pointing to garbage.  */
287   basic_block GTY ((skip (""))) original;
288   basic_block GTY ((skip (""))) copy;
289
290   int duplicated;
291   int copy_number;
292
293   /* This field is used by the bb-reorder and tracer passes.  */
294   int visited;
295 };
296
297 typedef struct reorder_block_def *reorder_block_def;
298
299 #define BB_FREQ_MAX 10000
300
301 /* Masks for basic_block.flags.
302
303    BB_HOT_PARTITION and BB_COLD_PARTITION should be preserved throughout
304    the compilation, so they are never cleared.
305
306    All other flags may be cleared by clear_bb_flags().  It is generally
307    a bad idea to rely on any flags being up-to-date.  */
308
309 enum
310 {
311
312   /* Set if insns in BB have are modified.  Used for updating liveness info.  */
313   BB_DIRTY = 1,
314
315   /* Only set on blocks that have just been created by create_bb.  */
316   BB_NEW = 2,
317
318   /* Set by find_unreachable_blocks.  Do not rely on this being set in any
319      pass.  */
320   BB_REACHABLE = 4,
321
322   /* Set for blocks in an irreducible loop by loop analysis.  */
323   BB_IRREDUCIBLE_LOOP = 8,
324
325   /* Set on blocks that may actually not be single-entry single-exit block.  */
326   BB_SUPERBLOCK = 16,
327
328   /* Set on basic blocks that the scheduler should not touch.  This is used
329      by SMS to prevent other schedulers from messing with the loop schedule.  */
330   BB_DISABLE_SCHEDULE = 32,
331
332   /* Set on blocks that should be put in a hot section.  */
333   BB_HOT_PARTITION = 64,
334
335   /* Set on blocks that should be put in a cold section.  */
336   BB_COLD_PARTITION = 128
337 };
338
339 /* Dummy flag for convenience in the hot/cold partitioning code.  */
340 #define BB_UNPARTITIONED        0
341
342 /* Partitions, to be used when partitioning hot and cold basic blocks into
343    separate sections.  */
344 #define BB_PARTITION(bb) ((bb)->flags & (BB_HOT_PARTITION|BB_COLD_PARTITION))
345 #define BB_SET_PARTITION(bb, part) do {                                 \
346   basic_block bb_ = (bb);                                               \
347   bb_->flags = ((bb_->flags & ~(BB_HOT_PARTITION|BB_COLD_PARTITION))    \
348                 | (part));                                              \
349 } while (0)
350
351 #define BB_COPY_PARTITION(dstbb, srcbb) \
352   BB_SET_PARTITION (dstbb, BB_PARTITION (srcbb))
353
354 /* A structure to group all the per-function control flow graph data.
355    The x_* prefixing is necessary because otherwise references to the
356    fields of this struct are interpreted as the defines for backward
357    source compatibility following the definition of this struct.  */
358 struct control_flow_graph GTY(())
359 {
360   /* Block pointers for the exit and entry of a function.
361      These are always the head and tail of the basic block list.  */
362   basic_block x_entry_block_ptr;
363   basic_block x_exit_block_ptr;
364
365   /* Index by basic block number, get basic block struct info.  */
366   varray_type x_basic_block_info;
367
368   /* Number of basic blocks in this flow graph.  */
369   int x_n_basic_blocks;
370
371   /* Number of edges in this flow graph.  */
372   int x_n_edges;
373
374   /* The first free basic block number.  */
375   int x_last_basic_block;
376
377   /* Mapping of labels to their associated blocks.  At present
378      only used for the tree CFG.  */
379   varray_type x_label_to_block_map;
380
381   enum profile_status {
382     PROFILE_ABSENT,
383     PROFILE_GUESSED,
384     PROFILE_READ
385   } x_profile_status;
386 };
387
388 /* Defines for accessing the fields of the CFG structure for function FN.  */
389 #define ENTRY_BLOCK_PTR_FOR_FUNCTION(FN)     ((FN)->cfg->x_entry_block_ptr)
390 #define EXIT_BLOCK_PTR_FOR_FUNCTION(FN)      ((FN)->cfg->x_exit_block_ptr)
391 #define basic_block_info_for_function(FN)    ((FN)->cfg->x_basic_block_info)
392 #define n_basic_blocks_for_function(FN)      ((FN)->cfg->x_n_basic_blocks)
393 #define n_edges_for_function(FN)             ((FN)->cfg->x_n_edges)
394 #define last_basic_block_for_function(FN)    ((FN)->cfg->x_last_basic_block)
395 #define label_to_block_map_for_function(FN)  ((FN)->cfg->x_label_to_block_map)
396
397 #define BASIC_BLOCK_FOR_FUNCTION(FN,N) \
398   (VARRAY_BB (basic_block_info_for_function(FN), (N)))
399
400 /* Defines for textual backward source compatibility.  */
401 #define ENTRY_BLOCK_PTR         (cfun->cfg->x_entry_block_ptr)
402 #define EXIT_BLOCK_PTR          (cfun->cfg->x_exit_block_ptr)
403 #define basic_block_info        (cfun->cfg->x_basic_block_info)
404 #define n_basic_blocks          (cfun->cfg->x_n_basic_blocks)
405 #define n_edges                 (cfun->cfg->x_n_edges)
406 #define last_basic_block        (cfun->cfg->x_last_basic_block)
407 #define label_to_block_map      (cfun->cfg->x_label_to_block_map)
408 #define profile_status          (cfun->cfg->x_profile_status)
409
410 #define BASIC_BLOCK(N)          (VARRAY_BB (basic_block_info, (N)))
411
412 /* TRUE if we should re-run loop discovery after threading jumps, FALSE
413    otherwise.  */
414 extern bool rediscover_loops_after_threading;
415
416 /* For iterating over basic blocks.  */
417 #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \
418   for (BB = FROM; BB != TO; BB = BB->DIR)
419
420 #define FOR_EACH_BB_FN(BB, FN) \
421   FOR_BB_BETWEEN (BB, (FN)->cfg->x_entry_block_ptr->next_bb, (FN)->cfg->x_exit_block_ptr, next_bb)
422
423 #define FOR_EACH_BB(BB) FOR_EACH_BB_FN (BB, cfun)
424
425 #define FOR_EACH_BB_REVERSE_FN(BB, FN) \
426   FOR_BB_BETWEEN (BB, (FN)->cfg->x_exit_block_ptr->prev_bb, (FN)->cfg->x_entry_block_ptr, prev_bb)
427
428 #define FOR_EACH_BB_REVERSE(BB) FOR_EACH_BB_REVERSE_FN(BB, cfun)
429
430 /* For iterating over insns in basic block.  */
431 #define FOR_BB_INSNS(BB, INSN)                  \
432   for ((INSN) = BB_HEAD (BB);                   \
433        (INSN) != NEXT_INSN (BB_END (BB));       \
434        (INSN) = NEXT_INSN (INSN))
435
436 #define FOR_BB_INSNS_REVERSE(BB, INSN)          \
437   for ((INSN) = BB_END (BB);                    \
438        (INSN) != PREV_INSN (BB_HEAD (BB));      \
439        (INSN) = PREV_INSN (INSN))
440
441 /* Cycles through _all_ basic blocks, even the fake ones (entry and
442    exit block).  */
443
444 #define FOR_ALL_BB(BB) \
445   for (BB = ENTRY_BLOCK_PTR; BB; BB = BB->next_bb)
446
447 #define FOR_ALL_BB_FN(BB, FN) \
448   for (BB = ENTRY_BLOCK_PTR_FOR_FUNCTION (FN); BB; BB = BB->next_bb)
449
450 /* Special labels found during CFG build.  */
451
452 extern GTY(()) rtx label_value_list;
453
454 extern bitmap_obstack reg_obstack;
455
456 /* Indexed by n, gives number of basic block that  (REG n) is used in.
457    If the value is REG_BLOCK_GLOBAL (-2),
458    it means (REG n) is used in more than one basic block.
459    REG_BLOCK_UNKNOWN (-1) means it hasn't been seen yet so we don't know.
460    This information remains valid for the rest of the compilation
461    of the current function; it is used to control register allocation.  */
462
463 #define REG_BLOCK_UNKNOWN -1
464 #define REG_BLOCK_GLOBAL -2
465
466 #define REG_BASIC_BLOCK(N) (VARRAY_REG (reg_n_info, N)->basic_block)
467 \f
468 /* Stuff for recording basic block info.  */
469
470 #define BB_HEAD(B)      (B)->head_
471 #define BB_END(B)       (B)->end_
472
473 /* Special block numbers [markers] for entry and exit.  */
474 #define ENTRY_BLOCK (-1)
475 #define EXIT_BLOCK (-2)
476
477 /* Special block number not valid for any block.  */
478 #define INVALID_BLOCK (-3)
479
480 #define BLOCK_NUM(INSN)       (BLOCK_FOR_INSN (INSN)->index + 0)
481 #define set_block_for_insn(INSN, BB)  (BLOCK_FOR_INSN (INSN) = BB)
482
483 extern void compute_bb_for_insn (void);
484 extern void free_bb_for_insn (void);
485 extern void update_bb_for_insn (basic_block);
486
487 extern void free_basic_block_vars (void);
488
489 extern void insert_insn_on_edge (rtx, edge);
490 bool safe_insert_insn_on_edge (rtx, edge);
491
492 extern void commit_edge_insertions (void);
493 extern void commit_edge_insertions_watch_calls (void);
494
495 extern void remove_fake_edges (void);
496 extern void remove_fake_exit_edges (void);
497 extern void add_noreturn_fake_exit_edges (void);
498 extern void connect_infinite_loops_to_exit (void);
499 extern edge unchecked_make_edge (basic_block, basic_block, int);
500 extern edge cached_make_edge (sbitmap, basic_block, basic_block, int);
501 extern edge make_edge (basic_block, basic_block, int);
502 extern edge make_single_succ_edge (basic_block, basic_block, int);
503 extern void remove_edge (edge);
504 extern void redirect_edge_succ (edge, basic_block);
505 extern edge redirect_edge_succ_nodup (edge, basic_block);
506 extern void redirect_edge_pred (edge, basic_block);
507 extern basic_block create_basic_block_structure (rtx, rtx, rtx, basic_block);
508 extern void clear_bb_flags (void);
509 extern void flow_reverse_top_sort_order_compute (int *);
510 extern int flow_depth_first_order_compute (int *, int *);
511 extern int dfs_enumerate_from (basic_block, int,
512                                bool (*)(basic_block, void *),
513                                basic_block *, int, void *);
514 extern void compute_dominance_frontiers (bitmap *);
515 extern void dump_edge_info (FILE *, edge, int);
516 extern void brief_dump_cfg (FILE *);
517 extern void clear_edges (void);
518 extern rtx first_insn_after_basic_block_note (basic_block);
519 extern void scale_bbs_frequencies_int (basic_block *, int, int, int);
520 extern void scale_bbs_frequencies_gcov_type (basic_block *, int, gcov_type, 
521                                              gcov_type);
522
523 /* Structure to group all of the information to process IF-THEN and
524    IF-THEN-ELSE blocks for the conditional execution support.  This
525    needs to be in a public file in case the IFCVT macros call
526    functions passing the ce_if_block data structure.  */
527
528 typedef struct ce_if_block
529 {
530   basic_block test_bb;                  /* First test block.  */
531   basic_block then_bb;                  /* THEN block.  */
532   basic_block else_bb;                  /* ELSE block or NULL.  */
533   basic_block join_bb;                  /* Join THEN/ELSE blocks.  */
534   basic_block last_test_bb;             /* Last bb to hold && or || tests.  */
535   int num_multiple_test_blocks;         /* # of && and || basic blocks.  */
536   int num_and_and_blocks;               /* # of && blocks.  */
537   int num_or_or_blocks;                 /* # of || blocks.  */
538   int num_multiple_test_insns;          /* # of insns in && and || blocks.  */
539   int and_and_p;                        /* Complex test is &&.  */
540   int num_then_insns;                   /* # of insns in THEN block.  */
541   int num_else_insns;                   /* # of insns in ELSE block.  */
542   int pass;                             /* Pass number.  */
543
544 #ifdef IFCVT_EXTRA_FIELDS
545   IFCVT_EXTRA_FIELDS                    /* Any machine dependent fields.  */
546 #endif
547
548 } ce_if_block_t;
549
550 /* This structure maintains an edge list vector.  */
551 struct edge_list
552 {
553   int num_blocks;
554   int num_edges;
555   edge *index_to_edge;
556 };
557
558 /* This is the value which indicates no edge is present.  */
559 #define EDGE_INDEX_NO_EDGE      -1
560
561 /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE
562    if there is no edge between the 2 basic blocks.  */
563 #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ)))
564
565 /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic
566    block which is either the pred or succ end of the indexed edge.  */
567 #define INDEX_EDGE_PRED_BB(el, index)   ((el)->index_to_edge[(index)]->src)
568 #define INDEX_EDGE_SUCC_BB(el, index)   ((el)->index_to_edge[(index)]->dest)
569
570 /* INDEX_EDGE returns a pointer to the edge.  */
571 #define INDEX_EDGE(el, index)           ((el)->index_to_edge[(index)])
572
573 /* Number of edges in the compressed edge list.  */
574 #define NUM_EDGES(el)                   ((el)->num_edges)
575
576 /* BB is assumed to contain conditional jump.  Return the fallthru edge.  */
577 #define FALLTHRU_EDGE(bb)               (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
578                                          ? EDGE_SUCC ((bb), 0) : EDGE_SUCC ((bb), 1))
579
580 /* BB is assumed to contain conditional jump.  Return the branch edge.  */
581 #define BRANCH_EDGE(bb)                 (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
582                                          ? EDGE_SUCC ((bb), 1) : EDGE_SUCC ((bb), 0))
583
584 /* Return expected execution frequency of the edge E.  */
585 #define EDGE_FREQUENCY(e)               (((e)->src->frequency \
586                                           * (e)->probability \
587                                           + REG_BR_PROB_BASE / 2) \
588                                          / REG_BR_PROB_BASE)
589
590 /* Return nonzero if edge is critical.  */
591 #define EDGE_CRITICAL_P(e)              (EDGE_COUNT ((e)->src->succs) >= 2 \
592                                          && EDGE_COUNT ((e)->dest->preds) >= 2)
593
594 #define EDGE_COUNT(ev)                  VEC_length (edge, (ev))
595 #define EDGE_I(ev,i)                    VEC_index  (edge, (ev), (i))
596 #define EDGE_PRED(bb,i)                 VEC_index  (edge, (bb)->preds, (i))
597 #define EDGE_SUCC(bb,i)                 VEC_index  (edge, (bb)->succs, (i))
598
599 /* Returns true if BB has precisely one successor.  */
600
601 static inline bool
602 single_succ_p (basic_block bb)
603 {
604   return EDGE_COUNT (bb->succs) == 1;
605 }
606
607 /* Returns true if BB has precisely one predecessor.  */
608
609 static inline bool
610 single_pred_p (basic_block bb)
611 {
612   return EDGE_COUNT (bb->preds) == 1;
613 }
614
615 /* Returns the single successor edge of basic block BB.  Aborts if
616    BB does not have exactly one successor.  */
617
618 static inline edge
619 single_succ_edge (basic_block bb)
620 {
621   gcc_assert (single_succ_p (bb));
622   return EDGE_SUCC (bb, 0);
623 }
624
625 /* Returns the single predecessor edge of basic block BB.  Aborts
626    if BB does not have exactly one predecessor.  */
627
628 static inline edge
629 single_pred_edge (basic_block bb)
630 {
631   gcc_assert (single_pred_p (bb));
632   return EDGE_PRED (bb, 0);
633 }
634
635 /* Returns the single successor block of basic block BB.  Aborts
636    if BB does not have exactly one successor.  */
637
638 static inline basic_block
639 single_succ (basic_block bb)
640 {
641   return single_succ_edge (bb)->dest;
642 }
643
644 /* Returns the single predecessor block of basic block BB.  Aborts
645    if BB does not have exactly one predecessor.*/
646
647 static inline basic_block
648 single_pred (basic_block bb)
649 {
650   return single_pred_edge (bb)->src;
651 }
652
653 /* Iterator object for edges.  */
654
655 typedef struct {
656   unsigned index;
657   VEC(edge,gc) **container;
658 } edge_iterator;
659
660 static inline VEC(edge,gc) *
661 ei_container (edge_iterator i)
662 {
663   gcc_assert (i.container);
664   return *i.container;
665 }
666
667 #define ei_start(iter) ei_start_1 (&(iter))
668 #define ei_last(iter) ei_last_1 (&(iter))
669
670 /* Return an iterator pointing to the start of an edge vector.  */
671 static inline edge_iterator
672 ei_start_1 (VEC(edge,gc) **ev)
673 {
674   edge_iterator i;
675
676   i.index = 0;
677   i.container = ev;
678
679   return i;
680 }
681
682 /* Return an iterator pointing to the last element of an edge
683    vector.  */
684 static inline edge_iterator
685 ei_last_1 (VEC(edge,gc) **ev)
686 {
687   edge_iterator i;
688
689   i.index = EDGE_COUNT (*ev) - 1;
690   i.container = ev;
691
692   return i;
693 }
694
695 /* Is the iterator `i' at the end of the sequence?  */
696 static inline bool
697 ei_end_p (edge_iterator i)
698 {
699   return (i.index == EDGE_COUNT (ei_container (i)));
700 }
701
702 /* Is the iterator `i' at one position before the end of the
703    sequence?  */
704 static inline bool
705 ei_one_before_end_p (edge_iterator i)
706 {
707   return (i.index + 1 == EDGE_COUNT (ei_container (i)));
708 }
709
710 /* Advance the iterator to the next element.  */
711 static inline void
712 ei_next (edge_iterator *i)
713 {
714   gcc_assert (i->index < EDGE_COUNT (ei_container (*i)));
715   i->index++;
716 }
717
718 /* Move the iterator to the previous element.  */
719 static inline void
720 ei_prev (edge_iterator *i)
721 {
722   gcc_assert (i->index > 0);
723   i->index--;
724 }
725
726 /* Return the edge pointed to by the iterator `i'.  */
727 static inline edge
728 ei_edge (edge_iterator i)
729 {
730   return EDGE_I (ei_container (i), i.index);
731 }
732
733 /* Return an edge pointed to by the iterator.  Do it safely so that
734    NULL is returned when the iterator is pointing at the end of the
735    sequence.  */
736 static inline edge
737 ei_safe_edge (edge_iterator i)
738 {
739   return !ei_end_p (i) ? ei_edge (i) : NULL;
740 }
741
742 /* Return 1 if we should continue to iterate.  Return 0 otherwise.
743    *Edge P is set to the next edge if we are to continue to iterate
744    and NULL otherwise.  */
745
746 static inline bool
747 ei_cond (edge_iterator ei, edge *p)
748 {
749   if (!ei_end_p (ei))
750     {
751       *p = ei_edge (ei);
752       return 1;
753     }
754   else
755     {
756       *p = NULL;
757       return 0;
758     }
759 }
760
761 /* This macro serves as a convenient way to iterate each edge in a
762    vector of predecessor or successor edges.  It must not be used when
763    an element might be removed during the traversal, otherwise
764    elements will be missed.  Instead, use a for-loop like that shown
765    in the following pseudo-code:
766    
767    FOR (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
768      {
769         IF (e != taken_edge)
770           remove_edge (e);
771         ELSE
772           ei_next (&ei);
773      }
774 */
775
776 #define FOR_EACH_EDGE(EDGE,ITER,EDGE_VEC)       \
777   for ((ITER) = ei_start ((EDGE_VEC));          \
778        ei_cond ((ITER), &(EDGE));               \
779        ei_next (&(ITER)))
780
781 struct edge_list * create_edge_list (void);
782 void free_edge_list (struct edge_list *);
783 void print_edge_list (FILE *, struct edge_list *);
784 void verify_edge_list (FILE *, struct edge_list *);
785 int find_edge_index (struct edge_list *, basic_block, basic_block);
786 edge find_edge (basic_block, basic_block);
787
788
789 enum update_life_extent
790 {
791   UPDATE_LIFE_LOCAL = 0,
792   UPDATE_LIFE_GLOBAL = 1,
793   UPDATE_LIFE_GLOBAL_RM_NOTES = 2
794 };
795
796 /* Flags for life_analysis and update_life_info.  */
797
798 #define PROP_DEATH_NOTES        1       /* Create DEAD and UNUSED notes.  */
799 #define PROP_LOG_LINKS          2       /* Create LOG_LINKS.  */
800 #define PROP_REG_INFO           4       /* Update regs_ever_live et al.  */
801 #define PROP_KILL_DEAD_CODE     8       /* Remove dead code.  */
802 #define PROP_SCAN_DEAD_CODE     16      /* Scan for dead code.  */
803 #define PROP_ALLOW_CFG_CHANGES  32      /* Allow the CFG to be changed
804                                            by dead code removal.  */
805 #define PROP_AUTOINC            64      /* Create autoinc mem references.  */
806 #define PROP_SCAN_DEAD_STORES   128     /* Scan for dead code.  */
807 #define PROP_ASM_SCAN           256     /* Internal flag used within flow.c
808                                            to flag analysis of asms.  */
809 #define PROP_DEAD_INSN          1024    /* Internal flag used within flow.c
810                                            to flag analysis of dead insn.  */
811 #define PROP_FINAL              (PROP_DEATH_NOTES | PROP_LOG_LINKS  \
812                                  | PROP_REG_INFO | PROP_KILL_DEAD_CODE  \
813                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
814                                  | PROP_ALLOW_CFG_CHANGES \
815                                  | PROP_SCAN_DEAD_STORES)
816 #define PROP_POSTRELOAD         (PROP_DEATH_NOTES  \
817                                  | PROP_KILL_DEAD_CODE  \
818                                  | PROP_SCAN_DEAD_CODE \
819                                  | PROP_SCAN_DEAD_STORES)
820
821 #define CLEANUP_EXPENSIVE       1       /* Do relatively expensive optimizations
822                                            except for edge forwarding */
823 #define CLEANUP_CROSSJUMP       2       /* Do crossjumping.  */
824 #define CLEANUP_POST_REGSTACK   4       /* We run after reg-stack and need
825                                            to care REG_DEAD notes.  */
826 #define CLEANUP_PRE_LOOP        8       /* Take care to preserve syntactic loop
827                                            notes.  */
828 #define CLEANUP_UPDATE_LIFE     16      /* Keep life information up to date.  */
829 #define CLEANUP_THREADING       32      /* Do jump threading.  */
830 #define CLEANUP_NO_INSN_DEL     64      /* Do not try to delete trivially dead
831                                            insns.  */
832 #define CLEANUP_CFGLAYOUT       128     /* Do cleanup in cfglayout mode.  */
833 #define CLEANUP_LOG_LINKS       256     /* Update log links.  */
834
835 extern void life_analysis (FILE *, int);
836 extern int update_life_info (sbitmap, enum update_life_extent, int);
837 extern int update_life_info_in_dirty_blocks (enum update_life_extent, int);
838 extern int count_or_remove_death_notes (sbitmap, int);
839 extern int propagate_block (basic_block, regset, regset, regset, int);
840
841 struct propagate_block_info;
842 extern rtx propagate_one_insn (struct propagate_block_info *, rtx);
843 extern struct propagate_block_info *init_propagate_block_info
844  (basic_block, regset, regset, regset, int);
845 extern void free_propagate_block_info (struct propagate_block_info *);
846
847 /* In lcm.c */
848 extern struct edge_list *pre_edge_lcm (FILE *, int, sbitmap *, sbitmap *,
849                                        sbitmap *, sbitmap *, sbitmap **,
850                                        sbitmap **);
851 extern struct edge_list *pre_edge_rev_lcm (FILE *, int, sbitmap *,
852                                            sbitmap *, sbitmap *,
853                                            sbitmap *, sbitmap **,
854                                            sbitmap **);
855 extern void compute_available (sbitmap *, sbitmap *, sbitmap *, sbitmap *);
856 extern int optimize_mode_switching (FILE *);
857
858 /* In predict.c */
859 extern void estimate_probability (struct loops *);
860 extern void expected_value_to_br_prob (void);
861 extern bool maybe_hot_bb_p (basic_block);
862 extern bool probably_cold_bb_p (basic_block);
863 extern bool probably_never_executed_bb_p (basic_block);
864 extern bool tree_predicted_by_p (basic_block, enum br_predictor);
865 extern bool rtl_predicted_by_p (basic_block, enum br_predictor);
866 extern void tree_predict_edge (edge, enum br_predictor, int);
867 extern void rtl_predict_edge (edge, enum br_predictor, int);
868 extern void predict_edge_def (edge, enum br_predictor, enum prediction);
869 extern void guess_outgoing_edge_probabilities (basic_block);
870
871 /* In flow.c */
872 extern void init_flow (void);
873 extern void debug_bb (basic_block);
874 extern basic_block debug_bb_n (int);
875 extern void dump_regset (regset, FILE *);
876 extern void debug_regset (regset);
877 extern void allocate_reg_life_data (void);
878 extern void expunge_block (basic_block);
879 extern void link_block (basic_block, basic_block);
880 extern void unlink_block (basic_block);
881 extern void compact_blocks (void);
882 extern basic_block alloc_block (void);
883 extern void find_unreachable_blocks (void);
884 extern int delete_noop_moves (void);
885 extern basic_block force_nonfallthru (edge);
886 extern rtx block_label (basic_block);
887 extern bool forwarder_block_p (basic_block);
888 extern bool purge_all_dead_edges (void);
889 extern bool purge_dead_edges (basic_block);
890 extern void find_many_sub_basic_blocks (sbitmap);
891 extern void rtl_make_eh_edge (sbitmap, basic_block, rtx);
892 extern bool can_fallthru (basic_block, basic_block);
893 extern bool could_fall_through (basic_block, basic_block);
894 extern void flow_nodes_print (const char *, const sbitmap, FILE *);
895 extern void flow_edge_list_print (const char *, const edge *, int, FILE *);
896 extern void alloc_aux_for_block (basic_block, int);
897 extern void alloc_aux_for_blocks (int);
898 extern void clear_aux_for_blocks (void);
899 extern void free_aux_for_blocks (void);
900 extern void alloc_aux_for_edge (edge, int);
901 extern void alloc_aux_for_edges (int);
902 extern void clear_aux_for_edges (void);
903 extern void free_aux_for_edges (void);
904 extern void find_basic_blocks (rtx);
905 extern bool cleanup_cfg (int);
906 extern bool delete_unreachable_blocks (void);
907 extern bool merge_seq_blocks (void);
908
909 typedef struct conflict_graph_def *conflict_graph;
910
911 /* Callback function when enumerating conflicts.  The arguments are
912    the smaller and larger regno in the conflict.  Returns zero if
913    enumeration is to continue, nonzero to halt enumeration.  */
914 typedef int (*conflict_graph_enum_fn) (int, int, void *);
915
916
917 /* Prototypes of operations on conflict graphs.  */
918
919 extern conflict_graph conflict_graph_new
920  (int);
921 extern void conflict_graph_delete (conflict_graph);
922 extern int conflict_graph_add (conflict_graph, int, int);
923 extern int conflict_graph_conflict_p (conflict_graph, int, int);
924 extern void conflict_graph_enum (conflict_graph, int, conflict_graph_enum_fn,
925                                  void *);
926 extern void conflict_graph_merge_regs (conflict_graph, int, int);
927 extern void conflict_graph_print (conflict_graph, FILE*);
928 extern bool mark_dfs_back_edges (void);
929 extern void set_edge_can_fallthru_flag (void);
930 extern void update_br_prob_note (basic_block);
931 extern void fixup_abnormal_edges (void);
932 extern bool inside_basic_block_p (rtx);
933 extern bool control_flow_insn_p (rtx);
934
935 /* In bb-reorder.c */
936 extern void reorder_basic_blocks (unsigned int);
937 extern void duplicate_computed_gotos (void);
938 extern void partition_hot_cold_basic_blocks (void);
939
940 /* In cfg.c */
941 extern void initialize_bb_rbi (basic_block bb);
942
943 /* In dominance.c */
944
945 enum cdi_direction
946 {
947   CDI_DOMINATORS,
948   CDI_POST_DOMINATORS
949 };
950
951 enum dom_state
952 {
953   DOM_NONE,             /* Not computed at all.  */
954   DOM_NO_FAST_QUERY,    /* The data is OK, but the fast query data are not usable.  */
955   DOM_OK                /* Everything is ok.  */
956 };
957
958 extern enum dom_state dom_computed[2];
959
960 extern bool dom_info_available_p (enum cdi_direction);
961 extern void calculate_dominance_info (enum cdi_direction);
962 extern void free_dominance_info (enum cdi_direction);
963 extern basic_block nearest_common_dominator (enum cdi_direction,
964                                              basic_block, basic_block);
965 extern basic_block nearest_common_dominator_for_set (enum cdi_direction, 
966                                                      bitmap);
967 extern void set_immediate_dominator (enum cdi_direction, basic_block,
968                                      basic_block);
969 extern basic_block get_immediate_dominator (enum cdi_direction, basic_block);
970 extern bool dominated_by_p (enum cdi_direction, basic_block, basic_block);
971 extern int get_dominated_by (enum cdi_direction, basic_block, basic_block **);
972 extern unsigned get_dominated_by_region (enum cdi_direction, basic_block *,
973                                          unsigned, basic_block *);
974 extern void add_to_dominance_info (enum cdi_direction, basic_block);
975 extern void delete_from_dominance_info (enum cdi_direction, basic_block);
976 basic_block recount_dominator (enum cdi_direction, basic_block);
977 extern void redirect_immediate_dominators (enum cdi_direction, basic_block,
978                                            basic_block);
979 extern void iterate_fix_dominators (enum cdi_direction, basic_block *, int);
980 extern void verify_dominators (enum cdi_direction);
981 extern basic_block first_dom_son (enum cdi_direction, basic_block);
982 extern basic_block next_dom_son (enum cdi_direction, basic_block);
983 extern edge try_redirect_by_replacing_jump (edge, basic_block, bool);
984 extern void break_superblocks (void);
985 extern void check_bb_profile (basic_block, FILE *);
986 extern void update_bb_profile_for_threading (basic_block, int, gcov_type, edge);
987
988 #include "cfghooks.h"
989
990 #endif /* GCC_BASIC_BLOCK_H */