Removed some stupid code.

[bpt/guile.git] / libguile / gc.c

/* Copyright (C) 1995, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 * 
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this software; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307 USA
 *
 * As a special exception, the Free Software Foundation gives permission
 * for additional uses of the text contained in its release of GUILE.
 *
 * The exception is that, if you link the GUILE library with other files
 * to produce an executable, this does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * Your use of that executable is in no way restricted on account of
 * linking the GUILE library code into it.
 *
 * This exception does not however invalidate any other reasons why
 * the executable file might be covered by the GNU General Public License.
 *
 * This exception applies only to the code released by the
 * Free Software Foundation under the name GUILE.  If you copy
 * code from other Free Software Foundation releases into a copy of
 * GUILE, as the General Public License permits, the exception does
 * not apply to the code that you add in this way.  To avoid misleading
 * anyone as to the status of such modified files, you must delete
 * this exception notice from them.
 *
 * If you write modifications of your own for GUILE, it is your choice
 * whether to permit this exception to apply to your modifications.
 * If you do not wish that, delete this exception notice.  */

/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */

\f
#include <stdio.h>
#include "_scm.h"
#include "stime.h"
#include "stackchk.h"
#include "struct.h"
#include "genio.h"
#include "weaks.h"
#include "guardians.h"
#include "smob.h"
#include "unif.h"
#include "async.h"

#include "validate.h"
#include "gc.h"

#ifdef HAVE_MALLOC_H
#include <malloc.h>
#endif

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#ifdef __STDC__
#include <stdarg.h>
#define var_start(x, y) va_start(x, y)
#else
#include <varargs.h>
#define var_start(x, y) va_start(x)
#endif

\f
/* {heap tuning parameters}
 * 
 * These are parameters for controlling memory allocation.  The heap
 * is the area out of which scm_cons, and object headers are allocated.
 *
 * Each heap cell is 8 bytes on a 32 bit machine and 16 bytes on a
 * 64 bit machine.  The units of the _SIZE parameters are bytes.
 * Cons pairs and object headers occupy one heap cell.
 *
 * SCM_INIT_HEAP_SIZE is the initial size of heap.  If this much heap is
 * allocated initially the heap will grow by half its current size
 * each subsequent time more heap is needed.
 *
 * If SCM_INIT_HEAP_SIZE heap cannot be allocated initially, SCM_HEAP_SEG_SIZE
 * will be used, and the heap will grow by SCM_HEAP_SEG_SIZE when more
 * heap is needed.  SCM_HEAP_SEG_SIZE must fit into type scm_sizet.  This code
 * is in scm_init_storage() and alloc_some_heap() in sys.c
 * 
 * If SCM_INIT_HEAP_SIZE can be allocated initially, the heap will grow by
 * SCM_EXPHEAP(scm_heap_size) when more heap is needed.
 *
 * SCM_MIN_HEAP_SEG_SIZE is minimum size of heap to accept when more heap
 * is needed.
 *
 * INIT_MALLOC_LIMIT is the initial amount of malloc usage which will
 * trigger a GC. 
 *
 * SCM_MTRIGGER_HYSTERESIS is the amount of malloc storage that must be
 * reclaimed by a GC triggered by must_malloc. If less than this is
 * reclaimed, the trigger threshold is raised. [I don't know what a
 * good value is. I arbitrarily chose 1/10 of the INIT_MALLOC_LIMIT to
 * work around a oscillation that caused almost constant GC.]  
 */

#define SCM_INIT_HEAP_SIZE (40000L * sizeof (scm_cell))
#define SCM_MIN_HEAP_SEG_SIZE (2048L * sizeof (scm_cell))
#ifdef _QC
# define SCM_HEAP_SEG_SIZE 32768L
#else
# ifdef sequent
#  define SCM_HEAP_SEG_SIZE (7000L*sizeof(scm_cell))
# else
#  define SCM_HEAP_SEG_SIZE (16384L*sizeof(scm_cell))
# endif
#endif
#define SCM_EXPHEAP(scm_heap_size) (scm_heap_size / 2)
#define SCM_INIT_MALLOC_LIMIT 100000
#define SCM_MTRIGGER_HYSTERESIS (SCM_INIT_MALLOC_LIMIT/10)

#define SCM_GC_TRIGGER 10000
#define SCM_GC_TRIGGER2 10000

/* CELL_UP and CELL_DN are used by scm_init_heap_seg to find scm_cell aligned inner
   bounds for allocated storage */

#ifdef PROT386
/*in 386 protected mode we must only adjust the offset */
# define CELL_UP(p) MK_FP(FP_SEG(p), ~7&(FP_OFF(p)+7))
# define CELL_DN(p) MK_FP(FP_SEG(p), ~7&FP_OFF(p))
#else
# ifdef _UNICOS
#  define CELL_UP(p) (SCM_CELLPTR)(~1L & ((long)(p)+1L))
#  define CELL_DN(p) (SCM_CELLPTR)(~1L & (long)(p))
# else
#  define CELL_UP(p) (SCM_CELLPTR)(~(sizeof(scm_cell)-1L) & ((long)(p)+sizeof(scm_cell)-1L))
#  define CELL_DN(p) (SCM_CELLPTR)(~(sizeof(scm_cell)-1L) & (long)(p))
# endif                         /* UNICOS */
#endif                          /* PROT386 */


\f
/* scm_freelists
 */

#ifdef GUILE_NEW_GC_SCHEME
SCM scm_freelist = SCM_EOL;
scm_freelist_t scm_master_freelist = {
  SCM_EOL, 0, SCM_EOL, SCM_EOL, 0, 0, 1, 0, 0
};
SCM scm_freelist2 = SCM_EOL;
scm_freelist_t scm_master_freelist2 = {
  SCM_EOL, 0, SCM_EOL, SCM_EOL, 0, 0, 2, 0, 0
};
#else
scm_freelist_t scm_freelist = { SCM_EOL, 1, 0, 0 };
scm_freelist_t scm_freelist2 = { SCM_EOL, 2, 0, 0 };
#endif

/* scm_mtrigger
 * is the number of bytes of must_malloc allocation needed to trigger gc.
 */
unsigned long scm_mtrigger;


/* scm_gc_heap_lock
 * If set, don't expand the heap.  Set only during gc, during which no allocation
 * is supposed to take place anyway.
 */
int scm_gc_heap_lock = 0;

/* GC Blocking
 * Don't pause for collection if this is set -- just
 * expand the heap.
 */

int scm_block_gc = 1;

/* If fewer than MIN_GC_YIELD cells are recovered during a garbage
 * collection (GC) more space is allocated for the heap.
 */
#define MIN_GC_YIELD(freelist) (freelist->heap_size / 4)

/* During collection, this accumulates objects holding
 * weak references.
 */
SCM scm_weak_vectors;

/* GC Statistics Keeping
 */
unsigned long scm_cells_allocated = 0;
long scm_mallocated = 0;
/* unsigned long scm_gc_cells_collected; */
unsigned long scm_gc_malloc_collected;
unsigned long scm_gc_ports_collected;
unsigned long scm_gc_rt;
unsigned long scm_gc_time_taken = 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");


struct scm_heap_seg_data
{
  /* lower and upper bounds of the segment */
  SCM_CELLPTR bounds[2];

  /* address of the head-of-freelist pointer for this segment's cells.
     All segments usually point to the same one, scm_freelist.  */
  scm_freelist_t *freelistp;

  /* number of SCM words per object in this segment */
  int span;

  /* If SEG_DATA->valid is non-zero, the conservative marking
     functions will apply SEG_DATA->valid to the purported pointer and
     SEG_DATA, and mark the object iff the function returns non-zero.
     At the moment, I don't think anyone uses this.  */
  int (*valid) ();
};




static void scm_mark_weak_vector_spines (void);
static scm_sizet init_heap_seg (SCM_CELLPTR, scm_sizet, scm_freelist_t *);
static void alloc_some_heap (scm_freelist_t *);


\f
/* Debugging functions.  */

#ifdef GUILE_DEBUG_FREELIST

/* Return the number of the heap segment containing CELL.  */
static int
which_seg (SCM cell)
{
  int i;

  for (i = 0; i < scm_n_heap_segs; i++)
    if (SCM_PTR_LE (scm_heap_table[i].bounds[0], (SCM_CELLPTR) cell)
        && SCM_PTR_GT (scm_heap_table[i].bounds[1], (SCM_CELLPTR) cell))
      return i;
  fprintf (stderr, "which_seg: can't find segment containing cell %lx\n",
           SCM_UNPACK (cell));
  abort ();
}


static void
map_free_list (scm_freelist_t *freelistp)
{
  int last_seg = -1, count = 0;
  SCM f;
  
  for (f = freelistp->cells; SCM_NIMP (f); f = SCM_CDR (f))
    {
      int this_seg = which_seg (f);

      if (this_seg != last_seg)
        {
          if (last_seg != -1)
            fprintf (stderr, "  %5d %d-cells in segment %d\n",
                     count, freelistp->span, last_seg);
          last_seg = this_seg;
          count = 0;
        }
      count++;
    }
  if (last_seg != -1)
    fprintf (stderr, "  %5d %d-cells in segment %d\n",
             count, freelistp->span, last_seg);
}

