]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/ipa-prop.h
Add new object_allocator and clean-up allocator usage.
[thirdparty/gcc.git] / gcc / ipa-prop.h
CommitLineData
3b22db66 1/* Interprocedural analyses.
d353bf18 2 Copyright (C) 2005-2015 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
ae7b7bc8 146/* Info about pointer alignments. */
147struct GTY(()) ipa_alignment
148{
149 /* The data fields below are valid only if known is true. */
150 bool known;
151 /* See ptr_info_def and get_pointer_alignment_1 for description of these
152 two. */
153 unsigned align;
154 unsigned misalign;
155};
156
1917e945 157/* A jump function for a callsite represents the values passed as actual
158 arguments of the callsite. See enum jump_func_type for the various
3b22db66 159 types of jump functions supported. */
b3e7c666 160struct GTY (()) ipa_jump_func
3b22db66 161{
0d491188 162 /* Aggregate contants description. See struct ipa_agg_jump_function and its
163 description. */
164 struct ipa_agg_jump_function agg;
165
ae7b7bc8 166 /* Information about alignment of pointers. */
167 struct ipa_alignment alignment;
168
3b22db66 169 enum jump_func_type type;
8867b500 170 /* Represents a value of a jump function. pass_through is used only in jump
171 function context. constant represents the actual constant in constant jump
172 functions and member_cst holds constant c++ member functions. */
173 union jump_func_value
174 {
096295f6 175 struct ipa_constant_data GTY ((tag ("IPA_JF_CONST"))) constant;
8867b500 176 struct ipa_pass_through_data GTY ((tag ("IPA_JF_PASS_THROUGH"))) pass_through;
177 struct ipa_ancestor_jf_data GTY ((tag ("IPA_JF_ANCESTOR"))) ancestor;
8867b500 178 } GTY ((desc ("%1.type"))) value;
b3e7c666 179};
b22832dc 180
3b22db66 181
4fa83f96 182/* Return the constant stored in a constant jump functin JFUNC. */
183
184static inline tree
185ipa_get_jf_constant (struct ipa_jump_func *jfunc)
186{
187 gcc_checking_assert (jfunc->type == IPA_JF_CONST);
096295f6 188 return jfunc->value.constant.value;
189}
190
191static inline struct ipa_cst_ref_desc *
192ipa_get_jf_constant_rdesc (struct ipa_jump_func *jfunc)
193{
194 gcc_checking_assert (jfunc->type == IPA_JF_CONST);
195 return jfunc->value.constant.rdesc;
4fa83f96 196}
197
198/* Return the operand of a pass through jmp function JFUNC. */
199
200static inline tree
201ipa_get_jf_pass_through_operand (struct ipa_jump_func *jfunc)
202{
203 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
204 return jfunc->value.pass_through.operand;
205}
206
207/* Return the number of the caller's formal parameter that a pass through jump
208 function JFUNC refers to. */
209
210static inline int
211ipa_get_jf_pass_through_formal_id (struct ipa_jump_func *jfunc)
212{
213 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
214 return jfunc->value.pass_through.formal_id;
215}
216
217/* Return operation of a pass through jump function JFUNC. */
218
219static inline enum tree_code
220ipa_get_jf_pass_through_operation (struct ipa_jump_func *jfunc)
221{
222 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
223 return jfunc->value.pass_through.operation;
224}
225
ad4a8b28 226/* Return the agg_preserved flag of a pass through jump function JFUNC. */
0d491188 227
228static inline bool
229ipa_get_jf_pass_through_agg_preserved (struct ipa_jump_func *jfunc)
230{
231 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
232 return jfunc->value.pass_through.agg_preserved;
233}
234
245ab191 235/* Return true if pass through jump function JFUNC preserves type
236 information. */
ad4a8b28 237
238static inline bool
239ipa_get_jf_pass_through_type_preserved (struct ipa_jump_func *jfunc)
240{
241 gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
245ab191 242 return jfunc->value.pass_through.agg_preserved;
ad4a8b28 243}
244
4fa83f96 245/* Return the offset of an ancestor jump function JFUNC. */
246
247static inline HOST_WIDE_INT
248ipa_get_jf_ancestor_offset (struct ipa_jump_func *jfunc)
249{
250 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
251 return jfunc->value.ancestor.offset;
252}
253
4fa83f96 254/* Return the number of the caller's formal parameter that an ancestor jump
255 function JFUNC refers to. */
256
257static inline int
258ipa_get_jf_ancestor_formal_id (struct ipa_jump_func *jfunc)
259{
260 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
261 return jfunc->value.ancestor.formal_id;
262}
263
ad4a8b28 264/* Return the agg_preserved flag of an ancestor jump function JFUNC. */
4fa83f96 265
0d491188 266static inline bool
267ipa_get_jf_ancestor_agg_preserved (struct ipa_jump_func *jfunc)
4fa83f96 268{
0d491188 269 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
270 return jfunc->value.ancestor.agg_preserved;
4fa83f96 271}
272
245ab191 273/* Return true if ancestor jump function JFUNC presrves type information. */
ad4a8b28 274
275static inline bool
276ipa_get_jf_ancestor_type_preserved (struct ipa_jump_func *jfunc)
277{
278 gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
245ab191 279 return jfunc->value.ancestor.agg_preserved;
ad4a8b28 280}
281
821d0e0f 282/* Summary describing a single formal parameter. */
6378ffb3 283
3f2ff969 284struct ipa_param_descriptor
285{
3f2ff969 286 /* PARAM_DECL of this parameter. */
287 tree decl;
096295f6 288 /* If all uses of the parameter are described by ipa-prop structures, this
289 says how many there are. If any use could not be described by means of
290 ipa-prop structures, this is IPA_UNDESCRIBED_USE. */
291 int controlled_uses;
09ab6335 292 unsigned int move_cost : 31;
bc1b408a 293 /* The parameter is used. */
294 unsigned used : 1;
3f2ff969 295};
296
3889f2e2 297/* ipa_node_params stores information related to formal parameters of functions
298 and some other information for interprocedural passes that operate on
299 parameters (such as ipa-cp). */
821d0e0f 300
3889f2e2 301struct ipa_node_params
3b22db66 302{
2cc80ac3 303 ~ipa_node_params ();
304
821d0e0f 305 /* Information about individual formal parameters that are gathered when
306 summaries are generated. */
b3e7c666 307 vec<ipa_param_descriptor> descriptors;
821d0e0f 308 /* Pointer to an array of structures describing individual formal
309 parameters. */
803a7988 310 struct ipcp_param_lattices *lattices;
821d0e0f 311 /* Only for versioned nodes this field would not be NULL,
312 it points to the node that IPA cp cloned from. */
313 struct cgraph_node *ipcp_orig_node;
245ab191 314 /* If this node is an ipa-cp clone, these are the known constants that
315 describe what it has been specialized for. */
316 vec<tree> known_csts;
317 /* If this node is an ipa-cp clone, these are the known polymorphic contexts
318 that describe what it has been specialized for. */
319 vec<ipa_polymorphic_call_context> known_contexts;
24430d08 320 /* Whether the param uses analysis and jump function computation has already
321 been performed. */
322 unsigned analysis_done : 1;
821d0e0f 323 /* Whether the function is enqueued in ipa-cp propagation stack. */
609c710b 324 unsigned node_enqueued : 1;
821d0e0f 325 /* Whether we should create a specialized version based on values that are
326 known to be constant in all contexts. */
87228246 327 unsigned do_clone_for_all_contexts : 1;
328 /* Set if this is an IPA-CP clone for all contexts. */
329 unsigned is_all_contexts_clone : 1;
821d0e0f 330 /* Node has been completely replaced by clones and will be removed after
331 ipa-cp is finished. */
332 unsigned node_dead : 1;
39fcd838 333 /* Node is involved in a recursion, potentionally indirect. */
334 unsigned node_within_scc : 1;
335 /* Node is calling a private function called only once. */
336 unsigned node_calling_single_call : 1;
3b22db66 337};
338
1a673ff0 339/* Intermediate information that we get from alias analysis about a particular
340 parameter in a particular basic_block. When a parameter or the memory it
9ea91b78 341 references is marked modified, we use that information in all dominated
342 blocks without consulting alias analysis oracle. */
1a673ff0 343
9ea91b78 344struct ipa_param_aa_status
1a673ff0 345{
346 /* Set when this structure contains meaningful information. If not, the
347 structure describing a dominating BB should be used instead. */
348 bool valid;
349
350 /* Whether we have seen something which might have modified the data in
351 question. PARM is for the parameter itself, REF is for data it points to
352 but using the alias type of individual accesses and PT is the same thing
353 but for computing aggregate pass-through functions using a very inclusive
354 ao_ref. */
355 bool parm_modified, ref_modified, pt_modified;
356};
357
358/* Information related to a given BB that used only when looking at function
359 body. */
360
361struct ipa_bb_info
362{
363 /* Call graph edges going out of this BB. */
364 vec<cgraph_edge *> cg_edges;
365 /* Alias analysis statuses of each formal parameter at this bb. */
9ea91b78 366 vec<ipa_param_aa_status> param_aa_statuses;
1a673ff0 367};
368
369/* Structure with global information that is only used when looking at function
370 body. */
371
9ea91b78 372struct ipa_func_body_info
1a673ff0 373{
374 /* The node that is being analyzed. */
375 cgraph_node *node;
376
377 /* Its info. */
378 struct ipa_node_params *info;
379
380 /* Information about individual BBs. */
381 vec<ipa_bb_info> bb_infos;
382
383 /* Number of parameters. */
384 int param_count;
385
386 /* Number of statements already walked by when analyzing this function. */
387 unsigned int aa_walked;
388};
389
3889f2e2 390/* ipa_node_params access functions. Please use these to access fields that
391 are or will be shared among various passes. */
392
3889f2e2 393/* Return the number of formal parameters. */
1917e945 394
3889f2e2 395static inline int
396ipa_get_param_count (struct ipa_node_params *info)
397{
f1f41a6c 398 return info->descriptors.length ();
3889f2e2 399}
400
3f2ff969 401/* Return the declaration of Ith formal parameter of the function corresponding
402 to INFO. Note there is no setter function as this array is built just once
403 using ipa_initialize_node_params. */
1917e945 404
3889f2e2 405static inline tree
3f2ff969 406ipa_get_param (struct ipa_node_params *info, int i)
3889f2e2 407{
09ab6335 408 gcc_checking_assert (!flag_wpa);
f1f41a6c 409 return info->descriptors[i].decl;
bc1b408a 410}
411
09ab6335 412/* Return the move cost of Ith formal parameter of the function corresponding
413 to INFO. */
414
415static inline int
416ipa_get_param_move_cost (struct ipa_node_params *info, int i)
417{
418 return info->descriptors[i].move_cost;
419}
420
821d0e0f 421/* Set the used flag corresponding to the Ith formal parameter of the function
422 associated with INFO to VAL. */
1caef38b 423
821d0e0f 424static inline void
425ipa_set_param_used (struct ipa_node_params *info, int i, bool val)
1caef38b 426{
f1f41a6c 427 info->descriptors[i].used = val;
1caef38b 428}
429
096295f6 430/* Return how many uses described by ipa-prop a parameter has or
431 IPA_UNDESCRIBED_USE if there is a use that is not described by these
432 structures. */
433static inline int
434ipa_get_controlled_uses (struct ipa_node_params *info, int i)
435{
072ec6eb 436 /* FIXME: introducing speuclation causes out of bounds access here. */
437 if (info->descriptors.length () > (unsigned)i)
438 return info->descriptors[i].controlled_uses;
439 return IPA_UNDESCRIBED_USE;
096295f6 440}
441
442/* Set the controlled counter of a given parameter. */
443
444static inline void
445ipa_set_controlled_uses (struct ipa_node_params *info, int i, int val)
446{
447 info->descriptors[i].controlled_uses = val;
448}
449
821d0e0f 450/* Return the used flag corresponding to the Ith formal parameter of the
451 function associated with INFO. */
1caef38b 452
453static inline bool
821d0e0f 454ipa_is_param_used (struct ipa_node_params *info, int i)
1caef38b 455{
f1f41a6c 456 return info->descriptors[i].used;
1caef38b 457}
458
803a7988 459/* Information about replacements done in aggregates for a given node (each
460 node has its linked list). */
461struct GTY(()) ipa_agg_replacement_value
462{
463 /* Next item in the linked list. */
464 struct ipa_agg_replacement_value *next;
465 /* Offset within the aggregate. */
466 HOST_WIDE_INT offset;
467 /* The constant value. */
468 tree value;
469 /* The paramter index. */
470 int index;
c42e4f2e 471 /* Whether the value was passed by reference. */
472 bool by_ref;
803a7988 473};
474
ae7b7bc8 475/* Structure holding information for the transformation phase of IPA-CP. */
476
477struct GTY(()) ipcp_transformation_summary
478{
479 /* Linked list of known aggregate values. */
480 ipa_agg_replacement_value *agg_values;
481 /* Alignment information for pointers. */
482 vec<ipa_alignment, va_gc> *alignments;
483};
803a7988 484
485void ipa_set_node_agg_value_chain (struct cgraph_node *node,
486 struct ipa_agg_replacement_value *aggvals);
ae7b7bc8 487void ipcp_grow_transformations_if_necessary (void);
803a7988 488
10d560f3 489/* ipa_edge_args stores information related to a callsite and particularly its
490 arguments. It can be accessed by the IPA_EDGE_REF macro. */
b3e7c666 491struct GTY(()) ipa_edge_args
3b22db66 492{
b22832dc 493 /* Vector of the callsite's jump function of each parameter. */
b3e7c666 494 vec<ipa_jump_func, va_gc> *jump_functions;
072ec6eb 495 vec<ipa_polymorphic_call_context, va_gc> *polymorphic_call_contexts;
b3e7c666 496};
3b22db66 497
3889f2e2 498/* ipa_edge_args access functions. Please use these to access fields that
499 are or will be shared among various passes. */
500
3889f2e2 501/* Return the number of actual arguments. */
1917e945 502
3889f2e2 503static inline int
504ipa_get_cs_argument_count (struct ipa_edge_args *args)
505{
f1f41a6c 506 return vec_safe_length (args->jump_functions);
3889f2e2 507}
508
509/* Returns a pointer to the jump function for the ith argument. Please note
510 there is no setter function as jump functions are all set up in
511 ipa_compute_jump_functions. */
1917e945 512
3889f2e2 513static inline struct ipa_jump_func *
514ipa_get_ith_jump_func (struct ipa_edge_args *args, int i)
515{
f1f41a6c 516 return &(*args->jump_functions)[i];
3889f2e2 517}
518
072ec6eb 519/* Returns a pointer to the polymorphic call context for the ith argument.
520 NULL if contexts are not computed. */
521static inline struct ipa_polymorphic_call_context *
522ipa_get_ith_polymorhic_call_context (struct ipa_edge_args *args, int i)
523{
524 if (!args->polymorphic_call_contexts)
525 return NULL;
526 return &(*args->polymorphic_call_contexts)[i];
527}
528
b4bae7a0 529/* Function summary for ipa_node_params. */
2cc80ac3 530class ipa_node_params_t: public function_summary <ipa_node_params *>
531{
532public:
533 ipa_node_params_t (symbol_table *table):
534 function_summary<ipa_node_params *> (table) { }
545eff8f 535
2cc80ac3 536 /* Hook that is called by summary when a node is duplicated. */
537 virtual void duplicate (cgraph_node *node,
538 cgraph_node *node2,
539 ipa_node_params *data,
540 ipa_node_params *data2);
541};
542
543/* Function summary where the parameter infos are actually stored. */
544extern ipa_node_params_t *ipa_node_params_sum;
ae7b7bc8 545/* Vector of IPA-CP transformation data for each clone. */
546extern GTY(()) vec<ipcp_transformation_summary, va_gc> *ipcp_transformations;
545eff8f 547/* Vector where the parameter infos are actually stored. */
b3e7c666 548extern GTY(()) vec<ipa_edge_args, va_gc> *ipa_edge_args_vector;
545eff8f 549
550/* Return the associated parameter/argument info corresponding to the given
551 node/edge. */
2cc80ac3 552#define IPA_NODE_REF(NODE) (ipa_node_params_sum->get (NODE))
f1f41a6c 553#define IPA_EDGE_REF(EDGE) (&(*ipa_edge_args_vector)[(EDGE)->uid])
545eff8f 554/* This macro checks validity of index returned by
555 ipa_get_param_decl_index function. */
556#define IS_VALID_JUMP_FUNC_INDEX(I) ((I) != -1)
557
558/* Creating and freeing ipa_node_params and ipa_edge_args. */
559void ipa_create_all_node_params (void);
560void ipa_create_all_edge_args (void);
561void ipa_free_edge_args_substructures (struct ipa_edge_args *);
545eff8f 562void ipa_free_all_node_params (void);
563void ipa_free_all_edge_args (void);
799c8711 564void ipa_free_all_structures_after_ipa_cp (void);
565void ipa_free_all_structures_after_iinln (void);
2cc80ac3 566
545eff8f 567void ipa_register_cgraph_hooks (void);
09809ecc 568int count_formal_params (tree fndecl);
545eff8f 569
570/* This function ensures the array of node param infos is big enough to
1917e945 571 accommodate a structure for all nodes and reallocates it if not. */
572
545eff8f 573static inline void
574ipa_check_create_node_params (void)
575{
2cc80ac3 576 if (!ipa_node_params_sum)
577 ipa_node_params_sum = new ipa_node_params_t (symtab);
545eff8f 578}
579
1917e945 580/* This function ensures the array of edge arguments infos is big enough to
581 accommodate a structure for all edges and reallocates it if not. */
582
545eff8f 583static inline void
584ipa_check_create_edge_args (void)
585{
35ee1c66 586 if (vec_safe_length (ipa_edge_args_vector)
587 <= (unsigned) symtab->edges_max_uid)
588 vec_safe_grow_cleared (ipa_edge_args_vector, symtab->edges_max_uid + 1);
545eff8f 589}
590
1917e945 591/* Returns true if the array of edge infos is large enough to accommodate an
86c96e3a 592 info for EDGE. The main purpose of this function is that debug dumping
593 function can check info availability without causing reallocations. */
1917e945 594
86c96e3a 595static inline bool
596ipa_edge_args_info_available_for_edge_p (struct cgraph_edge *edge)
597{
f1f41a6c 598 return ((unsigned) edge->uid < vec_safe_length (ipa_edge_args_vector));
86c96e3a 599}
600
ae7b7bc8 601static inline ipcp_transformation_summary *
602ipcp_get_transformation_summary (cgraph_node *node)
603{
604 if ((unsigned) node->uid >= vec_safe_length (ipcp_transformations))
605 return NULL;
606 return &(*ipcp_transformations)[node->uid];
607}
608
803a7988 609/* Return the aggregate replacements for NODE, if there are any. */
610
611static inline struct ipa_agg_replacement_value *
ae7b7bc8 612ipa_get_agg_replacements_for_node (cgraph_node *node)
803a7988 613{
ae7b7bc8 614 ipcp_transformation_summary *ts = ipcp_get_transformation_summary (node);
615 return ts ? ts->agg_values : NULL;
803a7988 616}
617
3f2ff969 618/* Function formal parameters related computations. */
619void ipa_initialize_node_params (struct cgraph_node *node);
3f2ff969 620bool ipa_propagate_indirect_call_infos (struct cgraph_edge *cs,
415d1b9a 621 vec<cgraph_edge *> *new_edges);
3b22db66 622
1caef38b 623/* Indirect edge and binfo processing. */
20da2013 624tree ipa_get_indirect_edge_target (struct cgraph_edge *ie,
f1f41a6c 625 vec<tree> ,
245ab191 626 vec<ipa_polymorphic_call_context>,
f21a87d8 627 vec<ipa_agg_jump_function_p>,
628 bool *);
072ec6eb 629struct cgraph_edge *ipa_make_edge_direct_to_target (struct cgraph_edge *, tree,
630 bool speculative = false);
3bc62a51 631tree ipa_impossible_devirt_target (struct cgraph_edge *, tree);
1caef38b 632
821d0e0f 633/* Functions related to both. */
634void ipa_analyze_node (struct cgraph_node *);
1caef38b 635
0d491188 636/* Aggregate jump function related functions. */
637tree ipa_find_agg_cst_for_param (struct ipa_agg_jump_function *, HOST_WIDE_INT,
638 bool);
9ea91b78 639bool ipa_load_from_parm_agg (struct ipa_func_body_info *,
1a673ff0 640 vec<ipa_param_descriptor>, gimple, tree, int *,
641 HOST_WIDE_INT *, HOST_WIDE_INT *, bool *);
0d491188 642
3b22db66 643/* Debugging interface. */
11b73810 644void ipa_print_node_params (FILE *, struct cgraph_node *node);
645void ipa_print_all_params (FILE *);
f8daee9b 646void ipa_print_node_jump_functions (FILE *f, struct cgraph_node *node);
647void ipa_print_all_jump_functions (FILE * f);
821d0e0f 648void ipcp_verify_propagated_values (void);
649
8361d32f 650template <typename value>
651class ipcp_value;
652
e16712b1 653extern object_allocator<ipcp_value<tree> > ipcp_cst_values_pool;
654extern object_allocator<ipcp_value<ipa_polymorphic_call_context> >
8361d32f 655 ipcp_poly_ctx_values_pool;
656
657template <typename valtype>
658class ipcp_value_source;
659
e16712b1 660extern object_allocator<ipcp_value_source<tree> > ipcp_sources_pool;
8361d32f 661
662class ipcp_agg_lattice;
663
e16712b1 664extern object_allocator<ipcp_agg_lattice> ipcp_agg_lattice_pool;
3b22db66 665
6bcfabf2 666/* Operation to be performed for the parameter in ipa_parm_adjustment
667 below. */
668enum ipa_parm_op {
669 IPA_PARM_OP_NONE,
670
671 /* This describes a brand new parameter.
672
673 The field `type' should be set to the new type, `arg_prefix'
674 should be set to the string prefix for the new DECL_NAME, and
675 `new_decl' will ultimately hold the newly created argument. */
676 IPA_PARM_OP_NEW,
677
678 /* This new parameter is an unmodified parameter at index base_index. */
679 IPA_PARM_OP_COPY,
680
681 /* This adjustment describes a parameter that is about to be removed
682 completely. Most users will probably need to book keep those so that they
683 don't leave behinfd any non default def ssa names belonging to them. */
684 IPA_PARM_OP_REMOVE
685};
686
547f1802 687/* Structure to describe transformations of formal parameters and actual
688 arguments. Each instance describes one new parameter and they are meant to
689 be stored in a vector. Additionally, most users will probably want to store
690 adjustments about parameters that are being removed altogether so that SSA
691 names belonging to them can be replaced by SSA names of an artificial
692 variable. */
693struct ipa_parm_adjustment
694{
695 /* The original PARM_DECL itself, helpful for processing of the body of the
696 function itself. Intended for traversing function bodies.
697 ipa_modify_formal_parameters, ipa_modify_call_arguments and
698 ipa_combine_adjustments ignore this and use base_index.
699 ipa_modify_formal_parameters actually sets this. */
700 tree base;
701
702 /* Type of the new parameter. However, if by_ref is true, the real type will
703 be a pointer to this type. */
704 tree type;
705
14c9496e 706 /* Alias refrerence type to be used in MEM_REFs when adjusting caller
707 arguments. */
708 tree alias_ptr_type;
709
6bcfabf2 710 /* The new declaration when creating/replacing a parameter. Created
711 by ipa_modify_formal_parameters, useful for functions modifying
712 the body accordingly. For brand new arguments, this is the newly
713 created argument. */
714 tree new_decl;
547f1802 715
716 /* New declaration of a substitute variable that we may use to replace all
717 non-default-def ssa names when a parm decl is going away. */
718 tree new_ssa_base;
719
720 /* If non-NULL and the original parameter is to be removed (copy_param below
721 is NULL), this is going to be its nonlocalized vars value. */
722 tree nonlocal_value;
723
6bcfabf2 724 /* This holds the prefix to be used for the new DECL_NAME. */
725 const char *arg_prefix;
726
547f1802 727 /* Offset into the original parameter (for the cases when the new parameter
728 is a component of an original one). */
729 HOST_WIDE_INT offset;
730
6bcfabf2 731 /* Zero based index of the original parameter this one is based on. */
547f1802 732 int base_index;
733
6bcfabf2 734 /* Whether this parameter is a new parameter, a copy of an old one,
735 or one about to be removed. */
736 enum ipa_parm_op op;
547f1802 737
738 /* The parameter is to be passed by reference. */
739 unsigned by_ref : 1;
740};
741
b3e7c666 742typedef vec<ipa_parm_adjustment> ipa_parm_adjustment_vec;
547f1802 743
f1f41a6c 744vec<tree> ipa_get_vector_of_formal_parms (tree fndecl);
6bcfabf2 745vec<tree> ipa_get_vector_of_formal_parm_types (tree fntype);
746void ipa_modify_formal_parameters (tree fndecl, ipa_parm_adjustment_vec);
1a91d914 747void ipa_modify_call_arguments (struct cgraph_edge *, gcall *,
547f1802 748 ipa_parm_adjustment_vec);
749ipa_parm_adjustment_vec ipa_combine_adjustments (ipa_parm_adjustment_vec,
750 ipa_parm_adjustment_vec);
751void ipa_dump_param_adjustments (FILE *, ipa_parm_adjustment_vec, tree);
803a7988 752void ipa_dump_agg_replacement_values (FILE *f,
753 struct ipa_agg_replacement_value *av);
eab36a5a 754void ipa_prop_write_jump_functions (void);
8867b500 755void ipa_prop_read_jump_functions (void);
ae7b7bc8 756void ipcp_write_transformation_summaries (void);
757void ipcp_read_transformation_summaries (void);
8867b500 758void ipa_update_after_lto_read (void);
a41f2a28 759int ipa_get_param_decl_index (struct ipa_node_params *, tree);
20da2013 760tree ipa_value_from_jfunc (struct ipa_node_params *info,
761 struct ipa_jump_func *jfunc);
803a7988 762unsigned int ipcp_transform_function (struct cgraph_node *node);
245ab191 763ipa_polymorphic_call_context ipa_context_from_jfunc (ipa_node_params *,
764 cgraph_edge *,
765 int,
766 ipa_jump_func *);
09ab6335 767void ipa_dump_param (FILE *, struct ipa_node_params *info, int i);
6bcfabf2 768bool ipa_modify_expr (tree *, bool, ipa_parm_adjustment_vec);
769ipa_parm_adjustment *ipa_get_adjustment_candidate (tree **, bool *,
770 ipa_parm_adjustment_vec,
771 bool);
93f713da 772
8867b500 773
547f1802 774/* From tree-sra.c: */
a60aac35 775tree build_ref_for_offset (location_t, tree, HOST_WIDE_INT, tree,
776 gimple_stmt_iterator *, bool);
547f1802 777
415309e2 778/* In ipa-cp.c */
779void ipa_cp_c_finalize (void);
780
3b22db66 781#endif /* IPA_PROP_H */