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