1 /* Interprocedural analyses.
2    Copyright (C) 2005-2016 Free Software Foundation, Inc.
3 
4 This file is part of GCC.
5 
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
10 
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15 
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3.  If not see
18 <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef IPA_PROP_H
21 #define IPA_PROP_H
22 
23 /* The following definitions and interfaces are used by
24    interprocedural analyses or parameters.  */
25 
26 #define IPA_UNDESCRIBED_USE -1
27 
28 /* ipa-prop.c stuff (ipa-cp, indirect inlining):  */
29 
30 /* A jump function for a callsite represents the values passed as actual
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 :
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 
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
45    getting addresses of ancestor fields in C++
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 
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.  */
57 
58 enum jump_func_type
59 {
60   IPA_JF_UNKNOWN = 0,  /* newly allocated and zeroed jump functions default */
61   IPA_JF_CONST,             /* represented by field costant */
62   IPA_JF_PASS_THROUGH,	    /* represented by field pass_through */
63   IPA_JF_ANCESTOR	    /* represented by field ancestor */
64 };
65 
66 struct ipa_cst_ref_desc;
67 
68 /* Structure holding data required to describe a constant jump function.  */
69 struct 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 
77 /* Structure holding data required to describe a pass-through jump function.  */
78 
79 struct GTY(()) ipa_pass_through_data
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;
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.  */
97   unsigned agg_preserved : 1;
98 };
99 
100 /* Structure holding data required to describe an ancestor pass-through
101    jump function.  */
102 
103 struct GTY(()) ipa_ancestor_jf_data
104 {
105   /* Offset of the field representing the ancestor.  */
106   HOST_WIDE_INT offset;
107   /* Number of the caller's formal parameter being passed.  */
108   int formal_id;
109   /* Flag with the same meaning like agg_preserve in ipa_pass_through_data.  */
110   unsigned agg_preserved : 1;
111 };
112 
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
121    fulfill is_gimple_ip_invariant.  */
122 
123 struct GTY(()) ipa_agg_jf_item
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;
130 };
131 
132 
133 /* Aggregate jump function - i.e. description of contents of aggregates passed
134    either by reference or value.  */
135 
136 struct GTY(()) ipa_agg_jump_function
137 {
138   /* Description of the individual items.  */
139   vec<ipa_agg_jf_item, va_gc> *items;
140   /* True if the data was passed by reference (as opposed to by value). */
141   bool by_ref;
142 };
143 
144 typedef struct ipa_agg_jump_function *ipa_agg_jump_function_p;
145 
146 /* Info about pointer alignments. */
147 struct 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 
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
159    types of jump functions supported.  */
160 struct GTY (()) ipa_jump_func
161 {
162   /* Aggregate contants description.  See struct ipa_agg_jump_function and its
163      description.  */
164   struct ipa_agg_jump_function agg;
165 
166   /* Information about alignment of pointers. */
167   struct ipa_alignment alignment;
168 
169   enum jump_func_type type;
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   {
175     struct ipa_constant_data GTY ((tag ("IPA_JF_CONST"))) constant;
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;
178   } GTY ((desc ("%1.type"))) value;
179 };
180 
181 
182 /* Return the constant stored in a constant jump functin JFUNC.  */
183 
184 static inline tree
ipa_get_jf_constant(struct ipa_jump_func * jfunc)185 ipa_get_jf_constant (struct ipa_jump_func *jfunc)
186 {
187   gcc_checking_assert (jfunc->type == IPA_JF_CONST);
188   return jfunc->value.constant.value;
189 }
190 
191 static inline struct ipa_cst_ref_desc *
ipa_get_jf_constant_rdesc(struct ipa_jump_func * jfunc)192 ipa_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;
196 }
197 
198 /* Return the operand of a pass through jmp function JFUNC.  */
199 
200 static inline tree
ipa_get_jf_pass_through_operand(struct ipa_jump_func * jfunc)201 ipa_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 
210 static inline int
ipa_get_jf_pass_through_formal_id(struct ipa_jump_func * jfunc)211 ipa_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 
219 static inline enum tree_code
ipa_get_jf_pass_through_operation(struct ipa_jump_func * jfunc)220 ipa_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 
226 /* Return the agg_preserved flag of a pass through jump function JFUNC.  */
227 
228 static inline bool
ipa_get_jf_pass_through_agg_preserved(struct ipa_jump_func * jfunc)229 ipa_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 
235 /* Return true if pass through jump function JFUNC preserves type
236    information.  */
237 
238 static inline bool
ipa_get_jf_pass_through_type_preserved(struct ipa_jump_func * jfunc)239 ipa_get_jf_pass_through_type_preserved (struct ipa_jump_func *jfunc)
240 {
241   gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
242   return jfunc->value.pass_through.agg_preserved;
243 }
244 
245 /* Return the offset of an ancestor jump function JFUNC.  */
246 
247 static inline HOST_WIDE_INT
ipa_get_jf_ancestor_offset(struct ipa_jump_func * jfunc)248 ipa_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 
254 /* Return the number of the caller's formal parameter that an ancestor jump
255    function JFUNC refers to.  */
256 
257 static inline int
ipa_get_jf_ancestor_formal_id(struct ipa_jump_func * jfunc)258 ipa_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 
264 /* Return the agg_preserved flag of an ancestor jump function JFUNC.  */
265 
266 static inline bool
ipa_get_jf_ancestor_agg_preserved(struct ipa_jump_func * jfunc)267 ipa_get_jf_ancestor_agg_preserved (struct ipa_jump_func *jfunc)
268 {
269   gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
270   return jfunc->value.ancestor.agg_preserved;
271 }
272 
273 /* Return true if ancestor jump function JFUNC presrves type information.  */
274 
275 static inline bool
ipa_get_jf_ancestor_type_preserved(struct ipa_jump_func * jfunc)276 ipa_get_jf_ancestor_type_preserved (struct ipa_jump_func *jfunc)
277 {
278   gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
279   return jfunc->value.ancestor.agg_preserved;
280 }
281 
282 /* Summary describing a single formal parameter.  */
283 
284 struct ipa_param_descriptor
285 {
286   /* PARAM_DECL of this parameter.  */
287   tree decl;
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;
292   unsigned int move_cost : 31;
293   /* The parameter is used.  */
294   unsigned used : 1;
295 };
296 
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).  */
300 
301 struct ipa_node_params
302 {
303   ~ipa_node_params ();
304 
305   /* Information about individual formal parameters that are gathered when
306      summaries are generated. */
307   vec<ipa_param_descriptor> descriptors;
308   /* Pointer to an array of structures describing individual formal
309      parameters.  */
310   struct ipcp_param_lattices *lattices;
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;
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;
320   /* Whether the param uses analysis and jump function computation has already
321      been performed.  */
322   unsigned analysis_done : 1;
323   /* Whether the function is enqueued in ipa-cp propagation stack.  */
324   unsigned node_enqueued : 1;
325   /* Whether we should create a specialized version based on values that are
326      known to be constant in all contexts.  */
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;
330   /* Node has been completely replaced by clones and will be removed after
331      ipa-cp is finished.  */
332   unsigned node_dead : 1;
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;
337   /* False when there is something makes versioning impossible.  */
338   unsigned versionable : 1;
339 };
340 
341 /* Intermediate information that we get from alias analysis about a particular
342    parameter in a particular basic_block.  When a parameter or the memory it
343    references is marked modified, we use that information in all dominated
344    blocks without consulting alias analysis oracle.  */
345 
346 struct ipa_param_aa_status
347 {
348   /* Set when this structure contains meaningful information.  If not, the
349      structure describing a dominating BB should be used instead.  */
350   bool valid;
351 
352   /* Whether we have seen something which might have modified the data in
353      question.  PARM is for the parameter itself, REF is for data it points to
354      but using the alias type of individual accesses and PT is the same thing
355      but for computing aggregate pass-through functions using a very inclusive
356      ao_ref.  */
357   bool parm_modified, ref_modified, pt_modified;
358 };
359 
360 /* Information related to a given BB that used only when looking at function
361    body.  */
362 
363 struct ipa_bb_info
364 {
365   /* Call graph edges going out of this BB.  */
366   vec<cgraph_edge *> cg_edges;
367   /* Alias analysis statuses of each formal parameter at this bb.  */
368   vec<ipa_param_aa_status> param_aa_statuses;
369 };
370 
371 /* Structure with global information that is only used when looking at function
372    body. */
373 
374 struct ipa_func_body_info
375 {
376   /* The node that is being analyzed.  */
377   cgraph_node *node;
378 
379   /* Its info.  */
380   struct ipa_node_params *info;
381 
382   /* Information about individual BBs. */
383   vec<ipa_bb_info> bb_infos;
384 
385   /* Number of parameters.  */
386   int param_count;
387 
388   /* Number of statements already walked by when analyzing this function.  */
389   unsigned int aa_walked;
390 };
391 
392 /* ipa_node_params access functions.  Please use these to access fields that
393    are or will be shared among various passes.  */
394 
395 /* Return the number of formal parameters. */
396 
397 static inline int
ipa_get_param_count(struct ipa_node_params * info)398 ipa_get_param_count (struct ipa_node_params *info)
399 {
400   return info->descriptors.length ();
401 }
402 
403 /* Return the declaration of Ith formal parameter of the function corresponding
404    to INFO.  Note there is no setter function as this array is built just once
405    using ipa_initialize_node_params. */
406 
407 static inline tree
ipa_get_param(struct ipa_node_params * info,int i)408 ipa_get_param (struct ipa_node_params *info, int i)
409 {
410   gcc_checking_assert (!flag_wpa);
411   return info->descriptors[i].decl;
412 }
413 
414 /* Return the move cost of Ith formal parameter of the function corresponding
415    to INFO.  */
416 
417 static inline int
ipa_get_param_move_cost(struct ipa_node_params * info,int i)418 ipa_get_param_move_cost (struct ipa_node_params *info, int i)
419 {
420   return info->descriptors[i].move_cost;
421 }
422 
423 /* Set the used flag corresponding to the Ith formal parameter of the function
424    associated with INFO to VAL.  */
425 
426 static inline void
ipa_set_param_used(struct ipa_node_params * info,int i,bool val)427 ipa_set_param_used (struct ipa_node_params *info, int i, bool val)
428 {
429   info->descriptors[i].used = val;
430 }
431 
432 /* Return how many uses described by ipa-prop a parameter has or
433    IPA_UNDESCRIBED_USE if there is a use that is not described by these
434    structures.  */
435 static inline int
ipa_get_controlled_uses(struct ipa_node_params * info,int i)436 ipa_get_controlled_uses (struct ipa_node_params *info, int i)
437 {
438   /* FIXME: introducing speuclation causes out of bounds access here.  */
439   if (info->descriptors.length () > (unsigned)i)
440     return info->descriptors[i].controlled_uses;
441   return IPA_UNDESCRIBED_USE;
442 }
443 
444 /* Set the controlled counter of a given parameter.  */
445 
446 static inline void
ipa_set_controlled_uses(struct ipa_node_params * info,int i,int val)447 ipa_set_controlled_uses (struct ipa_node_params *info, int i, int val)
448 {
449   info->descriptors[i].controlled_uses = val;
450 }
451 
452 /* Return the used flag corresponding to the Ith formal parameter of the
453    function associated with INFO.  */
454 
455 static inline bool
ipa_is_param_used(struct ipa_node_params * info,int i)456 ipa_is_param_used (struct ipa_node_params *info, int i)
457 {
458   return info->descriptors[i].used;
459 }
460 
461 /* Information about replacements done in aggregates for a given node (each
462    node has its linked list).  */
463 struct GTY(()) ipa_agg_replacement_value
464 {
465   /* Next item in the linked list.  */
466   struct ipa_agg_replacement_value *next;
467   /* Offset within the aggregate.  */
468   HOST_WIDE_INT offset;
469   /* The constant value.  */
470   tree value;
471   /* The paramter index.  */
472   int index;
473   /* Whether the value was passed by reference.  */
474   bool by_ref;
475 };
476 
477 /* Structure holding information for the transformation phase of IPA-CP.  */
478 
479 struct GTY(()) ipcp_transformation_summary
480 {
481   /* Linked list of known aggregate values.  */
482   ipa_agg_replacement_value *agg_values;
483   /* Alignment information for pointers.  */
484   vec<ipa_alignment, va_gc> *alignments;
485 };
486 
487 void ipa_set_node_agg_value_chain (struct cgraph_node *node,
488 				   struct ipa_agg_replacement_value *aggvals);
489 void ipcp_grow_transformations_if_necessary (void);
490 
491 /* ipa_edge_args stores information related to a callsite and particularly its
492    arguments.  It can be accessed by the IPA_EDGE_REF macro.  */
493 struct GTY(()) ipa_edge_args
494 {
495   /* Vector of the callsite's jump function of each parameter.  */
496   vec<ipa_jump_func, va_gc> *jump_functions;
497   vec<ipa_polymorphic_call_context, va_gc> *polymorphic_call_contexts;
498 };
499 
500 /* ipa_edge_args access functions.  Please use these to access fields that
501    are or will be shared among various passes.  */
502 
503 /* Return the number of actual arguments. */
504 
505 static inline int
ipa_get_cs_argument_count(struct ipa_edge_args * args)506 ipa_get_cs_argument_count (struct ipa_edge_args *args)
507 {
508   return vec_safe_length (args->jump_functions);
509 }
510 
511 /* Returns a pointer to the jump function for the ith argument.  Please note
512    there is no setter function as jump functions are all set up in
513    ipa_compute_jump_functions. */
514 
515 static inline struct ipa_jump_func *
ipa_get_ith_jump_func(struct ipa_edge_args * args,int i)516 ipa_get_ith_jump_func (struct ipa_edge_args *args, int i)
517 {
518   return &(*args->jump_functions)[i];
519 }
520 
521 /* Returns a pointer to the polymorphic call context for the ith argument.
522    NULL if contexts are not computed.  */
523 static inline struct ipa_polymorphic_call_context *
ipa_get_ith_polymorhic_call_context(struct ipa_edge_args * args,int i)524 ipa_get_ith_polymorhic_call_context (struct ipa_edge_args *args, int i)
525 {
526   if (!args->polymorphic_call_contexts)
527     return NULL;
528   return &(*args->polymorphic_call_contexts)[i];
529 }
530 
531 /* Function summary for ipa_node_params.  */
532 class ipa_node_params_t: public function_summary <ipa_node_params *>
533 {
534 public:
ipa_node_params_t(symbol_table * table)535   ipa_node_params_t (symbol_table *table):
536     function_summary<ipa_node_params *> (table) { }
537 
538   /* Hook that is called by summary when a node is duplicated.  */
539   virtual void duplicate (cgraph_node *node,
540 			  cgraph_node *node2,
541 			  ipa_node_params *data,
542 			  ipa_node_params *data2);
543 };
544 
545 /* Function summary where the parameter infos are actually stored. */
546 extern ipa_node_params_t *ipa_node_params_sum;
547 /* Vector of IPA-CP transformation data for each clone.  */
548 extern GTY(()) vec<ipcp_transformation_summary, va_gc> *ipcp_transformations;
549 /* Vector where the parameter infos are actually stored. */
550 extern GTY(()) vec<ipa_edge_args, va_gc> *ipa_edge_args_vector;
551 
552 /* Return the associated parameter/argument info corresponding to the given
553    node/edge.  */
554 #define IPA_NODE_REF(NODE) (ipa_node_params_sum->get (NODE))
555 #define IPA_EDGE_REF(EDGE) (&(*ipa_edge_args_vector)[(EDGE)->uid])
556 /* This macro checks validity of index returned by
557    ipa_get_param_decl_index function.  */
558 #define IS_VALID_JUMP_FUNC_INDEX(I) ((I) != -1)
559 
560 /* Creating and freeing ipa_node_params and ipa_edge_args.  */
561 void ipa_create_all_node_params (void);
562 void ipa_create_all_edge_args (void);
563 void ipa_free_edge_args_substructures (struct ipa_edge_args *);
564 void ipa_free_all_node_params (void);
565 void ipa_free_all_edge_args (void);
566 void ipa_free_all_structures_after_ipa_cp (void);
567 void ipa_free_all_structures_after_iinln (void);
568 
569 void ipa_register_cgraph_hooks (void);
570 int count_formal_params (tree fndecl);
571 
572 /* This function ensures the array of node param infos is big enough to
573    accommodate a structure for all nodes and reallocates it if not.  */
574 
575 static inline void
ipa_check_create_node_params(void)576 ipa_check_create_node_params (void)
577 {
578   if (!ipa_node_params_sum)
579     ipa_node_params_sum = new ipa_node_params_t (symtab);
580 }
581 
582 /* This function ensures the array of edge arguments infos is big enough to
583    accommodate a structure for all edges and reallocates it if not.  */
584 
585 static inline void
ipa_check_create_edge_args(void)586 ipa_check_create_edge_args (void)
587 {
588   if (vec_safe_length (ipa_edge_args_vector)
589       <= (unsigned) symtab->edges_max_uid)
590     vec_safe_grow_cleared (ipa_edge_args_vector, symtab->edges_max_uid + 1);
591 }
592 
593 /* Returns true if the array of edge infos is large enough to accommodate an
594    info for EDGE.  The main purpose of this function is that debug dumping
595    function can check info availability without causing reallocations.  */
596 
597 static inline bool
ipa_edge_args_info_available_for_edge_p(struct cgraph_edge * edge)598 ipa_edge_args_info_available_for_edge_p (struct cgraph_edge *edge)
599 {
600   return ((unsigned) edge->uid < vec_safe_length (ipa_edge_args_vector));
601 }
602 
603 static inline ipcp_transformation_summary *
ipcp_get_transformation_summary(cgraph_node * node)604 ipcp_get_transformation_summary (cgraph_node *node)
605 {
606   if ((unsigned) node->uid >= vec_safe_length (ipcp_transformations))
607     return NULL;
608   return &(*ipcp_transformations)[node->uid];
609 }
610 
611 /* Return the aggregate replacements for NODE, if there are any.  */
612 
613 static inline struct ipa_agg_replacement_value *
ipa_get_agg_replacements_for_node(cgraph_node * node)614 ipa_get_agg_replacements_for_node (cgraph_node *node)
615 {
616   ipcp_transformation_summary *ts = ipcp_get_transformation_summary (node);
617   return ts ? ts->agg_values : NULL;
618 }
619 
620 /* Function formal parameters related computations.  */
621 void ipa_initialize_node_params (struct cgraph_node *node);
622 bool ipa_propagate_indirect_call_infos (struct cgraph_edge *cs,
623 					vec<cgraph_edge *> *new_edges);
624 
625 /* Indirect edge and binfo processing.  */
626 tree ipa_get_indirect_edge_target (struct cgraph_edge *ie,
627 				   vec<tree> ,
628 				   vec<ipa_polymorphic_call_context>,
629 				   vec<ipa_agg_jump_function_p>,
630 				   bool *);
631 struct cgraph_edge *ipa_make_edge_direct_to_target (struct cgraph_edge *, tree,
632 						    bool speculative = false);
633 tree ipa_impossible_devirt_target (struct cgraph_edge *, tree);
634 
635 /* Functions related to both.  */
636 void ipa_analyze_node (struct cgraph_node *);
637 
638 /* Aggregate jump function related functions.  */
639 tree ipa_find_agg_cst_for_param (struct ipa_agg_jump_function *, HOST_WIDE_INT,
640 				 bool);
641 bool ipa_load_from_parm_agg (struct ipa_func_body_info *,
642 			     vec<ipa_param_descriptor>, gimple *, tree, int *,
643 			     HOST_WIDE_INT *, HOST_WIDE_INT *, bool *);
644 
645 /* Debugging interface.  */
646 void ipa_print_node_params (FILE *, struct cgraph_node *node);
647 void ipa_print_all_params (FILE *);
648 void ipa_print_node_jump_functions (FILE *f, struct cgraph_node *node);
649 void ipa_print_all_jump_functions (FILE * f);
650 void ipcp_verify_propagated_values (void);
651 
652 template <typename value>
653 class ipcp_value;
654 
655 extern object_allocator<ipcp_value<tree> > ipcp_cst_values_pool;
656 extern object_allocator<ipcp_value<ipa_polymorphic_call_context> >
657   ipcp_poly_ctx_values_pool;
658 
659 template <typename valtype>
660 class ipcp_value_source;
661 
662 extern object_allocator<ipcp_value_source<tree> > ipcp_sources_pool;
663 
664 class ipcp_agg_lattice;
665 
666 extern object_allocator<ipcp_agg_lattice> ipcp_agg_lattice_pool;
667 
668 /* Operation to be performed for the parameter in ipa_parm_adjustment
669    below.  */
670 enum ipa_parm_op {
671   IPA_PARM_OP_NONE,
672 
673   /* This describes a brand new parameter.
674 
675      The field `type' should be set to the new type, `arg_prefix'
676      should be set to the string prefix for the new DECL_NAME, and
677      `new_decl' will ultimately hold the newly created argument.  */
678   IPA_PARM_OP_NEW,
679 
680   /* This new parameter is an unmodified parameter at index base_index. */
681   IPA_PARM_OP_COPY,
682 
683   /* This adjustment describes a parameter that is about to be removed
684      completely.  Most users will probably need to book keep those so that they
685      don't leave behinfd any non default def ssa names belonging to them.  */
686   IPA_PARM_OP_REMOVE
687 };
688 
689 /* Structure to describe transformations of formal parameters and actual
690    arguments.  Each instance describes one new parameter and they are meant to
691    be stored in a vector.  Additionally, most users will probably want to store
692    adjustments about parameters that are being removed altogether so that SSA
693    names belonging to them can be replaced by SSA names of an artificial
694    variable.  */
695 struct ipa_parm_adjustment
696 {
697   /* The original PARM_DECL itself, helpful for processing of the body of the
698      function itself.  Intended for traversing function bodies.
699      ipa_modify_formal_parameters, ipa_modify_call_arguments and
700      ipa_combine_adjustments ignore this and use base_index.
701      ipa_modify_formal_parameters actually sets this.  */
702   tree base;
703 
704   /* Type of the new parameter.  However, if by_ref is true, the real type will
705      be a pointer to this type.  */
706   tree type;
707 
708   /* Alias refrerence type to be used in MEM_REFs when adjusting caller
709      arguments.  */
710   tree alias_ptr_type;
711 
712   /* The new declaration when creating/replacing a parameter.  Created
713      by ipa_modify_formal_parameters, useful for functions modifying
714      the body accordingly.  For brand new arguments, this is the newly
715      created argument.  */
716   tree new_decl;
717 
718   /* New declaration of a substitute variable that we may use to replace all
719      non-default-def ssa names when a parm decl is going away.  */
720   tree new_ssa_base;
721 
722   /* If non-NULL and the original parameter is to be removed (copy_param below
723      is NULL), this is going to be its nonlocalized vars value.  */
724   tree nonlocal_value;
725 
726   /* This holds the prefix to be used for the new DECL_NAME.  */
727   const char *arg_prefix;
728 
729   /* Offset into the original parameter (for the cases when the new parameter
730      is a component of an original one).  */
731   HOST_WIDE_INT offset;
732 
733   /* Zero based index of the original parameter this one is based on.  */
734   int base_index;
735 
736   /* Whether this parameter is a new parameter, a copy of an old one,
737      or one about to be removed.  */
738   enum ipa_parm_op op;
739 
740   /* Storage order of the original parameter (for the cases when the new
741      parameter is a component of an original one).  */
742   unsigned reverse : 1;
743 
744   /* The parameter is to be passed by reference.  */
745   unsigned by_ref : 1;
746 };
747 
748 typedef vec<ipa_parm_adjustment> ipa_parm_adjustment_vec;
749 
750 vec<tree> ipa_get_vector_of_formal_parms (tree fndecl);
751 vec<tree> ipa_get_vector_of_formal_parm_types (tree fntype);
752 void ipa_modify_formal_parameters (tree fndecl, ipa_parm_adjustment_vec);
753 void ipa_modify_call_arguments (struct cgraph_edge *, gcall *,
754 				ipa_parm_adjustment_vec);
755 ipa_parm_adjustment_vec ipa_combine_adjustments (ipa_parm_adjustment_vec,
756 						 ipa_parm_adjustment_vec);
757 void ipa_dump_param_adjustments (FILE *, ipa_parm_adjustment_vec, tree);
758 void ipa_dump_agg_replacement_values (FILE *f,
759 				      struct ipa_agg_replacement_value *av);
760 void ipa_prop_write_jump_functions (void);
761 void ipa_prop_read_jump_functions (void);
762 void ipcp_write_transformation_summaries (void);
763 void ipcp_read_transformation_summaries (void);
764 void ipa_update_after_lto_read (void);
765 int ipa_get_param_decl_index (struct ipa_node_params *, tree);
766 tree ipa_value_from_jfunc (struct ipa_node_params *info,
767 			   struct ipa_jump_func *jfunc);
768 unsigned int ipcp_transform_function (struct cgraph_node *node);
769 ipa_polymorphic_call_context ipa_context_from_jfunc (ipa_node_params *,
770 						     cgraph_edge *,
771 						     int,
772 						     ipa_jump_func *);
773 void ipa_dump_param (FILE *, struct ipa_node_params *info, int i);
774 bool ipa_modify_expr (tree *, bool, ipa_parm_adjustment_vec);
775 ipa_parm_adjustment *ipa_get_adjustment_candidate (tree **, bool *,
776 						   ipa_parm_adjustment_vec,
777 						   bool);
778 void ipa_release_body_info (struct ipa_func_body_info *);
779 
780 /* From tree-sra.c:  */
781 tree build_ref_for_offset (location_t, tree, HOST_WIDE_INT, bool, tree,
782 			   gimple_stmt_iterator *, bool);
783 
784 /* In ipa-cp.c  */
785 void ipa_cp_c_finalize (void);
786 
787 #endif /* IPA_PROP_H */
788