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 /* If compiled with XMALLOC_BLOCK_INPUT_CHECK, define a symbol
681 BLOCK_INPUT_IN_MEMORY_ALLOCATORS that is visible to the debugger.
682 If that variable is set, block input while in one of Emacs's memory
683 allocation functions. There should be no need for this debugging
684 option, since signal handlers do not allocate memory, but Emacs
685 formerly allocated memory in signal handlers and this compile-time
686 option remains as a way to help debug the issue should it rear its
688 #ifdef XMALLOC_BLOCK_INPUT_CHECK
689 bool block_input_in_memory_allocators EXTERNALLY_VISIBLE
;
691 malloc_block_input (void)
693 if (block_input_in_memory_allocators
)
697 malloc_unblock_input (void)
699 if (block_input_in_memory_allocators
)
702 # define MALLOC_BLOCK_INPUT malloc_block_input ()
703 # define MALLOC_UNBLOCK_INPUT malloc_unblock_input ()
705 # define MALLOC_BLOCK_INPUT ((void) 0)
706 # define MALLOC_UNBLOCK_INPUT ((void) 0)
709 #define MALLOC_PROBE(size) \
711 if (profiler_memory_running) \
712 malloc_probe (size); \
716 /* Like malloc but check for no memory and block interrupt input.. */
719 xmalloc (size_t size
)
725 MALLOC_UNBLOCK_INPUT
;
733 /* Like the above, but zeroes out the memory just allocated. */
736 xzalloc (size_t size
)
742 MALLOC_UNBLOCK_INPUT
;
746 memset (val
, 0, size
);
751 /* Like realloc but check for no memory and block interrupt input.. */
754 xrealloc (void *block
, size_t size
)
759 /* We must call malloc explicitly when BLOCK is 0, since some
760 reallocs don't do this. */
764 val
= realloc (block
, size
);
765 MALLOC_UNBLOCK_INPUT
;
774 /* Like free but block interrupt input. */
783 MALLOC_UNBLOCK_INPUT
;
784 /* We don't call refill_memory_reserve here
785 because in practice the call in r_alloc_free seems to suffice. */
789 /* Other parts of Emacs pass large int values to allocator functions
790 expecting ptrdiff_t. This is portable in practice, but check it to
792 verify (INT_MAX
<= PTRDIFF_MAX
);
795 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
796 Signal an error on memory exhaustion, and block interrupt input. */
799 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
801 eassert (0 <= nitems
&& 0 < item_size
);
802 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
803 memory_full (SIZE_MAX
);
804 return xmalloc (nitems
* item_size
);
808 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
809 Signal an error on memory exhaustion, and block interrupt input. */
812 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
814 eassert (0 <= nitems
&& 0 < item_size
);
815 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
816 memory_full (SIZE_MAX
);
817 return xrealloc (pa
, nitems
* item_size
);
821 /* Grow PA, which points to an array of *NITEMS items, and return the
822 location of the reallocated array, updating *NITEMS to reflect its
823 new size. The new array will contain at least NITEMS_INCR_MIN more
824 items, but will not contain more than NITEMS_MAX items total.
825 ITEM_SIZE is the size of each item, in bytes.
827 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
828 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
831 If PA is null, then allocate a new array instead of reallocating
834 Block interrupt input as needed. If memory exhaustion occurs, set
835 *NITEMS to zero if PA is null, and signal an error (i.e., do not
838 Thus, to grow an array A without saving its old contents, do
839 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
840 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
841 and signals an error, and later this code is reexecuted and
842 attempts to free A. */
845 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
846 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
848 /* The approximate size to use for initial small allocation
849 requests. This is the largest "small" request for the GNU C
851 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
853 /* If the array is tiny, grow it to about (but no greater than)
854 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
855 ptrdiff_t n
= *nitems
;
856 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
857 ptrdiff_t half_again
= n
>> 1;
858 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
860 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
861 NITEMS_MAX, and what the C language can represent safely. */
862 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
863 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
864 ? nitems_max
: C_language_max
);
865 ptrdiff_t nitems_incr_max
= n_max
- n
;
866 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
868 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
871 if (nitems_incr_max
< incr
)
872 memory_full (SIZE_MAX
);
874 pa
= xrealloc (pa
, n
* item_size
);
880 /* Like strdup, but uses xmalloc. */
883 xstrdup (const char *s
)
887 size
= strlen (s
) + 1;
888 return memcpy (xmalloc (size
), s
, size
);
891 /* Like above, but duplicates Lisp string to C string. */
894 xlispstrdup (Lisp_Object string
)
896 ptrdiff_t size
= SBYTES (string
) + 1;
897 return memcpy (xmalloc (size
), SSDATA (string
), size
);
900 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
901 pointed to. If STRING is null, assign it without copying anything.
902 Allocate before freeing, to avoid a dangling pointer if allocation
906 dupstring (char **ptr
, char const *string
)
909 *ptr
= string
? xstrdup (string
) : 0;
914 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
915 argument is a const pointer. */
918 xputenv (char const *string
)
920 if (putenv ((char *) string
) != 0)
924 /* Return a newly allocated memory block of SIZE bytes, remembering
925 to free it when unwinding. */
927 record_xmalloc (size_t size
)
929 void *p
= xmalloc (size
);
930 record_unwind_protect_ptr (xfree
, p
);
935 /* Like malloc but used for allocating Lisp data. NBYTES is the
936 number of bytes to allocate, TYPE describes the intended use of the
937 allocated memory block (for strings, for conses, ...). */
940 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
944 lisp_malloc (size_t nbytes
, enum mem_type type
)
950 #ifdef GC_MALLOC_CHECK
951 allocated_mem_type
= type
;
954 val
= malloc (nbytes
);
957 /* If the memory just allocated cannot be addressed thru a Lisp
958 object's pointer, and it needs to be,
959 that's equivalent to running out of memory. */
960 if (val
&& type
!= MEM_TYPE_NON_LISP
)
963 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
964 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
966 lisp_malloc_loser
= val
;
973 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
974 if (val
&& type
!= MEM_TYPE_NON_LISP
)
975 mem_insert (val
, (char *) val
+ nbytes
, type
);
978 MALLOC_UNBLOCK_INPUT
;
980 memory_full (nbytes
);
981 MALLOC_PROBE (nbytes
);
985 /* Free BLOCK. This must be called to free memory allocated with a
986 call to lisp_malloc. */
989 lisp_free (void *block
)
993 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
994 mem_delete (mem_find (block
));
996 MALLOC_UNBLOCK_INPUT
;
999 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
1001 /* The entry point is lisp_align_malloc which returns blocks of at most
1002 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
1004 /* Use aligned_alloc if it or a simple substitute is available.
1005 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
1006 clang 3.3 anyway. */
1008 #if ! ADDRESS_SANITIZER
1009 # if !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC
1010 # define USE_ALIGNED_ALLOC 1
1011 /* Defined in gmalloc.c. */
1012 void *aligned_alloc (size_t, size_t);
1013 # elif defined HAVE_ALIGNED_ALLOC
1014 # define USE_ALIGNED_ALLOC 1
1015 # elif defined HAVE_POSIX_MEMALIGN
1016 # define USE_ALIGNED_ALLOC 1
1018 aligned_alloc (size_t alignment
, size_t size
)
1021 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
1026 /* BLOCK_ALIGN has to be a power of 2. */
1027 #define BLOCK_ALIGN (1 << 10)
1029 /* Padding to leave at the end of a malloc'd block. This is to give
1030 malloc a chance to minimize the amount of memory wasted to alignment.
1031 It should be tuned to the particular malloc library used.
1032 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
1033 aligned_alloc on the other hand would ideally prefer a value of 4
1034 because otherwise, there's 1020 bytes wasted between each ablocks.
1035 In Emacs, testing shows that those 1020 can most of the time be
1036 efficiently used by malloc to place other objects, so a value of 0 can
1037 still preferable unless you have a lot of aligned blocks and virtually
1039 #define BLOCK_PADDING 0
1040 #define BLOCK_BYTES \
1041 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1043 /* Internal data structures and constants. */
1045 #define ABLOCKS_SIZE 16
1047 /* An aligned block of memory. */
1052 char payload
[BLOCK_BYTES
];
1053 struct ablock
*next_free
;
1055 /* `abase' is the aligned base of the ablocks. */
1056 /* It is overloaded to hold the virtual `busy' field that counts
1057 the number of used ablock in the parent ablocks.
1058 The first ablock has the `busy' field, the others have the `abase'
1059 field. To tell the difference, we assume that pointers will have
1060 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1061 is used to tell whether the real base of the parent ablocks is `abase'
1062 (if not, the word before the first ablock holds a pointer to the
1064 struct ablocks
*abase
;
1065 /* The padding of all but the last ablock is unused. The padding of
1066 the last ablock in an ablocks is not allocated. */
1068 char padding
[BLOCK_PADDING
];
1072 /* A bunch of consecutive aligned blocks. */
1075 struct ablock blocks
[ABLOCKS_SIZE
];
1078 /* Size of the block requested from malloc or aligned_alloc. */
1079 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1081 #define ABLOCK_ABASE(block) \
1082 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1083 ? (struct ablocks *)(block) \
1086 /* Virtual `busy' field. */
1087 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1089 /* Pointer to the (not necessarily aligned) malloc block. */
1090 #ifdef USE_ALIGNED_ALLOC
1091 #define ABLOCKS_BASE(abase) (abase)
1093 #define ABLOCKS_BASE(abase) \
1094 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1097 /* The list of free ablock. */
1098 static struct ablock
*free_ablock
;
1100 /* Allocate an aligned block of nbytes.
1101 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1102 smaller or equal to BLOCK_BYTES. */
1104 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1107 struct ablocks
*abase
;
1109 eassert (nbytes
<= BLOCK_BYTES
);
1113 #ifdef GC_MALLOC_CHECK
1114 allocated_mem_type
= type
;
1120 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1122 #ifdef DOUG_LEA_MALLOC
1123 if (!mmap_lisp_allowed_p ())
1124 mallopt (M_MMAP_MAX
, 0);
1127 #ifdef USE_ALIGNED_ALLOC
1128 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1130 base
= malloc (ABLOCKS_BYTES
);
1131 abase
= ALIGN (base
, BLOCK_ALIGN
);
1136 MALLOC_UNBLOCK_INPUT
;
1137 memory_full (ABLOCKS_BYTES
);
1140 aligned
= (base
== abase
);
1142 ((void **) abase
)[-1] = base
;
1144 #ifdef DOUG_LEA_MALLOC
1145 if (!mmap_lisp_allowed_p ())
1146 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1150 /* If the memory just allocated cannot be addressed thru a Lisp
1151 object's pointer, and it needs to be, that's equivalent to
1152 running out of memory. */
1153 if (type
!= MEM_TYPE_NON_LISP
)
1156 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1157 XSETCONS (tem
, end
);
1158 if ((char *) XCONS (tem
) != end
)
1160 lisp_malloc_loser
= base
;
1162 MALLOC_UNBLOCK_INPUT
;
1163 memory_full (SIZE_MAX
);
1168 /* Initialize the blocks and put them on the free list.
1169 If `base' was not properly aligned, we can't use the last block. */
1170 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1172 abase
->blocks
[i
].abase
= abase
;
1173 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1174 free_ablock
= &abase
->blocks
[i
];
1176 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1178 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1179 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1180 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1181 eassert (ABLOCKS_BASE (abase
) == base
);
1182 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1185 abase
= ABLOCK_ABASE (free_ablock
);
1186 ABLOCKS_BUSY (abase
)
1187 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1189 free_ablock
= free_ablock
->x
.next_free
;
1191 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1192 if (type
!= MEM_TYPE_NON_LISP
)
1193 mem_insert (val
, (char *) val
+ nbytes
, type
);
1196 MALLOC_UNBLOCK_INPUT
;
1198 MALLOC_PROBE (nbytes
);
1200 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1205 lisp_align_free (void *block
)
1207 struct ablock
*ablock
= block
;
1208 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1211 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1212 mem_delete (mem_find (block
));
1214 /* Put on free list. */
1215 ablock
->x
.next_free
= free_ablock
;
1216 free_ablock
= ablock
;
1217 /* Update busy count. */
1218 ABLOCKS_BUSY (abase
)
1219 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1221 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1222 { /* All the blocks are free. */
1223 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1224 struct ablock
**tem
= &free_ablock
;
1225 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1229 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1232 *tem
= (*tem
)->x
.next_free
;
1235 tem
= &(*tem
)->x
.next_free
;
1237 eassert ((aligned
& 1) == aligned
);
1238 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1239 #ifdef USE_POSIX_MEMALIGN
1240 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1242 free (ABLOCKS_BASE (abase
));
1244 MALLOC_UNBLOCK_INPUT
;
1248 /***********************************************************************
1250 ***********************************************************************/
1252 /* Number of intervals allocated in an interval_block structure.
1253 The 1020 is 1024 minus malloc overhead. */
1255 #define INTERVAL_BLOCK_SIZE \
1256 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1258 /* Intervals are allocated in chunks in the form of an interval_block
1261 struct interval_block
1263 /* Place `intervals' first, to preserve alignment. */
1264 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1265 struct interval_block
*next
;
1268 /* Current interval block. Its `next' pointer points to older
1271 static struct interval_block
*interval_block
;
1273 /* Index in interval_block above of the next unused interval
1276 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1278 /* Number of free and live intervals. */
1280 static EMACS_INT total_free_intervals
, total_intervals
;
1282 /* List of free intervals. */
1284 static INTERVAL interval_free_list
;
1286 /* Return a new interval. */
1289 make_interval (void)
1295 if (interval_free_list
)
1297 val
= interval_free_list
;
1298 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1302 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1304 struct interval_block
*newi
1305 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1307 newi
->next
= interval_block
;
1308 interval_block
= newi
;
1309 interval_block_index
= 0;
1310 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1312 val
= &interval_block
->intervals
[interval_block_index
++];
1315 MALLOC_UNBLOCK_INPUT
;
1317 consing_since_gc
+= sizeof (struct interval
);
1319 total_free_intervals
--;
1320 RESET_INTERVAL (val
);
1326 /* Mark Lisp objects in interval I. */
1329 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1331 /* Intervals should never be shared. So, if extra internal checking is
1332 enabled, GC aborts if it seems to have visited an interval twice. */
1333 eassert (!i
->gcmarkbit
);
1335 mark_object (i
->plist
);
1338 /* Mark the interval tree rooted in I. */
1340 #define MARK_INTERVAL_TREE(i) \
1342 if (i && !i->gcmarkbit) \
1343 traverse_intervals_noorder (i, mark_interval, Qnil); \
1346 /***********************************************************************
1348 ***********************************************************************/
1350 /* Lisp_Strings are allocated in string_block structures. When a new
1351 string_block is allocated, all the Lisp_Strings it contains are
1352 added to a free-list string_free_list. When a new Lisp_String is
1353 needed, it is taken from that list. During the sweep phase of GC,
1354 string_blocks that are entirely free are freed, except two which
1357 String data is allocated from sblock structures. Strings larger
1358 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1359 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1361 Sblocks consist internally of sdata structures, one for each
1362 Lisp_String. The sdata structure points to the Lisp_String it
1363 belongs to. The Lisp_String points back to the `u.data' member of
1364 its sdata structure.
1366 When a Lisp_String is freed during GC, it is put back on
1367 string_free_list, and its `data' member and its sdata's `string'
1368 pointer is set to null. The size of the string is recorded in the
1369 `n.nbytes' member of the sdata. So, sdata structures that are no
1370 longer used, can be easily recognized, and it's easy to compact the
1371 sblocks of small strings which we do in compact_small_strings. */
1373 /* Size in bytes of an sblock structure used for small strings. This
1374 is 8192 minus malloc overhead. */
1376 #define SBLOCK_SIZE 8188
1378 /* Strings larger than this are considered large strings. String data
1379 for large strings is allocated from individual sblocks. */
1381 #define LARGE_STRING_BYTES 1024
1383 /* The SDATA typedef is a struct or union describing string memory
1384 sub-allocated from an sblock. This is where the contents of Lisp
1385 strings are stored. */
1389 /* Back-pointer to the string this sdata belongs to. If null, this
1390 structure is free, and NBYTES (in this structure or in the union below)
1391 contains the string's byte size (the same value that STRING_BYTES
1392 would return if STRING were non-null). If non-null, STRING_BYTES
1393 (STRING) is the size of the data, and DATA contains the string's
1395 struct Lisp_String
*string
;
1397 #ifdef GC_CHECK_STRING_BYTES
1401 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1404 #ifdef GC_CHECK_STRING_BYTES
1406 typedef struct sdata sdata
;
1407 #define SDATA_NBYTES(S) (S)->nbytes
1408 #define SDATA_DATA(S) (S)->data
1414 struct Lisp_String
*string
;
1416 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1417 which has a flexible array member. However, if implemented by
1418 giving this union a member of type 'struct sdata', the union
1419 could not be the last (flexible) member of 'struct sblock',
1420 because C99 prohibits a flexible array member from having a type
1421 that is itself a flexible array. So, comment this member out here,
1422 but remember that the option's there when using this union. */
1427 /* When STRING is null. */
1430 struct Lisp_String
*string
;
1435 #define SDATA_NBYTES(S) (S)->n.nbytes
1436 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1438 #endif /* not GC_CHECK_STRING_BYTES */
1440 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1442 /* Structure describing a block of memory which is sub-allocated to
1443 obtain string data memory for strings. Blocks for small strings
1444 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1445 as large as needed. */
1450 struct sblock
*next
;
1452 /* Pointer to the next free sdata block. This points past the end
1453 of the sblock if there isn't any space left in this block. */
1457 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1460 /* Number of Lisp strings in a string_block structure. The 1020 is
1461 1024 minus malloc overhead. */
1463 #define STRING_BLOCK_SIZE \
1464 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1466 /* Structure describing a block from which Lisp_String structures
1471 /* Place `strings' first, to preserve alignment. */
1472 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1473 struct string_block
*next
;
1476 /* Head and tail of the list of sblock structures holding Lisp string
1477 data. We always allocate from current_sblock. The NEXT pointers
1478 in the sblock structures go from oldest_sblock to current_sblock. */
1480 static struct sblock
*oldest_sblock
, *current_sblock
;
1482 /* List of sblocks for large strings. */
1484 static struct sblock
*large_sblocks
;
1486 /* List of string_block structures. */
1488 static struct string_block
*string_blocks
;
1490 /* Free-list of Lisp_Strings. */
1492 static struct Lisp_String
*string_free_list
;
1494 /* Number of live and free Lisp_Strings. */
1496 static EMACS_INT total_strings
, total_free_strings
;
1498 /* Number of bytes used by live strings. */
1500 static EMACS_INT total_string_bytes
;
1502 /* Given a pointer to a Lisp_String S which is on the free-list
1503 string_free_list, return a pointer to its successor in the
1506 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1508 /* Return a pointer to the sdata structure belonging to Lisp string S.
1509 S must be live, i.e. S->data must not be null. S->data is actually
1510 a pointer to the `u.data' member of its sdata structure; the
1511 structure starts at a constant offset in front of that. */
1513 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1516 #ifdef GC_CHECK_STRING_OVERRUN
1518 /* We check for overrun in string data blocks by appending a small
1519 "cookie" after each allocated string data block, and check for the
1520 presence of this cookie during GC. */
1522 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1523 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1524 { '\xde', '\xad', '\xbe', '\xef' };
1527 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1530 /* Value is the size of an sdata structure large enough to hold NBYTES
1531 bytes of string data. The value returned includes a terminating
1532 NUL byte, the size of the sdata structure, and padding. */
1534 #ifdef GC_CHECK_STRING_BYTES
1536 #define SDATA_SIZE(NBYTES) \
1537 ((SDATA_DATA_OFFSET \
1539 + sizeof (ptrdiff_t) - 1) \
1540 & ~(sizeof (ptrdiff_t) - 1))
1542 #else /* not GC_CHECK_STRING_BYTES */
1544 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1545 less than the size of that member. The 'max' is not needed when
1546 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1547 alignment code reserves enough space. */
1549 #define SDATA_SIZE(NBYTES) \
1550 ((SDATA_DATA_OFFSET \
1551 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1553 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1555 + sizeof (ptrdiff_t) - 1) \
1556 & ~(sizeof (ptrdiff_t) - 1))
1558 #endif /* not GC_CHECK_STRING_BYTES */
1560 /* Extra bytes to allocate for each string. */
1562 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1564 /* Exact bound on the number of bytes in a string, not counting the
1565 terminating null. A string cannot contain more bytes than
1566 STRING_BYTES_BOUND, nor can it be so long that the size_t
1567 arithmetic in allocate_string_data would overflow while it is
1568 calculating a value to be passed to malloc. */
1569 static ptrdiff_t const STRING_BYTES_MAX
=
1570 min (STRING_BYTES_BOUND
,
1571 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1573 - offsetof (struct sblock
, data
)
1574 - SDATA_DATA_OFFSET
)
1575 & ~(sizeof (EMACS_INT
) - 1)));
1577 /* Initialize string allocation. Called from init_alloc_once. */
1582 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1583 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1587 #ifdef GC_CHECK_STRING_BYTES
1589 static int check_string_bytes_count
;
1591 /* Like STRING_BYTES, but with debugging check. Can be
1592 called during GC, so pay attention to the mark bit. */
1595 string_bytes (struct Lisp_String
*s
)
1598 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1600 if (!PURE_POINTER_P (s
)
1602 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1607 /* Check validity of Lisp strings' string_bytes member in B. */
1610 check_sblock (struct sblock
*b
)
1612 sdata
*from
, *end
, *from_end
;
1616 for (from
= b
->data
; from
< end
; from
= from_end
)
1618 /* Compute the next FROM here because copying below may
1619 overwrite data we need to compute it. */
1622 /* Check that the string size recorded in the string is the
1623 same as the one recorded in the sdata structure. */
1624 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1625 : SDATA_NBYTES (from
));
1626 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1631 /* Check validity of Lisp strings' string_bytes member. ALL_P
1632 means check all strings, otherwise check only most
1633 recently allocated strings. Used for hunting a bug. */
1636 check_string_bytes (bool all_p
)
1642 for (b
= large_sblocks
; b
; b
= b
->next
)
1644 struct Lisp_String
*s
= b
->data
[0].string
;
1649 for (b
= oldest_sblock
; b
; b
= b
->next
)
1652 else if (current_sblock
)
1653 check_sblock (current_sblock
);
1656 #else /* not GC_CHECK_STRING_BYTES */
1658 #define check_string_bytes(all) ((void) 0)
1660 #endif /* GC_CHECK_STRING_BYTES */
1662 #ifdef GC_CHECK_STRING_FREE_LIST
1664 /* Walk through the string free list looking for bogus next pointers.
1665 This may catch buffer overrun from a previous string. */
1668 check_string_free_list (void)
1670 struct Lisp_String
*s
;
1672 /* Pop a Lisp_String off the free-list. */
1673 s
= string_free_list
;
1676 if ((uintptr_t) s
< 1024)
1678 s
= NEXT_FREE_LISP_STRING (s
);
1682 #define check_string_free_list()
1685 /* Return a new Lisp_String. */
1687 static struct Lisp_String
*
1688 allocate_string (void)
1690 struct Lisp_String
*s
;
1694 /* If the free-list is empty, allocate a new string_block, and
1695 add all the Lisp_Strings in it to the free-list. */
1696 if (string_free_list
== NULL
)
1698 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1701 b
->next
= string_blocks
;
1704 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1707 /* Every string on a free list should have NULL data pointer. */
1709 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1710 string_free_list
= s
;
1713 total_free_strings
+= STRING_BLOCK_SIZE
;
1716 check_string_free_list ();
1718 /* Pop a Lisp_String off the free-list. */
1719 s
= string_free_list
;
1720 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1722 MALLOC_UNBLOCK_INPUT
;
1724 --total_free_strings
;
1727 consing_since_gc
+= sizeof *s
;
1729 #ifdef GC_CHECK_STRING_BYTES
1730 if (!noninteractive
)
1732 if (++check_string_bytes_count
== 200)
1734 check_string_bytes_count
= 0;
1735 check_string_bytes (1);
1738 check_string_bytes (0);
1740 #endif /* GC_CHECK_STRING_BYTES */
1746 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1747 plus a NUL byte at the end. Allocate an sdata structure for S, and
1748 set S->data to its `u.data' member. Store a NUL byte at the end of
1749 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1750 S->data if it was initially non-null. */
1753 allocate_string_data (struct Lisp_String
*s
,
1754 EMACS_INT nchars
, EMACS_INT nbytes
)
1756 sdata
*data
, *old_data
;
1758 ptrdiff_t needed
, old_nbytes
;
1760 if (STRING_BYTES_MAX
< nbytes
)
1763 /* Determine the number of bytes needed to store NBYTES bytes
1765 needed
= SDATA_SIZE (nbytes
);
1768 old_data
= SDATA_OF_STRING (s
);
1769 old_nbytes
= STRING_BYTES (s
);
1776 if (nbytes
> LARGE_STRING_BYTES
)
1778 size_t size
= offsetof (struct sblock
, data
) + needed
;
1780 #ifdef DOUG_LEA_MALLOC
1781 if (!mmap_lisp_allowed_p ())
1782 mallopt (M_MMAP_MAX
, 0);
1785 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1787 #ifdef DOUG_LEA_MALLOC
1788 if (!mmap_lisp_allowed_p ())
1789 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1792 b
->next_free
= b
->data
;
1793 b
->data
[0].string
= NULL
;
1794 b
->next
= large_sblocks
;
1797 else if (current_sblock
== NULL
1798 || (((char *) current_sblock
+ SBLOCK_SIZE
1799 - (char *) current_sblock
->next_free
)
1800 < (needed
+ GC_STRING_EXTRA
)))
1802 /* Not enough room in the current sblock. */
1803 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1804 b
->next_free
= b
->data
;
1805 b
->data
[0].string
= NULL
;
1809 current_sblock
->next
= b
;
1817 data
= b
->next_free
;
1818 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1820 MALLOC_UNBLOCK_INPUT
;
1823 s
->data
= SDATA_DATA (data
);
1824 #ifdef GC_CHECK_STRING_BYTES
1825 SDATA_NBYTES (data
) = nbytes
;
1828 s
->size_byte
= nbytes
;
1829 s
->data
[nbytes
] = '\0';
1830 #ifdef GC_CHECK_STRING_OVERRUN
1831 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1832 GC_STRING_OVERRUN_COOKIE_SIZE
);
1835 /* Note that Faset may call to this function when S has already data
1836 assigned. In this case, mark data as free by setting it's string
1837 back-pointer to null, and record the size of the data in it. */
1840 SDATA_NBYTES (old_data
) = old_nbytes
;
1841 old_data
->string
= NULL
;
1844 consing_since_gc
+= needed
;
1848 /* Sweep and compact strings. */
1850 NO_INLINE
/* For better stack traces */
1852 sweep_strings (void)
1854 struct string_block
*b
, *next
;
1855 struct string_block
*live_blocks
= NULL
;
1857 string_free_list
= NULL
;
1858 total_strings
= total_free_strings
= 0;
1859 total_string_bytes
= 0;
1861 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1862 for (b
= string_blocks
; b
; b
= next
)
1865 struct Lisp_String
*free_list_before
= string_free_list
;
1869 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1871 struct Lisp_String
*s
= b
->strings
+ i
;
1875 /* String was not on free-list before. */
1876 if (STRING_MARKED_P (s
))
1878 /* String is live; unmark it and its intervals. */
1881 /* Do not use string_(set|get)_intervals here. */
1882 s
->intervals
= balance_intervals (s
->intervals
);
1885 total_string_bytes
+= STRING_BYTES (s
);
1889 /* String is dead. Put it on the free-list. */
1890 sdata
*data
= SDATA_OF_STRING (s
);
1892 /* Save the size of S in its sdata so that we know
1893 how large that is. Reset the sdata's string
1894 back-pointer so that we know it's free. */
1895 #ifdef GC_CHECK_STRING_BYTES
1896 if (string_bytes (s
) != SDATA_NBYTES (data
))
1899 data
->n
.nbytes
= STRING_BYTES (s
);
1901 data
->string
= NULL
;
1903 /* Reset the strings's `data' member so that we
1907 /* Put the string on the free-list. */
1908 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1909 string_free_list
= s
;
1915 /* S was on the free-list before. Put it there again. */
1916 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1917 string_free_list
= s
;
1922 /* Free blocks that contain free Lisp_Strings only, except
1923 the first two of them. */
1924 if (nfree
== STRING_BLOCK_SIZE
1925 && total_free_strings
> STRING_BLOCK_SIZE
)
1928 string_free_list
= free_list_before
;
1932 total_free_strings
+= nfree
;
1933 b
->next
= live_blocks
;
1938 check_string_free_list ();
1940 string_blocks
= live_blocks
;
1941 free_large_strings ();
1942 compact_small_strings ();
1944 check_string_free_list ();
1948 /* Free dead large strings. */
1951 free_large_strings (void)
1953 struct sblock
*b
, *next
;
1954 struct sblock
*live_blocks
= NULL
;
1956 for (b
= large_sblocks
; b
; b
= next
)
1960 if (b
->data
[0].string
== NULL
)
1964 b
->next
= live_blocks
;
1969 large_sblocks
= live_blocks
;
1973 /* Compact data of small strings. Free sblocks that don't contain
1974 data of live strings after compaction. */
1977 compact_small_strings (void)
1979 struct sblock
*b
, *tb
, *next
;
1980 sdata
*from
, *to
, *end
, *tb_end
;
1981 sdata
*to_end
, *from_end
;
1983 /* TB is the sblock we copy to, TO is the sdata within TB we copy
1984 to, and TB_END is the end of TB. */
1986 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1989 /* Step through the blocks from the oldest to the youngest. We
1990 expect that old blocks will stabilize over time, so that less
1991 copying will happen this way. */
1992 for (b
= oldest_sblock
; b
; b
= b
->next
)
1995 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
1997 for (from
= b
->data
; from
< end
; from
= from_end
)
1999 /* Compute the next FROM here because copying below may
2000 overwrite data we need to compute it. */
2002 struct Lisp_String
*s
= from
->string
;
2004 #ifdef GC_CHECK_STRING_BYTES
2005 /* Check that the string size recorded in the string is the
2006 same as the one recorded in the sdata structure. */
2007 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2009 #endif /* GC_CHECK_STRING_BYTES */
2011 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2012 eassert (nbytes
<= LARGE_STRING_BYTES
);
2014 nbytes
= SDATA_SIZE (nbytes
);
2015 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2017 #ifdef GC_CHECK_STRING_OVERRUN
2018 if (memcmp (string_overrun_cookie
,
2019 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2020 GC_STRING_OVERRUN_COOKIE_SIZE
))
2024 /* Non-NULL S means it's alive. Copy its data. */
2027 /* If TB is full, proceed with the next sblock. */
2028 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2029 if (to_end
> tb_end
)
2033 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2035 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2038 /* Copy, and update the string's `data' pointer. */
2041 eassert (tb
!= b
|| to
< from
);
2042 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2043 to
->string
->data
= SDATA_DATA (to
);
2046 /* Advance past the sdata we copied to. */
2052 /* The rest of the sblocks following TB don't contain live data, so
2053 we can free them. */
2054 for (b
= tb
->next
; b
; b
= next
)
2062 current_sblock
= tb
;
2066 string_overflow (void)
2068 error ("Maximum string size exceeded");
2071 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2072 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2073 LENGTH must be an integer.
2074 INIT must be an integer that represents a character. */)
2075 (Lisp_Object length
, Lisp_Object init
)
2077 register Lisp_Object val
;
2081 CHECK_NATNUM (length
);
2082 CHECK_CHARACTER (init
);
2084 c
= XFASTINT (init
);
2085 if (ASCII_CHAR_P (c
))
2087 nbytes
= XINT (length
);
2088 val
= make_uninit_string (nbytes
);
2089 memset (SDATA (val
), c
, nbytes
);
2090 SDATA (val
)[nbytes
] = 0;
2094 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2095 ptrdiff_t len
= CHAR_STRING (c
, str
);
2096 EMACS_INT string_len
= XINT (length
);
2097 unsigned char *p
, *beg
, *end
;
2099 if (string_len
> STRING_BYTES_MAX
/ len
)
2101 nbytes
= len
* string_len
;
2102 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2103 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2105 /* First time we just copy `str' to the data of `val'. */
2107 memcpy (p
, str
, len
);
2110 /* Next time we copy largest possible chunk from
2111 initialized to uninitialized part of `val'. */
2112 len
= min (p
- beg
, end
- p
);
2113 memcpy (p
, beg
, len
);
2122 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2126 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2128 EMACS_INT nbits
= bool_vector_size (a
);
2131 unsigned char *data
= bool_vector_uchar_data (a
);
2132 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2133 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2134 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2135 memset (data
, pattern
, nbytes
- 1);
2136 data
[nbytes
- 1] = pattern
& last_mask
;
2141 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2144 make_uninit_bool_vector (EMACS_INT nbits
)
2147 EMACS_INT words
= bool_vector_words (nbits
);
2148 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2149 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2152 struct Lisp_Bool_Vector
*p
2153 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2154 XSETVECTOR (val
, p
);
2155 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2158 /* Clear padding at the end. */
2160 p
->data
[words
- 1] = 0;
2165 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2166 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2167 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2168 (Lisp_Object length
, Lisp_Object init
)
2172 CHECK_NATNUM (length
);
2173 val
= make_uninit_bool_vector (XFASTINT (length
));
2174 return bool_vector_fill (val
, init
);
2177 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2178 doc
: /* Return a new bool-vector with specified arguments as elements.
2179 Any number of arguments, even zero arguments, are allowed.
2180 usage: (bool-vector &rest OBJECTS) */)
2181 (ptrdiff_t nargs
, Lisp_Object
*args
)
2186 vector
= make_uninit_bool_vector (nargs
);
2187 for (i
= 0; i
< nargs
; i
++)
2188 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2193 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2194 of characters from the contents. This string may be unibyte or
2195 multibyte, depending on the contents. */
2198 make_string (const char *contents
, ptrdiff_t nbytes
)
2200 register Lisp_Object val
;
2201 ptrdiff_t nchars
, multibyte_nbytes
;
2203 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2204 &nchars
, &multibyte_nbytes
);
2205 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2206 /* CONTENTS contains no multibyte sequences or contains an invalid
2207 multibyte sequence. We must make unibyte string. */
2208 val
= make_unibyte_string (contents
, nbytes
);
2210 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2215 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2218 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2220 register Lisp_Object val
;
2221 val
= make_uninit_string (length
);
2222 memcpy (SDATA (val
), contents
, length
);
2227 /* Make a multibyte string from NCHARS characters occupying NBYTES
2228 bytes at CONTENTS. */
2231 make_multibyte_string (const char *contents
,
2232 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2234 register Lisp_Object val
;
2235 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2236 memcpy (SDATA (val
), contents
, nbytes
);
2241 /* Make a string from NCHARS characters occupying NBYTES bytes at
2242 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2245 make_string_from_bytes (const char *contents
,
2246 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2248 register Lisp_Object val
;
2249 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2250 memcpy (SDATA (val
), contents
, nbytes
);
2251 if (SBYTES (val
) == SCHARS (val
))
2252 STRING_SET_UNIBYTE (val
);
2257 /* Make a string from NCHARS characters occupying NBYTES bytes at
2258 CONTENTS. The argument MULTIBYTE controls whether to label the
2259 string as multibyte. If NCHARS is negative, it counts the number of
2260 characters by itself. */
2263 make_specified_string (const char *contents
,
2264 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2271 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2276 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2277 memcpy (SDATA (val
), contents
, nbytes
);
2279 STRING_SET_UNIBYTE (val
);
2284 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2285 occupying LENGTH bytes. */
2288 make_uninit_string (EMACS_INT length
)
2293 return empty_unibyte_string
;
2294 val
= make_uninit_multibyte_string (length
, length
);
2295 STRING_SET_UNIBYTE (val
);
2300 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2301 which occupy NBYTES bytes. */
2304 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2307 struct Lisp_String
*s
;
2312 return empty_multibyte_string
;
2314 s
= allocate_string ();
2315 s
->intervals
= NULL
;
2316 allocate_string_data (s
, nchars
, nbytes
);
2317 XSETSTRING (string
, s
);
2318 string_chars_consed
+= nbytes
;
2322 /* Print arguments to BUF according to a FORMAT, then return
2323 a Lisp_String initialized with the data from BUF. */
2326 make_formatted_string (char *buf
, const char *format
, ...)
2331 va_start (ap
, format
);
2332 length
= vsprintf (buf
, format
, ap
);
2334 return make_string (buf
, length
);
2338 /***********************************************************************
2340 ***********************************************************************/
2342 /* We store float cells inside of float_blocks, allocating a new
2343 float_block with malloc whenever necessary. Float cells reclaimed
2344 by GC are put on a free list to be reallocated before allocating
2345 any new float cells from the latest float_block. */
2347 #define FLOAT_BLOCK_SIZE \
2348 (((BLOCK_BYTES - sizeof (struct float_block *) \
2349 /* The compiler might add padding at the end. */ \
2350 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2351 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2353 #define GETMARKBIT(block,n) \
2354 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2355 >> ((n) % BITS_PER_BITS_WORD)) \
2358 #define SETMARKBIT(block,n) \
2359 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2360 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2362 #define UNSETMARKBIT(block,n) \
2363 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2364 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2366 #define FLOAT_BLOCK(fptr) \
2367 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2369 #define FLOAT_INDEX(fptr) \
2370 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2374 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2375 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2376 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2377 struct float_block
*next
;
2380 #define FLOAT_MARKED_P(fptr) \
2381 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2383 #define FLOAT_MARK(fptr) \
2384 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2386 #define FLOAT_UNMARK(fptr) \
2387 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2389 /* Current float_block. */
2391 static struct float_block
*float_block
;
2393 /* Index of first unused Lisp_Float in the current float_block. */
2395 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2397 /* Free-list of Lisp_Floats. */
2399 static struct Lisp_Float
*float_free_list
;
2401 /* Return a new float object with value FLOAT_VALUE. */
2404 make_float (double float_value
)
2406 register Lisp_Object val
;
2410 if (float_free_list
)
2412 /* We use the data field for chaining the free list
2413 so that we won't use the same field that has the mark bit. */
2414 XSETFLOAT (val
, float_free_list
);
2415 float_free_list
= float_free_list
->u
.chain
;
2419 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2421 struct float_block
*new
2422 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2423 new->next
= float_block
;
2424 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2426 float_block_index
= 0;
2427 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2429 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2430 float_block_index
++;
2433 MALLOC_UNBLOCK_INPUT
;
2435 XFLOAT_INIT (val
, float_value
);
2436 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2437 consing_since_gc
+= sizeof (struct Lisp_Float
);
2439 total_free_floats
--;
2445 /***********************************************************************
2447 ***********************************************************************/
2449 /* We store cons cells inside of cons_blocks, allocating a new
2450 cons_block with malloc whenever necessary. Cons cells reclaimed by
2451 GC are put on a free list to be reallocated before allocating
2452 any new cons cells from the latest cons_block. */
2454 #define CONS_BLOCK_SIZE \
2455 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2456 /* The compiler might add padding at the end. */ \
2457 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2458 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2460 #define CONS_BLOCK(fptr) \
2461 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2463 #define CONS_INDEX(fptr) \
2464 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2468 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2469 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2470 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2471 struct cons_block
*next
;
2474 #define CONS_MARKED_P(fptr) \
2475 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2477 #define CONS_MARK(fptr) \
2478 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2480 #define CONS_UNMARK(fptr) \
2481 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2483 /* Current cons_block. */
2485 static struct cons_block
*cons_block
;
2487 /* Index of first unused Lisp_Cons in the current block. */
2489 static int cons_block_index
= CONS_BLOCK_SIZE
;
2491 /* Free-list of Lisp_Cons structures. */
2493 static struct Lisp_Cons
*cons_free_list
;
2495 /* Explicitly free a cons cell by putting it on the free-list. */
2498 free_cons (struct Lisp_Cons
*ptr
)
2500 ptr
->u
.chain
= cons_free_list
;
2504 cons_free_list
= ptr
;
2505 consing_since_gc
-= sizeof *ptr
;
2506 total_free_conses
++;
2509 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2510 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2511 (Lisp_Object car
, Lisp_Object cdr
)
2513 register Lisp_Object val
;
2519 /* We use the cdr for chaining the free list
2520 so that we won't use the same field that has the mark bit. */
2521 XSETCONS (val
, cons_free_list
);
2522 cons_free_list
= cons_free_list
->u
.chain
;
2526 if (cons_block_index
== CONS_BLOCK_SIZE
)
2528 struct cons_block
*new
2529 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2530 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2531 new->next
= cons_block
;
2533 cons_block_index
= 0;
2534 total_free_conses
+= CONS_BLOCK_SIZE
;
2536 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2540 MALLOC_UNBLOCK_INPUT
;
2544 eassert (!CONS_MARKED_P (XCONS (val
)));
2545 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2546 total_free_conses
--;
2547 cons_cells_consed
++;
2551 #ifdef GC_CHECK_CONS_LIST
2552 /* Get an error now if there's any junk in the cons free list. */
2554 check_cons_list (void)
2556 struct Lisp_Cons
*tail
= cons_free_list
;
2559 tail
= tail
->u
.chain
;
2563 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2566 list1 (Lisp_Object arg1
)
2568 return Fcons (arg1
, Qnil
);
2572 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2574 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2579 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2581 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2586 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2588 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2593 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2595 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2596 Fcons (arg5
, Qnil
)))));
2599 /* Make a list of COUNT Lisp_Objects, where ARG is the
2600 first one. Allocate conses from pure space if TYPE
2601 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2604 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2608 Lisp_Object val
, *objp
;
2610 /* Change to SAFE_ALLOCA if you hit this eassert. */
2611 eassert (count
<= MAX_ALLOCA
/ word_size
);
2613 objp
= alloca (count
* word_size
);
2616 for (i
= 1; i
< count
; i
++)
2617 objp
[i
] = va_arg (ap
, Lisp_Object
);
2620 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2622 if (type
== CONSTYPE_PURE
)
2623 val
= pure_cons (objp
[i
], val
);
2624 else if (type
== CONSTYPE_HEAP
)
2625 val
= Fcons (objp
[i
], val
);
2632 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2633 doc
: /* Return a newly created list with specified arguments as elements.
2634 Any number of arguments, even zero arguments, are allowed.
2635 usage: (list &rest OBJECTS) */)
2636 (ptrdiff_t nargs
, Lisp_Object
*args
)
2638 register Lisp_Object val
;
2644 val
= Fcons (args
[nargs
], val
);
2650 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2651 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2652 (register Lisp_Object length
, Lisp_Object init
)
2654 register Lisp_Object val
;
2655 register EMACS_INT size
;
2657 CHECK_NATNUM (length
);
2658 size
= XFASTINT (length
);
2663 val
= Fcons (init
, val
);
2668 val
= Fcons (init
, val
);
2673 val
= Fcons (init
, val
);
2678 val
= Fcons (init
, val
);
2683 val
= Fcons (init
, val
);
2698 /***********************************************************************
2700 ***********************************************************************/
2702 /* Sometimes a vector's contents are merely a pointer internally used
2703 in vector allocation code. On the rare platforms where a null
2704 pointer cannot be tagged, represent it with a Lisp 0.
2705 Usually you don't want to touch this. */
2707 static struct Lisp_Vector
*
2708 next_vector (struct Lisp_Vector
*v
)
2710 return XUNTAG (v
->contents
[0], 0);
2714 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2716 v
->contents
[0] = make_lisp_ptr (p
, 0);
2719 /* This value is balanced well enough to avoid too much internal overhead
2720 for the most common cases; it's not required to be a power of two, but
2721 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2723 #define VECTOR_BLOCK_SIZE 4096
2727 /* Alignment of struct Lisp_Vector objects. */
2728 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2729 USE_LSB_TAG
? GCALIGNMENT
: 1),
2731 /* Vector size requests are a multiple of this. */
2732 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2735 /* Verify assumptions described above. */
2736 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2737 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2739 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2740 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2741 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2742 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2744 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2746 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2748 /* Size of the minimal vector allocated from block. */
2750 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2752 /* Size of the largest vector allocated from block. */
2754 #define VBLOCK_BYTES_MAX \
2755 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2757 /* We maintain one free list for each possible block-allocated
2758 vector size, and this is the number of free lists we have. */
2760 #define VECTOR_MAX_FREE_LIST_INDEX \
2761 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2763 /* Common shortcut to advance vector pointer over a block data. */
2765 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2767 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2769 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2771 /* Common shortcut to setup vector on a free list. */
2773 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2775 (tmp) = ((nbytes - header_size) / word_size); \
2776 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2777 eassert ((nbytes) % roundup_size == 0); \
2778 (tmp) = VINDEX (nbytes); \
2779 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2780 set_next_vector (v, vector_free_lists[tmp]); \
2781 vector_free_lists[tmp] = (v); \
2782 total_free_vector_slots += (nbytes) / word_size; \
2785 /* This internal type is used to maintain the list of large vectors
2786 which are allocated at their own, e.g. outside of vector blocks.
2788 struct large_vector itself cannot contain a struct Lisp_Vector, as
2789 the latter contains a flexible array member and C99 does not allow
2790 such structs to be nested. Instead, each struct large_vector
2791 object LV is followed by a struct Lisp_Vector, which is at offset
2792 large_vector_offset from LV, and whose address is therefore
2793 large_vector_vec (&LV). */
2797 struct large_vector
*next
;
2802 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2805 static struct Lisp_Vector
*
2806 large_vector_vec (struct large_vector
*p
)
2808 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
2811 /* This internal type is used to maintain an underlying storage
2812 for small vectors. */
2816 char data
[VECTOR_BLOCK_BYTES
];
2817 struct vector_block
*next
;
2820 /* Chain of vector blocks. */
2822 static struct vector_block
*vector_blocks
;
2824 /* Vector free lists, where NTH item points to a chain of free
2825 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2827 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2829 /* Singly-linked list of large vectors. */
2831 static struct large_vector
*large_vectors
;
2833 /* The only vector with 0 slots, allocated from pure space. */
2835 Lisp_Object zero_vector
;
2837 /* Number of live vectors. */
2839 static EMACS_INT total_vectors
;
2841 /* Total size of live and free vectors, in Lisp_Object units. */
2843 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2845 /* Get a new vector block. */
2847 static struct vector_block
*
2848 allocate_vector_block (void)
2850 struct vector_block
*block
= xmalloc (sizeof *block
);
2852 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2853 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2854 MEM_TYPE_VECTOR_BLOCK
);
2857 block
->next
= vector_blocks
;
2858 vector_blocks
= block
;
2862 /* Called once to initialize vector allocation. */
2867 zero_vector
= make_pure_vector (0);
2870 /* Allocate vector from a vector block. */
2872 static struct Lisp_Vector
*
2873 allocate_vector_from_block (size_t nbytes
)
2875 struct Lisp_Vector
*vector
;
2876 struct vector_block
*block
;
2877 size_t index
, restbytes
;
2879 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2880 eassert (nbytes
% roundup_size
== 0);
2882 /* First, try to allocate from a free list
2883 containing vectors of the requested size. */
2884 index
= VINDEX (nbytes
);
2885 if (vector_free_lists
[index
])
2887 vector
= vector_free_lists
[index
];
2888 vector_free_lists
[index
] = next_vector (vector
);
2889 total_free_vector_slots
-= nbytes
/ word_size
;
2893 /* Next, check free lists containing larger vectors. Since
2894 we will split the result, we should have remaining space
2895 large enough to use for one-slot vector at least. */
2896 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
2897 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
2898 if (vector_free_lists
[index
])
2900 /* This vector is larger than requested. */
2901 vector
= vector_free_lists
[index
];
2902 vector_free_lists
[index
] = next_vector (vector
);
2903 total_free_vector_slots
-= nbytes
/ word_size
;
2905 /* Excess bytes are used for the smaller vector,
2906 which should be set on an appropriate free list. */
2907 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
2908 eassert (restbytes
% roundup_size
== 0);
2909 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2913 /* Finally, need a new vector block. */
2914 block
= allocate_vector_block ();
2916 /* New vector will be at the beginning of this block. */
2917 vector
= (struct Lisp_Vector
*) block
->data
;
2919 /* If the rest of space from this block is large enough
2920 for one-slot vector at least, set up it on a free list. */
2921 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
2922 if (restbytes
>= VBLOCK_BYTES_MIN
)
2924 eassert (restbytes
% roundup_size
== 0);
2925 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2930 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
2932 #define VECTOR_IN_BLOCK(vector, block) \
2933 ((char *) (vector) <= (block)->data \
2934 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
2936 /* Return the memory footprint of V in bytes. */
2939 vector_nbytes (struct Lisp_Vector
*v
)
2941 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
2944 if (size
& PSEUDOVECTOR_FLAG
)
2946 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
2948 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
2949 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
2950 * sizeof (bits_word
));
2951 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
2952 verify (header_size
<= bool_header_size
);
2953 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
2956 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
2957 + ((size
& PSEUDOVECTOR_REST_MASK
)
2958 >> PSEUDOVECTOR_SIZE_BITS
));
2962 return vroundup (header_size
+ word_size
* nwords
);
2965 /* Release extra resources still in use by VECTOR, which may be any
2966 vector-like object. For now, this is used just to free data in
2970 cleanup_vector (struct Lisp_Vector
*vector
)
2972 detect_suspicious_free (vector
);
2973 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
2974 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
2975 == FONT_OBJECT_MAX
))
2977 /* Attempt to catch subtle bugs like Bug#16140. */
2978 eassert (valid_font_driver (((struct font
*) vector
)->driver
));
2979 ((struct font
*) vector
)->driver
->close ((struct font
*) vector
);
2983 /* Reclaim space used by unmarked vectors. */
2985 NO_INLINE
/* For better stack traces */
2987 sweep_vectors (void)
2989 struct vector_block
*block
, **bprev
= &vector_blocks
;
2990 struct large_vector
*lv
, **lvprev
= &large_vectors
;
2991 struct Lisp_Vector
*vector
, *next
;
2993 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
2994 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
2996 /* Looking through vector blocks. */
2998 for (block
= vector_blocks
; block
; block
= *bprev
)
3000 bool free_this_block
= 0;
3003 for (vector
= (struct Lisp_Vector
*) block
->data
;
3004 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3006 if (VECTOR_MARKED_P (vector
))
3008 VECTOR_UNMARK (vector
);
3010 nbytes
= vector_nbytes (vector
);
3011 total_vector_slots
+= nbytes
/ word_size
;
3012 next
= ADVANCE (vector
, nbytes
);
3016 ptrdiff_t total_bytes
;
3018 cleanup_vector (vector
);
3019 nbytes
= vector_nbytes (vector
);
3020 total_bytes
= nbytes
;
3021 next
= ADVANCE (vector
, nbytes
);
3023 /* While NEXT is not marked, try to coalesce with VECTOR,
3024 thus making VECTOR of the largest possible size. */
3026 while (VECTOR_IN_BLOCK (next
, block
))
3028 if (VECTOR_MARKED_P (next
))
3030 cleanup_vector (next
);
3031 nbytes
= vector_nbytes (next
);
3032 total_bytes
+= nbytes
;
3033 next
= ADVANCE (next
, nbytes
);
3036 eassert (total_bytes
% roundup_size
== 0);
3038 if (vector
== (struct Lisp_Vector
*) block
->data
3039 && !VECTOR_IN_BLOCK (next
, block
))
3040 /* This block should be freed because all of its
3041 space was coalesced into the only free vector. */
3042 free_this_block
= 1;
3046 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3051 if (free_this_block
)
3053 *bprev
= block
->next
;
3054 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3055 mem_delete (mem_find (block
->data
));
3060 bprev
= &block
->next
;
3063 /* Sweep large vectors. */
3065 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
3067 vector
= large_vector_vec (lv
);
3068 if (VECTOR_MARKED_P (vector
))
3070 VECTOR_UNMARK (vector
);
3072 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3074 /* All non-bool pseudovectors are small enough to be allocated
3075 from vector blocks. This code should be redesigned if some
3076 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3077 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3078 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3082 += header_size
/ word_size
+ vector
->header
.size
;
3093 /* Value is a pointer to a newly allocated Lisp_Vector structure
3094 with room for LEN Lisp_Objects. */
3096 static struct Lisp_Vector
*
3097 allocate_vectorlike (ptrdiff_t len
)
3099 struct Lisp_Vector
*p
;
3104 p
= XVECTOR (zero_vector
);
3107 size_t nbytes
= header_size
+ len
* word_size
;
3109 #ifdef DOUG_LEA_MALLOC
3110 if (!mmap_lisp_allowed_p ())
3111 mallopt (M_MMAP_MAX
, 0);
3114 if (nbytes
<= VBLOCK_BYTES_MAX
)
3115 p
= allocate_vector_from_block (vroundup (nbytes
));
3118 struct large_vector
*lv
3119 = lisp_malloc ((large_vector_offset
+ header_size
3121 MEM_TYPE_VECTORLIKE
);
3122 lv
->next
= large_vectors
;
3124 p
= large_vector_vec (lv
);
3127 #ifdef DOUG_LEA_MALLOC
3128 if (!mmap_lisp_allowed_p ())
3129 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3132 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3135 consing_since_gc
+= nbytes
;
3136 vector_cells_consed
+= len
;
3139 MALLOC_UNBLOCK_INPUT
;
3145 /* Allocate a vector with LEN slots. */
3147 struct Lisp_Vector
*
3148 allocate_vector (EMACS_INT len
)
3150 struct Lisp_Vector
*v
;
3151 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3153 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3154 memory_full (SIZE_MAX
);
3155 v
= allocate_vectorlike (len
);
3156 v
->header
.size
= len
;
3161 /* Allocate other vector-like structures. */
3163 struct Lisp_Vector
*
3164 allocate_pseudovector (int memlen
, int lisplen
, enum pvec_type tag
)
3166 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3169 /* Catch bogus values. */
3170 eassert (tag
<= PVEC_FONT
);
3171 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3172 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3174 /* Only the first lisplen slots will be traced normally by the GC. */
3175 for (i
= 0; i
< lisplen
; ++i
)
3176 v
->contents
[i
] = Qnil
;
3178 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3183 allocate_buffer (void)
3185 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3187 BUFFER_PVEC_INIT (b
);
3188 /* Put B on the chain of all buffers including killed ones. */
3189 b
->next
= all_buffers
;
3191 /* Note that the rest fields of B are not initialized. */
3195 struct Lisp_Hash_Table
*
3196 allocate_hash_table (void)
3198 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3202 allocate_window (void)
3206 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3207 /* Users assumes that non-Lisp data is zeroed. */
3208 memset (&w
->current_matrix
, 0,
3209 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3214 allocate_terminal (void)
3218 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3219 /* Users assumes that non-Lisp data is zeroed. */
3220 memset (&t
->next_terminal
, 0,
3221 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3226 allocate_frame (void)
3230 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3231 /* Users assumes that non-Lisp data is zeroed. */
3232 memset (&f
->face_cache
, 0,
3233 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3237 struct Lisp_Process
*
3238 allocate_process (void)
3240 struct Lisp_Process
*p
;
3242 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3243 /* Users assumes that non-Lisp data is zeroed. */
3245 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3249 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3250 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3251 See also the function `vector'. */)
3252 (register Lisp_Object length
, Lisp_Object init
)
3255 register ptrdiff_t sizei
;
3256 register ptrdiff_t i
;
3257 register struct Lisp_Vector
*p
;
3259 CHECK_NATNUM (length
);
3261 p
= allocate_vector (XFASTINT (length
));
3262 sizei
= XFASTINT (length
);
3263 for (i
= 0; i
< sizei
; i
++)
3264 p
->contents
[i
] = init
;
3266 XSETVECTOR (vector
, p
);
3271 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3272 doc
: /* Return a newly created vector with specified arguments as elements.
3273 Any number of arguments, even zero arguments, are allowed.
3274 usage: (vector &rest OBJECTS) */)
3275 (ptrdiff_t nargs
, Lisp_Object
*args
)
3278 register Lisp_Object val
= make_uninit_vector (nargs
);
3279 register struct Lisp_Vector
*p
= XVECTOR (val
);
3281 for (i
= 0; i
< nargs
; i
++)
3282 p
->contents
[i
] = args
[i
];
3287 make_byte_code (struct Lisp_Vector
*v
)
3289 /* Don't allow the global zero_vector to become a byte code object. */
3290 eassert (0 < v
->header
.size
);
3292 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3293 && STRING_MULTIBYTE (v
->contents
[1]))
3294 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3295 earlier because they produced a raw 8-bit string for byte-code
3296 and now such a byte-code string is loaded as multibyte while
3297 raw 8-bit characters converted to multibyte form. Thus, now we
3298 must convert them back to the original unibyte form. */
3299 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3300 XSETPVECTYPE (v
, PVEC_COMPILED
);
3303 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3304 doc
: /* Create a byte-code object with specified arguments as elements.
3305 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3306 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3307 and (optional) INTERACTIVE-SPEC.
3308 The first four arguments are required; at most six have any
3310 The ARGLIST can be either like the one of `lambda', in which case the arguments
3311 will be dynamically bound before executing the byte code, or it can be an
3312 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3313 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3314 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3315 argument to catch the left-over arguments. If such an integer is used, the
3316 arguments will not be dynamically bound but will be instead pushed on the
3317 stack before executing the byte-code.
3318 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3319 (ptrdiff_t nargs
, Lisp_Object
*args
)
3322 register Lisp_Object val
= make_uninit_vector (nargs
);
3323 register struct Lisp_Vector
*p
= XVECTOR (val
);
3325 /* We used to purecopy everything here, if purify-flag was set. This worked
3326 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3327 dangerous, since make-byte-code is used during execution to build
3328 closures, so any closure built during the preload phase would end up
3329 copied into pure space, including its free variables, which is sometimes
3330 just wasteful and other times plainly wrong (e.g. those free vars may want
3333 for (i
= 0; i
< nargs
; i
++)
3334 p
->contents
[i
] = args
[i
];
3336 XSETCOMPILED (val
, p
);
3342 /***********************************************************************
3344 ***********************************************************************/
3346 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3347 of the required alignment if LSB tags are used. */
3349 union aligned_Lisp_Symbol
3351 struct Lisp_Symbol s
;
3353 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3358 /* Each symbol_block is just under 1020 bytes long, since malloc
3359 really allocates in units of powers of two and uses 4 bytes for its
3362 #define SYMBOL_BLOCK_SIZE \
3363 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3367 /* Place `symbols' first, to preserve alignment. */
3368 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3369 struct symbol_block
*next
;
3372 /* Current symbol block and index of first unused Lisp_Symbol
3375 static struct symbol_block
*symbol_block
;
3376 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3377 /* Pointer to the first symbol_block that contains pinned symbols.
3378 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3379 10K of which are pinned (and all but 250 of them are interned in obarray),
3380 whereas a "typical session" has in the order of 30K symbols.
3381 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3382 than 30K to find the 10K symbols we need to mark. */
3383 static struct symbol_block
*symbol_block_pinned
;
3385 /* List of free symbols. */
3387 static struct Lisp_Symbol
*symbol_free_list
;
3390 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3392 XSYMBOL (sym
)->name
= name
;
3395 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3396 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3397 Its value is void, and its function definition and property list are nil. */)
3400 register Lisp_Object val
;
3401 register struct Lisp_Symbol
*p
;
3403 CHECK_STRING (name
);
3407 if (symbol_free_list
)
3409 XSETSYMBOL (val
, symbol_free_list
);
3410 symbol_free_list
= symbol_free_list
->next
;
3414 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3416 struct symbol_block
*new
3417 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3418 new->next
= symbol_block
;
3420 symbol_block_index
= 0;
3421 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3423 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3424 symbol_block_index
++;
3427 MALLOC_UNBLOCK_INPUT
;
3430 set_symbol_name (val
, name
);
3431 set_symbol_plist (val
, Qnil
);
3432 p
->redirect
= SYMBOL_PLAINVAL
;
3433 SET_SYMBOL_VAL (p
, Qunbound
);
3434 set_symbol_function (val
, Qnil
);
3435 set_symbol_next (val
, NULL
);
3436 p
->gcmarkbit
= false;
3437 p
->interned
= SYMBOL_UNINTERNED
;
3439 p
->declared_special
= false;
3441 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3443 total_free_symbols
--;
3449 /***********************************************************************
3450 Marker (Misc) Allocation
3451 ***********************************************************************/
3453 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3454 the required alignment when LSB tags are used. */
3456 union aligned_Lisp_Misc
3460 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3465 /* Allocation of markers and other objects that share that structure.
3466 Works like allocation of conses. */
3468 #define MARKER_BLOCK_SIZE \
3469 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3473 /* Place `markers' first, to preserve alignment. */
3474 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3475 struct marker_block
*next
;
3478 static struct marker_block
*marker_block
;
3479 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3481 static union Lisp_Misc
*marker_free_list
;
3483 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3486 allocate_misc (enum Lisp_Misc_Type type
)
3492 if (marker_free_list
)
3494 XSETMISC (val
, marker_free_list
);
3495 marker_free_list
= marker_free_list
->u_free
.chain
;
3499 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3501 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3502 new->next
= marker_block
;
3504 marker_block_index
= 0;
3505 total_free_markers
+= MARKER_BLOCK_SIZE
;
3507 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3508 marker_block_index
++;
3511 MALLOC_UNBLOCK_INPUT
;
3513 --total_free_markers
;
3514 consing_since_gc
+= sizeof (union Lisp_Misc
);
3515 misc_objects_consed
++;
3516 XMISCANY (val
)->type
= type
;
3517 XMISCANY (val
)->gcmarkbit
= 0;
3521 /* Free a Lisp_Misc object. */
3524 free_misc (Lisp_Object misc
)
3526 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3527 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3528 marker_free_list
= XMISC (misc
);
3529 consing_since_gc
-= sizeof (union Lisp_Misc
);
3530 total_free_markers
++;
3533 /* Verify properties of Lisp_Save_Value's representation
3534 that are assumed here and elsewhere. */
3536 verify (SAVE_UNUSED
== 0);
3537 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3541 /* Return Lisp_Save_Value objects for the various combinations
3542 that callers need. */
3545 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3547 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3548 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3549 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3550 p
->data
[0].integer
= a
;
3551 p
->data
[1].integer
= b
;
3552 p
->data
[2].integer
= c
;
3557 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3560 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3561 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3562 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3563 p
->data
[0].object
= a
;
3564 p
->data
[1].object
= b
;
3565 p
->data
[2].object
= c
;
3566 p
->data
[3].object
= d
;
3571 make_save_ptr (void *a
)
3573 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3574 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3575 p
->save_type
= SAVE_POINTER
;
3576 p
->data
[0].pointer
= a
;
3581 make_save_ptr_int (void *a
, ptrdiff_t b
)
3583 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3584 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3585 p
->save_type
= SAVE_TYPE_PTR_INT
;
3586 p
->data
[0].pointer
= a
;
3587 p
->data
[1].integer
= b
;
3591 #if ! (defined USE_X_TOOLKIT || defined USE_GTK)
3593 make_save_ptr_ptr (void *a
, void *b
)
3595 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3596 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3597 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3598 p
->data
[0].pointer
= a
;
3599 p
->data
[1].pointer
= b
;
3605 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3607 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3608 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3609 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3610 p
->data
[0].funcpointer
= a
;
3611 p
->data
[1].pointer
= b
;
3612 p
->data
[2].object
= c
;
3616 /* Return a Lisp_Save_Value object that represents an array A
3617 of N Lisp objects. */
3620 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3622 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3623 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3624 p
->save_type
= SAVE_TYPE_MEMORY
;
3625 p
->data
[0].pointer
= a
;
3626 p
->data
[1].integer
= n
;
3630 /* Free a Lisp_Save_Value object. Do not use this function
3631 if SAVE contains pointer other than returned by xmalloc. */
3634 free_save_value (Lisp_Object save
)
3636 xfree (XSAVE_POINTER (save
, 0));
3640 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3643 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3645 register Lisp_Object overlay
;
3647 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3648 OVERLAY_START (overlay
) = start
;
3649 OVERLAY_END (overlay
) = end
;
3650 set_overlay_plist (overlay
, plist
);
3651 XOVERLAY (overlay
)->next
= NULL
;
3655 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3656 doc
: /* Return a newly allocated marker which does not point at any place. */)
3659 register Lisp_Object val
;
3660 register struct Lisp_Marker
*p
;
3662 val
= allocate_misc (Lisp_Misc_Marker
);
3668 p
->insertion_type
= 0;
3669 p
->need_adjustment
= 0;
3673 /* Return a newly allocated marker which points into BUF
3674 at character position CHARPOS and byte position BYTEPOS. */
3677 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3680 struct Lisp_Marker
*m
;
3682 /* No dead buffers here. */
3683 eassert (BUFFER_LIVE_P (buf
));
3685 /* Every character is at least one byte. */
3686 eassert (charpos
<= bytepos
);
3688 obj
= allocate_misc (Lisp_Misc_Marker
);
3691 m
->charpos
= charpos
;
3692 m
->bytepos
= bytepos
;
3693 m
->insertion_type
= 0;
3694 m
->need_adjustment
= 0;
3695 m
->next
= BUF_MARKERS (buf
);
3696 BUF_MARKERS (buf
) = m
;
3700 /* Put MARKER back on the free list after using it temporarily. */
3703 free_marker (Lisp_Object marker
)
3705 unchain_marker (XMARKER (marker
));
3710 /* Return a newly created vector or string with specified arguments as
3711 elements. If all the arguments are characters that can fit
3712 in a string of events, make a string; otherwise, make a vector.
3714 Any number of arguments, even zero arguments, are allowed. */
3717 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3721 for (i
= 0; i
< nargs
; i
++)
3722 /* The things that fit in a string
3723 are characters that are in 0...127,
3724 after discarding the meta bit and all the bits above it. */
3725 if (!INTEGERP (args
[i
])
3726 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3727 return Fvector (nargs
, args
);
3729 /* Since the loop exited, we know that all the things in it are
3730 characters, so we can make a string. */
3734 result
= Fmake_string (make_number (nargs
), make_number (0));
3735 for (i
= 0; i
< nargs
; i
++)
3737 SSET (result
, i
, XINT (args
[i
]));
3738 /* Move the meta bit to the right place for a string char. */
3739 if (XINT (args
[i
]) & CHAR_META
)
3740 SSET (result
, i
, SREF (result
, i
) | 0x80);
3749 /************************************************************************
3750 Memory Full Handling
3751 ************************************************************************/
3754 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3755 there may have been size_t overflow so that malloc was never
3756 called, or perhaps malloc was invoked successfully but the
3757 resulting pointer had problems fitting into a tagged EMACS_INT. In
3758 either case this counts as memory being full even though malloc did
3762 memory_full (size_t nbytes
)
3764 /* Do not go into hysterics merely because a large request failed. */
3765 bool enough_free_memory
= 0;
3766 if (SPARE_MEMORY
< nbytes
)
3771 p
= malloc (SPARE_MEMORY
);
3775 enough_free_memory
= 1;
3777 MALLOC_UNBLOCK_INPUT
;
3780 if (! enough_free_memory
)
3786 memory_full_cons_threshold
= sizeof (struct cons_block
);
3788 /* The first time we get here, free the spare memory. */
3789 for (i
= 0; i
< ARRAYELTS (spare_memory
); i
++)
3790 if (spare_memory
[i
])
3793 free (spare_memory
[i
]);
3794 else if (i
>= 1 && i
<= 4)
3795 lisp_align_free (spare_memory
[i
]);
3797 lisp_free (spare_memory
[i
]);
3798 spare_memory
[i
] = 0;
3802 /* This used to call error, but if we've run out of memory, we could
3803 get infinite recursion trying to build the string. */
3804 xsignal (Qnil
, Vmemory_signal_data
);
3807 /* If we released our reserve (due to running out of memory),
3808 and we have a fair amount free once again,
3809 try to set aside another reserve in case we run out once more.
3811 This is called when a relocatable block is freed in ralloc.c,
3812 and also directly from this file, in case we're not using ralloc.c. */
3815 refill_memory_reserve (void)
3817 #ifndef SYSTEM_MALLOC
3818 if (spare_memory
[0] == 0)
3819 spare_memory
[0] = malloc (SPARE_MEMORY
);
3820 if (spare_memory
[1] == 0)
3821 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3823 if (spare_memory
[2] == 0)
3824 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3826 if (spare_memory
[3] == 0)
3827 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3829 if (spare_memory
[4] == 0)
3830 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3832 if (spare_memory
[5] == 0)
3833 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3835 if (spare_memory
[6] == 0)
3836 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3838 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3839 Vmemory_full
= Qnil
;
3843 /************************************************************************
3845 ************************************************************************/
3847 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3849 /* Conservative C stack marking requires a method to identify possibly
3850 live Lisp objects given a pointer value. We do this by keeping
3851 track of blocks of Lisp data that are allocated in a red-black tree
3852 (see also the comment of mem_node which is the type of nodes in
3853 that tree). Function lisp_malloc adds information for an allocated
3854 block to the red-black tree with calls to mem_insert, and function
3855 lisp_free removes it with mem_delete. Functions live_string_p etc
3856 call mem_find to lookup information about a given pointer in the
3857 tree, and use that to determine if the pointer points to a Lisp
3860 /* Initialize this part of alloc.c. */
3865 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3866 mem_z
.parent
= NULL
;
3867 mem_z
.color
= MEM_BLACK
;
3868 mem_z
.start
= mem_z
.end
= NULL
;
3873 /* Value is a pointer to the mem_node containing START. Value is
3874 MEM_NIL if there is no node in the tree containing START. */
3876 static struct mem_node
*
3877 mem_find (void *start
)
3881 if (start
< min_heap_address
|| start
> max_heap_address
)
3884 /* Make the search always successful to speed up the loop below. */
3885 mem_z
.start
= start
;
3886 mem_z
.end
= (char *) start
+ 1;
3889 while (start
< p
->start
|| start
>= p
->end
)
3890 p
= start
< p
->start
? p
->left
: p
->right
;
3895 /* Insert a new node into the tree for a block of memory with start
3896 address START, end address END, and type TYPE. Value is a
3897 pointer to the node that was inserted. */
3899 static struct mem_node
*
3900 mem_insert (void *start
, void *end
, enum mem_type type
)
3902 struct mem_node
*c
, *parent
, *x
;
3904 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3905 min_heap_address
= start
;
3906 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3907 max_heap_address
= end
;
3909 /* See where in the tree a node for START belongs. In this
3910 particular application, it shouldn't happen that a node is already
3911 present. For debugging purposes, let's check that. */
3915 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3917 while (c
!= MEM_NIL
)
3919 if (start
>= c
->start
&& start
< c
->end
)
3922 c
= start
< c
->start
? c
->left
: c
->right
;
3925 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3927 while (c
!= MEM_NIL
)
3930 c
= start
< c
->start
? c
->left
: c
->right
;
3933 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3935 /* Create a new node. */
3936 #ifdef GC_MALLOC_CHECK
3937 x
= malloc (sizeof *x
);
3941 x
= xmalloc (sizeof *x
);
3947 x
->left
= x
->right
= MEM_NIL
;
3950 /* Insert it as child of PARENT or install it as root. */
3953 if (start
< parent
->start
)
3961 /* Re-establish red-black tree properties. */
3962 mem_insert_fixup (x
);
3968 /* Re-establish the red-black properties of the tree, and thereby
3969 balance the tree, after node X has been inserted; X is always red. */
3972 mem_insert_fixup (struct mem_node
*x
)
3974 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3976 /* X is red and its parent is red. This is a violation of
3977 red-black tree property #3. */
3979 if (x
->parent
== x
->parent
->parent
->left
)
3981 /* We're on the left side of our grandparent, and Y is our
3983 struct mem_node
*y
= x
->parent
->parent
->right
;
3985 if (y
->color
== MEM_RED
)
3987 /* Uncle and parent are red but should be black because
3988 X is red. Change the colors accordingly and proceed
3989 with the grandparent. */
3990 x
->parent
->color
= MEM_BLACK
;
3991 y
->color
= MEM_BLACK
;
3992 x
->parent
->parent
->color
= MEM_RED
;
3993 x
= x
->parent
->parent
;
3997 /* Parent and uncle have different colors; parent is
3998 red, uncle is black. */
3999 if (x
== x
->parent
->right
)
4002 mem_rotate_left (x
);
4005 x
->parent
->color
= MEM_BLACK
;
4006 x
->parent
->parent
->color
= MEM_RED
;
4007 mem_rotate_right (x
->parent
->parent
);
4012 /* This is the symmetrical case of above. */
4013 struct mem_node
*y
= x
->parent
->parent
->left
;
4015 if (y
->color
== MEM_RED
)
4017 x
->parent
->color
= MEM_BLACK
;
4018 y
->color
= MEM_BLACK
;
4019 x
->parent
->parent
->color
= MEM_RED
;
4020 x
= x
->parent
->parent
;
4024 if (x
== x
->parent
->left
)
4027 mem_rotate_right (x
);
4030 x
->parent
->color
= MEM_BLACK
;
4031 x
->parent
->parent
->color
= MEM_RED
;
4032 mem_rotate_left (x
->parent
->parent
);
4037 /* The root may have been changed to red due to the algorithm. Set
4038 it to black so that property #5 is satisfied. */
4039 mem_root
->color
= MEM_BLACK
;
4050 mem_rotate_left (struct mem_node
*x
)
4054 /* Turn y's left sub-tree into x's right sub-tree. */
4057 if (y
->left
!= MEM_NIL
)
4058 y
->left
->parent
= x
;
4060 /* Y's parent was x's parent. */
4062 y
->parent
= x
->parent
;
4064 /* Get the parent to point to y instead of x. */
4067 if (x
== x
->parent
->left
)
4068 x
->parent
->left
= y
;
4070 x
->parent
->right
= y
;
4075 /* Put x on y's left. */
4089 mem_rotate_right (struct mem_node
*x
)
4091 struct mem_node
*y
= x
->left
;
4094 if (y
->right
!= MEM_NIL
)
4095 y
->right
->parent
= x
;
4098 y
->parent
= x
->parent
;
4101 if (x
== x
->parent
->right
)
4102 x
->parent
->right
= y
;
4104 x
->parent
->left
= y
;
4115 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4118 mem_delete (struct mem_node
*z
)
4120 struct mem_node
*x
, *y
;
4122 if (!z
|| z
== MEM_NIL
)
4125 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4130 while (y
->left
!= MEM_NIL
)
4134 if (y
->left
!= MEM_NIL
)
4139 x
->parent
= y
->parent
;
4142 if (y
== y
->parent
->left
)
4143 y
->parent
->left
= x
;
4145 y
->parent
->right
= x
;
4152 z
->start
= y
->start
;
4157 if (y
->color
== MEM_BLACK
)
4158 mem_delete_fixup (x
);
4160 #ifdef GC_MALLOC_CHECK
4168 /* Re-establish the red-black properties of the tree, after a
4172 mem_delete_fixup (struct mem_node
*x
)
4174 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4176 if (x
== x
->parent
->left
)
4178 struct mem_node
*w
= x
->parent
->right
;
4180 if (w
->color
== MEM_RED
)
4182 w
->color
= MEM_BLACK
;
4183 x
->parent
->color
= MEM_RED
;
4184 mem_rotate_left (x
->parent
);
4185 w
= x
->parent
->right
;
4188 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4195 if (w
->right
->color
== MEM_BLACK
)
4197 w
->left
->color
= MEM_BLACK
;
4199 mem_rotate_right (w
);
4200 w
= x
->parent
->right
;
4202 w
->color
= x
->parent
->color
;
4203 x
->parent
->color
= MEM_BLACK
;
4204 w
->right
->color
= MEM_BLACK
;
4205 mem_rotate_left (x
->parent
);
4211 struct mem_node
*w
= x
->parent
->left
;
4213 if (w
->color
== MEM_RED
)
4215 w
->color
= MEM_BLACK
;
4216 x
->parent
->color
= MEM_RED
;
4217 mem_rotate_right (x
->parent
);
4218 w
= x
->parent
->left
;
4221 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4228 if (w
->left
->color
== MEM_BLACK
)
4230 w
->right
->color
= MEM_BLACK
;
4232 mem_rotate_left (w
);
4233 w
= x
->parent
->left
;
4236 w
->color
= x
->parent
->color
;
4237 x
->parent
->color
= MEM_BLACK
;
4238 w
->left
->color
= MEM_BLACK
;
4239 mem_rotate_right (x
->parent
);
4245 x
->color
= MEM_BLACK
;
4249 /* Value is non-zero if P is a pointer to a live Lisp string on
4250 the heap. M is a pointer to the mem_block for P. */
4253 live_string_p (struct mem_node
*m
, void *p
)
4255 if (m
->type
== MEM_TYPE_STRING
)
4257 struct string_block
*b
= m
->start
;
4258 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4260 /* P must point to the start of a Lisp_String structure, and it
4261 must not be on the free-list. */
4263 && offset
% sizeof b
->strings
[0] == 0
4264 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4265 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4272 /* Value is non-zero if P is a pointer to a live Lisp cons on
4273 the heap. M is a pointer to the mem_block for P. */
4276 live_cons_p (struct mem_node
*m
, void *p
)
4278 if (m
->type
== MEM_TYPE_CONS
)
4280 struct cons_block
*b
= m
->start
;
4281 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4283 /* P must point to the start of a Lisp_Cons, not be
4284 one of the unused cells in the current cons block,
4285 and not be on the free-list. */
4287 && offset
% sizeof b
->conses
[0] == 0
4288 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4290 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4291 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4298 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4299 the heap. M is a pointer to the mem_block for P. */
4302 live_symbol_p (struct mem_node
*m
, void *p
)
4304 if (m
->type
== MEM_TYPE_SYMBOL
)
4306 struct symbol_block
*b
= m
->start
;
4307 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4309 /* P must point to the start of a Lisp_Symbol, not be
4310 one of the unused cells in the current symbol block,
4311 and not be on the free-list. */
4313 && offset
% sizeof b
->symbols
[0] == 0
4314 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4315 && (b
!= symbol_block
4316 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4317 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4324 /* Value is non-zero if P is a pointer to a live Lisp float on
4325 the heap. M is a pointer to the mem_block for P. */
4328 live_float_p (struct mem_node
*m
, void *p
)
4330 if (m
->type
== MEM_TYPE_FLOAT
)
4332 struct float_block
*b
= m
->start
;
4333 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4335 /* P must point to the start of a Lisp_Float and not be
4336 one of the unused cells in the current float block. */
4338 && offset
% sizeof b
->floats
[0] == 0
4339 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4340 && (b
!= float_block
4341 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4348 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4349 the heap. M is a pointer to the mem_block for P. */
4352 live_misc_p (struct mem_node
*m
, void *p
)
4354 if (m
->type
== MEM_TYPE_MISC
)
4356 struct marker_block
*b
= m
->start
;
4357 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4359 /* P must point to the start of a Lisp_Misc, not be
4360 one of the unused cells in the current misc block,
4361 and not be on the free-list. */
4363 && offset
% sizeof b
->markers
[0] == 0
4364 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4365 && (b
!= marker_block
4366 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4367 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4374 /* Value is non-zero if P is a pointer to a live vector-like object.
4375 M is a pointer to the mem_block for P. */
4378 live_vector_p (struct mem_node
*m
, void *p
)
4380 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4382 /* This memory node corresponds to a vector block. */
4383 struct vector_block
*block
= m
->start
;
4384 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4386 /* P is in the block's allocation range. Scan the block
4387 up to P and see whether P points to the start of some
4388 vector which is not on a free list. FIXME: check whether
4389 some allocation patterns (probably a lot of short vectors)
4390 may cause a substantial overhead of this loop. */
4391 while (VECTOR_IN_BLOCK (vector
, block
)
4392 && vector
<= (struct Lisp_Vector
*) p
)
4394 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4397 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4400 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4401 /* This memory node corresponds to a large vector. */
4407 /* Value is non-zero if P is a pointer to a live buffer. M is a
4408 pointer to the mem_block for P. */
4411 live_buffer_p (struct mem_node
*m
, void *p
)
4413 /* P must point to the start of the block, and the buffer
4414 must not have been killed. */
4415 return (m
->type
== MEM_TYPE_BUFFER
4417 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4420 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4424 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4426 /* Currently not used, but may be called from gdb. */
4428 void dump_zombies (void) EXTERNALLY_VISIBLE
;
4430 /* Array of objects that are kept alive because the C stack contains
4431 a pattern that looks like a reference to them. */
4433 #define MAX_ZOMBIES 10
4434 static Lisp_Object zombies
[MAX_ZOMBIES
];
4436 /* Number of zombie objects. */
4438 static EMACS_INT nzombies
;
4440 /* Number of garbage collections. */
4442 static EMACS_INT ngcs
;
4444 /* Average percentage of zombies per collection. */
4446 static double avg_zombies
;
4448 /* Max. number of live and zombie objects. */
4450 static EMACS_INT max_live
, max_zombies
;
4452 /* Average number of live objects per GC. */
4454 static double avg_live
;
4456 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4457 doc
: /* Show information about live and zombie objects. */)
4460 Lisp_Object args
[8], zombie_list
= Qnil
;
4462 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4463 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4464 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4465 args
[1] = make_number (ngcs
);
4466 args
[2] = make_float (avg_live
);
4467 args
[3] = make_float (avg_zombies
);
4468 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4469 args
[5] = make_number (max_live
);
4470 args
[6] = make_number (max_zombies
);
4471 args
[7] = zombie_list
;
4472 return Fmessage (8, args
);
4475 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4478 /* Mark OBJ if we can prove it's a Lisp_Object. */
4481 mark_maybe_object (Lisp_Object obj
)
4488 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4494 po
= (void *) XPNTR (obj
);
4501 switch (XTYPE (obj
))
4504 mark_p
= (live_string_p (m
, po
)
4505 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4509 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4513 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4517 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4520 case Lisp_Vectorlike
:
4521 /* Note: can't check BUFFERP before we know it's a
4522 buffer because checking that dereferences the pointer
4523 PO which might point anywhere. */
4524 if (live_vector_p (m
, po
))
4525 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4526 else if (live_buffer_p (m
, po
))
4527 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4531 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4540 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4541 if (nzombies
< MAX_ZOMBIES
)
4542 zombies
[nzombies
] = obj
;
4550 /* Return true if P can point to Lisp data, and false otherwise.
4551 USE_LSB_TAG needs Lisp data to be aligned on multiples of GCALIGNMENT.
4552 Otherwise, assume that Lisp data is aligned on even addresses. */
4555 maybe_lisp_pointer (void *p
)
4557 return !((intptr_t) p
% (USE_LSB_TAG
? GCALIGNMENT
: 2));
4560 /* If P points to Lisp data, mark that as live if it isn't already
4564 mark_maybe_pointer (void *p
)
4570 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4573 if (!maybe_lisp_pointer (p
))
4579 Lisp_Object obj
= Qnil
;
4583 case MEM_TYPE_NON_LISP
:
4584 case MEM_TYPE_SPARE
:
4585 /* Nothing to do; not a pointer to Lisp memory. */
4588 case MEM_TYPE_BUFFER
:
4589 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4590 XSETVECTOR (obj
, p
);
4594 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4598 case MEM_TYPE_STRING
:
4599 if (live_string_p (m
, p
)
4600 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4601 XSETSTRING (obj
, p
);
4605 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4609 case MEM_TYPE_SYMBOL
:
4610 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4611 XSETSYMBOL (obj
, p
);
4614 case MEM_TYPE_FLOAT
:
4615 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4619 case MEM_TYPE_VECTORLIKE
:
4620 case MEM_TYPE_VECTOR_BLOCK
:
4621 if (live_vector_p (m
, p
))
4624 XSETVECTOR (tem
, p
);
4625 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4640 /* Alignment of pointer values. Use alignof, as it sometimes returns
4641 a smaller alignment than GCC's __alignof__ and mark_memory might
4642 miss objects if __alignof__ were used. */
4643 #define GC_POINTER_ALIGNMENT alignof (void *)
4645 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4646 not suffice, which is the typical case. A host where a Lisp_Object is
4647 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4648 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4649 suffice to widen it to to a Lisp_Object and check it that way. */
4650 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4651 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4652 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4653 nor mark_maybe_object can follow the pointers. This should not occur on
4654 any practical porting target. */
4655 # error "MSB type bits straddle pointer-word boundaries"
4657 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4658 pointer words that hold pointers ORed with type bits. */
4659 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4661 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4662 words that hold unmodified pointers. */
4663 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4666 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4667 or END+OFFSET..START. */
4669 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4670 mark_memory (void *start
, void *end
)
4675 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4679 /* Make START the pointer to the start of the memory region,
4680 if it isn't already. */
4688 /* Mark Lisp data pointed to. This is necessary because, in some
4689 situations, the C compiler optimizes Lisp objects away, so that
4690 only a pointer to them remains. Example:
4692 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4695 Lisp_Object obj = build_string ("test");
4696 struct Lisp_String *s = XSTRING (obj);
4697 Fgarbage_collect ();
4698 fprintf (stderr, "test `%s'\n", s->data);
4702 Here, `obj' isn't really used, and the compiler optimizes it
4703 away. The only reference to the life string is through the
4706 for (pp
= start
; (void *) pp
< end
; pp
++)
4707 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4709 void *p
= *(void **) ((char *) pp
+ i
);
4710 mark_maybe_pointer (p
);
4711 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4712 mark_maybe_object (XIL ((intptr_t) p
));
4716 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4718 static bool setjmp_tested_p
;
4719 static int longjmps_done
;
4721 #define SETJMP_WILL_LIKELY_WORK "\
4723 Emacs garbage collector has been changed to use conservative stack\n\
4724 marking. Emacs has determined that the method it uses to do the\n\
4725 marking will likely work on your system, but this isn't sure.\n\
4727 If you are a system-programmer, or can get the help of a local wizard\n\
4728 who is, please take a look at the function mark_stack in alloc.c, and\n\
4729 verify that the methods used are appropriate for your system.\n\
4731 Please mail the result to <emacs-devel@gnu.org>.\n\
4734 #define SETJMP_WILL_NOT_WORK "\
4736 Emacs garbage collector has been changed to use conservative stack\n\
4737 marking. Emacs has determined that the default method it uses to do the\n\
4738 marking will not work on your system. We will need a system-dependent\n\
4739 solution for your system.\n\
4741 Please take a look at the function mark_stack in alloc.c, and\n\
4742 try to find a way to make it work on your system.\n\
4744 Note that you may get false negatives, depending on the compiler.\n\
4745 In particular, you need to use -O with GCC for this test.\n\
4747 Please mail the result to <emacs-devel@gnu.org>.\n\
4751 /* Perform a quick check if it looks like setjmp saves registers in a
4752 jmp_buf. Print a message to stderr saying so. When this test
4753 succeeds, this is _not_ a proof that setjmp is sufficient for
4754 conservative stack marking. Only the sources or a disassembly
4764 /* Arrange for X to be put in a register. */
4770 if (longjmps_done
== 1)
4772 /* Came here after the longjmp at the end of the function.
4774 If x == 1, the longjmp has restored the register to its
4775 value before the setjmp, and we can hope that setjmp
4776 saves all such registers in the jmp_buf, although that
4779 For other values of X, either something really strange is
4780 taking place, or the setjmp just didn't save the register. */
4783 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4786 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4793 if (longjmps_done
== 1)
4794 sys_longjmp (jbuf
, 1);
4797 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4800 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4802 /* Abort if anything GCPRO'd doesn't survive the GC. */
4810 for (p
= gcprolist
; p
; p
= p
->next
)
4811 for (i
= 0; i
< p
->nvars
; ++i
)
4812 if (!survives_gc_p (p
->var
[i
]))
4813 /* FIXME: It's not necessarily a bug. It might just be that the
4814 GCPRO is unnecessary or should release the object sooner. */
4818 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4825 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4826 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4828 fprintf (stderr
, " %d = ", i
);
4829 debug_print (zombies
[i
]);
4833 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4836 /* Mark live Lisp objects on the C stack.
4838 There are several system-dependent problems to consider when
4839 porting this to new architectures:
4843 We have to mark Lisp objects in CPU registers that can hold local
4844 variables or are used to pass parameters.
4846 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4847 something that either saves relevant registers on the stack, or
4848 calls mark_maybe_object passing it each register's contents.
4850 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4851 implementation assumes that calling setjmp saves registers we need
4852 to see in a jmp_buf which itself lies on the stack. This doesn't
4853 have to be true! It must be verified for each system, possibly
4854 by taking a look at the source code of setjmp.
4856 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4857 can use it as a machine independent method to store all registers
4858 to the stack. In this case the macros described in the previous
4859 two paragraphs are not used.
4863 Architectures differ in the way their processor stack is organized.
4864 For example, the stack might look like this
4867 | Lisp_Object | size = 4
4869 | something else | size = 2
4871 | Lisp_Object | size = 4
4875 In such a case, not every Lisp_Object will be aligned equally. To
4876 find all Lisp_Object on the stack it won't be sufficient to walk
4877 the stack in steps of 4 bytes. Instead, two passes will be
4878 necessary, one starting at the start of the stack, and a second
4879 pass starting at the start of the stack + 2. Likewise, if the
4880 minimal alignment of Lisp_Objects on the stack is 1, four passes
4881 would be necessary, each one starting with one byte more offset
4882 from the stack start. */
4885 mark_stack (void *end
)
4888 /* This assumes that the stack is a contiguous region in memory. If
4889 that's not the case, something has to be done here to iterate
4890 over the stack segments. */
4891 mark_memory (stack_base
, end
);
4893 /* Allow for marking a secondary stack, like the register stack on the
4895 #ifdef GC_MARK_SECONDARY_STACK
4896 GC_MARK_SECONDARY_STACK ();
4899 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4904 #else /* GC_MARK_STACK == 0 */
4906 #define mark_maybe_object(obj) emacs_abort ()
4908 #endif /* GC_MARK_STACK != 0 */
4911 /* Determine whether it is safe to access memory at address P. */
4913 valid_pointer_p (void *p
)
4916 return w32_valid_pointer_p (p
, 16);
4920 /* Obviously, we cannot just access it (we would SEGV trying), so we
4921 trick the o/s to tell us whether p is a valid pointer.
4922 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4923 not validate p in that case. */
4925 if (emacs_pipe (fd
) == 0)
4927 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
4928 emacs_close (fd
[1]);
4929 emacs_close (fd
[0]);
4937 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
4938 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
4939 cannot validate OBJ. This function can be quite slow, so its primary
4940 use is the manual debugging. The only exception is print_object, where
4941 we use it to check whether the memory referenced by the pointer of
4942 Lisp_Save_Value object contains valid objects. */
4945 valid_lisp_object_p (Lisp_Object obj
)
4955 p
= (void *) XPNTR (obj
);
4956 if (PURE_POINTER_P (p
))
4959 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
4963 return valid_pointer_p (p
);
4970 int valid
= valid_pointer_p (p
);
4982 case MEM_TYPE_NON_LISP
:
4983 case MEM_TYPE_SPARE
:
4986 case MEM_TYPE_BUFFER
:
4987 return live_buffer_p (m
, p
) ? 1 : 2;
4990 return live_cons_p (m
, p
);
4992 case MEM_TYPE_STRING
:
4993 return live_string_p (m
, p
);
4996 return live_misc_p (m
, p
);
4998 case MEM_TYPE_SYMBOL
:
4999 return live_symbol_p (m
, p
);
5001 case MEM_TYPE_FLOAT
:
5002 return live_float_p (m
, p
);
5004 case MEM_TYPE_VECTORLIKE
:
5005 case MEM_TYPE_VECTOR_BLOCK
:
5006 return live_vector_p (m
, p
);
5016 /* If GC_MARK_STACK, return 1 if STR is a relocatable data of Lisp_String
5017 (i.e. there is a non-pure Lisp_Object X so that SDATA (X) == STR) and 0
5018 if not. Otherwise we can't rely on valid_lisp_object_p and return -1.
5019 This function is slow and should be used for debugging purposes. */
5022 relocatable_string_data_p (const char *str
)
5024 if (PURE_POINTER_P (str
))
5030 = (struct sdata
*) (str
- offsetof (struct sdata
, data
));
5032 if (valid_pointer_p (sdata
)
5033 && valid_pointer_p (sdata
->string
)
5034 && maybe_lisp_pointer (sdata
->string
))
5035 return (valid_lisp_object_p
5036 (make_lisp_ptr (sdata
->string
, Lisp_String
))
5037 && (const char *) sdata
->string
->data
== str
);
5040 #endif /* GC_MARK_STACK */
5044 /***********************************************************************
5045 Pure Storage Management
5046 ***********************************************************************/
5048 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5049 pointer to it. TYPE is the Lisp type for which the memory is
5050 allocated. TYPE < 0 means it's not used for a Lisp object. */
5053 pure_alloc (size_t size
, int type
)
5057 size_t alignment
= GCALIGNMENT
;
5059 size_t alignment
= alignof (EMACS_INT
);
5061 /* Give Lisp_Floats an extra alignment. */
5062 if (type
== Lisp_Float
)
5063 alignment
= alignof (struct Lisp_Float
);
5069 /* Allocate space for a Lisp object from the beginning of the free
5070 space with taking account of alignment. */
5071 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5072 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5076 /* Allocate space for a non-Lisp object from the end of the free
5078 pure_bytes_used_non_lisp
+= size
;
5079 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5081 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5083 if (pure_bytes_used
<= pure_size
)
5086 /* Don't allocate a large amount here,
5087 because it might get mmap'd and then its address
5088 might not be usable. */
5089 purebeg
= xmalloc (10000);
5091 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5092 pure_bytes_used
= 0;
5093 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5098 /* Print a warning if PURESIZE is too small. */
5101 check_pure_size (void)
5103 if (pure_bytes_used_before_overflow
)
5104 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5106 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5110 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5111 the non-Lisp data pool of the pure storage, and return its start
5112 address. Return NULL if not found. */
5115 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5118 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5119 const unsigned char *p
;
5122 if (pure_bytes_used_non_lisp
<= nbytes
)
5125 /* Set up the Boyer-Moore table. */
5127 for (i
= 0; i
< 256; i
++)
5130 p
= (const unsigned char *) data
;
5132 bm_skip
[*p
++] = skip
;
5134 last_char_skip
= bm_skip
['\0'];
5136 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5137 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5139 /* See the comments in the function `boyer_moore' (search.c) for the
5140 use of `infinity'. */
5141 infinity
= pure_bytes_used_non_lisp
+ 1;
5142 bm_skip
['\0'] = infinity
;
5144 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5148 /* Check the last character (== '\0'). */
5151 start
+= bm_skip
[*(p
+ start
)];
5153 while (start
<= start_max
);
5155 if (start
< infinity
)
5156 /* Couldn't find the last character. */
5159 /* No less than `infinity' means we could find the last
5160 character at `p[start - infinity]'. */
5163 /* Check the remaining characters. */
5164 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5166 return non_lisp_beg
+ start
;
5168 start
+= last_char_skip
;
5170 while (start
<= start_max
);
5176 /* Return a string allocated in pure space. DATA is a buffer holding
5177 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5178 means make the result string multibyte.
5180 Must get an error if pure storage is full, since if it cannot hold
5181 a large string it may be able to hold conses that point to that
5182 string; then the string is not protected from gc. */
5185 make_pure_string (const char *data
,
5186 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5189 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5190 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5191 if (s
->data
== NULL
)
5193 s
->data
= pure_alloc (nbytes
+ 1, -1);
5194 memcpy (s
->data
, data
, nbytes
);
5195 s
->data
[nbytes
] = '\0';
5198 s
->size_byte
= multibyte
? nbytes
: -1;
5199 s
->intervals
= NULL
;
5200 XSETSTRING (string
, s
);
5204 /* Return a string allocated in pure space. Do not
5205 allocate the string data, just point to DATA. */
5208 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5211 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5214 s
->data
= (unsigned char *) data
;
5215 s
->intervals
= NULL
;
5216 XSETSTRING (string
, s
);
5220 static Lisp_Object
purecopy (Lisp_Object obj
);
5222 /* Return a cons allocated from pure space. Give it pure copies
5223 of CAR as car and CDR as cdr. */
5226 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5229 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5231 XSETCAR (new, purecopy (car
));
5232 XSETCDR (new, purecopy (cdr
));
5237 /* Value is a float object with value NUM allocated from pure space. */
5240 make_pure_float (double num
)
5243 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5245 XFLOAT_INIT (new, num
);
5250 /* Return a vector with room for LEN Lisp_Objects allocated from
5254 make_pure_vector (ptrdiff_t len
)
5257 size_t size
= header_size
+ len
* word_size
;
5258 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5259 XSETVECTOR (new, p
);
5260 XVECTOR (new)->header
.size
= len
;
5265 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5266 doc
: /* Make a copy of object OBJ in pure storage.
5267 Recursively copies contents of vectors and cons cells.
5268 Does not copy symbols. Copies strings without text properties. */)
5269 (register Lisp_Object obj
)
5271 if (NILP (Vpurify_flag
))
5273 else if (MARKERP (obj
) || OVERLAYP (obj
)
5274 || HASH_TABLE_P (obj
) || SYMBOLP (obj
))
5275 /* Can't purify those. */
5278 return purecopy (obj
);
5282 purecopy (Lisp_Object obj
)
5284 if (PURE_POINTER_P (XPNTR (obj
)) || INTEGERP (obj
) || SUBRP (obj
))
5285 return obj
; /* Already pure. */
5287 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5289 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5295 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5296 else if (FLOATP (obj
))
5297 obj
= make_pure_float (XFLOAT_DATA (obj
));
5298 else if (STRINGP (obj
))
5299 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5301 STRING_MULTIBYTE (obj
));
5302 else if (COMPILEDP (obj
) || VECTORP (obj
))
5304 register struct Lisp_Vector
*vec
;
5305 register ptrdiff_t i
;
5309 if (size
& PSEUDOVECTOR_FLAG
)
5310 size
&= PSEUDOVECTOR_SIZE_MASK
;
5311 vec
= XVECTOR (make_pure_vector (size
));
5312 for (i
= 0; i
< size
; i
++)
5313 vec
->contents
[i
] = purecopy (AREF (obj
, i
));
5314 if (COMPILEDP (obj
))
5316 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5317 XSETCOMPILED (obj
, vec
);
5320 XSETVECTOR (obj
, vec
);
5322 else if (SYMBOLP (obj
))
5324 if (!XSYMBOL (obj
)->pinned
)
5325 { /* We can't purify them, but they appear in many pure objects.
5326 Mark them as `pinned' so we know to mark them at every GC cycle. */
5327 XSYMBOL (obj
)->pinned
= true;
5328 symbol_block_pinned
= symbol_block
;
5334 Lisp_Object args
[2];
5335 args
[0] = build_pure_c_string ("Don't know how to purify: %S");
5337 Fsignal (Qerror
, (Fcons (Fformat (2, args
), Qnil
)));
5340 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5341 Fputhash (obj
, obj
, Vpurify_flag
);
5348 /***********************************************************************
5350 ***********************************************************************/
5352 /* Put an entry in staticvec, pointing at the variable with address
5356 staticpro (Lisp_Object
*varaddress
)
5358 if (staticidx
>= NSTATICS
)
5359 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5360 staticvec
[staticidx
++] = varaddress
;
5364 /***********************************************************************
5366 ***********************************************************************/
5368 /* Temporarily prevent garbage collection. */
5371 inhibit_garbage_collection (void)
5373 ptrdiff_t count
= SPECPDL_INDEX ();
5375 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5379 /* Used to avoid possible overflows when
5380 converting from C to Lisp integers. */
5383 bounded_number (EMACS_INT number
)
5385 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5388 /* Calculate total bytes of live objects. */
5391 total_bytes_of_live_objects (void)
5394 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5395 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5396 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5397 tot
+= total_string_bytes
;
5398 tot
+= total_vector_slots
* word_size
;
5399 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5400 tot
+= total_intervals
* sizeof (struct interval
);
5401 tot
+= total_strings
* sizeof (struct Lisp_String
);
5405 #ifdef HAVE_WINDOW_SYSTEM
5407 /* This code has a few issues on MS-Windows, see Bug#15876 and Bug#16140. */
5409 #if !defined (HAVE_NTGUI)
5411 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5412 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5415 compact_font_cache_entry (Lisp_Object entry
)
5417 Lisp_Object tail
, *prev
= &entry
;
5419 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5422 Lisp_Object obj
= XCAR (tail
);
5424 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5425 if (CONSP (obj
) && FONT_SPEC_P (XCAR (obj
))
5426 && !VECTOR_MARKED_P (XFONT_SPEC (XCAR (obj
)))
5427 && VECTORP (XCDR (obj
)))
5429 ptrdiff_t i
, size
= ASIZE (XCDR (obj
)) & ~ARRAY_MARK_FLAG
;
5431 /* If font-spec is not marked, most likely all font-entities
5432 are not marked too. But we must be sure that nothing is
5433 marked within OBJ before we really drop it. */
5434 for (i
= 0; i
< size
; i
++)
5435 if (VECTOR_MARKED_P (XFONT_ENTITY (AREF (XCDR (obj
), i
))))
5442 *prev
= XCDR (tail
);
5444 prev
= xcdr_addr (tail
);
5449 #endif /* not HAVE_NTGUI */
5451 /* Compact font caches on all terminals and mark
5452 everything which is still here after compaction. */
5455 compact_font_caches (void)
5459 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5461 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5462 #if !defined (HAVE_NTGUI)
5467 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5468 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5470 #endif /* not HAVE_NTGUI */
5471 mark_object (cache
);
5475 #else /* not HAVE_WINDOW_SYSTEM */
5477 #define compact_font_caches() (void)(0)
5479 #endif /* HAVE_WINDOW_SYSTEM */
5481 /* Remove (MARKER . DATA) entries with unmarked MARKER
5482 from buffer undo LIST and return changed list. */
5485 compact_undo_list (Lisp_Object list
)
5487 Lisp_Object tail
, *prev
= &list
;
5489 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5491 if (CONSP (XCAR (tail
))
5492 && MARKERP (XCAR (XCAR (tail
)))
5493 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5494 *prev
= XCDR (tail
);
5496 prev
= xcdr_addr (tail
);
5502 mark_pinned_symbols (void)
5504 struct symbol_block
*sblk
;
5505 int lim
= (symbol_block_pinned
== symbol_block
5506 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5508 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5510 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5511 for (; sym
< end
; ++sym
)
5513 mark_object (make_lisp_ptr (&sym
->s
, Lisp_Symbol
));
5515 lim
= SYMBOL_BLOCK_SIZE
;
5519 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5520 separate function so that we could limit mark_stack in searching
5521 the stack frames below this function, thus avoiding the rare cases
5522 where mark_stack finds values that look like live Lisp objects on
5523 portions of stack that couldn't possibly contain such live objects.
5524 For more details of this, see the discussion at
5525 http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00270.html. */
5527 garbage_collect_1 (void *end
)
5529 struct buffer
*nextb
;
5530 char stack_top_variable
;
5533 ptrdiff_t count
= SPECPDL_INDEX ();
5534 struct timespec start
;
5535 Lisp_Object retval
= Qnil
;
5536 size_t tot_before
= 0;
5541 /* Can't GC if pure storage overflowed because we can't determine
5542 if something is a pure object or not. */
5543 if (pure_bytes_used_before_overflow
)
5546 /* Record this function, so it appears on the profiler's backtraces. */
5547 record_in_backtrace (Qautomatic_gc
, &Qnil
, 0);
5551 /* Don't keep undo information around forever.
5552 Do this early on, so it is no problem if the user quits. */
5553 FOR_EACH_BUFFER (nextb
)
5554 compact_buffer (nextb
);
5556 if (profiler_memory_running
)
5557 tot_before
= total_bytes_of_live_objects ();
5559 start
= current_timespec ();
5561 /* In case user calls debug_print during GC,
5562 don't let that cause a recursive GC. */
5563 consing_since_gc
= 0;
5565 /* Save what's currently displayed in the echo area. */
5566 message_p
= push_message ();
5567 record_unwind_protect_void (pop_message_unwind
);
5569 /* Save a copy of the contents of the stack, for debugging. */
5570 #if MAX_SAVE_STACK > 0
5571 if (NILP (Vpurify_flag
))
5574 ptrdiff_t stack_size
;
5575 if (&stack_top_variable
< stack_bottom
)
5577 stack
= &stack_top_variable
;
5578 stack_size
= stack_bottom
- &stack_top_variable
;
5582 stack
= stack_bottom
;
5583 stack_size
= &stack_top_variable
- stack_bottom
;
5585 if (stack_size
<= MAX_SAVE_STACK
)
5587 if (stack_copy_size
< stack_size
)
5589 stack_copy
= xrealloc (stack_copy
, stack_size
);
5590 stack_copy_size
= stack_size
;
5592 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5595 #endif /* MAX_SAVE_STACK > 0 */
5597 if (garbage_collection_messages
)
5598 message1_nolog ("Garbage collecting...");
5602 shrink_regexp_cache ();
5606 /* Mark all the special slots that serve as the roots of accessibility. */
5608 mark_buffer (&buffer_defaults
);
5609 mark_buffer (&buffer_local_symbols
);
5611 for (i
= 0; i
< staticidx
; i
++)
5612 mark_object (*staticvec
[i
]);
5614 mark_pinned_symbols ();
5623 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5624 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5628 register struct gcpro
*tail
;
5629 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5630 for (i
= 0; i
< tail
->nvars
; i
++)
5631 mark_object (tail
->var
[i
]);
5636 struct handler
*handler
;
5637 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5639 mark_object (handler
->tag_or_ch
);
5640 mark_object (handler
->val
);
5643 #ifdef HAVE_WINDOW_SYSTEM
5644 mark_fringe_data ();
5647 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5651 /* Everything is now marked, except for the data in font caches
5652 and undo lists. They're compacted by removing an items which
5653 aren't reachable otherwise. */
5655 compact_font_caches ();
5657 FOR_EACH_BUFFER (nextb
)
5659 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5660 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5661 /* Now that we have stripped the elements that need not be
5662 in the undo_list any more, we can finally mark the list. */
5663 mark_object (BVAR (nextb
, undo_list
));
5668 /* Clear the mark bits that we set in certain root slots. */
5670 unmark_byte_stack ();
5671 VECTOR_UNMARK (&buffer_defaults
);
5672 VECTOR_UNMARK (&buffer_local_symbols
);
5674 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5684 consing_since_gc
= 0;
5685 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5686 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5688 gc_relative_threshold
= 0;
5689 if (FLOATP (Vgc_cons_percentage
))
5690 { /* Set gc_cons_combined_threshold. */
5691 double tot
= total_bytes_of_live_objects ();
5693 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5696 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5697 gc_relative_threshold
= tot
;
5699 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5703 if (garbage_collection_messages
)
5705 if (message_p
|| minibuf_level
> 0)
5708 message1_nolog ("Garbage collecting...done");
5711 unbind_to (count
, Qnil
);
5713 Lisp_Object total
[11];
5714 int total_size
= 10;
5716 total
[0] = list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5717 bounded_number (total_conses
),
5718 bounded_number (total_free_conses
));
5720 total
[1] = list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5721 bounded_number (total_symbols
),
5722 bounded_number (total_free_symbols
));
5724 total
[2] = list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5725 bounded_number (total_markers
),
5726 bounded_number (total_free_markers
));
5728 total
[3] = list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5729 bounded_number (total_strings
),
5730 bounded_number (total_free_strings
));
5732 total
[4] = list3 (Qstring_bytes
, make_number (1),
5733 bounded_number (total_string_bytes
));
5735 total
[5] = list3 (Qvectors
,
5736 make_number (header_size
+ sizeof (Lisp_Object
)),
5737 bounded_number (total_vectors
));
5739 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5740 bounded_number (total_vector_slots
),
5741 bounded_number (total_free_vector_slots
));
5743 total
[7] = list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5744 bounded_number (total_floats
),
5745 bounded_number (total_free_floats
));
5747 total
[8] = list4 (Qintervals
, make_number (sizeof (struct interval
)),
5748 bounded_number (total_intervals
),
5749 bounded_number (total_free_intervals
));
5751 total
[9] = list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5752 bounded_number (total_buffers
));
5754 #ifdef DOUG_LEA_MALLOC
5756 total
[10] = list4 (Qheap
, make_number (1024),
5757 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5758 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10));
5760 retval
= Flist (total_size
, total
);
5763 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5765 /* Compute average percentage of zombies. */
5767 = (total_conses
+ total_symbols
+ total_markers
+ total_strings
5768 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5770 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5771 max_live
= max (nlive
, max_live
);
5772 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5773 max_zombies
= max (nzombies
, max_zombies
);
5778 if (!NILP (Vpost_gc_hook
))
5780 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5781 safe_run_hooks (Qpost_gc_hook
);
5782 unbind_to (gc_count
, Qnil
);
5785 /* Accumulate statistics. */
5786 if (FLOATP (Vgc_elapsed
))
5788 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5789 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5790 + timespectod (since_start
));
5795 /* Collect profiling data. */
5796 if (profiler_memory_running
)
5799 size_t tot_after
= total_bytes_of_live_objects ();
5800 if (tot_before
> tot_after
)
5801 swept
= tot_before
- tot_after
;
5802 malloc_probe (swept
);
5808 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5809 doc
: /* Reclaim storage for Lisp objects no longer needed.
5810 Garbage collection happens automatically if you cons more than
5811 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5812 `garbage-collect' normally returns a list with info on amount of space in use,
5813 where each entry has the form (NAME SIZE USED FREE), where:
5814 - NAME is a symbol describing the kind of objects this entry represents,
5815 - SIZE is the number of bytes used by each one,
5816 - USED is the number of those objects that were found live in the heap,
5817 - FREE is the number of those objects that are not live but that Emacs
5818 keeps around for future allocations (maybe because it does not know how
5819 to return them to the OS).
5820 However, if there was overflow in pure space, `garbage-collect'
5821 returns nil, because real GC can't be done.
5822 See Info node `(elisp)Garbage Collection'. */)
5825 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5826 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS \
5827 || GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES)
5830 #ifdef HAVE___BUILTIN_UNWIND_INIT
5831 /* Force callee-saved registers and register windows onto the stack.
5832 This is the preferred method if available, obviating the need for
5833 machine dependent methods. */
5834 __builtin_unwind_init ();
5836 #else /* not HAVE___BUILTIN_UNWIND_INIT */
5837 #ifndef GC_SAVE_REGISTERS_ON_STACK
5838 /* jmp_buf may not be aligned enough on darwin-ppc64 */
5839 union aligned_jmpbuf
{
5843 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
5845 /* This trick flushes the register windows so that all the state of
5846 the process is contained in the stack. */
5847 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
5848 needed on ia64 too. See mach_dep.c, where it also says inline
5849 assembler doesn't work with relevant proprietary compilers. */
5851 #if defined (__sparc64__) && defined (__FreeBSD__)
5852 /* FreeBSD does not have a ta 3 handler. */
5859 /* Save registers that we need to see on the stack. We need to see
5860 registers used to hold register variables and registers used to
5862 #ifdef GC_SAVE_REGISTERS_ON_STACK
5863 GC_SAVE_REGISTERS_ON_STACK (end
);
5864 #else /* not GC_SAVE_REGISTERS_ON_STACK */
5866 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
5867 setjmp will definitely work, test it
5868 and print a message with the result
5870 if (!setjmp_tested_p
)
5872 setjmp_tested_p
= 1;
5875 #endif /* GC_SETJMP_WORKS */
5878 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
5879 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
5880 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
5881 return garbage_collect_1 (end
);
5882 #elif (GC_MARK_STACK == GC_USE_GCPROS_AS_BEFORE)
5883 /* Old GCPROs-based method without stack marking. */
5884 return garbage_collect_1 (NULL
);
5887 #endif /* GC_MARK_STACK */
5890 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5891 only interesting objects referenced from glyphs are strings. */
5894 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5896 struct glyph_row
*row
= matrix
->rows
;
5897 struct glyph_row
*end
= row
+ matrix
->nrows
;
5899 for (; row
< end
; ++row
)
5903 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5905 struct glyph
*glyph
= row
->glyphs
[area
];
5906 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5908 for (; glyph
< end_glyph
; ++glyph
)
5909 if (STRINGP (glyph
->object
)
5910 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5911 mark_object (glyph
->object
);
5916 /* Mark reference to a Lisp_Object.
5917 If the object referred to has not been seen yet, recursively mark
5918 all the references contained in it. */
5920 #define LAST_MARKED_SIZE 500
5921 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5922 static int last_marked_index
;
5924 /* For debugging--call abort when we cdr down this many
5925 links of a list, in mark_object. In debugging,
5926 the call to abort will hit a breakpoint.
5927 Normally this is zero and the check never goes off. */
5928 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5931 mark_vectorlike (struct Lisp_Vector
*ptr
)
5933 ptrdiff_t size
= ptr
->header
.size
;
5936 eassert (!VECTOR_MARKED_P (ptr
));
5937 VECTOR_MARK (ptr
); /* Else mark it. */
5938 if (size
& PSEUDOVECTOR_FLAG
)
5939 size
&= PSEUDOVECTOR_SIZE_MASK
;
5941 /* Note that this size is not the memory-footprint size, but only
5942 the number of Lisp_Object fields that we should trace.
5943 The distinction is used e.g. by Lisp_Process which places extra
5944 non-Lisp_Object fields at the end of the structure... */
5945 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5946 mark_object (ptr
->contents
[i
]);
5949 /* Like mark_vectorlike but optimized for char-tables (and
5950 sub-char-tables) assuming that the contents are mostly integers or
5954 mark_char_table (struct Lisp_Vector
*ptr
)
5956 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5959 eassert (!VECTOR_MARKED_P (ptr
));
5961 for (i
= 0; i
< size
; i
++)
5963 Lisp_Object val
= ptr
->contents
[i
];
5965 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5967 if (SUB_CHAR_TABLE_P (val
))
5969 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5970 mark_char_table (XVECTOR (val
));
5977 NO_INLINE
/* To reduce stack depth in mark_object. */
5979 mark_compiled (struct Lisp_Vector
*ptr
)
5981 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5984 for (i
= 0; i
< size
; i
++)
5985 if (i
!= COMPILED_CONSTANTS
)
5986 mark_object (ptr
->contents
[i
]);
5987 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
5990 /* Mark the chain of overlays starting at PTR. */
5993 mark_overlay (struct Lisp_Overlay
*ptr
)
5995 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5998 mark_object (ptr
->start
);
5999 mark_object (ptr
->end
);
6000 mark_object (ptr
->plist
);
6004 /* Mark Lisp_Objects and special pointers in BUFFER. */
6007 mark_buffer (struct buffer
*buffer
)
6009 /* This is handled much like other pseudovectors... */
6010 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
6012 /* ...but there are some buffer-specific things. */
6014 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
6016 /* For now, we just don't mark the undo_list. It's done later in
6017 a special way just before the sweep phase, and after stripping
6018 some of its elements that are not needed any more. */
6020 mark_overlay (buffer
->overlays_before
);
6021 mark_overlay (buffer
->overlays_after
);
6023 /* If this is an indirect buffer, mark its base buffer. */
6024 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
6025 mark_buffer (buffer
->base_buffer
);
6028 /* Mark Lisp faces in the face cache C. */
6030 NO_INLINE
/* To reduce stack depth in mark_object. */
6032 mark_face_cache (struct face_cache
*c
)
6037 for (i
= 0; i
< c
->used
; ++i
)
6039 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
6043 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
6044 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
6046 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
6047 mark_object (face
->lface
[j
]);
6053 NO_INLINE
/* To reduce stack depth in mark_object. */
6055 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
6057 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6058 Lisp_Object where
= blv
->where
;
6059 /* If the value is set up for a killed buffer or deleted
6060 frame, restore it's global binding. If the value is
6061 forwarded to a C variable, either it's not a Lisp_Object
6062 var, or it's staticpro'd already. */
6063 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
6064 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
6065 swap_in_global_binding (ptr
);
6066 mark_object (blv
->where
);
6067 mark_object (blv
->valcell
);
6068 mark_object (blv
->defcell
);
6071 /* Remove killed buffers or items whose car is a killed buffer from
6072 LIST, and mark other items. Return changed LIST, which is marked. */
6075 mark_discard_killed_buffers (Lisp_Object list
)
6077 Lisp_Object tail
, *prev
= &list
;
6079 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
6082 Lisp_Object tem
= XCAR (tail
);
6085 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
6086 *prev
= XCDR (tail
);
6089 CONS_MARK (XCONS (tail
));
6090 mark_object (XCAR (tail
));
6091 prev
= xcdr_addr (tail
);
6098 /* Determine type of generic Lisp_Object and mark it accordingly. */
6101 mark_object (Lisp_Object arg
)
6103 register Lisp_Object obj
= arg
;
6104 #ifdef GC_CHECK_MARKED_OBJECTS
6108 ptrdiff_t cdr_count
= 0;
6112 if (PURE_POINTER_P (XPNTR (obj
)))
6115 last_marked
[last_marked_index
++] = obj
;
6116 if (last_marked_index
== LAST_MARKED_SIZE
)
6117 last_marked_index
= 0;
6119 /* Perform some sanity checks on the objects marked here. Abort if
6120 we encounter an object we know is bogus. This increases GC time
6121 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
6122 #ifdef GC_CHECK_MARKED_OBJECTS
6124 po
= (void *) XPNTR (obj
);
6126 /* Check that the object pointed to by PO is known to be a Lisp
6127 structure allocated from the heap. */
6128 #define CHECK_ALLOCATED() \
6130 m = mem_find (po); \
6135 /* Check that the object pointed to by PO is live, using predicate
6137 #define CHECK_LIVE(LIVEP) \
6139 if (!LIVEP (m, po)) \
6143 /* Check both of the above conditions. */
6144 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6146 CHECK_ALLOCATED (); \
6147 CHECK_LIVE (LIVEP); \
6150 #else /* not GC_CHECK_MARKED_OBJECTS */
6152 #define CHECK_LIVE(LIVEP) (void) 0
6153 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
6155 #endif /* not GC_CHECK_MARKED_OBJECTS */
6157 switch (XTYPE (obj
))
6161 register struct Lisp_String
*ptr
= XSTRING (obj
);
6162 if (STRING_MARKED_P (ptr
))
6164 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6166 MARK_INTERVAL_TREE (ptr
->intervals
);
6167 #ifdef GC_CHECK_STRING_BYTES
6168 /* Check that the string size recorded in the string is the
6169 same as the one recorded in the sdata structure. */
6171 #endif /* GC_CHECK_STRING_BYTES */
6175 case Lisp_Vectorlike
:
6177 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6178 register ptrdiff_t pvectype
;
6180 if (VECTOR_MARKED_P (ptr
))
6183 #ifdef GC_CHECK_MARKED_OBJECTS
6185 if (m
== MEM_NIL
&& !SUBRP (obj
))
6187 #endif /* GC_CHECK_MARKED_OBJECTS */
6189 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6190 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6191 >> PSEUDOVECTOR_AREA_BITS
);
6193 pvectype
= PVEC_NORMAL_VECTOR
;
6195 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6196 CHECK_LIVE (live_vector_p
);
6201 #ifdef GC_CHECK_MARKED_OBJECTS
6210 #endif /* GC_CHECK_MARKED_OBJECTS */
6211 mark_buffer ((struct buffer
*) ptr
);
6215 /* Although we could treat this just like a vector, mark_compiled
6216 returns the COMPILED_CONSTANTS element, which is marked at the
6217 next iteration of goto-loop here. This is done to avoid a few
6218 recursive calls to mark_object. */
6219 obj
= mark_compiled (ptr
);
6226 struct frame
*f
= (struct frame
*) ptr
;
6228 mark_vectorlike (ptr
);
6229 mark_face_cache (f
->face_cache
);
6230 #ifdef HAVE_WINDOW_SYSTEM
6231 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6233 struct font
*font
= FRAME_FONT (f
);
6235 if (font
&& !VECTOR_MARKED_P (font
))
6236 mark_vectorlike ((struct Lisp_Vector
*) font
);
6244 struct window
*w
= (struct window
*) ptr
;
6246 mark_vectorlike (ptr
);
6248 /* Mark glyph matrices, if any. Marking window
6249 matrices is sufficient because frame matrices
6250 use the same glyph memory. */
6251 if (w
->current_matrix
)
6253 mark_glyph_matrix (w
->current_matrix
);
6254 mark_glyph_matrix (w
->desired_matrix
);
6257 /* Filter out killed buffers from both buffer lists
6258 in attempt to help GC to reclaim killed buffers faster.
6259 We can do it elsewhere for live windows, but this is the
6260 best place to do it for dead windows. */
6262 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6264 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6268 case PVEC_HASH_TABLE
:
6270 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6272 mark_vectorlike (ptr
);
6273 mark_object (h
->test
.name
);
6274 mark_object (h
->test
.user_hash_function
);
6275 mark_object (h
->test
.user_cmp_function
);
6276 /* If hash table is not weak, mark all keys and values.
6277 For weak tables, mark only the vector. */
6279 mark_object (h
->key_and_value
);
6281 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6285 case PVEC_CHAR_TABLE
:
6286 mark_char_table (ptr
);
6289 case PVEC_BOOL_VECTOR
:
6290 /* No Lisp_Objects to mark in a bool vector. */
6301 mark_vectorlike (ptr
);
6308 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6312 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6314 /* Attempt to catch bogus objects. */
6315 eassert (valid_lisp_object_p (ptr
->function
) >= 1);
6316 mark_object (ptr
->function
);
6317 mark_object (ptr
->plist
);
6318 switch (ptr
->redirect
)
6320 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6321 case SYMBOL_VARALIAS
:
6324 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6328 case SYMBOL_LOCALIZED
:
6329 mark_localized_symbol (ptr
);
6331 case SYMBOL_FORWARDED
:
6332 /* If the value is forwarded to a buffer or keyboard field,
6333 these are marked when we see the corresponding object.
6334 And if it's forwarded to a C variable, either it's not
6335 a Lisp_Object var, or it's staticpro'd already. */
6337 default: emacs_abort ();
6339 if (!PURE_POINTER_P (XSTRING (ptr
->name
)))
6340 MARK_STRING (XSTRING (ptr
->name
));
6341 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6342 /* Inner loop to mark next symbol in this bucket, if any. */
6350 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6352 if (XMISCANY (obj
)->gcmarkbit
)
6355 switch (XMISCTYPE (obj
))
6357 case Lisp_Misc_Marker
:
6358 /* DO NOT mark thru the marker's chain.
6359 The buffer's markers chain does not preserve markers from gc;
6360 instead, markers are removed from the chain when freed by gc. */
6361 XMISCANY (obj
)->gcmarkbit
= 1;
6364 case Lisp_Misc_Save_Value
:
6365 XMISCANY (obj
)->gcmarkbit
= 1;
6367 struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6368 /* If `save_type' is zero, `data[0].pointer' is the address
6369 of a memory area containing `data[1].integer' potential
6371 if (GC_MARK_STACK
&& ptr
->save_type
== SAVE_TYPE_MEMORY
)
6373 Lisp_Object
*p
= ptr
->data
[0].pointer
;
6375 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
6376 mark_maybe_object (*p
);
6380 /* Find Lisp_Objects in `data[N]' slots and mark them. */
6382 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
6383 if (save_type (ptr
, i
) == SAVE_OBJECT
)
6384 mark_object (ptr
->data
[i
].object
);
6389 case Lisp_Misc_Overlay
:
6390 mark_overlay (XOVERLAY (obj
));
6400 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6401 if (CONS_MARKED_P (ptr
))
6403 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6405 /* If the cdr is nil, avoid recursion for the car. */
6406 if (EQ (ptr
->u
.cdr
, Qnil
))
6412 mark_object (ptr
->car
);
6415 if (cdr_count
== mark_object_loop_halt
)
6421 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6422 FLOAT_MARK (XFLOAT (obj
));
6433 #undef CHECK_ALLOCATED
6434 #undef CHECK_ALLOCATED_AND_LIVE
6436 /* Mark the Lisp pointers in the terminal objects.
6437 Called by Fgarbage_collect. */
6440 mark_terminals (void)
6443 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6445 eassert (t
->name
!= NULL
);
6446 #ifdef HAVE_WINDOW_SYSTEM
6447 /* If a terminal object is reachable from a stacpro'ed object,
6448 it might have been marked already. Make sure the image cache
6450 mark_image_cache (t
->image_cache
);
6451 #endif /* HAVE_WINDOW_SYSTEM */
6452 if (!VECTOR_MARKED_P (t
))
6453 mark_vectorlike ((struct Lisp_Vector
*)t
);
6459 /* Value is non-zero if OBJ will survive the current GC because it's
6460 either marked or does not need to be marked to survive. */
6463 survives_gc_p (Lisp_Object obj
)
6467 switch (XTYPE (obj
))
6474 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6478 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6482 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6485 case Lisp_Vectorlike
:
6486 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6490 survives_p
= CONS_MARKED_P (XCONS (obj
));
6494 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6501 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6507 NO_INLINE
/* For better stack traces */
6511 struct cons_block
*cblk
;
6512 struct cons_block
**cprev
= &cons_block
;
6513 int lim
= cons_block_index
;
6514 EMACS_INT num_free
= 0, num_used
= 0;
6518 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6522 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6524 /* Scan the mark bits an int at a time. */
6525 for (i
= 0; i
< ilim
; i
++)
6527 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6529 /* Fast path - all cons cells for this int are marked. */
6530 cblk
->gcmarkbits
[i
] = 0;
6531 num_used
+= BITS_PER_BITS_WORD
;
6535 /* Some cons cells for this int are not marked.
6536 Find which ones, and free them. */
6537 int start
, pos
, stop
;
6539 start
= i
* BITS_PER_BITS_WORD
;
6541 if (stop
> BITS_PER_BITS_WORD
)
6542 stop
= BITS_PER_BITS_WORD
;
6545 for (pos
= start
; pos
< stop
; pos
++)
6547 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6550 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6551 cons_free_list
= &cblk
->conses
[pos
];
6553 cons_free_list
->car
= Vdead
;
6559 CONS_UNMARK (&cblk
->conses
[pos
]);
6565 lim
= CONS_BLOCK_SIZE
;
6566 /* If this block contains only free conses and we have already
6567 seen more than two blocks worth of free conses then deallocate
6569 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6571 *cprev
= cblk
->next
;
6572 /* Unhook from the free list. */
6573 cons_free_list
= cblk
->conses
[0].u
.chain
;
6574 lisp_align_free (cblk
);
6578 num_free
+= this_free
;
6579 cprev
= &cblk
->next
;
6582 total_conses
= num_used
;
6583 total_free_conses
= num_free
;
6586 NO_INLINE
/* For better stack traces */
6590 register struct float_block
*fblk
;
6591 struct float_block
**fprev
= &float_block
;
6592 register int lim
= float_block_index
;
6593 EMACS_INT num_free
= 0, num_used
= 0;
6595 float_free_list
= 0;
6597 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6601 for (i
= 0; i
< lim
; i
++)
6602 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6605 fblk
->floats
[i
].u
.chain
= float_free_list
;
6606 float_free_list
= &fblk
->floats
[i
];
6611 FLOAT_UNMARK (&fblk
->floats
[i
]);
6613 lim
= FLOAT_BLOCK_SIZE
;
6614 /* If this block contains only free floats and we have already
6615 seen more than two blocks worth of free floats then deallocate
6617 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6619 *fprev
= fblk
->next
;
6620 /* Unhook from the free list. */
6621 float_free_list
= fblk
->floats
[0].u
.chain
;
6622 lisp_align_free (fblk
);
6626 num_free
+= this_free
;
6627 fprev
= &fblk
->next
;
6630 total_floats
= num_used
;
6631 total_free_floats
= num_free
;
6634 NO_INLINE
/* For better stack traces */
6636 sweep_intervals (void)
6638 register struct interval_block
*iblk
;
6639 struct interval_block
**iprev
= &interval_block
;
6640 register int lim
= interval_block_index
;
6641 EMACS_INT num_free
= 0, num_used
= 0;
6643 interval_free_list
= 0;
6645 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6650 for (i
= 0; i
< lim
; i
++)
6652 if (!iblk
->intervals
[i
].gcmarkbit
)
6654 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6655 interval_free_list
= &iblk
->intervals
[i
];
6661 iblk
->intervals
[i
].gcmarkbit
= 0;
6664 lim
= INTERVAL_BLOCK_SIZE
;
6665 /* If this block contains only free intervals and we have already
6666 seen more than two blocks worth of free intervals then
6667 deallocate this block. */
6668 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6670 *iprev
= iblk
->next
;
6671 /* Unhook from the free list. */
6672 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6677 num_free
+= this_free
;
6678 iprev
= &iblk
->next
;
6681 total_intervals
= num_used
;
6682 total_free_intervals
= num_free
;
6685 NO_INLINE
/* For better stack traces */
6687 sweep_symbols (void)
6689 register struct symbol_block
*sblk
;
6690 struct symbol_block
**sprev
= &symbol_block
;
6691 register int lim
= symbol_block_index
;
6692 EMACS_INT num_free
= 0, num_used
= 0;
6694 symbol_free_list
= NULL
;
6696 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6699 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6700 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6702 for (; sym
< end
; ++sym
)
6704 if (!sym
->s
.gcmarkbit
)
6706 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6707 xfree (SYMBOL_BLV (&sym
->s
));
6708 sym
->s
.next
= symbol_free_list
;
6709 symbol_free_list
= &sym
->s
;
6711 symbol_free_list
->function
= Vdead
;
6718 sym
->s
.gcmarkbit
= 0;
6719 /* Attempt to catch bogus objects. */
6720 eassert (valid_lisp_object_p (sym
->s
.function
) >= 1);
6724 lim
= SYMBOL_BLOCK_SIZE
;
6725 /* If this block contains only free symbols and we have already
6726 seen more than two blocks worth of free symbols then deallocate
6728 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6730 *sprev
= sblk
->next
;
6731 /* Unhook from the free list. */
6732 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6737 num_free
+= this_free
;
6738 sprev
= &sblk
->next
;
6741 total_symbols
= num_used
;
6742 total_free_symbols
= num_free
;
6745 NO_INLINE
/* For better stack traces */
6749 register struct marker_block
*mblk
;
6750 struct marker_block
**mprev
= &marker_block
;
6751 register int lim
= marker_block_index
;
6752 EMACS_INT num_free
= 0, num_used
= 0;
6754 /* Put all unmarked misc's on free list. For a marker, first
6755 unchain it from the buffer it points into. */
6757 marker_free_list
= 0;
6759 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6764 for (i
= 0; i
< lim
; i
++)
6766 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6768 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6769 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6770 /* Set the type of the freed object to Lisp_Misc_Free.
6771 We could leave the type alone, since nobody checks it,
6772 but this might catch bugs faster. */
6773 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6774 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6775 marker_free_list
= &mblk
->markers
[i
].m
;
6781 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6784 lim
= MARKER_BLOCK_SIZE
;
6785 /* If this block contains only free markers and we have already
6786 seen more than two blocks worth of free markers then deallocate
6788 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6790 *mprev
= mblk
->next
;
6791 /* Unhook from the free list. */
6792 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6797 num_free
+= this_free
;
6798 mprev
= &mblk
->next
;
6802 total_markers
= num_used
;
6803 total_free_markers
= num_free
;
6806 NO_INLINE
/* For better stack traces */
6808 sweep_buffers (void)
6810 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6813 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6814 if (!VECTOR_MARKED_P (buffer
))
6816 *bprev
= buffer
->next
;
6821 VECTOR_UNMARK (buffer
);
6822 /* Do not use buffer_(set|get)_intervals here. */
6823 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6825 bprev
= &buffer
->next
;
6829 /* Sweep: find all structures not marked, and free them. */
6833 /* Remove or mark entries in weak hash tables.
6834 This must be done before any object is unmarked. */
6835 sweep_weak_hash_tables ();
6838 check_string_bytes (!noninteractive
);
6846 check_string_bytes (!noninteractive
);
6850 /* Debugging aids. */
6852 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6853 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6854 This may be helpful in debugging Emacs's memory usage.
6855 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6861 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
6864 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6870 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6871 doc
: /* Return a list of counters that measure how much consing there has been.
6872 Each of these counters increments for a certain kind of object.
6873 The counters wrap around from the largest positive integer to zero.
6874 Garbage collection does not decrease them.
6875 The elements of the value are as follows:
6876 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6877 All are in units of 1 = one object consed
6878 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6880 MISCS include overlays, markers, and some internal types.
6881 Frames, windows, buffers, and subprocesses count as vectors
6882 (but the contents of a buffer's text do not count here). */)
6885 return listn (CONSTYPE_HEAP
, 8,
6886 bounded_number (cons_cells_consed
),
6887 bounded_number (floats_consed
),
6888 bounded_number (vector_cells_consed
),
6889 bounded_number (symbols_consed
),
6890 bounded_number (string_chars_consed
),
6891 bounded_number (misc_objects_consed
),
6892 bounded_number (intervals_consed
),
6893 bounded_number (strings_consed
));
6896 /* Find at most FIND_MAX symbols which have OBJ as their value or
6897 function. This is used in gdbinit's `xwhichsymbols' command. */
6900 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6902 struct symbol_block
*sblk
;
6903 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6904 Lisp_Object found
= Qnil
;
6908 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6910 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6913 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6915 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6919 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6922 XSETSYMBOL (tem
, sym
);
6923 val
= find_symbol_value (tem
);
6925 || EQ (sym
->function
, obj
)
6926 || (!NILP (sym
->function
)
6927 && COMPILEDP (sym
->function
)
6928 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6931 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6933 found
= Fcons (tem
, found
);
6934 if (--find_max
== 0)
6942 unbind_to (gc_count
, Qnil
);
6946 #ifdef SUSPICIOUS_OBJECT_CHECKING
6949 find_suspicious_object_in_range (void *begin
, void *end
)
6951 char *begin_a
= begin
;
6955 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6957 char *suspicious_object
= suspicious_objects
[i
];
6958 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
6959 return suspicious_object
;
6966 note_suspicious_free (void* ptr
)
6968 struct suspicious_free_record
* rec
;
6970 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
6971 if (suspicious_free_history_index
==
6972 ARRAYELTS (suspicious_free_history
))
6974 suspicious_free_history_index
= 0;
6977 memset (rec
, 0, sizeof (*rec
));
6978 rec
->suspicious_object
= ptr
;
6979 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
6983 detect_suspicious_free (void* ptr
)
6987 eassert (ptr
!= NULL
);
6989 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6990 if (suspicious_objects
[i
] == ptr
)
6992 note_suspicious_free (ptr
);
6993 suspicious_objects
[i
] = NULL
;
6997 #endif /* SUSPICIOUS_OBJECT_CHECKING */
6999 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
7000 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
7001 If Emacs is compiled with suspicous object checking, capture
7002 a stack trace when OBJ is freed in order to help track down
7003 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
7006 #ifdef SUSPICIOUS_OBJECT_CHECKING
7007 /* Right now, we care only about vectors. */
7008 if (VECTORLIKEP (obj
))
7010 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
7011 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
7012 suspicious_object_index
= 0;
7018 #ifdef ENABLE_CHECKING
7020 bool suppress_checking
;
7023 die (const char *msg
, const char *file
, int line
)
7025 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
7027 terminate_due_to_signal (SIGABRT
, INT_MAX
);
7031 /* Initialization. */
7034 init_alloc_once (void)
7036 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
7038 pure_size
= PURESIZE
;
7040 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
7042 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
7045 #ifdef DOUG_LEA_MALLOC
7046 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
7047 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
7048 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
7053 refill_memory_reserve ();
7054 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
7061 byte_stack_list
= 0;
7063 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
7064 setjmp_tested_p
= longjmps_done
= 0;
7067 Vgc_elapsed
= make_float (0.0);
7071 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
7076 syms_of_alloc (void)
7078 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
7079 doc
: /* Number of bytes of consing between garbage collections.
7080 Garbage collection can happen automatically once this many bytes have been
7081 allocated since the last garbage collection. All data types count.
7083 Garbage collection happens automatically only when `eval' is called.
7085 By binding this temporarily to a large number, you can effectively
7086 prevent garbage collection during a part of the program.
7087 See also `gc-cons-percentage'. */);
7089 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
7090 doc
: /* Portion of the heap used for allocation.
7091 Garbage collection can happen automatically once this portion of the heap
7092 has been allocated since the last garbage collection.
7093 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
7094 Vgc_cons_percentage
= make_float (0.1);
7096 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
7097 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
7099 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
7100 doc
: /* Number of cons cells that have been consed so far. */);
7102 DEFVAR_INT ("floats-consed", floats_consed
,
7103 doc
: /* Number of floats that have been consed so far. */);
7105 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7106 doc
: /* Number of vector cells that have been consed so far. */);
7108 DEFVAR_INT ("symbols-consed", symbols_consed
,
7109 doc
: /* Number of symbols that have been consed so far. */);
7111 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7112 doc
: /* Number of string characters that have been consed so far. */);
7114 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7115 doc
: /* Number of miscellaneous objects that have been consed so far.
7116 These include markers and overlays, plus certain objects not visible
7119 DEFVAR_INT ("intervals-consed", intervals_consed
,
7120 doc
: /* Number of intervals that have been consed so far. */);
7122 DEFVAR_INT ("strings-consed", strings_consed
,
7123 doc
: /* Number of strings that have been consed so far. */);
7125 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7126 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7127 This means that certain objects should be allocated in shared (pure) space.
7128 It can also be set to a hash-table, in which case this table is used to
7129 do hash-consing of the objects allocated to pure space. */);
7131 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7132 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7133 garbage_collection_messages
= 0;
7135 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7136 doc
: /* Hook run after garbage collection has finished. */);
7137 Vpost_gc_hook
= Qnil
;
7138 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7140 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7141 doc
: /* Precomputed `signal' argument for memory-full error. */);
7142 /* We build this in advance because if we wait until we need it, we might
7143 not be able to allocate the memory to hold it. */
7145 = listn (CONSTYPE_PURE
, 2, Qerror
,
7146 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7148 DEFVAR_LISP ("memory-full", Vmemory_full
,
7149 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7150 Vmemory_full
= Qnil
;
7152 DEFSYM (Qconses
, "conses");
7153 DEFSYM (Qsymbols
, "symbols");
7154 DEFSYM (Qmiscs
, "miscs");
7155 DEFSYM (Qstrings
, "strings");
7156 DEFSYM (Qvectors
, "vectors");
7157 DEFSYM (Qfloats
, "floats");
7158 DEFSYM (Qintervals
, "intervals");
7159 DEFSYM (Qbuffers
, "buffers");
7160 DEFSYM (Qstring_bytes
, "string-bytes");
7161 DEFSYM (Qvector_slots
, "vector-slots");
7162 DEFSYM (Qheap
, "heap");
7163 DEFSYM (Qautomatic_gc
, "Automatic GC");
7165 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7166 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7168 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7169 doc
: /* Accumulated time elapsed in garbage collections.
7170 The time is in seconds as a floating point value. */);
7171 DEFVAR_INT ("gcs-done", gcs_done
,
7172 doc
: /* Accumulated number of garbage collections done. */);
7177 defsubr (&Sbool_vector
);
7178 defsubr (&Smake_byte_code
);
7179 defsubr (&Smake_list
);
7180 defsubr (&Smake_vector
);
7181 defsubr (&Smake_string
);
7182 defsubr (&Smake_bool_vector
);
7183 defsubr (&Smake_symbol
);
7184 defsubr (&Smake_marker
);
7185 defsubr (&Spurecopy
);
7186 defsubr (&Sgarbage_collect
);
7187 defsubr (&Smemory_limit
);
7188 defsubr (&Smemory_use_counts
);
7189 defsubr (&Ssuspicious_object
);
7191 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
7192 defsubr (&Sgc_status
);
7196 /* When compiled with GCC, GDB might say "No enum type named
7197 pvec_type" if we don't have at least one symbol with that type, and
7198 then xbacktrace could fail. Similarly for the other enums and
7199 their values. Some non-GCC compilers don't like these constructs. */
7203 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7204 enum CHAR_TABLE_STANDARD_SLOTS CHAR_TABLE_STANDARD_SLOTS
;
7205 enum char_bits char_bits
;
7206 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7207 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7208 enum Lisp_Bits Lisp_Bits
;
7209 enum Lisp_Compiled Lisp_Compiled
;
7210 enum maxargs maxargs
;
7211 enum MAX_ALLOCA MAX_ALLOCA
;
7212 enum More_Lisp_Bits More_Lisp_Bits
;
7213 enum pvec_type pvec_type
;
7214 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7215 #endif /* __GNUC__ */