gcc/tree-flow.h

   1 /* Data and Control Flow Analysis for Trees.
   2    Copyright (C) 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
   3    Contributed by Diego Novillo <dnovillo@redhat.com>
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GCC is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License 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
  19 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
  20 Boston, MA 02110-1301, USA.  */
  21
  22 #ifndef _TREE_FLOW_H
  23 #define _TREE_FLOW_H 1
  24
  25 #include "bitmap.h"
  26 #include "hard-reg-set.h"
  27 #include "basic-block.h"
  28 #include "hashtab.h"
  29 #include "tree-gimple.h"
  30 #include "tree-ssa-operands.h"
  31 #include "cgraph.h"
  32 #include "ipa-reference.h"
  33
  34 /* Forward declare structures for the garbage collector GTY markers.  */
  35 #ifndef GCC_BASIC_BLOCK_H
  36 struct edge_def;
  37 typedef struct edge_def *edge;
  38 struct basic_block_def;
  39 typedef struct basic_block_def *basic_block;
  40 #endif
  41 struct static_var_ann_d;
  42
  43 /* Gimple dataflow datastructure. All publicly available fields shall have
  44    gimple_ accessor defined in tree-flow-inline.h, all publicly modifiable
  45    fields should have gimple_set accessor.  */
  46 struct gimple_df GTY(()) {
  47   /* Array of all variables referenced in the function.  */
  48   htab_t GTY((param_is (struct int_tree_map))) referenced_vars;
  49
  50   /* A list of all the noreturn calls passed to modify_stmt.
  51      cleanup_control_flow uses it to detect cases where a mid-block
  52      indirect call has been turned into a noreturn call.  When this
  53      happens, all the instructions after the call are no longer
  54      reachable and must be deleted as dead.  */
  55   VEC(tree,gc) *modified_noreturn_calls;
  56
  57   /* Array of all SSA_NAMEs used in the function.  */
  58   VEC(tree,gc) *ssa_names;
  59
  60   /* Artificial variable used to model the effects of function calls.  */
  61   tree global_var;
  62
  63   /* Artificial variable used to model the effects of nonlocal
  64      variables.  */
  65   tree nonlocal_all;
  66
  67   /* Call clobbered variables in the function.  If bit I is set, then
  68      REFERENCED_VARS (I) is call-clobbered.  */
  69   bitmap call_clobbered_vars;
  70
  71   /* Addressable variables in the function.  If bit I is set, then
  72      REFERENCED_VARS (I) has had its address taken.  Note that
  73      CALL_CLOBBERED_VARS and ADDRESSABLE_VARS are not related.  An
  74      addressable variable is not necessarily call-clobbered (e.g., a
  75      local addressable whose address does not escape) and not all
  76      call-clobbered variables are addressable (e.g., a local static
  77      variable).  */
  78   bitmap addressable_vars;
  79
  80   /* Free list of SSA_NAMEs.  */
  81   tree free_ssanames;
  82
  83   /* Hashtable holding definition for symbol.  If this field is not NULL, it
  84      means that the first reference to this variable in the function is a
  85      USE or a VUSE.  In those cases, the SSA renamer creates an SSA name
  86      for this variable with an empty defining statement.  */
  87   htab_t GTY((param_is (struct int_tree_map))) default_defs;
  88
  89   /* 'true' after aliases have been computed (see compute_may_aliases).  */
  90   unsigned int aliases_computed_p : 1;
  91
  92   /* True if the code is in ssa form.  */
  93   unsigned int in_ssa_p : 1;
  94
  95   struct ssa_operands ssa_operands;
  96
  97   /* Hashtable of variables annotations.  Used for static variables only;
  98      local variables have direct pointer in the tree node.  */
  99   htab_t GTY((param_is (struct static_var_ann_d))) var_anns;
 100 };
 101
 102 /* Accessors for internal use only.  Generic code should use abstraction
 103    provided by tree-flow-inline.h or specific modules.  */
 104 #define FREE_SSANAMES(fun) (fun)->gimple_df->free_ssanames
 105 #define SSANAMES(fun) (fun)->gimple_df->ssa_names
 106 #define MODIFIED_NORETURN_CALLS(fun) (fun)->gimple_df->modified_noreturn_calls
 107 #define DEFAULT_DEFS(fun) (fun)->gimple_df->default_defs
 108
 109 typedef struct
 110 {
 111   htab_t htab;
 112   PTR *slot;
 113   PTR *limit;
 114 } htab_iterator;
 115
 116 /* Iterate through the elements of hashtable HTAB, using htab_iterator ITER,
 117    storing each element in RESULT, which is of type TYPE.  */
 118 #define FOR_EACH_HTAB_ELEMENT(HTAB, RESULT, TYPE, ITER) \
 119   for (RESULT = (TYPE) first_htab_element (&(ITER), (HTAB)); \
 120         !end_htab_p (&(ITER)); \
 121         RESULT = (TYPE) next_htab_element (&(ITER)))
 122
 123 /*---------------------------------------------------------------------------
 124                       Attributes for SSA_NAMEs.
 125
 126   NOTE: These structures are stored in struct tree_ssa_name
 127   but are only used by the tree optimizers, so it makes better sense
 128   to declare them here to avoid recompiling unrelated files when
 129   making changes.
 130 ---------------------------------------------------------------------------*/
 131
 132 /* Aliasing information for SSA_NAMEs representing pointer variables.  */
 133 struct ptr_info_def GTY(())
 134 {
 135   /* Nonzero if points-to analysis couldn't determine where this pointer
 136      is pointing to.  */
 137   unsigned int pt_anything : 1;
 138
 139   /* Nonzero if the value of this pointer escapes the current function.  */
 140   unsigned int value_escapes_p : 1;
 141
 142   /* Nonzero if this pointer is dereferenced.  */
 143   unsigned int is_dereferenced : 1;
 144
 145   /* Nonzero if this pointer points to a global variable.  */
 146   unsigned int pt_global_mem : 1;
 147
 148   /* Nonzero if this pointer points to NULL.  */
 149   unsigned int pt_null : 1;
 150
 151   /* Set of variables that this pointer may point to.  */
 152   bitmap pt_vars;
 153
 154   /* If this pointer has been dereferenced, and points-to information is
 155      more precise than type-based aliasing, indirect references to this
 156      pointer will be represented by this memory tag, instead of the type
 157      tag computed by TBAA.  */
 158   tree name_mem_tag;
 159
 160   /* Mask of reasons this pointer's value escapes the function  */
 161   unsigned int escape_mask;
 162 };
 163
 164
 165 /*---------------------------------------------------------------------------
 166                    Tree annotations stored in tree_base.ann
 167 ---------------------------------------------------------------------------*/
 168 enum tree_ann_type { TREE_ANN_COMMON, VAR_ANN, FUNCTION_ANN, STMT_ANN };
 169
 170 struct tree_ann_common_d GTY(())
 171 {
 172   /* Annotation type.  */
 173   enum tree_ann_type type;
 174
 175  /* Auxiliary info specific to a pass.  At all times, this
 176     should either point to valid data or be NULL.  */
 177   PTR GTY ((skip (""))) aux;
 178
 179   /* The value handle for this expression.  Used by GVN-PRE.  */
 180   tree GTY((skip)) value_handle;
 181 };
 182
 183 /* It is advantageous to avoid things like life analysis for variables which
 184    do not need PHI nodes.  This enum describes whether or not a particular
 185    variable may need a PHI node.  */
 186
 187 enum need_phi_state {
 188   /* This is the default.  If we are still in this state after finding
 189      all the definition and use sites, then we will assume the variable
 190      needs PHI nodes.  This is probably an overly conservative assumption.  */
 191   NEED_PHI_STATE_UNKNOWN,
 192
 193   /* This state indicates that we have seen one or more sets of the
 194      variable in a single basic block and that the sets dominate all
 195      uses seen so far.  If after finding all definition and use sites
 196      we are still in this state, then the variable does not need any
 197      PHI nodes.  */
 198   NEED_PHI_STATE_NO,
 199
 200   /* This state indicates that we have either seen multiple definitions of
 201      the variable in multiple blocks, or that we encountered a use in a
 202      block that was not dominated by the block containing the set(s) of
 203      this variable.  This variable is assumed to need PHI nodes.  */
 204   NEED_PHI_STATE_MAYBE
 205 };
 206
 207 struct subvar;
 208 typedef struct subvar *subvar_t;
 209
 210 /* This structure represents a fake sub-variable for a structure field.  */
 211 struct subvar GTY(())
 212 {
 213   /* Fake variable.  */
 214   tree var;
 215
 216   /* Next subvar for this structure.  */
 217   subvar_t next;
 218 };
 219
 220 struct var_ann_d GTY(())
 221 {
 222   struct tree_ann_common_d common;
 223
 224   /* Used by the out of SSA pass to determine whether this variable has
 225      been seen yet or not.  */
 226   unsigned out_of_ssa_tag : 1;
 227
 228   /* Used when building base variable structures in a var_map.  */
 229   unsigned base_var_processed : 1;
 230
 231   /* Nonzero if this variable is in the alias set of another variable.  */
 232   unsigned is_aliased : 1;
 233
 234   /* Nonzero if this variable was used after SSA optimizations were
 235      applied.  We set this when translating out of SSA form.  */
 236   unsigned used : 1;
 237
 238   /* This field indicates whether or not the variable may need PHI nodes.
 239      See the enum's definition for more detailed information about the
 240      states.  */
 241   ENUM_BITFIELD (need_phi_state) need_phi_state : 2;
 242
 243   /* Used during operand processing to determine if this variable is already
 244      in the VUSE list.  */
 245   unsigned in_vuse_list : 1;
 246
 247   /* Used during operand processing to determine if this variable is already
 248      in the VDEF list.  */
 249   unsigned in_vdef_list : 1;
 250
 251   /* True for HEAP and PARM_NOALIAS artificial variables.  */
 252   unsigned is_heapvar : 1;
 253
 254   /* Memory partition tag assigned to this symbol.  */
 255   tree mpt;
 256
 257   /* If this variable is a pointer P that has been dereferenced, this
 258      field is an artificial variable that represents the memory
 259      location *P.  Every other pointer Q that is type-compatible with
 260      P will also have the same memory tag.  If the variable is not a
 261      pointer or if it is never dereferenced, this must be NULL.
 262      FIXME, do we really need this here?  How much slower would it be
 263      to convert to hash table?  */
 264   tree symbol_mem_tag;
 265
 266   /* Variables that may alias this variable.  This may only be set on
 267      memory tags (NAME_MEMORY_TAG or TYPE_MEMORY_TAG).  FIXME, move to
 268      struct tree_memory_tag.  */
 269   VEC(tree, gc) *may_aliases;
 270
 271   /* Used when going out of SSA form to indicate which partition this
 272      variable represents storage for.  */
 273   unsigned partition;
 274
 275   /* Used by var_map for the base index of ssa base variables.  */
 276   unsigned base_index;
 277
 278   /* During into-ssa and the dominator optimizer, this field holds the
 279      current version of this variable (an SSA_NAME).  */
 280   tree current_def;
 281
 282   /* If this variable is a structure, this fields holds a list of
 283      symbols representing each of the fields of the structure.  */
 284   subvar_t subvars;
 285
 286   /* Mask of values saying the reasons why this variable has escaped
 287      the function.  */
 288   unsigned int escape_mask;
 289 };
 290
 291 /* Contianer for variable annotation used by hashtable for annotations for
 292    static variables.  */
 293 struct static_var_ann_d GTY(())
 294 {
 295   struct var_ann_d ann;
 296   unsigned int uid;
 297 };
 298
 299 struct function_ann_d GTY(())
 300 {
 301   struct tree_ann_common_d common;
 302
 303   /* Pointer to the structure that contains the sets of global
 304      variables modified by function calls.  This field is only used
 305      for FUNCTION_DECLs.  */
 306   ipa_reference_vars_info_t GTY ((skip)) reference_vars_info;
 307 };
 308
 309 typedef struct immediate_use_iterator_d
 310 {
 311   /* This is the current use the iterator is processing.  */
 312   ssa_use_operand_t *imm_use;
 313   /* This marks the last use in the list (use node from SSA_NAME)  */
 314   ssa_use_operand_t *end_p;
 315   /* This node is inserted and used to mark the end of the uses for a stmt.  */
 316   ssa_use_operand_t iter_node;
 317   /* This is the next ssa_name to visit.  IMM_USE may get removed before
 318      the next one is traversed to, so it must be cached early.  */
 319   ssa_use_operand_t *next_imm_name;
 320 } imm_use_iterator;
 321
 322
 323 /* Use this iterator when simply looking at stmts.  Adding, deleting or
 324    modifying stmts will cause this iterator to malfunction.  */
 325
 326 #define FOR_EACH_IMM_USE_FAST(DEST, ITER, SSAVAR)                       \
 327   for ((DEST) = first_readonly_imm_use (&(ITER), (SSAVAR));     \
 328        !end_readonly_imm_use_p (&(ITER));                       \
 329        (DEST) = next_readonly_imm_use (&(ITER)))
 330
 331 /* Use this iterator to visit each stmt which has a use of SSAVAR.  */
 332
 333 #define FOR_EACH_IMM_USE_STMT(STMT, ITER, SSAVAR)               \
 334   for ((STMT) = first_imm_use_stmt (&(ITER), (SSAVAR));         \
 335        !end_imm_use_stmt_p (&(ITER));                           \
 336        (STMT) = next_imm_use_stmt (&(ITER)))
 337
 338 /* Use this to terminate the FOR_EACH_IMM_USE_STMT loop early.  Failure to
 339    do so will result in leaving a iterator marker node in the immediate
 340    use list, and nothing good will come from that.   */
 341 #define BREAK_FROM_IMM_USE_STMT(ITER)                           \
 342    {                                                            \
 343      end_imm_use_stmt_traverse (&(ITER));                       \
 344      break;                                                     \
 345    }
 346
 347
 348 /* Use this iterator in combination with FOR_EACH_IMM_USE_STMT to
 349    get access to each occurrence of ssavar on the stmt returned by
 350    that iterator..  for instance:
 351
 352      FOR_EACH_IMM_USE_STMT (stmt, iter, var)
 353        {
 354          FOR_EACH_IMM_USE_ON_STMT (use_p, iter)
 355            {
 356              SET_USE (use_p) = blah;
 357            }
 358          update_stmt (stmt);
 359        }                                                         */
 360
 361 #define FOR_EACH_IMM_USE_ON_STMT(DEST, ITER)                    \
 362   for ((DEST) = first_imm_use_on_stmt (&(ITER));                \
 363        !end_imm_use_on_stmt_p (&(ITER));                        \
 364        (DEST) = next_imm_use_on_stmt (&(ITER)))
 365
 366
 367
 368 struct stmt_ann_d GTY(())
 369 {
 370   struct tree_ann_common_d common;
 371
 372   /* Basic block that contains this statement.  */
 373   basic_block bb;
 374
 375   /* Operand cache for stmt.  */
 376   struct stmt_operands_d GTY ((skip (""))) operands;
 377
 378   /* Set of variables that have had their address taken in the statement.  */
 379   bitmap addresses_taken;
 380
 381   /* Nonzero if the statement references memory (at least one of its
 382      expressions contains a non-register operand).  */
 383   unsigned references_memory : 1;
 384
 385   /* Unique identifier for this statement.  These ID's are to be created
 386      by each pass on an as-needed basis in any order convenient for the
 387      pass which needs statement UIDs.  */
 388   unsigned int uid;
 389
 390   /* Nonzero if the statement has been modified (meaning that the operands
 391      need to be scanned again).  */
 392   unsigned modified : 1;
 393
 394   /* Nonzero if the statement makes references to volatile storage.  */
 395   unsigned has_volatile_ops : 1;
 396
 397   /* Nonzero if the statement makes a function call that may clobber global
 398      and local addressable variables.  */
 399   unsigned makes_clobbering_call : 1;
 400 };
 401
 402 union tree_ann_d GTY((desc ("ann_type ((tree_ann_t)&%h)")))
 403 {
 404   struct tree_ann_common_d GTY((tag ("TREE_ANN_COMMON"))) common;
 405   struct var_ann_d GTY((tag ("VAR_ANN"))) vdecl;
 406   struct function_ann_d GTY((tag ("FUNCTION_ANN"))) fdecl;
 407   struct stmt_ann_d GTY((tag ("STMT_ANN"))) stmt;
 408 };
 409
 410 typedef union tree_ann_d *tree_ann_t;
 411 typedef struct var_ann_d *var_ann_t;
 412 typedef struct function_ann_d *function_ann_t;
 413 typedef struct stmt_ann_d *stmt_ann_t;
 414 typedef struct tree_ann_common_d *tree_ann_common_t;
 415
 416 static inline tree_ann_common_t tree_common_ann (tree);
 417 static inline tree_ann_common_t get_tree_common_ann (tree);
 418 static inline var_ann_t var_ann (tree);
 419 static inline var_ann_t get_var_ann (tree);
 420 static inline function_ann_t function_ann (tree);
 421 static inline function_ann_t get_function_ann (tree);
 422 static inline stmt_ann_t stmt_ann (tree);
 423 static inline bool has_stmt_ann (tree);
 424 static inline stmt_ann_t get_stmt_ann (tree);
 425 static inline enum tree_ann_type ann_type (tree_ann_t);
 426 static inline basic_block bb_for_stmt (tree);
 427 extern void set_bb_for_stmt (tree, basic_block);
 428 static inline bool noreturn_call_p (tree);
 429 static inline void update_stmt (tree);
 430 static inline bool stmt_modified_p (tree);
 431 static inline VEC(tree, gc) *may_aliases (tree);
 432 static inline int get_lineno (tree);
 433 static inline const char *get_filename (tree);
 434 static inline bool is_exec_stmt (tree);
 435 static inline bool is_label_stmt (tree);
 436 static inline bitmap addresses_taken (tree);
 437
 438 /*---------------------------------------------------------------------------
 439                   Structure representing predictions in tree level.
 440 ---------------------------------------------------------------------------*/
 441 struct edge_prediction GTY((chain_next ("%h.ep_next")))
 442 {
 443   struct edge_prediction *ep_next;
 444   edge ep_edge;
 445   enum br_predictor ep_predictor;
 446   int ep_probability;
 447 };
 448
 449 /* Accessors for basic block annotations.  */
 450 static inline tree phi_nodes (basic_block);
 451 static inline void set_phi_nodes (basic_block, tree);
 452
 453 /*---------------------------------------------------------------------------
 454                               Global declarations
 455 ---------------------------------------------------------------------------*/
 456 struct int_tree_map GTY(())
 457 {
 458
 459   unsigned int uid;
 460   tree to;
 461 };
 462
 463 extern unsigned int int_tree_map_hash (const void *);
 464 extern int int_tree_map_eq (const void *, const void *);
 465
 466 typedef struct
 467 {
 468   htab_iterator hti;
 469 } referenced_var_iterator;
 470
 471
 472 /* This macro loops over all the referenced vars, one at a time, putting the
 473    current var in VAR.  Note:  You are not allowed to add referenced variables
 474    to the hashtable while using this macro.  Doing so may cause it to behave
 475    erratically.  */
 476
 477 #define FOR_EACH_REFERENCED_VAR(VAR, ITER) \
 478   for ((VAR) = first_referenced_var (&(ITER)); \
 479        !end_referenced_vars_p (&(ITER)); \
 480        (VAR) = next_referenced_var (&(ITER)))
 481
 482
 483 typedef struct
 484 {
 485   int i;
 486 } safe_referenced_var_iterator;
 487
 488 /* This macro loops over all the referenced vars, one at a time, putting the
 489    current var in VAR.  You are allowed to add referenced variables during the
 490    execution of this macro, however, the macro will not iterate over them.  It
 491    requires a temporary vector of trees, VEC, whose lifetime is controlled by
 492    the caller.  The purpose of the vector is to temporarily store the
 493    referenced_variables hashtable so that adding referenced variables does not
 494    affect the hashtable.  */
 495
 496 #define FOR_EACH_REFERENCED_VAR_SAFE(VAR, VEC, ITER) \
 497   for ((ITER).i = 0, fill_referenced_var_vec (&(VEC)); \
 498        VEC_iterate (tree, (VEC), (ITER).i, (VAR)); \
 499        (ITER).i++)
 500
 501 extern tree referenced_var_lookup (unsigned int);
 502 extern bool referenced_var_check_and_insert (tree);
 503 #define num_referenced_vars htab_elements (gimple_referenced_vars (cfun))
 504 #define referenced_var(i) referenced_var_lookup (i)
 505
 506 #define num_ssa_names (VEC_length (tree, cfun->gimple_df->ssa_names))
 507 #define ssa_name(i) (VEC_index (tree, cfun->gimple_df->ssa_names, (i)))
 508
 509 /* Macros for showing usage statistics.  */
 510 #define SCALE(x) ((unsigned long) ((x) < 1024*10        \
 511                   ? (x)                                 \
 512                   : ((x) < 1024*1024*10                 \
 513                      ? (x) / 1024                       \
 514                      : (x) / (1024*1024))))
 515
 516 #define LABEL(x) ((x) < 1024*10 ? 'b' : ((x) < 1024*1024*10 ? 'k' : 'M'))
 517
 518 #define PERCENT(x,y) ((float)(x) * 100.0 / (float)(y))
 519
 520 /*---------------------------------------------------------------------------
 521                               Block iterators
 522 ---------------------------------------------------------------------------*/
 523
 524 typedef struct {
 525   tree_stmt_iterator tsi;
 526   basic_block bb;
 527 } block_stmt_iterator;
 528
 529 static inline block_stmt_iterator bsi_start (basic_block);
 530 static inline block_stmt_iterator bsi_last (basic_block);
 531 static inline block_stmt_iterator bsi_after_labels (basic_block);
 532 block_stmt_iterator bsi_for_stmt (tree);
 533 static inline bool bsi_end_p (block_stmt_iterator);
 534 static inline void bsi_next (block_stmt_iterator *);
 535 static inline void bsi_prev (block_stmt_iterator *);
 536 static inline tree bsi_stmt (block_stmt_iterator);
 537 static inline tree * bsi_stmt_ptr (block_stmt_iterator);
 538
 539 extern void bsi_remove (block_stmt_iterator *, bool);
 540 extern void bsi_move_before (block_stmt_iterator *, block_stmt_iterator *);
 541 extern void bsi_move_after (block_stmt_iterator *, block_stmt_iterator *);
 542 extern void bsi_move_to_bb_end (block_stmt_iterator *, basic_block);
 543
 544 enum bsi_iterator_update
 545 {
 546   /* Note that these are intentionally in the same order as TSI_FOO.  They
 547      mean exactly the same as their TSI_* counterparts.  */
 548   BSI_NEW_STMT,
 549   BSI_SAME_STMT,
 550   BSI_CHAIN_START,
 551   BSI_CHAIN_END,
 552   BSI_CONTINUE_LINKING
 553 };
 554
 555 extern void bsi_insert_before (block_stmt_iterator *, tree,
 556                                enum bsi_iterator_update);
 557 extern void bsi_insert_after (block_stmt_iterator *, tree,
 558                               enum bsi_iterator_update);
 559
 560 extern void bsi_replace (const block_stmt_iterator *, tree, bool);
 561
 562 /*---------------------------------------------------------------------------
 563                               OpenMP Region Tree
 564 ---------------------------------------------------------------------------*/
 565
 566 /* Parallel region information.  Every parallel and workshare
 567    directive is enclosed between two markers, the OMP_* directive
 568    and a corresponding OMP_RETURN statement.  */
 569
 570 struct omp_region
 571 {
 572   /* The enclosing region.  */
 573   struct omp_region *outer;
 574
 575   /* First child region.  */
 576   struct omp_region *inner;
 577
 578   /* Next peer region.  */
 579   struct omp_region *next;
 580
 581   /* Block containing the omp directive as its last stmt.  */
 582   basic_block entry;
 583
 584   /* Block containing the OMP_RETURN as its last stmt.  */
 585   basic_block exit;
 586
 587   /* Block containing the OMP_CONTINUE as its last stmt.  */
 588   basic_block cont;
 589
 590   /* If this is a combined parallel+workshare region, this is a list
 591      of additional arguments needed by the combined parallel+workshare
 592      library call.  */
 593   tree ws_args;
 594
 595   /* The code for the omp directive of this region.  */
 596   enum tree_code type;
 597
 598   /* Schedule kind, only used for OMP_FOR type regions.  */
 599   enum omp_clause_schedule_kind sched_kind;
 600
 601   /* True if this is a combined parallel+workshare region.  */
 602   bool is_combined_parallel;
 603 };
 604
 605 extern struct omp_region *root_omp_region;
 606 extern struct omp_region *new_omp_region (basic_block, enum tree_code,
 607                                           struct omp_region *);
 608 extern void free_omp_regions (void);
 609
 610 /*---------------------------------------------------------------------------
 611                               Function prototypes
 612 ---------------------------------------------------------------------------*/
 613 /* In tree-cfg.c  */
 614
 615 /* Location to track pending stmt for edge insertion.  */
 616 #define PENDING_STMT(e) ((e)->insns.t)
 617
 618 extern void delete_tree_cfg_annotations (void);
 619 extern void disband_implicit_edges (void);
 620 extern bool stmt_ends_bb_p (tree);
 621 extern bool is_ctrl_stmt (tree);
 622 extern bool is_ctrl_altering_stmt (tree);
 623 extern bool computed_goto_p (tree);
 624 extern bool simple_goto_p (tree);
 625 extern bool tree_can_make_abnormal_goto (tree);
 626 extern basic_block single_noncomplex_succ (basic_block bb);
 627 extern void tree_dump_bb (basic_block, FILE *, int);
 628 extern void debug_tree_bb (basic_block);
 629 extern basic_block debug_tree_bb_n (int);
 630 extern void dump_tree_cfg (FILE *, int);
 631 extern void debug_tree_cfg (int);
 632 extern void dump_cfg_stats (FILE *);
 633 extern void debug_cfg_stats (void);
 634 extern void debug_loop_ir (void);
 635 extern void print_loop_ir (FILE *);
 636 extern void cleanup_dead_labels (void);
 637 extern void group_case_labels (void);
 638 extern tree first_stmt (basic_block);
 639 extern tree last_stmt (basic_block);
 640 extern tree *last_stmt_ptr (basic_block);
 641 extern tree last_and_only_stmt (basic_block);
 642 extern edge find_taken_edge (basic_block, tree);
 643 extern basic_block label_to_block_fn (struct function *, tree);
 644 #define label_to_block(t) (label_to_block_fn (cfun, t))
 645 extern void bsi_insert_on_edge (edge, tree);
 646 extern basic_block bsi_insert_on_edge_immediate (edge, tree);
 647 extern void bsi_commit_one_edge_insert (edge, basic_block *);
 648 extern void bsi_commit_edge_inserts (void);
 649 extern void notice_special_calls (tree);
 650 extern void clear_special_calls (void);
 651 extern void verify_stmts (void);
 652 extern tree tree_block_label (basic_block);
 653 extern void extract_true_false_edges_from_block (basic_block, edge *, edge *);
 654 extern bool tree_duplicate_sese_region (edge, edge, basic_block *, unsigned,
 655                                         basic_block *);
 656 extern void add_phi_args_after_copy_bb (basic_block);
 657 extern void add_phi_args_after_copy (basic_block *, unsigned);
 658 extern bool tree_purge_dead_abnormal_call_edges (basic_block);
 659 extern bool tree_purge_dead_eh_edges (basic_block);
 660 extern bool tree_purge_all_dead_eh_edges (bitmap);
 661 extern tree gimplify_val (block_stmt_iterator *, tree, tree);
 662 extern tree gimplify_build1 (block_stmt_iterator *, enum tree_code,
 663                              tree, tree);
 664 extern tree gimplify_build2 (block_stmt_iterator *, enum tree_code,
 665                              tree, tree, tree);
 666 extern tree gimplify_build3 (block_stmt_iterator *, enum tree_code,
 667                              tree, tree, tree, tree);
 668 extern void init_empty_tree_cfg (void);
 669 extern void fold_cond_expr_cond (void);
 670 extern void make_abnormal_goto_edges (basic_block, bool);
 671 extern void replace_uses_by (tree, tree);
 672 extern void start_recording_case_labels (void);
 673 extern void end_recording_case_labels (void);
 674 extern basic_block move_sese_region_to_fn (struct function *, basic_block,
 675                                            basic_block);
 676
 677 /* In tree-cfgcleanup.c  */
 678 extern bool cleanup_tree_cfg (void);
 679 extern void cleanup_tree_cfg_loop (void);
 680
 681 /* In tree-pretty-print.c.  */
 682 extern void dump_generic_bb (FILE *, basic_block, int, int);
 683
 684 /* In tree-dfa.c  */
 685 extern var_ann_t create_var_ann (tree);
 686 extern function_ann_t create_function_ann (tree);
 687 extern stmt_ann_t create_stmt_ann (tree);
 688 extern tree_ann_common_t create_tree_common_ann (tree);
 689 extern void dump_dfa_stats (FILE *);
 690 extern void debug_dfa_stats (void);
 691 extern void debug_referenced_vars (void);
 692 extern void dump_referenced_vars (FILE *);
 693 extern void dump_variable (FILE *, tree);
 694 extern void debug_variable (tree);
 695 extern void dump_subvars_for (FILE *, tree);
 696 extern void debug_subvars_for (tree);
 697 extern tree get_virtual_var (tree);
 698 extern void add_referenced_var (tree);
 699 extern void mark_symbols_for_renaming (tree);
 700 extern void find_new_referenced_vars (tree *);
 701
 702 extern tree make_rename_temp (tree, const char *);
 703 extern void set_default_def (tree, tree);
 704 extern tree gimple_default_def (struct function *, tree);
 705
 706 /* In tree-phinodes.c  */
 707 extern void reserve_phi_args_for_new_edge (basic_block);
 708 extern tree create_phi_node (tree, basic_block);
 709 extern void add_phi_arg (tree, tree, edge);
 710 extern void remove_phi_args (edge);
 711 extern void remove_phi_node (tree, tree, bool);
 712 extern tree phi_reverse (tree);
 713
 714 /* In gimple-low.c  */
 715 extern void record_vars_into (tree, tree);
 716 extern void record_vars (tree);
 717 extern bool block_may_fallthru (tree);
 718
 719 /* In tree-ssa-alias.c  */
 720 extern void dump_may_aliases_for (FILE *, tree);
 721 extern void debug_may_aliases_for (tree);
 722 extern void dump_alias_info (FILE *);
 723 extern void debug_alias_info (void);
 724 extern void dump_points_to_info (FILE *);
 725 extern void debug_points_to_info (void);
 726 extern void dump_points_to_info_for (FILE *, tree);
 727 extern void debug_points_to_info_for (tree);
 728 extern bool may_be_aliased (tree);
 729 extern bool is_aliased_with (tree, tree);
 730 extern struct ptr_info_def *get_ptr_info (tree);
 731 extern void new_type_alias (tree, tree, tree);
 732 extern void count_uses_and_derefs (tree, tree, unsigned *, unsigned *, bool *);
 733 static inline subvar_t get_subvars_for_var (tree);
 734 static inline tree get_subvar_at (tree, unsigned HOST_WIDE_INT);
 735 static inline bool ref_contains_array_ref (tree);
 736 static inline bool array_ref_contains_indirect_ref (tree);
 737 extern tree get_ref_base_and_extent (tree, HOST_WIDE_INT *,
 738                                      HOST_WIDE_INT *, HOST_WIDE_INT *);
 739 static inline bool var_can_have_subvars (tree);
 740 static inline bool overlap_subvar (unsigned HOST_WIDE_INT,
 741                                    unsigned HOST_WIDE_INT,
 742                                    tree, bool *);
 743 extern tree create_tag_raw (enum tree_code, tree, const char *);
 744
 745 /* Call-back function for walk_use_def_chains().  At each reaching
 746    definition, a function with this prototype is called.  */
 747 typedef bool (*walk_use_def_chains_fn) (tree, tree, void *);
 748
 749
 750 /* In tree-ssa.c  */
 751 extern void init_tree_ssa (void);
 752 extern edge ssa_redirect_edge (edge, basic_block);
 753 extern void flush_pending_stmts (edge);
 754 extern bool tree_ssa_useless_type_conversion (tree);
 755 extern bool tree_ssa_useless_type_conversion_1 (tree, tree);
 756 extern void verify_ssa (bool);
 757 extern void delete_tree_ssa (void);
 758 extern void walk_use_def_chains (tree, walk_use_def_chains_fn, void *, bool);
 759 extern bool stmt_references_memory_p (tree);
 760
 761 /* In tree-into-ssa.c  */
 762 void update_ssa (unsigned);
 763 void delete_update_ssa (void);
 764 void register_new_name_mapping (tree, tree);
 765 tree create_new_def_for (tree, tree, def_operand_p);
 766 bool need_ssa_update_p (void);
 767 bool name_mappings_registered_p (void);
 768 bool name_registered_for_update_p (tree);
 769 bitmap ssa_names_to_replace (void);
 770 void release_ssa_name_after_update_ssa (tree);
 771 void compute_global_livein (bitmap, bitmap);
 772 tree duplicate_ssa_name (tree, tree);
 773 void mark_sym_for_renaming (tree);
 774 void mark_set_for_renaming (bitmap);
 775 tree get_current_def (tree);
 776 void set_current_def (tree, tree);
 777
 778 /* In tree-ssa-ccp.c  */
 779 bool fold_stmt (tree *);
 780 bool fold_stmt_inplace (tree);
 781 tree widen_bitfield (tree, tree, tree);
 782
 783 /* In tree-vrp.c  */
 784 tree vrp_evaluate_conditional (tree, bool);
 785 void simplify_stmt_using_ranges (tree);
 786
 787 /* In tree-ssa-dom.c  */
 788 extern void dump_dominator_optimization_stats (FILE *);
 789 extern void debug_dominator_optimization_stats (void);
 790 int loop_depth_of_name (tree);
 791
 792 /* In tree-ssa-copy.c  */
 793 extern void merge_alias_info (tree, tree);
 794 extern void propagate_value (use_operand_p, tree);
 795 extern void propagate_tree_value (tree *, tree);
 796 extern void replace_exp (use_operand_p, tree);
 797 extern bool may_propagate_copy (tree, tree);
 798 extern bool may_propagate_copy_into_asm (tree);
 799
 800 /* Affine iv.  */
 801
 802 typedef struct
 803 {
 804   /* Iv = BASE + STEP * i.  */
 805   tree base, step;
 806
 807   /* True if this iv does not overflow.  */
 808   bool no_overflow;
 809 } affine_iv;
 810
 811 /* Description of number of iterations of a loop.  All the expressions inside
 812    the structure can be evaluated at the end of the loop's preheader
 813    (and due to ssa form, also anywhere inside the body of the loop).  */
 814
 815 struct tree_niter_desc
 816 {
 817   tree assumptions;     /* The boolean expression.  If this expression evaluates
 818                            to false, then the other fields in this structure
 819                            should not be used; there is no guarantee that they
 820                            will be correct.  */
 821   tree may_be_zero;     /* The boolean expression.  If it evaluates to true,
 822                            the loop will exit in the first iteration (i.e.
 823                            its latch will not be executed), even if the niter
 824                            field says otherwise.  */
 825   tree niter;           /* The expression giving the number of iterations of
 826                            a loop (provided that assumptions == true and
 827                            may_be_zero == false), more precisely the number
 828                            of executions of the latch of the loop.  */
 829   tree additional_info; /* The boolean expression.  Sometimes we use additional
 830                            knowledge to simplify the other expressions
 831                            contained in this structure (for example the
 832                            knowledge about value ranges of operands on entry to
 833                            the loop).  If this is a case, conjunction of such
 834                            condition is stored in this field, so that we do not
 835                            lose the information: for example if may_be_zero
 836                            is (n <= 0) and niter is (unsigned) n, we know
 837                            that the number of iterations is at most
 838                            MAX_SIGNED_INT.  However if the (n <= 0) assumption
 839                            is eliminated (by looking at the guard on entry of
 840                            the loop), then the information would be lost.  */
 841
 842   /* The simplified shape of the exit condition.  The loop exits if
 843      CONTROL CMP BOUND is false, where CMP is one of NE_EXPR,
 844      LT_EXPR, or GT_EXPR, and step of CONTROL is positive if CMP is
 845      LE_EXPR and negative if CMP is GE_EXPR.  This information is used
 846      by loop unrolling.  */
 847   affine_iv control;
 848   tree bound;
 849   enum tree_code cmp;
 850 };
 851
 852 /* In tree-vectorizer.c */
 853 unsigned vectorize_loops (void);
 854 extern bool vect_can_force_dr_alignment_p (tree, unsigned int);
 855 extern tree get_vectype_for_scalar_type (tree);
 856
 857 /* In tree-ssa-phiopt.c */
 858 bool empty_block_p (basic_block);
 859
 860 /* In tree-ssa-loop*.c  */
 861
 862 void tree_ssa_lim (void);
 863 unsigned int tree_ssa_unswitch_loops (void);
 864 unsigned int canonicalize_induction_variables (void);
 865 unsigned int tree_unroll_loops_completely (bool);
 866 unsigned int tree_ssa_prefetch_arrays (void);
 867 unsigned int remove_empty_loops (void);
 868 void tree_ssa_iv_optimize (void);
 869
 870 bool number_of_iterations_exit (struct loop *, edge,
 871                                 struct tree_niter_desc *niter, bool);
 872 tree find_loop_niter (struct loop *, edge *);
 873 tree loop_niter_by_eval (struct loop *, edge);
 874 tree find_loop_niter_by_eval (struct loop *, edge *);
 875 void estimate_numbers_of_iterations (void);
 876 bool scev_probably_wraps_p (tree, tree, tree, struct loop *, bool);
 877 bool convert_affine_scev (struct loop *, tree, tree *, tree *, tree, bool);
 878
 879 bool nowrap_type_p (tree);
 880 enum ev_direction {EV_DIR_GROWS, EV_DIR_DECREASES, EV_DIR_UNKNOWN};
 881 enum ev_direction scev_direction (tree);
 882
 883 void free_numbers_of_iterations_estimates (void);
 884 void free_numbers_of_iterations_estimates_loop (struct loop *);
 885 void rewrite_into_loop_closed_ssa (bitmap, unsigned);
 886 void verify_loop_closed_ssa (void);
 887 bool for_each_index (tree *, bool (*) (tree, tree *, void *), void *);
 888 void create_iv (tree, tree, tree, struct loop *, block_stmt_iterator *, bool,
 889                 tree *, tree *);
 890 void split_loop_exit_edge (edge);
 891 unsigned force_expr_to_var_cost (tree);
 892 void standard_iv_increment_position (struct loop *, block_stmt_iterator *,
 893                                      bool *);
 894 basic_block ip_end_pos (struct loop *);
 895 basic_block ip_normal_pos (struct loop *);
 896 bool tree_duplicate_loop_to_header_edge (struct loop *, edge,
 897                                          unsigned int, sbitmap,
 898                                          edge, VEC (edge, heap) **,
 899                                          int);
 900 struct loop *tree_ssa_loop_version (struct loop *, tree,
 901                                     basic_block *);
 902 tree expand_simple_operations (tree);
 903 void substitute_in_loop_info (struct loop *, tree, tree);
 904 edge single_dom_exit (struct loop *);
 905 bool can_unroll_loop_p (struct loop *loop, unsigned factor,
 906                         struct tree_niter_desc *niter);
 907 void tree_unroll_loop (struct loop *, unsigned,
 908                        edge, struct tree_niter_desc *);
 909 bool contains_abnormal_ssa_name_p (tree);
 910
 911 /* In tree-ssa-threadedge.c */
 912 extern bool potentially_threadable_block (basic_block);
 913 extern void thread_across_edge (tree, edge, bool,
 914                                 VEC(tree, heap) **, tree (*) (tree));
 915
 916 /* In tree-ssa-loop-im.c  */
 917 /* The possibilities of statement movement.  */
 918
 919 enum move_pos
 920   {
 921     MOVE_IMPOSSIBLE,            /* No movement -- side effect expression.  */
 922     MOVE_PRESERVE_EXECUTION,    /* Must not cause the non-executed statement
 923                                    become executed -- memory accesses, ... */
 924     MOVE_POSSIBLE               /* Unlimited movement.  */
 925   };
 926 extern enum move_pos movement_possibility (tree);
 927
 928 /* The reasons a variable may escape a function.  */
 929 enum escape_type
 930 {
 931   NO_ESCAPE = 0,                        /* Doesn't escape.  */
 932   ESCAPE_STORED_IN_GLOBAL = 1 << 1,
 933   ESCAPE_TO_ASM = 1 << 2,               /* Passed by address to an assembly
 934                                            statement.  */
 935   ESCAPE_TO_CALL = 1 << 3,              /* Escapes to a function call.  */
 936   ESCAPE_BAD_CAST = 1 << 4,             /* Cast from pointer to integer */
 937   ESCAPE_TO_RETURN = 1 << 5,            /* Returned from function.  */
 938   ESCAPE_TO_PURE_CONST = 1 << 6,        /* Escapes to a pure or constant
 939                                            function call.  */
 940   ESCAPE_IS_GLOBAL = 1 << 7,            /* Is a global variable.  */
 941   ESCAPE_IS_PARM = 1 << 8,              /* Is an incoming function argument.  */
 942   ESCAPE_UNKNOWN = 1 << 9               /* We believe it escapes for
 943                                            some reason not enumerated
 944                                            above.  */
 945 };
 946
 947 /* In tree-flow-inline.h  */
 948 static inline bool is_call_clobbered (tree);
 949 static inline void mark_call_clobbered (tree, unsigned int);
 950 static inline void set_is_used (tree);
 951 static inline bool unmodifiable_var_p (tree);
 952
 953 /* In tree-eh.c  */
 954 extern void make_eh_edges (tree);
 955 extern bool tree_could_trap_p (tree);
 956 extern bool tree_could_throw_p (tree);
 957 extern bool tree_can_throw_internal (tree);
 958 extern bool tree_can_throw_external (tree);
 959 extern int lookup_stmt_eh_region (tree);
 960 extern void add_stmt_to_eh_region (tree, int);
 961 extern bool remove_stmt_from_eh_region (tree);
 962 extern bool maybe_clean_or_replace_eh_stmt (tree, tree);
 963
 964 /* In tree-ssa-pre.c  */
 965 void add_to_value (tree, tree);
 966 void debug_value_expressions (tree);
 967 void print_value_expressions (FILE *, tree);
 968
 969
 970 /* In tree-vn.c  */
 971 bool expressions_equal_p (tree, tree);
 972 static inline tree get_value_handle (tree);
 973 hashval_t vn_compute (tree, hashval_t);
 974 void sort_vuses (VEC (tree, gc) *);
 975 tree vn_lookup_or_add (tree, tree);
 976 tree vn_lookup_or_add_with_vuses (tree, VEC (tree, gc) *);
 977 void vn_add (tree, tree);
 978 void vn_add_with_vuses (tree, tree, VEC (tree, gc) *);
 979 tree vn_lookup (tree, tree);
 980 tree vn_lookup_with_vuses (tree, VEC (tree, gc) *);
 981 void vn_init (void);
 982 void vn_delete (void);
 983
 984 /* In tree-ssa-sink.c  */
 985 bool is_hidden_global_store (tree);
 986
 987 /* In tree-sra.c  */
 988 void insert_edge_copies (tree, basic_block);
 989 void sra_insert_before (block_stmt_iterator *, tree);
 990 void sra_insert_after (block_stmt_iterator *, tree);
 991 void sra_init_cache (void);
 992 bool sra_type_can_be_decomposed_p (tree);
 993
 994 /* In tree-loop-linear.c  */
 995 extern void linear_transform_loops (void);
 996
 997 /* In tree-ssa-loop-ivopts.c  */
 998 bool expr_invariant_in_loop_p (struct loop *, tree);
 999 bool multiplier_allowed_in_address_p (HOST_WIDE_INT, enum machine_mode);
