gcc/basic-block.h

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