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   /* Set on blocks that were modified in some way.  This bit is set in
 251      df_set_bb_dirty, but not cleared by df_analyze, so it can be used
 252      to test whether a block has been modified prior to a df_analyze
 253      call.  */
 254   BB_MODIFIED = 1 << 12
 255 };
 256
 257 /* Dummy flag for convenience in the hot/cold partitioning code.  */
 258 #define BB_UNPARTITIONED        0
 259
 260 /* Partitions, to be used when partitioning hot and cold basic blocks into
 261    separate sections.  */
 262 #define BB_PARTITION(bb) ((bb)->flags & (BB_HOT_PARTITION|BB_COLD_PARTITION))
 263 #define BB_SET_PARTITION(bb, part) do {                                 \
 264   basic_block bb_ = (bb);                                               \
 265   bb_->flags = ((bb_->flags & ~(BB_HOT_PARTITION|BB_COLD_PARTITION))    \
 266                 | (part));                                              \
 267 } while (0)
 268
 269 #define BB_COPY_PARTITION(dstbb, srcbb) \
 270   BB_SET_PARTITION (dstbb, BB_PARTITION (srcbb))
 271
 272 /* State of dominance information.  */
 273
 274 enum dom_state
 275 {
 276   DOM_NONE,             /* Not computed at all.  */
 277   DOM_NO_FAST_QUERY,    /* The data is OK, but the fast query data are not usable.  */
 278   DOM_OK                /* Everything is ok.  */
 279 };
 280
 281 /* What sort of profiling information we have.  */
 282 enum profile_status_d
 283 {
 284   PROFILE_ABSENT,
 285   PROFILE_GUESSED,
 286   PROFILE_READ,
 287   PROFILE_LAST  /* Last value, used by profile streaming.  */
 288 };
 289
 290 /* A structure to group all the per-function control flow graph data.
 291    The x_* prefixing is necessary because otherwise references to the
 292    fields of this struct are interpreted as the defines for backward
 293    source compatibility following the definition of this struct.  */
 294 struct GTY(()) control_flow_graph {
 295   /* Block pointers for the exit and entry of a function.
 296      These are always the head and tail of the basic block list.  */
 297   basic_block x_entry_block_ptr;
 298   basic_block x_exit_block_ptr;
 299
 300   /* Index by basic block number, get basic block struct info.  */
 301   VEC(basic_block,gc) *x_basic_block_info;
 302
 303   /* Number of basic blocks in this flow graph.  */
 304   int x_n_basic_blocks;
 305
 306   /* Number of edges in this flow graph.  */
 307   int x_n_edges;
 308
 309   /* The first free basic block number.  */
 310   int x_last_basic_block;
 311
 312   /* UIDs for LABEL_DECLs.  */
 313   int last_label_uid;
 314
 315   /* Mapping of labels to their associated blocks.  At present
 316      only used for the gimple CFG.  */
 317   VEC(basic_block,gc) *x_label_to_block_map;
 318
 319   enum profile_status_d x_profile_status;
 320
 321   /* Whether the dominators and the postdominators are available.  */
 322   enum dom_state x_dom_computed[2];
 323
 324   /* Number of basic blocks in the dominance tree.  */
 325   unsigned x_n_bbs_in_dom_tree[2];
 326
 327   /* Maximal number of entities in the single jumptable.  Used to estimate
 328      final flowgraph size.  */
 329   int max_jumptable_ents;
 330 };
 331
 332 /* Defines for accessing the fields of the CFG structure for function FN.  */
 333 #define ENTRY_BLOCK_PTR_FOR_FUNCTION(FN)     ((FN)->cfg->x_entry_block_ptr)
 334 #define EXIT_BLOCK_PTR_FOR_FUNCTION(FN)      ((FN)->cfg->x_exit_block_ptr)
 335 #define basic_block_info_for_function(FN)    ((FN)->cfg->x_basic_block_info)
 336 #define n_basic_blocks_for_function(FN)      ((FN)->cfg->x_n_basic_blocks)
 337 #define n_edges_for_function(FN)             ((FN)->cfg->x_n_edges)
 338 #define last_basic_block_for_function(FN)    ((FN)->cfg->x_last_basic_block)
 339 #define label_to_block_map_for_function(FN)  ((FN)->cfg->x_label_to_block_map)
 340 #define profile_status_for_function(FN)      ((FN)->cfg->x_profile_status)
 341
 342 #define BASIC_BLOCK_FOR_FUNCTION(FN,N) \
 343   (VEC_index (basic_block, basic_block_info_for_function(FN), (N)))
 344 #define SET_BASIC_BLOCK_FOR_FUNCTION(FN,N,BB) \
 345   (VEC_replace (basic_block, basic_block_info_for_function(FN), (N), (BB)))
 346
 347 /* Defines for textual backward source compatibility.  */
 348 #define ENTRY_BLOCK_PTR         (cfun->cfg->x_entry_block_ptr)
 349 #define EXIT_BLOCK_PTR          (cfun->cfg->x_exit_block_ptr)
 350 #define basic_block_info        (cfun->cfg->x_basic_block_info)
 351 #define n_basic_blocks          (cfun->cfg->x_n_basic_blocks)
 352 #define n_edges                 (cfun->cfg->x_n_edges)
 353 #define last_basic_block        (cfun->cfg->x_last_basic_block)
 354 #define label_to_block_map      (cfun->cfg->x_label_to_block_map)
 355 #define profile_status          (cfun->cfg->x_profile_status)
 356
 357 #define BASIC_BLOCK(N)          (VEC_index (basic_block, basic_block_info, (N)))
 358 #define SET_BASIC_BLOCK(N,BB)   (VEC_replace (basic_block, basic_block_info, (N), (BB)))
 359
 360 /* For iterating over basic blocks.  */
 361 #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \
 362   for (BB = FROM; BB != TO; BB = BB->DIR)
 363
 364 #define FOR_EACH_BB_FN(BB, FN) \
 365   FOR_BB_BETWEEN (BB, (FN)->cfg->x_entry_block_ptr->next_bb, (FN)->cfg->x_exit_block_ptr, next_bb)
 366
 367 #define FOR_EACH_BB(BB) FOR_EACH_BB_FN (BB, cfun)
 368
 369 #define FOR_EACH_BB_REVERSE_FN(BB, FN) \
 370   FOR_BB_BETWEEN (BB, (FN)->cfg->x_exit_block_ptr->prev_bb, (FN)->cfg->x_entry_block_ptr, prev_bb)
 371
 372 #define FOR_EACH_BB_REVERSE(BB) FOR_EACH_BB_REVERSE_FN(BB, cfun)
 373
 374 /* For iterating over insns in basic block.  */
 375 #define FOR_BB_INSNS(BB, INSN)                  \
 376   for ((INSN) = BB_HEAD (BB);                   \
 377        (INSN) && (INSN) != NEXT_INSN (BB_END (BB));     \
 378        (INSN) = NEXT_INSN (INSN))
 379
 380 /* For iterating over insns in basic block when we might remove the
 381    current insn.  */
 382 #define FOR_BB_INSNS_SAFE(BB, INSN, CURR)                       \
 383   for ((INSN) = BB_HEAD (BB), (CURR) = (INSN) ? NEXT_INSN ((INSN)): NULL;       \
 384        (INSN) && (INSN) != NEXT_INSN (BB_END (BB));     \
 385        (INSN) = (CURR), (CURR) = (INSN) ? NEXT_INSN ((INSN)) : NULL)
 386
 387 #define FOR_BB_INSNS_REVERSE(BB, INSN)          \
 388   for ((INSN) = BB_END (BB);                    \
 389        (INSN) && (INSN) != PREV_INSN (BB_HEAD (BB));    \
 390        (INSN) = PREV_INSN (INSN))
 391
 392 #define FOR_BB_INSNS_REVERSE_SAFE(BB, INSN, CURR)       \
 393   for ((INSN) = BB_END (BB),(CURR) = (INSN) ? PREV_INSN ((INSN)) : NULL;        \
 394        (INSN) && (INSN) != PREV_INSN (BB_HEAD (BB));    \
 395        (INSN) = (CURR), (CURR) = (INSN) ? PREV_INSN ((INSN)) : NULL)
 396
 397 /* Cycles through _all_ basic blocks, even the fake ones (entry and
 398    exit block).  */
 399
 400 #define FOR_ALL_BB(BB) \
 401   for (BB = ENTRY_BLOCK_PTR; BB; BB = BB->next_bb)
 402
 403 #define FOR_ALL_BB_FN(BB, FN) \
 404   for (BB = ENTRY_BLOCK_PTR_FOR_FUNCTION (FN); BB; BB = BB->next_bb)
 405
 406 \f
 407 /* Stuff for recording basic block info.  */
 408
 409 #define BB_HEAD(B)      (B)->il.rtl->head_
 410 #define BB_END(B)       (B)->il.rtl->end_
 411
 412 /* Special block numbers [markers] for entry and exit.
 413    Neither of them is supposed to hold actual statements.  */
 414 #define ENTRY_BLOCK (0)
 415 #define EXIT_BLOCK (1)
 416
 417 /* The two blocks that are always in the cfg.  */
 418 #define NUM_FIXED_BLOCKS (2)
 419
 420 #define set_block_for_insn(INSN, BB)  (BLOCK_FOR_INSN (INSN) = BB)
 421
 422 extern void compute_bb_for_insn (void);
 423 extern unsigned int free_bb_for_insn (void);
 424 extern void update_bb_for_insn (basic_block);
 425
 426 extern void insert_insn_on_edge (rtx, edge);
 427 basic_block split_edge_and_insert (edge, rtx);
 428
 429 extern void commit_one_edge_insertion (edge e);
 430 extern void commit_edge_insertions (void);
 431
 432 extern void remove_fake_edges (void);
 433 extern void remove_fake_exit_edges (void);
 434 extern void add_noreturn_fake_exit_edges (void);
 435 extern void connect_infinite_loops_to_exit (void);
 436 extern edge unchecked_make_edge (basic_block, basic_block, int);
 437 extern edge cached_make_edge (sbitmap, basic_block, basic_block, int);
 438 extern edge make_edge (basic_block, basic_block, int);
 439 extern edge make_single_succ_edge (basic_block, basic_block, int);
 440 extern void remove_edge_raw (edge);
 441 extern void redirect_edge_succ (edge, basic_block);
 442 extern edge redirect_edge_succ_nodup (edge, basic_block);
 443 extern void redirect_edge_pred (edge, basic_block);
 444 extern basic_block create_basic_block_structure (rtx, rtx, rtx, basic_block);
 445 extern void clear_bb_flags (void);
 446 extern int post_order_compute (int *, bool, bool);
 447 extern int inverted_post_order_compute (int *);
 448 extern int pre_and_rev_post_order_compute (int *, int *, bool);
 449 extern int dfs_enumerate_from (basic_block, int,
 450                                bool (*)(const_basic_block, const void *),
 451                                basic_block *, int, const void *);
 452 extern void compute_dominance_frontiers (struct bitmap_head_def *);
 453 extern bitmap compute_idf (bitmap, struct bitmap_head_def *);
 454 extern void dump_bb_info (basic_block, bool, bool, int, const char *, FILE *);
 455 extern void dump_edge_info (FILE *, edge, int);
 456 extern void brief_dump_cfg (FILE *);
 457 extern void clear_edges (void);
 458 extern void scale_bbs_frequencies_int (basic_block *, int, int, int);
 459 extern void scale_bbs_frequencies_gcov_type (basic_block *, int, gcov_type,
 460                                              gcov_type);
 461
 462 /* Structure to group all of the information to process IF-THEN and
 463    IF-THEN-ELSE blocks for the conditional execution support.  This
 464    needs to be in a public file in case the IFCVT macros call
 465    functions passing the ce_if_block data structure.  */
 466
 467 typedef struct ce_if_block
 468 {
 469   basic_block test_bb;                  /* First test block.  */
 470   basic_block then_bb;                  /* THEN block.  */
 471   basic_block else_bb;                  /* ELSE block or NULL.  */
 472   basic_block join_bb;                  /* Join THEN/ELSE blocks.  */
 473   basic_block last_test_bb;             /* Last bb to hold && or || tests.  */
 474   int num_multiple_test_blocks;         /* # of && and || basic blocks.  */
 475   int num_and_and_blocks;               /* # of && blocks.  */
 476   int num_or_or_blocks;                 /* # of || blocks.  */
 477   int num_multiple_test_insns;          /* # of insns in && and || blocks.  */
 478   int and_and_p;                        /* Complex test is &&.  */
 479   int num_then_insns;                   /* # of insns in THEN block.  */
 480   int num_else_insns;                   /* # of insns in ELSE block.  */
 481   int pass;                             /* Pass number.  */
 482
 483 #ifdef IFCVT_EXTRA_FIELDS
 484   IFCVT_EXTRA_FIELDS                    /* Any machine dependent fields.  */
 485 #endif
 486
 487 } ce_if_block_t;
 488
 489 /* This structure maintains an edge list vector.  */
 490 struct edge_list
 491 {
 492   int num_blocks;
 493   int num_edges;
 494   edge *index_to_edge;
 495 };
 496
 497 /* The base value for branch probability notes and edge probabilities.  */
 498 #define REG_BR_PROB_BASE  10000
 499
 500 /* This is the value which indicates no edge is present.  */
 501 #define EDGE_INDEX_NO_EDGE      -1
 502
 503 /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE
 504    if there is no edge between the 2 basic blocks.  */
 505 #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ)))
 506
 507 /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic
 508    block which is either the pred or succ end of the indexed edge.  */
 509 #define INDEX_EDGE_PRED_BB(el, index)   ((el)->index_to_edge[(index)]->src)
 510 #define INDEX_EDGE_SUCC_BB(el, index)   ((el)->index_to_edge[(index)]->dest)
 511
 512 /* INDEX_EDGE returns a pointer to the edge.  */
 513 #define INDEX_EDGE(el, index)           ((el)->index_to_edge[(index)])
 514
 515 /* Number of edges in the compressed edge list.  */
 516 #define NUM_EDGES(el)                   ((el)->num_edges)
 517
 518 /* BB is assumed to contain conditional jump.  Return the fallthru edge.  */
 519 #define FALLTHRU_EDGE(bb)               (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
 520                                          ? EDGE_SUCC ((bb), 0) : EDGE_SUCC ((bb), 1))
 521
 522 /* BB is assumed to contain conditional jump.  Return the branch edge.  */
 523 #define BRANCH_EDGE(bb)                 (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
 524                                          ? EDGE_SUCC ((bb), 1) : EDGE_SUCC ((bb), 0))
 525
 526 /* Return expected execution frequency of the edge E.  */
 527 #define EDGE_FREQUENCY(e)               (((e)->src->frequency \
 528                                           * (e)->probability \
 529                                           + REG_BR_PROB_BASE / 2) \
 530                                          / REG_BR_PROB_BASE)
 531
 532 /* Return nonzero if edge is critical.  */
 533 #define EDGE_CRITICAL_P(e)              (EDGE_COUNT ((e)->src->succs) >= 2 \
 534                                          && EDGE_COUNT ((e)->dest->preds) >= 2)
 535
 536 #define EDGE_COUNT(ev)                  VEC_length (edge, (ev))
 537 #define EDGE_I(ev,i)                    VEC_index  (edge, (ev), (i))
 538 #define EDGE_PRED(bb,i)                 VEC_index  (edge, (bb)->preds, (i))
 539 #define EDGE_SUCC(bb,i)                 VEC_index  (edge, (bb)->succs, (i))
 540
 541 /* Returns true if BB has precisely one successor.  */
 542
 543 static inline bool
 544 single_succ_p (const_basic_block bb)
 545 {
 546   return EDGE_COUNT (bb->succs) == 1;
 547 }
 548
 549 /* Returns true if BB has precisely one predecessor.  */
 550
 551 static inline bool
 552 single_pred_p (const_basic_block bb)
 553 {
 554   return EDGE_COUNT (bb->preds) == 1;
 555 }
 556
 557 /* Returns the single successor edge of basic block BB.  Aborts if
 558    BB does not have exactly one successor.  */
 559
 560 static inline edge
 561 single_succ_edge (const_basic_block bb)
 562 {
 563   gcc_checking_assert (single_succ_p (bb));
 564   return EDGE_SUCC (bb, 0);
 565 }
 566
 567 /* Returns the single predecessor edge of basic block BB.  Aborts
 568    if BB does not have exactly one predecessor.  */
 569
 570 static inline edge
 571 single_pred_edge (const_basic_block bb)
 572 {
 573   gcc_checking_assert (single_pred_p (bb));
 574   return EDGE_PRED (bb, 0);
 575 }
 576
 577 /* Returns the single successor block of basic block BB.  Aborts
 578    if BB does not have exactly one successor.  */
 579
 580 static inline basic_block
 581 single_succ (const_basic_block bb)
 582 {
 583   return single_succ_edge (bb)->dest;
 584 }
 585
 586 /* Returns the single predecessor block of basic block BB.  Aborts
 587    if BB does not have exactly one predecessor.*/
 588
 589 static inline basic_block
 590 single_pred (const_basic_block bb)
 591 {
 592   return single_pred_edge (bb)->src;
 593 }
 594
 595 /* Iterator object for edges.  */
 596
 597 typedef struct {
 598   unsigned index;
 599   VEC(edge,gc) **container;
 600 } edge_iterator;
 601
 602 static inline VEC(edge,gc) *
 603 ei_container (edge_iterator i)
 604 {
 605   gcc_checking_assert (i.container);
 606   return *i.container;
 607 }
 608
 609 #define ei_start(iter) ei_start_1 (&(iter))
 610 #define ei_last(iter) ei_last_1 (&(iter))
 611
 612 /* Return an iterator pointing to the start of an edge vector.  */
 613 static inline edge_iterator
 614 ei_start_1 (VEC(edge,gc) **ev)
 615 {
 616   edge_iterator i;
 617
 618   i.index = 0;
 619   i.container = ev;
 620
 621   return i;
 622 }
 623
 624 /* Return an iterator pointing to the last element of an edge
 625    vector.  */
 626 static inline edge_iterator
 627 ei_last_1 (VEC(edge,gc) **ev)
 628 {
 629   edge_iterator i;
 630
 631   i.index = EDGE_COUNT (*ev) - 1;
 632   i.container = ev;
 633
 634   return i;
 635 }
 636
 637 /* Is the iterator `i' at the end of the sequence?  */
 638 static inline bool
 639 ei_end_p (edge_iterator i)
 640 {
 641   return (i.index == EDGE_COUNT (ei_container (i)));
 642 }
 643
 644 /* Is the iterator `i' at one position before the end of the
 645    sequence?  */
 646 static inline bool
 647 ei_one_before_end_p (edge_iterator i)
 648 {
 649   return (i.index + 1 == EDGE_COUNT (ei_container (i)));
 650 }
 651
 652 /* Advance the iterator to the next element.  */
 653 static inline void
 654 ei_next (edge_iterator *i)
 655 {
 656   gcc_checking_assert (i->index < EDGE_COUNT (ei_container (*i)));
 657   i->index++;
 658 }
 659
 660 /* Move the iterator to the previous element.  */
 661 static inline void
 662 ei_prev (edge_iterator *i)
 663 {
 664   gcc_checking_assert (i->index > 0);
 665   i->index--;
 666 }
 667
 668 /* Return the edge pointed to by the iterator `i'.  */
 669 static inline edge
 670 ei_edge (edge_iterator i)
 671 {
 672   return EDGE_I (ei_container (i), i.index);
 673 }
 674
 675 /* Return an edge pointed to by the iterator.  Do it safely so that
 676    NULL is returned when the iterator is pointing at the end of the
 677    sequence.  */
 678 static inline edge
 679 ei_safe_edge (edge_iterator i)
 680 {
 681   return !ei_end_p (i) ? ei_edge (i) : NULL;
 682 }
 683
 684 /* Return 1 if we should continue to iterate.  Return 0 otherwise.
 685    *Edge P is set to the next edge if we are to continue to iterate
 686    and NULL otherwise.  */
 687
 688 static inline bool
 689 ei_cond (edge_iterator ei, edge *p)
 690 {
 691   if (!ei_end_p (ei))
 692     {
 693       *p = ei_edge (ei);
 694       return 1;
 695     }
 696   else
 697     {
 698       *p = NULL;
 699       return 0;
 700     }
 701 }
 702
 703 /* This macro serves as a convenient way to iterate each edge in a
 704    vector of predecessor or successor edges.  It must not be used when
 705    an element might be removed during the traversal, otherwise
 706    elements will be missed.  Instead, use a for-loop like that shown
 707    in the following pseudo-code:
 708
 709    FOR (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
 710      {
 711         IF (e != taken_edge)
 712           remove_edge (e);
 713         ELSE
 714           ei_next (&ei);
 715      }
 716 */
 717
 718 #define FOR_EACH_EDGE(EDGE,ITER,EDGE_VEC)       \
 719   for ((ITER) = ei_start ((EDGE_VEC));          \
 720        ei_cond ((ITER), &(EDGE));               \
 721        ei_next (&(ITER)))
 722
 723 struct edge_list * create_edge_list (void);
 724 void free_edge_list (struct edge_list *);
 725 void print_edge_list (FILE *, struct edge_list *);
 726 void verify_edge_list (FILE *, struct edge_list *);
 727 int find_edge_index (struct edge_list *, basic_block, basic_block);
 728 edge find_edge (basic_block, basic_block);
 729
 730 #define CLEANUP_EXPENSIVE       1       /* Do relatively expensive optimizations
 731                                            except for edge forwarding */
 732 #define CLEANUP_CROSSJUMP       2       /* Do crossjumping.  */
 733 #define CLEANUP_POST_REGSTACK   4       /* We run after reg-stack and need
 734                                            to care REG_DEAD notes.  */
 735 #define CLEANUP_THREADING       8       /* Do jump threading.  */
 736 #define CLEANUP_NO_INSN_DEL     16      /* Do not try to delete trivially dead
 737                                            insns.  */
 738 #define CLEANUP_CFGLAYOUT       32      /* Do cleanup in cfglayout mode.  */
 739
 740 /* In lcm.c */
 741 extern struct edge_list *pre_edge_lcm (int, sbitmap *, sbitmap *,
 742                                        sbitmap *, sbitmap *, sbitmap **,
 743                                        sbitmap **);
 744 extern struct edge_list *pre_edge_rev_lcm (int, sbitmap *,
 745                                            sbitmap *, sbitmap *,
 746                                            sbitmap *, sbitmap **,
 747                                            sbitmap **);
 748 extern void compute_available (sbitmap *, sbitmap *, sbitmap *, sbitmap *);
 749
 750 /* In predict.c */
 751 extern bool maybe_hot_bb_p (const_basic_block);
 752 extern bool maybe_hot_edge_p (edge);
 753 extern bool probably_never_executed_bb_p (const_basic_block);
 754 extern bool optimize_bb_for_size_p (const_basic_block);
 755 extern bool optimize_bb_for_speed_p (const_basic_block);
 756 extern bool optimize_edge_for_size_p (edge);
 757 extern bool optimize_edge_for_speed_p (edge);
 758 extern bool optimize_loop_for_size_p (struct loop *);
 759 extern bool optimize_loop_for_speed_p (struct loop *);
 760 extern bool optimize_loop_nest_for_size_p (struct loop *);
 761 extern bool optimize_loop_nest_for_speed_p (struct loop *);
 762 extern bool gimple_predicted_by_p (const_basic_block, enum br_predictor);
 763 extern bool rtl_predicted_by_p (const_basic_block, enum br_predictor);
 764 extern void gimple_predict_edge (edge, enum br_predictor, int);
 765 extern void rtl_predict_edge (edge, enum br_predictor, int);
 766 extern void predict_edge_def (edge, enum br_predictor, enum prediction);
 767 extern void guess_outgoing_edge_probabilities (basic_block);
 768 extern void remove_predictions_associated_with_edge (edge);
 769 extern bool edge_probability_reliable_p (const_edge);
 770 extern bool br_prob_note_reliable_p (const_rtx);
 771 extern bool predictable_edge_p (edge);
 772
 773 /* In cfg.c  */
 774 extern void init_flow (struct function *);
 775 extern void debug_bb (basic_block);
 776 extern basic_block debug_bb_n (int);
 777 extern void expunge_block (basic_block);
 778 extern void link_block (basic_block, basic_block);
 779 extern void unlink_block (basic_block);
 780 extern void compact_blocks (void);
 781 extern basic_block alloc_block (void);
 782 extern void alloc_aux_for_blocks (int);
 783 extern void clear_aux_for_blocks (void);
 784 extern void free_aux_for_blocks (void);
 785 extern void alloc_aux_for_edges (int);
 786 extern void clear_aux_for_edges (void);
 787 extern void free_aux_for_edges (void);
 788
 789 /* In cfganal.c  */
 790 extern void find_unreachable_blocks (void);
 791 extern bool forwarder_block_p (const_basic_block);
 792 extern bool can_fallthru (basic_block, basic_block);
 793 extern bool could_fall_through (basic_block, basic_block);
 794 extern void flow_nodes_print (const char *, const_sbitmap, FILE *);
 795 extern void flow_edge_list_print (const char *, const edge *, int, FILE *);
 796
 797 /* In cfgrtl.c  */
 798 extern rtx block_label (basic_block);
 799 extern bool purge_all_dead_edges (void);
 800 extern bool purge_dead_edges (basic_block);
 801 extern bool fixup_abnormal_edges (void);
 802
 803 /* In cfgbuild.c.  */
 804 extern void find_many_sub_basic_blocks (sbitmap);
 805 extern void rtl_make_eh_edge (sbitmap, basic_block, rtx);
 806
 807 enum replace_direction { dir_none, dir_forward, dir_backward, dir_both };
 808
 809 /* In cfgcleanup.c.  */
 810 extern bool cleanup_cfg (int);
 811 extern int flow_find_cross_jump (basic_block, basic_block, rtx *, rtx *,
 812                                  enum replace_direction*);
 813 extern int flow_find_head_matching_sequence (basic_block, basic_block,
 814                                              rtx *, rtx *, int);
 815
 816 extern bool delete_unreachable_blocks (void);
 817
 818 extern bool mark_dfs_back_edges (void);
 819 extern void set_edge_can_fallthru_flag (void);
 820 extern void update_br_prob_note (basic_block);
 821 extern bool inside_basic_block_p (const_rtx);
 822 extern bool control_flow_insn_p (const_rtx);
 823 extern rtx get_last_bb_insn (basic_block);
 824
 825 /* In bb-reorder.c */
 826 extern void reorder_basic_blocks (void);
 827
 828 /* In dominance.c */
 829
 830 enum cdi_direction
 831 {
 832   CDI_DOMINATORS = 1,
 833   CDI_POST_DOMINATORS = 2
 834 };
 835
 836 extern enum dom_state dom_info_state (enum cdi_direction);
 837 extern void set_dom_info_availability (enum cdi_direction, enum dom_state);
 838 extern bool dom_info_available_p (enum cdi_direction);
 839 extern void calculate_dominance_info (enum cdi_direction);
 840 extern void free_dominance_info (enum cdi_direction);
 841 extern basic_block nearest_common_dominator (enum cdi_direction,
 842                                              basic_block, basic_block);
 843 extern basic_block nearest_common_dominator_for_set (enum cdi_direction,
 844                                                      bitmap);
 845 extern void set_immediate_dominator (enum cdi_direction, basic_block,
 846                                      basic_block);
 847 extern basic_block get_immediate_dominator (enum cdi_direction, basic_block);
 848 extern bool dominated_by_p (enum cdi_direction, const_basic_block, const_basic_block);
 849 extern VEC (basic_block, heap) *get_dominated_by (enum cdi_direction, basic_block);
 850 extern VEC (basic_block, heap) *get_dominated_by_region (enum cdi_direction,
 851                                                          basic_block *,
 852                                                          unsigned);
 853 extern VEC (basic_block, heap) *get_dominated_to_depth (enum cdi_direction,
 854                                                         basic_block, int);
 855 extern VEC (basic_block, heap) *get_all_dominated_blocks (enum cdi_direction,
 856                                                           basic_block);
 857 extern void add_to_dominance_info (enum cdi_direction, basic_block);
 858 extern void delete_from_dominance_info (enum cdi_direction, basic_block);
 859 basic_block recompute_dominator (enum cdi_direction, basic_block);
 860 extern void redirect_immediate_dominators (enum cdi_direction, basic_block,
 861                                            basic_block);
 862 extern void iterate_fix_dominators (enum cdi_direction,
 863                                     VEC (basic_block, heap) *, bool);
 864 extern void verify_dominators (enum cdi_direction);
 865 extern basic_block first_dom_son (enum cdi_direction, basic_block);
 866 extern basic_block next_dom_son (enum cdi_direction, basic_block);
 867 unsigned bb_dom_dfs_in (enum cdi_direction, basic_block);
 868 unsigned bb_dom_dfs_out (enum cdi_direction, basic_block);
 869
 870 extern edge try_redirect_by_replacing_jump (edge, basic_block, bool);
 871 extern void break_superblocks (void);
 872 extern void relink_block_chain (bool);
 873 extern void check_bb_profile (basic_block, FILE *);
 874 extern void update_bb_profile_for_threading (basic_block, int, gcov_type, edge);
 875 extern void init_rtl_bb_info (basic_block);
 876
 877 extern void initialize_original_copy_tables (void);
 878 extern void free_original_copy_tables (void);
 879 extern void set_bb_original (basic_block, basic_block);
 880 extern basic_block get_bb_original (basic_block);
 881 extern void set_bb_copy (basic_block, basic_block);
 882 extern basic_block get_bb_copy (basic_block);
 883 void set_loop_copy (struct loop *, struct loop *);
 884 struct loop *get_loop_copy (struct loop *);
 885
 886 #include "cfghooks.h"
 887
 888 /* Return true when one of the predecessor edges of BB is marked with EDGE_EH.  */
 889 static inline bool
 890 bb_has_eh_pred (basic_block bb)
 891 {
 892   edge e;
 893   edge_iterator ei;
 894
 895   FOR_EACH_EDGE (e, ei, bb->preds)
 896     {
 897       if (e->flags & EDGE_EH)
 898         return true;
 899     }
 900   return false;
 901 }
 902
 903 /* Return true when one of the predecessor edges of BB is marked with EDGE_ABNORMAL.  */
 904 static inline bool
 905 bb_has_abnormal_pred (basic_block bb)
 906 {
 907   edge e;
 908   edge_iterator ei;
 909
 910   FOR_EACH_EDGE (e, ei, bb->preds)
 911     {
 912       if (e->flags & EDGE_ABNORMAL)
 913         return true;
 914     }
 915   return false;
 916 }
 917
 918 /* Return the fallthru edge in EDGES if it exists, NULL otherwise.  */
 919 static inline edge
 920 find_fallthru_edge (VEC(edge,gc) *edges)
 921 {
 922   edge e;
 923   edge_iterator ei;
 924
 925   FOR_EACH_EDGE (e, ei, edges)
 926     if (e->flags & EDGE_FALLTHRU)
 927       break;
 928
 929   return e;
 930 }
 931
 932 /* In cfgloopmanip.c.  */
 933 extern edge mfb_kj_edge;
 934 extern bool mfb_keep_just (edge);
 935
 936 /* In cfgexpand.c.  */
 937 extern void rtl_profile_for_bb (basic_block);
 938 extern void rtl_profile_for_edge (edge);
 939 extern void default_rtl_profile (void);
 940
 941 #endif /* GCC_BASIC_BLOCK_H */