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