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