/* classes: h_files */
-#ifndef GCH
-#define GCH
-/* Copyright (C) 1995, 1996, 1998, 1999 Free Software Foundation, Inc.
- *
+#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,
* 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
-#define SCM_FREEP(x) (SCM_CAR(x)==scm_tc_free_cell)
-#define SCM_NFREEP(x) (!SCM_FREEP(x))
-
-/* 1. This shouldn't be used on immediates.
- 2. It thinks that subrs are always unmarked (harmless). */
-#define SCM_MARKEDP(x) ((SCM_CAR(x) & 5) == 5 \
- ? SCM_GC8MARKP(x) \
- : SCM_GCMARKP(x))
-#define SCM_NMARKEDP(x) (!SCM_MARKEDP(x))
-
-extern struct scm_heap_seg_data *scm_heap_table;
-extern int scm_n_heap_segs;
-extern int scm_take_stdin;
-extern int scm_block_gc;
-extern int scm_gc_heap_lock;
+typedef struct scm_t_cell
+{
+ scm_t_bits word_0;
+ scm_t_bits word_1;
+} scm_t_cell;
+
+/*
+ CARDS
+
+ A card is a small `page' of memory; it will be the unit for lazy
+ sweeping, generations, etc. The first cell of a card contains a
+ pointer to the mark bitvector, so that we can find the bitvector efficiently: we
+ knock off some lowerorder bits.
+
+ The size on a 32 bit machine is 256 cells = 2kb. The card
+*/
+
+
+
+/* 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_t_cell *) (SCM_UNPACK (x) >> 3))
+# define PTR2SCM(x) (SCM_PACK (((scm_t_bits) (x)) << 3))
+#else
+# define SCM2PTR(x) ((scm_t_cell *) (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_SIZEOF_CARD SCM_GC_CARD_N_CELLS * sizeof (scm_t_cell)
+
+#define SCM_GC_CARD_BVEC(card) ((scm_t_c_bvec_long *) ((card)->word_0))
+#define SCM_GC_SET_CARD_BVEC(card, bvec) \
+ ((card)->word_0 = (scm_t_bits) (bvec))
+
+
+#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_CLEAR_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_CLEAR_CARD_FLAG(card, shift) \
+ (SCM_GC_SET_CARD_FLAGS (card, SCM_GC_GET_CARD_FLAGS(card) & ~(1L << (shift))))
+
+/*
+ Remove card flags. They hamper lazy initialization, and aren't used
+ anyways.
+ */
+
+/* card addressing. for efficiency, cards are *always* aligned to
+ SCM_GC_CARD_SIZE. */
+
+#define SCM_GC_CARD_SIZE_MASK (SCM_GC_CARD_N_CELLS * sizeof (scm_t_cell) - 1)
+#define SCM_GC_CARD_ADDR_MASK (~SCM_GC_CARD_SIZE_MASK)
+
+#define SCM_GC_CELL_CARD(x) ((scm_t_cell *) ((long) (x) & SCM_GC_CARD_ADDR_MASK))
+#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_CLEAR_BIT(x) SCM_C_BVEC_CLEAR (SCM_GC_CELL_BVEC (x), SCM_GC_CELL_OFFSET (x))
+
+#define SCM_GC_CARD_UP(x) SCM_GC_CELL_CARD ((char *) (x) + SCM_GC_SIZEOF_CARD - 1)
+#define SCM_GC_CARD_DOWN SCM_GC_CELL_CARD
+
+/* low level bit banging aids */
+typedef unsigned long scm_t_c_bvec_long;
+
+#if (SIZEOF_LONG == 8)
+# define SCM_C_BVEC_LONG_BITS 64
+# define SCM_C_BVEC_OFFSET_SHIFT 6
+# define SCM_C_BVEC_POS_MASK 63
+# define SCM_CELL_SIZE_SHIFT 4
+# define SCM_SIZEOF_LONG SIZEOF_LONG
+#else
+# define SCM_C_BVEC_LONG_BITS 32
+# define SCM_SIZEOF_LONG SIZEOF_LONG
+# 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_CLEAR(bvec, pos) (bvec[SCM_C_BVEC_OFFSET (pos)] &= ~(1L << (pos & SCM_C_BVEC_POS_MASK)))
+
+/* testing and changing GC marks */
+#define SCM_GC_MARK_P(x) SCM_GC_CELL_GET_BIT (x)
+#define SCM_SET_GC_MARK(x) SCM_GC_CELL_SET_BIT (x)
+#define SCM_CLEAR_GC_MARK(x) SCM_GC_CELL_CLEAR_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. */
+
+/*
+ SCM_FREECELL_P removed ; the semantics are ambiguous with lazy
+ sweeping. Could mean "this cell is no longer in use (will be swept)"
+ or "this cell has just been swept, and is not yet in use".
+ */
+
+#define SCM_FREECELL_P this_macro_has_been_removed_see_gc_header_file
+
+#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))
+
+
+
+
+#if (SCM_DEBUG_CELL_ACCESSES == 1)
+/* Set this to != 0 if every cell that is accessed shall be checked:
+ */
+SCM_API int scm_debug_cell_accesses_p;
+SCM_API int scm_expensive_debug_cell_accesses_p;
+SCM_API int scm_debug_cells_gc_interval ;
+void scm_i_expensive_validation_check (SCM cell);
+#endif
+
+SCM_API int scm_block_gc;
+SCM_API int scm_gc_heap_lock;
+SCM_API unsigned int scm_gc_running_p;
\f
+#if (SCM_ENABLE_DEPRECATED == 1)
+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;
+#else
+#define scm_default_init_heap_size_1 deprecated
+#define scm_default_min_yield_1 deprecated
+#define scm_default_init_heap_size_2 deprecated
+#define scm_default_min_yield_2 deprecated
+#define scm_default_max_segment_size deprecated
+#endif
+
+
+SCM_API size_t scm_max_segment_size;
+
+/*
+ Deprecated scm_freelist, scm_master_freelist.
+ No warning; this is not a user serviceable part.
+ */
+extern SCM scm_i_freelist;
+extern struct scm_t_cell_type_statistics scm_i_master_freelist;
+extern SCM scm_i_freelist2;
+extern struct scm_t_cell_type_statistics scm_i_master_freelist2;
+
-extern unsigned long scm_heap_size;
-extern SCM_CELLPTR scm_heap_org;
-extern SCM scm_freelist;
-extern unsigned long scm_gc_cells_collected;
-extern unsigned long scm_gc_malloc_collected;
-extern unsigned long scm_gc_ports_collected;
-extern unsigned long scm_cells_allocated;
-extern long scm_mallocated;
-extern unsigned long scm_mtrigger;
+SCM_API unsigned long scm_gc_cells_swept;
+SCM_API unsigned long scm_gc_cells_collected;
+SCM_API unsigned long scm_gc_cells_collected;
+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 int scm_gc_cell_yield_percentage;
+SCM_API int scm_gc_malloc_yield_percentage;
+SCM_API unsigned long scm_mallocated;
+SCM_API unsigned long scm_mtrigger;
-#ifdef DEBUG_FREELIST
-extern SCM scm_debug_newcell (void);
+
+
+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)
+#define scm_map_free_list deprecated
+#define scm_free_list_length deprecated
#endif
+#if (SCM_ENABLE_DEPRECATED == 1) && defined (GUILE_DEBUG_FREELIST)
+SCM_API SCM scm_gc_set_debug_check_freelist_x (SCM flag);
+#endif
\f
-extern SCM scm_object_address (SCM obj);
-extern SCM scm_unhash_name (SCM name);
-extern SCM scm_gc_stats (void);
-extern void scm_gc_start (const char *what);
-extern void scm_gc_end (void);
-extern SCM scm_gc (void);
-extern void scm_gc_for_alloc (int ncells, SCM * freelistp);
-extern SCM scm_gc_for_newcell (void);
-extern void scm_igc (const char *what);
-extern void scm_gc_mark (SCM p);
-extern void scm_mark_locations (SCM_STACKITEM x[], scm_sizet n);
-extern int scm_cellp (SCM value);
-extern void scm_gc_sweep (void);
-extern void * scm_must_malloc (scm_sizet len, const char *what);
-extern void * scm_must_realloc (void *where,
- scm_sizet olen, scm_sizet len,
- const char *what);
-extern void scm_done_malloc (long size);
-extern void scm_must_free (void *obj);
-extern void scm_remember (SCM * ptr);
-extern SCM scm_return_first (SCM elt, ...);
-extern SCM scm_permanent_object (SCM obj);
-extern SCM scm_protect_object (SCM obj);
-extern SCM scm_unprotect_object (SCM obj);
-extern int scm_init_storage (scm_sizet init_heap_size);
-extern void scm_init_gc (void);
-#endif /* GCH */
+#if (SCM_DEBUG_CELL_ACCESSES == 1)
+SCM_API void scm_assert_cell_valid (SCM);
+#endif
+
+SCM_API SCM scm_set_debug_cell_accesses_x (SCM flag);
+
+
+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_cell_type_statistics *freelist);
+SCM_API SCM scm_gc_for_newcell (struct scm_t_cell_type_statistics *master, SCM *freelist);
+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_in_heap_p (SCM value);
+SCM_API void scm_gc_sweep (void);
+
+SCM_API void *scm_malloc (size_t size);
+SCM_API void *scm_calloc (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_calloc (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:
+*/
HCoop / bpt / guile.git / blobdiff