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 | 204 | |
17ab1dc3 | 205 | SCM_SYMBOL (sym_gc_time_taken, "gc-time-taken"); |
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"); | |
17ab1dc3 | 209 | SCM_SYMBOL (sym_heap_allocated_since_gc, "heap-allocated-since-gc"); |
7eec4c37 | 210 | SCM_SYMBOL (sym_protected_objects, "protected-objects"); |
17ab1dc3 | 211 | SCM_SYMBOL (sym_times, "gc-times"); |
cf2d30f6 | 212 | |
d3dd80ab | 213 | |
cf2d30f6 | 214 | /* Number of calls to SCM_NEWCELL since startup. */ |
c8a1bdc4 HWN |
215 | unsigned scm_newcell_count; |
216 | unsigned scm_newcell2_count; | |
b37fe1c5 | 217 | |
b37fe1c5 | 218 | |
0f2d19dd JB |
219 | /* {Scheme Interface to GC} |
220 | */ | |
1367aa5e HWN |
221 | static SCM |
222 | tag_table_to_type_alist (void *closure, SCM key, SCM val, SCM acc) | |
223 | { | |
8fecbb19 | 224 | if (scm_is_integer (key)) |
8a00ba71 | 225 | { |
3e2073bd | 226 | int c_tag = scm_to_int (key); |
8fecbb19 HWN |
227 | |
228 | char const * name = scm_i_tag_name (c_tag); | |
229 | if (name != NULL) | |
230 | { | |
231 | key = scm_from_locale_string (name); | |
232 | } | |
233 | else | |
234 | { | |
235 | char s[100]; | |
236 | sprintf (s, "tag %d", c_tag); | |
237 | key = scm_from_locale_string (s); | |
238 | } | |
8a00ba71 | 239 | } |
8fecbb19 | 240 | |
1367aa5e HWN |
241 | return scm_cons (scm_cons (key, val), acc); |
242 | } | |
243 | ||
244 | SCM_DEFINE (scm_gc_live_object_stats, "gc-live-object-stats", 0, 0, 0, | |
245 | (), | |
246 | "Return an alist of statistics of the current live objects. ") | |
247 | #define FUNC_NAME s_scm_gc_live_object_stats | |
248 | { | |
249 | SCM tab = scm_make_hash_table (scm_from_int (57)); | |
b01532af NJ |
250 | SCM alist; |
251 | ||
b01532af | 252 | alist |
1367aa5e HWN |
253 | = scm_internal_hash_fold (&tag_table_to_type_alist, NULL, SCM_EOL, tab); |
254 | ||
255 | return alist; | |
256 | } | |
257 | #undef FUNC_NAME | |
258 | ||
c2cbcc57 | 259 | extern int scm_gc_malloc_yield_percentage; |
a00c95d9 | 260 | SCM_DEFINE (scm_gc_stats, "gc-stats", 0, 0, 0, |
1bbd0b84 | 261 | (), |
1e6808ea | 262 | "Return an association list of statistics about Guile's current\n" |
c8a1bdc4 | 263 | "use of storage.\n") |
1bbd0b84 | 264 | #define FUNC_NAME s_scm_gc_stats |
0f2d19dd | 265 | { |
0f2d19dd | 266 | SCM answer; |
915b3f9f LC |
267 | size_t heap_size, free_bytes, bytes_since_gc, total_bytes; |
268 | size_t gc_times; | |
4c9419ac | 269 | |
915b3f9f LC |
270 | heap_size = GC_get_heap_size (); |
271 | free_bytes = GC_get_free_bytes (); | |
272 | bytes_since_gc = GC_get_bytes_since_gc (); | |
273 | total_bytes = GC_get_total_bytes (); | |
274 | gc_times = GC_gc_no; | |
fca43887 | 275 | |
b9bd8526 | 276 | answer = |
915b3f9f | 277 | scm_list_n (scm_cons (sym_gc_time_taken, SCM_INUM0), |
915b3f9f LC |
278 | scm_cons (sym_heap_size, scm_from_size_t (heap_size)), |
279 | scm_cons (sym_heap_free_size, scm_from_size_t (free_bytes)), | |
280 | scm_cons (sym_heap_total_allocated, | |
281 | scm_from_size_t (total_bytes)), | |
17ab1dc3 AW |
282 | scm_cons (sym_heap_allocated_since_gc, |
283 | scm_from_size_t (bytes_since_gc)), | |
915b3f9f LC |
284 | scm_cons (sym_protected_objects, |
285 | scm_from_ulong (protected_obj_count)), | |
286 | scm_cons (sym_times, scm_from_size_t (gc_times)), | |
b9bd8526 | 287 | SCM_UNDEFINED); |
fca43887 | 288 | |
c8a1bdc4 | 289 | return answer; |
0f2d19dd | 290 | } |
c8a1bdc4 | 291 | #undef FUNC_NAME |
0f2d19dd | 292 | |
539b08a4 | 293 | |
7f9ec18a LC |
294 | SCM_DEFINE (scm_gc_dump, "gc-dump", 0, 0, 0, |
295 | (void), | |
296 | "Dump information about the garbage collector's internal data " | |
297 | "structures and memory usage to the standard output.") | |
298 | #define FUNC_NAME s_scm_gc_dump | |
299 | { | |
300 | GC_dump (); | |
301 | ||
302 | return SCM_UNSPECIFIED; | |
303 | } | |
304 | #undef FUNC_NAME | |
305 | ||
acf4331f | 306 | |
c8a1bdc4 HWN |
307 | SCM_DEFINE (scm_object_address, "object-address", 1, 0, 0, |
308 | (SCM obj), | |
309 | "Return an integer that for the lifetime of @var{obj} is uniquely\n" | |
310 | "returned by this function for @var{obj}") | |
311 | #define FUNC_NAME s_scm_object_address | |
c68296f8 | 312 | { |
b9bd8526 | 313 | return scm_from_ulong (SCM_UNPACK (obj)); |
c68296f8 | 314 | } |
c8a1bdc4 | 315 | #undef FUNC_NAME |
c68296f8 | 316 | |
1be6b49c | 317 | |
915b3f9f LC |
318 | SCM_DEFINE (scm_gc_disable, "gc-disable", 0, 0, 0, |
319 | (), | |
320 | "Disables the garbage collector. Nested calls are permitted. " | |
321 | "GC is re-enabled once @code{gc-enable} has been called the " | |
322 | "same number of times @code{gc-disable} was called.") | |
323 | #define FUNC_NAME s_scm_gc_disable | |
324 | { | |
325 | GC_disable (); | |
326 | return SCM_UNSPECIFIED; | |
327 | } | |
328 | #undef FUNC_NAME | |
329 | ||
330 | SCM_DEFINE (scm_gc_enable, "gc-enable", 0, 0, 0, | |
331 | (), | |
332 | "Enables the garbage collector.") | |
333 | #define FUNC_NAME s_scm_gc_enable | |
334 | { | |
335 | GC_enable (); | |
336 | return SCM_UNSPECIFIED; | |
337 | } | |
338 | #undef FUNC_NAME | |
339 | ||
340 | ||
c8a1bdc4 HWN |
341 | SCM_DEFINE (scm_gc, "gc", 0, 0, 0, |
342 | (), | |
343 | "Scans all of SCM objects and reclaims for further use those that are\n" | |
344 | "no longer accessible.") | |
345 | #define FUNC_NAME s_scm_gc | |
346 | { | |
b17e0ac3 | 347 | scm_i_gc ("call"); |
c8a1bdc4 | 348 | return SCM_UNSPECIFIED; |
9d47a1e6 | 349 | } |
c8a1bdc4 | 350 | #undef FUNC_NAME |
9d47a1e6 | 351 | |
c8a1bdc4 | 352 | void |
b17e0ac3 | 353 | scm_i_gc (const char *what) |
c8a1bdc4 | 354 | { |
26224b3f | 355 | GC_gcollect (); |
eab1b259 | 356 | } |
0f2d19dd | 357 | |
4c7016dc | 358 | |
0f2d19dd JB |
359 | \f |
360 | /* {GC Protection Helper Functions} | |
361 | */ | |
362 | ||
363 | ||
5d2b97cd DH |
364 | /* |
365 | * If within a function you need to protect one or more scheme objects from | |
366 | * garbage collection, pass them as parameters to one of the | |
367 | * scm_remember_upto_here* functions below. These functions don't do | |
368 | * anything, but since the compiler does not know that they are actually | |
369 | * no-ops, it will generate code that calls these functions with the given | |
370 | * parameters. Therefore, you can be sure that the compiler will keep those | |
371 | * scheme values alive (on the stack or in a register) up to the point where | |
372 | * scm_remember_upto_here* is called. In other words, place the call to | |
592996c9 | 373 | * scm_remember_upto_here* _behind_ the last code in your function, that |
5d2b97cd DH |
374 | * depends on the scheme object to exist. |
375 | * | |
8c494e99 DH |
376 | * Example: We want to make sure that the string object str does not get |
377 | * garbage collected during the execution of 'some_function' in the code | |
378 | * below, because otherwise the characters belonging to str would be freed and | |
5d2b97cd DH |
379 | * 'some_function' might access freed memory. To make sure that the compiler |
380 | * keeps str alive on the stack or in a register such that it is visible to | |
381 | * the conservative gc we add the call to scm_remember_upto_here_1 _after_ the | |
382 | * call to 'some_function'. Note that this would not be necessary if str was | |
383 | * used anyway after the call to 'some_function'. | |
eb01cb64 | 384 | * char *chars = scm_i_string_chars (str); |
5d2b97cd DH |
385 | * some_function (chars); |
386 | * scm_remember_upto_here_1 (str); // str will be alive up to this point. | |
387 | */ | |
388 | ||
9e1569bd KR |
389 | /* Remove any macro versions of these while defining the functions. |
390 | Functions are always included in the library, for upward binary | |
391 | compatibility and in case combinations of GCC and non-GCC are used. */ | |
392 | #undef scm_remember_upto_here_1 | |
393 | #undef scm_remember_upto_here_2 | |
394 | ||
5d2b97cd | 395 | void |
e81d98ec | 396 | scm_remember_upto_here_1 (SCM obj SCM_UNUSED) |
5d2b97cd DH |
397 | { |
398 | /* Empty. Protects a single object from garbage collection. */ | |
399 | } | |
400 | ||
401 | void | |
e81d98ec | 402 | scm_remember_upto_here_2 (SCM obj1 SCM_UNUSED, SCM obj2 SCM_UNUSED) |
5d2b97cd DH |
403 | { |
404 | /* Empty. Protects two objects from garbage collection. */ | |
405 | } | |
406 | ||
407 | void | |
e81d98ec | 408 | scm_remember_upto_here (SCM obj SCM_UNUSED, ...) |
5d2b97cd DH |
409 | { |
410 | /* Empty. Protects any number of objects from garbage collection. */ | |
411 | } | |
412 | ||
c209c88e | 413 | /* |
41b0806d GB |
414 | These crazy functions prevent garbage collection |
415 | of arguments after the first argument by | |
416 | ensuring they remain live throughout the | |
417 | function because they are used in the last | |
418 | line of the code block. | |
419 | It'd be better to have a nice compiler hint to | |
420 | aid the conservative stack-scanning GC. --03/09/00 gjb */ | |
0f2d19dd JB |
421 | SCM |
422 | scm_return_first (SCM elt, ...) | |
0f2d19dd JB |
423 | { |
424 | return elt; | |
425 | } | |
426 | ||
41b0806d GB |
427 | int |
428 | scm_return_first_int (int i, ...) | |
429 | { | |
430 | return i; | |
431 | } | |
432 | ||
0f2d19dd | 433 | |
0f2d19dd | 434 | SCM |
6e8d25a6 | 435 | scm_permanent_object (SCM obj) |
0f2d19dd | 436 | { |
8e7b3e98 | 437 | return (scm_gc_protect_object (obj)); |
0f2d19dd JB |
438 | } |
439 | ||
440 | ||
7bd4fbe2 MD |
441 | /* Protect OBJ from the garbage collector. OBJ will not be freed, even if all |
442 | other references are dropped, until the object is unprotected by calling | |
6b1b030e | 443 | scm_gc_unprotect_object (OBJ). Calls to scm_gc_protect/unprotect_object nest, |
7bd4fbe2 MD |
444 | i. e. it is possible to protect the same object several times, but it is |
445 | necessary to unprotect the object the same number of times to actually get | |
446 | the object unprotected. It is an error to unprotect an object more often | |
447 | than it has been protected before. The function scm_protect_object returns | |
448 | OBJ. | |
449 | */ | |
450 | ||
451 | /* Implementation note: For every object X, there is a counter which | |
1f584400 | 452 | scm_gc_protect_object (X) increments and scm_gc_unprotect_object (X) decrements. |
7bd4fbe2 | 453 | */ |
686765af | 454 | |
7eec4c37 HWN |
455 | |
456 | ||
ef290276 | 457 | SCM |
6b1b030e | 458 | scm_gc_protect_object (SCM obj) |
ef290276 | 459 | { |
686765af | 460 | SCM handle; |
9d47a1e6 | 461 | |
686765af | 462 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae NJ |
463 | /* njrev: Indeed; if my comment above is correct, there is the same |
464 | critsec/mutex inconsistency here. */ | |
9de87eea | 465 | SCM_CRITICAL_SECTION_START; |
9d47a1e6 | 466 | |
acbccb0c | 467 | handle = scm_hashq_create_handle_x (scm_protects, obj, scm_from_int (0)); |
e11e83f3 | 468 | SCM_SETCDR (handle, scm_sum (SCM_CDR (handle), scm_from_int (1))); |
9d47a1e6 | 469 | |
7eec4c37 HWN |
470 | protected_obj_count ++; |
471 | ||
9de87eea | 472 | SCM_CRITICAL_SECTION_END; |
9d47a1e6 | 473 | |
ef290276 JB |
474 | return obj; |
475 | } | |
476 | ||
477 | ||
478 | /* Remove any protection for OBJ established by a prior call to | |
dab7f566 | 479 | scm_protect_object. This function returns OBJ. |
ef290276 | 480 | |
dab7f566 | 481 | See scm_protect_object for more information. */ |
ef290276 | 482 | SCM |
6b1b030e | 483 | scm_gc_unprotect_object (SCM obj) |
ef290276 | 484 | { |
686765af | 485 | SCM handle; |
9d47a1e6 | 486 | |
686765af | 487 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae | 488 | /* njrev: and again. */ |
9de87eea | 489 | SCM_CRITICAL_SECTION_START; |
9d47a1e6 | 490 | |
0ff7e3ff HWN |
491 | if (scm_gc_running_p) |
492 | { | |
493 | fprintf (stderr, "scm_unprotect_object called during GC.\n"); | |
494 | abort (); | |
495 | } | |
b17e0ac3 | 496 | |
acbccb0c | 497 | handle = scm_hashq_get_handle (scm_protects, obj); |
9d47a1e6 | 498 | |
7888309b | 499 | if (scm_is_false (handle)) |
686765af | 500 | { |
0f0f0899 MD |
501 | fprintf (stderr, "scm_unprotect_object called on unprotected object\n"); |
502 | abort (); | |
686765af | 503 | } |
6a199940 DH |
504 | else |
505 | { | |
e11e83f3 | 506 | SCM count = scm_difference (SCM_CDR (handle), scm_from_int (1)); |
bc36d050 | 507 | if (scm_is_eq (count, scm_from_int (0))) |
acbccb0c | 508 | scm_hashq_remove_x (scm_protects, obj); |
6a199940 | 509 | else |
1be6b49c | 510 | SCM_SETCDR (handle, count); |
6a199940 | 511 | } |
7eec4c37 | 512 | protected_obj_count --; |
686765af | 513 | |
9de87eea | 514 | SCM_CRITICAL_SECTION_END; |
ef290276 JB |
515 | |
516 | return obj; | |
517 | } | |
518 | ||
6b1b030e ML |
519 | void |
520 | scm_gc_register_root (SCM *p) | |
521 | { | |
8e7b3e98 | 522 | /* Nothing. */ |
6b1b030e ML |
523 | } |
524 | ||
525 | void | |
526 | scm_gc_unregister_root (SCM *p) | |
527 | { | |
8e7b3e98 | 528 | /* Nothing. */ |
6b1b030e ML |
529 | } |
530 | ||
531 | void | |
532 | scm_gc_register_roots (SCM *b, unsigned long n) | |
533 | { | |
534 | SCM *p = b; | |
535 | for (; p < b + n; ++p) | |
536 | scm_gc_register_root (p); | |
537 | } | |
538 | ||
539 | void | |
540 | scm_gc_unregister_roots (SCM *b, unsigned long n) | |
541 | { | |
542 | SCM *p = b; | |
543 | for (; p < b + n; ++p) | |
544 | scm_gc_unregister_root (p); | |
545 | } | |
546 | ||
ec7f624d AW |
547 | static void |
548 | scm_c_register_gc_callback (void *key, void (*func) (void *, void *), | |
549 | void *data) | |
550 | { | |
551 | if (!key) | |
552 | key = GC_MALLOC_ATOMIC (sizeof (void*)); | |
553 | ||
554 | GC_REGISTER_FINALIZER_NO_ORDER (key, func, data, NULL, NULL); | |
555 | } | |
556 | ||
557 | static void | |
558 | system_gc_callback (void *key, void *data) | |
559 | { | |
560 | scm_c_register_gc_callback (key, system_gc_callback, data); | |
561 | scm_c_hook_run (&scm_after_gc_c_hook, NULL); | |
562 | } | |
563 | ||
0f2d19dd | 564 | \f |
a00c95d9 | 565 | |
4c48ba06 | 566 | |
c8a1bdc4 HWN |
567 | /* |
568 | MOVE THIS FUNCTION. IT DOES NOT HAVE ANYTHING TODO WITH GC. | |
569 | */ | |
85db4a2c DH |
570 | |
571 | /* Get an integer from an environment variable. */ | |
c8a1bdc4 HWN |
572 | int |
573 | scm_getenv_int (const char *var, int def) | |
85db4a2c | 574 | { |
c8a1bdc4 HWN |
575 | char *end = 0; |
576 | char *val = getenv (var); | |
577 | long res = def; | |
85db4a2c DH |
578 | if (!val) |
579 | return def; | |
580 | res = strtol (val, &end, 10); | |
581 | if (end == val) | |
582 | return def; | |
583 | return res; | |
584 | } | |
585 | ||
c35738c1 MD |
586 | void |
587 | scm_storage_prehistory () | |
588 | { | |
184327a6 | 589 | GC_all_interior_pointers = 0; |
21c097e0 | 590 | GC_set_free_space_divisor (scm_getenv_int ("GC_FREE_SPACE_DIVISOR", 3)); |
184327a6 | 591 | |
a82e7953 | 592 | GC_INIT (); |
e7bca227 | 593 | |
11d2fc06 LC |
594 | #if (! ((defined GC_VERSION_MAJOR) && (GC_VERSION_MAJOR >= 7))) \ |
595 | && (defined SCM_I_GSC_USE_PTHREAD_THREADS) | |
e7bca227 LC |
596 | /* When using GC 6.8, this call is required to initialize thread-local |
597 | freelists (shouldn't be necessary with GC 7.0). */ | |
598 | GC_init (); | |
599 | #endif | |
600 | ||
fdab75a1 | 601 | GC_expand_hp (SCM_DEFAULT_INIT_HEAP_SIZE_2); |
915b3f9f | 602 | |
184327a6 LC |
603 | /* We only need to register a displacement for those types for which the |
604 | higher bits of the type tag are used to store a pointer (that is, a | |
605 | pointer to an 8-octet aligned region). For `scm_tc3_struct', this is | |
606 | handled in `scm_alloc_struct ()'. */ | |
607 | GC_REGISTER_DISPLACEMENT (scm_tc3_cons); | |
314b8716 | 608 | /* GC_REGISTER_DISPLACEMENT (scm_tc3_unused); */ |
184327a6 | 609 | |
915b3f9f | 610 | /* Sanity check. */ |
acbccb0c | 611 | if (!GC_is_visible (&scm_protects)) |
915b3f9f | 612 | abort (); |
a82e7953 | 613 | |
c35738c1 MD |
614 | scm_c_hook_init (&scm_before_gc_c_hook, 0, SCM_C_HOOK_NORMAL); |
615 | scm_c_hook_init (&scm_before_mark_c_hook, 0, SCM_C_HOOK_NORMAL); | |
616 | scm_c_hook_init (&scm_before_sweep_c_hook, 0, SCM_C_HOOK_NORMAL); | |
617 | scm_c_hook_init (&scm_after_sweep_c_hook, 0, SCM_C_HOOK_NORMAL); | |
618 | scm_c_hook_init (&scm_after_gc_c_hook, 0, SCM_C_HOOK_NORMAL); | |
ec7f624d AW |
619 | |
620 | scm_c_register_gc_callback (NULL, system_gc_callback, NULL); | |
c35738c1 | 621 | } |
85db4a2c | 622 | |
9de87eea | 623 | scm_i_pthread_mutex_t scm_i_gc_admin_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER; |
eb01cb64 | 624 | |
562cd1b8 AW |
625 | void |
626 | scm_init_gc_protect_object () | |
0f2d19dd | 627 | { |
acbccb0c | 628 | scm_protects = scm_c_make_hash_table (31); |
4a4c9785 | 629 | |
9de87eea MV |
630 | #if 0 |
631 | /* We can't have a cleanup handler since we have no thread to run it | |
632 | in. */ | |
633 | ||
a18bcd0e | 634 | #ifdef HAVE_ATEXIT |
c45acc34 | 635 | atexit (cleanup); |
e52ceaac MD |
636 | #else |
637 | #ifdef HAVE_ON_EXIT | |
638 | on_exit (cleanup, 0); | |
639 | #endif | |
9de87eea MV |
640 | #endif |
641 | ||
a18bcd0e | 642 | #endif |
0f2d19dd | 643 | } |
939794ce | 644 | |
0f2d19dd JB |
645 | \f |
646 | ||
939794ce DH |
647 | SCM scm_after_gc_hook; |
648 | ||
939794ce DH |
649 | static SCM gc_async; |
650 | ||
939794ce DH |
651 | /* The function gc_async_thunk causes the execution of the after-gc-hook. It |
652 | * is run after the gc, as soon as the asynchronous events are handled by the | |
653 | * evaluator. | |
654 | */ | |
655 | static SCM | |
656 | gc_async_thunk (void) | |
657 | { | |
658 | scm_c_run_hook (scm_after_gc_hook, SCM_EOL); | |
939794ce DH |
659 | return SCM_UNSPECIFIED; |
660 | } | |
661 | ||
662 | ||
663 | /* The function mark_gc_async is run by the scm_after_gc_c_hook at the end of | |
664 | * the garbage collection. The only purpose of this function is to mark the | |
665 | * gc_async (which will eventually lead to the execution of the | |
666 | * gc_async_thunk). | |
667 | */ | |
668 | static void * | |
e81d98ec | 669 | mark_gc_async (void * hook_data SCM_UNUSED, |
5c004b6d | 670 | void *fn_data SCM_UNUSED, |
e81d98ec DH |
671 | void *data SCM_UNUSED) |
672 | { | |
673 | /* If cell access debugging is enabled, the user may choose to perform | |
674 | * additional garbage collections after an arbitrary number of cell | |
675 | * accesses. We don't want the scheme level after-gc-hook to be performed | |
676 | * for each of these garbage collections for the following reason: The | |
677 | * execution of the after-gc-hook causes cell accesses itself. Thus, if the | |
678 | * after-gc-hook was performed with every gc, and if the gc was performed | |
679 | * after a very small number of cell accesses, then the number of cell | |
680 | * accesses during the execution of the after-gc-hook will suffice to cause | |
681 | * the execution of the next gc. Then, guile would keep executing the | |
682 | * after-gc-hook over and over again, and would never come to do other | |
683 | * things. | |
eae33935 | 684 | * |
e81d98ec DH |
685 | * To overcome this problem, if cell access debugging with additional |
686 | * garbage collections is enabled, the after-gc-hook is never run by the | |
687 | * garbage collecter. When running guile with cell access debugging and the | |
688 | * execution of the after-gc-hook is desired, then it is necessary to run | |
689 | * the hook explicitly from the user code. This has the effect, that from | |
690 | * the scheme level point of view it seems that garbage collection is | |
691 | * performed with a much lower frequency than it actually is. Obviously, | |
692 | * this will not work for code that depends on a fixed one to one | |
693 | * relationship between the execution counts of the C level garbage | |
694 | * collection hooks and the execution count of the scheme level | |
695 | * after-gc-hook. | |
696 | */ | |
9de87eea | 697 | |
e81d98ec | 698 | #if (SCM_DEBUG_CELL_ACCESSES == 1) |
eab1b259 | 699 | if (scm_debug_cells_gc_interval == 0) |
e81d98ec DH |
700 | scm_system_async_mark (gc_async); |
701 | #else | |
939794ce | 702 | scm_system_async_mark (gc_async); |
e81d98ec DH |
703 | #endif |
704 | ||
939794ce DH |
705 | return NULL; |
706 | } | |
707 | ||
26224b3f LC |
708 | char const * |
709 | scm_i_tag_name (scm_t_bits tag) | |
710 | { | |
711 | if (tag >= 255) | |
712 | { | |
f86f3b5b LC |
713 | int k = 0xff & (tag >> 8); |
714 | return (scm_smobs[k].name); | |
26224b3f | 715 | } |
f86f3b5b | 716 | |
26224b3f LC |
717 | switch (tag) /* 7 bits */ |
718 | { | |
719 | case scm_tcs_struct: | |
720 | return "struct"; | |
721 | case scm_tcs_cons_imcar: | |
722 | return "cons (immediate car)"; | |
723 | case scm_tcs_cons_nimcar: | |
724 | return "cons (non-immediate car)"; | |
5b46a8c2 | 725 | case scm_tc7_pointer: |
e2c2a699 | 726 | return "foreign"; |
c99de5aa AW |
727 | case scm_tc7_hashtable: |
728 | return "hashtable"; | |
9ea31741 AW |
729 | case scm_tc7_fluid: |
730 | return "fluid"; | |
731 | case scm_tc7_dynamic_state: | |
732 | return "dynamic state"; | |
6f3b0cc2 AW |
733 | case scm_tc7_frame: |
734 | return "frame"; | |
735 | case scm_tc7_objcode: | |
736 | return "objcode"; | |
737 | case scm_tc7_vm: | |
738 | return "vm"; | |
739 | case scm_tc7_vm_cont: | |
740 | return "vm continuation"; | |
26224b3f LC |
741 | case scm_tc7_wvect: |
742 | return "weak vector"; | |
743 | case scm_tc7_vector: | |
744 | return "vector"; | |
26224b3f LC |
745 | case scm_tc7_number: |
746 | switch (tag) | |
747 | { | |
748 | case scm_tc16_real: | |
749 | return "real"; | |
750 | break; | |
751 | case scm_tc16_big: | |
752 | return "bignum"; | |
753 | break; | |
754 | case scm_tc16_complex: | |
755 | return "complex number"; | |
756 | break; | |
757 | case scm_tc16_fraction: | |
758 | return "fraction"; | |
759 | break; | |
760 | } | |
761 | break; | |
762 | case scm_tc7_string: | |
763 | return "string"; | |
764 | break; | |
765 | case scm_tc7_stringbuf: | |
766 | return "string buffer"; | |
767 | break; | |
768 | case scm_tc7_symbol: | |
769 | return "symbol"; | |
770 | break; | |
771 | case scm_tc7_variable: | |
772 | return "variable"; | |
773 | break; | |
26224b3f LC |
774 | case scm_tc7_port: |
775 | return "port"; | |
776 | break; | |
777 | case scm_tc7_smob: | |
778 | return "smob"; /* should not occur. */ | |
779 | break; | |
780 | } | |
781 | ||
782 | return NULL; | |
783 | } | |
784 | ||
785 | ||
26224b3f LC |
786 | |
787 | \f | |
0f2d19dd JB |
788 | void |
789 | scm_init_gc () | |
0f2d19dd | 790 | { |
a82e7953 | 791 | /* `GC_INIT ()' was invoked in `scm_storage_prehistory ()'. */ |
d678e25c | 792 | |
f39448c5 | 793 | scm_after_gc_hook = scm_make_hook (SCM_INUM0); |
fde50407 | 794 | scm_c_define ("after-gc-hook", scm_after_gc_hook); |
939794ce | 795 | |
df9ca8d8 | 796 | gc_async = scm_c_make_gsubr ("%gc-thunk", 0, 0, 0, gc_async_thunk); |
939794ce DH |
797 | |
798 | scm_c_hook_add (&scm_after_gc_c_hook, mark_gc_async, NULL, 0); | |
799 | ||
a0599745 | 800 | #include "libguile/gc.x" |
0f2d19dd | 801 | } |
89e00824 | 802 | |
c8a1bdc4 HWN |
803 | |
804 | void | |
805 | scm_gc_sweep (void) | |
806 | #define FUNC_NAME "scm_gc_sweep" | |
807 | { | |
26224b3f | 808 | /* FIXME */ |
cd169c5a | 809 | fprintf (stderr, "%s: doing nothing\n", FUNC_NAME); |
c8a1bdc4 | 810 | } |
c8a1bdc4 HWN |
811 | #undef FUNC_NAME |
812 | ||
89e00824 ML |
813 | /* |
814 | Local Variables: | |
815 | c-file-style: "gnu" | |
816 | End: | |
817 | */ |