[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 */

#define SCM_GC_CARD_N_HEADER_CELLS 1
#define SCM_GC_CARD_N_CELLS        256

#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))


#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
e618c9a3	83	#define SCM_GC_CARD_N_HEADER_CELLS 1
f91f77e6	84	#define SCM_GC_CARD_N_CELLS 256
e618c9a3	85
34d19ef6 HWN	86	#define SCM_GC_CARD_BVEC(card) ((scm_t_c_bvec_limb *) ((card)->word_0))
	87	#define SCM_GC_SET_CARD_BVEC(card, bvec) \
	88	((card)->word_0 = (scm_t_bits) (bvec))
34d19ef6 HWN	89
34d19ef6 HWN	90
228a24ef	91	#define SCM_GC_CARD_SIZE (SCM_GC_CARD_N_CELLS * sizeof (scm_t_cell))
e618c9a3 ML	92	#define SCM_GC_CARD_N_DATA_CELLS (SCM_GC_CARD_N_CELLS - SCM_GC_CARD_N_HEADER_CELLS)
	93
	94	#define SCM_GC_CARD_BVEC_SIZE_IN_LIMBS \
	95	((SCM_GC_CARD_N_CELLS + SCM_C_BVEC_LIMB_BITS - 1) / SCM_C_BVEC_LIMB_BITS)
	96
	97	#define SCM_GC_IN_CARD_HEADERP(x) \
228a24ef	98	SCM_PTR_LT ((scm_t_cell *) (x), SCM_GC_CELL_CARD (x) + SCM_GC_CARD_N_HEADER_CELLS)
e618c9a3	99
c014a02e	100	#define SCM_GC_GET_CARD_FLAGS(card) ((long) ((card)->word_1))
322ec19d	101	#define SCM_GC_SET_CARD_FLAGS(card, flags) \
92c2555f	102	((card)->word_1 = (scm_t_bits) (flags))
322ec19d	103	#define SCM_GC_CLR_CARD_FLAGS(card) (SCM_GC_SET_CARD_FLAGS (card, 0L))
e618c9a3 ML	104
e618c9a3 ML	105	#define SCM_GC_GET_CARD_FLAG(card, shift) (SCM_GC_GET_CARD_FLAGS (card) & (1L << (shift)))
322ec19d ML	106	#define SCM_GC_SET_CARD_FLAG(card, shift) \
	107	(SCM_GC_SET_CARD_FLAGS (card, SCM_GC_GET_CARD_FLAGS(card) \| (1L << (shift))))
	108	#define SCM_GC_CLR_CARD_FLAG(card, shift) \
	109	(SCM_GC_SET_CARD_FLAGS (card, SCM_GC_GET_CARD_FLAGS(card) & ~(1L << (shift))))
e618c9a3 ML	110
	111	#define SCM_GC_CARDF_DOUBLECELL 0
	112
	113	#define SCM_GC_CARD_DOUBLECELLP(card) SCM_GC_GET_CARD_FLAG (card, SCM_GC_CARDF_DOUBLECELL)
	114	#define SCM_GC_SET_CARD_DOUBLECELL(card) SCM_GC_SET_CARD_FLAG (card, SCM_GC_CARDF_DOUBLECELL)
	115
	116	/* card addressing. for efficiency, cards are always aligned to
	117	SCM_GC_CARD_SIZE. */
	118
	119	#define SCM_GC_CARD_SIZE_MASK (SCM_GC_CARD_SIZE - 1)
	120	#define SCM_GC_CARD_ADDR_MASK (~SCM_GC_CARD_SIZE_MASK)
	121
c014a02e	122	#define SCM_GC_CELL_CARD(x) ((SCM_CELLPTR) ((long) (x) & SCM_GC_CARD_ADDR_MASK))
e618c9a3	123	#define SCM_GC_CELL_SPAN(x) ((SCM_GC_CARD_DOUBLECELLP (SCM_GC_CELL_CARD (x))) ? 2 : 1)
c014a02e	124	#define SCM_GC_CELL_OFFSET(x) (((long) (x) & SCM_GC_CARD_SIZE_MASK) >> SCM_CELL_SIZE_SHIFT)
e618c9a3 ML	125	#define SCM_GC_CELL_BVEC(x) SCM_GC_CARD_BVEC (SCM_GC_CELL_CARD (x))
	126	#define SCM_GC_CELL_GET_BIT(x) SCM_C_BVEC_GET (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))
	127	#define SCM_GC_CELL_SET_BIT(x) SCM_C_BVEC_SET (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))
	128	#define SCM_GC_CELL_CLR_BIT(x) SCM_C_BVEC_CLR (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))
	129
	130	#define SCM_GC_CARD_UP(x) SCM_GC_CELL_CARD ((char *) (x) + SCM_GC_CARD_SIZE - 1)
	131	#define SCM_GC_CARD_DOWN SCM_GC_CELL_CARD
	132
	133	/* low level bit banging aids */
	134
92c2555f	135	typedef unsigned long scm_t_c_bvec_limb;
e618c9a3 ML	136
	137	#if (SIZEOF_LONG == 8)
	138	# define SCM_C_BVEC_LIMB_BITS 64
	139	# define SCM_C_BVEC_OFFSET_SHIFT 6
	140	# define SCM_C_BVEC_POS_MASK 63
	141	# define SCM_CELL_SIZE_SHIFT 4
	142	#else
	143	# define SCM_C_BVEC_LIMB_BITS 32
	144	# define SCM_C_BVEC_OFFSET_SHIFT 5
	145	# define SCM_C_BVEC_POS_MASK 31
	146	# define SCM_CELL_SIZE_SHIFT 3
	147	#endif
	148
	149	#define SCM_C_BVEC_OFFSET(pos) (pos >> SCM_C_BVEC_OFFSET_SHIFT)
	150
	151	#define SCM_C_BVEC_GET(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] & (1L << (pos & SCM_C_BVEC_POS_MASK)))
	152	#define SCM_C_BVEC_SET(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] \|= (1L << (pos & SCM_C_BVEC_POS_MASK)))
	153	#define SCM_C_BVEC_CLR(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] &= ~(1L << (pos & SCM_C_BVEC_POS_MASK)))
	154
	155	#define SCM_C_BVEC_BITS2BYTES(bits) \
92c2555f	156	(sizeof (scm_t_c_bvec_limb) * ((((bits) & SCM_C_BVEC_POS_MASK) ? 1L : 0L) + SCM_C_BVEC_OFFSET (bits)))
e618c9a3 ML	157
	158	#define SCM_C_BVEC_SET_BYTES(bvec, bytes) (memset (bvec, 0xff, bytes))
	159	#define SCM_C_BVEC_SET_ALL_BITS(bvec, bits) SCM_C_BVEC_SET_BYTES (bvec, SCM_C_BVEC_BITS2BYTES (bits))
	160
	161	#define SCM_C_BVEC_CLR_BYTES(bvec, bytes) (memset (bvec, 0, bytes))
	162	#define SCM_C_BVEC_CLR_ALL_BITS(bvec, bits) SCM_C_BVEC_CLR_BYTES (bvec, SCM_C_BVEC_BITS2BYTES (bits))
	163
	164	/* testing and changing GC marks */
	165
	166	#define SCM_GCMARKP(x) SCM_GC_CELL_GET_BIT (x)
	167	#define SCM_SETGCMARK(x) SCM_GC_CELL_SET_BIT (x)
	168	#define SCM_CLRGCMARK(x) SCM_GC_CELL_CLR_BIT (x)
	169
1fc8902f DH	170
	171	/* Low level cell data accessing macros. These macros should only be used
	172	* from within code related to garbage collection issues, since they will
	173	* never check the cells they are applied to - not even if guile is compiled
	174	* in debug mode. In particular these macros will even work for free cells,
	175	* which should never be encountered by user code. */
	176
	177	#define SCM_GC_CELL_WORD(x, n) \
	178	(((const scm_t_bits *) SCM2PTR (x)) [n])
	179	#define SCM_GC_CELL_OBJECT(x, n) \
	180	(SCM_PACK (((const scm_t_bits *) SCM2PTR (x)) [n]))
	181	#define SCM_GC_SET_CELL_WORD(x, n, v) \
	182	(((scm_t_bits *) SCM2PTR (x)) [n] = (scm_t_bits) (v))
	183	#define SCM_GC_SET_CELL_OBJECT(x, n, v) \
	184	(((scm_t_bits *) SCM2PTR (x)) [n] = SCM_UNPACK (v))
	185	#define SCM_GC_CELL_TYPE(x) SCM_GC_CELL_WORD (x, 0)
	186
	187
	188	/* Except for the garbage collector, no part of guile should ever run over a
	189	* free cell. Thus, if guile is compiled in debug mode the SCM_CELL_* and
	190	* SCM_SET_CELL_* macros below report an error if they are applied to a free
	191	* cell. Some other plausibility checks are also performed. However, if
	192	* guile is not compiled in debug mode, there won't be any time penalty at all
	193	* when using these macros. */
2549a709	194
406c7d90 DH	195	#if (SCM_DEBUG_CELL_ACCESSES == 1)
406c7d90 DH	196	# define SCM_VALIDATE_CELL(cell, expr) (scm_assert_cell_valid (cell), (expr))
708cb87c	197	#else
61045190	198	# define SCM_VALIDATE_CELL(cell, expr) (expr)
708cb87c	199	#endif
46d53380	200
f706a58b	201	#define SCM_CELL_WORD(x, n) \
1fc8902f	202	SCM_VALIDATE_CELL ((x), SCM_GC_CELL_WORD ((x), (n)))
2549a709 DH	203	#define SCM_CELL_WORD_0(x) SCM_CELL_WORD (x, 0)
	204	#define SCM_CELL_WORD_1(x) SCM_CELL_WORD (x, 1)
	205	#define SCM_CELL_WORD_2(x) SCM_CELL_WORD (x, 2)
	206	#define SCM_CELL_WORD_3(x) SCM_CELL_WORD (x, 3)
	207
f706a58b	208	#define SCM_CELL_OBJECT(x, n) \
1fc8902f	209	SCM_VALIDATE_CELL ((x), SCM_GC_CELL_OBJECT ((x), (n)))
2549a709 DH	210	#define SCM_CELL_OBJECT_0(x) SCM_CELL_OBJECT (x, 0)
	211	#define SCM_CELL_OBJECT_1(x) SCM_CELL_OBJECT (x, 1)
	212	#define SCM_CELL_OBJECT_2(x) SCM_CELL_OBJECT (x, 2)
	213	#define SCM_CELL_OBJECT_3(x) SCM_CELL_OBJECT (x, 3)
	214
f706a58b	215	#define SCM_SET_CELL_WORD(x, n, v) \
1fc8902f	216	SCM_VALIDATE_CELL ((x), SCM_GC_SET_CELL_WORD ((x), (n), (v)))
2549a709 DH	217	#define SCM_SET_CELL_WORD_0(x, v) SCM_SET_CELL_WORD (x, 0, v)
	218	#define SCM_SET_CELL_WORD_1(x, v) SCM_SET_CELL_WORD (x, 1, v)
	219	#define SCM_SET_CELL_WORD_2(x, v) SCM_SET_CELL_WORD (x, 2, v)
	220	#define SCM_SET_CELL_WORD_3(x, v) SCM_SET_CELL_WORD (x, 3, v)
	221
f706a58b	222	#define SCM_SET_CELL_OBJECT(x, n, v) \
1fc8902f	223	SCM_VALIDATE_CELL ((x), SCM_GC_SET_CELL_OBJECT ((x), (n), (v)))
2549a709 DH	224	#define SCM_SET_CELL_OBJECT_0(x, v) SCM_SET_CELL_OBJECT (x, 0, v)
	225	#define SCM_SET_CELL_OBJECT_1(x, v) SCM_SET_CELL_OBJECT (x, 1, v)
	226	#define SCM_SET_CELL_OBJECT_2(x, v) SCM_SET_CELL_OBJECT (x, 2, v)
	227	#define SCM_SET_CELL_OBJECT_3(x, v) SCM_SET_CELL_OBJECT (x, 3, v)
	228
	229	#define SCM_CELL_TYPE(x) SCM_CELL_WORD_0 (x)
	230	#define SCM_SET_CELL_TYPE(x, t) SCM_SET_CELL_WORD_0 (x, t)
	231
61045190	232
1fc8902f DH	233	/* Freelists consist of linked cells where the type entry holds the value
	234	* scm_tc_free_cell and the second entry holds a pointer to the next cell of
	235	* the freelist. Due to this structure, freelist cells are not cons cells
	236	* and thus may not be accessed using SCM_CAR and SCM_CDR. */
61045190	237
1fc8902f DH	238	#define SCM_FREE_CELL_P(x) \
	239	(!SCM_IMP (x) && (SCM_GC_CELL_TYPE (x) == scm_tc_free_cell))
	240	#define SCM_FREE_CELL_CDR(x) \
	241	(SCM_GC_CELL_OBJECT ((x), 1))
	242	#define SCM_SET_FREE_CELL_CDR(x, v) \
	243	(SCM_GC_SET_CELL_OBJECT ((x), 1, (v)))
61045190 DH	244
61045190 DH	245
92c2555f	246	#define SCM_CELL_WORD_LOC(x, n) ((scm_t_bits *) & SCM_CELL_WORD (x, n))
f706a58b DH	247	#define SCM_CARLOC(x) ((SCM *) SCM_CELL_WORD_LOC ((x), 0))
f706a58b DH	248	#define SCM_CDRLOC(x) ((SCM *) SCM_CELL_WORD_LOC ((x), 1))
2549a709 DH	249
2549a709 DH	250
6ba93e5e DH	251	/* SCM_PTR_LT and friends define how to compare two SCM_CELLPTRs (which may
6ba93e5e DH	252	* point to cells in different heap segments).
2549a709	253	*/
6ba93e5e DH	254	#define SCM_PTR_LT(x, y) ((x) < (y))
6ba93e5e DH	255	#define SCM_PTR_GT(x, y) (SCM_PTR_LT (y, x))
2549a709 DH	256	#define SCM_PTR_LE(x, y) (!SCM_PTR_GT (x, y))
	257	#define SCM_PTR_GE(x, y) (!SCM_PTR_LT (x, y))
	258
	259
e618c9a3	260	#define SCM_MARKEDP SCM_GCMARKP
2d67e390	261	#define SCM_NMARKEDP(x) (!SCM_MARKEDP (x))
79e3f9e2	262
61045190	263	#if (SCM_DEBUG_CELL_ACCESSES == 1)
33b001fd	264	SCM_API unsigned int scm_debug_cell_accesses_p;
61045190 DH	265	#endif
61045190 DH	266
33b001fd MV	267	SCM_API struct scm_t_heap_seg_data *scm_heap_table;
	268	SCM_API size_t scm_n_heap_segs;
	269	SCM_API int scm_block_gc;
	270	SCM_API int scm_gc_heap_lock;
	271	SCM_API unsigned int scm_gc_running_p;
0f2d19dd JB	272	\f
0f2d19dd JB	273
33b001fd MV	274	SCM_API size_t scm_default_init_heap_size_1;
	275	SCM_API int scm_default_min_yield_1;
	276	SCM_API size_t scm_default_init_heap_size_2;
	277	SCM_API int scm_default_min_yield_2;
	278	SCM_API size_t scm_default_max_segment_size;
	279
	280	SCM_API size_t scm_max_segment_size;
	281	SCM_API SCM_CELLPTR scm_heap_org;
	282	SCM_API SCM scm_freelist;
	283	SCM_API struct scm_t_freelist scm_master_freelist;
	284	SCM_API SCM scm_freelist2;
	285	SCM_API struct scm_t_freelist scm_master_freelist2;
	286	SCM_API unsigned long scm_gc_cells_collected;
	287	SCM_API unsigned long scm_gc_yield;
	288	SCM_API unsigned long scm_gc_malloc_collected;
	289	SCM_API unsigned long scm_gc_ports_collected;
	290	SCM_API unsigned long scm_cells_allocated;
	291	SCM_API unsigned long scm_mallocated;
	292	SCM_API unsigned long scm_mtrigger;
	293
	294	SCM_API SCM scm_after_gc_hook;
	295
	296	SCM_API scm_t_c_hook scm_before_gc_c_hook;
	297	SCM_API scm_t_c_hook scm_before_mark_c_hook;
	298	SCM_API scm_t_c_hook scm_before_sweep_c_hook;
	299	SCM_API scm_t_c_hook scm_after_sweep_c_hook;
	300	SCM_API scm_t_c_hook scm_after_gc_c_hook;
9b3e180c	301
bb2c57fa	302	#if defined (GUILE_DEBUG) \|\| defined (GUILE_DEBUG_FREELIST)
33b001fd MV	303	SCM_API SCM scm_map_free_list (void);
33b001fd MV	304	SCM_API SCM scm_free_list_length (void);
bb2c57fa MD	305	#endif
bb2c57fa MD	306	#ifdef GUILE_DEBUG_FREELIST
33b001fd	307	SCM_API SCM scm_gc_set_debug_check_freelist_x (SCM flag);
88256b2e JB	308	#endif
88256b2e JB	309
0f2d19dd	310	\f
0f2d19dd	311
61045190	312	#if (SCM_DEBUG_CELL_ACCESSES == 1)
33b001fd MV	313	SCM_API void scm_assert_cell_valid (SCM);
33b001fd MV	314	SCM_API SCM scm_set_debug_cell_accesses_x (SCM flag);
61045190	315	#endif
33b001fd	316	SCM_API SCM scm_object_address (SCM obj);
33b001fd MV	317	SCM_API SCM scm_gc_stats (void);
	318	SCM_API SCM scm_gc (void);
	319	SCM_API void scm_gc_for_alloc (struct scm_t_freelist *freelist);
	320	SCM_API SCM scm_gc_for_newcell (struct scm_t_freelist master, SCM freelist);
4c48ba06	321	#if 0
33b001fd	322	SCM_API void scm_alloc_cluster (struct scm_t_freelist *master);
4c48ba06	323	#endif
33b001fd MV	324	SCM_API void scm_igc (const char *what);
	325	SCM_API void scm_gc_mark (SCM p);
	326	SCM_API void scm_gc_mark_dependencies (SCM p);
	327	SCM_API void scm_mark_locations (SCM_STACKITEM x[], unsigned long n);
	328	SCM_API int scm_cellp (SCM value);
	329	SCM_API void scm_gc_sweep (void);
4c9419ac MV	330
	331	SCM_API void *scm_malloc (size_t size);
	332	SCM_API void scm_realloc (void mem, size_t size);
	333	SCM_API char scm_strdup (const char str);
	334	SCM_API char scm_strndup (const char str, size_t n);
	335	SCM_API void scm_gc_register_collectable_memory (void *mem, size_t size,
	336	const char *what);
	337	SCM_API void scm_gc_unregister_collectable_memory (void *mem, size_t size,
	338	const char *what);
	339	SCM_API void scm_gc_malloc (size_t size, const char what);
	340	SCM_API void scm_gc_realloc (void mem, size_t old_size,
	341	size_t new_size, const char *what);
	342	SCM_API void scm_gc_free (void mem, size_t size, const char what);
	343	SCM_API char scm_gc_strdup (const char str, const char *what);
	344	SCM_API char scm_gc_strndup (const char str, size_t n, const char *what);
	345
33b001fd MV	346	SCM_API void scm_remember_upto_here_1 (SCM obj);
	347	SCM_API void scm_remember_upto_here_2 (SCM obj1, SCM obj2);
	348	SCM_API void scm_remember_upto_here (SCM obj1, ...);
	349	SCM_API SCM scm_return_first (SCM elt, ...);
	350	SCM_API int scm_return_first_int (int x, ...);
	351	SCM_API SCM scm_permanent_object (SCM obj);
	352	SCM_API SCM scm_gc_protect_object (SCM obj);
	353	SCM_API SCM scm_gc_unprotect_object (SCM obj);
	354	SCM_API void scm_gc_register_root (SCM *p);
	355	SCM_API void scm_gc_unregister_root (SCM *p);
	356	SCM_API void scm_gc_register_roots (SCM *b, unsigned long n);
	357	SCM_API void scm_gc_unregister_roots (SCM *b, unsigned long n);
	358	SCM_API int scm_init_storage (void);
	359	SCM_API void *scm_get_stack_base (void);
	360	SCM_API void scm_init_gc (void);
d1ca2c64	361
d678e25c MV	362	#if SCM_ENABLE_DEPRECATED == 1
	363
	364	SCM_API SCM scm_deprecated_newcell (void);
	365	SCM_API SCM scm_deprecated_newcell2 (void);
	366
	367	#define SCM_NEWCELL(_into) \
	368	do { _into = scm_deprecated_newcell (); } while (0)
	369	#define SCM_NEWCELL2(_into) \
	370	do { _into = scm_deprecated_newcell2 (); } while (0)
	371
539b08a4 MV	372	SCM_API void * scm_must_malloc (size_t len, const char *what);
	373	SCM_API void * scm_must_realloc (void *where,
	374	size_t olen, size_t len,
	375	const char *what);
	376	SCM_API char scm_must_strdup (const char str);
	377	SCM_API char scm_must_strndup (const char str, size_t n);
	378	SCM_API void scm_done_malloc (long size);
	379	SCM_API void scm_done_free (long size);
	380	SCM_API void scm_must_free (void *obj);
	381
d678e25c MV	382	#endif
d678e25c MV	383
61045190	384	#endif /* SCM_GC_H */
89e00824 ML	385
	386	/*
	387	Local Variables:
	388	c-file-style: "gnu"
	389	End:
	390	*/