1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2013 Free Software
6 This file is part of GNU Emacs.
8 GNU Emacs 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 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs 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.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #define LISP_INLINE EXTERN_INLINE
26 #include <limits.h> /* For CHAR_BIT. */
28 #ifdef ENABLE_CHECKING
29 #include <signal.h> /* For SIGABRT. */
38 #include "intervals.h"
40 #include "character.h"
45 #include "blockinput.h"
46 #include "termhooks.h" /* For struct terminal. */
50 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
51 Doable only if GC_MARK_STACK. */
53 # undef GC_CHECK_MARKED_OBJECTS
56 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
57 memory. Can do this only if using gmalloc.c and if not checking
60 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
61 || defined GC_CHECK_MARKED_OBJECTS)
62 #undef GC_MALLOC_CHECK
73 #include "w32heap.h" /* for sbrk */
76 #ifdef DOUG_LEA_MALLOC
80 /* Specify maximum number of areas to mmap. It would be nice to use a
81 value that explicitly means "no limit". */
83 #define MMAP_MAX_AREAS 100000000
85 #endif /* not DOUG_LEA_MALLOC */
87 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
88 to a struct Lisp_String. */
90 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
91 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
92 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
94 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
95 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
96 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
98 /* Default value of gc_cons_threshold (see below). */
100 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
102 /* Global variables. */
103 struct emacs_globals globals
;
105 /* Number of bytes of consing done since the last gc. */
107 EMACS_INT consing_since_gc
;
109 /* Similar minimum, computed from Vgc_cons_percentage. */
111 EMACS_INT gc_relative_threshold
;
113 /* Minimum number of bytes of consing since GC before next GC,
114 when memory is full. */
116 EMACS_INT memory_full_cons_threshold
;
118 /* True during GC. */
122 /* True means abort if try to GC.
123 This is for code which is written on the assumption that
124 no GC will happen, so as to verify that assumption. */
128 /* Number of live and free conses etc. */
130 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
131 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
132 static EMACS_INT total_free_floats
, total_floats
;
134 /* Points to memory space allocated as "spare", to be freed if we run
135 out of memory. We keep one large block, four cons-blocks, and
136 two string blocks. */
138 static char *spare_memory
[7];
140 /* Amount of spare memory to keep in large reserve block, or to see
141 whether this much is available when malloc fails on a larger request. */
143 #define SPARE_MEMORY (1 << 14)
145 /* Initialize it to a nonzero value to force it into data space
146 (rather than bss space). That way unexec will remap it into text
147 space (pure), on some systems. We have not implemented the
148 remapping on more recent systems because this is less important
149 nowadays than in the days of small memories and timesharing. */
151 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
152 #define PUREBEG (char *) pure
154 /* Pointer to the pure area, and its size. */
156 static char *purebeg
;
157 static ptrdiff_t pure_size
;
159 /* Number of bytes of pure storage used before pure storage overflowed.
160 If this is non-zero, this implies that an overflow occurred. */
162 static ptrdiff_t pure_bytes_used_before_overflow
;
164 /* True if P points into pure space. */
166 #define PURE_POINTER_P(P) \
167 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
169 /* Index in pure at which next pure Lisp object will be allocated.. */
171 static ptrdiff_t pure_bytes_used_lisp
;
173 /* Number of bytes allocated for non-Lisp objects in pure storage. */
175 static ptrdiff_t pure_bytes_used_non_lisp
;
177 /* If nonzero, this is a warning delivered by malloc and not yet
180 const char *pending_malloc_warning
;
182 /* Maximum amount of C stack to save when a GC happens. */
184 #ifndef MAX_SAVE_STACK
185 #define MAX_SAVE_STACK 16000
188 /* Buffer in which we save a copy of the C stack at each GC. */
190 #if MAX_SAVE_STACK > 0
191 static char *stack_copy
;
192 static ptrdiff_t stack_copy_size
;
195 static Lisp_Object Qconses
;
196 static Lisp_Object Qsymbols
;
197 static Lisp_Object Qmiscs
;
198 static Lisp_Object Qstrings
;
199 static Lisp_Object Qvectors
;
200 static Lisp_Object Qfloats
;
201 static Lisp_Object Qintervals
;
202 static Lisp_Object Qbuffers
;
203 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
204 static Lisp_Object Qgc_cons_threshold
;
205 Lisp_Object Qautomatic_gc
;
206 Lisp_Object Qchar_table_extra_slots
;
208 /* Hook run after GC has finished. */
210 static Lisp_Object Qpost_gc_hook
;
212 static void mark_terminals (void);
213 static void gc_sweep (void);
214 static Lisp_Object
make_pure_vector (ptrdiff_t);
215 static void mark_buffer (struct buffer
*);
217 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
218 static void refill_memory_reserve (void);
220 static void compact_small_strings (void);
221 static void free_large_strings (void);
222 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
224 /* When scanning the C stack for live Lisp objects, Emacs keeps track of
225 what memory allocated via lisp_malloc and lisp_align_malloc is intended
226 for what purpose. This enumeration specifies the type of memory. */
237 /* Since all non-bool pseudovectors are small enough to be
238 allocated from vector blocks, this memory type denotes
239 large regular vectors and large bool pseudovectors. */
241 /* Special type to denote vector blocks. */
242 MEM_TYPE_VECTOR_BLOCK
,
243 /* Special type to denote reserved memory. */
247 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
249 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
250 #include <stdio.h> /* For fprintf. */
253 /* A unique object in pure space used to make some Lisp objects
254 on free lists recognizable in O(1). */
256 static Lisp_Object Vdead
;
257 #define DEADP(x) EQ (x, Vdead)
259 #ifdef GC_MALLOC_CHECK
261 enum mem_type allocated_mem_type
;
263 #endif /* GC_MALLOC_CHECK */
265 /* A node in the red-black tree describing allocated memory containing
266 Lisp data. Each such block is recorded with its start and end
267 address when it is allocated, and removed from the tree when it
270 A red-black tree is a balanced binary tree with the following
273 1. Every node is either red or black.
274 2. Every leaf is black.
275 3. If a node is red, then both of its children are black.
276 4. Every simple path from a node to a descendant leaf contains
277 the same number of black nodes.
278 5. The root is always black.
280 When nodes are inserted into the tree, or deleted from the tree,
281 the tree is "fixed" so that these properties are always true.
283 A red-black tree with N internal nodes has height at most 2
284 log(N+1). Searches, insertions and deletions are done in O(log N).
285 Please see a text book about data structures for a detailed
286 description of red-black trees. Any book worth its salt should
291 /* Children of this node. These pointers are never NULL. When there
292 is no child, the value is MEM_NIL, which points to a dummy node. */
293 struct mem_node
*left
, *right
;
295 /* The parent of this node. In the root node, this is NULL. */
296 struct mem_node
*parent
;
298 /* Start and end of allocated region. */
302 enum {MEM_BLACK
, MEM_RED
} color
;
308 /* Base address of stack. Set in main. */
310 Lisp_Object
*stack_base
;
312 /* Root of the tree describing allocated Lisp memory. */
314 static struct mem_node
*mem_root
;
316 /* Lowest and highest known address in the heap. */
318 static void *min_heap_address
, *max_heap_address
;
320 /* Sentinel node of the tree. */
322 static struct mem_node mem_z
;
323 #define MEM_NIL &mem_z
325 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
326 static void lisp_free (void *);
327 static void mark_stack (void);
328 static bool live_vector_p (struct mem_node
*, void *);
329 static bool live_buffer_p (struct mem_node
*, void *);
330 static bool live_string_p (struct mem_node
*, void *);
331 static bool live_cons_p (struct mem_node
*, void *);
332 static bool live_symbol_p (struct mem_node
*, void *);
333 static bool live_float_p (struct mem_node
*, void *);
334 static bool live_misc_p (struct mem_node
*, void *);
335 static void mark_maybe_object (Lisp_Object
);
336 static void mark_memory (void *, void *);
337 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
338 static void mem_init (void);
339 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
340 static void mem_insert_fixup (struct mem_node
*);
341 static void mem_rotate_left (struct mem_node
*);
342 static void mem_rotate_right (struct mem_node
*);
343 static void mem_delete (struct mem_node
*);
344 static void mem_delete_fixup (struct mem_node
*);
345 static struct mem_node
*mem_find (void *);
349 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
350 static void check_gcpros (void);
353 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
359 /* Recording what needs to be marked for gc. */
361 struct gcpro
*gcprolist
;
363 /* Addresses of staticpro'd variables. Initialize it to a nonzero
364 value; otherwise some compilers put it into BSS. */
366 #define NSTATICS 0x800
367 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
369 /* Index of next unused slot in staticvec. */
371 static int staticidx
;
373 static void *pure_alloc (size_t, int);
376 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
377 ALIGNMENT must be a power of 2. */
379 #define ALIGN(ptr, ALIGNMENT) \
380 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
381 & ~ ((ALIGNMENT) - 1)))
385 /************************************************************************
387 ************************************************************************/
389 /* Function malloc calls this if it finds we are near exhausting storage. */
392 malloc_warning (const char *str
)
394 pending_malloc_warning
= str
;
398 /* Display an already-pending malloc warning. */
401 display_malloc_warning (void)
403 call3 (intern ("display-warning"),
405 build_string (pending_malloc_warning
),
406 intern ("emergency"));
407 pending_malloc_warning
= 0;
410 /* Called if we can't allocate relocatable space for a buffer. */
413 buffer_memory_full (ptrdiff_t nbytes
)
415 /* If buffers use the relocating allocator, no need to free
416 spare_memory, because we may have plenty of malloc space left
417 that we could get, and if we don't, the malloc that fails will
418 itself cause spare_memory to be freed. If buffers don't use the
419 relocating allocator, treat this like any other failing
423 memory_full (nbytes
);
426 /* This used to call error, but if we've run out of memory, we could
427 get infinite recursion trying to build the string. */
428 xsignal (Qnil
, Vmemory_signal_data
);
431 /* A common multiple of the positive integers A and B. Ideally this
432 would be the least common multiple, but there's no way to do that
433 as a constant expression in C, so do the best that we can easily do. */
434 #define COMMON_MULTIPLE(a, b) \
435 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
437 #ifndef XMALLOC_OVERRUN_CHECK
438 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
441 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
444 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
445 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
446 block size in little-endian order. The trailer consists of
447 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
449 The header is used to detect whether this block has been allocated
450 through these functions, as some low-level libc functions may
451 bypass the malloc hooks. */
453 #define XMALLOC_OVERRUN_CHECK_SIZE 16
454 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
455 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
457 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
458 hold a size_t value and (2) the header size is a multiple of the
459 alignment that Emacs needs for C types and for USE_LSB_TAG. */
460 #define XMALLOC_BASE_ALIGNMENT \
461 alignof (union { long double d; intmax_t i; void *p; })
464 # define XMALLOC_HEADER_ALIGNMENT \
465 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
467 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
469 #define XMALLOC_OVERRUN_SIZE_SIZE \
470 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
471 + XMALLOC_HEADER_ALIGNMENT - 1) \
472 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
473 - XMALLOC_OVERRUN_CHECK_SIZE)
475 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
476 { '\x9a', '\x9b', '\xae', '\xaf',
477 '\xbf', '\xbe', '\xce', '\xcf',
478 '\xea', '\xeb', '\xec', '\xed',
479 '\xdf', '\xde', '\x9c', '\x9d' };
481 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
482 { '\xaa', '\xab', '\xac', '\xad',
483 '\xba', '\xbb', '\xbc', '\xbd',
484 '\xca', '\xcb', '\xcc', '\xcd',
485 '\xda', '\xdb', '\xdc', '\xdd' };
487 /* Insert and extract the block size in the header. */
490 xmalloc_put_size (unsigned char *ptr
, size_t size
)
493 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
495 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
501 xmalloc_get_size (unsigned char *ptr
)
505 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
506 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
515 /* Like malloc, but wraps allocated block with header and trailer. */
518 overrun_check_malloc (size_t size
)
520 register unsigned char *val
;
521 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
524 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
527 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
528 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
529 xmalloc_put_size (val
, size
);
530 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
531 XMALLOC_OVERRUN_CHECK_SIZE
);
537 /* Like realloc, but checks old block for overrun, and wraps new block
538 with header and trailer. */
541 overrun_check_realloc (void *block
, size_t size
)
543 register unsigned char *val
= (unsigned char *) block
;
544 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
548 && memcmp (xmalloc_overrun_check_header
,
549 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
550 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
552 size_t osize
= xmalloc_get_size (val
);
553 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
554 XMALLOC_OVERRUN_CHECK_SIZE
))
556 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
557 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
558 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
561 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
565 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
566 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
567 xmalloc_put_size (val
, size
);
568 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
569 XMALLOC_OVERRUN_CHECK_SIZE
);
574 /* Like free, but checks block for overrun. */
577 overrun_check_free (void *block
)
579 unsigned char *val
= (unsigned char *) block
;
582 && memcmp (xmalloc_overrun_check_header
,
583 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
584 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
586 size_t osize
= xmalloc_get_size (val
);
587 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
588 XMALLOC_OVERRUN_CHECK_SIZE
))
590 #ifdef XMALLOC_CLEAR_FREE_MEMORY
591 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
592 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
594 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
595 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
596 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
606 #define malloc overrun_check_malloc
607 #define realloc overrun_check_realloc
608 #define free overrun_check_free
611 /* If compiled with XMALLOC_BLOCK_INPUT_CHECK, define a symbol
612 BLOCK_INPUT_IN_MEMORY_ALLOCATORS that is visible to the debugger.
613 If that variable is set, block input while in one of Emacs's memory
614 allocation functions. There should be no need for this debugging
615 option, since signal handlers do not allocate memory, but Emacs
616 formerly allocated memory in signal handlers and this compile-time
617 option remains as a way to help debug the issue should it rear its
619 #ifdef XMALLOC_BLOCK_INPUT_CHECK
620 bool block_input_in_memory_allocators EXTERNALLY_VISIBLE
;
622 malloc_block_input (void)
624 if (block_input_in_memory_allocators
)
628 malloc_unblock_input (void)
630 if (block_input_in_memory_allocators
)
633 # define MALLOC_BLOCK_INPUT malloc_block_input ()
634 # define MALLOC_UNBLOCK_INPUT malloc_unblock_input ()
636 # define MALLOC_BLOCK_INPUT ((void) 0)
637 # define MALLOC_UNBLOCK_INPUT ((void) 0)
640 #define MALLOC_PROBE(size) \
642 if (profiler_memory_running) \
643 malloc_probe (size); \
647 /* Like malloc but check for no memory and block interrupt input.. */
650 xmalloc (size_t size
)
656 MALLOC_UNBLOCK_INPUT
;
664 /* Like the above, but zeroes out the memory just allocated. */
667 xzalloc (size_t size
)
673 MALLOC_UNBLOCK_INPUT
;
677 memset (val
, 0, size
);
682 /* Like realloc but check for no memory and block interrupt input.. */
685 xrealloc (void *block
, size_t size
)
690 /* We must call malloc explicitly when BLOCK is 0, since some
691 reallocs don't do this. */
695 val
= realloc (block
, size
);
696 MALLOC_UNBLOCK_INPUT
;
705 /* Like free but block interrupt input. */
714 MALLOC_UNBLOCK_INPUT
;
715 /* We don't call refill_memory_reserve here
716 because in practice the call in r_alloc_free seems to suffice. */
720 /* Other parts of Emacs pass large int values to allocator functions
721 expecting ptrdiff_t. This is portable in practice, but check it to
723 verify (INT_MAX
<= PTRDIFF_MAX
);
726 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
727 Signal an error on memory exhaustion, and block interrupt input. */
730 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
732 eassert (0 <= nitems
&& 0 < item_size
);
733 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
734 memory_full (SIZE_MAX
);
735 return xmalloc (nitems
* item_size
);
739 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
740 Signal an error on memory exhaustion, and block interrupt input. */
743 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
745 eassert (0 <= nitems
&& 0 < item_size
);
746 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
747 memory_full (SIZE_MAX
);
748 return xrealloc (pa
, nitems
* item_size
);
752 /* Grow PA, which points to an array of *NITEMS items, and return the
753 location of the reallocated array, updating *NITEMS to reflect its
754 new size. The new array will contain at least NITEMS_INCR_MIN more
755 items, but will not contain more than NITEMS_MAX items total.
756 ITEM_SIZE is the size of each item, in bytes.
758 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
759 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
762 If PA is null, then allocate a new array instead of reallocating
765 Block interrupt input as needed. If memory exhaustion occurs, set
766 *NITEMS to zero if PA is null, and signal an error (i.e., do not
769 Thus, to grow an array A without saving its old contents, do
770 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
771 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
772 and signals an error, and later this code is reexecuted and
773 attempts to free A. */
776 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
777 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
779 /* The approximate size to use for initial small allocation
780 requests. This is the largest "small" request for the GNU C
782 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
784 /* If the array is tiny, grow it to about (but no greater than)
785 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
786 ptrdiff_t n
= *nitems
;
787 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
788 ptrdiff_t half_again
= n
>> 1;
789 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
791 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
792 NITEMS_MAX, and what the C language can represent safely. */
793 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
794 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
795 ? nitems_max
: C_language_max
);
796 ptrdiff_t nitems_incr_max
= n_max
- n
;
797 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
799 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
802 if (nitems_incr_max
< incr
)
803 memory_full (SIZE_MAX
);
805 pa
= xrealloc (pa
, n
* item_size
);
811 /* Like strdup, but uses xmalloc. */
814 xstrdup (const char *s
)
816 size_t len
= strlen (s
) + 1;
817 char *p
= xmalloc (len
);
822 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
823 argument is a const pointer. */
826 xputenv (char const *string
)
828 if (putenv ((char *) string
) != 0)
832 /* Unwind for SAFE_ALLOCA */
835 safe_alloca_unwind (Lisp_Object arg
)
837 free_save_value (arg
);
841 /* Return a newly allocated memory block of SIZE bytes, remembering
842 to free it when unwinding. */
844 record_xmalloc (size_t size
)
846 void *p
= xmalloc (size
);
847 record_unwind_protect (safe_alloca_unwind
, make_save_value (p
, 0));
852 /* Like malloc but used for allocating Lisp data. NBYTES is the
853 number of bytes to allocate, TYPE describes the intended use of the
854 allocated memory block (for strings, for conses, ...). */
857 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
861 lisp_malloc (size_t nbytes
, enum mem_type type
)
867 #ifdef GC_MALLOC_CHECK
868 allocated_mem_type
= type
;
871 val
= malloc (nbytes
);
874 /* If the memory just allocated cannot be addressed thru a Lisp
875 object's pointer, and it needs to be,
876 that's equivalent to running out of memory. */
877 if (val
&& type
!= MEM_TYPE_NON_LISP
)
880 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
881 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
883 lisp_malloc_loser
= val
;
890 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
891 if (val
&& type
!= MEM_TYPE_NON_LISP
)
892 mem_insert (val
, (char *) val
+ nbytes
, type
);
895 MALLOC_UNBLOCK_INPUT
;
897 memory_full (nbytes
);
898 MALLOC_PROBE (nbytes
);
902 /* Free BLOCK. This must be called to free memory allocated with a
903 call to lisp_malloc. */
906 lisp_free (void *block
)
910 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
911 mem_delete (mem_find (block
));
913 MALLOC_UNBLOCK_INPUT
;
916 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
918 /* The entry point is lisp_align_malloc which returns blocks of at most
919 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
921 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
922 #define USE_POSIX_MEMALIGN 1
925 /* BLOCK_ALIGN has to be a power of 2. */
926 #define BLOCK_ALIGN (1 << 10)
928 /* Padding to leave at the end of a malloc'd block. This is to give
929 malloc a chance to minimize the amount of memory wasted to alignment.
930 It should be tuned to the particular malloc library used.
931 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
932 posix_memalign on the other hand would ideally prefer a value of 4
933 because otherwise, there's 1020 bytes wasted between each ablocks.
934 In Emacs, testing shows that those 1020 can most of the time be
935 efficiently used by malloc to place other objects, so a value of 0 can
936 still preferable unless you have a lot of aligned blocks and virtually
938 #define BLOCK_PADDING 0
939 #define BLOCK_BYTES \
940 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
942 /* Internal data structures and constants. */
944 #define ABLOCKS_SIZE 16
946 /* An aligned block of memory. */
951 char payload
[BLOCK_BYTES
];
952 struct ablock
*next_free
;
954 /* `abase' is the aligned base of the ablocks. */
955 /* It is overloaded to hold the virtual `busy' field that counts
956 the number of used ablock in the parent ablocks.
957 The first ablock has the `busy' field, the others have the `abase'
958 field. To tell the difference, we assume that pointers will have
959 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
960 is used to tell whether the real base of the parent ablocks is `abase'
961 (if not, the word before the first ablock holds a pointer to the
963 struct ablocks
*abase
;
964 /* The padding of all but the last ablock is unused. The padding of
965 the last ablock in an ablocks is not allocated. */
967 char padding
[BLOCK_PADDING
];
971 /* A bunch of consecutive aligned blocks. */
974 struct ablock blocks
[ABLOCKS_SIZE
];
977 /* Size of the block requested from malloc or posix_memalign. */
978 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
980 #define ABLOCK_ABASE(block) \
981 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
982 ? (struct ablocks *)(block) \
985 /* Virtual `busy' field. */
986 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
988 /* Pointer to the (not necessarily aligned) malloc block. */
989 #ifdef USE_POSIX_MEMALIGN
990 #define ABLOCKS_BASE(abase) (abase)
992 #define ABLOCKS_BASE(abase) \
993 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
996 /* The list of free ablock. */
997 static struct ablock
*free_ablock
;
999 /* Allocate an aligned block of nbytes.
1000 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1001 smaller or equal to BLOCK_BYTES. */
1003 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1006 struct ablocks
*abase
;
1008 eassert (nbytes
<= BLOCK_BYTES
);
1012 #ifdef GC_MALLOC_CHECK
1013 allocated_mem_type
= type
;
1019 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1021 #ifdef DOUG_LEA_MALLOC
1022 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1023 because mapped region contents are not preserved in
1025 mallopt (M_MMAP_MAX
, 0);
1028 #ifdef USE_POSIX_MEMALIGN
1030 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1036 base
= malloc (ABLOCKS_BYTES
);
1037 abase
= ALIGN (base
, BLOCK_ALIGN
);
1042 MALLOC_UNBLOCK_INPUT
;
1043 memory_full (ABLOCKS_BYTES
);
1046 aligned
= (base
== abase
);
1048 ((void**)abase
)[-1] = base
;
1050 #ifdef DOUG_LEA_MALLOC
1051 /* Back to a reasonable maximum of mmap'ed areas. */
1052 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1056 /* If the memory just allocated cannot be addressed thru a Lisp
1057 object's pointer, and it needs to be, that's equivalent to
1058 running out of memory. */
1059 if (type
!= MEM_TYPE_NON_LISP
)
1062 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1063 XSETCONS (tem
, end
);
1064 if ((char *) XCONS (tem
) != end
)
1066 lisp_malloc_loser
= base
;
1068 MALLOC_UNBLOCK_INPUT
;
1069 memory_full (SIZE_MAX
);
1074 /* Initialize the blocks and put them on the free list.
1075 If `base' was not properly aligned, we can't use the last block. */
1076 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1078 abase
->blocks
[i
].abase
= abase
;
1079 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1080 free_ablock
= &abase
->blocks
[i
];
1082 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1084 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1085 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1086 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1087 eassert (ABLOCKS_BASE (abase
) == base
);
1088 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1091 abase
= ABLOCK_ABASE (free_ablock
);
1092 ABLOCKS_BUSY (abase
) =
1093 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1095 free_ablock
= free_ablock
->x
.next_free
;
1097 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1098 if (type
!= MEM_TYPE_NON_LISP
)
1099 mem_insert (val
, (char *) val
+ nbytes
, type
);
1102 MALLOC_UNBLOCK_INPUT
;
1104 MALLOC_PROBE (nbytes
);
1106 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1111 lisp_align_free (void *block
)
1113 struct ablock
*ablock
= block
;
1114 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1117 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1118 mem_delete (mem_find (block
));
1120 /* Put on free list. */
1121 ablock
->x
.next_free
= free_ablock
;
1122 free_ablock
= ablock
;
1123 /* Update busy count. */
1124 ABLOCKS_BUSY (abase
)
1125 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1127 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1128 { /* All the blocks are free. */
1129 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1130 struct ablock
**tem
= &free_ablock
;
1131 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1135 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1138 *tem
= (*tem
)->x
.next_free
;
1141 tem
= &(*tem
)->x
.next_free
;
1143 eassert ((aligned
& 1) == aligned
);
1144 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1145 #ifdef USE_POSIX_MEMALIGN
1146 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1148 free (ABLOCKS_BASE (abase
));
1150 MALLOC_UNBLOCK_INPUT
;
1154 /***********************************************************************
1156 ***********************************************************************/
1158 /* Number of intervals allocated in an interval_block structure.
1159 The 1020 is 1024 minus malloc overhead. */
1161 #define INTERVAL_BLOCK_SIZE \
1162 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1164 /* Intervals are allocated in chunks in form of an interval_block
1167 struct interval_block
1169 /* Place `intervals' first, to preserve alignment. */
1170 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1171 struct interval_block
*next
;
1174 /* Current interval block. Its `next' pointer points to older
1177 static struct interval_block
*interval_block
;
1179 /* Index in interval_block above of the next unused interval
1182 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1184 /* Number of free and live intervals. */
1186 static EMACS_INT total_free_intervals
, total_intervals
;
1188 /* List of free intervals. */
1190 static INTERVAL interval_free_list
;
1192 /* Return a new interval. */
1195 make_interval (void)
1201 if (interval_free_list
)
1203 val
= interval_free_list
;
1204 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1208 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1210 struct interval_block
*newi
1211 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1213 newi
->next
= interval_block
;
1214 interval_block
= newi
;
1215 interval_block_index
= 0;
1216 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1218 val
= &interval_block
->intervals
[interval_block_index
++];
1221 MALLOC_UNBLOCK_INPUT
;
1223 consing_since_gc
+= sizeof (struct interval
);
1225 total_free_intervals
--;
1226 RESET_INTERVAL (val
);
1232 /* Mark Lisp objects in interval I. */
1235 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1237 /* Intervals should never be shared. So, if extra internal checking is
1238 enabled, GC aborts if it seems to have visited an interval twice. */
1239 eassert (!i
->gcmarkbit
);
1241 mark_object (i
->plist
);
1244 /* Mark the interval tree rooted in I. */
1246 #define MARK_INTERVAL_TREE(i) \
1248 if (i && !i->gcmarkbit) \
1249 traverse_intervals_noorder (i, mark_interval, Qnil); \
1252 /***********************************************************************
1254 ***********************************************************************/
1256 /* Lisp_Strings are allocated in string_block structures. When a new
1257 string_block is allocated, all the Lisp_Strings it contains are
1258 added to a free-list string_free_list. When a new Lisp_String is
1259 needed, it is taken from that list. During the sweep phase of GC,
1260 string_blocks that are entirely free are freed, except two which
1263 String data is allocated from sblock structures. Strings larger
1264 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1265 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1267 Sblocks consist internally of sdata structures, one for each
1268 Lisp_String. The sdata structure points to the Lisp_String it
1269 belongs to. The Lisp_String points back to the `u.data' member of
1270 its sdata structure.
1272 When a Lisp_String is freed during GC, it is put back on
1273 string_free_list, and its `data' member and its sdata's `string'
1274 pointer is set to null. The size of the string is recorded in the
1275 `u.nbytes' member of the sdata. So, sdata structures that are no
1276 longer used, can be easily recognized, and it's easy to compact the
1277 sblocks of small strings which we do in compact_small_strings. */
1279 /* Size in bytes of an sblock structure used for small strings. This
1280 is 8192 minus malloc overhead. */
1282 #define SBLOCK_SIZE 8188
1284 /* Strings larger than this are considered large strings. String data
1285 for large strings is allocated from individual sblocks. */
1287 #define LARGE_STRING_BYTES 1024
1289 /* Structure describing string memory sub-allocated from an sblock.
1290 This is where the contents of Lisp strings are stored. */
1294 /* Back-pointer to the string this sdata belongs to. If null, this
1295 structure is free, and the NBYTES member of the union below
1296 contains the string's byte size (the same value that STRING_BYTES
1297 would return if STRING were non-null). If non-null, STRING_BYTES
1298 (STRING) is the size of the data, and DATA contains the string's
1300 struct Lisp_String
*string
;
1302 #ifdef GC_CHECK_STRING_BYTES
1305 unsigned char data
[1];
1307 #define SDATA_NBYTES(S) (S)->nbytes
1308 #define SDATA_DATA(S) (S)->data
1309 #define SDATA_SELECTOR(member) member
1311 #else /* not GC_CHECK_STRING_BYTES */
1315 /* When STRING is non-null. */
1316 unsigned char data
[1];
1318 /* When STRING is null. */
1322 #define SDATA_NBYTES(S) (S)->u.nbytes
1323 #define SDATA_DATA(S) (S)->u.data
1324 #define SDATA_SELECTOR(member) u.member
1326 #endif /* not GC_CHECK_STRING_BYTES */
1328 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1332 /* Structure describing a block of memory which is sub-allocated to
1333 obtain string data memory for strings. Blocks for small strings
1334 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1335 as large as needed. */
1340 struct sblock
*next
;
1342 /* Pointer to the next free sdata block. This points past the end
1343 of the sblock if there isn't any space left in this block. */
1344 struct sdata
*next_free
;
1346 /* Start of data. */
1347 struct sdata first_data
;
1350 /* Number of Lisp strings in a string_block structure. The 1020 is
1351 1024 minus malloc overhead. */
1353 #define STRING_BLOCK_SIZE \
1354 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1356 /* Structure describing a block from which Lisp_String structures
1361 /* Place `strings' first, to preserve alignment. */
1362 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1363 struct string_block
*next
;
1366 /* Head and tail of the list of sblock structures holding Lisp string
1367 data. We always allocate from current_sblock. The NEXT pointers
1368 in the sblock structures go from oldest_sblock to current_sblock. */
1370 static struct sblock
*oldest_sblock
, *current_sblock
;
1372 /* List of sblocks for large strings. */
1374 static struct sblock
*large_sblocks
;
1376 /* List of string_block structures. */
1378 static struct string_block
*string_blocks
;
1380 /* Free-list of Lisp_Strings. */
1382 static struct Lisp_String
*string_free_list
;
1384 /* Number of live and free Lisp_Strings. */
1386 static EMACS_INT total_strings
, total_free_strings
;
1388 /* Number of bytes used by live strings. */
1390 static EMACS_INT total_string_bytes
;
1392 /* Given a pointer to a Lisp_String S which is on the free-list
1393 string_free_list, return a pointer to its successor in the
1396 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1398 /* Return a pointer to the sdata structure belonging to Lisp string S.
1399 S must be live, i.e. S->data must not be null. S->data is actually
1400 a pointer to the `u.data' member of its sdata structure; the
1401 structure starts at a constant offset in front of that. */
1403 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1406 #ifdef GC_CHECK_STRING_OVERRUN
1408 /* We check for overrun in string data blocks by appending a small
1409 "cookie" after each allocated string data block, and check for the
1410 presence of this cookie during GC. */
1412 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1413 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1414 { '\xde', '\xad', '\xbe', '\xef' };
1417 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1420 /* Value is the size of an sdata structure large enough to hold NBYTES
1421 bytes of string data. The value returned includes a terminating
1422 NUL byte, the size of the sdata structure, and padding. */
1424 #ifdef GC_CHECK_STRING_BYTES
1426 #define SDATA_SIZE(NBYTES) \
1427 ((SDATA_DATA_OFFSET \
1429 + sizeof (ptrdiff_t) - 1) \
1430 & ~(sizeof (ptrdiff_t) - 1))
1432 #else /* not GC_CHECK_STRING_BYTES */
1434 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1435 less than the size of that member. The 'max' is not needed when
1436 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1437 alignment code reserves enough space. */
1439 #define SDATA_SIZE(NBYTES) \
1440 ((SDATA_DATA_OFFSET \
1441 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1443 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1445 + sizeof (ptrdiff_t) - 1) \
1446 & ~(sizeof (ptrdiff_t) - 1))
1448 #endif /* not GC_CHECK_STRING_BYTES */
1450 /* Extra bytes to allocate for each string. */
1452 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1454 /* Exact bound on the number of bytes in a string, not counting the
1455 terminating null. A string cannot contain more bytes than
1456 STRING_BYTES_BOUND, nor can it be so long that the size_t
1457 arithmetic in allocate_string_data would overflow while it is
1458 calculating a value to be passed to malloc. */
1459 static ptrdiff_t const STRING_BYTES_MAX
=
1460 min (STRING_BYTES_BOUND
,
1461 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1463 - offsetof (struct sblock
, first_data
)
1464 - SDATA_DATA_OFFSET
)
1465 & ~(sizeof (EMACS_INT
) - 1)));
1467 /* Initialize string allocation. Called from init_alloc_once. */
1472 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1473 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1477 #ifdef GC_CHECK_STRING_BYTES
1479 static int check_string_bytes_count
;
1481 /* Like STRING_BYTES, but with debugging check. Can be
1482 called during GC, so pay attention to the mark bit. */
1485 string_bytes (struct Lisp_String
*s
)
1488 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1490 if (!PURE_POINTER_P (s
)
1492 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1497 /* Check validity of Lisp strings' string_bytes member in B. */
1500 check_sblock (struct sblock
*b
)
1502 struct sdata
*from
, *end
, *from_end
;
1506 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1508 /* Compute the next FROM here because copying below may
1509 overwrite data we need to compute it. */
1512 /* Check that the string size recorded in the string is the
1513 same as the one recorded in the sdata structure. */
1514 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1515 : SDATA_NBYTES (from
));
1516 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1521 /* Check validity of Lisp strings' string_bytes member. ALL_P
1522 means check all strings, otherwise check only most
1523 recently allocated strings. Used for hunting a bug. */
1526 check_string_bytes (bool all_p
)
1532 for (b
= large_sblocks
; b
; b
= b
->next
)
1534 struct Lisp_String
*s
= b
->first_data
.string
;
1539 for (b
= oldest_sblock
; b
; b
= b
->next
)
1542 else if (current_sblock
)
1543 check_sblock (current_sblock
);
1546 #else /* not GC_CHECK_STRING_BYTES */
1548 #define check_string_bytes(all) ((void) 0)
1550 #endif /* GC_CHECK_STRING_BYTES */
1552 #ifdef GC_CHECK_STRING_FREE_LIST
1554 /* Walk through the string free list looking for bogus next pointers.
1555 This may catch buffer overrun from a previous string. */
1558 check_string_free_list (void)
1560 struct Lisp_String
*s
;
1562 /* Pop a Lisp_String off the free-list. */
1563 s
= string_free_list
;
1566 if ((uintptr_t) s
< 1024)
1568 s
= NEXT_FREE_LISP_STRING (s
);
1572 #define check_string_free_list()
1575 /* Return a new Lisp_String. */
1577 static struct Lisp_String
*
1578 allocate_string (void)
1580 struct Lisp_String
*s
;
1584 /* If the free-list is empty, allocate a new string_block, and
1585 add all the Lisp_Strings in it to the free-list. */
1586 if (string_free_list
== NULL
)
1588 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1591 b
->next
= string_blocks
;
1594 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1597 /* Every string on a free list should have NULL data pointer. */
1599 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1600 string_free_list
= s
;
1603 total_free_strings
+= STRING_BLOCK_SIZE
;
1606 check_string_free_list ();
1608 /* Pop a Lisp_String off the free-list. */
1609 s
= string_free_list
;
1610 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1612 MALLOC_UNBLOCK_INPUT
;
1614 --total_free_strings
;
1617 consing_since_gc
+= sizeof *s
;
1619 #ifdef GC_CHECK_STRING_BYTES
1620 if (!noninteractive
)
1622 if (++check_string_bytes_count
== 200)
1624 check_string_bytes_count
= 0;
1625 check_string_bytes (1);
1628 check_string_bytes (0);
1630 #endif /* GC_CHECK_STRING_BYTES */
1636 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1637 plus a NUL byte at the end. Allocate an sdata structure for S, and
1638 set S->data to its `u.data' member. Store a NUL byte at the end of
1639 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1640 S->data if it was initially non-null. */
1643 allocate_string_data (struct Lisp_String
*s
,
1644 EMACS_INT nchars
, EMACS_INT nbytes
)
1646 struct sdata
*data
, *old_data
;
1648 ptrdiff_t needed
, old_nbytes
;
1650 if (STRING_BYTES_MAX
< nbytes
)
1653 /* Determine the number of bytes needed to store NBYTES bytes
1655 needed
= SDATA_SIZE (nbytes
);
1658 old_data
= SDATA_OF_STRING (s
);
1659 old_nbytes
= STRING_BYTES (s
);
1666 if (nbytes
> LARGE_STRING_BYTES
)
1668 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
1670 #ifdef DOUG_LEA_MALLOC
1671 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1672 because mapped region contents are not preserved in
1675 In case you think of allowing it in a dumped Emacs at the
1676 cost of not being able to re-dump, there's another reason:
1677 mmap'ed data typically have an address towards the top of the
1678 address space, which won't fit into an EMACS_INT (at least on
1679 32-bit systems with the current tagging scheme). --fx */
1680 mallopt (M_MMAP_MAX
, 0);
1683 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1685 #ifdef DOUG_LEA_MALLOC
1686 /* Back to a reasonable maximum of mmap'ed areas. */
1687 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1690 b
->next_free
= &b
->first_data
;
1691 b
->first_data
.string
= NULL
;
1692 b
->next
= large_sblocks
;
1695 else if (current_sblock
== NULL
1696 || (((char *) current_sblock
+ SBLOCK_SIZE
1697 - (char *) current_sblock
->next_free
)
1698 < (needed
+ GC_STRING_EXTRA
)))
1700 /* Not enough room in the current sblock. */
1701 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1702 b
->next_free
= &b
->first_data
;
1703 b
->first_data
.string
= NULL
;
1707 current_sblock
->next
= b
;
1715 data
= b
->next_free
;
1716 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1718 MALLOC_UNBLOCK_INPUT
;
1721 s
->data
= SDATA_DATA (data
);
1722 #ifdef GC_CHECK_STRING_BYTES
1723 SDATA_NBYTES (data
) = nbytes
;
1726 s
->size_byte
= nbytes
;
1727 s
->data
[nbytes
] = '\0';
1728 #ifdef GC_CHECK_STRING_OVERRUN
1729 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1730 GC_STRING_OVERRUN_COOKIE_SIZE
);
1733 /* Note that Faset may call to this function when S has already data
1734 assigned. In this case, mark data as free by setting it's string
1735 back-pointer to null, and record the size of the data in it. */
1738 SDATA_NBYTES (old_data
) = old_nbytes
;
1739 old_data
->string
= NULL
;
1742 consing_since_gc
+= needed
;
1746 /* Sweep and compact strings. */
1749 sweep_strings (void)
1751 struct string_block
*b
, *next
;
1752 struct string_block
*live_blocks
= NULL
;
1754 string_free_list
= NULL
;
1755 total_strings
= total_free_strings
= 0;
1756 total_string_bytes
= 0;
1758 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1759 for (b
= string_blocks
; b
; b
= next
)
1762 struct Lisp_String
*free_list_before
= string_free_list
;
1766 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1768 struct Lisp_String
*s
= b
->strings
+ i
;
1772 /* String was not on free-list before. */
1773 if (STRING_MARKED_P (s
))
1775 /* String is live; unmark it and its intervals. */
1778 /* Do not use string_(set|get)_intervals here. */
1779 s
->intervals
= balance_intervals (s
->intervals
);
1782 total_string_bytes
+= STRING_BYTES (s
);
1786 /* String is dead. Put it on the free-list. */
1787 struct sdata
*data
= SDATA_OF_STRING (s
);
1789 /* Save the size of S in its sdata so that we know
1790 how large that is. Reset the sdata's string
1791 back-pointer so that we know it's free. */
1792 #ifdef GC_CHECK_STRING_BYTES
1793 if (string_bytes (s
) != SDATA_NBYTES (data
))
1796 data
->u
.nbytes
= STRING_BYTES (s
);
1798 data
->string
= NULL
;
1800 /* Reset the strings's `data' member so that we
1804 /* Put the string on the free-list. */
1805 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1806 string_free_list
= s
;
1812 /* S was on the free-list before. Put it there again. */
1813 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1814 string_free_list
= s
;
1819 /* Free blocks that contain free Lisp_Strings only, except
1820 the first two of them. */
1821 if (nfree
== STRING_BLOCK_SIZE
1822 && total_free_strings
> STRING_BLOCK_SIZE
)
1825 string_free_list
= free_list_before
;
1829 total_free_strings
+= nfree
;
1830 b
->next
= live_blocks
;
1835 check_string_free_list ();
1837 string_blocks
= live_blocks
;
1838 free_large_strings ();
1839 compact_small_strings ();
1841 check_string_free_list ();
1845 /* Free dead large strings. */
1848 free_large_strings (void)
1850 struct sblock
*b
, *next
;
1851 struct sblock
*live_blocks
= NULL
;
1853 for (b
= large_sblocks
; b
; b
= next
)
1857 if (b
->first_data
.string
== NULL
)
1861 b
->next
= live_blocks
;
1866 large_sblocks
= live_blocks
;
1870 /* Compact data of small strings. Free sblocks that don't contain
1871 data of live strings after compaction. */
1874 compact_small_strings (void)
1876 struct sblock
*b
, *tb
, *next
;
1877 struct sdata
*from
, *to
, *end
, *tb_end
;
1878 struct sdata
*to_end
, *from_end
;
1880 /* TB is the sblock we copy to, TO is the sdata within TB we copy
1881 to, and TB_END is the end of TB. */
1883 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1884 to
= &tb
->first_data
;
1886 /* Step through the blocks from the oldest to the youngest. We
1887 expect that old blocks will stabilize over time, so that less
1888 copying will happen this way. */
1889 for (b
= oldest_sblock
; b
; b
= b
->next
)
1892 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
1894 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1896 /* Compute the next FROM here because copying below may
1897 overwrite data we need to compute it. */
1899 struct Lisp_String
*s
= from
->string
;
1901 #ifdef GC_CHECK_STRING_BYTES
1902 /* Check that the string size recorded in the string is the
1903 same as the one recorded in the sdata structure. */
1904 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
1906 #endif /* GC_CHECK_STRING_BYTES */
1908 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
1909 eassert (nbytes
<= LARGE_STRING_BYTES
);
1911 nbytes
= SDATA_SIZE (nbytes
);
1912 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1914 #ifdef GC_CHECK_STRING_OVERRUN
1915 if (memcmp (string_overrun_cookie
,
1916 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
1917 GC_STRING_OVERRUN_COOKIE_SIZE
))
1921 /* Non-NULL S means it's alive. Copy its data. */
1924 /* If TB is full, proceed with the next sblock. */
1925 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
1926 if (to_end
> tb_end
)
1930 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1931 to
= &tb
->first_data
;
1932 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
1935 /* Copy, and update the string's `data' pointer. */
1938 eassert (tb
!= b
|| to
< from
);
1939 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
1940 to
->string
->data
= SDATA_DATA (to
);
1943 /* Advance past the sdata we copied to. */
1949 /* The rest of the sblocks following TB don't contain live data, so
1950 we can free them. */
1951 for (b
= tb
->next
; b
; b
= next
)
1959 current_sblock
= tb
;
1963 string_overflow (void)
1965 error ("Maximum string size exceeded");
1968 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
1969 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
1970 LENGTH must be an integer.
1971 INIT must be an integer that represents a character. */)
1972 (Lisp_Object length
, Lisp_Object init
)
1974 register Lisp_Object val
;
1975 register unsigned char *p
, *end
;
1979 CHECK_NATNUM (length
);
1980 CHECK_CHARACTER (init
);
1982 c
= XFASTINT (init
);
1983 if (ASCII_CHAR_P (c
))
1985 nbytes
= XINT (length
);
1986 val
= make_uninit_string (nbytes
);
1988 end
= p
+ SCHARS (val
);
1994 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
1995 int len
= CHAR_STRING (c
, str
);
1996 EMACS_INT string_len
= XINT (length
);
1998 if (string_len
> STRING_BYTES_MAX
/ len
)
2000 nbytes
= len
* string_len
;
2001 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2006 memcpy (p
, str
, len
);
2016 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2017 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2018 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2019 (Lisp_Object length
, Lisp_Object init
)
2021 register Lisp_Object val
;
2022 struct Lisp_Bool_Vector
*p
;
2023 ptrdiff_t length_in_chars
;
2024 EMACS_INT length_in_elts
;
2026 int extra_bool_elts
= ((bool_header_size
- header_size
+ word_size
- 1)
2029 CHECK_NATNUM (length
);
2031 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2033 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2035 val
= Fmake_vector (make_number (length_in_elts
+ extra_bool_elts
), Qnil
);
2037 /* No Lisp_Object to trace in there. */
2038 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2040 p
= XBOOL_VECTOR (val
);
2041 p
->size
= XFASTINT (length
);
2043 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2044 / BOOL_VECTOR_BITS_PER_CHAR
);
2045 if (length_in_chars
)
2047 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2049 /* Clear any extraneous bits in the last byte. */
2050 p
->data
[length_in_chars
- 1]
2051 &= (1 << ((XFASTINT (length
) - 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1)) - 1;
2058 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2059 of characters from the contents. This string may be unibyte or
2060 multibyte, depending on the contents. */
2063 make_string (const char *contents
, ptrdiff_t nbytes
)
2065 register Lisp_Object val
;
2066 ptrdiff_t nchars
, multibyte_nbytes
;
2068 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2069 &nchars
, &multibyte_nbytes
);
2070 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2071 /* CONTENTS contains no multibyte sequences or contains an invalid
2072 multibyte sequence. We must make unibyte string. */
2073 val
= make_unibyte_string (contents
, nbytes
);
2075 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2080 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2083 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2085 register Lisp_Object val
;
2086 val
= make_uninit_string (length
);
2087 memcpy (SDATA (val
), contents
, length
);
2092 /* Make a multibyte string from NCHARS characters occupying NBYTES
2093 bytes at CONTENTS. */
2096 make_multibyte_string (const char *contents
,
2097 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2099 register Lisp_Object val
;
2100 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2101 memcpy (SDATA (val
), contents
, nbytes
);
2106 /* Make a string from NCHARS characters occupying NBYTES bytes at
2107 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2110 make_string_from_bytes (const char *contents
,
2111 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2113 register Lisp_Object val
;
2114 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2115 memcpy (SDATA (val
), contents
, nbytes
);
2116 if (SBYTES (val
) == SCHARS (val
))
2117 STRING_SET_UNIBYTE (val
);
2122 /* Make a string from NCHARS characters occupying NBYTES bytes at
2123 CONTENTS. The argument MULTIBYTE controls whether to label the
2124 string as multibyte. If NCHARS is negative, it counts the number of
2125 characters by itself. */
2128 make_specified_string (const char *contents
,
2129 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2136 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2141 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2142 memcpy (SDATA (val
), contents
, nbytes
);
2144 STRING_SET_UNIBYTE (val
);
2149 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2150 occupying LENGTH bytes. */
2153 make_uninit_string (EMACS_INT length
)
2158 return empty_unibyte_string
;
2159 val
= make_uninit_multibyte_string (length
, length
);
2160 STRING_SET_UNIBYTE (val
);
2165 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2166 which occupy NBYTES bytes. */
2169 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2172 struct Lisp_String
*s
;
2177 return empty_multibyte_string
;
2179 s
= allocate_string ();
2180 s
->intervals
= NULL
;
2181 allocate_string_data (s
, nchars
, nbytes
);
2182 XSETSTRING (string
, s
);
2183 string_chars_consed
+= nbytes
;
2187 /* Print arguments to BUF according to a FORMAT, then return
2188 a Lisp_String initialized with the data from BUF. */
2191 make_formatted_string (char *buf
, const char *format
, ...)
2196 va_start (ap
, format
);
2197 length
= vsprintf (buf
, format
, ap
);
2199 return make_string (buf
, length
);
2203 /***********************************************************************
2205 ***********************************************************************/
2207 /* We store float cells inside of float_blocks, allocating a new
2208 float_block with malloc whenever necessary. Float cells reclaimed
2209 by GC are put on a free list to be reallocated before allocating
2210 any new float cells from the latest float_block. */
2212 #define FLOAT_BLOCK_SIZE \
2213 (((BLOCK_BYTES - sizeof (struct float_block *) \
2214 /* The compiler might add padding at the end. */ \
2215 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2216 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2218 #define GETMARKBIT(block,n) \
2219 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2220 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2223 #define SETMARKBIT(block,n) \
2224 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2225 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2227 #define UNSETMARKBIT(block,n) \
2228 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2229 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2231 #define FLOAT_BLOCK(fptr) \
2232 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2234 #define FLOAT_INDEX(fptr) \
2235 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2239 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2240 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2241 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2242 struct float_block
*next
;
2245 #define FLOAT_MARKED_P(fptr) \
2246 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2248 #define FLOAT_MARK(fptr) \
2249 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2251 #define FLOAT_UNMARK(fptr) \
2252 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2254 /* Current float_block. */
2256 static struct float_block
*float_block
;
2258 /* Index of first unused Lisp_Float in the current float_block. */
2260 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2262 /* Free-list of Lisp_Floats. */
2264 static struct Lisp_Float
*float_free_list
;
2266 /* Return a new float object with value FLOAT_VALUE. */
2269 make_float (double float_value
)
2271 register Lisp_Object val
;
2275 if (float_free_list
)
2277 /* We use the data field for chaining the free list
2278 so that we won't use the same field that has the mark bit. */
2279 XSETFLOAT (val
, float_free_list
);
2280 float_free_list
= float_free_list
->u
.chain
;
2284 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2286 struct float_block
*new
2287 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2288 new->next
= float_block
;
2289 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2291 float_block_index
= 0;
2292 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2294 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2295 float_block_index
++;
2298 MALLOC_UNBLOCK_INPUT
;
2300 XFLOAT_INIT (val
, float_value
);
2301 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2302 consing_since_gc
+= sizeof (struct Lisp_Float
);
2304 total_free_floats
--;
2310 /***********************************************************************
2312 ***********************************************************************/
2314 /* We store cons cells inside of cons_blocks, allocating a new
2315 cons_block with malloc whenever necessary. Cons cells reclaimed by
2316 GC are put on a free list to be reallocated before allocating
2317 any new cons cells from the latest cons_block. */
2319 #define CONS_BLOCK_SIZE \
2320 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2321 /* The compiler might add padding at the end. */ \
2322 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2323 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2325 #define CONS_BLOCK(fptr) \
2326 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2328 #define CONS_INDEX(fptr) \
2329 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2333 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2334 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2335 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2336 struct cons_block
*next
;
2339 #define CONS_MARKED_P(fptr) \
2340 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2342 #define CONS_MARK(fptr) \
2343 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2345 #define CONS_UNMARK(fptr) \
2346 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2348 /* Current cons_block. */
2350 static struct cons_block
*cons_block
;
2352 /* Index of first unused Lisp_Cons in the current block. */
2354 static int cons_block_index
= CONS_BLOCK_SIZE
;
2356 /* Free-list of Lisp_Cons structures. */
2358 static struct Lisp_Cons
*cons_free_list
;
2360 /* Explicitly free a cons cell by putting it on the free-list. */
2363 free_cons (struct Lisp_Cons
*ptr
)
2365 ptr
->u
.chain
= cons_free_list
;
2369 cons_free_list
= ptr
;
2370 consing_since_gc
-= sizeof *ptr
;
2371 total_free_conses
++;
2374 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2375 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2376 (Lisp_Object car
, Lisp_Object cdr
)
2378 register Lisp_Object val
;
2384 /* We use the cdr for chaining the free list
2385 so that we won't use the same field that has the mark bit. */
2386 XSETCONS (val
, cons_free_list
);
2387 cons_free_list
= cons_free_list
->u
.chain
;
2391 if (cons_block_index
== CONS_BLOCK_SIZE
)
2393 struct cons_block
*new
2394 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2395 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2396 new->next
= cons_block
;
2398 cons_block_index
= 0;
2399 total_free_conses
+= CONS_BLOCK_SIZE
;
2401 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2405 MALLOC_UNBLOCK_INPUT
;
2409 eassert (!CONS_MARKED_P (XCONS (val
)));
2410 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2411 total_free_conses
--;
2412 cons_cells_consed
++;
2416 #ifdef GC_CHECK_CONS_LIST
2417 /* Get an error now if there's any junk in the cons free list. */
2419 check_cons_list (void)
2421 struct Lisp_Cons
*tail
= cons_free_list
;
2424 tail
= tail
->u
.chain
;
2428 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2431 list1 (Lisp_Object arg1
)
2433 return Fcons (arg1
, Qnil
);
2437 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2439 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2444 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2446 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2451 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2453 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2458 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2460 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2461 Fcons (arg5
, Qnil
)))));
2464 /* Make a list of COUNT Lisp_Objects, where ARG is the
2465 first one. Allocate conses from pure space if TYPE
2466 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2469 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2473 Lisp_Object val
, *objp
;
2475 /* Change to SAFE_ALLOCA if you hit this eassert. */
2476 eassert (count
<= MAX_ALLOCA
/ word_size
);
2478 objp
= alloca (count
* word_size
);
2481 for (i
= 1; i
< count
; i
++)
2482 objp
[i
] = va_arg (ap
, Lisp_Object
);
2485 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2487 if (type
== CONSTYPE_PURE
)
2488 val
= pure_cons (objp
[i
], val
);
2489 else if (type
== CONSTYPE_HEAP
)
2490 val
= Fcons (objp
[i
], val
);
2497 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2498 doc
: /* Return a newly created list with specified arguments as elements.
2499 Any number of arguments, even zero arguments, are allowed.
2500 usage: (list &rest OBJECTS) */)
2501 (ptrdiff_t nargs
, Lisp_Object
*args
)
2503 register Lisp_Object val
;
2509 val
= Fcons (args
[nargs
], val
);
2515 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2516 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2517 (register Lisp_Object length
, Lisp_Object init
)
2519 register Lisp_Object val
;
2520 register EMACS_INT size
;
2522 CHECK_NATNUM (length
);
2523 size
= XFASTINT (length
);
2528 val
= Fcons (init
, val
);
2533 val
= Fcons (init
, val
);
2538 val
= Fcons (init
, val
);
2543 val
= Fcons (init
, val
);
2548 val
= Fcons (init
, val
);
2563 /***********************************************************************
2565 ***********************************************************************/
2567 /* This value is balanced well enough to avoid too much internal overhead
2568 for the most common cases; it's not required to be a power of two, but
2569 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2571 #define VECTOR_BLOCK_SIZE 4096
2573 /* Align allocation request sizes to be a multiple of ROUNDUP_SIZE. */
2576 roundup_size
= COMMON_MULTIPLE (word_size
, USE_LSB_TAG
? GCALIGNMENT
: 1)
2579 /* ROUNDUP_SIZE must be a power of 2. */
2580 verify ((roundup_size
& (roundup_size
- 1)) == 0);
2582 /* Verify assumptions described above. */
2583 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2584 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2586 /* Round up X to nearest mult-of-ROUNDUP_SIZE. */
2588 #define vroundup(x) (((x) + (roundup_size - 1)) & ~(roundup_size - 1))
2590 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2592 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup (sizeof (void *)))
2594 /* Size of the minimal vector allocated from block. */
2596 #define VBLOCK_BYTES_MIN vroundup (sizeof (struct Lisp_Vector))
2598 /* Size of the largest vector allocated from block. */
2600 #define VBLOCK_BYTES_MAX \
2601 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2603 /* We maintain one free list for each possible block-allocated
2604 vector size, and this is the number of free lists we have. */
2606 #define VECTOR_MAX_FREE_LIST_INDEX \
2607 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2609 /* Common shortcut to advance vector pointer over a block data. */
2611 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2613 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2615 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2617 /* Get and set the next field in block-allocated vectorlike objects on
2618 the free list. Doing it this way respects C's aliasing rules.
2619 We could instead make 'contents' a union, but that would mean
2620 changes everywhere that the code uses 'contents'. */
2621 static struct Lisp_Vector
*
2622 next_in_free_list (struct Lisp_Vector
*v
)
2624 intptr_t i
= XLI (v
->contents
[0]);
2625 return (struct Lisp_Vector
*) i
;
2628 set_next_in_free_list (struct Lisp_Vector
*v
, struct Lisp_Vector
*next
)
2630 v
->contents
[0] = XIL ((intptr_t) next
);
2633 /* Common shortcut to setup vector on a free list. */
2635 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2637 (tmp) = ((nbytes - header_size) / word_size); \
2638 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2639 eassert ((nbytes) % roundup_size == 0); \
2640 (tmp) = VINDEX (nbytes); \
2641 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2642 set_next_in_free_list (v, vector_free_lists[tmp]); \
2643 vector_free_lists[tmp] = (v); \
2644 total_free_vector_slots += (nbytes) / word_size; \
2647 /* This internal type is used to maintain the list of large vectors
2648 which are allocated at their own, e.g. outside of vector blocks. */
2653 struct large_vector
*vector
;
2655 /* We need to maintain ROUNDUP_SIZE alignment for the vector member. */
2656 unsigned char c
[vroundup (sizeof (struct large_vector
*))];
2659 struct Lisp_Vector v
;
2662 /* This internal type is used to maintain an underlying storage
2663 for small vectors. */
2667 char data
[VECTOR_BLOCK_BYTES
];
2668 struct vector_block
*next
;
2671 /* Chain of vector blocks. */
2673 static struct vector_block
*vector_blocks
;
2675 /* Vector free lists, where NTH item points to a chain of free
2676 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2678 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2680 /* Singly-linked list of large vectors. */
2682 static struct large_vector
*large_vectors
;
2684 /* The only vector with 0 slots, allocated from pure space. */
2686 Lisp_Object zero_vector
;
2688 /* Number of live vectors. */
2690 static EMACS_INT total_vectors
;
2692 /* Total size of live and free vectors, in Lisp_Object units. */
2694 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2696 /* Get a new vector block. */
2698 static struct vector_block
*
2699 allocate_vector_block (void)
2701 struct vector_block
*block
= xmalloc (sizeof *block
);
2703 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2704 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2705 MEM_TYPE_VECTOR_BLOCK
);
2708 block
->next
= vector_blocks
;
2709 vector_blocks
= block
;
2713 /* Called once to initialize vector allocation. */
2718 zero_vector
= make_pure_vector (0);
2721 /* Allocate vector from a vector block. */
2723 static struct Lisp_Vector
*
2724 allocate_vector_from_block (size_t nbytes
)
2726 struct Lisp_Vector
*vector
;
2727 struct vector_block
*block
;
2728 size_t index
, restbytes
;
2730 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2731 eassert (nbytes
% roundup_size
== 0);
2733 /* First, try to allocate from a free list
2734 containing vectors of the requested size. */
2735 index
= VINDEX (nbytes
);
2736 if (vector_free_lists
[index
])
2738 vector
= vector_free_lists
[index
];
2739 vector_free_lists
[index
] = next_in_free_list (vector
);
2740 total_free_vector_slots
-= nbytes
/ word_size
;
2744 /* Next, check free lists containing larger vectors. Since
2745 we will split the result, we should have remaining space
2746 large enough to use for one-slot vector at least. */
2747 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
2748 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
2749 if (vector_free_lists
[index
])
2751 /* This vector is larger than requested. */
2752 vector
= vector_free_lists
[index
];
2753 vector_free_lists
[index
] = next_in_free_list (vector
);
2754 total_free_vector_slots
-= nbytes
/ word_size
;
2756 /* Excess bytes are used for the smaller vector,
2757 which should be set on an appropriate free list. */
2758 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
2759 eassert (restbytes
% roundup_size
== 0);
2760 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2764 /* Finally, need a new vector block. */
2765 block
= allocate_vector_block ();
2767 /* New vector will be at the beginning of this block. */
2768 vector
= (struct Lisp_Vector
*) block
->data
;
2770 /* If the rest of space from this block is large enough
2771 for one-slot vector at least, set up it on a free list. */
2772 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
2773 if (restbytes
>= VBLOCK_BYTES_MIN
)
2775 eassert (restbytes
% roundup_size
== 0);
2776 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2781 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
2783 #define VECTOR_IN_BLOCK(vector, block) \
2784 ((char *) (vector) <= (block)->data \
2785 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
2787 /* Return the memory footprint of V in bytes. */
2790 vector_nbytes (struct Lisp_Vector
*v
)
2792 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
2794 if (size
& PSEUDOVECTOR_FLAG
)
2796 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
2797 size
= (bool_header_size
2798 + (((struct Lisp_Bool_Vector
*) v
)->size
2799 + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2800 / BOOL_VECTOR_BITS_PER_CHAR
);
2803 + ((size
& PSEUDOVECTOR_SIZE_MASK
)
2804 + ((size
& PSEUDOVECTOR_REST_MASK
)
2805 >> PSEUDOVECTOR_SIZE_BITS
)) * word_size
);
2808 size
= header_size
+ size
* word_size
;
2809 return vroundup (size
);
2812 /* Reclaim space used by unmarked vectors. */
2815 sweep_vectors (void)
2817 struct vector_block
*block
= vector_blocks
, **bprev
= &vector_blocks
;
2818 struct large_vector
*lv
, **lvprev
= &large_vectors
;
2819 struct Lisp_Vector
*vector
, *next
;
2821 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
2822 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
2824 /* Looking through vector blocks. */
2826 for (block
= vector_blocks
; block
; block
= *bprev
)
2828 bool free_this_block
= 0;
2831 for (vector
= (struct Lisp_Vector
*) block
->data
;
2832 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
2834 if (VECTOR_MARKED_P (vector
))
2836 VECTOR_UNMARK (vector
);
2838 nbytes
= vector_nbytes (vector
);
2839 total_vector_slots
+= nbytes
/ word_size
;
2840 next
= ADVANCE (vector
, nbytes
);
2844 ptrdiff_t total_bytes
;
2846 nbytes
= vector_nbytes (vector
);
2847 total_bytes
= nbytes
;
2848 next
= ADVANCE (vector
, nbytes
);
2850 /* While NEXT is not marked, try to coalesce with VECTOR,
2851 thus making VECTOR of the largest possible size. */
2853 while (VECTOR_IN_BLOCK (next
, block
))
2855 if (VECTOR_MARKED_P (next
))
2857 nbytes
= vector_nbytes (next
);
2858 total_bytes
+= nbytes
;
2859 next
= ADVANCE (next
, nbytes
);
2862 eassert (total_bytes
% roundup_size
== 0);
2864 if (vector
== (struct Lisp_Vector
*) block
->data
2865 && !VECTOR_IN_BLOCK (next
, block
))
2866 /* This block should be freed because all of it's
2867 space was coalesced into the only free vector. */
2868 free_this_block
= 1;
2872 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
2877 if (free_this_block
)
2879 *bprev
= block
->next
;
2880 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2881 mem_delete (mem_find (block
->data
));
2886 bprev
= &block
->next
;
2889 /* Sweep large vectors. */
2891 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
2894 if (VECTOR_MARKED_P (vector
))
2896 VECTOR_UNMARK (vector
);
2898 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
2900 struct Lisp_Bool_Vector
*b
= (struct Lisp_Bool_Vector
*) vector
;
2902 /* All non-bool pseudovectors are small enough to be allocated
2903 from vector blocks. This code should be redesigned if some
2904 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
2905 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
2908 += (bool_header_size
2909 + ((b
->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
2910 / BOOL_VECTOR_BITS_PER_CHAR
)) / word_size
;
2914 += header_size
/ word_size
+ vector
->header
.size
;
2915 lvprev
= &lv
->next
.vector
;
2919 *lvprev
= lv
->next
.vector
;
2925 /* Value is a pointer to a newly allocated Lisp_Vector structure
2926 with room for LEN Lisp_Objects. */
2928 static struct Lisp_Vector
*
2929 allocate_vectorlike (ptrdiff_t len
)
2931 struct Lisp_Vector
*p
;
2936 p
= XVECTOR (zero_vector
);
2939 size_t nbytes
= header_size
+ len
* word_size
;
2941 #ifdef DOUG_LEA_MALLOC
2942 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2943 because mapped region contents are not preserved in
2945 mallopt (M_MMAP_MAX
, 0);
2948 if (nbytes
<= VBLOCK_BYTES_MAX
)
2949 p
= allocate_vector_from_block (vroundup (nbytes
));
2952 struct large_vector
*lv
2953 = lisp_malloc (sizeof (*lv
) + (len
- 1) * word_size
,
2954 MEM_TYPE_VECTORLIKE
);
2955 lv
->next
.vector
= large_vectors
;
2960 #ifdef DOUG_LEA_MALLOC
2961 /* Back to a reasonable maximum of mmap'ed areas. */
2962 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2965 consing_since_gc
+= nbytes
;
2966 vector_cells_consed
+= len
;
2969 MALLOC_UNBLOCK_INPUT
;
2975 /* Allocate a vector with LEN slots. */
2977 struct Lisp_Vector
*
2978 allocate_vector (EMACS_INT len
)
2980 struct Lisp_Vector
*v
;
2981 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
2983 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
2984 memory_full (SIZE_MAX
);
2985 v
= allocate_vectorlike (len
);
2986 v
->header
.size
= len
;
2991 /* Allocate other vector-like structures. */
2993 struct Lisp_Vector
*
2994 allocate_pseudovector (int memlen
, int lisplen
, enum pvec_type tag
)
2996 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
2999 /* Catch bogus values. */
3000 eassert (tag
<= PVEC_FONT
);
3001 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3002 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3004 /* Only the first lisplen slots will be traced normally by the GC. */
3005 for (i
= 0; i
< lisplen
; ++i
)
3006 v
->contents
[i
] = Qnil
;
3008 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3013 allocate_buffer (void)
3015 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3017 BUFFER_PVEC_INIT (b
);
3018 /* Put B on the chain of all buffers including killed ones. */
3019 b
->next
= all_buffers
;
3021 /* Note that the rest fields of B are not initialized. */
3025 struct Lisp_Hash_Table
*
3026 allocate_hash_table (void)
3028 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3032 allocate_window (void)
3036 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3037 /* Users assumes that non-Lisp data is zeroed. */
3038 memset (&w
->current_matrix
, 0,
3039 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3044 allocate_terminal (void)
3048 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3049 /* Users assumes that non-Lisp data is zeroed. */
3050 memset (&t
->next_terminal
, 0,
3051 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3056 allocate_frame (void)
3060 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3061 /* Users assumes that non-Lisp data is zeroed. */
3062 memset (&f
->face_cache
, 0,
3063 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3067 struct Lisp_Process
*
3068 allocate_process (void)
3070 struct Lisp_Process
*p
;
3072 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3073 /* Users assumes that non-Lisp data is zeroed. */
3075 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3079 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3080 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3081 See also the function `vector'. */)
3082 (register Lisp_Object length
, Lisp_Object init
)
3085 register ptrdiff_t sizei
;
3086 register ptrdiff_t i
;
3087 register struct Lisp_Vector
*p
;
3089 CHECK_NATNUM (length
);
3091 p
= allocate_vector (XFASTINT (length
));
3092 sizei
= XFASTINT (length
);
3093 for (i
= 0; i
< sizei
; i
++)
3094 p
->contents
[i
] = init
;
3096 XSETVECTOR (vector
, p
);
3101 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3102 doc
: /* Return a newly created vector with specified arguments as elements.
3103 Any number of arguments, even zero arguments, are allowed.
3104 usage: (vector &rest OBJECTS) */)
3105 (ptrdiff_t nargs
, Lisp_Object
*args
)
3107 register Lisp_Object len
, val
;
3109 register struct Lisp_Vector
*p
;
3111 XSETFASTINT (len
, nargs
);
3112 val
= Fmake_vector (len
, Qnil
);
3114 for (i
= 0; i
< nargs
; i
++)
3115 p
->contents
[i
] = args
[i
];
3120 make_byte_code (struct Lisp_Vector
*v
)
3122 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3123 && STRING_MULTIBYTE (v
->contents
[1]))
3124 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3125 earlier because they produced a raw 8-bit string for byte-code
3126 and now such a byte-code string is loaded as multibyte while
3127 raw 8-bit characters converted to multibyte form. Thus, now we
3128 must convert them back to the original unibyte form. */
3129 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3130 XSETPVECTYPE (v
, PVEC_COMPILED
);
3133 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3134 doc
: /* Create a byte-code object with specified arguments as elements.
3135 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3136 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3137 and (optional) INTERACTIVE-SPEC.
3138 The first four arguments are required; at most six have any
3140 The ARGLIST can be either like the one of `lambda', in which case the arguments
3141 will be dynamically bound before executing the byte code, or it can be an
3142 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3143 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3144 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3145 argument to catch the left-over arguments. If such an integer is used, the
3146 arguments will not be dynamically bound but will be instead pushed on the
3147 stack before executing the byte-code.
3148 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3149 (ptrdiff_t nargs
, Lisp_Object
*args
)
3151 register Lisp_Object len
, val
;
3153 register struct Lisp_Vector
*p
;
3155 /* We used to purecopy everything here, if purify-flag was set. This worked
3156 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3157 dangerous, since make-byte-code is used during execution to build
3158 closures, so any closure built during the preload phase would end up
3159 copied into pure space, including its free variables, which is sometimes
3160 just wasteful and other times plainly wrong (e.g. those free vars may want
3163 XSETFASTINT (len
, nargs
);
3164 val
= Fmake_vector (len
, Qnil
);
3167 for (i
= 0; i
< nargs
; i
++)
3168 p
->contents
[i
] = args
[i
];
3170 XSETCOMPILED (val
, p
);
3176 /***********************************************************************
3178 ***********************************************************************/
3180 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3181 of the required alignment if LSB tags are used. */
3183 union aligned_Lisp_Symbol
3185 struct Lisp_Symbol s
;
3187 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3192 /* Each symbol_block is just under 1020 bytes long, since malloc
3193 really allocates in units of powers of two and uses 4 bytes for its
3196 #define SYMBOL_BLOCK_SIZE \
3197 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3201 /* Place `symbols' first, to preserve alignment. */
3202 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3203 struct symbol_block
*next
;
3206 /* Current symbol block and index of first unused Lisp_Symbol
3209 static struct symbol_block
*symbol_block
;
3210 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3212 /* List of free symbols. */
3214 static struct Lisp_Symbol
*symbol_free_list
;
3216 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3217 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3218 Its value is void, and its function definition and property list are nil. */)
3221 register Lisp_Object val
;
3222 register struct Lisp_Symbol
*p
;
3224 CHECK_STRING (name
);
3228 if (symbol_free_list
)
3230 XSETSYMBOL (val
, symbol_free_list
);
3231 symbol_free_list
= symbol_free_list
->next
;
3235 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3237 struct symbol_block
*new
3238 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3239 new->next
= symbol_block
;
3241 symbol_block_index
= 0;
3242 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3244 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3245 symbol_block_index
++;
3248 MALLOC_UNBLOCK_INPUT
;
3251 set_symbol_name (val
, name
);
3252 set_symbol_plist (val
, Qnil
);
3253 p
->redirect
= SYMBOL_PLAINVAL
;
3254 SET_SYMBOL_VAL (p
, Qunbound
);
3255 set_symbol_function (val
, Qnil
);
3256 set_symbol_next (val
, NULL
);
3258 p
->interned
= SYMBOL_UNINTERNED
;
3260 p
->declared_special
= 0;
3261 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3263 total_free_symbols
--;
3269 /***********************************************************************
3270 Marker (Misc) Allocation
3271 ***********************************************************************/
3273 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3274 the required alignment when LSB tags are used. */
3276 union aligned_Lisp_Misc
3280 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3285 /* Allocation of markers and other objects that share that structure.
3286 Works like allocation of conses. */
3288 #define MARKER_BLOCK_SIZE \
3289 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3293 /* Place `markers' first, to preserve alignment. */
3294 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3295 struct marker_block
*next
;
3298 static struct marker_block
*marker_block
;
3299 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3301 static union Lisp_Misc
*marker_free_list
;
3303 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3306 allocate_misc (enum Lisp_Misc_Type type
)
3312 if (marker_free_list
)
3314 XSETMISC (val
, marker_free_list
);
3315 marker_free_list
= marker_free_list
->u_free
.chain
;
3319 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3321 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3322 new->next
= marker_block
;
3324 marker_block_index
= 0;
3325 total_free_markers
+= MARKER_BLOCK_SIZE
;
3327 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3328 marker_block_index
++;
3331 MALLOC_UNBLOCK_INPUT
;
3333 --total_free_markers
;
3334 consing_since_gc
+= sizeof (union Lisp_Misc
);
3335 misc_objects_consed
++;
3336 XMISCTYPE (val
) = type
;
3337 XMISCANY (val
)->gcmarkbit
= 0;
3341 /* Free a Lisp_Misc object. */
3344 free_misc (Lisp_Object misc
)
3346 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3347 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3348 marker_free_list
= XMISC (misc
);
3349 consing_since_gc
-= sizeof (union Lisp_Misc
);
3350 total_free_markers
++;
3353 /* Return a Lisp_Save_Value object with the data saved according to
3354 FMT. Format specifiers are `i' for an integer, `p' for a pointer
3355 and `o' for Lisp_Object. Up to 4 objects can be specified. */
3358 format_save_value (const char *fmt
, ...)
3361 int len
= strlen (fmt
);
3362 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3363 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3365 eassert (0 < len
&& len
< 5);
3368 #define INITX(index) \
3371 p->type ## index = SAVE_UNUSED; \
3374 if (fmt[index] == 'i') \
3376 p->type ## index = SAVE_INTEGER; \
3377 p->data[index].integer = va_arg (ap, ptrdiff_t); \
3379 else if (fmt[index] == 'p') \
3381 p->type ## index = SAVE_POINTER; \
3382 p->data[index].pointer = va_arg (ap, void *); \
3384 else if (fmt[index] == 'o') \
3386 p->type ## index = SAVE_OBJECT; \
3387 p->data[index].object = va_arg (ap, Lisp_Object); \
3406 /* Return a Lisp_Save_Value object containing POINTER and INTEGER.
3407 Most code should use this to package C integers and pointers
3408 to call record_unwind_protect. The unwind function can get the
3409 C values back using XSAVE_POINTER and XSAVE_INTEGER. */
3412 make_save_value (void *pointer
, ptrdiff_t integer
)
3414 return format_save_value ("pi", pointer
, integer
);
3417 /* Free a Lisp_Save_Value object. Do not use this function
3418 if SAVE contains pointer other than returned by xmalloc. */
3421 free_save_value (Lisp_Object save
)
3423 xfree (XSAVE_POINTER (save
));
3427 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3430 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3432 register Lisp_Object overlay
;
3434 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3435 OVERLAY_START (overlay
) = start
;
3436 OVERLAY_END (overlay
) = end
;
3437 set_overlay_plist (overlay
, plist
);
3438 XOVERLAY (overlay
)->next
= NULL
;
3442 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3443 doc
: /* Return a newly allocated marker which does not point at any place. */)
3446 register Lisp_Object val
;
3447 register struct Lisp_Marker
*p
;
3449 val
= allocate_misc (Lisp_Misc_Marker
);
3455 p
->insertion_type
= 0;
3459 /* Return a newly allocated marker which points into BUF
3460 at character position CHARPOS and byte position BYTEPOS. */
3463 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3466 struct Lisp_Marker
*m
;
3468 /* No dead buffers here. */
3469 eassert (BUFFER_LIVE_P (buf
));
3471 /* Every character is at least one byte. */
3472 eassert (charpos
<= bytepos
);
3474 obj
= allocate_misc (Lisp_Misc_Marker
);
3477 m
->charpos
= charpos
;
3478 m
->bytepos
= bytepos
;
3479 m
->insertion_type
= 0;
3480 m
->next
= BUF_MARKERS (buf
);
3481 BUF_MARKERS (buf
) = m
;
3485 /* Put MARKER back on the free list after using it temporarily. */
3488 free_marker (Lisp_Object marker
)
3490 unchain_marker (XMARKER (marker
));
3495 /* Return a newly created vector or string with specified arguments as
3496 elements. If all the arguments are characters that can fit
3497 in a string of events, make a string; otherwise, make a vector.
3499 Any number of arguments, even zero arguments, are allowed. */
3502 make_event_array (register int nargs
, Lisp_Object
*args
)
3506 for (i
= 0; i
< nargs
; i
++)
3507 /* The things that fit in a string
3508 are characters that are in 0...127,
3509 after discarding the meta bit and all the bits above it. */
3510 if (!INTEGERP (args
[i
])
3511 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3512 return Fvector (nargs
, args
);
3514 /* Since the loop exited, we know that all the things in it are
3515 characters, so we can make a string. */
3519 result
= Fmake_string (make_number (nargs
), make_number (0));
3520 for (i
= 0; i
< nargs
; i
++)
3522 SSET (result
, i
, XINT (args
[i
]));
3523 /* Move the meta bit to the right place for a string char. */
3524 if (XINT (args
[i
]) & CHAR_META
)
3525 SSET (result
, i
, SREF (result
, i
) | 0x80);
3534 /************************************************************************
3535 Memory Full Handling
3536 ************************************************************************/
3539 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3540 there may have been size_t overflow so that malloc was never
3541 called, or perhaps malloc was invoked successfully but the
3542 resulting pointer had problems fitting into a tagged EMACS_INT. In
3543 either case this counts as memory being full even though malloc did
3547 memory_full (size_t nbytes
)
3549 /* Do not go into hysterics merely because a large request failed. */
3550 bool enough_free_memory
= 0;
3551 if (SPARE_MEMORY
< nbytes
)
3556 p
= malloc (SPARE_MEMORY
);
3560 enough_free_memory
= 1;
3562 MALLOC_UNBLOCK_INPUT
;
3565 if (! enough_free_memory
)
3571 memory_full_cons_threshold
= sizeof (struct cons_block
);
3573 /* The first time we get here, free the spare memory. */
3574 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3575 if (spare_memory
[i
])
3578 free (spare_memory
[i
]);
3579 else if (i
>= 1 && i
<= 4)
3580 lisp_align_free (spare_memory
[i
]);
3582 lisp_free (spare_memory
[i
]);
3583 spare_memory
[i
] = 0;
3587 /* This used to call error, but if we've run out of memory, we could
3588 get infinite recursion trying to build the string. */
3589 xsignal (Qnil
, Vmemory_signal_data
);
3592 /* If we released our reserve (due to running out of memory),
3593 and we have a fair amount free once again,
3594 try to set aside another reserve in case we run out once more.
3596 This is called when a relocatable block is freed in ralloc.c,
3597 and also directly from this file, in case we're not using ralloc.c. */
3600 refill_memory_reserve (void)
3602 #ifndef SYSTEM_MALLOC
3603 if (spare_memory
[0] == 0)
3604 spare_memory
[0] = malloc (SPARE_MEMORY
);
3605 if (spare_memory
[1] == 0)
3606 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3608 if (spare_memory
[2] == 0)
3609 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3611 if (spare_memory
[3] == 0)
3612 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3614 if (spare_memory
[4] == 0)
3615 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3617 if (spare_memory
[5] == 0)
3618 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3620 if (spare_memory
[6] == 0)
3621 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3623 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3624 Vmemory_full
= Qnil
;
3628 /************************************************************************
3630 ************************************************************************/
3632 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3634 /* Conservative C stack marking requires a method to identify possibly
3635 live Lisp objects given a pointer value. We do this by keeping
3636 track of blocks of Lisp data that are allocated in a red-black tree
3637 (see also the comment of mem_node which is the type of nodes in
3638 that tree). Function lisp_malloc adds information for an allocated
3639 block to the red-black tree with calls to mem_insert, and function
3640 lisp_free removes it with mem_delete. Functions live_string_p etc
3641 call mem_find to lookup information about a given pointer in the
3642 tree, and use that to determine if the pointer points to a Lisp
3645 /* Initialize this part of alloc.c. */
3650 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3651 mem_z
.parent
= NULL
;
3652 mem_z
.color
= MEM_BLACK
;
3653 mem_z
.start
= mem_z
.end
= NULL
;
3658 /* Value is a pointer to the mem_node containing START. Value is
3659 MEM_NIL if there is no node in the tree containing START. */
3661 static struct mem_node
*
3662 mem_find (void *start
)
3666 if (start
< min_heap_address
|| start
> max_heap_address
)
3669 /* Make the search always successful to speed up the loop below. */
3670 mem_z
.start
= start
;
3671 mem_z
.end
= (char *) start
+ 1;
3674 while (start
< p
->start
|| start
>= p
->end
)
3675 p
= start
< p
->start
? p
->left
: p
->right
;
3680 /* Insert a new node into the tree for a block of memory with start
3681 address START, end address END, and type TYPE. Value is a
3682 pointer to the node that was inserted. */
3684 static struct mem_node
*
3685 mem_insert (void *start
, void *end
, enum mem_type type
)
3687 struct mem_node
*c
, *parent
, *x
;
3689 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3690 min_heap_address
= start
;
3691 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3692 max_heap_address
= end
;
3694 /* See where in the tree a node for START belongs. In this
3695 particular application, it shouldn't happen that a node is already
3696 present. For debugging purposes, let's check that. */
3700 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3702 while (c
!= MEM_NIL
)
3704 if (start
>= c
->start
&& start
< c
->end
)
3707 c
= start
< c
->start
? c
->left
: c
->right
;
3710 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3712 while (c
!= MEM_NIL
)
3715 c
= start
< c
->start
? c
->left
: c
->right
;
3718 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3720 /* Create a new node. */
3721 #ifdef GC_MALLOC_CHECK
3722 x
= malloc (sizeof *x
);
3726 x
= xmalloc (sizeof *x
);
3732 x
->left
= x
->right
= MEM_NIL
;
3735 /* Insert it as child of PARENT or install it as root. */
3738 if (start
< parent
->start
)
3746 /* Re-establish red-black tree properties. */
3747 mem_insert_fixup (x
);
3753 /* Re-establish the red-black properties of the tree, and thereby
3754 balance the tree, after node X has been inserted; X is always red. */
3757 mem_insert_fixup (struct mem_node
*x
)
3759 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3761 /* X is red and its parent is red. This is a violation of
3762 red-black tree property #3. */
3764 if (x
->parent
== x
->parent
->parent
->left
)
3766 /* We're on the left side of our grandparent, and Y is our
3768 struct mem_node
*y
= x
->parent
->parent
->right
;
3770 if (y
->color
== MEM_RED
)
3772 /* Uncle and parent are red but should be black because
3773 X is red. Change the colors accordingly and proceed
3774 with the grandparent. */
3775 x
->parent
->color
= MEM_BLACK
;
3776 y
->color
= MEM_BLACK
;
3777 x
->parent
->parent
->color
= MEM_RED
;
3778 x
= x
->parent
->parent
;
3782 /* Parent and uncle have different colors; parent is
3783 red, uncle is black. */
3784 if (x
== x
->parent
->right
)
3787 mem_rotate_left (x
);
3790 x
->parent
->color
= MEM_BLACK
;
3791 x
->parent
->parent
->color
= MEM_RED
;
3792 mem_rotate_right (x
->parent
->parent
);
3797 /* This is the symmetrical case of above. */
3798 struct mem_node
*y
= x
->parent
->parent
->left
;
3800 if (y
->color
== MEM_RED
)
3802 x
->parent
->color
= MEM_BLACK
;
3803 y
->color
= MEM_BLACK
;
3804 x
->parent
->parent
->color
= MEM_RED
;
3805 x
= x
->parent
->parent
;
3809 if (x
== x
->parent
->left
)
3812 mem_rotate_right (x
);
3815 x
->parent
->color
= MEM_BLACK
;
3816 x
->parent
->parent
->color
= MEM_RED
;
3817 mem_rotate_left (x
->parent
->parent
);
3822 /* The root may have been changed to red due to the algorithm. Set
3823 it to black so that property #5 is satisfied. */
3824 mem_root
->color
= MEM_BLACK
;
3835 mem_rotate_left (struct mem_node
*x
)
3839 /* Turn y's left sub-tree into x's right sub-tree. */
3842 if (y
->left
!= MEM_NIL
)
3843 y
->left
->parent
= x
;
3845 /* Y's parent was x's parent. */
3847 y
->parent
= x
->parent
;
3849 /* Get the parent to point to y instead of x. */
3852 if (x
== x
->parent
->left
)
3853 x
->parent
->left
= y
;
3855 x
->parent
->right
= y
;
3860 /* Put x on y's left. */
3874 mem_rotate_right (struct mem_node
*x
)
3876 struct mem_node
*y
= x
->left
;
3879 if (y
->right
!= MEM_NIL
)
3880 y
->right
->parent
= x
;
3883 y
->parent
= x
->parent
;
3886 if (x
== x
->parent
->right
)
3887 x
->parent
->right
= y
;
3889 x
->parent
->left
= y
;
3900 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3903 mem_delete (struct mem_node
*z
)
3905 struct mem_node
*x
, *y
;
3907 if (!z
|| z
== MEM_NIL
)
3910 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
3915 while (y
->left
!= MEM_NIL
)
3919 if (y
->left
!= MEM_NIL
)
3924 x
->parent
= y
->parent
;
3927 if (y
== y
->parent
->left
)
3928 y
->parent
->left
= x
;
3930 y
->parent
->right
= x
;
3937 z
->start
= y
->start
;
3942 if (y
->color
== MEM_BLACK
)
3943 mem_delete_fixup (x
);
3945 #ifdef GC_MALLOC_CHECK
3953 /* Re-establish the red-black properties of the tree, after a
3957 mem_delete_fixup (struct mem_node
*x
)
3959 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
3961 if (x
== x
->parent
->left
)
3963 struct mem_node
*w
= x
->parent
->right
;
3965 if (w
->color
== MEM_RED
)
3967 w
->color
= MEM_BLACK
;
3968 x
->parent
->color
= MEM_RED
;
3969 mem_rotate_left (x
->parent
);
3970 w
= x
->parent
->right
;
3973 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
3980 if (w
->right
->color
== MEM_BLACK
)
3982 w
->left
->color
= MEM_BLACK
;
3984 mem_rotate_right (w
);
3985 w
= x
->parent
->right
;
3987 w
->color
= x
->parent
->color
;
3988 x
->parent
->color
= MEM_BLACK
;
3989 w
->right
->color
= MEM_BLACK
;
3990 mem_rotate_left (x
->parent
);
3996 struct mem_node
*w
= x
->parent
->left
;
3998 if (w
->color
== MEM_RED
)
4000 w
->color
= MEM_BLACK
;
4001 x
->parent
->color
= MEM_RED
;
4002 mem_rotate_right (x
->parent
);
4003 w
= x
->parent
->left
;
4006 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4013 if (w
->left
->color
== MEM_BLACK
)
4015 w
->right
->color
= MEM_BLACK
;
4017 mem_rotate_left (w
);
4018 w
= x
->parent
->left
;
4021 w
->color
= x
->parent
->color
;
4022 x
->parent
->color
= MEM_BLACK
;
4023 w
->left
->color
= MEM_BLACK
;
4024 mem_rotate_right (x
->parent
);
4030 x
->color
= MEM_BLACK
;
4034 /* Value is non-zero if P is a pointer to a live Lisp string on
4035 the heap. M is a pointer to the mem_block for P. */
4038 live_string_p (struct mem_node
*m
, void *p
)
4040 if (m
->type
== MEM_TYPE_STRING
)
4042 struct string_block
*b
= (struct string_block
*) m
->start
;
4043 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4045 /* P must point to the start of a Lisp_String structure, and it
4046 must not be on the free-list. */
4048 && offset
% sizeof b
->strings
[0] == 0
4049 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4050 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4057 /* Value is non-zero if P is a pointer to a live Lisp cons on
4058 the heap. M is a pointer to the mem_block for P. */
4061 live_cons_p (struct mem_node
*m
, void *p
)
4063 if (m
->type
== MEM_TYPE_CONS
)
4065 struct cons_block
*b
= (struct cons_block
*) m
->start
;
4066 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4068 /* P must point to the start of a Lisp_Cons, not be
4069 one of the unused cells in the current cons block,
4070 and not be on the free-list. */
4072 && offset
% sizeof b
->conses
[0] == 0
4073 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4075 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4076 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4083 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4084 the heap. M is a pointer to the mem_block for P. */
4087 live_symbol_p (struct mem_node
*m
, void *p
)
4089 if (m
->type
== MEM_TYPE_SYMBOL
)
4091 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
4092 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4094 /* P must point to the start of a Lisp_Symbol, not be
4095 one of the unused cells in the current symbol block,
4096 and not be on the free-list. */
4098 && offset
% sizeof b
->symbols
[0] == 0
4099 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4100 && (b
!= symbol_block
4101 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4102 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4109 /* Value is non-zero if P is a pointer to a live Lisp float on
4110 the heap. M is a pointer to the mem_block for P. */
4113 live_float_p (struct mem_node
*m
, void *p
)
4115 if (m
->type
== MEM_TYPE_FLOAT
)
4117 struct float_block
*b
= (struct float_block
*) m
->start
;
4118 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4120 /* P must point to the start of a Lisp_Float and not be
4121 one of the unused cells in the current float block. */
4123 && offset
% sizeof b
->floats
[0] == 0
4124 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4125 && (b
!= float_block
4126 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4133 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4134 the heap. M is a pointer to the mem_block for P. */
4137 live_misc_p (struct mem_node
*m
, void *p
)
4139 if (m
->type
== MEM_TYPE_MISC
)
4141 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4142 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4144 /* P must point to the start of a Lisp_Misc, not be
4145 one of the unused cells in the current misc block,
4146 and not be on the free-list. */
4148 && offset
% sizeof b
->markers
[0] == 0
4149 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4150 && (b
!= marker_block
4151 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4152 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4159 /* Value is non-zero if P is a pointer to a live vector-like object.
4160 M is a pointer to the mem_block for P. */
4163 live_vector_p (struct mem_node
*m
, void *p
)
4165 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4167 /* This memory node corresponds to a vector block. */
4168 struct vector_block
*block
= (struct vector_block
*) m
->start
;
4169 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4171 /* P is in the block's allocation range. Scan the block
4172 up to P and see whether P points to the start of some
4173 vector which is not on a free list. FIXME: check whether
4174 some allocation patterns (probably a lot of short vectors)
4175 may cause a substantial overhead of this loop. */
4176 while (VECTOR_IN_BLOCK (vector
, block
)
4177 && vector
<= (struct Lisp_Vector
*) p
)
4179 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4182 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4185 else if (m
->type
== MEM_TYPE_VECTORLIKE
4186 && (char *) p
== ((char *) m
->start
4187 + offsetof (struct large_vector
, v
)))
4188 /* This memory node corresponds to a large vector. */
4194 /* Value is non-zero if P is a pointer to a live buffer. M is a
4195 pointer to the mem_block for P. */
4198 live_buffer_p (struct mem_node
*m
, void *p
)
4200 /* P must point to the start of the block, and the buffer
4201 must not have been killed. */
4202 return (m
->type
== MEM_TYPE_BUFFER
4204 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4207 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4211 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4213 /* Array of objects that are kept alive because the C stack contains
4214 a pattern that looks like a reference to them . */
4216 #define MAX_ZOMBIES 10
4217 static Lisp_Object zombies
[MAX_ZOMBIES
];
4219 /* Number of zombie objects. */
4221 static EMACS_INT nzombies
;
4223 /* Number of garbage collections. */
4225 static EMACS_INT ngcs
;
4227 /* Average percentage of zombies per collection. */
4229 static double avg_zombies
;
4231 /* Max. number of live and zombie objects. */
4233 static EMACS_INT max_live
, max_zombies
;
4235 /* Average number of live objects per GC. */
4237 static double avg_live
;
4239 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4240 doc
: /* Show information about live and zombie objects. */)
4243 Lisp_Object args
[8], zombie_list
= Qnil
;
4245 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4246 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4247 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4248 args
[1] = make_number (ngcs
);
4249 args
[2] = make_float (avg_live
);
4250 args
[3] = make_float (avg_zombies
);
4251 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4252 args
[5] = make_number (max_live
);
4253 args
[6] = make_number (max_zombies
);
4254 args
[7] = zombie_list
;
4255 return Fmessage (8, args
);
4258 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4261 /* Mark OBJ if we can prove it's a Lisp_Object. */
4264 mark_maybe_object (Lisp_Object obj
)
4272 po
= (void *) XPNTR (obj
);
4279 switch (XTYPE (obj
))
4282 mark_p
= (live_string_p (m
, po
)
4283 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4287 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4291 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4295 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4298 case Lisp_Vectorlike
:
4299 /* Note: can't check BUFFERP before we know it's a
4300 buffer because checking that dereferences the pointer
4301 PO which might point anywhere. */
4302 if (live_vector_p (m
, po
))
4303 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4304 else if (live_buffer_p (m
, po
))
4305 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4309 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4318 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4319 if (nzombies
< MAX_ZOMBIES
)
4320 zombies
[nzombies
] = obj
;
4329 /* If P points to Lisp data, mark that as live if it isn't already
4333 mark_maybe_pointer (void *p
)
4337 /* Quickly rule out some values which can't point to Lisp data.
4338 USE_LSB_TAG needs Lisp data to be aligned on multiples of GCALIGNMENT.
4339 Otherwise, assume that Lisp data is aligned on even addresses. */
4340 if ((intptr_t) p
% (USE_LSB_TAG
? GCALIGNMENT
: 2))
4346 Lisp_Object obj
= Qnil
;
4350 case MEM_TYPE_NON_LISP
:
4351 case MEM_TYPE_SPARE
:
4352 /* Nothing to do; not a pointer to Lisp memory. */
4355 case MEM_TYPE_BUFFER
:
4356 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4357 XSETVECTOR (obj
, p
);
4361 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4365 case MEM_TYPE_STRING
:
4366 if (live_string_p (m
, p
)
4367 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4368 XSETSTRING (obj
, p
);
4372 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4376 case MEM_TYPE_SYMBOL
:
4377 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4378 XSETSYMBOL (obj
, p
);
4381 case MEM_TYPE_FLOAT
:
4382 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4386 case MEM_TYPE_VECTORLIKE
:
4387 case MEM_TYPE_VECTOR_BLOCK
:
4388 if (live_vector_p (m
, p
))
4391 XSETVECTOR (tem
, p
);
4392 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4407 /* Alignment of pointer values. Use alignof, as it sometimes returns
4408 a smaller alignment than GCC's __alignof__ and mark_memory might
4409 miss objects if __alignof__ were used. */
4410 #define GC_POINTER_ALIGNMENT alignof (void *)
4412 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4413 not suffice, which is the typical case. A host where a Lisp_Object is
4414 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4415 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4416 suffice to widen it to to a Lisp_Object and check it that way. */
4417 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4418 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4419 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4420 nor mark_maybe_object can follow the pointers. This should not occur on
4421 any practical porting target. */
4422 # error "MSB type bits straddle pointer-word boundaries"
4424 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4425 pointer words that hold pointers ORed with type bits. */
4426 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4428 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4429 words that hold unmodified pointers. */
4430 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4433 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4434 or END+OFFSET..START. */
4437 mark_memory (void *start
, void *end
)
4438 #if defined (__clang__) && defined (__has_feature)
4439 #if __has_feature(address_sanitizer)
4440 /* Do not allow -faddress-sanitizer to check this function, since it
4441 crosses the function stack boundary, and thus would yield many
4443 __attribute__((no_address_safety_analysis
))
4450 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4454 /* Make START the pointer to the start of the memory region,
4455 if it isn't already. */
4463 /* Mark Lisp data pointed to. This is necessary because, in some
4464 situations, the C compiler optimizes Lisp objects away, so that
4465 only a pointer to them remains. Example:
4467 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4470 Lisp_Object obj = build_string ("test");
4471 struct Lisp_String *s = XSTRING (obj);
4472 Fgarbage_collect ();
4473 fprintf (stderr, "test `%s'\n", s->data);
4477 Here, `obj' isn't really used, and the compiler optimizes it
4478 away. The only reference to the life string is through the
4481 for (pp
= start
; (void *) pp
< end
; pp
++)
4482 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4484 void *p
= *(void **) ((char *) pp
+ i
);
4485 mark_maybe_pointer (p
);
4486 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4487 mark_maybe_object (XIL ((intptr_t) p
));
4491 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4493 static bool setjmp_tested_p
;
4494 static int longjmps_done
;
4496 #define SETJMP_WILL_LIKELY_WORK "\
4498 Emacs garbage collector has been changed to use conservative stack\n\
4499 marking. Emacs has determined that the method it uses to do the\n\
4500 marking will likely work on your system, but this isn't sure.\n\
4502 If you are a system-programmer, or can get the help of a local wizard\n\
4503 who is, please take a look at the function mark_stack in alloc.c, and\n\
4504 verify that the methods used are appropriate for your system.\n\
4506 Please mail the result to <emacs-devel@gnu.org>.\n\
4509 #define SETJMP_WILL_NOT_WORK "\
4511 Emacs garbage collector has been changed to use conservative stack\n\
4512 marking. Emacs has determined that the default method it uses to do the\n\
4513 marking will not work on your system. We will need a system-dependent\n\
4514 solution for your system.\n\
4516 Please take a look at the function mark_stack in alloc.c, and\n\
4517 try to find a way to make it work on your system.\n\
4519 Note that you may get false negatives, depending on the compiler.\n\
4520 In particular, you need to use -O with GCC for this test.\n\
4522 Please mail the result to <emacs-devel@gnu.org>.\n\
4526 /* Perform a quick check if it looks like setjmp saves registers in a
4527 jmp_buf. Print a message to stderr saying so. When this test
4528 succeeds, this is _not_ a proof that setjmp is sufficient for
4529 conservative stack marking. Only the sources or a disassembly
4539 /* Arrange for X to be put in a register. */
4545 if (longjmps_done
== 1)
4547 /* Came here after the longjmp at the end of the function.
4549 If x == 1, the longjmp has restored the register to its
4550 value before the setjmp, and we can hope that setjmp
4551 saves all such registers in the jmp_buf, although that
4554 For other values of X, either something really strange is
4555 taking place, or the setjmp just didn't save the register. */
4558 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4561 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4568 if (longjmps_done
== 1)
4569 sys_longjmp (jbuf
, 1);
4572 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4575 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4577 /* Abort if anything GCPRO'd doesn't survive the GC. */
4585 for (p
= gcprolist
; p
; p
= p
->next
)
4586 for (i
= 0; i
< p
->nvars
; ++i
)
4587 if (!survives_gc_p (p
->var
[i
]))
4588 /* FIXME: It's not necessarily a bug. It might just be that the
4589 GCPRO is unnecessary or should release the object sooner. */
4593 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4600 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4601 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4603 fprintf (stderr
, " %d = ", i
);
4604 debug_print (zombies
[i
]);
4608 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4611 /* Mark live Lisp objects on the C stack.
4613 There are several system-dependent problems to consider when
4614 porting this to new architectures:
4618 We have to mark Lisp objects in CPU registers that can hold local
4619 variables or are used to pass parameters.
4621 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4622 something that either saves relevant registers on the stack, or
4623 calls mark_maybe_object passing it each register's contents.
4625 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4626 implementation assumes that calling setjmp saves registers we need
4627 to see in a jmp_buf which itself lies on the stack. This doesn't
4628 have to be true! It must be verified for each system, possibly
4629 by taking a look at the source code of setjmp.
4631 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4632 can use it as a machine independent method to store all registers
4633 to the stack. In this case the macros described in the previous
4634 two paragraphs are not used.
4638 Architectures differ in the way their processor stack is organized.
4639 For example, the stack might look like this
4642 | Lisp_Object | size = 4
4644 | something else | size = 2
4646 | Lisp_Object | size = 4
4650 In such a case, not every Lisp_Object will be aligned equally. To
4651 find all Lisp_Object on the stack it won't be sufficient to walk
4652 the stack in steps of 4 bytes. Instead, two passes will be
4653 necessary, one starting at the start of the stack, and a second
4654 pass starting at the start of the stack + 2. Likewise, if the
4655 minimal alignment of Lisp_Objects on the stack is 1, four passes
4656 would be necessary, each one starting with one byte more offset
4657 from the stack start. */
4664 #ifdef HAVE___BUILTIN_UNWIND_INIT
4665 /* Force callee-saved registers and register windows onto the stack.
4666 This is the preferred method if available, obviating the need for
4667 machine dependent methods. */
4668 __builtin_unwind_init ();
4670 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4671 #ifndef GC_SAVE_REGISTERS_ON_STACK
4672 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4673 union aligned_jmpbuf
{
4677 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4679 /* This trick flushes the register windows so that all the state of
4680 the process is contained in the stack. */
4681 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4682 needed on ia64 too. See mach_dep.c, where it also says inline
4683 assembler doesn't work with relevant proprietary compilers. */
4685 #if defined (__sparc64__) && defined (__FreeBSD__)
4686 /* FreeBSD does not have a ta 3 handler. */
4693 /* Save registers that we need to see on the stack. We need to see
4694 registers used to hold register variables and registers used to
4696 #ifdef GC_SAVE_REGISTERS_ON_STACK
4697 GC_SAVE_REGISTERS_ON_STACK (end
);
4698 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4700 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4701 setjmp will definitely work, test it
4702 and print a message with the result
4704 if (!setjmp_tested_p
)
4706 setjmp_tested_p
= 1;
4709 #endif /* GC_SETJMP_WORKS */
4712 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4713 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4714 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4716 /* This assumes that the stack is a contiguous region in memory. If
4717 that's not the case, something has to be done here to iterate
4718 over the stack segments. */
4719 mark_memory (stack_base
, end
);
4721 /* Allow for marking a secondary stack, like the register stack on the
4723 #ifdef GC_MARK_SECONDARY_STACK
4724 GC_MARK_SECONDARY_STACK ();
4727 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4732 #endif /* GC_MARK_STACK != 0 */
4735 /* Determine whether it is safe to access memory at address P. */
4737 valid_pointer_p (void *p
)
4740 return w32_valid_pointer_p (p
, 16);
4744 /* Obviously, we cannot just access it (we would SEGV trying), so we
4745 trick the o/s to tell us whether p is a valid pointer.
4746 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4747 not validate p in that case. */
4751 bool valid
= emacs_write (fd
[1], (char *) p
, 16) == 16;
4752 emacs_close (fd
[1]);
4753 emacs_close (fd
[0]);
4761 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
4762 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
4763 cannot validate OBJ. This function can be quite slow, so its primary
4764 use is the manual debugging. The only exception is print_object, where
4765 we use it to check whether the memory referenced by the pointer of
4766 Lisp_Save_Value object contains valid objects. */
4769 valid_lisp_object_p (Lisp_Object obj
)
4779 p
= (void *) XPNTR (obj
);
4780 if (PURE_POINTER_P (p
))
4783 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
4787 return valid_pointer_p (p
);
4794 int valid
= valid_pointer_p (p
);
4806 case MEM_TYPE_NON_LISP
:
4807 case MEM_TYPE_SPARE
:
4810 case MEM_TYPE_BUFFER
:
4811 return live_buffer_p (m
, p
) ? 1 : 2;
4814 return live_cons_p (m
, p
);
4816 case MEM_TYPE_STRING
:
4817 return live_string_p (m
, p
);
4820 return live_misc_p (m
, p
);
4822 case MEM_TYPE_SYMBOL
:
4823 return live_symbol_p (m
, p
);
4825 case MEM_TYPE_FLOAT
:
4826 return live_float_p (m
, p
);
4828 case MEM_TYPE_VECTORLIKE
:
4829 case MEM_TYPE_VECTOR_BLOCK
:
4830 return live_vector_p (m
, p
);
4843 /***********************************************************************
4844 Pure Storage Management
4845 ***********************************************************************/
4847 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4848 pointer to it. TYPE is the Lisp type for which the memory is
4849 allocated. TYPE < 0 means it's not used for a Lisp object. */
4852 pure_alloc (size_t size
, int type
)
4856 size_t alignment
= GCALIGNMENT
;
4858 size_t alignment
= alignof (EMACS_INT
);
4860 /* Give Lisp_Floats an extra alignment. */
4861 if (type
== Lisp_Float
)
4862 alignment
= alignof (struct Lisp_Float
);
4868 /* Allocate space for a Lisp object from the beginning of the free
4869 space with taking account of alignment. */
4870 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4871 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4875 /* Allocate space for a non-Lisp object from the end of the free
4877 pure_bytes_used_non_lisp
+= size
;
4878 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4880 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4882 if (pure_bytes_used
<= pure_size
)
4885 /* Don't allocate a large amount here,
4886 because it might get mmap'd and then its address
4887 might not be usable. */
4888 purebeg
= xmalloc (10000);
4890 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4891 pure_bytes_used
= 0;
4892 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4897 /* Print a warning if PURESIZE is too small. */
4900 check_pure_size (void)
4902 if (pure_bytes_used_before_overflow
)
4903 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4905 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4909 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4910 the non-Lisp data pool of the pure storage, and return its start
4911 address. Return NULL if not found. */
4914 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
4917 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
4918 const unsigned char *p
;
4921 if (pure_bytes_used_non_lisp
<= nbytes
)
4924 /* Set up the Boyer-Moore table. */
4926 for (i
= 0; i
< 256; i
++)
4929 p
= (const unsigned char *) data
;
4931 bm_skip
[*p
++] = skip
;
4933 last_char_skip
= bm_skip
['\0'];
4935 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4936 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
4938 /* See the comments in the function `boyer_moore' (search.c) for the
4939 use of `infinity'. */
4940 infinity
= pure_bytes_used_non_lisp
+ 1;
4941 bm_skip
['\0'] = infinity
;
4943 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
4947 /* Check the last character (== '\0'). */
4950 start
+= bm_skip
[*(p
+ start
)];
4952 while (start
<= start_max
);
4954 if (start
< infinity
)
4955 /* Couldn't find the last character. */
4958 /* No less than `infinity' means we could find the last
4959 character at `p[start - infinity]'. */
4962 /* Check the remaining characters. */
4963 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
4965 return non_lisp_beg
+ start
;
4967 start
+= last_char_skip
;
4969 while (start
<= start_max
);
4975 /* Return a string allocated in pure space. DATA is a buffer holding
4976 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4977 means make the result string multibyte.
4979 Must get an error if pure storage is full, since if it cannot hold
4980 a large string it may be able to hold conses that point to that
4981 string; then the string is not protected from gc. */
4984 make_pure_string (const char *data
,
4985 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
4988 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
4989 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
4990 if (s
->data
== NULL
)
4992 s
->data
= pure_alloc (nbytes
+ 1, -1);
4993 memcpy (s
->data
, data
, nbytes
);
4994 s
->data
[nbytes
] = '\0';
4997 s
->size_byte
= multibyte
? nbytes
: -1;
4998 s
->intervals
= NULL
;
4999 XSETSTRING (string
, s
);
5003 /* Return a string allocated in pure space. Do not
5004 allocate the string data, just point to DATA. */
5007 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5010 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5013 s
->data
= (unsigned char *) data
;
5014 s
->intervals
= NULL
;
5015 XSETSTRING (string
, s
);
5019 /* Return a cons allocated from pure space. Give it pure copies
5020 of CAR as car and CDR as cdr. */
5023 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5026 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5028 XSETCAR (new, Fpurecopy (car
));
5029 XSETCDR (new, Fpurecopy (cdr
));
5034 /* Value is a float object with value NUM allocated from pure space. */
5037 make_pure_float (double num
)
5040 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5042 XFLOAT_INIT (new, num
);
5047 /* Return a vector with room for LEN Lisp_Objects allocated from
5051 make_pure_vector (ptrdiff_t len
)
5054 size_t size
= header_size
+ len
* word_size
;
5055 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5056 XSETVECTOR (new, p
);
5057 XVECTOR (new)->header
.size
= len
;
5062 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5063 doc
: /* Make a copy of object OBJ in pure storage.
5064 Recursively copies contents of vectors and cons cells.
5065 Does not copy symbols. Copies strings without text properties. */)
5066 (register Lisp_Object obj
)
5068 if (NILP (Vpurify_flag
))
5071 if (PURE_POINTER_P (XPNTR (obj
)))
5074 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5076 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5082 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5083 else if (FLOATP (obj
))
5084 obj
= make_pure_float (XFLOAT_DATA (obj
));
5085 else if (STRINGP (obj
))
5086 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5088 STRING_MULTIBYTE (obj
));
5089 else if (COMPILEDP (obj
) || VECTORP (obj
))
5091 register struct Lisp_Vector
*vec
;
5092 register ptrdiff_t i
;
5096 if (size
& PSEUDOVECTOR_FLAG
)
5097 size
&= PSEUDOVECTOR_SIZE_MASK
;
5098 vec
= XVECTOR (make_pure_vector (size
));
5099 for (i
= 0; i
< size
; i
++)
5100 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5101 if (COMPILEDP (obj
))
5103 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5104 XSETCOMPILED (obj
, vec
);
5107 XSETVECTOR (obj
, vec
);
5109 else if (MARKERP (obj
))
5110 error ("Attempt to copy a marker to pure storage");
5112 /* Not purified, don't hash-cons. */
5115 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5116 Fputhash (obj
, obj
, Vpurify_flag
);
5123 /***********************************************************************
5125 ***********************************************************************/
5127 /* Put an entry in staticvec, pointing at the variable with address
5131 staticpro (Lisp_Object
*varaddress
)
5133 staticvec
[staticidx
++] = varaddress
;
5134 if (staticidx
>= NSTATICS
)
5135 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5139 /***********************************************************************
5141 ***********************************************************************/
5143 /* Temporarily prevent garbage collection. */
5146 inhibit_garbage_collection (void)
5148 ptrdiff_t count
= SPECPDL_INDEX ();
5150 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5154 /* Used to avoid possible overflows when
5155 converting from C to Lisp integers. */
5158 bounded_number (EMACS_INT number
)
5160 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5163 /* Calculate total bytes of live objects. */
5166 total_bytes_of_live_objects (void)
5169 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5170 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5171 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5172 tot
+= total_string_bytes
;
5173 tot
+= total_vector_slots
* word_size
;
5174 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5175 tot
+= total_intervals
* sizeof (struct interval
);
5176 tot
+= total_strings
* sizeof (struct Lisp_String
);
5180 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5181 doc
: /* Reclaim storage for Lisp objects no longer needed.
5182 Garbage collection happens automatically if you cons more than
5183 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5184 `garbage-collect' normally returns a list with info on amount of space in use,
5185 where each entry has the form (NAME SIZE USED FREE), where:
5186 - NAME is a symbol describing the kind of objects this entry represents,
5187 - SIZE is the number of bytes used by each one,
5188 - USED is the number of those objects that were found live in the heap,
5189 - FREE is the number of those objects that are not live but that Emacs
5190 keeps around for future allocations (maybe because it does not know how
5191 to return them to the OS).
5192 However, if there was overflow in pure space, `garbage-collect'
5193 returns nil, because real GC can't be done.
5194 See Info node `(elisp)Garbage Collection'. */)
5197 struct specbinding
*bind
;
5198 struct buffer
*nextb
;
5199 char stack_top_variable
;
5202 ptrdiff_t count
= SPECPDL_INDEX ();
5204 Lisp_Object retval
= Qnil
;
5205 size_t tot_before
= 0;
5206 struct backtrace backtrace
;
5211 /* Can't GC if pure storage overflowed because we can't determine
5212 if something is a pure object or not. */
5213 if (pure_bytes_used_before_overflow
)
5216 /* Record this function, so it appears on the profiler's backtraces. */
5217 backtrace
.next
= backtrace_list
;
5218 backtrace
.function
= Qautomatic_gc
;
5219 backtrace
.args
= &Qnil
;
5220 backtrace
.nargs
= 0;
5221 backtrace
.debug_on_exit
= 0;
5222 backtrace_list
= &backtrace
;
5226 /* Don't keep undo information around forever.
5227 Do this early on, so it is no problem if the user quits. */
5228 FOR_EACH_BUFFER (nextb
)
5229 compact_buffer (nextb
);
5231 if (profiler_memory_running
)
5232 tot_before
= total_bytes_of_live_objects ();
5234 start
= current_emacs_time ();
5236 /* In case user calls debug_print during GC,
5237 don't let that cause a recursive GC. */
5238 consing_since_gc
= 0;
5240 /* Save what's currently displayed in the echo area. */
5241 message_p
= push_message ();
5242 record_unwind_protect (pop_message_unwind
, Qnil
);
5244 /* Save a copy of the contents of the stack, for debugging. */
5245 #if MAX_SAVE_STACK > 0
5246 if (NILP (Vpurify_flag
))
5249 ptrdiff_t stack_size
;
5250 if (&stack_top_variable
< stack_bottom
)
5252 stack
= &stack_top_variable
;
5253 stack_size
= stack_bottom
- &stack_top_variable
;
5257 stack
= stack_bottom
;
5258 stack_size
= &stack_top_variable
- stack_bottom
;
5260 if (stack_size
<= MAX_SAVE_STACK
)
5262 if (stack_copy_size
< stack_size
)
5264 stack_copy
= xrealloc (stack_copy
, stack_size
);
5265 stack_copy_size
= stack_size
;
5267 memcpy (stack_copy
, stack
, stack_size
);
5270 #endif /* MAX_SAVE_STACK > 0 */
5272 if (garbage_collection_messages
)
5273 message1_nolog ("Garbage collecting...");
5277 shrink_regexp_cache ();
5281 /* Mark all the special slots that serve as the roots of accessibility. */
5283 mark_buffer (&buffer_defaults
);
5284 mark_buffer (&buffer_local_symbols
);
5286 for (i
= 0; i
< staticidx
; i
++)
5287 mark_object (*staticvec
[i
]);
5289 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5291 mark_object (bind
->symbol
);
5292 mark_object (bind
->old_value
);
5301 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5302 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5306 register struct gcpro
*tail
;
5307 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5308 for (i
= 0; i
< tail
->nvars
; i
++)
5309 mark_object (tail
->var
[i
]);
5313 struct catchtag
*catch;
5314 struct handler
*handler
;
5316 for (catch = catchlist
; catch; catch = catch->next
)
5318 mark_object (catch->tag
);
5319 mark_object (catch->val
);
5321 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5323 mark_object (handler
->handler
);
5324 mark_object (handler
->var
);
5330 #ifdef HAVE_WINDOW_SYSTEM
5331 mark_fringe_data ();
5334 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5338 /* Everything is now marked, except for the things that require special
5339 finalization, i.e. the undo_list.
5340 Look thru every buffer's undo list
5341 for elements that update markers that were not marked,
5343 FOR_EACH_BUFFER (nextb
)
5345 /* If a buffer's undo list is Qt, that means that undo is
5346 turned off in that buffer. Calling truncate_undo_list on
5347 Qt tends to return NULL, which effectively turns undo back on.
5348 So don't call truncate_undo_list if undo_list is Qt. */
5349 if (! EQ (nextb
->INTERNAL_FIELD (undo_list
), Qt
))
5351 Lisp_Object tail
, prev
;
5352 tail
= nextb
->INTERNAL_FIELD (undo_list
);
5354 while (CONSP (tail
))
5356 if (CONSP (XCAR (tail
))
5357 && MARKERP (XCAR (XCAR (tail
)))
5358 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5361 nextb
->INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5365 XSETCDR (prev
, tail
);
5375 /* Now that we have stripped the elements that need not be in the
5376 undo_list any more, we can finally mark the list. */
5377 mark_object (nextb
->INTERNAL_FIELD (undo_list
));
5382 /* Clear the mark bits that we set in certain root slots. */
5384 unmark_byte_stack ();
5385 VECTOR_UNMARK (&buffer_defaults
);
5386 VECTOR_UNMARK (&buffer_local_symbols
);
5388 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5398 consing_since_gc
= 0;
5399 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5400 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5402 gc_relative_threshold
= 0;
5403 if (FLOATP (Vgc_cons_percentage
))
5404 { /* Set gc_cons_combined_threshold. */
5405 double tot
= total_bytes_of_live_objects ();
5407 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5410 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5411 gc_relative_threshold
= tot
;
5413 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5417 if (garbage_collection_messages
)
5419 if (message_p
|| minibuf_level
> 0)
5422 message1_nolog ("Garbage collecting...done");
5425 unbind_to (count
, Qnil
);
5427 Lisp_Object total
[11];
5428 int total_size
= 10;
5430 total
[0] = list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5431 bounded_number (total_conses
),
5432 bounded_number (total_free_conses
));
5434 total
[1] = list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5435 bounded_number (total_symbols
),
5436 bounded_number (total_free_symbols
));
5438 total
[2] = list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5439 bounded_number (total_markers
),
5440 bounded_number (total_free_markers
));
5442 total
[3] = list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5443 bounded_number (total_strings
),
5444 bounded_number (total_free_strings
));
5446 total
[4] = list3 (Qstring_bytes
, make_number (1),
5447 bounded_number (total_string_bytes
));
5449 total
[5] = list3 (Qvectors
, make_number (sizeof (struct Lisp_Vector
)),
5450 bounded_number (total_vectors
));
5452 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5453 bounded_number (total_vector_slots
),
5454 bounded_number (total_free_vector_slots
));
5456 total
[7] = list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5457 bounded_number (total_floats
),
5458 bounded_number (total_free_floats
));
5460 total
[8] = list4 (Qintervals
, make_number (sizeof (struct interval
)),
5461 bounded_number (total_intervals
),
5462 bounded_number (total_free_intervals
));
5464 total
[9] = list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5465 bounded_number (total_buffers
));
5467 #ifdef DOUG_LEA_MALLOC
5469 total
[10] = list4 (Qheap
, make_number (1024),
5470 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5471 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10));
5473 retval
= Flist (total_size
, total
);
5476 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5478 /* Compute average percentage of zombies. */
5480 = (total_conses
+ total_symbols
+ total_markers
+ total_strings
5481 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5483 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5484 max_live
= max (nlive
, max_live
);
5485 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5486 max_zombies
= max (nzombies
, max_zombies
);
5491 if (!NILP (Vpost_gc_hook
))
5493 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5494 safe_run_hooks (Qpost_gc_hook
);
5495 unbind_to (gc_count
, Qnil
);
5498 /* Accumulate statistics. */
5499 if (FLOATP (Vgc_elapsed
))
5501 EMACS_TIME since_start
= sub_emacs_time (current_emacs_time (), start
);
5502 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5503 + EMACS_TIME_TO_DOUBLE (since_start
));
5508 /* Collect profiling data. */
5509 if (profiler_memory_running
)
5512 size_t tot_after
= total_bytes_of_live_objects ();
5513 if (tot_before
> tot_after
)
5514 swept
= tot_before
- tot_after
;
5515 malloc_probe (swept
);
5518 backtrace_list
= backtrace
.next
;
5523 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5524 only interesting objects referenced from glyphs are strings. */
5527 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5529 struct glyph_row
*row
= matrix
->rows
;
5530 struct glyph_row
*end
= row
+ matrix
->nrows
;
5532 for (; row
< end
; ++row
)
5536 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5538 struct glyph
*glyph
= row
->glyphs
[area
];
5539 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5541 for (; glyph
< end_glyph
; ++glyph
)
5542 if (STRINGP (glyph
->object
)
5543 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5544 mark_object (glyph
->object
);
5550 /* Mark Lisp faces in the face cache C. */
5553 mark_face_cache (struct face_cache
*c
)
5558 for (i
= 0; i
< c
->used
; ++i
)
5560 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5564 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5565 mark_object (face
->lface
[j
]);
5573 /* Mark reference to a Lisp_Object.
5574 If the object referred to has not been seen yet, recursively mark
5575 all the references contained in it. */
5577 #define LAST_MARKED_SIZE 500
5578 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5579 static int last_marked_index
;
5581 /* For debugging--call abort when we cdr down this many
5582 links of a list, in mark_object. In debugging,
5583 the call to abort will hit a breakpoint.
5584 Normally this is zero and the check never goes off. */
5585 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5588 mark_vectorlike (struct Lisp_Vector
*ptr
)
5590 ptrdiff_t size
= ptr
->header
.size
;
5593 eassert (!VECTOR_MARKED_P (ptr
));
5594 VECTOR_MARK (ptr
); /* Else mark it. */
5595 if (size
& PSEUDOVECTOR_FLAG
)
5596 size
&= PSEUDOVECTOR_SIZE_MASK
;
5598 /* Note that this size is not the memory-footprint size, but only
5599 the number of Lisp_Object fields that we should trace.
5600 The distinction is used e.g. by Lisp_Process which places extra
5601 non-Lisp_Object fields at the end of the structure... */
5602 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5603 mark_object (ptr
->contents
[i
]);
5606 /* Like mark_vectorlike but optimized for char-tables (and
5607 sub-char-tables) assuming that the contents are mostly integers or
5611 mark_char_table (struct Lisp_Vector
*ptr
)
5613 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5616 eassert (!VECTOR_MARKED_P (ptr
));
5618 for (i
= 0; i
< size
; i
++)
5620 Lisp_Object val
= ptr
->contents
[i
];
5622 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5624 if (SUB_CHAR_TABLE_P (val
))
5626 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5627 mark_char_table (XVECTOR (val
));
5634 /* Mark the chain of overlays starting at PTR. */
5637 mark_overlay (struct Lisp_Overlay
*ptr
)
5639 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5642 mark_object (ptr
->start
);
5643 mark_object (ptr
->end
);
5644 mark_object (ptr
->plist
);
5648 /* Mark Lisp_Objects and special pointers in BUFFER. */
5651 mark_buffer (struct buffer
*buffer
)
5653 /* This is handled much like other pseudovectors... */
5654 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5656 /* ...but there are some buffer-specific things. */
5658 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
5660 /* For now, we just don't mark the undo_list. It's done later in
5661 a special way just before the sweep phase, and after stripping
5662 some of its elements that are not needed any more. */
5664 mark_overlay (buffer
->overlays_before
);
5665 mark_overlay (buffer
->overlays_after
);
5667 /* If this is an indirect buffer, mark its base buffer. */
5668 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5669 mark_buffer (buffer
->base_buffer
);
5672 /* Remove killed buffers or items whose car is a killed buffer from
5673 LIST, and mark other items. Return changed LIST, which is marked. */
5676 mark_discard_killed_buffers (Lisp_Object list
)
5678 Lisp_Object tail
, *prev
= &list
;
5680 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
5683 Lisp_Object tem
= XCAR (tail
);
5686 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
5687 *prev
= XCDR (tail
);
5690 CONS_MARK (XCONS (tail
));
5691 mark_object (XCAR (tail
));
5692 prev
= &XCDR_AS_LVALUE (tail
);
5699 /* Determine type of generic Lisp_Object and mark it accordingly. */
5702 mark_object (Lisp_Object arg
)
5704 register Lisp_Object obj
= arg
;
5705 #ifdef GC_CHECK_MARKED_OBJECTS
5709 ptrdiff_t cdr_count
= 0;
5713 if (PURE_POINTER_P (XPNTR (obj
)))
5716 last_marked
[last_marked_index
++] = obj
;
5717 if (last_marked_index
== LAST_MARKED_SIZE
)
5718 last_marked_index
= 0;
5720 /* Perform some sanity checks on the objects marked here. Abort if
5721 we encounter an object we know is bogus. This increases GC time
5722 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5723 #ifdef GC_CHECK_MARKED_OBJECTS
5725 po
= (void *) XPNTR (obj
);
5727 /* Check that the object pointed to by PO is known to be a Lisp
5728 structure allocated from the heap. */
5729 #define CHECK_ALLOCATED() \
5731 m = mem_find (po); \
5736 /* Check that the object pointed to by PO is live, using predicate
5738 #define CHECK_LIVE(LIVEP) \
5740 if (!LIVEP (m, po)) \
5744 /* Check both of the above conditions. */
5745 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5747 CHECK_ALLOCATED (); \
5748 CHECK_LIVE (LIVEP); \
5751 #else /* not GC_CHECK_MARKED_OBJECTS */
5753 #define CHECK_LIVE(LIVEP) (void) 0
5754 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5756 #endif /* not GC_CHECK_MARKED_OBJECTS */
5758 switch (XTYPE (obj
))
5762 register struct Lisp_String
*ptr
= XSTRING (obj
);
5763 if (STRING_MARKED_P (ptr
))
5765 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5767 MARK_INTERVAL_TREE (ptr
->intervals
);
5768 #ifdef GC_CHECK_STRING_BYTES
5769 /* Check that the string size recorded in the string is the
5770 same as the one recorded in the sdata structure. */
5772 #endif /* GC_CHECK_STRING_BYTES */
5776 case Lisp_Vectorlike
:
5778 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5779 register ptrdiff_t pvectype
;
5781 if (VECTOR_MARKED_P (ptr
))
5784 #ifdef GC_CHECK_MARKED_OBJECTS
5786 if (m
== MEM_NIL
&& !SUBRP (obj
))
5788 #endif /* GC_CHECK_MARKED_OBJECTS */
5790 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
5791 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
5792 >> PSEUDOVECTOR_AREA_BITS
);
5794 pvectype
= PVEC_NORMAL_VECTOR
;
5796 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
5797 CHECK_LIVE (live_vector_p
);
5802 #ifdef GC_CHECK_MARKED_OBJECTS
5811 #endif /* GC_CHECK_MARKED_OBJECTS */
5812 mark_buffer ((struct buffer
*) ptr
);
5816 { /* We could treat this just like a vector, but it is better
5817 to save the COMPILED_CONSTANTS element for last and avoid
5819 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5823 for (i
= 0; i
< size
; i
++)
5824 if (i
!= COMPILED_CONSTANTS
)
5825 mark_object (ptr
->contents
[i
]);
5826 if (size
> COMPILED_CONSTANTS
)
5828 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5835 mark_vectorlike (ptr
);
5836 mark_face_cache (((struct frame
*) ptr
)->face_cache
);
5841 struct window
*w
= (struct window
*) ptr
;
5842 bool leaf
= NILP (w
->hchild
) && NILP (w
->vchild
);
5844 mark_vectorlike (ptr
);
5846 /* Mark glyphs for leaf windows. Marking window
5847 matrices is sufficient because frame matrices
5848 use the same glyph memory. */
5849 if (leaf
&& w
->current_matrix
)
5851 mark_glyph_matrix (w
->current_matrix
);
5852 mark_glyph_matrix (w
->desired_matrix
);
5855 /* Filter out killed buffers from both buffer lists
5856 in attempt to help GC to reclaim killed buffers faster.
5857 We can do it elsewhere for live windows, but this is the
5858 best place to do it for dead windows. */
5860 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
5862 (w
, mark_discard_killed_buffers (w
->next_buffers
));
5866 case PVEC_HASH_TABLE
:
5868 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
5870 mark_vectorlike (ptr
);
5871 mark_object (h
->test
.name
);
5872 mark_object (h
->test
.user_hash_function
);
5873 mark_object (h
->test
.user_cmp_function
);
5874 /* If hash table is not weak, mark all keys and values.
5875 For weak tables, mark only the vector. */
5877 mark_object (h
->key_and_value
);
5879 VECTOR_MARK (XVECTOR (h
->key_and_value
));
5883 case PVEC_CHAR_TABLE
:
5884 mark_char_table (ptr
);
5887 case PVEC_BOOL_VECTOR
:
5888 /* No Lisp_Objects to mark in a bool vector. */
5899 mark_vectorlike (ptr
);
5906 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
5907 struct Lisp_Symbol
*ptrx
;
5911 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
5913 mark_object (ptr
->function
);
5914 mark_object (ptr
->plist
);
5915 switch (ptr
->redirect
)
5917 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
5918 case SYMBOL_VARALIAS
:
5921 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
5925 case SYMBOL_LOCALIZED
:
5927 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5928 Lisp_Object where
= blv
->where
;
5929 /* If the value is set up for a killed buffer or deleted
5930 frame, restore it's global binding. If the value is
5931 forwarded to a C variable, either it's not a Lisp_Object
5932 var, or it's staticpro'd already. */
5933 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
5934 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
5935 swap_in_global_binding (ptr
);
5936 mark_object (blv
->where
);
5937 mark_object (blv
->valcell
);
5938 mark_object (blv
->defcell
);
5941 case SYMBOL_FORWARDED
:
5942 /* If the value is forwarded to a buffer or keyboard field,
5943 these are marked when we see the corresponding object.
5944 And if it's forwarded to a C variable, either it's not
5945 a Lisp_Object var, or it's staticpro'd already. */
5947 default: emacs_abort ();
5949 if (!PURE_POINTER_P (XSTRING (ptr
->name
)))
5950 MARK_STRING (XSTRING (ptr
->name
));
5951 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
5956 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
5957 XSETSYMBOL (obj
, ptrx
);
5964 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
5966 if (XMISCANY (obj
)->gcmarkbit
)
5969 switch (XMISCTYPE (obj
))
5971 case Lisp_Misc_Marker
:
5972 /* DO NOT mark thru the marker's chain.
5973 The buffer's markers chain does not preserve markers from gc;
5974 instead, markers are removed from the chain when freed by gc. */
5975 XMISCANY (obj
)->gcmarkbit
= 1;
5978 case Lisp_Misc_Save_Value
:
5979 XMISCANY (obj
)->gcmarkbit
= 1;
5981 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
5982 /* If `area' is nonzero, `data[0].pointer' is the address
5983 of a memory area containing `data[1].integer' potential
5988 Lisp_Object
*p
= ptr
->data
[0].pointer
;
5990 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
5991 mark_maybe_object (*p
);
5994 #endif /* GC_MARK_STACK */
5996 /* Find Lisp_Objects in `data[N]' slots and mark them. */
5997 if (ptr
->type0
== SAVE_OBJECT
)
5998 mark_object (ptr
->data
[0].object
);
5999 if (ptr
->type1
== SAVE_OBJECT
)
6000 mark_object (ptr
->data
[1].object
);
6001 if (ptr
->type2
== SAVE_OBJECT
)
6002 mark_object (ptr
->data
[2].object
);
6003 if (ptr
->type3
== SAVE_OBJECT
)
6004 mark_object (ptr
->data
[3].object
);
6009 case Lisp_Misc_Overlay
:
6010 mark_overlay (XOVERLAY (obj
));
6020 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6021 if (CONS_MARKED_P (ptr
))
6023 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6025 /* If the cdr is nil, avoid recursion for the car. */
6026 if (EQ (ptr
->u
.cdr
, Qnil
))
6032 mark_object (ptr
->car
);
6035 if (cdr_count
== mark_object_loop_halt
)
6041 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6042 FLOAT_MARK (XFLOAT (obj
));
6053 #undef CHECK_ALLOCATED
6054 #undef CHECK_ALLOCATED_AND_LIVE
6056 /* Mark the Lisp pointers in the terminal objects.
6057 Called by Fgarbage_collect. */
6060 mark_terminals (void)
6063 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6065 eassert (t
->name
!= NULL
);
6066 #ifdef HAVE_WINDOW_SYSTEM
6067 /* If a terminal object is reachable from a stacpro'ed object,
6068 it might have been marked already. Make sure the image cache
6070 mark_image_cache (t
->image_cache
);
6071 #endif /* HAVE_WINDOW_SYSTEM */
6072 if (!VECTOR_MARKED_P (t
))
6073 mark_vectorlike ((struct Lisp_Vector
*)t
);
6079 /* Value is non-zero if OBJ will survive the current GC because it's
6080 either marked or does not need to be marked to survive. */
6083 survives_gc_p (Lisp_Object obj
)
6087 switch (XTYPE (obj
))
6094 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6098 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6102 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6105 case Lisp_Vectorlike
:
6106 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6110 survives_p
= CONS_MARKED_P (XCONS (obj
));
6114 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6121 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6126 /* Sweep: find all structures not marked, and free them. */
6131 /* Remove or mark entries in weak hash tables.
6132 This must be done before any object is unmarked. */
6133 sweep_weak_hash_tables ();
6136 check_string_bytes (!noninteractive
);
6138 /* Put all unmarked conses on free list */
6140 register struct cons_block
*cblk
;
6141 struct cons_block
**cprev
= &cons_block
;
6142 register int lim
= cons_block_index
;
6143 EMACS_INT num_free
= 0, num_used
= 0;
6147 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6151 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6153 /* Scan the mark bits an int at a time. */
6154 for (i
= 0; i
< ilim
; i
++)
6156 if (cblk
->gcmarkbits
[i
] == -1)
6158 /* Fast path - all cons cells for this int are marked. */
6159 cblk
->gcmarkbits
[i
] = 0;
6160 num_used
+= BITS_PER_INT
;
6164 /* Some cons cells for this int are not marked.
6165 Find which ones, and free them. */
6166 int start
, pos
, stop
;
6168 start
= i
* BITS_PER_INT
;
6170 if (stop
> BITS_PER_INT
)
6171 stop
= BITS_PER_INT
;
6174 for (pos
= start
; pos
< stop
; pos
++)
6176 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6179 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6180 cons_free_list
= &cblk
->conses
[pos
];
6182 cons_free_list
->car
= Vdead
;
6188 CONS_UNMARK (&cblk
->conses
[pos
]);
6194 lim
= CONS_BLOCK_SIZE
;
6195 /* If this block contains only free conses and we have already
6196 seen more than two blocks worth of free conses then deallocate
6198 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6200 *cprev
= cblk
->next
;
6201 /* Unhook from the free list. */
6202 cons_free_list
= cblk
->conses
[0].u
.chain
;
6203 lisp_align_free (cblk
);
6207 num_free
+= this_free
;
6208 cprev
= &cblk
->next
;
6211 total_conses
= num_used
;
6212 total_free_conses
= num_free
;
6215 /* Put all unmarked floats on free list */
6217 register struct float_block
*fblk
;
6218 struct float_block
**fprev
= &float_block
;
6219 register int lim
= float_block_index
;
6220 EMACS_INT num_free
= 0, num_used
= 0;
6222 float_free_list
= 0;
6224 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6228 for (i
= 0; i
< lim
; i
++)
6229 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6232 fblk
->floats
[i
].u
.chain
= float_free_list
;
6233 float_free_list
= &fblk
->floats
[i
];
6238 FLOAT_UNMARK (&fblk
->floats
[i
]);
6240 lim
= FLOAT_BLOCK_SIZE
;
6241 /* If this block contains only free floats and we have already
6242 seen more than two blocks worth of free floats then deallocate
6244 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6246 *fprev
= fblk
->next
;
6247 /* Unhook from the free list. */
6248 float_free_list
= fblk
->floats
[0].u
.chain
;
6249 lisp_align_free (fblk
);
6253 num_free
+= this_free
;
6254 fprev
= &fblk
->next
;
6257 total_floats
= num_used
;
6258 total_free_floats
= num_free
;
6261 /* Put all unmarked intervals on free list */
6263 register struct interval_block
*iblk
;
6264 struct interval_block
**iprev
= &interval_block
;
6265 register int lim
= interval_block_index
;
6266 EMACS_INT num_free
= 0, num_used
= 0;
6268 interval_free_list
= 0;
6270 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6275 for (i
= 0; i
< lim
; i
++)
6277 if (!iblk
->intervals
[i
].gcmarkbit
)
6279 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6280 interval_free_list
= &iblk
->intervals
[i
];
6286 iblk
->intervals
[i
].gcmarkbit
= 0;
6289 lim
= INTERVAL_BLOCK_SIZE
;
6290 /* If this block contains only free intervals and we have already
6291 seen more than two blocks worth of free intervals then
6292 deallocate this block. */
6293 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6295 *iprev
= iblk
->next
;
6296 /* Unhook from the free list. */
6297 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6302 num_free
+= this_free
;
6303 iprev
= &iblk
->next
;
6306 total_intervals
= num_used
;
6307 total_free_intervals
= num_free
;
6310 /* Put all unmarked symbols on free list */
6312 register struct symbol_block
*sblk
;
6313 struct symbol_block
**sprev
= &symbol_block
;
6314 register int lim
= symbol_block_index
;
6315 EMACS_INT num_free
= 0, num_used
= 0;
6317 symbol_free_list
= NULL
;
6319 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6322 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6323 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6325 for (; sym
< end
; ++sym
)
6327 /* Check if the symbol was created during loadup. In such a case
6328 it might be pointed to by pure bytecode which we don't trace,
6329 so we conservatively assume that it is live. */
6330 bool pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.name
));
6332 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6334 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6335 xfree (SYMBOL_BLV (&sym
->s
));
6336 sym
->s
.next
= symbol_free_list
;
6337 symbol_free_list
= &sym
->s
;
6339 symbol_free_list
->function
= Vdead
;
6347 UNMARK_STRING (XSTRING (sym
->s
.name
));
6348 sym
->s
.gcmarkbit
= 0;
6352 lim
= SYMBOL_BLOCK_SIZE
;
6353 /* If this block contains only free symbols and we have already
6354 seen more than two blocks worth of free symbols then deallocate
6356 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6358 *sprev
= sblk
->next
;
6359 /* Unhook from the free list. */
6360 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6365 num_free
+= this_free
;
6366 sprev
= &sblk
->next
;
6369 total_symbols
= num_used
;
6370 total_free_symbols
= num_free
;
6373 /* Put all unmarked misc's on free list.
6374 For a marker, first unchain it from the buffer it points into. */
6376 register struct marker_block
*mblk
;
6377 struct marker_block
**mprev
= &marker_block
;
6378 register int lim
= marker_block_index
;
6379 EMACS_INT num_free
= 0, num_used
= 0;
6381 marker_free_list
= 0;
6383 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6388 for (i
= 0; i
< lim
; i
++)
6390 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6392 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6393 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6394 /* Set the type of the freed object to Lisp_Misc_Free.
6395 We could leave the type alone, since nobody checks it,
6396 but this might catch bugs faster. */
6397 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6398 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6399 marker_free_list
= &mblk
->markers
[i
].m
;
6405 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6408 lim
= MARKER_BLOCK_SIZE
;
6409 /* If this block contains only free markers and we have already
6410 seen more than two blocks worth of free markers then deallocate
6412 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6414 *mprev
= mblk
->next
;
6415 /* Unhook from the free list. */
6416 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6421 num_free
+= this_free
;
6422 mprev
= &mblk
->next
;
6426 total_markers
= num_used
;
6427 total_free_markers
= num_free
;
6430 /* Free all unmarked buffers */
6432 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6435 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6436 if (!VECTOR_MARKED_P (buffer
))
6438 *bprev
= buffer
->next
;
6443 VECTOR_UNMARK (buffer
);
6444 /* Do not use buffer_(set|get)_intervals here. */
6445 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6447 bprev
= &buffer
->next
;
6452 check_string_bytes (!noninteractive
);
6458 /* Debugging aids. */
6460 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6461 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6462 This may be helpful in debugging Emacs's memory usage.
6463 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6468 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6473 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6474 doc
: /* Return a list of counters that measure how much consing there has been.
6475 Each of these counters increments for a certain kind of object.
6476 The counters wrap around from the largest positive integer to zero.
6477 Garbage collection does not decrease them.
6478 The elements of the value are as follows:
6479 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6480 All are in units of 1 = one object consed
6481 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6483 MISCS include overlays, markers, and some internal types.
6484 Frames, windows, buffers, and subprocesses count as vectors
6485 (but the contents of a buffer's text do not count here). */)
6488 return listn (CONSTYPE_HEAP
, 8,
6489 bounded_number (cons_cells_consed
),
6490 bounded_number (floats_consed
),
6491 bounded_number (vector_cells_consed
),
6492 bounded_number (symbols_consed
),
6493 bounded_number (string_chars_consed
),
6494 bounded_number (misc_objects_consed
),
6495 bounded_number (intervals_consed
),
6496 bounded_number (strings_consed
));
6499 /* Find at most FIND_MAX symbols which have OBJ as their value or
6500 function. This is used in gdbinit's `xwhichsymbols' command. */
6503 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6505 struct symbol_block
*sblk
;
6506 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6507 Lisp_Object found
= Qnil
;
6511 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6513 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6516 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6518 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6522 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6525 XSETSYMBOL (tem
, sym
);
6526 val
= find_symbol_value (tem
);
6528 || EQ (sym
->function
, obj
)
6529 || (!NILP (sym
->function
)
6530 && COMPILEDP (sym
->function
)
6531 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6534 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6536 found
= Fcons (tem
, found
);
6537 if (--find_max
== 0)
6545 unbind_to (gc_count
, Qnil
);
6549 #ifdef ENABLE_CHECKING
6551 bool suppress_checking
;
6554 die (const char *msg
, const char *file
, int line
)
6556 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6558 terminate_due_to_signal (SIGABRT
, INT_MAX
);
6562 /* Initialization */
6565 init_alloc_once (void)
6567 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6569 pure_size
= PURESIZE
;
6571 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6573 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6576 #ifdef DOUG_LEA_MALLOC
6577 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6578 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6579 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6584 refill_memory_reserve ();
6585 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6592 byte_stack_list
= 0;
6594 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6595 setjmp_tested_p
= longjmps_done
= 0;
6598 Vgc_elapsed
= make_float (0.0);
6603 syms_of_alloc (void)
6605 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6606 doc
: /* Number of bytes of consing between garbage collections.
6607 Garbage collection can happen automatically once this many bytes have been
6608 allocated since the last garbage collection. All data types count.
6610 Garbage collection happens automatically only when `eval' is called.
6612 By binding this temporarily to a large number, you can effectively
6613 prevent garbage collection during a part of the program.
6614 See also `gc-cons-percentage'. */);
6616 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6617 doc
: /* Portion of the heap used for allocation.
6618 Garbage collection can happen automatically once this portion of the heap
6619 has been allocated since the last garbage collection.
6620 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6621 Vgc_cons_percentage
= make_float (0.1);
6623 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6624 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6626 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6627 doc
: /* Number of cons cells that have been consed so far. */);
6629 DEFVAR_INT ("floats-consed", floats_consed
,
6630 doc
: /* Number of floats that have been consed so far. */);
6632 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6633 doc
: /* Number of vector cells that have been consed so far. */);
6635 DEFVAR_INT ("symbols-consed", symbols_consed
,
6636 doc
: /* Number of symbols that have been consed so far. */);
6638 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6639 doc
: /* Number of string characters that have been consed so far. */);
6641 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6642 doc
: /* Number of miscellaneous objects that have been consed so far.
6643 These include markers and overlays, plus certain objects not visible
6646 DEFVAR_INT ("intervals-consed", intervals_consed
,
6647 doc
: /* Number of intervals that have been consed so far. */);
6649 DEFVAR_INT ("strings-consed", strings_consed
,
6650 doc
: /* Number of strings that have been consed so far. */);
6652 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6653 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6654 This means that certain objects should be allocated in shared (pure) space.
6655 It can also be set to a hash-table, in which case this table is used to
6656 do hash-consing of the objects allocated to pure space. */);
6658 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6659 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6660 garbage_collection_messages
= 0;
6662 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6663 doc
: /* Hook run after garbage collection has finished. */);
6664 Vpost_gc_hook
= Qnil
;
6665 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6667 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6668 doc
: /* Precomputed `signal' argument for memory-full error. */);
6669 /* We build this in advance because if we wait until we need it, we might
6670 not be able to allocate the memory to hold it. */
6672 = listn (CONSTYPE_PURE
, 2, Qerror
,
6673 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
6675 DEFVAR_LISP ("memory-full", Vmemory_full
,
6676 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6677 Vmemory_full
= Qnil
;
6679 DEFSYM (Qconses
, "conses");
6680 DEFSYM (Qsymbols
, "symbols");
6681 DEFSYM (Qmiscs
, "miscs");
6682 DEFSYM (Qstrings
, "strings");
6683 DEFSYM (Qvectors
, "vectors");
6684 DEFSYM (Qfloats
, "floats");
6685 DEFSYM (Qintervals
, "intervals");
6686 DEFSYM (Qbuffers
, "buffers");
6687 DEFSYM (Qstring_bytes
, "string-bytes");
6688 DEFSYM (Qvector_slots
, "vector-slots");
6689 DEFSYM (Qheap
, "heap");
6690 DEFSYM (Qautomatic_gc
, "Automatic GC");
6692 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6693 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6695 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6696 doc
: /* Accumulated time elapsed in garbage collections.
6697 The time is in seconds as a floating point value. */);
6698 DEFVAR_INT ("gcs-done", gcs_done
,
6699 doc
: /* Accumulated number of garbage collections done. */);
6704 defsubr (&Smake_byte_code
);
6705 defsubr (&Smake_list
);
6706 defsubr (&Smake_vector
);
6707 defsubr (&Smake_string
);
6708 defsubr (&Smake_bool_vector
);
6709 defsubr (&Smake_symbol
);
6710 defsubr (&Smake_marker
);
6711 defsubr (&Spurecopy
);
6712 defsubr (&Sgarbage_collect
);
6713 defsubr (&Smemory_limit
);
6714 defsubr (&Smemory_use_counts
);
6716 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6717 defsubr (&Sgc_status
);
6721 /* When compiled with GCC, GDB might say "No enum type named
6722 pvec_type" if we don't have at least one symbol with that type, and
6723 then xbacktrace could fail. Similarly for the other enums and
6724 their values. Some non-GCC compilers don't like these constructs. */
6728 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
6729 enum CHAR_TABLE_STANDARD_SLOTS CHAR_TABLE_STANDARD_SLOTS
;
6730 enum char_bits char_bits
;
6731 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
6732 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
6733 enum enum_USE_LSB_TAG enum_USE_LSB_TAG
;
6734 enum FLOAT_TO_STRING_BUFSIZE FLOAT_TO_STRING_BUFSIZE
;
6735 enum Lisp_Bits Lisp_Bits
;
6736 enum Lisp_Compiled Lisp_Compiled
;
6737 enum maxargs maxargs
;
6738 enum MAX_ALLOCA MAX_ALLOCA
;
6739 enum More_Lisp_Bits More_Lisp_Bits
;
6740 enum pvec_type pvec_type
;
6742 enum lsb_bits lsb_bits
;
6744 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
6745 #endif /* __GNUC__ */