gcc/basic-block.h

   1 /* Define control and data flow tables, and regsets.
   2    Copyright (C) 1987, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING.  If not, write to the Free
  19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.  */
  21
  22 #ifndef GCC_BASIC_BLOCK_H
  23 #define GCC_BASIC_BLOCK_H
  24
  25 #include "bitmap.h"
  26 #include "sbitmap.h"
  27 #include "varray.h"
  28 #include "partition.h"
  29 #include "hard-reg-set.h"
  30 #include "predict.h"
  31
  32 /* Head of register set linked list.  */
  33 typedef bitmap_head regset_head;
  34
  35 /* A pointer to a regset_head.  */
  36 typedef bitmap regset;
  37
  38 /* Initialize a new regset.  */
  39 #define INIT_REG_SET(HEAD) bitmap_initialize (HEAD, 1)
  40
  41 /* Clear a register set by freeing up the linked list.  */
  42 #define CLEAR_REG_SET(HEAD) bitmap_clear (HEAD)
  43
  44 /* Copy a register set to another register set.  */
  45 #define COPY_REG_SET(TO, FROM) bitmap_copy (TO, FROM)
  46
  47 /* Compare two register sets.  */
  48 #define REG_SET_EQUAL_P(A, B) bitmap_equal_p (A, B)
  49
  50 /* `and' a register set with a second register set.  */
  51 #define AND_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_AND)
  52
  53 /* `and' the complement of a register set with a register set.  */
  54 #define AND_COMPL_REG_SET(TO, FROM) \
  55   bitmap_operation (TO, TO, FROM, BITMAP_AND_COMPL)
  56
  57 /* Inclusive or a register set with a second register set.  */
  58 #define IOR_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_IOR)
  59
  60 /* Exclusive or a register set with a second register set.  */
  61 #define XOR_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_XOR)
  62
  63 /* Or into TO the register set FROM1 `and'ed with the complement of FROM2.  */
  64 #define IOR_AND_COMPL_REG_SET(TO, FROM1, FROM2) \
  65   bitmap_ior_and_compl (TO, FROM1, FROM2)
  66
  67 /* Clear a single register in a register set.  */
  68 #define CLEAR_REGNO_REG_SET(HEAD, REG) bitmap_clear_bit (HEAD, REG)
  69
  70 /* Set a single register in a register set.  */
  71 #define SET_REGNO_REG_SET(HEAD, REG) bitmap_set_bit (HEAD, REG)
  72
  73 /* Return true if a register is set in a register set.  */
  74 #define REGNO_REG_SET_P(TO, REG) bitmap_bit_p (TO, REG)
  75
  76 /* Copy the hard registers in a register set to the hard register set.  */
  77 extern void reg_set_to_hard_reg_set (HARD_REG_SET *, bitmap);
  78 #define REG_SET_TO_HARD_REG_SET(TO, FROM)                               \
  79 do {                                                                    \
  80   CLEAR_HARD_REG_SET (TO);                                              \
  81   reg_set_to_hard_reg_set (&TO, FROM);                                  \
  82 } while (0)
  83
  84 /* Loop over all registers in REGSET, starting with MIN, setting REGNUM to the
  85    register number and executing CODE for all registers that are set.  */
  86 #define EXECUTE_IF_SET_IN_REG_SET(REGSET, MIN, REGNUM, CODE)            \
  87   EXECUTE_IF_SET_IN_BITMAP (REGSET, MIN, REGNUM, CODE)
  88
  89 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
  90    REGNUM to the register number and executing CODE for all registers that are
  91    set in the first regset and not set in the second.  */
  92 #define EXECUTE_IF_AND_COMPL_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, CODE) \
  93   EXECUTE_IF_AND_COMPL_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, CODE)
  94
  95 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
  96    REGNUM to the register number and executing CODE for all registers that are
  97    set in both regsets.  */
  98 #define EXECUTE_IF_AND_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, CODE) \
  99   EXECUTE_IF_AND_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, CODE)
 100
 101 /* Allocate a register set with oballoc.  */
 102 #define OBSTACK_ALLOC_REG_SET(OBSTACK) BITMAP_OBSTACK_ALLOC (OBSTACK)
 103
 104 /* Initialize a register set.  Returns the new register set.  */
 105 #define INITIALIZE_REG_SET(HEAD) bitmap_initialize (&HEAD, 1)
 106
 107 /* Do any cleanup needed on a regset when it is no longer used.  */
 108 #define FREE_REG_SET(REGSET) BITMAP_FREE(REGSET)
 109
 110 /* Do any one-time initializations needed for regsets.  */
 111 #define INIT_ONCE_REG_SET() BITMAP_INIT_ONCE ()
 112
 113 /* Grow any tables needed when the number of registers is calculated
 114    or extended.  For the linked list allocation, nothing needs to
 115    be done, other than zero the statistics on the first allocation.  */
 116 #define MAX_REGNO_REG_SET(NUM_REGS, NEW_P, RENUMBER_P)
 117
 118 /* Type we use to hold basic block counters.  Should be at least
 119    64bit.  Although a counter cannot be negative, we use a signed
 120    type, because erroneous negative counts can be generated when the
 121    flow graph is manipulated by various optimizations.  A signed type
 122    makes those easy to detect.  */
 123 typedef HOST_WIDEST_INT gcov_type;
 124
 125 /* Control flow edge information.  */
 126 struct edge_def GTY((chain_next ("%h.pred_next")))
 127 {
 128   /* Links through the predecessor and successor lists.  */
 129   struct edge_def *pred_next;
 130   struct edge_def *succ_next;
 131
 132   /* The two blocks at the ends of the edge.  */
 133   struct basic_block_def *src;
 134   struct basic_block_def *dest;
 135
 136   /* Instructions queued on the edge.  */
 137   union edge_def_insns {
 138     rtx GTY ((tag ("0"))) r;
 139     tree GTY ((tag ("1"))) t;
 140   } GTY ((desc ("ir_type ()"))) insns;
 141
 142   /* Auxiliary info specific to a pass.  */
 143   PTR GTY ((skip (""))) aux;
 144
 145   int flags;                    /* see EDGE_* below  */
 146   int probability;              /* biased by REG_BR_PROB_BASE */
 147   gcov_type count;              /* Expected number of executions calculated
 148                                    in profile.c  */
 149   bool crossing_edge;           /* Crosses between hot and cold sections, when
 150                                    we do partitioning.  */
 151 };
 152
 153 typedef struct edge_def *edge;
 154
 155 #define EDGE_FALLTHRU           1       /* 'Straight line' flow */
 156 #define EDGE_ABNORMAL           2       /* Strange flow, like computed
 157                                            label, or eh */
 158 #define EDGE_ABNORMAL_CALL      4       /* Call with abnormal exit
 159                                            like an exception, or sibcall */
 160 #define EDGE_EH                 8       /* Exception throw */
 161 #define EDGE_FAKE               16      /* Not a real edge (profile.c) */
 162 #define EDGE_DFS_BACK           32      /* A backwards edge */
 163 #define EDGE_CAN_FALLTHRU       64      /* Candidate for straight line
 164                                            flow.  */
 165 #define EDGE_IRREDUCIBLE_LOOP   128     /* Part of irreducible loop.  */
 166 #define EDGE_SIBCALL            256     /* Edge from sibcall to exit.  */
 167 #define EDGE_LOOP_EXIT          512     /* Exit of a loop.  */
 168 #define EDGE_TRUE_VALUE         1024    /* Edge taken when controlling
 169                                            predicate is non zero.  */
 170 #define EDGE_FALSE_VALUE        2048    /* Edge taken when controlling
 171                                            predicate is zero.  */
 172 #define EDGE_EXECUTABLE         4096    /* Edge is executable.  Only
 173                                            valid during SSA-CCP.  */
 174 #define EDGE_ALL_FLAGS          8191
 175
 176 #define EDGE_COMPLEX    (EDGE_ABNORMAL | EDGE_ABNORMAL_CALL | EDGE_EH)
 177
 178 /* Counter summary from the last set of coverage counts read by
 179    profile.c.  */
 180 extern const struct gcov_ctr_summary *profile_info;
 181
 182 /* Declared in cfgloop.h.  */
 183 struct loop;
 184 struct loops;
 185
 186 /* Declared in tree-flow.h.  */
 187 struct bb_ann_d;
 188
 189 /* A basic block is a sequence of instructions with only entry and
 190    only one exit.  If any one of the instructions are executed, they
 191    will all be executed, and in sequence from first to last.
 192
 193    There may be COND_EXEC instructions in the basic block.  The
 194    COND_EXEC *instructions* will be executed -- but if the condition
 195    is false the conditionally executed *expressions* will of course
 196    not be executed.  We don't consider the conditionally executed
 197    expression (which might have side-effects) to be in a separate
 198    basic block because the program counter will always be at the same
 199    location after the COND_EXEC instruction, regardless of whether the
 200    condition is true or not.
 201
 202    Basic blocks need not start with a label nor end with a jump insn.
 203    For example, a previous basic block may just "conditionally fall"
 204    into the succeeding basic block, and the last basic block need not
 205    end with a jump insn.  Block 0 is a descendant of the entry block.
 206
 207    A basic block beginning with two labels cannot have notes between
 208    the labels.
 209
 210    Data for jump tables are stored in jump_insns that occur in no
 211    basic block even though these insns can follow or precede insns in
 212    basic blocks.  */
 213
 214 /* Basic block information indexed by block number.  */
 215 struct basic_block_def GTY((chain_next ("%h.next_bb"), chain_prev ("%h.prev_bb")))
 216 {
 217   /* The first and last insns of the block.  */
 218   rtx head_;
 219   rtx end_;
 220
 221   /* Pointers to the first and last trees of the block.  */
 222   tree stmt_list;
 223
 224   /* The edges into and out of the block.  */
 225   edge pred;
 226   edge succ;
 227
 228   /* Liveness info.  */
 229
 230   /* The registers that are modified within this in block.  */
 231   bitmap GTY ((skip (""))) local_set;
 232   /* The registers that are conditionally modified within this block.
 233      In other words, registers that are set only as part of a
 234      COND_EXEC.  */
 235   bitmap GTY ((skip (""))) cond_local_set;
 236   /* The registers that are live on entry to this block.
 237
 238      Note that in SSA form, global_live_at_start does not reflect the
 239      use of regs in phi functions, since the liveness of these regs
 240      may depend on which edge was taken into the block.  */
 241   bitmap GTY ((skip (""))) global_live_at_start;
 242   /* The registers that are live on exit from this block.  */
 243   bitmap GTY ((skip (""))) global_live_at_end;
 244
 245   /* Auxiliary info specific to a pass.  */
 246   PTR GTY ((skip (""))) aux;
 247
 248   /* The index of this block.  */
 249   int index;
 250
 251   /* Previous and next blocks in the chain.  */
 252   struct basic_block_def *prev_bb;
 253   struct basic_block_def *next_bb;
 254
 255   /* The loop depth of this block.  */
 256   int loop_depth;
 257
 258   /* Innermost loop containing the block.  */
 259   struct loop * GTY ((skip (""))) loop_father;
 260
 261   /* The dominance and postdominance information node.  */
 262   struct et_node * GTY ((skip (""))) dom[2];
 263
 264   /* Expected number of executions: calculated in profile.c.  */
 265   gcov_type count;
 266
 267   /* Expected frequency.  Normalized to be in range 0 to BB_FREQ_MAX.  */
 268   int frequency;
 269
 270   /* Various flags.  See BB_* below.  */
 271   int flags;
 272
 273   /* Which section block belongs in, when partitioning basic blocks.  */
 274   int partition;
 275
 276   /* The data used by basic block copying and reordering functions.  */
 277   struct reorder_block_def * GTY ((skip (""))) rbi;
 278
 279   /* Annotations used at the tree level.  */
 280   struct bb_ann_d *tree_annotations;
 281 };
 282
 283 typedef struct basic_block_def *basic_block;
 284
 285 /* Structure to hold information about the blocks during reordering and
 286    copying.  */
 287
 288 typedef struct reorder_block_def
 289 {
 290   rtx header;
 291   rtx footer;
 292   basic_block next;
 293   basic_block original;
 294   /* Used by loop copying.  */
 295   basic_block copy;
 296   int duplicated;
 297
 298   /* These fields are used by bb-reorder pass.  */
 299   int visited;
 300 } *reorder_block_def;
 301
 302 #define BB_FREQ_MAX 10000
 303
 304 /* Masks for basic_block.flags.  */
 305 #define BB_DIRTY                1
 306 #define BB_NEW                  2
 307 #define BB_REACHABLE            4
 308 #define BB_VISITED              8
 309 #define BB_IRREDUCIBLE_LOOP     16
 310 #define BB_SUPERBLOCK           32
 311
 312 /* Partitions, to be used when partitioning hot and cold basic blocks into
 313    separate sections.  */
 314 #define UNPARTITIONED   0
 315 #define HOT_PARTITION   1
 316 #define COLD_PARTITION  2
 317
 318 /* Number of basic blocks in the current function.  */
 319
 320 extern int n_basic_blocks;
 321
 322 /* First free basic block number.  */
 323
 324 extern int last_basic_block;
 325
 326 /* Number of edges in the current function.  */
 327
 328 extern int n_edges;
 329
 330 /* Index by basic block number, get basic block struct info.  */
 331
 332 extern GTY(()) varray_type basic_block_info;
 333
 334 #define BASIC_BLOCK(N)  (VARRAY_BB (basic_block_info, (N)))
 335
 336 /* For iterating over basic blocks.  */
 337 #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \
 338   for (BB = FROM; BB != TO; BB = BB->DIR)
 339
 340 #define FOR_EACH_BB(BB) \
 341   FOR_BB_BETWEEN (BB, ENTRY_BLOCK_PTR->next_bb, EXIT_BLOCK_PTR, next_bb)
 342
 343 #define FOR_EACH_BB_REVERSE(BB) \
 344   FOR_BB_BETWEEN (BB, EXIT_BLOCK_PTR->prev_bb, ENTRY_BLOCK_PTR, prev_bb)
 345
 346 /* For iterating over insns in basic block.  */
 347 #define FOR_BB_INSNS(BB, INSN)                  \
 348   for ((INSN) = BB_HEAD (BB);                   \
 349        (INSN) != NEXT_INSN (BB_END (BB));       \
 350        (INSN) = NEXT_INSN (INSN))
 351
 352 #define FOR_BB_INSNS_REVERSE(BB, INSN)          \
 353   for ((INSN) = BB_END (BB);                    \
 354        (INSN) != PREV_INSN (BB_HEAD (BB));      \
 355        (INSN) = PREV_INSN (INSN))
 356
 357 /* Cycles through _all_ basic blocks, even the fake ones (entry and
 358    exit block).  */
 359
 360 #define FOR_ALL_BB(BB) \
 361   for (BB = ENTRY_BLOCK_PTR; BB; BB = BB->next_bb)
 362
 363 /* What registers are live at the setjmp call.  */
 364
 365 extern regset regs_live_at_setjmp;
 366
 367 /* Special labels found during CFG build.  */
 368
 369 extern GTY(()) rtx label_value_list;
 370
 371 extern struct obstack flow_obstack;
 372
 373 /* Indexed by n, gives number of basic block that  (REG n) is used in.
 374    If the value is REG_BLOCK_GLOBAL (-2),
 375    it means (REG n) is used in more than one basic block.
 376    REG_BLOCK_UNKNOWN (-1) means it hasn't been seen yet so we don't know.
 377    This information remains valid for the rest of the compilation
 378    of the current function; it is used to control register allocation.  */
 379
 380 #define REG_BLOCK_UNKNOWN -1
 381 #define REG_BLOCK_GLOBAL -2
 382
 383 #define REG_BASIC_BLOCK(N) (VARRAY_REG (reg_n_info, N)->basic_block)
 384 \f
 385 /* Stuff for recording basic block info.  */
 386
 387 #define BB_HEAD(B)      (B)->head_
 388 #define BB_END(B)       (B)->end_
 389
 390 /* Special block numbers [markers] for entry and exit.  */
 391 #define ENTRY_BLOCK (-1)
 392 #define EXIT_BLOCK (-2)
 393
 394 /* Special block number not valid for any block.  */
 395 #define INVALID_BLOCK (-3)
 396
 397 /* Similarly, block pointers for the edge list.  */
 398 extern GTY(()) basic_block ENTRY_BLOCK_PTR;
 399 extern GTY(()) basic_block EXIT_BLOCK_PTR;
 400
 401 #define BLOCK_NUM(INSN)       (BLOCK_FOR_INSN (INSN)->index + 0)
 402 #define set_block_for_insn(INSN, BB)  (BLOCK_FOR_INSN (INSN) = BB)
 403
 404 extern void compute_bb_for_insn (void);
 405 extern void free_bb_for_insn (void);
 406 extern void update_bb_for_insn (basic_block);
 407
 408 extern void free_basic_block_vars (void);
 409
 410 extern void insert_insn_on_edge (rtx, edge);
 411 bool safe_insert_insn_on_edge (rtx, edge);
 412
 413 extern void commit_edge_insertions (void);
 414 extern void commit_edge_insertions_watch_calls (void);
 415
 416 extern void remove_fake_edges (void);
 417 extern void add_noreturn_fake_exit_edges (void);
 418 extern void connect_infinite_loops_to_exit (void);
 419 extern edge unchecked_make_edge (basic_block, basic_block, int);
 420 extern edge cached_make_edge (sbitmap *, basic_block, basic_block, int);
 421 extern edge make_edge (basic_block, basic_block, int);
 422 extern edge make_single_succ_edge (basic_block, basic_block, int);
 423 extern void remove_edge (edge);
 424 extern void redirect_edge_succ (edge, basic_block);
 425 extern edge redirect_edge_succ_nodup (edge, basic_block);
 426 extern void redirect_edge_pred (edge, basic_block);
 427 extern basic_block create_basic_block_structure (rtx, rtx, rtx, basic_block);
 428 extern void clear_bb_flags (void);
 429 extern void flow_reverse_top_sort_order_compute (int *);
 430 extern int flow_depth_first_order_compute (int *, int *);
 431 extern void flow_preorder_transversal_compute (int *);
 432 extern int dfs_enumerate_from (basic_block, int,
 433                                bool (*)(basic_block, void *),
 434                                basic_block *, int, void *);
 435 extern void dump_edge_info (FILE *, edge, int);
 436 extern void brief_dump_cfg (FILE *);
 437 extern void clear_edges (void);
 438 extern void mark_critical_edges (void);
 439 extern rtx first_insn_after_basic_block_note (basic_block);
 440
 441 /* Structure to group all of the information to process IF-THEN and
 442    IF-THEN-ELSE blocks for the conditional execution support.  This
 443    needs to be in a public file in case the IFCVT macros call
 444    functions passing the ce_if_block data structure.  */
 445
 446 typedef struct ce_if_block
 447 {
 448   basic_block test_bb;                  /* First test block.  */
 449   basic_block then_bb;                  /* THEN block.  */
 450   basic_block else_bb;                  /* ELSE block or NULL.  */
 451   basic_block join_bb;                  /* Join THEN/ELSE blocks.  */
 452   basic_block last_test_bb;             /* Last bb to hold && or || tests.  */
 453   int num_multiple_test_blocks;         /* # of && and || basic blocks.  */
 454   int num_and_and_blocks;               /* # of && blocks.  */
 455   int num_or_or_blocks;                 /* # of || blocks.  */
 456   int num_multiple_test_insns;          /* # of insns in && and || blocks.  */
 457   int and_and_p;                        /* Complex test is &&.  */
 458   int num_then_insns;                   /* # of insns in THEN block.  */
 459   int num_else_insns;                   /* # of insns in ELSE block.  */
 460   int pass;                             /* Pass number.  */
 461
 462 #ifdef IFCVT_EXTRA_FIELDS
 463   IFCVT_EXTRA_FIELDS                    /* Any machine dependent fields.  */
 464 #endif
 465
 466 } ce_if_block_t;
 467
 468 /* This structure maintains an edge list vector.  */
 469 struct edge_list
 470 {
 471   int num_blocks;
 472   int num_edges;
 473   edge *index_to_edge;
 474 };
 475
 476 /* This is the value which indicates no edge is present.  */
 477 #define EDGE_INDEX_NO_EDGE      -1
 478
 479 /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE
 480    if there is no edge between the 2 basic blocks.  */
 481 #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ)))
 482
 483 /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic
 484    block which is either the pred or succ end of the indexed edge.  */
 485 #define INDEX_EDGE_PRED_BB(el, index)   ((el)->index_to_edge[(index)]->src)
 486 #define INDEX_EDGE_SUCC_BB(el, index)   ((el)->index_to_edge[(index)]->dest)
 487
 488 /* INDEX_EDGE returns a pointer to the edge.  */
 489 #define INDEX_EDGE(el, index)           ((el)->index_to_edge[(index)])
 490
 491 /* Number of edges in the compressed edge list.  */
 492 #define NUM_EDGES(el)                   ((el)->num_edges)
 493
 494 /* BB is assumed to contain conditional jump.  Return the fallthru edge.  */
 495 #define FALLTHRU_EDGE(bb)               ((bb)->succ->flags & EDGE_FALLTHRU \
 496                                          ? (bb)->succ : (bb)->succ->succ_next)
 497
 498 /* BB is assumed to contain conditional jump.  Return the branch edge.  */
 499 #define BRANCH_EDGE(bb)                 ((bb)->succ->flags & EDGE_FALLTHRU \
 500                                          ? (bb)->succ->succ_next : (bb)->succ)
 501
 502 /* Return expected execution frequency of the edge E.  */
 503 #define EDGE_FREQUENCY(e)               (((e)->src->frequency \
 504                                           * (e)->probability \
 505                                           + REG_BR_PROB_BASE / 2) \
 506                                          / REG_BR_PROB_BASE)
 507
 508 /* Return nonzero if edge is critical.  */
 509 #define EDGE_CRITICAL_P(e)              ((e)->src->succ->succ_next \
 510                                          && (e)->dest->pred->pred_next)
 511
 512 struct edge_list * create_edge_list (void);
 513 void free_edge_list (struct edge_list *);
 514 void print_edge_list (FILE *, struct edge_list *);
 515 void verify_edge_list (FILE *, struct edge_list *);
 516 int find_edge_index (struct edge_list *, basic_block, basic_block);
 517 edge find_edge (basic_block, basic_block);
 518
 519
 520 enum update_life_extent
 521 {
 522   UPDATE_LIFE_LOCAL = 0,
 523   UPDATE_LIFE_GLOBAL = 1,
 524   UPDATE_LIFE_GLOBAL_RM_NOTES = 2
 525 };
 526
 527 /* Flags for life_analysis and update_life_info.  */
 528
 529 #define PROP_DEATH_NOTES        1       /* Create DEAD and UNUSED notes.  */
 530 #define PROP_LOG_LINKS          2       /* Create LOG_LINKS.  */
 531 #define PROP_REG_INFO           4       /* Update regs_ever_live et al.  */
 532 #define PROP_KILL_DEAD_CODE     8       /* Remove dead code.  */
 533 #define PROP_SCAN_DEAD_CODE     16      /* Scan for dead code.  */
 534 #define PROP_ALLOW_CFG_CHANGES  32      /* Allow the CFG to be changed
 535                                            by dead code removal.  */
 536 #define PROP_AUTOINC            64      /* Create autoinc mem references.  */
 537 #define PROP_EQUAL_NOTES        128     /* Take into account REG_EQUAL notes.  */
 538 #define PROP_SCAN_DEAD_STORES   256     /* Scan for dead code.  */
 539 #define PROP_ASM_SCAN           512     /* Internal flag used within flow.c
 540                                            to flag analysis of asms.  */
 541 #define PROP_FINAL              (PROP_DEATH_NOTES | PROP_LOG_LINKS  \
 542                                  | PROP_REG_INFO | PROP_KILL_DEAD_CODE  \
 543                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
 544                                  | PROP_ALLOW_CFG_CHANGES \
 545                                  | PROP_SCAN_DEAD_STORES)
 546 #define PROP_POSTRELOAD         (PROP_DEATH_NOTES  \
 547                                  | PROP_KILL_DEAD_CODE  \
 548                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
 549                                  | PROP_SCAN_DEAD_STORES)
 550
 551 #define CLEANUP_EXPENSIVE       1       /* Do relatively expensive optimizations
 552                                            except for edge forwarding */
 553 #define CLEANUP_CROSSJUMP       2       /* Do crossjumping.  */
 554 #define CLEANUP_POST_REGSTACK   4       /* We run after reg-stack and need
 555                                            to care REG_DEAD notes.  */
 556 #define CLEANUP_PRE_LOOP        8       /* Take care to preserve syntactic loop
 557                                            notes.  */
 558 #define CLEANUP_UPDATE_LIFE     16      /* Keep life information up to date.  */
 559 #define CLEANUP_THREADING       32      /* Do jump threading.  */
 560 #define CLEANUP_NO_INSN_DEL     64      /* Do not try to delete trivially dead
 561                                            insns.  */
 562 #define CLEANUP_CFGLAYOUT       128     /* Do cleanup in cfglayout mode.  */
 563 #define CLEANUP_LOG_LINKS       256     /* Update log links.  */
 564
 565 extern void life_analysis (FILE *, int);
 566 extern int update_life_info (sbitmap, enum update_life_extent, int);
 567 extern int update_life_info_in_dirty_blocks (enum update_life_extent, int);
 568 extern int count_or_remove_death_notes (sbitmap, int);
 569 extern int propagate_block (basic_block, regset, regset, regset, int);
 570
 571 struct propagate_block_info;
 572 extern rtx propagate_one_insn (struct propagate_block_info *, rtx);
 573 extern struct propagate_block_info *init_propagate_block_info
 574  (basic_block, regset, regset, regset, int);
 575 extern void free_propagate_block_info (struct propagate_block_info *);
 576
 577 /* In lcm.c */
 578 extern struct edge_list *pre_edge_lcm (FILE *, int, sbitmap *, sbitmap *,
 579                                        sbitmap *, sbitmap *, sbitmap **,
 580                                        sbitmap **);
 581 extern struct edge_list *pre_edge_rev_lcm (FILE *, int, sbitmap *,
 582                                            sbitmap *, sbitmap *,
 583                                            sbitmap *, sbitmap **,
 584                                            sbitmap **);
 585 extern void compute_available (sbitmap *, sbitmap *, sbitmap *, sbitmap *);
 586 extern int optimize_mode_switching (FILE *);
 587
 588 /* In emit-rtl.c.  */
 589 extern rtx emit_block_insn_after (rtx, rtx, basic_block);
 590 extern rtx emit_block_insn_before (rtx, rtx, basic_block);
 591
 592 /* In predict.c */
 593 extern void estimate_probability (struct loops *);
 594 extern void note_prediction_to_br_prob (void);
 595 extern void expected_value_to_br_prob (void);
 596 extern bool maybe_hot_bb_p (basic_block);
 597 extern bool probably_cold_bb_p (basic_block);
 598 extern bool probably_never_executed_bb_p (basic_block);
 599 extern bool tree_predicted_by_p (basic_block, enum br_predictor);
 600 extern bool rtl_predicted_by_p (basic_block, enum br_predictor);
 601 extern void tree_predict_edge (edge, enum br_predictor, int);
 602 extern void rtl_predict_edge (edge, enum br_predictor, int);
 603 extern void predict_edge_def (edge, enum br_predictor, enum prediction);
 604
 605 /* In flow.c */
 606 extern void init_flow (void);
 607 extern void debug_bb (basic_block);
 608 extern basic_block debug_bb_n (int);
 609 extern void dump_regset (regset, FILE *);
 610 extern void debug_regset (regset);
 611 extern void allocate_reg_life_data (void);
 612 extern void allocate_bb_life_data (void);
 613 extern void expunge_block (basic_block);
 614 extern void link_block (basic_block, basic_block);
 615 extern void unlink_block (basic_block);
 616 extern void compact_blocks (void);
 617 extern basic_block alloc_block (void);
 618 extern void find_unreachable_blocks (void);
 619 extern int delete_noop_moves (void);
 620 extern basic_block force_nonfallthru (edge);
 621 extern rtx block_label (basic_block);
 622 extern bool forwarder_block_p (basic_block);
 623 extern bool purge_all_dead_edges (int);
 624 extern bool purge_dead_edges (basic_block);
 625 extern void find_sub_basic_blocks (basic_block);
 626 extern void find_many_sub_basic_blocks (sbitmap);
 627 extern void rtl_make_eh_edge (sbitmap *, basic_block, rtx);
 628 extern bool can_fallthru (basic_block, basic_block);
 629 extern void flow_nodes_print (const char *, const sbitmap, FILE *);
 630 extern void flow_edge_list_print (const char *, const edge *, int, FILE *);
 631 extern void alloc_aux_for_block (basic_block, int);
 632 extern void alloc_aux_for_blocks (int);
 633 extern void clear_aux_for_blocks (void);
 634 extern void free_aux_for_blocks (void);
 635 extern void alloc_aux_for_edge (edge, int);
 636 extern void alloc_aux_for_edges (int);
 637 extern void clear_aux_for_edges (void);
 638 extern void free_aux_for_edges (void);
 639 extern void find_basic_blocks (rtx, int, FILE *);
 640 extern bool cleanup_cfg (int);
 641 extern bool delete_unreachable_blocks (void);
 642 extern bool merge_seq_blocks (void);
 643
 644 typedef struct conflict_graph_def *conflict_graph;
 645
 646 /* Callback function when enumerating conflicts.  The arguments are
 647    the smaller and larger regno in the conflict.  Returns zero if
 648    enumeration is to continue, nonzero to halt enumeration.  */
 649 typedef int (*conflict_graph_enum_fn) (int, int, void *);
 650
 651
 652 /* Prototypes of operations on conflict graphs.  */
 653
 654 extern conflict_graph conflict_graph_new
 655  (int);
 656 extern void conflict_graph_delete (conflict_graph);
 657 extern int conflict_graph_add (conflict_graph, int, int);
 658 extern int conflict_graph_conflict_p (conflict_graph, int, int);
 659 extern void conflict_graph_enum (conflict_graph, int, conflict_graph_enum_fn,
 660                                  void *);
 661 extern void conflict_graph_merge_regs (conflict_graph, int, int);
 662 extern void conflict_graph_print (conflict_graph, FILE*);
 663 extern conflict_graph conflict_graph_compute (regset, partition);
 664 extern bool mark_dfs_back_edges (void);
 665 extern void set_edge_can_fallthru_flag (void);
 666 extern void update_br_prob_note (basic_block);
 667 extern void fixup_abnormal_edges (void);
 668 extern bool can_hoist_insn_p (rtx, rtx, regset);
 669 extern rtx hoist_insn_after (rtx, rtx, rtx, rtx);
 670 extern rtx hoist_insn_to_edge (rtx, edge, rtx, rtx);
 671 extern bool inside_basic_block_p (rtx);
 672 extern bool control_flow_insn_p (rtx);
 673
 674 /* In bb-reorder.c */
 675 extern void reorder_basic_blocks (void);
 676 extern void partition_hot_cold_basic_blocks (void);
 677
 678 /* In cfg.c */
 679 extern void alloc_rbi_pool (void);
 680 extern void initialize_bb_rbi (basic_block bb);
 681 extern void free_rbi_pool (void);
 682
 683 /* In dominance.c */
 684
 685 enum cdi_direction
 686 {
 687   CDI_DOMINATORS,
 688   CDI_POST_DOMINATORS
 689 };
 690
 691 enum dom_state
 692 {
 693   DOM_NONE,             /* Not computed at all.  */
 694   DOM_CONS_OK,          /* The data is conservatively OK, i.e. if it says you that A dominates B,
 695                            it indeed does.  */
 696   DOM_NO_FAST_QUERY,    /* The data is OK, but the fast query data are not usable.  */
 697   DOM_OK                /* Everything is ok.  */
 698 };
 699
 700 extern enum dom_state dom_computed[2];
 701
 702 extern void calculate_dominance_info (enum cdi_direction);
 703 extern void free_dominance_info (enum cdi_direction);
 704 extern basic_block nearest_common_dominator (enum cdi_direction,
 705                                              basic_block, basic_block);
 706 extern void set_immediate_dominator (enum cdi_direction, basic_block,
 707                                      basic_block);
 708 extern basic_block get_immediate_dominator (enum cdi_direction, basic_block);
 709 extern bool dominated_by_p (enum cdi_direction, basic_block, basic_block);
 710 extern int get_dominated_by (enum cdi_direction, basic_block, basic_block **);
 711 extern void add_to_dominance_info (enum cdi_direction, basic_block);
 712 extern void delete_from_dominance_info (enum cdi_direction, basic_block);
 713 basic_block recount_dominator (enum cdi_direction, basic_block);
 714 extern void redirect_immediate_dominators (enum cdi_direction, basic_block,
 715                                            basic_block);
 716 extern void iterate_fix_dominators (enum cdi_direction, basic_block *, int);
 717 extern void verify_dominators (enum cdi_direction);
 718 extern basic_block first_dom_son (enum cdi_direction, basic_block);
 719 extern basic_block next_dom_son (enum cdi_direction, basic_block);
 720 extern edge try_redirect_by_replacing_jump (edge, basic_block, bool);
 721 extern void break_superblocks (void);
 722
 723 #include "cfghooks.h"
 724
 725 #endif /* GCC_BASIC_BLOCK_H */