]>
Commit | Line | Data |
---|---|---|
0a25f1f5 | 1 | /* Garbage collection for the GNU compiler. |
a2130901 | 2 | Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 |
20c1dc5e | 3 | 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 | |
9 | Software Foundation; either version 2, or (at your option) any later | |
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 | |
1322177d | 18 | along with GCC; see the file COPYING. If not, write to the Free |
770ae6cc RK |
19 | Software Foundation, 59 Temple Place - Suite 330, Boston, MA |
20 | 02111-1307, USA. */ | |
0a25f1f5 | 21 | |
d07605f5 AP |
22 | #ifndef GCC_GGC_H |
23 | #define GCC_GGC_H | |
b9dcdee4 | 24 | #include "statistics.h" |
d07605f5 | 25 | |
0a25f1f5 RH |
26 | /* Symbols are marked with `ggc' for `gcc gc' so as not to interfere with |
27 | an external gc library that might be linked in. */ | |
28 | ||
21a427cc | 29 | /* Constants for general use. */ |
a8a05998 ZW |
30 | extern const char empty_string[]; /* empty string */ |
31 | extern const char digit_vector[]; /* "0" .. "9" */ | |
32 | #define digit_string(d) (digit_vector + ((d) * 2)) | |
21a427cc | 33 | |
17211ab5 GK |
34 | /* Internal functions and data structures used by the GTY |
35 | machinery. */ | |
36 | ||
37 | /* The first parameter is a pointer to a pointer, the second a cookie. */ | |
20c1dc5e | 38 | typedef void (*gt_pointer_operator) (void *, void *); |
17211ab5 GK |
39 | |
40 | #include "gtype-desc.h" | |
41 | ||
42 | /* One of these applies its third parameter (with cookie in the fourth | |
43 | parameter) to each pointer in the object pointed to by the first | |
44 | parameter, using the second parameter. */ | |
20c1dc5e AJ |
45 | typedef void (*gt_note_pointers) (void *, void *, gt_pointer_operator, |
46 | void *); | |
17211ab5 GK |
47 | |
48 | /* One of these is called before objects are re-ordered in memory. | |
49 | The first parameter is the original object, the second is the | |
50 | subobject that has had its pointers reordered, the third parameter | |
51 | can compute the new values of a pointer when given the cookie in | |
52 | the fourth parameter. */ | |
20c1dc5e AJ |
53 | typedef void (*gt_handle_reorder) (void *, void *, gt_pointer_operator, |
54 | void *); | |
17211ab5 GK |
55 | |
56 | /* Used by the gt_pch_n_* routines. Register an object in the hash table. */ | |
08cee789 DJ |
57 | extern int gt_pch_note_object (void *, void *, gt_note_pointers, |
58 | enum gt_types_enum); | |
17211ab5 | 59 | |
20c1dc5e | 60 | /* Used by the gt_pch_n_* routines. Register that an object has a reorder |
17211ab5 | 61 | function. */ |
20c1dc5e | 62 | extern void gt_pch_note_reorder (void *, void *, gt_handle_reorder); |
17211ab5 GK |
63 | |
64 | /* Mark the object in the first parameter and anything it points to. */ | |
20c1dc5e | 65 | typedef void (*gt_pointer_walker) (void *); |
e2500fed | 66 | |
589005ff | 67 | /* Structures for the easy way to mark roots. |
0ee55ad8 | 68 | In an array, terminated by having base == NULL. */ |
e2500fed GK |
69 | struct ggc_root_tab { |
70 | void *base; | |
71 | size_t nelt; | |
72 | size_t stride; | |
17211ab5 GK |
73 | gt_pointer_walker cb; |
74 | gt_pointer_walker pchw; | |
e2500fed | 75 | }; |
17211ab5 | 76 | #define LAST_GGC_ROOT_TAB { NULL, 0, 0, NULL, NULL } |
e2500fed GK |
77 | /* Pointers to arrays of ggc_root_tab, terminated by NULL. */ |
78 | extern const struct ggc_root_tab * const gt_ggc_rtab[]; | |
79 | extern const struct ggc_root_tab * const gt_ggc_deletable_rtab[]; | |
17211ab5 GK |
80 | extern const struct ggc_root_tab * const gt_pch_cache_rtab[]; |
81 | extern const struct ggc_root_tab * const gt_pch_scalar_rtab[]; | |
e2500fed GK |
82 | |
83 | /* Structure for hash table cache marking. */ | |
84 | struct htab; | |
85 | struct ggc_cache_tab { | |
86 | struct htab * *base; | |
87 | size_t nelt; | |
88 | size_t stride; | |
17211ab5 GK |
89 | gt_pointer_walker cb; |
90 | gt_pointer_walker pchw; | |
20c1dc5e | 91 | int (*marked_p) (const void *); |
e2500fed | 92 | }; |
17211ab5 | 93 | #define LAST_GGC_CACHE_TAB { NULL, 0, 0, NULL, NULL, NULL } |
e2500fed GK |
94 | /* Pointers to arrays of ggc_cache_tab, terminated by NULL. */ |
95 | extern const struct ggc_cache_tab * const gt_ggc_cache_rtab[]; | |
96 | ||
52a92176 AS |
97 | /* If EXPR is not NULL and previously unmarked, mark it and evaluate |
98 | to true. Otherwise evaluate to false. */ | |
99 | #define ggc_test_and_set_mark(EXPR) \ | |
e2500fed | 100 | ((EXPR) != NULL && ((void *) (EXPR)) != (void *) 1 && ! ggc_set_mark (EXPR)) |
52a92176 | 101 | |
005537df RH |
102 | #define ggc_mark(EXPR) \ |
103 | do { \ | |
d8750784 | 104 | const void *const a__ = (EXPR); \ |
e2500fed | 105 | if (a__ != NULL && a__ != (void *) 1) \ |
005537df RH |
106 | ggc_set_mark (a__); \ |
107 | } while (0) | |
108 | ||
17211ab5 GK |
109 | /* Actually set the mark on a particular region of memory, but don't |
110 | follow pointers. This function is called by ggc_mark_*. It | |
6356f892 | 111 | returns zero if the object was not previously marked; nonzero if |
17211ab5 GK |
112 | the object was already marked, or if, for any other reason, |
113 | pointers in this data structure should not be traversed. */ | |
20c1dc5e | 114 | extern int ggc_set_mark (const void *); |
17211ab5 GK |
115 | |
116 | /* Return 1 if P has been marked, zero otherwise. | |
117 | P must have been allocated by the GC allocator; it mustn't point to | |
118 | static objects, stack variables, or memory allocated with malloc. */ | |
20c1dc5e | 119 | extern int ggc_marked_p (const void *); |
17211ab5 GK |
120 | |
121 | /* Mark the entries in the string pool. */ | |
20c1dc5e | 122 | extern void ggc_mark_stringpool (void); |
17211ab5 GK |
123 | |
124 | /* Call ggc_set_mark on all the roots. */ | |
125 | ||
20c1dc5e | 126 | extern void ggc_mark_roots (void); |
17211ab5 GK |
127 | |
128 | /* Save and restore the string pool entries for PCH. */ | |
129 | ||
20c1dc5e AJ |
130 | extern void gt_pch_save_stringpool (void); |
131 | extern void gt_pch_fixup_stringpool (void); | |
132 | extern void gt_pch_restore_stringpool (void); | |
17211ab5 GK |
133 | |
134 | /* PCH and GGC handling for strings, mostly trivial. */ | |
135 | ||
20c1dc5e AJ |
136 | extern void gt_pch_p_S (void *, void *, gt_pointer_operator, void *); |
137 | extern void gt_pch_n_S (const void *); | |
138 | extern void gt_ggc_m_S (void *); | |
17211ab5 | 139 | |
39e3f58c | 140 | /* Initialize the string pool. */ |
20c1dc5e | 141 | extern void init_stringpool (void); |
17211ab5 GK |
142 | |
143 | /* A GC implementation must provide these functions. They are internal | |
144 | to the GC system. */ | |
b49a6a90 | 145 | |
47aeffac SB |
146 | /* Forward declare the zone structure. Only ggc_zone implements this. */ |
147 | struct alloc_zone; | |
148 | ||
eebedaa5 | 149 | /* Initialize the garbage collector. */ |
20c1dc5e | 150 | extern void init_ggc (void); |
0a25f1f5 | 151 | |
47aeffac SB |
152 | /* Start a new GGC zone. */ |
153 | extern struct alloc_zone *new_ggc_zone (const char *); | |
154 | ||
155 | /* Free a complete GGC zone, destroying everything in it. */ | |
156 | extern void destroy_ggc_zone (struct alloc_zone *); | |
157 | ||
21cd906e MM |
158 | /* Start a new GGC context. Memory allocated in previous contexts |
159 | will not be collected while the new context is active. */ | |
20c1dc5e | 160 | extern void ggc_push_context (void); |
b49a6a90 | 161 | |
21cd906e MM |
162 | /* Finish a GC context. Any uncollected memory in the new context |
163 | will be merged with the old context. */ | |
20c1dc5e | 164 | extern void ggc_pop_context (void); |
21cd906e | 165 | |
17211ab5 GK |
166 | struct ggc_pch_data; |
167 | ||
168 | /* Return a new ggc_pch_data structure. */ | |
20c1dc5e | 169 | extern struct ggc_pch_data *init_ggc_pch (void); |
17211ab5 GK |
170 | |
171 | /* The second parameter and third parameters give the address and size | |
172 | of an object. Update the ggc_pch_data structure with as much of | |
08cee789 | 173 | that information as is necessary. The bool argument should be true |
b6f61163 | 174 | if the object is a string. */ |
08cee789 DJ |
175 | extern void ggc_pch_count_object (struct ggc_pch_data *, void *, size_t, bool, |
176 | enum gt_types_enum); | |
17211ab5 | 177 | |
20c1dc5e | 178 | /* Return the total size of the data to be written to hold all |
17211ab5 | 179 | the objects previously passed to ggc_pch_count_object. */ |
20c1dc5e | 180 | extern size_t ggc_pch_total_size (struct ggc_pch_data *); |
17211ab5 GK |
181 | |
182 | /* The objects, when read, will most likely be at the address | |
183 | in the second parameter. */ | |
20c1dc5e | 184 | extern void ggc_pch_this_base (struct ggc_pch_data *, void *); |
17211ab5 GK |
185 | |
186 | /* Assuming that the objects really do end up at the address | |
b6f61163 | 187 | passed to ggc_pch_this_base, return the address of this object. |
08cee789 DJ |
188 | The bool argument should be true if the object is a string. */ |
189 | extern char *ggc_pch_alloc_object (struct ggc_pch_data *, void *, size_t, bool, | |
190 | enum gt_types_enum); | |
17211ab5 GK |
191 | |
192 | /* Write out any initial information required. */ | |
20c1dc5e | 193 | extern void ggc_pch_prepare_write (struct ggc_pch_data *, FILE *); |
b6f61163 DB |
194 | /* Write out this object, including any padding. The last argument should be |
195 | true if the object is a string. */ | |
20c1dc5e | 196 | extern void ggc_pch_write_object (struct ggc_pch_data *, FILE *, void *, |
b6f61163 | 197 | void *, size_t, bool); |
17211ab5 GK |
198 | /* All objects have been written, write out any final information |
199 | required. */ | |
20c1dc5e | 200 | extern void ggc_pch_finish (struct ggc_pch_data *, FILE *); |
17211ab5 GK |
201 | |
202 | /* A PCH file has just been read in at the address specified second | |
203 | parameter. Set up the GC implementation for the new objects. */ | |
20c1dc5e | 204 | extern void ggc_pch_read (FILE *, void *); |
17211ab5 GK |
205 | |
206 | \f | |
0a25f1f5 | 207 | /* Allocation. */ |
005537df | 208 | |
07724022 JH |
209 | /* When set, ggc_collect will do collection. */ |
210 | extern bool ggc_force_collect; | |
b6f61163 | 211 | |
005537df | 212 | /* The internal primitive. */ |
b9dcdee4 JH |
213 | extern void *ggc_alloc_stat (size_t MEM_STAT_DECL); |
214 | #define ggc_alloc(s) ggc_alloc_stat (s MEM_STAT_INFO) | |
6614fd40 | 215 | /* Allocate an object of the specified type and size. */ |
b9dcdee4 JH |
216 | extern void *ggc_alloc_typed_stat (enum gt_types_enum, size_t MEM_STAT_DECL); |
217 | #define ggc_alloc_typed(s,z) ggc_alloc_typed_stat (s,z MEM_STAT_INFO) | |
f8a83ee3 | 218 | /* Like ggc_alloc, but allocates cleared memory. */ |
b9dcdee4 JH |
219 | extern void *ggc_alloc_cleared_stat (size_t MEM_STAT_DECL); |
220 | #define ggc_alloc_cleared(s) ggc_alloc_cleared_stat (s MEM_STAT_INFO) | |
e2500fed | 221 | /* Resize a block. */ |
b9dcdee4 JH |
222 | extern void *ggc_realloc_stat (void *, size_t MEM_STAT_DECL); |
223 | #define ggc_realloc(s,z) ggc_realloc_stat (s,z MEM_STAT_INFO) | |
e2500fed | 224 | /* Like ggc_alloc_cleared, but performs a multiplication. */ |
20c1dc5e | 225 | extern void *ggc_calloc (size_t, size_t); |
685fe032 RH |
226 | /* Free a block. To be used when known for certain it's not reachable. */ |
227 | extern void ggc_free (void *); | |
b9dcdee4 | 228 | |
07724022 JH |
229 | extern void ggc_record_overhead (size_t, size_t, void * MEM_STAT_DECL); |
230 | extern void ggc_free_overhead (void *); | |
231 | extern void ggc_prune_overhead_list (void); | |
b9dcdee4 JH |
232 | |
233 | extern void dump_ggc_loc_statistics (void); | |
005537df | 234 | |
c32118f9 BI |
235 | /* Type-safe, C++-friendly versions of ggc_alloc() and gcc_calloc(). */ |
236 | #define GGC_NEW(T) ((T *) ggc_alloc (sizeof (T))) | |
237 | #define GGC_CNEW(T) ((T *) ggc_alloc_cleared (sizeof (T))) | |
238 | #define GGC_NEWVEC(T, N) ((T *) ggc_alloc ((N) * sizeof(T))) | |
239 | #define GGC_CNEWVEC(T, N) ((T *) ggc_alloc_cleared ((N) * sizeof(T))) | |
240 | #define GGC_NEWVAR(T, S) ((T *) ggc_alloc ((S))) | |
241 | #define GGC_CNEWVAR(T, S) ((T *) ggc_alloc_cleared ((S))) | |
242 | ||
08cee789 DJ |
243 | #define ggc_alloc_rtvec(NELT) \ |
244 | ((rtvec) ggc_alloc_zone (sizeof (struct rtvec_def) + ((NELT) - 1) \ | |
245 | * sizeof (rtx), &rtl_zone)) | |
005537df | 246 | |
08cee789 | 247 | #define ggc_alloc_tree(LENGTH) ((tree) ggc_alloc_zone (LENGTH, &tree_zone)) |
005537df | 248 | |
e2500fed GK |
249 | #define htab_create_ggc(SIZE, HASH, EQ, DEL) \ |
250 | htab_create_alloc (SIZE, HASH, EQ, DEL, ggc_calloc, NULL) | |
251 | ||
17211ab5 GK |
252 | #define splay_tree_new_ggc(COMPARE) \ |
253 | splay_tree_new_with_allocator (COMPARE, NULL, NULL, \ | |
254 | &ggc_splay_alloc, &ggc_splay_dont_free, \ | |
255 | NULL) | |
20c1dc5e AJ |
256 | extern void *ggc_splay_alloc (int, void *); |
257 | extern void ggc_splay_dont_free (void *, void *); | |
17211ab5 | 258 | |
520a57c8 ZW |
259 | /* Allocate a gc-able string, and fill it with LENGTH bytes from CONTENTS. |
260 | If LENGTH is -1, then CONTENTS is assumed to be a | |
261 | null-terminated string and the memory sized accordingly. */ | |
1d088dee | 262 | extern const char *ggc_alloc_string (const char *contents, int length); |
0a25f1f5 | 263 | |
f15b9af9 MM |
264 | /* Make a copy of S, in GC-able memory. */ |
265 | #define ggc_strdup(S) ggc_alloc_string((S), -1) | |
266 | ||
cd5a58e5 ZW |
267 | /* Invoke the collector. Garbage collection occurs only when this |
268 | function is called, not during allocations. */ | |
20c1dc5e | 269 | extern void ggc_collect (void); |
0a25f1f5 | 270 | |
17211ab5 | 271 | /* Return the number of bytes allocated at the indicated address. */ |
20c1dc5e | 272 | extern size_t ggc_get_size (const void *); |
4c160717 | 273 | |
17211ab5 | 274 | /* Write out all GCed objects to F. */ |
20c1dc5e | 275 | extern void gt_pch_save (FILE *f); |
0a25f1f5 | 276 | |
17211ab5 | 277 | /* Read objects previously saved with gt_pch_save from F. */ |
20c1dc5e | 278 | extern void gt_pch_restore (FILE *f); |
17211ab5 | 279 | \f |
3277221c MM |
280 | /* Statistics. */ |
281 | ||
282 | /* This structure contains the statistics common to all collectors. | |
283 | Particular collectors can extend this structure. */ | |
589005ff | 284 | typedef struct ggc_statistics |
3277221c | 285 | { |
17211ab5 GK |
286 | /* At present, we don't really gather any interesting statistics. */ |
287 | int unused; | |
3277221c MM |
288 | } ggc_statistics; |
289 | ||
3277221c MM |
290 | /* Used by the various collectors to gather and print statistics that |
291 | do not depend on the collector in use. */ | |
20c1dc5e | 292 | extern void ggc_print_common_statistics (FILE *, ggc_statistics *); |
c6991660 KG |
293 | |
294 | /* Print allocation statistics. */ | |
20c1dc5e AJ |
295 | extern void ggc_print_statistics (void); |
296 | extern void stringpool_statistics (void); | |
9ac121af KG |
297 | |
298 | /* Heuristics. */ | |
20c1dc5e AJ |
299 | extern int ggc_min_expand_heuristic (void); |
300 | extern int ggc_min_heapsize_heuristic (void); | |
301 | extern void init_ggc_heuristics (void); | |
d07605f5 | 302 | |
08cee789 DJ |
303 | /* Zone collection. */ |
304 | #if defined (GGC_ZONE) && !defined (GENERATOR_FILE) | |
305 | ||
306 | /* For regular rtl allocations. */ | |
307 | extern struct alloc_zone rtl_zone; | |
308 | /* For regular tree allocations. */ | |
309 | extern struct alloc_zone tree_zone; | |
310 | /* For IDENTIFIER_NODE allocations. */ | |
311 | extern struct alloc_zone tree_id_zone; | |
312 | ||
313 | /* Allocate an object into the specified allocation zone. */ | |
314 | extern void *ggc_alloc_zone_stat (size_t, struct alloc_zone * MEM_STAT_DECL); | |
315 | # define ggc_alloc_zone(s,z) ggc_alloc_zone_stat (s,z MEM_STAT_INFO) | |
a6e4d85b | 316 | # define ggc_alloc_zone_pass_stat(s,z) ggc_alloc_zone_stat (s,z PASS_MEM_STAT) |
08cee789 DJ |
317 | #else |
318 | ||
319 | # define ggc_alloc_zone(s, z) ggc_alloc (s) | |
a6e4d85b | 320 | # define ggc_alloc_zone_pass_stat(s, z) ggc_alloc_stat (s PASS_MEM_STAT) |
08cee789 DJ |
321 | |
322 | #endif | |
323 | ||
d07605f5 | 324 | #endif |