1169689Skan/* SSA operand management for trees. 2169689Skan Copyright (C) 2003, 2005 Free Software Foundation, Inc. 3169689Skan 4169689SkanThis file is part of GCC. 5169689Skan 6169689SkanGCC is free software; you can redistribute it and/or modify it under 7169689Skanthe terms of the GNU General Public License as published by the Free 8169689SkanSoftware Foundation; either version 2, or (at your option) any later 9169689Skanversion. 10169689Skan 11169689SkanGCC is distributed in the hope that it will be useful, but WITHOUT ANY 12169689SkanWARRANTY; without even the implied warranty of MERCHANTABILITY or 13169689SkanFITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14169689Skanfor more details. 15169689Skan 16169689SkanYou should have received a copy of the GNU General Public License 17169689Skanalong with GCC; see the file COPYING. If not, write to the Free 18169689SkanSoftware Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 19169689Skan02110-1301, USA. */ 20169689Skan 21169689Skan#ifndef GCC_TREE_SSA_OPERANDS_H 22169689Skan#define GCC_TREE_SSA_OPERANDS_H 23169689Skan 24169689Skan/* Interface to SSA operands. */ 25169689Skan 26169689Skan 27169689Skan/* This represents a pointer to a DEF operand. */ 28169689Skantypedef tree *def_operand_p; 29169689Skan 30169689Skan/* This represents a pointer to a USE operand. */ 31169689Skantypedef ssa_use_operand_t *use_operand_p; 32169689Skan 33169689Skan/* NULL operand types. */ 34169689Skan#define NULL_USE_OPERAND_P NULL 35169689Skan#define NULL_DEF_OPERAND_P NULL 36169689Skan 37169689Skan/* This represents the DEF operands of a stmt. */ 38169689Skanstruct def_optype_d 39169689Skan{ 40169689Skan struct def_optype_d *next; 41169689Skan tree *def_ptr; 42169689Skan}; 43169689Skantypedef struct def_optype_d *def_optype_p; 44169689Skan 45169689Skan/* This represents the USE operands of a stmt. */ 46169689Skanstruct use_optype_d 47169689Skan{ 48169689Skan struct use_optype_d *next; 49169689Skan struct ssa_use_operand_d use_ptr; 50169689Skan}; 51169689Skantypedef struct use_optype_d *use_optype_p; 52169689Skan 53169689Skan/* This represents the MAY_DEFS for a stmt. */ 54169689Skanstruct maydef_optype_d 55169689Skan{ 56169689Skan struct maydef_optype_d *next; 57169689Skan tree def_var; 58169689Skan tree use_var; 59169689Skan struct ssa_use_operand_d use_ptr; 60169689Skan}; 61169689Skantypedef struct maydef_optype_d *maydef_optype_p; 62169689Skan 63169689Skan/* This represents the VUSEs for a stmt. */ 64169689Skanstruct vuse_optype_d 65169689Skan{ 66169689Skan struct vuse_optype_d *next; 67169689Skan tree use_var; 68169689Skan struct ssa_use_operand_d use_ptr; 69169689Skan}; 70169689Skantypedef struct vuse_optype_d *vuse_optype_p; 71169689Skan 72169689Skan/* This represents the V_MUST_DEFS for a stmt. */ 73169689Skanstruct mustdef_optype_d 74169689Skan{ 75169689Skan struct mustdef_optype_d *next; 76169689Skan tree def_var; 77169689Skan tree kill_var; 78169689Skan struct ssa_use_operand_d use_ptr; 79169689Skan}; 80169689Skantypedef struct mustdef_optype_d *mustdef_optype_p; 81169689Skan 82169689Skan 83169689Skan#define SSA_OPERAND_MEMORY_SIZE (2048 - sizeof (void *)) 84169689Skan 85169689Skanstruct ssa_operand_memory_d GTY((chain_next("%h.next"))) 86169689Skan{ 87169689Skan struct ssa_operand_memory_d *next; 88169689Skan char mem[SSA_OPERAND_MEMORY_SIZE]; 89169689Skan}; 90169689Skan 91169689Skan 92169689Skan/* This represents the operand cache for a stmt. */ 93169689Skanstruct stmt_operands_d 94169689Skan{ 95169689Skan /* Statement operands. */ 96169689Skan struct def_optype_d * def_ops; 97169689Skan struct use_optype_d * use_ops; 98169689Skan 99169689Skan /* Virtual operands (V_MAY_DEF, VUSE, and V_MUST_DEF). */ 100169689Skan struct maydef_optype_d * maydef_ops; 101169689Skan struct vuse_optype_d * vuse_ops; 102169689Skan struct mustdef_optype_d * mustdef_ops; 103169689Skan}; 104169689Skan 105169689Skantypedef struct stmt_operands_d *stmt_operands_p; 106169689Skan 107169689Skan#define USE_FROM_PTR(PTR) get_use_from_ptr (PTR) 108169689Skan#define DEF_FROM_PTR(PTR) get_def_from_ptr (PTR) 109169689Skan#define SET_USE(USE, V) set_ssa_use_from_ptr (USE, V) 110169689Skan#define SET_DEF(DEF, V) ((*(DEF)) = (V)) 111169689Skan 112169689Skan#define USE_STMT(USE) (USE)->stmt 113169689Skan 114169689Skan#define DEF_OPS(STMT) (stmt_ann (STMT)->operands.def_ops) 115169689Skan#define USE_OPS(STMT) (stmt_ann (STMT)->operands.use_ops) 116169689Skan#define VUSE_OPS(STMT) (stmt_ann (STMT)->operands.vuse_ops) 117169689Skan#define MAYDEF_OPS(STMT) (stmt_ann (STMT)->operands.maydef_ops) 118169689Skan#define MUSTDEF_OPS(STMT) (stmt_ann (STMT)->operands.mustdef_ops) 119169689Skan 120169689Skan#define USE_OP_PTR(OP) (&((OP)->use_ptr)) 121169689Skan#define USE_OP(OP) (USE_FROM_PTR (USE_OP_PTR (OP))) 122169689Skan 123169689Skan#define DEF_OP_PTR(OP) ((OP)->def_ptr) 124169689Skan#define DEF_OP(OP) (DEF_FROM_PTR (DEF_OP_PTR (OP))) 125169689Skan 126169689Skan#define VUSE_OP_PTR(OP) USE_OP_PTR(OP) 127169689Skan#define VUSE_OP(OP) ((OP)->use_var) 128169689Skan 129169689Skan#define MAYDEF_RESULT_PTR(OP) (&((OP)->def_var)) 130169689Skan#define MAYDEF_RESULT(OP) ((OP)->def_var) 131169689Skan#define MAYDEF_OP_PTR(OP) USE_OP_PTR (OP) 132169689Skan#define MAYDEF_OP(OP) ((OP)->use_var) 133169689Skan 134169689Skan#define MUSTDEF_RESULT_PTR(OP) (&((OP)->def_var)) 135169689Skan#define MUSTDEF_RESULT(OP) ((OP)->def_var) 136169689Skan#define MUSTDEF_KILL_PTR(OP) USE_OP_PTR (OP) 137169689Skan#define MUSTDEF_KILL(OP) ((OP)->kill_var) 138169689Skan 139169689Skan#define PHI_RESULT_PTR(PHI) get_phi_result_ptr (PHI) 140169689Skan#define PHI_RESULT(PHI) DEF_FROM_PTR (PHI_RESULT_PTR (PHI)) 141169689Skan#define SET_PHI_RESULT(PHI, V) SET_DEF (PHI_RESULT_PTR (PHI), (V)) 142169689Skan 143169689Skan#define PHI_ARG_DEF_PTR(PHI, I) get_phi_arg_def_ptr ((PHI), (I)) 144169689Skan#define PHI_ARG_DEF(PHI, I) USE_FROM_PTR (PHI_ARG_DEF_PTR ((PHI), (I))) 145169689Skan#define SET_PHI_ARG_DEF(PHI, I, V) \ 146169689Skan SET_USE (PHI_ARG_DEF_PTR ((PHI), (I)), (V)) 147169689Skan#define PHI_ARG_DEF_FROM_EDGE(PHI, E) \ 148169689Skan PHI_ARG_DEF ((PHI), (E)->dest_idx) 149169689Skan#define PHI_ARG_DEF_PTR_FROM_EDGE(PHI, E) \ 150169689Skan PHI_ARG_DEF_PTR ((PHI), (E)->dest_idx) 151169689Skan#define PHI_ARG_INDEX_FROM_USE(USE) phi_arg_index_from_use (USE) 152169689Skan 153169689Skan 154169689Skanextern void init_ssa_operands (void); 155169689Skanextern void fini_ssa_operands (void); 156169689Skanextern void free_ssa_operands (stmt_operands_p); 157169689Skanextern void update_stmt_operands (tree); 158169689Skanextern bool verify_imm_links (FILE *f, tree var); 159169689Skan 160169689Skanextern void copy_virtual_operands (tree, tree); 161169689Skanextern void create_ssa_artficial_load_stmt (tree, tree); 162169689Skan 163169689Skanextern void dump_immediate_uses (FILE *file); 164169689Skanextern void dump_immediate_uses_for (FILE *file, tree var); 165169689Skanextern void debug_immediate_uses (void); 166169689Skanextern void debug_immediate_uses_for (tree var); 167169689Skan 168169689Skanextern bool ssa_operands_active (void); 169169689Skan 170169689Skanextern void add_to_addressable_set (tree, bitmap *); 171169689Skan 172169689Skanenum ssa_op_iter_type { 173169689Skan ssa_op_iter_none = 0, 174169689Skan ssa_op_iter_tree, 175169689Skan ssa_op_iter_use, 176169689Skan ssa_op_iter_def, 177169689Skan ssa_op_iter_maymustdef 178169689Skan}; 179169689Skan/* This structure is used in the operand iterator loops. It contains the 180169689Skan items required to determine which operand is retrieved next. During 181169689Skan optimization, this structure is scalarized, and any unused fields are 182169689Skan optimized away, resulting in little overhead. */ 183169689Skan 184169689Skantypedef struct ssa_operand_iterator_d 185169689Skan{ 186169689Skan def_optype_p defs; 187169689Skan use_optype_p uses; 188169689Skan vuse_optype_p vuses; 189169689Skan maydef_optype_p maydefs; 190169689Skan maydef_optype_p mayuses; 191169689Skan mustdef_optype_p mustdefs; 192169689Skan mustdef_optype_p mustkills; 193169689Skan enum ssa_op_iter_type iter_type; 194169689Skan int phi_i; 195169689Skan int num_phi; 196169689Skan tree phi_stmt; 197169689Skan bool done; 198169689Skan} ssa_op_iter; 199169689Skan 200169689Skan/* These flags are used to determine which operands are returned during 201169689Skan execution of the loop. */ 202169689Skan#define SSA_OP_USE 0x01 /* Real USE operands. */ 203169689Skan#define SSA_OP_DEF 0x02 /* Real DEF operands. */ 204169689Skan#define SSA_OP_VUSE 0x04 /* VUSE operands. */ 205169689Skan#define SSA_OP_VMAYUSE 0x08 /* USE portion of V_MAY_DEFS. */ 206169689Skan#define SSA_OP_VMAYDEF 0x10 /* DEF portion of V_MAY_DEFS. */ 207169689Skan#define SSA_OP_VMUSTDEF 0x20 /* V_MUST_DEF definitions. */ 208169689Skan#define SSA_OP_VMUSTKILL 0x40 /* V_MUST_DEF kills. */ 209169689Skan 210169689Skan/* These are commonly grouped operand flags. */ 211169689Skan#define SSA_OP_VIRTUAL_USES (SSA_OP_VUSE | SSA_OP_VMAYUSE) 212169689Skan#define SSA_OP_VIRTUAL_DEFS (SSA_OP_VMAYDEF | SSA_OP_VMUSTDEF) 213169689Skan#define SSA_OP_VIRTUAL_KILLS (SSA_OP_VMUSTKILL) 214169689Skan#define SSA_OP_ALL_VIRTUALS (SSA_OP_VIRTUAL_USES | SSA_OP_VIRTUAL_KILLS \ 215169689Skan | SSA_OP_VIRTUAL_DEFS) 216169689Skan#define SSA_OP_ALL_USES (SSA_OP_VIRTUAL_USES | SSA_OP_USE) 217169689Skan#define SSA_OP_ALL_DEFS (SSA_OP_VIRTUAL_DEFS | SSA_OP_DEF) 218169689Skan#define SSA_OP_ALL_KILLS (SSA_OP_VIRTUAL_KILLS) 219169689Skan#define SSA_OP_ALL_OPERANDS (SSA_OP_ALL_USES | SSA_OP_ALL_DEFS \ 220169689Skan | SSA_OP_ALL_KILLS) 221169689Skan 222169689Skan/* This macro executes a loop over the operands of STMT specified in FLAG, 223169689Skan returning each operand as a 'tree' in the variable TREEVAR. ITER is an 224169689Skan ssa_op_iter structure used to control the loop. */ 225169689Skan#define FOR_EACH_SSA_TREE_OPERAND(TREEVAR, STMT, ITER, FLAGS) \ 226169689Skan for (TREEVAR = op_iter_init_tree (&(ITER), STMT, FLAGS); \ 227169689Skan !op_iter_done (&(ITER)); \ 228169689Skan TREEVAR = op_iter_next_tree (&(ITER))) 229169689Skan 230169689Skan/* This macro executes a loop over the operands of STMT specified in FLAG, 231169689Skan returning each operand as a 'use_operand_p' in the variable USEVAR. 232169689Skan ITER is an ssa_op_iter structure used to control the loop. */ 233169689Skan#define FOR_EACH_SSA_USE_OPERAND(USEVAR, STMT, ITER, FLAGS) \ 234169689Skan for (USEVAR = op_iter_init_use (&(ITER), STMT, FLAGS); \ 235169689Skan !op_iter_done (&(ITER)); \ 236169689Skan USEVAR = op_iter_next_use (&(ITER))) 237169689Skan 238169689Skan/* This macro executes a loop over the operands of STMT specified in FLAG, 239169689Skan returning each operand as a 'def_operand_p' in the variable DEFVAR. 240169689Skan ITER is an ssa_op_iter structure used to control the loop. */ 241169689Skan#define FOR_EACH_SSA_DEF_OPERAND(DEFVAR, STMT, ITER, FLAGS) \ 242169689Skan for (DEFVAR = op_iter_init_def (&(ITER), STMT, FLAGS); \ 243169689Skan !op_iter_done (&(ITER)); \ 244169689Skan DEFVAR = op_iter_next_def (&(ITER))) 245169689Skan 246169689Skan/* This macro executes a loop over the V_MAY_DEF operands of STMT. The def 247169689Skan and use for each V_MAY_DEF is returned in DEFVAR and USEVAR. 248169689Skan ITER is an ssa_op_iter structure used to control the loop. */ 249169689Skan#define FOR_EACH_SSA_MAYDEF_OPERAND(DEFVAR, USEVAR, STMT, ITER) \ 250169689Skan for (op_iter_init_maydef (&(ITER), STMT, &(USEVAR), &(DEFVAR)); \ 251169689Skan !op_iter_done (&(ITER)); \ 252169689Skan op_iter_next_maymustdef (&(USEVAR), &(DEFVAR), &(ITER))) 253169689Skan 254169689Skan/* This macro executes a loop over the V_MUST_DEF operands of STMT. The def 255169689Skan and kill for each V_MUST_DEF is returned in DEFVAR and KILLVAR. 256169689Skan ITER is an ssa_op_iter structure used to control the loop. */ 257169689Skan#define FOR_EACH_SSA_MUSTDEF_OPERAND(DEFVAR, KILLVAR, STMT, ITER) \ 258169689Skan for (op_iter_init_mustdef (&(ITER), STMT, &(KILLVAR), &(DEFVAR)); \ 259169689Skan !op_iter_done (&(ITER)); \ 260169689Skan op_iter_next_maymustdef (&(KILLVAR), &(DEFVAR), &(ITER))) 261169689Skan 262169689Skan/* This macro executes a loop over the V_{MUST,MAY}_DEF of STMT. The def 263169689Skan and kill for each V_{MUST,MAY}_DEF is returned in DEFVAR and KILLVAR. 264169689Skan ITER is an ssa_op_iter structure used to control the loop. */ 265169689Skan#define FOR_EACH_SSA_MUST_AND_MAY_DEF_OPERAND(DEFVAR, KILLVAR, STMT, ITER)\ 266169689Skan for (op_iter_init_must_and_may_def (&(ITER), STMT, &(KILLVAR), &(DEFVAR));\ 267169689Skan !op_iter_done (&(ITER)); \ 268169689Skan op_iter_next_maymustdef (&(KILLVAR), &(DEFVAR), &(ITER))) 269169689Skan 270169689Skan/* This macro will execute a loop over all the arguments of a PHI which 271169689Skan match FLAGS. A use_operand_p is always returned via USEVAR. FLAGS 272169689Skan can be either SSA_OP_USE or SSA_OP_VIRTUAL_USES or SSA_OP_ALL_USES. */ 273169689Skan#define FOR_EACH_PHI_ARG(USEVAR, STMT, ITER, FLAGS) \ 274169689Skan for ((USEVAR) = op_iter_init_phiuse (&(ITER), STMT, FLAGS); \ 275169689Skan !op_iter_done (&(ITER)); \ 276169689Skan (USEVAR) = op_iter_next_use (&(ITER))) 277169689Skan 278169689Skan 279169689Skan/* This macro will execute a loop over a stmt, regardless of whether it is 280169689Skan a real stmt or a PHI node, looking at the USE nodes matching FLAGS. */ 281169689Skan#define FOR_EACH_PHI_OR_STMT_USE(USEVAR, STMT, ITER, FLAGS) \ 282169689Skan for ((USEVAR) = (TREE_CODE (STMT) == PHI_NODE \ 283169689Skan ? op_iter_init_phiuse (&(ITER), STMT, FLAGS) \ 284169689Skan : op_iter_init_use (&(ITER), STMT, FLAGS)); \ 285169689Skan !op_iter_done (&(ITER)); \ 286169689Skan (USEVAR) = op_iter_next_use (&(ITER))) 287169689Skan 288169689Skan/* This macro will execute a loop over a stmt, regardless of whether it is 289169689Skan a real stmt or a PHI node, looking at the DEF nodes matching FLAGS. */ 290169689Skan#define FOR_EACH_PHI_OR_STMT_DEF(DEFVAR, STMT, ITER, FLAGS) \ 291169689Skan for ((DEFVAR) = (TREE_CODE (STMT) == PHI_NODE \ 292169689Skan ? op_iter_init_phidef (&(ITER), STMT, FLAGS) \ 293169689Skan : op_iter_init_def (&(ITER), STMT, FLAGS)); \ 294169689Skan !op_iter_done (&(ITER)); \ 295169689Skan (DEFVAR) = op_iter_next_def (&(ITER))) 296169689Skan 297169689Skan/* This macro returns an operand in STMT as a tree if it is the ONLY 298169689Skan operand matching FLAGS. If there are 0 or more than 1 operand matching 299169689Skan FLAGS, then NULL_TREE is returned. */ 300169689Skan#define SINGLE_SSA_TREE_OPERAND(STMT, FLAGS) \ 301169689Skan single_ssa_tree_operand (STMT, FLAGS) 302169689Skan 303169689Skan/* This macro returns an operand in STMT as a use_operand_p if it is the ONLY 304169689Skan operand matching FLAGS. If there are 0 or more than 1 operand matching 305169689Skan FLAGS, then NULL_USE_OPERAND_P is returned. */ 306169689Skan#define SINGLE_SSA_USE_OPERAND(STMT, FLAGS) \ 307169689Skan single_ssa_use_operand (STMT, FLAGS) 308169689Skan 309169689Skan/* This macro returns an operand in STMT as a def_operand_p if it is the ONLY 310169689Skan operand matching FLAGS. If there are 0 or more than 1 operand matching 311169689Skan FLAGS, then NULL_DEF_OPERAND_P is returned. */ 312169689Skan#define SINGLE_SSA_DEF_OPERAND(STMT, FLAGS) \ 313169689Skan single_ssa_def_operand (STMT, FLAGS) 314169689Skan 315169689Skan/* This macro returns TRUE if there are no operands matching FLAGS in STMT. */ 316169689Skan#define ZERO_SSA_OPERANDS(STMT, FLAGS) zero_ssa_operands (STMT, FLAGS) 317169689Skan 318169689Skan/* This macro counts the number of operands in STMT matching FLAGS. */ 319169689Skan#define NUM_SSA_OPERANDS(STMT, FLAGS) num_ssa_operands (STMT, FLAGS) 320169689Skan 321169689Skan#endif /* GCC_TREE_SSA_OPERANDS_H */ 322