1000 unsigned multiply_by_cost (HOST_WIDE_INT, enum machine_mode);
1001
1002 /* In tree-ssa-threadupdate.c.  */
1003 extern bool thread_through_all_blocks (void);
1004 extern void register_jump_thread (edge, edge);
1005
1006 /* In gimplify.c  */
1007 tree force_gimple_operand (tree, tree *, bool, tree);
1008 tree force_gimple_operand_bsi (block_stmt_iterator *, tree, bool, tree);
1009
1010 /* In tree-ssa-structalias.c */
1011 bool find_what_p_points_to (tree);
1012
1013 /* In tree-ssa-live.c */
1014 extern void remove_unused_locals (void);
1015
1016 /* In tree-ssa-address.c  */
1017
1018 /* Description of a memory address.  */
1019
1020 struct mem_address
1021 {
1022   tree symbol, base, index, step, offset;
1023 };
1024
1025 struct affine_tree_combination;
1026 tree create_mem_ref (block_stmt_iterator *, tree,
1027                      struct affine_tree_combination *);
1028 rtx addr_for_mem_ref (struct mem_address *, bool);
1029 void get_address_description (tree, struct mem_address *);
1030 tree maybe_fold_tmr (tree);
1031
1032 /* This structure is simply used during pushing fields onto the fieldstack
1033    to track the offset of the field, since bitpos_of_field gives it relative
1034    to its immediate containing type, and we want it relative to the ultimate
1035    containing object.  */
1036
1037 struct fieldoff
1038 {
1039   tree type;
1040   tree size;
1041   tree decl;
1042   HOST_WIDE_INT offset;
1043 };
1044 typedef struct fieldoff fieldoff_s;
1045
1046 DEF_VEC_O(fieldoff_s);
1047 DEF_VEC_ALLOC_O(fieldoff_s,heap);
1048 int push_fields_onto_fieldstack (tree, VEC(fieldoff_s,heap) **,
1049                                  HOST_WIDE_INT, bool *);
1050 void sort_fieldstack (VEC(fieldoff_s,heap) *);
1051
1052 void init_alias_heapvars (void);
1053 void delete_alias_heapvars (void);
1054
1055 #include "tree-flow-inline.h"
1056
1057 void swap_tree_operands (tree, tree *, tree *);
1058
1059 int least_common_multiple (int, int);
1060
1061 #endif /* _TREE_FLOW_H  */