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 #ifdef HAVE_LINUX_SYSINFO
53 #include <sys/sysinfo.h>
57 #include "dosfns.h" /* For dos_memory_info. */
60 #if (defined ENABLE_CHECKING \
61 && defined HAVE_VALGRIND_VALGRIND_H \
62 && !defined USE_VALGRIND)
63 # define USE_VALGRIND 1
67 #include <valgrind/valgrind.h>
68 #include <valgrind/memcheck.h>
69 static bool valgrind_p
;
72 #ifdef USE_LOCAL_ALLOCATORS
73 # if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
74 # error "Stack-allocated Lisp objects are not compatible with GCPROs"
78 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
79 Doable only if GC_MARK_STACK. */
81 # undef GC_CHECK_MARKED_OBJECTS
84 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
85 memory. Can do this only if using gmalloc.c and if not checking
88 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
89 || defined HYBRID_MALLOC || defined GC_CHECK_MARKED_OBJECTS)
90 #undef GC_MALLOC_CHECK
101 #include "w32heap.h" /* for sbrk */
104 #ifdef DOUG_LEA_MALLOC
108 /* Specify maximum number of areas to mmap. It would be nice to use a
109 value that explicitly means "no limit". */
111 #define MMAP_MAX_AREAS 100000000
113 #endif /* not DOUG_LEA_MALLOC */
115 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
116 to a struct Lisp_String. */
118 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
119 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
120 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
122 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
123 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
124 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
126 /* Default value of gc_cons_threshold (see below). */
128 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
130 /* Global variables. */
131 struct emacs_globals globals
;
133 /* Number of bytes of consing done since the last gc. */
135 EMACS_INT consing_since_gc
;
137 /* Similar minimum, computed from Vgc_cons_percentage. */
139 EMACS_INT gc_relative_threshold
;
141 /* Minimum number of bytes of consing since GC before next GC,
142 when memory is full. */
144 EMACS_INT memory_full_cons_threshold
;
146 /* True during GC. */
150 /* True means abort if try to GC.
151 This is for code which is written on the assumption that
152 no GC will happen, so as to verify that assumption. */
156 /* Number of live and free conses etc. */
158 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
159 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
160 static EMACS_INT total_free_floats
, total_floats
;
162 /* Points to memory space allocated as "spare", to be freed if we run
163 out of memory. We keep one large block, four cons-blocks, and
164 two string blocks. */
166 static char *spare_memory
[7];
168 /* Amount of spare memory to keep in large reserve block, or to see
169 whether this much is available when malloc fails on a larger request. */
171 #define SPARE_MEMORY (1 << 14)
173 /* Initialize it to a nonzero value to force it into data space
174 (rather than bss space). That way unexec will remap it into text
175 space (pure), on some systems. We have not implemented the
176 remapping on more recent systems because this is less important
177 nowadays than in the days of small memories and timesharing. */
179 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
180 #define PUREBEG (char *) pure
182 /* Pointer to the pure area, and its size. */
184 static char *purebeg
;
185 static ptrdiff_t pure_size
;
187 /* Number of bytes of pure storage used before pure storage overflowed.
188 If this is non-zero, this implies that an overflow occurred. */
190 static ptrdiff_t pure_bytes_used_before_overflow
;
192 /* True if P points into pure space. */
194 #define PURE_POINTER_P(P) \
195 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
197 /* Index in pure at which next pure Lisp object will be allocated.. */
199 static ptrdiff_t pure_bytes_used_lisp
;
201 /* Number of bytes allocated for non-Lisp objects in pure storage. */
203 static ptrdiff_t pure_bytes_used_non_lisp
;
205 /* If nonzero, this is a warning delivered by malloc and not yet
208 const char *pending_malloc_warning
;
210 #if 0 /* Normally, pointer sanity only on request... */
211 #ifdef ENABLE_CHECKING
212 #define SUSPICIOUS_OBJECT_CHECKING 1
216 /* ... but unconditionally use SUSPICIOUS_OBJECT_CHECKING while the GC
217 bug is unresolved. */
218 #define SUSPICIOUS_OBJECT_CHECKING 1
220 #ifdef SUSPICIOUS_OBJECT_CHECKING
221 struct suspicious_free_record
223 void *suspicious_object
;
224 void *backtrace
[128];
226 static void *suspicious_objects
[32];
227 static int suspicious_object_index
;
228 struct suspicious_free_record suspicious_free_history
[64] EXTERNALLY_VISIBLE
;
229 static int suspicious_free_history_index
;
230 /* Find the first currently-monitored suspicious pointer in range
231 [begin,end) or NULL if no such pointer exists. */
232 static void *find_suspicious_object_in_range (void *begin
, void *end
);
233 static void detect_suspicious_free (void *ptr
);
235 # define find_suspicious_object_in_range(begin, end) NULL
236 # define detect_suspicious_free(ptr) (void)
239 /* Maximum amount of C stack to save when a GC happens. */
241 #ifndef MAX_SAVE_STACK
242 #define MAX_SAVE_STACK 16000
245 /* Buffer in which we save a copy of the C stack at each GC. */
247 #if MAX_SAVE_STACK > 0
248 static char *stack_copy
;
249 static ptrdiff_t stack_copy_size
;
251 /* Copy to DEST a block of memory from SRC of size SIZE bytes,
252 avoiding any address sanitization. */
254 static void * ATTRIBUTE_NO_SANITIZE_ADDRESS
255 no_sanitize_memcpy (void *dest
, void const *src
, size_t size
)
257 if (! ADDRESS_SANITIZER
)
258 return memcpy (dest
, src
, size
);
264 for (i
= 0; i
< size
; i
++)
270 #endif /* MAX_SAVE_STACK > 0 */
272 static Lisp_Object Qconses
;
273 static Lisp_Object Qsymbols
;
274 static Lisp_Object Qmiscs
;
275 static Lisp_Object Qstrings
;
276 static Lisp_Object Qvectors
;
277 static Lisp_Object Qfloats
;
278 static Lisp_Object Qintervals
;
279 static Lisp_Object Qbuffers
;
280 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
281 static Lisp_Object Qgc_cons_threshold
;
282 Lisp_Object Qautomatic_gc
;
283 Lisp_Object Qchar_table_extra_slots
;
285 /* Hook run after GC has finished. */
287 static Lisp_Object Qpost_gc_hook
;
289 static void mark_terminals (void);
290 static void gc_sweep (void);
291 static Lisp_Object
make_pure_vector (ptrdiff_t);
292 static void mark_buffer (struct buffer
*);
294 #if !defined REL_ALLOC || defined SYSTEM_MALLOC || defined HYBRID_MALLOC
295 static void refill_memory_reserve (void);
297 static void compact_small_strings (void);
298 static void free_large_strings (void);
299 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
301 /* When scanning the C stack for live Lisp objects, Emacs keeps track of
302 what memory allocated via lisp_malloc and lisp_align_malloc is intended
303 for what purpose. This enumeration specifies the type of memory. */
314 /* Since all non-bool pseudovectors are small enough to be
315 allocated from vector blocks, this memory type denotes
316 large regular vectors and large bool pseudovectors. */
318 /* Special type to denote vector blocks. */
319 MEM_TYPE_VECTOR_BLOCK
,
320 /* Special type to denote reserved memory. */
324 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
326 /* A unique object in pure space used to make some Lisp objects
327 on free lists recognizable in O(1). */
329 static Lisp_Object Vdead
;
330 #define DEADP(x) EQ (x, Vdead)
332 #ifdef GC_MALLOC_CHECK
334 enum mem_type allocated_mem_type
;
336 #endif /* GC_MALLOC_CHECK */
338 /* A node in the red-black tree describing allocated memory containing
339 Lisp data. Each such block is recorded with its start and end
340 address when it is allocated, and removed from the tree when it
343 A red-black tree is a balanced binary tree with the following
346 1. Every node is either red or black.
347 2. Every leaf is black.
348 3. If a node is red, then both of its children are black.
349 4. Every simple path from a node to a descendant leaf contains
350 the same number of black nodes.
351 5. The root is always black.
353 When nodes are inserted into the tree, or deleted from the tree,
354 the tree is "fixed" so that these properties are always true.
356 A red-black tree with N internal nodes has height at most 2
357 log(N+1). Searches, insertions and deletions are done in O(log N).
358 Please see a text book about data structures for a detailed
359 description of red-black trees. Any book worth its salt should
364 /* Children of this node. These pointers are never NULL. When there
365 is no child, the value is MEM_NIL, which points to a dummy node. */
366 struct mem_node
*left
, *right
;
368 /* The parent of this node. In the root node, this is NULL. */
369 struct mem_node
*parent
;
371 /* Start and end of allocated region. */
375 enum {MEM_BLACK
, MEM_RED
} color
;
381 /* Base address of stack. Set in main. */
383 Lisp_Object
*stack_base
;
385 /* Root of the tree describing allocated Lisp memory. */
387 static struct mem_node
*mem_root
;
389 /* Lowest and highest known address in the heap. */
391 static void *min_heap_address
, *max_heap_address
;
393 /* Sentinel node of the tree. */
395 static struct mem_node mem_z
;
396 #define MEM_NIL &mem_z
398 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
399 static void mem_insert_fixup (struct mem_node
*);
400 static void mem_rotate_left (struct mem_node
*);
401 static void mem_rotate_right (struct mem_node
*);
402 static void mem_delete (struct mem_node
*);
403 static void mem_delete_fixup (struct mem_node
*);
404 static struct mem_node
*mem_find (void *);
406 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
412 /* Recording what needs to be marked for gc. */
414 struct gcpro
*gcprolist
;
416 /* Addresses of staticpro'd variables. Initialize it to a nonzero
417 value; otherwise some compilers put it into BSS. */
419 enum { NSTATICS
= 2048 };
420 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
422 /* Index of next unused slot in staticvec. */
424 static int staticidx
;
426 static void *pure_alloc (size_t, int);
428 /* Return X rounded to the next multiple of Y. Arguments should not
429 have side effects, as they are evaluated more than once. Assume X
430 + Y - 1 does not overflow. Tune for Y being a power of 2. */
432 #define ROUNDUP(x, y) ((y) & ((y) - 1) \
433 ? ((x) + (y) - 1) - ((x) + (y) - 1) % (y) \
434 : ((x) + (y) - 1) & ~ ((y) - 1))
436 /* Return PTR rounded up to the next multiple of ALIGNMENT. */
439 ALIGN (void *ptr
, int alignment
)
441 return (void *) ROUNDUP ((uintptr_t) ptr
, alignment
);
445 XFLOAT_INIT (Lisp_Object f
, double n
)
447 XFLOAT (f
)->u
.data
= n
;
451 pointers_fit_in_lispobj_p (void)
453 return (UINTPTR_MAX
<= VAL_MAX
) || USE_LSB_TAG
;
457 mmap_lisp_allowed_p (void)
459 /* If we can't store all memory addresses in our lisp objects, it's
460 risky to let the heap use mmap and give us addresses from all
461 over our address space. We also can't use mmap for lisp objects
462 if we might dump: unexec doesn't preserve the contents of mmapped
464 return pointers_fit_in_lispobj_p () && !might_dump
;
468 /************************************************************************
470 ************************************************************************/
472 /* Function malloc calls this if it finds we are near exhausting storage. */
475 malloc_warning (const char *str
)
477 pending_malloc_warning
= str
;
481 /* Display an already-pending malloc warning. */
484 display_malloc_warning (void)
486 call3 (intern ("display-warning"),
488 build_string (pending_malloc_warning
),
489 intern ("emergency"));
490 pending_malloc_warning
= 0;
493 /* Called if we can't allocate relocatable space for a buffer. */
496 buffer_memory_full (ptrdiff_t nbytes
)
498 /* If buffers use the relocating allocator, no need to free
499 spare_memory, because we may have plenty of malloc space left
500 that we could get, and if we don't, the malloc that fails will
501 itself cause spare_memory to be freed. If buffers don't use the
502 relocating allocator, treat this like any other failing
506 memory_full (nbytes
);
508 /* This used to call error, but if we've run out of memory, we could
509 get infinite recursion trying to build the string. */
510 xsignal (Qnil
, Vmemory_signal_data
);
514 /* A common multiple of the positive integers A and B. Ideally this
515 would be the least common multiple, but there's no way to do that
516 as a constant expression in C, so do the best that we can easily do. */
517 #define COMMON_MULTIPLE(a, b) \
518 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
520 #ifndef XMALLOC_OVERRUN_CHECK
521 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
524 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
527 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
528 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
529 block size in little-endian order. The trailer consists of
530 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
532 The header is used to detect whether this block has been allocated
533 through these functions, as some low-level libc functions may
534 bypass the malloc hooks. */
536 #define XMALLOC_OVERRUN_CHECK_SIZE 16
537 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
538 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
540 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
541 hold a size_t value and (2) the header size is a multiple of the
542 alignment that Emacs needs for C types and for USE_LSB_TAG. */
543 #define XMALLOC_BASE_ALIGNMENT \
544 alignof (union { long double d; intmax_t i; void *p; })
547 # define XMALLOC_HEADER_ALIGNMENT \
548 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
550 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
552 #define XMALLOC_OVERRUN_SIZE_SIZE \
553 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
554 + XMALLOC_HEADER_ALIGNMENT - 1) \
555 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
556 - XMALLOC_OVERRUN_CHECK_SIZE)
558 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
559 { '\x9a', '\x9b', '\xae', '\xaf',
560 '\xbf', '\xbe', '\xce', '\xcf',
561 '\xea', '\xeb', '\xec', '\xed',
562 '\xdf', '\xde', '\x9c', '\x9d' };
564 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
565 { '\xaa', '\xab', '\xac', '\xad',
566 '\xba', '\xbb', '\xbc', '\xbd',
567 '\xca', '\xcb', '\xcc', '\xcd',
568 '\xda', '\xdb', '\xdc', '\xdd' };
570 /* Insert and extract the block size in the header. */
573 xmalloc_put_size (unsigned char *ptr
, size_t size
)
576 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
578 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
584 xmalloc_get_size (unsigned char *ptr
)
588 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
589 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
598 /* Like malloc, but wraps allocated block with header and trailer. */
601 overrun_check_malloc (size_t size
)
603 register unsigned char *val
;
604 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
607 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
610 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
611 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
612 xmalloc_put_size (val
, size
);
613 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
614 XMALLOC_OVERRUN_CHECK_SIZE
);
620 /* Like realloc, but checks old block for overrun, and wraps new block
621 with header and trailer. */
624 overrun_check_realloc (void *block
, size_t size
)
626 register unsigned char *val
= (unsigned char *) block
;
627 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
631 && memcmp (xmalloc_overrun_check_header
,
632 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
633 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
635 size_t osize
= xmalloc_get_size (val
);
636 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
637 XMALLOC_OVERRUN_CHECK_SIZE
))
639 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
640 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
641 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
644 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
648 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
649 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
650 xmalloc_put_size (val
, size
);
651 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
652 XMALLOC_OVERRUN_CHECK_SIZE
);
657 /* Like free, but checks block for overrun. */
660 overrun_check_free (void *block
)
662 unsigned char *val
= (unsigned char *) block
;
665 && memcmp (xmalloc_overrun_check_header
,
666 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
667 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
669 size_t osize
= xmalloc_get_size (val
);
670 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
671 XMALLOC_OVERRUN_CHECK_SIZE
))
673 #ifdef XMALLOC_CLEAR_FREE_MEMORY
674 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
675 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
677 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
678 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
679 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
689 #define malloc overrun_check_malloc
690 #define realloc overrun_check_realloc
691 #define free overrun_check_free
694 /* If compiled with XMALLOC_BLOCK_INPUT_CHECK, define a symbol
695 BLOCK_INPUT_IN_MEMORY_ALLOCATORS that is visible to the debugger.
696 If that variable is set, block input while in one of Emacs's memory
697 allocation functions. There should be no need for this debugging
698 option, since signal handlers do not allocate memory, but Emacs
699 formerly allocated memory in signal handlers and this compile-time
700 option remains as a way to help debug the issue should it rear its
702 #ifdef XMALLOC_BLOCK_INPUT_CHECK
703 bool block_input_in_memory_allocators EXTERNALLY_VISIBLE
;
705 malloc_block_input (void)
707 if (block_input_in_memory_allocators
)
711 malloc_unblock_input (void)
713 if (block_input_in_memory_allocators
)
716 # define MALLOC_BLOCK_INPUT malloc_block_input ()
717 # define MALLOC_UNBLOCK_INPUT malloc_unblock_input ()
719 # define MALLOC_BLOCK_INPUT ((void) 0)
720 # define MALLOC_UNBLOCK_INPUT ((void) 0)
723 #define MALLOC_PROBE(size) \
725 if (profiler_memory_running) \
726 malloc_probe (size); \
730 /* Like malloc but check for no memory and block interrupt input.. */
733 xmalloc (size_t size
)
739 MALLOC_UNBLOCK_INPUT
;
747 /* Like the above, but zeroes out the memory just allocated. */
750 xzalloc (size_t size
)
756 MALLOC_UNBLOCK_INPUT
;
760 memset (val
, 0, size
);
765 /* Like realloc but check for no memory and block interrupt input.. */
768 xrealloc (void *block
, size_t size
)
773 /* We must call malloc explicitly when BLOCK is 0, since some
774 reallocs don't do this. */
778 val
= realloc (block
, size
);
779 MALLOC_UNBLOCK_INPUT
;
788 /* Like free but block interrupt input. */
797 MALLOC_UNBLOCK_INPUT
;
798 /* We don't call refill_memory_reserve here
799 because in practice the call in r_alloc_free seems to suffice. */
803 /* Other parts of Emacs pass large int values to allocator functions
804 expecting ptrdiff_t. This is portable in practice, but check it to
806 verify (INT_MAX
<= PTRDIFF_MAX
);
809 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
810 Signal an error on memory exhaustion, and block interrupt input. */
813 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
815 eassert (0 <= nitems
&& 0 < item_size
);
816 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
817 memory_full (SIZE_MAX
);
818 return xmalloc (nitems
* item_size
);
822 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
823 Signal an error on memory exhaustion, and block interrupt input. */
826 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
828 eassert (0 <= nitems
&& 0 < item_size
);
829 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
830 memory_full (SIZE_MAX
);
831 return xrealloc (pa
, nitems
* item_size
);
835 /* Grow PA, which points to an array of *NITEMS items, and return the
836 location of the reallocated array, updating *NITEMS to reflect its
837 new size. The new array will contain at least NITEMS_INCR_MIN more
838 items, but will not contain more than NITEMS_MAX items total.
839 ITEM_SIZE is the size of each item, in bytes.
841 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
842 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
845 If PA is null, then allocate a new array instead of reallocating
848 Block interrupt input as needed. If memory exhaustion occurs, set
849 *NITEMS to zero if PA is null, and signal an error (i.e., do not
852 Thus, to grow an array A without saving its old contents, do
853 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
854 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
855 and signals an error, and later this code is reexecuted and
856 attempts to free A. */
859 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
860 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
862 /* The approximate size to use for initial small allocation
863 requests. This is the largest "small" request for the GNU C
865 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
867 /* If the array is tiny, grow it to about (but no greater than)
868 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
869 ptrdiff_t n
= *nitems
;
870 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
871 ptrdiff_t half_again
= n
>> 1;
872 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
874 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
875 NITEMS_MAX, and what the C language can represent safely. */
876 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
877 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
878 ? nitems_max
: C_language_max
);
879 ptrdiff_t nitems_incr_max
= n_max
- n
;
880 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
882 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
885 if (nitems_incr_max
< incr
)
886 memory_full (SIZE_MAX
);
888 pa
= xrealloc (pa
, n
* item_size
);
894 /* Like strdup, but uses xmalloc. */
897 xstrdup (const char *s
)
901 size
= strlen (s
) + 1;
902 return memcpy (xmalloc (size
), s
, size
);
905 /* Like above, but duplicates Lisp string to C string. */
908 xlispstrdup (Lisp_Object string
)
910 ptrdiff_t size
= SBYTES (string
) + 1;
911 return memcpy (xmalloc (size
), SSDATA (string
), size
);
914 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
915 pointed to. If STRING is null, assign it without copying anything.
916 Allocate before freeing, to avoid a dangling pointer if allocation
920 dupstring (char **ptr
, char const *string
)
923 *ptr
= string
? xstrdup (string
) : 0;
928 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
929 argument is a const pointer. */
932 xputenv (char const *string
)
934 if (putenv ((char *) string
) != 0)
938 /* Return a newly allocated memory block of SIZE bytes, remembering
939 to free it when unwinding. */
941 record_xmalloc (size_t size
)
943 void *p
= xmalloc (size
);
944 record_unwind_protect_ptr (xfree
, p
);
949 /* Like malloc but used for allocating Lisp data. NBYTES is the
950 number of bytes to allocate, TYPE describes the intended use of the
951 allocated memory block (for strings, for conses, ...). */
954 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
958 lisp_malloc (size_t nbytes
, enum mem_type type
)
964 #ifdef GC_MALLOC_CHECK
965 allocated_mem_type
= type
;
968 val
= malloc (nbytes
);
971 /* If the memory just allocated cannot be addressed thru a Lisp
972 object's pointer, and it needs to be,
973 that's equivalent to running out of memory. */
974 if (val
&& type
!= MEM_TYPE_NON_LISP
)
977 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
978 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
980 lisp_malloc_loser
= val
;
987 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
988 if (val
&& type
!= MEM_TYPE_NON_LISP
)
989 mem_insert (val
, (char *) val
+ nbytes
, type
);
992 MALLOC_UNBLOCK_INPUT
;
994 memory_full (nbytes
);
995 MALLOC_PROBE (nbytes
);
999 /* Free BLOCK. This must be called to free memory allocated with a
1000 call to lisp_malloc. */
1003 lisp_free (void *block
)
1007 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1008 mem_delete (mem_find (block
));
1010 MALLOC_UNBLOCK_INPUT
;
1013 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
1015 /* The entry point is lisp_align_malloc which returns blocks of at most
1016 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
1018 /* Use aligned_alloc if it or a simple substitute is available.
1019 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
1020 clang 3.3 anyway. */
1022 #if ! ADDRESS_SANITIZER
1023 # if !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC
1024 # define USE_ALIGNED_ALLOC 1
1025 /* Defined in gmalloc.c. */
1026 void *aligned_alloc (size_t, size_t);
1027 # elif defined HYBRID_MALLOC
1028 # if defined ALIGNED_ALLOC || defined HAVE_POSIX_MEMALIGN
1029 # define USE_ALIGNED_ALLOC 1
1030 # define aligned_alloc hybrid_aligned_alloc
1031 /* Defined in gmalloc.c. */
1032 void *aligned_alloc (size_t, size_t);
1034 # elif defined HAVE_ALIGNED_ALLOC
1035 # define USE_ALIGNED_ALLOC 1
1036 # elif defined HAVE_POSIX_MEMALIGN
1037 # define USE_ALIGNED_ALLOC 1
1039 aligned_alloc (size_t alignment
, size_t size
)
1042 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
1047 /* BLOCK_ALIGN has to be a power of 2. */
1048 #define BLOCK_ALIGN (1 << 10)
1050 /* Padding to leave at the end of a malloc'd block. This is to give
1051 malloc a chance to minimize the amount of memory wasted to alignment.
1052 It should be tuned to the particular malloc library used.
1053 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
1054 aligned_alloc on the other hand would ideally prefer a value of 4
1055 because otherwise, there's 1020 bytes wasted between each ablocks.
1056 In Emacs, testing shows that those 1020 can most of the time be
1057 efficiently used by malloc to place other objects, so a value of 0 can
1058 still preferable unless you have a lot of aligned blocks and virtually
1060 #define BLOCK_PADDING 0
1061 #define BLOCK_BYTES \
1062 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1064 /* Internal data structures and constants. */
1066 #define ABLOCKS_SIZE 16
1068 /* An aligned block of memory. */
1073 char payload
[BLOCK_BYTES
];
1074 struct ablock
*next_free
;
1076 /* `abase' is the aligned base of the ablocks. */
1077 /* It is overloaded to hold the virtual `busy' field that counts
1078 the number of used ablock in the parent ablocks.
1079 The first ablock has the `busy' field, the others have the `abase'
1080 field. To tell the difference, we assume that pointers will have
1081 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1082 is used to tell whether the real base of the parent ablocks is `abase'
1083 (if not, the word before the first ablock holds a pointer to the
1085 struct ablocks
*abase
;
1086 /* The padding of all but the last ablock is unused. The padding of
1087 the last ablock in an ablocks is not allocated. */
1089 char padding
[BLOCK_PADDING
];
1093 /* A bunch of consecutive aligned blocks. */
1096 struct ablock blocks
[ABLOCKS_SIZE
];
1099 /* Size of the block requested from malloc or aligned_alloc. */
1100 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1102 #define ABLOCK_ABASE(block) \
1103 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1104 ? (struct ablocks *)(block) \
1107 /* Virtual `busy' field. */
1108 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1110 /* Pointer to the (not necessarily aligned) malloc block. */
1111 #ifdef USE_ALIGNED_ALLOC
1112 #define ABLOCKS_BASE(abase) (abase)
1114 #define ABLOCKS_BASE(abase) \
1115 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1118 /* The list of free ablock. */
1119 static struct ablock
*free_ablock
;
1121 /* Allocate an aligned block of nbytes.
1122 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1123 smaller or equal to BLOCK_BYTES. */
1125 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1128 struct ablocks
*abase
;
1130 eassert (nbytes
<= BLOCK_BYTES
);
1134 #ifdef GC_MALLOC_CHECK
1135 allocated_mem_type
= type
;
1141 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1143 #ifdef DOUG_LEA_MALLOC
1144 if (!mmap_lisp_allowed_p ())
1145 mallopt (M_MMAP_MAX
, 0);
1148 #ifdef USE_ALIGNED_ALLOC
1149 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1151 base
= malloc (ABLOCKS_BYTES
);
1152 abase
= ALIGN (base
, BLOCK_ALIGN
);
1157 MALLOC_UNBLOCK_INPUT
;
1158 memory_full (ABLOCKS_BYTES
);
1161 aligned
= (base
== abase
);
1163 ((void **) abase
)[-1] = base
;
1165 #ifdef DOUG_LEA_MALLOC
1166 if (!mmap_lisp_allowed_p ())
1167 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1171 /* If the memory just allocated cannot be addressed thru a Lisp
1172 object's pointer, and it needs to be, that's equivalent to
1173 running out of memory. */
1174 if (type
!= MEM_TYPE_NON_LISP
)
1177 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1178 XSETCONS (tem
, end
);
1179 if ((char *) XCONS (tem
) != end
)
1181 lisp_malloc_loser
= base
;
1183 MALLOC_UNBLOCK_INPUT
;
1184 memory_full (SIZE_MAX
);
1189 /* Initialize the blocks and put them on the free list.
1190 If `base' was not properly aligned, we can't use the last block. */
1191 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1193 abase
->blocks
[i
].abase
= abase
;
1194 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1195 free_ablock
= &abase
->blocks
[i
];
1197 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1199 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1200 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1201 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1202 eassert (ABLOCKS_BASE (abase
) == base
);
1203 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1206 abase
= ABLOCK_ABASE (free_ablock
);
1207 ABLOCKS_BUSY (abase
)
1208 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1210 free_ablock
= free_ablock
->x
.next_free
;
1212 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1213 if (type
!= MEM_TYPE_NON_LISP
)
1214 mem_insert (val
, (char *) val
+ nbytes
, type
);
1217 MALLOC_UNBLOCK_INPUT
;
1219 MALLOC_PROBE (nbytes
);
1221 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1226 lisp_align_free (void *block
)
1228 struct ablock
*ablock
= block
;
1229 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1232 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1233 mem_delete (mem_find (block
));
1235 /* Put on free list. */
1236 ablock
->x
.next_free
= free_ablock
;
1237 free_ablock
= ablock
;
1238 /* Update busy count. */
1239 ABLOCKS_BUSY (abase
)
1240 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1242 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1243 { /* All the blocks are free. */
1244 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1245 struct ablock
**tem
= &free_ablock
;
1246 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1250 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1253 *tem
= (*tem
)->x
.next_free
;
1256 tem
= &(*tem
)->x
.next_free
;
1258 eassert ((aligned
& 1) == aligned
);
1259 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1260 #ifdef USE_POSIX_MEMALIGN
1261 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1263 free (ABLOCKS_BASE (abase
));
1265 MALLOC_UNBLOCK_INPUT
;
1269 /***********************************************************************
1271 ***********************************************************************/
1273 /* Number of intervals allocated in an interval_block structure.
1274 The 1020 is 1024 minus malloc overhead. */
1276 #define INTERVAL_BLOCK_SIZE \
1277 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1279 /* Intervals are allocated in chunks in the form of an interval_block
1282 struct interval_block
1284 /* Place `intervals' first, to preserve alignment. */
1285 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1286 struct interval_block
*next
;
1289 /* Current interval block. Its `next' pointer points to older
1292 static struct interval_block
*interval_block
;
1294 /* Index in interval_block above of the next unused interval
1297 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1299 /* Number of free and live intervals. */
1301 static EMACS_INT total_free_intervals
, total_intervals
;
1303 /* List of free intervals. */
1305 static INTERVAL interval_free_list
;
1307 /* Return a new interval. */
1310 make_interval (void)
1316 if (interval_free_list
)
1318 val
= interval_free_list
;
1319 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1323 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1325 struct interval_block
*newi
1326 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1328 newi
->next
= interval_block
;
1329 interval_block
= newi
;
1330 interval_block_index
= 0;
1331 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1333 val
= &interval_block
->intervals
[interval_block_index
++];
1336 MALLOC_UNBLOCK_INPUT
;
1338 consing_since_gc
+= sizeof (struct interval
);
1340 total_free_intervals
--;
1341 RESET_INTERVAL (val
);
1347 /* Mark Lisp objects in interval I. */
1350 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1352 /* Intervals should never be shared. So, if extra internal checking is
1353 enabled, GC aborts if it seems to have visited an interval twice. */
1354 eassert (!i
->gcmarkbit
);
1356 mark_object (i
->plist
);
1359 /* Mark the interval tree rooted in I. */
1361 #define MARK_INTERVAL_TREE(i) \
1363 if (i && !i->gcmarkbit) \
1364 traverse_intervals_noorder (i, mark_interval, Qnil); \
1367 /***********************************************************************
1369 ***********************************************************************/
1371 /* Lisp_Strings are allocated in string_block structures. When a new
1372 string_block is allocated, all the Lisp_Strings it contains are
1373 added to a free-list string_free_list. When a new Lisp_String is
1374 needed, it is taken from that list. During the sweep phase of GC,
1375 string_blocks that are entirely free are freed, except two which
1378 String data is allocated from sblock structures. Strings larger
1379 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1380 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1382 Sblocks consist internally of sdata structures, one for each
1383 Lisp_String. The sdata structure points to the Lisp_String it
1384 belongs to. The Lisp_String points back to the `u.data' member of
1385 its sdata structure.
1387 When a Lisp_String is freed during GC, it is put back on
1388 string_free_list, and its `data' member and its sdata's `string'
1389 pointer is set to null. The size of the string is recorded in the
1390 `n.nbytes' member of the sdata. So, sdata structures that are no
1391 longer used, can be easily recognized, and it's easy to compact the
1392 sblocks of small strings which we do in compact_small_strings. */
1394 /* Size in bytes of an sblock structure used for small strings. This
1395 is 8192 minus malloc overhead. */
1397 #define SBLOCK_SIZE 8188
1399 /* Strings larger than this are considered large strings. String data
1400 for large strings is allocated from individual sblocks. */
1402 #define LARGE_STRING_BYTES 1024
1404 /* The SDATA typedef is a struct or union describing string memory
1405 sub-allocated from an sblock. This is where the contents of Lisp
1406 strings are stored. */
1410 /* Back-pointer to the string this sdata belongs to. If null, this
1411 structure is free, and NBYTES (in this structure or in the union below)
1412 contains the string's byte size (the same value that STRING_BYTES
1413 would return if STRING were non-null). If non-null, STRING_BYTES
1414 (STRING) is the size of the data, and DATA contains the string's
1416 struct Lisp_String
*string
;
1418 #ifdef GC_CHECK_STRING_BYTES
1422 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1425 #ifdef GC_CHECK_STRING_BYTES
1427 typedef struct sdata sdata
;
1428 #define SDATA_NBYTES(S) (S)->nbytes
1429 #define SDATA_DATA(S) (S)->data
1435 struct Lisp_String
*string
;
1437 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1438 which has a flexible array member. However, if implemented by
1439 giving this union a member of type 'struct sdata', the union
1440 could not be the last (flexible) member of 'struct sblock',
1441 because C99 prohibits a flexible array member from having a type
1442 that is itself a flexible array. So, comment this member out here,
1443 but remember that the option's there when using this union. */
1448 /* When STRING is null. */
1451 struct Lisp_String
*string
;
1456 #define SDATA_NBYTES(S) (S)->n.nbytes
1457 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1459 #endif /* not GC_CHECK_STRING_BYTES */
1461 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1463 /* Structure describing a block of memory which is sub-allocated to
1464 obtain string data memory for strings. Blocks for small strings
1465 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1466 as large as needed. */
1471 struct sblock
*next
;
1473 /* Pointer to the next free sdata block. This points past the end
1474 of the sblock if there isn't any space left in this block. */
1478 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1481 /* Number of Lisp strings in a string_block structure. The 1020 is
1482 1024 minus malloc overhead. */
1484 #define STRING_BLOCK_SIZE \
1485 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1487 /* Structure describing a block from which Lisp_String structures
1492 /* Place `strings' first, to preserve alignment. */
1493 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1494 struct string_block
*next
;
1497 /* Head and tail of the list of sblock structures holding Lisp string
1498 data. We always allocate from current_sblock. The NEXT pointers
1499 in the sblock structures go from oldest_sblock to current_sblock. */
1501 static struct sblock
*oldest_sblock
, *current_sblock
;
1503 /* List of sblocks for large strings. */
1505 static struct sblock
*large_sblocks
;
1507 /* List of string_block structures. */
1509 static struct string_block
*string_blocks
;
1511 /* Free-list of Lisp_Strings. */
1513 static struct Lisp_String
*string_free_list
;
1515 /* Number of live and free Lisp_Strings. */
1517 static EMACS_INT total_strings
, total_free_strings
;
1519 /* Number of bytes used by live strings. */
1521 static EMACS_INT total_string_bytes
;
1523 /* Given a pointer to a Lisp_String S which is on the free-list
1524 string_free_list, return a pointer to its successor in the
1527 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1529 /* Return a pointer to the sdata structure belonging to Lisp string S.
1530 S must be live, i.e. S->data must not be null. S->data is actually
1531 a pointer to the `u.data' member of its sdata structure; the
1532 structure starts at a constant offset in front of that. */
1534 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1537 #ifdef GC_CHECK_STRING_OVERRUN
1539 /* We check for overrun in string data blocks by appending a small
1540 "cookie" after each allocated string data block, and check for the
1541 presence of this cookie during GC. */
1543 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1544 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1545 { '\xde', '\xad', '\xbe', '\xef' };
1548 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1551 /* Value is the size of an sdata structure large enough to hold NBYTES
1552 bytes of string data. The value returned includes a terminating
1553 NUL byte, the size of the sdata structure, and padding. */
1555 #ifdef GC_CHECK_STRING_BYTES
1557 #define SDATA_SIZE(NBYTES) \
1558 ((SDATA_DATA_OFFSET \
1560 + sizeof (ptrdiff_t) - 1) \
1561 & ~(sizeof (ptrdiff_t) - 1))
1563 #else /* not GC_CHECK_STRING_BYTES */
1565 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1566 less than the size of that member. The 'max' is not needed when
1567 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1568 alignment code reserves enough space. */
1570 #define SDATA_SIZE(NBYTES) \
1571 ((SDATA_DATA_OFFSET \
1572 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1574 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1576 + sizeof (ptrdiff_t) - 1) \
1577 & ~(sizeof (ptrdiff_t) - 1))
1579 #endif /* not GC_CHECK_STRING_BYTES */
1581 /* Extra bytes to allocate for each string. */
1583 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1585 /* Exact bound on the number of bytes in a string, not counting the
1586 terminating null. A string cannot contain more bytes than
1587 STRING_BYTES_BOUND, nor can it be so long that the size_t
1588 arithmetic in allocate_string_data would overflow while it is
1589 calculating a value to be passed to malloc. */
1590 static ptrdiff_t const STRING_BYTES_MAX
=
1591 min (STRING_BYTES_BOUND
,
1592 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1594 - offsetof (struct sblock
, data
)
1595 - SDATA_DATA_OFFSET
)
1596 & ~(sizeof (EMACS_INT
) - 1)));
1598 /* Initialize string allocation. Called from init_alloc_once. */
1603 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1604 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1608 #ifdef GC_CHECK_STRING_BYTES
1610 static int check_string_bytes_count
;
1612 /* Like STRING_BYTES, but with debugging check. Can be
1613 called during GC, so pay attention to the mark bit. */
1616 string_bytes (struct Lisp_String
*s
)
1619 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1621 if (!PURE_POINTER_P (s
)
1623 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1628 /* Check validity of Lisp strings' string_bytes member in B. */
1631 check_sblock (struct sblock
*b
)
1633 sdata
*from
, *end
, *from_end
;
1637 for (from
= b
->data
; from
< end
; from
= from_end
)
1639 /* Compute the next FROM here because copying below may
1640 overwrite data we need to compute it. */
1643 /* Check that the string size recorded in the string is the
1644 same as the one recorded in the sdata structure. */
1645 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1646 : SDATA_NBYTES (from
));
1647 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1652 /* Check validity of Lisp strings' string_bytes member. ALL_P
1653 means check all strings, otherwise check only most
1654 recently allocated strings. Used for hunting a bug. */
1657 check_string_bytes (bool all_p
)
1663 for (b
= large_sblocks
; b
; b
= b
->next
)
1665 struct Lisp_String
*s
= b
->data
[0].string
;
1670 for (b
= oldest_sblock
; b
; b
= b
->next
)
1673 else if (current_sblock
)
1674 check_sblock (current_sblock
);
1677 #else /* not GC_CHECK_STRING_BYTES */
1679 #define check_string_bytes(all) ((void) 0)
1681 #endif /* GC_CHECK_STRING_BYTES */
1683 #ifdef GC_CHECK_STRING_FREE_LIST
1685 /* Walk through the string free list looking for bogus next pointers.
1686 This may catch buffer overrun from a previous string. */
1689 check_string_free_list (void)
1691 struct Lisp_String
*s
;
1693 /* Pop a Lisp_String off the free-list. */
1694 s
= string_free_list
;
1697 if ((uintptr_t) s
< 1024)
1699 s
= NEXT_FREE_LISP_STRING (s
);
1703 #define check_string_free_list()
1706 /* Return a new Lisp_String. */
1708 static struct Lisp_String
*
1709 allocate_string (void)
1711 struct Lisp_String
*s
;
1715 /* If the free-list is empty, allocate a new string_block, and
1716 add all the Lisp_Strings in it to the free-list. */
1717 if (string_free_list
== NULL
)
1719 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1722 b
->next
= string_blocks
;
1725 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1728 /* Every string on a free list should have NULL data pointer. */
1730 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1731 string_free_list
= s
;
1734 total_free_strings
+= STRING_BLOCK_SIZE
;
1737 check_string_free_list ();
1739 /* Pop a Lisp_String off the free-list. */
1740 s
= string_free_list
;
1741 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1743 MALLOC_UNBLOCK_INPUT
;
1745 --total_free_strings
;
1748 consing_since_gc
+= sizeof *s
;
1750 #ifdef GC_CHECK_STRING_BYTES
1751 if (!noninteractive
)
1753 if (++check_string_bytes_count
== 200)
1755 check_string_bytes_count
= 0;
1756 check_string_bytes (1);
1759 check_string_bytes (0);
1761 #endif /* GC_CHECK_STRING_BYTES */
1767 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1768 plus a NUL byte at the end. Allocate an sdata structure for S, and
1769 set S->data to its `u.data' member. Store a NUL byte at the end of
1770 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1771 S->data if it was initially non-null. */
1774 allocate_string_data (struct Lisp_String
*s
,
1775 EMACS_INT nchars
, EMACS_INT nbytes
)
1777 sdata
*data
, *old_data
;
1779 ptrdiff_t needed
, old_nbytes
;
1781 if (STRING_BYTES_MAX
< nbytes
)
1784 /* Determine the number of bytes needed to store NBYTES bytes
1786 needed
= SDATA_SIZE (nbytes
);
1789 old_data
= SDATA_OF_STRING (s
);
1790 old_nbytes
= STRING_BYTES (s
);
1797 if (nbytes
> LARGE_STRING_BYTES
)
1799 size_t size
= offsetof (struct sblock
, data
) + needed
;
1801 #ifdef DOUG_LEA_MALLOC
1802 if (!mmap_lisp_allowed_p ())
1803 mallopt (M_MMAP_MAX
, 0);
1806 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1808 #ifdef DOUG_LEA_MALLOC
1809 if (!mmap_lisp_allowed_p ())
1810 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1813 b
->next_free
= b
->data
;
1814 b
->data
[0].string
= NULL
;
1815 b
->next
= large_sblocks
;
1818 else if (current_sblock
== NULL
1819 || (((char *) current_sblock
+ SBLOCK_SIZE
1820 - (char *) current_sblock
->next_free
)
1821 < (needed
+ GC_STRING_EXTRA
)))
1823 /* Not enough room in the current sblock. */
1824 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1825 b
->next_free
= b
->data
;
1826 b
->data
[0].string
= NULL
;
1830 current_sblock
->next
= b
;
1838 data
= b
->next_free
;
1839 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1841 MALLOC_UNBLOCK_INPUT
;
1844 s
->data
= SDATA_DATA (data
);
1845 #ifdef GC_CHECK_STRING_BYTES
1846 SDATA_NBYTES (data
) = nbytes
;
1849 s
->size_byte
= nbytes
;
1850 s
->data
[nbytes
] = '\0';
1851 #ifdef GC_CHECK_STRING_OVERRUN
1852 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1853 GC_STRING_OVERRUN_COOKIE_SIZE
);
1856 /* Note that Faset may call to this function when S has already data
1857 assigned. In this case, mark data as free by setting it's string
1858 back-pointer to null, and record the size of the data in it. */
1861 SDATA_NBYTES (old_data
) = old_nbytes
;
1862 old_data
->string
= NULL
;
1865 consing_since_gc
+= needed
;
1869 /* Sweep and compact strings. */
1871 NO_INLINE
/* For better stack traces */
1873 sweep_strings (void)
1875 struct string_block
*b
, *next
;
1876 struct string_block
*live_blocks
= NULL
;
1878 string_free_list
= NULL
;
1879 total_strings
= total_free_strings
= 0;
1880 total_string_bytes
= 0;
1882 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1883 for (b
= string_blocks
; b
; b
= next
)
1886 struct Lisp_String
*free_list_before
= string_free_list
;
1890 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1892 struct Lisp_String
*s
= b
->strings
+ i
;
1896 /* String was not on free-list before. */
1897 if (STRING_MARKED_P (s
))
1899 /* String is live; unmark it and its intervals. */
1902 /* Do not use string_(set|get)_intervals here. */
1903 s
->intervals
= balance_intervals (s
->intervals
);
1906 total_string_bytes
+= STRING_BYTES (s
);
1910 /* String is dead. Put it on the free-list. */
1911 sdata
*data
= SDATA_OF_STRING (s
);
1913 /* Save the size of S in its sdata so that we know
1914 how large that is. Reset the sdata's string
1915 back-pointer so that we know it's free. */
1916 #ifdef GC_CHECK_STRING_BYTES
1917 if (string_bytes (s
) != SDATA_NBYTES (data
))
1920 data
->n
.nbytes
= STRING_BYTES (s
);
1922 data
->string
= NULL
;
1924 /* Reset the strings's `data' member so that we
1928 /* Put the string on the free-list. */
1929 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1930 string_free_list
= s
;
1936 /* S was on the free-list before. Put it there again. */
1937 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1938 string_free_list
= s
;
1943 /* Free blocks that contain free Lisp_Strings only, except
1944 the first two of them. */
1945 if (nfree
== STRING_BLOCK_SIZE
1946 && total_free_strings
> STRING_BLOCK_SIZE
)
1949 string_free_list
= free_list_before
;
1953 total_free_strings
+= nfree
;
1954 b
->next
= live_blocks
;
1959 check_string_free_list ();
1961 string_blocks
= live_blocks
;
1962 free_large_strings ();
1963 compact_small_strings ();
1965 check_string_free_list ();
1969 /* Free dead large strings. */
1972 free_large_strings (void)
1974 struct sblock
*b
, *next
;
1975 struct sblock
*live_blocks
= NULL
;
1977 for (b
= large_sblocks
; b
; b
= next
)
1981 if (b
->data
[0].string
== NULL
)
1985 b
->next
= live_blocks
;
1990 large_sblocks
= live_blocks
;
1994 /* Compact data of small strings. Free sblocks that don't contain
1995 data of live strings after compaction. */
1998 compact_small_strings (void)
2000 struct sblock
*b
, *tb
, *next
;
2001 sdata
*from
, *to
, *end
, *tb_end
;
2002 sdata
*to_end
, *from_end
;
2004 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2005 to, and TB_END is the end of TB. */
2007 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2010 /* Step through the blocks from the oldest to the youngest. We
2011 expect that old blocks will stabilize over time, so that less
2012 copying will happen this way. */
2013 for (b
= oldest_sblock
; b
; b
= b
->next
)
2016 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2018 for (from
= b
->data
; from
< end
; from
= from_end
)
2020 /* Compute the next FROM here because copying below may
2021 overwrite data we need to compute it. */
2023 struct Lisp_String
*s
= from
->string
;
2025 #ifdef GC_CHECK_STRING_BYTES
2026 /* Check that the string size recorded in the string is the
2027 same as the one recorded in the sdata structure. */
2028 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2030 #endif /* GC_CHECK_STRING_BYTES */
2032 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2033 eassert (nbytes
<= LARGE_STRING_BYTES
);
2035 nbytes
= SDATA_SIZE (nbytes
);
2036 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2038 #ifdef GC_CHECK_STRING_OVERRUN
2039 if (memcmp (string_overrun_cookie
,
2040 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2041 GC_STRING_OVERRUN_COOKIE_SIZE
))
2045 /* Non-NULL S means it's alive. Copy its data. */
2048 /* If TB is full, proceed with the next sblock. */
2049 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2050 if (to_end
> tb_end
)
2054 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2056 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2059 /* Copy, and update the string's `data' pointer. */
2062 eassert (tb
!= b
|| to
< from
);
2063 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2064 to
->string
->data
= SDATA_DATA (to
);
2067 /* Advance past the sdata we copied to. */
2073 /* The rest of the sblocks following TB don't contain live data, so
2074 we can free them. */
2075 for (b
= tb
->next
; b
; b
= next
)
2083 current_sblock
= tb
;
2087 string_overflow (void)
2089 error ("Maximum string size exceeded");
2092 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2093 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2094 LENGTH must be an integer.
2095 INIT must be an integer that represents a character. */)
2096 (Lisp_Object length
, Lisp_Object init
)
2098 register Lisp_Object val
;
2102 CHECK_NATNUM (length
);
2103 CHECK_CHARACTER (init
);
2105 c
= XFASTINT (init
);
2106 if (ASCII_CHAR_P (c
))
2108 nbytes
= XINT (length
);
2109 val
= make_uninit_string (nbytes
);
2110 memset (SDATA (val
), c
, nbytes
);
2111 SDATA (val
)[nbytes
] = 0;
2115 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2116 ptrdiff_t len
= CHAR_STRING (c
, str
);
2117 EMACS_INT string_len
= XINT (length
);
2118 unsigned char *p
, *beg
, *end
;
2120 if (string_len
> STRING_BYTES_MAX
/ len
)
2122 nbytes
= len
* string_len
;
2123 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2124 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2126 /* First time we just copy `str' to the data of `val'. */
2128 memcpy (p
, str
, len
);
2131 /* Next time we copy largest possible chunk from
2132 initialized to uninitialized part of `val'. */
2133 len
= min (p
- beg
, end
- p
);
2134 memcpy (p
, beg
, len
);
2143 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2147 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2149 EMACS_INT nbits
= bool_vector_size (a
);
2152 unsigned char *data
= bool_vector_uchar_data (a
);
2153 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2154 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2155 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2156 memset (data
, pattern
, nbytes
- 1);
2157 data
[nbytes
- 1] = pattern
& last_mask
;
2162 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2165 make_uninit_bool_vector (EMACS_INT nbits
)
2168 EMACS_INT words
= bool_vector_words (nbits
);
2169 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2170 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2173 struct Lisp_Bool_Vector
*p
2174 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2175 XSETVECTOR (val
, p
);
2176 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2179 /* Clear padding at the end. */
2181 p
->data
[words
- 1] = 0;
2186 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2187 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2188 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2189 (Lisp_Object length
, Lisp_Object init
)
2193 CHECK_NATNUM (length
);
2194 val
= make_uninit_bool_vector (XFASTINT (length
));
2195 return bool_vector_fill (val
, init
);
2198 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2199 doc
: /* Return a new bool-vector with specified arguments as elements.
2200 Any number of arguments, even zero arguments, are allowed.
2201 usage: (bool-vector &rest OBJECTS) */)
2202 (ptrdiff_t nargs
, Lisp_Object
*args
)
2207 vector
= make_uninit_bool_vector (nargs
);
2208 for (i
= 0; i
< nargs
; i
++)
2209 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2214 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2215 of characters from the contents. This string may be unibyte or
2216 multibyte, depending on the contents. */
2219 make_string (const char *contents
, ptrdiff_t nbytes
)
2221 register Lisp_Object val
;
2222 ptrdiff_t nchars
, multibyte_nbytes
;
2224 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2225 &nchars
, &multibyte_nbytes
);
2226 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2227 /* CONTENTS contains no multibyte sequences or contains an invalid
2228 multibyte sequence. We must make unibyte string. */
2229 val
= make_unibyte_string (contents
, nbytes
);
2231 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2235 #ifdef USE_LOCAL_ALLOCATORS
2237 /* Initialize the string S from DATA and SIZE. S must be followed by
2238 SIZE + 1 bytes of memory that can be used. Return S tagged as a
2242 local_string_init (struct Lisp_String
*s
, char const *data
, ptrdiff_t size
)
2244 unsigned char *data_copy
= (unsigned char *) (s
+ 1);
2245 parse_str_as_multibyte ((unsigned char const *) data
,
2246 size
, &s
->size
, &s
->size_byte
);
2247 if (size
== s
->size
|| size
!= s
->size_byte
)
2252 s
->intervals
= NULL
;
2253 s
->data
= data_copy
;
2254 memcpy (data_copy
, data
, size
);
2255 data_copy
[size
] = '\0';
2256 return make_lisp_ptr (s
, Lisp_String
);
2262 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2265 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2267 register Lisp_Object val
;
2268 val
= make_uninit_string (length
);
2269 memcpy (SDATA (val
), contents
, length
);
2274 /* Make a multibyte string from NCHARS characters occupying NBYTES
2275 bytes at CONTENTS. */
2278 make_multibyte_string (const char *contents
,
2279 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2281 register Lisp_Object val
;
2282 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2283 memcpy (SDATA (val
), contents
, nbytes
);
2288 /* Make a string from NCHARS characters occupying NBYTES bytes at
2289 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2292 make_string_from_bytes (const char *contents
,
2293 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2295 register Lisp_Object val
;
2296 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2297 memcpy (SDATA (val
), contents
, nbytes
);
2298 if (SBYTES (val
) == SCHARS (val
))
2299 STRING_SET_UNIBYTE (val
);
2304 /* Make a string from NCHARS characters occupying NBYTES bytes at
2305 CONTENTS. The argument MULTIBYTE controls whether to label the
2306 string as multibyte. If NCHARS is negative, it counts the number of
2307 characters by itself. */
2310 make_specified_string (const char *contents
,
2311 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2318 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2323 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2324 memcpy (SDATA (val
), contents
, nbytes
);
2326 STRING_SET_UNIBYTE (val
);
2331 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2332 occupying LENGTH bytes. */
2335 make_uninit_string (EMACS_INT length
)
2340 return empty_unibyte_string
;
2341 val
= make_uninit_multibyte_string (length
, length
);
2342 STRING_SET_UNIBYTE (val
);
2347 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2348 which occupy NBYTES bytes. */
2351 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2354 struct Lisp_String
*s
;
2359 return empty_multibyte_string
;
2361 s
= allocate_string ();
2362 s
->intervals
= NULL
;
2363 allocate_string_data (s
, nchars
, nbytes
);
2364 XSETSTRING (string
, s
);
2365 string_chars_consed
+= nbytes
;
2369 /* Print arguments to BUF according to a FORMAT, then return
2370 a Lisp_String initialized with the data from BUF. */
2373 make_formatted_string (char *buf
, const char *format
, ...)
2378 va_start (ap
, format
);
2379 length
= vsprintf (buf
, format
, ap
);
2381 return make_string (buf
, length
);
2385 /***********************************************************************
2387 ***********************************************************************/
2389 /* We store float cells inside of float_blocks, allocating a new
2390 float_block with malloc whenever necessary. Float cells reclaimed
2391 by GC are put on a free list to be reallocated before allocating
2392 any new float cells from the latest float_block. */
2394 #define FLOAT_BLOCK_SIZE \
2395 (((BLOCK_BYTES - sizeof (struct float_block *) \
2396 /* The compiler might add padding at the end. */ \
2397 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2398 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2400 #define GETMARKBIT(block,n) \
2401 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2402 >> ((n) % BITS_PER_BITS_WORD)) \
2405 #define SETMARKBIT(block,n) \
2406 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2407 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2409 #define UNSETMARKBIT(block,n) \
2410 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2411 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2413 #define FLOAT_BLOCK(fptr) \
2414 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2416 #define FLOAT_INDEX(fptr) \
2417 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2421 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2422 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2423 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2424 struct float_block
*next
;
2427 #define FLOAT_MARKED_P(fptr) \
2428 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2430 #define FLOAT_MARK(fptr) \
2431 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2433 #define FLOAT_UNMARK(fptr) \
2434 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2436 /* Current float_block. */
2438 static struct float_block
*float_block
;
2440 /* Index of first unused Lisp_Float in the current float_block. */
2442 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2444 /* Free-list of Lisp_Floats. */
2446 static struct Lisp_Float
*float_free_list
;
2448 /* Return a new float object with value FLOAT_VALUE. */
2451 make_float (double float_value
)
2453 register Lisp_Object val
;
2457 if (float_free_list
)
2459 /* We use the data field for chaining the free list
2460 so that we won't use the same field that has the mark bit. */
2461 XSETFLOAT (val
, float_free_list
);
2462 float_free_list
= float_free_list
->u
.chain
;
2466 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2468 struct float_block
*new
2469 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2470 new->next
= float_block
;
2471 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2473 float_block_index
= 0;
2474 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2476 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2477 float_block_index
++;
2480 MALLOC_UNBLOCK_INPUT
;
2482 XFLOAT_INIT (val
, float_value
);
2483 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2484 consing_since_gc
+= sizeof (struct Lisp_Float
);
2486 total_free_floats
--;
2492 /***********************************************************************
2494 ***********************************************************************/
2496 /* We store cons cells inside of cons_blocks, allocating a new
2497 cons_block with malloc whenever necessary. Cons cells reclaimed by
2498 GC are put on a free list to be reallocated before allocating
2499 any new cons cells from the latest cons_block. */
2501 #define CONS_BLOCK_SIZE \
2502 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2503 /* The compiler might add padding at the end. */ \
2504 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2505 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2507 #define CONS_BLOCK(fptr) \
2508 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2510 #define CONS_INDEX(fptr) \
2511 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2515 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2516 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2517 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2518 struct cons_block
*next
;
2521 #define CONS_MARKED_P(fptr) \
2522 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2524 #define CONS_MARK(fptr) \
2525 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2527 #define CONS_UNMARK(fptr) \
2528 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2530 /* Current cons_block. */
2532 static struct cons_block
*cons_block
;
2534 /* Index of first unused Lisp_Cons in the current block. */
2536 static int cons_block_index
= CONS_BLOCK_SIZE
;
2538 /* Free-list of Lisp_Cons structures. */
2540 static struct Lisp_Cons
*cons_free_list
;
2542 /* Explicitly free a cons cell by putting it on the free-list. */
2545 free_cons (struct Lisp_Cons
*ptr
)
2547 ptr
->u
.chain
= cons_free_list
;
2551 cons_free_list
= ptr
;
2552 consing_since_gc
-= sizeof *ptr
;
2553 total_free_conses
++;
2556 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2557 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2558 (Lisp_Object car
, Lisp_Object cdr
)
2560 register Lisp_Object val
;
2566 /* We use the cdr for chaining the free list
2567 so that we won't use the same field that has the mark bit. */
2568 XSETCONS (val
, cons_free_list
);
2569 cons_free_list
= cons_free_list
->u
.chain
;
2573 if (cons_block_index
== CONS_BLOCK_SIZE
)
2575 struct cons_block
*new
2576 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2577 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2578 new->next
= cons_block
;
2580 cons_block_index
= 0;
2581 total_free_conses
+= CONS_BLOCK_SIZE
;
2583 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2587 MALLOC_UNBLOCK_INPUT
;
2591 eassert (!CONS_MARKED_P (XCONS (val
)));
2592 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2593 total_free_conses
--;
2594 cons_cells_consed
++;
2598 #ifdef GC_CHECK_CONS_LIST
2599 /* Get an error now if there's any junk in the cons free list. */
2601 check_cons_list (void)
2603 struct Lisp_Cons
*tail
= cons_free_list
;
2606 tail
= tail
->u
.chain
;
2610 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2613 list1 (Lisp_Object arg1
)
2615 return Fcons (arg1
, Qnil
);
2619 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2621 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2626 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2628 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2633 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2635 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2640 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2642 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2643 Fcons (arg5
, Qnil
)))));
2646 /* Make a list of COUNT Lisp_Objects, where ARG is the
2647 first one. Allocate conses from pure space if TYPE
2648 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2651 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2653 Lisp_Object (*cons
) (Lisp_Object
, Lisp_Object
);
2656 case CONSTYPE_PURE
: cons
= pure_cons
; break;
2657 case CONSTYPE_HEAP
: cons
= Fcons
; break;
2658 default: emacs_abort ();
2661 eassume (0 < count
);
2662 Lisp_Object val
= cons (arg
, Qnil
);
2663 Lisp_Object tail
= val
;
2667 for (ptrdiff_t i
= 1; i
< count
; i
++)
2669 Lisp_Object elem
= cons (va_arg (ap
, Lisp_Object
), Qnil
);
2670 XSETCDR (tail
, elem
);
2678 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2679 doc
: /* Return a newly created list with specified arguments as elements.
2680 Any number of arguments, even zero arguments, are allowed.
2681 usage: (list &rest OBJECTS) */)
2682 (ptrdiff_t nargs
, Lisp_Object
*args
)
2684 register Lisp_Object val
;
2690 val
= Fcons (args
[nargs
], val
);
2696 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2697 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2698 (register Lisp_Object length
, Lisp_Object init
)
2700 register Lisp_Object val
;
2701 register EMACS_INT size
;
2703 CHECK_NATNUM (length
);
2704 size
= XFASTINT (length
);
2709 val
= Fcons (init
, val
);
2714 val
= Fcons (init
, val
);
2719 val
= Fcons (init
, val
);
2724 val
= Fcons (init
, val
);
2729 val
= Fcons (init
, val
);
2744 /***********************************************************************
2746 ***********************************************************************/
2748 /* Sometimes a vector's contents are merely a pointer internally used
2749 in vector allocation code. On the rare platforms where a null
2750 pointer cannot be tagged, represent it with a Lisp 0.
2751 Usually you don't want to touch this. */
2753 static struct Lisp_Vector
*
2754 next_vector (struct Lisp_Vector
*v
)
2756 return XUNTAG (v
->contents
[0], 0);
2760 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2762 v
->contents
[0] = make_lisp_ptr (p
, 0);
2765 /* This value is balanced well enough to avoid too much internal overhead
2766 for the most common cases; it's not required to be a power of two, but
2767 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2769 #define VECTOR_BLOCK_SIZE 4096
2773 /* Alignment of struct Lisp_Vector objects. */
2774 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2775 USE_LSB_TAG
? GCALIGNMENT
: 1),
2777 /* Vector size requests are a multiple of this. */
2778 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2781 /* Verify assumptions described above. */
2782 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2783 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2785 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2786 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2787 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2788 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2790 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2792 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2794 /* Size of the minimal vector allocated from block. */
2796 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2798 /* Size of the largest vector allocated from block. */
2800 #define VBLOCK_BYTES_MAX \
2801 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2803 /* We maintain one free list for each possible block-allocated
2804 vector size, and this is the number of free lists we have. */
2806 #define VECTOR_MAX_FREE_LIST_INDEX \
2807 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2809 /* Common shortcut to advance vector pointer over a block data. */
2811 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2813 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2815 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2817 /* Common shortcut to setup vector on a free list. */
2819 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2821 (tmp) = ((nbytes - header_size) / word_size); \
2822 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2823 eassert ((nbytes) % roundup_size == 0); \
2824 (tmp) = VINDEX (nbytes); \
2825 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2826 set_next_vector (v, vector_free_lists[tmp]); \
2827 vector_free_lists[tmp] = (v); \
2828 total_free_vector_slots += (nbytes) / word_size; \
2831 /* This internal type is used to maintain the list of large vectors
2832 which are allocated at their own, e.g. outside of vector blocks.
2834 struct large_vector itself cannot contain a struct Lisp_Vector, as
2835 the latter contains a flexible array member and C99 does not allow
2836 such structs to be nested. Instead, each struct large_vector
2837 object LV is followed by a struct Lisp_Vector, which is at offset
2838 large_vector_offset from LV, and whose address is therefore
2839 large_vector_vec (&LV). */
2843 struct large_vector
*next
;
2848 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2851 static struct Lisp_Vector
*
2852 large_vector_vec (struct large_vector
*p
)
2854 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
2857 /* This internal type is used to maintain an underlying storage
2858 for small vectors. */
2862 char data
[VECTOR_BLOCK_BYTES
];
2863 struct vector_block
*next
;
2866 /* Chain of vector blocks. */
2868 static struct vector_block
*vector_blocks
;
2870 /* Vector free lists, where NTH item points to a chain of free
2871 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2873 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2875 /* Singly-linked list of large vectors. */
2877 static struct large_vector
*large_vectors
;
2879 /* The only vector with 0 slots, allocated from pure space. */
2881 Lisp_Object zero_vector
;
2883 /* Number of live vectors. */
2885 static EMACS_INT total_vectors
;
2887 /* Total size of live and free vectors, in Lisp_Object units. */
2889 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2891 /* Get a new vector block. */
2893 static struct vector_block
*
2894 allocate_vector_block (void)
2896 struct vector_block
*block
= xmalloc (sizeof *block
);
2898 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2899 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2900 MEM_TYPE_VECTOR_BLOCK
);
2903 block
->next
= vector_blocks
;
2904 vector_blocks
= block
;
2908 /* Called once to initialize vector allocation. */
2913 zero_vector
= make_pure_vector (0);
2916 /* Allocate vector from a vector block. */
2918 static struct Lisp_Vector
*
2919 allocate_vector_from_block (size_t nbytes
)
2921 struct Lisp_Vector
*vector
;
2922 struct vector_block
*block
;
2923 size_t index
, restbytes
;
2925 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2926 eassert (nbytes
% roundup_size
== 0);
2928 /* First, try to allocate from a free list
2929 containing vectors of the requested size. */
2930 index
= VINDEX (nbytes
);
2931 if (vector_free_lists
[index
])
2933 vector
= vector_free_lists
[index
];
2934 vector_free_lists
[index
] = next_vector (vector
);
2935 total_free_vector_slots
-= nbytes
/ word_size
;
2939 /* Next, check free lists containing larger vectors. Since
2940 we will split the result, we should have remaining space
2941 large enough to use for one-slot vector at least. */
2942 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
2943 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
2944 if (vector_free_lists
[index
])
2946 /* This vector is larger than requested. */
2947 vector
= vector_free_lists
[index
];
2948 vector_free_lists
[index
] = next_vector (vector
);
2949 total_free_vector_slots
-= nbytes
/ word_size
;
2951 /* Excess bytes are used for the smaller vector,
2952 which should be set on an appropriate free list. */
2953 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
2954 eassert (restbytes
% roundup_size
== 0);
2955 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2959 /* Finally, need a new vector block. */
2960 block
= allocate_vector_block ();
2962 /* New vector will be at the beginning of this block. */
2963 vector
= (struct Lisp_Vector
*) block
->data
;
2965 /* If the rest of space from this block is large enough
2966 for one-slot vector at least, set up it on a free list. */
2967 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
2968 if (restbytes
>= VBLOCK_BYTES_MIN
)
2970 eassert (restbytes
% roundup_size
== 0);
2971 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2976 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
2978 #define VECTOR_IN_BLOCK(vector, block) \
2979 ((char *) (vector) <= (block)->data \
2980 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
2982 /* Return the memory footprint of V in bytes. */
2985 vector_nbytes (struct Lisp_Vector
*v
)
2987 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
2990 if (size
& PSEUDOVECTOR_FLAG
)
2992 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
2994 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
2995 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
2996 * sizeof (bits_word
));
2997 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
2998 verify (header_size
<= bool_header_size
);
2999 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
3002 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
3003 + ((size
& PSEUDOVECTOR_REST_MASK
)
3004 >> PSEUDOVECTOR_SIZE_BITS
));
3008 return vroundup (header_size
+ word_size
* nwords
);
3011 /* Release extra resources still in use by VECTOR, which may be any
3012 vector-like object. For now, this is used just to free data in
3016 cleanup_vector (struct Lisp_Vector
*vector
)
3018 detect_suspicious_free (vector
);
3019 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
3020 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
3021 == FONT_OBJECT_MAX
))
3023 struct font_driver
*drv
= ((struct font
*) vector
)->driver
;
3025 /* The font driver might sometimes be NULL, e.g. if Emacs was
3026 interrupted before it had time to set it up. */
3029 /* Attempt to catch subtle bugs like Bug#16140. */
3030 eassert (valid_font_driver (drv
));
3031 drv
->close ((struct font
*) vector
);
3036 /* Reclaim space used by unmarked vectors. */
3038 NO_INLINE
/* For better stack traces */
3040 sweep_vectors (void)
3042 struct vector_block
*block
, **bprev
= &vector_blocks
;
3043 struct large_vector
*lv
, **lvprev
= &large_vectors
;
3044 struct Lisp_Vector
*vector
, *next
;
3046 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3047 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3049 /* Looking through vector blocks. */
3051 for (block
= vector_blocks
; block
; block
= *bprev
)
3053 bool free_this_block
= 0;
3056 for (vector
= (struct Lisp_Vector
*) block
->data
;
3057 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3059 if (VECTOR_MARKED_P (vector
))
3061 VECTOR_UNMARK (vector
);
3063 nbytes
= vector_nbytes (vector
);
3064 total_vector_slots
+= nbytes
/ word_size
;
3065 next
= ADVANCE (vector
, nbytes
);
3069 ptrdiff_t total_bytes
;
3071 cleanup_vector (vector
);
3072 nbytes
= vector_nbytes (vector
);
3073 total_bytes
= nbytes
;
3074 next
= ADVANCE (vector
, nbytes
);
3076 /* While NEXT is not marked, try to coalesce with VECTOR,
3077 thus making VECTOR of the largest possible size. */
3079 while (VECTOR_IN_BLOCK (next
, block
))
3081 if (VECTOR_MARKED_P (next
))
3083 cleanup_vector (next
);
3084 nbytes
= vector_nbytes (next
);
3085 total_bytes
+= nbytes
;
3086 next
= ADVANCE (next
, nbytes
);
3089 eassert (total_bytes
% roundup_size
== 0);
3091 if (vector
== (struct Lisp_Vector
*) block
->data
3092 && !VECTOR_IN_BLOCK (next
, block
))
3093 /* This block should be freed because all of its
3094 space was coalesced into the only free vector. */
3095 free_this_block
= 1;
3099 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3104 if (free_this_block
)
3106 *bprev
= block
->next
;
3107 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3108 mem_delete (mem_find (block
->data
));
3113 bprev
= &block
->next
;
3116 /* Sweep large vectors. */
3118 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
3120 vector
= large_vector_vec (lv
);
3121 if (VECTOR_MARKED_P (vector
))
3123 VECTOR_UNMARK (vector
);
3125 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3127 /* All non-bool pseudovectors are small enough to be allocated
3128 from vector blocks. This code should be redesigned if some
3129 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3130 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3131 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3135 += header_size
/ word_size
+ vector
->header
.size
;
3146 /* Value is a pointer to a newly allocated Lisp_Vector structure
3147 with room for LEN Lisp_Objects. */
3149 static struct Lisp_Vector
*
3150 allocate_vectorlike (ptrdiff_t len
)
3152 struct Lisp_Vector
*p
;
3157 p
= XVECTOR (zero_vector
);
3160 size_t nbytes
= header_size
+ len
* word_size
;
3162 #ifdef DOUG_LEA_MALLOC
3163 if (!mmap_lisp_allowed_p ())
3164 mallopt (M_MMAP_MAX
, 0);
3167 if (nbytes
<= VBLOCK_BYTES_MAX
)
3168 p
= allocate_vector_from_block (vroundup (nbytes
));
3171 struct large_vector
*lv
3172 = lisp_malloc ((large_vector_offset
+ header_size
3174 MEM_TYPE_VECTORLIKE
);
3175 lv
->next
= large_vectors
;
3177 p
= large_vector_vec (lv
);
3180 #ifdef DOUG_LEA_MALLOC
3181 if (!mmap_lisp_allowed_p ())
3182 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3185 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3188 consing_since_gc
+= nbytes
;
3189 vector_cells_consed
+= len
;
3192 MALLOC_UNBLOCK_INPUT
;
3198 /* Allocate a vector with LEN slots. */
3200 struct Lisp_Vector
*
3201 allocate_vector (EMACS_INT len
)
3203 struct Lisp_Vector
*v
;
3204 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3206 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3207 memory_full (SIZE_MAX
);
3208 v
= allocate_vectorlike (len
);
3209 v
->header
.size
= len
;
3214 /* Allocate other vector-like structures. */
3216 struct Lisp_Vector
*
3217 allocate_pseudovector (int memlen
, int lisplen
, enum pvec_type tag
)
3219 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3222 /* Catch bogus values. */
3223 eassert (tag
<= PVEC_FONT
);
3224 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3225 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3227 /* Only the first lisplen slots will be traced normally by the GC. */
3228 for (i
= 0; i
< lisplen
; ++i
)
3229 v
->contents
[i
] = Qnil
;
3231 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3236 allocate_buffer (void)
3238 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3240 BUFFER_PVEC_INIT (b
);
3241 /* Put B on the chain of all buffers including killed ones. */
3242 b
->next
= all_buffers
;
3244 /* Note that the rest fields of B are not initialized. */
3248 struct Lisp_Hash_Table
*
3249 allocate_hash_table (void)
3251 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3255 allocate_window (void)
3259 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3260 /* Users assumes that non-Lisp data is zeroed. */
3261 memset (&w
->current_matrix
, 0,
3262 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3267 allocate_terminal (void)
3271 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3272 /* Users assumes that non-Lisp data is zeroed. */
3273 memset (&t
->next_terminal
, 0,
3274 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3279 allocate_frame (void)
3283 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3284 /* Users assumes that non-Lisp data is zeroed. */
3285 memset (&f
->face_cache
, 0,
3286 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3290 struct Lisp_Process
*
3291 allocate_process (void)
3293 struct Lisp_Process
*p
;
3295 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3296 /* Users assumes that non-Lisp data is zeroed. */
3298 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3302 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3303 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3304 See also the function `vector'. */)
3305 (register Lisp_Object length
, Lisp_Object init
)
3308 register ptrdiff_t sizei
;
3309 register ptrdiff_t i
;
3310 register struct Lisp_Vector
*p
;
3312 CHECK_NATNUM (length
);
3314 p
= allocate_vector (XFASTINT (length
));
3315 sizei
= XFASTINT (length
);
3316 for (i
= 0; i
< sizei
; i
++)
3317 p
->contents
[i
] = init
;
3319 XSETVECTOR (vector
, p
);
3323 #ifdef USE_LOCAL_ALLOCATORS
3325 /* Initialize V with LENGTH objects each with value INIT,
3326 and return it tagged as a Lisp Object. */
3329 local_vector_init (struct Lisp_Vector
*v
, ptrdiff_t length
, Lisp_Object init
)
3331 v
->header
.size
= length
;
3332 for (ptrdiff_t i
= 0; i
< length
; i
++)
3333 v
->contents
[i
] = init
;
3334 return make_lisp_ptr (v
, Lisp_Vectorlike
);
3340 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3341 doc
: /* Return a newly created vector with specified arguments as elements.
3342 Any number of arguments, even zero arguments, are allowed.
3343 usage: (vector &rest OBJECTS) */)
3344 (ptrdiff_t nargs
, Lisp_Object
*args
)
3347 register Lisp_Object val
= make_uninit_vector (nargs
);
3348 register struct Lisp_Vector
*p
= XVECTOR (val
);
3350 for (i
= 0; i
< nargs
; i
++)
3351 p
->contents
[i
] = args
[i
];
3356 make_byte_code (struct Lisp_Vector
*v
)
3358 /* Don't allow the global zero_vector to become a byte code object. */
3359 eassert (0 < v
->header
.size
);
3361 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3362 && STRING_MULTIBYTE (v
->contents
[1]))
3363 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3364 earlier because they produced a raw 8-bit string for byte-code
3365 and now such a byte-code string is loaded as multibyte while
3366 raw 8-bit characters converted to multibyte form. Thus, now we
3367 must convert them back to the original unibyte form. */
3368 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3369 XSETPVECTYPE (v
, PVEC_COMPILED
);
3372 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3373 doc
: /* Create a byte-code object with specified arguments as elements.
3374 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3375 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3376 and (optional) INTERACTIVE-SPEC.
3377 The first four arguments are required; at most six have any
3379 The ARGLIST can be either like the one of `lambda', in which case the arguments
3380 will be dynamically bound before executing the byte code, or it can be an
3381 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3382 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3383 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3384 argument to catch the left-over arguments. If such an integer is used, the
3385 arguments will not be dynamically bound but will be instead pushed on the
3386 stack before executing the byte-code.
3387 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3388 (ptrdiff_t nargs
, Lisp_Object
*args
)
3391 register Lisp_Object val
= make_uninit_vector (nargs
);
3392 register struct Lisp_Vector
*p
= XVECTOR (val
);
3394 /* We used to purecopy everything here, if purify-flag was set. This worked
3395 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3396 dangerous, since make-byte-code is used during execution to build
3397 closures, so any closure built during the preload phase would end up
3398 copied into pure space, including its free variables, which is sometimes
3399 just wasteful and other times plainly wrong (e.g. those free vars may want
3402 for (i
= 0; i
< nargs
; i
++)
3403 p
->contents
[i
] = args
[i
];
3405 XSETCOMPILED (val
, p
);
3411 /***********************************************************************
3413 ***********************************************************************/
3415 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3416 of the required alignment if LSB tags are used. */
3418 union aligned_Lisp_Symbol
3420 struct Lisp_Symbol s
;
3422 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3427 /* Each symbol_block is just under 1020 bytes long, since malloc
3428 really allocates in units of powers of two and uses 4 bytes for its
3431 #define SYMBOL_BLOCK_SIZE \
3432 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3436 /* Place `symbols' first, to preserve alignment. */
3437 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3438 struct symbol_block
*next
;
3441 /* Current symbol block and index of first unused Lisp_Symbol
3444 static struct symbol_block
*symbol_block
;
3445 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3446 /* Pointer to the first symbol_block that contains pinned symbols.
3447 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3448 10K of which are pinned (and all but 250 of them are interned in obarray),
3449 whereas a "typical session" has in the order of 30K symbols.
3450 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3451 than 30K to find the 10K symbols we need to mark. */
3452 static struct symbol_block
*symbol_block_pinned
;
3454 /* List of free symbols. */
3456 static struct Lisp_Symbol
*symbol_free_list
;
3459 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3461 XSYMBOL (sym
)->name
= name
;
3464 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3465 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3466 Its value is void, and its function definition and property list are nil. */)
3469 register Lisp_Object val
;
3470 register struct Lisp_Symbol
*p
;
3472 CHECK_STRING (name
);
3476 if (symbol_free_list
)
3478 XSETSYMBOL (val
, symbol_free_list
);
3479 symbol_free_list
= symbol_free_list
->next
;
3483 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3485 struct symbol_block
*new
3486 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3487 new->next
= symbol_block
;
3489 symbol_block_index
= 0;
3490 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3492 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3493 symbol_block_index
++;
3496 MALLOC_UNBLOCK_INPUT
;
3499 set_symbol_name (val
, name
);
3500 set_symbol_plist (val
, Qnil
);
3501 p
->redirect
= SYMBOL_PLAINVAL
;
3502 SET_SYMBOL_VAL (p
, Qunbound
);
3503 set_symbol_function (val
, Qnil
);
3504 set_symbol_next (val
, NULL
);
3505 p
->gcmarkbit
= false;
3506 p
->interned
= SYMBOL_UNINTERNED
;
3508 p
->declared_special
= false;
3510 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3512 total_free_symbols
--;
3518 /***********************************************************************
3519 Marker (Misc) Allocation
3520 ***********************************************************************/
3522 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3523 the required alignment when LSB tags are used. */
3525 union aligned_Lisp_Misc
3529 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3534 /* Allocation of markers and other objects that share that structure.
3535 Works like allocation of conses. */
3537 #define MARKER_BLOCK_SIZE \
3538 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3542 /* Place `markers' first, to preserve alignment. */
3543 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3544 struct marker_block
*next
;
3547 static struct marker_block
*marker_block
;
3548 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3550 static union Lisp_Misc
*marker_free_list
;
3552 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3555 allocate_misc (enum Lisp_Misc_Type type
)
3561 if (marker_free_list
)
3563 XSETMISC (val
, marker_free_list
);
3564 marker_free_list
= marker_free_list
->u_free
.chain
;
3568 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3570 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3571 new->next
= marker_block
;
3573 marker_block_index
= 0;
3574 total_free_markers
+= MARKER_BLOCK_SIZE
;
3576 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3577 marker_block_index
++;
3580 MALLOC_UNBLOCK_INPUT
;
3582 --total_free_markers
;
3583 consing_since_gc
+= sizeof (union Lisp_Misc
);
3584 misc_objects_consed
++;
3585 XMISCANY (val
)->type
= type
;
3586 XMISCANY (val
)->gcmarkbit
= 0;
3590 /* Free a Lisp_Misc object. */
3593 free_misc (Lisp_Object misc
)
3595 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3596 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3597 marker_free_list
= XMISC (misc
);
3598 consing_since_gc
-= sizeof (union Lisp_Misc
);
3599 total_free_markers
++;
3602 /* Verify properties of Lisp_Save_Value's representation
3603 that are assumed here and elsewhere. */
3605 verify (SAVE_UNUSED
== 0);
3606 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3610 /* Return Lisp_Save_Value objects for the various combinations
3611 that callers need. */
3614 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3616 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3617 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3618 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3619 p
->data
[0].integer
= a
;
3620 p
->data
[1].integer
= b
;
3621 p
->data
[2].integer
= c
;
3626 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3629 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3630 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3631 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3632 p
->data
[0].object
= a
;
3633 p
->data
[1].object
= b
;
3634 p
->data
[2].object
= c
;
3635 p
->data
[3].object
= d
;
3640 make_save_ptr (void *a
)
3642 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3643 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3644 p
->save_type
= SAVE_POINTER
;
3645 p
->data
[0].pointer
= a
;
3650 make_save_ptr_int (void *a
, ptrdiff_t b
)
3652 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3653 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3654 p
->save_type
= SAVE_TYPE_PTR_INT
;
3655 p
->data
[0].pointer
= a
;
3656 p
->data
[1].integer
= b
;
3660 #if ! (defined USE_X_TOOLKIT || defined USE_GTK)
3662 make_save_ptr_ptr (void *a
, void *b
)
3664 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3665 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3666 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3667 p
->data
[0].pointer
= a
;
3668 p
->data
[1].pointer
= b
;
3674 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3676 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3677 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3678 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3679 p
->data
[0].funcpointer
= a
;
3680 p
->data
[1].pointer
= b
;
3681 p
->data
[2].object
= c
;
3685 /* Return a Lisp_Save_Value object that represents an array A
3686 of N Lisp objects. */
3689 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3691 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3692 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3693 p
->save_type
= SAVE_TYPE_MEMORY
;
3694 p
->data
[0].pointer
= a
;
3695 p
->data
[1].integer
= n
;
3699 /* Free a Lisp_Save_Value object. Do not use this function
3700 if SAVE contains pointer other than returned by xmalloc. */
3703 free_save_value (Lisp_Object save
)
3705 xfree (XSAVE_POINTER (save
, 0));
3709 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3712 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3714 register Lisp_Object overlay
;
3716 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3717 OVERLAY_START (overlay
) = start
;
3718 OVERLAY_END (overlay
) = end
;
3719 set_overlay_plist (overlay
, plist
);
3720 XOVERLAY (overlay
)->next
= NULL
;
3724 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3725 doc
: /* Return a newly allocated marker which does not point at any place. */)
3728 register Lisp_Object val
;
3729 register struct Lisp_Marker
*p
;
3731 val
= allocate_misc (Lisp_Misc_Marker
);
3737 p
->insertion_type
= 0;
3738 p
->need_adjustment
= 0;
3742 /* Return a newly allocated marker which points into BUF
3743 at character position CHARPOS and byte position BYTEPOS. */
3746 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3749 struct Lisp_Marker
*m
;
3751 /* No dead buffers here. */
3752 eassert (BUFFER_LIVE_P (buf
));
3754 /* Every character is at least one byte. */
3755 eassert (charpos
<= bytepos
);
3757 obj
= allocate_misc (Lisp_Misc_Marker
);
3760 m
->charpos
= charpos
;
3761 m
->bytepos
= bytepos
;
3762 m
->insertion_type
= 0;
3763 m
->need_adjustment
= 0;
3764 m
->next
= BUF_MARKERS (buf
);
3765 BUF_MARKERS (buf
) = m
;
3769 /* Put MARKER back on the free list after using it temporarily. */
3772 free_marker (Lisp_Object marker
)
3774 unchain_marker (XMARKER (marker
));
3779 /* Return a newly created vector or string with specified arguments as
3780 elements. If all the arguments are characters that can fit
3781 in a string of events, make a string; otherwise, make a vector.
3783 Any number of arguments, even zero arguments, are allowed. */
3786 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3790 for (i
= 0; i
< nargs
; i
++)
3791 /* The things that fit in a string
3792 are characters that are in 0...127,
3793 after discarding the meta bit and all the bits above it. */
3794 if (!INTEGERP (args
[i
])
3795 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3796 return Fvector (nargs
, args
);
3798 /* Since the loop exited, we know that all the things in it are
3799 characters, so we can make a string. */
3803 result
= Fmake_string (make_number (nargs
), make_number (0));
3804 for (i
= 0; i
< nargs
; i
++)
3806 SSET (result
, i
, XINT (args
[i
]));
3807 /* Move the meta bit to the right place for a string char. */
3808 if (XINT (args
[i
]) & CHAR_META
)
3809 SSET (result
, i
, SREF (result
, i
) | 0x80);
3818 /************************************************************************
3819 Memory Full Handling
3820 ************************************************************************/
3823 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3824 there may have been size_t overflow so that malloc was never
3825 called, or perhaps malloc was invoked successfully but the
3826 resulting pointer had problems fitting into a tagged EMACS_INT. In
3827 either case this counts as memory being full even though malloc did
3831 memory_full (size_t nbytes
)
3833 /* Do not go into hysterics merely because a large request failed. */
3834 bool enough_free_memory
= 0;
3835 if (SPARE_MEMORY
< nbytes
)
3840 p
= malloc (SPARE_MEMORY
);
3844 enough_free_memory
= 1;
3846 MALLOC_UNBLOCK_INPUT
;
3849 if (! enough_free_memory
)
3855 memory_full_cons_threshold
= sizeof (struct cons_block
);
3857 /* The first time we get here, free the spare memory. */
3858 for (i
= 0; i
< ARRAYELTS (spare_memory
); i
++)
3859 if (spare_memory
[i
])
3862 free (spare_memory
[i
]);
3863 else if (i
>= 1 && i
<= 4)
3864 lisp_align_free (spare_memory
[i
]);
3866 lisp_free (spare_memory
[i
]);
3867 spare_memory
[i
] = 0;
3871 /* This used to call error, but if we've run out of memory, we could
3872 get infinite recursion trying to build the string. */
3873 xsignal (Qnil
, Vmemory_signal_data
);
3876 /* If we released our reserve (due to running out of memory),
3877 and we have a fair amount free once again,
3878 try to set aside another reserve in case we run out once more.
3880 This is called when a relocatable block is freed in ralloc.c,
3881 and also directly from this file, in case we're not using ralloc.c. */
3884 refill_memory_reserve (void)
3886 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3887 if (spare_memory
[0] == 0)
3888 spare_memory
[0] = malloc (SPARE_MEMORY
);
3889 if (spare_memory
[1] == 0)
3890 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3892 if (spare_memory
[2] == 0)
3893 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3895 if (spare_memory
[3] == 0)
3896 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3898 if (spare_memory
[4] == 0)
3899 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3901 if (spare_memory
[5] == 0)
3902 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3904 if (spare_memory
[6] == 0)
3905 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3907 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3908 Vmemory_full
= Qnil
;
3912 /************************************************************************
3914 ************************************************************************/
3916 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3918 /* Conservative C stack marking requires a method to identify possibly
3919 live Lisp objects given a pointer value. We do this by keeping
3920 track of blocks of Lisp data that are allocated in a red-black tree
3921 (see also the comment of mem_node which is the type of nodes in
3922 that tree). Function lisp_malloc adds information for an allocated
3923 block to the red-black tree with calls to mem_insert, and function
3924 lisp_free removes it with mem_delete. Functions live_string_p etc
3925 call mem_find to lookup information about a given pointer in the
3926 tree, and use that to determine if the pointer points to a Lisp
3929 /* Initialize this part of alloc.c. */
3934 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3935 mem_z
.parent
= NULL
;
3936 mem_z
.color
= MEM_BLACK
;
3937 mem_z
.start
= mem_z
.end
= NULL
;
3942 /* Value is a pointer to the mem_node containing START. Value is
3943 MEM_NIL if there is no node in the tree containing START. */
3945 static struct mem_node
*
3946 mem_find (void *start
)
3950 if (start
< min_heap_address
|| start
> max_heap_address
)
3953 /* Make the search always successful to speed up the loop below. */
3954 mem_z
.start
= start
;
3955 mem_z
.end
= (char *) start
+ 1;
3958 while (start
< p
->start
|| start
>= p
->end
)
3959 p
= start
< p
->start
? p
->left
: p
->right
;
3964 /* Insert a new node into the tree for a block of memory with start
3965 address START, end address END, and type TYPE. Value is a
3966 pointer to the node that was inserted. */
3968 static struct mem_node
*
3969 mem_insert (void *start
, void *end
, enum mem_type type
)
3971 struct mem_node
*c
, *parent
, *x
;
3973 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3974 min_heap_address
= start
;
3975 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3976 max_heap_address
= end
;
3978 /* See where in the tree a node for START belongs. In this
3979 particular application, it shouldn't happen that a node is already
3980 present. For debugging purposes, let's check that. */
3984 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3986 while (c
!= MEM_NIL
)
3988 if (start
>= c
->start
&& start
< c
->end
)
3991 c
= start
< c
->start
? c
->left
: c
->right
;
3994 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3996 while (c
!= MEM_NIL
)
3999 c
= start
< c
->start
? c
->left
: c
->right
;
4002 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
4004 /* Create a new node. */
4005 #ifdef GC_MALLOC_CHECK
4006 x
= malloc (sizeof *x
);
4010 x
= xmalloc (sizeof *x
);
4016 x
->left
= x
->right
= MEM_NIL
;
4019 /* Insert it as child of PARENT or install it as root. */
4022 if (start
< parent
->start
)
4030 /* Re-establish red-black tree properties. */
4031 mem_insert_fixup (x
);
4037 /* Re-establish the red-black properties of the tree, and thereby
4038 balance the tree, after node X has been inserted; X is always red. */
4041 mem_insert_fixup (struct mem_node
*x
)
4043 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
4045 /* X is red and its parent is red. This is a violation of
4046 red-black tree property #3. */
4048 if (x
->parent
== x
->parent
->parent
->left
)
4050 /* We're on the left side of our grandparent, and Y is our
4052 struct mem_node
*y
= x
->parent
->parent
->right
;
4054 if (y
->color
== MEM_RED
)
4056 /* Uncle and parent are red but should be black because
4057 X is red. Change the colors accordingly and proceed
4058 with the grandparent. */
4059 x
->parent
->color
= MEM_BLACK
;
4060 y
->color
= MEM_BLACK
;
4061 x
->parent
->parent
->color
= MEM_RED
;
4062 x
= x
->parent
->parent
;
4066 /* Parent and uncle have different colors; parent is
4067 red, uncle is black. */
4068 if (x
== x
->parent
->right
)
4071 mem_rotate_left (x
);
4074 x
->parent
->color
= MEM_BLACK
;
4075 x
->parent
->parent
->color
= MEM_RED
;
4076 mem_rotate_right (x
->parent
->parent
);
4081 /* This is the symmetrical case of above. */
4082 struct mem_node
*y
= x
->parent
->parent
->left
;
4084 if (y
->color
== MEM_RED
)
4086 x
->parent
->color
= MEM_BLACK
;
4087 y
->color
= MEM_BLACK
;
4088 x
->parent
->parent
->color
= MEM_RED
;
4089 x
= x
->parent
->parent
;
4093 if (x
== x
->parent
->left
)
4096 mem_rotate_right (x
);
4099 x
->parent
->color
= MEM_BLACK
;
4100 x
->parent
->parent
->color
= MEM_RED
;
4101 mem_rotate_left (x
->parent
->parent
);
4106 /* The root may have been changed to red due to the algorithm. Set
4107 it to black so that property #5 is satisfied. */
4108 mem_root
->color
= MEM_BLACK
;
4119 mem_rotate_left (struct mem_node
*x
)
4123 /* Turn y's left sub-tree into x's right sub-tree. */
4126 if (y
->left
!= MEM_NIL
)
4127 y
->left
->parent
= x
;
4129 /* Y's parent was x's parent. */
4131 y
->parent
= x
->parent
;
4133 /* Get the parent to point to y instead of x. */
4136 if (x
== x
->parent
->left
)
4137 x
->parent
->left
= y
;
4139 x
->parent
->right
= y
;
4144 /* Put x on y's left. */
4158 mem_rotate_right (struct mem_node
*x
)
4160 struct mem_node
*y
= x
->left
;
4163 if (y
->right
!= MEM_NIL
)
4164 y
->right
->parent
= x
;
4167 y
->parent
= x
->parent
;
4170 if (x
== x
->parent
->right
)
4171 x
->parent
->right
= y
;
4173 x
->parent
->left
= y
;
4184 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4187 mem_delete (struct mem_node
*z
)
4189 struct mem_node
*x
, *y
;
4191 if (!z
|| z
== MEM_NIL
)
4194 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4199 while (y
->left
!= MEM_NIL
)
4203 if (y
->left
!= MEM_NIL
)
4208 x
->parent
= y
->parent
;
4211 if (y
== y
->parent
->left
)
4212 y
->parent
->left
= x
;
4214 y
->parent
->right
= x
;
4221 z
->start
= y
->start
;
4226 if (y
->color
== MEM_BLACK
)
4227 mem_delete_fixup (x
);
4229 #ifdef GC_MALLOC_CHECK
4237 /* Re-establish the red-black properties of the tree, after a
4241 mem_delete_fixup (struct mem_node
*x
)
4243 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4245 if (x
== x
->parent
->left
)
4247 struct mem_node
*w
= x
->parent
->right
;
4249 if (w
->color
== MEM_RED
)
4251 w
->color
= MEM_BLACK
;
4252 x
->parent
->color
= MEM_RED
;
4253 mem_rotate_left (x
->parent
);
4254 w
= x
->parent
->right
;
4257 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4264 if (w
->right
->color
== MEM_BLACK
)
4266 w
->left
->color
= MEM_BLACK
;
4268 mem_rotate_right (w
);
4269 w
= x
->parent
->right
;
4271 w
->color
= x
->parent
->color
;
4272 x
->parent
->color
= MEM_BLACK
;
4273 w
->right
->color
= MEM_BLACK
;
4274 mem_rotate_left (x
->parent
);
4280 struct mem_node
*w
= x
->parent
->left
;
4282 if (w
->color
== MEM_RED
)
4284 w
->color
= MEM_BLACK
;
4285 x
->parent
->color
= MEM_RED
;
4286 mem_rotate_right (x
->parent
);
4287 w
= x
->parent
->left
;
4290 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4297 if (w
->left
->color
== MEM_BLACK
)
4299 w
->right
->color
= MEM_BLACK
;
4301 mem_rotate_left (w
);
4302 w
= x
->parent
->left
;
4305 w
->color
= x
->parent
->color
;
4306 x
->parent
->color
= MEM_BLACK
;
4307 w
->left
->color
= MEM_BLACK
;
4308 mem_rotate_right (x
->parent
);
4314 x
->color
= MEM_BLACK
;
4318 /* Value is non-zero if P is a pointer to a live Lisp string on
4319 the heap. M is a pointer to the mem_block for P. */
4322 live_string_p (struct mem_node
*m
, void *p
)
4324 if (m
->type
== MEM_TYPE_STRING
)
4326 struct string_block
*b
= m
->start
;
4327 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4329 /* P must point to the start of a Lisp_String structure, and it
4330 must not be on the free-list. */
4332 && offset
% sizeof b
->strings
[0] == 0
4333 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4334 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4341 /* Value is non-zero if P is a pointer to a live Lisp cons on
4342 the heap. M is a pointer to the mem_block for P. */
4345 live_cons_p (struct mem_node
*m
, void *p
)
4347 if (m
->type
== MEM_TYPE_CONS
)
4349 struct cons_block
*b
= m
->start
;
4350 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4352 /* P must point to the start of a Lisp_Cons, not be
4353 one of the unused cells in the current cons block,
4354 and not be on the free-list. */
4356 && offset
% sizeof b
->conses
[0] == 0
4357 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4359 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4360 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4367 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4368 the heap. M is a pointer to the mem_block for P. */
4371 live_symbol_p (struct mem_node
*m
, void *p
)
4373 if (m
->type
== MEM_TYPE_SYMBOL
)
4375 struct symbol_block
*b
= m
->start
;
4376 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4378 /* P must point to the start of a Lisp_Symbol, not be
4379 one of the unused cells in the current symbol block,
4380 and not be on the free-list. */
4382 && offset
% sizeof b
->symbols
[0] == 0
4383 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4384 && (b
!= symbol_block
4385 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4386 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4393 /* Value is non-zero if P is a pointer to a live Lisp float on
4394 the heap. M is a pointer to the mem_block for P. */
4397 live_float_p (struct mem_node
*m
, void *p
)
4399 if (m
->type
== MEM_TYPE_FLOAT
)
4401 struct float_block
*b
= m
->start
;
4402 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4404 /* P must point to the start of a Lisp_Float and not be
4405 one of the unused cells in the current float block. */
4407 && offset
% sizeof b
->floats
[0] == 0
4408 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4409 && (b
!= float_block
4410 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4417 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4418 the heap. M is a pointer to the mem_block for P. */
4421 live_misc_p (struct mem_node
*m
, void *p
)
4423 if (m
->type
== MEM_TYPE_MISC
)
4425 struct marker_block
*b
= m
->start
;
4426 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4428 /* P must point to the start of a Lisp_Misc, not be
4429 one of the unused cells in the current misc block,
4430 and not be on the free-list. */
4432 && offset
% sizeof b
->markers
[0] == 0
4433 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4434 && (b
!= marker_block
4435 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4436 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4443 /* Value is non-zero if P is a pointer to a live vector-like object.
4444 M is a pointer to the mem_block for P. */
4447 live_vector_p (struct mem_node
*m
, void *p
)
4449 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4451 /* This memory node corresponds to a vector block. */
4452 struct vector_block
*block
= m
->start
;
4453 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4455 /* P is in the block's allocation range. Scan the block
4456 up to P and see whether P points to the start of some
4457 vector which is not on a free list. FIXME: check whether
4458 some allocation patterns (probably a lot of short vectors)
4459 may cause a substantial overhead of this loop. */
4460 while (VECTOR_IN_BLOCK (vector
, block
)
4461 && vector
<= (struct Lisp_Vector
*) p
)
4463 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4466 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4469 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4470 /* This memory node corresponds to a large vector. */
4476 /* Value is non-zero if P is a pointer to a live buffer. M is a
4477 pointer to the mem_block for P. */
4480 live_buffer_p (struct mem_node
*m
, void *p
)
4482 /* P must point to the start of the block, and the buffer
4483 must not have been killed. */
4484 return (m
->type
== MEM_TYPE_BUFFER
4486 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4489 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4493 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4495 /* Currently not used, but may be called from gdb. */
4497 void dump_zombies (void) EXTERNALLY_VISIBLE
;
4499 /* Array of objects that are kept alive because the C stack contains
4500 a pattern that looks like a reference to them. */
4502 #define MAX_ZOMBIES 10
4503 static Lisp_Object zombies
[MAX_ZOMBIES
];
4505 /* Number of zombie objects. */
4507 static EMACS_INT nzombies
;
4509 /* Number of garbage collections. */
4511 static EMACS_INT ngcs
;
4513 /* Average percentage of zombies per collection. */
4515 static double avg_zombies
;
4517 /* Max. number of live and zombie objects. */
4519 static EMACS_INT max_live
, max_zombies
;
4521 /* Average number of live objects per GC. */
4523 static double avg_live
;
4525 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4526 doc
: /* Show information about live and zombie objects. */)
4529 Lisp_Object args
[8], zombie_list
= Qnil
;
4531 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4532 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4533 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4534 args
[1] = make_number (ngcs
);
4535 args
[2] = make_float (avg_live
);
4536 args
[3] = make_float (avg_zombies
);
4537 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4538 args
[5] = make_number (max_live
);
4539 args
[6] = make_number (max_zombies
);
4540 args
[7] = zombie_list
;
4541 return Fmessage (8, args
);
4544 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4547 /* Mark OBJ if we can prove it's a Lisp_Object. */
4550 mark_maybe_object (Lisp_Object obj
)
4557 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4563 po
= (void *) XPNTR (obj
);
4570 switch (XTYPE (obj
))
4573 mark_p
= (live_string_p (m
, po
)
4574 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4578 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4582 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4586 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4589 case Lisp_Vectorlike
:
4590 /* Note: can't check BUFFERP before we know it's a
4591 buffer because checking that dereferences the pointer
4592 PO which might point anywhere. */
4593 if (live_vector_p (m
, po
))
4594 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4595 else if (live_buffer_p (m
, po
))
4596 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4600 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4609 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4610 if (nzombies
< MAX_ZOMBIES
)
4611 zombies
[nzombies
] = obj
;
4619 /* Return true if P can point to Lisp data, and false otherwise.
4620 USE_LSB_TAG needs Lisp data to be aligned on multiples of GCALIGNMENT.
4621 Otherwise, assume that Lisp data is aligned on even addresses. */
4624 maybe_lisp_pointer (void *p
)
4626 return !((intptr_t) p
% (USE_LSB_TAG
? GCALIGNMENT
: 2));
4629 /* If P points to Lisp data, mark that as live if it isn't already
4633 mark_maybe_pointer (void *p
)
4639 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4642 if (!maybe_lisp_pointer (p
))
4648 Lisp_Object obj
= Qnil
;
4652 case MEM_TYPE_NON_LISP
:
4653 case MEM_TYPE_SPARE
:
4654 /* Nothing to do; not a pointer to Lisp memory. */
4657 case MEM_TYPE_BUFFER
:
4658 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4659 XSETVECTOR (obj
, p
);
4663 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4667 case MEM_TYPE_STRING
:
4668 if (live_string_p (m
, p
)
4669 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4670 XSETSTRING (obj
, p
);
4674 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4678 case MEM_TYPE_SYMBOL
:
4679 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4680 XSETSYMBOL (obj
, p
);
4683 case MEM_TYPE_FLOAT
:
4684 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4688 case MEM_TYPE_VECTORLIKE
:
4689 case MEM_TYPE_VECTOR_BLOCK
:
4690 if (live_vector_p (m
, p
))
4693 XSETVECTOR (tem
, p
);
4694 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4709 /* Alignment of pointer values. Use alignof, as it sometimes returns
4710 a smaller alignment than GCC's __alignof__ and mark_memory might
4711 miss objects if __alignof__ were used. */
4712 #define GC_POINTER_ALIGNMENT alignof (void *)
4714 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4715 not suffice, which is the typical case. A host where a Lisp_Object is
4716 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4717 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4718 suffice to widen it to to a Lisp_Object and check it that way. */
4719 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4720 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4721 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4722 nor mark_maybe_object can follow the pointers. This should not occur on
4723 any practical porting target. */
4724 # error "MSB type bits straddle pointer-word boundaries"
4726 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4727 pointer words that hold pointers ORed with type bits. */
4728 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4730 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4731 words that hold unmodified pointers. */
4732 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4735 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4736 or END+OFFSET..START. */
4738 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4739 mark_memory (void *start
, void *end
)
4744 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4748 /* Make START the pointer to the start of the memory region,
4749 if it isn't already. */
4757 /* Mark Lisp data pointed to. This is necessary because, in some
4758 situations, the C compiler optimizes Lisp objects away, so that
4759 only a pointer to them remains. Example:
4761 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4764 Lisp_Object obj = build_string ("test");
4765 struct Lisp_String *s = XSTRING (obj);
4766 Fgarbage_collect ();
4767 fprintf (stderr, "test `%s'\n", s->data);
4771 Here, `obj' isn't really used, and the compiler optimizes it
4772 away. The only reference to the life string is through the
4775 for (pp
= start
; (void *) pp
< end
; pp
++)
4776 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4778 void *p
= *(void **) ((char *) pp
+ i
);
4779 mark_maybe_pointer (p
);
4780 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4781 mark_maybe_object (XIL ((intptr_t) p
));
4785 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4787 static bool setjmp_tested_p
;
4788 static int longjmps_done
;
4790 #define SETJMP_WILL_LIKELY_WORK "\
4792 Emacs garbage collector has been changed to use conservative stack\n\
4793 marking. Emacs has determined that the method it uses to do the\n\
4794 marking will likely work on your system, but this isn't sure.\n\
4796 If you are a system-programmer, or can get the help of a local wizard\n\
4797 who is, please take a look at the function mark_stack in alloc.c, and\n\
4798 verify that the methods used are appropriate for your system.\n\
4800 Please mail the result to <emacs-devel@gnu.org>.\n\
4803 #define SETJMP_WILL_NOT_WORK "\
4805 Emacs garbage collector has been changed to use conservative stack\n\
4806 marking. Emacs has determined that the default method it uses to do the\n\
4807 marking will not work on your system. We will need a system-dependent\n\
4808 solution for your system.\n\
4810 Please take a look at the function mark_stack in alloc.c, and\n\
4811 try to find a way to make it work on your system.\n\
4813 Note that you may get false negatives, depending on the compiler.\n\
4814 In particular, you need to use -O with GCC for this test.\n\
4816 Please mail the result to <emacs-devel@gnu.org>.\n\
4820 /* Perform a quick check if it looks like setjmp saves registers in a
4821 jmp_buf. Print a message to stderr saying so. When this test
4822 succeeds, this is _not_ a proof that setjmp is sufficient for
4823 conservative stack marking. Only the sources or a disassembly
4833 /* Arrange for X to be put in a register. */
4839 if (longjmps_done
== 1)
4841 /* Came here after the longjmp at the end of the function.
4843 If x == 1, the longjmp has restored the register to its
4844 value before the setjmp, and we can hope that setjmp
4845 saves all such registers in the jmp_buf, although that
4848 For other values of X, either something really strange is
4849 taking place, or the setjmp just didn't save the register. */
4852 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4855 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4862 if (longjmps_done
== 1)
4863 sys_longjmp (jbuf
, 1);
4866 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4869 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4871 /* Abort if anything GCPRO'd doesn't survive the GC. */
4879 for (p
= gcprolist
; p
; p
= p
->next
)
4880 for (i
= 0; i
< p
->nvars
; ++i
)
4881 if (!survives_gc_p (p
->var
[i
]))
4882 /* FIXME: It's not necessarily a bug. It might just be that the
4883 GCPRO is unnecessary or should release the object sooner. */
4887 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4894 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4895 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4897 fprintf (stderr
, " %d = ", i
);
4898 debug_print (zombies
[i
]);
4902 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4905 /* Mark live Lisp objects on the C stack.
4907 There are several system-dependent problems to consider when
4908 porting this to new architectures:
4912 We have to mark Lisp objects in CPU registers that can hold local
4913 variables or are used to pass parameters.
4915 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4916 something that either saves relevant registers on the stack, or
4917 calls mark_maybe_object passing it each register's contents.
4919 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4920 implementation assumes that calling setjmp saves registers we need
4921 to see in a jmp_buf which itself lies on the stack. This doesn't
4922 have to be true! It must be verified for each system, possibly
4923 by taking a look at the source code of setjmp.
4925 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4926 can use it as a machine independent method to store all registers
4927 to the stack. In this case the macros described in the previous
4928 two paragraphs are not used.
4932 Architectures differ in the way their processor stack is organized.
4933 For example, the stack might look like this
4936 | Lisp_Object | size = 4
4938 | something else | size = 2
4940 | Lisp_Object | size = 4
4944 In such a case, not every Lisp_Object will be aligned equally. To
4945 find all Lisp_Object on the stack it won't be sufficient to walk
4946 the stack in steps of 4 bytes. Instead, two passes will be
4947 necessary, one starting at the start of the stack, and a second
4948 pass starting at the start of the stack + 2. Likewise, if the
4949 minimal alignment of Lisp_Objects on the stack is 1, four passes
4950 would be necessary, each one starting with one byte more offset
4951 from the stack start. */
4954 mark_stack (void *end
)
4957 /* This assumes that the stack is a contiguous region in memory. If
4958 that's not the case, something has to be done here to iterate
4959 over the stack segments. */
4960 mark_memory (stack_base
, end
);
4962 /* Allow for marking a secondary stack, like the register stack on the
4964 #ifdef GC_MARK_SECONDARY_STACK
4965 GC_MARK_SECONDARY_STACK ();
4968 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4973 #else /* GC_MARK_STACK == 0 */
4975 #define mark_maybe_object(obj) emacs_abort ()
4977 #endif /* GC_MARK_STACK != 0 */
4980 /* Determine whether it is safe to access memory at address P. */
4982 valid_pointer_p (void *p
)
4985 return w32_valid_pointer_p (p
, 16);
4989 /* Obviously, we cannot just access it (we would SEGV trying), so we
4990 trick the o/s to tell us whether p is a valid pointer.
4991 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4992 not validate p in that case. */
4994 if (emacs_pipe (fd
) == 0)
4996 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
4997 emacs_close (fd
[1]);
4998 emacs_close (fd
[0]);
5006 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
5007 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
5008 cannot validate OBJ. This function can be quite slow, so its primary
5009 use is the manual debugging. The only exception is print_object, where
5010 we use it to check whether the memory referenced by the pointer of
5011 Lisp_Save_Value object contains valid objects. */
5014 valid_lisp_object_p (Lisp_Object obj
)
5024 p
= (void *) XPNTR (obj
);
5025 if (PURE_POINTER_P (p
))
5028 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
5032 return valid_pointer_p (p
);
5039 int valid
= valid_pointer_p (p
);
5051 case MEM_TYPE_NON_LISP
:
5052 case MEM_TYPE_SPARE
:
5055 case MEM_TYPE_BUFFER
:
5056 return live_buffer_p (m
, p
) ? 1 : 2;
5059 return live_cons_p (m
, p
);
5061 case MEM_TYPE_STRING
:
5062 return live_string_p (m
, p
);
5065 return live_misc_p (m
, p
);
5067 case MEM_TYPE_SYMBOL
:
5068 return live_symbol_p (m
, p
);
5070 case MEM_TYPE_FLOAT
:
5071 return live_float_p (m
, p
);
5073 case MEM_TYPE_VECTORLIKE
:
5074 case MEM_TYPE_VECTOR_BLOCK
:
5075 return live_vector_p (m
, p
);
5085 /* If GC_MARK_STACK, return 1 if STR is a relocatable data of Lisp_String
5086 (i.e. there is a non-pure Lisp_Object X so that SDATA (X) == STR) and 0
5087 if not. Otherwise we can't rely on valid_lisp_object_p and return -1.
5088 This function is slow and should be used for debugging purposes. */
5091 relocatable_string_data_p (const char *str
)
5093 if (PURE_POINTER_P (str
))
5099 = (struct sdata
*) (str
- offsetof (struct sdata
, data
));
5101 if (valid_pointer_p (sdata
)
5102 && valid_pointer_p (sdata
->string
)
5103 && maybe_lisp_pointer (sdata
->string
))
5104 return (valid_lisp_object_p
5105 (make_lisp_ptr (sdata
->string
, Lisp_String
))
5106 && (const char *) sdata
->string
->data
== str
);
5109 #endif /* GC_MARK_STACK */
5113 /***********************************************************************
5114 Pure Storage Management
5115 ***********************************************************************/
5117 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5118 pointer to it. TYPE is the Lisp type for which the memory is
5119 allocated. TYPE < 0 means it's not used for a Lisp object. */
5122 pure_alloc (size_t size
, int type
)
5126 size_t alignment
= GCALIGNMENT
;
5128 size_t alignment
= alignof (EMACS_INT
);
5130 /* Give Lisp_Floats an extra alignment. */
5131 if (type
== Lisp_Float
)
5132 alignment
= alignof (struct Lisp_Float
);
5138 /* Allocate space for a Lisp object from the beginning of the free
5139 space with taking account of alignment. */
5140 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5141 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5145 /* Allocate space for a non-Lisp object from the end of the free
5147 pure_bytes_used_non_lisp
+= size
;
5148 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5150 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5152 if (pure_bytes_used
<= pure_size
)
5155 /* Don't allocate a large amount here,
5156 because it might get mmap'd and then its address
5157 might not be usable. */
5158 purebeg
= xmalloc (10000);
5160 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5161 pure_bytes_used
= 0;
5162 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5167 /* Print a warning if PURESIZE is too small. */
5170 check_pure_size (void)
5172 if (pure_bytes_used_before_overflow
)
5173 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5175 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5179 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5180 the non-Lisp data pool of the pure storage, and return its start
5181 address. Return NULL if not found. */
5184 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5187 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5188 const unsigned char *p
;
5191 if (pure_bytes_used_non_lisp
<= nbytes
)
5194 /* Set up the Boyer-Moore table. */
5196 for (i
= 0; i
< 256; i
++)
5199 p
= (const unsigned char *) data
;
5201 bm_skip
[*p
++] = skip
;
5203 last_char_skip
= bm_skip
['\0'];
5205 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5206 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5208 /* See the comments in the function `boyer_moore' (search.c) for the
5209 use of `infinity'. */
5210 infinity
= pure_bytes_used_non_lisp
+ 1;
5211 bm_skip
['\0'] = infinity
;
5213 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5217 /* Check the last character (== '\0'). */
5220 start
+= bm_skip
[*(p
+ start
)];
5222 while (start
<= start_max
);
5224 if (start
< infinity
)
5225 /* Couldn't find the last character. */
5228 /* No less than `infinity' means we could find the last
5229 character at `p[start - infinity]'. */
5232 /* Check the remaining characters. */
5233 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5235 return non_lisp_beg
+ start
;
5237 start
+= last_char_skip
;
5239 while (start
<= start_max
);
5245 /* Return a string allocated in pure space. DATA is a buffer holding
5246 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5247 means make the result string multibyte.
5249 Must get an error if pure storage is full, since if it cannot hold
5250 a large string it may be able to hold conses that point to that
5251 string; then the string is not protected from gc. */
5254 make_pure_string (const char *data
,
5255 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5258 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5259 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5260 if (s
->data
== NULL
)
5262 s
->data
= pure_alloc (nbytes
+ 1, -1);
5263 memcpy (s
->data
, data
, nbytes
);
5264 s
->data
[nbytes
] = '\0';
5267 s
->size_byte
= multibyte
? nbytes
: -1;
5268 s
->intervals
= NULL
;
5269 XSETSTRING (string
, s
);
5273 /* Return a string allocated in pure space. Do not
5274 allocate the string data, just point to DATA. */
5277 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5280 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5283 s
->data
= (unsigned char *) data
;
5284 s
->intervals
= NULL
;
5285 XSETSTRING (string
, s
);
5289 static Lisp_Object
purecopy (Lisp_Object obj
);
5291 /* Return a cons allocated from pure space. Give it pure copies
5292 of CAR as car and CDR as cdr. */
5295 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5298 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5300 XSETCAR (new, purecopy (car
));
5301 XSETCDR (new, purecopy (cdr
));
5306 /* Value is a float object with value NUM allocated from pure space. */
5309 make_pure_float (double num
)
5312 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5314 XFLOAT_INIT (new, num
);
5319 /* Return a vector with room for LEN Lisp_Objects allocated from
5323 make_pure_vector (ptrdiff_t len
)
5326 size_t size
= header_size
+ len
* word_size
;
5327 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5328 XSETVECTOR (new, p
);
5329 XVECTOR (new)->header
.size
= len
;
5334 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5335 doc
: /* Make a copy of object OBJ in pure storage.
5336 Recursively copies contents of vectors and cons cells.
5337 Does not copy symbols. Copies strings without text properties. */)
5338 (register Lisp_Object obj
)
5340 if (NILP (Vpurify_flag
))
5342 else if (MARKERP (obj
) || OVERLAYP (obj
)
5343 || HASH_TABLE_P (obj
) || SYMBOLP (obj
))
5344 /* Can't purify those. */
5347 return purecopy (obj
);
5351 purecopy (Lisp_Object obj
)
5353 if (PURE_POINTER_P (XPNTR (obj
)) || INTEGERP (obj
) || SUBRP (obj
))
5354 return obj
; /* Already pure. */
5356 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5358 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5364 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5365 else if (FLOATP (obj
))
5366 obj
= make_pure_float (XFLOAT_DATA (obj
));
5367 else if (STRINGP (obj
))
5368 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5370 STRING_MULTIBYTE (obj
));
5371 else if (COMPILEDP (obj
) || VECTORP (obj
))
5373 register struct Lisp_Vector
*vec
;
5374 register ptrdiff_t i
;
5378 if (size
& PSEUDOVECTOR_FLAG
)
5379 size
&= PSEUDOVECTOR_SIZE_MASK
;
5380 vec
= XVECTOR (make_pure_vector (size
));
5381 for (i
= 0; i
< size
; i
++)
5382 vec
->contents
[i
] = purecopy (AREF (obj
, i
));
5383 if (COMPILEDP (obj
))
5385 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5386 XSETCOMPILED (obj
, vec
);
5389 XSETVECTOR (obj
, vec
);
5391 else if (SYMBOLP (obj
))
5393 if (!XSYMBOL (obj
)->pinned
)
5394 { /* We can't purify them, but they appear in many pure objects.
5395 Mark them as `pinned' so we know to mark them at every GC cycle. */
5396 XSYMBOL (obj
)->pinned
= true;
5397 symbol_block_pinned
= symbol_block
;
5403 Lisp_Object args
[2];
5404 args
[0] = build_pure_c_string ("Don't know how to purify: %S");
5406 Fsignal (Qerror
, (Fcons (Fformat (2, args
), Qnil
)));
5409 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5410 Fputhash (obj
, obj
, Vpurify_flag
);
5417 /***********************************************************************
5419 ***********************************************************************/
5421 /* Put an entry in staticvec, pointing at the variable with address
5425 staticpro (Lisp_Object
*varaddress
)
5427 if (staticidx
>= NSTATICS
)
5428 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5429 staticvec
[staticidx
++] = varaddress
;
5433 /***********************************************************************
5435 ***********************************************************************/
5437 /* Temporarily prevent garbage collection. */
5440 inhibit_garbage_collection (void)
5442 ptrdiff_t count
= SPECPDL_INDEX ();
5444 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5448 /* Used to avoid possible overflows when
5449 converting from C to Lisp integers. */
5452 bounded_number (EMACS_INT number
)
5454 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5457 /* Calculate total bytes of live objects. */
5460 total_bytes_of_live_objects (void)
5463 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5464 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5465 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5466 tot
+= total_string_bytes
;
5467 tot
+= total_vector_slots
* word_size
;
5468 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5469 tot
+= total_intervals
* sizeof (struct interval
);
5470 tot
+= total_strings
* sizeof (struct Lisp_String
);
5474 #ifdef HAVE_WINDOW_SYSTEM
5476 /* This code has a few issues on MS-Windows, see Bug#15876 and Bug#16140. */
5478 #if !defined (HAVE_NTGUI)
5480 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5481 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5484 compact_font_cache_entry (Lisp_Object entry
)
5486 Lisp_Object tail
, *prev
= &entry
;
5488 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5491 Lisp_Object obj
= XCAR (tail
);
5493 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5494 if (CONSP (obj
) && FONT_SPEC_P (XCAR (obj
))
5495 && !VECTOR_MARKED_P (XFONT_SPEC (XCAR (obj
)))
5496 && VECTORP (XCDR (obj
)))
5498 ptrdiff_t i
, size
= ASIZE (XCDR (obj
)) & ~ARRAY_MARK_FLAG
;
5500 /* If font-spec is not marked, most likely all font-entities
5501 are not marked too. But we must be sure that nothing is
5502 marked within OBJ before we really drop it. */
5503 for (i
= 0; i
< size
; i
++)
5504 if (VECTOR_MARKED_P (XFONT_ENTITY (AREF (XCDR (obj
), i
))))
5511 *prev
= XCDR (tail
);
5513 prev
= xcdr_addr (tail
);
5518 #endif /* not HAVE_NTGUI */
5520 /* Compact font caches on all terminals and mark
5521 everything which is still here after compaction. */
5524 compact_font_caches (void)
5528 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5530 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5531 #if !defined (HAVE_NTGUI)
5536 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5537 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5539 #endif /* not HAVE_NTGUI */
5540 mark_object (cache
);
5544 #else /* not HAVE_WINDOW_SYSTEM */
5546 #define compact_font_caches() (void)(0)
5548 #endif /* HAVE_WINDOW_SYSTEM */
5550 /* Remove (MARKER . DATA) entries with unmarked MARKER
5551 from buffer undo LIST and return changed list. */
5554 compact_undo_list (Lisp_Object list
)
5556 Lisp_Object tail
, *prev
= &list
;
5558 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5560 if (CONSP (XCAR (tail
))
5561 && MARKERP (XCAR (XCAR (tail
)))
5562 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5563 *prev
= XCDR (tail
);
5565 prev
= xcdr_addr (tail
);
5571 mark_pinned_symbols (void)
5573 struct symbol_block
*sblk
;
5574 int lim
= (symbol_block_pinned
== symbol_block
5575 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5577 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5579 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5580 for (; sym
< end
; ++sym
)
5582 mark_object (make_lisp_ptr (&sym
->s
, Lisp_Symbol
));
5584 lim
= SYMBOL_BLOCK_SIZE
;
5588 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5589 separate function so that we could limit mark_stack in searching
5590 the stack frames below this function, thus avoiding the rare cases
5591 where mark_stack finds values that look like live Lisp objects on
5592 portions of stack that couldn't possibly contain such live objects.
5593 For more details of this, see the discussion at
5594 http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00270.html. */
5596 garbage_collect_1 (void *end
)
5598 struct buffer
*nextb
;
5599 char stack_top_variable
;
5602 ptrdiff_t count
= SPECPDL_INDEX ();
5603 struct timespec start
;
5604 Lisp_Object retval
= Qnil
;
5605 size_t tot_before
= 0;
5610 /* Can't GC if pure storage overflowed because we can't determine
5611 if something is a pure object or not. */
5612 if (pure_bytes_used_before_overflow
)
5615 /* Record this function, so it appears on the profiler's backtraces. */
5616 record_in_backtrace (Qautomatic_gc
, &Qnil
, 0);
5620 /* Don't keep undo information around forever.
5621 Do this early on, so it is no problem if the user quits. */
5622 FOR_EACH_BUFFER (nextb
)
5623 compact_buffer (nextb
);
5625 if (profiler_memory_running
)
5626 tot_before
= total_bytes_of_live_objects ();
5628 start
= current_timespec ();
5630 /* In case user calls debug_print during GC,
5631 don't let that cause a recursive GC. */
5632 consing_since_gc
= 0;
5634 /* Save what's currently displayed in the echo area. */
5635 message_p
= push_message ();
5636 record_unwind_protect_void (pop_message_unwind
);
5638 /* Save a copy of the contents of the stack, for debugging. */
5639 #if MAX_SAVE_STACK > 0
5640 if (NILP (Vpurify_flag
))
5643 ptrdiff_t stack_size
;
5644 if (&stack_top_variable
< stack_bottom
)
5646 stack
= &stack_top_variable
;
5647 stack_size
= stack_bottom
- &stack_top_variable
;
5651 stack
= stack_bottom
;
5652 stack_size
= &stack_top_variable
- stack_bottom
;
5654 if (stack_size
<= MAX_SAVE_STACK
)
5656 if (stack_copy_size
< stack_size
)
5658 stack_copy
= xrealloc (stack_copy
, stack_size
);
5659 stack_copy_size
= stack_size
;
5661 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5664 #endif /* MAX_SAVE_STACK > 0 */
5666 if (garbage_collection_messages
)
5667 message1_nolog ("Garbage collecting...");
5671 shrink_regexp_cache ();
5675 /* Mark all the special slots that serve as the roots of accessibility. */
5677 mark_buffer (&buffer_defaults
);
5678 mark_buffer (&buffer_local_symbols
);
5680 for (i
= 0; i
< staticidx
; i
++)
5681 mark_object (*staticvec
[i
]);
5683 mark_pinned_symbols ();
5692 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5693 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5697 register struct gcpro
*tail
;
5698 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5699 for (i
= 0; i
< tail
->nvars
; i
++)
5700 mark_object (tail
->var
[i
]);
5705 struct handler
*handler
;
5706 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5708 mark_object (handler
->tag_or_ch
);
5709 mark_object (handler
->val
);
5712 #ifdef HAVE_WINDOW_SYSTEM
5713 mark_fringe_data ();
5716 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5720 /* Everything is now marked, except for the data in font caches
5721 and undo lists. They're compacted by removing an items which
5722 aren't reachable otherwise. */
5724 compact_font_caches ();
5726 FOR_EACH_BUFFER (nextb
)
5728 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5729 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5730 /* Now that we have stripped the elements that need not be
5731 in the undo_list any more, we can finally mark the list. */
5732 mark_object (BVAR (nextb
, undo_list
));
5737 /* Clear the mark bits that we set in certain root slots. */
5739 unmark_byte_stack ();
5740 VECTOR_UNMARK (&buffer_defaults
);
5741 VECTOR_UNMARK (&buffer_local_symbols
);
5743 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5753 consing_since_gc
= 0;
5754 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5755 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5757 gc_relative_threshold
= 0;
5758 if (FLOATP (Vgc_cons_percentage
))
5759 { /* Set gc_cons_combined_threshold. */
5760 double tot
= total_bytes_of_live_objects ();
5762 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5765 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5766 gc_relative_threshold
= tot
;
5768 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5772 if (garbage_collection_messages
)
5774 if (message_p
|| minibuf_level
> 0)
5777 message1_nolog ("Garbage collecting...done");
5780 unbind_to (count
, Qnil
);
5782 Lisp_Object total
[11];
5783 int total_size
= 10;
5785 total
[0] = list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5786 bounded_number (total_conses
),
5787 bounded_number (total_free_conses
));
5789 total
[1] = list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5790 bounded_number (total_symbols
),
5791 bounded_number (total_free_symbols
));
5793 total
[2] = list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5794 bounded_number (total_markers
),
5795 bounded_number (total_free_markers
));
5797 total
[3] = list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5798 bounded_number (total_strings
),
5799 bounded_number (total_free_strings
));
5801 total
[4] = list3 (Qstring_bytes
, make_number (1),
5802 bounded_number (total_string_bytes
));
5804 total
[5] = list3 (Qvectors
,
5805 make_number (header_size
+ sizeof (Lisp_Object
)),
5806 bounded_number (total_vectors
));
5808 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5809 bounded_number (total_vector_slots
),
5810 bounded_number (total_free_vector_slots
));
5812 total
[7] = list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5813 bounded_number (total_floats
),
5814 bounded_number (total_free_floats
));
5816 total
[8] = list4 (Qintervals
, make_number (sizeof (struct interval
)),
5817 bounded_number (total_intervals
),
5818 bounded_number (total_free_intervals
));
5820 total
[9] = list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5821 bounded_number (total_buffers
));
5823 #ifdef DOUG_LEA_MALLOC
5825 total
[10] = list4 (Qheap
, make_number (1024),
5826 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5827 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10));
5829 retval
= Flist (total_size
, total
);
5832 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5834 /* Compute average percentage of zombies. */
5836 = (total_conses
+ total_symbols
+ total_markers
+ total_strings
5837 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5839 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5840 max_live
= max (nlive
, max_live
);
5841 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5842 max_zombies
= max (nzombies
, max_zombies
);
5847 if (!NILP (Vpost_gc_hook
))
5849 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5850 safe_run_hooks (Qpost_gc_hook
);
5851 unbind_to (gc_count
, Qnil
);
5854 /* Accumulate statistics. */
5855 if (FLOATP (Vgc_elapsed
))
5857 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5858 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5859 + timespectod (since_start
));
5864 /* Collect profiling data. */
5865 if (profiler_memory_running
)
5868 size_t tot_after
= total_bytes_of_live_objects ();
5869 if (tot_before
> tot_after
)
5870 swept
= tot_before
- tot_after
;
5871 malloc_probe (swept
);
5877 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5878 doc
: /* Reclaim storage for Lisp objects no longer needed.
5879 Garbage collection happens automatically if you cons more than
5880 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5881 `garbage-collect' normally returns a list with info on amount of space in use,
5882 where each entry has the form (NAME SIZE USED FREE), where:
5883 - NAME is a symbol describing the kind of objects this entry represents,
5884 - SIZE is the number of bytes used by each one,
5885 - USED is the number of those objects that were found live in the heap,
5886 - FREE is the number of those objects that are not live but that Emacs
5887 keeps around for future allocations (maybe because it does not know how
5888 to return them to the OS).
5889 However, if there was overflow in pure space, `garbage-collect'
5890 returns nil, because real GC can't be done.
5891 See Info node `(elisp)Garbage Collection'. */)
5894 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5895 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS \
5896 || GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES)
5899 #ifdef HAVE___BUILTIN_UNWIND_INIT
5900 /* Force callee-saved registers and register windows onto the stack.
5901 This is the preferred method if available, obviating the need for
5902 machine dependent methods. */
5903 __builtin_unwind_init ();
5905 #else /* not HAVE___BUILTIN_UNWIND_INIT */
5906 #ifndef GC_SAVE_REGISTERS_ON_STACK
5907 /* jmp_buf may not be aligned enough on darwin-ppc64 */
5908 union aligned_jmpbuf
{
5912 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
5914 /* This trick flushes the register windows so that all the state of
5915 the process is contained in the stack. */
5916 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
5917 needed on ia64 too. See mach_dep.c, where it also says inline
5918 assembler doesn't work with relevant proprietary compilers. */
5920 #if defined (__sparc64__) && defined (__FreeBSD__)
5921 /* FreeBSD does not have a ta 3 handler. */
5928 /* Save registers that we need to see on the stack. We need to see
5929 registers used to hold register variables and registers used to
5931 #ifdef GC_SAVE_REGISTERS_ON_STACK
5932 GC_SAVE_REGISTERS_ON_STACK (end
);
5933 #else /* not GC_SAVE_REGISTERS_ON_STACK */
5935 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
5936 setjmp will definitely work, test it
5937 and print a message with the result
5939 if (!setjmp_tested_p
)
5941 setjmp_tested_p
= 1;
5944 #endif /* GC_SETJMP_WORKS */
5947 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
5948 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
5949 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
5950 return garbage_collect_1 (end
);
5951 #elif (GC_MARK_STACK == GC_USE_GCPROS_AS_BEFORE)
5952 /* Old GCPROs-based method without stack marking. */
5953 return garbage_collect_1 (NULL
);
5956 #endif /* GC_MARK_STACK */
5959 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5960 only interesting objects referenced from glyphs are strings. */
5963 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5965 struct glyph_row
*row
= matrix
->rows
;
5966 struct glyph_row
*end
= row
+ matrix
->nrows
;
5968 for (; row
< end
; ++row
)
5972 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5974 struct glyph
*glyph
= row
->glyphs
[area
];
5975 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5977 for (; glyph
< end_glyph
; ++glyph
)
5978 if (STRINGP (glyph
->object
)
5979 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5980 mark_object (glyph
->object
);
5985 /* Mark reference to a Lisp_Object.
5986 If the object referred to has not been seen yet, recursively mark
5987 all the references contained in it. */
5989 #define LAST_MARKED_SIZE 500
5990 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5991 static int last_marked_index
;
5993 /* For debugging--call abort when we cdr down this many
5994 links of a list, in mark_object. In debugging,
5995 the call to abort will hit a breakpoint.
5996 Normally this is zero and the check never goes off. */
5997 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
6000 mark_vectorlike (struct Lisp_Vector
*ptr
)
6002 ptrdiff_t size
= ptr
->header
.size
;
6005 eassert (!VECTOR_MARKED_P (ptr
));
6006 VECTOR_MARK (ptr
); /* Else mark it. */
6007 if (size
& PSEUDOVECTOR_FLAG
)
6008 size
&= PSEUDOVECTOR_SIZE_MASK
;
6010 /* Note that this size is not the memory-footprint size, but only
6011 the number of Lisp_Object fields that we should trace.
6012 The distinction is used e.g. by Lisp_Process which places extra
6013 non-Lisp_Object fields at the end of the structure... */
6014 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
6015 mark_object (ptr
->contents
[i
]);
6018 /* Like mark_vectorlike but optimized for char-tables (and
6019 sub-char-tables) assuming that the contents are mostly integers or
6023 mark_char_table (struct Lisp_Vector
*ptr
, enum pvec_type pvectype
)
6025 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
6026 /* Consult the Lisp_Sub_Char_Table layout before changing this. */
6027 int i
, idx
= (pvectype
== PVEC_SUB_CHAR_TABLE
? SUB_CHAR_TABLE_OFFSET
: 0);
6029 eassert (!VECTOR_MARKED_P (ptr
));
6031 for (i
= idx
; i
< size
; i
++)
6033 Lisp_Object val
= ptr
->contents
[i
];
6035 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
6037 if (SUB_CHAR_TABLE_P (val
))
6039 if (! VECTOR_MARKED_P (XVECTOR (val
)))
6040 mark_char_table (XVECTOR (val
), PVEC_SUB_CHAR_TABLE
);
6047 NO_INLINE
/* To reduce stack depth in mark_object. */
6049 mark_compiled (struct Lisp_Vector
*ptr
)
6051 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
6054 for (i
= 0; i
< size
; i
++)
6055 if (i
!= COMPILED_CONSTANTS
)
6056 mark_object (ptr
->contents
[i
]);
6057 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
6060 /* Mark the chain of overlays starting at PTR. */
6063 mark_overlay (struct Lisp_Overlay
*ptr
)
6065 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
6068 mark_object (ptr
->start
);
6069 mark_object (ptr
->end
);
6070 mark_object (ptr
->plist
);
6074 /* Mark Lisp_Objects and special pointers in BUFFER. */
6077 mark_buffer (struct buffer
*buffer
)
6079 /* This is handled much like other pseudovectors... */
6080 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
6082 /* ...but there are some buffer-specific things. */
6084 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
6086 /* For now, we just don't mark the undo_list. It's done later in
6087 a special way just before the sweep phase, and after stripping
6088 some of its elements that are not needed any more. */
6090 mark_overlay (buffer
->overlays_before
);
6091 mark_overlay (buffer
->overlays_after
);
6093 /* If this is an indirect buffer, mark its base buffer. */
6094 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
6095 mark_buffer (buffer
->base_buffer
);
6098 /* Mark Lisp faces in the face cache C. */
6100 NO_INLINE
/* To reduce stack depth in mark_object. */
6102 mark_face_cache (struct face_cache
*c
)
6107 for (i
= 0; i
< c
->used
; ++i
)
6109 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
6113 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
6114 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
6116 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
6117 mark_object (face
->lface
[j
]);
6123 NO_INLINE
/* To reduce stack depth in mark_object. */
6125 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
6127 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6128 Lisp_Object where
= blv
->where
;
6129 /* If the value is set up for a killed buffer or deleted
6130 frame, restore its global binding. If the value is
6131 forwarded to a C variable, either it's not a Lisp_Object
6132 var, or it's staticpro'd already. */
6133 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
6134 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
6135 swap_in_global_binding (ptr
);
6136 mark_object (blv
->where
);
6137 mark_object (blv
->valcell
);
6138 mark_object (blv
->defcell
);
6141 NO_INLINE
/* To reduce stack depth in mark_object. */
6143 mark_save_value (struct Lisp_Save_Value
*ptr
)
6145 /* If `save_type' is zero, `data[0].pointer' is the address
6146 of a memory area containing `data[1].integer' potential
6148 if (GC_MARK_STACK
&& ptr
->save_type
== SAVE_TYPE_MEMORY
)
6150 Lisp_Object
*p
= ptr
->data
[0].pointer
;
6152 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
6153 mark_maybe_object (*p
);
6157 /* Find Lisp_Objects in `data[N]' slots and mark them. */
6159 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
6160 if (save_type (ptr
, i
) == SAVE_OBJECT
)
6161 mark_object (ptr
->data
[i
].object
);
6165 /* Remove killed buffers or items whose car is a killed buffer from
6166 LIST, and mark other items. Return changed LIST, which is marked. */
6169 mark_discard_killed_buffers (Lisp_Object list
)
6171 Lisp_Object tail
, *prev
= &list
;
6173 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
6176 Lisp_Object tem
= XCAR (tail
);
6179 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
6180 *prev
= XCDR (tail
);
6183 CONS_MARK (XCONS (tail
));
6184 mark_object (XCAR (tail
));
6185 prev
= xcdr_addr (tail
);
6192 /* Determine type of generic Lisp_Object and mark it accordingly.
6194 This function implements a straightforward depth-first marking
6195 algorithm and so the recursion depth may be very high (a few
6196 tens of thousands is not uncommon). To minimize stack usage,
6197 a few cold paths are moved out to NO_INLINE functions above.
6198 In general, inlining them doesn't help you to gain more speed. */
6201 mark_object (Lisp_Object arg
)
6203 register Lisp_Object obj
= arg
;
6204 #ifdef GC_CHECK_MARKED_OBJECTS
6208 ptrdiff_t cdr_count
= 0;
6212 if (PURE_POINTER_P (XPNTR (obj
)))
6215 last_marked
[last_marked_index
++] = obj
;
6216 if (last_marked_index
== LAST_MARKED_SIZE
)
6217 last_marked_index
= 0;
6219 /* Perform some sanity checks on the objects marked here. Abort if
6220 we encounter an object we know is bogus. This increases GC time
6221 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
6222 #ifdef GC_CHECK_MARKED_OBJECTS
6224 po
= (void *) XPNTR (obj
);
6226 /* Check that the object pointed to by PO is known to be a Lisp
6227 structure allocated from the heap. */
6228 #define CHECK_ALLOCATED() \
6230 m = mem_find (po); \
6235 /* Check that the object pointed to by PO is live, using predicate
6237 #define CHECK_LIVE(LIVEP) \
6239 if (!LIVEP (m, po)) \
6243 /* Check both of the above conditions. */
6244 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6246 CHECK_ALLOCATED (); \
6247 CHECK_LIVE (LIVEP); \
6250 #else /* not GC_CHECK_MARKED_OBJECTS */
6252 #define CHECK_LIVE(LIVEP) (void) 0
6253 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
6255 #endif /* not GC_CHECK_MARKED_OBJECTS */
6257 switch (XTYPE (obj
))
6261 register struct Lisp_String
*ptr
= XSTRING (obj
);
6262 if (STRING_MARKED_P (ptr
))
6264 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6266 MARK_INTERVAL_TREE (ptr
->intervals
);
6267 #ifdef GC_CHECK_STRING_BYTES
6268 /* Check that the string size recorded in the string is the
6269 same as the one recorded in the sdata structure. */
6271 #endif /* GC_CHECK_STRING_BYTES */
6275 case Lisp_Vectorlike
:
6277 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6278 register ptrdiff_t pvectype
;
6280 if (VECTOR_MARKED_P (ptr
))
6283 #ifdef GC_CHECK_MARKED_OBJECTS
6285 if (m
== MEM_NIL
&& !SUBRP (obj
))
6287 #endif /* GC_CHECK_MARKED_OBJECTS */
6289 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6290 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6291 >> PSEUDOVECTOR_AREA_BITS
);
6293 pvectype
= PVEC_NORMAL_VECTOR
;
6295 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6296 CHECK_LIVE (live_vector_p
);
6301 #ifdef GC_CHECK_MARKED_OBJECTS
6310 #endif /* GC_CHECK_MARKED_OBJECTS */
6311 mark_buffer ((struct buffer
*) ptr
);
6315 /* Although we could treat this just like a vector, mark_compiled
6316 returns the COMPILED_CONSTANTS element, which is marked at the
6317 next iteration of goto-loop here. This is done to avoid a few
6318 recursive calls to mark_object. */
6319 obj
= mark_compiled (ptr
);
6326 struct frame
*f
= (struct frame
*) ptr
;
6328 mark_vectorlike (ptr
);
6329 mark_face_cache (f
->face_cache
);
6330 #ifdef HAVE_WINDOW_SYSTEM
6331 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6333 struct font
*font
= FRAME_FONT (f
);
6335 if (font
&& !VECTOR_MARKED_P (font
))
6336 mark_vectorlike ((struct Lisp_Vector
*) font
);
6344 struct window
*w
= (struct window
*) ptr
;
6346 mark_vectorlike (ptr
);
6348 /* Mark glyph matrices, if any. Marking window
6349 matrices is sufficient because frame matrices
6350 use the same glyph memory. */
6351 if (w
->current_matrix
)
6353 mark_glyph_matrix (w
->current_matrix
);
6354 mark_glyph_matrix (w
->desired_matrix
);
6357 /* Filter out killed buffers from both buffer lists
6358 in attempt to help GC to reclaim killed buffers faster.
6359 We can do it elsewhere for live windows, but this is the
6360 best place to do it for dead windows. */
6362 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6364 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6368 case PVEC_HASH_TABLE
:
6370 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6372 mark_vectorlike (ptr
);
6373 mark_object (h
->test
.name
);
6374 mark_object (h
->test
.user_hash_function
);
6375 mark_object (h
->test
.user_cmp_function
);
6376 /* If hash table is not weak, mark all keys and values.
6377 For weak tables, mark only the vector. */
6379 mark_object (h
->key_and_value
);
6381 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6385 case PVEC_CHAR_TABLE
:
6386 case PVEC_SUB_CHAR_TABLE
:
6387 mark_char_table (ptr
, (enum pvec_type
) pvectype
);
6390 case PVEC_BOOL_VECTOR
:
6391 /* No Lisp_Objects to mark in a bool vector. */
6402 mark_vectorlike (ptr
);
6409 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6413 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6415 /* Attempt to catch bogus objects. */
6416 eassert (valid_lisp_object_p (ptr
->function
) >= 1);
6417 mark_object (ptr
->function
);
6418 mark_object (ptr
->plist
);
6419 switch (ptr
->redirect
)
6421 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6422 case SYMBOL_VARALIAS
:
6425 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6429 case SYMBOL_LOCALIZED
:
6430 mark_localized_symbol (ptr
);
6432 case SYMBOL_FORWARDED
:
6433 /* If the value is forwarded to a buffer or keyboard field,
6434 these are marked when we see the corresponding object.
6435 And if it's forwarded to a C variable, either it's not
6436 a Lisp_Object var, or it's staticpro'd already. */
6438 default: emacs_abort ();
6440 if (!PURE_POINTER_P (XSTRING (ptr
->name
)))
6441 MARK_STRING (XSTRING (ptr
->name
));
6442 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6443 /* Inner loop to mark next symbol in this bucket, if any. */
6451 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6453 if (XMISCANY (obj
)->gcmarkbit
)
6456 switch (XMISCTYPE (obj
))
6458 case Lisp_Misc_Marker
:
6459 /* DO NOT mark thru the marker's chain.
6460 The buffer's markers chain does not preserve markers from gc;
6461 instead, markers are removed from the chain when freed by gc. */
6462 XMISCANY (obj
)->gcmarkbit
= 1;
6465 case Lisp_Misc_Save_Value
:
6466 XMISCANY (obj
)->gcmarkbit
= 1;
6467 mark_save_value (XSAVE_VALUE (obj
));
6470 case Lisp_Misc_Overlay
:
6471 mark_overlay (XOVERLAY (obj
));
6481 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6482 if (CONS_MARKED_P (ptr
))
6484 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6486 /* If the cdr is nil, avoid recursion for the car. */
6487 if (EQ (ptr
->u
.cdr
, Qnil
))
6493 mark_object (ptr
->car
);
6496 if (cdr_count
== mark_object_loop_halt
)
6502 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6503 FLOAT_MARK (XFLOAT (obj
));
6514 #undef CHECK_ALLOCATED
6515 #undef CHECK_ALLOCATED_AND_LIVE
6517 /* Mark the Lisp pointers in the terminal objects.
6518 Called by Fgarbage_collect. */
6521 mark_terminals (void)
6524 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6526 eassert (t
->name
!= NULL
);
6527 #ifdef HAVE_WINDOW_SYSTEM
6528 /* If a terminal object is reachable from a stacpro'ed object,
6529 it might have been marked already. Make sure the image cache
6531 mark_image_cache (t
->image_cache
);
6532 #endif /* HAVE_WINDOW_SYSTEM */
6533 if (!VECTOR_MARKED_P (t
))
6534 mark_vectorlike ((struct Lisp_Vector
*)t
);
6540 /* Value is non-zero if OBJ will survive the current GC because it's
6541 either marked or does not need to be marked to survive. */
6544 survives_gc_p (Lisp_Object obj
)
6548 switch (XTYPE (obj
))
6555 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6559 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6563 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6566 case Lisp_Vectorlike
:
6567 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6571 survives_p
= CONS_MARKED_P (XCONS (obj
));
6575 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6582 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6588 NO_INLINE
/* For better stack traces */
6592 struct cons_block
*cblk
;
6593 struct cons_block
**cprev
= &cons_block
;
6594 int lim
= cons_block_index
;
6595 EMACS_INT num_free
= 0, num_used
= 0;
6599 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6603 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6605 /* Scan the mark bits an int at a time. */
6606 for (i
= 0; i
< ilim
; i
++)
6608 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6610 /* Fast path - all cons cells for this int are marked. */
6611 cblk
->gcmarkbits
[i
] = 0;
6612 num_used
+= BITS_PER_BITS_WORD
;
6616 /* Some cons cells for this int are not marked.
6617 Find which ones, and free them. */
6618 int start
, pos
, stop
;
6620 start
= i
* BITS_PER_BITS_WORD
;
6622 if (stop
> BITS_PER_BITS_WORD
)
6623 stop
= BITS_PER_BITS_WORD
;
6626 for (pos
= start
; pos
< stop
; pos
++)
6628 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6631 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6632 cons_free_list
= &cblk
->conses
[pos
];
6634 cons_free_list
->car
= Vdead
;
6640 CONS_UNMARK (&cblk
->conses
[pos
]);
6646 lim
= CONS_BLOCK_SIZE
;
6647 /* If this block contains only free conses and we have already
6648 seen more than two blocks worth of free conses then deallocate
6650 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6652 *cprev
= cblk
->next
;
6653 /* Unhook from the free list. */
6654 cons_free_list
= cblk
->conses
[0].u
.chain
;
6655 lisp_align_free (cblk
);
6659 num_free
+= this_free
;
6660 cprev
= &cblk
->next
;
6663 total_conses
= num_used
;
6664 total_free_conses
= num_free
;
6667 NO_INLINE
/* For better stack traces */
6671 register struct float_block
*fblk
;
6672 struct float_block
**fprev
= &float_block
;
6673 register int lim
= float_block_index
;
6674 EMACS_INT num_free
= 0, num_used
= 0;
6676 float_free_list
= 0;
6678 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6682 for (i
= 0; i
< lim
; i
++)
6683 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6686 fblk
->floats
[i
].u
.chain
= float_free_list
;
6687 float_free_list
= &fblk
->floats
[i
];
6692 FLOAT_UNMARK (&fblk
->floats
[i
]);
6694 lim
= FLOAT_BLOCK_SIZE
;
6695 /* If this block contains only free floats and we have already
6696 seen more than two blocks worth of free floats then deallocate
6698 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6700 *fprev
= fblk
->next
;
6701 /* Unhook from the free list. */
6702 float_free_list
= fblk
->floats
[0].u
.chain
;
6703 lisp_align_free (fblk
);
6707 num_free
+= this_free
;
6708 fprev
= &fblk
->next
;
6711 total_floats
= num_used
;
6712 total_free_floats
= num_free
;
6715 NO_INLINE
/* For better stack traces */
6717 sweep_intervals (void)
6719 register struct interval_block
*iblk
;
6720 struct interval_block
**iprev
= &interval_block
;
6721 register int lim
= interval_block_index
;
6722 EMACS_INT num_free
= 0, num_used
= 0;
6724 interval_free_list
= 0;
6726 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6731 for (i
= 0; i
< lim
; i
++)
6733 if (!iblk
->intervals
[i
].gcmarkbit
)
6735 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6736 interval_free_list
= &iblk
->intervals
[i
];
6742 iblk
->intervals
[i
].gcmarkbit
= 0;
6745 lim
= INTERVAL_BLOCK_SIZE
;
6746 /* If this block contains only free intervals and we have already
6747 seen more than two blocks worth of free intervals then
6748 deallocate this block. */
6749 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6751 *iprev
= iblk
->next
;
6752 /* Unhook from the free list. */
6753 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6758 num_free
+= this_free
;
6759 iprev
= &iblk
->next
;
6762 total_intervals
= num_used
;
6763 total_free_intervals
= num_free
;
6766 NO_INLINE
/* For better stack traces */
6768 sweep_symbols (void)
6770 register struct symbol_block
*sblk
;
6771 struct symbol_block
**sprev
= &symbol_block
;
6772 register int lim
= symbol_block_index
;
6773 EMACS_INT num_free
= 0, num_used
= 0;
6775 symbol_free_list
= NULL
;
6777 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6780 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6781 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6783 for (; sym
< end
; ++sym
)
6785 if (!sym
->s
.gcmarkbit
)
6787 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6788 xfree (SYMBOL_BLV (&sym
->s
));
6789 sym
->s
.next
= symbol_free_list
;
6790 symbol_free_list
= &sym
->s
;
6792 symbol_free_list
->function
= Vdead
;
6799 sym
->s
.gcmarkbit
= 0;
6800 /* Attempt to catch bogus objects. */
6801 eassert (valid_lisp_object_p (sym
->s
.function
) >= 1);
6805 lim
= SYMBOL_BLOCK_SIZE
;
6806 /* If this block contains only free symbols and we have already
6807 seen more than two blocks worth of free symbols then deallocate
6809 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6811 *sprev
= sblk
->next
;
6812 /* Unhook from the free list. */
6813 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6818 num_free
+= this_free
;
6819 sprev
= &sblk
->next
;
6822 total_symbols
= num_used
;
6823 total_free_symbols
= num_free
;
6826 NO_INLINE
/* For better stack traces */
6830 register struct marker_block
*mblk
;
6831 struct marker_block
**mprev
= &marker_block
;
6832 register int lim
= marker_block_index
;
6833 EMACS_INT num_free
= 0, num_used
= 0;
6835 /* Put all unmarked misc's on free list. For a marker, first
6836 unchain it from the buffer it points into. */
6838 marker_free_list
= 0;
6840 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6845 for (i
= 0; i
< lim
; i
++)
6847 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6849 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6850 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6851 /* Set the type of the freed object to Lisp_Misc_Free.
6852 We could leave the type alone, since nobody checks it,
6853 but this might catch bugs faster. */
6854 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6855 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6856 marker_free_list
= &mblk
->markers
[i
].m
;
6862 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6865 lim
= MARKER_BLOCK_SIZE
;
6866 /* If this block contains only free markers and we have already
6867 seen more than two blocks worth of free markers then deallocate
6869 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6871 *mprev
= mblk
->next
;
6872 /* Unhook from the free list. */
6873 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6878 num_free
+= this_free
;
6879 mprev
= &mblk
->next
;
6883 total_markers
= num_used
;
6884 total_free_markers
= num_free
;
6887 NO_INLINE
/* For better stack traces */
6889 sweep_buffers (void)
6891 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6894 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6895 if (!VECTOR_MARKED_P (buffer
))
6897 *bprev
= buffer
->next
;
6902 VECTOR_UNMARK (buffer
);
6903 /* Do not use buffer_(set|get)_intervals here. */
6904 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6906 bprev
= &buffer
->next
;
6910 /* Sweep: find all structures not marked, and free them. */
6914 /* Remove or mark entries in weak hash tables.
6915 This must be done before any object is unmarked. */
6916 sweep_weak_hash_tables ();
6919 check_string_bytes (!noninteractive
);
6927 check_string_bytes (!noninteractive
);
6930 DEFUN ("memory-info", Fmemory_info
, Smemory_info
, 0, 0, 0,
6931 doc
: /* Return a list of (TOTAL-RAM FREE-RAM TOTAL-SWAP FREE-SWAP).
6932 All values are in Kbytes. If there is no swap space,
6933 last two values are zero. If the system is not supported
6934 or memory information can't be obtained, return nil. */)
6937 #if defined HAVE_LINUX_SYSINFO
6943 #ifdef LINUX_SYSINFO_UNIT
6944 units
= si
.mem_unit
;
6948 return list4i ((uintmax_t) si
.totalram
* units
/ 1024,
6949 (uintmax_t) si
.freeram
* units
/ 1024,
6950 (uintmax_t) si
.totalswap
* units
/ 1024,
6951 (uintmax_t) si
.freeswap
* units
/ 1024);
6952 #elif defined WINDOWSNT
6953 unsigned long long totalram
, freeram
, totalswap
, freeswap
;
6955 if (w32_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6956 return list4i ((uintmax_t) totalram
/ 1024,
6957 (uintmax_t) freeram
/ 1024,
6958 (uintmax_t) totalswap
/ 1024,
6959 (uintmax_t) freeswap
/ 1024);
6963 unsigned long totalram
, freeram
, totalswap
, freeswap
;
6965 if (dos_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6966 return list4i ((uintmax_t) totalram
/ 1024,
6967 (uintmax_t) freeram
/ 1024,
6968 (uintmax_t) totalswap
/ 1024,
6969 (uintmax_t) freeswap
/ 1024);
6972 #else /* not HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6973 /* FIXME: add more systems. */
6975 #endif /* HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6978 /* Debugging aids. */
6980 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6981 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6982 This may be helpful in debugging Emacs's memory usage.
6983 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6989 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
6992 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6998 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6999 doc
: /* Return a list of counters that measure how much consing there has been.
7000 Each of these counters increments for a certain kind of object.
7001 The counters wrap around from the largest positive integer to zero.
7002 Garbage collection does not decrease them.
7003 The elements of the value are as follows:
7004 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
7005 All are in units of 1 = one object consed
7006 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
7008 MISCS include overlays, markers, and some internal types.
7009 Frames, windows, buffers, and subprocesses count as vectors
7010 (but the contents of a buffer's text do not count here). */)
7013 return listn (CONSTYPE_HEAP
, 8,
7014 bounded_number (cons_cells_consed
),
7015 bounded_number (floats_consed
),
7016 bounded_number (vector_cells_consed
),
7017 bounded_number (symbols_consed
),
7018 bounded_number (string_chars_consed
),
7019 bounded_number (misc_objects_consed
),
7020 bounded_number (intervals_consed
),
7021 bounded_number (strings_consed
));
7024 /* Find at most FIND_MAX symbols which have OBJ as their value or
7025 function. This is used in gdbinit's `xwhichsymbols' command. */
7028 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
7030 struct symbol_block
*sblk
;
7031 ptrdiff_t gc_count
= inhibit_garbage_collection ();
7032 Lisp_Object found
= Qnil
;
7036 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
7038 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
7041 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
7043 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
7047 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
7050 XSETSYMBOL (tem
, sym
);
7051 val
= find_symbol_value (tem
);
7053 || EQ (sym
->function
, obj
)
7054 || (!NILP (sym
->function
)
7055 && COMPILEDP (sym
->function
)
7056 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
7059 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
7061 found
= Fcons (tem
, found
);
7062 if (--find_max
== 0)
7070 unbind_to (gc_count
, Qnil
);
7074 #ifdef SUSPICIOUS_OBJECT_CHECKING
7077 find_suspicious_object_in_range (void *begin
, void *end
)
7079 char *begin_a
= begin
;
7083 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7085 char *suspicious_object
= suspicious_objects
[i
];
7086 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
7087 return suspicious_object
;
7094 note_suspicious_free (void* ptr
)
7096 struct suspicious_free_record
* rec
;
7098 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
7099 if (suspicious_free_history_index
==
7100 ARRAYELTS (suspicious_free_history
))
7102 suspicious_free_history_index
= 0;
7105 memset (rec
, 0, sizeof (*rec
));
7106 rec
->suspicious_object
= ptr
;
7107 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
7111 detect_suspicious_free (void* ptr
)
7115 eassert (ptr
!= NULL
);
7117 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7118 if (suspicious_objects
[i
] == ptr
)
7120 note_suspicious_free (ptr
);
7121 suspicious_objects
[i
] = NULL
;
7125 #endif /* SUSPICIOUS_OBJECT_CHECKING */
7127 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
7128 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
7129 If Emacs is compiled with suspicious object checking, capture
7130 a stack trace when OBJ is freed in order to help track down
7131 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
7134 #ifdef SUSPICIOUS_OBJECT_CHECKING
7135 /* Right now, we care only about vectors. */
7136 if (VECTORLIKEP (obj
))
7138 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
7139 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
7140 suspicious_object_index
= 0;
7146 #ifdef ENABLE_CHECKING
7148 bool suppress_checking
;
7151 die (const char *msg
, const char *file
, int line
)
7153 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
7155 terminate_due_to_signal (SIGABRT
, INT_MAX
);
7158 #endif /* ENABLE_CHECKING */
7160 #if defined (ENABLE_CHECKING) && defined (USE_STACK_LISP_OBJECTS)
7162 /* Stress alloca with inconveniently sized requests and check
7163 whether all allocated areas may be used for Lisp_Object. */
7165 NO_INLINE
static void
7166 verify_alloca (void)
7169 enum { ALLOCA_CHECK_MAX
= 256 };
7170 /* Start from size of the smallest Lisp object. */
7171 for (i
= sizeof (struct Lisp_Cons
); i
<= ALLOCA_CHECK_MAX
; i
++)
7173 void *ptr
= alloca (i
);
7174 make_lisp_ptr (ptr
, Lisp_Cons
);
7178 #else /* not (ENABLE_CHECKING && USE_STACK_LISP_OBJECTS) */
7180 #define verify_alloca() ((void) 0)
7182 #endif /* ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7184 /* Initialization. */
7187 init_alloc_once (void)
7189 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
7191 pure_size
= PURESIZE
;
7195 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
7197 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
7200 #ifdef DOUG_LEA_MALLOC
7201 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
7202 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
7203 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
7208 refill_memory_reserve ();
7209 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
7216 byte_stack_list
= 0;
7218 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
7219 setjmp_tested_p
= longjmps_done
= 0;
7222 Vgc_elapsed
= make_float (0.0);
7226 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
7231 syms_of_alloc (void)
7233 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
7234 doc
: /* Number of bytes of consing between garbage collections.
7235 Garbage collection can happen automatically once this many bytes have been
7236 allocated since the last garbage collection. All data types count.
7238 Garbage collection happens automatically only when `eval' is called.
7240 By binding this temporarily to a large number, you can effectively
7241 prevent garbage collection during a part of the program.
7242 See also `gc-cons-percentage'. */);
7244 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
7245 doc
: /* Portion of the heap used for allocation.
7246 Garbage collection can happen automatically once this portion of the heap
7247 has been allocated since the last garbage collection.
7248 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
7249 Vgc_cons_percentage
= make_float (0.1);
7251 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
7252 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
7254 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
7255 doc
: /* Number of cons cells that have been consed so far. */);
7257 DEFVAR_INT ("floats-consed", floats_consed
,
7258 doc
: /* Number of floats that have been consed so far. */);
7260 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7261 doc
: /* Number of vector cells that have been consed so far. */);
7263 DEFVAR_INT ("symbols-consed", symbols_consed
,
7264 doc
: /* Number of symbols that have been consed so far. */);
7266 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7267 doc
: /* Number of string characters that have been consed so far. */);
7269 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7270 doc
: /* Number of miscellaneous objects that have been consed so far.
7271 These include markers and overlays, plus certain objects not visible
7274 DEFVAR_INT ("intervals-consed", intervals_consed
,
7275 doc
: /* Number of intervals that have been consed so far. */);
7277 DEFVAR_INT ("strings-consed", strings_consed
,
7278 doc
: /* Number of strings that have been consed so far. */);
7280 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7281 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7282 This means that certain objects should be allocated in shared (pure) space.
7283 It can also be set to a hash-table, in which case this table is used to
7284 do hash-consing of the objects allocated to pure space. */);
7286 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7287 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7288 garbage_collection_messages
= 0;
7290 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7291 doc
: /* Hook run after garbage collection has finished. */);
7292 Vpost_gc_hook
= Qnil
;
7293 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7295 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7296 doc
: /* Precomputed `signal' argument for memory-full error. */);
7297 /* We build this in advance because if we wait until we need it, we might
7298 not be able to allocate the memory to hold it. */
7300 = listn (CONSTYPE_PURE
, 2, Qerror
,
7301 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7303 DEFVAR_LISP ("memory-full", Vmemory_full
,
7304 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7305 Vmemory_full
= Qnil
;
7307 DEFSYM (Qconses
, "conses");
7308 DEFSYM (Qsymbols
, "symbols");
7309 DEFSYM (Qmiscs
, "miscs");
7310 DEFSYM (Qstrings
, "strings");
7311 DEFSYM (Qvectors
, "vectors");
7312 DEFSYM (Qfloats
, "floats");
7313 DEFSYM (Qintervals
, "intervals");
7314 DEFSYM (Qbuffers
, "buffers");
7315 DEFSYM (Qstring_bytes
, "string-bytes");
7316 DEFSYM (Qvector_slots
, "vector-slots");
7317 DEFSYM (Qheap
, "heap");
7318 DEFSYM (Qautomatic_gc
, "Automatic GC");
7320 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7321 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7323 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7324 doc
: /* Accumulated time elapsed in garbage collections.
7325 The time is in seconds as a floating point value. */);
7326 DEFVAR_INT ("gcs-done", gcs_done
,
7327 doc
: /* Accumulated number of garbage collections done. */);
7332 defsubr (&Sbool_vector
);
7333 defsubr (&Smake_byte_code
);
7334 defsubr (&Smake_list
);
7335 defsubr (&Smake_vector
);
7336 defsubr (&Smake_string
);
7337 defsubr (&Smake_bool_vector
);
7338 defsubr (&Smake_symbol
);
7339 defsubr (&Smake_marker
);
7340 defsubr (&Spurecopy
);
7341 defsubr (&Sgarbage_collect
);
7342 defsubr (&Smemory_limit
);
7343 defsubr (&Smemory_info
);
7344 defsubr (&Smemory_use_counts
);
7345 defsubr (&Ssuspicious_object
);
7347 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
7348 defsubr (&Sgc_status
);
7352 /* When compiled with GCC, GDB might say "No enum type named
7353 pvec_type" if we don't have at least one symbol with that type, and
7354 then xbacktrace could fail. Similarly for the other enums and
7355 their values. Some non-GCC compilers don't like these constructs. */
7359 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7360 enum char_table_specials char_table_specials
;
7361 enum char_bits char_bits
;
7362 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7363 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7364 enum Lisp_Bits Lisp_Bits
;
7365 enum Lisp_Compiled Lisp_Compiled
;
7366 enum maxargs maxargs
;
7367 enum MAX_ALLOCA MAX_ALLOCA
;
7368 enum More_Lisp_Bits More_Lisp_Bits
;
7369 enum pvec_type pvec_type
;
7370 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7371 #endif /* __GNUC__ */