1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2018 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 (at
11 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 <https://www.gnu.org/licenses/>. */
26 #include <limits.h> /* For CHAR_BIT. */
27 #include <signal.h> /* For SIGABRT, SIGDANGER. */
34 #include "dispextern.h"
35 #include "intervals.h"
39 #include "character.h"
44 #include "blockinput.h"
45 #include "termhooks.h" /* For struct terminal. */
46 #ifdef HAVE_WINDOW_SYSTEM
48 #endif /* HAVE_WINDOW_SYSTEM */
50 #include <flexmember.h>
52 #include <execinfo.h> /* For backtrace. */
54 #ifdef HAVE_LINUX_SYSINFO
55 #include <sys/sysinfo.h>
59 #include "dosfns.h" /* For dos_memory_info. */
66 #if (defined ENABLE_CHECKING \
67 && defined HAVE_VALGRIND_VALGRIND_H \
68 && !defined USE_VALGRIND)
69 # define USE_VALGRIND 1
73 #include <valgrind/valgrind.h>
74 #include <valgrind/memcheck.h>
75 static bool valgrind_p
;
78 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
79 We turn that on by default when ENABLE_CHECKING is defined;
80 define GC_CHECK_MARKED_OBJECTS to zero to disable. */
82 #if defined ENABLE_CHECKING && !defined GC_CHECK_MARKED_OBJECTS
83 # define GC_CHECK_MARKED_OBJECTS 1
86 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
87 memory. Can do this only if using gmalloc.c and if not checking
90 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
91 || defined HYBRID_MALLOC || GC_CHECK_MARKED_OBJECTS)
92 #undef GC_MALLOC_CHECK
103 #include "w32heap.h" /* for sbrk */
107 /* The address where the heap starts. */
118 #ifdef DOUG_LEA_MALLOC
120 /* Specify maximum number of areas to mmap. It would be nice to use a
121 value that explicitly means "no limit". */
123 #define MMAP_MAX_AREAS 100000000
125 /* A pointer to the memory allocated that copies that static data
126 inside glibc's malloc. */
127 static void *malloc_state_ptr
;
129 /* Restore the dumped malloc state. Because malloc can be invoked
130 even before main (e.g. by the dynamic linker), the dumped malloc
131 state must be restored as early as possible using this special hook. */
133 malloc_initialize_hook (void)
135 static bool malloc_using_checking
;
142 malloc_using_checking
= getenv ("MALLOC_CHECK_") != NULL
;
146 if (!malloc_using_checking
)
148 /* Work around a bug in glibc's malloc. MALLOC_CHECK_ must be
149 ignored if the heap to be restored was constructed without
150 malloc checking. Can't use unsetenv, since that calls malloc. */
154 if (strncmp (*p
, "MALLOC_CHECK_=", 14) == 0)
164 if (malloc_set_state (malloc_state_ptr
) != 0)
166 # ifndef XMALLOC_OVERRUN_CHECK
167 alloc_unexec_post ();
172 /* Declare the malloc initialization hook, which runs before 'main' starts.
173 EXTERNALLY_VISIBLE works around Bug#22522. */
174 # ifndef __MALLOC_HOOK_VOLATILE
175 # define __MALLOC_HOOK_VOLATILE
177 voidfuncptr __MALLOC_HOOK_VOLATILE __malloc_initialize_hook EXTERNALLY_VISIBLE
178 = malloc_initialize_hook
;
182 #if defined DOUG_LEA_MALLOC || !defined CANNOT_DUMP
184 /* Allocator-related actions to do just before and after unexec. */
187 alloc_unexec_pre (void)
189 # ifdef DOUG_LEA_MALLOC
190 malloc_state_ptr
= malloc_get_state ();
191 if (!malloc_state_ptr
)
192 fatal ("malloc_get_state: %s", strerror (errno
));
194 # ifdef HYBRID_MALLOC
195 bss_sbrk_did_unexec
= true;
200 alloc_unexec_post (void)
202 # ifdef DOUG_LEA_MALLOC
203 free (malloc_state_ptr
);
205 # ifdef HYBRID_MALLOC
206 bss_sbrk_did_unexec
= false;
211 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
212 to a struct Lisp_String. */
214 #define MARK_STRING(S) ((S)->u.s.size |= ARRAY_MARK_FLAG)
215 #define UNMARK_STRING(S) ((S)->u.s.size &= ~ARRAY_MARK_FLAG)
216 #define STRING_MARKED_P(S) (((S)->u.s.size & ARRAY_MARK_FLAG) != 0)
218 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
219 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
220 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
222 /* Default value of gc_cons_threshold (see below). */
224 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
226 /* Global variables. */
227 struct emacs_globals globals
;
229 /* Number of bytes of consing done since the last gc. */
231 EMACS_INT consing_since_gc
;
233 /* Similar minimum, computed from Vgc_cons_percentage. */
235 EMACS_INT gc_relative_threshold
;
237 /* Minimum number of bytes of consing since GC before next GC,
238 when memory is full. */
240 EMACS_INT memory_full_cons_threshold
;
242 /* True during GC. */
246 /* Number of live and free conses etc. */
248 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
249 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
250 static EMACS_INT total_free_floats
, total_floats
;
252 /* Points to memory space allocated as "spare", to be freed if we run
253 out of memory. We keep one large block, four cons-blocks, and
254 two string blocks. */
256 static char *spare_memory
[7];
258 /* Amount of spare memory to keep in large reserve block, or to see
259 whether this much is available when malloc fails on a larger request. */
261 #define SPARE_MEMORY (1 << 14)
263 /* Initialize it to a nonzero value to force it into data space
264 (rather than bss space). That way unexec will remap it into text
265 space (pure), on some systems. We have not implemented the
266 remapping on more recent systems because this is less important
267 nowadays than in the days of small memories and timesharing. */
269 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
270 #define PUREBEG (char *) pure
272 /* Pointer to the pure area, and its size. */
274 static char *purebeg
;
275 static ptrdiff_t pure_size
;
277 /* Number of bytes of pure storage used before pure storage overflowed.
278 If this is non-zero, this implies that an overflow occurred. */
280 static ptrdiff_t pure_bytes_used_before_overflow
;
282 /* Index in pure at which next pure Lisp object will be allocated.. */
284 static ptrdiff_t pure_bytes_used_lisp
;
286 /* Number of bytes allocated for non-Lisp objects in pure storage. */
288 static ptrdiff_t pure_bytes_used_non_lisp
;
290 /* If nonzero, this is a warning delivered by malloc and not yet
293 const char *pending_malloc_warning
;
295 #if 0 /* Normally, pointer sanity only on request... */
296 #ifdef ENABLE_CHECKING
297 #define SUSPICIOUS_OBJECT_CHECKING 1
301 /* ... but unconditionally use SUSPICIOUS_OBJECT_CHECKING while the GC
302 bug is unresolved. */
303 #define SUSPICIOUS_OBJECT_CHECKING 1
305 #ifdef SUSPICIOUS_OBJECT_CHECKING
306 struct suspicious_free_record
308 void *suspicious_object
;
309 void *backtrace
[128];
311 static void *suspicious_objects
[32];
312 static int suspicious_object_index
;
313 struct suspicious_free_record suspicious_free_history
[64] EXTERNALLY_VISIBLE
;
314 static int suspicious_free_history_index
;
315 /* Find the first currently-monitored suspicious pointer in range
316 [begin,end) or NULL if no such pointer exists. */
317 static void *find_suspicious_object_in_range (void *begin
, void *end
);
318 static void detect_suspicious_free (void *ptr
);
320 # define find_suspicious_object_in_range(begin, end) NULL
321 # define detect_suspicious_free(ptr) (void)
324 /* Maximum amount of C stack to save when a GC happens. */
326 #ifndef MAX_SAVE_STACK
327 #define MAX_SAVE_STACK 16000
330 /* Buffer in which we save a copy of the C stack at each GC. */
332 #if MAX_SAVE_STACK > 0
333 static char *stack_copy
;
334 static ptrdiff_t stack_copy_size
;
336 /* Copy to DEST a block of memory from SRC of size SIZE bytes,
337 avoiding any address sanitization. */
339 static void * ATTRIBUTE_NO_SANITIZE_ADDRESS
340 no_sanitize_memcpy (void *dest
, void const *src
, size_t size
)
342 if (! ADDRESS_SANITIZER
)
343 return memcpy (dest
, src
, size
);
349 for (i
= 0; i
< size
; i
++)
355 #endif /* MAX_SAVE_STACK > 0 */
357 static void mark_terminals (void);
358 static void gc_sweep (void);
359 static Lisp_Object
make_pure_vector (ptrdiff_t);
360 static void mark_buffer (struct buffer
*);
362 #if !defined REL_ALLOC || defined SYSTEM_MALLOC || defined HYBRID_MALLOC
363 static void refill_memory_reserve (void);
365 static void compact_small_strings (void);
366 static void free_large_strings (void);
367 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
369 /* When scanning the C stack for live Lisp objects, Emacs keeps track of
370 what memory allocated via lisp_malloc and lisp_align_malloc is intended
371 for what purpose. This enumeration specifies the type of memory. */
382 /* Since all non-bool pseudovectors are small enough to be
383 allocated from vector blocks, this memory type denotes
384 large regular vectors and large bool pseudovectors. */
386 /* Special type to denote vector blocks. */
387 MEM_TYPE_VECTOR_BLOCK
,
388 /* Special type to denote reserved memory. */
392 /* A unique object in pure space used to make some Lisp objects
393 on free lists recognizable in O(1). */
395 static Lisp_Object Vdead
;
396 #define DEADP(x) EQ (x, Vdead)
398 #ifdef GC_MALLOC_CHECK
400 enum mem_type allocated_mem_type
;
402 #endif /* GC_MALLOC_CHECK */
404 /* A node in the red-black tree describing allocated memory containing
405 Lisp data. Each such block is recorded with its start and end
406 address when it is allocated, and removed from the tree when it
409 A red-black tree is a balanced binary tree with the following
412 1. Every node is either red or black.
413 2. Every leaf is black.
414 3. If a node is red, then both of its children are black.
415 4. Every simple path from a node to a descendant leaf contains
416 the same number of black nodes.
417 5. The root is always black.
419 When nodes are inserted into the tree, or deleted from the tree,
420 the tree is "fixed" so that these properties are always true.
422 A red-black tree with N internal nodes has height at most 2
423 log(N+1). Searches, insertions and deletions are done in O(log N).
424 Please see a text book about data structures for a detailed
425 description of red-black trees. Any book worth its salt should
430 /* Children of this node. These pointers are never NULL. When there
431 is no child, the value is MEM_NIL, which points to a dummy node. */
432 struct mem_node
*left
, *right
;
434 /* The parent of this node. In the root node, this is NULL. */
435 struct mem_node
*parent
;
437 /* Start and end of allocated region. */
441 enum {MEM_BLACK
, MEM_RED
} color
;
447 /* Root of the tree describing allocated Lisp memory. */
449 static struct mem_node
*mem_root
;
451 /* Lowest and highest known address in the heap. */
453 static void *min_heap_address
, *max_heap_address
;
455 /* Sentinel node of the tree. */
457 static struct mem_node mem_z
;
458 #define MEM_NIL &mem_z
460 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
461 static void mem_insert_fixup (struct mem_node
*);
462 static void mem_rotate_left (struct mem_node
*);
463 static void mem_rotate_right (struct mem_node
*);
464 static void mem_delete (struct mem_node
*);
465 static void mem_delete_fixup (struct mem_node
*);
466 static struct mem_node
*mem_find (void *);
472 /* Addresses of staticpro'd variables. Initialize it to a nonzero
473 value; otherwise some compilers put it into BSS. */
475 enum { NSTATICS
= 2048 };
476 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
478 /* Index of next unused slot in staticvec. */
480 static int staticidx
;
482 static void *pure_alloc (size_t, int);
484 /* True if N is a power of 2. N should be positive. */
486 #define POWER_OF_2(n) (((n) & ((n) - 1)) == 0)
488 /* Return X rounded to the next multiple of Y. Y should be positive,
489 and Y - 1 + X should not overflow. Arguments should not have side
490 effects, as they are evaluated more than once. Tune for Y being a
493 #define ROUNDUP(x, y) (POWER_OF_2 (y) \
494 ? ((y) - 1 + (x)) & ~ ((y) - 1) \
495 : ((y) - 1 + (x)) - ((y) - 1 + (x)) % (y))
497 /* Return PTR rounded up to the next multiple of ALIGNMENT. */
500 pointer_align (void *ptr
, int alignment
)
502 return (void *) ROUNDUP ((uintptr_t) ptr
, alignment
);
505 /* Extract the pointer hidden within A, if A is not a symbol.
506 If A is a symbol, extract the hidden pointer's offset from lispsym,
507 converted to void *. */
509 #define macro_XPNTR_OR_SYMBOL_OFFSET(a) \
510 ((void *) (intptr_t) (USE_LSB_TAG ? XLI (a) - XTYPE (a) : XLI (a) & VALMASK))
512 /* Extract the pointer hidden within A. */
514 #define macro_XPNTR(a) \
515 ((void *) ((intptr_t) XPNTR_OR_SYMBOL_OFFSET (a) \
516 + (SYMBOLP (a) ? (char *) lispsym : NULL)))
518 /* For pointer access, define XPNTR and XPNTR_OR_SYMBOL_OFFSET as
519 functions, as functions are cleaner and can be used in debuggers.
520 Also, define them as macros if being compiled with GCC without
521 optimization, for performance in that case. The macro_* names are
522 private to this section of code. */
524 static ATTRIBUTE_UNUSED
void *
525 XPNTR_OR_SYMBOL_OFFSET (Lisp_Object a
)
527 return macro_XPNTR_OR_SYMBOL_OFFSET (a
);
529 static ATTRIBUTE_UNUSED
void *
530 XPNTR (Lisp_Object a
)
532 return macro_XPNTR (a
);
535 #if DEFINE_KEY_OPS_AS_MACROS
536 # define XPNTR_OR_SYMBOL_OFFSET(a) macro_XPNTR_OR_SYMBOL_OFFSET (a)
537 # define XPNTR(a) macro_XPNTR (a)
541 XFLOAT_INIT (Lisp_Object f
, double n
)
543 XFLOAT (f
)->u
.data
= n
;
546 #ifdef DOUG_LEA_MALLOC
548 pointers_fit_in_lispobj_p (void)
550 return (UINTPTR_MAX
<= VAL_MAX
) || USE_LSB_TAG
;
554 mmap_lisp_allowed_p (void)
556 /* If we can't store all memory addresses in our lisp objects, it's
557 risky to let the heap use mmap and give us addresses from all
558 over our address space. We also can't use mmap for lisp objects
559 if we might dump: unexec doesn't preserve the contents of mmapped
561 return pointers_fit_in_lispobj_p () && !might_dump
;
565 /* Head of a circularly-linked list of extant finalizers. */
566 static struct Lisp_Finalizer finalizers
;
568 /* Head of a circularly-linked list of finalizers that must be invoked
569 because we deemed them unreachable. This list must be global, and
570 not a local inside garbage_collect_1, in case we GC again while
571 running finalizers. */
572 static struct Lisp_Finalizer doomed_finalizers
;
575 /************************************************************************
577 ************************************************************************/
579 #if defined SIGDANGER || (!defined SYSTEM_MALLOC && !defined HYBRID_MALLOC)
581 /* Function malloc calls this if it finds we are near exhausting storage. */
584 malloc_warning (const char *str
)
586 pending_malloc_warning
= str
;
591 /* Display an already-pending malloc warning. */
594 display_malloc_warning (void)
596 call3 (intern ("display-warning"),
598 build_string (pending_malloc_warning
),
599 intern ("emergency"));
600 pending_malloc_warning
= 0;
603 /* Called if we can't allocate relocatable space for a buffer. */
606 buffer_memory_full (ptrdiff_t nbytes
)
608 /* If buffers use the relocating allocator, no need to free
609 spare_memory, because we may have plenty of malloc space left
610 that we could get, and if we don't, the malloc that fails will
611 itself cause spare_memory to be freed. If buffers don't use the
612 relocating allocator, treat this like any other failing
616 memory_full (nbytes
);
618 /* This used to call error, but if we've run out of memory, we could
619 get infinite recursion trying to build the string. */
620 xsignal (Qnil
, Vmemory_signal_data
);
624 /* A common multiple of the positive integers A and B. Ideally this
625 would be the least common multiple, but there's no way to do that
626 as a constant expression in C, so do the best that we can easily do. */
627 #define COMMON_MULTIPLE(a, b) \
628 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
630 #ifndef XMALLOC_OVERRUN_CHECK
631 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
634 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
637 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
638 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
639 block size in little-endian order. The trailer consists of
640 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
642 The header is used to detect whether this block has been allocated
643 through these functions, as some low-level libc functions may
644 bypass the malloc hooks. */
646 #define XMALLOC_OVERRUN_CHECK_SIZE 16
647 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
648 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
650 #define XMALLOC_BASE_ALIGNMENT alignof (max_align_t)
652 #define XMALLOC_HEADER_ALIGNMENT \
653 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
655 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
656 hold a size_t value and (2) the header size is a multiple of the
657 alignment that Emacs needs for C types and for USE_LSB_TAG. */
658 #define XMALLOC_OVERRUN_SIZE_SIZE \
659 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
660 + XMALLOC_HEADER_ALIGNMENT - 1) \
661 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
662 - XMALLOC_OVERRUN_CHECK_SIZE)
664 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
665 { '\x9a', '\x9b', '\xae', '\xaf',
666 '\xbf', '\xbe', '\xce', '\xcf',
667 '\xea', '\xeb', '\xec', '\xed',
668 '\xdf', '\xde', '\x9c', '\x9d' };
670 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
671 { '\xaa', '\xab', '\xac', '\xad',
672 '\xba', '\xbb', '\xbc', '\xbd',
673 '\xca', '\xcb', '\xcc', '\xcd',
674 '\xda', '\xdb', '\xdc', '\xdd' };
676 /* Insert and extract the block size in the header. */
679 xmalloc_put_size (unsigned char *ptr
, size_t size
)
682 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
684 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
690 xmalloc_get_size (unsigned char *ptr
)
694 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
695 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
704 /* Like malloc, but wraps allocated block with header and trailer. */
707 overrun_check_malloc (size_t size
)
709 register unsigned char *val
;
710 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
713 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
716 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
717 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
718 xmalloc_put_size (val
, size
);
719 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
720 XMALLOC_OVERRUN_CHECK_SIZE
);
726 /* Like realloc, but checks old block for overrun, and wraps new block
727 with header and trailer. */
730 overrun_check_realloc (void *block
, size_t size
)
732 register unsigned char *val
= (unsigned char *) block
;
733 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
737 && memcmp (xmalloc_overrun_check_header
,
738 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
739 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
741 size_t osize
= xmalloc_get_size (val
);
742 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
743 XMALLOC_OVERRUN_CHECK_SIZE
))
745 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
746 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
747 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
750 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
754 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
755 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
756 xmalloc_put_size (val
, size
);
757 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
758 XMALLOC_OVERRUN_CHECK_SIZE
);
763 /* Like free, but checks block for overrun. */
766 overrun_check_free (void *block
)
768 unsigned char *val
= (unsigned char *) block
;
771 && memcmp (xmalloc_overrun_check_header
,
772 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
773 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
775 size_t osize
= xmalloc_get_size (val
);
776 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
777 XMALLOC_OVERRUN_CHECK_SIZE
))
779 #ifdef XMALLOC_CLEAR_FREE_MEMORY
780 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
781 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
783 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
784 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
785 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
795 #define malloc overrun_check_malloc
796 #define realloc overrun_check_realloc
797 #define free overrun_check_free
800 /* If compiled with XMALLOC_BLOCK_INPUT_CHECK, define a symbol
801 BLOCK_INPUT_IN_MEMORY_ALLOCATORS that is visible to the debugger.
802 If that variable is set, block input while in one of Emacs's memory
803 allocation functions. There should be no need for this debugging
804 option, since signal handlers do not allocate memory, but Emacs
805 formerly allocated memory in signal handlers and this compile-time
806 option remains as a way to help debug the issue should it rear its
808 #ifdef XMALLOC_BLOCK_INPUT_CHECK
809 bool block_input_in_memory_allocators EXTERNALLY_VISIBLE
;
811 malloc_block_input (void)
813 if (block_input_in_memory_allocators
)
817 malloc_unblock_input (void)
819 if (block_input_in_memory_allocators
)
822 # define MALLOC_BLOCK_INPUT malloc_block_input ()
823 # define MALLOC_UNBLOCK_INPUT malloc_unblock_input ()
825 # define MALLOC_BLOCK_INPUT ((void) 0)
826 # define MALLOC_UNBLOCK_INPUT ((void) 0)
829 #define MALLOC_PROBE(size) \
831 if (profiler_memory_running) \
832 malloc_probe (size); \
835 static void *lmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
836 static void *lrealloc (void *, size_t);
838 /* Like malloc but check for no memory and block interrupt input. */
841 xmalloc (size_t size
)
846 val
= lmalloc (size
);
847 MALLOC_UNBLOCK_INPUT
;
855 /* Like the above, but zeroes out the memory just allocated. */
858 xzalloc (size_t size
)
863 val
= lmalloc (size
);
864 MALLOC_UNBLOCK_INPUT
;
868 memset (val
, 0, size
);
873 /* Like realloc but check for no memory and block interrupt input.. */
876 xrealloc (void *block
, size_t size
)
881 /* We must call malloc explicitly when BLOCK is 0, since some
882 reallocs don't do this. */
884 val
= lmalloc (size
);
886 val
= lrealloc (block
, size
);
887 MALLOC_UNBLOCK_INPUT
;
896 /* Like free but block interrupt input. */
905 MALLOC_UNBLOCK_INPUT
;
906 /* We don't call refill_memory_reserve here
907 because in practice the call in r_alloc_free seems to suffice. */
911 /* Other parts of Emacs pass large int values to allocator functions
912 expecting ptrdiff_t. This is portable in practice, but check it to
914 verify (INT_MAX
<= PTRDIFF_MAX
);
917 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
918 Signal an error on memory exhaustion, and block interrupt input. */
921 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
923 eassert (0 <= nitems
&& 0 < item_size
);
925 if (INT_MULTIPLY_WRAPV (nitems
, item_size
, &nbytes
) || SIZE_MAX
< nbytes
)
926 memory_full (SIZE_MAX
);
927 return xmalloc (nbytes
);
931 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
932 Signal an error on memory exhaustion, and block interrupt input. */
935 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
937 eassert (0 <= nitems
&& 0 < item_size
);
939 if (INT_MULTIPLY_WRAPV (nitems
, item_size
, &nbytes
) || SIZE_MAX
< nbytes
)
940 memory_full (SIZE_MAX
);
941 return xrealloc (pa
, nbytes
);
945 /* Grow PA, which points to an array of *NITEMS items, and return the
946 location of the reallocated array, updating *NITEMS to reflect its
947 new size. The new array will contain at least NITEMS_INCR_MIN more
948 items, but will not contain more than NITEMS_MAX items total.
949 ITEM_SIZE is the size of each item, in bytes.
951 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
952 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
955 If PA is null, then allocate a new array instead of reallocating
958 Block interrupt input as needed. If memory exhaustion occurs, set
959 *NITEMS to zero if PA is null, and signal an error (i.e., do not
962 Thus, to grow an array A without saving its old contents, do
963 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
964 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
965 and signals an error, and later this code is reexecuted and
966 attempts to free A. */
969 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
970 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
972 ptrdiff_t n0
= *nitems
;
973 eassume (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n0
&& -1 <= nitems_max
);
975 /* The approximate size to use for initial small allocation
976 requests. This is the largest "small" request for the GNU C
978 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
980 /* If the array is tiny, grow it to about (but no greater than)
981 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%.
982 Adjust the growth according to three constraints: NITEMS_INCR_MIN,
983 NITEMS_MAX, and what the C language can represent safely. */
986 if (INT_ADD_WRAPV (n0
, n0
>> 1, &n
))
988 if (0 <= nitems_max
&& nitems_max
< n
)
991 ptrdiff_t adjusted_nbytes
992 = ((INT_MULTIPLY_WRAPV (n
, item_size
, &nbytes
) || SIZE_MAX
< nbytes
)
993 ? min (PTRDIFF_MAX
, SIZE_MAX
)
994 : nbytes
< DEFAULT_MXFAST
? DEFAULT_MXFAST
: 0);
997 n
= adjusted_nbytes
/ item_size
;
998 nbytes
= adjusted_nbytes
- adjusted_nbytes
% item_size
;
1003 if (n
- n0
< nitems_incr_min
1004 && (INT_ADD_WRAPV (n0
, nitems_incr_min
, &n
)
1005 || (0 <= nitems_max
&& nitems_max
< n
)
1006 || INT_MULTIPLY_WRAPV (n
, item_size
, &nbytes
)))
1007 memory_full (SIZE_MAX
);
1008 pa
= xrealloc (pa
, nbytes
);
1014 /* Like strdup, but uses xmalloc. */
1017 xstrdup (const char *s
)
1021 size
= strlen (s
) + 1;
1022 return memcpy (xmalloc (size
), s
, size
);
1025 /* Like above, but duplicates Lisp string to C string. */
1028 xlispstrdup (Lisp_Object string
)
1030 ptrdiff_t size
= SBYTES (string
) + 1;
1031 return memcpy (xmalloc (size
), SSDATA (string
), size
);
1034 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
1035 pointed to. If STRING is null, assign it without copying anything.
1036 Allocate before freeing, to avoid a dangling pointer if allocation
1040 dupstring (char **ptr
, char const *string
)
1043 *ptr
= string
? xstrdup (string
) : 0;
1048 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
1049 argument is a const pointer. */
1052 xputenv (char const *string
)
1054 if (putenv ((char *) string
) != 0)
1058 /* Return a newly allocated memory block of SIZE bytes, remembering
1059 to free it when unwinding. */
1061 record_xmalloc (size_t size
)
1063 void *p
= xmalloc (size
);
1064 record_unwind_protect_ptr (xfree
, p
);
1069 /* Like malloc but used for allocating Lisp data. NBYTES is the
1070 number of bytes to allocate, TYPE describes the intended use of the
1071 allocated memory block (for strings, for conses, ...). */
1074 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
1078 lisp_malloc (size_t nbytes
, enum mem_type type
)
1084 #ifdef GC_MALLOC_CHECK
1085 allocated_mem_type
= type
;
1088 val
= lmalloc (nbytes
);
1091 /* If the memory just allocated cannot be addressed thru a Lisp
1092 object's pointer, and it needs to be,
1093 that's equivalent to running out of memory. */
1094 if (val
&& type
!= MEM_TYPE_NON_LISP
)
1097 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
1098 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
1100 lisp_malloc_loser
= val
;
1107 #ifndef GC_MALLOC_CHECK
1108 if (val
&& type
!= MEM_TYPE_NON_LISP
)
1109 mem_insert (val
, (char *) val
+ nbytes
, type
);
1112 MALLOC_UNBLOCK_INPUT
;
1114 memory_full (nbytes
);
1115 MALLOC_PROBE (nbytes
);
1119 /* Free BLOCK. This must be called to free memory allocated with a
1120 call to lisp_malloc. */
1123 lisp_free (void *block
)
1127 #ifndef GC_MALLOC_CHECK
1128 mem_delete (mem_find (block
));
1130 MALLOC_UNBLOCK_INPUT
;
1133 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
1135 /* The entry point is lisp_align_malloc which returns blocks of at most
1136 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
1138 /* Byte alignment of storage blocks. */
1139 #define BLOCK_ALIGN (1 << 10)
1140 verify (POWER_OF_2 (BLOCK_ALIGN
));
1142 /* Use aligned_alloc if it or a simple substitute is available.
1143 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
1144 clang 3.3 anyway. Aligned allocation is incompatible with
1145 unexmacosx.c, so don't use it on Darwin. */
1147 #if ! ADDRESS_SANITIZER && !defined DARWIN_OS
1148 # if (defined HAVE_ALIGNED_ALLOC \
1149 || (defined HYBRID_MALLOC \
1150 ? defined HAVE_POSIX_MEMALIGN \
1151 : !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC))
1152 # define USE_ALIGNED_ALLOC 1
1153 # elif !defined HYBRID_MALLOC && defined HAVE_POSIX_MEMALIGN
1154 # define USE_ALIGNED_ALLOC 1
1155 # define aligned_alloc my_aligned_alloc /* Avoid collision with lisp.h. */
1157 aligned_alloc (size_t alignment
, size_t size
)
1159 /* POSIX says the alignment must be a power-of-2 multiple of sizeof (void *).
1160 Verify this for all arguments this function is given. */
1161 verify (BLOCK_ALIGN
% sizeof (void *) == 0
1162 && POWER_OF_2 (BLOCK_ALIGN
/ sizeof (void *)));
1163 verify (GCALIGNMENT
% sizeof (void *) == 0
1164 && POWER_OF_2 (GCALIGNMENT
/ sizeof (void *)));
1165 eassert (alignment
== BLOCK_ALIGN
|| alignment
== GCALIGNMENT
);
1168 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
1173 /* Padding to leave at the end of a malloc'd block. This is to give
1174 malloc a chance to minimize the amount of memory wasted to alignment.
1175 It should be tuned to the particular malloc library used.
1176 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
1177 aligned_alloc on the other hand would ideally prefer a value of 4
1178 because otherwise, there's 1020 bytes wasted between each ablocks.
1179 In Emacs, testing shows that those 1020 can most of the time be
1180 efficiently used by malloc to place other objects, so a value of 0 can
1181 still preferable unless you have a lot of aligned blocks and virtually
1183 #define BLOCK_PADDING 0
1184 #define BLOCK_BYTES \
1185 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1187 /* Internal data structures and constants. */
1189 #define ABLOCKS_SIZE 16
1191 /* An aligned block of memory. */
1196 char payload
[BLOCK_BYTES
];
1197 struct ablock
*next_free
;
1200 /* ABASE is the aligned base of the ablocks. It is overloaded to
1201 hold a virtual "busy" field that counts twice the number of used
1202 ablock values in the parent ablocks, plus one if the real base of
1203 the parent ablocks is ABASE (if the "busy" field is even, the
1204 word before the first ablock holds a pointer to the real base).
1205 The first ablock has a "busy" ABASE, and the others have an
1206 ordinary pointer ABASE. To tell the difference, the code assumes
1207 that pointers, when cast to uintptr_t, are at least 2 *
1208 ABLOCKS_SIZE + 1. */
1209 struct ablocks
*abase
;
1211 /* The padding of all but the last ablock is unused. The padding of
1212 the last ablock in an ablocks is not allocated. */
1214 char padding
[BLOCK_PADDING
];
1218 /* A bunch of consecutive aligned blocks. */
1221 struct ablock blocks
[ABLOCKS_SIZE
];
1224 /* Size of the block requested from malloc or aligned_alloc. */
1225 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1227 #define ABLOCK_ABASE(block) \
1228 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1229 ? (struct ablocks *) (block) \
1232 /* Virtual `busy' field. */
1233 #define ABLOCKS_BUSY(a_base) ((a_base)->blocks[0].abase)
1235 /* Pointer to the (not necessarily aligned) malloc block. */
1236 #ifdef USE_ALIGNED_ALLOC
1237 #define ABLOCKS_BASE(abase) (abase)
1239 #define ABLOCKS_BASE(abase) \
1240 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **) (abase))[-1])
1243 /* The list of free ablock. */
1244 static struct ablock
*free_ablock
;
1246 /* Allocate an aligned block of nbytes.
1247 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1248 smaller or equal to BLOCK_BYTES. */
1250 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1253 struct ablocks
*abase
;
1255 eassert (nbytes
<= BLOCK_BYTES
);
1259 #ifdef GC_MALLOC_CHECK
1260 allocated_mem_type
= type
;
1268 #ifdef DOUG_LEA_MALLOC
1269 if (!mmap_lisp_allowed_p ())
1270 mallopt (M_MMAP_MAX
, 0);
1273 #ifdef USE_ALIGNED_ALLOC
1274 verify (ABLOCKS_BYTES
% BLOCK_ALIGN
== 0);
1275 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1277 base
= malloc (ABLOCKS_BYTES
);
1278 abase
= pointer_align (base
, BLOCK_ALIGN
);
1283 MALLOC_UNBLOCK_INPUT
;
1284 memory_full (ABLOCKS_BYTES
);
1287 aligned
= (base
== abase
);
1289 ((void **) abase
)[-1] = base
;
1291 #ifdef DOUG_LEA_MALLOC
1292 if (!mmap_lisp_allowed_p ())
1293 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1297 /* If the memory just allocated cannot be addressed thru a Lisp
1298 object's pointer, and it needs to be, that's equivalent to
1299 running out of memory. */
1300 if (type
!= MEM_TYPE_NON_LISP
)
1303 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1304 XSETCONS (tem
, end
);
1305 if ((char *) XCONS (tem
) != end
)
1307 lisp_malloc_loser
= base
;
1309 MALLOC_UNBLOCK_INPUT
;
1310 memory_full (SIZE_MAX
);
1315 /* Initialize the blocks and put them on the free list.
1316 If `base' was not properly aligned, we can't use the last block. */
1317 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1319 abase
->blocks
[i
].abase
= abase
;
1320 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1321 free_ablock
= &abase
->blocks
[i
];
1323 intptr_t ialigned
= aligned
;
1324 ABLOCKS_BUSY (abase
) = (struct ablocks
*) ialigned
;
1326 eassert ((uintptr_t) abase
% BLOCK_ALIGN
== 0);
1327 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1328 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1329 eassert (ABLOCKS_BASE (abase
) == base
);
1330 eassert ((intptr_t) ABLOCKS_BUSY (abase
) == aligned
);
1333 abase
= ABLOCK_ABASE (free_ablock
);
1334 ABLOCKS_BUSY (abase
)
1335 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1337 free_ablock
= free_ablock
->x
.next_free
;
1339 #ifndef GC_MALLOC_CHECK
1340 if (type
!= MEM_TYPE_NON_LISP
)
1341 mem_insert (val
, (char *) val
+ nbytes
, type
);
1344 MALLOC_UNBLOCK_INPUT
;
1346 MALLOC_PROBE (nbytes
);
1348 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1353 lisp_align_free (void *block
)
1355 struct ablock
*ablock
= block
;
1356 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1359 #ifndef GC_MALLOC_CHECK
1360 mem_delete (mem_find (block
));
1362 /* Put on free list. */
1363 ablock
->x
.next_free
= free_ablock
;
1364 free_ablock
= ablock
;
1365 /* Update busy count. */
1366 intptr_t busy
= (intptr_t) ABLOCKS_BUSY (abase
) - 2;
1367 eassume (0 <= busy
&& busy
<= 2 * ABLOCKS_SIZE
- 1);
1368 ABLOCKS_BUSY (abase
) = (struct ablocks
*) busy
;
1371 { /* All the blocks are free. */
1373 bool aligned
= busy
;
1374 struct ablock
**tem
= &free_ablock
;
1375 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1379 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1382 *tem
= (*tem
)->x
.next_free
;
1385 tem
= &(*tem
)->x
.next_free
;
1387 eassert ((aligned
& 1) == aligned
);
1388 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1389 #ifdef USE_POSIX_MEMALIGN
1390 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1392 free (ABLOCKS_BASE (abase
));
1394 MALLOC_UNBLOCK_INPUT
;
1397 #if !defined __GNUC__ && !defined __alignof__
1398 # define __alignof__(type) alignof (type)
1401 /* True if malloc (N) is known to return a multiple of GCALIGNMENT
1402 whenever N is also a multiple. In practice this is true if
1403 __alignof__ (max_align_t) is a multiple as well, assuming
1404 GCALIGNMENT is 8; other values of GCALIGNMENT have not been looked
1405 into. Use __alignof__ if available, as otherwise
1406 MALLOC_IS_GC_ALIGNED would be false on GCC x86 even though the
1407 alignment is OK there.
1409 This is a macro, not an enum constant, for portability to HP-UX
1410 10.20 cc and AIX 3.2.5 xlc. */
1411 #define MALLOC_IS_GC_ALIGNED \
1412 (GCALIGNMENT == 8 && __alignof__ (max_align_t) % GCALIGNMENT == 0)
1414 /* True if a malloc-returned pointer P is suitably aligned for SIZE,
1415 where Lisp alignment may be needed if SIZE is Lisp-aligned. */
1418 laligned (void *p
, size_t size
)
1420 return (MALLOC_IS_GC_ALIGNED
|| (intptr_t) p
% GCALIGNMENT
== 0
1421 || size
% GCALIGNMENT
!= 0);
1424 /* Like malloc and realloc except that if SIZE is Lisp-aligned, make
1425 sure the result is too, if necessary by reallocating (typically
1426 with larger and larger sizes) until the allocator returns a
1427 Lisp-aligned pointer. Code that needs to allocate C heap memory
1428 for a Lisp object should use one of these functions to obtain a
1429 pointer P; that way, if T is an enum Lisp_Type value and L ==
1430 make_lisp_ptr (P, T), then XPNTR (L) == P and XTYPE (L) == T.
1432 On typical modern platforms these functions' loops do not iterate.
1433 On now-rare (and perhaps nonexistent) platforms, the loops in
1434 theory could repeat forever. If an infinite loop is possible on a
1435 platform, a build would surely loop and the builder can then send
1436 us a bug report. Adding a counter to try to detect any such loop
1437 would complicate the code (and possibly introduce bugs, in code
1438 that's never really exercised) for little benefit. */
1441 lmalloc (size_t size
)
1443 #if USE_ALIGNED_ALLOC
1444 if (! MALLOC_IS_GC_ALIGNED
&& size
% GCALIGNMENT
== 0)
1445 return aligned_alloc (GCALIGNMENT
, size
);
1450 void *p
= malloc (size
);
1451 if (laligned (p
, size
))
1454 size_t bigger
= size
+ GCALIGNMENT
;
1461 lrealloc (void *p
, size_t size
)
1465 p
= realloc (p
, size
);
1466 if (laligned (p
, size
))
1468 size_t bigger
= size
+ GCALIGNMENT
;
1475 /***********************************************************************
1477 ***********************************************************************/
1479 /* Number of intervals allocated in an interval_block structure.
1480 The 1020 is 1024 minus malloc overhead. */
1482 #define INTERVAL_BLOCK_SIZE \
1483 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1485 /* Intervals are allocated in chunks in the form of an interval_block
1488 struct interval_block
1490 /* Place `intervals' first, to preserve alignment. */
1491 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1492 struct interval_block
*next
;
1495 /* Current interval block. Its `next' pointer points to older
1498 static struct interval_block
*interval_block
;
1500 /* Index in interval_block above of the next unused interval
1503 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1505 /* Number of free and live intervals. */
1507 static EMACS_INT total_free_intervals
, total_intervals
;
1509 /* List of free intervals. */
1511 static INTERVAL interval_free_list
;
1513 /* Return a new interval. */
1516 make_interval (void)
1522 if (interval_free_list
)
1524 val
= interval_free_list
;
1525 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1529 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1531 struct interval_block
*newi
1532 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1534 newi
->next
= interval_block
;
1535 interval_block
= newi
;
1536 interval_block_index
= 0;
1537 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1539 val
= &interval_block
->intervals
[interval_block_index
++];
1542 MALLOC_UNBLOCK_INPUT
;
1544 consing_since_gc
+= sizeof (struct interval
);
1546 total_free_intervals
--;
1547 RESET_INTERVAL (val
);
1553 /* Mark Lisp objects in interval I. */
1556 mark_interval (INTERVAL i
, void *dummy
)
1558 /* Intervals should never be shared. So, if extra internal checking is
1559 enabled, GC aborts if it seems to have visited an interval twice. */
1560 eassert (!i
->gcmarkbit
);
1562 mark_object (i
->plist
);
1565 /* Mark the interval tree rooted in I. */
1567 #define MARK_INTERVAL_TREE(i) \
1569 if (i && !i->gcmarkbit) \
1570 traverse_intervals_noorder (i, mark_interval, NULL); \
1573 /***********************************************************************
1575 ***********************************************************************/
1577 /* Lisp_Strings are allocated in string_block structures. When a new
1578 string_block is allocated, all the Lisp_Strings it contains are
1579 added to a free-list string_free_list. When a new Lisp_String is
1580 needed, it is taken from that list. During the sweep phase of GC,
1581 string_blocks that are entirely free are freed, except two which
1584 String data is allocated from sblock structures. Strings larger
1585 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1586 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1588 Sblocks consist internally of sdata structures, one for each
1589 Lisp_String. The sdata structure points to the Lisp_String it
1590 belongs to. The Lisp_String points back to the `u.data' member of
1591 its sdata structure.
1593 When a Lisp_String is freed during GC, it is put back on
1594 string_free_list, and its `data' member and its sdata's `string'
1595 pointer is set to null. The size of the string is recorded in the
1596 `n.nbytes' member of the sdata. So, sdata structures that are no
1597 longer used, can be easily recognized, and it's easy to compact the
1598 sblocks of small strings which we do in compact_small_strings. */
1600 /* Size in bytes of an sblock structure used for small strings. This
1601 is 8192 minus malloc overhead. */
1603 #define SBLOCK_SIZE 8188
1605 /* Strings larger than this are considered large strings. String data
1606 for large strings is allocated from individual sblocks. */
1608 #define LARGE_STRING_BYTES 1024
1610 /* The SDATA typedef is a struct or union describing string memory
1611 sub-allocated from an sblock. This is where the contents of Lisp
1612 strings are stored. */
1616 /* Back-pointer to the string this sdata belongs to. If null, this
1617 structure is free, and NBYTES (in this structure or in the union below)
1618 contains the string's byte size (the same value that STRING_BYTES
1619 would return if STRING were non-null). If non-null, STRING_BYTES
1620 (STRING) is the size of the data, and DATA contains the string's
1622 struct Lisp_String
*string
;
1624 #ifdef GC_CHECK_STRING_BYTES
1628 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1631 #ifdef GC_CHECK_STRING_BYTES
1633 typedef struct sdata sdata
;
1634 #define SDATA_NBYTES(S) (S)->nbytes
1635 #define SDATA_DATA(S) (S)->data
1641 struct Lisp_String
*string
;
1643 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1644 which has a flexible array member. However, if implemented by
1645 giving this union a member of type 'struct sdata', the union
1646 could not be the last (flexible) member of 'struct sblock',
1647 because C99 prohibits a flexible array member from having a type
1648 that is itself a flexible array. So, comment this member out here,
1649 but remember that the option's there when using this union. */
1654 /* When STRING is null. */
1657 struct Lisp_String
*string
;
1662 #define SDATA_NBYTES(S) (S)->n.nbytes
1663 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1665 #endif /* not GC_CHECK_STRING_BYTES */
1667 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1669 /* Structure describing a block of memory which is sub-allocated to
1670 obtain string data memory for strings. Blocks for small strings
1671 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1672 as large as needed. */
1677 struct sblock
*next
;
1679 /* Pointer to the next free sdata block. This points past the end
1680 of the sblock if there isn't any space left in this block. */
1684 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1687 /* Number of Lisp strings in a string_block structure. The 1020 is
1688 1024 minus malloc overhead. */
1690 #define STRING_BLOCK_SIZE \
1691 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1693 /* Structure describing a block from which Lisp_String structures
1698 /* Place `strings' first, to preserve alignment. */
1699 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1700 struct string_block
*next
;
1703 /* Head and tail of the list of sblock structures holding Lisp string
1704 data. We always allocate from current_sblock. The NEXT pointers
1705 in the sblock structures go from oldest_sblock to current_sblock. */
1707 static struct sblock
*oldest_sblock
, *current_sblock
;
1709 /* List of sblocks for large strings. */
1711 static struct sblock
*large_sblocks
;
1713 /* List of string_block structures. */
1715 static struct string_block
*string_blocks
;
1717 /* Free-list of Lisp_Strings. */
1719 static struct Lisp_String
*string_free_list
;
1721 /* Number of live and free Lisp_Strings. */
1723 static EMACS_INT total_strings
, total_free_strings
;
1725 /* Number of bytes used by live strings. */
1727 static EMACS_INT total_string_bytes
;
1729 /* Given a pointer to a Lisp_String S which is on the free-list
1730 string_free_list, return a pointer to its successor in the
1733 #define NEXT_FREE_LISP_STRING(S) ((S)->u.next)
1735 /* Return a pointer to the sdata structure belonging to Lisp string S.
1736 S must be live, i.e. S->data must not be null. S->data is actually
1737 a pointer to the `u.data' member of its sdata structure; the
1738 structure starts at a constant offset in front of that. */
1740 #define SDATA_OF_STRING(S) ((sdata *) ((S)->u.s.data - SDATA_DATA_OFFSET))
1743 #ifdef GC_CHECK_STRING_OVERRUN
1745 /* We check for overrun in string data blocks by appending a small
1746 "cookie" after each allocated string data block, and check for the
1747 presence of this cookie during GC. */
1749 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1750 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1751 { '\xde', '\xad', '\xbe', '\xef' };
1754 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1757 /* Value is the size of an sdata structure large enough to hold NBYTES
1758 bytes of string data. The value returned includes a terminating
1759 NUL byte, the size of the sdata structure, and padding. */
1761 #ifdef GC_CHECK_STRING_BYTES
1763 #define SDATA_SIZE(NBYTES) FLEXSIZEOF (struct sdata, data, (NBYTES) + 1)
1765 #else /* not GC_CHECK_STRING_BYTES */
1767 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1768 less than the size of that member. The 'max' is not needed when
1769 SDATA_DATA_OFFSET is a multiple of FLEXALIGNOF (struct sdata),
1770 because then the alignment code reserves enough space. */
1772 #define SDATA_SIZE(NBYTES) \
1773 ((SDATA_DATA_OFFSET \
1774 + (SDATA_DATA_OFFSET % FLEXALIGNOF (struct sdata) == 0 \
1776 : max (NBYTES, FLEXALIGNOF (struct sdata) - 1)) \
1778 + FLEXALIGNOF (struct sdata) - 1) \
1779 & ~(FLEXALIGNOF (struct sdata) - 1))
1781 #endif /* not GC_CHECK_STRING_BYTES */
1783 /* Extra bytes to allocate for each string. */
1785 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1787 /* Exact bound on the number of bytes in a string, not counting the
1788 terminating null. A string cannot contain more bytes than
1789 STRING_BYTES_BOUND, nor can it be so long that the size_t
1790 arithmetic in allocate_string_data would overflow while it is
1791 calculating a value to be passed to malloc. */
1792 static ptrdiff_t const STRING_BYTES_MAX
=
1793 min (STRING_BYTES_BOUND
,
1794 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1796 - offsetof (struct sblock
, data
)
1797 - SDATA_DATA_OFFSET
)
1798 & ~(sizeof (EMACS_INT
) - 1)));
1800 /* Initialize string allocation. Called from init_alloc_once. */
1805 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1806 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1810 #ifdef GC_CHECK_STRING_BYTES
1812 static int check_string_bytes_count
;
1814 /* Like STRING_BYTES, but with debugging check. Can be
1815 called during GC, so pay attention to the mark bit. */
1818 string_bytes (struct Lisp_String
*s
)
1821 (s
->u
.s
.size_byte
< 0 ? s
->u
.s
.size
& ~ARRAY_MARK_FLAG
: s
->u
.s
.size_byte
);
1823 if (!PURE_P (s
) && s
->u
.s
.data
1824 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1829 /* Check validity of Lisp strings' string_bytes member in B. */
1832 check_sblock (struct sblock
*b
)
1834 sdata
*from
, *end
, *from_end
;
1838 for (from
= b
->data
; from
< end
; from
= from_end
)
1840 /* Compute the next FROM here because copying below may
1841 overwrite data we need to compute it. */
1844 /* Check that the string size recorded in the string is the
1845 same as the one recorded in the sdata structure. */
1846 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1847 : SDATA_NBYTES (from
));
1848 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1853 /* Check validity of Lisp strings' string_bytes member. ALL_P
1854 means check all strings, otherwise check only most
1855 recently allocated strings. Used for hunting a bug. */
1858 check_string_bytes (bool all_p
)
1864 for (b
= large_sblocks
; b
; b
= b
->next
)
1866 struct Lisp_String
*s
= b
->data
[0].string
;
1871 for (b
= oldest_sblock
; b
; b
= b
->next
)
1874 else if (current_sblock
)
1875 check_sblock (current_sblock
);
1878 #else /* not GC_CHECK_STRING_BYTES */
1880 #define check_string_bytes(all) ((void) 0)
1882 #endif /* GC_CHECK_STRING_BYTES */
1884 #ifdef GC_CHECK_STRING_FREE_LIST
1886 /* Walk through the string free list looking for bogus next pointers.
1887 This may catch buffer overrun from a previous string. */
1890 check_string_free_list (void)
1892 struct Lisp_String
*s
;
1894 /* Pop a Lisp_String off the free-list. */
1895 s
= string_free_list
;
1898 if ((uintptr_t) s
< 1024)
1900 s
= NEXT_FREE_LISP_STRING (s
);
1904 #define check_string_free_list()
1907 /* Return a new Lisp_String. */
1909 static struct Lisp_String
*
1910 allocate_string (void)
1912 struct Lisp_String
*s
;
1916 /* If the free-list is empty, allocate a new string_block, and
1917 add all the Lisp_Strings in it to the free-list. */
1918 if (string_free_list
== NULL
)
1920 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1923 b
->next
= string_blocks
;
1926 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1929 /* Every string on a free list should have NULL data pointer. */
1931 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1932 string_free_list
= s
;
1935 total_free_strings
+= STRING_BLOCK_SIZE
;
1938 check_string_free_list ();
1940 /* Pop a Lisp_String off the free-list. */
1941 s
= string_free_list
;
1942 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1944 MALLOC_UNBLOCK_INPUT
;
1946 --total_free_strings
;
1949 consing_since_gc
+= sizeof *s
;
1951 #ifdef GC_CHECK_STRING_BYTES
1952 if (!noninteractive
)
1954 if (++check_string_bytes_count
== 200)
1956 check_string_bytes_count
= 0;
1957 check_string_bytes (1);
1960 check_string_bytes (0);
1962 #endif /* GC_CHECK_STRING_BYTES */
1968 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1969 plus a NUL byte at the end. Allocate an sdata structure DATA for
1970 S, and set S->u.s.data to SDATA->u.data. Store a NUL byte at the
1971 end of S->u.s.data. Set S->u.s.size to NCHARS and S->u.s.size_byte
1972 to NBYTES. Free S->u.s.data if it was initially non-null. */
1975 allocate_string_data (struct Lisp_String
*s
,
1976 EMACS_INT nchars
, EMACS_INT nbytes
)
1978 sdata
*data
, *old_data
;
1980 ptrdiff_t needed
, old_nbytes
;
1982 if (STRING_BYTES_MAX
< nbytes
)
1985 /* Determine the number of bytes needed to store NBYTES bytes
1987 needed
= SDATA_SIZE (nbytes
);
1990 old_data
= SDATA_OF_STRING (s
);
1991 old_nbytes
= STRING_BYTES (s
);
1998 if (nbytes
> LARGE_STRING_BYTES
)
2000 size_t size
= FLEXSIZEOF (struct sblock
, data
, needed
);
2002 #ifdef DOUG_LEA_MALLOC
2003 if (!mmap_lisp_allowed_p ())
2004 mallopt (M_MMAP_MAX
, 0);
2007 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2009 #ifdef DOUG_LEA_MALLOC
2010 if (!mmap_lisp_allowed_p ())
2011 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2015 b
->next
= large_sblocks
;
2016 b
->next_free
= data
;
2019 else if (current_sblock
== NULL
2020 || (((char *) current_sblock
+ SBLOCK_SIZE
2021 - (char *) current_sblock
->next_free
)
2022 < (needed
+ GC_STRING_EXTRA
)))
2024 /* Not enough room in the current sblock. */
2025 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2028 b
->next_free
= data
;
2031 current_sblock
->next
= b
;
2039 data
= b
->next_free
;
2043 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2045 MALLOC_UNBLOCK_INPUT
;
2047 s
->u
.s
.data
= SDATA_DATA (data
);
2048 #ifdef GC_CHECK_STRING_BYTES
2049 SDATA_NBYTES (data
) = nbytes
;
2051 s
->u
.s
.size
= nchars
;
2052 s
->u
.s
.size_byte
= nbytes
;
2053 s
->u
.s
.data
[nbytes
] = '\0';
2054 #ifdef GC_CHECK_STRING_OVERRUN
2055 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2056 GC_STRING_OVERRUN_COOKIE_SIZE
);
2059 /* Note that Faset may call to this function when S has already data
2060 assigned. In this case, mark data as free by setting it's string
2061 back-pointer to null, and record the size of the data in it. */
2064 SDATA_NBYTES (old_data
) = old_nbytes
;
2065 old_data
->string
= NULL
;
2068 consing_since_gc
+= needed
;
2072 /* Sweep and compact strings. */
2074 NO_INLINE
/* For better stack traces */
2076 sweep_strings (void)
2078 struct string_block
*b
, *next
;
2079 struct string_block
*live_blocks
= NULL
;
2081 string_free_list
= NULL
;
2082 total_strings
= total_free_strings
= 0;
2083 total_string_bytes
= 0;
2085 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2086 for (b
= string_blocks
; b
; b
= next
)
2089 struct Lisp_String
*free_list_before
= string_free_list
;
2093 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2095 struct Lisp_String
*s
= b
->strings
+ i
;
2099 /* String was not on free-list before. */
2100 if (STRING_MARKED_P (s
))
2102 /* String is live; unmark it and its intervals. */
2105 /* Do not use string_(set|get)_intervals here. */
2106 s
->u
.s
.intervals
= balance_intervals (s
->u
.s
.intervals
);
2109 total_string_bytes
+= STRING_BYTES (s
);
2113 /* String is dead. Put it on the free-list. */
2114 sdata
*data
= SDATA_OF_STRING (s
);
2116 /* Save the size of S in its sdata so that we know
2117 how large that is. Reset the sdata's string
2118 back-pointer so that we know it's free. */
2119 #ifdef GC_CHECK_STRING_BYTES
2120 if (string_bytes (s
) != SDATA_NBYTES (data
))
2123 data
->n
.nbytes
= STRING_BYTES (s
);
2125 data
->string
= NULL
;
2127 /* Reset the strings's `data' member so that we
2131 /* Put the string on the free-list. */
2132 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2133 string_free_list
= s
;
2139 /* S was on the free-list before. Put it there again. */
2140 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2141 string_free_list
= s
;
2146 /* Free blocks that contain free Lisp_Strings only, except
2147 the first two of them. */
2148 if (nfree
== STRING_BLOCK_SIZE
2149 && total_free_strings
> STRING_BLOCK_SIZE
)
2152 string_free_list
= free_list_before
;
2156 total_free_strings
+= nfree
;
2157 b
->next
= live_blocks
;
2162 check_string_free_list ();
2164 string_blocks
= live_blocks
;
2165 free_large_strings ();
2166 compact_small_strings ();
2168 check_string_free_list ();
2172 /* Free dead large strings. */
2175 free_large_strings (void)
2177 struct sblock
*b
, *next
;
2178 struct sblock
*live_blocks
= NULL
;
2180 for (b
= large_sblocks
; b
; b
= next
)
2184 if (b
->data
[0].string
== NULL
)
2188 b
->next
= live_blocks
;
2193 large_sblocks
= live_blocks
;
2197 /* Compact data of small strings. Free sblocks that don't contain
2198 data of live strings after compaction. */
2201 compact_small_strings (void)
2203 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2204 to, and TB_END is the end of TB. */
2205 struct sblock
*tb
= oldest_sblock
;
2208 sdata
*tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2209 sdata
*to
= tb
->data
;
2211 /* Step through the blocks from the oldest to the youngest. We
2212 expect that old blocks will stabilize over time, so that less
2213 copying will happen this way. */
2214 struct sblock
*b
= tb
;
2217 sdata
*end
= b
->next_free
;
2218 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2220 for (sdata
*from
= b
->data
; from
< end
; )
2222 /* Compute the next FROM here because copying below may
2223 overwrite data we need to compute it. */
2225 struct Lisp_String
*s
= from
->string
;
2227 #ifdef GC_CHECK_STRING_BYTES
2228 /* Check that the string size recorded in the string is the
2229 same as the one recorded in the sdata structure. */
2230 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2232 #endif /* GC_CHECK_STRING_BYTES */
2234 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2235 eassert (nbytes
<= LARGE_STRING_BYTES
);
2237 nbytes
= SDATA_SIZE (nbytes
);
2238 sdata
*from_end
= (sdata
*) ((char *) from
2239 + nbytes
+ GC_STRING_EXTRA
);
2241 #ifdef GC_CHECK_STRING_OVERRUN
2242 if (memcmp (string_overrun_cookie
,
2243 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2244 GC_STRING_OVERRUN_COOKIE_SIZE
))
2248 /* Non-NULL S means it's alive. Copy its data. */
2251 /* If TB is full, proceed with the next sblock. */
2252 sdata
*to_end
= (sdata
*) ((char *) to
2253 + nbytes
+ GC_STRING_EXTRA
);
2254 if (to_end
> tb_end
)
2258 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2260 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2263 /* Copy, and update the string's `data' pointer. */
2266 eassert (tb
!= b
|| to
< from
);
2267 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2268 to
->string
->u
.s
.data
= SDATA_DATA (to
);
2271 /* Advance past the sdata we copied to. */
2280 /* The rest of the sblocks following TB don't contain live data, so
2281 we can free them. */
2282 for (b
= tb
->next
; b
; )
2284 struct sblock
*next
= b
->next
;
2293 current_sblock
= tb
;
2297 string_overflow (void)
2299 error ("Maximum string size exceeded");
2302 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2303 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2304 LENGTH must be an integer.
2305 INIT must be an integer that represents a character. */)
2306 (Lisp_Object length
, Lisp_Object init
)
2308 register Lisp_Object val
;
2312 CHECK_NATNUM (length
);
2313 CHECK_CHARACTER (init
);
2315 c
= XFASTINT (init
);
2316 if (ASCII_CHAR_P (c
))
2318 nbytes
= XINT (length
);
2319 val
= make_uninit_string (nbytes
);
2322 memset (SDATA (val
), c
, nbytes
);
2323 SDATA (val
)[nbytes
] = 0;
2328 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2329 ptrdiff_t len
= CHAR_STRING (c
, str
);
2330 EMACS_INT string_len
= XINT (length
);
2331 unsigned char *p
, *beg
, *end
;
2333 if (INT_MULTIPLY_WRAPV (len
, string_len
, &nbytes
))
2335 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2336 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2338 /* First time we just copy `str' to the data of `val'. */
2340 memcpy (p
, str
, len
);
2343 /* Next time we copy largest possible chunk from
2344 initialized to uninitialized part of `val'. */
2345 len
= min (p
- beg
, end
- p
);
2346 memcpy (p
, beg
, len
);
2356 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2360 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2362 EMACS_INT nbits
= bool_vector_size (a
);
2365 unsigned char *data
= bool_vector_uchar_data (a
);
2366 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2367 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2368 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2369 memset (data
, pattern
, nbytes
- 1);
2370 data
[nbytes
- 1] = pattern
& last_mask
;
2375 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2378 make_uninit_bool_vector (EMACS_INT nbits
)
2381 EMACS_INT words
= bool_vector_words (nbits
);
2382 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2383 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2386 struct Lisp_Bool_Vector
*p
2387 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2388 XSETVECTOR (val
, p
);
2389 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2392 /* Clear padding at the end. */
2394 p
->data
[words
- 1] = 0;
2399 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2400 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2401 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2402 (Lisp_Object length
, Lisp_Object init
)
2406 CHECK_NATNUM (length
);
2407 val
= make_uninit_bool_vector (XFASTINT (length
));
2408 return bool_vector_fill (val
, init
);
2411 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2412 doc
: /* Return a new bool-vector with specified arguments as elements.
2413 Any number of arguments, even zero arguments, are allowed.
2414 usage: (bool-vector &rest OBJECTS) */)
2415 (ptrdiff_t nargs
, Lisp_Object
*args
)
2420 vector
= make_uninit_bool_vector (nargs
);
2421 for (i
= 0; i
< nargs
; i
++)
2422 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2427 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2428 of characters from the contents. This string may be unibyte or
2429 multibyte, depending on the contents. */
2432 make_string (const char *contents
, ptrdiff_t nbytes
)
2434 register Lisp_Object val
;
2435 ptrdiff_t nchars
, multibyte_nbytes
;
2437 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2438 &nchars
, &multibyte_nbytes
);
2439 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2440 /* CONTENTS contains no multibyte sequences or contains an invalid
2441 multibyte sequence. We must make unibyte string. */
2442 val
= make_unibyte_string (contents
, nbytes
);
2444 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2448 /* Make a unibyte string from LENGTH bytes at CONTENTS. */
2451 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2453 register Lisp_Object val
;
2454 val
= make_uninit_string (length
);
2455 memcpy (SDATA (val
), contents
, length
);
2460 /* Make a multibyte string from NCHARS characters occupying NBYTES
2461 bytes at CONTENTS. */
2464 make_multibyte_string (const char *contents
,
2465 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2467 register Lisp_Object val
;
2468 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2469 memcpy (SDATA (val
), contents
, nbytes
);
2474 /* Make a string from NCHARS characters occupying NBYTES bytes at
2475 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2478 make_string_from_bytes (const char *contents
,
2479 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2481 register Lisp_Object val
;
2482 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2483 memcpy (SDATA (val
), contents
, nbytes
);
2484 if (SBYTES (val
) == SCHARS (val
))
2485 STRING_SET_UNIBYTE (val
);
2490 /* Make a string from NCHARS characters occupying NBYTES bytes at
2491 CONTENTS. The argument MULTIBYTE controls whether to label the
2492 string as multibyte. If NCHARS is negative, it counts the number of
2493 characters by itself. */
2496 make_specified_string (const char *contents
,
2497 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2504 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2509 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2510 memcpy (SDATA (val
), contents
, nbytes
);
2512 STRING_SET_UNIBYTE (val
);
2517 /* Return a unibyte Lisp_String set up to hold LENGTH characters
2518 occupying LENGTH bytes. */
2521 make_uninit_string (EMACS_INT length
)
2526 return empty_unibyte_string
;
2527 val
= make_uninit_multibyte_string (length
, length
);
2528 STRING_SET_UNIBYTE (val
);
2533 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2534 which occupy NBYTES bytes. */
2537 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2540 struct Lisp_String
*s
;
2545 return empty_multibyte_string
;
2547 s
= allocate_string ();
2548 s
->u
.s
.intervals
= NULL
;
2549 allocate_string_data (s
, nchars
, nbytes
);
2550 XSETSTRING (string
, s
);
2551 string_chars_consed
+= nbytes
;
2555 /* Print arguments to BUF according to a FORMAT, then return
2556 a Lisp_String initialized with the data from BUF. */
2559 make_formatted_string (char *buf
, const char *format
, ...)
2564 va_start (ap
, format
);
2565 length
= vsprintf (buf
, format
, ap
);
2567 return make_string (buf
, length
);
2571 /***********************************************************************
2573 ***********************************************************************/
2575 /* We store float cells inside of float_blocks, allocating a new
2576 float_block with malloc whenever necessary. Float cells reclaimed
2577 by GC are put on a free list to be reallocated before allocating
2578 any new float cells from the latest float_block. */
2580 #define FLOAT_BLOCK_SIZE \
2581 (((BLOCK_BYTES - sizeof (struct float_block *) \
2582 /* The compiler might add padding at the end. */ \
2583 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2584 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2586 #define GETMARKBIT(block,n) \
2587 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2588 >> ((n) % BITS_PER_BITS_WORD)) \
2591 #define SETMARKBIT(block,n) \
2592 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2593 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2595 #define UNSETMARKBIT(block,n) \
2596 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2597 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2599 #define FLOAT_BLOCK(fptr) \
2600 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2602 #define FLOAT_INDEX(fptr) \
2603 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2607 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2608 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2609 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2610 struct float_block
*next
;
2613 #define FLOAT_MARKED_P(fptr) \
2614 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2616 #define FLOAT_MARK(fptr) \
2617 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2619 #define FLOAT_UNMARK(fptr) \
2620 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2622 /* Current float_block. */
2624 static struct float_block
*float_block
;
2626 /* Index of first unused Lisp_Float in the current float_block. */
2628 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2630 /* Free-list of Lisp_Floats. */
2632 static struct Lisp_Float
*float_free_list
;
2634 /* Return a new float object with value FLOAT_VALUE. */
2637 make_float (double float_value
)
2639 register Lisp_Object val
;
2643 if (float_free_list
)
2645 /* We use the data field for chaining the free list
2646 so that we won't use the same field that has the mark bit. */
2647 XSETFLOAT (val
, float_free_list
);
2648 float_free_list
= float_free_list
->u
.chain
;
2652 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2654 struct float_block
*new
2655 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2656 new->next
= float_block
;
2657 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2659 float_block_index
= 0;
2660 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2662 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2663 float_block_index
++;
2666 MALLOC_UNBLOCK_INPUT
;
2668 XFLOAT_INIT (val
, float_value
);
2669 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2670 consing_since_gc
+= sizeof (struct Lisp_Float
);
2672 total_free_floats
--;
2678 /***********************************************************************
2680 ***********************************************************************/
2682 /* We store cons cells inside of cons_blocks, allocating a new
2683 cons_block with malloc whenever necessary. Cons cells reclaimed by
2684 GC are put on a free list to be reallocated before allocating
2685 any new cons cells from the latest cons_block. */
2687 #define CONS_BLOCK_SIZE \
2688 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2689 /* The compiler might add padding at the end. */ \
2690 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2691 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2693 #define CONS_BLOCK(fptr) \
2694 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2696 #define CONS_INDEX(fptr) \
2697 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2701 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2702 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2703 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2704 struct cons_block
*next
;
2707 #define CONS_MARKED_P(fptr) \
2708 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2710 #define CONS_MARK(fptr) \
2711 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2713 #define CONS_UNMARK(fptr) \
2714 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2716 /* Current cons_block. */
2718 static struct cons_block
*cons_block
;
2720 /* Index of first unused Lisp_Cons in the current block. */
2722 static int cons_block_index
= CONS_BLOCK_SIZE
;
2724 /* Free-list of Lisp_Cons structures. */
2726 static struct Lisp_Cons
*cons_free_list
;
2728 /* Explicitly free a cons cell by putting it on the free-list. */
2731 free_cons (struct Lisp_Cons
*ptr
)
2733 ptr
->u
.s
.u
.chain
= cons_free_list
;
2734 ptr
->u
.s
.car
= Vdead
;
2735 cons_free_list
= ptr
;
2736 consing_since_gc
-= sizeof *ptr
;
2737 total_free_conses
++;
2740 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2741 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2742 (Lisp_Object car
, Lisp_Object cdr
)
2744 register Lisp_Object val
;
2750 /* We use the cdr for chaining the free list
2751 so that we won't use the same field that has the mark bit. */
2752 XSETCONS (val
, cons_free_list
);
2753 cons_free_list
= cons_free_list
->u
.s
.u
.chain
;
2757 if (cons_block_index
== CONS_BLOCK_SIZE
)
2759 struct cons_block
*new
2760 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2761 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2762 new->next
= cons_block
;
2764 cons_block_index
= 0;
2765 total_free_conses
+= CONS_BLOCK_SIZE
;
2767 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2771 MALLOC_UNBLOCK_INPUT
;
2775 eassert (!CONS_MARKED_P (XCONS (val
)));
2776 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2777 total_free_conses
--;
2778 cons_cells_consed
++;
2782 #ifdef GC_CHECK_CONS_LIST
2783 /* Get an error now if there's any junk in the cons free list. */
2785 check_cons_list (void)
2787 struct Lisp_Cons
*tail
= cons_free_list
;
2790 tail
= tail
->u
.s
.u
.chain
;
2794 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2797 list1 (Lisp_Object arg1
)
2799 return Fcons (arg1
, Qnil
);
2803 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2805 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2810 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2812 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2817 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2819 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2824 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2826 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2827 Fcons (arg5
, Qnil
)))));
2830 /* Make a list of COUNT Lisp_Objects, where ARG is the
2831 first one. Allocate conses from pure space if TYPE
2832 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2835 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2837 Lisp_Object (*cons
) (Lisp_Object
, Lisp_Object
);
2840 case CONSTYPE_PURE
: cons
= pure_cons
; break;
2841 case CONSTYPE_HEAP
: cons
= Fcons
; break;
2842 default: emacs_abort ();
2845 eassume (0 < count
);
2846 Lisp_Object val
= cons (arg
, Qnil
);
2847 Lisp_Object tail
= val
;
2851 for (ptrdiff_t i
= 1; i
< count
; i
++)
2853 Lisp_Object elem
= cons (va_arg (ap
, Lisp_Object
), Qnil
);
2854 XSETCDR (tail
, elem
);
2862 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2863 doc
: /* Return a newly created list with specified arguments as elements.
2864 Any number of arguments, even zero arguments, are allowed.
2865 usage: (list &rest OBJECTS) */)
2866 (ptrdiff_t nargs
, Lisp_Object
*args
)
2868 register Lisp_Object val
;
2874 val
= Fcons (args
[nargs
], val
);
2880 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2881 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2882 (Lisp_Object length
, Lisp_Object init
)
2884 Lisp_Object val
= Qnil
;
2885 CHECK_NATNUM (length
);
2887 for (EMACS_INT size
= XFASTINT (length
); 0 < size
; size
--)
2889 val
= Fcons (init
, val
);
2898 /***********************************************************************
2900 ***********************************************************************/
2902 /* Sometimes a vector's contents are merely a pointer internally used
2903 in vector allocation code. On the rare platforms where a null
2904 pointer cannot be tagged, represent it with a Lisp 0.
2905 Usually you don't want to touch this. */
2907 static struct Lisp_Vector
*
2908 next_vector (struct Lisp_Vector
*v
)
2910 return XUNTAG (v
->contents
[0], Lisp_Int0
);
2914 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2916 v
->contents
[0] = make_lisp_ptr (p
, Lisp_Int0
);
2919 /* This value is balanced well enough to avoid too much internal overhead
2920 for the most common cases; it's not required to be a power of two, but
2921 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2923 #define VECTOR_BLOCK_SIZE 4096
2925 /* Alignment of struct Lisp_Vector objects. Because pseudovectors
2926 can contain any C type, align at least as strictly as
2927 max_align_t. On x86 and x86-64 this can waste up to 8 bytes
2928 for typical vectors, since alignof (max_align_t) is 16 but
2929 typical vectors need only an alignment of 8. However, it is
2930 not worth the hassle to avoid wasting those bytes. */
2931 enum {vector_alignment
= COMMON_MULTIPLE (alignof (max_align_t
), GCALIGNMENT
)};
2933 /* Vector size requests are a multiple of this. */
2934 enum { roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
) };
2936 /* Verify assumptions described above. */
2937 verify (VECTOR_BLOCK_SIZE
% roundup_size
== 0);
2938 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2940 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2941 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2942 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2943 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2945 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2947 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2949 /* Size of the minimal vector allocated from block. */
2951 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2953 /* Size of the largest vector allocated from block. */
2955 #define VBLOCK_BYTES_MAX \
2956 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2958 /* We maintain one free list for each possible block-allocated
2959 vector size, and this is the number of free lists we have. */
2961 #define VECTOR_MAX_FREE_LIST_INDEX \
2962 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2964 /* Common shortcut to advance vector pointer over a block data. */
2966 static struct Lisp_Vector
*
2967 ADVANCE (struct Lisp_Vector
*v
, ptrdiff_t nbytes
)
2971 void *p
= cv
+ nbytes
;
2975 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2978 VINDEX (ptrdiff_t nbytes
)
2980 eassume (VBLOCK_BYTES_MIN
<= nbytes
);
2981 return (nbytes
- VBLOCK_BYTES_MIN
) / roundup_size
;
2984 /* This internal type is used to maintain the list of large vectors
2985 which are allocated at their own, e.g. outside of vector blocks.
2987 struct large_vector itself cannot contain a struct Lisp_Vector, as
2988 the latter contains a flexible array member and C99 does not allow
2989 such structs to be nested. Instead, each struct large_vector
2990 object LV is followed by a struct Lisp_Vector, which is at offset
2991 large_vector_offset from LV, and whose address is therefore
2992 large_vector_vec (&LV). */
2996 struct large_vector
*next
;
3001 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
3004 static struct Lisp_Vector
*
3005 large_vector_vec (struct large_vector
*p
)
3007 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
3010 /* This internal type is used to maintain an underlying storage
3011 for small vectors. */
3015 char data
[VECTOR_BLOCK_BYTES
];
3016 struct vector_block
*next
;
3019 /* Chain of vector blocks. */
3021 static struct vector_block
*vector_blocks
;
3023 /* Vector free lists, where NTH item points to a chain of free
3024 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
3026 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
3028 /* Singly-linked list of large vectors. */
3030 static struct large_vector
*large_vectors
;
3032 /* The only vector with 0 slots, allocated from pure space. */
3034 Lisp_Object zero_vector
;
3036 /* Number of live vectors. */
3038 static EMACS_INT total_vectors
;
3040 /* Total size of live and free vectors, in Lisp_Object units. */
3042 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
3044 /* Common shortcut to setup vector on a free list. */
3047 setup_on_free_list (struct Lisp_Vector
*v
, ptrdiff_t nbytes
)
3049 eassume (header_size
<= nbytes
);
3050 ptrdiff_t nwords
= (nbytes
- header_size
) / word_size
;
3051 XSETPVECTYPESIZE (v
, PVEC_FREE
, 0, nwords
);
3052 eassert (nbytes
% roundup_size
== 0);
3053 ptrdiff_t vindex
= VINDEX (nbytes
);
3054 eassert (vindex
< VECTOR_MAX_FREE_LIST_INDEX
);
3055 set_next_vector (v
, vector_free_lists
[vindex
]);
3056 vector_free_lists
[vindex
] = v
;
3057 total_free_vector_slots
+= nbytes
/ word_size
;
3060 /* Get a new vector block. */
3062 static struct vector_block
*
3063 allocate_vector_block (void)
3065 struct vector_block
*block
= xmalloc (sizeof *block
);
3067 #ifndef GC_MALLOC_CHECK
3068 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
3069 MEM_TYPE_VECTOR_BLOCK
);
3072 block
->next
= vector_blocks
;
3073 vector_blocks
= block
;
3077 /* Called once to initialize vector allocation. */
3082 zero_vector
= make_pure_vector (0);
3085 /* Allocate vector from a vector block. */
3087 static struct Lisp_Vector
*
3088 allocate_vector_from_block (size_t nbytes
)
3090 struct Lisp_Vector
*vector
;
3091 struct vector_block
*block
;
3092 size_t index
, restbytes
;
3094 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
3095 eassert (nbytes
% roundup_size
== 0);
3097 /* First, try to allocate from a free list
3098 containing vectors of the requested size. */
3099 index
= VINDEX (nbytes
);
3100 if (vector_free_lists
[index
])
3102 vector
= vector_free_lists
[index
];
3103 vector_free_lists
[index
] = next_vector (vector
);
3104 total_free_vector_slots
-= nbytes
/ word_size
;
3108 /* Next, check free lists containing larger vectors. Since
3109 we will split the result, we should have remaining space
3110 large enough to use for one-slot vector at least. */
3111 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3112 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3113 if (vector_free_lists
[index
])
3115 /* This vector is larger than requested. */
3116 vector
= vector_free_lists
[index
];
3117 vector_free_lists
[index
] = next_vector (vector
);
3118 total_free_vector_slots
-= nbytes
/ word_size
;
3120 /* Excess bytes are used for the smaller vector,
3121 which should be set on an appropriate free list. */
3122 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3123 eassert (restbytes
% roundup_size
== 0);
3124 setup_on_free_list (ADVANCE (vector
, nbytes
), restbytes
);
3128 /* Finally, need a new vector block. */
3129 block
= allocate_vector_block ();
3131 /* New vector will be at the beginning of this block. */
3132 vector
= (struct Lisp_Vector
*) block
->data
;
3134 /* If the rest of space from this block is large enough
3135 for one-slot vector at least, set up it on a free list. */
3136 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3137 if (restbytes
>= VBLOCK_BYTES_MIN
)
3139 eassert (restbytes
% roundup_size
== 0);
3140 setup_on_free_list (ADVANCE (vector
, nbytes
), restbytes
);
3145 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3147 #define VECTOR_IN_BLOCK(vector, block) \
3148 ((char *) (vector) <= (block)->data \
3149 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3151 /* Return the memory footprint of V in bytes. */
3154 vector_nbytes (struct Lisp_Vector
*v
)
3156 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
3159 if (size
& PSEUDOVECTOR_FLAG
)
3161 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
3163 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
3164 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
3165 * sizeof (bits_word
));
3166 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
3167 verify (header_size
<= bool_header_size
);
3168 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
3171 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
3172 + ((size
& PSEUDOVECTOR_REST_MASK
)
3173 >> PSEUDOVECTOR_SIZE_BITS
));
3177 return vroundup (header_size
+ word_size
* nwords
);
3180 /* Release extra resources still in use by VECTOR, which may be any
3181 vector-like object. */
3184 cleanup_vector (struct Lisp_Vector
*vector
)
3186 detect_suspicious_free (vector
);
3187 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
3188 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
3189 == FONT_OBJECT_MAX
))
3191 struct font_driver
const *drv
= ((struct font
*) vector
)->driver
;
3193 /* The font driver might sometimes be NULL, e.g. if Emacs was
3194 interrupted before it had time to set it up. */
3197 /* Attempt to catch subtle bugs like Bug#16140. */
3198 eassert (valid_font_driver (drv
));
3199 drv
->close ((struct font
*) vector
);
3203 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_THREAD
))
3204 finalize_one_thread ((struct thread_state
*) vector
);
3205 else if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_MUTEX
))
3206 finalize_one_mutex ((struct Lisp_Mutex
*) vector
);
3207 else if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_CONDVAR
))
3208 finalize_one_condvar ((struct Lisp_CondVar
*) vector
);
3211 /* Reclaim space used by unmarked vectors. */
3213 NO_INLINE
/* For better stack traces */
3215 sweep_vectors (void)
3217 struct vector_block
*block
, **bprev
= &vector_blocks
;
3218 struct large_vector
*lv
, **lvprev
= &large_vectors
;
3219 struct Lisp_Vector
*vector
, *next
;
3221 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3222 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3224 /* Looking through vector blocks. */
3226 for (block
= vector_blocks
; block
; block
= *bprev
)
3228 bool free_this_block
= 0;
3231 for (vector
= (struct Lisp_Vector
*) block
->data
;
3232 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3234 if (VECTOR_MARKED_P (vector
))
3236 VECTOR_UNMARK (vector
);
3238 nbytes
= vector_nbytes (vector
);
3239 total_vector_slots
+= nbytes
/ word_size
;
3240 next
= ADVANCE (vector
, nbytes
);
3244 ptrdiff_t total_bytes
;
3246 cleanup_vector (vector
);
3247 nbytes
= vector_nbytes (vector
);
3248 total_bytes
= nbytes
;
3249 next
= ADVANCE (vector
, nbytes
);
3251 /* While NEXT is not marked, try to coalesce with VECTOR,
3252 thus making VECTOR of the largest possible size. */
3254 while (VECTOR_IN_BLOCK (next
, block
))
3256 if (VECTOR_MARKED_P (next
))
3258 cleanup_vector (next
);
3259 nbytes
= vector_nbytes (next
);
3260 total_bytes
+= nbytes
;
3261 next
= ADVANCE (next
, nbytes
);
3264 eassert (total_bytes
% roundup_size
== 0);
3266 if (vector
== (struct Lisp_Vector
*) block
->data
3267 && !VECTOR_IN_BLOCK (next
, block
))
3268 /* This block should be freed because all of its
3269 space was coalesced into the only free vector. */
3270 free_this_block
= 1;
3272 setup_on_free_list (vector
, total_bytes
);
3276 if (free_this_block
)
3278 *bprev
= block
->next
;
3279 #ifndef GC_MALLOC_CHECK
3280 mem_delete (mem_find (block
->data
));
3285 bprev
= &block
->next
;
3288 /* Sweep large vectors. */
3290 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
3292 vector
= large_vector_vec (lv
);
3293 if (VECTOR_MARKED_P (vector
))
3295 VECTOR_UNMARK (vector
);
3297 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3298 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3301 += header_size
/ word_size
+ vector
->header
.size
;
3312 /* Value is a pointer to a newly allocated Lisp_Vector structure
3313 with room for LEN Lisp_Objects. */
3315 static struct Lisp_Vector
*
3316 allocate_vectorlike (ptrdiff_t len
)
3318 struct Lisp_Vector
*p
;
3323 p
= XVECTOR (zero_vector
);
3326 size_t nbytes
= header_size
+ len
* word_size
;
3328 #ifdef DOUG_LEA_MALLOC
3329 if (!mmap_lisp_allowed_p ())
3330 mallopt (M_MMAP_MAX
, 0);
3333 if (nbytes
<= VBLOCK_BYTES_MAX
)
3334 p
= allocate_vector_from_block (vroundup (nbytes
));
3337 struct large_vector
*lv
3338 = lisp_malloc ((large_vector_offset
+ header_size
3340 MEM_TYPE_VECTORLIKE
);
3341 lv
->next
= large_vectors
;
3343 p
= large_vector_vec (lv
);
3346 #ifdef DOUG_LEA_MALLOC
3347 if (!mmap_lisp_allowed_p ())
3348 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3351 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3354 consing_since_gc
+= nbytes
;
3355 vector_cells_consed
+= len
;
3358 MALLOC_UNBLOCK_INPUT
;
3364 /* Allocate a vector with LEN slots. */
3366 struct Lisp_Vector
*
3367 allocate_vector (EMACS_INT len
)
3369 struct Lisp_Vector
*v
;
3370 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3372 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3373 memory_full (SIZE_MAX
);
3374 v
= allocate_vectorlike (len
);
3376 v
->header
.size
= len
;
3381 /* Allocate other vector-like structures. */
3383 struct Lisp_Vector
*
3384 allocate_pseudovector (int memlen
, int lisplen
,
3385 int zerolen
, enum pvec_type tag
)
3387 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3389 /* Catch bogus values. */
3390 eassert (0 <= tag
&& tag
<= PVEC_FONT
);
3391 eassert (0 <= lisplen
&& lisplen
<= zerolen
&& zerolen
<= memlen
);
3392 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3393 eassert (lisplen
<= PSEUDOVECTOR_SIZE_MASK
);
3395 /* Only the first LISPLEN slots will be traced normally by the GC. */
3396 memclear (v
->contents
, zerolen
* word_size
);
3397 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3402 allocate_buffer (void)
3404 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3406 BUFFER_PVEC_INIT (b
);
3407 /* Put B on the chain of all buffers including killed ones. */
3408 b
->next
= all_buffers
;
3410 /* Note that the rest fields of B are not initialized. */
3415 /* Allocate a record with COUNT slots. COUNT must be positive, and
3416 includes the type slot. */
3418 static struct Lisp_Vector
*
3419 allocate_record (EMACS_INT count
)
3421 if (count
> PSEUDOVECTOR_SIZE_MASK
)
3422 error ("Attempt to allocate a record of %"pI
"d slots; max is %d",
3423 count
, PSEUDOVECTOR_SIZE_MASK
);
3424 struct Lisp_Vector
*p
= allocate_vectorlike (count
);
3425 p
->header
.size
= count
;
3426 XSETPVECTYPE (p
, PVEC_RECORD
);
3431 DEFUN ("make-record", Fmake_record
, Smake_record
, 3, 3, 0,
3432 doc
: /* Create a new record.
3433 TYPE is its type as returned by `type-of'; it should be either a
3434 symbol or a type descriptor. SLOTS is the number of non-type slots,
3435 each initialized to INIT. */)
3436 (Lisp_Object type
, Lisp_Object slots
, Lisp_Object init
)
3438 CHECK_NATNUM (slots
);
3439 EMACS_INT size
= XFASTINT (slots
) + 1;
3440 struct Lisp_Vector
*p
= allocate_record (size
);
3441 p
->contents
[0] = type
;
3442 for (ptrdiff_t i
= 1; i
< size
; i
++)
3443 p
->contents
[i
] = init
;
3444 return make_lisp_ptr (p
, Lisp_Vectorlike
);
3448 DEFUN ("record", Frecord
, Srecord
, 1, MANY
, 0,
3449 doc
: /* Create a new record.
3450 TYPE is its type as returned by `type-of'; it should be either a
3451 symbol or a type descriptor. SLOTS is used to initialize the record
3452 slots with shallow copies of the arguments.
3453 usage: (record TYPE &rest SLOTS) */)
3454 (ptrdiff_t nargs
, Lisp_Object
*args
)
3456 struct Lisp_Vector
*p
= allocate_record (nargs
);
3457 memcpy (p
->contents
, args
, nargs
* sizeof *args
);
3458 return make_lisp_ptr (p
, Lisp_Vectorlike
);
3462 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3463 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3464 See also the function `vector'. */)
3465 (Lisp_Object length
, Lisp_Object init
)
3467 CHECK_NATNUM (length
);
3468 struct Lisp_Vector
*p
= allocate_vector (XFASTINT (length
));
3469 for (ptrdiff_t i
= 0; i
< XFASTINT (length
); i
++)
3470 p
->contents
[i
] = init
;
3471 return make_lisp_ptr (p
, Lisp_Vectorlike
);
3474 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3475 doc
: /* Return a newly created vector with specified arguments as elements.
3476 Any number of arguments, even zero arguments, are allowed.
3477 usage: (vector &rest OBJECTS) */)
3478 (ptrdiff_t nargs
, Lisp_Object
*args
)
3480 Lisp_Object val
= make_uninit_vector (nargs
);
3481 struct Lisp_Vector
*p
= XVECTOR (val
);
3482 memcpy (p
->contents
, args
, nargs
* sizeof *args
);
3487 make_byte_code (struct Lisp_Vector
*v
)
3489 /* Don't allow the global zero_vector to become a byte code object. */
3490 eassert (0 < v
->header
.size
);
3492 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3493 && STRING_MULTIBYTE (v
->contents
[1]))
3494 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3495 earlier because they produced a raw 8-bit string for byte-code
3496 and now such a byte-code string is loaded as multibyte while
3497 raw 8-bit characters converted to multibyte form. Thus, now we
3498 must convert them back to the original unibyte form. */
3499 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3500 XSETPVECTYPE (v
, PVEC_COMPILED
);
3503 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3504 doc
: /* Create a byte-code object with specified arguments as elements.
3505 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3506 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3507 and (optional) INTERACTIVE-SPEC.
3508 The first four arguments are required; at most six have any
3510 The ARGLIST can be either like the one of `lambda', in which case the arguments
3511 will be dynamically bound before executing the byte code, or it can be an
3512 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3513 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3514 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3515 argument to catch the left-over arguments. If such an integer is used, the
3516 arguments will not be dynamically bound but will be instead pushed on the
3517 stack before executing the byte-code.
3518 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3519 (ptrdiff_t nargs
, Lisp_Object
*args
)
3521 Lisp_Object val
= make_uninit_vector (nargs
);
3522 struct Lisp_Vector
*p
= XVECTOR (val
);
3524 /* We used to purecopy everything here, if purify-flag was set. This worked
3525 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3526 dangerous, since make-byte-code is used during execution to build
3527 closures, so any closure built during the preload phase would end up
3528 copied into pure space, including its free variables, which is sometimes
3529 just wasteful and other times plainly wrong (e.g. those free vars may want
3532 memcpy (p
->contents
, args
, nargs
* sizeof *args
);
3534 XSETCOMPILED (val
, p
);
3540 /***********************************************************************
3542 ***********************************************************************/
3544 /* Each symbol_block is just under 1020 bytes long, since malloc
3545 really allocates in units of powers of two and uses 4 bytes for its
3548 #define SYMBOL_BLOCK_SIZE \
3549 ((1020 - sizeof (struct symbol_block *)) / sizeof (struct Lisp_Symbol))
3553 /* Place `symbols' first, to preserve alignment. */
3554 struct Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3555 struct symbol_block
*next
;
3558 /* Current symbol block and index of first unused Lisp_Symbol
3561 static struct symbol_block
*symbol_block
;
3562 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3563 /* Pointer to the first symbol_block that contains pinned symbols.
3564 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3565 10K of which are pinned (and all but 250 of them are interned in obarray),
3566 whereas a "typical session" has in the order of 30K symbols.
3567 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3568 than 30K to find the 10K symbols we need to mark. */
3569 static struct symbol_block
*symbol_block_pinned
;
3571 /* List of free symbols. */
3573 static struct Lisp_Symbol
*symbol_free_list
;
3576 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3578 XSYMBOL (sym
)->u
.s
.name
= name
;
3582 init_symbol (Lisp_Object val
, Lisp_Object name
)
3584 struct Lisp_Symbol
*p
= XSYMBOL (val
);
3585 set_symbol_name (val
, name
);
3586 set_symbol_plist (val
, Qnil
);
3587 p
->u
.s
.redirect
= SYMBOL_PLAINVAL
;
3588 SET_SYMBOL_VAL (p
, Qunbound
);
3589 set_symbol_function (val
, Qnil
);
3590 set_symbol_next (val
, NULL
);
3591 p
->u
.s
.gcmarkbit
= false;
3592 p
->u
.s
.interned
= SYMBOL_UNINTERNED
;
3593 p
->u
.s
.trapped_write
= SYMBOL_UNTRAPPED_WRITE
;
3594 p
->u
.s
.declared_special
= false;
3595 p
->u
.s
.pinned
= false;
3598 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3599 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3600 Its value is void, and its function definition and property list are nil. */)
3605 CHECK_STRING (name
);
3609 if (symbol_free_list
)
3611 XSETSYMBOL (val
, symbol_free_list
);
3612 symbol_free_list
= symbol_free_list
->u
.s
.next
;
3616 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3618 struct symbol_block
*new
3619 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3620 new->next
= symbol_block
;
3622 symbol_block_index
= 0;
3623 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3625 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
]);
3626 symbol_block_index
++;
3629 MALLOC_UNBLOCK_INPUT
;
3631 init_symbol (val
, name
);
3632 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3634 total_free_symbols
--;
3640 /***********************************************************************
3641 Marker (Misc) Allocation
3642 ***********************************************************************/
3644 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3645 the required alignment. */
3647 union aligned_Lisp_Misc
3650 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3654 /* Allocation of markers and other objects that share that structure.
3655 Works like allocation of conses. */
3657 #define MARKER_BLOCK_SIZE \
3658 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3662 /* Place `markers' first, to preserve alignment. */
3663 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3664 struct marker_block
*next
;
3667 static struct marker_block
*marker_block
;
3668 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3670 static union Lisp_Misc
*marker_free_list
;
3672 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3675 allocate_misc (enum Lisp_Misc_Type type
)
3681 if (marker_free_list
)
3683 XSETMISC (val
, marker_free_list
);
3684 marker_free_list
= marker_free_list
->u_free
.chain
;
3688 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3690 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3691 new->next
= marker_block
;
3693 marker_block_index
= 0;
3694 total_free_markers
+= MARKER_BLOCK_SIZE
;
3696 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3697 marker_block_index
++;
3700 MALLOC_UNBLOCK_INPUT
;
3702 --total_free_markers
;
3703 consing_since_gc
+= sizeof (union Lisp_Misc
);
3704 misc_objects_consed
++;
3705 XMISCANY (val
)->type
= type
;
3706 XMISCANY (val
)->gcmarkbit
= 0;
3710 /* Free a Lisp_Misc object. */
3713 free_misc (Lisp_Object misc
)
3715 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3716 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3717 marker_free_list
= XMISC (misc
);
3718 consing_since_gc
-= sizeof (union Lisp_Misc
);
3719 total_free_markers
++;
3722 /* Verify properties of Lisp_Save_Value's representation
3723 that are assumed here and elsewhere. */
3725 verify (SAVE_UNUSED
== 0);
3726 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3730 /* Return Lisp_Save_Value objects for the various combinations
3731 that callers need. */
3734 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3736 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3737 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3738 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3739 p
->data
[0].integer
= a
;
3740 p
->data
[1].integer
= b
;
3741 p
->data
[2].integer
= c
;
3746 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3749 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3750 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3751 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3752 p
->data
[0].object
= a
;
3753 p
->data
[1].object
= b
;
3754 p
->data
[2].object
= c
;
3755 p
->data
[3].object
= d
;
3760 make_save_ptr (void *a
)
3762 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3763 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3764 p
->save_type
= SAVE_POINTER
;
3765 p
->data
[0].pointer
= a
;
3770 make_save_ptr_int (void *a
, ptrdiff_t b
)
3772 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3773 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3774 p
->save_type
= SAVE_TYPE_PTR_INT
;
3775 p
->data
[0].pointer
= a
;
3776 p
->data
[1].integer
= b
;
3781 make_save_ptr_ptr (void *a
, void *b
)
3783 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3784 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3785 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3786 p
->data
[0].pointer
= a
;
3787 p
->data
[1].pointer
= b
;
3792 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3794 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3795 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3796 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3797 p
->data
[0].funcpointer
= a
;
3798 p
->data
[1].pointer
= b
;
3799 p
->data
[2].object
= c
;
3803 /* Return a Lisp_Save_Value object that represents an array A
3804 of N Lisp objects. */
3807 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3809 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3810 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3811 p
->save_type
= SAVE_TYPE_MEMORY
;
3812 p
->data
[0].pointer
= a
;
3813 p
->data
[1].integer
= n
;
3817 /* Free a Lisp_Save_Value object. Do not use this function
3818 if SAVE contains pointer other than returned by xmalloc. */
3821 free_save_value (Lisp_Object save
)
3823 xfree (XSAVE_POINTER (save
, 0));
3827 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3830 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3832 register Lisp_Object overlay
;
3834 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3835 OVERLAY_START (overlay
) = start
;
3836 OVERLAY_END (overlay
) = end
;
3837 set_overlay_plist (overlay
, plist
);
3838 XOVERLAY (overlay
)->next
= NULL
;
3842 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3843 doc
: /* Return a newly allocated marker which does not point at any place. */)
3846 register Lisp_Object val
;
3847 register struct Lisp_Marker
*p
;
3849 val
= allocate_misc (Lisp_Misc_Marker
);
3855 p
->insertion_type
= 0;
3856 p
->need_adjustment
= 0;
3860 /* Return a newly allocated marker which points into BUF
3861 at character position CHARPOS and byte position BYTEPOS. */
3864 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3867 struct Lisp_Marker
*m
;
3869 /* No dead buffers here. */
3870 eassert (BUFFER_LIVE_P (buf
));
3872 /* Every character is at least one byte. */
3873 eassert (charpos
<= bytepos
);
3875 obj
= allocate_misc (Lisp_Misc_Marker
);
3878 m
->charpos
= charpos
;
3879 m
->bytepos
= bytepos
;
3880 m
->insertion_type
= 0;
3881 m
->need_adjustment
= 0;
3882 m
->next
= BUF_MARKERS (buf
);
3883 BUF_MARKERS (buf
) = m
;
3887 /* Put MARKER back on the free list after using it temporarily. */
3890 free_marker (Lisp_Object marker
)
3892 unchain_marker (XMARKER (marker
));
3897 /* Return a newly created vector or string with specified arguments as
3898 elements. If all the arguments are characters that can fit
3899 in a string of events, make a string; otherwise, make a vector.
3901 Any number of arguments, even zero arguments, are allowed. */
3904 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3908 for (i
= 0; i
< nargs
; i
++)
3909 /* The things that fit in a string
3910 are characters that are in 0...127,
3911 after discarding the meta bit and all the bits above it. */
3912 if (!INTEGERP (args
[i
])
3913 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3914 return Fvector (nargs
, args
);
3916 /* Since the loop exited, we know that all the things in it are
3917 characters, so we can make a string. */
3921 result
= Fmake_string (make_number (nargs
), make_number (0));
3922 for (i
= 0; i
< nargs
; i
++)
3924 SSET (result
, i
, XINT (args
[i
]));
3925 /* Move the meta bit to the right place for a string char. */
3926 if (XINT (args
[i
]) & CHAR_META
)
3927 SSET (result
, i
, SREF (result
, i
) | 0x80);
3935 /* Create a new module user ptr object. */
3937 make_user_ptr (void (*finalizer
) (void *), void *p
)
3940 struct Lisp_User_Ptr
*uptr
;
3942 obj
= allocate_misc (Lisp_Misc_User_Ptr
);
3943 uptr
= XUSER_PTR (obj
);
3944 uptr
->finalizer
= finalizer
;
3951 init_finalizer_list (struct Lisp_Finalizer
*head
)
3953 head
->prev
= head
->next
= head
;
3956 /* Insert FINALIZER before ELEMENT. */
3959 finalizer_insert (struct Lisp_Finalizer
*element
,
3960 struct Lisp_Finalizer
*finalizer
)
3962 eassert (finalizer
->prev
== NULL
);
3963 eassert (finalizer
->next
== NULL
);
3964 finalizer
->next
= element
;
3965 finalizer
->prev
= element
->prev
;
3966 finalizer
->prev
->next
= finalizer
;
3967 element
->prev
= finalizer
;
3971 unchain_finalizer (struct Lisp_Finalizer
*finalizer
)
3973 if (finalizer
->prev
!= NULL
)
3975 eassert (finalizer
->next
!= NULL
);
3976 finalizer
->prev
->next
= finalizer
->next
;
3977 finalizer
->next
->prev
= finalizer
->prev
;
3978 finalizer
->prev
= finalizer
->next
= NULL
;
3983 mark_finalizer_list (struct Lisp_Finalizer
*head
)
3985 for (struct Lisp_Finalizer
*finalizer
= head
->next
;
3987 finalizer
= finalizer
->next
)
3989 finalizer
->base
.gcmarkbit
= true;
3990 mark_object (finalizer
->function
);
3994 /* Move doomed finalizers to list DEST from list SRC. A doomed
3995 finalizer is one that is not GC-reachable and whose
3996 finalizer->function is non-nil. */
3999 queue_doomed_finalizers (struct Lisp_Finalizer
*dest
,
4000 struct Lisp_Finalizer
*src
)
4002 struct Lisp_Finalizer
*finalizer
= src
->next
;
4003 while (finalizer
!= src
)
4005 struct Lisp_Finalizer
*next
= finalizer
->next
;
4006 if (!finalizer
->base
.gcmarkbit
&& !NILP (finalizer
->function
))
4008 unchain_finalizer (finalizer
);
4009 finalizer_insert (dest
, finalizer
);
4017 run_finalizer_handler (Lisp_Object args
)
4019 add_to_log ("finalizer failed: %S", args
);
4024 run_finalizer_function (Lisp_Object function
)
4026 ptrdiff_t count
= SPECPDL_INDEX ();
4028 specbind (Qinhibit_quit
, Qt
);
4029 internal_condition_case_1 (call0
, function
, Qt
, run_finalizer_handler
);
4030 unbind_to (count
, Qnil
);
4034 run_finalizers (struct Lisp_Finalizer
*finalizers
)
4036 struct Lisp_Finalizer
*finalizer
;
4037 Lisp_Object function
;
4039 while (finalizers
->next
!= finalizers
)
4041 finalizer
= finalizers
->next
;
4042 eassert (finalizer
->base
.type
== Lisp_Misc_Finalizer
);
4043 unchain_finalizer (finalizer
);
4044 function
= finalizer
->function
;
4045 if (!NILP (function
))
4047 finalizer
->function
= Qnil
;
4048 run_finalizer_function (function
);
4053 DEFUN ("make-finalizer", Fmake_finalizer
, Smake_finalizer
, 1, 1, 0,
4054 doc
: /* Make a finalizer that will run FUNCTION.
4055 FUNCTION will be called after garbage collection when the returned
4056 finalizer object becomes unreachable. If the finalizer object is
4057 reachable only through references from finalizer objects, it does not
4058 count as reachable for the purpose of deciding whether to run
4059 FUNCTION. FUNCTION will be run once per finalizer object. */)
4060 (Lisp_Object function
)
4062 Lisp_Object val
= allocate_misc (Lisp_Misc_Finalizer
);
4063 struct Lisp_Finalizer
*finalizer
= XFINALIZER (val
);
4064 finalizer
->function
= function
;
4065 finalizer
->prev
= finalizer
->next
= NULL
;
4066 finalizer_insert (&finalizers
, finalizer
);
4071 /************************************************************************
4072 Memory Full Handling
4073 ************************************************************************/
4076 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
4077 there may have been size_t overflow so that malloc was never
4078 called, or perhaps malloc was invoked successfully but the
4079 resulting pointer had problems fitting into a tagged EMACS_INT. In
4080 either case this counts as memory being full even though malloc did
4084 memory_full (size_t nbytes
)
4086 /* Do not go into hysterics merely because a large request failed. */
4087 bool enough_free_memory
= 0;
4088 if (SPARE_MEMORY
< nbytes
)
4093 p
= malloc (SPARE_MEMORY
);
4097 enough_free_memory
= 1;
4099 MALLOC_UNBLOCK_INPUT
;
4102 if (! enough_free_memory
)
4108 memory_full_cons_threshold
= sizeof (struct cons_block
);
4110 /* The first time we get here, free the spare memory. */
4111 for (i
= 0; i
< ARRAYELTS (spare_memory
); i
++)
4112 if (spare_memory
[i
])
4115 free (spare_memory
[i
]);
4116 else if (i
>= 1 && i
<= 4)
4117 lisp_align_free (spare_memory
[i
]);
4119 lisp_free (spare_memory
[i
]);
4120 spare_memory
[i
] = 0;
4124 /* This used to call error, but if we've run out of memory, we could
4125 get infinite recursion trying to build the string. */
4126 xsignal (Qnil
, Vmemory_signal_data
);
4129 /* If we released our reserve (due to running out of memory),
4130 and we have a fair amount free once again,
4131 try to set aside another reserve in case we run out once more.
4133 This is called when a relocatable block is freed in ralloc.c,
4134 and also directly from this file, in case we're not using ralloc.c. */
4137 refill_memory_reserve (void)
4139 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
4140 if (spare_memory
[0] == 0)
4141 spare_memory
[0] = malloc (SPARE_MEMORY
);
4142 if (spare_memory
[1] == 0)
4143 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
4145 if (spare_memory
[2] == 0)
4146 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
4148 if (spare_memory
[3] == 0)
4149 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
4151 if (spare_memory
[4] == 0)
4152 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
4154 if (spare_memory
[5] == 0)
4155 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
4157 if (spare_memory
[6] == 0)
4158 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
4160 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
4161 Vmemory_full
= Qnil
;
4165 /************************************************************************
4167 ************************************************************************/
4169 /* Conservative C stack marking requires a method to identify possibly
4170 live Lisp objects given a pointer value. We do this by keeping
4171 track of blocks of Lisp data that are allocated in a red-black tree
4172 (see also the comment of mem_node which is the type of nodes in
4173 that tree). Function lisp_malloc adds information for an allocated
4174 block to the red-black tree with calls to mem_insert, and function
4175 lisp_free removes it with mem_delete. Functions live_string_p etc
4176 call mem_find to lookup information about a given pointer in the
4177 tree, and use that to determine if the pointer points into a Lisp
4180 /* Initialize this part of alloc.c. */
4185 mem_z
.left
= mem_z
.right
= MEM_NIL
;
4186 mem_z
.parent
= NULL
;
4187 mem_z
.color
= MEM_BLACK
;
4188 mem_z
.start
= mem_z
.end
= NULL
;
4193 /* Value is a pointer to the mem_node containing START. Value is
4194 MEM_NIL if there is no node in the tree containing START. */
4196 static struct mem_node
*
4197 mem_find (void *start
)
4201 if (start
< min_heap_address
|| start
> max_heap_address
)
4204 /* Make the search always successful to speed up the loop below. */
4205 mem_z
.start
= start
;
4206 mem_z
.end
= (char *) start
+ 1;
4209 while (start
< p
->start
|| start
>= p
->end
)
4210 p
= start
< p
->start
? p
->left
: p
->right
;
4215 /* Insert a new node into the tree for a block of memory with start
4216 address START, end address END, and type TYPE. Value is a
4217 pointer to the node that was inserted. */
4219 static struct mem_node
*
4220 mem_insert (void *start
, void *end
, enum mem_type type
)
4222 struct mem_node
*c
, *parent
, *x
;
4224 if (min_heap_address
== NULL
|| start
< min_heap_address
)
4225 min_heap_address
= start
;
4226 if (max_heap_address
== NULL
|| end
> max_heap_address
)
4227 max_heap_address
= end
;
4229 /* See where in the tree a node for START belongs. In this
4230 particular application, it shouldn't happen that a node is already
4231 present. For debugging purposes, let's check that. */
4235 while (c
!= MEM_NIL
)
4238 c
= start
< c
->start
? c
->left
: c
->right
;
4241 /* Create a new node. */
4242 #ifdef GC_MALLOC_CHECK
4243 x
= malloc (sizeof *x
);
4247 x
= xmalloc (sizeof *x
);
4253 x
->left
= x
->right
= MEM_NIL
;
4256 /* Insert it as child of PARENT or install it as root. */
4259 if (start
< parent
->start
)
4267 /* Re-establish red-black tree properties. */
4268 mem_insert_fixup (x
);
4274 /* Re-establish the red-black properties of the tree, and thereby
4275 balance the tree, after node X has been inserted; X is always red. */
4278 mem_insert_fixup (struct mem_node
*x
)
4280 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
4282 /* X is red and its parent is red. This is a violation of
4283 red-black tree property #3. */
4285 if (x
->parent
== x
->parent
->parent
->left
)
4287 /* We're on the left side of our grandparent, and Y is our
4289 struct mem_node
*y
= x
->parent
->parent
->right
;
4291 if (y
->color
== MEM_RED
)
4293 /* Uncle and parent are red but should be black because
4294 X is red. Change the colors accordingly and proceed
4295 with the grandparent. */
4296 x
->parent
->color
= MEM_BLACK
;
4297 y
->color
= MEM_BLACK
;
4298 x
->parent
->parent
->color
= MEM_RED
;
4299 x
= x
->parent
->parent
;
4303 /* Parent and uncle have different colors; parent is
4304 red, uncle is black. */
4305 if (x
== x
->parent
->right
)
4308 mem_rotate_left (x
);
4311 x
->parent
->color
= MEM_BLACK
;
4312 x
->parent
->parent
->color
= MEM_RED
;
4313 mem_rotate_right (x
->parent
->parent
);
4318 /* This is the symmetrical case of above. */
4319 struct mem_node
*y
= x
->parent
->parent
->left
;
4321 if (y
->color
== MEM_RED
)
4323 x
->parent
->color
= MEM_BLACK
;
4324 y
->color
= MEM_BLACK
;
4325 x
->parent
->parent
->color
= MEM_RED
;
4326 x
= x
->parent
->parent
;
4330 if (x
== x
->parent
->left
)
4333 mem_rotate_right (x
);
4336 x
->parent
->color
= MEM_BLACK
;
4337 x
->parent
->parent
->color
= MEM_RED
;
4338 mem_rotate_left (x
->parent
->parent
);
4343 /* The root may have been changed to red due to the algorithm. Set
4344 it to black so that property #5 is satisfied. */
4345 mem_root
->color
= MEM_BLACK
;
4356 mem_rotate_left (struct mem_node
*x
)
4360 /* Turn y's left sub-tree into x's right sub-tree. */
4363 if (y
->left
!= MEM_NIL
)
4364 y
->left
->parent
= x
;
4366 /* Y's parent was x's parent. */
4368 y
->parent
= x
->parent
;
4370 /* Get the parent to point to y instead of x. */
4373 if (x
== x
->parent
->left
)
4374 x
->parent
->left
= y
;
4376 x
->parent
->right
= y
;
4381 /* Put x on y's left. */
4395 mem_rotate_right (struct mem_node
*x
)
4397 struct mem_node
*y
= x
->left
;
4400 if (y
->right
!= MEM_NIL
)
4401 y
->right
->parent
= x
;
4404 y
->parent
= x
->parent
;
4407 if (x
== x
->parent
->right
)
4408 x
->parent
->right
= y
;
4410 x
->parent
->left
= y
;
4421 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4424 mem_delete (struct mem_node
*z
)
4426 struct mem_node
*x
, *y
;
4428 if (!z
|| z
== MEM_NIL
)
4431 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4436 while (y
->left
!= MEM_NIL
)
4440 if (y
->left
!= MEM_NIL
)
4445 x
->parent
= y
->parent
;
4448 if (y
== y
->parent
->left
)
4449 y
->parent
->left
= x
;
4451 y
->parent
->right
= x
;
4458 z
->start
= y
->start
;
4463 if (y
->color
== MEM_BLACK
)
4464 mem_delete_fixup (x
);
4466 #ifdef GC_MALLOC_CHECK
4474 /* Re-establish the red-black properties of the tree, after a
4478 mem_delete_fixup (struct mem_node
*x
)
4480 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4482 if (x
== x
->parent
->left
)
4484 struct mem_node
*w
= x
->parent
->right
;
4486 if (w
->color
== MEM_RED
)
4488 w
->color
= MEM_BLACK
;
4489 x
->parent
->color
= MEM_RED
;
4490 mem_rotate_left (x
->parent
);
4491 w
= x
->parent
->right
;
4494 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4501 if (w
->right
->color
== MEM_BLACK
)
4503 w
->left
->color
= MEM_BLACK
;
4505 mem_rotate_right (w
);
4506 w
= x
->parent
->right
;
4508 w
->color
= x
->parent
->color
;
4509 x
->parent
->color
= MEM_BLACK
;
4510 w
->right
->color
= MEM_BLACK
;
4511 mem_rotate_left (x
->parent
);
4517 struct mem_node
*w
= x
->parent
->left
;
4519 if (w
->color
== MEM_RED
)
4521 w
->color
= MEM_BLACK
;
4522 x
->parent
->color
= MEM_RED
;
4523 mem_rotate_right (x
->parent
);
4524 w
= x
->parent
->left
;
4527 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4534 if (w
->left
->color
== MEM_BLACK
)
4536 w
->right
->color
= MEM_BLACK
;
4538 mem_rotate_left (w
);
4539 w
= x
->parent
->left
;
4542 w
->color
= x
->parent
->color
;
4543 x
->parent
->color
= MEM_BLACK
;
4544 w
->left
->color
= MEM_BLACK
;
4545 mem_rotate_right (x
->parent
);
4551 x
->color
= MEM_BLACK
;
4555 /* If P is a pointer into a live Lisp string object on the heap,
4556 return the object. Otherwise, return nil. M is a pointer to the
4559 This and other *_holding functions look for a pointer anywhere into
4560 the object, not merely for a pointer to the start of the object,
4561 because some compilers sometimes optimize away the latter. See
4565 live_string_holding (struct mem_node
*m
, void *p
)
4567 if (m
->type
== MEM_TYPE_STRING
)
4569 struct string_block
*b
= m
->start
;
4571 ptrdiff_t offset
= cp
- (char *) &b
->strings
[0];
4573 /* P must point into a Lisp_String structure, and it
4574 must not be on the free-list. */
4575 if (0 <= offset
&& offset
< STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4577 struct Lisp_String
*s
= p
= cp
-= offset
% sizeof b
->strings
[0];
4579 return make_lisp_ptr (s
, Lisp_String
);
4586 live_string_p (struct mem_node
*m
, void *p
)
4588 return !NILP (live_string_holding (m
, p
));
4591 /* If P is a pointer into a live Lisp cons object on the heap, return
4592 the object. Otherwise, return nil. M is a pointer to the
4596 live_cons_holding (struct mem_node
*m
, void *p
)
4598 if (m
->type
== MEM_TYPE_CONS
)
4600 struct cons_block
*b
= m
->start
;
4602 ptrdiff_t offset
= cp
- (char *) &b
->conses
[0];
4604 /* P must point into a Lisp_Cons, not be
4605 one of the unused cells in the current cons block,
4606 and not be on the free-list. */
4607 if (0 <= offset
&& offset
< CONS_BLOCK_SIZE
* sizeof b
->conses
[0]
4609 || offset
/ sizeof b
->conses
[0] < cons_block_index
))
4611 struct Lisp_Cons
*s
= p
= cp
-= offset
% sizeof b
->conses
[0];
4612 if (!EQ (s
->u
.s
.car
, Vdead
))
4613 return make_lisp_ptr (s
, Lisp_Cons
);
4620 live_cons_p (struct mem_node
*m
, void *p
)
4622 return !NILP (live_cons_holding (m
, p
));
4626 /* If P is a pointer into a live Lisp symbol object on the heap,
4627 return the object. Otherwise, return nil. M is a pointer to the
4631 live_symbol_holding (struct mem_node
*m
, void *p
)
4633 if (m
->type
== MEM_TYPE_SYMBOL
)
4635 struct symbol_block
*b
= m
->start
;
4637 ptrdiff_t offset
= cp
- (char *) &b
->symbols
[0];
4639 /* P must point into the Lisp_Symbol, not be
4640 one of the unused cells in the current symbol block,
4641 and not be on the free-list. */
4642 if (0 <= offset
&& offset
< SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0]
4643 && (b
!= symbol_block
4644 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
))
4646 struct Lisp_Symbol
*s
= p
= cp
-= offset
% sizeof b
->symbols
[0];
4647 if (!EQ (s
->u
.s
.function
, Vdead
))
4648 return make_lisp_symbol (s
);
4655 live_symbol_p (struct mem_node
*m
, void *p
)
4657 return !NILP (live_symbol_holding (m
, p
));
4661 /* Return true if P is a pointer to a live Lisp float on
4662 the heap. M is a pointer to the mem_block for P. */
4665 live_float_p (struct mem_node
*m
, void *p
)
4667 if (m
->type
== MEM_TYPE_FLOAT
)
4669 struct float_block
*b
= m
->start
;
4671 ptrdiff_t offset
= cp
- (char *) &b
->floats
[0];
4673 /* P must point to the start of a Lisp_Float and not be
4674 one of the unused cells in the current float block. */
4676 && offset
% sizeof b
->floats
[0] == 0
4677 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4678 && (b
!= float_block
4679 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4686 /* If P is a pointer to a live Lisp Misc on the heap, return the object.
4687 Otherwise, return nil. M is a pointer to the mem_block for P. */
4690 live_misc_holding (struct mem_node
*m
, void *p
)
4692 if (m
->type
== MEM_TYPE_MISC
)
4694 struct marker_block
*b
= m
->start
;
4696 ptrdiff_t offset
= cp
- (char *) &b
->markers
[0];
4698 /* P must point into a Lisp_Misc, not be
4699 one of the unused cells in the current misc block,
4700 and not be on the free-list. */
4701 if (0 <= offset
&& offset
< MARKER_BLOCK_SIZE
* sizeof b
->markers
[0]
4702 && (b
!= marker_block
4703 || offset
/ sizeof b
->markers
[0] < marker_block_index
))
4705 union Lisp_Misc
*s
= p
= cp
-= offset
% sizeof b
->markers
[0];
4706 if (s
->u_any
.type
!= Lisp_Misc_Free
)
4707 return make_lisp_ptr (s
, Lisp_Misc
);
4714 live_misc_p (struct mem_node
*m
, void *p
)
4716 return !NILP (live_misc_holding (m
, p
));
4719 /* If P is a pointer to a live vector-like object, return the object.
4720 Otherwise, return nil.
4721 M is a pointer to the mem_block for P. */
4724 live_vector_holding (struct mem_node
*m
, void *p
)
4726 struct Lisp_Vector
*vp
= p
;
4728 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4730 /* This memory node corresponds to a vector block. */
4731 struct vector_block
*block
= m
->start
;
4732 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4734 /* P is in the block's allocation range. Scan the block
4735 up to P and see whether P points to the start of some
4736 vector which is not on a free list. FIXME: check whether
4737 some allocation patterns (probably a lot of short vectors)
4738 may cause a substantial overhead of this loop. */
4739 while (VECTOR_IN_BLOCK (vector
, block
) && vector
<= vp
)
4741 struct Lisp_Vector
*next
= ADVANCE (vector
, vector_nbytes (vector
));
4742 if (vp
< next
&& !PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
))
4743 return make_lisp_ptr (vector
, Lisp_Vectorlike
);
4747 else if (m
->type
== MEM_TYPE_VECTORLIKE
)
4749 /* This memory node corresponds to a large vector. */
4750 struct Lisp_Vector
*vector
= large_vector_vec (m
->start
);
4751 struct Lisp_Vector
*next
= ADVANCE (vector
, vector_nbytes (vector
));
4752 if (vector
<= vp
&& vp
< next
)
4753 return make_lisp_ptr (vector
, Lisp_Vectorlike
);
4759 live_vector_p (struct mem_node
*m
, void *p
)
4761 return !NILP (live_vector_holding (m
, p
));
4764 /* If P is a pointer into a live buffer, return the buffer.
4765 Otherwise, return nil. M is a pointer to the mem_block for P. */
4768 live_buffer_holding (struct mem_node
*m
, void *p
)
4770 /* P must point into the block, and the buffer
4771 must not have been killed. */
4772 if (m
->type
== MEM_TYPE_BUFFER
)
4774 struct buffer
*b
= m
->start
;
4775 char *cb
= m
->start
;
4777 ptrdiff_t offset
= cp
- cb
;
4778 if (0 <= offset
&& offset
< sizeof *b
&& !NILP (b
->name_
))
4781 XSETBUFFER (obj
, b
);
4789 live_buffer_p (struct mem_node
*m
, void *p
)
4791 return !NILP (live_buffer_holding (m
, p
));
4794 /* Mark OBJ if we can prove it's a Lisp_Object. */
4797 mark_maybe_object (Lisp_Object obj
)
4801 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4807 void *po
= XPNTR (obj
);
4808 struct mem_node
*m
= mem_find (po
);
4812 bool mark_p
= false;
4814 switch (XTYPE (obj
))
4817 mark_p
= EQ (obj
, live_string_holding (m
, po
));
4821 mark_p
= EQ (obj
, live_cons_holding (m
, po
));
4825 mark_p
= EQ (obj
, live_symbol_holding (m
, po
));
4829 mark_p
= live_float_p (m
, po
);
4832 case Lisp_Vectorlike
:
4833 mark_p
= (EQ (obj
, live_vector_holding (m
, po
))
4834 || EQ (obj
, live_buffer_holding (m
, po
)));
4838 mark_p
= EQ (obj
, live_misc_holding (m
, po
));
4850 /* Return true if P can point to Lisp data, and false otherwise.
4851 Symbols are implemented via offsets not pointers, but the offsets
4852 are also multiples of GCALIGNMENT. */
4855 maybe_lisp_pointer (void *p
)
4857 return (uintptr_t) p
% GCALIGNMENT
== 0;
4860 #ifndef HAVE_MODULES
4861 enum { HAVE_MODULES
= false };
4864 /* If P points to Lisp data, mark that as live if it isn't already
4868 mark_maybe_pointer (void *p
)
4874 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4877 if (sizeof (Lisp_Object
) == sizeof (void *) || !HAVE_MODULES
)
4879 if (!maybe_lisp_pointer (p
))
4884 /* For the wide-int case, also mark emacs_value tagged pointers,
4885 which can be generated by emacs-module.c's value_to_lisp. */
4886 p
= (void *) ((uintptr_t) p
& ~(GCALIGNMENT
- 1));
4892 Lisp_Object obj
= Qnil
;
4896 case MEM_TYPE_NON_LISP
:
4897 case MEM_TYPE_SPARE
:
4898 /* Nothing to do; not a pointer to Lisp memory. */
4901 case MEM_TYPE_BUFFER
:
4902 obj
= live_buffer_holding (m
, p
);
4906 obj
= live_cons_holding (m
, p
);
4909 case MEM_TYPE_STRING
:
4910 obj
= live_string_holding (m
, p
);
4914 obj
= live_misc_holding (m
, p
);
4917 case MEM_TYPE_SYMBOL
:
4918 obj
= live_symbol_holding (m
, p
);
4921 case MEM_TYPE_FLOAT
:
4922 if (live_float_p (m
, p
))
4923 obj
= make_lisp_ptr (p
, Lisp_Float
);
4926 case MEM_TYPE_VECTORLIKE
:
4927 case MEM_TYPE_VECTOR_BLOCK
:
4928 obj
= live_vector_holding (m
, p
);
4941 /* Alignment of pointer values. Use alignof, as it sometimes returns
4942 a smaller alignment than GCC's __alignof__ and mark_memory might
4943 miss objects if __alignof__ were used. */
4944 #define GC_POINTER_ALIGNMENT alignof (void *)
4946 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4947 or END+OFFSET..START. */
4949 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4950 mark_memory (void *start
, void *end
)
4954 /* Make START the pointer to the start of the memory region,
4955 if it isn't already. */
4963 eassert (((uintptr_t) start
) % GC_POINTER_ALIGNMENT
== 0);
4965 /* Mark Lisp data pointed to. This is necessary because, in some
4966 situations, the C compiler optimizes Lisp objects away, so that
4967 only a pointer to them remains. Example:
4969 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4972 Lisp_Object obj = build_string ("test");
4973 struct Lisp_String *s = XSTRING (obj);
4974 Fgarbage_collect ();
4975 fprintf (stderr, "test '%s'\n", s->u.s.data);
4979 Here, `obj' isn't really used, and the compiler optimizes it
4980 away. The only reference to the life string is through the
4983 for (pp
= start
; (void *) pp
< end
; pp
+= GC_POINTER_ALIGNMENT
)
4985 mark_maybe_pointer (*(void **) pp
);
4986 mark_maybe_object (*(Lisp_Object
*) pp
);
4990 #ifndef HAVE___BUILTIN_UNWIND_INIT
4992 # ifdef GC_SETJMP_WORKS
4999 static bool setjmp_tested_p
;
5000 static int longjmps_done
;
5002 # define SETJMP_WILL_LIKELY_WORK "\
5004 Emacs garbage collector has been changed to use conservative stack\n\
5005 marking. Emacs has determined that the method it uses to do the\n\
5006 marking will likely work on your system, but this isn't sure.\n\
5008 If you are a system-programmer, or can get the help of a local wizard\n\
5009 who is, please take a look at the function mark_stack in alloc.c, and\n\
5010 verify that the methods used are appropriate for your system.\n\
5012 Please mail the result to <emacs-devel@gnu.org>.\n\
5015 # define SETJMP_WILL_NOT_WORK "\
5017 Emacs garbage collector has been changed to use conservative stack\n\
5018 marking. Emacs has determined that the default method it uses to do the\n\
5019 marking will not work on your system. We will need a system-dependent\n\
5020 solution for your system.\n\
5022 Please take a look at the function mark_stack in alloc.c, and\n\
5023 try to find a way to make it work on your system.\n\
5025 Note that you may get false negatives, depending on the compiler.\n\
5026 In particular, you need to use -O with GCC for this test.\n\
5028 Please mail the result to <emacs-devel@gnu.org>.\n\
5032 /* Perform a quick check if it looks like setjmp saves registers in a
5033 jmp_buf. Print a message to stderr saying so. When this test
5034 succeeds, this is _not_ a proof that setjmp is sufficient for
5035 conservative stack marking. Only the sources or a disassembly
5041 if (setjmp_tested_p
)
5043 setjmp_tested_p
= true;
5048 /* Arrange for X to be put in a register. */
5054 if (longjmps_done
== 1)
5056 /* Came here after the longjmp at the end of the function.
5058 If x == 1, the longjmp has restored the register to its
5059 value before the setjmp, and we can hope that setjmp
5060 saves all such registers in the jmp_buf, although that
5063 For other values of X, either something really strange is
5064 taking place, or the setjmp just didn't save the register. */
5067 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
5070 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
5077 if (longjmps_done
== 1)
5078 sys_longjmp (jbuf
, 1);
5080 # endif /* ! GC_SETJMP_WORKS */
5081 #endif /* ! HAVE___BUILTIN_UNWIND_INIT */
5083 /* The type of an object near the stack top, whose address can be used
5084 as a stack scan limit. */
5087 /* Align the stack top properly. Even if !HAVE___BUILTIN_UNWIND_INIT,
5088 jmp_buf may not be aligned enough on darwin-ppc64. */
5090 #ifndef HAVE___BUILTIN_UNWIND_INIT
5096 /* Force callee-saved registers and register windows onto the stack.
5097 Use the platform-defined __builtin_unwind_init if available,
5098 obviating the need for machine dependent methods. */
5099 #ifndef HAVE___BUILTIN_UNWIND_INIT
5101 /* This trick flushes the register windows so that all the state of
5102 the process is contained in the stack.
5103 FreeBSD does not have a ta 3 handler, so handle it specially.
5104 FIXME: Code in the Boehm GC suggests flushing (with 'flushrs') is
5105 needed on ia64 too. See mach_dep.c, where it also says inline
5106 assembler doesn't work with relevant proprietary compilers. */
5107 # if defined __sparc64__ && defined __FreeBSD__
5108 # define __builtin_unwind_init() asm ("flushw")
5110 # define __builtin_unwind_init() asm ("ta 3")
5113 # define __builtin_unwind_init() ((void) 0)
5117 /* Yield an address close enough to the top of the stack that the
5118 garbage collector need not scan above it. Callers should be
5119 declared NO_INLINE. */
5120 #ifdef HAVE___BUILTIN_FRAME_ADDRESS
5121 # define NEAR_STACK_TOP(addr) ((void) (addr), __builtin_frame_address (0))
5123 # define NEAR_STACK_TOP(addr) (addr)
5126 /* Set *P to the address of the top of the stack. This must be a
5127 macro, not a function, so that it is executed in the caller’s
5128 environment. It is not inside a do-while so that its storage
5129 survives the macro. Callers should be declared NO_INLINE. */
5130 #ifdef HAVE___BUILTIN_UNWIND_INIT
5131 # define SET_STACK_TOP_ADDRESS(p) \
5132 stacktop_sentry sentry; \
5133 __builtin_unwind_init (); \
5134 *(p) = NEAR_STACK_TOP (&sentry)
5136 # define SET_STACK_TOP_ADDRESS(p) \
5137 stacktop_sentry sentry; \
5138 __builtin_unwind_init (); \
5140 sys_setjmp (sentry.j); \
5141 *(p) = NEAR_STACK_TOP (&sentry + (stack_bottom < &sentry.c))
5144 /* Mark live Lisp objects on the C stack.
5146 There are several system-dependent problems to consider when
5147 porting this to new architectures:
5151 We have to mark Lisp objects in CPU registers that can hold local
5152 variables or are used to pass parameters.
5154 This code assumes that calling setjmp saves registers we need
5155 to see in a jmp_buf which itself lies on the stack. This doesn't
5156 have to be true! It must be verified for each system, possibly
5157 by taking a look at the source code of setjmp.
5159 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
5160 can use it as a machine independent method to store all registers
5161 to the stack. In this case the macros described in the previous
5162 two paragraphs are not used.
5166 Architectures differ in the way their processor stack is organized.
5167 For example, the stack might look like this
5170 | Lisp_Object | size = 4
5172 | something else | size = 2
5174 | Lisp_Object | size = 4
5178 In such a case, not every Lisp_Object will be aligned equally. To
5179 find all Lisp_Object on the stack it won't be sufficient to walk
5180 the stack in steps of 4 bytes. Instead, two passes will be
5181 necessary, one starting at the start of the stack, and a second
5182 pass starting at the start of the stack + 2. Likewise, if the
5183 minimal alignment of Lisp_Objects on the stack is 1, four passes
5184 would be necessary, each one starting with one byte more offset
5185 from the stack start. */
5188 mark_stack (char *bottom
, char *end
)
5190 /* This assumes that the stack is a contiguous region in memory. If
5191 that's not the case, something has to be done here to iterate
5192 over the stack segments. */
5193 mark_memory (bottom
, end
);
5195 /* Allow for marking a secondary stack, like the register stack on the
5197 #ifdef GC_MARK_SECONDARY_STACK
5198 GC_MARK_SECONDARY_STACK ();
5202 /* This is a trampoline function that flushes registers to the stack,
5203 and then calls FUNC. ARG is passed through to FUNC verbatim.
5205 This function must be called whenever Emacs is about to release the
5206 global interpreter lock. This lets the garbage collector easily
5207 find roots in registers on threads that are not actively running
5210 It is invalid to run any Lisp code or to allocate any GC memory
5214 flush_stack_call_func (void (*func
) (void *arg
), void *arg
)
5217 struct thread_state
*self
= current_thread
;
5218 SET_STACK_TOP_ADDRESS (&end
);
5219 self
->stack_top
= end
;
5221 eassert (current_thread
== self
);
5225 c_symbol_p (struct Lisp_Symbol
*sym
)
5227 char *lispsym_ptr
= (char *) lispsym
;
5228 char *sym_ptr
= (char *) sym
;
5229 ptrdiff_t lispsym_offset
= sym_ptr
- lispsym_ptr
;
5230 return 0 <= lispsym_offset
&& lispsym_offset
< sizeof lispsym
;
5233 /* Determine whether it is safe to access memory at address P. */
5235 valid_pointer_p (void *p
)
5238 return w32_valid_pointer_p (p
, 16);
5241 if (ADDRESS_SANITIZER
)
5246 /* Obviously, we cannot just access it (we would SEGV trying), so we
5247 trick the o/s to tell us whether p is a valid pointer.
5248 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
5249 not validate p in that case. */
5251 if (emacs_pipe (fd
) == 0)
5253 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
5254 emacs_close (fd
[1]);
5255 emacs_close (fd
[0]);
5263 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
5264 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
5265 cannot validate OBJ. This function can be quite slow, so its primary
5266 use is the manual debugging. The only exception is print_object, where
5267 we use it to check whether the memory referenced by the pointer of
5268 Lisp_Save_Value object contains valid objects. */
5271 valid_lisp_object_p (Lisp_Object obj
)
5276 void *p
= XPNTR (obj
);
5280 if (SYMBOLP (obj
) && c_symbol_p (p
))
5281 return ((char *) p
- (char *) lispsym
) % sizeof lispsym
[0] == 0;
5283 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
5286 struct mem_node
*m
= mem_find (p
);
5290 int valid
= valid_pointer_p (p
);
5302 case MEM_TYPE_NON_LISP
:
5303 case MEM_TYPE_SPARE
:
5306 case MEM_TYPE_BUFFER
:
5307 return live_buffer_p (m
, p
) ? 1 : 2;
5310 return live_cons_p (m
, p
);
5312 case MEM_TYPE_STRING
:
5313 return live_string_p (m
, p
);
5316 return live_misc_p (m
, p
);
5318 case MEM_TYPE_SYMBOL
:
5319 return live_symbol_p (m
, p
);
5321 case MEM_TYPE_FLOAT
:
5322 return live_float_p (m
, p
);
5324 case MEM_TYPE_VECTORLIKE
:
5325 case MEM_TYPE_VECTOR_BLOCK
:
5326 return live_vector_p (m
, p
);
5335 /***********************************************************************
5336 Pure Storage Management
5337 ***********************************************************************/
5339 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5340 pointer to it. TYPE is the Lisp type for which the memory is
5341 allocated. TYPE < 0 means it's not used for a Lisp object. */
5344 pure_alloc (size_t size
, int type
)
5351 /* Allocate space for a Lisp object from the beginning of the free
5352 space with taking account of alignment. */
5353 result
= pointer_align (purebeg
+ pure_bytes_used_lisp
, GCALIGNMENT
);
5354 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5358 /* Allocate space for a non-Lisp object from the end of the free
5360 pure_bytes_used_non_lisp
+= size
;
5361 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5363 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5365 if (pure_bytes_used
<= pure_size
)
5368 /* Don't allocate a large amount here,
5369 because it might get mmap'd and then its address
5370 might not be usable. */
5371 purebeg
= xmalloc (10000);
5373 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5374 pure_bytes_used
= 0;
5375 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5382 /* Print a warning if PURESIZE is too small. */
5385 check_pure_size (void)
5387 if (pure_bytes_used_before_overflow
)
5388 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5390 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5395 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5396 the non-Lisp data pool of the pure storage, and return its start
5397 address. Return NULL if not found. */
5400 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5403 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5404 const unsigned char *p
;
5407 if (pure_bytes_used_non_lisp
<= nbytes
)
5410 /* Set up the Boyer-Moore table. */
5412 for (i
= 0; i
< 256; i
++)
5415 p
= (const unsigned char *) data
;
5417 bm_skip
[*p
++] = skip
;
5419 last_char_skip
= bm_skip
['\0'];
5421 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5422 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5424 /* See the comments in the function `boyer_moore' (search.c) for the
5425 use of `infinity'. */
5426 infinity
= pure_bytes_used_non_lisp
+ 1;
5427 bm_skip
['\0'] = infinity
;
5429 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5433 /* Check the last character (== '\0'). */
5436 start
+= bm_skip
[*(p
+ start
)];
5438 while (start
<= start_max
);
5440 if (start
< infinity
)
5441 /* Couldn't find the last character. */
5444 /* No less than `infinity' means we could find the last
5445 character at `p[start - infinity]'. */
5448 /* Check the remaining characters. */
5449 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5451 return non_lisp_beg
+ start
;
5453 start
+= last_char_skip
;
5455 while (start
<= start_max
);
5461 /* Return a string allocated in pure space. DATA is a buffer holding
5462 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5463 means make the result string multibyte.
5465 Must get an error if pure storage is full, since if it cannot hold
5466 a large string it may be able to hold conses that point to that
5467 string; then the string is not protected from gc. */
5470 make_pure_string (const char *data
,
5471 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5474 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5475 s
->u
.s
.data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5476 if (s
->u
.s
.data
== NULL
)
5478 s
->u
.s
.data
= pure_alloc (nbytes
+ 1, -1);
5479 memcpy (s
->u
.s
.data
, data
, nbytes
);
5480 s
->u
.s
.data
[nbytes
] = '\0';
5482 s
->u
.s
.size
= nchars
;
5483 s
->u
.s
.size_byte
= multibyte
? nbytes
: -1;
5484 s
->u
.s
.intervals
= NULL
;
5485 XSETSTRING (string
, s
);
5489 /* Return a string allocated in pure space. Do not
5490 allocate the string data, just point to DATA. */
5493 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5496 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5497 s
->u
.s
.size
= nchars
;
5498 s
->u
.s
.size_byte
= -1;
5499 s
->u
.s
.data
= (unsigned char *) data
;
5500 s
->u
.s
.intervals
= NULL
;
5501 XSETSTRING (string
, s
);
5505 static Lisp_Object
purecopy (Lisp_Object obj
);
5507 /* Return a cons allocated from pure space. Give it pure copies
5508 of CAR as car and CDR as cdr. */
5511 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5514 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5516 XSETCAR (new, purecopy (car
));
5517 XSETCDR (new, purecopy (cdr
));
5522 /* Value is a float object with value NUM allocated from pure space. */
5525 make_pure_float (double num
)
5528 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5530 XFLOAT_INIT (new, num
);
5535 /* Return a vector with room for LEN Lisp_Objects allocated from
5539 make_pure_vector (ptrdiff_t len
)
5542 size_t size
= header_size
+ len
* word_size
;
5543 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5544 XSETVECTOR (new, p
);
5545 XVECTOR (new)->header
.size
= len
;
5549 /* Copy all contents and parameters of TABLE to a new table allocated
5550 from pure space, return the purified table. */
5551 static struct Lisp_Hash_Table
*
5552 purecopy_hash_table (struct Lisp_Hash_Table
*table
)
5554 eassert (NILP (table
->weak
));
5555 eassert (table
->pure
);
5557 struct Lisp_Hash_Table
*pure
= pure_alloc (sizeof *pure
, Lisp_Vectorlike
);
5558 struct hash_table_test pure_test
= table
->test
;
5560 /* Purecopy the hash table test. */
5561 pure_test
.name
= purecopy (table
->test
.name
);
5562 pure_test
.user_hash_function
= purecopy (table
->test
.user_hash_function
);
5563 pure_test
.user_cmp_function
= purecopy (table
->test
.user_cmp_function
);
5565 pure
->header
= table
->header
;
5566 pure
->weak
= purecopy (Qnil
);
5567 pure
->hash
= purecopy (table
->hash
);
5568 pure
->next
= purecopy (table
->next
);
5569 pure
->index
= purecopy (table
->index
);
5570 pure
->count
= table
->count
;
5571 pure
->next_free
= table
->next_free
;
5572 pure
->pure
= table
->pure
;
5573 pure
->rehash_threshold
= table
->rehash_threshold
;
5574 pure
->rehash_size
= table
->rehash_size
;
5575 pure
->key_and_value
= purecopy (table
->key_and_value
);
5576 pure
->test
= pure_test
;
5581 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5582 doc
: /* Make a copy of object OBJ in pure storage.
5583 Recursively copies contents of vectors and cons cells.
5584 Does not copy symbols. Copies strings without text properties. */)
5585 (register Lisp_Object obj
)
5587 if (NILP (Vpurify_flag
))
5589 else if (MARKERP (obj
) || OVERLAYP (obj
) || SYMBOLP (obj
))
5590 /* Can't purify those. */
5593 return purecopy (obj
);
5596 /* Pinned objects are marked before every GC cycle. */
5597 static struct pinned_object
5600 struct pinned_object
*next
;
5604 purecopy (Lisp_Object obj
)
5607 || (! SYMBOLP (obj
) && PURE_P (XPNTR_OR_SYMBOL_OFFSET (obj
)))
5609 return obj
; /* Already pure. */
5611 if (STRINGP (obj
) && XSTRING (obj
)->u
.s
.intervals
)
5612 message_with_string ("Dropping text-properties while making string `%s' pure",
5615 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5617 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5623 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5624 else if (FLOATP (obj
))
5625 obj
= make_pure_float (XFLOAT_DATA (obj
));
5626 else if (STRINGP (obj
))
5627 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5629 STRING_MULTIBYTE (obj
));
5630 else if (HASH_TABLE_P (obj
))
5632 struct Lisp_Hash_Table
*table
= XHASH_TABLE (obj
);
5633 /* Do not purify hash tables which haven't been defined with
5634 :purecopy as non-nil or are weak - they aren't guaranteed to
5636 if (!NILP (table
->weak
) || !table
->pure
)
5638 /* Instead, add the hash table to the list of pinned objects,
5639 so that it will be marked during GC. */
5640 struct pinned_object
*o
= xmalloc (sizeof *o
);
5642 o
->next
= pinned_objects
;
5644 return obj
; /* Don't hash cons it. */
5647 struct Lisp_Hash_Table
*h
= purecopy_hash_table (table
);
5648 XSET_HASH_TABLE (obj
, h
);
5650 else if (COMPILEDP (obj
) || VECTORP (obj
) || RECORDP (obj
))
5652 struct Lisp_Vector
*objp
= XVECTOR (obj
);
5653 ptrdiff_t nbytes
= vector_nbytes (objp
);
5654 struct Lisp_Vector
*vec
= pure_alloc (nbytes
, Lisp_Vectorlike
);
5655 register ptrdiff_t i
;
5656 ptrdiff_t size
= ASIZE (obj
);
5657 if (size
& PSEUDOVECTOR_FLAG
)
5658 size
&= PSEUDOVECTOR_SIZE_MASK
;
5659 memcpy (vec
, objp
, nbytes
);
5660 for (i
= 0; i
< size
; i
++)
5661 vec
->contents
[i
] = purecopy (vec
->contents
[i
]);
5662 XSETVECTOR (obj
, vec
);
5664 else if (SYMBOLP (obj
))
5666 if (!XSYMBOL (obj
)->u
.s
.pinned
&& !c_symbol_p (XSYMBOL (obj
)))
5667 { /* We can't purify them, but they appear in many pure objects.
5668 Mark them as `pinned' so we know to mark them at every GC cycle. */
5669 XSYMBOL (obj
)->u
.s
.pinned
= true;
5670 symbol_block_pinned
= symbol_block
;
5672 /* Don't hash-cons it. */
5677 AUTO_STRING (fmt
, "Don't know how to purify: %S");
5678 Fsignal (Qerror
, list1 (CALLN (Fformat
, fmt
, obj
)));
5681 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5682 Fputhash (obj
, obj
, Vpurify_flag
);
5689 /***********************************************************************
5691 ***********************************************************************/
5693 /* Put an entry in staticvec, pointing at the variable with address
5697 staticpro (Lisp_Object
*varaddress
)
5699 if (staticidx
>= NSTATICS
)
5700 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5701 staticvec
[staticidx
++] = varaddress
;
5705 /***********************************************************************
5707 ***********************************************************************/
5709 /* Temporarily prevent garbage collection. */
5712 inhibit_garbage_collection (void)
5714 ptrdiff_t count
= SPECPDL_INDEX ();
5716 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5720 /* Used to avoid possible overflows when
5721 converting from C to Lisp integers. */
5724 bounded_number (EMACS_INT number
)
5726 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5729 /* Calculate total bytes of live objects. */
5732 total_bytes_of_live_objects (void)
5735 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5736 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5737 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5738 tot
+= total_string_bytes
;
5739 tot
+= total_vector_slots
* word_size
;
5740 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5741 tot
+= total_intervals
* sizeof (struct interval
);
5742 tot
+= total_strings
* sizeof (struct Lisp_String
);
5746 #ifdef HAVE_WINDOW_SYSTEM
5748 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5749 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5752 compact_font_cache_entry (Lisp_Object entry
)
5754 Lisp_Object tail
, *prev
= &entry
;
5756 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5759 Lisp_Object obj
= XCAR (tail
);
5761 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5762 if (CONSP (obj
) && GC_FONT_SPEC_P (XCAR (obj
))
5763 && !VECTOR_MARKED_P (GC_XFONT_SPEC (XCAR (obj
)))
5764 /* Don't use VECTORP here, as that calls ASIZE, which could
5765 hit assertion violation during GC. */
5766 && (VECTORLIKEP (XCDR (obj
))
5767 && ! (gc_asize (XCDR (obj
)) & PSEUDOVECTOR_FLAG
)))
5769 ptrdiff_t i
, size
= gc_asize (XCDR (obj
));
5770 Lisp_Object obj_cdr
= XCDR (obj
);
5772 /* If font-spec is not marked, most likely all font-entities
5773 are not marked too. But we must be sure that nothing is
5774 marked within OBJ before we really drop it. */
5775 for (i
= 0; i
< size
; i
++)
5777 Lisp_Object objlist
;
5779 if (VECTOR_MARKED_P (GC_XFONT_ENTITY (AREF (obj_cdr
, i
))))
5782 objlist
= AREF (AREF (obj_cdr
, i
), FONT_OBJLIST_INDEX
);
5783 for (; CONSP (objlist
); objlist
= XCDR (objlist
))
5785 Lisp_Object val
= XCAR (objlist
);
5786 struct font
*font
= GC_XFONT_OBJECT (val
);
5788 if (!NILP (AREF (val
, FONT_TYPE_INDEX
))
5789 && VECTOR_MARKED_P(font
))
5792 if (CONSP (objlist
))
5794 /* Found a marked font, bail out. */
5801 /* No marked fonts were found, so this entire font
5802 entity can be dropped. */
5807 *prev
= XCDR (tail
);
5809 prev
= xcdr_addr (tail
);
5814 /* Compact font caches on all terminals and mark
5815 everything which is still here after compaction. */
5818 compact_font_caches (void)
5822 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5824 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5825 /* Inhibit compacting the caches if the user so wishes. Some of
5826 the users don't mind a larger memory footprint, but do mind
5827 slower redisplay. */
5828 if (!inhibit_compacting_font_caches
5833 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5834 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5836 mark_object (cache
);
5840 #else /* not HAVE_WINDOW_SYSTEM */
5842 #define compact_font_caches() (void)(0)
5844 #endif /* HAVE_WINDOW_SYSTEM */
5846 /* Remove (MARKER . DATA) entries with unmarked MARKER
5847 from buffer undo LIST and return changed list. */
5850 compact_undo_list (Lisp_Object list
)
5852 Lisp_Object tail
, *prev
= &list
;
5854 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5856 if (CONSP (XCAR (tail
))
5857 && MARKERP (XCAR (XCAR (tail
)))
5858 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5859 *prev
= XCDR (tail
);
5861 prev
= xcdr_addr (tail
);
5867 mark_pinned_objects (void)
5869 for (struct pinned_object
*pobj
= pinned_objects
; pobj
; pobj
= pobj
->next
)
5870 mark_object (pobj
->object
);
5874 mark_pinned_symbols (void)
5876 struct symbol_block
*sblk
;
5877 int lim
= (symbol_block_pinned
== symbol_block
5878 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5880 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5882 struct Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5883 for (; sym
< end
; ++sym
)
5884 if (sym
->u
.s
.pinned
)
5885 mark_object (make_lisp_symbol (sym
));
5887 lim
= SYMBOL_BLOCK_SIZE
;
5891 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5892 separate function so that we could limit mark_stack in searching
5893 the stack frames below this function, thus avoiding the rare cases
5894 where mark_stack finds values that look like live Lisp objects on
5895 portions of stack that couldn't possibly contain such live objects.
5896 For more details of this, see the discussion at
5897 https://lists.gnu.org/r/emacs-devel/2014-05/msg00270.html. */
5899 garbage_collect_1 (void *end
)
5901 struct buffer
*nextb
;
5902 char stack_top_variable
;
5905 ptrdiff_t count
= SPECPDL_INDEX ();
5906 struct timespec start
;
5907 Lisp_Object retval
= Qnil
;
5908 size_t tot_before
= 0;
5910 /* Can't GC if pure storage overflowed because we can't determine
5911 if something is a pure object or not. */
5912 if (pure_bytes_used_before_overflow
)
5915 /* Record this function, so it appears on the profiler's backtraces. */
5916 record_in_backtrace (QAutomatic_GC
, 0, 0);
5920 /* Don't keep undo information around forever.
5921 Do this early on, so it is no problem if the user quits. */
5922 FOR_EACH_BUFFER (nextb
)
5923 compact_buffer (nextb
);
5925 if (profiler_memory_running
)
5926 tot_before
= total_bytes_of_live_objects ();
5928 start
= current_timespec ();
5930 /* In case user calls debug_print during GC,
5931 don't let that cause a recursive GC. */
5932 consing_since_gc
= 0;
5934 /* Save what's currently displayed in the echo area. Don't do that
5935 if we are GC'ing because we've run out of memory, since
5936 push_message will cons, and we might have no memory for that. */
5937 if (NILP (Vmemory_full
))
5939 message_p
= push_message ();
5940 record_unwind_protect_void (pop_message_unwind
);
5945 /* Save a copy of the contents of the stack, for debugging. */
5946 #if MAX_SAVE_STACK > 0
5947 if (NILP (Vpurify_flag
))
5950 ptrdiff_t stack_size
;
5951 if (&stack_top_variable
< stack_bottom
)
5953 stack
= &stack_top_variable
;
5954 stack_size
= stack_bottom
- &stack_top_variable
;
5958 stack
= stack_bottom
;
5959 stack_size
= &stack_top_variable
- stack_bottom
;
5961 if (stack_size
<= MAX_SAVE_STACK
)
5963 if (stack_copy_size
< stack_size
)
5965 stack_copy
= xrealloc (stack_copy
, stack_size
);
5966 stack_copy_size
= stack_size
;
5968 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5971 #endif /* MAX_SAVE_STACK > 0 */
5973 if (garbage_collection_messages
)
5974 message1_nolog ("Garbage collecting...");
5978 shrink_regexp_cache ();
5982 /* Mark all the special slots that serve as the roots of accessibility. */
5984 mark_buffer (&buffer_defaults
);
5985 mark_buffer (&buffer_local_symbols
);
5987 for (i
= 0; i
< ARRAYELTS (lispsym
); i
++)
5988 mark_object (builtin_lisp_symbol (i
));
5990 for (i
= 0; i
< staticidx
; i
++)
5991 mark_object (*staticvec
[i
]);
5993 mark_pinned_objects ();
5994 mark_pinned_symbols ();
6003 #ifdef HAVE_WINDOW_SYSTEM
6004 mark_fringe_data ();
6011 /* Everything is now marked, except for the data in font caches,
6012 undo lists, and finalizers. The first two are compacted by
6013 removing an items which aren't reachable otherwise. */
6015 compact_font_caches ();
6017 FOR_EACH_BUFFER (nextb
)
6019 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
6020 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
6021 /* Now that we have stripped the elements that need not be
6022 in the undo_list any more, we can finally mark the list. */
6023 mark_object (BVAR (nextb
, undo_list
));
6026 /* Now pre-sweep finalizers. Here, we add any unmarked finalizers
6027 to doomed_finalizers so we can run their associated functions
6028 after GC. It's important to scan finalizers at this stage so
6029 that we can be sure that unmarked finalizers are really
6030 unreachable except for references from their associated functions
6031 and from other finalizers. */
6033 queue_doomed_finalizers (&doomed_finalizers
, &finalizers
);
6034 mark_finalizer_list (&doomed_finalizers
);
6038 /* Clear the mark bits that we set in certain root slots. */
6039 VECTOR_UNMARK (&buffer_defaults
);
6040 VECTOR_UNMARK (&buffer_local_symbols
);
6048 consing_since_gc
= 0;
6049 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
6050 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
6052 gc_relative_threshold
= 0;
6053 if (FLOATP (Vgc_cons_percentage
))
6054 { /* Set gc_cons_combined_threshold. */
6055 double tot
= total_bytes_of_live_objects ();
6057 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
6060 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
6061 gc_relative_threshold
= tot
;
6063 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
6067 if (garbage_collection_messages
&& NILP (Vmemory_full
))
6069 if (message_p
|| minibuf_level
> 0)
6072 message1_nolog ("Garbage collecting...done");
6075 unbind_to (count
, Qnil
);
6077 Lisp_Object total
[] = {
6078 list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
6079 bounded_number (total_conses
),
6080 bounded_number (total_free_conses
)),
6081 list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
6082 bounded_number (total_symbols
),
6083 bounded_number (total_free_symbols
)),
6084 list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
6085 bounded_number (total_markers
),
6086 bounded_number (total_free_markers
)),
6087 list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
6088 bounded_number (total_strings
),
6089 bounded_number (total_free_strings
)),
6090 list3 (Qstring_bytes
, make_number (1),
6091 bounded_number (total_string_bytes
)),
6093 make_number (header_size
+ sizeof (Lisp_Object
)),
6094 bounded_number (total_vectors
)),
6095 list4 (Qvector_slots
, make_number (word_size
),
6096 bounded_number (total_vector_slots
),
6097 bounded_number (total_free_vector_slots
)),
6098 list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
6099 bounded_number (total_floats
),
6100 bounded_number (total_free_floats
)),
6101 list4 (Qintervals
, make_number (sizeof (struct interval
)),
6102 bounded_number (total_intervals
),
6103 bounded_number (total_free_intervals
)),
6104 list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
6105 bounded_number (total_buffers
)),
6107 #ifdef DOUG_LEA_MALLOC
6108 list4 (Qheap
, make_number (1024),
6109 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
6110 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)),
6113 retval
= CALLMANY (Flist
, total
);
6115 /* GC is complete: now we can run our finalizer callbacks. */
6116 run_finalizers (&doomed_finalizers
);
6118 if (!NILP (Vpost_gc_hook
))
6120 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6121 safe_run_hooks (Qpost_gc_hook
);
6122 unbind_to (gc_count
, Qnil
);
6125 /* Accumulate statistics. */
6126 if (FLOATP (Vgc_elapsed
))
6128 struct timespec since_start
= timespec_sub (current_timespec (), start
);
6129 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
6130 + timespectod (since_start
));
6135 /* Collect profiling data. */
6136 if (profiler_memory_running
)
6139 size_t tot_after
= total_bytes_of_live_objects ();
6140 if (tot_before
> tot_after
)
6141 swept
= tot_before
- tot_after
;
6142 malloc_probe (swept
);
6148 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
6149 doc
: /* Reclaim storage for Lisp objects no longer needed.
6150 Garbage collection happens automatically if you cons more than
6151 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
6152 `garbage-collect' normally returns a list with info on amount of space in use,
6153 where each entry has the form (NAME SIZE USED FREE), where:
6154 - NAME is a symbol describing the kind of objects this entry represents,
6155 - SIZE is the number of bytes used by each one,
6156 - USED is the number of those objects that were found live in the heap,
6157 - FREE is the number of those objects that are not live but that Emacs
6158 keeps around for future allocations (maybe because it does not know how
6159 to return them to the OS).
6160 However, if there was overflow in pure space, `garbage-collect'
6161 returns nil, because real GC can't be done.
6162 See Info node `(elisp)Garbage Collection'. */
6163 attributes
: noinline
)
6167 SET_STACK_TOP_ADDRESS (&end
);
6168 return garbage_collect_1 (end
);
6171 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
6172 only interesting objects referenced from glyphs are strings. */
6175 mark_glyph_matrix (struct glyph_matrix
*matrix
)
6177 struct glyph_row
*row
= matrix
->rows
;
6178 struct glyph_row
*end
= row
+ matrix
->nrows
;
6180 for (; row
< end
; ++row
)
6184 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
6186 struct glyph
*glyph
= row
->glyphs
[area
];
6187 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
6189 for (; glyph
< end_glyph
; ++glyph
)
6190 if (STRINGP (glyph
->object
)
6191 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
6192 mark_object (glyph
->object
);
6197 /* Mark reference to a Lisp_Object.
6198 If the object referred to has not been seen yet, recursively mark
6199 all the references contained in it. */
6201 #define LAST_MARKED_SIZE 500
6202 Lisp_Object last_marked
[LAST_MARKED_SIZE
] EXTERNALLY_VISIBLE
;
6203 static int last_marked_index
;
6205 /* For debugging--call abort when we cdr down this many
6206 links of a list, in mark_object. In debugging,
6207 the call to abort will hit a breakpoint.
6208 Normally this is zero and the check never goes off. */
6209 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
6212 mark_vectorlike (struct Lisp_Vector
*ptr
)
6214 ptrdiff_t size
= ptr
->header
.size
;
6217 eassert (!VECTOR_MARKED_P (ptr
));
6218 VECTOR_MARK (ptr
); /* Else mark it. */
6219 if (size
& PSEUDOVECTOR_FLAG
)
6220 size
&= PSEUDOVECTOR_SIZE_MASK
;
6222 /* Note that this size is not the memory-footprint size, but only
6223 the number of Lisp_Object fields that we should trace.
6224 The distinction is used e.g. by Lisp_Process which places extra
6225 non-Lisp_Object fields at the end of the structure... */
6226 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
6227 mark_object (ptr
->contents
[i
]);
6230 /* Like mark_vectorlike but optimized for char-tables (and
6231 sub-char-tables) assuming that the contents are mostly integers or
6235 mark_char_table (struct Lisp_Vector
*ptr
, enum pvec_type pvectype
)
6237 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
6238 /* Consult the Lisp_Sub_Char_Table layout before changing this. */
6239 int i
, idx
= (pvectype
== PVEC_SUB_CHAR_TABLE
? SUB_CHAR_TABLE_OFFSET
: 0);
6241 eassert (!VECTOR_MARKED_P (ptr
));
6243 for (i
= idx
; i
< size
; i
++)
6245 Lisp_Object val
= ptr
->contents
[i
];
6247 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->u
.s
.gcmarkbit
))
6249 if (SUB_CHAR_TABLE_P (val
))
6251 if (! VECTOR_MARKED_P (XVECTOR (val
)))
6252 mark_char_table (XVECTOR (val
), PVEC_SUB_CHAR_TABLE
);
6259 NO_INLINE
/* To reduce stack depth in mark_object. */
6261 mark_compiled (struct Lisp_Vector
*ptr
)
6263 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
6266 for (i
= 0; i
< size
; i
++)
6267 if (i
!= COMPILED_CONSTANTS
)
6268 mark_object (ptr
->contents
[i
]);
6269 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
6272 /* Mark the chain of overlays starting at PTR. */
6275 mark_overlay (struct Lisp_Overlay
*ptr
)
6277 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
6280 /* These two are always markers and can be marked fast. */
6281 XMARKER (ptr
->start
)->gcmarkbit
= 1;
6282 XMARKER (ptr
->end
)->gcmarkbit
= 1;
6283 mark_object (ptr
->plist
);
6287 /* Mark Lisp_Objects and special pointers in BUFFER. */
6290 mark_buffer (struct buffer
*buffer
)
6292 /* This is handled much like other pseudovectors... */
6293 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
6295 /* ...but there are some buffer-specific things. */
6297 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
6299 /* For now, we just don't mark the undo_list. It's done later in
6300 a special way just before the sweep phase, and after stripping
6301 some of its elements that are not needed any more. */
6303 mark_overlay (buffer
->overlays_before
);
6304 mark_overlay (buffer
->overlays_after
);
6306 /* If this is an indirect buffer, mark its base buffer. */
6307 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
6308 mark_buffer (buffer
->base_buffer
);
6311 /* Mark Lisp faces in the face cache C. */
6313 NO_INLINE
/* To reduce stack depth in mark_object. */
6315 mark_face_cache (struct face_cache
*c
)
6320 for (i
= 0; i
< c
->used
; ++i
)
6322 struct face
*face
= FACE_FROM_ID_OR_NULL (c
->f
, i
);
6326 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
6327 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
6329 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
6330 mark_object (face
->lface
[j
]);
6336 NO_INLINE
/* To reduce stack depth in mark_object. */
6338 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
6340 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6341 Lisp_Object where
= blv
->where
;
6342 /* If the value is set up for a killed buffer or deleted
6343 frame, restore its global binding. If the value is
6344 forwarded to a C variable, either it's not a Lisp_Object
6345 var, or it's staticpro'd already. */
6346 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
6347 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
6348 swap_in_global_binding (ptr
);
6349 mark_object (blv
->where
);
6350 mark_object (blv
->valcell
);
6351 mark_object (blv
->defcell
);
6354 NO_INLINE
/* To reduce stack depth in mark_object. */
6356 mark_save_value (struct Lisp_Save_Value
*ptr
)
6358 /* If `save_type' is zero, `data[0].pointer' is the address
6359 of a memory area containing `data[1].integer' potential
6361 if (ptr
->save_type
== SAVE_TYPE_MEMORY
)
6363 Lisp_Object
*p
= ptr
->data
[0].pointer
;
6365 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
6366 mark_maybe_object (*p
);
6370 /* Find Lisp_Objects in `data[N]' slots and mark them. */
6372 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
6373 if (save_type (ptr
, i
) == SAVE_OBJECT
)
6374 mark_object (ptr
->data
[i
].object
);
6378 /* Remove killed buffers or items whose car is a killed buffer from
6379 LIST, and mark other items. Return changed LIST, which is marked. */
6382 mark_discard_killed_buffers (Lisp_Object list
)
6384 Lisp_Object tail
, *prev
= &list
;
6386 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
6389 Lisp_Object tem
= XCAR (tail
);
6392 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
6393 *prev
= XCDR (tail
);
6396 CONS_MARK (XCONS (tail
));
6397 mark_object (XCAR (tail
));
6398 prev
= xcdr_addr (tail
);
6405 /* Determine type of generic Lisp_Object and mark it accordingly.
6407 This function implements a straightforward depth-first marking
6408 algorithm and so the recursion depth may be very high (a few
6409 tens of thousands is not uncommon). To minimize stack usage,
6410 a few cold paths are moved out to NO_INLINE functions above.
6411 In general, inlining them doesn't help you to gain more speed. */
6414 mark_object (Lisp_Object arg
)
6416 register Lisp_Object obj
;
6418 #if GC_CHECK_MARKED_OBJECTS
6421 ptrdiff_t cdr_count
= 0;
6430 last_marked
[last_marked_index
++] = obj
;
6431 if (last_marked_index
== LAST_MARKED_SIZE
)
6432 last_marked_index
= 0;
6434 /* Perform some sanity checks on the objects marked here. Abort if
6435 we encounter an object we know is bogus. This increases GC time
6437 #if GC_CHECK_MARKED_OBJECTS
6439 /* Check that the object pointed to by PO is known to be a Lisp
6440 structure allocated from the heap. */
6441 #define CHECK_ALLOCATED() \
6443 m = mem_find (po); \
6448 /* Check that the object pointed to by PO is live, using predicate
6450 #define CHECK_LIVE(LIVEP) \
6452 if (!LIVEP (m, po)) \
6456 /* Check both of the above conditions, for non-symbols. */
6457 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6459 CHECK_ALLOCATED (); \
6460 CHECK_LIVE (LIVEP); \
6463 /* Check both of the above conditions, for symbols. */
6464 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() \
6466 if (!c_symbol_p (ptr)) \
6468 CHECK_ALLOCATED (); \
6469 CHECK_LIVE (live_symbol_p); \
6473 #else /* not GC_CHECK_MARKED_OBJECTS */
6475 #define CHECK_LIVE(LIVEP) ((void) 0)
6476 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) ((void) 0)
6477 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() ((void) 0)
6479 #endif /* not GC_CHECK_MARKED_OBJECTS */
6481 switch (XTYPE (obj
))
6485 register struct Lisp_String
*ptr
= XSTRING (obj
);
6486 if (STRING_MARKED_P (ptr
))
6488 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6490 MARK_INTERVAL_TREE (ptr
->u
.s
.intervals
);
6491 #ifdef GC_CHECK_STRING_BYTES
6492 /* Check that the string size recorded in the string is the
6493 same as the one recorded in the sdata structure. */
6495 #endif /* GC_CHECK_STRING_BYTES */
6499 case Lisp_Vectorlike
:
6501 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6503 if (VECTOR_MARKED_P (ptr
))
6506 #if GC_CHECK_MARKED_OBJECTS
6508 if (m
== MEM_NIL
&& !SUBRP (obj
) && !main_thread_p (po
))
6510 #endif /* GC_CHECK_MARKED_OBJECTS */
6512 enum pvec_type pvectype
6513 = PSEUDOVECTOR_TYPE (ptr
);
6515 if (pvectype
!= PVEC_SUBR
6516 && pvectype
!= PVEC_BUFFER
6517 && !main_thread_p (po
))
6518 CHECK_LIVE (live_vector_p
);
6523 #if GC_CHECK_MARKED_OBJECTS
6532 #endif /* GC_CHECK_MARKED_OBJECTS */
6533 mark_buffer ((struct buffer
*) ptr
);
6537 /* Although we could treat this just like a vector, mark_compiled
6538 returns the COMPILED_CONSTANTS element, which is marked at the
6539 next iteration of goto-loop here. This is done to avoid a few
6540 recursive calls to mark_object. */
6541 obj
= mark_compiled (ptr
);
6548 struct frame
*f
= (struct frame
*) ptr
;
6550 mark_vectorlike (ptr
);
6551 mark_face_cache (f
->face_cache
);
6552 #ifdef HAVE_WINDOW_SYSTEM
6553 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6555 struct font
*font
= FRAME_FONT (f
);
6557 if (font
&& !VECTOR_MARKED_P (font
))
6558 mark_vectorlike ((struct Lisp_Vector
*) font
);
6566 struct window
*w
= (struct window
*) ptr
;
6568 mark_vectorlike (ptr
);
6570 /* Mark glyph matrices, if any. Marking window
6571 matrices is sufficient because frame matrices
6572 use the same glyph memory. */
6573 if (w
->current_matrix
)
6575 mark_glyph_matrix (w
->current_matrix
);
6576 mark_glyph_matrix (w
->desired_matrix
);
6579 /* Filter out killed buffers from both buffer lists
6580 in attempt to help GC to reclaim killed buffers faster.
6581 We can do it elsewhere for live windows, but this is the
6582 best place to do it for dead windows. */
6584 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6586 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6590 case PVEC_HASH_TABLE
:
6592 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6594 mark_vectorlike (ptr
);
6595 mark_object (h
->test
.name
);
6596 mark_object (h
->test
.user_hash_function
);
6597 mark_object (h
->test
.user_cmp_function
);
6598 /* If hash table is not weak, mark all keys and values.
6599 For weak tables, mark only the vector. */
6601 mark_object (h
->key_and_value
);
6603 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6607 case PVEC_CHAR_TABLE
:
6608 case PVEC_SUB_CHAR_TABLE
:
6609 mark_char_table (ptr
, (enum pvec_type
) pvectype
);
6612 case PVEC_BOOL_VECTOR
:
6613 /* No Lisp_Objects to mark in a bool vector. */
6624 mark_vectorlike (ptr
);
6631 struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6633 if (ptr
->u
.s
.gcmarkbit
)
6635 CHECK_ALLOCATED_AND_LIVE_SYMBOL ();
6636 ptr
->u
.s
.gcmarkbit
= 1;
6637 /* Attempt to catch bogus objects. */
6638 eassert (valid_lisp_object_p (ptr
->u
.s
.function
));
6639 mark_object (ptr
->u
.s
.function
);
6640 mark_object (ptr
->u
.s
.plist
);
6641 switch (ptr
->u
.s
.redirect
)
6643 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6644 case SYMBOL_VARALIAS
:
6647 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6651 case SYMBOL_LOCALIZED
:
6652 mark_localized_symbol (ptr
);
6654 case SYMBOL_FORWARDED
:
6655 /* If the value is forwarded to a buffer or keyboard field,
6656 these are marked when we see the corresponding object.
6657 And if it's forwarded to a C variable, either it's not
6658 a Lisp_Object var, or it's staticpro'd already. */
6660 default: emacs_abort ();
6662 if (!PURE_P (XSTRING (ptr
->u
.s
.name
)))
6663 MARK_STRING (XSTRING (ptr
->u
.s
.name
));
6664 MARK_INTERVAL_TREE (string_intervals (ptr
->u
.s
.name
));
6665 /* Inner loop to mark next symbol in this bucket, if any. */
6666 po
= ptr
= ptr
->u
.s
.next
;
6673 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6675 if (XMISCANY (obj
)->gcmarkbit
)
6678 switch (XMISCTYPE (obj
))
6680 case Lisp_Misc_Marker
:
6681 /* DO NOT mark thru the marker's chain.
6682 The buffer's markers chain does not preserve markers from gc;
6683 instead, markers are removed from the chain when freed by gc. */
6684 XMISCANY (obj
)->gcmarkbit
= 1;
6687 case Lisp_Misc_Save_Value
:
6688 XMISCANY (obj
)->gcmarkbit
= 1;
6689 mark_save_value (XSAVE_VALUE (obj
));
6692 case Lisp_Misc_Overlay
:
6693 mark_overlay (XOVERLAY (obj
));
6696 case Lisp_Misc_Finalizer
:
6697 XMISCANY (obj
)->gcmarkbit
= true;
6698 mark_object (XFINALIZER (obj
)->function
);
6702 case Lisp_Misc_User_Ptr
:
6703 XMISCANY (obj
)->gcmarkbit
= true;
6714 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6715 if (CONS_MARKED_P (ptr
))
6717 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6719 /* If the cdr is nil, avoid recursion for the car. */
6720 if (EQ (ptr
->u
.s
.u
.cdr
, Qnil
))
6726 mark_object (ptr
->u
.s
.car
);
6727 obj
= ptr
->u
.s
.u
.cdr
;
6729 if (cdr_count
== mark_object_loop_halt
)
6735 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6736 FLOAT_MARK (XFLOAT (obj
));
6747 #undef CHECK_ALLOCATED
6748 #undef CHECK_ALLOCATED_AND_LIVE
6750 /* Mark the Lisp pointers in the terminal objects.
6751 Called by Fgarbage_collect. */
6754 mark_terminals (void)
6757 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6759 eassert (t
->name
!= NULL
);
6760 #ifdef HAVE_WINDOW_SYSTEM
6761 /* If a terminal object is reachable from a stacpro'ed object,
6762 it might have been marked already. Make sure the image cache
6764 mark_image_cache (t
->image_cache
);
6765 #endif /* HAVE_WINDOW_SYSTEM */
6766 if (!VECTOR_MARKED_P (t
))
6767 mark_vectorlike ((struct Lisp_Vector
*)t
);
6773 /* Value is non-zero if OBJ will survive the current GC because it's
6774 either marked or does not need to be marked to survive. */
6777 survives_gc_p (Lisp_Object obj
)
6781 switch (XTYPE (obj
))
6788 survives_p
= XSYMBOL (obj
)->u
.s
.gcmarkbit
;
6792 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6796 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6799 case Lisp_Vectorlike
:
6800 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6804 survives_p
= CONS_MARKED_P (XCONS (obj
));
6808 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6815 return survives_p
|| PURE_P (XPNTR (obj
));
6821 NO_INLINE
/* For better stack traces */
6825 struct cons_block
*cblk
;
6826 struct cons_block
**cprev
= &cons_block
;
6827 int lim
= cons_block_index
;
6828 EMACS_INT num_free
= 0, num_used
= 0;
6832 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6836 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6838 /* Scan the mark bits an int at a time. */
6839 for (i
= 0; i
< ilim
; i
++)
6841 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6843 /* Fast path - all cons cells for this int are marked. */
6844 cblk
->gcmarkbits
[i
] = 0;
6845 num_used
+= BITS_PER_BITS_WORD
;
6849 /* Some cons cells for this int are not marked.
6850 Find which ones, and free them. */
6851 int start
, pos
, stop
;
6853 start
= i
* BITS_PER_BITS_WORD
;
6855 if (stop
> BITS_PER_BITS_WORD
)
6856 stop
= BITS_PER_BITS_WORD
;
6859 for (pos
= start
; pos
< stop
; pos
++)
6861 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6864 cblk
->conses
[pos
].u
.s
.u
.chain
= cons_free_list
;
6865 cons_free_list
= &cblk
->conses
[pos
];
6866 cons_free_list
->u
.s
.car
= Vdead
;
6871 CONS_UNMARK (&cblk
->conses
[pos
]);
6877 lim
= CONS_BLOCK_SIZE
;
6878 /* If this block contains only free conses and we have already
6879 seen more than two blocks worth of free conses then deallocate
6881 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6883 *cprev
= cblk
->next
;
6884 /* Unhook from the free list. */
6885 cons_free_list
= cblk
->conses
[0].u
.s
.u
.chain
;
6886 lisp_align_free (cblk
);
6890 num_free
+= this_free
;
6891 cprev
= &cblk
->next
;
6894 total_conses
= num_used
;
6895 total_free_conses
= num_free
;
6898 NO_INLINE
/* For better stack traces */
6902 register struct float_block
*fblk
;
6903 struct float_block
**fprev
= &float_block
;
6904 register int lim
= float_block_index
;
6905 EMACS_INT num_free
= 0, num_used
= 0;
6907 float_free_list
= 0;
6909 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6913 for (i
= 0; i
< lim
; i
++)
6914 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6917 fblk
->floats
[i
].u
.chain
= float_free_list
;
6918 float_free_list
= &fblk
->floats
[i
];
6923 FLOAT_UNMARK (&fblk
->floats
[i
]);
6925 lim
= FLOAT_BLOCK_SIZE
;
6926 /* If this block contains only free floats and we have already
6927 seen more than two blocks worth of free floats then deallocate
6929 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6931 *fprev
= fblk
->next
;
6932 /* Unhook from the free list. */
6933 float_free_list
= fblk
->floats
[0].u
.chain
;
6934 lisp_align_free (fblk
);
6938 num_free
+= this_free
;
6939 fprev
= &fblk
->next
;
6942 total_floats
= num_used
;
6943 total_free_floats
= num_free
;
6946 NO_INLINE
/* For better stack traces */
6948 sweep_intervals (void)
6950 register struct interval_block
*iblk
;
6951 struct interval_block
**iprev
= &interval_block
;
6952 register int lim
= interval_block_index
;
6953 EMACS_INT num_free
= 0, num_used
= 0;
6955 interval_free_list
= 0;
6957 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6962 for (i
= 0; i
< lim
; i
++)
6964 if (!iblk
->intervals
[i
].gcmarkbit
)
6966 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6967 interval_free_list
= &iblk
->intervals
[i
];
6973 iblk
->intervals
[i
].gcmarkbit
= 0;
6976 lim
= INTERVAL_BLOCK_SIZE
;
6977 /* If this block contains only free intervals and we have already
6978 seen more than two blocks worth of free intervals then
6979 deallocate this block. */
6980 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6982 *iprev
= iblk
->next
;
6983 /* Unhook from the free list. */
6984 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6989 num_free
+= this_free
;
6990 iprev
= &iblk
->next
;
6993 total_intervals
= num_used
;
6994 total_free_intervals
= num_free
;
6997 NO_INLINE
/* For better stack traces */
6999 sweep_symbols (void)
7001 struct symbol_block
*sblk
;
7002 struct symbol_block
**sprev
= &symbol_block
;
7003 int lim
= symbol_block_index
;
7004 EMACS_INT num_free
= 0, num_used
= ARRAYELTS (lispsym
);
7006 symbol_free_list
= NULL
;
7008 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
7009 lispsym
[i
].u
.s
.gcmarkbit
= 0;
7011 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
7014 struct Lisp_Symbol
*sym
= sblk
->symbols
;
7015 struct Lisp_Symbol
*end
= sym
+ lim
;
7017 for (; sym
< end
; ++sym
)
7019 if (!sym
->u
.s
.gcmarkbit
)
7021 if (sym
->u
.s
.redirect
== SYMBOL_LOCALIZED
)
7023 xfree (SYMBOL_BLV (sym
));
7024 /* At every GC we sweep all symbol_blocks and rebuild the
7025 symbol_free_list, so those symbols which stayed unused
7026 between the two will be re-swept.
7027 So we have to make sure we don't re-free this blv next
7028 time we sweep this symbol_block (bug#29066). */
7029 sym
->u
.s
.redirect
= SYMBOL_PLAINVAL
;
7031 sym
->u
.s
.next
= symbol_free_list
;
7032 symbol_free_list
= sym
;
7033 symbol_free_list
->u
.s
.function
= Vdead
;
7039 sym
->u
.s
.gcmarkbit
= 0;
7040 /* Attempt to catch bogus objects. */
7041 eassert (valid_lisp_object_p (sym
->u
.s
.function
));
7045 lim
= SYMBOL_BLOCK_SIZE
;
7046 /* If this block contains only free symbols and we have already
7047 seen more than two blocks worth of free symbols then deallocate
7049 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
7051 *sprev
= sblk
->next
;
7052 /* Unhook from the free list. */
7053 symbol_free_list
= sblk
->symbols
[0].u
.s
.next
;
7058 num_free
+= this_free
;
7059 sprev
= &sblk
->next
;
7062 total_symbols
= num_used
;
7063 total_free_symbols
= num_free
;
7066 NO_INLINE
/* For better stack traces. */
7070 register struct marker_block
*mblk
;
7071 struct marker_block
**mprev
= &marker_block
;
7072 register int lim
= marker_block_index
;
7073 EMACS_INT num_free
= 0, num_used
= 0;
7075 /* Put all unmarked misc's on free list. For a marker, first
7076 unchain it from the buffer it points into. */
7078 marker_free_list
= 0;
7080 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
7085 for (i
= 0; i
< lim
; i
++)
7087 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
7089 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
7090 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
7091 else if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Finalizer
)
7092 unchain_finalizer (&mblk
->markers
[i
].m
.u_finalizer
);
7094 else if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_User_Ptr
)
7096 struct Lisp_User_Ptr
*uptr
= &mblk
->markers
[i
].m
.u_user_ptr
;
7097 if (uptr
->finalizer
)
7098 uptr
->finalizer (uptr
->p
);
7101 /* Set the type of the freed object to Lisp_Misc_Free.
7102 We could leave the type alone, since nobody checks it,
7103 but this might catch bugs faster. */
7104 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
7105 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
7106 marker_free_list
= &mblk
->markers
[i
].m
;
7112 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
7115 lim
= MARKER_BLOCK_SIZE
;
7116 /* If this block contains only free markers and we have already
7117 seen more than two blocks worth of free markers then deallocate
7119 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
7121 *mprev
= mblk
->next
;
7122 /* Unhook from the free list. */
7123 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
7128 num_free
+= this_free
;
7129 mprev
= &mblk
->next
;
7133 total_markers
= num_used
;
7134 total_free_markers
= num_free
;
7137 NO_INLINE
/* For better stack traces */
7139 sweep_buffers (void)
7141 register struct buffer
*buffer
, **bprev
= &all_buffers
;
7144 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
7145 if (!VECTOR_MARKED_P (buffer
))
7147 *bprev
= buffer
->next
;
7152 VECTOR_UNMARK (buffer
);
7153 /* Do not use buffer_(set|get)_intervals here. */
7154 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
7156 bprev
= &buffer
->next
;
7160 /* Sweep: find all structures not marked, and free them. */
7164 /* Remove or mark entries in weak hash tables.
7165 This must be done before any object is unmarked. */
7166 sweep_weak_hash_tables ();
7169 check_string_bytes (!noninteractive
);
7177 check_string_bytes (!noninteractive
);
7180 DEFUN ("memory-info", Fmemory_info
, Smemory_info
, 0, 0, 0,
7181 doc
: /* Return a list of (TOTAL-RAM FREE-RAM TOTAL-SWAP FREE-SWAP).
7182 All values are in Kbytes. If there is no swap space,
7183 last two values are zero. If the system is not supported
7184 or memory information can't be obtained, return nil. */)
7187 #if defined HAVE_LINUX_SYSINFO
7193 #ifdef LINUX_SYSINFO_UNIT
7194 units
= si
.mem_unit
;
7198 return list4i ((uintmax_t) si
.totalram
* units
/ 1024,
7199 (uintmax_t) si
.freeram
* units
/ 1024,
7200 (uintmax_t) si
.totalswap
* units
/ 1024,
7201 (uintmax_t) si
.freeswap
* units
/ 1024);
7202 #elif defined WINDOWSNT
7203 unsigned long long totalram
, freeram
, totalswap
, freeswap
;
7205 if (w32_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
7206 return list4i ((uintmax_t) totalram
/ 1024,
7207 (uintmax_t) freeram
/ 1024,
7208 (uintmax_t) totalswap
/ 1024,
7209 (uintmax_t) freeswap
/ 1024);
7213 unsigned long totalram
, freeram
, totalswap
, freeswap
;
7215 if (dos_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
7216 return list4i ((uintmax_t) totalram
/ 1024,
7217 (uintmax_t) freeram
/ 1024,
7218 (uintmax_t) totalswap
/ 1024,
7219 (uintmax_t) freeswap
/ 1024);
7222 #else /* not HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
7223 /* FIXME: add more systems. */
7225 #endif /* HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
7228 /* Debugging aids. */
7230 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
7231 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
7232 This may be helpful in debugging Emacs's memory usage.
7233 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
7238 #if defined HAVE_NS || defined __APPLE__ || !HAVE_SBRK
7239 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
7242 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
7248 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
7249 doc
: /* Return a list of counters that measure how much consing there has been.
7250 Each of these counters increments for a certain kind of object.
7251 The counters wrap around from the largest positive integer to zero.
7252 Garbage collection does not decrease them.
7253 The elements of the value are as follows:
7254 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
7255 All are in units of 1 = one object consed
7256 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
7258 MISCS include overlays, markers, and some internal types.
7259 Frames, windows, buffers, and subprocesses count as vectors
7260 (but the contents of a buffer's text do not count here). */)
7263 return listn (CONSTYPE_HEAP
, 8,
7264 bounded_number (cons_cells_consed
),
7265 bounded_number (floats_consed
),
7266 bounded_number (vector_cells_consed
),
7267 bounded_number (symbols_consed
),
7268 bounded_number (string_chars_consed
),
7269 bounded_number (misc_objects_consed
),
7270 bounded_number (intervals_consed
),
7271 bounded_number (strings_consed
));
7275 symbol_uses_obj (Lisp_Object symbol
, Lisp_Object obj
)
7277 struct Lisp_Symbol
*sym
= XSYMBOL (symbol
);
7278 Lisp_Object val
= find_symbol_value (symbol
);
7279 return (EQ (val
, obj
)
7280 || EQ (sym
->u
.s
.function
, obj
)
7281 || (!NILP (sym
->u
.s
.function
)
7282 && COMPILEDP (sym
->u
.s
.function
)
7283 && EQ (AREF (sym
->u
.s
.function
, COMPILED_BYTECODE
), obj
))
7286 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)));
7289 /* Find at most FIND_MAX symbols which have OBJ as their value or
7290 function. This is used in gdbinit's `xwhichsymbols' command. */
7293 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
7295 struct symbol_block
*sblk
;
7296 ptrdiff_t gc_count
= inhibit_garbage_collection ();
7297 Lisp_Object found
= Qnil
;
7301 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
7303 Lisp_Object sym
= builtin_lisp_symbol (i
);
7304 if (symbol_uses_obj (sym
, obj
))
7306 found
= Fcons (sym
, found
);
7307 if (--find_max
== 0)
7312 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
7314 struct Lisp_Symbol
*asym
= sblk
->symbols
;
7317 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, asym
++)
7319 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
7322 Lisp_Object sym
= make_lisp_symbol (asym
);
7323 if (symbol_uses_obj (sym
, obj
))
7325 found
= Fcons (sym
, found
);
7326 if (--find_max
== 0)
7334 unbind_to (gc_count
, Qnil
);
7338 #ifdef SUSPICIOUS_OBJECT_CHECKING
7341 find_suspicious_object_in_range (void *begin
, void *end
)
7343 char *begin_a
= begin
;
7347 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7349 char *suspicious_object
= suspicious_objects
[i
];
7350 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
7351 return suspicious_object
;
7358 note_suspicious_free (void *ptr
)
7360 struct suspicious_free_record
*rec
;
7362 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
7363 if (suspicious_free_history_index
==
7364 ARRAYELTS (suspicious_free_history
))
7366 suspicious_free_history_index
= 0;
7369 memset (rec
, 0, sizeof (*rec
));
7370 rec
->suspicious_object
= ptr
;
7371 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
7375 detect_suspicious_free (void *ptr
)
7379 eassert (ptr
!= NULL
);
7381 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7382 if (suspicious_objects
[i
] == ptr
)
7384 note_suspicious_free (ptr
);
7385 suspicious_objects
[i
] = NULL
;
7389 #endif /* SUSPICIOUS_OBJECT_CHECKING */
7391 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
7392 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
7393 If Emacs is compiled with suspicious object checking, capture
7394 a stack trace when OBJ is freed in order to help track down
7395 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
7398 #ifdef SUSPICIOUS_OBJECT_CHECKING
7399 /* Right now, we care only about vectors. */
7400 if (VECTORLIKEP (obj
))
7402 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
7403 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
7404 suspicious_object_index
= 0;
7410 #ifdef ENABLE_CHECKING
7412 bool suppress_checking
;
7415 die (const char *msg
, const char *file
, int line
)
7417 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
7419 terminate_due_to_signal (SIGABRT
, INT_MAX
);
7422 #endif /* ENABLE_CHECKING */
7424 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
7426 /* Stress alloca with inconveniently sized requests and check
7427 whether all allocated areas may be used for Lisp_Object. */
7429 NO_INLINE
static void
7430 verify_alloca (void)
7433 enum { ALLOCA_CHECK_MAX
= 256 };
7434 /* Start from size of the smallest Lisp object. */
7435 for (i
= sizeof (struct Lisp_Cons
); i
<= ALLOCA_CHECK_MAX
; i
++)
7437 void *ptr
= alloca (i
);
7438 make_lisp_ptr (ptr
, Lisp_Cons
);
7442 #else /* not ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7444 #define verify_alloca() ((void) 0)
7446 #endif /* ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7448 /* Initialization. */
7451 init_alloc_once (void)
7453 /* Even though Qt's contents are not set up, its address is known. */
7457 pure_size
= PURESIZE
;
7460 init_finalizer_list (&finalizers
);
7461 init_finalizer_list (&doomed_finalizers
);
7464 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
7466 #ifdef DOUG_LEA_MALLOC
7467 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
7468 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
7469 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
7474 refill_memory_reserve ();
7475 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
7481 Vgc_elapsed
= make_float (0.0);
7485 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
7490 syms_of_alloc (void)
7492 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
7493 doc
: /* Number of bytes of consing between garbage collections.
7494 Garbage collection can happen automatically once this many bytes have been
7495 allocated since the last garbage collection. All data types count.
7497 Garbage collection happens automatically only when `eval' is called.
7499 By binding this temporarily to a large number, you can effectively
7500 prevent garbage collection during a part of the program.
7501 See also `gc-cons-percentage'. */);
7503 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
7504 doc
: /* Portion of the heap used for allocation.
7505 Garbage collection can happen automatically once this portion of the heap
7506 has been allocated since the last garbage collection.
7507 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
7508 Vgc_cons_percentage
= make_float (0.1);
7510 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
7511 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
7513 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
7514 doc
: /* Number of cons cells that have been consed so far. */);
7516 DEFVAR_INT ("floats-consed", floats_consed
,
7517 doc
: /* Number of floats that have been consed so far. */);
7519 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7520 doc
: /* Number of vector cells that have been consed so far. */);
7522 DEFVAR_INT ("symbols-consed", symbols_consed
,
7523 doc
: /* Number of symbols that have been consed so far. */);
7524 symbols_consed
+= ARRAYELTS (lispsym
);
7526 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7527 doc
: /* Number of string characters that have been consed so far. */);
7529 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7530 doc
: /* Number of miscellaneous objects that have been consed so far.
7531 These include markers and overlays, plus certain objects not visible
7534 DEFVAR_INT ("intervals-consed", intervals_consed
,
7535 doc
: /* Number of intervals that have been consed so far. */);
7537 DEFVAR_INT ("strings-consed", strings_consed
,
7538 doc
: /* Number of strings that have been consed so far. */);
7540 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7541 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7542 This means that certain objects should be allocated in shared (pure) space.
7543 It can also be set to a hash-table, in which case this table is used to
7544 do hash-consing of the objects allocated to pure space. */);
7546 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7547 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7548 garbage_collection_messages
= 0;
7550 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7551 doc
: /* Hook run after garbage collection has finished. */);
7552 Vpost_gc_hook
= Qnil
;
7553 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7555 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7556 doc
: /* Precomputed `signal' argument for memory-full error. */);
7557 /* We build this in advance because if we wait until we need it, we might
7558 not be able to allocate the memory to hold it. */
7560 = listn (CONSTYPE_PURE
, 2, Qerror
,
7561 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7563 DEFVAR_LISP ("memory-full", Vmemory_full
,
7564 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7565 Vmemory_full
= Qnil
;
7567 DEFSYM (Qconses
, "conses");
7568 DEFSYM (Qsymbols
, "symbols");
7569 DEFSYM (Qmiscs
, "miscs");
7570 DEFSYM (Qstrings
, "strings");
7571 DEFSYM (Qvectors
, "vectors");
7572 DEFSYM (Qfloats
, "floats");
7573 DEFSYM (Qintervals
, "intervals");
7574 DEFSYM (Qbuffers
, "buffers");
7575 DEFSYM (Qstring_bytes
, "string-bytes");
7576 DEFSYM (Qvector_slots
, "vector-slots");
7577 DEFSYM (Qheap
, "heap");
7578 DEFSYM (QAutomatic_GC
, "Automatic GC");
7580 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7581 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7583 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7584 doc
: /* Accumulated time elapsed in garbage collections.
7585 The time is in seconds as a floating point value. */);
7586 DEFVAR_INT ("gcs-done", gcs_done
,
7587 doc
: /* Accumulated number of garbage collections done. */);
7593 defsubr (&Sbool_vector
);
7594 defsubr (&Smake_byte_code
);
7595 defsubr (&Smake_list
);
7596 defsubr (&Smake_vector
);
7597 defsubr (&Smake_record
);
7598 defsubr (&Smake_string
);
7599 defsubr (&Smake_bool_vector
);
7600 defsubr (&Smake_symbol
);
7601 defsubr (&Smake_marker
);
7602 defsubr (&Smake_finalizer
);
7603 defsubr (&Spurecopy
);
7604 defsubr (&Sgarbage_collect
);
7605 defsubr (&Smemory_limit
);
7606 defsubr (&Smemory_info
);
7607 defsubr (&Smemory_use_counts
);
7608 defsubr (&Ssuspicious_object
);
7611 /* When compiled with GCC, GDB might say "No enum type named
7612 pvec_type" if we don't have at least one symbol with that type, and
7613 then xbacktrace could fail. Similarly for the other enums and
7614 their values. Some non-GCC compilers don't like these constructs. */
7618 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7619 enum char_table_specials char_table_specials
;
7620 enum char_bits char_bits
;
7621 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7622 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7623 enum Lisp_Bits Lisp_Bits
;
7624 enum Lisp_Compiled Lisp_Compiled
;
7625 enum maxargs maxargs
;
7626 enum MAX_ALLOCA MAX_ALLOCA
;
7627 enum More_Lisp_Bits More_Lisp_Bits
;
7628 enum pvec_type pvec_type
;
7629 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7630 #endif /* __GNUC__ */