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