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