* eval.c: remove commented code, remove #ifdef CCLO conditionals
[bpt/guile.git] / libguile / gc.h
index cd1b1fb..9397e56 100644 (file)
@@ -2,18 +2,18 @@
 
 #ifndef GCH
 #define GCH
-/*     Copyright (C) 1995, 1996, 1998 Free Software Foundation, Inc.
- * 
+/* Copyright (C) 1995, 96, 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,
  * 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 "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))
+typedef struct scm_cell
+{
+  scm_bits_t word_0;
+  scm_bits_t word_1;
+} scm_cell;
+
+
+/* SCM_CELLPTR is a pointer to a cons cell which may be compared or
+ * differenced.
+ */
+typedef scm_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_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_bits_t) (x)) << 3))
+#else
+#  define SCM2PTR(x) ((SCM_CELLPTR) (SCM_UNPACK (x)))
+#  define PTR2SCM(x) (SCM_PACK ((scm_bits_t) (x)))
+#endif /* def _UNICOS */
+
+#define SCM_GC_CARD_N_HEADER_CELLS 1
+#define SCM_GC_CARD_N_CELLS        256
+
+#define SCM_GC_CARD_SIZE           (SCM_GC_CARD_N_CELLS * sizeof (scm_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_cell *) (x), SCM_GC_CELL_CARD (x) + SCM_GC_CARD_N_HEADER_CELLS)
+
+#define SCM_GC_CARD_BVEC(card)  ((scm_c_bvec_limb_t *) ((card)->word_0))
+
+#define SCM_GC_GET_CARD_FLAGS(card) ((long) ((card)->word_1))
+#define SCM_GC_SET_CARD_FLAGS(card, flags) (SCM_GC_GET_CARD_FLAGS (card) = (flags))
+#define SCM_GC_CLR_CARD_FLAGS(card) (SCM_GC_GET_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_GET_CARD_FLAGS (card) |= (1L << (shift)))
+#define SCM_GC_CLR_CARD_FLAG(card, shift) (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_c_bvec_limb_t;
+
+#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_c_bvec_limb_t) * ((((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 */
 
-/* 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))
+#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)
 
-extern struct scm_heap_seg_data *scm_heap_table;
+/* Low level cell data accessing 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), ((const scm_bits_t *) SCM2PTR (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_PACK (((const scm_bits_t *) SCM2PTR (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_bits_t *) SCM2PTR (x)) [n] = (scm_bits_t) (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_bits_t *) SCM2PTR (x)) [n] = SCM_UNPACK (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)
+
+#define SCM_SETAND_CAR(x, y) \
+  (SCM_SETCAR ((x), SCM_PACK (SCM_UNPACK (SCM_CAR (x)) & (y))))
+#define SCM_SETAND_CDR(x, y)\
+  (SCM_SETCDR ((x), SCM_PACK (SCM_UNPACK (SCM_CDR (x)) & (y))))
+#define SCM_SETOR_CAR(x, y)\
+  (SCM_SETCAR ((x), SCM_PACK (SCM_UNPACK (SCM_CAR (x)) | (y))))
+#define SCM_SETOR_CDR(x, y)\
+  (SCM_SETCDR ((x), SCM_PACK (SCM_UNPACK (SCM_CDR (x)) | (y))))
+
+#define SCM_CELL_WORD_LOC(x, n) ((scm_bits_t *) & 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))
+
+
+/* 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) && (* (const scm_bits_t *) SCM2PTR (x) == scm_tc_free_cell))
+#define SCM_FREE_CELL_CDR(x) \
+  (SCM_PACK (((const scm_bits_t *) SCM2PTR (x)) [1]))
+#define SCM_SET_FREE_CELL_TYPE(x, v) \
+  (((scm_bits_t *) SCM2PTR (x)) [0] = (v))
+#define SCM_SET_FREE_CELL_CDR(x, v) \
+  (((scm_bits_t *) SCM2PTR (x)) [1] = SCM_UNPACK (v))
+
+#ifdef GUILE_DEBUG_FREELIST
+#define SCM_NEWCELL(_into) do { _into = scm_debug_newcell (); } while (0)
+#define SCM_NEWCELL2(_into) do { _into = scm_debug_newcell2 (); } while (0)
+#else
+/* When we introduce POSIX threads support, every thread will have
+   a freelist of its own.  */
+#define SCM_NEWCELL(_into) \
+        do { \
+          if (SCM_IMP (scm_freelist)) \
+             _into = scm_gc_for_newcell (&scm_master_freelist, \
+                                         &scm_freelist); \
+          else \
+            { \
+               _into = scm_freelist; \
+               scm_freelist = SCM_FREE_CELL_CDR (scm_freelist); \
+            } \
+        } while(0)
+#define SCM_NEWCELL2(_into) \
+        do { \
+          if (SCM_IMP (scm_freelist2)) \
+             _into = scm_gc_for_newcell (&scm_master_freelist2, \
+                                         &scm_freelist2); \
+          else \
+            { \
+               _into = scm_freelist2; \
+               scm_freelist2 = SCM_FREE_CELL_CDR (scm_freelist2); \
+            } \
+        } while(0)
+#endif
+
+
+#define SCM_MARKEDP    SCM_GCMARKP
+#define SCM_NMARKEDP(x) (!SCM_MARKEDP (x))
+
+extern struct scm_heap_seg_data_t *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;
+extern unsigned int scm_gc_running_p;
 \f
 
