degenerate let forms
[bpt/guile.git] / libguile / gc.c
CommitLineData
0f595d7d 1/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006,
0320b1fc 2 * 2008, 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
a00c95d9 3 *
73be1d9e 4 * This library is free software; you can redistribute it and/or
53befeb7
NJ
5 * modify it under the terms of the GNU Lesser General Public License
6 * as published by the Free Software Foundation; either version 3 of
7 * the License, or (at your option) any later version.
a00c95d9 8 *
53befeb7
NJ
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e
MV
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
a00c95d9 13 *
73be1d9e
MV
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
53befeb7
NJ
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 * 02110-1301 USA
73be1d9e 18 */
1bbd0b84 19
37ddcaf6
MD
20/* #define DEBUGINFO */
21
dbb605f5 22#ifdef HAVE_CONFIG_H
aa54a9b0
RB
23# include <config.h>
24#endif
56495472 25
e7bca227
LC
26#include "libguile/gen-scmconfig.h"
27
0f2d19dd 28#include <stdio.h>
e6e2e95a 29#include <errno.h>
783e7774 30#include <string.h>
34cf38c3 31#include <stdlib.h>
6360beb2 32#include <math.h>
e6e2e95a 33
3ec17f28
LC
34#ifdef __ia64__
35#include <ucontext.h>
36extern unsigned long * __libc_ia64_register_backing_store_base;
37#endif
38
a0599745 39#include "libguile/_scm.h"
0a7a7445 40#include "libguile/eval.h"
a0599745
MD
41#include "libguile/stime.h"
42#include "libguile/stackchk.h"
43#include "libguile/struct.h"
a0599745 44#include "libguile/smob.h"
2fa901a5 45#include "libguile/arrays.h"
a0599745
MD
46#include "libguile/async.h"
47#include "libguile/ports.h"
48#include "libguile/root.h"
87fc4596 49#include "libguile/simpos.h"
a0599745
MD
50#include "libguile/strings.h"
51#include "libguile/vectors.h"
686765af 52#include "libguile/hashtab.h"
ecf470a2 53#include "libguile/tags.h"
a0599745
MD
54
55#include "libguile/validate.h"
1be6b49c 56#include "libguile/deprecation.h"
a0599745 57#include "libguile/gc.h"
9de87eea 58#include "libguile/dynwind.h"
fce59c93 59
1c44468d 60#include "libguile/bdw-gc.h"
a82e7953 61
cc3546b0
AW
62/* For GC_set_start_callback. */
63#include <gc/gc_mark.h>
64
bc9d9bb2 65#ifdef GUILE_DEBUG_MALLOC
a0599745 66#include "libguile/debug-malloc.h"
bc9d9bb2
MD
67#endif
68
95b88819 69#include <unistd.h>
0f2d19dd 70
064d2409
AW
71/* Size in bytes of the initial heap. This should be about the size of
72 result of 'guile -c "(display (assq-ref (gc-stats)
73 'heap-total-allocated))"'. */
74
75#define DEFAULT_INITIAL_HEAP_SIZE (128 * 1024 * SIZEOF_SCM_T_BITS)
76
eae33935 77/* Set this to != 0 if every cell that is accessed shall be checked:
61045190 78 */
eab1b259
HWN
79int scm_debug_cell_accesses_p = 0;
80int scm_expensive_debug_cell_accesses_p = 0;
406c7d90 81
e81d98ec
DH
82/* Set this to 0 if no additional gc's shall be performed, otherwise set it to
83 * the number of cell accesses after which a gc shall be called.
84 */
eab1b259 85int scm_debug_cells_gc_interval = 0;
e81d98ec 86
acbccb0c 87/* Hash table that keeps a reference to objects the user wants to protect from
fbe1cb7f
AW
88 garbage collection. */
89static SCM scm_protects;
e7efe8e7
AW
90
91
eab1b259
HWN
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 106void
eab1b259 107scm_i_expensive_validation_check (SCM cell)
406c7d90 108{
eab1b259
HWN
109 /* If desired, perform additional garbage collections after a user
110 * defined number of cell accesses.
111 */
112 if (scm_debug_cells_gc_interval)
113 {
114 static unsigned int counter = 0;
61045190 115
eab1b259
HWN
116 if (counter != 0)
117 {
118 --counter;
119 }
120 else
121 {
122 counter = scm_debug_cells_gc_interval;
b17e0ac3 123 scm_gc ();
eab1b259
HWN
124 }
125 }
126}
127
8c93b597
LC
128/* Whether cell validation is already running. */
129static int scm_i_cell_validation_already_running = 0;
130
eab1b259
HWN
131void
132scm_assert_cell_valid (SCM cell)
133{
134 if (!scm_i_cell_validation_already_running && scm_debug_cell_accesses_p)
406c7d90 135 {
eab1b259 136 scm_i_cell_validation_already_running = 1; /* set to avoid recursion */
406c7d90 137
c8a1bdc4 138 /*
eab1b259
HWN
139 During GC, no user-code should be run, and the guile core
140 should use non-protected accessors.
141 */
c8a1bdc4 142 if (scm_gc_running_p)
eab1b259 143 return;
c8a1bdc4
HWN
144
145 /*
eab1b259
HWN
146 Only scm_in_heap_p and rescanning the heap is wildly
147 expensive.
148 */
149 if (scm_expensive_debug_cell_accesses_p)
150 scm_i_expensive_validation_check (cell);
b4246e5b 151
eab1b259 152 scm_i_cell_validation_already_running = 0; /* re-enable */
406c7d90
DH
153 }
154}
155
156
eab1b259 157
406c7d90
DH
158SCM_DEFINE (scm_set_debug_cell_accesses_x, "set-debug-cell-accesses!", 1, 0, 0,
159 (SCM flag),
1e6808ea 160 "If @var{flag} is @code{#f}, cell access checking is disabled.\n"
eab1b259 161 "If @var{flag} is @code{#t}, cheap cell access checking is enabled,\n"
e81d98ec 162 "but no additional calls to garbage collection are issued.\n"
eab1b259 163 "If @var{flag} is a number, strict cell access checking is enabled,\n"
e81d98ec
DH
164 "with an additional garbage collection after the given\n"
165 "number of cell accesses.\n"
1e6808ea
MG
166 "This procedure only exists when the compile-time flag\n"
167 "@code{SCM_DEBUG_CELL_ACCESSES} was set to 1.")
406c7d90
DH
168#define FUNC_NAME s_scm_set_debug_cell_accesses_x
169{
7888309b 170 if (scm_is_false (flag))
eab1b259
HWN
171 {
172 scm_debug_cell_accesses_p = 0;
173 }
bc36d050 174 else if (scm_is_eq (flag, SCM_BOOL_T))
eab1b259
HWN
175 {
176 scm_debug_cells_gc_interval = 0;
177 scm_debug_cell_accesses_p = 1;
178 scm_expensive_debug_cell_accesses_p = 0;
179 }
e11e83f3 180 else
eab1b259 181 {
e11e83f3 182 scm_debug_cells_gc_interval = scm_to_signed_integer (flag, 0, INT_MAX);
eab1b259
HWN
183 scm_debug_cell_accesses_p = 1;
184 scm_expensive_debug_cell_accesses_p = 1;
185 }
406c7d90
DH
186 return SCM_UNSPECIFIED;
187}
188#undef FUNC_NAME
0f2d19dd 189
ecf470a2 190
c8a1bdc4 191#endif /* SCM_DEBUG_CELL_ACCESSES == 1 */
0f2d19dd 192
c2247b78
AW
193
194\f
195
196static int needs_gc_after_nonlocal_exit = 0;
197
198/* Arrange to throw an exception on failed allocations. */
199static void*
200scm_oom_fn (size_t nbytes)
201{
202 needs_gc_after_nonlocal_exit = 1;
203 scm_report_out_of_memory ();
204 return NULL;
205}
206
207/* Called within GC -- cannot allocate GC memory. */
208static void
209scm_gc_warn_proc (char *fmt, GC_word arg)
210{
211 SCM port;
212 FILE *stream = NULL;
213
214 port = scm_current_warning_port ();
215 if (!SCM_OPPORTP (port))
216 return;
217
218 if (SCM_FPORTP (port))
219 {
220 int fd;
221 scm_force_output (port);
222 if (!SCM_OPPORTP (port))
223 return;
224 fd = dup (SCM_FPORT_FDES (port));
225 if (fd == -1)
226 perror ("Failed to dup warning port fd");
227 else
228 {
229 stream = fdopen (fd, "a");
230 if (!stream)
231 {
232 perror ("Failed to open stream for warning port");
233 close (fd);
234 }
235 }
236 }
237
238 fprintf (stream ? stream : stderr, fmt, arg);
239
240 if (stream)
241 fclose (stream);
242}
243
244void
245scm_gc_after_nonlocal_exit (void)
246{
247 if (needs_gc_after_nonlocal_exit)
248 {
249 needs_gc_after_nonlocal_exit = 0;
250 GC_gcollect_and_unmap ();
251 }
252}
253
254
0f2d19dd 255\f
14294ce0 256
26224b3f
LC
257/* Hooks. */
258scm_t_c_hook scm_before_gc_c_hook;
259scm_t_c_hook scm_before_mark_c_hook;
260scm_t_c_hook scm_before_sweep_c_hook;
261scm_t_c_hook scm_after_sweep_c_hook;
262scm_t_c_hook scm_after_gc_c_hook;
945fec60 263
0f2d19dd 264
0fbdbe6c
AW
265static void
266run_before_gc_c_hook (void)
267{
e1fbe716
AW
268 if (!SCM_I_CURRENT_THREAD)
269 /* GC while a thread is spinning up; punt. */
270 return;
271
0fbdbe6c
AW
272 scm_c_hook_run (&scm_before_gc_c_hook, NULL);
273}
274
275
0f2d19dd
JB
276/* GC Statistics Keeping
277 */
b74e86cf 278unsigned long scm_gc_ports_collected = 0;
00b6ef23
AW
279static long gc_time_taken = 0;
280static long gc_start_time = 0;
281
6360beb2
AW
282static unsigned long free_space_divisor;
283static unsigned long minimum_free_space_divisor;
284static double target_free_space_divisor;
b74e86cf 285
915b3f9f 286static unsigned long protected_obj_count = 0;
c2cbcc57 287
0f2d19dd 288
17ab1dc3 289SCM_SYMBOL (sym_gc_time_taken, "gc-time-taken");
915b3f9f
LC
290SCM_SYMBOL (sym_heap_size, "heap-size");
291SCM_SYMBOL (sym_heap_free_size, "heap-free-size");
292SCM_SYMBOL (sym_heap_total_allocated, "heap-total-allocated");
17ab1dc3 293SCM_SYMBOL (sym_heap_allocated_since_gc, "heap-allocated-since-gc");
7eec4c37 294SCM_SYMBOL (sym_protected_objects, "protected-objects");
17ab1dc3 295SCM_SYMBOL (sym_times, "gc-times");
cf2d30f6 296
d3dd80ab 297
0f2d19dd
JB
298/* {Scheme Interface to GC}
299 */
c2cbcc57 300extern int scm_gc_malloc_yield_percentage;
a00c95d9 301SCM_DEFINE (scm_gc_stats, "gc-stats", 0, 0, 0,
1bbd0b84 302 (),
1e6808ea 303 "Return an association list of statistics about Guile's current\n"
c8a1bdc4 304 "use of storage.\n")
1bbd0b84 305#define FUNC_NAME s_scm_gc_stats
0f2d19dd 306{
0f2d19dd 307 SCM answer;
14294ce0 308 GC_word heap_size, free_bytes, unmapped_bytes, bytes_since_gc, total_bytes;
915b3f9f 309 size_t gc_times;
4c9419ac 310
14294ce0
AW
311 GC_get_heap_usage_safe (&heap_size, &free_bytes, &unmapped_bytes,
312 &bytes_since_gc, &total_bytes);
0f595d7d 313 gc_times = GC_get_gc_no ();
fca43887 314
b9bd8526 315 answer =
00b6ef23 316 scm_list_n (scm_cons (sym_gc_time_taken, scm_from_long (gc_time_taken)),
915b3f9f
LC
317 scm_cons (sym_heap_size, scm_from_size_t (heap_size)),
318 scm_cons (sym_heap_free_size, scm_from_size_t (free_bytes)),
319 scm_cons (sym_heap_total_allocated,
320 scm_from_size_t (total_bytes)),
17ab1dc3
AW
321 scm_cons (sym_heap_allocated_since_gc,
322 scm_from_size_t (bytes_since_gc)),
915b3f9f
LC
323 scm_cons (sym_protected_objects,
324 scm_from_ulong (protected_obj_count)),
325 scm_cons (sym_times, scm_from_size_t (gc_times)),
b9bd8526 326 SCM_UNDEFINED);
fca43887 327
c8a1bdc4 328 return answer;
0f2d19dd 329}
c8a1bdc4 330#undef FUNC_NAME
0f2d19dd 331
539b08a4 332
7f9ec18a
LC
333SCM_DEFINE (scm_gc_dump, "gc-dump", 0, 0, 0,
334 (void),
335 "Dump information about the garbage collector's internal data "
336 "structures and memory usage to the standard output.")
337#define FUNC_NAME s_scm_gc_dump
338{
339 GC_dump ();
340
341 return SCM_UNSPECIFIED;
342}
343#undef FUNC_NAME
344
acf4331f 345
c8a1bdc4
HWN
346SCM_DEFINE (scm_object_address, "object-address", 1, 0, 0,
347 (SCM obj),
348 "Return an integer that for the lifetime of @var{obj} is uniquely\n"
349 "returned by this function for @var{obj}")
350#define FUNC_NAME s_scm_object_address
c68296f8 351{
b9bd8526 352 return scm_from_ulong (SCM_UNPACK (obj));
c68296f8 353}
c8a1bdc4 354#undef FUNC_NAME
c68296f8 355
1be6b49c 356
915b3f9f
LC
357SCM_DEFINE (scm_gc_disable, "gc-disable", 0, 0, 0,
358 (),
359 "Disables the garbage collector. Nested calls are permitted. "
360 "GC is re-enabled once @code{gc-enable} has been called the "
361 "same number of times @code{gc-disable} was called.")
362#define FUNC_NAME s_scm_gc_disable
363{
364 GC_disable ();
365 return SCM_UNSPECIFIED;
366}
367#undef FUNC_NAME
368
369SCM_DEFINE (scm_gc_enable, "gc-enable", 0, 0, 0,
370 (),
371 "Enables the garbage collector.")
372#define FUNC_NAME s_scm_gc_enable
373{
374 GC_enable ();
375 return SCM_UNSPECIFIED;
376}
377#undef FUNC_NAME
378
379
c8a1bdc4
HWN
380SCM_DEFINE (scm_gc, "gc", 0, 0, 0,
381 (),
382 "Scans all of SCM objects and reclaims for further use those that are\n"
383 "no longer accessible.")
384#define FUNC_NAME s_scm_gc
385{
b17e0ac3 386 scm_i_gc ("call");
f740445a
AW
387 /* If you're calling scm_gc(), you probably want synchronous
388 finalization. */
eaf99988 389 GC_invoke_finalizers ();
c8a1bdc4 390 return SCM_UNSPECIFIED;
9d47a1e6 391}
c8a1bdc4 392#undef FUNC_NAME
9d47a1e6 393
c8a1bdc4 394void
b17e0ac3 395scm_i_gc (const char *what)
c8a1bdc4 396{
26224b3f 397 GC_gcollect ();
eab1b259 398}
0f2d19dd 399
4c7016dc 400
0f2d19dd
JB
401\f
402/* {GC Protection Helper Functions}
403 */
404
405
5d2b97cd
DH
406/*
407 * If within a function you need to protect one or more scheme objects from
408 * garbage collection, pass them as parameters to one of the
409 * scm_remember_upto_here* functions below. These functions don't do
410 * anything, but since the compiler does not know that they are actually
411 * no-ops, it will generate code that calls these functions with the given
412 * parameters. Therefore, you can be sure that the compiler will keep those
413 * scheme values alive (on the stack or in a register) up to the point where
414 * scm_remember_upto_here* is called. In other words, place the call to
592996c9 415 * scm_remember_upto_here* _behind_ the last code in your function, that
5d2b97cd
DH
416 * depends on the scheme object to exist.
417 *
8c494e99
DH
418 * Example: We want to make sure that the string object str does not get
419 * garbage collected during the execution of 'some_function' in the code
420 * below, because otherwise the characters belonging to str would be freed and
5d2b97cd
DH
421 * 'some_function' might access freed memory. To make sure that the compiler
422 * keeps str alive on the stack or in a register such that it is visible to
423 * the conservative gc we add the call to scm_remember_upto_here_1 _after_ the
424 * call to 'some_function'. Note that this would not be necessary if str was
425 * used anyway after the call to 'some_function'.
eb01cb64 426 * char *chars = scm_i_string_chars (str);
5d2b97cd
DH
427 * some_function (chars);
428 * scm_remember_upto_here_1 (str); // str will be alive up to this point.
429 */
430
9e1569bd
KR
431/* Remove any macro versions of these while defining the functions.
432 Functions are always included in the library, for upward binary
433 compatibility and in case combinations of GCC and non-GCC are used. */
434#undef scm_remember_upto_here_1
435#undef scm_remember_upto_here_2
436
5d2b97cd 437void
e81d98ec 438scm_remember_upto_here_1 (SCM obj SCM_UNUSED)
5d2b97cd
DH
439{
440 /* Empty. Protects a single object from garbage collection. */
441}
442
443void
e81d98ec 444scm_remember_upto_here_2 (SCM obj1 SCM_UNUSED, SCM obj2 SCM_UNUSED)
5d2b97cd
DH
445{
446 /* Empty. Protects two objects from garbage collection. */
447}
448
449void
e81d98ec 450scm_remember_upto_here (SCM obj SCM_UNUSED, ...)
5d2b97cd
DH
451{
452 /* Empty. Protects any number of objects from garbage collection. */
453}
454
c209c88e 455/*
41b0806d
GB
456 These crazy functions prevent garbage collection
457 of arguments after the first argument by
458 ensuring they remain live throughout the
459 function because they are used in the last
460 line of the code block.
461 It'd be better to have a nice compiler hint to
462 aid the conservative stack-scanning GC. --03/09/00 gjb */
0f2d19dd
JB
463SCM
464scm_return_first (SCM elt, ...)
0f2d19dd
JB
465{
466 return elt;
467}
468
41b0806d
GB
469int
470scm_return_first_int (int i, ...)
471{
472 return i;
473}
474
0f2d19dd 475
0f2d19dd 476SCM
6e8d25a6 477scm_permanent_object (SCM obj)
0f2d19dd 478{
8e7b3e98 479 return (scm_gc_protect_object (obj));
0f2d19dd
JB
480}
481
482
7bd4fbe2
MD
483/* Protect OBJ from the garbage collector. OBJ will not be freed, even if all
484 other references are dropped, until the object is unprotected by calling
6b1b030e 485 scm_gc_unprotect_object (OBJ). Calls to scm_gc_protect/unprotect_object nest,
7bd4fbe2
MD
486 i. e. it is possible to protect the same object several times, but it is
487 necessary to unprotect the object the same number of times to actually get
488 the object unprotected. It is an error to unprotect an object more often
489 than it has been protected before. The function scm_protect_object returns
490 OBJ.
491*/
492
493/* Implementation note: For every object X, there is a counter which
1f584400 494 scm_gc_protect_object (X) increments and scm_gc_unprotect_object (X) decrements.
7bd4fbe2 495*/
686765af 496
7eec4c37
HWN
497
498
ef290276 499SCM
6b1b030e 500scm_gc_protect_object (SCM obj)
ef290276 501{
686765af 502 SCM handle;
9d47a1e6 503
686765af 504 /* This critical section barrier will be replaced by a mutex. */
33b320ae
NJ
505 /* njrev: Indeed; if my comment above is correct, there is the same
506 critsec/mutex inconsistency here. */
9de87eea 507 SCM_CRITICAL_SECTION_START;
9d47a1e6 508
acbccb0c 509 handle = scm_hashq_create_handle_x (scm_protects, obj, scm_from_int (0));
e11e83f3 510 SCM_SETCDR (handle, scm_sum (SCM_CDR (handle), scm_from_int (1)));
9d47a1e6 511
7eec4c37
HWN
512 protected_obj_count ++;
513
9de87eea 514 SCM_CRITICAL_SECTION_END;
9d47a1e6 515
ef290276
JB
516 return obj;
517}
518
519
520/* Remove any protection for OBJ established by a prior call to
dab7f566 521 scm_protect_object. This function returns OBJ.
ef290276 522
dab7f566 523 See scm_protect_object for more information. */
ef290276 524SCM
6b1b030e 525scm_gc_unprotect_object (SCM obj)
ef290276 526{
686765af 527 SCM handle;
9d47a1e6 528
686765af 529 /* This critical section barrier will be replaced by a mutex. */
33b320ae 530 /* njrev: and again. */
9de87eea 531 SCM_CRITICAL_SECTION_START;
9d47a1e6 532
0ff7e3ff
HWN
533 if (scm_gc_running_p)
534 {
535 fprintf (stderr, "scm_unprotect_object called during GC.\n");
536 abort ();
537 }
b17e0ac3 538
acbccb0c 539 handle = scm_hashq_get_handle (scm_protects, obj);
9d47a1e6 540
7888309b 541 if (scm_is_false (handle))
686765af 542 {
0f0f0899
MD
543 fprintf (stderr, "scm_unprotect_object called on unprotected object\n");
544 abort ();
686765af 545 }
6a199940
DH
546 else
547 {
e11e83f3 548 SCM count = scm_difference (SCM_CDR (handle), scm_from_int (1));
bc36d050 549 if (scm_is_eq (count, scm_from_int (0)))
acbccb0c 550 scm_hashq_remove_x (scm_protects, obj);
6a199940 551 else
1be6b49c 552 SCM_SETCDR (handle, count);
6a199940 553 }
7eec4c37 554 protected_obj_count --;
686765af 555
9de87eea 556 SCM_CRITICAL_SECTION_END;
ef290276
JB
557
558 return obj;
559}
560
6b1b030e
ML
561void
562scm_gc_register_root (SCM *p)
563{
8e7b3e98 564 /* Nothing. */
6b1b030e
ML
565}
566
567void
568scm_gc_unregister_root (SCM *p)
569{
8e7b3e98 570 /* Nothing. */
6b1b030e
ML
571}
572
573void
574scm_gc_register_roots (SCM *b, unsigned long n)
575{
576 SCM *p = b;
577 for (; p < b + n; ++p)
578 scm_gc_register_root (p);
579}
580
581void
582scm_gc_unregister_roots (SCM *b, unsigned long n)
583{
584 SCM *p = b;
585 for (; p < b + n; ++p)
586 scm_gc_unregister_root (p);
587}
588
0f2d19dd 589\f
a00c95d9 590
4c48ba06 591
c35738c1
MD
592void
593scm_storage_prehistory ()
594{
0f595d7d 595 GC_set_all_interior_pointers (0);
0f595d7d 596
6360beb2
AW
597 free_space_divisor = scm_getenv_int ("GC_FREE_SPACE_DIVISOR", 3);
598 minimum_free_space_divisor = free_space_divisor;
599 target_free_space_divisor = free_space_divisor;
600 GC_set_free_space_divisor (free_space_divisor);
eaf99988 601 GC_set_finalize_on_demand (1);
184327a6 602
3f69e638 603#if (GC_VERSION_MAJOR == 7 && GC_VERSION_MINOR == 4 \
fab18c02 604 && GC_VERSION_MICRO == 0)
3f69e638
LC
605 /* BDW-GC 7.4.0 has a bug making it loop indefinitely when using more
606 than one marker thread: <https://github.com/ivmai/bdwgc/pull/30>.
607 Work around it by asking for one marker thread. */
608 setenv ("GC_MARKERS", "1", 1);
609#endif
610
a82e7953 611 GC_INIT ();
e7bca227 612
064d2409 613 GC_expand_hp (DEFAULT_INITIAL_HEAP_SIZE);
915b3f9f 614
184327a6
LC
615 /* We only need to register a displacement for those types for which the
616 higher bits of the type tag are used to store a pointer (that is, a
617 pointer to an 8-octet aligned region). For `scm_tc3_struct', this is
618 handled in `scm_alloc_struct ()'. */
619 GC_REGISTER_DISPLACEMENT (scm_tc3_cons);
314b8716 620 /* GC_REGISTER_DISPLACEMENT (scm_tc3_unused); */
184327a6 621
915b3f9f 622 /* Sanity check. */
acbccb0c 623 if (!GC_is_visible (&scm_protects))
915b3f9f 624 abort ();
a82e7953 625
c35738c1
MD
626 scm_c_hook_init (&scm_before_gc_c_hook, 0, SCM_C_HOOK_NORMAL);
627 scm_c_hook_init (&scm_before_mark_c_hook, 0, SCM_C_HOOK_NORMAL);
628 scm_c_hook_init (&scm_before_sweep_c_hook, 0, SCM_C_HOOK_NORMAL);
629 scm_c_hook_init (&scm_after_sweep_c_hook, 0, SCM_C_HOOK_NORMAL);
630 scm_c_hook_init (&scm_after_gc_c_hook, 0, SCM_C_HOOK_NORMAL);
631}
85db4a2c 632
9de87eea 633scm_i_pthread_mutex_t scm_i_gc_admin_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER;
eb01cb64 634
562cd1b8
AW
635void
636scm_init_gc_protect_object ()
0f2d19dd 637{
acbccb0c 638 scm_protects = scm_c_make_hash_table (31);
4a4c9785 639
9de87eea
MV
640#if 0
641 /* We can't have a cleanup handler since we have no thread to run it
642 in. */
643
a18bcd0e 644#ifdef HAVE_ATEXIT
c45acc34 645 atexit (cleanup);
e52ceaac
MD
646#else
647#ifdef HAVE_ON_EXIT
648 on_exit (cleanup, 0);
649#endif
9de87eea
MV
650#endif
651
a18bcd0e 652#endif
0f2d19dd 653}
939794ce 654
0f2d19dd
JB
655\f
656
939794ce
DH
657SCM scm_after_gc_hook;
658
cc3546b0 659static SCM after_gc_async_cell;
939794ce 660
cc3546b0
AW
661/* The function after_gc_async_thunk causes the execution of the
662 * after-gc-hook. It is run after the gc, as soon as the asynchronous
663 * events are handled by the evaluator.
939794ce
DH
664 */
665static SCM
cc3546b0 666after_gc_async_thunk (void)
939794ce 667{
cc3546b0
AW
668 /* Fun, no? Hook-run *and* run-hook? */
669 scm_c_hook_run (&scm_after_gc_c_hook, NULL);
939794ce 670 scm_c_run_hook (scm_after_gc_hook, SCM_EOL);
939794ce
DH
671 return SCM_UNSPECIFIED;
672}
673
674
cc3546b0
AW
675/* The function queue_after_gc_hook is run by the scm_before_gc_c_hook
676 * at the end of the garbage collection. The only purpose of this
677 * function is to mark the after_gc_async (which will eventually lead to
678 * the execution of the after_gc_async_thunk).
939794ce
DH
679 */
680static void *
cc3546b0
AW
681queue_after_gc_hook (void * hook_data SCM_UNUSED,
682 void *fn_data SCM_UNUSED,
683 void *data SCM_UNUSED)
e81d98ec
DH
684{
685 /* If cell access debugging is enabled, the user may choose to perform
686 * additional garbage collections after an arbitrary number of cell
687 * accesses. We don't want the scheme level after-gc-hook to be performed
688 * for each of these garbage collections for the following reason: The
689 * execution of the after-gc-hook causes cell accesses itself. Thus, if the
690 * after-gc-hook was performed with every gc, and if the gc was performed
691 * after a very small number of cell accesses, then the number of cell
692 * accesses during the execution of the after-gc-hook will suffice to cause
693 * the execution of the next gc. Then, guile would keep executing the
694 * after-gc-hook over and over again, and would never come to do other
695 * things.
eae33935 696 *
e81d98ec
DH
697 * To overcome this problem, if cell access debugging with additional
698 * garbage collections is enabled, the after-gc-hook is never run by the
699 * garbage collecter. When running guile with cell access debugging and the
700 * execution of the after-gc-hook is desired, then it is necessary to run
701 * the hook explicitly from the user code. This has the effect, that from
702 * the scheme level point of view it seems that garbage collection is
703 * performed with a much lower frequency than it actually is. Obviously,
704 * this will not work for code that depends on a fixed one to one
705 * relationship between the execution counts of the C level garbage
706 * collection hooks and the execution count of the scheme level
707 * after-gc-hook.
708 */
9de87eea 709
e81d98ec 710#if (SCM_DEBUG_CELL_ACCESSES == 1)
eab1b259 711 if (scm_debug_cells_gc_interval == 0)
e81d98ec 712#endif
cc3546b0
AW
713 {
714 scm_i_thread *t = SCM_I_CURRENT_THREAD;
715
716 if (scm_is_false (SCM_CDR (after_gc_async_cell)))
717 {
718 SCM_SETCDR (after_gc_async_cell, t->active_asyncs);
719 t->active_asyncs = after_gc_async_cell;
720 t->pending_asyncs = 1;
721 }
722 }
e81d98ec 723
939794ce
DH
724 return NULL;
725}
726
00b6ef23
AW
727\f
728
729static void *
730start_gc_timer (void * hook_data SCM_UNUSED,
731 void *fn_data SCM_UNUSED,
732 void *data SCM_UNUSED)
733{
734 if (!gc_start_time)
735 gc_start_time = scm_c_get_internal_run_time ();
736
737 return NULL;
738}
739
740static void *
741accumulate_gc_timer (void * hook_data SCM_UNUSED,
742 void *fn_data SCM_UNUSED,
743 void *data SCM_UNUSED)
744{
745 if (gc_start_time)
6360beb2
AW
746 {
747 long now = scm_c_get_internal_run_time ();
00b6ef23
AW
748 gc_time_taken += now - gc_start_time;
749 gc_start_time = 0;
750 }
751
752 return NULL;
753}
754
553294d9 755static size_t bytes_until_gc = DEFAULT_INITIAL_HEAP_SIZE;
fd51e661
AW
756static scm_i_pthread_mutex_t bytes_until_gc_lock = SCM_I_PTHREAD_MUTEX_INITIALIZER;
757
fd51e661
AW
758void
759scm_gc_register_allocation (size_t size)
760{
761 scm_i_pthread_mutex_lock (&bytes_until_gc_lock);
762 if (bytes_until_gc - size > bytes_until_gc)
763 {
764 bytes_until_gc = GC_get_heap_size ();
765 scm_i_pthread_mutex_unlock (&bytes_until_gc_lock);
766 GC_gcollect ();
767 }
768 else
769 {
770 bytes_until_gc -= size;
771 scm_i_pthread_mutex_unlock (&bytes_until_gc_lock);
772 }
773}
774
00b6ef23
AW
775
776\f
0f2d19dd
JB
777void
778scm_init_gc ()
0f2d19dd 779{
a82e7953 780 /* `GC_INIT ()' was invoked in `scm_storage_prehistory ()'. */
d678e25c 781
f39448c5 782 scm_after_gc_hook = scm_make_hook (SCM_INUM0);
fde50407 783 scm_c_define ("after-gc-hook", scm_after_gc_hook);
939794ce 784
cc3546b0
AW
785 /* When the async is to run, the cdr of the gc_async pair gets set to
786 the asyncs queue of the current thread. */
787 after_gc_async_cell = scm_cons (scm_c_make_gsubr ("%after-gc-thunk", 0, 0, 0,
788 after_gc_async_thunk),
789 SCM_BOOL_F);
939794ce 790
cc3546b0 791 scm_c_hook_add (&scm_before_gc_c_hook, queue_after_gc_hook, NULL, 0);
00b6ef23
AW
792 scm_c_hook_add (&scm_before_gc_c_hook, start_gc_timer, NULL, 0);
793 scm_c_hook_add (&scm_after_gc_c_hook, accumulate_gc_timer, NULL, 0);
66b229d5 794
c2247b78
AW
795 GC_set_oom_fn (scm_oom_fn);
796 GC_set_warn_proc (scm_gc_warn_proc);
cc3546b0 797 GC_set_start_callback (run_before_gc_c_hook);
939794ce 798
a0599745 799#include "libguile/gc.x"
0f2d19dd 800}
89e00824 801
c8a1bdc4
HWN
802
803void
804scm_gc_sweep (void)
805#define FUNC_NAME "scm_gc_sweep"
806{
26224b3f 807 /* FIXME */
cd169c5a 808 fprintf (stderr, "%s: doing nothing\n", FUNC_NAME);
c8a1bdc4 809}
c8a1bdc4
HWN
810#undef FUNC_NAME
811
89e00824
ML
812/*
813 Local Variables:
814 c-file-style: "gnu"
815 End:
816*/