1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2016 Free Software
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <limits.h> /* For CHAR_BIT. */
25 #include <signal.h> /* For SIGABRT, SIGDANGER. */
32 #include "dispextern.h"
33 #include "intervals.h"
37 #include "character.h"
42 #include "blockinput.h"
43 #include "termhooks.h" /* For struct terminal. */
44 #ifdef HAVE_WINDOW_SYSTEM
46 #endif /* HAVE_WINDOW_SYSTEM */
49 #include <execinfo.h> /* For backtrace. */
51 #ifdef HAVE_LINUX_SYSINFO
52 #include <sys/sysinfo.h>
56 #include "dosfns.h" /* For dos_memory_info. */
63 #if (defined ENABLE_CHECKING \
64 && defined HAVE_VALGRIND_VALGRIND_H \
65 && !defined USE_VALGRIND)
66 # define USE_VALGRIND 1
70 #include <valgrind/valgrind.h>
71 #include <valgrind/memcheck.h>
72 static bool valgrind_p
;
75 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects. */
77 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
78 memory. Can do this only if using gmalloc.c and if not checking
81 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
82 || defined HYBRID_MALLOC || defined GC_CHECK_MARKED_OBJECTS)
83 #undef GC_MALLOC_CHECK
94 #include "w32heap.h" /* for sbrk */
97 #if defined DOUG_LEA_MALLOC || defined GNU_LINUX
98 /* The address where the heap starts. */
109 #ifdef DOUG_LEA_MALLOC
111 /* Specify maximum number of areas to mmap. It would be nice to use a
112 value that explicitly means "no limit". */
114 #define MMAP_MAX_AREAS 100000000
116 /* A pointer to the memory allocated that copies that static data
117 inside glibc's malloc. */
118 static void *malloc_state_ptr
;
120 /* Restore the dumped malloc state. Because malloc can be invoked
121 even before main (e.g. by the dynamic linker), the dumped malloc
122 state must be restored as early as possible using this special hook. */
124 malloc_initialize_hook (void)
126 static bool malloc_using_checking
;
131 malloc_using_checking
= getenv ("MALLOC_CHECK_") != NULL
;
135 if (!malloc_using_checking
)
137 /* Work around a bug in glibc's malloc. MALLOC_CHECK_ must be
138 ignored if the heap to be restored was constructed without
139 malloc checking. Can't use unsetenv, since that calls malloc. */
143 if (strncmp (*p
, "MALLOC_CHECK_=", 14) == 0)
153 malloc_set_state (malloc_state_ptr
);
154 # ifndef XMALLOC_OVERRUN_CHECK
155 alloc_unexec_post ();
160 /* Declare the malloc initialization hook, which runs before 'main' starts.
161 EXTERNALLY_VISIBLE works around Bug#22522. */
162 # ifndef __MALLOC_HOOK_VOLATILE
163 # define __MALLOC_HOOK_VOLATILE
165 voidfuncptr __MALLOC_HOOK_VOLATILE __malloc_initialize_hook EXTERNALLY_VISIBLE
166 = malloc_initialize_hook
;
170 /* Allocator-related actions to do just before and after unexec. */
173 alloc_unexec_pre (void)
175 #ifdef DOUG_LEA_MALLOC
176 malloc_state_ptr
= malloc_get_state ();
179 bss_sbrk_did_unexec
= true;
184 alloc_unexec_post (void)
186 #ifdef DOUG_LEA_MALLOC
187 free (malloc_state_ptr
);
190 bss_sbrk_did_unexec
= false;
194 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
195 to a struct Lisp_String. */
197 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
198 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
199 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
201 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
202 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
203 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
205 /* Default value of gc_cons_threshold (see below). */
207 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
209 /* Global variables. */
210 struct emacs_globals globals
;
212 /* Number of bytes of consing done since the last gc. */
214 EMACS_INT consing_since_gc
;
216 /* Similar minimum, computed from Vgc_cons_percentage. */
218 EMACS_INT gc_relative_threshold
;
220 /* Minimum number of bytes of consing since GC before next GC,
221 when memory is full. */
223 EMACS_INT memory_full_cons_threshold
;
225 /* True during GC. */
229 /* True means abort if try to GC.
230 This is for code which is written on the assumption that
231 no GC will happen, so as to verify that assumption. */
235 /* Number of live and free conses etc. */
237 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
238 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
239 static EMACS_INT total_free_floats
, total_floats
;
241 /* Points to memory space allocated as "spare", to be freed if we run
242 out of memory. We keep one large block, four cons-blocks, and
243 two string blocks. */
245 static char *spare_memory
[7];
247 /* Amount of spare memory to keep in large reserve block, or to see
248 whether this much is available when malloc fails on a larger request. */
250 #define SPARE_MEMORY (1 << 14)
252 /* Initialize it to a nonzero value to force it into data space
253 (rather than bss space). That way unexec will remap it into text
254 space (pure), on some systems. We have not implemented the
255 remapping on more recent systems because this is less important
256 nowadays than in the days of small memories and timesharing. */
258 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
259 #define PUREBEG (char *) pure
261 /* Pointer to the pure area, and its size. */
263 static char *purebeg
;
264 static ptrdiff_t pure_size
;
266 /* Number of bytes of pure storage used before pure storage overflowed.
267 If this is non-zero, this implies that an overflow occurred. */
269 static ptrdiff_t pure_bytes_used_before_overflow
;
271 /* Index in pure at which next pure Lisp object will be allocated.. */
273 static ptrdiff_t pure_bytes_used_lisp
;
275 /* Number of bytes allocated for non-Lisp objects in pure storage. */
277 static ptrdiff_t pure_bytes_used_non_lisp
;
279 /* If nonzero, this is a warning delivered by malloc and not yet
282 const char *pending_malloc_warning
;
284 #if 0 /* Normally, pointer sanity only on request... */
285 #ifdef ENABLE_CHECKING
286 #define SUSPICIOUS_OBJECT_CHECKING 1
290 /* ... but unconditionally use SUSPICIOUS_OBJECT_CHECKING while the GC
291 bug is unresolved. */
292 #define SUSPICIOUS_OBJECT_CHECKING 1
294 #ifdef SUSPICIOUS_OBJECT_CHECKING
295 struct suspicious_free_record
297 void *suspicious_object
;
298 void *backtrace
[128];
300 static void *suspicious_objects
[32];
301 static int suspicious_object_index
;
302 struct suspicious_free_record suspicious_free_history
[64] EXTERNALLY_VISIBLE
;
303 static int suspicious_free_history_index
;
304 /* Find the first currently-monitored suspicious pointer in range
305 [begin,end) or NULL if no such pointer exists. */
306 static void *find_suspicious_object_in_range (void *begin
, void *end
);
307 static void detect_suspicious_free (void *ptr
);
309 # define find_suspicious_object_in_range(begin, end) NULL
310 # define detect_suspicious_free(ptr) (void)
313 /* Maximum amount of C stack to save when a GC happens. */
315 #ifndef MAX_SAVE_STACK
316 #define MAX_SAVE_STACK 16000
319 /* Buffer in which we save a copy of the C stack at each GC. */
321 #if MAX_SAVE_STACK > 0
322 static char *stack_copy
;
323 static ptrdiff_t stack_copy_size
;
325 /* Copy to DEST a block of memory from SRC of size SIZE bytes,
326 avoiding any address sanitization. */
328 static void * ATTRIBUTE_NO_SANITIZE_ADDRESS
329 no_sanitize_memcpy (void *dest
, void const *src
, size_t size
)
331 if (! ADDRESS_SANITIZER
)
332 return memcpy (dest
, src
, size
);
338 for (i
= 0; i
< size
; i
++)
344 #endif /* MAX_SAVE_STACK > 0 */
346 static void mark_terminals (void);
347 static void gc_sweep (void);
348 static Lisp_Object
make_pure_vector (ptrdiff_t);
349 static void mark_buffer (struct buffer
*);
351 #if !defined REL_ALLOC || defined SYSTEM_MALLOC || defined HYBRID_MALLOC
352 static void refill_memory_reserve (void);
354 static void compact_small_strings (void);
355 static void free_large_strings (void);
356 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
358 /* When scanning the C stack for live Lisp objects, Emacs keeps track of
359 what memory allocated via lisp_malloc and lisp_align_malloc is intended
360 for what purpose. This enumeration specifies the type of memory. */
371 /* Since all non-bool pseudovectors are small enough to be
372 allocated from vector blocks, this memory type denotes
373 large regular vectors and large bool pseudovectors. */
375 /* Special type to denote vector blocks. */
376 MEM_TYPE_VECTOR_BLOCK
,
377 /* Special type to denote reserved memory. */
381 /* A unique object in pure space used to make some Lisp objects
382 on free lists recognizable in O(1). */
384 static Lisp_Object Vdead
;
385 #define DEADP(x) EQ (x, Vdead)
387 #ifdef GC_MALLOC_CHECK
389 enum mem_type allocated_mem_type
;
391 #endif /* GC_MALLOC_CHECK */
393 /* A node in the red-black tree describing allocated memory containing
394 Lisp data. Each such block is recorded with its start and end
395 address when it is allocated, and removed from the tree when it
398 A red-black tree is a balanced binary tree with the following
401 1. Every node is either red or black.
402 2. Every leaf is black.
403 3. If a node is red, then both of its children are black.
404 4. Every simple path from a node to a descendant leaf contains
405 the same number of black nodes.
406 5. The root is always black.
408 When nodes are inserted into the tree, or deleted from the tree,
409 the tree is "fixed" so that these properties are always true.
411 A red-black tree with N internal nodes has height at most 2
412 log(N+1). Searches, insertions and deletions are done in O(log N).
413 Please see a text book about data structures for a detailed
414 description of red-black trees. Any book worth its salt should
419 /* Children of this node. These pointers are never NULL. When there
420 is no child, the value is MEM_NIL, which points to a dummy node. */
421 struct mem_node
*left
, *right
;
423 /* The parent of this node. In the root node, this is NULL. */
424 struct mem_node
*parent
;
426 /* Start and end of allocated region. */
430 enum {MEM_BLACK
, MEM_RED
} color
;
436 /* Base address of stack. Set in main. */
438 Lisp_Object
*stack_base
;
440 /* Root of the tree describing allocated Lisp memory. */
442 static struct mem_node
*mem_root
;
444 /* Lowest and highest known address in the heap. */
446 static void *min_heap_address
, *max_heap_address
;
448 /* Sentinel node of the tree. */
450 static struct mem_node mem_z
;
451 #define MEM_NIL &mem_z
453 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
454 static void mem_insert_fixup (struct mem_node
*);
455 static void mem_rotate_left (struct mem_node
*);
456 static void mem_rotate_right (struct mem_node
*);
457 static void mem_delete (struct mem_node
*);
458 static void mem_delete_fixup (struct mem_node
*);
459 static struct mem_node
*mem_find (void *);
465 /* Addresses of staticpro'd variables. Initialize it to a nonzero
466 value; otherwise some compilers put it into BSS. */
468 enum { NSTATICS
= 2048 };
469 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
471 /* Index of next unused slot in staticvec. */
473 static int staticidx
;
475 static void *pure_alloc (size_t, int);
477 /* Return X rounded to the next multiple of Y. Arguments should not
478 have side effects, as they are evaluated more than once. Assume X
479 + Y - 1 does not overflow. Tune for Y being a power of 2. */
481 #define ROUNDUP(x, y) ((y) & ((y) - 1) \
482 ? ((x) + (y) - 1) - ((x) + (y) - 1) % (y) \
483 : ((x) + (y) - 1) & ~ ((y) - 1))
485 /* Return PTR rounded up to the next multiple of ALIGNMENT. */
488 ALIGN (void *ptr
, int alignment
)
490 return (void *) ROUNDUP ((uintptr_t) ptr
, alignment
);
493 /* Extract the pointer hidden within A, if A is not a symbol.
494 If A is a symbol, extract the hidden pointer's offset from lispsym,
495 converted to void *. */
497 #define macro_XPNTR_OR_SYMBOL_OFFSET(a) \
498 ((void *) (intptr_t) (USE_LSB_TAG ? XLI (a) - XTYPE (a) : XLI (a) & VALMASK))
500 /* Extract the pointer hidden within A. */
502 #define macro_XPNTR(a) \
503 ((void *) ((intptr_t) XPNTR_OR_SYMBOL_OFFSET (a) \
504 + (SYMBOLP (a) ? (char *) lispsym : NULL)))
506 /* For pointer access, define XPNTR and XPNTR_OR_SYMBOL_OFFSET as
507 functions, as functions are cleaner and can be used in debuggers.
508 Also, define them as macros if being compiled with GCC without
509 optimization, for performance in that case. The macro_* names are
510 private to this section of code. */
512 static ATTRIBUTE_UNUSED
void *
513 XPNTR_OR_SYMBOL_OFFSET (Lisp_Object a
)
515 return macro_XPNTR_OR_SYMBOL_OFFSET (a
);
517 static ATTRIBUTE_UNUSED
void *
518 XPNTR (Lisp_Object a
)
520 return macro_XPNTR (a
);
523 #if DEFINE_KEY_OPS_AS_MACROS
524 # define XPNTR_OR_SYMBOL_OFFSET(a) macro_XPNTR_OR_SYMBOL_OFFSET (a)
525 # define XPNTR(a) macro_XPNTR (a)
529 XFLOAT_INIT (Lisp_Object f
, double n
)
531 XFLOAT (f
)->u
.data
= n
;
534 #ifdef DOUG_LEA_MALLOC
536 pointers_fit_in_lispobj_p (void)
538 return (UINTPTR_MAX
<= VAL_MAX
) || USE_LSB_TAG
;
542 mmap_lisp_allowed_p (void)
544 /* If we can't store all memory addresses in our lisp objects, it's
545 risky to let the heap use mmap and give us addresses from all
546 over our address space. We also can't use mmap for lisp objects
547 if we might dump: unexec doesn't preserve the contents of mmapped
549 return pointers_fit_in_lispobj_p () && !might_dump
;
553 /* Head of a circularly-linked list of extant finalizers. */
554 static struct Lisp_Finalizer finalizers
;
556 /* Head of a circularly-linked list of finalizers that must be invoked
557 because we deemed them unreachable. This list must be global, and
558 not a local inside garbage_collect_1, in case we GC again while
559 running finalizers. */
560 static struct Lisp_Finalizer doomed_finalizers
;
563 /************************************************************************
565 ************************************************************************/
567 #if defined SIGDANGER || (!defined SYSTEM_MALLOC && !defined HYBRID_MALLOC)
569 /* Function malloc calls this if it finds we are near exhausting storage. */
572 malloc_warning (const char *str
)
574 pending_malloc_warning
= str
;
579 /* Display an already-pending malloc warning. */
582 display_malloc_warning (void)
584 call3 (intern ("display-warning"),
586 build_string (pending_malloc_warning
),
587 intern ("emergency"));
588 pending_malloc_warning
= 0;
591 /* Called if we can't allocate relocatable space for a buffer. */
594 buffer_memory_full (ptrdiff_t nbytes
)
596 /* If buffers use the relocating allocator, no need to free
597 spare_memory, because we may have plenty of malloc space left
598 that we could get, and if we don't, the malloc that fails will
599 itself cause spare_memory to be freed. If buffers don't use the
600 relocating allocator, treat this like any other failing
604 memory_full (nbytes
);
606 /* This used to call error, but if we've run out of memory, we could
607 get infinite recursion trying to build the string. */
608 xsignal (Qnil
, Vmemory_signal_data
);
612 /* A common multiple of the positive integers A and B. Ideally this
613 would be the least common multiple, but there's no way to do that
614 as a constant expression in C, so do the best that we can easily do. */
615 #define COMMON_MULTIPLE(a, b) \
616 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
618 #ifndef XMALLOC_OVERRUN_CHECK
619 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
622 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
625 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
626 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
627 block size in little-endian order. The trailer consists of
628 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
630 The header is used to detect whether this block has been allocated
631 through these functions, as some low-level libc functions may
632 bypass the malloc hooks. */
634 #define XMALLOC_OVERRUN_CHECK_SIZE 16
635 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
636 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
638 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
639 hold a size_t value and (2) the header size is a multiple of the
640 alignment that Emacs needs for C types and for USE_LSB_TAG. */
641 #define XMALLOC_BASE_ALIGNMENT alignof (max_align_t)
643 #define XMALLOC_HEADER_ALIGNMENT \
644 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
645 #define XMALLOC_OVERRUN_SIZE_SIZE \
646 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
647 + XMALLOC_HEADER_ALIGNMENT - 1) \
648 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
649 - XMALLOC_OVERRUN_CHECK_SIZE)
651 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
652 { '\x9a', '\x9b', '\xae', '\xaf',
653 '\xbf', '\xbe', '\xce', '\xcf',
654 '\xea', '\xeb', '\xec', '\xed',
655 '\xdf', '\xde', '\x9c', '\x9d' };
657 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
658 { '\xaa', '\xab', '\xac', '\xad',
659 '\xba', '\xbb', '\xbc', '\xbd',
660 '\xca', '\xcb', '\xcc', '\xcd',
661 '\xda', '\xdb', '\xdc', '\xdd' };
663 /* Insert and extract the block size in the header. */
666 xmalloc_put_size (unsigned char *ptr
, size_t size
)
669 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
671 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
677 xmalloc_get_size (unsigned char *ptr
)
681 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
682 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
691 /* Like malloc, but wraps allocated block with header and trailer. */
694 overrun_check_malloc (size_t size
)
696 register unsigned char *val
;
697 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
700 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
703 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
704 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
705 xmalloc_put_size (val
, size
);
706 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
707 XMALLOC_OVERRUN_CHECK_SIZE
);
713 /* Like realloc, but checks old block for overrun, and wraps new block
714 with header and trailer. */
717 overrun_check_realloc (void *block
, size_t size
)
719 register unsigned char *val
= (unsigned char *) block
;
720 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
724 && memcmp (xmalloc_overrun_check_header
,
725 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
726 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
728 size_t osize
= xmalloc_get_size (val
);
729 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
730 XMALLOC_OVERRUN_CHECK_SIZE
))
732 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
733 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
734 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
737 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
741 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
742 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
743 xmalloc_put_size (val
, size
);
744 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
745 XMALLOC_OVERRUN_CHECK_SIZE
);
750 /* Like free, but checks block for overrun. */
753 overrun_check_free (void *block
)
755 unsigned char *val
= (unsigned char *) block
;
758 && memcmp (xmalloc_overrun_check_header
,
759 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
760 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
762 size_t osize
= xmalloc_get_size (val
);
763 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
764 XMALLOC_OVERRUN_CHECK_SIZE
))
766 #ifdef XMALLOC_CLEAR_FREE_MEMORY
767 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
768 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
770 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
771 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
772 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
782 #define malloc overrun_check_malloc
783 #define realloc overrun_check_realloc
784 #define free overrun_check_free
787 /* If compiled with XMALLOC_BLOCK_INPUT_CHECK, define a symbol
788 BLOCK_INPUT_IN_MEMORY_ALLOCATORS that is visible to the debugger.
789 If that variable is set, block input while in one of Emacs's memory
790 allocation functions. There should be no need for this debugging
791 option, since signal handlers do not allocate memory, but Emacs
792 formerly allocated memory in signal handlers and this compile-time
793 option remains as a way to help debug the issue should it rear its
795 #ifdef XMALLOC_BLOCK_INPUT_CHECK
796 bool block_input_in_memory_allocators EXTERNALLY_VISIBLE
;
798 malloc_block_input (void)
800 if (block_input_in_memory_allocators
)
804 malloc_unblock_input (void)
806 if (block_input_in_memory_allocators
)
809 # define MALLOC_BLOCK_INPUT malloc_block_input ()
810 # define MALLOC_UNBLOCK_INPUT malloc_unblock_input ()
812 # define MALLOC_BLOCK_INPUT ((void) 0)
813 # define MALLOC_UNBLOCK_INPUT ((void) 0)
816 #define MALLOC_PROBE(size) \
818 if (profiler_memory_running) \
819 malloc_probe (size); \
823 /* Like malloc but check for no memory and block interrupt input.. */
826 xmalloc (size_t size
)
832 MALLOC_UNBLOCK_INPUT
;
840 /* Like the above, but zeroes out the memory just allocated. */
843 xzalloc (size_t size
)
849 MALLOC_UNBLOCK_INPUT
;
853 memset (val
, 0, size
);
858 /* Like realloc but check for no memory and block interrupt input.. */
861 xrealloc (void *block
, size_t size
)
866 /* We must call malloc explicitly when BLOCK is 0, since some
867 reallocs don't do this. */
871 val
= realloc (block
, size
);
872 MALLOC_UNBLOCK_INPUT
;
881 /* Like free but block interrupt input. */
890 MALLOC_UNBLOCK_INPUT
;
891 /* We don't call refill_memory_reserve here
892 because in practice the call in r_alloc_free seems to suffice. */
896 /* Other parts of Emacs pass large int values to allocator functions
897 expecting ptrdiff_t. This is portable in practice, but check it to
899 verify (INT_MAX
<= PTRDIFF_MAX
);
902 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
903 Signal an error on memory exhaustion, and block interrupt input. */
906 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
908 eassert (0 <= nitems
&& 0 < item_size
);
910 if (INT_MULTIPLY_WRAPV (nitems
, item_size
, &nbytes
) || SIZE_MAX
< nbytes
)
911 memory_full (SIZE_MAX
);
912 return xmalloc (nbytes
);
916 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
917 Signal an error on memory exhaustion, and block interrupt input. */
920 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
922 eassert (0 <= nitems
&& 0 < item_size
);
924 if (INT_MULTIPLY_WRAPV (nitems
, item_size
, &nbytes
) || SIZE_MAX
< nbytes
)
925 memory_full (SIZE_MAX
);
926 return xrealloc (pa
, nbytes
);
930 /* Grow PA, which points to an array of *NITEMS items, and return the
931 location of the reallocated array, updating *NITEMS to reflect its
932 new size. The new array will contain at least NITEMS_INCR_MIN more
933 items, but will not contain more than NITEMS_MAX items total.
934 ITEM_SIZE is the size of each item, in bytes.
936 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
937 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
940 If PA is null, then allocate a new array instead of reallocating
943 Block interrupt input as needed. If memory exhaustion occurs, set
944 *NITEMS to zero if PA is null, and signal an error (i.e., do not
947 Thus, to grow an array A without saving its old contents, do
948 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
949 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
950 and signals an error, and later this code is reexecuted and
951 attempts to free A. */
954 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
955 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
957 ptrdiff_t n0
= *nitems
;
958 eassume (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n0
&& -1 <= nitems_max
);
960 /* The approximate size to use for initial small allocation
961 requests. This is the largest "small" request for the GNU C
963 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
965 /* If the array is tiny, grow it to about (but no greater than)
966 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%.
967 Adjust the growth according to three constraints: NITEMS_INCR_MIN,
968 NITEMS_MAX, and what the C language can represent safely. */
971 if (INT_ADD_WRAPV (n0
, n0
>> 1, &n
))
973 if (0 <= nitems_max
&& nitems_max
< n
)
976 ptrdiff_t adjusted_nbytes
977 = ((INT_MULTIPLY_WRAPV (n
, item_size
, &nbytes
) || SIZE_MAX
< nbytes
)
978 ? min (PTRDIFF_MAX
, SIZE_MAX
)
979 : nbytes
< DEFAULT_MXFAST
? DEFAULT_MXFAST
: 0);
982 n
= adjusted_nbytes
/ item_size
;
983 nbytes
= adjusted_nbytes
- adjusted_nbytes
% item_size
;
988 if (n
- n0
< nitems_incr_min
989 && (INT_ADD_WRAPV (n0
, nitems_incr_min
, &n
)
990 || (0 <= nitems_max
&& nitems_max
< n
)
991 || INT_MULTIPLY_WRAPV (n
, item_size
, &nbytes
)))
992 memory_full (SIZE_MAX
);
993 pa
= xrealloc (pa
, nbytes
);
999 /* Like strdup, but uses xmalloc. */
1002 xstrdup (const char *s
)
1006 size
= strlen (s
) + 1;
1007 return memcpy (xmalloc (size
), s
, size
);
1010 /* Like above, but duplicates Lisp string to C string. */
1013 xlispstrdup (Lisp_Object string
)
1015 ptrdiff_t size
= SBYTES (string
) + 1;
1016 return memcpy (xmalloc (size
), SSDATA (string
), size
);
1019 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
1020 pointed to. If STRING is null, assign it without copying anything.
1021 Allocate before freeing, to avoid a dangling pointer if allocation
1025 dupstring (char **ptr
, char const *string
)
1028 *ptr
= string
? xstrdup (string
) : 0;
1033 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
1034 argument is a const pointer. */
1037 xputenv (char const *string
)
1039 if (putenv ((char *) string
) != 0)
1043 /* Return a newly allocated memory block of SIZE bytes, remembering
1044 to free it when unwinding. */
1046 record_xmalloc (size_t size
)
1048 void *p
= xmalloc (size
);
1049 record_unwind_protect_ptr (xfree
, p
);
1054 /* Like malloc but used for allocating Lisp data. NBYTES is the
1055 number of bytes to allocate, TYPE describes the intended use of the
1056 allocated memory block (for strings, for conses, ...). */
1059 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
1063 lisp_malloc (size_t nbytes
, enum mem_type type
)
1069 #ifdef GC_MALLOC_CHECK
1070 allocated_mem_type
= type
;
1073 val
= malloc (nbytes
);
1076 /* If the memory just allocated cannot be addressed thru a Lisp
1077 object's pointer, and it needs to be,
1078 that's equivalent to running out of memory. */
1079 if (val
&& type
!= MEM_TYPE_NON_LISP
)
1082 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
1083 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
1085 lisp_malloc_loser
= val
;
1092 #ifndef GC_MALLOC_CHECK
1093 if (val
&& type
!= MEM_TYPE_NON_LISP
)
1094 mem_insert (val
, (char *) val
+ nbytes
, type
);
1097 MALLOC_UNBLOCK_INPUT
;
1099 memory_full (nbytes
);
1100 MALLOC_PROBE (nbytes
);
1104 /* Free BLOCK. This must be called to free memory allocated with a
1105 call to lisp_malloc. */
1108 lisp_free (void *block
)
1112 #ifndef GC_MALLOC_CHECK
1113 mem_delete (mem_find (block
));
1115 MALLOC_UNBLOCK_INPUT
;
1118 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
1120 /* The entry point is lisp_align_malloc which returns blocks of at most
1121 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
1123 /* Use aligned_alloc if it or a simple substitute is available.
1124 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
1125 clang 3.3 anyway. Aligned allocation is incompatible with
1126 unexmacosx.c, so don't use it on Darwin. */
1128 #if ! ADDRESS_SANITIZER && !defined DARWIN_OS
1129 # if (defined HAVE_ALIGNED_ALLOC \
1130 || (defined HYBRID_MALLOC \
1131 ? defined HAVE_POSIX_MEMALIGN \
1132 : !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC))
1133 # define USE_ALIGNED_ALLOC 1
1134 # elif !defined HYBRID_MALLOC && defined HAVE_POSIX_MEMALIGN
1135 # define USE_ALIGNED_ALLOC 1
1137 aligned_alloc (size_t alignment
, size_t size
)
1140 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
1145 /* BLOCK_ALIGN has to be a power of 2. */
1146 #define BLOCK_ALIGN (1 << 10)
1148 /* Padding to leave at the end of a malloc'd block. This is to give
1149 malloc a chance to minimize the amount of memory wasted to alignment.
1150 It should be tuned to the particular malloc library used.
1151 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
1152 aligned_alloc on the other hand would ideally prefer a value of 4
1153 because otherwise, there's 1020 bytes wasted between each ablocks.
1154 In Emacs, testing shows that those 1020 can most of the time be
1155 efficiently used by malloc to place other objects, so a value of 0 can
1156 still preferable unless you have a lot of aligned blocks and virtually
1158 #define BLOCK_PADDING 0
1159 #define BLOCK_BYTES \
1160 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1162 /* Internal data structures and constants. */
1164 #define ABLOCKS_SIZE 16
1166 /* An aligned block of memory. */
1171 char payload
[BLOCK_BYTES
];
1172 struct ablock
*next_free
;
1174 /* `abase' is the aligned base of the ablocks. */
1175 /* It is overloaded to hold the virtual `busy' field that counts
1176 the number of used ablock in the parent ablocks.
1177 The first ablock has the `busy' field, the others have the `abase'
1178 field. To tell the difference, we assume that pointers will have
1179 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1180 is used to tell whether the real base of the parent ablocks is `abase'
1181 (if not, the word before the first ablock holds a pointer to the
1183 struct ablocks
*abase
;
1184 /* The padding of all but the last ablock is unused. The padding of
1185 the last ablock in an ablocks is not allocated. */
1187 char padding
[BLOCK_PADDING
];
1191 /* A bunch of consecutive aligned blocks. */
1194 struct ablock blocks
[ABLOCKS_SIZE
];
1197 /* Size of the block requested from malloc or aligned_alloc. */
1198 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1200 #define ABLOCK_ABASE(block) \
1201 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1202 ? (struct ablocks *)(block) \
1205 /* Virtual `busy' field. */
1206 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1208 /* Pointer to the (not necessarily aligned) malloc block. */
1209 #ifdef USE_ALIGNED_ALLOC
1210 #define ABLOCKS_BASE(abase) (abase)
1212 #define ABLOCKS_BASE(abase) \
1213 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1216 /* The list of free ablock. */
1217 static struct ablock
*free_ablock
;
1219 /* Allocate an aligned block of nbytes.
1220 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1221 smaller or equal to BLOCK_BYTES. */
1223 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1226 struct ablocks
*abase
;
1228 eassert (nbytes
<= BLOCK_BYTES
);
1232 #ifdef GC_MALLOC_CHECK
1233 allocated_mem_type
= type
;
1239 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1241 #ifdef DOUG_LEA_MALLOC
1242 if (!mmap_lisp_allowed_p ())
1243 mallopt (M_MMAP_MAX
, 0);
1246 #ifdef USE_ALIGNED_ALLOC
1247 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1249 base
= malloc (ABLOCKS_BYTES
);
1250 abase
= ALIGN (base
, BLOCK_ALIGN
);
1255 MALLOC_UNBLOCK_INPUT
;
1256 memory_full (ABLOCKS_BYTES
);
1259 aligned
= (base
== abase
);
1261 ((void **) abase
)[-1] = base
;
1263 #ifdef DOUG_LEA_MALLOC
1264 if (!mmap_lisp_allowed_p ())
1265 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1269 /* If the memory just allocated cannot be addressed thru a Lisp
1270 object's pointer, and it needs to be, that's equivalent to
1271 running out of memory. */
1272 if (type
!= MEM_TYPE_NON_LISP
)
1275 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1276 XSETCONS (tem
, end
);
1277 if ((char *) XCONS (tem
) != end
)
1279 lisp_malloc_loser
= base
;
1281 MALLOC_UNBLOCK_INPUT
;
1282 memory_full (SIZE_MAX
);
1287 /* Initialize the blocks and put them on the free list.
1288 If `base' was not properly aligned, we can't use the last block. */
1289 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1291 abase
->blocks
[i
].abase
= abase
;
1292 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1293 free_ablock
= &abase
->blocks
[i
];
1295 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1297 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1298 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1299 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1300 eassert (ABLOCKS_BASE (abase
) == base
);
1301 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1304 abase
= ABLOCK_ABASE (free_ablock
);
1305 ABLOCKS_BUSY (abase
)
1306 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1308 free_ablock
= free_ablock
->x
.next_free
;
1310 #ifndef GC_MALLOC_CHECK
1311 if (type
!= MEM_TYPE_NON_LISP
)
1312 mem_insert (val
, (char *) val
+ nbytes
, type
);
1315 MALLOC_UNBLOCK_INPUT
;
1317 MALLOC_PROBE (nbytes
);
1319 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1324 lisp_align_free (void *block
)
1326 struct ablock
*ablock
= block
;
1327 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1330 #ifndef GC_MALLOC_CHECK
1331 mem_delete (mem_find (block
));
1333 /* Put on free list. */
1334 ablock
->x
.next_free
= free_ablock
;
1335 free_ablock
= ablock
;
1336 /* Update busy count. */
1337 ABLOCKS_BUSY (abase
)
1338 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1340 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1341 { /* All the blocks are free. */
1342 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1343 struct ablock
**tem
= &free_ablock
;
1344 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1348 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1351 *tem
= (*tem
)->x
.next_free
;
1354 tem
= &(*tem
)->x
.next_free
;
1356 eassert ((aligned
& 1) == aligned
);
1357 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1358 #ifdef USE_POSIX_MEMALIGN
1359 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1361 free (ABLOCKS_BASE (abase
));
1363 MALLOC_UNBLOCK_INPUT
;
1367 /***********************************************************************
1369 ***********************************************************************/
1371 /* Number of intervals allocated in an interval_block structure.
1372 The 1020 is 1024 minus malloc overhead. */
1374 #define INTERVAL_BLOCK_SIZE \
1375 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1377 /* Intervals are allocated in chunks in the form of an interval_block
1380 struct interval_block
1382 /* Place `intervals' first, to preserve alignment. */
1383 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1384 struct interval_block
*next
;
1387 /* Current interval block. Its `next' pointer points to older
1390 static struct interval_block
*interval_block
;
1392 /* Index in interval_block above of the next unused interval
1395 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1397 /* Number of free and live intervals. */
1399 static EMACS_INT total_free_intervals
, total_intervals
;
1401 /* List of free intervals. */
1403 static INTERVAL interval_free_list
;
1405 /* Return a new interval. */
1408 make_interval (void)
1414 if (interval_free_list
)
1416 val
= interval_free_list
;
1417 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1421 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1423 struct interval_block
*newi
1424 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1426 newi
->next
= interval_block
;
1427 interval_block
= newi
;
1428 interval_block_index
= 0;
1429 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1431 val
= &interval_block
->intervals
[interval_block_index
++];
1434 MALLOC_UNBLOCK_INPUT
;
1436 consing_since_gc
+= sizeof (struct interval
);
1438 total_free_intervals
--;
1439 RESET_INTERVAL (val
);
1445 /* Mark Lisp objects in interval I. */
1448 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1450 /* Intervals should never be shared. So, if extra internal checking is
1451 enabled, GC aborts if it seems to have visited an interval twice. */
1452 eassert (!i
->gcmarkbit
);
1454 mark_object (i
->plist
);
1457 /* Mark the interval tree rooted in I. */
1459 #define MARK_INTERVAL_TREE(i) \
1461 if (i && !i->gcmarkbit) \
1462 traverse_intervals_noorder (i, mark_interval, Qnil); \
1465 /***********************************************************************
1467 ***********************************************************************/
1469 /* Lisp_Strings are allocated in string_block structures. When a new
1470 string_block is allocated, all the Lisp_Strings it contains are
1471 added to a free-list string_free_list. When a new Lisp_String is
1472 needed, it is taken from that list. During the sweep phase of GC,
1473 string_blocks that are entirely free are freed, except two which
1476 String data is allocated from sblock structures. Strings larger
1477 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1478 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1480 Sblocks consist internally of sdata structures, one for each
1481 Lisp_String. The sdata structure points to the Lisp_String it
1482 belongs to. The Lisp_String points back to the `u.data' member of
1483 its sdata structure.
1485 When a Lisp_String is freed during GC, it is put back on
1486 string_free_list, and its `data' member and its sdata's `string'
1487 pointer is set to null. The size of the string is recorded in the
1488 `n.nbytes' member of the sdata. So, sdata structures that are no
1489 longer used, can be easily recognized, and it's easy to compact the
1490 sblocks of small strings which we do in compact_small_strings. */
1492 /* Size in bytes of an sblock structure used for small strings. This
1493 is 8192 minus malloc overhead. */
1495 #define SBLOCK_SIZE 8188
1497 /* Strings larger than this are considered large strings. String data
1498 for large strings is allocated from individual sblocks. */
1500 #define LARGE_STRING_BYTES 1024
1502 /* The SDATA typedef is a struct or union describing string memory
1503 sub-allocated from an sblock. This is where the contents of Lisp
1504 strings are stored. */
1508 /* Back-pointer to the string this sdata belongs to. If null, this
1509 structure is free, and NBYTES (in this structure or in the union below)
1510 contains the string's byte size (the same value that STRING_BYTES
1511 would return if STRING were non-null). If non-null, STRING_BYTES
1512 (STRING) is the size of the data, and DATA contains the string's
1514 struct Lisp_String
*string
;
1516 #ifdef GC_CHECK_STRING_BYTES
1520 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1523 #ifdef GC_CHECK_STRING_BYTES
1525 typedef struct sdata sdata
;
1526 #define SDATA_NBYTES(S) (S)->nbytes
1527 #define SDATA_DATA(S) (S)->data
1533 struct Lisp_String
*string
;
1535 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1536 which has a flexible array member. However, if implemented by
1537 giving this union a member of type 'struct sdata', the union
1538 could not be the last (flexible) member of 'struct sblock',
1539 because C99 prohibits a flexible array member from having a type
1540 that is itself a flexible array. So, comment this member out here,
1541 but remember that the option's there when using this union. */
1546 /* When STRING is null. */
1549 struct Lisp_String
*string
;
1554 #define SDATA_NBYTES(S) (S)->n.nbytes
1555 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1557 #endif /* not GC_CHECK_STRING_BYTES */
1559 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1561 /* Structure describing a block of memory which is sub-allocated to
1562 obtain string data memory for strings. Blocks for small strings
1563 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1564 as large as needed. */
1569 struct sblock
*next
;
1571 /* Pointer to the next free sdata block. This points past the end
1572 of the sblock if there isn't any space left in this block. */
1576 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1579 /* Number of Lisp strings in a string_block structure. The 1020 is
1580 1024 minus malloc overhead. */
1582 #define STRING_BLOCK_SIZE \
1583 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1585 /* Structure describing a block from which Lisp_String structures
1590 /* Place `strings' first, to preserve alignment. */
1591 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1592 struct string_block
*next
;
1595 /* Head and tail of the list of sblock structures holding Lisp string
1596 data. We always allocate from current_sblock. The NEXT pointers
1597 in the sblock structures go from oldest_sblock to current_sblock. */
1599 static struct sblock
*oldest_sblock
, *current_sblock
;
1601 /* List of sblocks for large strings. */
1603 static struct sblock
*large_sblocks
;
1605 /* List of string_block structures. */
1607 static struct string_block
*string_blocks
;
1609 /* Free-list of Lisp_Strings. */
1611 static struct Lisp_String
*string_free_list
;
1613 /* Number of live and free Lisp_Strings. */
1615 static EMACS_INT total_strings
, total_free_strings
;
1617 /* Number of bytes used by live strings. */
1619 static EMACS_INT total_string_bytes
;
1621 /* Given a pointer to a Lisp_String S which is on the free-list
1622 string_free_list, return a pointer to its successor in the
1625 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1627 /* Return a pointer to the sdata structure belonging to Lisp string S.
1628 S must be live, i.e. S->data must not be null. S->data is actually
1629 a pointer to the `u.data' member of its sdata structure; the
1630 structure starts at a constant offset in front of that. */
1632 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1635 #ifdef GC_CHECK_STRING_OVERRUN
1637 /* We check for overrun in string data blocks by appending a small
1638 "cookie" after each allocated string data block, and check for the
1639 presence of this cookie during GC. */
1641 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1642 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1643 { '\xde', '\xad', '\xbe', '\xef' };
1646 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1649 /* Value is the size of an sdata structure large enough to hold NBYTES
1650 bytes of string data. The value returned includes a terminating
1651 NUL byte, the size of the sdata structure, and padding. */
1653 #ifdef GC_CHECK_STRING_BYTES
1655 #define SDATA_SIZE(NBYTES) \
1656 ((SDATA_DATA_OFFSET \
1658 + sizeof (ptrdiff_t) - 1) \
1659 & ~(sizeof (ptrdiff_t) - 1))
1661 #else /* not GC_CHECK_STRING_BYTES */
1663 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1664 less than the size of that member. The 'max' is not needed when
1665 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1666 alignment code reserves enough space. */
1668 #define SDATA_SIZE(NBYTES) \
1669 ((SDATA_DATA_OFFSET \
1670 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1672 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1674 + sizeof (ptrdiff_t) - 1) \
1675 & ~(sizeof (ptrdiff_t) - 1))
1677 #endif /* not GC_CHECK_STRING_BYTES */
1679 /* Extra bytes to allocate for each string. */
1681 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1683 /* Exact bound on the number of bytes in a string, not counting the
1684 terminating null. A string cannot contain more bytes than
1685 STRING_BYTES_BOUND, nor can it be so long that the size_t
1686 arithmetic in allocate_string_data would overflow while it is
1687 calculating a value to be passed to malloc. */
1688 static ptrdiff_t const STRING_BYTES_MAX
=
1689 min (STRING_BYTES_BOUND
,
1690 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1692 - offsetof (struct sblock
, data
)
1693 - SDATA_DATA_OFFSET
)
1694 & ~(sizeof (EMACS_INT
) - 1)));
1696 /* Initialize string allocation. Called from init_alloc_once. */
1701 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1702 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1706 #ifdef GC_CHECK_STRING_BYTES
1708 static int check_string_bytes_count
;
1710 /* Like STRING_BYTES, but with debugging check. Can be
1711 called during GC, so pay attention to the mark bit. */
1714 string_bytes (struct Lisp_String
*s
)
1717 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1719 if (!PURE_P (s
) && s
->data
&& nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1724 /* Check validity of Lisp strings' string_bytes member in B. */
1727 check_sblock (struct sblock
*b
)
1729 sdata
*from
, *end
, *from_end
;
1733 for (from
= b
->data
; from
< end
; from
= from_end
)
1735 /* Compute the next FROM here because copying below may
1736 overwrite data we need to compute it. */
1739 /* Check that the string size recorded in the string is the
1740 same as the one recorded in the sdata structure. */
1741 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1742 : SDATA_NBYTES (from
));
1743 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1748 /* Check validity of Lisp strings' string_bytes member. ALL_P
1749 means check all strings, otherwise check only most
1750 recently allocated strings. Used for hunting a bug. */
1753 check_string_bytes (bool all_p
)
1759 for (b
= large_sblocks
; b
; b
= b
->next
)
1761 struct Lisp_String
*s
= b
->data
[0].string
;
1766 for (b
= oldest_sblock
; b
; b
= b
->next
)
1769 else if (current_sblock
)
1770 check_sblock (current_sblock
);
1773 #else /* not GC_CHECK_STRING_BYTES */
1775 #define check_string_bytes(all) ((void) 0)
1777 #endif /* GC_CHECK_STRING_BYTES */
1779 #ifdef GC_CHECK_STRING_FREE_LIST
1781 /* Walk through the string free list looking for bogus next pointers.
1782 This may catch buffer overrun from a previous string. */
1785 check_string_free_list (void)
1787 struct Lisp_String
*s
;
1789 /* Pop a Lisp_String off the free-list. */
1790 s
= string_free_list
;
1793 if ((uintptr_t) s
< 1024)
1795 s
= NEXT_FREE_LISP_STRING (s
);
1799 #define check_string_free_list()
1802 /* Return a new Lisp_String. */
1804 static struct Lisp_String
*
1805 allocate_string (void)
1807 struct Lisp_String
*s
;
1811 /* If the free-list is empty, allocate a new string_block, and
1812 add all the Lisp_Strings in it to the free-list. */
1813 if (string_free_list
== NULL
)
1815 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1818 b
->next
= string_blocks
;
1821 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1824 /* Every string on a free list should have NULL data pointer. */
1826 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1827 string_free_list
= s
;
1830 total_free_strings
+= STRING_BLOCK_SIZE
;
1833 check_string_free_list ();
1835 /* Pop a Lisp_String off the free-list. */
1836 s
= string_free_list
;
1837 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1839 MALLOC_UNBLOCK_INPUT
;
1841 --total_free_strings
;
1844 consing_since_gc
+= sizeof *s
;
1846 #ifdef GC_CHECK_STRING_BYTES
1847 if (!noninteractive
)
1849 if (++check_string_bytes_count
== 200)
1851 check_string_bytes_count
= 0;
1852 check_string_bytes (1);
1855 check_string_bytes (0);
1857 #endif /* GC_CHECK_STRING_BYTES */
1863 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1864 plus a NUL byte at the end. Allocate an sdata structure for S, and
1865 set S->data to its `u.data' member. Store a NUL byte at the end of
1866 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1867 S->data if it was initially non-null. */
1870 allocate_string_data (struct Lisp_String
*s
,
1871 EMACS_INT nchars
, EMACS_INT nbytes
)
1873 sdata
*data
, *old_data
;
1875 ptrdiff_t needed
, old_nbytes
;
1877 if (STRING_BYTES_MAX
< nbytes
)
1880 /* Determine the number of bytes needed to store NBYTES bytes
1882 needed
= SDATA_SIZE (nbytes
);
1885 old_data
= SDATA_OF_STRING (s
);
1886 old_nbytes
= STRING_BYTES (s
);
1893 if (nbytes
> LARGE_STRING_BYTES
)
1895 size_t size
= offsetof (struct sblock
, data
) + needed
;
1897 #ifdef DOUG_LEA_MALLOC
1898 if (!mmap_lisp_allowed_p ())
1899 mallopt (M_MMAP_MAX
, 0);
1902 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1904 #ifdef DOUG_LEA_MALLOC
1905 if (!mmap_lisp_allowed_p ())
1906 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1909 b
->next_free
= b
->data
;
1910 b
->data
[0].string
= NULL
;
1911 b
->next
= large_sblocks
;
1914 else if (current_sblock
== NULL
1915 || (((char *) current_sblock
+ SBLOCK_SIZE
1916 - (char *) current_sblock
->next_free
)
1917 < (needed
+ GC_STRING_EXTRA
)))
1919 /* Not enough room in the current sblock. */
1920 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1921 b
->next_free
= b
->data
;
1922 b
->data
[0].string
= NULL
;
1926 current_sblock
->next
= b
;
1934 data
= b
->next_free
;
1935 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1937 MALLOC_UNBLOCK_INPUT
;
1940 s
->data
= SDATA_DATA (data
);
1941 #ifdef GC_CHECK_STRING_BYTES
1942 SDATA_NBYTES (data
) = nbytes
;
1945 s
->size_byte
= nbytes
;
1946 s
->data
[nbytes
] = '\0';
1947 #ifdef GC_CHECK_STRING_OVERRUN
1948 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1949 GC_STRING_OVERRUN_COOKIE_SIZE
);
1952 /* Note that Faset may call to this function when S has already data
1953 assigned. In this case, mark data as free by setting it's string
1954 back-pointer to null, and record the size of the data in it. */
1957 SDATA_NBYTES (old_data
) = old_nbytes
;
1958 old_data
->string
= NULL
;
1961 consing_since_gc
+= needed
;
1965 /* Sweep and compact strings. */
1967 NO_INLINE
/* For better stack traces */
1969 sweep_strings (void)
1971 struct string_block
*b
, *next
;
1972 struct string_block
*live_blocks
= NULL
;
1974 string_free_list
= NULL
;
1975 total_strings
= total_free_strings
= 0;
1976 total_string_bytes
= 0;
1978 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1979 for (b
= string_blocks
; b
; b
= next
)
1982 struct Lisp_String
*free_list_before
= string_free_list
;
1986 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1988 struct Lisp_String
*s
= b
->strings
+ i
;
1992 /* String was not on free-list before. */
1993 if (STRING_MARKED_P (s
))
1995 /* String is live; unmark it and its intervals. */
1998 /* Do not use string_(set|get)_intervals here. */
1999 s
->intervals
= balance_intervals (s
->intervals
);
2002 total_string_bytes
+= STRING_BYTES (s
);
2006 /* String is dead. Put it on the free-list. */
2007 sdata
*data
= SDATA_OF_STRING (s
);
2009 /* Save the size of S in its sdata so that we know
2010 how large that is. Reset the sdata's string
2011 back-pointer so that we know it's free. */
2012 #ifdef GC_CHECK_STRING_BYTES
2013 if (string_bytes (s
) != SDATA_NBYTES (data
))
2016 data
->n
.nbytes
= STRING_BYTES (s
);
2018 data
->string
= NULL
;
2020 /* Reset the strings's `data' member so that we
2024 /* Put the string on the free-list. */
2025 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2026 string_free_list
= s
;
2032 /* S was on the free-list before. Put it there again. */
2033 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2034 string_free_list
= s
;
2039 /* Free blocks that contain free Lisp_Strings only, except
2040 the first two of them. */
2041 if (nfree
== STRING_BLOCK_SIZE
2042 && total_free_strings
> STRING_BLOCK_SIZE
)
2045 string_free_list
= free_list_before
;
2049 total_free_strings
+= nfree
;
2050 b
->next
= live_blocks
;
2055 check_string_free_list ();
2057 string_blocks
= live_blocks
;
2058 free_large_strings ();
2059 compact_small_strings ();
2061 check_string_free_list ();
2065 /* Free dead large strings. */
2068 free_large_strings (void)
2070 struct sblock
*b
, *next
;
2071 struct sblock
*live_blocks
= NULL
;
2073 for (b
= large_sblocks
; b
; b
= next
)
2077 if (b
->data
[0].string
== NULL
)
2081 b
->next
= live_blocks
;
2086 large_sblocks
= live_blocks
;
2090 /* Compact data of small strings. Free sblocks that don't contain
2091 data of live strings after compaction. */
2094 compact_small_strings (void)
2096 struct sblock
*b
, *tb
, *next
;
2097 sdata
*from
, *to
, *end
, *tb_end
;
2098 sdata
*to_end
, *from_end
;
2100 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2101 to, and TB_END is the end of TB. */
2103 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2106 /* Step through the blocks from the oldest to the youngest. We
2107 expect that old blocks will stabilize over time, so that less
2108 copying will happen this way. */
2109 for (b
= oldest_sblock
; b
; b
= b
->next
)
2112 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2114 for (from
= b
->data
; from
< end
; from
= from_end
)
2116 /* Compute the next FROM here because copying below may
2117 overwrite data we need to compute it. */
2119 struct Lisp_String
*s
= from
->string
;
2121 #ifdef GC_CHECK_STRING_BYTES
2122 /* Check that the string size recorded in the string is the
2123 same as the one recorded in the sdata structure. */
2124 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2126 #endif /* GC_CHECK_STRING_BYTES */
2128 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2129 eassert (nbytes
<= LARGE_STRING_BYTES
);
2131 nbytes
= SDATA_SIZE (nbytes
);
2132 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2134 #ifdef GC_CHECK_STRING_OVERRUN
2135 if (memcmp (string_overrun_cookie
,
2136 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2137 GC_STRING_OVERRUN_COOKIE_SIZE
))
2141 /* Non-NULL S means it's alive. Copy its data. */
2144 /* If TB is full, proceed with the next sblock. */
2145 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2146 if (to_end
> tb_end
)
2150 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2152 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2155 /* Copy, and update the string's `data' pointer. */
2158 eassert (tb
!= b
|| to
< from
);
2159 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2160 to
->string
->data
= SDATA_DATA (to
);
2163 /* Advance past the sdata we copied to. */
2169 /* The rest of the sblocks following TB don't contain live data, so
2170 we can free them. */
2171 for (b
= tb
->next
; b
; b
= next
)
2179 current_sblock
= tb
;
2183 string_overflow (void)
2185 error ("Maximum string size exceeded");
2188 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2189 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2190 LENGTH must be an integer.
2191 INIT must be an integer that represents a character. */)
2192 (Lisp_Object length
, Lisp_Object init
)
2194 register Lisp_Object val
;
2198 CHECK_NATNUM (length
);
2199 CHECK_CHARACTER (init
);
2201 c
= XFASTINT (init
);
2202 if (ASCII_CHAR_P (c
))
2204 nbytes
= XINT (length
);
2205 val
= make_uninit_string (nbytes
);
2208 memset (SDATA (val
), c
, nbytes
);
2209 SDATA (val
)[nbytes
] = 0;
2214 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2215 ptrdiff_t len
= CHAR_STRING (c
, str
);
2216 EMACS_INT string_len
= XINT (length
);
2217 unsigned char *p
, *beg
, *end
;
2219 if (INT_MULTIPLY_WRAPV (len
, string_len
, &nbytes
))
2221 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2222 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2224 /* First time we just copy `str' to the data of `val'. */
2226 memcpy (p
, str
, len
);
2229 /* Next time we copy largest possible chunk from
2230 initialized to uninitialized part of `val'. */
2231 len
= min (p
- beg
, end
- p
);
2232 memcpy (p
, beg
, len
);
2242 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2246 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2248 EMACS_INT nbits
= bool_vector_size (a
);
2251 unsigned char *data
= bool_vector_uchar_data (a
);
2252 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2253 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2254 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2255 memset (data
, pattern
, nbytes
- 1);
2256 data
[nbytes
- 1] = pattern
& last_mask
;
2261 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2264 make_uninit_bool_vector (EMACS_INT nbits
)
2267 EMACS_INT words
= bool_vector_words (nbits
);
2268 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2269 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2272 struct Lisp_Bool_Vector
*p
2273 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2274 XSETVECTOR (val
, p
);
2275 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2278 /* Clear padding at the end. */
2280 p
->data
[words
- 1] = 0;
2285 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2286 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2287 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2288 (Lisp_Object length
, Lisp_Object init
)
2292 CHECK_NATNUM (length
);
2293 val
= make_uninit_bool_vector (XFASTINT (length
));
2294 return bool_vector_fill (val
, init
);
2297 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2298 doc
: /* Return a new bool-vector with specified arguments as elements.
2299 Any number of arguments, even zero arguments, are allowed.
2300 usage: (bool-vector &rest OBJECTS) */)
2301 (ptrdiff_t nargs
, Lisp_Object
*args
)
2306 vector
= make_uninit_bool_vector (nargs
);
2307 for (i
= 0; i
< nargs
; i
++)
2308 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2313 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2314 of characters from the contents. This string may be unibyte or
2315 multibyte, depending on the contents. */
2318 make_string (const char *contents
, ptrdiff_t nbytes
)
2320 register Lisp_Object val
;
2321 ptrdiff_t nchars
, multibyte_nbytes
;
2323 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2324 &nchars
, &multibyte_nbytes
);
2325 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2326 /* CONTENTS contains no multibyte sequences or contains an invalid
2327 multibyte sequence. We must make unibyte string. */
2328 val
= make_unibyte_string (contents
, nbytes
);
2330 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2334 /* Make a unibyte string from LENGTH bytes at CONTENTS. */
2337 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2339 register Lisp_Object val
;
2340 val
= make_uninit_string (length
);
2341 memcpy (SDATA (val
), contents
, length
);
2346 /* Make a multibyte string from NCHARS characters occupying NBYTES
2347 bytes at CONTENTS. */
2350 make_multibyte_string (const char *contents
,
2351 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2353 register Lisp_Object val
;
2354 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2355 memcpy (SDATA (val
), contents
, nbytes
);
2360 /* Make a string from NCHARS characters occupying NBYTES bytes at
2361 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2364 make_string_from_bytes (const char *contents
,
2365 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2367 register Lisp_Object val
;
2368 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2369 memcpy (SDATA (val
), contents
, nbytes
);
2370 if (SBYTES (val
) == SCHARS (val
))
2371 STRING_SET_UNIBYTE (val
);
2376 /* Make a string from NCHARS characters occupying NBYTES bytes at
2377 CONTENTS. The argument MULTIBYTE controls whether to label the
2378 string as multibyte. If NCHARS is negative, it counts the number of
2379 characters by itself. */
2382 make_specified_string (const char *contents
,
2383 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2390 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2395 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2396 memcpy (SDATA (val
), contents
, nbytes
);
2398 STRING_SET_UNIBYTE (val
);
2403 /* Return a unibyte Lisp_String set up to hold LENGTH characters
2404 occupying LENGTH bytes. */
2407 make_uninit_string (EMACS_INT length
)
2412 return empty_unibyte_string
;
2413 val
= make_uninit_multibyte_string (length
, length
);
2414 STRING_SET_UNIBYTE (val
);
2419 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2420 which occupy NBYTES bytes. */
2423 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2426 struct Lisp_String
*s
;
2431 return empty_multibyte_string
;
2433 s
= allocate_string ();
2434 s
->intervals
= NULL
;
2435 allocate_string_data (s
, nchars
, nbytes
);
2436 XSETSTRING (string
, s
);
2437 string_chars_consed
+= nbytes
;
2441 /* Print arguments to BUF according to a FORMAT, then return
2442 a Lisp_String initialized with the data from BUF. */
2445 make_formatted_string (char *buf
, const char *format
, ...)
2450 va_start (ap
, format
);
2451 length
= vsprintf (buf
, format
, ap
);
2453 return make_string (buf
, length
);
2457 /***********************************************************************
2459 ***********************************************************************/
2461 /* We store float cells inside of float_blocks, allocating a new
2462 float_block with malloc whenever necessary. Float cells reclaimed
2463 by GC are put on a free list to be reallocated before allocating
2464 any new float cells from the latest float_block. */
2466 #define FLOAT_BLOCK_SIZE \
2467 (((BLOCK_BYTES - sizeof (struct float_block *) \
2468 /* The compiler might add padding at the end. */ \
2469 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2470 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2472 #define GETMARKBIT(block,n) \
2473 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2474 >> ((n) % BITS_PER_BITS_WORD)) \
2477 #define SETMARKBIT(block,n) \
2478 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2479 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2481 #define UNSETMARKBIT(block,n) \
2482 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2483 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2485 #define FLOAT_BLOCK(fptr) \
2486 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2488 #define FLOAT_INDEX(fptr) \
2489 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2493 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2494 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2495 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2496 struct float_block
*next
;
2499 #define FLOAT_MARKED_P(fptr) \
2500 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2502 #define FLOAT_MARK(fptr) \
2503 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2505 #define FLOAT_UNMARK(fptr) \
2506 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2508 /* Current float_block. */
2510 static struct float_block
*float_block
;
2512 /* Index of first unused Lisp_Float in the current float_block. */
2514 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2516 /* Free-list of Lisp_Floats. */
2518 static struct Lisp_Float
*float_free_list
;
2520 /* Return a new float object with value FLOAT_VALUE. */
2523 make_float (double float_value
)
2525 register Lisp_Object val
;
2529 if (float_free_list
)
2531 /* We use the data field for chaining the free list
2532 so that we won't use the same field that has the mark bit. */
2533 XSETFLOAT (val
, float_free_list
);
2534 float_free_list
= float_free_list
->u
.chain
;
2538 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2540 struct float_block
*new
2541 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2542 new->next
= float_block
;
2543 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2545 float_block_index
= 0;
2546 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2548 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2549 float_block_index
++;
2552 MALLOC_UNBLOCK_INPUT
;
2554 XFLOAT_INIT (val
, float_value
);
2555 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2556 consing_since_gc
+= sizeof (struct Lisp_Float
);
2558 total_free_floats
--;
2564 /***********************************************************************
2566 ***********************************************************************/
2568 /* We store cons cells inside of cons_blocks, allocating a new
2569 cons_block with malloc whenever necessary. Cons cells reclaimed by
2570 GC are put on a free list to be reallocated before allocating
2571 any new cons cells from the latest cons_block. */
2573 #define CONS_BLOCK_SIZE \
2574 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2575 /* The compiler might add padding at the end. */ \
2576 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2577 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2579 #define CONS_BLOCK(fptr) \
2580 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2582 #define CONS_INDEX(fptr) \
2583 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2587 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2588 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2589 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2590 struct cons_block
*next
;
2593 #define CONS_MARKED_P(fptr) \
2594 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2596 #define CONS_MARK(fptr) \
2597 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2599 #define CONS_UNMARK(fptr) \
2600 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2602 /* Current cons_block. */
2604 static struct cons_block
*cons_block
;
2606 /* Index of first unused Lisp_Cons in the current block. */
2608 static int cons_block_index
= CONS_BLOCK_SIZE
;
2610 /* Free-list of Lisp_Cons structures. */
2612 static struct Lisp_Cons
*cons_free_list
;
2614 /* Explicitly free a cons cell by putting it on the free-list. */
2617 free_cons (struct Lisp_Cons
*ptr
)
2619 ptr
->u
.chain
= cons_free_list
;
2621 cons_free_list
= ptr
;
2622 consing_since_gc
-= sizeof *ptr
;
2623 total_free_conses
++;
2626 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2627 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2628 (Lisp_Object car
, Lisp_Object cdr
)
2630 register Lisp_Object val
;
2636 /* We use the cdr for chaining the free list
2637 so that we won't use the same field that has the mark bit. */
2638 XSETCONS (val
, cons_free_list
);
2639 cons_free_list
= cons_free_list
->u
.chain
;
2643 if (cons_block_index
== CONS_BLOCK_SIZE
)
2645 struct cons_block
*new
2646 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2647 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2648 new->next
= cons_block
;
2650 cons_block_index
= 0;
2651 total_free_conses
+= CONS_BLOCK_SIZE
;
2653 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2657 MALLOC_UNBLOCK_INPUT
;
2661 eassert (!CONS_MARKED_P (XCONS (val
)));
2662 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2663 total_free_conses
--;
2664 cons_cells_consed
++;
2668 #ifdef GC_CHECK_CONS_LIST
2669 /* Get an error now if there's any junk in the cons free list. */
2671 check_cons_list (void)
2673 struct Lisp_Cons
*tail
= cons_free_list
;
2676 tail
= tail
->u
.chain
;
2680 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2683 list1 (Lisp_Object arg1
)
2685 return Fcons (arg1
, Qnil
);
2689 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2691 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2696 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2698 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2703 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2705 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2710 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2712 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2713 Fcons (arg5
, Qnil
)))));
2716 /* Make a list of COUNT Lisp_Objects, where ARG is the
2717 first one. Allocate conses from pure space if TYPE
2718 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2721 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2723 Lisp_Object (*cons
) (Lisp_Object
, Lisp_Object
);
2726 case CONSTYPE_PURE
: cons
= pure_cons
; break;
2727 case CONSTYPE_HEAP
: cons
= Fcons
; break;
2728 default: emacs_abort ();
2731 eassume (0 < count
);
2732 Lisp_Object val
= cons (arg
, Qnil
);
2733 Lisp_Object tail
= val
;
2737 for (ptrdiff_t i
= 1; i
< count
; i
++)
2739 Lisp_Object elem
= cons (va_arg (ap
, Lisp_Object
), Qnil
);
2740 XSETCDR (tail
, elem
);
2748 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2749 doc
: /* Return a newly created list with specified arguments as elements.
2750 Any number of arguments, even zero arguments, are allowed.
2751 usage: (list &rest OBJECTS) */)
2752 (ptrdiff_t nargs
, Lisp_Object
*args
)
2754 register Lisp_Object val
;
2760 val
= Fcons (args
[nargs
], val
);
2766 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2767 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2768 (register Lisp_Object length
, Lisp_Object init
)
2770 register Lisp_Object val
;
2771 register EMACS_INT size
;
2773 CHECK_NATNUM (length
);
2774 size
= XFASTINT (length
);
2779 val
= Fcons (init
, val
);
2784 val
= Fcons (init
, val
);
2789 val
= Fcons (init
, val
);
2794 val
= Fcons (init
, val
);
2799 val
= Fcons (init
, val
);
2814 /***********************************************************************
2816 ***********************************************************************/
2818 /* Sometimes a vector's contents are merely a pointer internally used
2819 in vector allocation code. On the rare platforms where a null
2820 pointer cannot be tagged, represent it with a Lisp 0.
2821 Usually you don't want to touch this. */
2823 static struct Lisp_Vector
*
2824 next_vector (struct Lisp_Vector
*v
)
2826 return XUNTAG (v
->contents
[0], Lisp_Int0
);
2830 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2832 v
->contents
[0] = make_lisp_ptr (p
, Lisp_Int0
);
2835 /* This value is balanced well enough to avoid too much internal overhead
2836 for the most common cases; it's not required to be a power of two, but
2837 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2839 #define VECTOR_BLOCK_SIZE 4096
2843 /* Alignment of struct Lisp_Vector objects. */
2844 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2847 /* Vector size requests are a multiple of this. */
2848 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2851 /* Verify assumptions described above. */
2852 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2853 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2855 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2856 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2857 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2858 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2860 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2862 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2864 /* Size of the minimal vector allocated from block. */
2866 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2868 /* Size of the largest vector allocated from block. */
2870 #define VBLOCK_BYTES_MAX \
2871 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2873 /* We maintain one free list for each possible block-allocated
2874 vector size, and this is the number of free lists we have. */
2876 #define VECTOR_MAX_FREE_LIST_INDEX \
2877 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2879 /* Common shortcut to advance vector pointer over a block data. */
2881 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2883 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2885 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2887 /* Common shortcut to setup vector on a free list. */
2889 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2891 (tmp) = ((nbytes - header_size) / word_size); \
2892 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2893 eassert ((nbytes) % roundup_size == 0); \
2894 (tmp) = VINDEX (nbytes); \
2895 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2896 set_next_vector (v, vector_free_lists[tmp]); \
2897 vector_free_lists[tmp] = (v); \
2898 total_free_vector_slots += (nbytes) / word_size; \
2901 /* This internal type is used to maintain the list of large vectors
2902 which are allocated at their own, e.g. outside of vector blocks.
2904 struct large_vector itself cannot contain a struct Lisp_Vector, as
2905 the latter contains a flexible array member and C99 does not allow
2906 such structs to be nested. Instead, each struct large_vector
2907 object LV is followed by a struct Lisp_Vector, which is at offset
2908 large_vector_offset from LV, and whose address is therefore
2909 large_vector_vec (&LV). */
2913 struct large_vector
*next
;
2918 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2921 static struct Lisp_Vector
*
2922 large_vector_vec (struct large_vector
*p
)
2924 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
2927 /* This internal type is used to maintain an underlying storage
2928 for small vectors. */
2932 char data
[VECTOR_BLOCK_BYTES
];
2933 struct vector_block
*next
;
2936 /* Chain of vector blocks. */
2938 static struct vector_block
*vector_blocks
;
2940 /* Vector free lists, where NTH item points to a chain of free
2941 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2943 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2945 /* Singly-linked list of large vectors. */
2947 static struct large_vector
*large_vectors
;
2949 /* The only vector with 0 slots, allocated from pure space. */
2951 Lisp_Object zero_vector
;
2953 /* Number of live vectors. */
2955 static EMACS_INT total_vectors
;
2957 /* Total size of live and free vectors, in Lisp_Object units. */
2959 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2961 /* Get a new vector block. */
2963 static struct vector_block
*
2964 allocate_vector_block (void)
2966 struct vector_block
*block
= xmalloc (sizeof *block
);
2968 #ifndef GC_MALLOC_CHECK
2969 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2970 MEM_TYPE_VECTOR_BLOCK
);
2973 block
->next
= vector_blocks
;
2974 vector_blocks
= block
;
2978 /* Called once to initialize vector allocation. */
2983 zero_vector
= make_pure_vector (0);
2986 /* Allocate vector from a vector block. */
2988 static struct Lisp_Vector
*
2989 allocate_vector_from_block (size_t nbytes
)
2991 struct Lisp_Vector
*vector
;
2992 struct vector_block
*block
;
2993 size_t index
, restbytes
;
2995 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2996 eassert (nbytes
% roundup_size
== 0);
2998 /* First, try to allocate from a free list
2999 containing vectors of the requested size. */
3000 index
= VINDEX (nbytes
);
3001 if (vector_free_lists
[index
])
3003 vector
= vector_free_lists
[index
];
3004 vector_free_lists
[index
] = next_vector (vector
);
3005 total_free_vector_slots
-= nbytes
/ word_size
;
3009 /* Next, check free lists containing larger vectors. Since
3010 we will split the result, we should have remaining space
3011 large enough to use for one-slot vector at least. */
3012 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3013 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3014 if (vector_free_lists
[index
])
3016 /* This vector is larger than requested. */
3017 vector
= vector_free_lists
[index
];
3018 vector_free_lists
[index
] = next_vector (vector
);
3019 total_free_vector_slots
-= nbytes
/ word_size
;
3021 /* Excess bytes are used for the smaller vector,
3022 which should be set on an appropriate free list. */
3023 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3024 eassert (restbytes
% roundup_size
== 0);
3025 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
3029 /* Finally, need a new vector block. */
3030 block
= allocate_vector_block ();
3032 /* New vector will be at the beginning of this block. */
3033 vector
= (struct Lisp_Vector
*) block
->data
;
3035 /* If the rest of space from this block is large enough
3036 for one-slot vector at least, set up it on a free list. */
3037 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3038 if (restbytes
>= VBLOCK_BYTES_MIN
)
3040 eassert (restbytes
% roundup_size
== 0);
3041 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
3046 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3048 #define VECTOR_IN_BLOCK(vector, block) \
3049 ((char *) (vector) <= (block)->data \
3050 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3052 /* Return the memory footprint of V in bytes. */
3055 vector_nbytes (struct Lisp_Vector
*v
)
3057 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
3060 if (size
& PSEUDOVECTOR_FLAG
)
3062 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
3064 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
3065 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
3066 * sizeof (bits_word
));
3067 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
3068 verify (header_size
<= bool_header_size
);
3069 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
3072 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
3073 + ((size
& PSEUDOVECTOR_REST_MASK
)
3074 >> PSEUDOVECTOR_SIZE_BITS
));
3078 return vroundup (header_size
+ word_size
* nwords
);
3081 /* Release extra resources still in use by VECTOR, which may be any
3082 vector-like object. For now, this is used just to free data in
3086 cleanup_vector (struct Lisp_Vector
*vector
)
3088 detect_suspicious_free (vector
);
3089 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
3090 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
3091 == FONT_OBJECT_MAX
))
3093 struct font_driver
*drv
= ((struct font
*) vector
)->driver
;
3095 /* The font driver might sometimes be NULL, e.g. if Emacs was
3096 interrupted before it had time to set it up. */
3099 /* Attempt to catch subtle bugs like Bug#16140. */
3100 eassert (valid_font_driver (drv
));
3101 drv
->close ((struct font
*) vector
);
3106 /* Reclaim space used by unmarked vectors. */
3108 NO_INLINE
/* For better stack traces */
3110 sweep_vectors (void)
3112 struct vector_block
*block
, **bprev
= &vector_blocks
;
3113 struct large_vector
*lv
, **lvprev
= &large_vectors
;
3114 struct Lisp_Vector
*vector
, *next
;
3116 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3117 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3119 /* Looking through vector blocks. */
3121 for (block
= vector_blocks
; block
; block
= *bprev
)
3123 bool free_this_block
= 0;
3126 for (vector
= (struct Lisp_Vector
*) block
->data
;
3127 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3129 if (VECTOR_MARKED_P (vector
))
3131 VECTOR_UNMARK (vector
);
3133 nbytes
= vector_nbytes (vector
);
3134 total_vector_slots
+= nbytes
/ word_size
;
3135 next
= ADVANCE (vector
, nbytes
);
3139 ptrdiff_t total_bytes
;
3141 cleanup_vector (vector
);
3142 nbytes
= vector_nbytes (vector
);
3143 total_bytes
= nbytes
;
3144 next
= ADVANCE (vector
, nbytes
);
3146 /* While NEXT is not marked, try to coalesce with VECTOR,
3147 thus making VECTOR of the largest possible size. */
3149 while (VECTOR_IN_BLOCK (next
, block
))
3151 if (VECTOR_MARKED_P (next
))
3153 cleanup_vector (next
);
3154 nbytes
= vector_nbytes (next
);
3155 total_bytes
+= nbytes
;
3156 next
= ADVANCE (next
, nbytes
);
3159 eassert (total_bytes
% roundup_size
== 0);
3161 if (vector
== (struct Lisp_Vector
*) block
->data
3162 && !VECTOR_IN_BLOCK (next
, block
))
3163 /* This block should be freed because all of its
3164 space was coalesced into the only free vector. */
3165 free_this_block
= 1;
3169 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3174 if (free_this_block
)
3176 *bprev
= block
->next
;
3177 #ifndef GC_MALLOC_CHECK
3178 mem_delete (mem_find (block
->data
));
3183 bprev
= &block
->next
;
3186 /* Sweep large vectors. */
3188 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
3190 vector
= large_vector_vec (lv
);
3191 if (VECTOR_MARKED_P (vector
))
3193 VECTOR_UNMARK (vector
);
3195 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3197 /* All non-bool pseudovectors are small enough to be allocated
3198 from vector blocks. This code should be redesigned if some
3199 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3200 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3201 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3205 += header_size
/ word_size
+ vector
->header
.size
;
3216 /* Value is a pointer to a newly allocated Lisp_Vector structure
3217 with room for LEN Lisp_Objects. */
3219 static struct Lisp_Vector
*
3220 allocate_vectorlike (ptrdiff_t len
)
3222 struct Lisp_Vector
*p
;
3227 p
= XVECTOR (zero_vector
);
3230 size_t nbytes
= header_size
+ len
* word_size
;
3232 #ifdef DOUG_LEA_MALLOC
3233 if (!mmap_lisp_allowed_p ())
3234 mallopt (M_MMAP_MAX
, 0);
3237 if (nbytes
<= VBLOCK_BYTES_MAX
)
3238 p
= allocate_vector_from_block (vroundup (nbytes
));
3241 struct large_vector
*lv
3242 = lisp_malloc ((large_vector_offset
+ header_size
3244 MEM_TYPE_VECTORLIKE
);
3245 lv
->next
= large_vectors
;
3247 p
= large_vector_vec (lv
);
3250 #ifdef DOUG_LEA_MALLOC
3251 if (!mmap_lisp_allowed_p ())
3252 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3255 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3258 consing_since_gc
+= nbytes
;
3259 vector_cells_consed
+= len
;
3262 MALLOC_UNBLOCK_INPUT
;
3268 /* Allocate a vector with LEN slots. */
3270 struct Lisp_Vector
*
3271 allocate_vector (EMACS_INT len
)
3273 struct Lisp_Vector
*v
;
3274 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3276 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3277 memory_full (SIZE_MAX
);
3278 v
= allocate_vectorlike (len
);
3280 v
->header
.size
= len
;
3285 /* Allocate other vector-like structures. */
3287 struct Lisp_Vector
*
3288 allocate_pseudovector (int memlen
, int lisplen
,
3289 int zerolen
, enum pvec_type tag
)
3291 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3293 /* Catch bogus values. */
3294 eassert (0 <= tag
&& tag
<= PVEC_FONT
);
3295 eassert (0 <= lisplen
&& lisplen
<= zerolen
&& zerolen
<= memlen
);
3296 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3297 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3299 /* Only the first LISPLEN slots will be traced normally by the GC. */
3300 memclear (v
->contents
, zerolen
* word_size
);
3301 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3306 allocate_buffer (void)
3308 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3310 BUFFER_PVEC_INIT (b
);
3311 /* Put B on the chain of all buffers including killed ones. */
3312 b
->next
= all_buffers
;
3314 /* Note that the rest fields of B are not initialized. */
3318 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3319 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3320 See also the function `vector'. */)
3321 (Lisp_Object length
, Lisp_Object init
)
3323 CHECK_NATNUM (length
);
3324 struct Lisp_Vector
*p
= allocate_vector (XFASTINT (length
));
3325 for (ptrdiff_t i
= 0; i
< XFASTINT (length
); i
++)
3326 p
->contents
[i
] = init
;
3327 return make_lisp_ptr (p
, Lisp_Vectorlike
);
3330 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3331 doc
: /* Return a newly created vector with specified arguments as elements.
3332 Any number of arguments, even zero arguments, are allowed.
3333 usage: (vector &rest OBJECTS) */)
3334 (ptrdiff_t nargs
, Lisp_Object
*args
)
3336 Lisp_Object val
= make_uninit_vector (nargs
);
3337 struct Lisp_Vector
*p
= XVECTOR (val
);
3338 memcpy (p
->contents
, args
, nargs
* sizeof *args
);
3343 make_byte_code (struct Lisp_Vector
*v
)
3345 /* Don't allow the global zero_vector to become a byte code object. */
3346 eassert (0 < v
->header
.size
);
3348 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3349 && STRING_MULTIBYTE (v
->contents
[1]))
3350 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3351 earlier because they produced a raw 8-bit string for byte-code
3352 and now such a byte-code string is loaded as multibyte while
3353 raw 8-bit characters converted to multibyte form. Thus, now we
3354 must convert them back to the original unibyte form. */
3355 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3356 XSETPVECTYPE (v
, PVEC_COMPILED
);
3359 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3360 doc
: /* Create a byte-code object with specified arguments as elements.
3361 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3362 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3363 and (optional) INTERACTIVE-SPEC.
3364 The first four arguments are required; at most six have any
3366 The ARGLIST can be either like the one of `lambda', in which case the arguments
3367 will be dynamically bound before executing the byte code, or it can be an
3368 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3369 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3370 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3371 argument to catch the left-over arguments. If such an integer is used, the
3372 arguments will not be dynamically bound but will be instead pushed on the
3373 stack before executing the byte-code.
3374 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3375 (ptrdiff_t nargs
, Lisp_Object
*args
)
3377 Lisp_Object val
= make_uninit_vector (nargs
);
3378 struct Lisp_Vector
*p
= XVECTOR (val
);
3380 /* We used to purecopy everything here, if purify-flag was set. This worked
3381 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3382 dangerous, since make-byte-code is used during execution to build
3383 closures, so any closure built during the preload phase would end up
3384 copied into pure space, including its free variables, which is sometimes
3385 just wasteful and other times plainly wrong (e.g. those free vars may want
3388 memcpy (p
->contents
, args
, nargs
* sizeof *args
);
3390 XSETCOMPILED (val
, p
);
3396 /***********************************************************************
3398 ***********************************************************************/
3400 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3401 of the required alignment. */
3403 union aligned_Lisp_Symbol
3405 struct Lisp_Symbol s
;
3406 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3410 /* Each symbol_block is just under 1020 bytes long, since malloc
3411 really allocates in units of powers of two and uses 4 bytes for its
3414 #define SYMBOL_BLOCK_SIZE \
3415 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3419 /* Place `symbols' first, to preserve alignment. */
3420 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3421 struct symbol_block
*next
;
3424 /* Current symbol block and index of first unused Lisp_Symbol
3427 static struct symbol_block
*symbol_block
;
3428 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3429 /* Pointer to the first symbol_block that contains pinned symbols.
3430 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3431 10K of which are pinned (and all but 250 of them are interned in obarray),
3432 whereas a "typical session" has in the order of 30K symbols.
3433 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3434 than 30K to find the 10K symbols we need to mark. */
3435 static struct symbol_block
*symbol_block_pinned
;
3437 /* List of free symbols. */
3439 static struct Lisp_Symbol
*symbol_free_list
;
3442 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3444 XSYMBOL (sym
)->name
= name
;
3448 init_symbol (Lisp_Object val
, Lisp_Object name
)
3450 struct Lisp_Symbol
*p
= XSYMBOL (val
);
3451 set_symbol_name (val
, name
);
3452 set_symbol_plist (val
, Qnil
);
3453 p
->redirect
= SYMBOL_PLAINVAL
;
3454 SET_SYMBOL_VAL (p
, Qunbound
);
3455 set_symbol_function (val
, Qnil
);
3456 set_symbol_next (val
, NULL
);
3457 p
->gcmarkbit
= false;
3458 p
->interned
= SYMBOL_UNINTERNED
;
3460 p
->declared_special
= false;
3464 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3465 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3466 Its value is void, and its function definition and property list are nil. */)
3471 CHECK_STRING (name
);
3475 if (symbol_free_list
)
3477 XSETSYMBOL (val
, symbol_free_list
);
3478 symbol_free_list
= symbol_free_list
->next
;
3482 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3484 struct symbol_block
*new
3485 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3486 new->next
= symbol_block
;
3488 symbol_block_index
= 0;
3489 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3491 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3492 symbol_block_index
++;
3495 MALLOC_UNBLOCK_INPUT
;
3497 init_symbol (val
, name
);
3498 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3500 total_free_symbols
--;
3506 /***********************************************************************
3507 Marker (Misc) Allocation
3508 ***********************************************************************/
3510 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3511 the required alignment. */
3513 union aligned_Lisp_Misc
3516 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3520 /* Allocation of markers and other objects that share that structure.
3521 Works like allocation of conses. */
3523 #define MARKER_BLOCK_SIZE \
3524 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3528 /* Place `markers' first, to preserve alignment. */
3529 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3530 struct marker_block
*next
;
3533 static struct marker_block
*marker_block
;
3534 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3536 static union Lisp_Misc
*marker_free_list
;
3538 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3541 allocate_misc (enum Lisp_Misc_Type type
)
3547 if (marker_free_list
)
3549 XSETMISC (val
, marker_free_list
);
3550 marker_free_list
= marker_free_list
->u_free
.chain
;
3554 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3556 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3557 new->next
= marker_block
;
3559 marker_block_index
= 0;
3560 total_free_markers
+= MARKER_BLOCK_SIZE
;
3562 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3563 marker_block_index
++;
3566 MALLOC_UNBLOCK_INPUT
;
3568 --total_free_markers
;
3569 consing_since_gc
+= sizeof (union Lisp_Misc
);
3570 misc_objects_consed
++;
3571 XMISCANY (val
)->type
= type
;
3572 XMISCANY (val
)->gcmarkbit
= 0;
3576 /* Free a Lisp_Misc object. */
3579 free_misc (Lisp_Object misc
)
3581 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3582 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3583 marker_free_list
= XMISC (misc
);
3584 consing_since_gc
-= sizeof (union Lisp_Misc
);
3585 total_free_markers
++;
3588 /* Verify properties of Lisp_Save_Value's representation
3589 that are assumed here and elsewhere. */
3591 verify (SAVE_UNUSED
== 0);
3592 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3596 /* Return Lisp_Save_Value objects for the various combinations
3597 that callers need. */
3600 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3602 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3603 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3604 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3605 p
->data
[0].integer
= a
;
3606 p
->data
[1].integer
= b
;
3607 p
->data
[2].integer
= c
;
3612 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3615 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3616 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3617 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3618 p
->data
[0].object
= a
;
3619 p
->data
[1].object
= b
;
3620 p
->data
[2].object
= c
;
3621 p
->data
[3].object
= d
;
3626 make_save_ptr (void *a
)
3628 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3629 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3630 p
->save_type
= SAVE_POINTER
;
3631 p
->data
[0].pointer
= a
;
3636 make_save_ptr_int (void *a
, ptrdiff_t b
)
3638 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3639 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3640 p
->save_type
= SAVE_TYPE_PTR_INT
;
3641 p
->data
[0].pointer
= a
;
3642 p
->data
[1].integer
= b
;
3646 #if ! (defined USE_X_TOOLKIT || defined USE_GTK)
3648 make_save_ptr_ptr (void *a
, void *b
)
3650 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3651 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3652 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3653 p
->data
[0].pointer
= a
;
3654 p
->data
[1].pointer
= b
;
3660 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3662 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3663 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3664 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3665 p
->data
[0].funcpointer
= a
;
3666 p
->data
[1].pointer
= b
;
3667 p
->data
[2].object
= c
;
3671 /* Return a Lisp_Save_Value object that represents an array A
3672 of N Lisp objects. */
3675 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3677 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3678 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3679 p
->save_type
= SAVE_TYPE_MEMORY
;
3680 p
->data
[0].pointer
= a
;
3681 p
->data
[1].integer
= n
;
3685 /* Free a Lisp_Save_Value object. Do not use this function
3686 if SAVE contains pointer other than returned by xmalloc. */
3689 free_save_value (Lisp_Object save
)
3691 xfree (XSAVE_POINTER (save
, 0));
3695 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3698 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3700 register Lisp_Object overlay
;
3702 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3703 OVERLAY_START (overlay
) = start
;
3704 OVERLAY_END (overlay
) = end
;
3705 set_overlay_plist (overlay
, plist
);
3706 XOVERLAY (overlay
)->next
= NULL
;
3710 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3711 doc
: /* Return a newly allocated marker which does not point at any place. */)
3714 register Lisp_Object val
;
3715 register struct Lisp_Marker
*p
;
3717 val
= allocate_misc (Lisp_Misc_Marker
);
3723 p
->insertion_type
= 0;
3724 p
->need_adjustment
= 0;
3728 /* Return a newly allocated marker which points into BUF
3729 at character position CHARPOS and byte position BYTEPOS. */
3732 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3735 struct Lisp_Marker
*m
;
3737 /* No dead buffers here. */
3738 eassert (BUFFER_LIVE_P (buf
));
3740 /* Every character is at least one byte. */
3741 eassert (charpos
<= bytepos
);
3743 obj
= allocate_misc (Lisp_Misc_Marker
);
3746 m
->charpos
= charpos
;
3747 m
->bytepos
= bytepos
;
3748 m
->insertion_type
= 0;
3749 m
->need_adjustment
= 0;
3750 m
->next
= BUF_MARKERS (buf
);
3751 BUF_MARKERS (buf
) = m
;
3755 /* Put MARKER back on the free list after using it temporarily. */
3758 free_marker (Lisp_Object marker
)
3760 unchain_marker (XMARKER (marker
));
3765 /* Return a newly created vector or string with specified arguments as
3766 elements. If all the arguments are characters that can fit
3767 in a string of events, make a string; otherwise, make a vector.
3769 Any number of arguments, even zero arguments, are allowed. */
3772 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3776 for (i
= 0; i
< nargs
; i
++)
3777 /* The things that fit in a string
3778 are characters that are in 0...127,
3779 after discarding the meta bit and all the bits above it. */
3780 if (!INTEGERP (args
[i
])
3781 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3782 return Fvector (nargs
, args
);
3784 /* Since the loop exited, we know that all the things in it are
3785 characters, so we can make a string. */
3789 result
= Fmake_string (make_number (nargs
), make_number (0));
3790 for (i
= 0; i
< nargs
; i
++)
3792 SSET (result
, i
, XINT (args
[i
]));
3793 /* Move the meta bit to the right place for a string char. */
3794 if (XINT (args
[i
]) & CHAR_META
)
3795 SSET (result
, i
, SREF (result
, i
) | 0x80);
3803 /* Create a new module user ptr object. */
3805 make_user_ptr (void (*finalizer
) (void *), void *p
)
3808 struct Lisp_User_Ptr
*uptr
;
3810 obj
= allocate_misc (Lisp_Misc_User_Ptr
);
3811 uptr
= XUSER_PTR (obj
);
3812 uptr
->finalizer
= finalizer
;
3820 init_finalizer_list (struct Lisp_Finalizer
*head
)
3822 head
->prev
= head
->next
= head
;
3825 /* Insert FINALIZER before ELEMENT. */
3828 finalizer_insert (struct Lisp_Finalizer
*element
,
3829 struct Lisp_Finalizer
*finalizer
)
3831 eassert (finalizer
->prev
== NULL
);
3832 eassert (finalizer
->next
== NULL
);
3833 finalizer
->next
= element
;
3834 finalizer
->prev
= element
->prev
;
3835 finalizer
->prev
->next
= finalizer
;
3836 element
->prev
= finalizer
;
3840 unchain_finalizer (struct Lisp_Finalizer
*finalizer
)
3842 if (finalizer
->prev
!= NULL
)
3844 eassert (finalizer
->next
!= NULL
);
3845 finalizer
->prev
->next
= finalizer
->next
;
3846 finalizer
->next
->prev
= finalizer
->prev
;
3847 finalizer
->prev
= finalizer
->next
= NULL
;
3852 mark_finalizer_list (struct Lisp_Finalizer
*head
)
3854 for (struct Lisp_Finalizer
*finalizer
= head
->next
;
3856 finalizer
= finalizer
->next
)
3858 finalizer
->base
.gcmarkbit
= true;
3859 mark_object (finalizer
->function
);
3863 /* Move doomed finalizers to list DEST from list SRC. A doomed
3864 finalizer is one that is not GC-reachable and whose
3865 finalizer->function is non-nil. */
3868 queue_doomed_finalizers (struct Lisp_Finalizer
*dest
,
3869 struct Lisp_Finalizer
*src
)
3871 struct Lisp_Finalizer
*finalizer
= src
->next
;
3872 while (finalizer
!= src
)
3874 struct Lisp_Finalizer
*next
= finalizer
->next
;
3875 if (!finalizer
->base
.gcmarkbit
&& !NILP (finalizer
->function
))
3877 unchain_finalizer (finalizer
);
3878 finalizer_insert (dest
, finalizer
);
3886 run_finalizer_handler (Lisp_Object args
)
3888 add_to_log ("finalizer failed: %S", args
);
3893 run_finalizer_function (Lisp_Object function
)
3895 ptrdiff_t count
= SPECPDL_INDEX ();
3897 specbind (Qinhibit_quit
, Qt
);
3898 internal_condition_case_1 (call0
, function
, Qt
, run_finalizer_handler
);
3899 unbind_to (count
, Qnil
);
3903 run_finalizers (struct Lisp_Finalizer
*finalizers
)
3905 struct Lisp_Finalizer
*finalizer
;
3906 Lisp_Object function
;
3908 while (finalizers
->next
!= finalizers
)
3910 finalizer
= finalizers
->next
;
3911 eassert (finalizer
->base
.type
== Lisp_Misc_Finalizer
);
3912 unchain_finalizer (finalizer
);
3913 function
= finalizer
->function
;
3914 if (!NILP (function
))
3916 finalizer
->function
= Qnil
;
3917 run_finalizer_function (function
);
3922 DEFUN ("make-finalizer", Fmake_finalizer
, Smake_finalizer
, 1, 1, 0,
3923 doc
: /* Make a finalizer that will run FUNCTION.
3924 FUNCTION will be called after garbage collection when the returned
3925 finalizer object becomes unreachable. If the finalizer object is
3926 reachable only through references from finalizer objects, it does not
3927 count as reachable for the purpose of deciding whether to run
3928 FUNCTION. FUNCTION will be run once per finalizer object. */)
3929 (Lisp_Object function
)
3931 Lisp_Object val
= allocate_misc (Lisp_Misc_Finalizer
);
3932 struct Lisp_Finalizer
*finalizer
= XFINALIZER (val
);
3933 finalizer
->function
= function
;
3934 finalizer
->prev
= finalizer
->next
= NULL
;
3935 finalizer_insert (&finalizers
, finalizer
);
3940 /************************************************************************
3941 Memory Full Handling
3942 ************************************************************************/
3945 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3946 there may have been size_t overflow so that malloc was never
3947 called, or perhaps malloc was invoked successfully but the
3948 resulting pointer had problems fitting into a tagged EMACS_INT. In
3949 either case this counts as memory being full even though malloc did
3953 memory_full (size_t nbytes
)
3955 /* Do not go into hysterics merely because a large request failed. */
3956 bool enough_free_memory
= 0;
3957 if (SPARE_MEMORY
< nbytes
)
3962 p
= malloc (SPARE_MEMORY
);
3966 enough_free_memory
= 1;
3968 MALLOC_UNBLOCK_INPUT
;
3971 if (! enough_free_memory
)
3977 memory_full_cons_threshold
= sizeof (struct cons_block
);
3979 /* The first time we get here, free the spare memory. */
3980 for (i
= 0; i
< ARRAYELTS (spare_memory
); i
++)
3981 if (spare_memory
[i
])
3984 free (spare_memory
[i
]);
3985 else if (i
>= 1 && i
<= 4)
3986 lisp_align_free (spare_memory
[i
]);
3988 lisp_free (spare_memory
[i
]);
3989 spare_memory
[i
] = 0;
3993 /* This used to call error, but if we've run out of memory, we could
3994 get infinite recursion trying to build the string. */
3995 xsignal (Qnil
, Vmemory_signal_data
);
3998 /* If we released our reserve (due to running out of memory),
3999 and we have a fair amount free once again,
4000 try to set aside another reserve in case we run out once more.
4002 This is called when a relocatable block is freed in ralloc.c,
4003 and also directly from this file, in case we're not using ralloc.c. */
4006 refill_memory_reserve (void)
4008 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
4009 if (spare_memory
[0] == 0)
4010 spare_memory
[0] = malloc (SPARE_MEMORY
);
4011 if (spare_memory
[1] == 0)
4012 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
4014 if (spare_memory
[2] == 0)
4015 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
4017 if (spare_memory
[3] == 0)
4018 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
4020 if (spare_memory
[4] == 0)
4021 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
4023 if (spare_memory
[5] == 0)
4024 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
4026 if (spare_memory
[6] == 0)
4027 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
4029 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
4030 Vmemory_full
= Qnil
;
4034 /************************************************************************
4036 ************************************************************************/
4038 /* Conservative C stack marking requires a method to identify possibly
4039 live Lisp objects given a pointer value. We do this by keeping
4040 track of blocks of Lisp data that are allocated in a red-black tree
4041 (see also the comment of mem_node which is the type of nodes in
4042 that tree). Function lisp_malloc adds information for an allocated
4043 block to the red-black tree with calls to mem_insert, and function
4044 lisp_free removes it with mem_delete. Functions live_string_p etc
4045 call mem_find to lookup information about a given pointer in the
4046 tree, and use that to determine if the pointer points to a Lisp
4049 /* Initialize this part of alloc.c. */
4054 mem_z
.left
= mem_z
.right
= MEM_NIL
;
4055 mem_z
.parent
= NULL
;
4056 mem_z
.color
= MEM_BLACK
;
4057 mem_z
.start
= mem_z
.end
= NULL
;
4062 /* Value is a pointer to the mem_node containing START. Value is
4063 MEM_NIL if there is no node in the tree containing START. */
4065 static struct mem_node
*
4066 mem_find (void *start
)
4070 if (start
< min_heap_address
|| start
> max_heap_address
)
4073 /* Make the search always successful to speed up the loop below. */
4074 mem_z
.start
= start
;
4075 mem_z
.end
= (char *) start
+ 1;
4078 while (start
< p
->start
|| start
>= p
->end
)
4079 p
= start
< p
->start
? p
->left
: p
->right
;
4084 /* Insert a new node into the tree for a block of memory with start
4085 address START, end address END, and type TYPE. Value is a
4086 pointer to the node that was inserted. */
4088 static struct mem_node
*
4089 mem_insert (void *start
, void *end
, enum mem_type type
)
4091 struct mem_node
*c
, *parent
, *x
;
4093 if (min_heap_address
== NULL
|| start
< min_heap_address
)
4094 min_heap_address
= start
;
4095 if (max_heap_address
== NULL
|| end
> max_heap_address
)
4096 max_heap_address
= end
;
4098 /* See where in the tree a node for START belongs. In this
4099 particular application, it shouldn't happen that a node is already
4100 present. For debugging purposes, let's check that. */
4104 while (c
!= MEM_NIL
)
4107 c
= start
< c
->start
? c
->left
: c
->right
;
4110 /* Create a new node. */
4111 #ifdef GC_MALLOC_CHECK
4112 x
= malloc (sizeof *x
);
4116 x
= xmalloc (sizeof *x
);
4122 x
->left
= x
->right
= MEM_NIL
;
4125 /* Insert it as child of PARENT or install it as root. */
4128 if (start
< parent
->start
)
4136 /* Re-establish red-black tree properties. */
4137 mem_insert_fixup (x
);
4143 /* Re-establish the red-black properties of the tree, and thereby
4144 balance the tree, after node X has been inserted; X is always red. */
4147 mem_insert_fixup (struct mem_node
*x
)
4149 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
4151 /* X is red and its parent is red. This is a violation of
4152 red-black tree property #3. */
4154 if (x
->parent
== x
->parent
->parent
->left
)
4156 /* We're on the left side of our grandparent, and Y is our
4158 struct mem_node
*y
= x
->parent
->parent
->right
;
4160 if (y
->color
== MEM_RED
)
4162 /* Uncle and parent are red but should be black because
4163 X is red. Change the colors accordingly and proceed
4164 with the grandparent. */
4165 x
->parent
->color
= MEM_BLACK
;
4166 y
->color
= MEM_BLACK
;
4167 x
->parent
->parent
->color
= MEM_RED
;
4168 x
= x
->parent
->parent
;
4172 /* Parent and uncle have different colors; parent is
4173 red, uncle is black. */
4174 if (x
== x
->parent
->right
)
4177 mem_rotate_left (x
);
4180 x
->parent
->color
= MEM_BLACK
;
4181 x
->parent
->parent
->color
= MEM_RED
;
4182 mem_rotate_right (x
->parent
->parent
);
4187 /* This is the symmetrical case of above. */
4188 struct mem_node
*y
= x
->parent
->parent
->left
;
4190 if (y
->color
== MEM_RED
)
4192 x
->parent
->color
= MEM_BLACK
;
4193 y
->color
= MEM_BLACK
;
4194 x
->parent
->parent
->color
= MEM_RED
;
4195 x
= x
->parent
->parent
;
4199 if (x
== x
->parent
->left
)
4202 mem_rotate_right (x
);
4205 x
->parent
->color
= MEM_BLACK
;
4206 x
->parent
->parent
->color
= MEM_RED
;
4207 mem_rotate_left (x
->parent
->parent
);
4212 /* The root may have been changed to red due to the algorithm. Set
4213 it to black so that property #5 is satisfied. */
4214 mem_root
->color
= MEM_BLACK
;
4225 mem_rotate_left (struct mem_node
*x
)
4229 /* Turn y's left sub-tree into x's right sub-tree. */
4232 if (y
->left
!= MEM_NIL
)
4233 y
->left
->parent
= x
;
4235 /* Y's parent was x's parent. */
4237 y
->parent
= x
->parent
;
4239 /* Get the parent to point to y instead of x. */
4242 if (x
== x
->parent
->left
)
4243 x
->parent
->left
= y
;
4245 x
->parent
->right
= y
;
4250 /* Put x on y's left. */
4264 mem_rotate_right (struct mem_node
*x
)
4266 struct mem_node
*y
= x
->left
;
4269 if (y
->right
!= MEM_NIL
)
4270 y
->right
->parent
= x
;
4273 y
->parent
= x
->parent
;
4276 if (x
== x
->parent
->right
)
4277 x
->parent
->right
= y
;
4279 x
->parent
->left
= y
;
4290 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4293 mem_delete (struct mem_node
*z
)
4295 struct mem_node
*x
, *y
;
4297 if (!z
|| z
== MEM_NIL
)
4300 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4305 while (y
->left
!= MEM_NIL
)
4309 if (y
->left
!= MEM_NIL
)
4314 x
->parent
= y
->parent
;
4317 if (y
== y
->parent
->left
)
4318 y
->parent
->left
= x
;
4320 y
->parent
->right
= x
;
4327 z
->start
= y
->start
;
4332 if (y
->color
== MEM_BLACK
)
4333 mem_delete_fixup (x
);
4335 #ifdef GC_MALLOC_CHECK
4343 /* Re-establish the red-black properties of the tree, after a
4347 mem_delete_fixup (struct mem_node
*x
)
4349 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4351 if (x
== x
->parent
->left
)
4353 struct mem_node
*w
= x
->parent
->right
;
4355 if (w
->color
== MEM_RED
)
4357 w
->color
= MEM_BLACK
;
4358 x
->parent
->color
= MEM_RED
;
4359 mem_rotate_left (x
->parent
);
4360 w
= x
->parent
->right
;
4363 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4370 if (w
->right
->color
== MEM_BLACK
)
4372 w
->left
->color
= MEM_BLACK
;
4374 mem_rotate_right (w
);
4375 w
= x
->parent
->right
;
4377 w
->color
= x
->parent
->color
;
4378 x
->parent
->color
= MEM_BLACK
;
4379 w
->right
->color
= MEM_BLACK
;
4380 mem_rotate_left (x
->parent
);
4386 struct mem_node
*w
= x
->parent
->left
;
4388 if (w
->color
== MEM_RED
)
4390 w
->color
= MEM_BLACK
;
4391 x
->parent
->color
= MEM_RED
;
4392 mem_rotate_right (x
->parent
);
4393 w
= x
->parent
->left
;
4396 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4403 if (w
->left
->color
== MEM_BLACK
)
4405 w
->right
->color
= MEM_BLACK
;
4407 mem_rotate_left (w
);
4408 w
= x
->parent
->left
;
4411 w
->color
= x
->parent
->color
;
4412 x
->parent
->color
= MEM_BLACK
;
4413 w
->left
->color
= MEM_BLACK
;
4414 mem_rotate_right (x
->parent
);
4420 x
->color
= MEM_BLACK
;
4424 /* Value is non-zero if P is a pointer to a live Lisp string on
4425 the heap. M is a pointer to the mem_block for P. */
4428 live_string_p (struct mem_node
*m
, void *p
)
4430 if (m
->type
== MEM_TYPE_STRING
)
4432 struct string_block
*b
= m
->start
;
4433 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4435 /* P must point to the start of a Lisp_String structure, and it
4436 must not be on the free-list. */
4438 && offset
% sizeof b
->strings
[0] == 0
4439 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4440 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4447 /* Value is non-zero if P is a pointer to a live Lisp cons on
4448 the heap. M is a pointer to the mem_block for P. */
4451 live_cons_p (struct mem_node
*m
, void *p
)
4453 if (m
->type
== MEM_TYPE_CONS
)
4455 struct cons_block
*b
= m
->start
;
4456 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4458 /* P must point to the start of a Lisp_Cons, not be
4459 one of the unused cells in the current cons block,
4460 and not be on the free-list. */
4462 && offset
% sizeof b
->conses
[0] == 0
4463 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4465 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4466 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4473 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4474 the heap. M is a pointer to the mem_block for P. */
4477 live_symbol_p (struct mem_node
*m
, void *p
)
4479 if (m
->type
== MEM_TYPE_SYMBOL
)
4481 struct symbol_block
*b
= m
->start
;
4482 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4484 /* P must point to the start of a Lisp_Symbol, not be
4485 one of the unused cells in the current symbol block,
4486 and not be on the free-list. */
4488 && offset
% sizeof b
->symbols
[0] == 0
4489 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4490 && (b
!= symbol_block
4491 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4492 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4499 /* Value is non-zero if P is a pointer to a live Lisp float on
4500 the heap. M is a pointer to the mem_block for P. */
4503 live_float_p (struct mem_node
*m
, void *p
)
4505 if (m
->type
== MEM_TYPE_FLOAT
)
4507 struct float_block
*b
= m
->start
;
4508 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4510 /* P must point to the start of a Lisp_Float and not be
4511 one of the unused cells in the current float block. */
4513 && offset
% sizeof b
->floats
[0] == 0
4514 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4515 && (b
!= float_block
4516 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4523 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4524 the heap. M is a pointer to the mem_block for P. */
4527 live_misc_p (struct mem_node
*m
, void *p
)
4529 if (m
->type
== MEM_TYPE_MISC
)
4531 struct marker_block
*b
= m
->start
;
4532 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4534 /* P must point to the start of a Lisp_Misc, not be
4535 one of the unused cells in the current misc block,
4536 and not be on the free-list. */
4538 && offset
% sizeof b
->markers
[0] == 0
4539 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4540 && (b
!= marker_block
4541 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4542 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4549 /* Value is non-zero if P is a pointer to a live vector-like object.
4550 M is a pointer to the mem_block for P. */
4553 live_vector_p (struct mem_node
*m
, void *p
)
4555 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4557 /* This memory node corresponds to a vector block. */
4558 struct vector_block
*block
= m
->start
;
4559 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4561 /* P is in the block's allocation range. Scan the block
4562 up to P and see whether P points to the start of some
4563 vector which is not on a free list. FIXME: check whether
4564 some allocation patterns (probably a lot of short vectors)
4565 may cause a substantial overhead of this loop. */
4566 while (VECTOR_IN_BLOCK (vector
, block
)
4567 && vector
<= (struct Lisp_Vector
*) p
)
4569 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4572 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4575 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4576 /* This memory node corresponds to a large vector. */
4582 /* Value is non-zero if P is a pointer to a live buffer. M is a
4583 pointer to the mem_block for P. */
4586 live_buffer_p (struct mem_node
*m
, void *p
)
4588 /* P must point to the start of the block, and the buffer
4589 must not have been killed. */
4590 return (m
->type
== MEM_TYPE_BUFFER
4592 && !NILP (((struct buffer
*) p
)->name_
));
4595 /* Mark OBJ if we can prove it's a Lisp_Object. */
4598 mark_maybe_object (Lisp_Object obj
)
4602 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4608 void *po
= XPNTR (obj
);
4609 struct mem_node
*m
= mem_find (po
);
4613 bool mark_p
= false;
4615 switch (XTYPE (obj
))
4618 mark_p
= (live_string_p (m
, po
)
4619 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4623 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4627 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4631 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4634 case Lisp_Vectorlike
:
4635 /* Note: can't check BUFFERP before we know it's a
4636 buffer because checking that dereferences the pointer
4637 PO which might point anywhere. */
4638 if (live_vector_p (m
, po
))
4639 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4640 else if (live_buffer_p (m
, po
))
4641 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4645 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4657 /* Return true if P can point to Lisp data, and false otherwise.
4658 Symbols are implemented via offsets not pointers, but the offsets
4659 are also multiples of GCALIGNMENT. */
4662 maybe_lisp_pointer (void *p
)
4664 return (uintptr_t) p
% GCALIGNMENT
== 0;
4667 #ifndef HAVE_MODULES
4668 enum { HAVE_MODULES
= false };
4671 /* If P points to Lisp data, mark that as live if it isn't already
4675 mark_maybe_pointer (void *p
)
4681 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4684 if (sizeof (Lisp_Object
) == sizeof (void *) || !HAVE_MODULES
)
4686 if (!maybe_lisp_pointer (p
))
4691 /* For the wide-int case, also mark emacs_value tagged pointers,
4692 which can be generated by emacs-module.c's value_to_lisp. */
4693 p
= (void *) ((uintptr_t) p
& ~(GCALIGNMENT
- 1));
4699 Lisp_Object obj
= Qnil
;
4703 case MEM_TYPE_NON_LISP
:
4704 case MEM_TYPE_SPARE
:
4705 /* Nothing to do; not a pointer to Lisp memory. */
4708 case MEM_TYPE_BUFFER
:
4709 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4710 XSETVECTOR (obj
, p
);
4714 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4718 case MEM_TYPE_STRING
:
4719 if (live_string_p (m
, p
)
4720 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4721 XSETSTRING (obj
, p
);
4725 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4729 case MEM_TYPE_SYMBOL
:
4730 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4731 XSETSYMBOL (obj
, p
);
4734 case MEM_TYPE_FLOAT
:
4735 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4739 case MEM_TYPE_VECTORLIKE
:
4740 case MEM_TYPE_VECTOR_BLOCK
:
4741 if (live_vector_p (m
, p
))
4744 XSETVECTOR (tem
, p
);
4745 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4760 /* Alignment of pointer values. Use alignof, as it sometimes returns
4761 a smaller alignment than GCC's __alignof__ and mark_memory might
4762 miss objects if __alignof__ were used. */
4763 #define GC_POINTER_ALIGNMENT alignof (void *)
4765 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4766 or END+OFFSET..START. */
4768 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4769 mark_memory (void *start
, void *end
)
4773 /* Make START the pointer to the start of the memory region,
4774 if it isn't already. */
4782 eassert (((uintptr_t) start
) % GC_POINTER_ALIGNMENT
== 0);
4784 /* Mark Lisp data pointed to. This is necessary because, in some
4785 situations, the C compiler optimizes Lisp objects away, so that
4786 only a pointer to them remains. Example:
4788 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4791 Lisp_Object obj = build_string ("test");
4792 struct Lisp_String *s = XSTRING (obj);
4793 Fgarbage_collect ();
4794 fprintf (stderr, "test '%s'\n", s->data);
4798 Here, `obj' isn't really used, and the compiler optimizes it
4799 away. The only reference to the life string is through the
4802 for (pp
= start
; (void *) pp
< end
; pp
+= GC_POINTER_ALIGNMENT
)
4804 mark_maybe_pointer (*(void **) pp
);
4805 mark_maybe_object (*(Lisp_Object
*) pp
);
4809 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4811 static bool setjmp_tested_p
;
4812 static int longjmps_done
;
4814 #define SETJMP_WILL_LIKELY_WORK "\
4816 Emacs garbage collector has been changed to use conservative stack\n\
4817 marking. Emacs has determined that the method it uses to do the\n\
4818 marking will likely work on your system, but this isn't sure.\n\
4820 If you are a system-programmer, or can get the help of a local wizard\n\
4821 who is, please take a look at the function mark_stack in alloc.c, and\n\
4822 verify that the methods used are appropriate for your system.\n\
4824 Please mail the result to <emacs-devel@gnu.org>.\n\
4827 #define SETJMP_WILL_NOT_WORK "\
4829 Emacs garbage collector has been changed to use conservative stack\n\
4830 marking. Emacs has determined that the default method it uses to do the\n\
4831 marking will not work on your system. We will need a system-dependent\n\
4832 solution for your system.\n\
4834 Please take a look at the function mark_stack in alloc.c, and\n\
4835 try to find a way to make it work on your system.\n\
4837 Note that you may get false negatives, depending on the compiler.\n\
4838 In particular, you need to use -O with GCC for this test.\n\
4840 Please mail the result to <emacs-devel@gnu.org>.\n\
4844 /* Perform a quick check if it looks like setjmp saves registers in a
4845 jmp_buf. Print a message to stderr saying so. When this test
4846 succeeds, this is _not_ a proof that setjmp is sufficient for
4847 conservative stack marking. Only the sources or a disassembly
4857 /* Arrange for X to be put in a register. */
4863 if (longjmps_done
== 1)
4865 /* Came here after the longjmp at the end of the function.
4867 If x == 1, the longjmp has restored the register to its
4868 value before the setjmp, and we can hope that setjmp
4869 saves all such registers in the jmp_buf, although that
4872 For other values of X, either something really strange is
4873 taking place, or the setjmp just didn't save the register. */
4876 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4879 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4886 if (longjmps_done
== 1)
4887 sys_longjmp (jbuf
, 1);
4890 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4893 /* Mark live Lisp objects on the C stack.
4895 There are several system-dependent problems to consider when
4896 porting this to new architectures:
4900 We have to mark Lisp objects in CPU registers that can hold local
4901 variables or are used to pass parameters.
4903 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4904 something that either saves relevant registers on the stack, or
4905 calls mark_maybe_object passing it each register's contents.
4907 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4908 implementation assumes that calling setjmp saves registers we need
4909 to see in a jmp_buf which itself lies on the stack. This doesn't
4910 have to be true! It must be verified for each system, possibly
4911 by taking a look at the source code of setjmp.
4913 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4914 can use it as a machine independent method to store all registers
4915 to the stack. In this case the macros described in the previous
4916 two paragraphs are not used.
4920 Architectures differ in the way their processor stack is organized.
4921 For example, the stack might look like this
4924 | Lisp_Object | size = 4
4926 | something else | size = 2
4928 | Lisp_Object | size = 4
4932 In such a case, not every Lisp_Object will be aligned equally. To
4933 find all Lisp_Object on the stack it won't be sufficient to walk
4934 the stack in steps of 4 bytes. Instead, two passes will be
4935 necessary, one starting at the start of the stack, and a second
4936 pass starting at the start of the stack + 2. Likewise, if the
4937 minimal alignment of Lisp_Objects on the stack is 1, four passes
4938 would be necessary, each one starting with one byte more offset
4939 from the stack start. */
4942 mark_stack (void *end
)
4945 /* This assumes that the stack is a contiguous region in memory. If
4946 that's not the case, something has to be done here to iterate
4947 over the stack segments. */
4948 mark_memory (stack_base
, end
);
4950 /* Allow for marking a secondary stack, like the register stack on the
4952 #ifdef GC_MARK_SECONDARY_STACK
4953 GC_MARK_SECONDARY_STACK ();
4958 c_symbol_p (struct Lisp_Symbol
*sym
)
4960 char *lispsym_ptr
= (char *) lispsym
;
4961 char *sym_ptr
= (char *) sym
;
4962 ptrdiff_t lispsym_offset
= sym_ptr
- lispsym_ptr
;
4963 return 0 <= lispsym_offset
&& lispsym_offset
< sizeof lispsym
;
4966 /* Determine whether it is safe to access memory at address P. */
4968 valid_pointer_p (void *p
)
4971 return w32_valid_pointer_p (p
, 16);
4974 if (ADDRESS_SANITIZER
)
4979 /* Obviously, we cannot just access it (we would SEGV trying), so we
4980 trick the o/s to tell us whether p is a valid pointer.
4981 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4982 not validate p in that case. */
4984 if (emacs_pipe (fd
) == 0)
4986 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
4987 emacs_close (fd
[1]);
4988 emacs_close (fd
[0]);
4996 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
4997 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
4998 cannot validate OBJ. This function can be quite slow, so its primary
4999 use is the manual debugging. The only exception is print_object, where
5000 we use it to check whether the memory referenced by the pointer of
5001 Lisp_Save_Value object contains valid objects. */
5004 valid_lisp_object_p (Lisp_Object obj
)
5009 void *p
= XPNTR (obj
);
5013 if (SYMBOLP (obj
) && c_symbol_p (p
))
5014 return ((char *) p
- (char *) lispsym
) % sizeof lispsym
[0] == 0;
5016 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
5019 struct mem_node
*m
= mem_find (p
);
5023 int valid
= valid_pointer_p (p
);
5035 case MEM_TYPE_NON_LISP
:
5036 case MEM_TYPE_SPARE
:
5039 case MEM_TYPE_BUFFER
:
5040 return live_buffer_p (m
, p
) ? 1 : 2;
5043 return live_cons_p (m
, p
);
5045 case MEM_TYPE_STRING
:
5046 return live_string_p (m
, p
);
5049 return live_misc_p (m
, p
);
5051 case MEM_TYPE_SYMBOL
:
5052 return live_symbol_p (m
, p
);
5054 case MEM_TYPE_FLOAT
:
5055 return live_float_p (m
, p
);
5057 case MEM_TYPE_VECTORLIKE
:
5058 case MEM_TYPE_VECTOR_BLOCK
:
5059 return live_vector_p (m
, p
);
5068 /***********************************************************************
5069 Pure Storage Management
5070 ***********************************************************************/
5072 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5073 pointer to it. TYPE is the Lisp type for which the memory is
5074 allocated. TYPE < 0 means it's not used for a Lisp object. */
5077 pure_alloc (size_t size
, int type
)
5084 /* Allocate space for a Lisp object from the beginning of the free
5085 space with taking account of alignment. */
5086 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, GCALIGNMENT
);
5087 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5091 /* Allocate space for a non-Lisp object from the end of the free
5093 pure_bytes_used_non_lisp
+= size
;
5094 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5096 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5098 if (pure_bytes_used
<= pure_size
)
5101 /* Don't allocate a large amount here,
5102 because it might get mmap'd and then its address
5103 might not be usable. */
5104 purebeg
= xmalloc (10000);
5106 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5107 pure_bytes_used
= 0;
5108 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5113 /* Print a warning if PURESIZE is too small. */
5116 check_pure_size (void)
5118 if (pure_bytes_used_before_overflow
)
5119 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5121 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5125 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5126 the non-Lisp data pool of the pure storage, and return its start
5127 address. Return NULL if not found. */
5130 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5133 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5134 const unsigned char *p
;
5137 if (pure_bytes_used_non_lisp
<= nbytes
)
5140 /* Set up the Boyer-Moore table. */
5142 for (i
= 0; i
< 256; i
++)
5145 p
= (const unsigned char *) data
;
5147 bm_skip
[*p
++] = skip
;
5149 last_char_skip
= bm_skip
['\0'];
5151 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5152 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5154 /* See the comments in the function `boyer_moore' (search.c) for the
5155 use of `infinity'. */
5156 infinity
= pure_bytes_used_non_lisp
+ 1;
5157 bm_skip
['\0'] = infinity
;
5159 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5163 /* Check the last character (== '\0'). */
5166 start
+= bm_skip
[*(p
+ start
)];
5168 while (start
<= start_max
);
5170 if (start
< infinity
)
5171 /* Couldn't find the last character. */
5174 /* No less than `infinity' means we could find the last
5175 character at `p[start - infinity]'. */
5178 /* Check the remaining characters. */
5179 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5181 return non_lisp_beg
+ start
;
5183 start
+= last_char_skip
;
5185 while (start
<= start_max
);
5191 /* Return a string allocated in pure space. DATA is a buffer holding
5192 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5193 means make the result string multibyte.
5195 Must get an error if pure storage is full, since if it cannot hold
5196 a large string it may be able to hold conses that point to that
5197 string; then the string is not protected from gc. */
5200 make_pure_string (const char *data
,
5201 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5204 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5205 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5206 if (s
->data
== NULL
)
5208 s
->data
= pure_alloc (nbytes
+ 1, -1);
5209 memcpy (s
->data
, data
, nbytes
);
5210 s
->data
[nbytes
] = '\0';
5213 s
->size_byte
= multibyte
? nbytes
: -1;
5214 s
->intervals
= NULL
;
5215 XSETSTRING (string
, s
);
5219 /* Return a string allocated in pure space. Do not
5220 allocate the string data, just point to DATA. */
5223 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5226 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5229 s
->data
= (unsigned char *) data
;
5230 s
->intervals
= NULL
;
5231 XSETSTRING (string
, s
);
5235 static Lisp_Object
purecopy (Lisp_Object obj
);
5237 /* Return a cons allocated from pure space. Give it pure copies
5238 of CAR as car and CDR as cdr. */
5241 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5244 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5246 XSETCAR (new, purecopy (car
));
5247 XSETCDR (new, purecopy (cdr
));
5252 /* Value is a float object with value NUM allocated from pure space. */
5255 make_pure_float (double num
)
5258 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5260 XFLOAT_INIT (new, num
);
5265 /* Return a vector with room for LEN Lisp_Objects allocated from
5269 make_pure_vector (ptrdiff_t len
)
5272 size_t size
= header_size
+ len
* word_size
;
5273 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5274 XSETVECTOR (new, p
);
5275 XVECTOR (new)->header
.size
= len
;
5279 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5280 doc
: /* Make a copy of object OBJ in pure storage.
5281 Recursively copies contents of vectors and cons cells.
5282 Does not copy symbols. Copies strings without text properties. */)
5283 (register Lisp_Object obj
)
5285 if (NILP (Vpurify_flag
))
5287 else if (MARKERP (obj
) || OVERLAYP (obj
)
5288 || HASH_TABLE_P (obj
) || SYMBOLP (obj
))
5289 /* Can't purify those. */
5292 return purecopy (obj
);
5296 purecopy (Lisp_Object obj
)
5299 || (! SYMBOLP (obj
) && PURE_P (XPNTR_OR_SYMBOL_OFFSET (obj
)))
5301 return obj
; /* Already pure. */
5303 if (STRINGP (obj
) && XSTRING (obj
)->intervals
)
5304 message_with_string ("Dropping text-properties while making string `%s' pure",
5307 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5309 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5315 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5316 else if (FLOATP (obj
))
5317 obj
= make_pure_float (XFLOAT_DATA (obj
));
5318 else if (STRINGP (obj
))
5319 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5321 STRING_MULTIBYTE (obj
));
5322 else if (COMPILEDP (obj
) || VECTORP (obj
) || HASH_TABLE_P (obj
))
5324 struct Lisp_Vector
*objp
= XVECTOR (obj
);
5325 ptrdiff_t nbytes
= vector_nbytes (objp
);
5326 struct Lisp_Vector
*vec
= pure_alloc (nbytes
, Lisp_Vectorlike
);
5327 register ptrdiff_t i
;
5328 ptrdiff_t size
= ASIZE (obj
);
5329 if (size
& PSEUDOVECTOR_FLAG
)
5330 size
&= PSEUDOVECTOR_SIZE_MASK
;
5331 memcpy (vec
, objp
, nbytes
);
5332 for (i
= 0; i
< size
; i
++)
5333 vec
->contents
[i
] = purecopy (vec
->contents
[i
]);
5334 XSETVECTOR (obj
, vec
);
5336 else if (SYMBOLP (obj
))
5338 if (!XSYMBOL (obj
)->pinned
&& !c_symbol_p (XSYMBOL (obj
)))
5339 { /* We can't purify them, but they appear in many pure objects.
5340 Mark them as `pinned' so we know to mark them at every GC cycle. */
5341 XSYMBOL (obj
)->pinned
= true;
5342 symbol_block_pinned
= symbol_block
;
5344 /* Don't hash-cons it. */
5349 Lisp_Object fmt
= build_pure_c_string ("Don't know how to purify: %S");
5350 Fsignal (Qerror
, list1 (CALLN (Fformat
, fmt
, obj
)));
5353 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5354 Fputhash (obj
, obj
, Vpurify_flag
);
5361 /***********************************************************************
5363 ***********************************************************************/
5365 /* Put an entry in staticvec, pointing at the variable with address
5369 staticpro (Lisp_Object
*varaddress
)
5371 if (staticidx
>= NSTATICS
)
5372 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5373 staticvec
[staticidx
++] = varaddress
;
5377 /***********************************************************************
5379 ***********************************************************************/
5381 /* Temporarily prevent garbage collection. */
5384 inhibit_garbage_collection (void)
5386 ptrdiff_t count
= SPECPDL_INDEX ();
5388 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5392 /* Used to avoid possible overflows when
5393 converting from C to Lisp integers. */
5396 bounded_number (EMACS_INT number
)
5398 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5401 /* Calculate total bytes of live objects. */
5404 total_bytes_of_live_objects (void)
5407 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5408 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5409 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5410 tot
+= total_string_bytes
;
5411 tot
+= total_vector_slots
* word_size
;
5412 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5413 tot
+= total_intervals
* sizeof (struct interval
);
5414 tot
+= total_strings
* sizeof (struct Lisp_String
);
5418 #ifdef HAVE_WINDOW_SYSTEM
5420 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5421 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5424 compact_font_cache_entry (Lisp_Object entry
)
5426 Lisp_Object tail
, *prev
= &entry
;
5428 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5431 Lisp_Object obj
= XCAR (tail
);
5433 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5434 if (CONSP (obj
) && GC_FONT_SPEC_P (XCAR (obj
))
5435 && !VECTOR_MARKED_P (GC_XFONT_SPEC (XCAR (obj
)))
5436 /* Don't use VECTORP here, as that calls ASIZE, which could
5437 hit assertion violation during GC. */
5438 && (VECTORLIKEP (XCDR (obj
))
5439 && ! (gc_asize (XCDR (obj
)) & PSEUDOVECTOR_FLAG
)))
5441 ptrdiff_t i
, size
= gc_asize (XCDR (obj
));
5442 Lisp_Object obj_cdr
= XCDR (obj
);
5444 /* If font-spec is not marked, most likely all font-entities
5445 are not marked too. But we must be sure that nothing is
5446 marked within OBJ before we really drop it. */
5447 for (i
= 0; i
< size
; i
++)
5449 Lisp_Object objlist
;
5451 if (VECTOR_MARKED_P (GC_XFONT_ENTITY (AREF (obj_cdr
, i
))))
5454 objlist
= AREF (AREF (obj_cdr
, i
), FONT_OBJLIST_INDEX
);
5455 for (; CONSP (objlist
); objlist
= XCDR (objlist
))
5457 Lisp_Object val
= XCAR (objlist
);
5458 struct font
*font
= GC_XFONT_OBJECT (val
);
5460 if (!NILP (AREF (val
, FONT_TYPE_INDEX
))
5461 && VECTOR_MARKED_P(font
))
5464 if (CONSP (objlist
))
5466 /* Found a marked font, bail out. */
5473 /* No marked fonts were found, so this entire font
5474 entity can be dropped. */
5479 *prev
= XCDR (tail
);
5481 prev
= xcdr_addr (tail
);
5486 /* Compact font caches on all terminals and mark
5487 everything which is still here after compaction. */
5490 compact_font_caches (void)
5494 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5496 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5501 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5502 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5504 mark_object (cache
);
5508 #else /* not HAVE_WINDOW_SYSTEM */
5510 #define compact_font_caches() (void)(0)
5512 #endif /* HAVE_WINDOW_SYSTEM */
5514 /* Remove (MARKER . DATA) entries with unmarked MARKER
5515 from buffer undo LIST and return changed list. */
5518 compact_undo_list (Lisp_Object list
)
5520 Lisp_Object tail
, *prev
= &list
;
5522 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5524 if (CONSP (XCAR (tail
))
5525 && MARKERP (XCAR (XCAR (tail
)))
5526 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5527 *prev
= XCDR (tail
);
5529 prev
= xcdr_addr (tail
);
5535 mark_pinned_symbols (void)
5537 struct symbol_block
*sblk
;
5538 int lim
= (symbol_block_pinned
== symbol_block
5539 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5541 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5543 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5544 for (; sym
< end
; ++sym
)
5546 mark_object (make_lisp_symbol (&sym
->s
));
5548 lim
= SYMBOL_BLOCK_SIZE
;
5552 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5553 separate function so that we could limit mark_stack in searching
5554 the stack frames below this function, thus avoiding the rare cases
5555 where mark_stack finds values that look like live Lisp objects on
5556 portions of stack that couldn't possibly contain such live objects.
5557 For more details of this, see the discussion at
5558 http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00270.html. */
5560 garbage_collect_1 (void *end
)
5562 struct buffer
*nextb
;
5563 char stack_top_variable
;
5566 ptrdiff_t count
= SPECPDL_INDEX ();
5567 struct timespec start
;
5568 Lisp_Object retval
= Qnil
;
5569 size_t tot_before
= 0;
5574 /* Can't GC if pure storage overflowed because we can't determine
5575 if something is a pure object or not. */
5576 if (pure_bytes_used_before_overflow
)
5579 /* Record this function, so it appears on the profiler's backtraces. */
5580 record_in_backtrace (Qautomatic_gc
, 0, 0);
5584 /* Don't keep undo information around forever.
5585 Do this early on, so it is no problem if the user quits. */
5586 FOR_EACH_BUFFER (nextb
)
5587 compact_buffer (nextb
);
5589 if (profiler_memory_running
)
5590 tot_before
= total_bytes_of_live_objects ();
5592 start
= current_timespec ();
5594 /* In case user calls debug_print during GC,
5595 don't let that cause a recursive GC. */
5596 consing_since_gc
= 0;
5598 /* Save what's currently displayed in the echo area. Don't do that
5599 if we are GC'ing because we've run out of memory, since
5600 push_message will cons, and we might have no memory for that. */
5601 if (NILP (Vmemory_full
))
5603 message_p
= push_message ();
5604 record_unwind_protect_void (pop_message_unwind
);
5609 /* Save a copy of the contents of the stack, for debugging. */
5610 #if MAX_SAVE_STACK > 0
5611 if (NILP (Vpurify_flag
))
5614 ptrdiff_t stack_size
;
5615 if (&stack_top_variable
< stack_bottom
)
5617 stack
= &stack_top_variable
;
5618 stack_size
= stack_bottom
- &stack_top_variable
;
5622 stack
= stack_bottom
;
5623 stack_size
= &stack_top_variable
- stack_bottom
;
5625 if (stack_size
<= MAX_SAVE_STACK
)
5627 if (stack_copy_size
< stack_size
)
5629 stack_copy
= xrealloc (stack_copy
, stack_size
);
5630 stack_copy_size
= stack_size
;
5632 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5635 #endif /* MAX_SAVE_STACK > 0 */
5637 if (garbage_collection_messages
)
5638 message1_nolog ("Garbage collecting...");
5642 shrink_regexp_cache ();
5646 /* Mark all the special slots that serve as the roots of accessibility. */
5648 mark_buffer (&buffer_defaults
);
5649 mark_buffer (&buffer_local_symbols
);
5651 for (i
= 0; i
< ARRAYELTS (lispsym
); i
++)
5652 mark_object (builtin_lisp_symbol (i
));
5654 for (i
= 0; i
< staticidx
; i
++)
5655 mark_object (*staticvec
[i
]);
5657 mark_pinned_symbols ();
5669 struct handler
*handler
;
5670 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5672 mark_object (handler
->tag_or_ch
);
5673 mark_object (handler
->val
);
5676 #ifdef HAVE_WINDOW_SYSTEM
5677 mark_fringe_data ();
5680 /* Everything is now marked, except for the data in font caches,
5681 undo lists, and finalizers. The first two are compacted by
5682 removing an items which aren't reachable otherwise. */
5684 compact_font_caches ();
5686 FOR_EACH_BUFFER (nextb
)
5688 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5689 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5690 /* Now that we have stripped the elements that need not be
5691 in the undo_list any more, we can finally mark the list. */
5692 mark_object (BVAR (nextb
, undo_list
));
5695 /* Now pre-sweep finalizers. Here, we add any unmarked finalizers
5696 to doomed_finalizers so we can run their associated functions
5697 after GC. It's important to scan finalizers at this stage so
5698 that we can be sure that unmarked finalizers are really
5699 unreachable except for references from their associated functions
5700 and from other finalizers. */
5702 queue_doomed_finalizers (&doomed_finalizers
, &finalizers
);
5703 mark_finalizer_list (&doomed_finalizers
);
5707 relocate_byte_stack ();
5709 /* Clear the mark bits that we set in certain root slots. */
5710 VECTOR_UNMARK (&buffer_defaults
);
5711 VECTOR_UNMARK (&buffer_local_symbols
);
5719 consing_since_gc
= 0;
5720 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5721 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5723 gc_relative_threshold
= 0;
5724 if (FLOATP (Vgc_cons_percentage
))
5725 { /* Set gc_cons_combined_threshold. */
5726 double tot
= total_bytes_of_live_objects ();
5728 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5731 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5732 gc_relative_threshold
= tot
;
5734 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5738 if (garbage_collection_messages
&& NILP (Vmemory_full
))
5740 if (message_p
|| minibuf_level
> 0)
5743 message1_nolog ("Garbage collecting...done");
5746 unbind_to (count
, Qnil
);
5748 Lisp_Object total
[] = {
5749 list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5750 bounded_number (total_conses
),
5751 bounded_number (total_free_conses
)),
5752 list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5753 bounded_number (total_symbols
),
5754 bounded_number (total_free_symbols
)),
5755 list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5756 bounded_number (total_markers
),
5757 bounded_number (total_free_markers
)),
5758 list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5759 bounded_number (total_strings
),
5760 bounded_number (total_free_strings
)),
5761 list3 (Qstring_bytes
, make_number (1),
5762 bounded_number (total_string_bytes
)),
5764 make_number (header_size
+ sizeof (Lisp_Object
)),
5765 bounded_number (total_vectors
)),
5766 list4 (Qvector_slots
, make_number (word_size
),
5767 bounded_number (total_vector_slots
),
5768 bounded_number (total_free_vector_slots
)),
5769 list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5770 bounded_number (total_floats
),
5771 bounded_number (total_free_floats
)),
5772 list4 (Qintervals
, make_number (sizeof (struct interval
)),
5773 bounded_number (total_intervals
),
5774 bounded_number (total_free_intervals
)),
5775 list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5776 bounded_number (total_buffers
)),
5778 #ifdef DOUG_LEA_MALLOC
5779 list4 (Qheap
, make_number (1024),
5780 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5781 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)),
5784 retval
= CALLMANY (Flist
, total
);
5786 /* GC is complete: now we can run our finalizer callbacks. */
5787 run_finalizers (&doomed_finalizers
);
5789 if (!NILP (Vpost_gc_hook
))
5791 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5792 safe_run_hooks (Qpost_gc_hook
);
5793 unbind_to (gc_count
, Qnil
);
5796 /* Accumulate statistics. */
5797 if (FLOATP (Vgc_elapsed
))
5799 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5800 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5801 + timespectod (since_start
));
5806 /* Collect profiling data. */
5807 if (profiler_memory_running
)
5810 size_t tot_after
= total_bytes_of_live_objects ();
5811 if (tot_before
> tot_after
)
5812 swept
= tot_before
- tot_after
;
5813 malloc_probe (swept
);
5819 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5820 doc
: /* Reclaim storage for Lisp objects no longer needed.
5821 Garbage collection happens automatically if you cons more than
5822 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5823 `garbage-collect' normally returns a list with info on amount of space in use,
5824 where each entry has the form (NAME SIZE USED FREE), where:
5825 - NAME is a symbol describing the kind of objects this entry represents,
5826 - SIZE is the number of bytes used by each one,
5827 - USED is the number of those objects that were found live in the heap,
5828 - FREE is the number of those objects that are not live but that Emacs
5829 keeps around for future allocations (maybe because it does not know how
5830 to return them to the OS).
5831 However, if there was overflow in pure space, `garbage-collect'
5832 returns nil, because real GC can't be done.
5833 See Info node `(elisp)Garbage Collection'. */)
5838 #ifdef HAVE___BUILTIN_UNWIND_INIT
5839 /* Force callee-saved registers and register windows onto the stack.
5840 This is the preferred method if available, obviating the need for
5841 machine dependent methods. */
5842 __builtin_unwind_init ();
5844 #else /* not HAVE___BUILTIN_UNWIND_INIT */
5845 #ifndef GC_SAVE_REGISTERS_ON_STACK
5846 /* jmp_buf may not be aligned enough on darwin-ppc64 */
5847 union aligned_jmpbuf
{
5851 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
5853 /* This trick flushes the register windows so that all the state of
5854 the process is contained in the stack. */
5855 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
5856 needed on ia64 too. See mach_dep.c, where it also says inline
5857 assembler doesn't work with relevant proprietary compilers. */
5859 #if defined (__sparc64__) && defined (__FreeBSD__)
5860 /* FreeBSD does not have a ta 3 handler. */
5867 /* Save registers that we need to see on the stack. We need to see
5868 registers used to hold register variables and registers used to
5870 #ifdef GC_SAVE_REGISTERS_ON_STACK
5871 GC_SAVE_REGISTERS_ON_STACK (end
);
5872 #else /* not GC_SAVE_REGISTERS_ON_STACK */
5874 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
5875 setjmp will definitely work, test it
5876 and print a message with the result
5878 if (!setjmp_tested_p
)
5880 setjmp_tested_p
= 1;
5883 #endif /* GC_SETJMP_WORKS */
5886 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
5887 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
5888 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
5889 return garbage_collect_1 (end
);
5892 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5893 only interesting objects referenced from glyphs are strings. */
5896 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5898 struct glyph_row
*row
= matrix
->rows
;
5899 struct glyph_row
*end
= row
+ matrix
->nrows
;
5901 for (; row
< end
; ++row
)
5905 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5907 struct glyph
*glyph
= row
->glyphs
[area
];
5908 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5910 for (; glyph
< end_glyph
; ++glyph
)
5911 if (STRINGP (glyph
->object
)
5912 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5913 mark_object (glyph
->object
);
5918 /* Mark reference to a Lisp_Object.
5919 If the object referred to has not been seen yet, recursively mark
5920 all the references contained in it. */
5922 #define LAST_MARKED_SIZE 500
5923 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5924 static int last_marked_index
;
5926 /* For debugging--call abort when we cdr down this many
5927 links of a list, in mark_object. In debugging,
5928 the call to abort will hit a breakpoint.
5929 Normally this is zero and the check never goes off. */
5930 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5933 mark_vectorlike (struct Lisp_Vector
*ptr
)
5935 ptrdiff_t size
= ptr
->header
.size
;
5938 eassert (!VECTOR_MARKED_P (ptr
));
5939 VECTOR_MARK (ptr
); /* Else mark it. */
5940 if (size
& PSEUDOVECTOR_FLAG
)
5941 size
&= PSEUDOVECTOR_SIZE_MASK
;
5943 /* Note that this size is not the memory-footprint size, but only
5944 the number of Lisp_Object fields that we should trace.
5945 The distinction is used e.g. by Lisp_Process which places extra
5946 non-Lisp_Object fields at the end of the structure... */
5947 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5948 mark_object (ptr
->contents
[i
]);
5951 /* Like mark_vectorlike but optimized for char-tables (and
5952 sub-char-tables) assuming that the contents are mostly integers or
5956 mark_char_table (struct Lisp_Vector
*ptr
, enum pvec_type pvectype
)
5958 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5959 /* Consult the Lisp_Sub_Char_Table layout before changing this. */
5960 int i
, idx
= (pvectype
== PVEC_SUB_CHAR_TABLE
? SUB_CHAR_TABLE_OFFSET
: 0);
5962 eassert (!VECTOR_MARKED_P (ptr
));
5964 for (i
= idx
; i
< size
; i
++)
5966 Lisp_Object val
= ptr
->contents
[i
];
5968 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5970 if (SUB_CHAR_TABLE_P (val
))
5972 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5973 mark_char_table (XVECTOR (val
), PVEC_SUB_CHAR_TABLE
);
5980 NO_INLINE
/* To reduce stack depth in mark_object. */
5982 mark_compiled (struct Lisp_Vector
*ptr
)
5984 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5987 for (i
= 0; i
< size
; i
++)
5988 if (i
!= COMPILED_CONSTANTS
)
5989 mark_object (ptr
->contents
[i
]);
5990 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
5993 /* Mark the chain of overlays starting at PTR. */
5996 mark_overlay (struct Lisp_Overlay
*ptr
)
5998 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
6001 /* These two are always markers and can be marked fast. */
6002 XMARKER (ptr
->start
)->gcmarkbit
= 1;
6003 XMARKER (ptr
->end
)->gcmarkbit
= 1;
6004 mark_object (ptr
->plist
);
6008 /* Mark Lisp_Objects and special pointers in BUFFER. */
6011 mark_buffer (struct buffer
*buffer
)
6013 /* This is handled much like other pseudovectors... */
6014 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
6016 /* ...but there are some buffer-specific things. */
6018 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
6020 /* For now, we just don't mark the undo_list. It's done later in
6021 a special way just before the sweep phase, and after stripping
6022 some of its elements that are not needed any more. */
6024 mark_overlay (buffer
->overlays_before
);
6025 mark_overlay (buffer
->overlays_after
);
6027 /* If this is an indirect buffer, mark its base buffer. */
6028 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
6029 mark_buffer (buffer
->base_buffer
);
6032 /* Mark Lisp faces in the face cache C. */
6034 NO_INLINE
/* To reduce stack depth in mark_object. */
6036 mark_face_cache (struct face_cache
*c
)
6041 for (i
= 0; i
< c
->used
; ++i
)
6043 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
6047 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
6048 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
6050 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
6051 mark_object (face
->lface
[j
]);
6057 NO_INLINE
/* To reduce stack depth in mark_object. */
6059 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
6061 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6062 Lisp_Object where
= blv
->where
;
6063 /* If the value is set up for a killed buffer or deleted
6064 frame, restore its global binding. If the value is
6065 forwarded to a C variable, either it's not a Lisp_Object
6066 var, or it's staticpro'd already. */
6067 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
6068 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
6069 swap_in_global_binding (ptr
);
6070 mark_object (blv
->where
);
6071 mark_object (blv
->valcell
);
6072 mark_object (blv
->defcell
);
6075 NO_INLINE
/* To reduce stack depth in mark_object. */
6077 mark_save_value (struct Lisp_Save_Value
*ptr
)
6079 /* If `save_type' is zero, `data[0].pointer' is the address
6080 of a memory area containing `data[1].integer' potential
6082 if (ptr
->save_type
== SAVE_TYPE_MEMORY
)
6084 Lisp_Object
*p
= ptr
->data
[0].pointer
;
6086 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
6087 mark_maybe_object (*p
);
6091 /* Find Lisp_Objects in `data[N]' slots and mark them. */
6093 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
6094 if (save_type (ptr
, i
) == SAVE_OBJECT
)
6095 mark_object (ptr
->data
[i
].object
);
6099 /* Remove killed buffers or items whose car is a killed buffer from
6100 LIST, and mark other items. Return changed LIST, which is marked. */
6103 mark_discard_killed_buffers (Lisp_Object list
)
6105 Lisp_Object tail
, *prev
= &list
;
6107 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
6110 Lisp_Object tem
= XCAR (tail
);
6113 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
6114 *prev
= XCDR (tail
);
6117 CONS_MARK (XCONS (tail
));
6118 mark_object (XCAR (tail
));
6119 prev
= xcdr_addr (tail
);
6126 /* Determine type of generic Lisp_Object and mark it accordingly.
6128 This function implements a straightforward depth-first marking
6129 algorithm and so the recursion depth may be very high (a few
6130 tens of thousands is not uncommon). To minimize stack usage,
6131 a few cold paths are moved out to NO_INLINE functions above.
6132 In general, inlining them doesn't help you to gain more speed. */
6135 mark_object (Lisp_Object arg
)
6137 register Lisp_Object obj
;
6139 #ifdef GC_CHECK_MARKED_OBJECTS
6142 ptrdiff_t cdr_count
= 0;
6151 last_marked
[last_marked_index
++] = obj
;
6152 if (last_marked_index
== LAST_MARKED_SIZE
)
6153 last_marked_index
= 0;
6155 /* Perform some sanity checks on the objects marked here. Abort if
6156 we encounter an object we know is bogus. This increases GC time
6158 #ifdef GC_CHECK_MARKED_OBJECTS
6160 /* Check that the object pointed to by PO is known to be a Lisp
6161 structure allocated from the heap. */
6162 #define CHECK_ALLOCATED() \
6164 m = mem_find (po); \
6169 /* Check that the object pointed to by PO is live, using predicate
6171 #define CHECK_LIVE(LIVEP) \
6173 if (!LIVEP (m, po)) \
6177 /* Check both of the above conditions, for non-symbols. */
6178 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6180 CHECK_ALLOCATED (); \
6181 CHECK_LIVE (LIVEP); \
6184 /* Check both of the above conditions, for symbols. */
6185 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() \
6187 if (!c_symbol_p (ptr)) \
6189 CHECK_ALLOCATED (); \
6190 CHECK_LIVE (live_symbol_p); \
6194 #else /* not GC_CHECK_MARKED_OBJECTS */
6196 #define CHECK_LIVE(LIVEP) ((void) 0)
6197 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) ((void) 0)
6198 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() ((void) 0)
6200 #endif /* not GC_CHECK_MARKED_OBJECTS */
6202 switch (XTYPE (obj
))
6206 register struct Lisp_String
*ptr
= XSTRING (obj
);
6207 if (STRING_MARKED_P (ptr
))
6209 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6211 MARK_INTERVAL_TREE (ptr
->intervals
);
6212 #ifdef GC_CHECK_STRING_BYTES
6213 /* Check that the string size recorded in the string is the
6214 same as the one recorded in the sdata structure. */
6216 #endif /* GC_CHECK_STRING_BYTES */
6220 case Lisp_Vectorlike
:
6222 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6223 register ptrdiff_t pvectype
;
6225 if (VECTOR_MARKED_P (ptr
))
6228 #ifdef GC_CHECK_MARKED_OBJECTS
6230 if (m
== MEM_NIL
&& !SUBRP (obj
))
6232 #endif /* GC_CHECK_MARKED_OBJECTS */
6234 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6235 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6236 >> PSEUDOVECTOR_AREA_BITS
);
6238 pvectype
= PVEC_NORMAL_VECTOR
;
6240 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6241 CHECK_LIVE (live_vector_p
);
6246 #ifdef GC_CHECK_MARKED_OBJECTS
6255 #endif /* GC_CHECK_MARKED_OBJECTS */
6256 mark_buffer ((struct buffer
*) ptr
);
6260 /* Although we could treat this just like a vector, mark_compiled
6261 returns the COMPILED_CONSTANTS element, which is marked at the
6262 next iteration of goto-loop here. This is done to avoid a few
6263 recursive calls to mark_object. */
6264 obj
= mark_compiled (ptr
);
6271 struct frame
*f
= (struct frame
*) ptr
;
6273 mark_vectorlike (ptr
);
6274 mark_face_cache (f
->face_cache
);
6275 #ifdef HAVE_WINDOW_SYSTEM
6276 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6278 struct font
*font
= FRAME_FONT (f
);
6280 if (font
&& !VECTOR_MARKED_P (font
))
6281 mark_vectorlike ((struct Lisp_Vector
*) font
);
6289 struct window
*w
= (struct window
*) ptr
;
6291 mark_vectorlike (ptr
);
6293 /* Mark glyph matrices, if any. Marking window
6294 matrices is sufficient because frame matrices
6295 use the same glyph memory. */
6296 if (w
->current_matrix
)
6298 mark_glyph_matrix (w
->current_matrix
);
6299 mark_glyph_matrix (w
->desired_matrix
);
6302 /* Filter out killed buffers from both buffer lists
6303 in attempt to help GC to reclaim killed buffers faster.
6304 We can do it elsewhere for live windows, but this is the
6305 best place to do it for dead windows. */
6307 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6309 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6313 case PVEC_HASH_TABLE
:
6315 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6317 mark_vectorlike (ptr
);
6318 mark_object (h
->test
.name
);
6319 mark_object (h
->test
.user_hash_function
);
6320 mark_object (h
->test
.user_cmp_function
);
6321 /* If hash table is not weak, mark all keys and values.
6322 For weak tables, mark only the vector. */
6324 mark_object (h
->key_and_value
);
6326 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6330 case PVEC_CHAR_TABLE
:
6331 case PVEC_SUB_CHAR_TABLE
:
6332 mark_char_table (ptr
, (enum pvec_type
) pvectype
);
6335 case PVEC_BOOL_VECTOR
:
6336 /* No Lisp_Objects to mark in a bool vector. */
6347 mark_vectorlike (ptr
);
6354 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6358 CHECK_ALLOCATED_AND_LIVE_SYMBOL ();
6360 /* Attempt to catch bogus objects. */
6361 eassert (valid_lisp_object_p (ptr
->function
));
6362 mark_object (ptr
->function
);
6363 mark_object (ptr
->plist
);
6364 switch (ptr
->redirect
)
6366 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6367 case SYMBOL_VARALIAS
:
6370 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6374 case SYMBOL_LOCALIZED
:
6375 mark_localized_symbol (ptr
);
6377 case SYMBOL_FORWARDED
:
6378 /* If the value is forwarded to a buffer or keyboard field,
6379 these are marked when we see the corresponding object.
6380 And if it's forwarded to a C variable, either it's not
6381 a Lisp_Object var, or it's staticpro'd already. */
6383 default: emacs_abort ();
6385 if (!PURE_P (XSTRING (ptr
->name
)))
6386 MARK_STRING (XSTRING (ptr
->name
));
6387 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6388 /* Inner loop to mark next symbol in this bucket, if any. */
6389 po
= ptr
= ptr
->next
;
6396 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6398 if (XMISCANY (obj
)->gcmarkbit
)
6401 switch (XMISCTYPE (obj
))
6403 case Lisp_Misc_Marker
:
6404 /* DO NOT mark thru the marker's chain.
6405 The buffer's markers chain does not preserve markers from gc;
6406 instead, markers are removed from the chain when freed by gc. */
6407 XMISCANY (obj
)->gcmarkbit
= 1;
6410 case Lisp_Misc_Save_Value
:
6411 XMISCANY (obj
)->gcmarkbit
= 1;
6412 mark_save_value (XSAVE_VALUE (obj
));
6415 case Lisp_Misc_Overlay
:
6416 mark_overlay (XOVERLAY (obj
));
6419 case Lisp_Misc_Finalizer
:
6420 XMISCANY (obj
)->gcmarkbit
= true;
6421 mark_object (XFINALIZER (obj
)->function
);
6425 case Lisp_Misc_User_Ptr
:
6426 XMISCANY (obj
)->gcmarkbit
= true;
6437 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6438 if (CONS_MARKED_P (ptr
))
6440 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6442 /* If the cdr is nil, avoid recursion for the car. */
6443 if (EQ (ptr
->u
.cdr
, Qnil
))
6449 mark_object (ptr
->car
);
6452 if (cdr_count
== mark_object_loop_halt
)
6458 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6459 FLOAT_MARK (XFLOAT (obj
));
6470 #undef CHECK_ALLOCATED
6471 #undef CHECK_ALLOCATED_AND_LIVE
6473 /* Mark the Lisp pointers in the terminal objects.
6474 Called by Fgarbage_collect. */
6477 mark_terminals (void)
6480 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6482 eassert (t
->name
!= NULL
);
6483 #ifdef HAVE_WINDOW_SYSTEM
6484 /* If a terminal object is reachable from a stacpro'ed object,
6485 it might have been marked already. Make sure the image cache
6487 mark_image_cache (t
->image_cache
);
6488 #endif /* HAVE_WINDOW_SYSTEM */
6489 if (!VECTOR_MARKED_P (t
))
6490 mark_vectorlike ((struct Lisp_Vector
*)t
);
6496 /* Value is non-zero if OBJ will survive the current GC because it's
6497 either marked or does not need to be marked to survive. */
6500 survives_gc_p (Lisp_Object obj
)
6504 switch (XTYPE (obj
))
6511 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6515 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6519 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6522 case Lisp_Vectorlike
:
6523 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6527 survives_p
= CONS_MARKED_P (XCONS (obj
));
6531 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6538 return survives_p
|| PURE_P (XPNTR (obj
));
6544 NO_INLINE
/* For better stack traces */
6548 struct cons_block
*cblk
;
6549 struct cons_block
**cprev
= &cons_block
;
6550 int lim
= cons_block_index
;
6551 EMACS_INT num_free
= 0, num_used
= 0;
6555 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6559 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6561 /* Scan the mark bits an int at a time. */
6562 for (i
= 0; i
< ilim
; i
++)
6564 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6566 /* Fast path - all cons cells for this int are marked. */
6567 cblk
->gcmarkbits
[i
] = 0;
6568 num_used
+= BITS_PER_BITS_WORD
;
6572 /* Some cons cells for this int are not marked.
6573 Find which ones, and free them. */
6574 int start
, pos
, stop
;
6576 start
= i
* BITS_PER_BITS_WORD
;
6578 if (stop
> BITS_PER_BITS_WORD
)
6579 stop
= BITS_PER_BITS_WORD
;
6582 for (pos
= start
; pos
< stop
; pos
++)
6584 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6587 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6588 cons_free_list
= &cblk
->conses
[pos
];
6589 cons_free_list
->car
= Vdead
;
6594 CONS_UNMARK (&cblk
->conses
[pos
]);
6600 lim
= CONS_BLOCK_SIZE
;
6601 /* If this block contains only free conses and we have already
6602 seen more than two blocks worth of free conses then deallocate
6604 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6606 *cprev
= cblk
->next
;
6607 /* Unhook from the free list. */
6608 cons_free_list
= cblk
->conses
[0].u
.chain
;
6609 lisp_align_free (cblk
);
6613 num_free
+= this_free
;
6614 cprev
= &cblk
->next
;
6617 total_conses
= num_used
;
6618 total_free_conses
= num_free
;
6621 NO_INLINE
/* For better stack traces */
6625 register struct float_block
*fblk
;
6626 struct float_block
**fprev
= &float_block
;
6627 register int lim
= float_block_index
;
6628 EMACS_INT num_free
= 0, num_used
= 0;
6630 float_free_list
= 0;
6632 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6636 for (i
= 0; i
< lim
; i
++)
6637 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6640 fblk
->floats
[i
].u
.chain
= float_free_list
;
6641 float_free_list
= &fblk
->floats
[i
];
6646 FLOAT_UNMARK (&fblk
->floats
[i
]);
6648 lim
= FLOAT_BLOCK_SIZE
;
6649 /* If this block contains only free floats and we have already
6650 seen more than two blocks worth of free floats then deallocate
6652 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6654 *fprev
= fblk
->next
;
6655 /* Unhook from the free list. */
6656 float_free_list
= fblk
->floats
[0].u
.chain
;
6657 lisp_align_free (fblk
);
6661 num_free
+= this_free
;
6662 fprev
= &fblk
->next
;
6665 total_floats
= num_used
;
6666 total_free_floats
= num_free
;
6669 NO_INLINE
/* For better stack traces */
6671 sweep_intervals (void)
6673 register struct interval_block
*iblk
;
6674 struct interval_block
**iprev
= &interval_block
;
6675 register int lim
= interval_block_index
;
6676 EMACS_INT num_free
= 0, num_used
= 0;
6678 interval_free_list
= 0;
6680 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6685 for (i
= 0; i
< lim
; i
++)
6687 if (!iblk
->intervals
[i
].gcmarkbit
)
6689 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6690 interval_free_list
= &iblk
->intervals
[i
];
6696 iblk
->intervals
[i
].gcmarkbit
= 0;
6699 lim
= INTERVAL_BLOCK_SIZE
;
6700 /* If this block contains only free intervals and we have already
6701 seen more than two blocks worth of free intervals then
6702 deallocate this block. */
6703 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6705 *iprev
= iblk
->next
;
6706 /* Unhook from the free list. */
6707 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6712 num_free
+= this_free
;
6713 iprev
= &iblk
->next
;
6716 total_intervals
= num_used
;
6717 total_free_intervals
= num_free
;
6720 NO_INLINE
/* For better stack traces */
6722 sweep_symbols (void)
6724 struct symbol_block
*sblk
;
6725 struct symbol_block
**sprev
= &symbol_block
;
6726 int lim
= symbol_block_index
;
6727 EMACS_INT num_free
= 0, num_used
= ARRAYELTS (lispsym
);
6729 symbol_free_list
= NULL
;
6731 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
6732 lispsym
[i
].gcmarkbit
= 0;
6734 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6737 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6738 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6740 for (; sym
< end
; ++sym
)
6742 if (!sym
->s
.gcmarkbit
)
6744 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6745 xfree (SYMBOL_BLV (&sym
->s
));
6746 sym
->s
.next
= symbol_free_list
;
6747 symbol_free_list
= &sym
->s
;
6748 symbol_free_list
->function
= Vdead
;
6754 sym
->s
.gcmarkbit
= 0;
6755 /* Attempt to catch bogus objects. */
6756 eassert (valid_lisp_object_p (sym
->s
.function
));
6760 lim
= SYMBOL_BLOCK_SIZE
;
6761 /* If this block contains only free symbols and we have already
6762 seen more than two blocks worth of free symbols then deallocate
6764 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6766 *sprev
= sblk
->next
;
6767 /* Unhook from the free list. */
6768 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6773 num_free
+= this_free
;
6774 sprev
= &sblk
->next
;
6777 total_symbols
= num_used
;
6778 total_free_symbols
= num_free
;
6781 NO_INLINE
/* For better stack traces. */
6785 register struct marker_block
*mblk
;
6786 struct marker_block
**mprev
= &marker_block
;
6787 register int lim
= marker_block_index
;
6788 EMACS_INT num_free
= 0, num_used
= 0;
6790 /* Put all unmarked misc's on free list. For a marker, first
6791 unchain it from the buffer it points into. */
6793 marker_free_list
= 0;
6795 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6800 for (i
= 0; i
< lim
; i
++)
6802 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6804 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6805 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6806 else if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Finalizer
)
6807 unchain_finalizer (&mblk
->markers
[i
].m
.u_finalizer
);
6809 else if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_User_Ptr
)
6811 struct Lisp_User_Ptr
*uptr
= &mblk
->markers
[i
].m
.u_user_ptr
;
6812 uptr
->finalizer (uptr
->p
);
6815 /* Set the type of the freed object to Lisp_Misc_Free.
6816 We could leave the type alone, since nobody checks it,
6817 but this might catch bugs faster. */
6818 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6819 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6820 marker_free_list
= &mblk
->markers
[i
].m
;
6826 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6829 lim
= MARKER_BLOCK_SIZE
;
6830 /* If this block contains only free markers and we have already
6831 seen more than two blocks worth of free markers then deallocate
6833 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6835 *mprev
= mblk
->next
;
6836 /* Unhook from the free list. */
6837 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6842 num_free
+= this_free
;
6843 mprev
= &mblk
->next
;
6847 total_markers
= num_used
;
6848 total_free_markers
= num_free
;
6851 NO_INLINE
/* For better stack traces */
6853 sweep_buffers (void)
6855 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6858 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6859 if (!VECTOR_MARKED_P (buffer
))
6861 *bprev
= buffer
->next
;
6866 VECTOR_UNMARK (buffer
);
6867 /* Do not use buffer_(set|get)_intervals here. */
6868 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6870 bprev
= &buffer
->next
;
6874 /* Sweep: find all structures not marked, and free them. */
6878 /* Remove or mark entries in weak hash tables.
6879 This must be done before any object is unmarked. */
6880 sweep_weak_hash_tables ();
6883 check_string_bytes (!noninteractive
);
6891 check_string_bytes (!noninteractive
);
6894 DEFUN ("memory-info", Fmemory_info
, Smemory_info
, 0, 0, 0,
6895 doc
: /* Return a list of (TOTAL-RAM FREE-RAM TOTAL-SWAP FREE-SWAP).
6896 All values are in Kbytes. If there is no swap space,
6897 last two values are zero. If the system is not supported
6898 or memory information can't be obtained, return nil. */)
6901 #if defined HAVE_LINUX_SYSINFO
6907 #ifdef LINUX_SYSINFO_UNIT
6908 units
= si
.mem_unit
;
6912 return list4i ((uintmax_t) si
.totalram
* units
/ 1024,
6913 (uintmax_t) si
.freeram
* units
/ 1024,
6914 (uintmax_t) si
.totalswap
* units
/ 1024,
6915 (uintmax_t) si
.freeswap
* units
/ 1024);
6916 #elif defined WINDOWSNT
6917 unsigned long long totalram
, freeram
, totalswap
, freeswap
;
6919 if (w32_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6920 return list4i ((uintmax_t) totalram
/ 1024,
6921 (uintmax_t) freeram
/ 1024,
6922 (uintmax_t) totalswap
/ 1024,
6923 (uintmax_t) freeswap
/ 1024);
6927 unsigned long totalram
, freeram
, totalswap
, freeswap
;
6929 if (dos_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6930 return list4i ((uintmax_t) totalram
/ 1024,
6931 (uintmax_t) freeram
/ 1024,
6932 (uintmax_t) totalswap
/ 1024,
6933 (uintmax_t) freeswap
/ 1024);
6936 #else /* not HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6937 /* FIXME: add more systems. */
6939 #endif /* HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6942 /* Debugging aids. */
6944 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6945 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6946 This may be helpful in debugging Emacs's memory usage.
6947 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6953 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
6956 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6962 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6963 doc
: /* Return a list of counters that measure how much consing there has been.
6964 Each of these counters increments for a certain kind of object.
6965 The counters wrap around from the largest positive integer to zero.
6966 Garbage collection does not decrease them.
6967 The elements of the value are as follows:
6968 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6969 All are in units of 1 = one object consed
6970 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6972 MISCS include overlays, markers, and some internal types.
6973 Frames, windows, buffers, and subprocesses count as vectors
6974 (but the contents of a buffer's text do not count here). */)
6977 return listn (CONSTYPE_HEAP
, 8,
6978 bounded_number (cons_cells_consed
),
6979 bounded_number (floats_consed
),
6980 bounded_number (vector_cells_consed
),
6981 bounded_number (symbols_consed
),
6982 bounded_number (string_chars_consed
),
6983 bounded_number (misc_objects_consed
),
6984 bounded_number (intervals_consed
),
6985 bounded_number (strings_consed
));
6989 symbol_uses_obj (Lisp_Object symbol
, Lisp_Object obj
)
6991 struct Lisp_Symbol
*sym
= XSYMBOL (symbol
);
6992 Lisp_Object val
= find_symbol_value (symbol
);
6993 return (EQ (val
, obj
)
6994 || EQ (sym
->function
, obj
)
6995 || (!NILP (sym
->function
)
6996 && COMPILEDP (sym
->function
)
6997 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
7000 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)));
7003 /* Find at most FIND_MAX symbols which have OBJ as their value or
7004 function. This is used in gdbinit's `xwhichsymbols' command. */
7007 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
7009 struct symbol_block
*sblk
;
7010 ptrdiff_t gc_count
= inhibit_garbage_collection ();
7011 Lisp_Object found
= Qnil
;
7015 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
7017 Lisp_Object sym
= builtin_lisp_symbol (i
);
7018 if (symbol_uses_obj (sym
, obj
))
7020 found
= Fcons (sym
, found
);
7021 if (--find_max
== 0)
7026 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
7028 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
7031 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
7033 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
7036 Lisp_Object sym
= make_lisp_symbol (&aligned_sym
->s
);
7037 if (symbol_uses_obj (sym
, obj
))
7039 found
= Fcons (sym
, found
);
7040 if (--find_max
== 0)
7048 unbind_to (gc_count
, Qnil
);
7052 #ifdef SUSPICIOUS_OBJECT_CHECKING
7055 find_suspicious_object_in_range (void *begin
, void *end
)
7057 char *begin_a
= begin
;
7061 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7063 char *suspicious_object
= suspicious_objects
[i
];
7064 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
7065 return suspicious_object
;
7072 note_suspicious_free (void* ptr
)
7074 struct suspicious_free_record
* rec
;
7076 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
7077 if (suspicious_free_history_index
==
7078 ARRAYELTS (suspicious_free_history
))
7080 suspicious_free_history_index
= 0;
7083 memset (rec
, 0, sizeof (*rec
));
7084 rec
->suspicious_object
= ptr
;
7085 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
7089 detect_suspicious_free (void* ptr
)
7093 eassert (ptr
!= NULL
);
7095 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7096 if (suspicious_objects
[i
] == ptr
)
7098 note_suspicious_free (ptr
);
7099 suspicious_objects
[i
] = NULL
;
7103 #endif /* SUSPICIOUS_OBJECT_CHECKING */
7105 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
7106 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
7107 If Emacs is compiled with suspicious object checking, capture
7108 a stack trace when OBJ is freed in order to help track down
7109 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
7112 #ifdef SUSPICIOUS_OBJECT_CHECKING
7113 /* Right now, we care only about vectors. */
7114 if (VECTORLIKEP (obj
))
7116 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
7117 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
7118 suspicious_object_index
= 0;
7124 #ifdef ENABLE_CHECKING
7126 bool suppress_checking
;
7129 die (const char *msg
, const char *file
, int line
)
7131 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
7133 terminate_due_to_signal (SIGABRT
, INT_MAX
);
7136 #endif /* ENABLE_CHECKING */
7138 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
7140 /* Debugging check whether STR is ASCII-only. */
7143 verify_ascii (const char *str
)
7145 const unsigned char *ptr
= (unsigned char *) str
, *end
= ptr
+ strlen (str
);
7148 int c
= STRING_CHAR_ADVANCE (ptr
);
7149 if (!ASCII_CHAR_P (c
))
7155 /* Stress alloca with inconveniently sized requests and check
7156 whether all allocated areas may be used for Lisp_Object. */
7158 NO_INLINE
static void
7159 verify_alloca (void)
7162 enum { ALLOCA_CHECK_MAX
= 256 };
7163 /* Start from size of the smallest Lisp object. */
7164 for (i
= sizeof (struct Lisp_Cons
); i
<= ALLOCA_CHECK_MAX
; i
++)
7166 void *ptr
= alloca (i
);
7167 make_lisp_ptr (ptr
, Lisp_Cons
);
7171 #else /* not ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7173 #define verify_alloca() ((void) 0)
7175 #endif /* ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7177 /* Initialization. */
7180 init_alloc_once (void)
7182 /* Even though Qt's contents are not set up, its address is known. */
7186 pure_size
= PURESIZE
;
7189 init_finalizer_list (&finalizers
);
7190 init_finalizer_list (&doomed_finalizers
);
7193 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
7195 #ifdef DOUG_LEA_MALLOC
7196 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
7197 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
7198 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
7203 refill_memory_reserve ();
7204 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
7210 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
7211 setjmp_tested_p
= longjmps_done
= 0;
7213 Vgc_elapsed
= make_float (0.0);
7217 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
7222 syms_of_alloc (void)
7224 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
7225 doc
: /* Number of bytes of consing between garbage collections.
7226 Garbage collection can happen automatically once this many bytes have been
7227 allocated since the last garbage collection. All data types count.
7229 Garbage collection happens automatically only when `eval' is called.
7231 By binding this temporarily to a large number, you can effectively
7232 prevent garbage collection during a part of the program.
7233 See also `gc-cons-percentage'. */);
7235 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
7236 doc
: /* Portion of the heap used for allocation.
7237 Garbage collection can happen automatically once this portion of the heap
7238 has been allocated since the last garbage collection.
7239 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
7240 Vgc_cons_percentage
= make_float (0.1);
7242 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
7243 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
7245 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
7246 doc
: /* Number of cons cells that have been consed so far. */);
7248 DEFVAR_INT ("floats-consed", floats_consed
,
7249 doc
: /* Number of floats that have been consed so far. */);
7251 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7252 doc
: /* Number of vector cells that have been consed so far. */);
7254 DEFVAR_INT ("symbols-consed", symbols_consed
,
7255 doc
: /* Number of symbols that have been consed so far. */);
7256 symbols_consed
+= ARRAYELTS (lispsym
);
7258 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7259 doc
: /* Number of string characters that have been consed so far. */);
7261 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7262 doc
: /* Number of miscellaneous objects that have been consed so far.
7263 These include markers and overlays, plus certain objects not visible
7266 DEFVAR_INT ("intervals-consed", intervals_consed
,
7267 doc
: /* Number of intervals that have been consed so far. */);
7269 DEFVAR_INT ("strings-consed", strings_consed
,
7270 doc
: /* Number of strings that have been consed so far. */);
7272 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7273 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7274 This means that certain objects should be allocated in shared (pure) space.
7275 It can also be set to a hash-table, in which case this table is used to
7276 do hash-consing of the objects allocated to pure space. */);
7278 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7279 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7280 garbage_collection_messages
= 0;
7282 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7283 doc
: /* Hook run after garbage collection has finished. */);
7284 Vpost_gc_hook
= Qnil
;
7285 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7287 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7288 doc
: /* Precomputed `signal' argument for memory-full error. */);
7289 /* We build this in advance because if we wait until we need it, we might
7290 not be able to allocate the memory to hold it. */
7292 = listn (CONSTYPE_PURE
, 2, Qerror
,
7293 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7295 DEFVAR_LISP ("memory-full", Vmemory_full
,
7296 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7297 Vmemory_full
= Qnil
;
7299 DEFSYM (Qconses
, "conses");
7300 DEFSYM (Qsymbols
, "symbols");
7301 DEFSYM (Qmiscs
, "miscs");
7302 DEFSYM (Qstrings
, "strings");
7303 DEFSYM (Qvectors
, "vectors");
7304 DEFSYM (Qfloats
, "floats");
7305 DEFSYM (Qintervals
, "intervals");
7306 DEFSYM (Qbuffers
, "buffers");
7307 DEFSYM (Qstring_bytes
, "string-bytes");
7308 DEFSYM (Qvector_slots
, "vector-slots");
7309 DEFSYM (Qheap
, "heap");
7310 DEFSYM (Qautomatic_gc
, "Automatic GC");
7312 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7313 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7315 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7316 doc
: /* Accumulated time elapsed in garbage collections.
7317 The time is in seconds as a floating point value. */);
7318 DEFVAR_INT ("gcs-done", gcs_done
,
7319 doc
: /* Accumulated number of garbage collections done. */);
7324 defsubr (&Sbool_vector
);
7325 defsubr (&Smake_byte_code
);
7326 defsubr (&Smake_list
);
7327 defsubr (&Smake_vector
);
7328 defsubr (&Smake_string
);
7329 defsubr (&Smake_bool_vector
);
7330 defsubr (&Smake_symbol
);
7331 defsubr (&Smake_marker
);
7332 defsubr (&Smake_finalizer
);
7333 defsubr (&Spurecopy
);
7334 defsubr (&Sgarbage_collect
);
7335 defsubr (&Smemory_limit
);
7336 defsubr (&Smemory_info
);
7337 defsubr (&Smemory_use_counts
);
7338 defsubr (&Ssuspicious_object
);
7341 /* When compiled with GCC, GDB might say "No enum type named
7342 pvec_type" if we don't have at least one symbol with that type, and
7343 then xbacktrace could fail. Similarly for the other enums and
7344 their values. Some non-GCC compilers don't like these constructs. */
7348 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7349 enum char_table_specials char_table_specials
;
7350 enum char_bits char_bits
;
7351 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7352 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7353 enum Lisp_Bits Lisp_Bits
;
7354 enum Lisp_Compiled Lisp_Compiled
;
7355 enum maxargs maxargs
;
7356 enum MAX_ALLOCA MAX_ALLOCA
;
7357 enum More_Lisp_Bits More_Lisp_Bits
;
7358 enum pvec_type pvec_type
;
7359 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7360 #endif /* __GNUC__ */