gcc/basic-block.h

   1 /* Define control flow data structures for the CFG.
   2    Copyright (C) 1987, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
   3    2005, 2006, 2007, 2008, 2009, 2010 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 3, 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 COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GCC_BASIC_BLOCK_H
  22 #define GCC_BASIC_BLOCK_H
  23
  24 #include "predict.h"
  25 #include "vec.h"
  26 #include "function.h"
  27
  28 /* Type we use to hold basic block counters.  Should be at least
  29    64bit.  Although a counter cannot be negative, we use a signed
  30    type, because erroneous negative counts can be generated when the
  31    flow graph is manipulated by various optimizations.  A signed type
  32    makes those easy to detect.  */
  33 typedef HOST_WIDEST_INT gcov_type;
  34
  35 /* Control flow edge information.  */
  36 struct GTY(()) edge_def {
  37   /* The two blocks at the ends of the edge.  */
  38   struct basic_block_def *src;
  39   struct basic_block_def *dest;
  40
  41   /* Instructions queued on the edge.  */
  42   union edge_def_insns {
  43     gimple_seq GTY ((tag ("true"))) g;
  44     rtx GTY ((tag ("false"))) r;
  45   } GTY ((desc ("current_ir_type () == IR_GIMPLE"))) insns;
  46
  47   /* Auxiliary info specific to a pass.  */
  48   PTR GTY ((skip (""))) aux;
  49
  50   /* Location of any goto implicit in the edge and associated BLOCK.  */
  51   tree goto_block;
  52   location_t goto_locus;
  53
  54   /* The index number corresponding to this edge in the edge vector
  55      dest->preds.  */
  56   unsigned int dest_idx;
  57
  58   int flags;                    /* see EDGE_* below  */
  59   int probability;              /* biased by REG_BR_PROB_BASE */
  60   gcov_type count;              /* Expected number of executions calculated
  61                                    in profile.c  */
  62 };
  63
  64 DEF_VEC_P(edge);
  65 DEF_VEC_ALLOC_P(edge,gc);
  66 DEF_VEC_ALLOC_P(edge,heap);
  67
  68 #define EDGE_FALLTHRU           1       /* 'Straight line' flow */
  69 #define EDGE_ABNORMAL           2       /* Strange flow, like computed
  70                                            label, or eh */
  71 #define EDGE_ABNORMAL_CALL      4       /* Call with abnormal exit
  72                                            like an exception, or sibcall */
  73 #define EDGE_EH                 8       /* Exception throw */
  74 #define EDGE_FAKE               16      /* Not a real edge (profile.c) */
  75 #define EDGE_DFS_BACK           32      /* A backwards edge */
  76 #define EDGE_CAN_FALLTHRU       64      /* Candidate for straight line
  77                                            flow.  */
  78 #define EDGE_IRREDUCIBLE_LOOP   128     /* Part of irreducible loop.  */
  79 #define EDGE_SIBCALL            256     /* Edge from sibcall to exit.  */
  80 #define EDGE_LOOP_EXIT          512     /* Exit of a loop.  */
  81 #define EDGE_TRUE_VALUE         1024    /* Edge taken when controlling
  82                                            predicate is nonzero.  */
  83 #define EDGE_FALSE_VALUE        2048    /* Edge taken when controlling
  84                                            predicate is zero.  */
  85 #define EDGE_EXECUTABLE         4096    /* Edge is executable.  Only
  86                                            valid during SSA-CCP.  */
  87 #define EDGE_CROSSING           8192    /* Edge crosses between hot
  88                                            and cold sections, when we
  89                                            do partitioning.  */
  90 #define EDGE_ALL_FLAGS         16383
  91
  92 #define EDGE_COMPLEX    (EDGE_ABNORMAL | EDGE_ABNORMAL_CALL | EDGE_EH)
  93
  94 /* Counter summary from the last set of coverage counts read by
  95    profile.c.  */
  96 extern const struct gcov_ctr_summary *profile_info;
  97
  98 /* Declared in cfgloop.h.  */
  99 struct loop;
 100
 101 /* Declared in tree-flow.h.  */
 102 struct rtl_bb_info;
 103
 104 /* A basic block is a sequence of instructions with only entry and
 105    only one exit.  If any one of the instructions are executed, they
 106    will all be executed, and in sequence from first to last.
 107
 108    There may be COND_EXEC instructions in the basic block.  The
 109    COND_EXEC *instructions* will be executed -- but if the condition
 110    is false the conditionally executed *expressions* will of course
 111    not be executed.  We don't consider the conditionally executed
 112    expression (which might have side-effects) to be in a separate
 113    basic block because the program counter will always be at the same
 114    location after the COND_EXEC instruction, regardless of whether the
 115    condition is true or not.
 116
 117    Basic blocks need not start with a label nor end with a jump insn.
 118    For example, a previous basic block may just "conditionally fall"
 119    into the succeeding basic block, and the last basic block need not
 120    end with a jump insn.  Block 0 is a descendant of the entry block.
 121
 122    A basic block beginning with two labels cannot have notes between
 123    the labels.
 124
 125    Data for jump tables are stored in jump_insns that occur in no
 126    basic block even though these insns can follow or precede insns in
 127    basic blocks.  */
 128
 129 /* Basic block information indexed by block number.  */
 130 struct GTY((chain_next ("%h.next_bb"), chain_prev ("%h.prev_bb"))) basic_block_def {
 131   /* The edges into and out of the block.  */
 132   VEC(edge,gc) *preds;
 133   VEC(edge,gc) *succs;
 134
 135   /* Auxiliary info specific to a pass.  */
 136   PTR GTY ((skip (""))) aux;
 137
 138   /* Innermost loop containing the block.  */
 139   struct loop *loop_father;
 140
 141   /* The dominance and postdominance information node.  */
 142   struct et_node * GTY ((skip (""))) dom[2];
 143
 144   /* Previous and next blocks in the chain.  */
 145   struct basic_block_def *prev_bb;
 146   struct basic_block_def *next_bb;
 147
 148   union basic_block_il_dependent {
 149       struct gimple_bb_info * GTY ((tag ("0"))) gimple;
 150       struct rtl_bb_info * GTY ((tag ("1"))) rtl;
 151     } GTY ((desc ("((%1.flags & BB_RTL) != 0)"))) il;
 152
 153   /* Expected number of executions: calculated in profile.c.  */
 154   gcov_type count;
 155
 156   /* The index of this block.  */
 157   int index;
 158
 159   /* The loop depth of this block.  */
 160   int loop_depth;
 161
 162   /* Expected frequency.  Normalized to be in range 0 to BB_FREQ_MAX.  */
 163   int frequency;
 164
 165   /* The discriminator for this block.  */
 166   int discriminator;
 167
 168   /* Various flags.  See BB_* below.  */
 169   int flags;
 170 };
 171
 172 struct GTY(()) rtl_bb_info {
 173   /* The first and last insns of the block.  */
 174   rtx head_;
 175   rtx end_;
 176
 177   /* In CFGlayout mode points to insn notes/jumptables to be placed just before
 178      and after the block.   */
 179   rtx header;
 180   rtx footer;
 181
 182   /* This field is used by the bb-reorder and tracer passes.  */
 183   int visited;
 184 };
 185
 186 struct GTY(()) gimple_bb_info {
 187   /* Sequence of statements in this block.  */
 188   gimple_seq seq;
 189
 190   /* PHI nodes for this block.  */
 191   gimple_seq phi_nodes;
 192 };
 193
 194 DEF_VEC_P(basic_block);
 195 DEF_VEC_ALLOC_P(basic_block,gc);
 196 DEF_VEC_ALLOC_P(basic_block,heap);
 197
 198 #define BB_FREQ_MAX 10000
 199
 200 /* Masks for basic_block.flags.
 201
 202    BB_HOT_PARTITION and BB_COLD_PARTITION should be preserved throughout
 203    the compilation, so they are never cleared.
 204
 205    All other flags may be cleared by clear_bb_flags().  It is generally
 206    a bad idea to rely on any flags being up-to-date.  */
 207
 208 enum bb_flags
 209 {
 210   /* Only set on blocks that have just been created by create_bb.  */
 211   BB_NEW = 1 << 0,
 212
 213   /* Set by find_unreachable_blocks.  Do not rely on this being set in any
 214      pass.  */
 215   BB_REACHABLE = 1 << 1,
 216
 217   /* Set for blocks in an irreducible loop by loop analysis.  */
 218   BB_IRREDUCIBLE_LOOP = 1 << 2,
 219
 220   /* Set on blocks that may actually not be single-entry single-exit block.  */
 221   BB_SUPERBLOCK = 1 << 3,
 222
 223   /* Set on basic blocks that the scheduler should not touch.  This is used
 224      by SMS to prevent other schedulers from messing with the loop schedule.  */
 225   BB_DISABLE_SCHEDULE = 1 << 4,
 226
 227   /* Set on blocks that should be put in a hot section.  */
 228   BB_HOT_PARTITION = 1 << 5,
 229
 230   /* Set on blocks that should be put in a cold section.  */
 231   BB_COLD_PARTITION = 1 << 6,
 232
 233   /* Set on block that was duplicated.  */
 234   BB_DUPLICATED = 1 << 7,
 235
 236   /* Set if the label at the top of this block is the target of a non-local goto.  */
 237   BB_NON_LOCAL_GOTO_TARGET = 1 << 8,
 238
 239   /* Set on blocks that are in RTL format.  */
 240   BB_RTL = 1 << 9 ,
 241
 242   /* Set on blocks that are forwarder blocks.
 243      Only used in cfgcleanup.c.  */
 244   BB_FORWARDER_BLOCK = 1 << 10,
 245
 246   /* Set on blocks that cannot be threaded through.
 247      Only used in cfgcleanup.c.  */
 248   BB_NONTHREADABLE_BLOCK = 1 << 11
 249 };
 250
 251 /* Dummy flag for convenience in the hot/cold partitioning code.  */
 252 #define BB_UNPARTITIONED        0
 253
 254 /* Partitions, to be used when partitioning hot and cold basic blocks into
 255    separate sections.  */
 256 #define BB_PARTITION(bb) ((bb)->flags & (BB_HOT_PARTITION|BB_COLD_PARTITION))
 257 #define BB_SET_PARTITION(bb, part) do {                                 \
 258   basic_block bb_ = (bb);                                               \
 259   bb_->flags = ((bb_->flags & ~(BB_HOT_PARTITION|BB_COLD_PARTITION))    \
 260                 | (part));                                              \
 261 } while (0)
 262
 263 #define BB_COPY_PARTITION(dstbb, srcbb) \
 264   BB_SET_PARTITION (dstbb, BB_PARTITION (srcbb))
 265
 266 /* State of dominance information.  */
 267
 268 enum dom_state
 269 {
 270   DOM_NONE,             /* Not computed at all.  */
 271   DOM_NO_FAST_QUERY,    /* The data is OK, but the fast query data are not usable.  */
 272   DOM_OK                /* Everything is ok.  */
 273 };
 274
 275 /* What sort of profiling information we have.  */
 276 enum profile_status_d
 277 {
 278   PROFILE_ABSENT,
 279   PROFILE_GUESSED,
 280   PROFILE_READ
 281 };
 282
 283 /* A structure to group all the per-function control flow graph data.
 284    The x_* prefixing is necessary because otherwise references to the
 285    fields of this struct are interpreted as the defines for backward
 286    source compatibility following the definition of this struct.  */
 287 struct GTY(()) control_flow_graph {
 288   /* Block pointers for the exit and entry of a function.
 289      These are always the head and tail of the basic block list.  */
 290   basic_block x_entry_block_ptr;
 291   basic_block x_exit_block_ptr;
 292
 293   /* Index by basic block number, get basic block struct info.  */
 294   VEC(basic_block,gc) *x_basic_block_info;
 295
 296   /* Number of basic blocks in this flow graph.  */
 297   int x_n_basic_blocks;
 298
 299   /* Number of edges in this flow graph.  */
 300   int x_n_edges;
 301
 302   /* The first free basic block number.  */
 303   int x_last_basic_block;
 304
 305   /* UIDs for LABEL_DECLs.  */
 306   int last_label_uid;
 307
 308   /* Mapping of labels to their associated blocks.  At present
 309      only used for the gimple CFG.  */
 310   VEC(basic_block,gc) *x_label_to_block_map;
 311
 312   enum profile_status_d x_profile_status;
 313
 314   /* Whether the dominators and the postdominators are available.  */
 315   enum dom_state x_dom_computed[2];
 316
 317   /* Number of basic blocks in the dominance tree.  */
 318   unsigned x_n_bbs_in_dom_tree[2];
 319
 320   /* Maximal number of entities in the single jumptable.  Used to estimate
 321      final flowgraph size.  */
 322   int max_jumptable_ents;
 323 };
 324
 325 /* Defines for accessing the fields of the CFG structure for function FN.  */
 326 #define ENTRY_BLOCK_PTR_FOR_FUNCTION(FN)     ((FN)->cfg->x_entry_block_ptr)
 327 #define EXIT_BLOCK_PTR_FOR_FUNCTION(FN)      ((FN)->cfg->x_exit_block_ptr)
 328 #define basic_block_info_for_function(FN)    ((FN)->cfg->x_basic_block_info)
 329 #define n_basic_blocks_for_function(FN)      ((FN)->cfg->x_n_basic_blocks)
 330 #define n_edges_for_function(FN)             ((FN)->cfg->x_n_edges)
 331 #define last_basic_block_for_function(FN)    ((FN)->cfg->x_last_basic_block)
 332 #define label_to_block_map_for_function(FN)  ((FN)->cfg->x_label_to_block_map)
 333 #define profile_status_for_function(FN)      ((FN)->cfg->x_profile_status)
 334
 335 #define BASIC_BLOCK_FOR_FUNCTION(FN,N) \
 336   (VEC_index (basic_block, basic_block_info_for_function(FN), (N)))
 337 #define SET_BASIC_BLOCK_FOR_FUNCTION(FN,N,BB) \
 338   (VEC_replace (basic_block, basic_block_info_for_function(FN), (N), (BB)))
 339
 340 /* Defines for textual backward source compatibility.  */
 341 #define ENTRY_BLOCK_PTR         (cfun->cfg->x_entry_block_ptr)
 342 #define EXIT_BLOCK_PTR          (cfun->cfg->x_exit_block_ptr)
 343 #define basic_block_info        (cfun->cfg->x_basic_block_info)
 344 #define n_basic_blocks          (cfun->cfg->x_n_basic_blocks)
 345 #define n_edges                 (cfun->cfg->x_n_edges)
 346 #define last_basic_block        (cfun->cfg->x_last_basic_block)
 347 #define label_to_block_map      (cfun->cfg->x_label_to_block_map)
 348 #define profile_status          (cfun->cfg->x_profile_status)
 349
 350 #define BASIC_BLOCK(N)          (VEC_index (basic_block, basic_block_info, (N)))
 351 #define SET_BASIC_BLOCK(N,BB)   (VEC_replace (basic_block, basic_block_info, (N), (BB)))
 352
 353 /* For iterating over basic blocks.  */
 354 #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \
 355   for (BB = FROM; BB != TO; BB = BB->DIR)
 356
 357 #define FOR_EACH_BB_FN(BB, FN) \
 358   FOR_BB_BETWEEN (BB, (FN)->cfg->x_entry_block_ptr->next_bb, (FN)->cfg->x_exit_block_ptr, next_bb)
 359
 360 #define FOR_EACH_BB(BB) FOR_EACH_BB_FN (BB, cfun)
 361
 362 #define FOR_EACH_BB_REVERSE_FN(BB, FN) \
 363   FOR_BB_BETWEEN (BB, (FN)->cfg->x_exit_block_ptr->prev_bb, (FN)->cfg->x_entry_block_ptr, prev_bb)
 364
 365 #define FOR_EACH_BB_REVERSE(BB) FOR_EACH_BB_REVERSE_FN(BB, cfun)
 366
 367 /* For iterating over insns in basic block.  */
 368 #define FOR_BB_INSNS(BB, INSN)                  \
 369   for ((INSN) = BB_HEAD (BB);                   \
 370        (INSN) && (INSN) != NEXT_INSN (BB_END (BB));     \
 371        (INSN) = NEXT_INSN (INSN))
 372
 373 /* For iterating over insns in basic block when we might remove the
 374    current insn.  */
 375 #define FOR_BB_INSNS_SAFE(BB, INSN, CURR)                       \
 376   for ((INSN) = BB_HEAD (BB), (CURR) = (INSN) ? NEXT_INSN ((INSN)): NULL;       \
 377        (INSN) && (INSN) != NEXT_INSN (BB_END (BB));     \
 378        (INSN) = (CURR), (CURR) = (INSN) ? NEXT_INSN ((INSN)) : NULL)
 379
 380 #define FOR_BB_INSNS_REVERSE(BB, INSN)          \
 381   for ((INSN) = BB_END (BB);                    \
 382        (INSN) && (INSN) != PREV_INSN (BB_HEAD (BB));    \
 383        (INSN) = PREV_INSN (INSN))
 384
 385 #define FOR_BB_INSNS_REVERSE_SAFE(BB, INSN, CURR)       \
 386   for ((INSN) = BB_END (BB),(CURR) = (INSN) ? PREV_INSN ((INSN)) : NULL;        \
 387        (INSN) && (INSN) != PREV_INSN (BB_HEAD (BB));    \
 388        (INSN) = (CURR), (CURR) = (INSN) ? PREV_INSN ((INSN)) : NULL)
 389
 390 /* Cycles through _all_ basic blocks, even the fake ones (entry and
 391    exit block).  */
 392
 393 #define FOR_ALL_BB(BB) \
 394   for (BB = ENTRY_BLOCK_PTR; BB; BB = BB->next_bb)
 395
 396 #define FOR_ALL_BB_FN(BB, FN) \
 397   for (BB = ENTRY_BLOCK_PTR_FOR_FUNCTION (FN); BB; BB = BB->next_bb)
 398
 399 \f
 400 /* Stuff for recording basic block info.  */
 401
 402 #define BB_HEAD(B)      (B)->il.rtl->head_
 403 #define BB_END(B)       (B)->il.rtl->end_
 404
 405 /* Special block numbers [markers] for entry and exit.
 406    Neither of them is supposed to hold actual statements.  */
 407 #define ENTRY_BLOCK (0)
 408 #define EXIT_BLOCK (1)
 409
 410 /* The two blocks that are always in the cfg.  */
 411 #define NUM_FIXED_BLOCKS (2)
 412
 413 #define set_block_for_insn(INSN, BB)  (BLOCK_FOR_INSN (INSN) = BB)
 414
 415 extern void compute_bb_for_insn (void);
 416 extern unsigned int free_bb_for_insn (void);
 417 extern void update_bb_for_insn (basic_block);
 418
 419 extern void insert_insn_on_edge (rtx, edge);
 420 basic_block split_edge_and_insert (edge, rtx);
 421
 422 extern void commit_one_edge_insertion (edge e);
 423 extern void commit_edge_insertions (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_raw (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 int post_order_compute (int *, bool, bool);
 440 extern int inverted_post_order_compute (int *);
 441 extern int pre_and_rev_post_order_compute (int *, int *, bool);
 442 extern int dfs_enumerate_from (basic_block, int,
 443                                bool (*)(const_basic_block, const void *),
 444                                basic_block *, int, const void *);
 445 extern void compute_dominance_frontiers (struct bitmap_head_def *);
 446 extern bitmap compute_idf (bitmap, struct bitmap_head_def *);
 447 extern void dump_bb_info (basic_block, bool, bool, int, const char *, FILE *);
 448 extern void dump_edge_info (FILE *, edge, int);
 449 extern void brief_dump_cfg (FILE *);
 450 extern void clear_edges (void);
 451 extern void scale_bbs_frequencies_int (basic_block *, int, int, int);
 452 extern void scale_bbs_frequencies_gcov_type (basic_block *, int, gcov_type,
 453                                              gcov_type);
 454
 455 /* Structure to group all of the information to process IF-THEN and
 456    IF-THEN-ELSE blocks for the conditional execution support.  This
 457    needs to be in a public file in case the IFCVT macros call
 458    functions passing the ce_if_block data structure.  */
 459
 460 typedef struct ce_if_block
 461 {
 462   basic_block test_bb;                  /* First test block.  */
 463   basic_block then_bb;                  /* THEN block.  */
 464   basic_block else_bb;                  /* ELSE block or NULL.  */
 465   basic_block join_bb;                  /* Join THEN/ELSE blocks.  */
 466   basic_block last_test_bb;             /* Last bb to hold && or || tests.  */
 467   int num_multiple_test_blocks;         /* # of && and || basic blocks.  */
 468   int num_and_and_blocks;               /* # of && blocks.  */
 469   int num_or_or_blocks;                 /* # of || blocks.  */
 470   int num_multiple_test_insns;          /* # of insns in && and || blocks.  */
 471   int and_and_p;                        /* Complex test is &&.  */
 472   int num_then_insns;                   /* # of insns in THEN block.  */
 473   int num_else_insns;                   /* # of insns in ELSE block.  */
 474   int pass;                             /* Pass number.  */
 475
 476 #ifdef IFCVT_EXTRA_FIELDS
 477   IFCVT_EXTRA_FIELDS                    /* Any machine dependent fields.  */
 478 #endif
 479
 480 } ce_if_block_t;
 481
 482 /* This structure maintains an edge list vector.  */
 483 struct edge_list
 484 {
 485   int num_blocks;
 486   int num_edges;
 487   edge *index_to_edge;
 488 };
 489
 490 /* The base value for branch probability notes and edge probabilities.  */
 491 #define REG_BR_PROB_BASE  10000
 492
 493 /* This is the value which indicates no edge is present.  */
 494 #define EDGE_INDEX_NO_EDGE      -1
 495
 496 /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE
 497    if there is no edge between the 2 basic blocks.  */
 498 #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ)))
 499
 500 /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic
 501    block which is either the pred or succ end of the indexed edge.  */
 502 #define INDEX_EDGE_PRED_BB(el, index)   ((el)->index_to_edge[(index)]->src)
 503 #define INDEX_EDGE_SUCC_BB(el, index)   ((el)->index_to_edge[(index)]->dest)
 504
 505 /* INDEX_EDGE returns a pointer to the edge.  */
 506 #define INDEX_EDGE(el, index)           ((el)->index_to_edge[(index)])
 507
 508 /* Number of edges in the compressed edge list.  */
 509 #define NUM_EDGES(el)                   ((el)->num_edges)
 510
 511 /* BB is assumed to contain conditional jump.  Return the fallthru edge.  */
 512 #define FALLTHRU_EDGE(bb)               (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
 513                                          ? EDGE_SUCC ((bb), 0) : EDGE_SUCC ((bb), 1))
 514
 515 /* BB is assumed to contain conditional jump.  Return the branch edge.  */
 516 #define BRANCH_EDGE(bb)                 (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
 517                                          ? EDGE_SUCC ((bb), 1) : EDGE_SUCC ((bb), 0))
 518
 519 /* Return expected execution frequency of the edge E.  */
 520 #define EDGE_FREQUENCY(e)               (((e)->src->frequency \
 521                                           * (e)->probability \
 522                                           + REG_BR_PROB_BASE / 2) \
 523                                          / REG_BR_PROB_BASE)
 524
 525 /* Return nonzero if edge is critical.  */
 526 #define EDGE_CRITICAL_P(e)              (EDGE_COUNT ((e)->src->succs) >= 2 \
 527                                          && EDGE_COUNT ((e)->dest->preds) >= 2)
 528
 529 #define EDGE_COUNT(ev)                  VEC_length (edge, (ev))
 530 #define EDGE_I(ev,i)                    VEC_index  (edge, (ev), (i))
 531 #define EDGE_PRED(bb,i)                 VEC_index  (edge, (bb)->preds, (i))
 532 #define EDGE_SUCC(bb,i)                 VEC_index  (edge, (bb)->succs, (i))
 533
 534 /* Returns true if BB has precisely one successor.  */
 535
 536 static inline bool
 537 single_succ_p (const_basic_block bb)
 538 {
 539   return EDGE_COUNT (bb->succs) == 1;
 540 }
 541
 542 /* Returns true if BB has precisely one predecessor.  */
 543
 544 static inline bool
 545 single_pred_p (const_basic_block bb)
 546 {
 547   return EDGE_COUNT (bb->preds) == 1;
 548 }
 549
 550 /* Returns the single successor edge of basic block BB.  Aborts if
 551    BB does not have exactly one successor.  */
 552
 553 static inline edge
 554 single_succ_edge (const_basic_block bb)
 555 {
 556   gcc_checking_assert (single_succ_p (bb));
 557   return EDGE_SUCC (bb, 0);
 558 }
 559
 560 /* Returns the single predecessor edge of basic block BB.  Aborts
 561    if BB does not have exactly one predecessor.  */
 562
 563 static inline edge
 564 single_pred_edge (const_basic_block bb)
 565 {
 566   gcc_checking_assert (single_pred_p (bb));
 567   return EDGE_PRED (bb, 0);
 568 }
 569
 570 /* Returns the single successor block of basic block BB.  Aborts
 571    if BB does not have exactly one successor.  */
 572
 573 static inline basic_block
 574 single_succ (const_basic_block bb)
 575 {
 576   return single_succ_edge (bb)->dest;
 577 }
 578
 579 /* Returns the single predecessor block of basic block BB.  Aborts
 580    if BB does not have exactly one predecessor.*/
 581
 582 static inline basic_block
 583 single_pred (const_basic_block bb)
 584 {
 585   return single_pred_edge (bb)->src;
 586 }
 587
 588 /* Iterator object for edges.  */
 589
 590 typedef struct {
 591   unsigned index;
 592   VEC(edge,gc) **container;
 593 } edge_iterator;
 594
 595 static inline VEC(edge,gc) *
 596 ei_container (edge_iterator i)
 597 {
 598   gcc_checking_assert (i.container);
 599   return *i.container;
 600 }
 601
 602 #define ei_start(iter) ei_start_1 (&(iter))
 603 #define ei_last(iter) ei_last_1 (&(iter))
 604
 605 /* Return an iterator pointing to the start of an edge vector.  */
 606 static inline edge_iterator
 607 ei_start_1 (VEC(edge,gc) **ev)
 608 {
 609   edge_iterator i;
 610
 611   i.index = 0;
 612   i.container = ev;
 613
 614   return i;
 615 }
 616
 617 /* Return an iterator pointing to the last element of an edge
 618    vector.  */
 619 static inline edge_iterator
 620 ei_last_1 (VEC(edge,gc) **ev)
 621 {
 622   edge_iterator i;
 623
 624   i.index = EDGE_COUNT (*ev) - 1;
 625   i.container = ev;
 626
 627   return i;
 628 }
 629
 630 /* Is the iterator `i' at the end of the sequence?  */
 631 static inline bool
 632 ei_end_p (edge_iterator i)
 633 {
 634   return (i.index == EDGE_COUNT (ei_container (i)));
 635 }
 636
 637 /* Is the iterator `i' at one position before the end of the
 638    sequence?  */
 639 static inline bool
 640 ei_one_before_end_p (edge_iterator i)
 641 {
 642   return (i.index + 1 == EDGE_COUNT (ei_container (i)));
 643 }
 644
 645 /* Advance the iterator to the next element.  */
 646 static inline void
 647 ei_next (edge_iterator *i)
 648 {
 649   gcc_checking_assert (i->index < EDGE_COUNT (ei_container (*i)));
 650   i->index++;
 651 }
 652
 653 /* Move the iterator to the previous element.  */
 654 static inline void
 655 ei_prev (edge_iterator *i)
 656 {
 657   gcc_checking_assert (i->index > 0);
 658   i->index--;
 659 }
 660
 661 /* Return the edge pointed to by the iterator `i'.  */
 662 static inline edge
 663 ei_edge (edge_iterator i)
 664 {
 665   return EDGE_I (ei_container (i), i.index);
 666 }
 667
 668 /* Return an edge pointed to by the iterator.  Do it safely so that
 669    NULL is returned when the iterator is pointing at the end of the
 670    sequence.  */
 671 static inline edge
 672 ei_safe_edge (edge_iterator i)
 673 {
 674   return !ei_end_p (i) ? ei_edge (i) : NULL;
 675 }
 676
 677 /* Return 1 if we should continue to iterate.  Return 0 otherwise.
 678    *Edge P is set to the next edge if we are to continue to iterate
 679    and NULL otherwise.  */
 680
 681 static inline bool
 682 ei_cond (edge_iterator ei, edge *p)
 683 {
 684   if (!ei_end_p (ei))
 685     {
 686       *p = ei_edge (ei);
 687       return 1;
 688     }
 689   else
 690     {
 691       *p = NULL;
 692       return 0;
 693     }
 694 }
 695
 696 /* This macro serves as a convenient way to iterate each edge in a
 697    vector of predecessor or successor edges.  It must not be used when
 698    an element might be removed during the traversal, otherwise
 699    elements will be missed.  Instead, use a for-loop like that shown
 700    in the following pseudo-code:
 701
 702    FOR (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
 703      {
 704         IF (e != taken_edge)
 705           remove_edge (e);
 706         ELSE
 707           ei_next (&ei);
 708      }
 709 */
 710
 711 #define FOR_EACH_EDGE(EDGE,ITER,EDGE_VEC)       \
 712   for ((ITER) = ei_start ((EDGE_VEC));          \
 713        ei_cond ((ITER), &(EDGE));               \
 714        ei_next (&(ITER)))
 715
 716 struct edge_list * create_edge_list (void);
 717 void free_edge_list (struct edge_list *);
 718 void print_edge_list (FILE *, struct edge_list *);
 719 void verify_edge_list (FILE *, struct edge_list *);
 720 int find_edge_index (struct edge_list *, basic_block, basic_block);
 721 edge find_edge (basic_block, basic_block);
 722
 723 #define CLEANUP_EXPENSIVE       1       /* Do relatively expensive optimizations
 724                                            except for edge forwarding */
 725 #define CLEANUP_CROSSJUMP       2       /* Do crossjumping.  */
 726 #define CLEANUP_POST_REGSTACK   4       /* We run after reg-stack and need
 727                                            to care REG_DEAD notes.  */
 728 #define CLEANUP_THREADING       8       /* Do jump threading.  */
 729 #define CLEANUP_NO_INSN_DEL     16      /* Do not try to delete trivially dead
 730                                            insns.  */
 731 #define CLEANUP_CFGLAYOUT       32      /* Do cleanup in cfglayout mode.  */
 732
 733 /* In lcm.c */
 734 extern struct edge_list *pre_edge_lcm (int, sbitmap *, sbitmap *,
 735                                        sbitmap *, sbitmap *, sbitmap **,
 736                                        sbitmap **);
 737 extern struct edge_list *pre_edge_rev_lcm (int, sbitmap *,
 738                                            sbitmap *, sbitmap *,
 739                                            sbitmap *, sbitmap **,
 740                                            sbitmap **);
 741 extern void compute_available (sbitmap *, sbitmap *, sbitmap *, sbitmap *);
 742
 743 /* In predict.c */
 744 extern bool maybe_hot_bb_p (const_basic_block);
 745 extern bool maybe_hot_edge_p (edge);
 746 extern bool probably_never_executed_bb_p (const_basic_block);
 747 extern bool optimize_bb_for_size_p (const_basic_block);
 748 extern bool optimize_bb_for_speed_p (const_basic_block);
 749 extern bool optimize_edge_for_size_p (edge);
 750 extern bool optimize_edge_for_speed_p (edge);
 751 extern bool optimize_loop_for_size_p (struct loop *);
 752 extern bool optimize_loop_for_speed_p (struct loop *);
 753 extern bool optimize_loop_nest_for_size_p (struct loop *);
 754 extern bool optimize_loop_nest_for_speed_p (struct loop *);
 755 extern bool gimple_predicted_by_p (const_basic_block, enum br_predictor);
 756 extern bool rtl_predicted_by_p (const_basic_block, enum br_predictor);
 757 extern void gimple_predict_edge (edge, enum br_predictor, int);
 758 extern void rtl_predict_edge (edge, enum br_predictor, int);
 759 extern void predict_edge_def (edge, enum br_predictor, enum prediction);
 760 extern void guess_outgoing_edge_probabilities (basic_block);
 761 extern void remove_predictions_associated_with_edge (edge);
 762 extern bool edge_probability_reliable_p (const_edge);
 763 extern bool br_prob_note_reliable_p (const_rtx);
 764 extern bool predictable_edge_p (edge);
 765
 766 /* In cfg.c  */
 767 extern void init_flow (struct function *);
 768 extern void debug_bb (basic_block);
 769 extern basic_block debug_bb_n (int);
 770 extern void expunge_block (basic_block);
 771 extern void link_block (basic_block, basic_block);
 772 extern void unlink_block (basic_block);
 773 extern void compact_blocks (void);
 774 extern basic_block alloc_block (void);
 775 extern void alloc_aux_for_blocks (int);
 776 extern void clear_aux_for_blocks (void);
 777 extern void free_aux_for_blocks (void);
 778 extern void alloc_aux_for_edges (int);
 779 extern void clear_aux_for_edges (void);
 780 extern void free_aux_for_edges (void);
 781
 782 /* In cfganal.c  */
 783 extern void find_unreachable_blocks (void);
 784 extern bool forwarder_block_p (const_basic_block);
 785 extern bool can_fallthru (basic_block, basic_block);
 786 extern bool could_fall_through (basic_block, basic_block);
 787 extern void flow_nodes_print (const char *, const_sbitmap, FILE *);
 788 extern void flow_edge_list_print (const char *, const edge *, int, FILE *);
 789
 790 /* In cfgrtl.c  */
 791 extern basic_block force_nonfallthru (edge);
 792 extern rtx block_label (basic_block);
 793 extern bool purge_all_dead_edges (void);
 794 extern bool purge_dead_edges (basic_block);
 795
 796 /* In cfgbuild.c.  */
 797 extern void find_many_sub_basic_blocks (sbitmap);
 798 extern void rtl_make_eh_edge (sbitmap, basic_block, rtx);
 799
 800 /* In cfgcleanup.c.  */
 801 extern bool cleanup_cfg (int);
 802 extern int flow_find_cross_jump (basic_block, basic_block, rtx *, rtx *);
 803 extern int flow_find_head_matching_sequence (basic_block, basic_block,
 804                                              rtx *, rtx *, int);
 805
 806 extern bool delete_unreachable_blocks (void);
 807
 808 extern bool mark_dfs_back_edges (void);
 809 extern void set_edge_can_fallthru_flag (void);
 810 extern void update_br_prob_note (basic_block);
 811 extern void fixup_abnormal_edges (void);
 812 extern bool inside_basic_block_p (const_rtx);
 813 extern bool control_flow_insn_p (const_rtx);
 814 extern rtx get_last_bb_insn (basic_block);
 815
 816 /* In bb-reorder.c */
 817 extern void reorder_basic_blocks (void);
 818
 819 /* In dominance.c */
 820
 821 enum cdi_direction
 822 {
 823   CDI_DOMINATORS = 1,
 824   CDI_POST_DOMINATORS = 2
 825 };
 826
 827 extern enum dom_state dom_info_state (enum cdi_direction);
 828 extern void set_dom_info_availability (enum cdi_direction, enum dom_state);
 829 extern bool dom_info_available_p (enum cdi_direction);
 830 extern void calculate_dominance_info (enum cdi_direction);
 831 extern void free_dominance_info (enum cdi_direction);
 832 extern basic_block nearest_common_dominator (enum cdi_direction,
 833                                              basic_block, basic_block);
 834 extern basic_block nearest_common_dominator_for_set (enum cdi_direction,
 835                                                      bitmap);
 836 extern void set_immediate_dominator (enum cdi_direction, basic_block,
 837                                      basic_block);
 838 extern basic_block get_immediate_dominator (enum cdi_direction, basic_block);
 839 extern bool dominated_by_p (enum cdi_direction, const_basic_block, const_basic_block);
 840 extern VEC (basic_block, heap) *get_dominated_by (enum cdi_direction, basic_block);
 841 extern VEC (basic_block, heap) *get_dominated_by_region (enum cdi_direction,
 842                                                          basic_block *,
 843                                                          unsigned);
 844 extern VEC (basic_block, heap) *get_dominated_to_depth (enum cdi_direction,
 845                                                         basic_block, int);
 846 extern VEC (basic_block, heap) *get_all_dominated_blocks (enum cdi_direction,
 847                                                           basic_block);
 848 extern void add_to_dominance_info (enum cdi_direction, basic_block);
 849 extern void delete_from_dominance_info (enum cdi_direction, basic_block);
 850 basic_block recompute_dominator (enum cdi_direction, basic_block);
 851 extern void redirect_immediate_dominators (enum cdi_direction, basic_block,
 852                                            basic_block);
 853 extern void iterate_fix_dominators (enum cdi_direction,
 854                                     VEC (basic_block, heap) *, bool);
 855 extern void verify_dominators (enum cdi_direction);
 856 extern basic_block first_dom_son (enum cdi_direction, basic_block);
 857 extern basic_block next_dom_son (enum cdi_direction, basic_block);
 858 unsigned bb_dom_dfs_in (enum cdi_direction, basic_block);
 859 unsigned bb_dom_dfs_out (enum cdi_direction, basic_block);
 860
 861 extern edge try_redirect_by_replacing_jump (edge, basic_block, bool);
 862 extern void break_superblocks (void);
 863 extern void relink_block_chain (bool);
 864 extern void check_bb_profile (basic_block, FILE *);
 865 extern void update_bb_profile_for_threading (basic_block, int, gcov_type, edge);
 866 extern void init_rtl_bb_info (basic_block);
 867
 868 extern void initialize_original_copy_tables (void);
 869 extern void free_original_copy_tables (void);
 870 extern void set_bb_original (basic_block, basic_block);
 871 extern basic_block get_bb_original (basic_block);
 872 extern void set_bb_copy (basic_block, basic_block);
 873 extern basic_block get_bb_copy (basic_block);
 874 void set_loop_copy (struct loop *, struct loop *);
 875 struct loop *get_loop_copy (struct loop *);
 876
 877 #include "cfghooks.h"
 878
 879 /* Return true when one of the predecessor edges of BB is marked with EDGE_EH.  */
 880 static inline bool
 881 bb_has_eh_pred (basic_block bb)
 882 {
 883   edge e;
 884   edge_iterator ei;
 885
 886   FOR_EACH_EDGE (e, ei, bb->preds)
 887     {
 888       if (e->flags & EDGE_EH)
 889         return true;
 890     }
 891   return false;
 892 }
 893
 894 /* Return true when one of the predecessor edges of BB is marked with EDGE_ABNORMAL.  */
 895 static inline bool
 896 bb_has_abnormal_pred (basic_block bb)
 897 {
 898   edge e;
 899   edge_iterator ei;
 900
 901   FOR_EACH_EDGE (e, ei, bb->preds)
 902     {
 903       if (e->flags & EDGE_ABNORMAL)
 904         return true;
 905     }
 906   return false;
 907 }
 908
 909 /* Return the fallthru edge in EDGES if it exists, NULL otherwise.  */
 910 static inline edge
 911 find_fallthru_edge (VEC(edge,gc) *edges)
 912 {
 913   edge e;
 914   edge_iterator ei;
 915
 916   FOR_EACH_EDGE (e, ei, edges)
 917     if (e->flags & EDGE_FALLTHRU)
 918       break;
 919
 920   return e;
 921 }
 922
 923 /* In cfgloopmanip.c.  */
 924 extern edge mfb_kj_edge;
 925 extern bool mfb_keep_just (edge);
 926
 927 /* In cfgexpand.c.  */
 928 extern void rtl_profile_for_bb (basic_block);
 929 extern void rtl_profile_for_edge (edge);
 930 extern void default_rtl_profile (void);
 931
 932 #endif /* GCC_BASIC_BLOCK_H */