1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2015 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/>. */
24 #include <limits.h> /* For CHAR_BIT. */
26 #ifdef ENABLE_CHECKING
27 #include <signal.h> /* For SIGABRT. */
35 #include "dispextern.h"
36 #include "intervals.h"
39 #include "character.h"
44 #include "blockinput.h"
45 #include "termhooks.h" /* For struct terminal. */
46 #ifdef HAVE_WINDOW_SYSTEM
48 #endif /* HAVE_WINDOW_SYSTEM */
51 #include <execinfo.h> /* For backtrace. */
53 #ifdef HAVE_LINUX_SYSINFO
54 #include <sys/sysinfo.h>
58 #include "dosfns.h" /* For dos_memory_info. */
61 #if (defined ENABLE_CHECKING \
62 && defined HAVE_VALGRIND_VALGRIND_H \
63 && !defined USE_VALGRIND)
64 # define USE_VALGRIND 1
68 #include <valgrind/valgrind.h>
69 #include <valgrind/memcheck.h>
70 static bool valgrind_p
;
73 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects. */
75 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
76 memory. Can do this only if using gmalloc.c and if not checking
79 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
80 || defined HYBRID_MALLOC || defined GC_CHECK_MARKED_OBJECTS)
81 #undef GC_MALLOC_CHECK
92 #include "w32heap.h" /* for sbrk */
95 #ifdef DOUG_LEA_MALLOC
99 /* Specify maximum number of areas to mmap. It would be nice to use a
100 value that explicitly means "no limit". */
102 #define MMAP_MAX_AREAS 100000000
104 #endif /* not DOUG_LEA_MALLOC */
106 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
107 to a struct Lisp_String. */
109 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
110 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
111 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
113 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
114 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
115 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
117 /* Default value of gc_cons_threshold (see below). */
119 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
121 /* Global variables. */
122 struct emacs_globals globals
;
124 /* Number of bytes of consing done since the last gc. */
126 EMACS_INT consing_since_gc
;
128 /* Similar minimum, computed from Vgc_cons_percentage. */
130 EMACS_INT gc_relative_threshold
;
132 /* Minimum number of bytes of consing since GC before next GC,
133 when memory is full. */
135 EMACS_INT memory_full_cons_threshold
;
137 /* True during GC. */
141 /* True means abort if try to GC.
142 This is for code which is written on the assumption that
143 no GC will happen, so as to verify that assumption. */
147 /* Number of live and free conses etc. */
149 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
150 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
151 static EMACS_INT total_free_floats
, total_floats
;
153 /* Points to memory space allocated as "spare", to be freed if we run
154 out of memory. We keep one large block, four cons-blocks, and
155 two string blocks. */
157 static char *spare_memory
[7];
159 /* Amount of spare memory to keep in large reserve block, or to see
160 whether this much is available when malloc fails on a larger request. */
162 #define SPARE_MEMORY (1 << 14)
164 /* Initialize it to a nonzero value to force it into data space
165 (rather than bss space). That way unexec will remap it into text
166 space (pure), on some systems. We have not implemented the
167 remapping on more recent systems because this is less important
168 nowadays than in the days of small memories and timesharing. */
170 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
171 #define PUREBEG (char *) pure
173 /* Pointer to the pure area, and its size. */
175 static char *purebeg
;
176 static ptrdiff_t pure_size
;
178 /* Number of bytes of pure storage used before pure storage overflowed.
179 If this is non-zero, this implies that an overflow occurred. */
181 static ptrdiff_t pure_bytes_used_before_overflow
;
183 /* Index in pure at which next pure Lisp object will be allocated.. */
185 static ptrdiff_t pure_bytes_used_lisp
;
187 /* Number of bytes allocated for non-Lisp objects in pure storage. */
189 static ptrdiff_t pure_bytes_used_non_lisp
;
191 /* If nonzero, this is a warning delivered by malloc and not yet
194 const char *pending_malloc_warning
;
196 #if 0 /* Normally, pointer sanity only on request... */
197 #ifdef ENABLE_CHECKING
198 #define SUSPICIOUS_OBJECT_CHECKING 1
202 /* ... but unconditionally use SUSPICIOUS_OBJECT_CHECKING while the GC
203 bug is unresolved. */
204 #define SUSPICIOUS_OBJECT_CHECKING 1
206 #ifdef SUSPICIOUS_OBJECT_CHECKING
207 struct suspicious_free_record
209 void *suspicious_object
;
210 void *backtrace
[128];
212 static void *suspicious_objects
[32];
213 static int suspicious_object_index
;
214 struct suspicious_free_record suspicious_free_history
[64] EXTERNALLY_VISIBLE
;
215 static int suspicious_free_history_index
;
216 /* Find the first currently-monitored suspicious pointer in range
217 [begin,end) or NULL if no such pointer exists. */
218 static void *find_suspicious_object_in_range (void *begin
, void *end
);
219 static void detect_suspicious_free (void *ptr
);
221 # define find_suspicious_object_in_range(begin, end) NULL
222 # define detect_suspicious_free(ptr) (void)
225 /* Maximum amount of C stack to save when a GC happens. */
227 #ifndef MAX_SAVE_STACK
228 #define MAX_SAVE_STACK 16000
231 /* Buffer in which we save a copy of the C stack at each GC. */
233 #if MAX_SAVE_STACK > 0
234 static char *stack_copy
;
235 static ptrdiff_t stack_copy_size
;
237 /* Copy to DEST a block of memory from SRC of size SIZE bytes,
238 avoiding any address sanitization. */
240 static void * ATTRIBUTE_NO_SANITIZE_ADDRESS
241 no_sanitize_memcpy (void *dest
, void const *src
, size_t size
)
243 if (! ADDRESS_SANITIZER
)
244 return memcpy (dest
, src
, size
);
250 for (i
= 0; i
< size
; i
++)
256 #endif /* MAX_SAVE_STACK > 0 */
258 static void mark_terminals (void);
259 static void gc_sweep (void);
260 static Lisp_Object
make_pure_vector (ptrdiff_t);
261 static void mark_buffer (struct buffer
*);
263 #if !defined REL_ALLOC || defined SYSTEM_MALLOC || defined HYBRID_MALLOC
264 static void refill_memory_reserve (void);
266 static void compact_small_strings (void);
267 static void free_large_strings (void);
268 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
270 /* When scanning the C stack for live Lisp objects, Emacs keeps track of
271 what memory allocated via lisp_malloc and lisp_align_malloc is intended
272 for what purpose. This enumeration specifies the type of memory. */
283 /* Since all non-bool pseudovectors are small enough to be
284 allocated from vector blocks, this memory type denotes
285 large regular vectors and large bool pseudovectors. */
287 /* Special type to denote vector blocks. */
288 MEM_TYPE_VECTOR_BLOCK
,
289 /* Special type to denote reserved memory. */
293 /* A unique object in pure space used to make some Lisp objects
294 on free lists recognizable in O(1). */
296 static Lisp_Object Vdead
;
297 #define DEADP(x) EQ (x, Vdead)
299 #ifdef GC_MALLOC_CHECK
301 enum mem_type allocated_mem_type
;
303 #endif /* GC_MALLOC_CHECK */
305 /* A node in the red-black tree describing allocated memory containing
306 Lisp data. Each such block is recorded with its start and end
307 address when it is allocated, and removed from the tree when it
310 A red-black tree is a balanced binary tree with the following
313 1. Every node is either red or black.
314 2. Every leaf is black.
315 3. If a node is red, then both of its children are black.
316 4. Every simple path from a node to a descendant leaf contains
317 the same number of black nodes.
318 5. The root is always black.
320 When nodes are inserted into the tree, or deleted from the tree,
321 the tree is "fixed" so that these properties are always true.
323 A red-black tree with N internal nodes has height at most 2
324 log(N+1). Searches, insertions and deletions are done in O(log N).
325 Please see a text book about data structures for a detailed
326 description of red-black trees. Any book worth its salt should
331 /* Children of this node. These pointers are never NULL. When there
332 is no child, the value is MEM_NIL, which points to a dummy node. */
333 struct mem_node
*left
, *right
;
335 /* The parent of this node. In the root node, this is NULL. */
336 struct mem_node
*parent
;
338 /* Start and end of allocated region. */
342 enum {MEM_BLACK
, MEM_RED
} color
;
348 /* Base address of stack. Set in main. */
350 Lisp_Object
*stack_base
;
352 /* Root of the tree describing allocated Lisp memory. */
354 static struct mem_node
*mem_root
;
356 /* Lowest and highest known address in the heap. */
358 static void *min_heap_address
, *max_heap_address
;
360 /* Sentinel node of the tree. */
362 static struct mem_node mem_z
;
363 #define MEM_NIL &mem_z
365 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
366 static void mem_insert_fixup (struct mem_node
*);
367 static void mem_rotate_left (struct mem_node
*);
368 static void mem_rotate_right (struct mem_node
*);
369 static void mem_delete (struct mem_node
*);
370 static void mem_delete_fixup (struct mem_node
*);
371 static struct mem_node
*mem_find (void *);
377 /* Addresses of staticpro'd variables. Initialize it to a nonzero
378 value; otherwise some compilers put it into BSS. */
380 enum { NSTATICS
= 2048 };
381 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
383 /* Index of next unused slot in staticvec. */
385 static int staticidx
;
387 static void *pure_alloc (size_t, int);
389 /* Return X rounded to the next multiple of Y. Arguments should not
390 have side effects, as they are evaluated more than once. Assume X
391 + Y - 1 does not overflow. Tune for Y being a power of 2. */
393 #define ROUNDUP(x, y) ((y) & ((y) - 1) \
394 ? ((x) + (y) - 1) - ((x) + (y) - 1) % (y) \
395 : ((x) + (y) - 1) & ~ ((y) - 1))
397 /* Return PTR rounded up to the next multiple of ALIGNMENT. */
400 ALIGN (void *ptr
, int alignment
)
402 return (void *) ROUNDUP ((uintptr_t) ptr
, alignment
);
405 /* Extract the pointer hidden within A, if A is not a symbol.
406 If A is a symbol, extract the hidden pointer's offset from lispsym,
407 converted to void *. */
410 XPNTR_OR_SYMBOL_OFFSET (Lisp_Object a
)
412 intptr_t i
= USE_LSB_TAG
? XLI (a
) - XTYPE (a
) : XLI (a
) & VALMASK
;
416 /* Extract the pointer hidden within A. */
419 XPNTR (Lisp_Object a
)
421 void *p
= XPNTR_OR_SYMBOL_OFFSET (a
);
423 p
= (intptr_t) p
+ (char *) lispsym
;
428 XFLOAT_INIT (Lisp_Object f
, double n
)
430 XFLOAT (f
)->u
.data
= n
;
434 pointers_fit_in_lispobj_p (void)
436 return (UINTPTR_MAX
<= VAL_MAX
) || USE_LSB_TAG
;
440 mmap_lisp_allowed_p (void)
442 /* If we can't store all memory addresses in our lisp objects, it's
443 risky to let the heap use mmap and give us addresses from all
444 over our address space. We also can't use mmap for lisp objects
445 if we might dump: unexec doesn't preserve the contents of mmapped
447 return pointers_fit_in_lispobj_p () && !might_dump
;
450 /* Head of a circularly-linked list of extant finalizers. */
451 static struct Lisp_Finalizer finalizers
;
453 /* Head of a circularly-linked list of finalizers that must be invoked
454 because we deemed them unreachable. This list must be global, and
455 not a local inside garbage_collect_1, in case we GC again while
456 running finalizers. */
457 static struct Lisp_Finalizer doomed_finalizers
;
460 /************************************************************************
462 ************************************************************************/
464 /* Function malloc calls this if it finds we are near exhausting storage. */
467 malloc_warning (const char *str
)
469 pending_malloc_warning
= str
;
473 /* Display an already-pending malloc warning. */
476 display_malloc_warning (void)
478 call3 (intern ("display-warning"),
480 build_string (pending_malloc_warning
),
481 intern ("emergency"));
482 pending_malloc_warning
= 0;
485 /* Called if we can't allocate relocatable space for a buffer. */
488 buffer_memory_full (ptrdiff_t nbytes
)
490 /* If buffers use the relocating allocator, no need to free
491 spare_memory, because we may have plenty of malloc space left
492 that we could get, and if we don't, the malloc that fails will
493 itself cause spare_memory to be freed. If buffers don't use the
494 relocating allocator, treat this like any other failing
498 memory_full (nbytes
);
500 /* This used to call error, but if we've run out of memory, we could
501 get infinite recursion trying to build the string. */
502 xsignal (Qnil
, Vmemory_signal_data
);
506 /* A common multiple of the positive integers A and B. Ideally this
507 would be the least common multiple, but there's no way to do that
508 as a constant expression in C, so do the best that we can easily do. */
509 #define COMMON_MULTIPLE(a, b) \
510 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
512 #ifndef XMALLOC_OVERRUN_CHECK
513 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
516 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
519 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
520 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
521 block size in little-endian order. The trailer consists of
522 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
524 The header is used to detect whether this block has been allocated
525 through these functions, as some low-level libc functions may
526 bypass the malloc hooks. */
528 #define XMALLOC_OVERRUN_CHECK_SIZE 16
529 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
530 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
532 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
533 hold a size_t value and (2) the header size is a multiple of the
534 alignment that Emacs needs for C types and for USE_LSB_TAG. */
535 #define XMALLOC_BASE_ALIGNMENT alignof (max_align_t)
537 #define XMALLOC_HEADER_ALIGNMENT \
538 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
539 #define XMALLOC_OVERRUN_SIZE_SIZE \
540 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
541 + XMALLOC_HEADER_ALIGNMENT - 1) \
542 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
543 - XMALLOC_OVERRUN_CHECK_SIZE)
545 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
546 { '\x9a', '\x9b', '\xae', '\xaf',
547 '\xbf', '\xbe', '\xce', '\xcf',
548 '\xea', '\xeb', '\xec', '\xed',
549 '\xdf', '\xde', '\x9c', '\x9d' };
551 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
552 { '\xaa', '\xab', '\xac', '\xad',
553 '\xba', '\xbb', '\xbc', '\xbd',
554 '\xca', '\xcb', '\xcc', '\xcd',
555 '\xda', '\xdb', '\xdc', '\xdd' };
557 /* Insert and extract the block size in the header. */
560 xmalloc_put_size (unsigned char *ptr
, size_t size
)
563 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
565 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
571 xmalloc_get_size (unsigned char *ptr
)
575 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
576 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
585 /* Like malloc, but wraps allocated block with header and trailer. */
588 overrun_check_malloc (size_t size
)
590 register unsigned char *val
;
591 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
594 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
597 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
598 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
599 xmalloc_put_size (val
, size
);
600 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
601 XMALLOC_OVERRUN_CHECK_SIZE
);
607 /* Like realloc, but checks old block for overrun, and wraps new block
608 with header and trailer. */
611 overrun_check_realloc (void *block
, size_t size
)
613 register unsigned char *val
= (unsigned char *) block
;
614 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
618 && memcmp (xmalloc_overrun_check_header
,
619 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
620 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
622 size_t osize
= xmalloc_get_size (val
);
623 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
624 XMALLOC_OVERRUN_CHECK_SIZE
))
626 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
627 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
628 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
631 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
635 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
636 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
637 xmalloc_put_size (val
, size
);
638 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
639 XMALLOC_OVERRUN_CHECK_SIZE
);
644 /* Like free, but checks block for overrun. */
647 overrun_check_free (void *block
)
649 unsigned char *val
= (unsigned char *) block
;
652 && memcmp (xmalloc_overrun_check_header
,
653 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
654 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
656 size_t osize
= xmalloc_get_size (val
);
657 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
658 XMALLOC_OVERRUN_CHECK_SIZE
))
660 #ifdef XMALLOC_CLEAR_FREE_MEMORY
661 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
662 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
664 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
665 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
666 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
676 #define malloc overrun_check_malloc
677 #define realloc overrun_check_realloc
678 #define free overrun_check_free
681 /* If compiled with XMALLOC_BLOCK_INPUT_CHECK, define a symbol
682 BLOCK_INPUT_IN_MEMORY_ALLOCATORS that is visible to the debugger.
683 If that variable is set, block input while in one of Emacs's memory
684 allocation functions. There should be no need for this debugging
685 option, since signal handlers do not allocate memory, but Emacs
686 formerly allocated memory in signal handlers and this compile-time
687 option remains as a way to help debug the issue should it rear its
689 #ifdef XMALLOC_BLOCK_INPUT_CHECK
690 bool block_input_in_memory_allocators EXTERNALLY_VISIBLE
;
692 malloc_block_input (void)
694 if (block_input_in_memory_allocators
)
698 malloc_unblock_input (void)
700 if (block_input_in_memory_allocators
)
703 # define MALLOC_BLOCK_INPUT malloc_block_input ()
704 # define MALLOC_UNBLOCK_INPUT malloc_unblock_input ()
706 # define MALLOC_BLOCK_INPUT ((void) 0)
707 # define MALLOC_UNBLOCK_INPUT ((void) 0)
710 #define MALLOC_PROBE(size) \
712 if (profiler_memory_running) \
713 malloc_probe (size); \
717 /* Like malloc but check for no memory and block interrupt input.. */
720 xmalloc (size_t size
)
726 MALLOC_UNBLOCK_INPUT
;
734 /* Like the above, but zeroes out the memory just allocated. */
737 xzalloc (size_t size
)
743 MALLOC_UNBLOCK_INPUT
;
747 memset (val
, 0, size
);
752 /* Like realloc but check for no memory and block interrupt input.. */
755 xrealloc (void *block
, size_t size
)
760 /* We must call malloc explicitly when BLOCK is 0, since some
761 reallocs don't do this. */
765 val
= realloc (block
, size
);
766 MALLOC_UNBLOCK_INPUT
;
775 /* Like free but block interrupt input. */
784 MALLOC_UNBLOCK_INPUT
;
785 /* We don't call refill_memory_reserve here
786 because in practice the call in r_alloc_free seems to suffice. */
790 /* Other parts of Emacs pass large int values to allocator functions
791 expecting ptrdiff_t. This is portable in practice, but check it to
793 verify (INT_MAX
<= PTRDIFF_MAX
);
796 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
797 Signal an error on memory exhaustion, and block interrupt input. */
800 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
802 eassert (0 <= nitems
&& 0 < item_size
);
803 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
804 memory_full (SIZE_MAX
);
805 return xmalloc (nitems
* item_size
);
809 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
810 Signal an error on memory exhaustion, and block interrupt input. */
813 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
815 eassert (0 <= nitems
&& 0 < item_size
);
816 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
817 memory_full (SIZE_MAX
);
818 return xrealloc (pa
, nitems
* item_size
);
822 /* Grow PA, which points to an array of *NITEMS items, and return the
823 location of the reallocated array, updating *NITEMS to reflect its
824 new size. The new array will contain at least NITEMS_INCR_MIN more
825 items, but will not contain more than NITEMS_MAX items total.
826 ITEM_SIZE is the size of each item, in bytes.
828 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
829 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
832 If PA is null, then allocate a new array instead of reallocating
835 Block interrupt input as needed. If memory exhaustion occurs, set
836 *NITEMS to zero if PA is null, and signal an error (i.e., do not
839 Thus, to grow an array A without saving its old contents, do
840 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
841 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
842 and signals an error, and later this code is reexecuted and
843 attempts to free A. */
846 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
847 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
849 /* The approximate size to use for initial small allocation
850 requests. This is the largest "small" request for the GNU C
852 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
854 /* If the array is tiny, grow it to about (but no greater than)
855 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
856 ptrdiff_t n
= *nitems
;
857 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
858 ptrdiff_t half_again
= n
>> 1;
859 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
861 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
862 NITEMS_MAX, and what the C language can represent safely. */
863 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
864 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
865 ? nitems_max
: C_language_max
);
866 ptrdiff_t nitems_incr_max
= n_max
- n
;
867 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
869 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
872 if (nitems_incr_max
< incr
)
873 memory_full (SIZE_MAX
);
875 pa
= xrealloc (pa
, n
* item_size
);
881 /* Like strdup, but uses xmalloc. */
884 xstrdup (const char *s
)
888 size
= strlen (s
) + 1;
889 return memcpy (xmalloc (size
), s
, size
);
892 /* Like above, but duplicates Lisp string to C string. */
895 xlispstrdup (Lisp_Object string
)
897 ptrdiff_t size
= SBYTES (string
) + 1;
898 return memcpy (xmalloc (size
), SSDATA (string
), size
);
901 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
902 pointed to. If STRING is null, assign it without copying anything.
903 Allocate before freeing, to avoid a dangling pointer if allocation
907 dupstring (char **ptr
, char const *string
)
910 *ptr
= string
? xstrdup (string
) : 0;
915 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
916 argument is a const pointer. */
919 xputenv (char const *string
)
921 if (putenv ((char *) string
) != 0)
925 /* Return a newly allocated memory block of SIZE bytes, remembering
926 to free it when unwinding. */
928 record_xmalloc (size_t size
)
930 void *p
= xmalloc (size
);
931 record_unwind_protect_ptr (xfree
, p
);
936 /* Like malloc but used for allocating Lisp data. NBYTES is the
937 number of bytes to allocate, TYPE describes the intended use of the
938 allocated memory block (for strings, for conses, ...). */
941 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
945 lisp_malloc (size_t nbytes
, enum mem_type type
)
951 #ifdef GC_MALLOC_CHECK
952 allocated_mem_type
= type
;
955 val
= malloc (nbytes
);
958 /* If the memory just allocated cannot be addressed thru a Lisp
959 object's pointer, and it needs to be,
960 that's equivalent to running out of memory. */
961 if (val
&& type
!= MEM_TYPE_NON_LISP
)
964 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
965 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
967 lisp_malloc_loser
= val
;
974 #ifndef GC_MALLOC_CHECK
975 if (val
&& type
!= MEM_TYPE_NON_LISP
)
976 mem_insert (val
, (char *) val
+ nbytes
, type
);
979 MALLOC_UNBLOCK_INPUT
;
981 memory_full (nbytes
);
982 MALLOC_PROBE (nbytes
);
986 /* Free BLOCK. This must be called to free memory allocated with a
987 call to lisp_malloc. */
990 lisp_free (void *block
)
994 #ifndef GC_MALLOC_CHECK
995 mem_delete (mem_find (block
));
997 MALLOC_UNBLOCK_INPUT
;
1000 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
1002 /* The entry point is lisp_align_malloc which returns blocks of at most
1003 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
1005 /* Use aligned_alloc if it or a simple substitute is available.
1006 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
1007 clang 3.3 anyway. */
1009 #if ! ADDRESS_SANITIZER
1010 # if !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC
1011 # define USE_ALIGNED_ALLOC 1
1012 /* Defined in gmalloc.c. */
1013 void *aligned_alloc (size_t, size_t);
1014 # elif defined HYBRID_MALLOC
1015 # if defined ALIGNED_ALLOC || defined HAVE_POSIX_MEMALIGN
1016 # define USE_ALIGNED_ALLOC 1
1017 # define aligned_alloc hybrid_aligned_alloc
1018 /* Defined in gmalloc.c. */
1019 void *aligned_alloc (size_t, size_t);
1021 # elif defined HAVE_ALIGNED_ALLOC
1022 # define USE_ALIGNED_ALLOC 1
1023 # elif defined HAVE_POSIX_MEMALIGN
1024 # define USE_ALIGNED_ALLOC 1
1026 aligned_alloc (size_t alignment
, size_t size
)
1029 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
1034 /* BLOCK_ALIGN has to be a power of 2. */
1035 #define BLOCK_ALIGN (1 << 10)
1037 /* Padding to leave at the end of a malloc'd block. This is to give
1038 malloc a chance to minimize the amount of memory wasted to alignment.
1039 It should be tuned to the particular malloc library used.
1040 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
1041 aligned_alloc on the other hand would ideally prefer a value of 4
1042 because otherwise, there's 1020 bytes wasted between each ablocks.
1043 In Emacs, testing shows that those 1020 can most of the time be
1044 efficiently used by malloc to place other objects, so a value of 0 can
1045 still preferable unless you have a lot of aligned blocks and virtually
1047 #define BLOCK_PADDING 0
1048 #define BLOCK_BYTES \
1049 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1051 /* Internal data structures and constants. */
1053 #define ABLOCKS_SIZE 16
1055 /* An aligned block of memory. */
1060 char payload
[BLOCK_BYTES
];
1061 struct ablock
*next_free
;
1063 /* `abase' is the aligned base of the ablocks. */
1064 /* It is overloaded to hold the virtual `busy' field that counts
1065 the number of used ablock in the parent ablocks.
1066 The first ablock has the `busy' field, the others have the `abase'
1067 field. To tell the difference, we assume that pointers will have
1068 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1069 is used to tell whether the real base of the parent ablocks is `abase'
1070 (if not, the word before the first ablock holds a pointer to the
1072 struct ablocks
*abase
;
1073 /* The padding of all but the last ablock is unused. The padding of
1074 the last ablock in an ablocks is not allocated. */
1076 char padding
[BLOCK_PADDING
];
1080 /* A bunch of consecutive aligned blocks. */
1083 struct ablock blocks
[ABLOCKS_SIZE
];
1086 /* Size of the block requested from malloc or aligned_alloc. */
1087 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1089 #define ABLOCK_ABASE(block) \
1090 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1091 ? (struct ablocks *)(block) \
1094 /* Virtual `busy' field. */
1095 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1097 /* Pointer to the (not necessarily aligned) malloc block. */
1098 #ifdef USE_ALIGNED_ALLOC
1099 #define ABLOCKS_BASE(abase) (abase)
1101 #define ABLOCKS_BASE(abase) \
1102 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1105 /* The list of free ablock. */
1106 static struct ablock
*free_ablock
;
1108 /* Allocate an aligned block of nbytes.
1109 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1110 smaller or equal to BLOCK_BYTES. */
1112 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1115 struct ablocks
*abase
;
1117 eassert (nbytes
<= BLOCK_BYTES
);
1121 #ifdef GC_MALLOC_CHECK
1122 allocated_mem_type
= type
;
1128 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1130 #ifdef DOUG_LEA_MALLOC
1131 if (!mmap_lisp_allowed_p ())
1132 mallopt (M_MMAP_MAX
, 0);
1135 #ifdef USE_ALIGNED_ALLOC
1136 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1138 base
= malloc (ABLOCKS_BYTES
);
1139 abase
= ALIGN (base
, BLOCK_ALIGN
);
1144 MALLOC_UNBLOCK_INPUT
;
1145 memory_full (ABLOCKS_BYTES
);
1148 aligned
= (base
== abase
);
1150 ((void **) abase
)[-1] = base
;
1152 #ifdef DOUG_LEA_MALLOC
1153 if (!mmap_lisp_allowed_p ())
1154 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1158 /* If the memory just allocated cannot be addressed thru a Lisp
1159 object's pointer, and it needs to be, that's equivalent to
1160 running out of memory. */
1161 if (type
!= MEM_TYPE_NON_LISP
)
1164 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1165 XSETCONS (tem
, end
);
1166 if ((char *) XCONS (tem
) != end
)
1168 lisp_malloc_loser
= base
;
1170 MALLOC_UNBLOCK_INPUT
;
1171 memory_full (SIZE_MAX
);
1176 /* Initialize the blocks and put them on the free list.
1177 If `base' was not properly aligned, we can't use the last block. */
1178 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1180 abase
->blocks
[i
].abase
= abase
;
1181 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1182 free_ablock
= &abase
->blocks
[i
];
1184 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1186 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1187 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1188 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1189 eassert (ABLOCKS_BASE (abase
) == base
);
1190 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1193 abase
= ABLOCK_ABASE (free_ablock
);
1194 ABLOCKS_BUSY (abase
)
1195 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1197 free_ablock
= free_ablock
->x
.next_free
;
1199 #ifndef GC_MALLOC_CHECK
1200 if (type
!= MEM_TYPE_NON_LISP
)
1201 mem_insert (val
, (char *) val
+ nbytes
, type
);
1204 MALLOC_UNBLOCK_INPUT
;
1206 MALLOC_PROBE (nbytes
);
1208 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1213 lisp_align_free (void *block
)
1215 struct ablock
*ablock
= block
;
1216 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1219 #ifndef GC_MALLOC_CHECK
1220 mem_delete (mem_find (block
));
1222 /* Put on free list. */
1223 ablock
->x
.next_free
= free_ablock
;
1224 free_ablock
= ablock
;
1225 /* Update busy count. */
1226 ABLOCKS_BUSY (abase
)
1227 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1229 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1230 { /* All the blocks are free. */
1231 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1232 struct ablock
**tem
= &free_ablock
;
1233 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1237 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1240 *tem
= (*tem
)->x
.next_free
;
1243 tem
= &(*tem
)->x
.next_free
;
1245 eassert ((aligned
& 1) == aligned
);
1246 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1247 #ifdef USE_POSIX_MEMALIGN
1248 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1250 free (ABLOCKS_BASE (abase
));
1252 MALLOC_UNBLOCK_INPUT
;
1256 /***********************************************************************
1258 ***********************************************************************/
1260 /* Number of intervals allocated in an interval_block structure.
1261 The 1020 is 1024 minus malloc overhead. */
1263 #define INTERVAL_BLOCK_SIZE \
1264 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1266 /* Intervals are allocated in chunks in the form of an interval_block
1269 struct interval_block
1271 /* Place `intervals' first, to preserve alignment. */
1272 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1273 struct interval_block
*next
;
1276 /* Current interval block. Its `next' pointer points to older
1279 static struct interval_block
*interval_block
;
1281 /* Index in interval_block above of the next unused interval
1284 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1286 /* Number of free and live intervals. */
1288 static EMACS_INT total_free_intervals
, total_intervals
;
1290 /* List of free intervals. */
1292 static INTERVAL interval_free_list
;
1294 /* Return a new interval. */
1297 make_interval (void)
1303 if (interval_free_list
)
1305 val
= interval_free_list
;
1306 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1310 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1312 struct interval_block
*newi
1313 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1315 newi
->next
= interval_block
;
1316 interval_block
= newi
;
1317 interval_block_index
= 0;
1318 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1320 val
= &interval_block
->intervals
[interval_block_index
++];
1323 MALLOC_UNBLOCK_INPUT
;
1325 consing_since_gc
+= sizeof (struct interval
);
1327 total_free_intervals
--;
1328 RESET_INTERVAL (val
);
1334 /* Mark Lisp objects in interval I. */
1337 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1339 /* Intervals should never be shared. So, if extra internal checking is
1340 enabled, GC aborts if it seems to have visited an interval twice. */
1341 eassert (!i
->gcmarkbit
);
1343 mark_object (i
->plist
);
1346 /* Mark the interval tree rooted in I. */
1348 #define MARK_INTERVAL_TREE(i) \
1350 if (i && !i->gcmarkbit) \
1351 traverse_intervals_noorder (i, mark_interval, Qnil); \
1354 /***********************************************************************
1356 ***********************************************************************/
1358 /* Lisp_Strings are allocated in string_block structures. When a new
1359 string_block is allocated, all the Lisp_Strings it contains are
1360 added to a free-list string_free_list. When a new Lisp_String is
1361 needed, it is taken from that list. During the sweep phase of GC,
1362 string_blocks that are entirely free are freed, except two which
1365 String data is allocated from sblock structures. Strings larger
1366 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1367 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1369 Sblocks consist internally of sdata structures, one for each
1370 Lisp_String. The sdata structure points to the Lisp_String it
1371 belongs to. The Lisp_String points back to the `u.data' member of
1372 its sdata structure.
1374 When a Lisp_String is freed during GC, it is put back on
1375 string_free_list, and its `data' member and its sdata's `string'
1376 pointer is set to null. The size of the string is recorded in the
1377 `n.nbytes' member of the sdata. So, sdata structures that are no
1378 longer used, can be easily recognized, and it's easy to compact the
1379 sblocks of small strings which we do in compact_small_strings. */
1381 /* Size in bytes of an sblock structure used for small strings. This
1382 is 8192 minus malloc overhead. */
1384 #define SBLOCK_SIZE 8188
1386 /* Strings larger than this are considered large strings. String data
1387 for large strings is allocated from individual sblocks. */
1389 #define LARGE_STRING_BYTES 1024
1391 /* The SDATA typedef is a struct or union describing string memory
1392 sub-allocated from an sblock. This is where the contents of Lisp
1393 strings are stored. */
1397 /* Back-pointer to the string this sdata belongs to. If null, this
1398 structure is free, and NBYTES (in this structure or in the union below)
1399 contains the string's byte size (the same value that STRING_BYTES
1400 would return if STRING were non-null). If non-null, STRING_BYTES
1401 (STRING) is the size of the data, and DATA contains the string's
1403 struct Lisp_String
*string
;
1405 #ifdef GC_CHECK_STRING_BYTES
1409 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1412 #ifdef GC_CHECK_STRING_BYTES
1414 typedef struct sdata sdata
;
1415 #define SDATA_NBYTES(S) (S)->nbytes
1416 #define SDATA_DATA(S) (S)->data
1422 struct Lisp_String
*string
;
1424 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1425 which has a flexible array member. However, if implemented by
1426 giving this union a member of type 'struct sdata', the union
1427 could not be the last (flexible) member of 'struct sblock',
1428 because C99 prohibits a flexible array member from having a type
1429 that is itself a flexible array. So, comment this member out here,
1430 but remember that the option's there when using this union. */
1435 /* When STRING is null. */
1438 struct Lisp_String
*string
;
1443 #define SDATA_NBYTES(S) (S)->n.nbytes
1444 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1446 #endif /* not GC_CHECK_STRING_BYTES */
1448 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1450 /* Structure describing a block of memory which is sub-allocated to
1451 obtain string data memory for strings. Blocks for small strings
1452 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1453 as large as needed. */
1458 struct sblock
*next
;
1460 /* Pointer to the next free sdata block. This points past the end
1461 of the sblock if there isn't any space left in this block. */
1465 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1468 /* Number of Lisp strings in a string_block structure. The 1020 is
1469 1024 minus malloc overhead. */
1471 #define STRING_BLOCK_SIZE \
1472 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1474 /* Structure describing a block from which Lisp_String structures
1479 /* Place `strings' first, to preserve alignment. */
1480 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1481 struct string_block
*next
;
1484 /* Head and tail of the list of sblock structures holding Lisp string
1485 data. We always allocate from current_sblock. The NEXT pointers
1486 in the sblock structures go from oldest_sblock to current_sblock. */
1488 static struct sblock
*oldest_sblock
, *current_sblock
;
1490 /* List of sblocks for large strings. */
1492 static struct sblock
*large_sblocks
;
1494 /* List of string_block structures. */
1496 static struct string_block
*string_blocks
;
1498 /* Free-list of Lisp_Strings. */
1500 static struct Lisp_String
*string_free_list
;
1502 /* Number of live and free Lisp_Strings. */
1504 static EMACS_INT total_strings
, total_free_strings
;
1506 /* Number of bytes used by live strings. */
1508 static EMACS_INT total_string_bytes
;
1510 /* Given a pointer to a Lisp_String S which is on the free-list
1511 string_free_list, return a pointer to its successor in the
1514 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1516 /* Return a pointer to the sdata structure belonging to Lisp string S.
1517 S must be live, i.e. S->data must not be null. S->data is actually
1518 a pointer to the `u.data' member of its sdata structure; the
1519 structure starts at a constant offset in front of that. */
1521 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1524 #ifdef GC_CHECK_STRING_OVERRUN
1526 /* We check for overrun in string data blocks by appending a small
1527 "cookie" after each allocated string data block, and check for the
1528 presence of this cookie during GC. */
1530 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1531 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1532 { '\xde', '\xad', '\xbe', '\xef' };
1535 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1538 /* Value is the size of an sdata structure large enough to hold NBYTES
1539 bytes of string data. The value returned includes a terminating
1540 NUL byte, the size of the sdata structure, and padding. */
1542 #ifdef GC_CHECK_STRING_BYTES
1544 #define SDATA_SIZE(NBYTES) \
1545 ((SDATA_DATA_OFFSET \
1547 + sizeof (ptrdiff_t) - 1) \
1548 & ~(sizeof (ptrdiff_t) - 1))
1550 #else /* not GC_CHECK_STRING_BYTES */
1552 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1553 less than the size of that member. The 'max' is not needed when
1554 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1555 alignment code reserves enough space. */
1557 #define SDATA_SIZE(NBYTES) \
1558 ((SDATA_DATA_OFFSET \
1559 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1561 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1563 + sizeof (ptrdiff_t) - 1) \
1564 & ~(sizeof (ptrdiff_t) - 1))
1566 #endif /* not GC_CHECK_STRING_BYTES */
1568 /* Extra bytes to allocate for each string. */
1570 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1572 /* Exact bound on the number of bytes in a string, not counting the
1573 terminating null. A string cannot contain more bytes than
1574 STRING_BYTES_BOUND, nor can it be so long that the size_t
1575 arithmetic in allocate_string_data would overflow while it is
1576 calculating a value to be passed to malloc. */
1577 static ptrdiff_t const STRING_BYTES_MAX
=
1578 min (STRING_BYTES_BOUND
,
1579 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1581 - offsetof (struct sblock
, data
)
1582 - SDATA_DATA_OFFSET
)
1583 & ~(sizeof (EMACS_INT
) - 1)));
1585 /* Initialize string allocation. Called from init_alloc_once. */
1590 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1591 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1595 #ifdef GC_CHECK_STRING_BYTES
1597 static int check_string_bytes_count
;
1599 /* Like STRING_BYTES, but with debugging check. Can be
1600 called during GC, so pay attention to the mark bit. */
1603 string_bytes (struct Lisp_String
*s
)
1606 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1608 if (!PURE_P (s
) && s
->data
&& nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1613 /* Check validity of Lisp strings' string_bytes member in B. */
1616 check_sblock (struct sblock
*b
)
1618 sdata
*from
, *end
, *from_end
;
1622 for (from
= b
->data
; from
< end
; from
= from_end
)
1624 /* Compute the next FROM here because copying below may
1625 overwrite data we need to compute it. */
1628 /* Check that the string size recorded in the string is the
1629 same as the one recorded in the sdata structure. */
1630 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1631 : SDATA_NBYTES (from
));
1632 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1637 /* Check validity of Lisp strings' string_bytes member. ALL_P
1638 means check all strings, otherwise check only most
1639 recently allocated strings. Used for hunting a bug. */
1642 check_string_bytes (bool all_p
)
1648 for (b
= large_sblocks
; b
; b
= b
->next
)
1650 struct Lisp_String
*s
= b
->data
[0].string
;
1655 for (b
= oldest_sblock
; b
; b
= b
->next
)
1658 else if (current_sblock
)
1659 check_sblock (current_sblock
);
1662 #else /* not GC_CHECK_STRING_BYTES */
1664 #define check_string_bytes(all) ((void) 0)
1666 #endif /* GC_CHECK_STRING_BYTES */
1668 #ifdef GC_CHECK_STRING_FREE_LIST
1670 /* Walk through the string free list looking for bogus next pointers.
1671 This may catch buffer overrun from a previous string. */
1674 check_string_free_list (void)
1676 struct Lisp_String
*s
;
1678 /* Pop a Lisp_String off the free-list. */
1679 s
= string_free_list
;
1682 if ((uintptr_t) s
< 1024)
1684 s
= NEXT_FREE_LISP_STRING (s
);
1688 #define check_string_free_list()
1691 /* Return a new Lisp_String. */
1693 static struct Lisp_String
*
1694 allocate_string (void)
1696 struct Lisp_String
*s
;
1700 /* If the free-list is empty, allocate a new string_block, and
1701 add all the Lisp_Strings in it to the free-list. */
1702 if (string_free_list
== NULL
)
1704 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1707 b
->next
= string_blocks
;
1710 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1713 /* Every string on a free list should have NULL data pointer. */
1715 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1716 string_free_list
= s
;
1719 total_free_strings
+= STRING_BLOCK_SIZE
;
1722 check_string_free_list ();
1724 /* Pop a Lisp_String off the free-list. */
1725 s
= string_free_list
;
1726 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1728 MALLOC_UNBLOCK_INPUT
;
1730 --total_free_strings
;
1733 consing_since_gc
+= sizeof *s
;
1735 #ifdef GC_CHECK_STRING_BYTES
1736 if (!noninteractive
)
1738 if (++check_string_bytes_count
== 200)
1740 check_string_bytes_count
= 0;
1741 check_string_bytes (1);
1744 check_string_bytes (0);
1746 #endif /* GC_CHECK_STRING_BYTES */
1752 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1753 plus a NUL byte at the end. Allocate an sdata structure for S, and
1754 set S->data to its `u.data' member. Store a NUL byte at the end of
1755 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1756 S->data if it was initially non-null. */
1759 allocate_string_data (struct Lisp_String
*s
,
1760 EMACS_INT nchars
, EMACS_INT nbytes
)
1762 sdata
*data
, *old_data
;
1764 ptrdiff_t needed
, old_nbytes
;
1766 if (STRING_BYTES_MAX
< nbytes
)
1769 /* Determine the number of bytes needed to store NBYTES bytes
1771 needed
= SDATA_SIZE (nbytes
);
1774 old_data
= SDATA_OF_STRING (s
);
1775 old_nbytes
= STRING_BYTES (s
);
1782 if (nbytes
> LARGE_STRING_BYTES
)
1784 size_t size
= offsetof (struct sblock
, data
) + needed
;
1786 #ifdef DOUG_LEA_MALLOC
1787 if (!mmap_lisp_allowed_p ())
1788 mallopt (M_MMAP_MAX
, 0);
1791 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1793 #ifdef DOUG_LEA_MALLOC
1794 if (!mmap_lisp_allowed_p ())
1795 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1798 b
->next_free
= b
->data
;
1799 b
->data
[0].string
= NULL
;
1800 b
->next
= large_sblocks
;
1803 else if (current_sblock
== NULL
1804 || (((char *) current_sblock
+ SBLOCK_SIZE
1805 - (char *) current_sblock
->next_free
)
1806 < (needed
+ GC_STRING_EXTRA
)))
1808 /* Not enough room in the current sblock. */
1809 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1810 b
->next_free
= b
->data
;
1811 b
->data
[0].string
= NULL
;
1815 current_sblock
->next
= b
;
1823 data
= b
->next_free
;
1824 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1826 MALLOC_UNBLOCK_INPUT
;
1829 s
->data
= SDATA_DATA (data
);
1830 #ifdef GC_CHECK_STRING_BYTES
1831 SDATA_NBYTES (data
) = nbytes
;
1834 s
->size_byte
= nbytes
;
1835 s
->data
[nbytes
] = '\0';
1836 #ifdef GC_CHECK_STRING_OVERRUN
1837 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1838 GC_STRING_OVERRUN_COOKIE_SIZE
);
1841 /* Note that Faset may call to this function when S has already data
1842 assigned. In this case, mark data as free by setting it's string
1843 back-pointer to null, and record the size of the data in it. */
1846 SDATA_NBYTES (old_data
) = old_nbytes
;
1847 old_data
->string
= NULL
;
1850 consing_since_gc
+= needed
;
1854 /* Sweep and compact strings. */
1856 NO_INLINE
/* For better stack traces */
1858 sweep_strings (void)
1860 struct string_block
*b
, *next
;
1861 struct string_block
*live_blocks
= NULL
;
1863 string_free_list
= NULL
;
1864 total_strings
= total_free_strings
= 0;
1865 total_string_bytes
= 0;
1867 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1868 for (b
= string_blocks
; b
; b
= next
)
1871 struct Lisp_String
*free_list_before
= string_free_list
;
1875 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1877 struct Lisp_String
*s
= b
->strings
+ i
;
1881 /* String was not on free-list before. */
1882 if (STRING_MARKED_P (s
))
1884 /* String is live; unmark it and its intervals. */
1887 /* Do not use string_(set|get)_intervals here. */
1888 s
->intervals
= balance_intervals (s
->intervals
);
1891 total_string_bytes
+= STRING_BYTES (s
);
1895 /* String is dead. Put it on the free-list. */
1896 sdata
*data
= SDATA_OF_STRING (s
);
1898 /* Save the size of S in its sdata so that we know
1899 how large that is. Reset the sdata's string
1900 back-pointer so that we know it's free. */
1901 #ifdef GC_CHECK_STRING_BYTES
1902 if (string_bytes (s
) != SDATA_NBYTES (data
))
1905 data
->n
.nbytes
= STRING_BYTES (s
);
1907 data
->string
= NULL
;
1909 /* Reset the strings's `data' member so that we
1913 /* Put the string on the free-list. */
1914 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1915 string_free_list
= s
;
1921 /* S was on the free-list before. Put it there again. */
1922 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1923 string_free_list
= s
;
1928 /* Free blocks that contain free Lisp_Strings only, except
1929 the first two of them. */
1930 if (nfree
== STRING_BLOCK_SIZE
1931 && total_free_strings
> STRING_BLOCK_SIZE
)
1934 string_free_list
= free_list_before
;
1938 total_free_strings
+= nfree
;
1939 b
->next
= live_blocks
;
1944 check_string_free_list ();
1946 string_blocks
= live_blocks
;
1947 free_large_strings ();
1948 compact_small_strings ();
1950 check_string_free_list ();
1954 /* Free dead large strings. */
1957 free_large_strings (void)
1959 struct sblock
*b
, *next
;
1960 struct sblock
*live_blocks
= NULL
;
1962 for (b
= large_sblocks
; b
; b
= next
)
1966 if (b
->data
[0].string
== NULL
)
1970 b
->next
= live_blocks
;
1975 large_sblocks
= live_blocks
;
1979 /* Compact data of small strings. Free sblocks that don't contain
1980 data of live strings after compaction. */
1983 compact_small_strings (void)
1985 struct sblock
*b
, *tb
, *next
;
1986 sdata
*from
, *to
, *end
, *tb_end
;
1987 sdata
*to_end
, *from_end
;
1989 /* TB is the sblock we copy to, TO is the sdata within TB we copy
1990 to, and TB_END is the end of TB. */
1992 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1995 /* Step through the blocks from the oldest to the youngest. We
1996 expect that old blocks will stabilize over time, so that less
1997 copying will happen this way. */
1998 for (b
= oldest_sblock
; b
; b
= b
->next
)
2001 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2003 for (from
= b
->data
; from
< end
; from
= from_end
)
2005 /* Compute the next FROM here because copying below may
2006 overwrite data we need to compute it. */
2008 struct Lisp_String
*s
= from
->string
;
2010 #ifdef GC_CHECK_STRING_BYTES
2011 /* Check that the string size recorded in the string is the
2012 same as the one recorded in the sdata structure. */
2013 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2015 #endif /* GC_CHECK_STRING_BYTES */
2017 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2018 eassert (nbytes
<= LARGE_STRING_BYTES
);
2020 nbytes
= SDATA_SIZE (nbytes
);
2021 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2023 #ifdef GC_CHECK_STRING_OVERRUN
2024 if (memcmp (string_overrun_cookie
,
2025 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2026 GC_STRING_OVERRUN_COOKIE_SIZE
))
2030 /* Non-NULL S means it's alive. Copy its data. */
2033 /* If TB is full, proceed with the next sblock. */
2034 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2035 if (to_end
> tb_end
)
2039 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2041 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2044 /* Copy, and update the string's `data' pointer. */
2047 eassert (tb
!= b
|| to
< from
);
2048 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2049 to
->string
->data
= SDATA_DATA (to
);
2052 /* Advance past the sdata we copied to. */
2058 /* The rest of the sblocks following TB don't contain live data, so
2059 we can free them. */
2060 for (b
= tb
->next
; b
; b
= next
)
2068 current_sblock
= tb
;
2072 string_overflow (void)
2074 error ("Maximum string size exceeded");
2077 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2078 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2079 LENGTH must be an integer.
2080 INIT must be an integer that represents a character. */)
2081 (Lisp_Object length
, Lisp_Object init
)
2083 register Lisp_Object val
;
2087 CHECK_NATNUM (length
);
2088 CHECK_CHARACTER (init
);
2090 c
= XFASTINT (init
);
2091 if (ASCII_CHAR_P (c
))
2093 nbytes
= XINT (length
);
2094 val
= make_uninit_string (nbytes
);
2095 memset (SDATA (val
), c
, nbytes
);
2096 SDATA (val
)[nbytes
] = 0;
2100 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2101 ptrdiff_t len
= CHAR_STRING (c
, str
);
2102 EMACS_INT string_len
= XINT (length
);
2103 unsigned char *p
, *beg
, *end
;
2105 if (string_len
> STRING_BYTES_MAX
/ len
)
2107 nbytes
= len
* string_len
;
2108 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2109 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2111 /* First time we just copy `str' to the data of `val'. */
2113 memcpy (p
, str
, len
);
2116 /* Next time we copy largest possible chunk from
2117 initialized to uninitialized part of `val'. */
2118 len
= min (p
- beg
, end
- p
);
2119 memcpy (p
, beg
, len
);
2128 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2132 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2134 EMACS_INT nbits
= bool_vector_size (a
);
2137 unsigned char *data
= bool_vector_uchar_data (a
);
2138 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2139 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2140 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2141 memset (data
, pattern
, nbytes
- 1);
2142 data
[nbytes
- 1] = pattern
& last_mask
;
2147 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2150 make_uninit_bool_vector (EMACS_INT nbits
)
2153 EMACS_INT words
= bool_vector_words (nbits
);
2154 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2155 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2158 struct Lisp_Bool_Vector
*p
2159 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2160 XSETVECTOR (val
, p
);
2161 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2164 /* Clear padding at the end. */
2166 p
->data
[words
- 1] = 0;
2171 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2172 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2173 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2174 (Lisp_Object length
, Lisp_Object init
)
2178 CHECK_NATNUM (length
);
2179 val
= make_uninit_bool_vector (XFASTINT (length
));
2180 return bool_vector_fill (val
, init
);
2183 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2184 doc
: /* Return a new bool-vector with specified arguments as elements.
2185 Any number of arguments, even zero arguments, are allowed.
2186 usage: (bool-vector &rest OBJECTS) */)
2187 (ptrdiff_t nargs
, Lisp_Object
*args
)
2192 vector
= make_uninit_bool_vector (nargs
);
2193 for (i
= 0; i
< nargs
; i
++)
2194 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2199 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2200 of characters from the contents. This string may be unibyte or
2201 multibyte, depending on the contents. */
2204 make_string (const char *contents
, ptrdiff_t nbytes
)
2206 register Lisp_Object val
;
2207 ptrdiff_t nchars
, multibyte_nbytes
;
2209 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2210 &nchars
, &multibyte_nbytes
);
2211 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2212 /* CONTENTS contains no multibyte sequences or contains an invalid
2213 multibyte sequence. We must make unibyte string. */
2214 val
= make_unibyte_string (contents
, nbytes
);
2216 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2220 /* Make a unibyte string from LENGTH bytes at CONTENTS. */
2223 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2225 register Lisp_Object val
;
2226 val
= make_uninit_string (length
);
2227 memcpy (SDATA (val
), contents
, length
);
2232 /* Make a multibyte string from NCHARS characters occupying NBYTES
2233 bytes at CONTENTS. */
2236 make_multibyte_string (const char *contents
,
2237 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2239 register Lisp_Object val
;
2240 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2241 memcpy (SDATA (val
), contents
, nbytes
);
2246 /* Make a string from NCHARS characters occupying NBYTES bytes at
2247 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2250 make_string_from_bytes (const char *contents
,
2251 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2253 register Lisp_Object val
;
2254 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2255 memcpy (SDATA (val
), contents
, nbytes
);
2256 if (SBYTES (val
) == SCHARS (val
))
2257 STRING_SET_UNIBYTE (val
);
2262 /* Make a string from NCHARS characters occupying NBYTES bytes at
2263 CONTENTS. The argument MULTIBYTE controls whether to label the
2264 string as multibyte. If NCHARS is negative, it counts the number of
2265 characters by itself. */
2268 make_specified_string (const char *contents
,
2269 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2276 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2281 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2282 memcpy (SDATA (val
), contents
, nbytes
);
2284 STRING_SET_UNIBYTE (val
);
2289 /* Return a unibyte Lisp_String set up to hold LENGTH characters
2290 occupying LENGTH bytes. */
2293 make_uninit_string (EMACS_INT length
)
2298 return empty_unibyte_string
;
2299 val
= make_uninit_multibyte_string (length
, length
);
2300 STRING_SET_UNIBYTE (val
);
2305 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2306 which occupy NBYTES bytes. */
2309 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2312 struct Lisp_String
*s
;
2317 return empty_multibyte_string
;
2319 s
= allocate_string ();
2320 s
->intervals
= NULL
;
2321 allocate_string_data (s
, nchars
, nbytes
);
2322 XSETSTRING (string
, s
);
2323 string_chars_consed
+= nbytes
;
2327 /* Print arguments to BUF according to a FORMAT, then return
2328 a Lisp_String initialized with the data from BUF. */
2331 make_formatted_string (char *buf
, const char *format
, ...)
2336 va_start (ap
, format
);
2337 length
= vsprintf (buf
, format
, ap
);
2339 return make_string (buf
, length
);
2343 /***********************************************************************
2345 ***********************************************************************/
2347 /* We store float cells inside of float_blocks, allocating a new
2348 float_block with malloc whenever necessary. Float cells reclaimed
2349 by GC are put on a free list to be reallocated before allocating
2350 any new float cells from the latest float_block. */
2352 #define FLOAT_BLOCK_SIZE \
2353 (((BLOCK_BYTES - sizeof (struct float_block *) \
2354 /* The compiler might add padding at the end. */ \
2355 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2356 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2358 #define GETMARKBIT(block,n) \
2359 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2360 >> ((n) % BITS_PER_BITS_WORD)) \
2363 #define SETMARKBIT(block,n) \
2364 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2365 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2367 #define UNSETMARKBIT(block,n) \
2368 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2369 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2371 #define FLOAT_BLOCK(fptr) \
2372 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2374 #define FLOAT_INDEX(fptr) \
2375 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2379 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2380 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2381 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2382 struct float_block
*next
;
2385 #define FLOAT_MARKED_P(fptr) \
2386 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2388 #define FLOAT_MARK(fptr) \
2389 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2391 #define FLOAT_UNMARK(fptr) \
2392 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2394 /* Current float_block. */
2396 static struct float_block
*float_block
;
2398 /* Index of first unused Lisp_Float in the current float_block. */
2400 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2402 /* Free-list of Lisp_Floats. */
2404 static struct Lisp_Float
*float_free_list
;
2406 /* Return a new float object with value FLOAT_VALUE. */
2409 make_float (double float_value
)
2411 register Lisp_Object val
;
2415 if (float_free_list
)
2417 /* We use the data field for chaining the free list
2418 so that we won't use the same field that has the mark bit. */
2419 XSETFLOAT (val
, float_free_list
);
2420 float_free_list
= float_free_list
->u
.chain
;
2424 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2426 struct float_block
*new
2427 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2428 new->next
= float_block
;
2429 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2431 float_block_index
= 0;
2432 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2434 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2435 float_block_index
++;
2438 MALLOC_UNBLOCK_INPUT
;
2440 XFLOAT_INIT (val
, float_value
);
2441 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2442 consing_since_gc
+= sizeof (struct Lisp_Float
);
2444 total_free_floats
--;
2450 /***********************************************************************
2452 ***********************************************************************/
2454 /* We store cons cells inside of cons_blocks, allocating a new
2455 cons_block with malloc whenever necessary. Cons cells reclaimed by
2456 GC are put on a free list to be reallocated before allocating
2457 any new cons cells from the latest cons_block. */
2459 #define CONS_BLOCK_SIZE \
2460 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2461 /* The compiler might add padding at the end. */ \
2462 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2463 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2465 #define CONS_BLOCK(fptr) \
2466 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2468 #define CONS_INDEX(fptr) \
2469 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2473 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2474 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2475 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2476 struct cons_block
*next
;
2479 #define CONS_MARKED_P(fptr) \
2480 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2482 #define CONS_MARK(fptr) \
2483 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2485 #define CONS_UNMARK(fptr) \
2486 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2488 /* Current cons_block. */
2490 static struct cons_block
*cons_block
;
2492 /* Index of first unused Lisp_Cons in the current block. */
2494 static int cons_block_index
= CONS_BLOCK_SIZE
;
2496 /* Free-list of Lisp_Cons structures. */
2498 static struct Lisp_Cons
*cons_free_list
;
2500 /* Explicitly free a cons cell by putting it on the free-list. */
2503 free_cons (struct Lisp_Cons
*ptr
)
2505 ptr
->u
.chain
= cons_free_list
;
2507 cons_free_list
= ptr
;
2508 consing_since_gc
-= sizeof *ptr
;
2509 total_free_conses
++;
2512 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2513 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2514 (Lisp_Object car
, Lisp_Object cdr
)
2516 register Lisp_Object val
;
2522 /* We use the cdr for chaining the free list
2523 so that we won't use the same field that has the mark bit. */
2524 XSETCONS (val
, cons_free_list
);
2525 cons_free_list
= cons_free_list
->u
.chain
;
2529 if (cons_block_index
== CONS_BLOCK_SIZE
)
2531 struct cons_block
*new
2532 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2533 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2534 new->next
= cons_block
;
2536 cons_block_index
= 0;
2537 total_free_conses
+= CONS_BLOCK_SIZE
;
2539 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2543 MALLOC_UNBLOCK_INPUT
;
2547 eassert (!CONS_MARKED_P (XCONS (val
)));
2548 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2549 total_free_conses
--;
2550 cons_cells_consed
++;
2554 #ifdef GC_CHECK_CONS_LIST
2555 /* Get an error now if there's any junk in the cons free list. */
2557 check_cons_list (void)
2559 struct Lisp_Cons
*tail
= cons_free_list
;
2562 tail
= tail
->u
.chain
;
2566 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2569 list1 (Lisp_Object arg1
)
2571 return Fcons (arg1
, Qnil
);
2575 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2577 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2582 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2584 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2589 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2591 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2596 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2598 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2599 Fcons (arg5
, Qnil
)))));
2602 /* Make a list of COUNT Lisp_Objects, where ARG is the
2603 first one. Allocate conses from pure space if TYPE
2604 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2607 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2609 Lisp_Object (*cons
) (Lisp_Object
, Lisp_Object
);
2612 case CONSTYPE_PURE
: cons
= pure_cons
; break;
2613 case CONSTYPE_HEAP
: cons
= Fcons
; break;
2614 default: emacs_abort ();
2617 eassume (0 < count
);
2618 Lisp_Object val
= cons (arg
, Qnil
);
2619 Lisp_Object tail
= val
;
2623 for (ptrdiff_t i
= 1; i
< count
; i
++)
2625 Lisp_Object elem
= cons (va_arg (ap
, Lisp_Object
), Qnil
);
2626 XSETCDR (tail
, elem
);
2634 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2635 doc
: /* Return a newly created list with specified arguments as elements.
2636 Any number of arguments, even zero arguments, are allowed.
2637 usage: (list &rest OBJECTS) */)
2638 (ptrdiff_t nargs
, Lisp_Object
*args
)
2640 register Lisp_Object val
;
2646 val
= Fcons (args
[nargs
], val
);
2652 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2653 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2654 (register Lisp_Object length
, Lisp_Object init
)
2656 register Lisp_Object val
;
2657 register EMACS_INT size
;
2659 CHECK_NATNUM (length
);
2660 size
= XFASTINT (length
);
2665 val
= Fcons (init
, val
);
2670 val
= Fcons (init
, val
);
2675 val
= Fcons (init
, val
);
2680 val
= Fcons (init
, val
);
2685 val
= Fcons (init
, val
);
2700 /***********************************************************************
2702 ***********************************************************************/
2704 /* Sometimes a vector's contents are merely a pointer internally used
2705 in vector allocation code. On the rare platforms where a null
2706 pointer cannot be tagged, represent it with a Lisp 0.
2707 Usually you don't want to touch this. */
2709 static struct Lisp_Vector
*
2710 next_vector (struct Lisp_Vector
*v
)
2712 return XUNTAG (v
->contents
[0], Lisp_Int0
);
2716 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2718 v
->contents
[0] = make_lisp_ptr (p
, Lisp_Int0
);
2721 /* This value is balanced well enough to avoid too much internal overhead
2722 for the most common cases; it's not required to be a power of two, but
2723 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2725 #define VECTOR_BLOCK_SIZE 4096
2729 /* Alignment of struct Lisp_Vector objects. */
2730 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2733 /* Vector size requests are a multiple of this. */
2734 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2737 /* Verify assumptions described above. */
2738 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2739 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2741 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2742 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2743 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2744 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2746 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2748 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2750 /* Size of the minimal vector allocated from block. */
2752 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2754 /* Size of the largest vector allocated from block. */
2756 #define VBLOCK_BYTES_MAX \
2757 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2759 /* We maintain one free list for each possible block-allocated
2760 vector size, and this is the number of free lists we have. */
2762 #define VECTOR_MAX_FREE_LIST_INDEX \
2763 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2765 /* Common shortcut to advance vector pointer over a block data. */
2767 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2769 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2771 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2773 /* Common shortcut to setup vector on a free list. */
2775 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2777 (tmp) = ((nbytes - header_size) / word_size); \
2778 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2779 eassert ((nbytes) % roundup_size == 0); \
2780 (tmp) = VINDEX (nbytes); \
2781 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2782 set_next_vector (v, vector_free_lists[tmp]); \
2783 vector_free_lists[tmp] = (v); \
2784 total_free_vector_slots += (nbytes) / word_size; \
2787 /* This internal type is used to maintain the list of large vectors
2788 which are allocated at their own, e.g. outside of vector blocks.
2790 struct large_vector itself cannot contain a struct Lisp_Vector, as
2791 the latter contains a flexible array member and C99 does not allow
2792 such structs to be nested. Instead, each struct large_vector
2793 object LV is followed by a struct Lisp_Vector, which is at offset
2794 large_vector_offset from LV, and whose address is therefore
2795 large_vector_vec (&LV). */
2799 struct large_vector
*next
;
2804 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2807 static struct Lisp_Vector
*
2808 large_vector_vec (struct large_vector
*p
)
2810 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
2813 /* This internal type is used to maintain an underlying storage
2814 for small vectors. */
2818 char data
[VECTOR_BLOCK_BYTES
];
2819 struct vector_block
*next
;
2822 /* Chain of vector blocks. */
2824 static struct vector_block
*vector_blocks
;
2826 /* Vector free lists, where NTH item points to a chain of free
2827 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2829 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2831 /* Singly-linked list of large vectors. */
2833 static struct large_vector
*large_vectors
;
2835 /* The only vector with 0 slots, allocated from pure space. */
2837 Lisp_Object zero_vector
;
2839 /* Number of live vectors. */
2841 static EMACS_INT total_vectors
;
2843 /* Total size of live and free vectors, in Lisp_Object units. */
2845 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2847 /* Get a new vector block. */
2849 static struct vector_block
*
2850 allocate_vector_block (void)
2852 struct vector_block
*block
= xmalloc (sizeof *block
);
2854 #ifndef GC_MALLOC_CHECK
2855 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2856 MEM_TYPE_VECTOR_BLOCK
);
2859 block
->next
= vector_blocks
;
2860 vector_blocks
= block
;
2864 /* Called once to initialize vector allocation. */
2869 zero_vector
= make_pure_vector (0);
2872 /* Allocate vector from a vector block. */
2874 static struct Lisp_Vector
*
2875 allocate_vector_from_block (size_t nbytes
)
2877 struct Lisp_Vector
*vector
;
2878 struct vector_block
*block
;
2879 size_t index
, restbytes
;
2881 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2882 eassert (nbytes
% roundup_size
== 0);
2884 /* First, try to allocate from a free list
2885 containing vectors of the requested size. */
2886 index
= VINDEX (nbytes
);
2887 if (vector_free_lists
[index
])
2889 vector
= vector_free_lists
[index
];
2890 vector_free_lists
[index
] = next_vector (vector
);
2891 total_free_vector_slots
-= nbytes
/ word_size
;
2895 /* Next, check free lists containing larger vectors. Since
2896 we will split the result, we should have remaining space
2897 large enough to use for one-slot vector at least. */
2898 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
2899 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
2900 if (vector_free_lists
[index
])
2902 /* This vector is larger than requested. */
2903 vector
= vector_free_lists
[index
];
2904 vector_free_lists
[index
] = next_vector (vector
);
2905 total_free_vector_slots
-= nbytes
/ word_size
;
2907 /* Excess bytes are used for the smaller vector,
2908 which should be set on an appropriate free list. */
2909 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
2910 eassert (restbytes
% roundup_size
== 0);
2911 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2915 /* Finally, need a new vector block. */
2916 block
= allocate_vector_block ();
2918 /* New vector will be at the beginning of this block. */
2919 vector
= (struct Lisp_Vector
*) block
->data
;
2921 /* If the rest of space from this block is large enough
2922 for one-slot vector at least, set up it on a free list. */
2923 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
2924 if (restbytes
>= VBLOCK_BYTES_MIN
)
2926 eassert (restbytes
% roundup_size
== 0);
2927 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2932 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
2934 #define VECTOR_IN_BLOCK(vector, block) \
2935 ((char *) (vector) <= (block)->data \
2936 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
2938 /* Return the memory footprint of V in bytes. */
2941 vector_nbytes (struct Lisp_Vector
*v
)
2943 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
2946 if (size
& PSEUDOVECTOR_FLAG
)
2948 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
2950 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
2951 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
2952 * sizeof (bits_word
));
2953 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
2954 verify (header_size
<= bool_header_size
);
2955 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
2958 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
2959 + ((size
& PSEUDOVECTOR_REST_MASK
)
2960 >> PSEUDOVECTOR_SIZE_BITS
));
2964 return vroundup (header_size
+ word_size
* nwords
);
2967 /* Release extra resources still in use by VECTOR, which may be any
2968 vector-like object. For now, this is used just to free data in
2972 cleanup_vector (struct Lisp_Vector
*vector
)
2974 detect_suspicious_free (vector
);
2975 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
2976 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
2977 == FONT_OBJECT_MAX
))
2979 struct font_driver
*drv
= ((struct font
*) vector
)->driver
;
2981 /* The font driver might sometimes be NULL, e.g. if Emacs was
2982 interrupted before it had time to set it up. */
2985 /* Attempt to catch subtle bugs like Bug#16140. */
2986 eassert (valid_font_driver (drv
));
2987 drv
->close ((struct font
*) vector
);
2992 /* Reclaim space used by unmarked vectors. */
2994 NO_INLINE
/* For better stack traces */
2996 sweep_vectors (void)
2998 struct vector_block
*block
, **bprev
= &vector_blocks
;
2999 struct large_vector
*lv
, **lvprev
= &large_vectors
;
3000 struct Lisp_Vector
*vector
, *next
;
3002 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3003 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3005 /* Looking through vector blocks. */
3007 for (block
= vector_blocks
; block
; block
= *bprev
)
3009 bool free_this_block
= 0;
3012 for (vector
= (struct Lisp_Vector
*) block
->data
;
3013 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3015 if (VECTOR_MARKED_P (vector
))
3017 VECTOR_UNMARK (vector
);
3019 nbytes
= vector_nbytes (vector
);
3020 total_vector_slots
+= nbytes
/ word_size
;
3021 next
= ADVANCE (vector
, nbytes
);
3025 ptrdiff_t total_bytes
;
3027 cleanup_vector (vector
);
3028 nbytes
= vector_nbytes (vector
);
3029 total_bytes
= nbytes
;
3030 next
= ADVANCE (vector
, nbytes
);
3032 /* While NEXT is not marked, try to coalesce with VECTOR,
3033 thus making VECTOR of the largest possible size. */
3035 while (VECTOR_IN_BLOCK (next
, block
))
3037 if (VECTOR_MARKED_P (next
))
3039 cleanup_vector (next
);
3040 nbytes
= vector_nbytes (next
);
3041 total_bytes
+= nbytes
;
3042 next
= ADVANCE (next
, nbytes
);
3045 eassert (total_bytes
% roundup_size
== 0);
3047 if (vector
== (struct Lisp_Vector
*) block
->data
3048 && !VECTOR_IN_BLOCK (next
, block
))
3049 /* This block should be freed because all of its
3050 space was coalesced into the only free vector. */
3051 free_this_block
= 1;
3055 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3060 if (free_this_block
)
3062 *bprev
= block
->next
;
3063 #ifndef GC_MALLOC_CHECK
3064 mem_delete (mem_find (block
->data
));
3069 bprev
= &block
->next
;
3072 /* Sweep large vectors. */
3074 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
3076 vector
= large_vector_vec (lv
);
3077 if (VECTOR_MARKED_P (vector
))
3079 VECTOR_UNMARK (vector
);
3081 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3083 /* All non-bool pseudovectors are small enough to be allocated
3084 from vector blocks. This code should be redesigned if some
3085 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3086 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3087 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3091 += header_size
/ word_size
+ vector
->header
.size
;
3102 /* Value is a pointer to a newly allocated Lisp_Vector structure
3103 with room for LEN Lisp_Objects. */
3105 static struct Lisp_Vector
*
3106 allocate_vectorlike (ptrdiff_t len
)
3108 struct Lisp_Vector
*p
;
3113 p
= XVECTOR (zero_vector
);
3116 size_t nbytes
= header_size
+ len
* word_size
;
3118 #ifdef DOUG_LEA_MALLOC
3119 if (!mmap_lisp_allowed_p ())
3120 mallopt (M_MMAP_MAX
, 0);
3123 if (nbytes
<= VBLOCK_BYTES_MAX
)
3124 p
= allocate_vector_from_block (vroundup (nbytes
));
3127 struct large_vector
*lv
3128 = lisp_malloc ((large_vector_offset
+ header_size
3130 MEM_TYPE_VECTORLIKE
);
3131 lv
->next
= large_vectors
;
3133 p
= large_vector_vec (lv
);
3136 #ifdef DOUG_LEA_MALLOC
3137 if (!mmap_lisp_allowed_p ())
3138 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3141 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3144 consing_since_gc
+= nbytes
;
3145 vector_cells_consed
+= len
;
3148 MALLOC_UNBLOCK_INPUT
;
3154 /* Allocate a vector with LEN slots. */
3156 struct Lisp_Vector
*
3157 allocate_vector (EMACS_INT len
)
3159 struct Lisp_Vector
*v
;
3160 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3162 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3163 memory_full (SIZE_MAX
);
3164 v
= allocate_vectorlike (len
);
3165 v
->header
.size
= len
;
3170 /* Allocate other vector-like structures. */
3172 struct Lisp_Vector
*
3173 allocate_pseudovector (int memlen
, int lisplen
,
3174 int zerolen
, enum pvec_type tag
)
3176 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3178 /* Catch bogus values. */
3179 eassert (0 <= tag
&& tag
<= PVEC_FONT
);
3180 eassert (0 <= lisplen
&& lisplen
<= zerolen
&& zerolen
<= memlen
);
3181 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3182 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3184 /* Only the first LISPLEN slots will be traced normally by the GC. */
3185 memclear (v
->contents
, zerolen
* word_size
);
3186 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3191 allocate_buffer (void)
3193 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3195 BUFFER_PVEC_INIT (b
);
3196 /* Put B on the chain of all buffers including killed ones. */
3197 b
->next
= all_buffers
;
3199 /* Note that the rest fields of B are not initialized. */
3203 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3204 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3205 See also the function `vector'. */)
3206 (register Lisp_Object length
, Lisp_Object init
)
3209 register ptrdiff_t sizei
;
3210 register ptrdiff_t i
;
3211 register struct Lisp_Vector
*p
;
3213 CHECK_NATNUM (length
);
3215 p
= allocate_vector (XFASTINT (length
));
3216 sizei
= XFASTINT (length
);
3217 for (i
= 0; i
< sizei
; i
++)
3218 p
->contents
[i
] = init
;
3220 XSETVECTOR (vector
, p
);
3224 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3225 doc
: /* Return a newly created vector with specified arguments as elements.
3226 Any number of arguments, even zero arguments, are allowed.
3227 usage: (vector &rest OBJECTS) */)
3228 (ptrdiff_t nargs
, Lisp_Object
*args
)
3231 register Lisp_Object val
= make_uninit_vector (nargs
);
3232 register struct Lisp_Vector
*p
= XVECTOR (val
);
3234 for (i
= 0; i
< nargs
; i
++)
3235 p
->contents
[i
] = args
[i
];
3240 make_byte_code (struct Lisp_Vector
*v
)
3242 /* Don't allow the global zero_vector to become a byte code object. */
3243 eassert (0 < v
->header
.size
);
3245 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3246 && STRING_MULTIBYTE (v
->contents
[1]))
3247 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3248 earlier because they produced a raw 8-bit string for byte-code
3249 and now such a byte-code string is loaded as multibyte while
3250 raw 8-bit characters converted to multibyte form. Thus, now we
3251 must convert them back to the original unibyte form. */
3252 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3253 XSETPVECTYPE (v
, PVEC_COMPILED
);
3256 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3257 doc
: /* Create a byte-code object with specified arguments as elements.
3258 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3259 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3260 and (optional) INTERACTIVE-SPEC.
3261 The first four arguments are required; at most six have any
3263 The ARGLIST can be either like the one of `lambda', in which case the arguments
3264 will be dynamically bound before executing the byte code, or it can be an
3265 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3266 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3267 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3268 argument to catch the left-over arguments. If such an integer is used, the
3269 arguments will not be dynamically bound but will be instead pushed on the
3270 stack before executing the byte-code.
3271 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3272 (ptrdiff_t nargs
, Lisp_Object
*args
)
3275 register Lisp_Object val
= make_uninit_vector (nargs
);
3276 register struct Lisp_Vector
*p
= XVECTOR (val
);
3278 /* We used to purecopy everything here, if purify-flag was set. This worked
3279 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3280 dangerous, since make-byte-code is used during execution to build
3281 closures, so any closure built during the preload phase would end up
3282 copied into pure space, including its free variables, which is sometimes
3283 just wasteful and other times plainly wrong (e.g. those free vars may want
3286 for (i
= 0; i
< nargs
; i
++)
3287 p
->contents
[i
] = args
[i
];
3289 XSETCOMPILED (val
, p
);
3295 /***********************************************************************
3297 ***********************************************************************/
3299 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3300 of the required alignment. */
3302 union aligned_Lisp_Symbol
3304 struct Lisp_Symbol s
;
3305 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3309 /* Each symbol_block is just under 1020 bytes long, since malloc
3310 really allocates in units of powers of two and uses 4 bytes for its
3313 #define SYMBOL_BLOCK_SIZE \
3314 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3318 /* Place `symbols' first, to preserve alignment. */
3319 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3320 struct symbol_block
*next
;
3323 /* Current symbol block and index of first unused Lisp_Symbol
3326 static struct symbol_block
*symbol_block
;
3327 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3328 /* Pointer to the first symbol_block that contains pinned symbols.
3329 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3330 10K of which are pinned (and all but 250 of them are interned in obarray),
3331 whereas a "typical session" has in the order of 30K symbols.
3332 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3333 than 30K to find the 10K symbols we need to mark. */
3334 static struct symbol_block
*symbol_block_pinned
;
3336 /* List of free symbols. */
3338 static struct Lisp_Symbol
*symbol_free_list
;
3341 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3343 XSYMBOL (sym
)->name
= name
;
3347 init_symbol (Lisp_Object val
, Lisp_Object name
)
3349 struct Lisp_Symbol
*p
= XSYMBOL (val
);
3350 set_symbol_name (val
, name
);
3351 set_symbol_plist (val
, Qnil
);
3352 p
->redirect
= SYMBOL_PLAINVAL
;
3353 SET_SYMBOL_VAL (p
, Qunbound
);
3354 set_symbol_function (val
, Qnil
);
3355 set_symbol_next (val
, NULL
);
3356 p
->gcmarkbit
= false;
3357 p
->interned
= SYMBOL_UNINTERNED
;
3359 p
->declared_special
= false;
3363 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3364 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3365 Its value is void, and its function definition and property list are nil. */)
3370 CHECK_STRING (name
);
3374 if (symbol_free_list
)
3376 XSETSYMBOL (val
, symbol_free_list
);
3377 symbol_free_list
= symbol_free_list
->next
;
3381 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3383 struct symbol_block
*new
3384 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3385 new->next
= symbol_block
;
3387 symbol_block_index
= 0;
3388 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3390 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3391 symbol_block_index
++;
3394 MALLOC_UNBLOCK_INPUT
;
3396 init_symbol (val
, name
);
3397 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3399 total_free_symbols
--;
3405 /***********************************************************************
3406 Marker (Misc) Allocation
3407 ***********************************************************************/
3409 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3410 the required alignment. */
3412 union aligned_Lisp_Misc
3415 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3419 /* Allocation of markers and other objects that share that structure.
3420 Works like allocation of conses. */
3422 #define MARKER_BLOCK_SIZE \
3423 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3427 /* Place `markers' first, to preserve alignment. */
3428 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3429 struct marker_block
*next
;
3432 static struct marker_block
*marker_block
;
3433 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3435 static union Lisp_Misc
*marker_free_list
;
3437 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3440 allocate_misc (enum Lisp_Misc_Type type
)
3446 if (marker_free_list
)
3448 XSETMISC (val
, marker_free_list
);
3449 marker_free_list
= marker_free_list
->u_free
.chain
;
3453 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3455 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3456 new->next
= marker_block
;
3458 marker_block_index
= 0;
3459 total_free_markers
+= MARKER_BLOCK_SIZE
;
3461 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3462 marker_block_index
++;
3465 MALLOC_UNBLOCK_INPUT
;
3467 --total_free_markers
;
3468 consing_since_gc
+= sizeof (union Lisp_Misc
);
3469 misc_objects_consed
++;
3470 XMISCANY (val
)->type
= type
;
3471 XMISCANY (val
)->gcmarkbit
= 0;
3475 /* Free a Lisp_Misc object. */
3478 free_misc (Lisp_Object misc
)
3480 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3481 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3482 marker_free_list
= XMISC (misc
);
3483 consing_since_gc
-= sizeof (union Lisp_Misc
);
3484 total_free_markers
++;
3487 /* Verify properties of Lisp_Save_Value's representation
3488 that are assumed here and elsewhere. */
3490 verify (SAVE_UNUSED
== 0);
3491 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3495 /* Return Lisp_Save_Value objects for the various combinations
3496 that callers need. */
3499 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3501 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3502 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3503 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3504 p
->data
[0].integer
= a
;
3505 p
->data
[1].integer
= b
;
3506 p
->data
[2].integer
= c
;
3511 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3514 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3515 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3516 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3517 p
->data
[0].object
= a
;
3518 p
->data
[1].object
= b
;
3519 p
->data
[2].object
= c
;
3520 p
->data
[3].object
= d
;
3525 make_save_ptr (void *a
)
3527 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3528 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3529 p
->save_type
= SAVE_POINTER
;
3530 p
->data
[0].pointer
= a
;
3535 make_save_ptr_int (void *a
, ptrdiff_t b
)
3537 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3538 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3539 p
->save_type
= SAVE_TYPE_PTR_INT
;
3540 p
->data
[0].pointer
= a
;
3541 p
->data
[1].integer
= b
;
3545 #if ! (defined USE_X_TOOLKIT || defined USE_GTK)
3547 make_save_ptr_ptr (void *a
, void *b
)
3549 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3550 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3551 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3552 p
->data
[0].pointer
= a
;
3553 p
->data
[1].pointer
= b
;
3559 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3561 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3562 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3563 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3564 p
->data
[0].funcpointer
= a
;
3565 p
->data
[1].pointer
= b
;
3566 p
->data
[2].object
= c
;
3570 /* Return a Lisp_Save_Value object that represents an array A
3571 of N Lisp objects. */
3574 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3576 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3577 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3578 p
->save_type
= SAVE_TYPE_MEMORY
;
3579 p
->data
[0].pointer
= a
;
3580 p
->data
[1].integer
= n
;
3584 /* Free a Lisp_Save_Value object. Do not use this function
3585 if SAVE contains pointer other than returned by xmalloc. */
3588 free_save_value (Lisp_Object save
)
3590 xfree (XSAVE_POINTER (save
, 0));
3594 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3597 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3599 register Lisp_Object overlay
;
3601 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3602 OVERLAY_START (overlay
) = start
;
3603 OVERLAY_END (overlay
) = end
;
3604 set_overlay_plist (overlay
, plist
);
3605 XOVERLAY (overlay
)->next
= NULL
;
3609 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3610 doc
: /* Return a newly allocated marker which does not point at any place. */)
3613 register Lisp_Object val
;
3614 register struct Lisp_Marker
*p
;
3616 val
= allocate_misc (Lisp_Misc_Marker
);
3622 p
->insertion_type
= 0;
3623 p
->need_adjustment
= 0;
3627 /* Return a newly allocated marker which points into BUF
3628 at character position CHARPOS and byte position BYTEPOS. */
3631 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3634 struct Lisp_Marker
*m
;
3636 /* No dead buffers here. */
3637 eassert (BUFFER_LIVE_P (buf
));
3639 /* Every character is at least one byte. */
3640 eassert (charpos
<= bytepos
);
3642 obj
= allocate_misc (Lisp_Misc_Marker
);
3645 m
->charpos
= charpos
;
3646 m
->bytepos
= bytepos
;
3647 m
->insertion_type
= 0;
3648 m
->need_adjustment
= 0;
3649 m
->next
= BUF_MARKERS (buf
);
3650 BUF_MARKERS (buf
) = m
;
3654 /* Put MARKER back on the free list after using it temporarily. */
3657 free_marker (Lisp_Object marker
)
3659 unchain_marker (XMARKER (marker
));
3664 /* Return a newly created vector or string with specified arguments as
3665 elements. If all the arguments are characters that can fit
3666 in a string of events, make a string; otherwise, make a vector.
3668 Any number of arguments, even zero arguments, are allowed. */
3671 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3675 for (i
= 0; i
< nargs
; i
++)
3676 /* The things that fit in a string
3677 are characters that are in 0...127,
3678 after discarding the meta bit and all the bits above it. */
3679 if (!INTEGERP (args
[i
])
3680 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3681 return Fvector (nargs
, args
);
3683 /* Since the loop exited, we know that all the things in it are
3684 characters, so we can make a string. */
3688 result
= Fmake_string (make_number (nargs
), make_number (0));
3689 for (i
= 0; i
< nargs
; i
++)
3691 SSET (result
, i
, XINT (args
[i
]));
3692 /* Move the meta bit to the right place for a string char. */
3693 if (XINT (args
[i
]) & CHAR_META
)
3694 SSET (result
, i
, SREF (result
, i
) | 0x80);
3702 init_finalizer_list (struct Lisp_Finalizer
*head
)
3704 head
->prev
= head
->next
= head
;
3707 /* Insert FINALIZER before ELEMENT. */
3710 finalizer_insert (struct Lisp_Finalizer
*element
,
3711 struct Lisp_Finalizer
*finalizer
)
3713 eassert (finalizer
->prev
== NULL
);
3714 eassert (finalizer
->next
== NULL
);
3715 finalizer
->next
= element
;
3716 finalizer
->prev
= element
->prev
;
3717 finalizer
->prev
->next
= finalizer
;
3718 element
->prev
= finalizer
;
3722 unchain_finalizer (struct Lisp_Finalizer
*finalizer
)
3724 if (finalizer
->prev
!= NULL
)
3726 eassert (finalizer
->next
!= NULL
);
3727 finalizer
->prev
->next
= finalizer
->next
;
3728 finalizer
->next
->prev
= finalizer
->prev
;
3729 finalizer
->prev
= finalizer
->next
= NULL
;
3734 mark_finalizer_list (struct Lisp_Finalizer
*head
)
3736 for (struct Lisp_Finalizer
*finalizer
= head
->next
;
3738 finalizer
= finalizer
->next
)
3740 finalizer
->base
.gcmarkbit
= true;
3741 mark_object (finalizer
->function
);
3745 /* Move doomed finalizers to list DEST from list SRC. A doomed
3746 finalizer is one that is not GC-reachable and whose
3747 finalizer->function is non-nil. */
3750 queue_doomed_finalizers (struct Lisp_Finalizer
*dest
,
3751 struct Lisp_Finalizer
*src
)
3753 struct Lisp_Finalizer
*finalizer
= src
->next
;
3754 while (finalizer
!= src
)
3756 struct Lisp_Finalizer
*next
= finalizer
->next
;
3757 if (!finalizer
->base
.gcmarkbit
&& !NILP (finalizer
->function
))
3759 unchain_finalizer (finalizer
);
3760 finalizer_insert (dest
, finalizer
);
3768 run_finalizer_handler (Lisp_Object args
)
3770 add_to_log ("finalizer failed: %S", args
);
3775 run_finalizer_function (Lisp_Object function
)
3777 ptrdiff_t count
= SPECPDL_INDEX ();
3779 specbind (Qinhibit_quit
, Qt
);
3780 internal_condition_case_1 (call0
, function
, Qt
, run_finalizer_handler
);
3781 unbind_to (count
, Qnil
);
3785 run_finalizers (struct Lisp_Finalizer
*finalizers
)
3787 struct Lisp_Finalizer
*finalizer
;
3788 Lisp_Object function
;
3790 while (finalizers
->next
!= finalizers
)
3792 finalizer
= finalizers
->next
;
3793 eassert (finalizer
->base
.type
== Lisp_Misc_Finalizer
);
3794 unchain_finalizer (finalizer
);
3795 function
= finalizer
->function
;
3796 if (!NILP (function
))
3798 finalizer
->function
= Qnil
;
3799 run_finalizer_function (function
);
3804 DEFUN ("make-finalizer", Fmake_finalizer
, Smake_finalizer
, 1, 1, 0,
3805 doc
: /* Make a finalizer that will run FUNCTION.
3806 FUNCTION will be called after garbage collection when the returned
3807 finalizer object becomes unreachable. If the finalizer object is
3808 reachable only through references from finalizer objects, it does not
3809 count as reachable for the purpose of deciding whether to run
3810 FUNCTION. FUNCTION will be run once per finalizer object. */)
3811 (Lisp_Object function
)
3813 Lisp_Object val
= allocate_misc (Lisp_Misc_Finalizer
);
3814 struct Lisp_Finalizer
*finalizer
= XFINALIZER (val
);
3815 finalizer
->function
= function
;
3816 finalizer
->prev
= finalizer
->next
= NULL
;
3817 finalizer_insert (&finalizers
, finalizer
);
3822 /************************************************************************
3823 Memory Full Handling
3824 ************************************************************************/
3827 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3828 there may have been size_t overflow so that malloc was never
3829 called, or perhaps malloc was invoked successfully but the
3830 resulting pointer had problems fitting into a tagged EMACS_INT. In
3831 either case this counts as memory being full even though malloc did
3835 memory_full (size_t nbytes
)
3837 /* Do not go into hysterics merely because a large request failed. */
3838 bool enough_free_memory
= 0;
3839 if (SPARE_MEMORY
< nbytes
)
3844 p
= malloc (SPARE_MEMORY
);
3848 enough_free_memory
= 1;
3850 MALLOC_UNBLOCK_INPUT
;
3853 if (! enough_free_memory
)
3859 memory_full_cons_threshold
= sizeof (struct cons_block
);
3861 /* The first time we get here, free the spare memory. */
3862 for (i
= 0; i
< ARRAYELTS (spare_memory
); i
++)
3863 if (spare_memory
[i
])
3866 free (spare_memory
[i
]);
3867 else if (i
>= 1 && i
<= 4)
3868 lisp_align_free (spare_memory
[i
]);
3870 lisp_free (spare_memory
[i
]);
3871 spare_memory
[i
] = 0;
3875 /* This used to call error, but if we've run out of memory, we could
3876 get infinite recursion trying to build the string. */
3877 xsignal (Qnil
, Vmemory_signal_data
);
3880 /* If we released our reserve (due to running out of memory),
3881 and we have a fair amount free once again,
3882 try to set aside another reserve in case we run out once more.
3884 This is called when a relocatable block is freed in ralloc.c,
3885 and also directly from this file, in case we're not using ralloc.c. */
3888 refill_memory_reserve (void)
3890 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3891 if (spare_memory
[0] == 0)
3892 spare_memory
[0] = malloc (SPARE_MEMORY
);
3893 if (spare_memory
[1] == 0)
3894 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3896 if (spare_memory
[2] == 0)
3897 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3899 if (spare_memory
[3] == 0)
3900 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3902 if (spare_memory
[4] == 0)
3903 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3905 if (spare_memory
[5] == 0)
3906 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3908 if (spare_memory
[6] == 0)
3909 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3911 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3912 Vmemory_full
= Qnil
;
3916 /************************************************************************
3918 ************************************************************************/
3920 /* Conservative C stack marking requires a method to identify possibly
3921 live Lisp objects given a pointer value. We do this by keeping
3922 track of blocks of Lisp data that are allocated in a red-black tree
3923 (see also the comment of mem_node which is the type of nodes in
3924 that tree). Function lisp_malloc adds information for an allocated
3925 block to the red-black tree with calls to mem_insert, and function
3926 lisp_free removes it with mem_delete. Functions live_string_p etc
3927 call mem_find to lookup information about a given pointer in the
3928 tree, and use that to determine if the pointer points to a Lisp
3931 /* Initialize this part of alloc.c. */
3936 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3937 mem_z
.parent
= NULL
;
3938 mem_z
.color
= MEM_BLACK
;
3939 mem_z
.start
= mem_z
.end
= NULL
;
3944 /* Value is a pointer to the mem_node containing START. Value is
3945 MEM_NIL if there is no node in the tree containing START. */
3947 static struct mem_node
*
3948 mem_find (void *start
)
3952 if (start
< min_heap_address
|| start
> max_heap_address
)
3955 /* Make the search always successful to speed up the loop below. */
3956 mem_z
.start
= start
;
3957 mem_z
.end
= (char *) start
+ 1;
3960 while (start
< p
->start
|| start
>= p
->end
)
3961 p
= start
< p
->start
? p
->left
: p
->right
;
3966 /* Insert a new node into the tree for a block of memory with start
3967 address START, end address END, and type TYPE. Value is a
3968 pointer to the node that was inserted. */
3970 static struct mem_node
*
3971 mem_insert (void *start
, void *end
, enum mem_type type
)
3973 struct mem_node
*c
, *parent
, *x
;
3975 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3976 min_heap_address
= start
;
3977 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3978 max_heap_address
= end
;
3980 /* See where in the tree a node for START belongs. In this
3981 particular application, it shouldn't happen that a node is already
3982 present. For debugging purposes, let's check that. */
3986 while (c
!= MEM_NIL
)
3989 c
= start
< c
->start
? c
->left
: c
->right
;
3992 /* Create a new node. */
3993 #ifdef GC_MALLOC_CHECK
3994 x
= malloc (sizeof *x
);
3998 x
= xmalloc (sizeof *x
);
4004 x
->left
= x
->right
= MEM_NIL
;
4007 /* Insert it as child of PARENT or install it as root. */
4010 if (start
< parent
->start
)
4018 /* Re-establish red-black tree properties. */
4019 mem_insert_fixup (x
);
4025 /* Re-establish the red-black properties of the tree, and thereby
4026 balance the tree, after node X has been inserted; X is always red. */
4029 mem_insert_fixup (struct mem_node
*x
)
4031 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
4033 /* X is red and its parent is red. This is a violation of
4034 red-black tree property #3. */
4036 if (x
->parent
== x
->parent
->parent
->left
)
4038 /* We're on the left side of our grandparent, and Y is our
4040 struct mem_node
*y
= x
->parent
->parent
->right
;
4042 if (y
->color
== MEM_RED
)
4044 /* Uncle and parent are red but should be black because
4045 X is red. Change the colors accordingly and proceed
4046 with the grandparent. */
4047 x
->parent
->color
= MEM_BLACK
;
4048 y
->color
= MEM_BLACK
;
4049 x
->parent
->parent
->color
= MEM_RED
;
4050 x
= x
->parent
->parent
;
4054 /* Parent and uncle have different colors; parent is
4055 red, uncle is black. */
4056 if (x
== x
->parent
->right
)
4059 mem_rotate_left (x
);
4062 x
->parent
->color
= MEM_BLACK
;
4063 x
->parent
->parent
->color
= MEM_RED
;
4064 mem_rotate_right (x
->parent
->parent
);
4069 /* This is the symmetrical case of above. */
4070 struct mem_node
*y
= x
->parent
->parent
->left
;
4072 if (y
->color
== MEM_RED
)
4074 x
->parent
->color
= MEM_BLACK
;
4075 y
->color
= MEM_BLACK
;
4076 x
->parent
->parent
->color
= MEM_RED
;
4077 x
= x
->parent
->parent
;
4081 if (x
== x
->parent
->left
)
4084 mem_rotate_right (x
);
4087 x
->parent
->color
= MEM_BLACK
;
4088 x
->parent
->parent
->color
= MEM_RED
;
4089 mem_rotate_left (x
->parent
->parent
);
4094 /* The root may have been changed to red due to the algorithm. Set
4095 it to black so that property #5 is satisfied. */
4096 mem_root
->color
= MEM_BLACK
;
4107 mem_rotate_left (struct mem_node
*x
)
4111 /* Turn y's left sub-tree into x's right sub-tree. */
4114 if (y
->left
!= MEM_NIL
)
4115 y
->left
->parent
= x
;
4117 /* Y's parent was x's parent. */
4119 y
->parent
= x
->parent
;
4121 /* Get the parent to point to y instead of x. */
4124 if (x
== x
->parent
->left
)
4125 x
->parent
->left
= y
;
4127 x
->parent
->right
= y
;
4132 /* Put x on y's left. */
4146 mem_rotate_right (struct mem_node
*x
)
4148 struct mem_node
*y
= x
->left
;
4151 if (y
->right
!= MEM_NIL
)
4152 y
->right
->parent
= x
;
4155 y
->parent
= x
->parent
;
4158 if (x
== x
->parent
->right
)
4159 x
->parent
->right
= y
;
4161 x
->parent
->left
= y
;
4172 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4175 mem_delete (struct mem_node
*z
)
4177 struct mem_node
*x
, *y
;
4179 if (!z
|| z
== MEM_NIL
)
4182 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4187 while (y
->left
!= MEM_NIL
)
4191 if (y
->left
!= MEM_NIL
)
4196 x
->parent
= y
->parent
;
4199 if (y
== y
->parent
->left
)
4200 y
->parent
->left
= x
;
4202 y
->parent
->right
= x
;
4209 z
->start
= y
->start
;
4214 if (y
->color
== MEM_BLACK
)
4215 mem_delete_fixup (x
);
4217 #ifdef GC_MALLOC_CHECK
4225 /* Re-establish the red-black properties of the tree, after a
4229 mem_delete_fixup (struct mem_node
*x
)
4231 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4233 if (x
== x
->parent
->left
)
4235 struct mem_node
*w
= x
->parent
->right
;
4237 if (w
->color
== MEM_RED
)
4239 w
->color
= MEM_BLACK
;
4240 x
->parent
->color
= MEM_RED
;
4241 mem_rotate_left (x
->parent
);
4242 w
= x
->parent
->right
;
4245 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4252 if (w
->right
->color
== MEM_BLACK
)
4254 w
->left
->color
= MEM_BLACK
;
4256 mem_rotate_right (w
);
4257 w
= x
->parent
->right
;
4259 w
->color
= x
->parent
->color
;
4260 x
->parent
->color
= MEM_BLACK
;
4261 w
->right
->color
= MEM_BLACK
;
4262 mem_rotate_left (x
->parent
);
4268 struct mem_node
*w
= x
->parent
->left
;
4270 if (w
->color
== MEM_RED
)
4272 w
->color
= MEM_BLACK
;
4273 x
->parent
->color
= MEM_RED
;
4274 mem_rotate_right (x
->parent
);
4275 w
= x
->parent
->left
;
4278 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4285 if (w
->left
->color
== MEM_BLACK
)
4287 w
->right
->color
= MEM_BLACK
;
4289 mem_rotate_left (w
);
4290 w
= x
->parent
->left
;
4293 w
->color
= x
->parent
->color
;
4294 x
->parent
->color
= MEM_BLACK
;
4295 w
->left
->color
= MEM_BLACK
;
4296 mem_rotate_right (x
->parent
);
4302 x
->color
= MEM_BLACK
;
4306 /* Value is non-zero if P is a pointer to a live Lisp string on
4307 the heap. M is a pointer to the mem_block for P. */
4310 live_string_p (struct mem_node
*m
, void *p
)
4312 if (m
->type
== MEM_TYPE_STRING
)
4314 struct string_block
*b
= m
->start
;
4315 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4317 /* P must point to the start of a Lisp_String structure, and it
4318 must not be on the free-list. */
4320 && offset
% sizeof b
->strings
[0] == 0
4321 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4322 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4329 /* Value is non-zero if P is a pointer to a live Lisp cons on
4330 the heap. M is a pointer to the mem_block for P. */
4333 live_cons_p (struct mem_node
*m
, void *p
)
4335 if (m
->type
== MEM_TYPE_CONS
)
4337 struct cons_block
*b
= m
->start
;
4338 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4340 /* P must point to the start of a Lisp_Cons, not be
4341 one of the unused cells in the current cons block,
4342 and not be on the free-list. */
4344 && offset
% sizeof b
->conses
[0] == 0
4345 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4347 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4348 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4355 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4356 the heap. M is a pointer to the mem_block for P. */
4359 live_symbol_p (struct mem_node
*m
, void *p
)
4361 if (m
->type
== MEM_TYPE_SYMBOL
)
4363 struct symbol_block
*b
= m
->start
;
4364 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4366 /* P must point to the start of a Lisp_Symbol, not be
4367 one of the unused cells in the current symbol block,
4368 and not be on the free-list. */
4370 && offset
% sizeof b
->symbols
[0] == 0
4371 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4372 && (b
!= symbol_block
4373 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4374 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4381 /* Value is non-zero if P is a pointer to a live Lisp float on
4382 the heap. M is a pointer to the mem_block for P. */
4385 live_float_p (struct mem_node
*m
, void *p
)
4387 if (m
->type
== MEM_TYPE_FLOAT
)
4389 struct float_block
*b
= m
->start
;
4390 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4392 /* P must point to the start of a Lisp_Float and not be
4393 one of the unused cells in the current float block. */
4395 && offset
% sizeof b
->floats
[0] == 0
4396 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4397 && (b
!= float_block
4398 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4405 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4406 the heap. M is a pointer to the mem_block for P. */
4409 live_misc_p (struct mem_node
*m
, void *p
)
4411 if (m
->type
== MEM_TYPE_MISC
)
4413 struct marker_block
*b
= m
->start
;
4414 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4416 /* P must point to the start of a Lisp_Misc, not be
4417 one of the unused cells in the current misc block,
4418 and not be on the free-list. */
4420 && offset
% sizeof b
->markers
[0] == 0
4421 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4422 && (b
!= marker_block
4423 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4424 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4431 /* Value is non-zero if P is a pointer to a live vector-like object.
4432 M is a pointer to the mem_block for P. */
4435 live_vector_p (struct mem_node
*m
, void *p
)
4437 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4439 /* This memory node corresponds to a vector block. */
4440 struct vector_block
*block
= m
->start
;
4441 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4443 /* P is in the block's allocation range. Scan the block
4444 up to P and see whether P points to the start of some
4445 vector which is not on a free list. FIXME: check whether
4446 some allocation patterns (probably a lot of short vectors)
4447 may cause a substantial overhead of this loop. */
4448 while (VECTOR_IN_BLOCK (vector
, block
)
4449 && vector
<= (struct Lisp_Vector
*) p
)
4451 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4454 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4457 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4458 /* This memory node corresponds to a large vector. */
4464 /* Value is non-zero if P is a pointer to a live buffer. M is a
4465 pointer to the mem_block for P. */
4468 live_buffer_p (struct mem_node
*m
, void *p
)
4470 /* P must point to the start of the block, and the buffer
4471 must not have been killed. */
4472 return (m
->type
== MEM_TYPE_BUFFER
4474 && !NILP (((struct buffer
*) p
)->name_
));
4477 /* Mark OBJ if we can prove it's a Lisp_Object. */
4480 mark_maybe_object (Lisp_Object obj
)
4484 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4490 void *po
= XPNTR (obj
);
4491 struct mem_node
*m
= mem_find (po
);
4495 bool mark_p
= false;
4497 switch (XTYPE (obj
))
4500 mark_p
= (live_string_p (m
, po
)
4501 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4505 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4509 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4513 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4516 case Lisp_Vectorlike
:
4517 /* Note: can't check BUFFERP before we know it's a
4518 buffer because checking that dereferences the pointer
4519 PO which might point anywhere. */
4520 if (live_vector_p (m
, po
))
4521 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4522 else if (live_buffer_p (m
, po
))
4523 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4527 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4539 /* Return true if P can point to Lisp data, and false otherwise.
4540 Symbols are implemented via offsets not pointers, but the offsets
4541 are also multiples of GCALIGNMENT. */
4544 maybe_lisp_pointer (void *p
)
4546 return (uintptr_t) p
% GCALIGNMENT
== 0;
4549 /* If P points to Lisp data, mark that as live if it isn't already
4553 mark_maybe_pointer (void *p
)
4559 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4562 if (!maybe_lisp_pointer (p
))
4568 Lisp_Object obj
= Qnil
;
4572 case MEM_TYPE_NON_LISP
:
4573 case MEM_TYPE_SPARE
:
4574 /* Nothing to do; not a pointer to Lisp memory. */
4577 case MEM_TYPE_BUFFER
:
4578 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4579 XSETVECTOR (obj
, p
);
4583 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4587 case MEM_TYPE_STRING
:
4588 if (live_string_p (m
, p
)
4589 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4590 XSETSTRING (obj
, p
);
4594 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4598 case MEM_TYPE_SYMBOL
:
4599 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4600 XSETSYMBOL (obj
, p
);
4603 case MEM_TYPE_FLOAT
:
4604 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4608 case MEM_TYPE_VECTORLIKE
:
4609 case MEM_TYPE_VECTOR_BLOCK
:
4610 if (live_vector_p (m
, p
))
4613 XSETVECTOR (tem
, p
);
4614 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4629 /* Alignment of pointer values. Use alignof, as it sometimes returns
4630 a smaller alignment than GCC's __alignof__ and mark_memory might
4631 miss objects if __alignof__ were used. */
4632 #define GC_POINTER_ALIGNMENT alignof (void *)
4634 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4635 or END+OFFSET..START. */
4637 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4638 mark_memory (void *start
, void *end
)
4643 /* Make START the pointer to the start of the memory region,
4644 if it isn't already. */
4652 /* Mark Lisp data pointed to. This is necessary because, in some
4653 situations, the C compiler optimizes Lisp objects away, so that
4654 only a pointer to them remains. Example:
4656 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4659 Lisp_Object obj = build_string ("test");
4660 struct Lisp_String *s = XSTRING (obj);
4661 Fgarbage_collect ();
4662 fprintf (stderr, "test '%s'\n", s->data);
4666 Here, `obj' isn't really used, and the compiler optimizes it
4667 away. The only reference to the life string is through the
4670 for (pp
= start
; (void *) pp
< end
; pp
++)
4671 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4673 void *p
= *(void **) ((char *) pp
+ i
);
4674 mark_maybe_pointer (p
);
4675 mark_maybe_object (XIL ((intptr_t) p
));
4679 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4681 static bool setjmp_tested_p
;
4682 static int longjmps_done
;
4684 #define SETJMP_WILL_LIKELY_WORK "\
4686 Emacs garbage collector has been changed to use conservative stack\n\
4687 marking. Emacs has determined that the method it uses to do the\n\
4688 marking will likely work on your system, but this isn't sure.\n\
4690 If you are a system-programmer, or can get the help of a local wizard\n\
4691 who is, please take a look at the function mark_stack in alloc.c, and\n\
4692 verify that the methods used are appropriate for your system.\n\
4694 Please mail the result to <emacs-devel@gnu.org>.\n\
4697 #define SETJMP_WILL_NOT_WORK "\
4699 Emacs garbage collector has been changed to use conservative stack\n\
4700 marking. Emacs has determined that the default method it uses to do the\n\
4701 marking will not work on your system. We will need a system-dependent\n\
4702 solution for your system.\n\
4704 Please take a look at the function mark_stack in alloc.c, and\n\
4705 try to find a way to make it work on your system.\n\
4707 Note that you may get false negatives, depending on the compiler.\n\
4708 In particular, you need to use -O with GCC for this test.\n\
4710 Please mail the result to <emacs-devel@gnu.org>.\n\
4714 /* Perform a quick check if it looks like setjmp saves registers in a
4715 jmp_buf. Print a message to stderr saying so. When this test
4716 succeeds, this is _not_ a proof that setjmp is sufficient for
4717 conservative stack marking. Only the sources or a disassembly
4727 /* Arrange for X to be put in a register. */
4733 if (longjmps_done
== 1)
4735 /* Came here after the longjmp at the end of the function.
4737 If x == 1, the longjmp has restored the register to its
4738 value before the setjmp, and we can hope that setjmp
4739 saves all such registers in the jmp_buf, although that
4742 For other values of X, either something really strange is
4743 taking place, or the setjmp just didn't save the register. */
4746 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4749 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4756 if (longjmps_done
== 1)
4757 sys_longjmp (jbuf
, 1);
4760 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4763 /* Mark live Lisp objects on the C stack.
4765 There are several system-dependent problems to consider when
4766 porting this to new architectures:
4770 We have to mark Lisp objects in CPU registers that can hold local
4771 variables or are used to pass parameters.
4773 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4774 something that either saves relevant registers on the stack, or
4775 calls mark_maybe_object passing it each register's contents.
4777 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4778 implementation assumes that calling setjmp saves registers we need
4779 to see in a jmp_buf which itself lies on the stack. This doesn't
4780 have to be true! It must be verified for each system, possibly
4781 by taking a look at the source code of setjmp.
4783 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4784 can use it as a machine independent method to store all registers
4785 to the stack. In this case the macros described in the previous
4786 two paragraphs are not used.
4790 Architectures differ in the way their processor stack is organized.
4791 For example, the stack might look like this
4794 | Lisp_Object | size = 4
4796 | something else | size = 2
4798 | Lisp_Object | size = 4
4802 In such a case, not every Lisp_Object will be aligned equally. To
4803 find all Lisp_Object on the stack it won't be sufficient to walk
4804 the stack in steps of 4 bytes. Instead, two passes will be
4805 necessary, one starting at the start of the stack, and a second
4806 pass starting at the start of the stack + 2. Likewise, if the
4807 minimal alignment of Lisp_Objects on the stack is 1, four passes
4808 would be necessary, each one starting with one byte more offset
4809 from the stack start. */
4812 mark_stack (void *end
)
4815 /* This assumes that the stack is a contiguous region in memory. If
4816 that's not the case, something has to be done here to iterate
4817 over the stack segments. */
4818 mark_memory (stack_base
, end
);
4820 /* Allow for marking a secondary stack, like the register stack on the
4822 #ifdef GC_MARK_SECONDARY_STACK
4823 GC_MARK_SECONDARY_STACK ();
4828 c_symbol_p (struct Lisp_Symbol
*sym
)
4830 char *lispsym_ptr
= (char *) lispsym
;
4831 char *sym_ptr
= (char *) sym
;
4832 ptrdiff_t lispsym_offset
= sym_ptr
- lispsym_ptr
;
4833 return 0 <= lispsym_offset
&& lispsym_offset
< sizeof lispsym
;
4836 /* Determine whether it is safe to access memory at address P. */
4838 valid_pointer_p (void *p
)
4841 return w32_valid_pointer_p (p
, 16);
4844 if (ADDRESS_SANITIZER
)
4849 /* Obviously, we cannot just access it (we would SEGV trying), so we
4850 trick the o/s to tell us whether p is a valid pointer.
4851 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4852 not validate p in that case. */
4854 if (emacs_pipe (fd
) == 0)
4856 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
4857 emacs_close (fd
[1]);
4858 emacs_close (fd
[0]);
4866 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
4867 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
4868 cannot validate OBJ. This function can be quite slow, so its primary
4869 use is the manual debugging. The only exception is print_object, where
4870 we use it to check whether the memory referenced by the pointer of
4871 Lisp_Save_Value object contains valid objects. */
4874 valid_lisp_object_p (Lisp_Object obj
)
4879 void *p
= XPNTR (obj
);
4883 if (SYMBOLP (obj
) && c_symbol_p (p
))
4884 return ((char *) p
- (char *) lispsym
) % sizeof lispsym
[0] == 0;
4886 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
4889 struct mem_node
*m
= mem_find (p
);
4893 int valid
= valid_pointer_p (p
);
4905 case MEM_TYPE_NON_LISP
:
4906 case MEM_TYPE_SPARE
:
4909 case MEM_TYPE_BUFFER
:
4910 return live_buffer_p (m
, p
) ? 1 : 2;
4913 return live_cons_p (m
, p
);
4915 case MEM_TYPE_STRING
:
4916 return live_string_p (m
, p
);
4919 return live_misc_p (m
, p
);
4921 case MEM_TYPE_SYMBOL
:
4922 return live_symbol_p (m
, p
);
4924 case MEM_TYPE_FLOAT
:
4925 return live_float_p (m
, p
);
4927 case MEM_TYPE_VECTORLIKE
:
4928 case MEM_TYPE_VECTOR_BLOCK
:
4929 return live_vector_p (m
, p
);
4938 /***********************************************************************
4939 Pure Storage Management
4940 ***********************************************************************/
4942 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4943 pointer to it. TYPE is the Lisp type for which the memory is
4944 allocated. TYPE < 0 means it's not used for a Lisp object. */
4947 pure_alloc (size_t size
, int type
)
4954 /* Allocate space for a Lisp object from the beginning of the free
4955 space with taking account of alignment. */
4956 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, GCALIGNMENT
);
4957 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4961 /* Allocate space for a non-Lisp object from the end of the free
4963 pure_bytes_used_non_lisp
+= size
;
4964 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4966 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4968 if (pure_bytes_used
<= pure_size
)
4971 /* Don't allocate a large amount here,
4972 because it might get mmap'd and then its address
4973 might not be usable. */
4974 purebeg
= xmalloc (10000);
4976 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4977 pure_bytes_used
= 0;
4978 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4983 /* Print a warning if PURESIZE is too small. */
4986 check_pure_size (void)
4988 if (pure_bytes_used_before_overflow
)
4989 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4991 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4995 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4996 the non-Lisp data pool of the pure storage, and return its start
4997 address. Return NULL if not found. */
5000 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5003 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5004 const unsigned char *p
;
5007 if (pure_bytes_used_non_lisp
<= nbytes
)
5010 /* Set up the Boyer-Moore table. */
5012 for (i
= 0; i
< 256; i
++)
5015 p
= (const unsigned char *) data
;
5017 bm_skip
[*p
++] = skip
;
5019 last_char_skip
= bm_skip
['\0'];
5021 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5022 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5024 /* See the comments in the function `boyer_moore' (search.c) for the
5025 use of `infinity'. */
5026 infinity
= pure_bytes_used_non_lisp
+ 1;
5027 bm_skip
['\0'] = infinity
;
5029 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5033 /* Check the last character (== '\0'). */
5036 start
+= bm_skip
[*(p
+ start
)];
5038 while (start
<= start_max
);
5040 if (start
< infinity
)
5041 /* Couldn't find the last character. */
5044 /* No less than `infinity' means we could find the last
5045 character at `p[start - infinity]'. */
5048 /* Check the remaining characters. */
5049 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5051 return non_lisp_beg
+ start
;
5053 start
+= last_char_skip
;
5055 while (start
<= start_max
);
5061 /* Return a string allocated in pure space. DATA is a buffer holding
5062 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5063 means make the result string multibyte.
5065 Must get an error if pure storage is full, since if it cannot hold
5066 a large string it may be able to hold conses that point to that
5067 string; then the string is not protected from gc. */
5070 make_pure_string (const char *data
,
5071 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5074 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5075 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5076 if (s
->data
== NULL
)
5078 s
->data
= pure_alloc (nbytes
+ 1, -1);
5079 memcpy (s
->data
, data
, nbytes
);
5080 s
->data
[nbytes
] = '\0';
5083 s
->size_byte
= multibyte
? nbytes
: -1;
5084 s
->intervals
= NULL
;
5085 XSETSTRING (string
, s
);
5089 /* Return a string allocated in pure space. Do not
5090 allocate the string data, just point to DATA. */
5093 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5096 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5099 s
->data
= (unsigned char *) data
;
5100 s
->intervals
= NULL
;
5101 XSETSTRING (string
, s
);
5105 static Lisp_Object
purecopy (Lisp_Object obj
);
5107 /* Return a cons allocated from pure space. Give it pure copies
5108 of CAR as car and CDR as cdr. */
5111 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5114 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5116 XSETCAR (new, purecopy (car
));
5117 XSETCDR (new, purecopy (cdr
));
5122 /* Value is a float object with value NUM allocated from pure space. */
5125 make_pure_float (double num
)
5128 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5130 XFLOAT_INIT (new, num
);
5135 /* Return a vector with room for LEN Lisp_Objects allocated from
5139 make_pure_vector (ptrdiff_t len
)
5142 size_t size
= header_size
+ len
* word_size
;
5143 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5144 XSETVECTOR (new, p
);
5145 XVECTOR (new)->header
.size
= len
;
5149 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5150 doc
: /* Make a copy of object OBJ in pure storage.
5151 Recursively copies contents of vectors and cons cells.
5152 Does not copy symbols. Copies strings without text properties. */)
5153 (register Lisp_Object obj
)
5155 if (NILP (Vpurify_flag
))
5157 else if (MARKERP (obj
) || OVERLAYP (obj
)
5158 || HASH_TABLE_P (obj
) || SYMBOLP (obj
))
5159 /* Can't purify those. */
5162 return purecopy (obj
);
5166 purecopy (Lisp_Object obj
)
5169 || (! SYMBOLP (obj
) && PURE_P (XPNTR_OR_SYMBOL_OFFSET (obj
)))
5171 return obj
; /* Already pure. */
5173 if (STRINGP (obj
) && XSTRING (obj
)->intervals
)
5174 message_with_string ("Dropping text-properties while making string `%s' pure",
5177 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5179 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5185 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5186 else if (FLOATP (obj
))
5187 obj
= make_pure_float (XFLOAT_DATA (obj
));
5188 else if (STRINGP (obj
))
5189 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5191 STRING_MULTIBYTE (obj
));
5192 else if (COMPILEDP (obj
) || VECTORP (obj
) || HASH_TABLE_P (obj
))
5194 struct Lisp_Vector
*objp
= XVECTOR (obj
);
5195 ptrdiff_t nbytes
= vector_nbytes (objp
);
5196 struct Lisp_Vector
*vec
= pure_alloc (nbytes
, Lisp_Vectorlike
);
5197 register ptrdiff_t i
;
5198 ptrdiff_t size
= ASIZE (obj
);
5199 if (size
& PSEUDOVECTOR_FLAG
)
5200 size
&= PSEUDOVECTOR_SIZE_MASK
;
5201 memcpy (vec
, objp
, nbytes
);
5202 for (i
= 0; i
< size
; i
++)
5203 vec
->contents
[i
] = purecopy (vec
->contents
[i
]);
5204 XSETVECTOR (obj
, vec
);
5206 else if (SYMBOLP (obj
))
5208 if (!XSYMBOL (obj
)->pinned
&& !c_symbol_p (XSYMBOL (obj
)))
5209 { /* We can't purify them, but they appear in many pure objects.
5210 Mark them as `pinned' so we know to mark them at every GC cycle. */
5211 XSYMBOL (obj
)->pinned
= true;
5212 symbol_block_pinned
= symbol_block
;
5214 /* Don't hash-cons it. */
5219 Lisp_Object fmt
= build_pure_c_string ("Don't know how to purify: %S");
5220 Fsignal (Qerror
, list1 (CALLN (Fformat
, fmt
, obj
)));
5223 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5224 Fputhash (obj
, obj
, Vpurify_flag
);
5231 /***********************************************************************
5233 ***********************************************************************/
5235 /* Put an entry in staticvec, pointing at the variable with address
5239 staticpro (Lisp_Object
*varaddress
)
5241 if (staticidx
>= NSTATICS
)
5242 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5243 staticvec
[staticidx
++] = varaddress
;
5247 /***********************************************************************
5249 ***********************************************************************/
5251 /* Temporarily prevent garbage collection. */
5254 inhibit_garbage_collection (void)
5256 ptrdiff_t count
= SPECPDL_INDEX ();
5258 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5262 /* Used to avoid possible overflows when
5263 converting from C to Lisp integers. */
5266 bounded_number (EMACS_INT number
)
5268 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5271 /* Calculate total bytes of live objects. */
5274 total_bytes_of_live_objects (void)
5277 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5278 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5279 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5280 tot
+= total_string_bytes
;
5281 tot
+= total_vector_slots
* word_size
;
5282 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5283 tot
+= total_intervals
* sizeof (struct interval
);
5284 tot
+= total_strings
* sizeof (struct Lisp_String
);
5288 #ifdef HAVE_WINDOW_SYSTEM
5290 /* This code has a few issues on MS-Windows, see Bug#15876 and Bug#16140. */
5292 #if !defined (HAVE_NTGUI)
5294 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5295 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5298 compact_font_cache_entry (Lisp_Object entry
)
5300 Lisp_Object tail
, *prev
= &entry
;
5302 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5305 Lisp_Object obj
= XCAR (tail
);
5307 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5308 if (CONSP (obj
) && FONT_SPEC_P (XCAR (obj
))
5309 && !VECTOR_MARKED_P (XFONT_SPEC (XCAR (obj
)))
5310 && VECTORP (XCDR (obj
)))
5312 ptrdiff_t i
, size
= ASIZE (XCDR (obj
)) & ~ARRAY_MARK_FLAG
;
5314 /* If font-spec is not marked, most likely all font-entities
5315 are not marked too. But we must be sure that nothing is
5316 marked within OBJ before we really drop it. */
5317 for (i
= 0; i
< size
; i
++)
5318 if (VECTOR_MARKED_P (XFONT_ENTITY (AREF (XCDR (obj
), i
))))
5325 *prev
= XCDR (tail
);
5327 prev
= xcdr_addr (tail
);
5332 #endif /* not HAVE_NTGUI */
5334 /* Compact font caches on all terminals and mark
5335 everything which is still here after compaction. */
5338 compact_font_caches (void)
5342 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5344 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5345 #if !defined (HAVE_NTGUI)
5350 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5351 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5353 #endif /* not HAVE_NTGUI */
5354 mark_object (cache
);
5358 #else /* not HAVE_WINDOW_SYSTEM */
5360 #define compact_font_caches() (void)(0)
5362 #endif /* HAVE_WINDOW_SYSTEM */
5364 /* Remove (MARKER . DATA) entries with unmarked MARKER
5365 from buffer undo LIST and return changed list. */
5368 compact_undo_list (Lisp_Object list
)
5370 Lisp_Object tail
, *prev
= &list
;
5372 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5374 if (CONSP (XCAR (tail
))
5375 && MARKERP (XCAR (XCAR (tail
)))
5376 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5377 *prev
= XCDR (tail
);
5379 prev
= xcdr_addr (tail
);
5385 mark_pinned_symbols (void)
5387 struct symbol_block
*sblk
;
5388 int lim
= (symbol_block_pinned
== symbol_block
5389 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5391 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5393 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5394 for (; sym
< end
; ++sym
)
5396 mark_object (make_lisp_symbol (&sym
->s
));
5398 lim
= SYMBOL_BLOCK_SIZE
;
5402 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5403 separate function so that we could limit mark_stack in searching
5404 the stack frames below this function, thus avoiding the rare cases
5405 where mark_stack finds values that look like live Lisp objects on
5406 portions of stack that couldn't possibly contain such live objects.
5407 For more details of this, see the discussion at
5408 http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00270.html. */
5410 garbage_collect_1 (void *end
)
5412 struct buffer
*nextb
;
5413 char stack_top_variable
;
5416 ptrdiff_t count
= SPECPDL_INDEX ();
5417 struct timespec start
;
5418 Lisp_Object retval
= Qnil
;
5419 size_t tot_before
= 0;
5424 /* Can't GC if pure storage overflowed because we can't determine
5425 if something is a pure object or not. */
5426 if (pure_bytes_used_before_overflow
)
5429 /* Record this function, so it appears on the profiler's backtraces. */
5430 record_in_backtrace (Qautomatic_gc
, 0, 0);
5434 /* Don't keep undo information around forever.
5435 Do this early on, so it is no problem if the user quits. */
5436 FOR_EACH_BUFFER (nextb
)
5437 compact_buffer (nextb
);
5439 if (profiler_memory_running
)
5440 tot_before
= total_bytes_of_live_objects ();
5442 start
= current_timespec ();
5444 /* In case user calls debug_print during GC,
5445 don't let that cause a recursive GC. */
5446 consing_since_gc
= 0;
5448 /* Save what's currently displayed in the echo area. */
5449 message_p
= push_message ();
5450 record_unwind_protect_void (pop_message_unwind
);
5452 /* Save a copy of the contents of the stack, for debugging. */
5453 #if MAX_SAVE_STACK > 0
5454 if (NILP (Vpurify_flag
))
5457 ptrdiff_t stack_size
;
5458 if (&stack_top_variable
< stack_bottom
)
5460 stack
= &stack_top_variable
;
5461 stack_size
= stack_bottom
- &stack_top_variable
;
5465 stack
= stack_bottom
;
5466 stack_size
= &stack_top_variable
- stack_bottom
;
5468 if (stack_size
<= MAX_SAVE_STACK
)
5470 if (stack_copy_size
< stack_size
)
5472 stack_copy
= xrealloc (stack_copy
, stack_size
);
5473 stack_copy_size
= stack_size
;
5475 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5478 #endif /* MAX_SAVE_STACK > 0 */
5480 if (garbage_collection_messages
)
5481 message1_nolog ("Garbage collecting...");
5485 shrink_regexp_cache ();
5489 /* Mark all the special slots that serve as the roots of accessibility. */
5491 mark_buffer (&buffer_defaults
);
5492 mark_buffer (&buffer_local_symbols
);
5494 for (i
= 0; i
< ARRAYELTS (lispsym
); i
++)
5495 mark_object (builtin_lisp_symbol (i
));
5497 for (i
= 0; i
< staticidx
; i
++)
5498 mark_object (*staticvec
[i
]);
5500 mark_pinned_symbols ();
5512 struct handler
*handler
;
5513 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5515 mark_object (handler
->tag_or_ch
);
5516 mark_object (handler
->val
);
5519 #ifdef HAVE_WINDOW_SYSTEM
5520 mark_fringe_data ();
5523 /* Everything is now marked, except for the data in font caches,
5524 undo lists, and finalizers. The first two are compacted by
5525 removing an items which aren't reachable otherwise. */
5527 compact_font_caches ();
5529 FOR_EACH_BUFFER (nextb
)
5531 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5532 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5533 /* Now that we have stripped the elements that need not be
5534 in the undo_list any more, we can finally mark the list. */
5535 mark_object (BVAR (nextb
, undo_list
));
5538 /* Now pre-sweep finalizers. Here, we add any unmarked finalizers
5539 to doomed_finalizers so we can run their associated functions
5540 after GC. It's important to scan finalizers at this stage so
5541 that we can be sure that unmarked finalizers are really
5542 unreachable except for references from their associated functions
5543 and from other finalizers. */
5545 queue_doomed_finalizers (&doomed_finalizers
, &finalizers
);
5546 mark_finalizer_list (&doomed_finalizers
);
5550 relocate_byte_stack ();
5552 /* Clear the mark bits that we set in certain root slots. */
5553 VECTOR_UNMARK (&buffer_defaults
);
5554 VECTOR_UNMARK (&buffer_local_symbols
);
5562 consing_since_gc
= 0;
5563 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5564 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5566 gc_relative_threshold
= 0;
5567 if (FLOATP (Vgc_cons_percentage
))
5568 { /* Set gc_cons_combined_threshold. */
5569 double tot
= total_bytes_of_live_objects ();
5571 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5574 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5575 gc_relative_threshold
= tot
;
5577 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5581 if (garbage_collection_messages
)
5583 if (message_p
|| minibuf_level
> 0)
5586 message1_nolog ("Garbage collecting...done");
5589 unbind_to (count
, Qnil
);
5591 Lisp_Object total
[] = {
5592 list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5593 bounded_number (total_conses
),
5594 bounded_number (total_free_conses
)),
5595 list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5596 bounded_number (total_symbols
),
5597 bounded_number (total_free_symbols
)),
5598 list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5599 bounded_number (total_markers
),
5600 bounded_number (total_free_markers
)),
5601 list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5602 bounded_number (total_strings
),
5603 bounded_number (total_free_strings
)),
5604 list3 (Qstring_bytes
, make_number (1),
5605 bounded_number (total_string_bytes
)),
5607 make_number (header_size
+ sizeof (Lisp_Object
)),
5608 bounded_number (total_vectors
)),
5609 list4 (Qvector_slots
, make_number (word_size
),
5610 bounded_number (total_vector_slots
),
5611 bounded_number (total_free_vector_slots
)),
5612 list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5613 bounded_number (total_floats
),
5614 bounded_number (total_free_floats
)),
5615 list4 (Qintervals
, make_number (sizeof (struct interval
)),
5616 bounded_number (total_intervals
),
5617 bounded_number (total_free_intervals
)),
5618 list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5619 bounded_number (total_buffers
)),
5621 #ifdef DOUG_LEA_MALLOC
5622 list4 (Qheap
, make_number (1024),
5623 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5624 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)),
5627 retval
= CALLMANY (Flist
, total
);
5629 /* GC is complete: now we can run our finalizer callbacks. */
5630 run_finalizers (&doomed_finalizers
);
5632 if (!NILP (Vpost_gc_hook
))
5634 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5635 safe_run_hooks (Qpost_gc_hook
);
5636 unbind_to (gc_count
, Qnil
);
5639 /* Accumulate statistics. */
5640 if (FLOATP (Vgc_elapsed
))
5642 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5643 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5644 + timespectod (since_start
));
5649 /* Collect profiling data. */
5650 if (profiler_memory_running
)
5653 size_t tot_after
= total_bytes_of_live_objects ();
5654 if (tot_before
> tot_after
)
5655 swept
= tot_before
- tot_after
;
5656 malloc_probe (swept
);
5662 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5663 doc
: /* Reclaim storage for Lisp objects no longer needed.
5664 Garbage collection happens automatically if you cons more than
5665 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5666 `garbage-collect' normally returns a list with info on amount of space in use,
5667 where each entry has the form (NAME SIZE USED FREE), where:
5668 - NAME is a symbol describing the kind of objects this entry represents,
5669 - SIZE is the number of bytes used by each one,
5670 - USED is the number of those objects that were found live in the heap,
5671 - FREE is the number of those objects that are not live but that Emacs
5672 keeps around for future allocations (maybe because it does not know how
5673 to return them to the OS).
5674 However, if there was overflow in pure space, `garbage-collect'
5675 returns nil, because real GC can't be done.
5676 See Info node `(elisp)Garbage Collection'. */)
5681 #ifdef HAVE___BUILTIN_UNWIND_INIT
5682 /* Force callee-saved registers and register windows onto the stack.
5683 This is the preferred method if available, obviating the need for
5684 machine dependent methods. */
5685 __builtin_unwind_init ();
5687 #else /* not HAVE___BUILTIN_UNWIND_INIT */
5688 #ifndef GC_SAVE_REGISTERS_ON_STACK
5689 /* jmp_buf may not be aligned enough on darwin-ppc64 */
5690 union aligned_jmpbuf
{
5694 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
5696 /* This trick flushes the register windows so that all the state of
5697 the process is contained in the stack. */
5698 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
5699 needed on ia64 too. See mach_dep.c, where it also says inline
5700 assembler doesn't work with relevant proprietary compilers. */
5702 #if defined (__sparc64__) && defined (__FreeBSD__)
5703 /* FreeBSD does not have a ta 3 handler. */
5710 /* Save registers that we need to see on the stack. We need to see
5711 registers used to hold register variables and registers used to
5713 #ifdef GC_SAVE_REGISTERS_ON_STACK
5714 GC_SAVE_REGISTERS_ON_STACK (end
);
5715 #else /* not GC_SAVE_REGISTERS_ON_STACK */
5717 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
5718 setjmp will definitely work, test it
5719 and print a message with the result
5721 if (!setjmp_tested_p
)
5723 setjmp_tested_p
= 1;
5726 #endif /* GC_SETJMP_WORKS */
5729 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
5730 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
5731 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
5732 return garbage_collect_1 (end
);
5735 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5736 only interesting objects referenced from glyphs are strings. */
5739 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5741 struct glyph_row
*row
= matrix
->rows
;
5742 struct glyph_row
*end
= row
+ matrix
->nrows
;
5744 for (; row
< end
; ++row
)
5748 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5750 struct glyph
*glyph
= row
->glyphs
[area
];
5751 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5753 for (; glyph
< end_glyph
; ++glyph
)
5754 if (STRINGP (glyph
->object
)
5755 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5756 mark_object (glyph
->object
);
5761 /* Mark reference to a Lisp_Object.
5762 If the object referred to has not been seen yet, recursively mark
5763 all the references contained in it. */
5765 #define LAST_MARKED_SIZE 500
5766 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5767 static int last_marked_index
;
5769 /* For debugging--call abort when we cdr down this many
5770 links of a list, in mark_object. In debugging,
5771 the call to abort will hit a breakpoint.
5772 Normally this is zero and the check never goes off. */
5773 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5776 mark_vectorlike (struct Lisp_Vector
*ptr
)
5778 ptrdiff_t size
= ptr
->header
.size
;
5781 eassert (!VECTOR_MARKED_P (ptr
));
5782 VECTOR_MARK (ptr
); /* Else mark it. */
5783 if (size
& PSEUDOVECTOR_FLAG
)
5784 size
&= PSEUDOVECTOR_SIZE_MASK
;
5786 /* Note that this size is not the memory-footprint size, but only
5787 the number of Lisp_Object fields that we should trace.
5788 The distinction is used e.g. by Lisp_Process which places extra
5789 non-Lisp_Object fields at the end of the structure... */
5790 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5791 mark_object (ptr
->contents
[i
]);
5794 /* Like mark_vectorlike but optimized for char-tables (and
5795 sub-char-tables) assuming that the contents are mostly integers or
5799 mark_char_table (struct Lisp_Vector
*ptr
, enum pvec_type pvectype
)
5801 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5802 /* Consult the Lisp_Sub_Char_Table layout before changing this. */
5803 int i
, idx
= (pvectype
== PVEC_SUB_CHAR_TABLE
? SUB_CHAR_TABLE_OFFSET
: 0);
5805 eassert (!VECTOR_MARKED_P (ptr
));
5807 for (i
= idx
; i
< size
; i
++)
5809 Lisp_Object val
= ptr
->contents
[i
];
5811 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5813 if (SUB_CHAR_TABLE_P (val
))
5815 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5816 mark_char_table (XVECTOR (val
), PVEC_SUB_CHAR_TABLE
);
5823 NO_INLINE
/* To reduce stack depth in mark_object. */
5825 mark_compiled (struct Lisp_Vector
*ptr
)
5827 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5830 for (i
= 0; i
< size
; i
++)
5831 if (i
!= COMPILED_CONSTANTS
)
5832 mark_object (ptr
->contents
[i
]);
5833 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
5836 /* Mark the chain of overlays starting at PTR. */
5839 mark_overlay (struct Lisp_Overlay
*ptr
)
5841 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5844 /* These two are always markers and can be marked fast. */
5845 XMARKER (ptr
->start
)->gcmarkbit
= 1;
5846 XMARKER (ptr
->end
)->gcmarkbit
= 1;
5847 mark_object (ptr
->plist
);
5851 /* Mark Lisp_Objects and special pointers in BUFFER. */
5854 mark_buffer (struct buffer
*buffer
)
5856 /* This is handled much like other pseudovectors... */
5857 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5859 /* ...but there are some buffer-specific things. */
5861 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
5863 /* For now, we just don't mark the undo_list. It's done later in
5864 a special way just before the sweep phase, and after stripping
5865 some of its elements that are not needed any more. */
5867 mark_overlay (buffer
->overlays_before
);
5868 mark_overlay (buffer
->overlays_after
);
5870 /* If this is an indirect buffer, mark its base buffer. */
5871 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5872 mark_buffer (buffer
->base_buffer
);
5875 /* Mark Lisp faces in the face cache C. */
5877 NO_INLINE
/* To reduce stack depth in mark_object. */
5879 mark_face_cache (struct face_cache
*c
)
5884 for (i
= 0; i
< c
->used
; ++i
)
5886 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5890 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
5891 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
5893 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5894 mark_object (face
->lface
[j
]);
5900 NO_INLINE
/* To reduce stack depth in mark_object. */
5902 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
5904 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5905 Lisp_Object where
= blv
->where
;
5906 /* If the value is set up for a killed buffer or deleted
5907 frame, restore its global binding. If the value is
5908 forwarded to a C variable, either it's not a Lisp_Object
5909 var, or it's staticpro'd already. */
5910 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
5911 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
5912 swap_in_global_binding (ptr
);
5913 mark_object (blv
->where
);
5914 mark_object (blv
->valcell
);
5915 mark_object (blv
->defcell
);
5918 NO_INLINE
/* To reduce stack depth in mark_object. */
5920 mark_save_value (struct Lisp_Save_Value
*ptr
)
5922 /* If `save_type' is zero, `data[0].pointer' is the address
5923 of a memory area containing `data[1].integer' potential
5925 if (ptr
->save_type
== SAVE_TYPE_MEMORY
)
5927 Lisp_Object
*p
= ptr
->data
[0].pointer
;
5929 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
5930 mark_maybe_object (*p
);
5934 /* Find Lisp_Objects in `data[N]' slots and mark them. */
5936 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
5937 if (save_type (ptr
, i
) == SAVE_OBJECT
)
5938 mark_object (ptr
->data
[i
].object
);
5942 /* Remove killed buffers or items whose car is a killed buffer from
5943 LIST, and mark other items. Return changed LIST, which is marked. */
5946 mark_discard_killed_buffers (Lisp_Object list
)
5948 Lisp_Object tail
, *prev
= &list
;
5950 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
5953 Lisp_Object tem
= XCAR (tail
);
5956 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
5957 *prev
= XCDR (tail
);
5960 CONS_MARK (XCONS (tail
));
5961 mark_object (XCAR (tail
));
5962 prev
= xcdr_addr (tail
);
5969 /* Determine type of generic Lisp_Object and mark it accordingly.
5971 This function implements a straightforward depth-first marking
5972 algorithm and so the recursion depth may be very high (a few
5973 tens of thousands is not uncommon). To minimize stack usage,
5974 a few cold paths are moved out to NO_INLINE functions above.
5975 In general, inlining them doesn't help you to gain more speed. */
5978 mark_object (Lisp_Object arg
)
5980 register Lisp_Object obj
;
5982 #ifdef GC_CHECK_MARKED_OBJECTS
5985 ptrdiff_t cdr_count
= 0;
5994 last_marked
[last_marked_index
++] = obj
;
5995 if (last_marked_index
== LAST_MARKED_SIZE
)
5996 last_marked_index
= 0;
5998 /* Perform some sanity checks on the objects marked here. Abort if
5999 we encounter an object we know is bogus. This increases GC time
6001 #ifdef GC_CHECK_MARKED_OBJECTS
6003 /* Check that the object pointed to by PO is known to be a Lisp
6004 structure allocated from the heap. */
6005 #define CHECK_ALLOCATED() \
6007 m = mem_find (po); \
6012 /* Check that the object pointed to by PO is live, using predicate
6014 #define CHECK_LIVE(LIVEP) \
6016 if (!LIVEP (m, po)) \
6020 /* Check both of the above conditions, for non-symbols. */
6021 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6023 CHECK_ALLOCATED (); \
6024 CHECK_LIVE (LIVEP); \
6027 /* Check both of the above conditions, for symbols. */
6028 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() \
6030 if (!c_symbol_p (ptr)) \
6032 CHECK_ALLOCATED (); \
6033 CHECK_LIVE (live_symbol_p); \
6037 #else /* not GC_CHECK_MARKED_OBJECTS */
6039 #define CHECK_LIVE(LIVEP) ((void) 0)
6040 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) ((void) 0)
6041 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() ((void) 0)
6043 #endif /* not GC_CHECK_MARKED_OBJECTS */
6045 switch (XTYPE (obj
))
6049 register struct Lisp_String
*ptr
= XSTRING (obj
);
6050 if (STRING_MARKED_P (ptr
))
6052 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6054 MARK_INTERVAL_TREE (ptr
->intervals
);
6055 #ifdef GC_CHECK_STRING_BYTES
6056 /* Check that the string size recorded in the string is the
6057 same as the one recorded in the sdata structure. */
6059 #endif /* GC_CHECK_STRING_BYTES */
6063 case Lisp_Vectorlike
:
6065 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6066 register ptrdiff_t pvectype
;
6068 if (VECTOR_MARKED_P (ptr
))
6071 #ifdef GC_CHECK_MARKED_OBJECTS
6073 if (m
== MEM_NIL
&& !SUBRP (obj
))
6075 #endif /* GC_CHECK_MARKED_OBJECTS */
6077 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6078 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6079 >> PSEUDOVECTOR_AREA_BITS
);
6081 pvectype
= PVEC_NORMAL_VECTOR
;
6083 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6084 CHECK_LIVE (live_vector_p
);
6089 #ifdef GC_CHECK_MARKED_OBJECTS
6098 #endif /* GC_CHECK_MARKED_OBJECTS */
6099 mark_buffer ((struct buffer
*) ptr
);
6103 /* Although we could treat this just like a vector, mark_compiled
6104 returns the COMPILED_CONSTANTS element, which is marked at the
6105 next iteration of goto-loop here. This is done to avoid a few
6106 recursive calls to mark_object. */
6107 obj
= mark_compiled (ptr
);
6114 struct frame
*f
= (struct frame
*) ptr
;
6116 mark_vectorlike (ptr
);
6117 mark_face_cache (f
->face_cache
);
6118 #ifdef HAVE_WINDOW_SYSTEM
6119 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6121 struct font
*font
= FRAME_FONT (f
);
6123 if (font
&& !VECTOR_MARKED_P (font
))
6124 mark_vectorlike ((struct Lisp_Vector
*) font
);
6132 struct window
*w
= (struct window
*) ptr
;
6134 mark_vectorlike (ptr
);
6136 /* Mark glyph matrices, if any. Marking window
6137 matrices is sufficient because frame matrices
6138 use the same glyph memory. */
6139 if (w
->current_matrix
)
6141 mark_glyph_matrix (w
->current_matrix
);
6142 mark_glyph_matrix (w
->desired_matrix
);
6145 /* Filter out killed buffers from both buffer lists
6146 in attempt to help GC to reclaim killed buffers faster.
6147 We can do it elsewhere for live windows, but this is the
6148 best place to do it for dead windows. */
6150 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6152 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6156 case PVEC_HASH_TABLE
:
6158 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6160 mark_vectorlike (ptr
);
6161 mark_object (h
->test
.name
);
6162 mark_object (h
->test
.user_hash_function
);
6163 mark_object (h
->test
.user_cmp_function
);
6164 /* If hash table is not weak, mark all keys and values.
6165 For weak tables, mark only the vector. */
6167 mark_object (h
->key_and_value
);
6169 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6173 case PVEC_CHAR_TABLE
:
6174 case PVEC_SUB_CHAR_TABLE
:
6175 mark_char_table (ptr
, (enum pvec_type
) pvectype
);
6178 case PVEC_BOOL_VECTOR
:
6179 /* No Lisp_Objects to mark in a bool vector. */
6190 mark_vectorlike (ptr
);
6197 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6201 CHECK_ALLOCATED_AND_LIVE_SYMBOL ();
6203 /* Attempt to catch bogus objects. */
6204 eassert (valid_lisp_object_p (ptr
->function
));
6205 mark_object (ptr
->function
);
6206 mark_object (ptr
->plist
);
6207 switch (ptr
->redirect
)
6209 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6210 case SYMBOL_VARALIAS
:
6213 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6217 case SYMBOL_LOCALIZED
:
6218 mark_localized_symbol (ptr
);
6220 case SYMBOL_FORWARDED
:
6221 /* If the value is forwarded to a buffer or keyboard field,
6222 these are marked when we see the corresponding object.
6223 And if it's forwarded to a C variable, either it's not
6224 a Lisp_Object var, or it's staticpro'd already. */
6226 default: emacs_abort ();
6228 if (!PURE_P (XSTRING (ptr
->name
)))
6229 MARK_STRING (XSTRING (ptr
->name
));
6230 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6231 /* Inner loop to mark next symbol in this bucket, if any. */
6232 po
= ptr
= ptr
->next
;
6239 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6241 if (XMISCANY (obj
)->gcmarkbit
)
6244 switch (XMISCTYPE (obj
))
6246 case Lisp_Misc_Marker
:
6247 /* DO NOT mark thru the marker's chain.
6248 The buffer's markers chain does not preserve markers from gc;
6249 instead, markers are removed from the chain when freed by gc. */
6250 XMISCANY (obj
)->gcmarkbit
= 1;
6253 case Lisp_Misc_Save_Value
:
6254 XMISCANY (obj
)->gcmarkbit
= 1;
6255 mark_save_value (XSAVE_VALUE (obj
));
6258 case Lisp_Misc_Overlay
:
6259 mark_overlay (XOVERLAY (obj
));
6262 case Lisp_Misc_Finalizer
:
6263 XMISCANY (obj
)->gcmarkbit
= true;
6264 mark_object (XFINALIZER (obj
)->function
);
6274 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6275 if (CONS_MARKED_P (ptr
))
6277 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6279 /* If the cdr is nil, avoid recursion for the car. */
6280 if (EQ (ptr
->u
.cdr
, Qnil
))
6286 mark_object (ptr
->car
);
6289 if (cdr_count
== mark_object_loop_halt
)
6295 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6296 FLOAT_MARK (XFLOAT (obj
));
6307 #undef CHECK_ALLOCATED
6308 #undef CHECK_ALLOCATED_AND_LIVE
6310 /* Mark the Lisp pointers in the terminal objects.
6311 Called by Fgarbage_collect. */
6314 mark_terminals (void)
6317 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6319 eassert (t
->name
!= NULL
);
6320 #ifdef HAVE_WINDOW_SYSTEM
6321 /* If a terminal object is reachable from a stacpro'ed object,
6322 it might have been marked already. Make sure the image cache
6324 mark_image_cache (t
->image_cache
);
6325 #endif /* HAVE_WINDOW_SYSTEM */
6326 if (!VECTOR_MARKED_P (t
))
6327 mark_vectorlike ((struct Lisp_Vector
*)t
);
6333 /* Value is non-zero if OBJ will survive the current GC because it's
6334 either marked or does not need to be marked to survive. */
6337 survives_gc_p (Lisp_Object obj
)
6341 switch (XTYPE (obj
))
6348 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6352 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6356 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6359 case Lisp_Vectorlike
:
6360 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6364 survives_p
= CONS_MARKED_P (XCONS (obj
));
6368 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6375 return survives_p
|| PURE_P (XPNTR (obj
));
6381 NO_INLINE
/* For better stack traces */
6385 struct cons_block
*cblk
;
6386 struct cons_block
**cprev
= &cons_block
;
6387 int lim
= cons_block_index
;
6388 EMACS_INT num_free
= 0, num_used
= 0;
6392 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6396 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6398 /* Scan the mark bits an int at a time. */
6399 for (i
= 0; i
< ilim
; i
++)
6401 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6403 /* Fast path - all cons cells for this int are marked. */
6404 cblk
->gcmarkbits
[i
] = 0;
6405 num_used
+= BITS_PER_BITS_WORD
;
6409 /* Some cons cells for this int are not marked.
6410 Find which ones, and free them. */
6411 int start
, pos
, stop
;
6413 start
= i
* BITS_PER_BITS_WORD
;
6415 if (stop
> BITS_PER_BITS_WORD
)
6416 stop
= BITS_PER_BITS_WORD
;
6419 for (pos
= start
; pos
< stop
; pos
++)
6421 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6424 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6425 cons_free_list
= &cblk
->conses
[pos
];
6426 cons_free_list
->car
= Vdead
;
6431 CONS_UNMARK (&cblk
->conses
[pos
]);
6437 lim
= CONS_BLOCK_SIZE
;
6438 /* If this block contains only free conses and we have already
6439 seen more than two blocks worth of free conses then deallocate
6441 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6443 *cprev
= cblk
->next
;
6444 /* Unhook from the free list. */
6445 cons_free_list
= cblk
->conses
[0].u
.chain
;
6446 lisp_align_free (cblk
);
6450 num_free
+= this_free
;
6451 cprev
= &cblk
->next
;
6454 total_conses
= num_used
;
6455 total_free_conses
= num_free
;
6458 NO_INLINE
/* For better stack traces */
6462 register struct float_block
*fblk
;
6463 struct float_block
**fprev
= &float_block
;
6464 register int lim
= float_block_index
;
6465 EMACS_INT num_free
= 0, num_used
= 0;
6467 float_free_list
= 0;
6469 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6473 for (i
= 0; i
< lim
; i
++)
6474 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6477 fblk
->floats
[i
].u
.chain
= float_free_list
;
6478 float_free_list
= &fblk
->floats
[i
];
6483 FLOAT_UNMARK (&fblk
->floats
[i
]);
6485 lim
= FLOAT_BLOCK_SIZE
;
6486 /* If this block contains only free floats and we have already
6487 seen more than two blocks worth of free floats then deallocate
6489 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6491 *fprev
= fblk
->next
;
6492 /* Unhook from the free list. */
6493 float_free_list
= fblk
->floats
[0].u
.chain
;
6494 lisp_align_free (fblk
);
6498 num_free
+= this_free
;
6499 fprev
= &fblk
->next
;
6502 total_floats
= num_used
;
6503 total_free_floats
= num_free
;
6506 NO_INLINE
/* For better stack traces */
6508 sweep_intervals (void)
6510 register struct interval_block
*iblk
;
6511 struct interval_block
**iprev
= &interval_block
;
6512 register int lim
= interval_block_index
;
6513 EMACS_INT num_free
= 0, num_used
= 0;
6515 interval_free_list
= 0;
6517 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6522 for (i
= 0; i
< lim
; i
++)
6524 if (!iblk
->intervals
[i
].gcmarkbit
)
6526 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6527 interval_free_list
= &iblk
->intervals
[i
];
6533 iblk
->intervals
[i
].gcmarkbit
= 0;
6536 lim
= INTERVAL_BLOCK_SIZE
;
6537 /* If this block contains only free intervals and we have already
6538 seen more than two blocks worth of free intervals then
6539 deallocate this block. */
6540 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6542 *iprev
= iblk
->next
;
6543 /* Unhook from the free list. */
6544 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6549 num_free
+= this_free
;
6550 iprev
= &iblk
->next
;
6553 total_intervals
= num_used
;
6554 total_free_intervals
= num_free
;
6557 NO_INLINE
/* For better stack traces */
6559 sweep_symbols (void)
6561 struct symbol_block
*sblk
;
6562 struct symbol_block
**sprev
= &symbol_block
;
6563 int lim
= symbol_block_index
;
6564 EMACS_INT num_free
= 0, num_used
= ARRAYELTS (lispsym
);
6566 symbol_free_list
= NULL
;
6568 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
6569 lispsym
[i
].gcmarkbit
= 0;
6571 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6574 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6575 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6577 for (; sym
< end
; ++sym
)
6579 if (!sym
->s
.gcmarkbit
)
6581 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6582 xfree (SYMBOL_BLV (&sym
->s
));
6583 sym
->s
.next
= symbol_free_list
;
6584 symbol_free_list
= &sym
->s
;
6585 symbol_free_list
->function
= Vdead
;
6591 sym
->s
.gcmarkbit
= 0;
6592 /* Attempt to catch bogus objects. */
6593 eassert (valid_lisp_object_p (sym
->s
.function
));
6597 lim
= SYMBOL_BLOCK_SIZE
;
6598 /* If this block contains only free symbols and we have already
6599 seen more than two blocks worth of free symbols then deallocate
6601 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6603 *sprev
= sblk
->next
;
6604 /* Unhook from the free list. */
6605 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6610 num_free
+= this_free
;
6611 sprev
= &sblk
->next
;
6614 total_symbols
= num_used
;
6615 total_free_symbols
= num_free
;
6618 NO_INLINE
/* For better stack traces. */
6622 register struct marker_block
*mblk
;
6623 struct marker_block
**mprev
= &marker_block
;
6624 register int lim
= marker_block_index
;
6625 EMACS_INT num_free
= 0, num_used
= 0;
6627 /* Put all unmarked misc's on free list. For a marker, first
6628 unchain it from the buffer it points into. */
6630 marker_free_list
= 0;
6632 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6637 for (i
= 0; i
< lim
; i
++)
6639 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6641 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6642 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6643 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Finalizer
)
6644 unchain_finalizer (&mblk
->markers
[i
].m
.u_finalizer
);
6645 /* Set the type of the freed object to Lisp_Misc_Free.
6646 We could leave the type alone, since nobody checks it,
6647 but this might catch bugs faster. */
6648 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6649 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6650 marker_free_list
= &mblk
->markers
[i
].m
;
6656 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6659 lim
= MARKER_BLOCK_SIZE
;
6660 /* If this block contains only free markers and we have already
6661 seen more than two blocks worth of free markers then deallocate
6663 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6665 *mprev
= mblk
->next
;
6666 /* Unhook from the free list. */
6667 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6672 num_free
+= this_free
;
6673 mprev
= &mblk
->next
;
6677 total_markers
= num_used
;
6678 total_free_markers
= num_free
;
6681 NO_INLINE
/* For better stack traces */
6683 sweep_buffers (void)
6685 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6688 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6689 if (!VECTOR_MARKED_P (buffer
))
6691 *bprev
= buffer
->next
;
6696 VECTOR_UNMARK (buffer
);
6697 /* Do not use buffer_(set|get)_intervals here. */
6698 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6700 bprev
= &buffer
->next
;
6704 /* Sweep: find all structures not marked, and free them. */
6708 /* Remove or mark entries in weak hash tables.
6709 This must be done before any object is unmarked. */
6710 sweep_weak_hash_tables ();
6713 check_string_bytes (!noninteractive
);
6721 check_string_bytes (!noninteractive
);
6724 DEFUN ("memory-info", Fmemory_info
, Smemory_info
, 0, 0, 0,
6725 doc
: /* Return a list of (TOTAL-RAM FREE-RAM TOTAL-SWAP FREE-SWAP).
6726 All values are in Kbytes. If there is no swap space,
6727 last two values are zero. If the system is not supported
6728 or memory information can't be obtained, return nil. */)
6731 #if defined HAVE_LINUX_SYSINFO
6737 #ifdef LINUX_SYSINFO_UNIT
6738 units
= si
.mem_unit
;
6742 return list4i ((uintmax_t) si
.totalram
* units
/ 1024,
6743 (uintmax_t) si
.freeram
* units
/ 1024,
6744 (uintmax_t) si
.totalswap
* units
/ 1024,
6745 (uintmax_t) si
.freeswap
* units
/ 1024);
6746 #elif defined WINDOWSNT
6747 unsigned long long totalram
, freeram
, totalswap
, freeswap
;
6749 if (w32_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6750 return list4i ((uintmax_t) totalram
/ 1024,
6751 (uintmax_t) freeram
/ 1024,
6752 (uintmax_t) totalswap
/ 1024,
6753 (uintmax_t) freeswap
/ 1024);
6757 unsigned long totalram
, freeram
, totalswap
, freeswap
;
6759 if (dos_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6760 return list4i ((uintmax_t) totalram
/ 1024,
6761 (uintmax_t) freeram
/ 1024,
6762 (uintmax_t) totalswap
/ 1024,
6763 (uintmax_t) freeswap
/ 1024);
6766 #else /* not HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6767 /* FIXME: add more systems. */
6769 #endif /* HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6772 /* Debugging aids. */
6774 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6775 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6776 This may be helpful in debugging Emacs's memory usage.
6777 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6783 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
6786 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6792 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6793 doc
: /* Return a list of counters that measure how much consing there has been.
6794 Each of these counters increments for a certain kind of object.
6795 The counters wrap around from the largest positive integer to zero.
6796 Garbage collection does not decrease them.
6797 The elements of the value are as follows:
6798 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6799 All are in units of 1 = one object consed
6800 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6802 MISCS include overlays, markers, and some internal types.
6803 Frames, windows, buffers, and subprocesses count as vectors
6804 (but the contents of a buffer's text do not count here). */)
6807 return listn (CONSTYPE_HEAP
, 8,
6808 bounded_number (cons_cells_consed
),
6809 bounded_number (floats_consed
),
6810 bounded_number (vector_cells_consed
),
6811 bounded_number (symbols_consed
),
6812 bounded_number (string_chars_consed
),
6813 bounded_number (misc_objects_consed
),
6814 bounded_number (intervals_consed
),
6815 bounded_number (strings_consed
));
6819 symbol_uses_obj (Lisp_Object symbol
, Lisp_Object obj
)
6821 struct Lisp_Symbol
*sym
= XSYMBOL (symbol
);
6822 Lisp_Object val
= find_symbol_value (symbol
);
6823 return (EQ (val
, obj
)
6824 || EQ (sym
->function
, obj
)
6825 || (!NILP (sym
->function
)
6826 && COMPILEDP (sym
->function
)
6827 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6830 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)));
6833 /* Find at most FIND_MAX symbols which have OBJ as their value or
6834 function. This is used in gdbinit's `xwhichsymbols' command. */
6837 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6839 struct symbol_block
*sblk
;
6840 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6841 Lisp_Object found
= Qnil
;
6845 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
6847 Lisp_Object sym
= builtin_lisp_symbol (i
);
6848 if (symbol_uses_obj (sym
, obj
))
6850 found
= Fcons (sym
, found
);
6851 if (--find_max
== 0)
6856 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6858 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6861 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6863 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6866 Lisp_Object sym
= make_lisp_symbol (&aligned_sym
->s
);
6867 if (symbol_uses_obj (sym
, obj
))
6869 found
= Fcons (sym
, found
);
6870 if (--find_max
== 0)
6878 unbind_to (gc_count
, Qnil
);
6882 #ifdef SUSPICIOUS_OBJECT_CHECKING
6885 find_suspicious_object_in_range (void *begin
, void *end
)
6887 char *begin_a
= begin
;
6891 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6893 char *suspicious_object
= suspicious_objects
[i
];
6894 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
6895 return suspicious_object
;
6902 note_suspicious_free (void* ptr
)
6904 struct suspicious_free_record
* rec
;
6906 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
6907 if (suspicious_free_history_index
==
6908 ARRAYELTS (suspicious_free_history
))
6910 suspicious_free_history_index
= 0;
6913 memset (rec
, 0, sizeof (*rec
));
6914 rec
->suspicious_object
= ptr
;
6915 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
6919 detect_suspicious_free (void* ptr
)
6923 eassert (ptr
!= NULL
);
6925 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6926 if (suspicious_objects
[i
] == ptr
)
6928 note_suspicious_free (ptr
);
6929 suspicious_objects
[i
] = NULL
;
6933 #endif /* SUSPICIOUS_OBJECT_CHECKING */
6935 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
6936 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
6937 If Emacs is compiled with suspicious object checking, capture
6938 a stack trace when OBJ is freed in order to help track down
6939 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
6942 #ifdef SUSPICIOUS_OBJECT_CHECKING
6943 /* Right now, we care only about vectors. */
6944 if (VECTORLIKEP (obj
))
6946 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
6947 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
6948 suspicious_object_index
= 0;
6954 #ifdef ENABLE_CHECKING
6956 bool suppress_checking
;
6959 die (const char *msg
, const char *file
, int line
)
6961 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
6963 terminate_due_to_signal (SIGABRT
, INT_MAX
);
6966 #endif /* ENABLE_CHECKING */
6968 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
6970 /* Debugging check whether STR is ASCII-only. */
6973 verify_ascii (const char *str
)
6975 const unsigned char *ptr
= (unsigned char *) str
, *end
= ptr
+ strlen (str
);
6978 int c
= STRING_CHAR_ADVANCE (ptr
);
6979 if (!ASCII_CHAR_P (c
))
6985 /* Stress alloca with inconveniently sized requests and check
6986 whether all allocated areas may be used for Lisp_Object. */
6988 NO_INLINE
static void
6989 verify_alloca (void)
6992 enum { ALLOCA_CHECK_MAX
= 256 };
6993 /* Start from size of the smallest Lisp object. */
6994 for (i
= sizeof (struct Lisp_Cons
); i
<= ALLOCA_CHECK_MAX
; i
++)
6996 void *ptr
= alloca (i
);
6997 make_lisp_ptr (ptr
, Lisp_Cons
);
7001 #else /* not ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7003 #define verify_alloca() ((void) 0)
7005 #endif /* ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7007 /* Initialization. */
7010 init_alloc_once (void)
7012 /* Even though Qt's contents are not set up, its address is known. */
7016 pure_size
= PURESIZE
;
7019 init_finalizer_list (&finalizers
);
7020 init_finalizer_list (&doomed_finalizers
);
7023 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
7025 #ifdef DOUG_LEA_MALLOC
7026 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
7027 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
7028 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
7033 refill_memory_reserve ();
7034 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
7040 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
7041 setjmp_tested_p
= longjmps_done
= 0;
7043 Vgc_elapsed
= make_float (0.0);
7047 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
7052 syms_of_alloc (void)
7054 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
7055 doc
: /* Number of bytes of consing between garbage collections.
7056 Garbage collection can happen automatically once this many bytes have been
7057 allocated since the last garbage collection. All data types count.
7059 Garbage collection happens automatically only when `eval' is called.
7061 By binding this temporarily to a large number, you can effectively
7062 prevent garbage collection during a part of the program.
7063 See also `gc-cons-percentage'. */);
7065 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
7066 doc
: /* Portion of the heap used for allocation.
7067 Garbage collection can happen automatically once this portion of the heap
7068 has been allocated since the last garbage collection.
7069 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
7070 Vgc_cons_percentage
= make_float (0.1);
7072 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
7073 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
7075 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
7076 doc
: /* Number of cons cells that have been consed so far. */);
7078 DEFVAR_INT ("floats-consed", floats_consed
,
7079 doc
: /* Number of floats that have been consed so far. */);
7081 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7082 doc
: /* Number of vector cells that have been consed so far. */);
7084 DEFVAR_INT ("symbols-consed", symbols_consed
,
7085 doc
: /* Number of symbols that have been consed so far. */);
7086 symbols_consed
+= ARRAYELTS (lispsym
);
7088 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7089 doc
: /* Number of string characters that have been consed so far. */);
7091 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7092 doc
: /* Number of miscellaneous objects that have been consed so far.
7093 These include markers and overlays, plus certain objects not visible
7096 DEFVAR_INT ("intervals-consed", intervals_consed
,
7097 doc
: /* Number of intervals that have been consed so far. */);
7099 DEFVAR_INT ("strings-consed", strings_consed
,
7100 doc
: /* Number of strings that have been consed so far. */);
7102 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7103 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7104 This means that certain objects should be allocated in shared (pure) space.
7105 It can also be set to a hash-table, in which case this table is used to
7106 do hash-consing of the objects allocated to pure space. */);
7108 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7109 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7110 garbage_collection_messages
= 0;
7112 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7113 doc
: /* Hook run after garbage collection has finished. */);
7114 Vpost_gc_hook
= Qnil
;
7115 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7117 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7118 doc
: /* Precomputed `signal' argument for memory-full error. */);
7119 /* We build this in advance because if we wait until we need it, we might
7120 not be able to allocate the memory to hold it. */
7122 = listn (CONSTYPE_PURE
, 2, Qerror
,
7123 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7125 DEFVAR_LISP ("memory-full", Vmemory_full
,
7126 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7127 Vmemory_full
= Qnil
;
7129 DEFSYM (Qconses
, "conses");
7130 DEFSYM (Qsymbols
, "symbols");
7131 DEFSYM (Qmiscs
, "miscs");
7132 DEFSYM (Qstrings
, "strings");
7133 DEFSYM (Qvectors
, "vectors");
7134 DEFSYM (Qfloats
, "floats");
7135 DEFSYM (Qintervals
, "intervals");
7136 DEFSYM (Qbuffers
, "buffers");
7137 DEFSYM (Qstring_bytes
, "string-bytes");
7138 DEFSYM (Qvector_slots
, "vector-slots");
7139 DEFSYM (Qheap
, "heap");
7140 DEFSYM (Qautomatic_gc
, "Automatic GC");
7142 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7143 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7145 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7146 doc
: /* Accumulated time elapsed in garbage collections.
7147 The time is in seconds as a floating point value. */);
7148 DEFVAR_INT ("gcs-done", gcs_done
,
7149 doc
: /* Accumulated number of garbage collections done. */);
7154 defsubr (&Sbool_vector
);
7155 defsubr (&Smake_byte_code
);
7156 defsubr (&Smake_list
);
7157 defsubr (&Smake_vector
);
7158 defsubr (&Smake_string
);
7159 defsubr (&Smake_bool_vector
);
7160 defsubr (&Smake_symbol
);
7161 defsubr (&Smake_marker
);
7162 defsubr (&Smake_finalizer
);
7163 defsubr (&Spurecopy
);
7164 defsubr (&Sgarbage_collect
);
7165 defsubr (&Smemory_limit
);
7166 defsubr (&Smemory_info
);
7167 defsubr (&Smemory_use_counts
);
7168 defsubr (&Ssuspicious_object
);
7171 /* When compiled with GCC, GDB might say "No enum type named
7172 pvec_type" if we don't have at least one symbol with that type, and
7173 then xbacktrace could fail. Similarly for the other enums and
7174 their values. Some non-GCC compilers don't like these constructs. */
7178 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7179 enum char_table_specials char_table_specials
;
7180 enum char_bits char_bits
;
7181 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7182 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7183 enum Lisp_Bits Lisp_Bits
;
7184 enum Lisp_Compiled Lisp_Compiled
;
7185 enum maxargs maxargs
;
7186 enum MAX_ALLOCA MAX_ALLOCA
;
7187 enum More_Lisp_Bits More_Lisp_Bits
;
7188 enum pvec_type pvec_type
;
7189 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7190 #endif /* __GNUC__ */