1 /* Interprocedural analyses.
2 Copyright (C) 2005, 2007, 2008 Free Software Foundation, Inc.
4 This file is part of GCC.
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
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
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/>. */
27 /* The following definitions and interfaces are used by
28 interprocedural analyses or parameters. */
30 /* ipa-prop.c stuff (ipa-cp, indirect inlining): */
32 /* A jump function for a callsite represents the values passed as actual
33 arguments of the callsite. There are three main types of values :
34 Formal - the caller's formal parameter is passed as an actual argument.
35 Constant - a constant is passed as an actual argument.
36 Unknown - neither of the above.
37 Integer and real constants are represented as IPA_JF_CONST.
38 Finally, IPA_JF_CONST_MEMBER_PTR stands for C++ member pointers
42 IPA_JF_UNKNOWN
= 0, /* newly allocated and zeroed jump functions default */
44 IPA_JF_CONST_MEMBER_PTR
,
48 /* All formal parameters in the program have a lattice associated with it
49 computed by the interprocedural stage of IPCP.
50 There are three main values of the lattice:
52 IPA_BOTTOM - non constant,
53 IPA_CONST_VALUE - simple scalar constant,
54 Cval of formal f will have a constant value if all callsites to this
55 function have the same constant value passed to f.
56 Integer and real constants are represented as IPA_CONST_VALUE. */
64 /* Structure holding a C++ member pointer constant. Holds a pointer to the
65 method and delta offset. */
66 struct ipa_member_ptr_cst
72 /* Represents a value of a jump function. formal_id is used only in jump
73 function context and represents pass-through parameter (the formal parameter
74 of the caller is passed as argument). constant represents the actual
75 constant in constant jump functions and member_cst holds constant c++ member
79 unsigned int formal_id
;
81 struct ipa_member_ptr_cst member_cst
;
84 /* A jump function for a callsite represents the values passed as actual
85 arguments of the callsite. See enum jump_func_type for the various
86 types of jump functions supported. */
89 enum jump_func_type type
;
90 union jump_func_value value
;
93 /* All formal parameters in the program have a cval computed by
94 the interprocedural stage of IPCP. See enum ipa_lattice_type for
95 the various types of lattices supported */
98 enum ipa_lattice_type type
;
102 /* Each instance of the following structure describes a statement that calls a
103 function parameter. Those referring to statements within the same function
104 are linked in a list. */
105 struct ipa_param_call_note
107 /* Linked list's next */
108 struct ipa_param_call_note
*next
;
109 /* Statement that contains the call to the parameter above. */
111 /* Index of the parameter that is called. */
112 unsigned int formal_id
;
113 /* Expected number of executions: calculated in profile.c. */
115 /* Expected frequency of executions within the function. see cgraph_edge in
116 cgraph.h for more on this. */
118 /* Depth of loop nest, 1 means no loop nest. */
120 /* Set when we have already found the target to be a compile time constant
121 and turned this into an edge or when the note was found unusable for some
126 /* Structure describing a single formal parameter. */
127 struct ipa_param_descriptor
129 /* IPA-CP lattice. */
130 struct ipcp_lattice ipcp_lattice
;
131 /* PARAM_DECL of this parameter. */
133 /* Whether the value parameter has been modified within the function. */
134 unsigned modified
: 1;
135 /* Whether the parameter has been used as a call destination. */
139 /* ipa_node_params stores information related to formal parameters of functions
140 and some other information for interprocedural passes that operate on
141 parameters (such as ipa-cp). */
142 struct ipa_node_params
144 /* Number of formal parameters of this function. When set to 0,
145 this function's parameters would not be analyzed by the different
148 /* Pointer to an array of structures describing individual formal
150 struct ipa_param_descriptor
*params
;
151 /* List of structures enumerating calls to a formal parameter. */
152 struct ipa_param_call_note
*param_calls
;
153 /* Only for versioned nodes this field would not be NULL,
154 it points to the node that IPA cp cloned from. */
155 struct cgraph_node
*ipcp_orig_node
;
156 /* Meaningful only for original functions. Expresses the
157 ratio between the direct calls and sum of all invocations of
158 this function (given by profiling info). It is used to calculate
159 the profiling information of the original function and the versioned
161 gcov_type count_scale
;
163 /* Whether this function is called with variable number of actual
165 unsigned called_with_var_arguments
: 1;
166 /* Whether the modification analysis has already been performed. */
167 unsigned modification_analysis_done
: 1;
168 /* Whether the param uses analysis has already been performed. */
169 unsigned uses_analysis_done
: 1;
170 /* Whether the function is enqueued in an ipa_func_list. */
171 unsigned node_enqueued
: 1;
174 /* ipa_node_params access functions. Please use these to access fields that
175 are or will be shared among various passes. */
177 /* Set the number of formal parameters. */
180 ipa_set_param_count (struct ipa_node_params
*info
, int count
)
182 info
->param_count
= count
;
185 /* Return the number of formal parameters. */
188 ipa_get_param_count (struct ipa_node_params
*info
)
190 return info
->param_count
;
193 /* Return the declaration of Ith formal parameter of the function corresponding
194 to INFO. Note there is no setter function as this array is built just once
195 using ipa_initialize_node_params. */
198 ipa_get_param (struct ipa_node_params
*info
, int i
)
200 return info
->params
[i
].decl
;
203 /* Return the modification flag corresponding to the Ith formal parameter of
204 the function associated with INFO. Note that there is no setter method as
205 the goal is to set all flags when building the array in
206 ipa_detect_param_modifications. */
209 ipa_is_param_modified (struct ipa_node_params
*info
, int i
)
211 return info
->params
[i
].modified
;
214 /* Return the called flag corresponding to the Ith formal parameter of the
215 function associated with INFO. Note that there is no setter method as the
216 goal is to set all flags when building the array in
217 ipa_detect_called_params. */
220 ipa_is_param_called (struct ipa_node_params
*info
, int i
)
222 return info
->params
[i
].called
;
225 /* Flag this node as having callers with variable number of arguments. */
228 ipa_set_called_with_variable_arg (struct ipa_node_params
*info
)
230 info
->called_with_var_arguments
= 1;
233 /* Have we detected this node was called with variable number of arguments? */
236 ipa_is_called_with_var_arguments (struct ipa_node_params
*info
)
238 return info
->called_with_var_arguments
;
243 /* ipa_edge_args stores information related to a callsite and particularly
244 its arguments. It is pointed to by a field in the
245 callsite's corresponding cgraph_edge. */
248 /* Number of actual arguments in this callsite. When set to 0,
249 this callsite's parameters would not be analyzed by the different
252 /* Array of the callsite's jump function of each parameter. */
253 struct ipa_jump_func
*jump_functions
;
256 /* ipa_edge_args access functions. Please use these to access fields that
257 are or will be shared among various passes. */
259 /* Set the number of actual arguments. */
262 ipa_set_cs_argument_count (struct ipa_edge_args
*args
, int count
)
264 args
->argument_count
= count
;
267 /* Return the number of actual arguments. */
270 ipa_get_cs_argument_count (struct ipa_edge_args
*args
)
272 return args
->argument_count
;
275 /* Returns a pointer to the jump function for the ith argument. Please note
276 there is no setter function as jump functions are all set up in
277 ipa_compute_jump_functions. */
279 static inline struct ipa_jump_func
*
280 ipa_get_ith_jump_func (struct ipa_edge_args
*args
, int i
)
282 return &args
->jump_functions
[i
];
285 /* Vectors need to have typedefs of structures. */
286 typedef struct ipa_node_params ipa_node_params_t
;
287 typedef struct ipa_edge_args ipa_edge_args_t
;
289 /* Types of vectors holding the infos. */
290 DEF_VEC_O (ipa_node_params_t
);
291 DEF_VEC_ALLOC_O (ipa_node_params_t
, heap
);
292 DEF_VEC_O (ipa_edge_args_t
);
293 DEF_VEC_ALLOC_O (ipa_edge_args_t
, heap
);
295 /* Vector where the parameter infos are actually stored. */
296 extern VEC (ipa_node_params_t
, heap
) *ipa_node_params_vector
;
297 /* Vector where the parameter infos are actually stored. */
298 extern VEC (ipa_edge_args_t
, heap
) *ipa_edge_args_vector
;
300 /* Return the associated parameter/argument info corresponding to the given
302 #define IPA_NODE_REF(NODE) (VEC_index (ipa_node_params_t, \
303 ipa_node_params_vector, (NODE)->uid))
304 #define IPA_EDGE_REF(EDGE) (VEC_index (ipa_edge_args_t, \
305 ipa_edge_args_vector, (EDGE)->uid))
306 /* This macro checks validity of index returned by
307 ipa_get_param_decl_index function. */
308 #define IS_VALID_JUMP_FUNC_INDEX(I) ((I) != -1)
310 /* Creating and freeing ipa_node_params and ipa_edge_args. */
311 void ipa_create_all_node_params (void);
312 void ipa_create_all_edge_args (void);
313 void ipa_free_edge_args_substructures (struct ipa_edge_args
*);
314 void ipa_free_node_params_substructures (struct ipa_node_params
*);
315 void ipa_free_all_node_params (void);
316 void ipa_free_all_edge_args (void);
317 void free_all_ipa_structures_after_ipa_cp (void);
318 void free_all_ipa_structures_after_iinln (void);
319 void ipa_register_cgraph_hooks (void);
321 /* This function ensures the array of node param infos is big enough to
322 accommodate a structure for all nodes and reallocates it if not. */
325 ipa_check_create_node_params (void)
327 if (!ipa_node_params_vector
)
328 ipa_node_params_vector
= VEC_alloc (ipa_node_params_t
, heap
,
331 if (VEC_length (ipa_node_params_t
, ipa_node_params_vector
)
332 <= (unsigned) cgraph_max_uid
)
333 VEC_safe_grow_cleared (ipa_node_params_t
, heap
,
334 ipa_node_params_vector
, cgraph_max_uid
+ 1);
337 /* This function ensures the array of edge arguments infos is big enough to
338 accommodate a structure for all edges and reallocates it if not. */
341 ipa_check_create_edge_args (void)
343 if (!ipa_edge_args_vector
)
344 ipa_edge_args_vector
= VEC_alloc (ipa_edge_args_t
, heap
,
345 cgraph_edge_max_uid
);
347 if (VEC_length (ipa_edge_args_t
, ipa_edge_args_vector
)
348 <= (unsigned) cgraph_edge_max_uid
)
349 VEC_safe_grow_cleared (ipa_edge_args_t
, heap
, ipa_edge_args_vector
,
350 cgraph_edge_max_uid
+ 1);
353 /* Returns true if the array of edge infos is large enough to accommodate an
354 info for EDGE. The main purpose of this function is that debug dumping
355 function can check info availability without causing reallocations. */
358 ipa_edge_args_info_available_for_edge_p (struct cgraph_edge
*edge
)
360 return ((unsigned) edge
->uid
< VEC_length (ipa_edge_args_t
,
361 ipa_edge_args_vector
));
364 /* A function list element. It is used to create a temporary worklist used in
365 the propagation stage of IPCP. (can be used for more IPA optimizations) */
368 struct cgraph_node
*node
;
369 struct ipa_func_list
*next
;
372 /* ipa_func_list interface. */
373 struct ipa_func_list
*ipa_init_func_list (void);
374 void ipa_push_func_to_list_1 (struct ipa_func_list
**, struct cgraph_node
*,
375 struct ipa_node_params
*);
376 struct cgraph_node
*ipa_pop_func_from_list (struct ipa_func_list
**);
378 /* Add cgraph NODE to the worklist WL if it is not already in one. */
381 ipa_push_func_to_list (struct ipa_func_list
**wl
, struct cgraph_node
*node
)
383 struct ipa_node_params
*info
= IPA_NODE_REF (node
);
385 if (!info
->node_enqueued
)
386 ipa_push_func_to_list_1 (wl
, node
, info
);
389 /* Callsite related calculations. */
390 void ipa_compute_jump_functions (struct cgraph_edge
*);
391 void ipa_count_arguments (struct cgraph_edge
*);
393 /* Function formal parameters related computations. */
394 void ipa_initialize_node_params (struct cgraph_node
*node
);
395 void ipa_detect_param_modifications (struct cgraph_node
*);
396 void ipa_analyze_params_uses (struct cgraph_node
*);
397 bool ipa_propagate_indirect_call_infos (struct cgraph_edge
*cs
,
398 VEC (cgraph_edge_p
, heap
) **new_edges
);
400 /* Debugging interface. */
401 void ipa_print_node_params (FILE *, struct cgraph_node
*node
);
402 void ipa_print_all_params (FILE *);
403 void ipa_print_node_jump_functions (FILE *f
, struct cgraph_node
*node
);
404 void ipa_print_all_jump_functions (FILE * f
);
406 #endif /* IPA_PROP_H */