gcc/tree-ssa-operands.h

   1 /* SSA operand management for trees.
   2    Copyright (C) 2003, 2005, 2006, 2007, 2008 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_OPERANDS_H
  21 #define GCC_TREE_SSA_OPERANDS_H
  22
  23 /* Interface to SSA operands.  */
  24
  25
  26 /* This represents a pointer to a DEF operand.  */
  27 typedef tree *def_operand_p;
  28
  29 /* This represents a pointer to a USE operand.  */
  30 typedef ssa_use_operand_t *use_operand_p;
  31
  32 /* NULL operand types.  */
  33 #define NULL_USE_OPERAND_P              ((use_operand_p)NULL)
  34 #define NULL_DEF_OPERAND_P              ((def_operand_p)NULL)
  35
  36 /* This represents the DEF operands of a stmt.  */
  37 struct def_optype_d
  38 {
  39   struct def_optype_d *next;
  40   tree *def_ptr;
  41 };
  42 typedef struct def_optype_d *def_optype_p;
  43
  44 /* This represents the USE operands of a stmt.  */
  45 struct use_optype_d
  46 {
  47   struct use_optype_d *next;
  48   struct ssa_use_operand_d use_ptr;
  49 };
  50 typedef struct use_optype_d *use_optype_p;
  51
  52 /* This structure represents a variable sized buffer which is allocated by the
  53    operand memory manager.  Operands are suballocated out of this block.  The
  54    MEM array varies in size.  */
  55
  56 struct ssa_operand_memory_d GTY((chain_next("%h.next")))
  57 {
  58   struct ssa_operand_memory_d *next;
  59   char mem[1];
  60 };
  61
  62 /* Per-function operand caches.  */
  63 struct ssa_operands GTY(()) {
  64    struct ssa_operand_memory_d *operand_memory;
  65    unsigned operand_memory_index;
  66    /* Current size of the operand memory buffer.  */
  67    unsigned int ssa_operand_mem_size;
  68
  69    bool ops_active;
  70
  71    struct def_optype_d * GTY ((skip (""))) free_defs;
  72    struct use_optype_d * GTY ((skip (""))) free_uses;
  73 };
  74
  75 #define USE_FROM_PTR(PTR)       get_use_from_ptr (PTR)
  76 #define DEF_FROM_PTR(PTR)       get_def_from_ptr (PTR)
  77 #define SET_USE(USE, V)         set_ssa_use_from_ptr (USE, V)
  78 #define SET_DEF(DEF, V)         ((*(DEF)) = (V))
  79
  80 #define USE_STMT(USE)           (USE)->loc.stmt
  81
  82 #define USE_OP_PTR(OP)          (&((OP)->use_ptr))
  83 #define USE_OP(OP)              (USE_FROM_PTR (USE_OP_PTR (OP)))
  84
  85 #define DEF_OP_PTR(OP)          ((OP)->def_ptr)
  86 #define DEF_OP(OP)              (DEF_FROM_PTR (DEF_OP_PTR (OP)))
  87
  88 #define PHI_RESULT_PTR(PHI)     gimple_phi_result_ptr (PHI)
  89 #define PHI_RESULT(PHI)         DEF_FROM_PTR (PHI_RESULT_PTR (PHI))
  90 #define SET_PHI_RESULT(PHI, V)  SET_DEF (PHI_RESULT_PTR (PHI), (V))
  91
  92 #define PHI_ARG_DEF_PTR(PHI, I) gimple_phi_arg_imm_use_ptr ((PHI), (I))
  93 #define PHI_ARG_DEF(PHI, I)     USE_FROM_PTR (PHI_ARG_DEF_PTR ((PHI), (I)))
  94 #define SET_PHI_ARG_DEF(PHI, I, V)                                      \
  95                                 SET_USE (PHI_ARG_DEF_PTR ((PHI), (I)), (V))
  96 #define PHI_ARG_DEF_FROM_EDGE(PHI, E)                                   \
  97                                 PHI_ARG_DEF ((PHI), (E)->dest_idx)
  98 #define PHI_ARG_DEF_PTR_FROM_EDGE(PHI, E)                               \
  99                                 PHI_ARG_DEF_PTR ((PHI), (E)->dest_idx)
 100 #define PHI_ARG_INDEX_FROM_USE(USE)   phi_arg_index_from_use (USE)
 101
 102
 103 extern void init_ssa_operands (void);
 104 extern void fini_ssa_operands (void);
 105 extern void update_stmt_operands (gimple);
 106 extern void free_stmt_operands (gimple);
 107 extern bool verify_imm_links (FILE *f, tree var);
 108
 109 extern void dump_immediate_uses (FILE *file);
 110 extern void dump_immediate_uses_for (FILE *file, tree var);
 111 extern void debug_immediate_uses (void);
 112 extern void debug_immediate_uses_for (tree var);
 113 extern void dump_decl_set (FILE *, bitmap);
 114 extern void debug_decl_set (bitmap);
 115
 116 extern bool ssa_operands_active (void);
 117
 118 extern void push_stmt_changes (gimple *);
 119 extern void pop_stmt_changes (gimple *);
 120 extern void discard_stmt_changes (gimple *);
 121
 122 extern void unlink_stmt_vdef (gimple);
 123
 124 enum ssa_op_iter_type {
 125   ssa_op_iter_none = 0,
 126   ssa_op_iter_tree,
 127   ssa_op_iter_use,
 128   ssa_op_iter_def
 129 };
 130
 131 /* This structure is used in the operand iterator loops.  It contains the
 132    items required to determine which operand is retrieved next.  During
 133    optimization, this structure is scalarized, and any unused fields are
 134    optimized away, resulting in little overhead.  */
 135
 136 typedef struct ssa_operand_iterator_d
 137 {
 138   bool done;
 139   enum ssa_op_iter_type iter_type;
 140   def_optype_p defs;
 141   use_optype_p uses;
 142   int phi_i;
 143   int num_phi;
 144   gimple phi_stmt;
 145 } ssa_op_iter;
 146
 147 /* These flags are used to determine which operands are returned during
 148    execution of the loop.  */
 149 #define SSA_OP_USE              0x01    /* Real USE operands.  */
 150 #define SSA_OP_DEF              0x02    /* Real DEF operands.  */
 151 #define SSA_OP_VUSE             0x04    /* VUSE operands.  */
 152 #define SSA_OP_VDEF             0x08    /* VDEF operands.  */
 153
 154 /* These are commonly grouped operand flags.  */
 155 #define SSA_OP_VIRTUAL_USES     (SSA_OP_VUSE)
 156 #define SSA_OP_VIRTUAL_DEFS     (SSA_OP_VDEF)
 157 #define SSA_OP_ALL_VIRTUALS     (SSA_OP_VIRTUAL_USES | SSA_OP_VIRTUAL_DEFS)
 158 #define SSA_OP_ALL_USES         (SSA_OP_VIRTUAL_USES | SSA_OP_USE)
 159 #define SSA_OP_ALL_DEFS         (SSA_OP_VIRTUAL_DEFS | SSA_OP_DEF)
 160 #define SSA_OP_ALL_OPERANDS     (SSA_OP_ALL_USES | SSA_OP_ALL_DEFS)
 161
 162 /* This macro executes a loop over the operands of STMT specified in FLAG,
 163    returning each operand as a 'tree' in the variable TREEVAR.  ITER is an
 164    ssa_op_iter structure used to control the loop.  */
 165 #define FOR_EACH_SSA_TREE_OPERAND(TREEVAR, STMT, ITER, FLAGS)   \
 166   for (TREEVAR = op_iter_init_tree (&(ITER), STMT, FLAGS);      \
 167        !op_iter_done (&(ITER));                                 \
 168        TREEVAR = op_iter_next_tree (&(ITER)))
 169
 170 /* This macro executes a loop over the operands of STMT specified in FLAG,
 171    returning each operand as a 'use_operand_p' in the variable USEVAR.
 172    ITER is an ssa_op_iter structure used to control the loop.  */
 173 #define FOR_EACH_SSA_USE_OPERAND(USEVAR, STMT, ITER, FLAGS)     \
 174   for (USEVAR = op_iter_init_use (&(ITER), STMT, FLAGS);        \
 175        !op_iter_done (&(ITER));                                 \
 176        USEVAR = op_iter_next_use (&(ITER)))
 177
 178 /* This macro executes a loop over the operands of STMT specified in FLAG,
 179    returning each operand as a 'def_operand_p' in the variable DEFVAR.
 180    ITER is an ssa_op_iter structure used to control the loop.  */
 181 #define FOR_EACH_SSA_DEF_OPERAND(DEFVAR, STMT, ITER, FLAGS)     \
 182   for (DEFVAR = op_iter_init_def (&(ITER), STMT, FLAGS);        \
 183        !op_iter_done (&(ITER));                                 \
 184        DEFVAR = op_iter_next_def (&(ITER)))
 185
 186 /* This macro will execute a loop over all the arguments of a PHI which
 187    match FLAGS.   A use_operand_p is always returned via USEVAR.  FLAGS
 188    can be either SSA_OP_USE or SSA_OP_VIRTUAL_USES or SSA_OP_ALL_USES.  */
 189 #define FOR_EACH_PHI_ARG(USEVAR, STMT, ITER, FLAGS)             \
 190   for ((USEVAR) = op_iter_init_phiuse (&(ITER), STMT, FLAGS);   \
 191        !op_iter_done (&(ITER));                                 \
 192        (USEVAR) = op_iter_next_use (&(ITER)))
 193
 194
 195 /* This macro will execute a loop over a stmt, regardless of whether it is
 196    a real stmt or a PHI node, looking at the USE nodes matching FLAGS.  */
 197 #define FOR_EACH_PHI_OR_STMT_USE(USEVAR, STMT, ITER, FLAGS)     \
 198   for ((USEVAR) = (gimple_code (STMT) == GIMPLE_PHI             \
 199                    ? op_iter_init_phiuse (&(ITER), STMT, FLAGS) \
 200                    : op_iter_init_use (&(ITER), STMT, FLAGS));  \
 201        !op_iter_done (&(ITER));                                 \
 202        (USEVAR) = op_iter_next_use (&(ITER)))
 203
 204 /* This macro will execute a loop over a stmt, regardless of whether it is
 205    a real stmt or a PHI node, looking at the DEF nodes matching FLAGS.  */
 206 #define FOR_EACH_PHI_OR_STMT_DEF(DEFVAR, STMT, ITER, FLAGS)     \
 207   for ((DEFVAR) = (gimple_code (STMT) == GIMPLE_PHI             \
 208                    ? op_iter_init_phidef (&(ITER), STMT, FLAGS) \
 209                    : op_iter_init_def (&(ITER), STMT, FLAGS));  \
 210        !op_iter_done (&(ITER));                                 \
 211        (DEFVAR) = op_iter_next_def (&(ITER)))
 212
 213 /* This macro returns an operand in STMT as a tree if it is the ONLY
 214    operand matching FLAGS.  If there are 0 or more than 1 operand matching
 215    FLAGS, then NULL_TREE is returned.  */
 216 #define SINGLE_SSA_TREE_OPERAND(STMT, FLAGS)                    \
 217   single_ssa_tree_operand (STMT, FLAGS)
 218
 219 /* This macro returns an operand in STMT as a use_operand_p if it is the ONLY
 220    operand matching FLAGS.  If there are 0 or more than 1 operand matching
 221    FLAGS, then NULL_USE_OPERAND_P is returned.  */
 222 #define SINGLE_SSA_USE_OPERAND(STMT, FLAGS)                     \
 223   single_ssa_use_operand (STMT, FLAGS)
 224
 225 /* This macro returns an operand in STMT as a def_operand_p if it is the ONLY
 226    operand matching FLAGS.  If there are 0 or more than 1 operand matching
 227    FLAGS, then NULL_DEF_OPERAND_P is returned.  */
 228 #define SINGLE_SSA_DEF_OPERAND(STMT, FLAGS)                     \
 229   single_ssa_def_operand (STMT, FLAGS)
 230
 231 /* This macro returns TRUE if there are no operands matching FLAGS in STMT.  */
 232 #define ZERO_SSA_OPERANDS(STMT, FLAGS)  zero_ssa_operands (STMT, FLAGS)
 233
 234 /* This macro counts the number of operands in STMT matching FLAGS.  */
 235 #define NUM_SSA_OPERANDS(STMT, FLAGS)   num_ssa_operands (STMT, FLAGS)
 236
 237 #endif  /* GCC_TREE_SSA_OPERANDS_H  */