]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/ipa-prop.h
[Ada] Add the System.Bitfield_Utils runtime unit
[thirdparty/gcc.git] / gcc / ipa-prop.h
CommitLineData
3b22db66 1/* Interprocedural analyses.
fbd26352 2 Copyright (C) 2005-2019 Free Software Foundation, Inc.
3b22db66 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
8c4c00c1 8Software Foundation; either version 3, or (at your option) any later
3b22db66 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
8c4c00c1 17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
3b22db66 19
20#ifndef IPA_PROP_H
21#define IPA_PROP_H
22
3b22db66 23/* The following definitions and interfaces are used by
ba3a7ba0 24 interprocedural analyses or parameters. */
25
096295f6 26#define IPA_UNDESCRIBED_USE -1
27
ba3a7ba0 28/* ipa-prop.c stuff (ipa-cp, indirect inlining): */
3b22db66 29
1917e945 30/* A jump function for a callsite represents the values passed as actual
821d0e0f 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 :
5215027d 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
6378ffb3 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
47ae02b7 45 getting addresses of ancestor fields in C++
6378ffb3 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
6378ffb3 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. */
5215027d 57
3b22db66 58enum jump_func_type
59{
ba3a7ba0 60 IPA_JF_UNKNOWN = 0, /* newly allocated and zeroed jump functions default */
6378ffb3 61 IPA_JF_CONST, /* represented by field costant */
6378ffb3 62 IPA_JF_PASS_THROUGH, /* represented by field pass_through */
63 IPA_JF_ANCESTOR /* represented by field ancestor */
3b22db66 64};
65
096295f6 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
5215027d 77/* Structure holding data required to describe a pass-through jump function. */
78
8867b500 79struct GTY(()) ipa_pass_through_data
5215027d 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;
0d491188 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. */
ad4a8b28 97 unsigned agg_preserved : 1;
5215027d 98};
99
6378ffb3 100/* Structure holding data required to describe an ancestor pass-through
101 jump function. */
5215027d 102
8867b500 103struct GTY(()) ipa_ancestor_jf_data
5215027d 104{
105 /* Offset of the field representing the ancestor. */
106 HOST_WIDE_INT offset;
5215027d 107 /* Number of the caller's formal parameter being passed. */
108 int formal_id;
0d491188 109 /* Flag with the same meaning like agg_preserve in ipa_pass_through_data. */
ad4a8b28 110 unsigned agg_preserved : 1;
5215027d 111};
112
0d491188 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
a04e8d62 121 fulfill is_gimple_ip_invariant. */
0d491188 122
b3e7c666 123struct GTY(()) ipa_agg_jf_item
0d491188 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;
b3e7c666 130};
0d491188 131
0d491188 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
f8daee9b 137{
0d491188 138 /* Description of the individual items. */
b3e7c666 139 vec<ipa_agg_jf_item, va_gc> *items;
0d491188 140 /* True if the data was passed by reference (as opposed to by value). */
141 bool by_ref;
f8daee9b 142};
143
0d491188 144typedef struct ipa_agg_jump_function *ipa_agg_jump_function_p;
0d491188 145
a54071b2 146/* Information about zero/non-zero bits. */
251317e4 147class GTY(()) ipa_bits
a54071b2 148{
251317e4 149public:
a54071b2 150 /* The propagated value. */
151 widest_int value;
152 /* Mask corresponding to the value.
153 Similar to ccp_lattice_t, if xth bit of mask is 0,
154 implies xth bit of value is constant. */
155 widest_int mask;
a54071b2 156};
157
25a8e007 158/* Info about value ranges. */
97cb825b 159
251317e4 160class GTY(()) ipa_vr
25a8e007 161{
251317e4 162public:
25a8e007 163 /* The data fields below are valid only if known is true. */
164 bool known;
be44111e 165 enum value_range_kind type;
25a8e007 166 wide_int min;
167 wide_int max;
168};
169
1917e945 170/* A jump function for a callsite represents the values passed as actual
171 arguments of the callsite. See enum jump_func_type for the various
3b22db66 172 types of jump functions supported. */
b3e7c666 173struct GTY (()) ipa_jump_func
3b22db66 174{
0d491188 175 /* Aggregate contants description. See struct ipa_agg_jump_function and its
176 description. */
177 struct ipa_agg_jump_function agg;
178
97cb825b 179 /* Information about zero/non-zero bits. The pointed to structure is shared
180 betweed different jump functions. Use ipa_set_jfunc_bits to set this
181 field. */
2e966e2a 182 class ipa_bits *bits;
a54071b2 183
72b16d90 184 /* Information about value range, containing valid data only when vr_known is
97cb825b 185 true. The pointed to structure is shared betweed different jump
186 functions. Use ipa_set_jfunc_vr to set this field. */
2e966e2a 187 class value_range_base *m_vr;
25a8e007 188
3b22db66 189 enum jump_func_type type;
8867b500 190 /* Represents a value of a jump function. pass_through is used only in jump
191 function context. constant represents the actual constant in constant jump
192 functions and member_cst holds constant c++ member functions. */
193 union jump_func_value
194 {
096295f6 195 struct ipa_constant_data GTY ((tag ("IPA_JF_CONST"))) constant;
8867b500 196 struct ipa_pass_through_data GTY ((tag ("IPA_JF_PASS_THROUGH"))) pass_through;
197 struct ipa_ancestor_jf_data GTY ((tag ("IPA_JF_ANCESTOR"))) ancestor;
8867b500 198 } GTY ((desc ("%1.type"))) value;
b3e7c666 199};
b22832dc 200
3b22db66 201
4fa83f96 202/* Return the constant stored in a constant jump functin JFUNC. */
203
204static inline tree
205ipa_get_jf_constant (struct ipa_jump_func *jfunc)
206{
207 gcc_checking_assert (jfunc->type == IPA_JF_CONST);
096295f6 208 return jfunc->value.constant.value;
209}
210
211static inline struct ipa_cst_ref_desc *
212ipa_get_jf_constant_rdesc (struct ipa_jump_func *jfunc)
213{
214 gcc_checking_assert (jfunc->type == IPA_JF_CONST);
215 return jfunc->value.constant.rdesc;
4fa83f96 216}
217
218/* Return the operand of a pass through jmp function JFUNC. */
219
220static inline tree
221ipa_get_jf_pass_through_operand (struct ipa_jump_func *jfunc)
222{
223 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
224 return jfunc->value.pass_through.operand;
225}
226
227/* Return the number of the caller's formal parameter that a pass through jump
228 function JFUNC refers to. */
229
230static inline int
231ipa_get_jf_pass_through_formal_id (struct ipa_jump_func *jfunc)
232{
233 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
234 return jfunc->value.pass_through.formal_id;
235}
236
237/* Return operation of a pass through jump function JFUNC. */
238
239static inline enum tree_code
240ipa_get_jf_pass_through_operation (struct ipa_jump_func *jfunc)
241{
242 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
243 return jfunc->value.pass_through.operation;
244}
245
ad4a8b28 246/* Return the agg_preserved flag of a pass through jump function JFUNC. */
0d491188 247
248static inline bool
249ipa_get_jf_pass_through_agg_preserved (struct ipa_jump_func *jfunc)
250{
251 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
252 return jfunc->value.pass_through.agg_preserved;
253}
254
245ab191 255/* Return true if pass through jump function JFUNC preserves type
256 information. */
ad4a8b28 257
258static inline bool
259ipa_get_jf_pass_through_type_preserved (struct ipa_jump_func *jfunc)
260{
261 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
245ab191 262 return jfunc->value.pass_through.agg_preserved;
ad4a8b28 263}
264
4fa83f96 265/* Return the offset of an ancestor jump function JFUNC. */
266
267static inline HOST_WIDE_INT
268ipa_get_jf_ancestor_offset (struct ipa_jump_func *jfunc)
269{
270 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
271 return jfunc->value.ancestor.offset;
272}
273
4fa83f96 274/* Return the number of the caller's formal parameter that an ancestor jump
275 function JFUNC refers to. */
276
277static inline int
278ipa_get_jf_ancestor_formal_id (struct ipa_jump_func *jfunc)
279{
280 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
281 return jfunc->value.ancestor.formal_id;
282}
283
ad4a8b28 284/* Return the agg_preserved flag of an ancestor jump function JFUNC. */
4fa83f96 285
0d491188 286static inline bool
287ipa_get_jf_ancestor_agg_preserved (struct ipa_jump_func *jfunc)
4fa83f96 288{
0d491188 289 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
290 return jfunc->value.ancestor.agg_preserved;
4fa83f96 291}
292
245ab191 293/* Return true if ancestor jump function JFUNC presrves type information. */
ad4a8b28 294
295static inline bool
296ipa_get_jf_ancestor_type_preserved (struct ipa_jump_func *jfunc)
297{
298 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
245ab191 299 return jfunc->value.ancestor.agg_preserved;
ad4a8b28 300}
301
821d0e0f 302/* Summary describing a single formal parameter. */
6378ffb3 303
7af25a10 304struct GTY(()) ipa_param_descriptor
3f2ff969 305{
a54071b2 306 /* In analysis and modification phase, this is the PARAM_DECL of this
307 parameter, in IPA LTO phase, this is the type of the the described
308 parameter or NULL if not known. Do not read this field directly but
309 through ipa_get_param and ipa_get_type as appropriate. */
310 tree decl_or_type;
096295f6 311 /* If all uses of the parameter are described by ipa-prop structures, this
312 says how many there are. If any use could not be described by means of
313 ipa-prop structures, this is IPA_UNDESCRIBED_USE. */
314 int controlled_uses;
09ab6335 315 unsigned int move_cost : 31;
bc1b408a 316 /* The parameter is used. */
317 unsigned used : 1;
3f2ff969 318};
319
3889f2e2 320/* ipa_node_params stores information related to formal parameters of functions
321 and some other information for interprocedural passes that operate on
322 parameters (such as ipa-cp). */
821d0e0f 323
251317e4 324class GTY((for_user)) ipa_node_params
3b22db66 325{
251317e4 326public:
3ca1e19c 327 /* Default constructor. */
328 ipa_node_params ();
329
330 /* Default destructor. */
331 ~ipa_node_params ();
332
821d0e0f 333 /* Information about individual formal parameters that are gathered when
334 summaries are generated. */
7af25a10 335 vec<ipa_param_descriptor, va_gc> *descriptors;
821d0e0f 336 /* Pointer to an array of structures describing individual formal
337 parameters. */
2e966e2a 338 class ipcp_param_lattices * GTY((skip)) lattices;
821d0e0f 339 /* Only for versioned nodes this field would not be NULL,
340 it points to the node that IPA cp cloned from. */
7af25a10 341 struct cgraph_node * GTY((skip)) ipcp_orig_node;
245ab191 342 /* If this node is an ipa-cp clone, these are the known constants that
343 describe what it has been specialized for. */
7af25a10 344 vec<tree> GTY((skip)) known_csts;
245ab191 345 /* If this node is an ipa-cp clone, these are the known polymorphic contexts
346 that describe what it has been specialized for. */
7af25a10 347 vec<ipa_polymorphic_call_context> GTY((skip)) known_contexts;
24430d08 348 /* Whether the param uses analysis and jump function computation has already
349 been performed. */
350 unsigned analysis_done : 1;
821d0e0f 351 /* Whether the function is enqueued in ipa-cp propagation stack. */
609c710b 352 unsigned node_enqueued : 1;
821d0e0f 353 /* Whether we should create a specialized version based on values that are
354 known to be constant in all contexts. */
87228246 355 unsigned do_clone_for_all_contexts : 1;
356 /* Set if this is an IPA-CP clone for all contexts. */
357 unsigned is_all_contexts_clone : 1;
821d0e0f 358 /* Node has been completely replaced by clones and will be removed after
359 ipa-cp is finished. */
360 unsigned node_dead : 1;
39fcd838 361 /* Node is involved in a recursion, potentionally indirect. */
362 unsigned node_within_scc : 1;
363 /* Node is calling a private function called only once. */
364 unsigned node_calling_single_call : 1;
b8681788 365 /* False when there is something makes versioning impossible. */
366 unsigned versionable : 1;
3b22db66 367};
368
3ca1e19c 369inline
370ipa_node_params::ipa_node_params ()
371: descriptors (NULL), lattices (NULL), ipcp_orig_node (NULL),
372 known_csts (vNULL), known_contexts (vNULL), analysis_done (0),
373 node_enqueued (0), do_clone_for_all_contexts (0), is_all_contexts_clone (0),
374 node_dead (0), node_within_scc (0), node_calling_single_call (0),
375 versionable (0)
376{
377}
378
379inline
380ipa_node_params::~ipa_node_params ()
381{
382 free (lattices);
383 known_csts.release ();
384 known_contexts.release ();
385}
386
1a673ff0 387/* Intermediate information that we get from alias analysis about a particular
388 parameter in a particular basic_block. When a parameter or the memory it
9ea91b78 389 references is marked modified, we use that information in all dominated
390 blocks without consulting alias analysis oracle. */
1a673ff0 391
9ea91b78 392struct ipa_param_aa_status
1a673ff0 393{
394 /* Set when this structure contains meaningful information. If not, the
395 structure describing a dominating BB should be used instead. */
396 bool valid;
397
398 /* Whether we have seen something which might have modified the data in
399 question. PARM is for the parameter itself, REF is for data it points to
400 but using the alias type of individual accesses and PT is the same thing
401 but for computing aggregate pass-through functions using a very inclusive
402 ao_ref. */
403 bool parm_modified, ref_modified, pt_modified;
404};
405
406/* Information related to a given BB that used only when looking at function
407 body. */
408
409struct ipa_bb_info
410{
411 /* Call graph edges going out of this BB. */
412 vec<cgraph_edge *> cg_edges;
413 /* Alias analysis statuses of each formal parameter at this bb. */
9ea91b78 414 vec<ipa_param_aa_status> param_aa_statuses;
1a673ff0 415};
416
417/* Structure with global information that is only used when looking at function
418 body. */
419
9ea91b78 420struct ipa_func_body_info
1a673ff0 421{
422 /* The node that is being analyzed. */
423 cgraph_node *node;
424
425 /* Its info. */
2e966e2a 426 class ipa_node_params *info;
1a673ff0 427
428 /* Information about individual BBs. */
429 vec<ipa_bb_info> bb_infos;
430
431 /* Number of parameters. */
432 int param_count;
433
915df3d8 434 /* Number of statements we are still allowed to walked by when analyzing this
435 function. */
436 unsigned int aa_walk_budget;
1a673ff0 437};
438
3889f2e2 439/* ipa_node_params access functions. Please use these to access fields that
440 are or will be shared among various passes. */
441
3889f2e2 442/* Return the number of formal parameters. */
1917e945 443
3889f2e2 444static inline int
2e966e2a 445ipa_get_param_count (class ipa_node_params *info)
3889f2e2 446{
7af25a10 447 return vec_safe_length (info->descriptors);
3889f2e2 448}
449
3f2ff969 450/* Return the declaration of Ith formal parameter of the function corresponding
451 to INFO. Note there is no setter function as this array is built just once
a54071b2 452 using ipa_initialize_node_params. This function should not be called in
453 WPA. */
1917e945 454
3889f2e2 455static inline tree
2e966e2a 456ipa_get_param (class ipa_node_params *info, int i)
3889f2e2 457{
7af25a10 458 gcc_checking_assert (info->descriptors);
09ab6335 459 gcc_checking_assert (!flag_wpa);
7af25a10 460 tree t = (*info->descriptors)[i].decl_or_type;
a54071b2 461 gcc_checking_assert (TREE_CODE (t) == PARM_DECL);
462 return t;
463}
464
465/* Return the type of Ith formal parameter of the function corresponding
466 to INFO if it is known or NULL if not. */
467
468static inline tree
2e966e2a 469ipa_get_type (class ipa_node_params *info, int i)
a54071b2 470{
944ee40d 471 if (vec_safe_length (info->descriptors) <= (unsigned) i)
472 return NULL;
7af25a10 473 tree t = (*info->descriptors)[i].decl_or_type;
a54071b2 474 if (!t)
475 return NULL;
476 if (TYPE_P (t))
477 return t;
478 gcc_checking_assert (TREE_CODE (t) == PARM_DECL);
479 return TREE_TYPE (t);
bc1b408a 480}
481
09ab6335 482/* Return the move cost of Ith formal parameter of the function corresponding
483 to INFO. */
484
485static inline int
2e966e2a 486ipa_get_param_move_cost (class ipa_node_params *info, int i)
09ab6335 487{
7af25a10 488 gcc_checking_assert (info->descriptors);
489 return (*info->descriptors)[i].move_cost;
09ab6335 490}
491
821d0e0f 492/* Set the used flag corresponding to the Ith formal parameter of the function
493 associated with INFO to VAL. */
1caef38b 494
821d0e0f 495static inline void
2e966e2a 496ipa_set_param_used (class ipa_node_params *info, int i, bool val)
1caef38b 497{
7af25a10 498 gcc_checking_assert (info->descriptors);
499 (*info->descriptors)[i].used = val;
1caef38b 500}
501
096295f6 502/* Return how many uses described by ipa-prop a parameter has or
503 IPA_UNDESCRIBED_USE if there is a use that is not described by these
504 structures. */
505static inline int
2e966e2a 506ipa_get_controlled_uses (class ipa_node_params *info, int i)
096295f6 507{
7af25a10 508 /* FIXME: introducing speculation causes out of bounds access here. */
509 if (vec_safe_length (info->descriptors) > (unsigned)i)
510 return (*info->descriptors)[i].controlled_uses;
072ec6eb 511 return IPA_UNDESCRIBED_USE;
096295f6 512}
513
514/* Set the controlled counter of a given parameter. */
515
516static inline void
2e966e2a 517ipa_set_controlled_uses (class ipa_node_params *info, int i, int val)
096295f6 518{
7af25a10 519 gcc_checking_assert (info->descriptors);
520 (*info->descriptors)[i].controlled_uses = val;
096295f6 521}
522
821d0e0f 523/* Return the used flag corresponding to the Ith formal parameter of the
524 function associated with INFO. */
1caef38b 525
526static inline bool
2e966e2a 527ipa_is_param_used (class ipa_node_params *info, int i)
1caef38b 528{
7af25a10 529 gcc_checking_assert (info->descriptors);
530 return (*info->descriptors)[i].used;
1caef38b 531}
532
803a7988 533/* Information about replacements done in aggregates for a given node (each
534 node has its linked list). */
535struct GTY(()) ipa_agg_replacement_value
536{
537 /* Next item in the linked list. */
538 struct ipa_agg_replacement_value *next;
539 /* Offset within the aggregate. */
540 HOST_WIDE_INT offset;
541 /* The constant value. */
542 tree value;
543 /* The paramter index. */
544 int index;
c42e4f2e 545 /* Whether the value was passed by reference. */
546 bool by_ref;
803a7988 547};
548
ae7b7bc8 549/* Structure holding information for the transformation phase of IPA-CP. */
550
00637f9c 551struct GTY(()) ipcp_transformation
ae7b7bc8 552{
553 /* Linked list of known aggregate values. */
554 ipa_agg_replacement_value *agg_values;
a54071b2 555 /* Known bits information. */
97cb825b 556 vec<ipa_bits *, va_gc> *bits;
25a8e007 557 /* Value range information. */
558 vec<ipa_vr, va_gc> *m_vr;
ae7b7bc8 559};
803a7988 560
561void ipa_set_node_agg_value_chain (struct cgraph_node *node,
562 struct ipa_agg_replacement_value *aggvals);
00637f9c 563void ipcp_transformation_initialize (void);
803a7988 564
10d560f3 565/* ipa_edge_args stores information related to a callsite and particularly its
566 arguments. It can be accessed by the IPA_EDGE_REF macro. */
322dd010 567
568class GTY((for_user)) ipa_edge_args
3b22db66 569{
322dd010 570 public:
571
572 /* Default constructor. */
573 ipa_edge_args () : jump_functions (NULL), polymorphic_call_contexts (NULL)
574 {}
575
576 /* Destructor. */
577 ~ipa_edge_args ()
578 {
579 vec_free (jump_functions);
580 vec_free (polymorphic_call_contexts);
581 }
582
583 /* Vectors of the callsite's jump function and polymorphic context
584 information of each parameter. */
b3e7c666 585 vec<ipa_jump_func, va_gc> *jump_functions;
072ec6eb 586 vec<ipa_polymorphic_call_context, va_gc> *polymorphic_call_contexts;
b3e7c666 587};
3b22db66 588
3889f2e2 589/* ipa_edge_args access functions. Please use these to access fields that
590 are or will be shared among various passes. */
591
3889f2e2 592/* Return the number of actual arguments. */
1917e945 593
3889f2e2 594static inline int
2e966e2a 595ipa_get_cs_argument_count (class ipa_edge_args *args)
3889f2e2 596{
f1f41a6c 597 return vec_safe_length (args->jump_functions);
3889f2e2 598}
599
600/* Returns a pointer to the jump function for the ith argument. Please note
601 there is no setter function as jump functions are all set up in
602 ipa_compute_jump_functions. */
1917e945 603
3889f2e2 604static inline struct ipa_jump_func *
2e966e2a 605ipa_get_ith_jump_func (class ipa_edge_args *args, int i)
3889f2e2 606{
f1f41a6c 607 return &(*args->jump_functions)[i];
3889f2e2 608}
609
072ec6eb 610/* Returns a pointer to the polymorphic call context for the ith argument.
611 NULL if contexts are not computed. */
2e966e2a 612static inline class ipa_polymorphic_call_context *
613ipa_get_ith_polymorhic_call_context (class ipa_edge_args *args, int i)
072ec6eb 614{
615 if (!args->polymorphic_call_contexts)
616 return NULL;
617 return &(*args->polymorphic_call_contexts)[i];
618}
619
b4bae7a0 620/* Function summary for ipa_node_params. */
7af25a10 621class GTY((user)) ipa_node_params_t: public function_summary <ipa_node_params *>
2cc80ac3 622{
623public:
7af25a10 624 ipa_node_params_t (symbol_table *table, bool ggc):
625 function_summary<ipa_node_params *> (table, ggc) { }
545eff8f 626
2cc80ac3 627 /* Hook that is called by summary when a node is duplicated. */
628 virtual void duplicate (cgraph_node *node,
629 cgraph_node *node2,
630 ipa_node_params *data,
631 ipa_node_params *data2);
632};
633
322dd010 634/* Summary to manange ipa_edge_args structures. */
635
636class GTY((user)) ipa_edge_args_sum_t : public call_summary <ipa_edge_args *>
637{
638 public:
639 ipa_edge_args_sum_t (symbol_table *table, bool ggc)
640 : call_summary<ipa_edge_args *> (table, ggc) { }
641
642 /* Hook that is called by summary when an edge is duplicated. */
643 virtual void remove (cgraph_edge *cs, ipa_edge_args *args);
644 /* Hook that is called by summary when an edge is duplicated. */
645 virtual void duplicate (cgraph_edge *src,
646 cgraph_edge *dst,
647 ipa_edge_args *old_args,
648 ipa_edge_args *new_args);
649};
650
2cc80ac3 651/* Function summary where the parameter infos are actually stored. */
7af25a10 652extern GTY(()) ipa_node_params_t * ipa_node_params_sum;
322dd010 653/* Call summary to store information about edges such as jump functions. */
654extern GTY(()) ipa_edge_args_sum_t *ipa_edge_args_sum;
7af25a10 655
00637f9c 656/* Function summary for IPA-CP transformation. */
657class ipcp_transformation_t
658: public function_summary<ipcp_transformation *>
659{
660public:
661 ipcp_transformation_t (symbol_table *table, bool ggc):
662 function_summary<ipcp_transformation *> (table, ggc) {}
663
664 ~ipcp_transformation_t () {}
665
666 static ipcp_transformation_t *create_ggc (symbol_table *symtab)
667 {
668 ipcp_transformation_t *summary
669 = new (ggc_cleared_alloc <ipcp_transformation_t> ())
670 ipcp_transformation_t (symtab, true);
671 return summary;
672 }
673};
674
675/* Function summary where the IPA CP transformations are actually stored. */
676extern GTY(()) function_summary <ipcp_transformation *> *ipcp_transformation_sum;
7af25a10 677
545eff8f 678/* Return the associated parameter/argument info corresponding to the given
679 node/edge. */
b53d4f56 680#define IPA_NODE_REF(NODE) (ipa_node_params_sum->get_create (NODE))
681#define IPA_EDGE_REF(EDGE) (ipa_edge_args_sum->get_create (EDGE))
545eff8f 682/* This macro checks validity of index returned by
683 ipa_get_param_decl_index function. */
684#define IS_VALID_JUMP_FUNC_INDEX(I) ((I) != -1)
685
686/* Creating and freeing ipa_node_params and ipa_edge_args. */
687void ipa_create_all_node_params (void);
688void ipa_create_all_edge_args (void);
97cb825b 689void ipa_check_create_edge_args (void);
545eff8f 690void ipa_free_all_node_params (void);
691void ipa_free_all_edge_args (void);
799c8711 692void ipa_free_all_structures_after_ipa_cp (void);
693void ipa_free_all_structures_after_iinln (void);
2cc80ac3 694
545eff8f 695void ipa_register_cgraph_hooks (void);
09809ecc 696int count_formal_params (tree fndecl);
545eff8f 697
698/* This function ensures the array of node param infos is big enough to
1917e945 699 accommodate a structure for all nodes and reallocates it if not. */
700
545eff8f 701static inline void
702ipa_check_create_node_params (void)
703{
2cc80ac3 704 if (!ipa_node_params_sum)
7af25a10 705 ipa_node_params_sum
706 = (new (ggc_cleared_alloc <ipa_node_params_t> ())
707 ipa_node_params_t (symtab, true));
545eff8f 708}
709
322dd010 710/* Returns true if edge summary contains a record for EDGE. The main purpose
711 of this function is that debug dumping function can check info availability
712 without causing allocations. */
1917e945 713
86c96e3a 714static inline bool
715ipa_edge_args_info_available_for_edge_p (struct cgraph_edge *edge)
716{
322dd010 717 return ipa_edge_args_sum->exists (edge);
86c96e3a 718}
719
00637f9c 720static inline ipcp_transformation *
ae7b7bc8 721ipcp_get_transformation_summary (cgraph_node *node)
722{
00637f9c 723 if (ipcp_transformation_sum == NULL)
ae7b7bc8 724 return NULL;
00637f9c 725
726 return ipcp_transformation_sum->get (node);
ae7b7bc8 727}
728
803a7988 729/* Return the aggregate replacements for NODE, if there are any. */
730
731static inline struct ipa_agg_replacement_value *
ae7b7bc8 732ipa_get_agg_replacements_for_node (cgraph_node *node)
803a7988 733{
00637f9c 734 ipcp_transformation *ts = ipcp_get_transformation_summary (node);
ae7b7bc8 735 return ts ? ts->agg_values : NULL;
803a7988 736}
737
3f2ff969 738/* Function formal parameters related computations. */
739void ipa_initialize_node_params (struct cgraph_node *node);
3f2ff969 740bool ipa_propagate_indirect_call_infos (struct cgraph_edge *cs,
415d1b9a 741 vec<cgraph_edge *> *new_edges);
3b22db66 742
1caef38b 743/* Indirect edge and binfo processing. */
20da2013 744tree ipa_get_indirect_edge_target (struct cgraph_edge *ie,
f1f41a6c 745 vec<tree> ,
245ab191 746 vec<ipa_polymorphic_call_context>,
f21a87d8 747 vec<ipa_agg_jump_function_p>,
748 bool *);
072ec6eb 749struct cgraph_edge *ipa_make_edge_direct_to_target (struct cgraph_edge *, tree,
750 bool speculative = false);
3bc62a51 751tree ipa_impossible_devirt_target (struct cgraph_edge *, tree);
97cb825b 752ipa_bits *ipa_get_ipa_bits_for_value (const widest_int &value,
753 const widest_int &mask);
754
1caef38b 755
821d0e0f 756/* Functions related to both. */
757void ipa_analyze_node (struct cgraph_node *);
1caef38b 758
0d491188 759/* Aggregate jump function related functions. */
665ff45b 760tree ipa_find_agg_cst_for_param (struct ipa_agg_jump_function *agg, tree scalar,
761 HOST_WIDE_INT offset, bool by_ref,
762 bool *from_global_constant = NULL);
763bool ipa_load_from_parm_agg (struct ipa_func_body_info *fbi,
7af25a10 764 vec<ipa_param_descriptor, va_gc> *descriptors,
665ff45b 765 gimple *stmt, tree op, int *index_p,
c47e61e1 766 HOST_WIDE_INT *offset_p, poly_int64 *size_p,
665ff45b 767 bool *by_ref, bool *guaranteed_unmodified = NULL);
0d491188 768
3b22db66 769/* Debugging interface. */
11b73810 770void ipa_print_node_params (FILE *, struct cgraph_node *node);
771void ipa_print_all_params (FILE *);
f8daee9b 772void ipa_print_node_jump_functions (FILE *f, struct cgraph_node *node);
773void ipa_print_all_jump_functions (FILE * f);
821d0e0f 774void ipcp_verify_propagated_values (void);
775
8361d32f 776template <typename value>
777class ipcp_value;
778
e16712b1 779extern object_allocator<ipcp_value<tree> > ipcp_cst_values_pool;
780extern object_allocator<ipcp_value<ipa_polymorphic_call_context> >
8361d32f 781 ipcp_poly_ctx_values_pool;
782
783template <typename valtype>
2e966e2a 784struct ipcp_value_source;
8361d32f 785
e16712b1 786extern object_allocator<ipcp_value_source<tree> > ipcp_sources_pool;
8361d32f 787
2e966e2a 788struct ipcp_agg_lattice;
8361d32f 789
e16712b1 790extern object_allocator<ipcp_agg_lattice> ipcp_agg_lattice_pool;
3b22db66 791
803a7988 792void ipa_dump_agg_replacement_values (FILE *f,
793 struct ipa_agg_replacement_value *av);
eab36a5a 794void ipa_prop_write_jump_functions (void);
8867b500 795void ipa_prop_read_jump_functions (void);
ae7b7bc8 796void ipcp_write_transformation_summaries (void);
797void ipcp_read_transformation_summaries (void);
2e966e2a 798int ipa_get_param_decl_index (class ipa_node_params *, tree);
799tree ipa_value_from_jfunc (class ipa_node_params *info,
944ee40d 800 struct ipa_jump_func *jfunc, tree type);
803a7988 801unsigned int ipcp_transform_function (struct cgraph_node *node);
245ab191 802ipa_polymorphic_call_context ipa_context_from_jfunc (ipa_node_params *,
803 cgraph_edge *,
804 int,
805 ipa_jump_func *);
2e966e2a 806void ipa_dump_param (FILE *, class ipa_node_params *info, int i);
73bd7d5f 807void ipa_release_body_info (struct ipa_func_body_info *);
166f8178 808tree ipa_get_callee_param_type (struct cgraph_edge *e, int i);
8867b500 809
547f1802 810/* From tree-sra.c: */
68a46b44 811tree build_ref_for_offset (location_t, tree, poly_int64, bool, tree,
a60aac35 812 gimple_stmt_iterator *, bool);
547f1802 813
415309e2 814/* In ipa-cp.c */
815void ipa_cp_c_finalize (void);
816
3b22db66 817#endif /* IPA_PROP_H */