]>
Commit | Line | Data |
---|---|---|
0a25f1f5 | 1 | /* Garbage collection for the GNU compiler. |
ae2392a9 | 2 | |
a5544970 | 3 | Copyright (C) 1998-2019 Free Software Foundation, Inc. |
0a25f1f5 | 4 | |
1322177d | 5 | This file is part of GCC. |
770ae6cc | 6 | |
1322177d LB |
7 | GCC is free software; you can redistribute it and/or modify it under |
8 | the terms of the GNU General Public License as published by the Free | |
9dcd6f09 | 9 | Software Foundation; either version 3, or (at your option) any later |
1322177d | 10 | version. |
770ae6cc | 11 | |
1322177d LB |
12 | GCC is distributed in the hope that it will be useful, but WITHOUT ANY |
13 | WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
770ae6cc RK |
14 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
15 | for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
9dcd6f09 NC |
18 | along with GCC; see the file COPYING3. If not see |
19 | <http://www.gnu.org/licenses/>. */ | |
0a25f1f5 | 20 | |
d07605f5 AP |
21 | #ifndef GCC_GGC_H |
22 | #define GCC_GGC_H | |
23 | ||
0a25f1f5 RH |
24 | /* Symbols are marked with `ggc' for `gcc gc' so as not to interfere with |
25 | an external gc library that might be linked in. */ | |
26 | ||
17211ab5 | 27 | /* Internal functions and data structures used by the GTY |
a9429e29 | 28 | machinery, including the generated gt*.[hc] files. */ |
17211ab5 | 29 | |
17211ab5 GK |
30 | #include "gtype-desc.h" |
31 | ||
32 | /* One of these applies its third parameter (with cookie in the fourth | |
33 | parameter) to each pointer in the object pointed to by the first | |
34 | parameter, using the second parameter. */ | |
20c1dc5e AJ |
35 | typedef void (*gt_note_pointers) (void *, void *, gt_pointer_operator, |
36 | void *); | |
17211ab5 GK |
37 | |
38 | /* One of these is called before objects are re-ordered in memory. | |
39 | The first parameter is the original object, the second is the | |
40 | subobject that has had its pointers reordered, the third parameter | |
41 | can compute the new values of a pointer when given the cookie in | |
42 | the fourth parameter. */ | |
20c1dc5e AJ |
43 | typedef void (*gt_handle_reorder) (void *, void *, gt_pointer_operator, |
44 | void *); | |
17211ab5 GK |
45 | |
46 | /* Used by the gt_pch_n_* routines. Register an object in the hash table. */ | |
cd030c07 | 47 | extern int gt_pch_note_object (void *, void *, gt_note_pointers); |
17211ab5 | 48 | |
20c1dc5e | 49 | /* Used by the gt_pch_n_* routines. Register that an object has a reorder |
17211ab5 | 50 | function. */ |
20c1dc5e | 51 | extern void gt_pch_note_reorder (void *, void *, gt_handle_reorder); |
17211ab5 | 52 | |
aebf76a2 TS |
53 | /* generated function to clear caches in gc memory. */ |
54 | extern void gt_clear_caches (); | |
55 | ||
17211ab5 | 56 | /* Mark the object in the first parameter and anything it points to. */ |
20c1dc5e | 57 | typedef void (*gt_pointer_walker) (void *); |
e2500fed | 58 | |
589005ff | 59 | /* Structures for the easy way to mark roots. |
0ee55ad8 | 60 | In an array, terminated by having base == NULL. */ |
e2500fed GK |
61 | struct ggc_root_tab { |
62 | void *base; | |
63 | size_t nelt; | |
64 | size_t stride; | |
17211ab5 GK |
65 | gt_pointer_walker cb; |
66 | gt_pointer_walker pchw; | |
e2500fed | 67 | }; |
17211ab5 | 68 | #define LAST_GGC_ROOT_TAB { NULL, 0, 0, NULL, NULL } |
e2500fed GK |
69 | /* Pointers to arrays of ggc_root_tab, terminated by NULL. */ |
70 | extern const struct ggc_root_tab * const gt_ggc_rtab[]; | |
71 | extern const struct ggc_root_tab * const gt_ggc_deletable_rtab[]; | |
17211ab5 | 72 | extern const struct ggc_root_tab * const gt_pch_scalar_rtab[]; |
e2500fed | 73 | |
52a92176 AS |
74 | /* If EXPR is not NULL and previously unmarked, mark it and evaluate |
75 | to true. Otherwise evaluate to false. */ | |
76 | #define ggc_test_and_set_mark(EXPR) \ | |
e2500fed | 77 | ((EXPR) != NULL && ((void *) (EXPR)) != (void *) 1 && ! ggc_set_mark (EXPR)) |
52a92176 | 78 | |
005537df RH |
79 | #define ggc_mark(EXPR) \ |
80 | do { \ | |
d8750784 | 81 | const void *const a__ = (EXPR); \ |
e2500fed | 82 | if (a__ != NULL && a__ != (void *) 1) \ |
005537df RH |
83 | ggc_set_mark (a__); \ |
84 | } while (0) | |
85 | ||
17211ab5 GK |
86 | /* Actually set the mark on a particular region of memory, but don't |
87 | follow pointers. This function is called by ggc_mark_*. It | |
6356f892 | 88 | returns zero if the object was not previously marked; nonzero if |
17211ab5 GK |
89 | the object was already marked, or if, for any other reason, |
90 | pointers in this data structure should not be traversed. */ | |
20c1dc5e | 91 | extern int ggc_set_mark (const void *); |
17211ab5 GK |
92 | |
93 | /* Return 1 if P has been marked, zero otherwise. | |
94 | P must have been allocated by the GC allocator; it mustn't point to | |
95 | static objects, stack variables, or memory allocated with malloc. */ | |
20c1dc5e | 96 | extern int ggc_marked_p (const void *); |
17211ab5 | 97 | |
17211ab5 | 98 | /* PCH and GGC handling for strings, mostly trivial. */ |
20c1dc5e | 99 | extern void gt_pch_n_S (const void *); |
dae4174e | 100 | extern void gt_ggc_m_S (const void *); |
17211ab5 | 101 | |
a9429e29 | 102 | /* End of GTY machinery API. */ |
17211ab5 | 103 | |
a9429e29 LB |
104 | /* Initialize the string pool. */ |
105 | extern void init_stringpool (void); | |
106 | ||
eebedaa5 | 107 | /* Initialize the garbage collector. */ |
20c1dc5e | 108 | extern void init_ggc (void); |
0a25f1f5 | 109 | |
dae4174e TT |
110 | /* When true, identifier nodes are considered as GC roots. When |
111 | false, identifier nodes are treated like any other GC-allocated | |
112 | object, and the identifier hash table is treated as a weak | |
113 | hash. */ | |
114 | extern bool ggc_protect_identifiers; | |
115 | ||
a9429e29 LB |
116 | /* Write out all GCed objects to F. */ |
117 | extern void gt_pch_save (FILE *f); | |
118 | ||
119 | \f | |
120 | /* Allocation. */ | |
121 | ||
005537df | 122 | /* The internal primitive. */ |
de49ce19 TS |
123 | extern void *ggc_internal_alloc (size_t, void (*)(void *), size_t, |
124 | size_t CXX_MEM_STAT_INFO) | |
125 | ATTRIBUTE_MALLOC; | |
126 | ||
e886224b NS |
127 | inline void * |
128 | ggc_internal_alloc (size_t s CXX_MEM_STAT_INFO) | |
de49ce19 TS |
129 | { |
130 | return ggc_internal_alloc (s, NULL, 0, 1 PASS_MEM_STAT); | |
131 | } | |
a9429e29 | 132 | |
b9bd6f74 TT |
133 | extern size_t ggc_round_alloc_size (size_t requested_size); |
134 | ||
a9429e29 | 135 | /* Allocates cleared memory. */ |
de49ce19 TS |
136 | extern void *ggc_internal_cleared_alloc (size_t, void (*)(void *), |
137 | size_t, size_t | |
138 | CXX_MEM_STAT_INFO) ATTRIBUTE_MALLOC; | |
139 | ||
e886224b | 140 | inline void * |
de49ce19 TS |
141 | ggc_internal_cleared_alloc (size_t s CXX_MEM_STAT_INFO) |
142 | { | |
143 | return ggc_internal_cleared_alloc (s, NULL, 0, 1 PASS_MEM_STAT); | |
144 | } | |
a9429e29 | 145 | |
e2500fed | 146 | /* Resize a block. */ |
231120e5 | 147 | extern void *ggc_realloc (void *, size_t CXX_MEM_STAT_INFO); |
a9429e29 | 148 | |
685fe032 RH |
149 | /* Free a block. To be used when known for certain it's not reachable. */ |
150 | extern void ggc_free (void *); | |
b8698a0f | 151 | |
c5281d50 | 152 | extern void dump_ggc_loc_statistics (); |
005537df | 153 | |
231120e5 | 154 | /* Reallocator. */ |
a9429e29 | 155 | #define GGC_RESIZEVEC(T, P, N) \ |
231120e5 | 156 | ((T *) ggc_realloc ((P), (N) * sizeof (T) MEM_STAT_INFO)) |
a9429e29 | 157 | |
de49ce19 TS |
158 | template<typename T> |
159 | void | |
160 | finalize (void *p) | |
161 | { | |
162 | static_cast<T *> (p)->~T (); | |
163 | } | |
164 | ||
165 | template<typename T> | |
e886224b | 166 | inline bool |
de49ce19 TS |
167 | need_finalization_p () |
168 | { | |
169 | #if GCC_VERSION >= 4003 | |
170 | return !__has_trivial_destructor (T); | |
171 | #else | |
172 | return true; | |
173 | #endif | |
174 | } | |
175 | ||
766090c2 | 176 | template<typename T> |
e886224b | 177 | inline T * |
766090c2 | 178 | ggc_alloc (ALONE_CXX_MEM_STAT_INFO) |
a9429e29 | 179 | { |
de49ce19 TS |
180 | if (need_finalization_p<T> ()) |
181 | return static_cast<T *> (ggc_internal_alloc (sizeof (T), finalize<T>, 0, 1 | |
182 | PASS_MEM_STAT)); | |
183 | else | |
184 | return static_cast<T *> (ggc_internal_alloc (sizeof (T), NULL, 0, 1 | |
185 | PASS_MEM_STAT)); | |
a9429e29 LB |
186 | } |
187 | ||
78cd68c0 ML |
188 | /* GGC allocation function that does not call finalizer for type |
189 | that have need_finalization_p equal to true. User is responsible | |
190 | for calling of the destructor. */ | |
191 | ||
192 | template<typename T> | |
193 | inline T * | |
194 | ggc_alloc_no_dtor (ALONE_CXX_MEM_STAT_INFO) | |
195 | { | |
196 | return static_cast<T *> (ggc_internal_alloc (sizeof (T), NULL, 0, 1 | |
197 | PASS_MEM_STAT)); | |
198 | } | |
199 | ||
766090c2 | 200 | template<typename T> |
e886224b | 201 | inline T * |
766090c2 TS |
202 | ggc_cleared_alloc (ALONE_CXX_MEM_STAT_INFO) |
203 | { | |
de49ce19 TS |
204 | if (need_finalization_p<T> ()) |
205 | return static_cast<T *> (ggc_internal_cleared_alloc (sizeof (T), | |
206 | finalize<T>, 0, 1 | |
207 | PASS_MEM_STAT)); | |
208 | else | |
209 | return static_cast<T *> (ggc_internal_cleared_alloc (sizeof (T), NULL, 0, 1 | |
210 | PASS_MEM_STAT)); | |
766090c2 TS |
211 | } |
212 | ||
213 | template<typename T> | |
e886224b | 214 | inline T * |
766090c2 TS |
215 | ggc_vec_alloc (size_t c CXX_MEM_STAT_INFO) |
216 | { | |
de49ce19 TS |
217 | if (need_finalization_p<T> ()) |
218 | return static_cast<T *> (ggc_internal_alloc (c * sizeof (T), finalize<T>, | |
219 | sizeof (T), c PASS_MEM_STAT)); | |
220 | else | |
221 | return static_cast<T *> (ggc_internal_alloc (c * sizeof (T), NULL, 0, 0 | |
766090c2 TS |
222 | PASS_MEM_STAT)); |
223 | } | |
224 | ||
225 | template<typename T> | |
e886224b | 226 | inline T * |
766090c2 | 227 | ggc_cleared_vec_alloc (size_t c CXX_MEM_STAT_INFO) |
a9429e29 | 228 | { |
de49ce19 TS |
229 | if (need_finalization_p<T> ()) |
230 | return static_cast<T *> (ggc_internal_cleared_alloc (c * sizeof (T), | |
231 | finalize<T>, | |
232 | sizeof (T), c | |
766090c2 | 233 | PASS_MEM_STAT)); |
de49ce19 TS |
234 | else |
235 | return static_cast<T *> (ggc_internal_cleared_alloc (c * sizeof (T), NULL, | |
236 | 0, 0 PASS_MEM_STAT)); | |
a9429e29 LB |
237 | } |
238 | ||
e886224b | 239 | inline void * |
231120e5 | 240 | ggc_alloc_atomic (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 241 | { |
231120e5 | 242 | return ggc_internal_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
243 | } |
244 | ||
ddf628e4 ML |
245 | /* Call destructor and free the garbage collected memory. */ |
246 | ||
247 | template <typename T> | |
248 | inline void | |
249 | ggc_delete (T *ptr) | |
250 | { | |
251 | ptr->~T (); | |
252 | ggc_free (ptr); | |
253 | } | |
254 | ||
520a57c8 ZW |
255 | /* Allocate a gc-able string, and fill it with LENGTH bytes from CONTENTS. |
256 | If LENGTH is -1, then CONTENTS is assumed to be a | |
257 | null-terminated string and the memory sized accordingly. */ | |
231120e5 TS |
258 | extern const char *ggc_alloc_string (const char *contents, int length |
259 | CXX_MEM_STAT_INFO); | |
0a25f1f5 | 260 | |
f15b9af9 | 261 | /* Make a copy of S, in GC-able memory. */ |
231120e5 | 262 | #define ggc_strdup(S) ggc_alloc_string ((S), -1 MEM_STAT_INFO) |
f15b9af9 | 263 | |
cd5a58e5 ZW |
264 | /* Invoke the collector. Garbage collection occurs only when this |
265 | function is called, not during allocations. */ | |
20c1dc5e | 266 | extern void ggc_collect (void); |
0a25f1f5 | 267 | |
e5207f1a JH |
268 | /* Return unused memory pages to the system. */ |
269 | extern void ggc_trim (void); | |
270 | ||
fd1e9302 JH |
271 | /* Assume that all GGC memory is reachable and grow the limits for next collection. */ |
272 | extern void ggc_grow (void); | |
273 | ||
ae2392a9 | 274 | /* Register an additional root table. This can be useful for some |
32c9b4e9 | 275 | plugins. Does nothing if the passed pointer is NULL. */ |
ae2392a9 BS |
276 | extern void ggc_register_root_tab (const struct ggc_root_tab *); |
277 | ||
17211ab5 | 278 | /* Read objects previously saved with gt_pch_save from F. */ |
20c1dc5e | 279 | extern void gt_pch_restore (FILE *f); |
17211ab5 | 280 | \f |
3277221c MM |
281 | /* Statistics. */ |
282 | ||
c6991660 | 283 | /* Print allocation statistics. */ |
20c1dc5e | 284 | extern void ggc_print_statistics (void); |
a9429e29 | 285 | |
20c1dc5e | 286 | extern void stringpool_statistics (void); |
9ac121af KG |
287 | |
288 | /* Heuristics. */ | |
20c1dc5e | 289 | extern void init_ggc_heuristics (void); |
d07605f5 | 290 | |
c9ef0409 JH |
291 | /* Report current heap memory use to stderr. */ |
292 | extern void report_heap_memory_use (void); | |
293 | ||
cd030c07 | 294 | #define ggc_alloc_rtvec_sized(NELT) \ |
766090c2 | 295 | (rtvec_def *) ggc_internal_alloc (sizeof (struct rtvec_def) \ |
cd030c07 | 296 | + ((NELT) - 1) * sizeof (rtx)) \ |
08cee789 | 297 | |
a9429e29 LB |
298 | /* Memory statistics passing versions of some allocators. Too few of them to |
299 | make gengtype produce them, so just define the needed ones here. */ | |
e886224b | 300 | inline struct rtx_def * |
231120e5 | 301 | ggc_alloc_rtx_def_stat (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 302 | { |
231120e5 | 303 | return (struct rtx_def *) ggc_internal_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
304 | } |
305 | ||
e886224b | 306 | inline union tree_node * |
231120e5 | 307 | ggc_alloc_tree_node_stat (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 308 | { |
231120e5 | 309 | return (union tree_node *) ggc_internal_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
310 | } |
311 | ||
e886224b | 312 | inline union tree_node * |
231120e5 | 313 | ggc_alloc_cleared_tree_node_stat (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 314 | { |
231120e5 | 315 | return (union tree_node *) ggc_internal_cleared_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
316 | } |
317 | ||
e886224b | 318 | inline gimple * |
231120e5 | 319 | ggc_alloc_cleared_gimple_statement_stat (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 320 | { |
355fe088 | 321 | return (gimple *) ggc_internal_cleared_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
322 | } |
323 | ||
e886224b | 324 | inline void |
b086d530 TS |
325 | gt_ggc_mx (const char *s) |
326 | { | |
327 | ggc_test_and_set_mark (const_cast<char *> (s)); | |
328 | } | |
329 | ||
e886224b | 330 | inline void |
b086d530 TS |
331 | gt_pch_nx (const char *) |
332 | { | |
333 | } | |
334 | ||
e886224b | 335 | inline void |
b086d530 TS |
336 | gt_ggc_mx (int) |
337 | { | |
338 | } | |
339 | ||
e886224b | 340 | inline void |
b086d530 TS |
341 | gt_pch_nx (int) |
342 | { | |
343 | } | |
344 | ||
e886224b | 345 | inline void |
2a22f99c TS |
346 | gt_pch_nx (unsigned int) |
347 | { | |
348 | } | |
349 | ||
d07605f5 | 350 | #endif |