mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-07-01 15:20:34 +02:00
27caa4cb98
* libguile/gc.h: * libguile/pairs.h (scm_pair_car_loc, scm_pair_cdr_loc): New helpers. (SCM_CARLOC, SCM_CDRLOC): Move here from gc.h. * libguile/list.c (scm_list_1, scm_list_2, scm_list_3): Just use scm_cons.
189 lines
7.2 KiB
C
189 lines
7.2 KiB
C
#ifndef SCM_GC_H
|
||
#define SCM_GC_H
|
||
|
||
/* Copyright 1995-1996,1998-2004,2006-2014,2018,2025
|
||
Free Software Foundation, Inc.
|
||
|
||
This file is part of Guile.
|
||
|
||
Guile is free software: you can redistribute it and/or modify it
|
||
under the terms of the GNU Lesser General Public License as published
|
||
by the Free Software Foundation, either version 3 of the License, or
|
||
(at your option) any later version.
|
||
|
||
Guile 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 Lesser General Public
|
||
License for more details.
|
||
|
||
You should have received a copy of the GNU Lesser General Public
|
||
License along with Guile. If not, see
|
||
<https://www.gnu.org/licenses/>. */
|
||
|
||
|
||
|
||
#include "libguile/inline.h"
|
||
#include "libguile/chooks.h"
|
||
|
||
|
||
/* Before Guile 2.0, Guile had a custom garbage collector and memory
|
||
management system that largely worked in terms of "cells", two-word
|
||
heap-tagged objects. This is no longer the case, and the "cell"
|
||
concept is obsolete; the allocator can now make objects of any size.
|
||
Still, some old code uses "cell" to mean a two-word allocation, so
|
||
for that reason you'll see the word around Guile. */
|
||
|
||
typedef struct scm_t_cell
|
||
{
|
||
SCM word_0;
|
||
SCM word_1;
|
||
} scm_t_cell;
|
||
|
||
/* FIXME: deprecate. */
|
||
#define PTR2SCM(x) (SCM_PACK_POINTER (x))
|
||
#define SCM2PTR(x) ((scm_t_cell *) (SCM_UNPACK_POINTER (x)))
|
||
|
||
#define SCM_GC_CELL_OBJECT(x, n) (((SCM *)SCM2PTR (x)) [n])
|
||
#define SCM_GC_CELL_WORD(x, n) (SCM_UNPACK (SCM_GC_CELL_OBJECT ((x), (n))))
|
||
|
||
#define SCM_GC_SET_CELL_OBJECT(x, n, v) ((((SCM *)SCM2PTR (x)) [n]) = (v))
|
||
#define SCM_GC_SET_CELL_WORD(x, n, v) \
|
||
(SCM_GC_SET_CELL_OBJECT ((x), (n), SCM_PACK (v)))
|
||
|
||
#define SCM_GC_CELL_TYPE(x) (SCM_GC_CELL_OBJECT ((x), 0))
|
||
|
||
#define SCM_CELL_WORD(x, n) 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_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_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_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_OBJECT_LOC(x, n) (&SCM_GC_CELL_OBJECT ((x), (n)))
|
||
|
||
#define SCM_CELL_TYPE(x) SCM_CELL_WORD_0 (x)
|
||
#define SCM_SET_CELL_TYPE(x, t) SCM_SET_CELL_WORD_0 ((x), (t))
|
||
|
||
|
||
|
||
|
||
SCM_API unsigned long scm_gc_ports_collected;
|
||
|
||
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;
|
||
|
||
|
||
|
||
SCM_API SCM scm_set_debug_cell_accesses_x (SCM flag);
|
||
|
||
|
||
SCM_API SCM scm_object_address (SCM obj);
|
||
SCM_API SCM scm_gc_enable (void);
|
||
SCM_API SCM scm_gc_disable (void);
|
||
SCM_API SCM scm_gc_dump (void);
|
||
SCM_API SCM scm_gc_stats (void);
|
||
SCM_API SCM scm_gc (void);
|
||
SCM_INTERNAL void scm_i_gc (const char *what);
|
||
SCM_API void scm_gc_mark (SCM p);
|
||
SCM_API void scm_gc_sweep (void);
|
||
|
||
SCM_API void scm_gc_register_allocation (size_t size);
|
||
|
||
SCM_API void *scm_malloc (size_t size) SCM_MALLOC;
|
||
SCM_API void *scm_calloc (size_t size) SCM_MALLOC;
|
||
SCM_API void *scm_realloc (void *mem, size_t size);
|
||
SCM_API char *scm_strdup (const char *str) SCM_MALLOC;
|
||
SCM_API char *scm_strndup (const char *str, size_t n) SCM_MALLOC;
|
||
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_allocate_pointerless (struct scm_thread *thr, size_t size);
|
||
SCM_API void *scm_allocate_tagged (struct scm_thread *thr, size_t size);
|
||
SCM_API void *scm_allocate_sloppy (struct scm_thread *thr, size_t size);
|
||
|
||
SCM_API void *scm_gc_malloc_pointerless (size_t size, const char *what)
|
||
SCM_MALLOC;
|
||
SCM_API void *scm_gc_calloc (size_t size, const char *what)
|
||
SCM_MALLOC;
|
||
SCM_API void *scm_gc_malloc (size_t size, const char *what)
|
||
SCM_MALLOC;
|
||
SCM_API char *scm_gc_strdup (const char *str, const char *what)
|
||
SCM_MALLOC;
|
||
SCM_API char *scm_gc_strndup (const char *str, size_t n, const char *what)
|
||
SCM_MALLOC;
|
||
|
||
#define scm_gc_typed_calloc(t) ((t *) scm_gc_calloc (sizeof (t), #t))
|
||
|
||
#define SCM_GC_MALLOC(size) scm_gc_malloc (size, NULL)
|
||
#define SCM_GC_MALLOC_POINTERLESS(size) scm_gc_malloc_pointerless (size, NULL)
|
||
|
||
|
||
SCM scm_cell (scm_t_bits car, scm_t_bits cdr);
|
||
SCM scm_double_cell (scm_t_bits car, scm_t_bits cbr,
|
||
scm_t_bits ccr, scm_t_bits cdr);
|
||
SCM scm_words (scm_t_bits car, uint32_t n_words);
|
||
|
||
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, ...);
|
||
|
||
/* In GCC we can force a reference to an SCM by making it an input to an
|
||
empty asm. This avoids the code size and slowdown of an actual function
|
||
call. Unfortunately there doesn't seem to be any way to do the varargs
|
||
scm_remember_upto_here like this.
|
||
|
||
__volatile__ ensures nothing will be moved across the asm, and it won't
|
||
be optimized away (or only if proved unreachable). Constraint "g" can be
|
||
used on all processors and allows any memory or general register (or
|
||
immediate) operand. The actual asm syntax doesn't matter, we don't want
|
||
to use it, just ensure the operand is still alive. See "Extended Asm" in
|
||
the GCC manual for more. */
|
||
|
||
#ifdef __GNUC__
|
||
#define scm_remember_upto_here_1(x) \
|
||
do { \
|
||
__asm__ __volatile__ ("" : : "g" (x)); \
|
||
} while (0)
|
||
#define scm_remember_upto_here_2(x, y) \
|
||
do { \
|
||
scm_remember_upto_here_1 (x); \
|
||
scm_remember_upto_here_1 (y); \
|
||
} while (0)
|
||
#endif
|
||
|
||
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_INTERNAL void scm_gc_after_nonlocal_exit (struct scm_thread *);
|
||
SCM_INTERNAL void scm_init_gc_protect_object (void);
|
||
SCM_INTERNAL void scm_init_gc (void);
|
||
|
||
#endif /* SCM_GC_H */
|