gcc/tree-ssa-operands.h

   1 /* SSA operand management for trees.
   2    Copyright (C) 2003, 2005, 2006, 2007 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              NULL
  34 #define NULL_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 typedef struct vuse_element_d
  53 {
  54   tree use_var;
  55   struct ssa_use_operand_d use_ptr;
  56 } vuse_element_t;
  57
  58 typedef struct vuse_vec_d
  59 {
  60   unsigned int num_vuse;
  61   vuse_element_t uses[1];
  62 } vuse_vec_t;
  63 typedef struct vuse_vec_d *vuse_vec_p;
  64
  65 #define VUSE_VECT_NUM_ELEM(V)           (V).num_vuse
  66 #define VUSE_VECT_ELEMENT_NC(V,X)       (V).uses[(X)]
  67 #define VUSE_ELEMENT_PTR_NC(V,X)        (&(VUSE_VECT_ELEMENT_NC ((V),(X)).use_ptr))
  68 #define VUSE_ELEMENT_VAR_NC(V,X)        (VUSE_VECT_ELEMENT_NC ((V),(X)).use_var)
  69
  70 #ifdef ENABLE_CHECKING
  71 #define VUSE_VECT_ELEMENT(V,X)                                          \
  72     (gcc_assert (((unsigned int) (X)) < VUSE_VECT_NUM_ELEM (V)),        \
  73      VUSE_VECT_ELEMENT_NC (V,X))
  74
  75 #define VUSE_ELEMENT_PTR(V,X)                                           \
  76     (gcc_assert (((unsigned int) (X)) < VUSE_VECT_NUM_ELEM (V)),        \
  77      VUSE_ELEMENT_PTR_NC (V, X))
  78
  79 #define SET_VUSE_VECT_ELEMENT(V,X,N)                                    \
  80     (gcc_assert (((unsigned int) (X)) < VUSE_VECT_NUM_ELEM (V)),        \
  81      VUSE_VECT_ELEMENT_NC (V,X) = (N))
  82
  83 #define SET_VUSE_ELEMENT_VAR(V,X,N)                                     \
  84     (gcc_assert (((unsigned int) (X)) < VUSE_VECT_NUM_ELEM (V)),        \
  85      VUSE_VECT_ELEMENT_NC ((V),(X)).use_var = (N))
  86
  87 #define SET_VUSE_ELEMENT_PTR(V,X,N)                                     \
  88     (gcc_assert (((unsigned int) (X)) < VUSE_VECT_NUM_ELEM (V)),        \
  89      VUSE_ELEMENT_PTR_NC (V, X) = (N))
  90 #else
  91 #define VUSE_VECT_ELEMENT(V,X) VUSE_VECT_ELEMENT_NC(V,X)
  92 #define VUSE_ELEMENT_PTR(V,X) VUSE_ELEMENT_PTR_NC(V,X)
  93 #define SET_VUSE_VECT_ELEMENT(V,X,N) VUSE_VECT_ELEMENT_NC(V,X) = (N)
  94 #define SET_VUSE_ELEMENT_PTR(V,X,N) VUSE_ELEMENT_PTR_NC(V,X) = (N)
  95 #define SET_VUSE_ELEMENT_VAR(V,X,N) VUSE_VECT_ELEMENT_NC ((V),(X)).use_var = (N)
  96 #endif
  97
  98 #define VUSE_ELEMENT_VAR(V,X)   (VUSE_VECT_ELEMENT ((V),(X)).use_var)
  99
 100 /* This represents the virtual ops of a stmt.  */
 101 struct voptype_d
 102 {
 103   struct voptype_d *next;
 104   tree def_var;
 105   vuse_vec_t usev;
 106 };
 107 typedef struct voptype_d *voptype_p;
 108
 109 /* This structure represents a variable sized buffer which is allocated by the
 110    operand memory manager.  Operands are suballocated out of this block.  The
 111    MEM array varies in size.  */
 112
 113 struct ssa_operand_memory_d GTY((chain_next("%h.next")))
 114 {
 115   struct ssa_operand_memory_d *next;
 116   char mem[1];
 117 };
 118
 119 /* Number of different size free buckets for virtual operands.  */
 120 #define NUM_VOP_FREE_BUCKETS            29
 121
 122 /* Per-function operand caches.  */
 123 struct ssa_operands GTY(()) {
 124    struct ssa_operand_memory_d *operand_memory;
 125    unsigned operand_memory_index;
 126    /* Current size of the operand memory buffer.  */
 127    unsigned int ssa_operand_mem_size;
 128
 129    bool ops_active;
 130
 131    struct def_optype_d * GTY ((skip (""))) free_defs;
 132    struct use_optype_d * GTY ((skip (""))) free_uses;
 133    struct voptype_d * GTY ((skip (""))) vop_free_buckets[NUM_VOP_FREE_BUCKETS];
 134    VEC(tree,heap) * GTY ((skip (""))) mpt_table;
 135 };
 136
 137 /* This represents the operand cache for a stmt.  */
 138 struct stmt_operands_d
 139 {
 140   /* Statement operands.  */
 141   struct def_optype_d * def_ops;
 142   struct use_optype_d * use_ops;
 143
 144   /* Virtual operands (VDEF, VUSE).  */
 145   struct voptype_d * vdef_ops;
 146   struct voptype_d * vuse_ops;
 147
 148   /* Sets of memory symbols loaded and stored.  */
 149   bitmap stores;
 150   bitmap loads;
 151 };
 152
 153 typedef struct stmt_operands_d *stmt_operands_p;
 154
 155 #define USE_FROM_PTR(PTR)       get_use_from_ptr (PTR)
 156 #define DEF_FROM_PTR(PTR)       get_def_from_ptr (PTR)
 157 #define SET_USE(USE, V)         set_ssa_use_from_ptr (USE, V)
 158 #define SET_DEF(DEF, V)         ((*(DEF)) = (V))
 159
 160 #define USE_STMT(USE)           (USE)->loc.stmt
 161
 162 #define USE_OP_PTR(OP)          (&((OP)->use_ptr))
 163 #define USE_OP(OP)              (USE_FROM_PTR (USE_OP_PTR (OP)))
 164
 165 #define DEF_OP_PTR(OP)          ((OP)->def_ptr)
 166 #define DEF_OP(OP)              (DEF_FROM_PTR (DEF_OP_PTR (OP)))
 167
 168 #define VUSE_OP_PTR(OP,X)       VUSE_ELEMENT_PTR ((OP)->usev, (X))
 169 #define VUSE_OP(OP,X)           VUSE_ELEMENT_VAR ((OP)->usev, (X))
 170 #define SET_VUSE_OP(OP,X,N)     SET_VUSE_ELEMENT_VAR ((OP)->usev, (X), (N))
 171 #define VUSE_NUM(OP)            VUSE_VECT_NUM_ELEM ((OP)->usev)
 172 #define VUSE_VECT(OP)           &((OP)->usev)
 173
 174 #define VDEF_RESULT_PTR(OP)     (&((OP)->def_var))
 175 #define VDEF_RESULT(OP)         ((OP)->def_var)
 176 #define VDEF_OP_PTR(OP,X)       VUSE_OP_PTR (OP, X)
 177 #define VDEF_OP(OP,X)           VUSE_OP (OP, X)
 178 #define SET_VDEF_OP(OP,X,N)     SET_VUSE_OP (OP, X, N)
 179 #define VDEF_NUM(OP)            VUSE_VECT_NUM_ELEM ((OP)->usev)
 180 #define VDEF_VECT(OP)           &((OP)->usev)
 181
 182 #define PHI_RESULT_PTR(PHI)     gimple_phi_result_ptr (PHI)
 183 #define PHI_RESULT(PHI)         DEF_FROM_PTR (PHI_RESULT_PTR (PHI))
 184 #define SET_PHI_RESULT(PHI, V)  SET_DEF (PHI_RESULT_PTR (PHI), (V))
 185
 186 #define PHI_ARG_DEF_PTR(PHI, I) gimple_phi_arg_imm_use_ptr ((PHI), (I))
 187 #define PHI_ARG_DEF(PHI, I)     USE_FROM_PTR (PHI_ARG_DEF_PTR ((PHI), (I)))
 188 #define SET_PHI_ARG_DEF(PHI, I, V)                                      \
 189                                 SET_USE (PHI_ARG_DEF_PTR ((PHI), (I)), (V))
 190 #define PHI_ARG_DEF_FROM_EDGE(PHI, E)                                   \
 191                                 PHI_ARG_DEF ((PHI), (E)->dest_idx)
 192 #define PHI_ARG_DEF_PTR_FROM_EDGE(PHI, E)                               \
 193                                 PHI_ARG_DEF_PTR ((PHI), (E)->dest_idx)
 194 #define PHI_ARG_INDEX_FROM_USE(USE)   phi_arg_index_from_use (USE)
 195
 196
 197 extern void init_ssa_operands (void);
 198 extern void fini_ssa_operands (void);
 199 extern void update_stmt_operands (gimple);
 200 extern void free_stmt_operands (gimple);
 201 extern bool verify_imm_links (FILE *f, tree var);
 202
 203 extern void copy_virtual_operands (gimple, gimple);
 204 extern int operand_build_cmp (const void *, const void *);
 205 extern void create_ssa_artificial_load_stmt (gimple, gimple, bool);
 206
 207 extern void dump_immediate_uses (FILE *file);
 208 extern void dump_immediate_uses_for (FILE *file, tree var);
 209 extern void debug_immediate_uses (void);
 210 extern void debug_immediate_uses_for (tree var);
 211 extern void dump_decl_set (FILE *, bitmap);
 212 extern void debug_decl_set (bitmap);
 213
 214 extern bool ssa_operands_active (void);
 215
 216 extern void push_stmt_changes (gimple *);
 217 extern void pop_stmt_changes (gimple *);
 218 extern void discard_stmt_changes (gimple *);
 219 void add_to_addressable_set (tree, bitmap *);
 220
 221 enum ssa_op_iter_type {
 222   ssa_op_iter_none = 0,
 223   ssa_op_iter_tree,
 224   ssa_op_iter_use,
 225   ssa_op_iter_def,
 226   ssa_op_iter_vdef
 227 };
 228
 229 /* This structure is used in the operand iterator loops.  It contains the
 230    items required to determine which operand is retrieved next.  During
 231    optimization, this structure is scalarized, and any unused fields are
 232    optimized away, resulting in little overhead.  */
 233
 234 typedef struct ssa_operand_iterator_d
 235 {
 236   def_optype_p defs;
 237   use_optype_p uses;
 238   voptype_p vuses;
 239   voptype_p vdefs;
 240   voptype_p mayuses;
 241   enum ssa_op_iter_type iter_type;
 242   int phi_i;
 243   int num_phi;
 244   gimple phi_stmt;
 245   bool done;
 246   unsigned int vuse_index;
 247   unsigned int mayuse_index;
 248 } ssa_op_iter;
 249
 250 /* These flags are used to determine which operands are returned during
 251    execution of the loop.  */
 252 #define SSA_OP_USE              0x01    /* Real USE operands.  */
 253 #define SSA_OP_DEF              0x02    /* Real DEF operands.  */
 254 #define SSA_OP_VUSE             0x04    /* VUSE operands.  */
 255 #define SSA_OP_VMAYUSE          0x08    /* USE portion of VDEFS.  */
 256 #define SSA_OP_VDEF             0x10    /* DEF portion of VDEFS.  */
 257
 258 /* These are commonly grouped operand flags.  */
 259 #define SSA_OP_VIRTUAL_USES     (SSA_OP_VUSE | SSA_OP_VMAYUSE)
 260 #define SSA_OP_VIRTUAL_DEFS     (SSA_OP_VDEF)
 261 #define SSA_OP_ALL_VIRTUALS     (SSA_OP_VIRTUAL_USES | SSA_OP_VIRTUAL_DEFS)
 262 #define SSA_OP_ALL_USES         (SSA_OP_VIRTUAL_USES | SSA_OP_USE)
 263 #define SSA_OP_ALL_DEFS         (SSA_OP_VIRTUAL_DEFS | SSA_OP_DEF)
 264 #define SSA_OP_ALL_OPERANDS     (SSA_OP_ALL_USES | SSA_OP_ALL_DEFS)
 265
 266 /* This macro executes a loop over the operands of STMT specified in FLAG,
 267    returning each operand as a 'tree' in the variable TREEVAR.  ITER is an
 268    ssa_op_iter structure used to control the loop.  */
 269 #define FOR_EACH_SSA_TREE_OPERAND(TREEVAR, STMT, ITER, FLAGS)   \
 270   for (TREEVAR = op_iter_init_tree (&(ITER), STMT, FLAGS);      \
 271        !op_iter_done (&(ITER));                                 \
 272        TREEVAR = op_iter_next_tree (&(ITER)))
 273
 274 /* This macro executes a loop over the operands of STMT specified in FLAG,
 275    returning each operand as a 'use_operand_p' in the variable USEVAR.
 276    ITER is an ssa_op_iter structure used to control the loop.  */
 277 #define FOR_EACH_SSA_USE_OPERAND(USEVAR, STMT, ITER, FLAGS)     \
 278   for (USEVAR = op_iter_init_use (&(ITER), STMT, FLAGS);        \
 279        !op_iter_done (&(ITER));                                 \
 280        USEVAR = op_iter_next_use (&(ITER)))
 281
 282 /* This macro executes a loop over the operands of STMT specified in FLAG,
 283    returning each operand as a 'def_operand_p' in the variable DEFVAR.
 284    ITER is an ssa_op_iter structure used to control the loop.  */
 285 #define FOR_EACH_SSA_DEF_OPERAND(DEFVAR, STMT, ITER, FLAGS)     \
 286   for (DEFVAR = op_iter_init_def (&(ITER), STMT, FLAGS);        \
 287        !op_iter_done (&(ITER));                                 \
 288        DEFVAR = op_iter_next_def (&(ITER)))
 289
 290 /* This macro executes a loop over the VDEF operands of STMT.  The def
 291    and use vector for each VDEF is returned in DEFVAR and USEVECT.
 292    ITER is an ssa_op_iter structure used to control the loop.  */
 293 #define FOR_EACH_SSA_VDEF_OPERAND(DEFVAR, USEVECT, STMT, ITER)  \
 294   for (op_iter_init_vdef (&(ITER), STMT, &(USEVECT), &(DEFVAR));        \
 295        !op_iter_done (&(ITER));                                 \
 296        op_iter_next_vdef (&(USEVECT), &(DEFVAR), &(ITER)))
 297
 298 /* This macro will execute a loop over all the arguments of a PHI which
 299    match FLAGS.   A use_operand_p is always returned via USEVAR.  FLAGS
 300    can be either SSA_OP_USE or SSA_OP_VIRTUAL_USES or SSA_OP_ALL_USES.  */
 301 #define FOR_EACH_PHI_ARG(USEVAR, STMT, ITER, FLAGS)             \
 302   for ((USEVAR) = op_iter_init_phiuse (&(ITER), STMT, FLAGS);   \
 303        !op_iter_done (&(ITER));                                 \
 304        (USEVAR) = op_iter_next_use (&(ITER)))
 305
 306
 307 /* This macro will execute a loop over a stmt, regardless of whether it is
 308    a real stmt or a PHI node, looking at the USE nodes matching FLAGS.  */
 309 #define FOR_EACH_PHI_OR_STMT_USE(USEVAR, STMT, ITER, FLAGS)     \
 310   for ((USEVAR) = (gimple_code (STMT) == GIMPLE_PHI             \
 311                    ? op_iter_init_phiuse (&(ITER), STMT, FLAGS) \
 312                    : op_iter_init_use (&(ITER), STMT, FLAGS));  \
 313        !op_iter_done (&(ITER));                                 \
 314        (USEVAR) = op_iter_next_use (&(ITER)))
 315
 316 /* This macro will execute a loop over a stmt, regardless of whether it is
 317    a real stmt or a PHI node, looking at the DEF nodes matching FLAGS.  */
 318 #define FOR_EACH_PHI_OR_STMT_DEF(DEFVAR, STMT, ITER, FLAGS)     \
 319   for ((DEFVAR) = (gimple_code (STMT) == GIMPLE_PHI             \
 320                    ? op_iter_init_phidef (&(ITER), STMT, FLAGS) \
 321                    : op_iter_init_def (&(ITER), STMT, FLAGS));  \
 322        !op_iter_done (&(ITER));                                 \
 323        (DEFVAR) = op_iter_next_def (&(ITER)))
 324
 325 /* This macro returns an operand in STMT as a tree if it is the ONLY
 326    operand matching FLAGS.  If there are 0 or more than 1 operand matching
 327    FLAGS, then NULL_TREE is returned.  */
 328 #define SINGLE_SSA_TREE_OPERAND(STMT, FLAGS)                    \
 329   single_ssa_tree_operand (STMT, FLAGS)
 330
 331 /* This macro returns an operand in STMT as a use_operand_p if it is the ONLY
 332    operand matching FLAGS.  If there are 0 or more than 1 operand matching
 333    FLAGS, then NULL_USE_OPERAND_P is returned.  */
 334 #define SINGLE_SSA_USE_OPERAND(STMT, FLAGS)                     \
 335   single_ssa_use_operand (STMT, FLAGS)
 336
 337 /* This macro returns an operand in STMT as a def_operand_p if it is the ONLY
 338    operand matching FLAGS.  If there are 0 or more than 1 operand matching
 339    FLAGS, then NULL_DEF_OPERAND_P is returned.  */
 340 #define SINGLE_SSA_DEF_OPERAND(STMT, FLAGS)                     \
 341   single_ssa_def_operand (STMT, FLAGS)
 342
 343 /* This macro returns TRUE if there are no operands matching FLAGS in STMT.  */
 344 #define ZERO_SSA_OPERANDS(STMT, FLAGS)  zero_ssa_operands (STMT, FLAGS)
 345
 346 /* This macro counts the number of operands in STMT matching FLAGS.  */
 347 #define NUM_SSA_OPERANDS(STMT, FLAGS)   num_ssa_operands (STMT, FLAGS)
 348
 349 #endif  /* GCC_TREE_SSA_OPERANDS_H  */