-/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006, 2008 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006,
+ * 2008, 2009, 2010, 2011, 2012, 2013, 2014 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
# include <config.h>
#endif
+#define SCM_BUILDING_DEPRECATED_CODE
+
+#include "libguile/gen-scmconfig.h"
+
#include <stdio.h>
#include <errno.h>
#include <string.h>
-#include <assert.h>
+#include <stdlib.h>
+#include <math.h>
+
+#ifdef __ia64__
+#include <ucontext.h>
+extern unsigned long * __libc_ia64_register_backing_store_base;
+#endif
#include "libguile/_scm.h"
#include "libguile/eval.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 "libguile/bdw-gc.h"
+
+/* For GC_set_start_callback. */
+#include <gc/gc_mark.h>
+
#ifdef GUILE_DEBUG_MALLOC
#include "libguile/debug-malloc.h"
#endif
-#ifdef HAVE_MALLOC_H
-#include <malloc.h>
-#endif
-
-#ifdef HAVE_UNISTD_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_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 ;
+#if SCM_ENABLE_DEPRECATED == 1
+/* 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;
+#else
+static SCM scm_protects;
+#endif
#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_DEBUG_MARKING_API == 0)
- 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 ();
- }
-#endif /* SCM_DEBUG_MARKING_API */
-
+
scm_i_cell_validation_already_running = 0; /* re-enable */
}
}
\f
+/* Compatibility. */
-/* scm_mtrigger
- * is the number of bytes of malloc allocation needed to trigger gc.
- */
-unsigned long scm_mtrigger;
+#ifndef HAVE_GC_GET_HEAP_USAGE_SAFE
+static void
+GC_get_heap_usage_safe (GC_word *pheap_size, GC_word *pfree_bytes,
+ GC_word *punmapped_bytes, GC_word *pbytes_since_gc,
+ GC_word *ptotal_bytes)
+{
+ *pheap_size = GC_get_heap_size ();
+ *pfree_bytes = GC_get_free_bytes ();
+#ifdef HAVE_GC_GET_UNMAPPED_BYTES
+ *punmapped_bytes = GC_get_unmapped_bytes ();
+#else
+ *punmapped_bytes = 0;
+#endif
+ *pbytes_since_gc = GC_get_bytes_since_gc ();
+ *ptotal_bytes = GC_get_total_bytes ();
+}
+#endif
-/* GC Statistics Keeping
- */
-unsigned long scm_cells_allocated = 0;
-unsigned long scm_last_cells_allocated = 0;
-unsigned long scm_mallocated = 0;
-long int scm_i_find_heap_calls = 0;
-/* Global GC sweep statistics since the last full GC. */
-scm_t_sweep_statistics scm_i_gc_sweep_stats = { 0, 0 };
+#ifndef HAVE_GC_GET_FREE_SPACE_DIVISOR
+static GC_word
+GC_get_free_space_divisor (void)
+{
+ return GC_free_space_divisor;
+}
+#endif
+
+\f
+/* Hooks. */
+scm_t_c_hook scm_before_gc_c_hook;
+scm_t_c_hook scm_before_mark_c_hook;
+scm_t_c_hook scm_before_sweep_c_hook;
+scm_t_c_hook scm_after_sweep_c_hook;
+scm_t_c_hook scm_after_gc_c_hook;
-/* Total count of cells marked/swept. */
-static double scm_gc_cells_marked_acc = 0.;
-static double scm_gc_cells_marked_conservatively_acc = 0.;
-static double scm_gc_cells_swept_acc = 0.;
-static double scm_gc_cells_allocated_acc = 0.;
-static unsigned long scm_gc_time_taken = 0;
-static unsigned long scm_gc_mark_time_taken = 0;
+static void
+run_before_gc_c_hook (void)
+{
+ if (!SCM_I_CURRENT_THREAD)
+ /* GC while a thread is spinning up; punt. */
+ return;
-static unsigned long scm_gc_times = 0;
+ scm_c_hook_run (&scm_before_gc_c_hook, NULL);
+}
-static int scm_gc_cell_yield_percentage = 0;
-static unsigned long protected_obj_count = 0;
-/* The following are accessed from `gc-malloc.c' and `gc-card.c'. */
-int scm_gc_malloc_yield_percentage = 0;
-unsigned long scm_gc_malloc_collected = 0;
+/* GC Statistics Keeping
+ */
+unsigned long scm_gc_ports_collected = 0;
+static long gc_time_taken = 0;
+static long gc_start_time = 0;
+static unsigned long free_space_divisor;
+static unsigned long minimum_free_space_divisor;
+static double target_free_space_divisor;
-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_marked_conservatively, "cells-marked-conservatively");
-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");
-SCM_SYMBOL (sym_total_cells_allocated, "total-cells-allocated");
+static unsigned long protected_obj_count = 0;
-/* Number of calls to SCM_NEWCELL since startup. */
-unsigned scm_newcell_count;
-unsigned scm_newcell2_count;
+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");
/* {Scheme Interface to GC}
*/
-static SCM
-tag_table_to_type_alist (void *closure, SCM key, SCM val, SCM acc)
-{
- if (scm_is_integer (key))
- {
- int c_tag = scm_to_int (key);
-
- char const * name = scm_i_tag_name (c_tag);
- if (name != NULL)
- {
- key = scm_from_locale_string (name);
- }
- else
- {
- char s[100];
- sprintf (s, "tag %d", c_tag);
- key = scm_from_locale_string (s);
- }
- }
-
- return scm_cons (scm_cons (key, val), acc);
-}
-
-SCM_DEFINE (scm_gc_live_object_stats, "gc-live-object-stats", 0, 0, 0,
- (),
- "Return an alist of statistics of the current live objects. ")
-#define FUNC_NAME s_scm_gc_live_object_stats
-{
- SCM tab = scm_make_hash_table (scm_from_int (57));
- SCM alist;
-
- scm_i_all_segments_statistics (tab);
-
- alist
- = scm_internal_hash_fold (&tag_table_to_type_alist, NULL, SCM_EOL, tab);
-
- return alist;
-}
-#undef FUNC_NAME
-
extern int scm_gc_malloc_yield_percentage;
SCM_DEFINE (scm_gc_stats, "gc-stats", 0, 0, 0,
(),
"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;
- double local_scm_gc_cells_marked_conservatively;
- double local_scm_total_cells_allocated;
SCM answer;
- unsigned long *bounds = 0;
- int table_size = 0;
- SCM_CRITICAL_SECTION_START;
-
- bounds = scm_i_segment_table_info (&table_size);
-
- /* 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 =
- (scm_i_master_freelist.heap_total_cells + scm_i_master_freelist2.heap_total_cells);
+ GC_word heap_size, free_bytes, unmapped_bytes, bytes_since_gc, total_bytes;
+ size_t gc_times;
+
+ GC_get_heap_usage_safe (&heap_size, &free_bytes, &unmapped_bytes,
+ &bytes_since_gc, &total_bytes);
+#ifdef HAVE_GC_GET_GC_NO
+ /* This function was added in 7.2alpha2 (June 2009). */
+ gc_times = GC_get_gc_no ();
+#else
+ /* This symbol is deprecated as of 7.3. */
+ gc_times = GC_gc_no;
+#endif
- local_scm_cells_allocated =
- scm_cells_allocated + scm_i_gc_sweep_stats.collected;
-
- 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_i_gc_sweep_stats.swept;
- local_scm_gc_cells_marked = scm_gc_cells_marked_acc
- + (double) scm_i_gc_sweep_stats.swept
- - (double) scm_i_gc_sweep_stats.collected;
- local_scm_gc_cells_marked_conservatively
- = scm_gc_cells_marked_conservatively_acc;
-
- local_scm_total_cells_allocated = scm_gc_cells_allocated_acc
- + (double) scm_i_gc_sweep_stats.collected;
-
- 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);
- }
-
- /* 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_total_cells_allocated,
- scm_from_double (local_scm_total_cells_allocated)),
- scm_cons (sym_heap_size,
- scm_from_ulong (local_scm_heap_size)),
- scm_cons (sym_cells_marked_conservatively,
- scm_from_ulong (local_scm_gc_cells_marked_conservatively)),
- 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_from_long (gc_time_taken)),
+ 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
-/*
- Update nice-to-know-statistics.
- */
-static void
-gc_end_stats ()
+
+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
{
- /* CELLS SWEPT is another word for the number of cells that were examined
- during GC. YIELD is the number that we cleaned out. MARKED is the number
- that weren't cleaned. */
- scm_gc_cell_yield_percentage = (scm_i_gc_sweep_stats.collected * 100) /
- (scm_i_master_freelist.heap_total_cells + scm_i_master_freelist2.heap_total_cells);
-
- scm_gc_cells_allocated_acc +=
- (double) scm_i_gc_sweep_stats.collected;
- scm_gc_cells_marked_acc += (double) scm_i_last_marked_cell_count;
- scm_gc_cells_marked_conservatively_acc += (double) scm_i_find_heap_calls;
- scm_gc_cells_swept_acc += (double) scm_i_gc_sweep_stats.swept;
-
- ++scm_gc_times;
+ GC_dump ();
+
+ return SCM_UNSPECIFIED;
}
+#undef FUNC_NAME
+
SCM_DEFINE (scm_object_address, "object-address", 1, 0, 0,
(SCM obj),
#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_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
{
- 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);
+ GC_disable ();
return SCM_UNSPECIFIED;
}
#undef FUNC_NAME
-
-\f
-
-/* The master is global and common while the freelist will be
- * individual for each thread.
- */
-
-SCM
-scm_gc_for_newcell (scm_t_cell_type_statistics *freelist, SCM *free_cells)
+SCM_DEFINE (scm_gc_enable, "gc-enable", 0, 0, 0,
+ (),
+ "Enables the garbage collector.")
+#define FUNC_NAME s_scm_gc_enable
{
- SCM cell;
- int did_gc = 0;
-
- scm_i_scm_pthread_mutex_lock (&scm_i_sweep_mutex);
- scm_gc_running_p = 1;
-
- *free_cells = scm_i_sweep_for_freelist (freelist);
- if (*free_cells == SCM_EOL)
- {
- float delta = scm_i_gc_heap_size_delta (freelist);
- if (delta > 0.0)
- {
- size_t bytes = ((unsigned long) delta) * sizeof (scm_t_cell);
- freelist->heap_segment_idx =
- scm_i_get_new_heap_segment (freelist, bytes, abort_on_error);
-
- *free_cells = scm_i_sweep_for_freelist (freelist);
- }
- }
-
- if (*free_cells == SCM_EOL)
- {
- /*
- out of fresh cells. Try to get some new ones.
- */
- char reason[] = "0-cells";
- reason[0] += freelist->span;
-
- did_gc = 1;
- scm_i_gc (reason);
-
- *free_cells = scm_i_sweep_for_freelist (freelist);
- }
-
- if (*free_cells == SCM_EOL)
- {
- /*
- failed getting new cells. Get new juice or die.
- */
- float delta = scm_i_gc_heap_size_delta (freelist);
- assert (delta > 0.0);
- size_t bytes = ((unsigned long) delta) * sizeof (scm_t_cell);
- freelist->heap_segment_idx =
- scm_i_get_new_heap_segment (freelist, bytes, abort_on_error);
-
- *free_cells = scm_i_sweep_for_freelist (freelist);
- }
-
- if (*free_cells == SCM_EOL)
- abort ();
-
- cell = *free_cells;
-
- *free_cells = SCM_FREE_CELL_CDR (cell);
-
- scm_gc_running_p = 0;
- scm_i_pthread_mutex_unlock (&scm_i_sweep_mutex);
-
- if (did_gc)
- scm_c_hook_run (&scm_after_gc_c_hook, 0);
-
- return cell;
+ GC_enable ();
+ return SCM_UNSPECIFIED;
}
+#undef FUNC_NAME
-scm_t_c_hook scm_before_gc_c_hook;
-scm_t_c_hook scm_before_mark_c_hook;
-scm_t_c_hook scm_before_sweep_c_hook;
-scm_t_c_hook scm_after_sweep_c_hook;
-scm_t_c_hook scm_after_gc_c_hook;
-
-static void
-scm_check_deprecated_memory_return ()
+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
{
- if (scm_mallocated < scm_i_deprecated_memory_return)
- {
- /* The byte count of allocated objects has underflowed. This is
- probably because you forgot to report the sizes of objects you
- have allocated, by calling scm_done_malloc or some such. When
- the GC freed them, it subtracted their size from
- scm_mallocated, which underflowed. */
- fprintf (stderr,
- "scm_gc_sweep: Byte count of allocated objects has underflowed.\n"
- "This is probably because the GC hasn't been correctly informed\n"
- "about object sizes\n");
- abort ();
- }
- scm_mallocated -= scm_i_deprecated_memory_return;
- scm_i_deprecated_memory_return = 0;
+ scm_i_gc ("call");
+ /* If you're calling scm_gc(), you probably want synchronous
+ finalization. */
+ GC_invoke_finalizers ();
+ return SCM_UNSPECIFIED;
}
+#undef FUNC_NAME
-long int scm_i_last_marked_cell_count;
-
-/* Must be called while holding scm_i_sweep_mutex.
-
- This function is fairly long, but it touches various global
- variables. To not obscure the side effects on global variables,
- this function has not been split up.
- */
void
scm_i_gc (const char *what)
{
- unsigned long t_before_gc = 0;
-
- scm_i_thread_put_to_sleep ();
-
- scm_c_hook_run (&scm_before_gc_c_hook, 0);
-
-#ifdef DEBUGINFO
- fprintf (stderr,"gc reason %s\n", what);
- fprintf (stderr,
- scm_is_null (*SCM_FREELIST_LOC (scm_i_freelist))
- ? "*"
- : (scm_is_null (*SCM_FREELIST_LOC (scm_i_freelist2)) ? "o" : "m"));
+#ifndef HAVE_GC_SET_START_CALLBACK
+ run_before_gc_c_hook ();
#endif
-
- t_before_gc = scm_c_get_internal_run_time ();
- scm_gc_malloc_collected = 0;
-
- /*
- Set freelists to NULL so scm_cons () always triggers gc, causing
- the assertion above to fail.
- */
- *SCM_FREELIST_LOC (scm_i_freelist) = SCM_EOL;
- *SCM_FREELIST_LOC (scm_i_freelist2) = SCM_EOL;
-
- /*
- Let's finish the sweep. The conservative GC might point into the
- garbage, and marking that would create a mess.
- */
- scm_i_sweep_all_segments ("GC", &scm_i_gc_sweep_stats);
- scm_check_deprecated_memory_return ();
-
-#if (SCM_DEBUG_CELL_ACCESSES == 0 && SCM_SIZEOF_UNSIGNED_LONG == 4)
- /* Sanity check our numbers. */
- /* TODO(hanwen): figure out why the stats are off on x64_64. */
- /* If this was not true, someone touched mark bits outside of the
- mark phase. */
- if (scm_i_last_marked_cell_count != scm_i_marked_count ())
- {
- static char msg[] =
- "The number of marked objects changed since the last GC: %d vs %d.";
- /* At some point, we should probably use a deprecation warning. */
- fprintf(stderr, msg, scm_i_last_marked_cell_count, scm_i_marked_count ());
- }
- assert (scm_i_gc_sweep_stats.swept
- == (scm_i_master_freelist.heap_total_cells
- + scm_i_master_freelist2.heap_total_cells));
- assert (scm_i_gc_sweep_stats.collected + scm_i_last_marked_cell_count
- == scm_i_gc_sweep_stats.swept);
-#endif /* SCM_DEBUG_CELL_ACCESSES */
-
- /* Mark */
- scm_c_hook_run (&scm_before_mark_c_hook, 0);
-
- scm_mark_all ();
- scm_gc_mark_time_taken += (scm_c_get_internal_run_time () - t_before_gc);
-
- scm_i_last_marked_cell_count = scm_cells_allocated = scm_i_marked_count ();
-
- /* Sweep
-
- TODO: the after_sweep hook should probably be moved to just before
- the mark, since that's where the sweep is finished in lazy
- sweeping.
-
- MDJ 030219 <djurfeldt@nada.kth.se>: No, probably not. The
- original meaning implied at least two things: that it would be
- called when
-
- 1. the freelist is re-initialized (no evaluation possible, though)
-
- and
-
- 2. the heap is "fresh"
- (it is well-defined what data is used and what is not)
-
- Neither of these conditions would hold just before the mark phase.
-
- Of course, the lazy sweeping has muddled the distinction between
- scm_before_sweep_c_hook and scm_after_sweep_c_hook, but even if
- there were no difference, it would still be useful to have two
- distinct classes of hook functions since this can prevent some
- bad interference when several modules adds gc hooks.
- */
- scm_c_hook_run (&scm_before_sweep_c_hook, 0);
-
- /*
- Nothing here: lazy sweeping.
- */
- scm_i_reset_segments ();
-
- *SCM_FREELIST_LOC (scm_i_freelist) = SCM_EOL;
- *SCM_FREELIST_LOC (scm_i_freelist2) = SCM_EOL;
-
- /* Invalidate the freelists of other threads. */
- scm_i_thread_invalidate_freelists ();
-
- scm_c_hook_run (&scm_after_sweep_c_hook, 0);
-
- gc_end_stats ();
-
- scm_i_gc_sweep_stats.collected = scm_i_gc_sweep_stats.swept = 0;
- scm_i_gc_sweep_freelist_reset (&scm_i_master_freelist);
- scm_i_gc_sweep_freelist_reset (&scm_i_master_freelist2);
-
- /* Arguably, this statistic is fairly useless: marking will dominate
- the time taken.
- */
- scm_gc_time_taken += (scm_c_get_internal_run_time () - t_before_gc);
-
- scm_i_thread_wake_up ();
- /*
- For debugging purposes, you could do
- scm_i_sweep_all_segments ("debug"), but then the remains of the
- cell aren't left to analyse.
- */
+ 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));
}
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
return res;
}
+#ifndef HAVE_GC_SET_FINALIZE_ON_DEMAND
+static void
+GC_set_finalize_on_demand (int foo)
+{
+ GC_finalize_on_demand = foo;
+}
+#endif
+
void
scm_storage_prehistory ()
{
+#ifdef HAVE_GC_SET_ALL_INTERIOR_POINTERS
+ /* This function was added in 7.2alpha2 (June 2009). */
+ GC_set_all_interior_pointers (0);
+#else
+ /* This symbol is deprecated in 7.3. */
+ GC_all_interior_pointers = 0;
+#endif
+
+ free_space_divisor = scm_getenv_int ("GC_FREE_SPACE_DIVISOR", 3);
+ minimum_free_space_divisor = free_space_divisor;
+ target_free_space_divisor = free_space_divisor;
+ GC_set_free_space_divisor (free_space_divisor);
+ GC_set_finalize_on_demand (1);
+
+ GC_INIT ();
+
+#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_c_hook_init (&scm_before_sweep_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;
-
- scm_gc_init_freelist ();
- scm_gc_init_malloc ();
+ 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 *fn_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;
}
-void
-scm_init_gc ()
+\f
+
+static void *
+start_gc_timer (void * hook_data SCM_UNUSED,
+ void *fn_data SCM_UNUSED,
+ void *data SCM_UNUSED)
{
- scm_gc_init_mark ();
+ if (!gc_start_time)
+ gc_start_time = scm_c_get_internal_run_time ();
- scm_after_gc_hook = scm_permanent_object (scm_make_hook (SCM_INUM0));
- scm_c_define ("after-gc-hook", scm_after_gc_hook);
+ return NULL;
+}
- gc_async = scm_c_make_subr ("%gc-thunk", scm_tc7_subr_0,
- gc_async_thunk);
+static void *
+accumulate_gc_timer (void * hook_data SCM_UNUSED,
+ void *fn_data SCM_UNUSED,
+ void *data SCM_UNUSED)
+{
+ if (gc_start_time)
+ {
+ long now = scm_c_get_internal_run_time ();
+ gc_time_taken += now - gc_start_time;
+ gc_start_time = 0;
+ }
- scm_c_hook_add (&scm_after_gc_c_hook, mark_gc_async, NULL, 0);
+ return NULL;
+}
-#include "libguile/gc.x"
+/* Return some idea of the memory footprint of a process, in bytes.
+ Currently only works on Linux systems. */
+static size_t
+get_image_size (void)
+{
+ unsigned long size, resident, share;
+ size_t ret = 0;
+
+ FILE *fp = fopen ("/proc/self/statm", "r");
+
+ if (fp && fscanf (fp, "%lu %lu %lu", &size, &resident, &share) == 3)
+ ret = resident * 4096;
+
+ if (fp)
+ fclose (fp);
+
+ return ret;
}
-#ifdef __ia64__
-# ifdef __hpux
-# include <sys/param.h>
-# include <sys/pstat.h>
-void *
-scm_ia64_register_backing_store_base (void)
+/* These are discussed later. */
+static size_t bytes_until_gc;
+static scm_i_pthread_mutex_t bytes_until_gc_lock = SCM_I_PTHREAD_MUTEX_INITIALIZER;
+
+/* Make GC run more frequently when the process image size is growing,
+ measured against the number of bytes allocated through the GC.
+
+ If Guile is allocating at a GC-managed heap size H, libgc will tend
+ to limit the process image size to H*N. But if at the same time the
+ user program is mallocating at a rate M bytes per GC-allocated byte,
+ then the process stabilizes at H*N*M -- assuming that collecting data
+ will result in malloc'd data being freed. It doesn't take a very
+ large M for this to be a bad situation. To limit the image size,
+ Guile should GC more often -- the bigger the M, the more often.
+
+ Numeric functions that produce bigger and bigger integers are
+ pessimal, because M is an increasing function of time. Here is an
+ example of such a function:
+
+ (define (factorial n)
+ (define (fac n acc)
+ (if (<= n 1)
+ acc
+ (fac (1- n) (* n acc))))
+ (fac n 1))
+
+ It is possible for a process to grow for reasons that will not be
+ solved by faster GC. In that case M will be estimated as
+ artificially high for a while, and so GC will happen more often on
+ the Guile side. But when it stabilizes, Guile can ease back the GC
+ frequency.
+
+ The key is to measure process image growth, not mallocation rate.
+ For maximum effectiveness, Guile reacts quickly to process growth,
+ and exponentially backs down when the process stops growing.
+
+ See http://thread.gmane.org/gmane.lisp.guile.devel/12552/focus=12936
+ for further discussion.
+ */
+static void *
+adjust_gc_frequency (void * hook_data SCM_UNUSED,
+ void *fn_data SCM_UNUSED,
+ void *data SCM_UNUSED)
{
- struct pst_vm_status vm_status;
- int i = 0;
- while (pstat_getprocvm (&vm_status, sizeof (vm_status), 0, i++) == 1)
- if (vm_status.pst_type == PS_RSESTACK)
- return (void *) vm_status.pst_vaddr;
- abort ();
+ static size_t prev_image_size = 0;
+ static size_t prev_bytes_alloced = 0;
+ size_t image_size;
+ size_t bytes_alloced;
+
+ scm_i_pthread_mutex_lock (&bytes_until_gc_lock);
+ bytes_until_gc = GC_get_heap_size ();
+ scm_i_pthread_mutex_unlock (&bytes_until_gc_lock);
+
+ image_size = get_image_size ();
+ bytes_alloced = GC_get_total_bytes ();
+
+#define HEURISTICS_DEBUG 0
+
+#if HEURISTICS_DEBUG
+ fprintf (stderr, "prev image / alloced: %lu / %lu\n", prev_image_size, prev_bytes_alloced);
+ fprintf (stderr, " image / alloced: %lu / %lu\n", image_size, bytes_alloced);
+ fprintf (stderr, "divisor %lu / %f\n", free_space_divisor, target_free_space_divisor);
+#endif
+
+ if (prev_image_size && bytes_alloced != prev_bytes_alloced)
+ {
+ double growth_rate, new_target_free_space_divisor;
+ double decay_factor = 0.5;
+ double hysteresis = 0.1;
+
+ growth_rate = ((double) image_size - prev_image_size)
+ / ((double)bytes_alloced - prev_bytes_alloced);
+
+#if HEURISTICS_DEBUG
+ fprintf (stderr, "growth rate %f\n", growth_rate);
+#endif
+
+ new_target_free_space_divisor = minimum_free_space_divisor;
+
+ if (growth_rate > 0)
+ new_target_free_space_divisor *= 1.0 + growth_rate;
+
+#if HEURISTICS_DEBUG
+ fprintf (stderr, "new divisor %f\n", new_target_free_space_divisor);
+#endif
+
+ if (new_target_free_space_divisor < target_free_space_divisor)
+ /* Decay down. */
+ target_free_space_divisor =
+ (decay_factor * target_free_space_divisor
+ + (1.0 - decay_factor) * new_target_free_space_divisor);
+ else
+ /* Jump up. */
+ target_free_space_divisor = new_target_free_space_divisor;
+
+#if HEURISTICS_DEBUG
+ fprintf (stderr, "new target divisor %f\n", target_free_space_divisor);
+#endif
+
+ if (free_space_divisor + 0.5 + hysteresis < target_free_space_divisor
+ || free_space_divisor - 0.5 - hysteresis > target_free_space_divisor)
+ {
+ free_space_divisor = lround (target_free_space_divisor);
+#if HEURISTICS_DEBUG
+ fprintf (stderr, "new divisor %lu\n", free_space_divisor);
+#endif
+ GC_set_free_space_divisor (free_space_divisor);
+ }
+ }
+
+ prev_image_size = image_size;
+ prev_bytes_alloced = bytes_alloced;
+
+ return NULL;
}
-void *
-scm_ia64_ar_bsp (const void *ctx)
+
+/* The adjust_gc_frequency routine handles transients in the process
+ image size. It can't handle instense non-GC-managed steady-state
+ allocation though, as it decays the FSD at steady-state down to its
+ minimum value.
+
+ The only real way to handle continuous, high non-GC allocation is to
+ let the GC know about it. This routine can handle non-GC allocation
+ rates that are similar in size to the GC-managed heap size.
+ */
+
+void
+scm_gc_register_allocation (size_t size)
{
- uint64_t bsp;
- __uc_get_ar_bsp (ctx, &bsp);
- return (void *) bsp;
+ scm_i_pthread_mutex_lock (&bytes_until_gc_lock);
+ if (bytes_until_gc - size > bytes_until_gc)
+ {
+ bytes_until_gc = GC_get_heap_size ();
+ scm_i_pthread_mutex_unlock (&bytes_until_gc_lock);
+ GC_gcollect ();
+ }
+ else
+ {
+ bytes_until_gc -= size;
+ scm_i_pthread_mutex_unlock (&bytes_until_gc_lock);
+ }
}
-# endif /* hpux */
-# ifdef linux
-# include <ucontext.h>
-void *
-scm_ia64_register_backing_store_base (void)
+
+
+\f
+
+char const *
+scm_i_tag_name (scm_t_bits tag)
{
- extern void *__libc_ia64_register_backing_store_base;
- return __libc_ia64_register_backing_store_base;
+ switch (tag & 0x7f) /* 7 bits */
+ {
+ case scm_tcs_struct:
+ return "struct";
+ case scm_tcs_cons_imcar:
+ return "cons (immediate car)";
+ case scm_tcs_cons_nimcar:
+ return "cons (non-immediate car)";
+ 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";
+ case scm_tc7_number:
+ switch (tag)
+ {
+ case scm_tc16_real:
+ return "real";
+ break;
+ case scm_tc16_big:
+ return "bignum";
+ break;
+ case scm_tc16_complex:
+ return "complex number";
+ break;
+ case scm_tc16_fraction:
+ return "fraction";
+ break;
+ }
+ break;
+ case scm_tc7_string:
+ return "string";
+ break;
+ case scm_tc7_stringbuf:
+ return "string buffer";
+ break;
+ case scm_tc7_symbol:
+ return "symbol";
+ break;
+ case scm_tc7_variable:
+ return "variable";
+ break;
+ case scm_tc7_port:
+ return "port";
+ break;
+ case scm_tc7_smob:
+ {
+ int k = 0xff & (tag >> 8);
+ return (scm_smobs[k].name);
+ }
+ break;
+ }
+
+ return NULL;
}
-void *
-scm_ia64_ar_bsp (const void *opaque)
+
+
+
+\f
+void
+scm_init_gc ()
{
- const ucontext_t *ctx = opaque;
- return (void *) ctx->uc_mcontext.sc_ar_bsp;
+ /* `GC_INIT ()' was invoked in `scm_storage_prehistory ()'. */
+
+ scm_after_gc_hook = scm_make_hook (SCM_INUM0);
+ scm_c_define ("after-gc-hook", scm_after_gc_hook);
+
+ /* 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_before_gc_c_hook, start_gc_timer, NULL, 0);
+ scm_c_hook_add (&scm_after_gc_c_hook, accumulate_gc_timer, NULL, 0);
+
+#if HAVE_GC_GET_HEAP_USAGE_SAFE
+ /* GC_get_heap_usage does not take a lock, and so can run in the GC
+ start hook. */
+ scm_c_hook_add (&scm_before_gc_c_hook, adjust_gc_frequency, NULL, 0);
+#else
+ /* GC_get_heap_usage might take a lock (and did from 7.2alpha1 to
+ 7.2alpha7), so call it in the after_gc_hook. */
+ scm_c_hook_add (&scm_after_gc_c_hook, adjust_gc_frequency, NULL, 0);
+#endif
+
+#ifdef HAVE_GC_SET_START_CALLBACK
+ GC_set_start_callback (run_before_gc_c_hook);
+#endif
+
+#include "libguile/gc.x"
}
-# endif /* linux */
-#endif /* __ia64__ */
+
void
scm_gc_sweep (void)
#define FUNC_NAME "scm_gc_sweep"
{
+ /* FIXME */
+ fprintf (stderr, "%s: doing nothing\n", FUNC_NAME);
}
-
#undef FUNC_NAME
-
-
/*
Local Variables:
c-file-style: "gnu"
HCoop / bpt / guile.git / blobdiff