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   /* Location of any goto implicit in the edge, during tree-ssa.  */
 146   source_locus goto_locus;
 147
 148   int flags;                    /* see EDGE_* below  */
 149   int probability;              /* biased by REG_BR_PROB_BASE */
 150   gcov_type count;              /* Expected number of executions calculated
 151                                    in profile.c  */
 152 };
 153
 154 typedef struct edge_def *edge;
 155
 156 #define EDGE_FALLTHRU           1       /* 'Straight line' flow */
 157 #define EDGE_ABNORMAL           2       /* Strange flow, like computed
 158                                            label, or eh */
 159 #define EDGE_ABNORMAL_CALL      4       /* Call with abnormal exit
 160                                            like an exception, or sibcall */
 161 #define EDGE_EH                 8       /* Exception throw */
 162 #define EDGE_FAKE               16      /* Not a real edge (profile.c) */
 163 #define EDGE_DFS_BACK           32      /* A backwards edge */
 164 #define EDGE_CAN_FALLTHRU       64      /* Candidate for straight line
 165                                            flow.  */
 166 #define EDGE_IRREDUCIBLE_LOOP   128     /* Part of irreducible loop.  */
 167 #define EDGE_SIBCALL            256     /* Edge from sibcall to exit.  */
 168 #define EDGE_LOOP_EXIT          512     /* Exit of a loop.  */
 169 #define EDGE_TRUE_VALUE         1024    /* Edge taken when controlling
 170                                            predicate is non zero.  */
 171 #define EDGE_FALSE_VALUE        2048    /* Edge taken when controlling
 172                                            predicate is zero.  */
 173 #define EDGE_EXECUTABLE         4096    /* Edge is executable.  Only
 174                                            valid during SSA-CCP.  */
 175 #define EDGE_CROSSING           8192    /* Edge crosses between hot
 176                                            and cold sections, when we
 177                                            do partitioning.  */
 178 #define EDGE_ALL_FLAGS         16383
 179
 180 #define EDGE_COMPLEX    (EDGE_ABNORMAL | EDGE_ABNORMAL_CALL | EDGE_EH)
 181
 182 /* Counter summary from the last set of coverage counts read by
 183    profile.c.  */
 184 extern const struct gcov_ctr_summary *profile_info;
 185
 186 /* Declared in cfgloop.h.  */
 187 struct loop;
 188 struct loops;
 189
 190 /* Declared in tree-flow.h.  */
 191 struct bb_ann_d;
 192
 193 /* A basic block is a sequence of instructions with only entry and
 194    only one exit.  If any one of the instructions are executed, they
 195    will all be executed, and in sequence from first to last.
 196
 197    There may be COND_EXEC instructions in the basic block.  The
 198    COND_EXEC *instructions* will be executed -- but if the condition
 199    is false the conditionally executed *expressions* will of course
 200    not be executed.  We don't consider the conditionally executed
 201    expression (which might have side-effects) to be in a separate
 202    basic block because the program counter will always be at the same
 203    location after the COND_EXEC instruction, regardless of whether the
 204    condition is true or not.
 205
 206    Basic blocks need not start with a label nor end with a jump insn.
 207    For example, a previous basic block may just "conditionally fall"
 208    into the succeeding basic block, and the last basic block need not
 209    end with a jump insn.  Block 0 is a descendant of the entry block.
 210
 211    A basic block beginning with two labels cannot have notes between
 212    the labels.
 213
 214    Data for jump tables are stored in jump_insns that occur in no
 215    basic block even though these insns can follow or precede insns in
 216    basic blocks.  */
 217
 218 /* Basic block information indexed by block number.  */
 219 struct basic_block_def GTY((chain_next ("%h.next_bb"), chain_prev ("%h.prev_bb")))
 220 {
 221   /* The first and last insns of the block.  */
 222   rtx head_;
 223   rtx end_;
 224
 225   /* Pointers to the first and last trees of the block.  */
 226   tree stmt_list;
 227
 228   /* The edges into and out of the block.  */
 229   edge pred;
 230   edge succ;
 231
 232   /* Liveness info.  */
 233
 234   /* The registers that are modified within this in block.  */
 235   bitmap GTY ((skip (""))) local_set;
 236   /* The registers that are conditionally modified within this block.
 237      In other words, registers that are set only as part of a
 238      COND_EXEC.  */
 239   bitmap GTY ((skip (""))) cond_local_set;
 240   /* The registers that are live on entry to this block.
 241
 242      Note that in SSA form, global_live_at_start does not reflect the
 243      use of regs in phi functions, since the liveness of these regs
 244      may depend on which edge was taken into the block.  */
 245   bitmap GTY ((skip (""))) global_live_at_start;
 246   /* The registers that are live on exit from this block.  */
 247   bitmap GTY ((skip (""))) global_live_at_end;
 248
 249   /* Auxiliary info specific to a pass.  */
 250   PTR GTY ((skip (""))) aux;
 251
 252   /* The index of this block.  */
 253   int index;
 254
 255   /* Previous and next blocks in the chain.  */
 256   struct basic_block_def *prev_bb;
 257   struct basic_block_def *next_bb;
 258
 259   /* The loop depth of this block.  */
 260   int loop_depth;
 261
 262   /* Innermost loop containing the block.  */
 263   struct loop * GTY ((skip (""))) loop_father;
 264
 265   /* The dominance and postdominance information node.  */
 266   struct et_node * GTY ((skip (""))) dom[2];
 267
 268   /* Expected number of executions: calculated in profile.c.  */
 269   gcov_type count;
 270
 271   /* Expected frequency.  Normalized to be in range 0 to BB_FREQ_MAX.  */
 272   int frequency;
 273
 274   /* Various flags.  See BB_* below.  */
 275   int flags;
 276
 277   /* Which section block belongs in, when partitioning basic blocks.  */
 278   int partition;
 279
 280   /* The data used by basic block copying and reordering functions.  */
 281   struct reorder_block_def * GTY ((skip (""))) rbi;
 282
 283   /* Annotations used at the tree level.  */
 284   struct bb_ann_d *tree_annotations;
 285 };
 286
 287 typedef struct basic_block_def *basic_block;
 288
 289 /* Structure to hold information about the blocks during reordering and
 290    copying.  */
 291
 292 typedef struct reorder_block_def
 293 {
 294   rtx header;
 295   rtx footer;
 296   basic_block next;
 297   basic_block original;
 298   /* Used by loop copying.  */
 299   basic_block copy;
 300   int duplicated;
 301
 302   /* These fields are used by bb-reorder pass.  */
 303   int visited;
 304 } *reorder_block_def_p;
 305
 306 #define BB_FREQ_MAX 10000
 307
 308 /* Masks for basic_block.flags.  */
 309 #define BB_DIRTY                1
 310 #define BB_NEW                  2
 311 #define BB_REACHABLE            4
 312 #define BB_VISITED              8
 313 #define BB_IRREDUCIBLE_LOOP     16
 314 #define BB_SUPERBLOCK           32
 315
 316 /* Partitions, to be used when partitioning hot and cold basic blocks into
 317    separate sections.  */
 318 #define UNPARTITIONED   0
 319 #define HOT_PARTITION   1
 320 #define COLD_PARTITION  2
 321
 322 /* Number of basic blocks in the current function.  */
 323
 324 extern int n_basic_blocks;
 325
 326 /* First free basic block number.  */
 327
 328 extern int last_basic_block;
 329
 330 /* Number of edges in the current function.  */
 331
 332 extern int n_edges;
 333
 334 /* Signalize the status of profile information in the CFG.  */
 335 extern enum profile_status
 336 {
 337   PROFILE_ABSENT,
 338   PROFILE_GUESSED,
 339   PROFILE_READ
 340 } profile_status;
 341
 342 /* Index by basic block number, get basic block struct info.  */
 343
 344 extern GTY(()) varray_type basic_block_info;
 345
 346 #define BASIC_BLOCK(N)  (VARRAY_BB (basic_block_info, (N)))
 347
 348 /* For iterating over basic blocks.  */
 349 #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \
 350   for (BB = FROM; BB != TO; BB = BB->DIR)
 351
 352 #define FOR_EACH_BB(BB) \
 353   FOR_BB_BETWEEN (BB, ENTRY_BLOCK_PTR->next_bb, EXIT_BLOCK_PTR, next_bb)
 354
 355 #define FOR_EACH_BB_REVERSE(BB) \
 356   FOR_BB_BETWEEN (BB, EXIT_BLOCK_PTR->prev_bb, ENTRY_BLOCK_PTR, prev_bb)
 357
 358 /* For iterating over insns in basic block.  */
 359 #define FOR_BB_INSNS(BB, INSN)                  \
 360   for ((INSN) = BB_HEAD (BB);                   \
 361        (INSN) != NEXT_INSN (BB_END (BB));       \
 362        (INSN) = NEXT_INSN (INSN))
 363
 364 #define FOR_BB_INSNS_REVERSE(BB, INSN)          \
 365   for ((INSN) = BB_END (BB);                    \
 366        (INSN) != PREV_INSN (BB_HEAD (BB));      \
 367        (INSN) = PREV_INSN (INSN))
 368
 369 /* Cycles through _all_ basic blocks, even the fake ones (entry and
 370    exit block).  */
 371
 372 #define FOR_ALL_BB(BB) \
 373   for (BB = ENTRY_BLOCK_PTR; BB; BB = BB->next_bb)
 374
 375 /* What registers are live at the setjmp call.  */
 376
 377 extern regset regs_live_at_setjmp;
 378
 379 /* Special labels found during CFG build.  */
 380
 381 extern GTY(()) rtx label_value_list;
 382
 383 extern struct obstack flow_obstack;
 384
 385 /* Indexed by n, gives number of basic block that  (REG n) is used in.
 386    If the value is REG_BLOCK_GLOBAL (-2),
 387    it means (REG n) is used in more than one basic block.
 388    REG_BLOCK_UNKNOWN (-1) means it hasn't been seen yet so we don't know.
 389    This information remains valid for the rest of the compilation
 390    of the current function; it is used to control register allocation.  */
 391
 392 #define REG_BLOCK_UNKNOWN -1
 393 #define REG_BLOCK_GLOBAL -2
 394
 395 #define REG_BASIC_BLOCK(N) (VARRAY_REG (reg_n_info, N)->basic_block)
 396 \f
 397 /* Stuff for recording basic block info.  */
 398
 399 #define BB_HEAD(B)      (B)->head_
 400 #define BB_END(B)       (B)->end_
 401
 402 /* Special block numbers [markers] for entry and exit.  */
 403 #define ENTRY_BLOCK (-1)
 404 #define EXIT_BLOCK (-2)
 405
 406 /* Special block number not valid for any block.  */
 407 #define INVALID_BLOCK (-3)
 408
 409 /* Similarly, block pointers for the edge list.  */
 410 extern GTY(()) basic_block ENTRY_BLOCK_PTR;
 411 extern GTY(()) basic_block EXIT_BLOCK_PTR;
 412
 413 #define BLOCK_NUM(INSN)       (BLOCK_FOR_INSN (INSN)->index + 0)
 414 #define set_block_for_insn(INSN, BB)  (BLOCK_FOR_INSN (INSN) = BB)
 415
 416 extern void compute_bb_for_insn (void);
 417 extern void free_bb_for_insn (void);
 418 extern void update_bb_for_insn (basic_block);
 419
 420 extern void free_basic_block_vars (void);
 421
 422 extern void insert_insn_on_edge (rtx, edge);
 423 bool safe_insert_insn_on_edge (rtx, edge);
 424
 425 extern void commit_edge_insertions (void);
 426 extern void commit_edge_insertions_watch_calls (void);
 427
 428 extern void remove_fake_edges (void);
 429 extern void remove_fake_exit_edges (void);
 430 extern void add_noreturn_fake_exit_edges (void);
 431 extern void connect_infinite_loops_to_exit (void);
 432 extern edge unchecked_make_edge (basic_block, basic_block, int);
 433 extern edge cached_make_edge (sbitmap *, basic_block, basic_block, int);
 434 extern edge make_edge (basic_block, basic_block, int);
 435 extern edge make_single_succ_edge (basic_block, basic_block, int);
 436 extern void remove_edge (edge);
 437 extern void redirect_edge_succ (edge, basic_block);
 438 extern edge redirect_edge_succ_nodup (edge, basic_block);
 439 extern void redirect_edge_pred (edge, basic_block);
 440 extern basic_block create_basic_block_structure (rtx, rtx, rtx, basic_block);
 441 extern void clear_bb_flags (void);
 442 extern void flow_reverse_top_sort_order_compute (int *);
 443 extern int flow_depth_first_order_compute (int *, int *);
 444 extern void flow_preorder_transversal_compute (int *);
 445 extern int dfs_enumerate_from (basic_block, int,
 446                                bool (*)(basic_block, void *),
 447                                basic_block *, int, void *);
 448 extern void compute_dominance_frontiers (bitmap *);
 449 extern void dump_edge_info (FILE *, edge, int);
 450 extern void brief_dump_cfg (FILE *);
 451 extern void clear_edges (void);
 452 extern void mark_critical_edges (void);
 453 extern rtx first_insn_after_basic_block_note (basic_block);
 454
 455 /* Structure to group all of the information to process IF-THEN and
 456    IF-THEN-ELSE blocks for the conditional execution support.  This
 457    needs to be in a public file in case the IFCVT macros call
 458    functions passing the ce_if_block data structure.  */
 459
 460 typedef struct ce_if_block
 461 {
 462   basic_block test_bb;                  /* First test block.  */
 463   basic_block then_bb;                  /* THEN block.  */
 464   basic_block else_bb;                  /* ELSE block or NULL.  */
 465   basic_block join_bb;                  /* Join THEN/ELSE blocks.  */
 466   basic_block last_test_bb;             /* Last bb to hold && or || tests.  */
 467   int num_multiple_test_blocks;         /* # of && and || basic blocks.  */
 468   int num_and_and_blocks;               /* # of && blocks.  */
 469   int num_or_or_blocks;                 /* # of || blocks.  */
 470   int num_multiple_test_insns;          /* # of insns in && and || blocks.  */
 471   int and_and_p;                        /* Complex test is &&.  */
 472   int num_then_insns;                   /* # of insns in THEN block.  */
 473   int num_else_insns;                   /* # of insns in ELSE block.  */
 474   int pass;                             /* Pass number.  */
 475
 476 #ifdef IFCVT_EXTRA_FIELDS
 477   IFCVT_EXTRA_FIELDS                    /* Any machine dependent fields.  */
 478 #endif
 479
 480 } ce_if_block_t;
 481
 482 /* This structure maintains an edge list vector.  */
 483 struct edge_list
 484 {
 485   int num_blocks;
 486   int num_edges;
 487   edge *index_to_edge;
 488 };
 489
 490 /* This is the value which indicates no edge is present.  */
 491 #define EDGE_INDEX_NO_EDGE      -1
 492
 493 /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE
 494    if there is no edge between the 2 basic blocks.  */
 495 #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ)))
 496
 497 /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic
 498    block which is either the pred or succ end of the indexed edge.  */
 499 #define INDEX_EDGE_PRED_BB(el, index)   ((el)->index_to_edge[(index)]->src)
 500 #define INDEX_EDGE_SUCC_BB(el, index)   ((el)->index_to_edge[(index)]->dest)
 501
 502 /* INDEX_EDGE returns a pointer to the edge.  */
 503 #define INDEX_EDGE(el, index)           ((el)->index_to_edge[(index)])
 504
 505 /* Number of edges in the compressed edge list.  */
 506 #define NUM_EDGES(el)                   ((el)->num_edges)
 507
 508 /* BB is assumed to contain conditional jump.  Return the fallthru edge.  */
 509 #define FALLTHRU_EDGE(bb)               ((bb)->succ->flags & EDGE_FALLTHRU \
 510                                          ? (bb)->succ : (bb)->succ->succ_next)
 511
 512 /* BB is assumed to contain conditional jump.  Return the branch edge.  */
 513 #define BRANCH_EDGE(bb)                 ((bb)->succ->flags & EDGE_FALLTHRU \
 514                                          ? (bb)->succ->succ_next : (bb)->succ)
 515
 516 /* Return expected execution frequency of the edge E.  */
 517 #define EDGE_FREQUENCY(e)               (((e)->src->frequency \
 518                                           * (e)->probability \
 519                                           + REG_BR_PROB_BASE / 2) \
 520                                          / REG_BR_PROB_BASE)
 521
 522 /* Return nonzero if edge is critical.  */
 523 #define EDGE_CRITICAL_P(e)              ((e)->src->succ->succ_next \
 524                                          && (e)->dest->pred->pred_next)
 525
 526 struct edge_list * create_edge_list (void);
 527 void free_edge_list (struct edge_list *);
 528 void print_edge_list (FILE *, struct edge_list *);
 529 void verify_edge_list (FILE *, struct edge_list *);
 530 int find_edge_index (struct edge_list *, basic_block, basic_block);
 531 edge find_edge (basic_block, basic_block);
 532
 533
 534 enum update_life_extent
 535 {
 536   UPDATE_LIFE_LOCAL = 0,
 537   UPDATE_LIFE_GLOBAL = 1,
 538   UPDATE_LIFE_GLOBAL_RM_NOTES = 2
 539 };
 540
 541 /* Flags for life_analysis and update_life_info.  */
 542
 543 #define PROP_DEATH_NOTES        1       /* Create DEAD and UNUSED notes.  */
 544 #define PROP_LOG_LINKS          2       /* Create LOG_LINKS.  */
 545 #define PROP_REG_INFO           4       /* Update regs_ever_live et al.  */
 546 #define PROP_KILL_DEAD_CODE     8       /* Remove dead code.  */
 547 #define PROP_SCAN_DEAD_CODE     16      /* Scan for dead code.  */
 548 #define PROP_ALLOW_CFG_CHANGES  32      /* Allow the CFG to be changed
 549                                            by dead code removal.  */
 550 #define PROP_AUTOINC            64      /* Create autoinc mem references.  */
 551 #define PROP_EQUAL_NOTES        128     /* Take into account REG_EQUAL notes.  */
 552 #define PROP_SCAN_DEAD_STORES   256     /* Scan for dead code.  */
 553 #define PROP_ASM_SCAN           512     /* Internal flag used within flow.c
 554                                            to flag analysis of asms.  */
 555 #define PROP_FINAL              (PROP_DEATH_NOTES | PROP_LOG_LINKS  \
 556                                  | PROP_REG_INFO | PROP_KILL_DEAD_CODE  \
 557                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
 558                                  | PROP_ALLOW_CFG_CHANGES \
 559                                  | PROP_SCAN_DEAD_STORES)
 560 #define PROP_POSTRELOAD         (PROP_DEATH_NOTES  \
 561                                  | PROP_KILL_DEAD_CODE  \
 562                                  | PROP_SCAN_DEAD_CODE | PROP_AUTOINC \
 563                                  | PROP_SCAN_DEAD_STORES)
 564
 565 #define CLEANUP_EXPENSIVE       1       /* Do relatively expensive optimizations
 566                                            except for edge forwarding */
 567 #define CLEANUP_CROSSJUMP       2       /* Do crossjumping.  */
 568 #define CLEANUP_POST_REGSTACK   4       /* We run after reg-stack and need
 569                                            to care REG_DEAD notes.  */
 570 #define CLEANUP_PRE_LOOP        8       /* Take care to preserve syntactic loop
 571                                            notes.  */
 572 #define CLEANUP_UPDATE_LIFE     16      /* Keep life information up to date.  */
 573 #define CLEANUP_THREADING       32      /* Do jump threading.  */
 574 #define CLEANUP_NO_INSN_DEL     64      /* Do not try to delete trivially dead
 575                                            insns.  */
 576 #define CLEANUP_CFGLAYOUT       128     /* Do cleanup in cfglayout mode.  */
 577 #define CLEANUP_LOG_LINKS       256     /* Update log links.  */
 578
 579 extern void life_analysis (FILE *, int);
 580 extern int update_life_info (sbitmap, enum update_life_extent, int);
 581 extern int update_life_info_in_dirty_blocks (enum update_life_extent, int);
 582 extern int count_or_remove_death_notes (sbitmap, int);
 583 extern int propagate_block (basic_block, regset, regset, regset, int);
 584
 585 struct propagate_block_info;
 586 extern rtx propagate_one_insn (struct propagate_block_info *, rtx);
 587 extern struct propagate_block_info *init_propagate_block_info
 588  (basic_block, regset, regset, regset, int);
 589 extern void free_propagate_block_info (struct propagate_block_info *);
 590
 591 /* In lcm.c */
 592 extern struct edge_list *pre_edge_lcm (FILE *, int, sbitmap *, sbitmap *,
 593                                        sbitmap *, sbitmap *, sbitmap **,
 594                                        sbitmap **);
 595 extern struct edge_list *pre_edge_rev_lcm (FILE *, int, sbitmap *,
 596                                            sbitmap *, sbitmap *,
 597                                            sbitmap *, sbitmap **,
 598                                            sbitmap **);
 599 extern void compute_available (sbitmap *, sbitmap *, sbitmap *, sbitmap *);
 600 extern int optimize_mode_switching (FILE *);
 601
 602 /* In emit-rtl.c.  */
 603 extern rtx emit_block_insn_after (rtx, rtx, basic_block);
 604 extern rtx emit_block_insn_before (rtx, rtx, basic_block);
 605
 606 /* In predict.c */
 607 extern void estimate_probability (struct loops *);
 608 extern void expected_value_to_br_prob (void);
 609 extern bool maybe_hot_bb_p (basic_block);
 610 extern bool probably_cold_bb_p (basic_block);
 611 extern bool probably_never_executed_bb_p (basic_block);
 612 extern bool tree_predicted_by_p (basic_block, enum br_predictor);
 613 extern bool rtl_predicted_by_p (basic_block, enum br_predictor);
 614 extern void tree_predict_edge (edge, enum br_predictor, int);
 615 extern void rtl_predict_edge (edge, enum br_predictor, int);
 616 extern void predict_edge_def (edge, enum br_predictor, enum prediction);
 617
 618 /* In flow.c */
 619 extern void init_flow (void);
 620 extern void debug_bb (basic_block);
 621 extern basic_block debug_bb_n (int);
 622 extern void dump_regset (regset, FILE *);
 623 extern void debug_regset (regset);
 624 extern void allocate_reg_life_data (void);
 625 extern void allocate_bb_life_data (void);
 626 extern void expunge_block (basic_block);
 627 extern void link_block (basic_block, basic_block);
 628 extern void unlink_block (basic_block);
 629 extern void compact_blocks (void);
 630 extern basic_block alloc_block (void);
 631 extern void find_unreachable_blocks (void);
 632 extern int delete_noop_moves (void);
 633 extern basic_block force_nonfallthru (edge);
 634 extern rtx block_label (basic_block);
 635 extern bool forwarder_block_p (basic_block);
 636 extern bool purge_all_dead_edges (int);
 637 extern bool purge_dead_edges (basic_block);
 638 extern void find_sub_basic_blocks (basic_block);
 639 extern void find_many_sub_basic_blocks (sbitmap);
 640 extern void rtl_make_eh_edge (sbitmap *, basic_block, rtx);
 641 extern bool can_fallthru (basic_block, basic_block);
 642 extern bool could_fall_through (basic_block, basic_block);
 643 extern void flow_nodes_print (const char *, const sbitmap, FILE *);
 644 extern void flow_edge_list_print (const char *, const edge *, int, FILE *);
 645 extern void alloc_aux_for_block (basic_block, int);
 646 extern void alloc_aux_for_blocks (int);
 647 extern void clear_aux_for_blocks (void);
 648 extern void free_aux_for_blocks (void);
 649 extern void alloc_aux_for_edge (edge, int);
 650 extern void alloc_aux_for_edges (int);
 651 extern void clear_aux_for_edges (void);
 652 extern void free_aux_for_edges (void);
 653 extern void find_basic_blocks (rtx, int, FILE *);
 654 extern bool cleanup_cfg (int);
 655 extern bool delete_unreachable_blocks (void);
 656 extern bool merge_seq_blocks (void);
 657
 658 typedef struct conflict_graph_def *conflict_graph;
 659
 660 /* Callback function when enumerating conflicts.  The arguments are
 661    the smaller and larger regno in the conflict.  Returns zero if
 662    enumeration is to continue, nonzero to halt enumeration.  */
 663 typedef int (*conflict_graph_enum_fn) (int, int, void *);
 664
 665
 666 /* Prototypes of operations on conflict graphs.  */
 667
 668 extern conflict_graph conflict_graph_new
 669  (int);
 670 extern void conflict_graph_delete (conflict_graph);
 671 extern int conflict_graph_add (conflict_graph, int, int);
 672 extern int conflict_graph_conflict_p (conflict_graph, int, int);
 673 extern void conflict_graph_enum (conflict_graph, int, conflict_graph_enum_fn,
 674                                  void *);
 675 extern void conflict_graph_merge_regs (conflict_graph, int, int);
 676 extern void conflict_graph_print (conflict_graph, FILE*);
 677 extern conflict_graph conflict_graph_compute (regset, partition);
 678 extern bool mark_dfs_back_edges (void);
 679 extern void set_edge_can_fallthru_flag (void);
 680 extern void update_br_prob_note (basic_block);
 681 extern void fixup_abnormal_edges (void);
 682 extern bool can_hoist_insn_p (rtx, rtx, regset);
 683 extern rtx hoist_insn_after (rtx, rtx, rtx, rtx);
 684 extern rtx hoist_insn_to_edge (rtx, edge, rtx, rtx);
 685 extern bool inside_basic_block_p (rtx);
 686 extern bool control_flow_insn_p (rtx);
 687
 688 /* In bb-reorder.c */
 689 extern void reorder_basic_blocks (unsigned int);
 690 extern void partition_hot_cold_basic_blocks (void);
 691
 692 /* In cfg.c */
 693 extern void alloc_rbi_pool (void);
 694 extern void initialize_bb_rbi (basic_block bb);
 695 extern void free_rbi_pool (void);
 696
 697 /* In dominance.c */
 698
 699 enum cdi_direction
 700 {
 701   CDI_DOMINATORS,
 702   CDI_POST_DOMINATORS
 703 };
 704
 705 enum dom_state
 706 {
 707   DOM_NONE,             /* Not computed at all.  */
 708   DOM_CONS_OK,          /* The data is conservatively OK, i.e. if it says you that A dominates B,
 709                            it indeed does.  */
 710   DOM_NO_FAST_QUERY,    /* The data is OK, but the fast query data are not usable.  */
 711   DOM_OK                /* Everything is ok.  */
 712 };
 713
 714 extern enum dom_state dom_computed[2];
 715
 716 extern void calculate_dominance_info (enum cdi_direction);
 717 extern void free_dominance_info (enum cdi_direction);
 718 extern basic_block nearest_common_dominator (enum cdi_direction,
 719                                              basic_block, basic_block);
 720 extern void set_immediate_dominator (enum cdi_direction, basic_block,
 721                                      basic_block);
 722 extern basic_block get_immediate_dominator (enum cdi_direction, basic_block);
 723 extern bool dominated_by_p (enum cdi_direction, basic_block, basic_block);
 724 extern int get_dominated_by (enum cdi_direction, basic_block, basic_block **);
 725 extern void add_to_dominance_info (enum cdi_direction, basic_block);
 726 extern void delete_from_dominance_info (enum cdi_direction, basic_block);
 727 basic_block recount_dominator (enum cdi_direction, basic_block);
 728 extern void redirect_immediate_dominators (enum cdi_direction, basic_block,
 729                                            basic_block);
 730 extern void iterate_fix_dominators (enum cdi_direction, basic_block *, int);
 731 extern void verify_dominators (enum cdi_direction);
 732 extern basic_block first_dom_son (enum cdi_direction, basic_block);
 733 extern basic_block next_dom_son (enum cdi_direction, basic_block);
 734 extern edge try_redirect_by_replacing_jump (edge, basic_block, bool);
 735 extern void break_superblocks (void);
 736 extern void check_bb_profile (basic_block, FILE *);
 737
 738 #include "cfghooks.h"
 739
 740 #endif /* GCC_BASIC_BLOCK_H */