gcc/tree-ssa-operands.h

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