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

/* classes: h_files */

#ifndef SCM_GC_H
#define SCM_GC_H

/* Copyright (C) 1995,1996,1998,1999,2000,2001 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.  */

\f

#include "libguile/__scm.h"

#include "libguile/hooks.h"

\f

typedef struct scm_t_cell
{
  scm_t_bits word_0;
  scm_t_bits word_1;
} scm_t_cell;


/* SCM_CELLPTR is a pointer to a cons cell which may be compared or
 * differenced.
 */
typedef scm_t_cell * SCM_CELLPTR;


/* Cray machines have pointers that are incremented once for each word,
 * rather than each byte, the 3 most significant bits encode the byte
 * within the word.  The following macros deal with this by storing the
 * native Cray pointers like the ones that looks like scm expects.  This
 * is done for any pointers that might appear in the car of a scm_t_cell,
 * pointers to scm_vector elts, functions, &c are not munged.
 */
#ifdef _UNICOS
#  define SCM2PTR(x) ((SCM_CELLPTR) (SCM_UNPACK (x) >> 3))
#  define PTR2SCM(x) (SCM_PACK (((scm_t_bits) (x)) << 3))
#else
#  define SCM2PTR(x) ((SCM_CELLPTR) (SCM_UNPACK (x)))
#  define PTR2SCM(x) (SCM_PACK ((scm_t_bits) (x)))
#endif /* def _UNICOS */

#ifdef GENGC
/*
  TODO
 */
#else /* ! genGC */ 

#define SCM_GC_CARD_N_HEADER_CELLS 1
#define SCM_GC_CARD_N_CELLS        256

#define SCM_GC_CARD_GENERATION(card)  
#define SCM_GC_FLAG_OBJECT_WRITE(x)  

#define SCM_GC_CARD_BVEC(card)  ((scm_t_c_bvec_limb *) ((card)->word_0))
#define SCM_GC_SET_CARD_BVEC(card, bvec) \
    ((card)->word_0 = (scm_t_bits) (bvec))
#endif


#define SCM_GC_CARD_SIZE           (SCM_GC_CARD_N_CELLS * sizeof (scm_t_cell))
#define SCM_GC_CARD_N_DATA_CELLS   (SCM_GC_CARD_N_CELLS - SCM_GC_CARD_N_HEADER_CELLS)

#define SCM_GC_CARD_BVEC_SIZE_IN_LIMBS \
    ((SCM_GC_CARD_N_CELLS + SCM_C_BVEC_LIMB_BITS - 1) / SCM_C_BVEC_LIMB_BITS)

#define SCM_GC_IN_CARD_HEADERP(x) \
    SCM_PTR_LT ((scm_t_cell *) (x), SCM_GC_CELL_CARD (x) + SCM_GC_CARD_N_HEADER_CELLS)

#define SCM_GC_GET_CARD_FLAGS(card) ((long) ((card)->word_1))
#define SCM_GC_SET_CARD_FLAGS(card, flags) \
    ((card)->word_1 = (scm_t_bits) (flags))
#define SCM_GC_CLR_CARD_FLAGS(card) (SCM_GC_SET_CARD_FLAGS (card, 0L))

#define SCM_GC_GET_CARD_FLAG(card, shift) (SCM_GC_GET_CARD_FLAGS (card) & (1L << (shift)))
#define SCM_GC_SET_CARD_FLAG(card, shift) \
    (SCM_GC_SET_CARD_FLAGS (card, SCM_GC_GET_CARD_FLAGS(card) | (1L << (shift))))
#define SCM_GC_CLR_CARD_FLAG(card, shift) \
    (SCM_GC_SET_CARD_FLAGS (card, SCM_GC_GET_CARD_FLAGS(card) & ~(1L << (shift))))

#define SCM_GC_CARDF_DOUBLECELL 0

#define SCM_GC_CARD_DOUBLECELLP(card)    SCM_GC_GET_CARD_FLAG (card, SCM_GC_CARDF_DOUBLECELL)
#define SCM_GC_SET_CARD_DOUBLECELL(card) SCM_GC_SET_CARD_FLAG (card, SCM_GC_CARDF_DOUBLECELL)

/* card addressing. for efficiency, cards are *always* aligned to
   SCM_GC_CARD_SIZE. */

#define SCM_GC_CARD_SIZE_MASK  (SCM_GC_CARD_SIZE - 1)
#define SCM_GC_CARD_ADDR_MASK  (~SCM_GC_CARD_SIZE_MASK)

#define SCM_GC_CELL_CARD(x)    ((SCM_CELLPTR) ((long) (x) & SCM_GC_CARD_ADDR_MASK))
#define SCM_GC_CELL_SPAN(x)    ((SCM_GC_CARD_DOUBLECELLP (SCM_GC_CELL_CARD (x))) ? 2 : 1)
#define SCM_GC_CELL_OFFSET(x)  (((long) (x) & SCM_GC_CARD_SIZE_MASK) >> SCM_CELL_SIZE_SHIFT)
#define SCM_GC_CELL_BVEC(x)    SCM_GC_CARD_BVEC (SCM_GC_CELL_CARD (x))
#define SCM_GC_CELL_GET_BIT(x) SCM_C_BVEC_GET (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))
#define SCM_GC_CELL_SET_BIT(x) SCM_C_BVEC_SET (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))
#define SCM_GC_CELL_CLR_BIT(x) SCM_C_BVEC_CLR (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))

#define SCM_GC_CARD_UP(x)      SCM_GC_CELL_CARD ((char *) (x) + SCM_GC_CARD_SIZE - 1)
#define SCM_GC_CARD_DOWN       SCM_GC_CELL_CARD

/* low level bit banging aids */

typedef unsigned long scm_t_c_bvec_limb;

