1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2014 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. */
36 #include "intervals.h"
38 #include "character.h"
43 #include "blockinput.h"
44 #include "termhooks.h" /* For struct terminal. */
45 #ifdef HAVE_WINDOW_SYSTEM
47 #endif /* HAVE_WINDOW_SYSTEM */
50 #include <execinfo.h> /* For backtrace. */
52 #if (defined ENABLE_CHECKING \
53 && defined HAVE_VALGRIND_VALGRIND_H \
54 && !defined USE_VALGRIND)
55 # define USE_VALGRIND 1
59 #include <valgrind/valgrind.h>
60 #include <valgrind/memcheck.h>
61 static bool valgrind_p
;
64 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
65 Doable only if GC_MARK_STACK. */
67 # undef GC_CHECK_MARKED_OBJECTS
70 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
71 memory. Can do this only if using gmalloc.c and if not checking
74 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
75 || defined GC_CHECK_MARKED_OBJECTS)
76 #undef GC_MALLOC_CHECK
87 #include "w32heap.h" /* for sbrk */
90 #ifdef DOUG_LEA_MALLOC
94 /* Specify maximum number of areas to mmap. It would be nice to use a
95 value that explicitly means "no limit". */
97 #define MMAP_MAX_AREAS 100000000
99 #endif /* not DOUG_LEA_MALLOC */
101 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
102 to a struct Lisp_String. */
104 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
105 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
106 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
108 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
109 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
110 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
112 /* Default value of gc_cons_threshold (see below). */
114 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
116 /* Global variables. */
117 struct emacs_globals globals
;
119 /* Number of bytes of consing done since the last gc. */
121 EMACS_INT consing_since_gc
;
123 /* Similar minimum, computed from Vgc_cons_percentage. */
125 EMACS_INT gc_relative_threshold
;
127 /* Minimum number of bytes of consing since GC before next GC,
128 when memory is full. */
130 EMACS_INT memory_full_cons_threshold
;
132 /* True during GC. */
136 /* True means abort if try to GC.
137 This is for code which is written on the assumption that
138 no GC will happen, so as to verify that assumption. */
142 /* Number of live and free conses etc. */
144 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
145 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
146 static EMACS_INT total_free_floats
, total_floats
;
148 /* Points to memory space allocated as "spare", to be freed if we run
149 out of memory. We keep one large block, four cons-blocks, and
150 two string blocks. */
152 static char *spare_memory
[7];
154 /* Amount of spare memory to keep in large reserve block, or to see
155 whether this much is available when malloc fails on a larger request. */
157 #define SPARE_MEMORY (1 << 14)
159 /* Initialize it to a nonzero value to force it into data space
160 (rather than bss space). That way unexec will remap it into text
161 space (pure), on some systems. We have not implemented the
162 remapping on more recent systems because this is less important
163 nowadays than in the days of small memories and timesharing. */
165 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
166 #define PUREBEG (char *) pure
168 /* Pointer to the pure area, and its size. */
170 static char *purebeg
;
171 static ptrdiff_t pure_size
;
173 /* Number of bytes of pure storage used before pure storage overflowed.
174 If this is non-zero, this implies that an overflow occurred. */
176 static ptrdiff_t pure_bytes_used_before_overflow
;
178 /* True if P points into pure space. */
180 #define PURE_POINTER_P(P) \
181 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
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 Lisp_Object Qconses
;
259 static Lisp_Object Qsymbols
;
260 static Lisp_Object Qmiscs
;
261 static Lisp_Object Qstrings
;
262 static Lisp_Object Qvectors
;
263 static Lisp_Object Qfloats
;
264 static Lisp_Object Qintervals
;
265 static Lisp_Object Qbuffers
;
266 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
267 static Lisp_Object Qgc_cons_threshold
;
268 Lisp_Object Qautomatic_gc
;
269 Lisp_Object Qchar_table_extra_slots
;
271 /* Hook run after GC has finished. */
273 static Lisp_Object Qpost_gc_hook
;
275 static void mark_terminals (void);
276 static void gc_sweep (void);
277 static Lisp_Object
make_pure_vector (ptrdiff_t);
278 static void mark_buffer (struct buffer
*);
280 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
281 static void refill_memory_reserve (void);
283 static void compact_small_strings (void);
284 static void free_large_strings (void);
285 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
287 /* When scanning the C stack for live Lisp objects, Emacs keeps track of
288 what memory allocated via lisp_malloc and lisp_align_malloc is intended
289 for what purpose. This enumeration specifies the type of memory. */
300 /* Since all non-bool pseudovectors are small enough to be
301 allocated from vector blocks, this memory type denotes
302 large regular vectors and large bool pseudovectors. */
304 /* Special type to denote vector blocks. */
305 MEM_TYPE_VECTOR_BLOCK
,
306 /* Special type to denote reserved memory. */
310 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
312 /* A unique object in pure space used to make some Lisp objects
313 on free lists recognizable in O(1). */
315 static Lisp_Object Vdead
;
316 #define DEADP(x) EQ (x, Vdead)
318 #ifdef GC_MALLOC_CHECK
320 enum mem_type allocated_mem_type
;
322 #endif /* GC_MALLOC_CHECK */
324 /* A node in the red-black tree describing allocated memory containing
325 Lisp data. Each such block is recorded with its start and end
326 address when it is allocated, and removed from the tree when it
329 A red-black tree is a balanced binary tree with the following
332 1. Every node is either red or black.
333 2. Every leaf is black.
334 3. If a node is red, then both of its children are black.
335 4. Every simple path from a node to a descendant leaf contains
336 the same number of black nodes.
337 5. The root is always black.
339 When nodes are inserted into the tree, or deleted from the tree,
340 the tree is "fixed" so that these properties are always true.
342 A red-black tree with N internal nodes has height at most 2
343 log(N+1). Searches, insertions and deletions are done in O(log N).
344 Please see a text book about data structures for a detailed
345 description of red-black trees. Any book worth its salt should
350 /* Children of this node. These pointers are never NULL. When there
351 is no child, the value is MEM_NIL, which points to a dummy node. */
352 struct mem_node
*left
, *right
;
354 /* The parent of this node. In the root node, this is NULL. */
355 struct mem_node
*parent
;
357 /* Start and end of allocated region. */
361 enum {MEM_BLACK
, MEM_RED
} color
;
367 /* Base address of stack. Set in main. */
369 Lisp_Object
*stack_base
;
371 /* Root of the tree describing allocated Lisp memory. */
373 static struct mem_node
*mem_root
;
375 /* Lowest and highest known address in the heap. */
377 static void *min_heap_address
, *max_heap_address
;
379 /* Sentinel node of the tree. */
381 static struct mem_node mem_z
;
382 #define MEM_NIL &mem_z
384 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
385 static void mem_insert_fixup (struct mem_node
*);
386 static void mem_rotate_left (struct mem_node
*);
387 static void mem_rotate_right (struct mem_node
*);
388 static void mem_delete (struct mem_node
*);
389 static void mem_delete_fixup (struct mem_node
*);
390 static struct mem_node
*mem_find (void *);
392 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
398 /* Recording what needs to be marked for gc. */
400 struct gcpro
*gcprolist
;
402 /* Addresses of staticpro'd variables. Initialize it to a nonzero
403 value; otherwise some compilers put it into BSS. */
405 enum { NSTATICS
= 2048 };
406 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
408 /* Index of next unused slot in staticvec. */
410 static int staticidx
;
412 static void *pure_alloc (size_t, int);
414 /* Return X rounded to the next multiple of Y. Arguments should not
415 have side effects, as they are evaluated more than once. Assume X
416 + Y - 1 does not overflow. Tune for Y being a power of 2. */
418 #define ROUNDUP(x, y) ((y) & ((y) - 1) \
419 ? ((x) + (y) - 1) - ((x) + (y) - 1) % (y) \
420 : ((x) + (y) - 1) & ~ ((y) - 1))
422 /* Return PTR rounded up to the next multiple of ALIGNMENT. */
425 ALIGN (void *ptr
, int alignment
)
427 return (void *) ROUNDUP ((uintptr_t) ptr
, alignment
);
431 XFLOAT_INIT (Lisp_Object f
, double n
)
433 XFLOAT (f
)->u
.data
= n
;
437 pointers_fit_in_lispobj_p (void)
439 return (UINTPTR_MAX
<= VAL_MAX
) || USE_LSB_TAG
;
443 mmap_lisp_allowed_p (void)
445 /* If we can't store all memory addresses in our lisp objects, it's
446 risky to let the heap use mmap and give us addresses from all
447 over our address space. We also can't use mmap for lisp objects
448 if we might dump: unexec doesn't preserve the contents of mmaped
450 return pointers_fit_in_lispobj_p () && !might_dump
;
454 /************************************************************************
456 ************************************************************************/
458 /* Function malloc calls this if it finds we are near exhausting storage. */
461 malloc_warning (const char *str
)
463 pending_malloc_warning
= str
;
467 /* Display an already-pending malloc warning. */
470 display_malloc_warning (void)
472 call3 (intern ("display-warning"),
474 build_string (pending_malloc_warning
),
475 intern ("emergency"));
476 pending_malloc_warning
= 0;
479 /* Called if we can't allocate relocatable space for a buffer. */
482 buffer_memory_full (ptrdiff_t nbytes
)
484 /* If buffers use the relocating allocator, no need to free
485 spare_memory, because we may have plenty of malloc space left
486 that we could get, and if we don't, the malloc that fails will
487 itself cause spare_memory to be freed. If buffers don't use the
488 relocating allocator, treat this like any other failing
492 memory_full (nbytes
);
494 /* This used to call error, but if we've run out of memory, we could
495 get infinite recursion trying to build the string. */
496 xsignal (Qnil
, Vmemory_signal_data
);
500 /* A common multiple of the positive integers A and B. Ideally this
501 would be the least common multiple, but there's no way to do that
502 as a constant expression in C, so do the best that we can easily do. */
503 #define COMMON_MULTIPLE(a, b) \
504 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
506 #ifndef XMALLOC_OVERRUN_CHECK
507 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
510 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
513 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
514 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
515 block size in little-endian order. The trailer consists of
516 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
518 The header is used to detect whether this block has been allocated
519 through these functions, as some low-level libc functions may
520 bypass the malloc hooks. */
522 #define XMALLOC_OVERRUN_CHECK_SIZE 16
523 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
524 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
526 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
527 hold a size_t value and (2) the header size is a multiple of the
528 alignment that Emacs needs for C types and for USE_LSB_TAG. */
529 #define XMALLOC_BASE_ALIGNMENT \
530 alignof (union { long double d; intmax_t i; void *p; })
533 # define XMALLOC_HEADER_ALIGNMENT \
534 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
536 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
538 #define XMALLOC_OVERRUN_SIZE_SIZE \
539 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
540 + XMALLOC_HEADER_ALIGNMENT - 1) \
541 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
542 - XMALLOC_OVERRUN_CHECK_SIZE)
544 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
545 { '\x9a', '\x9b', '\xae', '\xaf',
546 '\xbf', '\xbe', '\xce', '\xcf',
547 '\xea', '\xeb', '\xec', '\xed',
548 '\xdf', '\xde', '\x9c', '\x9d' };
550 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
551 { '\xaa', '\xab', '\xac', '\xad',
552 '\xba', '\xbb', '\xbc', '\xbd',
553 '\xca', '\xcb', '\xcc', '\xcd',
554 '\xda', '\xdb', '\xdc', '\xdd' };
556 /* Insert and extract the block size in the header. */
559 xmalloc_put_size (unsigned char *ptr
, size_t size
)
562 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
564 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
570 xmalloc_get_size (unsigned char *ptr
)
574 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
575 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
584 /* Like malloc, but wraps allocated block with header and trailer. */
587 overrun_check_malloc (size_t size
)
589 register unsigned char *val
;
590 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
593 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
596 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
597 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
598 xmalloc_put_size (val
, size
);
599 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
600 XMALLOC_OVERRUN_CHECK_SIZE
);
606 /* Like realloc, but checks old block for overrun, and wraps new block
607 with header and trailer. */
610 overrun_check_realloc (void *block
, size_t size
)
612 register unsigned char *val
= (unsigned char *) block
;
613 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
617 && memcmp (xmalloc_overrun_check_header
,
618 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
619 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
621 size_t osize
= xmalloc_get_size (val
);
622 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
623 XMALLOC_OVERRUN_CHECK_SIZE
))
625 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
626 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
627 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
630 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
634 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
635 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
636 xmalloc_put_size (val
, size
);
637 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
638 XMALLOC_OVERRUN_CHECK_SIZE
);
643 /* Like free, but checks block for overrun. */
646 overrun_check_free (void *block
)
648 unsigned char *val
= (unsigned char *) block
;
651 && memcmp (xmalloc_overrun_check_header
,
652 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
653 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
655 size_t osize
= xmalloc_get_size (val
);
656 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
657 XMALLOC_OVERRUN_CHECK_SIZE
))
659 #ifdef XMALLOC_CLEAR_FREE_MEMORY
660 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
661 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
663 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
664 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
665 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
675 #define malloc overrun_check_malloc
676 #define realloc overrun_check_realloc
677 #define free overrun_check_free
680 /* Like malloc but check for no memory and block interrupt input.. */
683 xmalloc (size_t size
)
694 /* Like the above, but zeroes out the memory just allocated. */
697 xzalloc (size_t size
)
705 memset (val
, 0, size
);
709 /* Like realloc but check for no memory and block interrupt input.. */
712 xrealloc (void *block
, size_t size
)
716 /* We must call malloc explicitly when BLOCK is 0, since some
717 reallocs don't do this. */
721 val
= realloc (block
, size
);
729 /* Like free but block interrupt input. */
739 /* We don't call refill_memory_reserve here
740 because in practice the call in r_alloc_free seems to suffice. */
744 /* Other parts of Emacs pass large int values to allocator functions
745 expecting ptrdiff_t. This is portable in practice, but check it to
747 verify (INT_MAX
<= PTRDIFF_MAX
);
750 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
751 Signal an error on memory exhaustion, and block interrupt input. */
754 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
756 eassert (0 <= nitems
&& 0 < item_size
);
757 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
758 memory_full (SIZE_MAX
);
759 return xmalloc (nitems
* item_size
);
763 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
764 Signal an error on memory exhaustion, and block interrupt input. */
767 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
769 eassert (0 <= nitems
&& 0 < item_size
);
770 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
771 memory_full (SIZE_MAX
);
772 return xrealloc (pa
, nitems
* item_size
);
776 /* Grow PA, which points to an array of *NITEMS items, and return the
777 location of the reallocated array, updating *NITEMS to reflect its
778 new size. The new array will contain at least NITEMS_INCR_MIN more
779 items, but will not contain more than NITEMS_MAX items total.
780 ITEM_SIZE is the size of each item, in bytes.
782 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
783 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
786 If PA is null, then allocate a new array instead of reallocating
789 Block interrupt input as needed. If memory exhaustion occurs, set
790 *NITEMS to zero if PA is null, and signal an error (i.e., do not
793 Thus, to grow an array A without saving its old contents, do
794 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
795 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
796 and signals an error, and later this code is reexecuted and
797 attempts to free A. */
800 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
801 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
803 /* The approximate size to use for initial small allocation
804 requests. This is the largest "small" request for the GNU C
806 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
808 /* If the array is tiny, grow it to about (but no greater than)
809 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
810 ptrdiff_t n
= *nitems
;
811 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
812 ptrdiff_t half_again
= n
>> 1;
813 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
815 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
816 NITEMS_MAX, and what the C language can represent safely. */
817 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
818 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
819 ? nitems_max
: C_language_max
);
820 ptrdiff_t nitems_incr_max
= n_max
- n
;
821 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
823 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
826 if (nitems_incr_max
< incr
)
827 memory_full (SIZE_MAX
);
829 pa
= xrealloc (pa
, n
* item_size
);
835 /* Like strdup, but uses xmalloc. */
838 xstrdup (const char *s
)
842 size
= strlen (s
) + 1;
843 return memcpy (xmalloc (size
), s
, size
);
846 /* Like above, but duplicates Lisp string to C string. */
849 xlispstrdup (Lisp_Object string
)
851 ptrdiff_t size
= SBYTES (string
) + 1;
852 return memcpy (xmalloc (size
), SSDATA (string
), size
);
855 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
856 pointed to. If STRING is null, assign it without copying anything.
857 Allocate before freeing, to avoid a dangling pointer if allocation
861 dupstring (char **ptr
, char const *string
)
864 *ptr
= string
? xstrdup (string
) : 0;
869 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
870 argument is a const pointer. */
873 xputenv (char const *string
)
875 if (putenv ((char *) string
) != 0)
879 /* Return a newly allocated memory block of SIZE bytes, remembering
880 to free it when unwinding. */
882 record_xmalloc (size_t size
)
884 void *p
= xmalloc (size
);
885 record_unwind_protect_ptr (xfree
, p
);
890 /* Like malloc but used for allocating Lisp data. NBYTES is the
891 number of bytes to allocate, TYPE describes the intended use of the
892 allocated memory block (for strings, for conses, ...). */
895 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
899 lisp_malloc (size_t nbytes
, enum mem_type type
)
903 #ifdef GC_MALLOC_CHECK
904 allocated_mem_type
= type
;
907 val
= malloc (nbytes
);
910 /* If the memory just allocated cannot be addressed thru a Lisp
911 object's pointer, and it needs to be,
912 that's equivalent to running out of memory. */
913 if (val
&& type
!= MEM_TYPE_NON_LISP
)
916 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
917 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
919 lisp_malloc_loser
= val
;
926 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
927 if (val
&& type
!= MEM_TYPE_NON_LISP
)
928 mem_insert (val
, (char *) val
+ nbytes
, type
);
932 memory_full (nbytes
);
936 /* Free BLOCK. This must be called to free memory allocated with a
937 call to lisp_malloc. */
940 lisp_free (void *block
)
943 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
944 mem_delete (mem_find (block
));
948 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
950 /* The entry point is lisp_align_malloc which returns blocks of at most
951 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
953 /* Use aligned_alloc if it or a simple substitute is available.
954 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
957 #if ! ADDRESS_SANITIZER
958 # if !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC
959 # define USE_ALIGNED_ALLOC 1
960 /* Defined in gmalloc.c. */
961 void *aligned_alloc (size_t, size_t);
962 # elif defined HAVE_ALIGNED_ALLOC
963 # define USE_ALIGNED_ALLOC 1
964 # elif defined HAVE_POSIX_MEMALIGN
965 # define USE_ALIGNED_ALLOC 1
967 aligned_alloc (size_t alignment
, size_t size
)
970 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
975 /* BLOCK_ALIGN has to be a power of 2. */
976 #define BLOCK_ALIGN (1 << 10)
978 /* Padding to leave at the end of a malloc'd block. This is to give
979 malloc a chance to minimize the amount of memory wasted to alignment.
980 It should be tuned to the particular malloc library used.
981 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
982 aligned_alloc on the other hand would ideally prefer a value of 4
983 because otherwise, there's 1020 bytes wasted between each ablocks.
984 In Emacs, testing shows that those 1020 can most of the time be
985 efficiently used by malloc to place other objects, so a value of 0 can
986 still preferable unless you have a lot of aligned blocks and virtually
988 #define BLOCK_PADDING 0
989 #define BLOCK_BYTES \
990 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
992 /* Internal data structures and constants. */
994 #define ABLOCKS_SIZE 16
996 /* An aligned block of memory. */
1001 char payload
[BLOCK_BYTES
];
1002 struct ablock
*next_free
;
1004 /* `abase' is the aligned base of the ablocks. */
1005 /* It is overloaded to hold the virtual `busy' field that counts
1006 the number of used ablock in the parent ablocks.
1007 The first ablock has the `busy' field, the others have the `abase'
1008 field. To tell the difference, we assume that pointers will have
1009 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1010 is used to tell whether the real base of the parent ablocks is `abase'
1011 (if not, the word before the first ablock holds a pointer to the
1013 struct ablocks
*abase
;
1014 /* The padding of all but the last ablock is unused. The padding of
1015 the last ablock in an ablocks is not allocated. */
1017 char padding
[BLOCK_PADDING
];
1021 /* A bunch of consecutive aligned blocks. */
1024 struct ablock blocks
[ABLOCKS_SIZE
];
1027 /* Size of the block requested from malloc or aligned_alloc. */
1028 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1030 #define ABLOCK_ABASE(block) \
1031 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1032 ? (struct ablocks *)(block) \
1035 /* Virtual `busy' field. */
1036 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1038 /* Pointer to the (not necessarily aligned) malloc block. */
1039 #ifdef USE_ALIGNED_ALLOC
1040 #define ABLOCKS_BASE(abase) (abase)
1042 #define ABLOCKS_BASE(abase) \
1043 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1046 /* The list of free ablock. */
1047 static struct ablock
*free_ablock
;
1049 /* Allocate an aligned block of nbytes.
1050 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1051 smaller or equal to BLOCK_BYTES. */
1053 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1056 struct ablocks
*abase
;
1058 eassert (nbytes
<= BLOCK_BYTES
);
1060 #ifdef GC_MALLOC_CHECK
1061 allocated_mem_type
= type
;
1067 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1069 #ifdef DOUG_LEA_MALLOC
1070 if (!mmap_lisp_allowed_p ())
1071 mallopt (M_MMAP_MAX
, 0);
1074 #ifdef USE_ALIGNED_ALLOC
1075 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1077 base
= malloc (ABLOCKS_BYTES
);
1078 abase
= ALIGN (base
, BLOCK_ALIGN
);
1082 memory_full (ABLOCKS_BYTES
);
1084 aligned
= (base
== abase
);
1086 ((void **) abase
)[-1] = base
;
1088 #ifdef DOUG_LEA_MALLOC
1089 if (!mmap_lisp_allowed_p ())
1090 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1094 /* If the memory just allocated cannot be addressed thru a Lisp
1095 object's pointer, and it needs to be, that's equivalent to
1096 running out of memory. */
1097 if (type
!= MEM_TYPE_NON_LISP
)
1100 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1101 XSETCONS (tem
, end
);
1102 if ((char *) XCONS (tem
) != end
)
1104 lisp_malloc_loser
= base
;
1106 memory_full (SIZE_MAX
);
1111 /* Initialize the blocks and put them on the free list.
1112 If `base' was not properly aligned, we can't use the last block. */
1113 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1115 abase
->blocks
[i
].abase
= abase
;
1116 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1117 free_ablock
= &abase
->blocks
[i
];
1119 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1121 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1122 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1123 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1124 eassert (ABLOCKS_BASE (abase
) == base
);
1125 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1128 abase
= ABLOCK_ABASE (free_ablock
);
1129 ABLOCKS_BUSY (abase
)
1130 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1132 free_ablock
= free_ablock
->x
.next_free
;
1134 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1135 if (type
!= MEM_TYPE_NON_LISP
)
1136 mem_insert (val
, (char *) val
+ nbytes
, type
);
1139 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1144 lisp_align_free (void *block
)
1146 struct ablock
*ablock
= block
;
1147 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1149 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1150 mem_delete (mem_find (block
));
1153 /* Put on free list. */
1154 ablock
->x
.next_free
= free_ablock
;
1155 free_ablock
= ablock
;
1156 /* Update busy count. */
1157 ABLOCKS_BUSY (abase
)
1158 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1160 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1161 { /* All the blocks are free. */
1162 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1163 struct ablock
**tem
= &free_ablock
;
1164 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1168 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1171 *tem
= (*tem
)->x
.next_free
;
1174 tem
= &(*tem
)->x
.next_free
;
1176 eassert ((aligned
& 1) == aligned
);
1177 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1178 #ifdef USE_POSIX_MEMALIGN
1179 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1181 free (ABLOCKS_BASE (abase
));
1185 /***********************************************************************
1187 ***********************************************************************/
1189 /* Number of intervals allocated in an interval_block structure.
1190 The 1020 is 1024 minus malloc overhead. */
1192 #define INTERVAL_BLOCK_SIZE \
1193 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1195 /* Intervals are allocated in chunks in the form of an interval_block
1198 struct interval_block
1200 /* Place `intervals' first, to preserve alignment. */
1201 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1202 struct interval_block
*next
;
1205 /* Current interval block. Its `next' pointer points to older
1208 static struct interval_block
*interval_block
;
1210 /* Index in interval_block above of the next unused interval
1213 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1215 /* Number of free and live intervals. */
1217 static EMACS_INT total_free_intervals
, total_intervals
;
1219 /* List of free intervals. */
1221 static INTERVAL interval_free_list
;
1223 /* Return a new interval. */
1226 make_interval (void)
1230 if (interval_free_list
)
1232 val
= interval_free_list
;
1233 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1237 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1239 struct interval_block
*newi
1240 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1242 newi
->next
= interval_block
;
1243 interval_block
= newi
;
1244 interval_block_index
= 0;
1245 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1247 val
= &interval_block
->intervals
[interval_block_index
++];
1250 consing_since_gc
+= sizeof (struct interval
);
1252 total_free_intervals
--;
1253 RESET_INTERVAL (val
);
1259 /* Mark Lisp objects in interval I. */
1262 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1264 /* Intervals should never be shared. So, if extra internal checking is
1265 enabled, GC aborts if it seems to have visited an interval twice. */
1266 eassert (!i
->gcmarkbit
);
1268 mark_object (i
->plist
);
1271 /* Mark the interval tree rooted in I. */
1273 #define MARK_INTERVAL_TREE(i) \
1275 if (i && !i->gcmarkbit) \
1276 traverse_intervals_noorder (i, mark_interval, Qnil); \
1279 /***********************************************************************
1281 ***********************************************************************/
1283 /* Lisp_Strings are allocated in string_block structures. When a new
1284 string_block is allocated, all the Lisp_Strings it contains are
1285 added to a free-list string_free_list. When a new Lisp_String is
1286 needed, it is taken from that list. During the sweep phase of GC,
1287 string_blocks that are entirely free are freed, except two which
1290 String data is allocated from sblock structures. Strings larger
1291 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1292 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1294 Sblocks consist internally of sdata structures, one for each
1295 Lisp_String. The sdata structure points to the Lisp_String it
1296 belongs to. The Lisp_String points back to the `u.data' member of
1297 its sdata structure.
1299 When a Lisp_String is freed during GC, it is put back on
1300 string_free_list, and its `data' member and its sdata's `string'
1301 pointer is set to null. The size of the string is recorded in the
1302 `n.nbytes' member of the sdata. So, sdata structures that are no
1303 longer used, can be easily recognized, and it's easy to compact the
1304 sblocks of small strings which we do in compact_small_strings. */
1306 /* Size in bytes of an sblock structure used for small strings. This
1307 is 8192 minus malloc overhead. */
1309 #define SBLOCK_SIZE 8188
1311 /* Strings larger than this are considered large strings. String data
1312 for large strings is allocated from individual sblocks. */
1314 #define LARGE_STRING_BYTES 1024
1316 /* The SDATA typedef is a struct or union describing string memory
1317 sub-allocated from an sblock. This is where the contents of Lisp
1318 strings are stored. */
1322 /* Back-pointer to the string this sdata belongs to. If null, this
1323 structure is free, and NBYTES (in this structure or in the union below)
1324 contains the string's byte size (the same value that STRING_BYTES
1325 would return if STRING were non-null). If non-null, STRING_BYTES
1326 (STRING) is the size of the data, and DATA contains the string's
1328 struct Lisp_String
*string
;
1330 #ifdef GC_CHECK_STRING_BYTES
1334 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1337 #ifdef GC_CHECK_STRING_BYTES
1339 typedef struct sdata sdata
;
1340 #define SDATA_NBYTES(S) (S)->nbytes
1341 #define SDATA_DATA(S) (S)->data
1347 struct Lisp_String
*string
;
1349 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1350 which has a flexible array member. However, if implemented by
1351 giving this union a member of type 'struct sdata', the union
1352 could not be the last (flexible) member of 'struct sblock',
1353 because C99 prohibits a flexible array member from having a type
1354 that is itself a flexible array. So, comment this member out here,
1355 but remember that the option's there when using this union. */
1360 /* When STRING is null. */
1363 struct Lisp_String
*string
;
1368 #define SDATA_NBYTES(S) (S)->n.nbytes
1369 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1371 #endif /* not GC_CHECK_STRING_BYTES */
1373 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1375 /* Structure describing a block of memory which is sub-allocated to
1376 obtain string data memory for strings. Blocks for small strings
1377 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1378 as large as needed. */
1383 struct sblock
*next
;
1385 /* Pointer to the next free sdata block. This points past the end
1386 of the sblock if there isn't any space left in this block. */
1390 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1393 /* Number of Lisp strings in a string_block structure. The 1020 is
1394 1024 minus malloc overhead. */
1396 #define STRING_BLOCK_SIZE \
1397 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1399 /* Structure describing a block from which Lisp_String structures
1404 /* Place `strings' first, to preserve alignment. */
1405 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1406 struct string_block
*next
;
1409 /* Head and tail of the list of sblock structures holding Lisp string
1410 data. We always allocate from current_sblock. The NEXT pointers
1411 in the sblock structures go from oldest_sblock to current_sblock. */
1413 static struct sblock
*oldest_sblock
, *current_sblock
;
1415 /* List of sblocks for large strings. */
1417 static struct sblock
*large_sblocks
;
1419 /* List of string_block structures. */
1421 static struct string_block
*string_blocks
;
1423 /* Free-list of Lisp_Strings. */
1425 static struct Lisp_String
*string_free_list
;
1427 /* Number of live and free Lisp_Strings. */
1429 static EMACS_INT total_strings
, total_free_strings
;
1431 /* Number of bytes used by live strings. */
1433 static EMACS_INT total_string_bytes
;
1435 /* Given a pointer to a Lisp_String S which is on the free-list
1436 string_free_list, return a pointer to its successor in the
1439 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1441 /* Return a pointer to the sdata structure belonging to Lisp string S.
1442 S must be live, i.e. S->data must not be null. S->data is actually
1443 a pointer to the `u.data' member of its sdata structure; the
1444 structure starts at a constant offset in front of that. */
1446 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1449 #ifdef GC_CHECK_STRING_OVERRUN
1451 /* We check for overrun in string data blocks by appending a small
1452 "cookie" after each allocated string data block, and check for the
1453 presence of this cookie during GC. */
1455 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1456 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1457 { '\xde', '\xad', '\xbe', '\xef' };
1460 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1463 /* Value is the size of an sdata structure large enough to hold NBYTES
1464 bytes of string data. The value returned includes a terminating
1465 NUL byte, the size of the sdata structure, and padding. */
1467 #ifdef GC_CHECK_STRING_BYTES
1469 #define SDATA_SIZE(NBYTES) \
1470 ((SDATA_DATA_OFFSET \
1472 + sizeof (ptrdiff_t) - 1) \
1473 & ~(sizeof (ptrdiff_t) - 1))
1475 #else /* not GC_CHECK_STRING_BYTES */
1477 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1478 less than the size of that member. The 'max' is not needed when
1479 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1480 alignment code reserves enough space. */
1482 #define SDATA_SIZE(NBYTES) \
1483 ((SDATA_DATA_OFFSET \
1484 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1486 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1488 + sizeof (ptrdiff_t) - 1) \
1489 & ~(sizeof (ptrdiff_t) - 1))
1491 #endif /* not GC_CHECK_STRING_BYTES */
1493 /* Extra bytes to allocate for each string. */
1495 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1497 /* Exact bound on the number of bytes in a string, not counting the
1498 terminating null. A string cannot contain more bytes than
1499 STRING_BYTES_BOUND, nor can it be so long that the size_t
1500 arithmetic in allocate_string_data would overflow while it is
1501 calculating a value to be passed to malloc. */
1502 static ptrdiff_t const STRING_BYTES_MAX
=
1503 min (STRING_BYTES_BOUND
,
1504 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1506 - offsetof (struct sblock
, data
)
1507 - SDATA_DATA_OFFSET
)
1508 & ~(sizeof (EMACS_INT
) - 1)));
1510 /* Initialize string allocation. Called from init_alloc_once. */
1515 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1516 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1520 #ifdef GC_CHECK_STRING_BYTES
1522 static int check_string_bytes_count
;
1524 /* Like STRING_BYTES, but with debugging check. Can be
1525 called during GC, so pay attention to the mark bit. */
1528 string_bytes (struct Lisp_String
*s
)
1531 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1533 if (!PURE_POINTER_P (s
)
1535 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1540 /* Check validity of Lisp strings' string_bytes member in B. */
1543 check_sblock (struct sblock
*b
)
1545 sdata
*from
, *end
, *from_end
;
1549 for (from
= b
->data
; from
< end
; from
= from_end
)
1551 /* Compute the next FROM here because copying below may
1552 overwrite data we need to compute it. */
1555 /* Check that the string size recorded in the string is the
1556 same as the one recorded in the sdata structure. */
1557 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1558 : SDATA_NBYTES (from
));
1559 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1564 /* Check validity of Lisp strings' string_bytes member. ALL_P
1565 means check all strings, otherwise check only most
1566 recently allocated strings. Used for hunting a bug. */
1569 check_string_bytes (bool all_p
)
1575 for (b
= large_sblocks
; b
; b
= b
->next
)
1577 struct Lisp_String
*s
= b
->data
[0].string
;
1582 for (b
= oldest_sblock
; b
; b
= b
->next
)
1585 else if (current_sblock
)
1586 check_sblock (current_sblock
);
1589 #else /* not GC_CHECK_STRING_BYTES */
1591 #define check_string_bytes(all) ((void) 0)
1593 #endif /* GC_CHECK_STRING_BYTES */
1595 #ifdef GC_CHECK_STRING_FREE_LIST
1597 /* Walk through the string free list looking for bogus next pointers.
1598 This may catch buffer overrun from a previous string. */
1601 check_string_free_list (void)
1603 struct Lisp_String
*s
;
1605 /* Pop a Lisp_String off the free-list. */
1606 s
= string_free_list
;
1609 if ((uintptr_t) s
< 1024)
1611 s
= NEXT_FREE_LISP_STRING (s
);
1615 #define check_string_free_list()
1618 /* Return a new Lisp_String. */
1620 static struct Lisp_String
*
1621 allocate_string (void)
1623 struct Lisp_String
*s
;
1625 /* If the free-list is empty, allocate a new string_block, and
1626 add all the Lisp_Strings in it to the free-list. */
1627 if (string_free_list
== NULL
)
1629 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1632 b
->next
= string_blocks
;
1635 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1638 /* Every string on a free list should have NULL data pointer. */
1640 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1641 string_free_list
= s
;
1644 total_free_strings
+= STRING_BLOCK_SIZE
;
1647 check_string_free_list ();
1649 /* Pop a Lisp_String off the free-list. */
1650 s
= string_free_list
;
1651 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1653 --total_free_strings
;
1656 consing_since_gc
+= sizeof *s
;
1658 #ifdef GC_CHECK_STRING_BYTES
1659 if (!noninteractive
)
1661 if (++check_string_bytes_count
== 200)
1663 check_string_bytes_count
= 0;
1664 check_string_bytes (1);
1667 check_string_bytes (0);
1669 #endif /* GC_CHECK_STRING_BYTES */
1675 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1676 plus a NUL byte at the end. Allocate an sdata structure for S, and
1677 set S->data to its `u.data' member. Store a NUL byte at the end of
1678 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1679 S->data if it was initially non-null. */
1682 allocate_string_data (struct Lisp_String
*s
,
1683 EMACS_INT nchars
, EMACS_INT nbytes
)
1685 sdata
*data
, *old_data
;
1687 ptrdiff_t needed
, old_nbytes
;
1689 if (STRING_BYTES_MAX
< nbytes
)
1692 /* Determine the number of bytes needed to store NBYTES bytes
1694 needed
= SDATA_SIZE (nbytes
);
1697 old_data
= SDATA_OF_STRING (s
);
1698 old_nbytes
= STRING_BYTES (s
);
1703 if (nbytes
> LARGE_STRING_BYTES
)
1705 size_t size
= offsetof (struct sblock
, data
) + needed
;
1707 #ifdef DOUG_LEA_MALLOC
1708 if (!mmap_lisp_allowed_p ())
1709 mallopt (M_MMAP_MAX
, 0);
1712 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1714 #ifdef DOUG_LEA_MALLOC
1715 if (!mmap_lisp_allowed_p ())
1716 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1719 b
->next_free
= b
->data
;
1720 b
->data
[0].string
= NULL
;
1721 b
->next
= large_sblocks
;
1724 else if (current_sblock
== NULL
1725 || (((char *) current_sblock
+ SBLOCK_SIZE
1726 - (char *) current_sblock
->next_free
)
1727 < (needed
+ GC_STRING_EXTRA
)))
1729 /* Not enough room in the current sblock. */
1730 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1731 b
->next_free
= b
->data
;
1732 b
->data
[0].string
= NULL
;
1736 current_sblock
->next
= b
;
1744 data
= b
->next_free
;
1745 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1748 s
->data
= SDATA_DATA (data
);
1749 #ifdef GC_CHECK_STRING_BYTES
1750 SDATA_NBYTES (data
) = nbytes
;
1753 s
->size_byte
= nbytes
;
1754 s
->data
[nbytes
] = '\0';
1755 #ifdef GC_CHECK_STRING_OVERRUN
1756 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1757 GC_STRING_OVERRUN_COOKIE_SIZE
);
1760 /* Note that Faset may call to this function when S has already data
1761 assigned. In this case, mark data as free by setting it's string
1762 back-pointer to null, and record the size of the data in it. */
1765 SDATA_NBYTES (old_data
) = old_nbytes
;
1766 old_data
->string
= NULL
;
1769 consing_since_gc
+= needed
;
1773 /* Sweep and compact strings. */
1775 NO_INLINE
/* For better stack traces */
1777 sweep_strings (void)
1779 struct string_block
*b
, *next
;
1780 struct string_block
*live_blocks
= NULL
;
1782 string_free_list
= NULL
;
1783 total_strings
= total_free_strings
= 0;
1784 total_string_bytes
= 0;
1786 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1787 for (b
= string_blocks
; b
; b
= next
)
1790 struct Lisp_String
*free_list_before
= string_free_list
;
1794 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1796 struct Lisp_String
*s
= b
->strings
+ i
;
1800 /* String was not on free-list before. */
1801 if (STRING_MARKED_P (s
))
1803 /* String is live; unmark it and its intervals. */
1806 /* Do not use string_(set|get)_intervals here. */
1807 s
->intervals
= balance_intervals (s
->intervals
);
1810 total_string_bytes
+= STRING_BYTES (s
);
1814 /* String is dead. Put it on the free-list. */
1815 sdata
*data
= SDATA_OF_STRING (s
);
1817 /* Save the size of S in its sdata so that we know
1818 how large that is. Reset the sdata's string
1819 back-pointer so that we know it's free. */
1820 #ifdef GC_CHECK_STRING_BYTES
1821 if (string_bytes (s
) != SDATA_NBYTES (data
))
1824 data
->n
.nbytes
= STRING_BYTES (s
);
1826 data
->string
= NULL
;
1828 /* Reset the strings's `data' member so that we
1832 /* Put the string on the free-list. */
1833 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1834 string_free_list
= s
;
1840 /* S was on the free-list before. Put it there again. */
1841 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1842 string_free_list
= s
;
1847 /* Free blocks that contain free Lisp_Strings only, except
1848 the first two of them. */
1849 if (nfree
== STRING_BLOCK_SIZE
1850 && total_free_strings
> STRING_BLOCK_SIZE
)
1853 string_free_list
= free_list_before
;
1857 total_free_strings
+= nfree
;
1858 b
->next
= live_blocks
;
1863 check_string_free_list ();
1865 string_blocks
= live_blocks
;
1866 free_large_strings ();
1867 compact_small_strings ();
1869 check_string_free_list ();
1873 /* Free dead large strings. */
1876 free_large_strings (void)
1878 struct sblock
*b
, *next
;
1879 struct sblock
*live_blocks
= NULL
;
1881 for (b
= large_sblocks
; b
; b
= next
)
1885 if (b
->data
[0].string
== NULL
)
1889 b
->next
= live_blocks
;
1894 large_sblocks
= live_blocks
;
1898 /* Compact data of small strings. Free sblocks that don't contain
1899 data of live strings after compaction. */
1902 compact_small_strings (void)
1904 struct sblock
*b
, *tb
, *next
;
1905 sdata
*from
, *to
, *end
, *tb_end
;
1906 sdata
*to_end
, *from_end
;
1908 /* TB is the sblock we copy to, TO is the sdata within TB we copy
1909 to, and TB_END is the end of TB. */
1911 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1914 /* Step through the blocks from the oldest to the youngest. We
1915 expect that old blocks will stabilize over time, so that less
1916 copying will happen this way. */
1917 for (b
= oldest_sblock
; b
; b
= b
->next
)
1920 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
1922 for (from
= b
->data
; from
< end
; from
= from_end
)
1924 /* Compute the next FROM here because copying below may
1925 overwrite data we need to compute it. */
1927 struct Lisp_String
*s
= from
->string
;
1929 #ifdef GC_CHECK_STRING_BYTES
1930 /* Check that the string size recorded in the string is the
1931 same as the one recorded in the sdata structure. */
1932 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
1934 #endif /* GC_CHECK_STRING_BYTES */
1936 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
1937 eassert (nbytes
<= LARGE_STRING_BYTES
);
1939 nbytes
= SDATA_SIZE (nbytes
);
1940 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1942 #ifdef GC_CHECK_STRING_OVERRUN
1943 if (memcmp (string_overrun_cookie
,
1944 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
1945 GC_STRING_OVERRUN_COOKIE_SIZE
))
1949 /* Non-NULL S means it's alive. Copy its data. */
1952 /* If TB is full, proceed with the next sblock. */
1953 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
1954 if (to_end
> tb_end
)
1958 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1960 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
1963 /* Copy, and update the string's `data' pointer. */
1966 eassert (tb
!= b
|| to
< from
);
1967 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
1968 to
->string
->data
= SDATA_DATA (to
);
1971 /* Advance past the sdata we copied to. */
1977 /* The rest of the sblocks following TB don't contain live data, so
1978 we can free them. */
1979 for (b
= tb
->next
; b
; b
= next
)
1987 current_sblock
= tb
;
1991 string_overflow (void)
1993 error ("Maximum string size exceeded");
1996 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
1997 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
1998 LENGTH must be an integer.
1999 INIT must be an integer that represents a character. */)
2000 (Lisp_Object length
, Lisp_Object init
)
2002 register Lisp_Object val
;
2006 CHECK_NATNUM (length
);
2007 CHECK_CHARACTER (init
);
2009 c
= XFASTINT (init
);
2010 if (ASCII_CHAR_P (c
))
2012 nbytes
= XINT (length
);
2013 val
= make_uninit_string (nbytes
);
2014 memset (SDATA (val
), c
, nbytes
);
2015 SDATA (val
)[nbytes
] = 0;
2019 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2020 ptrdiff_t len
= CHAR_STRING (c
, str
);
2021 EMACS_INT string_len
= XINT (length
);
2022 unsigned char *p
, *beg
, *end
;
2024 if (string_len
> STRING_BYTES_MAX
/ len
)
2026 nbytes
= len
* string_len
;
2027 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2028 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2030 /* First time we just copy `str' to the data of `val'. */
2032 memcpy (p
, str
, len
);
2035 /* Next time we copy largest possible chunk from
2036 initialized to uninitialized part of `val'. */
2037 len
= min (p
- beg
, end
- p
);
2038 memcpy (p
, beg
, len
);
2047 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2051 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2053 EMACS_INT nbits
= bool_vector_size (a
);
2056 unsigned char *data
= bool_vector_uchar_data (a
);
2057 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2058 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2059 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2060 memset (data
, pattern
, nbytes
- 1);
2061 data
[nbytes
- 1] = pattern
& last_mask
;
2066 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2069 make_uninit_bool_vector (EMACS_INT nbits
)
2072 EMACS_INT words
= bool_vector_words (nbits
);
2073 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2074 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2077 struct Lisp_Bool_Vector
*p
2078 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2079 XSETVECTOR (val
, p
);
2080 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2083 /* Clear padding at the end. */
2085 p
->data
[words
- 1] = 0;
2090 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2091 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2092 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2093 (Lisp_Object length
, Lisp_Object init
)
2097 CHECK_NATNUM (length
);
2098 val
= make_uninit_bool_vector (XFASTINT (length
));
2099 return bool_vector_fill (val
, init
);
2102 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2103 doc
: /* Return a new bool-vector with specified arguments as elements.
2104 Any number of arguments, even zero arguments, are allowed.
2105 usage: (bool-vector &rest OBJECTS) */)
2106 (ptrdiff_t nargs
, Lisp_Object
*args
)
2111 vector
= make_uninit_bool_vector (nargs
);
2112 for (i
= 0; i
< nargs
; i
++)
2113 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2118 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2119 of characters from the contents. This string may be unibyte or
2120 multibyte, depending on the contents. */
2123 make_string (const char *contents
, ptrdiff_t nbytes
)
2125 register Lisp_Object val
;
2126 ptrdiff_t nchars
, multibyte_nbytes
;
2128 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2129 &nchars
, &multibyte_nbytes
);
2130 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2131 /* CONTENTS contains no multibyte sequences or contains an invalid
2132 multibyte sequence. We must make unibyte string. */
2133 val
= make_unibyte_string (contents
, nbytes
);
2135 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2140 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2143 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2145 register Lisp_Object val
;
2146 val
= make_uninit_string (length
);
2147 memcpy (SDATA (val
), contents
, length
);
2152 /* Make a multibyte string from NCHARS characters occupying NBYTES
2153 bytes at CONTENTS. */
2156 make_multibyte_string (const char *contents
,
2157 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2159 register Lisp_Object val
;
2160 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2161 memcpy (SDATA (val
), contents
, nbytes
);
2166 /* Make a string from NCHARS characters occupying NBYTES bytes at
2167 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2170 make_string_from_bytes (const char *contents
,
2171 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2173 register Lisp_Object val
;
2174 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2175 memcpy (SDATA (val
), contents
, nbytes
);
2176 if (SBYTES (val
) == SCHARS (val
))
2177 STRING_SET_UNIBYTE (val
);
2182 /* Make a string from NCHARS characters occupying NBYTES bytes at
2183 CONTENTS. The argument MULTIBYTE controls whether to label the
2184 string as multibyte. If NCHARS is negative, it counts the number of
2185 characters by itself. */
2188 make_specified_string (const char *contents
,
2189 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2196 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2201 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2202 memcpy (SDATA (val
), contents
, nbytes
);
2204 STRING_SET_UNIBYTE (val
);
2209 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2210 occupying LENGTH bytes. */
2213 make_uninit_string (EMACS_INT length
)
2218 return empty_unibyte_string
;
2219 val
= make_uninit_multibyte_string (length
, length
);
2220 STRING_SET_UNIBYTE (val
);
2225 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2226 which occupy NBYTES bytes. */
2229 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2232 struct Lisp_String
*s
;
2237 return empty_multibyte_string
;
2239 s
= allocate_string ();
2240 s
->intervals
= NULL
;
2241 allocate_string_data (s
, nchars
, nbytes
);
2242 XSETSTRING (string
, s
);
2243 string_chars_consed
+= nbytes
;
2247 /* Print arguments to BUF according to a FORMAT, then return
2248 a Lisp_String initialized with the data from BUF. */
2251 make_formatted_string (char *buf
, const char *format
, ...)
2256 va_start (ap
, format
);
2257 length
= vsprintf (buf
, format
, ap
);
2259 return make_string (buf
, length
);
2263 /***********************************************************************
2265 ***********************************************************************/
2267 /* We store float cells inside of float_blocks, allocating a new
2268 float_block with malloc whenever necessary. Float cells reclaimed
2269 by GC are put on a free list to be reallocated before allocating
2270 any new float cells from the latest float_block. */
2272 #define FLOAT_BLOCK_SIZE \
2273 (((BLOCK_BYTES - sizeof (struct float_block *) \
2274 /* The compiler might add padding at the end. */ \
2275 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2276 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2278 #define GETMARKBIT(block,n) \
2279 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2280 >> ((n) % BITS_PER_BITS_WORD)) \
2283 #define SETMARKBIT(block,n) \
2284 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2285 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2287 #define UNSETMARKBIT(block,n) \
2288 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2289 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2291 #define FLOAT_BLOCK(fptr) \
2292 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2294 #define FLOAT_INDEX(fptr) \
2295 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2299 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2300 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2301 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2302 struct float_block
*next
;
2305 #define FLOAT_MARKED_P(fptr) \
2306 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2308 #define FLOAT_MARK(fptr) \
2309 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2311 #define FLOAT_UNMARK(fptr) \
2312 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2314 /* Current float_block. */
2316 static struct float_block
*float_block
;
2318 /* Index of first unused Lisp_Float in the current float_block. */
2320 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2322 /* Free-list of Lisp_Floats. */
2324 static struct Lisp_Float
*float_free_list
;
2326 /* Return a new float object with value FLOAT_VALUE. */
2329 make_float (double float_value
)
2331 register Lisp_Object val
;
2333 if (float_free_list
)
2335 /* We use the data field for chaining the free list
2336 so that we won't use the same field that has the mark bit. */
2337 XSETFLOAT (val
, float_free_list
);
2338 float_free_list
= float_free_list
->u
.chain
;
2342 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2344 struct float_block
*new
2345 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2346 new->next
= float_block
;
2347 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2349 float_block_index
= 0;
2350 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2352 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2353 float_block_index
++;
2356 XFLOAT_INIT (val
, float_value
);
2357 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2358 consing_since_gc
+= sizeof (struct Lisp_Float
);
2360 total_free_floats
--;
2366 /***********************************************************************
2368 ***********************************************************************/
2370 /* We store cons cells inside of cons_blocks, allocating a new
2371 cons_block with malloc whenever necessary. Cons cells reclaimed by
2372 GC are put on a free list to be reallocated before allocating
2373 any new cons cells from the latest cons_block. */
2375 #define CONS_BLOCK_SIZE \
2376 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2377 /* The compiler might add padding at the end. */ \
2378 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2379 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2381 #define CONS_BLOCK(fptr) \
2382 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2384 #define CONS_INDEX(fptr) \
2385 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2389 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2390 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2391 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2392 struct cons_block
*next
;
2395 #define CONS_MARKED_P(fptr) \
2396 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2398 #define CONS_MARK(fptr) \
2399 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2401 #define CONS_UNMARK(fptr) \
2402 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2404 /* Current cons_block. */
2406 static struct cons_block
*cons_block
;
2408 /* Index of first unused Lisp_Cons in the current block. */
2410 static int cons_block_index
= CONS_BLOCK_SIZE
;
2412 /* Free-list of Lisp_Cons structures. */
2414 static struct Lisp_Cons
*cons_free_list
;
2416 /* Explicitly free a cons cell by putting it on the free-list. */
2419 free_cons (struct Lisp_Cons
*ptr
)
2421 ptr
->u
.chain
= cons_free_list
;
2425 cons_free_list
= ptr
;
2426 consing_since_gc
-= sizeof *ptr
;
2427 total_free_conses
++;
2430 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2431 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2432 (Lisp_Object car
, Lisp_Object cdr
)
2434 register Lisp_Object val
;
2438 /* We use the cdr for chaining the free list
2439 so that we won't use the same field that has the mark bit. */
2440 XSETCONS (val
, cons_free_list
);
2441 cons_free_list
= cons_free_list
->u
.chain
;
2445 if (cons_block_index
== CONS_BLOCK_SIZE
)
2447 struct cons_block
*new
2448 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2449 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2450 new->next
= cons_block
;
2452 cons_block_index
= 0;
2453 total_free_conses
+= CONS_BLOCK_SIZE
;
2455 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2461 eassert (!CONS_MARKED_P (XCONS (val
)));
2462 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2463 total_free_conses
--;
2464 cons_cells_consed
++;
2468 #ifdef GC_CHECK_CONS_LIST
2469 /* Get an error now if there's any junk in the cons free list. */
2471 check_cons_list (void)
2473 struct Lisp_Cons
*tail
= cons_free_list
;
2476 tail
= tail
->u
.chain
;
2480 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2483 list1 (Lisp_Object arg1
)
2485 return Fcons (arg1
, Qnil
);
2489 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2491 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2496 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2498 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2503 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2505 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2510 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2512 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2513 Fcons (arg5
, Qnil
)))));
2516 /* Make a list of COUNT Lisp_Objects, where ARG is the
2517 first one. Allocate conses from pure space if TYPE
2518 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2521 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2525 Lisp_Object val
, *objp
;
2527 /* Change to SAFE_ALLOCA if you hit this eassert. */
2528 eassert (count
<= MAX_ALLOCA
/ word_size
);
2530 objp
= alloca (count
* word_size
);
2533 for (i
= 1; i
< count
; i
++)
2534 objp
[i
] = va_arg (ap
, Lisp_Object
);
2537 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2539 if (type
== CONSTYPE_PURE
)
2540 val
= pure_cons (objp
[i
], val
);
2541 else if (type
== CONSTYPE_HEAP
)
2542 val
= Fcons (objp
[i
], val
);
2549 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2550 doc
: /* Return a newly created list with specified arguments as elements.
2551 Any number of arguments, even zero arguments, are allowed.
2552 usage: (list &rest OBJECTS) */)
2553 (ptrdiff_t nargs
, Lisp_Object
*args
)
2555 register Lisp_Object val
;
2561 val
= Fcons (args
[nargs
], val
);
2567 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2568 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2569 (register Lisp_Object length
, Lisp_Object init
)
2571 register Lisp_Object val
;
2572 register EMACS_INT size
;
2574 CHECK_NATNUM (length
);
2575 size
= XFASTINT (length
);
2580 val
= Fcons (init
, val
);
2585 val
= Fcons (init
, val
);
2590 val
= Fcons (init
, val
);
2595 val
= Fcons (init
, val
);
2600 val
= Fcons (init
, val
);
2615 /***********************************************************************
2617 ***********************************************************************/
2619 /* Sometimes a vector's contents are merely a pointer internally used
2620 in vector allocation code. On the rare platforms where a null
2621 pointer cannot be tagged, represent it with a Lisp 0.
2622 Usually you don't want to touch this. */
2624 static struct Lisp_Vector
*
2625 next_vector (struct Lisp_Vector
*v
)
2627 return XUNTAG (v
->contents
[0], 0);
2631 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2633 v
->contents
[0] = make_lisp_ptr (p
, 0);
2636 /* This value is balanced well enough to avoid too much internal overhead
2637 for the most common cases; it's not required to be a power of two, but
2638 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2640 #define VECTOR_BLOCK_SIZE 4096
2644 /* Alignment of struct Lisp_Vector objects. */
2645 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2646 USE_LSB_TAG
? GCALIGNMENT
: 1),
2648 /* Vector size requests are a multiple of this. */
2649 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2652 /* Verify assumptions described above. */
2653 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2654 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2656 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2657 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2658 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2659 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2661 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2663 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2665 /* Size of the minimal vector allocated from block. */
2667 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2669 /* Size of the largest vector allocated from block. */
2671 #define VBLOCK_BYTES_MAX \
2672 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2674 /* We maintain one free list for each possible block-allocated
2675 vector size, and this is the number of free lists we have. */
2677 #define VECTOR_MAX_FREE_LIST_INDEX \
2678 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2680 /* Common shortcut to advance vector pointer over a block data. */
2682 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2684 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2686 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2688 /* Common shortcut to setup vector on a free list. */
2690 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2692 (tmp) = ((nbytes - header_size) / word_size); \
2693 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2694 eassert ((nbytes) % roundup_size == 0); \
2695 (tmp) = VINDEX (nbytes); \
2696 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2697 set_next_vector (v, vector_free_lists[tmp]); \
2698 vector_free_lists[tmp] = (v); \
2699 total_free_vector_slots += (nbytes) / word_size; \
2702 /* This internal type is used to maintain the list of large vectors
2703 which are allocated at their own, e.g. outside of vector blocks.
2705 struct large_vector itself cannot contain a struct Lisp_Vector, as
2706 the latter contains a flexible array member and C99 does not allow
2707 such structs to be nested. Instead, each struct large_vector
2708 object LV is followed by a struct Lisp_Vector, which is at offset
2709 large_vector_offset from LV, and whose address is therefore
2710 large_vector_vec (&LV). */
2714 struct large_vector
*next
;
2719 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2722 static struct Lisp_Vector
*
2723 large_vector_vec (struct large_vector
*p
)
2725 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
2728 /* This internal type is used to maintain an underlying storage
2729 for small vectors. */
2733 char data
[VECTOR_BLOCK_BYTES
];
2734 struct vector_block
*next
;
2737 /* Chain of vector blocks. */
2739 static struct vector_block
*vector_blocks
;
2741 /* Vector free lists, where NTH item points to a chain of free
2742 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2744 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2746 /* Singly-linked list of large vectors. */
2748 static struct large_vector
*large_vectors
;
2750 /* The only vector with 0 slots, allocated from pure space. */
2752 Lisp_Object zero_vector
;
2754 /* Number of live vectors. */
2756 static EMACS_INT total_vectors
;
2758 /* Total size of live and free vectors, in Lisp_Object units. */
2760 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2762 /* Get a new vector block. */
2764 static struct vector_block
*
2765 allocate_vector_block (void)
2767 struct vector_block
*block
= xmalloc (sizeof *block
);
2769 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2770 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2771 MEM_TYPE_VECTOR_BLOCK
);
2774 block
->next
= vector_blocks
;
2775 vector_blocks
= block
;
2779 /* Called once to initialize vector allocation. */
2784 zero_vector
= make_pure_vector (0);
2787 /* Allocate vector from a vector block. */
2789 static struct Lisp_Vector
*
2790 allocate_vector_from_block (size_t nbytes
)
2792 struct Lisp_Vector
*vector
;
2793 struct vector_block
*block
;
2794 size_t index
, restbytes
;
2796 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2797 eassert (nbytes
% roundup_size
== 0);
2799 /* First, try to allocate from a free list
2800 containing vectors of the requested size. */
2801 index
= VINDEX (nbytes
);
2802 if (vector_free_lists
[index
])
2804 vector
= vector_free_lists
[index
];
2805 vector_free_lists
[index
] = next_vector (vector
);
2806 total_free_vector_slots
-= nbytes
/ word_size
;
2810 /* Next, check free lists containing larger vectors. Since
2811 we will split the result, we should have remaining space
2812 large enough to use for one-slot vector at least. */
2813 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
2814 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
2815 if (vector_free_lists
[index
])
2817 /* This vector is larger than requested. */
2818 vector
= vector_free_lists
[index
];
2819 vector_free_lists
[index
] = next_vector (vector
);
2820 total_free_vector_slots
-= nbytes
/ word_size
;
2822 /* Excess bytes are used for the smaller vector,
2823 which should be set on an appropriate free list. */
2824 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
2825 eassert (restbytes
% roundup_size
== 0);
2826 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2830 /* Finally, need a new vector block. */
2831 block
= allocate_vector_block ();
2833 /* New vector will be at the beginning of this block. */
2834 vector
= (struct Lisp_Vector
*) block
->data
;
2836 /* If the rest of space from this block is large enough
2837 for one-slot vector at least, set up it on a free list. */
2838 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
2839 if (restbytes
>= VBLOCK_BYTES_MIN
)
2841 eassert (restbytes
% roundup_size
== 0);
2842 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2847 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
2849 #define VECTOR_IN_BLOCK(vector, block) \
2850 ((char *) (vector) <= (block)->data \
2851 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
2853 /* Return the memory footprint of V in bytes. */
2856 vector_nbytes (struct Lisp_Vector
*v
)
2858 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
2861 if (size
& PSEUDOVECTOR_FLAG
)
2863 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
2865 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
2866 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
2867 * sizeof (bits_word
));
2868 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
2869 verify (header_size
<= bool_header_size
);
2870 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
2873 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
2874 + ((size
& PSEUDOVECTOR_REST_MASK
)
2875 >> PSEUDOVECTOR_SIZE_BITS
));
2879 return vroundup (header_size
+ word_size
* nwords
);
2882 /* Release extra resources still in use by VECTOR, which may be any
2883 vector-like object. For now, this is used just to free data in
2887 cleanup_vector (struct Lisp_Vector
*vector
)
2889 detect_suspicious_free (vector
);
2890 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
2891 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
2892 == FONT_OBJECT_MAX
))
2894 struct font_driver
*drv
= ((struct font
*) vector
)->driver
;
2896 /* The font driver might sometimes be NULL, e.g. if Emacs was
2897 interrupted before it had time to set it up. */
2900 /* Attempt to catch subtle bugs like Bug#16140. */
2901 eassert (valid_font_driver (drv
));
2902 drv
->close ((struct font
*) vector
);
2907 /* Reclaim space used by unmarked vectors. */
2909 NO_INLINE
/* For better stack traces */
2911 sweep_vectors (void)
2913 struct vector_block
*block
, **bprev
= &vector_blocks
;
2914 struct large_vector
*lv
, **lvprev
= &large_vectors
;
2915 struct Lisp_Vector
*vector
, *next
;
2917 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
2918 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
2920 /* Looking through vector blocks. */
2922 for (block
= vector_blocks
; block
; block
= *bprev
)
2924 bool free_this_block
= 0;
2927 for (vector
= (struct Lisp_Vector
*) block
->data
;
2928 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
2930 if (VECTOR_MARKED_P (vector
))
2932 VECTOR_UNMARK (vector
);
2934 nbytes
= vector_nbytes (vector
);
2935 total_vector_slots
+= nbytes
/ word_size
;
2936 next
= ADVANCE (vector
, nbytes
);
2940 ptrdiff_t total_bytes
;
2942 cleanup_vector (vector
);
2943 nbytes
= vector_nbytes (vector
);
2944 total_bytes
= nbytes
;
2945 next
= ADVANCE (vector
, nbytes
);
2947 /* While NEXT is not marked, try to coalesce with VECTOR,
2948 thus making VECTOR of the largest possible size. */
2950 while (VECTOR_IN_BLOCK (next
, block
))
2952 if (VECTOR_MARKED_P (next
))
2954 cleanup_vector (next
);
2955 nbytes
= vector_nbytes (next
);
2956 total_bytes
+= nbytes
;
2957 next
= ADVANCE (next
, nbytes
);
2960 eassert (total_bytes
% roundup_size
== 0);
2962 if (vector
== (struct Lisp_Vector
*) block
->data
2963 && !VECTOR_IN_BLOCK (next
, block
))
2964 /* This block should be freed because all of its
2965 space was coalesced into the only free vector. */
2966 free_this_block
= 1;
2970 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
2975 if (free_this_block
)
2977 *bprev
= block
->next
;
2978 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2979 mem_delete (mem_find (block
->data
));
2984 bprev
= &block
->next
;
2987 /* Sweep large vectors. */
2989 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
2991 vector
= large_vector_vec (lv
);
2992 if (VECTOR_MARKED_P (vector
))
2994 VECTOR_UNMARK (vector
);
2996 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
2998 /* All non-bool pseudovectors are small enough to be allocated
2999 from vector blocks. This code should be redesigned if some
3000 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3001 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3002 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3006 += header_size
/ word_size
+ vector
->header
.size
;
3017 /* Value is a pointer to a newly allocated Lisp_Vector structure
3018 with room for LEN Lisp_Objects. */
3020 static struct Lisp_Vector
*
3021 allocate_vectorlike (ptrdiff_t len
)
3023 struct Lisp_Vector
*p
;
3025 #ifdef DOUG_LEA_MALLOC
3026 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3027 because mapped region contents are not preserved in
3029 mallopt (M_MMAP_MAX
, 0);
3033 p
= XVECTOR (zero_vector
);
3036 size_t nbytes
= header_size
+ len
* word_size
;
3038 #ifdef DOUG_LEA_MALLOC
3039 if (!mmap_lisp_allowed_p ())
3040 mallopt (M_MMAP_MAX
, 0);
3043 if (nbytes
<= VBLOCK_BYTES_MAX
)
3044 p
= allocate_vector_from_block (vroundup (nbytes
));
3047 struct large_vector
*lv
3048 = lisp_malloc ((large_vector_offset
+ header_size
3050 MEM_TYPE_VECTORLIKE
);
3051 lv
->next
= large_vectors
;
3053 p
= large_vector_vec (lv
);
3056 #ifdef DOUG_LEA_MALLOC
3057 if (!mmap_lisp_allowed_p ())
3058 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3061 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3064 consing_since_gc
+= nbytes
;
3065 vector_cells_consed
+= len
;
3072 /* Allocate a vector with LEN slots. */
3074 struct Lisp_Vector
*
3075 allocate_vector (EMACS_INT len
)
3077 struct Lisp_Vector
*v
;
3078 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3080 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3081 memory_full (SIZE_MAX
);
3082 v
= allocate_vectorlike (len
);
3083 v
->header
.size
= len
;
3088 /* Allocate other vector-like structures. */
3090 struct Lisp_Vector
*
3091 allocate_pseudovector (int memlen
, int lisplen
, enum pvec_type tag
)
3093 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3096 /* Catch bogus values. */
3097 eassert (tag
<= PVEC_FONT
);
3098 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3099 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3101 /* Only the first lisplen slots will be traced normally by the GC. */
3102 for (i
= 0; i
< lisplen
; ++i
)
3103 v
->contents
[i
] = Qnil
;
3105 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3110 allocate_buffer (void)
3112 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3114 BUFFER_PVEC_INIT (b
);
3115 /* Put B on the chain of all buffers including killed ones. */
3116 b
->next
= all_buffers
;
3118 /* Note that the rest fields of B are not initialized. */
3122 struct Lisp_Hash_Table
*
3123 allocate_hash_table (void)
3125 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3129 allocate_window (void)
3133 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3134 /* Users assumes that non-Lisp data is zeroed. */
3135 memset (&w
->current_matrix
, 0,
3136 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3141 allocate_terminal (void)
3145 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3146 /* Users assumes that non-Lisp data is zeroed. */
3147 memset (&t
->next_terminal
, 0,
3148 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3153 allocate_frame (void)
3157 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3158 /* Users assumes that non-Lisp data is zeroed. */
3159 memset (&f
->face_cache
, 0,
3160 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3164 struct Lisp_Process
*
3165 allocate_process (void)
3167 struct Lisp_Process
*p
;
3169 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3170 /* Users assumes that non-Lisp data is zeroed. */
3172 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3176 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3177 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3178 See also the function `vector'. */)
3179 (register Lisp_Object length
, Lisp_Object init
)
3182 register ptrdiff_t sizei
;
3183 register ptrdiff_t i
;
3184 register struct Lisp_Vector
*p
;
3186 CHECK_NATNUM (length
);
3188 p
= allocate_vector (XFASTINT (length
));
3189 sizei
= XFASTINT (length
);
3190 for (i
= 0; i
< sizei
; i
++)
3191 p
->contents
[i
] = init
;
3193 XSETVECTOR (vector
, p
);
3198 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3199 doc
: /* Return a newly created vector with specified arguments as elements.
3200 Any number of arguments, even zero arguments, are allowed.
3201 usage: (vector &rest OBJECTS) */)
3202 (ptrdiff_t nargs
, Lisp_Object
*args
)
3205 register Lisp_Object val
= make_uninit_vector (nargs
);
3206 register struct Lisp_Vector
*p
= XVECTOR (val
);
3208 for (i
= 0; i
< nargs
; i
++)
3209 p
->contents
[i
] = args
[i
];
3214 make_byte_code (struct Lisp_Vector
*v
)
3216 /* Don't allow the global zero_vector to become a byte code object. */
3217 eassert (0 < v
->header
.size
);
3219 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3220 && STRING_MULTIBYTE (v
->contents
[1]))
3221 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3222 earlier because they produced a raw 8-bit string for byte-code
3223 and now such a byte-code string is loaded as multibyte while
3224 raw 8-bit characters converted to multibyte form. Thus, now we
3225 must convert them back to the original unibyte form. */
3226 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3227 XSETPVECTYPE (v
, PVEC_COMPILED
);
3230 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3231 doc
: /* Create a byte-code object with specified arguments as elements.
3232 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3233 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3234 and (optional) INTERACTIVE-SPEC.
3235 The first four arguments are required; at most six have any
3237 The ARGLIST can be either like the one of `lambda', in which case the arguments
3238 will be dynamically bound before executing the byte code, or it can be an
3239 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3240 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3241 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3242 argument to catch the left-over arguments. If such an integer is used, the
3243 arguments will not be dynamically bound but will be instead pushed on the
3244 stack before executing the byte-code.
3245 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3246 (ptrdiff_t nargs
, Lisp_Object
*args
)
3249 register Lisp_Object val
= make_uninit_vector (nargs
);
3250 register struct Lisp_Vector
*p
= XVECTOR (val
);
3252 /* We used to purecopy everything here, if purify-flag was set. This worked
3253 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3254 dangerous, since make-byte-code is used during execution to build
3255 closures, so any closure built during the preload phase would end up
3256 copied into pure space, including its free variables, which is sometimes
3257 just wasteful and other times plainly wrong (e.g. those free vars may want
3260 for (i
= 0; i
< nargs
; i
++)
3261 p
->contents
[i
] = args
[i
];
3263 XSETCOMPILED (val
, p
);
3269 /***********************************************************************
3271 ***********************************************************************/
3273 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3274 of the required alignment if LSB tags are used. */
3276 union aligned_Lisp_Symbol
3278 struct Lisp_Symbol s
;
3280 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3285 /* Each symbol_block is just under 1020 bytes long, since malloc
3286 really allocates in units of powers of two and uses 4 bytes for its
3289 #define SYMBOL_BLOCK_SIZE \
3290 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3294 /* Place `symbols' first, to preserve alignment. */
3295 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3296 struct symbol_block
*next
;
3299 /* Current symbol block and index of first unused Lisp_Symbol
3302 static struct symbol_block
*symbol_block
;
3303 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3304 /* Pointer to the first symbol_block that contains pinned symbols.
3305 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3306 10K of which are pinned (and all but 250 of them are interned in obarray),
3307 whereas a "typical session" has in the order of 30K symbols.
3308 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3309 than 30K to find the 10K symbols we need to mark. */
3310 static struct symbol_block
*symbol_block_pinned
;
3312 /* List of free symbols. */
3314 static struct Lisp_Symbol
*symbol_free_list
;
3317 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3319 XSYMBOL (sym
)->name
= name
;
3322 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3323 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3324 Its value is void, and its function definition and property list are nil. */)
3327 register Lisp_Object val
;
3328 register struct Lisp_Symbol
*p
;
3330 CHECK_STRING (name
);
3332 if (symbol_free_list
)
3334 XSETSYMBOL (val
, symbol_free_list
);
3335 symbol_free_list
= symbol_free_list
->next
;
3339 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3341 struct symbol_block
*new
3342 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3343 new->next
= symbol_block
;
3345 symbol_block_index
= 0;
3346 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3348 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3349 symbol_block_index
++;
3353 set_symbol_name (val
, name
);
3354 set_symbol_plist (val
, Qnil
);
3355 p
->redirect
= SYMBOL_PLAINVAL
;
3356 SET_SYMBOL_VAL (p
, Qunbound
);
3357 set_symbol_function (val
, Qnil
);
3358 set_symbol_next (val
, NULL
);
3359 p
->gcmarkbit
= false;
3360 p
->interned
= SYMBOL_UNINTERNED
;
3362 p
->declared_special
= false;
3364 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3366 total_free_symbols
--;
3372 /***********************************************************************
3373 Marker (Misc) Allocation
3374 ***********************************************************************/
3376 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3377 the required alignment when LSB tags are used. */
3379 union aligned_Lisp_Misc
3383 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3388 /* Allocation of markers and other objects that share that structure.
3389 Works like allocation of conses. */
3391 #define MARKER_BLOCK_SIZE \
3392 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3396 /* Place `markers' first, to preserve alignment. */
3397 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3398 struct marker_block
*next
;
3401 static struct marker_block
*marker_block
;
3402 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3404 static union Lisp_Misc
*marker_free_list
;
3406 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3409 allocate_misc (enum Lisp_Misc_Type type
)
3413 if (marker_free_list
)
3415 XSETMISC (val
, marker_free_list
);
3416 marker_free_list
= marker_free_list
->u_free
.chain
;
3420 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3422 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3423 new->next
= marker_block
;
3425 marker_block_index
= 0;
3426 total_free_markers
+= MARKER_BLOCK_SIZE
;
3428 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3429 marker_block_index
++;
3432 --total_free_markers
;
3433 consing_since_gc
+= sizeof (union Lisp_Misc
);
3434 misc_objects_consed
++;
3435 XMISCANY (val
)->type
= type
;
3436 XMISCANY (val
)->gcmarkbit
= 0;
3440 /* Free a Lisp_Misc object. */
3443 free_misc (Lisp_Object misc
)
3445 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3446 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3447 marker_free_list
= XMISC (misc
);
3448 consing_since_gc
-= sizeof (union Lisp_Misc
);
3449 total_free_markers
++;
3452 /* Verify properties of Lisp_Save_Value's representation
3453 that are assumed here and elsewhere. */
3455 verify (SAVE_UNUSED
== 0);
3456 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3460 /* Return Lisp_Save_Value objects for the various combinations
3461 that callers need. */
3464 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3466 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3467 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3468 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3469 p
->data
[0].integer
= a
;
3470 p
->data
[1].integer
= b
;
3471 p
->data
[2].integer
= c
;
3476 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3479 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3480 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3481 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3482 p
->data
[0].object
= a
;
3483 p
->data
[1].object
= b
;
3484 p
->data
[2].object
= c
;
3485 p
->data
[3].object
= d
;
3490 make_save_ptr (void *a
)
3492 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3493 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3494 p
->save_type
= SAVE_POINTER
;
3495 p
->data
[0].pointer
= a
;
3500 make_save_ptr_int (void *a
, ptrdiff_t b
)
3502 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3503 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3504 p
->save_type
= SAVE_TYPE_PTR_INT
;
3505 p
->data
[0].pointer
= a
;
3506 p
->data
[1].integer
= b
;
3510 #if ! (defined USE_X_TOOLKIT || defined USE_GTK)
3512 make_save_ptr_ptr (void *a
, void *b
)
3514 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3515 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3516 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3517 p
->data
[0].pointer
= a
;
3518 p
->data
[1].pointer
= b
;
3524 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3526 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3527 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3528 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3529 p
->data
[0].funcpointer
= a
;
3530 p
->data
[1].pointer
= b
;
3531 p
->data
[2].object
= c
;
3535 /* Return a Lisp_Save_Value object that represents an array A
3536 of N Lisp objects. */
3539 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3541 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3542 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3543 p
->save_type
= SAVE_TYPE_MEMORY
;
3544 p
->data
[0].pointer
= a
;
3545 p
->data
[1].integer
= n
;
3549 /* Free a Lisp_Save_Value object. Do not use this function
3550 if SAVE contains pointer other than returned by xmalloc. */
3553 free_save_value (Lisp_Object save
)
3555 xfree (XSAVE_POINTER (save
, 0));
3559 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3562 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3564 register Lisp_Object overlay
;
3566 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3567 OVERLAY_START (overlay
) = start
;
3568 OVERLAY_END (overlay
) = end
;
3569 set_overlay_plist (overlay
, plist
);
3570 XOVERLAY (overlay
)->next
= NULL
;
3574 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3575 doc
: /* Return a newly allocated marker which does not point at any place. */)
3578 register Lisp_Object val
;
3579 register struct Lisp_Marker
*p
;
3581 val
= allocate_misc (Lisp_Misc_Marker
);
3587 p
->insertion_type
= 0;
3588 p
->need_adjustment
= 0;
3592 /* Return a newly allocated marker which points into BUF
3593 at character position CHARPOS and byte position BYTEPOS. */
3596 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3599 struct Lisp_Marker
*m
;
3601 /* No dead buffers here. */
3602 eassert (BUFFER_LIVE_P (buf
));
3604 /* Every character is at least one byte. */
3605 eassert (charpos
<= bytepos
);
3607 obj
= allocate_misc (Lisp_Misc_Marker
);
3610 m
->charpos
= charpos
;
3611 m
->bytepos
= bytepos
;
3612 m
->insertion_type
= 0;
3613 m
->need_adjustment
= 0;
3614 m
->next
= BUF_MARKERS (buf
);
3615 BUF_MARKERS (buf
) = m
;
3619 /* Put MARKER back on the free list after using it temporarily. */
3622 free_marker (Lisp_Object marker
)
3624 unchain_marker (XMARKER (marker
));
3629 /* Return a newly created vector or string with specified arguments as
3630 elements. If all the arguments are characters that can fit
3631 in a string of events, make a string; otherwise, make a vector.
3633 Any number of arguments, even zero arguments, are allowed. */
3636 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3640 for (i
= 0; i
< nargs
; i
++)
3641 /* The things that fit in a string
3642 are characters that are in 0...127,
3643 after discarding the meta bit and all the bits above it. */
3644 if (!INTEGERP (args
[i
])
3645 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3646 return Fvector (nargs
, args
);
3648 /* Since the loop exited, we know that all the things in it are
3649 characters, so we can make a string. */
3653 result
= Fmake_string (make_number (nargs
), make_number (0));
3654 for (i
= 0; i
< nargs
; i
++)
3656 SSET (result
, i
, XINT (args
[i
]));
3657 /* Move the meta bit to the right place for a string char. */
3658 if (XINT (args
[i
]) & CHAR_META
)
3659 SSET (result
, i
, SREF (result
, i
) | 0x80);
3668 /************************************************************************
3669 Memory Full Handling
3670 ************************************************************************/
3673 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3674 there may have been size_t overflow so that malloc was never
3675 called, or perhaps malloc was invoked successfully but the
3676 resulting pointer had problems fitting into a tagged EMACS_INT. In
3677 either case this counts as memory being full even though malloc did
3681 memory_full (size_t nbytes
)
3683 /* Do not go into hysterics merely because a large request failed. */
3684 bool enough_free_memory
= 0;
3685 if (SPARE_MEMORY
< nbytes
)
3689 p
= malloc (SPARE_MEMORY
);
3693 enough_free_memory
= 1;
3697 if (! enough_free_memory
)
3703 memory_full_cons_threshold
= sizeof (struct cons_block
);
3705 /* The first time we get here, free the spare memory. */
3706 for (i
= 0; i
< ARRAYELTS (spare_memory
); i
++)
3707 if (spare_memory
[i
])
3710 free (spare_memory
[i
]);
3711 else if (i
>= 1 && i
<= 4)
3712 lisp_align_free (spare_memory
[i
]);
3714 lisp_free (spare_memory
[i
]);
3715 spare_memory
[i
] = 0;
3719 /* This used to call error, but if we've run out of memory, we could
3720 get infinite recursion trying to build the string. */
3721 xsignal (Qnil
, Vmemory_signal_data
);
3724 /* If we released our reserve (due to running out of memory),
3725 and we have a fair amount free once again,
3726 try to set aside another reserve in case we run out once more.
3728 This is called when a relocatable block is freed in ralloc.c,
3729 and also directly from this file, in case we're not using ralloc.c. */
3732 refill_memory_reserve (void)
3734 #ifndef SYSTEM_MALLOC
3735 if (spare_memory
[0] == 0)
3736 spare_memory
[0] = malloc (SPARE_MEMORY
);
3737 if (spare_memory
[1] == 0)
3738 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3740 if (spare_memory
[2] == 0)
3741 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3743 if (spare_memory
[3] == 0)
3744 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3746 if (spare_memory
[4] == 0)
3747 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3749 if (spare_memory
[5] == 0)
3750 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3752 if (spare_memory
[6] == 0)
3753 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3755 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3756 Vmemory_full
= Qnil
;
3760 /************************************************************************
3762 ************************************************************************/
3764 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3766 /* Conservative C stack marking requires a method to identify possibly
3767 live Lisp objects given a pointer value. We do this by keeping
3768 track of blocks of Lisp data that are allocated in a red-black tree
3769 (see also the comment of mem_node which is the type of nodes in
3770 that tree). Function lisp_malloc adds information for an allocated
3771 block to the red-black tree with calls to mem_insert, and function
3772 lisp_free removes it with mem_delete. Functions live_string_p etc
3773 call mem_find to lookup information about a given pointer in the
3774 tree, and use that to determine if the pointer points to a Lisp
3777 /* Initialize this part of alloc.c. */
3782 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3783 mem_z
.parent
= NULL
;
3784 mem_z
.color
= MEM_BLACK
;
3785 mem_z
.start
= mem_z
.end
= NULL
;
3790 /* Value is a pointer to the mem_node containing START. Value is
3791 MEM_NIL if there is no node in the tree containing START. */
3793 static struct mem_node
*
3794 mem_find (void *start
)
3798 if (start
< min_heap_address
|| start
> max_heap_address
)
3801 /* Make the search always successful to speed up the loop below. */
3802 mem_z
.start
= start
;
3803 mem_z
.end
= (char *) start
+ 1;
3806 while (start
< p
->start
|| start
>= p
->end
)
3807 p
= start
< p
->start
? p
->left
: p
->right
;
3812 /* Insert a new node into the tree for a block of memory with start
3813 address START, end address END, and type TYPE. Value is a
3814 pointer to the node that was inserted. */
3816 static struct mem_node
*
3817 mem_insert (void *start
, void *end
, enum mem_type type
)
3819 struct mem_node
*c
, *parent
, *x
;
3821 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3822 min_heap_address
= start
;
3823 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3824 max_heap_address
= end
;
3826 /* See where in the tree a node for START belongs. In this
3827 particular application, it shouldn't happen that a node is already
3828 present. For debugging purposes, let's check that. */
3832 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3834 while (c
!= MEM_NIL
)
3836 if (start
>= c
->start
&& start
< c
->end
)
3839 c
= start
< c
->start
? c
->left
: c
->right
;
3842 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3844 while (c
!= MEM_NIL
)
3847 c
= start
< c
->start
? c
->left
: c
->right
;
3850 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3852 /* Create a new node. */
3853 #ifdef GC_MALLOC_CHECK
3854 x
= malloc (sizeof *x
);
3858 x
= xmalloc (sizeof *x
);
3864 x
->left
= x
->right
= MEM_NIL
;
3867 /* Insert it as child of PARENT or install it as root. */
3870 if (start
< parent
->start
)
3878 /* Re-establish red-black tree properties. */
3879 mem_insert_fixup (x
);
3885 /* Re-establish the red-black properties of the tree, and thereby
3886 balance the tree, after node X has been inserted; X is always red. */
3889 mem_insert_fixup (struct mem_node
*x
)
3891 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3893 /* X is red and its parent is red. This is a violation of
3894 red-black tree property #3. */
3896 if (x
->parent
== x
->parent
->parent
->left
)
3898 /* We're on the left side of our grandparent, and Y is our
3900 struct mem_node
*y
= x
->parent
->parent
->right
;
3902 if (y
->color
== MEM_RED
)
3904 /* Uncle and parent are red but should be black because
3905 X is red. Change the colors accordingly and proceed
3906 with the grandparent. */
3907 x
->parent
->color
= MEM_BLACK
;
3908 y
->color
= MEM_BLACK
;
3909 x
->parent
->parent
->color
= MEM_RED
;
3910 x
= x
->parent
->parent
;
3914 /* Parent and uncle have different colors; parent is
3915 red, uncle is black. */
3916 if (x
== x
->parent
->right
)
3919 mem_rotate_left (x
);
3922 x
->parent
->color
= MEM_BLACK
;
3923 x
->parent
->parent
->color
= MEM_RED
;
3924 mem_rotate_right (x
->parent
->parent
);
3929 /* This is the symmetrical case of above. */
3930 struct mem_node
*y
= x
->parent
->parent
->left
;
3932 if (y
->color
== MEM_RED
)
3934 x
->parent
->color
= MEM_BLACK
;
3935 y
->color
= MEM_BLACK
;
3936 x
->parent
->parent
->color
= MEM_RED
;
3937 x
= x
->parent
->parent
;
3941 if (x
== x
->parent
->left
)
3944 mem_rotate_right (x
);
3947 x
->parent
->color
= MEM_BLACK
;
3948 x
->parent
->parent
->color
= MEM_RED
;
3949 mem_rotate_left (x
->parent
->parent
);
3954 /* The root may have been changed to red due to the algorithm. Set
3955 it to black so that property #5 is satisfied. */
3956 mem_root
->color
= MEM_BLACK
;
3967 mem_rotate_left (struct mem_node
*x
)
3971 /* Turn y's left sub-tree into x's right sub-tree. */
3974 if (y
->left
!= MEM_NIL
)
3975 y
->left
->parent
= x
;
3977 /* Y's parent was x's parent. */
3979 y
->parent
= x
->parent
;
3981 /* Get the parent to point to y instead of x. */
3984 if (x
== x
->parent
->left
)
3985 x
->parent
->left
= y
;
3987 x
->parent
->right
= y
;
3992 /* Put x on y's left. */
4006 mem_rotate_right (struct mem_node
*x
)
4008 struct mem_node
*y
= x
->left
;
4011 if (y
->right
!= MEM_NIL
)
4012 y
->right
->parent
= x
;
4015 y
->parent
= x
->parent
;
4018 if (x
== x
->parent
->right
)
4019 x
->parent
->right
= y
;
4021 x
->parent
->left
= y
;
4032 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4035 mem_delete (struct mem_node
*z
)
4037 struct mem_node
*x
, *y
;
4039 if (!z
|| z
== MEM_NIL
)
4042 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4047 while (y
->left
!= MEM_NIL
)
4051 if (y
->left
!= MEM_NIL
)
4056 x
->parent
= y
->parent
;
4059 if (y
== y
->parent
->left
)
4060 y
->parent
->left
= x
;
4062 y
->parent
->right
= x
;
4069 z
->start
= y
->start
;
4074 if (y
->color
== MEM_BLACK
)
4075 mem_delete_fixup (x
);
4077 #ifdef GC_MALLOC_CHECK
4085 /* Re-establish the red-black properties of the tree, after a
4089 mem_delete_fixup (struct mem_node
*x
)
4091 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4093 if (x
== x
->parent
->left
)
4095 struct mem_node
*w
= x
->parent
->right
;
4097 if (w
->color
== MEM_RED
)
4099 w
->color
= MEM_BLACK
;
4100 x
->parent
->color
= MEM_RED
;
4101 mem_rotate_left (x
->parent
);
4102 w
= x
->parent
->right
;
4105 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4112 if (w
->right
->color
== MEM_BLACK
)
4114 w
->left
->color
= MEM_BLACK
;
4116 mem_rotate_right (w
);
4117 w
= x
->parent
->right
;
4119 w
->color
= x
->parent
->color
;
4120 x
->parent
->color
= MEM_BLACK
;
4121 w
->right
->color
= MEM_BLACK
;
4122 mem_rotate_left (x
->parent
);
4128 struct mem_node
*w
= x
->parent
->left
;
4130 if (w
->color
== MEM_RED
)
4132 w
->color
= MEM_BLACK
;
4133 x
->parent
->color
= MEM_RED
;
4134 mem_rotate_right (x
->parent
);
4135 w
= x
->parent
->left
;
4138 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4145 if (w
->left
->color
== MEM_BLACK
)
4147 w
->right
->color
= MEM_BLACK
;
4149 mem_rotate_left (w
);
4150 w
= x
->parent
->left
;
4153 w
->color
= x
->parent
->color
;
4154 x
->parent
->color
= MEM_BLACK
;
4155 w
->left
->color
= MEM_BLACK
;
4156 mem_rotate_right (x
->parent
);
4162 x
->color
= MEM_BLACK
;
4166 /* Value is non-zero if P is a pointer to a live Lisp string on
4167 the heap. M is a pointer to the mem_block for P. */
4170 live_string_p (struct mem_node
*m
, void *p
)
4172 if (m
->type
== MEM_TYPE_STRING
)
4174 struct string_block
*b
= m
->start
;
4175 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4177 /* P must point to the start of a Lisp_String structure, and it
4178 must not be on the free-list. */
4180 && offset
% sizeof b
->strings
[0] == 0
4181 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4182 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4189 /* Value is non-zero if P is a pointer to a live Lisp cons on
4190 the heap. M is a pointer to the mem_block for P. */
4193 live_cons_p (struct mem_node
*m
, void *p
)
4195 if (m
->type
== MEM_TYPE_CONS
)
4197 struct cons_block
*b
= m
->start
;
4198 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4200 /* P must point to the start of a Lisp_Cons, not be
4201 one of the unused cells in the current cons block,
4202 and not be on the free-list. */
4204 && offset
% sizeof b
->conses
[0] == 0
4205 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4207 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4208 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4215 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4216 the heap. M is a pointer to the mem_block for P. */
4219 live_symbol_p (struct mem_node
*m
, void *p
)
4221 if (m
->type
== MEM_TYPE_SYMBOL
)
4223 struct symbol_block
*b
= m
->start
;
4224 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4226 /* P must point to the start of a Lisp_Symbol, not be
4227 one of the unused cells in the current symbol block,
4228 and not be on the free-list. */
4230 && offset
% sizeof b
->symbols
[0] == 0
4231 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4232 && (b
!= symbol_block
4233 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4234 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4241 /* Value is non-zero if P is a pointer to a live Lisp float on
4242 the heap. M is a pointer to the mem_block for P. */
4245 live_float_p (struct mem_node
*m
, void *p
)
4247 if (m
->type
== MEM_TYPE_FLOAT
)
4249 struct float_block
*b
= m
->start
;
4250 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4252 /* P must point to the start of a Lisp_Float and not be
4253 one of the unused cells in the current float block. */
4255 && offset
% sizeof b
->floats
[0] == 0
4256 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4257 && (b
!= float_block
4258 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4265 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4266 the heap. M is a pointer to the mem_block for P. */
4269 live_misc_p (struct mem_node
*m
, void *p
)
4271 if (m
->type
== MEM_TYPE_MISC
)
4273 struct marker_block
*b
= m
->start
;
4274 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4276 /* P must point to the start of a Lisp_Misc, not be
4277 one of the unused cells in the current misc block,
4278 and not be on the free-list. */
4280 && offset
% sizeof b
->markers
[0] == 0
4281 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4282 && (b
!= marker_block
4283 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4284 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4291 /* Value is non-zero if P is a pointer to a live vector-like object.
4292 M is a pointer to the mem_block for P. */
4295 live_vector_p (struct mem_node
*m
, void *p
)
4297 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4299 /* This memory node corresponds to a vector block. */
4300 struct vector_block
*block
= m
->start
;
4301 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4303 /* P is in the block's allocation range. Scan the block
4304 up to P and see whether P points to the start of some
4305 vector which is not on a free list. FIXME: check whether
4306 some allocation patterns (probably a lot of short vectors)
4307 may cause a substantial overhead of this loop. */
4308 while (VECTOR_IN_BLOCK (vector
, block
)
4309 && vector
<= (struct Lisp_Vector
*) p
)
4311 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4314 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4317 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4318 /* This memory node corresponds to a large vector. */
4324 /* Value is non-zero if P is a pointer to a live buffer. M is a
4325 pointer to the mem_block for P. */
4328 live_buffer_p (struct mem_node
*m
, void *p
)
4330 /* P must point to the start of the block, and the buffer
4331 must not have been killed. */
4332 return (m
->type
== MEM_TYPE_BUFFER
4334 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4337 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4341 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4343 /* Currently not used, but may be called from gdb. */
4345 void dump_zombies (void) EXTERNALLY_VISIBLE
;
4347 /* Array of objects that are kept alive because the C stack contains
4348 a pattern that looks like a reference to them. */
4350 #define MAX_ZOMBIES 10
4351 static Lisp_Object zombies
[MAX_ZOMBIES
];
4353 /* Number of zombie objects. */
4355 static EMACS_INT nzombies
;
4357 /* Number of garbage collections. */
4359 static EMACS_INT ngcs
;
4361 /* Average percentage of zombies per collection. */
4363 static double avg_zombies
;
4365 /* Max. number of live and zombie objects. */
4367 static EMACS_INT max_live
, max_zombies
;
4369 /* Average number of live objects per GC. */
4371 static double avg_live
;
4373 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4374 doc
: /* Show information about live and zombie objects. */)
4377 Lisp_Object args
[8], zombie_list
= Qnil
;
4379 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4380 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4381 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4382 args
[1] = make_number (ngcs
);
4383 args
[2] = make_float (avg_live
);
4384 args
[3] = make_float (avg_zombies
);
4385 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4386 args
[5] = make_number (max_live
);
4387 args
[6] = make_number (max_zombies
);
4388 args
[7] = zombie_list
;
4389 return Fmessage (8, args
);
4392 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4395 /* Mark OBJ if we can prove it's a Lisp_Object. */
4398 mark_maybe_object (Lisp_Object obj
)
4405 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4411 po
= (void *) XPNTR (obj
);
4418 switch (XTYPE (obj
))
4421 mark_p
= (live_string_p (m
, po
)
4422 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4426 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4430 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4434 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4437 case Lisp_Vectorlike
:
4438 /* Note: can't check BUFFERP before we know it's a
4439 buffer because checking that dereferences the pointer
4440 PO which might point anywhere. */
4441 if (live_vector_p (m
, po
))
4442 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4443 else if (live_buffer_p (m
, po
))
4444 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4448 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4457 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4458 if (nzombies
< MAX_ZOMBIES
)
4459 zombies
[nzombies
] = obj
;
4467 /* Return true if P can point to Lisp data, and false otherwise.
4468 USE_LSB_TAG needs Lisp data to be aligned on multiples of GCALIGNMENT.
4469 Otherwise, assume that Lisp data is aligned on even addresses. */
4472 maybe_lisp_pointer (void *p
)
4474 return !((intptr_t) p
% (USE_LSB_TAG
? GCALIGNMENT
: 2));
4477 /* If P points to Lisp data, mark that as live if it isn't already
4481 mark_maybe_pointer (void *p
)
4487 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4490 if (!maybe_lisp_pointer (p
))
4496 Lisp_Object obj
= Qnil
;
4500 case MEM_TYPE_NON_LISP
:
4501 case MEM_TYPE_SPARE
:
4502 /* Nothing to do; not a pointer to Lisp memory. */
4505 case MEM_TYPE_BUFFER
:
4506 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4507 XSETVECTOR (obj
, p
);
4511 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4515 case MEM_TYPE_STRING
:
4516 if (live_string_p (m
, p
)
4517 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4518 XSETSTRING (obj
, p
);
4522 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4526 case MEM_TYPE_SYMBOL
:
4527 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4528 XSETSYMBOL (obj
, p
);
4531 case MEM_TYPE_FLOAT
:
4532 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4536 case MEM_TYPE_VECTORLIKE
:
4537 case MEM_TYPE_VECTOR_BLOCK
:
4538 if (live_vector_p (m
, p
))
4541 XSETVECTOR (tem
, p
);
4542 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4557 /* Alignment of pointer values. Use alignof, as it sometimes returns
4558 a smaller alignment than GCC's __alignof__ and mark_memory might
4559 miss objects if __alignof__ were used. */
4560 #define GC_POINTER_ALIGNMENT alignof (void *)
4562 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4563 not suffice, which is the typical case. A host where a Lisp_Object is
4564 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4565 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4566 suffice to widen it to to a Lisp_Object and check it that way. */
4567 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4568 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4569 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4570 nor mark_maybe_object can follow the pointers. This should not occur on
4571 any practical porting target. */
4572 # error "MSB type bits straddle pointer-word boundaries"
4574 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4575 pointer words that hold pointers ORed with type bits. */
4576 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4578 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4579 words that hold unmodified pointers. */
4580 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4583 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4584 or END+OFFSET..START. */
4586 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4587 mark_memory (void *start
, void *end
)
4592 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4596 /* Make START the pointer to the start of the memory region,
4597 if it isn't already. */
4605 /* Mark Lisp data pointed to. This is necessary because, in some
4606 situations, the C compiler optimizes Lisp objects away, so that
4607 only a pointer to them remains. Example:
4609 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4612 Lisp_Object obj = build_string ("test");
4613 struct Lisp_String *s = XSTRING (obj);
4614 Fgarbage_collect ();
4615 fprintf (stderr, "test `%s'\n", s->data);
4619 Here, `obj' isn't really used, and the compiler optimizes it
4620 away. The only reference to the life string is through the
4623 for (pp
= start
; (void *) pp
< end
; pp
++)
4624 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4626 void *p
= *(void **) ((char *) pp
+ i
);
4627 mark_maybe_pointer (p
);
4628 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4629 mark_maybe_object (XIL ((intptr_t) p
));
4633 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4635 static bool setjmp_tested_p
;
4636 static int longjmps_done
;
4638 #define SETJMP_WILL_LIKELY_WORK "\
4640 Emacs garbage collector has been changed to use conservative stack\n\
4641 marking. Emacs has determined that the method it uses to do the\n\
4642 marking will likely work on your system, but this isn't sure.\n\
4644 If you are a system-programmer, or can get the help of a local wizard\n\
4645 who is, please take a look at the function mark_stack in alloc.c, and\n\
4646 verify that the methods used are appropriate for your system.\n\
4648 Please mail the result to <emacs-devel@gnu.org>.\n\
4651 #define SETJMP_WILL_NOT_WORK "\
4653 Emacs garbage collector has been changed to use conservative stack\n\
4654 marking. Emacs has determined that the default method it uses to do the\n\
4655 marking will not work on your system. We will need a system-dependent\n\
4656 solution for your system.\n\
4658 Please take a look at the function mark_stack in alloc.c, and\n\
4659 try to find a way to make it work on your system.\n\
4661 Note that you may get false negatives, depending on the compiler.\n\
4662 In particular, you need to use -O with GCC for this test.\n\
4664 Please mail the result to <emacs-devel@gnu.org>.\n\
4668 /* Perform a quick check if it looks like setjmp saves registers in a
4669 jmp_buf. Print a message to stderr saying so. When this test
4670 succeeds, this is _not_ a proof that setjmp is sufficient for
4671 conservative stack marking. Only the sources or a disassembly
4681 /* Arrange for X to be put in a register. */
4687 if (longjmps_done
== 1)
4689 /* Came here after the longjmp at the end of the function.
4691 If x == 1, the longjmp has restored the register to its
4692 value before the setjmp, and we can hope that setjmp
4693 saves all such registers in the jmp_buf, although that
4696 For other values of X, either something really strange is
4697 taking place, or the setjmp just didn't save the register. */
4700 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4703 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4710 if (longjmps_done
== 1)
4711 sys_longjmp (jbuf
, 1);
4714 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4717 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4719 /* Abort if anything GCPRO'd doesn't survive the GC. */
4727 for (p
= gcprolist
; p
; p
= p
->next
)
4728 for (i
= 0; i
< p
->nvars
; ++i
)
4729 if (!survives_gc_p (p
->var
[i
]))
4730 /* FIXME: It's not necessarily a bug. It might just be that the
4731 GCPRO is unnecessary or should release the object sooner. */
4735 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4742 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4743 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4745 fprintf (stderr
, " %d = ", i
);
4746 debug_print (zombies
[i
]);
4750 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4753 /* Mark live Lisp objects on the C stack.
4755 There are several system-dependent problems to consider when
4756 porting this to new architectures:
4760 We have to mark Lisp objects in CPU registers that can hold local
4761 variables or are used to pass parameters.
4763 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4764 something that either saves relevant registers on the stack, or
4765 calls mark_maybe_object passing it each register's contents.
4767 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4768 implementation assumes that calling setjmp saves registers we need
4769 to see in a jmp_buf which itself lies on the stack. This doesn't
4770 have to be true! It must be verified for each system, possibly
4771 by taking a look at the source code of setjmp.
4773 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4774 can use it as a machine independent method to store all registers
4775 to the stack. In this case the macros described in the previous
4776 two paragraphs are not used.
4780 Architectures differ in the way their processor stack is organized.
4781 For example, the stack might look like this
4784 | Lisp_Object | size = 4
4786 | something else | size = 2
4788 | Lisp_Object | size = 4
4792 In such a case, not every Lisp_Object will be aligned equally. To
4793 find all Lisp_Object on the stack it won't be sufficient to walk
4794 the stack in steps of 4 bytes. Instead, two passes will be
4795 necessary, one starting at the start of the stack, and a second
4796 pass starting at the start of the stack + 2. Likewise, if the
4797 minimal alignment of Lisp_Objects on the stack is 1, four passes
4798 would be necessary, each one starting with one byte more offset
4799 from the stack start. */
4802 mark_stack (void *end
)
4805 /* This assumes that the stack is a contiguous region in memory. If
4806 that's not the case, something has to be done here to iterate
4807 over the stack segments. */
4808 mark_memory (stack_base
, end
);
4810 /* Allow for marking a secondary stack, like the register stack on the
4812 #ifdef GC_MARK_SECONDARY_STACK
4813 GC_MARK_SECONDARY_STACK ();
4816 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4821 #else /* GC_MARK_STACK == 0 */
4823 #define mark_maybe_object(obj) emacs_abort ()
4825 #endif /* GC_MARK_STACK != 0 */
4828 /* Determine whether it is safe to access memory at address P. */
4830 valid_pointer_p (void *p
)
4833 return w32_valid_pointer_p (p
, 16);
4837 /* Obviously, we cannot just access it (we would SEGV trying), so we
4838 trick the o/s to tell us whether p is a valid pointer.
4839 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4840 not validate p in that case. */
4842 if (emacs_pipe (fd
) == 0)
4844 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
4845 emacs_close (fd
[1]);
4846 emacs_close (fd
[0]);
4854 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
4855 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
4856 cannot validate OBJ. This function can be quite slow, so its primary
4857 use is the manual debugging. The only exception is print_object, where
4858 we use it to check whether the memory referenced by the pointer of
4859 Lisp_Save_Value object contains valid objects. */
4862 valid_lisp_object_p (Lisp_Object obj
)
4872 p
= (void *) XPNTR (obj
);
4873 if (PURE_POINTER_P (p
))
4876 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
4880 return valid_pointer_p (p
);
4887 int valid
= valid_pointer_p (p
);
4899 case MEM_TYPE_NON_LISP
:
4900 case MEM_TYPE_SPARE
:
4903 case MEM_TYPE_BUFFER
:
4904 return live_buffer_p (m
, p
) ? 1 : 2;
4907 return live_cons_p (m
, p
);
4909 case MEM_TYPE_STRING
:
4910 return live_string_p (m
, p
);
4913 return live_misc_p (m
, p
);
4915 case MEM_TYPE_SYMBOL
:
4916 return live_symbol_p (m
, p
);
4918 case MEM_TYPE_FLOAT
:
4919 return live_float_p (m
, p
);
4921 case MEM_TYPE_VECTORLIKE
:
4922 case MEM_TYPE_VECTOR_BLOCK
:
4923 return live_vector_p (m
, p
);
4933 /* If GC_MARK_STACK, return 1 if STR is a relocatable data of Lisp_String
4934 (i.e. there is a non-pure Lisp_Object X so that SDATA (X) == STR) and 0
4935 if not. Otherwise we can't rely on valid_lisp_object_p and return -1.
4936 This function is slow and should be used for debugging purposes. */
4939 relocatable_string_data_p (const char *str
)
4941 if (PURE_POINTER_P (str
))
4947 = (struct sdata
*) (str
- offsetof (struct sdata
, data
));
4949 if (valid_pointer_p (sdata
)
4950 && valid_pointer_p (sdata
->string
)
4951 && maybe_lisp_pointer (sdata
->string
))
4952 return (valid_lisp_object_p
4953 (make_lisp_ptr (sdata
->string
, Lisp_String
))
4954 && (const char *) sdata
->string
->data
== str
);
4957 #endif /* GC_MARK_STACK */
4961 /***********************************************************************
4962 Pure Storage Management
4963 ***********************************************************************/
4965 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4966 pointer to it. TYPE is the Lisp type for which the memory is
4967 allocated. TYPE < 0 means it's not used for a Lisp object. */
4970 pure_alloc (size_t size
, int type
)
4974 size_t alignment
= GCALIGNMENT
;
4976 size_t alignment
= alignof (EMACS_INT
);
4978 /* Give Lisp_Floats an extra alignment. */
4979 if (type
== Lisp_Float
)
4980 alignment
= alignof (struct Lisp_Float
);
4986 /* Allocate space for a Lisp object from the beginning of the free
4987 space with taking account of alignment. */
4988 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4989 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4993 /* Allocate space for a non-Lisp object from the end of the free
4995 pure_bytes_used_non_lisp
+= size
;
4996 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4998 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5000 if (pure_bytes_used
<= pure_size
)
5003 /* Don't allocate a large amount here,
5004 because it might get mmap'd and then its address
5005 might not be usable. */
5006 purebeg
= xmalloc (10000);
5008 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5009 pure_bytes_used
= 0;
5010 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5015 /* Print a warning if PURESIZE is too small. */
5018 check_pure_size (void)
5020 if (pure_bytes_used_before_overflow
)
5021 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5023 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5027 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5028 the non-Lisp data pool of the pure storage, and return its start
5029 address. Return NULL if not found. */
5032 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5035 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5036 const unsigned char *p
;
5039 if (pure_bytes_used_non_lisp
<= nbytes
)
5042 /* Set up the Boyer-Moore table. */
5044 for (i
= 0; i
< 256; i
++)
5047 p
= (const unsigned char *) data
;
5049 bm_skip
[*p
++] = skip
;
5051 last_char_skip
= bm_skip
['\0'];
5053 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5054 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5056 /* See the comments in the function `boyer_moore' (search.c) for the
5057 use of `infinity'. */
5058 infinity
= pure_bytes_used_non_lisp
+ 1;
5059 bm_skip
['\0'] = infinity
;
5061 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5065 /* Check the last character (== '\0'). */
5068 start
+= bm_skip
[*(p
+ start
)];
5070 while (start
<= start_max
);
5072 if (start
< infinity
)
5073 /* Couldn't find the last character. */
5076 /* No less than `infinity' means we could find the last
5077 character at `p[start - infinity]'. */
5080 /* Check the remaining characters. */
5081 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5083 return non_lisp_beg
+ start
;
5085 start
+= last_char_skip
;
5087 while (start
<= start_max
);
5093 /* Return a string allocated in pure space. DATA is a buffer holding
5094 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5095 means make the result string multibyte.
5097 Must get an error if pure storage is full, since if it cannot hold
5098 a large string it may be able to hold conses that point to that
5099 string; then the string is not protected from gc. */
5102 make_pure_string (const char *data
,
5103 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5106 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5107 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5108 if (s
->data
== NULL
)
5110 s
->data
= pure_alloc (nbytes
+ 1, -1);
5111 memcpy (s
->data
, data
, nbytes
);
5112 s
->data
[nbytes
] = '\0';
5115 s
->size_byte
= multibyte
? nbytes
: -1;
5116 s
->intervals
= NULL
;
5117 XSETSTRING (string
, s
);
5121 /* Return a string allocated in pure space. Do not
5122 allocate the string data, just point to DATA. */
5125 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5128 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5131 s
->data
= (unsigned char *) data
;
5132 s
->intervals
= NULL
;
5133 XSETSTRING (string
, s
);
5137 static Lisp_Object
purecopy (Lisp_Object obj
);
5139 /* Return a cons allocated from pure space. Give it pure copies
5140 of CAR as car and CDR as cdr. */
5143 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5146 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5148 XSETCAR (new, purecopy (car
));
5149 XSETCDR (new, purecopy (cdr
));
5154 /* Value is a float object with value NUM allocated from pure space. */
5157 make_pure_float (double num
)
5160 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5162 XFLOAT_INIT (new, num
);
5167 /* Return a vector with room for LEN Lisp_Objects allocated from
5171 make_pure_vector (ptrdiff_t len
)
5174 size_t size
= header_size
+ len
* word_size
;
5175 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5176 XSETVECTOR (new, p
);
5177 XVECTOR (new)->header
.size
= len
;
5182 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5183 doc
: /* Make a copy of object OBJ in pure storage.
5184 Recursively copies contents of vectors and cons cells.
5185 Does not copy symbols. Copies strings without text properties. */)
5186 (register Lisp_Object obj
)
5188 if (NILP (Vpurify_flag
))
5190 else if (MARKERP (obj
) || OVERLAYP (obj
)
5191 || HASH_TABLE_P (obj
) || SYMBOLP (obj
))
5192 /* Can't purify those. */
5195 return purecopy (obj
);
5199 purecopy (Lisp_Object obj
)
5201 if (PURE_POINTER_P (XPNTR (obj
)) || INTEGERP (obj
) || SUBRP (obj
))
5202 return obj
; /* Already pure. */
5204 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5206 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5212 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5213 else if (FLOATP (obj
))
5214 obj
= make_pure_float (XFLOAT_DATA (obj
));
5215 else if (STRINGP (obj
))
5216 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5218 STRING_MULTIBYTE (obj
));
5219 else if (COMPILEDP (obj
) || VECTORP (obj
))
5221 register struct Lisp_Vector
*vec
;
5222 register ptrdiff_t i
;
5226 if (size
& PSEUDOVECTOR_FLAG
)
5227 size
&= PSEUDOVECTOR_SIZE_MASK
;
5228 vec
= XVECTOR (make_pure_vector (size
));
5229 for (i
= 0; i
< size
; i
++)
5230 vec
->contents
[i
] = purecopy (AREF (obj
, i
));
5231 if (COMPILEDP (obj
))
5233 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5234 XSETCOMPILED (obj
, vec
);
5237 XSETVECTOR (obj
, vec
);
5239 else if (SYMBOLP (obj
))
5241 if (!XSYMBOL (obj
)->pinned
)
5242 { /* We can't purify them, but they appear in many pure objects.
5243 Mark them as `pinned' so we know to mark them at every GC cycle. */
5244 XSYMBOL (obj
)->pinned
= true;
5245 symbol_block_pinned
= symbol_block
;
5251 Lisp_Object args
[2];
5252 args
[0] = build_pure_c_string ("Don't know how to purify: %S");
5254 Fsignal (Qerror
, (Fcons (Fformat (2, args
), Qnil
)));
5257 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5258 Fputhash (obj
, obj
, Vpurify_flag
);
5265 /***********************************************************************
5267 ***********************************************************************/
5269 /* Put an entry in staticvec, pointing at the variable with address
5273 staticpro (Lisp_Object
*varaddress
)
5275 if (staticidx
>= NSTATICS
)
5276 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5277 staticvec
[staticidx
++] = varaddress
;
5281 /***********************************************************************
5283 ***********************************************************************/
5285 /* Temporarily prevent garbage collection. */
5288 inhibit_garbage_collection (void)
5290 ptrdiff_t count
= SPECPDL_INDEX ();
5292 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5296 /* Used to avoid possible overflows when
5297 converting from C to Lisp integers. */
5300 bounded_number (EMACS_INT number
)
5302 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5305 /* Calculate total bytes of live objects. */
5308 total_bytes_of_live_objects (void)
5311 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5312 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5313 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5314 tot
+= total_string_bytes
;
5315 tot
+= total_vector_slots
* word_size
;
5316 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5317 tot
+= total_intervals
* sizeof (struct interval
);
5318 tot
+= total_strings
* sizeof (struct Lisp_String
);
5322 #ifdef HAVE_WINDOW_SYSTEM
5324 /* This code has a few issues on MS-Windows, see Bug#15876 and Bug#16140. */
5326 #if !defined (HAVE_NTGUI)
5328 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5329 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5332 compact_font_cache_entry (Lisp_Object entry
)
5334 Lisp_Object tail
, *prev
= &entry
;
5336 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5339 Lisp_Object obj
= XCAR (tail
);
5341 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5342 if (CONSP (obj
) && FONT_SPEC_P (XCAR (obj
))
5343 && !VECTOR_MARKED_P (XFONT_SPEC (XCAR (obj
)))
5344 && VECTORP (XCDR (obj
)))
5346 ptrdiff_t i
, size
= ASIZE (XCDR (obj
)) & ~ARRAY_MARK_FLAG
;
5348 /* If font-spec is not marked, most likely all font-entities
5349 are not marked too. But we must be sure that nothing is
5350 marked within OBJ before we really drop it. */
5351 for (i
= 0; i
< size
; i
++)
5352 if (VECTOR_MARKED_P (XFONT_ENTITY (AREF (XCDR (obj
), i
))))
5359 *prev
= XCDR (tail
);
5361 prev
= xcdr_addr (tail
);
5366 #endif /* not HAVE_NTGUI */
5368 /* Compact font caches on all terminals and mark
5369 everything which is still here after compaction. */
5372 compact_font_caches (void)
5376 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5378 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5379 #if !defined (HAVE_NTGUI)
5384 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5385 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5387 #endif /* not HAVE_NTGUI */
5388 mark_object (cache
);
5392 #else /* not HAVE_WINDOW_SYSTEM */
5394 #define compact_font_caches() (void)(0)
5396 #endif /* HAVE_WINDOW_SYSTEM */
5398 /* Remove (MARKER . DATA) entries with unmarked MARKER
5399 from buffer undo LIST and return changed list. */
5402 compact_undo_list (Lisp_Object list
)
5404 Lisp_Object tail
, *prev
= &list
;
5406 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5408 if (CONSP (XCAR (tail
))
5409 && MARKERP (XCAR (XCAR (tail
)))
5410 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5411 *prev
= XCDR (tail
);
5413 prev
= xcdr_addr (tail
);
5419 mark_pinned_symbols (void)
5421 struct symbol_block
*sblk
;
5422 int lim
= (symbol_block_pinned
== symbol_block
5423 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5425 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5427 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5428 for (; sym
< end
; ++sym
)
5430 mark_object (make_lisp_ptr (&sym
->s
, Lisp_Symbol
));
5432 lim
= SYMBOL_BLOCK_SIZE
;
5436 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5437 separate function so that we could limit mark_stack in searching
5438 the stack frames below this function, thus avoiding the rare cases
5439 where mark_stack finds values that look like live Lisp objects on
5440 portions of stack that couldn't possibly contain such live objects.
5441 For more details of this, see the discussion at
5442 http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00270.html. */
5444 garbage_collect_1 (void *end
)
5446 struct buffer
*nextb
;
5447 char stack_top_variable
;
5450 ptrdiff_t count
= SPECPDL_INDEX ();
5451 struct timespec start
;
5452 Lisp_Object retval
= Qnil
;
5453 size_t tot_before
= 0;
5458 /* Can't GC if pure storage overflowed because we can't determine
5459 if something is a pure object or not. */
5460 if (pure_bytes_used_before_overflow
)
5463 /* Record this function, so it appears on the profiler's backtraces. */
5464 record_in_backtrace (Qautomatic_gc
, &Qnil
, 0);
5468 /* Don't keep undo information around forever.
5469 Do this early on, so it is no problem if the user quits. */
5470 FOR_EACH_BUFFER (nextb
)
5471 compact_buffer (nextb
);
5473 if (profiler_memory_running
)
5474 tot_before
= total_bytes_of_live_objects ();
5476 start
= current_timespec ();
5478 /* In case user calls debug_print during GC,
5479 don't let that cause a recursive GC. */
5480 consing_since_gc
= 0;
5482 /* Save what's currently displayed in the echo area. */
5483 message_p
= push_message ();
5484 record_unwind_protect_void (pop_message_unwind
);
5486 /* Save a copy of the contents of the stack, for debugging. */
5487 #if MAX_SAVE_STACK > 0
5488 if (NILP (Vpurify_flag
))
5491 ptrdiff_t stack_size
;
5492 if (&stack_top_variable
< stack_bottom
)
5494 stack
= &stack_top_variable
;
5495 stack_size
= stack_bottom
- &stack_top_variable
;
5499 stack
= stack_bottom
;
5500 stack_size
= &stack_top_variable
- stack_bottom
;
5502 if (stack_size
<= MAX_SAVE_STACK
)
5504 if (stack_copy_size
< stack_size
)
5506 stack_copy
= xrealloc (stack_copy
, stack_size
);
5507 stack_copy_size
= stack_size
;
5509 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5512 #endif /* MAX_SAVE_STACK > 0 */
5514 if (garbage_collection_messages
)
5515 message1_nolog ("Garbage collecting...");
5519 shrink_regexp_cache ();
5523 /* Mark all the special slots that serve as the roots of accessibility. */
5525 mark_buffer (&buffer_defaults
);
5526 mark_buffer (&buffer_local_symbols
);
5528 for (i
= 0; i
< staticidx
; i
++)
5529 mark_object (*staticvec
[i
]);
5531 mark_pinned_symbols ();
5540 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5541 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5545 register struct gcpro
*tail
;
5546 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5547 for (i
= 0; i
< tail
->nvars
; i
++)
5548 mark_object (tail
->var
[i
]);
5553 struct handler
*handler
;
5554 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5556 mark_object (handler
->tag_or_ch
);
5557 mark_object (handler
->val
);
5560 #ifdef HAVE_WINDOW_SYSTEM
5561 mark_fringe_data ();
5564 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5568 /* Everything is now marked, except for the data in font caches
5569 and undo lists. They're compacted by removing an items which
5570 aren't reachable otherwise. */
5572 compact_font_caches ();
5574 FOR_EACH_BUFFER (nextb
)
5576 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5577 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5578 /* Now that we have stripped the elements that need not be
5579 in the undo_list any more, we can finally mark the list. */
5580 mark_object (BVAR (nextb
, undo_list
));
5585 /* Clear the mark bits that we set in certain root slots. */
5587 unmark_byte_stack ();
5588 VECTOR_UNMARK (&buffer_defaults
);
5589 VECTOR_UNMARK (&buffer_local_symbols
);
5591 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5601 consing_since_gc
= 0;
5602 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5603 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5605 gc_relative_threshold
= 0;
5606 if (FLOATP (Vgc_cons_percentage
))
5607 { /* Set gc_cons_combined_threshold. */
5608 double tot
= total_bytes_of_live_objects ();
5610 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5613 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5614 gc_relative_threshold
= tot
;
5616 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5620 if (garbage_collection_messages
)
5622 if (message_p
|| minibuf_level
> 0)
5625 message1_nolog ("Garbage collecting...done");
5628 unbind_to (count
, Qnil
);
5630 Lisp_Object total
[11];
5631 int total_size
= 10;
5633 total
[0] = list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5634 bounded_number (total_conses
),
5635 bounded_number (total_free_conses
));
5637 total
[1] = list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5638 bounded_number (total_symbols
),
5639 bounded_number (total_free_symbols
));
5641 total
[2] = list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5642 bounded_number (total_markers
),
5643 bounded_number (total_free_markers
));
5645 total
[3] = list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5646 bounded_number (total_strings
),
5647 bounded_number (total_free_strings
));
5649 total
[4] = list3 (Qstring_bytes
, make_number (1),
5650 bounded_number (total_string_bytes
));
5652 total
[5] = list3 (Qvectors
,
5653 make_number (header_size
+ sizeof (Lisp_Object
)),
5654 bounded_number (total_vectors
));
5656 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5657 bounded_number (total_vector_slots
),
5658 bounded_number (total_free_vector_slots
));
5660 total
[7] = list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5661 bounded_number (total_floats
),
5662 bounded_number (total_free_floats
));
5664 total
[8] = list4 (Qintervals
, make_number (sizeof (struct interval
)),
5665 bounded_number (total_intervals
),
5666 bounded_number (total_free_intervals
));
5668 total
[9] = list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5669 bounded_number (total_buffers
));
5671 #ifdef DOUG_LEA_MALLOC
5673 total
[10] = list4 (Qheap
, make_number (1024),
5674 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5675 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10));
5677 retval
= Flist (total_size
, total
);
5680 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5682 /* Compute average percentage of zombies. */
5684 = (total_conses
+ total_symbols
+ total_markers
+ total_strings
5685 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5687 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5688 max_live
= max (nlive
, max_live
);
5689 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5690 max_zombies
= max (nzombies
, max_zombies
);
5695 if (!NILP (Vpost_gc_hook
))
5697 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5698 safe_run_hooks (Qpost_gc_hook
);
5699 unbind_to (gc_count
, Qnil
);
5702 /* Accumulate statistics. */
5703 if (FLOATP (Vgc_elapsed
))
5705 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5706 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5707 + timespectod (since_start
));
5712 /* Collect profiling data. */
5713 if (profiler_memory_running
)
5716 size_t tot_after
= total_bytes_of_live_objects ();
5717 if (tot_before
> tot_after
)
5718 swept
= tot_before
- tot_after
;
5719 malloc_probe (swept
);
5725 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5726 doc
: /* Reclaim storage for Lisp objects no longer needed.
5727 Garbage collection happens automatically if you cons more than
5728 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5729 `garbage-collect' normally returns a list with info on amount of space in use,
5730 where each entry has the form (NAME SIZE USED FREE), where:
5731 - NAME is a symbol describing the kind of objects this entry represents,
5732 - SIZE is the number of bytes used by each one,
5733 - USED is the number of those objects that were found live in the heap,
5734 - FREE is the number of those objects that are not live but that Emacs
5735 keeps around for future allocations (maybe because it does not know how
5736 to return them to the OS).
5737 However, if there was overflow in pure space, `garbage-collect'
5738 returns nil, because real GC can't be done.
5739 See Info node `(elisp)Garbage Collection'. */)
5742 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5743 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS \
5744 || GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES)
5747 #ifdef HAVE___BUILTIN_UNWIND_INIT
5748 /* Force callee-saved registers and register windows onto the stack.
5749 This is the preferred method if available, obviating the need for
5750 machine dependent methods. */
5751 __builtin_unwind_init ();
5753 #else /* not HAVE___BUILTIN_UNWIND_INIT */
5754 #ifndef GC_SAVE_REGISTERS_ON_STACK
5755 /* jmp_buf may not be aligned enough on darwin-ppc64 */
5756 union aligned_jmpbuf
{
5760 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
5762 /* This trick flushes the register windows so that all the state of
5763 the process is contained in the stack. */
5764 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
5765 needed on ia64 too. See mach_dep.c, where it also says inline
5766 assembler doesn't work with relevant proprietary compilers. */
5768 #if defined (__sparc64__) && defined (__FreeBSD__)
5769 /* FreeBSD does not have a ta 3 handler. */
5776 /* Save registers that we need to see on the stack. We need to see
5777 registers used to hold register variables and registers used to
5779 #ifdef GC_SAVE_REGISTERS_ON_STACK
5780 GC_SAVE_REGISTERS_ON_STACK (end
);
5781 #else /* not GC_SAVE_REGISTERS_ON_STACK */
5783 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
5784 setjmp will definitely work, test it
5785 and print a message with the result
5787 if (!setjmp_tested_p
)
5789 setjmp_tested_p
= 1;
5792 #endif /* GC_SETJMP_WORKS */
5795 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
5796 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
5797 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
5798 return garbage_collect_1 (end
);
5799 #elif (GC_MARK_STACK == GC_USE_GCPROS_AS_BEFORE)
5800 /* Old GCPROs-based method without stack marking. */
5801 return garbage_collect_1 (NULL
);
5804 #endif /* GC_MARK_STACK */
5807 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5808 only interesting objects referenced from glyphs are strings. */
5811 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5813 struct glyph_row
*row
= matrix
->rows
;
5814 struct glyph_row
*end
= row
+ matrix
->nrows
;
5816 for (; row
< end
; ++row
)
5820 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5822 struct glyph
*glyph
= row
->glyphs
[area
];
5823 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5825 for (; glyph
< end_glyph
; ++glyph
)
5826 if (STRINGP (glyph
->object
)
5827 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5828 mark_object (glyph
->object
);
5833 /* Mark reference to a Lisp_Object.
5834 If the object referred to has not been seen yet, recursively mark
5835 all the references contained in it. */
5837 #define LAST_MARKED_SIZE 500
5838 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5839 static int last_marked_index
;
5841 /* For debugging--call abort when we cdr down this many
5842 links of a list, in mark_object. In debugging,
5843 the call to abort will hit a breakpoint.
5844 Normally this is zero and the check never goes off. */
5845 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5848 mark_vectorlike (struct Lisp_Vector
*ptr
)
5850 ptrdiff_t size
= ptr
->header
.size
;
5853 eassert (!VECTOR_MARKED_P (ptr
));
5854 VECTOR_MARK (ptr
); /* Else mark it. */
5855 if (size
& PSEUDOVECTOR_FLAG
)
5856 size
&= PSEUDOVECTOR_SIZE_MASK
;
5858 /* Note that this size is not the memory-footprint size, but only
5859 the number of Lisp_Object fields that we should trace.
5860 The distinction is used e.g. by Lisp_Process which places extra
5861 non-Lisp_Object fields at the end of the structure... */
5862 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5863 mark_object (ptr
->contents
[i
]);
5866 /* Like mark_vectorlike but optimized for char-tables (and
5867 sub-char-tables) assuming that the contents are mostly integers or
5871 mark_char_table (struct Lisp_Vector
*ptr
)
5873 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5876 eassert (!VECTOR_MARKED_P (ptr
));
5878 for (i
= 0; i
< size
; i
++)
5880 Lisp_Object val
= ptr
->contents
[i
];
5882 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5884 if (SUB_CHAR_TABLE_P (val
))
5886 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5887 mark_char_table (XVECTOR (val
));
5894 NO_INLINE
/* To reduce stack depth in mark_object. */
5896 mark_compiled (struct Lisp_Vector
*ptr
)
5898 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5901 for (i
= 0; i
< size
; i
++)
5902 if (i
!= COMPILED_CONSTANTS
)
5903 mark_object (ptr
->contents
[i
]);
5904 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
5907 /* Mark the chain of overlays starting at PTR. */
5910 mark_overlay (struct Lisp_Overlay
*ptr
)
5912 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5915 mark_object (ptr
->start
);
5916 mark_object (ptr
->end
);
5917 mark_object (ptr
->plist
);
5921 /* Mark Lisp_Objects and special pointers in BUFFER. */
5924 mark_buffer (struct buffer
*buffer
)
5926 /* This is handled much like other pseudovectors... */
5927 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5929 /* ...but there are some buffer-specific things. */
5931 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
5933 /* For now, we just don't mark the undo_list. It's done later in
5934 a special way just before the sweep phase, and after stripping
5935 some of its elements that are not needed any more. */
5937 mark_overlay (buffer
->overlays_before
);
5938 mark_overlay (buffer
->overlays_after
);
5940 /* If this is an indirect buffer, mark its base buffer. */
5941 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5942 mark_buffer (buffer
->base_buffer
);
5945 /* Mark Lisp faces in the face cache C. */
5947 NO_INLINE
/* To reduce stack depth in mark_object. */
5949 mark_face_cache (struct face_cache
*c
)
5954 for (i
= 0; i
< c
->used
; ++i
)
5956 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5960 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
5961 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
5963 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5964 mark_object (face
->lface
[j
]);
5970 NO_INLINE
/* To reduce stack depth in mark_object. */
5972 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
5974 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5975 Lisp_Object where
= blv
->where
;
5976 /* If the value is set up for a killed buffer or deleted
5977 frame, restore its global binding. If the value is
5978 forwarded to a C variable, either it's not a Lisp_Object
5979 var, or it's staticpro'd already. */
5980 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
5981 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
5982 swap_in_global_binding (ptr
);
5983 mark_object (blv
->where
);
5984 mark_object (blv
->valcell
);
5985 mark_object (blv
->defcell
);
5988 NO_INLINE
/* To reduce stack depth in mark_object. */
5990 mark_save_value (struct Lisp_Save_Value
*ptr
)
5992 /* If `save_type' is zero, `data[0].pointer' is the address
5993 of a memory area containing `data[1].integer' potential
5995 if (GC_MARK_STACK
&& ptr
->save_type
== SAVE_TYPE_MEMORY
)
5997 Lisp_Object
*p
= ptr
->data
[0].pointer
;
5999 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
6000 mark_maybe_object (*p
);
6004 /* Find Lisp_Objects in `data[N]' slots and mark them. */
6006 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
6007 if (save_type (ptr
, i
) == SAVE_OBJECT
)
6008 mark_object (ptr
->data
[i
].object
);
6012 /* Remove killed buffers or items whose car is a killed buffer from
6013 LIST, and mark other items. Return changed LIST, which is marked. */
6016 mark_discard_killed_buffers (Lisp_Object list
)
6018 Lisp_Object tail
, *prev
= &list
;
6020 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
6023 Lisp_Object tem
= XCAR (tail
);
6026 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
6027 *prev
= XCDR (tail
);
6030 CONS_MARK (XCONS (tail
));
6031 mark_object (XCAR (tail
));
6032 prev
= xcdr_addr (tail
);
6039 /* Determine type of generic Lisp_Object and mark it accordingly.
6041 This function implements a straightforward depth-first marking
6042 algorithm and so the recursion depth may be very high (a few
6043 tens of thousands is not uncommon). To minimize stack usage,
6044 a few cold paths are moved out to NO_INLINE functions above.
6045 In general, inlining them doesn't help you to gain more speed. */
6048 mark_object (Lisp_Object arg
)
6050 register Lisp_Object obj
= arg
;
6051 #ifdef GC_CHECK_MARKED_OBJECTS
6055 ptrdiff_t cdr_count
= 0;
6059 if (PURE_POINTER_P (XPNTR (obj
)))
6062 last_marked
[last_marked_index
++] = obj
;
6063 if (last_marked_index
== LAST_MARKED_SIZE
)
6064 last_marked_index
= 0;
6066 /* Perform some sanity checks on the objects marked here. Abort if
6067 we encounter an object we know is bogus. This increases GC time
6068 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
6069 #ifdef GC_CHECK_MARKED_OBJECTS
6071 po
= (void *) XPNTR (obj
);
6073 /* Check that the object pointed to by PO is known to be a Lisp
6074 structure allocated from the heap. */
6075 #define CHECK_ALLOCATED() \
6077 m = mem_find (po); \
6082 /* Check that the object pointed to by PO is live, using predicate
6084 #define CHECK_LIVE(LIVEP) \
6086 if (!LIVEP (m, po)) \
6090 /* Check both of the above conditions. */
6091 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6093 CHECK_ALLOCATED (); \
6094 CHECK_LIVE (LIVEP); \
6097 #else /* not GC_CHECK_MARKED_OBJECTS */
6099 #define CHECK_LIVE(LIVEP) (void) 0
6100 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
6102 #endif /* not GC_CHECK_MARKED_OBJECTS */
6104 switch (XTYPE (obj
))
6108 register struct Lisp_String
*ptr
= XSTRING (obj
);
6109 if (STRING_MARKED_P (ptr
))
6111 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6113 MARK_INTERVAL_TREE (ptr
->intervals
);
6114 #ifdef GC_CHECK_STRING_BYTES
6115 /* Check that the string size recorded in the string is the
6116 same as the one recorded in the sdata structure. */
6118 #endif /* GC_CHECK_STRING_BYTES */
6122 case Lisp_Vectorlike
:
6124 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6125 register ptrdiff_t pvectype
;
6127 if (VECTOR_MARKED_P (ptr
))
6130 #ifdef GC_CHECK_MARKED_OBJECTS
6132 if (m
== MEM_NIL
&& !SUBRP (obj
))
6134 #endif /* GC_CHECK_MARKED_OBJECTS */
6136 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6137 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6138 >> PSEUDOVECTOR_AREA_BITS
);
6140 pvectype
= PVEC_NORMAL_VECTOR
;
6142 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6143 CHECK_LIVE (live_vector_p
);
6148 #ifdef GC_CHECK_MARKED_OBJECTS
6157 #endif /* GC_CHECK_MARKED_OBJECTS */
6158 mark_buffer ((struct buffer
*) ptr
);
6162 /* Although we could treat this just like a vector, mark_compiled
6163 returns the COMPILED_CONSTANTS element, which is marked at the
6164 next iteration of goto-loop here. This is done to avoid a few
6165 recursive calls to mark_object. */
6166 obj
= mark_compiled (ptr
);
6173 struct frame
*f
= (struct frame
*) ptr
;
6175 mark_vectorlike (ptr
);
6176 mark_face_cache (f
->face_cache
);
6177 #ifdef HAVE_WINDOW_SYSTEM
6178 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6180 struct font
*font
= FRAME_FONT (f
);
6182 if (font
&& !VECTOR_MARKED_P (font
))
6183 mark_vectorlike ((struct Lisp_Vector
*) font
);
6191 struct window
*w
= (struct window
*) ptr
;
6193 mark_vectorlike (ptr
);
6195 /* Mark glyph matrices, if any. Marking window
6196 matrices is sufficient because frame matrices
6197 use the same glyph memory. */
6198 if (w
->current_matrix
)
6200 mark_glyph_matrix (w
->current_matrix
);
6201 mark_glyph_matrix (w
->desired_matrix
);
6204 /* Filter out killed buffers from both buffer lists
6205 in attempt to help GC to reclaim killed buffers faster.
6206 We can do it elsewhere for live windows, but this is the
6207 best place to do it for dead windows. */
6209 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6211 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6215 case PVEC_HASH_TABLE
:
6217 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6219 mark_vectorlike (ptr
);
6220 mark_object (h
->test
.name
);
6221 mark_object (h
->test
.user_hash_function
);
6222 mark_object (h
->test
.user_cmp_function
);
6223 /* If hash table is not weak, mark all keys and values.
6224 For weak tables, mark only the vector. */
6226 mark_object (h
->key_and_value
);
6228 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6232 case PVEC_CHAR_TABLE
:
6233 mark_char_table (ptr
);
6236 case PVEC_BOOL_VECTOR
:
6237 /* No Lisp_Objects to mark in a bool vector. */
6248 mark_vectorlike (ptr
);
6255 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6259 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6261 /* Attempt to catch bogus objects. */
6262 eassert (valid_lisp_object_p (ptr
->function
) >= 1);
6263 mark_object (ptr
->function
);
6264 mark_object (ptr
->plist
);
6265 switch (ptr
->redirect
)
6267 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6268 case SYMBOL_VARALIAS
:
6271 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6275 case SYMBOL_LOCALIZED
:
6276 mark_localized_symbol (ptr
);
6278 case SYMBOL_FORWARDED
:
6279 /* If the value is forwarded to a buffer or keyboard field,
6280 these are marked when we see the corresponding object.
6281 And if it's forwarded to a C variable, either it's not
6282 a Lisp_Object var, or it's staticpro'd already. */
6284 default: emacs_abort ();
6286 if (!PURE_POINTER_P (XSTRING (ptr
->name
)))
6287 MARK_STRING (XSTRING (ptr
->name
));
6288 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6289 /* Inner loop to mark next symbol in this bucket, if any. */
6297 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6299 if (XMISCANY (obj
)->gcmarkbit
)
6302 switch (XMISCTYPE (obj
))
6304 case Lisp_Misc_Marker
:
6305 /* DO NOT mark thru the marker's chain.
6306 The buffer's markers chain does not preserve markers from gc;
6307 instead, markers are removed from the chain when freed by gc. */
6308 XMISCANY (obj
)->gcmarkbit
= 1;
6311 case Lisp_Misc_Save_Value
:
6312 XMISCANY (obj
)->gcmarkbit
= 1;
6313 mark_save_value (XSAVE_VALUE (obj
));
6316 case Lisp_Misc_Overlay
:
6317 mark_overlay (XOVERLAY (obj
));
6327 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6328 if (CONS_MARKED_P (ptr
))
6330 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6332 /* If the cdr is nil, avoid recursion for the car. */
6333 if (EQ (ptr
->u
.cdr
, Qnil
))
6339 mark_object (ptr
->car
);
6342 if (cdr_count
== mark_object_loop_halt
)
6348 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6349 FLOAT_MARK (XFLOAT (obj
));
6360 #undef CHECK_ALLOCATED
6361 #undef CHECK_ALLOCATED_AND_LIVE
6363 /* Mark the Lisp pointers in the terminal objects.
6364 Called by Fgarbage_collect. */
6367 mark_terminals (void)
6370 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6372 eassert (t
->name
!= NULL
);
6373 #ifdef HAVE_WINDOW_SYSTEM
6374 /* If a terminal object is reachable from a stacpro'ed object,
6375 it might have been marked already. Make sure the image cache
6377 mark_image_cache (t
->image_cache
);
6378 #endif /* HAVE_WINDOW_SYSTEM */
6379 if (!VECTOR_MARKED_P (t
))
6380 mark_vectorlike ((struct Lisp_Vector
*)t
);
6386 /* Value is non-zero if OBJ will survive the current GC because it's
6387 either marked or does not need to be marked to survive. */
6390 survives_gc_p (Lisp_Object obj
)
6394 switch (XTYPE (obj
))
6401 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6405 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6409 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6412 case Lisp_Vectorlike
:
6413 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6417 survives_p
= CONS_MARKED_P (XCONS (obj
));
6421 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6428 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6434 NO_INLINE
/* For better stack traces */
6438 struct cons_block
*cblk
;
6439 struct cons_block
**cprev
= &cons_block
;
6440 int lim
= cons_block_index
;
6441 EMACS_INT num_free
= 0, num_used
= 0;
6445 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6449 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6451 /* Scan the mark bits an int at a time. */
6452 for (i
= 0; i
< ilim
; i
++)
6454 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6456 /* Fast path - all cons cells for this int are marked. */
6457 cblk
->gcmarkbits
[i
] = 0;
6458 num_used
+= BITS_PER_BITS_WORD
;
6462 /* Some cons cells for this int are not marked.
6463 Find which ones, and free them. */
6464 int start
, pos
, stop
;
6466 start
= i
* BITS_PER_BITS_WORD
;
6468 if (stop
> BITS_PER_BITS_WORD
)
6469 stop
= BITS_PER_BITS_WORD
;
6472 for (pos
= start
; pos
< stop
; pos
++)
6474 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6477 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6478 cons_free_list
= &cblk
->conses
[pos
];
6480 cons_free_list
->car
= Vdead
;
6486 CONS_UNMARK (&cblk
->conses
[pos
]);
6492 lim
= CONS_BLOCK_SIZE
;
6493 /* If this block contains only free conses and we have already
6494 seen more than two blocks worth of free conses then deallocate
6496 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6498 *cprev
= cblk
->next
;
6499 /* Unhook from the free list. */
6500 cons_free_list
= cblk
->conses
[0].u
.chain
;
6501 lisp_align_free (cblk
);
6505 num_free
+= this_free
;
6506 cprev
= &cblk
->next
;
6509 total_conses
= num_used
;
6510 total_free_conses
= num_free
;
6513 NO_INLINE
/* For better stack traces */
6517 register struct float_block
*fblk
;
6518 struct float_block
**fprev
= &float_block
;
6519 register int lim
= float_block_index
;
6520 EMACS_INT num_free
= 0, num_used
= 0;
6522 float_free_list
= 0;
6524 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6528 for (i
= 0; i
< lim
; i
++)
6529 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6532 fblk
->floats
[i
].u
.chain
= float_free_list
;
6533 float_free_list
= &fblk
->floats
[i
];
6538 FLOAT_UNMARK (&fblk
->floats
[i
]);
6540 lim
= FLOAT_BLOCK_SIZE
;
6541 /* If this block contains only free floats and we have already
6542 seen more than two blocks worth of free floats then deallocate
6544 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6546 *fprev
= fblk
->next
;
6547 /* Unhook from the free list. */
6548 float_free_list
= fblk
->floats
[0].u
.chain
;
6549 lisp_align_free (fblk
);
6553 num_free
+= this_free
;
6554 fprev
= &fblk
->next
;
6557 total_floats
= num_used
;
6558 total_free_floats
= num_free
;
6561 NO_INLINE
/* For better stack traces */
6563 sweep_intervals (void)
6565 register struct interval_block
*iblk
;
6566 struct interval_block
**iprev
= &interval_block
;
6567 register int lim
= interval_block_index
;
6568 EMACS_INT num_free
= 0, num_used
= 0;
6570 interval_free_list
= 0;
6572 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6577 for (i
= 0; i
< lim
; i
++)
6579 if (!iblk
->intervals
[i
].gcmarkbit
)
6581 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6582 interval_free_list
= &iblk
->intervals
[i
];
6588 iblk
->intervals
[i
].gcmarkbit
= 0;
6591 lim
= INTERVAL_BLOCK_SIZE
;
6592 /* If this block contains only free intervals and we have already
6593 seen more than two blocks worth of free intervals then
6594 deallocate this block. */
6595 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6597 *iprev
= iblk
->next
;
6598 /* Unhook from the free list. */
6599 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6604 num_free
+= this_free
;
6605 iprev
= &iblk
->next
;
6608 total_intervals
= num_used
;
6609 total_free_intervals
= num_free
;
6612 NO_INLINE
/* For better stack traces */
6614 sweep_symbols (void)
6616 register struct symbol_block
*sblk
;
6617 struct symbol_block
**sprev
= &symbol_block
;
6618 register int lim
= symbol_block_index
;
6619 EMACS_INT num_free
= 0, num_used
= 0;
6621 symbol_free_list
= NULL
;
6623 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6626 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6627 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6629 for (; sym
< end
; ++sym
)
6631 if (!sym
->s
.gcmarkbit
)
6633 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6634 xfree (SYMBOL_BLV (&sym
->s
));
6635 sym
->s
.next
= symbol_free_list
;
6636 symbol_free_list
= &sym
->s
;
6638 symbol_free_list
->function
= Vdead
;
6645 sym
->s
.gcmarkbit
= 0;
6646 /* Attempt to catch bogus objects. */
6647 eassert (valid_lisp_object_p (sym
->s
.function
) >= 1);
6651 lim
= SYMBOL_BLOCK_SIZE
;
6652 /* If this block contains only free symbols and we have already
6653 seen more than two blocks worth of free symbols then deallocate
6655 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6657 *sprev
= sblk
->next
;
6658 /* Unhook from the free list. */
6659 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6664 num_free
+= this_free
;
6665 sprev
= &sblk
->next
;
6668 total_symbols
= num_used
;
6669 total_free_symbols
= num_free
;
6672 NO_INLINE
/* For better stack traces */
6676 register struct marker_block
*mblk
;
6677 struct marker_block
**mprev
= &marker_block
;
6678 register int lim
= marker_block_index
;
6679 EMACS_INT num_free
= 0, num_used
= 0;
6681 /* Put all unmarked misc's on free list. For a marker, first
6682 unchain it from the buffer it points into. */
6684 marker_free_list
= 0;
6686 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6691 for (i
= 0; i
< lim
; i
++)
6693 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6695 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6696 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6697 /* Set the type of the freed object to Lisp_Misc_Free.
6698 We could leave the type alone, since nobody checks it,
6699 but this might catch bugs faster. */
6700 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6701 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6702 marker_free_list
= &mblk
->markers
[i
].m
;
6708 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6711 lim
= MARKER_BLOCK_SIZE
;
6712 /* If this block contains only free markers and we have already
6713 seen more than two blocks worth of free markers then deallocate
6715 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6717 *mprev
= mblk
->next
;
6718 /* Unhook from the free list. */
6719 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6724 num_free
+= this_free
;
6725 mprev
= &mblk
->next
;
6729 total_markers
= num_used
;
6730 total_free_markers
= num_free
;
6733 NO_INLINE
/* For better stack traces */
6735 sweep_buffers (void)
6737 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6740 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6741 if (!VECTOR_MARKED_P (buffer
))
6743 *bprev
= buffer
->next
;
6748 VECTOR_UNMARK (buffer
);
6749 /* Do not use buffer_(set|get)_intervals here. */
6750 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6752 bprev
= &buffer
->next
;
6756 /* Sweep: find all structures not marked, and free them. */
6760 /* Remove or mark entries in weak hash tables.
6761 This must be done before any object is unmarked. */
6762 sweep_weak_hash_tables ();
6765 check_string_bytes (!noninteractive
);
6773 check_string_bytes (!noninteractive
);
6777 /* Debugging aids. */
6779 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6780 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6781 This may be helpful in debugging Emacs's memory usage.
6782 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6788 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
6791 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6797 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6798 doc
: /* Return a list of counters that measure how much consing there has been.
6799 Each of these counters increments for a certain kind of object.
6800 The counters wrap around from the largest positive integer to zero.
6801 Garbage collection does not decrease them.
6802 The elements of the value are as follows:
6803 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6804 All are in units of 1 = one object consed
6805 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6807 MISCS include overlays, markers, and some internal types.
6808 Frames, windows, buffers, and subprocesses count as vectors
6809 (but the contents of a buffer's text do not count here). */)
6812 return listn (CONSTYPE_HEAP
, 8,
6813 bounded_number (cons_cells_consed
),
6814 bounded_number (floats_consed
),
6815 bounded_number (vector_cells_consed
),
6816 bounded_number (symbols_consed
),
6817 bounded_number (string_chars_consed
),
6818 bounded_number (misc_objects_consed
),
6819 bounded_number (intervals_consed
),
6820 bounded_number (strings_consed
));
6823 /* Find at most FIND_MAX symbols which have OBJ as their value or
6824 function. This is used in gdbinit's `xwhichsymbols' command. */
6827 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6829 struct symbol_block
*sblk
;
6830 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6831 Lisp_Object found
= Qnil
;
6835 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6837 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6840 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6842 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6846 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6849 XSETSYMBOL (tem
, sym
);
6850 val
= find_symbol_value (tem
);
6852 || EQ (sym
->function
, obj
)
6853 || (!NILP (sym
->function
)
6854 && COMPILEDP (sym
->function
)
6855 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6858 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6860 found
= Fcons (tem
, found
);
6861 if (--find_max
== 0)
6869 unbind_to (gc_count
, Qnil
);
6873 #ifdef SUSPICIOUS_OBJECT_CHECKING
6876 find_suspicious_object_in_range (void *begin
, void *end
)
6878 char *begin_a
= begin
;
6882 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6884 char *suspicious_object
= suspicious_objects
[i
];
6885 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
6886 return suspicious_object
;
6893 note_suspicious_free (void* ptr
)
6895 struct suspicious_free_record
* rec
;
6897 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
6898 if (suspicious_free_history_index
==
6899 ARRAYELTS (suspicious_free_history
))
6901 suspicious_free_history_index
= 0;
6904 memset (rec
, 0, sizeof (*rec
));
6905 rec
->suspicious_object
= ptr
;
6906 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
6910 detect_suspicious_free (void* ptr
)
6914 eassert (ptr
!= NULL
);
6916 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6917 if (suspicious_objects
[i
] == ptr
)
6919 note_suspicious_free (ptr
);
6920 suspicious_objects
[i
] = NULL
;
6924 #endif /* SUSPICIOUS_OBJECT_CHECKING */
6926 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
6927 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
6928 If Emacs is compiled with suspicous object checking, capture
6929 a stack trace when OBJ is freed in order to help track down
6930 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
6933 #ifdef SUSPICIOUS_OBJECT_CHECKING
6934 /* Right now, we care only about vectors. */
6935 if (VECTORLIKEP (obj
))
6937 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
6938 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
6939 suspicious_object_index
= 0;
6945 #ifdef ENABLE_CHECKING
6947 bool suppress_checking
;
6950 die (const char *msg
, const char *file
, int line
)
6952 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
6954 terminate_due_to_signal (SIGABRT
, INT_MAX
);
6958 /* Initialization. */
6961 init_alloc_once (void)
6963 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6965 pure_size
= PURESIZE
;
6967 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6969 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6972 #ifdef DOUG_LEA_MALLOC
6973 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
6974 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
6975 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
6980 refill_memory_reserve ();
6981 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6988 byte_stack_list
= 0;
6990 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6991 setjmp_tested_p
= longjmps_done
= 0;
6994 Vgc_elapsed
= make_float (0.0);
6998 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
7003 syms_of_alloc (void)
7005 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
7006 doc
: /* Number of bytes of consing between garbage collections.
7007 Garbage collection can happen automatically once this many bytes have been
7008 allocated since the last garbage collection. All data types count.
7010 Garbage collection happens automatically only when `eval' is called.
7012 By binding this temporarily to a large number, you can effectively
7013 prevent garbage collection during a part of the program.
7014 See also `gc-cons-percentage'. */);
7016 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
7017 doc
: /* Portion of the heap used for allocation.
7018 Garbage collection can happen automatically once this portion of the heap
7019 has been allocated since the last garbage collection.
7020 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
7021 Vgc_cons_percentage
= make_float (0.1);
7023 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
7024 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
7026 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
7027 doc
: /* Number of cons cells that have been consed so far. */);
7029 DEFVAR_INT ("floats-consed", floats_consed
,
7030 doc
: /* Number of floats that have been consed so far. */);
7032 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7033 doc
: /* Number of vector cells that have been consed so far. */);
7035 DEFVAR_INT ("symbols-consed", symbols_consed
,
7036 doc
: /* Number of symbols that have been consed so far. */);
7038 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7039 doc
: /* Number of string characters that have been consed so far. */);
7041 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7042 doc
: /* Number of miscellaneous objects that have been consed so far.
7043 These include markers and overlays, plus certain objects not visible
7046 DEFVAR_INT ("intervals-consed", intervals_consed
,
7047 doc
: /* Number of intervals that have been consed so far. */);
7049 DEFVAR_INT ("strings-consed", strings_consed
,
7050 doc
: /* Number of strings that have been consed so far. */);
7052 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7053 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7054 This means that certain objects should be allocated in shared (pure) space.
7055 It can also be set to a hash-table, in which case this table is used to
7056 do hash-consing of the objects allocated to pure space. */);
7058 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7059 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7060 garbage_collection_messages
= 0;
7062 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7063 doc
: /* Hook run after garbage collection has finished. */);
7064 Vpost_gc_hook
= Qnil
;
7065 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7067 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7068 doc
: /* Precomputed `signal' argument for memory-full error. */);
7069 /* We build this in advance because if we wait until we need it, we might
7070 not be able to allocate the memory to hold it. */
7072 = listn (CONSTYPE_PURE
, 2, Qerror
,
7073 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7075 DEFVAR_LISP ("memory-full", Vmemory_full
,
7076 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7077 Vmemory_full
= Qnil
;
7079 DEFSYM (Qconses
, "conses");
7080 DEFSYM (Qsymbols
, "symbols");
7081 DEFSYM (Qmiscs
, "miscs");
7082 DEFSYM (Qstrings
, "strings");
7083 DEFSYM (Qvectors
, "vectors");
7084 DEFSYM (Qfloats
, "floats");
7085 DEFSYM (Qintervals
, "intervals");
7086 DEFSYM (Qbuffers
, "buffers");
7087 DEFSYM (Qstring_bytes
, "string-bytes");
7088 DEFSYM (Qvector_slots
, "vector-slots");
7089 DEFSYM (Qheap
, "heap");
7090 DEFSYM (Qautomatic_gc
, "Automatic GC");
7092 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7093 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7095 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7096 doc
: /* Accumulated time elapsed in garbage collections.
7097 The time is in seconds as a floating point value. */);
7098 DEFVAR_INT ("gcs-done", gcs_done
,
7099 doc
: /* Accumulated number of garbage collections done. */);
7104 defsubr (&Sbool_vector
);
7105 defsubr (&Smake_byte_code
);
7106 defsubr (&Smake_list
);
7107 defsubr (&Smake_vector
);
7108 defsubr (&Smake_string
);
7109 defsubr (&Smake_bool_vector
);
7110 defsubr (&Smake_symbol
);
7111 defsubr (&Smake_marker
);
7112 defsubr (&Spurecopy
);
7113 defsubr (&Sgarbage_collect
);
7114 defsubr (&Smemory_limit
);
7115 defsubr (&Smemory_use_counts
);
7116 defsubr (&Ssuspicious_object
);
7118 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
7119 defsubr (&Sgc_status
);
7123 /* When compiled with GCC, GDB might say "No enum type named
7124 pvec_type" if we don't have at least one symbol with that type, and
7125 then xbacktrace could fail. Similarly for the other enums and
7126 their values. Some non-GCC compilers don't like these constructs. */
7130 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7131 enum CHAR_TABLE_STANDARD_SLOTS CHAR_TABLE_STANDARD_SLOTS
;
7132 enum char_bits char_bits
;
7133 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7134 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7135 enum Lisp_Bits Lisp_Bits
;
7136 enum Lisp_Compiled Lisp_Compiled
;
7137 enum maxargs maxargs
;
7138 enum MAX_ALLOCA MAX_ALLOCA
;
7139 enum More_Lisp_Bits More_Lisp_Bits
;
7140 enum pvec_type pvec_type
;
7141 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7142 #endif /* __GNUC__ */