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