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   /* True if the variable is call clobbered.  */
 255   unsigned int call_clobbered : 1;
 256
 257   /* Memory partition tag assigned to this symbol.  */
 258   tree mpt;
 259
 260   /* If this variable is a pointer P that has been dereferenced, this
 261      field is an artificial variable that represents the memory
 262      location *P.  Every other pointer Q that is type-compatible with
 263      P will also have the same memory tag.  If the variable is not a
 264      pointer or if it is never dereferenced, this must be NULL.
 265      FIXME, do we really need this here?  How much slower would it be
 266      to convert to hash table?  */
 267   tree symbol_mem_tag;
 268
 269   /* Used when going out of SSA form to indicate which partition this
 270      variable represents storage for.  */
 271   unsigned partition;
 272
 273   /* Used by var_map for the base index of ssa base variables.  */
 274   unsigned base_index;
 275
 276   /* During into-ssa and the dominator optimizer, this field holds the
 277      current version of this variable (an SSA_NAME).  */
 278   tree current_def;
 279
 280   /* If this variable is a structure, this fields holds a list of
 281      symbols representing each of the fields of the structure.  */
 282   subvar_t subvars;
 283
 284   /* Mask of values saying the reasons why this variable has escaped
 285      the function.  */
 286   unsigned int escape_mask;
 287 };
 288
 289 /* Container for variable annotation used by hashtable for annotations for
 290    static variables.  */
 291 struct static_var_ann_d GTY(())
 292 {
 293   struct var_ann_d ann;
 294   unsigned int uid;
 295 };
 296
 297 struct function_ann_d GTY(())
 298 {
 299   struct tree_ann_common_d common;
 300
 301   /* Pointer to the structure that contains the sets of global
 302      variables modified by function calls.  This field is only used
 303      for FUNCTION_DECLs.  */
 304   ipa_reference_vars_info_t GTY ((skip)) reference_vars_info;
 305 };
 306
 307 typedef struct immediate_use_iterator_d
 308 {
 309   /* This is the current use the iterator is processing.  */
 310   ssa_use_operand_t *imm_use;
 311   /* This marks the last use in the list (use node from SSA_NAME)  */
 312   ssa_use_operand_t *end_p;
 313   /* This node is inserted and used to mark the end of the uses for a stmt.  */
 314   ssa_use_operand_t iter_node;
 315   /* This is the next ssa_name to visit.  IMM_USE may get removed before
 316      the next one is traversed to, so it must be cached early.  */
 317   ssa_use_operand_t *next_imm_name;
 318 } imm_use_iterator;
 319
 320
 321 /* Use this iterator when simply looking at stmts.  Adding, deleting or
 322    modifying stmts will cause this iterator to malfunction.  */
 323
 324 #define FOR_EACH_IMM_USE_FAST(DEST, ITER, SSAVAR)                       \
 325   for ((DEST) = first_readonly_imm_use (&(ITER), (SSAVAR));     \
 326        !end_readonly_imm_use_p (&(ITER));                       \
 327        (DEST) = next_readonly_imm_use (&(ITER)))
 328
 329 /* Use this iterator to visit each stmt which has a use of SSAVAR.  */
 330
 331 #define FOR_EACH_IMM_USE_STMT(STMT, ITER, SSAVAR)               \
 332   for ((STMT) = first_imm_use_stmt (&(ITER), (SSAVAR));         \
 333        !end_imm_use_stmt_p (&(ITER));                           \
 334        (STMT) = next_imm_use_stmt (&(ITER)))
 335
 336 /* Use this to terminate the FOR_EACH_IMM_USE_STMT loop early.  Failure to
 337    do so will result in leaving a iterator marker node in the immediate
 338    use list, and nothing good will come from that.   */
 339 #define BREAK_FROM_IMM_USE_STMT(ITER)                           \
 340    {                                                            \
 341      end_imm_use_stmt_traverse (&(ITER));                       \
 342      break;                                                     \
 343    }
 344
 345
 346 /* Use this iterator in combination with FOR_EACH_IMM_USE_STMT to
 347    get access to each occurrence of ssavar on the stmt returned by
 348    that iterator..  for instance:
 349
 350      FOR_EACH_IMM_USE_STMT (stmt, iter, var)
 351        {
 352          FOR_EACH_IMM_USE_ON_STMT (use_p, iter)
 353            {
 354              SET_USE (use_p) = blah;
 355            }
 356          update_stmt (stmt);
 357        }                                                         */
 358
 359 #define FOR_EACH_IMM_USE_ON_STMT(DEST, ITER)                    \
 360   for ((DEST) = first_imm_use_on_stmt (&(ITER));                \
 361        !end_imm_use_on_stmt_p (&(ITER));                        \
 362        (DEST) = next_imm_use_on_stmt (&(ITER)))
 363
 364
 365
 366 struct stmt_ann_d GTY(())
 367 {
 368   struct tree_ann_common_d common;
 369
 370   /* Basic block that contains this statement.  */
 371   basic_block bb;
 372
 373   /* Operand cache for stmt.  */
 374   struct stmt_operands_d GTY ((skip (""))) operands;
 375
 376   /* Set of variables that have had their address taken in the statement.  */
 377   bitmap addresses_taken;
 378
 379   /* Unique identifier for this statement.  These ID's are to be created
 380      by each pass on an as-needed basis in any order convenient for the
 381      pass which needs statement UIDs.  */
 382   unsigned int uid;
 383
 384   /* Nonzero if the statement references memory (at least one of its
 385      expressions contains a non-register operand).  */
 386   unsigned references_memory : 1;
 387
 388   /* Nonzero if the statement has been modified (meaning that the operands
 389      need to be scanned again).  */
 390   unsigned modified : 1;
 391
 392   /* Nonzero if the statement makes references to volatile storage.  */
 393   unsigned has_volatile_ops : 1;
 394
 395   /* Nonzero if the statement makes a function call that may clobber global
 396      and local addressable variables.  */
 397   unsigned makes_clobbering_call : 1;
 398 };
 399
 400 union tree_ann_d GTY((desc ("ann_type ((tree_ann_t)&%h)")))
 401 {
 402   struct tree_ann_common_d GTY((tag ("TREE_ANN_COMMON"))) common;
 403   struct var_ann_d GTY((tag ("VAR_ANN"))) vdecl;
 404   struct function_ann_d GTY((tag ("FUNCTION_ANN"))) fdecl;
 405   struct stmt_ann_d GTY((tag ("STMT_ANN"))) stmt;
 406 };
 407
 408 typedef union tree_ann_d *tree_ann_t;
 409 typedef struct var_ann_d *var_ann_t;
 410 typedef struct function_ann_d *function_ann_t;
 411 typedef struct stmt_ann_d *stmt_ann_t;
 412 typedef struct tree_ann_common_d *tree_ann_common_t;
 413
 414 static inline tree_ann_common_t tree_common_ann (tree);
 415 static inline tree_ann_common_t get_tree_common_ann (tree);
 416 static inline var_ann_t var_ann (tree);
 417 static inline var_ann_t get_var_ann (tree);
 418 static inline function_ann_t function_ann (tree);
 419 static inline function_ann_t get_function_ann (tree);
 420 static inline stmt_ann_t stmt_ann (tree);
 421 static inline bool has_stmt_ann (tree);
 422 static inline stmt_ann_t get_stmt_ann (tree);
 423 static inline enum tree_ann_type ann_type (tree_ann_t);
 424 static inline basic_block bb_for_stmt (tree);
 425 extern void set_bb_for_stmt (tree, basic_block);
 426 static inline bool noreturn_call_p (tree);
 427 static inline void update_stmt (tree);
 428 static inline bool stmt_modified_p (tree);
 429 static inline bitmap may_aliases (tree);
 430 static inline int get_lineno (tree);
 431 static inline const char *get_filename (tree);
 432 static inline bool is_exec_stmt (tree);
 433 static inline bool is_label_stmt (tree);
 434 static inline bitmap addresses_taken (tree);
 435
 436 /*---------------------------------------------------------------------------
 437                   Structure representing predictions in tree level.
 438 ---------------------------------------------------------------------------*/
 439 struct edge_prediction GTY((chain_next ("%h.ep_next")))
 440 {
 441   struct edge_prediction *ep_next;
 442   edge ep_edge;
 443   enum br_predictor ep_predictor;
 444   int ep_probability;
 445 };
 446
 447 /* Accessors for basic block annotations.  */
 448 static inline tree phi_nodes (basic_block);
 449 static inline void set_phi_nodes (basic_block, tree);
 450
 451 /*---------------------------------------------------------------------------
 452                               Global declarations
 453 ---------------------------------------------------------------------------*/
 454 struct int_tree_map GTY(())
 455 {
 456
 457   unsigned int uid;
 458   tree to;
 459 };
 460
 461 extern unsigned int int_tree_map_hash (const void *);
 462 extern int int_tree_map_eq (const void *, const void *);
 463
 464 typedef struct
 465 {
 466   htab_iterator hti;
 467 } referenced_var_iterator;
 468
 469
 470 /* This macro loops over all the referenced vars, one at a time, putting the
 471    current var in VAR.  Note:  You are not allowed to add referenced variables
 472    to the hashtable while using this macro.  Doing so may cause it to behave
 473    erratically.  */
 474
 475 #define FOR_EACH_REFERENCED_VAR(VAR, ITER) \
 476   for ((VAR) = first_referenced_var (&(ITER)); \
 477        !end_referenced_vars_p (&(ITER)); \
 478        (VAR) = next_referenced_var (&(ITER)))
 479
 480
 481 typedef struct
 482 {
 483   int i;
 484 } safe_referenced_var_iterator;
 485
 486 /* This macro loops over all the referenced vars, one at a time, putting the
 487    current var in VAR.  You are allowed to add referenced variables during the
 488    execution of this macro, however, the macro will not iterate over them.  It
 489    requires a temporary vector of trees, VEC, whose lifetime is controlled by
 490    the caller.  The purpose of the vector is to temporarily store the
 491    referenced_variables hashtable so that adding referenced variables does not
 492    affect the hashtable.  */
 493
 494 #define FOR_EACH_REFERENCED_VAR_SAFE(VAR, VEC, ITER) \
 495   for ((ITER).i = 0, fill_referenced_var_vec (&(VEC)); \
 496        VEC_iterate (tree, (VEC), (ITER).i, (VAR)); \
 497        (ITER).i++)
 498
 499 extern tree referenced_var_lookup (unsigned int);
 500 extern bool referenced_var_check_and_insert (tree);
 501 #define num_referenced_vars htab_elements (gimple_referenced_vars (cfun))
 502 #define referenced_var(i) referenced_var_lookup (i)
 503
 504 #define num_ssa_names (VEC_length (tree, cfun->gimple_df->ssa_names))
 505 #define ssa_name(i) (VEC_index (tree, cfun->gimple_df->ssa_names, (i)))
 506
 507 /* Macros for showing usage statistics.  */
 508 #define SCALE(x) ((unsigned long) ((x) < 1024*10        \
 509                   ? (x)                                 \
 510                   : ((x) < 1024*1024*10                 \
 511                      ? (x) / 1024                       \
 512                      : (x) / (1024*1024))))
 513
 514 #define LABEL(x) ((x) < 1024*10 ? 'b' : ((x) < 1024*1024*10 ? 'k' : 'M'))
 515
 516 #define PERCENT(x,y) ((float)(x) * 100.0 / (float)(y))
 517
 518 /*---------------------------------------------------------------------------
 519                               Block iterators
 520 ---------------------------------------------------------------------------*/
 521
 522 typedef struct {
 523   tree_stmt_iterator tsi;
 524   basic_block bb;
 525 } block_stmt_iterator;
 526
 527 static inline block_stmt_iterator bsi_start (basic_block);
 528 static inline block_stmt_iterator bsi_last (basic_block);
 529 static inline block_stmt_iterator bsi_after_labels (basic_block);
 530 block_stmt_iterator bsi_for_stmt (tree);
 531 static inline bool bsi_end_p (block_stmt_iterator);
 532 static inline void bsi_next (block_stmt_iterator *);
 533 static inline void bsi_prev (block_stmt_iterator *);
 534 static inline tree bsi_stmt (block_stmt_iterator);
 535 static inline tree * bsi_stmt_ptr (block_stmt_iterator);
 536
 537 extern void bsi_remove (block_stmt_iterator *, bool);
 538 extern void bsi_move_before (block_stmt_iterator *, block_stmt_iterator *);
 539 extern void bsi_move_after (block_stmt_iterator *, block_stmt_iterator *);
 540 extern void bsi_move_to_bb_end (block_stmt_iterator *, basic_block);
 541
 542 enum bsi_iterator_update
 543 {
 544   /* Note that these are intentionally in the same order as TSI_FOO.  They
 545      mean exactly the same as their TSI_* counterparts.  */
 546   BSI_NEW_STMT,
 547   BSI_SAME_STMT,
 548   BSI_CHAIN_START,
 549   BSI_CHAIN_END,
 550   BSI_CONTINUE_LINKING
 551 };
 552
 553 extern void bsi_insert_before (block_stmt_iterator *, tree,
 554                                enum bsi_iterator_update);
 555 extern void bsi_insert_after (block_stmt_iterator *, tree,
 556                               enum bsi_iterator_update);
 557
 558 extern void bsi_replace (const block_stmt_iterator *, tree, bool);
 559
 560 /*---------------------------------------------------------------------------
 561                               OpenMP Region Tree
 562 ---------------------------------------------------------------------------*/
 563
 564 /* Parallel region information.  Every parallel and workshare
 565    directive is enclosed between two markers, the OMP_* directive
 566    and a corresponding OMP_RETURN statement.  */
 567
 568 struct omp_region
 569 {
 570   /* The enclosing region.  */
 571   struct omp_region *outer;
 572
 573   /* First child region.  */
 574   struct omp_region *inner;
 575
 576   /* Next peer region.  */
 577   struct omp_region *next;
 578
 579   /* Block containing the omp directive as its last stmt.  */
 580   basic_block entry;
 581
 582   /* Block containing the OMP_RETURN as its last stmt.  */
 583   basic_block exit;
 584
 585   /* Block containing the OMP_CONTINUE as its last stmt.  */
 586   basic_block cont;
 587
 588   /* If this is a combined parallel+workshare region, this is a list
 589      of additional arguments needed by the combined parallel+workshare
 590      library call.  */
 591   tree ws_args;
 592
 593   /* The code for the omp directive of this region.  */
 594   enum tree_code type;
 595
 596   /* Schedule kind, only used for OMP_FOR type regions.  */
 597   enum omp_clause_schedule_kind sched_kind;
 598
 599   /* True if this is a combined parallel+workshare region.  */
 600   bool is_combined_parallel;
 601 };
 602
 603 extern struct omp_region *root_omp_region;
 604 extern struct omp_region *new_omp_region (basic_block, enum tree_code,
 605                                           struct omp_region *);
 606 extern void free_omp_regions (void);
 607
 608 /*---------------------------------------------------------------------------
 609                               Function prototypes
 610 ---------------------------------------------------------------------------*/
 611 /* In tree-cfg.c  */
 612
 613 /* Location to track pending stmt for edge insertion.  */
 614 #define PENDING_STMT(e) ((e)->insns.t)
 615
 616 extern void delete_tree_cfg_annotations (void);
 617 extern void disband_implicit_edges (void);
 618 extern bool stmt_ends_bb_p (tree);
 619 extern bool is_ctrl_stmt (tree);
 620 extern bool is_ctrl_altering_stmt (tree);
 621 extern bool computed_goto_p (tree);
 622 extern bool simple_goto_p (tree);
 623 extern bool tree_can_make_abnormal_goto (tree);
 624 extern basic_block single_noncomplex_succ (basic_block bb);
 625 extern void tree_dump_bb (basic_block, FILE *, int);
 626 extern void debug_tree_bb (basic_block);
 627 extern basic_block debug_tree_bb_n (int);
 628 extern void dump_tree_cfg (FILE *, int);
 629 extern void debug_tree_cfg (int);
 630 extern void dump_cfg_stats (FILE *);
 631 extern void debug_cfg_stats (void);
 632 extern void debug_loop_ir (void);
 633 extern void print_loop_ir (FILE *);
 634 extern void cleanup_dead_labels (void);
 635 extern void group_case_labels (void);
 636 extern tree first_stmt (basic_block);
 637 extern tree last_stmt (basic_block);
 638 extern tree last_and_only_stmt (basic_block);
 639 extern edge find_taken_edge (basic_block, tree);
 640 extern basic_block label_to_block_fn (struct function *, tree);
 641 #define label_to_block(t) (label_to_block_fn (cfun, t))
 642 extern void bsi_insert_on_edge (edge, tree);
 643 extern basic_block bsi_insert_on_edge_immediate (edge, tree);
 644 extern void bsi_commit_one_edge_insert (edge, basic_block *);
 645 extern void bsi_commit_edge_inserts (void);
 646 extern void notice_special_calls (tree);
 647 extern void clear_special_calls (void);
 648 extern void verify_stmts (void);
 649 extern tree tree_block_label (basic_block);
 650 extern void extract_true_false_edges_from_block (basic_block, edge *, edge *);
 651 extern bool tree_duplicate_sese_region (edge, edge, basic_block *, unsigned,
 652                                         basic_block *);
 653 extern void add_phi_args_after_copy_bb (basic_block);
 654 extern void add_phi_args_after_copy (basic_block *, unsigned);
 655 extern bool tree_purge_dead_abnormal_call_edges (basic_block);
 656 extern bool tree_purge_dead_eh_edges (basic_block);
 657 extern bool tree_purge_all_dead_eh_edges (bitmap);
 658 extern tree gimplify_val (block_stmt_iterator *, tree, tree);
 659 extern tree gimplify_build1 (block_stmt_iterator *, enum tree_code,
 660                              tree, tree);
 661 extern tree gimplify_build2 (block_stmt_iterator *, enum tree_code,
 662                              tree, tree, tree);
 663 extern tree gimplify_build3 (block_stmt_iterator *, enum tree_code,
 664                              tree, tree, tree, tree);
 665 extern void init_empty_tree_cfg (void);
 666 extern void fold_cond_expr_cond (void);
 667 extern void make_abnormal_goto_edges (basic_block, bool);
 668 extern void replace_uses_by (tree, tree);
 669 extern void start_recording_case_labels (void);
 670 extern void end_recording_case_labels (void);
 671 extern basic_block move_sese_region_to_fn (struct function *, basic_block,
 672                                            basic_block);
 673
 674 /* In tree-cfgcleanup.c  */
 675 extern bool cleanup_tree_cfg (void);
 676 extern bool cleanup_tree_cfg_loop (void);
 677
 678 /* In tree-pretty-print.c.  */
 679 extern void dump_generic_bb (FILE *, basic_block, int, int);
 680
 681 /* In tree-dfa.c  */
 682 extern var_ann_t create_var_ann (tree);
 683 extern function_ann_t create_function_ann (tree);
 684 extern stmt_ann_t create_stmt_ann (tree);
 685 extern tree_ann_common_t create_tree_common_ann (tree);
 686 extern void dump_dfa_stats (FILE *);
 687 extern void debug_dfa_stats (void);
 688 extern void debug_referenced_vars (void);
 689 extern void dump_referenced_vars (FILE *);
 690 extern void dump_variable (FILE *, tree);
 691 extern void debug_variable (tree);
 692 extern void dump_subvars_for (FILE *, tree);
 693 extern void debug_subvars_for (tree);
 694 extern tree get_virtual_var (tree);
 695 extern void add_referenced_var (tree);
 696 extern void remove_referenced_var (tree);
 697 extern void mark_symbols_for_renaming (tree);
 698 extern void find_new_referenced_vars (tree *);
 699
 700 extern tree make_rename_temp (tree, const char *);
 701 extern void set_default_def (tree, tree);
 702 extern tree gimple_default_def (struct function *, tree);
 703
 704 /* In tree-phinodes.c  */
 705 extern void reserve_phi_args_for_new_edge (basic_block);
 706 extern tree create_phi_node (tree, basic_block);
 707 extern void add_phi_arg (tree, tree, edge);
 708 extern void remove_phi_args (edge);
 709 extern void remove_phi_node (tree, tree, bool);
 710 extern tree phi_reverse (tree);
 711
 712 /* In gimple-low.c  */
 713 extern void record_vars_into (tree, tree);
 714 extern void record_vars (tree);
 715 extern bool block_may_fallthru (tree);
 716
 717 /* In tree-ssa-alias.c  */
 718 extern void dump_may_aliases_for (FILE *, tree);
 719 extern void debug_may_aliases_for (tree);
 720 extern void dump_alias_info (FILE *);
 721 extern void debug_alias_info (void);
 722 extern void dump_points_to_info (FILE *);
 723 extern void debug_points_to_info (void);
 724 extern void dump_points_to_info_for (FILE *, tree);
 725 extern void debug_points_to_info_for (tree);
 726 extern bool may_be_aliased (tree);
 727 extern bool is_aliased_with (tree, tree);
 728 extern struct ptr_info_def *get_ptr_info (tree);
 729 extern void new_type_alias (tree, tree, tree);
 730 extern void count_uses_and_derefs (tree, tree, unsigned *, unsigned *, bool *);
 731 static inline subvar_t get_subvars_for_var (tree);
 732 static inline tree get_subvar_at (tree, unsigned HOST_WIDE_INT);
 733 static inline bool ref_contains_array_ref (tree);
 734 static inline bool array_ref_contains_indirect_ref (tree);
 735 extern tree get_ref_base_and_extent (tree, HOST_WIDE_INT *,
 736                                      HOST_WIDE_INT *, HOST_WIDE_INT *);
 737 static inline bool var_can_have_subvars (tree);
 738 static inline bool overlap_subvar (unsigned HOST_WIDE_INT,
 739                                    unsigned HOST_WIDE_INT,
 740                                    tree, bool *);
 741 extern tree create_tag_raw (enum tree_code, tree, const char *);
 742
 743 /* Call-back function for walk_use_def_chains().  At each reaching
 744    definition, a function with this prototype is called.  */
 745 typedef bool (*walk_use_def_chains_fn) (tree, tree, void *);
 746
 747
 748 /* In tree-ssa.c  */
 749 extern void init_tree_ssa (void);
 750 extern edge ssa_redirect_edge (edge, basic_block);
 751 extern void flush_pending_stmts (edge);
 752 extern bool tree_ssa_useless_type_conversion (tree);
 753 extern bool tree_ssa_useless_type_conversion_1 (tree, tree);
 754 extern void verify_ssa (bool);
 755 extern void delete_tree_ssa (void);
 756 extern void walk_use_def_chains (tree, walk_use_def_chains_fn, void *, bool);
 757 extern bool stmt_references_memory_p (tree);
 758
 759 /* In tree-into-ssa.c  */
 760 void update_ssa (unsigned);
 761 void delete_update_ssa (void);
 762 void register_new_name_mapping (tree, tree);
 763 tree create_new_def_for (tree, tree, def_operand_p);
 764 bool need_ssa_update_p (void);
 765 bool name_mappings_registered_p (void);
 766 bool name_registered_for_update_p (tree);
 767 bitmap ssa_names_to_replace (void);
 768 void release_ssa_name_after_update_ssa (tree);
 769 void compute_global_livein (bitmap, bitmap);
 770 tree duplicate_ssa_name (tree, tree);
 771 void mark_sym_for_renaming (tree);
 772 void mark_set_for_renaming (bitmap);
 773 tree get_current_def (tree);
 774 void set_current_def (tree, tree);
 775
 776 /* In tree-ssa-ccp.c  */
 777 bool fold_stmt (tree *);
 778 bool fold_stmt_inplace (tree);
 779 tree widen_bitfield (tree, tree, tree);
 780
 781 /* In tree-vrp.c  */
 782 tree vrp_evaluate_conditional (tree, bool);
 783 void simplify_stmt_using_ranges (tree);
 784
 785 /* In tree-ssa-dom.c  */
 786 extern void dump_dominator_optimization_stats (FILE *);
 787 extern void debug_dominator_optimization_stats (void);
 788 int loop_depth_of_name (tree);
 789
 790 /* In tree-ssa-copy.c  */
 791 extern void merge_alias_info (tree, tree);
 792 extern void propagate_value (use_operand_p, tree);
 793 extern void propagate_tree_value (tree *, tree);
 794 extern void replace_exp (use_operand_p, tree);
 795 extern bool may_propagate_copy (tree, tree);
 796 extern bool may_propagate_copy_into_asm (tree);
 797
 798 /* Affine iv.  */
 799
 800 typedef struct
 801 {
 802   /* Iv = BASE + STEP * i.  */
 803   tree base, step;
 804
 805   /* True if this iv does not overflow.  */
 806   bool no_overflow;
 807 } affine_iv;
 808
 809 /* Description of number of iterations of a loop.  All the expressions inside
 810    the structure can be evaluated at the end of the loop's preheader
 811    (and due to ssa form, also anywhere inside the body of the loop).  */
 812
 813 struct tree_niter_desc
 814 {
 815   tree assumptions;     /* The boolean expression.  If this expression evaluates
 816                            to false, then the other fields in this structure
 817                            should not be used; there is no guarantee that they
 818                            will be correct.  */
 819   tree may_be_zero;     /* The boolean expression.  If it evaluates to true,
 820                            the loop will exit in the first iteration (i.e.
 821                            its latch will not be executed), even if the niter
 822                            field says otherwise.  */
 823   tree niter;           /* The expression giving the number of iterations of
 824                            a loop (provided that assumptions == true and
 825                            may_be_zero == false), more precisely the number
 826                            of executions of the latch of the loop.  */
 827   tree additional_info; /* The boolean expression.  Sometimes we use additional
 828                            knowledge to simplify the other expressions
 829                            contained in this structure (for example the
 830                            knowledge about value ranges of operands on entry to
 831                            the loop).  If this is a case, conjunction of such
 832                            condition is stored in this field, so that we do not
 833                            lose the information: for example if may_be_zero
 834                            is (n <= 0) and niter is (unsigned) n, we know
 835                            that the number of iterations is at most
 836                            MAX_SIGNED_INT.  However if the (n <= 0) assumption
 837                            is eliminated (by looking at the guard on entry of
 838                            the loop), then the information would be lost.  */
 839
 840   /* The simplified shape of the exit condition.  The loop exits if
 841      CONTROL CMP BOUND is false, where CMP is one of NE_EXPR,
 842      LT_EXPR, or GT_EXPR, and step of CONTROL is positive if CMP is
 843      LE_EXPR and negative if CMP is GE_EXPR.  This information is used
 844      by loop unrolling.  */
 845   affine_iv control;
 846   tree bound;
 847   enum tree_code cmp;
 848 };
 849
 850 /* In tree-vectorizer.c */
 851 unsigned vectorize_loops (void);
 852 extern bool vect_can_force_dr_alignment_p (tree, unsigned int);
 853 extern tree get_vectype_for_scalar_type (tree);
 854
 855 /* In tree-ssa-phiopt.c */
 856 bool empty_block_p (basic_block);
 857
 858 /* In tree-ssa-loop*.c  */
 859
 860 void tree_ssa_lim (void);
 861 unsigned int tree_ssa_unswitch_loops (void);
 862 unsigned int canonicalize_induction_variables (void);
 863 unsigned int tree_unroll_loops_completely (bool);
 864 unsigned int tree_ssa_prefetch_arrays (void);
 865 unsigned int remove_empty_loops (void);
 866 void tree_ssa_iv_optimize (void);
 867
 868 bool number_of_iterations_exit (struct loop *, edge,
 869                                 struct tree_niter_desc *niter, bool);
 870 tree find_loop_niter (struct loop *, edge *);
 871 tree loop_niter_by_eval (struct loop *, edge);
 872 tree find_loop_niter_by_eval (struct loop *, edge *);
 873 void estimate_numbers_of_iterations (void);
 874 bool scev_probably_wraps_p (tree, tree, tree, struct loop *, bool);
 875 bool convert_affine_scev (struct loop *, tree, tree *, tree *, tree, bool);
 876
 877 bool nowrap_type_p (tree);
 878 enum ev_direction {EV_DIR_GROWS, EV_DIR_DECREASES, EV_DIR_UNKNOWN};
 879 enum ev_direction scev_direction (tree);
 880
 881 void free_numbers_of_iterations_estimates (void);
 882 void free_numbers_of_iterations_estimates_loop (struct loop *);
 883 void rewrite_into_loop_closed_ssa (bitmap, unsigned);
 884 void verify_loop_closed_ssa (void);
 885 bool for_each_index (tree *, bool (*) (tree, tree *, void *), void *);
 886 void create_iv (tree, tree, tree, struct loop *, block_stmt_iterator *, bool,
 887                 tree *, tree *);
 888 void split_loop_exit_edge (edge);
 889 unsigned force_expr_to_var_cost (tree);
 890 void standard_iv_increment_position (struct loop *, block_stmt_iterator *,
 891                                      bool *);
 892 basic_block ip_end_pos (struct loop *);
 893 basic_block ip_normal_pos (struct loop *);
 894 bool tree_duplicate_loop_to_header_edge (struct loop *, edge,
 895                                          unsigned int, sbitmap,
 896                                          edge, VEC (edge, heap) **,
 897                                          int);
 898 struct loop *tree_ssa_loop_version (struct loop *, tree,
 899                                     basic_block *);
 900 tree expand_simple_operations (tree);
 901 void substitute_in_loop_info (struct loop *, tree, tree);
 902 edge single_dom_exit (struct loop *);
 903 bool can_unroll_loop_p (struct loop *loop, unsigned factor,
 904                         struct tree_niter_desc *niter);
 905 void tree_unroll_loop (struct loop *, unsigned,
 906                        edge, struct tree_niter_desc *);
 907 typedef void (*transform_callback)(struct loop *, void *);
 908 void tree_transform_and_unroll_loop (struct loop *, unsigned,
 909                                      edge, struct tree_niter_desc *,
 910                                      transform_callback, void *);
 911 bool contains_abnormal_ssa_name_p (tree);
 912
 913 /* In tree-ssa-threadedge.c */
 914 extern bool potentially_threadable_block (basic_block);
 915 extern void thread_across_edge (tree, edge, bool,
 916                                 VEC(tree, heap) **, tree (*) (tree));
 917
 918 /* In tree-ssa-loop-im.c  */
 919 /* The possibilities of statement movement.  */
 920
 921 enum move_pos
 922   {
 923     MOVE_IMPOSSIBLE,            /* No movement -- side effect expression.  */
 924     MOVE_PRESERVE_EXECUTION,    /* Must not cause the non-executed statement
 925                                    become executed -- memory accesses, ... */
 926     MOVE_POSSIBLE               /* Unlimited movement.  */
 927   };
 928 extern enum move_pos movement_possibility (tree);
 929
 930 /* The reasons a variable may escape a function.  */
 931 enum escape_type
 932 {
 933   NO_ESCAPE = 0,                        /* Doesn't escape.  */
 934   ESCAPE_STORED_IN_GLOBAL = 1 << 1,
 935   ESCAPE_TO_ASM = 1 << 2,               /* Passed by address to an assembly
 936                                            statement.  */
 937   ESCAPE_TO_CALL = 1 << 3,              /* Escapes to a function call.  */
 938   ESCAPE_BAD_CAST = 1 << 4,             /* Cast from pointer to integer */
 939   ESCAPE_TO_RETURN = 1 << 5,            /* Returned from function.  */
 940   ESCAPE_TO_PURE_CONST = 1 << 6,        /* Escapes to a pure or constant
 941                                            function call.  */
 942   ESCAPE_IS_GLOBAL = 1 << 7,            /* Is a global variable.  */
 943   ESCAPE_IS_PARM = 1 << 8,              /* Is an incoming function argument.  */
 944   ESCAPE_UNKNOWN = 1 << 9               /* We believe it escapes for
 945                                            some reason not enumerated
 946                                            above.  */
 947 };
 948
 949 /* In tree-flow-inline.h  */
 950 static inline bool is_call_clobbered (tree);
 951 static inline void mark_call_clobbered (tree, unsigned int);
 952 static inline void set_is_used (tree);
 953 static inline bool unmodifiable_var_p (tree);
 954
 955 /* In tree-eh.c  */
 956 extern void make_eh_edges (tree);
 957 extern bool tree_could_trap_p (tree);
 958 extern bool tree_could_throw_p (tree);
 959 extern bool tree_can_throw_internal (tree);
 960 extern bool tree_can_throw_external (tree);
 961 extern int lookup_stmt_eh_region (tree);
 962 extern void add_stmt_to_eh_region (tree, int);
 963 extern bool remove_stmt_from_eh_region (tree);
 964 extern bool maybe_clean_or_replace_eh_stmt (tree, tree);
 965
 966 /* In tree-ssa-pre.c  */
 967 void add_to_value (tree, tree);
 968 void debug_value_expressions (tree);
 969 void print_value_expressions (FILE *, tree);
 970
 971
 972 /* In tree-vn.c  */
 973 bool expressions_equal_p (tree, tree);
 974 static inline tree get_value_handle (tree);
 975 hashval_t vn_compute (tree, hashval_t);
 976 void sort_vuses (VEC (tree, gc) *);
 977 tree vn_lookup_or_add (tree, tree);
 978 tree vn_lookup_or_add_with_vuses (tree, VEC (tree, gc) *);
 979 void vn_add (tree, tree);
 980 void vn_add_with_vuses (tree, tree, VEC (tree, gc) *);
 981 tree vn_lookup (tree, tree);
 982 tree vn_lookup_with_vuses (tree, VEC (tree, gc) *);
 983 void vn_init (void);
 984 void vn_delete (void);
 985
 986 /* In tree-ssa-sink.c  */
 987 bool is_hidden_global_store (tree);
 988
 989 /* In tree-sra.c  */
 990 void insert_edge_copies (tree, basic_block);
 991 void sra_insert_before (block_stmt_iterator *, tree);
 992 void sra_insert_after (block_stmt_iterator *, tree);
 993 void sra_init_cache (void);
 994 bool sra_type_can_be_decomposed_p (tree);
 995
 996 /* In tree-loop-linear.c  */
 997 extern void linear_transform_loops (void);
 998
 999 /* In tree-ssa-loop-ivopts.c  */