#if (SIZEOF_LONG == 8)
#       define SCM_C_BVEC_LIMB_BITS    64
#       define SCM_C_BVEC_OFFSET_SHIFT 6
#       define SCM_C_BVEC_POS_MASK     63
#       define SCM_CELL_SIZE_SHIFT     4
#else
#       define SCM_C_BVEC_LIMB_BITS    32
#       define SCM_C_BVEC_OFFSET_SHIFT 5
#       define SCM_C_BVEC_POS_MASK     31
#       define SCM_CELL_SIZE_SHIFT     3
#endif

#define SCM_C_BVEC_OFFSET(pos) (pos >> SCM_C_BVEC_OFFSET_SHIFT)

#define SCM_C_BVEC_GET(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] & (1L << (pos & SCM_C_BVEC_POS_MASK)))
#define SCM_C_BVEC_SET(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] |= (1L << (pos & SCM_C_BVEC_POS_MASK)))
#define SCM_C_BVEC_CLR(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] &= ~(1L << (pos & SCM_C_BVEC_POS_MASK)))

#define SCM_C_BVEC_BITS2BYTES(bits) \
    (sizeof (scm_t_c_bvec_limb) * ((((bits) & SCM_C_BVEC_POS_MASK) ? 1L : 0L) + SCM_C_BVEC_OFFSET (bits)))

#define SCM_C_BVEC_SET_BYTES(bvec, bytes)   (memset (bvec, 0xff, bytes))
#define SCM_C_BVEC_SET_ALL_BITS(bvec, bits) SCM_C_BVEC_SET_BYTES (bvec, SCM_C_BVEC_BITS2BYTES (bits))

#define SCM_C_BVEC_CLR_BYTES(bvec, bytes)   (memset (bvec, 0, bytes))
#define SCM_C_BVEC_CLR_ALL_BITS(bvec, bits) SCM_C_BVEC_CLR_BYTES (bvec, SCM_C_BVEC_BITS2BYTES (bits))

/* testing and changing GC marks */

#define SCM_GCMARKP(x)   SCM_GC_CELL_GET_BIT (x)
#define SCM_SETGCMARK(x) SCM_GC_CELL_SET_BIT (x)
#define SCM_CLRGCMARK(x) SCM_GC_CELL_CLR_BIT (x)


/* Low level cell data accessing macros.  These macros should only be used
 * from within code related to garbage collection issues, since they will
 * never check the cells they are applied to - not even if guile is compiled
 * in debug mode.  In particular these macros will even work for free cells,
 * which should never be encountered by user code.  */

#define SCM_GC_CELL_WORD(x, n) \
  (((const scm_t_bits *) SCM2PTR (x)) [n])
#define SCM_GC_CELL_OBJECT(x, n) \
  (SCM_PACK (((const scm_t_bits *) SCM2PTR (x)) [n]))
#define SCM_GC_SET_CELL_WORD(x, n, v) \
  (((scm_t_bits *) SCM2PTR (x)) [n] = (scm_t_bits) (v))
#define SCM_GC_SET_CELL_OBJECT(x, n, v) \
  (((scm_t_bits *) SCM2PTR (x)) [n] = SCM_UNPACK (v))
#define SCM_GC_CELL_TYPE(x) SCM_GC_CELL_WORD (x, 0)


/* Except for the garbage collector, no part of guile should ever run over a
 * free cell.  Thus, if guile is compiled in debug mode the SCM_CELL_* and
 * SCM_SET_CELL_* macros below report an error if they are applied to a free
 * cell.  Some other plausibility checks are also performed.  However, if
 * guile is not compiled in debug mode, there won't be any time penalty at all
 * when using these macros.  */

#if (SCM_DEBUG_CELL_ACCESSES == 1)
#  define SCM_VALIDATE_CELL(cell, expr) (scm_assert_cell_valid (cell), (expr))
#else
#  define SCM_VALIDATE_CELL(cell, expr) (expr)
#endif

#define SCM_CELL_WORD(x, n) \
  SCM_VALIDATE_CELL ((x), SCM_GC_CELL_WORD ((x), (n)))
#define SCM_CELL_WORD_0(x) SCM_CELL_WORD (x, 0)
#define SCM_CELL_WORD_1(x) SCM_CELL_WORD (x, 1)
#define SCM_CELL_WORD_2(x) SCM_CELL_WORD (x, 2)
#define SCM_CELL_WORD_3(x) SCM_CELL_WORD (x, 3)

#define SCM_CELL_OBJECT(x, n) \
  SCM_VALIDATE_CELL ((x), SCM_GC_CELL_OBJECT ((x), (n)))
#define SCM_CELL_OBJECT_0(x) SCM_CELL_OBJECT (x, 0)
#define SCM_CELL_OBJECT_1(x) SCM_CELL_OBJECT (x, 1)
#define SCM_CELL_OBJECT_2(x) SCM_CELL_OBJECT (x, 2)
#define SCM_CELL_OBJECT_3(x) SCM_CELL_OBJECT (x, 3)

#define SCM_SET_CELL_WORD(x, n, v) \
  SCM_VALIDATE_CELL ((x), SCM_GC_SET_CELL_WORD ((x), (n), (v)))
#define SCM_SET_CELL_WORD_0(x, v) SCM_SET_CELL_WORD (x, 0, v)
#define SCM_SET_CELL_WORD_1(x, v) SCM_SET_CELL_WORD (x, 1, v)
#define SCM_SET_CELL_WORD_2(x, v) SCM_SET_CELL_WORD (x, 2, v)
#define SCM_SET_CELL_WORD_3(x, v) SCM_SET_CELL_WORD (x, 3, v)

