gcc/ipa-prop.h

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