Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
61045190 DH |
3 | #ifndef SCM_GC_H |
4 | #define SCM_GC_H | |
8c494e99 | 5 | |
fc7bd367 | 6 | /* Copyright (C) 1995,1996,1998,1999,2000,2001, 2002, 2003, 2004, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. |
a00c95d9 | 7 | * |
73be1d9e | 8 | * This library is free software; you can redistribute it and/or |
53befeb7 NJ |
9 | * modify it under the terms of the GNU Lesser General Public License |
10 | * as published by the Free Software Foundation; either version 3 of | |
11 | * the License, or (at your option) any later version. | |
a00c95d9 | 12 | * |
53befeb7 NJ |
13 | * This library is distributed in the hope that it will be useful, but |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
73be1d9e MV |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 | * Lesser General Public License for more details. | |
a00c95d9 | 17 | * |
73be1d9e MV |
18 | * You should have received a copy of the GNU Lesser General Public |
19 | * License along with this library; if not, write to the Free Software | |
53befeb7 NJ |
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
21 | * 02110-1301 USA | |
73be1d9e | 22 | */ |
d3a6bc94 | 23 | |
0f2d19dd JB |
24 | \f |
25 | ||
b4309c3c | 26 | #include "libguile/__scm.h" |
2549a709 | 27 | |
9b3e180c | 28 | #include "libguile/hooks.h" |
9de87eea | 29 | #include "libguile/threads.h" |
9bc4701c | 30 | |
0f2d19dd | 31 | \f |
228a24ef | 32 | typedef struct scm_t_cell |
2549a709 | 33 | { |
33c527ec MV |
34 | SCM word_0; |
35 | SCM word_1; | |
228a24ef | 36 | } scm_t_cell; |
2549a709 | 37 | |
21041372 AW |
38 | /* FIXME: deprecate. */ |
39 | #define PTR2SCM(x) (SCM_PACK_POINTER (x)) | |
40 | #define SCM2PTR(x) ((scm_t_cell *) (SCM_UNPACK_POINTER (x))) | |
1fc8902f DH |
41 | |
42 | /* Low level cell data accessing macros. These macros should only be used | |
43 | * from within code related to garbage collection issues, since they will | |
44 | * never check the cells they are applied to - not even if guile is compiled | |
45 | * in debug mode. In particular these macros will even work for free cells, | |
46 | * which should never be encountered by user code. */ | |
47 | ||
47ed8656 AW |
48 | #define SCM_GC_CELL_OBJECT(x, n) (SCM_PACK (SCM_HEAP_OBJECT_BASE (x)[n])) |
49 | #define SCM_GC_CELL_WORD(x, n) (SCM_HEAP_OBJECT_BASE (x)[n]) | |
33c527ec | 50 | |
47ed8656 AW |
51 | #define SCM_GC_SET_CELL_OBJECT(x, n, v) \ |
52 | (SCM_HEAP_OBJECT_BASE (x)[n] = SCM_UNPACK (v)) | |
33c527ec | 53 | #define SCM_GC_SET_CELL_WORD(x, n, v) \ |
47ed8656 | 54 | (SCM_HEAP_OBJECT_BASE (x)[n] = (v)) |
33c527ec MV |
55 | |
56 | #define SCM_GC_CELL_TYPE(x) (SCM_GC_CELL_OBJECT ((x), 0)) | |
1fc8902f DH |
57 | |
58 | ||
59 | /* Except for the garbage collector, no part of guile should ever run over a | |
60 | * free cell. Thus, if guile is compiled in debug mode the SCM_CELL_* and | |
61 | * SCM_SET_CELL_* macros below report an error if they are applied to a free | |
62 | * cell. Some other plausibility checks are also performed. However, if | |
63 | * guile is not compiled in debug mode, there won't be any time penalty at all | |
64 | * when using these macros. */ | |
2549a709 | 65 | |
406c7d90 DH |
66 | #if (SCM_DEBUG_CELL_ACCESSES == 1) |
67 | # define SCM_VALIDATE_CELL(cell, expr) (scm_assert_cell_valid (cell), (expr)) | |
708cb87c | 68 | #else |
61045190 | 69 | # define SCM_VALIDATE_CELL(cell, expr) (expr) |
708cb87c | 70 | #endif |
46d53380 | 71 | |
f706a58b | 72 | #define SCM_CELL_WORD(x, n) \ |
1fc8902f | 73 | SCM_VALIDATE_CELL ((x), SCM_GC_CELL_WORD ((x), (n))) |
33c527ec MV |
74 | #define SCM_CELL_WORD_0(x) SCM_CELL_WORD ((x), 0) |
75 | #define SCM_CELL_WORD_1(x) SCM_CELL_WORD ((x), 1) | |
76 | #define SCM_CELL_WORD_2(x) SCM_CELL_WORD ((x), 2) | |
77 | #define SCM_CELL_WORD_3(x) SCM_CELL_WORD ((x), 3) | |
2549a709 | 78 | |
f706a58b | 79 | #define SCM_CELL_OBJECT(x, n) \ |
1fc8902f | 80 | SCM_VALIDATE_CELL ((x), SCM_GC_CELL_OBJECT ((x), (n))) |
33c527ec MV |
81 | #define SCM_CELL_OBJECT_0(x) SCM_CELL_OBJECT ((x), 0) |
82 | #define SCM_CELL_OBJECT_1(x) SCM_CELL_OBJECT ((x), 1) | |
83 | #define SCM_CELL_OBJECT_2(x) SCM_CELL_OBJECT ((x), 2) | |
84 | #define SCM_CELL_OBJECT_3(x) SCM_CELL_OBJECT ((x), 3) | |
2549a709 | 85 | |
f706a58b | 86 | #define SCM_SET_CELL_WORD(x, n, v) \ |
1fc8902f | 87 | SCM_VALIDATE_CELL ((x), SCM_GC_SET_CELL_WORD ((x), (n), (v))) |
33c527ec MV |
88 | #define SCM_SET_CELL_WORD_0(x, v) SCM_SET_CELL_WORD ((x), 0, (v)) |
89 | #define SCM_SET_CELL_WORD_1(x, v) SCM_SET_CELL_WORD ((x), 1, (v)) | |
90 | #define SCM_SET_CELL_WORD_2(x, v) SCM_SET_CELL_WORD ((x), 2, (v)) | |
91 | #define SCM_SET_CELL_WORD_3(x, v) SCM_SET_CELL_WORD ((x), 3, (v)) | |
2549a709 | 92 | |
f706a58b | 93 | #define SCM_SET_CELL_OBJECT(x, n, v) \ |
1fc8902f | 94 | SCM_VALIDATE_CELL ((x), SCM_GC_SET_CELL_OBJECT ((x), (n), (v))) |
33c527ec MV |
95 | #define SCM_SET_CELL_OBJECT_0(x, v) SCM_SET_CELL_OBJECT ((x), 0, (v)) |
96 | #define SCM_SET_CELL_OBJECT_1(x, v) SCM_SET_CELL_OBJECT ((x), 1, (v)) | |
97 | #define SCM_SET_CELL_OBJECT_2(x, v) SCM_SET_CELL_OBJECT ((x), 2, (v)) | |
98 | #define SCM_SET_CELL_OBJECT_3(x, v) SCM_SET_CELL_OBJECT ((x), 3, (v)) | |
2549a709 | 99 | |
47ed8656 AW |
100 | #define SCM_CELL_WORD_LOC(x, n) (SCM_VALIDATE_CELL((x), &SCM_GC_CELL_WORD ((x), (n)))) |
101 | #define SCM_CELL_OBJECT_LOC(x, n) ((SCM *) SCM_CELL_WORD_LOC (x, n)) | |
b17e0ac3 MV |
102 | #define SCM_CARLOC(x) (SCM_CELL_OBJECT_LOC ((x), 0)) |
103 | #define SCM_CDRLOC(x) (SCM_CELL_OBJECT_LOC ((x), 1)) | |
104 | ||
2549a709 | 105 | #define SCM_CELL_TYPE(x) SCM_CELL_WORD_0 (x) |
33c527ec | 106 | #define SCM_SET_CELL_TYPE(x, t) SCM_SET_CELL_WORD_0 ((x), (t)) |
2549a709 | 107 | |
61045190 | 108 | |
61045190 | 109 | #if (SCM_DEBUG_CELL_ACCESSES == 1) |
eab1b259 HWN |
110 | /* Set this to != 0 if every cell that is accessed shall be checked: |
111 | */ | |
112 | SCM_API int scm_debug_cell_accesses_p; | |
113 | SCM_API int scm_expensive_debug_cell_accesses_p; | |
114 | SCM_API int scm_debug_cells_gc_interval ; | |
5f5e7a2c | 115 | SCM_API void scm_i_expensive_validation_check (SCM cell); |
61045190 DH |
116 | #endif |
117 | ||
102dbb6f | 118 | SCM_INTERNAL scm_i_pthread_mutex_t scm_i_gc_admin_mutex; |
eb01cb64 | 119 | |
6033d326 | 120 | #define scm_gc_running_p 0 |
102dbb6f | 121 | SCM_INTERNAL scm_i_pthread_mutex_t scm_i_sweep_mutex; |
b17e0ac3 | 122 | |
9a5fa6e9 NJ |
123 | #ifdef __ia64__ |
124 | void *scm_ia64_register_backing_store_base (void); | |
125 | void *scm_ia64_ar_bsp (const void *); | |
126 | #endif | |
127 | ||
0f2d19dd JB |
128 | \f |
129 | ||
b74e86cf | 130 | SCM_API unsigned long scm_gc_ports_collected; |
33b001fd MV |
131 | |
132 | SCM_API SCM scm_after_gc_hook; | |
133 | ||
134 | SCM_API scm_t_c_hook scm_before_gc_c_hook; | |
135 | SCM_API scm_t_c_hook scm_before_mark_c_hook; | |
136 | SCM_API scm_t_c_hook scm_before_sweep_c_hook; | |
137 | SCM_API scm_t_c_hook scm_after_sweep_c_hook; | |
138 | SCM_API scm_t_c_hook scm_after_gc_c_hook; | |
9b3e180c | 139 | |
0f2d19dd | 140 | \f |
0f2d19dd | 141 | |
61045190 | 142 | #if (SCM_DEBUG_CELL_ACCESSES == 1) |
33b001fd | 143 | SCM_API void scm_assert_cell_valid (SCM); |
61045190 | 144 | #endif |
c8a1bdc4 HWN |
145 | |
146 | SCM_API SCM scm_set_debug_cell_accesses_x (SCM flag); | |
147 | ||
148 | ||
33b001fd | 149 | SCM_API SCM scm_object_address (SCM obj); |
915b3f9f LC |
150 | SCM_API SCM scm_gc_enable (void); |
151 | SCM_API SCM scm_gc_disable (void); | |
7f9ec18a | 152 | SCM_API SCM scm_gc_dump (void); |
33b001fd | 153 | SCM_API SCM scm_gc_stats (void); |
1367aa5e | 154 | SCM_API SCM scm_gc_live_object_stats (void); |
33b001fd | 155 | SCM_API SCM scm_gc (void); |
8c93b597 | 156 | SCM_INTERNAL void scm_i_gc (const char *what); |
33b001fd | 157 | SCM_API void scm_gc_mark (SCM p); |
33b001fd | 158 | SCM_API void scm_gc_sweep (void); |
4c9419ac | 159 | |
fd51e661 AW |
160 | SCM_API void scm_gc_register_allocation (size_t size); |
161 | ||
e3401c65 LC |
162 | SCM_API void *scm_malloc (size_t size) SCM_MALLOC; |
163 | SCM_API void *scm_calloc (size_t size) SCM_MALLOC; | |
4c9419ac | 164 | SCM_API void *scm_realloc (void *mem, size_t size); |
e3401c65 LC |
165 | SCM_API char *scm_strdup (const char *str) SCM_MALLOC; |
166 | SCM_API char *scm_strndup (const char *str, size_t n) SCM_MALLOC; | |
4c9419ac MV |
167 | SCM_API void scm_gc_register_collectable_memory (void *mem, size_t size, |
168 | const char *what); | |
169 | SCM_API void scm_gc_unregister_collectable_memory (void *mem, size_t size, | |
170 | const char *what); | |
e3401c65 LC |
171 | SCM_API void *scm_gc_malloc_pointerless (size_t size, const char *what) |
172 | SCM_MALLOC; | |
173 | SCM_API void *scm_gc_calloc (size_t size, const char *what) | |
174 | SCM_MALLOC; | |
175 | SCM_API void *scm_gc_malloc (size_t size, const char *what) | |
176 | SCM_MALLOC; | |
4c9419ac MV |
177 | SCM_API void *scm_gc_realloc (void *mem, size_t old_size, |
178 | size_t new_size, const char *what); | |
179 | SCM_API void scm_gc_free (void *mem, size_t size, const char *what); | |
e3401c65 LC |
180 | SCM_API char *scm_gc_strdup (const char *str, const char *what) |
181 | SCM_MALLOC; | |
182 | SCM_API char *scm_gc_strndup (const char *str, size_t n, const char *what) | |
183 | SCM_MALLOC; | |
4c9419ac | 184 | |
4cf77f09 AW |
185 | |
186 | #ifdef BUILDING_LIBGUILE | |
187 | #include "libguile/bdw-gc.h" | |
188 | #define SCM_GC_MALLOC(size) GC_MALLOC (size) | |
189 | #define SCM_GC_MALLOC_POINTERLESS(size) GC_MALLOC_ATOMIC (size) | |
190 | #else | |
191 | #define SCM_GC_MALLOC(size) scm_gc_malloc (size, NULL) | |
192 | #define SCM_GC_MALLOC_POINTERLESS(size) scm_gc_malloc_pointerless (size, NULL) | |
193 | #endif | |
194 | ||
195 | ||
ff670362 AW |
196 | SCM_INLINE SCM scm_cell (scm_t_bits car, scm_t_bits cdr); |
197 | SCM_INLINE SCM scm_double_cell (scm_t_bits car, scm_t_bits cbr, | |
198 | scm_t_bits ccr, scm_t_bits cdr); | |
199 | SCM_INLINE SCM scm_words (scm_t_bits car, scm_t_uint16 n_words); | |
200 | ||
201 | #if SCM_CAN_INLINE || defined SCM_INLINE_C_IMPLEMENTING_INLINES | |
202 | ||
203 | SCM_INLINE_IMPLEMENTATION SCM | |
204 | scm_cell (scm_t_bits car, scm_t_bits cdr) | |
205 | { | |
21041372 | 206 | SCM cell = SCM_PACK_POINTER (SCM_GC_MALLOC (sizeof (scm_t_cell))); |
ff670362 AW |
207 | |
208 | /* Initialize the type slot last so that the cell is ignored by the GC | |
209 | until it is completely initialized. This is only relevant when the GC | |
210 | can actually run during this code, which it can't since the GC only runs | |
211 | when all other threads are stopped. */ | |
212 | SCM_GC_SET_CELL_WORD (cell, 1, cdr); | |
213 | SCM_GC_SET_CELL_WORD (cell, 0, car); | |
214 | ||
215 | return cell; | |
216 | } | |
217 | ||
218 | SCM_INLINE_IMPLEMENTATION SCM | |
219 | scm_double_cell (scm_t_bits car, scm_t_bits cbr, | |
220 | scm_t_bits ccr, scm_t_bits cdr) | |
221 | { | |
222 | SCM z; | |
223 | ||
21041372 | 224 | z = SCM_PACK_POINTER (SCM_GC_MALLOC (2 * sizeof (scm_t_cell))); |
ff670362 AW |
225 | /* Initialize the type slot last so that the cell is ignored by the |
226 | GC until it is completely initialized. This is only relevant | |
227 | when the GC can actually run during this code, which it can't | |
228 | since the GC only runs when all other threads are stopped. | |
229 | */ | |
230 | SCM_GC_SET_CELL_WORD (z, 1, cbr); | |
231 | SCM_GC_SET_CELL_WORD (z, 2, ccr); | |
232 | SCM_GC_SET_CELL_WORD (z, 3, cdr); | |
233 | SCM_GC_SET_CELL_WORD (z, 0, car); | |
234 | ||
235 | /* When this function is inlined, it's possible that the last | |
236 | SCM_GC_SET_CELL_WORD above will be adjacent to a following | |
237 | initialization of z. E.g., it occurred in scm_make_real. GCC | |
238 | from around version 3 (e.g., certainly 3.2) began taking | |
239 | advantage of strict C aliasing rules which say that it's OK to | |
240 | interchange the initialization above and the one below when the | |
241 | pointer types appear to differ sufficiently. We don't want that, | |
242 | of course. GCC allows this behaviour to be disabled with the | |
243 | -fno-strict-aliasing option, but would also need to be supplied | |
244 | by Guile users. Instead, the following statements prevent the | |
245 | reordering. | |
246 | */ | |
247 | #ifdef __GNUC__ | |
248 | __asm__ volatile ("" : : : "memory"); | |
249 | #else | |
250 | /* portable version, just in case any other compiler does the same | |
251 | thing. */ | |
252 | scm_remember_upto_here_1 (z); | |
253 | #endif | |
254 | ||
255 | return z; | |
256 | } | |
257 | ||
258 | SCM_INLINE_IMPLEMENTATION SCM | |
259 | scm_words (scm_t_bits car, scm_t_uint16 n_words) | |
260 | { | |
261 | SCM z; | |
262 | ||
21041372 | 263 | z = SCM_PACK_POINTER (SCM_GC_MALLOC (sizeof (scm_t_bits) * n_words)); |
ff670362 AW |
264 | SCM_GC_SET_CELL_WORD (z, 0, car); |
265 | ||
266 | /* FIXME: is the following concern even relevant with BDW-GC? */ | |
267 | ||
268 | /* When this function is inlined, it's possible that the last | |
269 | SCM_GC_SET_CELL_WORD above will be adjacent to a following | |
270 | initialization of z. E.g., it occurred in scm_make_real. GCC | |
271 | from around version 3 (e.g., certainly 3.2) began taking | |
272 | advantage of strict C aliasing rules which say that it's OK to | |
273 | interchange the initialization above and the one below when the | |
274 | pointer types appear to differ sufficiently. We don't want that, | |
275 | of course. GCC allows this behaviour to be disabled with the | |
276 | -fno-strict-aliasing option, but would also need to be supplied | |
277 | by Guile users. Instead, the following statements prevent the | |
278 | reordering. | |
279 | */ | |
280 | #ifdef __GNUC__ | |
281 | __asm__ volatile ("" : : : "memory"); | |
282 | #else | |
283 | /* portable version, just in case any other compiler does the same | |
284 | thing. */ | |
285 | scm_remember_upto_here_1 (z); | |
286 | #endif | |
287 | ||
288 | return z; | |
289 | } | |
290 | ||
291 | #endif /* SCM_CAN_INLINE || defined SCM_INLINE_C_IMPLEMENTING_INLINES */ | |
292 | ||
33b001fd MV |
293 | SCM_API void scm_remember_upto_here_1 (SCM obj); |
294 | SCM_API void scm_remember_upto_here_2 (SCM obj1, SCM obj2); | |
295 | SCM_API void scm_remember_upto_here (SCM obj1, ...); | |
aca3618f | 296 | |
c1ffdc6a KR |
297 | /* In GCC we can force a reference to an SCM by making it an input to an |
298 | empty asm. This avoids the code size and slowdown of an actual function | |
299 | call. Unfortunately there doesn't seem to be any way to do the varargs | |
300 | scm_remember_upto_here like this. | |
301 | ||
302 | __volatile__ ensures nothing will be moved across the asm, and it won't | |
303 | be optimized away (or only if proved unreachable). Constraint "g" can be | |
304 | used on all processors and allows any memory or general register (or | |
305 | immediate) operand. The actual asm syntax doesn't matter, we don't want | |
306 | to use it, just ensure the operand is still alive. See "Extended Asm" in | |
307 | the GCC manual for more. */ | |
aca3618f KR |
308 | |
309 | #ifdef __GNUC__ | |
310 | #define scm_remember_upto_here_1(x) \ | |
311 | do { \ | |
312 | __asm__ __volatile__ ("" : : "g" (x)); \ | |
313 | } while (0) | |
314 | #define scm_remember_upto_here_2(x, y) \ | |
315 | do { \ | |
316 | scm_remember_upto_here_1 (x); \ | |
317 | scm_remember_upto_here_1 (y); \ | |
318 | } while (0) | |
319 | #endif | |
320 | ||
33b001fd MV |
321 | SCM_API SCM scm_return_first (SCM elt, ...); |
322 | SCM_API int scm_return_first_int (int x, ...); | |
323 | SCM_API SCM scm_permanent_object (SCM obj); | |
324 | SCM_API SCM scm_gc_protect_object (SCM obj); | |
325 | SCM_API SCM scm_gc_unprotect_object (SCM obj); | |
326 | SCM_API void scm_gc_register_root (SCM *p); | |
327 | SCM_API void scm_gc_unregister_root (SCM *p); | |
328 | SCM_API void scm_gc_register_roots (SCM *b, unsigned long n); | |
329 | SCM_API void scm_gc_unregister_roots (SCM *b, unsigned long n); | |
562cd1b8 AW |
330 | SCM_INTERNAL void scm_storage_prehistory (void); |
331 | SCM_INTERNAL void scm_init_gc_protect_object (void); | |
332 | SCM_INTERNAL void scm_init_gc (void); | |
d1ca2c64 | 333 | |
61045190 | 334 | #endif /* SCM_GC_H */ |
89e00824 ML |
335 | |
336 | /* | |
337 | Local Variables: | |
338 | c-file-style: "gnu" | |
339 | End: | |
340 | */ |