]>
Commit | Line | Data |
---|---|---|
0a25f1f5 | 1 | /* Garbage collection for the GNU compiler. |
20c1dc5e AJ |
2 | Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 |
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 | |
24 | ||
0a25f1f5 RH |
25 | /* Symbols are marked with `ggc' for `gcc gc' so as not to interfere with |
26 | an external gc library that might be linked in. */ | |
27 | ||
21a427cc | 28 | /* Constants for general use. */ |
a8a05998 ZW |
29 | extern const char empty_string[]; /* empty string */ |
30 | extern const char digit_vector[]; /* "0" .. "9" */ | |
31 | #define digit_string(d) (digit_vector + ((d) * 2)) | |
21a427cc | 32 | |
17211ab5 GK |
33 | /* Internal functions and data structures used by the GTY |
34 | machinery. */ | |
35 | ||
36 | /* The first parameter is a pointer to a pointer, the second a cookie. */ | |
20c1dc5e | 37 | typedef void (*gt_pointer_operator) (void *, void *); |
17211ab5 GK |
38 | |
39 | #include "gtype-desc.h" | |
40 | ||
41 | /* One of these applies its third parameter (with cookie in the fourth | |
42 | parameter) to each pointer in the object pointed to by the first | |
43 | parameter, using the second parameter. */ | |
20c1dc5e AJ |
44 | typedef void (*gt_note_pointers) (void *, void *, gt_pointer_operator, |
45 | void *); | |
17211ab5 GK |
46 | |
47 | /* One of these is called before objects are re-ordered in memory. | |
48 | The first parameter is the original object, the second is the | |
49 | subobject that has had its pointers reordered, the third parameter | |
50 | can compute the new values of a pointer when given the cookie in | |
51 | the fourth parameter. */ | |
20c1dc5e AJ |
52 | typedef void (*gt_handle_reorder) (void *, void *, gt_pointer_operator, |
53 | void *); | |
17211ab5 GK |
54 | |
55 | /* Used by the gt_pch_n_* routines. Register an object in the hash table. */ | |
20c1dc5e | 56 | extern int gt_pch_note_object (void *, void *, gt_note_pointers); |
17211ab5 | 57 | |
20c1dc5e | 58 | /* Used by the gt_pch_n_* routines. Register that an object has a reorder |
17211ab5 | 59 | function. */ |
20c1dc5e | 60 | extern void gt_pch_note_reorder (void *, void *, gt_handle_reorder); |
17211ab5 GK |
61 | |
62 | /* Mark the object in the first parameter and anything it points to. */ | |
20c1dc5e | 63 | typedef void (*gt_pointer_walker) (void *); |
e2500fed | 64 | |
589005ff | 65 | /* Structures for the easy way to mark roots. |
e2500fed GK |
66 | In an array, terminated by having base == NULL.*/ |
67 | struct ggc_root_tab { | |
68 | void *base; | |
69 | size_t nelt; | |
70 | size_t stride; | |
17211ab5 GK |
71 | gt_pointer_walker cb; |
72 | gt_pointer_walker pchw; | |
e2500fed | 73 | }; |
17211ab5 | 74 | #define LAST_GGC_ROOT_TAB { NULL, 0, 0, NULL, NULL } |
e2500fed GK |
75 | /* Pointers to arrays of ggc_root_tab, terminated by NULL. */ |
76 | extern const struct ggc_root_tab * const gt_ggc_rtab[]; | |
77 | extern const struct ggc_root_tab * const gt_ggc_deletable_rtab[]; | |
17211ab5 GK |
78 | extern const struct ggc_root_tab * const gt_pch_cache_rtab[]; |
79 | extern const struct ggc_root_tab * const gt_pch_scalar_rtab[]; | |
e2500fed GK |
80 | |
81 | /* Structure for hash table cache marking. */ | |
82 | struct htab; | |
83 | struct ggc_cache_tab { | |
84 | struct htab * *base; | |
85 | size_t nelt; | |
86 | size_t stride; | |
17211ab5 GK |
87 | gt_pointer_walker cb; |
88 | gt_pointer_walker pchw; | |
20c1dc5e | 89 | int (*marked_p) (const void *); |
e2500fed | 90 | }; |
17211ab5 | 91 | #define LAST_GGC_CACHE_TAB { NULL, 0, 0, NULL, NULL, NULL } |
e2500fed GK |
92 | /* Pointers to arrays of ggc_cache_tab, terminated by NULL. */ |
93 | extern const struct ggc_cache_tab * const gt_ggc_cache_rtab[]; | |
94 | ||
52a92176 AS |
95 | /* If EXPR is not NULL and previously unmarked, mark it and evaluate |
96 | to true. Otherwise evaluate to false. */ | |
97 | #define ggc_test_and_set_mark(EXPR) \ | |
e2500fed | 98 | ((EXPR) != NULL && ((void *) (EXPR)) != (void *) 1 && ! ggc_set_mark (EXPR)) |
52a92176 | 99 | |
005537df RH |
100 | #define ggc_mark(EXPR) \ |
101 | do { \ | |
d8750784 | 102 | const void *const a__ = (EXPR); \ |
e2500fed | 103 | if (a__ != NULL && a__ != (void *) 1) \ |
005537df RH |
104 | ggc_set_mark (a__); \ |
105 | } while (0) | |
106 | ||
17211ab5 GK |
107 | /* Actually set the mark on a particular region of memory, but don't |
108 | follow pointers. This function is called by ggc_mark_*. It | |
6356f892 | 109 | returns zero if the object was not previously marked; nonzero if |
17211ab5 GK |
110 | the object was already marked, or if, for any other reason, |
111 | pointers in this data structure should not be traversed. */ | |
20c1dc5e | 112 | extern int ggc_set_mark (const void *); |
17211ab5 GK |
113 | |
114 | /* Return 1 if P has been marked, zero otherwise. | |
115 | P must have been allocated by the GC allocator; it mustn't point to | |
116 | static objects, stack variables, or memory allocated with malloc. */ | |
20c1dc5e | 117 | extern int ggc_marked_p (const void *); |
17211ab5 GK |
118 | |
119 | /* Mark the entries in the string pool. */ | |
20c1dc5e | 120 | extern void ggc_mark_stringpool (void); |
17211ab5 GK |
121 | |
122 | /* Call ggc_set_mark on all the roots. */ | |
123 | ||
20c1dc5e | 124 | extern void ggc_mark_roots (void); |
17211ab5 GK |
125 | |
126 | /* Save and restore the string pool entries for PCH. */ | |
127 | ||
20c1dc5e AJ |
128 | extern void gt_pch_save_stringpool (void); |
129 | extern void gt_pch_fixup_stringpool (void); | |
130 | extern void gt_pch_restore_stringpool (void); | |
17211ab5 GK |
131 | |
132 | /* PCH and GGC handling for strings, mostly trivial. */ | |
133 | ||
20c1dc5e AJ |
134 | extern void gt_pch_p_S (void *, void *, gt_pointer_operator, void *); |
135 | extern void gt_pch_n_S (const void *); | |
136 | extern void gt_ggc_m_S (void *); | |
17211ab5 | 137 | |
39e3f58c | 138 | /* Initialize the string pool. */ |
20c1dc5e | 139 | extern void init_stringpool (void); |
17211ab5 GK |
140 | |
141 | /* A GC implementation must provide these functions. They are internal | |
142 | to the GC system. */ | |
b49a6a90 | 143 | |
eebedaa5 | 144 | /* Initialize the garbage collector. */ |
20c1dc5e | 145 | extern void init_ggc (void); |
0a25f1f5 | 146 | |
21cd906e MM |
147 | /* Start a new GGC context. Memory allocated in previous contexts |
148 | will not be collected while the new context is active. */ | |
20c1dc5e | 149 | extern void ggc_push_context (void); |
b49a6a90 | 150 | |
21cd906e MM |
151 | /* Finish a GC context. Any uncollected memory in the new context |
152 | will be merged with the old context. */ | |
20c1dc5e | 153 | extern void ggc_pop_context (void); |
21cd906e | 154 | |
17211ab5 GK |
155 | struct ggc_pch_data; |
156 | ||
157 | /* Return a new ggc_pch_data structure. */ | |
20c1dc5e | 158 | extern struct ggc_pch_data *init_ggc_pch (void); |
17211ab5 GK |
159 | |
160 | /* The second parameter and third parameters give the address and size | |
161 | of an object. Update the ggc_pch_data structure with as much of | |
162 | that information as is necessary. */ | |
20c1dc5e | 163 | extern void ggc_pch_count_object (struct ggc_pch_data *, void *, size_t); |
17211ab5 | 164 | |
20c1dc5e | 165 | /* Return the total size of the data to be written to hold all |
17211ab5 | 166 | the objects previously passed to ggc_pch_count_object. */ |
20c1dc5e | 167 | extern size_t ggc_pch_total_size (struct ggc_pch_data *); |
17211ab5 GK |
168 | |
169 | /* The objects, when read, will most likely be at the address | |
170 | in the second parameter. */ | |
20c1dc5e | 171 | extern void ggc_pch_this_base (struct ggc_pch_data *, void *); |
17211ab5 GK |
172 | |
173 | /* Assuming that the objects really do end up at the address | |
174 | passed to ggc_pch_this_base, return the address of this object. */ | |
20c1dc5e | 175 | extern char *ggc_pch_alloc_object (struct ggc_pch_data *, void *, size_t); |
17211ab5 GK |
176 | |
177 | /* Write out any initial information required. */ | |
20c1dc5e | 178 | extern void ggc_pch_prepare_write (struct ggc_pch_data *, FILE *); |
17211ab5 | 179 | /* Write out this object, including any padding. */ |
20c1dc5e AJ |
180 | extern void ggc_pch_write_object (struct ggc_pch_data *, FILE *, void *, |
181 | void *, size_t); | |
17211ab5 GK |
182 | /* All objects have been written, write out any final information |
183 | required. */ | |
20c1dc5e | 184 | extern void ggc_pch_finish (struct ggc_pch_data *, FILE *); |
17211ab5 GK |
185 | |
186 | /* A PCH file has just been read in at the address specified second | |
187 | parameter. Set up the GC implementation for the new objects. */ | |
20c1dc5e | 188 | extern void ggc_pch_read (FILE *, void *); |
17211ab5 GK |
189 | |
190 | \f | |
0a25f1f5 | 191 | /* Allocation. */ |
005537df RH |
192 | |
193 | /* The internal primitive. */ | |
20c1dc5e | 194 | extern void *ggc_alloc (size_t); |
f8a83ee3 | 195 | /* Like ggc_alloc, but allocates cleared memory. */ |
20c1dc5e | 196 | extern void *ggc_alloc_cleared (size_t); |
e2500fed | 197 | /* Resize a block. */ |
20c1dc5e | 198 | extern void *ggc_realloc (void *, size_t); |
e2500fed | 199 | /* Like ggc_alloc_cleared, but performs a multiplication. */ |
20c1dc5e | 200 | extern void *ggc_calloc (size_t, size_t); |
005537df | 201 | |
f8a83ee3 | 202 | #define ggc_alloc_rtx(NSLOTS) \ |
bcda12f4 SB |
203 | ((rtx) ggc_alloc (sizeof (struct rtx_def) \ |
204 | + ((NSLOTS) - 1) * sizeof (rtunion))) | |
005537df RH |
205 | |
206 | #define ggc_alloc_rtvec(NELT) \ | |
bcda12f4 SB |
207 | ((rtvec) ggc_alloc (sizeof (struct rtvec_def) \ |
208 | + ((NELT) - 1) * sizeof (rtx))) | |
005537df | 209 | |
bcda12f4 | 210 | #define ggc_alloc_tree(LENGTH) ((tree) ggc_alloc (LENGTH)) |
005537df | 211 | |
e2500fed GK |
212 | #define htab_create_ggc(SIZE, HASH, EQ, DEL) \ |
213 | htab_create_alloc (SIZE, HASH, EQ, DEL, ggc_calloc, NULL) | |
214 | ||
17211ab5 GK |
215 | #define splay_tree_new_ggc(COMPARE) \ |
216 | splay_tree_new_with_allocator (COMPARE, NULL, NULL, \ | |
217 | &ggc_splay_alloc, &ggc_splay_dont_free, \ | |
218 | NULL) | |
20c1dc5e AJ |
219 | extern void *ggc_splay_alloc (int, void *); |
220 | extern void ggc_splay_dont_free (void *, void *); | |
17211ab5 | 221 | |
520a57c8 ZW |
222 | /* Allocate a gc-able string, and fill it with LENGTH bytes from CONTENTS. |
223 | If LENGTH is -1, then CONTENTS is assumed to be a | |
224 | null-terminated string and the memory sized accordingly. */ | |
1d088dee | 225 | extern const char *ggc_alloc_string (const char *contents, int length); |
0a25f1f5 | 226 | |
f15b9af9 MM |
227 | /* Make a copy of S, in GC-able memory. */ |
228 | #define ggc_strdup(S) ggc_alloc_string((S), -1) | |
229 | ||
cd5a58e5 ZW |
230 | /* Invoke the collector. Garbage collection occurs only when this |
231 | function is called, not during allocations. */ | |
20c1dc5e | 232 | extern void ggc_collect (void); |
0a25f1f5 | 233 | |
17211ab5 | 234 | /* Return the number of bytes allocated at the indicated address. */ |
20c1dc5e | 235 | extern size_t ggc_get_size (const void *); |
4c160717 | 236 | |
17211ab5 | 237 | /* Write out all GCed objects to F. */ |
20c1dc5e | 238 | extern void gt_pch_save (FILE *f); |
0a25f1f5 | 239 | |
17211ab5 | 240 | /* Read objects previously saved with gt_pch_save from F. */ |
20c1dc5e | 241 | extern void gt_pch_restore (FILE *f); |
17211ab5 | 242 | \f |
3277221c MM |
243 | /* Statistics. */ |
244 | ||
245 | /* This structure contains the statistics common to all collectors. | |
246 | Particular collectors can extend this structure. */ | |
589005ff | 247 | typedef struct ggc_statistics |
3277221c | 248 | { |
17211ab5 GK |
249 | /* At present, we don't really gather any interesting statistics. */ |
250 | int unused; | |
3277221c MM |
251 | } ggc_statistics; |
252 | ||
3277221c MM |
253 | /* Used by the various collectors to gather and print statistics that |
254 | do not depend on the collector in use. */ | |
20c1dc5e | 255 | extern void ggc_print_common_statistics (FILE *, ggc_statistics *); |
c6991660 KG |
256 | |
257 | /* Print allocation statistics. */ | |
20c1dc5e AJ |
258 | extern void ggc_print_statistics (void); |
259 | extern void stringpool_statistics (void); | |
9ac121af KG |
260 | |
261 | /* Heuristics. */ | |
20c1dc5e AJ |
262 | extern int ggc_min_expand_heuristic (void); |
263 | extern int ggc_min_heapsize_heuristic (void); | |
264 | extern void init_ggc_heuristics (void); | |
d07605f5 AP |
265 | |
266 | #endif |