gcc/ipa-prop.h

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