#define SCM_SET_CELL_OBJECT(x, n, v) \
  SCM_VALIDATE_CELL ((x), SCM_GC_SET_CELL_OBJECT ((x), (n), (v)))
#define SCM_SET_CELL_OBJECT_0(x, v) SCM_SET_CELL_OBJECT (x, 0, v)
#define SCM_SET_CELL_OBJECT_1(x, v) SCM_SET_CELL_OBJECT (x, 1, v)
#define SCM_SET_CELL_OBJECT_2(x, v) SCM_SET_CELL_OBJECT (x, 2, v)
#define SCM_SET_CELL_OBJECT_3(x, v) SCM_SET_CELL_OBJECT (x, 3, v)

#define SCM_CELL_TYPE(x) SCM_CELL_WORD_0 (x)
#define SCM_SET_CELL_TYPE(x, t) SCM_SET_CELL_WORD_0 (x, t)


/* Freelists consist of linked cells where the type entry holds the value
 * scm_tc_free_cell and the second entry holds a pointer to the next cell of
 * the freelist.  Due to this structure, freelist cells are not cons cells
 * and thus may not be accessed using SCM_CAR and SCM_CDR.  */

#define SCM_FREE_CELL_P(x) \
  (!SCM_IMP (x) && (SCM_GC_CELL_TYPE (x) == scm_tc_free_cell))
#define SCM_FREE_CELL_CDR(x) \
  (SCM_GC_CELL_OBJECT ((x), 1))
#define SCM_SET_FREE_CELL_CDR(x, v) \
  (SCM_GC_SET_CELL_OBJECT ((x), 1, (v)))


#define SCM_CELL_WORD_LOC(x, n) ((scm_t_bits *) & SCM_CELL_WORD (x, n))
#define SCM_CARLOC(x) ((SCM *) SCM_CELL_WORD_LOC ((x), 0))
#define SCM_CDRLOC(x) ((SCM *) SCM_CELL_WORD_LOC ((x), 1))


/* SCM_PTR_LT and friends define how to compare two SCM_CELLPTRs (which may
 * point to cells in different heap segments).
 */
#define SCM_PTR_LT(x, y) ((x) < (y))
#define SCM_PTR_GT(x, y) (SCM_PTR_LT (y, x))
#define SCM_PTR_LE(x, y) (!SCM_PTR_GT (x, y))
#define SCM_PTR_GE(x, y) (!SCM_PTR_LT (x, y))


#define SCM_MARKEDP    SCM_GCMARKP
#define SCM_NMARKEDP(x) (!SCM_MARKEDP (x))

#if (SCM_DEBUG_CELL_ACCESSES == 1)
SCM_API unsigned int scm_debug_cell_accesses_p;
#endif

SCM_API struct scm_t_heap_seg_data *scm_heap_table;
SCM_API size_t scm_n_heap_segs;
SCM_API int scm_block_gc;
SCM_API int scm_gc_heap_lock;
SCM_API unsigned int scm_gc_running_p;
\f

SCM_API size_t scm_default_init_heap_size_1;
SCM_API int scm_default_min_yield_1;
SCM_API size_t scm_default_init_heap_size_2;
SCM_API int scm_default_min_yield_2;
SCM_API size_t scm_default_max_segment_size;

SCM_API size_t scm_max_segment_size;
SCM_API SCM_CELLPTR scm_heap_org;
SCM_API SCM scm_freelist;
SCM_API struct scm_t_freelist scm_master_freelist;
SCM_API SCM scm_freelist2;
SCM_API struct scm_t_freelist scm_master_freelist2;
SCM_API unsigned long scm_gc_cells_collected;
SCM_API unsigned long scm_gc_yield;
SCM_API unsigned long scm_gc_malloc_collected;
SCM_API unsigned long scm_gc_ports_collected;
SCM_API unsigned long scm_cells_allocated;
SCM_API unsigned long scm_mallocated;
SCM_API unsigned long scm_mtrigger;

SCM_API SCM scm_after_gc_hook;

SCM_API scm_t_c_hook scm_before_gc_c_hook;
SCM_API scm_t_c_hook scm_before_mark_c_hook;
SCM_API scm_t_c_hook scm_before_sweep_c_hook;
SCM_API scm_t_c_hook scm_after_sweep_c_hook;
SCM_API scm_t_c_hook scm_after_gc_c_hook;

#if defined (GUILE_DEBUG) || defined (GUILE_DEBUG_FREELIST)
SCM_API SCM scm_map_free_list (void);
SCM_API SCM scm_free_list_length (void);
#endif
#ifdef GUILE_DEBUG_FREELIST
SCM_API SCM scm_gc_set_debug_check_freelist_x (SCM flag);
#endif

\f

#if (SCM_DEBUG_CELL_ACCESSES == 1)
SCM_API void scm_assert_cell_valid (SCM);
SCM_API SCM scm_set_debug_cell_accesses_x (SCM flag);
#endif
SCM_API SCM scm_object_address (SCM obj);
SCM_API SCM scm_gc_stats (void);
SCM_API SCM scm_gc (void);
SCM_API void scm_gc_for_alloc (struct scm_t_freelist *freelist);
SCM_API SCM scm_gc_for_newcell (struct scm_t_freelist *master, SCM *freelist);
#if 0
SCM_API void scm_alloc_cluster (struct scm_t_freelist *master);
#endif
SCM_API void scm_igc (const char *what);
SCM_API void scm_gc_mark (SCM p);
SCM_API void scm_gc_mark_dependencies (SCM p);
SCM_API void scm_mark_locations (SCM_STACKITEM x[], unsigned long n);
SCM_API int scm_cellp (SCM value);
SCM_API void scm_gc_sweep (void);

