GCC Middle and Back End API Reference
tree-ssa-operands.h
Go to the documentation of this file.
1/* SSA operand management for trees.
2 Copyright (C) 2003-2024 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along 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. */
28
29/* This represents a pointer to a USE operand. */
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 USE operands of a stmt. */
42typedef struct use_optype_d *use_optype_p;
43
44/* This structure represents a variable sized buffer which is allocated by the
45 operand memory manager. Operands are suballocated out of this block. The
46 MEM array varies in size. */
47
48struct GTY((chain_next("%h.next"))) ssa_operand_memory_d {
50 char mem[1];
51};
52
53/* Per-function operand caches. */
54struct GTY(()) ssa_operands {
57 /* Current size of the operand memory buffer. */
59
61
62 struct use_optype_d * GTY ((skip (""))) free_uses;
63};
64
65#define USE_FROM_PTR(PTR) get_use_from_ptr (PTR)
66#define DEF_FROM_PTR(PTR) get_def_from_ptr (PTR)
67#define SET_USE(USE, V) set_ssa_use_from_ptr (USE, V)
68#define SET_DEF(DEF, V) ((*(DEF)) = (V))
69
70#define USE_STMT(USE) (USE)->loc.stmt
71
72#define USE_OP_PTR(OP) (&((OP)->use_ptr))
73#define USE_OP(OP) (USE_FROM_PTR (USE_OP_PTR (OP)))
74
75#define PHI_RESULT(PHI) gimple_phi_result (PHI)
76#define SET_PHI_RESULT(PHI, V) SET_DEF (gimple_phi_result_ptr (PHI), (V))
77#define PHI_ARG_DEF_PTR(PHI, I) gimple_phi_arg_imm_use_ptr ((PHI), (I))
78#define PHI_ARG_DEF(PHI, I) gimple_phi_arg_def ((PHI), (I))
79#define SET_PHI_ARG_DEF(PHI, I, V) \
80 SET_USE (PHI_ARG_DEF_PTR ((PHI), (I)), (V))
81#define SET_PHI_ARG_DEF_ON_EDGE(PHI, E, V) \
82 SET_USE (gimple_phi_arg_imm_use_ptr_from_edge \
83 ((PHI), (E)), (V))
84#define PHI_ARG_DEF_FROM_EDGE(PHI, E) \
85 gimple_phi_arg_def_from_edge ((PHI), (E))
86#define PHI_ARG_DEF_PTR_FROM_EDGE(PHI, E) \
87 gimple_phi_arg_imm_use_ptr_from_edge ((PHI), (E))
88#define PHI_ARG_INDEX_FROM_USE(USE) phi_arg_index_from_use (USE)
89
90
91extern bool ssa_operands_active (struct function *);
92extern void init_ssa_operands (struct function *fn);
93extern void fini_ssa_operands (struct function *);
94extern bool verify_ssa_operands (struct function *, gimple *stmt);
95extern void free_stmt_operands (struct function *, gimple *);
96extern void update_stmt_operands (struct function *, gimple *);
97extern void swap_ssa_operands (gimple *, tree *, tree *);
98extern bool verify_imm_links (FILE *f, tree var);
99
100extern void dump_immediate_uses_for (FILE *file, tree var);
101extern void dump_immediate_uses (FILE *file);
102extern void debug_immediate_uses (void);
103extern void debug_immediate_uses_for (tree var);
104
105extern void unlink_stmt_vdef (gimple *);
106
107/* Return the tree pointed-to by USE. */
108inline tree
110{
111 return *(use->use);
112}
113
114/* Return the tree pointed-to by DEF. */
115inline tree
117{
118 return *def;
119}
120
121#endif /* GCC_TREE_SSA_OPERANDS_H */
#define GTY(x)
Definition coretypes.h:41
union tree_node * tree
Definition coretypes.h:97
Definition loop-invariant.cc:88
Definition function.h:249
Definition gimple.h:221
Definition tree-ssa-operands.h:48
char mem[1]
Definition tree-ssa-operands.h:50
struct ssa_operand_memory_d * next
Definition tree-ssa-operands.h:49
Definition tree-ssa-operands.h:54
bool ops_active
Definition tree-ssa-operands.h:60
struct ssa_operand_memory_d * operand_memory
Definition tree-ssa-operands.h:55
unsigned operand_memory_index
Definition tree-ssa-operands.h:56
struct use_optype_d * free_uses
Definition tree-ssa-operands.h:62
unsigned int ssa_operand_mem_size
Definition tree-ssa-operands.h:58
Definition tree-core.h:1678
Definition tree-ssa-operands.h:38
struct ssa_use_operand_t use_ptr
Definition tree-ssa-operands.h:40
struct use_optype_d * next
Definition tree-ssa-operands.h:39
Definition loop-invariant.cc:78
DEBUG_FUNCTION void debug_immediate_uses(void)
Definition tree-ssa-operands.cc:1346
void dump_immediate_uses(FILE *file)
Definition tree-ssa-operands.cc:1330
void swap_ssa_operands(gimple *stmt, tree *exp0, tree *exp1)
Definition tree-ssa-operands.cc:1157
bool ssa_operands_active(struct function *fun)
Definition tree-ssa-operands.cc:219
void free_stmt_operands(struct function *fn, gimple *stmt)
Definition tree-ssa-operands.cc:1111
void unlink_stmt_vdef(gimple *stmt)
Definition tree-ssa-operands.cc:1364
void init_ssa_operands(struct function *fn)
Definition tree-ssa-operands.cc:270
void dump_immediate_uses_for(FILE *file, tree var)
Definition tree-ssa-operands.cc:1296
DEBUG_FUNCTION bool verify_imm_links(FILE *f, tree var)
Definition tree-ssa-operands.cc:1204
DEBUG_FUNCTION bool verify_ssa_operands(struct function *fn, gimple *stmt)
Definition tree-ssa-operands.cc:1101
void fini_ssa_operands(struct function *fn)
Definition tree-ssa-operands.cc:284
DEBUG_FUNCTION void debug_immediate_uses_for(tree var)
Definition tree-ssa-operands.cc:1355
void update_stmt_operands(struct function *fn, gimple *stmt)
Definition tree-ssa-operands.cc:1136
tree * def_operand_p
Definition tree-ssa-operands.h:27
tree get_use_from_ptr(use_operand_p use)
Definition tree-ssa-operands.h:109
struct use_optype_d * use_optype_p
Definition tree-ssa-operands.h:42
void dump_immediate_uses(FILE *file)
Definition tree-ssa-operands.cc:1330
void update_stmt_operands(struct function *, gimple *)
Definition tree-ssa-operands.cc:1136
tree get_def_from_ptr(def_operand_p def)
Definition tree-ssa-operands.h:116
void fini_ssa_operands(struct function *)
Definition tree-ssa-operands.cc:284
bool verify_imm_links(FILE *f, tree var)
Definition tree-ssa-operands.cc:1204
ssa_use_operand_t * use_operand_p
Definition tree-ssa-operands.h:30
void unlink_stmt_vdef(gimple *)
Definition tree-ssa-operands.cc:1364
void debug_immediate_uses(void)
Definition tree-ssa-operands.cc:1346
bool verify_ssa_operands(struct function *, gimple *stmt)
Definition tree-ssa-operands.cc:1101
void free_stmt_operands(struct function *, gimple *)
Definition tree-ssa-operands.cc:1111
void init_ssa_operands(struct function *fn)
Definition tree-ssa-operands.cc:270
bool ssa_operands_active(struct function *)
Definition tree-ssa-operands.cc:219
void dump_immediate_uses_for(FILE *file, tree var)
Definition tree-ssa-operands.cc:1296
void swap_ssa_operands(gimple *, tree *, tree *)
Definition tree-ssa-operands.cc:1157
void debug_immediate_uses_for(tree var)
Definition tree-ssa-operands.cc:1355