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
   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
  34 /* Head of register set linked list.  */
  35 typedef bitmap_head regset_head;
  36
  37 /* A pointer to a regset_head.  */
  38 typedef bitmap regset;
  39
  40 /* Initialize a new regset.  */
  41 #define INIT_REG_SET(HEAD) bitmap_initialize (HEAD, 1)
  42
  43 /* Clear a register set by freeing up the linked list.  */
  44 #define CLEAR_REG_SET(HEAD) bitmap_clear (HEAD)
  45
  46 /* Copy a register set to another register set.  */
  47 #define COPY_REG_SET(TO, FROM) bitmap_copy (TO, FROM)
  48
  49 /* Compare two register sets.  */
  50 #define REG_SET_EQUAL_P(A, B) bitmap_equal_p (A, B)
  51
  52 /* `and' a register set with a second register set.  */
  53 #define AND_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_AND)
  54
  55 /* `and' the complement of a register set with a register set.  */
  56 #define AND_COMPL_REG_SET(TO, FROM) \
  57   bitmap_operation (TO, TO, FROM, BITMAP_AND_COMPL)
  58
  59 /* Inclusive or a register set with a second register set.  */
  60 #define IOR_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_IOR)
  61
  62 /* Exclusive or a register set with a second register set.  */
  63 #define XOR_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_XOR)
  64
  65 /* Or into TO the register set FROM1 `and'ed with the complement of FROM2.  */
  66 #define IOR_AND_COMPL_REG_SET(TO, FROM1, FROM2) \
  67   bitmap_ior_and_compl (TO, FROM1, FROM2)
  68
  69 /* Clear a single register in a register set.  */
  70 #define CLEAR_REGNO_REG_SET(HEAD, REG) bitmap_clear_bit (HEAD, REG)
  71
  72 /* Set a single register in a register set.  */
  73 #define SET_REGNO_REG_SET(HEAD, REG) bitmap_set_bit (HEAD, REG)
  74
  75 /* Return true if a register is set in a register set.  */
  76 #define REGNO_REG_SET_P(TO, REG) bitmap_bit_p (TO, REG)
  77
  78 /* Copy the hard registers in a register set to the hard register set.  */
  79 extern void reg_set_to_hard_reg_set (HARD_REG_SET *, bitmap);
  80 #define REG_SET_TO_HARD_REG_SET(TO, FROM)                               \
  81 do {                                                                    \
  82   CLEAR_HARD_REG_SET (TO);                                              \
  83   reg_set_to_hard_reg_set (&TO, FROM);                                  \
  84 } while (0)
  85
  86 /* Loop over all registers in REGSET, starting with MIN, setting REGNUM to the
  87    register number and executing CODE for all registers that are set.  */
  88 #define EXECUTE_IF_SET_IN_REG_SET(REGSET, MIN, REGNUM, CODE)            \
  89   EXECUTE_IF_SET_IN_BITMAP (REGSET, MIN, REGNUM, CODE)
  90
  91 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
  92    REGNUM to the register number and executing CODE for all registers that are
  93    set in the first regset and not set in the second.  */
  94 #define EXECUTE_IF_AND_COMPL_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, CODE) \
  95   EXECUTE_IF_AND_COMPL_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, CODE)
  96
  97 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
  98    REGNUM to the register number and executing CODE for all registers that are
  99    set in both regsets.  */
 100 #define EXECUTE_IF_AND_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, CODE) \
 101   EXECUTE_IF_AND_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, CODE)
 102
 103 /* Allocate a register set with oballoc.  */
 104 #define OBSTACK_ALLOC_REG_SET(OBSTACK) BITMAP_OBSTACK_ALLOC (OBSTACK)
 105
 106 /* Initialize a register set.  Returns the new register set.  */
 107 #define INITIALIZE_REG_SET(HEAD) bitmap_initialize (&HEAD, 1)
 108
 109 /* Do any cleanup needed on a regset when it is no longer used.  */
 110 #define FREE_REG_SET(REGSET) BITMAP_FREE(REGSET)
 111
 112 /* Do any one-time initializations needed for regsets.  */
 113 #define INIT_ONCE_REG_SET() BITMAP_INIT_ONCE ()
 114
 115 /* Grow any tables needed when the number of registers is calculated
 116    or extended.  For the linked list allocation, nothing needs to
 117    be done, other than zero the statistics on the first allocation.  */
 118 #define MAX_REGNO_REG_SET(NUM_REGS, NEW_P, RENUMBER_P)
 119
 120 /* Type we use to hold basic block counters.  Should be at least
 121    64bit.  Although a counter cannot be negative, we use a signed
 122    type, because erroneous negative counts can be generated when the
 123    flow graph is manipulated by various optimizations.  A signed type
 124    makes those easy to detect.  */
 125 typedef HOST_WIDEST_INT gcov_type;
 126
 127 /* Control flow edge information.  */
 128 struct edge_def GTY(())
 129 {
 130   /* The two blocks at the ends of the edge.  */
 131   struct basic_block_def *src;
 132   struct basic_block_def *dest;
 133
 134   /* Instructions queued on the edge.  */
 135   union edge_def_insns {
 136     rtx GTY ((tag ("0"))) r;
 137     tree GTY ((tag ("1"))) t;
 138   } GTY ((desc ("ir_type ()"))) insns;
 139
 140   /* Auxiliary info specific to a pass.  */
 141   PTR GTY ((skip (""))) aux;
 142
 143   /* Location of any goto implicit in the edge, during tree-ssa.  */
 144   source_locus goto_locus;
 145
 146   int flags;                    /* see EDGE_* below  */
 147   int probability;              /* biased by REG_BR_PROB_BASE */
 148   gcov_type count;              /* Expected number of executions calculated
 149                                    in profile.c  */
 150   bool crossing_edge;           /* Crosses between hot and cold sections, when
 151                                    we do partitioning.  */
 152 };
 153
 154 typedef struct edge_def *edge;
 155 DEF_VEC_P(edge);
 156
 157 struct edge_stack
 158 {
 159   VEC(edge) *ev;
 160   unsigned ix;
 161 };
 162
 163 #define EDGE_FALLTHRU           1       /* 'Straight line' flow */
 164 #define EDGE_ABNORMAL           2       /* Strange flow, like computed
 165                                            label, or eh */
 166 #define EDGE_ABNORMAL_CALL      4       /* Call with abnormal exit
 167                                            like an exception, or sibcall */
 168 #define EDGE_EH                 8       /* Exception throw */
 169 #define EDGE_FAKE               16      /* Not a real edge (profile.c) */
 170 #define EDGE_DFS_BACK           32      /* A backwards edge */
 171 #define EDGE_CAN_FALLTHRU       64      /* Candidate for straight line
 172                                            flow.  */
 173 #define EDGE_IRREDUCIBLE_LOOP   128     /* Part of irreducible loop.  */
 174 #define EDGE_SIBCALL            256     /* Edge from sibcall to exit.  */
 175 #define EDGE_LOOP_EXIT          512     /* Exit of a loop.  */
 176 #define EDGE_TRUE_VALUE         1024    /* Edge taken when controlling
 177                                            predicate is non zero.  */
 178 #define EDGE_FALSE_VALUE        2048    /* Edge taken when controlling
 179                                            predicate is zero.  */
 180 #define EDGE_EXECUTABLE         4096    /* Edge is executable.  Only
 181                                            valid during SSA-CCP.  */
 182 #define EDGE_ALL_FLAGS          8191
 183
 184 #define EDGE_COMPLEX    (EDGE_ABNORMAL | EDGE_ABNORMAL_CALL | EDGE_EH)
 185
 186 /* Counter summary from the last set of coverage counts read by
 187    profile.c.  */
 188 extern const struct gcov_ctr_summary *profile_info;
 189
 190 /* Declared in cfgloop.h.  */
 191 struct loop;
 192 struct loops;
 193
 194 /* Declared in tree-flow.h.  */
 195 struct bb_ann_d;
 196
 197 /* A basic block is a sequence of instructions with only entry and
 198    only one exit.  If any one of the instructions are executed, they
 199    will all be executed, and in sequence from first to last.
 200
 201    There may be COND_EXEC instructions in the basic block.  The
 202    COND_EXEC *instructions* will be executed -- but if the condition
 203    is false the conditionally executed *expressions* will of course
 204    not be executed.  We don't consider the conditionally executed
 205    expression (which might have side-effects) to be in a separate
 206    basic block because the program counter will always be at the same
 207    location after the COND_EXEC instruction, regardless of whether the
 208    condition is true or not.
 209
 210    Basic blocks need not start with a label nor end with a jump insn.
 211    For example, a previous basic block may just "conditionally fall"
 212    into the succeeding basic block, and the last basic block need not
 213    end with a jump insn.  Block 0 is a descendant of the entry block.
 214
 215    A basic block beginning with two labels cannot have notes between
 216    the labels.
 217
 218    Data for jump tables are stored in jump_insns that occur in no
 219    basic block even though these insns can follow or precede insns in
 220    basic blocks.  */
 221
 222 /* Basic block information indexed by block number.  */
 223 struct basic_block_def GTY((chain_next ("%h.next_bb"), chain_prev ("%h.prev_bb")))
 224 {
 225   /* The first and last insns of the block.  */
 226   rtx head_;
 227   rtx end_;
 228
 229   /* Pointers to the first and last trees of the block.  */
 230   tree stmt_list;
 231
 232   /* The edges into and out of the block.  */
 233   VEC(edge) *preds;
 234   VEC(edge) *succs;
 235
 236   /* Liveness info.  */
 237
 238   /* The registers that are modified within this in block.  */
 239   bitmap GTY ((skip (""))) local_set;
 240   /* The registers that are conditionally modified within this block.
 241      In other words, registers that are set only as part of a
 242      COND_EXEC.  */
 243   bitmap GTY ((skip (""))) cond_local_set;
 244   /* The registers that are live on entry to this block.
 245
 246      Note that in SSA form, global_live_at_start does not reflect the
 247      use of regs in phi functions, since the liveness of these regs
 248      may depend on which edge was taken into the block.  */
 249   bitmap GTY ((skip (""))) global_live_at_start;
 250   /* The registers that are live on exit from this block.  */
 251   bitmap GTY ((skip (""))) global_live_at_end;
 252
 253   /* Auxiliary info specific to a pass.  */
 254   PTR GTY ((skip (""))) aux;
 255
 256   /* The index of this block.  */
 257   int index;
 258
 259   /* Previous and next blocks in the chain.  */
 260   struct basic_block_def *prev_bb;
 261   struct basic_block_def *next_bb;
 262
 263   /* The loop depth of this block.  */
 264   int loop_depth;
 265
 266   /* Innermost loop containing the block.  */
 267   struct loop * GTY ((skip (""))) loop_father;
 268
 269   /* The dominance and postdominance information node.  */
 270   struct et_node * GTY ((skip (""))) dom[2];
 271
 272   /* Expected number of executions: calculated in profile.c.  */
 273   gcov_type count;
 274
 275   /* Expected frequency.  Normalized to be in range 0 to BB_FREQ_MAX.  */
 276   int frequency;
 277
 278   /* Various flags.  See BB_* below.  */
 279   int flags;
 280
 281   /* Which section block belongs in, when partitioning basic blocks.  */
 282   int partition;
 283
 284   /* The data used by basic block copying and reordering functions.  */
 285   struct reorder_block_def * GTY ((skip (""))) rbi;
 286
 287   /* Annotations used at the tree level.  */
 288   struct bb_ann_d *tree_annotations;
 289 };
 290
 291 typedef struct basic_block_def *basic_block;
 292
 293 /* Structure to hold information about the blocks during reordering and
 294    copying.  */
 295
 296 typedef struct reorder_block_def
 297 {
 298   rtx header;
 299   rtx footer;
 300   basic_block next;
 301   basic_block original;
 302   /* Used by loop copying.  */
 303   basic_block copy;
 304   int duplicated;
 305
 306   /* These fields are used by bb-reorder pass.  */
 307   int visited;
 308 } *reorder_block_def_p;
 309
 310 #define BB_FREQ_MAX 10000
 311
 312 /* Masks for basic_block.flags.  */
 313 #define BB_DIRTY                1
 314 #define BB_NEW                  2
 315 #define BB_REACHABLE            4
 316 #define BB_VISITED              8
 317 #define BB_IRREDUCIBLE_LOOP     16
 318 #define BB_SUPERBLOCK           32
 319
 320 /* Partitions, to be used when partitioning hot and cold basic blocks into
 321    separate sections.  */
 322 #define UNPARTITIONED   0
 323 #define HOT_PARTITION   1
 324 #define COLD_PARTITION  2
 325
 326 /* Number of basic blocks in the current function.  */
 327
 328 extern int n_basic_blocks;
 329
 330 /* First free basic block number.  */
 331
 332 extern int last_basic_block;
 333
 334 /* Number of edges in the current function.  */
 335
 336 extern int n_edges;
 337
 338 /* Index by basic block number, get basic block struct info.  */
 339
 340 extern GTY(()) varray_type basic_block_info;
 341
 342 #define BASIC_BLOCK(N)  (VARRAY_BB (basic_block_info, (N)))
 343
 344 /* For iterating over basic blocks.  */
 345 #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \
 346   for (BB = FROM; BB != TO; BB = BB->DIR)
 347
 348 #define FOR_EACH_BB(BB) \
 349   FOR_BB_BETWEEN (BB, ENTRY_BLOCK_PTR->next_bb, EXIT_BLOCK_PTR, next_bb)
 350
 351 #define FOR_EACH_BB_REVERSE(BB) \
 352   FOR_BB_BETWEEN (BB, EXIT_BLOCK_PTR->prev_bb, ENTRY_BLOCK_PTR, prev_bb)
 353
 354 /* For iterating over insns in basic block.  */
 355 #define FOR_BB_INSNS(BB, INSN)                  \
 356   for ((INSN) = BB_HEAD (BB);                   \
 357        (INSN) != NEXT_INSN (BB_END (BB));       \
 358        (INSN) = NEXT_INSN (INSN))
 359
 360 #define FOR_BB_INSNS_REVERSE(BB, INSN)          \
 361   for ((INSN) = BB_END (BB);                    \
 362        (INSN) != PREV_INSN (BB_HEAD (BB));      \
 363        (INSN) = PREV_INSN (INSN))
 364
 365 /* Cycles through _all_ basic blocks, even the fake ones (entry and
 366    exit block).  */
 367
 368 #define FOR_ALL_BB(BB) \
 369   for (BB = ENTRY_BLOCK_PTR; BB; BB = BB->next_bb)
 370
 371 /* What registers are live at the setjmp call.  */
 372
 373 extern regset regs_live_at_setjmp;
 374
 375 /* Special labels found during CFG build.  */
 376
 377 extern GTY(()) rtx label_value_list;
 378
 379 extern struct obstack flow_obstack;
 380
 381 /* Indexed by n, gives number of basic block that  (REG n) is used in.
 382    If the value is REG_BLOCK_GLOBAL (-2),
 383    it means (REG n) is used in more than one basic block.
 384    REG_BLOCK_UNKNOWN (-1) means it hasn't been seen yet so we don't know.
 385    This information remains valid for the rest of the compilation
 386    of the current function; it is used to control register allocation.  */
 387
 388 #define REG_BLOCK_UNKNOWN -1
 389 #define REG_BLOCK_GLOBAL -2
 390
 391 #define REG_BASIC_BLOCK(N) (VARRAY_REG (reg_n_info, N)->basic_block)
 392 \f
 393 /* Stuff for recording basic block info.  */
 394
 395 #define BB_HEAD(B)      (B)->head_
 396 #define BB_END(B)       (B)->end_
 397
 398 /* Special block numbers [markers] for entry and exit.  */
 399 #define ENTRY_BLOCK (-1)
 400 #define EXIT_BLOCK (-2)
 401
 402 /* Special block number not valid for any block.  */
 403 #define INVALID_BLOCK (-3)
 404
 405 /* Similarly, block pointers for the edge list.  */
 406 extern GTY(()) basic_block ENTRY_BLOCK_PTR;
 407 extern GTY(()) basic_block EXIT_BLOCK_PTR;
 408
 409 #define BLOCK_NUM(INSN)       (BLOCK_FOR_INSN (INSN)->index + 0)
 410 #define set_block_for_insn(INSN, BB)  (BLOCK_FOR_INSN (INSN) = BB)
 411
 412 extern void compute_bb_for_insn (void);
 413 extern void free_bb_for_insn (void);
 414 extern void update_bb_for_insn (basic_block);
 415
 416 extern void free_basic_block_vars (void);
 417
 418 extern void insert_insn_on_edge (rtx, edge);
 419 bool safe_insert_insn_on_edge (rtx, edge);
 420
 421 extern void commit_edge_insertions (void);
 422 extern void commit_edge_insertions_watch_calls (void);
 423
 424 extern void remove_fake_edges (void);
 425 extern void remove_fake_exit_edges (void);
 426 extern void add_noreturn_fake_exit_edges (void);
 427 extern void connect_infinite_loops_to_exit (void);
 428 extern edge unchecked_make_edge (basic_block, basic_block, int);
 429 extern edge cached_make_edge (sbitmap *, basic_block, basic_block, int);
 430 extern edge make_edge (basic_block, basic_block, int);
 431 extern edge make_single_succ_edge (basic_block, basic_block, int);
 432 extern void remove_edge (edge);
 433 extern void redirect_edge_succ (edge, basic_block);
 434 extern edge redirect_edge_succ_nodup (edge, basic_block);
 435 extern void redirect_edge_pred (edge, basic_block);
 436 extern basic_block create_basic_block_structure (rtx, rtx, rtx, basic_block);
 437 extern void clear_bb_flags (void);
 438 extern void flow_reverse_top_sort_order_compute (int *);
 439 extern int flow_depth_first_order_compute (int *, int *);
 440 extern void flow_preorder_transversal_compute (int *);
 441 extern int dfs_enumerate_from (basic_block, int,
 442                                bool (*)(basic_block, void *),
 443                                basic_block *, int, void *);
 444 extern void dump_edge_info (FILE *, edge, int);
 445 extern void brief_dump_cfg (FILE *);
 446 extern void clear_edges (void);
 447 extern void mark_critical_edges (void);
 448 extern rtx first_insn_after_basic_block_note (basic_block);
 449
 450 /* Structure to group all of the information to process IF-THEN and
 451    IF-THEN-ELSE blocks for the conditional execution support.  This
 452    needs to be in a public file in case the IFCVT macros call
 453    functions passing the ce_if_block data structure.  */
 454
 455 typedef struct ce_if_block
 456 {
 457   basic_block test_bb;                  /* First test block.  */
 458   basic_block then_bb;                  /* THEN block.  */
 459   basic_block else_bb;                  /* ELSE block or NULL.  */
 460   basic_block join_bb;                  /* Join THEN/ELSE blocks.  */
 461   basic_block last_test_bb;             /* Last bb to hold && or || tests.  */
 462   int num_multiple_test_blocks;         /* # of && and || basic blocks.  */
 463   int num_and_and_blocks;               /* # of && blocks.  */
 464   int num_or_or_blocks;                 /* # of || blocks.  */
 465   int num_multiple_test_insns;          /* # of insns in && and || blocks.  */
 466   int and_and_p;                        /* Complex test is &&.  */
 467   int num_then_insns;                   /* # of insns in THEN block.  */
 468   int num_else_insns;                   /* # of insns in ELSE block.  */
 469   int pass;                             /* Pass number.  */
 470
 471 #ifdef IFCVT_EXTRA_FIELDS
 472   IFCVT_EXTRA_FIELDS                    /* Any machine dependent fields.  */
 473 #endif
 474
 475 } ce_if_block_t;
 476
 477 /* This structure maintains an edge list vector.  */
 478 struct edge_list
 479 {
 480   int num_blocks;
 481   int num_edges;
 482   edge *index_to_edge;
 483 };
 484
 485 /* This is the value which indicates no edge is present.  */
 486 #define EDGE_INDEX_NO_EDGE      -1
 487
 488 /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE
 489    if there is no edge between the 2 basic blocks.  */
 490 #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ)))
 491
 492 /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic
 493    block which is either the pred or succ end of the indexed edge.  */
 494 #define INDEX_EDGE_PRED_BB(el, index)   ((el)->index_to_edge[(index)]->src)
 495 #define INDEX_EDGE_SUCC_BB(el, index)   ((el)->index_to_edge[(index)]->dest)
 496
 497 /* INDEX_EDGE returns a pointer to the edge.  */
 498 #define INDEX_EDGE(el, index)           ((el)->index_to_edge[(index)])
 499
 500 /* Number of edges in the compressed edge list.  */
 501 #define NUM_EDGES(el)                   ((el)->num_edges)
 502
 503 /* BB is assumed to contain conditional jump.  Return the fallthru edge.  */
 504 #define FALLTHRU_EDGE(bb)               (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
 505                                          ? EDGE_SUCC ((bb), 0) : EDGE_SUCC ((bb), 1))
 506
 507 /* BB is assumed to contain conditional jump.  Return the branch edge.  */
 508 #define BRANCH_EDGE(bb)                 (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
 509                                          ? EDGE_SUCC ((bb), 1) : EDGE_SUCC ((bb), 0))
 510
 511 /* Return expected execution frequency of the edge E.  */
 512 #define EDGE_FREQUENCY(e)               (((e)->src->frequency \
 513                                           * (e)->probability \
 514                                           + REG_BR_PROB_BASE / 2) \
 515                                          / REG_BR_PROB_BASE)
 516
 517 /* Return nonzero if edge is critical.  */
 518 #define EDGE_CRITICAL_P(e)              (EDGE_COUNT ((e)->src->succs) >= 2 \
 519                                          && EDGE_COUNT ((e)->dest->preds) >= 2)
 520
 521 #ifndef ENABLE_CHECKING
 522 #define ENABLE_CHECKING 0
 523 #endif
 524
 525 #define EDGE_COUNT(ev)                  VEC_length (edge, (ev))
 526 #define EDGE_I(ev,i)                    VEC_index  (edge, (ev), (i))
 527 #define EDGE_PRED(bb,i)                 VEC_index  (edge, (bb)->preds, (i))
 528 #define EDGE_SUCC(bb,i)                 VEC_index  (edge, (bb)->succs, (i))
 529
 530 #define FOR_EACH_EDGE(EDGE,EDGE_VEC)                                    \
 531 do {                                                                    \
 532   VEC(edge) *__ev = (EDGE_VEC);                                         \
 533   edge __check_edge;                                                    \
 534   unsigned int __ix;                                                    \
 535   (EDGE) = NULL;                                                        \
 536   for (__ix = 0; VEC_iterate (edge, __ev, __ix, (EDGE)); __ix++)        \
 537     {                                                                   \
 538       if (ENABLE_CHECKING)                                              \
 539         __check_edge = (EDGE);
 540
 541 #define END_FOR_EACH_EDGE                                               \
 542       if (ENABLE_CHECKING                                               \
 543           && (__ix >= EDGE_COUNT (__ev)                                 \
 544               || EDGE_I (__ev, __ix) != __check_edge))                  \
 545         internal_error ("edge modified in FOR_EACH_EDGE");              \
 546     }                                                                   \
 547 }                                                                       \
 548 while (0)
 549
 550 struct edge_list * create_edge_list (void);
 551 void free_edge_list (struct edge_list *);
 552 void print_edge_list (FILE *, struct edge_list *);
 553 void verify_edge_list (FILE *, struct edge_list *);
 554 int find_edge_index (struct edge_list *, basic_block, basic_block);
 555 edge find_edge (basic_block, basic_block);
 556
 557
 558 enum update_life_extent
 559 {
 560   UPDATE_LIFE_LOCAL = 0,
 561   UPDATE_LIFE_GLOBAL = 1,
 562   UPDATE_LIFE_GLOBAL_RM_NOTES = 2
 563 };
 564
 565 /* Flags for life_analysis and update_life_info.  */
 566
 567 #define PROP_DEATH_NOTES        1       /* Create DEAD and UNUSED notes.  */
 568 #define PROP_LOG_LINKS          2       /* Create LOG_LINKS.  */
 569 #define PROP_REG_INFO           4       /* Update regs_ever_live et al.  */
 570 #define PROP_KILL_DEAD_CODE     8       /* Remove dead code.  */
 571 #define PROP_SCAN_DEAD_CODE     16      /* Scan for dead code.  */
 572 #define PROP_ALLOW_CFG_CHANGES  32      /* Allow the CFG to be changed
 573                                            by dead code removal.  */
 574 #define PROP_AUTOINC            64      /* Create autoinc mem references.  */
 575 #define PROP_EQUAL_NOTES        128     /* Take into account REG_EQUAL notes.  */
 576 #define PROP_SCAN_DEAD_STORES   256     /* Scan for dead code.  */
 577 #define PROP_ASM_SCAN           512     /* Internal flag used within flow.c
 578                                            to flag analysis of asms.  */
 579 #define PROP_FINAL              (PROP_DEATH_NOTES | PROP_LOG_LINKS  \
 580                                  | PROP_REG_INFO | PROP_KILL_DEAD_CODE  \
 581                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
 582                                  | PROP_ALLOW_CFG_CHANGES \
 583                                  | PROP_SCAN_DEAD_STORES)
 584 #define PROP_POSTRELOAD         (PROP_DEATH_NOTES  \
 585                                  | PROP_KILL_DEAD_CODE  \
 586                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
 587                                  | PROP_SCAN_DEAD_STORES)
 588
 589 #define CLEANUP_EXPENSIVE       1       /* Do relatively expensive optimizations
 590                                            except for edge forwarding */
 591 #define CLEANUP_CROSSJUMP       2       /* Do crossjumping.  */
 592 #define CLEANUP_POST_REGSTACK   4       /* We run after reg-stack and need
 593                                            to care REG_DEAD notes.  */
 594 #define CLEANUP_PRE_LOOP        8       /* Take care to preserve syntactic loop
 595                                            notes.  */
 596 #define CLEANUP_UPDATE_LIFE     16      /* Keep life information up to date.  */
 597 #define CLEANUP_THREADING       32      /* Do jump threading.  */
 598 #define CLEANUP_NO_INSN_DEL     64      /* Do not try to delete trivially dead
 599                                            insns.  */
 600 #define CLEANUP_CFGLAYOUT       128     /* Do cleanup in cfglayout mode.  */
 601 #define CLEANUP_LOG_LINKS       256     /* Update log links.  */
 602
 603 extern void life_analysis (FILE *, int);
 604 extern int update_life_info (sbitmap, enum update_life_extent, int);
 605 extern int update_life_info_in_dirty_blocks (enum update_life_extent, int);
 606 extern int count_or_remove_death_notes (sbitmap, int);
 607 extern int propagate_block (basic_block, regset, regset, regset, int);
 608
 609 struct propagate_block_info;
 610 extern rtx propagate_one_insn (struct propagate_block_info *, rtx);
 611 extern struct propagate_block_info *init_propagate_block_info
 612  (basic_block, regset, regset, regset, int);
 613 extern void free_propagate_block_info (struct propagate_block_info *);
 614
 615 /* In lcm.c */
 616 extern struct edge_list *pre_edge_lcm (FILE *, int, sbitmap *, sbitmap *,
 617                                        sbitmap *, sbitmap *, sbitmap **,
 618                                        sbitmap **);
 619 extern struct edge_list *pre_edge_rev_lcm (FILE *, int, sbitmap *,
 620                                            sbitmap *, sbitmap *,
 621                                            sbitmap *, sbitmap **,
 622                                            sbitmap **);
 623 extern void compute_available (sbitmap *, sbitmap *, sbitmap *, sbitmap *);
 624 extern int optimize_mode_switching (FILE *);
 625
 626 /* In emit-rtl.c.  */
 627 extern rtx emit_block_insn_after (rtx, rtx, basic_block);
 628 extern rtx emit_block_insn_before (rtx, rtx, basic_block);
 629
 630 /* In predict.c */
 631 extern void estimate_probability (struct loops *);
 632 extern void expected_value_to_br_prob (void);
 633 extern bool maybe_hot_bb_p (basic_block);
 634 extern bool probably_cold_bb_p (basic_block);
 635 extern bool probably_never_executed_bb_p (basic_block);
 636 extern bool tree_predicted_by_p (basic_block, enum br_predictor);
 637 extern bool rtl_predicted_by_p (basic_block, enum br_predictor);
 638 extern void tree_predict_edge (edge, enum br_predictor, int);
 639 extern void rtl_predict_edge (edge, enum br_predictor, int);
 640 extern void predict_edge_def (edge, enum br_predictor, enum prediction);
 641
 642 /* In flow.c */
 643 extern void init_flow (void);
 644 extern void debug_bb (basic_block);
 645 extern basic_block debug_bb_n (int);
 646 extern void dump_regset (regset, FILE *);
 647 extern void debug_regset (regset);
 648 extern void allocate_reg_life_data (void);
 649 extern void allocate_bb_life_data (void);
 650 extern void expunge_block (basic_block);
 651 extern void link_block (basic_block, basic_block);
 652 extern void unlink_block (basic_block);
 653 extern void compact_blocks (void);
 654 extern basic_block alloc_block (void);
 655 extern void find_unreachable_blocks (void);
 656 extern int delete_noop_moves (void);
 657 extern basic_block force_nonfallthru (edge);
 658 extern rtx block_label (basic_block);
 659 extern bool forwarder_block_p (basic_block);
 660 extern bool purge_all_dead_edges (int);
 661 extern bool purge_dead_edges (basic_block);
 662 extern void find_sub_basic_blocks (basic_block);
 663 extern void find_many_sub_basic_blocks (sbitmap);
 664 extern void rtl_make_eh_edge (sbitmap *, basic_block, rtx);
 665 extern bool can_fallthru (basic_block, basic_block);
 666 extern bool could_fall_through (basic_block, basic_block);
 667 extern void flow_nodes_print (const char *, const sbitmap, FILE *);
 668 extern void flow_edge_list_print (const char *, const edge *, int, FILE *);
 669 extern void alloc_aux_for_block (basic_block, int);
 670 extern void alloc_aux_for_blocks (int);
 671 extern void clear_aux_for_blocks (void);
 672 extern void free_aux_for_blocks (void);
 673 extern void alloc_aux_for_edge (edge, int);
 674 extern void alloc_aux_for_edges (int);
 675 extern void clear_aux_for_edges (void);
 676 extern void free_aux_for_edges (void);
 677 extern void find_basic_blocks (rtx, int, FILE *);
 678 extern bool cleanup_cfg (int);
 679 extern bool delete_unreachable_blocks (void);
 680 extern bool merge_seq_blocks (void);
 681
 682 typedef struct conflict_graph_def *conflict_graph;
 683
 684 /* Callback function when enumerating conflicts.  The arguments are
 685    the smaller and larger regno in the conflict.  Returns zero if
 686    enumeration is to continue, nonzero to halt enumeration.  */
 687 typedef int (*conflict_graph_enum_fn) (int, int, void *);
 688
 689
 690 /* Prototypes of operations on conflict graphs.  */
 691
 692 extern conflict_graph conflict_graph_new
 693  (int);
 694 extern void conflict_graph_delete (conflict_graph);
 695 extern int conflict_graph_add (conflict_graph, int, int);
 696 extern int conflict_graph_conflict_p (conflict_graph, int, int);
 697 extern void conflict_graph_enum (conflict_graph, int, conflict_graph_enum_fn,
 698                                  void *);
 699 extern void conflict_graph_merge_regs (conflict_graph, int, int);
 700 extern void conflict_graph_print (conflict_graph, FILE*);
 701 extern conflict_graph conflict_graph_compute (regset, partition);
 702 extern bool mark_dfs_back_edges (void);
 703 extern void set_edge_can_fallthru_flag (void);
 704 extern void update_br_prob_note (basic_block);
 705 extern void fixup_abnormal_edges (void);
 706 extern bool can_hoist_insn_p (rtx, rtx, regset);
 707 extern rtx hoist_insn_after (rtx, rtx, rtx, rtx);
 708 extern rtx hoist_insn_to_edge (rtx, edge, rtx, rtx);
 709 extern bool inside_basic_block_p (rtx);
 710 extern bool control_flow_insn_p (rtx);
 711
 712 /* In bb-reorder.c */
 713 extern void reorder_basic_blocks (unsigned int);
 714 extern void partition_hot_cold_basic_blocks (void);
 715
 716 /* In cfg.c */
 717 extern void alloc_rbi_pool (void);
 718 extern void initialize_bb_rbi (basic_block bb);
 719 extern void free_rbi_pool (void);
 720
 721 /* In dominance.c */
 722
 723 enum cdi_direction
 724 {
 725   CDI_DOMINATORS,
 726   CDI_POST_DOMINATORS
 727 };
 728
 729 enum dom_state
 730 {
 731   DOM_NONE,             /* Not computed at all.  */
 732   DOM_CONS_OK,          /* The data is conservatively OK, i.e. if it says you that A dominates B,
 733                            it indeed does.  */
 734   DOM_NO_FAST_QUERY,    /* The data is OK, but the fast query data are not usable.  */
 735   DOM_OK                /* Everything is ok.  */
 736 };
 737
 738 extern enum dom_state dom_computed[2];
 739
 740 extern void calculate_dominance_info (enum cdi_direction);
 741 extern void free_dominance_info (enum cdi_direction);
 742 extern basic_block nearest_common_dominator (enum cdi_direction,
 743                                              basic_block, basic_block);
 744 extern void set_immediate_dominator (enum cdi_direction, basic_block,
 745                                      basic_block);
 746 extern basic_block get_immediate_dominator (enum cdi_direction, basic_block);
 747 extern bool dominated_by_p (enum cdi_direction, basic_block, basic_block);
 748 extern int get_dominated_by (enum cdi_direction, basic_block, basic_block **);
 749 extern void add_to_dominance_info (enum cdi_direction, basic_block);
 750 extern void delete_from_dominance_info (enum cdi_direction, basic_block);
 751 basic_block recount_dominator (enum cdi_direction, basic_block);
 752 extern void redirect_immediate_dominators (enum cdi_direction, basic_block,
 753                                            basic_block);
 754 extern void iterate_fix_dominators (enum cdi_direction, basic_block *, int);
 755 extern void verify_dominators (enum cdi_direction);
 756 extern basic_block first_dom_son (enum cdi_direction, basic_block);
 757 extern basic_block next_dom_son (enum cdi_direction, basic_block);
 758 extern edge try_redirect_by_replacing_jump (edge, basic_block, bool);
 759 extern void break_superblocks (void);
 760
 761 #include "cfghooks.h"
 762
 763 #endif /* GCC_BASIC_BLOCK_H */