* tags.h: (SCM_DOUBLE_CELLP, SCM_NDOUBLE_CELLP): new macros.
[bpt/guile.git] / libguile / gc.h
1 /* classes: h_files */
2
3 #ifndef GCH
4 #define GCH
5 /* Copyright (C) 1995, 96, 98, 99, 2000 Free Software Foundation, Inc.
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2, or (at your option)
10 * any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this software; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307 USA
21 *
22 * As a special exception, the Free Software Foundation gives permission
23 * for additional uses of the text contained in its release of GUILE.
24 *
25 * The exception is that, if you link the GUILE library with other files
26 * to produce an executable, this does not by itself cause the
27 * resulting executable to be covered by the GNU General Public License.
28 * Your use of that executable is in no way restricted on account of
29 * linking the GUILE library code into it.
30 *
31 * This exception does not however invalidate any other reasons why
32 * the executable file might be covered by the GNU General Public License.
33 *
34 * This exception applies only to the code released by the
35 * Free Software Foundation under the name GUILE. If you copy
36 * code from other Free Software Foundation releases into a copy of
37 * GUILE, as the General Public License permits, the exception does
38 * not apply to the code that you add in this way. To avoid misleading
39 * anyone as to the status of such modified files, you must delete
40 * this exception notice from them.
41 *
42 * If you write modifications of your own for GUILE, it is your choice
43 * whether to permit this exception to apply to your modifications.
44 * If you do not wish that, delete this exception notice. */
45
46 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
47 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
48 \f
49
50 #include "libguile/__scm.h"
51 \f
52
53 #define SCM_FREEP(x) (SCM_NIMP(x) && SCM_UNPACK_CAR (x)==scm_tc_free_cell)
54 #define SCM_NFREEP(x) (!SCM_FREEP(x))
55
56 /* 1. This shouldn't be used on immediates.
57 2. It thinks that subrs are always unmarked (harmless). */
58 #define SCM_MARKEDP(x) ((SCM_UNPACK_CAR (x) & 5) == 5 \
59 ? SCM_GC8MARKP(x) \
60 : SCM_GCMARKP(x))
61 #define SCM_NMARKEDP(x) (!SCM_MARKEDP(x))
62
63 extern struct scm_heap_seg_data_t *scm_heap_table;
64 extern int scm_n_heap_segs;
65 extern int scm_take_stdin;
66 extern int scm_block_gc;
67 extern int scm_gc_heap_lock;
68 \f
69
70 extern scm_sizet scm_max_segment_size;
71 extern SCM_CELLPTR scm_heap_org;
72 #ifdef GUILE_NEW_GC_SCHEME
73 extern SCM scm_freelist;
74 extern struct scm_freelist_t scm_master_freelist;
75 extern SCM scm_freelist2;
76 extern struct scm_freelist_t scm_master_freelist2;
77 #else
78 extern struct scm_freelist_t scm_freelist;
79 extern struct scm_freelist_t scm_freelist2;
80 #endif
81 extern unsigned long scm_gc_cells_collected;
82 extern unsigned long scm_gc_malloc_collected;
83 extern unsigned long scm_gc_ports_collected;
84 extern unsigned long scm_cells_allocated;
85 extern long scm_mallocated;
86 extern unsigned long scm_mtrigger;
87
88 #if defined (GUILE_DEBUG) || defined (GUILE_DEBUG_FREELIST)
89 extern SCM scm_map_free_list (void);
90 extern SCM scm_free_list_length (void);
91 #endif
92 #ifdef GUILE_DEBUG_FREELIST
93 extern SCM scm_debug_newcell (void);
94 extern SCM scm_debug_newcell2 (void);
95 extern SCM scm_gc_set_debug_check_freelist_x (SCM flag);
96 #endif
97
98 \f
99
100 extern SCM scm_object_address (SCM obj);
101 extern SCM scm_unhash_name (SCM name);
102 extern SCM scm_gc_stats (void);
103 extern void scm_gc_start (const char *what);
104 extern void scm_gc_end (void);
105 extern SCM scm_gc (void);
106 extern void scm_gc_for_alloc (struct scm_freelist_t *freelist);
107 #ifdef GUILE_NEW_GC_SCHEME
108 extern SCM scm_gc_for_newcell (struct scm_freelist_t *master, SCM *freelist);
109 #if 0
110 extern void scm_alloc_cluster (struct scm_freelist_t *master);
111 #endif
112 #else
113 extern SCM scm_gc_for_newcell (struct scm_freelist_t *freelist);
114 #endif
115 extern void scm_igc (const char *what);
116 extern void scm_gc_mark (SCM p);
117 extern void scm_mark_locations (SCM_STACKITEM x[], scm_sizet n);
118 extern int scm_cellp (SCM value);
119 extern void scm_gc_sweep (void);
120 extern void * scm_must_malloc (scm_sizet len, const char *what);
121 extern void * scm_must_realloc (void *where,
122 scm_sizet olen, scm_sizet len,
123 const char *what);
124 extern void scm_done_malloc (long size);
125 extern void scm_must_free (void *obj);
126 extern void scm_remember (SCM * ptr);
127 extern SCM scm_return_first (SCM elt, ...);
128 extern int scm_return_first_int (int x, ...);
129 extern SCM scm_permanent_object (SCM obj);
130 extern SCM scm_protect_object (SCM obj);
131 extern SCM scm_unprotect_object (SCM obj);
132 #ifdef GUILE_NEW_GC_SCHEME
133 extern int scm_init_storage (scm_sizet init_heap_size, int trig,
134 scm_sizet init_heap2_size, int trig2,
135 scm_sizet max_segment_size);
136 #else
137 extern int scm_init_storage (scm_sizet init_heap_size,
138 scm_sizet init_heap2_size);
139 #endif
140 extern void scm_init_gc (void);
141 #endif /* GCH */