]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/ipa-prop.h
Run selftests for C++ as well as C
[thirdparty/gcc.git] / gcc / ipa-prop.h
CommitLineData
518dc859 1/* Interprocedural analyses.
85ec4feb 2 Copyright (C) 2005-2018 Free Software Foundation, Inc.
518dc859
RL
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
9dcd6f09 8Software Foundation; either version 3, or (at your option) any later
518dc859
RL
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
9dcd6f09
NC
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
518dc859
RL
19
20#ifndef IPA_PROP_H
21#define IPA_PROP_H
22
518dc859 23/* The following definitions and interfaces are used by
133f9369
MJ
24 interprocedural analyses or parameters. */
25
4502fe8d
MJ
26#define IPA_UNDESCRIBED_USE -1
27
133f9369 28/* ipa-prop.c stuff (ipa-cp, indirect inlining): */
518dc859 29
be95e2b9 30/* A jump function for a callsite represents the values passed as actual
310bc633
MJ
31 arguments of the callsite. They were originally proposed in a paper called
32 "Interprocedural Constant Propagation", by David Callahan, Keith D Cooper,
33 Ken Kennedy, Linda Torczon in Comp86, pg 152-161. There are three main
34 types of values :
685b0d13
MJ
35
36 Pass-through - the caller's formal parameter is passed as an actual
37 argument, possibly one simple operation performed on it.
38 Constant - a constant (is_gimple_ip_invariant)is passed as an actual
39 argument.
40 Unknown - neither of the above.
41
b258210c
MJ
42 IPA_JF_ANCESTOR is a special pass-through jump function, which means that
43 the result is an address of a part of the object pointed to by the formal
44 parameter to which the function refers. It is mainly intended to represent
026c3cfd 45 getting addresses of ancestor fields in C++
b258210c
MJ
46 (e.g. &this_1(D)->D.1766.D.1756). Note that if the original pointer is
47 NULL, ancestor jump function must behave like a simple pass-through.
48
49 Other pass-through functions can either simply pass on an unchanged formal
50 parameter or can apply one simple binary operation to it (such jump
51 functions are called polynomial).
52
b258210c
MJ
53 Jump functions are computed in ipa-prop.c by function
54 update_call_notes_after_inlining. Some information can be lost and jump
55 functions degraded accordingly when inlining, see
56 update_call_notes_after_inlining in the same file. */
685b0d13 57
518dc859
RL
58enum jump_func_type
59{
133f9369 60 IPA_JF_UNKNOWN = 0, /* newly allocated and zeroed jump functions default */
b258210c 61 IPA_JF_CONST, /* represented by field costant */
b258210c
MJ
62 IPA_JF_PASS_THROUGH, /* represented by field pass_through */
63 IPA_JF_ANCESTOR /* represented by field ancestor */
518dc859
RL
64};
65
4502fe8d
MJ
66struct ipa_cst_ref_desc;
67
68/* Structure holding data required to describe a constant jump function. */
69struct GTY(()) ipa_constant_data
70{
71 /* THe value of the constant. */
72 tree value;
73 /* Pointer to the structure that describes the reference. */
74 struct ipa_cst_ref_desc GTY((skip)) *rdesc;
75};
76
685b0d13
MJ
77/* Structure holding data required to describe a pass-through jump function. */
78
fb3f88cc 79struct GTY(()) ipa_pass_through_data
685b0d13
MJ
80{
81 /* If an operation is to be performed on the original parameter, this is the
82 second (constant) operand. */
83 tree operand;
84 /* Number of the caller's formal parameter being passed. */
85 int formal_id;
86 /* Operation that is performed on the argument before it is passed on.
87 NOP_EXPR means no operation. Otherwise oper must be a simple binary
88 arithmetic operation where the caller's parameter is the first operand and
89 operand field from this structure is the second one. */
90 enum tree_code operation;
8b7773a4
MJ
91 /* When the passed value is a pointer, it is set to true only when we are
92 certain that no write to the object it points to has occurred since the
93 caller functions started execution, except for changes noted in the
94 aggregate part of the jump function (see description of
95 ipa_agg_jump_function). The flag is used only when the operation is
96 NOP_EXPR. */
b8f6e610 97 unsigned agg_preserved : 1;
685b0d13
MJ
98};
99
b258210c
MJ
100/* Structure holding data required to describe an ancestor pass-through
101 jump function. */
685b0d13 102
fb3f88cc 103struct GTY(()) ipa_ancestor_jf_data
685b0d13
MJ
104{
105 /* Offset of the field representing the ancestor. */
106 HOST_WIDE_INT offset;
685b0d13
MJ
107 /* Number of the caller's formal parameter being passed. */
108 int formal_id;
8b7773a4 109 /* Flag with the same meaning like agg_preserve in ipa_pass_through_data. */
b8f6e610 110 unsigned agg_preserved : 1;
685b0d13
MJ
111};
112
8b7773a4
MJ
113/* An element in an aggegate part of a jump function describing a known value
114 at a given offset. When it is part of a pass-through jump function with
115 agg_preserved set or an ancestor jump function with agg_preserved set, all
116 unlisted positions are assumed to be preserved but the value can be a type
117 node, which means that the particular piece (starting at offset and having
118 the size of the type) is clobbered with an unknown value. When
119 agg_preserved is false or the type of the containing jump function is
120 different, all unlisted parts are assumed to be unknown and all values must
688010ba 121 fulfill is_gimple_ip_invariant. */
8b7773a4 122
84562394 123struct GTY(()) ipa_agg_jf_item
8b7773a4
MJ
124{
125 /* The offset at which the known value is located within the aggregate. */
126 HOST_WIDE_INT offset;
127
128 /* The known constant or type if this is a clobber. */
129 tree value;
84562394 130};
8b7773a4 131
8b7773a4
MJ
132
133/* Aggregate jump function - i.e. description of contents of aggregates passed
134 either by reference or value. */
135
136struct GTY(()) ipa_agg_jump_function
3e293154 137{
8b7773a4 138 /* Description of the individual items. */
84562394 139 vec<ipa_agg_jf_item, va_gc> *items;
8b7773a4
MJ
140 /* True if the data was passed by reference (as opposed to by value). */
141 bool by_ref;
3e293154
MJ
142};
143
8b7773a4 144typedef struct ipa_agg_jump_function *ipa_agg_jump_function_p;
8b7773a4 145
209ca542
PK
146/* Information about zero/non-zero bits. */
147struct GTY(()) ipa_bits
148{
149 /* The propagated value. */
150 widest_int value;
151 /* Mask corresponding to the value.
152 Similar to ccp_lattice_t, if xth bit of mask is 0,
153 implies xth bit of value is constant. */
154 widest_int mask;
209ca542
PK
155};
156
8bc5448f 157/* Info about value ranges. */
86cd0334 158
8bc5448f
KV
159struct GTY(()) ipa_vr
160{
161 /* The data fields below are valid only if known is true. */
162 bool known;
163 enum value_range_type type;
164 wide_int min;
165 wide_int max;
166};
167
be95e2b9
MJ
168/* A jump function for a callsite represents the values passed as actual
169 arguments of the callsite. See enum jump_func_type for the various
518dc859 170 types of jump functions supported. */
84562394 171struct GTY (()) ipa_jump_func
518dc859 172{
8b7773a4
MJ
173 /* Aggregate contants description. See struct ipa_agg_jump_function and its
174 description. */
175 struct ipa_agg_jump_function agg;
176
86cd0334
MJ
177 /* Information about zero/non-zero bits. The pointed to structure is shared
178 betweed different jump functions. Use ipa_set_jfunc_bits to set this
179 field. */
180 struct ipa_bits *bits;
209ca542 181
a5e14a42 182 /* Information about value range, containing valid data only when vr_known is
86cd0334
MJ
183 true. The pointed to structure is shared betweed different jump
184 functions. Use ipa_set_jfunc_vr to set this field. */
185 struct value_range *m_vr;
8bc5448f 186
518dc859 187 enum jump_func_type type;
fb3f88cc
JH
188 /* Represents a value of a jump function. pass_through is used only in jump
189 function context. constant represents the actual constant in constant jump
190 functions and member_cst holds constant c++ member functions. */
191 union jump_func_value
192 {
4502fe8d 193 struct ipa_constant_data GTY ((tag ("IPA_JF_CONST"))) constant;
fb3f88cc
JH
194 struct ipa_pass_through_data GTY ((tag ("IPA_JF_PASS_THROUGH"))) pass_through;
195 struct ipa_ancestor_jf_data GTY ((tag ("IPA_JF_ANCESTOR"))) ancestor;
fb3f88cc 196 } GTY ((desc ("%1.type"))) value;
84562394 197};
606d9a09 198
518dc859 199
7b872d9e
MJ
200/* Return the constant stored in a constant jump functin JFUNC. */
201
202static inline tree
203ipa_get_jf_constant (struct ipa_jump_func *jfunc)
204{
205 gcc_checking_assert (jfunc->type == IPA_JF_CONST);
4502fe8d
MJ
206 return jfunc->value.constant.value;
207}
208
209static inline struct ipa_cst_ref_desc *
210ipa_get_jf_constant_rdesc (struct ipa_jump_func *jfunc)
211{
212 gcc_checking_assert (jfunc->type == IPA_JF_CONST);
213 return jfunc->value.constant.rdesc;
7b872d9e
MJ
214}
215
216/* Return the operand of a pass through jmp function JFUNC. */
217
218static inline tree
219ipa_get_jf_pass_through_operand (struct ipa_jump_func *jfunc)
220{
221 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
222 return jfunc->value.pass_through.operand;
223}
224
225/* Return the number of the caller's formal parameter that a pass through jump
226 function JFUNC refers to. */
227
228static inline int
229ipa_get_jf_pass_through_formal_id (struct ipa_jump_func *jfunc)
230{
231 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
232 return jfunc->value.pass_through.formal_id;
233}
234
235/* Return operation of a pass through jump function JFUNC. */
236
237static inline enum tree_code
238ipa_get_jf_pass_through_operation (struct ipa_jump_func *jfunc)
239{
240 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
241 return jfunc->value.pass_through.operation;
242}
243
b8f6e610 244/* Return the agg_preserved flag of a pass through jump function JFUNC. */
8b7773a4
MJ
245
246static inline bool
247ipa_get_jf_pass_through_agg_preserved (struct ipa_jump_func *jfunc)
248{
249 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
250 return jfunc->value.pass_through.agg_preserved;
251}
252
44210a96
MJ
253/* Return true if pass through jump function JFUNC preserves type
254 information. */
b8f6e610
MJ
255
256static inline bool
257ipa_get_jf_pass_through_type_preserved (struct ipa_jump_func *jfunc)
258{
259 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
44210a96 260 return jfunc->value.pass_through.agg_preserved;
b8f6e610
MJ
261}
262
7b872d9e
MJ
263/* Return the offset of an ancestor jump function JFUNC. */
264
265static inline HOST_WIDE_INT
266ipa_get_jf_ancestor_offset (struct ipa_jump_func *jfunc)
267{
268 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
269 return jfunc->value.ancestor.offset;
270}
271
7b872d9e
MJ
272/* Return the number of the caller's formal parameter that an ancestor jump
273 function JFUNC refers to. */
274
275static inline int
276ipa_get_jf_ancestor_formal_id (struct ipa_jump_func *jfunc)
277{
278 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
279 return jfunc->value.ancestor.formal_id;
280}
281
b8f6e610 282/* Return the agg_preserved flag of an ancestor jump function JFUNC. */
7b872d9e 283
8b7773a4
MJ
284static inline bool
285ipa_get_jf_ancestor_agg_preserved (struct ipa_jump_func *jfunc)
7b872d9e 286{
8b7773a4
MJ
287 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
288 return jfunc->value.ancestor.agg_preserved;
7b872d9e
MJ
289}
290
44210a96 291/* Return true if ancestor jump function JFUNC presrves type information. */
b8f6e610
MJ
292
293static inline bool
294ipa_get_jf_ancestor_type_preserved (struct ipa_jump_func *jfunc)
295{
296 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
44210a96 297 return jfunc->value.ancestor.agg_preserved;
b8f6e610
MJ
298}
299
310bc633 300/* Summary describing a single formal parameter. */
b258210c 301
f65f1ae3 302struct GTY(()) ipa_param_descriptor
f8e2a1ed 303{
209ca542
PK
304 /* In analysis and modification phase, this is the PARAM_DECL of this
305 parameter, in IPA LTO phase, this is the type of the the described
306 parameter or NULL if not known. Do not read this field directly but
307 through ipa_get_param and ipa_get_type as appropriate. */
308 tree decl_or_type;
4502fe8d
MJ
309 /* If all uses of the parameter are described by ipa-prop structures, this
310 says how many there are. If any use could not be described by means of
311 ipa-prop structures, this is IPA_UNDESCRIBED_USE. */
312 int controlled_uses;
0e8853ee 313 unsigned int move_cost : 31;
339f49ec
JH
314 /* The parameter is used. */
315 unsigned used : 1;
f8e2a1ed
MJ
316};
317
dcd416e3
MJ
318/* ipa_node_params stores information related to formal parameters of functions
319 and some other information for interprocedural passes that operate on
320 parameters (such as ipa-cp). */
310bc633 321
f65f1ae3 322struct GTY((for_user)) ipa_node_params
518dc859 323{
e806796d
ML
324 /* Default constructor. */
325 ipa_node_params ();
326
327 /* Default destructor. */
328 ~ipa_node_params ();
329
310bc633
MJ
330 /* Information about individual formal parameters that are gathered when
331 summaries are generated. */
f65f1ae3 332 vec<ipa_param_descriptor, va_gc> *descriptors;
310bc633
MJ
333 /* Pointer to an array of structures describing individual formal
334 parameters. */
f65f1ae3 335 struct ipcp_param_lattices * GTY((skip)) lattices;
310bc633
MJ
336 /* Only for versioned nodes this field would not be NULL,
337 it points to the node that IPA cp cloned from. */
f65f1ae3 338 struct cgraph_node * GTY((skip)) ipcp_orig_node;
44210a96
MJ
339 /* If this node is an ipa-cp clone, these are the known constants that
340 describe what it has been specialized for. */
f65f1ae3 341 vec<tree> GTY((skip)) known_csts;
44210a96
MJ
342 /* If this node is an ipa-cp clone, these are the known polymorphic contexts
343 that describe what it has been specialized for. */
f65f1ae3 344 vec<ipa_polymorphic_call_context> GTY((skip)) known_contexts;
8aab5218
MJ
345 /* Whether the param uses analysis and jump function computation has already
346 been performed. */
347 unsigned analysis_done : 1;
310bc633 348 /* Whether the function is enqueued in ipa-cp propagation stack. */
448f65db 349 unsigned node_enqueued : 1;
310bc633
MJ
350 /* Whether we should create a specialized version based on values that are
351 known to be constant in all contexts. */
eb20b778
MJ
352 unsigned do_clone_for_all_contexts : 1;
353 /* Set if this is an IPA-CP clone for all contexts. */
354 unsigned is_all_contexts_clone : 1;
310bc633
MJ
355 /* Node has been completely replaced by clones and will be removed after
356 ipa-cp is finished. */
357 unsigned node_dead : 1;
af21714c
MJ
358 /* Node is involved in a recursion, potentionally indirect. */
359 unsigned node_within_scc : 1;
360 /* Node is calling a private function called only once. */
361 unsigned node_calling_single_call : 1;
7e729474
ML
362 /* False when there is something makes versioning impossible. */
363 unsigned versionable : 1;
518dc859
RL
364};
365
e806796d
ML
366inline
367ipa_node_params::ipa_node_params ()
368: descriptors (NULL), lattices (NULL), ipcp_orig_node (NULL),
369 known_csts (vNULL), known_contexts (vNULL), analysis_done (0),
370 node_enqueued (0), do_clone_for_all_contexts (0), is_all_contexts_clone (0),
371 node_dead (0), node_within_scc (0), node_calling_single_call (0),
372 versionable (0)
373{
374}
375
376inline
377ipa_node_params::~ipa_node_params ()
378{
379 free (lattices);
380 known_csts.release ();
381 known_contexts.release ();
382}
383
ff302741
PB
384/* Intermediate information that we get from alias analysis about a particular
385 parameter in a particular basic_block. When a parameter or the memory it
56b40062
MJ
386 references is marked modified, we use that information in all dominated
387 blocks without consulting alias analysis oracle. */
ff302741 388
56b40062 389struct ipa_param_aa_status
ff302741
PB
390{
391 /* Set when this structure contains meaningful information. If not, the
392 structure describing a dominating BB should be used instead. */
393 bool valid;
394
395 /* Whether we have seen something which might have modified the data in
396 question. PARM is for the parameter itself, REF is for data it points to
397 but using the alias type of individual accesses and PT is the same thing
398 but for computing aggregate pass-through functions using a very inclusive
399 ao_ref. */
400 bool parm_modified, ref_modified, pt_modified;
401};
402
403/* Information related to a given BB that used only when looking at function
404 body. */
405
406struct ipa_bb_info
407{
408 /* Call graph edges going out of this BB. */
409 vec<cgraph_edge *> cg_edges;
410 /* Alias analysis statuses of each formal parameter at this bb. */
56b40062 411 vec<ipa_param_aa_status> param_aa_statuses;
ff302741
PB
412};
413
414/* Structure with global information that is only used when looking at function
415 body. */
416
56b40062 417struct ipa_func_body_info
ff302741
PB
418{
419 /* The node that is being analyzed. */
420 cgraph_node *node;
421
422 /* Its info. */
423 struct ipa_node_params *info;
424
425 /* Information about individual BBs. */
426 vec<ipa_bb_info> bb_infos;
427
428 /* Number of parameters. */
429 int param_count;
430
431 /* Number of statements already walked by when analyzing this function. */
432 unsigned int aa_walked;
433};
434
dcd416e3
MJ
435/* ipa_node_params access functions. Please use these to access fields that
436 are or will be shared among various passes. */
437
dcd416e3 438/* Return the number of formal parameters. */
be95e2b9 439
dcd416e3
MJ
440static inline int
441ipa_get_param_count (struct ipa_node_params *info)
442{
f65f1ae3 443 return vec_safe_length (info->descriptors);
dcd416e3
MJ
444}
445
f8e2a1ed
MJ
446/* Return the declaration of Ith formal parameter of the function corresponding
447 to INFO. Note there is no setter function as this array is built just once
209ca542
PK
448 using ipa_initialize_node_params. This function should not be called in
449 WPA. */
be95e2b9 450
dcd416e3 451static inline tree
f8e2a1ed 452ipa_get_param (struct ipa_node_params *info, int i)
dcd416e3 453{
f65f1ae3 454 gcc_checking_assert (info->descriptors);
0e8853ee 455 gcc_checking_assert (!flag_wpa);
f65f1ae3 456 tree t = (*info->descriptors)[i].decl_or_type;
209ca542
PK
457 gcc_checking_assert (TREE_CODE (t) == PARM_DECL);
458 return t;
459}
460
461/* Return the type of Ith formal parameter of the function corresponding
462 to INFO if it is known or NULL if not. */
463
464static inline tree
465ipa_get_type (struct ipa_node_params *info, int i)
466{
e5cf5e11
PK
467 if (vec_safe_length (info->descriptors) <= (unsigned) i)
468 return NULL;
f65f1ae3 469 tree t = (*info->descriptors)[i].decl_or_type;
209ca542
PK
470 if (!t)
471 return NULL;
472 if (TYPE_P (t))
473 return t;
474 gcc_checking_assert (TREE_CODE (t) == PARM_DECL);
475 return TREE_TYPE (t);
339f49ec
JH
476}
477
0e8853ee
JH
478/* Return the move cost of Ith formal parameter of the function corresponding
479 to INFO. */
480
481static inline int
482ipa_get_param_move_cost (struct ipa_node_params *info, int i)
483{
f65f1ae3
MJ
484 gcc_checking_assert (info->descriptors);
485 return (*info->descriptors)[i].move_cost;
0e8853ee
JH
486}
487
310bc633
MJ
488/* Set the used flag corresponding to the Ith formal parameter of the function
489 associated with INFO to VAL. */
3949c4a7 490
310bc633
MJ
491static inline void
492ipa_set_param_used (struct ipa_node_params *info, int i, bool val)
3949c4a7 493{
f65f1ae3
MJ
494 gcc_checking_assert (info->descriptors);
495 (*info->descriptors)[i].used = val;
3949c4a7
MJ
496}
497
4502fe8d
MJ
498/* Return how many uses described by ipa-prop a parameter has or
499 IPA_UNDESCRIBED_USE if there is a use that is not described by these
500 structures. */
501static inline int
502ipa_get_controlled_uses (struct ipa_node_params *info, int i)
503{
f65f1ae3
MJ
504 /* FIXME: introducing speculation causes out of bounds access here. */
505 if (vec_safe_length (info->descriptors) > (unsigned)i)
506 return (*info->descriptors)[i].controlled_uses;
5ce97055 507 return IPA_UNDESCRIBED_USE;
4502fe8d
MJ
508}
509
510/* Set the controlled counter of a given parameter. */
511
512static inline void
513ipa_set_controlled_uses (struct ipa_node_params *info, int i, int val)
514{
f65f1ae3
MJ
515 gcc_checking_assert (info->descriptors);
516 (*info->descriptors)[i].controlled_uses = val;
4502fe8d
MJ
517}
518
310bc633
MJ
519/* Return the used flag corresponding to the Ith formal parameter of the
520 function associated with INFO. */
3949c4a7
MJ
521
522static inline bool
310bc633 523ipa_is_param_used (struct ipa_node_params *info, int i)
3949c4a7 524{
f65f1ae3
MJ
525 gcc_checking_assert (info->descriptors);
526 return (*info->descriptors)[i].used;
3949c4a7
MJ
527}
528
2c9561b5
MJ
529/* Information about replacements done in aggregates for a given node (each
530 node has its linked list). */
531struct GTY(()) ipa_agg_replacement_value
532{
533 /* Next item in the linked list. */
534 struct ipa_agg_replacement_value *next;
535 /* Offset within the aggregate. */
536 HOST_WIDE_INT offset;
537 /* The constant value. */
538 tree value;
539 /* The paramter index. */
540 int index;
7b920a9a
MJ
541 /* Whether the value was passed by reference. */
542 bool by_ref;
2c9561b5
MJ
543};
544
04be694e
MJ
545/* Structure holding information for the transformation phase of IPA-CP. */
546
9d3e0adc 547struct GTY(()) ipcp_transformation
04be694e
MJ
548{
549 /* Linked list of known aggregate values. */
550 ipa_agg_replacement_value *agg_values;
209ca542 551 /* Known bits information. */
86cd0334 552 vec<ipa_bits *, va_gc> *bits;
8bc5448f
KV
553 /* Value range information. */
554 vec<ipa_vr, va_gc> *m_vr;
04be694e 555};
2c9561b5
MJ
556
557void ipa_set_node_agg_value_chain (struct cgraph_node *node,
558 struct ipa_agg_replacement_value *aggvals);
9d3e0adc 559void ipcp_transformation_initialize (void);
2c9561b5 560
93c594a3
MJ
561/* ipa_edge_args stores information related to a callsite and particularly its
562 arguments. It can be accessed by the IPA_EDGE_REF macro. */
6fe906a3
MJ
563
564class GTY((for_user)) ipa_edge_args
518dc859 565{
6fe906a3
MJ
566 public:
567
568 /* Default constructor. */
569 ipa_edge_args () : jump_functions (NULL), polymorphic_call_contexts (NULL)
570 {}
571
572 /* Destructor. */
573 ~ipa_edge_args ()
574 {
575 vec_free (jump_functions);
576 vec_free (polymorphic_call_contexts);
577 }
578
579 /* Vectors of the callsite's jump function and polymorphic context
580 information of each parameter. */
84562394 581 vec<ipa_jump_func, va_gc> *jump_functions;
5ce97055 582 vec<ipa_polymorphic_call_context, va_gc> *polymorphic_call_contexts;
84562394 583};
518dc859 584
dcd416e3
MJ
585/* ipa_edge_args access functions. Please use these to access fields that
586 are or will be shared among various passes. */
587
dcd416e3 588/* Return the number of actual arguments. */
be95e2b9 589
dcd416e3
MJ
590static inline int
591ipa_get_cs_argument_count (struct ipa_edge_args *args)
592{
9771b263 593 return vec_safe_length (args->jump_functions);
dcd416e3
MJ
594}
595
596/* Returns a pointer to the jump function for the ith argument. Please note
597 there is no setter function as jump functions are all set up in
598 ipa_compute_jump_functions. */
be95e2b9 599
dcd416e3
MJ
600static inline struct ipa_jump_func *
601ipa_get_ith_jump_func (struct ipa_edge_args *args, int i)
602{
9771b263 603 return &(*args->jump_functions)[i];
dcd416e3
MJ
604}
605
5ce97055
JH
606/* Returns a pointer to the polymorphic call context for the ith argument.
607 NULL if contexts are not computed. */
608static inline struct ipa_polymorphic_call_context *
609ipa_get_ith_polymorhic_call_context (struct ipa_edge_args *args, int i)
610{
611 if (!args->polymorphic_call_contexts)
612 return NULL;
613 return &(*args->polymorphic_call_contexts)[i];
614}
615
9a1e784a 616/* Function summary for ipa_node_params. */
f65f1ae3 617class GTY((user)) ipa_node_params_t: public function_summary <ipa_node_params *>
dd912cb8
ML
618{
619public:
f65f1ae3
MJ
620 ipa_node_params_t (symbol_table *table, bool ggc):
621 function_summary<ipa_node_params *> (table, ggc) { }
771578a0 622
dd912cb8
ML
623 /* Hook that is called by summary when a node is duplicated. */
624 virtual void duplicate (cgraph_node *node,
625 cgraph_node *node2,
626 ipa_node_params *data,
627 ipa_node_params *data2);
628};
629
6fe906a3
MJ
630/* Summary to manange ipa_edge_args structures. */
631
632class GTY((user)) ipa_edge_args_sum_t : public call_summary <ipa_edge_args *>
633{
634 public:
635 ipa_edge_args_sum_t (symbol_table *table, bool ggc)
636 : call_summary<ipa_edge_args *> (table, ggc) { }
637
638 /* Hook that is called by summary when an edge is duplicated. */
639 virtual void remove (cgraph_edge *cs, ipa_edge_args *args);
640 /* Hook that is called by summary when an edge is duplicated. */
641 virtual void duplicate (cgraph_edge *src,
642 cgraph_edge *dst,
643 ipa_edge_args *old_args,
644 ipa_edge_args *new_args);
645};
646
dd912cb8 647/* Function summary where the parameter infos are actually stored. */
f65f1ae3 648extern GTY(()) ipa_node_params_t * ipa_node_params_sum;
6fe906a3
MJ
649/* Call summary to store information about edges such as jump functions. */
650extern GTY(()) ipa_edge_args_sum_t *ipa_edge_args_sum;
f65f1ae3 651
9d3e0adc
ML
652/* Function summary for IPA-CP transformation. */
653class ipcp_transformation_t
654: public function_summary<ipcp_transformation *>
655{
656public:
657 ipcp_transformation_t (symbol_table *table, bool ggc):
658 function_summary<ipcp_transformation *> (table, ggc) {}
659
660 ~ipcp_transformation_t () {}
661
662 static ipcp_transformation_t *create_ggc (symbol_table *symtab)
663 {
664 ipcp_transformation_t *summary
665 = new (ggc_cleared_alloc <ipcp_transformation_t> ())
666 ipcp_transformation_t (symtab, true);
667 return summary;
668 }
669};
670
671/* Function summary where the IPA CP transformations are actually stored. */
672extern GTY(()) function_summary <ipcp_transformation *> *ipcp_transformation_sum;
f65f1ae3 673
771578a0
MJ
674/* Return the associated parameter/argument info corresponding to the given
675 node/edge. */
99353fcf
ML
676#define IPA_NODE_REF(NODE) (ipa_node_params_sum->get_create (NODE))
677#define IPA_EDGE_REF(EDGE) (ipa_edge_args_sum->get_create (EDGE))
771578a0
MJ
678/* This macro checks validity of index returned by
679 ipa_get_param_decl_index function. */
680#define IS_VALID_JUMP_FUNC_INDEX(I) ((I) != -1)
681
682/* Creating and freeing ipa_node_params and ipa_edge_args. */
683void ipa_create_all_node_params (void);
684void ipa_create_all_edge_args (void);
86cd0334 685void ipa_check_create_edge_args (void);
771578a0
MJ
686void ipa_free_all_node_params (void);
687void ipa_free_all_edge_args (void);
e33c6cd6
MJ
688void ipa_free_all_structures_after_ipa_cp (void);
689void ipa_free_all_structures_after_iinln (void);
dd912cb8 690
771578a0 691void ipa_register_cgraph_hooks (void);
fd29c024 692int count_formal_params (tree fndecl);
771578a0
MJ
693
694/* This function ensures the array of node param infos is big enough to
be95e2b9
MJ
695 accommodate a structure for all nodes and reallocates it if not. */
696
771578a0
MJ
697static inline void
698ipa_check_create_node_params (void)
699{
dd912cb8 700 if (!ipa_node_params_sum)
f65f1ae3
MJ
701 ipa_node_params_sum
702 = (new (ggc_cleared_alloc <ipa_node_params_t> ())
703 ipa_node_params_t (symtab, true));
771578a0
MJ
704}
705
6fe906a3
MJ
706/* Returns true if edge summary contains a record for EDGE. The main purpose
707 of this function is that debug dumping function can check info availability
708 without causing allocations. */
be95e2b9 709
0eae6bab
MJ
710static inline bool
711ipa_edge_args_info_available_for_edge_p (struct cgraph_edge *edge)
712{
6fe906a3 713 return ipa_edge_args_sum->exists (edge);
0eae6bab
MJ
714}
715
9d3e0adc 716static inline ipcp_transformation *
04be694e
MJ
717ipcp_get_transformation_summary (cgraph_node *node)
718{
9d3e0adc 719 if (ipcp_transformation_sum == NULL)
04be694e 720 return NULL;
9d3e0adc
ML
721
722 return ipcp_transformation_sum->get (node);
04be694e
MJ
723}
724
2c9561b5
MJ
725/* Return the aggregate replacements for NODE, if there are any. */
726
727static inline struct ipa_agg_replacement_value *
04be694e 728ipa_get_agg_replacements_for_node (cgraph_node *node)
2c9561b5 729{
9d3e0adc 730 ipcp_transformation *ts = ipcp_get_transformation_summary (node);
04be694e 731 return ts ? ts->agg_values : NULL;
2c9561b5
MJ
732}
733
f8e2a1ed
MJ
734/* Function formal parameters related computations. */
735void ipa_initialize_node_params (struct cgraph_node *node);
f8e2a1ed 736bool ipa_propagate_indirect_call_infos (struct cgraph_edge *cs,
d52f5295 737 vec<cgraph_edge *> *new_edges);
518dc859 738
3949c4a7 739/* Indirect edge and binfo processing. */
d2d668fb 740tree ipa_get_indirect_edge_target (struct cgraph_edge *ie,
9771b263 741 vec<tree> ,
44210a96 742 vec<ipa_polymorphic_call_context>,
231b4916
JH
743 vec<ipa_agg_jump_function_p>,
744 bool *);
5ce97055
JH
745struct cgraph_edge *ipa_make_edge_direct_to_target (struct cgraph_edge *, tree,
746 bool speculative = false);
72972c22 747tree ipa_impossible_devirt_target (struct cgraph_edge *, tree);
86cd0334
MJ
748ipa_bits *ipa_get_ipa_bits_for_value (const widest_int &value,
749 const widest_int &mask);
750
3949c4a7 751
310bc633
MJ
752/* Functions related to both. */
753void ipa_analyze_node (struct cgraph_node *);
3949c4a7 754
8b7773a4 755/* Aggregate jump function related functions. */
91bb9f80
MJ
756tree ipa_find_agg_cst_for_param (struct ipa_agg_jump_function *agg, tree scalar,
757 HOST_WIDE_INT offset, bool by_ref,
758 bool *from_global_constant = NULL);
759bool ipa_load_from_parm_agg (struct ipa_func_body_info *fbi,
f65f1ae3 760 vec<ipa_param_descriptor, va_gc> *descriptors,
91bb9f80
MJ
761 gimple *stmt, tree op, int *index_p,
762 HOST_WIDE_INT *offset_p, HOST_WIDE_INT *size_p,
763 bool *by_ref, bool *guaranteed_unmodified = NULL);
8b7773a4 764
518dc859 765/* Debugging interface. */
ca30a539
JH
766void ipa_print_node_params (FILE *, struct cgraph_node *node);
767void ipa_print_all_params (FILE *);
3e293154
MJ
768void ipa_print_node_jump_functions (FILE *f, struct cgraph_node *node);
769void ipa_print_all_jump_functions (FILE * f);
310bc633
MJ
770void ipcp_verify_propagated_values (void);
771
2651e637
ML
772template <typename value>
773class ipcp_value;
774
fb0b2914
ML
775extern object_allocator<ipcp_value<tree> > ipcp_cst_values_pool;
776extern object_allocator<ipcp_value<ipa_polymorphic_call_context> >
2651e637
ML
777 ipcp_poly_ctx_values_pool;
778
779template <typename valtype>
780class ipcp_value_source;
781
fb0b2914 782extern object_allocator<ipcp_value_source<tree> > ipcp_sources_pool;
2651e637
ML
783
784class ipcp_agg_lattice;
785
fb0b2914 786extern object_allocator<ipcp_agg_lattice> ipcp_agg_lattice_pool;
518dc859 787
2c9561b5
MJ
788void ipa_dump_agg_replacement_values (FILE *f,
789 struct ipa_agg_replacement_value *av);
f27c1867 790void ipa_prop_write_jump_functions (void);
fb3f88cc 791void ipa_prop_read_jump_functions (void);
04be694e
MJ
792void ipcp_write_transformation_summaries (void);
793void ipcp_read_transformation_summaries (void);
632b4f8e 794int ipa_get_param_decl_index (struct ipa_node_params *, tree);
d2d668fb 795tree ipa_value_from_jfunc (struct ipa_node_params *info,
e5cf5e11 796 struct ipa_jump_func *jfunc, tree type);
2c9561b5 797unsigned int ipcp_transform_function (struct cgraph_node *node);
44210a96
MJ
798ipa_polymorphic_call_context ipa_context_from_jfunc (ipa_node_params *,
799 cgraph_edge *,
800 int,
801 ipa_jump_func *);
0e8853ee 802void ipa_dump_param (FILE *, struct ipa_node_params *info, int i);
c3431191 803void ipa_release_body_info (struct ipa_func_body_info *);
5d5f1e95 804tree ipa_get_callee_param_type (struct cgraph_edge *e, int i);
fb3f88cc 805
3f84bf08 806/* From tree-sra.c: */
f7ed3195 807tree build_ref_for_offset (location_t, tree, poly_int64, bool, tree,
e4b5cace 808 gimple_stmt_iterator *, bool);
3f84bf08 809
3edf64aa
DM
810/* In ipa-cp.c */
811void ipa_cp_c_finalize (void);
812
518dc859 813#endif /* IPA_PROP_H */