gcc/basic-block.h

   1 /* Define control flow data structures for the CFG.
   2    Copyright (C) 1987-2014 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_BASIC_BLOCK_H
  21 #define GCC_BASIC_BLOCK_H
  22
  23 #include "predict.h"
  24 #include "vec.h"
  25 #include "function.h"
  26
  27 /* Use gcov_type to hold basic block counters.  Should be at least
  28    64bit.  Although a counter cannot be negative, we use a signed
  29    type, because erroneous negative counts can be generated when the
  30    flow graph is manipulated by various optimizations.  A signed type
  31    makes those easy to detect.  */
  32
  33 /* Control flow edge information.  */
  34 struct GTY((user)) edge_def {
  35   /* The two blocks at the ends of the edge.  */
  36   basic_block src;
  37   basic_block dest;
  38
  39   /* Instructions queued on the edge.  */
  40   union edge_def_insns {
  41     gimple_seq g;
  42     rtx r;
  43   } insns;
  44
  45   /* Auxiliary info specific to a pass.  */
  46   PTR aux;
  47
  48   /* Location of any goto implicit in the edge.  */
  49   location_t goto_locus;
  50
  51   /* The index number corresponding to this edge in the edge vector
  52      dest->preds.  */
  53   unsigned int dest_idx;
  54
  55   int flags;                    /* see cfg-flags.def */
  56   int probability;              /* biased by REG_BR_PROB_BASE */
  57   gcov_type count;              /* Expected number of executions calculated
  58                                    in profile.c  */
  59 };
  60
  61
  62 /* Garbage collection and PCH support for edge_def.  */
  63 extern void gt_ggc_mx (edge_def *e);
  64 extern void gt_pch_nx (edge_def *e);
  65 extern void gt_pch_nx (edge_def *e, gt_pointer_operator, void *);
  66
  67 /* Masks for edge.flags.  */
  68 #define DEF_EDGE_FLAG(NAME,IDX) EDGE_##NAME = 1 << IDX ,
  69 enum cfg_edge_flags {
  70 #include "cfg-flags.def"
  71   LAST_CFG_EDGE_FLAG            /* this is only used for EDGE_ALL_FLAGS */
  72 };
  73 #undef DEF_EDGE_FLAG
  74
  75 /* Bit mask for all edge flags.  */
  76 #define EDGE_ALL_FLAGS          ((LAST_CFG_EDGE_FLAG - 1) * 2 - 1)
  77
  78 /* The following four flags all indicate something special about an edge.
  79    Test the edge flags on EDGE_COMPLEX to detect all forms of "strange"
  80    control flow transfers.  */
  81 #define EDGE_COMPLEX \
  82   (EDGE_ABNORMAL | EDGE_ABNORMAL_CALL | EDGE_EH | EDGE_PRESERVE)
  83
  84 /* Counter summary from the last set of coverage counts read by
  85    profile.c.  */
  86 extern const struct gcov_ctr_summary *profile_info;
  87
  88 /* Structure to gather statistic about profile consistency, per pass.
  89    An array of this structure, indexed by pass static number, is allocated
  90    in passes.c.  The structure is defined here so that different CFG modes
  91    can do their book-keeping via CFG hooks.
  92
  93    For every field[2], field[0] is the count before the pass runs, and
  94    field[1] is the post-pass count.  This allows us to monitor the effect
  95    of each individual pass on the profile consistency.
  96
  97    This structure is not supposed to be used by anything other than passes.c
  98    and one CFG hook per CFG mode.  */
  99 struct profile_record
 100 {
 101   /* The number of basic blocks where sum(freq) of the block's predecessors
 102      doesn't match reasonably well with the incoming frequency.  */
 103   int num_mismatched_freq_in[2];
 104   /* Likewise for a basic block's successors.  */
 105   int num_mismatched_freq_out[2];
 106   /* The number of basic blocks where sum(count) of the block's predecessors
 107      doesn't match reasonably well with the incoming frequency.  */
 108   int num_mismatched_count_in[2];
 109   /* Likewise for a basic block's successors.  */
 110   int num_mismatched_count_out[2];
 111   /* A weighted cost of the run-time of the function body.  */
 112   gcov_type time[2];
 113   /* A weighted cost of the size of the function body.  */
 114   int size[2];
 115   /* True iff this pass actually was run.  */
 116   bool run;
 117 };
 118
 119 /* Declared in cfgloop.h.  */
 120 struct loop;
 121
 122 struct GTY(()) rtl_bb_info {
 123   /* The first insn of the block is embedded into bb->il.x.  */
 124   /* The last insn of the block.  */
 125   rtx end_;
 126
 127   /* In CFGlayout mode points to insn notes/jumptables to be placed just before
 128      and after the block.   */
 129   rtx header_;
 130   rtx footer_;
 131 };
 132
 133 struct GTY(()) gimple_bb_info {
 134   /* Sequence of statements in this block.  */
 135   gimple_seq seq;
 136
 137   /* PHI nodes for this block.  */
 138   gimple_seq phi_nodes;
 139 };
 140
 141 /* A basic block is a sequence of instructions with only one entry and
 142    only one exit.  If any one of the instructions are executed, they
 143    will all be executed, and in sequence from first to last.
 144
 145    There may be COND_EXEC instructions in the basic block.  The
 146    COND_EXEC *instructions* will be executed -- but if the condition
 147    is false the conditionally executed *expressions* will of course
 148    not be executed.  We don't consider the conditionally executed
 149    expression (which might have side-effects) to be in a separate
 150    basic block because the program counter will always be at the same
 151    location after the COND_EXEC instruction, regardless of whether the
 152    condition is true or not.
 153
 154    Basic blocks need not start with a label nor end with a jump insn.
 155    For example, a previous basic block may just "conditionally fall"
 156    into the succeeding basic block, and the last basic block need not
 157    end with a jump insn.  Block 0 is a descendant of the entry block.
 158
 159    A basic block beginning with two labels cannot have notes between
 160    the labels.
 161
 162    Data for jump tables are stored in jump_insns that occur in no
 163    basic block even though these insns can follow or precede insns in
 164    basic blocks.  */
 165
 166 /* Basic block information indexed by block number.  */
 167 struct GTY((chain_next ("%h.next_bb"), chain_prev ("%h.prev_bb"))) basic_block_def {
 168   /* The edges into and out of the block.  */
 169   vec<edge, va_gc> *preds;
 170   vec<edge, va_gc> *succs;
 171
 172   /* Auxiliary info specific to a pass.  */
 173   PTR GTY ((skip (""))) aux;
 174
 175   /* Innermost loop containing the block.  */
 176   struct loop *loop_father;
 177
 178   /* The dominance and postdominance information node.  */
 179   struct et_node * GTY ((skip (""))) dom[2];
 180
 181   /* Previous and next blocks in the chain.  */
 182   basic_block prev_bb;
 183   basic_block next_bb;
 184
 185   union basic_block_il_dependent {
 186       struct gimple_bb_info GTY ((tag ("0"))) gimple;
 187       struct {
 188         rtx head_;
 189         struct rtl_bb_info * rtl;
 190       } GTY ((tag ("1"))) x;
 191     } GTY ((desc ("((%1.flags & BB_RTL) != 0)"))) il;
 192
 193   /* Various flags.  See cfg-flags.def.  */
 194   int flags;
 195
 196   /* The index of this block.  */
 197   int index;
 198
 199   /* Expected number of executions: calculated in profile.c.  */
 200   gcov_type count;
 201
 202   /* Expected frequency.  Normalized to be in range 0 to BB_FREQ_MAX.  */
 203   int frequency;
 204 };
 205
 206 /* This ensures that struct gimple_bb_info is smaller than
 207    struct rtl_bb_info, so that inlining the former into basic_block_def
 208    is the better choice.  */
 209 typedef int __assert_gimple_bb_smaller_rtl_bb
 210               [(int) sizeof (struct rtl_bb_info)
 211                - (int) sizeof (struct gimple_bb_info)];
 212
 213
 214 #define BB_FREQ_MAX 10000
 215
 216 /* Masks for basic_block.flags.  */
 217 #define DEF_BASIC_BLOCK_FLAG(NAME,IDX) BB_##NAME = 1 << IDX ,
 218 enum cfg_bb_flags
 219 {
 220 #include "cfg-flags.def"
 221   LAST_CFG_BB_FLAG              /* this is only used for BB_ALL_FLAGS */
 222 };
 223 #undef DEF_BASIC_BLOCK_FLAG
 224
 225 /* Bit mask for all basic block flags.  */
 226 #define BB_ALL_FLAGS            ((LAST_CFG_BB_FLAG - 1) * 2 - 1)
 227
 228 /* Bit mask for all basic block flags that must be preserved.  These are
 229    the bit masks that are *not* cleared by clear_bb_flags.  */
 230 #define BB_FLAGS_TO_PRESERVE                                    \
 231   (BB_DISABLE_SCHEDULE | BB_RTL | BB_NON_LOCAL_GOTO_TARGET      \
 232    | BB_HOT_PARTITION | BB_COLD_PARTITION)
 233
 234 /* Dummy bitmask for convenience in the hot/cold partitioning code.  */
 235 #define BB_UNPARTITIONED        0
 236
 237 /* Partitions, to be used when partitioning hot and cold basic blocks into
 238    separate sections.  */
 239 #define BB_PARTITION(bb) ((bb)->flags & (BB_HOT_PARTITION|BB_COLD_PARTITION))
 240 #define BB_SET_PARTITION(bb, part) do {                                 \
 241   basic_block bb_ = (bb);                                               \
 242   bb_->flags = ((bb_->flags & ~(BB_HOT_PARTITION|BB_COLD_PARTITION))    \
 243                 | (part));                                              \
 244 } while (0)
 245
 246 #define BB_COPY_PARTITION(dstbb, srcbb) \
 247   BB_SET_PARTITION (dstbb, BB_PARTITION (srcbb))
 248
 249 /* State of dominance information.  */
 250
 251 enum dom_state
 252 {
 253   DOM_NONE,             /* Not computed at all.  */
 254   DOM_NO_FAST_QUERY,    /* The data is OK, but the fast query data are not usable.  */
 255   DOM_OK                /* Everything is ok.  */
 256 };
 257
 258 /* What sort of profiling information we have.  */
 259 enum profile_status_d
 260 {
 261   PROFILE_ABSENT,
 262   PROFILE_GUESSED,
 263   PROFILE_READ,
 264   PROFILE_LAST  /* Last value, used by profile streaming.  */
 265 };
 266
 267 /* A structure to group all the per-function control flow graph data.
 268    The x_* prefixing is necessary because otherwise references to the
 269    fields of this struct are interpreted as the defines for backward
 270    source compatibility following the definition of this struct.  */
 271 struct GTY(()) control_flow_graph {
 272   /* Block pointers for the exit and entry of a function.
 273      These are always the head and tail of the basic block list.  */
 274   basic_block x_entry_block_ptr;
 275   basic_block x_exit_block_ptr;
 276
 277   /* Index by basic block number, get basic block struct info.  */
 278   vec<basic_block, va_gc> *x_basic_block_info;
 279
 280   /* Number of basic blocks in this flow graph.  */
 281   int x_n_basic_blocks;
 282
 283   /* Number of edges in this flow graph.  */
 284   int x_n_edges;
 285
 286   /* The first free basic block number.  */
 287   int x_last_basic_block;
 288
 289   /* UIDs for LABEL_DECLs.  */
 290   int last_label_uid;
 291
 292   /* Mapping of labels to their associated blocks.  At present
 293      only used for the gimple CFG.  */
 294   vec<basic_block, va_gc> *x_label_to_block_map;
 295
 296   enum profile_status_d x_profile_status;
 297
 298   /* Whether the dominators and the postdominators are available.  */
 299   enum dom_state x_dom_computed[2];
 300
 301   /* Number of basic blocks in the dominance tree.  */
 302   unsigned x_n_bbs_in_dom_tree[2];
 303
 304   /* Maximal number of entities in the single jumptable.  Used to estimate
 305      final flowgraph size.  */
 306   int max_jumptable_ents;
 307 };
 308
 309 /* Defines for accessing the fields of the CFG structure for function FN.  */
 310 #define ENTRY_BLOCK_PTR_FOR_FN(FN)           ((FN)->cfg->x_entry_block_ptr)
 311 #define EXIT_BLOCK_PTR_FOR_FN(FN)            ((FN)->cfg->x_exit_block_ptr)
 312 #define basic_block_info_for_fn(FN)          ((FN)->cfg->x_basic_block_info)
 313 #define n_basic_blocks_for_fn(FN)            ((FN)->cfg->x_n_basic_blocks)
 314 #define n_edges_for_fn(FN)                   ((FN)->cfg->x_n_edges)
 315 #define last_basic_block_for_fn(FN)          ((FN)->cfg->x_last_basic_block)
 316 #define label_to_block_map_for_fn(FN)        ((FN)->cfg->x_label_to_block_map)
 317 #define profile_status_for_fn(FN)            ((FN)->cfg->x_profile_status)
 318
 319 #define BASIC_BLOCK_FOR_FN(FN,N) \
 320   ((*basic_block_info_for_fn (FN))[(N)])
 321 #define SET_BASIC_BLOCK_FOR_FN(FN,N,BB) \
 322   ((*basic_block_info_for_fn (FN))[(N)] = (BB))
 323
 324 /* For iterating over basic blocks.  */
 325 #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \
 326   for (BB = FROM; BB != TO; BB = BB->DIR)
 327
 328 #define FOR_EACH_BB_FN(BB, FN) \
 329   FOR_BB_BETWEEN (BB, (FN)->cfg->x_entry_block_ptr->next_bb, (FN)->cfg->x_exit_block_ptr, next_bb)
 330
 331 #define FOR_EACH_BB_REVERSE_FN(BB, FN) \
 332   FOR_BB_BETWEEN (BB, (FN)->cfg->x_exit_block_ptr->prev_bb, (FN)->cfg->x_entry_block_ptr, prev_bb)
 333
 334 /* For iterating over insns in basic block.  */
 335 #define FOR_BB_INSNS(BB, INSN)                  \
 336   for ((INSN) = BB_HEAD (BB);                   \
 337        (INSN) && (INSN) != NEXT_INSN (BB_END (BB));     \
 338        (INSN) = NEXT_INSN (INSN))
 339
 340 /* For iterating over insns in basic block when we might remove the
 341    current insn.  */
 342 #define FOR_BB_INSNS_SAFE(BB, INSN, CURR)                       \
 343   for ((INSN) = BB_HEAD (BB), (CURR) = (INSN) ? NEXT_INSN ((INSN)): NULL;       \
 344        (INSN) && (INSN) != NEXT_INSN (BB_END (BB));     \
 345        (INSN) = (CURR), (CURR) = (INSN) ? NEXT_INSN ((INSN)) : NULL)
 346
 347 #define FOR_BB_INSNS_REVERSE(BB, INSN)          \
 348   for ((INSN) = BB_END (BB);                    \
 349        (INSN) && (INSN) != PREV_INSN (BB_HEAD (BB));    \
 350        (INSN) = PREV_INSN (INSN))
 351
 352 #define FOR_BB_INSNS_REVERSE_SAFE(BB, INSN, CURR)       \
 353   for ((INSN) = BB_END (BB),(CURR) = (INSN) ? PREV_INSN ((INSN)) : NULL;        \
 354        (INSN) && (INSN) != PREV_INSN (BB_HEAD (BB));    \
 355        (INSN) = (CURR), (CURR) = (INSN) ? PREV_INSN ((INSN)) : NULL)
 356
 357 /* Cycles through _all_ basic blocks, even the fake ones (entry and
 358    exit block).  */
 359
 360 #define FOR_ALL_BB_FN(BB, FN) \
 361   for (BB = ENTRY_BLOCK_PTR_FOR_FN (FN); BB; BB = BB->next_bb)
 362
 363 \f
 364 /* Stuff for recording basic block info.  */
 365
 366 #define BB_HEAD(B)      (B)->il.x.head_
 367 #define BB_END(B)       (B)->il.x.rtl->end_
 368 #define BB_HEADER(B)    (B)->il.x.rtl->header_
 369 #define BB_FOOTER(B)    (B)->il.x.rtl->footer_
 370
 371 /* Special block numbers [markers] for entry and exit.
 372    Neither of them is supposed to hold actual statements.  */
 373 #define ENTRY_BLOCK (0)
 374 #define EXIT_BLOCK (1)
 375
 376 /* The two blocks that are always in the cfg.  */
 377 #define NUM_FIXED_BLOCKS (2)
 378
 379 #define set_block_for_insn(INSN, BB)  (BLOCK_FOR_INSN (INSN) = BB)
 380
 381 extern void compute_bb_for_insn (void);
 382 extern unsigned int free_bb_for_insn (void);
 383 extern void update_bb_for_insn (basic_block);
 384
 385 extern void insert_insn_on_edge (rtx, edge);
 386 basic_block split_edge_and_insert (edge, rtx);
 387
 388 extern void commit_one_edge_insertion (edge e);
 389 extern void commit_edge_insertions (void);
 390
 391 extern edge unchecked_make_edge (basic_block, basic_block, int);
 392 extern edge cached_make_edge (sbitmap, basic_block, basic_block, int);
 393 extern edge make_edge (basic_block, basic_block, int);
 394 extern edge make_single_succ_edge (basic_block, basic_block, int);
 395 extern void remove_edge_raw (edge);
 396 extern void redirect_edge_succ (edge, basic_block);
 397 extern edge redirect_edge_succ_nodup (edge, basic_block);
 398 extern void redirect_edge_pred (edge, basic_block);
 399 extern basic_block create_basic_block_structure (rtx, rtx, rtx, basic_block);
 400 extern void clear_bb_flags (void);
 401 extern void dump_bb_info (FILE *, basic_block, int, int, bool, bool);
 402 extern void dump_edge_info (FILE *, edge, int, int);
 403 extern void debug (edge_def &ref);
 404 extern void debug (edge_def *ptr);
 405 extern void brief_dump_cfg (FILE *, int);
 406 extern void clear_edges (void);
 407 extern void scale_bbs_frequencies_int (basic_block *, int, int, int);
 408 extern void scale_bbs_frequencies_gcov_type (basic_block *, int, gcov_type,
 409                                              gcov_type);
 410
 411 /* Structure to group all of the information to process IF-THEN and
 412    IF-THEN-ELSE blocks for the conditional execution support.  This
 413    needs to be in a public file in case the IFCVT macros call
 414    functions passing the ce_if_block data structure.  */
 415
 416 struct ce_if_block
 417 {
 418   basic_block test_bb;                  /* First test block.  */
 419   basic_block then_bb;                  /* THEN block.  */
 420   basic_block else_bb;                  /* ELSE block or NULL.  */
 421   basic_block join_bb;                  /* Join THEN/ELSE blocks.  */
 422   basic_block last_test_bb;             /* Last bb to hold && or || tests.  */
 423   int num_multiple_test_blocks;         /* # of && and || basic blocks.  */
 424   int num_and_and_blocks;               /* # of && blocks.  */
 425   int num_or_or_blocks;                 /* # of || blocks.  */
 426   int num_multiple_test_insns;          /* # of insns in && and || blocks.  */
 427   int and_and_p;                        /* Complex test is &&.  */
 428   int num_then_insns;                   /* # of insns in THEN block.  */
 429   int num_else_insns;                   /* # of insns in ELSE block.  */
 430   int pass;                             /* Pass number.  */
 431 };
 432
 433 /* This structure maintains an edge list vector.  */
 434 /* FIXME: Make this a vec<edge>.  */
 435 struct edge_list
 436 {
 437   int num_edges;
 438   edge *index_to_edge;
 439 };
 440
 441 /* Class to compute and manage control dependences on an edge-list.  */
 442 class control_dependences
 443 {
 444 public:
 445   control_dependences (edge_list *);
 446   ~control_dependences ();
 447   bitmap get_edges_dependent_on (int);
 448   edge get_edge (int);
 449
 450 private:
 451   void set_control_dependence_map_bit (basic_block, int);
 452   void clear_control_dependence_bitmap (basic_block);
 453   void find_control_dependence (int);
 454   vec<bitmap> control_dependence_map;
 455   edge_list *m_el;
 456 };
 457
 458 /* The base value for branch probability notes and edge probabilities.  */
 459 #define REG_BR_PROB_BASE  10000
 460
 461 /* This is the value which indicates no edge is present.  */
 462 #define EDGE_INDEX_NO_EDGE      -1
 463
 464 /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE
 465    if there is no edge between the 2 basic blocks.  */
 466 #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ)))
 467
 468 /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic
 469    block which is either the pred or succ end of the indexed edge.  */
 470 #define INDEX_EDGE_PRED_BB(el, index)   ((el)->index_to_edge[(index)]->src)
 471 #define INDEX_EDGE_SUCC_BB(el, index)   ((el)->index_to_edge[(index)]->dest)
 472
 473 /* INDEX_EDGE returns a pointer to the edge.  */
 474 #define INDEX_EDGE(el, index)           ((el)->index_to_edge[(index)])
 475
 476 /* Number of edges in the compressed edge list.  */
 477 #define NUM_EDGES(el)                   ((el)->num_edges)
 478
 479 /* BB is assumed to contain conditional jump.  Return the fallthru edge.  */
 480 #define FALLTHRU_EDGE(bb)               (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
 481                                          ? EDGE_SUCC ((bb), 0) : EDGE_SUCC ((bb), 1))
 482
 483 /* BB is assumed to contain conditional jump.  Return the branch edge.  */
 484 #define BRANCH_EDGE(bb)                 (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \
 485                                          ? EDGE_SUCC ((bb), 1) : EDGE_SUCC ((bb), 0))
 486
 487 #define RDIV(X,Y) (((X) + (Y) / 2) / (Y))
 488 /* Return expected execution frequency of the edge E.  */
 489 #define EDGE_FREQUENCY(e)               RDIV ((e)->src->frequency * (e)->probability, \
 490                                               REG_BR_PROB_BASE)
 491
 492 /* Compute a scale factor (or probability) suitable for scaling of
 493    gcov_type values via apply_probability() and apply_scale().  */
 494 #define GCOV_COMPUTE_SCALE(num,den) \
 495   ((den) ? RDIV ((num) * REG_BR_PROB_BASE, (den)) : REG_BR_PROB_BASE)
 496
 497 /* Return nonzero if edge is critical.  */
 498 #define EDGE_CRITICAL_P(e)              (EDGE_COUNT ((e)->src->succs) >= 2 \
 499                                          && EDGE_COUNT ((e)->dest->preds) >= 2)
 500
 501 #define EDGE_COUNT(ev)                  vec_safe_length (ev)
 502 #define EDGE_I(ev,i)                    (*ev)[(i)]
 503 #define EDGE_PRED(bb,i)                 (*(bb)->preds)[(i)]
 504 #define EDGE_SUCC(bb,i)                 (*(bb)->succs)[(i)]
 505
 506 /* Returns true if BB has precisely one successor.  */
 507
 508 static inline bool
 509 single_succ_p (const_basic_block bb)
 510 {
 511   return EDGE_COUNT (bb->succs) == 1;
 512 }
 513
 514 /* Returns true if BB has precisely one predecessor.  */
 515
 516 static inline bool
 517 single_pred_p (const_basic_block bb)
 518 {
 519   return EDGE_COUNT (bb->preds) == 1;
 520 }
 521
 522 /* Returns the single successor edge of basic block BB.  Aborts if
 523    BB does not have exactly one successor.  */
 524
 525 static inline edge
 526 single_succ_edge (const_basic_block bb)
 527 {
 528   gcc_checking_assert (single_succ_p (bb));
 529   return EDGE_SUCC (bb, 0);
 530 }
 531
 532 /* Returns the single predecessor edge of basic block BB.  Aborts
 533    if BB does not have exactly one predecessor.  */
 534
 535 static inline edge
 536 single_pred_edge (const_basic_block bb)
 537 {
 538   gcc_checking_assert (single_pred_p (bb));
 539   return EDGE_PRED (bb, 0);
 540 }
 541
 542 /* Returns the single successor block of basic block BB.  Aborts
 543    if BB does not have exactly one successor.  */
 544
 545 static inline basic_block
 546 single_succ (const_basic_block bb)
 547 {
 548   return single_succ_edge (bb)->dest;
 549 }
 550
 551 /* Returns the single predecessor block of basic block BB.  Aborts
 552    if BB does not have exactly one predecessor.*/
 553
 554 static inline basic_block
 555 single_pred (const_basic_block bb)
 556 {
 557   return single_pred_edge (bb)->src;
 558 }
 559
 560 /* Iterator object for edges.  */
 561
 562 struct edge_iterator {
 563   unsigned index;
 564   vec<edge, va_gc> **container;
 565 };
 566
 567 static inline vec<edge, va_gc> *
 568 ei_container (edge_iterator i)
 569 {
 570   gcc_checking_assert (i.container);
 571   return *i.container;
 572 }
 573
 574 #define ei_start(iter) ei_start_1 (&(iter))
 575 #define ei_last(iter) ei_last_1 (&(iter))
 576
 577 /* Return an iterator pointing to the start of an edge vector.  */
 578 static inline edge_iterator
 579 ei_start_1 (vec<edge, va_gc> **ev)
 580 {
 581   edge_iterator i;
 582
 583   i.index = 0;
 584   i.container = ev;
 585
 586   return i;
 587 }
 588
 589 /* Return an iterator pointing to the last element of an edge
 590    vector.  */
 591 static inline edge_iterator
 592 ei_last_1 (vec<edge, va_gc> **ev)
 593 {
 594   edge_iterator i;
 595
 596   i.index = EDGE_COUNT (*ev) - 1;
 597   i.container = ev;
 598
 599   return i;
 600 }
 601
 602 /* Is the iterator `i' at the end of the sequence?  */
 603 static inline bool
 604 ei_end_p (edge_iterator i)
 605 {
 606   return (i.index == EDGE_COUNT (ei_container (i)));
 607 }
 608
 609 /* Is the iterator `i' at one position before the end of the
 610    sequence?  */
 611 static inline bool
 612 ei_one_before_end_p (edge_iterator i)
 613 {
 614   return (i.index + 1 == EDGE_COUNT (ei_container (i)));
 615 }
 616
 617 /* Advance the iterator to the next element.  */
 618 static inline void
 619 ei_next (edge_iterator *i)
 620 {
 621   gcc_checking_assert (i->index < EDGE_COUNT (ei_container (*i)));
 622   i->index++;
 623 }
 624
 625 /* Move the iterator to the previous element.  */
 626 static inline void
 627 ei_prev (edge_iterator *i)
 628 {
 629   gcc_checking_assert (i->index > 0);
 630   i->index--;
 631 }
 632
 633 /* Return the edge pointed to by the iterator `i'.  */
 634 static inline edge
 635 ei_edge (edge_iterator i)
 636 {
 637   return EDGE_I (ei_container (i), i.index);
 638 }
 639
 640 /* Return an edge pointed to by the iterator.  Do it safely so that
 641    NULL is returned when the iterator is pointing at the end of the
 642    sequence.  */
 643 static inline edge
 644 ei_safe_edge (edge_iterator i)
 645 {
 646   return !ei_end_p (i) ? ei_edge (i) : NULL;
 647 }
 648
 649 /* Return 1 if we should continue to iterate.  Return 0 otherwise.
 650    *Edge P is set to the next edge if we are to continue to iterate
 651    and NULL otherwise.  */
 652
 653 static inline bool
 654 ei_cond (edge_iterator ei, edge *p)
 655 {
 656   if (!ei_end_p (ei))
 657     {
 658       *p = ei_edge (ei);
 659       return 1;
 660     }
 661   else
 662     {
 663       *p = NULL;
 664       return 0;
 665     }
 666 }
 667
 668 /* This macro serves as a convenient way to iterate each edge in a
 669    vector of predecessor or successor edges.  It must not be used when
 670    an element might be removed during the traversal, otherwise
 671    elements will be missed.  Instead, use a for-loop like that shown
 672    in the following pseudo-code:
 673
 674    FOR (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
 675      {
 676         IF (e != taken_edge)
 677           remove_edge (e);
 678         ELSE
 679           ei_next (&ei);
 680      }
 681 */
 682
 683 #define FOR_EACH_EDGE(EDGE,ITER,EDGE_VEC)       \
 684   for ((ITER) = ei_start ((EDGE_VEC));          \
 685        ei_cond ((ITER), &(EDGE));               \
 686        ei_next (&(ITER)))
 687
 688 #define CLEANUP_EXPENSIVE       1       /* Do relatively expensive optimizations
 689                                            except for edge forwarding */
 690 #define CLEANUP_CROSSJUMP       2       /* Do crossjumping.  */
 691 #define CLEANUP_POST_REGSTACK   4       /* We run after reg-stack and need
 692                                            to care REG_DEAD notes.  */
 693 #define CLEANUP_THREADING       8       /* Do jump threading.  */
 694 #define CLEANUP_NO_INSN_DEL     16      /* Do not try to delete trivially dead
 695                                            insns.  */
 696 #define CLEANUP_CFGLAYOUT       32      /* Do cleanup in cfglayout mode.  */
 697 #define CLEANUP_CFG_CHANGED     64      /* The caller changed the CFG.  */
 698
 699 /* In cfganal.c */
 700 extern void bitmap_intersection_of_succs (sbitmap, sbitmap *, basic_block);
 701 extern void bitmap_intersection_of_preds (sbitmap, sbitmap *, basic_block);
 702 extern void bitmap_union_of_succs (sbitmap, sbitmap *, basic_block);
 703 extern void bitmap_union_of_preds (sbitmap, sbitmap *, basic_block);
 704
 705 /* In lcm.c */
 706 extern struct edge_list *pre_edge_lcm (int, sbitmap *, sbitmap *,
 707                                        sbitmap *, sbitmap *, sbitmap **,
 708                                        sbitmap **);
 709 extern struct edge_list *pre_edge_rev_lcm (int, sbitmap *,
 710                                            sbitmap *, sbitmap *,
 711                                            sbitmap *, sbitmap **,
 712                                            sbitmap **);
 713 extern void compute_available (sbitmap *, sbitmap *, sbitmap *, sbitmap *);
 714
 715 /* In predict.c */
 716 extern bool maybe_hot_count_p (struct function *, gcov_type);
 717 extern bool maybe_hot_bb_p (struct function *, const_basic_block);
 718 extern bool maybe_hot_edge_p (edge);
 719 extern bool probably_never_executed_bb_p (struct function *, const_basic_block);
 720 extern bool probably_never_executed_edge_p (struct function *, edge);
 721 extern bool optimize_bb_for_size_p (const_basic_block);
 722 extern bool optimize_bb_for_speed_p (const_basic_block);
 723 extern bool optimize_edge_for_size_p (edge);
 724 extern bool optimize_edge_for_speed_p (edge);
 725 extern bool optimize_loop_for_size_p (struct loop *);
 726 extern bool optimize_loop_for_speed_p (struct loop *);
 727 extern bool optimize_loop_nest_for_size_p (struct loop *);
 728 extern bool optimize_loop_nest_for_speed_p (struct loop *);
 729 extern bool gimple_predicted_by_p (const_basic_block, enum br_predictor);
 730 extern bool rtl_predicted_by_p (const_basic_block, enum br_predictor);
 731 extern void gimple_predict_edge (edge, enum br_predictor, int);
 732 extern void rtl_predict_edge (edge, enum br_predictor, int);
 733 extern void predict_edge_def (edge, enum br_predictor, enum prediction);
 734 extern void guess_outgoing_edge_probabilities (basic_block);
 735 extern void remove_predictions_associated_with_edge (edge);
 736 extern bool edge_probability_reliable_p (const_edge);
 737 extern bool br_prob_note_reliable_p (const_rtx);
 738 extern bool predictable_edge_p (edge);
 739
 740 /* In cfg.c  */
 741 extern void init_flow (struct function *);
 742 extern void debug_bb (basic_block);
 743 extern basic_block debug_bb_n (int);
 744 extern void dump_flow_info (FILE *, int);
 745 extern void expunge_block (basic_block);
 746 extern void link_block (basic_block, basic_block);
 747 extern void unlink_block (basic_block);
 748 extern void compact_blocks (void);
 749 extern basic_block alloc_block (void);
 750 extern void alloc_aux_for_blocks (int);
 751 extern void clear_aux_for_blocks (void);
 752 extern void free_aux_for_blocks (void);
 753 extern void alloc_aux_for_edge (edge, int);
 754 extern void alloc_aux_for_edges (int);
 755 extern void clear_aux_for_edges (void);
 756 extern void free_aux_for_edges (void);
 757
 758 /* In cfganal.c  */
 759 extern void find_unreachable_blocks (void);
 760 extern bool mark_dfs_back_edges (void);
 761 struct edge_list * create_edge_list (void);
 762 void free_edge_list (struct edge_list *);
 763 void print_edge_list (FILE *, struct edge_list *);
 764 void verify_edge_list (FILE *, struct edge_list *);
 765 int find_edge_index (struct edge_list *, basic_block, basic_block);
 766 edge find_edge (basic_block, basic_block);
 767 extern void remove_fake_edges (void);
 768 extern void remove_fake_exit_edges (void);
 769 extern void add_noreturn_fake_exit_edges (void);
 770 extern void connect_infinite_loops_to_exit (void);
 771 extern int post_order_compute (int *, bool, bool);
 772 extern basic_block dfs_find_deadend (basic_block);
 773 extern int inverted_post_order_compute (int *);
 774 extern int pre_and_rev_post_order_compute_fn (struct function *,
 775                                               int *, int *, bool);
 776 extern int pre_and_rev_post_order_compute (int *, int *, bool);
 777 extern int dfs_enumerate_from (basic_block, int,
 778                                bool (*)(const_basic_block, const void *),
 779                                basic_block *, int, const void *);
 780 extern void compute_dominance_frontiers (struct bitmap_head *);
 781 extern bitmap compute_idf (bitmap, struct bitmap_head *);
 782 extern basic_block * single_pred_before_succ_order (void);
 783
 784 /* In cfgrtl.c  */
 785 extern rtx block_label (basic_block);
 786 extern rtx bb_note (basic_block);
 787 extern bool purge_all_dead_edges (void);
 788 extern bool purge_dead_edges (basic_block);
 789 extern bool fixup_abnormal_edges (void);
 790 extern basic_block force_nonfallthru_and_redirect (edge, basic_block, rtx);
 791 extern bool contains_no_active_insn_p (const_basic_block);
 792 extern bool forwarder_block_p (const_basic_block);
 793 extern bool can_fallthru (basic_block, basic_block);
 794 extern void emit_barrier_after_bb (basic_block bb);
 795 extern void fixup_partitions (void);
 796
 797 /* In cfgbuild.c.  */
 798 extern void find_many_sub_basic_blocks (sbitmap);
 799 extern void rtl_make_eh_edge (sbitmap, basic_block, rtx);
 800
 801 enum replace_direction { dir_none, dir_forward, dir_backward, dir_both };
 802
 803 /* In cfgcleanup.c.  */
 804 extern bool cleanup_cfg (int);
 805 extern int flow_find_cross_jump (basic_block, basic_block, rtx *, rtx *,
 806                                  enum replace_direction*);
 807 extern int flow_find_head_matching_sequence (basic_block, basic_block,
 808                                              rtx *, rtx *, int);
 809
 810 extern bool delete_unreachable_blocks (void);
 811
 812 extern void update_br_prob_note (basic_block);
 813 extern bool inside_basic_block_p (const_rtx);
 814 extern bool control_flow_insn_p (const_rtx);
 815 extern rtx get_last_bb_insn (basic_block);
 816
 817 /* In dominance.c */
 818
 819 enum cdi_direction
 820 {
 821   CDI_DOMINATORS = 1,
 822   CDI_POST_DOMINATORS = 2
 823 };
 824
 825 extern enum dom_state dom_info_state (enum cdi_direction);
 826 extern void set_dom_info_availability (enum cdi_direction, enum dom_state);
 827 extern bool dom_info_available_p (enum cdi_direction);
 828 extern void calculate_dominance_info (enum cdi_direction);
 829 extern void free_dominance_info (enum cdi_direction);
 830 extern basic_block nearest_common_dominator (enum cdi_direction,
 831                                              basic_block, basic_block);
 832 extern basic_block nearest_common_dominator_for_set (enum cdi_direction,
 833                                                      bitmap);
 834 extern void set_immediate_dominator (enum cdi_direction, basic_block,
 835                                      basic_block);
 836 extern basic_block get_immediate_dominator (enum cdi_direction, basic_block);
 837 extern bool dominated_by_p (enum cdi_direction, const_basic_block, const_basic_block);
 838 extern vec<basic_block> get_dominated_by (enum cdi_direction, basic_block);
 839 extern vec<basic_block> get_dominated_by_region (enum cdi_direction,
 840                                                          basic_block *,
 841                                                          unsigned);
 842 extern vec<basic_block> get_dominated_to_depth (enum cdi_direction,
 843                                                         basic_block, int);
 844 extern vec<basic_block> get_all_dominated_blocks (enum cdi_direction,
 845                                                           basic_block);
 846 extern void add_to_dominance_info (enum cdi_direction, basic_block);
 847 extern void delete_from_dominance_info (enum cdi_direction, basic_block);
 848 basic_block recompute_dominator (enum cdi_direction, basic_block);
 849 extern void redirect_immediate_dominators (enum cdi_direction, basic_block,
 850                                            basic_block);
 851 extern void iterate_fix_dominators (enum cdi_direction,
 852                                     vec<basic_block> , bool);
 853 extern void verify_dominators (enum cdi_direction);
 854 extern basic_block first_dom_son (enum cdi_direction, basic_block);
 855 extern basic_block next_dom_son (enum cdi_direction, basic_block);
 856 unsigned bb_dom_dfs_in (enum cdi_direction, basic_block);
 857 unsigned bb_dom_dfs_out (enum cdi_direction, basic_block);
 858
 859 extern edge try_redirect_by_replacing_jump (edge, basic_block, bool);
 860 extern void break_superblocks (void);
 861 extern void relink_block_chain (bool);
 862 extern void update_bb_profile_for_threading (basic_block, int, gcov_type, edge);
 863 extern void init_rtl_bb_info (basic_block);
 864
 865 extern void initialize_original_copy_tables (void);
 866 extern void free_original_copy_tables (void);
 867 extern void set_bb_original (basic_block, basic_block);
 868 extern basic_block get_bb_original (basic_block);
 869 extern void set_bb_copy (basic_block, basic_block);
 870 extern basic_block get_bb_copy (basic_block);
 871 void set_loop_copy (struct loop *, struct loop *);
 872 struct loop *get_loop_copy (struct loop *);
 873
 874 #include "cfghooks.h"
 875
 876 /* Return true if BB is in a transaction.  */
 877
 878 static inline bool
 879 bb_in_transaction (basic_block bb)
 880 {
 881   return bb->flags & BB_IN_TRANSACTION;
 882 }
 883
 884 /* Return true when one of the predecessor edges of BB is marked with EDGE_EH.  */
 885 static inline bool
 886 bb_has_eh_pred (basic_block bb)
 887 {
 888   edge e;
 889   edge_iterator ei;
 890
 891   FOR_EACH_EDGE (e, ei, bb->preds)
 892     {
 893       if (e->flags & EDGE_EH)
 894         return true;
 895     }
 896   return false;
 897 }
 898
 899 /* Return true when one of the predecessor edges of BB is marked with EDGE_ABNORMAL.  */
 900 static inline bool
 901 bb_has_abnormal_pred (basic_block bb)
 902 {
 903   edge e;
 904   edge_iterator ei;
 905
 906   FOR_EACH_EDGE (e, ei, bb->preds)
 907     {
 908       if (e->flags & EDGE_ABNORMAL)
 909         return true;
 910     }
 911   return false;
 912 }
 913
 914 /* Return the fallthru edge in EDGES if it exists, NULL otherwise.  */
 915 static inline edge
 916 find_fallthru_edge (vec<edge, va_gc> *edges)
 917 {
 918   edge e;
 919   edge_iterator ei;
 920
 921   FOR_EACH_EDGE (e, ei, edges)
 922     if (e->flags & EDGE_FALLTHRU)
 923       break;
 924
 925   return e;
 926 }
 927
 928 /* In cfgloopmanip.c.  */
 929 extern edge mfb_kj_edge;
 930 extern bool mfb_keep_just (edge);
 931
 932 /* In cfgexpand.c.  */
 933 extern void rtl_profile_for_bb (basic_block);
 934 extern void rtl_profile_for_edge (edge);
 935 extern void default_rtl_profile (void);
 936
 937 /* In profile.c.  */
 938 typedef struct gcov_working_set_info gcov_working_set_t;
 939 extern gcov_working_set_t *find_working_set (unsigned pct_times_10);
 940 extern void add_working_set (gcov_working_set_t *);
 941
 942 /* Check tha probability is sane.  */
 943
 944 static inline void
 945 check_probability (int prob)
 946 {
 947   gcc_checking_assert (prob >= 0 && prob <= REG_BR_PROB_BASE);
 948 }
 949
 950 /* Given PROB1 and PROB2, return PROB1*PROB2/REG_BR_PROB_BASE.
 951    Used to combine BB probabilities.  */
 952
 953 static inline int
 954 combine_probabilities (int prob1, int prob2)
 955 {
 956   check_probability (prob1);
 957   check_probability (prob2);
 958   return RDIV (prob1 * prob2, REG_BR_PROB_BASE);
 959 }
 960
 961 /* Apply scale factor SCALE on frequency or count FREQ. Use this
 962    interface when potentially scaling up, so that SCALE is not
 963    constrained to be < REG_BR_PROB_BASE.  */
 964
 965 static inline gcov_type
 966 apply_scale (gcov_type freq, gcov_type scale)
 967 {
 968   return RDIV (freq * scale, REG_BR_PROB_BASE);
 969 }
 970
 971 /* Apply probability PROB on frequency or count FREQ.  */
 972
 973 static inline gcov_type
 974 apply_probability (gcov_type freq, int prob)
 975 {
 976   check_probability (prob);
 977   return apply_scale (freq, prob);
 978 }
 979
 980 /* Return inverse probability for PROB.  */
 981
 982 static inline int
 983 inverse_probability (int prob1)
 984 {
 985   check_probability (prob1);
 986   return REG_BR_PROB_BASE - prob1;
 987 }
 988
 989 /* Return true if BB has at least one abnormal outgoing edge.  */
 990
 991 static inline bool
 992 has_abnormal_or_eh_outgoing_edge_p (basic_block bb)
 993 {
 994   edge e;
 995   edge_iterator ei;
 996
 997   FOR_EACH_EDGE (e, ei, bb->succs)
 998     if (e->flags & (EDGE_ABNORMAL | EDGE_EH))
 999       return true;
1000
1001   return false;
1002 }
1003 #endif /* GCC_BASIC_BLOCK_H */