gcc/basic-block.h

   1 /* Define control and data flow tables, and regsets.
   2    Copyright (C) 1987, 1997, 1998, 1999, 2000, 2001, 2002
   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
  30 /* Head of register set linked list.  */
  31 typedef bitmap_head regset_head;
  32 /* A pointer to a regset_head.  */
  33 typedef bitmap regset;
  34
  35 /* Initialize a new regset.  */
  36 #define INIT_REG_SET(HEAD) bitmap_initialize (HEAD, 1)
  37
  38 /* Clear a register set by freeing up the linked list.  */
  39 #define CLEAR_REG_SET(HEAD) bitmap_clear (HEAD)
  40
  41 /* Copy a register set to another register set.  */
  42 #define COPY_REG_SET(TO, FROM) bitmap_copy (TO, FROM)
  43
  44 /* Compare two register sets.  */
  45 #define REG_SET_EQUAL_P(A, B) bitmap_equal_p (A, B)
  46
  47 /* `and' a register set with a second register set.  */
  48 #define AND_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_AND)
  49
  50 /* `and' the complement of a register set with a register set.  */
  51 #define AND_COMPL_REG_SET(TO, FROM) \
  52   bitmap_operation (TO, TO, FROM, BITMAP_AND_COMPL)
  53
  54 /* Inclusive or a register set with a second register set.  */
  55 #define IOR_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_IOR)
  56
  57 /* Exclusive or a register set with a second register set.  */
  58 #define XOR_REG_SET(TO, FROM) bitmap_operation (TO, TO, FROM, BITMAP_XOR)
  59
  60 /* Or into TO the register set FROM1 `and'ed with the complement of FROM2.  */
  61 #define IOR_AND_COMPL_REG_SET(TO, FROM1, FROM2) \
  62   bitmap_ior_and_compl (TO, FROM1, FROM2)
  63
  64 /* Clear a single register in a register set.  */
  65 #define CLEAR_REGNO_REG_SET(HEAD, REG) bitmap_clear_bit (HEAD, REG)
  66
  67 /* Set a single register in a register set.  */
  68 #define SET_REGNO_REG_SET(HEAD, REG) bitmap_set_bit (HEAD, REG)
  69
  70 /* Return true if a register is set in a register set.  */
  71 #define REGNO_REG_SET_P(TO, REG) bitmap_bit_p (TO, REG)
  72
  73 /* Copy the hard registers in a register set to the hard register set.  */
  74 extern void reg_set_to_hard_reg_set PARAMS ((HARD_REG_SET *, bitmap));
  75 #define REG_SET_TO_HARD_REG_SET(TO, FROM)                               \
  76 do {                                                                    \
  77   CLEAR_HARD_REG_SET (TO);                                              \
  78   reg_set_to_hard_reg_set (&TO, FROM);                                  \
  79 } while (0)
  80
  81 /* Loop over all registers in REGSET, starting with MIN, setting REGNUM to the
  82    register number and executing CODE for all registers that are set.  */
  83 #define EXECUTE_IF_SET_IN_REG_SET(REGSET, MIN, REGNUM, CODE)            \
  84   EXECUTE_IF_SET_IN_BITMAP (REGSET, MIN, REGNUM, CODE)
  85
  86 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
  87    REGNUM to the register number and executing CODE for all registers that are
  88    set in the first regset and not set in the second.  */
  89 #define EXECUTE_IF_AND_COMPL_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, CODE) \
  90   EXECUTE_IF_AND_COMPL_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, CODE)
  91
  92 /* Loop over all registers in REGSET1 and REGSET2, starting with MIN, setting
  93    REGNUM to the register number and executing CODE for all registers that are
  94    set in both regsets.  */
  95 #define EXECUTE_IF_AND_IN_REG_SET(REGSET1, REGSET2, MIN, REGNUM, CODE) \
  96   EXECUTE_IF_AND_IN_BITMAP (REGSET1, REGSET2, MIN, REGNUM, CODE)
  97
  98 /* Allocate a register set with oballoc.  */
  99 #define OBSTACK_ALLOC_REG_SET(OBSTACK) BITMAP_OBSTACK_ALLOC (OBSTACK)
 100
 101 /* Initialize a register set.  Returns the new register set.  */
 102 #define INITIALIZE_REG_SET(HEAD) bitmap_initialize (&HEAD, 1)
 103
 104 /* Do any cleanup needed on a regset when it is no longer used.  */
 105 #define FREE_REG_SET(REGSET) BITMAP_FREE(REGSET)
 106
 107 /* Do any one-time initializations needed for regsets.  */
 108 #define INIT_ONCE_REG_SET() BITMAP_INIT_ONCE ()
 109
 110 /* Grow any tables needed when the number of registers is calculated
 111    or extended.  For the linked list allocation, nothing needs to
 112    be done, other than zero the statistics on the first allocation.  */
 113 #define MAX_REGNO_REG_SET(NUM_REGS, NEW_P, RENUMBER_P)
 114
 115 /* Type we use to hold basic block counters.  Should be at least 64bit.  */
 116 typedef HOST_WIDEST_INT gcov_type;
 117
 118 /* Control flow edge information.  */
 119 typedef struct edge_def {
 120   /* Links through the predecessor and successor lists.  */
 121   struct edge_def *pred_next, *succ_next;
 122
 123   /* The two blocks at the ends of the edge.  */
 124   struct basic_block_def *src, *dest;
 125
 126   /* Instructions queued on the edge.  */
 127   rtx insns;
 128
 129   /* Auxiliary info specific to a pass.  */
 130   void *aux;
 131
 132   int flags;                    /* see EDGE_* below  */
 133   int probability;              /* biased by REG_BR_PROB_BASE */
 134   gcov_type count;              /* Expected number of executions calculated
 135                                    in profile.c  */
 136 } *edge;
 137
 138 #define EDGE_FALLTHRU           1       /* 'Straight line' flow */
 139 #define EDGE_ABNORMAL           2       /* Strange flow, like computed
 140                                            label, or eh */
 141 #define EDGE_ABNORMAL_CALL      4       /* Call with abnormal exit
 142                                            like an exception, or sibcall */
 143 #define EDGE_EH                 8       /* Exception throw */
 144 #define EDGE_FAKE               16      /* Not a real edge (profile.c) */
 145 #define EDGE_DFS_BACK           32      /* A backwards edge */
 146 #define EDGE_CAN_FALLTHRU       64      /* Candidate for straight line
 147                                            flow. */
 148
 149 #define EDGE_COMPLEX    (EDGE_ABNORMAL | EDGE_ABNORMAL_CALL | EDGE_EH)
 150
 151
 152 /* A basic block is a sequence of instructions with only entry and
 153    only one exit.  If any one of the instructions are executed, they
 154    will all be executed, and in sequence from first to last.
 155
 156    There may be COND_EXEC instructions in the basic block.  The
 157    COND_EXEC *instructions* will be executed -- but if the condition
 158    is false the conditionally executed *expressions* will of course
 159    not be executed.  We don't consider the conditionally executed
 160    expression (which might have side-effects) to be in a separate
 161    basic block because the program counter will always be at the same
 162    location after the COND_EXEC instruction, regardless of whether the
 163    condition is true or not.
 164
 165    Basic blocks need not start with a label nor end with a jump insn.
 166    For example, a previous basic block may just "conditionally fall"
 167    into the succeeding basic block, and the last basic block need not
 168    end with a jump insn.  Block 0 is a descendant of the entry block.
 169
 170    A basic block beginning with two labels cannot have notes between
 171    the labels.
 172
 173    Data for jump tables are stored in jump_insns that occur in no
 174    basic block even though these insns can follow or precede insns in
 175    basic blocks.  */
 176
 177 /* Basic block information indexed by block number.  */
 178 typedef struct basic_block_def {
 179   /* The first and last insns of the block.  */
 180   rtx head, end;
 181
 182   /* The first and last trees of the block.  */
 183   tree head_tree;
 184   tree end_tree;
 185
 186   /* The edges into and out of the block.  */
 187   edge pred, succ;
 188
 189   /* Liveness info.  */
 190
 191   /* The registers that are modified within this in block.  */
 192   regset local_set;
 193   /* The registers that are conditionally modified within this block.
 194      In other words, registers that are set only as part of a
 195      COND_EXEC.  */
 196   regset cond_local_set;
 197   /* The registers that are live on entry to this block.
 198
 199      Note that in SSA form, global_live_at_start does not reflect the
 200      use of regs in phi functions, since the liveness of these regs
 201      may depend on which edge was taken into the block.  */
 202   regset global_live_at_start;
 203   /* The registers that are live on exit from this block.  */
 204   regset global_live_at_end;
 205
 206   /* Auxiliary info specific to a pass.  */
 207   void *aux;
 208
 209   /* The index of this block.  */
 210   int index;
 211
 212   /* Previous and next blocks in the chain.  */
 213   struct basic_block_def *prev_bb, *next_bb;
 214
 215   /* The loop depth of this block.  */
 216   int loop_depth;
 217
 218   /* Outermost loop containing the block.  */
 219   struct loop *loop_father;
 220
 221   /* Expected number of executions: calculated in profile.c.  */
 222   gcov_type count;
 223
 224   /* Expected frequency.  Normalized to be in range 0 to BB_FREQ_MAX.  */
 225   int frequency;
 226
 227   /* Various flags.  See BB_* below.  */
 228   int flags;
 229 } *basic_block;
 230
 231 #define BB_FREQ_MAX 10000
 232
 233 /* Masks for basic_block.flags.  */
 234 #define BB_DIRTY                1
 235 #define BB_NEW                  2
 236 #define BB_REACHABLE            4
 237 #define BB_VISITED              8
 238
 239 /* Number of basic blocks in the current function.  */
 240
 241 extern int n_basic_blocks;
 242
 243 /* First free basic block number.  */
 244
 245 extern int last_basic_block;
 246
 247 /* Number of edges in the current function.  */
 248
 249 extern int n_edges;
 250
 251 /* Index by basic block number, get basic block struct info.  */
 252
 253 extern varray_type basic_block_info;
 254
 255 #define BASIC_BLOCK(N)  (VARRAY_BB (basic_block_info, (N)))
 256
 257 /* For iterating over basic blocks.  */
 258 #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \
 259   for (BB = FROM; BB != TO; BB = BB->DIR)
 260
 261 #define FOR_EACH_BB(BB) \
 262   FOR_BB_BETWEEN (BB, ENTRY_BLOCK_PTR->next_bb, EXIT_BLOCK_PTR, next_bb)
 263
 264 #define FOR_EACH_BB_REVERSE(BB) \
 265   FOR_BB_BETWEEN (BB, EXIT_BLOCK_PTR->prev_bb, ENTRY_BLOCK_PTR, prev_bb)
 266
 267 /* Cycles through _all_ basic blocks, even the fake ones (entry and
 268    exit block).  */
 269
 270 #define FOR_ALL_BB(BB) \
 271   for (BB = ENTRY_BLOCK_PTR; BB; BB = BB->next_bb)
 272
 273 /* What registers are live at the setjmp call.  */
 274
 275 extern regset regs_live_at_setjmp;
 276
 277 /* Special labels found during CFG build.  */
 278
 279 extern GTY(()) rtx label_value_list;
 280 extern GTY(()) rtx tail_recursion_label_list;
 281
 282 extern struct obstack flow_obstack;
 283
 284 /* Indexed by n, gives number of basic block that  (REG n) is used in.
 285    If the value is REG_BLOCK_GLOBAL (-2),
 286    it means (REG n) is used in more than one basic block.
 287    REG_BLOCK_UNKNOWN (-1) means it hasn't been seen yet so we don't know.
 288    This information remains valid for the rest of the compilation
 289    of the current function; it is used to control register allocation.  */
 290
 291 #define REG_BLOCK_UNKNOWN -1
 292 #define REG_BLOCK_GLOBAL -2
 293
 294 #define REG_BASIC_BLOCK(N) (VARRAY_REG (reg_n_info, N)->basic_block)
 295 \f
 296 /* Stuff for recording basic block info.  */
 297
 298 #define BLOCK_HEAD(B)      (BASIC_BLOCK (B)->head)
 299 #define BLOCK_END(B)       (BASIC_BLOCK (B)->end)
 300
 301 #define BLOCK_HEAD_TREE(B) (BASIC_BLOCK (B)->head_tree)
 302 #define BLOCK_END_TREE(B) (BASIC_BLOCK (B)->end_tree)
 303
 304 /* Special block numbers [markers] for entry and exit.  */
 305 #define ENTRY_BLOCK (-1)
 306 #define EXIT_BLOCK (-2)
 307
 308 /* Special block number not valid for any block.  */
 309 #define INVALID_BLOCK (-3)
 310
 311 /* Similarly, block pointers for the edge list.  */
 312 extern struct basic_block_def entry_exit_blocks[2];
 313 #define ENTRY_BLOCK_PTR (&entry_exit_blocks[0])
 314 #define EXIT_BLOCK_PTR  (&entry_exit_blocks[1])
 315
 316 #define BLOCK_NUM(INSN)       (BLOCK_FOR_INSN (INSN)->index + 0)
 317 #define set_block_for_insn(INSN, BB)  (BLOCK_FOR_INSN (INSN) = BB)
 318
 319 extern void compute_bb_for_insn         PARAMS ((void));
 320 extern void free_bb_for_insn            PARAMS ((void));
 321 extern void update_bb_for_insn          PARAMS ((basic_block));
 322
 323 extern void free_basic_block_vars       PARAMS ((int));
 324
 325 extern edge split_block                 PARAMS ((basic_block, rtx));
 326 extern basic_block split_edge           PARAMS ((edge));
 327 extern void insert_insn_on_edge         PARAMS ((rtx, edge));
 328
 329 extern void commit_edge_insertions      PARAMS ((void));
 330 extern void commit_edge_insertions_watch_calls  PARAMS ((void));
 331
 332 extern void remove_fake_edges           PARAMS ((void));
 333 extern void add_noreturn_fake_exit_edges        PARAMS ((void));
 334 extern void connect_infinite_loops_to_exit      PARAMS ((void));
 335 extern int flow_call_edges_add          PARAMS ((sbitmap));
 336 extern edge cached_make_edge            PARAMS ((sbitmap *, basic_block,
 337                                                  basic_block, int));
 338 extern edge make_edge                   PARAMS ((basic_block,
 339                                                  basic_block, int));
 340 extern edge make_single_succ_edge       PARAMS ((basic_block,
 341                                                  basic_block, int));
 342 extern void remove_edge                 PARAMS ((edge));
 343 extern void redirect_edge_succ          PARAMS ((edge, basic_block));
 344 extern edge redirect_edge_succ_nodup    PARAMS ((edge, basic_block));
 345 extern void redirect_edge_pred          PARAMS ((edge, basic_block));
 346 extern basic_block create_basic_block_structure PARAMS ((rtx, rtx, rtx, basic_block));
 347 extern basic_block create_basic_block   PARAMS ((rtx, rtx, basic_block));
 348 extern int flow_delete_block            PARAMS ((basic_block));
 349 extern int flow_delete_block_noexpunge  PARAMS ((basic_block));
 350 extern void clear_bb_flags              PARAMS ((void));
 351 extern void merge_blocks_nomove         PARAMS ((basic_block, basic_block));
 352 extern void tidy_fallthru_edge          PARAMS ((edge, basic_block,
 353                                                  basic_block));
 354 extern void tidy_fallthru_edges         PARAMS ((void));
 355 extern void flow_reverse_top_sort_order_compute PARAMS ((int *));
 356 extern int flow_depth_first_order_compute       PARAMS ((int *, int *));
 357 extern void flow_preorder_transversal_compute   PARAMS ((int *));
 358 extern void dump_edge_info              PARAMS ((FILE *, edge, int));
 359 extern void clear_edges                 PARAMS ((void));
 360 extern void mark_critical_edges         PARAMS ((void));
 361 extern rtx first_insn_after_basic_block_note    PARAMS ((basic_block));
 362
 363 /* Dominator information for basic blocks.  */
 364
 365 typedef struct dominance_info *dominance_info;
 366
 367 /* Structure to hold information for each natural loop.  */
 368 struct loop
 369 {
 370   /* Index into loops array.  */
 371   int num;
 372
 373   /* Basic block of loop header.  */
 374   basic_block header;
 375
 376   /* Basic block of loop latch.  */
 377   basic_block latch;
 378
 379   /* Basic block of loop pre-header or NULL if it does not exist.  */
 380   basic_block pre_header;
 381
 382   /* Array of edges along the pre-header extended basic block trace.
 383      The source of the first edge is the root node of pre-header
 384      extended basic block, if it exists.  */
 385   edge *pre_header_edges;
 386
 387   /* Number of edges along the pre_header extended basic block trace.  */
 388   int num_pre_header_edges;
 389
 390   /* The first block in the loop.  This is not necessarily the same as
 391      the loop header.  */
 392   basic_block first;
 393
 394   /* The last block in the loop.  This is not necessarily the same as
 395      the loop latch.  */
 396   basic_block last;
 397
 398   /* Bitmap of blocks contained within the loop.  */
 399   sbitmap nodes;
 400
 401   /* Number of blocks contained within the loop.  */
 402   int num_nodes;
 403
 404   /* Array of edges that enter the loop.  */
 405   edge *entry_edges;
 406
 407   /* Number of edges that enter the loop.  */
 408   int num_entries;
 409
 410   /* Array of edges that exit the loop.  */
 411   edge *exit_edges;
 412
 413   /* Number of edges that exit the loop.  */
 414   int num_exits;
 415
 416   /* Bitmap of blocks that dominate all exits of the loop.  */
 417   sbitmap exits_doms;
 418
 419   /* The loop nesting depth.  */
 420   int depth;
 421
 422   /* Superloops of the loop.  */
 423   struct loop **pred;
 424
 425   /* The height of the loop (enclosed loop levels) within the loop
 426      hierarchy tree.  */
 427   int level;
 428
 429   /* The outer (parent) loop or NULL if outermost loop.  */
 430   struct loop *outer;
 431
 432   /* The first inner (child) loop or NULL if innermost loop.  */
 433   struct loop *inner;
 434
 435   /* Link to the next (sibling) loop.  */
 436   struct loop *next;
 437
 438   /* Non-zero if the loop is invalid (e.g., contains setjmp.).  */
 439   int invalid;
 440
 441   /* Auxiliary info specific to a pass.  */
 442   void *aux;
 443
 444   /* The following are currently used by loop.c but they are likely to
 445      disappear as loop.c is converted to use the CFG.  */
 446
 447   /* Non-zero if the loop has a NOTE_INSN_LOOP_VTOP.  */
 448   rtx vtop;
 449
 450   /* Non-zero if the loop has a NOTE_INSN_LOOP_CONT.
 451      A continue statement will generate a branch to NEXT_INSN (cont).  */
 452   rtx cont;
 453
 454   /* The NOTE_INSN_LOOP_BEG.  */
 455   rtx start;
 456
 457   /* The NOTE_INSN_LOOP_END.  */
 458   rtx end;
 459
 460   /* For a rotated loop that is entered near the bottom,
 461      this is the label at the top.  Otherwise it is zero.  */
 462   rtx top;
 463
 464   /* Place in the loop where control enters.  */
 465   rtx scan_start;
 466
 467   /* The position where to sink insns out of the loop.  */
 468   rtx sink;
 469
 470   /* List of all LABEL_REFs which refer to code labels outside the
 471      loop.  Used by routines that need to know all loop exits, such as
 472      final_biv_value and final_giv_value.
 473
 474      This does not include loop exits due to return instructions.
 475      This is because all bivs and givs are pseudos, and hence must be
 476      dead after a return, so the presense of a return does not affect
 477      any of the optimizations that use this info.  It is simpler to
 478      just not include return instructions on this list.  */
 479   rtx exit_labels;
 480
 481   /* The number of LABEL_REFs on exit_labels for this loop and all
 482      loops nested inside it.  */
 483   int exit_count;
 484 };
 485
 486
 487 /* Structure to hold CFG information about natural loops within a function.  */
 488 struct loops
 489 {
 490   /* Number of natural loops in the function.  */
 491   int num;
 492
 493   /* Maxium nested loop level in the function.  */
 494   int levels;
 495
 496   /* Array of natural loop descriptors (scanning this array in reverse order
 497      will find the inner loops before their enclosing outer loops).  */
 498   struct loop *array;
 499
 500   /* The above array is unused in new loop infrastructure and is kept only for
 501      purposes of the old loop optimizer.  Instead we store just pointers to
 502      loops here.  */
 503   struct loop **parray;
 504
 505   /* Pointer to root of loop heirachy tree.  */
 506   struct loop *tree_root;
 507
 508   /* Information derived from the CFG.  */
 509   struct cfg
 510   {
 511     /* The bitmap vector of dominators or NULL if not computed.  */
 512     dominance_info dom;
 513
 514     /* The ordering of the basic blocks in a depth first search.  */
 515     int *dfs_order;
 516
 517     /* The reverse completion ordering of the basic blocks found in a
 518        depth first search.  */
 519     int *rc_order;
 520   } cfg;
 521
 522   /* Headers shared by multiple loops that should be merged.  */
 523   sbitmap shared_headers;
 524 };
 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 extern int flow_loops_find PARAMS ((struct loops *, int flags));
 554 extern int flow_loops_update PARAMS ((struct loops *, int flags));
 555 extern void flow_loops_free PARAMS ((struct loops *));
 556 extern void flow_loops_dump PARAMS ((const struct loops *, FILE *,
 557                                      void (*)(const struct loop *,
 558                                               FILE *, int), int));
 559 extern void flow_loop_dump PARAMS ((const struct loop *, FILE *,
 560                                     void (*)(const struct loop *,
 561                                              FILE *, int), int));
 562 extern int flow_loop_scan PARAMS ((struct loops *, struct loop *, int));
 563 extern void flow_loop_tree_node_add PARAMS ((struct loop *, struct loop *));
 564 extern void flow_loop_tree_node_remove PARAMS ((struct loop *));
 565
 566 /* This structure maintains an edge list vector.  */
 567 struct edge_list
 568 {
 569   int num_blocks;
 570   int num_edges;
 571   edge *index_to_edge;
 572 };
 573
 574 /* This is the value which indicates no edge is present.  */
 575 #define EDGE_INDEX_NO_EDGE      -1
 576
 577 /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE
 578    if there is no edge between the 2 basic blocks.  */
 579 #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ)))
 580
 581 /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic
 582    block which is either the pred or succ end of the indexed edge.  */
 583 #define INDEX_EDGE_PRED_BB(el, index)   ((el)->index_to_edge[(index)]->src)
 584 #define INDEX_EDGE_SUCC_BB(el, index)   ((el)->index_to_edge[(index)]->dest)
 585
 586 /* INDEX_EDGE returns a pointer to the edge.  */
 587 #define INDEX_EDGE(el, index)           ((el)->index_to_edge[(index)])
 588
 589 /* Number of edges in the compressed edge list.  */
 590 #define NUM_EDGES(el)                   ((el)->num_edges)
 591
 592 /* BB is assumed to contain conditional jump.  Return the fallthru edge.  */
 593 #define FALLTHRU_EDGE(bb)               ((bb)->succ->flags & EDGE_FALLTHRU \
 594                                          ? (bb)->succ : (bb)->succ->succ_next)
 595
 596 /* BB is assumed to contain conditional jump.  Return the branch edge.  */
 597 #define BRANCH_EDGE(bb)                 ((bb)->succ->flags & EDGE_FALLTHRU \
 598                                          ? (bb)->succ->succ_next : (bb)->succ)
 599
 600 /* Return expected execution frequency of the edge E.  */
 601 #define EDGE_FREQUENCY(e)               (((e)->src->frequency \
 602                                           * (e)->probability \
 603                                           + REG_BR_PROB_BASE / 2) \
 604                                          / REG_BR_PROB_BASE)
 605
 606 /* Return nonzero if edge is critical.  */
 607 #define EDGE_CRITICAL_P(e)              ((e)->src->succ->succ_next \
 608                                          && (e)->dest->pred->pred_next)
 609
 610 struct edge_list * create_edge_list     PARAMS ((void));
 611 void free_edge_list                     PARAMS ((struct edge_list *));
 612 void print_edge_list                    PARAMS ((FILE *, struct edge_list *));
 613 void verify_edge_list                   PARAMS ((FILE *, struct edge_list *));
 614 int find_edge_index                     PARAMS ((struct edge_list *,
 615                                                  basic_block, basic_block));
 616
 617
 618 enum update_life_extent
 619 {
 620   UPDATE_LIFE_LOCAL = 0,
 621   UPDATE_LIFE_GLOBAL = 1,
 622   UPDATE_LIFE_GLOBAL_RM_NOTES = 2
 623 };
 624
 625 /* Flags for life_analysis and update_life_info.  */
 626
 627 #define PROP_DEATH_NOTES        1       /* Create DEAD and UNUSED notes.  */
 628 #define PROP_LOG_LINKS          2       /* Create LOG_LINKS.  */
 629 #define PROP_REG_INFO           4       /* Update regs_ever_live et al.  */
 630 #define PROP_KILL_DEAD_CODE     8       /* Remove dead code.  */
 631 #define PROP_SCAN_DEAD_CODE     16      /* Scan for dead code.  */
 632 #define PROP_ALLOW_CFG_CHANGES  32      /* Allow the CFG to be changed
 633                                            by dead code removal.  */
 634 #define PROP_AUTOINC            64      /* Create autoinc mem references.  */
 635 #define PROP_EQUAL_NOTES        128     /* Take into account REG_EQUAL notes.  */
 636 #define PROP_SCAN_DEAD_STORES   256     /* Scan for dead code.  */
 637 #define PROP_FINAL              (PROP_DEATH_NOTES | PROP_LOG_LINKS  \
 638                                  | PROP_REG_INFO | PROP_KILL_DEAD_CODE  \
 639                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
 640                                  | PROP_ALLOW_CFG_CHANGES \
 641                                  | PROP_SCAN_DEAD_STORES)
 642
 643 #define CLEANUP_EXPENSIVE       1       /* Do relativly expensive optimizations
 644                                            except for edge forwarding */
 645 #define CLEANUP_CROSSJUMP       2       /* Do crossjumping.  */
 646 #define CLEANUP_POST_REGSTACK   4       /* We run after reg-stack and need
 647                                            to care REG_DEAD notes.  */
 648 #define CLEANUP_PRE_SIBCALL     8       /* Do not get confused by code hidden
 649                                            inside call_placeholders..  */
 650 #define CLEANUP_PRE_LOOP        16      /* Take care to preserve syntactic loop
 651                                            notes.  */
 652 #define CLEANUP_UPDATE_LIFE     32      /* Keep life information up to date.  */
 653 #define CLEANUP_THREADING       64      /* Do jump threading.  */
 654 #define CLEANUP_NO_INSN_DEL     128     /* Do not try to delete trivially dead
 655                                            insns.  */
 656 /* Flags for loop discovery.  */
 657
 658 #define LOOP_TREE               1       /* Build loop hierarchy tree.  */
 659 #define LOOP_PRE_HEADER         2       /* Analyse loop pre-header.  */
 660 #define LOOP_ENTRY_EDGES        4       /* Find entry edges.  */
 661 #define LOOP_EXIT_EDGES         8       /* Find exit edges.  */
 662 #define LOOP_EDGES              (LOOP_ENTRY_EDGES | LOOP_EXIT_EDGES)
 663 #define LOOP_ALL               15       /* All of the above  */
 664
 665 extern void life_analysis       PARAMS ((rtx, FILE *, int));
 666 extern int update_life_info     PARAMS ((sbitmap, enum update_life_extent,
 667                                          int));
 668 extern int update_life_info_in_dirty_blocks PARAMS ((enum update_life_extent,
 669                                                       int));
 670 extern int count_or_remove_death_notes  PARAMS ((sbitmap, int));
 671 extern int propagate_block      PARAMS ((basic_block, regset, regset, regset,
 672                                          int));
 673
 674 struct propagate_block_info;
 675 extern rtx propagate_one_insn   PARAMS ((struct propagate_block_info *, rtx));
 676 extern struct propagate_block_info *init_propagate_block_info
 677   PARAMS ((basic_block, regset, regset, regset, int));
 678 extern void free_propagate_block_info PARAMS ((struct propagate_block_info *));
 679
 680 /* In lcm.c */
 681 extern struct edge_list *pre_edge_lcm   PARAMS ((FILE *, int, sbitmap *,
 682                                                  sbitmap *, sbitmap *,
 683                                                  sbitmap *, sbitmap **,
 684                                                  sbitmap **));
 685 extern struct edge_list *pre_edge_rev_lcm PARAMS ((FILE *, int, sbitmap *,
 686                                                    sbitmap *, sbitmap *,
 687                                                    sbitmap *, sbitmap **,
 688                                                    sbitmap **));
 689 extern void compute_available           PARAMS ((sbitmap *, sbitmap *,
 690                                                  sbitmap *, sbitmap *));
 691 extern int optimize_mode_switching      PARAMS ((FILE *));
 692
 693 /* In emit-rtl.c.  */
 694 extern rtx emit_block_insn_after        PARAMS ((rtx, rtx, basic_block));
 695 extern rtx emit_block_insn_before       PARAMS ((rtx, rtx, basic_block));
 696
 697 /* In predict.c */
 698 extern void estimate_probability        PARAMS ((struct loops *));
 699 extern void note_prediction_to_br_prob  PARAMS ((void));
 700 extern void expected_value_to_br_prob   PARAMS ((void));
 701 extern void note_prediction_to_br_prob  PARAMS ((void));
 702 extern bool maybe_hot_bb_p              PARAMS ((basic_block));
 703 extern bool probably_cold_bb_p          PARAMS ((basic_block));
 704 extern bool probably_never_executed_bb_p PARAMS ((basic_block));
 705
 706 /* In flow.c */
 707 extern void init_flow                   PARAMS ((void));
 708 extern void reorder_basic_blocks        PARAMS ((void));
 709 extern void dump_bb                     PARAMS ((basic_block, FILE *));
 710 extern void debug_bb                    PARAMS ((basic_block));
 711 extern void debug_bb_n                  PARAMS ((int));
 712 extern void dump_regset                 PARAMS ((regset, FILE *));
 713 extern void debug_regset                PARAMS ((regset));
 714 extern void allocate_reg_life_data      PARAMS ((void));
 715 extern void allocate_bb_life_data       PARAMS ((void));
 716 extern void expunge_block               PARAMS ((basic_block));
 717 extern void link_block                  PARAMS ((basic_block, basic_block));
 718 extern void unlink_block                PARAMS ((basic_block));
 719 extern void compact_blocks              PARAMS ((void));
 720 extern basic_block alloc_block          PARAMS ((void));
 721 extern void find_unreachable_blocks     PARAMS ((void));
 722 extern int delete_noop_moves            PARAMS ((rtx));
 723 extern basic_block redirect_edge_and_branch_force PARAMS ((edge, basic_block));
 724 extern basic_block force_nonfallthru    PARAMS ((edge));
 725 extern bool redirect_edge_and_branch    PARAMS ((edge, basic_block));
 726 extern rtx block_label                  PARAMS ((basic_block));
 727 extern bool forwarder_block_p           PARAMS ((basic_block));
 728 extern bool purge_all_dead_edges        PARAMS ((int));
 729 extern bool purge_dead_edges            PARAMS ((basic_block));
 730 extern void find_sub_basic_blocks       PARAMS ((basic_block));
 731 extern void find_many_sub_basic_blocks  PARAMS ((sbitmap));
 732 extern bool can_fallthru                PARAMS ((basic_block, basic_block));
 733 extern void flow_nodes_print            PARAMS ((const char *, const sbitmap,
 734                                                  FILE *));
 735 extern void flow_edge_list_print        PARAMS ((const char *, const edge *,
 736                                                  int, FILE *));
 737 extern void alloc_aux_for_block         PARAMS ((basic_block, int));
 738 extern void alloc_aux_for_blocks        PARAMS ((int));
 739 extern void clear_aux_for_blocks        PARAMS ((void));
 740 extern void free_aux_for_blocks         PARAMS ((void));
 741 extern void alloc_aux_for_edge          PARAMS ((edge, int));
 742 extern void alloc_aux_for_edges         PARAMS ((int));
 743 extern void clear_aux_for_edges         PARAMS ((void));
 744 extern void free_aux_for_edges          PARAMS ((void));
 745
 746 /* This function is always defined so it can be called from the
 747    debugger, and it is declared extern so we don't get warnings about
 748    it being unused.  */
 749 extern void verify_flow_info            PARAMS ((void));
 750 extern bool flow_loop_outside_edge_p    PARAMS ((const struct loop *, edge));
 751 extern bool flow_loop_nested_p PARAMS ((const struct loop *, const struct loop *));
 752 extern bool flow_bb_inside_loop_p       PARAMS ((const struct loop *, basic_block));
 753 extern basic_block *get_loop_body       PARAMS ((const struct loop *));
 754 extern int dfs_enumerate_from           PARAMS ((basic_block, int,
 755                                          bool (*)(basic_block, void *),
 756                                          basic_block *, int, void *));
 757
 758 extern edge loop_preheader_edge PARAMS ((struct loop *));
 759 extern edge loop_latch_edge PARAMS ((struct loop *));
 760
 761 extern void add_bb_to_loop PARAMS ((basic_block, struct loop *));
 762 extern void remove_bb_from_loops PARAMS ((basic_block));
 763 extern struct loop * find_common_loop PARAMS ((struct loop *, struct loop *));
 764
 765 extern void verify_loop_structure PARAMS ((struct loops *, int));
 766 #define VLS_EXPECT_PREHEADERS 1
 767 #define VLS_EXPECT_SIMPLE_LATCHES 2
 768
 769 typedef struct conflict_graph_def *conflict_graph;
 770
 771 /* Callback function when enumerating conflicts.  The arguments are
 772    the smaller and larger regno in the conflict.  Returns zero if
 773    enumeration is to continue, non-zero to halt enumeration.  */
 774 typedef int (*conflict_graph_enum_fn) PARAMS ((int, int, void *));
 775
 776
 777 /* Prototypes of operations on conflict graphs.  */
 778
 779 extern conflict_graph conflict_graph_new
 780                                         PARAMS ((int));
 781 extern void conflict_graph_delete       PARAMS ((conflict_graph));
 782 extern int conflict_graph_add           PARAMS ((conflict_graph,
 783                                                  int, int));
 784 extern int conflict_graph_conflict_p    PARAMS ((conflict_graph,
 785                                                  int, int));
 786 extern void conflict_graph_enum         PARAMS ((conflict_graph, int,
 787                                                  conflict_graph_enum_fn,
 788                                                  void *));
 789 extern void conflict_graph_merge_regs   PARAMS ((conflict_graph, int,
 790                                                  int));
 791 extern void conflict_graph_print        PARAMS ((conflict_graph, FILE*));
 792 extern conflict_graph conflict_graph_compute
 793                                         PARAMS ((regset,
 794                                                  partition));
 795 extern bool mark_dfs_back_edges         PARAMS ((void));
 796 extern void set_edge_can_fallthru_flag  PARAMS ((void));
 797 extern void update_br_prob_note         PARAMS ((basic_block));
 798 extern void fixup_abnormal_edges        PARAMS ((void));
 799 extern bool can_hoist_insn_p            PARAMS ((rtx, rtx, regset));
 800 extern rtx hoist_insn_after             PARAMS ((rtx, rtx, rtx, rtx));
 801 extern rtx hoist_insn_to_edge           PARAMS ((rtx, edge, rtx, rtx));
 802
 803 /* In dominance.c */
 804
 805 enum cdi_direction
 806 {
 807   CDI_DOMINATORS,
 808   CDI_POST_DOMINATORS
 809 };
 810
 811 extern dominance_info calculate_dominance_info  PARAMS ((enum cdi_direction));
 812 extern void free_dominance_info                 PARAMS ((dominance_info));
 813 extern basic_block nearest_common_dominator     PARAMS ((dominance_info,
 814                                                  basic_block, basic_block));
 815 extern void set_immediate_dominator     PARAMS ((dominance_info,
 816                                                  basic_block, basic_block));
 817 extern basic_block get_immediate_dominator      PARAMS ((dominance_info,
 818                                                  basic_block));
 819 extern bool dominated_by_p      PARAMS ((dominance_info, basic_block, basic_block));
 820 extern int get_dominated_by PARAMS ((dominance_info, basic_block, basic_block **));
 821 extern void add_to_dominance_info PARAMS ((dominance_info, basic_block));
 822 extern void delete_from_dominance_info PARAMS ((dominance_info, basic_block));
 823 basic_block recount_dominator PARAMS ((dominance_info, basic_block));
 824 extern void redirect_immediate_dominators PARAMS ((dominance_info, basic_block,
 825                                                  basic_block));
 826 void iterate_fix_dominators PARAMS ((dominance_info, basic_block *, int));
 827 extern void verify_dominators PARAMS ((dominance_info));
 828 #endif /* GCC_BASIC_BLOCK_H */