+extern int scm_default_init_heap_size_1;
+extern int scm_default_min_yield_1;
+extern int scm_default_init_heap_size_2;
+extern int scm_default_min_yield_2;
+extern int scm_default_max_segment_size;
 
-extern unsigned long scm_heap_size;
+extern scm_sizet scm_max_segment_size;
 extern SCM_CELLPTR scm_heap_org;
 extern SCM scm_freelist;
+extern struct scm_freelist_t scm_master_freelist;
+extern SCM scm_freelist2;
+extern struct scm_freelist_t scm_master_freelist2;
 extern unsigned long scm_gc_cells_collected;
+extern unsigned long scm_gc_yield;
 extern unsigned long scm_gc_malloc_collected;
 extern unsigned long scm_gc_ports_collected;
 extern unsigned long scm_cells_allocated;
-extern unsigned long scm_mallocated;
+extern long scm_mallocated;
 extern unsigned long scm_mtrigger;
 
-#ifdef DEBUG_FREELIST
+extern SCM scm_after_gc_hook;
+
+extern scm_c_hook_t scm_before_gc_c_hook;
+extern scm_c_hook_t scm_before_mark_c_hook;
+extern scm_c_hook_t scm_before_sweep_c_hook;
+extern scm_c_hook_t scm_after_sweep_c_hook;
+extern scm_c_hook_t scm_after_gc_c_hook;
+
+#if (SCM_DEBUG_CELL_ACCESSES == 1)
+extern void scm_assert_cell_valid (SCM);
+extern unsigned int scm_debug_cell_accesses_p;
+extern SCM scm_set_debug_cell_accesses_x (SCM flag);
+#endif
+
+#if defined (GUILE_DEBUG) || defined (GUILE_DEBUG_FREELIST)
+extern SCM scm_map_free_list (void);
+extern SCM scm_free_list_length (void);
+#endif
+#ifdef GUILE_DEBUG_FREELIST
 extern SCM scm_debug_newcell (void);
+extern SCM scm_debug_newcell2 (void);
+extern SCM scm_gc_set_debug_check_freelist_x (SCM flag);
 #endif
 
 \f
 
-extern SCM scm_object_addr (SCM obj);
+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_gc_for_alloc (struct scm_freelist_t *freelist);
+extern SCM scm_gc_for_newcell (struct scm_freelist_t *master, SCM *freelist);
+#if 0
+extern void scm_alloc_cluster (struct scm_freelist_t *master);
+#endif
 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 char * scm_must_malloc (scm_sizet len, const char *what);
-extern char * scm_must_realloc (char *where,
+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 (char *obj);
+extern void scm_done_free (long size);
+extern void scm_must_free (void *obj);
 extern void scm_remember (SCM * ptr);
 extern SCM scm_return_first (SCM elt, ...);
+extern int scm_return_first_int (int x, ...);
 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 int scm_init_storage (scm_sizet init_heap_size, int trig,
+                             scm_sizet init_heap2_size, int trig2,
+                            scm_sizet max_segment_size);
+extern void *scm_get_stack_base (void);
 extern void scm_init_gc (void);
+
+\f
+
+#if (SCM_DEBUG_DEPRECATED == 0)
+
+#define SCM_FREEP(x) (SCM_FREE_CELL_P (x))
+#define SCM_NFREEP(x) (!SCM_FREE_CELL_P (x))
+#define SCM_GC8MARKP(x) SCM_GCMARKP (x)
+#define SCM_SETGC8MARK(x) SCM_SETGCMARK (x)
+#define SCM_CLRGC8MARK(x) SCM_CLRGCMARK (x)
+#define SCM_GCTYP16(x) SCM_TYP16 (x)
+#define SCM_GCCDR(x) SCM_CDR (x)
+
+#endif  /* SCM_DEBUG_DEPRECATED == 0 */
+
 #endif  /* GCH */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/