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