annotate gcc/ipa-param-manipulation.h @ 131:84e7813d76e9

gcc-8.2
author mir3636
date Thu, 25 Oct 2018 07:37:49 +0900
parents
children 1830386684a0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
131
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
1 /* Manipulation of formal and actual parameters of functions and function
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
2 calls.
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
3 Copyright (C) 2017-2018 Free Software Foundation, Inc.
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
4
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
5 This file is part of GCC.
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
6
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
7 GCC is free software; you can redistribute it and/or modify it under
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
8 the terms of the GNU General Public License as published by the Free
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
9 Software Foundation; either version 3, or (at your option) any later
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
10 version.
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
11
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
15 for more details.
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
16
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
18 along with GCC; see the file COPYING3. If not see
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
19 <http://www.gnu.org/licenses/>. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
20
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
21 #ifndef IPA_PARAM_MANIPULATION_H
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
22 #define IPA_PARAM_MANIPULATION_H
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
23
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
24 /* Operation to be performed for the parameter in ipa_parm_adjustment
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
25 below. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
26 enum ipa_parm_op {
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
27 IPA_PARM_OP_NONE,
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
28
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
29 /* This describes a brand new parameter.
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
30
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
31 The field `type' should be set to the new type, `arg_prefix'
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
32 should be set to the string prefix for the new DECL_NAME, and
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
33 `new_decl' will ultimately hold the newly created argument. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
34 IPA_PARM_OP_NEW,
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
35
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
36 /* This new parameter is an unmodified parameter at index base_index. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
37 IPA_PARM_OP_COPY,
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
38
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
39 /* This adjustment describes a parameter that is about to be removed
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
40 completely. Most users will probably need to book keep those so that they
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
41 don't leave behinfd any non default def ssa names belonging to them. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
42 IPA_PARM_OP_REMOVE
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
43 };
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
44
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
45 /* Structure to describe transformations of formal parameters and actual
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
46 arguments. Each instance describes one new parameter and they are meant to
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
47 be stored in a vector. Additionally, most users will probably want to store
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
48 adjustments about parameters that are being removed altogether so that SSA
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
49 names belonging to them can be replaced by SSA names of an artificial
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
50 variable. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
51 struct ipa_parm_adjustment
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
52 {
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
53 /* The original PARM_DECL itself, helpful for processing of the body of the
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
54 function itself. Intended for traversing function bodies.
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
55 ipa_modify_formal_parameters, ipa_modify_call_arguments and
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
56 ipa_combine_adjustments ignore this and use base_index.
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
57 ipa_modify_formal_parameters actually sets this. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
58 tree base;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
59
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
60 /* Type of the new parameter. However, if by_ref is true, the real type will
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
61 be a pointer to this type. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
62 tree type;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
63
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
64 /* Alias refrerence type to be used in MEM_REFs when adjusting caller
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
65 arguments. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
66 tree alias_ptr_type;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
67
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
68 /* The new declaration when creating/replacing a parameter. Created
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
69 by ipa_modify_formal_parameters, useful for functions modifying
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
70 the body accordingly. For brand new arguments, this is the newly
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
71 created argument. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
72 tree new_decl;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
73
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
74 /* New declaration of a substitute variable that we may use to replace all
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
75 non-default-def ssa names when a parm decl is going away. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
76 tree new_ssa_base;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
77
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
78 /* If non-NULL and the original parameter is to be removed (copy_param below
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
79 is NULL), this is going to be its nonlocalized vars value. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
80 tree nonlocal_value;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
81
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
82 /* This holds the prefix to be used for the new DECL_NAME. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
83 const char *arg_prefix;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
84
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
85 /* Offset into the original parameter (for the cases when the new parameter
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
86 is a component of an original one). */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
87 poly_int64_pod offset;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
88
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
89 /* Zero based index of the original parameter this one is based on. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
90 int base_index;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
91
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
92 /* Whether this parameter is a new parameter, a copy of an old one,
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
93 or one about to be removed. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
94 enum ipa_parm_op op;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
95
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
96 /* Storage order of the original parameter (for the cases when the new
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
97 parameter is a component of an original one). */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
98 unsigned reverse : 1;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
99
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
100 /* The parameter is to be passed by reference. */
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
101 unsigned by_ref : 1;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
102 };
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
103
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
104 typedef vec<ipa_parm_adjustment> ipa_parm_adjustment_vec;
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
105
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
106 vec<tree> ipa_get_vector_of_formal_parms (tree fndecl);
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
107 vec<tree> ipa_get_vector_of_formal_parm_types (tree fntype);
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
108 void ipa_modify_formal_parameters (tree fndecl, ipa_parm_adjustment_vec);
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
109 void ipa_modify_call_arguments (struct cgraph_edge *, gcall *,
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
110 ipa_parm_adjustment_vec);
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
111 ipa_parm_adjustment_vec ipa_combine_adjustments (ipa_parm_adjustment_vec,
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
112 ipa_parm_adjustment_vec);
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
113 void ipa_dump_param_adjustments (FILE *, ipa_parm_adjustment_vec, tree);
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
114
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
115 bool ipa_modify_expr (tree *, bool, ipa_parm_adjustment_vec);
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
116 ipa_parm_adjustment *ipa_get_adjustment_candidate (tree **, bool *,
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
117 ipa_parm_adjustment_vec,
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
118 bool);
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
119
84e7813d76e9 gcc-8.2
mir3636
parents:
diff changeset
120 #endif /* IPA_PARAM_MANIPULATION_H */