SCM_DEFINE (scm_map_free_list, "map-free-list", 0, 0, 0, 
            (),
            "Print debugging information about the free-list.\n"
            "`map-free-list' is only included in GUILE_DEBUG_FREELIST builds of Guile.")
#define FUNC_NAME s_scm_map_free_list
{
  fprintf (stderr, "%d segments total\n", scm_n_heap_segs);
#ifdef GUILE_NEW_GC_SCHEME
  map_free_list (&scm_master_freelist);
  map_free_list (&scm_master_freelist2);
#else
  map_free_list (&scm_freelist);
  map_free_list (&scm_freelist2);
#endif
  fflush (stderr);

  return SCM_UNSPECIFIED;
}
#undef FUNC_NAME


/* Number of calls to SCM_NEWCELL since startup.  */
static unsigned long scm_newcell_count;
static unsigned long scm_newcell2_count;

/* Search freelist for anything that isn't marked as a free cell.
   Abort if we find something.  */
static void
scm_check_freelist (scm_freelist_t *freelistp)
{
  SCM f;
  int i = 0;

  for (f = freelistp->cells; SCM_NIMP (f); f = SCM_CDR (f), i++)
    if (SCM_CAR (f) != (SCM) scm_tc_free_cell)
      {
        fprintf (stderr, "Bad cell in freelist on newcell %lu: %d'th elt\n",
                 scm_newcell_count, i);
        fflush (stderr);
        abort ();
      }
}

static int scm_debug_check_freelist = 0;

SCM_DEFINE (scm_gc_set_debug_check_freelist_x, "gc-set-debug-check-freelist!", 1, 0, 0, 
            (SCM flag),
            "If FLAG is #t, check the freelist for consistency on each cell allocation.\n"
            "This procedure only exists because the GUILE_DEBUG_FREELIST \n"
            "compile-time flag was selected.\n")
#define FUNC_NAME s_scm_gc_set_debug_check_freelist_x
{
  SCM_VALIDATE_BOOL_COPY (1, flag, scm_debug_check_freelist);
  return SCM_UNSPECIFIED;
}
#undef FUNC_NAME


#ifdef GUILE_NEW_GC_SCHEME

SCM
scm_debug_newcell (void)
{
  SCM new;

  scm_newcell_count++;
  if (scm_debug_check_freelist)
    {
      scm_check_freelist (&scm_master_freelist);
      scm_gc();
    }

  /* The rest of this is supposed to be identical to the SCM_NEWCELL
     macro.  */
  if (SCM_IMP (scm_freelist))
    new = scm_gc_for_newcell (&scm_master_freelist, &scm_freelist);
  else
    {
      new = scm_freelist;
      scm_freelist = SCM_CDR (scm_freelist);
      SCM_SETCAR (new, scm_tc16_allocated);
    }

  return new;
}

SCM
scm_debug_newcell2 (void)
{
  SCM new;

  scm_newcell2_count++;
  if (scm_debug_check_freelist)
    {
      scm_check_freelist (&scm_master_freelist2);
      scm_gc ();
    }

  /* The rest of this is supposed to be identical to the SCM_NEWCELL
     macro.  */
  if (SCM_IMP (scm_freelist2))
    new = scm_gc_for_newcell (&scm_master_freelist2, &scm_freelist2);
  else
    {
      new = scm_freelist2;
      scm_freelist2 = SCM_CDR (scm_freelist2);
      SCM_SETCAR (new, scm_tc16_allocated);
    }

  return new;
}

#else /* GUILE_NEW_GC_SCHEME */

SCM
scm_debug_newcell (void)
{
  SCM new;

  scm_newcell_count++;
  if (scm_debug_check_freelist)
    {
      scm_check_freelist (&scm_freelist);
      scm_gc();
    }

  /* The rest of this is supposed to be identical to the SCM_NEWCELL
     macro.  */
  if (SCM_IMP (scm_freelist.cells))
    new = scm_gc_for_newcell (&scm_freelist);
  else
    {
      new = scm_freelist.cells;
      scm_freelist.cells = SCM_CDR (scm_freelist.cells);
      SCM_SETCAR (new, scm_tc16_allocated);
      ++scm_cells_allocated;
    }

  return new;
}

SCM
scm_debug_newcell2 (void)
{
  SCM new;

  scm_newcell2_count++;
  if (scm_debug_check_freelist) {
    scm_check_freelist (&scm_freelist2);
    scm_gc();
  }

  /* The rest of this is supposed to be identical to the SCM_NEWCELL2
     macro.  */
  if (SCM_IMP (scm_freelist2.cells))
    new = scm_gc_for_newcell (&scm_freelist2);
  else
    {
      new = scm_freelist2.cells;
      scm_freelist2.cells = SCM_CDR (scm_freelist2.cells);
      SCM_SETCAR (new, scm_tc16_allocated);
      scm_cells_allocated += 2;
    }

  return new;
}

#endif /* GUILE_NEW_GC_SCHEME */
#endif /* GUILE_DEBUG_FREELIST */

\f

/* {Scheme Interface to GC}
 */

SCM_DEFINE (scm_gc_stats, "gc-stats", 0, 0, 0, 
            (),
            "Returns an association list of statistics about Guile's current use of storage.  ")
#define FUNC_NAME s_scm_gc_stats
{
  int i;
  int n;
  SCM heap_segs;
  long int local_scm_mtrigger;
  long int local_scm_mallocated;
  long int local_scm_heap_size;
  long int local_scm_cells_allocated;
  long int local_scm_gc_time_taken;
  SCM answer;

  SCM_DEFER_INTS;
  scm_block_gc = 1;
 retry:
  heap_segs = SCM_EOL;
  n = scm_n_heap_segs;
  for (i = scm_n_heap_segs; i--; )
    heap_segs = scm_cons (scm_cons (scm_ulong2num ((unsigned long)scm_heap_table[i].bounds[1]),
                                    scm_ulong2num ((unsigned long)scm_heap_table[i].bounds[0])),
                          heap_segs);
  if (scm_n_heap_segs != n)
    goto retry;
  scm_block_gc = 0;

  /// ? ?? ? 
  local_scm_mtrigger = scm_mtrigger;
  local_scm_mallocated = scm_mallocated;
#ifdef GUILE_NEW_GC_SCHEME
  local_scm_heap_size = scm_master_freelist.heap_size; /*fixme*/
#else
  local_scm_heap_size = scm_freelist.heap_size; /*fixme*/
#endif
  local_scm_cells_allocated = scm_cells_allocated;
  local_scm_gc_time_taken = scm_gc_time_taken;

  answer = scm_listify (scm_cons (sym_gc_time_taken, scm_ulong2num (local_scm_gc_time_taken)),
                        scm_cons (sym_cells_allocated, scm_ulong2num (local_scm_cells_allocated)),
                        scm_cons (sym_heap_size, scm_ulong2num (local_scm_heap_size)),
                        scm_cons (sym_mallocated, scm_ulong2num (local_scm_mallocated)),
                        scm_cons (sym_mtrigger, scm_ulong2num (local_scm_mtrigger)),
                        scm_cons (sym_heap_segments, heap_segs),
                        SCM_UNDEFINED);
  SCM_ALLOW_INTS;
  return answer;
}
#undef FUNC_NAME


void 
scm_gc_start (const char *what)
{
  scm_gc_rt = SCM_INUM (scm_get_internal_run_time ());
  /* scm_gc_cells_collected = 0; */
  scm_gc_malloc_collected = 0;
  scm_gc_ports_collected = 0;
}

void 
scm_gc_end ()
{
  scm_gc_rt = SCM_INUM (scm_get_internal_run_time ()) - scm_gc_rt;
  scm_gc_time_taken += scm_gc_rt;
  scm_system_async_mark (scm_gc_async);
}


SCM_DEFINE (scm_object_address, "object-address", 1, 0, 0, 
            (SCM obj),
            "Return an integer that for the lifetime of @var{obj} is uniquely\n"
            "returned by this function for @var{obj}")
