annotate gcc/symbol-summary.h @ 131:84e7813d76e9

gcc-8.2
author mir3636
date Thu, 25 Oct 2018 07:37:49 +0900
parents 04ced10e8804
children 1830386684a0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 /* Callgraph summary data structure.
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
2 Copyright (C) 2014-2018 Free Software Foundation, Inc.
111
kono
parents:
diff changeset
3 Contributed by Martin Liska
kono
parents:
diff changeset
4
kono
parents:
diff changeset
5 This file is part of GCC.
kono
parents:
diff changeset
6
kono
parents:
diff changeset
7 GCC is free software; you can redistribute it and/or modify it under
kono
parents:
diff changeset
8 the terms of the GNU General Public License as published by the Free
kono
parents:
diff changeset
9 Software Foundation; either version 3, or (at your option) any later
kono
parents:
diff changeset
10 version.
kono
parents:
diff changeset
11
kono
parents:
diff changeset
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
kono
parents:
diff changeset
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
kono
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
kono
parents:
diff changeset
15 for more details.
kono
parents:
diff changeset
16
kono
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
kono
parents:
diff changeset
18 along with GCC; see the file COPYING3. If not see
kono
parents:
diff changeset
19 <http://www.gnu.org/licenses/>. */
kono
parents:
diff changeset
20
kono
parents:
diff changeset
21 #ifndef GCC_SYMBOL_SUMMARY_H
kono
parents:
diff changeset
22 #define GCC_SYMBOL_SUMMARY_H
kono
parents:
diff changeset
23
kono
parents:
diff changeset
24 /* We want to pass just pointer types as argument for function_summary
kono
parents:
diff changeset
25 template class. */
kono
parents:
diff changeset
26
kono
parents:
diff changeset
27 template <class T>
kono
parents:
diff changeset
28 class function_summary
kono
parents:
diff changeset
29 {
kono
parents:
diff changeset
30 private:
kono
parents:
diff changeset
31 function_summary();
kono
parents:
diff changeset
32 };
kono
parents:
diff changeset
33
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
34 /* Function summary is a helper class that is used to associate a data structure
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
35 related to a callgraph node. Typical usage can be seen in IPA passes which
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
36 create a temporary pass-related structures. The summary class registers
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
37 hooks that are triggered when a new node is inserted, duplicated and deleted.
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
38 A user of a summary class can ovewrite virtual methods than are triggered by
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
39 the summary if such hook is triggered. Apart from a callgraph node, the user
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
40 is given a data structure tied to the node.
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
41
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
42 The function summary class can work both with a heap-allocated memory and
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
43 a memory gained by garbage collected memory. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
44
111
kono
parents:
diff changeset
45 template <class T>
kono
parents:
diff changeset
46 class GTY((user)) function_summary <T *>
kono
parents:
diff changeset
47 {
kono
parents:
diff changeset
48 public:
kono
parents:
diff changeset
49 /* Default construction takes SYMTAB as an argument. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
50 function_summary (symbol_table *symtab, bool ggc = false);
111
kono
parents:
diff changeset
51
kono
parents:
diff changeset
52 /* Destructor. */
kono
parents:
diff changeset
53 virtual ~function_summary ()
kono
parents:
diff changeset
54 {
kono
parents:
diff changeset
55 release ();
kono
parents:
diff changeset
56 }
kono
parents:
diff changeset
57
kono
parents:
diff changeset
58 /* Destruction method that can be called for GGT purpose. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
59 void release ();
111
kono
parents:
diff changeset
60
kono
parents:
diff changeset
61 /* Traverses all summarys with a function F called with
kono
parents:
diff changeset
62 ARG as argument. */
kono
parents:
diff changeset
63 template<typename Arg, bool (*f)(const T &, Arg)>
kono
parents:
diff changeset
64 void traverse (Arg a) const
kono
parents:
diff changeset
65 {
kono
parents:
diff changeset
66 m_map.traverse <f> (a);
kono
parents:
diff changeset
67 }
kono
parents:
diff changeset
68
kono
parents:
diff changeset
69 /* Basic implementation of insert operation. */
kono
parents:
diff changeset
70 virtual void insert (cgraph_node *, T *) {}
kono
parents:
diff changeset
71
kono
parents:
diff changeset
72 /* Basic implementation of removal operation. */
kono
parents:
diff changeset
73 virtual void remove (cgraph_node *, T *) {}
kono
parents:
diff changeset
74
kono
parents:
diff changeset
75 /* Basic implementation of duplication operation. */
kono
parents:
diff changeset
76 virtual void duplicate (cgraph_node *, cgraph_node *, T *, T *) {}
kono
parents:
diff changeset
77
kono
parents:
diff changeset
78 /* Allocates new data that are stored within map. */
kono
parents:
diff changeset
79 T* allocate_new ()
kono
parents:
diff changeset
80 {
kono
parents:
diff changeset
81 /* Call gcc_internal_because we do not want to call finalizer for
kono
parents:
diff changeset
82 a type T. We call dtor explicitly. */
kono
parents:
diff changeset
83 return m_ggc ? new (ggc_internal_alloc (sizeof (T))) T () : new T () ;
kono
parents:
diff changeset
84 }
kono
parents:
diff changeset
85
kono
parents:
diff changeset
86 /* Release an item that is stored within map. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
87 void release (T *item);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
88
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
89 /* Getter for summary callgraph node pointer. If a summary for a node
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
90 does not exist it will be created. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
91 T* get_create (cgraph_node *node)
111
kono
parents:
diff changeset
92 {
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
93 bool existed;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
94 T **v = &m_map.get_or_insert (node->get_uid (), &existed);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
95 if (!existed)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
96 *v = allocate_new ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
97
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
98 return *v;
111
kono
parents:
diff changeset
99 }
kono
parents:
diff changeset
100
kono
parents:
diff changeset
101 /* Getter for summary callgraph node pointer. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
102 T* get (cgraph_node *node) ATTRIBUTE_PURE
111
kono
parents:
diff changeset
103 {
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
104 T **v = m_map.get (node->get_uid ());
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
105 return v == NULL ? NULL : *v;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
106 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
107
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
108 /* Remove node from summary. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
109 void remove (cgraph_node *node)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
110 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
111 int uid = node->get_uid ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
112 T **v = m_map.get (uid);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
113 if (v)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
114 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
115 m_map.remove (uid);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
116 release (*v);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
117 }
111
kono
parents:
diff changeset
118 }
kono
parents:
diff changeset
119
kono
parents:
diff changeset
120 /* Return number of elements handled by data structure. */
kono
parents:
diff changeset
121 size_t elements ()
kono
parents:
diff changeset
122 {
kono
parents:
diff changeset
123 return m_map.elements ();
kono
parents:
diff changeset
124 }
kono
parents:
diff changeset
125
kono
parents:
diff changeset
126 /* Return true if a summary for the given NODE already exists. */
kono
parents:
diff changeset
127 bool exists (cgraph_node *node)
kono
parents:
diff changeset
128 {
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
129 return m_map.get (node->get_uid ()) != NULL;
111
kono
parents:
diff changeset
130 }
kono
parents:
diff changeset
131
kono
parents:
diff changeset
132 /* Enable insertion hook invocation. */
kono
parents:
diff changeset
133 void enable_insertion_hook ()
kono
parents:
diff changeset
134 {
kono
parents:
diff changeset
135 m_insertion_enabled = true;
kono
parents:
diff changeset
136 }
kono
parents:
diff changeset
137
kono
parents:
diff changeset
138 /* Enable insertion hook invocation. */
kono
parents:
diff changeset
139 void disable_insertion_hook ()
kono
parents:
diff changeset
140 {
kono
parents:
diff changeset
141 m_insertion_enabled = false;
kono
parents:
diff changeset
142 }
kono
parents:
diff changeset
143
kono
parents:
diff changeset
144 /* Symbol insertion hook that is registered to symbol table. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
145 static void symtab_insertion (cgraph_node *node, void *data);
111
kono
parents:
diff changeset
146
kono
parents:
diff changeset
147 /* Symbol removal hook that is registered to symbol table. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
148 static void symtab_removal (cgraph_node *node, void *data);
111
kono
parents:
diff changeset
149
kono
parents:
diff changeset
150 /* Symbol duplication hook that is registered to symbol table. */
kono
parents:
diff changeset
151 static void symtab_duplication (cgraph_node *node, cgraph_node *node2,
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
152 void *data);
111
kono
parents:
diff changeset
153
kono
parents:
diff changeset
154 protected:
kono
parents:
diff changeset
155 /* Indication if we use ggc summary. */
kono
parents:
diff changeset
156 bool m_ggc;
kono
parents:
diff changeset
157
kono
parents:
diff changeset
158 private:
kono
parents:
diff changeset
159 typedef int_hash <int, 0, -1> map_hash;
kono
parents:
diff changeset
160
kono
parents:
diff changeset
161 /* Indicates if insertion hook is enabled. */
kono
parents:
diff changeset
162 bool m_insertion_enabled;
kono
parents:
diff changeset
163 /* Indicates if the summary is released. */
kono
parents:
diff changeset
164 bool m_released;
kono
parents:
diff changeset
165 /* Main summary store, where summary ID is used as key. */
kono
parents:
diff changeset
166 hash_map <map_hash, T *> m_map;
kono
parents:
diff changeset
167 /* Internal summary insertion hook pointer. */
kono
parents:
diff changeset
168 cgraph_node_hook_list *m_symtab_insertion_hook;
kono
parents:
diff changeset
169 /* Internal summary removal hook pointer. */
kono
parents:
diff changeset
170 cgraph_node_hook_list *m_symtab_removal_hook;
kono
parents:
diff changeset
171 /* Internal summary duplication hook pointer. */
kono
parents:
diff changeset
172 cgraph_2node_hook_list *m_symtab_duplication_hook;
kono
parents:
diff changeset
173 /* Symbol table the summary is registered to. */
kono
parents:
diff changeset
174 symbol_table *m_symtab;
kono
parents:
diff changeset
175
kono
parents:
diff changeset
176 template <typename U> friend void gt_ggc_mx (function_summary <U *> * const &);
kono
parents:
diff changeset
177 template <typename U> friend void gt_pch_nx (function_summary <U *> * const &);
kono
parents:
diff changeset
178 template <typename U> friend void gt_pch_nx (function_summary <U *> * const &,
kono
parents:
diff changeset
179 gt_pointer_operator, void *);
kono
parents:
diff changeset
180 };
kono
parents:
diff changeset
181
kono
parents:
diff changeset
182 template <typename T>
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
183 function_summary<T *>::function_summary (symbol_table *symtab, bool ggc):
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
184 m_ggc (ggc), m_insertion_enabled (true), m_released (false), m_map (13, ggc),
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
185 m_symtab (symtab)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
186 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
187 m_symtab_insertion_hook
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
188 = symtab->add_cgraph_insertion_hook (function_summary::symtab_insertion,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
189 this);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
190
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
191 m_symtab_removal_hook
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
192 = symtab->add_cgraph_removal_hook (function_summary::symtab_removal, this);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
193 m_symtab_duplication_hook
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
194 = symtab->add_cgraph_duplication_hook (function_summary::symtab_duplication,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
195 this);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
196 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
197
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
198 template <typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
199 void
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
200 function_summary<T *>::release ()
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
201 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
202 if (m_released)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
203 return;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
204
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
205 m_symtab->remove_cgraph_insertion_hook (m_symtab_insertion_hook);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
206 m_symtab->remove_cgraph_removal_hook (m_symtab_removal_hook);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
207 m_symtab->remove_cgraph_duplication_hook (m_symtab_duplication_hook);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
208
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
209 /* Release all summaries. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
210 typedef typename hash_map <map_hash, T *>::iterator map_iterator;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
211 for (map_iterator it = m_map.begin (); it != m_map.end (); ++it)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
212 release ((*it).second);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
213
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
214 m_released = true;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
215 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
216
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
217 template <typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
218 void
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
219 function_summary<T *>::release (T *item)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
220 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
221 if (m_ggc)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
222 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
223 item->~T ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
224 ggc_free (item);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
225 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
226 else
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
227 delete item;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
228 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
229
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
230 template <typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
231 void
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
232 function_summary<T *>::symtab_insertion (cgraph_node *node, void *data)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
233 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
234 gcc_checking_assert (node->get_uid ());
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
235 function_summary *summary = (function_summary <T *> *) (data);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
236
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
237 if (summary->m_insertion_enabled)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
238 summary->insert (node, summary->get_create (node));
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
239 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
240
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
241 template <typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
242 void
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
243 function_summary<T *>::symtab_removal (cgraph_node *node, void *data)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
244 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
245 gcc_checking_assert (node->get_uid ());
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
246 function_summary *summary = (function_summary <T *> *) (data);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
247
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
248 int uid = node->get_uid ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
249 T **v = summary->m_map.get (uid);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
250
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
251 if (v)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
252 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
253 summary->remove (node, *v);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
254
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
255 if (!summary->m_ggc)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
256 delete (*v);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
257
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
258 summary->m_map.remove (uid);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
259 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
260 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
261
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
262 template <typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
263 void
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
264 function_summary<T *>::symtab_duplication (cgraph_node *node,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
265 cgraph_node *node2, void *data)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
266 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
267 function_summary *summary = (function_summary <T *> *) (data);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
268 T *v = summary->get (node);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
269
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
270 if (v)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
271 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
272 /* This load is necessary, because we insert a new value! */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
273 T *duplicate = summary->allocate_new ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
274 summary->m_map.put (node2->get_uid (), duplicate);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
275 summary->duplicate (node, node2, v, duplicate);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
276 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
277 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
278
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
279 template <typename T>
111
kono
parents:
diff changeset
280 void
kono
parents:
diff changeset
281 gt_ggc_mx(function_summary<T *>* const &summary)
kono
parents:
diff changeset
282 {
kono
parents:
diff changeset
283 gcc_checking_assert (summary->m_ggc);
kono
parents:
diff changeset
284 gt_ggc_mx (&summary->m_map);
kono
parents:
diff changeset
285 }
kono
parents:
diff changeset
286
kono
parents:
diff changeset
287 template <typename T>
kono
parents:
diff changeset
288 void
kono
parents:
diff changeset
289 gt_pch_nx(function_summary<T *>* const &summary)
kono
parents:
diff changeset
290 {
kono
parents:
diff changeset
291 gcc_checking_assert (summary->m_ggc);
kono
parents:
diff changeset
292 gt_pch_nx (&summary->m_map);
kono
parents:
diff changeset
293 }
kono
parents:
diff changeset
294
kono
parents:
diff changeset
295 template <typename T>
kono
parents:
diff changeset
296 void
kono
parents:
diff changeset
297 gt_pch_nx(function_summary<T *>* const& summary, gt_pointer_operator op,
kono
parents:
diff changeset
298 void *cookie)
kono
parents:
diff changeset
299 {
kono
parents:
diff changeset
300 gcc_checking_assert (summary->m_ggc);
kono
parents:
diff changeset
301 gt_pch_nx (&summary->m_map, op, cookie);
kono
parents:
diff changeset
302 }
kono
parents:
diff changeset
303
kono
parents:
diff changeset
304 /* An impossible class templated by non-pointers so, which makes sure that only
kono
parents:
diff changeset
305 summaries gathering pointers can be created. */
kono
parents:
diff changeset
306
kono
parents:
diff changeset
307 template <class T>
kono
parents:
diff changeset
308 class call_summary
kono
parents:
diff changeset
309 {
kono
parents:
diff changeset
310 private:
kono
parents:
diff changeset
311 call_summary();
kono
parents:
diff changeset
312 };
kono
parents:
diff changeset
313
kono
parents:
diff changeset
314 /* Class to store auxiliary information about call graph edges. */
kono
parents:
diff changeset
315
kono
parents:
diff changeset
316 template <class T>
kono
parents:
diff changeset
317 class GTY((user)) call_summary <T *>
kono
parents:
diff changeset
318 {
kono
parents:
diff changeset
319 public:
kono
parents:
diff changeset
320 /* Default construction takes SYMTAB as an argument. */
kono
parents:
diff changeset
321 call_summary (symbol_table *symtab, bool ggc = false): m_ggc (ggc),
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
322 m_initialize_when_cloning (false), m_map (13, ggc), m_released (false),
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
323 m_symtab (symtab)
111
kono
parents:
diff changeset
324 {
kono
parents:
diff changeset
325 m_symtab_removal_hook =
kono
parents:
diff changeset
326 symtab->add_edge_removal_hook
kono
parents:
diff changeset
327 (call_summary::symtab_removal, this);
kono
parents:
diff changeset
328 m_symtab_duplication_hook =
kono
parents:
diff changeset
329 symtab->add_edge_duplication_hook
kono
parents:
diff changeset
330 (call_summary::symtab_duplication, this);
kono
parents:
diff changeset
331 }
kono
parents:
diff changeset
332
kono
parents:
diff changeset
333 /* Destructor. */
kono
parents:
diff changeset
334 virtual ~call_summary ()
kono
parents:
diff changeset
335 {
kono
parents:
diff changeset
336 release ();
kono
parents:
diff changeset
337 }
kono
parents:
diff changeset
338
kono
parents:
diff changeset
339 /* Destruction method that can be called for GGT purpose. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
340 void release ();
111
kono
parents:
diff changeset
341
kono
parents:
diff changeset
342 /* Traverses all summarys with a function F called with
kono
parents:
diff changeset
343 ARG as argument. */
kono
parents:
diff changeset
344 template<typename Arg, bool (*f)(const T &, Arg)>
kono
parents:
diff changeset
345 void traverse (Arg a) const
kono
parents:
diff changeset
346 {
kono
parents:
diff changeset
347 m_map.traverse <f> (a);
kono
parents:
diff changeset
348 }
kono
parents:
diff changeset
349
kono
parents:
diff changeset
350 /* Basic implementation of removal operation. */
kono
parents:
diff changeset
351 virtual void remove (cgraph_edge *, T *) {}
kono
parents:
diff changeset
352
kono
parents:
diff changeset
353 /* Basic implementation of duplication operation. */
kono
parents:
diff changeset
354 virtual void duplicate (cgraph_edge *, cgraph_edge *, T *, T *) {}
kono
parents:
diff changeset
355
kono
parents:
diff changeset
356 /* Allocates new data that are stored within map. */
kono
parents:
diff changeset
357 T* allocate_new ()
kono
parents:
diff changeset
358 {
kono
parents:
diff changeset
359 /* Call gcc_internal_because we do not want to call finalizer for
kono
parents:
diff changeset
360 a type T. We call dtor explicitly. */
kono
parents:
diff changeset
361 return m_ggc ? new (ggc_internal_alloc (sizeof (T))) T () : new T () ;
kono
parents:
diff changeset
362 }
kono
parents:
diff changeset
363
kono
parents:
diff changeset
364 /* Release an item that is stored within map. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
365 void release (T *item);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
366
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
367 /* Getter for summary callgraph edge pointer.
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
368 If a summary for an edge does not exist, it will be created. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
369 T* get_create (cgraph_edge *edge)
111
kono
parents:
diff changeset
370 {
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
371 bool existed;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
372 T **v = &m_map.get_or_insert (edge->get_uid (), &existed);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
373 if (!existed)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
374 *v = allocate_new ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
375
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
376 return *v;
111
kono
parents:
diff changeset
377 }
kono
parents:
diff changeset
378
kono
parents:
diff changeset
379 /* Getter for summary callgraph edge pointer. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
380 T* get (cgraph_edge *edge) ATTRIBUTE_PURE
111
kono
parents:
diff changeset
381 {
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
382 T **v = m_map.get (edge->get_uid ());
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
383 return v == NULL ? NULL : *v;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
384 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
385
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
386 /* Remove edge from summary. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
387 void remove (cgraph_edge *edge)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
388 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
389 int uid = edge->get_uid ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
390 T **v = m_map.get (uid);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
391 if (v)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
392 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
393 m_map.remove (uid);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
394 release (*v);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
395 }
111
kono
parents:
diff changeset
396 }
kono
parents:
diff changeset
397
kono
parents:
diff changeset
398 /* Return number of elements handled by data structure. */
kono
parents:
diff changeset
399 size_t elements ()
kono
parents:
diff changeset
400 {
kono
parents:
diff changeset
401 return m_map.elements ();
kono
parents:
diff changeset
402 }
kono
parents:
diff changeset
403
kono
parents:
diff changeset
404 /* Return true if a summary for the given EDGE already exists. */
kono
parents:
diff changeset
405 bool exists (cgraph_edge *edge)
kono
parents:
diff changeset
406 {
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
407 return m_map.get (edge->get_uid ()) != NULL;
111
kono
parents:
diff changeset
408 }
kono
parents:
diff changeset
409
kono
parents:
diff changeset
410 /* Symbol removal hook that is registered to symbol table. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
411 static void symtab_removal (cgraph_edge *edge, void *data);
111
kono
parents:
diff changeset
412
kono
parents:
diff changeset
413 /* Symbol duplication hook that is registered to symbol table. */
kono
parents:
diff changeset
414 static void symtab_duplication (cgraph_edge *edge1, cgraph_edge *edge2,
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
415 void *data);
111
kono
parents:
diff changeset
416
kono
parents:
diff changeset
417 protected:
kono
parents:
diff changeset
418 /* Indication if we use ggc summary. */
kono
parents:
diff changeset
419 bool m_ggc;
kono
parents:
diff changeset
420
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
421 /* Initialize summary for an edge that is cloned. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
422 bool m_initialize_when_cloning;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
423
111
kono
parents:
diff changeset
424 private:
kono
parents:
diff changeset
425 typedef int_hash <int, 0, -1> map_hash;
kono
parents:
diff changeset
426
kono
parents:
diff changeset
427 /* Main summary store, where summary ID is used as key. */
kono
parents:
diff changeset
428 hash_map <map_hash, T *> m_map;
kono
parents:
diff changeset
429 /* Internal summary removal hook pointer. */
kono
parents:
diff changeset
430 cgraph_edge_hook_list *m_symtab_removal_hook;
kono
parents:
diff changeset
431 /* Internal summary duplication hook pointer. */
kono
parents:
diff changeset
432 cgraph_2edge_hook_list *m_symtab_duplication_hook;
kono
parents:
diff changeset
433 /* Indicates if the summary is released. */
kono
parents:
diff changeset
434 bool m_released;
kono
parents:
diff changeset
435 /* Symbol table the summary is registered to. */
kono
parents:
diff changeset
436 symbol_table *m_symtab;
kono
parents:
diff changeset
437
kono
parents:
diff changeset
438 template <typename U> friend void gt_ggc_mx (call_summary <U *> * const &);
kono
parents:
diff changeset
439 template <typename U> friend void gt_pch_nx (call_summary <U *> * const &);
kono
parents:
diff changeset
440 template <typename U> friend void gt_pch_nx (call_summary <U *> * const &,
kono
parents:
diff changeset
441 gt_pointer_operator, void *);
kono
parents:
diff changeset
442 };
kono
parents:
diff changeset
443
kono
parents:
diff changeset
444 template <typename T>
kono
parents:
diff changeset
445 void
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
446 call_summary<T *>::release ()
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
447 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
448 if (m_released)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
449 return;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
450
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
451 m_symtab->remove_edge_removal_hook (m_symtab_removal_hook);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
452 m_symtab->remove_edge_duplication_hook (m_symtab_duplication_hook);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
453
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
454 /* Release all summaries. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
455 typedef typename hash_map <map_hash, T *>::iterator map_iterator;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
456 for (map_iterator it = m_map.begin (); it != m_map.end (); ++it)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
457 release ((*it).second);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
458
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
459 m_released = true;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
460 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
461
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
462 template <typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
463 void
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
464 call_summary<T *>::release (T *item)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
465 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
466 if (m_ggc)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
467 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
468 item->~T ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
469 ggc_free (item);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
470 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
471 else
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
472 delete item;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
473 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
474
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
475 template <typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
476 void
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
477 call_summary<T *>::symtab_removal (cgraph_edge *edge, void *data)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
478 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
479 call_summary *summary = (call_summary <T *> *) (data);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
480
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
481 int h_uid = edge->get_uid ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
482 T **v = summary->m_map.get (h_uid);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
483
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
484 if (v)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
485 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
486 summary->remove (edge, *v);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
487 summary->release (*v);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
488 summary->m_map.remove (h_uid);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
489 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
490 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
491
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
492 template <typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
493 void
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
494 call_summary<T *>::symtab_duplication (cgraph_edge *edge1,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
495 cgraph_edge *edge2, void *data)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
496 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
497 call_summary *summary = (call_summary <T *> *) (data);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
498 T *edge1_summary = NULL;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
499
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
500 if (summary->m_initialize_when_cloning)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
501 edge1_summary = summary->get_create (edge1);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
502 else
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
503 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
504 T **v = summary->m_map.get (edge1->get_uid ());
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
505 if (v)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
506 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
507 /* This load is necessary, because we insert a new value! */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
508 edge1_summary = *v;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
509 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
510 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
511
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
512 if (edge1_summary)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
513 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
514 T *duplicate = summary->allocate_new ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
515 summary->m_map.put (edge2->get_uid (), duplicate);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
516 summary->duplicate (edge1, edge2, edge1_summary, duplicate);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
517 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
518 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
519
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
520 template <typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
521 void
111
kono
parents:
diff changeset
522 gt_ggc_mx(call_summary<T *>* const &summary)
kono
parents:
diff changeset
523 {
kono
parents:
diff changeset
524 gcc_checking_assert (summary->m_ggc);
kono
parents:
diff changeset
525 gt_ggc_mx (&summary->m_map);
kono
parents:
diff changeset
526 }
kono
parents:
diff changeset
527
kono
parents:
diff changeset
528 template <typename T>
kono
parents:
diff changeset
529 void
kono
parents:
diff changeset
530 gt_pch_nx(call_summary<T *>* const &summary)
kono
parents:
diff changeset
531 {
kono
parents:
diff changeset
532 gcc_checking_assert (summary->m_ggc);
kono
parents:
diff changeset
533 gt_pch_nx (&summary->m_map);
kono
parents:
diff changeset
534 }
kono
parents:
diff changeset
535
kono
parents:
diff changeset
536 template <typename T>
kono
parents:
diff changeset
537 void
kono
parents:
diff changeset
538 gt_pch_nx(call_summary<T *>* const& summary, gt_pointer_operator op,
kono
parents:
diff changeset
539 void *cookie)
kono
parents:
diff changeset
540 {
kono
parents:
diff changeset
541 gcc_checking_assert (summary->m_ggc);
kono
parents:
diff changeset
542 gt_pch_nx (&summary->m_map, op, cookie);
kono
parents:
diff changeset
543 }
kono
parents:
diff changeset
544
kono
parents:
diff changeset
545 #endif /* GCC_SYMBOL_SUMMARY_H */