Commit | Line | Data |
---|---|---|
ec7f624d | 1 | /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. |
a00c95d9 | 2 | * |
73be1d9e | 3 | * This library is free software; you can redistribute it and/or |
53befeb7 NJ |
4 | * modify it under the terms of the GNU Lesser General Public License |
5 | * as published by the Free Software Foundation; either version 3 of | |
6 | * the License, or (at your option) any later version. | |
a00c95d9 | 7 | * |
53befeb7 NJ |
8 | * This library is distributed in the hope that it will be useful, but |
9 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
73be1d9e MV |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
11 | * Lesser General Public License for more details. | |
a00c95d9 | 12 | * |
73be1d9e MV |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the Free Software | |
53befeb7 NJ |
15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
16 | * 02110-1301 USA | |
73be1d9e | 17 | */ |
1bbd0b84 | 18 | |
37ddcaf6 MD |
19 | /* #define DEBUGINFO */ |
20 | ||
dbb605f5 | 21 | #ifdef HAVE_CONFIG_H |
aa54a9b0 RB |
22 | # include <config.h> |
23 | #endif | |
56495472 | 24 | |
e7bca227 LC |
25 | #include "libguile/gen-scmconfig.h" |
26 | ||
0f2d19dd | 27 | #include <stdio.h> |
e6e2e95a | 28 | #include <errno.h> |
783e7774 | 29 | #include <string.h> |
e6e2e95a | 30 | |
3ec17f28 LC |
31 | #ifdef __ia64__ |
32 | #include <ucontext.h> | |
33 | extern unsigned long * __libc_ia64_register_backing_store_base; | |
34 | #endif | |
35 | ||
a0599745 | 36 | #include "libguile/_scm.h" |
0a7a7445 | 37 | #include "libguile/eval.h" |
a0599745 MD |
38 | #include "libguile/stime.h" |
39 | #include "libguile/stackchk.h" | |
40 | #include "libguile/struct.h" | |
a0599745 | 41 | #include "libguile/smob.h" |
2fa901a5 | 42 | #include "libguile/arrays.h" |
a0599745 MD |
43 | #include "libguile/async.h" |
44 | #include "libguile/ports.h" | |
45 | #include "libguile/root.h" | |
46 | #include "libguile/strings.h" | |
47 | #include "libguile/vectors.h" | |
801cb5e7 | 48 | #include "libguile/weaks.h" |
686765af | 49 | #include "libguile/hashtab.h" |
ecf470a2 | 50 | #include "libguile/tags.h" |
a0599745 | 51 | |
c8a1bdc4 | 52 | #include "libguile/private-gc.h" |
a0599745 | 53 | #include "libguile/validate.h" |
1be6b49c | 54 | #include "libguile/deprecation.h" |
a0599745 | 55 | #include "libguile/gc.h" |
9de87eea | 56 | #include "libguile/dynwind.h" |
fce59c93 | 57 | |
1c44468d | 58 | #include "libguile/bdw-gc.h" |
a82e7953 | 59 | |
bc9d9bb2 | 60 | #ifdef GUILE_DEBUG_MALLOC |
a0599745 | 61 | #include "libguile/debug-malloc.h" |
bc9d9bb2 MD |
62 | #endif |
63 | ||
0f2d19dd | 64 | #ifdef HAVE_MALLOC_H |
95b88819 | 65 | #include <malloc.h> |
0f2d19dd JB |
66 | #endif |
67 | ||
68 | #ifdef HAVE_UNISTD_H | |
95b88819 | 69 | #include <unistd.h> |
0f2d19dd JB |
70 | #endif |
71 | ||
eae33935 | 72 | /* Set this to != 0 if every cell that is accessed shall be checked: |
61045190 | 73 | */ |
eab1b259 HWN |
74 | int scm_debug_cell_accesses_p = 0; |
75 | int scm_expensive_debug_cell_accesses_p = 0; | |
406c7d90 | 76 | |
e81d98ec DH |
77 | /* Set this to 0 if no additional gc's shall be performed, otherwise set it to |
78 | * the number of cell accesses after which a gc shall be called. | |
79 | */ | |
eab1b259 | 80 | int scm_debug_cells_gc_interval = 0; |
e81d98ec | 81 | |
acbccb0c LC |
82 | /* Hash table that keeps a reference to objects the user wants to protect from |
83 | garbage collection. It could arguably be private but applications have come | |
84 | to rely on it (e.g., Lilypond 2.13.9). */ | |
85 | SCM scm_protects; | |
e7efe8e7 AW |
86 | |
87 | ||
eab1b259 HWN |
88 | #if (SCM_DEBUG_CELL_ACCESSES == 1) |
89 | ||
90 | ||
91 | /* | |
92 | ||
93 | Assert that the given object is a valid reference to a valid cell. This | |
94 | test involves to determine whether the object is a cell pointer, whether | |
95 | this pointer actually points into a heap segment and whether the cell | |
96 | pointed to is not a free cell. Further, additional garbage collections may | |
97 | get executed after a user defined number of cell accesses. This helps to | |
98 | find places in the C code where references are dropped for extremely short | |
99 | periods. | |
100 | ||
101 | */ | |
406c7d90 | 102 | void |
eab1b259 | 103 | scm_i_expensive_validation_check (SCM cell) |
406c7d90 | 104 | { |
eab1b259 HWN |
105 | /* If desired, perform additional garbage collections after a user |
106 | * defined number of cell accesses. | |
107 | */ | |
108 | if (scm_debug_cells_gc_interval) | |
109 | { | |
110 | static unsigned int counter = 0; | |
61045190 | 111 | |
eab1b259 HWN |
112 | if (counter != 0) |
113 | { | |
114 | --counter; | |
115 | } | |
116 | else | |
117 | { | |
118 | counter = scm_debug_cells_gc_interval; | |
b17e0ac3 | 119 | scm_gc (); |
eab1b259 HWN |
120 | } |
121 | } | |
122 | } | |
123 | ||
8c93b597 LC |
124 | /* Whether cell validation is already running. */ |
125 | static int scm_i_cell_validation_already_running = 0; | |
126 | ||
eab1b259 HWN |
127 | void |
128 | scm_assert_cell_valid (SCM cell) | |
129 | { | |
130 | if (!scm_i_cell_validation_already_running && scm_debug_cell_accesses_p) | |
406c7d90 | 131 | { |
eab1b259 | 132 | scm_i_cell_validation_already_running = 1; /* set to avoid recursion */ |
406c7d90 | 133 | |
c8a1bdc4 | 134 | /* |
eab1b259 HWN |
135 | During GC, no user-code should be run, and the guile core |
136 | should use non-protected accessors. | |
137 | */ | |
c8a1bdc4 | 138 | if (scm_gc_running_p) |
eab1b259 | 139 | return; |
c8a1bdc4 HWN |
140 | |
141 | /* | |
eab1b259 HWN |
142 | Only scm_in_heap_p and rescanning the heap is wildly |
143 | expensive. | |
144 | */ | |
145 | if (scm_expensive_debug_cell_accesses_p) | |
146 | scm_i_expensive_validation_check (cell); | |
b4246e5b | 147 | |
eab1b259 | 148 | scm_i_cell_validation_already_running = 0; /* re-enable */ |
406c7d90 DH |
149 | } |
150 | } | |
151 | ||
152 | ||
eab1b259 | 153 | |
406c7d90 DH |
154 | SCM_DEFINE (scm_set_debug_cell_accesses_x, "set-debug-cell-accesses!", 1, 0, 0, |
155 | (SCM flag), | |
1e6808ea | 156 | "If @var{flag} is @code{#f}, cell access checking is disabled.\n" |
eab1b259 | 157 | "If @var{flag} is @code{#t}, cheap cell access checking is enabled,\n" |
e81d98ec | 158 | "but no additional calls to garbage collection are issued.\n" |
eab1b259 | 159 | "If @var{flag} is a number, strict cell access checking is enabled,\n" |
e81d98ec DH |
160 | "with an additional garbage collection after the given\n" |
161 | "number of cell accesses.\n" | |
1e6808ea MG |
162 | "This procedure only exists when the compile-time flag\n" |
163 | "@code{SCM_DEBUG_CELL_ACCESSES} was set to 1.") | |
406c7d90 DH |
164 | #define FUNC_NAME s_scm_set_debug_cell_accesses_x |
165 | { | |
7888309b | 166 | if (scm_is_false (flag)) |
eab1b259 HWN |
167 | { |
168 | scm_debug_cell_accesses_p = 0; | |
169 | } | |
bc36d050 | 170 | else if (scm_is_eq (flag, SCM_BOOL_T)) |
eab1b259 HWN |
171 | { |
172 | scm_debug_cells_gc_interval = 0; | |
173 | scm_debug_cell_accesses_p = 1; | |
174 | scm_expensive_debug_cell_accesses_p = 0; | |
175 | } | |
e11e83f3 | 176 | else |
eab1b259 | 177 | { |
e11e83f3 | 178 | scm_debug_cells_gc_interval = scm_to_signed_integer (flag, 0, INT_MAX); |
eab1b259 HWN |
179 | scm_debug_cell_accesses_p = 1; |
180 | scm_expensive_debug_cell_accesses_p = 1; | |
181 | } | |
406c7d90 DH |
182 | return SCM_UNSPECIFIED; |
183 | } | |
184 | #undef FUNC_NAME | |
0f2d19dd | 185 | |
ecf470a2 | 186 | |
c8a1bdc4 | 187 | #endif /* SCM_DEBUG_CELL_ACCESSES == 1 */ |
0f2d19dd JB |
188 | |
189 | \f | |
26224b3f LC |
190 | /* Hooks. */ |
191 | scm_t_c_hook scm_before_gc_c_hook; | |
192 | scm_t_c_hook scm_before_mark_c_hook; | |
193 | scm_t_c_hook scm_before_sweep_c_hook; | |
194 | scm_t_c_hook scm_after_sweep_c_hook; | |
195 | scm_t_c_hook scm_after_gc_c_hook; | |
945fec60 | 196 | |
0f2d19dd | 197 | |
0f2d19dd JB |
198 | /* GC Statistics Keeping |
199 | */ | |
b74e86cf LC |
200 | unsigned long scm_gc_ports_collected = 0; |
201 | ||
915b3f9f | 202 | static unsigned long protected_obj_count = 0; |
c2cbcc57 | 203 | |
0f2d19dd JB |
204 | |
205 | SCM_SYMBOL (sym_cells_allocated, "cells-allocated"); | |
915b3f9f LC |
206 | SCM_SYMBOL (sym_heap_size, "heap-size"); |
207 | SCM_SYMBOL (sym_heap_free_size, "heap-free-size"); | |
208 | SCM_SYMBOL (sym_heap_total_allocated, "heap-total-allocated"); | |
0f2d19dd JB |
209 | SCM_SYMBOL (sym_mallocated, "bytes-malloced"); |
210 | SCM_SYMBOL (sym_mtrigger, "gc-malloc-threshold"); | |
211 | SCM_SYMBOL (sym_heap_segments, "cell-heap-segments"); | |
212 | SCM_SYMBOL (sym_gc_time_taken, "gc-time-taken"); | |
c9b0d4b0 | 213 | SCM_SYMBOL (sym_gc_mark_time_taken, "gc-mark-time-taken"); |
c9b0d4b0 ML |
214 | SCM_SYMBOL (sym_times, "gc-times"); |
215 | SCM_SYMBOL (sym_cells_marked, "cells-marked"); | |
40945e5e | 216 | SCM_SYMBOL (sym_cells_marked_conservatively, "cells-marked-conservatively"); |
c9b0d4b0 | 217 | SCM_SYMBOL (sym_cells_swept, "cells-swept"); |
c2cbcc57 HWN |
218 | SCM_SYMBOL (sym_malloc_yield, "malloc-yield"); |
219 | SCM_SYMBOL (sym_cell_yield, "cell-yield"); | |
7eec4c37 | 220 | SCM_SYMBOL (sym_protected_objects, "protected-objects"); |
93632e3c | 221 | SCM_SYMBOL (sym_total_cells_allocated, "total-cells-allocated"); |
cf2d30f6 | 222 | |
d3dd80ab | 223 | |
cf2d30f6 | 224 | /* Number of calls to SCM_NEWCELL since startup. */ |
c8a1bdc4 HWN |
225 | unsigned scm_newcell_count; |
226 | unsigned scm_newcell2_count; | |
b37fe1c5 | 227 | |
b37fe1c5 | 228 | |
0f2d19dd JB |
229 | /* {Scheme Interface to GC} |
230 | */ | |
1367aa5e HWN |
231 | static SCM |
232 | tag_table_to_type_alist (void *closure, SCM key, SCM val, SCM acc) | |
233 | { | |
8fecbb19 | 234 | if (scm_is_integer (key)) |
8a00ba71 | 235 | { |
3e2073bd | 236 | int c_tag = scm_to_int (key); |
8fecbb19 HWN |
237 | |
238 | char const * name = scm_i_tag_name (c_tag); | |
239 | if (name != NULL) | |
240 | { | |
241 | key = scm_from_locale_string (name); | |
242 | } | |
243 | else | |
244 | { | |
245 | char s[100]; | |
246 | sprintf (s, "tag %d", c_tag); | |
247 | key = scm_from_locale_string (s); | |
248 | } | |
8a00ba71 | 249 | } |
8fecbb19 | 250 | |
1367aa5e HWN |
251 | return scm_cons (scm_cons (key, val), acc); |
252 | } | |
253 | ||
254 | SCM_DEFINE (scm_gc_live_object_stats, "gc-live-object-stats", 0, 0, 0, | |
255 | (), | |
256 | "Return an alist of statistics of the current live objects. ") | |
257 | #define FUNC_NAME s_scm_gc_live_object_stats | |
258 | { | |
259 | SCM tab = scm_make_hash_table (scm_from_int (57)); | |
b01532af NJ |
260 | SCM alist; |
261 | ||
b01532af | 262 | alist |
1367aa5e HWN |
263 | = scm_internal_hash_fold (&tag_table_to_type_alist, NULL, SCM_EOL, tab); |
264 | ||
265 | return alist; | |
266 | } | |
267 | #undef FUNC_NAME | |
268 | ||
c2cbcc57 | 269 | extern int scm_gc_malloc_yield_percentage; |
a00c95d9 | 270 | SCM_DEFINE (scm_gc_stats, "gc-stats", 0, 0, 0, |
1bbd0b84 | 271 | (), |
1e6808ea | 272 | "Return an association list of statistics about Guile's current\n" |
c8a1bdc4 | 273 | "use of storage.\n") |
1bbd0b84 | 274 | #define FUNC_NAME s_scm_gc_stats |
0f2d19dd | 275 | { |
0f2d19dd | 276 | SCM answer; |
915b3f9f LC |
277 | size_t heap_size, free_bytes, bytes_since_gc, total_bytes; |
278 | size_t gc_times; | |
4c9419ac | 279 | |
915b3f9f LC |
280 | heap_size = GC_get_heap_size (); |
281 | free_bytes = GC_get_free_bytes (); | |
282 | bytes_since_gc = GC_get_bytes_since_gc (); | |
283 | total_bytes = GC_get_total_bytes (); | |
284 | gc_times = GC_gc_no; | |
fca43887 | 285 | |
33b320ae NJ |
286 | /* njrev: can any of these scm_cons's or scm_list_n signal a memory |
287 | error? If so we need a frame here. */ | |
b9bd8526 | 288 | answer = |
915b3f9f LC |
289 | scm_list_n (scm_cons (sym_gc_time_taken, SCM_INUM0), |
290 | #if 0 | |
b9bd8526 MV |
291 | scm_cons (sym_cells_allocated, |
292 | scm_from_ulong (local_scm_cells_allocated)), | |
b9bd8526 MV |
293 | scm_cons (sym_mallocated, |
294 | scm_from_ulong (local_scm_mallocated)), | |
295 | scm_cons (sym_mtrigger, | |
296 | scm_from_ulong (local_scm_mtrigger)), | |
b9bd8526 MV |
297 | scm_cons (sym_gc_mark_time_taken, |
298 | scm_from_ulong (local_scm_gc_mark_time_taken)), | |
299 | scm_cons (sym_cells_marked, | |
300 | scm_from_double (local_scm_gc_cells_marked)), | |
301 | scm_cons (sym_cells_swept, | |
302 | scm_from_double (local_scm_gc_cells_swept)), | |
303 | scm_cons (sym_malloc_yield, | |
1f584400 | 304 | scm_from_long (local_scm_gc_malloc_yield_percentage)), |
b9bd8526 MV |
305 | scm_cons (sym_cell_yield, |
306 | scm_from_long (local_scm_gc_cell_yield_percentage)), | |
b9bd8526 | 307 | scm_cons (sym_heap_segments, heap_segs), |
915b3f9f LC |
308 | #endif |
309 | scm_cons (sym_heap_size, scm_from_size_t (heap_size)), | |
310 | scm_cons (sym_heap_free_size, scm_from_size_t (free_bytes)), | |
311 | scm_cons (sym_heap_total_allocated, | |
312 | scm_from_size_t (total_bytes)), | |
313 | scm_cons (sym_protected_objects, | |
314 | scm_from_ulong (protected_obj_count)), | |
315 | scm_cons (sym_times, scm_from_size_t (gc_times)), | |
b9bd8526 | 316 | SCM_UNDEFINED); |
fca43887 | 317 | |
c8a1bdc4 | 318 | return answer; |
0f2d19dd | 319 | } |
c8a1bdc4 | 320 | #undef FUNC_NAME |
0f2d19dd | 321 | |
539b08a4 | 322 | |
7f9ec18a LC |
323 | SCM_DEFINE (scm_gc_dump, "gc-dump", 0, 0, 0, |
324 | (void), | |
325 | "Dump information about the garbage collector's internal data " | |
326 | "structures and memory usage to the standard output.") | |
327 | #define FUNC_NAME s_scm_gc_dump | |
328 | { | |
329 | GC_dump (); | |
330 | ||
331 | return SCM_UNSPECIFIED; | |
332 | } | |
333 | #undef FUNC_NAME | |
334 | ||
acf4331f | 335 | |
c8a1bdc4 HWN |
336 | SCM_DEFINE (scm_object_address, "object-address", 1, 0, 0, |
337 | (SCM obj), | |
338 | "Return an integer that for the lifetime of @var{obj} is uniquely\n" | |
339 | "returned by this function for @var{obj}") | |
340 | #define FUNC_NAME s_scm_object_address | |
c68296f8 | 341 | { |
b9bd8526 | 342 | return scm_from_ulong (SCM_UNPACK (obj)); |
c68296f8 | 343 | } |
c8a1bdc4 | 344 | #undef FUNC_NAME |
c68296f8 | 345 | |
1be6b49c | 346 | |
915b3f9f LC |
347 | SCM_DEFINE (scm_gc_disable, "gc-disable", 0, 0, 0, |
348 | (), | |
349 | "Disables the garbage collector. Nested calls are permitted. " | |
350 | "GC is re-enabled once @code{gc-enable} has been called the " | |
351 | "same number of times @code{gc-disable} was called.") | |
352 | #define FUNC_NAME s_scm_gc_disable | |
353 | { | |
354 | GC_disable (); | |
355 | return SCM_UNSPECIFIED; | |
356 | } | |
357 | #undef FUNC_NAME | |
358 | ||
359 | SCM_DEFINE (scm_gc_enable, "gc-enable", 0, 0, 0, | |
360 | (), | |
361 | "Enables the garbage collector.") | |
362 | #define FUNC_NAME s_scm_gc_enable | |
363 | { | |
364 | GC_enable (); | |
365 | return SCM_UNSPECIFIED; | |
366 | } | |
367 | #undef FUNC_NAME | |
368 | ||
369 | ||
c8a1bdc4 HWN |
370 | SCM_DEFINE (scm_gc, "gc", 0, 0, 0, |
371 | (), | |
372 | "Scans all of SCM objects and reclaims for further use those that are\n" | |
373 | "no longer accessible.") | |
374 | #define FUNC_NAME s_scm_gc | |
375 | { | |
b17e0ac3 | 376 | scm_i_gc ("call"); |
c8a1bdc4 | 377 | return SCM_UNSPECIFIED; |
9d47a1e6 | 378 | } |
c8a1bdc4 | 379 | #undef FUNC_NAME |
9d47a1e6 | 380 | |
c8a1bdc4 | 381 | void |
b17e0ac3 | 382 | scm_i_gc (const char *what) |
c8a1bdc4 | 383 | { |
26224b3f | 384 | GC_gcollect (); |
eab1b259 | 385 | } |
0f2d19dd | 386 | |
4c7016dc | 387 | |
0f2d19dd JB |
388 | \f |
389 | /* {GC Protection Helper Functions} | |
390 | */ | |
391 | ||
392 | ||
5d2b97cd DH |
393 | /* |
394 | * If within a function you need to protect one or more scheme objects from | |
395 | * garbage collection, pass them as parameters to one of the | |
396 | * scm_remember_upto_here* functions below. These functions don't do | |
397 | * anything, but since the compiler does not know that they are actually | |
398 | * no-ops, it will generate code that calls these functions with the given | |
399 | * parameters. Therefore, you can be sure that the compiler will keep those | |
400 | * scheme values alive (on the stack or in a register) up to the point where | |
401 | * scm_remember_upto_here* is called. In other words, place the call to | |
592996c9 | 402 | * scm_remember_upto_here* _behind_ the last code in your function, that |
5d2b97cd DH |
403 | * depends on the scheme object to exist. |
404 | * | |
8c494e99 DH |
405 | * Example: We want to make sure that the string object str does not get |
406 | * garbage collected during the execution of 'some_function' in the code | |
407 | * below, because otherwise the characters belonging to str would be freed and | |
5d2b97cd DH |
408 | * 'some_function' might access freed memory. To make sure that the compiler |
409 | * keeps str alive on the stack or in a register such that it is visible to | |
410 | * the conservative gc we add the call to scm_remember_upto_here_1 _after_ the | |
411 | * call to 'some_function'. Note that this would not be necessary if str was | |
412 | * used anyway after the call to 'some_function'. | |
eb01cb64 | 413 | * char *chars = scm_i_string_chars (str); |
5d2b97cd DH |
414 | * some_function (chars); |
415 | * scm_remember_upto_here_1 (str); // str will be alive up to this point. | |
416 | */ | |
417 | ||
9e1569bd KR |
418 | /* Remove any macro versions of these while defining the functions. |
419 | Functions are always included in the library, for upward binary | |
420 | compatibility and in case combinations of GCC and non-GCC are used. */ | |
421 | #undef scm_remember_upto_here_1 | |
422 | #undef scm_remember_upto_here_2 | |
423 | ||
5d2b97cd | 424 | void |
e81d98ec | 425 | scm_remember_upto_here_1 (SCM obj SCM_UNUSED) |
5d2b97cd DH |
426 | { |
427 | /* Empty. Protects a single object from garbage collection. */ | |
428 | } | |
429 | ||
430 | void | |
e81d98ec | 431 | scm_remember_upto_here_2 (SCM obj1 SCM_UNUSED, SCM obj2 SCM_UNUSED) |
5d2b97cd DH |
432 | { |
433 | /* Empty. Protects two objects from garbage collection. */ | |
434 | } | |
435 | ||
436 | void | |
e81d98ec | 437 | scm_remember_upto_here (SCM obj SCM_UNUSED, ...) |
5d2b97cd DH |
438 | { |
439 | /* Empty. Protects any number of objects from garbage collection. */ | |
440 | } | |
441 | ||
c209c88e | 442 | /* |
41b0806d GB |
443 | These crazy functions prevent garbage collection |
444 | of arguments after the first argument by | |
445 | ensuring they remain live throughout the | |
446 | function because they are used in the last | |
447 | line of the code block. | |
448 | It'd be better to have a nice compiler hint to | |
449 | aid the conservative stack-scanning GC. --03/09/00 gjb */ | |
0f2d19dd JB |
450 | SCM |
451 | scm_return_first (SCM elt, ...) | |
0f2d19dd JB |
452 | { |
453 | return elt; | |
454 | } | |
455 | ||
41b0806d GB |
456 | int |
457 | scm_return_first_int (int i, ...) | |
458 | { | |
459 | return i; | |
460 | } | |
461 | ||
0f2d19dd | 462 | |
0f2d19dd | 463 | SCM |
6e8d25a6 | 464 | scm_permanent_object (SCM obj) |
0f2d19dd | 465 | { |
8e7b3e98 | 466 | return (scm_gc_protect_object (obj)); |
0f2d19dd JB |
467 | } |
468 | ||
469 | ||
7bd4fbe2 MD |
470 | /* Protect OBJ from the garbage collector. OBJ will not be freed, even if all |
471 | other references are dropped, until the object is unprotected by calling | |
6b1b030e | 472 | scm_gc_unprotect_object (OBJ). Calls to scm_gc_protect/unprotect_object nest, |
7bd4fbe2 MD |
473 | i. e. it is possible to protect the same object several times, but it is |
474 | necessary to unprotect the object the same number of times to actually get | |
475 | the object unprotected. It is an error to unprotect an object more often | |
476 | than it has been protected before. The function scm_protect_object returns | |
477 | OBJ. | |
478 | */ | |
479 | ||
480 | /* Implementation note: For every object X, there is a counter which | |
1f584400 | 481 | scm_gc_protect_object (X) increments and scm_gc_unprotect_object (X) decrements. |
7bd4fbe2 | 482 | */ |
686765af | 483 | |
7eec4c37 HWN |
484 | |
485 | ||
ef290276 | 486 | SCM |
6b1b030e | 487 | scm_gc_protect_object (SCM obj) |
ef290276 | 488 | { |
686765af | 489 | SCM handle; |
9d47a1e6 | 490 | |
686765af | 491 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae NJ |
492 | /* njrev: Indeed; if my comment above is correct, there is the same |
493 | critsec/mutex inconsistency here. */ | |
9de87eea | 494 | SCM_CRITICAL_SECTION_START; |
9d47a1e6 | 495 | |
acbccb0c | 496 | handle = scm_hashq_create_handle_x (scm_protects, obj, scm_from_int (0)); |
e11e83f3 | 497 | SCM_SETCDR (handle, scm_sum (SCM_CDR (handle), scm_from_int (1))); |
9d47a1e6 | 498 | |
7eec4c37 HWN |
499 | protected_obj_count ++; |
500 | ||
9de87eea | 501 | SCM_CRITICAL_SECTION_END; |
9d47a1e6 | 502 | |
ef290276 JB |
503 | return obj; |
504 | } | |
505 | ||
506 | ||
507 | /* Remove any protection for OBJ established by a prior call to | |
dab7f566 | 508 | scm_protect_object. This function returns OBJ. |
ef290276 | 509 | |
dab7f566 | 510 | See scm_protect_object for more information. */ |
ef290276 | 511 | SCM |
6b1b030e | 512 | scm_gc_unprotect_object (SCM obj) |
ef290276 | 513 | { |
686765af | 514 | SCM handle; |
9d47a1e6 | 515 | |
686765af | 516 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae | 517 | /* njrev: and again. */ |
9de87eea | 518 | SCM_CRITICAL_SECTION_START; |
9d47a1e6 | 519 | |
0ff7e3ff HWN |
520 | if (scm_gc_running_p) |
521 | { | |
522 | fprintf (stderr, "scm_unprotect_object called during GC.\n"); | |
523 | abort (); | |
524 | } | |
b17e0ac3 | 525 | |
acbccb0c | 526 | handle = scm_hashq_get_handle (scm_protects, obj); |
9d47a1e6 | 527 | |
7888309b | 528 | if (scm_is_false (handle)) |
686765af | 529 | { |
0f0f0899 MD |
530 | fprintf (stderr, "scm_unprotect_object called on unprotected object\n"); |
531 | abort (); | |
686765af | 532 | } |
6a199940 DH |
533 | else |
534 | { | |
e11e83f3 | 535 | SCM count = scm_difference (SCM_CDR (handle), scm_from_int (1)); |
bc36d050 | 536 | if (scm_is_eq (count, scm_from_int (0))) |
acbccb0c | 537 | scm_hashq_remove_x (scm_protects, obj); |
6a199940 | 538 | else |
1be6b49c | 539 | SCM_SETCDR (handle, count); |
6a199940 | 540 | } |
7eec4c37 | 541 | protected_obj_count --; |
686765af | 542 | |
9de87eea | 543 | SCM_CRITICAL_SECTION_END; |
ef290276 JB |
544 | |
545 | return obj; | |
546 | } | |
547 | ||
6b1b030e ML |
548 | void |
549 | scm_gc_register_root (SCM *p) | |
550 | { | |
8e7b3e98 | 551 | /* Nothing. */ |
6b1b030e ML |
552 | } |
553 | ||
554 | void | |
555 | scm_gc_unregister_root (SCM *p) | |
556 | { | |
8e7b3e98 | 557 | /* Nothing. */ |
6b1b030e ML |
558 | } |
559 | ||
560 | void | |
561 | scm_gc_register_roots (SCM *b, unsigned long n) | |
562 | { | |
563 | SCM *p = b; | |
564 | for (; p < b + n; ++p) | |
565 | scm_gc_register_root (p); | |
566 | } | |
567 | ||
568 | void | |
569 | scm_gc_unregister_roots (SCM *b, unsigned long n) | |
570 | { | |
571 | SCM *p = b; | |
572 | for (; p < b + n; ++p) | |
573 | scm_gc_unregister_root (p); | |
574 | } | |
575 | ||
ec7f624d AW |
576 | static void |
577 | scm_c_register_gc_callback (void *key, void (*func) (void *, void *), | |
578 | void *data) | |
579 | { | |
580 | if (!key) | |
581 | key = GC_MALLOC_ATOMIC (sizeof (void*)); | |
582 | ||
583 | GC_REGISTER_FINALIZER_NO_ORDER (key, func, data, NULL, NULL); | |
584 | } | |
585 | ||
586 | static void | |
587 | system_gc_callback (void *key, void *data) | |
588 | { | |
589 | scm_c_register_gc_callback (key, system_gc_callback, data); | |
590 | scm_c_hook_run (&scm_after_gc_c_hook, NULL); | |
591 | } | |
592 | ||
0f2d19dd | 593 | \f |
a00c95d9 | 594 | |
4c48ba06 | 595 | |
c8a1bdc4 HWN |
596 | /* |
597 | MOVE THIS FUNCTION. IT DOES NOT HAVE ANYTHING TODO WITH GC. | |
598 | */ | |
85db4a2c DH |
599 | |
600 | /* Get an integer from an environment variable. */ | |
c8a1bdc4 HWN |
601 | int |
602 | scm_getenv_int (const char *var, int def) | |
85db4a2c | 603 | { |
c8a1bdc4 HWN |
604 | char *end = 0; |
605 | char *val = getenv (var); | |
606 | long res = def; | |
85db4a2c DH |
607 | if (!val) |
608 | return def; | |
609 | res = strtol (val, &end, 10); | |
610 | if (end == val) | |
611 | return def; | |
612 | return res; | |
613 | } | |
614 | ||
c35738c1 MD |
615 | void |
616 | scm_storage_prehistory () | |
617 | { | |
184327a6 | 618 | GC_all_interior_pointers = 0; |
21c097e0 | 619 | GC_set_free_space_divisor (scm_getenv_int ("GC_FREE_SPACE_DIVISOR", 3)); |
184327a6 | 620 | |
a82e7953 | 621 | GC_INIT (); |
e7bca227 | 622 | |
11d2fc06 LC |
623 | #if (! ((defined GC_VERSION_MAJOR) && (GC_VERSION_MAJOR >= 7))) \ |
624 | && (defined SCM_I_GSC_USE_PTHREAD_THREADS) | |
e7bca227 LC |
625 | /* When using GC 6.8, this call is required to initialize thread-local |
626 | freelists (shouldn't be necessary with GC 7.0). */ | |
627 | GC_init (); | |
628 | #endif | |
629 | ||
fdab75a1 | 630 | GC_expand_hp (SCM_DEFAULT_INIT_HEAP_SIZE_2); |
915b3f9f | 631 | |
184327a6 LC |
632 | /* We only need to register a displacement for those types for which the |
633 | higher bits of the type tag are used to store a pointer (that is, a | |
634 | pointer to an 8-octet aligned region). For `scm_tc3_struct', this is | |
635 | handled in `scm_alloc_struct ()'. */ | |
636 | GC_REGISTER_DISPLACEMENT (scm_tc3_cons); | |
314b8716 | 637 | /* GC_REGISTER_DISPLACEMENT (scm_tc3_unused); */ |
184327a6 | 638 | |
915b3f9f | 639 | /* Sanity check. */ |
acbccb0c | 640 | if (!GC_is_visible (&scm_protects)) |
915b3f9f | 641 | abort (); |
a82e7953 | 642 | |
c35738c1 MD |
643 | scm_c_hook_init (&scm_before_gc_c_hook, 0, SCM_C_HOOK_NORMAL); |
644 | scm_c_hook_init (&scm_before_mark_c_hook, 0, SCM_C_HOOK_NORMAL); | |
645 | scm_c_hook_init (&scm_before_sweep_c_hook, 0, SCM_C_HOOK_NORMAL); | |
646 | scm_c_hook_init (&scm_after_sweep_c_hook, 0, SCM_C_HOOK_NORMAL); | |
647 | scm_c_hook_init (&scm_after_gc_c_hook, 0, SCM_C_HOOK_NORMAL); | |
ec7f624d AW |
648 | |
649 | scm_c_register_gc_callback (NULL, system_gc_callback, NULL); | |
c35738c1 | 650 | } |
85db4a2c | 651 | |
9de87eea | 652 | scm_i_pthread_mutex_t scm_i_gc_admin_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER; |
eb01cb64 | 653 | |
562cd1b8 AW |
654 | void |
655 | scm_init_gc_protect_object () | |
0f2d19dd | 656 | { |
acbccb0c | 657 | scm_protects = scm_c_make_hash_table (31); |
4a4c9785 | 658 | |
9de87eea MV |
659 | #if 0 |
660 | /* We can't have a cleanup handler since we have no thread to run it | |
661 | in. */ | |
662 | ||
a18bcd0e | 663 | #ifdef HAVE_ATEXIT |
c45acc34 | 664 | atexit (cleanup); |
e52ceaac MD |
665 | #else |
666 | #ifdef HAVE_ON_EXIT | |
667 | on_exit (cleanup, 0); | |
668 | #endif | |
9de87eea MV |
669 | #endif |
670 | ||
a18bcd0e | 671 | #endif |
0f2d19dd | 672 | } |
939794ce | 673 | |
0f2d19dd JB |
674 | \f |
675 | ||
939794ce DH |
676 | SCM scm_after_gc_hook; |
677 | ||
939794ce DH |
678 | static SCM gc_async; |
679 | ||
939794ce DH |
680 | /* The function gc_async_thunk causes the execution of the after-gc-hook. It |
681 | * is run after the gc, as soon as the asynchronous events are handled by the | |
682 | * evaluator. | |
683 | */ | |
684 | static SCM | |
685 | gc_async_thunk (void) | |
686 | { | |
687 | scm_c_run_hook (scm_after_gc_hook, SCM_EOL); | |
939794ce DH |
688 | return SCM_UNSPECIFIED; |
689 | } | |
690 | ||
691 | ||
692 | /* The function mark_gc_async is run by the scm_after_gc_c_hook at the end of | |
693 | * the garbage collection. The only purpose of this function is to mark the | |
694 | * gc_async (which will eventually lead to the execution of the | |
695 | * gc_async_thunk). | |
696 | */ | |
697 | static void * | |
e81d98ec | 698 | mark_gc_async (void * hook_data SCM_UNUSED, |
5c004b6d | 699 | void *fn_data SCM_UNUSED, |
e81d98ec DH |
700 | void *data SCM_UNUSED) |
701 | { | |
702 | /* If cell access debugging is enabled, the user may choose to perform | |
703 | * additional garbage collections after an arbitrary number of cell | |
704 | * accesses. We don't want the scheme level after-gc-hook to be performed | |
705 | * for each of these garbage collections for the following reason: The | |
706 | * execution of the after-gc-hook causes cell accesses itself. Thus, if the | |
707 | * after-gc-hook was performed with every gc, and if the gc was performed | |
708 | * after a very small number of cell accesses, then the number of cell | |
709 | * accesses during the execution of the after-gc-hook will suffice to cause | |
710 | * the execution of the next gc. Then, guile would keep executing the | |
711 | * after-gc-hook over and over again, and would never come to do other | |
712 | * things. | |
eae33935 | 713 | * |
e81d98ec DH |
714 | * To overcome this problem, if cell access debugging with additional |
715 | * garbage collections is enabled, the after-gc-hook is never run by the | |
716 | * garbage collecter. When running guile with cell access debugging and the | |
717 | * execution of the after-gc-hook is desired, then it is necessary to run | |
718 | * the hook explicitly from the user code. This has the effect, that from | |
719 | * the scheme level point of view it seems that garbage collection is | |
720 | * performed with a much lower frequency than it actually is. Obviously, | |
721 | * this will not work for code that depends on a fixed one to one | |
722 | * relationship between the execution counts of the C level garbage | |
723 | * collection hooks and the execution count of the scheme level | |
724 | * after-gc-hook. | |
725 | */ | |
9de87eea | 726 | |
e81d98ec | 727 | #if (SCM_DEBUG_CELL_ACCESSES == 1) |
eab1b259 | 728 | if (scm_debug_cells_gc_interval == 0) |
e81d98ec DH |
729 | scm_system_async_mark (gc_async); |
730 | #else | |
939794ce | 731 | scm_system_async_mark (gc_async); |
e81d98ec DH |
732 | #endif |
733 | ||
939794ce DH |
734 | return NULL; |
735 | } | |
736 | ||
26224b3f LC |
737 | char const * |
738 | scm_i_tag_name (scm_t_bits tag) | |
739 | { | |
740 | if (tag >= 255) | |
741 | { | |
f86f3b5b LC |
742 | int k = 0xff & (tag >> 8); |
743 | return (scm_smobs[k].name); | |
26224b3f | 744 | } |
f86f3b5b | 745 | |
26224b3f LC |
746 | switch (tag) /* 7 bits */ |
747 | { | |
748 | case scm_tcs_struct: | |
749 | return "struct"; | |
750 | case scm_tcs_cons_imcar: | |
751 | return "cons (immediate car)"; | |
752 | case scm_tcs_cons_nimcar: | |
753 | return "cons (non-immediate car)"; | |
5b46a8c2 | 754 | case scm_tc7_pointer: |
e2c2a699 | 755 | return "foreign"; |
c99de5aa AW |
756 | case scm_tc7_hashtable: |
757 | return "hashtable"; | |
9ea31741 AW |
758 | case scm_tc7_fluid: |
759 | return "fluid"; | |
760 | case scm_tc7_dynamic_state: | |
761 | return "dynamic state"; | |
6f3b0cc2 AW |
762 | case scm_tc7_frame: |
763 | return "frame"; | |
764 | case scm_tc7_objcode: | |
765 | return "objcode"; | |
766 | case scm_tc7_vm: | |
767 | return "vm"; | |
768 | case scm_tc7_vm_cont: | |
769 | return "vm continuation"; | |
26224b3f LC |
770 | case scm_tc7_wvect: |
771 | return "weak vector"; | |
772 | case scm_tc7_vector: | |
773 | return "vector"; | |
26224b3f LC |
774 | case scm_tc7_number: |
775 | switch (tag) | |
776 | { | |
777 | case scm_tc16_real: | |
778 | return "real"; | |
779 | break; | |
780 | case scm_tc16_big: | |
781 | return "bignum"; | |
782 | break; | |
783 | case scm_tc16_complex: | |
784 | return "complex number"; | |
785 | break; | |
786 | case scm_tc16_fraction: | |
787 | return "fraction"; | |
788 | break; | |
789 | } | |
790 | break; | |
791 | case scm_tc7_string: | |
792 | return "string"; | |
793 | break; | |
794 | case scm_tc7_stringbuf: | |
795 | return "string buffer"; | |
796 | break; | |
797 | case scm_tc7_symbol: | |
798 | return "symbol"; | |
799 | break; | |
800 | case scm_tc7_variable: | |
801 | return "variable"; | |
802 | break; | |
26224b3f LC |
803 | case scm_tc7_port: |
804 | return "port"; | |
805 | break; | |
806 | case scm_tc7_smob: | |
807 | return "smob"; /* should not occur. */ | |
808 | break; | |
809 | } | |
810 | ||
811 | return NULL; | |
812 | } | |
813 | ||
814 | ||
26224b3f LC |
815 | |
816 | \f | |
0f2d19dd JB |
817 | void |
818 | scm_init_gc () | |
0f2d19dd | 819 | { |
a82e7953 | 820 | /* `GC_INIT ()' was invoked in `scm_storage_prehistory ()'. */ |
d678e25c | 821 | |
f39448c5 | 822 | scm_after_gc_hook = scm_make_hook (SCM_INUM0); |
fde50407 | 823 | scm_c_define ("after-gc-hook", scm_after_gc_hook); |
939794ce | 824 | |
df9ca8d8 | 825 | gc_async = scm_c_make_gsubr ("%gc-thunk", 0, 0, 0, gc_async_thunk); |
939794ce DH |
826 | |
827 | scm_c_hook_add (&scm_after_gc_c_hook, mark_gc_async, NULL, 0); | |
828 | ||
a0599745 | 829 | #include "libguile/gc.x" |
0f2d19dd | 830 | } |
89e00824 | 831 | |
c8a1bdc4 HWN |
832 | |
833 | void | |
834 | scm_gc_sweep (void) | |
835 | #define FUNC_NAME "scm_gc_sweep" | |
836 | { | |
26224b3f | 837 | /* FIXME */ |
cd169c5a | 838 | fprintf (stderr, "%s: doing nothing\n", FUNC_NAME); |
c8a1bdc4 | 839 | } |
c8a1bdc4 HWN |
840 | #undef FUNC_NAME |
841 | ||
89e00824 ML |
842 | /* |
843 | Local Variables: | |
844 | c-file-style: "gnu" | |
845 | End: | |
846 | */ |