SCM_API void *scm_malloc (size_t size);
SCM_API void *scm_realloc (void *mem, size_t size);
SCM_API char *scm_strdup (const char *str);
SCM_API char *scm_strndup (const char *str, size_t n);
SCM_API void scm_gc_register_collectable_memory (void *mem, size_t size,
						 const char *what);
SCM_API void scm_gc_unregister_collectable_memory (void *mem, size_t size,
						   const char *what);
SCM_API void *scm_gc_malloc (size_t size, const char *what);
SCM_API void *scm_gc_realloc (void *mem, size_t old_size, 
			      size_t new_size, const char *what);
SCM_API void scm_gc_free (void *mem, size_t size, const char *what);
SCM_API char *scm_gc_strdup (const char *str, const char *what);
SCM_API char *scm_gc_strndup (const char *str, size_t n, const char *what);

SCM_API void scm_remember_upto_here_1 (SCM obj);
SCM_API void scm_remember_upto_here_2 (SCM obj1, SCM obj2);
SCM_API void scm_remember_upto_here (SCM obj1, ...);
SCM_API SCM scm_return_first (SCM elt, ...);
SCM_API int scm_return_first_int (int x, ...);
SCM_API SCM scm_permanent_object (SCM obj);
SCM_API SCM scm_gc_protect_object (SCM obj);
SCM_API SCM scm_gc_unprotect_object (SCM obj);
SCM_API void scm_gc_register_root (SCM *p);
SCM_API void scm_gc_unregister_root (SCM *p);
SCM_API void scm_gc_register_roots (SCM *b, unsigned long n);
SCM_API void scm_gc_unregister_roots (SCM *b, unsigned long n);
SCM_API int scm_init_storage (void);
SCM_API void *scm_get_stack_base (void);
SCM_API void scm_init_gc (void);

#if SCM_ENABLE_DEPRECATED == 1

SCM_API SCM scm_deprecated_newcell (void);
SCM_API SCM scm_deprecated_newcell2 (void);

#define SCM_NEWCELL(_into) \
  do { _into = scm_deprecated_newcell (); } while (0)
#define SCM_NEWCELL2(_into) \
  do { _into = scm_deprecated_newcell2 (); } while (0)

SCM_API void * scm_must_malloc (size_t len, const char *what);
SCM_API void * scm_must_realloc (void *where,
				 size_t olen, size_t len,
				 const char *what);
SCM_API char *scm_must_strdup (const char *str);
SCM_API char *scm_must_strndup (const char *str, size_t n);
SCM_API void scm_done_malloc (long size);
SCM_API void scm_done_free (long size);
SCM_API void scm_must_free (void *obj);

#endif

#endif  /* SCM_GC_H */

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
Commit	Line	Data
0f2d19dd JB	1	/* classes: h_files */
0f2d19dd JB	2
61045190 DH	3	#ifndef SCM_GC_H
61045190 DH	4	#define SCM_GC_H
8c494e99	5
61045190	6	/* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
a00c95d9	7	*
0f2d19dd JB	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2, or (at your option)
	11	* any later version.
a00c95d9	12	*
0f2d19dd JB	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
a00c95d9	17	*
0f2d19dd JB	18	* You should have received a copy of the GNU General Public License
0f2d19dd JB	19	* along with this software; see the file COPYING. If not, write to
82892bed JB	20	* the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
82892bed JB	21	* Boston, MA 02111-1307 USA
0f2d19dd JB	22	*
	23	* As a special exception, the Free Software Foundation gives permission
	24	* for additional uses of the text contained in its release of GUILE.
	25	*
	26	* The exception is that, if you link the GUILE library with other files
	27	* to produce an executable, this does not by itself cause the
	28	* resulting executable to be covered by the GNU General Public License.
	29	* Your use of that executable is in no way restricted on account of
	30	* linking the GUILE library code into it.
	31	*
	32	* This exception does not however invalidate any other reasons why
	33	* the executable file might be covered by the GNU General Public License.
	34	*
	35	* This exception applies only to the code released by the
	36	* Free Software Foundation under the name GUILE. If you copy
	37	* code from other Free Software Foundation releases into a copy of
	38	* GUILE, as the General Public License permits, the exception does
	39	* not apply to the code that you add in this way. To avoid misleading
	40	* anyone as to the status of such modified files, you must delete
	41	* this exception notice from them.
	42	*
	43	* If you write modifications of your own for GUILE, it is your choice
	44	* whether to permit this exception to apply to your modifications.
82892bed	45	* If you do not wish that, delete this exception notice. */
d3a6bc94	46
0f2d19dd JB	47	\f
0f2d19dd JB	48
b4309c3c	49	#include "libguile/__scm.h"
2549a709	50
9b3e180c MD	51	#include "libguile/hooks.h"
9b3e180c MD	52
0f2d19dd JB	53	\f
0f2d19dd JB	54
228a24ef	55	typedef struct scm_t_cell
2549a709	56	{
92c2555f MV	57	scm_t_bits word_0;
92c2555f MV	58	scm_t_bits word_1;
228a24ef	59	} scm_t_cell;
2549a709 DH	60
	61
	62	/* SCM_CELLPTR is a pointer to a cons cell which may be compared or
	63	* differenced.
	64	*/