#define FUNC_NAME s_scm_object_address
{
  return scm_ulong2num ((unsigned long) 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_DEFER_INTS;
  scm_igc ("call");
  SCM_ALLOW_INTS;
  return SCM_UNSPECIFIED;
}
#undef FUNC_NAME


\f
/* {C Interface For When GC is Triggered}
 */

#ifdef GUILE_NEW_GC_SCHEME

/* When we get POSIX threads support, the master will be global and
   common while the freelist will be individual for each thread. */

SCM
scm_gc_for_newcell (scm_freelist_t *master, SCM *freelist)
{
  SCM cell;
  ++scm_ints_disabled;
  if (master->triggeredp)
    scm_igc ("cells");
  else if (SCM_NULLP (master->clusters))
    alloc_some_heap (master);
  else if (SCM_NULLP (SCM_CDR (master->clusters)))
    /* we are satisfied; GC instead of alloc next time around */
    master->triggeredp = 1;
  --scm_ints_disabled;
  cell = SCM_CAR (master->clusters);
  master->clusters = SCM_CDR (master->clusters);
  *freelist = SCM_CDR (cell);
  SCM_SETCAR (cell, scm_tc16_allocated);
  return cell;
}

#else /* GUILE_NEW_GC_SCHEME */

void
scm_gc_for_alloc (scm_freelist_t *freelistp)
{
  SCM_REDEFER_INTS;
  scm_igc ("cells");
#ifdef GUILE_DEBUG_FREELIST
  fprintf (stderr, "Collected: %d, min_yield: %d\n",
           freelistp->collected, MIN_GC_YIELD (freelistp));
#endif
  if ((freelistp->collected < MIN_GC_YIELD (freelistp))
      || SCM_IMP (freelistp->cells))
    alloc_some_heap (freelistp);
  SCM_REALLOW_INTS;
}


SCM 
scm_gc_for_newcell (scm_freelist_t *freelistp)
{
  SCM fl;
  scm_gc_for_alloc (freelistp);
  fl = freelistp->cells;
  freelistp->cells = SCM_CDR (fl);
  SCM_SETCAR (fl, scm_tc16_allocated);
  return fl;
}

#endif /* GUILE_NEW_GC_SCHEME */

void
scm_igc (const char *what)
{
  int j;

#ifdef USE_THREADS
  /* During the critical section, only the current thread may run. */
  SCM_THREAD_CRITICAL_SECTION_START;
#endif

  /* fprintf (stderr, "gc: %s\n", what); */

  scm_gc_start (what);

  if (!scm_stack_base || scm_block_gc)
    {
      scm_gc_end ();
      return;
    }

  if (scm_mallocated < 0)
    /* 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.  */
    abort ();

  if (scm_gc_heap_lock)
    /* We've invoked the collector while a GC is already in progress.
       That should never happen.  */
    abort ();

  ++scm_gc_heap_lock;

  scm_weak_vectors = SCM_EOL;

  scm_guardian_gc_init ();

  /* unprotect any struct types with no instances */
#if 0
  {
    SCM type_list;
    SCM * pos;

    pos = &scm_type_obj_list;
    type_list = scm_type_obj_list;
    while (type_list != SCM_EOL)
      if (SCM_VELTS (SCM_CAR (type_list))[scm_struct_i_refcnt])
        {
          pos = SCM_CDRLOC (type_list);
          type_list = SCM_CDR (type_list);
        }
      else
        {
          *pos = SCM_CDR (type_list);
          type_list = SCM_CDR (type_list);
        }
  }
#endif

  /* flush dead entries from the continuation stack */
  {
    int x;
    int bound;
    SCM * elts;
    elts = SCM_VELTS (scm_continuation_stack);
    bound = SCM_LENGTH (scm_continuation_stack);
    x = SCM_INUM (scm_continuation_stack_ptr);
    while (x < bound)
      {
        elts[x] = SCM_BOOL_F;
        ++x;
      }
  }

#ifndef USE_THREADS
  
  /* Protect from the C stack.  This must be the first marking
   * done because it provides information about what objects
   * are "in-use" by the C code.   "in-use" objects are  those
   * for which the values from SCM_LENGTH and SCM_CHARS must remain
   * usable.   This requirement is stricter than a liveness
   * requirement -- in particular, it constrains the implementation
   * of scm_vector_set_length_x.
   */
  SCM_FLUSH_REGISTER_WINDOWS;
  /* This assumes that all registers are saved into the jmp_buf */
  setjmp (scm_save_regs_gc_mark);
  scm_mark_locations ((SCM_STACKITEM *) scm_save_regs_gc_mark,
                      (   (scm_sizet) (sizeof (SCM_STACKITEM) - 1 +
                                       sizeof scm_save_regs_gc_mark)
                          / sizeof (SCM_STACKITEM)));

  {
    /* stack_len is long rather than scm_sizet in order to guarantee that
       &stack_len is long aligned */
#ifdef SCM_STACK_GROWS_UP
#ifdef nosve
    long stack_len = (SCM_STACKITEM *) (&stack_len) - scm_stack_base;
#else
    long stack_len = scm_stack_size (scm_stack_base);
#endif
    scm_mark_locations (scm_stack_base, (scm_sizet) stack_len);
#else
#ifdef nosve
    long stack_len = scm_stack_base - (SCM_STACKITEM *) (&stack_len);
#else
    long stack_len = scm_stack_size (scm_stack_base);
#endif
    scm_mark_locations ((scm_stack_base - stack_len), (scm_sizet) stack_len);
#endif
  }

#else /* USE_THREADS */

  /* Mark every thread's stack and registers */
  scm_threads_mark_stacks ();

#endif /* USE_THREADS */

  /* FIXME: insert a phase to un-protect string-data preserved
   * in scm_vector_set_length_x.
   */

  j = SCM_NUM_PROTECTS;
  while (j--)
    scm_gc_mark (scm_sys_protects[j]);

  /* FIXME: we should have a means to register C functions to be run
   * in different phases of GC
   */ 
  scm_mark_subr_table ();
  
#ifndef USE_THREADS
  scm_gc_mark (scm_root->handle);
#endif
  
  scm_mark_weak_vector_spines ();

  scm_guardian_zombify ();

  scm_gc_sweep ();

  --scm_gc_heap_lock;
  scm_gc_end ();

#ifdef USE_THREADS
  SCM_THREAD_CRITICAL_SECTION_END;
#endif
}

\f
/* {Mark/Sweep} 
 */



/* Mark an object precisely.
 */
void 
scm_gc_mark (SCM p)
{
  register long i;
  register SCM ptr;

  ptr = p;

gc_mark_loop:
  if (SCM_IMP (ptr))
    return;

gc_mark_nimp:
  if (SCM_NCELLP (ptr))
    scm_wta (ptr, "rogue pointer in heap", NULL);

  switch (SCM_TYP7 (ptr))
    {
    case scm_tcs_cons_nimcar:
      if (SCM_GCMARKP (ptr))
        break;
      SCM_SETGCMARK (ptr);
      if (SCM_IMP (SCM_CDR (ptr))) /* SCM_IMP works even with a GC mark */
        {
          ptr = SCM_CAR (ptr);
          goto gc_mark_nimp;
        }
      scm_gc_mark (SCM_CAR (ptr));
      ptr = SCM_GCCDR (ptr);
      goto gc_mark_nimp;
    case scm_tcs_cons_imcar:
      if (SCM_GCMARKP (ptr))
        break;
      SCM_SETGCMARK (ptr);
      ptr = SCM_GCCDR (ptr);
      goto gc_mark_loop;
    case scm_tc7_pws:
      if (SCM_GCMARKP (ptr))
        break;
      SCM_SETGCMARK (ptr);
      scm_gc_mark (SCM_CELL_WORD (ptr, 2));
      ptr = SCM_GCCDR (ptr);
      goto gc_mark_loop;
    case scm_tcs_cons_gloc:
      if (SCM_GCMARKP (ptr))
        break;
      SCM_SETGCMARK (ptr);
      {
        SCM vcell;
        vcell = SCM_CAR (ptr) - 1L;
        switch (SCM_UNPACK (SCM_CDR (vcell)))
          {
          default:
            scm_gc_mark (vcell);
            ptr = SCM_GCCDR (ptr);
            goto gc_mark_loop;
          case 1:               /* ! */
          case 0:               /* ! */
            {
              SCM layout;
              SCM * vtable_data;
              int len;
              char * fields_desc;
              register SCM * mem;
              register int x;

              vtable_data = (SCM *)vcell;
              layout = vtable_data[scm_vtable_index_layout];
              len = SCM_LENGTH (layout);
              fields_desc = SCM_CHARS (layout);
              /* We're using SCM_GCCDR here like STRUCT_DATA, except
                 that it removes the mark */
              mem = (SCM *)SCM_GCCDR (ptr);
              
              if (SCM_UNPACK (vtable_data[scm_struct_i_flags]) & SCM_STRUCTF_ENTITY)
                {
                  scm_gc_mark (mem[scm_struct_i_procedure]);
                  scm_gc_mark (mem[scm_struct_i_setter]);
                }
              if (len)
                {
                  for (x = 0; x < len - 2; x += 2, ++mem)
                    if (fields_desc[x] == 'p')
                      scm_gc_mark (*mem);
                  if (fields_desc[x] == 'p')
                    {
                      int j;
                      if (SCM_LAYOUT_TAILP (fields_desc[x + 1]))
                        for (j = (long int) *mem; x; --x)
                          scm_gc_mark (*++mem);
                      else
                        scm_gc_mark (*mem);
                    }
                }
              if (!SCM_CDR (vcell))
                {
                  SCM_SETGCMARK (vcell);
                  ptr = vtable_data[scm_vtable_index_vtable];
                  goto gc_mark_loop;
                }
            }
          }
      }
      break;
    case scm_tcs_closures:
      if (SCM_GCMARKP (ptr))
        break;
      SCM_SETGCMARK (ptr);
      if (SCM_IMP (SCM_CDR (ptr)))
        {
          ptr = SCM_CLOSCAR (ptr);
          goto gc_mark_nimp;
        }
      scm_gc_mark (SCM_CLOSCAR (ptr));
      ptr = SCM_GCCDR (ptr);
      goto gc_mark_nimp;
    case scm_tc7_vector:
    case scm_tc7_lvector:
#ifdef CCLO
    case scm_tc7_cclo:
#endif
      if (SCM_GC8MARKP (ptr))
        break;
      SCM_SETGC8MARK (ptr);
      i = SCM_LENGTH (ptr);
      if (i == 0)
        break;
      while (--i > 0)
        if (SCM_NIMP (SCM_VELTS (ptr)[i]))
          scm_gc_mark (SCM_VELTS (ptr)[i]);
      ptr = SCM_VELTS (ptr)[0];
      goto gc_mark_loop;
    case scm_tc7_contin:
      if SCM_GC8MARKP
        (ptr) break;
      SCM_SETGC8MARK (ptr);
      if (SCM_VELTS (ptr))
        scm_mark_locations (SCM_VELTS_AS_STACKITEMS (ptr),
                            (scm_sizet)
                            (SCM_LENGTH (ptr) +
                             (sizeof (SCM_STACKITEM) + -1 +
                              sizeof (scm_contregs)) /
                             sizeof (SCM_STACKITEM)));
      break;
#ifdef HAVE_ARRAYS
    case scm_tc7_bvect:
    case scm_tc7_byvect:
    case scm_tc7_ivect:
    case scm_tc7_uvect:
    case scm_tc7_fvect:
    case scm_tc7_dvect:
    case scm_tc7_cvect:
    case scm_tc7_svect:
#ifdef HAVE_LONG_LONGS
    case scm_tc7_llvect:
#endif
#endif
    case scm_tc7_string:
      SCM_SETGC8MARK (ptr);
      break;

    case scm_tc7_substring:
      if (SCM_GC8MARKP(ptr))
        break;
      SCM_SETGC8MARK (ptr);
      ptr = SCM_CDR (ptr);
      goto gc_mark_loop;

    case scm_tc7_wvect:
      if (SCM_GC8MARKP(ptr))
        break;
      SCM_WVECT_GC_CHAIN (ptr) = scm_weak_vectors;
      scm_weak_vectors = ptr;
      SCM_SETGC8MARK (ptr);
      if (SCM_IS_WHVEC_ANY (ptr))
        {
          int x;
          int len;
          int weak_keys;
          int weak_values;

          len = SCM_LENGTH (ptr);
          weak_keys = SCM_IS_WHVEC (ptr) || SCM_IS_WHVEC_B (ptr);
          weak_values = SCM_IS_WHVEC_V (ptr) || SCM_IS_WHVEC_B (ptr);
          
          for (x = 0; x < len; ++x)
            {
              SCM alist;
              alist = SCM_VELTS (ptr)[x];

              /* mark everything on the alist except the keys or
               * values, according to weak_values and weak_keys.  */
              while (   SCM_CONSP (alist)
                     && !SCM_GCMARKP (alist)
                     && SCM_CONSP (SCM_CAR (alist)))
                {
                  SCM kvpair;
                  SCM next_alist;

                  kvpair = SCM_CAR (alist);
                  next_alist = SCM_CDR (alist);
                  /* 
                   * Do not do this:
                   *    SCM_SETGCMARK (alist);
                   *    SCM_SETGCMARK (kvpair);
                   *
                   * It may be that either the key or value is protected by
                   * an escaped reference to part of the spine of this alist.
                   * If we mark the spine here, and only mark one or neither of the
                   * key and value, they may never be properly marked.
                   * This leads to a horrible situation in which an alist containing
                   * freelist cells is exported.
                   *
                   * So only mark the spines of these arrays last of all marking.
                   * If somebody confuses us by constructing a weak vector
                   * with a circular alist then we are hosed, but at least we
                   * won't prematurely drop table entries.
                   */
                  if (!weak_keys)
                    scm_gc_mark (SCM_CAR (kvpair));
                  if (!weak_values)
                    scm_gc_mark (SCM_GCCDR (kvpair));
                  alist = next_alist;
                }
              if (SCM_NIMP (alist))
                scm_gc_mark (alist);
            }
        }
      break;

    case scm_tc7_msymbol:
      if (SCM_GC8MARKP(ptr))
        break;
      SCM_SETGC8MARK (ptr);
      scm_gc_mark (SCM_SYMBOL_FUNC (ptr));
      ptr = SCM_SYMBOL_PROPS (ptr);
      goto gc_mark_loop;
    case scm_tc7_ssymbol:
      if (SCM_GC8MARKP(ptr))
        break;
      SCM_SETGC8MARK (ptr);
      break;
    case scm_tcs_subrs:
      break;
    case scm_tc7_port:
      i = SCM_PTOBNUM (ptr);
      if (!(i < scm_numptob))
        goto def;
      if (SCM_GC8MARKP (ptr))
        break;
      SCM_SETGC8MARK (ptr);
      if (SCM_PTAB_ENTRY(ptr))
        scm_gc_mark (SCM_PTAB_ENTRY(ptr)->file_name);
      if (scm_ptobs[i].mark)
        {
          ptr = (scm_ptobs[i].mark) (ptr);
          goto gc_mark_loop;
        }
      else
        return;
      break;
    case scm_tc7_smob:
      if (SCM_GC8MARKP (ptr))
        break;
      SCM_SETGC8MARK (ptr);
      switch (SCM_GCTYP16 (ptr))
        { /* should be faster than going through scm_smobs */
        case scm_tc_free_cell:
          /* printf("found free_cell %X ", ptr); fflush(stdout); */
        case scm_tc16_allocated:
        case scm_tc16_big:
        case scm_tc16_real:
        case scm_tc16_complex:
          break;
        default:
          i = SCM_SMOBNUM (ptr);
          if (!(i < scm_numsmob))
            goto def;
          if (scm_smobs[i].mark)
            {
              ptr = (scm_smobs[i].mark) (ptr);
              goto gc_mark_loop;
            }
          else
            return;
        }
      break;
    default:
    def:scm_wta (ptr, "unknown type in ", "gc_mark");
    }
}


/* Mark a Region Conservatively
 */

void 
scm_mark_locations (SCM_STACKITEM x[], scm_sizet n)
{
  register long m = n;
  register int i, j;
  register SCM_CELLPTR ptr;

  while (0 <= --m)
    if (SCM_CELLP (*(SCM **) (& x[m])))
      {
        ptr = (SCM_CELLPTR) SCM2PTR ((*(SCM **) & x[m]));
        i = 0;
        j = scm_n_heap_segs - 1;
        if (   SCM_PTR_LE (scm_heap_table[i].bounds[0], ptr)
            && SCM_PTR_GT (scm_heap_table[j].bounds[1], ptr))
          {
            while (i <= j)
              {
                int seg_id;
                seg_id = -1;
                if (   (i == j)
                    || SCM_PTR_GT (scm_heap_table[i].bounds[1], ptr))
                  seg_id = i;
                else if (SCM_PTR_LE (scm_heap_table[j].bounds[0], ptr))
                  seg_id = j;
                else
                  {
                    int k;
                    k = (i + j) / 2;
                    if (k == i)
                      break;
                    if (SCM_PTR_GT (scm_heap_table[k].bounds[1], ptr))
                      {
                        j = k;
                        ++i;
                        if (SCM_PTR_LE (scm_heap_table[i].bounds[0], ptr))
                          continue;
                        else
                          break;
                      }
                    else if (SCM_PTR_LE (scm_heap_table[k].bounds[0], ptr))
                      {
                        i = k;
                        --j;
                        if (SCM_PTR_GT (scm_heap_table[j].bounds[1], ptr))
                          continue;
                        else
                          break;
                      }
                  }
                if (   !scm_heap_table[seg_id].valid
                    || scm_heap_table[seg_id].valid (ptr,
                                                     &scm_heap_table[seg_id]))
                  scm_gc_mark (*(SCM *) & x[m]);
                break;
              }

          }
      }
}


/* The following is a C predicate which determines if an SCM value can be
   regarded as a pointer to a cell on the heap.  The code is duplicated
   from scm_mark_locations.  */


int
scm_cellp (SCM value)
{
  register int i, j;
  register SCM_CELLPTR ptr;
  
  if SCM_CELLP (*(SCM **) (& value))
    {
      ptr = (SCM_CELLPTR) SCM2PTR ((*(SCM **) & value));
      i = 0;
      j = scm_n_heap_segs - 1;
      if (   SCM_PTR_LE (scm_heap_table[i].bounds[0], ptr)
             && SCM_PTR_GT (scm_heap_table[j].bounds[1], ptr))
        {
          while (i <= j)
            {
              int seg_id;
              seg_id = -1;
              if (   (i == j)
                     || SCM_PTR_GT (scm_heap_table[i].bounds[1], ptr))
                seg_id = i;
              else if (SCM_PTR_LE (scm_heap_table[j].bounds[0], ptr))
                seg_id = j;
              else
                {
                  int k;
                  k = (i + j) / 2;
                  if (k == i)
                    break;
                  if (SCM_PTR_GT (scm_heap_table[k].bounds[1], ptr))
                    {
                      j = k;
                      ++i;
                      if (SCM_PTR_LE (scm_heap_table[i].bounds[0], ptr))
                        continue;
                      else
                        break;
                    }
                  else if (SCM_PTR_LE (scm_heap_table[k].bounds[0], ptr))
                    {
                      i = k;
                      --j;
                      if (SCM_PTR_GT (scm_heap_table[j].bounds[1], ptr))
                        continue;
                      else
                        break;
                    }
                }
              if (   !scm_heap_table[seg_id].valid
                     || scm_heap_table[seg_id].valid (ptr,
                                                      &scm_heap_table[seg_id]))
                return 1;
              break;
            }

        }
    }
  return 0;
}


static void
scm_mark_weak_vector_spines ()
{
  SCM w;

  for (w = scm_weak_vectors; w != SCM_EOL; w = SCM_WVECT_GC_CHAIN (w))
    {
      if (SCM_IS_WHVEC_ANY (w))
        {
          SCM *ptr;
          SCM obj;
          int j;
          int n;

          obj = w;
          ptr = SCM_VELTS (w);
          n = SCM_LENGTH (w);
          for (j = 0; j < n; ++j)
            {
              SCM alist;

              alist = ptr[j];
              while (   SCM_CONSP (alist)
                     && !SCM_GCMARKP (alist) 
                     && SCM_CONSP  (SCM_CAR (alist)))
                {
                  SCM_SETGCMARK (alist);
                  SCM_SETGCMARK (SCM_CAR (alist));
                  alist = SCM_GCCDR (alist);
                }
            }
        }
    }
}



void 
scm_gc_sweep ()
{
  register SCM_CELLPTR ptr;
#ifdef SCM_POINTERS_MUNGED
  register SCM scmptr;
#else
#undef scmptr
#define scmptr (SCM)ptr
#endif
  register SCM nfreelist;
  register scm_freelist_t *hp_freelist;
  register long m;
  register int span;
#ifdef GUILE_NEW_GC_SCHEME
  long n_objects;
#endif
  long i;
  scm_sizet seg_size;

  m = 0;

#ifdef GUILE_NEW_GC_SCHEME
  /* Reset all free list pointers.  We'll reconstruct them completely
     while scanning.  */
  for (i = 0; i < scm_n_heap_segs; i++)
    {
      scm_heap_table[i].freelistp->cells = SCM_EOL;
      scm_heap_table[i].freelistp->n_objects
        = scm_heap_table[i].freelistp->gc_trigger;
      scm_heap_table[i].freelistp->clusters = SCM_EOL;
      scm_heap_table[i].freelistp->clustertail
        = &scm_heap_table[i].freelistp->clusters;
      scm_heap_table[i].freelistp->triggeredp = 0;
    }
#else
  /* Reset all free list pointers.  We'll reconstruct them completely
     while scanning.  */
  for (i = 0; i < scm_n_heap_segs; i++)
    scm_heap_table[i].freelistp->cells = SCM_EOL;
#endif
  
  for (i = 0; i < scm_n_heap_segs; i++)
    {
      register scm_sizet n = 0;
      register scm_sizet j;

      /* Unmarked cells go onto the front of the freelist this heap
         segment points to.  Rather than updating the real freelist
         pointer as we go along, we accumulate the new head in
         nfreelist.  Then, if it turns out that the entire segment is
         free, we free (i.e., malloc's free) the whole segment, and
         simply don't assign nfreelist back into the real freelist.  */
      hp_freelist = scm_heap_table[i].freelistp;
      nfreelist = hp_freelist->cells;
#ifdef GUILE_NEW_GC_SCHEME
      n_objects = hp_freelist->n_objects;
#endif
      span = scm_heap_table[i].span;
      hp_freelist->collected = 0;

      ptr = CELL_UP (scm_heap_table[i].bounds[0]);
      seg_size = CELL_DN (scm_heap_table[i].bounds[1]) - ptr;
      for (j = seg_size + span; j -= span; ptr += span)
        {
#ifdef SCM_POINTERS_MUNGED
          scmptr = PTR2SCM (ptr);
#endif
          switch SCM_TYP7 (scmptr)
            {
            case scm_tcs_cons_gloc:
              if (SCM_GCMARKP (scmptr))
                {
                  if (SCM_CDR (SCM_CAR (scmptr) - 1) == (SCM)1)
                    SCM_SETCDR (SCM_CAR (scmptr) - 1, (SCM) 0);
                  goto cmrkcontinue;
                }
              {
                SCM vcell;
                vcell = SCM_CAR (scmptr) - 1L;

                if ((SCM_CDR (vcell) == 0) || (SCM_UNPACK (SCM_CDR (vcell)) == 1))
                  {
                    scm_struct_free_t free
                      = (scm_struct_free_t) ((SCM*) vcell)[scm_struct_i_free];
                    m += free ((SCM *) vcell, (SCM *) SCM_GCCDR (scmptr));
                  }
              }
              break;
            case scm_tcs_cons_imcar:
            case scm_tcs_cons_nimcar:
            case scm_tcs_closures:
            case scm_tc7_pws:
              if (SCM_GCMARKP (scmptr))
                goto cmrkcontinue;
              break;
            case scm_tc7_wvect:
              if (SCM_GC8MARKP (scmptr))
                {
                  goto c8mrkcontinue;
                }
              else
                {
                  m += (2 + SCM_LENGTH (scmptr)) * sizeof (SCM);
                  scm_must_free ((char *)(SCM_VELTS (scmptr) - 2));
                  break;
                }

            case scm_tc7_vector:
            case scm_tc7_lvector:
#ifdef CCLO
            case scm_tc7_cclo:
#endif
              if (SCM_GC8MARKP (scmptr))
                goto c8mrkcontinue;

              m += (SCM_LENGTH (scmptr) * sizeof (SCM));
            freechars:
              scm_must_free (SCM_CHARS (scmptr));
              /*        SCM_SETCHARS(scmptr, 0);*/
              break;
#ifdef HAVE_ARRAYS
            case scm_tc7_bvect:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              m += sizeof (long) * ((SCM_HUGE_LENGTH (scmptr) + SCM_LONG_BIT - 1) / SCM_LONG_BIT);
              goto freechars;
            case scm_tc7_byvect:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              m += SCM_HUGE_LENGTH (scmptr) * sizeof (char);
              goto freechars;
            case scm_tc7_ivect:
            case scm_tc7_uvect:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              m += SCM_HUGE_LENGTH (scmptr) * sizeof (long);
              goto freechars;
            case scm_tc7_svect:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              m += SCM_HUGE_LENGTH (scmptr) * sizeof (short);
              goto freechars;
#ifdef HAVE_LONG_LONGS
            case scm_tc7_llvect:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              m += SCM_HUGE_LENGTH (scmptr) * sizeof (long_long);
              goto freechars;
#endif
            case scm_tc7_fvect:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              m += SCM_HUGE_LENGTH (scmptr) * sizeof (float);
              goto freechars;
            case scm_tc7_dvect:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              m += SCM_HUGE_LENGTH (scmptr) * sizeof (double);
              goto freechars;
            case scm_tc7_cvect:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              m += SCM_HUGE_LENGTH (scmptr) * 2 * sizeof (double);
              goto freechars;
#endif
            case scm_tc7_substring:
              if (SCM_GC8MARKP (scmptr))
                goto c8mrkcontinue;
              break;
            case scm_tc7_string:
              if (SCM_GC8MARKP (scmptr))
                goto c8mrkcontinue;
              m += SCM_HUGE_LENGTH (scmptr) + 1;
              goto freechars;
            case scm_tc7_msymbol:
              if (SCM_GC8MARKP (scmptr))
                goto c8mrkcontinue;
              m += (  SCM_LENGTH (scmptr)
                    + 1
                    + sizeof (SCM) * ((SCM *)SCM_CHARS (scmptr) - SCM_SLOTS(scmptr)));
              scm_must_free ((char *)SCM_SLOTS (scmptr));
              break;
            case scm_tc7_contin:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              m += SCM_LENGTH (scmptr) * sizeof (SCM_STACKITEM) + sizeof (scm_contregs);
              if (SCM_VELTS (scmptr))
                goto freechars;
            case scm_tc7_ssymbol:
              if SCM_GC8MARKP(scmptr)
                goto c8mrkcontinue;
              break;
            case scm_tcs_subrs:
              continue;
            case scm_tc7_port:
              if SCM_GC8MARKP (scmptr)
                goto c8mrkcontinue;
              if SCM_OPENP (scmptr)
                {
                  int k = SCM_PTOBNUM (scmptr);
                  if (!(k < scm_numptob))
                    goto sweeperr;
                  /* Keep "revealed" ports alive.  */
                  if (scm_revealed_count (scmptr) > 0)
                    continue;
                  /* Yes, I really do mean scm_ptobs[k].free */
                  /* rather than ftobs[k].close.  .close */
                  /* is for explicit CLOSE-PORT by user */
                  m += (scm_ptobs[k].free) (scmptr);
                  SCM_SETSTREAM (scmptr, 0);
                  scm_remove_from_port_table (scmptr);
                  scm_gc_ports_collected++;
                  SCM_SETAND_CAR (scmptr, ~SCM_OPN);
                }
              break;
            case scm_tc7_smob:
              switch SCM_GCTYP16 (scmptr)
                {
                case scm_tc_free_cell:
                case scm_tc16_real:
                  if SCM_GC8MARKP (scmptr)
                    goto c8mrkcontinue;
                  break;
#ifdef SCM_BIGDIG
                case scm_tc16_big:
                  if SCM_GC8MARKP (scmptr)
                    goto c8mrkcontinue;
                  m += (SCM_NUMDIGS (scmptr) * SCM_BITSPERDIG / SCM_CHAR_BIT);
                  goto freechars;
#endif /* def SCM_BIGDIG */
                case scm_tc16_complex:
                  if SCM_GC8MARKP (scmptr)
                    goto c8mrkcontinue;
                  m += 2 * sizeof (double);
                  goto freechars;
                default:
                  if SCM_GC8MARKP (scmptr)
                    goto c8mrkcontinue;

                  {
                    int k;
                    k = SCM_SMOBNUM (scmptr);
                    if (!(k < scm_numsmob))
                      goto sweeperr;
                    m += (scm_smobs[k].free) ((SCM) scmptr);
                    break;
                  }
                }
              break;
            default:
            sweeperr:scm_wta (scmptr, "unknown type in ", "gc_sweep");
            }
#if 0
          if (SCM_CAR (scmptr) == (SCM) scm_tc_free_cell)
            exit (2);
#endif
#ifndef GUILE_NEW_GC_SCHEME
          n += span;
#else
          if (--n_objects < 0)
            {
              SCM_SETCAR (scmptr, nfreelist);
              *hp_freelist->clustertail = scmptr;
              hp_freelist->clustertail = SCM_CDRLOC (scmptr);
                  
              nfreelist = SCM_EOL;
              n_objects = hp_freelist->gc_trigger;
              n += span * (n_objects + 1);
            }
          else
#endif
            {
              /* Stick the new cell on the front of nfreelist.  It's
                 critical that we mark this cell as freed; otherwise, the
                 conservative collector might trace it as some other type
                 of object.  */
              SCM_SETCAR (scmptr, scm_tc_free_cell);
              SCM_SETCDR (scmptr, nfreelist);
              nfreelist = scmptr;
            }

          continue;
        c8mrkcontinue:
          SCM_CLRGC8MARK (scmptr);
          continue;
        cmrkcontinue:
          SCM_CLRGCMARK (scmptr);
        }
#ifdef GC_FREE_SEGMENTS
      if (n == seg_size)
        {
          register long j;

          hp_freelist->heap_size -= seg_size;
          free ((char *) scm_heap_table[i].bounds[0]);
          scm_heap_table[i].bounds[0] = 0;
          for (j = i + 1; j < scm_n_heap_segs; j++)
            scm_heap_table[j - 1] = scm_heap_table[j];
          scm_n_heap_segs -= 1;
          i--;          /* We need to scan the segment just moved.  */
        }
      else
#endif /* ifdef GC_FREE_SEGMENTS */
        {
          /* Update the real freelist pointer to point to the head of
             the list of free cells we've built for this segment.  */
          hp_freelist->cells = nfreelist;
#ifdef GUILE_NEW_GC_SCHEME
          hp_freelist->n_objects = n_objects;
#endif
        }

#ifdef GUILE_NEW_GC_SCHEME
      j = span * (hp_freelist->gc_trigger - n_objects);
      /* sum up---if this is last turn for this freelist */
      hp_freelist->collected += n + j;
      n -= j; /* compensate for the sum up */
#else
      hp_freelist->collected += n;
#endif
      scm_cells_allocated += hp_freelist->heap_size - hp_freelist->collected;

#ifdef GUILE_DEBUG_FREELIST
      scm_check_freelist (hp_freelist);
      scm_map_free_list ();
#endif
    }

#ifdef GUILE_NEW_GC_SCHEME
  for (i = 0; i < scm_n_heap_segs; i++)
    {
      scm_freelist_t *hp_freelist = scm_heap_table[i].freelistp;
      if (hp_freelist->gc_trigger - hp_freelist->n_objects > 1)
        {
          SCM c = hp_freelist->cells;
          SCM_SETCAR (c, SCM_CDR (c));
          SCM_SETCDR (c, SCM_EOL);
          *hp_freelist->clustertail = c;
          hp_freelist->n_objects = hp_freelist->gc_trigger;
        }
      else
        *hp_freelist->clustertail = SCM_EOL;
#if 0
      fprintf (stderr, "%d:%d: ",
               i, scm_ilength (hp_freelist->clusters));
      {
        SCM ls, c = hp_freelist->clusters;
        int n;
        while (SCM_NNULLP (c))
          {
            ls = SCM_CAR (c);
            for (n = 0; SCM_NNULLP (ls); ls = SCM_CDR (ls))
              ++n;
            fprintf (stderr, "%d ", n);
            c = SCM_CDR (c);
          }
        fprintf (stderr, "\n");
      }
#endif
    }
#endif
  
  /* Scan weak vectors. */
  {
    SCM *ptr, w;
    for (w = scm_weak_vectors; w != SCM_EOL; w = SCM_WVECT_GC_CHAIN (w))
      {
        if (!SCM_IS_WHVEC_ANY (w))
          {
            register long j, n;

            ptr = SCM_VELTS (w);
            n = SCM_LENGTH (w);
            for (j = 0; j < n; ++j)
              if (SCM_FREEP (ptr[j]))
                ptr[j] = SCM_BOOL_F;
          }
        else /* if (SCM_IS_WHVEC_ANY (scm_weak_vectors[i])) */
          {
            SCM obj = w;
            register long n = SCM_LENGTH (w);
            register long j;

            ptr = SCM_VELTS (w);

            for (j = 0; j < n; ++j)
              {
                SCM * fixup;
                SCM alist;
                int weak_keys;
                int weak_values;
                
                weak_keys = SCM_IS_WHVEC (obj) || SCM_IS_WHVEC_B (obj);
                weak_values = SCM_IS_WHVEC_V (obj) || SCM_IS_WHVEC_B (obj);

                fixup = ptr + j;
                alist = *fixup;

                while (   SCM_CONSP (alist)
                       && SCM_CONSP (SCM_CAR (alist)))
                  {
                    SCM key;
                    SCM value;

                    key = SCM_CAAR (alist);
                    value = SCM_CDAR (alist);
                    if (   (weak_keys && SCM_FREEP (key))
                        || (weak_values && SCM_FREEP (value)))
                      {
                        *fixup = SCM_CDR (alist);
                      }
                    else
                      fixup = SCM_CDRLOC (alist);
                    alist = SCM_CDR (alist);
                  }
              }
          }
      }
  }
  scm_mallocated -= m;
  scm_gc_malloc_collected = m;
}


\f

/* {Front end to malloc}
 *
 * scm_must_malloc, scm_must_realloc, scm_must_free, scm_done_malloc
 *
 * These functions provide services comperable to malloc, realloc, and
 * free.  They are for allocating malloced parts of scheme objects.
 * The primary purpose of the front end is to impose calls to gc.
 */

/* scm_must_malloc
 * Return newly malloced storage or throw an error.
 *
 * The parameter WHAT is a string for error reporting.
 * If the threshold scm_mtrigger will be passed by this 
 * allocation, or if the first call to malloc fails,
 * garbage collect -- on the presumption that some objects
 * using malloced storage may be collected.
 *
 * The limit scm_mtrigger may be raised by this allocation.
 */
void *
scm_must_malloc (scm_sizet size, const char *what)
{
  void *ptr;
  unsigned long nm = scm_mallocated + size;

  if (nm <= scm_mtrigger)
    {
      SCM_SYSCALL (ptr = malloc (size));
      if (NULL != ptr)
        {
          scm_mallocated = nm;
          return ptr;
        }
    }

  scm_igc (what);

  nm = scm_mallocated + size;
  SCM_SYSCALL (ptr = malloc (size));
  if (NULL != ptr)
    {
      scm_mallocated = nm;
      if (nm > scm_mtrigger - SCM_MTRIGGER_HYSTERESIS) {
        if (nm > scm_mtrigger)
          scm_mtrigger = nm + nm / 2;
        else
          scm_mtrigger += scm_mtrigger / 2;
      }
      return ptr;
    }

  scm_wta (SCM_MAKINUM (size), (char *) SCM_NALLOC, what);
  return 0; /* never reached */
}


/* scm_must_realloc
 * is similar to scm_must_malloc.
 */
void *
scm_must_realloc (void *where,
                  scm_sizet old_size,
                  scm_sizet size,
                  const char *what)
{
  void *ptr;
  scm_sizet nm = scm_mallocated + size - old_size;

  if (nm <= scm_mtrigger)
    {
      SCM_SYSCALL (ptr = realloc (where, size));
      if (NULL != ptr)
        {
          scm_mallocated = nm;
          return ptr;
        }
    }

  scm_igc (what);

  nm = scm_mallocated + size - old_size;
  SCM_SYSCALL (ptr = realloc (where, size));
  if (NULL != ptr)
    {
      scm_mallocated = nm;
      if (nm > scm_mtrigger - SCM_MTRIGGER_HYSTERESIS) {
        if (nm > scm_mtrigger)
          scm_mtrigger = nm + nm / 2;
        else
          scm_mtrigger += scm_mtrigger / 2;
      }
      return ptr;
    }

  scm_wta (SCM_MAKINUM (size), (char *) SCM_NALLOC, what);
  return 0; /* never reached */
}

void 
scm_must_free (void *obj)
{
  if (obj)
    free (obj);
  else
    scm_wta (SCM_INUM0, "already free", "");
}

/* Announce that there has been some malloc done that will be freed
 * during gc.  A typical use is for a smob that uses some malloced
 * memory but can not get it from scm_must_malloc (for whatever
 * reason).  When a new object of this smob is created you call
 * scm_done_malloc with the size of the object.  When your smob free
 * function is called, be sure to include this size in the return
 * value. */

void
scm_done_malloc (long size)
{
  scm_mallocated += size;

  if (scm_mallocated > scm_mtrigger)
    {
      scm_igc ("foreign mallocs");
      if (scm_mallocated > scm_mtrigger - SCM_MTRIGGER_HYSTERESIS)
        {
          if (scm_mallocated > scm_mtrigger)
            scm_mtrigger = scm_mallocated + scm_mallocated / 2;
          else
            scm_mtrigger += scm_mtrigger / 2;
        }
    }
}


\f

/* {Heap Segments}
 *
 * Each heap segment is an array of objects of a particular size.
 * Every segment has an associated (possibly shared) freelist.
 * A table of segment records is kept that records the upper and
 * lower extents of the segment;  this is used during the conservative
 * phase of gc to identify probably gc roots (because they point
 * into valid segments at reasonable offsets).  */

/* scm_expmem
 * is true if the first segment was smaller than INIT_HEAP_SEG.
 * If scm_expmem is set to one, subsequent segment allocations will
 * allocate segments of size SCM_EXPHEAP(scm_heap_size).
 */
int scm_expmem = 0;

/* scm_heap_org
 * is the lowest base address of any heap segment.
 */
SCM_CELLPTR scm_heap_org;

struct scm_heap_seg_data * scm_heap_table = 0;
int scm_n_heap_segs = 0;

/* init_heap_seg
 * initializes a new heap segment and return the number of objects it contains.
 *
 * The segment origin, segment size in bytes, and the span of objects
 * in cells are input parameters.  The freelist is both input and output.
 *
 * This function presume that the scm_heap_table has already been expanded
 * to accomodate a new segment record.
 */


static scm_sizet 
init_heap_seg (SCM_CELLPTR seg_org, scm_sizet size, scm_freelist_t *freelistp)
{
  register SCM_CELLPTR ptr;
#ifdef SCM_POINTERS_MUNGED
  register SCM scmptr;
#else
#undef scmptr
#define scmptr ptr
#endif
  SCM_CELLPTR seg_end;
  int new_seg_index;
  int n_new_cells;
  int span = freelistp->span;
  
  if (seg_org == NULL)
    return 0;

  ptr = seg_org;

  size = (size / sizeof (scm_cell) / span) * span * sizeof (scm_cell);

  /* Compute the ceiling on valid object pointers w/in this segment. 
   */
  seg_end = CELL_DN ((char *) ptr + size);

  /* Find the right place and insert the segment record. 
   *
   */
  for (new_seg_index = 0;
       (   (new_seg_index < scm_n_heap_segs)
        && SCM_PTR_LE (scm_heap_table[new_seg_index].bounds[0], seg_org));
       new_seg_index++)
    ;

  {
    int i;
    for (i = scm_n_heap_segs; i > new_seg_index; --i)
      scm_heap_table[i] = scm_heap_table[i - 1];
  }
  
  ++scm_n_heap_segs;

  scm_heap_table[new_seg_index].valid = 0;
  scm_heap_table[new_seg_index].span = span;
  scm_heap_table[new_seg_index].freelistp = freelistp;
  scm_heap_table[new_seg_index].bounds[0] = (SCM_CELLPTR)ptr;
  scm_heap_table[new_seg_index].bounds[1] = (SCM_CELLPTR)seg_end;


  /* Compute the least valid object pointer w/in this segment 
   */
  ptr = CELL_UP (ptr);


  /*n_new_cells*/
  n_new_cells = seg_end - ptr;

#ifdef GUILE_NEW_GC_SCHEME

  freelistp->heap_size += n_new_cells;

  /* Partition objects in this segment into clusters
   */
  {
    SCM clusters;
    SCM *clusterp = &clusters;
    int trigger = span * freelistp->gc_trigger;
    int n, c = 0;

    while (n_new_cells > span)
      {
        if (n_new_cells > trigger)
          n = span + trigger;
        else
          n = n_new_cells;
        n_new_cells -= n;
        n -= span;
        c += span;

        *clusterp = PTR2SCM (ptr);
        SCM_SETCAR (*clusterp, PTR2SCM (ptr + span));
        clusterp = SCM_CDRLOC (*clusterp);
        
        ptr += span;
        seg_end = ptr + n;
        while (ptr < seg_end)
          {
#ifdef SCM_POINTERS_MUNGED
            scmptr = PTR2SCM (ptr);
#endif
            SCM_SETCAR (scmptr, scm_tc_free_cell);
            SCM_SETCDR (scmptr, PTR2SCM (ptr + span));
            ptr += span;
          }
        SCM_SETCDR (PTR2SCM (ptr - span), SCM_EOL);
      }

    /* Correction for cluster cells + spill */
    freelistp->heap_size -= c + n_new_cells;
        
    /* Patch up the last cluster pointer in the segment
     * to join it to the input freelist.
     */
    *clusterp = freelistp->clusters;
    freelistp->clusters = clusters;
  }

#else /* GUILE_NEW_GC_SCHEME */

  /* Prepend objects in this segment to the freelist. 
   */
  while (ptr < seg_end)
    {
#ifdef SCM_POINTERS_MUNGED
      scmptr = PTR2SCM (ptr);
#endif
      SCM_SETCAR (scmptr, (SCM) scm_tc_free_cell);
      SCM_SETCDR (scmptr, PTR2SCM (ptr + span));
      ptr += span;
    }

  ptr -= span;

  /* Patch up the last freelist pointer in the segment
   * to join it to the input freelist.
   */
  SCM_SETCDR (PTR2SCM (ptr), freelistp->cells);
  freelistp->cells = PTR2SCM (CELL_UP (seg_org));

  freelistp->heap_size += n_new_cells;
  
#endif /* GUILE_NEW_GC_SCHEME */
  
  return size;
#ifdef scmptr
#undef scmptr
#endif
}


static void 
alloc_some_heap (scm_freelist_t *freelistp)
{
  struct scm_heap_seg_data * tmptable;
  SCM_CELLPTR ptr;
  scm_sizet len;

  /* Critical code sections (such as the garbage collector)
   * aren't supposed to add heap segments.
   */
  if (scm_gc_heap_lock)
    scm_wta (SCM_UNDEFINED, "need larger initial", "heap");

  /* Expand the heap tables to have room for the new segment.
   * Do not yet increment scm_n_heap_segs -- that is done by init_heap_seg
   * only if the allocation of the segment itself succeeds.
   */
  len = (1 + scm_n_heap_segs) * sizeof (struct scm_heap_seg_data);

  SCM_SYSCALL (tmptable = ((struct scm_heap_seg_data *)
                       realloc ((char *)scm_heap_table, len)));
  if (!tmptable)
    scm_wta (SCM_UNDEFINED, "could not grow", "hplims");
  else
    scm_heap_table = tmptable;


  /* Pick a size for the new heap segment.
   * The rule for picking the size of a segment is explained in 
   * gc.h
   */
  if (scm_expmem)
    {
      len = (scm_sizet) SCM_EXPHEAP (freelistp->heap_size * sizeof (scm_cell));
      if ((scm_sizet) SCM_EXPHEAP (freelistp->heap_size * sizeof (scm_cell))
          != len)
        len = 0;
    }
  else
    len = SCM_HEAP_SEG_SIZE;

  {
    scm_sizet smallest;

    smallest = (freelistp->span * sizeof (scm_cell));
    if (len < smallest)
      len = (freelistp->span * sizeof (scm_cell));

    /* Allocate with decaying ambition. */
    while ((len >= SCM_MIN_HEAP_SEG_SIZE)
           && (len >= smallest))
      {
        SCM_SYSCALL (ptr = (SCM_CELLPTR) malloc (len));
        if (ptr)
          {
            init_heap_seg (ptr, len, freelistp);
            return;
          }
        len /= 2;
      }
  }

  scm_wta (SCM_UNDEFINED, "could not grow", "heap");
}



SCM_DEFINE (scm_unhash_name, "unhash-name", 1, 0, 0, 
            (SCM name),
            "")
#define FUNC_NAME s_scm_unhash_name
{
  int x;
  int bound;
  SCM_VALIDATE_SYMBOL (1,name);
  SCM_DEFER_INTS;
  bound = scm_n_heap_segs;
  for (x = 0; x < bound; ++x)
    {
      SCM_CELLPTR p;
      SCM_CELLPTR pbound;
      p  = (SCM_CELLPTR)scm_heap_table[x].bounds[0];
      pbound = (SCM_CELLPTR)scm_heap_table[x].bounds[1];
      while (p < pbound)
        {
          SCM incar;
          incar = p->car;
          if (1 == (7 & (int)incar))
            {
              --incar;
              if (   ((name == SCM_BOOL_T) || (SCM_CAR (incar) == name))
                  && (SCM_CDR (incar) != 0)
                  && (SCM_UNPACK (SCM_CDR (incar)) != 1))
                {
                  p->car = name;
                }
            }
          ++p;
        }
    }
  SCM_ALLOW_INTS;
  return name;
}
#undef FUNC_NAME


\f
/* {GC Protection Helper Functions}
 */


void
scm_remember (SCM *ptr)
{ /* empty */ }


/*
  These crazy functions prevent garbage collection
  of arguments after the first argument by
  ensuring they remain live throughout the
  function because they are used in the last
  line of the code block.
  It'd be better to have a nice compiler hint to
  aid the conservative stack-scanning GC. --03/09/00 gjb */
SCM
scm_return_first (SCM elt, ...)
{
  return elt;
}

int
scm_return_first_int (int i, ...)
{
  return i;
}


SCM
scm_permanent_object (SCM obj)
{
  SCM_REDEFER_INTS;
  scm_permobjs = scm_cons (obj, scm_permobjs);
  SCM_REALLOW_INTS;
  return obj;
}


/* Protect OBJ from the garbage collector.  OBJ will not be freed,
   even if all other references are dropped, until someone applies
   scm_unprotect_object to it.  This function returns OBJ.

   Calls to scm_protect_object nest.  For every object OBJ, there is a
   counter which scm_protect_object(OBJ) increments and
   scm_unprotect_object(OBJ) decrements, if it is greater than zero.  If
   an object's counter is greater than zero, the garbage collector
   will not free it.

   Of course, that's not how it's implemented.  scm_protect_object and
   scm_unprotect_object just maintain a list of references to things.
   Since the GC knows about this list, all objects it mentions stay
   alive.  scm_protect_object adds its argument to the list;
   scm_unprotect_object removes the first occurrence of its argument
   to the list.  */
SCM
scm_protect_object (SCM obj)
{
  scm_protects = scm_cons (obj, scm_protects);

  return obj;
}


/* Remove any protection for OBJ established by a prior call to
   scm_protect_object.  This function returns OBJ.

   See scm_protect_object for more information.  */
SCM
scm_unprotect_object (SCM obj)
{
  SCM *tail_ptr = &scm_protects;

  while (SCM_CONSP (*tail_ptr))
    if (SCM_CAR (*tail_ptr) == obj)
      {
        *tail_ptr = SCM_CDR (*tail_ptr);
        break;
      }
    else
      tail_ptr = SCM_CDRLOC (*tail_ptr);

  return obj;
}

int terminating;

/* called on process termination.  */
#ifdef HAVE_ATEXIT
static void
cleanup (void)
#else
#ifdef HAVE_ON_EXIT
extern int on_exit (void (*procp) (), int arg);

static void
cleanup (int status, void *arg)
#else
#error Dont know how to setup a cleanup handler on your system.
#endif
#endif
{
  terminating = 1;
  scm_flush_all_ports ();
}

\f
static int
make_initial_segment (scm_sizet init_heap_size, scm_freelist_t *freelistp)
{
  if (0L == init_heap_size)
    init_heap_size = SCM_INIT_HEAP_SIZE;
  if (!init_heap_seg ((SCM_CELLPTR) malloc (init_heap_size),
                      init_heap_size,
                      freelistp))
    {
      init_heap_size = SCM_HEAP_SEG_SIZE;
      if (!init_heap_seg ((SCM_CELLPTR) malloc (init_heap_size),
                          init_heap_size,
                          freelistp))
        return 1;
    }
  else
    scm_expmem = 1;

  return 0;
}

\f
#ifdef GUILE_NEW_GC_SCHEME
int
scm_init_storage (scm_sizet init_heap_size, int gc_trigger,
                  scm_sizet init_heap2_size, int gc_trigger2)
#else
int
scm_init_storage (scm_sizet init_heap_size, scm_sizet init_heap2_size)
#endif
{
  scm_sizet j;

  j = SCM_NUM_PROTECTS;
  while (j)
    scm_sys_protects[--j] = SCM_BOOL_F;
  scm_block_gc = 1;

#ifdef GUILE_NEW_GC_SCHEME
  scm_freelist = SCM_EOL;
  scm_master_freelist.clusters = SCM_EOL;
  scm_master_freelist.triggeredp = 0;
  scm_master_freelist.gc_trigger
    = gc_trigger ? gc_trigger : SCM_GC_TRIGGER;
  scm_master_freelist.span = 1;
  scm_master_freelist.collected = 0;
  scm_master_freelist.heap_size = 0;
#else
  scm_freelist.cells = SCM_EOL;
  scm_freelist.span = 1;
  scm_freelist.collected = 0;
  scm_freelist.heap_size = 0;
#endif

#ifdef GUILE_NEW_GC_SCHEME
  scm_freelist2 = SCM_EOL;
  scm_master_freelist2.clusters = SCM_EOL;
  scm_master_freelist2.triggeredp = 0;
  scm_master_freelist2.gc_trigger
    = gc_trigger2 ? gc_trigger2 : SCM_GC_TRIGGER2;
  scm_master_freelist2.span = 2;
  scm_master_freelist2.collected = 0;
  scm_master_freelist2.heap_size = 0;
#else
  scm_freelist2.cells = SCM_EOL;
  scm_freelist2.span = 2;
  scm_freelist2.collected = 0;
  scm_freelist2.heap_size = 0;
#endif

  scm_expmem = 0;

  j = SCM_HEAP_SEG_SIZE;
  scm_mtrigger = SCM_INIT_MALLOC_LIMIT;
  scm_heap_table = ((struct scm_heap_seg_data *)
                    scm_must_malloc (sizeof (struct scm_heap_seg_data) * 2, "hplims"));

#ifdef GUILE_NEW_GC_SCHEME
  if (make_initial_segment (init_heap_size, &scm_master_freelist) ||
      make_initial_segment (init_heap2_size, &scm_master_freelist2))
    return 1;
#else
  if (make_initial_segment (init_heap_size, &scm_freelist) ||
      make_initial_segment (init_heap2_size, &scm_freelist2))
    return 1;
#endif

  scm_heap_org = CELL_UP (scm_heap_table[0].bounds[0]);

  /* scm_hplims[0] can change. do not remove scm_heap_org */
  scm_weak_vectors = SCM_EOL;

  /* Initialise the list of ports.  */
  scm_port_table = (scm_port **)
    malloc (sizeof (scm_port *) * scm_port_table_room);
  if (!scm_port_table)
    return 1;

#ifdef HAVE_ATEXIT
  atexit (cleanup);
#else
#ifdef HAVE_ON_EXIT
  on_exit (cleanup, 0);
#endif
#endif

  scm_undefineds = scm_cons (SCM_UNDEFINED, SCM_EOL);
  SCM_SETCDR (scm_undefineds, scm_undefineds);

  scm_listofnull = scm_cons (SCM_EOL, SCM_EOL);
  scm_nullstr = scm_makstr (0L, 0);
  scm_nullvect = scm_make_vector (SCM_INUM0, SCM_UNDEFINED);
  scm_symhash = scm_make_vector ((SCM) SCM_MAKINUM (scm_symhash_dim), SCM_EOL);
  scm_weak_symhash = scm_make_weak_key_hash_table ((SCM) SCM_MAKINUM (scm_symhash_dim));
  scm_symhash_vars = scm_make_vector ((SCM) SCM_MAKINUM (scm_symhash_dim), SCM_EOL);
  scm_stand_in_procs = SCM_EOL;
  scm_permobjs = SCM_EOL;
  scm_protects = SCM_EOL;
  scm_asyncs = SCM_EOL;
  scm_sysintern ("most-positive-fixnum", (SCM) SCM_MAKINUM (SCM_MOST_POSITIVE_FIXNUM));
  scm_sysintern ("most-negative-fixnum", (SCM) SCM_MAKINUM (SCM_MOST_NEGATIVE_FIXNUM));
#ifdef SCM_BIGDIG
  scm_sysintern ("bignum-radix", SCM_MAKINUM (SCM_BIGRAD));
#endif
  return 0;
}
\f

void
scm_init_gc ()
{
#include "gc.x"
}