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