gcc/ipa-prop.h

   1 /* Interprocedural analyses.
   2    Copyright (C) 2005-2014 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 #include "vec.h"
  24 #include "cgraph.h"
  25 #include "alloc-pool.h"
  26
  27 /* The following definitions and interfaces are used by
  28    interprocedural analyses or parameters.  */
  29
  30 #define IPA_UNDESCRIBED_USE -1
  31
  32 /* ipa-prop.c stuff (ipa-cp, indirect inlining):  */
  33
  34 /* A jump function for a callsite represents the values passed as actual
  35    arguments of the callsite.  They were originally proposed in a paper called
  36    "Interprocedural Constant Propagation", by David Callahan, Keith D Cooper,
  37    Ken Kennedy, Linda Torczon in Comp86, pg 152-161.  There are three main
  38    types of values :
  39
  40    Pass-through - the caller's formal parameter is passed as an actual
  41                   argument, possibly one simple operation performed on it.
  42    Constant     - a constant (is_gimple_ip_invariant)is passed as an actual
  43                   argument.
  44    Unknown      - neither of the above.
  45
  46    IPA_JF_ANCESTOR is a special pass-through jump function, which means that
  47    the result is an address of a part of the object pointed to by the formal
  48    parameter to which the function refers.  It is mainly intended to represent
  49    getting addresses of of ancestor fields in C++
  50    (e.g. &this_1(D)->D.1766.D.1756).  Note that if the original pointer is
  51    NULL, ancestor jump function must behave like a simple pass-through.
  52
  53    Other pass-through functions can either simply pass on an unchanged formal
  54    parameter or can apply one simple binary operation to it (such jump
  55    functions are called polynomial).
  56
  57    IPA_JF_KNOWN_TYPE is a special type of an "unknown" function that applies
  58    only to pointer parameters.  It means that even though we cannot prove that
  59    the passed value is an interprocedural constant, we still know the exact
  60    type of the containing object which may be valuable for devirtualization.
  61
  62    Jump functions are computed in ipa-prop.c by function
  63    update_call_notes_after_inlining.  Some information can be lost and jump
  64    functions degraded accordingly when inlining, see
  65    update_call_notes_after_inlining in the same file.  */
  66
  67 enum jump_func_type
  68 {
  69   IPA_JF_UNKNOWN = 0,  /* newly allocated and zeroed jump functions default */
  70   IPA_JF_KNOWN_TYPE,        /* represented by field known_type */
  71   IPA_JF_CONST,             /* represented by field costant */
  72   IPA_JF_PASS_THROUGH,      /* represented by field pass_through */
  73   IPA_JF_ANCESTOR           /* represented by field ancestor */
  74 };
  75
  76 /* Structure holding data required to describe a known type jump function.  */
  77 struct GTY(()) ipa_known_type_data
  78 {
  79   /* Offset of the component of the base_type being described.  */
  80   HOST_WIDE_INT offset;
  81   /* Type of the whole object.  */
  82   tree base_type;
  83   /* Type of the component of the object that is being described.  */
  84   tree component_type;
  85 };
  86
  87 struct ipa_cst_ref_desc;
  88
  89 /* Structure holding data required to describe a constant jump function.  */
  90 struct GTY(()) ipa_constant_data
  91 {
  92   /* THe value of the constant.  */
  93   tree value;
  94   /* Pointer to the structure that describes the reference.  */
  95   struct ipa_cst_ref_desc GTY((skip)) *rdesc;
  96 };
  97
  98 /* Structure holding data required to describe a pass-through jump function.  */
  99
 100 struct GTY(()) ipa_pass_through_data
 101 {
 102   /* If an operation is to be performed on the original parameter, this is the
 103      second (constant) operand.  */
 104   tree operand;
 105   /* Number of the caller's formal parameter being passed.  */
 106   int formal_id;
 107   /* Operation that is performed on the argument before it is passed on.
 108      NOP_EXPR means no operation.  Otherwise oper must be a simple binary
 109      arithmetic operation where the caller's parameter is the first operand and
 110      operand field from this structure is the second one.  */
 111   enum tree_code operation;
 112   /* When the passed value is a pointer, it is set to true only when we are
 113      certain that no write to the object it points to has occurred since the
 114      caller functions started execution, except for changes noted in the
 115      aggregate part of the jump function (see description of
 116      ipa_agg_jump_function).  The flag is used only when the operation is
 117      NOP_EXPR.  */
 118   unsigned agg_preserved : 1;
 119
 120   /* When set to true, we guarantee that, if there is a C++ object pointed to
 121      by this object, it does not undergo dynamic type change in the course of
 122      functions decribed by this jump function.  */
 123   unsigned type_preserved : 1;
 124 };
 125
 126 /* Structure holding data required to describe an ancestor pass-through
 127    jump function.  */
 128
 129 struct GTY(()) ipa_ancestor_jf_data
 130 {
 131   /* Offset of the field representing the ancestor.  */
 132   HOST_WIDE_INT offset;
 133   /* Type of the result.
 134      When TYPE_PRESERVED is false, TYPE is NULL, since it is only
 135      relevant for the devirtualization machinery.  */
 136   tree type;
 137   /* Number of the caller's formal parameter being passed.  */
 138   int formal_id;
 139   /* Flag with the same meaning like agg_preserve in ipa_pass_through_data.  */
 140   unsigned agg_preserved : 1;
 141   /* When set to true, we guarantee that, if there is a C++ object pointed to
 142      by this object, it does not undergo dynamic type change in the course of
 143      functions decribed by this jump function.  */
 144   unsigned type_preserved : 1;
 145 };
 146
 147 /* An element in an aggegate part of a jump function describing a known value
 148    at a given offset.  When it is part of a pass-through jump function with
 149    agg_preserved set or an ancestor jump function with agg_preserved set, all
 150    unlisted positions are assumed to be preserved but the value can be a type
 151    node, which means that the particular piece (starting at offset and having
 152    the size of the type) is clobbered with an unknown value.  When
 153    agg_preserved is false or the type of the containing jump function is
 154    different, all unlisted parts are assumed to be unknown and all values must
 155    fulfill is_gimple_ip_invariant.  */
 156
 157 struct GTY(()) ipa_agg_jf_item
 158 {
 159   /* The offset at which the known value is located within the aggregate.  */
 160   HOST_WIDE_INT offset;
 161
 162   /* The known constant or type if this is a clobber.  */
 163   tree value;
 164 };
 165
 166
 167 /* Aggregate jump function - i.e. description of contents of aggregates passed
 168    either by reference or value.  */
 169
 170 struct GTY(()) ipa_agg_jump_function
 171 {
 172   /* Description of the individual items.  */
 173   vec<ipa_agg_jf_item, va_gc> *items;
 174   /* True if the data was passed by reference (as opposed to by value). */
 175   bool by_ref;
 176 };
 177
 178 typedef struct ipa_agg_jump_function *ipa_agg_jump_function_p;
 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   enum jump_func_type type;
 190   /* Represents a value of a jump function.  pass_through is used only in jump
 191      function context.  constant represents the actual constant in constant jump
 192      functions and member_cst holds constant c++ member functions.  */
 193   union jump_func_value
 194   {
 195     struct ipa_known_type_data GTY ((tag ("IPA_JF_KNOWN_TYPE"))) known_type;
 196     struct ipa_constant_data GTY ((tag ("IPA_JF_CONST"))) constant;
 197     struct ipa_pass_through_data GTY ((tag ("IPA_JF_PASS_THROUGH"))) pass_through;
 198     struct ipa_ancestor_jf_data GTY ((tag ("IPA_JF_ANCESTOR"))) ancestor;
 199   } GTY ((desc ("%1.type"))) value;
 200 };
 201
 202
 203 /* Return the offset of the component that is described by a known type jump
 204    function JFUNC.  */
 205
 206 static inline HOST_WIDE_INT
 207 ipa_get_jf_known_type_offset (struct ipa_jump_func *jfunc)
 208 {
 209   gcc_checking_assert (jfunc->type == IPA_JF_KNOWN_TYPE);
 210   return jfunc->value.known_type.offset;
 211 }
 212
 213 /* Return the base type of a known type jump function JFUNC.  */
 214
 215 static inline tree
 216 ipa_get_jf_known_type_base_type (struct ipa_jump_func *jfunc)
 217 {
 218   gcc_checking_assert (jfunc->type == IPA_JF_KNOWN_TYPE);
 219   return jfunc->value.known_type.base_type;
 220 }
 221
 222 /* Return the component type of a known type jump function JFUNC.  */
 223
 224 static inline tree
 225 ipa_get_jf_known_type_component_type (struct ipa_jump_func *jfunc)
 226 {
 227   gcc_checking_assert (jfunc->type == IPA_JF_KNOWN_TYPE);
 228   return jfunc->value.known_type.component_type;
 229 }
 230
 231 /* Return the constant stored in a constant jump functin JFUNC.  */
 232
 233 static inline tree
 234 ipa_get_jf_constant (struct ipa_jump_func *jfunc)
 235 {
 236   gcc_checking_assert (jfunc->type == IPA_JF_CONST);
 237   return jfunc->value.constant.value;
 238 }
 239
 240 static inline struct ipa_cst_ref_desc *
 241 ipa_get_jf_constant_rdesc (struct ipa_jump_func *jfunc)
 242 {
 243   gcc_checking_assert (jfunc->type == IPA_JF_CONST);
 244   return jfunc->value.constant.rdesc;
 245 }
 246
 247 /* Return the operand of a pass through jmp function JFUNC.  */
 248
 249 static inline tree
 250 ipa_get_jf_pass_through_operand (struct ipa_jump_func *jfunc)
 251 {
 252   gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
 253   return jfunc->value.pass_through.operand;
 254 }
 255
 256 /* Return the number of the caller's formal parameter that a pass through jump
 257    function JFUNC refers to.  */
 258
 259 static inline int
 260 ipa_get_jf_pass_through_formal_id (struct ipa_jump_func *jfunc)
 261 {
 262   gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
 263   return jfunc->value.pass_through.formal_id;
 264 }
 265
 266 /* Return operation of a pass through jump function JFUNC.  */
 267
 268 static inline enum tree_code
 269 ipa_get_jf_pass_through_operation (struct ipa_jump_func *jfunc)
 270 {
 271   gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
 272   return jfunc->value.pass_through.operation;
 273 }
 274
 275 /* Return the agg_preserved flag of a pass through jump function JFUNC.  */
 276
 277 static inline bool
 278 ipa_get_jf_pass_through_agg_preserved (struct ipa_jump_func *jfunc)
 279 {
 280   gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
 281   return jfunc->value.pass_through.agg_preserved;
 282 }
 283
 284 /* Return the type_preserved flag of a pass through jump function JFUNC.  */
 285
 286 static inline bool
 287 ipa_get_jf_pass_through_type_preserved (struct ipa_jump_func *jfunc)
 288 {
 289   gcc_checking_assert (jfunc->type == IPA_JF_PASS_THROUGH);
 290   return jfunc->value.pass_through.type_preserved;
 291 }
 292
 293 /* Return the offset of an ancestor jump function JFUNC.  */
 294
 295 static inline HOST_WIDE_INT
 296 ipa_get_jf_ancestor_offset (struct ipa_jump_func *jfunc)
 297 {
 298   gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
 299   return jfunc->value.ancestor.offset;
 300 }
 301
 302 /* Return the result type of an ancestor jump function JFUNC.  */
 303
 304 static inline tree
 305 ipa_get_jf_ancestor_type (struct ipa_jump_func *jfunc)
 306 {
 307   gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
 308   return jfunc->value.ancestor.type;
 309 }
 310
 311 /* Return the number of the caller's formal parameter that an ancestor jump
 312    function JFUNC refers to.  */
 313
 314 static inline int
 315 ipa_get_jf_ancestor_formal_id (struct ipa_jump_func *jfunc)
 316 {
 317   gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
 318   return jfunc->value.ancestor.formal_id;
 319 }
 320
 321 /* Return the agg_preserved flag of an ancestor jump function JFUNC.  */
 322
 323 static inline bool
 324 ipa_get_jf_ancestor_agg_preserved (struct ipa_jump_func *jfunc)
 325 {
 326   gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
 327   return jfunc->value.ancestor.agg_preserved;
 328 }
 329
 330 /* Return the type_preserved flag of an ancestor jump function JFUNC.  */
 331
 332 static inline bool
 333 ipa_get_jf_ancestor_type_preserved (struct ipa_jump_func *jfunc)
 334 {
 335   gcc_checking_assert (jfunc->type == IPA_JF_ANCESTOR);
 336   return jfunc->value.ancestor.type_preserved;
 337 }
 338
 339 /* Summary describing a single formal parameter.  */
 340
 341 struct ipa_param_descriptor
 342 {
 343   /* PARAM_DECL of this parameter.  */
 344   tree decl;
 345   /* If all uses of the parameter are described by ipa-prop structures, this
 346      says how many there are.  If any use could not be described by means of
 347      ipa-prop structures, this is IPA_UNDESCRIBED_USE.  */
 348   int controlled_uses;
 349   unsigned int move_cost : 31;
 350   /* The parameter is used.  */
 351   unsigned used : 1;
 352 };
 353
 354 struct ipcp_lattice;
 355
 356 /* ipa_node_params stores information related to formal parameters of functions
 357    and some other information for interprocedural passes that operate on
 358    parameters (such as ipa-cp).  */
 359
 360 struct ipa_node_params
 361 {
 362   /* Information about individual formal parameters that are gathered when
 363      summaries are generated. */
 364   vec<ipa_param_descriptor> descriptors;
 365   /* Pointer to an array of structures describing individual formal
 366      parameters.  */
 367   struct ipcp_param_lattices *lattices;
 368   /* Only for versioned nodes this field would not be NULL,
 369      it points to the node that IPA cp cloned from.  */
 370   struct cgraph_node *ipcp_orig_node;
 371   /* If this node is an ipa-cp clone, these are the known values that describe
 372      what it has been specialized for.  */
 373   vec<tree> known_vals;
 374   /* Whether the param uses analysis and jump function computation has already
 375      been performed.  */
 376   unsigned analysis_done : 1;
 377   /* Whether the function is enqueued in ipa-cp propagation stack.  */
 378   unsigned node_enqueued : 1;
 379   /* Whether we should create a specialized version based on values that are
 380      known to be constant in all contexts.  */
 381   unsigned do_clone_for_all_contexts : 1;
 382   /* Set if this is an IPA-CP clone for all contexts.  */
 383   unsigned is_all_contexts_clone : 1;
 384   /* Node has been completely replaced by clones and will be removed after
 385      ipa-cp is finished.  */
 386   unsigned node_dead : 1;
 387 };
 388
 389 /* ipa_node_params access functions.  Please use these to access fields that
 390    are or will be shared among various passes.  */
 391
 392 /* Return the number of formal parameters. */
 393
 394 static inline int
 395 ipa_get_param_count (struct ipa_node_params *info)
 396 {
 397   return info->descriptors.length ();
 398 }
 399
 400 /* Return the declaration of Ith formal parameter of the function corresponding
 401    to INFO.  Note there is no setter function as this array is built just once
 402    using ipa_initialize_node_params. */
 403
 404 static inline tree
 405 ipa_get_param (struct ipa_node_params *info, int i)
 406 {
 407   gcc_checking_assert (!flag_wpa);
 408   return info->descriptors[i].decl;
 409 }
 410
 411 /* Return the move cost of Ith formal parameter of the function corresponding
 412    to INFO.  */
 413
 414 static inline int
 415 ipa_get_param_move_cost (struct ipa_node_params *info, int i)
 416 {
 417   return info->descriptors[i].move_cost;
 418 }
 419
 420 /* Set the used flag corresponding to the Ith formal parameter of the function
 421    associated with INFO to VAL.  */
 422
 423 static inline void
 424 ipa_set_param_used (struct ipa_node_params *info, int i, bool val)
 425 {
 426   info->descriptors[i].used = val;
 427 }
 428
 429 /* Return how many uses described by ipa-prop a parameter has or
 430    IPA_UNDESCRIBED_USE if there is a use that is not described by these
 431    structures.  */
 432 static inline int
 433 ipa_get_controlled_uses (struct ipa_node_params *info, int i)
 434 {
 435   return info->descriptors[i].controlled_uses;
 436 }
 437
 438 /* Set the controlled counter of a given parameter.  */
 439
 440 static inline void
 441 ipa_set_controlled_uses (struct ipa_node_params *info, int i, int val)
 442 {
 443   info->descriptors[i].controlled_uses = val;
 444 }
 445
 446 /* Return the used flag corresponding to the Ith formal parameter of the
 447    function associated with INFO.  */
 448
 449 static inline bool
 450 ipa_is_param_used (struct ipa_node_params *info, int i)
 451 {
 452   return info->descriptors[i].used;
 453 }
 454
 455 /* Information about replacements done in aggregates for a given node (each
 456    node has its linked list).  */
 457 struct GTY(()) ipa_agg_replacement_value
 458 {
 459   /* Next item in the linked list.  */
 460   struct ipa_agg_replacement_value *next;
 461   /* Offset within the aggregate.  */
 462   HOST_WIDE_INT offset;
 463   /* The constant value.  */
 464   tree value;
 465   /* The paramter index.  */
 466   int index;
 467   /* Whether the value was passed by reference.  */
 468   bool by_ref;
 469 };
 470
 471 typedef struct ipa_agg_replacement_value *ipa_agg_replacement_value_p;
 472
 473 void ipa_set_node_agg_value_chain (struct cgraph_node *node,
 474                                    struct ipa_agg_replacement_value *aggvals);
 475
 476 /* ipa_edge_args stores information related to a callsite and particularly its
 477    arguments.  It can be accessed by the IPA_EDGE_REF macro.  */
 478 struct GTY(()) ipa_edge_args
 479 {
 480   /* Vector of the callsite's jump function of each parameter.  */
 481   vec<ipa_jump_func, va_gc> *jump_functions;
 482 };
 483
 484 /* ipa_edge_args access functions.  Please use these to access fields that
 485    are or will be shared among various passes.  */
 486
 487 /* Return the number of actual arguments. */
 488
 489 static inline int
 490 ipa_get_cs_argument_count (struct ipa_edge_args *args)
 491 {
 492   return vec_safe_length (args->jump_functions);
 493 }
 494
 495 /* Returns a pointer to the jump function for the ith argument.  Please note
 496    there is no setter function as jump functions are all set up in
 497    ipa_compute_jump_functions. */
 498
 499 static inline struct ipa_jump_func *
 500 ipa_get_ith_jump_func (struct ipa_edge_args *args, int i)
 501 {
 502   return &(*args->jump_functions)[i];
 503 }
 504
 505 /* Types of vectors holding the infos.  */
 506
 507 /* Vector where the parameter infos are actually stored. */
 508 extern vec<ipa_node_params> ipa_node_params_vector;
 509 /* Vector of known aggregate values in cloned nodes.  */
 510 extern GTY(()) vec<ipa_agg_replacement_value_p, va_gc> *ipa_node_agg_replacements;
 511 /* Vector where the parameter infos are actually stored. */
 512 extern GTY(()) vec<ipa_edge_args, va_gc> *ipa_edge_args_vector;
 513
 514 /* Return the associated parameter/argument info corresponding to the given
 515    node/edge.  */
 516 #define IPA_NODE_REF(NODE) (&ipa_node_params_vector[(NODE)->uid])
 517 #define IPA_EDGE_REF(EDGE) (&(*ipa_edge_args_vector)[(EDGE)->uid])
 518 /* This macro checks validity of index returned by
 519    ipa_get_param_decl_index function.  */
 520 #define IS_VALID_JUMP_FUNC_INDEX(I) ((I) != -1)
 521
 522 /* Creating and freeing ipa_node_params and ipa_edge_args.  */
 523 void ipa_create_all_node_params (void);
 524 void ipa_create_all_edge_args (void);
 525 void ipa_free_edge_args_substructures (struct ipa_edge_args *);
 526 void ipa_free_node_params_substructures (struct ipa_node_params *);
 527 void ipa_free_all_node_params (void);
 528 void ipa_free_all_edge_args (void);
 529 void ipa_free_all_structures_after_ipa_cp (void);
 530 void ipa_free_all_structures_after_iinln (void);
 531 void ipa_register_cgraph_hooks (void);
 532 int count_formal_params (tree fndecl);
 533
 534 /* This function ensures the array of node param infos is big enough to
 535    accommodate a structure for all nodes and reallocates it if not.  */
 536
 537 static inline void
 538 ipa_check_create_node_params (void)
 539 {
 540   if (!ipa_node_params_vector.exists ())
 541     ipa_node_params_vector.create (symtab->cgraph_max_uid);
 542
 543   if (ipa_node_params_vector.length () <= (unsigned) symtab->cgraph_max_uid)
 544     ipa_node_params_vector.safe_grow_cleared (symtab->cgraph_max_uid + 1);
 545 }
 546
 547 /* This function ensures the array of edge arguments infos is big enough to
 548    accommodate a structure for all edges and reallocates it if not.  */
 549
 550 static inline void
 551 ipa_check_create_edge_args (void)
 552 {
 553   if (vec_safe_length (ipa_edge_args_vector)
 554       <= (unsigned) symtab->edges_max_uid)
 555     vec_safe_grow_cleared (ipa_edge_args_vector, symtab->edges_max_uid + 1);
 556 }
 557
 558 /* Returns true if the array of edge infos is large enough to accommodate an
 559    info for EDGE.  The main purpose of this function is that debug dumping
 560    function can check info availability without causing reallocations.  */
 561
 562 static inline bool
 563 ipa_edge_args_info_available_for_edge_p (struct cgraph_edge *edge)
 564 {
 565   return ((unsigned) edge->uid < vec_safe_length (ipa_edge_args_vector));
 566 }
 567
 568 /* Return the aggregate replacements for NODE, if there are any.  */
 569
 570 static inline struct ipa_agg_replacement_value *
 571 ipa_get_agg_replacements_for_node (struct cgraph_node *node)
 572 {
 573   if ((unsigned) node->uid >= vec_safe_length (ipa_node_agg_replacements))
 574     return NULL;
 575   return (*ipa_node_agg_replacements)[node->uid];
 576 }
 577
 578 /* Function formal parameters related computations.  */
 579 void ipa_initialize_node_params (struct cgraph_node *node);
 580 bool ipa_propagate_indirect_call_infos (struct cgraph_edge *cs,
 581                                         vec<cgraph_edge *> *new_edges);
 582
 583 /* Indirect edge and binfo processing.  */
 584 tree ipa_get_indirect_edge_target (struct cgraph_edge *ie,
 585                                    vec<tree> ,
 586                                    vec<tree> ,
 587                                    vec<ipa_agg_jump_function_p> );
 588 struct cgraph_edge *ipa_make_edge_direct_to_target (struct cgraph_edge *, tree);
 589 tree ipa_binfo_from_known_type_jfunc (struct ipa_jump_func *);
 590 tree ipa_intraprocedural_devirtualization (gimple);
 591 tree ipa_impossible_devirt_target (struct cgraph_edge *, tree);
 592
 593 /* Functions related to both.  */
 594 void ipa_analyze_node (struct cgraph_node *);
 595
 596 /* Aggregate jump function related functions.  */
 597 tree ipa_find_agg_cst_for_param (struct ipa_agg_jump_function *, HOST_WIDE_INT,
 598                                  bool);
 599 bool ipa_load_from_parm_agg (struct ipa_node_params *, gimple, tree, int *,
 600                              HOST_WIDE_INT *, bool *);
 601
 602 /* Debugging interface.  */
 603 void ipa_print_node_params (FILE *, struct cgraph_node *node);
 604 void ipa_print_all_params (FILE *);
 605 void ipa_print_node_jump_functions (FILE *f, struct cgraph_node *node);
 606 void ipa_print_all_jump_functions (FILE * f);
 607 void ipcp_verify_propagated_values (void);
 608
 609 extern alloc_pool ipcp_values_pool;
 610 extern alloc_pool ipcp_sources_pool;
 611 extern alloc_pool ipcp_agg_lattice_pool;
 612
 613 /* Operation to be performed for the parameter in ipa_parm_adjustment
 614    below.  */
 615 enum ipa_parm_op {
 616   IPA_PARM_OP_NONE,
 617
 618   /* This describes a brand new parameter.
 619
 620      The field `type' should be set to the new type, `arg_prefix'
 621      should be set to the string prefix for the new DECL_NAME, and
 622      `new_decl' will ultimately hold the newly created argument.  */
 623   IPA_PARM_OP_NEW,
 624
 625   /* This new parameter is an unmodified parameter at index base_index. */
 626   IPA_PARM_OP_COPY,
 627
 628   /* This adjustment describes a parameter that is about to be removed
 629      completely.  Most users will probably need to book keep those so that they
 630      don't leave behinfd any non default def ssa names belonging to them.  */
 631   IPA_PARM_OP_REMOVE
 632 };
 633
 634 /* Structure to describe transformations of formal parameters and actual
 635    arguments.  Each instance describes one new parameter and they are meant to
 636    be stored in a vector.  Additionally, most users will probably want to store
 637    adjustments about parameters that are being removed altogether so that SSA
 638    names belonging to them can be replaced by SSA names of an artificial
 639    variable.  */
 640 struct ipa_parm_adjustment
 641 {
 642   /* The original PARM_DECL itself, helpful for processing of the body of the
 643      function itself.  Intended for traversing function bodies.
 644      ipa_modify_formal_parameters, ipa_modify_call_arguments and
 645      ipa_combine_adjustments ignore this and use base_index.
 646      ipa_modify_formal_parameters actually sets this.  */
 647   tree base;
 648
 649   /* Type of the new parameter.  However, if by_ref is true, the real type will
 650      be a pointer to this type.  */
 651   tree type;
 652
 653   /* Alias refrerence type to be used in MEM_REFs when adjusting caller
 654      arguments.  */
 655   tree alias_ptr_type;
 656
 657   /* The new declaration when creating/replacing a parameter.  Created
 658      by ipa_modify_formal_parameters, useful for functions modifying
 659      the body accordingly.  For brand new arguments, this is the newly
 660      created argument.  */
 661   tree new_decl;
 662
 663   /* New declaration of a substitute variable that we may use to replace all
 664      non-default-def ssa names when a parm decl is going away.  */
 665   tree new_ssa_base;
 666
 667   /* If non-NULL and the original parameter is to be removed (copy_param below
 668      is NULL), this is going to be its nonlocalized vars value.  */
 669   tree nonlocal_value;
 670
 671   /* This holds the prefix to be used for the new DECL_NAME.  */
 672   const char *arg_prefix;
 673
 674   /* Offset into the original parameter (for the cases when the new parameter
 675      is a component of an original one).  */
 676   HOST_WIDE_INT offset;
 677
 678   /* Zero based index of the original parameter this one is based on.  */
 679   int base_index;
 680
 681   /* Whether this parameter is a new parameter, a copy of an old one,
 682      or one about to be removed.  */
 683   enum ipa_parm_op op;
 684
 685   /* The parameter is to be passed by reference.  */
 686   unsigned by_ref : 1;
 687 };
 688
 689 typedef vec<ipa_parm_adjustment> ipa_parm_adjustment_vec;
 690
 691 vec<tree> ipa_get_vector_of_formal_parms (tree fndecl);
 692 vec<tree> ipa_get_vector_of_formal_parm_types (tree fntype);
 693 void ipa_modify_formal_parameters (tree fndecl, ipa_parm_adjustment_vec);
 694 void ipa_modify_call_arguments (struct cgraph_edge *, gimple,
 695                                 ipa_parm_adjustment_vec);
 696 ipa_parm_adjustment_vec ipa_combine_adjustments (ipa_parm_adjustment_vec,
 697                                                  ipa_parm_adjustment_vec);
 698 void ipa_dump_param_adjustments (FILE *, ipa_parm_adjustment_vec, tree);
 699 void ipa_dump_agg_replacement_values (FILE *f,
 700                                       struct ipa_agg_replacement_value *av);
 701 void ipa_prop_write_jump_functions (void);
 702 void ipa_prop_read_jump_functions (void);
 703 void ipa_prop_write_all_agg_replacement (void);
 704 void ipa_prop_read_all_agg_replacement (void);
 705 void ipa_update_after_lto_read (void);
 706 int ipa_get_param_decl_index (struct ipa_node_params *, tree);
 707 tree ipa_value_from_jfunc (struct ipa_node_params *info,
 708                            struct ipa_jump_func *jfunc);
 709 unsigned int ipcp_transform_function (struct cgraph_node *node);
 710 void ipa_dump_param (FILE *, struct ipa_node_params *info, int i);
 711 bool ipa_modify_expr (tree *, bool, ipa_parm_adjustment_vec);
 712 ipa_parm_adjustment *ipa_get_adjustment_candidate (tree **, bool *,
 713                                                    ipa_parm_adjustment_vec,
 714                                                    bool);
 715
 716
 717 /* From tree-sra.c:  */
 718 tree build_ref_for_offset (location_t, tree, HOST_WIDE_INT, tree,
 719                            gimple_stmt_iterator *, bool);
 720
 721 #endif /* IPA_PROP_H */