gcc/ipa-prop.h

   1 /* Interprocedural analyses.
   2    Copyright (C) 2005, 2007, 2008 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 "tree.h"
  24 #include "vec.h"
  25 #include "cgraph.h"
  26
  27 /* The following definitions and interfaces are used by
  28    interprocedural analyses.  */
  29
  30 /* A jump function for a callsite represents the values passed as actual
  31    arguments of the callsite. There are three main types of values :
  32    Formal - the caller's formal parameter is passed as an actual argument.
  33    Constant - a constant is passed as an actual argument.
  34    Unknown - neither of the above.
  35    Integer and real constants are represented as IPA_CONST.
  36    Finally, IPA_CONST_MEMBER_PTR stands for C++ member pointers constants.  */
  37 enum jump_func_type
  38 {
  39   IPA_UNKNOWN = 0,     /* newly allocated and zeroed jump functions default */
  40   IPA_CONST,
  41   IPA_CONST_MEMBER_PTR,
  42   IPA_PASS_THROUGH
  43 };
  44
  45 /* All formal parameters in the program have a lattice associated with it
  46    computed by the interprocedural stage of IPCP.
  47    There are three main values of the lattice:
  48    IPA_TOP - unknown,
  49    IPA_BOTTOM - non constant,
  50    IPA_CONST_VALUE - simple scalar constant,
  51    Cval of formal f will have a constant value if all callsites to this
  52    function have the same constant value passed to f.
  53    Integer and real constants are represented as IPA_CONST.  */
  54 enum ipa_lattice_type
  55 {
  56   IPA_BOTTOM,
  57   IPA_CONST_VALUE,
  58   IPA_TOP
  59 };
  60
  61 /* Structure holding a C++ member pointer constant.  Holds a pointer to the
  62    method and delta offset.  */
  63 struct ipa_member_ptr_cst
  64 {
  65   tree pfn;
  66   tree delta;
  67 };
  68
  69 /* Represents a value of a jump function.  formal_id is used only in jump
  70    function context and represents pass-through parameter (the formal parameter
  71    of the caller is passed as argument).  constant represents the actual
  72    constant in constant jump functions and member_cst holds constant c++ member
  73    functions.  */
  74 union jump_func_value
  75 {
  76   unsigned int formal_id;
  77   tree constant;
  78   struct ipa_member_ptr_cst member_cst;
  79 };
  80
  81 /* A jump function for a callsite represents the values passed as actual
  82    arguments of the callsite. See enum jump_func_type for the various
  83    types of jump functions supported.  */
  84 struct ipa_jump_func
  85 {
  86   enum jump_func_type type;
  87   union jump_func_value value;
  88 };
  89
  90 /* All formal parameters in the program have a cval computed by
  91    the interprocedural stage of IPCP. See enum ipa_lattice_type for
  92    the various types of lattices supported */
  93 struct ipcp_lattice
  94 {
  95   enum ipa_lattice_type type;
  96   tree constant;
  97 };
  98
  99 /* Represent which DECL tree (or reference to such tree)
 100    will be replaced by another tree while versioning.  */
 101 struct ipa_replace_map
 102 {
 103   /* The tree that will be replaced.  */
 104   tree old_tree;
 105   /* The new (replacing) tree.  */
 106   tree new_tree;
 107   /* True when a substitution should be done, false otherwise.  */
 108   bool replace_p;
 109   /* True when we replace a reference to old_tree.  */
 110   bool ref_p;
 111 };
 112
 113 /* ipa_param_flags contains various flags that describe how the associated
 114    parameter is treated within a function. */
 115 struct ipa_param_flags
 116 {
 117   /* Whether the value parameter has been modified within the function.  */
 118   unsigned modified : 1;
 119   /* Whether the parameter has been used as a call destination. */
 120   unsigned called : 1;
 121 };
 122
 123 /* Each instance of the following  structure describes a statement that calls a
 124    function parameter.  Those referring  to statements within the same function
 125    are linked in a list.  */
 126 struct ipa_param_call_note
 127 {
 128   /* Linked list's next */
 129   struct ipa_param_call_note *next;
 130   /* Statement that contains the call to the parameter above.  */
 131   gimple stmt;
 132   /* Index of the parameter that is called.  */
 133   unsigned int formal_id;
 134   /* Expected number of executions: calculated in profile.c.  */
 135   gcov_type count;
 136   /* Expected frequency of executions within the function. see cgraph_edge in
 137      cgraph.h for more on this. */
 138   int frequency;
 139   /* Depth of loop nest, 1 means no loop nest.  */
 140   int loop_nest;
 141   /* Set when we have already found the target to be a compile time constant
 142      and turned this into an edge or when the note was found unusable for some
 143      reason.  */
 144   bool processed;
 145 };
 146
 147 /* ipa_node_params stores information related to formal parameters of functions
 148    and some other information for interprocedural passes that operate on
 149    parameters (such as ipa-cp).  */
 150 struct ipa_node_params
 151 {
 152   /* Number of formal parameters of this function.  When set to 0,
 153      this function's parameters would not be analyzed by the different
 154      stages of IPA CP.  */
 155   int param_count;
 156   /* Array of lattices.  */
 157   struct ipcp_lattice *ipcp_lattices;
 158   /* Mapping each parameter to its PARM_DECL tree.  */
 159   tree *param_decls;
 160   /* Various flags describing individual parameters.  */
 161   struct ipa_param_flags *param_flags;
 162   /* List of structures enumerating calls to a formal parameter.  */
 163   struct ipa_param_call_note *param_calls;
 164   /* Only for versioned nodes this field would not be NULL,
 165      it points to the node that IPA cp cloned from.  */
 166   struct cgraph_node *ipcp_orig_node;
 167   /* Meaningful only for original functions.  Expresses the
 168      ratio between the direct calls and sum of all invocations of
 169      this function (given by profiling info).  It is used to calculate
 170      the profiling information of the original function and the versioned
 171      one.  */
 172   gcov_type count_scale;
 173
 174   /* Whether this function is called with variable number of actual
 175      arguments.  */
 176   unsigned called_with_var_arguments : 1;
 177   /* Whether the modification analysis has already been performed. */
 178   unsigned modification_analysis_done : 1;
 179   /* Whether the param uses analysis has already been performed.  */
 180   unsigned uses_analysis_done : 1;
 181 };
 182
 183 /* ipa_node_params access functions.  Please use these to access fields that
 184    are or will be shared among various passes.  */
 185
 186 /* Set the number of formal parameters. */
 187 static inline void
 188 ipa_set_param_count (struct ipa_node_params *info, int count)
 189 {
 190   info->param_count = count;
 191 }
 192
 193 /* Return the number of formal parameters. */
 194 static inline int
 195 ipa_get_param_count (struct ipa_node_params *info)
 196 {
 197   return info->param_count;
 198 }
 199
 200 /* Returns the declaration of ith param of the corresponding node.  Note there
 201    is no setter function as this array is built just once using
 202    ipa_create_param_decls_array. */
 203 static inline tree
 204 ipa_get_ith_param (struct ipa_node_params *info, int i)
 205 {
 206   return info->param_decls[i];
 207 }
 208
 209 /* Returns the modification flag corresponding to the ith parameter.  Note
 210    there is no setter method as the goal is to set all flags when building the
 211    array in ipa_detect_param_modifications.  */
 212 static inline bool
 213 ipa_is_ith_param_modified (struct ipa_node_params *info, int i)
 214 {
 215   return info->param_flags[i].modified;
 216 }
 217
 218 /* Returns the called flag corresponding o the ith paramterer.  Note there is
 219    no setter method as the goal is to set all flags when building the array in
 220    ipa_detect_called_params.  */
 221 static inline bool
 222 ipa_is_ith_param_called (struct ipa_node_params *info, int i)
 223 {
 224   return info->param_flags[i].called;
 225 }
 226
 227 /* Flag this node as having callers with variable number of arguments.  */
 228 static inline void
 229 ipa_set_called_with_variable_arg (struct ipa_node_params *info)
 230 {
 231   info->called_with_var_arguments = 1;
 232 }
 233
 234 /* Have we detected this node was called with variable number of arguments? */
 235 static inline bool
 236 ipa_is_called_with_var_arguments (struct ipa_node_params *info)
 237 {
 238   return info->called_with_var_arguments;
 239 }
 240
 241
 242
 243 /* ipa_edge_args stores information related to a callsite and particularly
 244    its arguments. It is pointed to by a field in the
 245    callsite's corresponding cgraph_edge.  */
 246 struct ipa_edge_args
 247 {
 248   /* Number of actual arguments in this callsite.  When set to 0,
 249      this callsite's parameters would not be analyzed by the different
 250      stages of IPA CP.  */
 251   int argument_count;
 252   /* Array of the callsite's jump function of each parameter.  */
 253   struct ipa_jump_func *jump_functions;
 254 };
 255
 256 /* ipa_edge_args access functions.  Please use these to access fields that
 257    are or will be shared among various passes.  */
 258
 259 /* Set the number of actual arguments. */
 260 static inline void
 261 ipa_set_cs_argument_count (struct ipa_edge_args *args, int count)
 262 {
 263   args->argument_count = count;
 264 }
 265
 266 /* Return the number of actual arguments. */
 267 static inline int
 268 ipa_get_cs_argument_count (struct ipa_edge_args *args)
 269 {
 270   return args->argument_count;
 271 }
 272
 273 /* Returns a pointer to the jump function for the ith argument.  Please note
 274    there is no setter function as jump functions are all set up in
 275    ipa_compute_jump_functions. */
 276 static inline struct ipa_jump_func *
 277 ipa_get_ith_jump_func (struct ipa_edge_args *args, int i)
 278 {
 279   return &args->jump_functions[i];
 280 }
 281
 282 /* Vectors need to have typedefs of structures.  */
 283 typedef struct ipa_node_params ipa_node_params_t;
 284 typedef struct ipa_edge_args ipa_edge_args_t;
 285
 286 /* Types of vectors hodling the infos.  */
 287 DEF_VEC_O (ipa_node_params_t);
 288 DEF_VEC_ALLOC_O (ipa_node_params_t, heap);
 289 DEF_VEC_O (ipa_edge_args_t);
 290 DEF_VEC_ALLOC_O (ipa_edge_args_t, heap);
 291
 292 /* Vector where the parameter infos are actually stored. */
 293 extern VEC (ipa_node_params_t, heap) *ipa_node_params_vector;
 294 /* Vector where the parameter infos are actually stored. */
 295 extern VEC (ipa_edge_args_t, heap) *ipa_edge_args_vector;
 296
 297 /* Return the associated parameter/argument info corresponding to the given
 298    node/edge.  */
 299 #define IPA_NODE_REF(NODE) (VEC_index (ipa_node_params_t, \
 300                                        ipa_node_params_vector, (NODE)->uid))
 301 #define IPA_EDGE_REF(EDGE) (VEC_index (ipa_edge_args_t, \
 302                                        ipa_edge_args_vector, (EDGE)->uid))
 303 /* This macro checks validity of index returned by
 304    ipa_get_param_decl_index function.  */
 305 #define IS_VALID_JUMP_FUNC_INDEX(I) ((I) != -1)
 306
 307 /* Creating and freeing ipa_node_params and ipa_edge_args.  */
 308 void ipa_create_all_node_params (void);
 309 void ipa_create_all_edge_args (void);
 310 void ipa_free_edge_args_substructures (struct ipa_edge_args *);
 311 void ipa_free_node_params_substructures (struct ipa_node_params *);
 312 void ipa_free_all_node_params (void);
 313 void ipa_free_all_edge_args (void);
 314 void free_all_ipa_structures_after_ipa_cp (void);
 315 void free_all_ipa_structures_after_iinln (void);
 316 void ipa_register_cgraph_hooks (void);
 317
 318 /* This function ensures the array of node param infos is big enough to
 319    accomdate a structure for all nodes and realloacates it if not.  */
 320 static inline void
 321 ipa_check_create_node_params (void)
 322 {
 323   if (!ipa_node_params_vector)
 324     ipa_node_params_vector = VEC_alloc (ipa_node_params_t, heap,
 325                                         cgraph_max_uid);
 326
 327   if (VEC_length (ipa_node_params_t, ipa_node_params_vector)
 328       <= (unsigned) cgraph_max_uid)
 329     VEC_safe_grow_cleared (ipa_node_params_t, heap,
 330                            ipa_node_params_vector, cgraph_max_uid + 1);
 331 }
 332
 333 /* This function ensures the array of adge arguments infos is big enough to
 334    accomdate a structure for all edges and realloacates it if not.  */
 335 static inline void
 336 ipa_check_create_edge_args (void)
 337 {
 338   if (!ipa_edge_args_vector)
 339     ipa_edge_args_vector = VEC_alloc (ipa_edge_args_t, heap,
 340                                       cgraph_edge_max_uid);
 341
 342   if (VEC_length (ipa_edge_args_t, ipa_edge_args_vector)
 343       <=  (unsigned) cgraph_edge_max_uid)
 344     VEC_safe_grow_cleared (ipa_edge_args_t, heap, ipa_edge_args_vector,
 345                            cgraph_edge_max_uid + 1);
 346 }
 347
 348 /* Returns true if the array of edge infos is large enough to accomodate an
 349    info for EDGE.  The main purpose of this function is that debug dumping
 350    function can check info availability without causing reallocations.  */
 351 static inline bool
 352 ipa_edge_args_info_available_for_edge_p (struct cgraph_edge *edge)
 353 {
 354   return ((unsigned) edge->uid < VEC_length (ipa_edge_args_t,
 355                                              ipa_edge_args_vector));
 356 }
 357
 358 /* A function list element.  It is used to create a temporary worklist used in
 359    the propagation stage of IPCP. (can be used for more IPA optimizations)  */
 360 struct ipa_func_list
 361 {
 362   struct cgraph_node *node;
 363   struct ipa_func_list *next;
 364 };
 365
 366 /* ipa_func_list interface.  */
 367 struct ipa_func_list *ipa_init_func_list (void);
 368 void ipa_push_func_to_list (struct ipa_func_list **, struct cgraph_node *);
 369 struct cgraph_node *ipa_pop_func_from_list (struct ipa_func_list **);
 370
 371 /* Callsite related calculations.  */
 372 void ipa_compute_jump_functions (struct cgraph_edge *);
 373 void ipa_count_arguments (struct cgraph_edge *);
 374
 375 /* Function parameters related computations.  */
 376 void ipa_count_formal_params (struct cgraph_node *);
 377 void ipa_create_param_decls_array (struct cgraph_node *);
 378 void ipa_detect_param_modifications (struct cgraph_node *);
 379 void ipa_analyze_params_uses (struct cgraph_node *);
 380 void ipa_propagate_indirect_call_infos (struct cgraph_edge *cs,
 381                                         VEC (cgraph_edge_p, heap) **new_edges);
 382
 383 /* Debugging interface.  */
 384 void ipa_print_node_params (FILE *, struct cgraph_node *node);
 385 void ipa_print_all_params (FILE *);
 386 void ipa_print_node_jump_functions (FILE *f, struct cgraph_node *node);
 387 void ipa_print_all_jump_functions (FILE * f);
 388
 389 #endif /* IPA_PROP_H */