228a24ef	65	typedef scm_t_cell * SCM_CELLPTR;
2549a709 DH	66
	67
	68	/* Cray machines have pointers that are incremented once for each word,
	69	* rather than each byte, the 3 most significant bits encode the byte
	70	* within the word. The following macros deal with this by storing the
	71	* native Cray pointers like the ones that looks like scm expects. This
228a24ef	72	* is done for any pointers that might appear in the car of a scm_t_cell,
e618c9a3	73	* pointers to scm_vector elts, functions, &c are not munged.
2549a709 DH	74	*/
2549a709 DH	75	#ifdef _UNICOS
076d6063	76	# define SCM2PTR(x) ((SCM_CELLPTR) (SCM_UNPACK (x) >> 3))
92c2555f	77	# define PTR2SCM(x) (SCM_PACK (((scm_t_bits) (x)) << 3))
2549a709	78	#else
076d6063	79	# define SCM2PTR(x) ((SCM_CELLPTR) (SCM_UNPACK (x)))
92c2555f	80	# define PTR2SCM(x) (SCM_PACK ((scm_t_bits) (x)))
2549a709 DH	81	#endif /* def _UNICOS */
2549a709 DH	82
34d19ef6 HWN	83	#ifdef GENGC
	84	/*
	85	TODO
	86	*/
	87	#else /* ! genGC */
	88
e618c9a3	89	#define SCM_GC_CARD_N_HEADER_CELLS 1
f91f77e6	90	#define SCM_GC_CARD_N_CELLS 256
e618c9a3	91
34d19ef6 HWN	92	#define SCM_GC_CARD_GENERATION(card)
	93	#define SCM_GC_FLAG_OBJECT_WRITE(x)
	94
	95	#define SCM_GC_CARD_BVEC(card) ((scm_t_c_bvec_limb *) ((card)->word_0))
	96	#define SCM_GC_SET_CARD_BVEC(card, bvec) \
	97	((card)->word_0 = (scm_t_bits) (bvec))
	98	#endif
	99
	100
228a24ef	101	#define SCM_GC_CARD_SIZE (SCM_GC_CARD_N_CELLS * sizeof (scm_t_cell))
e618c9a3 ML	102	#define SCM_GC_CARD_N_DATA_CELLS (SCM_GC_CARD_N_CELLS - SCM_GC_CARD_N_HEADER_CELLS)
	103
	104	#define SCM_GC_CARD_BVEC_SIZE_IN_LIMBS \
	105	((SCM_GC_CARD_N_CELLS + SCM_C_BVEC_LIMB_BITS - 1) / SCM_C_BVEC_LIMB_BITS)
	106
	107	#define SCM_GC_IN_CARD_HEADERP(x) \
228a24ef	108	SCM_PTR_LT ((scm_t_cell *) (x), SCM_GC_CELL_CARD (x) + SCM_GC_CARD_N_HEADER_CELLS)
e618c9a3	109
c014a02e	110	#define SCM_GC_GET_CARD_FLAGS(card) ((long) ((card)->word_1))
322ec19d	111	#define SCM_GC_SET_CARD_FLAGS(card, flags) \
92c2555f	112	((card)->word_1 = (scm_t_bits) (flags))
322ec19d	113	#define SCM_GC_CLR_CARD_FLAGS(card) (SCM_GC_SET_CARD_FLAGS (card, 0L))
e618c9a3 ML	114
e618c9a3 ML	115	#define SCM_GC_GET_CARD_FLAG(card, shift) (SCM_GC_GET_CARD_FLAGS (card) & (1L << (shift)))
322ec19d ML	116	#define SCM_GC_SET_CARD_FLAG(card, shift) \
	117	(SCM_GC_SET_CARD_FLAGS (card, SCM_GC_GET_CARD_FLAGS(card) \| (1L << (shift))))
	118	#define SCM_GC_CLR_CARD_FLAG(card, shift) \
	119	(SCM_GC_SET_CARD_FLAGS (card, SCM_GC_GET_CARD_FLAGS(card) & ~(1L << (shift))))
e618c9a3 ML	120
	121	#define SCM_GC_CARDF_DOUBLECELL 0
	122
	123	#define SCM_GC_CARD_DOUBLECELLP(card) SCM_GC_GET_CARD_FLAG (card, SCM_GC_CARDF_DOUBLECELL)
	124	#define SCM_GC_SET_CARD_DOUBLECELL(card) SCM_GC_SET_CARD_FLAG (card, SCM_GC_CARDF_DOUBLECELL)
	125
	126	/* card addressing. for efficiency, cards are always aligned to
	127	SCM_GC_CARD_SIZE. */
	128
	129	#define SCM_GC_CARD_SIZE_MASK (SCM_GC_CARD_SIZE - 1)
	130	#define SCM_GC_CARD_ADDR_MASK (~SCM_GC_CARD_SIZE_MASK)
	131
c014a02e	132	#define SCM_GC_CELL_CARD(x) ((SCM_CELLPTR) ((long) (x) & SCM_GC_CARD_ADDR_MASK))
e618c9a3	133	#define SCM_GC_CELL_SPAN(x) ((SCM_GC_CARD_DOUBLECELLP (SCM_GC_CELL_CARD (x))) ? 2 : 1)
c014a02e	134	#define SCM_GC_CELL_OFFSET(x) (((long) (x) & SCM_GC_CARD_SIZE_MASK) >> SCM_CELL_SIZE_SHIFT)
e618c9a3 ML	135	#define SCM_GC_CELL_BVEC(x) SCM_GC_CARD_BVEC (SCM_GC_CELL_CARD (x))
	136	#define SCM_GC_CELL_GET_BIT(x) SCM_C_BVEC_GET (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))
	137	#define SCM_GC_CELL_SET_BIT(x) SCM_C_BVEC_SET (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))
	138	#define SCM_GC_CELL_CLR_BIT(x) SCM_C_BVEC_CLR (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))
	139
	140	#define SCM_GC_CARD_UP(x) SCM_GC_CELL_CARD ((char *) (x) + SCM_GC_CARD_SIZE - 1)
	141	#define SCM_GC_CARD_DOWN SCM_GC_CELL_CARD
	142
	143	/* low level bit banging aids */
	144
