Commit | Line | Data |
---|---|---|
2b829bbb | 1 | /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006 Free Software Foundation, Inc. |
a00c95d9 | 2 | * |
73be1d9e MV |
3 | * This library is free software; you can redistribute it and/or |
4 | * modify it under the terms of the GNU Lesser General Public | |
5 | * License as published by the Free Software Foundation; either | |
6 | * version 2.1 of the License, or (at your option) any later version. | |
a00c95d9 | 7 | * |
73be1d9e | 8 | * This library is distributed in the hope that it will be useful, |
0f2d19dd | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
73be1d9e MV |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
11 | * Lesser General Public License for more details. | |
a00c95d9 | 12 | * |
73be1d9e MV |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the Free Software | |
92205699 | 15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
73be1d9e | 16 | */ |
1bbd0b84 | 17 | |
9de87eea | 18 | #define _GNU_SOURCE |
1bbd0b84 | 19 | |
37ddcaf6 MD |
20 | /* #define DEBUGINFO */ |
21 | ||
aa54a9b0 RB |
22 | #if HAVE_CONFIG_H |
23 | # include <config.h> | |
24 | #endif | |
56495472 | 25 | |
0f2d19dd | 26 | #include <stdio.h> |
e6e2e95a | 27 | #include <errno.h> |
783e7774 | 28 | #include <string.h> |
c8a1bdc4 | 29 | #include <assert.h> |
e6e2e95a | 30 | |
d9189652 RB |
31 | #ifdef __ia64__ |
32 | #include <ucontext.h> | |
bb1180ef | 33 | extern unsigned long * __libc_ia64_register_backing_store_base; |
d9189652 RB |
34 | #endif |
35 | ||
a0599745 | 36 | #include "libguile/_scm.h" |
0a7a7445 | 37 | #include "libguile/eval.h" |
a0599745 MD |
38 | #include "libguile/stime.h" |
39 | #include "libguile/stackchk.h" | |
40 | #include "libguile/struct.h" | |
a0599745 MD |
41 | #include "libguile/smob.h" |
42 | #include "libguile/unif.h" | |
43 | #include "libguile/async.h" | |
44 | #include "libguile/ports.h" | |
45 | #include "libguile/root.h" | |
46 | #include "libguile/strings.h" | |
47 | #include "libguile/vectors.h" | |
801cb5e7 | 48 | #include "libguile/weaks.h" |
686765af | 49 | #include "libguile/hashtab.h" |
ecf470a2 | 50 | #include "libguile/tags.h" |
a0599745 | 51 | |
c8a1bdc4 | 52 | #include "libguile/private-gc.h" |
a0599745 | 53 | #include "libguile/validate.h" |
1be6b49c | 54 | #include "libguile/deprecation.h" |
a0599745 | 55 | #include "libguile/gc.h" |
9de87eea | 56 | #include "libguile/dynwind.h" |
fce59c93 | 57 | |
a82e7953 LC |
58 | #include <gc/gc.h> |
59 | ||
bc9d9bb2 | 60 | #ifdef GUILE_DEBUG_MALLOC |
a0599745 | 61 | #include "libguile/debug-malloc.h" |
bc9d9bb2 MD |
62 | #endif |
63 | ||
0f2d19dd | 64 | #ifdef HAVE_MALLOC_H |
95b88819 | 65 | #include <malloc.h> |
0f2d19dd JB |
66 | #endif |
67 | ||
68 | #ifdef HAVE_UNISTD_H | |
95b88819 | 69 | #include <unistd.h> |
0f2d19dd JB |
70 | #endif |
71 | ||
fb50ef08 MD |
72 | /* Lock this mutex before doing lazy sweeping. |
73 | */ | |
b17e0ac3 | 74 | scm_i_pthread_mutex_t scm_i_sweep_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER; |
fb50ef08 | 75 | |
eae33935 | 76 | /* Set this to != 0 if every cell that is accessed shall be checked: |
61045190 | 77 | */ |
eab1b259 HWN |
78 | int scm_debug_cell_accesses_p = 0; |
79 | int scm_expensive_debug_cell_accesses_p = 0; | |
406c7d90 | 80 | |
e81d98ec DH |
81 | /* Set this to 0 if no additional gc's shall be performed, otherwise set it to |
82 | * the number of cell accesses after which a gc shall be called. | |
83 | */ | |
eab1b259 | 84 | int scm_debug_cells_gc_interval = 0; |
e81d98ec | 85 | |
eab1b259 HWN |
86 | /* |
87 | Global variable, so you can switch it off at runtime by setting | |
88 | scm_i_cell_validation_already_running. | |
406c7d90 | 89 | */ |
eab1b259 HWN |
90 | int scm_i_cell_validation_already_running ; |
91 | ||
92 | #if (SCM_DEBUG_CELL_ACCESSES == 1) | |
93 | ||
94 | ||
95 | /* | |
96 | ||
97 | Assert that the given object is a valid reference to a valid cell. This | |
98 | test involves to determine whether the object is a cell pointer, whether | |
99 | this pointer actually points into a heap segment and whether the cell | |
100 | pointed to is not a free cell. Further, additional garbage collections may | |
101 | get executed after a user defined number of cell accesses. This helps to | |
102 | find places in the C code where references are dropped for extremely short | |
103 | periods. | |
104 | ||
105 | */ | |
406c7d90 | 106 | void |
eab1b259 | 107 | scm_i_expensive_validation_check (SCM cell) |
406c7d90 | 108 | { |
eab1b259 HWN |
109 | if (!scm_in_heap_p (cell)) |
110 | { | |
111 | fprintf (stderr, "scm_assert_cell_valid: this object does not live in the heap: %lux\n", | |
112 | (unsigned long) SCM_UNPACK (cell)); | |
113 | abort (); | |
114 | } | |
115 | ||
116 | /* If desired, perform additional garbage collections after a user | |
117 | * defined number of cell accesses. | |
118 | */ | |
119 | if (scm_debug_cells_gc_interval) | |
120 | { | |
121 | static unsigned int counter = 0; | |
61045190 | 122 | |
eab1b259 HWN |
123 | if (counter != 0) |
124 | { | |
125 | --counter; | |
126 | } | |
127 | else | |
128 | { | |
129 | counter = scm_debug_cells_gc_interval; | |
b17e0ac3 | 130 | scm_gc (); |
eab1b259 HWN |
131 | } |
132 | } | |
133 | } | |
134 | ||
135 | void | |
136 | scm_assert_cell_valid (SCM cell) | |
137 | { | |
138 | if (!scm_i_cell_validation_already_running && scm_debug_cell_accesses_p) | |
406c7d90 | 139 | { |
eab1b259 | 140 | scm_i_cell_validation_already_running = 1; /* set to avoid recursion */ |
406c7d90 | 141 | |
c8a1bdc4 | 142 | /* |
eab1b259 HWN |
143 | During GC, no user-code should be run, and the guile core |
144 | should use non-protected accessors. | |
145 | */ | |
c8a1bdc4 | 146 | if (scm_gc_running_p) |
eab1b259 | 147 | return; |
c8a1bdc4 HWN |
148 | |
149 | /* | |
eab1b259 HWN |
150 | Only scm_in_heap_p and rescanning the heap is wildly |
151 | expensive. | |
152 | */ | |
153 | if (scm_expensive_debug_cell_accesses_p) | |
154 | scm_i_expensive_validation_check (cell); | |
c8a1bdc4 HWN |
155 | |
156 | if (!SCM_GC_MARK_P (cell)) | |
406c7d90 | 157 | { |
c8a1bdc4 HWN |
158 | fprintf (stderr, |
159 | "scm_assert_cell_valid: this object is unmarked. \n" | |
160 | "It has been garbage-collected in the last GC run: " | |
161 | "%lux\n", | |
1be6b49c | 162 | (unsigned long) SCM_UNPACK (cell)); |
406c7d90 DH |
163 | abort (); |
164 | } | |
c8a1bdc4 | 165 | |
eab1b259 | 166 | scm_i_cell_validation_already_running = 0; /* re-enable */ |
406c7d90 DH |
167 | } |
168 | } | |
169 | ||
170 | ||
eab1b259 | 171 | |
406c7d90 DH |
172 | SCM_DEFINE (scm_set_debug_cell_accesses_x, "set-debug-cell-accesses!", 1, 0, 0, |
173 | (SCM flag), | |
1e6808ea | 174 | "If @var{flag} is @code{#f}, cell access checking is disabled.\n" |
eab1b259 | 175 | "If @var{flag} is @code{#t}, cheap cell access checking is enabled,\n" |
e81d98ec | 176 | "but no additional calls to garbage collection are issued.\n" |
eab1b259 | 177 | "If @var{flag} is a number, strict cell access checking is enabled,\n" |
e81d98ec DH |
178 | "with an additional garbage collection after the given\n" |
179 | "number of cell accesses.\n" | |
1e6808ea MG |
180 | "This procedure only exists when the compile-time flag\n" |
181 | "@code{SCM_DEBUG_CELL_ACCESSES} was set to 1.") | |
406c7d90 DH |
182 | #define FUNC_NAME s_scm_set_debug_cell_accesses_x |
183 | { | |
7888309b | 184 | if (scm_is_false (flag)) |
eab1b259 HWN |
185 | { |
186 | scm_debug_cell_accesses_p = 0; | |
187 | } | |
bc36d050 | 188 | else if (scm_is_eq (flag, SCM_BOOL_T)) |
eab1b259 HWN |
189 | { |
190 | scm_debug_cells_gc_interval = 0; | |
191 | scm_debug_cell_accesses_p = 1; | |
192 | scm_expensive_debug_cell_accesses_p = 0; | |
193 | } | |
e11e83f3 | 194 | else |
eab1b259 | 195 | { |
e11e83f3 | 196 | scm_debug_cells_gc_interval = scm_to_signed_integer (flag, 0, INT_MAX); |
eab1b259 HWN |
197 | scm_debug_cell_accesses_p = 1; |
198 | scm_expensive_debug_cell_accesses_p = 1; | |
199 | } | |
406c7d90 DH |
200 | return SCM_UNSPECIFIED; |
201 | } | |
202 | #undef FUNC_NAME | |
0f2d19dd | 203 | |
ecf470a2 | 204 | |
c8a1bdc4 | 205 | #endif /* SCM_DEBUG_CELL_ACCESSES == 1 */ |
0f2d19dd JB |
206 | |
207 | \f | |
26224b3f LC |
208 | /* Hooks. */ |
209 | scm_t_c_hook scm_before_gc_c_hook; | |
210 | scm_t_c_hook scm_before_mark_c_hook; | |
211 | scm_t_c_hook scm_before_sweep_c_hook; | |
212 | scm_t_c_hook scm_after_sweep_c_hook; | |
213 | scm_t_c_hook scm_after_gc_c_hook; | |
945fec60 | 214 | |
0f2d19dd JB |
215 | |
216 | /* scm_mtrigger | |
539b08a4 | 217 | * is the number of bytes of malloc allocation needed to trigger gc. |
0f2d19dd | 218 | */ |
c014a02e | 219 | unsigned long scm_mtrigger; |
0f2d19dd | 220 | |
0f2d19dd JB |
221 | /* GC Statistics Keeping |
222 | */ | |
f2893a25 | 223 | unsigned long scm_cells_allocated = 0; |
c014a02e ML |
224 | unsigned long scm_mallocated = 0; |
225 | unsigned long scm_gc_cells_collected; | |
c8a1bdc4 | 226 | unsigned long scm_gc_cells_collected_1 = 0; /* previous GC yield */ |
c014a02e ML |
227 | unsigned long scm_gc_malloc_collected; |
228 | unsigned long scm_gc_ports_collected; | |
0f2d19dd | 229 | unsigned long scm_gc_time_taken = 0; |
c014a02e | 230 | static unsigned long t_before_gc; |
c9b0d4b0 | 231 | unsigned long scm_gc_mark_time_taken = 0; |
c014a02e ML |
232 | unsigned long scm_gc_times = 0; |
233 | unsigned long scm_gc_cells_swept = 0; | |
c9b0d4b0 ML |
234 | double scm_gc_cells_marked_acc = 0.; |
235 | double scm_gc_cells_swept_acc = 0.; | |
c2cbcc57 HWN |
236 | int scm_gc_cell_yield_percentage =0; |
237 | int scm_gc_malloc_yield_percentage = 0; | |
915b3f9f LC |
238 | |
239 | static unsigned long protected_obj_count = 0; | |
c2cbcc57 | 240 | |
0f2d19dd JB |
241 | |
242 | SCM_SYMBOL (sym_cells_allocated, "cells-allocated"); | |
915b3f9f LC |
243 | SCM_SYMBOL (sym_heap_size, "heap-size"); |
244 | SCM_SYMBOL (sym_heap_free_size, "heap-free-size"); | |
245 | SCM_SYMBOL (sym_heap_total_allocated, "heap-total-allocated"); | |
0f2d19dd JB |
246 | SCM_SYMBOL (sym_mallocated, "bytes-malloced"); |
247 | SCM_SYMBOL (sym_mtrigger, "gc-malloc-threshold"); | |
248 | SCM_SYMBOL (sym_heap_segments, "cell-heap-segments"); | |
249 | SCM_SYMBOL (sym_gc_time_taken, "gc-time-taken"); | |
c9b0d4b0 | 250 | SCM_SYMBOL (sym_gc_mark_time_taken, "gc-mark-time-taken"); |
c9b0d4b0 ML |
251 | SCM_SYMBOL (sym_times, "gc-times"); |
252 | SCM_SYMBOL (sym_cells_marked, "cells-marked"); | |
253 | SCM_SYMBOL (sym_cells_swept, "cells-swept"); | |
c2cbcc57 HWN |
254 | SCM_SYMBOL (sym_malloc_yield, "malloc-yield"); |
255 | SCM_SYMBOL (sym_cell_yield, "cell-yield"); | |
7eec4c37 | 256 | SCM_SYMBOL (sym_protected_objects, "protected-objects"); |
0f2d19dd | 257 | |
bb2c57fa | 258 | |
cf2d30f6 | 259 | |
d3dd80ab | 260 | |
cf2d30f6 | 261 | /* Number of calls to SCM_NEWCELL since startup. */ |
c8a1bdc4 HWN |
262 | unsigned scm_newcell_count; |
263 | unsigned scm_newcell2_count; | |
b37fe1c5 | 264 | |
b37fe1c5 | 265 | |
0f2d19dd JB |
266 | /* {Scheme Interface to GC} |
267 | */ | |
1367aa5e HWN |
268 | static SCM |
269 | tag_table_to_type_alist (void *closure, SCM key, SCM val, SCM acc) | |
270 | { | |
8fecbb19 | 271 | if (scm_is_integer (key)) |
8a00ba71 | 272 | { |
3e2073bd | 273 | int c_tag = scm_to_int (key); |
8fecbb19 HWN |
274 | |
275 | char const * name = scm_i_tag_name (c_tag); | |
276 | if (name != NULL) | |
277 | { | |
278 | key = scm_from_locale_string (name); | |
279 | } | |
280 | else | |
281 | { | |
282 | char s[100]; | |
283 | sprintf (s, "tag %d", c_tag); | |
284 | key = scm_from_locale_string (s); | |
285 | } | |
8a00ba71 | 286 | } |
8fecbb19 | 287 | |
1367aa5e HWN |
288 | return scm_cons (scm_cons (key, val), acc); |
289 | } | |
290 | ||
291 | SCM_DEFINE (scm_gc_live_object_stats, "gc-live-object-stats", 0, 0, 0, | |
292 | (), | |
293 | "Return an alist of statistics of the current live objects. ") | |
294 | #define FUNC_NAME s_scm_gc_live_object_stats | |
295 | { | |
296 | SCM tab = scm_make_hash_table (scm_from_int (57)); | |
b01532af NJ |
297 | SCM alist; |
298 | ||
b01532af | 299 | alist |
1367aa5e HWN |
300 | = scm_internal_hash_fold (&tag_table_to_type_alist, NULL, SCM_EOL, tab); |
301 | ||
302 | return alist; | |
303 | } | |
304 | #undef FUNC_NAME | |
305 | ||
c2cbcc57 | 306 | extern int scm_gc_malloc_yield_percentage; |
a00c95d9 | 307 | SCM_DEFINE (scm_gc_stats, "gc-stats", 0, 0, 0, |
1bbd0b84 | 308 | (), |
1e6808ea | 309 | "Return an association list of statistics about Guile's current\n" |
c8a1bdc4 | 310 | "use of storage.\n") |
1bbd0b84 | 311 | #define FUNC_NAME s_scm_gc_stats |
0f2d19dd | 312 | { |
0f2d19dd | 313 | SCM answer; |
915b3f9f LC |
314 | size_t heap_size, free_bytes, bytes_since_gc, total_bytes; |
315 | size_t gc_times; | |
4c9419ac | 316 | |
915b3f9f LC |
317 | heap_size = GC_get_heap_size (); |
318 | free_bytes = GC_get_free_bytes (); | |
319 | bytes_since_gc = GC_get_bytes_since_gc (); | |
320 | total_bytes = GC_get_total_bytes (); | |
321 | gc_times = GC_gc_no; | |
fca43887 | 322 | |
33b320ae NJ |
323 | /* njrev: can any of these scm_cons's or scm_list_n signal a memory |
324 | error? If so we need a frame here. */ | |
b9bd8526 | 325 | answer = |
915b3f9f LC |
326 | scm_list_n (scm_cons (sym_gc_time_taken, SCM_INUM0), |
327 | #if 0 | |
b9bd8526 MV |
328 | scm_cons (sym_cells_allocated, |
329 | scm_from_ulong (local_scm_cells_allocated)), | |
b9bd8526 MV |
330 | scm_cons (sym_mallocated, |
331 | scm_from_ulong (local_scm_mallocated)), | |
332 | scm_cons (sym_mtrigger, | |
333 | scm_from_ulong (local_scm_mtrigger)), | |
b9bd8526 MV |
334 | scm_cons (sym_gc_mark_time_taken, |
335 | scm_from_ulong (local_scm_gc_mark_time_taken)), | |
336 | scm_cons (sym_cells_marked, | |
337 | scm_from_double (local_scm_gc_cells_marked)), | |
338 | scm_cons (sym_cells_swept, | |
339 | scm_from_double (local_scm_gc_cells_swept)), | |
340 | scm_cons (sym_malloc_yield, | |
341 | scm_from_long(local_scm_gc_malloc_yield_percentage)), | |
342 | scm_cons (sym_cell_yield, | |
343 | scm_from_long (local_scm_gc_cell_yield_percentage)), | |
b9bd8526 | 344 | scm_cons (sym_heap_segments, heap_segs), |
915b3f9f LC |
345 | #endif |
346 | scm_cons (sym_heap_size, scm_from_size_t (heap_size)), | |
347 | scm_cons (sym_heap_free_size, scm_from_size_t (free_bytes)), | |
348 | scm_cons (sym_heap_total_allocated, | |
349 | scm_from_size_t (total_bytes)), | |
350 | scm_cons (sym_protected_objects, | |
351 | scm_from_ulong (protected_obj_count)), | |
352 | scm_cons (sym_times, scm_from_size_t (gc_times)), | |
b9bd8526 | 353 | SCM_UNDEFINED); |
fca43887 | 354 | |
c8a1bdc4 | 355 | return answer; |
0f2d19dd | 356 | } |
c8a1bdc4 | 357 | #undef FUNC_NAME |
0f2d19dd | 358 | |
539b08a4 | 359 | |
acf4331f | 360 | |
0f2d19dd | 361 | |
c8a1bdc4 HWN |
362 | SCM_DEFINE (scm_object_address, "object-address", 1, 0, 0, |
363 | (SCM obj), | |
364 | "Return an integer that for the lifetime of @var{obj} is uniquely\n" | |
365 | "returned by this function for @var{obj}") | |
366 | #define FUNC_NAME s_scm_object_address | |
c68296f8 | 367 | { |
b9bd8526 | 368 | return scm_from_ulong (SCM_UNPACK (obj)); |
c68296f8 | 369 | } |
c8a1bdc4 | 370 | #undef FUNC_NAME |
c68296f8 | 371 | |
1be6b49c | 372 | |
915b3f9f LC |
373 | SCM_DEFINE (scm_gc_disable, "gc-disable", 0, 0, 0, |
374 | (), | |
375 | "Disables the garbage collector. Nested calls are permitted. " | |
376 | "GC is re-enabled once @code{gc-enable} has been called the " | |
377 | "same number of times @code{gc-disable} was called.") | |
378 | #define FUNC_NAME s_scm_gc_disable | |
379 | { | |
380 | GC_disable (); | |
381 | return SCM_UNSPECIFIED; | |
382 | } | |
383 | #undef FUNC_NAME | |
384 | ||
385 | SCM_DEFINE (scm_gc_enable, "gc-enable", 0, 0, 0, | |
386 | (), | |
387 | "Enables the garbage collector.") | |
388 | #define FUNC_NAME s_scm_gc_enable | |
389 | { | |
390 | GC_enable (); | |
391 | return SCM_UNSPECIFIED; | |
392 | } | |
393 | #undef FUNC_NAME | |
394 | ||
395 | ||
c8a1bdc4 HWN |
396 | SCM_DEFINE (scm_gc, "gc", 0, 0, 0, |
397 | (), | |
398 | "Scans all of SCM objects and reclaims for further use those that are\n" | |
399 | "no longer accessible.") | |
400 | #define FUNC_NAME s_scm_gc | |
401 | { | |
b17e0ac3 MV |
402 | scm_i_scm_pthread_mutex_lock (&scm_i_sweep_mutex); |
403 | scm_gc_running_p = 1; | |
404 | scm_i_gc ("call"); | |
33b320ae NJ |
405 | /* njrev: It looks as though other places, e.g. scm_realloc, |
406 | can call scm_i_gc without acquiring the sweep mutex. Does this | |
407 | matter? Also scm_i_gc (or its descendants) touch the | |
408 | scm_sys_protects, which are protected in some cases | |
409 | (e.g. scm_permobjs above in scm_gc_stats) by a critical section, | |
410 | not by the sweep mutex. Shouldn't all the GC-relevant objects be | |
411 | protected in the same way? */ | |
b17e0ac3 MV |
412 | scm_gc_running_p = 0; |
413 | scm_i_pthread_mutex_unlock (&scm_i_sweep_mutex); | |
414 | scm_c_hook_run (&scm_after_gc_c_hook, 0); | |
c8a1bdc4 | 415 | return SCM_UNSPECIFIED; |
9d47a1e6 | 416 | } |
c8a1bdc4 | 417 | #undef FUNC_NAME |
9d47a1e6 | 418 | |
c8a1bdc4 | 419 | void |
b17e0ac3 | 420 | scm_i_gc (const char *what) |
c8a1bdc4 | 421 | { |
26224b3f | 422 | GC_gcollect (); |
eab1b259 | 423 | } |
0f2d19dd | 424 | |
4c7016dc | 425 | |
0f2d19dd JB |
426 | \f |
427 | /* {GC Protection Helper Functions} | |
428 | */ | |
429 | ||
430 | ||
5d2b97cd DH |
431 | /* |
432 | * If within a function you need to protect one or more scheme objects from | |
433 | * garbage collection, pass them as parameters to one of the | |
434 | * scm_remember_upto_here* functions below. These functions don't do | |
435 | * anything, but since the compiler does not know that they are actually | |
436 | * no-ops, it will generate code that calls these functions with the given | |
437 | * parameters. Therefore, you can be sure that the compiler will keep those | |
438 | * scheme values alive (on the stack or in a register) up to the point where | |
439 | * scm_remember_upto_here* is called. In other words, place the call to | |
592996c9 | 440 | * scm_remember_upto_here* _behind_ the last code in your function, that |
5d2b97cd DH |
441 | * depends on the scheme object to exist. |
442 | * | |
8c494e99 DH |
443 | * Example: We want to make sure that the string object str does not get |
444 | * garbage collected during the execution of 'some_function' in the code | |
445 | * below, because otherwise the characters belonging to str would be freed and | |
5d2b97cd DH |
446 | * 'some_function' might access freed memory. To make sure that the compiler |
447 | * keeps str alive on the stack or in a register such that it is visible to | |
448 | * the conservative gc we add the call to scm_remember_upto_here_1 _after_ the | |
449 | * call to 'some_function'. Note that this would not be necessary if str was | |
450 | * used anyway after the call to 'some_function'. | |
eb01cb64 | 451 | * char *chars = scm_i_string_chars (str); |
5d2b97cd DH |
452 | * some_function (chars); |
453 | * scm_remember_upto_here_1 (str); // str will be alive up to this point. | |
454 | */ | |
455 | ||
9e1569bd KR |
456 | /* Remove any macro versions of these while defining the functions. |
457 | Functions are always included in the library, for upward binary | |
458 | compatibility and in case combinations of GCC and non-GCC are used. */ | |
459 | #undef scm_remember_upto_here_1 | |
460 | #undef scm_remember_upto_here_2 | |
461 | ||
5d2b97cd | 462 | void |
e81d98ec | 463 | scm_remember_upto_here_1 (SCM obj SCM_UNUSED) |
5d2b97cd DH |
464 | { |
465 | /* Empty. Protects a single object from garbage collection. */ | |
466 | } | |
467 | ||
468 | void | |
e81d98ec | 469 | scm_remember_upto_here_2 (SCM obj1 SCM_UNUSED, SCM obj2 SCM_UNUSED) |
5d2b97cd DH |
470 | { |
471 | /* Empty. Protects two objects from garbage collection. */ | |
472 | } | |
473 | ||
474 | void | |
e81d98ec | 475 | scm_remember_upto_here (SCM obj SCM_UNUSED, ...) |
5d2b97cd DH |
476 | { |
477 | /* Empty. Protects any number of objects from garbage collection. */ | |
478 | } | |
479 | ||
c209c88e | 480 | /* |
41b0806d GB |
481 | These crazy functions prevent garbage collection |
482 | of arguments after the first argument by | |
483 | ensuring they remain live throughout the | |
484 | function because they are used in the last | |
485 | line of the code block. | |
486 | It'd be better to have a nice compiler hint to | |
487 | aid the conservative stack-scanning GC. --03/09/00 gjb */ | |
0f2d19dd JB |
488 | SCM |
489 | scm_return_first (SCM elt, ...) | |
0f2d19dd JB |
490 | { |
491 | return elt; | |
492 | } | |
493 | ||
41b0806d GB |
494 | int |
495 | scm_return_first_int (int i, ...) | |
496 | { | |
497 | return i; | |
498 | } | |
499 | ||
0f2d19dd | 500 | |
0f2d19dd | 501 | SCM |
6e8d25a6 | 502 | scm_permanent_object (SCM obj) |
0f2d19dd | 503 | { |
9de87eea MV |
504 | SCM cell = scm_cons (obj, SCM_EOL); |
505 | SCM_CRITICAL_SECTION_START; | |
506 | SCM_SETCDR (cell, scm_permobjs); | |
507 | scm_permobjs = cell; | |
508 | SCM_CRITICAL_SECTION_END; | |
0f2d19dd JB |
509 | return obj; |
510 | } | |
511 | ||
512 | ||
7bd4fbe2 MD |
513 | /* Protect OBJ from the garbage collector. OBJ will not be freed, even if all |
514 | other references are dropped, until the object is unprotected by calling | |
6b1b030e | 515 | scm_gc_unprotect_object (OBJ). Calls to scm_gc_protect/unprotect_object nest, |
7bd4fbe2 MD |
516 | i. e. it is possible to protect the same object several times, but it is |
517 | necessary to unprotect the object the same number of times to actually get | |
518 | the object unprotected. It is an error to unprotect an object more often | |
519 | than it has been protected before. The function scm_protect_object returns | |
520 | OBJ. | |
521 | */ | |
522 | ||
523 | /* Implementation note: For every object X, there is a counter which | |
6b1b030e | 524 | scm_gc_protect_object(X) increments and scm_gc_unprotect_object(X) decrements. |
7bd4fbe2 | 525 | */ |
686765af | 526 | |
7eec4c37 HWN |
527 | |
528 | ||
ef290276 | 529 | SCM |
6b1b030e | 530 | scm_gc_protect_object (SCM obj) |
ef290276 | 531 | { |
686765af | 532 | SCM handle; |
9d47a1e6 | 533 | |
686765af | 534 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae NJ |
535 | /* njrev: Indeed; if my comment above is correct, there is the same |
536 | critsec/mutex inconsistency here. */ | |
9de87eea | 537 | SCM_CRITICAL_SECTION_START; |
9d47a1e6 | 538 | |
e11e83f3 MV |
539 | handle = scm_hashq_create_handle_x (scm_protects, obj, scm_from_int (0)); |
540 | SCM_SETCDR (handle, scm_sum (SCM_CDR (handle), scm_from_int (1))); | |
9d47a1e6 | 541 | |
7eec4c37 HWN |
542 | protected_obj_count ++; |
543 | ||
9de87eea | 544 | SCM_CRITICAL_SECTION_END; |
9d47a1e6 | 545 | |
ef290276 JB |
546 | return obj; |
547 | } | |
548 | ||
549 | ||
550 | /* Remove any protection for OBJ established by a prior call to | |
dab7f566 | 551 | scm_protect_object. This function returns OBJ. |
ef290276 | 552 | |
dab7f566 | 553 | See scm_protect_object for more information. */ |
ef290276 | 554 | SCM |
6b1b030e | 555 | scm_gc_unprotect_object (SCM obj) |
ef290276 | 556 | { |
686765af | 557 | SCM handle; |
9d47a1e6 | 558 | |
686765af | 559 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae | 560 | /* njrev: and again. */ |
9de87eea | 561 | SCM_CRITICAL_SECTION_START; |
9d47a1e6 | 562 | |
0ff7e3ff HWN |
563 | if (scm_gc_running_p) |
564 | { | |
565 | fprintf (stderr, "scm_unprotect_object called during GC.\n"); | |
566 | abort (); | |
567 | } | |
b17e0ac3 | 568 | |
686765af | 569 | handle = scm_hashq_get_handle (scm_protects, obj); |
9d47a1e6 | 570 | |
7888309b | 571 | if (scm_is_false (handle)) |
686765af | 572 | { |
0f0f0899 MD |
573 | fprintf (stderr, "scm_unprotect_object called on unprotected object\n"); |
574 | abort (); | |
686765af | 575 | } |
6a199940 DH |
576 | else |
577 | { | |
e11e83f3 | 578 | SCM count = scm_difference (SCM_CDR (handle), scm_from_int (1)); |
bc36d050 | 579 | if (scm_is_eq (count, scm_from_int (0))) |
6a199940 DH |
580 | scm_hashq_remove_x (scm_protects, obj); |
581 | else | |
1be6b49c | 582 | SCM_SETCDR (handle, count); |
6a199940 | 583 | } |
7eec4c37 | 584 | protected_obj_count --; |
686765af | 585 | |
9de87eea | 586 | SCM_CRITICAL_SECTION_END; |
ef290276 JB |
587 | |
588 | return obj; | |
589 | } | |
590 | ||
6b1b030e ML |
591 | void |
592 | scm_gc_register_root (SCM *p) | |
593 | { | |
594 | SCM handle; | |
b9bd8526 | 595 | SCM key = scm_from_ulong ((unsigned long) p); |
eae33935 | 596 | |
6b1b030e | 597 | /* This critical section barrier will be replaced by a mutex. */ |
33b320ae | 598 | /* njrev: and again. */ |
9de87eea | 599 | SCM_CRITICAL_SECTION_START; |
6b1b030e | 600 | |
e11e83f3 MV |
601 | handle = scm_hashv_create_handle_x (scm_gc_registered_roots, key, |
602 | scm_from_int (0)); | |
33b320ae | 603 | /* njrev: note also that the above can probably signal an error */ |
e11e83f3 | 604 | SCM_SETCDR (handle, scm_sum (SCM_CDR (handle), scm_from_int (1))); |
6b1b030e | 605 | |
9de87eea | 606 | SCM_CRITICAL_SECTION_END; |
6b1b030e ML |
607 | } |
608 | ||
609 | void | |
610 | scm_gc_unregister_root (SCM *p) | |
611 | { | |
612 | SCM handle; | |
b9bd8526 | 613 | SCM key = scm_from_ulong ((unsigned long) p); |
6b1b030e ML |
614 | |
615 | /* This critical section barrier will be replaced by a mutex. */ | |
33b320ae | 616 | /* njrev: and again. */ |
9de87eea | 617 | SCM_CRITICAL_SECTION_START; |
6b1b030e ML |
618 | |
619 | handle = scm_hashv_get_handle (scm_gc_registered_roots, key); | |
620 | ||
7888309b | 621 | if (scm_is_false (handle)) |
6b1b030e ML |
622 | { |
623 | fprintf (stderr, "scm_gc_unregister_root called on unregistered root\n"); | |
624 | abort (); | |
625 | } | |
626 | else | |
627 | { | |
e11e83f3 | 628 | SCM count = scm_difference (SCM_CDR (handle), scm_from_int (1)); |
bc36d050 | 629 | if (scm_is_eq (count, scm_from_int (0))) |
6b1b030e ML |
630 | scm_hashv_remove_x (scm_gc_registered_roots, key); |
631 | else | |
632 | SCM_SETCDR (handle, count); | |
633 | } | |
634 | ||
9de87eea | 635 | SCM_CRITICAL_SECTION_END; |
6b1b030e ML |
636 | } |
637 | ||
638 | void | |
639 | scm_gc_register_roots (SCM *b, unsigned long n) | |
640 | { | |
641 | SCM *p = b; | |
642 | for (; p < b + n; ++p) | |
643 | scm_gc_register_root (p); | |
644 | } | |
645 | ||
646 | void | |
647 | scm_gc_unregister_roots (SCM *b, unsigned long n) | |
648 | { | |
649 | SCM *p = b; | |
650 | for (; p < b + n; ++p) | |
651 | scm_gc_unregister_root (p); | |
652 | } | |
653 | ||
04a98cff | 654 | int scm_i_terminating; |
c45acc34 | 655 | |
0f2d19dd | 656 | \f |
a00c95d9 | 657 | |
4c48ba06 | 658 | |
c8a1bdc4 HWN |
659 | /* |
660 | MOVE THIS FUNCTION. IT DOES NOT HAVE ANYTHING TODO WITH GC. | |
661 | */ | |
85db4a2c DH |
662 | |
663 | /* Get an integer from an environment variable. */ | |
c8a1bdc4 HWN |
664 | int |
665 | scm_getenv_int (const char *var, int def) | |
85db4a2c | 666 | { |
c8a1bdc4 HWN |
667 | char *end = 0; |
668 | char *val = getenv (var); | |
669 | long res = def; | |
85db4a2c DH |
670 | if (!val) |
671 | return def; | |
672 | res = strtol (val, &end, 10); | |
673 | if (end == val) | |
674 | return def; | |
675 | return res; | |
676 | } | |
677 | ||
c35738c1 MD |
678 | void |
679 | scm_storage_prehistory () | |
680 | { | |
a82e7953 | 681 | GC_INIT (); |
915b3f9f LC |
682 | |
683 | /* Sanity check. */ | |
684 | if (!GC_is_visible (scm_sys_protects)) | |
685 | abort (); | |
a82e7953 | 686 | |
c35738c1 MD |
687 | scm_c_hook_init (&scm_before_gc_c_hook, 0, SCM_C_HOOK_NORMAL); |
688 | scm_c_hook_init (&scm_before_mark_c_hook, 0, SCM_C_HOOK_NORMAL); | |
689 | scm_c_hook_init (&scm_before_sweep_c_hook, 0, SCM_C_HOOK_NORMAL); | |
690 | scm_c_hook_init (&scm_after_sweep_c_hook, 0, SCM_C_HOOK_NORMAL); | |
691 | scm_c_hook_init (&scm_after_gc_c_hook, 0, SCM_C_HOOK_NORMAL); | |
692 | } | |
85db4a2c | 693 | |
9de87eea | 694 | scm_i_pthread_mutex_t scm_i_gc_admin_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER; |
eb01cb64 | 695 | |
4a4c9785 | 696 | int |
85db4a2c | 697 | scm_init_storage () |
0f2d19dd | 698 | { |
1be6b49c | 699 | size_t j; |
0f2d19dd JB |
700 | |
701 | j = SCM_NUM_PROTECTS; | |
702 | while (j) | |
703 | scm_sys_protects[--j] = SCM_BOOL_F; | |
4a4c9785 | 704 | |
0f2d19dd | 705 | j = SCM_HEAP_SEG_SIZE; |
d6884e63 | 706 | |
9de87eea MV |
707 | #if 0 |
708 | /* We can't have a cleanup handler since we have no thread to run it | |
709 | in. */ | |
710 | ||
a18bcd0e | 711 | #ifdef HAVE_ATEXIT |
c45acc34 | 712 | atexit (cleanup); |
e52ceaac MD |
713 | #else |
714 | #ifdef HAVE_ON_EXIT | |
715 | on_exit (cleanup, 0); | |
716 | #endif | |
9de87eea MV |
717 | #endif |
718 | ||
a18bcd0e | 719 | #endif |
0f2d19dd | 720 | |
e4da0740 | 721 | scm_stand_in_procs = scm_make_weak_key_hash_table (scm_from_int (257)); |
0f2d19dd | 722 | scm_permobjs = SCM_EOL; |
00ffa0e7 | 723 | scm_protects = scm_c_make_hash_table (31); |
6b1b030e | 724 | scm_gc_registered_roots = scm_c_make_hash_table (31); |
d6884e63 | 725 | |
0f2d19dd JB |
726 | return 0; |
727 | } | |
939794ce | 728 | |
0f2d19dd JB |
729 | \f |
730 | ||
939794ce DH |
731 | SCM scm_after_gc_hook; |
732 | ||
939794ce DH |
733 | static SCM gc_async; |
734 | ||
939794ce DH |
735 | /* The function gc_async_thunk causes the execution of the after-gc-hook. It |
736 | * is run after the gc, as soon as the asynchronous events are handled by the | |
737 | * evaluator. | |
738 | */ | |
739 | static SCM | |
740 | gc_async_thunk (void) | |
741 | { | |
742 | scm_c_run_hook (scm_after_gc_hook, SCM_EOL); | |
939794ce DH |
743 | return SCM_UNSPECIFIED; |
744 | } | |
745 | ||
746 | ||
747 | /* The function mark_gc_async is run by the scm_after_gc_c_hook at the end of | |
748 | * the garbage collection. The only purpose of this function is to mark the | |
749 | * gc_async (which will eventually lead to the execution of the | |
750 | * gc_async_thunk). | |
751 | */ | |
752 | static void * | |
e81d98ec DH |
753 | mark_gc_async (void * hook_data SCM_UNUSED, |
754 | void *func_data SCM_UNUSED, | |
755 | void *data SCM_UNUSED) | |
756 | { | |
757 | /* If cell access debugging is enabled, the user may choose to perform | |
758 | * additional garbage collections after an arbitrary number of cell | |
759 | * accesses. We don't want the scheme level after-gc-hook to be performed | |
760 | * for each of these garbage collections for the following reason: The | |
761 | * execution of the after-gc-hook causes cell accesses itself. Thus, if the | |
762 | * after-gc-hook was performed with every gc, and if the gc was performed | |
763 | * after a very small number of cell accesses, then the number of cell | |
764 | * accesses during the execution of the after-gc-hook will suffice to cause | |
765 | * the execution of the next gc. Then, guile would keep executing the | |
766 | * after-gc-hook over and over again, and would never come to do other | |
767 | * things. | |
eae33935 | 768 | * |
e81d98ec DH |
769 | * To overcome this problem, if cell access debugging with additional |
770 | * garbage collections is enabled, the after-gc-hook is never run by the | |
771 | * garbage collecter. When running guile with cell access debugging and the | |
772 | * execution of the after-gc-hook is desired, then it is necessary to run | |
773 | * the hook explicitly from the user code. This has the effect, that from | |
774 | * the scheme level point of view it seems that garbage collection is | |
775 | * performed with a much lower frequency than it actually is. Obviously, | |
776 | * this will not work for code that depends on a fixed one to one | |
777 | * relationship between the execution counts of the C level garbage | |
778 | * collection hooks and the execution count of the scheme level | |
779 | * after-gc-hook. | |
780 | */ | |
9de87eea | 781 | |
e81d98ec | 782 | #if (SCM_DEBUG_CELL_ACCESSES == 1) |
eab1b259 | 783 | if (scm_debug_cells_gc_interval == 0) |
e81d98ec DH |
784 | scm_system_async_mark (gc_async); |
785 | #else | |
939794ce | 786 | scm_system_async_mark (gc_async); |
e81d98ec DH |
787 | #endif |
788 | ||
939794ce DH |
789 | return NULL; |
790 | } | |
791 | ||
26224b3f LC |
792 | char const * |
793 | scm_i_tag_name (scm_t_bits tag) | |
794 | { | |
795 | if (tag >= 255) | |
796 | { | |
797 | if (tag == scm_tc_free_cell) | |
798 | return "free cell"; | |
799 | ||
800 | { | |
801 | int k = 0xff & (tag >> 8); | |
802 | return (scm_smobs[k].name); | |
803 | } | |
804 | } | |
805 | ||
806 | switch (tag) /* 7 bits */ | |
807 | { | |
808 | case scm_tcs_struct: | |
809 | return "struct"; | |
810 | case scm_tcs_cons_imcar: | |
811 | return "cons (immediate car)"; | |
812 | case scm_tcs_cons_nimcar: | |
813 | return "cons (non-immediate car)"; | |
814 | case scm_tcs_closures: | |
815 | return "closures"; | |
816 | case scm_tc7_pws: | |
817 | return "pws"; | |
818 | case scm_tc7_wvect: | |
819 | return "weak vector"; | |
820 | case scm_tc7_vector: | |
821 | return "vector"; | |
822 | #ifdef CCLO | |
823 | case scm_tc7_cclo: | |
824 | return "compiled closure"; | |
825 | #endif | |
826 | case scm_tc7_number: | |
827 | switch (tag) | |
828 | { | |
829 | case scm_tc16_real: | |
830 | return "real"; | |
831 | break; | |
832 | case scm_tc16_big: | |
833 | return "bignum"; | |
834 | break; | |
835 | case scm_tc16_complex: | |
836 | return "complex number"; | |
837 | break; | |
838 | case scm_tc16_fraction: | |
839 | return "fraction"; | |
840 | break; | |
841 | } | |
842 | break; | |
843 | case scm_tc7_string: | |
844 | return "string"; | |
845 | break; | |
846 | case scm_tc7_stringbuf: | |
847 | return "string buffer"; | |
848 | break; | |
849 | case scm_tc7_symbol: | |
850 | return "symbol"; | |
851 | break; | |
852 | case scm_tc7_variable: | |
853 | return "variable"; | |
854 | break; | |
855 | case scm_tcs_subrs: | |
856 | return "subrs"; | |
857 | break; | |
858 | case scm_tc7_port: | |
859 | return "port"; | |
860 | break; | |
861 | case scm_tc7_smob: | |
862 | return "smob"; /* should not occur. */ | |
863 | break; | |
864 | } | |
865 | ||
866 | return NULL; | |
867 | } | |
868 | ||
869 | ||
26224b3f LC |
870 | |
871 | \f | |
0f2d19dd JB |
872 | void |
873 | scm_init_gc () | |
0f2d19dd | 874 | { |
a82e7953 | 875 | /* `GC_INIT ()' was invoked in `scm_storage_prehistory ()'. */ |
d678e25c | 876 | |
fde50407 ML |
877 | scm_after_gc_hook = scm_permanent_object (scm_make_hook (SCM_INUM0)); |
878 | scm_c_define ("after-gc-hook", scm_after_gc_hook); | |
939794ce | 879 | |
2592c4c7 MV |
880 | gc_async = scm_c_make_subr ("%gc-thunk", scm_tc7_subr_0, |
881 | gc_async_thunk); | |
939794ce DH |
882 | |
883 | scm_c_hook_add (&scm_after_gc_c_hook, mark_gc_async, NULL, 0); | |
884 | ||
a0599745 | 885 | #include "libguile/gc.x" |
0f2d19dd | 886 | } |
89e00824 | 887 | |
c8a1bdc4 HWN |
888 | |
889 | void | |
890 | scm_gc_sweep (void) | |
891 | #define FUNC_NAME "scm_gc_sweep" | |
892 | { | |
26224b3f LC |
893 | /* FIXME */ |
894 | fprintf (stderr, "%s: doing nothing\n", __FUNCTION__); | |
c8a1bdc4 HWN |
895 | } |
896 | ||
897 | #undef FUNC_NAME | |
898 | ||
899 | ||
56495472 | 900 | |
89e00824 ML |
901 | /* |
902 | Local Variables: | |
903 | c-file-style: "gnu" | |
904 | End: | |
905 | */ |