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, &reg_obstack)
  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_and_into (TO, FROM)
  54
  55 /* `and' the complement of a register set with a register set.  */
  56 #define AND_COMPL_REG_SET(TO, FROM) bitmap_and_compl_into (TO, FROM)
  57
  58 /* Inclusive or a register set with a second register set.  */
  59 #define IOR_REG_SET(TO, FROM) bitmap_ior_into (TO, FROM)
  60
  61 /* Exclusive or a register set with a second register set.  */
  62 #define XOR_REG_SET(TO, FROM) bitmap_xor_into (TO, FROM)
  63
  64 /* Or into TO the register set FROM1 `and'ed with the complement of FROM2.  */
  65 #define IOR_AND_COMPL_REG_SET(TO, FROM1, FROM2) \
  66   bitmap_ior_and_compl_into (TO, FROM1, FROM2)
  67
  68 /* Clear a single register in a register set.  */
  69 #define CLEAR_REGNO_REG_SET(HEAD, REG) bitmap_clear_bit (HEAD, REG)
  70
  71 /* Set a single register in a register set.  */
  72 #define SET_REGNO_REG_SET(HEAD, REG) bitmap_set_bit (HEAD, REG)
  73
  74 /* Return true if a register is set in a register set.  */
  75 #define REGNO_REG_SET_P(TO, REG) bitmap_bit_p (TO, REG)
  76
  77 /* Copy the hard registers in a register set to the hard register set.  */
  78 extern void reg_set_to_hard_reg_set (HARD_REG_SET *, bitmap);
  79 #define REG_SET_TO_HARD_REG_SET(TO, FROM)                               \
  80 do {                                                                    \
  81   CLEAR_HARD_REG_SET (TO);                                              \
  82   reg_set_to_hard_reg_set (&TO, FROM);                                  \
  83 } while (0)
  84
  85 typedef bitmap_iterator reg_set_iterator;
  86
  87 /* Loop over all registers in REGSET, starting with MIN, setting REGNUM to the
  88    register number and executing CODE for all registers that are set.  */
  89 #define EXECUTE_IF_SET_IN_REG_SET(REGSET, MIN, REGNUM, RSI)     \
  90   EXECUTE_IF_SET_IN_BITMAP (REGSET, MIN, REGNUM, RSI)
  91
  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 the first regset and not set in the second.  */
  95 #define EXECUTE_IF_AND_COMPL_IN_REG_SET(REGSET, MIN, REGNUM, RSI)       \
  96   EXECUTE_IF_AND_COMPL_IN_BITMAP (REGSET, MIN, REGNUM, RSI)
  97
  98 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
  99    REGNUM to the register number and executing CODE for all registers that are
 100    set in both regsets.  */
 101 #define EXECUTE_IF_AND_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, RSI) \
 102   EXECUTE_IF_AND_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, RSI) \
 103
 104 /* Allocate a register set with oballoc.  */
 105 #define OBSTACK_ALLOC_REG_SET(OBSTACK) BITMAP_OBSTACK_ALLOC (OBSTACK)
 106
 107 /* Do any cleanup needed on a regset when it is no longer used.  */
 108 #define FREE_REG_SET(REGSET) BITMAP_OBSTACK_FREE(REGSET)
 109
 110 /* Allocate a register set with xmalloc.  */
 111 #define XMALLOC_REG_SET() BITMAP_XMALLOC ()
 112
 113 /* Free a register set.  */
 114 #define XFREE_REG_SET(REGSET) BITMAP_XFREE (REGSET)
 115
 116 /* Type we use to hold basic block counters.  Should be at least
 117    64bit.  Although a counter cannot be negative, we use a signed
 118    type, because erroneous negative counts can be generated when the
 119    flow graph is manipulated by various optimizations.  A signed type
 120    makes those easy to detect.  */
 121 typedef HOST_WIDEST_INT gcov_type;
 122
 123 /* Control flow edge information.  */
 124 struct edge_def GTY(())
 125 {
 126   /* The two blocks at the ends of the edge.  */
 127   struct basic_block_def *src;
 128   struct basic_block_def *dest;
 129
 130   /* Instructions queued on the edge.  */
 131   union edge_def_insns {
 132     rtx GTY ((tag ("0"))) r;
 133     tree GTY ((tag ("1"))) t;
 134   } GTY ((desc ("ir_type ()"))) insns;
 135
 136   /* Auxiliary info specific to a pass.  */
 137   PTR GTY ((skip (""))) aux;
 138
 139   /* Location of any goto implicit in the edge, during tree-ssa.  */
 140   source_locus goto_locus;
 141
 142   int flags;                    /* see EDGE_* below  */
 143   int probability;              /* biased by REG_BR_PROB_BASE */
 144   gcov_type count;              /* Expected number of executions calculated
 145                                    in profile.c  */
 146
 147   /* The index number corresponding to this edge in the edge vector
 148      dest->preds.  */
 149   unsigned int dest_idx;
 150 };
 151
 152 typedef struct edge_def *edge;
 153 DEF_VEC_GC_P(edge);
 154
 155 #define EDGE_FALLTHRU           1       /* 'Straight line' flow */
 156 #define EDGE_ABNORMAL           2       /* Strange flow, like computed
 157                                            label, or eh */
 158 #define EDGE_ABNORMAL_CALL      4       /* Call with abnormal exit
 159                                            like an exception, or sibcall */
 160 #define EDGE_EH                 8       /* Exception throw */
 161 #define EDGE_FAKE               16      /* Not a real edge (profile.c) */
 162 #define EDGE_DFS_BACK           32      /* A backwards edge */
 163 #define EDGE_CAN_FALLTHRU       64      /* Candidate for straight line
 164                                            flow.  */
 165 #define EDGE_IRREDUCIBLE_LOOP   128     /* Part of irreducible loop.  */
 166 #define EDGE_SIBCALL            256     /* Edge from sibcall to exit.  */
 167 #define EDGE_LOOP_EXIT          512     /* Exit of a loop.  */
 168 #define EDGE_TRUE_VALUE         1024    /* Edge taken when controlling
 169                                            predicate is nonzero.  */
 170 #define EDGE_FALSE_VALUE        2048    /* Edge taken when controlling
 171                                            predicate is zero.  */
 172 #define EDGE_EXECUTABLE         4096    /* Edge is executable.  Only
 173                                            valid during SSA-CCP.  */
 174 #define EDGE_CROSSING           8192    /* Edge crosses between hot
 175                                            and cold sections, when we
 176                                            do partitioning.  */
 177 #define EDGE_ALL_FLAGS         16383
 178
 179 #define EDGE_COMPLEX    (EDGE_ABNORMAL | EDGE_ABNORMAL_CALL | EDGE_EH)
 180
 181 /* Counter summary from the last set of coverage counts read by
 182    profile.c.  */
 183 extern const struct gcov_ctr_summary *profile_info;
 184
 185 /* Declared in cfgloop.h.  */
 186 struct loop;
 187 struct loops;
 188
 189 /* Declared in tree-flow.h.  */
 190 struct bb_ann_d;
 191
 192 /* A basic block is a sequence of instructions with only entry and
 193    only one exit.  If any one of the instructions are executed, they
 194    will all be executed, and in sequence from first to last.
 195
 196    There may be COND_EXEC instructions in the basic block.  The
 197    COND_EXEC *instructions* will be executed -- but if the condition
 198    is false the conditionally executed *expressions* will of course
 199    not be executed.  We don't consider the conditionally executed
 200    expression (which might have side-effects) to be in a separate
 201    basic block because the program counter will always be at the same
 202    location after the COND_EXEC instruction, regardless of whether the
 203    condition is true or not.
 204
 205    Basic blocks need not start with a label nor end with a jump insn.
 206    For example, a previous basic block may just "conditionally fall"
 207    into the succeeding basic block, and the last basic block need not
 208    end with a jump insn.  Block 0 is a descendant of the entry block.
 209
 210    A basic block beginning with two labels cannot have notes between
 211    the labels.
 212
 213    Data for jump tables are stored in jump_insns that occur in no
 214    basic block even though these insns can follow or precede insns in
 215    basic blocks.  */
 216
 217 /* Basic block information indexed by block number.  */
 218 struct basic_block_def GTY((chain_next ("%h.next_bb"), chain_prev ("%h.prev_bb")))
 219 {
 220   /* The first and last insns of the block.  */
 221   rtx head_;
 222   rtx end_;
 223
 224   /* Pointers to the first and last trees of the block.  */
 225   tree stmt_list;
 226
 227   /* The edges into and out of the block.  */
 228   VEC(edge) *preds;
 229   VEC(edge) *succs;
 230
 231   /* The registers that are live on entry to this block.  */
 232   bitmap GTY ((skip (""))) global_live_at_start;
 233
 234   /* The registers that are live on exit from this block.  */
 235   bitmap GTY ((skip (""))) global_live_at_end;
 236
 237   /* Auxiliary info specific to a pass.  */
 238   PTR GTY ((skip (""))) aux;
 239
 240   /* Innermost loop containing the block.  */
 241   struct loop * GTY ((skip (""))) loop_father;
 242
 243   /* The dominance and postdominance information node.  */
 244   struct et_node * GTY ((skip (""))) dom[2];
 245
 246   /* Previous and next blocks in the chain.  */
 247   struct basic_block_def *prev_bb;
 248   struct basic_block_def *next_bb;
 249
 250   /* The data used by basic block copying and reordering functions.  */
 251   struct reorder_block_def * GTY ((skip (""))) rbi;
 252
 253   /* Annotations used at the tree level.  */
 254   struct bb_ann_d *tree_annotations;
 255
 256   /* Expected number of executions: calculated in profile.c.  */
 257   gcov_type count;
 258
 259   /* The index of this block.  */
 260   int index;
 261
 262   /* The loop depth of this block.  */
 263   int loop_depth;
 264
 265   /* Expected frequency.  Normalized to be in range 0 to BB_FREQ_MAX.  */
 266   int frequency;
 267
 268   /* Various flags.  See BB_* below.  */
 269   int flags;
 270 };
 271
 272 typedef struct basic_block_def *basic_block;
 273
 274 /* Structure to hold information about the blocks during reordering and
 275    copying.  */
 276
 277 typedef struct reorder_block_def
 278 {
 279   rtx header;
 280   rtx footer;
 281   basic_block next;
 282   basic_block original;
 283   /* Used by loop copying.  */
 284   basic_block copy;
 285   int duplicated;
 286   int copy_number;
 287
 288   /* These fields are used by bb-reorder pass.  */
 289   int visited;
 290 } *reorder_block_def_p;
 291
 292 #define BB_FREQ_MAX 10000
 293
 294 /* Masks for basic_block.flags.  */
 295 #define BB_DIRTY                1
 296 #define BB_NEW                  2
 297 #define BB_REACHABLE            4
 298 #define BB_VISITED              8
 299 #define BB_IRREDUCIBLE_LOOP     16
 300 #define BB_SUPERBLOCK           32
 301 #define BB_DISABLE_SCHEDULE     64
 302
 303 #define BB_HOT_PARTITION        128
 304 #define BB_COLD_PARTITION       256
 305 #define BB_UNPARTITIONED        0
 306
 307 /* Partitions, to be used when partitioning hot and cold basic blocks into
 308    separate sections.  */
 309 #define BB_PARTITION(bb) ((bb)->flags & (BB_HOT_PARTITION|BB_COLD_PARTITION))
 310 #define BB_SET_PARTITION(bb, part) do {                                 \
 311   basic_block bb_ = (bb);                                               \
 312   bb_->flags = ((bb_->flags & ~(BB_HOT_PARTITION|BB_COLD_PARTITION))    \
 313                 | (part));                                              \
 314 } while (0)
 315
 316 #define BB_COPY_PARTITION(dstbb, srcbb) \
 317   BB_SET_PARTITION (dstbb, BB_PARTITION (srcbb))
 318
 319 /* Number of basic blocks in the current function.  */
 320
 321 extern int n_basic_blocks;
 322
 323 /* First free basic block number.  */
 324
 325 extern int last_basic_block;
 326
 327 /* Number of edges in the current function.  */
 328
 329 extern int n_edges;
 330
 331 /* Signalize the status of profile information in the CFG.  */
 332 extern enum profile_status
 333 {
 334   PROFILE_ABSENT,
 335   PROFILE_GUESSED,
 336   PROFILE_READ
 337 } profile_status;
 338
 339 /* Index by basic block number, get basic block struct info.  */
 340
 341 extern GTY(()) varray_type basic_block_info;
 342
 343 #define BASIC_BLOCK(N)  (VARRAY_BB (basic_block_info, (N)))
 344
 345 /* For iterating over basic blocks.  */
 346 #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \
 347   for (BB = FROM; BB != TO; BB = BB->DIR)
 348
 349 #define FOR_EACH_BB(BB) \
 350   FOR_BB_BETWEEN (BB, ENTRY_BLOCK_PTR->next_bb, EXIT_BLOCK_PTR, next_bb)
 351
 352 #define FOR_EACH_BB_REVERSE(BB) \
 353   FOR_BB_BETWEEN (BB, EXIT_BLOCK_PTR->prev_bb, ENTRY_BLOCK_PTR, prev_bb)
 354
 355 /* For iterating over insns in basic block.  */
 356 #define FOR_BB_INSNS(BB, INSN)                  \
 357   for ((INSN) = BB_HEAD (BB);                   \
 358        (INSN) != NEXT_INSN (BB_END (BB));       \
 359        (INSN) = NEXT_INSN (INSN))
 360
 361 #define FOR_BB_INSNS_REVERSE(BB, INSN)          \
 362   for ((INSN) = BB_END (BB);                    \
 363        (INSN) != PREV_INSN (BB_HEAD (BB));      \
 364        (INSN) = PREV_INSN (INSN))
 365
 366 /* Cycles through _all_ basic blocks, even the fake ones (entry and
 367    exit block).  */
 368
 369 #define FOR_ALL_BB(BB) \
 370   for (BB = ENTRY_BLOCK_PTR; BB; BB = BB->next_bb)
 371
 372 /* What registers are live at the setjmp call.  */
 373
 374 extern regset regs_live_at_setjmp;
 375
 376 /* Special labels found during CFG build.  */
 377
 378 extern GTY(()) rtx label_value_list;
 379
 380 extern bitmap_obstack reg_obstack;
 381
 382 /* Indexed by n, gives number of basic block that  (REG n) is used in.
 383    If the value is REG_BLOCK_GLOBAL (-2),
 384    it means (REG n) is used in more than one basic block.
 385    REG_BLOCK_UNKNOWN (-1) means it hasn't been seen yet so we don't know.
 386    This information remains valid for the rest of the compilation
 387    of the current function; it is used to control register allocation.  */
 388
 389 #define REG_BLOCK_UNKNOWN -1
 390 #define REG_BLOCK_GLOBAL -2
 391
 392 #define REG_BASIC_BLOCK(N) (VARRAY_REG (reg_n_info, N)->basic_block)
 393 \f
 394 /* Stuff for recording basic block info.  */
 395
 396 #define BB_HEAD(B)      (B)->head_
 397 #define BB_END(B)       (B)->end_
 398
 399 /* Special block numbers [markers] for entry and exit.  */
 400 #define ENTRY_BLOCK (-1)
 401 #define EXIT_BLOCK (-2)
 402
 403 /* Special block number not valid for any block.  */
 404 #define INVALID_BLOCK (-3)
 405
 406 /* Similarly, block pointers for the edge list.  */
 407 extern GTY(()) basic_block ENTRY_BLOCK_PTR;
 408 extern GTY(()) basic_block EXIT_BLOCK_PTR;
 409
 410 #define BLOCK_NUM(INSN)       (BLOCK_FOR_INSN (INSN)->index + 0)
 411 #define set_block_for_insn(INSN, BB)  (BLOCK_FOR_INSN (INSN) = BB)
 412
 413 extern void compute_bb_for_insn (void);
 414 extern void free_bb_for_insn (void);
 415 extern void update_bb_for_insn (basic_block);
 416
 417 extern void free_basic_block_vars (void);
 418
 419 extern void insert_insn_on_edge (rtx, edge);
 420 bool safe_insert_insn_on_edge (rtx, edge);
 421
 422 extern void commit_edge_insertions (void);
 423 extern void commit_edge_insertions_watch_calls (void);
 424
 425 extern void remove_fake_edges (void);
 426 extern void remove_fake_exit_edges (void);
 427 extern void add_noreturn_fake_exit_edges (void);
 428 extern void connect_infinite_loops_to_exit (void);
 429 extern edge unchecked_make_edge (basic_block, basic_block, int);
 430 extern edge cached_make_edge (sbitmap *, basic_block, basic_block, int);
 431 extern edge make_edge (basic_block, basic_block, int);
 432 extern edge make_single_succ_edge (basic_block, basic_block, int);
 433 extern void remove_edge (edge);
 434 extern void redirect_edge_succ (edge, basic_block);
 435 extern edge redirect_edge_succ_nodup (edge, basic_block);
 436 extern void redirect_edge_pred (edge, basic_block);
 437 extern basic_block create_basic_block_structure (rtx, rtx, rtx, basic_block);
 438 extern void clear_bb_flags (void);
 439 extern void flow_reverse_top_sort_order_compute (int *);
 440 extern int flow_depth_first_order_compute (int *, int *);
 441 extern int dfs_enumerate_from (basic_block, int,
 442                                bool (*)(basic_block, void *),
 443                                basic_block *, int, void *);
 444 extern void compute_dominance_frontiers (bitmap *);
 445 extern void dump_edge_info (FILE *, edge, int);
 446 extern void brief_dump_cfg (FILE *);
 447 extern void clear_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 #define EDGE_COUNT(ev)                  VEC_length (edge, (ev))
 522 #define EDGE_I(ev,i)                    VEC_index  (edge, (ev), (i))
 523 #define EDGE_PRED(bb,i)                 VEC_index  (edge, (bb)->preds, (i))
 524 #define EDGE_SUCC(bb,i)                 VEC_index  (edge, (bb)->succs, (i))
 525
 526 /* Iterator object for edges.  */
 527
 528 typedef struct {
 529   unsigned index;
 530   VEC(edge) **container;
 531 } edge_iterator;
 532
 533 static inline VEC(edge) *
 534 ei_container (edge_iterator i)
 535 {
 536   gcc_assert (i.container);
 537   return *i.container;
 538 }
 539
 540 #define ei_start(iter) ei_start_1 (&(iter))
 541 #define ei_last(iter) ei_last_1 (&(iter))
 542
 543 /* Return an iterator pointing to the start of an edge vector.  */
 544 static inline edge_iterator
 545 ei_start_1 (VEC(edge) **ev)
 546 {
 547   edge_iterator i;
 548
 549   i.index = 0;
 550   i.container = ev;
 551
 552   return i;
 553 }
 554
 555 /* Return an iterator pointing to the last element of an edge
 556    vector.  */
 557 static inline edge_iterator
 558 ei_last_1 (VEC(edge) **ev)
 559 {
 560   edge_iterator i;
 561
 562   i.index = EDGE_COUNT (*ev) - 1;
 563   i.container = ev;
 564
 565   return i;
 566 }
 567
 568 /* Is the iterator `i' at the end of the sequence?  */
 569 static inline bool
 570 ei_end_p (edge_iterator i)
 571 {
 572   return (i.index == EDGE_COUNT (ei_container (i)));
 573 }
 574
 575 /* Is the iterator `i' at one position before the end of the
 576    sequence?  */
 577 static inline bool
 578 ei_one_before_end_p (edge_iterator i)
 579 {
 580   return (i.index + 1 == EDGE_COUNT (ei_container (i)));
 581 }
 582
 583 /* Advance the iterator to the next element.  */
 584 static inline void
 585 ei_next (edge_iterator *i)
 586 {
 587   gcc_assert (i->index < EDGE_COUNT (ei_container (*i)));
 588   i->index++;
 589 }
 590
 591 /* Move the iterator to the previous element.  */
 592 static inline void
 593 ei_prev (edge_iterator *i)
 594 {
 595   gcc_assert (i->index > 0);
 596   i->index--;
 597 }
 598
 599 /* Return the edge pointed to by the iterator `i'.  */
 600 static inline edge
 601 ei_edge (edge_iterator i)
 602 {
 603   return EDGE_I (ei_container (i), i.index);
 604 }
 605
 606 /* Return an edge pointed to by the iterator.  Do it safely so that
 607    NULL is returned when the iterator is pointing at the end of the
 608    sequence.  */
 609 static inline edge
 610 ei_safe_edge (edge_iterator i)
 611 {
 612   return !ei_end_p (i) ? ei_edge (i) : NULL;
 613 }
 614
 615 /* This macro serves as a convenient way to iterate each edge in a
 616    vector of predecessor or successor edges.  It must not be used when
 617    an element might be removed during the traversal, otherwise
 618    elements will be missed.  Instead, use a for-loop like that shown
 619    in the following pseudo-code:
 620
 621    FOR (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
 622      {
 623         IF (e != taken_edge)
 624           remove_edge (e);
 625         ELSE
 626           ei_next (&ei);
 627      }
 628 */
 629
 630 #define FOR_EACH_EDGE(EDGE,ITER,EDGE_VEC) \
 631   for ((EDGE) = NULL, (ITER) = ei_start ((EDGE_VEC)); \
 632        ((EDGE) = ei_safe_edge ((ITER))); \
 633        ei_next (&(ITER)))
 634
 635 struct edge_list * create_edge_list (void);
 636 void free_edge_list (struct edge_list *);
 637 void print_edge_list (FILE *, struct edge_list *);
 638 void verify_edge_list (FILE *, struct edge_list *);
 639 int find_edge_index (struct edge_list *, basic_block, basic_block);
 640 edge find_edge (basic_block, basic_block);
 641
 642
 643 enum update_life_extent
 644 {
 645   UPDATE_LIFE_LOCAL = 0,
 646   UPDATE_LIFE_GLOBAL = 1,
 647   UPDATE_LIFE_GLOBAL_RM_NOTES = 2
 648 };
 649
 650 /* Flags for life_analysis and update_life_info.  */
 651
 652 #define PROP_DEATH_NOTES        1       /* Create DEAD and UNUSED notes.  */
 653 #define PROP_LOG_LINKS          2       /* Create LOG_LINKS.  */
 654 #define PROP_REG_INFO           4       /* Update regs_ever_live et al.  */
 655 #define PROP_KILL_DEAD_CODE     8       /* Remove dead code.  */
 656 #define PROP_SCAN_DEAD_CODE     16      /* Scan for dead code.  */
 657 #define PROP_ALLOW_CFG_CHANGES  32      /* Allow the CFG to be changed
 658                                            by dead code removal.  */
 659 #define PROP_AUTOINC            64      /* Create autoinc mem references.  */
 660 #define PROP_EQUAL_NOTES        128     /* Take into account REG_EQUAL notes.  */
 661 #define PROP_SCAN_DEAD_STORES   256     /* Scan for dead code.  */
 662 #define PROP_ASM_SCAN           512     /* Internal flag used within flow.c
 663                                            to flag analysis of asms.  */
 664 #define PROP_FINAL              (PROP_DEATH_NOTES | PROP_LOG_LINKS  \
 665                                  | PROP_REG_INFO | PROP_KILL_DEAD_CODE  \
 666                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
 667                                  | PROP_ALLOW_CFG_CHANGES \
 668                                  | PROP_SCAN_DEAD_STORES)
 669 #define PROP_POSTRELOAD         (PROP_DEATH_NOTES  \
 670                                  | PROP_KILL_DEAD_CODE  \
 671                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
 672                                  | PROP_SCAN_DEAD_STORES)
 673
 674 #define CLEANUP_EXPENSIVE       1       /* Do relatively expensive optimizations
 675                                            except for edge forwarding */
 676 #define CLEANUP_CROSSJUMP       2       /* Do crossjumping.  */
 677 #define CLEANUP_POST_REGSTACK   4       /* We run after reg-stack and need
 678                                            to care REG_DEAD notes.  */
 679 #define CLEANUP_PRE_LOOP        8       /* Take care to preserve syntactic loop
 680                                            notes.  */
 681 #define CLEANUP_UPDATE_LIFE     16      /* Keep life information up to date.  */
 682 #define CLEANUP_THREADING       32      /* Do jump threading.  */
 683 #define CLEANUP_NO_INSN_DEL     64      /* Do not try to delete trivially dead
 684                                            insns.  */
 685 #define CLEANUP_CFGLAYOUT       128     /* Do cleanup in cfglayout mode.  */
 686 #define CLEANUP_LOG_LINKS       256     /* Update log links.  */
 687
 688 extern void life_analysis (FILE *, int);
 689 extern int update_life_info (sbitmap, enum update_life_extent, int);
 690 extern int update_life_info_in_dirty_blocks (enum update_life_extent, int);
 691 extern int count_or_remove_death_notes (sbitmap, int);
 692 extern int propagate_block (basic_block, regset, regset, regset, int);
 693
 694 struct propagate_block_info;
 695 extern rtx propagate_one_insn (struct propagate_block_info *, rtx);
 696 extern struct propagate_block_info *init_propagate_block_info
 697  (basic_block, regset, regset, regset, int);
 698 extern void free_propagate_block_info (struct propagate_block_info *);
 699
 700 /* In lcm.c */
 701 extern struct edge_list *pre_edge_lcm (FILE *, int, sbitmap *, sbitmap *,
 702                                        sbitmap *, sbitmap *, sbitmap **,
 703                                        sbitmap **);
 704 extern struct edge_list *pre_edge_rev_lcm (FILE *, int, sbitmap *,
 705                                            sbitmap *, sbitmap *,
 706                                            sbitmap *, sbitmap **,
 707                                            sbitmap **);
 708 extern void compute_available (sbitmap *, sbitmap *, sbitmap *, sbitmap *);
 709 extern int optimize_mode_switching (FILE *);
 710
 711 /* In predict.c */
 712 extern void estimate_probability (struct loops *);
 713 extern void expected_value_to_br_prob (void);
 714 extern bool maybe_hot_bb_p (basic_block);
 715 extern bool probably_cold_bb_p (basic_block);
 716 extern bool probably_never_executed_bb_p (basic_block);
 717 extern bool tree_predicted_by_p (basic_block, enum br_predictor);
 718 extern bool rtl_predicted_by_p (basic_block, enum br_predictor);
 719 extern void tree_predict_edge (edge, enum br_predictor, int);
 720 extern void rtl_predict_edge (edge, enum br_predictor, int);
 721 extern void predict_edge_def (edge, enum br_predictor, enum prediction);
 722 extern void guess_outgoing_edge_probabilities (basic_block);
 723
 724 /* In flow.c */
 725 extern void init_flow (void);
 726 extern void debug_bb (basic_block);
 727 extern basic_block debug_bb_n (int);
 728 extern void dump_regset (regset, FILE *);
 729 extern void debug_regset (regset);
 730 extern void allocate_reg_life_data (void);
 731 extern void expunge_block (basic_block);
 732 extern void link_block (basic_block, basic_block);
 733 extern void unlink_block (basic_block);
 734 extern void compact_blocks (void);
 735 extern basic_block alloc_block (void);
 736 extern void find_unreachable_blocks (void);
 737 extern int delete_noop_moves (void);
 738 extern basic_block force_nonfallthru (edge);
 739 extern rtx block_label (basic_block);
 740 extern bool forwarder_block_p (basic_block);
 741 extern bool purge_all_dead_edges (int);
 742 extern bool purge_dead_edges (basic_block);
 743 extern void find_sub_basic_blocks (basic_block);
 744 extern void find_many_sub_basic_blocks (sbitmap);
 745 extern void rtl_make_eh_edge (sbitmap *, basic_block, rtx);
 746 extern bool can_fallthru (basic_block, basic_block);
 747 extern bool could_fall_through (basic_block, basic_block);
 748 extern void flow_nodes_print (const char *, const sbitmap, FILE *);
 749 extern void flow_edge_list_print (const char *, const edge *, int, FILE *);
 750 extern void alloc_aux_for_block (basic_block, int);
 751 extern void alloc_aux_for_blocks (int);
 752 extern void clear_aux_for_blocks (void);
 753 extern void free_aux_for_blocks (void);
 754 extern void alloc_aux_for_edge (edge, int);
 755 extern void alloc_aux_for_edges (int);
 756 extern void clear_aux_for_edges (void);
 757 extern void free_aux_for_edges (void);
 758 extern void find_basic_blocks (rtx, int, FILE *);
 759 extern bool cleanup_cfg (int);
 760 extern bool delete_unreachable_blocks (void);
 761 extern bool merge_seq_blocks (void);
 762
 763 typedef struct conflict_graph_def *conflict_graph;
 764
 765 /* Callback function when enumerating conflicts.  The arguments are
 766    the smaller and larger regno in the conflict.  Returns zero if
 767    enumeration is to continue, nonzero to halt enumeration.  */
 768 typedef int (*conflict_graph_enum_fn) (int, int, void *);
 769
 770
 771 /* Prototypes of operations on conflict graphs.  */
 772
 773 extern conflict_graph conflict_graph_new
 774  (int);
 775 extern void conflict_graph_delete (conflict_graph);
 776 extern int conflict_graph_add (conflict_graph, int, int);
 777 extern int conflict_graph_conflict_p (conflict_graph, int, int);
 778 extern void conflict_graph_enum (conflict_graph, int, conflict_graph_enum_fn,
 779                                  void *);
 780 extern void conflict_graph_merge_regs (conflict_graph, int, int);
 781 extern void conflict_graph_print (conflict_graph, FILE*);
 782 extern bool mark_dfs_back_edges (void);
 783 extern void set_edge_can_fallthru_flag (void);
 784 extern void update_br_prob_note (basic_block);
 785 extern void fixup_abnormal_edges (void);
 786 extern bool inside_basic_block_p (rtx);
 787 extern bool control_flow_insn_p (rtx);
 788
 789 /* In bb-reorder.c */
 790 extern void reorder_basic_blocks (unsigned int);
 791 extern void partition_hot_cold_basic_blocks (void);
 792
 793 /* In cfg.c */
 794 extern void alloc_rbi_pool (void);
 795 extern void initialize_bb_rbi (basic_block bb);
 796 extern void free_rbi_pool (void);
 797
 798 /* In dominance.c */
 799
 800 enum cdi_direction
 801 {
 802   CDI_DOMINATORS,
 803   CDI_POST_DOMINATORS
 804 };
 805
 806 enum dom_state
 807 {
 808   DOM_NONE,             /* Not computed at all.  */
 809   DOM_NO_FAST_QUERY,    /* The data is OK, but the fast query data are not usable.  */
 810   DOM_OK                /* Everything is ok.  */
 811 };
 812
 813 extern enum dom_state dom_computed[2];
 814
 815 extern bool dom_info_available_p (enum cdi_direction);
 816 extern void calculate_dominance_info (enum cdi_direction);
 817 extern void free_dominance_info (enum cdi_direction);
 818 extern basic_block nearest_common_dominator (enum cdi_direction,
 819                                              basic_block, basic_block);
 820 extern void set_immediate_dominator (enum cdi_direction, basic_block,
 821                                      basic_block);
 822 extern basic_block get_immediate_dominator (enum cdi_direction, basic_block);
 823 extern bool dominated_by_p (enum cdi_direction, basic_block, basic_block);
 824 extern int get_dominated_by (enum cdi_direction, basic_block, basic_block **);
 825 extern unsigned get_dominated_by_region (enum cdi_direction, basic_block *,
 826                                          unsigned, basic_block *);
 827 extern void add_to_dominance_info (enum cdi_direction, basic_block);
 828 extern void delete_from_dominance_info (enum cdi_direction, basic_block);
 829 basic_block recount_dominator (enum cdi_direction, basic_block);
 830 extern void redirect_immediate_dominators (enum cdi_direction, basic_block,
 831                                            basic_block);
 832 extern void iterate_fix_dominators (enum cdi_direction, basic_block *, int);
 833 extern void verify_dominators (enum cdi_direction);
 834 extern basic_block first_dom_son (enum cdi_direction, basic_block);
 835 extern basic_block next_dom_son (enum cdi_direction, basic_block);
 836 extern edge try_redirect_by_replacing_jump (edge, basic_block, bool);
 837 extern void break_superblocks (void);
 838 extern void check_bb_profile (basic_block, FILE *);
 839 extern void update_bb_profile_for_threading (basic_block, int, gcov_type, edge);
 840
 841 #include "cfghooks.h"
 842
 843 #endif /* GCC_BASIC_BLOCK_H */