92c2555f	145	typedef unsigned long scm_t_c_bvec_limb;
e618c9a3 ML	146
	147	#if (SIZEOF_LONG == 8)
	148	# define SCM_C_BVEC_LIMB_BITS 64
	149	# define SCM_C_BVEC_OFFSET_SHIFT 6
	150	# define SCM_C_BVEC_POS_MASK 63
	151	# define SCM_CELL_SIZE_SHIFT 4
	152	#else
	153	# define SCM_C_BVEC_LIMB_BITS 32
	154	# define SCM_C_BVEC_OFFSET_SHIFT 5
	155	# define SCM_C_BVEC_POS_MASK 31
	156	# define SCM_CELL_SIZE_SHIFT 3
	157	#endif
	158
	159	#define SCM_C_BVEC_OFFSET(pos) (pos >> SCM_C_BVEC_OFFSET_SHIFT)
	160
	161	#define SCM_C_BVEC_GET(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] & (1L << (pos & SCM_C_BVEC_POS_MASK)))
	162	#define SCM_C_BVEC_SET(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] \|= (1L << (pos & SCM_C_BVEC_POS_MASK)))
	163	#define SCM_C_BVEC_CLR(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] &= ~(1L << (pos & SCM_C_BVEC_POS_MASK)))
	164
	165	#define SCM_C_BVEC_BITS2BYTES(bits) \
92c2555f	166	(sizeof (scm_t_c_bvec_limb) * ((((bits) & SCM_C_BVEC_POS_MASK) ? 1L : 0L) + SCM_C_BVEC_OFFSET (bits)))
e618c9a3 ML	167
	168	#define SCM_C_BVEC_SET_BYTES(bvec, bytes) (memset (bvec, 0xff, bytes))
	169	#define SCM_C_BVEC_SET_ALL_BITS(bvec, bits) SCM_C_BVEC_SET_BYTES (bvec, SCM_C_BVEC_BITS2BYTES (bits))
	170
	171	#define SCM_C_BVEC_CLR_BYTES(bvec, bytes) (memset (bvec, 0, bytes))
	172	#define SCM_C_BVEC_CLR_ALL_BITS(bvec, bits) SCM_C_BVEC_CLR_BYTES (bvec, SCM_C_BVEC_BITS2BYTES (bits))
	173
	174	/* testing and changing GC marks */
	175
	176	#define SCM_GCMARKP(x) SCM_GC_CELL_GET_BIT (x)
	177	#define SCM_SETGCMARK(x) SCM_GC_CELL_SET_BIT (x)
	178	#define SCM_CLRGCMARK(x) SCM_GC_CELL_CLR_BIT (x)
	179
1fc8902f DH	180
	181	/* Low level cell data accessing macros. These macros should only be used
	182	* from within code related to garbage collection issues, since they will
	183	* never check the cells they are applied to - not even if guile is compiled
	184	* in debug mode. In particular these macros will even work for free cells,
	185	* which should never be encountered by user code. */
	186
	187	#define SCM_GC_CELL_WORD(x, n) \
	188	(((const scm_t_bits *) SCM2PTR (x)) [n])
	189	#define SCM_GC_CELL_OBJECT(x, n) \
	190	(SCM_PACK (((const scm_t_bits *) SCM2PTR (x)) [n]))
	191	#define SCM_GC_SET_CELL_WORD(x, n, v) \
	192	(((scm_t_bits *) SCM2PTR (x)) [n] = (scm_t_bits) (v))
	193	#define SCM_GC_SET_CELL_OBJECT(x, n, v) \
	194	(((scm_t_bits *) SCM2PTR (x)) [n] = SCM_UNPACK (v))
	195	#define SCM_GC_CELL_TYPE(x) SCM_GC_CELL_WORD (x, 0)
	196
	197
	198	/* Except for the garbage collector, no part of guile should ever run over a
	199	* free cell. Thus, if guile is compiled in debug mode the SCM_CELL_* and
	200	* SCM_SET_CELL_* macros below report an error if they are applied to a free
	201	* cell. Some other plausibility checks are also performed. However, if
	202	* guile is not compiled in debug mode, there won't be any time penalty at all
	203	* when using these macros. */
2549a709	204
406c7d90 DH	205	#if (SCM_DEBUG_CELL_ACCESSES == 1)
406c7d90 DH	206	# define SCM_VALIDATE_CELL(cell, expr) (scm_assert_cell_valid (cell), (expr))
708cb87c	207	#else
61045190	208	# define SCM_VALIDATE_CELL(cell, expr) (expr)
708cb87c	209	#endif
46d53380	210
f706a58b	211	#define SCM_CELL_WORD(x, n) \
1fc8902f	212	SCM_VALIDATE_CELL ((x), SCM_GC_CELL_WORD ((x), (n)))
2549a709 DH	213	#define SCM_CELL_WORD_0(x) SCM_CELL_WORD (x, 0)
	214	#define SCM_CELL_WORD_1(x) SCM_CELL_WORD (x, 1)
	215	#define SCM_CELL_WORD_2(x) SCM_CELL_WORD (x, 2)
	216	#define SCM_CELL_WORD_3(x) SCM_CELL_WORD (x, 3)
	217
f706a58b	218	#define SCM_CELL_OBJECT(x, n) \
1fc8902f	219	SCM_VALIDATE_CELL ((x), SCM_GC_CELL_OBJECT ((x), (n)))
2549a709 DH	220	#define SCM_CELL_OBJECT_0(x) SCM_CELL_OBJECT (x, 0)
	221	#define SCM_CELL_OBJECT_1(x) SCM_CELL_OBJECT (x, 1)
	222	#define SCM_CELL_OBJECT_2(x) SCM_CELL_OBJECT (x, 2)
	223	#define SCM_CELL_OBJECT_3(x) SCM_CELL_OBJECT (x, 3)
	224
