-/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3 of
+ * the License, or (at your option) any later version.
*
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
*/
-#define _GNU_SOURCE
-
/* #define DEBUGINFO */
-#if HAVE_CONFIG_H
+#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
+#include "libguile/gen-scmconfig.h"
+
#include <stdio.h>
#include <errno.h>
#include <string.h>
-#include <assert.h>
#ifdef __ia64__
#include <ucontext.h>
#include "libguile/stackchk.h"
#include "libguile/struct.h"
#include "libguile/smob.h"
-#include "libguile/unif.h"
+#include "libguile/arrays.h"
#include "libguile/async.h"
#include "libguile/ports.h"
#include "libguile/root.h"
#include "libguile/gc.h"
#include "libguile/dynwind.h"
-#include <gc/gc.h>
+#include "libguile/bdw-gc.h"
+
+/* For GC_set_start_callback. */
+#include <gc/gc_mark.h>
#ifdef GUILE_DEBUG_MALLOC
#include "libguile/debug-malloc.h"
#include <unistd.h>
#endif
-/* Lock this mutex before doing lazy sweeping.
- */
-scm_i_pthread_mutex_t scm_i_sweep_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER;
-
/* Set this to != 0 if every cell that is accessed shall be checked:
*/
int scm_debug_cell_accesses_p = 0;
*/
int scm_debug_cells_gc_interval = 0;
-/*
- Global variable, so you can switch it off at runtime by setting
- scm_i_cell_validation_already_running.
- */
-int scm_i_cell_validation_already_running ;
+/* Hash table that keeps a reference to objects the user wants to protect from
+ garbage collection. It could arguably be private but applications have come
+ to rely on it (e.g., Lilypond 2.13.9). */
+SCM scm_protects;
+
#if (SCM_DEBUG_CELL_ACCESSES == 1)
void
scm_i_expensive_validation_check (SCM cell)
{
- if (!scm_in_heap_p (cell))
- {
- fprintf (stderr, "scm_assert_cell_valid: this object does not live in the heap: %lux\n",
- (unsigned long) SCM_UNPACK (cell));
- abort ();
- }
-
/* If desired, perform additional garbage collections after a user
* defined number of cell accesses.
*/
}
}
+/* Whether cell validation is already running. */
+static int scm_i_cell_validation_already_running = 0;
+
void
scm_assert_cell_valid (SCM cell)
{
*/
if (scm_expensive_debug_cell_accesses_p)
scm_i_expensive_validation_check (cell);
-
- if (!SCM_GC_MARK_P (cell))
- {
- fprintf (stderr,
- "scm_assert_cell_valid: this object is unmarked. \n"
- "It has been garbage-collected in the last GC run: "
- "%lux\n",
- (unsigned long) SCM_UNPACK (cell));
- abort ();
- }
scm_i_cell_validation_already_running = 0; /* re-enable */
}
scm_t_c_hook scm_after_gc_c_hook;
-/* scm_mtrigger
- * is the number of bytes of malloc allocation needed to trigger gc.
- */
-unsigned long scm_mtrigger;
+static void
+run_before_gc_c_hook (void)
+{
+ scm_c_hook_run (&scm_before_gc_c_hook, NULL);
+}
+
/* GC Statistics Keeping
*/
-unsigned long scm_cells_allocated = 0;
-unsigned long scm_mallocated = 0;
-unsigned long scm_gc_cells_collected;
-unsigned long scm_gc_cells_collected_1 = 0; /* previous GC yield */
-unsigned long scm_gc_malloc_collected;
-unsigned long scm_gc_ports_collected;
-unsigned long scm_gc_time_taken = 0;
-static unsigned long t_before_gc;
-unsigned long scm_gc_mark_time_taken = 0;
-unsigned long scm_gc_times = 0;
-unsigned long scm_gc_cells_swept = 0;
-double scm_gc_cells_marked_acc = 0.;
-double scm_gc_cells_swept_acc = 0.;
-int scm_gc_cell_yield_percentage =0;
-int scm_gc_malloc_yield_percentage = 0;
-unsigned long protected_obj_count = 0;
-
-
-SCM_SYMBOL (sym_cells_allocated, "cells-allocated");
-SCM_SYMBOL (sym_heap_size, "cell-heap-size");
-SCM_SYMBOL (sym_mallocated, "bytes-malloced");
-SCM_SYMBOL (sym_mtrigger, "gc-malloc-threshold");
-SCM_SYMBOL (sym_heap_segments, "cell-heap-segments");
-SCM_SYMBOL (sym_gc_time_taken, "gc-time-taken");
-SCM_SYMBOL (sym_gc_mark_time_taken, "gc-mark-time-taken");
-SCM_SYMBOL (sym_times, "gc-times");
-SCM_SYMBOL (sym_cells_marked, "cells-marked");
-SCM_SYMBOL (sym_cells_swept, "cells-swept");
-SCM_SYMBOL (sym_malloc_yield, "malloc-yield");
-SCM_SYMBOL (sym_cell_yield, "cell-yield");
-SCM_SYMBOL (sym_protected_objects, "protected-objects");
+unsigned long scm_gc_ports_collected = 0;
+
+static unsigned long protected_obj_count = 0;
+SCM_SYMBOL (sym_gc_time_taken, "gc-time-taken");
+SCM_SYMBOL (sym_heap_size, "heap-size");
+SCM_SYMBOL (sym_heap_free_size, "heap-free-size");
+SCM_SYMBOL (sym_heap_total_allocated, "heap-total-allocated");
+SCM_SYMBOL (sym_heap_allocated_since_gc, "heap-allocated-since-gc");
+SCM_SYMBOL (sym_protected_objects, "protected-objects");
+SCM_SYMBOL (sym_times, "gc-times");
/* Number of calls to SCM_NEWCELL since startup. */
"use of storage.\n")
#define FUNC_NAME s_scm_gc_stats
{
- long i = 0;
- SCM heap_segs = SCM_EOL ;
- unsigned long int local_scm_mtrigger;
- unsigned long int local_scm_mallocated;
- unsigned long int local_scm_heap_size;
- int local_scm_gc_cell_yield_percentage;
- int local_scm_gc_malloc_yield_percentage;
- unsigned long int local_scm_cells_allocated;
- unsigned long int local_scm_gc_time_taken;
- unsigned long int local_scm_gc_times;
- unsigned long int local_scm_gc_mark_time_taken;
- unsigned long int local_protected_obj_count;
- double local_scm_gc_cells_swept;
- double local_scm_gc_cells_marked;
SCM answer;
- unsigned long *bounds = 0;
- SCM_CRITICAL_SECTION_START;
-
- /*
- temporarily store the numbers, so as not to cause GC.
- */
-#if 0
- bounds = malloc (sizeof (unsigned long) * table_size * 2);
- if (!bounds)
- abort();
-#endif
-
- /* Below, we cons to produce the resulting list. We want a snapshot of
- * the heap situation before consing.
- */
- local_scm_mtrigger = scm_mtrigger;
- local_scm_mallocated = scm_mallocated;
- local_scm_heap_size = GC_get_heap_size ();
-
- local_scm_cells_allocated = scm_cells_allocated;
-
- local_scm_gc_time_taken = scm_gc_time_taken;
- local_scm_gc_mark_time_taken = scm_gc_mark_time_taken;
- local_scm_gc_times = scm_gc_times;
- local_scm_gc_malloc_yield_percentage = scm_gc_malloc_yield_percentage;
- local_scm_gc_cell_yield_percentage= scm_gc_cell_yield_percentage;
- local_protected_obj_count = protected_obj_count;
- local_scm_gc_cells_swept =
- (double) scm_gc_cells_swept_acc
- + (double) scm_gc_cells_swept;
- local_scm_gc_cells_marked = scm_gc_cells_marked_acc
- +(double) scm_gc_cells_swept
- -(double) scm_gc_cells_collected;
+ size_t heap_size, free_bytes, bytes_since_gc, total_bytes;
+ size_t gc_times;
-#if 0
- for (i = table_size; i--;)
- {
- heap_segs = scm_cons (scm_cons (scm_from_ulong (bounds[2*i]),
- scm_from_ulong (bounds[2*i+1])),
- heap_segs);
- }
-#else
- heap_segs = scm_list (SCM_INUM0); /* FIXME */
-#endif
+ heap_size = GC_get_heap_size ();
+ free_bytes = GC_get_free_bytes ();
+ bytes_since_gc = GC_get_bytes_since_gc ();
+ total_bytes = GC_get_total_bytes ();
+ gc_times = GC_gc_no;
- /* njrev: can any of these scm_cons's or scm_list_n signal a memory
- error? If so we need a frame here. */
answer =
- scm_list_n (scm_cons (sym_gc_time_taken,
- scm_from_ulong (local_scm_gc_time_taken)),
- scm_cons (sym_cells_allocated,
- scm_from_ulong (local_scm_cells_allocated)),
- scm_cons (sym_heap_size,
- scm_from_ulong (local_scm_heap_size)),
- scm_cons (sym_mallocated,
- scm_from_ulong (local_scm_mallocated)),
- scm_cons (sym_mtrigger,
- scm_from_ulong (local_scm_mtrigger)),
- scm_cons (sym_times,
- scm_from_ulong (local_scm_gc_times)),
- scm_cons (sym_gc_mark_time_taken,
- scm_from_ulong (local_scm_gc_mark_time_taken)),
- scm_cons (sym_cells_marked,
- scm_from_double (local_scm_gc_cells_marked)),
- scm_cons (sym_cells_swept,
- scm_from_double (local_scm_gc_cells_swept)),
- scm_cons (sym_malloc_yield,
- scm_from_long(local_scm_gc_malloc_yield_percentage)),
- scm_cons (sym_cell_yield,
- scm_from_long (local_scm_gc_cell_yield_percentage)),
+ scm_list_n (scm_cons (sym_gc_time_taken, SCM_INUM0),
+ scm_cons (sym_heap_size, scm_from_size_t (heap_size)),
+ scm_cons (sym_heap_free_size, scm_from_size_t (free_bytes)),
+ scm_cons (sym_heap_total_allocated,
+ scm_from_size_t (total_bytes)),
+ scm_cons (sym_heap_allocated_since_gc,
+ scm_from_size_t (bytes_since_gc)),
scm_cons (sym_protected_objects,
- scm_from_ulong (local_protected_obj_count)),
- scm_cons (sym_heap_segments, heap_segs),
+ scm_from_ulong (protected_obj_count)),
+ scm_cons (sym_times, scm_from_size_t (gc_times)),
SCM_UNDEFINED);
- SCM_CRITICAL_SECTION_END;
-/* free (bounds); */
return answer;
}
#undef FUNC_NAME
+SCM_DEFINE (scm_gc_dump, "gc-dump", 0, 0, 0,
+ (void),
+ "Dump information about the garbage collector's internal data "
+ "structures and memory usage to the standard output.")
+#define FUNC_NAME s_scm_gc_dump
+{
+ GC_dump ();
+
+ return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
SCM_DEFINE (scm_object_address, "object-address", 1, 0, 0,
#undef FUNC_NAME
+SCM_DEFINE (scm_gc_disable, "gc-disable", 0, 0, 0,
+ (),
+ "Disables the garbage collector. Nested calls are permitted. "
+ "GC is re-enabled once @code{gc-enable} has been called the "
+ "same number of times @code{gc-disable} was called.")
+#define FUNC_NAME s_scm_gc_disable
+{
+ GC_disable ();
+ return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_gc_enable, "gc-enable", 0, 0, 0,
+ (),
+ "Enables the garbage collector.")
+#define FUNC_NAME s_scm_gc_enable
+{
+ GC_enable ();
+ return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
+
+
SCM_DEFINE (scm_gc, "gc", 0, 0, 0,
(),
"Scans all of SCM objects and reclaims for further use those that are\n"
"no longer accessible.")
#define FUNC_NAME s_scm_gc
{
- scm_i_scm_pthread_mutex_lock (&scm_i_sweep_mutex);
- scm_gc_running_p = 1;
scm_i_gc ("call");
- /* njrev: It looks as though other places, e.g. scm_realloc,
- can call scm_i_gc without acquiring the sweep mutex. Does this
- matter? Also scm_i_gc (or its descendants) touch the
- scm_sys_protects, which are protected in some cases
- (e.g. scm_permobjs above in scm_gc_stats) by a critical section,
- not by the sweep mutex. Shouldn't all the GC-relevant objects be
- protected in the same way? */
- scm_gc_running_p = 0;
- scm_i_pthread_mutex_unlock (&scm_i_sweep_mutex);
- scm_c_hook_run (&scm_after_gc_c_hook, 0);
return SCM_UNSPECIFIED;
}
#undef FUNC_NAME
void
scm_i_gc (const char *what)
{
+#ifndef HAVE_GC_SET_START_CALLBACK
+ run_before_gc_c_hook ();
+#endif
GC_gcollect ();
}
SCM
scm_permanent_object (SCM obj)
{
- SCM cell = scm_cons (obj, SCM_EOL);
- SCM_CRITICAL_SECTION_START;
- SCM_SETCDR (cell, scm_permobjs);
- scm_permobjs = cell;
- SCM_CRITICAL_SECTION_END;
- return obj;
+ return (scm_gc_protect_object (obj));
}
*/
/* Implementation note: For every object X, there is a counter which
- scm_gc_protect_object(X) increments and scm_gc_unprotect_object(X) decrements.
+ scm_gc_protect_object (X) increments and scm_gc_unprotect_object (X) decrements.
*/
void
scm_gc_register_root (SCM *p)
{
- SCM handle;
- SCM key = scm_from_ulong ((unsigned long) p);
-
- /* This critical section barrier will be replaced by a mutex. */
- /* njrev: and again. */
- SCM_CRITICAL_SECTION_START;
-
- handle = scm_hashv_create_handle_x (scm_gc_registered_roots, key,
- scm_from_int (0));
- /* njrev: note also that the above can probably signal an error */
- SCM_SETCDR (handle, scm_sum (SCM_CDR (handle), scm_from_int (1)));
-
- SCM_CRITICAL_SECTION_END;
+ /* Nothing. */
}
void
scm_gc_unregister_root (SCM *p)
{
- SCM handle;
- SCM key = scm_from_ulong ((unsigned long) p);
-
- /* This critical section barrier will be replaced by a mutex. */
- /* njrev: and again. */
- SCM_CRITICAL_SECTION_START;
-
- handle = scm_hashv_get_handle (scm_gc_registered_roots, key);
-
- if (scm_is_false (handle))
- {
- fprintf (stderr, "scm_gc_unregister_root called on unregistered root\n");
- abort ();
- }
- else
- {
- SCM count = scm_difference (SCM_CDR (handle), scm_from_int (1));
- if (scm_is_eq (count, scm_from_int (0)))
- scm_hashv_remove_x (scm_gc_registered_roots, key);
- else
- SCM_SETCDR (handle, count);
- }
-
- SCM_CRITICAL_SECTION_END;
+ /* Nothing. */
}
void
scm_gc_unregister_root (p);
}
-int scm_i_terminating;
-
\f
void
scm_storage_prehistory ()
{
+ GC_all_interior_pointers = 0;
+ GC_set_free_space_divisor (scm_getenv_int ("GC_FREE_SPACE_DIVISOR", 3));
+
GC_INIT ();
- GC_add_roots ((char *)scm_sys_protects,
- (char *)(scm_sys_protects + SCM_NUM_PROTECTS));
+
+#if (! ((defined GC_VERSION_MAJOR) && (GC_VERSION_MAJOR >= 7))) \
+ && (defined SCM_I_GSC_USE_PTHREAD_THREADS)
+ /* When using GC 6.8, this call is required to initialize thread-local
+ freelists (shouldn't be necessary with GC 7.0). */
+ GC_init ();
+#endif
+
+ GC_expand_hp (SCM_DEFAULT_INIT_HEAP_SIZE_2);
+
+ /* We only need to register a displacement for those types for which the
+ higher bits of the type tag are used to store a pointer (that is, a
+ pointer to an 8-octet aligned region). For `scm_tc3_struct', this is
+ handled in `scm_alloc_struct ()'. */
+ GC_REGISTER_DISPLACEMENT (scm_tc3_cons);
+ /* GC_REGISTER_DISPLACEMENT (scm_tc3_unused); */
+
+ /* Sanity check. */
+ if (!GC_is_visible (&scm_protects))
+ abort ();
scm_c_hook_init (&scm_before_gc_c_hook, 0, SCM_C_HOOK_NORMAL);
scm_c_hook_init (&scm_before_mark_c_hook, 0, SCM_C_HOOK_NORMAL);
scm_i_pthread_mutex_t scm_i_gc_admin_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER;
-int
-scm_init_storage ()
+void
+scm_init_gc_protect_object ()
{
- size_t j;
-
- j = SCM_NUM_PROTECTS;
- while (j)
- scm_sys_protects[--j] = SCM_BOOL_F;
-
- j = SCM_HEAP_SEG_SIZE;
+ scm_protects = scm_c_make_hash_table (31);
#if 0
/* We can't have a cleanup handler since we have no thread to run it
#endif
#endif
-
- scm_stand_in_procs = scm_make_weak_key_hash_table (scm_from_int (257));
- scm_permobjs = SCM_EOL;
- scm_protects = scm_c_make_hash_table (31);
- scm_gc_registered_roots = scm_c_make_hash_table (31);
-
- return 0;
}
\f
SCM scm_after_gc_hook;
-static SCM gc_async;
+static SCM after_gc_async_cell;
-/* The function gc_async_thunk causes the execution of the after-gc-hook. It
- * is run after the gc, as soon as the asynchronous events are handled by the
- * evaluator.
+/* The function after_gc_async_thunk causes the execution of the
+ * after-gc-hook. It is run after the gc, as soon as the asynchronous
+ * events are handled by the evaluator.
*/
static SCM
-gc_async_thunk (void)
+after_gc_async_thunk (void)
{
+ /* Fun, no? Hook-run *and* run-hook? */
+ scm_c_hook_run (&scm_after_gc_c_hook, NULL);
scm_c_run_hook (scm_after_gc_hook, SCM_EOL);
return SCM_UNSPECIFIED;
}
-/* The function mark_gc_async is run by the scm_after_gc_c_hook at the end of
- * the garbage collection. The only purpose of this function is to mark the
- * gc_async (which will eventually lead to the execution of the
- * gc_async_thunk).
+/* The function queue_after_gc_hook is run by the scm_before_gc_c_hook
+ * at the end of the garbage collection. The only purpose of this
+ * function is to mark the after_gc_async (which will eventually lead to
+ * the execution of the after_gc_async_thunk).
*/
static void *
-mark_gc_async (void * hook_data SCM_UNUSED,
- void *func_data SCM_UNUSED,
- void *data SCM_UNUSED)
+queue_after_gc_hook (void * hook_data SCM_UNUSED,
+ void *fn_data SCM_UNUSED,
+ void *data SCM_UNUSED)
{
/* If cell access debugging is enabled, the user may choose to perform
* additional garbage collections after an arbitrary number of cell
#if (SCM_DEBUG_CELL_ACCESSES == 1)
if (scm_debug_cells_gc_interval == 0)
- scm_system_async_mark (gc_async);
-#else
- scm_system_async_mark (gc_async);
#endif
+ {
+ scm_i_thread *t = SCM_I_CURRENT_THREAD;
+
+ if (scm_is_false (SCM_CDR (after_gc_async_cell)))
+ {
+ SCM_SETCDR (after_gc_async_cell, t->active_asyncs);
+ t->active_asyncs = after_gc_async_cell;
+ t->pending_asyncs = 1;
+ }
+ }
return NULL;
}
{
if (tag >= 255)
{
- if (tag == scm_tc_free_cell)
- return "free cell";
-
- {
- int k = 0xff & (tag >> 8);
- return (scm_smobs[k].name);
- }
+ int k = 0xff & (tag >> 8);
+ return (scm_smobs[k].name);
}
-
+
switch (tag) /* 7 bits */
{
case scm_tcs_struct:
return "cons (immediate car)";
case scm_tcs_cons_nimcar:
return "cons (non-immediate car)";
- case scm_tcs_closures:
- return "closures";
- case scm_tc7_pws:
- return "pws";
+ case scm_tc7_pointer:
+ return "foreign";
+ case scm_tc7_hashtable:
+ return "hashtable";
+ case scm_tc7_fluid:
+ return "fluid";
+ case scm_tc7_dynamic_state:
+ return "dynamic state";
+ case scm_tc7_frame:
+ return "frame";
+ case scm_tc7_objcode:
+ return "objcode";
+ case scm_tc7_vm:
+ return "vm";
+ case scm_tc7_vm_cont:
+ return "vm continuation";
case scm_tc7_wvect:
return "weak vector";
case scm_tc7_vector:
return "vector";
-#ifdef CCLO
- case scm_tc7_cclo:
- return "compiled closure";
-#endif
case scm_tc7_number:
switch (tag)
{
case scm_tc7_variable:
return "variable";
break;
- case scm_tcs_subrs:
- return "subrs";
- break;
case scm_tc7_port:
return "port";
break;
}
-/*
- FIXME: Unimplemented procs!
-
-*/
-
-void
-scm_gc_mark (SCM o)
-{
-}
-
-void
-scm_gc_mark_dependencies (SCM o)
-{
-}
-
-void
-scm_mark_locations (SCM_STACKITEM x[], unsigned long n)
-{
-}
\f
void
{
/* `GC_INIT ()' was invoked in `scm_storage_prehistory ()'. */
- scm_after_gc_hook = scm_permanent_object (scm_make_hook (SCM_INUM0));
+ scm_after_gc_hook = scm_make_hook (SCM_INUM0);
scm_c_define ("after-gc-hook", scm_after_gc_hook);
- gc_async = scm_c_make_subr ("%gc-thunk", scm_tc7_subr_0,
- gc_async_thunk);
+ /* When the async is to run, the cdr of the gc_async pair gets set to
+ the asyncs queue of the current thread. */
+ after_gc_async_cell = scm_cons (scm_c_make_gsubr ("%after-gc-thunk", 0, 0, 0,
+ after_gc_async_thunk),
+ SCM_BOOL_F);
+
+ scm_c_hook_add (&scm_before_gc_c_hook, queue_after_gc_hook, NULL, 0);
- scm_c_hook_add (&scm_after_gc_c_hook, mark_gc_async, NULL, 0);
+#ifdef HAVE_GC_SET_START_CALLBACK
+ GC_set_start_callback (run_before_gc_c_hook);
+#endif
#include "libguile/gc.x"
}
#define FUNC_NAME "scm_gc_sweep"
{
/* FIXME */
- fprintf (stderr, "%s: doing nothing\n", __FUNCTION__);
+ fprintf (stderr, "%s: doing nothing\n", FUNC_NAME);
}
-
#undef FUNC_NAME
-
-
/*
Local Variables:
c-file-style: "gnu"
HCoop / bpt / guile.git / blobdiff