1000 bool expr_invariant_in_loop_p (struct loop *, tree);
1001 bool multiplier_allowed_in_address_p (HOST_WIDE_INT, enum machine_mode);
1002 unsigned multiply_by_cost (HOST_WIDE_INT, enum machine_mode);
1003
1004 /* In tree-ssa-threadupdate.c.  */
1005 extern bool thread_through_all_blocks (void);
1006 extern void register_jump_thread (edge, edge);
1007
1008 /* In gimplify.c  */
1009 tree force_gimple_operand (tree, tree *, bool, tree);
1010 tree force_gimple_operand_bsi (block_stmt_iterator *, tree, bool, tree);
1011
1012 /* In tree-ssa-structalias.c */
1013 bool find_what_p_points_to (tree);
1014
1015 /* In tree-ssa-live.c */
1016 extern void remove_unused_locals (void);
1017
1018 /* In tree-ssa-address.c  */
1019
1020 /* Description of a memory address.  */
1021
1022 struct mem_address
1023 {
1024   tree symbol, base, index, step, offset;
1025 };
1026
1027 struct affine_tree_combination;
1028 tree create_mem_ref (block_stmt_iterator *, tree,
1029                      struct affine_tree_combination *);
1030 rtx addr_for_mem_ref (struct mem_address *, bool);
1031 void get_address_description (tree, struct mem_address *);
1032 tree maybe_fold_tmr (tree);
1033
1034 /* This structure is simply used during pushing fields onto the fieldstack
1035    to track the offset of the field, since bitpos_of_field gives it relative
1036    to its immediate containing type, and we want it relative to the ultimate
1037    containing object.  */
1038
1039 struct fieldoff
1040 {
1041   tree type;
1042   tree size;
1043   tree decl;
1044   HOST_WIDE_INT offset;
1045 };
1046 typedef struct fieldoff fieldoff_s;
1047
1048 DEF_VEC_O(fieldoff_s);
1049 DEF_VEC_ALLOC_O(fieldoff_s,heap);
1050 int push_fields_onto_fieldstack (tree, VEC(fieldoff_s,heap) **,
1051                                  HOST_WIDE_INT, bool *);
1052 void sort_fieldstack (VEC(fieldoff_s,heap) *);
1053
1054 void init_alias_heapvars (void);
1055 void delete_alias_heapvars (void);
1056 unsigned int execute_fixup_cfg (void);
1057
1058 #include "tree-flow-inline.h"
1059
1060 void swap_tree_operands (tree, tree *, tree *);
1061
1062 int least_common_multiple (int, int);
1063
1064 #endif /* _TREE_FLOW_H  */