f706a58b	225	#define SCM_SET_CELL_WORD(x, n, v) \
1fc8902f	226	SCM_VALIDATE_CELL ((x), SCM_GC_SET_CELL_WORD ((x), (n), (v)))
2549a709 DH	227	#define SCM_SET_CELL_WORD_0(x, v) SCM_SET_CELL_WORD (x, 0, v)
	228	#define SCM_SET_CELL_WORD_1(x, v) SCM_SET_CELL_WORD (x, 1, v)
	229	#define SCM_SET_CELL_WORD_2(x, v) SCM_SET_CELL_WORD (x, 2, v)
	230	#define SCM_SET_CELL_WORD_3(x, v) SCM_SET_CELL_WORD (x, 3, v)
	231
f706a58b	232	#define SCM_SET_CELL_OBJECT(x, n, v) \
1fc8902f	233	SCM_VALIDATE_CELL ((x), SCM_GC_SET_CELL_OBJECT ((x), (n), (v)))
2549a709 DH	234	#define SCM_SET_CELL_OBJECT_0(x, v) SCM_SET_CELL_OBJECT (x, 0, v)
	235	#define SCM_SET_CELL_OBJECT_1(x, v) SCM_SET_CELL_OBJECT (x, 1, v)
	236	#define SCM_SET_CELL_OBJECT_2(x, v) SCM_SET_CELL_OBJECT (x, 2, v)
	237	#define SCM_SET_CELL_OBJECT_3(x, v) SCM_SET_CELL_OBJECT (x, 3, v)
	238
	239	#define SCM_CELL_TYPE(x) SCM_CELL_WORD_0 (x)
	240	#define SCM_SET_CELL_TYPE(x, t) SCM_SET_CELL_WORD_0 (x, t)
	241
61045190	242
1fc8902f DH	243	/* Freelists consist of linked cells where the type entry holds the value
	244	* scm_tc_free_cell and the second entry holds a pointer to the next cell of
	245	* the freelist. Due to this structure, freelist cells are not cons cells
	246	* and thus may not be accessed using SCM_CAR and SCM_CDR. */
61045190	247
1fc8902f DH	248	#define SCM_FREE_CELL_P(x) \
	249	(!SCM_IMP (x) && (SCM_GC_CELL_TYPE (x) == scm_tc_free_cell))
	250	#define SCM_FREE_CELL_CDR(x) \
	251	(SCM_GC_CELL_OBJECT ((x), 1))
	252	#define SCM_SET_FREE_CELL_CDR(x, v) \
	253	(SCM_GC_SET_CELL_OBJECT ((x), 1, (v)))
61045190 DH	254
61045190 DH	255
92c2555f	256	#define SCM_CELL_WORD_LOC(x, n) ((scm_t_bits *) & SCM_CELL_WORD (x, n))
f706a58b DH	257	#define SCM_CARLOC(x) ((SCM *) SCM_CELL_WORD_LOC ((x), 0))
f706a58b DH	258	#define SCM_CDRLOC(x) ((SCM *) SCM_CELL_WORD_LOC ((x), 1))
2549a709 DH	259
2549a709 DH	260
6ba93e5e DH	261	/* SCM_PTR_LT and friends define how to compare two SCM_CELLPTRs (which may
6ba93e5e DH	262	* point to cells in different heap segments).
2549a709	263	*/
6ba93e5e DH	264	#define SCM_PTR_LT(x, y) ((x) < (y))
6ba93e5e DH	265	#define SCM_PTR_GT(x, y) (SCM_PTR_LT (y, x))
2549a709 DH	266	#define SCM_PTR_LE(x, y) (!SCM_PTR_GT (x, y))
	267	#define SCM_PTR_GE(x, y) (!SCM_PTR_LT (x, y))
	268
	269
e618c9a3	270	#define SCM_MARKEDP SCM_GCMARKP
2d67e390	271	#define SCM_NMARKEDP(x) (!SCM_MARKEDP (x))
79e3f9e2	272
61045190	273	#if (SCM_DEBUG_CELL_ACCESSES == 1)
33b001fd	274	SCM_API unsigned int scm_debug_cell_accesses_p;
61045190 DH	275	#endif
61045190 DH	276
33b001fd MV	277	SCM_API struct scm_t_heap_seg_data *scm_heap_table;
	278	SCM_API size_t scm_n_heap_segs;
	279	SCM_API int scm_block_gc;
	280	SCM_API int scm_gc_heap_lock;
	281	SCM_API unsigned int scm_gc_running_p;
0f2d19dd JB	282	\f
0f2d19dd JB	283
33b001fd MV	284	SCM_API size_t scm_default_init_heap_size_1;
	285	SCM_API int scm_default_min_yield_1;
	286	SCM_API size_t scm_default_init_heap_size_2;
	287	SCM_API int scm_default_min_yield_2;
	288	SCM_API size_t scm_default_max_segment_size;
	289
	290	SCM_API size_t scm_max_segment_size;
	291	SCM_API SCM_CELLPTR scm_heap_org;
	292	SCM_API SCM scm_freelist;
	293	SCM_API struct scm_t_freelist scm_master_freelist;
	294	SCM_API SCM scm_freelist2;
	295	SCM_API struct scm_t_freelist scm_master_freelist2;
	296	SCM_API unsigned long scm_gc_cells_collected;
	297	SCM_API unsigned long scm_gc_yield;
	298	SCM_API unsigned long scm_gc_malloc_collected;
	299	SCM_API unsigned long scm_gc_ports_collected;
	300	SCM_API unsigned long scm_cells_allocated;
	301	SCM_API unsigned long scm_mallocated;
	302	SCM_API unsigned long scm_mtrigger;
	303
	304	SCM_API SCM scm_after_gc_hook;
	305
	306	SCM_API scm_t_c_hook scm_before_gc_c_hook;
	307	SCM_API scm_t_c_hook scm_before_mark_c_hook;
	308	SCM_API scm_t_c_hook scm_before_sweep_c_hook;
	309	SCM_API scm_t_c_hook scm_after_sweep_c_hook;
	310	SCM_API scm_t_c_hook scm_after_gc_c_hook;
