]>
Commit | Line | Data |
---|---|---|
0a25f1f5 | 1 | /* Garbage collection for the GNU compiler. |
ae2392a9 | 2 | |
a945c346 | 3 | Copyright (C) 1998-2024 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. */ | |
f3b957ea LH |
47 | extern int gt_pch_note_object (void *, void *, gt_note_pointers, |
48 | size_t length_override = (size_t)-1); | |
17211ab5 | 49 | |
fe7c3ecf JJ |
50 | /* Used by the gt_pch_p_* routines. Register address of a callback |
51 | pointer. */ | |
52 | extern void gt_pch_note_callback (void *, void *); | |
53 | ||
20c1dc5e | 54 | /* Used by the gt_pch_n_* routines. Register that an object has a reorder |
17211ab5 | 55 | function. */ |
20c1dc5e | 56 | extern void gt_pch_note_reorder (void *, void *, gt_handle_reorder); |
17211ab5 | 57 | |
aebf76a2 TS |
58 | /* generated function to clear caches in gc memory. */ |
59 | extern void gt_clear_caches (); | |
60 | ||
17211ab5 | 61 | /* Mark the object in the first parameter and anything it points to. */ |
20c1dc5e | 62 | typedef void (*gt_pointer_walker) (void *); |
e2500fed | 63 | |
589005ff | 64 | /* Structures for the easy way to mark roots. |
0ee55ad8 | 65 | In an array, terminated by having base == NULL. */ |
e2500fed GK |
66 | struct ggc_root_tab { |
67 | void *base; | |
68 | size_t nelt; | |
69 | size_t stride; | |
17211ab5 GK |
70 | gt_pointer_walker cb; |
71 | gt_pointer_walker pchw; | |
e2500fed | 72 | }; |
17211ab5 | 73 | #define LAST_GGC_ROOT_TAB { NULL, 0, 0, NULL, NULL } |
e2500fed GK |
74 | /* Pointers to arrays of ggc_root_tab, terminated by NULL. */ |
75 | extern const struct ggc_root_tab * const gt_ggc_rtab[]; | |
76 | extern const struct ggc_root_tab * const gt_ggc_deletable_rtab[]; | |
17211ab5 | 77 | extern const struct ggc_root_tab * const gt_pch_scalar_rtab[]; |
e2500fed | 78 | |
52a92176 AS |
79 | /* If EXPR is not NULL and previously unmarked, mark it and evaluate |
80 | to true. Otherwise evaluate to false. */ | |
81 | #define ggc_test_and_set_mark(EXPR) \ | |
e2500fed | 82 | ((EXPR) != NULL && ((void *) (EXPR)) != (void *) 1 && ! ggc_set_mark (EXPR)) |
52a92176 | 83 | |
005537df RH |
84 | #define ggc_mark(EXPR) \ |
85 | do { \ | |
d8750784 | 86 | const void *const a__ = (EXPR); \ |
e2500fed | 87 | if (a__ != NULL && a__ != (void *) 1) \ |
005537df RH |
88 | ggc_set_mark (a__); \ |
89 | } while (0) | |
90 | ||
17211ab5 GK |
91 | /* Actually set the mark on a particular region of memory, but don't |
92 | follow pointers. This function is called by ggc_mark_*. It | |
9a856f67 | 93 | returns false if the object was not previously marked; true if |
17211ab5 GK |
94 | the object was already marked, or if, for any other reason, |
95 | pointers in this data structure should not be traversed. */ | |
9a856f67 | 96 | extern bool ggc_set_mark (const void *); |
17211ab5 | 97 | |
9a856f67 | 98 | /* Return true if P has been marked, zero otherwise. |
17211ab5 GK |
99 | P must have been allocated by the GC allocator; it mustn't point to |
100 | static objects, stack variables, or memory allocated with malloc. */ | |
9a856f67 | 101 | extern bool ggc_marked_p (const void *); |
17211ab5 | 102 | |
17211ab5 | 103 | /* PCH and GGC handling for strings, mostly trivial. */ |
20c1dc5e | 104 | extern void gt_pch_n_S (const void *); |
f3b957ea | 105 | extern void gt_pch_n_S2 (const void *, size_t); |
dae4174e | 106 | extern void gt_ggc_m_S (const void *); |
17211ab5 | 107 | |
a9429e29 | 108 | /* End of GTY machinery API. */ |
17211ab5 | 109 | |
a9429e29 LB |
110 | /* Initialize the string pool. */ |
111 | extern void init_stringpool (void); | |
112 | ||
eebedaa5 | 113 | /* Initialize the garbage collector. */ |
20c1dc5e | 114 | extern void init_ggc (void); |
0a25f1f5 | 115 | |
dae4174e TT |
116 | /* When true, identifier nodes are considered as GC roots. When |
117 | false, identifier nodes are treated like any other GC-allocated | |
118 | object, and the identifier hash table is treated as a weak | |
119 | hash. */ | |
120 | extern bool ggc_protect_identifiers; | |
121 | ||
a9429e29 LB |
122 | /* Write out all GCed objects to F. */ |
123 | extern void gt_pch_save (FILE *f); | |
124 | ||
125 | \f | |
126 | /* Allocation. */ | |
127 | ||
005537df | 128 | /* The internal primitive. */ |
de49ce19 TS |
129 | extern void *ggc_internal_alloc (size_t, void (*)(void *), size_t, |
130 | size_t CXX_MEM_STAT_INFO) | |
131 | ATTRIBUTE_MALLOC; | |
132 | ||
e886224b NS |
133 | inline void * |
134 | ggc_internal_alloc (size_t s CXX_MEM_STAT_INFO) | |
de49ce19 TS |
135 | { |
136 | return ggc_internal_alloc (s, NULL, 0, 1 PASS_MEM_STAT); | |
137 | } | |
a9429e29 | 138 | |
b9bd6f74 TT |
139 | extern size_t ggc_round_alloc_size (size_t requested_size); |
140 | ||
a9429e29 | 141 | /* Allocates cleared memory. */ |
de49ce19 TS |
142 | extern void *ggc_internal_cleared_alloc (size_t, void (*)(void *), |
143 | size_t, size_t | |
144 | CXX_MEM_STAT_INFO) ATTRIBUTE_MALLOC; | |
145 | ||
e886224b | 146 | inline void * |
de49ce19 TS |
147 | ggc_internal_cleared_alloc (size_t s CXX_MEM_STAT_INFO) |
148 | { | |
149 | return ggc_internal_cleared_alloc (s, NULL, 0, 1 PASS_MEM_STAT); | |
150 | } | |
a9429e29 | 151 | |
e2500fed | 152 | /* Resize a block. */ |
231120e5 | 153 | extern void *ggc_realloc (void *, size_t CXX_MEM_STAT_INFO); |
a9429e29 | 154 | |
685fe032 RH |
155 | /* Free a block. To be used when known for certain it's not reachable. */ |
156 | extern void ggc_free (void *); | |
b8698a0f | 157 | |
c5281d50 | 158 | extern void dump_ggc_loc_statistics (); |
005537df | 159 | |
231120e5 | 160 | /* Reallocator. */ |
a9429e29 | 161 | #define GGC_RESIZEVEC(T, P, N) \ |
231120e5 | 162 | ((T *) ggc_realloc ((P), (N) * sizeof (T) MEM_STAT_INFO)) |
a9429e29 | 163 | |
de49ce19 TS |
164 | template<typename T> |
165 | void | |
166 | finalize (void *p) | |
167 | { | |
168 | static_cast<T *> (p)->~T (); | |
169 | } | |
170 | ||
171 | template<typename T> | |
e886224b | 172 | inline bool |
de49ce19 TS |
173 | need_finalization_p () |
174 | { | |
175 | #if GCC_VERSION >= 4003 | |
176 | return !__has_trivial_destructor (T); | |
177 | #else | |
178 | return true; | |
179 | #endif | |
180 | } | |
181 | ||
766090c2 | 182 | template<typename T> |
e886224b | 183 | inline T * |
766090c2 | 184 | ggc_alloc (ALONE_CXX_MEM_STAT_INFO) |
a9429e29 | 185 | { |
de49ce19 TS |
186 | if (need_finalization_p<T> ()) |
187 | return static_cast<T *> (ggc_internal_alloc (sizeof (T), finalize<T>, 0, 1 | |
188 | PASS_MEM_STAT)); | |
189 | else | |
190 | return static_cast<T *> (ggc_internal_alloc (sizeof (T), NULL, 0, 1 | |
191 | PASS_MEM_STAT)); | |
a9429e29 LB |
192 | } |
193 | ||
78cd68c0 ML |
194 | /* GGC allocation function that does not call finalizer for type |
195 | that have need_finalization_p equal to true. User is responsible | |
196 | for calling of the destructor. */ | |
197 | ||
198 | template<typename T> | |
199 | inline T * | |
200 | ggc_alloc_no_dtor (ALONE_CXX_MEM_STAT_INFO) | |
201 | { | |
202 | return static_cast<T *> (ggc_internal_alloc (sizeof (T), NULL, 0, 1 | |
203 | PASS_MEM_STAT)); | |
204 | } | |
205 | ||
766090c2 | 206 | template<typename T> |
e886224b | 207 | inline T * |
766090c2 TS |
208 | ggc_cleared_alloc (ALONE_CXX_MEM_STAT_INFO) |
209 | { | |
de49ce19 TS |
210 | if (need_finalization_p<T> ()) |
211 | return static_cast<T *> (ggc_internal_cleared_alloc (sizeof (T), | |
212 | finalize<T>, 0, 1 | |
213 | PASS_MEM_STAT)); | |
214 | else | |
215 | return static_cast<T *> (ggc_internal_cleared_alloc (sizeof (T), NULL, 0, 1 | |
216 | PASS_MEM_STAT)); | |
766090c2 TS |
217 | } |
218 | ||
219 | template<typename T> | |
e886224b | 220 | inline T * |
766090c2 TS |
221 | ggc_vec_alloc (size_t c CXX_MEM_STAT_INFO) |
222 | { | |
de49ce19 TS |
223 | if (need_finalization_p<T> ()) |
224 | return static_cast<T *> (ggc_internal_alloc (c * sizeof (T), finalize<T>, | |
225 | sizeof (T), c PASS_MEM_STAT)); | |
226 | else | |
227 | return static_cast<T *> (ggc_internal_alloc (c * sizeof (T), NULL, 0, 0 | |
766090c2 TS |
228 | PASS_MEM_STAT)); |
229 | } | |
230 | ||
231 | template<typename T> | |
e886224b | 232 | inline T * |
766090c2 | 233 | ggc_cleared_vec_alloc (size_t c CXX_MEM_STAT_INFO) |
a9429e29 | 234 | { |
de49ce19 TS |
235 | if (need_finalization_p<T> ()) |
236 | return static_cast<T *> (ggc_internal_cleared_alloc (c * sizeof (T), | |
237 | finalize<T>, | |
238 | sizeof (T), c | |
766090c2 | 239 | PASS_MEM_STAT)); |
de49ce19 TS |
240 | else |
241 | return static_cast<T *> (ggc_internal_cleared_alloc (c * sizeof (T), NULL, | |
242 | 0, 0 PASS_MEM_STAT)); | |
a9429e29 LB |
243 | } |
244 | ||
e886224b | 245 | inline void * |
231120e5 | 246 | ggc_alloc_atomic (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 247 | { |
231120e5 | 248 | return ggc_internal_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
249 | } |
250 | ||
ddf628e4 ML |
251 | /* Call destructor and free the garbage collected memory. */ |
252 | ||
253 | template <typename T> | |
254 | inline void | |
255 | ggc_delete (T *ptr) | |
256 | { | |
257 | ptr->~T (); | |
258 | ggc_free (ptr); | |
259 | } | |
260 | ||
520a57c8 ZW |
261 | /* Allocate a gc-able string, and fill it with LENGTH bytes from CONTENTS. |
262 | If LENGTH is -1, then CONTENTS is assumed to be a | |
263 | null-terminated string and the memory sized accordingly. */ | |
231120e5 TS |
264 | extern const char *ggc_alloc_string (const char *contents, int length |
265 | CXX_MEM_STAT_INFO); | |
0a25f1f5 | 266 | |
f15b9af9 | 267 | /* Make a copy of S, in GC-able memory. */ |
231120e5 | 268 | #define ggc_strdup(S) ggc_alloc_string ((S), -1 MEM_STAT_INFO) |
f15b9af9 | 269 | |
cd5a58e5 | 270 | /* Invoke the collector. Garbage collection occurs only when this |
602fca42 TS |
271 | function is called, not during allocations. */ |
272 | enum ggc_collect { | |
273 | GGC_COLLECT_HEURISTIC, | |
274 | GGC_COLLECT_FORCE | |
275 | }; | |
276 | extern void ggc_collect (enum ggc_collect mode = GGC_COLLECT_HEURISTIC); | |
0a25f1f5 | 277 | |
e5207f1a JH |
278 | /* Return unused memory pages to the system. */ |
279 | extern void ggc_trim (void); | |
280 | ||
fd1e9302 JH |
281 | /* Assume that all GGC memory is reachable and grow the limits for next collection. */ |
282 | extern void ggc_grow (void); | |
283 | ||
ae2392a9 | 284 | /* Register an additional root table. This can be useful for some |
32c9b4e9 | 285 | plugins. Does nothing if the passed pointer is NULL. */ |
ae2392a9 BS |
286 | extern void ggc_register_root_tab (const struct ggc_root_tab *); |
287 | ||
17211ab5 | 288 | /* Read objects previously saved with gt_pch_save from F. */ |
20c1dc5e | 289 | extern void gt_pch_restore (FILE *f); |
17211ab5 | 290 | \f |
3277221c MM |
291 | /* Statistics. */ |
292 | ||
c6991660 | 293 | /* Print allocation statistics. */ |
20c1dc5e | 294 | extern void ggc_print_statistics (void); |
a9429e29 | 295 | |
20c1dc5e | 296 | extern void stringpool_statistics (void); |
9ac121af KG |
297 | |
298 | /* Heuristics. */ | |
20c1dc5e | 299 | extern void init_ggc_heuristics (void); |
d07605f5 | 300 | |
c9ef0409 JH |
301 | /* Report current heap memory use to stderr. */ |
302 | extern void report_heap_memory_use (void); | |
303 | ||
cd030c07 | 304 | #define ggc_alloc_rtvec_sized(NELT) \ |
766090c2 | 305 | (rtvec_def *) ggc_internal_alloc (sizeof (struct rtvec_def) \ |
cd030c07 | 306 | + ((NELT) - 1) * sizeof (rtx)) \ |
08cee789 | 307 | |
a9429e29 LB |
308 | /* Memory statistics passing versions of some allocators. Too few of them to |
309 | make gengtype produce them, so just define the needed ones here. */ | |
e886224b | 310 | inline struct rtx_def * |
231120e5 | 311 | ggc_alloc_rtx_def_stat (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 312 | { |
231120e5 | 313 | return (struct rtx_def *) ggc_internal_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
314 | } |
315 | ||
e886224b | 316 | inline union tree_node * |
231120e5 | 317 | ggc_alloc_tree_node_stat (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 318 | { |
231120e5 | 319 | return (union tree_node *) ggc_internal_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
320 | } |
321 | ||
e886224b | 322 | inline union tree_node * |
231120e5 | 323 | ggc_alloc_cleared_tree_node_stat (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 324 | { |
231120e5 | 325 | return (union tree_node *) ggc_internal_cleared_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
326 | } |
327 | ||
e886224b | 328 | inline gimple * |
231120e5 | 329 | ggc_alloc_cleared_gimple_statement_stat (size_t s CXX_MEM_STAT_INFO) |
a9429e29 | 330 | { |
355fe088 | 331 | return (gimple *) ggc_internal_cleared_alloc (s PASS_MEM_STAT); |
a9429e29 LB |
332 | } |
333 | ||
e886224b | 334 | inline void |
b086d530 TS |
335 | gt_ggc_mx (const char *s) |
336 | { | |
337 | ggc_test_and_set_mark (const_cast<char *> (s)); | |
338 | } | |
339 | ||
e886224b | 340 | inline void |
b086d530 TS |
341 | gt_pch_nx (const char *) |
342 | { | |
343 | } | |
344 | ||
5d05e83e MS |
345 | inline void gt_pch_nx (bool) { } |
346 | inline void gt_pch_nx (char) { } | |
347 | inline void gt_pch_nx (signed char) { } | |
348 | inline void gt_pch_nx (unsigned char) { } | |
349 | inline void gt_pch_nx (short) { } | |
350 | inline void gt_pch_nx (unsigned short) { } | |
351 | inline void gt_pch_nx (int) { } | |
352 | inline void gt_pch_nx (unsigned int) { } | |
353 | inline void gt_pch_nx (long int) { } | |
354 | inline void gt_pch_nx (unsigned long int) { } | |
355 | inline void gt_pch_nx (long long int) { } | |
356 | inline void gt_pch_nx (unsigned long long int) { } | |
357 | ||
358 | inline void gt_ggc_mx (bool) { } | |
359 | inline void gt_ggc_mx (char) { } | |
360 | inline void gt_ggc_mx (signed char) { } | |
361 | inline void gt_ggc_mx (unsigned char) { } | |
362 | inline void gt_ggc_mx (short) { } | |
363 | inline void gt_ggc_mx (unsigned short) { } | |
364 | inline void gt_ggc_mx (int) { } | |
365 | inline void gt_ggc_mx (unsigned int) { } | |
366 | inline void gt_ggc_mx (long int) { } | |
367 | inline void gt_ggc_mx (unsigned long int) { } | |
368 | inline void gt_ggc_mx (long long int) { } | |
369 | inline void gt_ggc_mx (unsigned long long int) { } | |
2a22f99c | 370 | |
eaa8e854 DM |
371 | extern void ggc_common_finalize (); |
372 | ||
d07605f5 | 373 | #endif |