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
;
433 #ifdef DOUG_LEA_MALLOC
435 pointers_fit_in_lispobj_p (void)
437 return (UINTPTR_MAX
<= VAL_MAX
) || USE_LSB_TAG
;
441 mmap_lisp_allowed_p (void)
443 /* If we can't store all memory addresses in our lisp objects, it's
444 risky to let the heap use mmap and give us addresses from all
445 over our address space. We also can't use mmap for lisp objects
446 if we might dump: unexec doesn't preserve the contents of mmapped
448 return pointers_fit_in_lispobj_p () && !might_dump
;
452 /* Head of a circularly-linked list of extant finalizers. */
453 static struct Lisp_Finalizer finalizers
;
455 /* Head of a circularly-linked list of finalizers that must be invoked
456 because we deemed them unreachable. This list must be global, and
457 not a local inside garbage_collect_1, in case we GC again while
458 running finalizers. */
459 static struct Lisp_Finalizer doomed_finalizers
;
462 /************************************************************************
464 ************************************************************************/
466 /* Function malloc calls this if it finds we are near exhausting storage. */
469 malloc_warning (const char *str
)
471 pending_malloc_warning
= str
;
475 /* Display an already-pending malloc warning. */
478 display_malloc_warning (void)
480 call3 (intern ("display-warning"),
482 build_string (pending_malloc_warning
),
483 intern ("emergency"));
484 pending_malloc_warning
= 0;
487 /* Called if we can't allocate relocatable space for a buffer. */
490 buffer_memory_full (ptrdiff_t nbytes
)
492 /* If buffers use the relocating allocator, no need to free
493 spare_memory, because we may have plenty of malloc space left
494 that we could get, and if we don't, the malloc that fails will
495 itself cause spare_memory to be freed. If buffers don't use the
496 relocating allocator, treat this like any other failing
500 memory_full (nbytes
);
502 /* This used to call error, but if we've run out of memory, we could
503 get infinite recursion trying to build the string. */
504 xsignal (Qnil
, Vmemory_signal_data
);
508 /* A common multiple of the positive integers A and B. Ideally this
509 would be the least common multiple, but there's no way to do that
510 as a constant expression in C, so do the best that we can easily do. */
511 #define COMMON_MULTIPLE(a, b) \
512 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
514 #ifndef XMALLOC_OVERRUN_CHECK
515 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
518 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
521 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
522 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
523 block size in little-endian order. The trailer consists of
524 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
526 The header is used to detect whether this block has been allocated
527 through these functions, as some low-level libc functions may
528 bypass the malloc hooks. */
530 #define XMALLOC_OVERRUN_CHECK_SIZE 16
531 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
532 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
534 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
535 hold a size_t value and (2) the header size is a multiple of the
536 alignment that Emacs needs for C types and for USE_LSB_TAG. */
537 #define XMALLOC_BASE_ALIGNMENT alignof (max_align_t)
539 #define XMALLOC_HEADER_ALIGNMENT \
540 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
541 #define XMALLOC_OVERRUN_SIZE_SIZE \
542 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
543 + XMALLOC_HEADER_ALIGNMENT - 1) \
544 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
545 - XMALLOC_OVERRUN_CHECK_SIZE)
547 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
548 { '\x9a', '\x9b', '\xae', '\xaf',
549 '\xbf', '\xbe', '\xce', '\xcf',
550 '\xea', '\xeb', '\xec', '\xed',
551 '\xdf', '\xde', '\x9c', '\x9d' };
553 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
554 { '\xaa', '\xab', '\xac', '\xad',
555 '\xba', '\xbb', '\xbc', '\xbd',
556 '\xca', '\xcb', '\xcc', '\xcd',
557 '\xda', '\xdb', '\xdc', '\xdd' };
559 /* Insert and extract the block size in the header. */
562 xmalloc_put_size (unsigned char *ptr
, size_t size
)
565 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
567 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
573 xmalloc_get_size (unsigned char *ptr
)
577 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
578 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
587 /* Like malloc, but wraps allocated block with header and trailer. */
590 overrun_check_malloc (size_t size
)
592 register unsigned char *val
;
593 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
596 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
599 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
600 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
601 xmalloc_put_size (val
, size
);
602 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
603 XMALLOC_OVERRUN_CHECK_SIZE
);
609 /* Like realloc, but checks old block for overrun, and wraps new block
610 with header and trailer. */
613 overrun_check_realloc (void *block
, size_t size
)
615 register unsigned char *val
= (unsigned char *) block
;
616 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
620 && memcmp (xmalloc_overrun_check_header
,
621 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
622 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
624 size_t osize
= xmalloc_get_size (val
);
625 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
626 XMALLOC_OVERRUN_CHECK_SIZE
))
628 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
629 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
630 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
633 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
637 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
638 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
639 xmalloc_put_size (val
, size
);
640 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
641 XMALLOC_OVERRUN_CHECK_SIZE
);
646 /* Like free, but checks block for overrun. */
649 overrun_check_free (void *block
)
651 unsigned char *val
= (unsigned char *) block
;
654 && memcmp (xmalloc_overrun_check_header
,
655 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
656 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
658 size_t osize
= xmalloc_get_size (val
);
659 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
660 XMALLOC_OVERRUN_CHECK_SIZE
))
662 #ifdef XMALLOC_CLEAR_FREE_MEMORY
663 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
664 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
666 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
667 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
668 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
678 #define malloc overrun_check_malloc
679 #define realloc overrun_check_realloc
680 #define free overrun_check_free
683 /* If compiled with XMALLOC_BLOCK_INPUT_CHECK, define a symbol
684 BLOCK_INPUT_IN_MEMORY_ALLOCATORS that is visible to the debugger.
685 If that variable is set, block input while in one of Emacs's memory
686 allocation functions. There should be no need for this debugging
687 option, since signal handlers do not allocate memory, but Emacs
688 formerly allocated memory in signal handlers and this compile-time
689 option remains as a way to help debug the issue should it rear its
691 #ifdef XMALLOC_BLOCK_INPUT_CHECK
692 bool block_input_in_memory_allocators EXTERNALLY_VISIBLE
;
694 malloc_block_input (void)
696 if (block_input_in_memory_allocators
)
700 malloc_unblock_input (void)
702 if (block_input_in_memory_allocators
)
705 # define MALLOC_BLOCK_INPUT malloc_block_input ()
706 # define MALLOC_UNBLOCK_INPUT malloc_unblock_input ()
708 # define MALLOC_BLOCK_INPUT ((void) 0)
709 # define MALLOC_UNBLOCK_INPUT ((void) 0)
712 #define MALLOC_PROBE(size) \
714 if (profiler_memory_running) \
715 malloc_probe (size); \
719 /* Like malloc but check for no memory and block interrupt input.. */
722 xmalloc (size_t size
)
728 MALLOC_UNBLOCK_INPUT
;
736 /* Like the above, but zeroes out the memory just allocated. */
739 xzalloc (size_t size
)
745 MALLOC_UNBLOCK_INPUT
;
749 memset (val
, 0, size
);
754 /* Like realloc but check for no memory and block interrupt input.. */
757 xrealloc (void *block
, size_t size
)
762 /* We must call malloc explicitly when BLOCK is 0, since some
763 reallocs don't do this. */
767 val
= realloc (block
, size
);
768 MALLOC_UNBLOCK_INPUT
;
777 /* Like free but block interrupt input. */
786 MALLOC_UNBLOCK_INPUT
;
787 /* We don't call refill_memory_reserve here
788 because in practice the call in r_alloc_free seems to suffice. */
792 /* Other parts of Emacs pass large int values to allocator functions
793 expecting ptrdiff_t. This is portable in practice, but check it to
795 verify (INT_MAX
<= PTRDIFF_MAX
);
798 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
799 Signal an error on memory exhaustion, and block interrupt input. */
802 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
804 eassert (0 <= nitems
&& 0 < item_size
);
805 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
806 memory_full (SIZE_MAX
);
807 return xmalloc (nitems
* item_size
);
811 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
812 Signal an error on memory exhaustion, and block interrupt input. */
815 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
817 eassert (0 <= nitems
&& 0 < item_size
);
818 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
819 memory_full (SIZE_MAX
);
820 return xrealloc (pa
, nitems
* item_size
);
824 /* Grow PA, which points to an array of *NITEMS items, and return the
825 location of the reallocated array, updating *NITEMS to reflect its
826 new size. The new array will contain at least NITEMS_INCR_MIN more
827 items, but will not contain more than NITEMS_MAX items total.
828 ITEM_SIZE is the size of each item, in bytes.
830 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
831 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
834 If PA is null, then allocate a new array instead of reallocating
837 Block interrupt input as needed. If memory exhaustion occurs, set
838 *NITEMS to zero if PA is null, and signal an error (i.e., do not
841 Thus, to grow an array A without saving its old contents, do
842 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
843 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
844 and signals an error, and later this code is reexecuted and
845 attempts to free A. */
848 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
849 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
851 /* The approximate size to use for initial small allocation
852 requests. This is the largest "small" request for the GNU C
854 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
856 /* If the array is tiny, grow it to about (but no greater than)
857 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
858 ptrdiff_t n
= *nitems
;
859 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
860 ptrdiff_t half_again
= n
>> 1;
861 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
863 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
864 NITEMS_MAX, and what the C language can represent safely. */
865 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
866 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
867 ? nitems_max
: C_language_max
);
868 ptrdiff_t nitems_incr_max
= n_max
- n
;
869 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
871 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
874 if (nitems_incr_max
< incr
)
875 memory_full (SIZE_MAX
);
877 pa
= xrealloc (pa
, n
* item_size
);
883 /* Like strdup, but uses xmalloc. */
886 xstrdup (const char *s
)
890 size
= strlen (s
) + 1;
891 return memcpy (xmalloc (size
), s
, size
);
894 /* Like above, but duplicates Lisp string to C string. */
897 xlispstrdup (Lisp_Object string
)
899 ptrdiff_t size
= SBYTES (string
) + 1;
900 return memcpy (xmalloc (size
), SSDATA (string
), size
);
903 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
904 pointed to. If STRING is null, assign it without copying anything.
905 Allocate before freeing, to avoid a dangling pointer if allocation
909 dupstring (char **ptr
, char const *string
)
912 *ptr
= string
? xstrdup (string
) : 0;
917 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
918 argument is a const pointer. */
921 xputenv (char const *string
)
923 if (putenv ((char *) string
) != 0)
927 /* Return a newly allocated memory block of SIZE bytes, remembering
928 to free it when unwinding. */
930 record_xmalloc (size_t size
)
932 void *p
= xmalloc (size
);
933 record_unwind_protect_ptr (xfree
, p
);
938 /* Like malloc but used for allocating Lisp data. NBYTES is the
939 number of bytes to allocate, TYPE describes the intended use of the
940 allocated memory block (for strings, for conses, ...). */
943 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
947 lisp_malloc (size_t nbytes
, enum mem_type type
)
953 #ifdef GC_MALLOC_CHECK
954 allocated_mem_type
= type
;
957 val
= malloc (nbytes
);
960 /* If the memory just allocated cannot be addressed thru a Lisp
961 object's pointer, and it needs to be,
962 that's equivalent to running out of memory. */
963 if (val
&& type
!= MEM_TYPE_NON_LISP
)
966 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
967 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
969 lisp_malloc_loser
= val
;
976 #ifndef GC_MALLOC_CHECK
977 if (val
&& type
!= MEM_TYPE_NON_LISP
)
978 mem_insert (val
, (char *) val
+ nbytes
, type
);
981 MALLOC_UNBLOCK_INPUT
;
983 memory_full (nbytes
);
984 MALLOC_PROBE (nbytes
);
988 /* Free BLOCK. This must be called to free memory allocated with a
989 call to lisp_malloc. */
992 lisp_free (void *block
)
996 #ifndef GC_MALLOC_CHECK
997 mem_delete (mem_find (block
));
999 MALLOC_UNBLOCK_INPUT
;
1002 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
1004 /* The entry point is lisp_align_malloc which returns blocks of at most
1005 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
1007 /* Use aligned_alloc if it or a simple substitute is available.
1008 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
1009 clang 3.3 anyway. */
1011 #if ! ADDRESS_SANITIZER
1012 # if !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC
1013 # define USE_ALIGNED_ALLOC 1
1014 /* Defined in gmalloc.c. */
1015 void *aligned_alloc (size_t, size_t);
1016 # elif defined HYBRID_MALLOC
1017 # if defined ALIGNED_ALLOC || defined HAVE_POSIX_MEMALIGN
1018 # define USE_ALIGNED_ALLOC 1
1019 # define aligned_alloc hybrid_aligned_alloc
1020 /* Defined in gmalloc.c. */
1021 void *aligned_alloc (size_t, size_t);
1023 # elif defined HAVE_ALIGNED_ALLOC
1024 # define USE_ALIGNED_ALLOC 1
1025 # elif defined HAVE_POSIX_MEMALIGN
1026 # define USE_ALIGNED_ALLOC 1
1028 aligned_alloc (size_t alignment
, size_t size
)
1031 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
1036 /* BLOCK_ALIGN has to be a power of 2. */
1037 #define BLOCK_ALIGN (1 << 10)
1039 /* Padding to leave at the end of a malloc'd block. This is to give
1040 malloc a chance to minimize the amount of memory wasted to alignment.
1041 It should be tuned to the particular malloc library used.
1042 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
1043 aligned_alloc on the other hand would ideally prefer a value of 4
1044 because otherwise, there's 1020 bytes wasted between each ablocks.
1045 In Emacs, testing shows that those 1020 can most of the time be
1046 efficiently used by malloc to place other objects, so a value of 0 can
1047 still preferable unless you have a lot of aligned blocks and virtually
1049 #define BLOCK_PADDING 0
1050 #define BLOCK_BYTES \
1051 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1053 /* Internal data structures and constants. */
1055 #define ABLOCKS_SIZE 16
1057 /* An aligned block of memory. */
1062 char payload
[BLOCK_BYTES
];
1063 struct ablock
*next_free
;
1065 /* `abase' is the aligned base of the ablocks. */
1066 /* It is overloaded to hold the virtual `busy' field that counts
1067 the number of used ablock in the parent ablocks.
1068 The first ablock has the `busy' field, the others have the `abase'
1069 field. To tell the difference, we assume that pointers will have
1070 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1071 is used to tell whether the real base of the parent ablocks is `abase'
1072 (if not, the word before the first ablock holds a pointer to the
1074 struct ablocks
*abase
;
1075 /* The padding of all but the last ablock is unused. The padding of
1076 the last ablock in an ablocks is not allocated. */
1078 char padding
[BLOCK_PADDING
];
1082 /* A bunch of consecutive aligned blocks. */
1085 struct ablock blocks
[ABLOCKS_SIZE
];
1088 /* Size of the block requested from malloc or aligned_alloc. */
1089 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1091 #define ABLOCK_ABASE(block) \
1092 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1093 ? (struct ablocks *)(block) \
1096 /* Virtual `busy' field. */
1097 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1099 /* Pointer to the (not necessarily aligned) malloc block. */
1100 #ifdef USE_ALIGNED_ALLOC
1101 #define ABLOCKS_BASE(abase) (abase)
1103 #define ABLOCKS_BASE(abase) \
1104 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1107 /* The list of free ablock. */
1108 static struct ablock
*free_ablock
;
1110 /* Allocate an aligned block of nbytes.
1111 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1112 smaller or equal to BLOCK_BYTES. */
1114 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1117 struct ablocks
*abase
;
1119 eassert (nbytes
<= BLOCK_BYTES
);
1123 #ifdef GC_MALLOC_CHECK
1124 allocated_mem_type
= type
;
1130 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1132 #ifdef DOUG_LEA_MALLOC
1133 if (!mmap_lisp_allowed_p ())
1134 mallopt (M_MMAP_MAX
, 0);
1137 #ifdef USE_ALIGNED_ALLOC
1138 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1140 base
= malloc (ABLOCKS_BYTES
);
1141 abase
= ALIGN (base
, BLOCK_ALIGN
);
1146 MALLOC_UNBLOCK_INPUT
;
1147 memory_full (ABLOCKS_BYTES
);
1150 aligned
= (base
== abase
);
1152 ((void **) abase
)[-1] = base
;
1154 #ifdef DOUG_LEA_MALLOC
1155 if (!mmap_lisp_allowed_p ())
1156 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1160 /* If the memory just allocated cannot be addressed thru a Lisp
1161 object's pointer, and it needs to be, that's equivalent to
1162 running out of memory. */
1163 if (type
!= MEM_TYPE_NON_LISP
)
1166 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1167 XSETCONS (tem
, end
);
1168 if ((char *) XCONS (tem
) != end
)
1170 lisp_malloc_loser
= base
;
1172 MALLOC_UNBLOCK_INPUT
;
1173 memory_full (SIZE_MAX
);
1178 /* Initialize the blocks and put them on the free list.
1179 If `base' was not properly aligned, we can't use the last block. */
1180 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1182 abase
->blocks
[i
].abase
= abase
;
1183 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1184 free_ablock
= &abase
->blocks
[i
];
1186 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1188 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1189 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1190 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1191 eassert (ABLOCKS_BASE (abase
) == base
);
1192 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1195 abase
= ABLOCK_ABASE (free_ablock
);
1196 ABLOCKS_BUSY (abase
)
1197 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1199 free_ablock
= free_ablock
->x
.next_free
;
1201 #ifndef GC_MALLOC_CHECK
1202 if (type
!= MEM_TYPE_NON_LISP
)
1203 mem_insert (val
, (char *) val
+ nbytes
, type
);
1206 MALLOC_UNBLOCK_INPUT
;
1208 MALLOC_PROBE (nbytes
);
1210 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1215 lisp_align_free (void *block
)
1217 struct ablock
*ablock
= block
;
1218 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1221 #ifndef GC_MALLOC_CHECK
1222 mem_delete (mem_find (block
));
1224 /* Put on free list. */
1225 ablock
->x
.next_free
= free_ablock
;
1226 free_ablock
= ablock
;
1227 /* Update busy count. */
1228 ABLOCKS_BUSY (abase
)
1229 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1231 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1232 { /* All the blocks are free. */
1233 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1234 struct ablock
**tem
= &free_ablock
;
1235 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1239 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1242 *tem
= (*tem
)->x
.next_free
;
1245 tem
= &(*tem
)->x
.next_free
;
1247 eassert ((aligned
& 1) == aligned
);
1248 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1249 #ifdef USE_POSIX_MEMALIGN
1250 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1252 free (ABLOCKS_BASE (abase
));
1254 MALLOC_UNBLOCK_INPUT
;
1258 /***********************************************************************
1260 ***********************************************************************/
1262 /* Number of intervals allocated in an interval_block structure.
1263 The 1020 is 1024 minus malloc overhead. */
1265 #define INTERVAL_BLOCK_SIZE \
1266 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1268 /* Intervals are allocated in chunks in the form of an interval_block
1271 struct interval_block
1273 /* Place `intervals' first, to preserve alignment. */
1274 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1275 struct interval_block
*next
;
1278 /* Current interval block. Its `next' pointer points to older
1281 static struct interval_block
*interval_block
;
1283 /* Index in interval_block above of the next unused interval
1286 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1288 /* Number of free and live intervals. */
1290 static EMACS_INT total_free_intervals
, total_intervals
;
1292 /* List of free intervals. */
1294 static INTERVAL interval_free_list
;
1296 /* Return a new interval. */
1299 make_interval (void)
1305 if (interval_free_list
)
1307 val
= interval_free_list
;
1308 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1312 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1314 struct interval_block
*newi
1315 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1317 newi
->next
= interval_block
;
1318 interval_block
= newi
;
1319 interval_block_index
= 0;
1320 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1322 val
= &interval_block
->intervals
[interval_block_index
++];
1325 MALLOC_UNBLOCK_INPUT
;
1327 consing_since_gc
+= sizeof (struct interval
);
1329 total_free_intervals
--;
1330 RESET_INTERVAL (val
);
1336 /* Mark Lisp objects in interval I. */
1339 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1341 /* Intervals should never be shared. So, if extra internal checking is
1342 enabled, GC aborts if it seems to have visited an interval twice. */
1343 eassert (!i
->gcmarkbit
);
1345 mark_object (i
->plist
);
1348 /* Mark the interval tree rooted in I. */
1350 #define MARK_INTERVAL_TREE(i) \
1352 if (i && !i->gcmarkbit) \
1353 traverse_intervals_noorder (i, mark_interval, Qnil); \
1356 /***********************************************************************
1358 ***********************************************************************/
1360 /* Lisp_Strings are allocated in string_block structures. When a new
1361 string_block is allocated, all the Lisp_Strings it contains are
1362 added to a free-list string_free_list. When a new Lisp_String is
1363 needed, it is taken from that list. During the sweep phase of GC,
1364 string_blocks that are entirely free are freed, except two which
1367 String data is allocated from sblock structures. Strings larger
1368 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1369 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1371 Sblocks consist internally of sdata structures, one for each
1372 Lisp_String. The sdata structure points to the Lisp_String it
1373 belongs to. The Lisp_String points back to the `u.data' member of
1374 its sdata structure.
1376 When a Lisp_String is freed during GC, it is put back on
1377 string_free_list, and its `data' member and its sdata's `string'
1378 pointer is set to null. The size of the string is recorded in the
1379 `n.nbytes' member of the sdata. So, sdata structures that are no
1380 longer used, can be easily recognized, and it's easy to compact the
1381 sblocks of small strings which we do in compact_small_strings. */
1383 /* Size in bytes of an sblock structure used for small strings. This
1384 is 8192 minus malloc overhead. */
1386 #define SBLOCK_SIZE 8188
1388 /* Strings larger than this are considered large strings. String data
1389 for large strings is allocated from individual sblocks. */
1391 #define LARGE_STRING_BYTES 1024
1393 /* The SDATA typedef is a struct or union describing string memory
1394 sub-allocated from an sblock. This is where the contents of Lisp
1395 strings are stored. */
1399 /* Back-pointer to the string this sdata belongs to. If null, this
1400 structure is free, and NBYTES (in this structure or in the union below)
1401 contains the string's byte size (the same value that STRING_BYTES
1402 would return if STRING were non-null). If non-null, STRING_BYTES
1403 (STRING) is the size of the data, and DATA contains the string's
1405 struct Lisp_String
*string
;
1407 #ifdef GC_CHECK_STRING_BYTES
1411 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1414 #ifdef GC_CHECK_STRING_BYTES
1416 typedef struct sdata sdata
;
1417 #define SDATA_NBYTES(S) (S)->nbytes
1418 #define SDATA_DATA(S) (S)->data
1424 struct Lisp_String
*string
;
1426 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1427 which has a flexible array member. However, if implemented by
1428 giving this union a member of type 'struct sdata', the union
1429 could not be the last (flexible) member of 'struct sblock',
1430 because C99 prohibits a flexible array member from having a type
1431 that is itself a flexible array. So, comment this member out here,
1432 but remember that the option's there when using this union. */
1437 /* When STRING is null. */
1440 struct Lisp_String
*string
;
1445 #define SDATA_NBYTES(S) (S)->n.nbytes
1446 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1448 #endif /* not GC_CHECK_STRING_BYTES */
1450 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1452 /* Structure describing a block of memory which is sub-allocated to
1453 obtain string data memory for strings. Blocks for small strings
1454 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1455 as large as needed. */
1460 struct sblock
*next
;
1462 /* Pointer to the next free sdata block. This points past the end
1463 of the sblock if there isn't any space left in this block. */
1467 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1470 /* Number of Lisp strings in a string_block structure. The 1020 is
1471 1024 minus malloc overhead. */
1473 #define STRING_BLOCK_SIZE \
1474 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1476 /* Structure describing a block from which Lisp_String structures
1481 /* Place `strings' first, to preserve alignment. */
1482 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1483 struct string_block
*next
;
1486 /* Head and tail of the list of sblock structures holding Lisp string
1487 data. We always allocate from current_sblock. The NEXT pointers
1488 in the sblock structures go from oldest_sblock to current_sblock. */
1490 static struct sblock
*oldest_sblock
, *current_sblock
;
1492 /* List of sblocks for large strings. */
1494 static struct sblock
*large_sblocks
;
1496 /* List of string_block structures. */
1498 static struct string_block
*string_blocks
;
1500 /* Free-list of Lisp_Strings. */
1502 static struct Lisp_String
*string_free_list
;
1504 /* Number of live and free Lisp_Strings. */
1506 static EMACS_INT total_strings
, total_free_strings
;
1508 /* Number of bytes used by live strings. */
1510 static EMACS_INT total_string_bytes
;
1512 /* Given a pointer to a Lisp_String S which is on the free-list
1513 string_free_list, return a pointer to its successor in the
1516 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1518 /* Return a pointer to the sdata structure belonging to Lisp string S.
1519 S must be live, i.e. S->data must not be null. S->data is actually
1520 a pointer to the `u.data' member of its sdata structure; the
1521 structure starts at a constant offset in front of that. */
1523 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1526 #ifdef GC_CHECK_STRING_OVERRUN
1528 /* We check for overrun in string data blocks by appending a small
1529 "cookie" after each allocated string data block, and check for the
1530 presence of this cookie during GC. */
1532 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1533 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1534 { '\xde', '\xad', '\xbe', '\xef' };
1537 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1540 /* Value is the size of an sdata structure large enough to hold NBYTES
1541 bytes of string data. The value returned includes a terminating
1542 NUL byte, the size of the sdata structure, and padding. */
1544 #ifdef GC_CHECK_STRING_BYTES
1546 #define SDATA_SIZE(NBYTES) \
1547 ((SDATA_DATA_OFFSET \
1549 + sizeof (ptrdiff_t) - 1) \
1550 & ~(sizeof (ptrdiff_t) - 1))
1552 #else /* not GC_CHECK_STRING_BYTES */
1554 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1555 less than the size of that member. The 'max' is not needed when
1556 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1557 alignment code reserves enough space. */
1559 #define SDATA_SIZE(NBYTES) \
1560 ((SDATA_DATA_OFFSET \
1561 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1563 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1565 + sizeof (ptrdiff_t) - 1) \
1566 & ~(sizeof (ptrdiff_t) - 1))
1568 #endif /* not GC_CHECK_STRING_BYTES */
1570 /* Extra bytes to allocate for each string. */
1572 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1574 /* Exact bound on the number of bytes in a string, not counting the
1575 terminating null. A string cannot contain more bytes than
1576 STRING_BYTES_BOUND, nor can it be so long that the size_t
1577 arithmetic in allocate_string_data would overflow while it is
1578 calculating a value to be passed to malloc. */
1579 static ptrdiff_t const STRING_BYTES_MAX
=
1580 min (STRING_BYTES_BOUND
,
1581 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1583 - offsetof (struct sblock
, data
)
1584 - SDATA_DATA_OFFSET
)
1585 & ~(sizeof (EMACS_INT
) - 1)));
1587 /* Initialize string allocation. Called from init_alloc_once. */
1592 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1593 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1597 #ifdef GC_CHECK_STRING_BYTES
1599 static int check_string_bytes_count
;
1601 /* Like STRING_BYTES, but with debugging check. Can be
1602 called during GC, so pay attention to the mark bit. */
1605 string_bytes (struct Lisp_String
*s
)
1608 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1610 if (!PURE_P (s
) && s
->data
&& nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1615 /* Check validity of Lisp strings' string_bytes member in B. */
1618 check_sblock (struct sblock
*b
)
1620 sdata
*from
, *end
, *from_end
;
1624 for (from
= b
->data
; from
< end
; from
= from_end
)
1626 /* Compute the next FROM here because copying below may
1627 overwrite data we need to compute it. */
1630 /* Check that the string size recorded in the string is the
1631 same as the one recorded in the sdata structure. */
1632 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1633 : SDATA_NBYTES (from
));
1634 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1639 /* Check validity of Lisp strings' string_bytes member. ALL_P
1640 means check all strings, otherwise check only most
1641 recently allocated strings. Used for hunting a bug. */
1644 check_string_bytes (bool all_p
)
1650 for (b
= large_sblocks
; b
; b
= b
->next
)
1652 struct Lisp_String
*s
= b
->data
[0].string
;
1657 for (b
= oldest_sblock
; b
; b
= b
->next
)
1660 else if (current_sblock
)
1661 check_sblock (current_sblock
);
1664 #else /* not GC_CHECK_STRING_BYTES */
1666 #define check_string_bytes(all) ((void) 0)
1668 #endif /* GC_CHECK_STRING_BYTES */
1670 #ifdef GC_CHECK_STRING_FREE_LIST
1672 /* Walk through the string free list looking for bogus next pointers.
1673 This may catch buffer overrun from a previous string. */
1676 check_string_free_list (void)
1678 struct Lisp_String
*s
;
1680 /* Pop a Lisp_String off the free-list. */
1681 s
= string_free_list
;
1684 if ((uintptr_t) s
< 1024)
1686 s
= NEXT_FREE_LISP_STRING (s
);
1690 #define check_string_free_list()
1693 /* Return a new Lisp_String. */
1695 static struct Lisp_String
*
1696 allocate_string (void)
1698 struct Lisp_String
*s
;
1702 /* If the free-list is empty, allocate a new string_block, and
1703 add all the Lisp_Strings in it to the free-list. */
1704 if (string_free_list
== NULL
)
1706 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1709 b
->next
= string_blocks
;
1712 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1715 /* Every string on a free list should have NULL data pointer. */
1717 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1718 string_free_list
= s
;
1721 total_free_strings
+= STRING_BLOCK_SIZE
;
1724 check_string_free_list ();
1726 /* Pop a Lisp_String off the free-list. */
1727 s
= string_free_list
;
1728 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1730 MALLOC_UNBLOCK_INPUT
;
1732 --total_free_strings
;
1735 consing_since_gc
+= sizeof *s
;
1737 #ifdef GC_CHECK_STRING_BYTES
1738 if (!noninteractive
)
1740 if (++check_string_bytes_count
== 200)
1742 check_string_bytes_count
= 0;
1743 check_string_bytes (1);
1746 check_string_bytes (0);
1748 #endif /* GC_CHECK_STRING_BYTES */
1754 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1755 plus a NUL byte at the end. Allocate an sdata structure for S, and
1756 set S->data to its `u.data' member. Store a NUL byte at the end of
1757 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1758 S->data if it was initially non-null. */
1761 allocate_string_data (struct Lisp_String
*s
,
1762 EMACS_INT nchars
, EMACS_INT nbytes
)
1764 sdata
*data
, *old_data
;
1766 ptrdiff_t needed
, old_nbytes
;
1768 if (STRING_BYTES_MAX
< nbytes
)
1771 /* Determine the number of bytes needed to store NBYTES bytes
1773 needed
= SDATA_SIZE (nbytes
);
1776 old_data
= SDATA_OF_STRING (s
);
1777 old_nbytes
= STRING_BYTES (s
);
1784 if (nbytes
> LARGE_STRING_BYTES
)
1786 size_t size
= offsetof (struct sblock
, data
) + needed
;
1788 #ifdef DOUG_LEA_MALLOC
1789 if (!mmap_lisp_allowed_p ())
1790 mallopt (M_MMAP_MAX
, 0);
1793 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1795 #ifdef DOUG_LEA_MALLOC
1796 if (!mmap_lisp_allowed_p ())
1797 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1800 b
->next_free
= b
->data
;
1801 b
->data
[0].string
= NULL
;
1802 b
->next
= large_sblocks
;
1805 else if (current_sblock
== NULL
1806 || (((char *) current_sblock
+ SBLOCK_SIZE
1807 - (char *) current_sblock
->next_free
)
1808 < (needed
+ GC_STRING_EXTRA
)))
1810 /* Not enough room in the current sblock. */
1811 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1812 b
->next_free
= b
->data
;
1813 b
->data
[0].string
= NULL
;
1817 current_sblock
->next
= b
;
1825 data
= b
->next_free
;
1826 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1828 MALLOC_UNBLOCK_INPUT
;
1831 s
->data
= SDATA_DATA (data
);
1832 #ifdef GC_CHECK_STRING_BYTES
1833 SDATA_NBYTES (data
) = nbytes
;
1836 s
->size_byte
= nbytes
;
1837 s
->data
[nbytes
] = '\0';
1838 #ifdef GC_CHECK_STRING_OVERRUN
1839 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1840 GC_STRING_OVERRUN_COOKIE_SIZE
);
1843 /* Note that Faset may call to this function when S has already data
1844 assigned. In this case, mark data as free by setting it's string
1845 back-pointer to null, and record the size of the data in it. */
1848 SDATA_NBYTES (old_data
) = old_nbytes
;
1849 old_data
->string
= NULL
;
1852 consing_since_gc
+= needed
;
1856 /* Sweep and compact strings. */
1858 NO_INLINE
/* For better stack traces */
1860 sweep_strings (void)
1862 struct string_block
*b
, *next
;
1863 struct string_block
*live_blocks
= NULL
;
1865 string_free_list
= NULL
;
1866 total_strings
= total_free_strings
= 0;
1867 total_string_bytes
= 0;
1869 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1870 for (b
= string_blocks
; b
; b
= next
)
1873 struct Lisp_String
*free_list_before
= string_free_list
;
1877 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1879 struct Lisp_String
*s
= b
->strings
+ i
;
1883 /* String was not on free-list before. */
1884 if (STRING_MARKED_P (s
))
1886 /* String is live; unmark it and its intervals. */
1889 /* Do not use string_(set|get)_intervals here. */
1890 s
->intervals
= balance_intervals (s
->intervals
);
1893 total_string_bytes
+= STRING_BYTES (s
);
1897 /* String is dead. Put it on the free-list. */
1898 sdata
*data
= SDATA_OF_STRING (s
);
1900 /* Save the size of S in its sdata so that we know
1901 how large that is. Reset the sdata's string
1902 back-pointer so that we know it's free. */
1903 #ifdef GC_CHECK_STRING_BYTES
1904 if (string_bytes (s
) != SDATA_NBYTES (data
))
1907 data
->n
.nbytes
= STRING_BYTES (s
);
1909 data
->string
= NULL
;
1911 /* Reset the strings's `data' member so that we
1915 /* Put the string on the free-list. */
1916 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1917 string_free_list
= s
;
1923 /* S was on the free-list before. Put it there again. */
1924 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1925 string_free_list
= s
;
1930 /* Free blocks that contain free Lisp_Strings only, except
1931 the first two of them. */
1932 if (nfree
== STRING_BLOCK_SIZE
1933 && total_free_strings
> STRING_BLOCK_SIZE
)
1936 string_free_list
= free_list_before
;
1940 total_free_strings
+= nfree
;
1941 b
->next
= live_blocks
;
1946 check_string_free_list ();
1948 string_blocks
= live_blocks
;
1949 free_large_strings ();
1950 compact_small_strings ();
1952 check_string_free_list ();
1956 /* Free dead large strings. */
1959 free_large_strings (void)
1961 struct sblock
*b
, *next
;
1962 struct sblock
*live_blocks
= NULL
;
1964 for (b
= large_sblocks
; b
; b
= next
)
1968 if (b
->data
[0].string
== NULL
)
1972 b
->next
= live_blocks
;
1977 large_sblocks
= live_blocks
;
1981 /* Compact data of small strings. Free sblocks that don't contain
1982 data of live strings after compaction. */
1985 compact_small_strings (void)
1987 struct sblock
*b
, *tb
, *next
;
1988 sdata
*from
, *to
, *end
, *tb_end
;
1989 sdata
*to_end
, *from_end
;
1991 /* TB is the sblock we copy to, TO is the sdata within TB we copy
1992 to, and TB_END is the end of TB. */
1994 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1997 /* Step through the blocks from the oldest to the youngest. We
1998 expect that old blocks will stabilize over time, so that less
1999 copying will happen this way. */
2000 for (b
= oldest_sblock
; b
; b
= b
->next
)
2003 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2005 for (from
= b
->data
; from
< end
; from
= from_end
)
2007 /* Compute the next FROM here because copying below may
2008 overwrite data we need to compute it. */
2010 struct Lisp_String
*s
= from
->string
;
2012 #ifdef GC_CHECK_STRING_BYTES
2013 /* Check that the string size recorded in the string is the
2014 same as the one recorded in the sdata structure. */
2015 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2017 #endif /* GC_CHECK_STRING_BYTES */
2019 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2020 eassert (nbytes
<= LARGE_STRING_BYTES
);
2022 nbytes
= SDATA_SIZE (nbytes
);
2023 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2025 #ifdef GC_CHECK_STRING_OVERRUN
2026 if (memcmp (string_overrun_cookie
,
2027 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2028 GC_STRING_OVERRUN_COOKIE_SIZE
))
2032 /* Non-NULL S means it's alive. Copy its data. */
2035 /* If TB is full, proceed with the next sblock. */
2036 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2037 if (to_end
> tb_end
)
2041 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2043 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2046 /* Copy, and update the string's `data' pointer. */
2049 eassert (tb
!= b
|| to
< from
);
2050 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2051 to
->string
->data
= SDATA_DATA (to
);
2054 /* Advance past the sdata we copied to. */
2060 /* The rest of the sblocks following TB don't contain live data, so
2061 we can free them. */
2062 for (b
= tb
->next
; b
; b
= next
)
2070 current_sblock
= tb
;
2074 string_overflow (void)
2076 error ("Maximum string size exceeded");
2079 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2080 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2081 LENGTH must be an integer.
2082 INIT must be an integer that represents a character. */)
2083 (Lisp_Object length
, Lisp_Object init
)
2085 register Lisp_Object val
;
2089 CHECK_NATNUM (length
);
2090 CHECK_CHARACTER (init
);
2092 c
= XFASTINT (init
);
2093 if (ASCII_CHAR_P (c
))
2095 nbytes
= XINT (length
);
2096 val
= make_uninit_string (nbytes
);
2097 memset (SDATA (val
), c
, nbytes
);
2098 SDATA (val
)[nbytes
] = 0;
2102 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2103 ptrdiff_t len
= CHAR_STRING (c
, str
);
2104 EMACS_INT string_len
= XINT (length
);
2105 unsigned char *p
, *beg
, *end
;
2107 if (string_len
> STRING_BYTES_MAX
/ len
)
2109 nbytes
= len
* string_len
;
2110 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2111 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2113 /* First time we just copy `str' to the data of `val'. */
2115 memcpy (p
, str
, len
);
2118 /* Next time we copy largest possible chunk from
2119 initialized to uninitialized part of `val'. */
2120 len
= min (p
- beg
, end
- p
);
2121 memcpy (p
, beg
, len
);
2130 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2134 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2136 EMACS_INT nbits
= bool_vector_size (a
);
2139 unsigned char *data
= bool_vector_uchar_data (a
);
2140 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2141 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2142 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2143 memset (data
, pattern
, nbytes
- 1);
2144 data
[nbytes
- 1] = pattern
& last_mask
;
2149 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2152 make_uninit_bool_vector (EMACS_INT nbits
)
2155 EMACS_INT words
= bool_vector_words (nbits
);
2156 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2157 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2160 struct Lisp_Bool_Vector
*p
2161 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2162 XSETVECTOR (val
, p
);
2163 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2166 /* Clear padding at the end. */
2168 p
->data
[words
- 1] = 0;
2173 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2174 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2175 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2176 (Lisp_Object length
, Lisp_Object init
)
2180 CHECK_NATNUM (length
);
2181 val
= make_uninit_bool_vector (XFASTINT (length
));
2182 return bool_vector_fill (val
, init
);
2185 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2186 doc
: /* Return a new bool-vector with specified arguments as elements.
2187 Any number of arguments, even zero arguments, are allowed.
2188 usage: (bool-vector &rest OBJECTS) */)
2189 (ptrdiff_t nargs
, Lisp_Object
*args
)
2194 vector
= make_uninit_bool_vector (nargs
);
2195 for (i
= 0; i
< nargs
; i
++)
2196 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2201 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2202 of characters from the contents. This string may be unibyte or
2203 multibyte, depending on the contents. */
2206 make_string (const char *contents
, ptrdiff_t nbytes
)
2208 register Lisp_Object val
;
2209 ptrdiff_t nchars
, multibyte_nbytes
;
2211 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2212 &nchars
, &multibyte_nbytes
);
2213 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2214 /* CONTENTS contains no multibyte sequences or contains an invalid
2215 multibyte sequence. We must make unibyte string. */
2216 val
= make_unibyte_string (contents
, nbytes
);
2218 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2222 /* Make a unibyte string from LENGTH bytes at CONTENTS. */
2225 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2227 register Lisp_Object val
;
2228 val
= make_uninit_string (length
);
2229 memcpy (SDATA (val
), contents
, length
);
2234 /* Make a multibyte string from NCHARS characters occupying NBYTES
2235 bytes at CONTENTS. */
2238 make_multibyte_string (const char *contents
,
2239 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2241 register Lisp_Object val
;
2242 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2243 memcpy (SDATA (val
), contents
, nbytes
);
2248 /* Make a string from NCHARS characters occupying NBYTES bytes at
2249 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2252 make_string_from_bytes (const char *contents
,
2253 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2255 register Lisp_Object val
;
2256 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2257 memcpy (SDATA (val
), contents
, nbytes
);
2258 if (SBYTES (val
) == SCHARS (val
))
2259 STRING_SET_UNIBYTE (val
);
2264 /* Make a string from NCHARS characters occupying NBYTES bytes at
2265 CONTENTS. The argument MULTIBYTE controls whether to label the
2266 string as multibyte. If NCHARS is negative, it counts the number of
2267 characters by itself. */
2270 make_specified_string (const char *contents
,
2271 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2278 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2283 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2284 memcpy (SDATA (val
), contents
, nbytes
);
2286 STRING_SET_UNIBYTE (val
);
2291 /* Return a unibyte Lisp_String set up to hold LENGTH characters
2292 occupying LENGTH bytes. */
2295 make_uninit_string (EMACS_INT length
)
2300 return empty_unibyte_string
;
2301 val
= make_uninit_multibyte_string (length
, length
);
2302 STRING_SET_UNIBYTE (val
);
2307 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2308 which occupy NBYTES bytes. */
2311 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2314 struct Lisp_String
*s
;
2319 return empty_multibyte_string
;
2321 s
= allocate_string ();
2322 s
->intervals
= NULL
;
2323 allocate_string_data (s
, nchars
, nbytes
);
2324 XSETSTRING (string
, s
);
2325 string_chars_consed
+= nbytes
;
2329 /* Print arguments to BUF according to a FORMAT, then return
2330 a Lisp_String initialized with the data from BUF. */
2333 make_formatted_string (char *buf
, const char *format
, ...)
2338 va_start (ap
, format
);
2339 length
= vsprintf (buf
, format
, ap
);
2341 return make_string (buf
, length
);
2345 /***********************************************************************
2347 ***********************************************************************/
2349 /* We store float cells inside of float_blocks, allocating a new
2350 float_block with malloc whenever necessary. Float cells reclaimed
2351 by GC are put on a free list to be reallocated before allocating
2352 any new float cells from the latest float_block. */
2354 #define FLOAT_BLOCK_SIZE \
2355 (((BLOCK_BYTES - sizeof (struct float_block *) \
2356 /* The compiler might add padding at the end. */ \
2357 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2358 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2360 #define GETMARKBIT(block,n) \
2361 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2362 >> ((n) % BITS_PER_BITS_WORD)) \
2365 #define SETMARKBIT(block,n) \
2366 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2367 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2369 #define UNSETMARKBIT(block,n) \
2370 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2371 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2373 #define FLOAT_BLOCK(fptr) \
2374 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2376 #define FLOAT_INDEX(fptr) \
2377 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2381 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2382 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2383 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2384 struct float_block
*next
;
2387 #define FLOAT_MARKED_P(fptr) \
2388 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2390 #define FLOAT_MARK(fptr) \
2391 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2393 #define FLOAT_UNMARK(fptr) \
2394 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2396 /* Current float_block. */
2398 static struct float_block
*float_block
;
2400 /* Index of first unused Lisp_Float in the current float_block. */
2402 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2404 /* Free-list of Lisp_Floats. */
2406 static struct Lisp_Float
*float_free_list
;
2408 /* Return a new float object with value FLOAT_VALUE. */
2411 make_float (double float_value
)
2413 register Lisp_Object val
;
2417 if (float_free_list
)
2419 /* We use the data field for chaining the free list
2420 so that we won't use the same field that has the mark bit. */
2421 XSETFLOAT (val
, float_free_list
);
2422 float_free_list
= float_free_list
->u
.chain
;
2426 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2428 struct float_block
*new
2429 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2430 new->next
= float_block
;
2431 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2433 float_block_index
= 0;
2434 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2436 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2437 float_block_index
++;
2440 MALLOC_UNBLOCK_INPUT
;
2442 XFLOAT_INIT (val
, float_value
);
2443 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2444 consing_since_gc
+= sizeof (struct Lisp_Float
);
2446 total_free_floats
--;
2452 /***********************************************************************
2454 ***********************************************************************/
2456 /* We store cons cells inside of cons_blocks, allocating a new
2457 cons_block with malloc whenever necessary. Cons cells reclaimed by
2458 GC are put on a free list to be reallocated before allocating
2459 any new cons cells from the latest cons_block. */
2461 #define CONS_BLOCK_SIZE \
2462 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2463 /* The compiler might add padding at the end. */ \
2464 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2465 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2467 #define CONS_BLOCK(fptr) \
2468 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2470 #define CONS_INDEX(fptr) \
2471 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2475 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2476 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2477 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2478 struct cons_block
*next
;
2481 #define CONS_MARKED_P(fptr) \
2482 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2484 #define CONS_MARK(fptr) \
2485 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2487 #define CONS_UNMARK(fptr) \
2488 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2490 /* Current cons_block. */
2492 static struct cons_block
*cons_block
;
2494 /* Index of first unused Lisp_Cons in the current block. */
2496 static int cons_block_index
= CONS_BLOCK_SIZE
;
2498 /* Free-list of Lisp_Cons structures. */
2500 static struct Lisp_Cons
*cons_free_list
;
2502 /* Explicitly free a cons cell by putting it on the free-list. */
2505 free_cons (struct Lisp_Cons
*ptr
)
2507 ptr
->u
.chain
= cons_free_list
;
2509 cons_free_list
= ptr
;
2510 consing_since_gc
-= sizeof *ptr
;
2511 total_free_conses
++;
2514 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2515 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2516 (Lisp_Object car
, Lisp_Object cdr
)
2518 register Lisp_Object val
;
2524 /* We use the cdr for chaining the free list
2525 so that we won't use the same field that has the mark bit. */
2526 XSETCONS (val
, cons_free_list
);
2527 cons_free_list
= cons_free_list
->u
.chain
;
2531 if (cons_block_index
== CONS_BLOCK_SIZE
)
2533 struct cons_block
*new
2534 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2535 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2536 new->next
= cons_block
;
2538 cons_block_index
= 0;
2539 total_free_conses
+= CONS_BLOCK_SIZE
;
2541 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2545 MALLOC_UNBLOCK_INPUT
;
2549 eassert (!CONS_MARKED_P (XCONS (val
)));
2550 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2551 total_free_conses
--;
2552 cons_cells_consed
++;
2556 #ifdef GC_CHECK_CONS_LIST
2557 /* Get an error now if there's any junk in the cons free list. */
2559 check_cons_list (void)
2561 struct Lisp_Cons
*tail
= cons_free_list
;
2564 tail
= tail
->u
.chain
;
2568 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2571 list1 (Lisp_Object arg1
)
2573 return Fcons (arg1
, Qnil
);
2577 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2579 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2584 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2586 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2591 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2593 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2598 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2600 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2601 Fcons (arg5
, Qnil
)))));
2604 /* Make a list of COUNT Lisp_Objects, where ARG is the
2605 first one. Allocate conses from pure space if TYPE
2606 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2609 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2611 Lisp_Object (*cons
) (Lisp_Object
, Lisp_Object
);
2614 case CONSTYPE_PURE
: cons
= pure_cons
; break;
2615 case CONSTYPE_HEAP
: cons
= Fcons
; break;
2616 default: emacs_abort ();
2619 eassume (0 < count
);
2620 Lisp_Object val
= cons (arg
, Qnil
);
2621 Lisp_Object tail
= val
;
2625 for (ptrdiff_t i
= 1; i
< count
; i
++)
2627 Lisp_Object elem
= cons (va_arg (ap
, Lisp_Object
), Qnil
);
2628 XSETCDR (tail
, elem
);
2636 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2637 doc
: /* Return a newly created list with specified arguments as elements.
2638 Any number of arguments, even zero arguments, are allowed.
2639 usage: (list &rest OBJECTS) */)
2640 (ptrdiff_t nargs
, Lisp_Object
*args
)
2642 register Lisp_Object val
;
2648 val
= Fcons (args
[nargs
], val
);
2654 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2655 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2656 (register Lisp_Object length
, Lisp_Object init
)
2658 register Lisp_Object val
;
2659 register EMACS_INT size
;
2661 CHECK_NATNUM (length
);
2662 size
= XFASTINT (length
);
2667 val
= Fcons (init
, val
);
2672 val
= Fcons (init
, val
);
2677 val
= Fcons (init
, val
);
2682 val
= Fcons (init
, val
);
2687 val
= Fcons (init
, val
);
2702 /***********************************************************************
2704 ***********************************************************************/
2706 /* Sometimes a vector's contents are merely a pointer internally used
2707 in vector allocation code. On the rare platforms where a null
2708 pointer cannot be tagged, represent it with a Lisp 0.
2709 Usually you don't want to touch this. */
2711 static struct Lisp_Vector
*
2712 next_vector (struct Lisp_Vector
*v
)
2714 return XUNTAG (v
->contents
[0], Lisp_Int0
);
2718 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2720 v
->contents
[0] = make_lisp_ptr (p
, Lisp_Int0
);
2723 /* This value is balanced well enough to avoid too much internal overhead
2724 for the most common cases; it's not required to be a power of two, but
2725 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2727 #define VECTOR_BLOCK_SIZE 4096
2731 /* Alignment of struct Lisp_Vector objects. */
2732 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2735 /* Vector size requests are a multiple of this. */
2736 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2739 /* Verify assumptions described above. */
2740 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2741 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2743 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2744 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2745 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2746 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2748 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2750 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2752 /* Size of the minimal vector allocated from block. */
2754 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2756 /* Size of the largest vector allocated from block. */
2758 #define VBLOCK_BYTES_MAX \
2759 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2761 /* We maintain one free list for each possible block-allocated
2762 vector size, and this is the number of free lists we have. */
2764 #define VECTOR_MAX_FREE_LIST_INDEX \
2765 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2767 /* Common shortcut to advance vector pointer over a block data. */
2769 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2771 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2773 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2775 /* Common shortcut to setup vector on a free list. */
2777 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2779 (tmp) = ((nbytes - header_size) / word_size); \
2780 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2781 eassert ((nbytes) % roundup_size == 0); \
2782 (tmp) = VINDEX (nbytes); \
2783 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2784 set_next_vector (v, vector_free_lists[tmp]); \
2785 vector_free_lists[tmp] = (v); \
2786 total_free_vector_slots += (nbytes) / word_size; \
2789 /* This internal type is used to maintain the list of large vectors
2790 which are allocated at their own, e.g. outside of vector blocks.
2792 struct large_vector itself cannot contain a struct Lisp_Vector, as
2793 the latter contains a flexible array member and C99 does not allow
2794 such structs to be nested. Instead, each struct large_vector
2795 object LV is followed by a struct Lisp_Vector, which is at offset
2796 large_vector_offset from LV, and whose address is therefore
2797 large_vector_vec (&LV). */
2801 struct large_vector
*next
;
2806 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2809 static struct Lisp_Vector
*
2810 large_vector_vec (struct large_vector
*p
)
2812 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
2815 /* This internal type is used to maintain an underlying storage
2816 for small vectors. */
2820 char data
[VECTOR_BLOCK_BYTES
];
2821 struct vector_block
*next
;
2824 /* Chain of vector blocks. */
2826 static struct vector_block
*vector_blocks
;
2828 /* Vector free lists, where NTH item points to a chain of free
2829 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2831 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2833 /* Singly-linked list of large vectors. */
2835 static struct large_vector
*large_vectors
;
2837 /* The only vector with 0 slots, allocated from pure space. */
2839 Lisp_Object zero_vector
;
2841 /* Number of live vectors. */
2843 static EMACS_INT total_vectors
;
2845 /* Total size of live and free vectors, in Lisp_Object units. */
2847 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2849 /* Get a new vector block. */
2851 static struct vector_block
*
2852 allocate_vector_block (void)
2854 struct vector_block
*block
= xmalloc (sizeof *block
);
2856 #ifndef GC_MALLOC_CHECK
2857 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2858 MEM_TYPE_VECTOR_BLOCK
);
2861 block
->next
= vector_blocks
;
2862 vector_blocks
= block
;
2866 /* Called once to initialize vector allocation. */
2871 zero_vector
= make_pure_vector (0);
2874 /* Allocate vector from a vector block. */
2876 static struct Lisp_Vector
*
2877 allocate_vector_from_block (size_t nbytes
)
2879 struct Lisp_Vector
*vector
;
2880 struct vector_block
*block
;
2881 size_t index
, restbytes
;
2883 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2884 eassert (nbytes
% roundup_size
== 0);
2886 /* First, try to allocate from a free list
2887 containing vectors of the requested size. */
2888 index
= VINDEX (nbytes
);
2889 if (vector_free_lists
[index
])
2891 vector
= vector_free_lists
[index
];
2892 vector_free_lists
[index
] = next_vector (vector
);
2893 total_free_vector_slots
-= nbytes
/ word_size
;
2897 /* Next, check free lists containing larger vectors. Since
2898 we will split the result, we should have remaining space
2899 large enough to use for one-slot vector at least. */
2900 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
2901 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
2902 if (vector_free_lists
[index
])
2904 /* This vector is larger than requested. */
2905 vector
= vector_free_lists
[index
];
2906 vector_free_lists
[index
] = next_vector (vector
);
2907 total_free_vector_slots
-= nbytes
/ word_size
;
2909 /* Excess bytes are used for the smaller vector,
2910 which should be set on an appropriate free list. */
2911 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
2912 eassert (restbytes
% roundup_size
== 0);
2913 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2917 /* Finally, need a new vector block. */
2918 block
= allocate_vector_block ();
2920 /* New vector will be at the beginning of this block. */
2921 vector
= (struct Lisp_Vector
*) block
->data
;
2923 /* If the rest of space from this block is large enough
2924 for one-slot vector at least, set up it on a free list. */
2925 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
2926 if (restbytes
>= VBLOCK_BYTES_MIN
)
2928 eassert (restbytes
% roundup_size
== 0);
2929 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2934 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
2936 #define VECTOR_IN_BLOCK(vector, block) \
2937 ((char *) (vector) <= (block)->data \
2938 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
2940 /* Return the memory footprint of V in bytes. */
2943 vector_nbytes (struct Lisp_Vector
*v
)
2945 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
2948 if (size
& PSEUDOVECTOR_FLAG
)
2950 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
2952 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
2953 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
2954 * sizeof (bits_word
));
2955 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
2956 verify (header_size
<= bool_header_size
);
2957 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
2960 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
2961 + ((size
& PSEUDOVECTOR_REST_MASK
)
2962 >> PSEUDOVECTOR_SIZE_BITS
));
2966 return vroundup (header_size
+ word_size
* nwords
);
2969 /* Release extra resources still in use by VECTOR, which may be any
2970 vector-like object. For now, this is used just to free data in
2974 cleanup_vector (struct Lisp_Vector
*vector
)
2976 detect_suspicious_free (vector
);
2977 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
2978 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
2979 == FONT_OBJECT_MAX
))
2981 struct font_driver
*drv
= ((struct font
*) vector
)->driver
;
2983 /* The font driver might sometimes be NULL, e.g. if Emacs was
2984 interrupted before it had time to set it up. */
2987 /* Attempt to catch subtle bugs like Bug#16140. */
2988 eassert (valid_font_driver (drv
));
2989 drv
->close ((struct font
*) vector
);
2994 /* Reclaim space used by unmarked vectors. */
2996 NO_INLINE
/* For better stack traces */
2998 sweep_vectors (void)
3000 struct vector_block
*block
, **bprev
= &vector_blocks
;
3001 struct large_vector
*lv
, **lvprev
= &large_vectors
;
3002 struct Lisp_Vector
*vector
, *next
;
3004 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3005 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3007 /* Looking through vector blocks. */
3009 for (block
= vector_blocks
; block
; block
= *bprev
)
3011 bool free_this_block
= 0;
3014 for (vector
= (struct Lisp_Vector
*) block
->data
;
3015 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3017 if (VECTOR_MARKED_P (vector
))
3019 VECTOR_UNMARK (vector
);
3021 nbytes
= vector_nbytes (vector
);
3022 total_vector_slots
+= nbytes
/ word_size
;
3023 next
= ADVANCE (vector
, nbytes
);
3027 ptrdiff_t total_bytes
;
3029 cleanup_vector (vector
);
3030 nbytes
= vector_nbytes (vector
);
3031 total_bytes
= nbytes
;
3032 next
= ADVANCE (vector
, nbytes
);
3034 /* While NEXT is not marked, try to coalesce with VECTOR,
3035 thus making VECTOR of the largest possible size. */
3037 while (VECTOR_IN_BLOCK (next
, block
))
3039 if (VECTOR_MARKED_P (next
))
3041 cleanup_vector (next
);
3042 nbytes
= vector_nbytes (next
);
3043 total_bytes
+= nbytes
;
3044 next
= ADVANCE (next
, nbytes
);
3047 eassert (total_bytes
% roundup_size
== 0);
3049 if (vector
== (struct Lisp_Vector
*) block
->data
3050 && !VECTOR_IN_BLOCK (next
, block
))
3051 /* This block should be freed because all of its
3052 space was coalesced into the only free vector. */
3053 free_this_block
= 1;
3057 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3062 if (free_this_block
)
3064 *bprev
= block
->next
;
3065 #ifndef GC_MALLOC_CHECK
3066 mem_delete (mem_find (block
->data
));
3071 bprev
= &block
->next
;
3074 /* Sweep large vectors. */
3076 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
3078 vector
= large_vector_vec (lv
);
3079 if (VECTOR_MARKED_P (vector
))
3081 VECTOR_UNMARK (vector
);
3083 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3085 /* All non-bool pseudovectors are small enough to be allocated
3086 from vector blocks. This code should be redesigned if some
3087 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3088 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3089 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3093 += header_size
/ word_size
+ vector
->header
.size
;
3104 /* Value is a pointer to a newly allocated Lisp_Vector structure
3105 with room for LEN Lisp_Objects. */
3107 static struct Lisp_Vector
*
3108 allocate_vectorlike (ptrdiff_t len
)
3110 struct Lisp_Vector
*p
;
3115 p
= XVECTOR (zero_vector
);
3118 size_t nbytes
= header_size
+ len
* word_size
;
3120 #ifdef DOUG_LEA_MALLOC
3121 if (!mmap_lisp_allowed_p ())
3122 mallopt (M_MMAP_MAX
, 0);
3125 if (nbytes
<= VBLOCK_BYTES_MAX
)
3126 p
= allocate_vector_from_block (vroundup (nbytes
));
3129 struct large_vector
*lv
3130 = lisp_malloc ((large_vector_offset
+ header_size
3132 MEM_TYPE_VECTORLIKE
);
3133 lv
->next
= large_vectors
;
3135 p
= large_vector_vec (lv
);
3138 #ifdef DOUG_LEA_MALLOC
3139 if (!mmap_lisp_allowed_p ())
3140 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3143 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3146 consing_since_gc
+= nbytes
;
3147 vector_cells_consed
+= len
;
3150 MALLOC_UNBLOCK_INPUT
;
3156 /* Allocate a vector with LEN slots. */
3158 struct Lisp_Vector
*
3159 allocate_vector (EMACS_INT len
)
3161 struct Lisp_Vector
*v
;
3162 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3164 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3165 memory_full (SIZE_MAX
);
3166 v
= allocate_vectorlike (len
);
3167 v
->header
.size
= len
;
3172 /* Allocate other vector-like structures. */
3174 struct Lisp_Vector
*
3175 allocate_pseudovector (int memlen
, int lisplen
,
3176 int zerolen
, enum pvec_type tag
)
3178 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3180 /* Catch bogus values. */
3181 eassert (0 <= tag
&& tag
<= PVEC_FONT
);
3182 eassert (0 <= lisplen
&& lisplen
<= zerolen
&& zerolen
<= memlen
);
3183 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3184 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3186 /* Only the first LISPLEN slots will be traced normally by the GC. */
3187 memclear (v
->contents
, zerolen
* word_size
);
3188 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3193 allocate_buffer (void)
3195 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3197 BUFFER_PVEC_INIT (b
);
3198 /* Put B on the chain of all buffers including killed ones. */
3199 b
->next
= all_buffers
;
3201 /* Note that the rest fields of B are not initialized. */
3205 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3206 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3207 See also the function `vector'. */)
3208 (register Lisp_Object length
, Lisp_Object init
)
3211 register ptrdiff_t sizei
;
3212 register ptrdiff_t i
;
3213 register struct Lisp_Vector
*p
;
3215 CHECK_NATNUM (length
);
3217 p
= allocate_vector (XFASTINT (length
));
3218 sizei
= XFASTINT (length
);
3219 for (i
= 0; i
< sizei
; i
++)
3220 p
->contents
[i
] = init
;
3222 XSETVECTOR (vector
, p
);
3226 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3227 doc
: /* Return a newly created vector with specified arguments as elements.
3228 Any number of arguments, even zero arguments, are allowed.
3229 usage: (vector &rest OBJECTS) */)
3230 (ptrdiff_t nargs
, Lisp_Object
*args
)
3233 register Lisp_Object val
= make_uninit_vector (nargs
);
3234 register struct Lisp_Vector
*p
= XVECTOR (val
);
3236 for (i
= 0; i
< nargs
; i
++)
3237 p
->contents
[i
] = args
[i
];
3242 make_byte_code (struct Lisp_Vector
*v
)
3244 /* Don't allow the global zero_vector to become a byte code object. */
3245 eassert (0 < v
->header
.size
);
3247 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3248 && STRING_MULTIBYTE (v
->contents
[1]))
3249 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3250 earlier because they produced a raw 8-bit string for byte-code
3251 and now such a byte-code string is loaded as multibyte while
3252 raw 8-bit characters converted to multibyte form. Thus, now we
3253 must convert them back to the original unibyte form. */
3254 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3255 XSETPVECTYPE (v
, PVEC_COMPILED
);
3258 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3259 doc
: /* Create a byte-code object with specified arguments as elements.
3260 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3261 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3262 and (optional) INTERACTIVE-SPEC.
3263 The first four arguments are required; at most six have any
3265 The ARGLIST can be either like the one of `lambda', in which case the arguments
3266 will be dynamically bound before executing the byte code, or it can be an
3267 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3268 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3269 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3270 argument to catch the left-over arguments. If such an integer is used, the
3271 arguments will not be dynamically bound but will be instead pushed on the
3272 stack before executing the byte-code.
3273 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3274 (ptrdiff_t nargs
, Lisp_Object
*args
)
3277 register Lisp_Object val
= make_uninit_vector (nargs
);
3278 register struct Lisp_Vector
*p
= XVECTOR (val
);
3280 /* We used to purecopy everything here, if purify-flag was set. This worked
3281 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3282 dangerous, since make-byte-code is used during execution to build
3283 closures, so any closure built during the preload phase would end up
3284 copied into pure space, including its free variables, which is sometimes
3285 just wasteful and other times plainly wrong (e.g. those free vars may want
3288 for (i
= 0; i
< nargs
; i
++)
3289 p
->contents
[i
] = args
[i
];
3291 XSETCOMPILED (val
, p
);
3297 /***********************************************************************
3299 ***********************************************************************/
3301 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3302 of the required alignment. */
3304 union aligned_Lisp_Symbol
3306 struct Lisp_Symbol s
;
3307 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3311 /* Each symbol_block is just under 1020 bytes long, since malloc
3312 really allocates in units of powers of two and uses 4 bytes for its
3315 #define SYMBOL_BLOCK_SIZE \
3316 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3320 /* Place `symbols' first, to preserve alignment. */
3321 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3322 struct symbol_block
*next
;
3325 /* Current symbol block and index of first unused Lisp_Symbol
3328 static struct symbol_block
*symbol_block
;
3329 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3330 /* Pointer to the first symbol_block that contains pinned symbols.
3331 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3332 10K of which are pinned (and all but 250 of them are interned in obarray),
3333 whereas a "typical session" has in the order of 30K symbols.
3334 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3335 than 30K to find the 10K symbols we need to mark. */
3336 static struct symbol_block
*symbol_block_pinned
;
3338 /* List of free symbols. */
3340 static struct Lisp_Symbol
*symbol_free_list
;
3343 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3345 XSYMBOL (sym
)->name
= name
;
3349 init_symbol (Lisp_Object val
, Lisp_Object name
)
3351 struct Lisp_Symbol
*p
= XSYMBOL (val
);
3352 set_symbol_name (val
, name
);
3353 set_symbol_plist (val
, Qnil
);
3354 p
->redirect
= SYMBOL_PLAINVAL
;
3355 SET_SYMBOL_VAL (p
, Qunbound
);
3356 set_symbol_function (val
, Qnil
);
3357 set_symbol_next (val
, NULL
);
3358 p
->gcmarkbit
= false;
3359 p
->interned
= SYMBOL_UNINTERNED
;
3361 p
->declared_special
= false;
3365 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3366 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3367 Its value is void, and its function definition and property list are nil. */)
3372 CHECK_STRING (name
);
3376 if (symbol_free_list
)
3378 XSETSYMBOL (val
, symbol_free_list
);
3379 symbol_free_list
= symbol_free_list
->next
;
3383 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3385 struct symbol_block
*new
3386 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3387 new->next
= symbol_block
;
3389 symbol_block_index
= 0;
3390 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3392 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3393 symbol_block_index
++;
3396 MALLOC_UNBLOCK_INPUT
;
3398 init_symbol (val
, name
);
3399 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3401 total_free_symbols
--;
3407 /***********************************************************************
3408 Marker (Misc) Allocation
3409 ***********************************************************************/
3411 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3412 the required alignment. */
3414 union aligned_Lisp_Misc
3417 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3421 /* Allocation of markers and other objects that share that structure.
3422 Works like allocation of conses. */
3424 #define MARKER_BLOCK_SIZE \
3425 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3429 /* Place `markers' first, to preserve alignment. */
3430 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3431 struct marker_block
*next
;
3434 static struct marker_block
*marker_block
;
3435 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3437 static union Lisp_Misc
*marker_free_list
;
3439 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3442 allocate_misc (enum Lisp_Misc_Type type
)
3448 if (marker_free_list
)
3450 XSETMISC (val
, marker_free_list
);
3451 marker_free_list
= marker_free_list
->u_free
.chain
;
3455 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3457 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3458 new->next
= marker_block
;
3460 marker_block_index
= 0;
3461 total_free_markers
+= MARKER_BLOCK_SIZE
;
3463 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3464 marker_block_index
++;
3467 MALLOC_UNBLOCK_INPUT
;
3469 --total_free_markers
;
3470 consing_since_gc
+= sizeof (union Lisp_Misc
);
3471 misc_objects_consed
++;
3472 XMISCANY (val
)->type
= type
;
3473 XMISCANY (val
)->gcmarkbit
= 0;
3477 /* Free a Lisp_Misc object. */
3480 free_misc (Lisp_Object misc
)
3482 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3483 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3484 marker_free_list
= XMISC (misc
);
3485 consing_since_gc
-= sizeof (union Lisp_Misc
);
3486 total_free_markers
++;
3489 /* Verify properties of Lisp_Save_Value's representation
3490 that are assumed here and elsewhere. */
3492 verify (SAVE_UNUSED
== 0);
3493 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3497 /* Return Lisp_Save_Value objects for the various combinations
3498 that callers need. */
3501 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3503 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3504 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3505 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3506 p
->data
[0].integer
= a
;
3507 p
->data
[1].integer
= b
;
3508 p
->data
[2].integer
= c
;
3513 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3516 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3517 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3518 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3519 p
->data
[0].object
= a
;
3520 p
->data
[1].object
= b
;
3521 p
->data
[2].object
= c
;
3522 p
->data
[3].object
= d
;
3527 make_save_ptr (void *a
)
3529 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3530 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3531 p
->save_type
= SAVE_POINTER
;
3532 p
->data
[0].pointer
= a
;
3537 make_save_ptr_int (void *a
, ptrdiff_t b
)
3539 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3540 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3541 p
->save_type
= SAVE_TYPE_PTR_INT
;
3542 p
->data
[0].pointer
= a
;
3543 p
->data
[1].integer
= b
;
3547 #if ! (defined USE_X_TOOLKIT || defined USE_GTK)
3549 make_save_ptr_ptr (void *a
, void *b
)
3551 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3552 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3553 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3554 p
->data
[0].pointer
= a
;
3555 p
->data
[1].pointer
= b
;
3561 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3563 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3564 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3565 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3566 p
->data
[0].funcpointer
= a
;
3567 p
->data
[1].pointer
= b
;
3568 p
->data
[2].object
= c
;
3572 /* Return a Lisp_Save_Value object that represents an array A
3573 of N Lisp objects. */
3576 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3578 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3579 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3580 p
->save_type
= SAVE_TYPE_MEMORY
;
3581 p
->data
[0].pointer
= a
;
3582 p
->data
[1].integer
= n
;
3586 /* Free a Lisp_Save_Value object. Do not use this function
3587 if SAVE contains pointer other than returned by xmalloc. */
3590 free_save_value (Lisp_Object save
)
3592 xfree (XSAVE_POINTER (save
, 0));
3596 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3599 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3601 register Lisp_Object overlay
;
3603 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3604 OVERLAY_START (overlay
) = start
;
3605 OVERLAY_END (overlay
) = end
;
3606 set_overlay_plist (overlay
, plist
);
3607 XOVERLAY (overlay
)->next
= NULL
;
3611 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3612 doc
: /* Return a newly allocated marker which does not point at any place. */)
3615 register Lisp_Object val
;
3616 register struct Lisp_Marker
*p
;
3618 val
= allocate_misc (Lisp_Misc_Marker
);
3624 p
->insertion_type
= 0;
3625 p
->need_adjustment
= 0;
3629 /* Return a newly allocated marker which points into BUF
3630 at character position CHARPOS and byte position BYTEPOS. */
3633 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3636 struct Lisp_Marker
*m
;
3638 /* No dead buffers here. */
3639 eassert (BUFFER_LIVE_P (buf
));
3641 /* Every character is at least one byte. */
3642 eassert (charpos
<= bytepos
);
3644 obj
= allocate_misc (Lisp_Misc_Marker
);
3647 m
->charpos
= charpos
;
3648 m
->bytepos
= bytepos
;
3649 m
->insertion_type
= 0;
3650 m
->need_adjustment
= 0;
3651 m
->next
= BUF_MARKERS (buf
);
3652 BUF_MARKERS (buf
) = m
;
3656 /* Put MARKER back on the free list after using it temporarily. */
3659 free_marker (Lisp_Object marker
)
3661 unchain_marker (XMARKER (marker
));
3666 /* Return a newly created vector or string with specified arguments as
3667 elements. If all the arguments are characters that can fit
3668 in a string of events, make a string; otherwise, make a vector.
3670 Any number of arguments, even zero arguments, are allowed. */
3673 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3677 for (i
= 0; i
< nargs
; i
++)
3678 /* The things that fit in a string
3679 are characters that are in 0...127,
3680 after discarding the meta bit and all the bits above it. */
3681 if (!INTEGERP (args
[i
])
3682 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3683 return Fvector (nargs
, args
);
3685 /* Since the loop exited, we know that all the things in it are
3686 characters, so we can make a string. */
3690 result
= Fmake_string (make_number (nargs
), make_number (0));
3691 for (i
= 0; i
< nargs
; i
++)
3693 SSET (result
, i
, XINT (args
[i
]));
3694 /* Move the meta bit to the right place for a string char. */
3695 if (XINT (args
[i
]) & CHAR_META
)
3696 SSET (result
, i
, SREF (result
, i
) | 0x80);
3704 init_finalizer_list (struct Lisp_Finalizer
*head
)
3706 head
->prev
= head
->next
= head
;
3709 /* Insert FINALIZER before ELEMENT. */
3712 finalizer_insert (struct Lisp_Finalizer
*element
,
3713 struct Lisp_Finalizer
*finalizer
)
3715 eassert (finalizer
->prev
== NULL
);
3716 eassert (finalizer
->next
== NULL
);
3717 finalizer
->next
= element
;
3718 finalizer
->prev
= element
->prev
;
3719 finalizer
->prev
->next
= finalizer
;
3720 element
->prev
= finalizer
;
3724 unchain_finalizer (struct Lisp_Finalizer
*finalizer
)
3726 if (finalizer
->prev
!= NULL
)
3728 eassert (finalizer
->next
!= NULL
);
3729 finalizer
->prev
->next
= finalizer
->next
;
3730 finalizer
->next
->prev
= finalizer
->prev
;
3731 finalizer
->prev
= finalizer
->next
= NULL
;
3736 mark_finalizer_list (struct Lisp_Finalizer
*head
)
3738 for (struct Lisp_Finalizer
*finalizer
= head
->next
;
3740 finalizer
= finalizer
->next
)
3742 finalizer
->base
.gcmarkbit
= true;
3743 mark_object (finalizer
->function
);
3747 /* Move doomed finalizers to list DEST from list SRC. A doomed
3748 finalizer is one that is not GC-reachable and whose
3749 finalizer->function is non-nil. */
3752 queue_doomed_finalizers (struct Lisp_Finalizer
*dest
,
3753 struct Lisp_Finalizer
*src
)
3755 struct Lisp_Finalizer
*finalizer
= src
->next
;
3756 while (finalizer
!= src
)
3758 struct Lisp_Finalizer
*next
= finalizer
->next
;
3759 if (!finalizer
->base
.gcmarkbit
&& !NILP (finalizer
->function
))
3761 unchain_finalizer (finalizer
);
3762 finalizer_insert (dest
, finalizer
);
3770 run_finalizer_handler (Lisp_Object args
)
3772 add_to_log ("finalizer failed: %S", args
);
3777 run_finalizer_function (Lisp_Object function
)
3779 ptrdiff_t count
= SPECPDL_INDEX ();
3781 specbind (Qinhibit_quit
, Qt
);
3782 internal_condition_case_1 (call0
, function
, Qt
, run_finalizer_handler
);
3783 unbind_to (count
, Qnil
);
3787 run_finalizers (struct Lisp_Finalizer
*finalizers
)
3789 struct Lisp_Finalizer
*finalizer
;
3790 Lisp_Object function
;
3792 while (finalizers
->next
!= finalizers
)
3794 finalizer
= finalizers
->next
;
3795 eassert (finalizer
->base
.type
== Lisp_Misc_Finalizer
);
3796 unchain_finalizer (finalizer
);
3797 function
= finalizer
->function
;
3798 if (!NILP (function
))
3800 finalizer
->function
= Qnil
;
3801 run_finalizer_function (function
);
3806 DEFUN ("make-finalizer", Fmake_finalizer
, Smake_finalizer
, 1, 1, 0,
3807 doc
: /* Make a finalizer that will run FUNCTION.
3808 FUNCTION will be called after garbage collection when the returned
3809 finalizer object becomes unreachable. If the finalizer object is
3810 reachable only through references from finalizer objects, it does not
3811 count as reachable for the purpose of deciding whether to run
3812 FUNCTION. FUNCTION will be run once per finalizer object. */)
3813 (Lisp_Object function
)
3815 Lisp_Object val
= allocate_misc (Lisp_Misc_Finalizer
);
3816 struct Lisp_Finalizer
*finalizer
= XFINALIZER (val
);
3817 finalizer
->function
= function
;
3818 finalizer
->prev
= finalizer
->next
= NULL
;
3819 finalizer_insert (&finalizers
, finalizer
);
3824 /************************************************************************
3825 Memory Full Handling
3826 ************************************************************************/
3829 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3830 there may have been size_t overflow so that malloc was never
3831 called, or perhaps malloc was invoked successfully but the
3832 resulting pointer had problems fitting into a tagged EMACS_INT. In
3833 either case this counts as memory being full even though malloc did
3837 memory_full (size_t nbytes
)
3839 /* Do not go into hysterics merely because a large request failed. */
3840 bool enough_free_memory
= 0;
3841 if (SPARE_MEMORY
< nbytes
)
3846 p
= malloc (SPARE_MEMORY
);
3850 enough_free_memory
= 1;
3852 MALLOC_UNBLOCK_INPUT
;
3855 if (! enough_free_memory
)
3861 memory_full_cons_threshold
= sizeof (struct cons_block
);
3863 /* The first time we get here, free the spare memory. */
3864 for (i
= 0; i
< ARRAYELTS (spare_memory
); i
++)
3865 if (spare_memory
[i
])
3868 free (spare_memory
[i
]);
3869 else if (i
>= 1 && i
<= 4)
3870 lisp_align_free (spare_memory
[i
]);
3872 lisp_free (spare_memory
[i
]);
3873 spare_memory
[i
] = 0;
3877 /* This used to call error, but if we've run out of memory, we could
3878 get infinite recursion trying to build the string. */
3879 xsignal (Qnil
, Vmemory_signal_data
);
3882 /* If we released our reserve (due to running out of memory),
3883 and we have a fair amount free once again,
3884 try to set aside another reserve in case we run out once more.
3886 This is called when a relocatable block is freed in ralloc.c,
3887 and also directly from this file, in case we're not using ralloc.c. */
3890 refill_memory_reserve (void)
3892 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3893 if (spare_memory
[0] == 0)
3894 spare_memory
[0] = malloc (SPARE_MEMORY
);
3895 if (spare_memory
[1] == 0)
3896 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3898 if (spare_memory
[2] == 0)
3899 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3901 if (spare_memory
[3] == 0)
3902 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3904 if (spare_memory
[4] == 0)
3905 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3907 if (spare_memory
[5] == 0)
3908 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3910 if (spare_memory
[6] == 0)
3911 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3913 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3914 Vmemory_full
= Qnil
;
3918 /************************************************************************
3920 ************************************************************************/
3922 /* Conservative C stack marking requires a method to identify possibly
3923 live Lisp objects given a pointer value. We do this by keeping
3924 track of blocks of Lisp data that are allocated in a red-black tree
3925 (see also the comment of mem_node which is the type of nodes in
3926 that tree). Function lisp_malloc adds information for an allocated
3927 block to the red-black tree with calls to mem_insert, and function
3928 lisp_free removes it with mem_delete. Functions live_string_p etc
3929 call mem_find to lookup information about a given pointer in the
3930 tree, and use that to determine if the pointer points to a Lisp
3933 /* Initialize this part of alloc.c. */
3938 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3939 mem_z
.parent
= NULL
;
3940 mem_z
.color
= MEM_BLACK
;
3941 mem_z
.start
= mem_z
.end
= NULL
;
3946 /* Value is a pointer to the mem_node containing START. Value is
3947 MEM_NIL if there is no node in the tree containing START. */
3949 static struct mem_node
*
3950 mem_find (void *start
)
3954 if (start
< min_heap_address
|| start
> max_heap_address
)
3957 /* Make the search always successful to speed up the loop below. */
3958 mem_z
.start
= start
;
3959 mem_z
.end
= (char *) start
+ 1;
3962 while (start
< p
->start
|| start
>= p
->end
)
3963 p
= start
< p
->start
? p
->left
: p
->right
;
3968 /* Insert a new node into the tree for a block of memory with start
3969 address START, end address END, and type TYPE. Value is a
3970 pointer to the node that was inserted. */
3972 static struct mem_node
*
3973 mem_insert (void *start
, void *end
, enum mem_type type
)
3975 struct mem_node
*c
, *parent
, *x
;
3977 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3978 min_heap_address
= start
;
3979 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3980 max_heap_address
= end
;
3982 /* See where in the tree a node for START belongs. In this
3983 particular application, it shouldn't happen that a node is already
3984 present. For debugging purposes, let's check that. */
3988 while (c
!= MEM_NIL
)
3991 c
= start
< c
->start
? c
->left
: c
->right
;
3994 /* Create a new node. */
3995 #ifdef GC_MALLOC_CHECK
3996 x
= malloc (sizeof *x
);
4000 x
= xmalloc (sizeof *x
);
4006 x
->left
= x
->right
= MEM_NIL
;
4009 /* Insert it as child of PARENT or install it as root. */
4012 if (start
< parent
->start
)
4020 /* Re-establish red-black tree properties. */
4021 mem_insert_fixup (x
);
4027 /* Re-establish the red-black properties of the tree, and thereby
4028 balance the tree, after node X has been inserted; X is always red. */
4031 mem_insert_fixup (struct mem_node
*x
)
4033 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
4035 /* X is red and its parent is red. This is a violation of
4036 red-black tree property #3. */
4038 if (x
->parent
== x
->parent
->parent
->left
)
4040 /* We're on the left side of our grandparent, and Y is our
4042 struct mem_node
*y
= x
->parent
->parent
->right
;
4044 if (y
->color
== MEM_RED
)
4046 /* Uncle and parent are red but should be black because
4047 X is red. Change the colors accordingly and proceed
4048 with the grandparent. */
4049 x
->parent
->color
= MEM_BLACK
;
4050 y
->color
= MEM_BLACK
;
4051 x
->parent
->parent
->color
= MEM_RED
;
4052 x
= x
->parent
->parent
;
4056 /* Parent and uncle have different colors; parent is
4057 red, uncle is black. */
4058 if (x
== x
->parent
->right
)
4061 mem_rotate_left (x
);
4064 x
->parent
->color
= MEM_BLACK
;
4065 x
->parent
->parent
->color
= MEM_RED
;
4066 mem_rotate_right (x
->parent
->parent
);
4071 /* This is the symmetrical case of above. */
4072 struct mem_node
*y
= x
->parent
->parent
->left
;
4074 if (y
->color
== MEM_RED
)
4076 x
->parent
->color
= MEM_BLACK
;
4077 y
->color
= MEM_BLACK
;
4078 x
->parent
->parent
->color
= MEM_RED
;
4079 x
= x
->parent
->parent
;
4083 if (x
== x
->parent
->left
)
4086 mem_rotate_right (x
);
4089 x
->parent
->color
= MEM_BLACK
;
4090 x
->parent
->parent
->color
= MEM_RED
;
4091 mem_rotate_left (x
->parent
->parent
);
4096 /* The root may have been changed to red due to the algorithm. Set
4097 it to black so that property #5 is satisfied. */
4098 mem_root
->color
= MEM_BLACK
;
4109 mem_rotate_left (struct mem_node
*x
)
4113 /* Turn y's left sub-tree into x's right sub-tree. */
4116 if (y
->left
!= MEM_NIL
)
4117 y
->left
->parent
= x
;
4119 /* Y's parent was x's parent. */
4121 y
->parent
= x
->parent
;
4123 /* Get the parent to point to y instead of x. */
4126 if (x
== x
->parent
->left
)
4127 x
->parent
->left
= y
;
4129 x
->parent
->right
= y
;
4134 /* Put x on y's left. */
4148 mem_rotate_right (struct mem_node
*x
)
4150 struct mem_node
*y
= x
->left
;
4153 if (y
->right
!= MEM_NIL
)
4154 y
->right
->parent
= x
;
4157 y
->parent
= x
->parent
;
4160 if (x
== x
->parent
->right
)
4161 x
->parent
->right
= y
;
4163 x
->parent
->left
= y
;
4174 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4177 mem_delete (struct mem_node
*z
)
4179 struct mem_node
*x
, *y
;
4181 if (!z
|| z
== MEM_NIL
)
4184 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4189 while (y
->left
!= MEM_NIL
)
4193 if (y
->left
!= MEM_NIL
)
4198 x
->parent
= y
->parent
;
4201 if (y
== y
->parent
->left
)
4202 y
->parent
->left
= x
;
4204 y
->parent
->right
= x
;
4211 z
->start
= y
->start
;
4216 if (y
->color
== MEM_BLACK
)
4217 mem_delete_fixup (x
);
4219 #ifdef GC_MALLOC_CHECK
4227 /* Re-establish the red-black properties of the tree, after a
4231 mem_delete_fixup (struct mem_node
*x
)
4233 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4235 if (x
== x
->parent
->left
)
4237 struct mem_node
*w
= x
->parent
->right
;
4239 if (w
->color
== MEM_RED
)
4241 w
->color
= MEM_BLACK
;
4242 x
->parent
->color
= MEM_RED
;
4243 mem_rotate_left (x
->parent
);
4244 w
= x
->parent
->right
;
4247 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4254 if (w
->right
->color
== MEM_BLACK
)
4256 w
->left
->color
= MEM_BLACK
;
4258 mem_rotate_right (w
);
4259 w
= x
->parent
->right
;
4261 w
->color
= x
->parent
->color
;
4262 x
->parent
->color
= MEM_BLACK
;
4263 w
->right
->color
= MEM_BLACK
;
4264 mem_rotate_left (x
->parent
);
4270 struct mem_node
*w
= x
->parent
->left
;
4272 if (w
->color
== MEM_RED
)
4274 w
->color
= MEM_BLACK
;
4275 x
->parent
->color
= MEM_RED
;
4276 mem_rotate_right (x
->parent
);
4277 w
= x
->parent
->left
;
4280 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4287 if (w
->left
->color
== MEM_BLACK
)
4289 w
->right
->color
= MEM_BLACK
;
4291 mem_rotate_left (w
);
4292 w
= x
->parent
->left
;
4295 w
->color
= x
->parent
->color
;
4296 x
->parent
->color
= MEM_BLACK
;
4297 w
->left
->color
= MEM_BLACK
;
4298 mem_rotate_right (x
->parent
);
4304 x
->color
= MEM_BLACK
;
4308 /* Value is non-zero if P is a pointer to a live Lisp string on
4309 the heap. M is a pointer to the mem_block for P. */
4312 live_string_p (struct mem_node
*m
, void *p
)
4314 if (m
->type
== MEM_TYPE_STRING
)
4316 struct string_block
*b
= m
->start
;
4317 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4319 /* P must point to the start of a Lisp_String structure, and it
4320 must not be on the free-list. */
4322 && offset
% sizeof b
->strings
[0] == 0
4323 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4324 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4331 /* Value is non-zero if P is a pointer to a live Lisp cons on
4332 the heap. M is a pointer to the mem_block for P. */
4335 live_cons_p (struct mem_node
*m
, void *p
)
4337 if (m
->type
== MEM_TYPE_CONS
)
4339 struct cons_block
*b
= m
->start
;
4340 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4342 /* P must point to the start of a Lisp_Cons, not be
4343 one of the unused cells in the current cons block,
4344 and not be on the free-list. */
4346 && offset
% sizeof b
->conses
[0] == 0
4347 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4349 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4350 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4357 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4358 the heap. M is a pointer to the mem_block for P. */
4361 live_symbol_p (struct mem_node
*m
, void *p
)
4363 if (m
->type
== MEM_TYPE_SYMBOL
)
4365 struct symbol_block
*b
= m
->start
;
4366 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4368 /* P must point to the start of a Lisp_Symbol, not be
4369 one of the unused cells in the current symbol block,
4370 and not be on the free-list. */
4372 && offset
% sizeof b
->symbols
[0] == 0
4373 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4374 && (b
!= symbol_block
4375 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4376 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4383 /* Value is non-zero if P is a pointer to a live Lisp float on
4384 the heap. M is a pointer to the mem_block for P. */
4387 live_float_p (struct mem_node
*m
, void *p
)
4389 if (m
->type
== MEM_TYPE_FLOAT
)
4391 struct float_block
*b
= m
->start
;
4392 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4394 /* P must point to the start of a Lisp_Float and not be
4395 one of the unused cells in the current float block. */
4397 && offset
% sizeof b
->floats
[0] == 0
4398 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4399 && (b
!= float_block
4400 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4407 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4408 the heap. M is a pointer to the mem_block for P. */
4411 live_misc_p (struct mem_node
*m
, void *p
)
4413 if (m
->type
== MEM_TYPE_MISC
)
4415 struct marker_block
*b
= m
->start
;
4416 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4418 /* P must point to the start of a Lisp_Misc, not be
4419 one of the unused cells in the current misc block,
4420 and not be on the free-list. */
4422 && offset
% sizeof b
->markers
[0] == 0
4423 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4424 && (b
!= marker_block
4425 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4426 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4433 /* Value is non-zero if P is a pointer to a live vector-like object.
4434 M is a pointer to the mem_block for P. */
4437 live_vector_p (struct mem_node
*m
, void *p
)
4439 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4441 /* This memory node corresponds to a vector block. */
4442 struct vector_block
*block
= m
->start
;
4443 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4445 /* P is in the block's allocation range. Scan the block
4446 up to P and see whether P points to the start of some
4447 vector which is not on a free list. FIXME: check whether
4448 some allocation patterns (probably a lot of short vectors)
4449 may cause a substantial overhead of this loop. */
4450 while (VECTOR_IN_BLOCK (vector
, block
)
4451 && vector
<= (struct Lisp_Vector
*) p
)
4453 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4456 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4459 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4460 /* This memory node corresponds to a large vector. */
4466 /* Value is non-zero if P is a pointer to a live buffer. M is a
4467 pointer to the mem_block for P. */
4470 live_buffer_p (struct mem_node
*m
, void *p
)
4472 /* P must point to the start of the block, and the buffer
4473 must not have been killed. */
4474 return (m
->type
== MEM_TYPE_BUFFER
4476 && !NILP (((struct buffer
*) p
)->name_
));
4479 /* Mark OBJ if we can prove it's a Lisp_Object. */
4482 mark_maybe_object (Lisp_Object obj
)
4486 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4492 void *po
= XPNTR (obj
);
4493 struct mem_node
*m
= mem_find (po
);
4497 bool mark_p
= false;
4499 switch (XTYPE (obj
))
4502 mark_p
= (live_string_p (m
, po
)
4503 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4507 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4511 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4515 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4518 case Lisp_Vectorlike
:
4519 /* Note: can't check BUFFERP before we know it's a
4520 buffer because checking that dereferences the pointer
4521 PO which might point anywhere. */
4522 if (live_vector_p (m
, po
))
4523 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4524 else if (live_buffer_p (m
, po
))
4525 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4529 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4541 /* Return true if P can point to Lisp data, and false otherwise.
4542 Symbols are implemented via offsets not pointers, but the offsets
4543 are also multiples of GCALIGNMENT. */
4546 maybe_lisp_pointer (void *p
)
4548 return (uintptr_t) p
% GCALIGNMENT
== 0;
4551 /* If P points to Lisp data, mark that as live if it isn't already
4555 mark_maybe_pointer (void *p
)
4561 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4564 if (!maybe_lisp_pointer (p
))
4570 Lisp_Object obj
= Qnil
;
4574 case MEM_TYPE_NON_LISP
:
4575 case MEM_TYPE_SPARE
:
4576 /* Nothing to do; not a pointer to Lisp memory. */
4579 case MEM_TYPE_BUFFER
:
4580 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4581 XSETVECTOR (obj
, p
);
4585 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4589 case MEM_TYPE_STRING
:
4590 if (live_string_p (m
, p
)
4591 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4592 XSETSTRING (obj
, p
);
4596 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4600 case MEM_TYPE_SYMBOL
:
4601 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4602 XSETSYMBOL (obj
, p
);
4605 case MEM_TYPE_FLOAT
:
4606 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4610 case MEM_TYPE_VECTORLIKE
:
4611 case MEM_TYPE_VECTOR_BLOCK
:
4612 if (live_vector_p (m
, p
))
4615 XSETVECTOR (tem
, p
);
4616 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4631 /* Alignment of pointer values. Use alignof, as it sometimes returns
4632 a smaller alignment than GCC's __alignof__ and mark_memory might
4633 miss objects if __alignof__ were used. */
4634 #define GC_POINTER_ALIGNMENT alignof (void *)
4636 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4637 or END+OFFSET..START. */
4639 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4640 mark_memory (void *start
, void *end
)
4645 /* Make START the pointer to the start of the memory region,
4646 if it isn't already. */
4654 /* Mark Lisp data pointed to. This is necessary because, in some
4655 situations, the C compiler optimizes Lisp objects away, so that
4656 only a pointer to them remains. Example:
4658 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4661 Lisp_Object obj = build_string ("test");
4662 struct Lisp_String *s = XSTRING (obj);
4663 Fgarbage_collect ();
4664 fprintf (stderr, "test '%s'\n", s->data);
4668 Here, `obj' isn't really used, and the compiler optimizes it
4669 away. The only reference to the life string is through the
4672 for (pp
= start
; (void *) pp
< end
; pp
++)
4673 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4675 void *p
= *(void **) ((char *) pp
+ i
);
4676 mark_maybe_pointer (p
);
4677 mark_maybe_object (XIL ((intptr_t) p
));
4681 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4683 static bool setjmp_tested_p
;
4684 static int longjmps_done
;
4686 #define SETJMP_WILL_LIKELY_WORK "\
4688 Emacs garbage collector has been changed to use conservative stack\n\
4689 marking. Emacs has determined that the method it uses to do the\n\
4690 marking will likely work on your system, but this isn't sure.\n\
4692 If you are a system-programmer, or can get the help of a local wizard\n\
4693 who is, please take a look at the function mark_stack in alloc.c, and\n\
4694 verify that the methods used are appropriate for your system.\n\
4696 Please mail the result to <emacs-devel@gnu.org>.\n\
4699 #define SETJMP_WILL_NOT_WORK "\
4701 Emacs garbage collector has been changed to use conservative stack\n\
4702 marking. Emacs has determined that the default method it uses to do the\n\
4703 marking will not work on your system. We will need a system-dependent\n\
4704 solution for your system.\n\
4706 Please take a look at the function mark_stack in alloc.c, and\n\
4707 try to find a way to make it work on your system.\n\
4709 Note that you may get false negatives, depending on the compiler.\n\
4710 In particular, you need to use -O with GCC for this test.\n\
4712 Please mail the result to <emacs-devel@gnu.org>.\n\
4716 /* Perform a quick check if it looks like setjmp saves registers in a
4717 jmp_buf. Print a message to stderr saying so. When this test
4718 succeeds, this is _not_ a proof that setjmp is sufficient for
4719 conservative stack marking. Only the sources or a disassembly
4729 /* Arrange for X to be put in a register. */
4735 if (longjmps_done
== 1)
4737 /* Came here after the longjmp at the end of the function.
4739 If x == 1, the longjmp has restored the register to its
4740 value before the setjmp, and we can hope that setjmp
4741 saves all such registers in the jmp_buf, although that
4744 For other values of X, either something really strange is
4745 taking place, or the setjmp just didn't save the register. */
4748 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4751 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4758 if (longjmps_done
== 1)
4759 sys_longjmp (jbuf
, 1);
4762 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4765 /* Mark live Lisp objects on the C stack.
4767 There are several system-dependent problems to consider when
4768 porting this to new architectures:
4772 We have to mark Lisp objects in CPU registers that can hold local
4773 variables or are used to pass parameters.
4775 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4776 something that either saves relevant registers on the stack, or
4777 calls mark_maybe_object passing it each register's contents.
4779 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4780 implementation assumes that calling setjmp saves registers we need
4781 to see in a jmp_buf which itself lies on the stack. This doesn't
4782 have to be true! It must be verified for each system, possibly
4783 by taking a look at the source code of setjmp.
4785 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4786 can use it as a machine independent method to store all registers
4787 to the stack. In this case the macros described in the previous
4788 two paragraphs are not used.
4792 Architectures differ in the way their processor stack is organized.
4793 For example, the stack might look like this
4796 | Lisp_Object | size = 4
4798 | something else | size = 2
4800 | Lisp_Object | size = 4
4804 In such a case, not every Lisp_Object will be aligned equally. To
4805 find all Lisp_Object on the stack it won't be sufficient to walk
4806 the stack in steps of 4 bytes. Instead, two passes will be
4807 necessary, one starting at the start of the stack, and a second
4808 pass starting at the start of the stack + 2. Likewise, if the
4809 minimal alignment of Lisp_Objects on the stack is 1, four passes
4810 would be necessary, each one starting with one byte more offset
4811 from the stack start. */
4814 mark_stack (void *end
)
4817 /* This assumes that the stack is a contiguous region in memory. If
4818 that's not the case, something has to be done here to iterate
4819 over the stack segments. */
4820 mark_memory (stack_base
, end
);
4822 /* Allow for marking a secondary stack, like the register stack on the
4824 #ifdef GC_MARK_SECONDARY_STACK
4825 GC_MARK_SECONDARY_STACK ();
4830 c_symbol_p (struct Lisp_Symbol
*sym
)
4832 char *lispsym_ptr
= (char *) lispsym
;
4833 char *sym_ptr
= (char *) sym
;
4834 ptrdiff_t lispsym_offset
= sym_ptr
- lispsym_ptr
;
4835 return 0 <= lispsym_offset
&& lispsym_offset
< sizeof lispsym
;
4838 /* Determine whether it is safe to access memory at address P. */
4840 valid_pointer_p (void *p
)
4843 return w32_valid_pointer_p (p
, 16);
4846 if (ADDRESS_SANITIZER
)
4851 /* Obviously, we cannot just access it (we would SEGV trying), so we
4852 trick the o/s to tell us whether p is a valid pointer.
4853 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4854 not validate p in that case. */
4856 if (emacs_pipe (fd
) == 0)
4858 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
4859 emacs_close (fd
[1]);
4860 emacs_close (fd
[0]);
4868 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
4869 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
4870 cannot validate OBJ. This function can be quite slow, so its primary
4871 use is the manual debugging. The only exception is print_object, where
4872 we use it to check whether the memory referenced by the pointer of
4873 Lisp_Save_Value object contains valid objects. */
4876 valid_lisp_object_p (Lisp_Object obj
)
4881 void *p
= XPNTR (obj
);
4885 if (SYMBOLP (obj
) && c_symbol_p (p
))
4886 return ((char *) p
- (char *) lispsym
) % sizeof lispsym
[0] == 0;
4888 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
4891 struct mem_node
*m
= mem_find (p
);
4895 int valid
= valid_pointer_p (p
);
4907 case MEM_TYPE_NON_LISP
:
4908 case MEM_TYPE_SPARE
:
4911 case MEM_TYPE_BUFFER
:
4912 return live_buffer_p (m
, p
) ? 1 : 2;
4915 return live_cons_p (m
, p
);
4917 case MEM_TYPE_STRING
:
4918 return live_string_p (m
, p
);
4921 return live_misc_p (m
, p
);
4923 case MEM_TYPE_SYMBOL
:
4924 return live_symbol_p (m
, p
);
4926 case MEM_TYPE_FLOAT
:
4927 return live_float_p (m
, p
);
4929 case MEM_TYPE_VECTORLIKE
:
4930 case MEM_TYPE_VECTOR_BLOCK
:
4931 return live_vector_p (m
, p
);
4940 /***********************************************************************
4941 Pure Storage Management
4942 ***********************************************************************/
4944 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4945 pointer to it. TYPE is the Lisp type for which the memory is
4946 allocated. TYPE < 0 means it's not used for a Lisp object. */
4949 pure_alloc (size_t size
, int type
)
4956 /* Allocate space for a Lisp object from the beginning of the free
4957 space with taking account of alignment. */
4958 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, GCALIGNMENT
);
4959 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4963 /* Allocate space for a non-Lisp object from the end of the free
4965 pure_bytes_used_non_lisp
+= size
;
4966 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4968 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4970 if (pure_bytes_used
<= pure_size
)
4973 /* Don't allocate a large amount here,
4974 because it might get mmap'd and then its address
4975 might not be usable. */
4976 purebeg
= xmalloc (10000);
4978 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4979 pure_bytes_used
= 0;
4980 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4985 /* Print a warning if PURESIZE is too small. */
4988 check_pure_size (void)
4990 if (pure_bytes_used_before_overflow
)
4991 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4993 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4997 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4998 the non-Lisp data pool of the pure storage, and return its start
4999 address. Return NULL if not found. */
5002 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5005 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5006 const unsigned char *p
;
5009 if (pure_bytes_used_non_lisp
<= nbytes
)
5012 /* Set up the Boyer-Moore table. */
5014 for (i
= 0; i
< 256; i
++)
5017 p
= (const unsigned char *) data
;
5019 bm_skip
[*p
++] = skip
;
5021 last_char_skip
= bm_skip
['\0'];
5023 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5024 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5026 /* See the comments in the function `boyer_moore' (search.c) for the
5027 use of `infinity'. */
5028 infinity
= pure_bytes_used_non_lisp
+ 1;
5029 bm_skip
['\0'] = infinity
;
5031 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5035 /* Check the last character (== '\0'). */
5038 start
+= bm_skip
[*(p
+ start
)];
5040 while (start
<= start_max
);
5042 if (start
< infinity
)
5043 /* Couldn't find the last character. */
5046 /* No less than `infinity' means we could find the last
5047 character at `p[start - infinity]'. */
5050 /* Check the remaining characters. */
5051 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5053 return non_lisp_beg
+ start
;
5055 start
+= last_char_skip
;
5057 while (start
<= start_max
);
5063 /* Return a string allocated in pure space. DATA is a buffer holding
5064 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5065 means make the result string multibyte.
5067 Must get an error if pure storage is full, since if it cannot hold
5068 a large string it may be able to hold conses that point to that
5069 string; then the string is not protected from gc. */
5072 make_pure_string (const char *data
,
5073 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5076 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5077 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5078 if (s
->data
== NULL
)
5080 s
->data
= pure_alloc (nbytes
+ 1, -1);
5081 memcpy (s
->data
, data
, nbytes
);
5082 s
->data
[nbytes
] = '\0';
5085 s
->size_byte
= multibyte
? nbytes
: -1;
5086 s
->intervals
= NULL
;
5087 XSETSTRING (string
, s
);
5091 /* Return a string allocated in pure space. Do not
5092 allocate the string data, just point to DATA. */
5095 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5098 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5101 s
->data
= (unsigned char *) data
;
5102 s
->intervals
= NULL
;
5103 XSETSTRING (string
, s
);
5107 static Lisp_Object
purecopy (Lisp_Object obj
);
5109 /* Return a cons allocated from pure space. Give it pure copies
5110 of CAR as car and CDR as cdr. */
5113 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5116 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5118 XSETCAR (new, purecopy (car
));
5119 XSETCDR (new, purecopy (cdr
));
5124 /* Value is a float object with value NUM allocated from pure space. */
5127 make_pure_float (double num
)
5130 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5132 XFLOAT_INIT (new, num
);
5137 /* Return a vector with room for LEN Lisp_Objects allocated from
5141 make_pure_vector (ptrdiff_t len
)
5144 size_t size
= header_size
+ len
* word_size
;
5145 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5146 XSETVECTOR (new, p
);
5147 XVECTOR (new)->header
.size
= len
;
5151 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5152 doc
: /* Make a copy of object OBJ in pure storage.
5153 Recursively copies contents of vectors and cons cells.
5154 Does not copy symbols. Copies strings without text properties. */)
5155 (register Lisp_Object obj
)
5157 if (NILP (Vpurify_flag
))
5159 else if (MARKERP (obj
) || OVERLAYP (obj
)
5160 || HASH_TABLE_P (obj
) || SYMBOLP (obj
))
5161 /* Can't purify those. */
5164 return purecopy (obj
);
5168 purecopy (Lisp_Object obj
)
5171 || (! SYMBOLP (obj
) && PURE_P (XPNTR_OR_SYMBOL_OFFSET (obj
)))
5173 return obj
; /* Already pure. */
5175 if (STRINGP (obj
) && XSTRING (obj
)->intervals
)
5176 message_with_string ("Dropping text-properties while making string `%s' pure",
5179 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5181 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5187 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5188 else if (FLOATP (obj
))
5189 obj
= make_pure_float (XFLOAT_DATA (obj
));
5190 else if (STRINGP (obj
))
5191 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5193 STRING_MULTIBYTE (obj
));
5194 else if (COMPILEDP (obj
) || VECTORP (obj
) || HASH_TABLE_P (obj
))
5196 struct Lisp_Vector
*objp
= XVECTOR (obj
);
5197 ptrdiff_t nbytes
= vector_nbytes (objp
);
5198 struct Lisp_Vector
*vec
= pure_alloc (nbytes
, Lisp_Vectorlike
);
5199 register ptrdiff_t i
;
5200 ptrdiff_t size
= ASIZE (obj
);
5201 if (size
& PSEUDOVECTOR_FLAG
)
5202 size
&= PSEUDOVECTOR_SIZE_MASK
;
5203 memcpy (vec
, objp
, nbytes
);
5204 for (i
= 0; i
< size
; i
++)
5205 vec
->contents
[i
] = purecopy (vec
->contents
[i
]);
5206 XSETVECTOR (obj
, vec
);
5208 else if (SYMBOLP (obj
))
5210 if (!XSYMBOL (obj
)->pinned
&& !c_symbol_p (XSYMBOL (obj
)))
5211 { /* We can't purify them, but they appear in many pure objects.
5212 Mark them as `pinned' so we know to mark them at every GC cycle. */
5213 XSYMBOL (obj
)->pinned
= true;
5214 symbol_block_pinned
= symbol_block
;
5216 /* Don't hash-cons it. */
5221 Lisp_Object fmt
= build_pure_c_string ("Don't know how to purify: %S");
5222 Fsignal (Qerror
, list1 (CALLN (Fformat
, fmt
, obj
)));
5225 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5226 Fputhash (obj
, obj
, Vpurify_flag
);
5233 /***********************************************************************
5235 ***********************************************************************/
5237 /* Put an entry in staticvec, pointing at the variable with address
5241 staticpro (Lisp_Object
*varaddress
)
5243 if (staticidx
>= NSTATICS
)
5244 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5245 staticvec
[staticidx
++] = varaddress
;
5249 /***********************************************************************
5251 ***********************************************************************/
5253 /* Temporarily prevent garbage collection. */
5256 inhibit_garbage_collection (void)
5258 ptrdiff_t count
= SPECPDL_INDEX ();
5260 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5264 /* Used to avoid possible overflows when
5265 converting from C to Lisp integers. */
5268 bounded_number (EMACS_INT number
)
5270 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5273 /* Calculate total bytes of live objects. */
5276 total_bytes_of_live_objects (void)
5279 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5280 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5281 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5282 tot
+= total_string_bytes
;
5283 tot
+= total_vector_slots
* word_size
;
5284 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5285 tot
+= total_intervals
* sizeof (struct interval
);
5286 tot
+= total_strings
* sizeof (struct Lisp_String
);
5290 #ifdef HAVE_WINDOW_SYSTEM
5292 /* This code has a few issues on MS-Windows, see Bug#15876 and Bug#16140. */
5294 #if !defined (HAVE_NTGUI)
5296 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5297 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5300 compact_font_cache_entry (Lisp_Object entry
)
5302 Lisp_Object tail
, *prev
= &entry
;
5304 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5307 Lisp_Object obj
= XCAR (tail
);
5309 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5310 if (CONSP (obj
) && FONT_SPEC_P (XCAR (obj
))
5311 && !VECTOR_MARKED_P (XFONT_SPEC (XCAR (obj
)))
5312 && VECTORP (XCDR (obj
)))
5314 ptrdiff_t i
, size
= ASIZE (XCDR (obj
)) & ~ARRAY_MARK_FLAG
;
5316 /* If font-spec is not marked, most likely all font-entities
5317 are not marked too. But we must be sure that nothing is
5318 marked within OBJ before we really drop it. */
5319 for (i
= 0; i
< size
; i
++)
5320 if (VECTOR_MARKED_P (XFONT_ENTITY (AREF (XCDR (obj
), i
))))
5327 *prev
= XCDR (tail
);
5329 prev
= xcdr_addr (tail
);
5334 #endif /* not HAVE_NTGUI */
5336 /* Compact font caches on all terminals and mark
5337 everything which is still here after compaction. */
5340 compact_font_caches (void)
5344 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5346 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5347 #if !defined (HAVE_NTGUI)
5352 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5353 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5355 #endif /* not HAVE_NTGUI */
5356 mark_object (cache
);
5360 #else /* not HAVE_WINDOW_SYSTEM */
5362 #define compact_font_caches() (void)(0)
5364 #endif /* HAVE_WINDOW_SYSTEM */
5366 /* Remove (MARKER . DATA) entries with unmarked MARKER
5367 from buffer undo LIST and return changed list. */
5370 compact_undo_list (Lisp_Object list
)
5372 Lisp_Object tail
, *prev
= &list
;
5374 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5376 if (CONSP (XCAR (tail
))
5377 && MARKERP (XCAR (XCAR (tail
)))
5378 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5379 *prev
= XCDR (tail
);
5381 prev
= xcdr_addr (tail
);
5387 mark_pinned_symbols (void)
5389 struct symbol_block
*sblk
;
5390 int lim
= (symbol_block_pinned
== symbol_block
5391 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5393 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5395 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5396 for (; sym
< end
; ++sym
)
5398 mark_object (make_lisp_symbol (&sym
->s
));
5400 lim
= SYMBOL_BLOCK_SIZE
;
5404 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5405 separate function so that we could limit mark_stack in searching
5406 the stack frames below this function, thus avoiding the rare cases
5407 where mark_stack finds values that look like live Lisp objects on
5408 portions of stack that couldn't possibly contain such live objects.
5409 For more details of this, see the discussion at
5410 http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00270.html. */
5412 garbage_collect_1 (void *end
)
5414 struct buffer
*nextb
;
5415 char stack_top_variable
;
5418 ptrdiff_t count
= SPECPDL_INDEX ();
5419 struct timespec start
;
5420 Lisp_Object retval
= Qnil
;
5421 size_t tot_before
= 0;
5426 /* Can't GC if pure storage overflowed because we can't determine
5427 if something is a pure object or not. */
5428 if (pure_bytes_used_before_overflow
)
5431 /* Record this function, so it appears on the profiler's backtraces. */
5432 record_in_backtrace (Qautomatic_gc
, 0, 0);
5436 /* Don't keep undo information around forever.
5437 Do this early on, so it is no problem if the user quits. */
5438 FOR_EACH_BUFFER (nextb
)
5439 compact_buffer (nextb
);
5441 if (profiler_memory_running
)
5442 tot_before
= total_bytes_of_live_objects ();
5444 start
= current_timespec ();
5446 /* In case user calls debug_print during GC,
5447 don't let that cause a recursive GC. */
5448 consing_since_gc
= 0;
5450 /* Save what's currently displayed in the echo area. */
5451 message_p
= push_message ();
5452 record_unwind_protect_void (pop_message_unwind
);
5454 /* Save a copy of the contents of the stack, for debugging. */
5455 #if MAX_SAVE_STACK > 0
5456 if (NILP (Vpurify_flag
))
5459 ptrdiff_t stack_size
;
5460 if (&stack_top_variable
< stack_bottom
)
5462 stack
= &stack_top_variable
;
5463 stack_size
= stack_bottom
- &stack_top_variable
;
5467 stack
= stack_bottom
;
5468 stack_size
= &stack_top_variable
- stack_bottom
;
5470 if (stack_size
<= MAX_SAVE_STACK
)
5472 if (stack_copy_size
< stack_size
)
5474 stack_copy
= xrealloc (stack_copy
, stack_size
);
5475 stack_copy_size
= stack_size
;
5477 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5480 #endif /* MAX_SAVE_STACK > 0 */
5482 if (garbage_collection_messages
)
5483 message1_nolog ("Garbage collecting...");
5487 shrink_regexp_cache ();
5491 /* Mark all the special slots that serve as the roots of accessibility. */
5493 mark_buffer (&buffer_defaults
);
5494 mark_buffer (&buffer_local_symbols
);
5496 for (i
= 0; i
< ARRAYELTS (lispsym
); i
++)
5497 mark_object (builtin_lisp_symbol (i
));
5499 for (i
= 0; i
< staticidx
; i
++)
5500 mark_object (*staticvec
[i
]);
5502 mark_pinned_symbols ();
5514 struct handler
*handler
;
5515 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5517 mark_object (handler
->tag_or_ch
);
5518 mark_object (handler
->val
);
5521 #ifdef HAVE_WINDOW_SYSTEM
5522 mark_fringe_data ();
5525 /* Everything is now marked, except for the data in font caches,
5526 undo lists, and finalizers. The first two are compacted by
5527 removing an items which aren't reachable otherwise. */
5529 compact_font_caches ();
5531 FOR_EACH_BUFFER (nextb
)
5533 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5534 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5535 /* Now that we have stripped the elements that need not be
5536 in the undo_list any more, we can finally mark the list. */
5537 mark_object (BVAR (nextb
, undo_list
));
5540 /* Now pre-sweep finalizers. Here, we add any unmarked finalizers
5541 to doomed_finalizers so we can run their associated functions
5542 after GC. It's important to scan finalizers at this stage so
5543 that we can be sure that unmarked finalizers are really
5544 unreachable except for references from their associated functions
5545 and from other finalizers. */
5547 queue_doomed_finalizers (&doomed_finalizers
, &finalizers
);
5548 mark_finalizer_list (&doomed_finalizers
);
5552 relocate_byte_stack ();
5554 /* Clear the mark bits that we set in certain root slots. */
5555 VECTOR_UNMARK (&buffer_defaults
);
5556 VECTOR_UNMARK (&buffer_local_symbols
);
5564 consing_since_gc
= 0;
5565 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5566 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5568 gc_relative_threshold
= 0;
5569 if (FLOATP (Vgc_cons_percentage
))
5570 { /* Set gc_cons_combined_threshold. */
5571 double tot
= total_bytes_of_live_objects ();
5573 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5576 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5577 gc_relative_threshold
= tot
;
5579 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5583 if (garbage_collection_messages
)
5585 if (message_p
|| minibuf_level
> 0)
5588 message1_nolog ("Garbage collecting...done");
5591 unbind_to (count
, Qnil
);
5593 Lisp_Object total
[] = {
5594 list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5595 bounded_number (total_conses
),
5596 bounded_number (total_free_conses
)),
5597 list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5598 bounded_number (total_symbols
),
5599 bounded_number (total_free_symbols
)),
5600 list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5601 bounded_number (total_markers
),
5602 bounded_number (total_free_markers
)),
5603 list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5604 bounded_number (total_strings
),
5605 bounded_number (total_free_strings
)),
5606 list3 (Qstring_bytes
, make_number (1),
5607 bounded_number (total_string_bytes
)),
5609 make_number (header_size
+ sizeof (Lisp_Object
)),
5610 bounded_number (total_vectors
)),
5611 list4 (Qvector_slots
, make_number (word_size
),
5612 bounded_number (total_vector_slots
),
5613 bounded_number (total_free_vector_slots
)),
5614 list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5615 bounded_number (total_floats
),
5616 bounded_number (total_free_floats
)),
5617 list4 (Qintervals
, make_number (sizeof (struct interval
)),
5618 bounded_number (total_intervals
),
5619 bounded_number (total_free_intervals
)),
5620 list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5621 bounded_number (total_buffers
)),
5623 #ifdef DOUG_LEA_MALLOC
5624 list4 (Qheap
, make_number (1024),
5625 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5626 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)),
5629 retval
= CALLMANY (Flist
, total
);
5631 /* GC is complete: now we can run our finalizer callbacks. */
5632 run_finalizers (&doomed_finalizers
);
5634 if (!NILP (Vpost_gc_hook
))
5636 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5637 safe_run_hooks (Qpost_gc_hook
);
5638 unbind_to (gc_count
, Qnil
);
5641 /* Accumulate statistics. */
5642 if (FLOATP (Vgc_elapsed
))
5644 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5645 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5646 + timespectod (since_start
));
5651 /* Collect profiling data. */
5652 if (profiler_memory_running
)
5655 size_t tot_after
= total_bytes_of_live_objects ();
5656 if (tot_before
> tot_after
)
5657 swept
= tot_before
- tot_after
;
5658 malloc_probe (swept
);
5664 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5665 doc
: /* Reclaim storage for Lisp objects no longer needed.
5666 Garbage collection happens automatically if you cons more than
5667 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5668 `garbage-collect' normally returns a list with info on amount of space in use,
5669 where each entry has the form (NAME SIZE USED FREE), where:
5670 - NAME is a symbol describing the kind of objects this entry represents,
5671 - SIZE is the number of bytes used by each one,
5672 - USED is the number of those objects that were found live in the heap,
5673 - FREE is the number of those objects that are not live but that Emacs
5674 keeps around for future allocations (maybe because it does not know how
5675 to return them to the OS).
5676 However, if there was overflow in pure space, `garbage-collect'
5677 returns nil, because real GC can't be done.
5678 See Info node `(elisp)Garbage Collection'. */)
5683 #ifdef HAVE___BUILTIN_UNWIND_INIT
5684 /* Force callee-saved registers and register windows onto the stack.
5685 This is the preferred method if available, obviating the need for
5686 machine dependent methods. */
5687 __builtin_unwind_init ();
5689 #else /* not HAVE___BUILTIN_UNWIND_INIT */
5690 #ifndef GC_SAVE_REGISTERS_ON_STACK
5691 /* jmp_buf may not be aligned enough on darwin-ppc64 */
5692 union aligned_jmpbuf
{
5696 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
5698 /* This trick flushes the register windows so that all the state of
5699 the process is contained in the stack. */
5700 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
5701 needed on ia64 too. See mach_dep.c, where it also says inline
5702 assembler doesn't work with relevant proprietary compilers. */
5704 #if defined (__sparc64__) && defined (__FreeBSD__)
5705 /* FreeBSD does not have a ta 3 handler. */
5712 /* Save registers that we need to see on the stack. We need to see
5713 registers used to hold register variables and registers used to
5715 #ifdef GC_SAVE_REGISTERS_ON_STACK
5716 GC_SAVE_REGISTERS_ON_STACK (end
);
5717 #else /* not GC_SAVE_REGISTERS_ON_STACK */
5719 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
5720 setjmp will definitely work, test it
5721 and print a message with the result
5723 if (!setjmp_tested_p
)
5725 setjmp_tested_p
= 1;
5728 #endif /* GC_SETJMP_WORKS */
5731 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
5732 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
5733 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
5734 return garbage_collect_1 (end
);
5737 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5738 only interesting objects referenced from glyphs are strings. */
5741 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5743 struct glyph_row
*row
= matrix
->rows
;
5744 struct glyph_row
*end
= row
+ matrix
->nrows
;
5746 for (; row
< end
; ++row
)
5750 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5752 struct glyph
*glyph
= row
->glyphs
[area
];
5753 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5755 for (; glyph
< end_glyph
; ++glyph
)
5756 if (STRINGP (glyph
->object
)
5757 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5758 mark_object (glyph
->object
);
5763 /* Mark reference to a Lisp_Object.
5764 If the object referred to has not been seen yet, recursively mark
5765 all the references contained in it. */
5767 #define LAST_MARKED_SIZE 500
5768 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5769 static int last_marked_index
;
5771 /* For debugging--call abort when we cdr down this many
5772 links of a list, in mark_object. In debugging,
5773 the call to abort will hit a breakpoint.
5774 Normally this is zero and the check never goes off. */
5775 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5778 mark_vectorlike (struct Lisp_Vector
*ptr
)
5780 ptrdiff_t size
= ptr
->header
.size
;
5783 eassert (!VECTOR_MARKED_P (ptr
));
5784 VECTOR_MARK (ptr
); /* Else mark it. */
5785 if (size
& PSEUDOVECTOR_FLAG
)
5786 size
&= PSEUDOVECTOR_SIZE_MASK
;
5788 /* Note that this size is not the memory-footprint size, but only
5789 the number of Lisp_Object fields that we should trace.
5790 The distinction is used e.g. by Lisp_Process which places extra
5791 non-Lisp_Object fields at the end of the structure... */
5792 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5793 mark_object (ptr
->contents
[i
]);
5796 /* Like mark_vectorlike but optimized for char-tables (and
5797 sub-char-tables) assuming that the contents are mostly integers or
5801 mark_char_table (struct Lisp_Vector
*ptr
, enum pvec_type pvectype
)
5803 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5804 /* Consult the Lisp_Sub_Char_Table layout before changing this. */
5805 int i
, idx
= (pvectype
== PVEC_SUB_CHAR_TABLE
? SUB_CHAR_TABLE_OFFSET
: 0);
5807 eassert (!VECTOR_MARKED_P (ptr
));
5809 for (i
= idx
; i
< size
; i
++)
5811 Lisp_Object val
= ptr
->contents
[i
];
5813 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5815 if (SUB_CHAR_TABLE_P (val
))
5817 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5818 mark_char_table (XVECTOR (val
), PVEC_SUB_CHAR_TABLE
);
5825 NO_INLINE
/* To reduce stack depth in mark_object. */
5827 mark_compiled (struct Lisp_Vector
*ptr
)
5829 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5832 for (i
= 0; i
< size
; i
++)
5833 if (i
!= COMPILED_CONSTANTS
)
5834 mark_object (ptr
->contents
[i
]);
5835 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
5838 /* Mark the chain of overlays starting at PTR. */
5841 mark_overlay (struct Lisp_Overlay
*ptr
)
5843 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5846 /* These two are always markers and can be marked fast. */
5847 XMARKER (ptr
->start
)->gcmarkbit
= 1;
5848 XMARKER (ptr
->end
)->gcmarkbit
= 1;
5849 mark_object (ptr
->plist
);
5853 /* Mark Lisp_Objects and special pointers in BUFFER. */
5856 mark_buffer (struct buffer
*buffer
)
5858 /* This is handled much like other pseudovectors... */
5859 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5861 /* ...but there are some buffer-specific things. */
5863 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
5865 /* For now, we just don't mark the undo_list. It's done later in
5866 a special way just before the sweep phase, and after stripping
5867 some of its elements that are not needed any more. */
5869 mark_overlay (buffer
->overlays_before
);
5870 mark_overlay (buffer
->overlays_after
);
5872 /* If this is an indirect buffer, mark its base buffer. */
5873 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5874 mark_buffer (buffer
->base_buffer
);
5877 /* Mark Lisp faces in the face cache C. */
5879 NO_INLINE
/* To reduce stack depth in mark_object. */
5881 mark_face_cache (struct face_cache
*c
)
5886 for (i
= 0; i
< c
->used
; ++i
)
5888 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5892 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
5893 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
5895 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5896 mark_object (face
->lface
[j
]);
5902 NO_INLINE
/* To reduce stack depth in mark_object. */
5904 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
5906 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5907 Lisp_Object where
= blv
->where
;
5908 /* If the value is set up for a killed buffer or deleted
5909 frame, restore its global binding. If the value is
5910 forwarded to a C variable, either it's not a Lisp_Object
5911 var, or it's staticpro'd already. */
5912 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
5913 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
5914 swap_in_global_binding (ptr
);
5915 mark_object (blv
->where
);
5916 mark_object (blv
->valcell
);
5917 mark_object (blv
->defcell
);
5920 NO_INLINE
/* To reduce stack depth in mark_object. */
5922 mark_save_value (struct Lisp_Save_Value
*ptr
)
5924 /* If `save_type' is zero, `data[0].pointer' is the address
5925 of a memory area containing `data[1].integer' potential
5927 if (ptr
->save_type
== SAVE_TYPE_MEMORY
)
5929 Lisp_Object
*p
= ptr
->data
[0].pointer
;
5931 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
5932 mark_maybe_object (*p
);
5936 /* Find Lisp_Objects in `data[N]' slots and mark them. */
5938 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
5939 if (save_type (ptr
, i
) == SAVE_OBJECT
)
5940 mark_object (ptr
->data
[i
].object
);
5944 /* Remove killed buffers or items whose car is a killed buffer from
5945 LIST, and mark other items. Return changed LIST, which is marked. */
5948 mark_discard_killed_buffers (Lisp_Object list
)
5950 Lisp_Object tail
, *prev
= &list
;
5952 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
5955 Lisp_Object tem
= XCAR (tail
);
5958 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
5959 *prev
= XCDR (tail
);
5962 CONS_MARK (XCONS (tail
));
5963 mark_object (XCAR (tail
));
5964 prev
= xcdr_addr (tail
);
5971 /* Determine type of generic Lisp_Object and mark it accordingly.
5973 This function implements a straightforward depth-first marking
5974 algorithm and so the recursion depth may be very high (a few
5975 tens of thousands is not uncommon). To minimize stack usage,
5976 a few cold paths are moved out to NO_INLINE functions above.
5977 In general, inlining them doesn't help you to gain more speed. */
5980 mark_object (Lisp_Object arg
)
5982 register Lisp_Object obj
;
5984 #ifdef GC_CHECK_MARKED_OBJECTS
5987 ptrdiff_t cdr_count
= 0;
5996 last_marked
[last_marked_index
++] = obj
;
5997 if (last_marked_index
== LAST_MARKED_SIZE
)
5998 last_marked_index
= 0;
6000 /* Perform some sanity checks on the objects marked here. Abort if
6001 we encounter an object we know is bogus. This increases GC time
6003 #ifdef GC_CHECK_MARKED_OBJECTS
6005 /* Check that the object pointed to by PO is known to be a Lisp
6006 structure allocated from the heap. */
6007 #define CHECK_ALLOCATED() \
6009 m = mem_find (po); \
6014 /* Check that the object pointed to by PO is live, using predicate
6016 #define CHECK_LIVE(LIVEP) \
6018 if (!LIVEP (m, po)) \
6022 /* Check both of the above conditions, for non-symbols. */
6023 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6025 CHECK_ALLOCATED (); \
6026 CHECK_LIVE (LIVEP); \
6029 /* Check both of the above conditions, for symbols. */
6030 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() \
6032 if (!c_symbol_p (ptr)) \
6034 CHECK_ALLOCATED (); \
6035 CHECK_LIVE (live_symbol_p); \
6039 #else /* not GC_CHECK_MARKED_OBJECTS */
6041 #define CHECK_LIVE(LIVEP) ((void) 0)
6042 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) ((void) 0)
6043 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() ((void) 0)
6045 #endif /* not GC_CHECK_MARKED_OBJECTS */
6047 switch (XTYPE (obj
))
6051 register struct Lisp_String
*ptr
= XSTRING (obj
);
6052 if (STRING_MARKED_P (ptr
))
6054 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6056 MARK_INTERVAL_TREE (ptr
->intervals
);
6057 #ifdef GC_CHECK_STRING_BYTES
6058 /* Check that the string size recorded in the string is the
6059 same as the one recorded in the sdata structure. */
6061 #endif /* GC_CHECK_STRING_BYTES */
6065 case Lisp_Vectorlike
:
6067 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6068 register ptrdiff_t pvectype
;
6070 if (VECTOR_MARKED_P (ptr
))
6073 #ifdef GC_CHECK_MARKED_OBJECTS
6075 if (m
== MEM_NIL
&& !SUBRP (obj
))
6077 #endif /* GC_CHECK_MARKED_OBJECTS */
6079 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6080 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6081 >> PSEUDOVECTOR_AREA_BITS
);
6083 pvectype
= PVEC_NORMAL_VECTOR
;
6085 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6086 CHECK_LIVE (live_vector_p
);
6091 #ifdef GC_CHECK_MARKED_OBJECTS
6100 #endif /* GC_CHECK_MARKED_OBJECTS */
6101 mark_buffer ((struct buffer
*) ptr
);
6105 /* Although we could treat this just like a vector, mark_compiled
6106 returns the COMPILED_CONSTANTS element, which is marked at the
6107 next iteration of goto-loop here. This is done to avoid a few
6108 recursive calls to mark_object. */
6109 obj
= mark_compiled (ptr
);
6116 struct frame
*f
= (struct frame
*) ptr
;
6118 mark_vectorlike (ptr
);
6119 mark_face_cache (f
->face_cache
);
6120 #ifdef HAVE_WINDOW_SYSTEM
6121 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6123 struct font
*font
= FRAME_FONT (f
);
6125 if (font
&& !VECTOR_MARKED_P (font
))
6126 mark_vectorlike ((struct Lisp_Vector
*) font
);
6134 struct window
*w
= (struct window
*) ptr
;
6136 mark_vectorlike (ptr
);
6138 /* Mark glyph matrices, if any. Marking window
6139 matrices is sufficient because frame matrices
6140 use the same glyph memory. */
6141 if (w
->current_matrix
)
6143 mark_glyph_matrix (w
->current_matrix
);
6144 mark_glyph_matrix (w
->desired_matrix
);
6147 /* Filter out killed buffers from both buffer lists
6148 in attempt to help GC to reclaim killed buffers faster.
6149 We can do it elsewhere for live windows, but this is the
6150 best place to do it for dead windows. */
6152 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6154 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6158 case PVEC_HASH_TABLE
:
6160 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6162 mark_vectorlike (ptr
);
6163 mark_object (h
->test
.name
);
6164 mark_object (h
->test
.user_hash_function
);
6165 mark_object (h
->test
.user_cmp_function
);
6166 /* If hash table is not weak, mark all keys and values.
6167 For weak tables, mark only the vector. */
6169 mark_object (h
->key_and_value
);
6171 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6175 case PVEC_CHAR_TABLE
:
6176 case PVEC_SUB_CHAR_TABLE
:
6177 mark_char_table (ptr
, (enum pvec_type
) pvectype
);
6180 case PVEC_BOOL_VECTOR
:
6181 /* No Lisp_Objects to mark in a bool vector. */
6192 mark_vectorlike (ptr
);
6199 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6203 CHECK_ALLOCATED_AND_LIVE_SYMBOL ();
6205 /* Attempt to catch bogus objects. */
6206 eassert (valid_lisp_object_p (ptr
->function
));
6207 mark_object (ptr
->function
);
6208 mark_object (ptr
->plist
);
6209 switch (ptr
->redirect
)
6211 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6212 case SYMBOL_VARALIAS
:
6215 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6219 case SYMBOL_LOCALIZED
:
6220 mark_localized_symbol (ptr
);
6222 case SYMBOL_FORWARDED
:
6223 /* If the value is forwarded to a buffer or keyboard field,
6224 these are marked when we see the corresponding object.
6225 And if it's forwarded to a C variable, either it's not
6226 a Lisp_Object var, or it's staticpro'd already. */
6228 default: emacs_abort ();
6230 if (!PURE_P (XSTRING (ptr
->name
)))
6231 MARK_STRING (XSTRING (ptr
->name
));
6232 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6233 /* Inner loop to mark next symbol in this bucket, if any. */
6234 po
= ptr
= ptr
->next
;
6241 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6243 if (XMISCANY (obj
)->gcmarkbit
)
6246 switch (XMISCTYPE (obj
))
6248 case Lisp_Misc_Marker
:
6249 /* DO NOT mark thru the marker's chain.
6250 The buffer's markers chain does not preserve markers from gc;
6251 instead, markers are removed from the chain when freed by gc. */
6252 XMISCANY (obj
)->gcmarkbit
= 1;
6255 case Lisp_Misc_Save_Value
:
6256 XMISCANY (obj
)->gcmarkbit
= 1;
6257 mark_save_value (XSAVE_VALUE (obj
));
6260 case Lisp_Misc_Overlay
:
6261 mark_overlay (XOVERLAY (obj
));
6264 case Lisp_Misc_Finalizer
:
6265 XMISCANY (obj
)->gcmarkbit
= true;
6266 mark_object (XFINALIZER (obj
)->function
);
6276 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6277 if (CONS_MARKED_P (ptr
))
6279 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6281 /* If the cdr is nil, avoid recursion for the car. */
6282 if (EQ (ptr
->u
.cdr
, Qnil
))
6288 mark_object (ptr
->car
);
6291 if (cdr_count
== mark_object_loop_halt
)
6297 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6298 FLOAT_MARK (XFLOAT (obj
));
6309 #undef CHECK_ALLOCATED
6310 #undef CHECK_ALLOCATED_AND_LIVE
6312 /* Mark the Lisp pointers in the terminal objects.
6313 Called by Fgarbage_collect. */
6316 mark_terminals (void)
6319 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6321 eassert (t
->name
!= NULL
);
6322 #ifdef HAVE_WINDOW_SYSTEM
6323 /* If a terminal object is reachable from a stacpro'ed object,
6324 it might have been marked already. Make sure the image cache
6326 mark_image_cache (t
->image_cache
);
6327 #endif /* HAVE_WINDOW_SYSTEM */
6328 if (!VECTOR_MARKED_P (t
))
6329 mark_vectorlike ((struct Lisp_Vector
*)t
);
6335 /* Value is non-zero if OBJ will survive the current GC because it's
6336 either marked or does not need to be marked to survive. */
6339 survives_gc_p (Lisp_Object obj
)
6343 switch (XTYPE (obj
))
6350 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6354 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6358 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6361 case Lisp_Vectorlike
:
6362 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6366 survives_p
= CONS_MARKED_P (XCONS (obj
));
6370 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6377 return survives_p
|| PURE_P (XPNTR (obj
));
6383 NO_INLINE
/* For better stack traces */
6387 struct cons_block
*cblk
;
6388 struct cons_block
**cprev
= &cons_block
;
6389 int lim
= cons_block_index
;
6390 EMACS_INT num_free
= 0, num_used
= 0;
6394 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6398 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6400 /* Scan the mark bits an int at a time. */
6401 for (i
= 0; i
< ilim
; i
++)
6403 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6405 /* Fast path - all cons cells for this int are marked. */
6406 cblk
->gcmarkbits
[i
] = 0;
6407 num_used
+= BITS_PER_BITS_WORD
;
6411 /* Some cons cells for this int are not marked.
6412 Find which ones, and free them. */
6413 int start
, pos
, stop
;
6415 start
= i
* BITS_PER_BITS_WORD
;
6417 if (stop
> BITS_PER_BITS_WORD
)
6418 stop
= BITS_PER_BITS_WORD
;
6421 for (pos
= start
; pos
< stop
; pos
++)
6423 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6426 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6427 cons_free_list
= &cblk
->conses
[pos
];
6428 cons_free_list
->car
= Vdead
;
6433 CONS_UNMARK (&cblk
->conses
[pos
]);
6439 lim
= CONS_BLOCK_SIZE
;
6440 /* If this block contains only free conses and we have already
6441 seen more than two blocks worth of free conses then deallocate
6443 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6445 *cprev
= cblk
->next
;
6446 /* Unhook from the free list. */
6447 cons_free_list
= cblk
->conses
[0].u
.chain
;
6448 lisp_align_free (cblk
);
6452 num_free
+= this_free
;
6453 cprev
= &cblk
->next
;
6456 total_conses
= num_used
;
6457 total_free_conses
= num_free
;
6460 NO_INLINE
/* For better stack traces */
6464 register struct float_block
*fblk
;
6465 struct float_block
**fprev
= &float_block
;
6466 register int lim
= float_block_index
;
6467 EMACS_INT num_free
= 0, num_used
= 0;
6469 float_free_list
= 0;
6471 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6475 for (i
= 0; i
< lim
; i
++)
6476 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6479 fblk
->floats
[i
].u
.chain
= float_free_list
;
6480 float_free_list
= &fblk
->floats
[i
];
6485 FLOAT_UNMARK (&fblk
->floats
[i
]);
6487 lim
= FLOAT_BLOCK_SIZE
;
6488 /* If this block contains only free floats and we have already
6489 seen more than two blocks worth of free floats then deallocate
6491 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6493 *fprev
= fblk
->next
;
6494 /* Unhook from the free list. */
6495 float_free_list
= fblk
->floats
[0].u
.chain
;
6496 lisp_align_free (fblk
);
6500 num_free
+= this_free
;
6501 fprev
= &fblk
->next
;
6504 total_floats
= num_used
;
6505 total_free_floats
= num_free
;
6508 NO_INLINE
/* For better stack traces */
6510 sweep_intervals (void)
6512 register struct interval_block
*iblk
;
6513 struct interval_block
**iprev
= &interval_block
;
6514 register int lim
= interval_block_index
;
6515 EMACS_INT num_free
= 0, num_used
= 0;
6517 interval_free_list
= 0;
6519 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6524 for (i
= 0; i
< lim
; i
++)
6526 if (!iblk
->intervals
[i
].gcmarkbit
)
6528 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6529 interval_free_list
= &iblk
->intervals
[i
];
6535 iblk
->intervals
[i
].gcmarkbit
= 0;
6538 lim
= INTERVAL_BLOCK_SIZE
;
6539 /* If this block contains only free intervals and we have already
6540 seen more than two blocks worth of free intervals then
6541 deallocate this block. */
6542 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6544 *iprev
= iblk
->next
;
6545 /* Unhook from the free list. */
6546 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6551 num_free
+= this_free
;
6552 iprev
= &iblk
->next
;
6555 total_intervals
= num_used
;
6556 total_free_intervals
= num_free
;
6559 NO_INLINE
/* For better stack traces */
6561 sweep_symbols (void)
6563 struct symbol_block
*sblk
;
6564 struct symbol_block
**sprev
= &symbol_block
;
6565 int lim
= symbol_block_index
;
6566 EMACS_INT num_free
= 0, num_used
= ARRAYELTS (lispsym
);
6568 symbol_free_list
= NULL
;
6570 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
6571 lispsym
[i
].gcmarkbit
= 0;
6573 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6576 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6577 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6579 for (; sym
< end
; ++sym
)
6581 if (!sym
->s
.gcmarkbit
)
6583 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6584 xfree (SYMBOL_BLV (&sym
->s
));
6585 sym
->s
.next
= symbol_free_list
;
6586 symbol_free_list
= &sym
->s
;
6587 symbol_free_list
->function
= Vdead
;
6593 sym
->s
.gcmarkbit
= 0;
6594 /* Attempt to catch bogus objects. */
6595 eassert (valid_lisp_object_p (sym
->s
.function
));
6599 lim
= SYMBOL_BLOCK_SIZE
;
6600 /* If this block contains only free symbols and we have already
6601 seen more than two blocks worth of free symbols then deallocate
6603 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6605 *sprev
= sblk
->next
;
6606 /* Unhook from the free list. */
6607 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6612 num_free
+= this_free
;
6613 sprev
= &sblk
->next
;
6616 total_symbols
= num_used
;
6617 total_free_symbols
= num_free
;
6620 NO_INLINE
/* For better stack traces. */
6624 register struct marker_block
*mblk
;
6625 struct marker_block
**mprev
= &marker_block
;
6626 register int lim
= marker_block_index
;
6627 EMACS_INT num_free
= 0, num_used
= 0;
6629 /* Put all unmarked misc's on free list. For a marker, first
6630 unchain it from the buffer it points into. */
6632 marker_free_list
= 0;
6634 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6639 for (i
= 0; i
< lim
; i
++)
6641 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6643 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6644 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6645 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Finalizer
)
6646 unchain_finalizer (&mblk
->markers
[i
].m
.u_finalizer
);
6647 /* Set the type of the freed object to Lisp_Misc_Free.
6648 We could leave the type alone, since nobody checks it,
6649 but this might catch bugs faster. */
6650 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6651 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6652 marker_free_list
= &mblk
->markers
[i
].m
;
6658 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6661 lim
= MARKER_BLOCK_SIZE
;
6662 /* If this block contains only free markers and we have already
6663 seen more than two blocks worth of free markers then deallocate
6665 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6667 *mprev
= mblk
->next
;
6668 /* Unhook from the free list. */
6669 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6674 num_free
+= this_free
;
6675 mprev
= &mblk
->next
;
6679 total_markers
= num_used
;
6680 total_free_markers
= num_free
;
6683 NO_INLINE
/* For better stack traces */
6685 sweep_buffers (void)
6687 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6690 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6691 if (!VECTOR_MARKED_P (buffer
))
6693 *bprev
= buffer
->next
;
6698 VECTOR_UNMARK (buffer
);
6699 /* Do not use buffer_(set|get)_intervals here. */
6700 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6702 bprev
= &buffer
->next
;
6706 /* Sweep: find all structures not marked, and free them. */
6710 /* Remove or mark entries in weak hash tables.
6711 This must be done before any object is unmarked. */
6712 sweep_weak_hash_tables ();
6715 check_string_bytes (!noninteractive
);
6723 check_string_bytes (!noninteractive
);
6726 DEFUN ("memory-info", Fmemory_info
, Smemory_info
, 0, 0, 0,
6727 doc
: /* Return a list of (TOTAL-RAM FREE-RAM TOTAL-SWAP FREE-SWAP).
6728 All values are in Kbytes. If there is no swap space,
6729 last two values are zero. If the system is not supported
6730 or memory information can't be obtained, return nil. */)
6733 #if defined HAVE_LINUX_SYSINFO
6739 #ifdef LINUX_SYSINFO_UNIT
6740 units
= si
.mem_unit
;
6744 return list4i ((uintmax_t) si
.totalram
* units
/ 1024,
6745 (uintmax_t) si
.freeram
* units
/ 1024,
6746 (uintmax_t) si
.totalswap
* units
/ 1024,
6747 (uintmax_t) si
.freeswap
* units
/ 1024);
6748 #elif defined WINDOWSNT
6749 unsigned long long totalram
, freeram
, totalswap
, freeswap
;
6751 if (w32_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6752 return list4i ((uintmax_t) totalram
/ 1024,
6753 (uintmax_t) freeram
/ 1024,
6754 (uintmax_t) totalswap
/ 1024,
6755 (uintmax_t) freeswap
/ 1024);
6759 unsigned long totalram
, freeram
, totalswap
, freeswap
;
6761 if (dos_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6762 return list4i ((uintmax_t) totalram
/ 1024,
6763 (uintmax_t) freeram
/ 1024,
6764 (uintmax_t) totalswap
/ 1024,
6765 (uintmax_t) freeswap
/ 1024);
6768 #else /* not HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6769 /* FIXME: add more systems. */
6771 #endif /* HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6774 /* Debugging aids. */
6776 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6777 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6778 This may be helpful in debugging Emacs's memory usage.
6779 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6785 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
6788 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6794 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6795 doc
: /* Return a list of counters that measure how much consing there has been.
6796 Each of these counters increments for a certain kind of object.
6797 The counters wrap around from the largest positive integer to zero.
6798 Garbage collection does not decrease them.
6799 The elements of the value are as follows:
6800 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6801 All are in units of 1 = one object consed
6802 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6804 MISCS include overlays, markers, and some internal types.
6805 Frames, windows, buffers, and subprocesses count as vectors
6806 (but the contents of a buffer's text do not count here). */)
6809 return listn (CONSTYPE_HEAP
, 8,
6810 bounded_number (cons_cells_consed
),
6811 bounded_number (floats_consed
),
6812 bounded_number (vector_cells_consed
),
6813 bounded_number (symbols_consed
),
6814 bounded_number (string_chars_consed
),
6815 bounded_number (misc_objects_consed
),
6816 bounded_number (intervals_consed
),
6817 bounded_number (strings_consed
));
6821 symbol_uses_obj (Lisp_Object symbol
, Lisp_Object obj
)
6823 struct Lisp_Symbol
*sym
= XSYMBOL (symbol
);
6824 Lisp_Object val
= find_symbol_value (symbol
);
6825 return (EQ (val
, obj
)
6826 || EQ (sym
->function
, obj
)
6827 || (!NILP (sym
->function
)
6828 && COMPILEDP (sym
->function
)
6829 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6832 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)));
6835 /* Find at most FIND_MAX symbols which have OBJ as their value or
6836 function. This is used in gdbinit's `xwhichsymbols' command. */
6839 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6841 struct symbol_block
*sblk
;
6842 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6843 Lisp_Object found
= Qnil
;
6847 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
6849 Lisp_Object sym
= builtin_lisp_symbol (i
);
6850 if (symbol_uses_obj (sym
, obj
))
6852 found
= Fcons (sym
, found
);
6853 if (--find_max
== 0)
6858 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6860 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6863 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6865 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6868 Lisp_Object sym
= make_lisp_symbol (&aligned_sym
->s
);
6869 if (symbol_uses_obj (sym
, obj
))
6871 found
= Fcons (sym
, found
);
6872 if (--find_max
== 0)
6880 unbind_to (gc_count
, Qnil
);
6884 #ifdef SUSPICIOUS_OBJECT_CHECKING
6887 find_suspicious_object_in_range (void *begin
, void *end
)
6889 char *begin_a
= begin
;
6893 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6895 char *suspicious_object
= suspicious_objects
[i
];
6896 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
6897 return suspicious_object
;
6904 note_suspicious_free (void* ptr
)
6906 struct suspicious_free_record
* rec
;
6908 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
6909 if (suspicious_free_history_index
==
6910 ARRAYELTS (suspicious_free_history
))
6912 suspicious_free_history_index
= 0;
6915 memset (rec
, 0, sizeof (*rec
));
6916 rec
->suspicious_object
= ptr
;
6917 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
6921 detect_suspicious_free (void* ptr
)
6925 eassert (ptr
!= NULL
);
6927 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6928 if (suspicious_objects
[i
] == ptr
)
6930 note_suspicious_free (ptr
);
6931 suspicious_objects
[i
] = NULL
;
6935 #endif /* SUSPICIOUS_OBJECT_CHECKING */
6937 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
6938 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
6939 If Emacs is compiled with suspicious object checking, capture
6940 a stack trace when OBJ is freed in order to help track down
6941 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
6944 #ifdef SUSPICIOUS_OBJECT_CHECKING
6945 /* Right now, we care only about vectors. */
6946 if (VECTORLIKEP (obj
))
6948 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
6949 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
6950 suspicious_object_index
= 0;
6956 #ifdef ENABLE_CHECKING
6958 bool suppress_checking
;
6961 die (const char *msg
, const char *file
, int line
)
6963 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
6965 terminate_due_to_signal (SIGABRT
, INT_MAX
);
6968 #endif /* ENABLE_CHECKING */
6970 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
6972 /* Debugging check whether STR is ASCII-only. */
6975 verify_ascii (const char *str
)
6977 const unsigned char *ptr
= (unsigned char *) str
, *end
= ptr
+ strlen (str
);
6980 int c
= STRING_CHAR_ADVANCE (ptr
);
6981 if (!ASCII_CHAR_P (c
))
6987 /* Stress alloca with inconveniently sized requests and check
6988 whether all allocated areas may be used for Lisp_Object. */
6990 NO_INLINE
static void
6991 verify_alloca (void)
6994 enum { ALLOCA_CHECK_MAX
= 256 };
6995 /* Start from size of the smallest Lisp object. */
6996 for (i
= sizeof (struct Lisp_Cons
); i
<= ALLOCA_CHECK_MAX
; i
++)
6998 void *ptr
= alloca (i
);
6999 make_lisp_ptr (ptr
, Lisp_Cons
);
7003 #else /* not ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7005 #define verify_alloca() ((void) 0)
7007 #endif /* ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7009 /* Initialization. */
7012 init_alloc_once (void)
7014 /* Even though Qt's contents are not set up, its address is known. */
7018 pure_size
= PURESIZE
;
7021 init_finalizer_list (&finalizers
);
7022 init_finalizer_list (&doomed_finalizers
);
7025 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
7027 #ifdef DOUG_LEA_MALLOC
7028 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
7029 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
7030 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
7035 refill_memory_reserve ();
7036 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
7042 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
7043 setjmp_tested_p
= longjmps_done
= 0;
7045 Vgc_elapsed
= make_float (0.0);
7049 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
7054 syms_of_alloc (void)
7056 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
7057 doc
: /* Number of bytes of consing between garbage collections.
7058 Garbage collection can happen automatically once this many bytes have been
7059 allocated since the last garbage collection. All data types count.
7061 Garbage collection happens automatically only when `eval' is called.
7063 By binding this temporarily to a large number, you can effectively
7064 prevent garbage collection during a part of the program.
7065 See also `gc-cons-percentage'. */);
7067 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
7068 doc
: /* Portion of the heap used for allocation.
7069 Garbage collection can happen automatically once this portion of the heap
7070 has been allocated since the last garbage collection.
7071 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
7072 Vgc_cons_percentage
= make_float (0.1);
7074 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
7075 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
7077 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
7078 doc
: /* Number of cons cells that have been consed so far. */);
7080 DEFVAR_INT ("floats-consed", floats_consed
,
7081 doc
: /* Number of floats that have been consed so far. */);
7083 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7084 doc
: /* Number of vector cells that have been consed so far. */);
7086 DEFVAR_INT ("symbols-consed", symbols_consed
,
7087 doc
: /* Number of symbols that have been consed so far. */);
7088 symbols_consed
+= ARRAYELTS (lispsym
);
7090 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7091 doc
: /* Number of string characters that have been consed so far. */);
7093 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7094 doc
: /* Number of miscellaneous objects that have been consed so far.
7095 These include markers and overlays, plus certain objects not visible
7098 DEFVAR_INT ("intervals-consed", intervals_consed
,
7099 doc
: /* Number of intervals that have been consed so far. */);
7101 DEFVAR_INT ("strings-consed", strings_consed
,
7102 doc
: /* Number of strings that have been consed so far. */);
7104 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7105 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7106 This means that certain objects should be allocated in shared (pure) space.
7107 It can also be set to a hash-table, in which case this table is used to
7108 do hash-consing of the objects allocated to pure space. */);
7110 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7111 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7112 garbage_collection_messages
= 0;
7114 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7115 doc
: /* Hook run after garbage collection has finished. */);
7116 Vpost_gc_hook
= Qnil
;
7117 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7119 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7120 doc
: /* Precomputed `signal' argument for memory-full error. */);
7121 /* We build this in advance because if we wait until we need it, we might
7122 not be able to allocate the memory to hold it. */
7124 = listn (CONSTYPE_PURE
, 2, Qerror
,
7125 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7127 DEFVAR_LISP ("memory-full", Vmemory_full
,
7128 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7129 Vmemory_full
= Qnil
;
7131 DEFSYM (Qconses
, "conses");
7132 DEFSYM (Qsymbols
, "symbols");
7133 DEFSYM (Qmiscs
, "miscs");
7134 DEFSYM (Qstrings
, "strings");
7135 DEFSYM (Qvectors
, "vectors");
7136 DEFSYM (Qfloats
, "floats");
7137 DEFSYM (Qintervals
, "intervals");
7138 DEFSYM (Qbuffers
, "buffers");
7139 DEFSYM (Qstring_bytes
, "string-bytes");
7140 DEFSYM (Qvector_slots
, "vector-slots");
7141 DEFSYM (Qheap
, "heap");
7142 DEFSYM (Qautomatic_gc
, "Automatic GC");
7144 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7145 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7147 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7148 doc
: /* Accumulated time elapsed in garbage collections.
7149 The time is in seconds as a floating point value. */);
7150 DEFVAR_INT ("gcs-done", gcs_done
,
7151 doc
: /* Accumulated number of garbage collections done. */);
7156 defsubr (&Sbool_vector
);
7157 defsubr (&Smake_byte_code
);
7158 defsubr (&Smake_list
);
7159 defsubr (&Smake_vector
);
7160 defsubr (&Smake_string
);
7161 defsubr (&Smake_bool_vector
);
7162 defsubr (&Smake_symbol
);
7163 defsubr (&Smake_marker
);
7164 defsubr (&Smake_finalizer
);
7165 defsubr (&Spurecopy
);
7166 defsubr (&Sgarbage_collect
);
7167 defsubr (&Smemory_limit
);
7168 defsubr (&Smemory_info
);
7169 defsubr (&Smemory_use_counts
);
7170 defsubr (&Ssuspicious_object
);
7173 /* When compiled with GCC, GDB might say "No enum type named
7174 pvec_type" if we don't have at least one symbol with that type, and
7175 then xbacktrace could fail. Similarly for the other enums and
7176 their values. Some non-GCC compilers don't like these constructs. */
7180 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7181 enum char_table_specials char_table_specials
;
7182 enum char_bits char_bits
;
7183 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7184 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7185 enum Lisp_Bits Lisp_Bits
;
7186 enum Lisp_Compiled Lisp_Compiled
;
7187 enum maxargs maxargs
;
7188 enum MAX_ALLOCA MAX_ALLOCA
;
7189 enum More_Lisp_Bits More_Lisp_Bits
;
7190 enum pvec_type pvec_type
;
7191 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7192 #endif /* __GNUC__ */