gcc/tree-ssa.h

   1 /* Header file for any pass which requires SSA routines.
   2    Copyright (C) 2013-2023 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_TREE_SSA_H
  21 #define GCC_TREE_SSA_H
  22
  23 /* Mapping for redirected edges.  */
  24 struct edge_var_map {
  25   tree result;                  /* PHI result.  */
  26   tree def;                     /* PHI arg definition.  */
  27   location_t locus;        /* PHI arg location.  */
  28 };
  29
  30 /* A vector of var maps.  */
  31 typedef vec<edge_var_map, va_heap, vl_embed> edge_var_map_vector;
  32
  33
  34 extern void redirect_edge_var_map_add (edge, tree, tree, location_t);
  35 extern void redirect_edge_var_map_clear (edge);
  36 extern void redirect_edge_var_map_dup (edge, edge);
  37 extern vec<edge_var_map> *redirect_edge_var_map_vector (edge);
  38 extern void redirect_edge_var_map_empty (void);
  39 extern edge ssa_redirect_edge (edge, basic_block);
  40 extern void flush_pending_stmts (edge);
  41 extern void gimple_replace_ssa_lhs (gimple *, tree);
  42 extern tree target_for_debug_bind (tree);
  43 extern void insert_debug_temp_for_var_def (gimple_stmt_iterator *, tree);
  44 extern void insert_debug_temps_for_defs (gimple_stmt_iterator *);
  45 extern void reset_debug_uses (gimple *);
  46 extern void release_defs_bitset (bitmap toremove);
  47 extern void verify_ssa (bool, bool);
  48 extern void init_tree_ssa (function *, int size = 0);
  49 extern void delete_tree_ssa (function *);
  50 extern bool tree_ssa_useless_type_conversion (tree);
  51 extern tree tree_ssa_strip_useless_type_conversions (tree);
  52 extern tree find_released_ssa_name (tree *, int *, void *);
  53
  54
  55 extern bool ssa_defined_default_def_p (tree t);
  56 extern bool ssa_undefined_value_p (tree, bool = true);
  57 extern bool gimple_uses_undefined_value_p (gimple *);
  58
  59
  60 bool ssa_name_any_use_dominates_bb_p (tree var, basic_block bb);
  61 extern void mark_ssa_maybe_undefs (void);
  62
  63 /* Return TRUE iff VAR is marked as maybe-undefined.  See
  64    mark_ssa_maybe_undefs.  */
  65
  66 static inline bool
  67 ssa_name_maybe_undef_p (tree var)
  68 {
  69   gcc_checking_assert (TREE_CODE (var) == SSA_NAME);
  70   return TREE_VISITED (var);
  71 }
  72
  73 /* Set (or clear, depending on VALUE) VAR's maybe-undefined mark.  */
  74
  75 static inline void
  76 ssa_name_set_maybe_undef (tree var, bool value = true)
  77 {
  78   gcc_checking_assert (TREE_CODE (var) == SSA_NAME);
  79   TREE_VISITED (var) = value;
  80 }
  81
  82
  83 extern void execute_update_addresses_taken (void);
  84
  85 /* Given an edge_var_map V, return the PHI arg definition.  */
  86
  87 static inline tree
  88 redirect_edge_var_map_def (edge_var_map *v)
  89 {
  90   return v->def;
  91 }
  92
  93 /* Given an edge_var_map V, return the PHI result.  */
  94
  95 static inline tree
  96 redirect_edge_var_map_result (edge_var_map *v)
  97 {
  98   return v->result;
  99 }
 100
 101 /* Given an edge_var_map V, return the PHI arg location.  */
 102
 103 static inline location_t
 104 redirect_edge_var_map_location (edge_var_map *v)
 105 {
 106   return v->locus;
 107 }
 108
 109 /* Verify SSA invariants, if internal consistency checks are enabled.  */
 110
 111 static inline void
 112 checking_verify_ssa (bool check_modified_stmt, bool check_ssa_operands)
 113 {
 114   if (flag_checking)
 115     verify_ssa (check_modified_stmt, check_ssa_operands);
 116 }
 117
 118 #endif /* GCC_TREE_SSA_H */