9b3e180c	311
bb2c57fa	312	#if defined (GUILE_DEBUG) \|\| defined (GUILE_DEBUG_FREELIST)
33b001fd MV	313	SCM_API SCM scm_map_free_list (void);
33b001fd MV	314	SCM_API SCM scm_free_list_length (void);
bb2c57fa MD	315	#endif
bb2c57fa MD	316	#ifdef GUILE_DEBUG_FREELIST
33b001fd	317	SCM_API SCM scm_gc_set_debug_check_freelist_x (SCM flag);
88256b2e JB	318	#endif
88256b2e JB	319
0f2d19dd	320	\f
0f2d19dd	321
61045190	322	#if (SCM_DEBUG_CELL_ACCESSES == 1)
33b001fd MV	323	SCM_API void scm_assert_cell_valid (SCM);
33b001fd MV	324	SCM_API SCM scm_set_debug_cell_accesses_x (SCM flag);
61045190	325	#endif
33b001fd	326	SCM_API SCM scm_object_address (SCM obj);
33b001fd MV	327	SCM_API SCM scm_gc_stats (void);
	328	SCM_API SCM scm_gc (void);
	329	SCM_API void scm_gc_for_alloc (struct scm_t_freelist *freelist);
	330	SCM_API SCM scm_gc_for_newcell (struct scm_t_freelist master, SCM freelist);
4c48ba06	331	#if 0
33b001fd	332	SCM_API void scm_alloc_cluster (struct scm_t_freelist *master);
4c48ba06	333	#endif
33b001fd MV	334	SCM_API void scm_igc (const char *what);
	335	SCM_API void scm_gc_mark (SCM p);
	336	SCM_API void scm_gc_mark_dependencies (SCM p);
	337	SCM_API void scm_mark_locations (SCM_STACKITEM x[], unsigned long n);
	338	SCM_API int scm_cellp (SCM value);
	339	SCM_API void scm_gc_sweep (void);
4c9419ac MV	340
	341	SCM_API void *scm_malloc (size_t size);
	342	SCM_API void scm_realloc (void mem, size_t size);
	343	SCM_API char scm_strdup (const char str);
	344	SCM_API char scm_strndup (const char str, size_t n);
	345	SCM_API void scm_gc_register_collectable_memory (void *mem, size_t size,
	346	const char *what);
	347	SCM_API void scm_gc_unregister_collectable_memory (void *mem, size_t size,
	348	const char *what);
	349	SCM_API void scm_gc_malloc (size_t size, const char what);
	350	SCM_API void scm_gc_realloc (void mem, size_t old_size,
	351	size_t new_size, const char *what);
	352	SCM_API void scm_gc_free (void mem, size_t size, const char what);
	353	SCM_API char scm_gc_strdup (const char str, const char *what);
	354	SCM_API char scm_gc_strndup (const char str, size_t n, const char *what);
	355
33b001fd MV	356	SCM_API void scm_remember_upto_here_1 (SCM obj);
	357	SCM_API void scm_remember_upto_here_2 (SCM obj1, SCM obj2);
	358	SCM_API void scm_remember_upto_here (SCM obj1, ...);
	359	SCM_API SCM scm_return_first (SCM elt, ...);
	360	SCM_API int scm_return_first_int (int x, ...);
	361	SCM_API SCM scm_permanent_object (SCM obj);
	362	SCM_API SCM scm_gc_protect_object (SCM obj);
	363	SCM_API SCM scm_gc_unprotect_object (SCM obj);
	364	SCM_API void scm_gc_register_root (SCM *p);
	365	SCM_API void scm_gc_unregister_root (SCM *p);
	366	SCM_API void scm_gc_register_roots (SCM *b, unsigned long n);
	367	SCM_API void scm_gc_unregister_roots (SCM *b, unsigned long n);
	368	SCM_API int scm_init_storage (void);
	369	SCM_API void *scm_get_stack_base (void);
	370	SCM_API void scm_init_gc (void);
d1ca2c64	371
d678e25c MV	372	#if SCM_ENABLE_DEPRECATED == 1
	373
	374	SCM_API SCM scm_deprecated_newcell (void);
	375	SCM_API SCM scm_deprecated_newcell2 (void);
	376
	377	#define SCM_NEWCELL(_into) \
	378	do { _into = scm_deprecated_newcell (); } while (0)
	379	#define SCM_NEWCELL2(_into) \
	380	do { _into = scm_deprecated_newcell2 (); } while (0)
	381
539b08a4 MV	382	SCM_API void * scm_must_malloc (size_t len, const char *what);
	383	SCM_API void * scm_must_realloc (void *where,
	384	size_t olen, size_t len,
	385	const char *what);
	386	SCM_API char scm_must_strdup (const char str);
	387	SCM_API char scm_must_strndup (const char str, size_t n);
	388	SCM_API void scm_done_malloc (long size);
	389	SCM_API void scm_done_free (long size);
	390	SCM_API void scm_must_free (void *obj);
	391
d678e25c MV	392	#endif
d678e25c MV	393
61045190	394	#endif /* SCM_GC_H */
89e00824 ML	395
	396	/*
	397	Local Variables:
	398	c-file-style: "gnu"
	399	End:
	400	*/