Commit | Line | Data |
---|---|---|
c35738c1 | 1 | /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003 Free Software Foundation, Inc. |
a00c95d9 | 2 | * |
73be1d9e MV |
3 | * This library is free software; you can redistribute it and/or |
4 | * modify it under the terms of the GNU Lesser General Public | |
5 | * License as published by the Free Software Foundation; either | |
6 | * version 2.1 of the License, or (at your option) any later version. | |
a00c95d9 | 7 | * |
73be1d9e | 8 | * This library is distributed in the hope that it will be useful, |
0f2d19dd | 9 | * but 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 | |
92205699 | 15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
73be1d9e | 16 | */ |
1bbd0b84 | 17 | |
9de87eea | 18 | #define _GNU_SOURCE |
1bbd0b84 | 19 | |
37ddcaf6 MD |
20 | /* #define DEBUGINFO */ |
21 | ||
aa54a9b0 RB |
22 | #if HAVE_CONFIG_H |
23 | # include <config.h> | |
24 | #endif | |
56495472 | 25 | |
0f2d19dd | 26 | #include <stdio.h> |
e6e2e95a | 27 | #include <errno.h> |
783e7774 | 28 | #include <string.h> |
c8a1bdc4 | 29 | #include <assert.h> |
e6e2e95a | 30 | |
d9189652 RB |
31 | #ifdef __ia64__ |
32 | #include <ucontext.h> | |
bb1180ef | 33 | extern unsigned long * __libc_ia64_register_backing_store_base; |
d9189652 RB |
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 MD |
41 | #include "libguile/smob.h" |
42 | #include "libguile/unif.h" | |
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 | |
bc9d9bb2 | 58 | #ifdef GUILE_DEBUG_MALLOC |
a0599745 | 59 | #include "libguile/debug-malloc.h" |
bc9d9bb2 MD |
60 | #endif |
61 | ||
0f2d19dd | 62 | #ifdef HAVE_MALLOC_H |
95b88819 | 63 | #include <malloc.h> |
0f2d19dd JB |
64 | #endif |
65 | ||
66 | #ifdef HAVE_UNISTD_H | |
95b88819 | 67 | #include <unistd.h> |
0f2d19dd JB |
68 | #endif |
69 | ||
fb50ef08 MD |
70 | /* Lock this mutex before doing lazy sweeping. |
71 | */ | |
b17e0ac3 | 72 | scm_i_pthread_mutex_t scm_i_sweep_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER; |
fb50ef08 | 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 | |
eab1b259 HWN |
84 | /* |
85 | Global variable, so you can switch it off at runtime by setting | |
86 | scm_i_cell_validation_already_running. | |
406c7d90 | 87 | */ |
eab1b259 HWN |
88 | int scm_i_cell_validation_already_running ; |
89 | ||
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 (!scm_in_heap_p (cell)) |
108 | { | |
109 | fprintf (stderr, "scm_assert_cell_valid: this object does not live in the heap: %lux\n", | |
110 | (unsigned long) SCM_UNPACK (cell)); | |
111 | abort (); | |
112 | } | |
113 | ||
114 | /* If desired, perform additional garbage collections after a user | |
115 | * defined number of cell accesses. | |
116 | */ | |
117 | if (scm_debug_cells_gc_interval) | |
118 | { | |
119 | static unsigned int counter = 0; | |
61045190 | 120 | |
eab1b259 HWN |
121 | if (counter != 0) |
122 | { | |
123 | --counter; | |
124 | } | |
125 | else | |
126 | { | |
127 | counter = scm_debug_cells_gc_interval; | |
b17e0ac3 | 128 | scm_gc (); |
eab1b259 HWN |
129 | } |
130 | } | |
131 | } | |
132 | ||
133 | void | |
134 | scm_assert_cell_valid (SCM cell) | |
135 | { | |
136 | if (!scm_i_cell_validation_already_running && scm_debug_cell_accesses_p) | |
406c7d90 | 137 | { |
eab1b259 | 138 | scm_i_cell_validation_already_running = 1; /* set to avoid recursion */ |
406c7d90 | 139 | |
c8a1bdc4 | 140 | /* |
eab1b259 HWN |
141 | During GC, no user-code should be run, and the guile core |
142 | should use non-protected accessors. | |
143 | */ | |
c8a1bdc4 | 144 | if (scm_gc_running_p) |
eab1b259 | 145 | return; |
c8a1bdc4 HWN |
146 | |
147 | /* | |
eab1b259 HWN |
148 | Only scm_in_heap_p and rescanning the heap is wildly |
149 | expensive. | |
150 | */ | |
151 | if (scm_expensive_debug_cell_accesses_p) | |
152 | scm_i_expensive_validation_check (cell); | |
c8a1bdc4 HWN |
153 | |
154 | if (!SCM_GC_MARK_P (cell)) | |
406c7d90 | 155 | { |
c8a1bdc4 HWN |
156 | fprintf (stderr, |
157 | "scm_assert_cell_valid: this object is unmarked. \n" | |
158 | "It has been garbage-collected in the last GC run: " | |
159 | "%lux\n", | |
1be6b49c | 160 | (unsigned long) SCM_UNPACK (cell)); |
406c7d90 DH |
161 | abort (); |
162 | } | |
c8a1bdc4 | 163 | |
eab1b259 | 164 | scm_i_cell_validation_already_running = 0; /* re-enable */ |
406c7d90 DH |
165 | } |
166 | } | |
167 | ||
168 | ||
eab1b259 | 169 | |
406c7d90 DH |
170 | SCM_DEFINE (scm_set_debug_cell_accesses_x, "set-debug-cell-accesses!", 1, 0, 0, |
171 | (SCM flag), | |
1e6808ea | 172 | "If @var{flag} is @code{#f}, cell access checking is disabled.\n" |
eab1b259 | 173 | "If @var{flag} is @code{#t}, cheap cell access checking is enabled,\n" |
e81d98ec | 174 | "but no additional calls to garbage collection are issued.\n" |
eab1b259 | 175 | "If @var{flag} is a number, strict cell access checking is enabled,\n" |
e81d98ec DH |
176 | "with an additional garbage collection after the given\n" |
177 | "number of cell accesses.\n" | |
1e6808ea MG |
178 | "This procedure only exists when the compile-time flag\n" |
179 | "@code{SCM_DEBUG_CELL_ACCESSES} was set to 1.") | |
406c7d90 DH |
180 | #define FUNC_NAME s_scm_set_debug_cell_accesses_x |
181 | { | |
7888309b | 182 | if (scm_is_false (flag)) |
eab1b259 HWN |
183 | { |
184 | scm_debug_cell_accesses_p = 0; | |
185 | } | |
bc36d050 | 186 | else if (scm_is_eq (flag, SCM_BOOL_T)) |
eab1b259 HWN |
187 | { |
188 | scm_debug_cells_gc_interval = 0; | |
189 | scm_debug_cell_accesses_p = 1; | |
190 | scm_expensive_debug_cell_accesses_p = 0; | |
191 | } | |
e11e83f3 | 192 | else |
eab1b259 | 193 | { |
e11e83f3 | 194 | scm_debug_cells_gc_interval = scm_to_signed_integer (flag, 0, INT_MAX); |
eab1b259 HWN |
195 | scm_debug_cell_accesses_p = 1; |
196 | scm_expensive_debug_cell_accesses_p = 1; | |
197 | } | |
406c7d90 DH |
198 | return SCM_UNSPECIFIED; |
199 | } | |
200 | #undef FUNC_NAME | |
0f2d19dd | 201 | |
ecf470a2 | 202 | |
c8a1bdc4 | 203 | #endif /* SCM_DEBUG_CELL_ACCESSES == 1 */ |
0f2d19dd JB |
204 | |
205 | \f | |
945fec60 | 206 | |
0f2d19dd JB |
207 | |
208 | /* scm_mtrigger | |
539b08a4 | 209 | * is the number of bytes of malloc allocation needed to trigger gc. |
0f2d19dd | 210 | */ |
c014a02e | 211 | unsigned long scm_mtrigger; |
0f2d19dd | 212 | |
0f2d19dd JB |
213 | /* During collection, this accumulates objects holding |
214 | * weak references. | |
215 | */ | |
ab4bef85 | 216 | SCM scm_weak_vectors; |
0f2d19dd JB |
217 | |
218 | /* GC Statistics Keeping | |
219 | */ | |
f2893a25 | 220 | unsigned long scm_cells_allocated = 0; |
c014a02e ML |
221 | unsigned long scm_mallocated = 0; |
222 | unsigned long scm_gc_cells_collected; | |
c8a1bdc4 | 223 | unsigned long scm_gc_cells_collected_1 = 0; /* previous GC yield */ |
c014a02e ML |
224 | unsigned long scm_gc_malloc_collected; |
225 | unsigned long scm_gc_ports_collected; | |
0f2d19dd | 226 | unsigned long scm_gc_time_taken = 0; |
c014a02e | 227 | static unsigned long t_before_gc; |
c9b0d4b0 | 228 | unsigned long scm_gc_mark_time_taken = 0; |
c014a02e ML |
229 | unsigned long scm_gc_times = 0; |
230 | unsigned long scm_gc_cells_swept = 0; | |
c9b0d4b0 ML |
231 | double scm_gc_cells_marked_acc = 0.; |
232 | double scm_gc_cells_swept_acc = 0.; | |
c2cbcc57 HWN |
233 | int scm_gc_cell_yield_percentage =0; |
234 | int scm_gc_malloc_yield_percentage = 0; | |
7eec4c37 | 235 | unsigned long protected_obj_count = 0; |
c2cbcc57 | 236 | |
0f2d19dd JB |
237 | |
238 | SCM_SYMBOL (sym_cells_allocated, "cells-allocated"); | |
239 | SCM_SYMBOL (sym_heap_size, "cell-heap-size"); | |
240 | SCM_SYMBOL (sym_mallocated, "bytes-malloced"); | |
241 | SCM_SYMBOL (sym_mtrigger, "gc-malloc-threshold"); | |
242 | SCM_SYMBOL (sym_heap_segments, "cell-heap-segments"); | |
243 | SCM_SYMBOL (sym_gc_time_taken, "gc-time-taken"); | |
c9b0d4b0 | 244 | SCM_SYMBOL (sym_gc_mark_time_taken, "gc-mark-time-taken"); |
c9b0d4b0 ML |
245 | SCM_SYMBOL (sym_times, "gc-times"); |
246 | SCM_SYMBOL (sym_cells_marked, "cells-marked"); | |
247 | SCM_SYMBOL (sym_cells_swept, "cells-swept"); | |
c2cbcc57 HWN |
248 | SCM_SYMBOL (sym_malloc_yield, "malloc-yield"); |
249 | SCM_SYMBOL (sym_cell_yield, "cell-yield"); | |
7eec4c37 | 250 | SCM_SYMBOL (sym_protected_objects, "protected-objects"); |
0f2d19dd | 251 | |
bb2c57fa | 252 | |
cf2d30f6 | 253 | |
d3dd80ab | 254 | |
cf2d30f6 | 255 | /* Number of calls to SCM_NEWCELL since startup. */ |
c8a1bdc4 HWN |
256 | unsigned scm_newcell_count; |
257 | unsigned scm_newcell2_count; | |
b37fe1c5 | 258 | |
b37fe1c5 | 259 | |
0f2d19dd JB |
260 | /* {Scheme Interface to GC} |
261 | */ | |
1367aa5e HWN |
262 | static SCM |
263 | tag_table_to_type_alist (void *closure, SCM key, SCM val, SCM acc) | |
264 | { | |
265 | scm_t_bits c_tag = scm_to_int (key); | |
73a4c24e HWN |
266 | |
267 | char const * name = scm_i_tag_name (c_tag); | |
268 | if (name != NULL) | |
8a00ba71 HWN |
269 | { |
270 | key = scm_from_locale_string (name); | |
271 | } | |
272 | else | |
273 | { | |
274 | char s[100]; | |
275 | sprintf (s, "tag %d", c_tag); | |
276 | key = scm_from_locale_string (s); | |
277 | } | |
1367aa5e HWN |
278 | return scm_cons (scm_cons (key, val), acc); |
279 | } | |
280 | ||
281 | SCM_DEFINE (scm_gc_live_object_stats, "gc-live-object-stats", 0, 0, 0, | |
282 | (), | |
283 | "Return an alist of statistics of the current live objects. ") | |
284 | #define FUNC_NAME s_scm_gc_live_object_stats | |
285 | { | |
286 | SCM tab = scm_make_hash_table (scm_from_int (57)); | |
b01532af NJ |
287 | SCM alist; |
288 | ||
1367aa5e HWN |
289 | scm_i_all_segments_statistics (tab); |
290 | ||
b01532af | 291 | alist |
1367aa5e HWN |
292 | = scm_internal_hash_fold (&tag_table_to_type_alist, NULL, SCM_EOL, tab); |
293 | ||
294 | return alist; | |
295 | } | |
296 | #undef FUNC_NAME | |
297 | ||
c2cbcc57 | 298 | extern int scm_gc_malloc_yield_percentage; |
a00c95d9 | 299 | SCM_DEFINE (scm_gc_stats, "gc-stats", 0, 0, 0, |
1bbd0b84 | 300 | (), |
1e6808ea | 301 | "Return an association list of statistics about Guile's current\n" |
c8a1bdc4 | 302 | "use of storage.\n") |
1bbd0b84 | 303 | #define FUNC_NAME s_scm_gc_stats |
0f2d19dd | 304 | { |
c8a1bdc4 HWN |
305 | long i = 0; |
306 | SCM heap_segs = SCM_EOL ; | |
c014a02e ML |
307 | unsigned long int local_scm_mtrigger; |
308 | unsigned long int local_scm_mallocated; | |
309 | unsigned long int local_scm_heap_size; | |
c2cbcc57 HWN |
310 | int local_scm_gc_cell_yield_percentage; |
311 | int local_scm_gc_malloc_yield_percentage; | |
f2893a25 | 312 | unsigned long int local_scm_cells_allocated; |
c014a02e ML |
313 | unsigned long int local_scm_gc_time_taken; |
314 | unsigned long int local_scm_gc_times; | |
315 | unsigned long int local_scm_gc_mark_time_taken; | |
7eec4c37 | 316 | unsigned long int local_protected_obj_count; |
c9b0d4b0 ML |
317 | double local_scm_gc_cells_swept; |
318 | double local_scm_gc_cells_marked; | |
0f2d19dd | 319 | SCM answer; |
c8a1bdc4 HWN |
320 | unsigned long *bounds = 0; |
321 | int table_size = scm_i_heap_segment_table_size; | |
9de87eea | 322 | SCM_CRITICAL_SECTION_START; |
939794ce | 323 | |
c8a1bdc4 HWN |
324 | /* |
325 | temporarily store the numbers, so as not to cause GC. | |
7febb4a2 | 326 | */ |
c8a1bdc4 HWN |
327 | |
328 | bounds = malloc (sizeof (int) * table_size * 2); | |
329 | if (!bounds) | |
330 | abort(); | |
331 | for (i = table_size; i--; ) | |
332 | { | |
333 | bounds[2*i] = (unsigned long)scm_i_heap_segment_table[i]->bounds[0]; | |
334 | bounds[2*i+1] = (unsigned long)scm_i_heap_segment_table[i]->bounds[1]; | |
335 | } | |
0f2d19dd | 336 | |
4c9419ac | 337 | |
c8a1bdc4 HWN |
338 | /* Below, we cons to produce the resulting list. We want a snapshot of |
339 | * the heap situation before consing. | |
340 | */ | |
341 | local_scm_mtrigger = scm_mtrigger; | |
342 | local_scm_mallocated = scm_mallocated; | |
343 | local_scm_heap_size = SCM_HEAP_SIZE; | |
539b08a4 | 344 | |
c8a1bdc4 HWN |
345 | local_scm_cells_allocated = scm_cells_allocated; |
346 | ||
347 | local_scm_gc_time_taken = scm_gc_time_taken; | |
348 | local_scm_gc_mark_time_taken = scm_gc_mark_time_taken; | |
349 | local_scm_gc_times = scm_gc_times; | |
c2cbcc57 HWN |
350 | local_scm_gc_malloc_yield_percentage = scm_gc_malloc_yield_percentage; |
351 | local_scm_gc_cell_yield_percentage= scm_gc_cell_yield_percentage; | |
7eec4c37 | 352 | local_protected_obj_count = protected_obj_count; |
c2cbcc57 HWN |
353 | local_scm_gc_cells_swept = |
354 | (double) scm_gc_cells_swept_acc | |
355 | + (double) scm_gc_cells_swept; | |
c8a1bdc4 HWN |
356 | local_scm_gc_cells_marked = scm_gc_cells_marked_acc |
357 | +(double) scm_gc_cells_swept | |
358 | -(double) scm_gc_cells_collected; | |
0f2d19dd | 359 | |
c8a1bdc4 HWN |
360 | for (i = table_size; i--;) |
361 | { | |
b9bd8526 MV |
362 | heap_segs = scm_cons (scm_cons (scm_from_ulong (bounds[2*i]), |
363 | scm_from_ulong (bounds[2*i+1])), | |
c8a1bdc4 HWN |
364 | heap_segs); |
365 | } | |
33b320ae NJ |
366 | /* njrev: can any of these scm_cons's or scm_list_n signal a memory |
367 | error? If so we need a frame here. */ | |
b9bd8526 MV |
368 | answer = |
369 | scm_list_n (scm_cons (sym_gc_time_taken, | |
370 | scm_from_ulong (local_scm_gc_time_taken)), | |
371 | scm_cons (sym_cells_allocated, | |
372 | scm_from_ulong (local_scm_cells_allocated)), | |
373 | scm_cons (sym_heap_size, | |
374 | scm_from_ulong (local_scm_heap_size)), | |
375 | scm_cons (sym_mallocated, | |
376 | scm_from_ulong (local_scm_mallocated)), | |
377 | scm_cons (sym_mtrigger, | |
378 | scm_from_ulong (local_scm_mtrigger)), | |
379 | scm_cons (sym_times, | |
380 | scm_from_ulong (local_scm_gc_times)), | |
381 | scm_cons (sym_gc_mark_time_taken, | |
382 | scm_from_ulong (local_scm_gc_mark_time_taken)), | |
383 | scm_cons (sym_cells_marked, | |
384 | scm_from_double (local_scm_gc_cells_marked)), | |
385 | scm_cons (sym_cells_swept, | |
386 | scm_from_double (local_scm_gc_cells_swept)), | |
387 | scm_cons (sym_malloc_yield, | |
388 | scm_from_long(local_scm_gc_malloc_yield_percentage)), | |
389 | scm_cons (sym_cell_yield, | |
390 | scm_from_long (local_scm_gc_cell_yield_percentage)), | |
391 | scm_cons (sym_protected_objects, | |
392 | scm_from_ulong (local_protected_obj_count)), | |
393 | scm_cons (sym_heap_segments, heap_segs), | |
394 | SCM_UNDEFINED); | |
9de87eea | 395 | SCM_CRITICAL_SECTION_END; |
c8a1bdc4 HWN |
396 | |
397 | free (bounds); | |
398 | return answer; | |
0f2d19dd | 399 | } |
c8a1bdc4 | 400 | #undef FUNC_NAME |
0f2d19dd | 401 | |
c8a1bdc4 HWN |
402 | static void |
403 | gc_start_stats (const char *what SCM_UNUSED) | |
e4a7824f | 404 | { |
c8a1bdc4 | 405 | t_before_gc = scm_c_get_internal_run_time (); |
539b08a4 | 406 | |
c8a1bdc4 HWN |
407 | scm_gc_cells_marked_acc += (double) scm_gc_cells_swept |
408 | - (double) scm_gc_cells_collected; | |
c2cbcc57 | 409 | scm_gc_cells_swept_acc += (double) scm_gc_cells_swept; |
e4a7824f | 410 | |
c2cbcc57 HWN |
411 | scm_gc_cell_yield_percentage = ( scm_gc_cells_collected * 100 ) / SCM_HEAP_SIZE; |
412 | ||
c8a1bdc4 HWN |
413 | scm_gc_cells_swept = 0; |
414 | scm_gc_cells_collected_1 = scm_gc_cells_collected; | |
539b08a4 | 415 | |
c8a1bdc4 HWN |
416 | /* |
417 | CELLS SWEPT is another word for the number of cells that were | |
418 | examined during GC. YIELD is the number that we cleaned | |
419 | out. MARKED is the number that weren't cleaned. | |
420 | */ | |
421 | scm_gc_cells_collected = 0; | |
422 | scm_gc_malloc_collected = 0; | |
423 | scm_gc_ports_collected = 0; | |
e4a7824f | 424 | } |
acf4331f | 425 | |
c8a1bdc4 HWN |
426 | static void |
427 | gc_end_stats () | |
0f2d19dd | 428 | { |
c8a1bdc4 HWN |
429 | unsigned long t = scm_c_get_internal_run_time (); |
430 | scm_gc_time_taken += (t - t_before_gc); | |
539b08a4 | 431 | |
c8a1bdc4 | 432 | ++scm_gc_times; |
0f2d19dd | 433 | } |
acf4331f | 434 | |
0f2d19dd | 435 | |
c8a1bdc4 HWN |
436 | SCM_DEFINE (scm_object_address, "object-address", 1, 0, 0, |
437 | (SCM obj), | |
438 | "Return an integer that for the lifetime of @var{obj} is uniquely\n" | |
439 | "returned by this function for @var{obj}") | |
440 | #define FUNC_NAME s_scm_object_address | |
c68296f8 | 441 | { |
b9bd8526 | 442 | return scm_from_ulong (SCM_UNPACK (obj)); |
c68296f8 | 443 | } |
c8a1bdc4 | 444 | #undef FUNC_NAME |
c68296f8 | 445 | |
1be6b49c | 446 | |
c8a1bdc4 HWN |
447 | SCM_DEFINE (scm_gc, "gc", 0, 0, 0, |
448 | (), | |
449 | "Scans all of SCM objects and reclaims for further use those that are\n" | |
450 | "no longer accessible.") | |
451 | #define FUNC_NAME s_scm_gc | |
452 | { | |
b17e0ac3 MV |
453 | scm_i_scm_pthread_mutex_lock (&scm_i_sweep_mutex); |
454 | scm_gc_running_p = 1; | |
455 | scm_i_gc ("call"); | |
33b320ae NJ |
456 | /* njrev: It looks as though other places, e.g. scm_realloc, |
457 | can call scm_i_gc without acquiring the sweep mutex. Does this | |
458 | matter? Also scm_i_gc (or its descendants) touch the | |
459 | scm_sys_protects, which are protected in some cases | |
460 | (e.g. scm_permobjs above in scm_gc_stats) by a critical section, | |
461 | not by the sweep mutex. Shouldn't all the GC-relevant objects be | |
462 | protected in the same way? */ | |
b17e0ac3 MV |
463 | scm_gc_running_p = 0; |
464 | scm_i_pthread_mutex_unlock (&scm_i_sweep_mutex); | |
465 | scm_c_hook_run (&scm_after_gc_c_hook, 0); | |
c8a1bdc4 | 466 | return SCM_UNSPECIFIED; |
9d47a1e6 | 467 | } |
c8a1bdc4 | 468 | #undef FUNC_NAME |
9d47a1e6 | 469 | |
c68296f8 MV |
470 | |
471 | \f | |
0f2d19dd | 472 | |
b17e0ac3 MV |
473 | /* The master is global and common while the freelist will be |
474 | * individual for each thread. | |
0f2d19dd JB |
475 | */ |
476 | ||
c8a1bdc4 HWN |
477 | SCM |
478 | scm_gc_for_newcell (scm_t_cell_type_statistics *freelist, SCM *free_cells) | |
0f2d19dd | 479 | { |
c8a1bdc4 | 480 | SCM cell; |
b17e0ac3 | 481 | int did_gc = 0; |
c8a1bdc4 | 482 | |
9de87eea | 483 | scm_i_scm_pthread_mutex_lock (&scm_i_sweep_mutex); |
b17e0ac3 | 484 | scm_gc_running_p = 1; |
9bc4701c | 485 | |
c8a1bdc4 HWN |
486 | *free_cells = scm_i_sweep_some_segments (freelist); |
487 | if (*free_cells == SCM_EOL && scm_i_gc_grow_heap_p (freelist)) | |
488 | { | |
489 | freelist->heap_segment_idx = scm_i_get_new_heap_segment (freelist, abort_on_error); | |
490 | *free_cells = scm_i_sweep_some_segments (freelist); | |
491 | } | |
acb0a19c | 492 | |
b17e0ac3 | 493 | if (*free_cells == SCM_EOL) |
c8a1bdc4 HWN |
494 | { |
495 | /* | |
b17e0ac3 | 496 | with the advent of lazy sweep, GC yield is only known just |
c8a1bdc4 HWN |
497 | before doing the GC. |
498 | */ | |
499 | scm_i_adjust_min_yield (freelist); | |
500 | ||
501 | /* | |
502 | out of fresh cells. Try to get some new ones. | |
503 | */ | |
0f2d19dd | 504 | |
b17e0ac3 MV |
505 | did_gc = 1; |
506 | scm_i_gc ("cells"); | |
a00c95d9 | 507 | |
c8a1bdc4 HWN |
508 | *free_cells = scm_i_sweep_some_segments (freelist); |
509 | } | |
510 | ||
511 | if (*free_cells == SCM_EOL) | |
512 | { | |
513 | /* | |
514 | failed getting new cells. Get new juice or die. | |
515 | */ | |
516 | freelist->heap_segment_idx = scm_i_get_new_heap_segment (freelist, abort_on_error); | |
517 | *free_cells = scm_i_sweep_some_segments (freelist); | |
518 | } | |
519 | ||
520 | if (*free_cells == SCM_EOL) | |
521 | abort (); | |
0f2d19dd | 522 | |
c8a1bdc4 | 523 | cell = *free_cells; |
0f2d19dd | 524 | |
c8a1bdc4 | 525 | *free_cells = SCM_FREE_CELL_CDR (cell); |
eab1b259 | 526 | |
b17e0ac3 | 527 | scm_gc_running_p = 0; |
9de87eea | 528 | scm_i_pthread_mutex_unlock (&scm_i_sweep_mutex); |
eab1b259 | 529 | |
b17e0ac3 MV |
530 | if (did_gc) |
531 | scm_c_hook_run (&scm_after_gc_c_hook, 0); | |
532 | ||
c8a1bdc4 HWN |
533 | return cell; |
534 | } | |
4a4c9785 | 535 | |
4a4c9785 | 536 | |
c8a1bdc4 HWN |
537 | scm_t_c_hook scm_before_gc_c_hook; |
538 | scm_t_c_hook scm_before_mark_c_hook; | |
539 | scm_t_c_hook scm_before_sweep_c_hook; | |
540 | scm_t_c_hook scm_after_sweep_c_hook; | |
541 | scm_t_c_hook scm_after_gc_c_hook; | |
4a4c9785 | 542 | |
b17e0ac3 MV |
543 | /* Must be called while holding scm_i_sweep_mutex. |
544 | */ | |
545 | ||
c8a1bdc4 | 546 | void |
b17e0ac3 | 547 | scm_i_gc (const char *what) |
c8a1bdc4 | 548 | { |
9de87eea MV |
549 | scm_i_thread_put_to_sleep (); |
550 | ||
c8a1bdc4 | 551 | scm_c_hook_run (&scm_before_gc_c_hook, 0); |
a00c95d9 | 552 | |
c8a1bdc4 HWN |
553 | #ifdef DEBUGINFO |
554 | fprintf (stderr,"gc reason %s\n", what); | |
555 | ||
556 | fprintf (stderr, | |
d2e53ed6 | 557 | scm_is_null (*SCM_FREELIST_LOC (scm_i_freelist)) |
c8a1bdc4 | 558 | ? "*" |
d2e53ed6 | 559 | : (scm_is_null (*SCM_FREELIST_LOC (scm_i_freelist2)) ? "o" : "m")); |
c8a1bdc4 | 560 | #endif |
4c48ba06 | 561 | |
c8a1bdc4 | 562 | gc_start_stats (what); |
a00c95d9 | 563 | |
1367aa5e HWN |
564 | /* |
565 | Set freelists to NULL so scm_cons() always triggers gc, causing | |
b17e0ac3 | 566 | the assertion above to fail. |
1367aa5e HWN |
567 | */ |
568 | *SCM_FREELIST_LOC (scm_i_freelist) = SCM_EOL; | |
569 | *SCM_FREELIST_LOC (scm_i_freelist2) = SCM_EOL; | |
570 | ||
c8a1bdc4 HWN |
571 | /* |
572 | Let's finish the sweep. The conservative GC might point into the | |
573 | garbage, and marking that would create a mess. | |
574 | */ | |
575 | scm_i_sweep_all_segments("GC"); | |
576 | if (scm_mallocated < scm_i_deprecated_memory_return) | |
b6efc951 | 577 | { |
c8a1bdc4 HWN |
578 | /* The byte count of allocated objects has underflowed. This is |
579 | probably because you forgot to report the sizes of objects you | |
580 | have allocated, by calling scm_done_malloc or some such. When | |
581 | the GC freed them, it subtracted their size from | |
582 | scm_mallocated, which underflowed. */ | |
583 | fprintf (stderr, | |
584 | "scm_gc_sweep: Byte count of allocated objects has underflowed.\n" | |
585 | "This is probably because the GC hasn't been correctly informed\n" | |
586 | "about object sizes\n"); | |
b6efc951 DH |
587 | abort (); |
588 | } | |
c8a1bdc4 | 589 | scm_mallocated -= scm_i_deprecated_memory_return; |
0f2d19dd | 590 | |
c8a1bdc4 | 591 | |
b17e0ac3 | 592 | /* Mark */ |
b6efc951 | 593 | |
b17e0ac3 | 594 | scm_c_hook_run (&scm_before_mark_c_hook, 0); |
c8a1bdc4 | 595 | scm_mark_all (); |
c2cbcc57 | 596 | scm_gc_mark_time_taken += (scm_c_get_internal_run_time () - t_before_gc); |
c8a1bdc4 | 597 | |
b17e0ac3 | 598 | /* Sweep |
ffd72400 | 599 | |
b17e0ac3 MV |
600 | TODO: the after_sweep hook should probably be moved to just before |
601 | the mark, since that's where the sweep is finished in lazy | |
602 | sweeping. | |
c35738c1 MD |
603 | |
604 | MDJ 030219 <djurfeldt@nada.kth.se>: No, probably not. The | |
605 | original meaning implied at least two things: that it would be | |
606 | called when | |
607 | ||
608 | 1. the freelist is re-initialized (no evaluation possible, though) | |
609 | ||
610 | and | |
611 | ||
612 | 2. the heap is "fresh" | |
613 | (it is well-defined what data is used and what is not) | |
614 | ||
615 | Neither of these conditions would hold just before the mark phase. | |
616 | ||
617 | Of course, the lazy sweeping has muddled the distinction between | |
618 | scm_before_sweep_c_hook and scm_after_sweep_c_hook, but even if | |
619 | there were no difference, it would still be useful to have two | |
620 | distinct classes of hook functions since this can prevent some | |
621 | bad interference when several modules adds gc hooks. | |
ffd72400 | 622 | */ |
b17e0ac3 MV |
623 | |
624 | scm_c_hook_run (&scm_before_sweep_c_hook, 0); | |
625 | scm_gc_sweep (); | |
c8a1bdc4 | 626 | scm_c_hook_run (&scm_after_sweep_c_hook, 0); |
b17e0ac3 | 627 | |
c8a1bdc4 HWN |
628 | gc_end_stats (); |
629 | ||
fb50ef08 | 630 | scm_i_thread_wake_up (); |
ffd72400 | 631 | |
eab1b259 HWN |
632 | /* |
633 | For debugging purposes, you could do | |
634 | scm_i_sweep_all_segments("debug"), but then the remains of the | |
635 | cell aren't left to analyse. | |
636 | */ | |
637 | } | |
0f2d19dd | 638 | |
0f2d19dd JB |
639 | \f |
640 | /* {GC Protection Helper Functions} | |
641 | */ | |
642 | ||
643 | ||
5d2b97cd DH |
644 | /* |
645 | * If within a function you need to protect one or more scheme objects from | |
646 | * garbage collection, pass them as parameters to one of the | |
647 | * scm_remember_upto_here* functions below. These functions don't do | |
648 | * anything, but since the compiler does not know that they are actually | |
649 | * no-ops, it will generate code that calls these functions with the given | |
650 | * parameters. Therefore, you can be sure that the compiler will keep those | |
651 | * scheme values alive (on the stack or in a register) up to the point where | |
652 | * scm_remember_upto_here* is called. In other words, place the call to | |
592996c9 | 653 | * scm_remember_upto_here* _behind_ the last code in your function, that |
5d2b97cd DH |
654 | * depends on the scheme object to exist. |
655 | * | |
8c494e99 DH |
656 | * Example: We want to make sure that the string object str does not get |
657 | * garbage collected during the execution of 'some_function' in the code | |
658 | * below, because otherwise the characters belonging to str would be freed and | |
5d2b97cd DH |
659 | * 'some_function' might access freed memory. To make sure that the compiler |
660 | * keeps str alive on the stack or in a register such that it is visible to | |
661 | * the conservative gc we add the call to scm_remember_upto_here_1 _after_ the | |
662 | * call to 'some_function'. Note that this would not be necessary if str was | |
663 | * used anyway after the call to 'some_function'. | |
eb01cb64 | 664 | * char *chars = scm_i_string_chars (str); |
5d2b97cd DH |
665 | * some_function (chars); |
666 | * scm_remember_upto_here_1 (str); // str will be alive up to this point. | |
667 | */ | |
668 | ||
9e1569bd KR |
669 | /* Remove any macro versions of these while defining the functions. |
670 | Functions are always included in the library, for upward binary | |
671 | compatibility and in case combinations of GCC and non-GCC are used. */ | |
672 | #undef scm_remember_upto_here_1 | |
673 | #undef scm_remember_upto_here_2 | |
674 | ||
5d2b97cd | 675 | void |
e81d98ec | 676 | scm_remember_upto_here_1 (SCM obj SCM_UNUSED) |
5d2b97cd DH |
677 | { |
678 | /* Empty. Protects a single object from garbage collection. */ | |
679 | } | |
680 | ||
681 | void | |
e81d98ec | 682 | scm_remember_upto_here_2 (SCM obj1 SCM_UNUSED, SCM obj2 SCM_UNUSED) |
5d2b97cd DH |
683 | { |
684 | /* Empty. Protects two objects from garbage collection. */ | |
685 | } | |
686 | ||
687 | void | |
e81d98ec | 688 | scm_remember_upto_here (SCM obj SCM_UNUSED, ...) |
5d2b97cd DH |
689 | { |
690 | /* Empty. Protects any number of objects from garbage collection. */ | |
691 | } | |
692 | ||
c209c88e | 693 | /* |
41b0806d GB |
694 | These crazy functions prevent garbage collection |
695 | of arguments after the first argument by | |
696 | ensuring they remain live throughout the | |
697 | function because they are used in the last | |
698 | line of the code block. | |
699 | It'd be better to have a nice compiler hint to | |
700 | aid the conservative stack-scanning GC. --03/09/00 gjb */ | |
0f2d19dd JB |
701 | SCM |
702 | scm_return_first (SCM elt, ...) | |
0f2d19dd JB |
703 | { |
704 | return elt; | |
705 | } | |
706 | ||
41b0806d GB |
707 | int |
708 | scm_return_first_int (int i, ...) | |
709 | { | |
710 | return i; | |
711 | } | |
712 | ||
0f2d19dd | 713 | |
0f2d19dd | 714 | SCM |
6e8d25a6 | 715 | scm_permanent_object (SCM obj) |
0f2d19dd | 716 | { |
9de87eea MV |
717 | SCM cell = scm_cons (obj, SCM_EOL); |
718 | SCM_CRITICAL_SECTION_START; | |
719 | SCM_SETCDR (cell, scm_permobjs); | |
720 | scm_permobjs = cell; | |
721 | SCM_CRITICAL_SECTION_END; | |
0f2d19dd JB |
722 | return obj; |
723 | } | |
724 | ||
725 | ||
7bd4fbe2 MD |
726 | /* Protect OBJ from the garbage collector. OBJ will not be freed, even if all |
727 | other references are dropped, until the object is unprotected by calling | |
6b1b030e | 728 | scm_gc_unprotect_object (OBJ). Calls to scm_gc_protect/unprotect_object nest, |
7bd4fbe2 MD |
729 | i. e. it is possible to protect the same object several times, but it is |
730 | necessary to unprotect the object the same number of times to actually get | |
731 | the object unprotected. It is an error to unprotect an object more often | |
732 | than it has been protected before. The function scm_protect_object returns | |
733 | OBJ. | |
734 | */ | |
735 | ||
736 | /* Implementation note: For every object X, there is a counter which | |
6b1b030e | 737 | scm_gc_protect_object(X) increments and scm_gc_unprotect_object(X) decrements. |
7bd4fbe2 | 738 | */ |
686765af | 739 | |
7eec4c37 HWN |
740 | |
741 | ||
ef290276 | 742 | SCM |
6b1b030e | 743 | scm_gc_protect_object (SCM obj) |
ef290276 | 744 | { |
686765af | 745 | SCM handle; |
9d47a1e6 | 746 | |
686765af | 747 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae NJ |
748 | /* njrev: Indeed; if my comment above is correct, there is the same |
749 | critsec/mutex inconsistency here. */ | |
9de87eea | 750 | SCM_CRITICAL_SECTION_START; |
9d47a1e6 | 751 | |
e11e83f3 MV |
752 | handle = scm_hashq_create_handle_x (scm_protects, obj, scm_from_int (0)); |
753 | SCM_SETCDR (handle, scm_sum (SCM_CDR (handle), scm_from_int (1))); | |
9d47a1e6 | 754 | |
7eec4c37 HWN |
755 | protected_obj_count ++; |
756 | ||
9de87eea | 757 | SCM_CRITICAL_SECTION_END; |
9d47a1e6 | 758 | |
ef290276 JB |
759 | return obj; |
760 | } | |
761 | ||
762 | ||
763 | /* Remove any protection for OBJ established by a prior call to | |
dab7f566 | 764 | scm_protect_object. This function returns OBJ. |
ef290276 | 765 | |
dab7f566 | 766 | See scm_protect_object for more information. */ |
ef290276 | 767 | SCM |
6b1b030e | 768 | scm_gc_unprotect_object (SCM obj) |
ef290276 | 769 | { |
686765af | 770 | SCM handle; |
9d47a1e6 | 771 | |
686765af | 772 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae | 773 | /* njrev: and again. */ |
9de87eea | 774 | SCM_CRITICAL_SECTION_START; |
9d47a1e6 | 775 | |
0ff7e3ff HWN |
776 | if (scm_gc_running_p) |
777 | { | |
778 | fprintf (stderr, "scm_unprotect_object called during GC.\n"); | |
779 | abort (); | |
780 | } | |
b17e0ac3 | 781 | |
686765af | 782 | handle = scm_hashq_get_handle (scm_protects, obj); |
9d47a1e6 | 783 | |
7888309b | 784 | if (scm_is_false (handle)) |
686765af | 785 | { |
0f0f0899 MD |
786 | fprintf (stderr, "scm_unprotect_object called on unprotected object\n"); |
787 | abort (); | |
686765af | 788 | } |
6a199940 DH |
789 | else |
790 | { | |
e11e83f3 | 791 | SCM count = scm_difference (SCM_CDR (handle), scm_from_int (1)); |
bc36d050 | 792 | if (scm_is_eq (count, scm_from_int (0))) |
6a199940 DH |
793 | scm_hashq_remove_x (scm_protects, obj); |
794 | else | |
1be6b49c | 795 | SCM_SETCDR (handle, count); |
6a199940 | 796 | } |
7eec4c37 | 797 | protected_obj_count --; |
686765af | 798 | |
9de87eea | 799 | SCM_CRITICAL_SECTION_END; |
ef290276 JB |
800 | |
801 | return obj; | |
802 | } | |
803 | ||
6b1b030e ML |
804 | void |
805 | scm_gc_register_root (SCM *p) | |
806 | { | |
807 | SCM handle; | |
b9bd8526 | 808 | SCM key = scm_from_ulong ((unsigned long) p); |
eae33935 | 809 | |
6b1b030e | 810 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae | 811 | /* njrev: and again. */ |
9de87eea | 812 | SCM_CRITICAL_SECTION_START; |
6b1b030e | 813 | |
e11e83f3 MV |
814 | handle = scm_hashv_create_handle_x (scm_gc_registered_roots, key, |
815 | scm_from_int (0)); | |
33b320ae | 816 | /* njrev: note also that the above can probably signal an error */ |
e11e83f3 | 817 | SCM_SETCDR (handle, scm_sum (SCM_CDR (handle), scm_from_int (1))); |
6b1b030e | 818 | |
9de87eea | 819 | SCM_CRITICAL_SECTION_END; |
6b1b030e ML |
820 | } |
821 | ||
822 | void | |
823 | scm_gc_unregister_root (SCM *p) | |
824 | { | |
825 | SCM handle; | |
b9bd8526 | 826 | SCM key = scm_from_ulong ((unsigned long) p); |
6b1b030e ML |
827 | |
828 | /* This critical section barrier will be replaced by a mutex. */ | |
33b320ae | 829 | /* njrev: and again. */ |
9de87eea | 830 | SCM_CRITICAL_SECTION_START; |
6b1b030e ML |
831 | |
832 | handle = scm_hashv_get_handle (scm_gc_registered_roots, key); | |
833 | ||
7888309b | 834 | if (scm_is_false (handle)) |
6b1b030e ML |
835 | { |
836 | fprintf (stderr, "scm_gc_unregister_root called on unregistered root\n"); | |
837 | abort (); | |
838 | } | |
839 | else | |
840 | { | |
e11e83f3 | 841 | SCM count = scm_difference (SCM_CDR (handle), scm_from_int (1)); |
bc36d050 | 842 | if (scm_is_eq (count, scm_from_int (0))) |
6b1b030e ML |
843 | scm_hashv_remove_x (scm_gc_registered_roots, key); |
844 | else | |
845 | SCM_SETCDR (handle, count); | |
846 | } | |
847 | ||
9de87eea | 848 | SCM_CRITICAL_SECTION_END; |
6b1b030e ML |
849 | } |
850 | ||
851 | void | |
852 | scm_gc_register_roots (SCM *b, unsigned long n) | |
853 | { | |
854 | SCM *p = b; | |
855 | for (; p < b + n; ++p) | |
856 | scm_gc_register_root (p); | |
857 | } | |
858 | ||
859 | void | |
860 | scm_gc_unregister_roots (SCM *b, unsigned long n) | |
861 | { | |
862 | SCM *p = b; | |
863 | for (; p < b + n; ++p) | |
864 | scm_gc_unregister_root (p); | |
865 | } | |
866 | ||
04a98cff | 867 | int scm_i_terminating; |
c45acc34 | 868 | |
0f2d19dd | 869 | \f |
a00c95d9 | 870 | |
4c48ba06 | 871 | |
c8a1bdc4 HWN |
872 | /* |
873 | MOVE THIS FUNCTION. IT DOES NOT HAVE ANYTHING TODO WITH GC. | |
874 | */ | |
85db4a2c DH |
875 | |
876 | /* Get an integer from an environment variable. */ | |
c8a1bdc4 HWN |
877 | int |
878 | scm_getenv_int (const char *var, int def) | |
85db4a2c | 879 | { |
c8a1bdc4 HWN |
880 | char *end = 0; |
881 | char *val = getenv (var); | |
882 | long res = def; | |
85db4a2c DH |
883 | if (!val) |
884 | return def; | |
885 | res = strtol (val, &end, 10); | |
886 | if (end == val) | |
887 | return def; | |
888 | return res; | |
889 | } | |
890 | ||
c35738c1 MD |
891 | void |
892 | scm_storage_prehistory () | |
893 | { | |
894 | scm_c_hook_init (&scm_before_gc_c_hook, 0, SCM_C_HOOK_NORMAL); | |
895 | scm_c_hook_init (&scm_before_mark_c_hook, 0, SCM_C_HOOK_NORMAL); | |
896 | scm_c_hook_init (&scm_before_sweep_c_hook, 0, SCM_C_HOOK_NORMAL); | |
897 | scm_c_hook_init (&scm_after_sweep_c_hook, 0, SCM_C_HOOK_NORMAL); | |
898 | scm_c_hook_init (&scm_after_gc_c_hook, 0, SCM_C_HOOK_NORMAL); | |
899 | } | |
85db4a2c | 900 | |
9de87eea | 901 | scm_i_pthread_mutex_t scm_i_gc_admin_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER; |
eb01cb64 | 902 | |
4a4c9785 | 903 | int |
85db4a2c | 904 | scm_init_storage () |
0f2d19dd | 905 | { |
1be6b49c | 906 | size_t j; |
0f2d19dd JB |
907 | |
908 | j = SCM_NUM_PROTECTS; | |
909 | while (j) | |
910 | scm_sys_protects[--j] = SCM_BOOL_F; | |
4a4c9785 | 911 | |
c8a1bdc4 HWN |
912 | scm_gc_init_freelist(); |
913 | scm_gc_init_malloc (); | |
0f2d19dd JB |
914 | |
915 | j = SCM_HEAP_SEG_SIZE; | |
d6884e63 | 916 | |
c8a1bdc4 | 917 | |
0f2d19dd | 918 | /* Initialise the list of ports. */ |
67329a9e HWN |
919 | scm_i_port_table = (scm_t_port **) |
920 | malloc (sizeof (scm_t_port *) * scm_i_port_table_room); | |
921 | if (!scm_i_port_table) | |
0f2d19dd JB |
922 | return 1; |
923 | ||
9de87eea MV |
924 | #if 0 |
925 | /* We can't have a cleanup handler since we have no thread to run it | |
926 | in. */ | |
927 | ||
a18bcd0e | 928 | #ifdef HAVE_ATEXIT |
c45acc34 | 929 | atexit (cleanup); |
e52ceaac MD |
930 | #else |
931 | #ifdef HAVE_ON_EXIT | |
932 | on_exit (cleanup, 0); | |
933 | #endif | |
9de87eea MV |
934 | #endif |
935 | ||
a18bcd0e | 936 | #endif |
0f2d19dd | 937 | |
e4da0740 | 938 | scm_stand_in_procs = scm_make_weak_key_hash_table (scm_from_int (257)); |
0f2d19dd | 939 | scm_permobjs = SCM_EOL; |
00ffa0e7 | 940 | scm_protects = scm_c_make_hash_table (31); |
6b1b030e | 941 | scm_gc_registered_roots = scm_c_make_hash_table (31); |
d6884e63 | 942 | |
0f2d19dd JB |
943 | return 0; |
944 | } | |
939794ce | 945 | |
0f2d19dd JB |
946 | \f |
947 | ||
939794ce DH |
948 | SCM scm_after_gc_hook; |
949 | ||
939794ce DH |
950 | static SCM gc_async; |
951 | ||
939794ce DH |
952 | /* The function gc_async_thunk causes the execution of the after-gc-hook. It |
953 | * is run after the gc, as soon as the asynchronous events are handled by the | |
954 | * evaluator. | |
955 | */ | |
956 | static SCM | |
957 | gc_async_thunk (void) | |
958 | { | |
959 | scm_c_run_hook (scm_after_gc_hook, SCM_EOL); | |
939794ce DH |
960 | return SCM_UNSPECIFIED; |
961 | } | |
962 | ||
963 | ||
964 | /* The function mark_gc_async is run by the scm_after_gc_c_hook at the end of | |
965 | * the garbage collection. The only purpose of this function is to mark the | |
966 | * gc_async (which will eventually lead to the execution of the | |
967 | * gc_async_thunk). | |
968 | */ | |
969 | static void * | |
e81d98ec DH |
970 | mark_gc_async (void * hook_data SCM_UNUSED, |
971 | void *func_data SCM_UNUSED, | |
972 | void *data SCM_UNUSED) | |
973 | { | |
974 | /* If cell access debugging is enabled, the user may choose to perform | |
975 | * additional garbage collections after an arbitrary number of cell | |
976 | * accesses. We don't want the scheme level after-gc-hook to be performed | |
977 | * for each of these garbage collections for the following reason: The | |
978 | * execution of the after-gc-hook causes cell accesses itself. Thus, if the | |
979 | * after-gc-hook was performed with every gc, and if the gc was performed | |
980 | * after a very small number of cell accesses, then the number of cell | |
981 | * accesses during the execution of the after-gc-hook will suffice to cause | |
982 | * the execution of the next gc. Then, guile would keep executing the | |
983 | * after-gc-hook over and over again, and would never come to do other | |
984 | * things. | |
eae33935 | 985 | * |
e81d98ec DH |
986 | * To overcome this problem, if cell access debugging with additional |
987 | * garbage collections is enabled, the after-gc-hook is never run by the | |
988 | * garbage collecter. When running guile with cell access debugging and the | |
989 | * execution of the after-gc-hook is desired, then it is necessary to run | |
990 | * the hook explicitly from the user code. This has the effect, that from | |
991 | * the scheme level point of view it seems that garbage collection is | |
992 | * performed with a much lower frequency than it actually is. Obviously, | |
993 | * this will not work for code that depends on a fixed one to one | |
994 | * relationship between the execution counts of the C level garbage | |
995 | * collection hooks and the execution count of the scheme level | |
996 | * after-gc-hook. | |
997 | */ | |
9de87eea | 998 | |
e81d98ec | 999 | #if (SCM_DEBUG_CELL_ACCESSES == 1) |
eab1b259 | 1000 | if (scm_debug_cells_gc_interval == 0) |
e81d98ec DH |
1001 | scm_system_async_mark (gc_async); |
1002 | #else | |
939794ce | 1003 | scm_system_async_mark (gc_async); |
e81d98ec DH |
1004 | #endif |
1005 | ||
939794ce DH |
1006 | return NULL; |
1007 | } | |
1008 | ||
0f2d19dd JB |
1009 | void |
1010 | scm_init_gc () | |
0f2d19dd | 1011 | { |
c8a1bdc4 | 1012 | scm_gc_init_mark (); |
d678e25c | 1013 | |
fde50407 ML |
1014 | scm_after_gc_hook = scm_permanent_object (scm_make_hook (SCM_INUM0)); |
1015 | scm_c_define ("after-gc-hook", scm_after_gc_hook); | |
939794ce | 1016 | |
2592c4c7 MV |
1017 | gc_async = scm_c_make_subr ("%gc-thunk", scm_tc7_subr_0, |
1018 | gc_async_thunk); | |
939794ce DH |
1019 | |
1020 | scm_c_hook_add (&scm_after_gc_c_hook, mark_gc_async, NULL, 0); | |
1021 | ||
a0599745 | 1022 | #include "libguile/gc.x" |
0f2d19dd | 1023 | } |
89e00824 | 1024 | |
c8a1bdc4 HWN |
1025 | |
1026 | void | |
1027 | scm_gc_sweep (void) | |
1028 | #define FUNC_NAME "scm_gc_sweep" | |
1029 | { | |
1030 | scm_i_deprecated_memory_return = 0; | |
1031 | ||
1032 | scm_i_gc_sweep_freelist_reset (&scm_i_master_freelist); | |
1033 | scm_i_gc_sweep_freelist_reset (&scm_i_master_freelist2); | |
1034 | ||
1035 | /* | |
1036 | NOTHING HERE: LAZY SWEEPING ! | |
1037 | */ | |
1038 | scm_i_reset_segments (); | |
1039 | ||
9bc4701c MD |
1040 | *SCM_FREELIST_LOC (scm_i_freelist) = SCM_EOL; |
1041 | *SCM_FREELIST_LOC (scm_i_freelist2) = SCM_EOL; | |
392d2833 MD |
1042 | |
1043 | /* Invalidate the freelists of other threads. */ | |
1044 | scm_i_thread_invalidate_freelists (); | |
c8a1bdc4 HWN |
1045 | } |
1046 | ||
1047 | #undef FUNC_NAME | |
1048 | ||
1049 | ||
56495472 | 1050 | |
89e00824 ML |
1051 | /* |
1052 | Local Variables: | |
1053 | c-file-style: "gnu" | |
1054 | End: | |
1055 | */ |